/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
2696.1.1 by Martin Pool
Remove things deprecated in 0.11 and earlier
38
from bzrlib.symbol_versioning import (
39
        zero_ten,
40
        zero_eleven,
41
        )
1526.1.3 by Robert Collins
Merge from upstream.
42
from bzrlib.tests import (
1534.4.31 by Robert Collins
cleanedup test_outside_wt
43
                          ChrootedTestCase,
2367.1.2 by Robert Collins
Some minor cleanups of test code, and implement KnownFailure support as
44
                          ExtendedTestResult,
2367.1.4 by Robert Collins
Add operating system Feature model to bzrlib.tests to allow writing tests
45
                          Feature,
2367.1.2 by Robert Collins
Some minor cleanups of test code, and implement KnownFailure support as
46
                          KnownFailure,
1526.1.3 by Robert Collins
Merge from upstream.
47
                          TestCase,
48
                          TestCaseInTempDir,
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
49
                          TestCaseWithMemoryTransport,
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
50
                          TestCaseWithTransport,
2729.1.1 by Martin Pool
Add TestNotApplicable exception and handling of it; document test parameterization
51
                          TestNotApplicable,
1526.1.3 by Robert Collins
Merge from upstream.
52
                          TestSkipped,
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
53
                          TestSuite,
2394.2.7 by Ian Clatworthy
Added whitebox tests - filter_suite_by_re and sort_suite_by_re
54
                          TestUtil,
1526.1.3 by Robert Collins
Merge from upstream.
55
                          TextTestRunner,
2367.1.6 by Robert Collins
Allow per-test-fixture feature requirements via 'requireFeature'.(Robert Collins)
56
                          UnavailableFeature,
2394.2.7 by Ian Clatworthy
Added whitebox tests - filter_suite_by_re and sort_suite_by_re
57
                          iter_suite_tests,
58
                          filter_suite_by_re,
59
                          sort_suite_by_re,
2493.2.8 by Aaron Bentley
Convert old lsprof tests to require new LSProf Feature instead of skipping
60
                          test_lsprof,
61
                          test_suite,
1526.1.3 by Robert Collins
Merge from upstream.
62
                          )
1910.14.1 by Andrew Bennetts
Fix to make_branch_and_tree's behavior when used with an sftp transport.
63
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
1707.2.2 by Robert Collins
Start on bench_add, an add benchtest.
64
from bzrlib.tests.TestUtil import _load_module_by_name
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
65
from bzrlib.trace import note
1910.13.1 by Andrew Bennetts
Make make_bzrdir preserve the transport.
66
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.
67
from bzrlib.version import _get_bzr_source_tree
1185.51.1 by Martin Pool
Better message when failing to import a test suite.
68
69
70
class SelftestTests(TestCase):
71
72
    def test_import_tests(self):
73
        mod = _load_module_by_name('bzrlib.tests.test_selftest')
74
        self.assertEqual(mod.SelftestTests, SelftestTests)
75
76
    def test_import_test_failure(self):
77
        self.assertRaises(ImportError,
78
                          _load_module_by_name,
79
                          'bzrlib.no-name-yet')
80
81
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.
82
1185.51.1 by Martin Pool
Better message when failing to import a test suite.
83
    def test_logging(self):
84
        """Test logs are captured when a test fails."""
85
        self.log('a test message')
86
        self._log_file.flush()
1927.3.1 by Carl Friedrich Bolz
Throw away on-disk logfile when possible.
87
        self.assertContainsRe(self._get_log(keep_log_file=True),
88
                              'a test message\n')
1185.33.95 by Martin Pool
New TestSkipped facility, and tests for it.
89
90
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.
91
class TestTreeShape(TestCaseInTempDir):
92
93
    def test_unicode_paths(self):
94
        filename = u'hell\u00d8'
1526.1.4 by Robert Collins
forgot my self.
95
        try:
96
            self.build_tree_contents([(filename, 'contents of hello')])
97
        except UnicodeEncodeError:
