/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
 
19
 
import cStringIO
 
19
from cStringIO import StringIO
 
20
from doctest import ELLIPSIS
20
21
import os
21
 
from StringIO import StringIO
 
22
import signal
22
23
import sys
23
24
import time
24
25
import unittest
25
26
import warnings
26
27
 
 
28
from testtools import MultiTestResult
 
29
from testtools.content_type import ContentType
 
30
from testtools.matchers import (
 
31
    DocTestMatches,
 
32
    Equals,
 
33
    )
 
34
import testtools.tests.helpers
 
35
 
27
36
import bzrlib
28
37
from bzrlib import (
 
38
    branchbuilder,
29
39
    bzrdir,
 
40
    debug,
30
41
    errors,
 
42
    lockdir,
31
43
    memorytree,
32
44
    osutils,
 
45
    progress,
 
46
    remote,
33
47
    repository,
34
48
    symbol_versioning,
35
 
    )
36
 
from bzrlib.progress import _BaseProgressBar
37
 
from bzrlib.repofmt import weaverepo
38
 
from bzrlib.symbol_versioning import zero_ten, zero_eleven
 
49
    tests,
 
50
    transport,
 
51
    workingtree,
 
52
    )
 
53
from bzrlib.repofmt import (
 
54
    groupcompress_repo,
 
55
    pack_repo,
 
56
    weaverepo,
 
57
    )
 
58
from bzrlib.symbol_versioning import (
 
59
    deprecated_function,
 
60
    deprecated_in,
 
61
    deprecated_method,
 
62
    )
39
63
from bzrlib.tests import (
40
 
                          ChrootedTestCase,
41
 
                          ExtendedTestResult,
42
 
                          Feature,
43
 
                          KnownFailure,
44
 
                          TestCase,
45
 
                          TestCaseInTempDir,
46
 
                          TestCaseWithMemoryTransport,
47
 
                          TestCaseWithTransport,
48
 
                          TestSkipped,
49
 
                          TestSuite,
50
 
                          TestUtil,
51
 
                          TextTestRunner,
52
 
                          UnavailableFeature,
53
 
                          clean_selftest_output,
54
 
                          iter_suite_tests,
55
 
                          filter_suite_by_re,
56
 
                          sort_suite_by_re,
57
 
                          test_suite
58
 
                          )
59
 
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
60
 
from bzrlib.tests.TestUtil import _load_module_by_name
 
64
    features,
 
65
    test_lsprof,
 
66
    test_server,
 
67
    test_sftp_transport,
 
68
    TestUtil,
 
69
    )
61
70
from bzrlib.trace import note
62
 
from bzrlib.transport.memory import MemoryServer, MemoryTransport
 
71
from bzrlib.transport import memory
63
72
from bzrlib.version import _get_bzr_source_tree
64
73
 
65
74
 
66
 
class SelftestTests(TestCase):
 
75
def _test_ids(test_suite):
 
76
    """Get the ids for the tests in a test suite."""
 
77
    return [t.id() for t in tests.iter_suite_tests(test_suite)]
 
78
 
 
79
 
 
80
class SelftestTests(tests.TestCase):
67
81
 
68
82
    def test_import_tests(self):
69
 
        mod = _load_module_by_name('bzrlib.tests.test_selftest')
 
83
        mod = TestUtil._load_module_by_name('bzrlib.tests.test_selftest')
70
84
        self.assertEqual(mod.SelftestTests, SelftestTests)
71
85
 
72
86
    def test_import_test_failure(self):
73
87
        self.assertRaises(ImportError,
74
 
                          _load_module_by_name,
 
88
                          TestUtil._load_module_by_name,
75
89
                          'bzrlib.no-name-yet')
76
90
 
77
 
class MetaTestLog(TestCase):
 
91
 
 
92
class MetaTestLog(tests.TestCase):
78
93
 
79
94
    def test_logging(self):
80
95
        """Test logs are captured when a test fails."""
81
96
        self.log('a test message')
82
 
        self._log_file.flush()
83
 
        self.assertContainsRe(self._get_log(keep_log_file=True),
84
 
                              'a test message\n')
85
 
 
86
 
 
87
 
class TestTreeShape(TestCaseInTempDir):
 
97
        details = self.getDetails()
 
98
        log = details['log']
 
99
        self.assertThat(log.content_type, Equals(ContentType(
 
100
            "text", "plain", {"charset": "utf8"})))
 
101
        self.assertThat(u"".join(log.iter_text()), Equals(self.get_log()))
 
102
        self.assertThat(self.get_log(),
 
103
            DocTestMatches(u"...a test message\n", ELLIPSIS))
 
104
 
 
105
 
 
106
class TestUnicodeFilename(tests.TestCase):
 
107
 
 
108
    def test_probe_passes(self):
 
109
        """UnicodeFilename._probe passes."""
 
110
        # We can't test much more than that because the behaviour depends
 
111
        # on the platform.
 
112
        tests.UnicodeFilename._probe()
 
113
 
 
114
 
 
115
class TestTreeShape(tests.TestCaseInTempDir):
88
116
 
89
117
    def test_unicode_paths(self):
 
118
        self.requireFeature(tests.UnicodeFilename)
 
119
 
90
120
        filename = u'hell\u00d8'
91
 
        try:
92
 
            self.build_tree_contents([(filename, 'contents of hello')])
93
 
        except UnicodeEncodeError:
94
 
            raise TestSkipped("can't build unicode working tree in "
95
 
                "filesystem encoding %s" % sys.getfilesystemencoding())
 
121
        self.build_tree_contents([(filename, 'contents of hello')])
96
122
        self.failUnlessExists(filename)
97
123
 
98
124
 
99
 
class TestTransportProviderAdapter(TestCase):
 
125
class TestTransportScenarios(tests.TestCase):
100
126
    """A group of tests that test the transport implementation adaption core.
101
127
 
102
 
    This is a meta test that the tests are applied to all available 
 
128
    This is a meta test that the tests are applied to all available
103
129
    transports.
104
130
 
105
 
    This will be generalised in the future which is why it is in this 
 
131
    This will be generalised in the future which is why it is in this
106
132
    test file even though it is specific to transport tests at the moment.
107
133
    """
108
134
 
109
135
    def test_get_transport_permutations(self):
110
 
        # this checks that we the module get_test_permutations call
111
 
        # is made by the adapter get_transport_test_permitations method.
 
136
        # this checks that get_test_permutations defined by the module is
 
137
        # called by the get_transport_test_permutations function.
112
138
        class MockModule(object):
113
139
            def get_test_permutations(self):
114
140
                return sample_permutation
115
141
        sample_permutation = [(1,2), (3,4)]
116
 
        from bzrlib.transport import TransportTestProviderAdapter
117
 
        adapter = TransportTestProviderAdapter()
 
142
        from bzrlib.tests.per_transport import get_transport_test_permutations
118
143
        self.assertEqual(sample_permutation,
119
 
                         adapter.get_transport_test_permutations(MockModule()))
 
144
                         get_transport_test_permutations(MockModule()))
120
145
 
121
 
    def test_adapter_checks_all_modules(self):
122
 
        # this checks that the adapter returns as many permurtations as
123
 
        # there are in all the registered# transport modules for there
124
 
        # - we assume if this matches its probably doing the right thing
125
 
        # especially in combination with the tests for setting the right
126
 
        # classes below.
127
 
        from bzrlib.transport import (TransportTestProviderAdapter,
128
 
                                      _get_transport_modules
129
 
                                      )
 
146
    def test_scenarios_include_all_modules(self):
 
147
        # this checks that the scenario generator returns as many permutations
 
148
        # as there are in all the registered transport modules - we assume if
 
149
        # this matches its probably doing the right thing especially in
 
150
        # combination with the tests for setting the right classes below.
 
151
        from bzrlib.tests.per_transport import transport_test_permutations
 
152
        from bzrlib.transport import _get_transport_modules
130
153
        modules = _get_transport_modules()
131
154
        permutation_count = 0
132
155
        for module in modules:
133
156
            try:
