~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 14:01:20 UTC
  • mfrom: (3280.2.5 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080316140120-i3yq8yr1l66m11h7
Start 1.4 development

Show diffs side-by-side

added added

removed removed

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