/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
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
            )
2100.3.37 by Aaron Bentley
rename working tree format 4 to AB1 everywhere
357
        from bzrlib.workingtree import WorkingTreeFormat, WorkingTreeFormatAB1
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))
2100.3.37 by Aaron Bentley
rename working tree format 4 to AB1 everywhere
367
        default_format = WorkingTreeFormatAB1
1852.6.1 by Robert Collins
Start tree implementation tests.
368
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
369
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
370
        self.assertEqual(tests[0].transport_server, server1)
371
        self.assertEqual(tests[0].transport_readonly_server, server2)
372
        self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
373
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
374
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
375
        self.assertEqual(tests[1].transport_server, server1)
376
        self.assertEqual(tests[1].transport_readonly_server, server2)
377
        self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
2100.3.20 by Aaron Bentley
Implement tree comparison for tree references
378
        self.assertIsInstance(tests[2].workingtree_format, default_format)
379
        #self.assertEqual(tests[2].bzrdir_format,
380
        #                 default_format._matchingbzrdir)
1852.6.1 by Robert Collins
Start tree implementation tests.
381
        self.assertEqual(tests[2].transport_server, server1)
382
        self.assertEqual(tests[2].transport_readonly_server, server2)
383
        self.assertEqual(tests[2].workingtree_to_test_tree,
384
            revision_tree_from_workingtree)
385
386
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
387
class TestInterTreeProviderAdapter(TestCase):
388
    """A group of tests that test the InterTreeTestAdapter."""
389
390
    def test_adapted_tests(self):
391
        # check that constructor parameters are passed through to the adapted
392
        # test.
393
        # for InterTree tests we want the machinery to bring up two trees in
394
        # each instance: the base one, and the one we are interacting with.
395
        # because each optimiser can be direction specific, we need to test
396
        # each optimiser in its chosen direction.
397
        # unlike the TestProviderAdapter we dont want to automatically add a
398
        # parameterised one for WorkingTree - the optimisers will tell us what
399
        # ones to add.
400
        from bzrlib.tests.tree_implementations import (
401
            return_parameter,
402
            revision_tree_from_workingtree
403
            )
404
        from bzrlib.tests.intertree_implementations import (
405
            InterTreeTestProviderAdapter,
406
            )
407
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
408
        input_test = TestInterTreeProviderAdapter(
409
            "test_adapted_tests")
410
        server1 = "a"
411
        server2 = "b"
412
        format1 = WorkingTreeFormat2()
413
        format2 = WorkingTreeFormat3()
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
414
        formats = [(str, format1, format2, "converter1"),
415
            (int, format2, format1, "converter2")]
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
416
        adapter = InterTreeTestProviderAdapter(server1, server2, formats)
417
        suite = adapter.adapt(input_test)
418
        tests = list(iter(suite))
419
        self.assertEqual(2, len(tests))
420
        self.assertEqual(tests[0].intertree_class, formats[0][0])
421
        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.
422
        self.assertEqual(tests[0].workingtree_format_to, formats[0][2])
423
        self.assertEqual(tests[0].mutable_trees_to_test_trees, formats[0][3])
424
        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.
425
        self.assertEqual(tests[0].transport_server, server1)
426
        self.assertEqual(tests[0].transport_readonly_server, server2)
427
        self.assertEqual(tests[1].intertree_class, formats[1][0])
428
        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.
429
        self.assertEqual(tests[1].workingtree_format_to, formats[1][2])
430
        self.assertEqual(tests[1].mutable_trees_to_test_trees, formats[1][3])
431
        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.
432
        self.assertEqual(tests[1].transport_server, server1)
433
        self.assertEqual(tests[1].transport_readonly_server, server2)
434
1987.1.1 by John Arbash Meinel
Update the test suite to put HOME in a different directory
435
436
class TestTestCaseInTempDir(TestCaseInTempDir):
437
438
    def test_home_is_not_working(self):
439
        self.assertNotEqual(self.test_dir, self.test_home_dir)
440
        cwd = osutils.getcwd()
1987.1.4 by John Arbash Meinel
fix the home_is_not_working test
441
        self.assertEqual(self.test_dir, cwd)
1987.1.1 by John Arbash Meinel
Update the test suite to put HOME in a different directory
442
        self.assertEqual(self.test_home_dir, os.environ['HOME'])