134
 
                permutation_count += len(reduce(getattr, 
 
157
                permutation_count += len(reduce(getattr,
135
158
                    (module + ".get_test_permutations").split('.')[1:],
136
159
                     __import__(module))())
137
160
            except errors.DependencyNotPresent:
138
161
                pass
139
 
        input_test = TestTransportProviderAdapter(
140
 
            "test_adapter_sets_transport_class")
141
 
        adapter = TransportTestProviderAdapter()
142
 
        self.assertEqual(permutation_count,
143
 
                         len(list(iter(adapter.adapt(input_test)))))
 
162
        scenarios = transport_test_permutations()
 
163
        self.assertEqual(permutation_count, len(scenarios))
144
164
 
145
 
    def test_adapter_sets_transport_class(self):
146
 
        # Check that the test adapter inserts a transport and server into the
147
 
        # generated test.
148
 
        #
 
165
    def test_scenarios_include_transport_class(self):
149
166
        # This test used to know about all the possible transports and the
150
167
        # order they were returned but that seems overly brittle (mbp
151
168
        # 20060307)
152
 
        input_test = TestTransportProviderAdapter(
153
 
            "test_adapter_sets_transport_class")
154
 
        from bzrlib.transport import TransportTestProviderAdapter
155
 
        suite = TransportTestProviderAdapter().adapt(input_test)
156
 
        tests = list(iter(suite))
157
 
        self.assertTrue(len(tests) > 6)
 
169
        from bzrlib.tests.per_transport import transport_test_permutations
 
170
        scenarios = transport_test_permutations()
158
171
        # there are at least that many builtin transports
159
 
        one_test = tests[0]
160
 
        self.assertTrue(issubclass(one_test.transport_class, 
 
172
        self.assertTrue(len(scenarios) > 6)
 
173
        one_scenario = scenarios[0]
 
174
        self.assertIsInstance(one_scenario[0], str)
 
175
        self.assertTrue(issubclass(one_scenario[1]["transport_class"],
161
176
                                   bzrlib.transport.Transport))
162
 
        self.assertTrue(issubclass(one_test.transport_server, 
 
177
        self.assertTrue(issubclass(one_scenario[1]["transport_server"],
163
178
                                   bzrlib.transport.Server))
164
179
 
165
180
 
166
 
class TestBranchProviderAdapter(TestCase):
167
 
    """A group of tests that test the branch implementation test adapter."""
 
181
class TestBranchScenarios(tests.TestCase):
168
182
 
169
 
    def test_adapted_tests(self):
 
183
    def test_scenarios(self):
170
184
        # check that constructor parameters are passed through to the adapted
171
185
        # test.
172
 
        from bzrlib.branch import BranchTestProviderAdapter
173
 
        input_test = TestBranchProviderAdapter(
174
 
            "test_adapted_tests")
 
186
        from bzrlib.tests.per_branch import make_scenarios
175
187
        server1 = "a"
176
188
        server2 = "b"
177
189
        formats = [("c", "C"), ("d", "D")]
178
 
        adapter = BranchTestProviderAdapter(server1, server2, formats)
179
 
        suite = adapter.adapt(input_test)
180
 
        tests = list(iter(suite))
181
 
        self.assertEqual(2, len(tests))
182
 
        self.assertEqual(tests[0].branch_format, formats[0][0])
183
 
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
184
 
        self.assertEqual(tests[0].transport_server, server1)
185
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
186
 
        self.assertEqual(tests[1].branch_format, formats[1][0])
187
 
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
188
 
        self.assertEqual(tests[1].transport_server, server1)
189
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
190
 
 
191
 
 
192
 
class TestBzrDirProviderAdapter(TestCase):
193
 
    """A group of tests that test the bzr dir implementation test adapter."""
194
 
 
195
 
    def test_adapted_tests(self):
 
190
        scenarios = make_scenarios(server1, server2, formats)
 
191
        self.assertEqual(2, len(scenarios))
 
192
        self.assertEqual([
 
193
            ('str',
 
194
             {'branch_format': 'c',
 
195
              'bzrdir_format': 'C',
 
196
              'transport_readonly_server': 'b',
 
197
              'transport_server': 'a'}),
 
198
            ('str',
 
199
             {'branch_format': 'd',
 
200
              'bzrdir_format': 'D',
 
201
              'transport_readonly_server': 'b',
 
202
              'transport_server': 'a'})],
 
203
            scenarios)
 
204
 
 
205
 
 
206
class TestBzrDirScenarios(tests.TestCase):
 
207
 
 
208
    def test_scenarios(self):
196
209
        # check that constructor parameters are passed through to the adapted
197
210
        # test.
198
 
        from bzrlib.bzrdir import BzrDirTestProviderAdapter
199
 
        input_test = TestBzrDirProviderAdapter(
200
 
            "test_adapted_tests")
 
211
        from bzrlib.tests.per_bzrdir import make_scenarios
201
212
        vfs_factory = "v"
202
213
        server1 = "a"
203
214
        server2 = "b"
204
215
        formats = ["c", "d"]
205
 
        adapter = BzrDirTestProviderAdapter(vfs_factory,
206
 
            server1, server2, formats)
207
 
        suite = adapter.adapt(input_test)
208
 
        tests = list(iter(suite))
209
 
        self.assertEqual(2, len(tests))
210
 
        self.assertEqual(tests[0].bzrdir_format, formats[0])
211
 
        self.assertEqual(tests[0].vfs_transport_factory, vfs_factory)
212
 
        self.assertEqual(tests[0].transport_server, server1)
213
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
214
 
        self.assertEqual(tests[1].bzrdir_format, formats[1])
215
 
        self.assertEqual(tests[1].vfs_transport_factory, vfs_factory)
216
 
        self.assertEqual(tests[1].transport_server, server1)
217
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
218
 
 
219
 
 
220
 
class TestRepositoryProviderAdapter(TestCase):
221
 
    """A group of tests that test the repository implementation test adapter."""
222
 
 
223
 
    def test_adapted_tests(self):
224
 
        # check that constructor parameters are passed through to the adapted
225
 
        # test.
226
 
        from bzrlib.repository import RepositoryTestProviderAdapter
227
 
        input_test = TestRepositoryProviderAdapter(
228
 
            "test_adapted_tests")
229
 
        server1 = "a"
230
 
        server2 = "b"
231
 
        formats = [("c", "C"), ("d", "D")]
232
 
        adapter = RepositoryTestProviderAdapter(server1, server2, formats)
233
 
        suite = adapter.adapt(input_test)
234
 
        tests = list(iter(suite))
235
 
        self.assertEqual(2, len(tests))
236
 
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
237
 
        self.assertEqual(tests[0].repository_format, formats[0][0])
238
 
        self.assertEqual(tests[0].transport_server, server1)
239
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
240
 
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
241
 
        self.assertEqual(tests[1].repository_format, formats[1][0])
242
 
        self.assertEqual(tests[1].transport_server, server1)
243
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
244
 
 
245
 
    def test_setting_vfs_transport(self):
246
 
        """The vfs_transport_factory can be set optionally."""
247
 
        from bzrlib.repository import RepositoryTestProviderAdapter
248
 
        input_test = TestRepositoryProviderAdapter(
249
 
            "test_adapted_tests")
250
 
        formats = [("c", "C")]
251
 
        adapter = RepositoryTestProviderAdapter(None, None, formats,
 
216
        scenarios = make_scenarios(vfs_factory, server1, server2, formats)
 
217
        self.assertEqual([
 
218
            ('str',
 
219
             {'bzrdir_format': 'c',
 
220
              'transport_readonly_server': 'b',
 
221
              'transport_server': 'a',
 
222
              'vfs_transport_factory': 'v'}),
 
223
            ('str',
 
224
             {'bzrdir_format': 'd',
 
225
              'transport_readonly_server': 'b',
 
226
              'transport_server': 'a',
 
227
              'vfs_transport_factory': 'v'})],
 
228
            scenarios)
 
229
 
 
230
 
 
231
class TestRepositoryScenarios(tests.TestCase):
 
232
 
 
233
    def test_formats_to_scenarios(self):
 
234
        from bzrlib.tests.per_repository import formats_to_scenarios
 
235
        formats = [("(c)", remote.RemoteRepositoryFormat()),
 
236
                   ("(d)", repository.format_registry.get(
 
237
                    'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
 
238
        no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
 
239
            None)
 
240
        vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
252
241
            vfs_transport_factory="vfs")
253
 
        suite = adapter.adapt(input_test)
254
 
        tests = list(iter(suite))
255
 
        self.assertEqual(1, len(tests))
256
 
        self.assertEqual(tests[0].vfs_transport_factory, "vfs")
257
 
 
258
 
 
259
 
class TestInterRepositoryProviderAdapter(TestCase):
260
 
    """A group of tests that test the InterRepository test adapter."""
261
 
 
262
 
    def test_adapted_tests(self):
263
 
        # check that constructor parameters are passed through to the adapted
264
 
        # test.
265
 
        from bzrlib.repository import InterRepositoryTestProviderAdapter
266
 
        input_test = TestInterRepositoryProviderAdapter(
267
 
            "test_adapted_tests")
268
 
        server1 = "a"
269
 
        server2 = "b"
270
 
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
271
 
        adapter = InterRepositoryTestProviderAdapter(server1, server2, formats)
272
 
        suite = adapter.adapt(input_test)
273
 
        tests = list(iter(suite))
274
 
        self.assertEqual(2, len(tests))
275
 
        self.assertEqual(tests[0].interrepo_class, formats[0][0])
276
 
        self.assertEqual(tests[0].repository_format, formats[0][1])
277
 
        self.assertEqual(tests[0].repository_format_to, formats[0][2])
278
 
        self.assertEqual(tests[0].transport_server, server1)
279
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
280
 
        self.assertEqual(tests[1].interrepo_class, formats[1][0])
281
 
        self.assertEqual(tests[1].repository_format, formats[1][1])
282
 
        self.assertEqual(tests[1].repository_format_to, formats[1][2])
283
 
        self.assertEqual(tests[1].transport_server, server1)
284
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
285
 
 
286
 
 
287
 
class TestInterVersionedFileProviderAdapter(TestCase):
288
 
    """A group of tests that test the InterVersionedFile test adapter."""
289
 
 
290
 
    def test_adapted_tests(self):
291
 
        # check that constructor parameters are passed through to the adapted
292
 
        # test.
293
 
        from bzrlib.versionedfile import InterVersionedFileTestProviderAdapter
294
 
        input_test = TestInterRepositoryProviderAdapter(
295
 
            "test_adapted_tests")
296
 
        server1 = "a"
297
 
        server2 = "b"
298
 
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
299
 
        adapter = InterVersionedFileTestProviderAdapter(server1, server2, formats)
300
 
        suite = adapter.adapt(input_test)
301
 
        tests = list(iter(suite))
302
 
        self.assertEqual(2, len(tests))
303
 
        self.assertEqual(tests[0].interversionedfile_class, formats[0][0])
304
 
        self.assertEqual(tests[0].versionedfile_factory, formats[0][1])
305
 
        self.assertEqual(tests[0].versionedfile_factory_to, formats[0][2])
306
 
        self.assertEqual(tests[0].transport_server, server1)
307
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
308
 
        self.assertEqual(tests[1].interversionedfile_class, formats[1][0])
309
 
        self.assertEqual(tests[1].versionedfile_factory, formats[1][1])
310
 
        self.assertEqual(tests[1].versionedfile_factory_to, formats[1][2])
311
 
        self.assertEqual(tests[1].transport_server, server1)
312
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
313
 
 
314
 
 
315
 
class TestRevisionStoreProviderAdapter(TestCase):
316
 
    """A group of tests that test the RevisionStore test adapter."""
317
 
 
318
 
    def test_adapted_tests(self):
319
 
        # check that constructor parameters are passed through to the adapted
320
 
        # test.
321
 
        from bzrlib.store.revision import RevisionStoreTestProviderAdapter
322
 
        input_test = TestRevisionStoreProviderAdapter(
323
 
            "test_adapted_tests")
324
 
        # revision stores need a store factory - i.e. RevisionKnit
325
 
        #, a readonly and rw transport 
326
 
        # transport servers:
327
 
        server1 = "a"
328
 
        server2 = "b"
329
 
        store_factories = ["c", "d"]
330
 
        adapter = RevisionStoreTestProviderAdapter(server1, server2, store_factories)
331
 
        suite = adapter.adapt(input_test)
332
 
        tests = list(iter(suite))
333
 
        self.assertEqual(2, len(tests))
334
 
        self.assertEqual(tests[0].store_factory, store_factories[0][0])
335
 
        self.assertEqual(tests[0].transport_server, server1)
336
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
337
 
        self.assertEqual(tests[1].store_factory, store_factories[1][0])
338
 
        self.assertEqual(tests[1].transport_server, server1)
339
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
340
 
 
341
 
 
342
 
class TestWorkingTreeProviderAdapter(TestCase):
343
 
    """A group of tests that test the workingtree implementation test adapter."""
344
 
 
345
 
    def test_adapted_tests(self):
346
 
        # check that constructor parameters are passed through to the adapted
347
 
        # test.
348
 
        from bzrlib.workingtree import WorkingTreeTestProviderAdapter
349
 
        input_test = TestWorkingTreeProviderAdapter(
350
 
            "test_adapted_tests")
351
 
        server1 = "a"
352
 
        server2 = "b"
353
 
        formats = [("c", "C"), ("d", "D")]
354
 
        adapter = WorkingTreeTestProviderAdapter(server1, server2, formats)
355
 
        suite = adapter.adapt(input_test)
356
 
        tests = list(iter(suite))
357
 
        self.assertEqual(2, len(tests))
358
 
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
359
 
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
360
 
        self.assertEqual(tests[0].transport_server, server1)
361
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
362
 
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
363
 
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
364
 
        self.assertEqual(tests[1].transport_server, server1)
365
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
366
 
 
367
 
 
368
 
class TestTreeProviderAdapter(TestCase):
369
 
    """Test the setup of tree_implementation tests."""
370
 
 
371
 
    def test_adapted_tests(self):
372
 
        # the tree implementation adapter is meant to setup one instance for
373
 
        # each working tree format, and one additional instance that will
374
 
        # use the default wt format, but create a revision tree for the tests.
375
 
        # this means that the wt ones should have the workingtree_to_test_tree
376
 
        # attribute set to 'return_parameter' and the revision one set to
377
 
        # revision_tree_from_workingtree.
378
 
 
379
 
        from bzrlib.tests.tree_implementations import (
380
 
            TreeTestProviderAdapter,
 
242
        # no_vfs generate scenarios without vfs_transport_factory
 
243
        expected = [
 
244
            ('RemoteRepositoryFormat(c)',
 
245
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
 
246
              'repository_format': remote.RemoteRepositoryFormat(),
 
247
              'transport_readonly_server': 'readonly',
 
248
              'transport_server': 'server'}),
 
249
            ('RepositoryFormat2a(d)',
 
250
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
 
251
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
252
              'transport_readonly_server': 'readonly',
 
253
              'transport_server': 'server'})]
 
254
        self.assertEqual(expected, no_vfs_scenarios)
 
255
        self.assertEqual([
 
256
            ('RemoteRepositoryFormat(c)',
 
257
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
 
258
              'repository_format': remote.RemoteRepositoryFormat(),
 
259
              'transport_readonly_server': 'readonly',
 
260
              'transport_server': 'server',
 
261
              'vfs_transport_factory': 'vfs'}),
 
262
            ('RepositoryFormat2a(d)',
 
263
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
 
264
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
265
              'transport_readonly_server': 'readonly',
 
266
              'transport_server': 'server',
 
267
              'vfs_transport_factory': 'vfs'})],
 
268
            vfs_scenarios)
 
269
 
 
270
 
 
271
class TestTestScenarioApplication(tests.TestCase):
 
272
    """Tests for the test adaption facilities."""
 
273
 
 
274
    def test_apply_scenario(self):
 
275
        from bzrlib.tests import apply_scenario
 
276
        input_test = TestTestScenarioApplication("test_apply_scenario")
 
277
        # setup two adapted tests
 
278
        adapted_test1 = apply_scenario(input_test,
 
279
            ("new id",
 
280
            {"bzrdir_format":"bzr_format",
 
281
             "repository_format":"repo_fmt",
 
282
             "transport_server":"transport_server",
 
283
             "transport_readonly_server":"readonly-server"}))
 
284
        adapted_test2 = apply_scenario(input_test,
 
285
            ("new id 2", {"bzrdir_format":None}))
 
286
        # input_test should have been altered.
 
287
        self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
 
288
        # the new tests are mutually incompatible, ensuring it has
 
289
        # made new ones, and unspecified elements in the scenario
 
290
        # should not have been altered.
 
291
        self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
 
292
        self.assertEqual("repo_fmt", adapted_test1.repository_format)
 
293
        self.assertEqual("transport_server", adapted_test1.transport_server)
 
294
        self.assertEqual("readonly-server",
 
295
            adapted_test1.transport_readonly_server)
 
296
        self.assertEqual(
 
297
            "bzrlib.tests.test_selftest.TestTestScenarioApplication."
 
298
            "test_apply_scenario(new id)",
 
299
            adapted_test1.id())
 
300
        self.assertEqual(None, adapted_test2.bzrdir_format)
 
301
        self.assertEqual(
 
302
            "bzrlib.tests.test_selftest.TestTestScenarioApplication."
 
303
            "test_apply_scenario(new id 2)",
 
304
            adapted_test2.id())
 
305
 
 
306
 
 
307
class TestInterRepositoryScenarios(tests.TestCase):
 
308
 
 
309
    def test_scenarios(self):
 
310
        # check that constructor parameters are passed through to the adapted
 
311
        # test.
 
312
        from bzrlib.tests.per_interrepository import make_scenarios
 
313
        server1 = "a"
 
314
        server2 = "b"
 
315
        formats = [("C0", "C1", "C2"), ("D0", "D1", "D2")]
 
316
        scenarios = make_scenarios(server1, server2, formats)
 
317
        self.assertEqual([
 
318
            ('C0,str,str',
 
319
             {'repository_format': 'C1',
 
320
              'repository_format_to': 'C2',
 
321
              'transport_readonly_server': 'b',
 
322
              'transport_server': 'a'}),
 
323
            ('D0,str,str',
 
324
             {'repository_format': 'D1',
 
325
              'repository_format_to': 'D2',
 
326
              'transport_readonly_server': 'b',
 
327
              'transport_server': 'a'})],
 
328
            scenarios)
 
329
 
 
330
 
 
331
class TestWorkingTreeScenarios(tests.TestCase):
 
332
 
 
333
    def test_scenarios(self):
 
334
        # check that constructor parameters are passed through to the adapted
 
335
        # test.
 
336
        from bzrlib.tests.per_workingtree import make_scenarios
 
337
        server1 = "a"
 
338
        server2 = "b"
 
339
        formats = [workingtree.WorkingTreeFormat2(),
 
340
                   workingtree.WorkingTreeFormat3(),]
 
341
        scenarios = make_scenarios(server1, server2, formats)
 
342
        self.assertEqual([
 
343
            ('WorkingTreeFormat2',
 
344
             {'bzrdir_format': formats[0]._matchingbzrdir,
 
345
              'transport_readonly_server': 'b',
 
346
              'transport_server': 'a',
 
347
              'workingtree_format': formats[0]}),
 
348
            ('WorkingTreeFormat3',
 
349
             {'bzrdir_format': formats[1]._matchingbzrdir,
 
350
              'transport_readonly_server': 'b',
 
351
              'transport_server': 'a',
 
352
              'workingtree_format': formats[1]})],
 
353
            scenarios)
 
354
 
 
355
 
 
356
class TestTreeScenarios(tests.TestCase):
 
357
 
 
358
    def test_scenarios(self):
 
359
        # the tree implementation scenario generator is meant to setup one
 
360
        # instance for each working tree format, and one additional instance
 
361
        # that will use the default wt format, but create a revision tree for
 
362
        # the tests.  this means that the wt ones should have the
 
363
        # workingtree_to_test_tree attribute set to 'return_parameter' and the
 
364
        # revision one set to revision_tree_from_workingtree.
 
365
 
 
366
        from bzrlib.tests.per_tree import (
 
367
            _dirstate_tree_from_workingtree,
 
368
            make_scenarios,
 
369
            preview_tree_pre,
 
370
            preview_tree_post,
381
371
            return_parameter,
382
372
            revision_tree_from_workingtree
383
373
            )
384
 
        from bzrlib.workingtree import WorkingTreeFormat, WorkingTreeFormat3
385
 
        input_test = TestTreeProviderAdapter(
386
 
            "test_adapted_tests")
387
374
        server1 = "a"
388
375
        server2 = "b"
389
 
        formats = [("c", "C"), ("d", "D")]
390
 
        adapter = TreeTestProviderAdapter(server1, server2, formats)
391
 
        suite = adapter.adapt(input_test)
392
 
        tests = list(iter(suite))
393
 
        self.assertEqual(4, len(tests))
394
 
        # this must match the default format setp up in
395
 
        # TreeTestProviderAdapter.adapt
396
 
        default_format = WorkingTreeFormat3
397
 
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
398
 
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
399
 
        self.assertEqual(tests[0].transport_server, server1)
400
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
401
 
        self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
402
 
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
403
 
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
404
 
        self.assertEqual(tests[1].transport_server, server1)
405
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
406
 
        self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
407
 
        self.assertIsInstance(tests[2].workingtree_format, default_format)
408
 
        #self.assertEqual(tests[2].bzrdir_format,
409
 
        #                 default_format._matchingbzrdir)
410
 
        self.assertEqual(tests[2].transport_server, server1)
411
 
        self.assertEqual(tests[2].transport_readonly_server, server2)
412
 
        self.assertEqual(tests[2].workingtree_to_test_tree,
413
 
            revision_tree_from_workingtree)
414
 
 
415
 
 
416
 
class TestInterTreeProviderAdapter(TestCase):
 
376
        formats = [workingtree.WorkingTreeFormat2(),
 
377
                   workingtree.WorkingTreeFormat3(),]
 
378
        scenarios = make_scenarios(server1, server2, formats)
 
379
        self.assertEqual(7, len(scenarios))
 
380
        default_wt_format = workingtree.WorkingTreeFormat4._default_format
 
381
        wt4_format = workingtree.WorkingTreeFormat4()
 
382
        wt5_format = workingtree.WorkingTreeFormat5()
 
383
        expected_scenarios = [
 
384
            ('WorkingTreeFormat2',
 
385
             {'bzrdir_format': formats[0]._matchingbzrdir,
 
386
              'transport_readonly_server': 'b',
 
387
              'transport_server': 'a',
 
388
              'workingtree_format': formats[0],
 
389
              '_workingtree_to_test_tree': return_parameter,
 
390
              }),
 
391
            ('WorkingTreeFormat3',
 
392
             {'bzrdir_format': formats[1]._matchingbzrdir,
 
393
              'transport_readonly_server': 'b',
 
394
              'transport_server': 'a',
 
395
              'workingtree_format': formats[1],
 
396
              '_workingtree_to_test_tree': return_parameter,
 
397
             }),
 
398
            ('RevisionTree',
 
399
             {'_workingtree_to_test_tree': revision_tree_from_workingtree,
 
400
              'bzrdir_format': default_wt_format._matchingbzrdir,
 
401
              'transport_readonly_server': 'b',
 
402
              'transport_server': 'a',
 
403
              'workingtree_format': default_wt_format,
 
404
             }),
 
405
            ('DirStateRevisionTree,WT4',
 
406
             {'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
 
407
              'bzrdir_format': wt4_format._matchingbzrdir,
 
408
              'transport_readonly_server': 'b',
 
409
              'transport_server': 'a',
 
410
              'workingtree_format': wt4_format,
 
411
             }),
 
412
            ('DirStateRevisionTree,WT5',
 
413
             {'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
 
414
              'bzrdir_format': wt5_format._matchingbzrdir,
 
415
              'transport_readonly_server': 'b',
 
416
              'transport_server': 'a',
 
417
              'workingtree_format': wt5_format,
 
418
             }),
 
419
            ('PreviewTree',
 
420
             {'_workingtree_to_test_tree': preview_tree_pre,
 
421
              'bzrdir_format': default_wt_format._matchingbzrdir,
 
422
              'transport_readonly_server': 'b',
 
423
              'transport_server': 'a',
 
424
              'workingtree_format': default_wt_format}),
 
425
            ('PreviewTreePost',
 
426
             {'_workingtree_to_test_tree': preview_tree_post,
 
427
              'bzrdir_format': default_wt_format._matchingbzrdir,
 
428
              'transport_readonly_server': 'b',
 
429
              'transport_server': 'a',
 
430
              'workingtree_format': default_wt_format}),
 
431
             ]
 
432
        self.assertEqual(expected_scenarios, scenarios)
 
433
 
 
434
 
 
435
class TestInterTreeScenarios(tests.TestCase):
417
436
    """A group of tests that test the InterTreeTestAdapter."""
418
437
 
419
 
    def test_adapted_tests(self):
 
438
    def test_scenarios(self):
420
439
        # check that constructor parameters are passed through to the adapted
421
440
        # test.
422
441
        # for InterTree tests we want the machinery to bring up two trees in
424
443
        # because each optimiser can be direction specific, we need to test
425
444
        # each optimiser in its chosen direction.
426
445
        # unlike the TestProviderAdapter we dont want to automatically add a
427
 
        # parameterised one for WorkingTree - the optimisers will tell us what
 
446
        # parameterized one for WorkingTree - the optimisers will tell us what
428
447
        # ones to add.
429
 
        from bzrlib.tests.tree_implementations import (
 
448
        from bzrlib.tests.per_tree import (
430
449
            return_parameter,
431
450
            revision_tree_from_workingtree
432
451
            )
433
 
        from bzrlib.tests.intertree_implementations import (
434
 
            InterTreeTestProviderAdapter,
 
452
        from bzrlib.tests.per_intertree import (
 
453
            make_scenarios,
435
454
            )
436
455
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
437
 
        input_test = TestInterTreeProviderAdapter(
438
 
            "test_adapted_tests")
 
456
        input_test = TestInterTreeScenarios(
 
457
            "test_scenarios")
439
458
        server1 = "a"
440
459
        server2 = "b"
441
460
        format1 = WorkingTreeFormat2()
442
461
        format2 = WorkingTreeFormat3()
443
 
        formats = [(str, format1, format2, "converter1"),
444
 
            (int, format2, format1, "converter2")]
445
 
        adapter = InterTreeTestProviderAdapter(server1, server2, formats)
446
 
        suite = adapter.adapt(input_test)
447
 
        tests = list(iter(suite))
448
 
        self.assertEqual(2, len(tests))
449
 
        self.assertEqual(tests[0].intertree_class, formats[0][0])
450
 
        self.assertEqual(tests[0].workingtree_format, formats[0][1])
451
 
        self.assertEqual(tests[0].workingtree_format_to, formats[0][2])
452
 
        self.assertEqual(tests[0].mutable_trees_to_test_trees, formats[0][3])
453
 
        self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
454
 
        self.assertEqual(tests[0].transport_server, server1)
455
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
456
 
        self.assertEqual(tests[1].intertree_class, formats[1][0])
457
 
        self.assertEqual(tests[1].workingtree_format, formats[1][1])
458
 
        self.assertEqual(tests[1].workingtree_format_to, formats[1][2])
459
 
        self.assertEqual(tests[1].mutable_trees_to_test_trees, formats[1][3])
460
 
        self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
461
 
        self.assertEqual(tests[1].transport_server, server1)
462
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
463
 
 
464
 
 
465
 
class TestTestCaseInTempDir(TestCaseInTempDir):
 
462
        formats = [("1", str, format1, format2, "converter1"),
 
463
            ("2", int, format2, format1, "converter2")]
 
464
        scenarios = make_scenarios(server1, server2, formats)
 
465
        self.assertEqual(2, len(scenarios))
 
466
        expected_scenarios = [
 
467
            ("1", {
 
468
                "bzrdir_format": format1._matchingbzrdir,
 
469
                "intertree_class": formats[0][1],
 
470
                "workingtree_format": formats[0][2],
 
471
                "workingtree_format_to": formats[0][3],
 
472
                "mutable_trees_to_test_trees": formats[0][4],
 
473
                "_workingtree_to_test_tree": return_parameter,
 
474
                "transport_server": server1,
 
475
                "transport_readonly_server": server2,
 
476
                }),
 
477
            ("2", {
 
478
                "bzrdir_format": format2._matchingbzrdir,
 
479
                "intertree_class": formats[1][1],
 
480
                "workingtree_format": formats[1][2],
 
481
                "workingtree_format_to": formats[1][3],
 
482
                "mutable_trees_to_test_trees": formats[1][4],
 
483
                "_workingtree_to_test_tree": return_parameter,
 
484
                "transport_server": server1,
 
485
                "transport_readonly_server": server2,
 
486
                }),
 
487
            ]
 
488
        self.assertEqual(scenarios, expected_scenarios)
 
489
 
 
490
 
 
491
class TestTestCaseInTempDir(tests.TestCaseInTempDir):
466
492
 
467
493
    def test_home_is_not_working(self):
468
494
        self.assertNotEqual(self.test_dir, self.test_home_dir)
469
495
        cwd = osutils.getcwd()
470
 
        self.assertEqual(self.test_dir, cwd)
471
 
        self.assertEqual(self.test_home_dir, os.environ['HOME'])
472
 
 
473
 
 
474
 
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
 
496
        self.assertIsSameRealPath(self.test_dir, cwd)
 
497
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
 
498
 
 
499
    def test_assertEqualStat_equal(self):
 
500
        from bzrlib.tests.test_dirstate import _FakeStat
 
501
        self.build_tree(["foo"])
 
502
        real = os.lstat("foo")
 
503
        fake = _FakeStat(real.st_size, real.st_mtime, real.st_ctime,
 
504
            real.st_dev, real.st_ino, real.st_mode)
 
505
        self.assertEqualStat(real, fake)
 
506
 
 
507
    def test_assertEqualStat_notequal(self):
 
508
        self.build_tree(["foo", "longname"])
 
509
        self.assertRaises(AssertionError, self.assertEqualStat,
 
510
            os.lstat("foo"), os.lstat("longname"))
 
511
 
 
512
 
 
513
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
475
514
 
476
515
    def test_home_is_non_existant_dir_under_root(self):
477
516
        """The test_home_dir for TestCaseWithMemoryTransport is missing.
478
517
 
479
518
        This is because TestCaseWithMemoryTransport is for tests that do not
480
 
        need any disk resources: they should be hooked into bzrlib in such a 
481
 
        way that no global settings are being changed by the test (only a 
 
519
        need any disk resources: they should be hooked into bzrlib in such a
 
520
        way that no global settings are being changed by the test (only a
482
521
        few tests should need to do that), and having a missing dir as home is
483
522
        an effective way to ensure that this is the case.
484
523
        """
485
 
        self.assertEqual(self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
 
524
        self.assertIsSameRealPath(
 
525
            self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
486
526
            self.test_home_dir)
487
 
        self.assertEqual(self.test_home_dir, os.environ['HOME'])
488
 
        
 
527
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
 
528
 
489
529
    def test_cwd_is_TEST_ROOT(self):
490
 
        self.assertEqual(self.test_dir, self.TEST_ROOT)
 
530
        self.assertIsSameRealPath(self.test_dir, self.TEST_ROOT)
491
531
        cwd = osutils.getcwd()
492
 
        self.assertEqual(self.test_dir, cwd)
 
532
        self.assertIsSameRealPath(self.test_dir, cwd)
 
533
 
 
534
    def test_BZR_HOME_and_HOME_are_bytestrings(self):
 
535
        """The $BZR_HOME and $HOME environment variables should not be unicode.
 
536
 
 
537
        See https://bugs.launchpad.net/bzr/+bug/464174
 
538
        """
 
539
        self.assertIsInstance(os.environ['BZR_HOME'], str)
 
540
        self.assertIsInstance(os.environ['HOME'], str)
493
541
 
494
542
    def test_make_branch_and_memory_tree(self):
495
543
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
515
563
        self.assertEqual(format.repository_format.__class__,
516
564
            tree.branch.repository._format.__class__)
517
565
 
518
 
 
519
 
class TestTestCaseWithTransport(TestCaseWithTransport):
 
566
    def test_make_branch_builder(self):
 
567
        builder = self.make_branch_builder('dir')
 
568
        self.assertIsInstance(builder, branchbuilder.BranchBuilder)
 
569
        # Guard against regression into MemoryTransport leaking
 
570
        # files to disk instead of keeping them in memory.
 
571
        self.failIf(osutils.lexists('dir'))
 
572
 
 
573
    def test_make_branch_builder_with_format(self):
 
574
        # Use a repo layout that doesn't conform to a 'named' layout, to ensure
 
575
        # that the format objects are used.
 
576
        format = bzrdir.BzrDirMetaFormat1()
 
577
        repo_format = weaverepo.RepositoryFormat7()
 
578
        format.repository_format = repo_format
 
579
        builder = self.make_branch_builder('dir', format=format)
 
580
        the_branch = builder.get_branch()
 
581
        # Guard against regression into MemoryTransport leaking
 
582
        # files to disk instead of keeping them in memory.
 
583
        self.failIf(osutils.lexists('dir'))
 
584
        self.assertEqual(format.repository_format.__class__,
 
585
                         the_branch.repository._format.__class__)
 
586
        self.assertEqual(repo_format.get_format_string(),
 
587
                         self.get_transport().get_bytes(
 
588
                            'dir/.bzr/repository/format'))
 
589
 
 
590
    def test_make_branch_builder_with_format_name(self):
 
591
        builder = self.make_branch_builder('dir', format='knit')
 
592
        the_branch = builder.get_branch()
 
593
        # Guard against regression into MemoryTransport leaking
 
594
        # files to disk instead of keeping them in memory.
 
595
        self.failIf(osutils.lexists('dir'))
 
596
        dir_format = bzrdir.format_registry.make_bzrdir('knit')
 
597
        self.assertEqual(dir_format.repository_format.__class__,
 
598
                         the_branch.repository._format.__class__)
 
599
        self.assertEqual('Bazaar-NG Knit Repository Format 1',
 
600
                         self.get_transport().get_bytes(
 
601
                            'dir/.bzr/repository/format'))
 
602
 
 
603
    def test_dangling_locks_cause_failures(self):
 
604
        class TestDanglingLock(tests.TestCaseWithMemoryTransport):
 
605
            def test_function(self):
 
606
                t = self.get_transport('.')
 
607
                l = lockdir.LockDir(t, 'lock')
 
608
                l.create()
 
609
                l.attempt_lock()
 
610
        test = TestDanglingLock('test_function')
 
611
        result = test.run()
 
612
        if self._lock_check_thorough:
 
613
            self.assertEqual(1, len(result.errors))
 
614
        else:
 
615
            # When _lock_check_thorough is disabled, then we don't trigger a
 
616
            # failure
 
617
            self.assertEqual(0, len(result.errors))
 
618
 
 
619
 
 
620
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
520
621
    """Tests for the convenience functions TestCaseWithTransport introduces."""
521
622
 
522
623
    def test_get_readonly_url_none(self):
523
624
        from bzrlib.transport import get_transport
524
 
        from bzrlib.transport.memory import MemoryServer
525
625
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
526
 
        self.vfs_transport_factory = MemoryServer
 
626
        self.vfs_transport_factory = memory.MemoryServer
527
627
        self.transport_readonly_server = None
528
628
        # calling get_readonly_transport() constructs a decorator on the url
529
629
        # for the server
536
636
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
537
637
 
538
638
    def test_get_readonly_url_http(self):
539
 
        from bzrlib.tests.HttpServer import HttpServer
 
639
        from bzrlib.tests.http_server import HttpServer
540
640
        from bzrlib.transport import get_transport
541
 
        from bzrlib.transport.local import LocalURLServer
542
641
        from bzrlib.transport.http import HttpTransportBase
543
 
        self.transport_server = LocalURLServer
 
642
        self.transport_server = test_server.LocalURLServer
544
643
        self.transport_readonly_server = HttpServer
545
644
        # calling get_readonly_transport() gives us a HTTP server instance.
546
645
        url = self.get_readonly_url()
560
659
        self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
561
660
        self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
562
661
 
563
 
 
564
 
class TestTestCaseTransports(TestCaseWithTransport):
 
662
    def test_make_branch_builder(self):
 
663
        builder = self.make_branch_builder('dir')
 
664
        rev_id = builder.build_commit()
 
665
        self.failUnlessExists('dir')
 
666
        a_dir = bzrdir.BzrDir.open('dir')
 
667
        self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
 
668
        a_branch = a_dir.open_branch()
 
669
        builder_branch = builder.get_branch()
 
670
        self.assertEqual(a_branch.base, builder_branch.base)
 
671
        self.assertEqual((1, rev_id), builder_branch.last_revision_info())
 
672
        self.assertEqual((1, rev_id), a_branch.last_revision_info())
 
673
 
 
674
 
 
675
class TestTestCaseTransports(tests.TestCaseWithTransport):
565
676
 
566
677
    def setUp(self):
567
678
        super(TestTestCaseTransports, self).setUp()
568
 
        self.vfs_transport_factory = MemoryServer
 
679
        self.vfs_transport_factory = memory.MemoryServer
569
680
 
570
681
    def test_make_bzrdir_preserves_transport(self):
571
682
        t = self.get_transport()
572
683
        result_bzrdir = self.make_bzrdir('subdir')
573
 
        self.assertIsInstance(result_bzrdir.transport, 
574
 
                              MemoryTransport)
 
684
        self.assertIsInstance(result_bzrdir.transport,
 
685
                              memory.MemoryTransport)
575
686
        # should not be on disk, should only be in memory
576
687
        self.failIfExists('subdir')
577
688
 
578
689
 
579
 
class TestChrootedTest(ChrootedTestCase):
 
690
class TestChrootedTest(tests.ChrootedTestCase):
580
691
 
581
692
    def test_root_is_root(self):
582
693
        from bzrlib.transport import get_transport
585
696
        self.assertEqual(url, t.clone('..').base)
586
697
 
587
698
 
588
 
class MockProgress(_BaseProgressBar):
589
 
    """Progress-bar standin that records calls.
590
 
 
591
 
    Useful for testing pb using code.
592
 
    """
593
 
 
594
 
    def __init__(self):
595
 
        _BaseProgressBar.__init__(self)
596
 
        self.calls = []
597
 
 
598
 
    def tick(self):
599
 
        self.calls.append(('tick',))
600
 
 
601
 
    def update(self, msg=None, current=None, total=None):
602
 
        self.calls.append(('update', msg, current, total))
603
 
 
604
 
    def clear(self):
605
 
        self.calls.append(('clear',))
606
 
 
607
 
    def note(self, msg, *args):
608
 
        self.calls.append(('note', msg, args))
609
 
 
610
 
 
611
 
class TestTestResult(TestCase):
612
 
 
613
 
    def test_elapsed_time_with_benchmarking(self):
 
699
class TestProfileResult(tests.TestCase):
 
700
 
 
701
    def test_profiles_tests(self):
 
702
        self.requireFeature(test_lsprof.LSProfFeature)
 
703
        terminal = testtools.tests.helpers.ExtendedTestResult()
 
704
        result = tests.ProfileResult(terminal)
 
705
        class Sample(tests.TestCase):
 
706
            def a(self):
 
707
                self.sample_function()
 
708
            def sample_function(self):
 
709
                pass
 
710
        test = Sample("a")
 
711
        test.run(result)
 
712
        case = terminal._events[0][1]
 
713
        self.assertLength(1, case._benchcalls)
 
714
        # We must be able to unpack it as the test reporting code wants
 
715
        (_, _, _), stats = case._benchcalls[0]
 
716
        self.assertTrue(callable(stats.pprint))
 
717
 
 
718
 
 
719
class TestTestResult(tests.TestCase):
 
720
 
 
721
    def check_timing(self, test_case, expected_re):
614
722
        result = bzrlib.tests.TextTestResult(self._log_file,
615
 
                                        descriptions=0,
616
 
                                        verbosity=1,
617
 
                                        )
618
 
        result._recordTestStartTime()
619
 
        time.sleep(0.003)
620
 
        result.extractBenchmarkTime(self)
621
 
        timed_string = result._testTimeString()
622
 
        # without explicit benchmarking, we should get a simple time.
623
 
        self.assertContainsRe(timed_string, "^ +[0-9]+ms$")
624
 
        # if a benchmark time is given, we want a x of y style result.
625
 
        self.time(time.sleep, 0.001)
626
 
        result.extractBenchmarkTime(self)
627
 
        timed_string = result._testTimeString()
628
 
        self.assertContainsRe(
629
 
            timed_string, "^ +[0-9]+ms/ +[0-9]+ms$")
630
 
        # extracting the time from a non-bzrlib testcase sets to None
631
 
        result._recordTestStartTime()
632
 
        result.extractBenchmarkTime(
633
 
            unittest.FunctionTestCase(self.test_elapsed_time_with_benchmarking))
634
 
        timed_string = result._testTimeString()
635
 
        self.assertContainsRe(timed_string, "^ +[0-9]+ms$")
636
 
        # cheat. Yes, wash thy mouth out with soap.
637
 
        self._benchtime = None
 
723
                descriptions=0,
 
724
                verbosity=1,
 
725
                )
 
726
        capture = testtools.tests.helpers.ExtendedTestResult()
 
727
        test_case.run(MultiTestResult(result, capture))
 
728
        run_case = capture._events[0][1]
 
729
        timed_string = result._testTimeString(run_case)
 
730
        self.assertContainsRe(timed_string, expected_re)
 
731
 
 
732
    def test_test_reporting(self):
 
733
        class ShortDelayTestCase(tests.TestCase):
 
734
            def test_short_delay(self):
 
735
                time.sleep(0.003)
 
736
            def test_short_benchmark(self):
 
737
                self.time(time.sleep, 0.003)
 
738
        self.check_timing(ShortDelayTestCase('test_short_delay'),
 
739
                          r"^ +[0-9]+ms$")
 
740
        # if a benchmark time is given, we now show just that time followed by
 
741
        # a star
 
742
        self.check_timing(ShortDelayTestCase('test_short_benchmark'),
 
743
                          r"^ +[0-9]+ms\*$")
 
744
 
 
745
    def test_unittest_reporting_unittest_class(self):
 
746
        # getting the time from a non-bzrlib test works ok
 
747
        class ShortDelayTestCase(unittest.TestCase):
 
748
            def test_short_delay(self):
 
749
                time.sleep(0.003)
 
750
        self.check_timing(ShortDelayTestCase('test_short_delay'),
 
751
                          r"^ +[0-9]+ms$")
 
752
 
 
753
    def _patch_get_bzr_source_tree(self):
 
754
        # Reading from the actual source tree breaks isolation, but we don't
 
755
        # want to assume that thats *all* that would happen.
 
756
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree', lambda: None)
638
757
 
639
758
    def test_assigned_benchmark_file_stores_date(self):
 
759
        self._patch_get_bzr_source_tree()
640
760
        output = StringIO()
641
761
        result = bzrlib.tests.TextTestResult(self._log_file,
642
762
                                        descriptions=0,
644
764
                                        bench_history=output
645
765
                                        )
646
766
        output_string = output.getvalue()
647
 
        
648
767
        # if you are wondering about the regexp please read the comment in
649
768
        # test_bench_history (bzrlib.tests.test_selftest.TestRunner)
650
769
        # XXX: what comment?  -- Andrew Bennetts
651
770
        self.assertContainsRe(output_string, "--date [0-9.]+")
652
771
 
653
772
    def test_benchhistory_records_test_times(self):
 
773
        self._patch_get_bzr_source_tree()
654
774
        result_stream = StringIO()
655
775
        result = bzrlib.tests.TextTestResult(
656
776
            self._log_file,
669
789
        self.assertContainsRe(lines[1],
670
790
            " *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
671
791
            "._time_hello_world_encoding")
672
 
 
 
792
 
673
793
    def _time_hello_world_encoding(self):
674
794
        """Profile two sleep calls
675
 
        
 
795
 
676
796
        This is used to exercise the test framework.
677
797
        """
678
798
        self.time(unicode, 'hello', errors='replace')
680
800
 
681
801
    def test_lsprofiling(self):
682
802
        """Verbose test result prints lsprof statistics from test cases."""
683
 
        try:
684
 
            import bzrlib.lsprof
685
 
        except ImportError:
686
 
            raise TestSkipped("lsprof not installed.")
 
803
        self.requireFeature(test_lsprof.LSProfFeature)
687
804
        result_stream = StringIO()
688
805
        result = bzrlib.tests.VerboseTestResult(
689
806
            unittest._WritelnDecorator(result_stream),
699
816
        # execute the test, which should succeed and record profiles
700
817
        example_test_case.run(result)
701
818
        # lsprofile_something()
702
 
        # if this worked we want 
 
819
        # if this worked we want
703
820
        # LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
704
821
        #    CallCount    Recursive    Total(ms)   Inline(ms) module:lineno(function)
705
822
        # (the lsprof header)
706
823
        # ... an arbitrary number of lines
707
824
        # and the function call which is time.sleep.
708
 
        #           1        0            ???         ???       ???(sleep) 
 
825
        #           1        0            ???         ???       ???(sleep)
709
826
        # and then repeated but with 'world', rather than 'hello'.
710
827
        # this should appear in the output stream of our test result.
711
828
        output = result_stream.getvalue()
720
837
 
721
838
    def test_known_failure(self):
722
839
        """A KnownFailure being raised should trigger several result actions."""
723
 
        class InstrumentedTestResult(ExtendedTestResult):
724
 
 
 
840
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
841
            def stopTestRun(self): pass
 
842
            def startTests(self): pass
725
843
            def report_test_start(self, test): pass
726
 
            def report_known_failure(self, test, err):
727
 
                self._call = test, err
 
844
            def report_known_failure(self, test, err=None, details=None):
 
845
                self._call = test, 'known failure'
728
846
        result = InstrumentedTestResult(None, None, None, None)
729
 
        def test_function():
730
 
            raise KnownFailure('failed!')
731
 
        test = unittest.FunctionTestCase(test_function)
 
847
        class Test(tests.TestCase):
 
848
            def test_function(self):
 
849
                raise tests.KnownFailure('failed!')
 
850
        test = Test("test_function")
732
851
        test.run(result)
733
852
        # it should invoke 'report_known_failure'.
734
853
        self.assertEqual(2, len(result._call))
735
 
        self.assertEqual(test, result._call[0])
736
 
        self.assertEqual(KnownFailure, result._call[1][0])
737
 
        self.assertIsInstance(result._call[1][1], KnownFailure)
 
854
        self.assertEqual(test.id(), result._call[0].id())
 
855
        self.assertEqual('known failure', result._call[1])
738
856
        # we dont introspec the traceback, if the rest is ok, it would be
739
857
        # exceptional for it not to be.
740
858
        # it should update the known_failure_count on the object.
752
870
            )
753
871
        test = self.get_passing_test()
754
872
        result.startTest(test)
755
 
        result.extractBenchmarkTime(test)
756
873
        prefix = len(result_stream.getvalue())
757
874
        # the err parameter has the shape:
758
875
        # (class, exception object, traceback)
759
876
        # KnownFailures dont get their tracebacks shown though, so we
760
877
        # can skip that.
761
 
        err = (KnownFailure, KnownFailure('foo'), None)
 
878
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
762
879
        result.report_known_failure(test, err)
763
880
        output = result_stream.getvalue()[prefix:]
764
881
        lines = output.splitlines()
766
883
        self.assertEqual(lines[1], '    foo')
767
884
        self.assertEqual(2, len(lines))
768
885
 
769
 
    def test_text_report_known_failure(self):
770
 
        # text test output formatting
771
 
        pb = MockProgress()
772
 
        result = bzrlib.tests.TextTestResult(
773
 
            None,
774
 
            descriptions=0,
775
 
            verbosity=1,
776
 
            pb=pb,
777
 
            )
778
 
        test = self.get_passing_test()
779
 
        # this seeds the state to handle reporting the test.
780
 
        result.startTest(test)
781
 
        result.extractBenchmarkTime(test)
782
 
        # the err parameter has the shape:
783
 
        # (class, exception object, traceback)
784
 
        # KnownFailures dont get their tracebacks shown though, so we
785
 
        # can skip that.
786
 
        err = (KnownFailure, KnownFailure('foo'), None)
787
 
        result.report_known_failure(test, err)
788
 
        self.assertEqual(
789
 
            [
790
 
            ('update', '[1 in 0s] passing_test', None, None),
791
 
            ('note', 'XFAIL: %s\n%s\n', ('passing_test', err[1]))
792
 
            ],
793
 
            pb.calls)
794
 
        # known_failures should be printed in the summary, so if we run a test
795
 
        # after there are some known failures, the update prefix should match
796
 
        # this.
797
 
        result.known_failure_count = 3
798
 
        test.run(result)
799
 
        self.assertEqual(
800
 
            [
801
 
            ('update', '[2 in 0s, 3 known failures] passing_test', None, None),
802
 
            ],
803
 
            pb.calls[2:])
804
 
 
805
886
    def get_passing_test(self):
806
887
        """Return a test object that can't be run usefully."""
807
888
        def passing_test():
810
891
 
811
892
    def test_add_not_supported(self):
812
893
        """Test the behaviour of invoking addNotSupported."""
813
 
        class InstrumentedTestResult(ExtendedTestResult):
 
894
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
895
            def stopTestRun(self): pass
 
896
            def startTests(self): pass
814
897
            def report_test_start(self, test): pass
815
898
            def report_unsupported(self, test, feature):
816
899
                self._call = test, feature
817
900
        result = InstrumentedTestResult(None, None, None, None)
818
901
        test = SampleTestCase('_test_pass')
819
 
        feature = Feature()
 
902
        feature = tests.Feature()
820
903
        result.startTest(test)
821
904
        result.addNotSupported(test, feature)
822
905
        # it should invoke 'report_unsupported'.
841
924
            verbosity=2,
842
925
            )
843
926
        test = self.get_passing_test()
844
 
        feature = Feature()
 
927
        feature = tests.Feature()
845
928
        result.startTest(test)
846
 
        result.extractBenchmarkTime(test)
847
929
        prefix = len(result_stream.getvalue())
848
930
        result.report_unsupported(test, feature)
849
931
        output = result_stream.getvalue()[prefix:]
850
932
        lines = output.splitlines()
851
 
        self.assertEqual(lines, ['NODEP                   0ms', "    The feature 'Feature' is not available."])
852
 
    
853
 
    def test_text_report_unsupported(self):
854
 
        # text test output formatting
855
 
        pb = MockProgress()
856
 
        result = bzrlib.tests.TextTestResult(
857
 
            None,
858
 
            descriptions=0,
859
 
            verbosity=1,
860
 
            pb=pb,
861
 
            )
862
 
        test = self.get_passing_test()
863
 
        feature = Feature()
864
 
        # this seeds the state to handle reporting the test.
865
 
        result.startTest(test)
866
 
        result.extractBenchmarkTime(test)
867
 
        result.report_unsupported(test, feature)
868
 
        # no output on unsupported features
869
 
        self.assertEqual(
870
 
            [('update', '[1 in 0s] passing_test', None, None)
871
 
            ],
872
 
            pb.calls)
873
 
        # the number of missing features should be printed in the progress
874
 
        # summary, so check for that.
875
 
        result.unsupported = {'foo':0, 'bar':0}
876
 
        test.run(result)
877
 
        self.assertEqual(
878
 
            [
879
 
            ('update', '[2 in 0s, 2 missing features] passing_test', None, None),
880
 
            ],
881
 
            pb.calls[1:])
882
 
    
 
933
        # We don't check for the final '0ms' since it may fail on slow hosts
 
934
        self.assertStartsWith(lines[0], 'NODEP')
 
935
        self.assertEqual(lines[1],
 
936
                         "    The feature 'Feature' is not available.")
 
937
 
883
938
    def test_unavailable_exception(self):
884
939
        """An UnavailableFeature being raised should invoke addNotSupported."""
885
 
        class InstrumentedTestResult(ExtendedTestResult):
886
 
 
 
940
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
941
            def stopTestRun(self): pass
 
942
            def startTests(self): pass
887
943
            def report_test_start(self, test): pass
888
944
            def addNotSupported(self, test, feature):
889
945
                self._call = test, feature
890
946
        result = InstrumentedTestResult(None, None, None, None)
891
 
        feature = Feature()
892
 
        def test_function():
893
 
            raise UnavailableFeature(feature)
894
 
        test = unittest.FunctionTestCase(test_function)
 
947
        feature = tests.Feature()
 
948
        class Test(tests.TestCase):
 
949
            def test_function(self):
 
950
                raise tests.UnavailableFeature(feature)
 
951
        test = Test("test_function")
895
952
        test.run(result)
896
953
        # it should invoke 'addNotSupported'.
897
954
        self.assertEqual(2, len(result._call))
898
 
        self.assertEqual(test, result._call[0])
 
955
        self.assertEqual(test.id(), result._call[0].id())
899
956
        self.assertEqual(feature, result._call[1])
900
957
        # and not count as an error
901
958
        self.assertEqual(0, result.error_count)
902
959
 
903
 
 
904
 
class TestRunner(TestCase):
 
960
    def test_strict_with_unsupported_feature(self):
 
961
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
962
                                             verbosity=1)
 
963
        test = self.get_passing_test()
 
964
        feature = "Unsupported Feature"
 
965
        result.addNotSupported(test, feature)
 
966
        self.assertFalse(result.wasStrictlySuccessful())
 
967
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
968
 
 
969
    def test_strict_with_known_failure(self):
 
970
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
971
                                             verbosity=1)
 
972
        test = self.get_passing_test()
 
973
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
 
974
        result.addExpectedFailure(test, err)
 
975
        self.assertFalse(result.wasStrictlySuccessful())
 
976
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
977
 
 
978
    def test_strict_with_success(self):
 
979
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
980
                                             verbosity=1)
 
981
        test = self.get_passing_test()
 
982
        result.addSuccess(test)
 
983
        self.assertTrue(result.wasStrictlySuccessful())
 
984
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
985
 
 
986
    def test_startTests(self):
 
987
        """Starting the first test should trigger startTests."""
 
988
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
989
            calls = 0
 
990
            def startTests(self): self.calls += 1
 
991
            def report_test_start(self, test): pass
 
992
        result = InstrumentedTestResult(None, None, None, None)
 
993
        def test_function():
 
994
            pass
 
995
        test = unittest.FunctionTestCase(test_function)
 
996
        test.run(result)
 
997
        self.assertEquals(1, result.calls)
 
998
 
 
999
 
 
1000
class TestUnicodeFilenameFeature(tests.TestCase):
 
1001
 
 
1002
    def test_probe_passes(self):
 
1003
        """UnicodeFilenameFeature._probe passes."""
 
1004
        # We can't test much more than that because the behaviour depends
 
1005
        # on the platform.
 
1006
        tests.UnicodeFilenameFeature._probe()
 
1007
 
 
1008
 
 
1009
class TestRunner(tests.TestCase):
905
1010
 
906
1011
    def dummy_test(self):
907
1012
        pass
911
1016
 
912
1017
        This current saves and restores:
913
1018
        TestCaseInTempDir.TEST_ROOT
914
 
        
915
 
        There should be no tests in this file that use bzrlib.tests.TextTestRunner
916
 
        without using this convenience method, because of our use of global state.
 
1019
 
 
1020
        There should be no tests in this file that use
 
1021
        bzrlib.tests.TextTestRunner without using this convenience method,
 
1022
        because of our use of global state.
917
1023
        """
918
 
        old_root = TestCaseInTempDir.TEST_ROOT
 
1024
        old_root = tests.TestCaseInTempDir.TEST_ROOT
 
1025
        old_leak = tests.TestCase._first_thread_leaker_id
919
1026
        try:
920
 
            TestCaseInTempDir.TEST_ROOT = None
 
1027
            tests.TestCaseInTempDir.TEST_ROOT = None
 
1028
            tests.TestCase._first_thread_leaker_id = None
921
1029
            return testrunner.run(test)
922
1030
        finally:
923
 
            TestCaseInTempDir.TEST_ROOT = old_root
 
1031
            tests.TestCaseInTempDir.TEST_ROOT = old_root
 
1032
            tests.TestCase._first_thread_leaker_id = old_leak
924
1033
 
925
1034
    def test_known_failure_failed_run(self):
926
1035
        # run a test that generates a known failure which should be printed in
927
1036
        # the final output when real failures occur.
928
 
        def known_failure_test():
929
 
            raise KnownFailure('failed')
 
1037
        class Test(tests.TestCase):
 
1038
            def known_failure_test(self):
 
1039
                self.expectFailure('failed', self.assertTrue, False)
930
1040
        test = unittest.TestSuite()
931
 
        test.addTest(unittest.FunctionTestCase(known_failure_test))
 
1041
        test.addTest(Test("known_failure_test"))
932
1042
        def failing_test():
933
 
            raise AssertionError('foo')
 
1043
            self.fail('foo')
934
1044
        test.addTest(unittest.FunctionTestCase(failing_test))
935
1045
        stream = StringIO()
936
 
        runner = TextTestRunner(stream=stream)
 
1046
        runner = tests.TextTestRunner(stream=stream)
937
1047
        result = self.run_test_runner(runner, test)
938
1048
        lines = stream.getvalue().splitlines()
939
 
        self.assertEqual([
940
 
            '',
941
 
            '======================================================================',
942
 
            'FAIL: unittest.FunctionTestCase (failing_test)',
943
 
            '----------------------------------------------------------------------',
944
 
            'Traceback (most recent call last):',
945
 
            '    raise AssertionError(\'foo\')',
946
 
            'AssertionError: foo',
947
 
            '',
948
 
            '----------------------------------------------------------------------',
949
 
            '',
950
 
            'FAILED (failures=1, known_failure_count=1)'],
951
 
            lines[0:5] + lines[6:10] + lines[11:])
 
1049
        self.assertContainsRe(stream.getvalue(),
 
1050
            '(?sm)^bzr selftest.*$'
 
1051
            '.*'
 
1052
            '^======================================================================\n'
 
1053
            '^FAIL: failing_test\n'
 
1054
            '^----------------------------------------------------------------------\n'
 
1055
            'Traceback \\(most recent call last\\):\n'
 
1056
            '  .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
 
1057
            '    self.fail\\(\'foo\'\\)\n'
 
1058
            '.*'
 
1059
            '^----------------------------------------------------------------------\n'
 
1060
            '.*'
 
1061
            'FAILED \\(failures=1, known_failure_count=1\\)'
 
1062
            )
952
1063
 
953
1064
    def test_known_failure_ok_run(self):
954
 
        # run a test that generates a known failure which should be printed in the final output.
955
 
        def known_failure_test():
956
 
            raise KnownFailure('failed')
957
 
        test = unittest.FunctionTestCase(known_failure_test)
 
1065
        # run a test that generates a known failure which should be printed in
 
1066
        # the final output.
 
1067
        class Test(tests.TestCase):
 
1068
            def known_failure_test(self):
 
1069
                self.expectFailure('failed', self.assertTrue, False)
 
1070
        test = Test("known_failure_test")
958
1071
        stream = StringIO()
959
 
        runner = TextTestRunner(stream=stream)
 
1072
        runner = tests.TextTestRunner(stream=stream)
960
1073
        result = self.run_test_runner(runner, test)
961
1074
        self.assertContainsRe(stream.getvalue(),
962
1075
            '\n'
965
1078
            '\n'
966
1079
            'OK \\(known_failures=1\\)\n')
967
1080
 
 
1081
    def test_result_decorator(self):
 
1082
        # decorate results
 
1083
        calls = []
 
1084
        class LoggingDecorator(tests.ForwardingResult):
 
1085
            def startTest(self, test):
 
1086
                tests.ForwardingResult.startTest(self, test)
 
1087
                calls.append('start')
 
1088
        test = unittest.FunctionTestCase(lambda:None)
 
1089
        stream = StringIO()
 
1090
        runner = tests.TextTestRunner(stream=stream,
 
1091
            result_decorators=[LoggingDecorator])
 
1092
        result = self.run_test_runner(runner, test)
 
1093
        self.assertLength(1, calls)
 
1094
 
968
1095
    def test_skipped_test(self):
969
1096
        # run a test that is skipped, and check the suite as a whole still
970
1097
        # succeeds.
971
1098
        # skipping_test must be hidden in here so it's not run as a real test
972
 
        def skipping_test():
973
 
            raise TestSkipped('test intentionally skipped')
974
 
 
975
 
        runner = TextTestRunner(stream=self._log_file, keep_output=True)
976
 
        test = unittest.FunctionTestCase(skipping_test)
 
1099
        class SkippingTest(tests.TestCase):
 
1100
            def skipping_test(self):
 
1101
                raise tests.TestSkipped('test intentionally skipped')
 
1102
        runner = tests.TextTestRunner(stream=self._log_file)
 
1103
        test = SkippingTest("skipping_test")
977
1104
        result = self.run_test_runner(runner, test)
978
1105
        self.assertTrue(result.wasSuccessful())
979
1106
 
980
1107
    def test_skipped_from_setup(self):
981
 
        class SkippedSetupTest(TestCase):
 
1108
        calls = []
 
1109
        class SkippedSetupTest(tests.TestCase):
982
1110
 
983
1111
            def setUp(self):
984
 
                self.counter = 1
 
1112
                calls.append('setUp')
985
1113
                self.addCleanup(self.cleanup)
986
 
                raise TestSkipped('skipped setup')
 
1114
                raise tests.TestSkipped('skipped setup')
987
1115
 
988
1116
            def test_skip(self):
989
1117
                self.fail('test reached')
990
1118
 
991
1119
            def cleanup(self):
992
 
                self.counter -= 1
 
1120
                calls.append('cleanup')
993
1121
 
994
 
        runner = TextTestRunner(stream=self._log_file, keep_output=True)
 
1122
        runner = tests.TextTestRunner(stream=self._log_file)
995
1123
        test = SkippedSetupTest('test_skip')
996
1124
        result = self.run_test_runner(runner, test)
997
1125
        self.assertTrue(result.wasSuccessful())
998
1126
        # Check if cleanup was called the right number of times.
999
 
        self.assertEqual(0, test.counter)
 
1127
        self.assertEqual(['setUp', 'cleanup'], calls)
1000
1128
 
1001
1129
    def test_skipped_from_test(self):
1002
 
        class SkippedTest(TestCase):
 
1130
        calls = []
 
1131
        class SkippedTest(tests.TestCase):
1003
1132
 
1004
1133
            def setUp(self):
1005
 
                self.counter = 1
 
1134
                tests.TestCase.setUp(self)
 
1135
                calls.append('setUp')
1006
1136
                self.addCleanup(self.cleanup)
1007
1137
 
1008
1138
            def test_skip(self):
1009
 
                raise TestSkipped('skipped test')
 
1139
                raise tests.TestSkipped('skipped test')
1010
1140
 
1011
1141
            def cleanup(self):
1012
 
                self.counter -= 1
 
1142
                calls.append('cleanup')
1013
1143
 
1014
 
        runner = TextTestRunner(stream=self._log_file, keep_output=True)
 
1144
        runner = tests.TextTestRunner(stream=self._log_file)
1015
1145
        test = SkippedTest('test_skip')
1016
1146
        result = self.run_test_runner(runner, test)
1017
1147
        self.assertTrue(result.wasSuccessful())
1018
1148
        # Check if cleanup was called the right number of times.
1019
 
        self.assertEqual(0, test.counter)
 
1149
        self.assertEqual(['setUp', 'cleanup'], calls)
 
1150
 
 
1151
    def test_not_applicable(self):
 
1152
        # run a test that is skipped because it's not applicable
 
1153
        class Test(tests.TestCase):
 
1154
            def not_applicable_test(self):
 
1155
                raise tests.TestNotApplicable('this test never runs')
 
1156
        out = StringIO()
 
1157
        runner = tests.TextTestRunner(stream=out, verbosity=2)
 
1158
        test = Test("not_applicable_test")
 
1159
        result = self.run_test_runner(runner, test)
 
1160
        self._log_file.write(out.getvalue())
 
1161
        self.assertTrue(result.wasSuccessful())
 
1162
        self.assertTrue(result.wasStrictlySuccessful())
 
1163
        self.assertContainsRe(out.getvalue(),
 
1164
                r'(?m)not_applicable_test   * N/A')
 
1165
        self.assertContainsRe(out.getvalue(),
 
1166
                r'(?m)^    this test never runs')
1020
1167
 
1021
1168
    def test_unsupported_features_listed(self):
1022
1169
        """When unsupported features are encountered they are detailed."""
1023
 
        class Feature1(Feature):
 
1170
        class Feature1(tests.Feature):
1024
1171
            def _probe(self): return False
1025
 
        class Feature2(Feature):
 
1172
        class Feature2(tests.Feature):
1026
1173
            def _probe(self): return False
1027
1174
        # create sample tests
1028
1175
        test1 = SampleTestCase('_test_pass')
1033
1180
        test.addTest(test1)
1034
1181
        test.addTest(test2)
1035
1182
        stream = StringIO()
1036
 
        runner = TextTestRunner(stream=stream)
 
1183
        runner = tests.TextTestRunner(stream=stream)
1037
1184
        result = self.run_test_runner(runner, test)
1038
1185
        lines = stream.getvalue().splitlines()
1039
1186
        self.assertEqual([
1043
1190
            ],
1044
1191
            lines[-3:])
1045
1192
 
 
1193
    def _patch_get_bzr_source_tree(self):
 
1194
        # Reading from the actual source tree breaks isolation, but we don't
 
1195
        # want to assume that thats *all* that would happen.
 
1196
        self._get_source_tree_calls = []
 
1197
        def new_get():
 
1198
            self._get_source_tree_calls.append("called")
 
1199
            return None
 
1200
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree',  new_get)
 
1201
 
1046
1202
    def test_bench_history(self):
1047
 
        # tests that the running the benchmark produces a history file
1048
 
        # containing a timestamp and the revision id of the bzrlib source which
1049
 
        # was tested.
1050
 
        workingtree = _get_bzr_source_tree()
 
1203
        # tests that the running the benchmark passes bench_history into
 
1204
        # the test result object. We can tell that happens if
 
1205
        # _get_bzr_source_tree is called.
 
1206
        self._patch_get_bzr_source_tree()
1051
1207
        test = TestRunner('dummy_test')
1052
1208
        output = StringIO()
1053
 
        runner = TextTestRunner(stream=self._log_file, bench_history=output)
 
1209
        runner = tests.TextTestRunner(stream=self._log_file,
 
1210
                                      bench_history=output)
1054
1211
        result = self.run_test_runner(runner, test)
1055
1212
        output_string = output.getvalue()
1056
1213
        self.assertContainsRe(output_string, "--date [0-9.]+")
1057
 
        if workingtree is not None:
1058
 
            revision_id = workingtree.get_parent_ids()[0]
1059
 
            self.assertEndsWith(output_string.rstrip(), revision_id)
1060
 
 
1061
 
    def test_success_log_deleted(self):
1062
 
        """Successful tests have their log deleted"""
1063
 
 
1064
 
        class LogTester(TestCase):
1065
 
 
1066
 
            def test_success(self):
1067
 
                self.log('this will be removed\n')
1068
 
 
1069
 
        sio = cStringIO.StringIO()
1070
 
        runner = TextTestRunner(stream=sio)
1071
 
        test = LogTester('test_success')
1072
 
        result = self.run_test_runner(runner, test)
1073
 
 
1074
 
        log = test._get_log()
1075
 
        self.assertEqual("DELETED log file to reduce memory footprint", log)
1076
 
        self.assertEqual('', test._log_contents)
1077
 
        self.assertIs(None, test._log_file_name)
1078
 
 
1079
 
    def test_fail_log_kept(self):
1080
 
        """Failed tests have their log kept"""
1081
 
 
1082
 
        class LogTester(TestCase):
1083
 
 
1084
 
            def test_fail(self):
1085
 
                self.log('this will be kept\n')
1086
 
                self.fail('this test fails')
1087
 
 
1088
 
        sio = cStringIO.StringIO()
1089
 
        runner = TextTestRunner(stream=sio)
1090
 
        test = LogTester('test_fail')
1091
 
        result = self.run_test_runner(runner, test)
1092
 
 
1093
 
        text = sio.getvalue()
1094
 
        self.assertContainsRe(text, 'this will be kept')
1095
 
        self.assertContainsRe(text, 'this test fails')
1096
 
 
1097
 
        log = test._get_log()
1098
 
        self.assertContainsRe(log, 'this will be kept')
1099
 
        self.assertEqual(log, test._log_contents)
1100
 
 
1101
 
    def test_error_log_kept(self):
1102
 
        """Tests with errors have their log kept"""
1103
 
 
1104
 
        class LogTester(TestCase):
1105
 
 
1106
 
            def test_error(self):
1107
 
                self.log('this will be kept\n')
1108
 
                raise ValueError('random exception raised')
1109
 
 
1110
 
        sio = cStringIO.StringIO()
1111
 
        runner = TextTestRunner(stream=sio)
1112
 
        test = LogTester('test_error')
1113
 
        result = self.run_test_runner(runner, test)
1114
 
 
1115
 
        text = sio.getvalue()
1116
 
        self.assertContainsRe(text, 'this will be kept')
1117
 
        self.assertContainsRe(text, 'random exception raised')
1118
 
 
1119
 
        log = test._get_log()
1120
 
        self.assertContainsRe(log, 'this will be kept')
1121
 
        self.assertEqual(log, test._log_contents)
1122
 
 
1123
 
 
1124
 
class SampleTestCase(TestCase):
 
1214
        self.assertLength(1, self._get_source_tree_calls)
 
1215
 
 
1216
    def test_startTestRun(self):
 
1217
        """run should call result.startTestRun()"""
 
1218
        calls = []
 
1219
        class LoggingDecorator(tests.ForwardingResult):
 
1220
            def startTestRun(self):
 
1221
                tests.ForwardingResult.startTestRun(self)
 
1222
                calls.append('startTestRun')
 
1223
        test = unittest.FunctionTestCase(lambda:None)
 
1224
        stream = StringIO()
 
1225
        runner = tests.TextTestRunner(stream=stream,
 
1226
            result_decorators=[LoggingDecorator])
 
1227
        result = self.run_test_runner(runner, test)
 
1228
        self.assertLength(1, calls)
 
1229
 
 
1230
    def test_stopTestRun(self):
 
1231
        """run should call result.stopTestRun()"""
 
1232
        calls = []
 
1233
        class LoggingDecorator(tests.ForwardingResult):
 
1234
            def stopTestRun(self):
 
1235
                tests.ForwardingResult.stopTestRun(self)
 
1236
                calls.append('stopTestRun')
 
1237
        test = unittest.FunctionTestCase(lambda:None)
 
1238
        stream = StringIO()
 
1239
        runner = tests.TextTestRunner(stream=stream,
 
1240
            result_decorators=[LoggingDecorator])
 
1241
        result = self.run_test_runner(runner, test)
 
1242
        self.assertLength(1, calls)
 
1243
 
 
1244
 
 
1245
class SampleTestCase(tests.TestCase):
1125
1246
 
1126
1247
    def _test_pass(self):
1127
1248
        pass
1128
1249
 
1129
 
 
1130
 
class TestTestCase(TestCase):
 
1250
class _TestException(Exception):
 
1251
    pass
 
1252
 
 
1253
 
 
1254
class TestTestCase(tests.TestCase):
1131
1255
    """Tests that test the core bzrlib TestCase."""
1132
1256
 
 
1257
    def test_assertLength_matches_empty(self):
 
1258
        a_list = []
 
1259
        self.assertLength(0, a_list)
 
1260
 
 
1261
    def test_assertLength_matches_nonempty(self):
 
1262
        a_list = [1, 2, 3]
 
1263
        self.assertLength(3, a_list)
 
1264
 
 
1265
    def test_assertLength_fails_different(self):
 
1266
        a_list = []
 
1267
        self.assertRaises(AssertionError, self.assertLength, 1, a_list)
 
1268
 
 
1269
    def test_assertLength_shows_sequence_in_failure(self):
 
1270
        a_list = [1, 2, 3]
 
1271
        exception = self.assertRaises(AssertionError, self.assertLength, 2,
 
1272
            a_list)
 
1273
        self.assertEqual('Incorrect length: wanted 2, got 3 for [1, 2, 3]',
 
1274
            exception.args[0])
 
1275
 
 
1276
    def test_base_setUp_not_called_causes_failure(self):
 
1277
        class TestCaseWithBrokenSetUp(tests.TestCase):
 
1278
            def setUp(self):
 
1279
                pass # does not call TestCase.setUp
 
1280
            def test_foo(self):
 
1281
                pass
 
1282
        test = TestCaseWithBrokenSetUp('test_foo')
 
1283
        result = unittest.TestResult()
 
1284
        test.run(result)
 
1285
        self.assertFalse(result.wasSuccessful())
 
1286
        self.assertEqual(1, result.testsRun)
 
1287
 
 
1288
    def test_base_tearDown_not_called_causes_failure(self):
 
1289
        class TestCaseWithBrokenTearDown(tests.TestCase):
 
1290
            def tearDown(self):
 
1291
                pass # does not call TestCase.tearDown
 
1292
            def test_foo(self):
 
1293
                pass
 
1294
        test = TestCaseWithBrokenTearDown('test_foo')
 
1295
        result = unittest.TestResult()
 
1296
        test.run(result)
 
1297
        self.assertFalse(result.wasSuccessful())
 
1298
        self.assertEqual(1, result.testsRun)
 
1299
 
 
1300
    def test_debug_flags_sanitised(self):
 
1301
        """The bzrlib debug flags should be sanitised by setUp."""
 
1302
        if 'allow_debug' in tests.selftest_debug_flags:
 
1303
            raise tests.TestNotApplicable(
 
1304
                '-Eallow_debug option prevents debug flag sanitisation')
 
1305
        # we could set something and run a test that will check
 
1306
        # it gets santised, but this is probably sufficient for now:
 
1307
        # if someone runs the test with -Dsomething it will error.
 
1308
        flags = set()
 
1309
        if self._lock_check_thorough:
 
1310
            flags.add('strict_locks')
 
1311
        self.assertEqual(flags, bzrlib.debug.debug_flags)
 
1312
 
 
1313
    def change_selftest_debug_flags(self, new_flags):
 
1314
        self.overrideAttr(tests, 'selftest_debug_flags', set(new_flags))
 
1315
 
 
1316
    def test_allow_debug_flag(self):
 
1317
        """The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
 
1318
        sanitised (i.e. cleared) before running a test.
 
1319
        """
 
1320
        self.change_selftest_debug_flags(set(['allow_debug']))
 
1321
        bzrlib.debug.debug_flags = set(['a-flag'])
 
1322
        class TestThatRecordsFlags(tests.TestCase):
 
1323
            def test_foo(nested_self):
 
1324
                self.flags = set(bzrlib.debug.debug_flags)
 
1325
        test = TestThatRecordsFlags('test_foo')
 
1326
        test.run(self.make_test_result())
 
1327
        flags = set(['a-flag'])
 
1328
        if 'disable_lock_checks' not in tests.selftest_debug_flags:
 
1329
            flags.add('strict_locks')
 
1330
        self.assertEqual(flags, self.flags)
 
1331
 
 
1332
    def test_disable_lock_checks(self):
 
1333
        """The -Edisable_lock_checks flag disables thorough checks."""
 
1334
        class TestThatRecordsFlags(tests.TestCase):
 
1335
            def test_foo(nested_self):
 
1336
                self.flags = set(bzrlib.debug.debug_flags)
 
1337
                self.test_lock_check_thorough = nested_self._lock_check_thorough
 
1338
        self.change_selftest_debug_flags(set())
 
1339
        test = TestThatRecordsFlags('test_foo')
 
1340
        test.run(self.make_test_result())
 
1341
        # By default we do strict lock checking and thorough lock/unlock
 
1342
        # tracking.
 
1343
        self.assertTrue(self.test_lock_check_thorough)
 
1344
        self.assertEqual(set(['strict_locks']), self.flags)
 
1345
        # Now set the disable_lock_checks flag, and show that this changed.
 
1346
        self.change_selftest_debug_flags(set(['disable_lock_checks']))
 
1347
        test = TestThatRecordsFlags('test_foo')
 
1348
        test.run(self.make_test_result())
 
1349
        self.assertFalse(self.test_lock_check_thorough)
 
1350
        self.assertEqual(set(), self.flags)
 
1351
 
 
1352
    def test_this_fails_strict_lock_check(self):
 
1353
        class TestThatRecordsFlags(tests.TestCase):
 
1354
            def test_foo(nested_self):
 
1355
                self.flags1 = set(bzrlib.debug.debug_flags)
 
1356
                self.thisFailsStrictLockCheck()
 
1357
                self.flags2 = set(bzrlib.debug.debug_flags)
 
1358
        # Make sure lock checking is active
 
1359
        self.change_selftest_debug_flags(set())
 
1360
        test = TestThatRecordsFlags('test_foo')
 
1361
        test.run(self.make_test_result())
 
1362
        self.assertEqual(set(['strict_locks']), self.flags1)
 
1363
        self.assertEqual(set(), self.flags2)
 
1364
 
 
1365
    def test_debug_flags_restored(self):
 
1366
        """The bzrlib debug flags should be restored to their original state
 
1367
        after the test was run, even if allow_debug is set.
 
1368
        """
 
1369
        self.change_selftest_debug_flags(set(['allow_debug']))
 
1370
        # Now run a test that modifies debug.debug_flags.
 
1371
        bzrlib.debug.debug_flags = set(['original-state'])
 
1372
        class TestThatModifiesFlags(tests.TestCase):
 
1373
            def test_foo(self):
 
1374
                bzrlib.debug.debug_flags = set(['modified'])
 
1375
        test = TestThatModifiesFlags('test_foo')
 
1376
        test.run(self.make_test_result())
 
1377
        self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
 
1378
 
 
1379
    def make_test_result(self):
 
1380
        """Get a test result that writes to the test log file."""
 
1381
        return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
 
1382
 
1133
1383
    def inner_test(self):
1134
1384
        # the inner child test
1135
1385
        note("inner_test")
1138
1388
        # the outer child test
1139
1389
        note("outer_start")
1140
1390
        self.inner_test = TestTestCase("inner_child")
1141
 
        result = bzrlib.tests.TextTestResult(self._log_file,
1142
 
                                        descriptions=0,
1143
 
                                        verbosity=1)
 
1391
        result = self.make_test_result()
1144
1392
        self.inner_test.run(result)
1145
1393
        note("outer finish")
 
1394
        self.addCleanup(osutils.delete_any, self._log_file_name)
1146
1395
 
1147
1396
    def test_trace_nesting(self):
1148
1397
        # this tests that each test case nests its trace facility correctly.
1150
1399
        # should setup a new log, log content to it, setup a child case (B),
1151
1400
        # which should log independently, then case (A) should log a trailer
1152
1401
        # and return.
1153
 
        # we do two nested children so that we can verify the state of the 
 
1402
        # we do two nested children so that we can verify the state of the
1154
1403
        # logs after the outer child finishes is correct, which a bad clean
1155
1404
        # up routine in tearDown might trigger a fault in our test with only
1156
1405
        # one child, we should instead see the bad result inside our test with
1158
1407
        # the outer child test
1159
1408
        original_trace = bzrlib.trace._trace_file
1160
1409
        outer_test = TestTestCase("outer_child")
1161
 
        result = bzrlib.tests.TextTestResult(self._log_file,
1162
 
                                        descriptions=0,
1163
 
                                        verbosity=1)
 
1410
        result = self.make_test_result()
1164
1411
        outer_test.run(result)
1165
1412
        self.assertEqual(original_trace, bzrlib.trace._trace_file)
1166
1413
 
1176
1423
        result = bzrlib.tests.VerboseTestResult(
1177
1424
            unittest._WritelnDecorator(output_stream),
1178
1425
            descriptions=0,
1179
 
            verbosity=2,
1180
 
            num_tests=sample_test.countTestCases())
 
1426
            verbosity=2)
1181
1427
        sample_test.run(result)
1182
1428
        self.assertContainsRe(
1183
1429
            output_stream.getvalue(),
1184
 
            r"\d+ms/ +\d+ms\n$")
 
1430
            r"\d+ms\*\n$")
1185
1431
 
1186
1432
    def test_hooks_sanitised(self):
1187
1433
        """The bzrlib hooks should be sanitised by setUp."""
 
1434
        # Note this test won't fail with hooks that the core library doesn't
 
1435
        # use - but it trigger with a plugin that adds hooks, so its still a
 
1436
        # useful warning in that case.
1188
1437
        self.assertEqual(bzrlib.branch.BranchHooks(),
1189
1438
            bzrlib.branch.Branch.hooks)
1190
1439
        self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
1191
1440
            bzrlib.smart.server.SmartTCPServer.hooks)
 
1441
        self.assertEqual(bzrlib.commands.CommandHooks(),
 
1442
            bzrlib.commands.Command.hooks)
1192
1443
 
1193
1444
    def test__gather_lsprof_in_benchmarks(self):
1194
1445
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1195
 
        
 
1446
 
1196
1447
        Each self.time() call is individually and separately profiled.
1197
1448
        """
1198
 
        try:
1199
 
            import bzrlib.lsprof
1200
 
        except ImportError:
1201
 
            raise TestSkipped("lsprof not installed.")
1202
 
        # overrides the class member with an instance member so no cleanup 
 
1449
        self.requireFeature(test_lsprof.LSProfFeature)
 
1450
        # overrides the class member with an instance member so no cleanup
1203
1451
        # needed.
1204
1452
        self._gather_lsprof_in_benchmarks = True
1205
1453
        self.time(time.sleep, 0.000)
1209
1457
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1210
1458
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1211
1459
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
 
1460
        del self._benchcalls[:]
1212
1461
 
1213
1462
    def test_knownFailure(self):
1214
1463
        """Self.knownFailure() should raise a KnownFailure exception."""
1215
 
        self.assertRaises(KnownFailure, self.knownFailure, "A Failure")
 
1464
        self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
 
1465
 
 
1466
    def test_open_bzrdir_safe_roots(self):
 
1467
        # even a memory transport should fail to open when its url isn't 
 
1468
        # permitted.
 
1469
        # Manually set one up (TestCase doesn't and shouldn't provide magic
 
1470
        # machinery)
 
1471
        transport_server = memory.MemoryServer()
 
1472
        transport_server.start_server()
 
1473
        self.addCleanup(transport_server.stop_server)
 
1474
        t = transport.get_transport(transport_server.get_url())
 
1475
        bzrdir.BzrDir.create(t.base)
 
1476
        self.assertRaises(errors.BzrError,
 
1477
            bzrdir.BzrDir.open_from_transport, t)
 
1478
        # But if we declare this as safe, we can open the bzrdir.
 
1479
        self.permit_url(t.base)
 
1480
        self._bzr_selftest_roots.append(t.base)
 
1481
        bzrdir.BzrDir.open_from_transport(t)
1216
1482
 
1217
1483
    def test_requireFeature_available(self):
1218
1484
        """self.requireFeature(available) is a no-op."""
1219
 
        class Available(Feature):
 
1485
        class Available(tests.Feature):
1220
1486
            def _probe(self):return True
1221
1487
        feature = Available()
1222
1488
        self.requireFeature(feature)
1223
1489
 
1224
1490
    def test_requireFeature_unavailable(self):
1225
1491
        """self.requireFeature(unavailable) raises UnavailableFeature."""
1226
 
        class Unavailable(Feature):
 
1492
        class Unavailable(tests.Feature):
1227
1493
            def _probe(self):return False
1228
1494
        feature = Unavailable()
1229
 
        self.assertRaises(UnavailableFeature, self.requireFeature, feature)
 
1495
        self.assertRaises(tests.UnavailableFeature,
 
1496
                          self.requireFeature, feature)
1230
1497
 
1231
1498
    def test_run_no_parameters(self):
1232
1499
        test = SampleTestCase('_test_pass')
1233
1500
        test.run()
1234
 
    
 
1501
 
1235
1502
    def test_run_enabled_unittest_result(self):
1236
1503
        """Test we revert to regular behaviour when the test is enabled."""
1237
1504
        test = SampleTestCase('_test_pass')
1262
1529
        """Test disabled tests behaviour with support aware results."""
1263
1530
        test = SampleTestCase('_test_pass')
1264
1531
        class DisabledFeature(object):
 
1532
            def __eq__(self, other):
 
1533
                return isinstance(other, DisabledFeature)
1265
1534
            def available(self):
1266
1535
                return False
1267
1536
        the_feature = DisabledFeature()
1278
1547
                self.calls.append(('addNotSupported', test, feature))
1279
1548
        result = InstrumentedTestResult()
1280
1549
        test.run(result)
 
1550
        case = result.calls[0][1]
1281
1551
        self.assertEqual([
1282
 
            ('startTest', test),
1283
 
            ('addNotSupported', test, the_feature),
1284
 
            ('stopTest', test),
 
1552
            ('startTest', case),
 
1553
            ('addNotSupported', case, the_feature),
 
1554
            ('stopTest', case),
1285
1555
            ],
1286
1556
            result.calls)
1287
1557
 
1288
 
 
1289
 
@symbol_versioning.deprecated_function(zero_eleven)
 
1558
    def test_start_server_registers_url(self):
 
1559
        transport_server = memory.MemoryServer()
 
1560
        # A little strict, but unlikely to be changed soon.
 
1561
        self.assertEqual([], self._bzr_selftest_roots)
 
1562
        self.start_server(transport_server)
 
1563
        self.assertSubset([transport_server.get_url()],
 
1564
            self._bzr_selftest_roots)
 
1565
 
 
1566
    def test_assert_list_raises_on_generator(self):
 
1567
        def generator_which_will_raise():
 
1568
            # This will not raise until after the first yield
 
1569
            yield 1
 
1570
            raise _TestException()
 
1571
 
 
1572
        e = self.assertListRaises(_TestException, generator_which_will_raise)
 
1573
        self.assertIsInstance(e, _TestException)
 
1574
 
 
1575
        e = self.assertListRaises(Exception, generator_which_will_raise)
 
1576
        self.assertIsInstance(e, _TestException)
 
1577
 
 
1578
    def test_assert_list_raises_on_plain(self):
 
1579
        def plain_exception():
 
1580
            raise _TestException()
 
1581
            return []
 
1582
 
 
1583
        e = self.assertListRaises(_TestException, plain_exception)
 
1584
        self.assertIsInstance(e, _TestException)
 
1585
 
 
1586
        e = self.assertListRaises(Exception, plain_exception)
 
1587
        self.assertIsInstance(e, _TestException)
 
1588
 
 
1589
    def test_assert_list_raises_assert_wrong_exception(self):
 
1590
        class _NotTestException(Exception):
 
1591
            pass
 
1592
 
 
1593
        def wrong_exception():
 
1594
            raise _NotTestException()
 
1595
 
 
1596
        def wrong_exception_generator():
 
1597
            yield 1
 
1598
            yield 2
 
1599
            raise _NotTestException()
 
1600
 
 
1601
        # Wrong exceptions are not intercepted
 
1602
        self.assertRaises(_NotTestException,
 
1603
            self.assertListRaises, _TestException, wrong_exception)
 
1604
        self.assertRaises(_NotTestException,
 
1605
            self.assertListRaises, _TestException, wrong_exception_generator)
 
1606
 
 
1607
    def test_assert_list_raises_no_exception(self):
 
1608
        def success():
 
1609
            return []
 
1610
 
 
1611
        def success_generator():
 
1612
            yield 1
 
1613
            yield 2
 
1614
 
 
1615
        self.assertRaises(AssertionError,
 
1616
            self.assertListRaises, _TestException, success)
 
1617
 
 
1618
        self.assertRaises(AssertionError,
 
1619
            self.assertListRaises, _TestException, success_generator)
 
1620
 
 
1621
    def test_overrideAttr_without_value(self):
 
1622
        self.test_attr = 'original' # Define a test attribute
 
1623
        obj = self # Make 'obj' visible to the embedded test
 
1624
        class Test(tests.TestCase):
 
1625
 
 
1626
            def setUp(self):
 
1627
                tests.TestCase.setUp(self)
 
1628
                self.orig = self.overrideAttr(obj, 'test_attr')
 
1629
 
 
1630
            def test_value(self):
 
1631
                self.assertEqual('original', self.orig)
 
1632
                self.assertEqual('original', obj.test_attr)
 
1633
                obj.test_attr = 'modified'
 
1634
                self.assertEqual('modified', obj.test_attr)
 
1635
 
 
1636
        test = Test('test_value')
 
1637
        test.run(unittest.TestResult())
 
1638
        self.assertEqual('original', obj.test_attr)
 
1639
 
 
1640
    def test_overrideAttr_with_value(self):
 
1641
        self.test_attr = 'original' # Define a test attribute
 
1642
        obj = self # Make 'obj' visible to the embedded test
 
1643
        class Test(tests.TestCase):
 
1644
 
 
1645
            def setUp(self):
 
1646
                tests.TestCase.setUp(self)
 
1647
                self.orig = self.overrideAttr(obj, 'test_attr', new='modified')
 
1648
 
 
1649
            def test_value(self):
 
1650
                self.assertEqual('original', self.orig)
 
1651
                self.assertEqual('modified', obj.test_attr)
 
1652
 
 
1653
        test = Test('test_value')
 
1654
        test.run(unittest.TestResult())
 
1655
        self.assertEqual('original', obj.test_attr)
 
1656
 
 
1657
 
 
1658
# NB: Don't delete this; it's not actually from 0.11!
 
1659
@deprecated_function(deprecated_in((0, 11, 0)))
1290
1660
def sample_deprecated_function():
1291
1661
    """A deprecated function to test applyDeprecated with."""
1292
1662
    return 2
1299
1669
class ApplyDeprecatedHelper(object):
1300
1670
    """A helper class for ApplyDeprecated tests."""
1301
1671
 
1302
 
    @symbol_versioning.deprecated_method(zero_eleven)
 
1672
    @deprecated_method(deprecated_in((0, 11, 0)))
1303
1673
    def sample_deprecated_method(self, param_one):
1304
1674
        """A deprecated method for testing with."""
1305
1675
        return param_one
1307
1677
    def sample_normal_method(self):
1308
1678
        """A undeprecated method."""
1309
1679
 
1310
 
    @symbol_versioning.deprecated_method(zero_ten)
 
1680
    @deprecated_method(deprecated_in((0, 10, 0)))
1311
1681
    def sample_nested_deprecation(self):
1312
1682
        return sample_deprecated_function()
1313
1683
 
1314
1684
 
1315
 
class TestExtraAssertions(TestCase):
 
1685
class TestExtraAssertions(tests.TestCase):
1316
1686
    """Tests for new test assertions in bzrlib test suite"""
1317
1687
 
1318
1688
    def test_assert_isinstance(self):
1319
1689
        self.assertIsInstance(2, int)
1320
1690
        self.assertIsInstance(u'', basestring)
1321
 
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
 
1691
        e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
 
1692
        self.assertEquals(str(e),
 
1693
            "None is an instance of <type 'NoneType'> rather than <type 'int'>")
1322
1694
        self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
 
1695
        e = self.assertRaises(AssertionError,
 
1696
            self.assertIsInstance, None, int, "it's just not")
 
1697
        self.assertEquals(str(e),
 
1698
            "None is an instance of <type 'NoneType'> rather than <type 'int'>"
 
1699
            ": it's just not")
1323
1700
 
1324
1701
    def test_assertEndsWith(self):
1325
1702
        self.assertEndsWith('foo', 'oo')
1326
1703
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1327
1704
 
 
1705
    def test_assertEqualDiff(self):
 
1706
        e = self.assertRaises(AssertionError,
 
1707
                              self.assertEqualDiff, '', '\n')
 
1708
        self.assertEquals(str(e),
 
1709
                          # Don't blink ! The '+' applies to the second string
 
1710
                          'first string is missing a final newline.\n+ \n')
 
1711
        e = self.assertRaises(AssertionError,
 
1712
                              self.assertEqualDiff, '\n', '')
 
1713
        self.assertEquals(str(e),
 
1714
                          # Don't blink ! The '-' applies to the second string
 
1715
                          'second string is missing a final newline.\n- \n')
 
1716
 
 
1717
 
 
1718
class TestDeprecations(tests.TestCase):
 
1719
 
1328
1720
    def test_applyDeprecated_not_deprecated(self):
1329
1721
        sample_object = ApplyDeprecatedHelper()
1330
1722
        # calling an undeprecated callable raises an assertion
1331
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
 
1723
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1724
            deprecated_in((0, 11, 0)),
1332
1725
            sample_object.sample_normal_method)
1333
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
 
1726
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1727
            deprecated_in((0, 11, 0)),
1334
1728
            sample_undeprecated_function, "a param value")
1335
1729
        # calling a deprecated callable (function or method) with the wrong
1336
1730
        # expected deprecation fails.
1337
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
 
1731
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1732
            deprecated_in((0, 10, 0)),
1338
1733
            sample_object.sample_deprecated_method, "a param value")
1339
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
 
1734
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1735
            deprecated_in((0, 10, 0)),
1340
1736
            sample_deprecated_function)
