~bzr-pqm/bzr/bzr.dev

2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
1185.51.1 by Martin Pool
Better message when failing to import a test suite.
2
#
3
# This program is free software; you can redistribute it and/or modify
2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
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.
1185.51.1 by Martin Pool
Better message when failing to import a test suite.
7
#
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.
12
#
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
16
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
17
"""Tests for the test framework."""
1185.51.1 by Martin Pool
Better message when failing to import a test suite.
18
2036.1.1 by John Arbash Meinel
test that logs are kept or deleted when appropriate
19
import cStringIO
1185.51.1 by Martin Pool
Better message when failing to import a test suite.
20
import os
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
21
from StringIO import StringIO
1185.51.1 by Martin Pool
Better message when failing to import a test suite.
22
import sys
1707.2.3 by Robert Collins
Add a setBenchmarkTime method to the bzrlib test result allowing introduction of granular benchmarking. (Robert Collins, Martin Pool).
23
import time
1185.33.95 by Martin Pool
New TestSkipped facility, and tests for it.
24
import unittest
1185.62.24 by John Arbash Meinel
Changing the exception that sftp.py throws when it can't find paramiko, so that the test suite can handle it.
25
import warnings
1185.51.1 by Martin Pool
Better message when failing to import a test suite.
26
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
27
import bzrlib
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
28
from bzrlib import (
29
    bzrdir,
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
30
    errors,
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
31
    memorytree,
32
    osutils,
33
    repository,
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
34
    symbol_versioning,
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
35
    )
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
36
from bzrlib.progress import _BaseProgressBar
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
37
from bzrlib.repofmt import weaverepo
38
from bzrlib.symbol_versioning import zero_ten, zero_eleven
1526.1.3 by Robert Collins
Merge from upstream.
39
from bzrlib.tests import (
1534.4.31 by Robert Collins
cleanedup test_outside_wt
40
                          ChrootedTestCase,
1526.1.3 by Robert Collins
Merge from upstream.
41
                          TestCase,
42
                          TestCaseInTempDir,
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
43
                          TestCaseWithMemoryTransport,
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
44
                          TestCaseWithTransport,
1526.1.3 by Robert Collins
Merge from upstream.
45
                          TestSkipped,
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
46
                          TestSuite,
1526.1.3 by Robert Collins
Merge from upstream.
47
                          TextTestRunner,
48
                          )
1910.14.1 by Andrew Bennetts
Fix to make_branch_and_tree's behavior when used with an sftp transport.
49
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
1707.2.2 by Robert Collins
Start on bench_add, an add benchtest.
50
from bzrlib.tests.TestUtil import _load_module_by_name
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
51
from bzrlib.trace import note
1910.13.1 by Andrew Bennetts
Make make_bzrdir preserve the transport.
52
from bzrlib.transport.memory import MemoryServer, MemoryTransport
1951.1.1 by Andrew Bennetts
Make test_bench_history and _get_bzr_source_tree tolerant of UnknownFormatError for the bzr workingtree.
53
from bzrlib.version import _get_bzr_source_tree
1185.51.1 by Martin Pool
Better message when failing to import a test suite.
54
55
56
class SelftestTests(TestCase):
57
58
    def test_import_tests(self):
59
        mod = _load_module_by_name('bzrlib.tests.test_selftest')
60
        self.assertEqual(mod.SelftestTests, SelftestTests)
61
62
    def test_import_test_failure(self):
63
        self.assertRaises(ImportError,
64
                          _load_module_by_name,
65
                          'bzrlib.no-name-yet')
66
67
class MetaTestLog(TestCase):
1526.1.1 by Robert Collins
Run the test suite with no locale as well as the default locale. Also add a test for build_tree_shape to selftest.
68
1185.51.1 by Martin Pool
Better message when failing to import a test suite.
69
    def test_logging(self):
70
        """Test logs are captured when a test fails."""
71
        self.log('a test message')
72
        self._log_file.flush()
1927.3.1 by Carl Friedrich Bolz
Throw away on-disk logfile when possible.
73
        self.assertContainsRe(self._get_log(keep_log_file=True),
74
                              'a test message\n')
1185.33.95 by Martin Pool
New TestSkipped facility, and tests for it.
75
76
1526.1.1 by Robert Collins
Run the test suite with no locale as well as the default locale. Also add a test for build_tree_shape to selftest.
77
class TestTreeShape(TestCaseInTempDir):
78
79
    def test_unicode_paths(self):
80
        filename = u'hell\u00d8'
1526.1.4 by Robert Collins
forgot my self.
81
        try:
82
            self.build_tree_contents([(filename, 'contents of hello')])
83
        except UnicodeEncodeError:
84
            raise TestSkipped("can't build unicode working tree in "
85
                "filesystem encoding %s" % sys.getfilesystemencoding())
1526.1.1 by Robert Collins
Run the test suite with no locale as well as the default locale. Also add a test for build_tree_shape to selftest.
86
        self.failUnlessExists(filename)
1526.1.3 by Robert Collins
Merge from upstream.
87
88
1530.1.1 by Robert Collins
Minimal infrastructure to test TransportTestProviderAdapter.
89
class TestTransportProviderAdapter(TestCase):
1530.1.21 by Robert Collins
Review feedback fixes.
90
    """A group of tests that test the transport implementation adaption core.
91
1551.1.1 by Martin Pool
[merge] branch-formats branch, and reconcile changes
92
    This is a meta test that the tests are applied to all available 
93
    transports.
94
1530.1.21 by Robert Collins
Review feedback fixes.
95
    This will be generalised in the future which is why it is in this 
96
    test file even though it is specific to transport tests at the moment.
97
    """
1530.1.1 by Robert Collins
Minimal infrastructure to test TransportTestProviderAdapter.
98
1530.1.11 by Robert Collins
Push the transport permutations list into each transport module allowing for automatic testing of new modules that are registered as transports.
99
    def test_get_transport_permutations(self):
1530.1.21 by Robert Collins
Review feedback fixes.
100
        # this checks that we the module get_test_permutations call
101
        # is made by the adapter get_transport_test_permitations method.
1530.1.11 by Robert Collins
Push the transport permutations list into each transport module allowing for automatic testing of new modules that are registered as transports.
102
        class MockModule(object):
103
            def get_test_permutations(self):
104
                return sample_permutation
105
        sample_permutation = [(1,2), (3,4)]
106
        from bzrlib.transport import TransportTestProviderAdapter
107
        adapter = TransportTestProviderAdapter()
108
        self.assertEqual(sample_permutation,
109
                         adapter.get_transport_test_permutations(MockModule()))
110
111
    def test_adapter_checks_all_modules(self):
1530.1.21 by Robert Collins
Review feedback fixes.
112
        # this checks that the adapter returns as many permurtations as
113
        # there are in all the registered# transport modules for there
114
        # - we assume if this matches its probably doing the right thing
115
        # especially in combination with the tests for setting the right
116
        # classes below.
1530.1.11 by Robert Collins
Push the transport permutations list into each transport module allowing for automatic testing of new modules that are registered as transports.
117
        from bzrlib.transport import (TransportTestProviderAdapter,
118
                                      _get_transport_modules
119
                                      )
120
        modules = _get_transport_modules()
121
        permutation_count = 0