98
            raise TestSkipped("can't build unicode working tree in "
99
                "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.
100
        self.failUnlessExists(filename)
1526.1.3 by Robert Collins
Merge from upstream.
101
102
1530.1.1 by Robert Collins
Minimal infrastructure to test TransportTestProviderAdapter.
103
class TestTransportProviderAdapter(TestCase):
1530.1.21 by Robert Collins
Review feedback fixes.
104
    """A group of tests that test the transport implementation adaption core.
105
1551.1.1 by Martin Pool
[merge] branch-formats branch, and reconcile changes
106
    This is a meta test that the tests are applied to all available 
107
    transports.
108
1530.1.21 by Robert Collins
Review feedback fixes.
109
    This will be generalised in the future which is why it is in this 
110
    test file even though it is specific to transport tests at the moment.
111
    """
1530.1.1 by Robert Collins
Minimal infrastructure to test TransportTestProviderAdapter.
112
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.
113
    def test_get_transport_permutations(self):
1530.1.21 by Robert Collins
Review feedback fixes.
114
        # this checks that we the module get_test_permutations call
115
        # 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.
116
        class MockModule(object):
117
            def get_test_permutations(self):
118
                return sample_permutation
119
        sample_permutation = [(1,2), (3,4)]
2553.2.5 by Robert Collins
And overhaul TransportTestProviderAdapter too.
120
        from bzrlib.tests.test_transport_implementations \
121
            import TransportTestProviderAdapter
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.
122
        adapter = TransportTestProviderAdapter()
123
        self.assertEqual(sample_permutation,
124
                         adapter.get_transport_test_permutations(MockModule()))
125
126
    def test_adapter_checks_all_modules(self):
1530.1.21 by Robert Collins
Review feedback fixes.
127
        # this checks that the adapter returns as many permurtations as
128
        # there are in all the registered# transport modules for there
129
        # - we assume if this matches its probably doing the right thing
130
        # especially in combination with the tests for setting the right
131
        # classes below.
2553.2.5 by Robert Collins
And overhaul TransportTestProviderAdapter too.
132
        from bzrlib.tests.test_transport_implementations \
133
            import TransportTestProviderAdapter
134
        from bzrlib.transport import _get_transport_modules
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.
135
        modules = _get_transport_modules()
136
        permutation_count = 0
137
        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.
138
            try:
139
                permutation_count += len(reduce(getattr, 
140
                    (module + ".get_test_permutations").split('.')[1:],
141
                     __import__(module))())
142
            except errors.DependencyNotPresent:
143
                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.
144
        input_test = TestTransportProviderAdapter(
145
            "test_adapter_sets_transport_class")
146
        adapter = TransportTestProviderAdapter()
147
        self.assertEqual(permutation_count,
148
                         len(list(iter(adapter.adapt(input_test)))))
149
1530.1.1 by Robert Collins
Minimal infrastructure to test TransportTestProviderAdapter.
150
    def test_adapter_sets_transport_class(self):
1540.3.21 by Martin Pool
Trim test for TestTransportProviderAdapter to be less dependent on
151
        # Check that the test adapter inserts a transport and server into the
152
        # generated test.
153
        #
154
        # This test used to know about all the possible transports and the
155
        # order they were returned but that seems overly brittle (mbp
156
        # 20060307)
2553.2.5 by Robert Collins
And overhaul TransportTestProviderAdapter too.
157
        from bzrlib.tests.test_transport_implementations \
158
            import TransportTestProviderAdapter
159
        scenarios = TransportTestProviderAdapter().scenarios
1540.3.21 by Martin Pool
Trim test for TestTransportProviderAdapter to be less dependent on
160
        # there are at least that many builtin transports
2553.2.5 by Robert Collins
And overhaul TransportTestProviderAdapter too.
161
        self.assertTrue(len(scenarios) > 6)
162
        one_scenario = scenarios[0]
163
        self.assertIsInstance(one_scenario[0], str)
164
        self.assertTrue(issubclass(one_scenario[1]["transport_class"],
1540.3.21 by Martin Pool
Trim test for TestTransportProviderAdapter to be less dependent on
165
                                   bzrlib.transport.Transport))
2553.2.5 by Robert Collins
And overhaul TransportTestProviderAdapter too.
166
        self.assertTrue(issubclass(one_scenario[1]["transport_server"],
1540.3.21 by Martin Pool
Trim test for TestTransportProviderAdapter to be less dependent on
167
                                   bzrlib.transport.Server))
1534.4.3 by Robert Collins
Implement BranchTestProviderAdapter, so tests now run across all branch formats.
168
169
170
class TestBranchProviderAdapter(TestCase):
171
    """A group of tests that test the branch implementation test adapter."""
172
2553.2.6 by Robert Collins
And overhaul BranchTestProviderAdapter too.
173
    def test_constructor(self):
1534.4.3 by Robert Collins
Implement BranchTestProviderAdapter, so tests now run across all branch formats.
174
        # check that constructor parameters are passed through to the adapted
175
        # test.
2553.2.6 by Robert Collins
And overhaul BranchTestProviderAdapter too.
176
        from bzrlib.tests.branch_implementations import BranchTestProviderAdapter
1534.4.3 by Robert Collins
Implement BranchTestProviderAdapter, so tests now run across all branch formats.
177
        server1 = "a"
178
        server2 = "b"
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
179
        formats = [("c", "C"), ("d", "D")]
1534.4.3 by Robert Collins
Implement BranchTestProviderAdapter, so tests now run across all branch formats.
180
        adapter = BranchTestProviderAdapter(server1, server2, formats)
2553.2.6 by Robert Collins
And overhaul BranchTestProviderAdapter too.
181
        self.assertEqual(2, len(adapter.scenarios))
182
        self.assertEqual([
183
            ('str',
184
             {'branch_format': 'c',
185
              'bzrdir_format': 'C',
186
              'transport_readonly_server': 'b',
187
              'transport_server': 'a'}),
188
            ('str',
189
             {'branch_format': 'd',
190
              'bzrdir_format': 'D',
191
              'transport_readonly_server': 'b',
192
              'transport_server': 'a'})],
193
            adapter.scenarios)
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
194
195
1534.4.39 by Robert Collins
Basic BzrDir support.
196
class TestBzrDirProviderAdapter(TestCase):
197
    """A group of tests that test the bzr dir implementation test adapter."""
198
199
    def test_adapted_tests(self):
200
        # check that constructor parameters are passed through to the adapted
201
        # test.
2553.2.7 by Robert Collins
And overhaul BzrDirTestProviderAdapter too.
202
        from bzrlib.tests.bzrdir_implementations import BzrDirTestProviderAdapter
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
203
        vfs_factory = "v"
1534.4.39 by Robert Collins
Basic BzrDir support.
204
        server1 = "a"
205
        server2 = "b"
206
        formats = ["c", "d"]
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
207
        adapter = BzrDirTestProviderAdapter(vfs_factory,
208
            server1, server2, formats)
2553.2.7 by Robert Collins
And overhaul BzrDirTestProviderAdapter too.
209
        self.assertEqual([
210
            ('str',
211
             {'bzrdir_format': 'c',
212
              'transport_readonly_server': 'b',
213
              'transport_server': 'a',
214
              'vfs_transport_factory': 'v'}),
215
            ('str',
216
             {'bzrdir_format': 'd',
217
              'transport_readonly_server': 'b',
218
              'transport_server': 'a',
219
              'vfs_transport_factory': 'v'})],
220
            adapter.scenarios)
1534.4.39 by Robert Collins
Basic BzrDir support.
221
222
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
223
class TestRepositoryProviderAdapter(TestCase):
224
    """A group of tests that test the repository implementation test adapter."""
225
2553.2.1 by Robert Collins
Overhaul RepositoryTestAdapter to be cleaner and more modular.
226
    def test_constructor(self):
227
        # check that constructor parameters are passed through to the
228
        # scenarios.
2553.2.2 by Robert Collins
Move RepositoryTestProviderAdapter into the tests part of the code base.
229
        from bzrlib.tests.repository_implementations import RepositoryTestProviderAdapter
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
230
        server1 = "a"
231
        server2 = "b"
232
        formats = [("c", "C"), ("d", "D")]
233
        adapter = RepositoryTestProviderAdapter(server1, server2, formats)
2553.2.1 by Robert Collins
Overhaul RepositoryTestAdapter to be cleaner and more modular.
234
        self.assertEqual([
235
            ('str',
236
             {'bzrdir_format': 'C',
237
              'repository_format': 'c',
238
              'transport_readonly_server': 'b',
239
              'transport_server': 'a'}),
240
            ('str',
241
             {'bzrdir_format': 'D',
242
              'repository_format': 'd',
243
              'transport_readonly_server': 'b',
244
              'transport_server': 'a'})],
245
            adapter.scenarios)
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
246
2018.5.64 by Robert Collins
Allow Repository tests to be backed onto a specific VFS as needed.
247
    def test_setting_vfs_transport(self):
248
        """The vfs_transport_factory can be set optionally."""
2553.2.2 by Robert Collins
Move RepositoryTestProviderAdapter into the tests part of the code base.
249
        from bzrlib.tests.repository_implementations import RepositoryTestProviderAdapter
2553.2.1 by Robert Collins
Overhaul RepositoryTestAdapter to be cleaner and more modular.
250
        formats = [("a", "b"), ("c", "d")]
2018.5.64 by Robert Collins
Allow Repository tests to be backed onto a specific VFS as needed.
251
        adapter = RepositoryTestProviderAdapter(None, None, formats,
252
            vfs_transport_factory="vfs")
2553.2.1 by Robert Collins
Overhaul RepositoryTestAdapter to be cleaner and more modular.
253
        self.assertEqual([
254
            ('str',
255
             {'bzrdir_format': 'b',
256
              'repository_format': 'a',
257
              'transport_readonly_server': None,
258
              'transport_server': None,
259
              'vfs_transport_factory': 'vfs'}),
260
            ('str',
261
             {'bzrdir_format': 'd',
262
              'repository_format': 'c',
263
              'transport_readonly_server': None,
264
              'transport_server': None,
265
              'vfs_transport_factory': 'vfs'})],
266
            adapter.scenarios)
267
268
    def test_formats_to_scenarios(self):
269
        """The adapter can generate all the scenarios needed."""
2553.2.2 by Robert Collins
Move RepositoryTestProviderAdapter into the tests part of the code base.
270
        from bzrlib.tests.repository_implementations import RepositoryTestProviderAdapter
2553.2.1 by Robert Collins
Overhaul RepositoryTestAdapter to be cleaner and more modular.
271
        no_vfs_adapter = RepositoryTestProviderAdapter("server", "readonly",
272
            [], None)
273
        vfs_adapter = RepositoryTestProviderAdapter("server", "readonly",
274
            [], vfs_transport_factory="vfs")
275
        # no_vfs generate scenarios without vfs_transport_factor
276
        formats = [("c", "C"), (1, "D")]
277
        self.assertEqual([
278
            ('str',
279
             {'bzrdir_format': 'C',
280
              'repository_format': 'c',
281
              'transport_readonly_server': 'readonly',
282
              'transport_server': 'server'}),
283
            ('int',
284
             {'bzrdir_format': 'D',
285
              'repository_format': 1,
286
              'transport_readonly_server': 'readonly',
287
              'transport_server': 'server'})],
288
            no_vfs_adapter.formats_to_scenarios(formats))
289
        self.assertEqual([
290
            ('str',
291
             {'bzrdir_format': 'C',
292
              'repository_format': 'c',
293
              'transport_readonly_server': 'readonly',
294
              'transport_server': 'server',
295
              'vfs_transport_factory': 'vfs'}),
296
            ('int',
297
             {'bzrdir_format': 'D',
298
              'repository_format': 1,
299
              'transport_readonly_server': 'readonly',
300
              'transport_server': 'server',
301
              'vfs_transport_factory': 'vfs'})],
302
            vfs_adapter.formats_to_scenarios(formats))
303
2553.2.3 by Robert Collins
Split out the common test scenario support from the repository implementation specific code.
304
305
class TestTestScenarioApplier(TestCase):
306
    """Tests for the test adaption facilities."""
307
308
    def test_adapt_applies_scenarios(self):
309
        from bzrlib.tests.repository_implementations import TestScenarioApplier
310
        input_test = TestTestScenarioApplier("test_adapt_test_to_scenario")
311
        adapter = TestScenarioApplier()
312
        adapter.scenarios = [("1", "dict"), ("2", "settings")]
313
        calls = []
314
        def capture_call(test, scenario):
315
            calls.append((test, scenario))
316
            return test
317
        adapter.adapt_test_to_scenario = capture_call
318
        adapter.adapt(input_test)
319
        self.assertEqual([(input_test, ("1", "dict")),
320
            (input_test, ("2", "settings"))], calls)
321
2553.2.1 by Robert Collins
Overhaul RepositoryTestAdapter to be cleaner and more modular.
322
    def test_adapt_test_to_scenario(self):
2553.2.3 by Robert Collins
Split out the common test scenario support from the repository implementation specific code.
323
        from bzrlib.tests.repository_implementations import TestScenarioApplier
324
        input_test = TestTestScenarioApplier("test_adapt_test_to_scenario")
325
        adapter = TestScenarioApplier()
2553.2.1 by Robert Collins
Overhaul RepositoryTestAdapter to be cleaner and more modular.
326
        # setup two adapted tests
327
        adapted_test1 = adapter.adapt_test_to_scenario(input_test,
328
            ("new id",
329
            {"bzrdir_format":"bzr_format",
330
             "repository_format":"repo_fmt",
331
             "transport_server":"transport_server",
332
             "transport_readonly_server":"readonly-server"}))
333
        adapted_test2 = adapter.adapt_test_to_scenario(input_test,
334
            ("new id 2", {"bzrdir_format":None}))
335
        # input_test should have been altered.
336
        self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
337
        # the new tests are mutually incompatible, ensuring it has 
338
        # made new ones, and unspecified elements in the scenario
339
        # should not have been altered.
340
        self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
341
        self.assertEqual("repo_fmt", adapted_test1.repository_format)
342
        self.assertEqual("transport_server", adapted_test1.transport_server)
343
        self.assertEqual("readonly-server",
344
            adapted_test1.transport_readonly_server)
345
        self.assertEqual(
2553.2.3 by Robert Collins
Split out the common test scenario support from the repository implementation specific code.
346
            "bzrlib.tests.test_selftest.TestTestScenarioApplier."
2553.2.1 by Robert Collins
Overhaul RepositoryTestAdapter to be cleaner and more modular.
347
            "test_adapt_test_to_scenario(new id)",
348
            adapted_test1.id())
349
        self.assertEqual(None, adapted_test2.bzrdir_format)
350
        self.assertEqual(
2553.2.3 by Robert Collins
Split out the common test scenario support from the repository implementation specific code.
351
            "bzrlib.tests.test_selftest.TestTestScenarioApplier."
2553.2.1 by Robert Collins
Overhaul RepositoryTestAdapter to be cleaner and more modular.
352
            "test_adapt_test_to_scenario(new id 2)",
353
            adapted_test2.id())
2018.5.64 by Robert Collins
Allow Repository tests to be backed onto a specific VFS as needed.
354
1534.4.40 by Robert Collins
Add RepositoryFormats and allow bzrdir.open or create _repository to be used.
355
1534.1.29 by Robert Collins
Add a test environment for InterRepository objects, and remove the fetch corner case tests from test_repository.
356
class TestInterRepositoryProviderAdapter(TestCase):
357
    """A group of tests that test the InterRepository test adapter."""
358
359
    def test_adapted_tests(self):
360
        # check that constructor parameters are passed through to the adapted
361
        # test.
2553.2.4 by Robert Collins
Treat InterRepositoryTestProviderAdapter like RepositoryTestProviderAdapter
362
        from bzrlib.tests.interrepository_implementations import \
363
            InterRepositoryTestProviderAdapter
1534.1.29 by Robert Collins
Add a test environment for InterRepository objects, and remove the fetch corner case tests from test_repository.
364
        server1 = "a"
365
        server2 = "b"
1563.2.20 by Robert Collins
Add a revision store test adapter.
366
        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.
367
        adapter = InterRepositoryTestProviderAdapter(server1, server2, formats)
2553.2.4 by Robert Collins
Treat InterRepositoryTestProviderAdapter like RepositoryTestProviderAdapter
368
        self.assertEqual([
369
            ('str',
370
             {'interrepo_class': str,
371
              'repository_format': 'C1',
372
              'repository_format_to': 'C2',
373
              'transport_readonly_server': 'b',
374
              'transport_server': 'a'}),
375
            ('int',
376
             {'interrepo_class': int,
377
              'repository_format': 'D1',
378
              'repository_format_to': 'D2',
379
              'transport_readonly_server': 'b',
380
              'transport_server': 'a'})],
381
            adapter.formats_to_scenarios(formats))
1534.1.29 by Robert Collins
Add a test environment for InterRepository objects, and remove the fetch corner case tests from test_repository.
382
383
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.
384
class TestInterVersionedFileProviderAdapter(TestCase):
385
    """A group of tests that test the InterVersionedFile test adapter."""
386
2553.2.9 by Robert Collins
And overhaul RevisionStoreTestProviderAdapter too.
387
    def test_scenarios(self):
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.
388
        # check that constructor parameters are passed through to the adapted
389
        # test.
2553.2.8 by Robert Collins
And overhaul InterVersionedFileTestProviderAdapter too.
390
        from bzrlib.tests.interversionedfile_implementations \
391
            import InterVersionedFileTestProviderAdapter
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.
392
        server1 = "a"
393
        server2 = "b"
1563.2.20 by Robert Collins
Add a revision store test adapter.
394
        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.
395
        adapter = InterVersionedFileTestProviderAdapter(server1, server2, formats)
2553.2.8 by Robert Collins
And overhaul InterVersionedFileTestProviderAdapter too.
396
        self.assertEqual([
397
            ('str',
398
             {'interversionedfile_class':str,
399
              'transport_readonly_server': 'b',
400
              'transport_server': 'a',
401
              'versionedfile_factory': 'C1',
402
              'versionedfile_factory_to': 'C2'}),
403
            ('int',
404
             {'interversionedfile_class': int,
405
              'transport_readonly_server': 'b',
406
              'transport_server': 'a',
407
              'versionedfile_factory': 'D1',
408
              'versionedfile_factory_to': 'D2'})],
409
            adapter.scenarios)
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.
410
411
1563.2.20 by Robert Collins
Add a revision store test adapter.
412
class TestRevisionStoreProviderAdapter(TestCase):
413
    """A group of tests that test the RevisionStore test adapter."""
414
2553.2.9 by Robert Collins
And overhaul RevisionStoreTestProviderAdapter too.
415
    def test_scenarios(self):
1563.2.20 by Robert Collins
Add a revision store test adapter.
416
        # check that constructor parameters are passed through to the adapted
417
        # test.
2553.2.9 by Robert Collins
And overhaul RevisionStoreTestProviderAdapter too.
418
        from bzrlib.tests.revisionstore_implementations \
419
            import RevisionStoreTestProviderAdapter
1563.2.20 by Robert Collins
Add a revision store test adapter.
420
        # revision stores need a store factory - i.e. RevisionKnit
421
        #, a readonly and rw transport 
422
        # transport servers:
423
        server1 = "a"
424
        server2 = "b"
425
        store_factories = ["c", "d"]
426
        adapter = RevisionStoreTestProviderAdapter(server1, server2, store_factories)
2553.2.9 by Robert Collins
And overhaul RevisionStoreTestProviderAdapter too.
427
        self.assertEqual([
428
            ('c',
429
             {'store_factory': 'c',
430
              'transport_readonly_server': 'b',
431
              'transport_server': 'a'}),
432
            ('d',
433
             {'store_factory': 'd',
434
              'transport_readonly_server': 'b',
435
              'transport_server': 'a'})],
436
            adapter.scenarios)
1563.2.20 by Robert Collins
Add a revision store test adapter.
437
438
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
439
class TestWorkingTreeProviderAdapter(TestCase):
440
    """A group of tests that test the workingtree implementation test adapter."""
441
2553.2.10 by Robert Collins
And overhaul WorkingTreeTestProviderAdapter too.
442
    def test_scenarios(self):
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
443
        # check that constructor parameters are passed through to the adapted
444
        # test.
2553.2.10 by Robert Collins
And overhaul WorkingTreeTestProviderAdapter too.
445
        from bzrlib.tests.workingtree_implementations \
446
            import WorkingTreeTestProviderAdapter
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
447
        server1 = "a"
448
        server2 = "b"
449
        formats = [("c", "C"), ("d", "D")]
450
        adapter = WorkingTreeTestProviderAdapter(server1, server2, formats)
2553.2.10 by Robert Collins
And overhaul WorkingTreeTestProviderAdapter too.
451
        self.assertEqual([
452
            ('str',
453
             {'bzrdir_format': 'C',
454
              'transport_readonly_server': 'b',
455
              'transport_server': 'a',
456
              'workingtree_format': 'c'}),
457
            ('str',
458
             {'bzrdir_format': 'D',
459
              'transport_readonly_server': 'b',
460
              'transport_server': 'a',
461
              'workingtree_format': 'd'})],
462
            adapter.scenarios)
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
463
464
1852.6.1 by Robert Collins
Start tree implementation tests.
465
class TestTreeProviderAdapter(TestCase):
466
    """Test the setup of tree_implementation tests."""
467
468
    def test_adapted_tests(self):
469
        # the tree implementation adapter is meant to setup one instance for
470
        # each working tree format, and one additional instance that will
471
        # use the default wt format, but create a revision tree for the tests.
472
        # this means that the wt ones should have the workingtree_to_test_tree
473
        # attribute set to 'return_parameter' and the revision one set to
474
        # revision_tree_from_workingtree.
475
476
        from bzrlib.tests.tree_implementations import (
477
            TreeTestProviderAdapter,
478
            return_parameter,
479
            revision_tree_from_workingtree
480
            )
2255.2.164 by Martin Pool
Change the default format for some tests from AB1 back to WorkingTreeFormat3
481
        from bzrlib.workingtree import WorkingTreeFormat, WorkingTreeFormat3
1852.6.1 by Robert Collins
Start tree implementation tests.
482
        input_test = TestTreeProviderAdapter(
483
            "test_adapted_tests")
484
        server1 = "a"
485
        server2 = "b"
486
        formats = [("c", "C"), ("d", "D")]
487
        adapter = TreeTestProviderAdapter(server1, server2, formats)
488
        suite = adapter.adapt(input_test)
489
        tests = list(iter(suite))
2255.6.3 by Aaron Bentley
tweak tests
490
        self.assertEqual(4, len(tests))
2255.2.164 by Martin Pool
Change the default format for some tests from AB1 back to WorkingTreeFormat3
491
        # this must match the default format setp up in
492
        # TreeTestProviderAdapter.adapt
493
        default_format = WorkingTreeFormat3
1852.6.1 by Robert Collins
Start tree implementation tests.
494
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
495
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
496
        self.assertEqual(tests[0].transport_server, server1)
497
        self.assertEqual(tests[0].transport_readonly_server, server2)
498
        self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
499
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
500
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
501
        self.assertEqual(tests[1].transport_server, server1)
502
        self.assertEqual(tests[1].transport_readonly_server, server2)
503
        self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
2100.3.20 by Aaron Bentley
Implement tree comparison for tree references
504
        self.assertIsInstance(tests[2].workingtree_format, default_format)
505
        #self.assertEqual(tests[2].bzrdir_format,
506
        #                 default_format._matchingbzrdir)
1852.6.1 by Robert Collins
Start tree implementation tests.
507
        self.assertEqual(tests[2].transport_server, server1)
508
        self.assertEqual(tests[2].transport_readonly_server, server2)
509
        self.assertEqual(tests[2].workingtree_to_test_tree,
510
            revision_tree_from_workingtree)
511
512
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
513
class TestInterTreeProviderAdapter(TestCase):
514
    """A group of tests that test the InterTreeTestAdapter."""
515
516
    def test_adapted_tests(self):
517
        # check that constructor parameters are passed through to the adapted
518
        # test.
519
        # for InterTree tests we want the machinery to bring up two trees in
520
        # each instance: the base one, and the one we are interacting with.
521
        # because each optimiser can be direction specific, we need to test
522
        # each optimiser in its chosen direction.
523
        # unlike the TestProviderAdapter we dont want to automatically add a
524
        # parameterised one for WorkingTree - the optimisers will tell us what
525
        # ones to add.
526
        from bzrlib.tests.tree_implementations import (
527
            return_parameter,
528
            revision_tree_from_workingtree
529
            )
530
        from bzrlib.tests.intertree_implementations import (
531
            InterTreeTestProviderAdapter,
532
            )
533
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
534
        input_test = TestInterTreeProviderAdapter(
535
            "test_adapted_tests")
536
        server1 = "a"
537
        server2 = "b"
538
        format1 = WorkingTreeFormat2()
539
        format2 = WorkingTreeFormat3()
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
540
        formats = [(str, format1, format2, "converter1"),
541
            (int, format2, format1, "converter2")]
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
542
        adapter = InterTreeTestProviderAdapter(server1, server2, formats)
543
        suite = adapter.adapt(input_test)
544
        tests = list(iter(suite))
545
        self.assertEqual(2, len(tests))
546
        self.assertEqual(tests[0].intertree_class, formats[0][0])
547
        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.
548
        self.assertEqual(tests[0].workingtree_format_to, formats[0][2])
549
        self.assertEqual(tests[0].mutable_trees_to_test_trees, formats[0][3])
550
        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.
551
        self.assertEqual(tests[0].transport_server, server1)
552
        self.assertEqual(tests[0].transport_readonly_server, server2)
553
        self.assertEqual(tests[1].intertree_class, formats[1][0])
554
        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.
555
        self.assertEqual(tests[1].workingtree_format_to, formats[1][2])
556
        self.assertEqual(tests[1].mutable_trees_to_test_trees, formats[1][3])
557
        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.
558
        self.assertEqual(tests[1].transport_server, server1)
559
        self.assertEqual(tests[1].transport_readonly_server, server2)
560
1987.1.1 by John Arbash Meinel
Update the test suite to put HOME in a different directory
561
562
class TestTestCaseInTempDir(TestCaseInTempDir):
563
564
    def test_home_is_not_working(self):
565
        self.assertNotEqual(self.test_dir, self.test_home_dir)
566
        cwd = osutils.getcwd()
2823.1.4 by Vincent Ladeuil
Use assertIsSameRealPath to avoid OSX aliasing (specifically /tmp
567
        self.assertIsSameRealPath(self.test_dir, cwd)
568
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
1987.1.1 by John Arbash Meinel
Update the test suite to put HOME in a different directory
569
570
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
571
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
572
573
    def test_home_is_non_existant_dir_under_root(self):
574
        """The test_home_dir for TestCaseWithMemoryTransport is missing.
575
576
        This is because TestCaseWithMemoryTransport is for tests that do not
577
        need any disk resources: they should be hooked into bzrlib in such a 
578
        way that no global settings are being changed by the test (only a 
579
        few tests should need to do that), and having a missing dir as home is
580
        an effective way to ensure that this is the case.
581
        """
2823.1.4 by Vincent Ladeuil
Use assertIsSameRealPath to avoid OSX aliasing (specifically /tmp
582
        self.assertIsSameRealPath(
583
            self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
584
            self.test_home_dir)
2823.1.4 by Vincent Ladeuil
Use assertIsSameRealPath to avoid OSX aliasing (specifically /tmp
585
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
586
        
587
    def test_cwd_is_TEST_ROOT(self):
2823.1.4 by Vincent Ladeuil
Use assertIsSameRealPath to avoid OSX aliasing (specifically /tmp
588
        self.assertIsSameRealPath(self.test_dir, self.TEST_ROOT)
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
589
        cwd = osutils.getcwd()
2823.1.4 by Vincent Ladeuil
Use assertIsSameRealPath to avoid OSX aliasing (specifically /tmp
590
        self.assertIsSameRealPath(self.test_dir, cwd)
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
591
592
    def test_make_branch_and_memory_tree(self):
593
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
594
595
        This is hard to comprehensively robustly test, so we settle for making
596
        a branch and checking no directory was created at its relpath.
597
        """
598
        tree = self.make_branch_and_memory_tree('dir')
2227.2.2 by v.ladeuil+lp at free
Cleanup.
599
        # Guard against regression into MemoryTransport leaking
600
        # files to disk instead of keeping them in memory.
601
        self.failIf(osutils.lexists('dir'))
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
602
        self.assertIsInstance(tree, memorytree.MemoryTree)
603
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
604
    def test_make_branch_and_memory_tree_with_format(self):
605
        """make_branch_and_memory_tree should accept a format option."""
606
        format = bzrdir.BzrDirMetaFormat1()
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
607
        format.repository_format = weaverepo.RepositoryFormat7()
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
608
        tree = self.make_branch_and_memory_tree('dir', format=format)
2227.2.2 by v.ladeuil+lp at free
Cleanup.
609
        # Guard against regression into MemoryTransport leaking
610
        # files to disk instead of keeping them in memory.
611
        self.failIf(osutils.lexists('dir'))
1986.4.9 by Robert Collins
``TestCase.make_branch_and_memory_tree`` now takes a format
612
        self.assertIsInstance(tree, memorytree.MemoryTree)
613
        self.assertEqual(format.repository_format.__class__,
614
            tree.branch.repository._format.__class__)
615
1986.2.3 by Robert Collins
New test base class TestCaseWithMemoryTransport offers memory-only
616
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
617
class TestTestCaseWithTransport(TestCaseWithTransport):
618
    """Tests for the convenience functions TestCaseWithTransport introduces."""
619
620
    def test_get_readonly_url_none(self):
621
        from bzrlib.transport import get_transport
622
        from bzrlib.transport.memory import MemoryServer
623
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
624
        self.vfs_transport_factory = MemoryServer
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
625
        self.transport_readonly_server = None
626
        # calling get_readonly_transport() constructs a decorator on the url
627
        # for the server
628
        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.
629
        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.
630
        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.
631
        t2 = get_transport(url2)
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
632
        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.
633
        self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
634
        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.
635
636
    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 :)
637
        from bzrlib.tests.HttpServer import HttpServer
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
638
        from bzrlib.transport import get_transport
1951.2.1 by Martin Pool
Change to using LocalURLServer for testing.
639
        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 :)
640
        from bzrlib.transport.http import HttpTransportBase
1951.2.1 by Martin Pool
Change to using LocalURLServer for testing.
641
        self.transport_server = LocalURLServer
1534.4.10 by Robert Collins
Add TestCaseWithTransport class that provides tests with read and write transport pairs.
642
        self.transport_readonly_server = HttpServer
643
        # calling get_readonly_transport() gives us a HTTP server instance.
644
        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.
645
        url2 = self.get_readonly_url('foo/bar')
1540.3.6 by Martin Pool
[merge] update from bzr.dev
646
        # 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.
647
        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.
648
        t2 = get_transport(url2)
1540.3.6 by Martin Pool
[merge] update from bzr.dev
649
        self.failUnless(isinstance(t, HttpTransportBase))
650
        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.
651
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
1534.4.31 by Robert Collins
cleanedup test_outside_wt
652
1553.5.68 by Martin Pool
Add new TestCaseWithTransport.assertIsDirectory() and tests
653
    def test_is_directory(self):
654
        """Test assertIsDirectory assertion"""
655
        t = self.get_transport()
656
        self.build_tree(['a_dir/', 'a_file'], transport=t)
657
        self.assertIsDirectory('a_dir', t)
658
        self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
659
        self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
1534.4.31 by Robert Collins
cleanedup test_outside_wt
660
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
661
1910.13.1 by Andrew Bennetts
Make make_bzrdir preserve the transport.
662
class TestTestCaseTransports(TestCaseWithTransport):
663
664
    def setUp(self):
665
        super(TestTestCaseTransports, self).setUp()
2018.5.42 by Robert Collins
Various hopefully improvements, but wsgi is broken, handing over to spiv :).
666
        self.vfs_transport_factory = MemoryServer
1910.13.1 by Andrew Bennetts
Make make_bzrdir preserve the transport.
667
668
    def test_make_bzrdir_preserves_transport(self):
669
        t = self.get_transport()
670
        result_bzrdir = self.make_bzrdir('subdir')
671
        self.assertIsInstance(result_bzrdir.transport, 
672
                              MemoryTransport)
673
        # should not be on disk, should only be in memory
674
        self.failIfExists('subdir')
675
676
1534.4.31 by Robert Collins
cleanedup test_outside_wt
677
class TestChrootedTest(ChrootedTestCase):
678
679
    def test_root_is_root(self):
680
        from bzrlib.transport import get_transport
681
        t = get_transport(self.get_readonly_url())
682
        url = t.base
683
        self.assertEqual(url, t.clone('..').base)
1540.3.22 by Martin Pool
[patch] Add TestCase.assertIsInstance
684
685
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
686
class MockProgress(_BaseProgressBar):
687
    """Progress-bar standin that records calls.
688
689
    Useful for testing pb using code.
690
    """
691
692
    def __init__(self):
693
        _BaseProgressBar.__init__(self)
694
        self.calls = []
695
696
    def tick(self):
697
        self.calls.append(('tick',))
698
699
    def update(self, msg=None, current=None, total=None):
700
        self.calls.append(('update', msg, current, total))
701
702
    def clear(self):
703
        self.calls.append(('clear',))
704
1864.3.1 by John Arbash Meinel
Print out when a test fails in non verbose mode, run transport tests later
705
    def note(self, msg, *args):
706
        self.calls.append(('note', msg, args))
707
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
708
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
709
class TestTestResult(TestCase):
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
710
2695.1.3 by Martin Pool
Fix up selftest tests for new extractBenchmarkTime behaviour; remove many unneeded calls to it
711
    def check_timing(self, test_case, expected_re):
2095.4.1 by Martin Pool
Better progress bars during tests
712
        result = bzrlib.tests.TextTestResult(self._log_file,
2695.1.3 by Martin Pool
Fix up selftest tests for new extractBenchmarkTime behaviour; remove many unneeded calls to it
713
                descriptions=0,
714
                verbosity=1,
715
                )
716
        test_case.run(result)
717
        timed_string = result._testTimeString(test_case)
718
        self.assertContainsRe(timed_string, expected_re)
719
720
    def test_test_reporting(self):
721
        class ShortDelayTestCase(TestCase):
722
            def test_short_delay(self):
723
                time.sleep(0.003)
724
            def test_short_benchmark(self):
725
                self.time(time.sleep, 0.003)
726
        self.check_timing(ShortDelayTestCase('test_short_delay'),
727
                          r"^ +[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).
728
        # if a benchmark time is given, we want a x of y style result.
2695.1.3 by Martin Pool
Fix up selftest tests for new extractBenchmarkTime behaviour; remove many unneeded calls to it
729
        self.check_timing(ShortDelayTestCase('test_short_benchmark'),
730
                          r"^ +[0-9]+ms/ +[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).
731
2695.1.3 by Martin Pool
Fix up selftest tests for new extractBenchmarkTime behaviour; remove many unneeded calls to it
732
    def test_unittest_reporting_unittest_class(self):
733
        # getting the time from a non-bzrlib test works ok
734
        class ShortDelayTestCase(unittest.TestCase):
735
            def test_short_delay(self):
736
                time.sleep(0.003)
737
        self.check_timing(ShortDelayTestCase('test_short_delay'),
738
                          r"^ +[0-9]+ms$")
739
        
1819.1.1 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Give the test result object an optional benchmark
740
    def test_assigned_benchmark_file_stores_date(self):
741
        output = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
742
        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
743
                                        descriptions=0,
744
                                        verbosity=1,
745
                                        bench_history=output
746
                                        )
747
        output_string = output.getvalue()
1819.1.4 by Jan Balster
save the revison id for every benchmark run in .perf-history
748
        # if you are wondering about the regexp please read the comment in
749
        # 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.
750
        # XXX: what comment?  -- Andrew Bennetts
751
        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
752
753
    def test_benchhistory_records_test_times(self):
754
        result_stream = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
755
        result = bzrlib.tests.TextTestResult(
1819.1.3 by Carl Friedrich Bolz
(lifeless, cfbolz): Add recording of benchmark results to the benchmark history
756
            self._log_file,
757
            descriptions=0,
758
            verbosity=1,
759
            bench_history=result_stream
760
            )
761
762
        # we want profile a call and check that its test duration is recorded
763
        # make a new test instance that when run will generate a benchmark
764
        example_test_case = TestTestResult("_time_hello_world_encoding")
765
        # execute the test, which should succeed and record times
766
        example_test_case.run(result)
767
        lines = result_stream.getvalue().splitlines()
768
        self.assertEqual(2, len(lines))
769
        self.assertContainsRe(lines[1],
770
            " *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
771
            "._time_hello_world_encoding")
772
 
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
773
    def _time_hello_world_encoding(self):
774
        """Profile two sleep calls
775
        
776
        This is used to exercise the test framework.
777
        """
778
        self.time(unicode, 'hello', errors='replace')
779
        self.time(unicode, 'world', errors='replace')
780
781
    def test_lsprofiling(self):
782
        """Verbose test result prints lsprof statistics from test cases."""
1551.15.28 by Aaron Bentley
Improve Feature usage style w/ lsprof
783
        self.requireFeature(test_lsprof.LSProfFeature)
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
784
        result_stream = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
785
        result = bzrlib.tests.VerboseTestResult(
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
786
            unittest._WritelnDecorator(result_stream),
787
            descriptions=0,
788
            verbosity=2,
789
            )
790
        # we want profile a call of some sort and check it is output by
791
        # addSuccess. We dont care about addError or addFailure as they
792
        # are not that interesting for performance tuning.
793
        # make a new test instance that when run will generate a profile
794
        example_test_case = TestTestResult("_time_hello_world_encoding")
795
        example_test_case._gather_lsprof_in_benchmarks = True
796
        # execute the test, which should succeed and record profiles
797
        example_test_case.run(result)
798
        # lsprofile_something()
799
        # if this worked we want 
800
        # LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
801
        #    CallCount    Recursive    Total(ms)   Inline(ms) module:lineno(function)
802
        # (the lsprof header)
803
        # ... an arbitrary number of lines
804
        # and the function call which is time.sleep.
805
        #           1        0            ???         ???       ???(sleep) 
806
        # and then repeated but with 'world', rather than 'hello'.
807
        # this should appear in the output stream of our test result.
1831.2.1 by Martin Pool
[trivial] Simplify & fix up lsprof blackbox test
808
        output = result_stream.getvalue()
809
        self.assertContainsRe(output,
810
            r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
811
        self.assertContainsRe(output,
812
            r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
813
        self.assertContainsRe(output,
814
            r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
815
        self.assertContainsRe(output,
816
            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
817
2367.1.2 by Robert Collins
Some minor cleanups of test code, and implement KnownFailure support as
818
    def test_known_failure(self):
819
        """A KnownFailure being raised should trigger several result actions."""
820
        class InstrumentedTestResult(ExtendedTestResult):
821
822
            def report_test_start(self, test): pass
823
            def report_known_failure(self, test, err):
824
                self._call = test, err
825
        result = InstrumentedTestResult(None, None, None, None)
826
        def test_function():
827
            raise KnownFailure('failed!')
828
        test = unittest.FunctionTestCase(test_function)
829
        test.run(result)
830
        # it should invoke 'report_known_failure'.
831
        self.assertEqual(2, len(result._call))
832
        self.assertEqual(test, result._call[0])
833
        self.assertEqual(KnownFailure, result._call[1][0])
834
        self.assertIsInstance(result._call[1][1], KnownFailure)
835
        # we dont introspec the traceback, if the rest is ok, it would be
836
        # exceptional for it not to be.
837
        # it should update the known_failure_count on the object.
838
        self.assertEqual(1, result.known_failure_count)
839
        # the result should be successful.
840
        self.assertTrue(result.wasSuccessful())
841
842
    def test_verbose_report_known_failure(self):
843
        # verbose test output formatting
844
        result_stream = StringIO()
845
        result = bzrlib.tests.VerboseTestResult(
846
            unittest._WritelnDecorator(result_stream),
847
            descriptions=0,
848
            verbosity=2,
849
            )
850
        test = self.get_passing_test()
851
        result.startTest(test)
852
        prefix = len(result_stream.getvalue())
853
        # the err parameter has the shape:
854
        # (class, exception object, traceback)
855
        # KnownFailures dont get their tracebacks shown though, so we
856
        # can skip that.
857
        err = (KnownFailure, KnownFailure('foo'), None)
858
        result.report_known_failure(test, err)
859
        output = result_stream.getvalue()[prefix:]
860
        lines = output.splitlines()
2418.3.1 by John Arbash Meinel
Remove timing dependencies from the selftest tests.
861
        self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
862
        self.assertEqual(lines[1], '    foo')
863
        self.assertEqual(2, len(lines))
864
2367.1.2 by Robert Collins
Some minor cleanups of test code, and implement KnownFailure support as
865
    def test_text_report_known_failure(self):
866
        # text test output formatting
867
        pb = MockProgress()
868
        result = bzrlib.tests.TextTestResult(
869
            None,
870
            descriptions=0,
871
            verbosity=1,
872
            pb=pb,
873
            )
874
        test = self.get_passing_test()
875
        # this seeds the state to handle reporting the test.
876
        result.startTest(test)
877
        # the err parameter has the shape:
878
        # (class, exception object, traceback)
879
        # KnownFailures dont get their tracebacks shown though, so we
880
        # can skip that.
881
        err = (KnownFailure, KnownFailure('foo'), None)
882
        result.report_known_failure(test, err)
883
        self.assertEqual(
884
            [
885
            ('update', '[1 in 0s] passing_test', None, None),
886
            ('note', 'XFAIL: %s\n%s\n', ('passing_test', err[1]))
887
            ],
888
            pb.calls)
889
        # known_failures should be printed in the summary, so if we run a test
890
        # after there are some known failures, the update prefix should match
891
        # this.
892
        result.known_failure_count = 3
893
        test.run(result)
894
        self.assertEqual(
895
            [
896
            ('update', '[2 in 0s, 3 known failures] passing_test', None, None),
897
            ],
898
            pb.calls[2:])
899
900
    def get_passing_test(self):
901
        """Return a test object that can't be run usefully."""
902
        def passing_test():
903
            pass
904
        return unittest.FunctionTestCase(passing_test)
905
2367.1.5 by Robert Collins
Implement reporting of Unsupported tests in the bzr test result and runner
906
    def test_add_not_supported(self):
907
        """Test the behaviour of invoking addNotSupported."""
908
        class InstrumentedTestResult(ExtendedTestResult):
909
            def report_test_start(self, test): pass
910
            def report_unsupported(self, test, feature):
911
                self._call = test, feature
912
        result = InstrumentedTestResult(None, None, None, None)
913
        test = SampleTestCase('_test_pass')
914
        feature = Feature()
915
        result.startTest(test)
916
        result.addNotSupported(test, feature)
917
        # it should invoke 'report_unsupported'.
918
        self.assertEqual(2, len(result._call))
919
        self.assertEqual(test, result._call[0])
920
        self.assertEqual(feature, result._call[1])
921
        # the result should be successful.
922
        self.assertTrue(result.wasSuccessful())
923
        # it should record the test against a count of tests not run due to
924
        # this feature.
925
        self.assertEqual(1, result.unsupported['Feature'])
926
        # and invoking it again should increment that counter
927
        result.addNotSupported(test, feature)
928
        self.assertEqual(2, result.unsupported['Feature'])
929
930
    def test_verbose_report_unsupported(self):
931
        # verbose test output formatting
932
        result_stream = StringIO()
933
        result = bzrlib.tests.VerboseTestResult(
934
            unittest._WritelnDecorator(result_stream),
935
            descriptions=0,
936
            verbosity=2,
937
            )
938
        test = self.get_passing_test()
939
        feature = Feature()
940
        result.startTest(test)
941
        prefix = len(result_stream.getvalue())
942
        result.report_unsupported(test, feature)
943
        output = result_stream.getvalue()[prefix:]
944
        lines = output.splitlines()
945
        self.assertEqual(lines, ['NODEP                   0ms', "    The feature 'Feature' is not available."])
946
    
947
    def test_text_report_unsupported(self):
948
        # text test output formatting
949
        pb = MockProgress()
950
        result = bzrlib.tests.TextTestResult(
951
            None,
952
            descriptions=0,
953
            verbosity=1,
954
            pb=pb,
955
            )
956
        test = self.get_passing_test()
957
        feature = Feature()
958
        # this seeds the state to handle reporting the test.
959
        result.startTest(test)
960
        result.report_unsupported(test, feature)
961
        # no output on unsupported features
962
        self.assertEqual(
963
            [('update', '[1 in 0s] passing_test', None, None)
964
            ],
965
            pb.calls)
966
        # the number of missing features should be printed in the progress
967
        # summary, so check for that.
968
        result.unsupported = {'foo':0, 'bar':0}
969
        test.run(result)
970
        self.assertEqual(
971
            [
972
            ('update', '[2 in 0s, 2 missing features] passing_test', None, None),
973
            ],
974
            pb.calls[1:])
975
    
2367.1.6 by Robert Collins
Allow per-test-fixture feature requirements via 'requireFeature'.(Robert Collins)
976
    def test_unavailable_exception(self):
977
        """An UnavailableFeature being raised should invoke addNotSupported."""
978
        class InstrumentedTestResult(ExtendedTestResult):
979
980
            def report_test_start(self, test): pass
981
            def addNotSupported(self, test, feature):
982
                self._call = test, feature
983
        result = InstrumentedTestResult(None, None, None, None)
984
        feature = Feature()
985
        def test_function():
986
            raise UnavailableFeature(feature)
987
        test = unittest.FunctionTestCase(test_function)
988
        test.run(result)
989
        # it should invoke 'addNotSupported'.
990
        self.assertEqual(2, len(result._call))
991
        self.assertEqual(test, result._call[0])
992
        self.assertEqual(feature, result._call[1])
993
        # and not count as an error
994
        self.assertEqual(0, result.error_count)
995
2658.3.2 by Daniel Watkins
Added tests for ExtendedTestResult.wasStrictlySuccessful.
996
    def test_strict_with_unsupported_feature(self):
997
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
2695.1.3 by Martin Pool
Fix up selftest tests for new extractBenchmarkTime behaviour; remove many unneeded calls to it
998
                                             verbosity=1)
2658.3.2 by Daniel Watkins
Added tests for ExtendedTestResult.wasStrictlySuccessful.
999
        test = self.get_passing_test()
1000
        feature = "Unsupported Feature"
1001
        result.addNotSupported(test, feature)
1002
        self.assertFalse(result.wasStrictlySuccessful())
2695.1.3 by Martin Pool
Fix up selftest tests for new extractBenchmarkTime behaviour; remove many unneeded calls to it
1003
        self.assertEqual(None, result._extractBenchmarkTime(test))
1004
 
2658.3.2 by Daniel Watkins
Added tests for ExtendedTestResult.wasStrictlySuccessful.
1005
    def test_strict_with_known_failure(self):
1006
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
2695.1.3 by Martin Pool
Fix up selftest tests for new extractBenchmarkTime behaviour; remove many unneeded calls to it
1007
                                             verbosity=1)
2658.3.2 by Daniel Watkins
Added tests for ExtendedTestResult.wasStrictlySuccessful.
1008
        test = self.get_passing_test()
1009
        err = (KnownFailure, KnownFailure('foo'), None)
2695.1.1 by Martin Pool
Fix problem if the first test is missing a dependency
1010
        result._addKnownFailure(test, err)
2658.3.2 by Daniel Watkins
Added tests for ExtendedTestResult.wasStrictlySuccessful.
1011
        self.assertFalse(result.wasStrictlySuccessful())
2695.1.3 by Martin Pool
Fix up selftest tests for new extractBenchmarkTime behaviour; remove many unneeded calls to it
1012
        self.assertEqual(None, result._extractBenchmarkTime(test))
2658.3.2 by Daniel Watkins
Added tests for ExtendedTestResult.wasStrictlySuccessful.
1013
1014
    def test_strict_with_success(self):
1015
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
2695.1.3 by Martin Pool
Fix up selftest tests for new extractBenchmarkTime behaviour; remove many unneeded calls to it
1016
                                             verbosity=1)
2658.3.2 by Daniel Watkins
Added tests for ExtendedTestResult.wasStrictlySuccessful.
1017
        test = self.get_passing_test()
1018
        result.addSuccess(test)
1019
        self.assertTrue(result.wasStrictlySuccessful())
2695.1.3 by Martin Pool
Fix up selftest tests for new extractBenchmarkTime behaviour; remove many unneeded calls to it
1020
        self.assertEqual(None, result._extractBenchmarkTime(test))
2658.3.2 by Daniel Watkins
Added tests for ExtendedTestResult.wasStrictlySuccessful.
1021
1534.11.1 by Robert Collins
Teach bzr selftest to use a progress bar in non verbose mode.
1022
1023
class TestRunner(TestCase):
1024
1025
    def dummy_test(self):
1026
        pass
1027
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
1028
    def run_test_runner(self, testrunner, test):
1029
        """Run suite in testrunner, saving global state and restoring it.
1030
1031
        This current saves and restores:
1032
        TestCaseInTempDir.TEST_ROOT
1033
        
1034
        There should be no tests in this file that use bzrlib.tests.TextTestRunner
1035
        without using this convenience method, because of our use of global state.
1036
        """
1037
        old_root = TestCaseInTempDir.TEST_ROOT
1038
        try:
1039
            TestCaseInTempDir.TEST_ROOT = None
1040
            return testrunner.run(test)
1041
        finally:
1042
            TestCaseInTempDir.TEST_ROOT = old_root
1043
2367.1.2 by Robert Collins
Some minor cleanups of test code, and implement KnownFailure support as
1044
    def test_known_failure_failed_run(self):
1045
        # run a test that generates a known failure which should be printed in
1046
        # the final output when real failures occur.
1047
        def known_failure_test():
1048
            raise KnownFailure('failed')
1049
        test = unittest.TestSuite()
1050
        test.addTest(unittest.FunctionTestCase(known_failure_test))
1051
        def failing_test():
1052
            raise AssertionError('foo')
1053
        test.addTest(unittest.FunctionTestCase(failing_test))
1054
        stream = StringIO()
1055
        runner = TextTestRunner(stream=stream)
1056
        result = self.run_test_runner(runner, test)
1057
        lines = stream.getvalue().splitlines()
1058
        self.assertEqual([
1059
            '',
1060
            '======================================================================',
1061
            'FAIL: unittest.FunctionTestCase (failing_test)',
1062
            '----------------------------------------------------------------------',
1063
            'Traceback (most recent call last):',
1064
            '    raise AssertionError(\'foo\')',
1065
            'AssertionError: foo',
1066
            '',
1067
            '----------------------------------------------------------------------',
1068
            '',
1069
            'FAILED (failures=1, known_failure_count=1)'],
2367.1.5 by Robert Collins
Implement reporting of Unsupported tests in the bzr test result and runner
1070
            lines[0:5] + lines[6:10] + lines[11:])
2367.1.2 by Robert Collins
Some minor cleanups of test code, and implement KnownFailure support as
1071
1072
    def test_known_failure_ok_run(self):
1073
        # run a test that generates a known failure which should be printed in the final output.
1074
        def known_failure_test():
1075
            raise KnownFailure('failed')
1076
        test = unittest.FunctionTestCase(known_failure_test)
1077
        stream = StringIO()
1078
        runner = TextTestRunner(stream=stream)
1079
        result = self.run_test_runner(runner, test)
2418.3.1 by John Arbash Meinel
Remove timing dependencies from the selftest tests.
1080
        self.assertContainsRe(stream.getvalue(),
1081
            '\n'
1082
            '-*\n'
1083
            'Ran 1 test in .*\n'
1084
            '\n'
1085
            'OK \\(known_failures=1\\)\n')
2367.1.2 by Robert Collins
Some minor cleanups of test code, and implement KnownFailure support as
1086
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
1087
    def test_skipped_test(self):
1088
        # run a test that is skipped, and check the suite as a whole still
1089
        # succeeds.
1090
        # skipping_test must be hidden in here so it's not run as a real test
1091
        def skipping_test():
1092
            raise TestSkipped('test intentionally skipped')
2338.4.8 by Marien Zwart
Fix a bug in selftest causing tearDown to run twice for skipped tests.
1093
2485.6.5 by Martin Pool
Remove keep_output option
1094
        runner = TextTestRunner(stream=self._log_file)
2338.4.10 by Marien Zwart
Make a test skipped from setUp run tearDown again. Make calling _runCleanups twice safe. Clean up tests.
1095
        test = unittest.FunctionTestCase(skipping_test)
1096
        result = self.run_test_runner(runner, test)
1097
        self.assertTrue(result.wasSuccessful())
1098
1099
    def test_skipped_from_setup(self):
1100
        class SkippedSetupTest(TestCase):
2338.4.8 by Marien Zwart
Fix a bug in selftest causing tearDown to run twice for skipped tests.
1101
1102
            def setUp(self):
2338.4.10 by Marien Zwart
Make a test skipped from setUp run tearDown again. Make calling _runCleanups twice safe. Clean up tests.
1103
                self.counter = 1
1104
                self.addCleanup(self.cleanup)
2338.4.8 by Marien Zwart
Fix a bug in selftest causing tearDown to run twice for skipped tests.
1105
                raise TestSkipped('skipped setup')
1106
1107
            def test_skip(self):
1108
                self.fail('test reached')
1109
2338.4.10 by Marien Zwart
Make a test skipped from setUp run tearDown again. Make calling _runCleanups twice safe. Clean up tests.
1110
            def cleanup(self):
1111
                self.counter -= 1
1112
2485.6.5 by Martin Pool
Remove keep_output option
1113
        runner = TextTestRunner(stream=self._log_file)
2338.4.10 by Marien Zwart
Make a test skipped from setUp run tearDown again. Make calling _runCleanups twice safe. Clean up tests.
1114
        test = SkippedSetupTest('test_skip')
1115
        result = self.run_test_runner(runner, test)
1116
        self.assertTrue(result.wasSuccessful())
1117
        # Check if cleanup was called the right number of times.
1118
        self.assertEqual(0, test.counter)
1119
1120
    def test_skipped_from_test(self):
1121
        class SkippedTest(TestCase):
2338.4.8 by Marien Zwart
Fix a bug in selftest causing tearDown to run twice for skipped tests.
1122
1123
            def setUp(self):
1124
                self.counter = 1
2338.4.10 by Marien Zwart
Make a test skipped from setUp run tearDown again. Make calling _runCleanups twice safe. Clean up tests.
1125
                self.addCleanup(self.cleanup)
2338.4.8 by Marien Zwart
Fix a bug in selftest causing tearDown to run twice for skipped tests.
1126
1127
            def test_skip(self):
1128
                raise TestSkipped('skipped test')
1129
2338.4.10 by Marien Zwart
Make a test skipped from setUp run tearDown again. Make calling _runCleanups twice safe. Clean up tests.
1130
            def cleanup(self):
2338.4.8 by Marien Zwart
Fix a bug in selftest causing tearDown to run twice for skipped tests.
1131
                self.counter -= 1
1132
2485.6.5 by Martin Pool
Remove keep_output option
1133
        runner = TextTestRunner(stream=self._log_file)
2338.4.8 by Marien Zwart
Fix a bug in selftest causing tearDown to run twice for skipped tests.
1134
        test = SkippedTest('test_skip')
1135
        result = self.run_test_runner(runner, test)
1136
        self.assertTrue(result.wasSuccessful())
2338.4.10 by Marien Zwart
Make a test skipped from setUp run tearDown again. Make calling _runCleanups twice safe. Clean up tests.
1137
        # Check if cleanup was called the right number of times.
2338.4.8 by Marien Zwart
Fix a bug in selftest causing tearDown to run twice for skipped tests.
1138
        self.assertEqual(0, test.counter)
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
1139
2729.1.1 by Martin Pool
Add TestNotApplicable exception and handling of it; document test parameterization
1140
    def test_not_applicable(self):
1141
        # run a test that is skipped because it's not applicable
1142
        def not_applicable_test():
1143
            from bzrlib.tests import TestNotApplicable
1144
            raise TestNotApplicable('this test never runs')
1145
        out = StringIO()
1146
        runner = TextTestRunner(stream=out, verbosity=2)
1147
        test = unittest.FunctionTestCase(not_applicable_test)
1148
        result = self.run_test_runner(runner, test)
1149
        self._log_file.write(out.getvalue())
1150
        self.assertTrue(result.wasSuccessful())
1151
        self.assertTrue(result.wasStrictlySuccessful())
1152
        self.assertContainsRe(out.getvalue(),
1153
                r'(?m)not_applicable_test   * N/A')
1154
        self.assertContainsRe(out.getvalue(),
1155
                r'(?m)^    this test never runs')
1156
1157
    def test_not_applicable_demo(self):
1158
        # just so you can see it in the test output
1159
        raise TestNotApplicable('this test is just a demonstation')
1160
2367.1.5 by Robert Collins
Implement reporting of Unsupported tests in the bzr test result and runner
1161
    def test_unsupported_features_listed(self):
1162
        """When unsupported features are encountered they are detailed."""
1163
        class Feature1(Feature):
1164
            def _probe(self): return False
1165
        class Feature2(Feature):
1166
            def _probe(self): return False
1167
        # create sample tests
1168
        test1 = SampleTestCase('_test_pass')
1169
        test1._test_needs_features = [Feature1()]
1170
        test2 = SampleTestCase('_test_pass')
1171
        test2._test_needs_features = [Feature2()]
1172
        test = unittest.TestSuite()
1173
        test.addTest(test1)
1174
        test.addTest(test2)
1175
        stream = StringIO()
1176
        runner = TextTestRunner(stream=stream)
1177
        result = self.run_test_runner(runner, test)
1178
        lines = stream.getvalue().splitlines()
1179
        self.assertEqual([
1180
            'OK',
1181
            "Missing feature 'Feature1' skipped 1 tests.",
1182
            "Missing feature 'Feature2' skipped 1 tests.",
1183
            ],
2367.1.6 by Robert Collins
Allow per-test-fixture feature requirements via 'requireFeature'.(Robert Collins)
1184
            lines[-3:])
2367.1.5 by Robert Collins
Implement reporting of Unsupported tests in the bzr test result and runner
1185
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
1186
    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.
1187
        # tests that the running the benchmark produces a history file
1188
        # containing a timestamp and the revision id of the bzrlib source which
1189
        # was tested.
1190
        workingtree = _get_bzr_source_tree()
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
1191
        test = TestRunner('dummy_test')
1192
        output = StringIO()
1193
        runner = TextTestRunner(stream=self._log_file, bench_history=output)
1194
        result = self.run_test_runner(runner, test)
1195
        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.
1196
        self.assertContainsRe(output_string, "--date [0-9.]+")
1197
        if workingtree is not None:
1908.7.6 by Robert Collins
Deprecate WorkingTree.last_revision.
1198
            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.
1199
            self.assertEndsWith(output_string.rstrip(), revision_id)
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
1200
2036.1.1 by John Arbash Meinel
test that logs are kept or deleted when appropriate
1201
    def test_success_log_deleted(self):
1202
        """Successful tests have their log deleted"""
1203
1204
        class LogTester(TestCase):
1205
1206
            def test_success(self):
1207
                self.log('this will be removed\n')
1208
1209
        sio = cStringIO.StringIO()
1210
        runner = TextTestRunner(stream=sio)
1211
        test = LogTester('test_success')
1212
        result = self.run_test_runner(runner, test)
1213
1214
        log = test._get_log()
1215
        self.assertEqual("DELETED log file to reduce memory footprint", log)
1216
        self.assertEqual('', test._log_contents)
1217
        self.assertIs(None, test._log_file_name)
1218
1219
    def test_fail_log_kept(self):
1220
        """Failed tests have their log kept"""
1221
1222
        class LogTester(TestCase):
1223
1224
            def test_fail(self):
1225
                self.log('this will be kept\n')
1226
                self.fail('this test fails')
1227
1228
        sio = cStringIO.StringIO()
1229
        runner = TextTestRunner(stream=sio)
1230
        test = LogTester('test_fail')
1231
        result = self.run_test_runner(runner, test)
1232
1233
        text = sio.getvalue()
1234
        self.assertContainsRe(text, 'this will be kept')
1235
        self.assertContainsRe(text, 'this test fails')
1236
1237
        log = test._get_log()
1238
        self.assertContainsRe(log, 'this will be kept')
1239
        self.assertEqual(log, test._log_contents)
1240
1241
    def test_error_log_kept(self):
1242
        """Tests with errors have their log kept"""
1243
1244
        class LogTester(TestCase):
1245
1246
            def test_error(self):
1247
                self.log('this will be kept\n')
1248
                raise ValueError('random exception raised')
1249
1250
        sio = cStringIO.StringIO()
1251
        runner = TextTestRunner(stream=sio)
1252
        test = LogTester('test_error')
1253
        result = self.run_test_runner(runner, test)
1254
1255
        text = sio.getvalue()
1256
        self.assertContainsRe(text, 'this will be kept')
1257
        self.assertContainsRe(text, 'random exception raised')
1258
1259
        log = test._get_log()
1260
        self.assertContainsRe(log, 'this will be kept')
1261
        self.assertEqual(log, test._log_contents)
1819.1.2 by Carl Friedrich Bolz
(lifeless, cfbolz, hpk): Add a benchmark output parameter to TextTestRunner.
1262
2036.1.2 by John Arbash Meinel
whitespace fix
1263
2367.1.3 by Robert Collins
Add support for calling addNotSupported on TestResults to bzr TestCase's
1264
class SampleTestCase(TestCase):
1265
1266
    def _test_pass(self):
1267
        pass
1268
1269
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
1270
class TestTestCase(TestCase):
1271
    """Tests that test the core bzrlib TestCase."""
1272
2560.1.1 by Robert Collins
Make debug.debug_flags be isolated for all tests.
1273
    def test_debug_flags_sanitised(self):
1274
        """The bzrlib debug flags should be sanitised by setUp."""
1275
        # we could set something and run a test that will check
1276
        # it gets santised, but this is probably sufficient for now:
1277
        # if someone runs the test with -Dsomething it will error.
1278
        self.assertEqual(set(), bzrlib.debug.debug_flags)
1279
1534.11.7 by Robert Collins
Test and correct the problem with nested test logs breaking further in-test logs.
1280
    def inner_test(self):
1281
        # the inner child test
1282
        note("inner_test")
1283
1284
    def outer_child(self):
1285
        # the outer child test
1286
        note("outer_start")
1287
        self.inner_test = TestTestCase("inner_child")
2095.4.1 by Martin Pool
Better progress bars during tests
1288
        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.
1289
                                        descriptions=0,
1290
                                        verbosity=1)
1291
        self.inner_test.run(result)
1292
        note("outer finish")
1293
1294
    def test_trace_nesting(self):
1295
        # this tests that each test case nests its trace facility correctly.
1296
        # we do this by running a test case manually. That test case (A)
1297
        # should setup a new log, log content to it, setup a child case (B),
1298
        # which should log independently, then case (A) should log a trailer
1299
        # and return.
1300
        # we do two nested children so that we can verify the state of the 
1301
        # logs after the outer child finishes is correct, which a bad clean
1302
        # up routine in tearDown might trigger a fault in our test with only
1303
        # one child, we should instead see the bad result inside our test with
1304
        # the two children.
1305
        # the outer child test
1306
        original_trace = bzrlib.trace._trace_file
1307
        outer_test = TestTestCase("outer_child")
2095.4.1 by Martin Pool
Better progress bars during tests
1308
        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.
1309
                                        descriptions=0,
1310
                                        verbosity=1)
1311
        outer_test.run(result)
1312
        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)