1341
1737
        # calling a deprecated callable (function or method) with the right
1342
1738
        # expected deprecation returns the functions result.
1343
 
        self.assertEqual("a param value", self.applyDeprecated(zero_eleven,
 
1739
        self.assertEqual("a param value",
 
1740
            self.applyDeprecated(deprecated_in((0, 11, 0)),
1344
1741
            sample_object.sample_deprecated_method, "a param value"))
1345
 
        self.assertEqual(2, self.applyDeprecated(zero_eleven,
 
1742
        self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 11, 0)),
1346
1743
            sample_deprecated_function))
1347
1744
        # calling a nested deprecation with the wrong deprecation version
1348
 
        # fails even if a deeper nested function was deprecated with the 
 
1745
        # fails even if a deeper nested function was deprecated with the
1349
1746
        # supplied version.
1350
1747
        self.assertRaises(AssertionError, self.applyDeprecated,
1351
 
            zero_eleven, sample_object.sample_nested_deprecation)
 
1748
            deprecated_in((0, 11, 0)), sample_object.sample_nested_deprecation)
1352
1749
        # calling a nested deprecation with the right deprecation value
1353
1750
        # returns the calls result.
1354
 
        self.assertEqual(2, self.applyDeprecated(zero_ten,
 
1751
        self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 10, 0)),