443
444
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
445
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
446
447
    def test_home_is_non_existant_dir_under_root(self):
448
        """The test_home_dir for TestCaseWithMemoryTransport is missing.
449
450
        This is because TestCaseWithMemoryTransport is for tests that do not
451
        need any disk resources: they should be hooked into bzrlib in such a 
452
        way that no global settings are being changed by the test (only a 
453
        few tests should need to do that), and having a missing dir as home is
454
        an effective way to ensure that this is the case.
455
        """
456
        self.assertEqual(self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
457
            self.test_home_dir)
458
        self.assertEqual(self.test_home_dir, os.environ['HOME'])
459
        
460
    def test_cwd_is_TEST_ROOT(self):
461
        self.assertEqual(self.test_dir, self.TEST_ROOT)
462
        cwd = osutils.getcwd()
463
        self.assertEqual(self.test_dir, cwd)
464
465
    def test_make_branch_and_memory_tree(self):
466
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
467
468
        This is hard to comprehensively robustly test, so we settle for making
469
        a branch and checking no directory was created at its relpath.
470
        """
471
        tree = self.make_branch_and_memory_tree('dir')
2227.2.2 by v.ladeuil+lp at free
Cleanup.
472
        # Guard against regression into MemoryTransport leaking
473
        # files to disk instead of keeping them in memory.
474
        self.failIf(osutils.lexists('dir'))
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
475
        self.assertIsInstance(tree, memorytree.MemoryTree)
476
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
477
    def test_make_branch_and_memory_tree_with_format(self):
478
        """make_branch_and_memory_tree should accept a format option."""
479
        format = bzrdir.BzrDirMetaFormat1()
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
480
        format.repository_format = weaverepo.RepositoryFormat7()
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
481
        tree = self.make_branch_and_memory_tree('dir', format=format)
2227.2.2 by v.ladeuil+lp at free
Cleanup.
482
        # Guard against regression into MemoryTransport leaking
483
        # files to disk instead of keeping them in memory.
484
        self.failIf(osutils.lexists('dir'))
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
485
        self.assertIsInstance(tree, memorytree.MemoryTree)
486
        self.assertEqual(format.repository_format.__class__,
487
            tree.branch.repository._format.__class__)
488
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
489
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
490
class TestTestCaseWithTransport(TestCaseWithTransport):
491
    """Tests for the convenience functions TestCaseWithTransport introduces."""
492
493
    def test_get_readonly_url_none(self):
494
        from bzrlib.transport import get_transport
495
        from bzrlib.transport.memory import MemoryServer
496
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
497
        self.transport_server = MemoryServer
498
        self.transport_readonly_server = None
499
        # calling get_readonly_transport() constructs a decorator on the url
500
        # for the server
501
        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.
502
        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.
503
        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.
504
        t2 = get_transport(url2)
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
505
        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.
506
        self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
507
        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.
508
509
    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 :)
510
        from bzrlib.tests.HttpServer import HttpServer
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
511
        from bzrlib.transport import get_transport
1951.2.1 by Martin Pool
Change to using LocalURLServer for testing.
512
        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 :)
513
        from bzrlib.transport.http import HttpTransportBase
1951.2.1 by Martin Pool
Change to using LocalURLServer for testing.
514
        self.transport_server = LocalURLServer
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
515
        self.transport_readonly_server = HttpServer
516
        # calling get_readonly_transport() gives us a HTTP server instance.
517
        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.
518
        url2 = self.get_readonly_url('foo/bar')
1540.3.6 by Martin Pool
[merge] update from bzr.dev
519
        # 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.
520
        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.
521
        t2 = get_transport(url2)
1540.3.6 by Martin Pool
[merge] update from bzr.dev
522
        self.failUnless(isinstance(t, HttpTransportBase))
523
        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.
524
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
1534.4.31 by Robert Collins
cleanedup test_outside_wt
525
1553.5.68 by Martin Pool
Add new TestCaseWithTransport.assertIsDirectory() and tests
526
    def test_is_directory(self):
527
        """Test assertIsDirectory assertion"""
528
        t = self.get_transport()
529
        self.build_tree(['a_dir/', 'a_file'], transport=t)
530
        self.assertIsDirectory('a_dir', t)
531
        self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
532
        self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
1534.4.31 by Robert Collins
cleanedup test_outside_wt
533
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
534
1910.13.1 by Andrew Bennetts
Make make_bzrdir preserve the transport.
535
class TestTestCaseTransports(TestCaseWithTransport):
536
537
    def setUp(self):
538
        super(TestTestCaseTransports, self).setUp()
539
        self.transport_server = MemoryServer
540
541
    def test_make_bzrdir_preserves_transport(self):
542
        t = self.get_transport()
543
        result_bzrdir = self.make_bzrdir('subdir')
544
        self.assertIsInstance(result_bzrdir.transport, 
545
                              MemoryTransport)
546
        # should not be on disk, should only be in memory
547
        self.failIfExists('subdir')
548
549
1534.4.31 by Robert Collins
cleanedup test_outside_wt
550
class TestChrootedTest(ChrootedTestCase):
551
552
    def test_root_is_root(self):
553
        from bzrlib.transport import get_transport
554
        t = get_transport(self.get_readonly_url())
555
        url = t.base
556
        self.assertEqual(url, t.clone('..').base)
1540.3.22 by Martin Pool
[patch] Add TestCase.assertIsInstance
557
558
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
559
class MockProgress(_BaseProgressBar):
560
    """Progress-bar standin that records calls.