1313
1314
    def method_that_times_a_bit_twice(self):
1315
        # 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.
1316
        self.time(time.sleep, 0.007)
1317
        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)
1318
1319
    def test_time_creates_benchmark_in_result(self):
1320
        """Test that the TestCase.time() method accumulates a benchmark time."""
1321
        sample_test = TestTestCase("method_that_times_a_bit_twice")
1322
        output_stream = StringIO()
2095.4.1 by Martin Pool
Better progress bars during tests
1323
        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)
1324
            unittest._WritelnDecorator(output_stream),
1325
            descriptions=0,
2095.4.1 by Martin Pool
Better progress bars during tests
1326
            verbosity=2,
1327
            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)
1328
        sample_test.run(result)
1329
        self.assertContainsRe(
1330
            output_stream.getvalue(),
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
1331
            r"\d+ms/ +\d+ms\n$")
2245.1.1 by Robert Collins
New Branch hooks facility, with one initial hook 'set_rh' which triggers
1332
1333
    def test_hooks_sanitised(self):
1334
        """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.
1335
        self.assertEqual(bzrlib.branch.BranchHooks(),
2245.1.1 by Robert Collins
New Branch hooks facility, with one initial hook 'set_rh' which triggers
1336
            bzrlib.branch.Branch.hooks)
2400.1.7 by Andrew Bennetts
Merge from bzr.dev.
1337
        self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
1338
            bzrlib.smart.server.SmartTCPServer.hooks)
2245.1.1 by Robert Collins
New Branch hooks facility, with one initial hook 'set_rh' which triggers
1339
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
1340
    def test__gather_lsprof_in_benchmarks(self):
1341
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1342
        
1343
        Each self.time() call is individually and separately profiled.
1344
        """