1355
1752
            sample_object.sample_nested_deprecation))
1356
1753
 
1357
1754
    def test_callDeprecated(self):
1358
1755
        def testfunc(be_deprecated, result=None):
1359
1756
            if be_deprecated is True:
1360
 
                symbol_versioning.warn('i am deprecated', DeprecationWarning, 
 
1757
                symbol_versioning.warn('i am deprecated', DeprecationWarning,
1361
1758
                                       stacklevel=1)
1362
1759
            return result
1363
1760
        result = self.callDeprecated(['i am deprecated'], testfunc, True)
1368
1765
        self.callDeprecated([], testfunc, be_deprecated=False)
1369
1766
 
1370
1767
 
1371
 
class TestConvenienceMakers(TestCaseWithTransport):
 
1768
class TestWarningTests(tests.TestCase):
 
1769
    """Tests for calling methods that raise warnings."""
 
1770
 
 
1771
    def test_callCatchWarnings(self):
 
1772
        def meth(a, b):
 
1773
            warnings.warn("this is your last warning")
 
1774
            return a + b
 
1775
        wlist, result = self.callCatchWarnings(meth, 1, 2)
 
1776
        self.assertEquals(3, result)
 
1777
        # would like just to compare them, but UserWarning doesn't implement
 
1778
        # eq well
 
1779
        w0, = wlist
 
1780
        self.assertIsInstance(w0, UserWarning)
 
1781
        self.assertEquals("this is your last warning", str(w0))
 
1782
 
 
1783
 
 
1784
class TestConvenienceMakers(tests.TestCaseWithTransport):
1372
1785
    """Test for the make_* convenience functions."""
1373
1786
 
1374
1787
    def test_make_branch_and_tree_with_format(self):
1386
1799
        tree = self.make_branch_and_memory_tree('a')
1387
1800
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1388
1801
 
1389
 
 
1390
 
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
1391
 
 
1392
 
    def test_make_tree_for_sftp_branch(self):
1393
 
        """Transports backed by local directories create local trees."""
1394
 
 
 
1802
    def test_make_tree_for_local_vfs_backed_transport(self):
 
1803
        # make_branch_and_tree has to use local branch and repositories
 
1804
        # when the vfs transport and local disk are colocated, even if
 
1805
        # a different transport is in use for url generation.
 
1806
        self.transport_server = test_server.FakeVFATServer
 
1807
        self.assertFalse(self.get_url('t1').startswith('file://'))
1395
1808
        tree = self.make_branch_and_tree('t1')
1396
1809
        base = tree.bzrdir.root_transport.base
1397
 
        self.failIf(base.startswith('sftp'),
1398
 
                'base %r is on sftp but should be local' % base)
 
1810
        self.assertStartsWith(base, 'file://')
1399
1811
        self.assertEquals(tree.bzrdir.root_transport,
1400
1812
                tree.branch.bzrdir.root_transport)
1401
1813
        self.assertEquals(tree.bzrdir.root_transport,
1402
1814
                tree.branch.repository.bzrdir.root_transport)
1403
1815
 
1404
1816
 
1405
 
class TestSelftest(TestCase):
 
1817
class SelfTestHelper:
 
1818
 
 
1819
    def run_selftest(self, **kwargs):
 
1820
        """Run selftest returning its output."""
 
1821
        output = StringIO()
 
1822
        old_transport = bzrlib.tests.default_transport
 
1823
        old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
 
1824
        tests.TestCaseWithMemoryTransport.TEST_ROOT = None
 
1825
        try:
 
1826
            self.assertEqual(True, tests.selftest(stream=output, **kwargs))
 
1827
        finally:
 
1828
            bzrlib.tests.default_transport = old_transport
 
1829
            tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
 
1830
        output.seek(0)
 
1831
        return output
 
1832
 
 
1833
 
 
1834
class TestSelftest(tests.TestCase, SelfTestHelper):
1406
1835
    """Tests of bzrlib.tests.selftest."""
1407
1836
 
1408
1837
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1409
1838
        factory_called = []
1410
1839
        def factory():
1411
1840
            factory_called.append(True)
1412
 
            return TestSuite()
 
1841
            return TestUtil.TestSuite()
1413
1842
        out = StringIO()
1414
1843
        err = StringIO()
1415
 
        self.apply_redirected(out, err, None, bzrlib.tests.selftest, 
 
1844
        self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1416
1845
            test_suite_factory=factory)
1417
1846
        self.assertEqual([True], factory_called)
1418
1847
 
1419
 
 
1420
 
class TestSelftestCleanOutput(TestCaseInTempDir):
1421
 
 
1422
 
    def test_clean_output(self):
1423
 
        # test functionality of clean_selftest_output()
1424
 
        self.build_tree(['test0000.tmp/', 'test0001.tmp/',
1425
 
                         'bzrlib/', 'tests/',
1426
 
                         'bzr', 'setup.py', 'test9999.tmp'])
1427
 
 
1428
 
        root = os.getcwdu()
1429
 
        before = os.listdir(root)
1430
 
        before.sort()
1431
 
        self.assertEquals(['bzr','bzrlib','setup.py',
1432
 
                           'test0000.tmp','test0001.tmp',
1433
 
                           'test9999.tmp','tests'],
1434
 
                           before)
1435
 
        clean_selftest_output(root, quiet=True)
1436
 
        after = os.listdir(root)
1437
 
        after.sort()
1438
 
        self.assertEquals(['bzr','bzrlib','setup.py',
1439
 
                           'test9999.tmp','tests'],
1440
 
                           after)
1441
 
 
1442
 
    def test_clean_readonly(self):
1443
 
        # test for delete read-only files
1444
 
        self.build_tree(['test0000.tmp/', 'test0000.tmp/foo'])
1445
 
        osutils.make_readonly('test0000.tmp/foo')
1446
 
        root = os.getcwdu()
1447
 
        before = os.listdir(root);  before.sort()
1448
 
        self.assertEquals(['test0000.tmp'], before)
1449
 
        clean_selftest_output(root, quiet=True)
1450
 
        after = os.listdir(root);   after.sort()
1451
 
        self.assertEquals([], after)
1452
 
 
1453
 
 
1454
 
class TestKnownFailure(TestCase):
1455
 
 
1456
 
    def test_known_failure(self):
1457
 
        """Check that KnownFailure is defined appropriately."""
1458
 
        # a KnownFailure is an assertion error for compatability with unaware
1459
 
        # runners.
1460
 
        self.assertIsInstance(KnownFailure(""), AssertionError)
1461
 
 
1462
 
    def test_expect_failure(self):
1463
 
        try:
1464
 
            self.expectFailure("Doomed to failure", self.assertTrue, False)
1465
 
        except KnownFailure, e:
1466
 
            self.assertEqual('Doomed to failure', e.args[0])
1467
 
        try:
1468
 
            self.expectFailure("Doomed to failure", self.assertTrue, True)
1469
 
        except AssertionError, e:
1470
 
            self.assertEqual('Unexpected success.  Should have failed:'
1471
 
                             ' Doomed to failure', e.args[0])
 
1848
    def factory(self):
 
1849
        """A test suite factory."""
 
1850
        class Test(tests.TestCase):
 
1851
            def a(self):
 
1852
                pass
 
1853
            def b(self):
 
1854
                pass
 
1855
            def c(self):
 
1856
                pass
 
1857
        return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
 
1858
 
 
1859
    def test_list_only(self):
 
1860
        output = self.run_selftest(test_suite_factory=self.factory,
 
1861
            list_only=True)
 
1862
        self.assertEqual(3, len(output.readlines()))
 
1863
 
 
1864
    def test_list_only_filtered(self):
 
1865
        output = self.run_selftest(test_suite_factory=self.factory,
 
1866
            list_only=True, pattern="Test.b")
 
1867
        self.assertEndsWith(output.getvalue(), "Test.b\n")
 
1868
        self.assertLength(1, output.readlines())
 
1869
 
 
1870
    def test_list_only_excludes(self):
 
1871
        output = self.run_selftest(test_suite_factory=self.factory,
 
1872
            list_only=True, exclude_pattern="Test.b")
 
1873
        self.assertNotContainsRe("Test.b", output.getvalue())
 
1874
        self.assertLength(2, output.readlines())
 
1875
 
 
1876
    def test_lsprof_tests(self):
 
1877
        self.requireFeature(test_lsprof.LSProfFeature)
 
1878
        calls = []
 
1879
        class Test(object):
 
1880
            def __call__(test, result):
 
1881
                test.run(result)
 
1882
            def run(test, result):
 
1883
                self.assertIsInstance(result, tests.ForwardingResult)
 
1884
                calls.append("called")
 
1885
            def countTestCases(self):
 
1886
                return 1
 
1887
        self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
 
1888
        self.assertLength(1, calls)
 
1889
 
 
1890
    def test_random(self):
 
1891
        # test randomising by listing a number of tests.
 
1892
        output_123 = self.run_selftest(test_suite_factory=self.factory,
 
1893
            list_only=True, random_seed="123")
 
1894
        output_234 = self.run_selftest(test_suite_factory=self.factory,
 
1895
            list_only=True, random_seed="234")
 
1896
        self.assertNotEqual(output_123, output_234)
 
1897
        # "Randominzing test order..\n\n
 
1898
        self.assertLength(5, output_123.readlines())
 
1899
        self.assertLength(5, output_234.readlines())
 
1900
 
 
1901
    def test_random_reuse_is_same_order(self):
 
1902
        # test randomising by listing a number of tests.
 
1903
        expected = self.run_selftest(test_suite_factory=self.factory,
 
1904
            list_only=True, random_seed="123")
 
1905
        repeated = self.run_selftest(test_suite_factory=self.factory,
 
1906
            list_only=True, random_seed="123")
 
1907
        self.assertEqual(expected.getvalue(), repeated.getvalue())
 
1908
 
 
1909
    def test_runner_class(self):
 
1910
        self.requireFeature(features.subunit)
 
1911
        from subunit import ProtocolTestCase
 
1912
        stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
 
1913
            test_suite_factory=self.factory)
 