122
        for module in modules:
1185.62.24 by John Arbash Meinel
Changing the exception that sftp.py throws when it can't find paramiko, so that the test suite can handle it.
123
            try:
124
                permutation_count += len(reduce(getattr, 
125
                    (module + ".get_test_permutations").split('.')[1:],
126
                     __import__(module))())
127
            except errors.DependencyNotPresent:
128
                pass
1530.1.11 by Robert Collins
Push the transport permutations list into each transport module allowing for automatic testing of new modules that are registered as transports.
129
        input_test = TestTransportProviderAdapter(
130
            "test_adapter_sets_transport_class")
131
        adapter = TransportTestProviderAdapter()
132
        self.assertEqual(permutation_count,
133
                         len(list(iter(adapter.adapt(input_test)))))
134
1530.1.1 by Robert Collins
Minimal infrastructure to test TransportTestProviderAdapter.
135
    def test_adapter_sets_transport_class(self):
1540.3.21 by Martin Pool
Trim test for TestTransportProviderAdapter to be less dependent on
136
        # Check that the test adapter inserts a transport and server into the
137
        # generated test.
138
        #
139
        # This test used to know about all the possible transports and the
140
        # order they were returned but that seems overly brittle (mbp
141
        # 20060307)
1530.1.1 by Robert Collins
Minimal infrastructure to test TransportTestProviderAdapter.
142
        input_test = TestTransportProviderAdapter(
143
            "test_adapter_sets_transport_class")
1540.3.21 by Martin Pool
Trim test for TestTransportProviderAdapter to be less dependent on
144
        from bzrlib.transport import TransportTestProviderAdapter
1530.1.1 by Robert Collins
Minimal infrastructure to test TransportTestProviderAdapter.
145
        suite = TransportTestProviderAdapter().adapt(input_test)
1540.3.21 by Martin Pool
Trim test for TestTransportProviderAdapter to be less dependent on
146
        tests = list(iter(suite))
147
        self.assertTrue(len(tests) > 6)
148
        # there are at least that many builtin transports
149
        one_test = tests[0]
150
        self.assertTrue(issubclass(one_test.transport_class, 
151
                                   bzrlib.transport.Transport))
152
        self.assertTrue(issubclass(one_test.transport_server, 
153
                                   bzrlib.transport.Server))
1534.4.3 by Robert Collins
Implement BranchTestProviderAdapter, so tests now run across all branch formats.
154
155
156
class TestBranchProviderAdapter(TestCase):
157
    """A group of tests that test the branch implementation test adapter."""
158
159
    def test_adapted_tests(self):
160
        # check that constructor parameters are passed through to the adapted
161
        # test.
162
        from bzrlib.branch import BranchTestProviderAdapter
163
        input_test = TestBranchProviderAdapter(
164
            "test_adapted_tests")
165
        server1 = "a"
166
        server2 = "b"
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
167
        formats = [("c", "C"), ("d", "D")]
1534.4.3 by Robert Collins
Implement BranchTestProviderAdapter, so tests now run across all branch formats.
168
        adapter = BranchTestProviderAdapter(server1, server2, formats)
169
        suite = adapter.adapt(input_test)
170
        tests = list(iter(suite))
171
        self.assertEqual(2, len(tests))
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
172
        self.assertEqual(tests[0].branch_format, formats[0][0])
173
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
1534.4.3 by Robert Collins
Implement BranchTestProviderAdapter, so tests now run across all branch formats.
174
        self.assertEqual(tests[0].transport_server, server1)
175
        self.assertEqual(tests[0].transport_readonly_server, server2)
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
176
        self.assertEqual(tests[1].branch_format, formats[1][0])
177
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
1534.4.3 by Robert Collins
Implement BranchTestProviderAdapter, so tests now run across all branch formats.
178
        self.assertEqual(tests[1].transport_server, server1)
179
        self.assertEqual(tests[1].transport_readonly_server, server2)
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
180
181
1534.4.39 by Robert Collins
Basic BzrDir support.
182
class TestBzrDirProviderAdapter(TestCase):
183
    """A group of tests that test the bzr dir implementation test adapter."""
184
185
    def test_adapted_tests(self):
186
        # check that constructor parameters are passed through to the adapted
187
        # test.
188
        from bzrlib.bzrdir import BzrDirTestProviderAdapter
189
        input_test = TestBzrDirProviderAdapter(
190
            "test_adapted_tests")
191
        server1 = "a"
192
        server2 = "b"
193
        formats = ["c", "d"]
194
        adapter = BzrDirTestProviderAdapter(server1, server2, formats)
195
        suite = adapter.adapt(input_test)
196
        tests = list(iter(suite))
197
        self.assertEqual(2, len(tests))
198
        self.assertEqual(tests[0].bzrdir_format, formats[0])
199
        self.assertEqual(tests[0].transport_server, server1)
200
        self.assertEqual(tests[0].transport_readonly_server, server2)
201
        self.assertEqual(tests[1].bzrdir_format, formats[1])
202
        self.assertEqual(tests[1].transport_server, server1)
203
        self.assertEqual(tests[1].transport_readonly_server, server2)
204
205
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
206
class TestRepositoryProviderAdapter(TestCase):
207
    """A group of tests that test the repository implementation test adapter."""
208
209
    def test_adapted_tests(self):
210
        # check that constructor parameters are passed through to the adapted
211
        # test.
212
        from bzrlib.repository import RepositoryTestProviderAdapter
213
        input_test = TestRepositoryProviderAdapter(
214
            "test_adapted_tests")
215
        server1 = "a"
216
        server2 = "b"
217
        formats = [("c", "C"), ("d", "D")]
218
        adapter = RepositoryTestProviderAdapter(server1, server2, formats)
219
        suite = adapter.adapt(input_test)
220
        tests = list(iter(suite))
221
        self.assertEqual(2, len(tests))
222
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
223
        self.assertEqual(tests[0].repository_format, formats[0][0])
224
        self.assertEqual(tests[0].transport_server, server1)
225
        self.assertEqual(tests[0].transport_readonly_server, server2)
226
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
227
        self.assertEqual(tests[1].repository_format, formats[1][0])
228
        self.assertEqual(tests[1].transport_server, server1)
229
        self.assertEqual(tests[1].transport_readonly_server, server2)
230
231
1534.1.29 by Robert Collins
Add a test environment for InterRepository objects, and remove the fetch corner case tests from test_repository.
232
class TestInterRepositoryProviderAdapter(TestCase):
233
    """A group of tests that test the InterRepository test adapter."""
234
235
    def test_adapted_tests(self):
236
        # check that constructor parameters are passed through to the adapted
237
        # test.
238
        from bzrlib.repository import InterRepositoryTestProviderAdapter
239
        input_test = TestInterRepositoryProviderAdapter(
240
            "test_adapted_tests")
241
        server1 = "a"
242
        server2 = "b"
1563.2.20 by Robert Collins
Add a revision store test adapter.
243
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
1534.1.29 by Robert Collins
Add a test environment for InterRepository objects, and remove the fetch corner case tests from test_repository.
244
        adapter = InterRepositoryTestProviderAdapter(server1, server2, formats)
245
        suite = adapter.adapt(input_test)
246
        tests = list(iter(suite))