1551.15.28 by Aaron Bentley
Improve Feature usage style w/ lsprof
1345
        self.requireFeature(test_lsprof.LSProfFeature)
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
1346
        # overrides the class member with an instance member so no cleanup 
1347
        # needed.
1348
        self._gather_lsprof_in_benchmarks = True
1349
        self.time(time.sleep, 0.000)
1350
        self.time(time.sleep, 0.003)
1351
        self.assertEqual(2, len(self._benchcalls))
1352
        self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
1353
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1354
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1355
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1356
2367.1.2 by Robert Collins
Some minor cleanups of test code, and implement KnownFailure support as
1357
    def test_knownFailure(self):
1358
        """Self.knownFailure() should raise a KnownFailure exception."""
1359
        self.assertRaises(KnownFailure, self.knownFailure, "A Failure")
1360
2367.1.6 by Robert Collins
Allow per-test-fixture feature requirements via 'requireFeature'.(Robert Collins)
1361
    def test_requireFeature_available(self):
1362
        """self.requireFeature(available) is a no-op."""
1363
        class Available(Feature):
1364
            def _probe(self):return True
1365
        feature = Available()
1366
        self.requireFeature(feature)
1367
1368
    def test_requireFeature_unavailable(self):
1369
        """self.requireFeature(unavailable) raises UnavailableFeature."""
