/brz/remove-bazaar

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