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