1370
        class Unavailable(Feature):
1371
            def _probe(self):return False
1372
        feature = Unavailable()
1373
        self.assertRaises(UnavailableFeature, self.requireFeature, feature)
1374
2367.1.3 by Robert Collins
Add support for calling addNotSupported on TestResults to bzr TestCase's
1375
    def test_run_no_parameters(self):
1376
        test = SampleTestCase('_test_pass')
1377
        test.run()
1378
    
1379
    def test_run_enabled_unittest_result(self):
1380
        """Test we revert to regular behaviour when the test is enabled."""
1381
        test = SampleTestCase('_test_pass')
1382
        class EnabledFeature(object):
1383
            def available(self):
1384
                return True
1385
        test._test_needs_features = [EnabledFeature()]
1386
        result = unittest.TestResult()
1387
        test.run(result)
1388
        self.assertEqual(1, result.testsRun)
1389
        self.assertEqual([], result.errors)
1390
        self.assertEqual([], result.failures)
1391
1392
    def test_run_disabled_unittest_result(self):
1393
        """Test our compatability for disabled tests with unittest results."""
1394
        test = SampleTestCase('_test_pass')
1395
        class DisabledFeature(object):
1396
            def available(self):
1397
                return False
1398
        test._test_needs_features = [DisabledFeature()]
