1
# Copyright (C) 2005-2010 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
20
from doctest import ELLIPSIS
28
from testtools import MultiTestResult
29
from testtools.content_type import ContentType
30
from testtools.matchers import (
34
import testtools.tests.helpers
53
from bzrlib.repofmt import (
58
from bzrlib.symbol_versioning import (
63
from bzrlib.tests import (
70
from bzrlib.trace import note
71
from bzrlib.transport import memory
72
from bzrlib.version import _get_bzr_source_tree
75
def _test_ids(test_suite):
76
"""Get the ids for the tests in a test suite."""
77
return [t.id() for t in tests.iter_suite_tests(test_suite)]
80
class SelftestTests(tests.TestCase):
82
def test_import_tests(self):
83
mod = TestUtil._load_module_by_name('bzrlib.tests.test_selftest')
84
self.assertEqual(mod.SelftestTests, SelftestTests)
86
def test_import_test_failure(self):
87
self.assertRaises(ImportError,
88
TestUtil._load_module_by_name,
92
class MetaTestLog(tests.TestCase):
94
def test_logging(self):
95
"""Test logs are captured when a test fails."""
96
self.log('a test message')
97
details = self.getDetails()
99
self.assertThat(log.content_type, Equals(ContentType(
100
"text", "plain", {"charset": "utf8"})))
101
self.assertThat(u"".join(log.iter_text()), Equals(self.get_log()))
102
self.assertThat(self.get_log(),
103
DocTestMatches(u"...a test message\n", ELLIPSIS))
106
class TestUnicodeFilename(tests.TestCase):
108
def test_probe_passes(self):
109
"""UnicodeFilename._probe passes."""
110
# We can't test much more than that because the behaviour depends
112
tests.UnicodeFilename._probe()
115
class TestTreeShape(tests.TestCaseInTempDir):
117
def test_unicode_paths(self):
118
self.requireFeature(tests.UnicodeFilename)
120
filename = u'hell\u00d8'
121
self.build_tree_contents([(filename, 'contents of hello')])
122
self.failUnlessExists(filename)
125
class TestTransportScenarios(tests.TestCase):
126
"""A group of tests that test the transport implementation adaption core.
128
This is a meta test that the tests are applied to all available
131
This will be generalised in the future which is why it is in this
132
test file even though it is specific to transport tests at the moment.
135
def test_get_transport_permutations(self):
136
# this checks that get_test_permutations defined by the module is
137
# called by the get_transport_test_permutations function.
138
class MockModule(object):
139
def get_test_permutations(self):
140
return sample_permutation
141
sample_permutation = [(1,2), (3,4)]
142
from bzrlib.tests.per_transport import get_transport_test_permutations
143
self.assertEqual(sample_permutation,
144
get_transport_test_permutations(MockModule()))
146
def test_scenarios_include_all_modules(self):
147
# this checks that the scenario generator returns as many permutations
148
# as there are in all the registered transport modules - we assume if
149
# this matches its probably doing the right thing especially in
150
# combination with the tests for setting the right classes below.
151
from bzrlib.tests.per_transport import transport_test_permutations
152
from bzrlib.transport import _get_transport_modules
153
modules = _get_transport_modules()
154
permutation_count = 0
155
for module in modules:
157
permutation_count += len(reduce(getattr,
158
(module + ".get_test_permutations").split('.')[1:],
159
__import__(module))())
160
except errors.DependencyNotPresent:
162
scenarios = transport_test_permutations()
163
self.assertEqual(permutation_count, len(scenarios))
165
def test_scenarios_include_transport_class(self):
166
# This test used to know about all the possible transports and the
167
# order they were returned but that seems overly brittle (mbp
169
from bzrlib.tests.per_transport import transport_test_permutations
170
scenarios = transport_test_permutations()
171
# there are at least that many builtin transports
172
self.assertTrue(len(scenarios) > 6)
173
one_scenario = scenarios[0]
174
self.assertIsInstance(one_scenario[0], str)
175
self.assertTrue(issubclass(one_scenario[1]["transport_class"],
176
bzrlib.transport.Transport))
177
self.assertTrue(issubclass(one_scenario[1]["transport_server"],
178
bzrlib.transport.Server))
181
class TestBranchScenarios(tests.TestCase):
183
def test_scenarios(self):
184
# check that constructor parameters are passed through to the adapted
186
from bzrlib.tests.per_branch import make_scenarios
189
formats = [("c", "C"), ("d", "D")]
190
scenarios = make_scenarios(server1, server2, formats)
191
self.assertEqual(2, len(scenarios))
194
{'branch_format': 'c',
195
'bzrdir_format': 'C',
196
'transport_readonly_server': 'b',
197
'transport_server': 'a'}),
199
{'branch_format': 'd',
200
'bzrdir_format': 'D',
201
'transport_readonly_server': 'b',
202
'transport_server': 'a'})],
206
class TestBzrDirScenarios(tests.TestCase):
208
def test_scenarios(self):
209
# check that constructor parameters are passed through to the adapted
211
from bzrlib.tests.per_controldir import make_scenarios
216
scenarios = make_scenarios(vfs_factory, server1, server2, formats)
219
{'bzrdir_format': 'c',
220
'transport_readonly_server': 'b',
221
'transport_server': 'a',
222
'vfs_transport_factory': 'v'}),
224
{'bzrdir_format': 'd',
225
'transport_readonly_server': 'b',
226
'transport_server': 'a',
227
'vfs_transport_factory': 'v'})],
231
class TestRepositoryScenarios(tests.TestCase):
233
def test_formats_to_scenarios(self):
234
from bzrlib.tests.per_repository import formats_to_scenarios
235
formats = [("(c)", remote.RemoteRepositoryFormat()),
236
("(d)", repository.format_registry.get(
237
'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
238
no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
240
vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
241
vfs_transport_factory="vfs")
242
# no_vfs generate scenarios without vfs_transport_factory
244
('RemoteRepositoryFormat(c)',
245
{'bzrdir_format': remote.RemoteBzrDirFormat(),
246
'repository_format': remote.RemoteRepositoryFormat(),
247
'transport_readonly_server': 'readonly',
248
'transport_server': 'server'}),
249
('RepositoryFormat2a(d)',
250
{'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
251
'repository_format': groupcompress_repo.RepositoryFormat2a(),
252
'transport_readonly_server': 'readonly',
253
'transport_server': 'server'})]
254
self.assertEqual(expected, no_vfs_scenarios)
256
('RemoteRepositoryFormat(c)',
257
{'bzrdir_format': remote.RemoteBzrDirFormat(),
258
'repository_format': remote.RemoteRepositoryFormat(),
259
'transport_readonly_server': 'readonly',
260
'transport_server': 'server',
261
'vfs_transport_factory': 'vfs'}),
262
('RepositoryFormat2a(d)',
263
{'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
264
'repository_format': groupcompress_repo.RepositoryFormat2a(),
265
'transport_readonly_server': 'readonly',
266
'transport_server': 'server',
267
'vfs_transport_factory': 'vfs'})],
271
class TestTestScenarioApplication(tests.TestCase):
272
"""Tests for the test adaption facilities."""
274
def test_apply_scenario(self):
275
from bzrlib.tests import apply_scenario
276
input_test = TestTestScenarioApplication("test_apply_scenario")
277
# setup two adapted tests
278
adapted_test1 = apply_scenario(input_test,
280
{"bzrdir_format":"bzr_format",
281
"repository_format":"repo_fmt",
282
"transport_server":"transport_server",
283
"transport_readonly_server":"readonly-server"}))
284
adapted_test2 = apply_scenario(input_test,
285
("new id 2", {"bzrdir_format":None}))
286
# input_test should have been altered.
287
self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
288
# the new tests are mutually incompatible, ensuring it has
289
# made new ones, and unspecified elements in the scenario
290
# should not have been altered.
291
self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
292
self.assertEqual("repo_fmt", adapted_test1.repository_format)
293
self.assertEqual("transport_server", adapted_test1.transport_server)
294
self.assertEqual("readonly-server",
295
adapted_test1.transport_readonly_server)
297
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
298
"test_apply_scenario(new id)",
300
self.assertEqual(None, adapted_test2.bzrdir_format)
302
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
303
"test_apply_scenario(new id 2)",
307
class TestInterRepositoryScenarios(tests.TestCase):
309
def test_scenarios(self):
310
# check that constructor parameters are passed through to the adapted
312
from bzrlib.tests.per_interrepository import make_scenarios
315
formats = [("C0", "C1", "C2"), ("D0", "D1", "D2")]
316
scenarios = make_scenarios(server1, server2, formats)
319
{'repository_format': 'C1',
320
'repository_format_to': 'C2',
321
'transport_readonly_server': 'b',
322
'transport_server': 'a'}),
324
{'repository_format': 'D1',
325
'repository_format_to': 'D2',
326
'transport_readonly_server': 'b',
327
'transport_server': 'a'})],
331
class TestWorkingTreeScenarios(tests.TestCase):
333
def test_scenarios(self):
334
# check that constructor parameters are passed through to the adapted
336
from bzrlib.tests.per_workingtree import make_scenarios
339
formats = [workingtree.WorkingTreeFormat2(),
340
workingtree.WorkingTreeFormat3(),]
341
scenarios = make_scenarios(server1, server2, formats)
343
('WorkingTreeFormat2',
344
{'bzrdir_format': formats[0]._matchingbzrdir,
345
'transport_readonly_server': 'b',
346
'transport_server': 'a',
347
'workingtree_format': formats[0]}),
348
('WorkingTreeFormat3',
349
{'bzrdir_format': formats[1]._matchingbzrdir,
350
'transport_readonly_server': 'b',
351
'transport_server': 'a',
352
'workingtree_format': formats[1]})],
356
class TestTreeScenarios(tests.TestCase):
358
def test_scenarios(self):
359
# the tree implementation scenario generator is meant to setup one
360
# instance for each working tree format, and one additional instance
361
# that will use the default wt format, but create a revision tree for
362
# the tests. this means that the wt ones should have the
363
# workingtree_to_test_tree attribute set to 'return_parameter' and the
364
# revision one set to revision_tree_from_workingtree.
366
from bzrlib.tests.per_tree import (
367
_dirstate_tree_from_workingtree,
372
revision_tree_from_workingtree
376
formats = [workingtree.WorkingTreeFormat2(),
377
workingtree.WorkingTreeFormat3(),]
378
scenarios = make_scenarios(server1, server2, formats)
379
self.assertEqual(7, len(scenarios))
380
default_wt_format = workingtree.WorkingTreeFormat4._default_format
381
wt4_format = workingtree.WorkingTreeFormat4()
382
wt5_format = workingtree.WorkingTreeFormat5()
383
expected_scenarios = [
384
('WorkingTreeFormat2',
385
{'bzrdir_format': formats[0]._matchingbzrdir,
386
'transport_readonly_server': 'b',
387
'transport_server': 'a',
388
'workingtree_format': formats[0],
389
'_workingtree_to_test_tree': return_parameter,
391
('WorkingTreeFormat3',
392
{'bzrdir_format': formats[1]._matchingbzrdir,
393
'transport_readonly_server': 'b',
394
'transport_server': 'a',
395
'workingtree_format': formats[1],
396
'_workingtree_to_test_tree': return_parameter,
399
{'_workingtree_to_test_tree': revision_tree_from_workingtree,
400
'bzrdir_format': default_wt_format._matchingbzrdir,
401
'transport_readonly_server': 'b',
402
'transport_server': 'a',
403
'workingtree_format': default_wt_format,
405
('DirStateRevisionTree,WT4',
406
{'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
407
'bzrdir_format': wt4_format._matchingbzrdir,
408
'transport_readonly_server': 'b',
409
'transport_server': 'a',
410
'workingtree_format': wt4_format,
412
('DirStateRevisionTree,WT5',
413
{'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
414
'bzrdir_format': wt5_format._matchingbzrdir,
415
'transport_readonly_server': 'b',
416
'transport_server': 'a',
417
'workingtree_format': wt5_format,
420
{'_workingtree_to_test_tree': preview_tree_pre,
421
'bzrdir_format': default_wt_format._matchingbzrdir,
422
'transport_readonly_server': 'b',
423
'transport_server': 'a',
424
'workingtree_format': default_wt_format}),
426
{'_workingtree_to_test_tree': preview_tree_post,
427
'bzrdir_format': default_wt_format._matchingbzrdir,
428
'transport_readonly_server': 'b',
429
'transport_server': 'a',
430
'workingtree_format': default_wt_format}),
432
self.assertEqual(expected_scenarios, scenarios)
435
class TestInterTreeScenarios(tests.TestCase):
436
"""A group of tests that test the InterTreeTestAdapter."""
438
def test_scenarios(self):
439
# check that constructor parameters are passed through to the adapted
441
# for InterTree tests we want the machinery to bring up two trees in
442
# each instance: the base one, and the one we are interacting with.
443
# because each optimiser can be direction specific, we need to test
444
# each optimiser in its chosen direction.
445
# unlike the TestProviderAdapter we dont want to automatically add a
446
# parameterized one for WorkingTree - the optimisers will tell us what
448
from bzrlib.tests.per_tree import (
450
revision_tree_from_workingtree
452
from bzrlib.tests.per_intertree import (
455
from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
456
input_test = TestInterTreeScenarios(
460
format1 = WorkingTreeFormat2()
461
format2 = WorkingTreeFormat3()
462
formats = [("1", str, format1, format2, "converter1"),
463
("2", int, format2, format1, "converter2")]
464
scenarios = make_scenarios(server1, server2, formats)
465
self.assertEqual(2, len(scenarios))
466
expected_scenarios = [
468
"bzrdir_format": format1._matchingbzrdir,
469
"intertree_class": formats[0][1],
470
"workingtree_format": formats[0][2],
471
"workingtree_format_to": formats[0][3],
472
"mutable_trees_to_test_trees": formats[0][4],
473
"_workingtree_to_test_tree": return_parameter,
474
"transport_server": server1,
475
"transport_readonly_server": server2,
478
"bzrdir_format": format2._matchingbzrdir,
479
"intertree_class": formats[1][1],
480
"workingtree_format": formats[1][2],
481
"workingtree_format_to": formats[1][3],
482
"mutable_trees_to_test_trees": formats[1][4],
483
"_workingtree_to_test_tree": return_parameter,
484
"transport_server": server1,
485
"transport_readonly_server": server2,
488
self.assertEqual(scenarios, expected_scenarios)
491
class TestTestCaseInTempDir(tests.TestCaseInTempDir):
493
def test_home_is_not_working(self):
494
self.assertNotEqual(self.test_dir, self.test_home_dir)
495
cwd = osutils.getcwd()
496
self.assertIsSameRealPath(self.test_dir, cwd)
497
self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
499
def test_assertEqualStat_equal(self):
500
from bzrlib.tests.test_dirstate import _FakeStat
501
self.build_tree(["foo"])
502
real = os.lstat("foo")
503
fake = _FakeStat(real.st_size, real.st_mtime, real.st_ctime,
504
real.st_dev, real.st_ino, real.st_mode)
505
self.assertEqualStat(real, fake)
507
def test_assertEqualStat_notequal(self):
508
self.build_tree(["foo", "longname"])
509
self.assertRaises(AssertionError, self.assertEqualStat,
510
os.lstat("foo"), os.lstat("longname"))
513
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
515
def test_home_is_non_existant_dir_under_root(self):
516
"""The test_home_dir for TestCaseWithMemoryTransport is missing.
518
This is because TestCaseWithMemoryTransport is for tests that do not
519
need any disk resources: they should be hooked into bzrlib in such a
520
way that no global settings are being changed by the test (only a
521
few tests should need to do that), and having a missing dir as home is
522
an effective way to ensure that this is the case.
524
self.assertIsSameRealPath(
525
self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
527
self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
529
def test_cwd_is_TEST_ROOT(self):
530
self.assertIsSameRealPath(self.test_dir, self.TEST_ROOT)
531
cwd = osutils.getcwd()
532
self.assertIsSameRealPath(self.test_dir, cwd)
534
def test_BZR_HOME_and_HOME_are_bytestrings(self):
535
"""The $BZR_HOME and $HOME environment variables should not be unicode.
537
See https://bugs.launchpad.net/bzr/+bug/464174
539
self.assertIsInstance(os.environ['BZR_HOME'], str)
540
self.assertIsInstance(os.environ['HOME'], str)
542
def test_make_branch_and_memory_tree(self):
543
"""In TestCaseWithMemoryTransport we should not make the branch on disk.
545
This is hard to comprehensively robustly test, so we settle for making
546
a branch and checking no directory was created at its relpath.
548
tree = self.make_branch_and_memory_tree('dir')
549
# Guard against regression into MemoryTransport leaking
550
# files to disk instead of keeping them in memory.
551
self.failIf(osutils.lexists('dir'))
552
self.assertIsInstance(tree, memorytree.MemoryTree)
554
def test_make_branch_and_memory_tree_with_format(self):
555
"""make_branch_and_memory_tree should accept a format option."""
556
format = bzrdir.BzrDirMetaFormat1()
557
format.repository_format = weaverepo.RepositoryFormat7()
558
tree = self.make_branch_and_memory_tree('dir', format=format)
559
# Guard against regression into MemoryTransport leaking
560
# files to disk instead of keeping them in memory.
561
self.failIf(osutils.lexists('dir'))
562
self.assertIsInstance(tree, memorytree.MemoryTree)
563
self.assertEqual(format.repository_format.__class__,
564
tree.branch.repository._format.__class__)
566
def test_make_branch_builder(self):
567
builder = self.make_branch_builder('dir')
568
self.assertIsInstance(builder, branchbuilder.BranchBuilder)
569
# Guard against regression into MemoryTransport leaking
570
# files to disk instead of keeping them in memory.
571
self.failIf(osutils.lexists('dir'))
573
def test_make_branch_builder_with_format(self):
574
# Use a repo layout that doesn't conform to a 'named' layout, to ensure
575
# that the format objects are used.
576
format = bzrdir.BzrDirMetaFormat1()
577
repo_format = weaverepo.RepositoryFormat7()
578
format.repository_format = repo_format
579
builder = self.make_branch_builder('dir', format=format)
580
the_branch = builder.get_branch()
581
# Guard against regression into MemoryTransport leaking
582
# files to disk instead of keeping them in memory.
583
self.failIf(osutils.lexists('dir'))
584
self.assertEqual(format.repository_format.__class__,
585
the_branch.repository._format.__class__)
586
self.assertEqual(repo_format.get_format_string(),
587
self.get_transport().get_bytes(
588
'dir/.bzr/repository/format'))
590
def test_make_branch_builder_with_format_name(self):
591
builder = self.make_branch_builder('dir', format='knit')
592
the_branch = builder.get_branch()
593
# Guard against regression into MemoryTransport leaking
594
# files to disk instead of keeping them in memory.
595
self.failIf(osutils.lexists('dir'))
596
dir_format = bzrdir.format_registry.make_bzrdir('knit')
597
self.assertEqual(dir_format.repository_format.__class__,
598
the_branch.repository._format.__class__)
599
self.assertEqual('Bazaar-NG Knit Repository Format 1',
600
self.get_transport().get_bytes(
601
'dir/.bzr/repository/format'))
603
def test_dangling_locks_cause_failures(self):
604
class TestDanglingLock(tests.TestCaseWithMemoryTransport):
605
def test_function(self):
606
t = self.get_transport('.')
607
l = lockdir.LockDir(t, 'lock')
610
test = TestDanglingLock('test_function')
612
total_failures = result.errors + result.failures
613
if self._lock_check_thorough:
614
self.assertLength(1, total_failures)
616
# When _lock_check_thorough is disabled, then we don't trigger a
618
self.assertLength(0, total_failures)
621
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
622
"""Tests for the convenience functions TestCaseWithTransport introduces."""
624
def test_get_readonly_url_none(self):
625
from bzrlib.transport.readonly import ReadonlyTransportDecorator
626
self.vfs_transport_factory = memory.MemoryServer
627
self.transport_readonly_server = None
628
# calling get_readonly_transport() constructs a decorator on the url
630
url = self.get_readonly_url()
631
url2 = self.get_readonly_url('foo/bar')
632
t = transport.get_transport(url)
633
t2 = transport.get_transport(url2)
634
self.failUnless(isinstance(t, ReadonlyTransportDecorator))
635
self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
636
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
638
def test_get_readonly_url_http(self):
639
from bzrlib.tests.http_server import HttpServer
640
from bzrlib.transport.http import HttpTransportBase
641
self.transport_server = test_server.LocalURLServer
642
self.transport_readonly_server = HttpServer
643
# calling get_readonly_transport() gives us a HTTP server instance.
644
url = self.get_readonly_url()
645
url2 = self.get_readonly_url('foo/bar')
646
# the transport returned may be any HttpTransportBase subclass
647
t = transport.get_transport(url)
648
t2 = transport.get_transport(url2)
649
self.failUnless(isinstance(t, HttpTransportBase))
650
self.failUnless(isinstance(t2, HttpTransportBase))
651
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
653
def test_is_directory(self):
654
"""Test assertIsDirectory assertion"""
655
t = self.get_transport()
656
self.build_tree(['a_dir/', 'a_file'], transport=t)
657
self.assertIsDirectory('a_dir', t)
658
self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
659
self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
661
def test_make_branch_builder(self):
662
builder = self.make_branch_builder('dir')
663
rev_id = builder.build_commit()
664
self.failUnlessExists('dir')
665
a_dir = bzrdir.BzrDir.open('dir')
666
self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
667
a_branch = a_dir.open_branch()
668
builder_branch = builder.get_branch()
669
self.assertEqual(a_branch.base, builder_branch.base)
670
self.assertEqual((1, rev_id), builder_branch.last_revision_info())
671
self.assertEqual((1, rev_id), a_branch.last_revision_info())
674
class TestTestCaseTransports(tests.TestCaseWithTransport):
677
super(TestTestCaseTransports, self).setUp()
678
self.vfs_transport_factory = memory.MemoryServer
680
def test_make_bzrdir_preserves_transport(self):
681
t = self.get_transport()
682
result_bzrdir = self.make_bzrdir('subdir')
683
self.assertIsInstance(result_bzrdir.transport,
684
memory.MemoryTransport)
685
# should not be on disk, should only be in memory
686
self.failIfExists('subdir')
689
class TestChrootedTest(tests.ChrootedTestCase):
691
def test_root_is_root(self):
692
t = transport.get_transport(self.get_readonly_url())
694
self.assertEqual(url, t.clone('..').base)
697
class TestProfileResult(tests.TestCase):
699
def test_profiles_tests(self):
700
self.requireFeature(test_lsprof.LSProfFeature)
701
terminal = testtools.tests.helpers.ExtendedTestResult()
702
result = tests.ProfileResult(terminal)
703
class Sample(tests.TestCase):
705
self.sample_function()
706
def sample_function(self):
710
case = terminal._events[0][1]
711
self.assertLength(1, case._benchcalls)
712
# We must be able to unpack it as the test reporting code wants
713
(_, _, _), stats = case._benchcalls[0]
714
self.assertTrue(callable(stats.pprint))
717
class TestTestResult(tests.TestCase):
719
def check_timing(self, test_case, expected_re):
720
result = bzrlib.tests.TextTestResult(self._log_file,
724
capture = testtools.tests.helpers.ExtendedTestResult()
725
test_case.run(MultiTestResult(result, capture))
726
run_case = capture._events[0][1]
727
timed_string = result._testTimeString(run_case)
728
self.assertContainsRe(timed_string, expected_re)
730
def test_test_reporting(self):
731
class ShortDelayTestCase(tests.TestCase):
732
def test_short_delay(self):
734
def test_short_benchmark(self):
735
self.time(time.sleep, 0.003)
736
self.check_timing(ShortDelayTestCase('test_short_delay'),
738
# if a benchmark time is given, we now show just that time followed by
740
self.check_timing(ShortDelayTestCase('test_short_benchmark'),
743
def test_unittest_reporting_unittest_class(self):
744
# getting the time from a non-bzrlib test works ok
745
class ShortDelayTestCase(unittest.TestCase):
746
def test_short_delay(self):
748
self.check_timing(ShortDelayTestCase('test_short_delay'),
751
def _patch_get_bzr_source_tree(self):
752
# Reading from the actual source tree breaks isolation, but we don't
753
# want to assume that thats *all* that would happen.
754
self.overrideAttr(bzrlib.version, '_get_bzr_source_tree', lambda: None)
756
def test_assigned_benchmark_file_stores_date(self):
757
self._patch_get_bzr_source_tree()
759
result = bzrlib.tests.TextTestResult(self._log_file,
764
output_string = output.getvalue()
765
# if you are wondering about the regexp please read the comment in
766
# test_bench_history (bzrlib.tests.test_selftest.TestRunner)
767
# XXX: what comment? -- Andrew Bennetts
768
self.assertContainsRe(output_string, "--date [0-9.]+")
770
def test_benchhistory_records_test_times(self):
771
self._patch_get_bzr_source_tree()
772
result_stream = StringIO()
773
result = bzrlib.tests.TextTestResult(
777
bench_history=result_stream
780
# we want profile a call and check that its test duration is recorded
781
# make a new test instance that when run will generate a benchmark
782
example_test_case = TestTestResult("_time_hello_world_encoding")
783
# execute the test, which should succeed and record times
784
example_test_case.run(result)
785
lines = result_stream.getvalue().splitlines()
786
self.assertEqual(2, len(lines))
787
self.assertContainsRe(lines[1],
788
" *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
789
"._time_hello_world_encoding")
791
def _time_hello_world_encoding(self):
792
"""Profile two sleep calls
794
This is used to exercise the test framework.
796
self.time(unicode, 'hello', errors='replace')
797
self.time(unicode, 'world', errors='replace')
799
def test_lsprofiling(self):
800
"""Verbose test result prints lsprof statistics from test cases."""
801
self.requireFeature(test_lsprof.LSProfFeature)
802
result_stream = StringIO()
803
result = bzrlib.tests.VerboseTestResult(
808
# we want profile a call of some sort and check it is output by
809
# addSuccess. We dont care about addError or addFailure as they
810
# are not that interesting for performance tuning.
811
# make a new test instance that when run will generate a profile
812
example_test_case = TestTestResult("_time_hello_world_encoding")
813
example_test_case._gather_lsprof_in_benchmarks = True
814
# execute the test, which should succeed and record profiles
815
example_test_case.run(result)
816
# lsprofile_something()
817
# if this worked we want
818
# LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
819
# CallCount Recursive Total(ms) Inline(ms) module:lineno(function)
820
# (the lsprof header)
821
# ... an arbitrary number of lines
822
# and the function call which is time.sleep.
823
# 1 0 ??? ??? ???(sleep)
824
# and then repeated but with 'world', rather than 'hello'.
825
# this should appear in the output stream of our test result.
826
output = result_stream.getvalue()
827
self.assertContainsRe(output,
828
r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
829
self.assertContainsRe(output,
830
r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
831
self.assertContainsRe(output,
832
r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
833
self.assertContainsRe(output,
834
r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
836
def test_known_failure(self):
837
"""A KnownFailure being raised should trigger several result actions."""
838
class InstrumentedTestResult(tests.ExtendedTestResult):
839
def stopTestRun(self): pass
840
def startTests(self): pass
841
def report_test_start(self, test): pass
842
def report_known_failure(self, test, err=None, details=None):
843
self._call = test, 'known failure'
844
result = InstrumentedTestResult(None, None, None, None)
845
class Test(tests.TestCase):
846
def test_function(self):
847
raise tests.KnownFailure('failed!')
848
test = Test("test_function")
850
# it should invoke 'report_known_failure'.
851
self.assertEqual(2, len(result._call))
852
self.assertEqual(test.id(), result._call[0].id())
853
self.assertEqual('known failure', result._call[1])
854
# we dont introspec the traceback, if the rest is ok, it would be
855
# exceptional for it not to be.
856
# it should update the known_failure_count on the object.
857
self.assertEqual(1, result.known_failure_count)
858
# the result should be successful.
859
self.assertTrue(result.wasSuccessful())
861
def test_verbose_report_known_failure(self):
862
# verbose test output formatting
863
result_stream = StringIO()
864
result = bzrlib.tests.VerboseTestResult(
869
test = self.get_passing_test()
870
result.startTest(test)
871
prefix = len(result_stream.getvalue())
872
# the err parameter has the shape:
873
# (class, exception object, traceback)
874
# KnownFailures dont get their tracebacks shown though, so we
876
err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
877
result.report_known_failure(test, err)
878
output = result_stream.getvalue()[prefix:]
879
lines = output.splitlines()
880
self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
881
if sys.version_info > (2, 7):
882
self.expectFailure("_ExpectedFailure on 2.7 loses the message",
883
self.assertNotEqual, lines[1], ' ')
884
self.assertEqual(lines[1], ' foo')
885
self.assertEqual(2, len(lines))
887
def get_passing_test(self):
888
"""Return a test object that can't be run usefully."""
891
return unittest.FunctionTestCase(passing_test)
893
def test_add_not_supported(self):
894
"""Test the behaviour of invoking addNotSupported."""
895
class InstrumentedTestResult(tests.ExtendedTestResult):
896
def stopTestRun(self): pass
897
def startTests(self): pass
898
def report_test_start(self, test): pass
899
def report_unsupported(self, test, feature):
900
self._call = test, feature
901
result = InstrumentedTestResult(None, None, None, None)
902
test = SampleTestCase('_test_pass')
903
feature = tests.Feature()
904
result.startTest(test)
905
result.addNotSupported(test, feature)
906
# it should invoke 'report_unsupported'.
907
self.assertEqual(2, len(result._call))
908
self.assertEqual(test, result._call[0])
909
self.assertEqual(feature, result._call[1])
910
# the result should be successful.
911
self.assertTrue(result.wasSuccessful())
912
# it should record the test against a count of tests not run due to
914
self.assertEqual(1, result.unsupported['Feature'])
915
# and invoking it again should increment that counter
916
result.addNotSupported(test, feature)
917
self.assertEqual(2, result.unsupported['Feature'])
919
def test_verbose_report_unsupported(self):
920
# verbose test output formatting
921
result_stream = StringIO()
922
result = bzrlib.tests.VerboseTestResult(
927
test = self.get_passing_test()
928
feature = tests.Feature()
929
result.startTest(test)
930
prefix = len(result_stream.getvalue())
931
result.report_unsupported(test, feature)
932
output = result_stream.getvalue()[prefix:]
933
lines = output.splitlines()
934
# We don't check for the final '0ms' since it may fail on slow hosts
935
self.assertStartsWith(lines[0], 'NODEP')
936
self.assertEqual(lines[1],
937
" The feature 'Feature' is not available.")
939
def test_unavailable_exception(self):
940
"""An UnavailableFeature being raised should invoke addNotSupported."""
941
class InstrumentedTestResult(tests.ExtendedTestResult):
942
def stopTestRun(self): pass
943
def startTests(self): pass
944
def report_test_start(self, test): pass
945
def addNotSupported(self, test, feature):
946
self._call = test, feature
947
result = InstrumentedTestResult(None, None, None, None)
948
feature = tests.Feature()
949
class Test(tests.TestCase):
950
def test_function(self):
951
raise tests.UnavailableFeature(feature)
952
test = Test("test_function")
954
# it should invoke 'addNotSupported'.
955
self.assertEqual(2, len(result._call))
956
self.assertEqual(test.id(), result._call[0].id())
957
self.assertEqual(feature, result._call[1])
958
# and not count as an error
959
self.assertEqual(0, result.error_count)
961
def test_strict_with_unsupported_feature(self):
962
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
964
test = self.get_passing_test()
965
feature = "Unsupported Feature"
966
result.addNotSupported(test, feature)
967
self.assertFalse(result.wasStrictlySuccessful())
968
self.assertEqual(None, result._extractBenchmarkTime(test))
970
def test_strict_with_known_failure(self):
971
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
973
test = self.get_passing_test()
974
err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
975
result.addExpectedFailure(test, err)
976
self.assertFalse(result.wasStrictlySuccessful())
977
self.assertEqual(None, result._extractBenchmarkTime(test))
979
def test_strict_with_success(self):
980
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
982
test = self.get_passing_test()
983
result.addSuccess(test)
984
self.assertTrue(result.wasStrictlySuccessful())
985
self.assertEqual(None, result._extractBenchmarkTime(test))
987
def test_startTests(self):
988
"""Starting the first test should trigger startTests."""
989
class InstrumentedTestResult(tests.ExtendedTestResult):
991
def startTests(self): self.calls += 1
992
def report_test_start(self, test): pass
993
result = InstrumentedTestResult(None, None, None, None)
996
test = unittest.FunctionTestCase(test_function)
998
self.assertEquals(1, result.calls)
1001
class TestUnicodeFilenameFeature(tests.TestCase):
1003
def test_probe_passes(self):
1004
"""UnicodeFilenameFeature._probe passes."""
1005
# We can't test much more than that because the behaviour depends
1007
tests.UnicodeFilenameFeature._probe()
1010
class TestRunner(tests.TestCase):
1012
def dummy_test(self):
1015
def run_test_runner(self, testrunner, test):
1016
"""Run suite in testrunner, saving global state and restoring it.
1018
This current saves and restores:
1019
TestCaseInTempDir.TEST_ROOT
1021
There should be no tests in this file that use
1022
bzrlib.tests.TextTestRunner without using this convenience method,
1023
because of our use of global state.
1025
old_root = tests.TestCaseInTempDir.TEST_ROOT
1026
old_leak = tests.TestCase._first_thread_leaker_id
1028
tests.TestCaseInTempDir.TEST_ROOT = None
1029
tests.TestCase._first_thread_leaker_id = None
1030
return testrunner.run(test)
1032
tests.TestCaseInTempDir.TEST_ROOT = old_root
1033
tests.TestCase._first_thread_leaker_id = old_leak
1035
def test_known_failure_failed_run(self):
1036
# run a test that generates a known failure which should be printed in
1037
# the final output when real failures occur.
1038
class Test(tests.TestCase):
1039
def known_failure_test(self):
1040
self.expectFailure('failed', self.assertTrue, False)
1041
test = unittest.TestSuite()
1042
test.addTest(Test("known_failure_test"))
1045
test.addTest(unittest.FunctionTestCase(failing_test))
1047
runner = tests.TextTestRunner(stream=stream)
1048
result = self.run_test_runner(runner, test)
1049
lines = stream.getvalue().splitlines()
1050
self.assertContainsRe(stream.getvalue(),
1051
'(?sm)^bzr selftest.*$'
1053
'^======================================================================\n'
1054
'^FAIL: failing_test\n'
1055
'^----------------------------------------------------------------------\n'
1056
'Traceback \\(most recent call last\\):\n'
1057
' .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
1058
' self.fail\\(\'foo\'\\)\n'
1060
'^----------------------------------------------------------------------\n'
1062
'FAILED \\(failures=1, known_failure_count=1\\)'
1065
def test_known_failure_ok_run(self):
1066
# run a test that generates a known failure which should be printed in
1068
class Test(tests.TestCase):
1069
def known_failure_test(self):
1070
self.expectFailure('failed', self.assertTrue, False)
1071
test = Test("known_failure_test")
1073
runner = tests.TextTestRunner(stream=stream)
1074
result = self.run_test_runner(runner, test)
1075
self.assertContainsRe(stream.getvalue(),
1078
'Ran 1 test in .*\n'
1080
'OK \\(known_failures=1\\)\n')
1082
def test_result_decorator(self):
1085
class LoggingDecorator(tests.ForwardingResult):
1086
def startTest(self, test):
1087
tests.ForwardingResult.startTest(self, test)
1088
calls.append('start')
1089
test = unittest.FunctionTestCase(lambda:None)
1091
runner = tests.TextTestRunner(stream=stream,
1092
result_decorators=[LoggingDecorator])
1093
result = self.run_test_runner(runner, test)
1094
self.assertLength(1, calls)
1096
def test_skipped_test(self):
1097
# run a test that is skipped, and check the suite as a whole still
1099
# skipping_test must be hidden in here so it's not run as a real test
1100
class SkippingTest(tests.TestCase):
1101
def skipping_test(self):
1102
raise tests.TestSkipped('test intentionally skipped')
1103
runner = tests.TextTestRunner(stream=self._log_file)
1104
test = SkippingTest("skipping_test")
1105
result = self.run_test_runner(runner, test)
1106
self.assertTrue(result.wasSuccessful())
1108
def test_skipped_from_setup(self):
1110
class SkippedSetupTest(tests.TestCase):
1113
calls.append('setUp')
1114
self.addCleanup(self.cleanup)
1115
raise tests.TestSkipped('skipped setup')
1117
def test_skip(self):
1118
self.fail('test reached')
1121
calls.append('cleanup')
1123
runner = tests.TextTestRunner(stream=self._log_file)
1124
test = SkippedSetupTest('test_skip')
1125
result = self.run_test_runner(runner, test)
1126
self.assertTrue(result.wasSuccessful())
1127
# Check if cleanup was called the right number of times.
1128
self.assertEqual(['setUp', 'cleanup'], calls)
1130
def test_skipped_from_test(self):
1132
class SkippedTest(tests.TestCase):
1135
tests.TestCase.setUp(self)
1136
calls.append('setUp')
1137
self.addCleanup(self.cleanup)
1139
def test_skip(self):
1140
raise tests.TestSkipped('skipped test')
1143
calls.append('cleanup')
1145
runner = tests.TextTestRunner(stream=self._log_file)
1146
test = SkippedTest('test_skip')
1147
result = self.run_test_runner(runner, test)
1148
self.assertTrue(result.wasSuccessful())
1149
# Check if cleanup was called the right number of times.
1150
self.assertEqual(['setUp', 'cleanup'], calls)
1152
def test_not_applicable(self):
1153
# run a test that is skipped because it's not applicable
1154
class Test(tests.TestCase):
1155
def not_applicable_test(self):
1156
raise tests.TestNotApplicable('this test never runs')
1158
runner = tests.TextTestRunner(stream=out, verbosity=2)
1159
test = Test("not_applicable_test")
1160
result = self.run_test_runner(runner, test)
1161
self._log_file.write(out.getvalue())
1162
self.assertTrue(result.wasSuccessful())
1163
self.assertTrue(result.wasStrictlySuccessful())
1164
self.assertContainsRe(out.getvalue(),
1165
r'(?m)not_applicable_test * N/A')
1166
self.assertContainsRe(out.getvalue(),
1167
r'(?m)^ this test never runs')
1169
def test_unsupported_features_listed(self):
1170
"""When unsupported features are encountered they are detailed."""
1171
class Feature1(tests.Feature):
1172
def _probe(self): return False
1173
class Feature2(tests.Feature):
1174
def _probe(self): return False
1175
# create sample tests
1176
test1 = SampleTestCase('_test_pass')
1177
test1._test_needs_features = [Feature1()]
1178
test2 = SampleTestCase('_test_pass')
1179
test2._test_needs_features = [Feature2()]
1180
test = unittest.TestSuite()
1184
runner = tests.TextTestRunner(stream=stream)
1185
result = self.run_test_runner(runner, test)
1186
lines = stream.getvalue().splitlines()
1189
"Missing feature 'Feature1' skipped 1 tests.",
1190
"Missing feature 'Feature2' skipped 1 tests.",
1194
def _patch_get_bzr_source_tree(self):
1195
# Reading from the actual source tree breaks isolation, but we don't
1196
# want to assume that thats *all* that would happen.
1197
self._get_source_tree_calls = []
1199
self._get_source_tree_calls.append("called")
1201
self.overrideAttr(bzrlib.version, '_get_bzr_source_tree', new_get)
1203
def test_bench_history(self):
1204
# tests that the running the benchmark passes bench_history into
1205
# the test result object. We can tell that happens if
1206
# _get_bzr_source_tree is called.
1207
self._patch_get_bzr_source_tree()
1208
test = TestRunner('dummy_test')
1210
runner = tests.TextTestRunner(stream=self._log_file,
1211
bench_history=output)
1212
result = self.run_test_runner(runner, test)
1213
output_string = output.getvalue()
1214
self.assertContainsRe(output_string, "--date [0-9.]+")
1215
self.assertLength(1, self._get_source_tree_calls)
1217
def test_startTestRun(self):
1218
"""run should call result.startTestRun()"""
1220
class LoggingDecorator(tests.ForwardingResult):
1221
def startTestRun(self):
1222
tests.ForwardingResult.startTestRun(self)
1223
calls.append('startTestRun')
1224
test = unittest.FunctionTestCase(lambda:None)
1226
runner = tests.TextTestRunner(stream=stream,
1227
result_decorators=[LoggingDecorator])
1228
result = self.run_test_runner(runner, test)
1229
self.assertLength(1, calls)
1231
def test_stopTestRun(self):
1232
"""run should call result.stopTestRun()"""
1234
class LoggingDecorator(tests.ForwardingResult):
1235
def stopTestRun(self):
1236
tests.ForwardingResult.stopTestRun(self)
1237
calls.append('stopTestRun')
1238
test = unittest.FunctionTestCase(lambda:None)
1240
runner = tests.TextTestRunner(stream=stream,
1241
result_decorators=[LoggingDecorator])
1242
result = self.run_test_runner(runner, test)
1243
self.assertLength(1, calls)
1246
class SampleTestCase(tests.TestCase):
1248
def _test_pass(self):
1251
class _TestException(Exception):
1255
class TestTestCase(tests.TestCase):
1256
"""Tests that test the core bzrlib TestCase."""
1258
def test_assertLength_matches_empty(self):
1260
self.assertLength(0, a_list)
1262
def test_assertLength_matches_nonempty(self):
1264
self.assertLength(3, a_list)
1266
def test_assertLength_fails_different(self):
1268
self.assertRaises(AssertionError, self.assertLength, 1, a_list)
1270
def test_assertLength_shows_sequence_in_failure(self):
1272
exception = self.assertRaises(AssertionError, self.assertLength, 2,
1274
self.assertEqual('Incorrect length: wanted 2, got 3 for [1, 2, 3]',
1277
def test_base_setUp_not_called_causes_failure(self):
1278
class TestCaseWithBrokenSetUp(tests.TestCase):
1280
pass # does not call TestCase.setUp
1283
test = TestCaseWithBrokenSetUp('test_foo')
1284
result = unittest.TestResult()
1286
self.assertFalse(result.wasSuccessful())
1287
self.assertEqual(1, result.testsRun)
1289
def test_base_tearDown_not_called_causes_failure(self):
1290
class TestCaseWithBrokenTearDown(tests.TestCase):
1292
pass # does not call TestCase.tearDown
1295
test = TestCaseWithBrokenTearDown('test_foo')
1296
result = unittest.TestResult()
1298
self.assertFalse(result.wasSuccessful())
1299
self.assertEqual(1, result.testsRun)
1301
def test_debug_flags_sanitised(self):
1302
"""The bzrlib debug flags should be sanitised by setUp."""
1303
if 'allow_debug' in tests.selftest_debug_flags:
1304
raise tests.TestNotApplicable(
1305
'-Eallow_debug option prevents debug flag sanitisation')
1306
# we could set something and run a test that will check
1307
# it gets santised, but this is probably sufficient for now:
1308
# if someone runs the test with -Dsomething it will error.
1310
if self._lock_check_thorough:
1311
flags.add('strict_locks')
1312
self.assertEqual(flags, bzrlib.debug.debug_flags)
1314
def change_selftest_debug_flags(self, new_flags):
1315
self.overrideAttr(tests, 'selftest_debug_flags', set(new_flags))
1317
def test_allow_debug_flag(self):
1318
"""The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1319
sanitised (i.e. cleared) before running a test.
1321
self.change_selftest_debug_flags(set(['allow_debug']))
1322
bzrlib.debug.debug_flags = set(['a-flag'])
1323
class TestThatRecordsFlags(tests.TestCase):
1324
def test_foo(nested_self):
1325
self.flags = set(bzrlib.debug.debug_flags)
1326
test = TestThatRecordsFlags('test_foo')
1327
test.run(self.make_test_result())
1328
flags = set(['a-flag'])
1329
if 'disable_lock_checks' not in tests.selftest_debug_flags:
1330
flags.add('strict_locks')
1331
self.assertEqual(flags, self.flags)
1333
def test_disable_lock_checks(self):
1334
"""The -Edisable_lock_checks flag disables thorough checks."""
1335
class TestThatRecordsFlags(tests.TestCase):
1336
def test_foo(nested_self):
1337
self.flags = set(bzrlib.debug.debug_flags)
1338
self.test_lock_check_thorough = nested_self._lock_check_thorough
1339
self.change_selftest_debug_flags(set())
1340
test = TestThatRecordsFlags('test_foo')
1341
test.run(self.make_test_result())
1342
# By default we do strict lock checking and thorough lock/unlock
1344
self.assertTrue(self.test_lock_check_thorough)
1345
self.assertEqual(set(['strict_locks']), self.flags)
1346
# Now set the disable_lock_checks flag, and show that this changed.
1347
self.change_selftest_debug_flags(set(['disable_lock_checks']))
1348
test = TestThatRecordsFlags('test_foo')
1349
test.run(self.make_test_result())
1350
self.assertFalse(self.test_lock_check_thorough)
1351
self.assertEqual(set(), self.flags)
1353
def test_this_fails_strict_lock_check(self):
1354
class TestThatRecordsFlags(tests.TestCase):
1355
def test_foo(nested_self):
1356
self.flags1 = set(bzrlib.debug.debug_flags)
1357
self.thisFailsStrictLockCheck()
1358
self.flags2 = set(bzrlib.debug.debug_flags)
1359
# Make sure lock checking is active
1360
self.change_selftest_debug_flags(set())
1361
test = TestThatRecordsFlags('test_foo')
1362
test.run(self.make_test_result())
1363
self.assertEqual(set(['strict_locks']), self.flags1)
1364
self.assertEqual(set(), self.flags2)
1366
def test_debug_flags_restored(self):
1367
"""The bzrlib debug flags should be restored to their original state
1368
after the test was run, even if allow_debug is set.
1370
self.change_selftest_debug_flags(set(['allow_debug']))
1371
# Now run a test that modifies debug.debug_flags.
1372
bzrlib.debug.debug_flags = set(['original-state'])
1373
class TestThatModifiesFlags(tests.TestCase):
1375
bzrlib.debug.debug_flags = set(['modified'])
1376
test = TestThatModifiesFlags('test_foo')
1377
test.run(self.make_test_result())
1378
self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1380
def make_test_result(self):
1381
"""Get a test result that writes to the test log file."""
1382
return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
1384
def inner_test(self):
1385
# the inner child test
1388
def outer_child(self):
1389
# the outer child test
1391
self.inner_test = TestTestCase("inner_child")
1392
result = self.make_test_result()
1393
self.inner_test.run(result)
1394
note("outer finish")
1395
self.addCleanup(osutils.delete_any, self._log_file_name)
1397
def test_trace_nesting(self):
1398
# this tests that each test case nests its trace facility correctly.
1399
# we do this by running a test case manually. That test case (A)
1400
# should setup a new log, log content to it, setup a child case (B),
1401
# which should log independently, then case (A) should log a trailer
1403
# we do two nested children so that we can verify the state of the
1404
# logs after the outer child finishes is correct, which a bad clean
1405
# up routine in tearDown might trigger a fault in our test with only
1406
# one child, we should instead see the bad result inside our test with
1408
# the outer child test
1409
original_trace = bzrlib.trace._trace_file
1410
outer_test = TestTestCase("outer_child")
1411
result = self.make_test_result()
1412
outer_test.run(result)
1413
self.assertEqual(original_trace, bzrlib.trace._trace_file)
1415
def method_that_times_a_bit_twice(self):
1416
# call self.time twice to ensure it aggregates
1417
self.time(time.sleep, 0.007)
1418
self.time(time.sleep, 0.007)
1420
def test_time_creates_benchmark_in_result(self):
1421
"""Test that the TestCase.time() method accumulates a benchmark time."""
1422
sample_test = TestTestCase("method_that_times_a_bit_twice")
1423
output_stream = StringIO()
1424
result = bzrlib.tests.VerboseTestResult(
1428
sample_test.run(result)
1429
self.assertContainsRe(
1430
output_stream.getvalue(),
1433
def test_hooks_sanitised(self):
1434
"""The bzrlib hooks should be sanitised by setUp."""
1435
# Note this test won't fail with hooks that the core library doesn't
1436
# use - but it trigger with a plugin that adds hooks, so its still a
1437
# useful warning in that case.
1438
self.assertEqual(bzrlib.branch.BranchHooks(),
1439
bzrlib.branch.Branch.hooks)
1440
self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
1441
bzrlib.smart.server.SmartTCPServer.hooks)
1442
self.assertEqual(bzrlib.commands.CommandHooks(),
1443
bzrlib.commands.Command.hooks)
1445
def test__gather_lsprof_in_benchmarks(self):
1446
"""When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1448
Each self.time() call is individually and separately profiled.
1450
self.requireFeature(test_lsprof.LSProfFeature)
1451
# overrides the class member with an instance member so no cleanup
1453
self._gather_lsprof_in_benchmarks = True
1454
self.time(time.sleep, 0.000)
1455
self.time(time.sleep, 0.003)
1456
self.assertEqual(2, len(self._benchcalls))
1457
self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
1458
self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1459
self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1460
self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1461
del self._benchcalls[:]
1463
def test_knownFailure(self):
1464
"""Self.knownFailure() should raise a KnownFailure exception."""
1465
self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
1467
def test_open_bzrdir_safe_roots(self):
1468
# even a memory transport should fail to open when its url isn't
1470
# Manually set one up (TestCase doesn't and shouldn't provide magic
1472
transport_server = memory.MemoryServer()
1473
transport_server.start_server()
1474
self.addCleanup(transport_server.stop_server)
1475
t = transport.get_transport(transport_server.get_url())
1476
bzrdir.BzrDir.create(t.base)
1477
self.assertRaises(errors.BzrError,
1478
bzrdir.BzrDir.open_from_transport, t)
1479
# But if we declare this as safe, we can open the bzrdir.
1480
self.permit_url(t.base)
1481
self._bzr_selftest_roots.append(t.base)
1482
bzrdir.BzrDir.open_from_transport(t)
1484
def test_requireFeature_available(self):
1485
"""self.requireFeature(available) is a no-op."""
1486
class Available(tests.Feature):
1487
def _probe(self):return True
1488
feature = Available()
1489
self.requireFeature(feature)
1491
def test_requireFeature_unavailable(self):
1492
"""self.requireFeature(unavailable) raises UnavailableFeature."""
1493
class Unavailable(tests.Feature):
1494
def _probe(self):return False
1495
feature = Unavailable()
1496
self.assertRaises(tests.UnavailableFeature,
1497
self.requireFeature, feature)
1499
def test_run_no_parameters(self):
1500
test = SampleTestCase('_test_pass')
1503
def test_run_enabled_unittest_result(self):
1504
"""Test we revert to regular behaviour when the test is enabled."""
1505
test = SampleTestCase('_test_pass')
1506
class EnabledFeature(object):
1507
def available(self):
1509
test._test_needs_features = [EnabledFeature()]
1510
result = unittest.TestResult()
1512
self.assertEqual(1, result.testsRun)
1513
self.assertEqual([], result.errors)
1514
self.assertEqual([], result.failures)
1516
def test_run_disabled_unittest_result(self):
1517
"""Test our compatability for disabled tests with unittest results."""
1518
test = SampleTestCase('_test_pass')
1519
class DisabledFeature(object):
1520
def available(self):
1522
test._test_needs_features = [DisabledFeature()]
1523
result = unittest.TestResult()
1525
self.assertEqual(1, result.testsRun)
1526
self.assertEqual([], result.errors)
1527
self.assertEqual([], result.failures)
1529
def test_run_disabled_supporting_result(self):
1530
"""Test disabled tests behaviour with support aware results."""
1531
test = SampleTestCase('_test_pass')
1532
class DisabledFeature(object):
1533
def __eq__(self, other):
1534
return isinstance(other, DisabledFeature)
1535
def available(self):
1537
the_feature = DisabledFeature()
1538
test._test_needs_features = [the_feature]
1539
class InstrumentedTestResult(unittest.TestResult):
1541
unittest.TestResult.__init__(self)
1543
def startTest(self, test):
1544
self.calls.append(('startTest', test))
1545
def stopTest(self, test):
1546
self.calls.append(('stopTest', test))
1547
def addNotSupported(self, test, feature):
1548
self.calls.append(('addNotSupported', test, feature))
1549
result = InstrumentedTestResult()
1551
case = result.calls[0][1]
1553
('startTest', case),
1554
('addNotSupported', case, the_feature),
1559
def test_start_server_registers_url(self):
1560
transport_server = memory.MemoryServer()
1561
# A little strict, but unlikely to be changed soon.
1562
self.assertEqual([], self._bzr_selftest_roots)
1563
self.start_server(transport_server)
1564
self.assertSubset([transport_server.get_url()],
1565
self._bzr_selftest_roots)
1567
def test_assert_list_raises_on_generator(self):
1568
def generator_which_will_raise():
1569
# This will not raise until after the first yield
1571
raise _TestException()
1573
e = self.assertListRaises(_TestException, generator_which_will_raise)
1574
self.assertIsInstance(e, _TestException)
1576
e = self.assertListRaises(Exception, generator_which_will_raise)
1577
self.assertIsInstance(e, _TestException)
1579
def test_assert_list_raises_on_plain(self):
1580
def plain_exception():
1581
raise _TestException()
1584
e = self.assertListRaises(_TestException, plain_exception)
1585
self.assertIsInstance(e, _TestException)
1587
e = self.assertListRaises(Exception, plain_exception)
1588
self.assertIsInstance(e, _TestException)
1590
def test_assert_list_raises_assert_wrong_exception(self):
1591
class _NotTestException(Exception):
1594
def wrong_exception():
1595
raise _NotTestException()
1597
def wrong_exception_generator():
1600
raise _NotTestException()
1602
# Wrong exceptions are not intercepted
1603
self.assertRaises(_NotTestException,
1604
self.assertListRaises, _TestException, wrong_exception)
1605
self.assertRaises(_NotTestException,
1606
self.assertListRaises, _TestException, wrong_exception_generator)
1608
def test_assert_list_raises_no_exception(self):
1612
def success_generator():
1616
self.assertRaises(AssertionError,
1617
self.assertListRaises, _TestException, success)
1619
self.assertRaises(AssertionError,
1620
self.assertListRaises, _TestException, success_generator)
1622
def test_overrideAttr_without_value(self):
1623
self.test_attr = 'original' # Define a test attribute
1624
obj = self # Make 'obj' visible to the embedded test
1625
class Test(tests.TestCase):
1628
tests.TestCase.setUp(self)
1629
self.orig = self.overrideAttr(obj, 'test_attr')
1631
def test_value(self):
1632
self.assertEqual('original', self.orig)
1633
self.assertEqual('original', obj.test_attr)
1634
obj.test_attr = 'modified'
1635
self.assertEqual('modified', obj.test_attr)
1637
test = Test('test_value')
1638
test.run(unittest.TestResult())
1639
self.assertEqual('original', obj.test_attr)
1641
def test_overrideAttr_with_value(self):
1642
self.test_attr = 'original' # Define a test attribute
1643
obj = self # Make 'obj' visible to the embedded test
1644
class Test(tests.TestCase):
1647
tests.TestCase.setUp(self)
1648
self.orig = self.overrideAttr(obj, 'test_attr', new='modified')
1650
def test_value(self):
1651
self.assertEqual('original', self.orig)
1652
self.assertEqual('modified', obj.test_attr)
1654
test = Test('test_value')
1655
test.run(unittest.TestResult())
1656
self.assertEqual('original', obj.test_attr)
1659
# NB: Don't delete this; it's not actually from 0.11!
1660
@deprecated_function(deprecated_in((0, 11, 0)))
1661
def sample_deprecated_function():
1662
"""A deprecated function to test applyDeprecated with."""
1666
def sample_undeprecated_function(a_param):
1667
"""A undeprecated function to test applyDeprecated with."""
1670
class ApplyDeprecatedHelper(object):
1671
"""A helper class for ApplyDeprecated tests."""
1673
@deprecated_method(deprecated_in((0, 11, 0)))
1674
def sample_deprecated_method(self, param_one):
1675
"""A deprecated method for testing with."""
1678
def sample_normal_method(self):
1679
"""A undeprecated method."""
1681
@deprecated_method(deprecated_in((0, 10, 0)))
1682
def sample_nested_deprecation(self):
1683
return sample_deprecated_function()
1686
class TestExtraAssertions(tests.TestCase):
1687
"""Tests for new test assertions in bzrlib test suite"""
1689
def test_assert_isinstance(self):
1690
self.assertIsInstance(2, int)
1691
self.assertIsInstance(u'', basestring)
1692
e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1693
self.assertEquals(str(e),
1694
"None is an instance of <type 'NoneType'> rather than <type 'int'>")
1695
self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1696
e = self.assertRaises(AssertionError,
1697
self.assertIsInstance, None, int, "it's just not")
1698
self.assertEquals(str(e),
1699
"None is an instance of <type 'NoneType'> rather than <type 'int'>"
1702
def test_assertEndsWith(self):
1703
self.assertEndsWith('foo', 'oo')
1704
self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1706
def test_assertEqualDiff(self):
1707
e = self.assertRaises(AssertionError,
1708
self.assertEqualDiff, '', '\n')
1709
self.assertEquals(str(e),
1710
# Don't blink ! The '+' applies to the second string
1711
'first string is missing a final newline.\n+ \n')
1712
e = self.assertRaises(AssertionError,
1713
self.assertEqualDiff, '\n', '')
1714
self.assertEquals(str(e),
1715
# Don't blink ! The '-' applies to the second string
1716
'second string is missing a final newline.\n- \n')
1719
class TestDeprecations(tests.TestCase):
1721
def test_applyDeprecated_not_deprecated(self):
1722
sample_object = ApplyDeprecatedHelper()
1723
# calling an undeprecated callable raises an assertion
1724
self.assertRaises(AssertionError, self.applyDeprecated,
1725
deprecated_in((0, 11, 0)),
1726
sample_object.sample_normal_method)
1727
self.assertRaises(AssertionError, self.applyDeprecated,
1728
deprecated_in((0, 11, 0)),
1729
sample_undeprecated_function, "a param value")
1730
# calling a deprecated callable (function or method) with the wrong
1731
# expected deprecation fails.
1732
self.assertRaises(AssertionError, self.applyDeprecated,
1733
deprecated_in((0, 10, 0)),
1734
sample_object.sample_deprecated_method, "a param value")
1735
self.assertRaises(AssertionError, self.applyDeprecated,
1736
deprecated_in((0, 10, 0)),
1737
sample_deprecated_function)
1738
# calling a deprecated callable (function or method) with the right
1739
# expected deprecation returns the functions result.
1740
self.assertEqual("a param value",
1741
self.applyDeprecated(deprecated_in((0, 11, 0)),
1742
sample_object.sample_deprecated_method, "a param value"))
1743
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 11, 0)),
1744
sample_deprecated_function))
1745
# calling a nested deprecation with the wrong deprecation version
1746
# fails even if a deeper nested function was deprecated with the
1748
self.assertRaises(AssertionError, self.applyDeprecated,
1749
deprecated_in((0, 11, 0)), sample_object.sample_nested_deprecation)
1750
# calling a nested deprecation with the right deprecation value
1751
# returns the calls result.
1752
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 10, 0)),
1753
sample_object.sample_nested_deprecation))
1755
def test_callDeprecated(self):
1756
def testfunc(be_deprecated, result=None):
1757
if be_deprecated is True:
1758
symbol_versioning.warn('i am deprecated', DeprecationWarning,
1761
result = self.callDeprecated(['i am deprecated'], testfunc, True)
1762
self.assertIs(None, result)
1763
result = self.callDeprecated([], testfunc, False, 'result')
1764
self.assertEqual('result', result)
1765
self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
1766
self.callDeprecated([], testfunc, be_deprecated=False)
1769
class TestWarningTests(tests.TestCase):
1770
"""Tests for calling methods that raise warnings."""
1772
def test_callCatchWarnings(self):
1774
warnings.warn("this is your last warning")
1776
wlist, result = self.callCatchWarnings(meth, 1, 2)
1777
self.assertEquals(3, result)
1778
# would like just to compare them, but UserWarning doesn't implement
1781
self.assertIsInstance(w0, UserWarning)
1782
self.assertEquals("this is your last warning", str(w0))
1785
class TestConvenienceMakers(tests.TestCaseWithTransport):
1786
"""Test for the make_* convenience functions."""
1788
def test_make_branch_and_tree_with_format(self):
1789
# we should be able to supply a format to make_branch_and_tree
1790
self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
1791
self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
1792
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
1793
bzrlib.bzrdir.BzrDirMetaFormat1)
1794
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
1795
bzrlib.bzrdir.BzrDirFormat6)
1797
def test_make_branch_and_memory_tree(self):
1798
# we should be able to get a new branch and a mutable tree from
1799
# TestCaseWithTransport
1800
tree = self.make_branch_and_memory_tree('a')
1801
self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1803
def test_make_tree_for_local_vfs_backed_transport(self):
1804
# make_branch_and_tree has to use local branch and repositories
1805
# when the vfs transport and local disk are colocated, even if
1806
# a different transport is in use for url generation.
1807
self.transport_server = test_server.FakeVFATServer
1808
self.assertFalse(self.get_url('t1').startswith('file://'))
1809
tree = self.make_branch_and_tree('t1')
1810
base = tree.bzrdir.root_transport.base
1811
self.assertStartsWith(base, 'file://')
1812
self.assertEquals(tree.bzrdir.root_transport,
1813
tree.branch.bzrdir.root_transport)
1814
self.assertEquals(tree.bzrdir.root_transport,
1815
tree.branch.repository.bzrdir.root_transport)
1818
class SelfTestHelper:
1820
def run_selftest(self, **kwargs):
1821
"""Run selftest returning its output."""
1823
old_transport = bzrlib.tests.default_transport
1824
old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
1825
tests.TestCaseWithMemoryTransport.TEST_ROOT = None
1827
self.assertEqual(True, tests.selftest(stream=output, **kwargs))
1829
bzrlib.tests.default_transport = old_transport
1830
tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
1835
class TestSelftest(tests.TestCase, SelfTestHelper):
1836
"""Tests of bzrlib.tests.selftest."""
1838
def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1841
factory_called.append(True)
1842
return TestUtil.TestSuite()
1845
self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1846
test_suite_factory=factory)
1847
self.assertEqual([True], factory_called)
1850
"""A test suite factory."""
1851
class Test(tests.TestCase):
1858
return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
1860
def test_list_only(self):
1861
output = self.run_selftest(test_suite_factory=self.factory,
1863
self.assertEqual(3, len(output.readlines()))
1865
def test_list_only_filtered(self):
1866
output = self.run_selftest(test_suite_factory=self.factory,
1867
list_only=True, pattern="Test.b")
1868
self.assertEndsWith(output.getvalue(), "Test.b\n")
1869
self.assertLength(1, output.readlines())
1871
def test_list_only_excludes(self):
1872
output = self.run_selftest(test_suite_factory=self.factory,
1873
list_only=True, exclude_pattern="Test.b")
1874
self.assertNotContainsRe("Test.b", output.getvalue())
1875
self.assertLength(2, output.readlines())
1877
def test_lsprof_tests(self):
1878
self.requireFeature(test_lsprof.LSProfFeature)
1881
def __call__(test, result):
1883
def run(test, result):
1884
self.assertIsInstance(result, tests.ForwardingResult)
1885
calls.append("called")
1886
def countTestCases(self):
1888
self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
1889
self.assertLength(1, calls)
1891
def test_random(self):
1892
# test randomising by listing a number of tests.
1893
output_123 = self.run_selftest(test_suite_factory=self.factory,
1894
list_only=True, random_seed="123")
1895
output_234 = self.run_selftest(test_suite_factory=self.factory,
1896
list_only=True, random_seed="234")
1897
self.assertNotEqual(output_123, output_234)
1898
# "Randominzing test order..\n\n
1899
self.assertLength(5, output_123.readlines())
1900
self.assertLength(5, output_234.readlines())
1902
def test_random_reuse_is_same_order(self):
1903
# test randomising by listing a number of tests.
1904
expected = self.run_selftest(test_suite_factory=self.factory,
1905
list_only=True, random_seed="123")
1906
repeated = self.run_selftest(test_suite_factory=self.factory,
1907
list_only=True, random_seed="123")
1908
self.assertEqual(expected.getvalue(), repeated.getvalue())
1910
def test_runner_class(self):
1911
self.requireFeature(features.subunit)
1912
from subunit import ProtocolTestCase
1913
stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
1914
test_suite_factory=self.factory)
1915
test = ProtocolTestCase(stream)
1916
result = unittest.TestResult()
1918
self.assertEqual(3, result.testsRun)
1920
def test_starting_with_single_argument(self):
1921
output = self.run_selftest(test_suite_factory=self.factory,
1922
starting_with=['bzrlib.tests.test_selftest.Test.a'],
1924
self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
1927
def test_starting_with_multiple_argument(self):
1928
output = self.run_selftest(test_suite_factory=self.factory,
1929
starting_with=['bzrlib.tests.test_selftest.Test.a',
1930
'bzrlib.tests.test_selftest.Test.b'],
1932
self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
1933
'bzrlib.tests.test_selftest.Test.b\n',
1936
def check_transport_set(self, transport_server):
1937
captured_transport = []
1938
def seen_transport(a_transport):
1939
captured_transport.append(a_transport)
1940
class Capture(tests.TestCase):
1942
seen_transport(bzrlib.tests.default_transport)
1944
return TestUtil.TestSuite([Capture("a")])
1945
self.run_selftest(transport=transport_server, test_suite_factory=factory)
1946
self.assertEqual(transport_server, captured_transport[0])
1948
def test_transport_sftp(self):
1949
self.requireFeature(features.paramiko)
1950
from bzrlib.tests import stub_sftp
1951
self.check_transport_set(stub_sftp.SFTPAbsoluteServer)
1953
def test_transport_memory(self):
1954
self.check_transport_set(memory.MemoryServer)
1957
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
1958
# Does IO: reads test.list
1960
def test_load_list(self):
1961
# Provide a list with one test - this test.
1962
test_id_line = '%s\n' % self.id()
1963
self.build_tree_contents([('test.list', test_id_line)])
1964
# And generate a list of the tests in the suite.
1965
stream = self.run_selftest(load_list='test.list', list_only=True)
1966
self.assertEqual(test_id_line, stream.getvalue())
1968
def test_load_unknown(self):
1969
# Provide a list with one test - this test.
1970
# And generate a list of the tests in the suite.
1971
err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
1972
load_list='missing file name', list_only=True)
1975
class TestRunBzr(tests.TestCase):
1980
def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
1982
"""Override _run_bzr_core to test how it is invoked by run_bzr.
1984
Attempts to run bzr from inside this class don't actually run it.
1986
We test how run_bzr actually invokes bzr in another location. Here we
1987
only need to test that it passes the right parameters to run_bzr.
1989
self.argv = list(argv)
1990
self.retcode = retcode
1991
self.encoding = encoding
1993
self.working_dir = working_dir
1994
return self.retcode, self.out, self.err
1996
def test_run_bzr_error(self):
1997
self.out = "It sure does!\n"
1998
out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
1999
self.assertEqual(['rocks'], self.argv)
2000
self.assertEqual(34, self.retcode)
2001
self.assertEqual('It sure does!\n', out)
2002
self.assertEquals(out, self.out)
2003
self.assertEqual('', err)
2004
self.assertEquals(err, self.err)
2006
def test_run_bzr_error_regexes(self):
2008
self.err = "bzr: ERROR: foobarbaz is not versioned"
2009
out, err = self.run_bzr_error(
2010
["bzr: ERROR: foobarbaz is not versioned"],
2011
['file-id', 'foobarbaz'])
2013
def test_encoding(self):
2014
"""Test that run_bzr passes encoding to _run_bzr_core"""
2015
self.run_bzr('foo bar')
2016
self.assertEqual(None, self.encoding)
2017
self.assertEqual(['foo', 'bar'], self.argv)
2019
self.run_bzr('foo bar', encoding='baz')
2020
self.assertEqual('baz', self.encoding)
2021
self.assertEqual(['foo', 'bar'], self.argv)
2023
def test_retcode(self):
2024
"""Test that run_bzr passes retcode to _run_bzr_core"""
2025
# Default is retcode == 0
2026
self.run_bzr('foo bar')
2027
self.assertEqual(0, self.retcode)
2028
self.assertEqual(['foo', 'bar'], self.argv)
2030
self.run_bzr('foo bar', retcode=1)
2031
self.assertEqual(1, self.retcode)
2032
self.assertEqual(['foo', 'bar'], self.argv)
2034
self.run_bzr('foo bar', retcode=None)
2035
self.assertEqual(None, self.retcode)
2036
self.assertEqual(['foo', 'bar'], self.argv)
2038
self.run_bzr(['foo', 'bar'], retcode=3)
2039
self.assertEqual(3, self.retcode)
2040
self.assertEqual(['foo', 'bar'], self.argv)
2042
def test_stdin(self):
2043
# test that the stdin keyword to run_bzr is passed through to
2044
# _run_bzr_core as-is. We do this by overriding
2045
# _run_bzr_core in this class, and then calling run_bzr,
2046
# which is a convenience function for _run_bzr_core, so
2048
self.run_bzr('foo bar', stdin='gam')
2049
self.assertEqual('gam', self.stdin)
2050
self.assertEqual(['foo', 'bar'], self.argv)
2052
self.run_bzr('foo bar', stdin='zippy')
2053
self.assertEqual('zippy', self.stdin)
2054
self.assertEqual(['foo', 'bar'], self.argv)
2056
def test_working_dir(self):
2057
"""Test that run_bzr passes working_dir to _run_bzr_core"""
2058
self.run_bzr('foo bar')
2059
self.assertEqual(None, self.working_dir)
2060
self.assertEqual(['foo', 'bar'], self.argv)
2062
self.run_bzr('foo bar', working_dir='baz')
2063
self.assertEqual('baz', self.working_dir)
2064
self.assertEqual(['foo', 'bar'], self.argv)
2066
def test_reject_extra_keyword_arguments(self):
2067
self.assertRaises(TypeError, self.run_bzr, "foo bar",
2068
error_regex=['error message'])
2071
class TestRunBzrCaptured(tests.TestCaseWithTransport):
2072
# Does IO when testing the working_dir parameter.
2074
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2075
a_callable=None, *args, **kwargs):
2077
self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
2078
self.factory = bzrlib.ui.ui_factory
2079
self.working_dir = osutils.getcwd()
2080
stdout.write('foo\n')
2081
stderr.write('bar\n')
2084
def test_stdin(self):
2085
# test that the stdin keyword to _run_bzr_core is passed through to
2086
# apply_redirected as a StringIO. We do this by overriding
2087
# apply_redirected in this class, and then calling _run_bzr_core,
2088
# which calls apply_redirected.
2089
self.run_bzr(['foo', 'bar'], stdin='gam')
2090
self.assertEqual('gam', self.stdin.read())
2091
self.assertTrue(self.stdin is self.factory_stdin)
2092
self.run_bzr(['foo', 'bar'], stdin='zippy')
2093
self.assertEqual('zippy', self.stdin.read())
2094
self.assertTrue(self.stdin is self.factory_stdin)
2096
def test_ui_factory(self):
2097
# each invocation of self.run_bzr should get its
2098
# own UI factory, which is an instance of TestUIFactory,
2099
# with stdin, stdout and stderr attached to the stdin,
2100
# stdout and stderr of the invoked run_bzr
2101
current_factory = bzrlib.ui.ui_factory
2102
self.run_bzr(['foo'])
2103
self.failIf(current_factory is self.factory)
2104
self.assertNotEqual(sys.stdout, self.factory.stdout)
2105
self.assertNotEqual(sys.stderr, self.factory.stderr)
2106
self.assertEqual('foo\n', self.factory.stdout.getvalue())
2107
self.assertEqual('bar\n', self.factory.stderr.getvalue())
2108
self.assertIsInstance(self.factory, tests.TestUIFactory)
2110
def test_working_dir(self):
2111
self.build_tree(['one/', 'two/'])
2112
cwd = osutils.getcwd()
2114
# Default is to work in the current directory
2115
self.run_bzr(['foo', 'bar'])
2116
self.assertEqual(cwd, self.working_dir)
2118
self.run_bzr(['foo', 'bar'], working_dir=None)
2119
self.assertEqual(cwd, self.working_dir)
2121
# The function should be run in the alternative directory
2122
# but afterwards the current working dir shouldn't be changed
2123
self.run_bzr(['foo', 'bar'], working_dir='one')
2124
self.assertNotEqual(cwd, self.working_dir)
2125
self.assertEndsWith(self.working_dir, 'one')
2126
self.assertEqual(cwd, osutils.getcwd())
2128
self.run_bzr(['foo', 'bar'], working_dir='two')
2129
self.assertNotEqual(cwd, self.working_dir)
2130
self.assertEndsWith(self.working_dir, 'two')
2131
self.assertEqual(cwd, osutils.getcwd())
2134
class StubProcess(object):
2135
"""A stub process for testing run_bzr_subprocess."""
2137
def __init__(self, out="", err="", retcode=0):
2140
self.returncode = retcode
2142
def communicate(self):
2143
return self.out, self.err
2146
class TestWithFakedStartBzrSubprocess(tests.TestCaseWithTransport):
2147
"""Base class for tests testing how we might run bzr."""
2150
tests.TestCaseWithTransport.setUp(self)
2151
self.subprocess_calls = []
2153
def start_bzr_subprocess(self, process_args, env_changes=None,
2154
skip_if_plan_to_signal=False,
2156
allow_plugins=False):
2157
"""capture what run_bzr_subprocess tries to do."""
2158
self.subprocess_calls.append({'process_args':process_args,
2159
'env_changes':env_changes,
2160
'skip_if_plan_to_signal':skip_if_plan_to_signal,
2161
'working_dir':working_dir, 'allow_plugins':allow_plugins})
2162
return self.next_subprocess
2165
class TestRunBzrSubprocess(TestWithFakedStartBzrSubprocess):
2167
def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
2168
"""Run run_bzr_subprocess with args and kwargs using a stubbed process.
2170
Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
2171
that will return static results. This assertion method populates those
2172
results and also checks the arguments run_bzr_subprocess generates.
2174
self.next_subprocess = process
2176
result = self.run_bzr_subprocess(*args, **kwargs)
2178
self.next_subprocess = None
2179
for key, expected in expected_args.iteritems():
2180
self.assertEqual(expected, self.subprocess_calls[-1][key])
2183
self.next_subprocess = None
2184
for key, expected in expected_args.iteritems():
2185
self.assertEqual(expected, self.subprocess_calls[-1][key])
2188
def test_run_bzr_subprocess(self):
2189
"""The run_bzr_helper_external command behaves nicely."""
2190
self.assertRunBzrSubprocess({'process_args':['--version']},
2191
StubProcess(), '--version')
2192
self.assertRunBzrSubprocess({'process_args':['--version']},
2193
StubProcess(), ['--version'])
2194
# retcode=None disables retcode checking
2195
result = self.assertRunBzrSubprocess({},
2196
StubProcess(retcode=3), '--version', retcode=None)
2197
result = self.assertRunBzrSubprocess({},
2198
StubProcess(out="is free software"), '--version')
2199
self.assertContainsRe(result[0], 'is free software')
2200
# Running a subcommand that is missing errors
2201
self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
2202
{'process_args':['--versionn']}, StubProcess(retcode=3),
2204
# Unless it is told to expect the error from the subprocess
2205
result = self.assertRunBzrSubprocess({},
2206
StubProcess(retcode=3), '--versionn', retcode=3)
2207
# Or to ignore retcode checking
2208
result = self.assertRunBzrSubprocess({},
2209
StubProcess(err="unknown command", retcode=3), '--versionn',
2211
self.assertContainsRe(result[1], 'unknown command')
2213
def test_env_change_passes_through(self):
2214
self.assertRunBzrSubprocess(
2215
{'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
2217
env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
2219
def test_no_working_dir_passed_as_None(self):
2220
self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
2222
def test_no_working_dir_passed_through(self):
2223
self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
2226
def test_run_bzr_subprocess_no_plugins(self):
2227
self.assertRunBzrSubprocess({'allow_plugins': False},
2230
def test_allow_plugins(self):
2231
self.assertRunBzrSubprocess({'allow_plugins': True},
2232
StubProcess(), '', allow_plugins=True)
2235
class TestFinishBzrSubprocess(TestWithFakedStartBzrSubprocess):
2237
def test_finish_bzr_subprocess_with_error(self):
2238
"""finish_bzr_subprocess allows specification of the desired exit code.
2240
process = StubProcess(err="unknown command", retcode=3)
2241
result = self.finish_bzr_subprocess(process, retcode=3)
2242
self.assertEqual('', result[0])
2243
self.assertContainsRe(result[1], 'unknown command')
2245
def test_finish_bzr_subprocess_ignoring_retcode(self):
2246
"""finish_bzr_subprocess allows the exit code to be ignored."""
2247
process = StubProcess(err="unknown command", retcode=3)
2248
result = self.finish_bzr_subprocess(process, retcode=None)
2249
self.assertEqual('', result[0])
2250
self.assertContainsRe(result[1], 'unknown command')
2252
def test_finish_subprocess_with_unexpected_retcode(self):
2253
"""finish_bzr_subprocess raises self.failureException if the retcode is
2254
not the expected one.
2256
process = StubProcess(err="unknown command", retcode=3)
2257
self.assertRaises(self.failureException, self.finish_bzr_subprocess,
2261
class _DontSpawnProcess(Exception):
2262
"""A simple exception which just allows us to skip unnecessary steps"""
2265
class TestStartBzrSubProcess(tests.TestCase):
2267
def check_popen_state(self):
2268
"""Replace to make assertions when popen is called."""
2270
def _popen(self, *args, **kwargs):
2271
"""Record the command that is run, so that we can ensure it is correct"""
2272
self.check_popen_state()
2273
self._popen_args = args
2274
self._popen_kwargs = kwargs
2275
raise _DontSpawnProcess()
2277
def test_run_bzr_subprocess_no_plugins(self):
2278
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
2279
command = self._popen_args[0]
2280
self.assertEqual(sys.executable, command[0])
2281
self.assertEqual(self.get_bzr_path(), command[1])
2282
self.assertEqual(['--no-plugins'], command[2:])
2284
def test_allow_plugins(self):
2285
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2287
command = self._popen_args[0]
2288
self.assertEqual([], command[2:])
2290
def test_set_env(self):
2291
self.failIf('EXISTANT_ENV_VAR' in os.environ)
2293
def check_environment():
2294
self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2295
self.check_popen_state = check_environment
2296
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2297
env_changes={'EXISTANT_ENV_VAR':'set variable'})
2298
# not set in theparent
2299
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2301
def test_run_bzr_subprocess_env_del(self):
2302
"""run_bzr_subprocess can remove environment variables too."""
2303
self.failIf('EXISTANT_ENV_VAR' in os.environ)
2304
def check_environment():
2305
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2306
os.environ['EXISTANT_ENV_VAR'] = 'set variable'
2307
self.check_popen_state = check_environment
2308
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2309
env_changes={'EXISTANT_ENV_VAR':None})
2310
# Still set in parent
2311
self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2312
del os.environ['EXISTANT_ENV_VAR']
2314
def test_env_del_missing(self):
2315
self.failIf('NON_EXISTANT_ENV_VAR' in os.environ)
2316
def check_environment():
2317
self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2318
self.check_popen_state = check_environment
2319
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2320
env_changes={'NON_EXISTANT_ENV_VAR':None})
2322
def test_working_dir(self):
2323
"""Test that we can specify the working dir for the child"""
2324
orig_getcwd = osutils.getcwd
2325
orig_chdir = os.chdir
2333
osutils.getcwd = getcwd
2335
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2338
osutils.getcwd = orig_getcwd
2340
os.chdir = orig_chdir
2341
self.assertEqual(['foo', 'current'], chdirs)
2343
def test_get_bzr_path_with_cwd_bzrlib(self):
2344
self.get_source_path = lambda: ""
2345
self.overrideAttr(os.path, "isfile", lambda path: True)
2346
self.assertEqual(self.get_bzr_path(), "bzr")
2349
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
2350
"""Tests that really need to do things with an external bzr."""
2352
def test_start_and_stop_bzr_subprocess_send_signal(self):
2353
"""finish_bzr_subprocess raises self.failureException if the retcode is
2354
not the expected one.
2356
self.disable_missing_extensions_warning()
2357
process = self.start_bzr_subprocess(['wait-until-signalled'],
2358
skip_if_plan_to_signal=True)
2359
self.assertEqual('running\n', process.stdout.readline())
2360
result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
2362
self.assertEqual('', result[0])
2363
self.assertEqual('bzr: interrupted\n', result[1])
2366
class TestFeature(tests.TestCase):
2368
def test_caching(self):
2369
"""Feature._probe is called by the feature at most once."""
2370
class InstrumentedFeature(tests.Feature):
2372
super(InstrumentedFeature, self).__init__()
2375
self.calls.append('_probe')
2377
feature = InstrumentedFeature()
2379
self.assertEqual(['_probe'], feature.calls)
2381
self.assertEqual(['_probe'], feature.calls)
2383
def test_named_str(self):
2384
"""Feature.__str__ should thunk to feature_name()."""
2385
class NamedFeature(tests.Feature):
2386
def feature_name(self):
2388
feature = NamedFeature()
2389
self.assertEqual('symlinks', str(feature))
2391
def test_default_str(self):
2392
"""Feature.__str__ should default to __class__.__name__."""
2393
class NamedFeature(tests.Feature):
2395
feature = NamedFeature()
2396
self.assertEqual('NamedFeature', str(feature))
2399
class TestUnavailableFeature(tests.TestCase):
2401
def test_access_feature(self):
2402
feature = tests.Feature()
2403
exception = tests.UnavailableFeature(feature)
2404
self.assertIs(feature, exception.args[0])
2407
simple_thunk_feature = tests._CompatabilityThunkFeature(
2408
deprecated_in((2, 1, 0)),
2409
'bzrlib.tests.test_selftest',
2410
'simple_thunk_feature','UnicodeFilename',
2411
replacement_module='bzrlib.tests'
2414
class Test_CompatibilityFeature(tests.TestCase):
2416
def test_does_thunk(self):
2417
res = self.callDeprecated(
2418
['bzrlib.tests.test_selftest.simple_thunk_feature was deprecated'
2419
' in version 2.1.0. Use bzrlib.tests.UnicodeFilename instead.'],
2420
simple_thunk_feature.available)
2421
self.assertEqual(tests.UnicodeFilename.available(), res)
2424
class TestModuleAvailableFeature(tests.TestCase):
2426
def test_available_module(self):
2427
feature = tests.ModuleAvailableFeature('bzrlib.tests')
2428
self.assertEqual('bzrlib.tests', feature.module_name)
2429
self.assertEqual('bzrlib.tests', str(feature))
2430
self.assertTrue(feature.available())
2431
self.assertIs(tests, feature.module)
2433
def test_unavailable_module(self):
2434
feature = tests.ModuleAvailableFeature('bzrlib.no_such_module_exists')
2435
self.assertEqual('bzrlib.no_such_module_exists', str(feature))
2436
self.assertFalse(feature.available())
2437
self.assertIs(None, feature.module)
2440
class TestSelftestFiltering(tests.TestCase):
2443
tests.TestCase.setUp(self)
2444
self.suite = TestUtil.TestSuite()
2445
self.loader = TestUtil.TestLoader()
2446
self.suite.addTest(self.loader.loadTestsFromModule(
2447
sys.modules['bzrlib.tests.test_selftest']))
2448
self.all_names = _test_ids(self.suite)
2450
def test_condition_id_re(self):
2451
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2452
'test_condition_id_re')
2453
filtered_suite = tests.filter_suite_by_condition(
2454
self.suite, tests.condition_id_re('test_condition_id_re'))
2455
self.assertEqual([test_name], _test_ids(filtered_suite))
2457
def test_condition_id_in_list(self):
2458
test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
2459
'test_condition_id_in_list']
2460
id_list = tests.TestIdList(test_names)
2461
filtered_suite = tests.filter_suite_by_condition(
2462
self.suite, tests.condition_id_in_list(id_list))
2463
my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
2464
re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
2465
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2467
def test_condition_id_startswith(self):
2468
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2469
start1 = klass + 'test_condition_id_starts'
2470
start2 = klass + 'test_condition_id_in'
2471
test_names = [ klass + 'test_condition_id_in_list',
2472
klass + 'test_condition_id_startswith',
2474
filtered_suite = tests.filter_suite_by_condition(
2475
self.suite, tests.condition_id_startswith([start1, start2]))
2476
self.assertEqual(test_names, _test_ids(filtered_suite))
2478
def test_condition_isinstance(self):
2479
filtered_suite = tests.filter_suite_by_condition(
2480
self.suite, tests.condition_isinstance(self.__class__))
2481
class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2482
re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
2483
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2485
def test_exclude_tests_by_condition(self):
2486
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2487
'test_exclude_tests_by_condition')
2488
filtered_suite = tests.exclude_tests_by_condition(self.suite,
2489
lambda x:x.id() == excluded_name)
2490
self.assertEqual(len(self.all_names) - 1,
2491
filtered_suite.countTestCases())
2492
self.assertFalse(excluded_name in _test_ids(filtered_suite))
2493
remaining_names = list(self.all_names)
2494
remaining_names.remove(excluded_name)
2495
self.assertEqual(remaining_names, _test_ids(filtered_suite))
2497
def test_exclude_tests_by_re(self):
2498
self.all_names = _test_ids(self.suite)
2499
filtered_suite = tests.exclude_tests_by_re(self.suite,
2500
'exclude_tests_by_re')
2501
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2502
'test_exclude_tests_by_re')
2503
self.assertEqual(len(self.all_names) - 1,
2504
filtered_suite.countTestCases())
2505
self.assertFalse(excluded_name in _test_ids(filtered_suite))
2506
remaining_names = list(self.all_names)
2507
remaining_names.remove(excluded_name)
2508
self.assertEqual(remaining_names, _test_ids(filtered_suite))
2510
def test_filter_suite_by_condition(self):
2511
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2512
'test_filter_suite_by_condition')
2513
filtered_suite = tests.filter_suite_by_condition(self.suite,
2514
lambda x:x.id() == test_name)
2515
self.assertEqual([test_name], _test_ids(filtered_suite))
2517
def test_filter_suite_by_re(self):
2518
filtered_suite = tests.filter_suite_by_re(self.suite,
2519
'test_filter_suite_by_r')
2520
filtered_names = _test_ids(filtered_suite)
2521
self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
2522
'TestSelftestFiltering.test_filter_suite_by_re'])
2524
def test_filter_suite_by_id_list(self):
2525
test_list = ['bzrlib.tests.test_selftest.'
2526
'TestSelftestFiltering.test_filter_suite_by_id_list']
2527
filtered_suite = tests.filter_suite_by_id_list(
2528
self.suite, tests.TestIdList(test_list))
2529
filtered_names = _test_ids(filtered_suite)
2532
['bzrlib.tests.test_selftest.'
2533
'TestSelftestFiltering.test_filter_suite_by_id_list'])
2535
def test_filter_suite_by_id_startswith(self):
2536
# By design this test may fail if another test is added whose name also
2537
# begins with one of the start value used.
2538
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2539
start1 = klass + 'test_filter_suite_by_id_starts'
2540
start2 = klass + 'test_filter_suite_by_id_li'
2541
test_list = [klass + 'test_filter_suite_by_id_list',
2542
klass + 'test_filter_suite_by_id_startswith',
2544
filtered_suite = tests.filter_suite_by_id_startswith(
2545
self.suite, [start1, start2])
2548
_test_ids(filtered_suite),
2551
def test_preserve_input(self):
2552
# NB: Surely this is something in the stdlib to do this?
2553
self.assertTrue(self.suite is tests.preserve_input(self.suite))
2554
self.assertTrue("@#$" is tests.preserve_input("@#$"))
2556
def test_randomize_suite(self):
2557
randomized_suite = tests.randomize_suite(self.suite)
2558
# randomizing should not add or remove test names.
2559
self.assertEqual(set(_test_ids(self.suite)),
2560
set(_test_ids(randomized_suite)))
2561
# Technically, this *can* fail, because random.shuffle(list) can be
2562
# equal to list. Trying multiple times just pushes the frequency back.
2563
# As its len(self.all_names)!:1, the failure frequency should be low
2564
# enough to ignore. RBC 20071021.
2565
# It should change the order.
2566
self.assertNotEqual(self.all_names, _test_ids(randomized_suite))
2567
# But not the length. (Possibly redundant with the set test, but not
2569
self.assertEqual(len(self.all_names), len(_test_ids(randomized_suite)))
2571
def test_split_suit_by_condition(self):
2572
self.all_names = _test_ids(self.suite)
2573
condition = tests.condition_id_re('test_filter_suite_by_r')
2574
split_suite = tests.split_suite_by_condition(self.suite, condition)
2575
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2576
'test_filter_suite_by_re')
2577
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2578
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2579
remaining_names = list(self.all_names)
2580
remaining_names.remove(filtered_name)
2581
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2583
def test_split_suit_by_re(self):
2584
self.all_names = _test_ids(self.suite)
2585
split_suite = tests.split_suite_by_re(self.suite,
2586
'test_filter_suite_by_r')
2587
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2588
'test_filter_suite_by_re')
2589
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2590
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2591
remaining_names = list(self.all_names)
2592
remaining_names.remove(filtered_name)
2593
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2596
class TestCheckInventoryShape(tests.TestCaseWithTransport):
2598
def test_check_inventory_shape(self):
2599
files = ['a', 'b/', 'b/c']
2600
tree = self.make_branch_and_tree('.')
2601
self.build_tree(files)
2605
self.check_inventory_shape(tree.inventory, files)
2610
class TestBlackboxSupport(tests.TestCase):
2611
"""Tests for testsuite blackbox features."""
2613
def test_run_bzr_failure_not_caught(self):
2614
# When we run bzr in blackbox mode, we want any unexpected errors to
2615
# propagate up to the test suite so that it can show the error in the
2616
# usual way, and we won't get a double traceback.
2617
e = self.assertRaises(
2619
self.run_bzr, ['assert-fail'])
2620
# make sure we got the real thing, not an error from somewhere else in
2621
# the test framework
2622
self.assertEquals('always fails', str(e))
2623
# check that there's no traceback in the test log
2624
self.assertNotContainsRe(self.get_log(), r'Traceback')
2626
def test_run_bzr_user_error_caught(self):
2627
# Running bzr in blackbox mode, normal/expected/user errors should be
2628
# caught in the regular way and turned into an error message plus exit
2630
transport_server = memory.MemoryServer()
2631
transport_server.start_server()
2632
self.addCleanup(transport_server.stop_server)
2633
url = transport_server.get_url()
2634
self.permit_url(url)
2635
out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
2636
self.assertEqual(out, '')
2637
self.assertContainsRe(err,
2638
'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
2641
class TestTestLoader(tests.TestCase):
2642
"""Tests for the test loader."""
2644
def _get_loader_and_module(self):
2645
"""Gets a TestLoader and a module with one test in it."""
2646
loader = TestUtil.TestLoader()
2648
class Stub(tests.TestCase):
2651
class MyModule(object):
2653
MyModule.a_class = Stub
2655
return loader, module
2657
def test_module_no_load_tests_attribute_loads_classes(self):
2658
loader, module = self._get_loader_and_module()
2659
self.assertEqual(1, loader.loadTestsFromModule(module).countTestCases())
2661
def test_module_load_tests_attribute_gets_called(self):
2662
loader, module = self._get_loader_and_module()
2663
# 'self' is here because we're faking the module with a class. Regular
2664
# load_tests do not need that :)
2665
def load_tests(self, standard_tests, module, loader):
2666
result = loader.suiteClass()
2667
for test in tests.iter_suite_tests(standard_tests):
2668
result.addTests([test, test])
2670
# add a load_tests() method which multiplies the tests from the module.
2671
module.__class__.load_tests = load_tests
2672
self.assertEqual(2, loader.loadTestsFromModule(module).countTestCases())
2674
def test_load_tests_from_module_name_smoke_test(self):
2675
loader = TestUtil.TestLoader()
2676
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2677
self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2680
def test_load_tests_from_module_name_with_bogus_module_name(self):
2681
loader = TestUtil.TestLoader()
2682
self.assertRaises(ImportError, loader.loadTestsFromModuleName, 'bogus')
2685
class TestTestIdList(tests.TestCase):
2687
def _create_id_list(self, test_list):
2688
return tests.TestIdList(test_list)
2690
def _create_suite(self, test_id_list):
2692
class Stub(tests.TestCase):
2696
def _create_test_id(id):
2699
suite = TestUtil.TestSuite()
2700
for id in test_id_list:
2701
t = Stub('test_foo')
2702
t.id = _create_test_id(id)
2706
def _test_ids(self, test_suite):
2707
"""Get the ids for the tests in a test suite."""
2708
return [t.id() for t in tests.iter_suite_tests(test_suite)]
2710
def test_empty_list(self):
2711
id_list = self._create_id_list([])
2712
self.assertEquals({}, id_list.tests)
2713
self.assertEquals({}, id_list.modules)
2715
def test_valid_list(self):
2716
id_list = self._create_id_list(
2717
['mod1.cl1.meth1', 'mod1.cl1.meth2',
2718
'mod1.func1', 'mod1.cl2.meth2',
2720
'mod1.submod2.cl1.meth1', 'mod1.submod2.cl2.meth2',
2722
self.assertTrue(id_list.refers_to('mod1'))
2723
self.assertTrue(id_list.refers_to('mod1.submod1'))
2724
self.assertTrue(id_list.refers_to('mod1.submod2'))
2725
self.assertTrue(id_list.includes('mod1.cl1.meth1'))
2726
self.assertTrue(id_list.includes('mod1.submod1'))
2727
self.assertTrue(id_list.includes('mod1.func1'))
2729
def test_bad_chars_in_params(self):
2730
id_list = self._create_id_list(['mod1.cl1.meth1(xx.yy)'])
2731
self.assertTrue(id_list.refers_to('mod1'))
2732
self.assertTrue(id_list.includes('mod1.cl1.meth1(xx.yy)'))
2734
def test_module_used(self):
2735
id_list = self._create_id_list(['mod.class.meth'])
2736
self.assertTrue(id_list.refers_to('mod'))
2737
self.assertTrue(id_list.refers_to('mod.class'))
2738
self.assertTrue(id_list.refers_to('mod.class.meth'))
2740
def test_test_suite_matches_id_list_with_unknown(self):
2741
loader = TestUtil.TestLoader()
2742
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2743
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',
2745
not_found, duplicates = tests.suite_matches_id_list(suite, test_list)
2746
self.assertEquals(['bogus'], not_found)
2747
self.assertEquals([], duplicates)
2749
def test_suite_matches_id_list_with_duplicates(self):
2750
loader = TestUtil.TestLoader()
2751
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2752
dupes = loader.suiteClass()
2753
for test in tests.iter_suite_tests(suite):
2755
dupes.addTest(test) # Add it again
2757
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',]
2758
not_found, duplicates = tests.suite_matches_id_list(
2760
self.assertEquals([], not_found)
2761
self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2765
class TestTestSuite(tests.TestCase):
2767
def test__test_suite_testmod_names(self):
2768
# Test that a plausible list of test module names are returned
2769
# by _test_suite_testmod_names.
2770
test_list = tests._test_suite_testmod_names()
2772
'bzrlib.tests.blackbox',
2773
'bzrlib.tests.per_transport',
2774
'bzrlib.tests.test_selftest',
2778
def test__test_suite_modules_to_doctest(self):
2779
# Test that a plausible list of modules to doctest is returned
2780
# by _test_suite_modules_to_doctest.
2781
test_list = tests._test_suite_modules_to_doctest()
2783
# When docstrings are stripped, there are no modules to doctest
2784
self.assertEqual([], test_list)
2791
def test_test_suite(self):
2792
# test_suite() loads the entire test suite to operate. To avoid this
2793
# overhead, and yet still be confident that things are happening,
2794
# we temporarily replace two functions used by test_suite with
2795
# test doubles that supply a few sample tests to load, and check they
2798
def testmod_names():
2799
calls.append("testmod_names")
2801
'bzrlib.tests.blackbox.test_branch',
2802
'bzrlib.tests.per_transport',
2803
'bzrlib.tests.test_selftest',
2805
self.overrideAttr(tests, '_test_suite_testmod_names', testmod_names)
2807
calls.append("modules_to_doctest")
2810
return ['bzrlib.timestamp']
2811
self.overrideAttr(tests, '_test_suite_modules_to_doctest', doctests)
2812
expected_test_list = [
2814
'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
2815
('bzrlib.tests.per_transport.TransportTests'
2816
'.test_abspath(LocalTransport,LocalURLServer)'),
2817
'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
2818
# plugins can't be tested that way since selftest may be run with
2821
if __doc__ is not None:
2822
expected_test_list.extend([
2823
# modules_to_doctest
2824
'bzrlib.timestamp.format_highres_date',
2826
suite = tests.test_suite()
2827
self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
2829
self.assertSubset(expected_test_list, _test_ids(suite))
2831
def test_test_suite_list_and_start(self):
2832
# We cannot test this at the same time as the main load, because we want
2833
# to know that starting_with == None works. So a second load is
2834
# incurred - note that the starting_with parameter causes a partial load
2835
# rather than a full load so this test should be pretty quick.
2836
test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
2837
suite = tests.test_suite(test_list,
2838
['bzrlib.tests.test_selftest.TestTestSuite'])
2839
# test_test_suite_list_and_start is not included
2840
self.assertEquals(test_list, _test_ids(suite))
2843
class TestLoadTestIdList(tests.TestCaseInTempDir):
2845
def _create_test_list_file(self, file_name, content):
2846
fl = open(file_name, 'wt')
2850
def test_load_unknown(self):
2851
self.assertRaises(errors.NoSuchFile,
2852
tests.load_test_id_list, 'i_do_not_exist')
2854
def test_load_test_list(self):
2855
test_list_fname = 'test.list'
2856
self._create_test_list_file(test_list_fname,
2857
'mod1.cl1.meth1\nmod2.cl2.meth2\n')
2858
tlist = tests.load_test_id_list(test_list_fname)
2859
self.assertEquals(2, len(tlist))
2860
self.assertEquals('mod1.cl1.meth1', tlist[0])
2861
self.assertEquals('mod2.cl2.meth2', tlist[1])
2863
def test_load_dirty_file(self):
2864
test_list_fname = 'test.list'
2865
self._create_test_list_file(test_list_fname,
2866
' mod1.cl1.meth1\n\nmod2.cl2.meth2 \n'
2868
tlist = tests.load_test_id_list(test_list_fname)
2869
self.assertEquals(4, len(tlist))
2870
self.assertEquals('mod1.cl1.meth1', tlist[0])
2871
self.assertEquals('', tlist[1])
2872
self.assertEquals('mod2.cl2.meth2', tlist[2])
2873
self.assertEquals('bar baz', tlist[3])
2876
class TestFilteredByModuleTestLoader(tests.TestCase):
2878
def _create_loader(self, test_list):
2879
id_filter = tests.TestIdList(test_list)
2880
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2883
def test_load_tests(self):
2884
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2885
loader = self._create_loader(test_list)
2886
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2887
self.assertEquals(test_list, _test_ids(suite))
2889
def test_exclude_tests(self):
2890
test_list = ['bogus']
2891
loader = self._create_loader(test_list)
2892
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2893
self.assertEquals([], _test_ids(suite))
2896
class TestFilteredByNameStartTestLoader(tests.TestCase):
2898
def _create_loader(self, name_start):
2899
def needs_module(name):
2900
return name.startswith(name_start) or name_start.startswith(name)
2901
loader = TestUtil.FilteredByModuleTestLoader(needs_module)
2904
def test_load_tests(self):
2905
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2906
loader = self._create_loader('bzrlib.tests.test_samp')
2908
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2909
self.assertEquals(test_list, _test_ids(suite))
2911
def test_load_tests_inside_module(self):
2912
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2913
loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
2915
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2916
self.assertEquals(test_list, _test_ids(suite))
2918
def test_exclude_tests(self):
2919
test_list = ['bogus']
2920
loader = self._create_loader('bogus')
2922
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2923
self.assertEquals([], _test_ids(suite))
2926
class TestTestPrefixRegistry(tests.TestCase):
2928
def _get_registry(self):
2929
tp_registry = tests.TestPrefixAliasRegistry()
2932
def test_register_new_prefix(self):
2933
tpr = self._get_registry()
2934
tpr.register('foo', 'fff.ooo.ooo')
2935
self.assertEquals('fff.ooo.ooo', tpr.get('foo'))
2937
def test_register_existing_prefix(self):
2938
tpr = self._get_registry()
2939
tpr.register('bar', 'bbb.aaa.rrr')
2940
tpr.register('bar', 'bBB.aAA.rRR')
2941
self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
2942
self.assertThat(self.get_log(),
2943
DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR", ELLIPSIS))
2945
def test_get_unknown_prefix(self):
2946
tpr = self._get_registry()
2947
self.assertRaises(KeyError, tpr.get, 'I am not a prefix')
2949
def test_resolve_prefix(self):
2950
tpr = self._get_registry()
2951
tpr.register('bar', 'bb.aa.rr')
2952
self.assertEquals('bb.aa.rr', tpr.resolve_alias('bar'))
2954
def test_resolve_unknown_alias(self):
2955
tpr = self._get_registry()
2956
self.assertRaises(errors.BzrCommandError,
2957
tpr.resolve_alias, 'I am not a prefix')
2959
def test_predefined_prefixes(self):
2960
tpr = tests.test_prefix_alias_registry
2961
self.assertEquals('bzrlib', tpr.resolve_alias('bzrlib'))
2962
self.assertEquals('bzrlib.doc', tpr.resolve_alias('bd'))
2963
self.assertEquals('bzrlib.utils', tpr.resolve_alias('bu'))
2964
self.assertEquals('bzrlib.tests', tpr.resolve_alias('bt'))
2965
self.assertEquals('bzrlib.tests.blackbox', tpr.resolve_alias('bb'))
2966
self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
2969
class TestRunSuite(tests.TestCase):
2971
def test_runner_class(self):
2972
"""run_suite accepts and uses a runner_class keyword argument."""
2973
class Stub(tests.TestCase):
2976
suite = Stub("test_foo")
2978
class MyRunner(tests.TextTestRunner):
2979
def run(self, test):
2981
return tests.ExtendedTestResult(self.stream, self.descriptions,
2983
tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
2984
self.assertLength(1, calls)
added
removed
bzrlib/tests/test_selftest.py