247
        self.assertEqual(2, len(tests))
248
        self.assertEqual(tests[0].interrepo_class, formats[0][0])
249
        self.assertEqual(tests[0].repository_format, formats[0][1])
250
        self.assertEqual(tests[0].repository_format_to, formats[0][2])
251
        self.assertEqual(tests[0].transport_server, server1)
252
        self.assertEqual(tests[0].transport_readonly_server, server2)
1563.2.20 by Robert Collins
Add a revision store test adapter.
253
        self.assertEqual(tests[1].interrepo_class, formats[1][0])
1534.1.29 by Robert Collins
Add a test environment for InterRepository objects, and remove the fetch corner case tests from test_repository.
254
        self.assertEqual(tests[1].repository_format, formats[1][1])
255
        self.assertEqual(tests[1].repository_format_to, formats[1][2])
256
        self.assertEqual(tests[1].transport_server, server1)
257
        self.assertEqual(tests[1].transport_readonly_server, server2)
258
259
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
260
class TestInterVersionedFileProviderAdapter(TestCase):
261
    """A group of tests that test the InterVersionedFile test adapter."""
262
263
    def test_adapted_tests(self):
264
        # check that constructor parameters are passed through to the adapted
265
        # test.
266
        from bzrlib.versionedfile import InterVersionedFileTestProviderAdapter
267
        input_test = TestInterRepositoryProviderAdapter(
268
            "test_adapted_tests")
269
        server1 = "a"
270
        server2 = "b"
1563.2.20 by Robert Collins
Add a revision store test adapter.
271
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
272
        adapter = InterVersionedFileTestProviderAdapter(server1, server2, formats)
273
        suite = adapter.adapt(input_test)
274
        tests = list(iter(suite))
275
        self.assertEqual(2, len(tests))
276
        self.assertEqual(tests[0].interversionedfile_class, formats[0][0])
277
        self.assertEqual(tests[0].versionedfile_factory, formats[0][1])
278
        self.assertEqual(tests[0].versionedfile_factory_to, formats[0][2])
279
        self.assertEqual(tests[0].transport_server, server1)
280
        self.assertEqual(tests[0].transport_readonly_server, server2)
1563.2.20 by Robert Collins
Add a revision store test adapter.
281
        self.assertEqual(tests[1].interversionedfile_class, formats[1][0])
1563.2.12 by Robert Collins
Checkpointing: created InterObject to factor out common inter object worker code, added InterVersionedFile and tests to allow making join work between any versionedfile.
282
        self.assertEqual(tests[1].versionedfile_factory, formats[1][1])
283
        self.assertEqual(tests[1].versionedfile_factory_to, formats[1][2])
284
        self.assertEqual(tests[1].transport_server, server1)
285
        self.assertEqual(tests[1].transport_readonly_server, server2)
286
287
1563.2.20 by Robert Collins
Add a revision store test adapter.
288
class TestRevisionStoreProviderAdapter(TestCase):
289
    """A group of tests that test the RevisionStore test adapter."""
290
291
    def test_adapted_tests(self):
292
        # check that constructor parameters are passed through to the adapted
293
        # test.
294
        from bzrlib.store.revision import RevisionStoreTestProviderAdapter
295
        input_test = TestRevisionStoreProviderAdapter(
296
            "test_adapted_tests")
297
        # revision stores need a store factory - i.e. RevisionKnit
298
        #, a readonly and rw transport 
299
        # transport servers:
300
        server1 = "a"
301
        server2 = "b"
302
        store_factories = ["c", "d"]
303
        adapter = RevisionStoreTestProviderAdapter(server1, server2, store_factories)
304
        suite = adapter.adapt(input_test)
305
        tests = list(iter(suite))
306
        self.assertEqual(2, len(tests))
307
        self.assertEqual(tests[0].store_factory, store_factories[0][0])
308
        self.assertEqual(tests[0].transport_server, server1)
309
        self.assertEqual(tests[0].transport_readonly_server, server2)
310
        self.assertEqual(tests[1].store_factory, store_factories[1][0])
311
        self.assertEqual(tests[1].transport_server, server1)
312
        self.assertEqual(tests[1].transport_readonly_server, server2)
313
314
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
315
class TestWorkingTreeProviderAdapter(TestCase):
316
    """A group of tests that test the workingtree implementation test adapter."""
317
318
    def test_adapted_tests(self):
319
        # check that constructor parameters are passed through to the adapted
320
        # test.
321
        from bzrlib.workingtree import WorkingTreeTestProviderAdapter
322
        input_test = TestWorkingTreeProviderAdapter(
323
            "test_adapted_tests")
324
        server1 = "a"
325
        server2 = "b"
326
        formats = [("c", "C"), ("d", "D")]
327
        adapter = WorkingTreeTestProviderAdapter(server1, server2, formats)
328
        suite = adapter.adapt(input_test)
329
        tests = list(iter(suite))
330
        self.assertEqual(2, len(tests))
331
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
332
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
333
        self.assertEqual(tests[0].transport_server, server1)
334
        self.assertEqual(tests[0].transport_readonly_server, server2)
335
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
336
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
337
        self.assertEqual(tests[1].transport_server, server1)
338
        self.assertEqual(tests[1].transport_readonly_server, server2)
339
340
1852.6.1 by Robert Collins
Start tree implementation tests.
341
class TestTreeProviderAdapter(TestCase):
342
    """Test the setup of tree_implementation tests."""
343
344
    def test_adapted_tests(self):
345
        # the tree implementation adapter is meant to setup one instance for
346
        # each working tree format, and one additional instance that will
347
        # use the default wt format, but create a revision tree for the tests.
348
        # this means that the wt ones should have the workingtree_to_test_tree
349
        # attribute set to 'return_parameter' and the revision one set to
350
        # revision_tree_from_workingtree.
351
352
        from bzrlib.tests.tree_implementations import (
353
            TreeTestProviderAdapter,
354
            return_parameter,
355
            revision_tree_from_workingtree
356
            )
2255.2.164 by Martin Pool
Change the default format for some tests from AB1 back to WorkingTreeFormat3
357
        from bzrlib.workingtree import WorkingTreeFormat, WorkingTreeFormat3
1852.6.1 by Robert Collins
Start tree implementation tests.
358
        input_test = TestTreeProviderAdapter(
359
            "test_adapted_tests")
360
        server1 = "a"
361
        server2 = "b"
362
        formats = [("c", "C"), ("d", "D")]
363
        adapter = TreeTestProviderAdapter(server1, server2, formats)
364
        suite = adapter.adapt(input_test)
365
        tests = list(iter(suite))
2255.6.3 by Aaron Bentley
tweak tests
366
        self.assertEqual(4, len(tests))
2255.2.164 by Martin Pool
Change the default format for some tests from AB1 back to WorkingTreeFormat3
367
        # this must match the default format setp up in
368
        # TreeTestProviderAdapter.adapt
369
        default_format = WorkingTreeFormat3
1852.6.1 by Robert Collins
Start tree implementation tests.
370
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
371
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
372
        self.assertEqual(tests[0].transport_server, server1)
373
        self.assertEqual(tests[0].transport_readonly_server, server2)
374
        self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
375
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
376
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
377
        self.assertEqual(tests[1].transport_server, server1)
