~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Vincent Ladeuil
  • Date: 2007-11-24 14:20:59 UTC
  • mto: (3928.1.1 bzr.integration)
  • mto: This revision was merged to the branch mainline in revision 3929.
  • Revision ID: v.ladeuil+lp@free.fr-20071124142059-2114qtsgfdv8g9p1
Ssl files needed for the test https server.

* bzrlib/tests/ssl_certs/create_ssls.py: 
Script to create the ssl keys and certificates.

* bzrlib/tests/ssl_certs/server.crt: 
Server certificate signed by the certificate authority.

* bzrlib/tests/ssl_certs/server.csr: 
Server certificate signing request.

* bzrlib/tests/ssl_certs/server_without_pass.key: 
Server key usable without password.

* bzrlib/tests/ssl_certs/server_with_pass.key: 
Server key.

* bzrlib/tests/ssl_certs/ca.key: 
Certificate authority private key.

* bzrlib/tests/ssl_certs/ca.crt: 
Certificate authority certificate.

* bzrlib/tests/ssl_certs/__init__.py: 
Provide access to ssl files (keys and certificates). 

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