561
562
    Useful for testing pb using code.
563
    """
564
565
    def __init__(self):
566
        _BaseProgressBar.__init__(self)
567
        self.calls = []
568
569
    def tick(self):
570
        self.calls.append(('tick',))
571
572
    def update(self, msg=None, current=None, total=None):
573
        self.calls.append(('update', msg, current, total))
574
575
    def clear(self):
576
        self.calls.append(('clear',))
577
1864.3.1 by John Arbash Meinel
Print out when a test fails in non verbose mode, run transport tests later
578
    def note(self, msg, *args):
579
        self.calls.append(('note', msg, args))
580
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
581
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
582
class TestTestResult(TestCase):
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
583
1707.2.3 by Robert Collins
Add a setBenchmarkTime method to the bzrlib test result allowing introduction of granular benchmarking. (Robert Collins, Martin Pool).
584
    def test_elapsed_time_with_benchmarking(self):
2095.4.1 by Martin Pool
Better progress bars during tests
585
        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).
586
                                        descriptions=0,
587
                                        verbosity=1,
588
                                        )
589
        result._recordTestStartTime()
590
        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)
591
        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).
592
        timed_string = result._testTimeString()
593
        # without explicit benchmarking, we should get a simple time.
2196.1.2 by Martin Pool
Loosen requirements for benchmark formatting in selftest
594
        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).
595
        # 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)
596
        self.time(time.sleep, 0.001)
597
        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).
598
        timed_string = result._testTimeString()
2196.1.2 by Martin Pool
Loosen requirements for benchmark formatting in selftest
599
        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)
600
        # 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).
601
        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)
602
        result.extractBenchmarkTime(
603
            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).
604
        timed_string = result._testTimeString()
2196.1.2 by Martin Pool
Loosen requirements for benchmark formatting in selftest
605
        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)
606
        # cheat. Yes, wash thy mouth out with soap.
607
        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).
608
1819.1.1 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Give the test result object an optional benchmark
609
    def test_assigned_benchmark_file_stores_date(self):
610
        output = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
611
        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
612
                                        descriptions=0,
613
                                        verbosity=1,
614
                                        bench_history=output
615
                                        )
616
        output_string = output.getvalue()
2095.4.1 by Martin Pool
Better progress bars during tests
617
        
1819.1.4 by Jan Balster
save the revison id for every benchmark run in .perf-history
618
        # if you are wondering about the regexp please read the comment in
619
        # 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.
620
        # XXX: what comment?  -- Andrew Bennetts
621
        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
622
623
    def test_benchhistory_records_test_times(self):
624
        result_stream = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
625
        result = bzrlib.tests.TextTestResult(
1819.1.3 by Carl Friedrich Bolz
(lifeless, cfbolz): Add recording of benchmark results to the benchmark history
626
            self._log_file,
627
            descriptions=0,
628
            verbosity=1,
629
            bench_history=result_stream
630
            )
631
632
        # we want profile a call and check that its test duration is recorded
633
        # make a new test instance that when run will generate a benchmark
634
        example_test_case = TestTestResult("_time_hello_world_encoding")
635
        # execute the test, which should succeed and record times
636
        example_test_case.run(result)
637
        lines = result_stream.getvalue().splitlines()
638
        self.assertEqual(2, len(lines))
639
        self.assertContainsRe(lines[1],
640
            " *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
641
            "._time_hello_world_encoding")
642
 
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
643
    def _time_hello_world_encoding(self):
644
        """Profile two sleep calls