378
        self.assertEqual(tests[1].transport_readonly_server, server2)
379
        self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
2100.3.20 by Aaron Bentley
Implement tree comparison for tree references
380
        self.assertIsInstance(tests[2].workingtree_format, default_format)
381
        #self.assertEqual(tests[2].bzrdir_format,
382
        #                 default_format._matchingbzrdir)
1852.6.1 by Robert Collins
Start tree implementation tests.
383
        self.assertEqual(tests[2].transport_server, server1)
384
        self.assertEqual(tests[2].transport_readonly_server, server2)
385
        self.assertEqual(tests[2].workingtree_to_test_tree,
386
            revision_tree_from_workingtree)
387
388
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
389
class TestInterTreeProviderAdapter(TestCase):
390
    """A group of tests that test the InterTreeTestAdapter."""
391
392
    def test_adapted_tests(self):
393
        # check that constructor parameters are passed through to the adapted
394
        # test.
395
        # for InterTree tests we want the machinery to bring up two trees in
396
        # each instance: the base one, and the one we are interacting with.
397
        # because each optimiser can be direction specific, we need to test
398
        # each optimiser in its chosen direction.
399
        # unlike the TestProviderAdapter we dont want to automatically add a
400
        # parameterised one for WorkingTree - the optimisers will tell us what
401
        # ones to add.
402
        from bzrlib.tests.tree_implementations import (
403
            return_parameter,
404
            revision_tree_from_workingtree
405
            )
406
        from bzrlib.tests.intertree_implementations import (
407
            InterTreeTestProviderAdapter,
408
            )
409
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
410
        input_test = TestInterTreeProviderAdapter(
411
            "test_adapted_tests")
412
        server1 = "a"
413
        server2 = "b"
414
        format1 = WorkingTreeFormat2()
415
        format2 = WorkingTreeFormat3()
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
416
        formats = [(str, format1, format2, "converter1"),
417
            (int, format2, format1, "converter2")]
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
418
        adapter = InterTreeTestProviderAdapter(server1, server2, formats)
419
        suite = adapter.adapt(input_test)
420
        tests = list(iter(suite))
421
        self.assertEqual(2, len(tests))
422
        self.assertEqual(tests[0].intertree_class, formats[0][0])
423
        self.assertEqual(tests[0].workingtree_format, formats[0][1])
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
424
        self.assertEqual(tests[0].workingtree_format_to, formats[0][2])
425
        self.assertEqual(tests[0].mutable_trees_to_test_trees, formats[0][3])
426
        self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
427
        self.assertEqual(tests[0].transport_server, server1)
428
        self.assertEqual(tests[0].transport_readonly_server, server2)
429
        self.assertEqual(tests[1].intertree_class, formats[1][0])
430
        self.assertEqual(tests[1].workingtree_format, formats[1][1])
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
431
        self.assertEqual(tests[1].workingtree_format_to, formats[1][2])
432
        self.assertEqual(tests[1].mutable_trees_to_test_trees, formats[1][3])
433
        self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
434
        self.assertEqual(tests[1].transport_server, server1)
435
        self.assertEqual(tests[1].transport_readonly_server, server2)
436
1987.1.1 by John Arbash Meinel
Update the test suite to put HOME in a different directory
437
438
class TestTestCaseInTempDir(TestCaseInTempDir):
439
440
    def test_home_is_not_working(self):
441
        self.assertNotEqual(self.test_dir, self.test_home_dir)
442
        cwd = osutils.getcwd()
1987.1.4 by John Arbash Meinel
fix the home_is_not_working test
443
        self.assertEqual(self.test_dir, cwd)
1987.1.1 by John Arbash Meinel
Update the test suite to put HOME in a different directory
444
        self.assertEqual(self.test_home_dir, os.environ['HOME'])
445
446
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
447
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
448
449
    def test_home_is_non_existant_dir_under_root(self):
450
        """The test_home_dir for TestCaseWithMemoryTransport is missing.
451
452
        This is because TestCaseWithMemoryTransport is for tests that do not
453
        need any disk resources: they should be hooked into bzrlib in such a 
454
        way that no global settings are being changed by the test (only a 
455
        few tests should need to do that), and having a missing dir as home is
456
        an effective way to ensure that this is the case.
457
        """
458
        self.assertEqual(self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
459
            self.test_home_dir)
460
        self.assertEqual(self.test_home_dir, os.environ['HOME'])
461
        
462
    def test_cwd_is_TEST_ROOT(self):
463
        self.assertEqual(self.test_dir, self.TEST_ROOT)
464
        cwd = osutils.getcwd()
465
        self.assertEqual(self.test_dir, cwd)
466
467
    def test_make_branch_and_memory_tree(self):
468
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
469
470
        This is hard to comprehensively robustly test, so we settle for making
471
        a branch and checking no directory was created at its relpath.
