~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-09 20:23:07 UTC
  • mfrom: (4265.1.4 bbc-merge)
  • Revision ID: pqm@pqm.ubuntu.com-20090409202307-n0depb16qepoe21o
(jam) Change _fetch_uses_deltas = False for CHK repos until we can
        write a better fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for the test framework."""
18
18
 
26
26
 
27
27
import bzrlib
28
28
from bzrlib import (
 
29
    branchbuilder,
29
30
    bzrdir,
30
31
    errors,
31
32
    memorytree,
32
33
    osutils,
 
34
    remote,
33
35
    repository,
34
36
    symbol_versioning,
 
37
    tests,
 
38
    workingtree,
35
39
    )
36
40
from bzrlib.progress import _BaseProgressBar
37
 
from bzrlib.repofmt import weaverepo
38
 
from bzrlib.symbol_versioning import zero_ten, zero_eleven
 
41
from bzrlib.repofmt import (
 
42
    pack_repo,
 
43
    weaverepo,
 
44
    )
 
45
from bzrlib.symbol_versioning import (
 
46
    deprecated_function,
 
47
    deprecated_in,
 
48
    deprecated_method,
 
49
    )
39
50
from bzrlib.tests import (
40
51
                          ChrootedTestCase,
41
52
                          ExtendedTestResult,
45
56
                          TestCaseInTempDir,
46
57
                          TestCaseWithMemoryTransport,
47
58
                          TestCaseWithTransport,
 
59
                          TestNotApplicable,
48
60
                          TestSkipped,
49
61
                          TestSuite,
 
62
                          TestUtil,
50
63
                          TextTestRunner,
51
64
                          UnavailableFeature,
52
 
                          clean_selftest_output,
 
65
                          condition_id_re,
 
66
                          condition_isinstance,
 
67
                          exclude_tests_by_condition,
 
68
                          exclude_tests_by_re,
 
69
                          filter_suite_by_condition,
 
70
                          filter_suite_by_re,
 
71
                          iter_suite_tests,
 
72
                          preserve_input,
 
73
                          randomize_suite,
 
74
                          run_suite,
 
75
                          split_suite_by_condition,
 
76
                          split_suite_by_re,
 
77
                          test_lsprof,
 
78
                          test_suite,
53
79
                          )
54
80
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
55
81
from bzrlib.tests.TestUtil import _load_module_by_name
58
84
from bzrlib.version import _get_bzr_source_tree
59
85
 
60
86
 
 
87
def _test_ids(test_suite):
 
88
    """Get the ids for the tests in a test suite."""
 
89
    return [t.id() for t in iter_suite_tests(test_suite)]
 
90
 
 
91
 
61
92
class SelftestTests(TestCase):
62
93
 
63
94
    def test_import_tests(self):
79
110
                              'a test message\n')
80
111
 
81
112
 
 
113
class TestUnicodeFilename(TestCase):
 
114
 
 
115
    def test_probe_passes(self):
 
116
        """UnicodeFilename._probe passes."""
 
117
        # We can't test much more than that because the behaviour depends
 
118
        # on the platform.
 
119
        tests.UnicodeFilename._probe()
 
120
 
 
121
 
82
122
class TestTreeShape(TestCaseInTempDir):
83
123
 
84
124
    def test_unicode_paths(self):
 
125
        self.requireFeature(tests.UnicodeFilename)
 
126
 
85
127
        filename = u'hell\u00d8'
86
 
        try:
87
 
            self.build_tree_contents([(filename, 'contents of hello')])
88
 
        except UnicodeEncodeError:
89
 
            raise TestSkipped("can't build unicode working tree in "
90
 
                "filesystem encoding %s" % sys.getfilesystemencoding())
 
128
        self.build_tree_contents([(filename, 'contents of hello')])
91
129
        self.failUnlessExists(filename)
92
130
 
93
131
 
94
 
class TestTransportProviderAdapter(TestCase):
 
132
class TestTransportScenarios(TestCase):
95
133
    """A group of tests that test the transport implementation adaption core.
96
134
 
97
 
    This is a meta test that the tests are applied to all available 
 
135
    This is a meta test that the tests are applied to all available
98
136
    transports.
99
137
 
100
 
    This will be generalised in the future which is why it is in this 
 
138
    This will be generalised in the future which is why it is in this
101
139
    test file even though it is specific to transport tests at the moment.