645
        
646
        This is used to exercise the test framework.
647
        """
648
        self.time(unicode, 'hello', errors='replace')
649
        self.time(unicode, 'world', errors='replace')
650
651
    def test_lsprofiling(self):
652
        """Verbose test result prints lsprof statistics from test cases."""
653
        try:
654
            import bzrlib.lsprof
655
        except ImportError:
656
            raise TestSkipped("lsprof not installed.")
657
        result_stream = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
658
        result = bzrlib.tests.VerboseTestResult(
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
659
            unittest._WritelnDecorator(result_stream),
660
            descriptions=0,
661
            verbosity=2,
662
            )
663
        # we want profile a call of some sort and check it is output by
664
        # addSuccess. We dont care about addError or addFailure as they
665
        # are not that interesting for performance tuning.
666
        # make a new test instance that when run will generate a profile
667
        example_test_case = TestTestResult("_time_hello_world_encoding")
668
        example_test_case._gather_lsprof_in_benchmarks = True
669
        # execute the test, which should succeed and record profiles
670
        example_test_case.run(result)
671
        # lsprofile_something()
672
        # if this worked we want 
673
        # LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
674
        #    CallCount    Recursive    Total(ms)   Inline(ms) module:lineno(function)
675
        # (the lsprof header)
676
        # ... an arbitrary number of lines
677
        # and the function call which is time.sleep.
678
        #           1        0            ???         ???       ???(sleep) 
679
        # and then repeated but with 'world', rather than 'hello'.
680
        # this should appear in the output stream of our test result.
1831.2.1 by Martin Pool
[trivial] Simplify & fix up lsprof blackbox test
681
        output = result_stream.getvalue()
682
        self.assertContainsRe(output,
683
            r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
684
        self.assertContainsRe(output,
685
            r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
686
        self.assertContainsRe(output,
687
            r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
688
        self.assertContainsRe(output,
689
            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
690
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
691
692
class TestRunner(TestCase):
693
694
    def dummy_test(self):
695
        pass
696
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
697
    def run_test_runner(self, testrunner, test):
698
        """Run suite in testrunner, saving global state and restoring it.
699
700
        This current saves and restores:
701
        TestCaseInTempDir.TEST_ROOT
702
        
703
        There should be no tests in this file that use bzrlib.tests.TextTestRunner
704
        without using this convenience method, because of our use of global state.