472
        """
473
        tree = self.make_branch_and_memory_tree('dir')
2227.2.2 by v.ladeuil+lp at free
Cleanup.
474
        # Guard against regression into MemoryTransport leaking
475
        # files to disk instead of keeping them in memory.
476
        self.failIf(osutils.lexists('dir'))
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
477
        self.assertIsInstance(tree, memorytree.MemoryTree)
478
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
479
    def test_make_branch_and_memory_tree_with_format(self):
480
        """make_branch_and_memory_tree should accept a format option."""
481
        format = bzrdir.BzrDirMetaFormat1()
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
482
        format.repository_format = weaverepo.RepositoryFormat7()
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
483
        tree = self.make_branch_and_memory_tree('dir', format=format)
2227.2.2 by v.ladeuil+lp at free
Cleanup.
484
        # Guard against regression into MemoryTransport leaking
485
        # files to disk instead of keeping them in memory.
486
        self.failIf(osutils.lexists('dir'))
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
487
        self.assertIsInstance(tree, memorytree.MemoryTree)
488
        self.assertEqual(format.repository_format.__class__,
489
            tree.branch.repository._format.__class__)
490
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
491
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
492
class TestTestCaseWithTransport(TestCaseWithTransport):
493
    """Tests for the convenience functions TestCaseWithTransport introduces."""
494
495
    def test_get_readonly_url_none(self):
496
        from bzrlib.transport import get_transport
497
        from bzrlib.transport.memory import MemoryServer
498
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
499
        self.transport_server = MemoryServer
500
        self.transport_readonly_server = None
501
        # calling get_readonly_transport() constructs a decorator on the url
502
        # for the server
503
        url = self.get_readonly_url()
1534.4.11 by Robert Collins
Convert test_open_containing from being a Remote test to being the more accurate Chrooted test.
504
        url2 = self.get_readonly_url('foo/bar')
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
505
        t = get_transport(url)
1534.4.11 by Robert Collins
Convert test_open_containing from being a Remote test to being the more accurate Chrooted test.
506
        t2 = get_transport(url2)
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
507
        self.failUnless(isinstance(t, ReadonlyTransportDecorator))
1534.4.11 by Robert Collins
Convert test_open_containing from being a Remote test to being the more accurate Chrooted test.
508
        self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
509
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
510
511
    def test_get_readonly_url_http(self):
2004.1.25 by v.ladeuil+lp at free
Shuffle http related test code. Hopefully it ends up at the right place :)
512
        from bzrlib.tests.HttpServer import HttpServer
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
513
        from bzrlib.transport import get_transport
1951.2.1 by Martin Pool
Change to using LocalURLServer for testing.
514
        from bzrlib.transport.local import LocalURLServer
2004.1.25 by v.ladeuil+lp at free
Shuffle http related test code. Hopefully it ends up at the right place :)
515
        from bzrlib.transport.http import HttpTransportBase
1951.2.1 by Martin Pool
Change to using LocalURLServer for testing.
516
        self.transport_server = LocalURLServer
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
517
        self.transport_readonly_server = HttpServer
518
        # calling get_readonly_transport() gives us a HTTP server instance.
519
        url = self.get_readonly_url()
1534.4.11 by Robert Collins
Convert test_open_containing from being a Remote test to being the more accurate Chrooted test.
520
        url2 = self.get_readonly_url('foo/bar')
1540.3.6 by Martin Pool
[merge] update from bzr.dev
521
        # the transport returned may be any HttpTransportBase subclass
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
522
        t = get_transport(url)
1534.4.11 by Robert Collins
Convert test_open_containing from being a Remote test to being the more accurate Chrooted test.
523
        t2 = get_transport(url2)
1540.3.6 by Martin Pool
[merge] update from bzr.dev
524
        self.failUnless(isinstance(t, HttpTransportBase))
525
        self.failUnless(isinstance(t2, HttpTransportBase))
1534.4.11 by Robert Collins
Convert test_open_containing from being a Remote test to being the more accurate Chrooted test.
526
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
1534.4.31 by Robert Collins
cleanedup test_outside_wt
527
1553.5.68 by Martin Pool
Add new TestCaseWithTransport.assertIsDirectory() and tests
528
    def test_is_directory(self):
529
        """Test assertIsDirectory assertion"""
530
        t = self.get_transport()
531
        self.build_tree(['a_dir/', 'a_file'], transport=t)
532
        self.assertIsDirectory('a_dir', t)
533
        self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
534
        self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
1534.4.31 by Robert Collins
cleanedup test_outside_wt
535
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
536
1910.13.1 by Andrew Bennetts
Make make_bzrdir preserve the transport.
537
class TestTestCaseTransports(TestCaseWithTransport):
538
539
    def setUp(self):
540
        super(TestTestCaseTransports, self).setUp()
541
        self.transport_server = MemoryServer
542
543
    def test_make_bzrdir_preserves_transport(self):
544
        t = self.get_transport()
545
        result_bzrdir = self.make_bzrdir('subdir')
546
        self.assertIsInstance(result_bzrdir.transport, 
547
                              MemoryTransport)
548
        # should not be on disk, should only be in memory
549
        self.failIfExists('subdir')
550
551
1534.4.31 by Robert Collins
cleanedup test_outside_wt
552
class TestChrootedTest(ChrootedTestCase):
553
554
    def test_root_is_root(self):
555
        from bzrlib.transport import get_transport
556
        t = get_transport(self.get_readonly_url())
557
        url = t.base
558
        self.assertEqual(url, t.clone('..').base)
1540.3.22 by Martin Pool
[patch] Add TestCase.assertIsInstance
559
560
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
561
class MockProgress(_BaseProgressBar):
562
    """Progress-bar standin that records calls.
563
564
    Useful for testing pb using code.
565
    """
566
567
    def __init__(self):
568
        _BaseProgressBar.__init__(self)
569
        self.calls = []
570
571
    def tick(self):
572
        self.calls.append(('tick',))
573
574
    def update(self, msg=None, current=None, total=None):
575
        self.calls.append(('update', msg, current, total))
576
577
    def clear(self):
578
        self.calls.append(('clear',))
579
1864.3.1 by John Arbash Meinel
Print out when a test fails in non verbose mode, run transport tests later
580
    def note(self, msg, *args):
581
        self.calls.append(('note', msg, args))
582
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
583
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
584
class TestTestResult(TestCase):
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
585
1707.2.3 by Robert Collins
Add a setBenchmarkTime method to the bzrlib test result allowing introduction of granular benchmarking. (Robert Collins, Martin Pool).
586
    def test_elapsed_time_with_benchmarking(self):
2095.4.1 by Martin Pool
Better progress bars during tests
587
        result = bzrlib.tests.TextTestResult(self._log_file,
1707.2.3 by Robert Collins
Add a setBenchmarkTime method to the bzrlib test result allowing introduction of granular benchmarking. (Robert Collins, Martin Pool).
588
                                        descriptions=0,
589
                                        verbosity=1,
590
                                        )
591
        result._recordTestStartTime()
592
        time.sleep(0.003)
1707.2.4 by Robert Collins
Teach the bzrlib TestCase to report the time take by calls to self.time as benchmark time, allowing granular reporting of time during benchmarks. See bzrlib.benchmarks.bench_add. (Robert Collins, Martin Pool)
593
        result.extractBenchmarkTime(self)
1707.2.3 by Robert Collins
Add a setBenchmarkTime method to the bzrlib test result allowing introduction of granular benchmarking. (Robert Collins, Martin Pool).
594
        timed_string = result._testTimeString()
595
        # without explicit benchmarking, we should get a simple time.
2196.1.2 by Martin Pool
Loosen requirements for benchmark formatting in selftest
596
        self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms$")
1707.2.3 by Robert Collins
Add a setBenchmarkTime method to the bzrlib test result allowing introduction of granular benchmarking. (Robert Collins, Martin Pool).
597
        # if a benchmark time is given, we want a x of y style result.
1707.2.4 by Robert Collins
Teach the bzrlib TestCase to report the time take by calls to self.time as benchmark time, allowing granular reporting of time during benchmarks. See bzrlib.benchmarks.bench_add. (Robert Collins, Martin Pool)
598
        self.time(time.sleep, 0.001)
599
        result.extractBenchmarkTime(self)
1707.2.3 by Robert Collins
Add a setBenchmarkTime method to the bzrlib test result allowing introduction of granular benchmarking. (Robert Collins, Martin Pool).
600
        timed_string = result._testTimeString()
2196.1.2 by Martin Pool
Loosen requirements for benchmark formatting in selftest
601
        self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms/ *[ 1-9][0-9]ms$")
1707.2.4 by Robert Collins
Teach the bzrlib TestCase to report the time take by calls to self.time as benchmark time, allowing granular reporting of time during benchmarks. See bzrlib.benchmarks.bench_add. (Robert Collins, Martin Pool)
602
        # extracting the time from a non-bzrlib testcase sets to None
1707.2.3 by Robert Collins
Add a setBenchmarkTime method to the bzrlib test result allowing introduction of granular benchmarking. (Robert Collins, Martin Pool).
603
        result._recordTestStartTime()
1707.2.4 by Robert Collins
Teach the bzrlib TestCase to report the time take by calls to self.time as benchmark time, allowing granular reporting of time during benchmarks. See bzrlib.benchmarks.bench_add. (Robert Collins, Martin Pool)
604
        result.extractBenchmarkTime(
605
            unittest.FunctionTestCase(self.test_elapsed_time_with_benchmarking))
1707.2.3 by Robert Collins
Add a setBenchmarkTime method to the bzrlib test result allowing introduction of granular benchmarking. (Robert Collins, Martin Pool).
606
        timed_string = result._testTimeString()
2196.1.2 by Martin Pool
Loosen requirements for benchmark formatting in selftest
607
        self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms$")
1707.2.4 by Robert Collins
Teach the bzrlib TestCase to report the time take by calls to self.time as benchmark time, allowing granular reporting of time during benchmarks. See bzrlib.benchmarks.bench_add. (Robert Collins, Martin Pool)
608
        # cheat. Yes, wash thy mouth out with soap.
609
        self._benchtime = None
1707.2.3 by Robert Collins
Add a setBenchmarkTime method to the bzrlib test result allowing introduction of granular benchmarking. (Robert Collins, Martin Pool).
610
1819.1.1 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Give the test result object an optional benchmark
611
    def test_assigned_benchmark_file_stores_date(self):
612
        output = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
613
        result = bzrlib.tests.TextTestResult(self._log_file,
1819.1.1 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Give the test result object an optional benchmark
614
                                        descriptions=0,
615
                                        verbosity=1,
616
                                        bench_history=output
617
                                        )
618
        output_string = output.getvalue()
2095.4.1 by Martin Pool
Better progress bars during tests
619
        
1819.1.4 by Jan Balster
save the revison id for every benchmark run in .perf-history
620
        # if you are wondering about the regexp please read the comment in
621
        # test_bench_history (bzrlib.tests.test_selftest.TestRunner)
1951.1.2 by Andrew Bennetts
Relax test_assigned_benchmark_file_stores_date's regexp the same way we relaxed test_bench_history's.
622
        # XXX: what comment?  -- Andrew Bennetts
623
        self.assertContainsRe(output_string, "--date [0-9.]+")
1819.1.3 by Carl Friedrich Bolz
(lifeless, cfbolz): Add recording of benchmark results to the benchmark history
624
625
    def test_benchhistory_records_test_times(self):
626
        result_stream = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
627
        result = bzrlib.tests.TextTestResult(
1819.1.3 by Carl Friedrich Bolz
(lifeless, cfbolz): Add recording of benchmark results to the benchmark history
628
            self._log_file,
629
            descriptions=0,
630
            verbosity=1,
631
            bench_history=result_stream
632
            )
633
634
        # we want profile a call and check that its test duration is recorded
635
        # make a new test instance that when run will generate a benchmark
636
        example_test_case = TestTestResult("_time_hello_world_encoding")
637
        # execute the test, which should succeed and record times
638
        example_test_case.run(result)
639
        lines = result_stream.getvalue().splitlines()
640
        self.assertEqual(2, len(lines))
641
        self.assertContainsRe(lines[1],
642
            " *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
643
            "._time_hello_world_encoding")
644
 
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
645
    def _time_hello_world_encoding(self):
646
        """Profile two sleep calls