1399
        result = unittest.TestResult()
1400
        test.run(result)
1401
        self.assertEqual(1, result.testsRun)
1402
        self.assertEqual([], result.errors)
1403
        self.assertEqual([], result.failures)
1404
1405
    def test_run_disabled_supporting_result(self):
1406
        """Test disabled tests behaviour with support aware results."""
1407
        test = SampleTestCase('_test_pass')
1408
        class DisabledFeature(object):
1409
            def available(self):
1410
                return False
1411
        the_feature = DisabledFeature()
1412
        test._test_needs_features = [the_feature]
1413
        class InstrumentedTestResult(unittest.TestResult):
1414
            def __init__(self):
1415
                unittest.TestResult.__init__(self)
1416
                self.calls = []
1417
            def startTest(self, test):
1418
                self.calls.append(('startTest', test))
1419
            def stopTest(self, test):
1420
                self.calls.append(('stopTest', test))
1421
            def addNotSupported(self, test, feature):
1422
                self.calls.append(('addNotSupported', test, feature))
1423
        result = InstrumentedTestResult()
1424
        test.run(result)
1425
        self.assertEqual([
1426
            ('startTest', test),
1427
            ('addNotSupported', test, the_feature),
1428
            ('stopTest', test),
1429
            ],
1430
            result.calls)