1914
        test = ProtocolTestCase(stream)
 
1915
        result = unittest.TestResult()
 
1916
        test.run(result)
 
1917
        self.assertEqual(3, result.testsRun)
 
1918
 
 
1919
    def test_starting_with_single_argument(self):
 
1920
        output = self.run_selftest(test_suite_factory=self.factory,
 
1921
            starting_with=['bzrlib.tests.test_selftest.Test.a'],
 
1922
            list_only=True)
 
1923
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
 
1924
            output.getvalue())
 
1925
 
 
1926
    def test_starting_with_multiple_argument(self):
 
1927
        output = self.run_selftest(test_suite_factory=self.factory,
 
1928
            starting_with=['bzrlib.tests.test_selftest.Test.a',
 
1929
                'bzrlib.tests.test_selftest.Test.b'],
 
1930
            list_only=True)
 
1931
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
 
1932
            'bzrlib.tests.test_selftest.Test.b\n',
 
1933
            output.getvalue())
 
1934
 
 
1935
    def check_transport_set(self, transport_server):
 
1936
        captured_transport = []
 
1937
        def seen_transport(a_transport):
 
1938
            captured_transport.append(a_transport)
 
1939
        class Capture(tests.TestCase):
 
1940
            def a(self):
 
1941
                seen_transport(bzrlib.tests.default_transport)
 