647
        
648
        This is used to exercise the test framework.
649
        """
650
        self.time(unicode, 'hello', errors='replace')
651
        self.time(unicode, 'world', errors='replace')
652
653
    def test_lsprofiling(self):
654
        """Verbose test result prints lsprof statistics from test cases."""
655
        try:
656
            import bzrlib.lsprof
657
        except ImportError:
658
            raise TestSkipped("lsprof not installed.")
659
        result_stream = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
660
        result = bzrlib.tests.VerboseTestResult(
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
661
            unittest._WritelnDecorator(result_stream),
662
            descriptions=0,
663
            verbosity=2,
664
            )
665
        # we want profile a call of some sort and check it is output by
666
        # addSuccess. We dont care about addError or addFailure as they
667
        # are not that interesting for performance tuning.
668
        # make a new test instance that when run will generate a profile
669
        example_test_case = TestTestResult("_time_hello_world_encoding")
670
        example_test_case._gather_lsprof_in_benchmarks = True
671
        # execute the test, which should succeed and record profiles
672
        example_test_case.run(result)
673
        # lsprofile_something()
674
        # if this worked we want 
675
        # LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
676
        #    CallCount    Recursive    Total(ms)   Inline(ms) module:lineno(function)
677
        # (the lsprof header)
678
        # ... an arbitrary number of lines
679
        # and the function call which is time.sleep.
680
        #           1        0            ???         ???       ???(sleep) 
681
        # and then repeated but with 'world', rather than 'hello'.
682
        # this should appear in the output stream of our test result.
1831.2.1 by Martin Pool
[trivial] Simplify & fix up lsprof blackbox test
683
        output = result_stream.getvalue()
684
        self.assertContainsRe(output,
685
            r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
686
        self.assertContainsRe(output,
687
            r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
688
        self.assertContainsRe(output,
689
            r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
690
        self.assertContainsRe(output,
691
            r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
692
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
693
694
class TestRunner(TestCase):
695
696
    def dummy_test(self):
697
        pass
698
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
699
    def run_test_runner(self, testrunner, test):
700
        """Run suite in testrunner, saving global state and restoring it.
701
702
        This current saves and restores:
703
        TestCaseInTempDir.TEST_ROOT
704
        
705
        There should be no tests in this file that use bzrlib.tests.TextTestRunner
706
        without using this convenience method, because of our use of global state.
