1
# Copyright (C) 2005, 2006 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
34
from bzrlib.progress import _BaseProgressBar
35
from bzrlib.tests import (
39
TestCaseWithMemoryTransport,
40
TestCaseWithTransport,
45
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
46
from bzrlib.tests.TestUtil import _load_module_by_name
47
import bzrlib.errors as errors
48
from bzrlib import symbol_versioning
49
from bzrlib.symbol_versioning import zero_ten, zero_eleven
50
from bzrlib.trace import note
51
from bzrlib.transport.memory import MemoryServer, MemoryTransport
52
from bzrlib.version import _get_bzr_source_tree
55
class SelftestTests(TestCase):
57
def test_import_tests(self):
58
mod = _load_module_by_name('bzrlib.tests.test_selftest')
59
self.assertEqual(mod.SelftestTests, SelftestTests)
61
def test_import_test_failure(self):
62
self.assertRaises(ImportError,
66
class MetaTestLog(TestCase):
68
def test_logging(self):
69
"""Test logs are captured when a test fails."""
70
self.log('a test message')
71
self._log_file.flush()
72
self.assertContainsRe(self._get_log(keep_log_file=True),
76
class TestTreeShape(TestCaseInTempDir):
78
def test_unicode_paths(self):
79
filename = u'hell\u00d8'
81
self.build_tree_contents([(filename, 'contents of hello')])
82
except UnicodeEncodeError:
83
raise TestSkipped("can't build unicode working tree in "
84
"filesystem encoding %s" % sys.getfilesystemencoding())
85
self.failUnlessExists(filename)
88
class TestTransportProviderAdapter(TestCase):
89
"""A group of tests that test the transport implementation adaption core.
91
This is a meta test that the tests are applied to all available
94
This will be generalised in the future which is why it is in this
95
test file even though it is specific to transport tests at the moment.
98
def test_get_transport_permutations(self):
99
# this checks that we the module get_test_permutations call
100
# is made by the adapter get_transport_test_permitations method.
101
class MockModule(object):
102
def get_test_permutations(self):
103
return sample_permutation
104
sample_permutation = [(1,2), (3,4)]
105
from bzrlib.transport import TransportTestProviderAdapter
106
adapter = TransportTestProviderAdapter()
107
self.assertEqual(sample_permutation,
108
adapter.get_transport_test_permutations(MockModule()))
110
def test_adapter_checks_all_modules(self):
111
# this checks that the adapter returns as many permurtations as
112
# there are in all the registered# transport modules for there
113
# - we assume if this matches its probably doing the right thing
114
# especially in combination with the tests for setting the right
116
from bzrlib.transport import (TransportTestProviderAdapter,
117
_get_transport_modules
119
modules = _get_transport_modules()
120
permutation_count = 0
121
for module in modules:
123
permutation_count += len(reduce(getattr,
124
(module + ".get_test_permutations").split('.')[1:],
125
__import__(module))())
126
except errors.DependencyNotPresent:
128
input_test = TestTransportProviderAdapter(
129
"test_adapter_sets_transport_class")
130
adapter = TransportTestProviderAdapter()
131
self.assertEqual(permutation_count,
132
len(list(iter(adapter.adapt(input_test)))))
134
def test_adapter_sets_transport_class(self):
135
# Check that the test adapter inserts a transport and server into the
138
# This test used to know about all the possible transports and the
139
# order they were returned but that seems overly brittle (mbp
141
input_test = TestTransportProviderAdapter(
142
"test_adapter_sets_transport_class")
143
from bzrlib.transport import TransportTestProviderAdapter
144
suite = TransportTestProviderAdapter().adapt(input_test)
145
tests = list(iter(suite))
146
self.assertTrue(len(tests) > 6)
147
# there are at least that many builtin transports
149
self.assertTrue(issubclass(one_test.transport_class,
150
bzrlib.transport.Transport))
151
self.assertTrue(issubclass(one_test.transport_server,
152
bzrlib.transport.Server))
155
class TestBranchProviderAdapter(TestCase):
156
"""A group of tests that test the branch implementation test adapter."""
158
def test_adapted_tests(self):
159
# check that constructor parameters are passed through to the adapted
161
from bzrlib.branch import BranchTestProviderAdapter
162
input_test = TestBranchProviderAdapter(
163
"test_adapted_tests")
166
formats = [("c", "C"), ("d", "D")]
167
adapter = BranchTestProviderAdapter(server1, server2, formats)
168
suite = adapter.adapt(input_test)
169
tests = list(iter(suite))
170
self.assertEqual(2, len(tests))
171
self.assertEqual(tests[0].branch_format, formats[0][0])
172
self.assertEqual(tests[0].bzrdir_format, formats[0][1])
173
self.assertEqual(tests[0].transport_server, server1)
174
self.assertEqual(tests[0].transport_readonly_server, server2)
175
self.assertEqual(tests[1].branch_format, formats[1][0])
176
self.assertEqual(tests[1].bzrdir_format, formats[1][1])
177
self.assertEqual(tests[1].transport_server, server1)
178
self.assertEqual(tests[1].transport_readonly_server, server2)
181
class TestBzrDirProviderAdapter(TestCase):
182
"""A group of tests that test the bzr dir implementation test adapter."""
184
def test_adapted_tests(self):
185
# check that constructor parameters are passed through to the adapted
187
from bzrlib.bzrdir import BzrDirTestProviderAdapter
188
input_test = TestBzrDirProviderAdapter(
189
"test_adapted_tests")
193
adapter = BzrDirTestProviderAdapter(server1, server2, formats)
194
suite = adapter.adapt(input_test)
195
tests = list(iter(suite))
196
self.assertEqual(2, len(tests))
197
self.assertEqual(tests[0].bzrdir_format, formats[0])
198
self.assertEqual(tests[0].transport_server, server1)
199
self.assertEqual(tests[0].transport_readonly_server, server2)
200
self.assertEqual(tests[1].bzrdir_format, formats[1])
201
self.assertEqual(tests[1].transport_server, server1)
202
self.assertEqual(tests[1].transport_readonly_server, server2)
205
class TestRepositoryProviderAdapter(TestCase):
206
"""A group of tests that test the repository implementation test adapter."""
208
def test_adapted_tests(self):
209
# check that constructor parameters are passed through to the adapted
211
from bzrlib.repository import RepositoryTestProviderAdapter
212
input_test = TestRepositoryProviderAdapter(
213
"test_adapted_tests")
216
formats = [("c", "C"), ("d", "D")]
217
adapter = RepositoryTestProviderAdapter(server1, server2, formats)
218
suite = adapter.adapt(input_test)
219
tests = list(iter(suite))
220
self.assertEqual(2, len(tests))
221
self.assertEqual(tests[0].bzrdir_format, formats[0][1])
222
self.assertEqual(tests[0].repository_format, formats[0][0])
223
self.assertEqual(tests[0].transport_server, server1)
224
self.assertEqual(tests[0].transport_readonly_server, server2)
225
self.assertEqual(tests[1].bzrdir_format, formats[1][1])
226
self.assertEqual(tests[1].repository_format, formats[1][0])
227
self.assertEqual(tests[1].transport_server, server1)
228
self.assertEqual(tests[1].transport_readonly_server, server2)
231
class TestInterRepositoryProviderAdapter(TestCase):
232
"""A group of tests that test the InterRepository test adapter."""
234
def test_adapted_tests(self):
235
# check that constructor parameters are passed through to the adapted
237
from bzrlib.repository import InterRepositoryTestProviderAdapter
238
input_test = TestInterRepositoryProviderAdapter(
239
"test_adapted_tests")
242
formats = [(str, "C1", "C2"), (int, "D1", "D2")]
243
adapter = InterRepositoryTestProviderAdapter(server1, server2, formats)
244
suite = adapter.adapt(input_test)
245
tests = list(iter(suite))
246
self.assertEqual(2, len(tests))
247
self.assertEqual(tests[0].interrepo_class, formats[0][0])
248
self.assertEqual(tests[0].repository_format, formats[0][1])
249
self.assertEqual(tests[0].repository_format_to, formats[0][2])
250
self.assertEqual(tests[0].transport_server, server1)
251
self.assertEqual(tests[0].transport_readonly_server, server2)
252
self.assertEqual(tests[1].interrepo_class, formats[1][0])
253
self.assertEqual(tests[1].repository_format, formats[1][1])
254
self.assertEqual(tests[1].repository_format_to, formats[1][2])
255
self.assertEqual(tests[1].transport_server, server1)
256
self.assertEqual(tests[1].transport_readonly_server, server2)
259
class TestInterVersionedFileProviderAdapter(TestCase):
260
"""A group of tests that test the InterVersionedFile test adapter."""
262
def test_adapted_tests(self):
263
# check that constructor parameters are passed through to the adapted
265
from bzrlib.versionedfile import InterVersionedFileTestProviderAdapter
266
input_test = TestInterRepositoryProviderAdapter(
267
"test_adapted_tests")
270
formats = [(str, "C1", "C2"), (int, "D1", "D2")]
271
adapter = InterVersionedFileTestProviderAdapter(server1, server2, formats)
272
suite = adapter.adapt(input_test)
273
tests = list(iter(suite))
274
self.assertEqual(2, len(tests))
275
self.assertEqual(tests[0].interversionedfile_class, formats[0][0])
276
self.assertEqual(tests[0].versionedfile_factory, formats[0][1])
277
self.assertEqual(tests[0].versionedfile_factory_to, formats[0][2])
278
self.assertEqual(tests[0].transport_server, server1)
279
self.assertEqual(tests[0].transport_readonly_server, server2)
280
self.assertEqual(tests[1].interversionedfile_class, formats[1][0])
281
self.assertEqual(tests[1].versionedfile_factory, formats[1][1])
282
self.assertEqual(tests[1].versionedfile_factory_to, formats[1][2])
283
self.assertEqual(tests[1].transport_server, server1)
284
self.assertEqual(tests[1].transport_readonly_server, server2)
287
class TestRevisionStoreProviderAdapter(TestCase):
288
"""A group of tests that test the RevisionStore test adapter."""
290
def test_adapted_tests(self):
291
# check that constructor parameters are passed through to the adapted
293
from bzrlib.store.revision import RevisionStoreTestProviderAdapter
294
input_test = TestRevisionStoreProviderAdapter(
295
"test_adapted_tests")
296
# revision stores need a store factory - i.e. RevisionKnit
297
#, a readonly and rw transport
301
store_factories = ["c", "d"]
302
adapter = RevisionStoreTestProviderAdapter(server1, server2, store_factories)
303
suite = adapter.adapt(input_test)
304
tests = list(iter(suite))
305
self.assertEqual(2, len(tests))
306
self.assertEqual(tests[0].store_factory, store_factories[0][0])
307
self.assertEqual(tests[0].transport_server, server1)
308
self.assertEqual(tests[0].transport_readonly_server, server2)
309
self.assertEqual(tests[1].store_factory, store_factories[1][0])
310
self.assertEqual(tests[1].transport_server, server1)
311
self.assertEqual(tests[1].transport_readonly_server, server2)
314
class TestWorkingTreeProviderAdapter(TestCase):
315
"""A group of tests that test the workingtree implementation test adapter."""
317
def test_adapted_tests(self):
318
# check that constructor parameters are passed through to the adapted
320
from bzrlib.workingtree import WorkingTreeTestProviderAdapter
321
input_test = TestWorkingTreeProviderAdapter(
322
"test_adapted_tests")
325
formats = [("c", "C"), ("d", "D")]
326
adapter = WorkingTreeTestProviderAdapter(server1, server2, formats)
327
suite = adapter.adapt(input_test)
328
tests = list(iter(suite))
329
self.assertEqual(2, len(tests))
330
self.assertEqual(tests[0].workingtree_format, formats[0][0])
331
self.assertEqual(tests[0].bzrdir_format, formats[0][1])
332
self.assertEqual(tests[0].transport_server, server1)
333
self.assertEqual(tests[0].transport_readonly_server, server2)
334
self.assertEqual(tests[1].workingtree_format, formats[1][0])
335
self.assertEqual(tests[1].bzrdir_format, formats[1][1])
336
self.assertEqual(tests[1].transport_server, server1)
337
self.assertEqual(tests[1].transport_readonly_server, server2)
340
class TestTreeProviderAdapter(TestCase):
341
"""Test the setup of tree_implementation tests."""
343
def test_adapted_tests(self):
344
# the tree implementation adapter is meant to setup one instance for
345
# each working tree format, and one additional instance that will
346
# use the default wt format, but create a revision tree for the tests.
347
# this means that the wt ones should have the workingtree_to_test_tree
348
# attribute set to 'return_parameter' and the revision one set to
349
# revision_tree_from_workingtree.
351
from bzrlib.tests.tree_implementations import (
352
TreeTestProviderAdapter,
354
revision_tree_from_workingtree
356
from bzrlib.workingtree import WorkingTreeFormat
357
input_test = TestTreeProviderAdapter(
358
"test_adapted_tests")
361
formats = [("c", "C"), ("d", "D")]
362
adapter = TreeTestProviderAdapter(server1, server2, formats)
363
suite = adapter.adapt(input_test)
364
tests = list(iter(suite))
365
self.assertEqual(3, len(tests))
366
default_format = WorkingTreeFormat.get_default_format()
367
self.assertEqual(tests[0].workingtree_format, formats[0][0])
368
self.assertEqual(tests[0].bzrdir_format, formats[0][1])
369
self.assertEqual(tests[0].transport_server, server1)
370
self.assertEqual(tests[0].transport_readonly_server, server2)
371
self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
372
self.assertEqual(tests[1].workingtree_format, formats[1][0])
373
self.assertEqual(tests[1].bzrdir_format, formats[1][1])
374
self.assertEqual(tests[1].transport_server, server1)
375
self.assertEqual(tests[1].transport_readonly_server, server2)
376
self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
377
self.assertEqual(tests[2].workingtree_format, default_format)
378
self.assertEqual(tests[2].bzrdir_format, default_format._matchingbzrdir)
379
self.assertEqual(tests[2].transport_server, server1)
380
self.assertEqual(tests[2].transport_readonly_server, server2)
381
self.assertEqual(tests[2].workingtree_to_test_tree,
382
revision_tree_from_workingtree)
385
class TestInterTreeProviderAdapter(TestCase):
386
"""A group of tests that test the InterTreeTestAdapter."""
388
def test_adapted_tests(self):
389
# check that constructor parameters are passed through to the adapted
391
# for InterTree tests we want the machinery to bring up two trees in
392
# each instance: the base one, and the one we are interacting with.
393
# because each optimiser can be direction specific, we need to test
394
# each optimiser in its chosen direction.
395
# unlike the TestProviderAdapter we dont want to automatically add a
396
# parameterised one for WorkingTree - the optimisers will tell us what
398
from bzrlib.tests.tree_implementations import (
400
revision_tree_from_workingtree
402
from bzrlib.tests.intertree_implementations import (
403
InterTreeTestProviderAdapter,
405
from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
406
input_test = TestInterTreeProviderAdapter(
407
"test_adapted_tests")
410
format1 = WorkingTreeFormat2()
411
format2 = WorkingTreeFormat3()
412
formats = [(str, format1, format2, False, True),
413
(int, format2, format1, False, True)]
414
adapter = InterTreeTestProviderAdapter(server1, server2, formats)
415
suite = adapter.adapt(input_test)
416
tests = list(iter(suite))
417
self.assertEqual(2, len(tests))
418
self.assertEqual(tests[0].intertree_class, formats[0][0])
419
self.assertEqual(tests[0].workingtree_format, formats[0][1])
420
self.assertEqual(tests[0].workingtree_to_test_tree, formats[0][2])
421
self.assertEqual(tests[0].workingtree_format_to, formats[0][3])
422
self.assertEqual(tests[0].workingtree_to_test_tree_to, formats[0][4])
423
self.assertEqual(tests[0].transport_server, server1)
424
self.assertEqual(tests[0].transport_readonly_server, server2)
425
self.assertEqual(tests[1].intertree_class, formats[1][0])
426
self.assertEqual(tests[1].workingtree_format, formats[1][1])
427
self.assertEqual(tests[1].workingtree_to_test_tree, formats[1][2])
428
self.assertEqual(tests[1].workingtree_format_to, formats[1][3])
429
self.assertEqual(tests[1].workingtree_to_test_tree_to, formats[1][4])
430
self.assertEqual(tests[1].transport_server, server1)
431
self.assertEqual(tests[1].transport_readonly_server, server2)
434
class TestTestCaseInTempDir(TestCaseInTempDir):
436
def test_home_is_not_working(self):
437
self.assertNotEqual(self.test_dir, self.test_home_dir)
438
cwd = osutils.getcwd()
439
self.assertEqual(self.test_dir, cwd)
440
self.assertEqual(self.test_home_dir, os.environ['HOME'])
443
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
445
def test_home_is_non_existant_dir_under_root(self):
446
"""The test_home_dir for TestCaseWithMemoryTransport is missing.
448
This is because TestCaseWithMemoryTransport is for tests that do not
449
need any disk resources: they should be hooked into bzrlib in such a
450
way that no global settings are being changed by the test (only a
451
few tests should need to do that), and having a missing dir as home is
452
an effective way to ensure that this is the case.
454
self.assertEqual(self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
456
self.assertEqual(self.test_home_dir, os.environ['HOME'])
458
def test_cwd_is_TEST_ROOT(self):
459
self.assertEqual(self.test_dir, self.TEST_ROOT)
460
cwd = osutils.getcwd()
461
self.assertEqual(self.test_dir, cwd)
463
def test_make_branch_and_memory_tree(self):
464
"""In TestCaseWithMemoryTransport we should not make the branch on disk.
466
This is hard to comprehensively robustly test, so we settle for making
467
a branch and checking no directory was created at its relpath.
469
tree = self.make_branch_and_memory_tree('dir')
470
# Guard against regression into MemoryTransport leaking
471
# files to disk instead of keeping them in memory.
472
self.failIf(osutils.lexists('dir'))
473
self.assertIsInstance(tree, memorytree.MemoryTree)
475
def test_make_branch_and_memory_tree_with_format(self):
476
"""make_branch_and_memory_tree should accept a format option."""
477
format = bzrdir.BzrDirMetaFormat1()
478
format.repository_format = repository.RepositoryFormat7()
479
tree = self.make_branch_and_memory_tree('dir', format=format)
480
# Guard against regression into MemoryTransport leaking
481
# files to disk instead of keeping them in memory.
482
self.failIf(osutils.lexists('dir'))
483
self.assertIsInstance(tree, memorytree.MemoryTree)
484
self.assertEqual(format.repository_format.__class__,
485
tree.branch.repository._format.__class__)
488
class TestTestCaseWithTransport(TestCaseWithTransport):
489
"""Tests for the convenience functions TestCaseWithTransport introduces."""
491
def test_get_readonly_url_none(self):
492
from bzrlib.transport import get_transport
493
from bzrlib.transport.memory import MemoryServer
494
from bzrlib.transport.readonly import ReadonlyTransportDecorator
495
self.transport_server = MemoryServer
496
self.transport_readonly_server = None
497
# calling get_readonly_transport() constructs a decorator on the url
499
url = self.get_readonly_url()
500
url2 = self.get_readonly_url('foo/bar')
501
t = get_transport(url)
502
t2 = get_transport(url2)
503
self.failUnless(isinstance(t, ReadonlyTransportDecorator))
504
self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
505
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
507
def test_get_readonly_url_http(self):
508
from bzrlib.tests.HttpServer import HttpServer
509
from bzrlib.transport import get_transport
510
from bzrlib.transport.local import LocalURLServer
511
from bzrlib.transport.http import HttpTransportBase
512
self.transport_server = LocalURLServer
513
self.transport_readonly_server = HttpServer
514
# calling get_readonly_transport() gives us a HTTP server instance.
515
url = self.get_readonly_url()
516
url2 = self.get_readonly_url('foo/bar')
517
# the transport returned may be any HttpTransportBase subclass
518
t = get_transport(url)
519
t2 = get_transport(url2)
520
self.failUnless(isinstance(t, HttpTransportBase))
521
self.failUnless(isinstance(t2, HttpTransportBase))
522
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
524
def test_is_directory(self):
525
"""Test assertIsDirectory assertion"""
526
t = self.get_transport()
527
self.build_tree(['a_dir/', 'a_file'], transport=t)
528
self.assertIsDirectory('a_dir', t)
529
self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
530
self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
533
class TestTestCaseTransports(TestCaseWithTransport):
536
super(TestTestCaseTransports, self).setUp()
537
self.transport_server = MemoryServer
539
def test_make_bzrdir_preserves_transport(self):
540
t = self.get_transport()
541
result_bzrdir = self.make_bzrdir('subdir')
542
self.assertIsInstance(result_bzrdir.transport,
544
# should not be on disk, should only be in memory
545
self.failIfExists('subdir')
548
class TestChrootedTest(ChrootedTestCase):
550
def test_root_is_root(self):
551
from bzrlib.transport import get_transport
552
t = get_transport(self.get_readonly_url())
554
self.assertEqual(url, t.clone('..').base)
557
class MockProgress(_BaseProgressBar):
558
"""Progress-bar standin that records calls.
560
Useful for testing pb using code.
564
_BaseProgressBar.__init__(self)
568
self.calls.append(('tick',))
570
def update(self, msg=None, current=None, total=None):
571
self.calls.append(('update', msg, current, total))
574
self.calls.append(('clear',))
576
def note(self, msg, *args):
577
self.calls.append(('note', msg, args))
580
class TestTestResult(TestCase):
582
def test_elapsed_time_with_benchmarking(self):
583
result = bzrlib.tests.TextTestResult(self._log_file,
587
result._recordTestStartTime()
589
result.extractBenchmarkTime(self)
590
timed_string = result._testTimeString()
591
# without explicit benchmarking, we should get a simple time.
592
self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms$")
593
# if a benchmark time is given, we want a x of y style result.
594
self.time(time.sleep, 0.001)
595
result.extractBenchmarkTime(self)
596
timed_string = result._testTimeString()
597
self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms/ *[ 1-9][0-9]ms$")
598
# extracting the time from a non-bzrlib testcase sets to None
599
result._recordTestStartTime()
600
result.extractBenchmarkTime(
601
unittest.FunctionTestCase(self.test_elapsed_time_with_benchmarking))
602
timed_string = result._testTimeString()
603
self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms$")
604
# cheat. Yes, wash thy mouth out with soap.
605
self._benchtime = None
607
def test_assigned_benchmark_file_stores_date(self):
609
result = bzrlib.tests.TextTestResult(self._log_file,
614
output_string = output.getvalue()
616
# if you are wondering about the regexp please read the comment in
617
# test_bench_history (bzrlib.tests.test_selftest.TestRunner)
618
# XXX: what comment? -- Andrew Bennetts
619
self.assertContainsRe(output_string, "--date [0-9.]+")
621
def test_benchhistory_records_test_times(self):
622
result_stream = StringIO()
623
result = bzrlib.tests.TextTestResult(
627
bench_history=result_stream
630
# we want profile a call and check that its test duration is recorded
631
# make a new test instance that when run will generate a benchmark
632
example_test_case = TestTestResult("_time_hello_world_encoding")
633
# execute the test, which should succeed and record times
634
example_test_case.run(result)
635
lines = result_stream.getvalue().splitlines()
636
self.assertEqual(2, len(lines))
637
self.assertContainsRe(lines[1],
638
" *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
639
"._time_hello_world_encoding")
641
def _time_hello_world_encoding(self):
642
"""Profile two sleep calls
644
This is used to exercise the test framework.
646
self.time(unicode, 'hello', errors='replace')
647
self.time(unicode, 'world', errors='replace')
649
def test_lsprofiling(self):
650
"""Verbose test result prints lsprof statistics from test cases."""
654
raise TestSkipped("lsprof not installed.")
655
result_stream = StringIO()
656
result = bzrlib.tests.VerboseTestResult(
657
unittest._WritelnDecorator(result_stream),
661
# we want profile a call of some sort and check it is output by
662
# addSuccess. We dont care about addError or addFailure as they
663
# are not that interesting for performance tuning.
664
# make a new test instance that when run will generate a profile
665
example_test_case = TestTestResult("_time_hello_world_encoding")
666
example_test_case._gather_lsprof_in_benchmarks = True
667
# execute the test, which should succeed and record profiles
668
example_test_case.run(result)
669
# lsprofile_something()
670
# if this worked we want
671
# LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
672
# CallCount Recursive Total(ms) Inline(ms) module:lineno(function)
673
# (the lsprof header)
674
# ... an arbitrary number of lines
675
# and the function call which is time.sleep.
676
# 1 0 ??? ??? ???(sleep)
677
# and then repeated but with 'world', rather than 'hello'.
678
# this should appear in the output stream of our test result.
679
output = result_stream.getvalue()
680
self.assertContainsRe(output,
681
r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
682
self.assertContainsRe(output,
683
r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
684
self.assertContainsRe(output,
685
r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
686
self.assertContainsRe(output,
687
r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
690
class TestRunner(TestCase):
692
def dummy_test(self):
695
def run_test_runner(self, testrunner, test):
696
"""Run suite in testrunner, saving global state and restoring it.
698
This current saves and restores:
699
TestCaseInTempDir.TEST_ROOT
701
There should be no tests in this file that use bzrlib.tests.TextTestRunner
702
without using this convenience method, because of our use of global state.
704
old_root = TestCaseInTempDir.TEST_ROOT
706
TestCaseInTempDir.TEST_ROOT = None
707
return testrunner.run(test)
709
TestCaseInTempDir.TEST_ROOT = old_root
711
def test_skipped_test(self):
712
# run a test that is skipped, and check the suite as a whole still
714
# skipping_test must be hidden in here so it's not run as a real test
716
raise TestSkipped('test intentionally skipped')
717
runner = TextTestRunner(stream=self._log_file, keep_output=True)
718
test = unittest.FunctionTestCase(skipping_test)
719
result = self.run_test_runner(runner, test)
720
self.assertTrue(result.wasSuccessful())
722
def test_bench_history(self):
723
# tests that the running the benchmark produces a history file
724
# containing a timestamp and the revision id of the bzrlib source which
726
workingtree = _get_bzr_source_tree()
727
test = TestRunner('dummy_test')
729
runner = TextTestRunner(stream=self._log_file, bench_history=output)
730
result = self.run_test_runner(runner, test)
731
output_string = output.getvalue()
732
self.assertContainsRe(output_string, "--date [0-9.]+")
733
if workingtree is not None:
734
revision_id = workingtree.get_parent_ids()[0]
735
self.assertEndsWith(output_string.rstrip(), revision_id)
737
def test_success_log_deleted(self):
738
"""Successful tests have their log deleted"""
740
class LogTester(TestCase):
742
def test_success(self):
743
self.log('this will be removed\n')
745
sio = cStringIO.StringIO()
746
runner = TextTestRunner(stream=sio)
747
test = LogTester('test_success')
748
result = self.run_test_runner(runner, test)
750
log = test._get_log()
751
self.assertEqual("DELETED log file to reduce memory footprint", log)
752
self.assertEqual('', test._log_contents)
753
self.assertIs(None, test._log_file_name)
755
def test_fail_log_kept(self):
756
"""Failed tests have their log kept"""
758
class LogTester(TestCase):
761
self.log('this will be kept\n')
762
self.fail('this test fails')
764
sio = cStringIO.StringIO()
765
runner = TextTestRunner(stream=sio)
766
test = LogTester('test_fail')
767
result = self.run_test_runner(runner, test)
769
text = sio.getvalue()
770
self.assertContainsRe(text, 'this will be kept')
771
self.assertContainsRe(text, 'this test fails')
773
log = test._get_log()
774
self.assertContainsRe(log, 'this will be kept')
775
self.assertEqual(log, test._log_contents)
777
def test_error_log_kept(self):
778
"""Tests with errors have their log kept"""
780
class LogTester(TestCase):
782
def test_error(self):
783
self.log('this will be kept\n')
784
raise ValueError('random exception raised')
786
sio = cStringIO.StringIO()
787
runner = TextTestRunner(stream=sio)
788
test = LogTester('test_error')
789
result = self.run_test_runner(runner, test)
791
text = sio.getvalue()
792
self.assertContainsRe(text, 'this will be kept')
793
self.assertContainsRe(text, 'random exception raised')
795
log = test._get_log()
796
self.assertContainsRe(log, 'this will be kept')
797
self.assertEqual(log, test._log_contents)
800
class TestTestCase(TestCase):
801
"""Tests that test the core bzrlib TestCase."""
803
def inner_test(self):
804
# the inner child test
807
def outer_child(self):
808
# the outer child test
810
self.inner_test = TestTestCase("inner_child")
811
result = bzrlib.tests.TextTestResult(self._log_file,
814
self.inner_test.run(result)
817
def test_trace_nesting(self):
818
# this tests that each test case nests its trace facility correctly.
819
# we do this by running a test case manually. That test case (A)
820
# should setup a new log, log content to it, setup a child case (B),
821
# which should log independently, then case (A) should log a trailer
823
# we do two nested children so that we can verify the state of the
824
# logs after the outer child finishes is correct, which a bad clean
825
# up routine in tearDown might trigger a fault in our test with only
826
# one child, we should instead see the bad result inside our test with
828
# the outer child test
829
original_trace = bzrlib.trace._trace_file
830
outer_test = TestTestCase("outer_child")
831
result = bzrlib.tests.TextTestResult(self._log_file,
834
outer_test.run(result)
835
self.assertEqual(original_trace, bzrlib.trace._trace_file)
837
def method_that_times_a_bit_twice(self):
838
# call self.time twice to ensure it aggregates
839
self.time(time.sleep, 0.007)
840
self.time(time.sleep, 0.007)
842
def test_time_creates_benchmark_in_result(self):
843
"""Test that the TestCase.time() method accumulates a benchmark time."""
844
sample_test = TestTestCase("method_that_times_a_bit_twice")
845
output_stream = StringIO()
846
result = bzrlib.tests.VerboseTestResult(
847
unittest._WritelnDecorator(output_stream),
850
num_tests=sample_test.countTestCases())
851
sample_test.run(result)
852
self.assertContainsRe(
853
output_stream.getvalue(),
856
def test_hooks_sanitised(self):
857
"""The bzrlib hooks should be sanitised by setUp."""
858
self.assertEqual(bzrlib.branch.BranchHooks(),
859
bzrlib.branch.Branch.hooks)
861
def test__gather_lsprof_in_benchmarks(self):
862
"""When _gather_lsprof_in_benchmarks is on, accumulate profile data.
864
Each self.time() call is individually and separately profiled.
869
raise TestSkipped("lsprof not installed.")
870
# overrides the class member with an instance member so no cleanup
872
self._gather_lsprof_in_benchmarks = True
873
self.time(time.sleep, 0.000)
874
self.time(time.sleep, 0.003)
875
self.assertEqual(2, len(self._benchcalls))
876
self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
877
self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
878
self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
879
self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
882
@symbol_versioning.deprecated_function(zero_eleven)
883
def sample_deprecated_function():
884
"""A deprecated function to test applyDeprecated with."""
888
def sample_undeprecated_function(a_param):
889
"""A undeprecated function to test applyDeprecated with."""
892
class ApplyDeprecatedHelper(object):
893
"""A helper class for ApplyDeprecated tests."""
895
@symbol_versioning.deprecated_method(zero_eleven)
896
def sample_deprecated_method(self, param_one):
897
"""A deprecated method for testing with."""
900
def sample_normal_method(self):
901
"""A undeprecated method."""
903
@symbol_versioning.deprecated_method(zero_ten)
904
def sample_nested_deprecation(self):
905
return sample_deprecated_function()
908
class TestExtraAssertions(TestCase):
909
"""Tests for new test assertions in bzrlib test suite"""
911
def test_assert_isinstance(self):
912
self.assertIsInstance(2, int)
913
self.assertIsInstance(u'', basestring)
914
self.assertRaises(AssertionError, self.assertIsInstance, None, int)
915
self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
917
def test_assertEndsWith(self):
918
self.assertEndsWith('foo', 'oo')
919
self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
921
def test_applyDeprecated_not_deprecated(self):
922
sample_object = ApplyDeprecatedHelper()
923
# calling an undeprecated callable raises an assertion
924
self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
925
sample_object.sample_normal_method)
926
self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
927
sample_undeprecated_function, "a param value")
928
# calling a deprecated callable (function or method) with the wrong
929
# expected deprecation fails.
930
self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
931
sample_object.sample_deprecated_method, "a param value")
932
self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
933
sample_deprecated_function)
934
# calling a deprecated callable (function or method) with the right
935
# expected deprecation returns the functions result.
936
self.assertEqual("a param value", self.applyDeprecated(zero_eleven,
937
sample_object.sample_deprecated_method, "a param value"))
938
self.assertEqual(2, self.applyDeprecated(zero_eleven,
939
sample_deprecated_function))
940
# calling a nested deprecation with the wrong deprecation version
941
# fails even if a deeper nested function was deprecated with the
943
self.assertRaises(AssertionError, self.applyDeprecated,
944
zero_eleven, sample_object.sample_nested_deprecation)
945
# calling a nested deprecation with the right deprecation value
946
# returns the calls result.
947
self.assertEqual(2, self.applyDeprecated(zero_ten,
948
sample_object.sample_nested_deprecation))
950
def test_callDeprecated(self):
951
def testfunc(be_deprecated, result=None):
952
if be_deprecated is True:
953
symbol_versioning.warn('i am deprecated', DeprecationWarning,
956
result = self.callDeprecated(['i am deprecated'], testfunc, True)
957
self.assertIs(None, result)
958
result = self.callDeprecated([], testfunc, False, 'result')
959
self.assertEqual('result', result)
960
self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
961
self.callDeprecated([], testfunc, be_deprecated=False)
964
class TestConvenienceMakers(TestCaseWithTransport):
965
"""Test for the make_* convenience functions."""
967
def test_make_branch_and_tree_with_format(self):
968
# we should be able to supply a format to make_branch_and_tree
969
self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
970
self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
971
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
972
bzrlib.bzrdir.BzrDirMetaFormat1)
973
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
974
bzrlib.bzrdir.BzrDirFormat6)
976
def test_make_branch_and_memory_tree(self):
977
# we should be able to get a new branch and a mutable tree from
978
# TestCaseWithTransport
979
tree = self.make_branch_and_memory_tree('a')
980
self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
983
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
985
def test_make_tree_for_sftp_branch(self):
986
"""Transports backed by local directories create local trees."""
988
tree = self.make_branch_and_tree('t1')
989
base = tree.bzrdir.root_transport.base
990
self.failIf(base.startswith('sftp'),
991
'base %r is on sftp but should be local' % base)
992
self.assertEquals(tree.bzrdir.root_transport,
993
tree.branch.bzrdir.root_transport)
994
self.assertEquals(tree.bzrdir.root_transport,
995
tree.branch.repository.bzrdir.root_transport)
998
class TestSelftest(TestCase):
999
"""Tests of bzrlib.tests.selftest."""
1001
def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1004
factory_called.append(True)
1008
self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1009
test_suite_factory=factory)
1010
self.assertEqual([True], factory_called)
1013
class TestSelftestCleanOutput(TestCaseInTempDir):
1015
def test_clean_output(self):
1016
# test functionality of clean_selftest_output()
1017
from bzrlib.tests import clean_selftest_output
1019
dirs = ('test0000.tmp', 'test0001.tmp', 'bzrlib', 'tests')
1020
files = ('bzr', 'setup.py', 'test9999.tmp')
1025
f.write('content of ')
1030
before = os.listdir(root)
1032
self.assertEquals(['bzr','bzrlib','setup.py',
1033
'test0000.tmp','test0001.tmp',
1034
'test9999.tmp','tests'],
1036
clean_selftest_output(root, quiet=True)
1037
after = os.listdir(root)
1039
self.assertEquals(['bzr','bzrlib','setup.py',
1040
'test9999.tmp','tests'],
added
removed
bzrlib/tests/test_selftest.py
