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