707
        """
708
        old_root = TestCaseInTempDir.TEST_ROOT
709
        try:
710
            TestCaseInTempDir.TEST_ROOT = None
711
            return testrunner.run(test)
712
        finally:
713
            TestCaseInTempDir.TEST_ROOT = old_root
714
715
    def test_skipped_test(self):
716
        # run a test that is skipped, and check the suite as a whole still
717
        # succeeds.
718
        # skipping_test must be hidden in here so it's not run as a real test
719
        def skipping_test():
720
            raise TestSkipped('test intentionally skipped')
721
        runner = TextTestRunner(stream=self._log_file, keep_output=True)
722
        test = unittest.FunctionTestCase(skipping_test)
723
        result = self.run_test_runner(runner, test)
724
        self.assertTrue(result.wasSuccessful())
725
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
726
    def test_bench_history(self):
1951.1.1 by Andrew Bennetts
Make test_bench_history and _get_bzr_source_tree tolerant of UnknownFormatError for the bzr workingtree.
727
        # tests that the running the benchmark produces a history file
728
        # containing a timestamp and the revision id of the bzrlib source which
729
        # was tested.
730
        workingtree = _get_bzr_source_tree()
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
731
        test = TestRunner('dummy_test')
732
        output = StringIO()
733
        runner = TextTestRunner(stream=self._log_file, bench_history=output)
734
        result = self.run_test_runner(runner, test)
735
        output_string = output.getvalue()
1951.1.1 by Andrew Bennetts
Make test_bench_history and _get_bzr_source_tree tolerant of UnknownFormatError for the bzr workingtree.
736
        self.assertContainsRe(output_string, "--date [0-9.]+")
737
        if workingtree is not None:
1908.7.6 by Robert Collins
Deprecate WorkingTree.last_revision.
738
            revision_id = workingtree.get_parent_ids()[0]
1951.1.1 by Andrew Bennetts
Make test_bench_history and _get_bzr_source_tree tolerant of UnknownFormatError for the bzr workingtree.
739
            self.assertEndsWith(output_string.rstrip(), revision_id)
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
740
2036.1.1 by John Arbash Meinel
test that logs are kept or deleted when appropriate
741
    def test_success_log_deleted(self):
742
        """Successful tests have their log deleted"""
743
744
        class LogTester(TestCase):
745
746
            def test_success(self):
747
                self.log('this will be removed\n')
748
749
        sio = cStringIO.StringIO()
750
        runner = TextTestRunner(stream=sio)
751
        test = LogTester('test_success')
752
        result = self.run_test_runner(runner, test)
753
754
        log = test._get_log()
755
        self.assertEqual("DELETED log file to reduce memory footprint", log)
756
        self.assertEqual('', test._log_contents)
757
        self.assertIs(None, test._log_file_name)
758
759
    def test_fail_log_kept(self):
760
        """Failed tests have their log kept"""
761
762
        class LogTester(TestCase):
763
764
            def test_fail(self):
765
                self.log('this will be kept\n')
766
                self.fail('this test fails')
767
768
        sio = cStringIO.StringIO()
769
        runner = TextTestRunner(stream=sio)
770
        test = LogTester('test_fail')
771
        result = self.run_test_runner(runner, test)
772
773
        text = sio.getvalue()
774
        self.assertContainsRe(text, 'this will be kept')
775
        self.assertContainsRe(text, 'this test fails')
776
777
        log = test._get_log()
778
        self.assertContainsRe(log, 'this will be kept')
779
        self.assertEqual(log, test._log_contents)
780
781
    def test_error_log_kept(self):
782
        """Tests with errors have their log kept"""
783
784
        class LogTester(TestCase):
785
786
            def test_error(self):
787
                self.log('this will be kept\n')
788
                raise ValueError('random exception raised')
789
790
        sio = cStringIO.StringIO()
791
        runner = TextTestRunner(stream=sio)
792
        test = LogTester('test_error')
793
        result = self.run_test_runner(runner, test)
794
795
        text = sio.getvalue()
796
        self.assertContainsRe(text, 'this will be kept')
797
        self.assertContainsRe(text, 'random exception raised')
798
799
        log = test._get_log()
800
        self.assertContainsRe(log, 'this will be kept')
801
        self.assertEqual(log, test._log_contents)
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
802
2036.1.2 by John Arbash Meinel
whitespace fix
803
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
804
class TestTestCase(TestCase):
805
    """Tests that test the core bzrlib TestCase."""
806
807
    def inner_test(self):
808
        # the inner child test
809
        note("inner_test")
810
811
    def outer_child(self):
812
        # the outer child test
813
        note("outer_start")
814
        self.inner_test = TestTestCase("inner_child")
2095.4.1 by Martin Pool
Better progress bars during tests
815
        result = bzrlib.tests.TextTestResult(self._log_file,
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
816
                                        descriptions=0,
817
                                        verbosity=1)
818
        self.inner_test.run(result)
819
        note("outer finish")
820
821
    def test_trace_nesting(self):
822
        # this tests that each test case nests its trace facility correctly.
823
        # we do this by running a test case manually. That test case (A)
824
        # should setup a new log, log content to it, setup a child case (B),
825
        # which should log independently, then case (A) should log a trailer
826
        # and return.
827
        # we do two nested children so that we can verify the state of the 
828
        # logs after the outer child finishes is correct, which a bad clean
829
        # up routine in tearDown might trigger a fault in our test with only
830
        # one child, we should instead see the bad result inside our test with
831
        # the two children.
832
        # the outer child test
833
        original_trace = bzrlib.trace._trace_file
834
        outer_test = TestTestCase("outer_child")
2095.4.1 by Martin Pool
Better progress bars during tests
835
        result = bzrlib.tests.TextTestResult(self._log_file,
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
836
                                        descriptions=0,
837
                                        verbosity=1)
838
        outer_test.run(result)
839
        self.assertEqual(original_trace, bzrlib.trace._trace_file)
1707.2.4 by Robert Collins
Teach the bzrlib TestCase to report the time take by calls to self.time as benchmark time, allowing granular reporting of time during benchmarks. See bzrlib.benchmarks.bench_add. (Robert Collins, Martin Pool)
840
841
    def method_that_times_a_bit_twice(self):
842
        # call self.time twice to ensure it aggregates
1713.1.4 by Robert Collins
Make the test test_time_creates_benchmark_in_result more robust to timing variation.
843
        self.time(time.sleep, 0.007)
844
        self.time(time.sleep, 0.007)
1707.2.4 by Robert Collins
Teach the bzrlib TestCase to report the time take by calls to self.time as benchmark time, allowing granular reporting of time during benchmarks. See bzrlib.benchmarks.bench_add. (Robert Collins, Martin Pool)
845
846
    def test_time_creates_benchmark_in_result(self):
847
        """Test that the TestCase.time() method accumulates a benchmark time."""
848
        sample_test = TestTestCase("method_that_times_a_bit_twice")
849
        output_stream = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
850
        result = bzrlib.tests.VerboseTestResult(
1707.2.4 by Robert Collins
Teach the bzrlib TestCase to report the time take by calls to self.time as benchmark time, allowing granular reporting of time during benchmarks. See bzrlib.benchmarks.bench_add. (Robert Collins, Martin Pool)
851
            unittest._WritelnDecorator(output_stream),
852
            descriptions=0,
2095.4.1 by Martin Pool
Better progress bars during tests
853
            verbosity=2,
854
            num_tests=sample_test.countTestCases())
1707.2.4 by Robert Collins
Teach the bzrlib TestCase to report the time take by calls to self.time as benchmark time, allowing granular reporting of time during benchmarks. See bzrlib.benchmarks.bench_add. (Robert Collins, Martin Pool)
855
        sample_test.run(result)
856
        self.assertContainsRe(
857
            output_stream.getvalue(),
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
858
            r"\d+ms/ +\d+ms\n$")
2245.1.1 by Robert Collins
New Branch hooks facility, with one initial hook 'set_rh' which triggers
859
860
    def test_hooks_sanitised(self):
861
        """The bzrlib hooks should be sanitised by setUp."""
2245.1.2 by Robert Collins
Remove the static DefaultHooks method from Branch, replacing it with a derived dict BranchHooks object, which is easier to use and provides a place to put the policy-checking add method discussed on list.
862
        self.assertEqual(bzrlib.branch.BranchHooks(),
2245.1.1 by Robert Collins
New Branch hooks facility, with one initial hook 'set_rh' which triggers
863
            bzrlib.branch.Branch.hooks)
864
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
865
    def test__gather_lsprof_in_benchmarks(self):
866
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
867
        
868
        Each self.time() call is individually and separately profiled.
869
        """
870
        try:
871
            import bzrlib.lsprof
872
        except ImportError:
873
            raise TestSkipped("lsprof not installed.")
874
        # overrides the class member with an instance member so no cleanup 
875
        # needed.
876
        self._gather_lsprof_in_benchmarks = True
877
        self.time(time.sleep, 0.000)
878
        self.time(time.sleep, 0.003)
879
        self.assertEqual(2, len(self._benchcalls))
880
        self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
881
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
882
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
883
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
884
1534.11.4 by Robert Collins
Merge from mainline.
885
1982.3.2 by Robert Collins
New TestCase helper applyDeprecated. This allows you to call a callable
886
@symbol_versioning.deprecated_function(zero_eleven)
887
def sample_deprecated_function():
888
    """A deprecated function to test applyDeprecated with."""