102
140
    """
103
141
 
104
142
    def test_get_transport_permutations(self):
105
 
        # this checks that we the module get_test_permutations call
106
 
        # is made by the adapter get_transport_test_permitations method.
 
143
        # this checks that get_test_permutations defined by the module is
 
144
        # called by the get_transport_test_permutations function.
107
145
        class MockModule(object):
108
146
            def get_test_permutations(self):
109
147
                return sample_permutation
110
148
        sample_permutation = [(1,2), (3,4)]
111
 
        from bzrlib.transport import TransportTestProviderAdapter
112
 
        adapter = TransportTestProviderAdapter()
 
149
        from bzrlib.tests.test_transport_implementations \
 
150
            import get_transport_test_permutations
113
151
        self.assertEqual(sample_permutation,
114
 
                         adapter.get_transport_test_permutations(MockModule()))
 
152
                         get_transport_test_permutations(MockModule()))
115
153
 
116
 
    def test_adapter_checks_all_modules(self):
117
 
        # this checks that the adapter returns as many permurtations as
118
 
        # there are in all the registered# transport modules for there
119
 
        # - we assume if this matches its probably doing the right thing
120
 
        # especially in combination with the tests for setting the right
121
 
        # classes below.
122
 
        from bzrlib.transport import (TransportTestProviderAdapter,
123
 
                                      _get_transport_modules
124
 
                                      )
 
154
    def test_scenarios_invlude_all_modules(self):
 
155
        # this checks that the scenario generator returns as many permutations
 
156
        # as there are in all the registered transport modules - we assume if
 
157
        # this matches its probably doing the right thing especially in
 
158
        # combination with the tests for setting the right classes below.
 
159
        from bzrlib.tests.test_transport_implementations \
 
160
            import transport_test_permutations
 
161
        from bzrlib.transport import _get_transport_modules
125
162
        modules = _get_transport_modules()
126
163
        permutation_count = 0
127
164
        for module in modules:
128
165
            try:
129
 
                permutation_count += len(reduce(getattr, 
 
166
                permutation_count += len(reduce(getattr,
130
167
                    (module + ".get_test_permutations").split('.')[1:],
131
168
                     __import__(module))())
132
169
            except errors.DependencyNotPresent:
133
170
                pass
134
 
        input_test = TestTransportProviderAdapter(
135
 
            "test_adapter_sets_transport_class")
136
 
        adapter = TransportTestProviderAdapter()
137
 
        self.assertEqual(permutation_count,
138
 
                         len(list(iter(adapter.adapt(input_test)))))
 
171
        scenarios = transport_test_permutations()
 
172
        self.assertEqual(permutation_count, len(scenarios))
139
173
 
140
 
    def test_adapter_sets_transport_class(self):
141
 
        # Check that the test adapter inserts a transport and server into the
142
 
        # generated test.
143
 
        #
 
174
    def test_scenarios_include_transport_class(self):
144
175
        # This test used to know about all the possible transports and the
145
176
        # order they were returned but that seems overly brittle (mbp
146
177
        # 20060307)
147
 
        input_test = TestTransportProviderAdapter(
148
 
            "test_adapter_sets_transport_class")
149
 
        from bzrlib.transport import TransportTestProviderAdapter
150
 
        suite = TransportTestProviderAdapter().adapt(input_test)
151
 
        tests = list(iter(suite))
152
 
        self.assertTrue(len(tests) > 6)
 
178
        from bzrlib.tests.test_transport_implementations \
 
179
            import transport_test_permutations
 
180
        scenarios = transport_test_permutations()
153
181
        # there are at least that many builtin transports
154
 
        one_test = tests[0]
155
 
        self.assertTrue(issubclass(one_test.transport_class, 
 
182
        self.assertTrue(len(scenarios) > 6)
 
183
        one_scenario = scenarios[0]
 
184
        self.assertIsInstance(one_scenario[0], str)
 
185
        self.assertTrue(issubclass(one_scenario[1]["transport_class"],
156
186
                                   bzrlib.transport.Transport))
157
 
        self.assertTrue(issubclass(one_test.transport_server, 
 
187
        self.assertTrue(issubclass(one_scenario[1]["transport_server"],
158
188
                                   bzrlib.transport.Server))
159
189
 
160
190
 
161
 
class TestBranchProviderAdapter(TestCase):
162
 
    """A group of tests that test the branch implementation test adapter."""
 
191
class TestBranchScenarios(TestCase):
163
192
 
164
 
    def test_adapted_tests(self):
 
193
    def test_scenarios(self):
165
194
        # check that constructor parameters are passed through to the adapted
166
195
        # test.
167
 
        from bzrlib.branch import BranchTestProviderAdapter
168
 
        input_test = TestBranchProviderAdapter(
169
 
            "test_adapted_tests")
 
196
        from bzrlib.tests.branch_implementations import make_scenarios
170
197
        server1 = "a"
171
198
        server2 = "b"
172
199
        formats = [("c", "C"), ("d", "D")]
173
 
        adapter = BranchTestProviderAdapter(server1, server2, formats)
174
 
        suite = adapter.adapt(input_test)
175
 
        tests = list(iter(suite))
176
 
        self.assertEqual(2, len(tests))
177
 
        self.assertEqual(tests[0].branch_format, formats[0][0])
178
 
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
179
 
        self.assertEqual(tests[0].transport_server, server1)
180
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
181
 
        self.assertEqual(tests[1].branch_format, formats[1][0])
182
 
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
183
 
        self.assertEqual(tests[1].transport_server, server1)
184
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
185
 
 
186
 
 
187
 
class TestBzrDirProviderAdapter(TestCase):
188
 
    """A group of tests that test the bzr dir implementation test adapter."""
189
 
 
190
 
    def test_adapted_tests(self):
 
200
        scenarios = make_scenarios(server1, server2, formats)
 
201
        self.assertEqual(2, len(scenarios))
 
202
        self.assertEqual([
 
203
            ('str',
 
204
             {'branch_format': 'c',
 
205
              'bzrdir_format': 'C',
 
206
              'transport_readonly_server': 'b',
 
207
              'transport_server': 'a'}),
 
208
            ('str',
 
209
             {'branch_format': 'd',
 
210
              'bzrdir_format': 'D',
 
211
              'transport_readonly_server': 'b',
 
212
              'transport_server': 'a'})],
 
213
            scenarios)
 
214
 
 
215
 
 
216
class TestBzrDirScenarios(TestCase):
 
217
 
 
218
    def test_scenarios(self):
191
219
        # check that constructor parameters are passed through to the adapted
192
220
        # test.
193
 
        from bzrlib.bzrdir import BzrDirTestProviderAdapter
194
 
        input_test = TestBzrDirProviderAdapter(
195
 
            "test_adapted_tests")
 
221
        from bzrlib.tests.bzrdir_implementations import make_scenarios
 
222
        vfs_factory = "v"
196
223
        server1 = "a"
197
224
        server2 = "b"
198
225
        formats = ["c", "d"]
199
 
        adapter = BzrDirTestProviderAdapter(server1, server2, formats)
200
 
        suite = adapter.adapt(input_test)
201
 
        tests = list(iter(suite))
202
 
        self.assertEqual(2, len(tests))
203
 
        self.assertEqual(tests[0].bzrdir_format, formats[0])
204
 
        self.assertEqual(tests[0].transport_server, server1)
205
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
206
 
        self.assertEqual(tests[1].bzrdir_format, formats[1])
207
 
        self.assertEqual(tests[1].transport_server, server1)
208
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
209
 
 
210
 
 
211
 
class TestRepositoryProviderAdapter(TestCase):
212
 
    """A group of tests that test the repository implementation test adapter."""
213
 
 
214
 
    def test_adapted_tests(self):
215
 
        # check that constructor parameters are passed through to the adapted
216
 
        # test.
217
 
        from bzrlib.repository import RepositoryTestProviderAdapter
218
 
        input_test = TestRepositoryProviderAdapter(
219
 
            "test_adapted_tests")
220
 
        server1 = "a"
221
 
        server2 = "b"
222
 
        formats = [("c", "C"), ("d", "D")]
223
 
        adapter = RepositoryTestProviderAdapter(server1, server2, formats)
224
 
        suite = adapter.adapt(input_test)
225
 
        tests = list(iter(suite))
226
 
        self.assertEqual(2, len(tests))
227
 
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
228
 
        self.assertEqual(tests[0].repository_format, formats[0][0])
229
 
        self.assertEqual(tests[0].transport_server, server1)
230
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
231
 
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
232
 
        self.assertEqual(tests[1].repository_format, formats[1][0])
233
 
        self.assertEqual(tests[1].transport_server, server1)
234
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
235
 
 
236
 
 
237
 
class TestInterRepositoryProviderAdapter(TestCase):
238
 
    """A group of tests that test the InterRepository test adapter."""
239
 
 
240
 
    def test_adapted_tests(self):
241
 
        # check that constructor parameters are passed through to the adapted
242
 
        # test.
243
 
        from bzrlib.repository import InterRepositoryTestProviderAdapter
244
 
        input_test = TestInterRepositoryProviderAdapter(
245
 
            "test_adapted_tests")
246
 
        server1 = "a"
247
 
        server2 = "b"
248
 
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
249
 
        adapter = InterRepositoryTestProviderAdapter(server1, server2, formats)
250
 
        suite = adapter.adapt(input_test)
251
 
        tests = list(iter(suite))
252
 
        self.assertEqual(2, len(tests))
253
 
        self.assertEqual(tests[0].interrepo_class, formats[0][0])
254
 
        self.assertEqual(tests[0].repository_format, formats[0][1])
255
 
        self.assertEqual(tests[0].repository_format_to, formats[0][2])
256
 
        self.assertEqual(tests[0].transport_server, server1)
257
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
258
 
        self.assertEqual(tests[1].interrepo_class, formats[1][0])
259
 
        self.assertEqual(tests[1].repository_format, formats[1][1])
260
 
        self.assertEqual(tests[1].repository_format_to, formats[1][2])
261
 
        self.assertEqual(tests[1].transport_server, server1)
262
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
263
 
 
264
 
 
265
 
class TestInterVersionedFileProviderAdapter(TestCase):
266
 
    """A group of tests that test the InterVersionedFile test adapter."""
267
 
 
268
 
    def test_adapted_tests(self):
269
 
        # check that constructor parameters are passed through to the adapted
270
 
        # test.
271
 
        from bzrlib.versionedfile import InterVersionedFileTestProviderAdapter
272
 
        input_test = TestInterRepositoryProviderAdapter(
273
 
            "test_adapted_tests")
274
 
        server1 = "a"
275
 
        server2 = "b"
276
 
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
277
 
        adapter = InterVersionedFileTestProviderAdapter(server1, server2, formats)
278
 
        suite = adapter.adapt(input_test)
279
 
        tests = list(iter(suite))
280
 
        self.assertEqual(2, len(tests))
281
 
        self.assertEqual(tests[0].interversionedfile_class, formats[0][0])
282
 
        self.assertEqual(tests[0].versionedfile_factory, formats[0][1])
283
 
        self.assertEqual(tests[0].versionedfile_factory_to, formats[0][2])
284
 
        self.assertEqual(tests[0].transport_server, server1)
285
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
286
 
        self.assertEqual(tests[1].interversionedfile_class, formats[1][0])
287
 
        self.assertEqual(tests[1].versionedfile_factory, formats[1][1])
288
 
        self.assertEqual(tests[1].versionedfile_factory_to, formats[1][2])
289
 
        self.assertEqual(tests[1].transport_server, server1)
290
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
291
 
 
292
 
 
293
 
class TestRevisionStoreProviderAdapter(TestCase):
294
 
    """A group of tests that test the RevisionStore test adapter."""
295
 
 
296
 
    def test_adapted_tests(self):
297
 
        # check that constructor parameters are passed through to the adapted
298
 
        # test.
299
 
        from bzrlib.store.revision import RevisionStoreTestProviderAdapter
300
 
        input_test = TestRevisionStoreProviderAdapter(
301
 
            "test_adapted_tests")
302
 
        # revision stores need a store factory - i.e. RevisionKnit
303
 
        #, a readonly and rw transport 
304
 
        # transport servers:
305
 
        server1 = "a"
306
 
        server2 = "b"
307
 
        store_factories = ["c", "d"]
308
 
        adapter = RevisionStoreTestProviderAdapter(server1, server2, store_factories)
309
 
        suite = adapter.adapt(input_test)
310
 
        tests = list(iter(suite))
311
 
        self.assertEqual(2, len(tests))
312
 
        self.assertEqual(tests[0].store_factory, store_factories[0][0])
313
 
        self.assertEqual(tests[0].transport_server, server1)
314
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
315
 
        self.assertEqual(tests[1].store_factory, store_factories[1][0])
316
 
        self.assertEqual(tests[1].transport_server, server1)
317
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
318
 
 
319
 
 
320
 
class TestWorkingTreeProviderAdapter(TestCase):
321
 
    """A group of tests that test the workingtree implementation test adapter."""
322
 
 
323
 
    def test_adapted_tests(self):
324
 
        # check that constructor parameters are passed through to the adapted
325
 
        # test.
326
 
        from bzrlib.workingtree import WorkingTreeTestProviderAdapter
327
 
        input_test = TestWorkingTreeProviderAdapter(
328
 
            "test_adapted_tests")
329
 
        server1 = "a"
330
 
        server2 = "b"
331
 
        formats = [("c", "C"), ("d", "D")]
332
 
        adapter = WorkingTreeTestProviderAdapter(server1, server2, formats)
333
 
        suite = adapter.adapt(input_test)
334
 
        tests = list(iter(suite))
335
 
        self.assertEqual(2, len(tests))
336
 
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
337
 
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
338
 
        self.assertEqual(tests[0].transport_server, server1)
339
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
340
 
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
341
 
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
342
 
        self.assertEqual(tests[1].transport_server, server1)
343
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
344
 
 
345
 
 
346
 
class TestTreeProviderAdapter(TestCase):
347
 
    """Test the setup of tree_implementation tests."""
348
 
 
349
 
    def test_adapted_tests(self):
350
 
        # the tree implementation adapter is meant to setup one instance for
351
 
        # each working tree format, and one additional instance that will
352
 
        # use the default wt format, but create a revision tree for the tests.
353
 
        # this means that the wt ones should have the workingtree_to_test_tree
354
 
        # attribute set to 'return_parameter' and the revision one set to
355
 
        # revision_tree_from_workingtree.
 
226
        scenarios = make_scenarios(vfs_factory, server1, server2, formats)
 
227
        self.assertEqual([
 
228
            ('str',
 
229
             {'bzrdir_format': 'c',
 
230
              'transport_readonly_server': 'b',
 
231
              'transport_server': 'a',
 
232
              'vfs_transport_factory': 'v'}),
 
233
            ('str',
 
234
             {'bzrdir_format': 'd',
 
235
              'transport_readonly_server': 'b',
 
236
              'transport_server': 'a',
 
237
              'vfs_transport_factory': 'v'})],
 
238
            scenarios)
 
239
 
 
240
 
 
241
class TestRepositoryScenarios(TestCase):
 
242
 
 
243
    def test_formats_to_scenarios(self):
 
244
        from bzrlib.tests.per_repository import formats_to_scenarios
 
245
        formats = [("(c)", remote.RemoteRepositoryFormat()),
 
246
                   ("(d)", repository.format_registry.get(
 
247
                        'Bazaar pack repository format 1 (needs bzr 0.92)\n'))]
 
248
        no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
 
249
            None)
 
250
        vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
 
251
            vfs_transport_factory="vfs")
 
252
        # no_vfs generate scenarios without vfs_transport_factory
 
253
        self.assertEqual([
 
254
            ('RemoteRepositoryFormat(c)',
 
255
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
 
256
              'repository_format': remote.RemoteRepositoryFormat(),
 
257
              'transport_readonly_server': 'readonly',
 
258
              'transport_server': 'server'}),
 
259
            ('RepositoryFormatKnitPack1(d)',
 
260
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
 
261
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
 
262
              'transport_readonly_server': 'readonly',
 
263
              'transport_server': 'server'})],
 
264
            no_vfs_scenarios)
 
265
        self.assertEqual([
 
266
            ('RemoteRepositoryFormat(c)',
 
267
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
 
268
              'repository_format': remote.RemoteRepositoryFormat(),
 
269
              'transport_readonly_server': 'readonly',
 
270
              'transport_server': 'server',
 
271
              'vfs_transport_factory': 'vfs'}),
 
272
            ('RepositoryFormatKnitPack1(d)',
 
273
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
 
274
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
 
275
              'transport_readonly_server': 'readonly',
 
276
              'transport_server': 'server',
 
277
              'vfs_transport_factory': 'vfs'})],
 
278
            vfs_scenarios)
 
279
 
 
280
 
 
281
class TestTestScenarioApplication(TestCase):
 
282
    """Tests for the test adaption facilities."""
 
283
 
 
284
    def test_apply_scenario(self):
 
285
        from bzrlib.tests import apply_scenario
 
286
        input_test = TestTestScenarioApplication("test_apply_scenario")
 
287
        # setup two adapted tests
 
288
        adapted_test1 = apply_scenario(input_test,
 
289
            ("new id",
 
290
            {"bzrdir_format":"bzr_format",
 
291
             "repository_format":"repo_fmt",
 
292
             "transport_server":"transport_server",
 
293
             "transport_readonly_server":"readonly-server"}))
 
294
        adapted_test2 = apply_scenario(input_test,
 
295
            ("new id 2", {"bzrdir_format":None}))
 
296
        # input_test should have been altered.
 
297
        self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
 
298
        # the new tests are mutually incompatible, ensuring it has
 
299
        # made new ones, and unspecified elements in the scenario
 
300
        # should not have been altered.
 
301
        self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
 
302
        self.assertEqual("repo_fmt", adapted_test1.repository_format)
 
303
        self.assertEqual("transport_server", adapted_test1.transport_server)
 
304
        self.assertEqual("readonly-server",
 
305
            adapted_test1.transport_readonly_server)
 
306
        self.assertEqual(
 
307
            "bzrlib.tests.test_selftest.TestTestScenarioApplication."
 
308
            "test_apply_scenario(new id)",
 
309
            adapted_test1.id())
 
310
        self.assertEqual(None, adapted_test2.bzrdir_format)
 
311
        self.assertEqual(
 
312
            "bzrlib.tests.test_selftest.TestTestScenarioApplication."
 
313
            "test_apply_scenario(new id 2)",
 
314
            adapted_test2.id())
 
315
 
 
316
 
 
317
class TestInterRepositoryScenarios(TestCase):
 
318
 
 
319
    def test_scenarios(self):
 
320
        # check that constructor parameters are passed through to the adapted
 
321
        # test.
 
322
        from bzrlib.tests.interrepository_implementations import \
 
323
            make_scenarios
 
324
        server1 = "a"
 
325
        server2 = "b"
 
326
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
 
327
        scenarios = make_scenarios(server1, server2, formats)
 
328
        self.assertEqual([
 
329
            ('str,str,str',
 
330
             {'interrepo_class': str,
 
331
              'repository_format': 'C1',
 
332
              'repository_format_to': 'C2',
 
333
              'transport_readonly_server': 'b',
 
334
              'transport_server': 'a'}),
 
335
            ('int,str,str',
 
336
             {'interrepo_class': int,
 
337
              'repository_format': 'D1',
 
338
              'repository_format_to': 'D2',
 
339
              'transport_readonly_server': 'b',
 
340
              'transport_server': 'a'})],
 
341
            scenarios)
 
342
 
 
343
 
 
344
class TestWorkingTreeScenarios(TestCase):
 
345
 
 
346
    def test_scenarios(self):
 
347
        # check that constructor parameters are passed through to the adapted
 
348
        # test.
 
349
        from bzrlib.tests.workingtree_implementations \
 
350
            import make_scenarios
 
351
        server1 = "a"
 
352
        server2 = "b"
 
353
        formats = [workingtree.WorkingTreeFormat2(),
 
354
                   workingtree.WorkingTreeFormat3(),]
 
355
        scenarios = make_scenarios(server1, server2, formats)
 
356
        self.assertEqual([
 
357
            ('WorkingTreeFormat2',
 
358
             {'bzrdir_format': formats[0]._matchingbzrdir,
 
359
              'transport_readonly_server': 'b',
 
360
              'transport_server': 'a',
 
361
              'workingtree_format': formats[0]}),
 
362
            ('WorkingTreeFormat3',
 
363
             {'bzrdir_format': formats[1]._matchingbzrdir,
 
364
              'transport_readonly_server': 'b',
 
365
              'transport_server': 'a',
 
366
              'workingtree_format': formats[1]})],
 
367
            scenarios)
 
368
 
 
369
 
 
370
class TestTreeScenarios(TestCase):
 
371
 
 
372
    def test_scenarios(self):
 
373
        # the tree implementation scenario generator is meant to setup one
 
374
        # instance for each working tree format, and one additional instance
 
375
        # that will use the default wt format, but create a revision tree for
 
376
        # the tests.  this means that the wt ones should have the
 
377
        # workingtree_to_test_tree attribute set to 'return_parameter' and the
 
378
        # revision one set to revision_tree_from_workingtree.
356
379
 
357
380
        from bzrlib.tests.tree_implementations import (
358
 
            TreeTestProviderAdapter,
 
381
            _dirstate_tree_from_workingtree,
 
382
            make_scenarios,
 
383
            preview_tree_pre,
 
384
            preview_tree_post,
359
385
            return_parameter,
360
386
            revision_tree_from_workingtree
361
387
            )
362
 
        from bzrlib.workingtree import WorkingTreeFormat, WorkingTreeFormat3
363
 
        input_test = TestTreeProviderAdapter(
364
 
            "test_adapted_tests")
365
388
        server1 = "a"
366
389
        server2 = "b"
367
 
        formats = [("c", "C"), ("d", "D")]
368
 
        adapter = TreeTestProviderAdapter(server1, server2, formats)
369
 
        suite = adapter.adapt(input_test)
370
 
        tests = list(iter(suite))
371
 
        self.assertEqual(4, len(tests))
372
 
        # this must match the default format setp up in
373
 
        # TreeTestProviderAdapter.adapt
374
 
        default_format = WorkingTreeFormat3
375
 
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
376
 
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
377
 
        self.assertEqual(tests[0].transport_server, server1)
378
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
379
 
        self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
380
 
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
381
 
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
382
 
        self.assertEqual(tests[1].transport_server, server1)
383
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
384
 
        self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
385
 
        self.assertIsInstance(tests[2].workingtree_format, default_format)
386
 
        #self.assertEqual(tests[2].bzrdir_format,
387
 
        #                 default_format._matchingbzrdir)
388
 
        self.assertEqual(tests[2].transport_server, server1)
389
 
        self.assertEqual(tests[2].transport_readonly_server, server2)
390
 
        self.assertEqual(tests[2].workingtree_to_test_tree,
391
 
            revision_tree_from_workingtree)
392
 
 
393
 
 
394
 
class TestInterTreeProviderAdapter(TestCase):
 
390
        formats = [workingtree.WorkingTreeFormat2(),
 
391
                   workingtree.WorkingTreeFormat3(),]
 
392
        scenarios = make_scenarios(server1, server2, formats)
 
393
        self.assertEqual(7, len(scenarios))
 
394
        default_wt_format = workingtree.WorkingTreeFormat4._default_format
 
395
        wt4_format = workingtree.WorkingTreeFormat4()
 
396
        wt5_format = workingtree.WorkingTreeFormat5()
 
397
        expected_scenarios = [
 
398
            ('WorkingTreeFormat2',
 
399
             {'bzrdir_format': formats[0]._matchingbzrdir,
 
400
              'transport_readonly_server': 'b',
 
401
              'transport_server': 'a',
 
402
              'workingtree_format': formats[0],
 
403
              '_workingtree_to_test_tree': return_parameter,
 
404
              }),
 
405
            ('WorkingTreeFormat3',
 
406
             {'bzrdir_format': formats[1]._matchingbzrdir,
 
407
              'transport_readonly_server': 'b',
 
408
              'transport_server': 'a',
 
409
              'workingtree_format': formats[1],
 
410
              '_workingtree_to_test_tree': return_parameter,
 
411
             }),
 
412
            ('RevisionTree',
 
413
             {'_workingtree_to_test_tree': revision_tree_from_workingtree,
 
414
              'bzrdir_format': default_wt_format._matchingbzrdir,
 
415
              'transport_readonly_server': 'b',
 
416
              'transport_server': 'a',
 
417
              'workingtree_format': default_wt_format,
 
418
             }),
 
419
            ('DirStateRevisionTree,WT4',
 
420
             {'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
 
421
              'bzrdir_format': wt4_format._matchingbzrdir,
 
422
              'transport_readonly_server': 'b',
 
423
              'transport_server': 'a',
 
424
              'workingtree_format': wt4_format,
 
425
             }),
 
426
            ('DirStateRevisionTree,WT5',
 
427
             {'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
 
428
              'bzrdir_format': wt5_format._matchingbzrdir,
 
429
              'transport_readonly_server': 'b',
 
430
              'transport_server': 'a',
 
431
              'workingtree_format': wt5_format,
 
432
             }),
 
433
            ('PreviewTree',
 
434
             {'_workingtree_to_test_tree': preview_tree_pre,
 
435
              'bzrdir_format': default_wt_format._matchingbzrdir,
 
436
              'transport_readonly_server': 'b',
 
437
              'transport_server': 'a',
 
438
              'workingtree_format': default_wt_format}),
 
439
            ('PreviewTreePost',
 
440
             {'_workingtree_to_test_tree': preview_tree_post,
 
441
              'bzrdir_format': default_wt_format._matchingbzrdir,
 
442
              'transport_readonly_server': 'b',
 
443
              'transport_server': 'a',
 
444
              'workingtree_format': default_wt_format}),
 
445
             ]
 
446
        self.assertEqual(expected_scenarios, scenarios)
 
447
 
 
448
 
 
449
class TestInterTreeScenarios(TestCase):
395
450
    """A group of tests that test the InterTreeTestAdapter."""
396
451
 
397
 
    def test_adapted_tests(self):
 
452
    def test_scenarios(self):
398
453
        # check that constructor parameters are passed through to the adapted
399
454
        # test.
400
455
        # for InterTree tests we want the machinery to bring up two trees in
402
457
        # because each optimiser can be direction specific, we need to test
403
458
        # each optimiser in its chosen direction.
404
459
        # unlike the TestProviderAdapter we dont want to automatically add a
405
 
        # parameterised one for WorkingTree - the optimisers will tell us what
 
460
        # parameterized one for WorkingTree - the optimisers will tell us what
406
461
        # ones to add.
407
462
        from bzrlib.tests.tree_implementations import (
408
463
            return_parameter,
409
464
            revision_tree_from_workingtree
410
465
            )
411
466
        from bzrlib.tests.intertree_implementations import (
412
 
            InterTreeTestProviderAdapter,
 
467
            make_scenarios,
413
468
            )
414
469
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
415
 
        input_test = TestInterTreeProviderAdapter(
416
 
            "test_adapted_tests")
 
470
        input_test = TestInterTreeScenarios(
 
471
            "test_scenarios")
417
472
        server1 = "a"
418
473
        server2 = "b"
419
474
        format1 = WorkingTreeFormat2()
420
475
        format2 = WorkingTreeFormat3()
421
 
        formats = [(str, format1, format2, "converter1"),
422
 
            (int, format2, format1, "converter2")]
423
 
        adapter = InterTreeTestProviderAdapter(server1, server2, formats)
424
 
        suite = adapter.adapt(input_test)
425
 
        tests = list(iter(suite))
426
 
        self.assertEqual(2, len(tests))
427
 
        self.assertEqual(tests[0].intertree_class, formats[0][0])
428
 
        self.assertEqual(tests[0].workingtree_format, formats[0][1])
429
 
        self.assertEqual(tests[0].workingtree_format_to, formats[0][2])
430
 
        self.assertEqual(tests[0].mutable_trees_to_test_trees, formats[0][3])
431
 
        self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
432
 
        self.assertEqual(tests[0].transport_server, server1)
433
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
434
 
        self.assertEqual(tests[1].intertree_class, formats[1][0])
435
 
        self.assertEqual(tests[1].workingtree_format, formats[1][1])
436
 
        self.assertEqual(tests[1].workingtree_format_to, formats[1][2])
437
 
        self.assertEqual(tests[1].mutable_trees_to_test_trees, formats[1][3])
438
 
        self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
439
 
        self.assertEqual(tests[1].transport_server, server1)
440
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
476
        formats = [("1", str, format1, format2, "converter1"),
 
477
            ("2", int, format2, format1, "converter2")]
 
478
        scenarios = make_scenarios(server1, server2, formats)
 
479
        self.assertEqual(2, len(scenarios))
 
480
        expected_scenarios = [
 
481
            ("1", {
 
482
                "bzrdir_format": format1._matchingbzrdir,
 
483
                "intertree_class": formats[0][1],
 
484
                "workingtree_format": formats[0][2],
 
485
                "workingtree_format_to": formats[0][3],
 
486
                "mutable_trees_to_test_trees": formats[0][4],
 
487
                "_workingtree_to_test_tree": return_parameter,
 
488
                "transport_server": server1,
 
489
                "transport_readonly_server": server2,
 
490
                }),
 
491
            ("2", {
 
492
                "bzrdir_format": format2._matchingbzrdir,
 
493
                "intertree_class": formats[1][1],
 
494
                "workingtree_format": formats[1][2],
 
495
                "workingtree_format_to": formats[1][3],
 
496
                "mutable_trees_to_test_trees": formats[1][4],
 
497
                "_workingtree_to_test_tree": return_parameter,
 
498
                "transport_server": server1,
 
499
                "transport_readonly_server": server2,
 
500
                }),
 
501
            ]
 
502
        self.assertEqual(scenarios, expected_scenarios)
441
503
 
442
504
 
443
505
class TestTestCaseInTempDir(TestCaseInTempDir):
445
507
    def test_home_is_not_working(self):
446
508
        self.assertNotEqual(self.test_dir, self.test_home_dir)
447
509
        cwd = osutils.getcwd()
448
 
        self.assertEqual(self.test_dir, cwd)
449
 
        self.assertEqual(self.test_home_dir, os.environ['HOME'])
 
510
        self.assertIsSameRealPath(self.test_dir, cwd)
 
511
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
 
512
 
 
513
    def test_assertEqualStat_equal(self):
 
514
        from bzrlib.tests.test_dirstate import _FakeStat
 
515
        self.build_tree(["foo"])
 
516
        real = os.lstat("foo")
 
517
        fake = _FakeStat(real.st_size, real.st_mtime, real.st_ctime,
 
518
            real.st_dev, real.st_ino, real.st_mode)
 
519
        self.assertEqualStat(real, fake)
 
520
 
 
521
    def test_assertEqualStat_notequal(self):
 
522
        self.build_tree(["foo", "bar"])
 
523
        self.assertRaises(AssertionError, self.assertEqualStat,
 
524
            os.lstat("foo"), os.lstat("bar"))
450
525
 
451
526
 
452
527
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
455
530
        """The test_home_dir for TestCaseWithMemoryTransport is missing.
