1
# Copyright (C) 2005, 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Tests for the test framework."""
21
from StringIO import StringIO
36
from bzrlib.progress import _BaseProgressBar
37
from bzrlib.repofmt import weaverepo
38
from bzrlib.symbol_versioning import (
42
from bzrlib.tests import (
49
TestCaseWithMemoryTransport,
50
TestCaseWithTransport,
63
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
64
from bzrlib.tests.TestUtil import _load_module_by_name
65
from bzrlib.trace import note
66
from bzrlib.transport.memory import MemoryServer, MemoryTransport
67
from bzrlib.version import _get_bzr_source_tree
70
class SelftestTests(TestCase):
72
def test_import_tests(self):
73
mod = _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,
81
class MetaTestLog(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 TestTreeShape(TestCaseInTempDir):
93
def test_unicode_paths(self):
94
filename = u'hell\u00d8'
96
self.build_tree_contents([(filename, 'contents of hello')])
97
except UnicodeEncodeError:
98
raise TestSkipped("can't build unicode working tree in "
99
"filesystem encoding %s" % sys.getfilesystemencoding())
100
self.failUnlessExists(filename)
103
class TestTransportProviderAdapter(TestCase):
104
"""A group of tests that test the transport implementation adaption core.
106
This is a meta test that the tests are applied to all available
109
This will be generalised in the future which is why it is in this
110
test file even though it is specific to transport tests at the moment.
113
def test_get_transport_permutations(self):
114
# this checks that we the module get_test_permutations call
115
# is made by the adapter get_transport_test_permitations method.
116
class MockModule(object):
117
def get_test_permutations(self):
118
return sample_permutation
119
sample_permutation = [(1,2), (3,4)]
120
from bzrlib.tests.test_transport_implementations \
121
import TransportTestProviderAdapter
122
adapter = TransportTestProviderAdapter()
123
self.assertEqual(sample_permutation,
124
adapter.get_transport_test_permutations(MockModule()))
126
def test_adapter_checks_all_modules(self):
127
# this checks that the adapter returns as many permurtations as
128
# there are in all the registered# transport modules for there
129
# - we assume if this matches its probably doing the right thing
130
# especially in combination with the tests for setting the right
132
from bzrlib.tests.test_transport_implementations \
133
import TransportTestProviderAdapter
134
from bzrlib.transport import _get_transport_modules
135
modules = _get_transport_modules()
136
permutation_count = 0
137
for module in modules:
139
permutation_count += len(reduce(getattr,
140
(module + ".get_test_permutations").split('.')[1:],
141
__import__(module))())
142
except errors.DependencyNotPresent:
144
input_test = TestTransportProviderAdapter(
145
"test_adapter_sets_transport_class")
146
adapter = TransportTestProviderAdapter()
147
self.assertEqual(permutation_count,
148
len(list(iter(adapter.adapt(input_test)))))
150
def test_adapter_sets_transport_class(self):
151
# Check that the test adapter inserts a transport and server into the
154
# This test used to know about all the possible transports and the
155
# order they were returned but that seems overly brittle (mbp
157
from bzrlib.tests.test_transport_implementations \
158
import TransportTestProviderAdapter
159
scenarios = TransportTestProviderAdapter().scenarios
160
# there are at least that many builtin transports
161
self.assertTrue(len(scenarios) > 6)
162
one_scenario = scenarios[0]
163
self.assertIsInstance(one_scenario[0], str)
164
self.assertTrue(issubclass(one_scenario[1]["transport_class"],
165
bzrlib.transport.Transport))
166
self.assertTrue(issubclass(one_scenario[1]["transport_server"],
167
bzrlib.transport.Server))
170
class TestBranchProviderAdapter(TestCase):
171
"""A group of tests that test the branch implementation test adapter."""
173
def test_constructor(self):
174
# check that constructor parameters are passed through to the adapted
176
from bzrlib.tests.branch_implementations import BranchTestProviderAdapter
179
formats = [("c", "C"), ("d", "D")]
180
adapter = BranchTestProviderAdapter(server1, server2, formats)
181
self.assertEqual(2, len(adapter.scenarios))
184
{'branch_format': 'c',
185
'bzrdir_format': 'C',
186
'transport_readonly_server': 'b',
187
'transport_server': 'a'}),
189
{'branch_format': 'd',
190
'bzrdir_format': 'D',
191
'transport_readonly_server': 'b',
192
'transport_server': 'a'})],
196
class TestBzrDirProviderAdapter(TestCase):
197
"""A group of tests that test the bzr dir implementation test adapter."""
199
def test_adapted_tests(self):
200
# check that constructor parameters are passed through to the adapted
202
from bzrlib.tests.bzrdir_implementations import BzrDirTestProviderAdapter
207
adapter = BzrDirTestProviderAdapter(vfs_factory,
208
server1, server2, formats)
211
{'bzrdir_format': 'c',
212
'transport_readonly_server': 'b',
213
'transport_server': 'a',
214
'vfs_transport_factory': 'v'}),
216
{'bzrdir_format': 'd',
217
'transport_readonly_server': 'b',
218
'transport_server': 'a',
219
'vfs_transport_factory': 'v'})],
223
class TestRepositoryProviderAdapter(TestCase):
224
"""A group of tests that test the repository implementation test adapter."""
226
def test_constructor(self):
227
# check that constructor parameters are passed through to the
229
from bzrlib.tests.repository_implementations import RepositoryTestProviderAdapter
232
formats = [("c", "C"), ("d", "D")]
233
adapter = RepositoryTestProviderAdapter(server1, server2, formats)
236
{'bzrdir_format': 'C',
237
'repository_format': 'c',
238
'transport_readonly_server': 'b',
239
'transport_server': 'a'}),
241
{'bzrdir_format': 'D',
242
'repository_format': 'd',
243
'transport_readonly_server': 'b',
244
'transport_server': 'a'})],
247
def test_setting_vfs_transport(self):
248
"""The vfs_transport_factory can be set optionally."""
249
from bzrlib.tests.repository_implementations import RepositoryTestProviderAdapter
250
formats = [("a", "b"), ("c", "d")]
251
adapter = RepositoryTestProviderAdapter(None, None, formats,
252
vfs_transport_factory="vfs")
255
{'bzrdir_format': 'b',
256
'repository_format': 'a',
257
'transport_readonly_server': None,
258
'transport_server': None,
259
'vfs_transport_factory': 'vfs'}),
261
{'bzrdir_format': 'd',
262
'repository_format': 'c',
263
'transport_readonly_server': None,
264
'transport_server': None,
265
'vfs_transport_factory': 'vfs'})],
268
def test_formats_to_scenarios(self):
269
"""The adapter can generate all the scenarios needed."""
270
from bzrlib.tests.repository_implementations import RepositoryTestProviderAdapter
271
no_vfs_adapter = RepositoryTestProviderAdapter("server", "readonly",
273
vfs_adapter = RepositoryTestProviderAdapter("server", "readonly",
274
[], vfs_transport_factory="vfs")
275
# no_vfs generate scenarios without vfs_transport_factor
276
formats = [("c", "C"), (1, "D")]
279
{'bzrdir_format': 'C',
280
'repository_format': 'c',
281
'transport_readonly_server': 'readonly',
282
'transport_server': 'server'}),
284
{'bzrdir_format': 'D',
285
'repository_format': 1,
286
'transport_readonly_server': 'readonly',
287
'transport_server': 'server'})],
288
no_vfs_adapter.formats_to_scenarios(formats))
291
{'bzrdir_format': 'C',
292
'repository_format': 'c',
293
'transport_readonly_server': 'readonly',
294
'transport_server': 'server',
295
'vfs_transport_factory': 'vfs'}),
297
{'bzrdir_format': 'D',
298
'repository_format': 1,
299
'transport_readonly_server': 'readonly',
300
'transport_server': 'server',
301
'vfs_transport_factory': 'vfs'})],
302
vfs_adapter.formats_to_scenarios(formats))
305
class TestTestScenarioApplier(TestCase):
306
"""Tests for the test adaption facilities."""
308
def test_adapt_applies_scenarios(self):
309
from bzrlib.tests.repository_implementations import TestScenarioApplier
310
input_test = TestTestScenarioApplier("test_adapt_test_to_scenario")
311
adapter = TestScenarioApplier()
312
adapter.scenarios = [("1", "dict"), ("2", "settings")]
314
def capture_call(test, scenario):
315
calls.append((test, scenario))
317
adapter.adapt_test_to_scenario = capture_call
318
adapter.adapt(input_test)
319
self.assertEqual([(input_test, ("1", "dict")),
320
(input_test, ("2", "settings"))], calls)
322
def test_adapt_test_to_scenario(self):
323
from bzrlib.tests.repository_implementations import TestScenarioApplier
324
input_test = TestTestScenarioApplier("test_adapt_test_to_scenario")
325
adapter = TestScenarioApplier()
326
# setup two adapted tests
327
adapted_test1 = adapter.adapt_test_to_scenario(input_test,
329
{"bzrdir_format":"bzr_format",
330
"repository_format":"repo_fmt",
331
"transport_server":"transport_server",
332
"transport_readonly_server":"readonly-server"}))
333
adapted_test2 = adapter.adapt_test_to_scenario(input_test,
334
("new id 2", {"bzrdir_format":None}))
335
# input_test should have been altered.
336
self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
337
# the new tests are mutually incompatible, ensuring it has
338
# made new ones, and unspecified elements in the scenario
339
# should not have been altered.
340
self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
341
self.assertEqual("repo_fmt", adapted_test1.repository_format)
342
self.assertEqual("transport_server", adapted_test1.transport_server)
343
self.assertEqual("readonly-server",
344
adapted_test1.transport_readonly_server)
346
"bzrlib.tests.test_selftest.TestTestScenarioApplier."
347
"test_adapt_test_to_scenario(new id)",
349
self.assertEqual(None, adapted_test2.bzrdir_format)
351
"bzrlib.tests.test_selftest.TestTestScenarioApplier."
352
"test_adapt_test_to_scenario(new id 2)",
356
class TestInterRepositoryProviderAdapter(TestCase):
357
"""A group of tests that test the InterRepository test adapter."""
359
def test_adapted_tests(self):
360
# check that constructor parameters are passed through to the adapted
362
from bzrlib.tests.interrepository_implementations import \
363
InterRepositoryTestProviderAdapter
366
formats = [(str, "C1", "C2"), (int, "D1", "D2")]
367
adapter = InterRepositoryTestProviderAdapter(server1, server2, formats)
370
{'interrepo_class': str,
371
'repository_format': 'C1',
372
'repository_format_to': 'C2',
373
'transport_readonly_server': 'b',
374
'transport_server': 'a'}),
376
{'interrepo_class': int,
377
'repository_format': 'D1',
378
'repository_format_to': 'D2',
379
'transport_readonly_server': 'b',
380
'transport_server': 'a'})],
381
adapter.formats_to_scenarios(formats))
384
class TestInterVersionedFileProviderAdapter(TestCase):
385
"""A group of tests that test the InterVersionedFile test adapter."""
387
def test_scenarios(self):
388
# check that constructor parameters are passed through to the adapted
390
from bzrlib.tests.interversionedfile_implementations \
391
import InterVersionedFileTestProviderAdapter
394
formats = [(str, "C1", "C2"), (int, "D1", "D2")]
395
adapter = InterVersionedFileTestProviderAdapter(server1, server2, formats)
398
{'interversionedfile_class':str,
399
'transport_readonly_server': 'b',
400
'transport_server': 'a',
401
'versionedfile_factory': 'C1',
402
'versionedfile_factory_to': 'C2'}),
404
{'interversionedfile_class': int,
405
'transport_readonly_server': 'b',
406
'transport_server': 'a',
407
'versionedfile_factory': 'D1',
408
'versionedfile_factory_to': 'D2'})],
412
class TestRevisionStoreProviderAdapter(TestCase):
413
"""A group of tests that test the RevisionStore test adapter."""
415
def test_scenarios(self):
416
# check that constructor parameters are passed through to the adapted
418
from bzrlib.tests.revisionstore_implementations \
419
import RevisionStoreTestProviderAdapter
420
# revision stores need a store factory - i.e. RevisionKnit
421
#, a readonly and rw transport
425
store_factories = ["c", "d"]
426
adapter = RevisionStoreTestProviderAdapter(server1, server2, store_factories)
429
{'store_factory': 'c',
430
'transport_readonly_server': 'b',
431
'transport_server': 'a'}),
433
{'store_factory': 'd',
434
'transport_readonly_server': 'b',
435
'transport_server': 'a'})],
439
class TestWorkingTreeProviderAdapter(TestCase):
440
"""A group of tests that test the workingtree implementation test adapter."""
442
def test_scenarios(self):
443
# check that constructor parameters are passed through to the adapted
445
from bzrlib.tests.workingtree_implementations \
446
import WorkingTreeTestProviderAdapter
449
formats = [("c", "C"), ("d", "D")]
450
adapter = WorkingTreeTestProviderAdapter(server1, server2, formats)
453
{'bzrdir_format': 'C',
454
'transport_readonly_server': 'b',
455
'transport_server': 'a',
456
'workingtree_format': 'c'}),
458
{'bzrdir_format': 'D',
459
'transport_readonly_server': 'b',
460
'transport_server': 'a',
461
'workingtree_format': 'd'})],
465
class TestTreeProviderAdapter(TestCase):
466
"""Test the setup of tree_implementation tests."""
468
def test_adapted_tests(self):
469
# the tree implementation adapter is meant to setup one instance for
470
# each working tree format, and one additional instance that will
471
# use the default wt format, but create a revision tree for the tests.
472
# this means that the wt ones should have the workingtree_to_test_tree
473
# attribute set to 'return_parameter' and the revision one set to
474
# revision_tree_from_workingtree.
476
from bzrlib.tests.tree_implementations import (
477
TreeTestProviderAdapter,
479
revision_tree_from_workingtree
481
from bzrlib.workingtree import WorkingTreeFormat, WorkingTreeFormat3
482
input_test = TestTreeProviderAdapter(
483
"test_adapted_tests")
486
formats = [("c", "C"), ("d", "D")]
487
adapter = TreeTestProviderAdapter(server1, server2, formats)
488
suite = adapter.adapt(input_test)
489
tests = list(iter(suite))
490
self.assertEqual(4, len(tests))
491
# this must match the default format setp up in
492
# TreeTestProviderAdapter.adapt
493
default_format = WorkingTreeFormat3
494
self.assertEqual(tests[0].workingtree_format, formats[0][0])
495
self.assertEqual(tests[0].bzrdir_format, formats[0][1])
496
self.assertEqual(tests[0].transport_server, server1)
497
self.assertEqual(tests[0].transport_readonly_server, server2)
498
self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
499
self.assertEqual(tests[1].workingtree_format, formats[1][0])
500
self.assertEqual(tests[1].bzrdir_format, formats[1][1])
501
self.assertEqual(tests[1].transport_server, server1)
502
self.assertEqual(tests[1].transport_readonly_server, server2)
503
self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
504
self.assertIsInstance(tests[2].workingtree_format, default_format)
505
#self.assertEqual(tests[2].bzrdir_format,
506
# default_format._matchingbzrdir)
507
self.assertEqual(tests[2].transport_server, server1)
508
self.assertEqual(tests[2].transport_readonly_server, server2)
509
self.assertEqual(tests[2].workingtree_to_test_tree,
510
revision_tree_from_workingtree)
513
class TestInterTreeProviderAdapter(TestCase):
514
"""A group of tests that test the InterTreeTestAdapter."""
516
def test_adapted_tests(self):
517
# check that constructor parameters are passed through to the adapted
519
# for InterTree tests we want the machinery to bring up two trees in
520
# each instance: the base one, and the one we are interacting with.
521
# because each optimiser can be direction specific, we need to test
522
# each optimiser in its chosen direction.
523
# unlike the TestProviderAdapter we dont want to automatically add a
524
# parameterised one for WorkingTree - the optimisers will tell us what
526
from bzrlib.tests.tree_implementations import (
528
revision_tree_from_workingtree
530
from bzrlib.tests.intertree_implementations import (
531
InterTreeTestProviderAdapter,
533
from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
534
input_test = TestInterTreeProviderAdapter(
535
"test_adapted_tests")
538
format1 = WorkingTreeFormat2()
539
format2 = WorkingTreeFormat3()
540
formats = [(str, format1, format2, "converter1"),
541
(int, format2, format1, "converter2")]
542
adapter = InterTreeTestProviderAdapter(server1, server2, formats)
543
suite = adapter.adapt(input_test)
544
tests = list(iter(suite))
545
self.assertEqual(2, len(tests))
546
self.assertEqual(tests[0].intertree_class, formats[0][0])
547
self.assertEqual(tests[0].workingtree_format, formats[0][1])
548
self.assertEqual(tests[0].workingtree_format_to, formats[0][2])
549
self.assertEqual(tests[0].mutable_trees_to_test_trees, formats[0][3])
550
self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
551
self.assertEqual(tests[0].transport_server, server1)
552
self.assertEqual(tests[0].transport_readonly_server, server2)
553
self.assertEqual(tests[1].intertree_class, formats[1][0])
554
self.assertEqual(tests[1].workingtree_format, formats[1][1])
555
self.assertEqual(tests[1].workingtree_format_to, formats[1][2])
556
self.assertEqual(tests[1].mutable_trees_to_test_trees, formats[1][3])
557
self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
558
self.assertEqual(tests[1].transport_server, server1)
559
self.assertEqual(tests[1].transport_readonly_server, server2)
562
class TestTestCaseInTempDir(TestCaseInTempDir):
564
def test_home_is_not_working(self):
565
self.assertNotEqual(self.test_dir, self.test_home_dir)
566
cwd = osutils.getcwd()
567
self.assertEqual(self.test_dir, cwd)
568
self.assertEqual(self.test_home_dir, os.environ['HOME'])
571
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
573
def test_home_is_non_existant_dir_under_root(self):
574
"""The test_home_dir for TestCaseWithMemoryTransport is missing.
576
This is because TestCaseWithMemoryTransport is for tests that do not
577
need any disk resources: they should be hooked into bzrlib in such a
578
way that no global settings are being changed by the test (only a
579
few tests should need to do that), and having a missing dir as home is
580
an effective way to ensure that this is the case.
582
self.assertEqual(self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
584
self.assertEqual(self.test_home_dir, os.environ['HOME'])
586
def test_cwd_is_TEST_ROOT(self):
587
self.assertEqual(self.test_dir, self.TEST_ROOT)
588
cwd = osutils.getcwd()
589
self.assertEqual(self.test_dir, cwd)
591
def test_make_branch_and_memory_tree(self):
592
"""In TestCaseWithMemoryTransport we should not make the branch on disk.
594
This is hard to comprehensively robustly test, so we settle for making
595
a branch and checking no directory was created at its relpath.
597
tree = self.make_branch_and_memory_tree('dir')
598
# Guard against regression into MemoryTransport leaking
599
# files to disk instead of keeping them in memory.
600
self.failIf(osutils.lexists('dir'))
601
self.assertIsInstance(tree, memorytree.MemoryTree)
603
def test_make_branch_and_memory_tree_with_format(self):
604
"""make_branch_and_memory_tree should accept a format option."""
605
format = bzrdir.BzrDirMetaFormat1()
606
format.repository_format = weaverepo.RepositoryFormat7()
607
tree = self.make_branch_and_memory_tree('dir', format=format)
608
# Guard against regression into MemoryTransport leaking
609
# files to disk instead of keeping them in memory.
610
self.failIf(osutils.lexists('dir'))
611
self.assertIsInstance(tree, memorytree.MemoryTree)
612
self.assertEqual(format.repository_format.__class__,
613
tree.branch.repository._format.__class__)
616
class TestTestCaseWithTransport(TestCaseWithTransport):
617
"""Tests for the convenience functions TestCaseWithTransport introduces."""
619
def test_get_readonly_url_none(self):
620
from bzrlib.transport import get_transport
621
from bzrlib.transport.memory import MemoryServer
622
from bzrlib.transport.readonly import ReadonlyTransportDecorator
623
self.vfs_transport_factory = MemoryServer
624
self.transport_readonly_server = None
625
# calling get_readonly_transport() constructs a decorator on the url
627
url = self.get_readonly_url()
628
url2 = self.get_readonly_url('foo/bar')
629
t = get_transport(url)
630
t2 = get_transport(url2)
631
self.failUnless(isinstance(t, ReadonlyTransportDecorator))
632
self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
633
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
635
def test_get_readonly_url_http(self):
636
from bzrlib.tests.HttpServer import HttpServer
637
from bzrlib.transport import get_transport
638
from bzrlib.transport.local import LocalURLServer
639
from bzrlib.transport.http import HttpTransportBase
640
self.transport_server = LocalURLServer
641
self.transport_readonly_server = HttpServer
642
# calling get_readonly_transport() gives us a HTTP server instance.
643
url = self.get_readonly_url()
644
url2 = self.get_readonly_url('foo/bar')
645
# the transport returned may be any HttpTransportBase subclass
646
t = get_transport(url)
647
t2 = get_transport(url2)
648
self.failUnless(isinstance(t, HttpTransportBase))
649
self.failUnless(isinstance(t2, HttpTransportBase))
650
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
652
def test_is_directory(self):
653
"""Test assertIsDirectory assertion"""
654
t = self.get_transport()
655
self.build_tree(['a_dir/', 'a_file'], transport=t)
656
self.assertIsDirectory('a_dir', t)
657
self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
658
self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
661
class TestTestCaseTransports(TestCaseWithTransport):
664
super(TestTestCaseTransports, self).setUp()
665
self.vfs_transport_factory = MemoryServer
667
def test_make_bzrdir_preserves_transport(self):
668
t = self.get_transport()
669
result_bzrdir = self.make_bzrdir('subdir')
670
self.assertIsInstance(result_bzrdir.transport,
672
# should not be on disk, should only be in memory
673
self.failIfExists('subdir')
676
class TestChrootedTest(ChrootedTestCase):
678
def test_root_is_root(self):
679
from bzrlib.transport import get_transport
680
t = get_transport(self.get_readonly_url())
682
self.assertEqual(url, t.clone('..').base)
685
class MockProgress(_BaseProgressBar):
686
"""Progress-bar standin that records calls.
688
Useful for testing pb using code.
692
_BaseProgressBar.__init__(self)
696
self.calls.append(('tick',))
698
def update(self, msg=None, current=None, total=None):
699
self.calls.append(('update', msg, current, total))
702
self.calls.append(('clear',))
704
def note(self, msg, *args):
705
self.calls.append(('note', msg, args))
708
class TestTestResult(TestCase):
710
def check_timing(self, test_case, expected_re):
711
result = bzrlib.tests.TextTestResult(self._log_file,
715
test_case.run(result)
716
timed_string = result._testTimeString(test_case)
717
self.assertContainsRe(timed_string, expected_re)
719
def test_test_reporting(self):
720
class ShortDelayTestCase(TestCase):
721
def test_short_delay(self):
723
def test_short_benchmark(self):
724
self.time(time.sleep, 0.003)
725
self.check_timing(ShortDelayTestCase('test_short_delay'),
727
# if a benchmark time is given, we want a x of y style result.
728
self.check_timing(ShortDelayTestCase('test_short_benchmark'),
729
r"^ +[0-9]+ms/ +[0-9]+ms$")
731
def test_unittest_reporting_unittest_class(self):
732
# getting the time from a non-bzrlib test works ok
733
class ShortDelayTestCase(unittest.TestCase):
734
def test_short_delay(self):
736
self.check_timing(ShortDelayTestCase('test_short_delay'),
739
def test_assigned_benchmark_file_stores_date(self):
741
result = bzrlib.tests.TextTestResult(self._log_file,
746
output_string = output.getvalue()
747
# if you are wondering about the regexp please read the comment in
748
# test_bench_history (bzrlib.tests.test_selftest.TestRunner)
749
# XXX: what comment? -- Andrew Bennetts
750
self.assertContainsRe(output_string, "--date [0-9.]+")
752
def test_benchhistory_records_test_times(self):
753
result_stream = StringIO()
754
result = bzrlib.tests.TextTestResult(
758
bench_history=result_stream
761
# we want profile a call and check that its test duration is recorded
762
# make a new test instance that when run will generate a benchmark
763
example_test_case = TestTestResult("_time_hello_world_encoding")
764
# execute the test, which should succeed and record times
765
example_test_case.run(result)
766
lines = result_stream.getvalue().splitlines()
767
self.assertEqual(2, len(lines))
768
self.assertContainsRe(lines[1],
769
" *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
770
"._time_hello_world_encoding")
772
def _time_hello_world_encoding(self):
773
"""Profile two sleep calls
775
This is used to exercise the test framework.
777
self.time(unicode, 'hello', errors='replace')
778
self.time(unicode, 'world', errors='replace')
780
def test_lsprofiling(self):
781
"""Verbose test result prints lsprof statistics from test cases."""
782
self.requireFeature(test_lsprof.LSProfFeature)
783
result_stream = StringIO()
784
result = bzrlib.tests.VerboseTestResult(
785
unittest._WritelnDecorator(result_stream),
789
# we want profile a call of some sort and check it is output by
790
# addSuccess. We dont care about addError or addFailure as they
791
# are not that interesting for performance tuning.
792
# make a new test instance that when run will generate a profile
793
example_test_case = TestTestResult("_time_hello_world_encoding")
794
example_test_case._gather_lsprof_in_benchmarks = True
795
# execute the test, which should succeed and record profiles
796
example_test_case.run(result)
797
# lsprofile_something()
798
# if this worked we want
799
# LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
800
# CallCount Recursive Total(ms) Inline(ms) module:lineno(function)
801
# (the lsprof header)
802
# ... an arbitrary number of lines
803
# and the function call which is time.sleep.
804
# 1 0 ??? ??? ???(sleep)
805
# and then repeated but with 'world', rather than 'hello'.
806
# this should appear in the output stream of our test result.
807
output = result_stream.getvalue()
808
self.assertContainsRe(output,
809
r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
810
self.assertContainsRe(output,
811
r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
812
self.assertContainsRe(output,
813
r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
814
self.assertContainsRe(output,
815
r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
817
def test_known_failure(self):
818
"""A KnownFailure being raised should trigger several result actions."""
819
class InstrumentedTestResult(ExtendedTestResult):
821
def report_test_start(self, test): pass
822
def report_known_failure(self, test, err):
823
self._call = test, err
824
result = InstrumentedTestResult(None, None, None, None)
826
raise KnownFailure('failed!')
827
test = unittest.FunctionTestCase(test_function)
829
# it should invoke 'report_known_failure'.
830
self.assertEqual(2, len(result._call))
831
self.assertEqual(test, result._call[0])
832
self.assertEqual(KnownFailure, result._call[1][0])
833
self.assertIsInstance(result._call[1][1], KnownFailure)
834
# we dont introspec the traceback, if the rest is ok, it would be
835
# exceptional for it not to be.
836
# it should update the known_failure_count on the object.
837
self.assertEqual(1, result.known_failure_count)
838
# the result should be successful.
839
self.assertTrue(result.wasSuccessful())
841
def test_verbose_report_known_failure(self):
842
# verbose test output formatting
843
result_stream = StringIO()
844
result = bzrlib.tests.VerboseTestResult(
845
unittest._WritelnDecorator(result_stream),
849
test = self.get_passing_test()
850
result.startTest(test)
851
prefix = len(result_stream.getvalue())
852
# the err parameter has the shape:
853
# (class, exception object, traceback)
854
# KnownFailures dont get their tracebacks shown though, so we
856
err = (KnownFailure, KnownFailure('foo'), None)
857
result.report_known_failure(test, err)
858
output = result_stream.getvalue()[prefix:]
859
lines = output.splitlines()
860
self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
861
self.assertEqual(lines[1], ' foo')
862
self.assertEqual(2, len(lines))
864
def test_text_report_known_failure(self):
865
# text test output formatting
867
result = bzrlib.tests.TextTestResult(
873
test = self.get_passing_test()
874
# this seeds the state to handle reporting the test.
875
result.startTest(test)
876
# the err parameter has the shape:
877
# (class, exception object, traceback)
878
# KnownFailures dont get their tracebacks shown though, so we
880
err = (KnownFailure, KnownFailure('foo'), None)
881
result.report_known_failure(test, err)
884
('update', '[1 in 0s] passing_test', None, None),
885
('note', 'XFAIL: %s\n%s\n', ('passing_test', err[1]))
888
# known_failures should be printed in the summary, so if we run a test
889
# after there are some known failures, the update prefix should match
891
result.known_failure_count = 3
895
('update', '[2 in 0s, 3 known failures] passing_test', None, None),
899
def get_passing_test(self):
900
"""Return a test object that can't be run usefully."""
903
return unittest.FunctionTestCase(passing_test)
905
def test_add_not_supported(self):
906
"""Test the behaviour of invoking addNotSupported."""
907
class InstrumentedTestResult(ExtendedTestResult):
908
def report_test_start(self, test): pass
909
def report_unsupported(self, test, feature):
910
self._call = test, feature
911
result = InstrumentedTestResult(None, None, None, None)
912
test = SampleTestCase('_test_pass')
914
result.startTest(test)
915
result.addNotSupported(test, feature)
916
# it should invoke 'report_unsupported'.
917
self.assertEqual(2, len(result._call))
918
self.assertEqual(test, result._call[0])
919
self.assertEqual(feature, result._call[1])
920
# the result should be successful.
921
self.assertTrue(result.wasSuccessful())
922
# it should record the test against a count of tests not run due to
924
self.assertEqual(1, result.unsupported['Feature'])
925
# and invoking it again should increment that counter
926
result.addNotSupported(test, feature)
927
self.assertEqual(2, result.unsupported['Feature'])
929
def test_verbose_report_unsupported(self):
930
# verbose test output formatting
931
result_stream = StringIO()
932
result = bzrlib.tests.VerboseTestResult(
933
unittest._WritelnDecorator(result_stream),
937
test = self.get_passing_test()
939
result.startTest(test)
940
prefix = len(result_stream.getvalue())
941
result.report_unsupported(test, feature)
942
output = result_stream.getvalue()[prefix:]
943
lines = output.splitlines()
944
self.assertEqual(lines, ['NODEP 0ms', " The feature 'Feature' is not available."])
946
def test_text_report_unsupported(self):
947
# text test output formatting
949
result = bzrlib.tests.TextTestResult(
955
test = self.get_passing_test()
957
# this seeds the state to handle reporting the test.
958
result.startTest(test)
959
result.report_unsupported(test, feature)
960
# no output on unsupported features
962
[('update', '[1 in 0s] passing_test', None, None)
965
# the number of missing features should be printed in the progress
966
# summary, so check for that.
967
result.unsupported = {'foo':0, 'bar':0}
971
('update', '[2 in 0s, 2 missing features] passing_test', None, None),
975
def test_unavailable_exception(self):
976
"""An UnavailableFeature being raised should invoke addNotSupported."""
977
class InstrumentedTestResult(ExtendedTestResult):
979
def report_test_start(self, test): pass
980
def addNotSupported(self, test, feature):
981
self._call = test, feature
982
result = InstrumentedTestResult(None, None, None, None)
985
raise UnavailableFeature(feature)
986
test = unittest.FunctionTestCase(test_function)
988
# it should invoke 'addNotSupported'.
989
self.assertEqual(2, len(result._call))
990
self.assertEqual(test, result._call[0])
991
self.assertEqual(feature, result._call[1])
992
# and not count as an error
993
self.assertEqual(0, result.error_count)
995
def test_strict_with_unsupported_feature(self):
996
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
998
test = self.get_passing_test()
999
feature = "Unsupported Feature"
1000
result.addNotSupported(test, feature)
1001
self.assertFalse(result.wasStrictlySuccessful())
1002
self.assertEqual(None, result._extractBenchmarkTime(test))
1004
def test_strict_with_known_failure(self):
1005
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
1007
test = self.get_passing_test()
1008
err = (KnownFailure, KnownFailure('foo'), None)
1009
result._addKnownFailure(test, err)
1010
self.assertFalse(result.wasStrictlySuccessful())
1011
self.assertEqual(None, result._extractBenchmarkTime(test))
1013
def test_strict_with_success(self):
1014
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
1016
test = self.get_passing_test()
1017
result.addSuccess(test)
1018
self.assertTrue(result.wasStrictlySuccessful())
1019
self.assertEqual(None, result._extractBenchmarkTime(test))
1022
class TestRunner(TestCase):
1024
def dummy_test(self):
1027
def run_test_runner(self, testrunner, test):
1028
"""Run suite in testrunner, saving global state and restoring it.
1030
This current saves and restores:
1031
TestCaseInTempDir.TEST_ROOT
1033
There should be no tests in this file that use bzrlib.tests.TextTestRunner
1034
without using this convenience method, because of our use of global state.
1036
old_root = TestCaseInTempDir.TEST_ROOT
1038
TestCaseInTempDir.TEST_ROOT = None
1039
return testrunner.run(test)
1041
TestCaseInTempDir.TEST_ROOT = old_root
1043
def test_known_failure_failed_run(self):
1044
# run a test that generates a known failure which should be printed in
1045
# the final output when real failures occur.
1046
def known_failure_test():
1047
raise KnownFailure('failed')
1048
test = unittest.TestSuite()
1049
test.addTest(unittest.FunctionTestCase(known_failure_test))
1051
raise AssertionError('foo')
1052
test.addTest(unittest.FunctionTestCase(failing_test))
1054
runner = TextTestRunner(stream=stream)
1055
result = self.run_test_runner(runner, test)
1056
lines = stream.getvalue().splitlines()
1059
'======================================================================',
1060
'FAIL: unittest.FunctionTestCase (failing_test)',
1061
'----------------------------------------------------------------------',
1062
'Traceback (most recent call last):',
1063
' raise AssertionError(\'foo\')',
1064
'AssertionError: foo',
1066
'----------------------------------------------------------------------',
1068
'FAILED (failures=1, known_failure_count=1)'],
1069
lines[0:5] + lines[6:10] + lines[11:])
1071
def test_known_failure_ok_run(self):
1072
# run a test that generates a known failure which should be printed in the final output.
1073
def known_failure_test():
1074
raise KnownFailure('failed')
1075
test = unittest.FunctionTestCase(known_failure_test)
1077
runner = TextTestRunner(stream=stream)
1078
result = self.run_test_runner(runner, test)
1079
self.assertContainsRe(stream.getvalue(),
1082
'Ran 1 test in .*\n'
1084
'OK \\(known_failures=1\\)\n')
1086
def test_skipped_test(self):
1087
# run a test that is skipped, and check the suite as a whole still
1089
# skipping_test must be hidden in here so it's not run as a real test
1090
def skipping_test():
1091
raise TestSkipped('test intentionally skipped')
1093
runner = TextTestRunner(stream=self._log_file)
1094
test = unittest.FunctionTestCase(skipping_test)
1095
result = self.run_test_runner(runner, test)
1096
self.assertTrue(result.wasSuccessful())
1098
def test_skipped_from_setup(self):
1099
class SkippedSetupTest(TestCase):
1103
self.addCleanup(self.cleanup)
1104
raise TestSkipped('skipped setup')
1106
def test_skip(self):
1107
self.fail('test reached')
1112
runner = 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(0, test.counter)
1119
def test_skipped_from_test(self):
1120
class SkippedTest(TestCase):
1124
self.addCleanup(self.cleanup)
1126
def test_skip(self):
1127
raise TestSkipped('skipped test')
1132
runner = TextTestRunner(stream=self._log_file)
1133
test = SkippedTest('test_skip')
1134
result = self.run_test_runner(runner, test)
1135
self.assertTrue(result.wasSuccessful())
1136
# Check if cleanup was called the right number of times.
1137
self.assertEqual(0, test.counter)
1139
def test_not_applicable(self):
1140
# run a test that is skipped because it's not applicable
1141
def not_applicable_test():
1142
from bzrlib.tests import TestNotApplicable
1143
raise TestNotApplicable('this test never runs')
1145
runner = TextTestRunner(stream=out, verbosity=2)
1146
test = unittest.FunctionTestCase(not_applicable_test)
1147
result = self.run_test_runner(runner, test)
1148
self._log_file.write(out.getvalue())
1149
self.assertTrue(result.wasSuccessful())
1150
self.assertTrue(result.wasStrictlySuccessful())
1151
self.assertContainsRe(out.getvalue(),
1152
r'(?m)not_applicable_test * N/A')
1153
self.assertContainsRe(out.getvalue(),
1154
r'(?m)^ this test never runs')
1156
def test_not_applicable_demo(self):
1157
# just so you can see it in the test output
1158
raise TestNotApplicable('this test is just a demonstation')
1160
def test_unsupported_features_listed(self):
1161
"""When unsupported features are encountered they are detailed."""
1162
class Feature1(Feature):
1163
def _probe(self): return False
1164
class Feature2(Feature):
1165
def _probe(self): return False
1166
# create sample tests
1167
test1 = SampleTestCase('_test_pass')
1168
test1._test_needs_features = [Feature1()]
1169
test2 = SampleTestCase('_test_pass')
1170
test2._test_needs_features = [Feature2()]
1171
test = unittest.TestSuite()
1175
runner = TextTestRunner(stream=stream)
1176
result = self.run_test_runner(runner, test)
1177
lines = stream.getvalue().splitlines()
1180
"Missing feature 'Feature1' skipped 1 tests.",
1181
"Missing feature 'Feature2' skipped 1 tests.",
1185
def test_bench_history(self):
1186
# tests that the running the benchmark produces a history file
1187
# containing a timestamp and the revision id of the bzrlib source which
1189
workingtree = _get_bzr_source_tree()
1190
test = TestRunner('dummy_test')
1192
runner = TextTestRunner(stream=self._log_file, bench_history=output)
1193
result = self.run_test_runner(runner, test)
1194
output_string = output.getvalue()
1195
self.assertContainsRe(output_string, "--date [0-9.]+")
1196
if workingtree is not None:
1197
revision_id = workingtree.get_parent_ids()[0]
1198
self.assertEndsWith(output_string.rstrip(), revision_id)
1200
def test_success_log_deleted(self):
1201
"""Successful tests have their log deleted"""
1203
class LogTester(TestCase):
1205
def test_success(self):
1206
self.log('this will be removed\n')
1208
sio = cStringIO.StringIO()
1209
runner = TextTestRunner(stream=sio)
1210
test = LogTester('test_success')
1211
result = self.run_test_runner(runner, test)
1213
log = test._get_log()
1214
self.assertEqual("DELETED log file to reduce memory footprint", log)
1215
self.assertEqual('', test._log_contents)
1216
self.assertIs(None, test._log_file_name)
1218
def test_fail_log_kept(self):
1219
"""Failed tests have their log kept"""
1221
class LogTester(TestCase):
1223
def test_fail(self):
1224
self.log('this will be kept\n')
1225
self.fail('this test fails')
1227
sio = cStringIO.StringIO()
1228
runner = TextTestRunner(stream=sio)
1229
test = LogTester('test_fail')
1230
result = self.run_test_runner(runner, test)
1232
text = sio.getvalue()
1233
self.assertContainsRe(text, 'this will be kept')
1234
self.assertContainsRe(text, 'this test fails')
1236
log = test._get_log()
1237
self.assertContainsRe(log, 'this will be kept')
1238
self.assertEqual(log, test._log_contents)
1240
def test_error_log_kept(self):
1241
"""Tests with errors have their log kept"""
1243
class LogTester(TestCase):
1245
def test_error(self):
1246
self.log('this will be kept\n')
1247
raise ValueError('random exception raised')
1249
sio = cStringIO.StringIO()
1250
runner = TextTestRunner(stream=sio)
1251
test = LogTester('test_error')
1252
result = self.run_test_runner(runner, test)
1254
text = sio.getvalue()
1255
self.assertContainsRe(text, 'this will be kept')
1256
self.assertContainsRe(text, 'random exception raised')
1258
log = test._get_log()
1259
self.assertContainsRe(log, 'this will be kept')
1260
self.assertEqual(log, test._log_contents)
1263
class SampleTestCase(TestCase):
1265
def _test_pass(self):
1269
class TestTestCase(TestCase):
1270
"""Tests that test the core bzrlib TestCase."""
1272
def test_debug_flags_sanitised(self):
1273
"""The bzrlib debug flags should be sanitised by setUp."""
1274
# we could set something and run a test that will check
1275
# it gets santised, but this is probably sufficient for now:
1276
# if someone runs the test with -Dsomething it will error.
1277
self.assertEqual(set(), bzrlib.debug.debug_flags)
1279
def inner_test(self):
1280
# the inner child test
1283
def outer_child(self):
1284
# the outer child test
1286
self.inner_test = TestTestCase("inner_child")
1287
result = bzrlib.tests.TextTestResult(self._log_file,
1290
self.inner_test.run(result)
1291
note("outer finish")
1293
def test_trace_nesting(self):
1294
# this tests that each test case nests its trace facility correctly.
1295
# we do this by running a test case manually. That test case (A)
1296
# should setup a new log, log content to it, setup a child case (B),
1297
# which should log independently, then case (A) should log a trailer
1299
# we do two nested children so that we can verify the state of the
1300
# logs after the outer child finishes is correct, which a bad clean
1301
# up routine in tearDown might trigger a fault in our test with only
1302
# one child, we should instead see the bad result inside our test with
1304
# the outer child test
1305
original_trace = bzrlib.trace._trace_file
1306
outer_test = TestTestCase("outer_child")
1307
result = bzrlib.tests.TextTestResult(self._log_file,
1310
outer_test.run(result)
1311
self.assertEqual(original_trace, bzrlib.trace._trace_file)
1313
def method_that_times_a_bit_twice(self):
1314
# call self.time twice to ensure it aggregates
1315
self.time(time.sleep, 0.007)
1316
self.time(time.sleep, 0.007)
1318
def test_time_creates_benchmark_in_result(self):
1319
"""Test that the TestCase.time() method accumulates a benchmark time."""
1320
sample_test = TestTestCase("method_that_times_a_bit_twice")
1321
output_stream = StringIO()
1322
result = bzrlib.tests.VerboseTestResult(
1323
unittest._WritelnDecorator(output_stream),
1326
num_tests=sample_test.countTestCases())
1327
sample_test.run(result)
1328
self.assertContainsRe(
1329
output_stream.getvalue(),
1330
r"\d+ms/ +\d+ms\n$")
1332
def test_hooks_sanitised(self):
1333
"""The bzrlib hooks should be sanitised by setUp."""
1334
self.assertEqual(bzrlib.branch.BranchHooks(),
1335
bzrlib.branch.Branch.hooks)
1336
self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
1337
bzrlib.smart.server.SmartTCPServer.hooks)
1339
def test__gather_lsprof_in_benchmarks(self):
1340
"""When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1342
Each self.time() call is individually and separately profiled.
1344
self.requireFeature(test_lsprof.LSProfFeature)
1345
# overrides the class member with an instance member so no cleanup
1347
self._gather_lsprof_in_benchmarks = True
1348
self.time(time.sleep, 0.000)
1349
self.time(time.sleep, 0.003)
1350
self.assertEqual(2, len(self._benchcalls))
1351
self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
1352
self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1353
self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1354
self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1356
def test_knownFailure(self):
1357
"""Self.knownFailure() should raise a KnownFailure exception."""
1358
self.assertRaises(KnownFailure, self.knownFailure, "A Failure")
1360
def test_requireFeature_available(self):
1361
"""self.requireFeature(available) is a no-op."""
1362
class Available(Feature):
1363
def _probe(self):return True
1364
feature = Available()
1365
self.requireFeature(feature)
1367
def test_requireFeature_unavailable(self):
1368
"""self.requireFeature(unavailable) raises UnavailableFeature."""
1369
class Unavailable(Feature):
1370
def _probe(self):return False
1371
feature = Unavailable()
1372
self.assertRaises(UnavailableFeature, self.requireFeature, feature)
1374
def test_run_no_parameters(self):
1375
test = SampleTestCase('_test_pass')
1378
def test_run_enabled_unittest_result(self):
1379
"""Test we revert to regular behaviour when the test is enabled."""
1380
test = SampleTestCase('_test_pass')
1381
class EnabledFeature(object):
1382
def available(self):
1384
test._test_needs_features = [EnabledFeature()]
1385
result = unittest.TestResult()
1387
self.assertEqual(1, result.testsRun)
1388
self.assertEqual([], result.errors)
1389
self.assertEqual([], result.failures)
1391
def test_run_disabled_unittest_result(self):
1392
"""Test our compatability for disabled tests with unittest results."""
1393
test = SampleTestCase('_test_pass')
1394
class DisabledFeature(object):
1395
def available(self):
1397
test._test_needs_features = [DisabledFeature()]
1398
result = unittest.TestResult()
1400
self.assertEqual(1, result.testsRun)
1401
self.assertEqual([], result.errors)
1402
self.assertEqual([], result.failures)
1404
def test_run_disabled_supporting_result(self):
1405
"""Test disabled tests behaviour with support aware results."""
1406
test = SampleTestCase('_test_pass')
1407
class DisabledFeature(object):
1408
def available(self):
1410
the_feature = DisabledFeature()
1411
test._test_needs_features = [the_feature]
1412
class InstrumentedTestResult(unittest.TestResult):
1414
unittest.TestResult.__init__(self)
1416
def startTest(self, test):
1417
self.calls.append(('startTest', test))
1418
def stopTest(self, test):
1419
self.calls.append(('stopTest', test))
1420
def addNotSupported(self, test, feature):
1421
self.calls.append(('addNotSupported', test, feature))
1422
result = InstrumentedTestResult()
1425
('startTest', test),
1426
('addNotSupported', test, the_feature),
1432
@symbol_versioning.deprecated_function(zero_eleven)
1433
def sample_deprecated_function():
1434
"""A deprecated function to test applyDeprecated with."""
1438
def sample_undeprecated_function(a_param):
1439
"""A undeprecated function to test applyDeprecated with."""
1442
class ApplyDeprecatedHelper(object):
1443
"""A helper class for ApplyDeprecated tests."""
1445
@symbol_versioning.deprecated_method(zero_eleven)
1446
def sample_deprecated_method(self, param_one):
1447
"""A deprecated method for testing with."""
1450
def sample_normal_method(self):
1451
"""A undeprecated method."""
1453
@symbol_versioning.deprecated_method(zero_ten)
1454
def sample_nested_deprecation(self):
1455
return sample_deprecated_function()
1458
class TestExtraAssertions(TestCase):
1459
"""Tests for new test assertions in bzrlib test suite"""
1461
def test_assert_isinstance(self):
1462
self.assertIsInstance(2, int)
1463
self.assertIsInstance(u'', basestring)
1464
self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1465
self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1467
def test_assertEndsWith(self):
1468
self.assertEndsWith('foo', 'oo')
1469
self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1471
def test_applyDeprecated_not_deprecated(self):
1472
sample_object = ApplyDeprecatedHelper()
1473
# calling an undeprecated callable raises an assertion
1474
self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
1475
sample_object.sample_normal_method)
1476
self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
1477
sample_undeprecated_function, "a param value")
1478
# calling a deprecated callable (function or method) with the wrong
1479
# expected deprecation fails.
1480
self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
1481
sample_object.sample_deprecated_method, "a param value")
1482
self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
1483
sample_deprecated_function)
1484
# calling a deprecated callable (function or method) with the right
1485
# expected deprecation returns the functions result.
1486
self.assertEqual("a param value", self.applyDeprecated(zero_eleven,
1487
sample_object.sample_deprecated_method, "a param value"))
1488
self.assertEqual(2, self.applyDeprecated(zero_eleven,
1489
sample_deprecated_function))
1490
# calling a nested deprecation with the wrong deprecation version
1491
# fails even if a deeper nested function was deprecated with the
1493
self.assertRaises(AssertionError, self.applyDeprecated,
1494
zero_eleven, sample_object.sample_nested_deprecation)
1495
# calling a nested deprecation with the right deprecation value
1496
# returns the calls result.
1497
self.assertEqual(2, self.applyDeprecated(zero_ten,
1498
sample_object.sample_nested_deprecation))
1500
def test_callDeprecated(self):
1501
def testfunc(be_deprecated, result=None):
1502
if be_deprecated is True:
1503
symbol_versioning.warn('i am deprecated', DeprecationWarning,
1506
result = self.callDeprecated(['i am deprecated'], testfunc, True)
1507
self.assertIs(None, result)
1508
result = self.callDeprecated([], testfunc, False, 'result')
1509
self.assertEqual('result', result)
1510
self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
1511
self.callDeprecated([], testfunc, be_deprecated=False)
1514
class TestConvenienceMakers(TestCaseWithTransport):
1515
"""Test for the make_* convenience functions."""
1517
def test_make_branch_and_tree_with_format(self):
1518
# we should be able to supply a format to make_branch_and_tree
1519
self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
1520
self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
1521
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
1522
bzrlib.bzrdir.BzrDirMetaFormat1)
1523
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
1524
bzrlib.bzrdir.BzrDirFormat6)
1526
def test_make_branch_and_memory_tree(self):
1527
# we should be able to get a new branch and a mutable tree from
1528
# TestCaseWithTransport
1529
tree = self.make_branch_and_memory_tree('a')
1530
self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1533
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
1535
def test_make_tree_for_sftp_branch(self):
1536
"""Transports backed by local directories create local trees."""
1538
tree = self.make_branch_and_tree('t1')
1539
base = tree.bzrdir.root_transport.base
1540
self.failIf(base.startswith('sftp'),
1541
'base %r is on sftp but should be local' % base)
1542
self.assertEquals(tree.bzrdir.root_transport,
1543
tree.branch.bzrdir.root_transport)
1544
self.assertEquals(tree.bzrdir.root_transport,
1545
tree.branch.repository.bzrdir.root_transport)
1548
class TestSelftest(TestCase):
1549
"""Tests of bzrlib.tests.selftest."""
1551
def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1554
factory_called.append(True)
1558
self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1559
test_suite_factory=factory)
1560
self.assertEqual([True], factory_called)
1563
class TestKnownFailure(TestCase):
1565
def test_known_failure(self):
1566
"""Check that KnownFailure is defined appropriately."""
1567
# a KnownFailure is an assertion error for compatability with unaware
1569
self.assertIsInstance(KnownFailure(""), AssertionError)
1571
def test_expect_failure(self):
1573
self.expectFailure("Doomed to failure", self.assertTrue, False)
1574
except KnownFailure, e:
1575
self.assertEqual('Doomed to failure', e.args[0])
1577
self.expectFailure("Doomed to failure", self.assertTrue, True)
1578
except AssertionError, e:
1579
self.assertEqual('Unexpected success. Should have failed:'
1580
' Doomed to failure', e.args[0])
1582
self.fail('Assertion not raised')
1585
class TestFeature(TestCase):
1587
def test_caching(self):
1588
"""Feature._probe is called by the feature at most once."""
1589
class InstrumentedFeature(Feature):
1591
Feature.__init__(self)
1594
self.calls.append('_probe')
1596
feature = InstrumentedFeature()
1598
self.assertEqual(['_probe'], feature.calls)
1600
self.assertEqual(['_probe'], feature.calls)
1602
def test_named_str(self):
1603
"""Feature.__str__ should thunk to feature_name()."""
1604
class NamedFeature(Feature):
1605
def feature_name(self):
1607
feature = NamedFeature()
1608
self.assertEqual('symlinks', str(feature))
1610
def test_default_str(self):
1611
"""Feature.__str__ should default to __class__.__name__."""
1612
class NamedFeature(Feature):
1614
feature = NamedFeature()
1615
self.assertEqual('NamedFeature', str(feature))
1618
class TestUnavailableFeature(TestCase):
1620
def test_access_feature(self):
1622
exception = UnavailableFeature(feature)
1623
self.assertIs(feature, exception.args[0])
1626
class TestSelftestFiltering(TestCase):
1629
self.suite = TestUtil.TestSuite()
1630
self.loader = TestUtil.TestLoader()
1631
self.suite.addTest(self.loader.loadTestsFromModuleNames([
1632
'bzrlib.tests.test_selftest']))
1633
self.all_names = [t.id() for t in iter_suite_tests(self.suite)]
1635
def test_filter_suite_by_re(self):
1636
filtered_suite = filter_suite_by_re(self.suite, 'test_filter')
1637
filtered_names = [t.id() for t in iter_suite_tests(filtered_suite)]
1638
self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
1639
'TestSelftestFiltering.test_filter_suite_by_re'])
1641
def test_sort_suite_by_re(self):
1642
sorted_suite = sort_suite_by_re(self.suite, 'test_filter')
1643
sorted_names = [t.id() for t in iter_suite_tests(sorted_suite)]
1644
self.assertEqual(sorted_names[0], 'bzrlib.tests.test_selftest.'
1645
'TestSelftestFiltering.test_filter_suite_by_re')
1646
self.assertEquals(sorted(self.all_names), sorted(sorted_names))
1649
class TestCheckInventoryShape(TestCaseWithTransport):
1651
def test_check_inventory_shape(self):
1652
files = ['a', 'b/', 'b/c']
1653
tree = self.make_branch_and_tree('.')
1654
self.build_tree(files)
1658
self.check_inventory_shape(tree.inventory, files)
added
removed
bzrlib/tests/test_selftest.py