889
    return 2
890
891
892
def sample_undeprecated_function(a_param):
893
    """A undeprecated function to test applyDeprecated with."""
894
895
896
class ApplyDeprecatedHelper(object):
897
    """A helper class for ApplyDeprecated tests."""
898
899
    @symbol_versioning.deprecated_method(zero_eleven)
900
    def sample_deprecated_method(self, param_one):
901
        """A deprecated method for testing with."""
902
        return param_one
903
904
    def sample_normal_method(self):
905
        """A undeprecated method."""
906
907
    @symbol_versioning.deprecated_method(zero_ten)
908
    def sample_nested_deprecation(self):
909
        return sample_deprecated_function()
910
911
1540.3.22 by Martin Pool
[patch] Add TestCase.assertIsInstance
912
class TestExtraAssertions(TestCase):
913
    """Tests for new test assertions in bzrlib test suite"""
914
915
    def test_assert_isinstance(self):
916
        self.assertIsInstance(2, int)
917
        self.assertIsInstance(u'', basestring)
918
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
919
        self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
920
1692.3.1 by Robert Collins
Fix push to work with just a branch, no need for a working tree.
921
    def test_assertEndsWith(self):
922
        self.assertEndsWith('foo', 'oo')
923
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
924
1982.3.2 by Robert Collins
New TestCase helper applyDeprecated. This allows you to call a callable
925
    def test_applyDeprecated_not_deprecated(self):
926
        sample_object = ApplyDeprecatedHelper()
927
        # calling an undeprecated callable raises an assertion
928
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
929
            sample_object.sample_normal_method)
930
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
931
            sample_undeprecated_function, "a param value")
932
        # calling a deprecated callable (function or method) with the wrong
933
        # expected deprecation fails.
934
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
935
            sample_object.sample_deprecated_method, "a param value")
936
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
937
            sample_deprecated_function)
938
        # calling a deprecated callable (function or method) with the right
939
        # expected deprecation returns the functions result.
940
        self.assertEqual("a param value", self.applyDeprecated(zero_eleven,
941
            sample_object.sample_deprecated_method, "a param value"))
942
        self.assertEqual(2, self.applyDeprecated(zero_eleven,
943
            sample_deprecated_function))
944
        # calling a nested deprecation with the wrong deprecation version
945
        # fails even if a deeper nested function was deprecated with the 
946
        # supplied version.
947
        self.assertRaises(AssertionError, self.applyDeprecated,
948
            zero_eleven, sample_object.sample_nested_deprecation)
949
        # calling a nested deprecation with the right deprecation value
950
        # returns the calls result.
951
        self.assertEqual(2, self.applyDeprecated(zero_ten,
952
            sample_object.sample_nested_deprecation))
953
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
954
    def test_callDeprecated(self):
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
955
        def testfunc(be_deprecated, result=None):
1910.2.10 by Aaron Bentley
Add tests for assertDeprecated
956
            if be_deprecated is True:
957
                symbol_versioning.warn('i am deprecated', DeprecationWarning, 
958
                                       stacklevel=1)
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
959
            return result
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
960
        result = self.callDeprecated(['i am deprecated'], testfunc, True)
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
961
        self.assertIs(None, result)
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
962
        result = self.callDeprecated([], testfunc, False, 'result')
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
963
        self.assertEqual('result', result)
1982.3.2 by Robert Collins
New TestCase helper applyDeprecated. This allows you to call a callable
964
        self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
965
        self.callDeprecated([], testfunc, be_deprecated=False)
1910.2.10 by Aaron Bentley
Add tests for assertDeprecated
966
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
967
968
class TestConvenienceMakers(TestCaseWithTransport):
969
    """Test for the make_* convenience functions."""
970
971
    def test_make_branch_and_tree_with_format(self):
972
        # we should be able to supply a format to make_branch_and_tree
973
        self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
974
        self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
975
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
976
                              bzrlib.bzrdir.BzrDirMetaFormat1)
977
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
978
                              bzrlib.bzrdir.BzrDirFormat6)
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
979
1986.2.1 by Robert Collins
Bugfix - the name of the test for make_branch_and_memory_tree was wrong.
980
    def test_make_branch_and_memory_tree(self):
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
981
        # we should be able to get a new branch and a mutable tree from
982
        # TestCaseWithTransport
983
        tree = self.make_branch_and_memory_tree('a')
984
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
985
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
986
1910.14.1 by Andrew Bennetts
Fix to make_branch_and_tree's behavior when used with an sftp transport.
987
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
988
989
    def test_make_tree_for_sftp_branch(self):
990
        """Transports backed by local directories create local trees."""
991
992
        tree = self.make_branch_and_tree('t1')
993
        base = tree.bzrdir.root_transport.base
994
        self.failIf(base.startswith('sftp'),
995
                'base %r is on sftp but should be local' % base)
996
        self.assertEquals(tree.bzrdir.root_transport,
997
                tree.branch.bzrdir.root_transport)
998
        self.assertEquals(tree.bzrdir.root_transport,
999
                tree.branch.repository.bzrdir.root_transport)
1000
1001
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
1002
class TestSelftest(TestCase):
1003
    """Tests of bzrlib.tests.selftest."""
1004
1005
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1006
        factory_called = []
1007
        def factory():
1008
            factory_called.append(True)
1009
            return TestSuite()
1010
        out = StringIO()
1011
        err = StringIO()
1012
        self.apply_redirected(out, err, None, bzrlib.tests.selftest, 
1013
            test_suite_factory=factory)
1014
        self.assertEqual([True], factory_called)
2172.4.3 by Alexander Belchenko
Change name of option to '--clean-output' and provide tests
1015
1016
1017
class TestSelftestCleanOutput(TestCaseInTempDir):
1018
1019
    def test_clean_output(self):
1020
        # test functionality of clean_selftest_output()
1021
        from bzrlib.tests import clean_selftest_output
1022
1023
        dirs = ('test0000.tmp', 'test0001.tmp', 'bzrlib', 'tests')
1024
        files = ('bzr', 'setup.py', 'test9999.tmp')
1025
        for i in dirs:
1026
            os.mkdir(i)
1027
        for i in files:
1028
            f = file(i, 'wb')
1029
            f.write('content of ')
1030
            f.write(i)
1031
            f.close()
1032
1033
        root = os.getcwdu()
1034
        before = os.listdir(root)
2172.4.5 by Alexander Belchenko
Small fix: output of os.listdir() should be sorted manually
1035
        before.sort()
2172.4.3 by Alexander Belchenko
Change name of option to '--clean-output' and provide tests
1036
        self.assertEquals(['bzr','bzrlib','setup.py',
1037
                           'test0000.tmp','test0001.tmp',
1038
                           'test9999.tmp','tests'],
1039
                           before)
1040
        clean_selftest_output(root, quiet=True)
1041
        after = os.listdir(root)
2172.4.5 by Alexander Belchenko
Small fix: output of os.listdir() should be sorted manually
1042
        after.sort()
2172.4.3 by Alexander Belchenko
Change name of option to '--clean-output' and provide tests
1043
        self.assertEquals(['bzr','bzrlib','setup.py',
1044
                           'test9999.tmp','tests'],
1045
                           after)