456
531
 
457
532
        This is because TestCaseWithMemoryTransport is for tests that do not
458
 
        need any disk resources: they should be hooked into bzrlib in such a 
459
 
        way that no global settings are being changed by the test (only a 
 
533
        need any disk resources: they should be hooked into bzrlib in such a
 
534
        way that no global settings are being changed by the test (only a
460
535
        few tests should need to do that), and having a missing dir as home is
461
536
        an effective way to ensure that this is the case.
462
537
        """
463
 
        self.assertEqual(self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
 
538
        self.assertIsSameRealPath(
 
539
            self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
464
540
            self.test_home_dir)
465
 
        self.assertEqual(self.test_home_dir, os.environ['HOME'])
466
 
        
 
541
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
 
542
 
467
543
    def test_cwd_is_TEST_ROOT(self):
468
 
        self.assertEqual(self.test_dir, self.TEST_ROOT)
 
544
        self.assertIsSameRealPath(self.test_dir, self.TEST_ROOT)
469
545
        cwd = osutils.getcwd()
470
 
        self.assertEqual(self.test_dir, cwd)
 
546
        self.assertIsSameRealPath(self.test_dir, cwd)
471
547
 
472
548
    def test_make_branch_and_memory_tree(self):
473
549
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
493
569
        self.assertEqual(format.repository_format.__class__,
494
570
            tree.branch.repository._format.__class__)
495
571
 
 
572
    def test_make_branch_builder(self):
 
573
        builder = self.make_branch_builder('dir')
 
574
        self.assertIsInstance(builder, branchbuilder.BranchBuilder)
 
575
        # Guard against regression into MemoryTransport leaking
 
576
        # files to disk instead of keeping them in memory.
 
577
        self.failIf(osutils.lexists('dir'))
 
578
 
 
579
    def test_make_branch_builder_with_format(self):
 
580
        # Use a repo layout that doesn't conform to a 'named' layout, to ensure
 
581
        # that the format objects are used.
 
582
        format = bzrdir.BzrDirMetaFormat1()
 
583
        repo_format = weaverepo.RepositoryFormat7()
 
584
        format.repository_format = repo_format
 
585
        builder = self.make_branch_builder('dir', format=format)
 
586
        the_branch = builder.get_branch()
 
587
        # Guard against regression into MemoryTransport leaking
 
588
        # files to disk instead of keeping them in memory.
 
589
        self.failIf(osutils.lexists('dir'))
 
590
        self.assertEqual(format.repository_format.__class__,
 
591
                         the_branch.repository._format.__class__)
 
592
        self.assertEqual(repo_format.get_format_string(),
 
593
                         self.get_transport().get_bytes(
 
594
                            'dir/.bzr/repository/format'))
 
595
 
 
596
    def test_make_branch_builder_with_format_name(self):
 
597
        builder = self.make_branch_builder('dir', format='knit')
 
598
        the_branch = builder.get_branch()
 
599
        # Guard against regression into MemoryTransport leaking
 
600
        # files to disk instead of keeping them in memory.
 
601
        self.failIf(osutils.lexists('dir'))
 
602
        dir_format = bzrdir.format_registry.make_bzrdir('knit')
 
603
        self.assertEqual(dir_format.repository_format.__class__,
 
604
                         the_branch.repository._format.__class__)
 
605
        self.assertEqual('Bazaar-NG Knit Repository Format 1',
 
606
                         self.get_transport().get_bytes(
 
607
                            'dir/.bzr/repository/format'))
 
608
 
 
609
    def test_safety_net(self):
 
610
        """No test should modify the safety .bzr directory.
 
611
 
 
612
        We just test that the _check_safety_net private method raises
 
613
        AssertionError, it's easier than building a test suite with the same
 
614
        test.
 
615
        """
 
616
        # Oops, a commit in the current directory (i.e. without local .bzr
 
617
        # directory) will crawl up the hierarchy to find a .bzr directory.
 
618
        self.run_bzr(['commit', '-mfoo', '--unchanged'])
 
619
        # But we have a safety net in place.
 
620
        self.assertRaises(AssertionError, self._check_safety_net)
 
621
 
496
622
 
497
623
class TestTestCaseWithTransport(TestCaseWithTransport):
498
624
    """Tests for the convenience functions TestCaseWithTransport introduces."""
514
640
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
515
641
 
516
642
    def test_get_readonly_url_http(self):
517
 
        from bzrlib.tests.HttpServer import HttpServer
 
643
        from bzrlib.tests.http_server import HttpServer
518
644
        from bzrlib.transport import get_transport
519
645
        from bzrlib.transport.local import LocalURLServer
520
646
        from bzrlib.transport.http import HttpTransportBase
538
664
        self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
539
665
        self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
540
666
 
 
667
    def test_make_branch_builder(self):
 
668
        builder = self.make_branch_builder('dir')
 
669
        rev_id = builder.build_commit()
 
670
        self.failUnlessExists('dir')
 
671
        a_dir = bzrdir.BzrDir.open('dir')
 
672
        self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
 
673
        a_branch = a_dir.open_branch()
 
674
        builder_branch = builder.get_branch()
 
675
        self.assertEqual(a_branch.base, builder_branch.base)
 
676
        self.assertEqual((1, rev_id), builder_branch.last_revision_info())
 
677
        self.assertEqual((1, rev_id), a_branch.last_revision_info())
 
678
 
541
679
 
542
680
class TestTestCaseTransports(TestCaseWithTransport):
543
681
 
548
686
    def test_make_bzrdir_preserves_transport(self):
549
687
        t = self.get_transport()
550
688
        result_bzrdir = self.make_bzrdir('subdir')
551
 
        self.assertIsInstance(result_bzrdir.transport, 
 
689
        self.assertIsInstance(result_bzrdir.transport,
552
690
                              MemoryTransport)
553
691
        # should not be on disk, should only be in memory
554
692
        self.failIfExists('subdir')
588
726
 
589
727
class TestTestResult(TestCase):
590
728
 
591
 
    def test_elapsed_time_with_benchmarking(self):
 
729
    def check_timing(self, test_case, expected_re):
592
730
        result = bzrlib.tests.TextTestResult(self._log_file,
593
 
                                        descriptions=0,
594
 
                                        verbosity=1,
595
 
                                        )
596
 
        result._recordTestStartTime()
597
 
        time.sleep(0.003)
598
 
        result.extractBenchmarkTime(self)
599
 
        timed_string = result._testTimeString()
600
 
        # without explicit benchmarking, we should get a simple time.
601
 
        self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms$")
 
731
                descriptions=0,
 
732
                verbosity=1,
 
733
                )
 
734
        test_case.run(result)
 
735
        timed_string = result._testTimeString(test_case)
 
736
        self.assertContainsRe(timed_string, expected_re)
 
737
 
 
738
    def test_test_reporting(self):
 
739
        class ShortDelayTestCase(TestCase):
 
740
            def test_short_delay(self):
 
741
                time.sleep(0.003)
 
742
            def test_short_benchmark(self):
 
743
                self.time(time.sleep, 0.003)
 
744
        self.check_timing(ShortDelayTestCase('test_short_delay'),
 
745
                          r"^ +[0-9]+ms$")
602
746
        # if a benchmark time is given, we want a x of y style result.
603
 
        self.time(time.sleep, 0.001)
604
 
        result.extractBenchmarkTime(self)
605
 
        timed_string = result._testTimeString()
606
 
        self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms/ *[ 1-9][0-9]ms$")
607
 
        # extracting the time from a non-bzrlib testcase sets to None
608
 
        result._recordTestStartTime()
609
 
        result.extractBenchmarkTime(
610
 
            unittest.FunctionTestCase(self.test_elapsed_time_with_benchmarking))
611
 
        timed_string = result._testTimeString()
612
 
        self.assertContainsRe(timed_string, "^ *[ 1-9][0-9]ms$")
613
 
        # cheat. Yes, wash thy mouth out with soap.
614
 
        self._benchtime = None
 
747
        self.check_timing(ShortDelayTestCase('test_short_benchmark'),
 
748
                          r"^ +[0-9]+ms/ +[0-9]+ms$")
 
749
 
 
750
    def test_unittest_reporting_unittest_class(self):
 
751
        # getting the time from a non-bzrlib test works ok
 
752
        class ShortDelayTestCase(unittest.TestCase):
 
753
            def test_short_delay(self):
 
754
                time.sleep(0.003)
 
755
        self.check_timing(ShortDelayTestCase('test_short_delay'),
 
756
                          r"^ +[0-9]+ms$")
615
757
 
616
758
    def test_assigned_benchmark_file_stores_date(self):
617
759
        output = StringIO()
621
763
                                        bench_history=output
622
764
                                        )
623
765
        output_string = output.getvalue()
624
 
        
625
766
        # if you are wondering about the regexp please read the comment in
626
767
        # test_bench_history (bzrlib.tests.test_selftest.TestRunner)
627
768
        # XXX: what comment?  -- Andrew Bennetts
646
787
        self.assertContainsRe(lines[1],
647
788
            " *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
648
789
            "._time_hello_world_encoding")
649
 
 
 
790
 
650
791
    def _time_hello_world_encoding(self):
651
792
        """Profile two sleep calls
652
 
        
 
793
 
653
794
        This is used to exercise the test framework.
654
795
        """
655
796
        self.time(unicode, 'hello', errors='replace')
657
798
 
658
799
    def test_lsprofiling(self):
659
800
        """Verbose test result prints lsprof statistics from test cases."""
660
 
        try:
661
 
            import bzrlib.lsprof
662
 
        except ImportError:
663
 
            raise TestSkipped("lsprof not installed.")
 
801
        self.requireFeature(test_lsprof.LSProfFeature)
664
802
        result_stream = StringIO()
665
803
        result = bzrlib.tests.VerboseTestResult(
666
804
            unittest._WritelnDecorator(result_stream),
676
814
        # execute the test, which should succeed and record profiles
677
815
        example_test_case.run(result)
678
816
        # lsprofile_something()
679
 
        # if this worked we want 
 
817
        # if this worked we want
680
818
        # LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
681
819
        #    CallCount    Recursive    Total(ms)   Inline(ms) module:lineno(function)
682
820
        # (the lsprof header)
683
821
        # ... an arbitrary number of lines
684
822
        # and the function call which is time.sleep.
685
 
        #           1        0            ???         ???       ???(sleep) 
 
823
        #           1        0            ???         ???       ???(sleep)
686
824
        # and then repeated but with 'world', rather than 'hello'.
687
825
        # this should appear in the output stream of our test result.
688
826
        output = result_stream.getvalue()
698
836
    def test_known_failure(self):
699
837
        """A KnownFailure being raised should trigger several result actions."""
700
838
        class InstrumentedTestResult(ExtendedTestResult):
701
 
 
 
839
            def done(self): pass
 
840
            def startTests(self): pass
702
841
            def report_test_start(self, test): pass
703
842
            def report_known_failure(self, test, err):
704
843
                self._call = test, err
729
868
            )
730
869
        test = self.get_passing_test()
731
870
        result.startTest(test)
732
 
        result.extractBenchmarkTime(test)
733
871
        prefix = len(result_stream.getvalue())
734
872
        # the err parameter has the shape:
735
873
        # (class, exception object, traceback)
739
877
        result.report_known_failure(test, err)
740
878
        output = result_stream.getvalue()[prefix:]
741
879
        lines = output.splitlines()
742
 
        self.assertEqual(lines, ['XFAIL                   0ms', '    foo'])
743
 
    
 
880
        self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
 
881
        self.assertEqual(lines[1], '    foo')
 
882
        self.assertEqual(2, len(lines))
 
883
 
744
884
    def test_text_report_known_failure(self):
745
885
        # text test output formatting
746
886
        pb = MockProgress()
747
887
        result = bzrlib.tests.TextTestResult(
748
 
            None,
 
888
            StringIO(),
749
889
            descriptions=0,
750
890
            verbosity=1,
751
891
            pb=pb,
753
893
        test = self.get_passing_test()
754
894
        # this seeds the state to handle reporting the test.
755
895
        result.startTest(test)
756
 
        result.extractBenchmarkTime(test)
757
896
        # the err parameter has the shape:
758
897
        # (class, exception object, traceback)
759
898
        # KnownFailures dont get their tracebacks shown though, so we
773
912
        test.run(result)
774
913
        self.assertEqual(
775
914
            [
776
 
            ('update', '[2 in 0s, 3 known failures] passing_test', None, None),
 
915
            ('update', '[2 in 0s] passing_test', None, None),
777
916
            ],
778
917
            pb.calls[2:])
779
918
 
786
925
    def test_add_not_supported(self):
787
926
        """Test the behaviour of invoking addNotSupported."""
788
927
        class InstrumentedTestResult(ExtendedTestResult):
 
928
            def done(self): pass
 
929
            def startTests(self): pass
789
930
            def report_test_start(self, test): pass
790
931
            def report_unsupported(self, test, feature):
791
932
                self._call = test, feature
818
959
        test = self.get_passing_test()
819
960
        feature = Feature()
820
961
        result.startTest(test)
821
 
        result.extractBenchmarkTime(test)
822
962
        prefix = len(result_stream.getvalue())
823
963
        result.report_unsupported(test, feature)
824
964
        output = result_stream.getvalue()[prefix:]
825
965
        lines = output.splitlines()
826
966
        self.assertEqual(lines, ['NODEP                   0ms', "    The feature 'Feature' is not available."])
827
 
    
 
967
 
828
968
    def test_text_report_unsupported(self):
829
969
        # text test output formatting
830
970
        pb = MockProgress()
831
971
        result = bzrlib.tests.TextTestResult(
832
 
            None,
 
972
            StringIO(),
833
973
            descriptions=0,
834
974
            verbosity=1,
835
975
            pb=pb,
838
978
        feature = Feature()
839
979
        # this seeds the state to handle reporting the test.
840
980
        result.startTest(test)
841
 
        result.extractBenchmarkTime(test)
842
981
        result.report_unsupported(test, feature)
843
982
        # no output on unsupported features
844
983
        self.assertEqual(
851
990
        test.run(result)
852
991
        self.assertEqual(
853
992
            [
854
 
            ('update', '[2 in 0s, 2 missing features] passing_test', None, None),
 
993
            ('update', '[2 in 0s, 2 missing] passing_test', None, None),
855
994
            ],
856
995
            pb.calls[1:])
857
 
    
 
996
 
858
997
    def test_unavailable_exception(self):
859
998
        """An UnavailableFeature being raised should invoke addNotSupported."""
860
999
        class InstrumentedTestResult(ExtendedTestResult):
861
 
 
 
1000
            def done(self): pass
 
1001
            def startTests(self): pass
862
1002
            def report_test_start(self, test): pass
863
1003
            def addNotSupported(self, test, feature):
864
1004
                self._call = test, feature
875
1015
        # and not count as an error
876
1016
        self.assertEqual(0, result.error_count)
877
1017
 
 
1018
    def test_strict_with_unsupported_feature(self):
 
1019
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
1020
                                             verbosity=1)
 
1021
        test = self.get_passing_test()
 
1022
        feature = "Unsupported Feature"
 
1023
        result.addNotSupported(test, feature)
 
1024
        self.assertFalse(result.wasStrictlySuccessful())
 
1025
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
1026
 
 
1027
    def test_strict_with_known_failure(self):
 
1028
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
1029
                                             verbosity=1)
 
1030
        test = self.get_passing_test()
 
1031
        err = (KnownFailure, KnownFailure('foo'), None)
 
1032
        result._addKnownFailure(test, err)
 
1033
        self.assertFalse(result.wasStrictlySuccessful())
 
1034
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
1035
 
 
1036
    def test_strict_with_success(self):
 
1037
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
1038
                                             verbosity=1)
 
1039
        test = self.get_passing_test()
 
1040
        result.addSuccess(test)
 
1041
        self.assertTrue(result.wasStrictlySuccessful())
 
1042
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
1043
 
 
1044
    def test_startTests(self):
 
1045
        """Starting the first test should trigger startTests."""
 
1046
        class InstrumentedTestResult(ExtendedTestResult):
 
1047
            calls = 0
 
1048
            def startTests(self): self.calls += 1
 
1049
            def report_test_start(self, test): pass
 
1050
        result = InstrumentedTestResult(None, None, None, None)
 
1051
        def test_function():
 
1052
            pass
 
1053
        test = unittest.FunctionTestCase(test_function)
 
1054
        test.run(result)
 
1055
        self.assertEquals(1, result.calls)
 
1056
 
 
1057
 
 
1058
class TestUnicodeFilenameFeature(TestCase):
 
1059
 
 
1060
    def test_probe_passes(self):
 
1061
        """UnicodeFilenameFeature._probe passes."""
 
1062
        # We can't test much more than that because the behaviour depends
 
1063
        # on the platform.
 
1064
        tests.UnicodeFilenameFeature._probe()
 
1065
 
878
1066
 
879
1067
class TestRunner(TestCase):
880
1068
 
886
1074
 
887
1075
        This current saves and restores:
888
1076
        TestCaseInTempDir.TEST_ROOT
889
 
        
 
1077
 
890
1078
        There should be no tests in this file that use bzrlib.tests.TextTestRunner
891
1079
        without using this convenience method, because of our use of global state.
892
1080
        """
923
1111
            '----------------------------------------------------------------------',
924
1112
            '',
925
1113
            'FAILED (failures=1, known_failure_count=1)'],