1431
1534.11.4 by Robert Collins
Merge from mainline.
1432
1982.3.2 by Robert Collins
New TestCase helper applyDeprecated. This allows you to call a callable
1433
@symbol_versioning.deprecated_function(zero_eleven)
1434
def sample_deprecated_function():
1435
    """A deprecated function to test applyDeprecated with."""
1436
    return 2
1437
1438
1439
def sample_undeprecated_function(a_param):
1440
    """A undeprecated function to test applyDeprecated with."""
1441
1442
1443
class ApplyDeprecatedHelper(object):
1444
    """A helper class for ApplyDeprecated tests."""
1445
1446
    @symbol_versioning.deprecated_method(zero_eleven)
1447
    def sample_deprecated_method(self, param_one):
1448
        """A deprecated method for testing with."""
1449
        return param_one
1450
1451
    def sample_normal_method(self):
1452
        """A undeprecated method."""
1453
1454
    @symbol_versioning.deprecated_method(zero_ten)
1455
    def sample_nested_deprecation(self):
1456
        return sample_deprecated_function()
1457
1458
1540.3.22 by Martin Pool
[patch] Add TestCase.assertIsInstance
1459
class TestExtraAssertions(TestCase):
1460
    """Tests for new test assertions in bzrlib test suite"""
1461
1462
    def test_assert_isinstance(self):
1463
        self.assertIsInstance(2, int)
1464
        self.assertIsInstance(u'', basestring)
1465
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1466
        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
1467
1692.3.1 by Robert Collins
Fix push to work with just a branch, no need for a working tree.
1468
    def test_assertEndsWith(self):
1469
        self.assertEndsWith('foo', 'oo')
1470
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1471
1982.3.2 by Robert Collins
New TestCase helper applyDeprecated. This allows you to call a callable
1472
    def test_applyDeprecated_not_deprecated(self):
1473
        sample_object = ApplyDeprecatedHelper()
1474
        # calling an undeprecated callable raises an assertion
1475
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
1476
            sample_object.sample_normal_method)
