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
self.failIfExists('dir')
471
self.assertIsInstance(tree, memorytree.MemoryTree)
473
def test_make_branch_and_memory_tree_with_format(self):
474
"""make_branch_and_memory_tree should accept a format option."""
475
format = bzrdir.BzrDirMetaFormat1()
476
format.repository_format = repository.RepositoryFormat7()
477
tree = self.make_branch_and_memory_tree('dir', format=format)
478
self.failIfExists('dir')
479
self.assertIsInstance(tree, memorytree.MemoryTree)
480
self.assertEqual(format.repository_format.__class__,
481
tree.branch.repository._format.__class__)
484
class TestTestCaseWithTransport(TestCaseWithTransport):
485
"""Tests for the convenience functions TestCaseWithTransport introduces."""
487
def test_get_readonly_url_none(self):
488
from bzrlib.transport import get_transport
489
from bzrlib.transport.memory import MemoryServer
490
from bzrlib.transport.readonly import ReadonlyTransportDecorator
491
self.transport_server = MemoryServer
492
self.transport_readonly_server = None
493
# calling get_readonly_transport() constructs a decorator on the url
495
url = self.get_readonly_url()
496
url2 = self.get_readonly_url('foo/bar')
497
t = get_transport(url)
498
t2 = get_transport(url2)
499
self.failUnless(isinstance(t, ReadonlyTransportDecorator))
500
self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
501
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
503
def test_get_readonly_url_http(self):
504
from bzrlib.tests.HttpServer import HttpServer
505
from bzrlib.transport import get_transport
506
from bzrlib.transport.local import LocalURLServer
507
from bzrlib.transport.http import HttpTransportBase
508
self.transport_server = LocalURLServer
509
self.transport_readonly_server = HttpServer
510
# calling get_readonly_transport() gives us a HTTP server instance.
511
url = self.get_readonly_url()
512
url2 = self.get_readonly_url('foo/bar')
513
# the transport returned may be any HttpTransportBase subclass
514
t = get_transport(url)
515
t2 = get_transport(url2)
516
self.failUnless(isinstance(t, HttpTransportBase))
517
self.failUnless(isinstance(t2, HttpTransportBase))
518
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
520
def test_is_directory(self):
521
"""Test assertIsDirectory assertion"""
522
t = self.get_transport()
523
self.build_tree(['a_dir/', 'a_file'], transport=t)
524
self.assertIsDirectory('a_dir', t)
525
self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
526
self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
529
class TestTestCaseTransports(TestCaseWithTransport):
532
super(TestTestCaseTransports, self).setUp()
533
self.transport_server = MemoryServer
535
def test_make_bzrdir_preserves_transport(self):
536
t = self.get_transport()
537
result_bzrdir = self.make_bzrdir('subdir')
538
self.assertIsInstance(result_bzrdir.transport,
540
# should not be on disk, should only be in memory
541
self.failIfExists('subdir')
544
class TestChrootedTest(ChrootedTestCase):
546
def test_root_is_root(self):
547
from bzrlib.transport import get_transport
548
t = get_transport(self.get_readonly_url())
550
self.assertEqual(url, t.clone('..').base)
553
class MockProgress(_BaseProgressBar):
554
"""Progress-bar standin that records calls.
556
Useful for testing pb using code.
560
_BaseProgressBar.__init__(self)
564
self.calls.append(('tick',))
566
def update(self, msg=None, current=None, total=None):
567
self.calls.append(('update', msg, current, total))
570
self.calls.append(('clear',))
572
def note(self, msg, *args):
573
self.calls.append(('note', msg, args))
576
class TestTestResult(TestCase):
578
def test_elapsed_time_with_benchmarking(self):
579
result = bzrlib.tests.TextTestResult(self._log_file,
583
result._recordTestStartTime()
585
result.extractBenchmarkTime(self)
586
timed_string = result._testTimeString()
587
# without explicit benchmarking, we should get a simple time.
588
self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms$")
589
# if a benchmark time is given, we want a x of y style result.
590
self.time(time.sleep, 0.001)
591
result.extractBenchmarkTime(self)
592
timed_string = result._testTimeString()
593
self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms/ *[ 1-9][0-9]ms$")
594
# extracting the time from a non-bzrlib testcase sets to None
595
result._recordTestStartTime()
596
result.extractBenchmarkTime(
597
unittest.FunctionTestCase(self.test_elapsed_time_with_benchmarking))
598
timed_string = result._testTimeString()
599
self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms$")
600
# cheat. Yes, wash thy mouth out with soap.
601
self._benchtime = None
603
def test_assigned_benchmark_file_stores_date(self):
605
result = bzrlib.tests.TextTestResult(self._log_file,
610
output_string = output.getvalue()
612
# if you are wondering about the regexp please read the comment in
613
# test_bench_history (bzrlib.tests.test_selftest.TestRunner)
614
# XXX: what comment? -- Andrew Bennetts
615
self.assertContainsRe(output_string, "--date [0-9.]+")
617
def test_benchhistory_records_test_times(self):
618
result_stream = StringIO()
619
result = bzrlib.tests.TextTestResult(
623
bench_history=result_stream
626
# we want profile a call and check that its test duration is recorded
627
# make a new test instance that when run will generate a benchmark
628
example_test_case = TestTestResult("_time_hello_world_encoding")
629
# execute the test, which should succeed and record times
630
example_test_case.run(result)
631
lines = result_stream.getvalue().splitlines()
632
self.assertEqual(2, len(lines))
633
self.assertContainsRe(lines[1],
634
" *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
635
"._time_hello_world_encoding")
637
def _time_hello_world_encoding(self):
638
"""Profile two sleep calls
640
This is used to exercise the test framework.
642
self.time(unicode, 'hello', errors='replace')
643
self.time(unicode, 'world', errors='replace')
645
def test_lsprofiling(self):
646
"""Verbose test result prints lsprof statistics from test cases."""
650
raise TestSkipped("lsprof not installed.")
651
result_stream = StringIO()
652
result = bzrlib.tests.VerboseTestResult(
653
unittest._WritelnDecorator(result_stream),
657
# we want profile a call of some sort and check it is output by
658
# addSuccess. We dont care about addError or addFailure as they
659
# are not that interesting for performance tuning.
660
# make a new test instance that when run will generate a profile
661
example_test_case = TestTestResult("_time_hello_world_encoding")
662
example_test_case._gather_lsprof_in_benchmarks = True
663
# execute the test, which should succeed and record profiles
664
example_test_case.run(result)
665
# lsprofile_something()
666
# if this worked we want
667
# LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
668
# CallCount Recursive Total(ms) Inline(ms) module:lineno(function)
669
# (the lsprof header)
670
# ... an arbitrary number of lines
671
# and the function call which is time.sleep.
672
# 1 0 ??? ??? ???(sleep)
673
# and then repeated but with 'world', rather than 'hello'.
674
# this should appear in the output stream of our test result.
675
output = result_stream.getvalue()
676
self.assertContainsRe(output,
677
r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
678
self.assertContainsRe(output,
679
r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
680
self.assertContainsRe(output,
681
r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
682
self.assertContainsRe(output,
683
r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
686
class TestRunner(TestCase):
688
def dummy_test(self):
691
def run_test_runner(self, testrunner, test):
692
"""Run suite in testrunner, saving global state and restoring it.
694
This current saves and restores:
695
TestCaseInTempDir.TEST_ROOT
697
There should be no tests in this file that use bzrlib.tests.TextTestRunner
698
without using this convenience method, because of our use of global state.
700
old_root = TestCaseInTempDir.TEST_ROOT
702
TestCaseInTempDir.TEST_ROOT = None
703
return testrunner.run(test)
705
TestCaseInTempDir.TEST_ROOT = old_root
707
def test_skipped_test(self):
708
# run a test that is skipped, and check the suite as a whole still
710
# skipping_test must be hidden in here so it's not run as a real test
712
raise TestSkipped('test intentionally skipped')
713
runner = TextTestRunner(stream=self._log_file, keep_output=True)
714
test = unittest.FunctionTestCase(skipping_test)
715
result = self.run_test_runner(runner, test)
716
self.assertTrue(result.wasSuccessful())
718
def test_bench_history(self):
719
# tests that the running the benchmark produces a history file
720
# containing a timestamp and the revision id of the bzrlib source which
722
workingtree = _get_bzr_source_tree()
723
test = TestRunner('dummy_test')
725
runner = TextTestRunner(stream=self._log_file, bench_history=output)
726
result = self.run_test_runner(runner, test)
727
output_string = output.getvalue()
728
self.assertContainsRe(output_string, "--date [0-9.]+")
729
if workingtree is not None:
730
revision_id = workingtree.get_parent_ids()[0]
731
self.assertEndsWith(output_string.rstrip(), revision_id)
733
def test_success_log_deleted(self):
734
"""Successful tests have their log deleted"""
736
class LogTester(TestCase):
738
def test_success(self):
739
self.log('this will be removed\n')
741
sio = cStringIO.StringIO()
742
runner = TextTestRunner(stream=sio)
743
test = LogTester('test_success')
744
result = self.run_test_runner(runner, test)
746
log = test._get_log()
747
self.assertEqual("DELETED log file to reduce memory footprint", log)
748
self.assertEqual('', test._log_contents)
749
self.assertIs(None, test._log_file_name)
751
def test_fail_log_kept(self):
752
"""Failed tests have their log kept"""
754
class LogTester(TestCase):
757
self.log('this will be kept\n')
758
self.fail('this test fails')
760
sio = cStringIO.StringIO()
761
runner = TextTestRunner(stream=sio)
762
test = LogTester('test_fail')
763
result = self.run_test_runner(runner, test)
765
text = sio.getvalue()
766
self.assertContainsRe(text, 'this will be kept')
767
self.assertContainsRe(text, 'this test fails')
769
log = test._get_log()
770
self.assertContainsRe(log, 'this will be kept')
771
self.assertEqual(log, test._log_contents)
773
def test_error_log_kept(self):
774
"""Tests with errors have their log kept"""
776
class LogTester(TestCase):
778
def test_error(self):
779
self.log('this will be kept\n')
780
raise ValueError('random exception raised')
782
sio = cStringIO.StringIO()
783
runner = TextTestRunner(stream=sio)
784
test = LogTester('test_error')
785
result = self.run_test_runner(runner, test)
787
text = sio.getvalue()
788
self.assertContainsRe(text, 'this will be kept')
789
self.assertContainsRe(text, 'random exception raised')
791
log = test._get_log()
792
self.assertContainsRe(log, 'this will be kept')
793
self.assertEqual(log, test._log_contents)
796
class TestTestCase(TestCase):
797
"""Tests that test the core bzrlib TestCase."""
799
def inner_test(self):
800
# the inner child test
803
def outer_child(self):
804
# the outer child test
806
self.inner_test = TestTestCase("inner_child")
807
result = bzrlib.tests.TextTestResult(self._log_file,
810
self.inner_test.run(result)
813
def test_trace_nesting(self):
814
# this tests that each test case nests its trace facility correctly.
815
# we do this by running a test case manually. That test case (A)
816
# should setup a new log, log content to it, setup a child case (B),
817
# which should log independently, then case (A) should log a trailer
819
# we do two nested children so that we can verify the state of the
820
# logs after the outer child finishes is correct, which a bad clean
821
# up routine in tearDown might trigger a fault in our test with only
822
# one child, we should instead see the bad result inside our test with
824
# the outer child test
825
original_trace = bzrlib.trace._trace_file
826
outer_test = TestTestCase("outer_child")
827
result = bzrlib.tests.TextTestResult(self._log_file,
830
outer_test.run(result)
831
self.assertEqual(original_trace, bzrlib.trace._trace_file)
833
def method_that_times_a_bit_twice(self):
834
# call self.time twice to ensure it aggregates
835
self.time(time.sleep, 0.007)
836
self.time(time.sleep, 0.007)
838
def test_time_creates_benchmark_in_result(self):
839
"""Test that the TestCase.time() method accumulates a benchmark time."""
840
sample_test = TestTestCase("method_that_times_a_bit_twice")
841
output_stream = StringIO()
842
result = bzrlib.tests.VerboseTestResult(
843
unittest._WritelnDecorator(output_stream),
846
num_tests=sample_test.countTestCases())
847
sample_test.run(result)
848
self.assertContainsRe(
849
output_stream.getvalue(),
852
def test__gather_lsprof_in_benchmarks(self):
853
"""When _gather_lsprof_in_benchmarks is on, accumulate profile data.
855
Each self.time() call is individually and separately profiled.
860
raise TestSkipped("lsprof not installed.")
861
# overrides the class member with an instance member so no cleanup
863
self._gather_lsprof_in_benchmarks = True
864
self.time(time.sleep, 0.000)
865
self.time(time.sleep, 0.003)
866
self.assertEqual(2, len(self._benchcalls))
867
self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
868
self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
869
self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
870
self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
873
@symbol_versioning.deprecated_function(zero_eleven)
874
def sample_deprecated_function():
875
"""A deprecated function to test applyDeprecated with."""
879
def sample_undeprecated_function(a_param):
880
"""A undeprecated function to test applyDeprecated with."""
883
class ApplyDeprecatedHelper(object):
884
"""A helper class for ApplyDeprecated tests."""
886
@symbol_versioning.deprecated_method(zero_eleven)
887
def sample_deprecated_method(self, param_one):
888
"""A deprecated method for testing with."""
891
def sample_normal_method(self):
892
"""A undeprecated method."""
894
@symbol_versioning.deprecated_method(zero_ten)
895
def sample_nested_deprecation(self):
896
return sample_deprecated_function()
899
class TestExtraAssertions(TestCase):
900
"""Tests for new test assertions in bzrlib test suite"""
902
def test_assert_isinstance(self):
903
self.assertIsInstance(2, int)
904
self.assertIsInstance(u'', basestring)
905
self.assertRaises(AssertionError, self.assertIsInstance, None, int)
906
self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
908
def test_assertEndsWith(self):
909
self.assertEndsWith('foo', 'oo')
910
self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
912
def test_applyDeprecated_not_deprecated(self):
913
sample_object = ApplyDeprecatedHelper()
914
# calling an undeprecated callable raises an assertion
915
self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
916
sample_object.sample_normal_method)
917
self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
918
sample_undeprecated_function, "a param value")
919
# calling a deprecated callable (function or method) with the wrong
920
# expected deprecation fails.
921
self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
922
sample_object.sample_deprecated_method, "a param value")
923
self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
924
sample_deprecated_function)
925
# calling a deprecated callable (function or method) with the right
926
# expected deprecation returns the functions result.
927
self.assertEqual("a param value", self.applyDeprecated(zero_eleven,
928
sample_object.sample_deprecated_method, "a param value"))
929
self.assertEqual(2, self.applyDeprecated(zero_eleven,
930
sample_deprecated_function))
931
# calling a nested deprecation with the wrong deprecation version
932
# fails even if a deeper nested function was deprecated with the
934
self.assertRaises(AssertionError, self.applyDeprecated,
935
zero_eleven, sample_object.sample_nested_deprecation)
936
# calling a nested deprecation with the right deprecation value
937
# returns the calls result.
938
self.assertEqual(2, self.applyDeprecated(zero_ten,
939
sample_object.sample_nested_deprecation))
941
def test_callDeprecated(self):
942
def testfunc(be_deprecated, result=None):
943
if be_deprecated is True:
944
symbol_versioning.warn('i am deprecated', DeprecationWarning,
947
result = self.callDeprecated(['i am deprecated'], testfunc, True)
948
self.assertIs(None, result)
949
result = self.callDeprecated([], testfunc, False, 'result')
950
self.assertEqual('result', result)
951
self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
952
self.callDeprecated([], testfunc, be_deprecated=False)
955
class TestConvenienceMakers(TestCaseWithTransport):
956
"""Test for the make_* convenience functions."""
958
def test_make_branch_and_tree_with_format(self):
959
# we should be able to supply a format to make_branch_and_tree
960
self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
961
self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
962
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
963
bzrlib.bzrdir.BzrDirMetaFormat1)
964
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
965
bzrlib.bzrdir.BzrDirFormat6)
967
def test_make_branch_and_memory_tree(self):
968
# we should be able to get a new branch and a mutable tree from
969
# TestCaseWithTransport
970
tree = self.make_branch_and_memory_tree('a')
971
self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
974
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
976
def test_make_tree_for_sftp_branch(self):
977
"""Transports backed by local directories create local trees."""
979
tree = self.make_branch_and_tree('t1')
980
base = tree.bzrdir.root_transport.base
981
self.failIf(base.startswith('sftp'),
982
'base %r is on sftp but should be local' % base)
983
self.assertEquals(tree.bzrdir.root_transport,
984
tree.branch.bzrdir.root_transport)
985
self.assertEquals(tree.bzrdir.root_transport,
986
tree.branch.repository.bzrdir.root_transport)
989
class TestSelftest(TestCase):
990
"""Tests of bzrlib.tests.selftest."""
992
def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
995
factory_called.append(True)
999
self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1000
test_suite_factory=factory)
1001
self.assertEqual([True], factory_called)
1004
class TestSelftestCleanOutput(TestCaseInTempDir):
1006
def test_clean_output(self):
1007
# test functionality of clean_selftest_output()
1008
from bzrlib.tests import clean_selftest_output
1010
dirs = ('test0000.tmp', 'test0001.tmp', 'bzrlib', 'tests')
1011
files = ('bzr', 'setup.py', 'test9999.tmp')
1016
f.write('content of ')
1021
before = os.listdir(root)
1023
self.assertEquals(['bzr','bzrlib','setup.py',
1024
'test0000.tmp','test0001.tmp',
1025
'test9999.tmp','tests'],
1027
clean_selftest_output(root, quiet=True)
1028
after = os.listdir(root)
1030
self.assertEquals(['bzr','bzrlib','setup.py',
1031
'test9999.tmp','tests'],
added
removed
bzrlib/tests/test_selftest.py