926
 
            lines[0:5] + lines[6:10] + lines[11:])
 
1114
            lines[3:8] + lines[9:13] + lines[14:])
927
1115
 
928
1116
    def test_known_failure_ok_run(self):
929
1117
        # run a test that generates a known failure which should be printed in the final output.
933
1121
        stream = StringIO()
934
1122
        runner = TextTestRunner(stream=stream)
935
1123
        result = self.run_test_runner(runner, test)
936
 
        self.assertEqual(
937
 
            '\n'
938
 
            '----------------------------------------------------------------------\n'
939
 
            'Ran 1 test in 0.000s\n'
940
 
            '\n'
941
 
            'OK (known_failures=1)\n',
942
 
            stream.getvalue())
 
1124
        self.assertContainsRe(stream.getvalue(),
 
1125
            '\n'
 
1126
            '-*\n'
 
1127
            'Ran 1 test in .*\n'
 
1128
            '\n'
 
1129
            'OK \\(known_failures=1\\)\n')
943
1130
 
944
1131
    def test_skipped_test(self):
945
1132
        # run a test that is skipped, and check the suite as a whole still
946
1133
        # succeeds.
947
1134
        # skipping_test must be hidden in here so it's not run as a real test
948
 
        def skipping_test():
949
 
            raise TestSkipped('test intentionally skipped')