705
        """
706
        old_root = TestCaseInTempDir.TEST_ROOT
707
        try:
708
            TestCaseInTempDir.TEST_ROOT = None
709
            return testrunner.run(test)
710
        finally:
711
            TestCaseInTempDir.TEST_ROOT = old_root
712
713
    def test_skipped_test(self):
714
        # run a test that is skipped, and check the suite as a whole still
715
        # succeeds.
716
        # skipping_test must be hidden in here so it's not run as a real test
717
        def skipping_test():
718
            raise TestSkipped('test intentionally skipped')
719
        runner = TextTestRunner(stream=self._log_file, keep_output=True)
720
        test = unittest.FunctionTestCase(skipping_test)
721
        result = self.run_test_runner(runner, test)
722
        self.assertTrue(result.wasSuccessful())
723
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
724
    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.
725
        # tests that the running the benchmark produces a history file
726
        # containing a timestamp and the revision id of the bzrlib source which
727
        # was tested.
728
        workingtree = _get_bzr_source_tree()
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
729
        test = TestRunner('dummy_test')
730
        output = StringIO()
731
        runner = TextTestRunner(stream=self._log_file, bench_history=output)
732
        result = self.run_test_runner(runner, test)
733
        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.
734
        self.assertContainsRe(output_string, "--date [0-9.]+")
735
        if workingtree is not None:
1908.7.6 by Robert Collins
Deprecate WorkingTree.last_revision.
736
            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.
737
            self.assertEndsWith(output_string.rstrip(), revision_id)
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
738
2036.1.1 by John Arbash Meinel
test that logs are kept or deleted when appropriate
739
    def test_success_log_deleted(self):
740
        """Successful tests have their log deleted"""
741
742
        class LogTester(TestCase):
743
744
            def test_success(self):
745
                self.log('this will be removed\n')
746
747
        sio = cStringIO.StringIO()
748
        runner = TextTestRunner(stream=sio)
749
        test = LogTester('test_success')
750
        result = self.run_test_runner(runner, test)
751
752
        log = test._get_log()
753
        self.assertEqual("DELETED log file to reduce memory footprint", log)
754
        self.assertEqual('', test._log_contents)
755
        self.assertIs(None, test._log_file_name)
756
757
    def test_fail_log_kept(self):
758
        """Failed tests have their log kept"""
759
760
        class LogTester(TestCase):
761
762
            def test_fail(self):
763
                self.log('this will be kept\n')
764
                self.fail('this test fails')
765
766
        sio = cStringIO.StringIO()
767
        runner = TextTestRunner(stream=sio)
768
        test = LogTester('test_fail')
769
        result = self.run_test_runner(runner, test)
770
771
        text = sio.getvalue()
772
        self.assertContainsRe(text, 'this will be kept')
773
        self.assertContainsRe(text, 'this test fails')
774
775
        log = test._get_log()
776
        self.assertContainsRe(log, 'this will be kept')
777
        self.assertEqual(log, test._log_contents)
778
779
    def test_error_log_kept(self):
780
        """Tests with errors have their log kept"""
781
782
        class LogTester(TestCase):
783
784
            def test_error(self):
785
                self.log('this will be kept\n')
786
                raise ValueError('random exception raised')
787
788
        sio = cStringIO.StringIO()
789
        runner = TextTestRunner(stream=sio)
790
        test = LogTester('test_error')
791
        result = self.run_test_runner(runner, test)
792
793
        text = sio.getvalue()
794
        self.assertContainsRe(text, 'this will be kept')
795
        self.assertContainsRe(text, 'random exception raised')
796
797
        log = test._get_log()
798
        self.assertContainsRe(log, 'this will be kept')
799
        self.assertEqual(log, test._log_contents)
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
800
2036.1.2 by John Arbash Meinel
whitespace fix
801
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
802
class TestTestCase(TestCase):
803
    """Tests that test the core bzrlib TestCase."""
804
805
    def inner_test(self):
806
        # the inner child test
807
        note("inner_test")
808
809
    def outer_child(self):
810
        # the outer child test
811
        note("outer_start")
812
        self.inner_test = TestTestCase("inner_child")
2095.4.1 by Martin Pool
Better progress bars during tests
813
        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.
814
                                        descriptions=0,
815
                                        verbosity=1)
816
        self.inner_test.run(result)
817
        note("outer finish")
818
819
    def test_trace_nesting(self):
820
        # this tests that each test case nests its trace facility correctly.
821
        # we do this by running a test case manually. That test case (A)
822
        # should setup a new log, log content to it, setup a child case (B),
823
        # which should log independently, then case (A) should log a trailer
824
        # and return.
825
        # we do two nested children so that we can verify the state of the 
826
        # logs after the outer child finishes is correct, which a bad clean
827
        # up routine in tearDown might trigger a fault in our test with only
828
        # one child, we should instead see the bad result inside our test with
829
        # the two children.
830
        # the outer child test
831
        original_trace = bzrlib.trace._trace_file
832
        outer_test = TestTestCase("outer_child")
2095.4.1 by Martin Pool
Better progress bars during tests
833
        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.
834
                                        descriptions=0,
835
                                        verbosity=1)
836
        outer_test.run(result)
837
        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)
838
839
    def method_that_times_a_bit_twice(self):
840
        # 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.
841
        self.time(time.sleep, 0.007)
842
        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)
843
844
    def test_time_creates_benchmark_in_result(self):
845
        """Test that the TestCase.time() method accumulates a benchmark time."""
846
        sample_test = TestTestCase("method_that_times_a_bit_twice")
847
        output_stream = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
848
        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)
849
            unittest._WritelnDecorator(output_stream),
850
            descriptions=0,
2095.4.1 by Martin Pool
Better progress bars during tests
851
            verbosity=2,
852
            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)
853
        sample_test.run(result)
854
        self.assertContainsRe(
855
            output_stream.getvalue(),
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
856
            r"\d+ms/ +\d+ms\n$")
2245.1.1 by Robert Collins
New Branch hooks facility, with one initial hook 'set_rh' which triggers
857
858
    def test_hooks_sanitised(self):
859
        """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.