1477
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
1478
            sample_undeprecated_function, "a param value")
1479
        # calling a deprecated callable (function or method) with the wrong
1480
        # expected deprecation fails.
1481
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
1482
            sample_object.sample_deprecated_method, "a param value")
1483
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
1484
            sample_deprecated_function)
1485
        # calling a deprecated callable (function or method) with the right
1486
        # expected deprecation returns the functions result.
1487
        self.assertEqual("a param value", self.applyDeprecated(zero_eleven,
1488
            sample_object.sample_deprecated_method, "a param value"))
1489
        self.assertEqual(2, self.applyDeprecated(zero_eleven,
1490
            sample_deprecated_function))
1491
        # calling a nested deprecation with the wrong deprecation version
1492
        # fails even if a deeper nested function was deprecated with the 
1493
        # supplied version.
1494
        self.assertRaises(AssertionError, self.applyDeprecated,
1495
            zero_eleven, sample_object.sample_nested_deprecation)
1496
        # calling a nested deprecation with the right deprecation value
1497
        # returns the calls result.
1498
        self.assertEqual(2, self.applyDeprecated(zero_ten,
1499
            sample_object.sample_nested_deprecation))
1500
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
1501
    def test_callDeprecated(self):
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
1502
        def testfunc(be_deprecated, result=None):
1910.2.10 by Aaron Bentley
Add tests for assertDeprecated
1503
            if be_deprecated is True:
1504
                symbol_versioning.warn('i am deprecated', DeprecationWarning, 
1505
                                       stacklevel=1)
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
1506
            return result
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
1507
        result = self.callDeprecated(['i am deprecated'], testfunc, True)
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
1508
        self.assertIs(None, result)
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
1509
        result = self.callDeprecated([], testfunc, False, 'result')
1551.8.8 by Aaron Bentley
Made assertDeprecated return the callable's result
1510
        self.assertEqual('result', result)
1982.3.2 by Robert Collins
New TestCase helper applyDeprecated. This allows you to call a callable
1511
        self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
1551.8.9 by Aaron Bentley
Rename assertDeprecated to callDeprecated
1512
        self.callDeprecated([], testfunc, be_deprecated=False)
1910.2.10 by Aaron Bentley
Add tests for assertDeprecated
1513
1666.1.4 by Robert Collins
* 'Metadir' is now the default disk format. This improves behaviour in
1514
1515
class TestConvenienceMakers(TestCaseWithTransport):
1516
    """Test for the make_* convenience functions."""
1517
1518
    def test_make_branch_and_tree_with_format(self):
1519
        # we should be able to supply a format to make_branch_and_tree
1520
        self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
1521
        self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
1522
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
1523
                              bzrlib.bzrdir.BzrDirMetaFormat1)
1524
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
1525
                              bzrlib.bzrdir.BzrDirFormat6)
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
1526
1986.2.1 by Robert Collins
Bugfix - the name of the test for make_branch_and_memory_tree was wrong.
1527
    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
1528
        # we should be able to get a new branch and a mutable tree from
1529
        # TestCaseWithTransport
1530
        tree = self.make_branch_and_memory_tree('a')
1531
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1532
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
1533
1910.14.1 by Andrew Bennetts
Fix to make_branch_and_tree's behavior when used with an sftp transport.
1534
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
1535
1536
    def test_make_tree_for_sftp_branch(self):
1537
        """Transports backed by local directories create local trees."""
1538
1539
        tree = self.make_branch_and_tree('t1')
1540
        base = tree.bzrdir.root_transport.base
1541
        self.failIf(base.startswith('sftp'),
1542
                'base %r is on sftp but should be local' % base)
1543
        self.assertEquals(tree.bzrdir.root_transport,
1544
                tree.branch.bzrdir.root_transport)
1545
        self.assertEquals(tree.bzrdir.root_transport,
1546
                tree.branch.repository.bzrdir.root_transport)
1547
1548
1707.2.1 by Robert Collins
'bzr selftest --benchmark' will run a new benchmarking selftest.
1549
class TestSelftest(TestCase):
1550
    """Tests of bzrlib.tests.selftest."""
1551
1552
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1553
        factory_called = []
1554
        def factory():
1555
            factory_called.append(True)
1556
            return TestSuite()
1557
        out = StringIO()
1558
        err = StringIO()
1559
        self.apply_redirected(out, err, None, bzrlib.tests.selftest, 
1560
            test_suite_factory=factory)
1561
        self.assertEqual([True], factory_called)
2172.4.3 by Alexander Belchenko
Change name of option to '--clean-output' and provide tests
1562
1563
2367.1.2 by Robert Collins
Some minor cleanups of test code, and implement KnownFailure support as
1564
class TestKnownFailure(TestCase):
1565
1566
    def test_known_failure(self):
1567
        """Check that KnownFailure is defined appropriately."""
1568
        # a KnownFailure is an assertion error for compatability with unaware
1569
        # runners.
1570
        self.assertIsInstance(KnownFailure(""), AssertionError)
2367.1.4 by Robert Collins
Add operating system Feature model to bzrlib.tests to allow writing tests
1571
1551.13.9 by Aaron Bentley
Implement TestCase.expectFailure
1572
    def test_expect_failure(self):
1573
        try:
1574
            self.expectFailure("Doomed to failure", self.assertTrue, False)
1575
        except KnownFailure, e:
1576
            self.assertEqual('Doomed to failure', e.args[0])
1577
        try:
1578
            self.expectFailure("Doomed to failure", self.assertTrue, True)
1579
        except AssertionError, e:
1580
            self.assertEqual('Unexpected success.  Should have failed:'
1581
                             ' Doomed to failure', e.args[0])
1582
        else:
1583
            self.fail('Assertion not raised')
1584
2367.1.4 by Robert Collins
Add operating system Feature model to bzrlib.tests to allow writing tests
1585
1586
class TestFeature(TestCase):
1587
1588
    def test_caching(self):
1589
        """Feature._probe is called by the feature at most once."""
1590
        class InstrumentedFeature(Feature):
1591
            def __init__(self):
1592
                Feature.__init__(self)
1593
                self.calls = []
1594
            def _probe(self):
1595
                self.calls.append('_probe')
1596
                return False
1597
        feature = InstrumentedFeature()
1598
        feature.available()
1599
        self.assertEqual(['_probe'], feature.calls)
1600
        feature.available()
1601
        self.assertEqual(['_probe'], feature.calls)
1602
1603
    def test_named_str(self):
1604
        """Feature.__str__ should thunk to feature_name()."""
1605
        class NamedFeature(Feature):
1606
            def feature_name(self):
1607
                return 'symlinks'
1608
        feature = NamedFeature()
1609
        self.assertEqual('symlinks', str(feature))
1610
1611
    def test_default_str(self):
1612
        """Feature.__str__ should default to __class__.__name__."""
1613
        class NamedFeature(Feature):
1614
            pass
1615
        feature = NamedFeature()
1616
        self.assertEqual('NamedFeature', str(feature))
2367.1.6 by Robert Collins
Allow per-test-fixture feature requirements via 'requireFeature'.(Robert Collins)
1617
1618
1619
class TestUnavailableFeature(TestCase):
1620
1621
    def test_access_feature(self):
1622
        feature = Feature()
1623
        exception = UnavailableFeature(feature)
1624
        self.assertIs(feature, exception.args[0])
2394.2.5 by Ian Clatworthy
list-only working, include test not
1625
1626
1627
class TestSelftestFiltering(TestCase):
1628
2394.2.7 by Ian Clatworthy
Added whitebox tests - filter_suite_by_re and sort_suite_by_re
1629
    def setUp(self):
1630
        self.suite = TestUtil.TestSuite()
1631
        self.loader = TestUtil.TestLoader()
1632
        self.suite.addTest(self.loader.loadTestsFromModuleNames([
1633
            'bzrlib.tests.test_selftest']))
1634
        self.all_names = [t.id() for t in iter_suite_tests(self.suite)]
1635
2394.2.5 by Ian Clatworthy
list-only working, include test not
1636
    def test_filter_suite_by_re(self):
2394.2.7 by Ian Clatworthy
Added whitebox tests - filter_suite_by_re and sort_suite_by_re
1637
        filtered_suite = filter_suite_by_re(self.suite, 'test_filter')
1638
        filtered_names = [t.id() for t in iter_suite_tests(filtered_suite)]
1639
        self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
1640
            'TestSelftestFiltering.test_filter_suite_by_re'])
1641
            
1642
    def test_sort_suite_by_re(self):
1643
        sorted_suite = sort_suite_by_re(self.suite, 'test_filter')
1644
        sorted_names = [t.id() for t in iter_suite_tests(sorted_suite)]
1645
        self.assertEqual(sorted_names[0], 'bzrlib.tests.test_selftest.'
1646
            'TestSelftestFiltering.test_filter_suite_by_re')
1647
        self.assertEquals(sorted(self.all_names), sorted(sorted_names))
1648
2545.3.2 by James Westby
Add a test for check_inventory_shape.
1649
1650
class TestCheckInventoryShape(TestCaseWithTransport):
1651
1652
    def test_check_inventory_shape(self):
2561.1.2 by Aaron Bentley
Fix indenting in TestCheckInventoryShape
1653
        files = ['a', 'b/', 'b/c']
1654
        tree = self.make_branch_and_tree('.')
1655
        self.build_tree(files)
1656
        tree.add(files)
1657
        tree.lock_read()
1658
        try:
1659
            self.check_inventory_shape(tree.inventory, files)
1660
        finally:
1661
            tree.unlock()
2830.2.1 by Martin Pool
If TestCase.run_bzr hits an internal exception, don't catch it but rather propagate up into the test suite
1662
1663
1664
class TestBlackboxSupport(TestCase):
1665
    """Tests for testsuite blackbox features."""
1666
1667
    def test_run_bzr_failure_not_caught(self):
1668
        # When we run bzr in blackbox mode, we want any unexpected errors to
1669
        # propagate up to the test suite so that it can show the error in the
1670
        # usual way, and we won't get a double traceback.
1671
        e = self.assertRaises(
1672
            AssertionError,
1673
            self.run_bzr, ['assert-fail'])
1674
        # make sure we got the real thing, not an error from somewhere else in
1675
        # the test framework
1676
        self.assertEquals('always fails', str(e))
1677
        # check that there's no traceback in the test log
1678
        self.assertNotContainsRe(self._get_log(keep_log_file=True),
1679
            r'Traceback')
1680
1681
    def test_run_bzr_user_error_caught(self):
1682
        # Running bzr in blackbox mode, normal/expected/user errors should be
1683
        # caught in the regular way and turned into an error message plus exit
1684
        # code.
1685
        out, err = self.run_bzr(["log", "/nonexistantpath"], retcode=3)
1686
        self.assertEqual(out, '')
1687
        self.assertEqual(err, 'bzr: ERROR: Not a branch: "/nonexistantpath/".\n')