950
 
 
951
 
        runner = TextTestRunner(stream=self._log_file, keep_output=True)
952
 
        test = unittest.FunctionTestCase(skipping_test)
 
1135
        class SkippingTest(TestCase):
 
1136
            def skipping_test(self):
 
1137
                raise TestSkipped('test intentionally skipped')
 
1138
        runner = TextTestRunner(stream=self._log_file)
 
1139
        test = SkippingTest("skipping_test")
953
1140
        result = self.run_test_runner(runner, test)
954
1141
        self.assertTrue(result.wasSuccessful())
955
1142
 
956
1143
    def test_skipped_from_setup(self):
 
1144
        calls = []
957
1145
        class SkippedSetupTest(TestCase):
958
1146
 
959
1147
            def setUp(self):
960
 
                self.counter = 1
 
1148
                calls.append('setUp')
961
1149
                self.addCleanup(self.cleanup)
962
1150
                raise TestSkipped('skipped setup')
963
1151
 
965
1153
                self.fail('test reached')
966
1154
 
967
1155
            def cleanup(self):
968
 
                self.counter -= 1
 
1156
                calls.append('cleanup')
969
1157
 
970
 
        runner = TextTestRunner(stream=self._log_file, keep_output=True)
 
1158
        runner = TextTestRunner(stream=self._log_file)
971
1159
        test = SkippedSetupTest('test_skip')
972
1160
        result = self.run_test_runner(runner, test)
973
1161
        self.assertTrue(result.wasSuccessful())
974
1162
        # Check if cleanup was called the right number of times.
975
 
        self.assertEqual(0, test.counter)
 
1163
        self.assertEqual(['setUp', 'cleanup'], calls)
976
1164
 
977
1165
    def test_skipped_from_test(self):
 
1166
        calls = []
978
1167
        class SkippedTest(TestCase):
979
1168
 
980
1169
            def setUp(self):
981
 
                self.counter = 1
 
1170
                TestCase.setUp(self)
 
1171
                calls.append('setUp')
982
1172
                self.addCleanup(self.cleanup)
983
1173
 
984
1174
            def test_skip(self):
985
1175
                raise TestSkipped('skipped test')
986
1176
 
987
1177
            def cleanup(self):
988
 
                self.counter -= 1
 
1178
                calls.append('cleanup')
989
1179
 
990
 
        runner = TextTestRunner(stream=self._log_file, keep_output=True)
 
1180
        runner = TextTestRunner(stream=self._log_file)
991
1181
        test = SkippedTest('test_skip')
992
1182
        result = self.run_test_runner(runner, test)
993
1183
        self.assertTrue(result.wasSuccessful())
994
1184
        # Check if cleanup was called the right number of times.
995
 
        self.assertEqual(0, test.counter)
 
1185
        self.assertEqual(['setUp', 'cleanup'], calls)
 
1186
 
 
1187
    def test_not_applicable(self):
 
1188
        # run a test that is skipped because it's not applicable
 
1189
        def not_applicable_test():
 
1190
            from bzrlib.tests import TestNotApplicable
 
1191
            raise TestNotApplicable('this test never runs')
 
1192
        out = StringIO()
 
1193
        runner = TextTestRunner(stream=out, verbosity=2)
 
1194
        test = unittest.FunctionTestCase(not_applicable_test)
 
1195
        result = self.run_test_runner(runner, test)
 
1196
        self._log_file.write(out.getvalue())
 
1197
        self.assertTrue(result.wasSuccessful())
 
1198
        self.assertTrue(result.wasStrictlySuccessful())
 
1199
        self.assertContainsRe(out.getvalue(),
 
1200
                r'(?m)not_applicable_test   * N/A')
 
1201
        self.assertContainsRe(out.getvalue(),
 
1202
                r'(?m)^    this test never runs')
 
1203
 
 
1204
    def test_not_applicable_demo(self):
 
1205
        # just so you can see it in the test output
 
1206
        raise TestNotApplicable('this test is just a demonstation')
996
1207
 
997
1208
    def test_unsupported_features_listed(self):
998
1209
        """When unsupported features are encountered they are detailed."""
1034
1245
            revision_id = workingtree.get_parent_ids()[0]
1035
1246
            self.assertEndsWith(output_string.rstrip(), revision_id)
1036
1247
 
 
1248
    def assertLogDeleted(self, test):
 
1249
        log = test._get_log()
 
1250
        self.assertEqual("DELETED log file to reduce memory footprint", log)
 
1251
        self.assertEqual('', test._log_contents)
 
1252
        self.assertIs(None, test._log_file_name)
 
1253
 
1037
1254
    def test_success_log_deleted(self):
1038
1255
        """Successful tests have their log deleted"""
1039
1256
 
1047
1264
        test = LogTester('test_success')
1048
1265
        result = self.run_test_runner(runner, test)
1049
1266
 
1050
 
        log = test._get_log()
1051
 
        self.assertEqual("DELETED log file to reduce memory footprint", log)
1052
 
        self.assertEqual('', test._log_contents)
1053
 
        self.assertIs(None, test._log_file_name)
 
1267
        self.assertLogDeleted(test)
 
1268
 
 
1269
    def test_skipped_log_deleted(self):
 
1270
        """Skipped tests have their log deleted"""
 
1271
 
 
1272
        class LogTester(TestCase):
 
1273
 
 
1274
            def test_skipped(self):
 
1275
                self.log('this will be removed\n')
 
1276
                raise tests.TestSkipped()
 
1277
 
 
1278
        sio = cStringIO.StringIO()
 
1279
        runner = TextTestRunner(stream=sio)
 
1280
        test = LogTester('test_skipped')
 
1281
        result = self.run_test_runner(runner, test)
 
1282
 
 
1283
        self.assertLogDeleted(test)
 
1284
 
 
1285
    def test_not_aplicable_log_deleted(self):
 
1286
        """Not applicable tests have their log deleted"""
 
1287
 
 
1288
        class LogTester(TestCase):
 
1289
 
 
1290
            def test_not_applicable(self):
 
1291
                self.log('this will be removed\n')
 
1292
                raise tests.TestNotApplicable()
 
1293
 
 
1294
        sio = cStringIO.StringIO()
 
1295
        runner = TextTestRunner(stream=sio)
 
1296
        test = LogTester('test_not_applicable')
 
1297
        result = self.run_test_runner(runner, test)
 
1298
 
 
1299
        self.assertLogDeleted(test)
 
1300
 
 
1301
    def test_known_failure_log_deleted(self):
 
1302
        """Know failure tests have their log deleted"""
 
1303
 
 
1304
        class LogTester(TestCase):
 
1305
 
 
1306
            def test_known_failure(self):
 
1307
                self.log('this will be removed\n')
 
1308
                raise tests.KnownFailure()
 
1309
 
 
1310
        sio = cStringIO.StringIO()
 
1311
        runner = TextTestRunner(stream=sio)
 
1312
        test = LogTester('test_known_failure')
 
1313
        result = self.run_test_runner(runner, test)
 
1314
 
 
1315
        self.assertLogDeleted(test)
1054
1316
 
1055
1317
    def test_fail_log_kept(self):
1056
1318
        """Failed tests have their log kept"""
1102
1364
    def _test_pass(self):
1103
1365
        pass
1104
1366
 
 
1367
class _TestException(Exception):
 
1368
    pass
1105
1369
 
1106
1370
class TestTestCase(TestCase):
1107
1371
    """Tests that test the core bzrlib TestCase."""
1108
1372
 
 
1373
    def test_assertLength_matches_empty(self):
 
1374
        a_list = []
 
1375
        self.assertLength(0, a_list)
 
1376
 
 
1377
    def test_assertLength_matches_nonempty(self):
 
1378
        a_list = [1, 2, 3]
 
1379
        self.assertLength(3, a_list)
 
1380
 
 
1381
    def test_assertLength_fails_different(self):
 
1382
        a_list = []
 
1383
        self.assertRaises(AssertionError, self.assertLength, 1, a_list)
 
1384
 
 
1385
    def test_assertLength_shows_sequence_in_failure(self):
 
1386
        a_list = [1, 2, 3]
 
1387
        exception = self.assertRaises(AssertionError, self.assertLength, 2,
 
1388
            a_list)
 
1389
        self.assertEqual('Incorrect length: wanted 2, got 3 for [1, 2, 3]',
 
1390
            exception.args[0])
 
1391
 
 
1392
    def test_base_setUp_not_called_causes_failure(self):
 
1393
        class TestCaseWithBrokenSetUp(TestCase):
 
1394
            def setUp(self):
 
1395
                pass # does not call TestCase.setUp
 
1396
            def test_foo(self):
 
1397
                pass
 
1398
        test = TestCaseWithBrokenSetUp('test_foo')
 
1399
        result = unittest.TestResult()
 
1400
        test.run(result)
 
1401
        self.assertFalse(result.wasSuccessful())
 
1402
        self.assertEqual(1, result.testsRun)
 
1403
 
 
1404
    def test_base_tearDown_not_called_causes_failure(self):
 
1405
        class TestCaseWithBrokenTearDown(TestCase):
 
1406
            def tearDown(self):
 
1407
                pass # does not call TestCase.tearDown
 
1408
            def test_foo(self):
 
1409
                pass
 
1410
        test = TestCaseWithBrokenTearDown('test_foo')
 
1411
        result = unittest.TestResult()
 
1412
        test.run(result)
 
1413
        self.assertFalse(result.wasSuccessful())
 
1414
        self.assertEqual(1, result.testsRun)
 
1415
 
 
1416
    def test_debug_flags_sanitised(self):
 
1417
        """The bzrlib debug flags should be sanitised by setUp."""
 
1418
        if 'allow_debug' in tests.selftest_debug_flags:
 
1419
            raise TestNotApplicable(
 
1420
                '-Eallow_debug option prevents debug flag sanitisation')
 
1421
        # we could set something and run a test that will check
 
1422
        # it gets santised, but this is probably sufficient for now:
 
1423
        # if someone runs the test with -Dsomething it will error.
 
1424
        self.assertEqual(set(), bzrlib.debug.debug_flags)
 
1425
 
 
1426
    def change_selftest_debug_flags(self, new_flags):
 