860
        self.assertEqual(bzrlib.branch.BranchHooks(),
2245.1.1 by Robert Collins
New Branch hooks facility, with one initial hook 'set_rh' which triggers
861
            bzrlib.branch.Branch.hooks)
862
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
863
    def test__gather_lsprof_in_benchmarks(self):
864
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
865
        
866
        Each self.time() call is individually and separately profiled.
867
        """
868
        try:
869
            import bzrlib.lsprof
870
        except ImportError:
871
            raise TestSkipped("lsprof not installed.")
872
        # overrides the class member with an instance member so no cleanup 
873
        # needed.
874
        self._gather_lsprof_in_benchmarks = True
875
        self.time(time.sleep, 0.000)
876
        self.time(time.sleep, 0.003)
877
        self.assertEqual(2, len(self._benchcalls))
878
        self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
879
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
880
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
881
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
882
1534.11.4 by Robert Collins
Merge from mainline.
883
1982.3.2 by Robert Collins
New TestCase helper applyDeprecated. This allows you to call a callable
884
@symbol_versioning.deprecated_function(zero_eleven)
885
def sample_deprecated_function():
886
    """A deprecated function to test applyDeprecated with."""
887
    return 2
888
889
890
def sample_undeprecated_function(a_param):
891
    """A undeprecated function to test applyDeprecated with."""
892
893
894
class ApplyDeprecatedHelper(object):
895
    """A helper class for ApplyDeprecated tests."""
896
897
    @symbol_versioning.deprecated_method(zero_eleven)
898
    def sample_deprecated_method(self, param_one):
899
        """A deprecated method for testing with."""
900
        return param_one
901
902
    def sample_normal_method(self):
903
        """A undeprecated method."""
904
905
    @symbol_versioning.deprecated_method(zero_ten)
906
    def sample_nested_deprecation(self):
907
        return sample_deprecated_function()
908
909
1540.3.22 by Martin Pool
[patch] Add TestCase.assertIsInstance
910
class TestExtraAssertions(TestCase):
911
    """Tests for new test assertions in bzrlib test suite"""
912
913
    def test_assert_isinstance(self):
914
        self.assertIsInstance(2, int)
915
        self.assertIsInstance(u'', basestring)
916
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
917
        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
918
1692.3.1 by Robert Collins
Fix push to work with just a branch, no need for a working tree.
919
    def test_assertEndsWith(self):
920
        self.assertEndsWith('foo', 'oo')
921
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
922
1982.3.2 by Robert Collins
New TestCase helper applyDeprecated. This allows you to call a callable
923
    def test_applyDeprecated_not_deprecated(self):
924
        sample_object = ApplyDeprecatedHelper()
925
        # calling an undeprecated callable raises an assertion
926
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
927
            sample_object.sample_normal_method)
928
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
929
            sample_undeprecated_function, "a param value")
930
        # calling a deprecated callable (function or method) with the wrong
931
        # expected deprecation fails.
932
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
933
            sample_object.sample_deprecated_method, "a param value")
934
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
935
            sample_deprecated_function)
936
        # calling a deprecated callable (function or method) with the right
937
        # expected deprecation returns the functions result.
938
        self.assertEqual("a param value", self.applyDeprecated(zero_eleven,
939
            sample_object.sample_deprecated_method, "a param value"))
940
        self.assertEqual(2, self.applyDeprecated(zero_eleven,
941
            sample_deprecated_function))
942
        # calling a nested deprecation with the wrong deprecation version
943
        # fails even if a deeper nested function was deprecated with the 
944
        # supplied version.
945
        self.assertRaises(AssertionError, self.applyDeprecated,
946
            zero_eleven, sample_object.sample_nested_deprecation)
947
        # calling a nested deprecation with the right deprecation value
948
        # returns the calls result.
949
        self.assertEqual(2, self.applyDeprecated(zero_ten,
950
            sample_object.sample_nested_deprecation))
951
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
952
    def test_callDeprecated(self):
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
953
        def testfunc(be_deprecated, result=None):
1910.2.10 by Aaron Bentley
Add tests for assertDeprecated
954
            if be_deprecated is True:
955
                symbol_versioning.warn('i am deprecated', DeprecationWarning, 
956
                                       stacklevel=1)
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
957
            return result
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
958
        result = self.callDeprecated(['i am deprecated'], testfunc, True)
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
959
        self.assertIs(None, result)
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
960
        result = self.callDeprecated([], testfunc, False, 'result')
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
961
        self.assertEqual('result', result)
1982.3.2 by Robert Collins
New TestCase helper applyDeprecated. This allows you to call a callable
962
        self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
963
        self.callDeprecated([], testfunc, be_deprecated=False)
1910.2.10 by Aaron Bentley
Add tests for assertDeprecated
964
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
965
966
class TestConvenienceMakers(TestCaseWithTransport):
967
    """Test for the make_* convenience functions."""
968
969
    def test_make_branch_and_tree_with_format(self):
970
        # we should be able to supply a format to make_branch_and_tree
971
        self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
972
        self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
973
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
974
                              bzrlib.bzrdir.BzrDirMetaFormat1)
975
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
976
                              bzrlib.bzrdir.BzrDirFormat6)
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
977
1986.2.1 by Robert Collins
Bugfix - the name of the test for make_branch_and_memory_tree was wrong.
978
    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
979
        # we should be able to get a new branch and a mutable tree from
980
        # TestCaseWithTransport
981
        tree = self.make_branch_and_memory_tree('a')
982
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
983
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
984
1910.14.1 by Andrew Bennetts
Fix to make_branch_and_tree's behavior when used with an sftp transport.
985
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
986
987
    def test_make_tree_for_sftp_branch(self):
988
        """Transports backed by local directories create local trees."""
989
990
        tree = self.make_branch_and_tree('t1')
991
        base = tree.bzrdir.root_transport.base
992
        self.failIf(base.startswith('sftp'),
993
                'base %r is on sftp but should be local' % base)
994
        self.assertEquals(tree.bzrdir.root_transport,
995
                tree.branch.bzrdir.root_transport)
996
        self.assertEquals(tree.bzrdir.root_transport,
997
                tree.branch.repository.bzrdir.root_transport)
998
999
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
1000
class TestSelftest(TestCase):
1001
    """Tests of bzrlib.tests.selftest."""
1002
1003
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1004
        factory_called = []
1005
        def factory():
1006
            factory_called.append(True)
1007
            return TestSuite()
1008
        out = StringIO()
1009
        err = StringIO()
1010
        self.apply_redirected(out, err, None, bzrlib.tests.selftest, 
1011
            test_suite_factory=factory)
1012
        self.assertEqual([True], factory_called)
2172.4.3 by Alexander Belchenko
Change name of option to '--clean-output' and provide tests
1013
1014
1015
class TestSelftestCleanOutput(TestCaseInTempDir):
1016
1017
    def test_clean_output(self):
1018
        # test functionality of clean_selftest_output()
1019
        from bzrlib.tests import clean_selftest_output
1020
1021
        dirs = ('test0000.tmp', 'test0001.tmp', 'bzrlib', 'tests')
1022
        files = ('bzr', 'setup.py', 'test9999.tmp')
1023
        for i in dirs:
1024
            os.mkdir(i)
1025
        for i in files:
1026
            f = file(i, 'wb')
1027
            f.write('content of ')
1028
            f.write(i)
1029
            f.close()
1030
1031
        root = os.getcwdu()
1032
        before = os.listdir(root)
2172.4.5 by Alexander Belchenko
Small fix: output of os.listdir() should be sorted manually
1033
        before.sort()
2172.4.3 by Alexander Belchenko
Change name of option to '--clean-output' and provide tests
1034
        self.assertEquals(['bzr','bzrlib','setup.py',
1035
                           'test0000.tmp','test0001.tmp',
1036
                           'test9999.tmp','tests'],
1037
                           before)
1038
        clean_selftest_output(root, quiet=True)
1039
        after = os.listdir(root)
2172.4.5 by Alexander Belchenko
Small fix: output of os.listdir() should be sorted manually
1040
        after.sort()
2172.4.3 by Alexander Belchenko
Change name of option to '--clean-output' and provide tests
1041
        self.assertEquals(['bzr','bzrlib','setup.py',
1042
                           'test9999.tmp','tests'],
1043
                           after)