1942
        def factory():
 
1943
            return TestUtil.TestSuite([Capture("a")])
 
1944
        self.run_selftest(transport=transport_server, test_suite_factory=factory)
 
1945
        self.assertEqual(transport_server, captured_transport[0])
 
1946
 
 
1947
    def test_transport_sftp(self):
 
1948
        self.requireFeature(features.paramiko)
 
1949
        from bzrlib.tests import stub_sftp
 
1950
        self.check_transport_set(stub_sftp.SFTPAbsoluteServer)
 
1951
 
 
1952
    def test_transport_memory(self):
 
1953
        self.check_transport_set(memory.MemoryServer)
 
1954
 
 
1955
 
 
1956
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
 
1957
    # Does IO: reads test.list
 
1958
 
 
1959
    def test_load_list(self):
 
1960
        # Provide a list with one test - this test.
 
1961
        test_id_line = '%s\n' % self.id()
 
1962
        self.build_tree_contents([('test.list', test_id_line)])
 
1963
        # And generate a list of the tests in  the suite.
 
1964
        stream = self.run_selftest(load_list='test.list', list_only=True)
 
1965
        self.assertEqual(test_id_line, stream.getvalue())
 
1966
 
 
1967
    def test_load_unknown(self):
 
1968
        # Provide a list with one test - this test.
 
1969
        # And generate a list of the tests in  the suite.
 
1970
        err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
 
1971
            load_list='missing file name', list_only=True)
 
1972
 
 
1973
 
 
1974
class TestRunBzr(tests.TestCase):
 
1975
 
 
1976
    out = ''
 
1977
    err = ''
 
1978
 
 
1979
    def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
 
1980
                         working_dir=None):
 
1981
        """Override _run_bzr_core to test how it is invoked by run_bzr.
 
1982
 
 
1983
        Attempts to run bzr from inside this class don't actually run it.
 
1984
 
 
1985
        We test how run_bzr actually invokes bzr in another location.  Here we
 
1986
        only need to test that it passes the right parameters to run_bzr.
 
1987
        """
 
1988
        self.argv = list(argv)
 
1989
        self.retcode = retcode
 
1990
        self.encoding = encoding
 
1991
        self.stdin = stdin
 
1992
        self.working_dir = working_dir
 
1993
        return self.retcode, self.out, self.err
 
1994
 
 
1995
    def test_run_bzr_error(self):
 
1996
        self.out = "It sure does!\n"
 
1997
        out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
 
1998
        self.assertEqual(['rocks'], self.argv)
 
1999
        self.assertEqual(34, self.retcode)
 
2000
        self.assertEqual('It sure does!\n', out)
 
2001
        self.assertEquals(out, self.out)
 
2002
        self.assertEqual('', err)
 
2003
        self.assertEquals(err, self.err)
 
2004
 
 
2005
    def test_run_bzr_error_regexes(self):
 
2006
        self.out = ''
 
2007
        self.err = "bzr: ERROR: foobarbaz is not versioned"
 
2008
        out, err = self.run_bzr_error(
 
2009
            ["bzr: ERROR: foobarbaz is not versioned"],
 
2010
            ['file-id', 'foobarbaz'])
 
2011
 
 
2012
    def test_encoding(self):
 
2013
        """Test that run_bzr passes encoding to _run_bzr_core"""
 
2014
        self.run_bzr('foo bar')
 
2015
        self.assertEqual(None, self.encoding)
 
2016
        self.assertEqual(['foo', 'bar'], self.argv)
 
2017
 
 
2018
        self.run_bzr('foo bar', encoding='baz')
 
2019
        self.assertEqual('baz', self.encoding)
 
2020
        self.assertEqual(['foo', 'bar'], self.argv)
 
2021
 
 
2022
    def test_retcode(self):
 
2023
        """Test that run_bzr passes retcode to _run_bzr_core"""
 
2024
        # Default is retcode == 0
 
2025
        self.run_bzr('foo bar')
 
2026
        self.assertEqual(0, self.retcode)
 
2027
        self.assertEqual(['foo', 'bar'], self.argv)
 
2028
 
 
2029
        self.run_bzr('foo bar', retcode=1)
 
2030
        self.assertEqual(1, self.retcode)
 
2031
        self.assertEqual(['foo', 'bar'], self.argv)
 
2032
 
 
2033
        self.run_bzr('foo bar', retcode=None)
 
2034
        self.assertEqual(None, self.retcode)
 
2035
        self.assertEqual(['foo', 'bar'], self.argv)
 
2036
 
 
2037
        self.run_bzr(['foo', 'bar'], retcode=3)
 
2038
        self.assertEqual(3, self.retcode)
 
2039
        self.assertEqual(['foo', 'bar'], self.argv)
 
2040
 
 
2041
    def test_stdin(self):
 
2042
        # test that the stdin keyword to run_bzr is passed through to
 
2043
        # _run_bzr_core as-is. We do this by overriding
 
2044
        # _run_bzr_core in this class, and then calling run_bzr,
 
2045
        # which is a convenience function for _run_bzr_core, so
 
2046
        # should invoke it.
 
2047
        self.run_bzr('foo bar', stdin='gam')
 
2048
        self.assertEqual('gam', self.stdin)
 
2049
        self.assertEqual(['foo', 'bar'], self.argv)
 
2050
 
 
2051
        self.run_bzr('foo bar', stdin='zippy')
 
2052
        self.assertEqual('zippy', self.stdin)
 
2053
        self.assertEqual(['foo', 'bar'], self.argv)
 
2054
 
 
2055
    def test_working_dir(self):
 
2056
        """Test that run_bzr passes working_dir to _run_bzr_core"""
 
2057
        self.run_bzr('foo bar')
 
2058
        self.assertEqual(None, self.working_dir)
 
2059
        self.assertEqual(['foo', 'bar'], self.argv)
 
2060
 
 
2061
        self.run_bzr('foo bar', working_dir='baz')
 
2062
        self.assertEqual('baz', self.working_dir)
 
2063
        self.assertEqual(['foo', 'bar'], self.argv)
 
2064
 
 
2065
    def test_reject_extra_keyword_arguments(self):
 
2066
        self.assertRaises(TypeError, self.run_bzr, "foo bar",
 
2067
                          error_regex=['error message'])
 
2068
 
 
2069
 
 
2070
class TestRunBzrCaptured(tests.TestCaseWithTransport):
 
2071
    # Does IO when testing the working_dir parameter.
 
2072
 
 
2073
    def apply_redirected(self, stdin=None, stdout=None, stderr=None,
 
2074
                         a_callable=None, *args, **kwargs):
 
2075
        self.stdin = stdin
 
2076
        self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
 
2077
        self.factory = bzrlib.ui.ui_factory
 
2078
        self.working_dir = osutils.getcwd()
 
2079
        stdout.write('foo\n')
 
2080
        stderr.write('bar\n')
 
2081
        return 0
 
2082
 
 
2083
    def test_stdin(self):
 
2084
        # test that the stdin keyword to _run_bzr_core is passed through to
 
2085
        # apply_redirected as a StringIO. We do this by overriding
 
2086
        # apply_redirected in this class, and then calling _run_bzr_core,
 
2087
        # which calls apply_redirected.
 
2088
        self.run_bzr(['foo', 'bar'], stdin='gam')
 
2089
        self.assertEqual('gam', self.stdin.read())
 
2090
        self.assertTrue(self.stdin is self.factory_stdin)
 
2091
        self.run_bzr(['foo', 'bar'], stdin='zippy')
 
2092
        self.assertEqual('zippy', self.stdin.read())
 
2093
        self.assertTrue(self.stdin is self.factory_stdin)
 
2094
 
 
2095
    def test_ui_factory(self):
 
2096
        # each invocation of self.run_bzr should get its
 
2097
        # own UI factory, which is an instance of TestUIFactory,
 
2098
        # with stdin, stdout and stderr attached to the stdin,
 
2099
        # stdout and stderr of the invoked run_bzr
 
2100
        current_factory = bzrlib.ui.ui_factory
 
2101
        self.run_bzr(['foo'])
 
2102
        self.failIf(current_factory is self.factory)
 
2103
        self.assertNotEqual(sys.stdout, self.factory.stdout)
 
2104
        self.assertNotEqual(sys.stderr, self.factory.stderr)
 
2105
        self.assertEqual('foo\n', self.factory.stdout.getvalue())
 
2106
        self.assertEqual('bar\n', self.factory.stderr.getvalue())
 
2107
        self.assertIsInstance(self.factory, tests.TestUIFactory)
 
2108
 
 
2109
    def test_working_dir(self):
 
2110
        self.build_tree(['one/', 'two/'])
 
2111
        cwd = osutils.getcwd()
 
2112
 
 
2113
        # Default is to work in the current directory
 
2114
        self.run_bzr(['foo', 'bar'])
 
2115
        self.assertEqual(cwd, self.working_dir)
 
2116
 
 
2117
        self.run_bzr(['foo', 'bar'], working_dir=None)
 
2118
        self.assertEqual(cwd, self.working_dir)
 
2119
 
 
2120
        # The function should be run in the alternative directory
 
2121
        # but afterwards the current working dir shouldn't be changed
 
2122
        self.run_bzr(['foo', 'bar'], working_dir='one')
 
2123
        self.assertNotEqual(cwd, self.working_dir)
 