1427
        orig_selftest_flags = tests.selftest_debug_flags
 
1428
        self.addCleanup(self._restore_selftest_debug_flags, orig_selftest_flags)
 
1429
        tests.selftest_debug_flags = set(new_flags)
 
1430
 
 
1431
    def _restore_selftest_debug_flags(self, flags):
 
1432
        tests.selftest_debug_flags = flags
 
1433
 
 
1434
    def test_allow_debug_flag(self):
 
1435
        """The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
 
1436
        sanitised (i.e. cleared) before running a test.
 
1437
        """
 
1438
        self.change_selftest_debug_flags(set(['allow_debug']))
 
1439
        bzrlib.debug.debug_flags = set(['a-flag'])
 
1440
        class TestThatRecordsFlags(TestCase):
 
1441
            def test_foo(nested_self):
 
1442
                self.flags = set(bzrlib.debug.debug_flags)
 
1443
        test = TestThatRecordsFlags('test_foo')
 
1444
        test.run(self.make_test_result())
 
1445
        self.assertEqual(set(['a-flag']), self.flags)
 
1446
 
 
1447
    def test_debug_flags_restored(self):
 
1448
        """The bzrlib debug flags should be restored to their original state
 
1449
        after the test was run, even if allow_debug is set.
 
1450
        """
 
1451
        self.change_selftest_debug_flags(set(['allow_debug']))
 
1452
        # Now run a test that modifies debug.debug_flags.
 
1453
        bzrlib.debug.debug_flags = set(['original-state'])
 
1454
        class TestThatModifiesFlags(TestCase):
 
1455
            def test_foo(self):
 
1456
                bzrlib.debug.debug_flags = set(['modified'])
 
1457
        test = TestThatModifiesFlags('test_foo')
 
1458
        test.run(self.make_test_result())
 
1459
        self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
 
1460
 
 
1461
    def make_test_result(self):
 
1462
        return bzrlib.tests.TextTestResult(
 
1463
            self._log_file, descriptions=0, verbosity=1)
 
1464
 
1109
1465
    def inner_test(self):
1110
1466
        # the inner child test
1111
1467
        note("inner_test")
1114
1470
        # the outer child test
1115
1471
        note("outer_start")
1116
1472
        self.inner_test = TestTestCase("inner_child")
1117
 
        result = bzrlib.tests.TextTestResult(self._log_file,
1118
 
                                        descriptions=0,
1119
 
                                        verbosity=1)
 
1473
        result = self.make_test_result()
1120
1474
        self.inner_test.run(result)
1121
1475
        note("outer finish")
1122
1476
 
1126
1480
        # should setup a new log, log content to it, setup a child case (B),
1127
1481
        # which should log independently, then case (A) should log a trailer
1128
1482
        # and return.
1129
 
        # we do two nested children so that we can verify the state of the 
 
1483
        # we do two nested children so that we can verify the state of the
1130
1484
        # logs after the outer child finishes is correct, which a bad clean
1131
1485
        # up routine in tearDown might trigger a fault in our test with only
1132
1486
        # one child, we should instead see the bad result inside our test with
1134
1488
        # the outer child test
1135
1489
        original_trace = bzrlib.trace._trace_file
1136
1490
        outer_test = TestTestCase("outer_child")
1137
 
        result = bzrlib.tests.TextTestResult(self._log_file,
1138
 
                                        descriptions=0,
1139
 
                                        verbosity=1)
 
1491
        result = self.make_test_result()
1140
1492
        outer_test.run(result)
1141
1493
        self.assertEqual(original_trace, bzrlib.trace._trace_file)
1142
1494
 
1161
1513
 
1162
1514
    def test_hooks_sanitised(self):
1163
1515
        """The bzrlib hooks should be sanitised by setUp."""
 
1516
        # Note this test won't fail with hooks that the core library doesn't
 
1517
        # use - but it trigger with a plugin that adds hooks, so its still a
 
1518
        # useful warning in that case.
1164
1519
        self.assertEqual(bzrlib.branch.BranchHooks(),
1165
1520
            bzrlib.branch.Branch.hooks)
1166
1521
        self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
1167
1522
            bzrlib.smart.server.SmartTCPServer.hooks)
 
1523
        self.assertEqual(bzrlib.commands.CommandHooks(),
 
1524
            bzrlib.commands.Command.hooks)
1168
1525
 
1169
1526
    def test__gather_lsprof_in_benchmarks(self):
1170
1527
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1171
 
        
 
1528
 
1172
1529
        Each self.time() call is individually and separately profiled.
