1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
42
from bzrlib.repofmt import (
46
from bzrlib.symbol_versioning import (
51
from bzrlib.tests import (
56
from bzrlib.trace import note
57
from bzrlib.transport.memory import MemoryServer, MemoryTransport
58
from bzrlib.version import _get_bzr_source_tree
61
def _test_ids(test_suite):
62
"""Get the ids for the tests in a test suite."""
63
return [t.id() for t in tests.iter_suite_tests(test_suite)]
66
class SelftestTests(tests.TestCase):
68
def test_import_tests(self):
69
mod = TestUtil._load_module_by_name('bzrlib.tests.test_selftest')
70
self.assertEqual(mod.SelftestTests, SelftestTests)
72
def test_import_test_failure(self):
73
self.assertRaises(ImportError,
74
TestUtil._load_module_by_name,
77
class MetaTestLog(tests.TestCase):
79
def test_logging(self):
80
"""Test logs are captured when a test fails."""
81
self.log('a test message')
82
self._log_file.flush()
83
self.assertContainsRe(self._get_log(keep_log_file=True),
87
class TestUnicodeFilename(tests.TestCase):
89
def test_probe_passes(self):
90
"""UnicodeFilename._probe passes."""
91
# We can't test much more than that because the behaviour depends
93
tests.UnicodeFilename._probe()
96
class TestTreeShape(tests.TestCaseInTempDir):
98
def test_unicode_paths(self):
99
self.requireFeature(tests.UnicodeFilename)
101
filename = u'hell\u00d8'
102
self.build_tree_contents([(filename, 'contents of hello')])
103
self.failUnlessExists(filename)
106
class TestTransportScenarios(tests.TestCase):
107
"""A group of tests that test the transport implementation adaption core.
109
This is a meta test that the tests are applied to all available
112
This will be generalised in the future which is why it is in this
113
test file even though it is specific to transport tests at the moment.
116
def test_get_transport_permutations(self):
117
# this checks that get_test_permutations defined by the module is
118
# called by the get_transport_test_permutations function.
119
class MockModule(object):
120
def get_test_permutations(self):
121
return sample_permutation
122
sample_permutation = [(1,2), (3,4)]
123
from bzrlib.tests.per_transport import get_transport_test_permutations
124
self.assertEqual(sample_permutation,
125
get_transport_test_permutations(MockModule()))
127
def test_scenarios_invlude_all_modules(self):
128
# this checks that the scenario generator returns as many permutations
129
# as there are in all the registered transport modules - we assume if
130
# this matches its probably doing the right thing especially in
131
# combination with the tests for setting the right classes below.
132
from bzrlib.tests.per_transport import transport_test_permutations
133
from bzrlib.transport import _get_transport_modules
134
modules = _get_transport_modules()
135
permutation_count = 0
136
for module in modules:
138
permutation_count += len(reduce(getattr,
139
(module + ".get_test_permutations").split('.')[1:],
140
__import__(module))())
141
except errors.DependencyNotPresent:
143
scenarios = transport_test_permutations()
144
self.assertEqual(permutation_count, len(scenarios))
146
def test_scenarios_include_transport_class(self):
147
# This test used to know about all the possible transports and the
148
# order they were returned but that seems overly brittle (mbp
150
from bzrlib.tests.per_transport import transport_test_permutations
151
scenarios = transport_test_permutations()
152
# there are at least that many builtin transports
153
self.assertTrue(len(scenarios) > 6)
154
one_scenario = scenarios[0]
155
self.assertIsInstance(one_scenario[0], str)
156
self.assertTrue(issubclass(one_scenario[1]["transport_class"],
157
bzrlib.transport.Transport))
158
self.assertTrue(issubclass(one_scenario[1]["transport_server"],
159
bzrlib.transport.Server))
162
class TestBranchScenarios(tests.TestCase):
164
def test_scenarios(self):
165
# check that constructor parameters are passed through to the adapted
167
from bzrlib.tests.per_branch import make_scenarios
170
formats = [("c", "C"), ("d", "D")]
171
scenarios = make_scenarios(server1, server2, formats)
172
self.assertEqual(2, len(scenarios))
175
{'branch_format': 'c',
176
'bzrdir_format': 'C',
177
'transport_readonly_server': 'b',
178
'transport_server': 'a'}),
180
{'branch_format': 'd',
181
'bzrdir_format': 'D',
182
'transport_readonly_server': 'b',
183
'transport_server': 'a'})],
187
class TestBzrDirScenarios(tests.TestCase):
189
def test_scenarios(self):
190
# check that constructor parameters are passed through to the adapted
192
from bzrlib.tests.per_bzrdir import make_scenarios
197
scenarios = make_scenarios(vfs_factory, server1, server2, formats)
200
{'bzrdir_format': 'c',
201
'transport_readonly_server': 'b',
202
'transport_server': 'a',
203
'vfs_transport_factory': 'v'}),
205
{'bzrdir_format': 'd',
206
'transport_readonly_server': 'b',
207
'transport_server': 'a',
208
'vfs_transport_factory': 'v'})],
212
class TestRepositoryScenarios(tests.TestCase):
214
def test_formats_to_scenarios(self):
215
from bzrlib.tests.per_repository import formats_to_scenarios
216
formats = [("(c)", remote.RemoteRepositoryFormat()),
217
("(d)", repository.format_registry.get(
218
'Bazaar pack repository format 1 (needs bzr 0.92)\n'))]
219
no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
221
vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
222
vfs_transport_factory="vfs")
223
# no_vfs generate scenarios without vfs_transport_factory
225
('RemoteRepositoryFormat(c)',
226
{'bzrdir_format': remote.RemoteBzrDirFormat(),
227
'repository_format': remote.RemoteRepositoryFormat(),
228
'transport_readonly_server': 'readonly',
229
'transport_server': 'server'}),
230
('RepositoryFormatKnitPack1(d)',
231
{'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
232
'repository_format': pack_repo.RepositoryFormatKnitPack1(),
233
'transport_readonly_server': 'readonly',
234
'transport_server': 'server'})],
237
('RemoteRepositoryFormat(c)',
238
{'bzrdir_format': remote.RemoteBzrDirFormat(),
239
'repository_format': remote.RemoteRepositoryFormat(),
240
'transport_readonly_server': 'readonly',
241
'transport_server': 'server',
242
'vfs_transport_factory': 'vfs'}),
243
('RepositoryFormatKnitPack1(d)',
244
{'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
245
'repository_format': pack_repo.RepositoryFormatKnitPack1(),
246
'transport_readonly_server': 'readonly',
247
'transport_server': 'server',
248
'vfs_transport_factory': 'vfs'})],
252
class TestTestScenarioApplication(tests.TestCase):
253
"""Tests for the test adaption facilities."""
255
def test_apply_scenario(self):
256
from bzrlib.tests import apply_scenario
257
input_test = TestTestScenarioApplication("test_apply_scenario")
258
# setup two adapted tests
259
adapted_test1 = apply_scenario(input_test,
261
{"bzrdir_format":"bzr_format",
262
"repository_format":"repo_fmt",
263
"transport_server":"transport_server",
264
"transport_readonly_server":"readonly-server"}))
265
adapted_test2 = apply_scenario(input_test,
266
("new id 2", {"bzrdir_format":None}))
267
# input_test should have been altered.
268
self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
269
# the new tests are mutually incompatible, ensuring it has
270
# made new ones, and unspecified elements in the scenario
271
# should not have been altered.
272
self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
273
self.assertEqual("repo_fmt", adapted_test1.repository_format)
274
self.assertEqual("transport_server", adapted_test1.transport_server)
275
self.assertEqual("readonly-server",
276
adapted_test1.transport_readonly_server)
278
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
279
"test_apply_scenario(new id)",
281
self.assertEqual(None, adapted_test2.bzrdir_format)
283
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
284
"test_apply_scenario(new id 2)",
288
class TestInterRepositoryScenarios(tests.TestCase):
290
def test_scenarios(self):
291
# check that constructor parameters are passed through to the adapted
293
from bzrlib.tests.per_interrepository import make_scenarios
296
formats = [(str, "C1", "C2"), (int, "D1", "D2")]
297
scenarios = make_scenarios(server1, server2, formats)
300
{'interrepo_class': str,
301
'repository_format': 'C1',
302
'repository_format_to': 'C2',
303
'transport_readonly_server': 'b',
304
'transport_server': 'a'}),
306
{'interrepo_class': int,
307
'repository_format': 'D1',
308
'repository_format_to': 'D2',
309
'transport_readonly_server': 'b',
310
'transport_server': 'a'})],
314
class TestWorkingTreeScenarios(tests.TestCase):
316
def test_scenarios(self):
317
# check that constructor parameters are passed through to the adapted
319
from bzrlib.tests.per_workingtree import make_scenarios
322
formats = [workingtree.WorkingTreeFormat2(),
323
workingtree.WorkingTreeFormat3(),]
324
scenarios = make_scenarios(server1, server2, formats)
326
('WorkingTreeFormat2',
327
{'bzrdir_format': formats[0]._matchingbzrdir,
328
'transport_readonly_server': 'b',
329
'transport_server': 'a',
330
'workingtree_format': formats[0]}),
331
('WorkingTreeFormat3',
332
{'bzrdir_format': formats[1]._matchingbzrdir,
333
'transport_readonly_server': 'b',
334
'transport_server': 'a',
335
'workingtree_format': formats[1]})],
339
class TestTreeScenarios(tests.TestCase):
341
def test_scenarios(self):
342
# the tree implementation scenario generator is meant to setup one
343
# instance for each working tree format, and one additional instance
344
# that will use the default wt format, but create a revision tree for
345
# the tests. this means that the wt ones should have the
346
# workingtree_to_test_tree attribute set to 'return_parameter' and the
347
# revision one set to revision_tree_from_workingtree.
349
from bzrlib.tests.per_tree import (
350
_dirstate_tree_from_workingtree,
355
revision_tree_from_workingtree
359
formats = [workingtree.WorkingTreeFormat2(),
360
workingtree.WorkingTreeFormat3(),]
361
scenarios = make_scenarios(server1, server2, formats)
362
self.assertEqual(7, len(scenarios))
363
default_wt_format = workingtree.WorkingTreeFormat4._default_format
364
wt4_format = workingtree.WorkingTreeFormat4()
365
wt5_format = workingtree.WorkingTreeFormat5()
366
expected_scenarios = [
367
('WorkingTreeFormat2',
368
{'bzrdir_format': formats[0]._matchingbzrdir,
369
'transport_readonly_server': 'b',
370
'transport_server': 'a',
371
'workingtree_format': formats[0],
372
'_workingtree_to_test_tree': return_parameter,
374
('WorkingTreeFormat3',
375
{'bzrdir_format': formats[1]._matchingbzrdir,
376
'transport_readonly_server': 'b',
377
'transport_server': 'a',
378
'workingtree_format': formats[1],
379
'_workingtree_to_test_tree': return_parameter,
382
{'_workingtree_to_test_tree': revision_tree_from_workingtree,
383
'bzrdir_format': default_wt_format._matchingbzrdir,
384
'transport_readonly_server': 'b',
385
'transport_server': 'a',
386
'workingtree_format': default_wt_format,
388
('DirStateRevisionTree,WT4',
389
{'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
390
'bzrdir_format': wt4_format._matchingbzrdir,
391
'transport_readonly_server': 'b',
392
'transport_server': 'a',
393
'workingtree_format': wt4_format,
395
('DirStateRevisionTree,WT5',
396
{'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
397
'bzrdir_format': wt5_format._matchingbzrdir,
398
'transport_readonly_server': 'b',
399
'transport_server': 'a',
400
'workingtree_format': wt5_format,
403
{'_workingtree_to_test_tree': preview_tree_pre,
404
'bzrdir_format': default_wt_format._matchingbzrdir,
405
'transport_readonly_server': 'b',
406
'transport_server': 'a',
407
'workingtree_format': default_wt_format}),
409
{'_workingtree_to_test_tree': preview_tree_post,
410
'bzrdir_format': default_wt_format._matchingbzrdir,
411
'transport_readonly_server': 'b',
412
'transport_server': 'a',
413
'workingtree_format': default_wt_format}),
415
self.assertEqual(expected_scenarios, scenarios)
418
class TestInterTreeScenarios(tests.TestCase):
419
"""A group of tests that test the InterTreeTestAdapter."""
421
def test_scenarios(self):
422
# check that constructor parameters are passed through to the adapted
424
# for InterTree tests we want the machinery to bring up two trees in
425
# each instance: the base one, and the one we are interacting with.
426
# because each optimiser can be direction specific, we need to test
427
# each optimiser in its chosen direction.
428
# unlike the TestProviderAdapter we dont want to automatically add a
429
# parameterized one for WorkingTree - the optimisers will tell us what
431
from bzrlib.tests.per_tree import (
433
revision_tree_from_workingtree
435
from bzrlib.tests.per_intertree import (
438
from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
439
input_test = TestInterTreeScenarios(
443
format1 = WorkingTreeFormat2()
444
format2 = WorkingTreeFormat3()
445
formats = [("1", str, format1, format2, "converter1"),
446
("2", int, format2, format1, "converter2")]
447
scenarios = make_scenarios(server1, server2, formats)
448
self.assertEqual(2, len(scenarios))
449
expected_scenarios = [
451
"bzrdir_format": format1._matchingbzrdir,
452
"intertree_class": formats[0][1],
453
"workingtree_format": formats[0][2],
454
"workingtree_format_to": formats[0][3],
455
"mutable_trees_to_test_trees": formats[0][4],
456
"_workingtree_to_test_tree": return_parameter,
457
"transport_server": server1,
458
"transport_readonly_server": server2,
461
"bzrdir_format": format2._matchingbzrdir,
462
"intertree_class": formats[1][1],
463
"workingtree_format": formats[1][2],
464
"workingtree_format_to": formats[1][3],
465
"mutable_trees_to_test_trees": formats[1][4],
466
"_workingtree_to_test_tree": return_parameter,
467
"transport_server": server1,
468
"transport_readonly_server": server2,
471
self.assertEqual(scenarios, expected_scenarios)
474
class TestTestCaseInTempDir(tests.TestCaseInTempDir):
476
def test_home_is_not_working(self):
477
self.assertNotEqual(self.test_dir, self.test_home_dir)
478
cwd = osutils.getcwd()
479
self.assertIsSameRealPath(self.test_dir, cwd)
480
self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
482
def test_assertEqualStat_equal(self):
483
from bzrlib.tests.test_dirstate import _FakeStat
484
self.build_tree(["foo"])
485
real = os.lstat("foo")
486
fake = _FakeStat(real.st_size, real.st_mtime, real.st_ctime,
487
real.st_dev, real.st_ino, real.st_mode)
488
self.assertEqualStat(real, fake)
490
def test_assertEqualStat_notequal(self):
491
self.build_tree(["foo", "bar"])
492
self.assertRaises(AssertionError, self.assertEqualStat,
493
os.lstat("foo"), os.lstat("bar"))
496
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
498
def test_home_is_non_existant_dir_under_root(self):
499
"""The test_home_dir for TestCaseWithMemoryTransport is missing.
501
This is because TestCaseWithMemoryTransport is for tests that do not
502
need any disk resources: they should be hooked into bzrlib in such a
503
way that no global settings are being changed by the test (only a
504
few tests should need to do that), and having a missing dir as home is
505
an effective way to ensure that this is the case.
507
self.assertIsSameRealPath(
508
self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
510
self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
512
def test_cwd_is_TEST_ROOT(self):
513
self.assertIsSameRealPath(self.test_dir, self.TEST_ROOT)
514
cwd = osutils.getcwd()
515
self.assertIsSameRealPath(self.test_dir, cwd)
517
def test_make_branch_and_memory_tree(self):
518
"""In TestCaseWithMemoryTransport we should not make the branch on disk.
520
This is hard to comprehensively robustly test, so we settle for making
521
a branch and checking no directory was created at its relpath.
523
tree = self.make_branch_and_memory_tree('dir')
524
# Guard against regression into MemoryTransport leaking
525
# files to disk instead of keeping them in memory.
526
self.failIf(osutils.lexists('dir'))
527
self.assertIsInstance(tree, memorytree.MemoryTree)
529
def test_make_branch_and_memory_tree_with_format(self):
530
"""make_branch_and_memory_tree should accept a format option."""
531
format = bzrdir.BzrDirMetaFormat1()
532
format.repository_format = weaverepo.RepositoryFormat7()
533
tree = self.make_branch_and_memory_tree('dir', format=format)
534
# Guard against regression into MemoryTransport leaking
535
# files to disk instead of keeping them in memory.
536
self.failIf(osutils.lexists('dir'))
537
self.assertIsInstance(tree, memorytree.MemoryTree)
538
self.assertEqual(format.repository_format.__class__,
539
tree.branch.repository._format.__class__)
541
def test_make_branch_builder(self):
542
builder = self.make_branch_builder('dir')
543
self.assertIsInstance(builder, branchbuilder.BranchBuilder)
544
# Guard against regression into MemoryTransport leaking
545
# files to disk instead of keeping them in memory.
546
self.failIf(osutils.lexists('dir'))
548
def test_make_branch_builder_with_format(self):
549
# Use a repo layout that doesn't conform to a 'named' layout, to ensure
550
# that the format objects are used.
551
format = bzrdir.BzrDirMetaFormat1()
552
repo_format = weaverepo.RepositoryFormat7()
553
format.repository_format = repo_format
554
builder = self.make_branch_builder('dir', format=format)
555
the_branch = builder.get_branch()
556
# Guard against regression into MemoryTransport leaking
557
# files to disk instead of keeping them in memory.
558
self.failIf(osutils.lexists('dir'))
559
self.assertEqual(format.repository_format.__class__,
560
the_branch.repository._format.__class__)
561
self.assertEqual(repo_format.get_format_string(),
562
self.get_transport().get_bytes(
563
'dir/.bzr/repository/format'))
565
def test_make_branch_builder_with_format_name(self):
566
builder = self.make_branch_builder('dir', format='knit')
567
the_branch = builder.get_branch()
568
# Guard against regression into MemoryTransport leaking
569
# files to disk instead of keeping them in memory.
570
self.failIf(osutils.lexists('dir'))
571
dir_format = bzrdir.format_registry.make_bzrdir('knit')
572
self.assertEqual(dir_format.repository_format.__class__,
573
the_branch.repository._format.__class__)
574
self.assertEqual('Bazaar-NG Knit Repository Format 1',
575
self.get_transport().get_bytes(
576
'dir/.bzr/repository/format'))
578
def test_safety_net(self):
579
"""No test should modify the safety .bzr directory.
581
We just test that the _check_safety_net private method raises
582
AssertionError, it's easier than building a test suite with the same
585
# Oops, a commit in the current directory (i.e. without local .bzr
586
# directory) will crawl up the hierarchy to find a .bzr directory.
587
self.run_bzr(['commit', '-mfoo', '--unchanged'])
588
# But we have a safety net in place.
589
self.assertRaises(AssertionError, self._check_safety_net)
591
def test_dangling_locks_cause_failures(self):
592
class TestDanglingLock(tests.TestCaseWithMemoryTransport):
593
def test_function(self):
594
t = self.get_transport('.')
595
l = lockdir.LockDir(t, 'lock')
598
test = TestDanglingLock('test_function')
600
self.assertEqual(1, len(result.errors))
603
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
604
"""Tests for the convenience functions TestCaseWithTransport introduces."""
606
def test_get_readonly_url_none(self):
607
from bzrlib.transport import get_transport
608
from bzrlib.transport.memory import MemoryServer
609
from bzrlib.transport.readonly import ReadonlyTransportDecorator
610
self.vfs_transport_factory = MemoryServer
611
self.transport_readonly_server = None
612
# calling get_readonly_transport() constructs a decorator on the url
614
url = self.get_readonly_url()
615
url2 = self.get_readonly_url('foo/bar')
616
t = get_transport(url)
617
t2 = get_transport(url2)
618
self.failUnless(isinstance(t, ReadonlyTransportDecorator))
619
self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
620
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
622
def test_get_readonly_url_http(self):
623
from bzrlib.tests.http_server import HttpServer
624
from bzrlib.transport import get_transport
625
from bzrlib.transport.local import LocalURLServer
626
from bzrlib.transport.http import HttpTransportBase
627
self.transport_server = LocalURLServer
628
self.transport_readonly_server = HttpServer
629
# calling get_readonly_transport() gives us a HTTP server instance.
630
url = self.get_readonly_url()
631
url2 = self.get_readonly_url('foo/bar')
632
# the transport returned may be any HttpTransportBase subclass
633
t = get_transport(url)
634
t2 = get_transport(url2)
635
self.failUnless(isinstance(t, HttpTransportBase))
636
self.failUnless(isinstance(t2, HttpTransportBase))
637
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
639
def test_is_directory(self):
640
"""Test assertIsDirectory assertion"""
641
t = self.get_transport()
642
self.build_tree(['a_dir/', 'a_file'], transport=t)
643
self.assertIsDirectory('a_dir', t)
644
self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
645
self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
647
def test_make_branch_builder(self):
648
builder = self.make_branch_builder('dir')
649
rev_id = builder.build_commit()
650
self.failUnlessExists('dir')
651
a_dir = bzrdir.BzrDir.open('dir')
652
self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
653
a_branch = a_dir.open_branch()
654
builder_branch = builder.get_branch()
655
self.assertEqual(a_branch.base, builder_branch.base)
656
self.assertEqual((1, rev_id), builder_branch.last_revision_info())
657
self.assertEqual((1, rev_id), a_branch.last_revision_info())
660
class TestTestCaseTransports(tests.TestCaseWithTransport):
663
super(TestTestCaseTransports, self).setUp()
664
self.vfs_transport_factory = MemoryServer
666
def test_make_bzrdir_preserves_transport(self):
667
t = self.get_transport()
668
result_bzrdir = self.make_bzrdir('subdir')
669
self.assertIsInstance(result_bzrdir.transport,
671
# should not be on disk, should only be in memory
672
self.failIfExists('subdir')
675
class TestChrootedTest(tests.ChrootedTestCase):
677
def test_root_is_root(self):
678
from bzrlib.transport import get_transport
679
t = get_transport(self.get_readonly_url())
681
self.assertEqual(url, t.clone('..').base)
684
class MockProgress(progress._BaseProgressBar):
685
"""Progress-bar standin that records calls.
687
Useful for testing pb using code.
691
progress._BaseProgressBar.__init__(self)
695
self.calls.append(('tick',))
697
def update(self, msg=None, current=None, total=None):
698
self.calls.append(('update', msg, current, total))
701
self.calls.append(('clear',))
703
def note(self, msg, *args):
704
self.calls.append(('note', msg, args))
707
class TestTestResult(tests.TestCase):
709
def check_timing(self, test_case, expected_re):
710
result = bzrlib.tests.TextTestResult(self._log_file,
714
test_case.run(result)
715
timed_string = result._testTimeString(test_case)
716
self.assertContainsRe(timed_string, expected_re)
718
def test_test_reporting(self):
719
class ShortDelayTestCase(tests.TestCase):
720
def test_short_delay(self):
722
def test_short_benchmark(self):
723
self.time(time.sleep, 0.003)
724
self.check_timing(ShortDelayTestCase('test_short_delay'),
726
# if a benchmark time is given, we now show just that time followed by
728
self.check_timing(ShortDelayTestCase('test_short_benchmark'),
731
def test_unittest_reporting_unittest_class(self):
732
# getting the time from a non-bzrlib test works ok
733
class ShortDelayTestCase(unittest.TestCase):
734
def test_short_delay(self):
736
self.check_timing(ShortDelayTestCase('test_short_delay'),
739
def test_assigned_benchmark_file_stores_date(self):
741
result = bzrlib.tests.TextTestResult(self._log_file,
746
output_string = output.getvalue()
747
# if you are wondering about the regexp please read the comment in
748
# test_bench_history (bzrlib.tests.test_selftest.TestRunner)
749
# XXX: what comment? -- Andrew Bennetts
750
self.assertContainsRe(output_string, "--date [0-9.]+")
752
def test_benchhistory_records_test_times(self):
753
result_stream = StringIO()
754
result = bzrlib.tests.TextTestResult(
758
bench_history=result_stream
761
# we want profile a call and check that its test duration is recorded
762
# make a new test instance that when run will generate a benchmark
763
example_test_case = TestTestResult("_time_hello_world_encoding")
764
# execute the test, which should succeed and record times
765
example_test_case.run(result)
766
lines = result_stream.getvalue().splitlines()
767
self.assertEqual(2, len(lines))
768
self.assertContainsRe(lines[1],
769
" *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
770
"._time_hello_world_encoding")
772
def _time_hello_world_encoding(self):
773
"""Profile two sleep calls
775
This is used to exercise the test framework.
777
self.time(unicode, 'hello', errors='replace')
778
self.time(unicode, 'world', errors='replace')
780
def test_lsprofiling(self):
781
"""Verbose test result prints lsprof statistics from test cases."""
782
self.requireFeature(test_lsprof.LSProfFeature)
783
result_stream = StringIO()
784
result = bzrlib.tests.VerboseTestResult(
785
unittest._WritelnDecorator(result_stream),
789
# we want profile a call of some sort and check it is output by
790
# addSuccess. We dont care about addError or addFailure as they
791
# are not that interesting for performance tuning.
792
# make a new test instance that when run will generate a profile
793
example_test_case = TestTestResult("_time_hello_world_encoding")
794
example_test_case._gather_lsprof_in_benchmarks = True
795
# execute the test, which should succeed and record profiles
796
example_test_case.run(result)
797
# lsprofile_something()
798
# if this worked we want
799
# LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
800
# CallCount Recursive Total(ms) Inline(ms) module:lineno(function)
801
# (the lsprof header)
802
# ... an arbitrary number of lines
803
# and the function call which is time.sleep.
804
# 1 0 ??? ??? ???(sleep)
805
# and then repeated but with 'world', rather than 'hello'.
806
# this should appear in the output stream of our test result.
807
output = result_stream.getvalue()
808
self.assertContainsRe(output,
809
r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
810
self.assertContainsRe(output,
811
r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
812
self.assertContainsRe(output,
813
r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
814
self.assertContainsRe(output,
815
r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
817
def test_known_failure(self):
818
"""A KnownFailure being raised should trigger several result actions."""
819
class InstrumentedTestResult(tests.ExtendedTestResult):
821
def startTests(self): pass
822
def report_test_start(self, test): pass
823
def report_known_failure(self, test, err):
824
self._call = test, err
825
result = InstrumentedTestResult(None, None, None, None)
827
raise tests.KnownFailure('failed!')
828
test = unittest.FunctionTestCase(test_function)
830
# it should invoke 'report_known_failure'.
831
self.assertEqual(2, len(result._call))
832
self.assertEqual(test, result._call[0])
833
self.assertEqual(tests.KnownFailure, result._call[1][0])
834
self.assertIsInstance(result._call[1][1], tests.KnownFailure)
835
# we dont introspec the traceback, if the rest is ok, it would be
836
# exceptional for it not to be.
837
# it should update the known_failure_count on the object.
838
self.assertEqual(1, result.known_failure_count)
839
# the result should be successful.
840
self.assertTrue(result.wasSuccessful())
842
def test_verbose_report_known_failure(self):
843
# verbose test output formatting
844
result_stream = StringIO()
845
result = bzrlib.tests.VerboseTestResult(
846
unittest._WritelnDecorator(result_stream),
850
test = self.get_passing_test()
851
result.startTest(test)
852
prefix = len(result_stream.getvalue())
853
# the err parameter has the shape:
854
# (class, exception object, traceback)
855
# KnownFailures dont get their tracebacks shown though, so we
857
err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
858
result.report_known_failure(test, err)
859
output = result_stream.getvalue()[prefix:]
860
lines = output.splitlines()
861
self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
862
self.assertEqual(lines[1], ' foo')
863
self.assertEqual(2, len(lines))
865
def test_text_report_known_failure(self):
866
# text test output formatting
868
result = bzrlib.tests.TextTestResult(
874
test = self.get_passing_test()
875
# this seeds the state to handle reporting the test.
876
result.startTest(test)
877
# the err parameter has the shape:
878
# (class, exception object, traceback)
879
# KnownFailures dont get their tracebacks shown though, so we
881
err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
882
result.report_known_failure(test, err)
885
('update', '[1 in 0s] passing_test', None, None),
886
('note', 'XFAIL: %s\n%s\n', ('passing_test', err[1]))
889
# known_failures should be printed in the summary, so if we run a test
890
# after there are some known failures, the update prefix should match
892
result.known_failure_count = 3
896
('update', '[2 in 0s] passing_test', None, None),
900
def get_passing_test(self):
901
"""Return a test object that can't be run usefully."""
904
return unittest.FunctionTestCase(passing_test)
906
def test_add_not_supported(self):
907
"""Test the behaviour of invoking addNotSupported."""
908
class InstrumentedTestResult(tests.ExtendedTestResult):
910
def startTests(self): pass
911
def report_test_start(self, test): pass
912
def report_unsupported(self, test, feature):
913
self._call = test, feature
914
result = InstrumentedTestResult(None, None, None, None)
915
test = SampleTestCase('_test_pass')
916
feature = tests.Feature()
917
result.startTest(test)
918
result.addNotSupported(test, feature)
919
# it should invoke 'report_unsupported'.
920
self.assertEqual(2, len(result._call))
921
self.assertEqual(test, result._call[0])
922
self.assertEqual(feature, result._call[1])
923
# the result should be successful.
924
self.assertTrue(result.wasSuccessful())
925
# it should record the test against a count of tests not run due to
927
self.assertEqual(1, result.unsupported['Feature'])
928
# and invoking it again should increment that counter
929
result.addNotSupported(test, feature)
930
self.assertEqual(2, result.unsupported['Feature'])
932
def test_verbose_report_unsupported(self):
933
# verbose test output formatting
934
result_stream = StringIO()
935
result = bzrlib.tests.VerboseTestResult(
936
unittest._WritelnDecorator(result_stream),
940
test = self.get_passing_test()
941
feature = tests.Feature()
942
result.startTest(test)
943
prefix = len(result_stream.getvalue())
944
result.report_unsupported(test, feature)
945
output = result_stream.getvalue()[prefix:]
946
lines = output.splitlines()
947
self.assertEqual(lines, ['NODEP 0ms',
948
" The feature 'Feature' is not available."])
950
def test_text_report_unsupported(self):
951
# text test output formatting
953
result = bzrlib.tests.TextTestResult(
959
test = self.get_passing_test()
960
feature = tests.Feature()
961
# this seeds the state to handle reporting the test.
962
result.startTest(test)
963
result.report_unsupported(test, feature)
964
# no output on unsupported features
966
[('update', '[1 in 0s] passing_test', None, None)
969
# the number of missing features should be printed in the progress
970
# summary, so check for that.
971
result.unsupported = {'foo':0, 'bar':0}
975
('update', '[2 in 0s, 2 missing] passing_test', None, None),
979
def test_unavailable_exception(self):
980
"""An UnavailableFeature being raised should invoke addNotSupported."""
981
class InstrumentedTestResult(tests.ExtendedTestResult):
983
def startTests(self): pass
984
def report_test_start(self, test): pass
985
def addNotSupported(self, test, feature):
986
self._call = test, feature
987
result = InstrumentedTestResult(None, None, None, None)
988
feature = tests.Feature()
990
raise tests.UnavailableFeature(feature)
991
test = unittest.FunctionTestCase(test_function)
993
# it should invoke 'addNotSupported'.
994
self.assertEqual(2, len(result._call))
995
self.assertEqual(test, result._call[0])
996
self.assertEqual(feature, result._call[1])
997
# and not count as an error
998
self.assertEqual(0, result.error_count)
1000
def test_strict_with_unsupported_feature(self):
1001
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
1003
test = self.get_passing_test()
1004
feature = "Unsupported Feature"
1005
result.addNotSupported(test, feature)
1006
self.assertFalse(result.wasStrictlySuccessful())
1007
self.assertEqual(None, result._extractBenchmarkTime(test))
1009
def test_strict_with_known_failure(self):
1010
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
1012
test = self.get_passing_test()
1013
err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
1014
result._addKnownFailure(test, err)
1015
self.assertFalse(result.wasStrictlySuccessful())
1016
self.assertEqual(None, result._extractBenchmarkTime(test))
1018
def test_strict_with_success(self):
1019
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
1021
test = self.get_passing_test()
1022
result.addSuccess(test)
1023
self.assertTrue(result.wasStrictlySuccessful())
1024
self.assertEqual(None, result._extractBenchmarkTime(test))
1026
def test_startTests(self):
1027
"""Starting the first test should trigger startTests."""
1028
class InstrumentedTestResult(tests.ExtendedTestResult):
1030
def startTests(self): self.calls += 1
1031
def report_test_start(self, test): pass
1032
result = InstrumentedTestResult(None, None, None, None)
1033
def test_function():
1035
test = unittest.FunctionTestCase(test_function)
1037
self.assertEquals(1, result.calls)
1040
class TestUnicodeFilenameFeature(tests.TestCase):
1042
def test_probe_passes(self):
1043
"""UnicodeFilenameFeature._probe passes."""
1044
# We can't test much more than that because the behaviour depends
1046
tests.UnicodeFilenameFeature._probe()
1049
class TestRunner(tests.TestCase):
1051
def dummy_test(self):
1054
def run_test_runner(self, testrunner, test):
1055
"""Run suite in testrunner, saving global state and restoring it.
1057
This current saves and restores:
1058
TestCaseInTempDir.TEST_ROOT
1060
There should be no tests in this file that use
1061
bzrlib.tests.TextTestRunner without using this convenience method,
1062
because of our use of global state.
1064
old_root = tests.TestCaseInTempDir.TEST_ROOT
1066
tests.TestCaseInTempDir.TEST_ROOT = None
1067
return testrunner.run(test)
1069
tests.TestCaseInTempDir.TEST_ROOT = old_root
1071
def test_known_failure_failed_run(self):
1072
# run a test that generates a known failure which should be printed in
1073
# the final output when real failures occur.
1074
def known_failure_test():
1075
raise tests.KnownFailure('failed')
1076
test = unittest.TestSuite()
1077
test.addTest(unittest.FunctionTestCase(known_failure_test))
1079
raise AssertionError('foo')
1080
test.addTest(unittest.FunctionTestCase(failing_test))
1082
runner = tests.TextTestRunner(stream=stream)
1083
result = self.run_test_runner(runner, test)
1084
lines = stream.getvalue().splitlines()
1087
'======================================================================',
1088
'FAIL: unittest.FunctionTestCase (failing_test)',
1089
'----------------------------------------------------------------------',
1090
'Traceback (most recent call last):',
1091
' raise AssertionError(\'foo\')',
1092
'AssertionError: foo',
1094
'----------------------------------------------------------------------',
1096
'FAILED (failures=1, known_failure_count=1)'],
1097
lines[3:8] + lines[9:13] + lines[14:])
1099
def test_known_failure_ok_run(self):
1100
# run a test that generates a known failure which should be printed in the final output.
1101
def known_failure_test():
1102
raise tests.KnownFailure('failed')
1103
test = unittest.FunctionTestCase(known_failure_test)
1105
runner = tests.TextTestRunner(stream=stream)
1106
result = self.run_test_runner(runner, test)
1107
self.assertContainsRe(stream.getvalue(),
1110
'Ran 1 test in .*\n'
1112
'OK \\(known_failures=1\\)\n')
1114
def test_skipped_test(self):
1115
# run a test that is skipped, and check the suite as a whole still
1117
# skipping_test must be hidden in here so it's not run as a real test
1118
class SkippingTest(tests.TestCase):
1119
def skipping_test(self):
1120
raise tests.TestSkipped('test intentionally skipped')
1121
runner = tests.TextTestRunner(stream=self._log_file)
1122
test = SkippingTest("skipping_test")
1123
result = self.run_test_runner(runner, test)
1124
self.assertTrue(result.wasSuccessful())
1126
def test_skipped_from_setup(self):
1128
class SkippedSetupTest(tests.TestCase):
1131
calls.append('setUp')
1132
self.addCleanup(self.cleanup)
1133
raise tests.TestSkipped('skipped setup')
1135
def test_skip(self):
1136
self.fail('test reached')
1139
calls.append('cleanup')
1141
runner = tests.TextTestRunner(stream=self._log_file)
1142
test = SkippedSetupTest('test_skip')
1143
result = self.run_test_runner(runner, test)
1144
self.assertTrue(result.wasSuccessful())
1145
# Check if cleanup was called the right number of times.
1146
self.assertEqual(['setUp', 'cleanup'], calls)
1148
def test_skipped_from_test(self):
1150
class SkippedTest(tests.TestCase):
1153
tests.TestCase.setUp(self)
1154
calls.append('setUp')
1155
self.addCleanup(self.cleanup)
1157
def test_skip(self):
1158
raise tests.TestSkipped('skipped test')
1161
calls.append('cleanup')
1163
runner = tests.TextTestRunner(stream=self._log_file)
1164
test = SkippedTest('test_skip')
1165
result = self.run_test_runner(runner, test)
1166
self.assertTrue(result.wasSuccessful())
1167
# Check if cleanup was called the right number of times.
1168
self.assertEqual(['setUp', 'cleanup'], calls)
1170
def test_not_applicable(self):
1171
# run a test that is skipped because it's not applicable
1172
def not_applicable_test():
1173
raise tests.TestNotApplicable('this test never runs')
1175
runner = tests.TextTestRunner(stream=out, verbosity=2)
1176
test = unittest.FunctionTestCase(not_applicable_test)
1177
result = self.run_test_runner(runner, test)
1178
self._log_file.write(out.getvalue())
1179
self.assertTrue(result.wasSuccessful())
1180
self.assertTrue(result.wasStrictlySuccessful())
1181
self.assertContainsRe(out.getvalue(),
1182
r'(?m)not_applicable_test * N/A')
1183
self.assertContainsRe(out.getvalue(),
1184
r'(?m)^ this test never runs')
1186
def test_not_applicable_demo(self):
1187
# just so you can see it in the test output
1188
raise tests.TestNotApplicable('this test is just a demonstation')
1190
def test_unsupported_features_listed(self):
1191
"""When unsupported features are encountered they are detailed."""
1192
class Feature1(tests.Feature):
1193
def _probe(self): return False
1194
class Feature2(tests.Feature):
1195
def _probe(self): return False
1196
# create sample tests
1197
test1 = SampleTestCase('_test_pass')
1198
test1._test_needs_features = [Feature1()]
1199
test2 = SampleTestCase('_test_pass')
1200
test2._test_needs_features = [Feature2()]
1201
test = unittest.TestSuite()
1205
runner = tests.TextTestRunner(stream=stream)
1206
result = self.run_test_runner(runner, test)
1207
lines = stream.getvalue().splitlines()
1210
"Missing feature 'Feature1' skipped 1 tests.",
1211
"Missing feature 'Feature2' skipped 1 tests.",
1215
def test_bench_history(self):
1216
# tests that the running the benchmark produces a history file
1217
# containing a timestamp and the revision id of the bzrlib source which
1219
workingtree = _get_bzr_source_tree()
1220
test = TestRunner('dummy_test')
1222
runner = tests.TextTestRunner(stream=self._log_file,
1223
bench_history=output)
1224
result = self.run_test_runner(runner, test)
1225
output_string = output.getvalue()
1226
self.assertContainsRe(output_string, "--date [0-9.]+")
1227
if workingtree is not None:
1228
revision_id = workingtree.get_parent_ids()[0]
1229
self.assertEndsWith(output_string.rstrip(), revision_id)
1231
def assertLogDeleted(self, test):
1232
log = test._get_log()
1233
self.assertEqual("DELETED log file to reduce memory footprint", log)
1234
self.assertEqual('', test._log_contents)
1235
self.assertIs(None, test._log_file_name)
1237
def test_success_log_deleted(self):
1238
"""Successful tests have their log deleted"""
1240
class LogTester(tests.TestCase):
1242
def test_success(self):
1243
self.log('this will be removed\n')
1246
runner = tests.TextTestRunner(stream=sio)
1247
test = LogTester('test_success')
1248
result = self.run_test_runner(runner, test)
1250
self.assertLogDeleted(test)
1252
def test_skipped_log_deleted(self):
1253
"""Skipped tests have their log deleted"""
1255
class LogTester(tests.TestCase):
1257
def test_skipped(self):
1258
self.log('this will be removed\n')
1259
raise tests.TestSkipped()
1262
runner = tests.TextTestRunner(stream=sio)
1263
test = LogTester('test_skipped')
1264
result = self.run_test_runner(runner, test)
1266
self.assertLogDeleted(test)
1268
def test_not_aplicable_log_deleted(self):
1269
"""Not applicable tests have their log deleted"""
1271
class LogTester(tests.TestCase):
1273
def test_not_applicable(self):
1274
self.log('this will be removed\n')
1275
raise tests.TestNotApplicable()
1278
runner = tests.TextTestRunner(stream=sio)
1279
test = LogTester('test_not_applicable')
1280
result = self.run_test_runner(runner, test)
1282
self.assertLogDeleted(test)
1284
def test_known_failure_log_deleted(self):
1285
"""Know failure tests have their log deleted"""
1287
class LogTester(tests.TestCase):
1289
def test_known_failure(self):
1290
self.log('this will be removed\n')
1291
raise tests.KnownFailure()
1294
runner = tests.TextTestRunner(stream=sio)
1295
test = LogTester('test_known_failure')
1296
result = self.run_test_runner(runner, test)
1298
self.assertLogDeleted(test)
1300
def test_fail_log_kept(self):
1301
"""Failed tests have their log kept"""
1303
class LogTester(tests.TestCase):
1305
def test_fail(self):
1306
self.log('this will be kept\n')
1307
self.fail('this test fails')
1310
runner = tests.TextTestRunner(stream=sio)
1311
test = LogTester('test_fail')
1312
result = self.run_test_runner(runner, test)
1314
text = sio.getvalue()
1315
self.assertContainsRe(text, 'this will be kept')
1316
self.assertContainsRe(text, 'this test fails')
1318
log = test._get_log()
1319
self.assertContainsRe(log, 'this will be kept')
1320
self.assertEqual(log, test._log_contents)
1322
def test_error_log_kept(self):
1323
"""Tests with errors have their log kept"""
1325
class LogTester(tests.TestCase):
1327
def test_error(self):
1328
self.log('this will be kept\n')
1329
raise ValueError('random exception raised')
1332
runner = tests.TextTestRunner(stream=sio)
1333
test = LogTester('test_error')
1334
result = self.run_test_runner(runner, test)
1336
text = sio.getvalue()
1337
self.assertContainsRe(text, 'this will be kept')
1338
self.assertContainsRe(text, 'random exception raised')
1340
log = test._get_log()
1341
self.assertContainsRe(log, 'this will be kept')
1342
self.assertEqual(log, test._log_contents)
1345
class SampleTestCase(tests.TestCase):
1347
def _test_pass(self):
1350
class _TestException(Exception):
1353
class TestTestCase(tests.TestCase):
1354
"""Tests that test the core bzrlib TestCase."""
1356
def test_assertLength_matches_empty(self):
1358
self.assertLength(0, a_list)
1360
def test_assertLength_matches_nonempty(self):
1362
self.assertLength(3, a_list)
1364
def test_assertLength_fails_different(self):
1366
self.assertRaises(AssertionError, self.assertLength, 1, a_list)
1368
def test_assertLength_shows_sequence_in_failure(self):
1370
exception = self.assertRaises(AssertionError, self.assertLength, 2,
1372
self.assertEqual('Incorrect length: wanted 2, got 3 for [1, 2, 3]',
1375
def test_base_setUp_not_called_causes_failure(self):
1376
class TestCaseWithBrokenSetUp(tests.TestCase):
1378
pass # does not call TestCase.setUp
1381
test = TestCaseWithBrokenSetUp('test_foo')
1382
result = unittest.TestResult()
1384
self.assertFalse(result.wasSuccessful())
1385
self.assertEqual(1, result.testsRun)
1387
def test_base_tearDown_not_called_causes_failure(self):
1388
class TestCaseWithBrokenTearDown(tests.TestCase):
1390
pass # does not call TestCase.tearDown
1393
test = TestCaseWithBrokenTearDown('test_foo')
1394
result = unittest.TestResult()
1396
self.assertFalse(result.wasSuccessful())
1397
self.assertEqual(1, result.testsRun)
1399
def test_debug_flags_sanitised(self):
1400
"""The bzrlib debug flags should be sanitised by setUp."""
1401
if 'allow_debug' in tests.selftest_debug_flags:
1402
raise tests.TestNotApplicable(
1403
'-Eallow_debug option prevents debug flag sanitisation')
1404
# we could set something and run a test that will check
1405
# it gets santised, but this is probably sufficient for now:
1406
# if someone runs the test with -Dsomething it will error.
1407
self.assertEqual(set(), bzrlib.debug.debug_flags)
1409
def change_selftest_debug_flags(self, new_flags):
1410
orig_selftest_flags = tests.selftest_debug_flags
1411
self.addCleanup(self._restore_selftest_debug_flags, orig_selftest_flags)
1412
tests.selftest_debug_flags = set(new_flags)
1414
def _restore_selftest_debug_flags(self, flags):
1415
tests.selftest_debug_flags = flags
1417
def test_allow_debug_flag(self):
1418
"""The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1419
sanitised (i.e. cleared) before running a test.
1421
self.change_selftest_debug_flags(set(['allow_debug']))
1422
bzrlib.debug.debug_flags = set(['a-flag'])
1423
class TestThatRecordsFlags(tests.TestCase):
1424
def test_foo(nested_self):
1425
self.flags = set(bzrlib.debug.debug_flags)
1426
test = TestThatRecordsFlags('test_foo')
1427
test.run(self.make_test_result())
1428
self.assertEqual(set(['a-flag']), self.flags)
1430
def test_debug_flags_restored(self):
1431
"""The bzrlib debug flags should be restored to their original state
1432
after the test was run, even if allow_debug is set.
1434
self.change_selftest_debug_flags(set(['allow_debug']))
1435
# Now run a test that modifies debug.debug_flags.
1436
bzrlib.debug.debug_flags = set(['original-state'])
1437
class TestThatModifiesFlags(tests.TestCase):
1439
bzrlib.debug.debug_flags = set(['modified'])
1440
test = TestThatModifiesFlags('test_foo')
1441
test.run(self.make_test_result())
1442
self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1444
def make_test_result(self):
1445
return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
1447
def inner_test(self):
1448
# the inner child test
1451
def outer_child(self):
1452
# the outer child test
1454
self.inner_test = TestTestCase("inner_child")
1455
result = self.make_test_result()
1456
self.inner_test.run(result)
1457
note("outer finish")
1459
def test_trace_nesting(self):
1460
# this tests that each test case nests its trace facility correctly.
1461
# we do this by running a test case manually. That test case (A)
1462
# should setup a new log, log content to it, setup a child case (B),
1463
# which should log independently, then case (A) should log a trailer
1465
# we do two nested children so that we can verify the state of the
1466
# logs after the outer child finishes is correct, which a bad clean
1467
# up routine in tearDown might trigger a fault in our test with only
1468
# one child, we should instead see the bad result inside our test with
1470
# the outer child test
1471
original_trace = bzrlib.trace._trace_file
1472
outer_test = TestTestCase("outer_child")
1473
result = self.make_test_result()
1474
outer_test.run(result)
1475
self.assertEqual(original_trace, bzrlib.trace._trace_file)
1477
def method_that_times_a_bit_twice(self):
1478
# call self.time twice to ensure it aggregates
1479
self.time(time.sleep, 0.007)
1480
self.time(time.sleep, 0.007)
1482
def test_time_creates_benchmark_in_result(self):
1483
"""Test that the TestCase.time() method accumulates a benchmark time."""
1484
sample_test = TestTestCase("method_that_times_a_bit_twice")
1485
output_stream = StringIO()
1486
result = bzrlib.tests.VerboseTestResult(
1487
unittest._WritelnDecorator(output_stream),
1490
num_tests=sample_test.countTestCases())
1491
sample_test.run(result)
1492
self.assertContainsRe(
1493
output_stream.getvalue(),
1496
def test_hooks_sanitised(self):
1497
"""The bzrlib hooks should be sanitised by setUp."""
1498
# Note this test won't fail with hooks that the core library doesn't
1499
# use - but it trigger with a plugin that adds hooks, so its still a
1500
# useful warning in that case.
1501
self.assertEqual(bzrlib.branch.BranchHooks(),
1502
bzrlib.branch.Branch.hooks)
1503
self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
1504
bzrlib.smart.server.SmartTCPServer.hooks)
1505
self.assertEqual(bzrlib.commands.CommandHooks(),
1506
bzrlib.commands.Command.hooks)
1508
def test__gather_lsprof_in_benchmarks(self):
1509
"""When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1511
Each self.time() call is individually and separately profiled.
1513
self.requireFeature(test_lsprof.LSProfFeature)
1514
# overrides the class member with an instance member so no cleanup
1516
self._gather_lsprof_in_benchmarks = True
1517
self.time(time.sleep, 0.000)
1518
self.time(time.sleep, 0.003)
1519
self.assertEqual(2, len(self._benchcalls))
1520
self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
1521
self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1522
self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1523
self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1525
def test_knownFailure(self):
1526
"""Self.knownFailure() should raise a KnownFailure exception."""
1527
self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
1529
def test_requireFeature_available(self):
1530
"""self.requireFeature(available) is a no-op."""
1531
class Available(tests.Feature):
1532
def _probe(self):return True
1533
feature = Available()
1534
self.requireFeature(feature)
1536
def test_requireFeature_unavailable(self):
1537
"""self.requireFeature(unavailable) raises UnavailableFeature."""
1538
class Unavailable(tests.Feature):
1539
def _probe(self):return False
1540
feature = Unavailable()
1541
self.assertRaises(tests.UnavailableFeature,
1542
self.requireFeature, feature)
1544
def test_run_no_parameters(self):
1545
test = SampleTestCase('_test_pass')
1548
def test_run_enabled_unittest_result(self):
1549
"""Test we revert to regular behaviour when the test is enabled."""
1550
test = SampleTestCase('_test_pass')
1551
class EnabledFeature(object):
1552
def available(self):
1554
test._test_needs_features = [EnabledFeature()]
1555
result = unittest.TestResult()
1557
self.assertEqual(1, result.testsRun)
1558
self.assertEqual([], result.errors)
1559
self.assertEqual([], result.failures)
1561
def test_run_disabled_unittest_result(self):
1562
"""Test our compatability for disabled tests with unittest results."""
1563
test = SampleTestCase('_test_pass')
1564
class DisabledFeature(object):
1565
def available(self):
1567
test._test_needs_features = [DisabledFeature()]
1568
result = unittest.TestResult()
1570
self.assertEqual(1, result.testsRun)
1571
self.assertEqual([], result.errors)
1572
self.assertEqual([], result.failures)
1574
def test_run_disabled_supporting_result(self):
1575
"""Test disabled tests behaviour with support aware results."""
1576
test = SampleTestCase('_test_pass')
1577
class DisabledFeature(object):
1578
def available(self):
1580
the_feature = DisabledFeature()
1581
test._test_needs_features = [the_feature]
1582
class InstrumentedTestResult(unittest.TestResult):
1584
unittest.TestResult.__init__(self)
1586
def startTest(self, test):
1587
self.calls.append(('startTest', test))
1588
def stopTest(self, test):
1589
self.calls.append(('stopTest', test))
1590
def addNotSupported(self, test, feature):
1591
self.calls.append(('addNotSupported', test, feature))
1592
result = InstrumentedTestResult()
1595
('startTest', test),
1596
('addNotSupported', test, the_feature),
1601
def test_assert_list_raises_on_generator(self):
1602
def generator_which_will_raise():
1603
# This will not raise until after the first yield
1605
raise _TestException()
1607
e = self.assertListRaises(_TestException, generator_which_will_raise)
1608
self.assertIsInstance(e, _TestException)
1610
e = self.assertListRaises(Exception, generator_which_will_raise)
1611
self.assertIsInstance(e, _TestException)
1613
def test_assert_list_raises_on_plain(self):
1614
def plain_exception():
1615
raise _TestException()
1618
e = self.assertListRaises(_TestException, plain_exception)
1619
self.assertIsInstance(e, _TestException)
1621
e = self.assertListRaises(Exception, plain_exception)
1622
self.assertIsInstance(e, _TestException)
1624
def test_assert_list_raises_assert_wrong_exception(self):
1625
class _NotTestException(Exception):
1628
def wrong_exception():
1629
raise _NotTestException()
1631
def wrong_exception_generator():
1634
raise _NotTestException()
1636
# Wrong exceptions are not intercepted
1637
self.assertRaises(_NotTestException,
1638
self.assertListRaises, _TestException, wrong_exception)
1639
self.assertRaises(_NotTestException,
1640
self.assertListRaises, _TestException, wrong_exception_generator)
1642
def test_assert_list_raises_no_exception(self):
1646
def success_generator():
1650
self.assertRaises(AssertionError,
1651
self.assertListRaises, _TestException, success)
1653
self.assertRaises(AssertionError,
1654
self.assertListRaises, _TestException, success_generator)
1657
# NB: Don't delete this; it's not actually from 0.11!
1658
@deprecated_function(deprecated_in((0, 11, 0)))
1659
def sample_deprecated_function():
1660
"""A deprecated function to test applyDeprecated with."""
1664
def sample_undeprecated_function(a_param):
1665
"""A undeprecated function to test applyDeprecated with."""
1668
class ApplyDeprecatedHelper(object):
1669
"""A helper class for ApplyDeprecated tests."""
1671
@deprecated_method(deprecated_in((0, 11, 0)))
1672
def sample_deprecated_method(self, param_one):
1673
"""A deprecated method for testing with."""
1676
def sample_normal_method(self):
1677
"""A undeprecated method."""
1679
@deprecated_method(deprecated_in((0, 10, 0)))
1680
def sample_nested_deprecation(self):
1681
return sample_deprecated_function()
1684
class TestExtraAssertions(tests.TestCase):
1685
"""Tests for new test assertions in bzrlib test suite"""
1687
def test_assert_isinstance(self):
1688
self.assertIsInstance(2, int)
1689
self.assertIsInstance(u'', basestring)
1690
e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1691
self.assertEquals(str(e),
1692
"None is an instance of <type 'NoneType'> rather than <type 'int'>")
1693
self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1694
e = self.assertRaises(AssertionError,
1695
self.assertIsInstance, None, int, "it's just not")
1696
self.assertEquals(str(e),
1697
"None is an instance of <type 'NoneType'> rather than <type 'int'>"
1700
def test_assertEndsWith(self):
1701
self.assertEndsWith('foo', 'oo')
1702
self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1704
def test_applyDeprecated_not_deprecated(self):
1705
sample_object = ApplyDeprecatedHelper()
1706
# calling an undeprecated callable raises an assertion
1707
self.assertRaises(AssertionError, self.applyDeprecated,
1708
deprecated_in((0, 11, 0)),
1709
sample_object.sample_normal_method)
1710
self.assertRaises(AssertionError, self.applyDeprecated,
1711
deprecated_in((0, 11, 0)),
1712
sample_undeprecated_function, "a param value")
1713
# calling a deprecated callable (function or method) with the wrong
1714
# expected deprecation fails.
1715
self.assertRaises(AssertionError, self.applyDeprecated,
1716
deprecated_in((0, 10, 0)),
1717
sample_object.sample_deprecated_method, "a param value")
1718
self.assertRaises(AssertionError, self.applyDeprecated,
1719
deprecated_in((0, 10, 0)),
1720
sample_deprecated_function)
1721
# calling a deprecated callable (function or method) with the right
1722
# expected deprecation returns the functions result.
1723
self.assertEqual("a param value",
1724
self.applyDeprecated(deprecated_in((0, 11, 0)),
1725
sample_object.sample_deprecated_method, "a param value"))
1726
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 11, 0)),
1727
sample_deprecated_function))
1728
# calling a nested deprecation with the wrong deprecation version
1729
# fails even if a deeper nested function was deprecated with the
1731
self.assertRaises(AssertionError, self.applyDeprecated,
1732
deprecated_in((0, 11, 0)), sample_object.sample_nested_deprecation)
1733
# calling a nested deprecation with the right deprecation value
1734
# returns the calls result.
1735
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 10, 0)),
1736
sample_object.sample_nested_deprecation))
1738
def test_callDeprecated(self):
1739
def testfunc(be_deprecated, result=None):
1740
if be_deprecated is True:
1741
symbol_versioning.warn('i am deprecated', DeprecationWarning,
1744
result = self.callDeprecated(['i am deprecated'], testfunc, True)
1745
self.assertIs(None, result)
1746
result = self.callDeprecated([], testfunc, False, 'result')
1747
self.assertEqual('result', result)
1748
self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
1749
self.callDeprecated([], testfunc, be_deprecated=False)
1752
class TestWarningTests(tests.TestCase):
1753
"""Tests for calling methods that raise warnings."""
1755
def test_callCatchWarnings(self):
1757
warnings.warn("this is your last warning")
1759
wlist, result = self.callCatchWarnings(meth, 1, 2)
1760
self.assertEquals(3, result)
1761
# would like just to compare them, but UserWarning doesn't implement
1764
self.assertIsInstance(w0, UserWarning)
1765
self.assertEquals("this is your last warning", str(w0))
1768
class TestConvenienceMakers(tests.TestCaseWithTransport):
1769
"""Test for the make_* convenience functions."""
1771
def test_make_branch_and_tree_with_format(self):
1772
# we should be able to supply a format to make_branch_and_tree
1773
self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
1774
self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
1775
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
1776
bzrlib.bzrdir.BzrDirMetaFormat1)
1777
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
1778
bzrlib.bzrdir.BzrDirFormat6)
1780
def test_make_branch_and_memory_tree(self):
1781
# we should be able to get a new branch and a mutable tree from
1782
# TestCaseWithTransport
1783
tree = self.make_branch_and_memory_tree('a')
1784
self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1787
class TestSFTPMakeBranchAndTree(test_sftp_transport.TestCaseWithSFTPServer):
1789
def test_make_tree_for_sftp_branch(self):
1790
"""Transports backed by local directories create local trees."""
1792
tree = self.make_branch_and_tree('t1')
1793
base = tree.bzrdir.root_transport.base
1794
self.failIf(base.startswith('sftp'),
1795
'base %r is on sftp but should be local' % base)
1796
self.assertEquals(tree.bzrdir.root_transport,
1797
tree.branch.bzrdir.root_transport)
1798
self.assertEquals(tree.bzrdir.root_transport,
1799
tree.branch.repository.bzrdir.root_transport)
1802
class TestSelftest(tests.TestCase):
1803
"""Tests of bzrlib.tests.selftest."""
1805
def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1808
factory_called.append(True)
1809
return TestUtil.TestSuite()
1812
self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1813
test_suite_factory=factory)
1814
self.assertEqual([True], factory_called)
1817
class TestKnownFailure(tests.TestCase):
1819
def test_known_failure(self):
1820
"""Check that KnownFailure is defined appropriately."""
1821
# a KnownFailure is an assertion error for compatability with unaware
1823
self.assertIsInstance(tests.KnownFailure(""), AssertionError)
1825
def test_expect_failure(self):
1827
self.expectFailure("Doomed to failure", self.assertTrue, False)
1828
except tests.KnownFailure, e:
1829
self.assertEqual('Doomed to failure', e.args[0])
1831
self.expectFailure("Doomed to failure", self.assertTrue, True)
1832
except AssertionError, e:
1833
self.assertEqual('Unexpected success. Should have failed:'
1834
' Doomed to failure', e.args[0])
1836
self.fail('Assertion not raised')
1839
class TestFeature(tests.TestCase):
1841
def test_caching(self):
1842
"""Feature._probe is called by the feature at most once."""
1843
class InstrumentedFeature(tests.Feature):
1845
super(InstrumentedFeature, self).__init__()
1848
self.calls.append('_probe')
1850
feature = InstrumentedFeature()
1852
self.assertEqual(['_probe'], feature.calls)
1854
self.assertEqual(['_probe'], feature.calls)
1856
def test_named_str(self):
1857
"""Feature.__str__ should thunk to feature_name()."""
1858
class NamedFeature(tests.Feature):
1859
def feature_name(self):
1861
feature = NamedFeature()
1862
self.assertEqual('symlinks', str(feature))
1864
def test_default_str(self):
1865
"""Feature.__str__ should default to __class__.__name__."""
1866
class NamedFeature(tests.Feature):
1868
feature = NamedFeature()
1869
self.assertEqual('NamedFeature', str(feature))
1872
class TestUnavailableFeature(tests.TestCase):
1874
def test_access_feature(self):
1875
feature = tests.Feature()
1876
exception = tests.UnavailableFeature(feature)
1877
self.assertIs(feature, exception.args[0])
1880
class TestSelftestFiltering(tests.TestCase):
1883
tests.TestCase.setUp(self)
1884
self.suite = TestUtil.TestSuite()
1885
self.loader = TestUtil.TestLoader()
1886
self.suite.addTest(self.loader.loadTestsFromModuleNames([
1887
'bzrlib.tests.test_selftest']))
1888
self.all_names = _test_ids(self.suite)
1890
def test_condition_id_re(self):
1891
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
1892
'test_condition_id_re')
1893
filtered_suite = tests.filter_suite_by_condition(
1894
self.suite, tests.condition_id_re('test_condition_id_re'))
1895
self.assertEqual([test_name], _test_ids(filtered_suite))
1897
def test_condition_id_in_list(self):
1898
test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
1899
'test_condition_id_in_list']
1900
id_list = tests.TestIdList(test_names)
1901
filtered_suite = tests.filter_suite_by_condition(
1902
self.suite, tests.condition_id_in_list(id_list))
1903
my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
1904
re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
1905
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
1907
def test_condition_id_startswith(self):
1908
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
1909
start1 = klass + 'test_condition_id_starts'
1910
start2 = klass + 'test_condition_id_in'
1911
test_names = [ klass + 'test_condition_id_in_list',
1912
klass + 'test_condition_id_startswith',
1914
filtered_suite = tests.filter_suite_by_condition(
1915
self.suite, tests.condition_id_startswith([start1, start2]))
1916
self.assertEqual(test_names, _test_ids(filtered_suite))
1918
def test_condition_isinstance(self):
1919
filtered_suite = tests.filter_suite_by_condition(
1920
self.suite, tests.condition_isinstance(self.__class__))
1921
class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
1922
re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
1923
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
1925
def test_exclude_tests_by_condition(self):
1926
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
1927
'test_exclude_tests_by_condition')
1928
filtered_suite = tests.exclude_tests_by_condition(self.suite,
1929
lambda x:x.id() == excluded_name)
1930
self.assertEqual(len(self.all_names) - 1,
1931
filtered_suite.countTestCases())
1932
self.assertFalse(excluded_name in _test_ids(filtered_suite))
1933
remaining_names = list(self.all_names)
1934
remaining_names.remove(excluded_name)
1935
self.assertEqual(remaining_names, _test_ids(filtered_suite))
1937
def test_exclude_tests_by_re(self):
1938
self.all_names = _test_ids(self.suite)
1939
filtered_suite = tests.exclude_tests_by_re(self.suite,
1940
'exclude_tests_by_re')
1941
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
1942
'test_exclude_tests_by_re')
1943
self.assertEqual(len(self.all_names) - 1,
1944
filtered_suite.countTestCases())
1945
self.assertFalse(excluded_name in _test_ids(filtered_suite))
1946
remaining_names = list(self.all_names)
1947
remaining_names.remove(excluded_name)
1948
self.assertEqual(remaining_names, _test_ids(filtered_suite))
1950
def test_filter_suite_by_condition(self):
1951
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
1952
'test_filter_suite_by_condition')
1953
filtered_suite = tests.filter_suite_by_condition(self.suite,
1954
lambda x:x.id() == test_name)
1955
self.assertEqual([test_name], _test_ids(filtered_suite))
1957
def test_filter_suite_by_re(self):
1958
filtered_suite = tests.filter_suite_by_re(self.suite,
1959
'test_filter_suite_by_r')
1960
filtered_names = _test_ids(filtered_suite)
1961
self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
1962
'TestSelftestFiltering.test_filter_suite_by_re'])
1964
def test_filter_suite_by_id_list(self):
1965
test_list = ['bzrlib.tests.test_selftest.'
1966
'TestSelftestFiltering.test_filter_suite_by_id_list']
1967
filtered_suite = tests.filter_suite_by_id_list(
1968
self.suite, tests.TestIdList(test_list))
1969
filtered_names = _test_ids(filtered_suite)
1972
['bzrlib.tests.test_selftest.'
1973
'TestSelftestFiltering.test_filter_suite_by_id_list'])
1975
def test_filter_suite_by_id_startswith(self):
1976
# By design this test may fail if another test is added whose name also
1977
# begins with one of the start value used.
1978
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
1979
start1 = klass + 'test_filter_suite_by_id_starts'
1980
start2 = klass + 'test_filter_suite_by_id_li'
1981
test_list = [klass + 'test_filter_suite_by_id_list',
1982
klass + 'test_filter_suite_by_id_startswith',
1984
filtered_suite = tests.filter_suite_by_id_startswith(
1985
self.suite, [start1, start2])
1988
_test_ids(filtered_suite),
1991
def test_preserve_input(self):
1992
# NB: Surely this is something in the stdlib to do this?
1993
self.assertTrue(self.suite is tests.preserve_input(self.suite))
1994
self.assertTrue("@#$" is tests.preserve_input("@#$"))
1996
def test_randomize_suite(self):
1997
randomized_suite = tests.randomize_suite(self.suite)
1998
# randomizing should not add or remove test names.
1999
self.assertEqual(set(_test_ids(self.suite)),
2000
set(_test_ids(randomized_suite)))
2001
# Technically, this *can* fail, because random.shuffle(list) can be
2002
# equal to list. Trying multiple times just pushes the frequency back.
2003
# As its len(self.all_names)!:1, the failure frequency should be low
2004
# enough to ignore. RBC 20071021.
2005
# It should change the order.
2006
self.assertNotEqual(self.all_names, _test_ids(randomized_suite))
2007
# But not the length. (Possibly redundant with the set test, but not
2009
self.assertEqual(len(self.all_names), len(_test_ids(randomized_suite)))
2011
def test_split_suit_by_condition(self):
2012
self.all_names = _test_ids(self.suite)
2013
condition = tests.condition_id_re('test_filter_suite_by_r')
2014
split_suite = tests.split_suite_by_condition(self.suite, condition)
2015
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2016
'test_filter_suite_by_re')
2017
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2018
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2019
remaining_names = list(self.all_names)
2020
remaining_names.remove(filtered_name)
2021
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2023
def test_split_suit_by_re(self):
2024
self.all_names = _test_ids(self.suite)
2025
split_suite = tests.split_suite_by_re(self.suite,
2026
'test_filter_suite_by_r')
2027
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2028
'test_filter_suite_by_re')
2029
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2030
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2031
remaining_names = list(self.all_names)
2032
remaining_names.remove(filtered_name)
2033
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2036
class TestCheckInventoryShape(tests.TestCaseWithTransport):
2038
def test_check_inventory_shape(self):
2039
files = ['a', 'b/', 'b/c']
2040
tree = self.make_branch_and_tree('.')
2041
self.build_tree(files)
2045
self.check_inventory_shape(tree.inventory, files)
2050
class TestBlackboxSupport(tests.TestCase):
2051
"""Tests for testsuite blackbox features."""
2053
def test_run_bzr_failure_not_caught(self):
2054
# When we run bzr in blackbox mode, we want any unexpected errors to
2055
# propagate up to the test suite so that it can show the error in the
2056
# usual way, and we won't get a double traceback.
2057
e = self.assertRaises(
2059
self.run_bzr, ['assert-fail'])
2060
# make sure we got the real thing, not an error from somewhere else in
2061
# the test framework
2062
self.assertEquals('always fails', str(e))
2063
# check that there's no traceback in the test log
2064
self.assertNotContainsRe(self._get_log(keep_log_file=True),
2067
def test_run_bzr_user_error_caught(self):
2068
# Running bzr in blackbox mode, normal/expected/user errors should be
2069
# caught in the regular way and turned into an error message plus exit
2071
out, err = self.run_bzr(["log", "/nonexistantpath"], retcode=3)
2072
self.assertEqual(out, '')
2073
self.assertContainsRe(err,
2074
'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
2077
class TestTestLoader(tests.TestCase):
2078
"""Tests for the test loader."""
2080
def _get_loader_and_module(self):
2081
"""Gets a TestLoader and a module with one test in it."""
2082
loader = TestUtil.TestLoader()
2084
class Stub(tests.TestCase):
2087
class MyModule(object):
2089
MyModule.a_class = Stub
2091
return loader, module
2093
def test_module_no_load_tests_attribute_loads_classes(self):
2094
loader, module = self._get_loader_and_module()
2095
self.assertEqual(1, loader.loadTestsFromModule(module).countTestCases())
2097
def test_module_load_tests_attribute_gets_called(self):
2098
loader, module = self._get_loader_and_module()
2099
# 'self' is here because we're faking the module with a class. Regular
2100
# load_tests do not need that :)
2101
def load_tests(self, standard_tests, module, loader):
2102
result = loader.suiteClass()
2103
for test in tests.iter_suite_tests(standard_tests):
2104
result.addTests([test, test])
2106
# add a load_tests() method which multiplies the tests from the module.
2107
module.__class__.load_tests = load_tests
2108
self.assertEqual(2, loader.loadTestsFromModule(module).countTestCases())
2110
def test_load_tests_from_module_name_smoke_test(self):
2111
loader = TestUtil.TestLoader()
2112
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2113
self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2116
def test_load_tests_from_module_name_with_bogus_module_name(self):
2117
loader = TestUtil.TestLoader()
2118
self.assertRaises(ImportError, loader.loadTestsFromModuleName, 'bogus')
2121
class TestTestIdList(tests.TestCase):
2123
def _create_id_list(self, test_list):
2124
return tests.TestIdList(test_list)
2126
def _create_suite(self, test_id_list):
2128
class Stub(tests.TestCase):
2132
def _create_test_id(id):
2135
suite = TestUtil.TestSuite()
2136
for id in test_id_list:
2137
t = Stub('test_foo')
2138
t.id = _create_test_id(id)
2142
def _test_ids(self, test_suite):
2143
"""Get the ids for the tests in a test suite."""
2144
return [t.id() for t in tests.iter_suite_tests(test_suite)]
2146
def test_empty_list(self):
2147
id_list = self._create_id_list([])
2148
self.assertEquals({}, id_list.tests)
2149
self.assertEquals({}, id_list.modules)
2151
def test_valid_list(self):
2152
id_list = self._create_id_list(
2153
['mod1.cl1.meth1', 'mod1.cl1.meth2',
2154
'mod1.func1', 'mod1.cl2.meth2',
2156
'mod1.submod2.cl1.meth1', 'mod1.submod2.cl2.meth2',
2158
self.assertTrue(id_list.refers_to('mod1'))
2159
self.assertTrue(id_list.refers_to('mod1.submod1'))
2160
self.assertTrue(id_list.refers_to('mod1.submod2'))
2161
self.assertTrue(id_list.includes('mod1.cl1.meth1'))
2162
self.assertTrue(id_list.includes('mod1.submod1'))
2163
self.assertTrue(id_list.includes('mod1.func1'))
2165
def test_bad_chars_in_params(self):
2166
id_list = self._create_id_list(['mod1.cl1.meth1(xx.yy)'])
2167
self.assertTrue(id_list.refers_to('mod1'))
2168
self.assertTrue(id_list.includes('mod1.cl1.meth1(xx.yy)'))
2170
def test_module_used(self):
2171
id_list = self._create_id_list(['mod.class.meth'])
2172
self.assertTrue(id_list.refers_to('mod'))
2173
self.assertTrue(id_list.refers_to('mod.class'))
2174
self.assertTrue(id_list.refers_to('mod.class.meth'))
2176
def test_test_suite_matches_id_list_with_unknown(self):
2177
loader = TestUtil.TestLoader()
2178
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2179
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',
2181
not_found, duplicates = tests.suite_matches_id_list(suite, test_list)
2182
self.assertEquals(['bogus'], not_found)
2183
self.assertEquals([], duplicates)
2185
def test_suite_matches_id_list_with_duplicates(self):
2186
loader = TestUtil.TestLoader()
2187
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2188
dupes = loader.suiteClass()
2189
for test in tests.iter_suite_tests(suite):
2191
dupes.addTest(test) # Add it again
2193
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',]
2194
not_found, duplicates = tests.suite_matches_id_list(
2196
self.assertEquals([], not_found)
2197
self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2201
class TestTestSuite(tests.TestCase):
2203
def test_test_suite(self):
2204
# This test is slow, so we do a single test with one test in each
2208
'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
2209
('bzrlib.tests.per_transport.TransportTests'
2210
'.test_abspath(LocalURLServer)'),
2211
'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
2212
# modules_to_doctest
2213
'bzrlib.timestamp.format_highres_date',
2214
# plugins can't be tested that way since selftest may be run with
2217
suite = tests.test_suite(test_list)
2218
self.assertEquals(test_list, _test_ids(suite))
2220
def test_test_suite_list_and_start(self):
2221
test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
2222
suite = tests.test_suite(test_list,
2223
['bzrlib.tests.test_selftest.TestTestSuite'])
2224
# test_test_suite_list_and_start is not included
2225
self.assertEquals(test_list, _test_ids(suite))
2228
class TestLoadTestIdList(tests.TestCaseInTempDir):
2230
def _create_test_list_file(self, file_name, content):
2231
fl = open(file_name, 'wt')
2235
def test_load_unknown(self):
2236
self.assertRaises(errors.NoSuchFile,
2237
tests.load_test_id_list, 'i_do_not_exist')
2239
def test_load_test_list(self):
2240
test_list_fname = 'test.list'
2241
self._create_test_list_file(test_list_fname,
2242
'mod1.cl1.meth1\nmod2.cl2.meth2\n')
2243
tlist = tests.load_test_id_list(test_list_fname)
2244
self.assertEquals(2, len(tlist))
2245
self.assertEquals('mod1.cl1.meth1', tlist[0])
2246
self.assertEquals('mod2.cl2.meth2', tlist[1])
2248
def test_load_dirty_file(self):
2249
test_list_fname = 'test.list'
2250
self._create_test_list_file(test_list_fname,
2251
' mod1.cl1.meth1\n\nmod2.cl2.meth2 \n'
2253
tlist = tests.load_test_id_list(test_list_fname)
2254
self.assertEquals(4, len(tlist))
2255
self.assertEquals('mod1.cl1.meth1', tlist[0])
2256
self.assertEquals('', tlist[1])
2257
self.assertEquals('mod2.cl2.meth2', tlist[2])
2258
self.assertEquals('bar baz', tlist[3])
2261
class TestFilteredByModuleTestLoader(tests.TestCase):
2263
def _create_loader(self, test_list):
2264
id_filter = tests.TestIdList(test_list)
2265
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2268
def test_load_tests(self):
2269
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2270
loader = self._create_loader(test_list)
2272
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2273
self.assertEquals(test_list, _test_ids(suite))
2275
def test_exclude_tests(self):
2276
test_list = ['bogus']
2277
loader = self._create_loader(test_list)
2279
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2280
self.assertEquals([], _test_ids(suite))
2283
class TestFilteredByNameStartTestLoader(tests.TestCase):
2285
def _create_loader(self, name_start):
2286
def needs_module(name):
2287
return name.startswith(name_start) or name_start.startswith(name)
2288
loader = TestUtil.FilteredByModuleTestLoader(needs_module)
2291
def test_load_tests(self):
2292
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2293
loader = self._create_loader('bzrlib.tests.test_samp')
2295
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2296
self.assertEquals(test_list, _test_ids(suite))
2298
def test_load_tests_inside_module(self):
2299
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2300
loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
2302
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2303
self.assertEquals(test_list, _test_ids(suite))
2305
def test_exclude_tests(self):
2306
test_list = ['bogus']
2307
loader = self._create_loader('bogus')
2309
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2310
self.assertEquals([], _test_ids(suite))
2313
class TestTestPrefixRegistry(tests.TestCase):
2315
def _get_registry(self):
2316
tp_registry = tests.TestPrefixAliasRegistry()
2319
def test_register_new_prefix(self):
2320
tpr = self._get_registry()
2321
tpr.register('foo', 'fff.ooo.ooo')
2322
self.assertEquals('fff.ooo.ooo', tpr.get('foo'))
2324
def test_register_existing_prefix(self):
2325
tpr = self._get_registry()
2326
tpr.register('bar', 'bbb.aaa.rrr')
2327
tpr.register('bar', 'bBB.aAA.rRR')
2328
self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
2329
self.assertContainsRe(self._get_log(keep_log_file=True),
2330
r'.*bar.*bbb.aaa.rrr.*bBB.aAA.rRR')
2332
def test_get_unknown_prefix(self):
2333
tpr = self._get_registry()
2334
self.assertRaises(KeyError, tpr.get, 'I am not a prefix')
2336
def test_resolve_prefix(self):
2337
tpr = self._get_registry()
2338
tpr.register('bar', 'bb.aa.rr')
2339
self.assertEquals('bb.aa.rr', tpr.resolve_alias('bar'))
2341
def test_resolve_unknown_alias(self):
2342
tpr = self._get_registry()
2343
self.assertRaises(errors.BzrCommandError,
2344
tpr.resolve_alias, 'I am not a prefix')
2346
def test_predefined_prefixes(self):
2347
tpr = tests.test_prefix_alias_registry
2348
self.assertEquals('bzrlib', tpr.resolve_alias('bzrlib'))
2349
self.assertEquals('bzrlib.doc', tpr.resolve_alias('bd'))
2350
self.assertEquals('bzrlib.utils', tpr.resolve_alias('bu'))
2351
self.assertEquals('bzrlib.tests', tpr.resolve_alias('bt'))
2352
self.assertEquals('bzrlib.tests.blackbox', tpr.resolve_alias('bb'))
2353
self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
2356
class TestRunSuite(tests.TestCase):
2358
def test_runner_class(self):
2359
"""run_suite accepts and uses a runner_class keyword argument."""
2360
class Stub(tests.TestCase):
2363
suite = Stub("test_foo")
2365
class MyRunner(tests.TextTestRunner):
2366
def run(self, test):
2368
return tests.ExtendedTestResult(self.stream, self.descriptions,
2370
tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
2371
self.assertEqual(calls, [suite])
2373
def test_done(self):
2374
"""run_suite should call result.done()"""
2376
def one_more_call(): self.calls += 1
2377
def test_function():
2379
test = unittest.FunctionTestCase(test_function)
2380
class InstrumentedTestResult(tests.ExtendedTestResult):
2381
def done(self): one_more_call()
2382
class MyRunner(tests.TextTestRunner):
2383
def run(self, test):
2384
return InstrumentedTestResult(self.stream, self.descriptions,
2386
tests.run_suite(test, runner_class=MyRunner, stream=StringIO())
2387
self.assertEquals(1, self.calls)