2124
        self.assertEndsWith(self.working_dir, 'one')
 
2125
        self.assertEqual(cwd, osutils.getcwd())
 
2126
 
 
2127
        self.run_bzr(['foo', 'bar'], working_dir='two')
 
2128
        self.assertNotEqual(cwd, self.working_dir)
 
2129
        self.assertEndsWith(self.working_dir, 'two')
 
2130
        self.assertEqual(cwd, osutils.getcwd())
 
2131
 
 
2132
 
 
2133
class StubProcess(object):
 
2134
    """A stub process for testing run_bzr_subprocess."""
 
2135
    
 
2136
    def __init__(self, out="", err="", retcode=0):
 
2137
        self.out = out
 
2138
        self.err = err
 
2139
        self.returncode = retcode
 
2140
 
 
2141
    def communicate(self):
 
2142
        return self.out, self.err
 
2143
 
 
2144
 
 
2145
class TestWithFakedStartBzrSubprocess(tests.TestCaseWithTransport):
 
2146
    """Base class for tests testing how we might run bzr."""
 
2147
 
 
2148
    def setUp(self):
 
2149
        tests.TestCaseWithTransport.setUp(self)
 
2150
        self.subprocess_calls = []
 
2151
 
 
2152
    def start_bzr_subprocess(self, process_args, env_changes=None,
 
2153
                             skip_if_plan_to_signal=False,
 
2154
                             working_dir=None,
 
2155
                             allow_plugins=False):
 
2156
        """capture what run_bzr_subprocess tries to do."""
 
2157
        self.subprocess_calls.append({'process_args':process_args,
 
2158
            'env_changes':env_changes,
 
2159
            'skip_if_plan_to_signal':skip_if_plan_to_signal,
 
2160
            'working_dir':working_dir, 'allow_plugins':allow_plugins})
 
2161
        return self.next_subprocess
 
2162
 
 
2163
 
 
2164
class TestRunBzrSubprocess(TestWithFakedStartBzrSubprocess):
 
2165
 
 
2166
    def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
 
2167
        """Run run_bzr_subprocess with args and kwargs using a stubbed process.
 
2168
 
 
2169
        Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
 
2170
        that will return static results. This assertion method populates those
 
2171
        results and also checks the arguments run_bzr_subprocess generates.
 
2172
        """
 
2173
        self.next_subprocess = process
 
2174
        try:
 
2175
            result = self.run_bzr_subprocess(*args, **kwargs)
 
2176
        except:
 
2177
            self.next_subprocess = None
 
2178
            for key, expected in expected_args.iteritems():
 
2179
                self.assertEqual(expected, self.subprocess_calls[-1][key])
 
2180
            raise
1472
2181
        else:
1473
 
            self.fail('Assertion not raised')
1474
 
 
1475
 
 
1476
 
class TestFeature(TestCase):
 
2182
            self.next_subprocess = None
 
2183
            for key, expected in expected_args.iteritems():
 
2184
                self.assertEqual(expected, self.subprocess_calls[-1][key])
 
2185
            return result
 
2186
 
 
2187
    def test_run_bzr_subprocess(self):
 
2188
        """The run_bzr_helper_external command behaves nicely."""
 
2189
        self.assertRunBzrSubprocess({'process_args':['--version']},
 
2190
            StubProcess(), '--version')
 
2191
        self.assertRunBzrSubprocess({'process_args':['--version']},
 
2192
            StubProcess(), ['--version'])
 
2193
        # retcode=None disables retcode checking
 
2194
        result = self.assertRunBzrSubprocess({},
 
2195
            StubProcess(retcode=3), '--version', retcode=None)
 
2196
        result = self.assertRunBzrSubprocess({},
 
2197
            StubProcess(out="is free software"), '--version')
 
2198
        self.assertContainsRe(result[0], 'is free software')
 
2199
        # Running a subcommand that is missing errors
 
2200
        self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
 
2201
            {'process_args':['--versionn']}, StubProcess(retcode=3),
 
2202
            '--versionn')
 
2203
        # Unless it is told to expect the error from the subprocess
 
2204
        result = self.assertRunBzrSubprocess({},
 
2205
            StubProcess(retcode=3), '--versionn', retcode=3)
 
2206
        # Or to ignore retcode checking
 
2207
        result = self.assertRunBzrSubprocess({},
 
2208
            StubProcess(err="unknown command", retcode=3), '--versionn',
 
2209
            retcode=None)
 
2210
        self.assertContainsRe(result[1], 'unknown command')
 
2211
 
 
2212
    def test_env_change_passes_through(self):
 
2213
        self.assertRunBzrSubprocess(
 
2214
            {'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
 
2215
            StubProcess(), '',
 
2216
            env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
 
2217
 
 
2218
    def test_no_working_dir_passed_as_None(self):
 
2219
        self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
 
2220
 
 
2221
    def test_no_working_dir_passed_through(self):
 
2222
        self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
 
2223
            working_dir='dir')
 
2224
 
 
2225
    def test_run_bzr_subprocess_no_plugins(self):
 
2226
        self.assertRunBzrSubprocess({'allow_plugins': False},
 
2227
            StubProcess(), '')
 
2228
 
 
2229
    def test_allow_plugins(self):
 
2230
        self.assertRunBzrSubprocess({'allow_plugins': True},
 
2231
            StubProcess(), '', allow_plugins=True)
 
2232
 
 
2233
 
 
2234
class TestFinishBzrSubprocess(TestWithFakedStartBzrSubprocess):
 
2235
 
 
2236
    def test_finish_bzr_subprocess_with_error(self):
 
2237
        """finish_bzr_subprocess allows specification of the desired exit code.
 
2238
        """
 
2239
        process = StubProcess(err="unknown command", retcode=3)
 
2240
        result = self.finish_bzr_subprocess(process, retcode=3)
 
2241
        self.assertEqual('', result[0])
 
2242
        self.assertContainsRe(result[1], 'unknown command')
 
2243
 
 
2244
    def test_finish_bzr_subprocess_ignoring_retcode(self):
 
2245
        """finish_bzr_subprocess allows the exit code to be ignored."""
 
2246
        process = StubProcess(err="unknown command", retcode=3)
 
2247
        result = self.finish_bzr_subprocess(process, retcode=None)
 
2248
        self.assertEqual('', result[0])
 
2249
        self.assertContainsRe(result[1], 'unknown command')
 
2250
 
 
2251
    def test_finish_subprocess_with_unexpected_retcode(self):
 
2252
        """finish_bzr_subprocess raises self.failureException if the retcode is
 
2253
        not the expected one.
 
2254
        """
 
2255
        process = StubProcess(err="unknown command", retcode=3)
 
2256
        self.assertRaises(self.failureException, self.finish_bzr_subprocess,
 
2257
                          process)
 
2258
 
 
2259
 
 
2260
class _DontSpawnProcess(Exception):
 
2261
    """A simple exception which just allows us to skip unnecessary steps"""
 
2262
 
 
2263
 
 
2264
class TestStartBzrSubProcess(tests.TestCase):
 
2265
 
 
2266
    def check_popen_state(self):
 
2267
        """Replace to make assertions when popen is called."""
 
2268
 
 
2269
    def _popen(self, *args, **kwargs):
 
2270
        """Record the command that is run, so that we can ensure it is correct"""
 
2271
        self.check_popen_state()
 
2272
        self._popen_args = args
 
2273
        self._popen_kwargs = kwargs
 
2274
        raise _DontSpawnProcess()
 
2275
 
 
2276
    def test_run_bzr_subprocess_no_plugins(self):
 
2277
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
 
2278
        command = self._popen_args[0]
 
2279
        self.assertEqual(sys.executable, command[0])
 
2280
        self.assertEqual(self.get_bzr_path(), command[1])
 
2281
        self.assertEqual(['--no-plugins'], command[2:])
 
2282
 
 
2283
    def test_allow_plugins(self):
 
2284
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2285
            allow_plugins=True)
 
2286
        command = self._popen_args[0]
 
2287
        self.assertEqual([], command[2:])
 
2288
 
 
2289
    def test_set_env(self):
 
2290
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
 
2291
        # set in the child
 
2292
        def check_environment():
 
2293
            self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
 
2294
        self.check_popen_state = check_environment
 
2295
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2296
            env_changes={'EXISTANT_ENV_VAR':'set variable'})
 
2297
        # not set in theparent
 
2298
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
 
2299
 
 
2300
    def test_run_bzr_subprocess_env_del(self):
 
2301
        """run_bzr_subprocess can remove environment variables too."""
 
2302
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
 
2303
        def check_environment():
 
2304
            self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
 
2305
        os.environ['EXISTANT_ENV_VAR'] = 'set variable'
 
2306
        self.check_popen_state = check_environment
 
2307
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2308
            env_changes={'EXISTANT_ENV_VAR':None})
 
2309
        # Still set in parent
 
2310
        self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
 
2311
        del os.environ['EXISTANT_ENV_VAR']
 
2312
 
 
2313
    def test_env_del_missing(self):
 
2314
        self.failIf('NON_EXISTANT_ENV_VAR' in os.environ)
 
2315
        def check_environment():
 
2316
            self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
 
2317
        self.check_popen_state = check_environment
 
2318
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2319
            env_changes={'NON_EXISTANT_ENV_VAR':None})
 
2320
 
 
2321
    def test_working_dir(self):
 
2322
        """Test that we can specify the working dir for the child"""
 
2323
        orig_getcwd = osutils.getcwd
 
2324
        orig_chdir = os.chdir
 
2325
        chdirs = []
 
2326
        def chdir(path):
 
2327
            chdirs.append(path)
 
2328
        os.chdir = chdir
 
2329
        try:
 
2330
            def getcwd():
 
2331
                return 'current'
 
2332
            osutils.getcwd = getcwd
 
2333
            try:
 
2334
                self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2335
                    working_dir='foo')
 
2336
            finally:
 
2337
                osutils.getcwd = orig_getcwd
 
2338
        finally:
 
2339
            os.chdir = orig_chdir
 
2340
        self.assertEqual(['foo', 'current'], chdirs)
 
2341
 
 
2342
 
 
2343
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
 
2344
    """Tests that really need to do things with an external bzr."""
 
2345
 
 
2346
    def test_start_and_stop_bzr_subprocess_send_signal(self):
 
2347
        """finish_bzr_subprocess raises self.failureException if the retcode is
 
2348
        not the expected one.
 
2349
        """
 
2350
        self.disable_missing_extensions_warning()
 
2351
        process = self.start_bzr_subprocess(['wait-until-signalled'],
 
2352
                                            skip_if_plan_to_signal=True)
 
2353
        self.assertEqual('running\n', process.stdout.readline())
 
2354
        result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
 
2355
                                            retcode=3)
 
2356
        self.assertEqual('', result[0])
 
2357
        self.assertEqual('bzr: interrupted\n', result[1])
 
2358
 
 
2359
 
 
2360
class TestFeature(tests.TestCase):
1477
2361
 
1478
2362
    def test_caching(self):
1479
2363
        """Feature._probe is called by the feature at most once."""
1480
 
        class InstrumentedFeature(Feature):
 
2364
        class InstrumentedFeature(tests.Feature):
1481
2365
            def __init__(self):
1482
 
                Feature.__init__(self)
 
2366
                super(InstrumentedFeature, self).__init__()
1483
2367
                self.calls = []
1484
2368
            def _probe(self):
1485
2369
                self.calls.append('_probe')
1492
2376
 
1493
2377
    def test_named_str(self):
1494
2378
        """Feature.__str__ should thunk to feature_name()."""
1495
 
        class NamedFeature(Feature):
 
2379
        class NamedFeature(tests.Feature):
1496
2380
            def feature_name(self):
1497
2381
                return 'symlinks'
1498
2382
        feature = NamedFeature()
1500
2384
 
1501
2385
    def test_default_str(self):
1502
2386
        """Feature.__str__ should default to __class__.__name__."""
1503
 
        class NamedFeature(Feature):
 
2387
        class NamedFeature(tests.Feature):
1504
2388
            pass
1505
2389
        feature = NamedFeature()
1506
2390
        self.assertEqual('NamedFeature', str(feature))
1507
2391
 
1508
2392
 
1509
 
class TestUnavailableFeature(TestCase):
 
2393
class TestUnavailableFeature(tests.TestCase):
1510
2394
 
1511
2395
    def test_access_feature(self):
1512
 
        feature = Feature()
1513
 
        exception = UnavailableFeature(feature)
 
2396
        feature = tests.Feature()
 
2397
        exception = tests.UnavailableFeature(feature)
1514
2398
        self.assertIs(feature, exception.args[0])
1515
2399
 
1516
2400
 
1517
 
class TestSelftestFiltering(TestCase):
 
2401
simple_thunk_feature = tests._CompatabilityThunkFeature(
 
2402
    deprecated_in((2, 1, 0)),
 
2403
    'bzrlib.tests.test_selftest',
 
2404
    'simple_thunk_feature','UnicodeFilename',
 
2405
    replacement_module='bzrlib.tests'
 
2406
    )
 
2407
 
 
2408
class Test_CompatibilityFeature(tests.TestCase):
 
2409
 
 
2410
    def test_does_thunk(self):
 
2411
        res = self.callDeprecated(
 
2412
            ['bzrlib.tests.test_selftest.simple_thunk_feature was deprecated'
 
2413
             ' in version 2.1.0. Use bzrlib.tests.UnicodeFilename instead.'],
 
2414
            simple_thunk_feature.available)
 
2415
        self.assertEqual(tests.UnicodeFilename.available(), res)
 
2416
 
 
2417
 
 
2418
class TestModuleAvailableFeature(tests.TestCase):
 
2419
 
 
2420
    def test_available_module(self):
 
2421
        feature = tests.ModuleAvailableFeature('bzrlib.tests')
 
2422
        self.assertEqual('bzrlib.tests', feature.module_name)
 
2423
        self.assertEqual('bzrlib.tests', str(feature))
 
2424
        self.assertTrue(feature.available())
 
2425
        self.assertIs(tests, feature.module)
 
2426
 
 
2427
    def test_unavailable_module(self):
 
2428
        feature = tests.ModuleAvailableFeature('bzrlib.no_such_module_exists')
 
2429
        self.assertEqual('bzrlib.no_such_module_exists', str(feature))
 
2430
        self.assertFalse(feature.available())
 
2431
        self.assertIs(None, feature.module)
 
2432
 
 
2433
 
 
2434
class TestSelftestFiltering(tests.TestCase):
1518
2435
 
1519
2436
    def setUp(self):
 
2437
        tests.TestCase.setUp(self)
1520
2438
        self.suite = TestUtil.TestSuite()
1521
2439
        self.loader = TestUtil.TestLoader()
1522
 
        self.suite.addTest(self.loader.loadTestsFromModuleNames([
1523
 
            'bzrlib.tests.test_selftest']))
1524
 
        self.all_names = [t.id() for t in iter_suite_tests(self.suite)]
 
2440
        self.suite.addTest(self.loader.loadTestsFromModule(
 
2441
            sys.modules['bzrlib.tests.test_selftest']))
 
2442
        self.all_names = _test_ids(self.suite)
 
2443
 
 
2444
    def test_condition_id_re(self):
 
2445
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2446
            'test_condition_id_re')
 
2447
        filtered_suite = tests.filter_suite_by_condition(
 
2448
            self.suite, tests.condition_id_re('test_condition_id_re'))
 
2449
        self.assertEqual([test_name], _test_ids(filtered_suite))
 
2450
 
 
2451
    def test_condition_id_in_list(self):
 
2452
        test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2453
                      'test_condition_id_in_list']
 
2454
        id_list = tests.TestIdList(test_names)
 
2455
        filtered_suite = tests.filter_suite_by_condition(
 
2456
            self.suite, tests.condition_id_in_list(id_list))
 
2457
        my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
 
2458
        re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
 
2459
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
 
2460
 
 
2461
    def test_condition_id_startswith(self):
 
2462
        klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2463
        start1 = klass + 'test_condition_id_starts'
 
2464
        start2 = klass + 'test_condition_id_in'
 
2465
        test_names = [ klass + 'test_condition_id_in_list',
 
2466
                      klass + 'test_condition_id_startswith',
 
2467
                     ]
 
2468
        filtered_suite = tests.filter_suite_by_condition(
 
2469
            self.suite, tests.condition_id_startswith([start1, start2]))
 
2470
        self.assertEqual(test_names, _test_ids(filtered_suite))
 
2471
 
 
2472
    def test_condition_isinstance(self):
 
2473
        filtered_suite = tests.filter_suite_by_condition(
 
2474
            self.suite, tests.condition_isinstance(self.__class__))
 
2475
        class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2476
        re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
 
2477
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
 
2478
 
 
2479
    def test_exclude_tests_by_condition(self):
 
2480
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2481
            'test_exclude_tests_by_condition')
 
2482
        filtered_suite = tests.exclude_tests_by_condition(self.suite,
 
2483
            lambda x:x.id() == excluded_name)
 
2484
        self.assertEqual(len(self.all_names) - 1,
 
2485
            filtered_suite.countTestCases())
 
2486
        self.assertFalse(excluded_name in _test_ids(filtered_suite))
 
2487
        remaining_names = list(self.all_names)
 
2488
        remaining_names.remove(excluded_name)
 
2489
        self.assertEqual(remaining_names, _test_ids(filtered_suite))
 
2490
 
 
2491
    def test_exclude_tests_by_re(self):
 
2492
        self.all_names = _test_ids(self.suite)
 
2493
        filtered_suite = tests.exclude_tests_by_re(self.suite,
 
2494
                                                   'exclude_tests_by_re')
 
2495
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2496
            'test_exclude_tests_by_re')
 
2497
        self.assertEqual(len(self.all_names) - 1,
 
2498
            filtered_suite.countTestCases())
 
2499
        self.assertFalse(excluded_name in _test_ids(filtered_suite))
 
2500
        remaining_names = list(self.all_names)
 
2501
        remaining_names.remove(excluded_name)
 
2502
        self.assertEqual(remaining_names, _test_ids(filtered_suite))
 
2503
 
 
2504
    def test_filter_suite_by_condition(self):
 
2505
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2506
            'test_filter_suite_by_condition')
 
2507
        filtered_suite = tests.filter_suite_by_condition(self.suite,
 
2508
            lambda x:x.id() == test_name)
 
2509
        self.assertEqual([test_name], _test_ids(filtered_suite))
1525
2510
 
1526
2511
    def test_filter_suite_by_re(self):
1527
 
        filtered_suite = filter_suite_by_re(self.suite, 'test_filter')
1528
 
        filtered_names = [t.id() for t in iter_suite_tests(filtered_suite)]
 
2512
        filtered_suite = tests.filter_suite_by_re(self.suite,
 
2513
                                                  'test_filter_suite_by_r')
 
2514
        filtered_names = _test_ids(filtered_suite)
1529
2515
        self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
1530
2516
            'TestSelftestFiltering.test_filter_suite_by_re'])
1531
 
            
1532
 
    def test_sort_suite_by_re(self):
1533
 
        sorted_suite = sort_suite_by_re(self.suite, 'test_filter')
1534
 
        sorted_names = [t.id() for t in iter_suite_tests(sorted_suite)]
1535
 
        self.assertEqual(sorted_names[0], 'bzrlib.tests.test_selftest.'
1536
 
            'TestSelftestFiltering.test_filter_suite_by_re')
1537
 
        self.assertEquals(sorted(self.all_names), sorted(sorted_names))
1538
 
 
 
2517
 
 
2518
    def test_filter_suite_by_id_list(self):
 
2519
        test_list = ['bzrlib.tests.test_selftest.'
 
2520
                     'TestSelftestFiltering.test_filter_suite_by_id_list']
 
2521
        filtered_suite = tests.filter_suite_by_id_list(
 
2522
            self.suite, tests.TestIdList(test_list))
 
2523
        filtered_names = _test_ids(filtered_suite)
 
2524
        self.assertEqual(
 
2525
            filtered_names,
 
2526
            ['bzrlib.tests.test_selftest.'
 
2527
             'TestSelftestFiltering.test_filter_suite_by_id_list'])
 
2528
 
 
2529
    def test_filter_suite_by_id_startswith(self):
 
2530
        # By design this test may fail if another test is added whose name also
 
2531
        # begins with one of the start value used.
 
2532
        klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2533
        start1 = klass + 'test_filter_suite_by_id_starts'
 
2534
        start2 = klass + 'test_filter_suite_by_id_li'
 
2535
        test_list = [klass + 'test_filter_suite_by_id_list',
 
2536
                     klass + 'test_filter_suite_by_id_startswith',
 
2537
                     ]
 
