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.memory import MemoryServer, MemoryTransport
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_bzrdir 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
if self._lock_check_thorough:
613
self.assertEqual(1, len(result.errors))
615
# When _lock_check_thorough is disabled, then we don't trigger a
617
self.assertEqual(0, len(result.errors))
620
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
621
"""Tests for the convenience functions TestCaseWithTransport introduces."""
623
def test_get_readonly_url_none(self):
624
from bzrlib.transport import get_transport
625
from bzrlib.transport.memory import MemoryServer
626
from bzrlib.transport.readonly import ReadonlyTransportDecorator
627
self.vfs_transport_factory = MemoryServer
628
self.transport_readonly_server = None
629
# calling get_readonly_transport() constructs a decorator on the url
631
url = self.get_readonly_url()
632
url2 = self.get_readonly_url('foo/bar')
633
t = get_transport(url)
634
t2 = get_transport(url2)
635
self.failUnless(isinstance(t, ReadonlyTransportDecorator))
636
self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
637
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
639
def test_get_readonly_url_http(self):
640
from bzrlib.tests.http_server import HttpServer
641
from bzrlib.transport import get_transport
642
from bzrlib.transport.local import LocalURLServer
643
from bzrlib.transport.http import HttpTransportBase
644
self.transport_server = LocalURLServer
645
self.transport_readonly_server = HttpServer
646
# calling get_readonly_transport() gives us a HTTP server instance.
647
url = self.get_readonly_url()
648
url2 = self.get_readonly_url('foo/bar')
649
# the transport returned may be any HttpTransportBase subclass
650
t = get_transport(url)
651
t2 = get_transport(url2)
652
self.failUnless(isinstance(t, HttpTransportBase))
653
self.failUnless(isinstance(t2, HttpTransportBase))
654
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
656
def test_is_directory(self):
657
"""Test assertIsDirectory assertion"""
658
t = self.get_transport()
659
self.build_tree(['a_dir/', 'a_file'], transport=t)
660
self.assertIsDirectory('a_dir', t)
661
self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
662
self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
664
def test_make_branch_builder(self):
665
builder = self.make_branch_builder('dir')
666
rev_id = builder.build_commit()
667
self.failUnlessExists('dir')
668
a_dir = bzrdir.BzrDir.open('dir')
669
self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
670
a_branch = a_dir.open_branch()
671
builder_branch = builder.get_branch()
672
self.assertEqual(a_branch.base, builder_branch.base)
673
self.assertEqual((1, rev_id), builder_branch.last_revision_info())
674
self.assertEqual((1, rev_id), a_branch.last_revision_info())
677
class TestTestCaseTransports(tests.TestCaseWithTransport):
680
super(TestTestCaseTransports, self).setUp()
681
self.vfs_transport_factory = MemoryServer
683
def test_make_bzrdir_preserves_transport(self):
684
t = self.get_transport()
685
result_bzrdir = self.make_bzrdir('subdir')
686
self.assertIsInstance(result_bzrdir.transport,
688
# should not be on disk, should only be in memory
689
self.failIfExists('subdir')
692
class TestChrootedTest(tests.ChrootedTestCase):
694
def test_root_is_root(self):
695
from bzrlib.transport import get_transport
696
t = get_transport(self.get_readonly_url())
698
self.assertEqual(url, t.clone('..').base)
701
class TestProfileResult(tests.TestCase):
703
def test_profiles_tests(self):
704
self.requireFeature(test_lsprof.LSProfFeature)
705
terminal = testtools.tests.helpers.ExtendedTestResult()
706
result = tests.ProfileResult(terminal)
707
class Sample(tests.TestCase):
709
self.sample_function()
710
def sample_function(self):
714
case = terminal._events[0][1]
715
self.assertLength(1, case._benchcalls)
716
# We must be able to unpack it as the test reporting code wants
717
(_, _, _), stats = case._benchcalls[0]
718
self.assertTrue(callable(stats.pprint))
721
class TestTestResult(tests.TestCase):
723
def check_timing(self, test_case, expected_re):
724
result = bzrlib.tests.TextTestResult(self._log_file,
728
capture = testtools.tests.helpers.ExtendedTestResult()
729
test_case.run(MultiTestResult(result, capture))
730
run_case = capture._events[0][1]
731
timed_string = result._testTimeString(run_case)
732
self.assertContainsRe(timed_string, expected_re)
734
def test_test_reporting(self):
735
class ShortDelayTestCase(tests.TestCase):
736
def test_short_delay(self):
738
def test_short_benchmark(self):
739
self.time(time.sleep, 0.003)
740
self.check_timing(ShortDelayTestCase('test_short_delay'),
742
# if a benchmark time is given, we now show just that time followed by
744
self.check_timing(ShortDelayTestCase('test_short_benchmark'),
747
def test_unittest_reporting_unittest_class(self):
748
# getting the time from a non-bzrlib test works ok
749
class ShortDelayTestCase(unittest.TestCase):
750
def test_short_delay(self):
752
self.check_timing(ShortDelayTestCase('test_short_delay'),
755
def _patch_get_bzr_source_tree(self):
756
# Reading from the actual source tree breaks isolation, but we don't
757
# want to assume that thats *all* that would happen.
758
def _get_bzr_source_tree():
760
orig_get_bzr_source_tree = bzrlib.version._get_bzr_source_tree
761
bzrlib.version._get_bzr_source_tree = _get_bzr_source_tree
763
bzrlib.version._get_bzr_source_tree = orig_get_bzr_source_tree
764
self.addCleanup(restore)
766
def test_assigned_benchmark_file_stores_date(self):
767
self._patch_get_bzr_source_tree()
769
result = bzrlib.tests.TextTestResult(self._log_file,
774
output_string = output.getvalue()
775
# if you are wondering about the regexp please read the comment in
776
# test_bench_history (bzrlib.tests.test_selftest.TestRunner)
777
# XXX: what comment? -- Andrew Bennetts
778
self.assertContainsRe(output_string, "--date [0-9.]+")
780
def test_benchhistory_records_test_times(self):
781
self._patch_get_bzr_source_tree()
782
result_stream = StringIO()
783
result = bzrlib.tests.TextTestResult(
787
bench_history=result_stream
790
# we want profile a call and check that its test duration is recorded
791
# make a new test instance that when run will generate a benchmark
792
example_test_case = TestTestResult("_time_hello_world_encoding")
793
# execute the test, which should succeed and record times
794
example_test_case.run(result)
795
lines = result_stream.getvalue().splitlines()
796
self.assertEqual(2, len(lines))
797
self.assertContainsRe(lines[1],
798
" *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
799
"._time_hello_world_encoding")
801
def _time_hello_world_encoding(self):
802
"""Profile two sleep calls
804
This is used to exercise the test framework.
806
self.time(unicode, 'hello', errors='replace')
807
self.time(unicode, 'world', errors='replace')
809
def test_lsprofiling(self):
810
"""Verbose test result prints lsprof statistics from test cases."""
811
self.requireFeature(test_lsprof.LSProfFeature)
812
result_stream = StringIO()
813
result = bzrlib.tests.VerboseTestResult(
814
unittest._WritelnDecorator(result_stream),
818
# we want profile a call of some sort and check it is output by
819
# addSuccess. We dont care about addError or addFailure as they
820
# are not that interesting for performance tuning.
821
# make a new test instance that when run will generate a profile
822
example_test_case = TestTestResult("_time_hello_world_encoding")
823
example_test_case._gather_lsprof_in_benchmarks = True
824
# execute the test, which should succeed and record profiles
825
example_test_case.run(result)
826
# lsprofile_something()
827
# if this worked we want
828
# LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
829
# CallCount Recursive Total(ms) Inline(ms) module:lineno(function)
830
# (the lsprof header)
831
# ... an arbitrary number of lines
832
# and the function call which is time.sleep.
833
# 1 0 ??? ??? ???(sleep)
834
# and then repeated but with 'world', rather than 'hello'.
835
# this should appear in the output stream of our test result.
836
output = result_stream.getvalue()
837
self.assertContainsRe(output,
838
r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
839
self.assertContainsRe(output,
840
r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
841
self.assertContainsRe(output,
842
r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
843
self.assertContainsRe(output,
844
r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
846
def test_known_failure(self):
847
"""A KnownFailure being raised should trigger several result actions."""
848
class InstrumentedTestResult(tests.ExtendedTestResult):
849
def stopTestRun(self): pass
850
def startTests(self): pass
851
def report_test_start(self, test): pass
852
def report_known_failure(self, test, err=None, details=None):
853
self._call = test, 'known failure'
854
result = InstrumentedTestResult(None, None, None, None)
855
class Test(tests.TestCase):
856
def test_function(self):
857
raise tests.KnownFailure('failed!')
858
test = Test("test_function")
860
# it should invoke 'report_known_failure'.
861
self.assertEqual(2, len(result._call))
862
self.assertEqual(test.id(), result._call[0].id())
863
self.assertEqual('known failure', result._call[1])
864
# we dont introspec the traceback, if the rest is ok, it would be
865
# exceptional for it not to be.
866
# it should update the known_failure_count on the object.
867
self.assertEqual(1, result.known_failure_count)
868
# the result should be successful.
869
self.assertTrue(result.wasSuccessful())
871
def test_verbose_report_known_failure(self):
872
# verbose test output formatting
873
result_stream = StringIO()
874
result = bzrlib.tests.VerboseTestResult(
875
unittest._WritelnDecorator(result_stream),
879
test = self.get_passing_test()
880
result.startTest(test)
881
prefix = len(result_stream.getvalue())
882
# the err parameter has the shape:
883
# (class, exception object, traceback)
884
# KnownFailures dont get their tracebacks shown though, so we
886
err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
887
result.report_known_failure(test, err)
888
output = result_stream.getvalue()[prefix:]
889
lines = output.splitlines()
890
self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
891
self.assertEqual(lines[1], ' foo')
892
self.assertEqual(2, len(lines))
894
def get_passing_test(self):
895
"""Return a test object that can't be run usefully."""
898
return unittest.FunctionTestCase(passing_test)
900
def test_add_not_supported(self):
901
"""Test the behaviour of invoking addNotSupported."""
902
class InstrumentedTestResult(tests.ExtendedTestResult):
903
def stopTestRun(self): pass
904
def startTests(self): pass
905
def report_test_start(self, test): pass
906
def report_unsupported(self, test, feature):
907
self._call = test, feature
908
result = InstrumentedTestResult(None, None, None, None)
909
test = SampleTestCase('_test_pass')
910
feature = tests.Feature()
911
result.startTest(test)
912
result.addNotSupported(test, feature)
913
# it should invoke 'report_unsupported'.
914
self.assertEqual(2, len(result._call))
915
self.assertEqual(test, result._call[0])
916
self.assertEqual(feature, result._call[1])
917
# the result should be successful.
918
self.assertTrue(result.wasSuccessful())
919
# it should record the test against a count of tests not run due to
921
self.assertEqual(1, result.unsupported['Feature'])
922
# and invoking it again should increment that counter
923
result.addNotSupported(test, feature)
924
self.assertEqual(2, result.unsupported['Feature'])
926
def test_verbose_report_unsupported(self):
927
# verbose test output formatting
928
result_stream = StringIO()
929
result = bzrlib.tests.VerboseTestResult(
930
unittest._WritelnDecorator(result_stream),
934
test = self.get_passing_test()
935
feature = tests.Feature()
936
result.startTest(test)
937
prefix = len(result_stream.getvalue())
938
result.report_unsupported(test, feature)
939
output = result_stream.getvalue()[prefix:]
940
lines = output.splitlines()
941
# We don't check for the final '0ms' since it may fail on slow hosts
942
self.assertStartsWith(lines[0], 'NODEP')
943
self.assertEqual(lines[1],
944
" The feature 'Feature' is not available.")
946
def test_unavailable_exception(self):
947
"""An UnavailableFeature being raised should invoke addNotSupported."""
948
class InstrumentedTestResult(tests.ExtendedTestResult):
949
def stopTestRun(self): pass
950
def startTests(self): pass
951
def report_test_start(self, test): pass
952
def addNotSupported(self, test, feature):
953
self._call = test, feature
954
result = InstrumentedTestResult(None, None, None, None)
955
feature = tests.Feature()
956
class Test(tests.TestCase):
957
def test_function(self):
958
raise tests.UnavailableFeature(feature)
959
test = Test("test_function")
961
# it should invoke 'addNotSupported'.
962
self.assertEqual(2, len(result._call))
963
self.assertEqual(test.id(), result._call[0].id())
964
self.assertEqual(feature, result._call[1])
965
# and not count as an error
966
self.assertEqual(0, result.error_count)
968
def test_strict_with_unsupported_feature(self):
969
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
971
test = self.get_passing_test()
972
feature = "Unsupported Feature"
973
result.addNotSupported(test, feature)
974
self.assertFalse(result.wasStrictlySuccessful())
975
self.assertEqual(None, result._extractBenchmarkTime(test))
977
def test_strict_with_known_failure(self):
978
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
980
test = self.get_passing_test()
981
err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
982
result.addExpectedFailure(test, err)
983
self.assertFalse(result.wasStrictlySuccessful())
984
self.assertEqual(None, result._extractBenchmarkTime(test))
986
def test_strict_with_success(self):
987
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
989
test = self.get_passing_test()
990
result.addSuccess(test)
991
self.assertTrue(result.wasStrictlySuccessful())
992
self.assertEqual(None, result._extractBenchmarkTime(test))
994
def test_startTests(self):
995
"""Starting the first test should trigger startTests."""
996
class InstrumentedTestResult(tests.ExtendedTestResult):
998
def startTests(self): self.calls += 1
999
def report_test_start(self, test): pass
1000
result = InstrumentedTestResult(None, None, None, None)
1001
def test_function():
1003
test = unittest.FunctionTestCase(test_function)
1005
self.assertEquals(1, result.calls)
1008
class TestUnicodeFilenameFeature(tests.TestCase):
1010
def test_probe_passes(self):
1011
"""UnicodeFilenameFeature._probe passes."""
1012
# We can't test much more than that because the behaviour depends
1014
tests.UnicodeFilenameFeature._probe()
1017
class TestRunner(tests.TestCase):
1019
def dummy_test(self):
1022
def run_test_runner(self, testrunner, test):
1023
"""Run suite in testrunner, saving global state and restoring it.
1025
This current saves and restores:
1026
TestCaseInTempDir.TEST_ROOT
1028
There should be no tests in this file that use
1029
bzrlib.tests.TextTestRunner without using this convenience method,
1030
because of our use of global state.
1032
old_root = tests.TestCaseInTempDir.TEST_ROOT
1033
old_leak = tests.TestCase._first_thread_leaker_id
1035
tests.TestCaseInTempDir.TEST_ROOT = None
1036
tests.TestCase._first_thread_leaker_id = None
1037
return testrunner.run(test)
1039
tests.TestCaseInTempDir.TEST_ROOT = old_root
1040
tests.TestCase._first_thread_leaker_id = old_leak
1042
def test_known_failure_failed_run(self):
1043
# run a test that generates a known failure which should be printed in
1044
# the final output when real failures occur.
1045
class Test(tests.TestCase):
1046
def known_failure_test(self):
1047
self.expectFailure('failed', self.assertTrue, False)
1048
test = unittest.TestSuite()
1049
test.addTest(Test("known_failure_test"))
1052
test.addTest(unittest.FunctionTestCase(failing_test))
1054
runner = tests.TextTestRunner(stream=stream)
1055
result = self.run_test_runner(runner, test)
1056
lines = stream.getvalue().splitlines()
1057
self.assertContainsRe(stream.getvalue(),
1058
'(?sm)^bzr selftest.*$'
1060
'^======================================================================\n'
1061
'^FAIL: failing_test\n'
1062
'^----------------------------------------------------------------------\n'
1063
'Traceback \\(most recent call last\\):\n'
1064
' .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
1065
' self.fail\\(\'foo\'\\)\n'
1067
'^----------------------------------------------------------------------\n'
1069
'FAILED \\(failures=1, known_failure_count=1\\)'
1072
def test_known_failure_ok_run(self):
1073
# run a test that generates a known failure which should be printed in
1075
class Test(tests.TestCase):
1076
def known_failure_test(self):
1077
self.expectFailure('failed', self.assertTrue, False)
1078
test = Test("known_failure_test")
1080
runner = tests.TextTestRunner(stream=stream)
1081
result = self.run_test_runner(runner, test)
1082
self.assertContainsRe(stream.getvalue(),
1085
'Ran 1 test in .*\n'
1087
'OK \\(known_failures=1\\)\n')
1089
def test_result_decorator(self):
1092
class LoggingDecorator(tests.ForwardingResult):
1093
def startTest(self, test):
1094
tests.ForwardingResult.startTest(self, test)
1095
calls.append('start')
1096
test = unittest.FunctionTestCase(lambda:None)
1098
runner = tests.TextTestRunner(stream=stream,
1099
result_decorators=[LoggingDecorator])
1100
result = self.run_test_runner(runner, test)
1101
self.assertLength(1, calls)
1103
def test_skipped_test(self):
1104
# run a test that is skipped, and check the suite as a whole still
1106
# skipping_test must be hidden in here so it's not run as a real test
1107
class SkippingTest(tests.TestCase):
1108
def skipping_test(self):
1109
raise tests.TestSkipped('test intentionally skipped')
1110
runner = tests.TextTestRunner(stream=self._log_file)
1111
test = SkippingTest("skipping_test")
1112
result = self.run_test_runner(runner, test)
1113
self.assertTrue(result.wasSuccessful())
1115
def test_skipped_from_setup(self):
1117
class SkippedSetupTest(tests.TestCase):
1120
calls.append('setUp')
1121
self.addCleanup(self.cleanup)
1122
raise tests.TestSkipped('skipped setup')
1124
def test_skip(self):
1125
self.fail('test reached')
1128
calls.append('cleanup')
1130
runner = tests.TextTestRunner(stream=self._log_file)
1131
test = SkippedSetupTest('test_skip')
1132
result = self.run_test_runner(runner, test)
1133
self.assertTrue(result.wasSuccessful())
1134
# Check if cleanup was called the right number of times.
1135
self.assertEqual(['setUp', 'cleanup'], calls)
1137
def test_skipped_from_test(self):
1139
class SkippedTest(tests.TestCase):
1142
tests.TestCase.setUp(self)
1143
calls.append('setUp')
1144
self.addCleanup(self.cleanup)
1146
def test_skip(self):
1147
raise tests.TestSkipped('skipped test')
1150
calls.append('cleanup')
1152
runner = tests.TextTestRunner(stream=self._log_file)
1153
test = SkippedTest('test_skip')
1154
result = self.run_test_runner(runner, test)
1155
self.assertTrue(result.wasSuccessful())
1156
# Check if cleanup was called the right number of times.
1157
self.assertEqual(['setUp', 'cleanup'], calls)
1159
def test_not_applicable(self):
1160
# run a test that is skipped because it's not applicable
1161
class Test(tests.TestCase):
1162
def not_applicable_test(self):
1163
raise tests.TestNotApplicable('this test never runs')
1165
runner = tests.TextTestRunner(stream=out, verbosity=2)
1166
test = Test("not_applicable_test")
1167
result = self.run_test_runner(runner, test)
1168
self._log_file.write(out.getvalue())
1169
self.assertTrue(result.wasSuccessful())
1170
self.assertTrue(result.wasStrictlySuccessful())
1171
self.assertContainsRe(out.getvalue(),
1172
r'(?m)not_applicable_test * N/A')
1173
self.assertContainsRe(out.getvalue(),
1174
r'(?m)^ this test never runs')
1176
def test_unsupported_features_listed(self):
1177
"""When unsupported features are encountered they are detailed."""
1178
class Feature1(tests.Feature):
1179
def _probe(self): return False
1180
class Feature2(tests.Feature):
1181
def _probe(self): return False
1182
# create sample tests
1183
test1 = SampleTestCase('_test_pass')
1184
test1._test_needs_features = [Feature1()]
1185
test2 = SampleTestCase('_test_pass')
1186
test2._test_needs_features = [Feature2()]
1187
test = unittest.TestSuite()
1191
runner = tests.TextTestRunner(stream=stream)
1192
result = self.run_test_runner(runner, test)
1193
lines = stream.getvalue().splitlines()
1196
"Missing feature 'Feature1' skipped 1 tests.",
1197
"Missing feature 'Feature2' skipped 1 tests.",
1201
def _patch_get_bzr_source_tree(self):
1202
# Reading from the actual source tree breaks isolation, but we don't
1203
# want to assume that thats *all* that would happen.
1204
self._get_source_tree_calls = []
1205
def _get_bzr_source_tree():
1206
self._get_source_tree_calls.append("called")
1208
orig_get_bzr_source_tree = bzrlib.version._get_bzr_source_tree
1209
bzrlib.version._get_bzr_source_tree = _get_bzr_source_tree
1211
bzrlib.version._get_bzr_source_tree = orig_get_bzr_source_tree
1212
self.addCleanup(restore)
1214
def test_bench_history(self):
1215
# tests that the running the benchmark passes bench_history into
1216
# the test result object. We can tell that happens if
1217
# _get_bzr_source_tree is called.
1218
self._patch_get_bzr_source_tree()
1219
test = TestRunner('dummy_test')
1221
runner = tests.TextTestRunner(stream=self._log_file,
1222
bench_history=output)
1223
result = self.run_test_runner(runner, test)
1224
output_string = output.getvalue()
1225
self.assertContainsRe(output_string, "--date [0-9.]+")
1226
self.assertLength(1, self._get_source_tree_calls)
1228
def test_startTestRun(self):
1229
"""run should call result.startTestRun()"""
1231
class LoggingDecorator(tests.ForwardingResult):
1232
def startTestRun(self):
1233
tests.ForwardingResult.startTestRun(self)
1234
calls.append('startTestRun')
1235
test = unittest.FunctionTestCase(lambda:None)
1237
runner = tests.TextTestRunner(stream=stream,
1238
result_decorators=[LoggingDecorator])
1239
result = self.run_test_runner(runner, test)
1240
self.assertLength(1, calls)
1242
def test_stopTestRun(self):
1243
"""run should call result.stopTestRun()"""
1245
class LoggingDecorator(tests.ForwardingResult):
1246
def stopTestRun(self):
1247
tests.ForwardingResult.stopTestRun(self)
1248
calls.append('stopTestRun')
1249
test = unittest.FunctionTestCase(lambda:None)
1251
runner = tests.TextTestRunner(stream=stream,
1252
result_decorators=[LoggingDecorator])
1253
result = self.run_test_runner(runner, test)
1254
self.assertLength(1, calls)
1257
class SampleTestCase(tests.TestCase):
1259
def _test_pass(self):
1262
class _TestException(Exception):
1266
class TestTestCase(tests.TestCase):
1267
"""Tests that test the core bzrlib TestCase."""
1269
def test_assertLength_matches_empty(self):
1271
self.assertLength(0, a_list)
1273
def test_assertLength_matches_nonempty(self):
1275
self.assertLength(3, a_list)
1277
def test_assertLength_fails_different(self):
1279
self.assertRaises(AssertionError, self.assertLength, 1, a_list)
1281
def test_assertLength_shows_sequence_in_failure(self):
1283
exception = self.assertRaises(AssertionError, self.assertLength, 2,
1285
self.assertEqual('Incorrect length: wanted 2, got 3 for [1, 2, 3]',
1288
def test_base_setUp_not_called_causes_failure(self):
1289
class TestCaseWithBrokenSetUp(tests.TestCase):
1291
pass # does not call TestCase.setUp
1294
test = TestCaseWithBrokenSetUp('test_foo')
1295
result = unittest.TestResult()
1297
self.assertFalse(result.wasSuccessful())
1298
self.assertEqual(1, result.testsRun)
1300
def test_base_tearDown_not_called_causes_failure(self):
1301
class TestCaseWithBrokenTearDown(tests.TestCase):
1303
pass # does not call TestCase.tearDown
1306
test = TestCaseWithBrokenTearDown('test_foo')
1307
result = unittest.TestResult()
1309
self.assertFalse(result.wasSuccessful())
1310
self.assertEqual(1, result.testsRun)
1312
def test_debug_flags_sanitised(self):
1313
"""The bzrlib debug flags should be sanitised by setUp."""
1314
if 'allow_debug' in tests.selftest_debug_flags:
1315
raise tests.TestNotApplicable(
1316
'-Eallow_debug option prevents debug flag sanitisation')
1317
# we could set something and run a test that will check
1318
# it gets santised, but this is probably sufficient for now:
1319
# if someone runs the test with -Dsomething it will error.
1321
if self._lock_check_thorough:
1322
flags.add('strict_locks')
1323
self.assertEqual(flags, bzrlib.debug.debug_flags)
1325
def change_selftest_debug_flags(self, new_flags):
1326
orig_selftest_flags = tests.selftest_debug_flags
1327
self.addCleanup(self._restore_selftest_debug_flags, orig_selftest_flags)
1328
tests.selftest_debug_flags = set(new_flags)
1330
def _restore_selftest_debug_flags(self, flags):
1331
tests.selftest_debug_flags = flags
1333
def test_allow_debug_flag(self):
1334
"""The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1335
sanitised (i.e. cleared) before running a test.
1337
self.change_selftest_debug_flags(set(['allow_debug']))
1338
bzrlib.debug.debug_flags = set(['a-flag'])
1339
class TestThatRecordsFlags(tests.TestCase):
1340
def test_foo(nested_self):
1341
self.flags = set(bzrlib.debug.debug_flags)
1342
test = TestThatRecordsFlags('test_foo')
1343
test.run(self.make_test_result())
1344
flags = set(['a-flag'])
1345
if 'disable_lock_checks' not in tests.selftest_debug_flags:
1346
flags.add('strict_locks')
1347
self.assertEqual(flags, self.flags)
1349
def test_disable_lock_checks(self):
1350
"""The -Edisable_lock_checks flag disables thorough checks."""
1351
class TestThatRecordsFlags(tests.TestCase):
1352
def test_foo(nested_self):
1353
self.flags = set(bzrlib.debug.debug_flags)
1354
self.test_lock_check_thorough = nested_self._lock_check_thorough
1355
self.change_selftest_debug_flags(set())
1356
test = TestThatRecordsFlags('test_foo')
1357
test.run(self.make_test_result())
1358
# By default we do strict lock checking and thorough lock/unlock
1360
self.assertTrue(self.test_lock_check_thorough)
1361
self.assertEqual(set(['strict_locks']), self.flags)
1362
# Now set the disable_lock_checks flag, and show that this changed.
1363
self.change_selftest_debug_flags(set(['disable_lock_checks']))
1364
test = TestThatRecordsFlags('test_foo')
1365
test.run(self.make_test_result())
1366
self.assertFalse(self.test_lock_check_thorough)
1367
self.assertEqual(set(), self.flags)
1369
def test_this_fails_strict_lock_check(self):
1370
class TestThatRecordsFlags(tests.TestCase):
1371
def test_foo(nested_self):
1372
self.flags1 = set(bzrlib.debug.debug_flags)
1373
self.thisFailsStrictLockCheck()
1374
self.flags2 = set(bzrlib.debug.debug_flags)
1375
# Make sure lock checking is active
1376
self.change_selftest_debug_flags(set())
1377
test = TestThatRecordsFlags('test_foo')
1378
test.run(self.make_test_result())
1379
self.assertEqual(set(['strict_locks']), self.flags1)
1380
self.assertEqual(set(), self.flags2)
1382
def test_debug_flags_restored(self):
1383
"""The bzrlib debug flags should be restored to their original state
1384
after the test was run, even if allow_debug is set.
1386
self.change_selftest_debug_flags(set(['allow_debug']))
1387
# Now run a test that modifies debug.debug_flags.
1388
bzrlib.debug.debug_flags = set(['original-state'])
1389
class TestThatModifiesFlags(tests.TestCase):
1391
bzrlib.debug.debug_flags = set(['modified'])
1392
test = TestThatModifiesFlags('test_foo')
1393
test.run(self.make_test_result())
1394
self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1396
def make_test_result(self):
1397
"""Get a test result that writes to the test log file."""
1398
return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
1400
def inner_test(self):
1401
# the inner child test
1404
def outer_child(self):
1405
# the outer child test
1407
self.inner_test = TestTestCase("inner_child")
1408
result = self.make_test_result()
1409
self.inner_test.run(result)
1410
note("outer finish")
1411
self.addCleanup(osutils.delete_any, self._log_file_name)
1413
def test_trace_nesting(self):
1414
# this tests that each test case nests its trace facility correctly.
1415
# we do this by running a test case manually. That test case (A)
1416
# should setup a new log, log content to it, setup a child case (B),
1417
# which should log independently, then case (A) should log a trailer
1419
# we do two nested children so that we can verify the state of the
1420
# logs after the outer child finishes is correct, which a bad clean
1421
# up routine in tearDown might trigger a fault in our test with only
1422
# one child, we should instead see the bad result inside our test with
1424
# the outer child test
1425
original_trace = bzrlib.trace._trace_file
1426
outer_test = TestTestCase("outer_child")
1427
result = self.make_test_result()
1428
outer_test.run(result)
1429
self.assertEqual(original_trace, bzrlib.trace._trace_file)
1431
def method_that_times_a_bit_twice(self):
1432
# call self.time twice to ensure it aggregates
1433
self.time(time.sleep, 0.007)
1434
self.time(time.sleep, 0.007)
1436
def test_time_creates_benchmark_in_result(self):
1437
"""Test that the TestCase.time() method accumulates a benchmark time."""
1438
sample_test = TestTestCase("method_that_times_a_bit_twice")
1439
output_stream = StringIO()
1440
result = bzrlib.tests.VerboseTestResult(
1441
unittest._WritelnDecorator(output_stream),
1444
sample_test.run(result)
1445
self.assertContainsRe(
1446
output_stream.getvalue(),
1449
def test_hooks_sanitised(self):
1450
"""The bzrlib hooks should be sanitised by setUp."""
1451
# Note this test won't fail with hooks that the core library doesn't
1452
# use - but it trigger with a plugin that adds hooks, so its still a
1453
# useful warning in that case.
1454
self.assertEqual(bzrlib.branch.BranchHooks(),
1455
bzrlib.branch.Branch.hooks)
1456
self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
1457
bzrlib.smart.server.SmartTCPServer.hooks)
1458
self.assertEqual(bzrlib.commands.CommandHooks(),
1459
bzrlib.commands.Command.hooks)
1461
def test__gather_lsprof_in_benchmarks(self):
1462
"""When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1464
Each self.time() call is individually and separately profiled.
1466
self.requireFeature(test_lsprof.LSProfFeature)
1467
# overrides the class member with an instance member so no cleanup
1469
self._gather_lsprof_in_benchmarks = True
1470
self.time(time.sleep, 0.000)
1471
self.time(time.sleep, 0.003)
1472
self.assertEqual(2, len(self._benchcalls))
1473
self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
1474
self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1475
self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1476
self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1477
del self._benchcalls[:]
1479
def test_knownFailure(self):
1480
"""Self.knownFailure() should raise a KnownFailure exception."""
1481
self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
1483
def test_open_bzrdir_safe_roots(self):
1484
# even a memory transport should fail to open when its url isn't
1486
# Manually set one up (TestCase doesn't and shouldn't provide magic
1488
transport_server = MemoryServer()
1489
transport_server.start_server()
1490
self.addCleanup(transport_server.stop_server)
1491
t = transport.get_transport(transport_server.get_url())
1492
bzrdir.BzrDir.create(t.base)
1493
self.assertRaises(errors.BzrError,
1494
bzrdir.BzrDir.open_from_transport, t)
1495
# But if we declare this as safe, we can open the bzrdir.
1496
self.permit_url(t.base)
1497
self._bzr_selftest_roots.append(t.base)
1498
bzrdir.BzrDir.open_from_transport(t)
1500
def test_requireFeature_available(self):
1501
"""self.requireFeature(available) is a no-op."""
1502
class Available(tests.Feature):
1503
def _probe(self):return True
1504
feature = Available()
1505
self.requireFeature(feature)
1507
def test_requireFeature_unavailable(self):
1508
"""self.requireFeature(unavailable) raises UnavailableFeature."""
1509
class Unavailable(tests.Feature):
1510
def _probe(self):return False
1511
feature = Unavailable()
1512
self.assertRaises(tests.UnavailableFeature,
1513
self.requireFeature, feature)
1515
def test_run_no_parameters(self):
1516
test = SampleTestCase('_test_pass')
1519
def test_run_enabled_unittest_result(self):
1520
"""Test we revert to regular behaviour when the test is enabled."""
1521
test = SampleTestCase('_test_pass')
1522
class EnabledFeature(object):
1523
def available(self):
1525
test._test_needs_features = [EnabledFeature()]
1526
result = unittest.TestResult()
1528
self.assertEqual(1, result.testsRun)
1529
self.assertEqual([], result.errors)
1530
self.assertEqual([], result.failures)
1532
def test_run_disabled_unittest_result(self):
1533
"""Test our compatability for disabled tests with unittest results."""
1534
test = SampleTestCase('_test_pass')
1535
class DisabledFeature(object):
1536
def available(self):
1538
test._test_needs_features = [DisabledFeature()]
1539
result = unittest.TestResult()
1541
self.assertEqual(1, result.testsRun)
1542
self.assertEqual([], result.errors)
1543
self.assertEqual([], result.failures)
1545
def test_run_disabled_supporting_result(self):
1546
"""Test disabled tests behaviour with support aware results."""
1547
test = SampleTestCase('_test_pass')
1548
class DisabledFeature(object):
1549
def __eq__(self, other):
1550
return isinstance(other, DisabledFeature)
1551
def available(self):
1553
the_feature = DisabledFeature()
1554
test._test_needs_features = [the_feature]
1555
class InstrumentedTestResult(unittest.TestResult):
1557
unittest.TestResult.__init__(self)
1559
def startTest(self, test):
1560
self.calls.append(('startTest', test))
1561
def stopTest(self, test):
1562
self.calls.append(('stopTest', test))
1563
def addNotSupported(self, test, feature):
1564
self.calls.append(('addNotSupported', test, feature))
1565
result = InstrumentedTestResult()
1567
case = result.calls[0][1]
1569
('startTest', case),
1570
('addNotSupported', case, the_feature),
1575
def test_start_server_registers_url(self):
1576
transport_server = MemoryServer()
1577
# A little strict, but unlikely to be changed soon.
1578
self.assertEqual([], self._bzr_selftest_roots)
1579
self.start_server(transport_server)
1580
self.assertSubset([transport_server.get_url()],
1581
self._bzr_selftest_roots)
1583
def test_assert_list_raises_on_generator(self):
1584
def generator_which_will_raise():
1585
# This will not raise until after the first yield
1587
raise _TestException()
1589
e = self.assertListRaises(_TestException, generator_which_will_raise)
1590
self.assertIsInstance(e, _TestException)
1592
e = self.assertListRaises(Exception, generator_which_will_raise)
1593
self.assertIsInstance(e, _TestException)
1595
def test_assert_list_raises_on_plain(self):
1596
def plain_exception():
1597
raise _TestException()
1600
e = self.assertListRaises(_TestException, plain_exception)
1601
self.assertIsInstance(e, _TestException)
1603
e = self.assertListRaises(Exception, plain_exception)
1604
self.assertIsInstance(e, _TestException)
1606
def test_assert_list_raises_assert_wrong_exception(self):
1607
class _NotTestException(Exception):
1610
def wrong_exception():
1611
raise _NotTestException()
1613
def wrong_exception_generator():
1616
raise _NotTestException()
1618
# Wrong exceptions are not intercepted
1619
self.assertRaises(_NotTestException,
1620
self.assertListRaises, _TestException, wrong_exception)
1621
self.assertRaises(_NotTestException,
1622
self.assertListRaises, _TestException, wrong_exception_generator)
1624
def test_assert_list_raises_no_exception(self):
1628
def success_generator():
1632
self.assertRaises(AssertionError,
1633
self.assertListRaises, _TestException, success)
1635
self.assertRaises(AssertionError,
1636
self.assertListRaises, _TestException, success_generator)
1639
# NB: Don't delete this; it's not actually from 0.11!
1640
@deprecated_function(deprecated_in((0, 11, 0)))
1641
def sample_deprecated_function():
1642
"""A deprecated function to test applyDeprecated with."""
1646
def sample_undeprecated_function(a_param):
1647
"""A undeprecated function to test applyDeprecated with."""
1650
class ApplyDeprecatedHelper(object):
1651
"""A helper class for ApplyDeprecated tests."""
1653
@deprecated_method(deprecated_in((0, 11, 0)))
1654
def sample_deprecated_method(self, param_one):
1655
"""A deprecated method for testing with."""
1658
def sample_normal_method(self):
1659
"""A undeprecated method."""
1661
@deprecated_method(deprecated_in((0, 10, 0)))
1662
def sample_nested_deprecation(self):
1663
return sample_deprecated_function()
1666
class TestExtraAssertions(tests.TestCase):
1667
"""Tests for new test assertions in bzrlib test suite"""
1669
def test_assert_isinstance(self):
1670
self.assertIsInstance(2, int)
1671
self.assertIsInstance(u'', basestring)
1672
e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1673
self.assertEquals(str(e),
1674
"None is an instance of <type 'NoneType'> rather than <type 'int'>")
1675
self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1676
e = self.assertRaises(AssertionError,
1677
self.assertIsInstance, None, int, "it's just not")
1678
self.assertEquals(str(e),
1679
"None is an instance of <type 'NoneType'> rather than <type 'int'>"
1682
def test_assertEndsWith(self):
1683
self.assertEndsWith('foo', 'oo')
1684
self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1686
def test_assertEqualDiff(self):
1687
e = self.assertRaises(AssertionError,
1688
self.assertEqualDiff, '', '\n')
1689
self.assertEquals(str(e),
1690
# Don't blink ! The '+' applies to the second string
1691
'first string is missing a final newline.\n+ \n')
1692
e = self.assertRaises(AssertionError,
1693
self.assertEqualDiff, '\n', '')
1694
self.assertEquals(str(e),
1695
# Don't blink ! The '-' applies to the second string
1696
'second string is missing a final newline.\n- \n')
1699
class TestDeprecations(tests.TestCase):
1701
def test_applyDeprecated_not_deprecated(self):
1702
sample_object = ApplyDeprecatedHelper()
1703
# calling an undeprecated callable raises an assertion
1704
self.assertRaises(AssertionError, self.applyDeprecated,
1705
deprecated_in((0, 11, 0)),
1706
sample_object.sample_normal_method)
1707
self.assertRaises(AssertionError, self.applyDeprecated,
1708
deprecated_in((0, 11, 0)),
1709
sample_undeprecated_function, "a param value")
1710
# calling a deprecated callable (function or method) with the wrong
1711
# expected deprecation fails.
1712
self.assertRaises(AssertionError, self.applyDeprecated,
1713
deprecated_in((0, 10, 0)),
1714
sample_object.sample_deprecated_method, "a param value")
1715
self.assertRaises(AssertionError, self.applyDeprecated,
1716
deprecated_in((0, 10, 0)),
1717
sample_deprecated_function)
1718
# calling a deprecated callable (function or method) with the right
1719
# expected deprecation returns the functions result.
1720
self.assertEqual("a param value",
1721
self.applyDeprecated(deprecated_in((0, 11, 0)),
1722
sample_object.sample_deprecated_method, "a param value"))
1723
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 11, 0)),
1724
sample_deprecated_function))
1725
# calling a nested deprecation with the wrong deprecation version
1726
# fails even if a deeper nested function was deprecated with the
1728
self.assertRaises(AssertionError, self.applyDeprecated,
1729
deprecated_in((0, 11, 0)), sample_object.sample_nested_deprecation)
1730
# calling a nested deprecation with the right deprecation value
1731
# returns the calls result.
1732
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 10, 0)),
1733
sample_object.sample_nested_deprecation))
1735
def test_callDeprecated(self):
1736
def testfunc(be_deprecated, result=None):
1737
if be_deprecated is True:
1738
symbol_versioning.warn('i am deprecated', DeprecationWarning,
1741
result = self.callDeprecated(['i am deprecated'], testfunc, True)
1742
self.assertIs(None, result)
1743
result = self.callDeprecated([], testfunc, False, 'result')
1744
self.assertEqual('result', result)
1745
self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
1746
self.callDeprecated([], testfunc, be_deprecated=False)
1749
class TestWarningTests(tests.TestCase):
1750
"""Tests for calling methods that raise warnings."""
1752
def test_callCatchWarnings(self):
1754
warnings.warn("this is your last warning")
1756
wlist, result = self.callCatchWarnings(meth, 1, 2)
1757
self.assertEquals(3, result)
1758
# would like just to compare them, but UserWarning doesn't implement
1761
self.assertIsInstance(w0, UserWarning)
1762
self.assertEquals("this is your last warning", str(w0))
1765
class TestConvenienceMakers(tests.TestCaseWithTransport):
1766
"""Test for the make_* convenience functions."""
1768
def test_make_branch_and_tree_with_format(self):
1769
# we should be able to supply a format to make_branch_and_tree
1770
self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
1771
self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
1772
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
1773
bzrlib.bzrdir.BzrDirMetaFormat1)
1774
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
1775
bzrlib.bzrdir.BzrDirFormat6)
1777
def test_make_branch_and_memory_tree(self):
1778
# we should be able to get a new branch and a mutable tree from
1779
# TestCaseWithTransport
1780
tree = self.make_branch_and_memory_tree('a')
1781
self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1783
def test_make_tree_for_local_vfs_backed_transport(self):
1784
# make_branch_and_tree has to use local branch and repositories
1785
# when the vfs transport and local disk are colocated, even if
1786
# a different transport is in use for url generation.
1787
from bzrlib.transport.fakevfat import FakeVFATServer
1788
self.transport_server = FakeVFATServer
1789
self.assertFalse(self.get_url('t1').startswith('file://'))
1790
tree = self.make_branch_and_tree('t1')
1791
base = tree.bzrdir.root_transport.base
1792
self.assertStartsWith(base, 'file://')
1793
self.assertEquals(tree.bzrdir.root_transport,
1794
tree.branch.bzrdir.root_transport)
1795
self.assertEquals(tree.bzrdir.root_transport,
1796
tree.branch.repository.bzrdir.root_transport)
1799
class SelfTestHelper:
1801
def run_selftest(self, **kwargs):
1802
"""Run selftest returning its output."""
1804
old_transport = bzrlib.tests.default_transport
1805
old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
1806
tests.TestCaseWithMemoryTransport.TEST_ROOT = None
1808
self.assertEqual(True, tests.selftest(stream=output, **kwargs))
1810
bzrlib.tests.default_transport = old_transport
1811
tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
1816
class TestSelftest(tests.TestCase, SelfTestHelper):
1817
"""Tests of bzrlib.tests.selftest."""
1819
def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1822
factory_called.append(True)
1823
return TestUtil.TestSuite()
1826
self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1827
test_suite_factory=factory)
1828
self.assertEqual([True], factory_called)
1831
"""A test suite factory."""
1832
class Test(tests.TestCase):
1839
return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
1841
def test_list_only(self):
1842
output = self.run_selftest(test_suite_factory=self.factory,
1844
self.assertEqual(3, len(output.readlines()))
1846
def test_list_only_filtered(self):
1847
output = self.run_selftest(test_suite_factory=self.factory,
1848
list_only=True, pattern="Test.b")
1849
self.assertEndsWith(output.getvalue(), "Test.b\n")
1850
self.assertLength(1, output.readlines())
1852
def test_list_only_excludes(self):
1853
output = self.run_selftest(test_suite_factory=self.factory,
1854
list_only=True, exclude_pattern="Test.b")
1855
self.assertNotContainsRe("Test.b", output.getvalue())
1856
self.assertLength(2, output.readlines())
1858
def test_lsprof_tests(self):
1859
self.requireFeature(test_lsprof.LSProfFeature)
1862
def __call__(test, result):
1864
def run(test, result):
1865
self.assertIsInstance(result, tests.ForwardingResult)
1866
calls.append("called")
1867
def countTestCases(self):
1869
self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
1870
self.assertLength(1, calls)
1872
def test_random(self):
1873
# test randomising by listing a number of tests.
1874
output_123 = self.run_selftest(test_suite_factory=self.factory,
1875
list_only=True, random_seed="123")
1876
output_234 = self.run_selftest(test_suite_factory=self.factory,
1877
list_only=True, random_seed="234")
1878
self.assertNotEqual(output_123, output_234)
1879
# "Randominzing test order..\n\n
1880
self.assertLength(5, output_123.readlines())
1881
self.assertLength(5, output_234.readlines())
1883
def test_random_reuse_is_same_order(self):
1884
# test randomising by listing a number of tests.
1885
expected = self.run_selftest(test_suite_factory=self.factory,
1886
list_only=True, random_seed="123")
1887
repeated = self.run_selftest(test_suite_factory=self.factory,
1888
list_only=True, random_seed="123")
1889
self.assertEqual(expected.getvalue(), repeated.getvalue())
1891
def test_runner_class(self):
1892
self.requireFeature(features.subunit)
1893
from subunit import ProtocolTestCase
1894
stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
1895
test_suite_factory=self.factory)
1896
test = ProtocolTestCase(stream)
1897
result = unittest.TestResult()
1899
self.assertEqual(3, result.testsRun)
1901
def test_starting_with_single_argument(self):
1902
output = self.run_selftest(test_suite_factory=self.factory,
1903
starting_with=['bzrlib.tests.test_selftest.Test.a'],
1905
self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
1908
def test_starting_with_multiple_argument(self):
1909
output = self.run_selftest(test_suite_factory=self.factory,
1910
starting_with=['bzrlib.tests.test_selftest.Test.a',
1911
'bzrlib.tests.test_selftest.Test.b'],
1913
self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
1914
'bzrlib.tests.test_selftest.Test.b\n',
1917
def check_transport_set(self, transport_server):
1918
captured_transport = []
1919
def seen_transport(a_transport):
1920
captured_transport.append(a_transport)
1921
class Capture(tests.TestCase):
1923
seen_transport(bzrlib.tests.default_transport)
1925
return TestUtil.TestSuite([Capture("a")])
1926
self.run_selftest(transport=transport_server, test_suite_factory=factory)
1927
self.assertEqual(transport_server, captured_transport[0])
1929
def test_transport_sftp(self):
1930
self.requireFeature(features.paramiko)
1931
self.check_transport_set(stub_sftp.SFTPAbsoluteServer)
1933
def test_transport_memory(self):
1934
self.check_transport_set(bzrlib.transport.memory.MemoryServer)
1937
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
1938
# Does IO: reads test.list
1940
def test_load_list(self):
1941
# Provide a list with one test - this test.
1942
test_id_line = '%s\n' % self.id()
1943
self.build_tree_contents([('test.list', test_id_line)])
1944
# And generate a list of the tests in the suite.
1945
stream = self.run_selftest(load_list='test.list', list_only=True)
1946
self.assertEqual(test_id_line, stream.getvalue())
1948
def test_load_unknown(self):
1949
# Provide a list with one test - this test.
1950
# And generate a list of the tests in the suite.
1951
err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
1952
load_list='missing file name', list_only=True)
1955
class TestRunBzr(tests.TestCase):
1960
def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
1962
"""Override _run_bzr_core to test how it is invoked by run_bzr.
1964
Attempts to run bzr from inside this class don't actually run it.
1966
We test how run_bzr actually invokes bzr in another location. Here we
1967
only need to test that it passes the right parameters to run_bzr.
1969
self.argv = list(argv)
1970
self.retcode = retcode
1971
self.encoding = encoding
1973
self.working_dir = working_dir
1974
return self.retcode, self.out, self.err
1976
def test_run_bzr_error(self):
1977
self.out = "It sure does!\n"
1978
out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
1979
self.assertEqual(['rocks'], self.argv)
1980
self.assertEqual(34, self.retcode)
1981
self.assertEqual('It sure does!\n', out)
1982
self.assertEquals(out, self.out)
1983
self.assertEqual('', err)
1984
self.assertEquals(err, self.err)
1986
def test_run_bzr_error_regexes(self):
1988
self.err = "bzr: ERROR: foobarbaz is not versioned"
1989
out, err = self.run_bzr_error(
1990
["bzr: ERROR: foobarbaz is not versioned"],
1991
['file-id', 'foobarbaz'])
1993
def test_encoding(self):
1994
"""Test that run_bzr passes encoding to _run_bzr_core"""
1995
self.run_bzr('foo bar')
1996
self.assertEqual(None, self.encoding)
1997
self.assertEqual(['foo', 'bar'], self.argv)
1999
self.run_bzr('foo bar', encoding='baz')
2000
self.assertEqual('baz', self.encoding)
2001
self.assertEqual(['foo', 'bar'], self.argv)
2003
def test_retcode(self):
2004
"""Test that run_bzr passes retcode to _run_bzr_core"""
2005
# Default is retcode == 0
2006
self.run_bzr('foo bar')
2007
self.assertEqual(0, self.retcode)
2008
self.assertEqual(['foo', 'bar'], self.argv)
2010
self.run_bzr('foo bar', retcode=1)
2011
self.assertEqual(1, self.retcode)
2012
self.assertEqual(['foo', 'bar'], self.argv)
2014
self.run_bzr('foo bar', retcode=None)
2015
self.assertEqual(None, self.retcode)
2016
self.assertEqual(['foo', 'bar'], self.argv)
2018
self.run_bzr(['foo', 'bar'], retcode=3)
2019
self.assertEqual(3, self.retcode)
2020
self.assertEqual(['foo', 'bar'], self.argv)
2022
def test_stdin(self):
2023
# test that the stdin keyword to run_bzr is passed through to
2024
# _run_bzr_core as-is. We do this by overriding
2025
# _run_bzr_core in this class, and then calling run_bzr,
2026
# which is a convenience function for _run_bzr_core, so
2028
self.run_bzr('foo bar', stdin='gam')
2029
self.assertEqual('gam', self.stdin)
2030
self.assertEqual(['foo', 'bar'], self.argv)
2032
self.run_bzr('foo bar', stdin='zippy')
2033
self.assertEqual('zippy', self.stdin)
2034
self.assertEqual(['foo', 'bar'], self.argv)
2036
def test_working_dir(self):
2037
"""Test that run_bzr passes working_dir to _run_bzr_core"""
2038
self.run_bzr('foo bar')
2039
self.assertEqual(None, self.working_dir)
2040
self.assertEqual(['foo', 'bar'], self.argv)
2042
self.run_bzr('foo bar', working_dir='baz')
2043
self.assertEqual('baz', self.working_dir)
2044
self.assertEqual(['foo', 'bar'], self.argv)
2046
def test_reject_extra_keyword_arguments(self):
2047
self.assertRaises(TypeError, self.run_bzr, "foo bar",
2048
error_regex=['error message'])
2051
class TestRunBzrCaptured(tests.TestCaseWithTransport):
2052
# Does IO when testing the working_dir parameter.
2054
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2055
a_callable=None, *args, **kwargs):
2057
self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
2058
self.factory = bzrlib.ui.ui_factory
2059
self.working_dir = osutils.getcwd()
2060
stdout.write('foo\n')
2061
stderr.write('bar\n')
2064
def test_stdin(self):
2065
# test that the stdin keyword to _run_bzr_core is passed through to
2066
# apply_redirected as a StringIO. We do this by overriding
2067
# apply_redirected in this class, and then calling _run_bzr_core,
2068
# which calls apply_redirected.
2069
self.run_bzr(['foo', 'bar'], stdin='gam')
2070
self.assertEqual('gam', self.stdin.read())
2071
self.assertTrue(self.stdin is self.factory_stdin)
2072
self.run_bzr(['foo', 'bar'], stdin='zippy')
2073
self.assertEqual('zippy', self.stdin.read())
2074
self.assertTrue(self.stdin is self.factory_stdin)
2076
def test_ui_factory(self):
2077
# each invocation of self.run_bzr should get its
2078
# own UI factory, which is an instance of TestUIFactory,
2079
# with stdin, stdout and stderr attached to the stdin,
2080
# stdout and stderr of the invoked run_bzr
2081
current_factory = bzrlib.ui.ui_factory
2082
self.run_bzr(['foo'])
2083
self.failIf(current_factory is self.factory)
2084
self.assertNotEqual(sys.stdout, self.factory.stdout)
2085
self.assertNotEqual(sys.stderr, self.factory.stderr)
2086
self.assertEqual('foo\n', self.factory.stdout.getvalue())
2087
self.assertEqual('bar\n', self.factory.stderr.getvalue())
2088
self.assertIsInstance(self.factory, tests.TestUIFactory)
2090
def test_working_dir(self):
2091
self.build_tree(['one/', 'two/'])
2092
cwd = osutils.getcwd()
2094
# Default is to work in the current directory
2095
self.run_bzr(['foo', 'bar'])
2096
self.assertEqual(cwd, self.working_dir)
2098
self.run_bzr(['foo', 'bar'], working_dir=None)
2099
self.assertEqual(cwd, self.working_dir)
2101
# The function should be run in the alternative directory
2102
# but afterwards the current working dir shouldn't be changed
2103
self.run_bzr(['foo', 'bar'], working_dir='one')
2104
self.assertNotEqual(cwd, self.working_dir)
2105
self.assertEndsWith(self.working_dir, 'one')
2106
self.assertEqual(cwd, osutils.getcwd())
2108
self.run_bzr(['foo', 'bar'], working_dir='two')
2109
self.assertNotEqual(cwd, self.working_dir)
2110
self.assertEndsWith(self.working_dir, 'two')
2111
self.assertEqual(cwd, osutils.getcwd())
2114
class StubProcess(object):
2115
"""A stub process for testing run_bzr_subprocess."""
2117
def __init__(self, out="", err="", retcode=0):
2120
self.returncode = retcode
2122
def communicate(self):
2123
return self.out, self.err
2126
class TestWithFakedStartBzrSubprocess(tests.TestCaseWithTransport):
2127
"""Base class for tests testing how we might run bzr."""
2130
tests.TestCaseWithTransport.setUp(self)
2131
self.subprocess_calls = []
2133
def start_bzr_subprocess(self, process_args, env_changes=None,
2134
skip_if_plan_to_signal=False,
2136
allow_plugins=False):
2137
"""capture what run_bzr_subprocess tries to do."""
2138
self.subprocess_calls.append({'process_args':process_args,
2139
'env_changes':env_changes,
2140
'skip_if_plan_to_signal':skip_if_plan_to_signal,
2141
'working_dir':working_dir, 'allow_plugins':allow_plugins})
2142
return self.next_subprocess
2145
class TestRunBzrSubprocess(TestWithFakedStartBzrSubprocess):
2147
def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
2148
"""Run run_bzr_subprocess with args and kwargs using a stubbed process.
2150
Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
2151
that will return static results. This assertion method populates those
2152
results and also checks the arguments run_bzr_subprocess generates.
2154
self.next_subprocess = process
2156
result = self.run_bzr_subprocess(*args, **kwargs)
2158
self.next_subprocess = None
2159
for key, expected in expected_args.iteritems():
2160
self.assertEqual(expected, self.subprocess_calls[-1][key])
2163
self.next_subprocess = None
2164
for key, expected in expected_args.iteritems():
2165
self.assertEqual(expected, self.subprocess_calls[-1][key])
2168
def test_run_bzr_subprocess(self):
2169
"""The run_bzr_helper_external command behaves nicely."""
2170
self.assertRunBzrSubprocess({'process_args':['--version']},
2171
StubProcess(), '--version')
2172
self.assertRunBzrSubprocess({'process_args':['--version']},
2173
StubProcess(), ['--version'])
2174
# retcode=None disables retcode checking
2175
result = self.assertRunBzrSubprocess({},
2176
StubProcess(retcode=3), '--version', retcode=None)
2177
result = self.assertRunBzrSubprocess({},
2178
StubProcess(out="is free software"), '--version')
2179
self.assertContainsRe(result[0], 'is free software')
2180
# Running a subcommand that is missing errors
2181
self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
2182
{'process_args':['--versionn']}, StubProcess(retcode=3),
2184
# Unless it is told to expect the error from the subprocess
2185
result = self.assertRunBzrSubprocess({},
2186
StubProcess(retcode=3), '--versionn', retcode=3)
2187
# Or to ignore retcode checking
2188
result = self.assertRunBzrSubprocess({},
2189
StubProcess(err="unknown command", retcode=3), '--versionn',
2191
self.assertContainsRe(result[1], 'unknown command')
2193
def test_env_change_passes_through(self):
2194
self.assertRunBzrSubprocess(
2195
{'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
2197
env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
2199
def test_no_working_dir_passed_as_None(self):
2200
self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
2202
def test_no_working_dir_passed_through(self):
2203
self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
2206
def test_run_bzr_subprocess_no_plugins(self):
2207
self.assertRunBzrSubprocess({'allow_plugins': False},
2210
def test_allow_plugins(self):
2211
self.assertRunBzrSubprocess({'allow_plugins': True},
2212
StubProcess(), '', allow_plugins=True)
2215
class TestFinishBzrSubprocess(TestWithFakedStartBzrSubprocess):
2217
def test_finish_bzr_subprocess_with_error(self):
2218
"""finish_bzr_subprocess allows specification of the desired exit code.
2220
process = StubProcess(err="unknown command", retcode=3)
2221
result = self.finish_bzr_subprocess(process, retcode=3)
2222
self.assertEqual('', result[0])
2223
self.assertContainsRe(result[1], 'unknown command')
2225
def test_finish_bzr_subprocess_ignoring_retcode(self):
2226
"""finish_bzr_subprocess allows the exit code to be ignored."""
2227
process = StubProcess(err="unknown command", retcode=3)
2228
result = self.finish_bzr_subprocess(process, retcode=None)
2229
self.assertEqual('', result[0])
2230
self.assertContainsRe(result[1], 'unknown command')
2232
def test_finish_subprocess_with_unexpected_retcode(self):
2233
"""finish_bzr_subprocess raises self.failureException if the retcode is
2234
not the expected one.
2236
process = StubProcess(err="unknown command", retcode=3)
2237
self.assertRaises(self.failureException, self.finish_bzr_subprocess,
2241
class _DontSpawnProcess(Exception):
2242
"""A simple exception which just allows us to skip unnecessary steps"""
2245
class TestStartBzrSubProcess(tests.TestCase):
2247
def check_popen_state(self):
2248
"""Replace to make assertions when popen is called."""
2250
def _popen(self, *args, **kwargs):
2251
"""Record the command that is run, so that we can ensure it is correct"""
2252
self.check_popen_state()
2253
self._popen_args = args
2254
self._popen_kwargs = kwargs
2255
raise _DontSpawnProcess()
2257
def test_run_bzr_subprocess_no_plugins(self):
2258
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
2259
command = self._popen_args[0]
2260
self.assertEqual(sys.executable, command[0])
2261
self.assertEqual(self.get_bzr_path(), command[1])
2262
self.assertEqual(['--no-plugins'], command[2:])
2264
def test_allow_plugins(self):
2265
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2267
command = self._popen_args[0]
2268
self.assertEqual([], command[2:])
2270
def test_set_env(self):
2271
self.failIf('EXISTANT_ENV_VAR' in os.environ)
2273
def check_environment():
2274
self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2275
self.check_popen_state = check_environment
2276
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2277
env_changes={'EXISTANT_ENV_VAR':'set variable'})
2278
# not set in theparent
2279
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2281
def test_run_bzr_subprocess_env_del(self):
2282
"""run_bzr_subprocess can remove environment variables too."""
2283
self.failIf('EXISTANT_ENV_VAR' in os.environ)
2284
def check_environment():
2285
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2286
os.environ['EXISTANT_ENV_VAR'] = 'set variable'
2287
self.check_popen_state = check_environment
2288
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2289
env_changes={'EXISTANT_ENV_VAR':None})
2290
# Still set in parent
2291
self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2292
del os.environ['EXISTANT_ENV_VAR']
2294
def test_env_del_missing(self):
2295
self.failIf('NON_EXISTANT_ENV_VAR' in os.environ)
2296
def check_environment():
2297
self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2298
self.check_popen_state = check_environment
2299
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2300
env_changes={'NON_EXISTANT_ENV_VAR':None})
2302
def test_working_dir(self):
2303
"""Test that we can specify the working dir for the child"""
2304
orig_getcwd = osutils.getcwd
2305
orig_chdir = os.chdir
2313
osutils.getcwd = getcwd
2315
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2318
osutils.getcwd = orig_getcwd
2320
os.chdir = orig_chdir
2321
self.assertEqual(['foo', 'current'], chdirs)
2324
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
2325
"""Tests that really need to do things with an external bzr."""
2327
def test_start_and_stop_bzr_subprocess_send_signal(self):
2328
"""finish_bzr_subprocess raises self.failureException if the retcode is
2329
not the expected one.
2331
self.disable_missing_extensions_warning()
2332
process = self.start_bzr_subprocess(['wait-until-signalled'],
2333
skip_if_plan_to_signal=True)
2334
self.assertEqual('running\n', process.stdout.readline())
2335
result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
2337
self.assertEqual('', result[0])
2338
self.assertEqual('bzr: interrupted\n', result[1])
2341
class TestFeature(tests.TestCase):
2343
def test_caching(self):
2344
"""Feature._probe is called by the feature at most once."""
2345
class InstrumentedFeature(tests.Feature):
2347
super(InstrumentedFeature, self).__init__()
2350
self.calls.append('_probe')
2352
feature = InstrumentedFeature()
2354
self.assertEqual(['_probe'], feature.calls)
2356
self.assertEqual(['_probe'], feature.calls)
2358
def test_named_str(self):
2359
"""Feature.__str__ should thunk to feature_name()."""
2360
class NamedFeature(tests.Feature):
2361
def feature_name(self):
2363
feature = NamedFeature()
2364
self.assertEqual('symlinks', str(feature))
2366
def test_default_str(self):
2367
"""Feature.__str__ should default to __class__.__name__."""
2368
class NamedFeature(tests.Feature):
2370
feature = NamedFeature()
2371
self.assertEqual('NamedFeature', str(feature))
2374
class TestUnavailableFeature(tests.TestCase):
2376
def test_access_feature(self):
2377
feature = tests.Feature()
2378
exception = tests.UnavailableFeature(feature)
2379
self.assertIs(feature, exception.args[0])
2382
simple_thunk_feature = tests._CompatabilityThunkFeature(
2383
'bzrlib.tests', 'UnicodeFilename',
2384
'bzrlib.tests.test_selftest.simple_thunk_feature',
2385
deprecated_in((2,1,0)))
2387
class Test_CompatibilityFeature(tests.TestCase):
2389
def test_does_thunk(self):
2390
res = self.callDeprecated(
2391
['bzrlib.tests.test_selftest.simple_thunk_feature was deprecated'
2392
' in version 2.1.0. Use bzrlib.tests.UnicodeFilename instead.'],
2393
simple_thunk_feature.available)
2394
self.assertEqual(tests.UnicodeFilename.available(), res)
2397
class TestModuleAvailableFeature(tests.TestCase):
2399
def test_available_module(self):
2400
feature = tests.ModuleAvailableFeature('bzrlib.tests')
2401
self.assertEqual('bzrlib.tests', feature.module_name)
2402
self.assertEqual('bzrlib.tests', str(feature))
2403
self.assertTrue(feature.available())
2404
self.assertIs(tests, feature.module)
2406
def test_unavailable_module(self):
2407
feature = tests.ModuleAvailableFeature('bzrlib.no_such_module_exists')
2408
self.assertEqual('bzrlib.no_such_module_exists', str(feature))
2409
self.assertFalse(feature.available())
2410
self.assertIs(None, feature.module)
2413
class TestSelftestFiltering(tests.TestCase):
2416
tests.TestCase.setUp(self)
2417
self.suite = TestUtil.TestSuite()
2418
self.loader = TestUtil.TestLoader()
2419
self.suite.addTest(self.loader.loadTestsFromModule(
2420
sys.modules['bzrlib.tests.test_selftest']))
2421
self.all_names = _test_ids(self.suite)
2423
def test_condition_id_re(self):
2424
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2425
'test_condition_id_re')
2426
filtered_suite = tests.filter_suite_by_condition(
2427
self.suite, tests.condition_id_re('test_condition_id_re'))
2428
self.assertEqual([test_name], _test_ids(filtered_suite))
2430
def test_condition_id_in_list(self):
2431
test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
2432
'test_condition_id_in_list']
2433
id_list = tests.TestIdList(test_names)
2434
filtered_suite = tests.filter_suite_by_condition(
2435
self.suite, tests.condition_id_in_list(id_list))
2436
my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
2437
re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
2438
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2440
def test_condition_id_startswith(self):
2441
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2442
start1 = klass + 'test_condition_id_starts'
2443
start2 = klass + 'test_condition_id_in'
2444
test_names = [ klass + 'test_condition_id_in_list',
2445
klass + 'test_condition_id_startswith',
2447
filtered_suite = tests.filter_suite_by_condition(
2448
self.suite, tests.condition_id_startswith([start1, start2]))
2449
self.assertEqual(test_names, _test_ids(filtered_suite))
2451
def test_condition_isinstance(self):
2452
filtered_suite = tests.filter_suite_by_condition(
2453
self.suite, tests.condition_isinstance(self.__class__))
2454
class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2455
re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
2456
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2458
def test_exclude_tests_by_condition(self):
2459
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2460
'test_exclude_tests_by_condition')
2461
filtered_suite = tests.exclude_tests_by_condition(self.suite,
2462
lambda x:x.id() == excluded_name)
2463
self.assertEqual(len(self.all_names) - 1,
2464
filtered_suite.countTestCases())
2465
self.assertFalse(excluded_name in _test_ids(filtered_suite))
2466
remaining_names = list(self.all_names)
2467
remaining_names.remove(excluded_name)
2468
self.assertEqual(remaining_names, _test_ids(filtered_suite))
2470
def test_exclude_tests_by_re(self):
2471
self.all_names = _test_ids(self.suite)
2472
filtered_suite = tests.exclude_tests_by_re(self.suite,
2473
'exclude_tests_by_re')
2474
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2475
'test_exclude_tests_by_re')
2476
self.assertEqual(len(self.all_names) - 1,
2477
filtered_suite.countTestCases())
2478
self.assertFalse(excluded_name in _test_ids(filtered_suite))
2479
remaining_names = list(self.all_names)
2480
remaining_names.remove(excluded_name)
2481
self.assertEqual(remaining_names, _test_ids(filtered_suite))
2483
def test_filter_suite_by_condition(self):
2484
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2485
'test_filter_suite_by_condition')
2486
filtered_suite = tests.filter_suite_by_condition(self.suite,
2487
lambda x:x.id() == test_name)
2488
self.assertEqual([test_name], _test_ids(filtered_suite))
2490
def test_filter_suite_by_re(self):
2491
filtered_suite = tests.filter_suite_by_re(self.suite,
2492
'test_filter_suite_by_r')
2493
filtered_names = _test_ids(filtered_suite)
2494
self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
2495
'TestSelftestFiltering.test_filter_suite_by_re'])
2497
def test_filter_suite_by_id_list(self):
2498
test_list = ['bzrlib.tests.test_selftest.'
2499
'TestSelftestFiltering.test_filter_suite_by_id_list']
2500
filtered_suite = tests.filter_suite_by_id_list(
2501
self.suite, tests.TestIdList(test_list))
2502
filtered_names = _test_ids(filtered_suite)
2505
['bzrlib.tests.test_selftest.'
2506
'TestSelftestFiltering.test_filter_suite_by_id_list'])
2508
def test_filter_suite_by_id_startswith(self):
2509
# By design this test may fail if another test is added whose name also
2510
# begins with one of the start value used.
2511
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2512
start1 = klass + 'test_filter_suite_by_id_starts'
2513
start2 = klass + 'test_filter_suite_by_id_li'
2514
test_list = [klass + 'test_filter_suite_by_id_list',
2515
klass + 'test_filter_suite_by_id_startswith',
2517
filtered_suite = tests.filter_suite_by_id_startswith(
2518
self.suite, [start1, start2])
2521
_test_ids(filtered_suite),
2524
def test_preserve_input(self):
2525
# NB: Surely this is something in the stdlib to do this?
2526
self.assertTrue(self.suite is tests.preserve_input(self.suite))
2527
self.assertTrue("@#$" is tests.preserve_input("@#$"))
2529
def test_randomize_suite(self):
2530
randomized_suite = tests.randomize_suite(self.suite)
2531
# randomizing should not add or remove test names.
2532
self.assertEqual(set(_test_ids(self.suite)),
2533
set(_test_ids(randomized_suite)))
2534
# Technically, this *can* fail, because random.shuffle(list) can be
2535
# equal to list. Trying multiple times just pushes the frequency back.
2536
# As its len(self.all_names)!:1, the failure frequency should be low
2537
# enough to ignore. RBC 20071021.
2538
# It should change the order.
2539
self.assertNotEqual(self.all_names, _test_ids(randomized_suite))
2540
# But not the length. (Possibly redundant with the set test, but not
2542
self.assertEqual(len(self.all_names), len(_test_ids(randomized_suite)))
2544
def test_split_suit_by_condition(self):
2545
self.all_names = _test_ids(self.suite)
2546
condition = tests.condition_id_re('test_filter_suite_by_r')
2547
split_suite = tests.split_suite_by_condition(self.suite, condition)
2548
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2549
'test_filter_suite_by_re')
2550
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2551
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2552
remaining_names = list(self.all_names)
2553
remaining_names.remove(filtered_name)
2554
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2556
def test_split_suit_by_re(self):
2557
self.all_names = _test_ids(self.suite)
2558
split_suite = tests.split_suite_by_re(self.suite,
2559
'test_filter_suite_by_r')
2560
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2561
'test_filter_suite_by_re')
2562
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2563
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2564
remaining_names = list(self.all_names)
2565
remaining_names.remove(filtered_name)
2566
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2569
class TestCheckInventoryShape(tests.TestCaseWithTransport):
2571
def test_check_inventory_shape(self):
2572
files = ['a', 'b/', 'b/c']
2573
tree = self.make_branch_and_tree('.')
2574
self.build_tree(files)
2578
self.check_inventory_shape(tree.inventory, files)
2583
class TestBlackboxSupport(tests.TestCase):
2584
"""Tests for testsuite blackbox features."""
2586
def test_run_bzr_failure_not_caught(self):
2587
# When we run bzr in blackbox mode, we want any unexpected errors to
2588
# propagate up to the test suite so that it can show the error in the
2589
# usual way, and we won't get a double traceback.
2590
e = self.assertRaises(
2592
self.run_bzr, ['assert-fail'])
2593
# make sure we got the real thing, not an error from somewhere else in
2594
# the test framework
2595
self.assertEquals('always fails', str(e))
2596
# check that there's no traceback in the test log
2597
self.assertNotContainsRe(self.get_log(), r'Traceback')
2599
def test_run_bzr_user_error_caught(self):
2600
# Running bzr in blackbox mode, normal/expected/user errors should be
2601
# caught in the regular way and turned into an error message plus exit
2603
transport_server = MemoryServer()
2604
transport_server.start_server()
2605
self.addCleanup(transport_server.stop_server)
2606
url = transport_server.get_url()
2607
self.permit_url(url)
2608
out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
2609
self.assertEqual(out, '')
2610
self.assertContainsRe(err,
2611
'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
2614
class TestTestLoader(tests.TestCase):
2615
"""Tests for the test loader."""
2617
def _get_loader_and_module(self):
2618
"""Gets a TestLoader and a module with one test in it."""
2619
loader = TestUtil.TestLoader()
2621
class Stub(tests.TestCase):
2624
class MyModule(object):
2626
MyModule.a_class = Stub
2628
return loader, module
2630
def test_module_no_load_tests_attribute_loads_classes(self):
2631
loader, module = self._get_loader_and_module()
2632
self.assertEqual(1, loader.loadTestsFromModule(module).countTestCases())
2634
def test_module_load_tests_attribute_gets_called(self):
2635
loader, module = self._get_loader_and_module()
2636
# 'self' is here because we're faking the module with a class. Regular
2637
# load_tests do not need that :)
2638
def load_tests(self, standard_tests, module, loader):
2639
result = loader.suiteClass()
2640
for test in tests.iter_suite_tests(standard_tests):
2641
result.addTests([test, test])
2643
# add a load_tests() method which multiplies the tests from the module.
2644
module.__class__.load_tests = load_tests
2645
self.assertEqual(2, loader.loadTestsFromModule(module).countTestCases())
2647
def test_load_tests_from_module_name_smoke_test(self):
2648
loader = TestUtil.TestLoader()
2649
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2650
self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2653
def test_load_tests_from_module_name_with_bogus_module_name(self):
2654
loader = TestUtil.TestLoader()
2655
self.assertRaises(ImportError, loader.loadTestsFromModuleName, 'bogus')
2658
class TestTestIdList(tests.TestCase):
2660
def _create_id_list(self, test_list):
2661
return tests.TestIdList(test_list)
2663
def _create_suite(self, test_id_list):
2665
class Stub(tests.TestCase):
2669
def _create_test_id(id):
2672
suite = TestUtil.TestSuite()
2673
for id in test_id_list:
2674
t = Stub('test_foo')
2675
t.id = _create_test_id(id)
2679
def _test_ids(self, test_suite):
2680
"""Get the ids for the tests in a test suite."""
2681
return [t.id() for t in tests.iter_suite_tests(test_suite)]
2683
def test_empty_list(self):
2684
id_list = self._create_id_list([])
2685
self.assertEquals({}, id_list.tests)
2686
self.assertEquals({}, id_list.modules)
2688
def test_valid_list(self):
2689
id_list = self._create_id_list(
2690
['mod1.cl1.meth1', 'mod1.cl1.meth2',
2691
'mod1.func1', 'mod1.cl2.meth2',
2693
'mod1.submod2.cl1.meth1', 'mod1.submod2.cl2.meth2',
2695
self.assertTrue(id_list.refers_to('mod1'))
2696
self.assertTrue(id_list.refers_to('mod1.submod1'))
2697
self.assertTrue(id_list.refers_to('mod1.submod2'))
2698
self.assertTrue(id_list.includes('mod1.cl1.meth1'))
2699
self.assertTrue(id_list.includes('mod1.submod1'))
2700
self.assertTrue(id_list.includes('mod1.func1'))
2702
def test_bad_chars_in_params(self):
2703
id_list = self._create_id_list(['mod1.cl1.meth1(xx.yy)'])
2704
self.assertTrue(id_list.refers_to('mod1'))
2705
self.assertTrue(id_list.includes('mod1.cl1.meth1(xx.yy)'))
2707
def test_module_used(self):
2708
id_list = self._create_id_list(['mod.class.meth'])
2709
self.assertTrue(id_list.refers_to('mod'))
2710
self.assertTrue(id_list.refers_to('mod.class'))
2711
self.assertTrue(id_list.refers_to('mod.class.meth'))
2713
def test_test_suite_matches_id_list_with_unknown(self):
2714
loader = TestUtil.TestLoader()
2715
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2716
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',
2718
not_found, duplicates = tests.suite_matches_id_list(suite, test_list)
2719
self.assertEquals(['bogus'], not_found)
2720
self.assertEquals([], duplicates)
2722
def test_suite_matches_id_list_with_duplicates(self):
2723
loader = TestUtil.TestLoader()
2724
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2725
dupes = loader.suiteClass()
2726
for test in tests.iter_suite_tests(suite):
2728
dupes.addTest(test) # Add it again
2730
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',]
2731
not_found, duplicates = tests.suite_matches_id_list(
2733
self.assertEquals([], not_found)
2734
self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2738
class TestTestSuite(tests.TestCase):
2740
def test__test_suite_testmod_names(self):
2741
# Test that a plausible list of test module names are returned
2742
# by _test_suite_testmod_names.
2743
test_list = tests._test_suite_testmod_names()
2745
'bzrlib.tests.blackbox',
2746
'bzrlib.tests.per_transport',
2747
'bzrlib.tests.test_selftest',
2751
def test__test_suite_modules_to_doctest(self):
2752
# Test that a plausible list of modules to doctest is returned
2753
# by _test_suite_modules_to_doctest.
2754
test_list = tests._test_suite_modules_to_doctest()
2760
def test_test_suite(self):
2761
# test_suite() loads the entire test suite to operate. To avoid this
2762
# overhead, and yet still be confident that things are happening,
2763
# we temporarily replace two functions used by test_suite with
2764
# test doubles that supply a few sample tests to load, and check they
2767
def _test_suite_testmod_names():
2768
calls.append("testmod_names")
2770
'bzrlib.tests.blackbox.test_branch',
2771
'bzrlib.tests.per_transport',
2772
'bzrlib.tests.test_selftest',
2774
original_testmod_names = tests._test_suite_testmod_names
2775
def _test_suite_modules_to_doctest():
2776
calls.append("modules_to_doctest")
2777
return ['bzrlib.timestamp']
2778
orig_modules_to_doctest = tests._test_suite_modules_to_doctest
2779
def restore_names():
2780
tests._test_suite_testmod_names = original_testmod_names
2781
tests._test_suite_modules_to_doctest = orig_modules_to_doctest
2782
self.addCleanup(restore_names)
2783
tests._test_suite_testmod_names = _test_suite_testmod_names
2784
tests._test_suite_modules_to_doctest = _test_suite_modules_to_doctest
2785
expected_test_list = [
2787
'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
2788
('bzrlib.tests.per_transport.TransportTests'
2789
'.test_abspath(LocalTransport,LocalURLServer)'),
2790
'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
2791
# modules_to_doctest
2792
'bzrlib.timestamp.format_highres_date',
2793
# plugins can't be tested that way since selftest may be run with
2796
suite = tests.test_suite()
2797
self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
2799
self.assertSubset(expected_test_list, _test_ids(suite))
2801
def test_test_suite_list_and_start(self):
2802
# We cannot test this at the same time as the main load, because we want
2803
# to know that starting_with == None works. So a second load is
2804
# incurred - note that the starting_with parameter causes a partial load
2805
# rather than a full load so this test should be pretty quick.
2806
test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
2807
suite = tests.test_suite(test_list,
2808
['bzrlib.tests.test_selftest.TestTestSuite'])
2809
# test_test_suite_list_and_start is not included
2810
self.assertEquals(test_list, _test_ids(suite))
2813
class TestLoadTestIdList(tests.TestCaseInTempDir):
2815
def _create_test_list_file(self, file_name, content):
2816
fl = open(file_name, 'wt')
2820
def test_load_unknown(self):
2821
self.assertRaises(errors.NoSuchFile,
2822
tests.load_test_id_list, 'i_do_not_exist')
2824
def test_load_test_list(self):
2825
test_list_fname = 'test.list'
2826
self._create_test_list_file(test_list_fname,
2827
'mod1.cl1.meth1\nmod2.cl2.meth2\n')
2828
tlist = tests.load_test_id_list(test_list_fname)
2829
self.assertEquals(2, len(tlist))
2830
self.assertEquals('mod1.cl1.meth1', tlist[0])
2831
self.assertEquals('mod2.cl2.meth2', tlist[1])
2833
def test_load_dirty_file(self):
2834
test_list_fname = 'test.list'
2835
self._create_test_list_file(test_list_fname,
2836
' mod1.cl1.meth1\n\nmod2.cl2.meth2 \n'
2838
tlist = tests.load_test_id_list(test_list_fname)
2839
self.assertEquals(4, len(tlist))
2840
self.assertEquals('mod1.cl1.meth1', tlist[0])
2841
self.assertEquals('', tlist[1])
2842
self.assertEquals('mod2.cl2.meth2', tlist[2])
2843
self.assertEquals('bar baz', tlist[3])
2846
class TestFilteredByModuleTestLoader(tests.TestCase):
2848
def _create_loader(self, test_list):
2849
id_filter = tests.TestIdList(test_list)
2850
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2853
def test_load_tests(self):
2854
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2855
loader = self._create_loader(test_list)
2856
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2857
self.assertEquals(test_list, _test_ids(suite))
2859
def test_exclude_tests(self):
2860
test_list = ['bogus']
2861
loader = self._create_loader(test_list)
2862
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2863
self.assertEquals([], _test_ids(suite))
2866
class TestFilteredByNameStartTestLoader(tests.TestCase):
2868
def _create_loader(self, name_start):
2869
def needs_module(name):
2870
return name.startswith(name_start) or name_start.startswith(name)
2871
loader = TestUtil.FilteredByModuleTestLoader(needs_module)
2874
def test_load_tests(self):
2875
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2876
loader = self._create_loader('bzrlib.tests.test_samp')
2878
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2879
self.assertEquals(test_list, _test_ids(suite))
2881
def test_load_tests_inside_module(self):
2882
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2883
loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
2885
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2886
self.assertEquals(test_list, _test_ids(suite))
2888
def test_exclude_tests(self):
2889
test_list = ['bogus']
2890
loader = self._create_loader('bogus')
2892
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2893
self.assertEquals([], _test_ids(suite))
2896
class TestTestPrefixRegistry(tests.TestCase):
2898
def _get_registry(self):
2899
tp_registry = tests.TestPrefixAliasRegistry()
2902
def test_register_new_prefix(self):
2903
tpr = self._get_registry()
2904
tpr.register('foo', 'fff.ooo.ooo')
2905
self.assertEquals('fff.ooo.ooo', tpr.get('foo'))
2907
def test_register_existing_prefix(self):
2908
tpr = self._get_registry()
2909
tpr.register('bar', 'bbb.aaa.rrr')
2910
tpr.register('bar', 'bBB.aAA.rRR')
2911
self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
2912
self.assertThat(self.get_log(),
2913
DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR", ELLIPSIS))
2915
def test_get_unknown_prefix(self):
2916
tpr = self._get_registry()
2917
self.assertRaises(KeyError, tpr.get, 'I am not a prefix')
2919
def test_resolve_prefix(self):
2920
tpr = self._get_registry()
2921
tpr.register('bar', 'bb.aa.rr')
2922
self.assertEquals('bb.aa.rr', tpr.resolve_alias('bar'))
2924
def test_resolve_unknown_alias(self):
2925
tpr = self._get_registry()
2926
self.assertRaises(errors.BzrCommandError,
2927
tpr.resolve_alias, 'I am not a prefix')
2929
def test_predefined_prefixes(self):
2930
tpr = tests.test_prefix_alias_registry
2931
self.assertEquals('bzrlib', tpr.resolve_alias('bzrlib'))
2932
self.assertEquals('bzrlib.doc', tpr.resolve_alias('bd'))
2933
self.assertEquals('bzrlib.utils', tpr.resolve_alias('bu'))
2934
self.assertEquals('bzrlib.tests', tpr.resolve_alias('bt'))
2935
self.assertEquals('bzrlib.tests.blackbox', tpr.resolve_alias('bb'))
2936
self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
2939
class TestRunSuite(tests.TestCase):
2941
def test_runner_class(self):
2942
"""run_suite accepts and uses a runner_class keyword argument."""
2943
class Stub(tests.TestCase):
2946
suite = Stub("test_foo")
2948
class MyRunner(tests.TextTestRunner):
2949
def run(self, test):
2951
return tests.ExtendedTestResult(self.stream, self.descriptions,
2953
tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
2954
self.assertLength(1, calls)
added
removed
bzrlib/tests/test_selftest.py