1173
1530
        """
1174
 
        try:
1175
 
            import bzrlib.lsprof
1176
 
        except ImportError:
1177
 
            raise TestSkipped("lsprof not installed.")
1178
 
        # overrides the class member with an instance member so no cleanup 
 
1531
        self.requireFeature(test_lsprof.LSProfFeature)
 
1532
        # overrides the class member with an instance member so no cleanup
1179
1533
        # needed.
1180
1534
        self._gather_lsprof_in_benchmarks = True
1181
1535
        self.time(time.sleep, 0.000)
1207
1561
    def test_run_no_parameters(self):
1208
1562
        test = SampleTestCase('_test_pass')
1209
1563
        test.run()
1210
 
    
 
1564
 
1211
1565
    def test_run_enabled_unittest_result(self):
1212
1566
        """Test we revert to regular behaviour when the test is enabled."""
1213
1567
        test = SampleTestCase('_test_pass')
1261
1615
            ],
1262
1616
            result.calls)
1263
1617
 
1264
 
 
1265
 
@symbol_versioning.deprecated_function(zero_eleven)
 
1618
    def test_assert_list_raises_on_generator(self):
 
1619
        def generator_which_will_raise():
 
1620
            # This will not raise until after the first yield
 
1621
            yield 1
 
1622
            raise _TestException()
 
1623
 
 
1624
        e = self.assertListRaises(_TestException, generator_which_will_raise)
 
1625
        self.assertIsInstance(e, _TestException)
 
1626
 
 
1627
        e = self.assertListRaises(Exception, generator_which_will_raise)
 
1628
        self.assertIsInstance(e, _TestException)
 
1629
 
 
1630
    def test_assert_list_raises_on_plain(self):
 
1631
        def plain_exception():
 
1632
            raise _TestException()
 
1633
            return []
 
1634
 
 
1635
        e = self.assertListRaises(_TestException, plain_exception)
 
1636
        self.assertIsInstance(e, _TestException)
 
1637
 
 
1638
        e = self.assertListRaises(Exception, plain_exception)
 
1639
        self.assertIsInstance(e, _TestException)
 
1640
 
 
1641
    def test_assert_list_raises_assert_wrong_exception(self):
 
1642
        class _NotTestException(Exception):
 
1643
            pass
 
1644
 
 
1645
        def wrong_exception():
 
1646
            raise _NotTestException()
 
1647
 
 
1648
        def wrong_exception_generator():
 
1649
            yield 1
 
1650
            yield 2
 
1651
            raise _NotTestException()
 
1652
 
 
1653
        # Wrong exceptions are not intercepted
 
1654
        self.assertRaises(_NotTestException,
 
1655
            self.assertListRaises, _TestException, wrong_exception)
 
1656
        self.assertRaises(_NotTestException,
 
1657
            self.assertListRaises, _TestException, wrong_exception_generator)
 
1658
 
 
1659
    def test_assert_list_raises_no_exception(self):
 
1660
        def success():
 
1661
            return []
 
1662
 
 
1663
        def success_generator():
 
1664
            yield 1
 
1665
            yield 2
 
1666
 
 
1667
        self.assertRaises(AssertionError,
 
1668
            self.assertListRaises, _TestException, success)
 
1669
 
 
1670
        self.assertRaises(AssertionError,
 
1671
            self.assertListRaises, _TestException, success_generator)
 
1672
 
 
1673
 
 
1674
# NB: Don't delete this; it's not actually from 0.11!
 
1675
@deprecated_function(deprecated_in((0, 11, 0)))
1266
1676
def sample_deprecated_function():
1267
1677
    """A deprecated function to test applyDeprecated with."""
1268
1678
    return 2
1275
1685
class ApplyDeprecatedHelper(object):
1276
1686
    """A helper class for ApplyDeprecated tests."""
1277
1687
 
1278
 
    @symbol_versioning.deprecated_method(zero_eleven)
 
1688
    @deprecated_method(deprecated_in((0, 11, 0)))
1279
1689
    def sample_deprecated_method(self, param_one):
1280
1690
        """A deprecated method for testing with."""
1281
1691
        return param_one
1283
1693
    def sample_normal_method(self):
1284
1694
        """A undeprecated method."""
1285
1695
 
1286
 
    @symbol_versioning.deprecated_method(zero_ten)
 
1696
    @deprecated_method(deprecated_in((0, 10, 0)))
1287
1697
    def sample_nested_deprecation(self):
1288
1698
        return sample_deprecated_function()
1289
1699
 
1304
1714
    def test_applyDeprecated_not_deprecated(self):
1305
1715
        sample_object = ApplyDeprecatedHelper()
1306
1716
        # calling an undeprecated callable raises an assertion
1307
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
 
1717
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1718
            deprecated_in((0, 11, 0)),
1308
1719
            sample_object.sample_normal_method)
1309
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
 
1720
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1721
            deprecated_in((0, 11, 0)),
1310
1722
            sample_undeprecated_function, "a param value")
1311
1723
        # calling a deprecated callable (function or method) with the wrong
1312
1724
        # expected deprecation fails.
1313
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
 
1725
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1726
            deprecated_in((0, 10, 0)),
1314
1727
            sample_object.sample_deprecated_method, "a param value")
1315
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
 
1728
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1729
            deprecated_in((0, 10, 0)),
1316
1730
            sample_deprecated_function)
1317
1731
        # calling a deprecated callable (function or method) with the right
1318
1732
        # expected deprecation returns the functions result.
1319
 
        self.assertEqual("a param value", self.applyDeprecated(zero_eleven,
 
1733
        self.assertEqual("a param value",
 
1734
            self.applyDeprecated(deprecated_in((0, 11, 0)),
1320
1735
            sample_object.sample_deprecated_method, "a param value"))
1321
 
        self.assertEqual(2, self.applyDeprecated(zero_eleven,
 
1736
        self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 11, 0)),
1322
1737
            sample_deprecated_function))
1323
1738
        # calling a nested deprecation with the wrong deprecation version
1324
 
        # fails even if a deeper nested function was deprecated with the 
 
1739
        # fails even if a deeper nested function was deprecated with the
1325
1740
        # supplied version.
1326
1741
        self.assertRaises(AssertionError, self.applyDeprecated,
1327
 
            zero_eleven, sample_object.sample_nested_deprecation)
 
1742
            deprecated_in((0, 11, 0)), sample_object.sample_nested_deprecation)
1328
1743
        # calling a nested deprecation with the right deprecation value
1329
1744
        # returns the calls result.
1330
 
        self.assertEqual(2, self.applyDeprecated(zero_ten,
 
1745
        self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 10, 0)),
1331
1746
            sample_object.sample_nested_deprecation))
1332
1747
 
1333
1748
    def test_callDeprecated(self):
1334
1749
        def testfunc(be_deprecated, result=None):
1335
1750
            if be_deprecated is True:
1336
 
                symbol_versioning.warn('i am deprecated', DeprecationWarning, 
 
1751
                symbol_versioning.warn('i am deprecated', DeprecationWarning,
1337
1752
                                       stacklevel=1)
1338
1753
            return result
1339
1754
        result = self.callDeprecated(['i am deprecated'], testfunc, True)
1344
1759
        self.callDeprecated([], testfunc, be_deprecated=False)
1345
1760
 
1346
1761
 
 
1762
class TestWarningTests(TestCase):
 
1763
    """Tests for calling methods that raise warnings."""
 
1764
 
 
1765
    def test_callCatchWarnings(self):
 
1766
        def meth(a, b):
 
1767
            warnings.warn("this is your last warning")
 
1768
            return a + b
 
1769
        wlist, result = self.callCatchWarnings(meth, 1, 2)
 
1770
        self.assertEquals(3, result)
 
1771
        # would like just to compare them, but UserWarning doesn't implement
 
1772
        # eq well
 
1773
        w0, = wlist
 
1774
        self.assertIsInstance(w0, UserWarning)
 
1775
        self.assertEquals("this is your last warning", str(w0))
 
1776
 
 
1777
 
1347
1778
class TestConvenienceMakers(TestCaseWithTransport):
1348
1779
    """Test for the make_* convenience functions."""
1349
1780
 
1388
1819
            return TestSuite()
1389
1820
        out = StringIO()
1390
1821
        err = StringIO()
1391
 
        self.apply_redirected(out, err, None, bzrlib.tests.selftest, 
 
1822
        self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1392
1823
            test_suite_factory=factory)
1393
1824
        self.assertEqual([True], factory_called)
1394
1825
 
1395
1826
 
1396
 
class TestSelftestCleanOutput(TestCaseInTempDir):
1397
 
 
1398
 
    def test_clean_output(self):
1399
 
        # test functionality of clean_selftest_output()
1400
 
        self.build_tree(['test0000.tmp/', 'test0001.tmp/',
1401
 
                         'bzrlib/', 'tests/',
1402
 
                         'bzr', 'setup.py', 'test9999.tmp'])
1403
 
 
1404
 
        root = os.getcwdu()
1405
 
        before = os.listdir(root)
1406
 
        before.sort()
1407
 
        self.assertEquals(['bzr','bzrlib','setup.py',
1408
 
                           'test0000.tmp','test0001.tmp',
1409
 
                           'test9999.tmp','tests'],
1410
 
                           before)
1411
 
        clean_selftest_output(root, quiet=True)
1412
 
        after = os.listdir(root)
1413
 
        after.sort()
1414
 
        self.assertEquals(['bzr','bzrlib','setup.py',
1415
 
                           'test9999.tmp','tests'],
1416
 
                           after)
1417
 
 
1418
 
    def test_clean_readonly(self):
1419
 
        # test for delete read-only files
1420
 
        self.build_tree(['test0000.tmp/', 'test0000.tmp/foo'])
1421
 
        osutils.make_readonly('test0000.tmp/foo')
1422
 
        root = os.getcwdu()
1423
 
        before = os.listdir(root);  before.sort()
1424
 
        self.assertEquals(['test0000.tmp'], before)
1425
 
        clean_selftest_output(root, quiet=True)
1426
 
        after = os.listdir(root);   after.sort()
1427
 
        self.assertEquals([], after)
1428
 
 
1429
 
 
1430
1827
class TestKnownFailure(TestCase):
1431
1828
 
1432
1829
    def test_known_failure(self):
1488
1885
        feature = Feature()
1489
1886
        exception = UnavailableFeature(feature)
1490
1887
        self.assertIs(feature, exception.args[0])
 
1888
 
 
1889
 
 
1890
class TestSelftestFiltering(TestCase):
 
1891
 
 
1892
    def setUp(self):
 
1893
        TestCase.setUp(self)
 
1894
        self.suite = TestUtil.TestSuite()
 
1895
        self.loader = TestUtil.TestLoader()
 
1896
        self.suite.addTest(self.loader.loadTestsFromModuleNames([
 
1897
            'bzrlib.tests.test_selftest']))
 
1898
        self.all_names = _test_ids(self.suite)
 
1899
 
 
1900
    def test_condition_id_re(self):
 
1901
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1902
            'test_condition_id_re')
 
1903
        filtered_suite = filter_suite_by_condition(self.suite,
 
1904
            condition_id_re('test_condition_id_re'))
 
1905
        self.assertEqual([test_name], _test_ids(filtered_suite))
 
1906
 
 
1907
    def test_condition_id_in_list(self):
 
1908
        test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1909
                      'test_condition_id_in_list']
 
1910
        id_list = tests.TestIdList(test_names)
 
1911
        filtered_suite = filter_suite_by_condition(
 
1912
            self.suite, tests.condition_id_in_list(id_list))
 
1913
        my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
 
1914
        re_filtered = filter_suite_by_re(self.suite, my_pattern)
 
1915
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
 
1916
 
 
1917
    def test_condition_id_startswith(self):
 
1918
        klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1919
        start1 = klass + 'test_condition_id_starts'
 
1920
        start2 = klass + 'test_condition_id_in'
 
1921
        test_names = [ klass + 'test_condition_id_in_list',
 
1922
                      klass + 'test_condition_id_startswith',
 
1923
                     ]
 
1924
        filtered_suite = filter_suite_by_condition(
 
1925
            self.suite, tests.condition_id_startswith([start1, start2]))
 
1926
        self.assertEqual(test_names, _test_ids(filtered_suite))
 
1927
 
 
1928
    def test_condition_isinstance(self):
 
1929
        filtered_suite = filter_suite_by_condition(self.suite,
 
1930
            condition_isinstance(self.__class__))
 
1931
        class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1932
        re_filtered = filter_suite_by_re(self.suite, class_pattern)
 
1933
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
 
1934
 
 
1935
    def test_exclude_tests_by_condition(self):
 
1936
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1937
            'test_exclude_tests_by_condition')
 
1938
        filtered_suite = exclude_tests_by_condition(self.suite,
 
1939
            lambda x:x.id() == excluded_name)
 
1940
        self.assertEqual(len(self.all_names) - 1,
 
1941
            filtered_suite.countTestCases())
 
1942
        self.assertFalse(excluded_name in _test_ids(filtered_suite))
 
1943
        remaining_names = list(self.all_names)
 
1944
        remaining_names.remove(excluded_name)
 
1945
        self.assertEqual(remaining_names, _test_ids(filtered_suite))
 
1946
 
 
1947
    def test_exclude_tests_by_re(self):
 
1948
        self.all_names = _test_ids(self.suite)
 
1949
        filtered_suite = exclude_tests_by_re(self.suite, 'exclude_tests_by_re')
 
1950
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1951
            'test_exclude_tests_by_re')
 
1952
        self.assertEqual(len(self.all_names) - 1,
 
1953
            filtered_suite.countTestCases())
 
1954
        self.assertFalse(excluded_name in _test_ids(filtered_suite))
 
1955
        remaining_names = list(self.all_names)
 
1956
        remaining_names.remove(excluded_name)
 
1957
        self.assertEqual(remaining_names, _test_ids(filtered_suite))
 
1958
 
 
1959
    def test_filter_suite_by_condition(self):
 
1960
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1961
            'test_filter_suite_by_condition')
 
1962
        filtered_suite = filter_suite_by_condition(self.suite,
 
1963
            lambda x:x.id() == test_name)
 
1964
        self.assertEqual([test_name], _test_ids(filtered_suite))
 
1965
 
 
1966
    def test_filter_suite_by_re(self):
 
1967
        filtered_suite = filter_suite_by_re(self.suite, 'test_filter_suite_by_r')
 
1968
        filtered_names = _test_ids(filtered_suite)
 
1969
        self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
 
1970
            'TestSelftestFiltering.test_filter_suite_by_re'])
 
1971
 
 
1972
    def test_filter_suite_by_id_list(self):
 
1973
        test_list = ['bzrlib.tests.test_selftest.'
 
1974
                     'TestSelftestFiltering.test_filter_suite_by_id_list']
 
1975
        filtered_suite = tests.filter_suite_by_id_list(
 
1976
            self.suite, tests.TestIdList(test_list))
 
1977
        filtered_names = _test_ids(filtered_suite)
 
1978
        self.assertEqual(
 
1979
            filtered_names,
 
1980
            ['bzrlib.tests.test_selftest.'
 
1981
             'TestSelftestFiltering.test_filter_suite_by_id_list'])
 
1982
 
 
1983
    def test_filter_suite_by_id_startswith(self):
 
1984
        # By design this test may fail if another test is added whose name also
 
1985
        # begins with one of the start value used.
 
1986
        klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1987
        start1 = klass + 'test_filter_suite_by_id_starts'
 
1988
        start2 = klass + 'test_filter_suite_by_id_li'
 
1989
        test_list = [klass + 'test_filter_suite_by_id_list',
 
1990
                     klass + 'test_filter_suite_by_id_startswith',
 
1991
                     ]
 
1992
        filtered_suite = tests.filter_suite_by_id_startswith(
 
1993
            self.suite, [start1, start2])
 
1994
        self.assertEqual(
 
1995
            test_list,
 
1996
            _test_ids(filtered_suite),
 
1997
            )
 
1998
 
 
1999
    def test_preserve_input(self):
 
2000
        # NB: Surely this is something in the stdlib to do this?
 
2001
        self.assertTrue(self.suite is preserve_input(self.suite))
 
2002
        self.assertTrue("@#$" is preserve_input("@#$"))
 
2003
 
 
2004
    def test_randomize_suite(self):
 
2005
        randomized_suite = randomize_suite(self.suite)
 
2006
        # randomizing should not add or remove test names.
 
2007
        self.assertEqual(set(_test_ids(self.suite)),
 
2008
                         set(_test_ids(randomized_suite)))
 
2009
        # Technically, this *can* fail, because random.shuffle(list) can be
 
2010
        # equal to list. Trying multiple times just pushes the frequency back.
 
2011
        # As its len(self.all_names)!:1, the failure frequency should be low
 
2012
        # enough to ignore. RBC 20071021.
 
2013
        # It should change the order.
 
2014
        self.assertNotEqual(self.all_names, _test_ids(randomized_suite))
 
2015
        # But not the length. (Possibly redundant with the set test, but not
 
2016
        # necessarily.)
 
2017
        self.assertEqual(len(self.all_names), len(_test_ids(randomized_suite)))
 
2018
 
 
2019
    def test_split_suit_by_condition(self):
 
2020
        self.all_names = _test_ids(self.suite)
 
2021
        condition = condition_id_re('test_filter_suite_by_r')
 
2022
        split_suite = split_suite_by_condition(self.suite, condition)
 
2023
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2024
            'test_filter_suite_by_re')
 
2025
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
 
2026
        self.assertFalse(filtered_name in _test_ids(split_suite[1]))
 
2027
        remaining_names = list(self.all_names)
 
2028
        remaining_names.remove(filtered_name)
 
2029
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
 
2030
 
 
2031
    def test_split_suit_by_re(self):
 
2032
        self.all_names = _test_ids(self.suite)
 
2033
        split_suite = split_suite_by_re(self.suite, 'test_filter_suite_by_r')
 
2034
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2035
            'test_filter_suite_by_re')
 
2036
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
 
2037
        self.assertFalse(filtered_name in _test_ids(split_suite[1]))
 
2038
        remaining_names = list(self.all_names)
 
2039
        remaining_names.remove(filtered_name)
 
2040
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
 
2041
 
 
2042
 
 
2043
class TestCheckInventoryShape(TestCaseWithTransport):
 
2044
 
 
2045
    def test_check_inventory_shape(self):
 
2046
        files = ['a', 'b/', 'b/c']
 
2047
        tree = self.make_branch_and_tree('.')
 
2048
        self.build_tree(files)
 
2049
        tree.add(files)
 
2050
        tree.lock_read()
 
2051
        try:
 
2052
            self.check_inventory_shape(tree.inventory, files)
 
2053
        finally:
 
2054
            tree.unlock()
 
2055
 
 
2056
 
 
2057
class TestBlackboxSupport(TestCase):
 
2058
    """Tests for testsuite blackbox features."""
 
2059
 
 
2060
    def test_run_bzr_failure_not_caught(self):
 
2061
        # When we run bzr in blackbox mode, we want any unexpected errors to
 
2062
        # propagate up to the test suite so that it can show the error in the
 
2063
        # usual way, and we won't get a double traceback.
 
2064
        e = self.assertRaises(
 
2065
            AssertionError,
 
2066
            self.run_bzr, ['assert-fail'])
 
2067
        # make sure we got the real thing, not an error from somewhere else in
 
2068
        # the test framework
 
2069
        self.assertEquals('always fails', str(e))
 
2070
        # check that there's no traceback in the test log
 
2071
        self.assertNotContainsRe(self._get_log(keep_log_file=True),
 
2072
            r'Traceback')
 
2073
 
 
2074
    def test_run_bzr_user_error_caught(self):
 
2075
        # Running bzr in blackbox mode, normal/expected/user errors should be
 
2076
        # caught in the regular way and turned into an error message plus exit
 
2077
        # code.
 
2078
        out, err = self.run_bzr(["log", "/nonexistantpath"], retcode=3)
 
2079
        self.assertEqual(out, '')
 
2080
        self.assertContainsRe(err,
 
2081
            'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
 
2082
 
 
2083
 
 
2084
class TestTestLoader(TestCase):
 
2085
    """Tests for the test loader."""
 
2086
 
 
2087
    def _get_loader_and_module(self):
 
2088
        """Gets a TestLoader and a module with one test in it."""
 
2089
        loader = TestUtil.TestLoader()
 
2090
        module = {}
 
2091
        class Stub(TestCase):
 
2092
            def test_foo(self):
 
2093
                pass
 
2094
        class MyModule(object):
 
2095
            pass
 
2096
        MyModule.a_class = Stub
 
2097
        module = MyModule()
 
2098
        return loader, module
 
2099
 
 
2100
    def test_module_no_load_tests_attribute_loads_classes(self):
 
2101
        loader, module = self._get_loader_and_module()
 
2102
        self.assertEqual(1, loader.loadTestsFromModule(module).countTestCases())
 
2103
 
 
2104
    def test_module_load_tests_attribute_gets_called(self):
 
2105
        loader, module = self._get_loader_and_module()
 
2106
        # 'self' is here because we're faking the module with a class. Regular
 
2107
        # load_tests do not need that :)
 
2108
        def load_tests(self, standard_tests, module, loader):
 
2109
            result = loader.suiteClass()
 
2110
            for test in iter_suite_tests(standard_tests):
 
2111
                result.addTests([test, test])
 
2112
            return result
 
2113
        # add a load_tests() method which multiplies the tests from the module.
 
2114
        module.__class__.load_tests = load_tests
 
2115
        self.assertEqual(2, loader.loadTestsFromModule(module).countTestCases())
 
2116
 
 
2117
    def test_load_tests_from_module_name_smoke_test(self):
 
2118
        loader = TestUtil.TestLoader()
 
2119
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2120
        self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
 
2121
                          _test_ids(suite))
 
2122
 
 
2123
    def test_load_tests_from_module_name_with_bogus_module_name(self):
 
2124
        loader = TestUtil.TestLoader()
 
2125
        self.assertRaises(ImportError, loader.loadTestsFromModuleName, 'bogus')
 
2126
 
 
2127
 
 
2128
class TestTestIdList(tests.TestCase):
 
2129
 
 
2130
    def _create_id_list(self, test_list):
 
2131
        return tests.TestIdList(test_list)
 
2132
 
 
2133
    def _create_suite(self, test_id_list):
 
2134
 
 
2135
        class Stub(TestCase):
 
2136
            def test_foo(self):
 
2137
                pass
 
2138
 
 
2139
        def _create_test_id(id):
 
2140
            return lambda: id
 
2141
 
 
2142
        suite = TestUtil.TestSuite()
 
2143
        for id in test_id_list:
 
2144
            t  = Stub('test_foo')
 
2145
            t.id = _create_test_id(id)
 
2146
            suite.addTest(t)
 
2147
        return suite
 
2148
 
 
2149
    def _test_ids(self, test_suite):
 
2150
        """Get the ids for the tests in a test suite."""
 
2151
        return [t.id() for t in iter_suite_tests(test_suite)]
 
2152
 
 
2153
    def test_empty_list(self):
 
2154
        id_list = self._create_id_list([])
 
2155
        self.assertEquals({}, id_list.tests)
 
2156
        self.assertEquals({}, id_list.modules)
 
2157
 
 
2158
    def test_valid_list(self):
 
2159
        id_list = self._create_id_list(
 
2160
            ['mod1.cl1.meth1', 'mod1.cl1.meth2',
 
2161
             'mod1.func1', 'mod1.cl2.meth2',
 
2162
             'mod1.submod1',
 
2163
             'mod1.submod2.cl1.meth1', 'mod1.submod2.cl2.meth2',
 
2164
             ])
 
2165
        self.assertTrue(id_list.refers_to('mod1'))
 
2166
        self.assertTrue(id_list.refers_to('mod1.submod1'))
 
2167
        self.assertTrue(id_list.refers_to('mod1.submod2'))
 
2168
        self.assertTrue(id_list.includes('mod1.cl1.meth1'))
 
2169
        self.assertTrue(id_list.includes('mod1.submod1'))
 
2170
        self.assertTrue(id_list.includes('mod1.func1'))
 
2171
 
 
2172
    def test_bad_chars_in_params(self):
 
2173
        id_list = self._create_id_list(['mod1.cl1.meth1(xx.yy)'])
 
2174
        self.assertTrue(id_list.refers_to('mod1'))
 
2175
        self.assertTrue(id_list.includes('mod1.cl1.meth1(xx.yy)'))
 
2176
 
 
2177
    def test_module_used(self):
 
2178
        id_list = self._create_id_list(['mod.class.meth'])
 
2179
        self.assertTrue(id_list.refers_to('mod'))
 
2180
        self.assertTrue(id_list.refers_to('mod.class'))
 
2181
        self.assertTrue(id_list.refers_to('mod.class.meth'))
 
2182
 
 
2183
    def test_test_suite(self):
 
2184
        # This test is slow, so we do a single test with one test in each
 
2185
        # category
 
2186
        test_list = [
 
2187
            # testmod_names
 
2188
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
 
2189
            'bzrlib.tests.test_selftest.TestTestIdList.test_test_suite',
 
2190
            # transport implementations
 
2191
            'bzrlib.tests.test_transport_implementations.TransportTests'
 
2192
            '.test_abspath(LocalURLServer)',
 
2193
            # modules_to_doctest
 
2194
            'bzrlib.timestamp.format_highres_date',
 
2195
            # plugins can't be tested that way since selftest may be run with
 
2196
            # --no-plugins
 
2197
            ]
 
2198
        suite = tests.test_suite(test_list)
 
2199
        self.assertEquals(test_list, _test_ids(suite))
 
2200
 
 
2201
    def test_test_suite_matches_id_list_with_unknown(self):
 
2202
        loader = TestUtil.TestLoader()
 
2203
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2204
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',
 
2205
                     'bogus']
 
2206
        not_found, duplicates = tests.suite_matches_id_list(suite, test_list)
 
2207
        self.assertEquals(['bogus'], not_found)
 
2208
        self.assertEquals([], duplicates)
 
2209
 
 
2210
    def test_suite_matches_id_list_with_duplicates(self):
 
2211
        loader = TestUtil.TestLoader()
 
2212
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2213
        dupes = loader.suiteClass()
 
2214
        for test in iter_suite_tests(suite):
 
2215
            dupes.addTest(test)
 
2216
            dupes.addTest(test) # Add it again
 
2217
 
 
2218
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',]
 
2219
        not_found, duplicates = tests.suite_matches_id_list(
 
2220
            dupes, test_list)
 
2221
        self.assertEquals([], not_found)
 
2222
        self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
 
2223
                          duplicates)
 
2224
 
 
2225
 
 
2226
class TestLoadTestIdList(tests.TestCaseInTempDir):
 
2227
 
 
2228
    def _create_test_list_file(self, file_name, content):
 
2229
        fl = open(file_name, 'wt')
 
2230
        fl.write(content)
 
2231
        fl.close()
 
2232
 
 
2233
    def test_load_unknown(self):
 
2234
        self.assertRaises(errors.NoSuchFile,
 
2235
                          tests.load_test_id_list, 'i_do_not_exist')
 
2236
 
 
2237
    def test_load_test_list(self):
 
2238
        test_list_fname = 'test.list'
 
2239
        self._create_test_list_file(test_list_fname,
 
2240
                                    'mod1.cl1.meth1\nmod2.cl2.meth2\n')
 
2241
        tlist = tests.load_test_id_list(test_list_fname)
 
2242
        self.assertEquals(2, len(tlist))
 
2243
        self.assertEquals('mod1.cl1.meth1', tlist[0])
 
2244
        self.assertEquals('mod2.cl2.meth2', tlist[1])
 
2245
 
 
2246
    def test_load_dirty_file(self):
 
2247
        test_list_fname = 'test.list'
 
2248
        self._create_test_list_file(test_list_fname,
 
2249
                                    '  mod1.cl1.meth1\n\nmod2.cl2.meth2  \n'
 
2250
                                    'bar baz\n')
 
2251
        tlist = tests.load_test_id_list(test_list_fname)
 
2252
        self.assertEquals(4, len(tlist))
 
2253
        self.assertEquals('mod1.cl1.meth1', tlist[0])
 
2254
        self.assertEquals('', tlist[1])
 
2255
        self.assertEquals('mod2.cl2.meth2', tlist[2])
 
2256
        self.assertEquals('bar baz', tlist[3])
 
2257
 
 
2258
 
 
2259
class TestFilteredByModuleTestLoader(tests.TestCase):
 
2260
 
 
2261
    def _create_loader(self, test_list):
 
2262
        id_filter = tests.TestIdList(test_list)
 
2263
        loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
 
2264
        return loader
 
2265
 
 
2266
    def test_load_tests(self):
 
2267
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2268
        loader = self._create_loader(test_list)
 
2269
 
 
2270
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2271
        self.assertEquals(test_list, _test_ids(suite))
 
2272
 
 
2273
    def test_exclude_tests(self):
 
2274
        test_list = ['bogus']
 
2275
        loader = self._create_loader(test_list)
 
2276
 
 
2277
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2278
        self.assertEquals([], _test_ids(suite))
 
2279
 
 
2280
 
 
2281
class TestFilteredByNameStartTestLoader(tests.TestCase):
 
2282
 
 
2283
    def _create_loader(self, name_start):
 
2284
        def needs_module(name):
 
2285
            return name.startswith(name_start) or name_start.startswith(name)
 
2286
        loader = TestUtil.FilteredByModuleTestLoader(needs_module)
 
2287
        return loader
 
2288
 
 
2289
    def test_load_tests(self):
 
2290
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2291
        loader = self._create_loader('bzrlib.tests.test_samp')
 
2292
 
 
2293
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2294
        self.assertEquals(test_list, _test_ids(suite))
 
2295
 
 
2296
    def test_load_tests_inside_module(self):
 
2297
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2298
        loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
 
2299
 
 
2300
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2301
        self.assertEquals(test_list, _test_ids(suite))
 
2302
 
 
2303
    def test_exclude_tests(self):
 
2304
        test_list = ['bogus']
 
2305
        loader = self._create_loader('bogus')
 
2306
 
 
2307
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2308
        self.assertEquals([], _test_ids(suite))
 
2309
 
 
2310
 
 
2311
class TestTestPrefixRegistry(tests.TestCase):
 
2312
 
 
2313
    def _get_registry(self):
 
2314
        tp_registry = tests.TestPrefixAliasRegistry()
 
2315
        return tp_registry
 
2316
 
 
2317
    def test_register_new_prefix(self):
 
2318
        tpr = self._get_registry()
 
2319
        tpr.register('foo', 'fff.ooo.ooo')
 
2320
        self.assertEquals('fff.ooo.ooo', tpr.get('foo'))
 
2321
 
 
2322
    def test_register_existing_prefix(self):
 
2323
        tpr = self._get_registry()
 
2324
        tpr.register('bar', 'bbb.aaa.rrr')
 
2325
        tpr.register('bar', 'bBB.aAA.rRR')
 
2326
        self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
 
2327
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
2328
                              r'.*bar.*bbb.aaa.rrr.*bBB.aAA.rRR')
 
2329
 
 
2330
    def test_get_unknown_prefix(self):
 
2331
        tpr = self._get_registry()
 
2332
        self.assertRaises(KeyError, tpr.get, 'I am not a prefix')
 
2333
 
 
2334
    def test_resolve_prefix(self):
 
2335
        tpr = self._get_registry()
 
2336
        tpr.register('bar', 'bb.aa.rr')
 
2337
        self.assertEquals('bb.aa.rr', tpr.resolve_alias('bar'))
 
2338
 
 
2339
    def test_resolve_unknown_alias(self):
 
2340
        tpr = self._get_registry()
 
2341
        self.assertRaises(errors.BzrCommandError,
 
2342
                          tpr.resolve_alias, 'I am not a prefix')
 
2343
 
 
2344
    def test_predefined_prefixes(self):
 
2345
        tpr = tests.test_prefix_alias_registry
 
2346
        self.assertEquals('bzrlib', tpr.resolve_alias('bzrlib'))
 
2347
        self.assertEquals('bzrlib.doc', tpr.resolve_alias('bd'))
 
2348
        self.assertEquals('bzrlib.utils', tpr.resolve_alias('bu'))
 
2349
        self.assertEquals('bzrlib.tests', tpr.resolve_alias('bt'))
 
2350
        self.assertEquals('bzrlib.tests.blackbox', tpr.resolve_alias('bb'))
 
2351
        self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
 
2352
 
 
2353
 
 
2354
class TestRunSuite(TestCase):
 
2355
 
 
2356
    def test_runner_class(self):
 
2357
        """run_suite accepts and uses a runner_class keyword argument."""
 
2358
        class Stub(TestCase):
 
2359
            def test_foo(self):
 
2360
                pass
 
2361
        suite = Stub("test_foo")
 
2362
        calls = []
 
2363
        class MyRunner(TextTestRunner):
 
2364
            def run(self, test):
 
2365
                calls.append(test)
 
2366
                return ExtendedTestResult(self.stream, self.descriptions,
 
2367
                    self.verbosity)
 
2368
        run_suite(suite, runner_class=MyRunner, stream=StringIO())
 
2369
        self.assertEqual(calls, [suite])
 
2370
 
 
2371
    def test_done(self):
 
2372
        """run_suite should call result.done()"""
 
2373
        self.calls = 0
 
2374
        def one_more_call(): self.calls += 1
 
2375
        def test_function():
 
2376
            pass
 
2377
        test = unittest.FunctionTestCase(test_function)
 
2378
        class InstrumentedTestResult(ExtendedTestResult):
 
2379
            def done(self): one_more_call()
 
2380
        class MyRunner(TextTestRunner):
 
2381
            def run(self, test):
 
2382
                return InstrumentedTestResult(self.stream, self.descriptions,
 
2383
                                              self.verbosity)
 
2384
        run_suite(test, runner_class=MyRunner, stream=StringIO())
 
2385
        self.assertEquals(1, self.calls)