2538
        filtered_suite = tests.filter_suite_by_id_startswith(
 
2539
            self.suite, [start1, start2])
 
2540
        self.assertEqual(
 
2541
            test_list,
 
2542
            _test_ids(filtered_suite),
 
2543
            )
 
2544
 
 
2545
    def test_preserve_input(self):
 
2546
        # NB: Surely this is something in the stdlib to do this?
 
2547
        self.assertTrue(self.suite is tests.preserve_input(self.suite))
 
2548
        self.assertTrue("@#$" is tests.preserve_input("@#$"))
 
2549
 
 
2550
    def test_randomize_suite(self):
 
2551
        randomized_suite = tests.randomize_suite(self.suite)
 
2552
        # randomizing should not add or remove test names.
 
2553
        self.assertEqual(set(_test_ids(self.suite)),
 
2554
                         set(_test_ids(randomized_suite)))
 
2555
        # Technically, this *can* fail, because random.shuffle(list) can be
 
2556
        # equal to list. Trying multiple times just pushes the frequency back.
 
2557
        # As its len(self.all_names)!:1, the failure frequency should be low
 
2558
        # enough to ignore. RBC 20071021.
 
2559
        # It should change the order.
 
2560
        self.assertNotEqual(self.all_names, _test_ids(randomized_suite))
 
2561
        # But not the length. (Possibly redundant with the set test, but not
 
2562
        # necessarily.)
 
2563
        self.assertEqual(len(self.all_names), len(_test_ids(randomized_suite)))
 
2564
 
 
2565
    def test_split_suit_by_condition(self):
 
2566
        self.all_names = _test_ids(self.suite)
 
2567
        condition = tests.condition_id_re('test_filter_suite_by_r')
 
2568
        split_suite = tests.split_suite_by_condition(self.suite, condition)
 
2569
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2570
            'test_filter_suite_by_re')
 
2571
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
 
2572
        self.assertFalse(filtered_name in _test_ids(split_suite[1]))
 
2573
        remaining_names = list(self.all_names)
 
2574
        remaining_names.remove(filtered_name)
 
2575
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
 
2576
 
 
2577
    def test_split_suit_by_re(self):
 
2578
        self.all_names = _test_ids(self.suite)
 
2579
        split_suite = tests.split_suite_by_re(self.suite,
 
2580
                                              'test_filter_suite_by_r')
 
2581
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2582
            'test_filter_suite_by_re')
 
2583
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
 
2584
        self.assertFalse(filtered_name in _test_ids(split_suite[1]))
 
2585
        remaining_names = list(self.all_names)
 
2586
        remaining_names.remove(filtered_name)
 
2587
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
 
2588
 
 
2589
 
 
2590
class TestCheckInventoryShape(tests.TestCaseWithTransport):
 
2591
 
 
2592
    def test_check_inventory_shape(self):
 
2593
        files = ['a', 'b/', 'b/c']
 
2594
        tree = self.make_branch_and_tree('.')
 
2595
        self.build_tree(files)
 
2596
        tree.add(files)
 
2597
        tree.lock_read()
 
2598
        try:
 
2599
            self.check_inventory_shape(tree.inventory, files)
 
2600
        finally:
 
2601
            tree.unlock()
 
2602
 
 
2603
 
 
2604
class TestBlackboxSupport(tests.TestCase):
 
2605
    """Tests for testsuite blackbox features."""
 
2606
 
 
2607
    def test_run_bzr_failure_not_caught(self):
 
2608
        # When we run bzr in blackbox mode, we want any unexpected errors to
 
2609
        # propagate up to the test suite so that it can show the error in the
 
2610
        # usual way, and we won't get a double traceback.
 
2611
        e = self.assertRaises(
 
2612
            AssertionError,
 
2613
            self.run_bzr, ['assert-fail'])
 
2614
        # make sure we got the real thing, not an error from somewhere else in
 
2615
        # the test framework
 
2616
        self.assertEquals('always fails', str(e))
 
2617
        # check that there's no traceback in the test log
 
2618
        self.assertNotContainsRe(self.get_log(), r'Traceback')
 
2619
 
 
2620
    def test_run_bzr_user_error_caught(self):
 
2621
        # Running bzr in blackbox mode, normal/expected/user errors should be
 
2622
        # caught in the regular way and turned into an error message plus exit
 
2623
        # code.
 
2624
        transport_server = memory.MemoryServer()
 
2625
        transport_server.start_server()
 
2626
        self.addCleanup(transport_server.stop_server)
 
2627
        url = transport_server.get_url()
 
2628
        self.permit_url(url)
 
2629
        out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
 
2630
        self.assertEqual(out, '')
 
2631
        self.assertContainsRe(err,
 
2632
            'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
 
2633
 
 
2634
 
 
2635
class TestTestLoader(tests.TestCase):
 
2636
    """Tests for the test loader."""
 
2637
 
 
2638
    def _get_loader_and_module(self):
 
2639
        """Gets a TestLoader and a module with one test in it."""
 
2640
        loader = TestUtil.TestLoader()
 
2641
        module = {}
 
2642
        class Stub(tests.TestCase):
 
2643
            def test_foo(self):
 
2644
                pass
 
2645
        class MyModule(object):
 
2646
            pass
 
2647
        MyModule.a_class = Stub
 
2648
        module = MyModule()
 
2649
        return loader, module
 
2650
 
 
2651
    def test_module_no_load_tests_attribute_loads_classes(self):
 
2652
        loader, module = self._get_loader_and_module()
 
2653
        self.assertEqual(1, loader.loadTestsFromModule(module).countTestCases())
 
2654
 
 
2655
    def test_module_load_tests_attribute_gets_called(self):
 
2656
        loader, module = self._get_loader_and_module()
 
2657
        # 'self' is here because we're faking the module with a class. Regular
 
2658
        # load_tests do not need that :)
 
2659
        def load_tests(self, standard_tests, module, loader):
 
2660
            result = loader.suiteClass()
 
2661
            for test in tests.iter_suite_tests(standard_tests):
 
2662
                result.addTests([test, test])
 
2663
            return result
 
2664
        # add a load_tests() method which multiplies the tests from the module.
 
2665
        module.__class__.load_tests = load_tests
 
2666
        self.assertEqual(2, loader.loadTestsFromModule(module).countTestCases())
 
2667
 
 
2668
    def test_load_tests_from_module_name_smoke_test(self):
 
2669
        loader = TestUtil.TestLoader()
 
2670
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2671
        self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
 
2672
                          _test_ids(suite))
 
2673
 
 
2674
    def test_load_tests_from_module_name_with_bogus_module_name(self):
 
2675
        loader = TestUtil.TestLoader()
 
2676
        self.assertRaises(ImportError, loader.loadTestsFromModuleName, 'bogus')
 
2677
 
 
2678
 
 
2679
class TestTestIdList(tests.TestCase):
 
2680
 
 
2681
    def _create_id_list(self, test_list):
 
2682
        return tests.TestIdList(test_list)
 
2683
 
 
2684
    def _create_suite(self, test_id_list):
 
2685
 
 
2686
        class Stub(tests.TestCase):
 
2687
            def test_foo(self):
 
2688
                pass
 
2689
 
 
2690
        def _create_test_id(id):
 
2691
            return lambda: id
 
2692
 
 
2693
        suite = TestUtil.TestSuite()
 
2694
        for id in test_id_list:
 
2695
            t  = Stub('test_foo')
 
2696
            t.id = _create_test_id(id)
 
2697
            suite.addTest(t)
 
2698
        return suite
 
2699
 
 
2700
    def _test_ids(self, test_suite):
 
2701
        """Get the ids for the tests in a test suite."""
 
2702
        return [t.id() for t in tests.iter_suite_tests(test_suite)]
 
2703
 
 
2704
    def test_empty_list(self):
 
2705
        id_list = self._create_id_list([])
 
2706
        self.assertEquals({}, id_list.tests)
 
2707
        self.assertEquals({}, id_list.modules)
 
2708
 
 
2709
    def test_valid_list(self):
 
2710
        id_list = self._create_id_list(
 
2711
            ['mod1.cl1.meth1', 'mod1.cl1.meth2',
 
2712
             'mod1.func1', 'mod1.cl2.meth2',
 
2713
             'mod1.submod1',
 
2714
             'mod1.submod2.cl1.meth1', 'mod1.submod2.cl2.meth2',
 
2715
             ])
 
2716
        self.assertTrue(id_list.refers_to('mod1'))
 
2717
        self.assertTrue(id_list.refers_to('mod1.submod1'))
 
2718
        self.assertTrue(id_list.refers_to('mod1.submod2'))
 
2719
        self.assertTrue(id_list.includes('mod1.cl1.meth1'))
 
2720
        self.assertTrue(id_list.includes('mod1.submod1'))
 
2721
        self.assertTrue(id_list.includes('mod1.func1'))
 
2722
 
 
2723
    def test_bad_chars_in_params(self):
 
2724
        id_list = self._create_id_list(['mod1.cl1.meth1(xx.yy)'])
 
2725
        self.assertTrue(id_list.refers_to('mod1'))
 
2726
        self.assertTrue(id_list.includes('mod1.cl1.meth1(xx.yy)'))
 
2727
 
 
2728
    def test_module_used(self):
 
2729
        id_list = self._create_id_list(['mod.class.meth'])
 
2730
        self.assertTrue(id_list.refers_to('mod'))
 
2731
        self.assertTrue(id_list.refers_to('mod.class'))
 
2732
        self.assertTrue(id_list.refers_to('mod.class.meth'))
 
2733
 
 
2734
    def test_test_suite_matches_id_list_with_unknown(self):
 
2735
        loader = TestUtil.TestLoader()
 
2736
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2737
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',
 
2738
                     'bogus']
 
2739
        not_found, duplicates = tests.suite_matches_id_list(suite, test_list)
 
2740
        self.assertEquals(['bogus'], not_found)
 
2741
        self.assertEquals([], duplicates)
 
2742
 
 
2743
    def test_suite_matches_id_list_with_duplicates(self):
 
2744
        loader = TestUtil.TestLoader()
 
2745
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2746
        dupes = loader.suiteClass()
 
2747
        for test in tests.iter_suite_tests(suite):
 
2748
            dupes.addTest(test)
 
2749
            dupes.addTest(test) # Add it again
 
2750
 
 
2751
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',]
 
2752
        not_found, duplicates = tests.suite_matches_id_list(
 
2753
            dupes, test_list)
 
2754
        self.assertEquals([], not_found)
 
2755
        self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
 
2756
                          duplicates)
 
2757
 
 
2758
 
 
2759
class TestTestSuite(tests.TestCase):
 
2760
 
 
2761
    def test__test_suite_testmod_names(self):
 
2762
        # Test that a plausible list of test module names are returned
 
2763
        # by _test_suite_testmod_names.
 
2764
        test_list = tests._test_suite_testmod_names()
 
2765
        self.assertSubset([
 
2766
            'bzrlib.tests.blackbox',
 
2767
            'bzrlib.tests.per_transport',
 
2768
            'bzrlib.tests.test_selftest',
 
2769
            ],
 
2770
            test_list)
 
2771
 
 
2772
    def test__test_suite_modules_to_doctest(self):
 
2773
        # Test that a plausible list of modules to doctest is returned
 
2774
        # by _test_suite_modules_to_doctest.
 
2775
        test_list = tests._test_suite_modules_to_doctest()
 
2776
        if __doc__ is None:
 
2777
            # When docstrings are stripped, there are no modules to doctest
 
2778
            self.assertEqual([], test_list)
 
2779
            return
 
2780
        self.assertSubset([
 
2781
            'bzrlib.timestamp',
 
2782
            ],
 
2783
            test_list)
 
2784
 
 
2785
    def test_test_suite(self):
 
2786
        # test_suite() loads the entire test suite to operate. To avoid this
 
2787
        # overhead, and yet still be confident that things are happening,
 
2788
        # we temporarily replace two functions used by test_suite with 
 
2789
        # test doubles that supply a few sample tests to load, and check they
 
2790
        # are loaded.
 
2791
        calls = []
 
2792
        def testmod_names():
 
2793
            calls.append("testmod_names")
 
2794
            return [
 
2795
                'bzrlib.tests.blackbox.test_branch',
 
2796
                'bzrlib.tests.per_transport',
 
2797
                'bzrlib.tests.test_selftest',
 
2798
                ]
 
2799
        self.overrideAttr(tests, '_test_suite_testmod_names', testmod_names)
 
2800
        def doctests():
 
2801
            calls.append("modules_to_doctest")
 
2802
            if __doc__ is None:
 
2803
                return []
 
2804
            return ['bzrlib.timestamp']
 
2805
        self.overrideAttr(tests, '_test_suite_modules_to_doctest', doctests)
 
2806
        expected_test_list = [
 
2807
            # testmod_names
 
2808
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
 
2809
            ('bzrlib.tests.per_transport.TransportTests'
 
2810
             '.test_abspath(LocalTransport,LocalURLServer)'),
 
2811
            'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
 
2812
            # plugins can't be tested that way since selftest may be run with
 
2813
            # --no-plugins
 
2814
            ]
 
2815
        if __doc__ is not None:
 
2816
            expected_test_list.extend([
 
2817
                # modules_to_doctest
 
2818
                'bzrlib.timestamp.format_highres_date',
 
2819
                ])
 
2820
        suite = tests.test_suite()
 
2821
        self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
 
2822
            set(calls))
 
2823
        self.assertSubset(expected_test_list, _test_ids(suite))
 
2824
 
 
2825
    def test_test_suite_list_and_start(self):
 
2826
        # We cannot test this at the same time as the main load, because we want
 
2827
        # to know that starting_with == None works. So a second load is
 
2828
        # incurred - note that the starting_with parameter causes a partial load
 
2829
        # rather than a full load so this test should be pretty quick.
 
2830
        test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
 
2831
        suite = tests.test_suite(test_list,
 
2832
                                 ['bzrlib.tests.test_selftest.TestTestSuite'])
 
2833
        # test_test_suite_list_and_start is not included 
 
2834
        self.assertEquals(test_list, _test_ids(suite))
 
2835
 
 
2836
 
 
2837
class TestLoadTestIdList(tests.TestCaseInTempDir):
 
2838
 
 
2839
    def _create_test_list_file(self, file_name, content):
 
2840
        fl = open(file_name, 'wt')
 
2841
        fl.write(content)
 
2842
        fl.close()
 
2843
 
 
2844
    def test_load_unknown(self):
 
2845
        self.assertRaises(errors.NoSuchFile,
 
2846
                          tests.load_test_id_list, 'i_do_not_exist')
 
2847
 
 
2848
    def test_load_test_list(self):
 
2849
        test_list_fname = 'test.list'
 
2850
        self._create_test_list_file(test_list_fname,
 
2851
                                    'mod1.cl1.meth1\nmod2.cl2.meth2\n')
 
2852
        tlist = tests.load_test_id_list(test_list_fname)
 
2853
        self.assertEquals(2, len(tlist))
 
2854
        self.assertEquals('mod1.cl1.meth1', tlist[0])
 
2855
        self.assertEquals('mod2.cl2.meth2', tlist[1])
 
2856
 
 
2857
    def test_load_dirty_file(self):
 
2858
        test_list_fname = 'test.list'
 
2859
        self._create_test_list_file(test_list_fname,
 
2860
                                    '  mod1.cl1.meth1\n\nmod2.cl2.meth2  \n'
 
2861
                                    'bar baz\n')
 
2862
        tlist = tests.load_test_id_list(test_list_fname)
 
2863
        self.assertEquals(4, len(tlist))
 
2864
        self.assertEquals('mod1.cl1.meth1', tlist[0])
 
2865
        self.assertEquals('', tlist[1])
 
2866
        self.assertEquals('mod2.cl2.meth2', tlist[2])
 
2867
        self.assertEquals('bar baz', tlist[3])
 
2868
 
 
2869
 
 
2870
class TestFilteredByModuleTestLoader(tests.TestCase):
 
2871
 
 
2872
    def _create_loader(self, test_list):
 
2873
        id_filter = tests.TestIdList(test_list)
 
2874
        loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
 
2875
        return loader
 
2876
 
 
2877
    def test_load_tests(self):
 
2878
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2879
        loader = self._create_loader(test_list)
 
2880
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2881
        self.assertEquals(test_list, _test_ids(suite))
 
2882
 
 
2883
    def test_exclude_tests(self):
 
2884
        test_list = ['bogus']
 
2885
        loader = self._create_loader(test_list)
 
2886
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2887
        self.assertEquals([], _test_ids(suite))
 
2888
 
 
2889
 
 
2890
class TestFilteredByNameStartTestLoader(tests.TestCase):
 
2891
 
 
2892
    def _create_loader(self, name_start):
 
2893
        def needs_module(name):
 
2894
            return name.startswith(name_start) or name_start.startswith(name)
 
2895
        loader = TestUtil.FilteredByModuleTestLoader(needs_module)
 
2896
        return loader
 
2897
 
 
2898
    def test_load_tests(self):
 
2899
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2900
        loader = self._create_loader('bzrlib.tests.test_samp')
 
2901
 
 
2902
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2903
        self.assertEquals(test_list, _test_ids(suite))
 
2904
 
 
2905
    def test_load_tests_inside_module(self):
 
2906
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2907
        loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
 
2908
 
 
2909
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2910
        self.assertEquals(test_list, _test_ids(suite))
 
2911
 
 
2912
    def test_exclude_tests(self):
 
2913
        test_list = ['bogus']
 
2914
        loader = self._create_loader('bogus')
 
2915
 
 
2916
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2917
        self.assertEquals([], _test_ids(suite))
 
2918
 
 
2919
 
 
2920
class TestTestPrefixRegistry(tests.TestCase):
 
2921
 
 
2922
    def _get_registry(self):
 
2923
        tp_registry = tests.TestPrefixAliasRegistry()
 
2924
        return tp_registry
 
2925
 
 
2926
    def test_register_new_prefix(self):
 
2927
        tpr = self._get_registry()
 
2928
        tpr.register('foo', 'fff.ooo.ooo')
 
2929
        self.assertEquals('fff.ooo.ooo', tpr.get('foo'))
 
2930
 
 
2931
    def test_register_existing_prefix(self):
 
2932
        tpr = self._get_registry()
 
2933
        tpr.register('bar', 'bbb.aaa.rrr')
 
2934
        tpr.register('bar', 'bBB.aAA.rRR')
 
2935
        self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
 
2936
        self.assertThat(self.get_log(),
 
2937
            DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR", ELLIPSIS))
 
2938
 
 
2939
    def test_get_unknown_prefix(self):
 
2940
        tpr = self._get_registry()
 
2941
        self.assertRaises(KeyError, tpr.get, 'I am not a prefix')
 
2942
 
 
2943
    def test_resolve_prefix(self):
 
2944
        tpr = self._get_registry()
 
2945
        tpr.register('bar', 'bb.aa.rr')
 
2946
        self.assertEquals('bb.aa.rr', tpr.resolve_alias('bar'))
 
2947
 
 
2948
    def test_resolve_unknown_alias(self):
 
2949
        tpr = self._get_registry()
 
2950
        self.assertRaises(errors.BzrCommandError,
 
2951
                          tpr.resolve_alias, 'I am not a prefix')
 
2952
 
 
2953
    def test_predefined_prefixes(self):
 
2954
        tpr = tests.test_prefix_alias_registry
 
2955
        self.assertEquals('bzrlib', tpr.resolve_alias('bzrlib'))
 
2956
        self.assertEquals('bzrlib.doc', tpr.resolve_alias('bd'))
 
2957
        self.assertEquals('bzrlib.utils', tpr.resolve_alias('bu'))
 
2958
        self.assertEquals('bzrlib.tests', tpr.resolve_alias('bt'))
 
2959
        self.assertEquals('bzrlib.tests.blackbox', tpr.resolve_alias('bb'))
 
2960
        self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
 
2961
 
 
2962
 
 
2963
class TestRunSuite(tests.TestCase):
 
2964
 
 
2965
    def test_runner_class(self):
 
2966
        """run_suite accepts and uses a runner_class keyword argument."""
 
2967
        class Stub(tests.TestCase):
 
2968
            def test_foo(self):
 
2969
                pass
 
2970
        suite = Stub("test_foo")
 
2971
        calls = []
 
2972
        class MyRunner(tests.TextTestRunner):
 
2973
            def run(self, test):
 
2974
                calls.append(test)
 
2975
                return tests.ExtendedTestResult(self.stream, self.descriptions,
 
2976
                                                self.verbosity)
 
2977
        tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
 
2978
        self.assertLength(1, calls)