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
44
from bzrlib.repofmt import (
49
from bzrlib.symbol_versioning import (
54
from bzrlib.tests import (
60
from bzrlib.trace import note
61
from bzrlib.transport.memory import MemoryServer, MemoryTransport
62
from bzrlib.version import _get_bzr_source_tree
65
def _test_ids(test_suite):
66
"""Get the ids for the tests in a test suite."""
67
return [t.id() for t in tests.iter_suite_tests(test_suite)]
70
class SelftestTests(tests.TestCase):
72
def test_import_tests(self):
73
mod = TestUtil._load_module_by_name('bzrlib.tests.test_selftest')
74
self.assertEqual(mod.SelftestTests, SelftestTests)
76
def test_import_test_failure(self):
77
self.assertRaises(ImportError,
78
TestUtil._load_module_by_name,
81
class MetaTestLog(tests.TestCase):
83
def test_logging(self):
84
"""Test logs are captured when a test fails."""
85
self.log('a test message')
86
self._log_file.flush()
87
self.assertContainsRe(self._get_log(keep_log_file=True),
91
class TestUnicodeFilename(tests.TestCase):
93
def test_probe_passes(self):
94
"""UnicodeFilename._probe passes."""
95
# We can't test much more than that because the behaviour depends
97
tests.UnicodeFilename._probe()
100
class TestTreeShape(tests.TestCaseInTempDir):
102
def test_unicode_paths(self):
103
self.requireFeature(tests.UnicodeFilename)
105
filename = u'hell\u00d8'
106
self.build_tree_contents([(filename, 'contents of hello')])
107
self.failUnlessExists(filename)
110
class TestTransportScenarios(tests.TestCase):
111
"""A group of tests that test the transport implementation adaption core.
113
This is a meta test that the tests are applied to all available
116
This will be generalised in the future which is why it is in this
117
test file even though it is specific to transport tests at the moment.
120
def test_get_transport_permutations(self):
121
# this checks that get_test_permutations defined by the module is
122
# called by the get_transport_test_permutations function.
123
class MockModule(object):
124
def get_test_permutations(self):
125
return sample_permutation
126
sample_permutation = [(1,2), (3,4)]
127
from bzrlib.tests.per_transport import get_transport_test_permutations
128
self.assertEqual(sample_permutation,
129
get_transport_test_permutations(MockModule()))
131
def test_scenarios_include_all_modules(self):
132
# this checks that the scenario generator returns as many permutations
133
# as there are in all the registered transport modules - we assume if
134
# this matches its probably doing the right thing especially in
135
# combination with the tests for setting the right classes below.
136
from bzrlib.tests.per_transport import transport_test_permutations
137
from bzrlib.transport import _get_transport_modules
138
modules = _get_transport_modules()
139
permutation_count = 0
140
for module in modules:
142
permutation_count += len(reduce(getattr,
143
(module + ".get_test_permutations").split('.')[1:],
144
__import__(module))())
145
except errors.DependencyNotPresent:
147
scenarios = transport_test_permutations()
148
self.assertEqual(permutation_count, len(scenarios))
150
def test_scenarios_include_transport_class(self):
151
# This test used to know about all the possible transports and the
152
# order they were returned but that seems overly brittle (mbp
154
from bzrlib.tests.per_transport import transport_test_permutations
155
scenarios = transport_test_permutations()
156
# there are at least that many builtin transports
157
self.assertTrue(len(scenarios) > 6)
158
one_scenario = scenarios[0]
159
self.assertIsInstance(one_scenario[0], str)
160
self.assertTrue(issubclass(one_scenario[1]["transport_class"],
161
bzrlib.transport.Transport))
162
self.assertTrue(issubclass(one_scenario[1]["transport_server"],
163
bzrlib.transport.Server))
166
class TestBranchScenarios(tests.TestCase):
168
def test_scenarios(self):
169
# check that constructor parameters are passed through to the adapted
171
from bzrlib.tests.per_branch import make_scenarios
174
formats = [("c", "C"), ("d", "D")]
175
scenarios = make_scenarios(server1, server2, formats)
176
self.assertEqual(2, len(scenarios))
179
{'branch_format': 'c',
180
'bzrdir_format': 'C',
181
'transport_readonly_server': 'b',
182
'transport_server': 'a'}),
184
{'branch_format': 'd',
185
'bzrdir_format': 'D',
186
'transport_readonly_server': 'b',
187
'transport_server': 'a'})],
191
class TestBzrDirScenarios(tests.TestCase):
193
def test_scenarios(self):
194
# check that constructor parameters are passed through to the adapted
196
from bzrlib.tests.per_bzrdir import make_scenarios
201
scenarios = make_scenarios(vfs_factory, server1, server2, formats)
204
{'bzrdir_format': 'c',
205
'transport_readonly_server': 'b',
206
'transport_server': 'a',
207
'vfs_transport_factory': 'v'}),
209
{'bzrdir_format': 'd',
210
'transport_readonly_server': 'b',
211
'transport_server': 'a',
212
'vfs_transport_factory': 'v'})],
216
class TestRepositoryScenarios(tests.TestCase):
218
def test_formats_to_scenarios(self):
219
from bzrlib.tests.per_repository import formats_to_scenarios
220
formats = [("(c)", remote.RemoteRepositoryFormat()),
221
("(d)", repository.format_registry.get(
222
'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
223
no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
225
vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
226
vfs_transport_factory="vfs")
227
# no_vfs generate scenarios without vfs_transport_factory
229
('RemoteRepositoryFormat(c)',
230
{'bzrdir_format': remote.RemoteBzrDirFormat(),
231
'repository_format': remote.RemoteRepositoryFormat(),
232
'transport_readonly_server': 'readonly',
233
'transport_server': 'server'}),
234
('RepositoryFormat2a(d)',
235
{'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
236
'repository_format': groupcompress_repo.RepositoryFormat2a(),
237
'transport_readonly_server': 'readonly',
238
'transport_server': 'server'})]
239
self.assertEqual(expected, no_vfs_scenarios)
241
('RemoteRepositoryFormat(c)',
242
{'bzrdir_format': remote.RemoteBzrDirFormat(),
243
'repository_format': remote.RemoteRepositoryFormat(),
244
'transport_readonly_server': 'readonly',
245
'transport_server': 'server',
246
'vfs_transport_factory': 'vfs'}),
247
('RepositoryFormat2a(d)',
248
{'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
249
'repository_format': groupcompress_repo.RepositoryFormat2a(),
250
'transport_readonly_server': 'readonly',
251
'transport_server': 'server',
252
'vfs_transport_factory': 'vfs'})],
256
class TestTestScenarioApplication(tests.TestCase):
257
"""Tests for the test adaption facilities."""
259
def test_apply_scenario(self):
260
from bzrlib.tests import apply_scenario
261
input_test = TestTestScenarioApplication("test_apply_scenario")
262
# setup two adapted tests
263
adapted_test1 = apply_scenario(input_test,
265
{"bzrdir_format":"bzr_format",
266
"repository_format":"repo_fmt",
267
"transport_server":"transport_server",
268
"transport_readonly_server":"readonly-server"}))
269
adapted_test2 = apply_scenario(input_test,
270
("new id 2", {"bzrdir_format":None}))
271
# input_test should have been altered.
272
self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
273
# the new tests are mutually incompatible, ensuring it has
274
# made new ones, and unspecified elements in the scenario
275
# should not have been altered.
276
self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
277
self.assertEqual("repo_fmt", adapted_test1.repository_format)
278
self.assertEqual("transport_server", adapted_test1.transport_server)
279
self.assertEqual("readonly-server",
280
adapted_test1.transport_readonly_server)
282
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
283
"test_apply_scenario(new id)",
285
self.assertEqual(None, adapted_test2.bzrdir_format)
287
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
288
"test_apply_scenario(new id 2)",
292
class TestInterRepositoryScenarios(tests.TestCase):
294
def test_scenarios(self):
295
# check that constructor parameters are passed through to the adapted
297
from bzrlib.tests.per_interrepository import make_scenarios
300
formats = [("C0", "C1", "C2"), ("D0", "D1", "D2")]
301
scenarios = make_scenarios(server1, server2, formats)
304
{'repository_format': 'C1',
305
'repository_format_to': 'C2',
306
'transport_readonly_server': 'b',
307
'transport_server': 'a'}),
309
{'repository_format': 'D1',
310
'repository_format_to': 'D2',
311
'transport_readonly_server': 'b',
312
'transport_server': 'a'})],
316
class TestWorkingTreeScenarios(tests.TestCase):
318
def test_scenarios(self):
319
# check that constructor parameters are passed through to the adapted
321
from bzrlib.tests.per_workingtree import make_scenarios
324
formats = [workingtree.WorkingTreeFormat2(),
325
workingtree.WorkingTreeFormat3(),]
326
scenarios = make_scenarios(server1, server2, formats)
328
('WorkingTreeFormat2',
329
{'bzrdir_format': formats[0]._matchingbzrdir,
330
'transport_readonly_server': 'b',
331
'transport_server': 'a',
332
'workingtree_format': formats[0]}),
333
('WorkingTreeFormat3',
334
{'bzrdir_format': formats[1]._matchingbzrdir,
335
'transport_readonly_server': 'b',
336
'transport_server': 'a',
337
'workingtree_format': formats[1]})],
341
class TestTreeScenarios(tests.TestCase):
343
def test_scenarios(self):
344
# the tree implementation scenario generator is meant to setup one
345
# instance for each working tree format, and one additional instance
346
# that will use the default wt format, but create a revision tree for
347
# the tests. this means that the wt ones should have the
348
# workingtree_to_test_tree attribute set to 'return_parameter' and the
349
# revision one set to revision_tree_from_workingtree.
351
from bzrlib.tests.per_tree import (
352
_dirstate_tree_from_workingtree,
357
revision_tree_from_workingtree
361
formats = [workingtree.WorkingTreeFormat2(),
362
workingtree.WorkingTreeFormat3(),]
363
scenarios = make_scenarios(server1, server2, formats)
364
self.assertEqual(7, len(scenarios))
365
default_wt_format = workingtree.WorkingTreeFormat4._default_format
366
wt4_format = workingtree.WorkingTreeFormat4()
367
wt5_format = workingtree.WorkingTreeFormat5()
368
expected_scenarios = [
369
('WorkingTreeFormat2',
370
{'bzrdir_format': formats[0]._matchingbzrdir,
371
'transport_readonly_server': 'b',
372
'transport_server': 'a',
373
'workingtree_format': formats[0],
374
'_workingtree_to_test_tree': return_parameter,
376
('WorkingTreeFormat3',
377
{'bzrdir_format': formats[1]._matchingbzrdir,
378
'transport_readonly_server': 'b',
379
'transport_server': 'a',
380
'workingtree_format': formats[1],
381
'_workingtree_to_test_tree': return_parameter,
384
{'_workingtree_to_test_tree': revision_tree_from_workingtree,
385
'bzrdir_format': default_wt_format._matchingbzrdir,
386
'transport_readonly_server': 'b',
387
'transport_server': 'a',
388
'workingtree_format': default_wt_format,
390
('DirStateRevisionTree,WT4',
391
{'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
392
'bzrdir_format': wt4_format._matchingbzrdir,
393
'transport_readonly_server': 'b',
394
'transport_server': 'a',
395
'workingtree_format': wt4_format,
397
('DirStateRevisionTree,WT5',
398
{'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
399
'bzrdir_format': wt5_format._matchingbzrdir,
400
'transport_readonly_server': 'b',
401
'transport_server': 'a',
402
'workingtree_format': wt5_format,
405
{'_workingtree_to_test_tree': preview_tree_pre,
406
'bzrdir_format': default_wt_format._matchingbzrdir,
407
'transport_readonly_server': 'b',
408
'transport_server': 'a',
409
'workingtree_format': default_wt_format}),
411
{'_workingtree_to_test_tree': preview_tree_post,
412
'bzrdir_format': default_wt_format._matchingbzrdir,
413
'transport_readonly_server': 'b',
414
'transport_server': 'a',
415
'workingtree_format': default_wt_format}),
417
self.assertEqual(expected_scenarios, scenarios)
420
class TestInterTreeScenarios(tests.TestCase):
421
"""A group of tests that test the InterTreeTestAdapter."""
423
def test_scenarios(self):
424
# check that constructor parameters are passed through to the adapted
426
# for InterTree tests we want the machinery to bring up two trees in
427
# each instance: the base one, and the one we are interacting with.
428
# because each optimiser can be direction specific, we need to test
429
# each optimiser in its chosen direction.
430
# unlike the TestProviderAdapter we dont want to automatically add a
431
# parameterized one for WorkingTree - the optimisers will tell us what
433
from bzrlib.tests.per_tree import (
435
revision_tree_from_workingtree
437
from bzrlib.tests.per_intertree import (
440
from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
441
input_test = TestInterTreeScenarios(
445
format1 = WorkingTreeFormat2()
446
format2 = WorkingTreeFormat3()
447
formats = [("1", str, format1, format2, "converter1"),
448
("2", int, format2, format1, "converter2")]
449
scenarios = make_scenarios(server1, server2, formats)
450
self.assertEqual(2, len(scenarios))
451
expected_scenarios = [
453
"bzrdir_format": format1._matchingbzrdir,
454
"intertree_class": formats[0][1],
455
"workingtree_format": formats[0][2],
456
"workingtree_format_to": formats[0][3],
457
"mutable_trees_to_test_trees": formats[0][4],
458
"_workingtree_to_test_tree": return_parameter,
459
"transport_server": server1,
460
"transport_readonly_server": server2,
463
"bzrdir_format": format2._matchingbzrdir,
464
"intertree_class": formats[1][1],
465
"workingtree_format": formats[1][2],
466
"workingtree_format_to": formats[1][3],
467
"mutable_trees_to_test_trees": formats[1][4],
468
"_workingtree_to_test_tree": return_parameter,
469
"transport_server": server1,
470
"transport_readonly_server": server2,
473
self.assertEqual(scenarios, expected_scenarios)
476
class TestTestCaseInTempDir(tests.TestCaseInTempDir):
478
def test_home_is_not_working(self):
479
self.assertNotEqual(self.test_dir, self.test_home_dir)
480
cwd = osutils.getcwd()
481
self.assertIsSameRealPath(self.test_dir, cwd)
482
self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
484
def test_assertEqualStat_equal(self):
485
from bzrlib.tests.test_dirstate import _FakeStat
486
self.build_tree(["foo"])
487
real = os.lstat("foo")
488
fake = _FakeStat(real.st_size, real.st_mtime, real.st_ctime,
489
real.st_dev, real.st_ino, real.st_mode)
490
self.assertEqualStat(real, fake)
492
def test_assertEqualStat_notequal(self):
493
self.build_tree(["foo", "longname"])
494
self.assertRaises(AssertionError, self.assertEqualStat,
495
os.lstat("foo"), os.lstat("longname"))
498
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
500
def test_home_is_non_existant_dir_under_root(self):
501
"""The test_home_dir for TestCaseWithMemoryTransport is missing.
503
This is because TestCaseWithMemoryTransport is for tests that do not
504
need any disk resources: they should be hooked into bzrlib in such a
505
way that no global settings are being changed by the test (only a
506
few tests should need to do that), and having a missing dir as home is
507
an effective way to ensure that this is the case.
509
self.assertIsSameRealPath(
510
self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
512
self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
514
def test_cwd_is_TEST_ROOT(self):
515
self.assertIsSameRealPath(self.test_dir, self.TEST_ROOT)
516
cwd = osutils.getcwd()
517
self.assertIsSameRealPath(self.test_dir, cwd)
519
def test_BZR_HOME_and_HOME_are_bytestrings(self):
520
"""The $BZR_HOME and $HOME environment variables should not be unicode.
522
See https://bugs.launchpad.net/bzr/+bug/464174
524
self.assertIsInstance(os.environ['BZR_HOME'], str)
525
self.assertIsInstance(os.environ['HOME'], str)
527
def test_make_branch_and_memory_tree(self):
528
"""In TestCaseWithMemoryTransport we should not make the branch on disk.
530
This is hard to comprehensively robustly test, so we settle for making
531
a branch and checking no directory was created at its relpath.
533
tree = self.make_branch_and_memory_tree('dir')
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)
539
def test_make_branch_and_memory_tree_with_format(self):
540
"""make_branch_and_memory_tree should accept a format option."""
541
format = bzrdir.BzrDirMetaFormat1()
542
format.repository_format = weaverepo.RepositoryFormat7()
543
tree = self.make_branch_and_memory_tree('dir', format=format)
544
# Guard against regression into MemoryTransport leaking
545
# files to disk instead of keeping them in memory.
546
self.failIf(osutils.lexists('dir'))
547
self.assertIsInstance(tree, memorytree.MemoryTree)
548
self.assertEqual(format.repository_format.__class__,
549
tree.branch.repository._format.__class__)
551
def test_make_branch_builder(self):
552
builder = self.make_branch_builder('dir')
553
self.assertIsInstance(builder, branchbuilder.BranchBuilder)
554
# Guard against regression into MemoryTransport leaking
555
# files to disk instead of keeping them in memory.
556
self.failIf(osutils.lexists('dir'))
558
def test_make_branch_builder_with_format(self):
559
# Use a repo layout that doesn't conform to a 'named' layout, to ensure
560
# that the format objects are used.
561
format = bzrdir.BzrDirMetaFormat1()
562
repo_format = weaverepo.RepositoryFormat7()
563
format.repository_format = repo_format
564
builder = self.make_branch_builder('dir', format=format)
565
the_branch = builder.get_branch()
566
# Guard against regression into MemoryTransport leaking
567
# files to disk instead of keeping them in memory.
568
self.failIf(osutils.lexists('dir'))
569
self.assertEqual(format.repository_format.__class__,
570
the_branch.repository._format.__class__)
571
self.assertEqual(repo_format.get_format_string(),
572
self.get_transport().get_bytes(
573
'dir/.bzr/repository/format'))
575
def test_make_branch_builder_with_format_name(self):
576
builder = self.make_branch_builder('dir', format='knit')
577
the_branch = builder.get_branch()
578
# Guard against regression into MemoryTransport leaking
579
# files to disk instead of keeping them in memory.
580
self.failIf(osutils.lexists('dir'))
581
dir_format = bzrdir.format_registry.make_bzrdir('knit')
582
self.assertEqual(dir_format.repository_format.__class__,
583
the_branch.repository._format.__class__)
584
self.assertEqual('Bazaar-NG Knit Repository Format 1',
585
self.get_transport().get_bytes(
586
'dir/.bzr/repository/format'))
588
def test_dangling_locks_cause_failures(self):
589
class TestDanglingLock(tests.TestCaseWithMemoryTransport):
590
def test_function(self):
591
t = self.get_transport('.')
592
l = lockdir.LockDir(t, 'lock')
595
test = TestDanglingLock('test_function')
597
if self._lock_check_thorough:
598
self.assertEqual(1, len(result.errors))
600
# When _lock_check_thorough is disabled, then we don't trigger a
602
self.assertEqual(0, len(result.errors))
605
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
606
"""Tests for the convenience functions TestCaseWithTransport introduces."""
608
def test_get_readonly_url_none(self):
609
from bzrlib.transport import get_transport
610
from bzrlib.transport.memory import MemoryServer
611
from bzrlib.transport.readonly import ReadonlyTransportDecorator
612
self.vfs_transport_factory = MemoryServer
613
self.transport_readonly_server = None
614
# calling get_readonly_transport() constructs a decorator on the url
616
url = self.get_readonly_url()
617
url2 = self.get_readonly_url('foo/bar')
618
t = get_transport(url)
619
t2 = get_transport(url2)
620
self.failUnless(isinstance(t, ReadonlyTransportDecorator))
621
self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
622
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
624
def test_get_readonly_url_http(self):
625
from bzrlib.tests.http_server import HttpServer
626
from bzrlib.transport import get_transport
627
from bzrlib.transport.local import LocalURLServer
628
from bzrlib.transport.http import HttpTransportBase
629
self.transport_server = LocalURLServer
630
self.transport_readonly_server = HttpServer
631
# calling get_readonly_transport() gives us a HTTP server instance.
632
url = self.get_readonly_url()
633
url2 = self.get_readonly_url('foo/bar')
634
# the transport returned may be any HttpTransportBase subclass
635
t = get_transport(url)
636
t2 = get_transport(url2)
637
self.failUnless(isinstance(t, HttpTransportBase))
638
self.failUnless(isinstance(t2, HttpTransportBase))
639
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
641
def test_is_directory(self):
642
"""Test assertIsDirectory assertion"""
643
t = self.get_transport()
644
self.build_tree(['a_dir/', 'a_file'], transport=t)
645
self.assertIsDirectory('a_dir', t)
646
self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
647
self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
649
def test_make_branch_builder(self):
650
builder = self.make_branch_builder('dir')
651
rev_id = builder.build_commit()
652
self.failUnlessExists('dir')
653
a_dir = bzrdir.BzrDir.open('dir')
654
self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
655
a_branch = a_dir.open_branch()
656
builder_branch = builder.get_branch()
657
self.assertEqual(a_branch.base, builder_branch.base)
658
self.assertEqual((1, rev_id), builder_branch.last_revision_info())
659
self.assertEqual((1, rev_id), a_branch.last_revision_info())
662
class TestTestCaseTransports(tests.TestCaseWithTransport):
665
super(TestTestCaseTransports, self).setUp()
666
self.vfs_transport_factory = MemoryServer
668
def test_make_bzrdir_preserves_transport(self):
669
t = self.get_transport()
670
result_bzrdir = self.make_bzrdir('subdir')
671
self.assertIsInstance(result_bzrdir.transport,
673
# should not be on disk, should only be in memory
674
self.failIfExists('subdir')
677
class TestChrootedTest(tests.ChrootedTestCase):
679
def test_root_is_root(self):
680
from bzrlib.transport import get_transport
681
t = get_transport(self.get_readonly_url())
683
self.assertEqual(url, t.clone('..').base)
686
class TestProfileResult(tests.TestCase):
688
def test_profiles_tests(self):
689
self.requireFeature(test_lsprof.LSProfFeature)
690
terminal = unittest.TestResult()
691
result = tests.ProfileResult(terminal)
692
class Sample(tests.TestCase):
694
self.sample_function()
695
def sample_function(self):
698
test.attrs_to_keep = test.attrs_to_keep + ('_benchcalls',)
700
self.assertLength(1, test._benchcalls)
701
# We must be able to unpack it as the test reporting code wants
702
(_, _, _), stats = test._benchcalls[0]
703
self.assertTrue(callable(stats.pprint))
706
class TestTestResult(tests.TestCase):
708
def check_timing(self, test_case, expected_re):
709
result = bzrlib.tests.TextTestResult(self._log_file,
713
test_case.run(result)
714
timed_string = result._testTimeString(test_case)
715
self.assertContainsRe(timed_string, expected_re)
717
def test_test_reporting(self):
718
class ShortDelayTestCase(tests.TestCase):
719
def test_short_delay(self):
721
def test_short_benchmark(self):
722
self.time(time.sleep, 0.003)
723
self.check_timing(ShortDelayTestCase('test_short_delay'),
725
# if a benchmark time is given, we now show just that time followed by
727
self.check_timing(ShortDelayTestCase('test_short_benchmark'),
730
def test_unittest_reporting_unittest_class(self):
731
# getting the time from a non-bzrlib test works ok
732
class ShortDelayTestCase(unittest.TestCase):
733
def test_short_delay(self):
735
self.check_timing(ShortDelayTestCase('test_short_delay'),
738
def _patch_get_bzr_source_tree(self):
739
# Reading from the actual source tree breaks isolation, but we don't
740
# want to assume that thats *all* that would happen.
741
def _get_bzr_source_tree():
743
orig_get_bzr_source_tree = bzrlib.version._get_bzr_source_tree
744
bzrlib.version._get_bzr_source_tree = _get_bzr_source_tree
746
bzrlib.version._get_bzr_source_tree = orig_get_bzr_source_tree
747
self.addCleanup(restore)
749
def test_assigned_benchmark_file_stores_date(self):
750
self._patch_get_bzr_source_tree()
752
result = bzrlib.tests.TextTestResult(self._log_file,
757
output_string = output.getvalue()
758
# if you are wondering about the regexp please read the comment in
759
# test_bench_history (bzrlib.tests.test_selftest.TestRunner)
760
# XXX: what comment? -- Andrew Bennetts
761
self.assertContainsRe(output_string, "--date [0-9.]+")
763
def test_benchhistory_records_test_times(self):
764
self._patch_get_bzr_source_tree()
765
result_stream = StringIO()
766
result = bzrlib.tests.TextTestResult(
770
bench_history=result_stream
773
# we want profile a call and check that its test duration is recorded
774
# make a new test instance that when run will generate a benchmark
775
example_test_case = TestTestResult("_time_hello_world_encoding")
776
# execute the test, which should succeed and record times
777
example_test_case.run(result)
778
lines = result_stream.getvalue().splitlines()
779
self.assertEqual(2, len(lines))
780
self.assertContainsRe(lines[1],
781
" *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
782
"._time_hello_world_encoding")
784
def _time_hello_world_encoding(self):
785
"""Profile two sleep calls
787
This is used to exercise the test framework.
789
self.time(unicode, 'hello', errors='replace')
790
self.time(unicode, 'world', errors='replace')
792
def test_lsprofiling(self):
793
"""Verbose test result prints lsprof statistics from test cases."""
794
self.requireFeature(test_lsprof.LSProfFeature)
795
result_stream = StringIO()
796
result = bzrlib.tests.VerboseTestResult(
797
unittest._WritelnDecorator(result_stream),
801
# we want profile a call of some sort and check it is output by
802
# addSuccess. We dont care about addError or addFailure as they
803
# are not that interesting for performance tuning.
804
# make a new test instance that when run will generate a profile
805
example_test_case = TestTestResult("_time_hello_world_encoding")
806
example_test_case._gather_lsprof_in_benchmarks = True
807
# execute the test, which should succeed and record profiles
808
example_test_case.run(result)
809
# lsprofile_something()
810
# if this worked we want
811
# LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
812
# CallCount Recursive Total(ms) Inline(ms) module:lineno(function)
813
# (the lsprof header)
814
# ... an arbitrary number of lines
815
# and the function call which is time.sleep.
816
# 1 0 ??? ??? ???(sleep)
817
# and then repeated but with 'world', rather than 'hello'.
818
# this should appear in the output stream of our test result.
819
output = result_stream.getvalue()
820
self.assertContainsRe(output,
821
r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
822
self.assertContainsRe(output,
823
r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
824
self.assertContainsRe(output,
825
r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
826
self.assertContainsRe(output,
827
r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
829
def test_known_failure(self):
830
"""A KnownFailure being raised should trigger several result actions."""
831
class InstrumentedTestResult(tests.ExtendedTestResult):
832
def stopTestRun(self): pass
833
def startTests(self): pass
834
def report_test_start(self, test): pass
835
def report_known_failure(self, test, err):
836
self._call = test, err
837
result = InstrumentedTestResult(None, None, None, None)
838
class Test(tests.TestCase):
839
def test_function(self):
840
raise tests.KnownFailure('failed!')
841
test = Test("test_function")
843
# it should invoke 'report_known_failure'.
844
self.assertEqual(2, len(result._call))
845
self.assertEqual(test, result._call[0])
846
self.assertEqual(tests.KnownFailure, result._call[1][0])
847
self.assertIsInstance(result._call[1][1], tests.KnownFailure)
848
# we dont introspec the traceback, if the rest is ok, it would be
849
# exceptional for it not to be.
850
# it should update the known_failure_count on the object.
851
self.assertEqual(1, result.known_failure_count)
852
# the result should be successful.
853
self.assertTrue(result.wasSuccessful())
855
def test_verbose_report_known_failure(self):
856
# verbose test output formatting
857
result_stream = StringIO()
858
result = bzrlib.tests.VerboseTestResult(
859
unittest._WritelnDecorator(result_stream),
863
test = self.get_passing_test()
864
result.startTest(test)
865
prefix = len(result_stream.getvalue())
866
# the err parameter has the shape:
867
# (class, exception object, traceback)
868
# KnownFailures dont get their tracebacks shown though, so we
870
err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
871
result.report_known_failure(test, err)
872
output = result_stream.getvalue()[prefix:]
873
lines = output.splitlines()
874
self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
875
self.assertEqual(lines[1], ' foo')
876
self.assertEqual(2, len(lines))
878
def get_passing_test(self):
879
"""Return a test object that can't be run usefully."""
882
return unittest.FunctionTestCase(passing_test)
884
def test_add_not_supported(self):
885
"""Test the behaviour of invoking addNotSupported."""
886
class InstrumentedTestResult(tests.ExtendedTestResult):
887
def stopTestRun(self): pass
888
def startTests(self): pass
889
def report_test_start(self, test): pass
890
def report_unsupported(self, test, feature):
891
self._call = test, feature
892
result = InstrumentedTestResult(None, None, None, None)
893
test = SampleTestCase('_test_pass')
894
feature = tests.Feature()
895
result.startTest(test)
896
result.addNotSupported(test, feature)
897
# it should invoke 'report_unsupported'.
898
self.assertEqual(2, len(result._call))
899
self.assertEqual(test, result._call[0])
900
self.assertEqual(feature, result._call[1])
901
# the result should be successful.
902
self.assertTrue(result.wasSuccessful())
903
# it should record the test against a count of tests not run due to
905
self.assertEqual(1, result.unsupported['Feature'])
906
# and invoking it again should increment that counter
907
result.addNotSupported(test, feature)
908
self.assertEqual(2, result.unsupported['Feature'])
910
def test_verbose_report_unsupported(self):
911
# verbose test output formatting
912
result_stream = StringIO()
913
result = bzrlib.tests.VerboseTestResult(
914
unittest._WritelnDecorator(result_stream),
918
test = self.get_passing_test()
919
feature = tests.Feature()
920
result.startTest(test)
921
prefix = len(result_stream.getvalue())
922
result.report_unsupported(test, feature)
923
output = result_stream.getvalue()[prefix:]
924
lines = output.splitlines()
925
self.assertEqual(lines, ['NODEP 0ms',
926
" The feature 'Feature' is not available."])
928
def test_unavailable_exception(self):
929
"""An UnavailableFeature being raised should invoke addNotSupported."""
930
class InstrumentedTestResult(tests.ExtendedTestResult):
931
def stopTestRun(self): pass
932
def startTests(self): pass
933
def report_test_start(self, test): pass
934
def addNotSupported(self, test, feature):
935
self._call = test, feature
936
result = InstrumentedTestResult(None, None, None, None)
937
feature = tests.Feature()
938
class Test(tests.TestCase):
939
def test_function(self):
940
raise tests.UnavailableFeature(feature)
941
test = Test("test_function")
943
# it should invoke 'addNotSupported'.
944
self.assertEqual(2, len(result._call))
945
self.assertEqual(test, result._call[0])
946
self.assertEqual(feature, result._call[1])
947
# and not count as an error
948
self.assertEqual(0, result.error_count)
950
def test_strict_with_unsupported_feature(self):
951
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
953
test = self.get_passing_test()
954
feature = "Unsupported Feature"
955
result.addNotSupported(test, feature)
956
self.assertFalse(result.wasStrictlySuccessful())
957
self.assertEqual(None, result._extractBenchmarkTime(test))
959
def test_strict_with_known_failure(self):
960
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
962
test = self.get_passing_test()
963
err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
964
result.addExpectedFailure(test, err)
965
self.assertFalse(result.wasStrictlySuccessful())
966
self.assertEqual(None, result._extractBenchmarkTime(test))
968
def test_strict_with_success(self):
969
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
971
test = self.get_passing_test()
972
result.addSuccess(test)
973
self.assertTrue(result.wasStrictlySuccessful())
974
self.assertEqual(None, result._extractBenchmarkTime(test))
976
def test_startTests(self):
977
"""Starting the first test should trigger startTests."""
978
class InstrumentedTestResult(tests.ExtendedTestResult):
980
def startTests(self): self.calls += 1
981
def report_test_start(self, test): pass
982
result = InstrumentedTestResult(None, None, None, None)
985
test = unittest.FunctionTestCase(test_function)
987
self.assertEquals(1, result.calls)
990
class TestUnicodeFilenameFeature(tests.TestCase):
992
def test_probe_passes(self):
993
"""UnicodeFilenameFeature._probe passes."""
994
# We can't test much more than that because the behaviour depends
996
tests.UnicodeFilenameFeature._probe()
999
class TestRunner(tests.TestCase):
1001
def dummy_test(self):
1004
def run_test_runner(self, testrunner, test):
1005
"""Run suite in testrunner, saving global state and restoring it.
1007
This current saves and restores:
1008
TestCaseInTempDir.TEST_ROOT
1010
There should be no tests in this file that use
1011
bzrlib.tests.TextTestRunner without using this convenience method,
1012
because of our use of global state.
1014
old_root = tests.TestCaseInTempDir.TEST_ROOT
1015
old_leak = tests.TestCase._first_thread_leaker_id
1017
tests.TestCaseInTempDir.TEST_ROOT = None
1018
tests.TestCase._first_thread_leaker_id = None
1019
return testrunner.run(test)
1021
tests.TestCaseInTempDir.TEST_ROOT = old_root
1022
tests.TestCase._first_thread_leaker_id = old_leak
1024
def test_known_failure_failed_run(self):
1025
# run a test that generates a known failure which should be printed in
1026
# the final output when real failures occur.
1027
class Test(tests.TestCase):
1028
def known_failure_test(self):
1029
raise tests.KnownFailure('failed')
1030
test = unittest.TestSuite()
1031
test.addTest(Test("known_failure_test"))
1033
raise AssertionError('foo')
1034
test.addTest(unittest.FunctionTestCase(failing_test))
1036
runner = tests.TextTestRunner(stream=stream)
1037
result = self.run_test_runner(runner, test)
1038
lines = stream.getvalue().splitlines()
1039
self.assertContainsRe(stream.getvalue(),
1042
'^======================================================================\n'
1043
'^FAIL: unittest.FunctionTestCase \\(failing_test\\)\n'
1044
'^----------------------------------------------------------------------\n'
1045
'Traceback \\(most recent call last\\):\n'
1046
' .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
1047
' raise AssertionError\\(\'foo\'\\)\n'
1049
'^----------------------------------------------------------------------\n'
1051
'FAILED \\(failures=1, known_failure_count=1\\)'
1054
def test_known_failure_ok_run(self):
1055
# run a test that generates a known failure which should be printed in
1057
class Test(tests.TestCase):
1058
def known_failure_test(self):
1059
raise tests.KnownFailure('failed')
1060
test = Test("known_failure_test")
1062
runner = tests.TextTestRunner(stream=stream)
1063
result = self.run_test_runner(runner, test)
1064
self.assertContainsRe(stream.getvalue(),
1067
'Ran 1 test in .*\n'
1069
'OK \\(known_failures=1\\)\n')
1071
def test_result_decorator(self):
1074
class LoggingDecorator(tests.ForwardingResult):
1075
def startTest(self, test):
1076
tests.ForwardingResult.startTest(self, test)
1077
calls.append('start')
1078
test = unittest.FunctionTestCase(lambda:None)
1080
runner = tests.TextTestRunner(stream=stream,
1081
result_decorators=[LoggingDecorator])
1082
result = self.run_test_runner(runner, test)
1083
self.assertLength(1, calls)
1085
def test_skipped_test(self):
1086
# run a test that is skipped, and check the suite as a whole still
1088
# skipping_test must be hidden in here so it's not run as a real test
1089
class SkippingTest(tests.TestCase):
1090
def skipping_test(self):
1091
raise tests.TestSkipped('test intentionally skipped')
1092
runner = tests.TextTestRunner(stream=self._log_file)
1093
test = SkippingTest("skipping_test")
1094
result = self.run_test_runner(runner, test)
1095
self.assertTrue(result.wasSuccessful())
1097
def test_skipped_from_setup(self):
1099
class SkippedSetupTest(tests.TestCase):
1102
calls.append('setUp')
1103
self.addCleanup(self.cleanup)
1104
raise tests.TestSkipped('skipped setup')
1106
def test_skip(self):
1107
self.fail('test reached')
1110
calls.append('cleanup')
1112
runner = tests.TextTestRunner(stream=self._log_file)
1113
test = SkippedSetupTest('test_skip')
1114
result = self.run_test_runner(runner, test)
1115
self.assertTrue(result.wasSuccessful())
1116
# Check if cleanup was called the right number of times.
1117
self.assertEqual(['setUp', 'cleanup'], calls)
1119
def test_skipped_from_test(self):
1121
class SkippedTest(tests.TestCase):
1124
tests.TestCase.setUp(self)
1125
calls.append('setUp')
1126
self.addCleanup(self.cleanup)
1128
def test_skip(self):
1129
raise tests.TestSkipped('skipped test')
1132
calls.append('cleanup')
1134
runner = tests.TextTestRunner(stream=self._log_file)
1135
test = SkippedTest('test_skip')
1136
result = self.run_test_runner(runner, test)
1137
self.assertTrue(result.wasSuccessful())
1138
# Check if cleanup was called the right number of times.
1139
self.assertEqual(['setUp', 'cleanup'], calls)
1141
def test_not_applicable(self):
1142
# run a test that is skipped because it's not applicable
1143
class Test(tests.TestCase):
1144
def not_applicable_test(self):
1145
raise tests.TestNotApplicable('this test never runs')
1147
runner = tests.TextTestRunner(stream=out, verbosity=2)
1148
test = Test("not_applicable_test")
1149
result = self.run_test_runner(runner, test)
1150
self._log_file.write(out.getvalue())
1151
self.assertTrue(result.wasSuccessful())
1152
self.assertTrue(result.wasStrictlySuccessful())
1153
self.assertContainsRe(out.getvalue(),
1154
r'(?m)not_applicable_test * N/A')
1155
self.assertContainsRe(out.getvalue(),
1156
r'(?m)^ this test never runs')
1158
def test_unsupported_features_listed(self):
1159
"""When unsupported features are encountered they are detailed."""
1160
class Feature1(tests.Feature):
1161
def _probe(self): return False
1162
class Feature2(tests.Feature):
1163
def _probe(self): return False
1164
# create sample tests
1165
test1 = SampleTestCase('_test_pass')
1166
test1._test_needs_features = [Feature1()]
1167
test2 = SampleTestCase('_test_pass')
1168
test2._test_needs_features = [Feature2()]
1169
test = unittest.TestSuite()
1173
runner = tests.TextTestRunner(stream=stream)
1174
result = self.run_test_runner(runner, test)
1175
lines = stream.getvalue().splitlines()
1178
"Missing feature 'Feature1' skipped 1 tests.",
1179
"Missing feature 'Feature2' skipped 1 tests.",
1183
def _patch_get_bzr_source_tree(self):
1184
# Reading from the actual source tree breaks isolation, but we don't
1185
# want to assume that thats *all* that would happen.
1186
self._get_source_tree_calls = []
1187
def _get_bzr_source_tree():
1188
self._get_source_tree_calls.append("called")
1190
orig_get_bzr_source_tree = bzrlib.version._get_bzr_source_tree
1191
bzrlib.version._get_bzr_source_tree = _get_bzr_source_tree
1193
bzrlib.version._get_bzr_source_tree = orig_get_bzr_source_tree
1194
self.addCleanup(restore)
1196
def test_bench_history(self):
1197
# tests that the running the benchmark passes bench_history into
1198
# the test result object. We can tell that happens if
1199
# _get_bzr_source_tree is called.
1200
self._patch_get_bzr_source_tree()
1201
test = TestRunner('dummy_test')
1203
runner = tests.TextTestRunner(stream=self._log_file,
1204
bench_history=output)
1205
result = self.run_test_runner(runner, test)
1206
output_string = output.getvalue()
1207
self.assertContainsRe(output_string, "--date [0-9.]+")
1208
self.assertLength(1, self._get_source_tree_calls)
1210
def assertLogDeleted(self, test):
1211
log = test._get_log()
1212
self.assertEqual("DELETED log file to reduce memory footprint", log)
1213
self.assertEqual('', test._log_contents)
1214
self.assertIs(None, test._log_file_name)
1216
def test_success_log_deleted(self):
1217
"""Successful tests have their log deleted"""
1219
class LogTester(tests.TestCase):
1221
def test_success(self):
1222
self.log('this will be removed\n')
1225
runner = tests.TextTestRunner(stream=sio)
1226
test = LogTester('test_success')
1227
result = self.run_test_runner(runner, test)
1229
self.assertLogDeleted(test)
1231
def test_skipped_log_deleted(self):
1232
"""Skipped tests have their log deleted"""
1234
class LogTester(tests.TestCase):
1236
def test_skipped(self):
1237
self.log('this will be removed\n')
1238
raise tests.TestSkipped()
1241
runner = tests.TextTestRunner(stream=sio)
1242
test = LogTester('test_skipped')
1243
result = self.run_test_runner(runner, test)
1245
self.assertLogDeleted(test)
1247
def test_not_aplicable_log_deleted(self):
1248
"""Not applicable tests have their log deleted"""
1250
class LogTester(tests.TestCase):
1252
def test_not_applicable(self):
1253
self.log('this will be removed\n')
1254
raise tests.TestNotApplicable()
1257
runner = tests.TextTestRunner(stream=sio)
1258
test = LogTester('test_not_applicable')
1259
result = self.run_test_runner(runner, test)
1261
self.assertLogDeleted(test)
1263
def test_known_failure_log_deleted(self):
1264
"""Know failure tests have their log deleted"""
1266
class LogTester(tests.TestCase):
1268
def test_known_failure(self):
1269
self.log('this will be removed\n')
1270
raise tests.KnownFailure()
1273
runner = tests.TextTestRunner(stream=sio)
1274
test = LogTester('test_known_failure')
1275
result = self.run_test_runner(runner, test)
1277
self.assertLogDeleted(test)
1279
def test_fail_log_kept(self):
1280
"""Failed tests have their log kept"""
1282
class LogTester(tests.TestCase):
1284
def test_fail(self):
1285
self.log('this will be kept\n')
1286
self.fail('this test fails')
1289
runner = tests.TextTestRunner(stream=sio)
1290
test = LogTester('test_fail')
1291
result = self.run_test_runner(runner, test)
1293
text = sio.getvalue()
1294
self.assertContainsRe(text, 'this will be kept')
1295
self.assertContainsRe(text, 'this test fails')
1297
log = test._get_log()
1298
self.assertContainsRe(log, 'this will be kept')
1299
self.assertEqual(log, test._log_contents)
1301
def test_error_log_kept(self):
1302
"""Tests with errors have their log kept"""
1304
class LogTester(tests.TestCase):
1306
def test_error(self):
1307
self.log('this will be kept\n')
1308
raise ValueError('random exception raised')
1311
runner = tests.TextTestRunner(stream=sio)
1312
test = LogTester('test_error')
1313
result = self.run_test_runner(runner, test)
1315
text = sio.getvalue()
1316
self.assertContainsRe(text, 'this will be kept')
1317
self.assertContainsRe(text, 'random exception raised')
1319
log = test._get_log()
1320
self.assertContainsRe(log, 'this will be kept')
1321
self.assertEqual(log, test._log_contents)
1323
def test_startTestRun(self):
1324
"""run should call result.startTestRun()"""
1326
class LoggingDecorator(tests.ForwardingResult):
1327
def startTestRun(self):
1328
tests.ForwardingResult.startTestRun(self)
1329
calls.append('startTestRun')
1330
test = unittest.FunctionTestCase(lambda:None)
1332
runner = tests.TextTestRunner(stream=stream,
1333
result_decorators=[LoggingDecorator])
1334
result = self.run_test_runner(runner, test)
1335
self.assertLength(1, calls)
1337
def test_stopTestRun(self):
1338
"""run should call result.stopTestRun()"""
1340
class LoggingDecorator(tests.ForwardingResult):
1341
def stopTestRun(self):
1342
tests.ForwardingResult.stopTestRun(self)
1343
calls.append('stopTestRun')
1344
test = unittest.FunctionTestCase(lambda:None)
1346
runner = tests.TextTestRunner(stream=stream,
1347
result_decorators=[LoggingDecorator])
1348
result = self.run_test_runner(runner, test)
1349
self.assertLength(1, calls)
1352
class SampleTestCase(tests.TestCase):
1354
def _test_pass(self):
1357
class _TestException(Exception):
1361
class TestTestCase(tests.TestCase):
1362
"""Tests that test the core bzrlib TestCase."""
1364
def test_assertLength_matches_empty(self):
1366
self.assertLength(0, a_list)
1368
def test_assertLength_matches_nonempty(self):
1370
self.assertLength(3, a_list)
1372
def test_assertLength_fails_different(self):
1374
self.assertRaises(AssertionError, self.assertLength, 1, a_list)
1376
def test_assertLength_shows_sequence_in_failure(self):
1378
exception = self.assertRaises(AssertionError, self.assertLength, 2,
1380
self.assertEqual('Incorrect length: wanted 2, got 3 for [1, 2, 3]',
1383
def test_base_setUp_not_called_causes_failure(self):
1384
class TestCaseWithBrokenSetUp(tests.TestCase):
1386
pass # does not call TestCase.setUp
1389
test = TestCaseWithBrokenSetUp('test_foo')
1390
result = unittest.TestResult()
1392
self.assertFalse(result.wasSuccessful())
1393
self.assertEqual(1, result.testsRun)
1395
def test_base_tearDown_not_called_causes_failure(self):
1396
class TestCaseWithBrokenTearDown(tests.TestCase):
1398
pass # does not call TestCase.tearDown
1401
test = TestCaseWithBrokenTearDown('test_foo')
1402
result = unittest.TestResult()
1404
self.assertFalse(result.wasSuccessful())
1405
self.assertEqual(1, result.testsRun)
1407
def test_debug_flags_sanitised(self):
1408
"""The bzrlib debug flags should be sanitised by setUp."""
1409
if 'allow_debug' in tests.selftest_debug_flags:
1410
raise tests.TestNotApplicable(
1411
'-Eallow_debug option prevents debug flag sanitisation')
1412
# we could set something and run a test that will check
1413
# it gets santised, but this is probably sufficient for now:
1414
# if someone runs the test with -Dsomething it will error.
1416
if self._lock_check_thorough:
1417
flags.add('strict_locks')
1418
self.assertEqual(flags, bzrlib.debug.debug_flags)
1420
def change_selftest_debug_flags(self, new_flags):
1421
orig_selftest_flags = tests.selftest_debug_flags
1422
self.addCleanup(self._restore_selftest_debug_flags, orig_selftest_flags)
1423
tests.selftest_debug_flags = set(new_flags)
1425
def _restore_selftest_debug_flags(self, flags):
1426
tests.selftest_debug_flags = flags
1428
def test_allow_debug_flag(self):
1429
"""The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1430
sanitised (i.e. cleared) before running a test.
1432
self.change_selftest_debug_flags(set(['allow_debug']))
1433
bzrlib.debug.debug_flags = set(['a-flag'])
1434
class TestThatRecordsFlags(tests.TestCase):
1435
def test_foo(nested_self):
1436
self.flags = set(bzrlib.debug.debug_flags)
1437
test = TestThatRecordsFlags('test_foo')
1438
test.run(self.make_test_result())
1439
flags = set(['a-flag'])
1440
if 'disable_lock_checks' not in tests.selftest_debug_flags:
1441
flags.add('strict_locks')
1442
self.assertEqual(flags, self.flags)
1444
def test_disable_lock_checks(self):
1445
"""The -Edisable_lock_checks flag disables thorough checks."""
1446
class TestThatRecordsFlags(tests.TestCase):
1447
def test_foo(nested_self):
1448
self.flags = set(bzrlib.debug.debug_flags)
1449
self.test_lock_check_thorough = nested_self._lock_check_thorough
1450
self.change_selftest_debug_flags(set())
1451
test = TestThatRecordsFlags('test_foo')
1452
test.run(self.make_test_result())
1453
# By default we do strict lock checking and thorough lock/unlock
1455
self.assertTrue(self.test_lock_check_thorough)
1456
self.assertEqual(set(['strict_locks']), self.flags)
1457
# Now set the disable_lock_checks flag, and show that this changed.
1458
self.change_selftest_debug_flags(set(['disable_lock_checks']))
1459
test = TestThatRecordsFlags('test_foo')
1460
test.run(self.make_test_result())
1461
self.assertFalse(self.test_lock_check_thorough)
1462
self.assertEqual(set(), self.flags)
1464
def test_this_fails_strict_lock_check(self):
1465
class TestThatRecordsFlags(tests.TestCase):
1466
def test_foo(nested_self):
1467
self.flags1 = set(bzrlib.debug.debug_flags)
1468
self.thisFailsStrictLockCheck()
1469
self.flags2 = set(bzrlib.debug.debug_flags)
1470
# Make sure lock checking is active
1471
self.change_selftest_debug_flags(set())
1472
test = TestThatRecordsFlags('test_foo')
1473
test.run(self.make_test_result())
1474
self.assertEqual(set(['strict_locks']), self.flags1)
1475
self.assertEqual(set(), self.flags2)
1477
def test_debug_flags_restored(self):
1478
"""The bzrlib debug flags should be restored to their original state
1479
after the test was run, even if allow_debug is set.
1481
self.change_selftest_debug_flags(set(['allow_debug']))
1482
# Now run a test that modifies debug.debug_flags.
1483
bzrlib.debug.debug_flags = set(['original-state'])
1484
class TestThatModifiesFlags(tests.TestCase):
1486
bzrlib.debug.debug_flags = set(['modified'])
1487
test = TestThatModifiesFlags('test_foo')
1488
test.run(self.make_test_result())
1489
self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1491
def make_test_result(self):
1492
return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
1494
def inner_test(self):
1495
# the inner child test
1498
def outer_child(self):
1499
# the outer child test
1501
self.inner_test = TestTestCase("inner_child")
1502
result = self.make_test_result()
1503
self.inner_test.run(result)
1504
note("outer finish")
1506
def test_trace_nesting(self):
1507
# this tests that each test case nests its trace facility correctly.
1508
# we do this by running a test case manually. That test case (A)
1509
# should setup a new log, log content to it, setup a child case (B),
1510
# which should log independently, then case (A) should log a trailer
1512
# we do two nested children so that we can verify the state of the
1513
# logs after the outer child finishes is correct, which a bad clean
1514
# up routine in tearDown might trigger a fault in our test with only
1515
# one child, we should instead see the bad result inside our test with
1517
# the outer child test
1518
original_trace = bzrlib.trace._trace_file
1519
outer_test = TestTestCase("outer_child")
1520
result = self.make_test_result()
1521
outer_test.run(result)
1522
self.addCleanup(osutils.delete_any, outer_test._log_file_name)
1523
self.assertEqual(original_trace, bzrlib.trace._trace_file)
1525
def method_that_times_a_bit_twice(self):
1526
# call self.time twice to ensure it aggregates
1527
self.time(time.sleep, 0.007)
1528
self.time(time.sleep, 0.007)
1530
def test_time_creates_benchmark_in_result(self):
1531
"""Test that the TestCase.time() method accumulates a benchmark time."""
1532
sample_test = TestTestCase("method_that_times_a_bit_twice")
1533
output_stream = StringIO()
1534
result = bzrlib.tests.VerboseTestResult(
1535
unittest._WritelnDecorator(output_stream),
1538
sample_test.run(result)
1539
self.assertContainsRe(
1540
output_stream.getvalue(),
1543
def test_hooks_sanitised(self):
1544
"""The bzrlib hooks should be sanitised by setUp."""
1545
# Note this test won't fail with hooks that the core library doesn't
1546
# use - but it trigger with a plugin that adds hooks, so its still a
1547
# useful warning in that case.
1548
self.assertEqual(bzrlib.branch.BranchHooks(),
1549
bzrlib.branch.Branch.hooks)
1550
self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
1551
bzrlib.smart.server.SmartTCPServer.hooks)
1552
self.assertEqual(bzrlib.commands.CommandHooks(),
1553
bzrlib.commands.Command.hooks)
1555
def test__gather_lsprof_in_benchmarks(self):
1556
"""When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1558
Each self.time() call is individually and separately profiled.
1560
self.requireFeature(test_lsprof.LSProfFeature)
1561
# overrides the class member with an instance member so no cleanup
1563
self._gather_lsprof_in_benchmarks = True
1564
self.time(time.sleep, 0.000)
1565
self.time(time.sleep, 0.003)
1566
self.assertEqual(2, len(self._benchcalls))
1567
self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
1568
self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1569
self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1570
self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1571
del self._benchcalls[:]
1573
def test_knownFailure(self):
1574
"""Self.knownFailure() should raise a KnownFailure exception."""
1575
self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
1577
def test_open_bzrdir_safe_roots(self):
1578
# even a memory transport should fail to open when its url isn't
1580
# Manually set one up (TestCase doesn't and shouldn't provide magic
1582
transport_server = MemoryServer()
1583
transport_server.setUp()
1584
self.addCleanup(transport_server.tearDown)
1585
t = transport.get_transport(transport_server.get_url())
1586
bzrdir.BzrDir.create(t.base)
1587
self.assertRaises(errors.BzrError,
1588
bzrdir.BzrDir.open_from_transport, t)
1589
# But if we declare this as safe, we can open the bzrdir.
1590
self.permit_url(t.base)
1591
self._bzr_selftest_roots.append(t.base)
1592
bzrdir.BzrDir.open_from_transport(t)
1594
def test_requireFeature_available(self):
1595
"""self.requireFeature(available) is a no-op."""
1596
class Available(tests.Feature):
1597
def _probe(self):return True
1598
feature = Available()
1599
self.requireFeature(feature)
1601
def test_requireFeature_unavailable(self):
1602
"""self.requireFeature(unavailable) raises UnavailableFeature."""
1603
class Unavailable(tests.Feature):
1604
def _probe(self):return False
1605
feature = Unavailable()
1606
self.assertRaises(tests.UnavailableFeature,
1607
self.requireFeature, feature)
1609
def test_run_no_parameters(self):
1610
test = SampleTestCase('_test_pass')
1613
def test_run_enabled_unittest_result(self):
1614
"""Test we revert to regular behaviour when the test is enabled."""
1615
test = SampleTestCase('_test_pass')
1616
class EnabledFeature(object):
1617
def available(self):
1619
test._test_needs_features = [EnabledFeature()]
1620
result = unittest.TestResult()
1622
self.assertEqual(1, result.testsRun)
1623
self.assertEqual([], result.errors)
1624
self.assertEqual([], result.failures)
1626
def test_run_disabled_unittest_result(self):
1627
"""Test our compatability for disabled tests with unittest results."""
1628
test = SampleTestCase('_test_pass')
1629
class DisabledFeature(object):
1630
def available(self):
1632
test._test_needs_features = [DisabledFeature()]
1633
result = unittest.TestResult()
1635
self.assertEqual(1, result.testsRun)
1636
self.assertEqual([], result.errors)
1637
self.assertEqual([], result.failures)
1639
def test_run_disabled_supporting_result(self):
1640
"""Test disabled tests behaviour with support aware results."""
1641
test = SampleTestCase('_test_pass')
1642
class DisabledFeature(object):
1643
def available(self):
1645
the_feature = DisabledFeature()
1646
test._test_needs_features = [the_feature]
1647
class InstrumentedTestResult(unittest.TestResult):
1649
unittest.TestResult.__init__(self)
1651
def startTest(self, test):
1652
self.calls.append(('startTest', test))
1653
def stopTest(self, test):
1654
self.calls.append(('stopTest', test))
1655
def addNotSupported(self, test, feature):
1656
self.calls.append(('addNotSupported', test, feature))
1657
result = InstrumentedTestResult()
1660
('startTest', test),
1661
('addNotSupported', test, the_feature),
1666
def test_start_server_registers_url(self):
1667
transport_server = MemoryServer()
1668
# A little strict, but unlikely to be changed soon.
1669
self.assertEqual([], self._bzr_selftest_roots)
1670
self.start_server(transport_server)
1671
self.assertSubset([transport_server.get_url()],
1672
self._bzr_selftest_roots)
1674
def test_assert_list_raises_on_generator(self):
1675
def generator_which_will_raise():
1676
# This will not raise until after the first yield
1678
raise _TestException()
1680
e = self.assertListRaises(_TestException, generator_which_will_raise)
1681
self.assertIsInstance(e, _TestException)
1683
e = self.assertListRaises(Exception, generator_which_will_raise)
1684
self.assertIsInstance(e, _TestException)
1686
def test_assert_list_raises_on_plain(self):
1687
def plain_exception():
1688
raise _TestException()
1691
e = self.assertListRaises(_TestException, plain_exception)
1692
self.assertIsInstance(e, _TestException)
1694
e = self.assertListRaises(Exception, plain_exception)
1695
self.assertIsInstance(e, _TestException)
1697
def test_assert_list_raises_assert_wrong_exception(self):
1698
class _NotTestException(Exception):
1701
def wrong_exception():
1702
raise _NotTestException()
1704
def wrong_exception_generator():
1707
raise _NotTestException()
1709
# Wrong exceptions are not intercepted
1710
self.assertRaises(_NotTestException,
1711
self.assertListRaises, _TestException, wrong_exception)
1712
self.assertRaises(_NotTestException,
1713
self.assertListRaises, _TestException, wrong_exception_generator)
1715
def test_assert_list_raises_no_exception(self):
1719
def success_generator():
1723
self.assertRaises(AssertionError,
1724
self.assertListRaises, _TestException, success)
1726
self.assertRaises(AssertionError,
1727
self.assertListRaises, _TestException, success_generator)
1730
# NB: Don't delete this; it's not actually from 0.11!
1731
@deprecated_function(deprecated_in((0, 11, 0)))
1732
def sample_deprecated_function():
1733
"""A deprecated function to test applyDeprecated with."""
1737
def sample_undeprecated_function(a_param):
1738
"""A undeprecated function to test applyDeprecated with."""
1741
class ApplyDeprecatedHelper(object):
1742
"""A helper class for ApplyDeprecated tests."""
1744
@deprecated_method(deprecated_in((0, 11, 0)))
1745
def sample_deprecated_method(self, param_one):
1746
"""A deprecated method for testing with."""
1749
def sample_normal_method(self):
1750
"""A undeprecated method."""
1752
@deprecated_method(deprecated_in((0, 10, 0)))
1753
def sample_nested_deprecation(self):
1754
return sample_deprecated_function()
1757
class TestExtraAssertions(tests.TestCase):
1758
"""Tests for new test assertions in bzrlib test suite"""
1760
def test_assert_isinstance(self):
1761
self.assertIsInstance(2, int)
1762
self.assertIsInstance(u'', basestring)
1763
e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1764
self.assertEquals(str(e),
1765
"None is an instance of <type 'NoneType'> rather than <type 'int'>")
1766
self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1767
e = self.assertRaises(AssertionError,
1768
self.assertIsInstance, None, int, "it's just not")
1769
self.assertEquals(str(e),
1770
"None is an instance of <type 'NoneType'> rather than <type 'int'>"
1773
def test_assertEndsWith(self):
1774
self.assertEndsWith('foo', 'oo')
1775
self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1777
def test_assertEqualDiff(self):
1778
e = self.assertRaises(AssertionError,
1779
self.assertEqualDiff, '', '\n')
1780
self.assertEquals(str(e),
1781
# Don't blink ! The '+' applies to the second string
1782
'first string is missing a final newline.\n+ \n')
1783
e = self.assertRaises(AssertionError,
1784
self.assertEqualDiff, '\n', '')
1785
self.assertEquals(str(e),
1786
# Don't blink ! The '-' applies to the second string
1787
'second string is missing a final newline.\n- \n')
1790
class TestDeprecations(tests.TestCase):
1792
def test_applyDeprecated_not_deprecated(self):
1793
sample_object = ApplyDeprecatedHelper()
1794
# calling an undeprecated callable raises an assertion
1795
self.assertRaises(AssertionError, self.applyDeprecated,
1796
deprecated_in((0, 11, 0)),
1797
sample_object.sample_normal_method)
1798
self.assertRaises(AssertionError, self.applyDeprecated,
1799
deprecated_in((0, 11, 0)),
1800
sample_undeprecated_function, "a param value")
1801
# calling a deprecated callable (function or method) with the wrong
1802
# expected deprecation fails.
1803
self.assertRaises(AssertionError, self.applyDeprecated,
1804
deprecated_in((0, 10, 0)),
1805
sample_object.sample_deprecated_method, "a param value")
1806
self.assertRaises(AssertionError, self.applyDeprecated,
1807
deprecated_in((0, 10, 0)),
1808
sample_deprecated_function)
1809
# calling a deprecated callable (function or method) with the right
1810
# expected deprecation returns the functions result.
1811
self.assertEqual("a param value",
1812
self.applyDeprecated(deprecated_in((0, 11, 0)),
1813
sample_object.sample_deprecated_method, "a param value"))
1814
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 11, 0)),
1815
sample_deprecated_function))
1816
# calling a nested deprecation with the wrong deprecation version
1817
# fails even if a deeper nested function was deprecated with the
1819
self.assertRaises(AssertionError, self.applyDeprecated,
1820
deprecated_in((0, 11, 0)), sample_object.sample_nested_deprecation)
1821
# calling a nested deprecation with the right deprecation value
1822
# returns the calls result.
1823
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 10, 0)),
1824
sample_object.sample_nested_deprecation))
1826
def test_callDeprecated(self):
1827
def testfunc(be_deprecated, result=None):
1828
if be_deprecated is True:
1829
symbol_versioning.warn('i am deprecated', DeprecationWarning,
1832
result = self.callDeprecated(['i am deprecated'], testfunc, True)
1833
self.assertIs(None, result)
1834
result = self.callDeprecated([], testfunc, False, 'result')
1835
self.assertEqual('result', result)
1836
self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
1837
self.callDeprecated([], testfunc, be_deprecated=False)
1840
class TestWarningTests(tests.TestCase):
1841
"""Tests for calling methods that raise warnings."""
1843
def test_callCatchWarnings(self):
1845
warnings.warn("this is your last warning")
1847
wlist, result = self.callCatchWarnings(meth, 1, 2)
1848
self.assertEquals(3, result)
1849
# would like just to compare them, but UserWarning doesn't implement
1852
self.assertIsInstance(w0, UserWarning)
1853
self.assertEquals("this is your last warning", str(w0))
1856
class TestConvenienceMakers(tests.TestCaseWithTransport):
1857
"""Test for the make_* convenience functions."""
1859
def test_make_branch_and_tree_with_format(self):
1860
# we should be able to supply a format to make_branch_and_tree
1861
self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
1862
self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
1863
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
1864
bzrlib.bzrdir.BzrDirMetaFormat1)
1865
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
1866
bzrlib.bzrdir.BzrDirFormat6)
1868
def test_make_branch_and_memory_tree(self):
1869
# we should be able to get a new branch and a mutable tree from
1870
# TestCaseWithTransport
1871
tree = self.make_branch_and_memory_tree('a')
1872
self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1874
def test_make_tree_for_local_vfs_backed_transport(self):
1875
# make_branch_and_tree has to use local branch and repositories
1876
# when the vfs transport and local disk are colocated, even if
1877
# a different transport is in use for url generation.
1878
from bzrlib.transport.fakevfat import FakeVFATServer
1879
self.transport_server = FakeVFATServer
1880
self.assertFalse(self.get_url('t1').startswith('file://'))
1881
tree = self.make_branch_and_tree('t1')
1882
base = tree.bzrdir.root_transport.base
1883
self.assertStartsWith(base, 'file://')
1884
self.assertEquals(tree.bzrdir.root_transport,
1885
tree.branch.bzrdir.root_transport)
1886
self.assertEquals(tree.bzrdir.root_transport,
1887
tree.branch.repository.bzrdir.root_transport)
1890
class SelfTestHelper:
1892
def run_selftest(self, **kwargs):
1893
"""Run selftest returning its output."""
1895
old_transport = bzrlib.tests.default_transport
1896
old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
1897
tests.TestCaseWithMemoryTransport.TEST_ROOT = None
1899
self.assertEqual(True, tests.selftest(stream=output, **kwargs))
1901
bzrlib.tests.default_transport = old_transport
1902
tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
1907
class TestSelftest(tests.TestCase, SelfTestHelper):
1908
"""Tests of bzrlib.tests.selftest."""
1910
def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1913
factory_called.append(True)
1914
return TestUtil.TestSuite()
1917
self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1918
test_suite_factory=factory)
1919
self.assertEqual([True], factory_called)
1922
"""A test suite factory."""
1923
class Test(tests.TestCase):
1930
return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
1932
def test_list_only(self):
1933
output = self.run_selftest(test_suite_factory=self.factory,
1935
self.assertEqual(3, len(output.readlines()))
1937
def test_list_only_filtered(self):
1938
output = self.run_selftest(test_suite_factory=self.factory,
1939
list_only=True, pattern="Test.b")
1940
self.assertEndsWith(output.getvalue(), "Test.b\n")
1941
self.assertLength(1, output.readlines())
1943
def test_list_only_excludes(self):
1944
output = self.run_selftest(test_suite_factory=self.factory,
1945
list_only=True, exclude_pattern="Test.b")
1946
self.assertNotContainsRe("Test.b", output.getvalue())
1947
self.assertLength(2, output.readlines())
1949
def test_lsprof_tests(self):
1950
self.requireFeature(test_lsprof.LSProfFeature)
1953
def __call__(test, result):
1955
def run(test, result):
1956
self.assertIsInstance(result, tests.ForwardingResult)
1957
calls.append("called")
1958
def countTestCases(self):
1960
self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
1961
self.assertLength(1, calls)
1963
def test_random(self):
1964
# test randomising by listing a number of tests.
1965
output_123 = self.run_selftest(test_suite_factory=self.factory,
1966
list_only=True, random_seed="123")
1967
output_234 = self.run_selftest(test_suite_factory=self.factory,
1968
list_only=True, random_seed="234")
1969
self.assertNotEqual(output_123, output_234)
1970
# "Randominzing test order..\n\n
1971
self.assertLength(5, output_123.readlines())
1972
self.assertLength(5, output_234.readlines())
1974
def test_random_reuse_is_same_order(self):
1975
# test randomising by listing a number of tests.
1976
expected = self.run_selftest(test_suite_factory=self.factory,
1977
list_only=True, random_seed="123")
1978
repeated = self.run_selftest(test_suite_factory=self.factory,
1979
list_only=True, random_seed="123")
1980
self.assertEqual(expected.getvalue(), repeated.getvalue())
1982
def test_runner_class(self):
1983
self.requireFeature(SubUnitFeature)
1984
from subunit import ProtocolTestCase
1985
stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
1986
test_suite_factory=self.factory)
1987
test = ProtocolTestCase(stream)
1988
result = unittest.TestResult()
1990
self.assertEqual(3, result.testsRun)
1992
def test_starting_with_single_argument(self):
1993
output = self.run_selftest(test_suite_factory=self.factory,
1994
starting_with=['bzrlib.tests.test_selftest.Test.a'],
1996
self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
1999
def test_starting_with_multiple_argument(self):
2000
output = self.run_selftest(test_suite_factory=self.factory,
2001
starting_with=['bzrlib.tests.test_selftest.Test.a',
2002
'bzrlib.tests.test_selftest.Test.b'],
2004
self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
2005
'bzrlib.tests.test_selftest.Test.b\n',
2008
def check_transport_set(self, transport_server):
2009
captured_transport = []
2010
def seen_transport(a_transport):
2011
captured_transport.append(a_transport)
2012
class Capture(tests.TestCase):
2014
seen_transport(bzrlib.tests.default_transport)
2016
return TestUtil.TestSuite([Capture("a")])
2017
self.run_selftest(transport=transport_server, test_suite_factory=factory)
2018
self.assertEqual(transport_server, captured_transport[0])
2020
def test_transport_sftp(self):
2022
import bzrlib.transport.sftp
2023
except errors.ParamikoNotPresent:
2024
raise tests.TestSkipped("Paramiko not present")
2025
self.check_transport_set(bzrlib.transport.sftp.SFTPAbsoluteServer)
2027
def test_transport_memory(self):
2028
self.check_transport_set(bzrlib.transport.memory.MemoryServer)
2031
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
2032
# Does IO: reads test.list
2034
def test_load_list(self):
2035
# Provide a list with one test - this test.
2036
test_id_line = '%s\n' % self.id()
2037
self.build_tree_contents([('test.list', test_id_line)])
2038
# And generate a list of the tests in the suite.
2039
stream = self.run_selftest(load_list='test.list', list_only=True)
2040
self.assertEqual(test_id_line, stream.getvalue())
2042
def test_load_unknown(self):
2043
# Provide a list with one test - this test.
2044
# And generate a list of the tests in the suite.
2045
err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
2046
load_list='missing file name', list_only=True)
2049
class TestRunBzr(tests.TestCase):
2054
def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
2056
"""Override _run_bzr_core to test how it is invoked by run_bzr.
2058
Attempts to run bzr from inside this class don't actually run it.
2060
We test how run_bzr actually invokes bzr in another location. Here we
2061
only need to test that it passes the right parameters to run_bzr.
2063
self.argv = list(argv)
2064
self.retcode = retcode
2065
self.encoding = encoding
2067
self.working_dir = working_dir
2068
return self.retcode, self.out, self.err
2070
def test_run_bzr_error(self):
2071
self.out = "It sure does!\n"
2072
out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
2073
self.assertEqual(['rocks'], self.argv)
2074
self.assertEqual(34, self.retcode)
2075
self.assertEqual('It sure does!\n', out)
2076
self.assertEquals(out, self.out)
2077
self.assertEqual('', err)
2078
self.assertEquals(err, self.err)
2080
def test_run_bzr_error_regexes(self):
2082
self.err = "bzr: ERROR: foobarbaz is not versioned"
2083
out, err = self.run_bzr_error(
2084
["bzr: ERROR: foobarbaz is not versioned"],
2085
['file-id', 'foobarbaz'])
2087
def test_encoding(self):
2088
"""Test that run_bzr passes encoding to _run_bzr_core"""
2089
self.run_bzr('foo bar')
2090
self.assertEqual(None, self.encoding)
2091
self.assertEqual(['foo', 'bar'], self.argv)
2093
self.run_bzr('foo bar', encoding='baz')
2094
self.assertEqual('baz', self.encoding)
2095
self.assertEqual(['foo', 'bar'], self.argv)
2097
def test_retcode(self):
2098
"""Test that run_bzr passes retcode to _run_bzr_core"""
2099
# Default is retcode == 0
2100
self.run_bzr('foo bar')
2101
self.assertEqual(0, self.retcode)
2102
self.assertEqual(['foo', 'bar'], self.argv)
2104
self.run_bzr('foo bar', retcode=1)
2105
self.assertEqual(1, self.retcode)
2106
self.assertEqual(['foo', 'bar'], self.argv)
2108
self.run_bzr('foo bar', retcode=None)
2109
self.assertEqual(None, self.retcode)
2110
self.assertEqual(['foo', 'bar'], self.argv)
2112
self.run_bzr(['foo', 'bar'], retcode=3)
2113
self.assertEqual(3, self.retcode)
2114
self.assertEqual(['foo', 'bar'], self.argv)
2116
def test_stdin(self):
2117
# test that the stdin keyword to run_bzr is passed through to
2118
# _run_bzr_core as-is. We do this by overriding
2119
# _run_bzr_core in this class, and then calling run_bzr,
2120
# which is a convenience function for _run_bzr_core, so
2122
self.run_bzr('foo bar', stdin='gam')
2123
self.assertEqual('gam', self.stdin)
2124
self.assertEqual(['foo', 'bar'], self.argv)
2126
self.run_bzr('foo bar', stdin='zippy')
2127
self.assertEqual('zippy', self.stdin)
2128
self.assertEqual(['foo', 'bar'], self.argv)
2130
def test_working_dir(self):
2131
"""Test that run_bzr passes working_dir to _run_bzr_core"""
2132
self.run_bzr('foo bar')
2133
self.assertEqual(None, self.working_dir)
2134
self.assertEqual(['foo', 'bar'], self.argv)
2136
self.run_bzr('foo bar', working_dir='baz')
2137
self.assertEqual('baz', self.working_dir)
2138
self.assertEqual(['foo', 'bar'], self.argv)
2140
def test_reject_extra_keyword_arguments(self):
2141
self.assertRaises(TypeError, self.run_bzr, "foo bar",
2142
error_regex=['error message'])
2145
class TestRunBzrCaptured(tests.TestCaseWithTransport):
2146
# Does IO when testing the working_dir parameter.
2148
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2149
a_callable=None, *args, **kwargs):
2151
self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
2152
self.factory = bzrlib.ui.ui_factory
2153
self.working_dir = osutils.getcwd()
2154
stdout.write('foo\n')
2155
stderr.write('bar\n')
2158
def test_stdin(self):
2159
# test that the stdin keyword to _run_bzr_core is passed through to
2160
# apply_redirected as a StringIO. We do this by overriding
2161
# apply_redirected in this class, and then calling _run_bzr_core,
2162
# which calls apply_redirected.
2163
self.run_bzr(['foo', 'bar'], stdin='gam')
2164
self.assertEqual('gam', self.stdin.read())
2165
self.assertTrue(self.stdin is self.factory_stdin)
2166
self.run_bzr(['foo', 'bar'], stdin='zippy')
2167
self.assertEqual('zippy', self.stdin.read())
2168
self.assertTrue(self.stdin is self.factory_stdin)
2170
def test_ui_factory(self):
2171
# each invocation of self.run_bzr should get its
2172
# own UI factory, which is an instance of TestUIFactory,
2173
# with stdin, stdout and stderr attached to the stdin,
2174
# stdout and stderr of the invoked run_bzr
2175
current_factory = bzrlib.ui.ui_factory
2176
self.run_bzr(['foo'])
2177
self.failIf(current_factory is self.factory)
2178
self.assertNotEqual(sys.stdout, self.factory.stdout)
2179
self.assertNotEqual(sys.stderr, self.factory.stderr)
2180
self.assertEqual('foo\n', self.factory.stdout.getvalue())
2181
self.assertEqual('bar\n', self.factory.stderr.getvalue())
2182
self.assertIsInstance(self.factory, tests.TestUIFactory)
2184
def test_working_dir(self):
2185
self.build_tree(['one/', 'two/'])
2186
cwd = osutils.getcwd()
2188
# Default is to work in the current directory
2189
self.run_bzr(['foo', 'bar'])
2190
self.assertEqual(cwd, self.working_dir)
2192
self.run_bzr(['foo', 'bar'], working_dir=None)
2193
self.assertEqual(cwd, self.working_dir)
2195
# The function should be run in the alternative directory
2196
# but afterwards the current working dir shouldn't be changed
2197
self.run_bzr(['foo', 'bar'], working_dir='one')
2198
self.assertNotEqual(cwd, self.working_dir)
2199
self.assertEndsWith(self.working_dir, 'one')
2200
self.assertEqual(cwd, osutils.getcwd())
2202
self.run_bzr(['foo', 'bar'], working_dir='two')
2203
self.assertNotEqual(cwd, self.working_dir)
2204
self.assertEndsWith(self.working_dir, 'two')
2205
self.assertEqual(cwd, osutils.getcwd())
2208
class StubProcess(object):
2209
"""A stub process for testing run_bzr_subprocess."""
2211
def __init__(self, out="", err="", retcode=0):
2214
self.returncode = retcode
2216
def communicate(self):
2217
return self.out, self.err
2220
class TestWithFakedStartBzrSubprocess(tests.TestCaseWithTransport):
2221
"""Base class for tests testing how we might run bzr."""
2224
tests.TestCaseWithTransport.setUp(self)
2225
self.subprocess_calls = []
2227
def start_bzr_subprocess(self, process_args, env_changes=None,
2228
skip_if_plan_to_signal=False,
2230
allow_plugins=False):
2231
"""capture what run_bzr_subprocess tries to do."""
2232
self.subprocess_calls.append({'process_args':process_args,
2233
'env_changes':env_changes,
2234
'skip_if_plan_to_signal':skip_if_plan_to_signal,
2235
'working_dir':working_dir, 'allow_plugins':allow_plugins})
2236
return self.next_subprocess
2239
class TestRunBzrSubprocess(TestWithFakedStartBzrSubprocess):
2241
def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
2242
"""Run run_bzr_subprocess with args and kwargs using a stubbed process.
2244
Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
2245
that will return static results. This assertion method populates those
2246
results and also checks the arguments run_bzr_subprocess generates.
2248
self.next_subprocess = process
2250
result = self.run_bzr_subprocess(*args, **kwargs)
2252
self.next_subprocess = None
2253
for key, expected in expected_args.iteritems():
2254
self.assertEqual(expected, self.subprocess_calls[-1][key])
2257
self.next_subprocess = None
2258
for key, expected in expected_args.iteritems():
2259
self.assertEqual(expected, self.subprocess_calls[-1][key])
2262
def test_run_bzr_subprocess(self):
2263
"""The run_bzr_helper_external command behaves nicely."""
2264
self.assertRunBzrSubprocess({'process_args':['--version']},
2265
StubProcess(), '--version')
2266
self.assertRunBzrSubprocess({'process_args':['--version']},
2267
StubProcess(), ['--version'])
2268
# retcode=None disables retcode checking
2269
result = self.assertRunBzrSubprocess({},
2270
StubProcess(retcode=3), '--version', retcode=None)
2271
result = self.assertRunBzrSubprocess({},
2272
StubProcess(out="is free software"), '--version')
2273
self.assertContainsRe(result[0], 'is free software')
2274
# Running a subcommand that is missing errors
2275
self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
2276
{'process_args':['--versionn']}, StubProcess(retcode=3),
2278
# Unless it is told to expect the error from the subprocess
2279
result = self.assertRunBzrSubprocess({},
2280
StubProcess(retcode=3), '--versionn', retcode=3)
2281
# Or to ignore retcode checking
2282
result = self.assertRunBzrSubprocess({},
2283
StubProcess(err="unknown command", retcode=3), '--versionn',
2285
self.assertContainsRe(result[1], 'unknown command')
2287
def test_env_change_passes_through(self):
2288
self.assertRunBzrSubprocess(
2289
{'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
2291
env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
2293
def test_no_working_dir_passed_as_None(self):
2294
self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
2296
def test_no_working_dir_passed_through(self):
2297
self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
2300
def test_run_bzr_subprocess_no_plugins(self):
2301
self.assertRunBzrSubprocess({'allow_plugins': False},
2304
def test_allow_plugins(self):
2305
self.assertRunBzrSubprocess({'allow_plugins': True},
2306
StubProcess(), '', allow_plugins=True)
2309
class TestFinishBzrSubprocess(TestWithFakedStartBzrSubprocess):
2311
def test_finish_bzr_subprocess_with_error(self):
2312
"""finish_bzr_subprocess allows specification of the desired exit code.
2314
process = StubProcess(err="unknown command", retcode=3)
2315
result = self.finish_bzr_subprocess(process, retcode=3)
2316
self.assertEqual('', result[0])
2317
self.assertContainsRe(result[1], 'unknown command')
2319
def test_finish_bzr_subprocess_ignoring_retcode(self):
2320
"""finish_bzr_subprocess allows the exit code to be ignored."""
2321
process = StubProcess(err="unknown command", retcode=3)
2322
result = self.finish_bzr_subprocess(process, retcode=None)
2323
self.assertEqual('', result[0])
2324
self.assertContainsRe(result[1], 'unknown command')
2326
def test_finish_subprocess_with_unexpected_retcode(self):
2327
"""finish_bzr_subprocess raises self.failureException if the retcode is
2328
not the expected one.
2330
process = StubProcess(err="unknown command", retcode=3)
2331
self.assertRaises(self.failureException, self.finish_bzr_subprocess,
2335
class _DontSpawnProcess(Exception):
2336
"""A simple exception which just allows us to skip unnecessary steps"""
2339
class TestStartBzrSubProcess(tests.TestCase):
2341
def check_popen_state(self):
2342
"""Replace to make assertions when popen is called."""
2344
def _popen(self, *args, **kwargs):
2345
"""Record the command that is run, so that we can ensure it is correct"""
2346
self.check_popen_state()
2347
self._popen_args = args
2348
self._popen_kwargs = kwargs
2349
raise _DontSpawnProcess()
2351
def test_run_bzr_subprocess_no_plugins(self):
2352
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
2353
command = self._popen_args[0]
2354
self.assertEqual(sys.executable, command[0])
2355
self.assertEqual(self.get_bzr_path(), command[1])
2356
self.assertEqual(['--no-plugins'], command[2:])
2358
def test_allow_plugins(self):
2359
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2361
command = self._popen_args[0]
2362
self.assertEqual([], command[2:])
2364
def test_set_env(self):
2365
self.failIf('EXISTANT_ENV_VAR' in os.environ)
2367
def check_environment():
2368
self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2369
self.check_popen_state = check_environment
2370
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2371
env_changes={'EXISTANT_ENV_VAR':'set variable'})
2372
# not set in theparent
2373
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2375
def test_run_bzr_subprocess_env_del(self):
2376
"""run_bzr_subprocess can remove environment variables too."""
2377
self.failIf('EXISTANT_ENV_VAR' in os.environ)
2378
def check_environment():
2379
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2380
os.environ['EXISTANT_ENV_VAR'] = 'set variable'
2381
self.check_popen_state = check_environment
2382
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2383
env_changes={'EXISTANT_ENV_VAR':None})
2384
# Still set in parent
2385
self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2386
del os.environ['EXISTANT_ENV_VAR']
2388
def test_env_del_missing(self):
2389
self.failIf('NON_EXISTANT_ENV_VAR' in os.environ)
2390
def check_environment():
2391
self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2392
self.check_popen_state = check_environment
2393
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2394
env_changes={'NON_EXISTANT_ENV_VAR':None})
2396
def test_working_dir(self):
2397
"""Test that we can specify the working dir for the child"""
2398
orig_getcwd = osutils.getcwd
2399
orig_chdir = os.chdir
2407
osutils.getcwd = getcwd
2409
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2412
osutils.getcwd = orig_getcwd
2414
os.chdir = orig_chdir
2415
self.assertEqual(['foo', 'current'], chdirs)
2418
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
2419
"""Tests that really need to do things with an external bzr."""
2421
def test_start_and_stop_bzr_subprocess_send_signal(self):
2422
"""finish_bzr_subprocess raises self.failureException if the retcode is
2423
not the expected one.
2425
self.disable_missing_extensions_warning()
2426
process = self.start_bzr_subprocess(['wait-until-signalled'],
2427
skip_if_plan_to_signal=True)
2428
self.assertEqual('running\n', process.stdout.readline())
2429
result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
2431
self.assertEqual('', result[0])
2432
self.assertEqual('bzr: interrupted\n', result[1])
2435
class TestKnownFailure(tests.TestCase):
2437
def test_known_failure(self):
2438
"""Check that KnownFailure is defined appropriately."""
2439
# a KnownFailure is an assertion error for compatability with unaware
2441
self.assertIsInstance(tests.KnownFailure(""), AssertionError)
2443
def test_expect_failure(self):
2445
self.expectFailure("Doomed to failure", self.assertTrue, False)
2446
except tests.KnownFailure, e:
2447
self.assertEqual('Doomed to failure', e.args[0])
2449
self.expectFailure("Doomed to failure", self.assertTrue, True)
2450
except AssertionError, e:
2451
self.assertEqual('Unexpected success. Should have failed:'
2452
' Doomed to failure', e.args[0])
2454
self.fail('Assertion not raised')
2457
class TestFeature(tests.TestCase):
2459
def test_caching(self):
2460
"""Feature._probe is called by the feature at most once."""
2461
class InstrumentedFeature(tests.Feature):
2463
super(InstrumentedFeature, self).__init__()
2466
self.calls.append('_probe')
2468
feature = InstrumentedFeature()
2470
self.assertEqual(['_probe'], feature.calls)
2472
self.assertEqual(['_probe'], feature.calls)
2474
def test_named_str(self):
2475
"""Feature.__str__ should thunk to feature_name()."""
2476
class NamedFeature(tests.Feature):
2477
def feature_name(self):
2479
feature = NamedFeature()
2480
self.assertEqual('symlinks', str(feature))
2482
def test_default_str(self):
2483
"""Feature.__str__ should default to __class__.__name__."""
2484
class NamedFeature(tests.Feature):
2486
feature = NamedFeature()
2487
self.assertEqual('NamedFeature', str(feature))
2490
class TestUnavailableFeature(tests.TestCase):
2492
def test_access_feature(self):
2493
feature = tests.Feature()
2494
exception = tests.UnavailableFeature(feature)
2495
self.assertIs(feature, exception.args[0])
2498
class TestSelftestFiltering(tests.TestCase):
2501
tests.TestCase.setUp(self)
2502
self.suite = TestUtil.TestSuite()
2503
self.loader = TestUtil.TestLoader()
2504
self.suite.addTest(self.loader.loadTestsFromModule(
2505
sys.modules['bzrlib.tests.test_selftest']))
2506
self.all_names = _test_ids(self.suite)
2508
def test_condition_id_re(self):
2509
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2510
'test_condition_id_re')
2511
filtered_suite = tests.filter_suite_by_condition(
2512
self.suite, tests.condition_id_re('test_condition_id_re'))
2513
self.assertEqual([test_name], _test_ids(filtered_suite))
2515
def test_condition_id_in_list(self):
2516
test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
2517
'test_condition_id_in_list']
2518
id_list = tests.TestIdList(test_names)
2519
filtered_suite = tests.filter_suite_by_condition(
2520
self.suite, tests.condition_id_in_list(id_list))
2521
my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
2522
re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
2523
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2525
def test_condition_id_startswith(self):
2526
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2527
start1 = klass + 'test_condition_id_starts'
2528
start2 = klass + 'test_condition_id_in'
2529
test_names = [ klass + 'test_condition_id_in_list',
2530
klass + 'test_condition_id_startswith',
2532
filtered_suite = tests.filter_suite_by_condition(
2533
self.suite, tests.condition_id_startswith([start1, start2]))
2534
self.assertEqual(test_names, _test_ids(filtered_suite))
2536
def test_condition_isinstance(self):
2537
filtered_suite = tests.filter_suite_by_condition(
2538
self.suite, tests.condition_isinstance(self.__class__))
2539
class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2540
re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
2541
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2543
def test_exclude_tests_by_condition(self):
2544
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2545
'test_exclude_tests_by_condition')
2546
filtered_suite = tests.exclude_tests_by_condition(self.suite,
2547
lambda x:x.id() == excluded_name)
2548
self.assertEqual(len(self.all_names) - 1,
2549
filtered_suite.countTestCases())
2550
self.assertFalse(excluded_name in _test_ids(filtered_suite))
2551
remaining_names = list(self.all_names)
2552
remaining_names.remove(excluded_name)
2553
self.assertEqual(remaining_names, _test_ids(filtered_suite))
2555
def test_exclude_tests_by_re(self):
2556
self.all_names = _test_ids(self.suite)
2557
filtered_suite = tests.exclude_tests_by_re(self.suite,
2558
'exclude_tests_by_re')
2559
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2560
'test_exclude_tests_by_re')
2561
self.assertEqual(len(self.all_names) - 1,
2562
filtered_suite.countTestCases())
2563
self.assertFalse(excluded_name in _test_ids(filtered_suite))
2564
remaining_names = list(self.all_names)
2565
remaining_names.remove(excluded_name)
2566
self.assertEqual(remaining_names, _test_ids(filtered_suite))
2568
def test_filter_suite_by_condition(self):
2569
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2570
'test_filter_suite_by_condition')
2571
filtered_suite = tests.filter_suite_by_condition(self.suite,
2572
lambda x:x.id() == test_name)
2573
self.assertEqual([test_name], _test_ids(filtered_suite))
2575
def test_filter_suite_by_re(self):
2576
filtered_suite = tests.filter_suite_by_re(self.suite,
2577
'test_filter_suite_by_r')
2578
filtered_names = _test_ids(filtered_suite)
2579
self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
2580
'TestSelftestFiltering.test_filter_suite_by_re'])
2582
def test_filter_suite_by_id_list(self):
2583
test_list = ['bzrlib.tests.test_selftest.'
2584
'TestSelftestFiltering.test_filter_suite_by_id_list']
2585
filtered_suite = tests.filter_suite_by_id_list(
2586
self.suite, tests.TestIdList(test_list))
2587
filtered_names = _test_ids(filtered_suite)
2590
['bzrlib.tests.test_selftest.'
2591
'TestSelftestFiltering.test_filter_suite_by_id_list'])
2593
def test_filter_suite_by_id_startswith(self):
2594
# By design this test may fail if another test is added whose name also
2595
# begins with one of the start value used.
2596
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2597
start1 = klass + 'test_filter_suite_by_id_starts'
2598
start2 = klass + 'test_filter_suite_by_id_li'
2599
test_list = [klass + 'test_filter_suite_by_id_list',
2600
klass + 'test_filter_suite_by_id_startswith',
2602
filtered_suite = tests.filter_suite_by_id_startswith(
2603
self.suite, [start1, start2])
2606
_test_ids(filtered_suite),
2609
def test_preserve_input(self):
2610
# NB: Surely this is something in the stdlib to do this?
2611
self.assertTrue(self.suite is tests.preserve_input(self.suite))
2612
self.assertTrue("@#$" is tests.preserve_input("@#$"))
2614
def test_randomize_suite(self):
2615
randomized_suite = tests.randomize_suite(self.suite)
2616
# randomizing should not add or remove test names.
2617
self.assertEqual(set(_test_ids(self.suite)),
2618
set(_test_ids(randomized_suite)))
2619
# Technically, this *can* fail, because random.shuffle(list) can be
2620
# equal to list. Trying multiple times just pushes the frequency back.
2621
# As its len(self.all_names)!:1, the failure frequency should be low
2622
# enough to ignore. RBC 20071021.
2623
# It should change the order.
2624
self.assertNotEqual(self.all_names, _test_ids(randomized_suite))
2625
# But not the length. (Possibly redundant with the set test, but not
2627
self.assertEqual(len(self.all_names), len(_test_ids(randomized_suite)))
2629
def test_split_suit_by_condition(self):
2630
self.all_names = _test_ids(self.suite)
2631
condition = tests.condition_id_re('test_filter_suite_by_r')
2632
split_suite = tests.split_suite_by_condition(self.suite, condition)
2633
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2634
'test_filter_suite_by_re')
2635
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2636
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2637
remaining_names = list(self.all_names)
2638
remaining_names.remove(filtered_name)
2639
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2641
def test_split_suit_by_re(self):
2642
self.all_names = _test_ids(self.suite)
2643
split_suite = tests.split_suite_by_re(self.suite,
2644
'test_filter_suite_by_r')
2645
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2646
'test_filter_suite_by_re')
2647
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2648
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2649
remaining_names = list(self.all_names)
2650
remaining_names.remove(filtered_name)
2651
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2654
class TestCheckInventoryShape(tests.TestCaseWithTransport):
2656
def test_check_inventory_shape(self):
2657
files = ['a', 'b/', 'b/c']
2658
tree = self.make_branch_and_tree('.')
2659
self.build_tree(files)
2663
self.check_inventory_shape(tree.inventory, files)
2668
class TestBlackboxSupport(tests.TestCase):
2669
"""Tests for testsuite blackbox features."""
2671
def test_run_bzr_failure_not_caught(self):
2672
# When we run bzr in blackbox mode, we want any unexpected errors to
2673
# propagate up to the test suite so that it can show the error in the
2674
# usual way, and we won't get a double traceback.
2675
e = self.assertRaises(
2677
self.run_bzr, ['assert-fail'])
2678
# make sure we got the real thing, not an error from somewhere else in
2679
# the test framework
2680
self.assertEquals('always fails', str(e))
2681
# check that there's no traceback in the test log
2682
self.assertNotContainsRe(self._get_log(keep_log_file=True),
2685
def test_run_bzr_user_error_caught(self):
2686
# Running bzr in blackbox mode, normal/expected/user errors should be
2687
# caught in the regular way and turned into an error message plus exit
2689
transport_server = MemoryServer()
2690
transport_server.setUp()
2691
self.addCleanup(transport_server.tearDown)
2692
url = transport_server.get_url()
2693
self.permit_url(url)
2694
out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
2695
self.assertEqual(out, '')
2696
self.assertContainsRe(err,
2697
'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
2700
class TestTestLoader(tests.TestCase):
2701
"""Tests for the test loader."""
2703
def _get_loader_and_module(self):
2704
"""Gets a TestLoader and a module with one test in it."""
2705
loader = TestUtil.TestLoader()
2707
class Stub(tests.TestCase):
2710
class MyModule(object):
2712
MyModule.a_class = Stub
2714
return loader, module
2716
def test_module_no_load_tests_attribute_loads_classes(self):
2717
loader, module = self._get_loader_and_module()
2718
self.assertEqual(1, loader.loadTestsFromModule(module).countTestCases())
2720
def test_module_load_tests_attribute_gets_called(self):
2721
loader, module = self._get_loader_and_module()
2722
# 'self' is here because we're faking the module with a class. Regular
2723
# load_tests do not need that :)
2724
def load_tests(self, standard_tests, module, loader):
2725
result = loader.suiteClass()
2726
for test in tests.iter_suite_tests(standard_tests):
2727
result.addTests([test, test])
2729
# add a load_tests() method which multiplies the tests from the module.
2730
module.__class__.load_tests = load_tests
2731
self.assertEqual(2, loader.loadTestsFromModule(module).countTestCases())
2733
def test_load_tests_from_module_name_smoke_test(self):
2734
loader = TestUtil.TestLoader()
2735
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2736
self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2739
def test_load_tests_from_module_name_with_bogus_module_name(self):
2740
loader = TestUtil.TestLoader()
2741
self.assertRaises(ImportError, loader.loadTestsFromModuleName, 'bogus')
2744
class TestTestIdList(tests.TestCase):
2746
def _create_id_list(self, test_list):
2747
return tests.TestIdList(test_list)
2749
def _create_suite(self, test_id_list):
2751
class Stub(tests.TestCase):
2755
def _create_test_id(id):
2758
suite = TestUtil.TestSuite()
2759
for id in test_id_list:
2760
t = Stub('test_foo')
2761
t.id = _create_test_id(id)
2765
def _test_ids(self, test_suite):
2766
"""Get the ids for the tests in a test suite."""
2767
return [t.id() for t in tests.iter_suite_tests(test_suite)]
2769
def test_empty_list(self):
2770
id_list = self._create_id_list([])
2771
self.assertEquals({}, id_list.tests)
2772
self.assertEquals({}, id_list.modules)
2774
def test_valid_list(self):
2775
id_list = self._create_id_list(
2776
['mod1.cl1.meth1', 'mod1.cl1.meth2',
2777
'mod1.func1', 'mod1.cl2.meth2',
2779
'mod1.submod2.cl1.meth1', 'mod1.submod2.cl2.meth2',
2781
self.assertTrue(id_list.refers_to('mod1'))
2782
self.assertTrue(id_list.refers_to('mod1.submod1'))
2783
self.assertTrue(id_list.refers_to('mod1.submod2'))
2784
self.assertTrue(id_list.includes('mod1.cl1.meth1'))
2785
self.assertTrue(id_list.includes('mod1.submod1'))
2786
self.assertTrue(id_list.includes('mod1.func1'))
2788
def test_bad_chars_in_params(self):
2789
id_list = self._create_id_list(['mod1.cl1.meth1(xx.yy)'])
2790
self.assertTrue(id_list.refers_to('mod1'))
2791
self.assertTrue(id_list.includes('mod1.cl1.meth1(xx.yy)'))
2793
def test_module_used(self):
2794
id_list = self._create_id_list(['mod.class.meth'])
2795
self.assertTrue(id_list.refers_to('mod'))
2796
self.assertTrue(id_list.refers_to('mod.class'))
2797
self.assertTrue(id_list.refers_to('mod.class.meth'))
2799
def test_test_suite_matches_id_list_with_unknown(self):
2800
loader = TestUtil.TestLoader()
2801
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2802
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',
2804
not_found, duplicates = tests.suite_matches_id_list(suite, test_list)
2805
self.assertEquals(['bogus'], not_found)
2806
self.assertEquals([], duplicates)
2808
def test_suite_matches_id_list_with_duplicates(self):
2809
loader = TestUtil.TestLoader()
2810
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2811
dupes = loader.suiteClass()
2812
for test in tests.iter_suite_tests(suite):
2814
dupes.addTest(test) # Add it again
2816
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',]
2817
not_found, duplicates = tests.suite_matches_id_list(
2819
self.assertEquals([], not_found)
2820
self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2824
class TestTestSuite(tests.TestCase):
2826
def test__test_suite_testmod_names(self):
2827
# Test that a plausible list of test module names are returned
2828
# by _test_suite_testmod_names.
2829
test_list = tests._test_suite_testmod_names()
2831
'bzrlib.tests.blackbox',
2832
'bzrlib.tests.per_transport',
2833
'bzrlib.tests.test_selftest',
2837
def test__test_suite_modules_to_doctest(self):
2838
# Test that a plausible list of modules to doctest is returned
2839
# by _test_suite_modules_to_doctest.
2840
test_list = tests._test_suite_modules_to_doctest()
2846
def test_test_suite(self):
2847
# test_suite() loads the entire test suite to operate. To avoid this
2848
# overhead, and yet still be confident that things are happening,
2849
# we temporarily replace two functions used by test_suite with
2850
# test doubles that supply a few sample tests to load, and check they
2853
def _test_suite_testmod_names():
2854
calls.append("testmod_names")
2856
'bzrlib.tests.blackbox.test_branch',
2857
'bzrlib.tests.per_transport',
2858
'bzrlib.tests.test_selftest',
2860
original_testmod_names = tests._test_suite_testmod_names
2861
def _test_suite_modules_to_doctest():
2862
calls.append("modules_to_doctest")
2863
return ['bzrlib.timestamp']
2864
orig_modules_to_doctest = tests._test_suite_modules_to_doctest
2865
def restore_names():
2866
tests._test_suite_testmod_names = original_testmod_names
2867
tests._test_suite_modules_to_doctest = orig_modules_to_doctest
2868
self.addCleanup(restore_names)
2869
tests._test_suite_testmod_names = _test_suite_testmod_names
2870
tests._test_suite_modules_to_doctest = _test_suite_modules_to_doctest
2871
expected_test_list = [
2873
'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
2874
('bzrlib.tests.per_transport.TransportTests'
2875
'.test_abspath(LocalTransport,LocalURLServer)'),
2876
'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
2877
# modules_to_doctest
2878
'bzrlib.timestamp.format_highres_date',
2879
# plugins can't be tested that way since selftest may be run with
2882
suite = tests.test_suite()
2883
self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
2885
self.assertSubset(expected_test_list, _test_ids(suite))
2887
def test_test_suite_list_and_start(self):
2888
# We cannot test this at the same time as the main load, because we want
2889
# to know that starting_with == None works. So a second load is
2890
# incurred - note that the starting_with parameter causes a partial load
2891
# rather than a full load so this test should be pretty quick.
2892
test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
2893
suite = tests.test_suite(test_list,
2894
['bzrlib.tests.test_selftest.TestTestSuite'])
2895
# test_test_suite_list_and_start is not included
2896
self.assertEquals(test_list, _test_ids(suite))
2899
class TestLoadTestIdList(tests.TestCaseInTempDir):
2901
def _create_test_list_file(self, file_name, content):
2902
fl = open(file_name, 'wt')
2906
def test_load_unknown(self):
2907
self.assertRaises(errors.NoSuchFile,
2908
tests.load_test_id_list, 'i_do_not_exist')
2910
def test_load_test_list(self):
2911
test_list_fname = 'test.list'
2912
self._create_test_list_file(test_list_fname,
2913
'mod1.cl1.meth1\nmod2.cl2.meth2\n')
2914
tlist = tests.load_test_id_list(test_list_fname)
2915
self.assertEquals(2, len(tlist))
2916
self.assertEquals('mod1.cl1.meth1', tlist[0])
2917
self.assertEquals('mod2.cl2.meth2', tlist[1])
2919
def test_load_dirty_file(self):
2920
test_list_fname = 'test.list'
2921
self._create_test_list_file(test_list_fname,
2922
' mod1.cl1.meth1\n\nmod2.cl2.meth2 \n'
2924
tlist = tests.load_test_id_list(test_list_fname)
2925
self.assertEquals(4, len(tlist))
2926
self.assertEquals('mod1.cl1.meth1', tlist[0])
2927
self.assertEquals('', tlist[1])
2928
self.assertEquals('mod2.cl2.meth2', tlist[2])
2929
self.assertEquals('bar baz', tlist[3])
2932
class TestFilteredByModuleTestLoader(tests.TestCase):
2934
def _create_loader(self, test_list):
2935
id_filter = tests.TestIdList(test_list)
2936
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2939
def test_load_tests(self):
2940
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2941
loader = self._create_loader(test_list)
2943
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2944
self.assertEquals(test_list, _test_ids(suite))
2946
def test_exclude_tests(self):
2947
test_list = ['bogus']
2948
loader = self._create_loader(test_list)
2950
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2951
self.assertEquals([], _test_ids(suite))
2954
class TestFilteredByNameStartTestLoader(tests.TestCase):
2956
def _create_loader(self, name_start):
2957
def needs_module(name):
2958
return name.startswith(name_start) or name_start.startswith(name)
2959
loader = TestUtil.FilteredByModuleTestLoader(needs_module)
2962
def test_load_tests(self):
2963
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2964
loader = self._create_loader('bzrlib.tests.test_samp')
2966
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2967
self.assertEquals(test_list, _test_ids(suite))
2969
def test_load_tests_inside_module(self):
2970
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2971
loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
2973
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2974
self.assertEquals(test_list, _test_ids(suite))
2976
def test_exclude_tests(self):
2977
test_list = ['bogus']
2978
loader = self._create_loader('bogus')
2980
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2981
self.assertEquals([], _test_ids(suite))
2984
class TestTestPrefixRegistry(tests.TestCase):
2986
def _get_registry(self):
2987
tp_registry = tests.TestPrefixAliasRegistry()
2990
def test_register_new_prefix(self):
2991
tpr = self._get_registry()
2992
tpr.register('foo', 'fff.ooo.ooo')
2993
self.assertEquals('fff.ooo.ooo', tpr.get('foo'))
2995
def test_register_existing_prefix(self):
2996
tpr = self._get_registry()
2997
tpr.register('bar', 'bbb.aaa.rrr')
2998
tpr.register('bar', 'bBB.aAA.rRR')
2999
self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
3000
self.assertContainsRe(self._get_log(keep_log_file=True),
3001
r'.*bar.*bbb.aaa.rrr.*bBB.aAA.rRR')
3003
def test_get_unknown_prefix(self):
3004
tpr = self._get_registry()
3005
self.assertRaises(KeyError, tpr.get, 'I am not a prefix')
3007
def test_resolve_prefix(self):
3008
tpr = self._get_registry()
3009
tpr.register('bar', 'bb.aa.rr')
3010
self.assertEquals('bb.aa.rr', tpr.resolve_alias('bar'))
3012
def test_resolve_unknown_alias(self):
3013
tpr = self._get_registry()
3014
self.assertRaises(errors.BzrCommandError,
3015
tpr.resolve_alias, 'I am not a prefix')
3017
def test_predefined_prefixes(self):
3018
tpr = tests.test_prefix_alias_registry
3019
self.assertEquals('bzrlib', tpr.resolve_alias('bzrlib'))
3020
self.assertEquals('bzrlib.doc', tpr.resolve_alias('bd'))
3021
self.assertEquals('bzrlib.utils', tpr.resolve_alias('bu'))
3022
self.assertEquals('bzrlib.tests', tpr.resolve_alias('bt'))
3023
self.assertEquals('bzrlib.tests.blackbox', tpr.resolve_alias('bb'))
3024
self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
3027
class TestRunSuite(tests.TestCase):
3029
def test_runner_class(self):
3030
"""run_suite accepts and uses a runner_class keyword argument."""
3031
class Stub(tests.TestCase):
3034
suite = Stub("test_foo")
3036
class MyRunner(tests.TextTestRunner):
3037
def run(self, test):
3039
return tests.ExtendedTestResult(self.stream, self.descriptions,
3041
tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
3042
self.assertLength(1, calls)
added
removed
bzrlib/tests/test_selftest.py
