~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: John Arbash Meinel
  • Date: 2006-12-01 19:41:16 UTC
  • mfrom: (2158 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2159.
  • Revision ID: john@arbash-meinel.com-20061201194116-nvn5qhfxux5284jc
[merge] bzr.dev 2158

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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
 
    errors,
42
 
    lockdir,
43
30
    memorytree,
44
31
    osutils,
45
 
    progress,
46
 
    remote,
47
32
    repository,
48
 
    symbol_versioning,
49
 
    tests,
50
 
    transport,
51
 
    workingtree,
52
 
    )
53
 
from bzrlib.repofmt import (
54
 
    groupcompress_repo,
55
 
    pack_repo,
56
 
    weaverepo,
57
 
    )
58
 
from bzrlib.symbol_versioning import (
59
 
    deprecated_function,
60
 
    deprecated_in,
61
 
    deprecated_method,
62
 
    )
 
33
    )
 
34
from bzrlib.progress import _BaseProgressBar
63
35
from bzrlib.tests import (
64
 
    features,
65
 
    test_lsprof,
66
 
    test_server,
67
 
    test_sftp_transport,
68
 
    TestUtil,
69
 
    )
 
36
                          ChrootedTestCase,
 
37
                          TestCase,
 
38
                          TestCaseInTempDir,
 
39
                          TestCaseWithMemoryTransport,
 
40
                          TestCaseWithTransport,
 
41
                          TestSkipped,
 
42
                          TestSuite,
 
43
                          TextTestRunner,
 
44
                          )
 
45
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
 
46
from bzrlib.tests.TestUtil import _load_module_by_name
 
47
import bzrlib.errors as errors
 
48
from bzrlib import symbol_versioning
 
49
from bzrlib.symbol_versioning import zero_ten, zero_eleven
70
50
from bzrlib.trace import note
71
 
from bzrlib.transport import memory
 
51
from bzrlib.transport.memory import MemoryServer, MemoryTransport
72
52
from bzrlib.version import _get_bzr_source_tree
73
53
 
74
54
 
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):
 
55
class SelftestTests(TestCase):
81
56
 
82
57
    def test_import_tests(self):
83
 
        mod = TestUtil._load_module_by_name('bzrlib.tests.test_selftest')
 
58
        mod = _load_module_by_name('bzrlib.tests.test_selftest')
84
59
        self.assertEqual(mod.SelftestTests, SelftestTests)
85
60
 
86
61
    def test_import_test_failure(self):
87
62
        self.assertRaises(ImportError,
88
 
                          TestUtil._load_module_by_name,
 
63
                          _load_module_by_name,
89
64
                          'bzrlib.no-name-yet')
90
65
 
91
 
 
92
 
class MetaTestLog(tests.TestCase):
 
66
class MetaTestLog(TestCase):
93
67
 
94
68
    def test_logging(self):
95
69
        """Test logs are captured when a test fails."""
96
70
        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):
 
71
        self._log_file.flush()
 
72
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
73
                              'a test message\n')
 
74
 
 
75
 
 
76
class TestTreeShape(TestCaseInTempDir):
116
77
 
117
78
    def test_unicode_paths(self):
118
 
        self.requireFeature(tests.UnicodeFilename)
119
 
 
120
79
        filename = u'hell\u00d8'
121
 
        self.build_tree_contents([(filename, 'contents of hello')])
 
80
        try:
 
81
            self.build_tree_contents([(filename, 'contents of hello')])
 
82
        except UnicodeEncodeError:
 
83
            raise TestSkipped("can't build unicode working tree in "
 
84
                "filesystem encoding %s" % sys.getfilesystemencoding())
122
85
        self.failUnlessExists(filename)
123
86
 
124
87
 
125
 
class TestTransportScenarios(tests.TestCase):
 
88
class TestTransportProviderAdapter(TestCase):
126
89
    """A group of tests that test the transport implementation adaption core.
127
90
 
128
 
    This is a meta test that the tests are applied to all available
 
91
    This is a meta test that the tests are applied to all available 
129
92
    transports.
130
93
 
131
 
    This will be generalised in the future which is why it is in this
 
94
    This will be generalised in the future which is why it is in this 
132
95
    test file even though it is specific to transport tests at the moment.
133
96
    """
134
97
 
135
98
    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.
 
99
        # this checks that we the module get_test_permutations call
 
100
        # is made by the adapter get_transport_test_permitations method.
138
101
        class MockModule(object):
139
102
            def get_test_permutations(self):
140
103
                return sample_permutation
141
104
        sample_permutation = [(1,2), (3,4)]
142
 
        from bzrlib.tests.per_transport import get_transport_test_permutations
 
105
        from bzrlib.transport import TransportTestProviderAdapter
 
106
        adapter = TransportTestProviderAdapter()
143
107
        self.assertEqual(sample_permutation,
144
 
                         get_transport_test_permutations(MockModule()))
 
108
                         adapter.get_transport_test_permutations(MockModule()))
145
109
 
146
 
    def test_scenarios_include_all_modules(self):
147
 
        # this checks that the scenario generator returns as many permutations
148
 
        # as there are in all the registered transport modules - we assume if
149
 
        # this matches its probably doing the right thing especially in
150
 
        # combination with the tests for setting the right classes below.
151
 
        from bzrlib.tests.per_transport import transport_test_permutations
152
 
        from bzrlib.transport import _get_transport_modules
 
110
    def test_adapter_checks_all_modules(self):
 
111
        # this checks that the adapter returns as many permurtations as
 
112
        # there are in all the registered# transport modules for there
 
113
        # - we assume if this matches its probably doing the right thing
 
114
        # especially in combination with the tests for setting the right
 
115
        # classes below.
 
116
        from bzrlib.transport import (TransportTestProviderAdapter,
 
117
                                      _get_transport_modules
 
118
                                      )
153
119
        modules = _get_transport_modules()
154
120
        permutation_count = 0
155
121
        for module in modules:
156
122
            try:
157
 
                permutation_count += len(reduce(getattr,
 
123
                permutation_count += len(reduce(getattr, 
158
124
                    (module + ".get_test_permutations").split('.')[1:],
159
125
                     __import__(module))())
160
126
            except errors.DependencyNotPresent:
161
127
                pass
162
 
        scenarios = transport_test_permutations()
163
 
        self.assertEqual(permutation_count, len(scenarios))
 
128
        input_test = TestTransportProviderAdapter(
 
129
            "test_adapter_sets_transport_class")
 
130
        adapter = TransportTestProviderAdapter()
 
131
        self.assertEqual(permutation_count,
 
132
                         len(list(iter(adapter.adapt(input_test)))))
164
133
 
165
 
    def test_scenarios_include_transport_class(self):
 
134
    def test_adapter_sets_transport_class(self):
 
135
        # Check that the test adapter inserts a transport and server into the
 
136
        # generated test.
 
137
        #
166
138
        # This test used to know about all the possible transports and the
167
139
        # order they were returned but that seems overly brittle (mbp
168
140
        # 20060307)
169
 
        from bzrlib.tests.per_transport import transport_test_permutations
170
 
        scenarios = transport_test_permutations()
 
141
        input_test = TestTransportProviderAdapter(
 
142
            "test_adapter_sets_transport_class")
 
143
        from bzrlib.transport import TransportTestProviderAdapter
 
144
        suite = TransportTestProviderAdapter().adapt(input_test)
 
145
        tests = list(iter(suite))
 
146
        self.assertTrue(len(tests) > 6)
171
147
        # there are at least that many builtin transports
172
 
        self.assertTrue(len(scenarios) > 6)
173
 
        one_scenario = scenarios[0]
174
 
        self.assertIsInstance(one_scenario[0], str)
175
 
        self.assertTrue(issubclass(one_scenario[1]["transport_class"],
 
148
        one_test = tests[0]
 
149
        self.assertTrue(issubclass(one_test.transport_class, 
176
150
                                   bzrlib.transport.Transport))
177
 
        self.assertTrue(issubclass(one_scenario[1]["transport_server"],
 
151
        self.assertTrue(issubclass(one_test.transport_server, 
178
152
                                   bzrlib.transport.Server))
179
153
 
180
154
 
181
 
class TestBranchScenarios(tests.TestCase):
 
155
class TestBranchProviderAdapter(TestCase):
 
156
    """A group of tests that test the branch implementation test adapter."""
182
157
 
183
 
    def test_scenarios(self):
 
158
    def test_adapted_tests(self):
184
159
        # check that constructor parameters are passed through to the adapted
185
160
        # test.
186
 
        from bzrlib.tests.per_branch import make_scenarios
 
161
        from bzrlib.branch import BranchTestProviderAdapter
 
162
        input_test = TestBranchProviderAdapter(
 
163
            "test_adapted_tests")
187
164
        server1 = "a"
188
165
        server2 = "b"
189
166
        formats = [("c", "C"), ("d", "D")]
190
 
        scenarios = make_scenarios(server1, server2, formats)
191
 
        self.assertEqual(2, len(scenarios))
192
 
        self.assertEqual([
193
 
            ('str',
194
 
             {'branch_format': 'c',
195
 
              'bzrdir_format': 'C',
196
 
              'transport_readonly_server': 'b',
197
 
              'transport_server': 'a'}),
198
 
            ('str',
199
 
             {'branch_format': 'd',
200
 
              'bzrdir_format': 'D',
201
 
              'transport_readonly_server': 'b',
202
 
              'transport_server': 'a'})],
203
 
            scenarios)
204
 
 
205
 
 
206
 
class TestBzrDirScenarios(tests.TestCase):
207
 
 
208
 
    def test_scenarios(self):
 
167
        adapter = BranchTestProviderAdapter(server1, server2, formats)
 
168
        suite = adapter.adapt(input_test)
 
169
        tests = list(iter(suite))
 
170
        self.assertEqual(2, len(tests))
 
171
        self.assertEqual(tests[0].branch_format, formats[0][0])
 
172
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
 
173
        self.assertEqual(tests[0].transport_server, server1)
 
174
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
175
        self.assertEqual(tests[1].branch_format, formats[1][0])
 
176
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
 
177
        self.assertEqual(tests[1].transport_server, server1)
 
178
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
179
 
 
180
 
 
181
class TestBzrDirProviderAdapter(TestCase):
 
182
    """A group of tests that test the bzr dir implementation test adapter."""
 
183
 
 
184
    def test_adapted_tests(self):
209
185
        # check that constructor parameters are passed through to the adapted
210
186
        # test.
211
 
        from bzrlib.tests.per_bzrdir import make_scenarios
212
 
        vfs_factory = "v"
 
187
        from bzrlib.bzrdir import BzrDirTestProviderAdapter
 
188
        input_test = TestBzrDirProviderAdapter(
 
189
            "test_adapted_tests")
213
190
        server1 = "a"
214
191
        server2 = "b"
215
192
        formats = ["c", "d"]
216
 
        scenarios = make_scenarios(vfs_factory, server1, server2, formats)
217
 
        self.assertEqual([
218
 
            ('str',
219
 
             {'bzrdir_format': 'c',
220
 
              'transport_readonly_server': 'b',
221
 
              'transport_server': 'a',
222
 
              'vfs_transport_factory': 'v'}),
223
 
            ('str',
224
 
             {'bzrdir_format': 'd',
225
 
              'transport_readonly_server': 'b',
226
 
              'transport_server': 'a',
227
 
              'vfs_transport_factory': 'v'})],
228
 
            scenarios)
229
 
 
230
 
 
231
 
class TestRepositoryScenarios(tests.TestCase):
232
 
 
233
 
    def test_formats_to_scenarios(self):
234
 
        from bzrlib.tests.per_repository import formats_to_scenarios
235
 
        formats = [("(c)", remote.RemoteRepositoryFormat()),
236
 
                   ("(d)", repository.format_registry.get(
237
 
                    'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
238
 
        no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
239
 
            None)
240
 
        vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
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(),
247
 
              'transport_readonly_server': 'readonly',
248
 
              'transport_server': 'server'}),
249
 
            ('RepositoryFormat2a(d)',
250
 
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
251
 
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
252
 
              'transport_readonly_server': 'readonly',
253
 
              'transport_server': 'server'})]
254
 
        self.assertEqual(expected, no_vfs_scenarios)
255
 
        self.assertEqual([
256
 
            ('RemoteRepositoryFormat(c)',
257
 
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
258
 
              'repository_format': remote.RemoteRepositoryFormat(),
259
 
              'transport_readonly_server': 'readonly',
260
 
              'transport_server': 'server',
261
 
              'vfs_transport_factory': 'vfs'}),
262
 
            ('RepositoryFormat2a(d)',
263
 
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
264
 
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
265
 
              'transport_readonly_server': 'readonly',
266
 
              'transport_server': 'server',
267
 
              'vfs_transport_factory': 'vfs'})],
268
 
            vfs_scenarios)
269
 
 
270
 
 
271
 
class TestTestScenarioApplication(tests.TestCase):
272
 
    """Tests for the test adaption facilities."""
273
 
 
274
 
    def test_apply_scenario(self):
275
 
        from bzrlib.tests import apply_scenario
276
 
        input_test = TestTestScenarioApplication("test_apply_scenario")
277
 
        # setup two adapted tests
278
 
        adapted_test1 = apply_scenario(input_test,
279
 
            ("new id",
280
 
            {"bzrdir_format":"bzr_format",
281
 
             "repository_format":"repo_fmt",
282
 
             "transport_server":"transport_server",
283
 
             "transport_readonly_server":"readonly-server"}))
284
 
        adapted_test2 = apply_scenario(input_test,
285
 
            ("new id 2", {"bzrdir_format":None}))
286
 
        # input_test should have been altered.
287
 
        self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
288
 
        # the new tests are mutually incompatible, ensuring it has
289
 
        # made new ones, and unspecified elements in the scenario
290
 
        # should not have been altered.
291
 
        self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
292
 
        self.assertEqual("repo_fmt", adapted_test1.repository_format)
293
 
        self.assertEqual("transport_server", adapted_test1.transport_server)
294
 
        self.assertEqual("readonly-server",
295
 
            adapted_test1.transport_readonly_server)
296
 
        self.assertEqual(
297
 
            "bzrlib.tests.test_selftest.TestTestScenarioApplication."
298
 
            "test_apply_scenario(new id)",
299
 
            adapted_test1.id())
300
 
        self.assertEqual(None, adapted_test2.bzrdir_format)
301
 
        self.assertEqual(
302
 
            "bzrlib.tests.test_selftest.TestTestScenarioApplication."
303
 
            "test_apply_scenario(new id 2)",
304
 
            adapted_test2.id())
305
 
 
306
 
 
307
 
class TestInterRepositoryScenarios(tests.TestCase):
308
 
 
309
 
    def test_scenarios(self):
310
 
        # check that constructor parameters are passed through to the adapted
311
 
        # test.
312
 
        from bzrlib.tests.per_interrepository import make_scenarios
313
 
        server1 = "a"
314
 
        server2 = "b"
315
 
        formats = [("C0", "C1", "C2"), ("D0", "D1", "D2")]
316
 
        scenarios = make_scenarios(server1, server2, formats)
317
 
        self.assertEqual([
318
 
            ('C0,str,str',
319
 
             {'repository_format': 'C1',
320
 
              'repository_format_to': 'C2',
321
 
              'transport_readonly_server': 'b',
322
 
              'transport_server': 'a'}),
323
 
            ('D0,str,str',
324
 
             {'repository_format': 'D1',
325
 
              'repository_format_to': 'D2',
326
 
              'transport_readonly_server': 'b',
327
 
              'transport_server': 'a'})],
328
 
            scenarios)
329
 
 
330
 
 
331
 
class TestWorkingTreeScenarios(tests.TestCase):
332
 
 
333
 
    def test_scenarios(self):
334
 
        # check that constructor parameters are passed through to the adapted
335
 
        # test.
336
 
        from bzrlib.tests.per_workingtree import make_scenarios
337
 
        server1 = "a"
338
 
        server2 = "b"
339
 
        formats = [workingtree.WorkingTreeFormat2(),
340
 
                   workingtree.WorkingTreeFormat3(),]
341
 
        scenarios = make_scenarios(server1, server2, formats)
342
 
        self.assertEqual([
343
 
            ('WorkingTreeFormat2',
344
 
             {'bzrdir_format': formats[0]._matchingbzrdir,
345
 
              'transport_readonly_server': 'b',
346
 
              'transport_server': 'a',
347
 
              'workingtree_format': formats[0]}),
348
 
            ('WorkingTreeFormat3',
349
 
             {'bzrdir_format': formats[1]._matchingbzrdir,
350
 
              'transport_readonly_server': 'b',
351
 
              'transport_server': 'a',
352
 
              'workingtree_format': formats[1]})],
353
 
            scenarios)
354
 
 
355
 
 
356
 
class TestTreeScenarios(tests.TestCase):
357
 
 
358
 
    def test_scenarios(self):
359
 
        # the tree implementation scenario generator is meant to setup one
360
 
        # instance for each working tree format, and one additional instance
361
 
        # that will use the default wt format, but create a revision tree for
362
 
        # the tests.  this means that the wt ones should have the
363
 
        # workingtree_to_test_tree attribute set to 'return_parameter' and the
364
 
        # revision one set to revision_tree_from_workingtree.
365
 
 
366
 
        from bzrlib.tests.per_tree import (
367
 
            _dirstate_tree_from_workingtree,
368
 
            make_scenarios,
369
 
            preview_tree_pre,
370
 
            preview_tree_post,
 
193
        adapter = BzrDirTestProviderAdapter(server1, server2, formats)
 
194
        suite = adapter.adapt(input_test)
 
195
        tests = list(iter(suite))
 
196
        self.assertEqual(2, len(tests))
 
197
        self.assertEqual(tests[0].bzrdir_format, formats[0])
 
198
        self.assertEqual(tests[0].transport_server, server1)
 
199
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
200
        self.assertEqual(tests[1].bzrdir_format, formats[1])
 
201
        self.assertEqual(tests[1].transport_server, server1)
 
202
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
203
 
 
204
 
 
205
class TestRepositoryProviderAdapter(TestCase):
 
206
    """A group of tests that test the repository implementation test adapter."""
 
207
 
 
208
    def test_adapted_tests(self):
 
209
        # check that constructor parameters are passed through to the adapted
 
210
        # test.
 
211
        from bzrlib.repository import RepositoryTestProviderAdapter
 
212
        input_test = TestRepositoryProviderAdapter(
 
213
            "test_adapted_tests")
 
214
        server1 = "a"
 
215
        server2 = "b"
 
216
        formats = [("c", "C"), ("d", "D")]
 
217
        adapter = RepositoryTestProviderAdapter(server1, server2, formats)
 
218
        suite = adapter.adapt(input_test)
 
219
        tests = list(iter(suite))
 
220
        self.assertEqual(2, len(tests))
 
221
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
 
222
        self.assertEqual(tests[0].repository_format, formats[0][0])
 
223
        self.assertEqual(tests[0].transport_server, server1)
 
224
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
225
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
 
226
        self.assertEqual(tests[1].repository_format, formats[1][0])
 
227
        self.assertEqual(tests[1].transport_server, server1)
 
228
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
229
 
 
230
 
 
231
class TestInterRepositoryProviderAdapter(TestCase):
 
232
    """A group of tests that test the InterRepository test adapter."""
 
233
 
 
234
    def test_adapted_tests(self):
 
235
        # check that constructor parameters are passed through to the adapted
 
236
        # test.
 
237
        from bzrlib.repository import InterRepositoryTestProviderAdapter
 
238
        input_test = TestInterRepositoryProviderAdapter(
 
239
            "test_adapted_tests")
 
240
        server1 = "a"
 
241
        server2 = "b"
 
242
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
 
243
        adapter = InterRepositoryTestProviderAdapter(server1, server2, formats)
 
244
        suite = adapter.adapt(input_test)
 
245
        tests = list(iter(suite))
 
246
        self.assertEqual(2, len(tests))
 
247
        self.assertEqual(tests[0].interrepo_class, formats[0][0])
 
248
        self.assertEqual(tests[0].repository_format, formats[0][1])
 
249
        self.assertEqual(tests[0].repository_format_to, formats[0][2])
 
250
        self.assertEqual(tests[0].transport_server, server1)
 
251
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
252
        self.assertEqual(tests[1].interrepo_class, formats[1][0])
 
253
        self.assertEqual(tests[1].repository_format, formats[1][1])
 
254
        self.assertEqual(tests[1].repository_format_to, formats[1][2])
 
255
        self.assertEqual(tests[1].transport_server, server1)
 
256
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
257
 
 
258
 
 
259
class TestInterVersionedFileProviderAdapter(TestCase):
 
260
    """A group of tests that test the InterVersionedFile test adapter."""
 
261
 
 
262
    def test_adapted_tests(self):
 
263
        # check that constructor parameters are passed through to the adapted
 
264
        # test.
 
265
        from bzrlib.versionedfile import InterVersionedFileTestProviderAdapter
 
266
        input_test = TestInterRepositoryProviderAdapter(
 
267
            "test_adapted_tests")
 
268
        server1 = "a"
 
269
        server2 = "b"
 
270
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
 
271
        adapter = InterVersionedFileTestProviderAdapter(server1, server2, formats)
 
272
        suite = adapter.adapt(input_test)
 
273
        tests = list(iter(suite))
 
274
        self.assertEqual(2, len(tests))
 
275
        self.assertEqual(tests[0].interversionedfile_class, formats[0][0])
 
276
        self.assertEqual(tests[0].versionedfile_factory, formats[0][1])
 
277
        self.assertEqual(tests[0].versionedfile_factory_to, formats[0][2])
 
278
        self.assertEqual(tests[0].transport_server, server1)
 
279
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
280
        self.assertEqual(tests[1].interversionedfile_class, formats[1][0])
 
281
        self.assertEqual(tests[1].versionedfile_factory, formats[1][1])
 
282
        self.assertEqual(tests[1].versionedfile_factory_to, formats[1][2])
 
283
        self.assertEqual(tests[1].transport_server, server1)
 
284
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
285
 
 
286
 
 
287
class TestRevisionStoreProviderAdapter(TestCase):
 
288
    """A group of tests that test the RevisionStore test adapter."""
 
289
 
 
290
    def test_adapted_tests(self):
 
291
        # check that constructor parameters are passed through to the adapted
 
292
        # test.
 
293
        from bzrlib.store.revision import RevisionStoreTestProviderAdapter
 
294
        input_test = TestRevisionStoreProviderAdapter(
 
295
            "test_adapted_tests")
 
296
        # revision stores need a store factory - i.e. RevisionKnit
 
297
        #, a readonly and rw transport 
 
298
        # transport servers:
 
299
        server1 = "a"
 
300
        server2 = "b"
 
301
        store_factories = ["c", "d"]
 
302
        adapter = RevisionStoreTestProviderAdapter(server1, server2, store_factories)
 
303
        suite = adapter.adapt(input_test)
 
304
        tests = list(iter(suite))
 
305
        self.assertEqual(2, len(tests))
 
306
        self.assertEqual(tests[0].store_factory, store_factories[0][0])
 
307
        self.assertEqual(tests[0].transport_server, server1)
 
308
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
309
        self.assertEqual(tests[1].store_factory, store_factories[1][0])
 
310
        self.assertEqual(tests[1].transport_server, server1)
 
311
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
312
 
 
313
 
 
314
class TestWorkingTreeProviderAdapter(TestCase):
 
315
    """A group of tests that test the workingtree implementation test adapter."""
 
316
 
 
317
    def test_adapted_tests(self):
 
318
        # check that constructor parameters are passed through to the adapted
 
319
        # test.
 
320
        from bzrlib.workingtree import WorkingTreeTestProviderAdapter
 
321
        input_test = TestWorkingTreeProviderAdapter(
 
322
            "test_adapted_tests")
 
323
        server1 = "a"
 
324
        server2 = "b"
 
325
        formats = [("c", "C"), ("d", "D")]
 
326
        adapter = WorkingTreeTestProviderAdapter(server1, server2, formats)
 
327
        suite = adapter.adapt(input_test)
 
328
        tests = list(iter(suite))
 
329
        self.assertEqual(2, len(tests))
 
330
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
 
331
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
 
332
        self.assertEqual(tests[0].transport_server, server1)
 
333
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
334
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
 
335
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
 
336
        self.assertEqual(tests[1].transport_server, server1)
 
337
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
338
 
 
339
 
 
340
class TestTreeProviderAdapter(TestCase):
 
341
    """Test the setup of tree_implementation tests."""
 
342
 
 
343
    def test_adapted_tests(self):
 
344
        # the tree implementation adapter is meant to setup one instance for
 
345
        # each working tree format, and one additional instance that will
 
346
        # use the default wt format, but create a revision tree for the tests.
 
347
        # this means that the wt ones should have the workingtree_to_test_tree
 
348
        # attribute set to 'return_parameter' and the revision one set to
 
349
        # revision_tree_from_workingtree.
 
350
 
 
351
        from bzrlib.tests.tree_implementations import (
 
352
            TreeTestProviderAdapter,
371
353
            return_parameter,
372
354
            revision_tree_from_workingtree
373
355
            )
 
356
        from bzrlib.workingtree import WorkingTreeFormat
 
357
        input_test = TestTreeProviderAdapter(
 
358
            "test_adapted_tests")
374
359
        server1 = "a"
375
360
        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):
 
361
        formats = [("c", "C"), ("d", "D")]
 
362
        adapter = TreeTestProviderAdapter(server1, server2, formats)
 
363
        suite = adapter.adapt(input_test)
 
364
        tests = list(iter(suite))
 
365
        self.assertEqual(3, len(tests))
 
366
        default_format = WorkingTreeFormat.get_default_format()
 
367
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
 
368
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
 
369
        self.assertEqual(tests[0].transport_server, server1)
 
370
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
371
        self.assertEqual(tests[0].workingtree_to_test_tree, return_parameter)
 
372
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
 
373
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
 
374
        self.assertEqual(tests[1].transport_server, server1)
 
375
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
376
        self.assertEqual(tests[1].workingtree_to_test_tree, return_parameter)
 
377
        self.assertEqual(tests[2].workingtree_format, default_format)
 
378
        self.assertEqual(tests[2].bzrdir_format, default_format._matchingbzrdir)
 
379
        self.assertEqual(tests[2].transport_server, server1)
 
380
        self.assertEqual(tests[2].transport_readonly_server, server2)
 
381
        self.assertEqual(tests[2].workingtree_to_test_tree,
 
382
            revision_tree_from_workingtree)
 
383
 
 
384
 
 
385
class TestInterTreeProviderAdapter(TestCase):
436
386
    """A group of tests that test the InterTreeTestAdapter."""
437
387
 
438
 
    def test_scenarios(self):
 
388
    def test_adapted_tests(self):
439
389
        # check that constructor parameters are passed through to the adapted
440
390
        # test.
441
391
        # for InterTree tests we want the machinery to bring up two trees in
443
393
        # because each optimiser can be direction specific, we need to test
444
394
        # each optimiser in its chosen direction.
445
395
        # unlike the TestProviderAdapter we dont want to automatically add a
446
 
        # parameterized one for WorkingTree - the optimisers will tell us what
 
396
        # parameterised one for WorkingTree - the optimisers will tell us what
447
397
        # ones to add.
448
 
        from bzrlib.tests.per_tree import (
 
398
        from bzrlib.tests.tree_implementations import (
449
399
            return_parameter,
450
400
            revision_tree_from_workingtree
451
401
            )
452
 
        from bzrlib.tests.per_intertree import (
453
 
            make_scenarios,
 
402
        from bzrlib.tests.intertree_implementations import (
 
403
            InterTreeTestProviderAdapter,
454
404
            )
455
405
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
456
 
        input_test = TestInterTreeScenarios(
457
 
            "test_scenarios")
 
406
        input_test = TestInterTreeProviderAdapter(
 
407
            "test_adapted_tests")
458
408
        server1 = "a"
459
409
        server2 = "b"
460
410
        format1 = WorkingTreeFormat2()
461
411
        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):
 
412
        formats = [(str, format1, format2, False, True),
 
413
            (int, format2, format1, False, True)]
 
414
        adapter = InterTreeTestProviderAdapter(server1, server2, formats)
 
415
        suite = adapter.adapt(input_test)
 
416
        tests = list(iter(suite))
 
417
        self.assertEqual(2, len(tests))
 
418
        self.assertEqual(tests[0].intertree_class, formats[0][0])
 
419
        self.assertEqual(tests[0].workingtree_format, formats[0][1])
 
420
        self.assertEqual(tests[0].workingtree_to_test_tree, formats[0][2])
 
421
        self.assertEqual(tests[0].workingtree_format_to, formats[0][3])
 
422
        self.assertEqual(tests[0].workingtree_to_test_tree_to, formats[0][4])
 
423
        self.assertEqual(tests[0].transport_server, server1)
 
424
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
425
        self.assertEqual(tests[1].intertree_class, formats[1][0])
 
426
        self.assertEqual(tests[1].workingtree_format, formats[1][1])
 
427
        self.assertEqual(tests[1].workingtree_to_test_tree, formats[1][2])
 
428
        self.assertEqual(tests[1].workingtree_format_to, formats[1][3])
 
429
        self.assertEqual(tests[1].workingtree_to_test_tree_to, formats[1][4])
 
430
        self.assertEqual(tests[1].transport_server, server1)
 
431
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
432
 
 
433
 
 
434
class TestTestCaseInTempDir(TestCaseInTempDir):
492
435
 
493
436
    def test_home_is_not_working(self):
494
437
        self.assertNotEqual(self.test_dir, self.test_home_dir)
495
438
        cwd = osutils.getcwd()
496
 
        self.assertIsSameRealPath(self.test_dir, cwd)
497
 
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
498
 
 
499
 
    def test_assertEqualStat_equal(self):
500
 
        from bzrlib.tests.test_dirstate import _FakeStat
501
 
        self.build_tree(["foo"])
502
 
        real = os.lstat("foo")
503
 
        fake = _FakeStat(real.st_size, real.st_mtime, real.st_ctime,
504
 
            real.st_dev, real.st_ino, real.st_mode)
505
 
        self.assertEqualStat(real, fake)
506
 
 
507
 
    def test_assertEqualStat_notequal(self):
508
 
        self.build_tree(["foo", "longname"])
509
 
        self.assertRaises(AssertionError, self.assertEqualStat,
510
 
            os.lstat("foo"), os.lstat("longname"))
511
 
 
512
 
 
513
 
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
 
439
        self.assertEqual(self.test_dir, cwd)
 
440
        self.assertEqual(self.test_home_dir, os.environ['HOME'])
 
441
 
 
442
 
 
443
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
514
444
 
515
445
    def test_home_is_non_existant_dir_under_root(self):
516
446
        """The test_home_dir for TestCaseWithMemoryTransport is missing.
517
447
 
518
448
        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
 
449
        need any disk resources: they should be hooked into bzrlib in such a 
 
450
        way that no global settings are being changed by the test (only a 
521
451
        few tests should need to do that), and having a missing dir as home is
522
452
        an effective way to ensure that this is the case.
523
453
        """
524
 
        self.assertIsSameRealPath(
525
 
            self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
 
454
        self.assertEqual(self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
526
455
            self.test_home_dir)
527
 
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
528
 
 
 
456
        self.assertEqual(self.test_home_dir, os.environ['HOME'])
 
457
        
529
458
    def test_cwd_is_TEST_ROOT(self):
530
 
        self.assertIsSameRealPath(self.test_dir, self.TEST_ROOT)
 
459
        self.assertEqual(self.test_dir, self.TEST_ROOT)
531
460
        cwd = osutils.getcwd()
532
 
        self.assertIsSameRealPath(self.test_dir, cwd)
533
 
 
534
 
    def test_BZR_HOME_and_HOME_are_bytestrings(self):
535
 
        """The $BZR_HOME and $HOME environment variables should not be unicode.
536
 
 
537
 
        See https://bugs.launchpad.net/bzr/+bug/464174
538
 
        """
539
 
        self.assertIsInstance(os.environ['BZR_HOME'], str)
540
 
        self.assertIsInstance(os.environ['HOME'], str)
 
461
        self.assertEqual(self.test_dir, cwd)
541
462
 
542
463
    def test_make_branch_and_memory_tree(self):
543
464
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
546
467
        a branch and checking no directory was created at its relpath.
547
468
        """
548
469
        tree = self.make_branch_and_memory_tree('dir')
549
 
        # Guard against regression into MemoryTransport leaking
550
 
        # files to disk instead of keeping them in memory.
551
 
        self.failIf(osutils.lexists('dir'))
 
470
        self.failIfExists('dir')
552
471
        self.assertIsInstance(tree, memorytree.MemoryTree)
553
472
 
554
473
    def test_make_branch_and_memory_tree_with_format(self):
555
474
        """make_branch_and_memory_tree should accept a format option."""
556
475
        format = bzrdir.BzrDirMetaFormat1()
557
 
        format.repository_format = weaverepo.RepositoryFormat7()
 
476
        format.repository_format = repository.RepositoryFormat7()
558
477
        tree = self.make_branch_and_memory_tree('dir', format=format)
559
 
        # Guard against regression into MemoryTransport leaking
560
 
        # files to disk instead of keeping them in memory.
561
 
        self.failIf(osutils.lexists('dir'))
 
478
        self.failIfExists('dir')
562
479
        self.assertIsInstance(tree, memorytree.MemoryTree)
563
480
        self.assertEqual(format.repository_format.__class__,
564
481
            tree.branch.repository._format.__class__)
565
482
 
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):
 
483
 
 
484
class TestTestCaseWithTransport(TestCaseWithTransport):
621
485
    """Tests for the convenience functions TestCaseWithTransport introduces."""
622
486
 
623
487
    def test_get_readonly_url_none(self):
624
488
        from bzrlib.transport import get_transport
 
489
        from bzrlib.transport.memory import MemoryServer
625
490
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
626
 
        self.vfs_transport_factory = memory.MemoryServer
 
491
        self.transport_server = MemoryServer
627
492
        self.transport_readonly_server = None
628
493
        # calling get_readonly_transport() constructs a decorator on the url
629
494
        # for the server
636
501
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
637
502
 
638
503
    def test_get_readonly_url_http(self):
639
 
        from bzrlib.tests.http_server import HttpServer
 
504
        from bzrlib.tests.HttpServer import HttpServer
640
505
        from bzrlib.transport import get_transport
 
506
        from bzrlib.transport.local import LocalURLServer
641
507
        from bzrlib.transport.http import HttpTransportBase
642
 
        self.transport_server = test_server.LocalURLServer
 
508
        self.transport_server = LocalURLServer
643
509
        self.transport_readonly_server = HttpServer
644
510
        # calling get_readonly_transport() gives us a HTTP server instance.
645
511
        url = self.get_readonly_url()
659
525
        self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
660
526
        self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
661
527
 
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):
 
528
 
 
529
class TestTestCaseTransports(TestCaseWithTransport):
676
530
 
677
531
    def setUp(self):
678
532
        super(TestTestCaseTransports, self).setUp()
679
 
        self.vfs_transport_factory = memory.MemoryServer
 
533
        self.transport_server = MemoryServer
680
534
 
681
535
    def test_make_bzrdir_preserves_transport(self):
682
536
        t = self.get_transport()
683
537
        result_bzrdir = self.make_bzrdir('subdir')
684
 
        self.assertIsInstance(result_bzrdir.transport,
685
 
                              memory.MemoryTransport)
 
538
        self.assertIsInstance(result_bzrdir.transport, 
 
539
                              MemoryTransport)
686
540
        # should not be on disk, should only be in memory
687
541
        self.failIfExists('subdir')
688
542
 
689
543
 
690
 
class TestChrootedTest(tests.ChrootedTestCase):
 
544
class TestChrootedTest(ChrootedTestCase):
691
545
 
692
546
    def test_root_is_root(self):
693
547
        from bzrlib.transport import get_transport
696
550
        self.assertEqual(url, t.clone('..').base)
697
551
 
698
552
 
699
 
class TestProfileResult(tests.TestCase):
700
 
 
701
 
    def test_profiles_tests(self):
702
 
        self.requireFeature(test_lsprof.LSProfFeature)
703
 
        terminal = testtools.tests.helpers.ExtendedTestResult()
704
 
        result = tests.ProfileResult(terminal)
705
 
        class Sample(tests.TestCase):
706
 
            def a(self):
707
 
                self.sample_function()
708
 
            def sample_function(self):
709
 
                pass
710
 
        test = Sample("a")
711
 
        test.run(result)
712
 
        case = terminal._events[0][1]
713
 
        self.assertLength(1, case._benchcalls)
714
 
        # We must be able to unpack it as the test reporting code wants
715
 
        (_, _, _), stats = case._benchcalls[0]
716
 
        self.assertTrue(callable(stats.pprint))
717
 
 
718
 
 
719
 
class TestTestResult(tests.TestCase):
720
 
 
721
 
    def check_timing(self, test_case, expected_re):
 
553
class MockProgress(_BaseProgressBar):
 
554
    """Progress-bar standin that records calls.
 
555
 
 
556
    Useful for testing pb using code.
 
557
    """
 
558
 
 
559
    def __init__(self):
 
560
        _BaseProgressBar.__init__(self)
 
561
        self.calls = []
 
562
 
 
563
    def tick(self):
 
564
        self.calls.append(('tick',))
 
565
 
 
566
    def update(self, msg=None, current=None, total=None):
 
567
        self.calls.append(('update', msg, current, total))
 
568
 
 
569
    def clear(self):
 
570
        self.calls.append(('clear',))
 
571
 
 
572
    def note(self, msg, *args):
 
573
        self.calls.append(('note', msg, args))
 
574
 
 
575
 
 
576
class TestTestResult(TestCase):
 
577
 
 
578
    def test_elapsed_time_with_benchmarking(self):
722
579
        result = bzrlib.tests.TextTestResult(self._log_file,
723
 
                descriptions=0,
724
 
                verbosity=1,
725
 
                )
726
 
        capture = testtools.tests.helpers.ExtendedTestResult()
727
 
        test_case.run(MultiTestResult(result, capture))
728
 
        run_case = capture._events[0][1]
729
 
        timed_string = result._testTimeString(run_case)
730
 
        self.assertContainsRe(timed_string, expected_re)
731
 
 
732
 
    def test_test_reporting(self):
733
 
        class ShortDelayTestCase(tests.TestCase):
734
 
            def test_short_delay(self):
735
 
                time.sleep(0.003)
736
 
            def test_short_benchmark(self):
737
 
                self.time(time.sleep, 0.003)
738
 
        self.check_timing(ShortDelayTestCase('test_short_delay'),
739
 
                          r"^ +[0-9]+ms$")
740
 
        # if a benchmark time is given, we now show just that time followed by
741
 
        # a star
742
 
        self.check_timing(ShortDelayTestCase('test_short_benchmark'),
743
 
                          r"^ +[0-9]+ms\*$")
744
 
 
745
 
    def test_unittest_reporting_unittest_class(self):
746
 
        # getting the time from a non-bzrlib test works ok
747
 
        class ShortDelayTestCase(unittest.TestCase):
748
 
            def test_short_delay(self):
749
 
                time.sleep(0.003)
750
 
        self.check_timing(ShortDelayTestCase('test_short_delay'),
751
 
                          r"^ +[0-9]+ms$")
752
 
 
753
 
    def _patch_get_bzr_source_tree(self):
754
 
        # Reading from the actual source tree breaks isolation, but we don't
755
 
        # want to assume that thats *all* that would happen.
756
 
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree', lambda: None)
 
580
                                        descriptions=0,
 
581
                                        verbosity=1,
 
582
                                        )
 
583
        result._recordTestStartTime()
 
584
        time.sleep(0.003)
 
585
        result.extractBenchmarkTime(self)
 
586
        timed_string = result._testTimeString()
 
587
        # without explicit benchmarking, we should get a simple time.
 
588
        self.assertContainsRe(timed_string, "^         [ 1-9][0-9]ms$")
 
589
        # if a benchmark time is given, we want a x of y style result.
 
590
        self.time(time.sleep, 0.001)
 
591
        result.extractBenchmarkTime(self)
 
592
        timed_string = result._testTimeString()
 
593
        self.assertContainsRe(timed_string, "^   [ 1-9][0-9]ms/   [ 1-9][0-9]ms$")
 
594
        # extracting the time from a non-bzrlib testcase sets to None
 
595
        result._recordTestStartTime()
 
596
        result.extractBenchmarkTime(
 
597
            unittest.FunctionTestCase(self.test_elapsed_time_with_benchmarking))
 
598
        timed_string = result._testTimeString()
 
599
        self.assertContainsRe(timed_string, "^         [ 1-9][0-9]ms$")
 
600
        # cheat. Yes, wash thy mouth out with soap.
 
601
        self._benchtime = None
757
602
 
758
603
    def test_assigned_benchmark_file_stores_date(self):
759
 
        self._patch_get_bzr_source_tree()
760
604
        output = StringIO()
761
605
        result = bzrlib.tests.TextTestResult(self._log_file,
762
606
                                        descriptions=0,
764
608
                                        bench_history=output
765
609
                                        )
766
610
        output_string = output.getvalue()
 
611
        
767
612
        # if you are wondering about the regexp please read the comment in
768
613
        # test_bench_history (bzrlib.tests.test_selftest.TestRunner)
769
614
        # XXX: what comment?  -- Andrew Bennetts
770
615
        self.assertContainsRe(output_string, "--date [0-9.]+")
771
616
 
772
617
    def test_benchhistory_records_test_times(self):
773
 
        self._patch_get_bzr_source_tree()
774
618
        result_stream = StringIO()
775
619
        result = bzrlib.tests.TextTestResult(
776
620
            self._log_file,
789
633
        self.assertContainsRe(lines[1],
790
634
            " *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
791
635
            "._time_hello_world_encoding")
792
 
 
 
636
 
793
637
    def _time_hello_world_encoding(self):
794
638
        """Profile two sleep calls
795
 
 
 
639
        
796
640
        This is used to exercise the test framework.
797
641
        """
798
642
        self.time(unicode, 'hello', errors='replace')
800
644
 
801
645
    def test_lsprofiling(self):
802
646
        """Verbose test result prints lsprof statistics from test cases."""
803
 
        self.requireFeature(test_lsprof.LSProfFeature)
 
647
        try:
 
648
            import bzrlib.lsprof
 
649
        except ImportError:
 
650
            raise TestSkipped("lsprof not installed.")
804
651
        result_stream = StringIO()
805
652
        result = bzrlib.tests.VerboseTestResult(
806
653
            unittest._WritelnDecorator(result_stream),
816
663
        # execute the test, which should succeed and record profiles
817
664
        example_test_case.run(result)
818
665
        # lsprofile_something()
819
 
        # if this worked we want
 
666
        # if this worked we want 
820
667
        # LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
821
668
        #    CallCount    Recursive    Total(ms)   Inline(ms) module:lineno(function)
822
669
        # (the lsprof header)
823
670
        # ... an arbitrary number of lines
824
671
        # and the function call which is time.sleep.
825
 
        #           1        0            ???         ???       ???(sleep)
 
672
        #           1        0            ???         ???       ???(sleep) 
826
673
        # and then repeated but with 'world', rather than 'hello'.
827
674
        # this should appear in the output stream of our test result.
828
675
        output = result_stream.getvalue()
835
682
        self.assertContainsRe(output,
836
683
            r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
837
684
 
838
 
    def test_known_failure(self):
839
 
        """A KnownFailure being raised should trigger several result actions."""
840
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
841
 
            def stopTestRun(self): pass
842
 
            def startTests(self): pass
843
 
            def report_test_start(self, test): pass
844
 
            def report_known_failure(self, test, err=None, details=None):
845
 
                self._call = test, 'known failure'
846
 
        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")
851
 
        test.run(result)
852
 
        # it should invoke 'report_known_failure'.
853
 
        self.assertEqual(2, len(result._call))
854
 
        self.assertEqual(test.id(), result._call[0].id())
855
 
        self.assertEqual('known failure', result._call[1])
856
 
        # we dont introspec the traceback, if the rest is ok, it would be
857
 
        # exceptional for it not to be.
858
 
        # it should update the known_failure_count on the object.
859
 
        self.assertEqual(1, result.known_failure_count)
860
 
        # the result should be successful.
861
 
        self.assertTrue(result.wasSuccessful())
862
 
 
863
 
    def test_verbose_report_known_failure(self):
864
 
        # verbose test output formatting
865
 
        result_stream = StringIO()
866
 
        result = bzrlib.tests.VerboseTestResult(
867
 
            unittest._WritelnDecorator(result_stream),
868
 
            descriptions=0,
869
 
            verbosity=2,
870
 
            )
871
 
        test = self.get_passing_test()
872
 
        result.startTest(test)
873
 
        prefix = len(result_stream.getvalue())
874
 
        # the err parameter has the shape:
875
 
        # (class, exception object, traceback)
876
 
        # KnownFailures dont get their tracebacks shown though, so we
877
 
        # can skip that.
878
 
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
879
 
        result.report_known_failure(test, err)
880
 
        output = result_stream.getvalue()[prefix:]
881
 
        lines = output.splitlines()
882
 
        self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
883
 
        self.assertEqual(lines[1], '    foo')
884
 
        self.assertEqual(2, len(lines))
885
 
 
886
 
    def get_passing_test(self):
887
 
        """Return a test object that can't be run usefully."""
888
 
        def passing_test():
889
 
            pass
890
 
        return unittest.FunctionTestCase(passing_test)
891
 
 
892
 
    def test_add_not_supported(self):
893
 
        """Test the behaviour of invoking addNotSupported."""
894
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
895
 
            def stopTestRun(self): pass
896
 
            def startTests(self): pass
897
 
            def report_test_start(self, test): pass
898
 
            def report_unsupported(self, test, feature):
899
 
                self._call = test, feature
900
 
        result = InstrumentedTestResult(None, None, None, None)
901
 
        test = SampleTestCase('_test_pass')
902
 
        feature = tests.Feature()
903
 
        result.startTest(test)
904
 
        result.addNotSupported(test, feature)
905
 
        # it should invoke 'report_unsupported'.
906
 
        self.assertEqual(2, len(result._call))
907
 
        self.assertEqual(test, result._call[0])
908
 
        self.assertEqual(feature, result._call[1])
909
 
        # the result should be successful.
910
 
        self.assertTrue(result.wasSuccessful())
911
 
        # it should record the test against a count of tests not run due to
912
 
        # this feature.
913
 
        self.assertEqual(1, result.unsupported['Feature'])
914
 
        # and invoking it again should increment that counter
915
 
        result.addNotSupported(test, feature)
916
 
        self.assertEqual(2, result.unsupported['Feature'])
917
 
 
918
 
    def test_verbose_report_unsupported(self):
919
 
        # verbose test output formatting
920
 
        result_stream = StringIO()
921
 
        result = bzrlib.tests.VerboseTestResult(
922
 
            unittest._WritelnDecorator(result_stream),
923
 
            descriptions=0,
924
 
            verbosity=2,
925
 
            )
926
 
        test = self.get_passing_test()
927
 
        feature = tests.Feature()
928
 
        result.startTest(test)
929
 
        prefix = len(result_stream.getvalue())
930
 
        result.report_unsupported(test, feature)
931
 
        output = result_stream.getvalue()[prefix:]
932
 
        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
 
 
938
 
    def test_unavailable_exception(self):
939
 
        """An UnavailableFeature being raised should invoke addNotSupported."""
940
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
941
 
            def stopTestRun(self): pass
942
 
            def startTests(self): pass
943
 
            def report_test_start(self, test): pass
944
 
            def addNotSupported(self, test, feature):
945
 
                self._call = test, feature
946
 
        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")
952
 
        test.run(result)
953
 
        # it should invoke 'addNotSupported'.
954
 
        self.assertEqual(2, len(result._call))
955
 
        self.assertEqual(test.id(), result._call[0].id())
956
 
        self.assertEqual(feature, result._call[1])
957
 
        # and not count as an error
958
 
        self.assertEqual(0, result.error_count)
959
 
 
960
 
    def test_strict_with_unsupported_feature(self):
961
 
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
962
 
                                             verbosity=1)
963
 
        test = self.get_passing_test()
964
 
        feature = "Unsupported Feature"
965
 
        result.addNotSupported(test, feature)
966
 
        self.assertFalse(result.wasStrictlySuccessful())
967
 
        self.assertEqual(None, result._extractBenchmarkTime(test))
968
 
 
969
 
    def test_strict_with_known_failure(self):
970
 
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
971
 
                                             verbosity=1)
972
 
        test = self.get_passing_test()
973
 
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
974
 
        result.addExpectedFailure(test, err)
975
 
        self.assertFalse(result.wasStrictlySuccessful())
976
 
        self.assertEqual(None, result._extractBenchmarkTime(test))
977
 
 
978
 
    def test_strict_with_success(self):
979
 
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
980
 
                                             verbosity=1)
981
 
        test = self.get_passing_test()
982
 
        result.addSuccess(test)
983
 
        self.assertTrue(result.wasStrictlySuccessful())
984
 
        self.assertEqual(None, result._extractBenchmarkTime(test))
985
 
 
986
 
    def test_startTests(self):
987
 
        """Starting the first test should trigger startTests."""
988
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
989
 
            calls = 0
990
 
            def startTests(self): self.calls += 1
991
 
            def report_test_start(self, test): pass
992
 
        result = InstrumentedTestResult(None, None, None, None)
993
 
        def test_function():
994
 
            pass
995
 
        test = unittest.FunctionTestCase(test_function)
996
 
        test.run(result)
997
 
        self.assertEquals(1, result.calls)
998
 
 
999
 
 
1000
 
class TestUnicodeFilenameFeature(tests.TestCase):
1001
 
 
1002
 
    def test_probe_passes(self):
1003
 
        """UnicodeFilenameFeature._probe passes."""
1004
 
        # We can't test much more than that because the behaviour depends
1005
 
        # on the platform.
1006
 
        tests.UnicodeFilenameFeature._probe()
1007
 
 
1008
 
 
1009
 
class TestRunner(tests.TestCase):
 
685
 
 
686
class TestRunner(TestCase):
1010
687
 
1011
688
    def dummy_test(self):
1012
689
        pass
1016
693
 
1017
694
        This current saves and restores:
1018
695
        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.
 
696
        
 
697
        There should be no tests in this file that use bzrlib.tests.TextTestRunner
 
698
        without using this convenience method, because of our use of global state.
1023
699
        """
1024
 
        old_root = tests.TestCaseInTempDir.TEST_ROOT
1025
 
        old_leak = tests.TestCase._first_thread_leaker_id
 
700
        old_root = TestCaseInTempDir.TEST_ROOT
1026
701
        try:
1027
 
            tests.TestCaseInTempDir.TEST_ROOT = None
1028
 
            tests.TestCase._first_thread_leaker_id = None
 
702
            TestCaseInTempDir.TEST_ROOT = None
1029
703
            return testrunner.run(test)
1030
704
        finally:
1031
 
            tests.TestCaseInTempDir.TEST_ROOT = old_root
1032
 
            tests.TestCase._first_thread_leaker_id = old_leak
1033
 
 
1034
 
    def test_known_failure_failed_run(self):
1035
 
        # run a test that generates a known failure which should be printed in
1036
 
        # 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)
1040
 
        test = unittest.TestSuite()
1041
 
        test.addTest(Test("known_failure_test"))
1042
 
        def failing_test():
1043
 
            self.fail('foo')
1044
 
        test.addTest(unittest.FunctionTestCase(failing_test))
1045
 
        stream = StringIO()
1046
 
        runner = tests.TextTestRunner(stream=stream)
1047
 
        result = self.run_test_runner(runner, test)
1048
 
        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
 
            )
1063
 
 
1064
 
    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")
1071
 
        stream = StringIO()
1072
 
        runner = tests.TextTestRunner(stream=stream)
1073
 
        result = self.run_test_runner(runner, test)
1074
 
        self.assertContainsRe(stream.getvalue(),
1075
 
            '\n'
1076
 
            '-*\n'
1077
 
            'Ran 1 test in .*\n'
1078
 
            '\n'
1079
 
            'OK \\(known_failures=1\\)\n')
1080
 
 
1081
 
    def test_result_decorator(self):
1082
 
        # decorate results
1083
 
        calls = []
1084
 
        class LoggingDecorator(tests.ForwardingResult):
1085
 
            def startTest(self, test):
1086
 
                tests.ForwardingResult.startTest(self, test)
1087
 
                calls.append('start')
1088
 
        test = unittest.FunctionTestCase(lambda:None)
1089
 
        stream = StringIO()
1090
 
        runner = tests.TextTestRunner(stream=stream,
1091
 
            result_decorators=[LoggingDecorator])
1092
 
        result = self.run_test_runner(runner, test)
1093
 
        self.assertLength(1, calls)
 
705
            TestCaseInTempDir.TEST_ROOT = old_root
1094
706
 
1095
707
    def test_skipped_test(self):
1096
708
        # run a test that is skipped, and check the suite as a whole still
1097
709
        # succeeds.
1098
710
        # 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
 
        result = self.run_test_runner(runner, test)
1105
 
        self.assertTrue(result.wasSuccessful())
1106
 
 
1107
 
    def test_skipped_from_setup(self):
1108
 
        calls = []
1109
 
        class SkippedSetupTest(tests.TestCase):
1110
 
 
1111
 
            def setUp(self):
1112
 
                calls.append('setUp')
1113
 
                self.addCleanup(self.cleanup)
1114
 
                raise tests.TestSkipped('skipped setup')
1115
 
 
1116
 
            def test_skip(self):
1117
 
                self.fail('test reached')
1118
 
 
1119
 
            def cleanup(self):
1120
 
                calls.append('cleanup')
1121
 
 
1122
 
        runner = tests.TextTestRunner(stream=self._log_file)
1123
 
        test = SkippedSetupTest('test_skip')
1124
 
        result = self.run_test_runner(runner, test)
1125
 
        self.assertTrue(result.wasSuccessful())
1126
 
        # Check if cleanup was called the right number of times.
1127
 
        self.assertEqual(['setUp', 'cleanup'], calls)
1128
 
 
1129
 
    def test_skipped_from_test(self):
1130
 
        calls = []
1131
 
        class SkippedTest(tests.TestCase):
1132
 
 
1133
 
            def setUp(self):
1134
 
                tests.TestCase.setUp(self)
1135
 
                calls.append('setUp')
1136
 
                self.addCleanup(self.cleanup)
1137
 
 
1138
 
            def test_skip(self):
1139
 
                raise tests.TestSkipped('skipped test')
1140
 
 
1141
 
            def cleanup(self):
1142
 
                calls.append('cleanup')
1143
 
 
1144
 
        runner = tests.TextTestRunner(stream=self._log_file)
1145
 
        test = SkippedTest('test_skip')
1146
 
        result = self.run_test_runner(runner, test)
1147
 
        self.assertTrue(result.wasSuccessful())
1148
 
        # Check if cleanup was called the right number of times.
1149
 
        self.assertEqual(['setUp', 'cleanup'], calls)
1150
 
 
1151
 
    def test_not_applicable(self):
1152
 
        # run a test that is skipped because it's not applicable
1153
 
        class Test(tests.TestCase):
1154
 
            def not_applicable_test(self):
1155
 
                raise tests.TestNotApplicable('this test never runs')
1156
 
        out = StringIO()
1157
 
        runner = tests.TextTestRunner(stream=out, verbosity=2)
1158
 
        test = Test("not_applicable_test")
1159
 
        result = self.run_test_runner(runner, test)
1160
 
        self._log_file.write(out.getvalue())
1161
 
        self.assertTrue(result.wasSuccessful())
1162
 
        self.assertTrue(result.wasStrictlySuccessful())
1163
 
        self.assertContainsRe(out.getvalue(),
1164
 
                r'(?m)not_applicable_test   * N/A')
1165
 
        self.assertContainsRe(out.getvalue(),
1166
 
                r'(?m)^    this test never runs')
1167
 
 
1168
 
    def test_unsupported_features_listed(self):
1169
 
        """When unsupported features are encountered they are detailed."""
1170
 
        class Feature1(tests.Feature):
1171
 
            def _probe(self): return False
1172
 
        class Feature2(tests.Feature):
1173
 
            def _probe(self): return False
1174
 
        # create sample tests
1175
 
        test1 = SampleTestCase('_test_pass')
1176
 
        test1._test_needs_features = [Feature1()]
1177
 
        test2 = SampleTestCase('_test_pass')
1178
 
        test2._test_needs_features = [Feature2()]
1179
 
        test = unittest.TestSuite()
1180
 
        test.addTest(test1)
1181
 
        test.addTest(test2)
1182
 
        stream = StringIO()
1183
 
        runner = tests.TextTestRunner(stream=stream)
1184
 
        result = self.run_test_runner(runner, test)
1185
 
        lines = stream.getvalue().splitlines()
1186
 
        self.assertEqual([
1187
 
            'OK',
1188
 
            "Missing feature 'Feature1' skipped 1 tests.",
1189
 
            "Missing feature 'Feature2' skipped 1 tests.",
1190
 
            ],
1191
 
            lines[-3:])
1192
 
 
1193
 
    def _patch_get_bzr_source_tree(self):
1194
 
        # Reading from the actual source tree breaks isolation, but we don't
1195
 
        # want to assume that thats *all* that would happen.
1196
 
        self._get_source_tree_calls = []
1197
 
        def new_get():
1198
 
            self._get_source_tree_calls.append("called")
1199
 
            return None
1200
 
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree',  new_get)
 
711
        def skipping_test():
 
712
            raise TestSkipped('test intentionally skipped')
 
713
        runner = TextTestRunner(stream=self._log_file, keep_output=True)
 
714
        test = unittest.FunctionTestCase(skipping_test)
 
715
        result = self.run_test_runner(runner, test)
 
716
        self.assertTrue(result.wasSuccessful())
1201
717
 
1202
718
    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()
 
719
        # tests that the running the benchmark produces a history file
 
720
        # containing a timestamp and the revision id of the bzrlib source which
 
721
        # was tested.
 
722
        workingtree = _get_bzr_source_tree()
1207
723
        test = TestRunner('dummy_test')
1208
724
        output = StringIO()
1209
 
        runner = tests.TextTestRunner(stream=self._log_file,
1210
 
                                      bench_history=output)
 
725
        runner = TextTestRunner(stream=self._log_file, bench_history=output)
1211
726
        result = self.run_test_runner(runner, test)
1212
727
        output_string = output.getvalue()
1213
728
        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):
1246
 
 
1247
 
    def _test_pass(self):
1248
 
        pass
1249
 
 
1250
 
class _TestException(Exception):
1251
 
    pass
1252
 
 
1253
 
 
1254
 
class TestTestCase(tests.TestCase):
 
729
        if workingtree is not None:
 
730
            revision_id = workingtree.get_parent_ids()[0]
 
731
            self.assertEndsWith(output_string.rstrip(), revision_id)
 
732
 
 
733
    def test_success_log_deleted(self):
 
734
        """Successful tests have their log deleted"""
 
735
 
 
736
        class LogTester(TestCase):
 
737
 
 
738
            def test_success(self):
 
739
                self.log('this will be removed\n')
 
740
 
 
741
        sio = cStringIO.StringIO()
 
742
        runner = TextTestRunner(stream=sio)
 
743
        test = LogTester('test_success')
 
744
        result = self.run_test_runner(runner, test)
 
745
 
 
746
        log = test._get_log()
 
747
        self.assertEqual("DELETED log file to reduce memory footprint", log)
 
748
        self.assertEqual('', test._log_contents)
 
749
        self.assertIs(None, test._log_file_name)
 
750
 
 
751
    def test_fail_log_kept(self):
 
752
        """Failed tests have their log kept"""
 
753
 
 
754
        class LogTester(TestCase):
 
755
 
 
756
            def test_fail(self):
 
757
                self.log('this will be kept\n')
 
758
                self.fail('this test fails')
 
759
 
 
760
        sio = cStringIO.StringIO()
 
761
        runner = TextTestRunner(stream=sio)
 
762
        test = LogTester('test_fail')
 
763
        result = self.run_test_runner(runner, test)
 
764
 
 
765
        text = sio.getvalue()
 
766
        self.assertContainsRe(text, 'this will be kept')
 
767
        self.assertContainsRe(text, 'this test fails')
 
768
 
 
769
        log = test._get_log()
 
770
        self.assertContainsRe(log, 'this will be kept')
 
771
        self.assertEqual(log, test._log_contents)
 
772
 
 
773
    def test_error_log_kept(self):
 
774
        """Tests with errors have their log kept"""
 
775
 
 
776
        class LogTester(TestCase):
 
777
 
 
778
            def test_error(self):
 
779
                self.log('this will be kept\n')
 
780
                raise ValueError('random exception raised')
 
781
 
 
782
        sio = cStringIO.StringIO()
 
783
        runner = TextTestRunner(stream=sio)
 
784
        test = LogTester('test_error')
 
785
        result = self.run_test_runner(runner, test)
 
786
 
 
787
        text = sio.getvalue()
 
788
        self.assertContainsRe(text, 'this will be kept')
 
789
        self.assertContainsRe(text, 'random exception raised')
 
790
 
 
791
        log = test._get_log()
 
792
        self.assertContainsRe(log, 'this will be kept')
 
793
        self.assertEqual(log, test._log_contents)
 
794
 
 
795
 
 
796
class TestTestCase(TestCase):
1255
797
    """Tests that test the core bzrlib TestCase."""
1256
798
 
1257
 
    def test_assertLength_matches_empty(self):
1258
 
        a_list = []
1259
 
        self.assertLength(0, a_list)
1260
 
 
1261
 
    def test_assertLength_matches_nonempty(self):
1262
 
        a_list = [1, 2, 3]
1263
 
        self.assertLength(3, a_list)
1264
 
 
1265
 
    def test_assertLength_fails_different(self):
1266
 
        a_list = []
1267
 
        self.assertRaises(AssertionError, self.assertLength, 1, a_list)
1268
 
 
1269
 
    def test_assertLength_shows_sequence_in_failure(self):
1270
 
        a_list = [1, 2, 3]
1271
 
        exception = self.assertRaises(AssertionError, self.assertLength, 2,
1272
 
            a_list)
1273
 
        self.assertEqual('Incorrect length: wanted 2, got 3 for [1, 2, 3]',
1274
 
            exception.args[0])
1275
 
 
1276
 
    def test_base_setUp_not_called_causes_failure(self):
1277
 
        class TestCaseWithBrokenSetUp(tests.TestCase):
1278
 
            def setUp(self):
1279
 
                pass # does not call TestCase.setUp
1280
 
            def test_foo(self):
1281
 
                pass
1282
 
        test = TestCaseWithBrokenSetUp('test_foo')
1283
 
        result = unittest.TestResult()
1284
 
        test.run(result)
1285
 
        self.assertFalse(result.wasSuccessful())
1286
 
        self.assertEqual(1, result.testsRun)
1287
 
 
1288
 
    def test_base_tearDown_not_called_causes_failure(self):
1289
 
        class TestCaseWithBrokenTearDown(tests.TestCase):
1290
 
            def tearDown(self):
1291
 
                pass # does not call TestCase.tearDown
1292
 
            def test_foo(self):
1293
 
                pass
1294
 
        test = TestCaseWithBrokenTearDown('test_foo')
1295
 
        result = unittest.TestResult()
1296
 
        test.run(result)
1297
 
        self.assertFalse(result.wasSuccessful())
1298
 
        self.assertEqual(1, result.testsRun)
1299
 
 
1300
 
    def test_debug_flags_sanitised(self):
1301
 
        """The bzrlib debug flags should be sanitised by setUp."""
1302
 
        if 'allow_debug' in tests.selftest_debug_flags:
1303
 
            raise tests.TestNotApplicable(
1304
 
                '-Eallow_debug option prevents debug flag sanitisation')
1305
 
        # we could set something and run a test that will check
1306
 
        # it gets santised, but this is probably sufficient for now:
1307
 
        # if someone runs the test with -Dsomething it will error.
1308
 
        flags = set()
1309
 
        if self._lock_check_thorough:
1310
 
            flags.add('strict_locks')
1311
 
        self.assertEqual(flags, bzrlib.debug.debug_flags)
1312
 
 
1313
 
    def change_selftest_debug_flags(self, new_flags):
1314
 
        self.overrideAttr(tests, 'selftest_debug_flags', set(new_flags))
1315
 
 
1316
 
    def test_allow_debug_flag(self):
1317
 
        """The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1318
 
        sanitised (i.e. cleared) before running a test.
1319
 
        """
1320
 
        self.change_selftest_debug_flags(set(['allow_debug']))
1321
 
        bzrlib.debug.debug_flags = set(['a-flag'])
1322
 
        class TestThatRecordsFlags(tests.TestCase):
1323
 
            def test_foo(nested_self):
1324
 
                self.flags = set(bzrlib.debug.debug_flags)
1325
 
        test = TestThatRecordsFlags('test_foo')
1326
 
        test.run(self.make_test_result())
1327
 
        flags = set(['a-flag'])
1328
 
        if 'disable_lock_checks' not in tests.selftest_debug_flags:
1329
 
            flags.add('strict_locks')
1330
 
        self.assertEqual(flags, self.flags)
1331
 
 
1332
 
    def test_disable_lock_checks(self):
1333
 
        """The -Edisable_lock_checks flag disables thorough checks."""
1334
 
        class TestThatRecordsFlags(tests.TestCase):
1335
 
            def test_foo(nested_self):
1336
 
                self.flags = set(bzrlib.debug.debug_flags)
1337
 
                self.test_lock_check_thorough = nested_self._lock_check_thorough
1338
 
        self.change_selftest_debug_flags(set())
1339
 
        test = TestThatRecordsFlags('test_foo')
1340
 
        test.run(self.make_test_result())
1341
 
        # By default we do strict lock checking and thorough lock/unlock
1342
 
        # tracking.
1343
 
        self.assertTrue(self.test_lock_check_thorough)
1344
 
        self.assertEqual(set(['strict_locks']), self.flags)
1345
 
        # Now set the disable_lock_checks flag, and show that this changed.
1346
 
        self.change_selftest_debug_flags(set(['disable_lock_checks']))
1347
 
        test = TestThatRecordsFlags('test_foo')
1348
 
        test.run(self.make_test_result())
1349
 
        self.assertFalse(self.test_lock_check_thorough)
1350
 
        self.assertEqual(set(), self.flags)
1351
 
 
1352
 
    def test_this_fails_strict_lock_check(self):
1353
 
        class TestThatRecordsFlags(tests.TestCase):
1354
 
            def test_foo(nested_self):
1355
 
                self.flags1 = set(bzrlib.debug.debug_flags)
1356
 
                self.thisFailsStrictLockCheck()
1357
 
                self.flags2 = set(bzrlib.debug.debug_flags)
1358
 
        # Make sure lock checking is active
1359
 
        self.change_selftest_debug_flags(set())
1360
 
        test = TestThatRecordsFlags('test_foo')
1361
 
        test.run(self.make_test_result())
1362
 
        self.assertEqual(set(['strict_locks']), self.flags1)
1363
 
        self.assertEqual(set(), self.flags2)
1364
 
 
1365
 
    def test_debug_flags_restored(self):
1366
 
        """The bzrlib debug flags should be restored to their original state
1367
 
        after the test was run, even if allow_debug is set.
1368
 
        """
1369
 
        self.change_selftest_debug_flags(set(['allow_debug']))
1370
 
        # Now run a test that modifies debug.debug_flags.
1371
 
        bzrlib.debug.debug_flags = set(['original-state'])
1372
 
        class TestThatModifiesFlags(tests.TestCase):
1373
 
            def test_foo(self):
1374
 
                bzrlib.debug.debug_flags = set(['modified'])
1375
 
        test = TestThatModifiesFlags('test_foo')
1376
 
        test.run(self.make_test_result())
1377
 
        self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1378
 
 
1379
 
    def make_test_result(self):
1380
 
        """Get a test result that writes to the test log file."""
1381
 
        return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
1382
 
 
1383
799
    def inner_test(self):
1384
800
        # the inner child test
1385
801
        note("inner_test")
1388
804
        # the outer child test
1389
805
        note("outer_start")
1390
806
        self.inner_test = TestTestCase("inner_child")
1391
 
        result = self.make_test_result()
 
807
        result = bzrlib.tests.TextTestResult(self._log_file,
 
808
                                        descriptions=0,
 
809
                                        verbosity=1)
1392
810
        self.inner_test.run(result)
1393
811
        note("outer finish")
1394
 
        self.addCleanup(osutils.delete_any, self._log_file_name)
1395
812
 
1396
813
    def test_trace_nesting(self):
1397
814
        # this tests that each test case nests its trace facility correctly.
1399
816
        # should setup a new log, log content to it, setup a child case (B),
1400
817
        # which should log independently, then case (A) should log a trailer
1401
818
        # and return.
1402
 
        # we do two nested children so that we can verify the state of the
 
819
        # we do two nested children so that we can verify the state of the 
1403
820
        # logs after the outer child finishes is correct, which a bad clean
1404
821
        # up routine in tearDown might trigger a fault in our test with only
1405
822
        # one child, we should instead see the bad result inside our test with
1407
824
        # the outer child test
1408
825
        original_trace = bzrlib.trace._trace_file
1409
826
        outer_test = TestTestCase("outer_child")
1410
 
        result = self.make_test_result()
 
827
        result = bzrlib.tests.TextTestResult(self._log_file,
 
828
                                        descriptions=0,
 
829
                                        verbosity=1)
1411
830
        outer_test.run(result)
1412
831
        self.assertEqual(original_trace, bzrlib.trace._trace_file)
1413
832
 
1423
842
        result = bzrlib.tests.VerboseTestResult(
1424
843
            unittest._WritelnDecorator(output_stream),
1425
844
            descriptions=0,
1426
 
            verbosity=2)
 
845
            verbosity=2,
 
846
            num_tests=sample_test.countTestCases())
1427
847
        sample_test.run(result)
1428
848
        self.assertContainsRe(
1429
849
            output_stream.getvalue(),
1430
 
            r"\d+ms\*\n$")
1431
 
 
1432
 
    def test_hooks_sanitised(self):
1433
 
        """The bzrlib hooks should be sanitised by setUp."""
1434
 
        # Note this test won't fail with hooks that the core library doesn't
1435
 
        # use - but it trigger with a plugin that adds hooks, so its still a
1436
 
        # useful warning in that case.
1437
 
        self.assertEqual(bzrlib.branch.BranchHooks(),
1438
 
            bzrlib.branch.Branch.hooks)
1439
 
        self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
1440
 
            bzrlib.smart.server.SmartTCPServer.hooks)
1441
 
        self.assertEqual(bzrlib.commands.CommandHooks(),
1442
 
            bzrlib.commands.Command.hooks)
1443
 
 
 
850
            r"\d+ms/ +\d+ms\n$")
 
851
        
1444
852
    def test__gather_lsprof_in_benchmarks(self):
1445
853
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1446
 
 
 
854
        
1447
855
        Each self.time() call is individually and separately profiled.
1448
856
        """
1449
 
        self.requireFeature(test_lsprof.LSProfFeature)
1450
 
        # overrides the class member with an instance member so no cleanup
 
857
        try:
 
858
            import bzrlib.lsprof
 
859
        except ImportError:
 
860
            raise TestSkipped("lsprof not installed.")
 
861
        # overrides the class member with an instance member so no cleanup 
1451
862
        # needed.
1452
863
        self._gather_lsprof_in_benchmarks = True
1453
864
        self.time(time.sleep, 0.000)
1457
868
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1458
869
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1459
870
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1460
 
        del self._benchcalls[:]
1461
 
 
1462
 
    def test_knownFailure(self):
1463
 
        """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)
1482
 
 
1483
 
    def test_requireFeature_available(self):
1484
 
        """self.requireFeature(available) is a no-op."""
1485
 
        class Available(tests.Feature):
1486
 
            def _probe(self):return True
1487
 
        feature = Available()
1488
 
        self.requireFeature(feature)
1489
 
 
1490
 
    def test_requireFeature_unavailable(self):
1491
 
        """self.requireFeature(unavailable) raises UnavailableFeature."""
1492
 
        class Unavailable(tests.Feature):
1493
 
            def _probe(self):return False
1494
 
        feature = Unavailable()
1495
 
        self.assertRaises(tests.UnavailableFeature,
1496
 
                          self.requireFeature, feature)
1497
 
 
1498
 
    def test_run_no_parameters(self):
1499
 
        test = SampleTestCase('_test_pass')
1500
 
        test.run()
1501
 
 
1502
 
    def test_run_enabled_unittest_result(self):
1503
 
        """Test we revert to regular behaviour when the test is enabled."""
1504
 
        test = SampleTestCase('_test_pass')
1505
 
        class EnabledFeature(object):
1506
 
            def available(self):
1507
 
                return True
1508
 
        test._test_needs_features = [EnabledFeature()]
1509
 
        result = unittest.TestResult()
1510
 
        test.run(result)
1511
 
        self.assertEqual(1, result.testsRun)
1512
 
        self.assertEqual([], result.errors)
1513
 
        self.assertEqual([], result.failures)
1514
 
 
1515
 
    def test_run_disabled_unittest_result(self):
1516
 
        """Test our compatability for disabled tests with unittest results."""
1517
 
        test = SampleTestCase('_test_pass')
1518
 
        class DisabledFeature(object):
1519
 
            def available(self):
1520
 
                return False
1521
 
        test._test_needs_features = [DisabledFeature()]
1522
 
        result = unittest.TestResult()
1523
 
        test.run(result)
1524
 
        self.assertEqual(1, result.testsRun)
1525
 
        self.assertEqual([], result.errors)
1526
 
        self.assertEqual([], result.failures)
1527
 
 
1528
 
    def test_run_disabled_supporting_result(self):
1529
 
        """Test disabled tests behaviour with support aware results."""
1530
 
        test = SampleTestCase('_test_pass')
1531
 
        class DisabledFeature(object):
1532
 
            def __eq__(self, other):
1533
 
                return isinstance(other, DisabledFeature)
1534
 
            def available(self):
1535
 
                return False
1536
 
        the_feature = DisabledFeature()
1537
 
        test._test_needs_features = [the_feature]
1538
 
        class InstrumentedTestResult(unittest.TestResult):
1539
 
            def __init__(self):
1540
 
                unittest.TestResult.__init__(self)
1541
 
                self.calls = []
1542
 
            def startTest(self, test):
1543
 
                self.calls.append(('startTest', test))
1544
 
            def stopTest(self, test):
1545
 
                self.calls.append(('stopTest', test))
1546
 
            def addNotSupported(self, test, feature):
1547
 
                self.calls.append(('addNotSupported', test, feature))
1548
 
        result = InstrumentedTestResult()
1549
 
        test.run(result)
1550
 
        case = result.calls[0][1]
1551
 
        self.assertEqual([
1552
 
            ('startTest', case),
1553
 
            ('addNotSupported', case, the_feature),
1554
 
            ('stopTest', case),
1555
 
            ],
1556
 
            result.calls)
1557
 
 
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)))
 
871
 
 
872
 
 
873
@symbol_versioning.deprecated_function(zero_eleven)
1660
874
def sample_deprecated_function():
1661
875
    """A deprecated function to test applyDeprecated with."""
1662
876
    return 2
1669
883
class ApplyDeprecatedHelper(object):
1670
884
    """A helper class for ApplyDeprecated tests."""
1671
885
 
1672
 
    @deprecated_method(deprecated_in((0, 11, 0)))
 
886
    @symbol_versioning.deprecated_method(zero_eleven)
1673
887
    def sample_deprecated_method(self, param_one):
1674
888
        """A deprecated method for testing with."""
1675
889
        return param_one
1677
891
    def sample_normal_method(self):
1678
892
        """A undeprecated method."""
1679
893
 
1680
 
    @deprecated_method(deprecated_in((0, 10, 0)))
 
894
    @symbol_versioning.deprecated_method(zero_ten)
1681
895
    def sample_nested_deprecation(self):
1682
896
        return sample_deprecated_function()
1683
897
 
1684
898
 
1685
 
class TestExtraAssertions(tests.TestCase):
 
899
class TestExtraAssertions(TestCase):
1686
900
    """Tests for new test assertions in bzrlib test suite"""
1687
901
 
1688
902
    def test_assert_isinstance(self):
1689
903
        self.assertIsInstance(2, int)
1690
904
        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'>")
 
905
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1694
906
        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
907
 
1701
908
    def test_assertEndsWith(self):
1702
909
        self.assertEndsWith('foo', 'oo')
1703
910
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1704
911
 
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
912
    def test_applyDeprecated_not_deprecated(self):
1721
913
        sample_object = ApplyDeprecatedHelper()
1722
914
        # calling an undeprecated callable raises an assertion
1723
 
        self.assertRaises(AssertionError, self.applyDeprecated,
1724
 
            deprecated_in((0, 11, 0)),
 
915
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
1725
916
            sample_object.sample_normal_method)
1726
 
        self.assertRaises(AssertionError, self.applyDeprecated,
1727
 
            deprecated_in((0, 11, 0)),
 
917
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
1728
918
            sample_undeprecated_function, "a param value")
1729
919
        # calling a deprecated callable (function or method) with the wrong
1730
920
        # expected deprecation fails.
1731
 
        self.assertRaises(AssertionError, self.applyDeprecated,
1732
 
            deprecated_in((0, 10, 0)),
 
921
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
1733
922
            sample_object.sample_deprecated_method, "a param value")
1734
 
        self.assertRaises(AssertionError, self.applyDeprecated,
1735
 
            deprecated_in((0, 10, 0)),
 
923
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
1736
924
            sample_deprecated_function)
1737
925
        # calling a deprecated callable (function or method) with the right
1738
926
        # expected deprecation returns the functions result.
1739
 
        self.assertEqual("a param value",
1740
 
            self.applyDeprecated(deprecated_in((0, 11, 0)),
 
927
        self.assertEqual("a param value", self.applyDeprecated(zero_eleven,
1741
928
            sample_object.sample_deprecated_method, "a param value"))
1742
 
        self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 11, 0)),
 
929
        self.assertEqual(2, self.applyDeprecated(zero_eleven,
1743
930
            sample_deprecated_function))
1744
931
        # calling a nested deprecation with the wrong deprecation version
1745
 
        # fails even if a deeper nested function was deprecated with the
 
932
        # fails even if a deeper nested function was deprecated with the 
1746
933
        # supplied version.
1747
934
        self.assertRaises(AssertionError, self.applyDeprecated,
1748
 
            deprecated_in((0, 11, 0)), sample_object.sample_nested_deprecation)
 
935
            zero_eleven, sample_object.sample_nested_deprecation)
1749
936
        # calling a nested deprecation with the right deprecation value
1750
937
        # returns the calls result.
1751
 
        self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 10, 0)),
 
938
        self.assertEqual(2, self.applyDeprecated(zero_ten,
1752
939
            sample_object.sample_nested_deprecation))
1753
940
 
1754
941
    def test_callDeprecated(self):
1755
942
        def testfunc(be_deprecated, result=None):
1756
943
            if be_deprecated is True:
1757
 
                symbol_versioning.warn('i am deprecated', DeprecationWarning,
 
944
                symbol_versioning.warn('i am deprecated', DeprecationWarning, 
1758
945
                                       stacklevel=1)
1759
946
            return result
1760
947
        result = self.callDeprecated(['i am deprecated'], testfunc, True)
1765
952
        self.callDeprecated([], testfunc, be_deprecated=False)
1766
953
 
1767
954
 
1768
 
class TestWarningTests(tests.TestCase):
1769
 
    """Tests for calling methods that raise warnings."""
1770
 
 
1771
 
    def test_callCatchWarnings(self):
1772
 
        def meth(a, b):
1773
 
            warnings.warn("this is your last warning")
1774
 
            return a + b
1775
 
        wlist, result = self.callCatchWarnings(meth, 1, 2)
1776
 
        self.assertEquals(3, result)
1777
 
        # would like just to compare them, but UserWarning doesn't implement
1778
 
        # eq well
1779
 
        w0, = wlist
1780
 
        self.assertIsInstance(w0, UserWarning)
1781
 
        self.assertEquals("this is your last warning", str(w0))
1782
 
 
1783
 
 
1784
 
class TestConvenienceMakers(tests.TestCaseWithTransport):
 
955
class TestConvenienceMakers(TestCaseWithTransport):
1785
956
    """Test for the make_* convenience functions."""
1786
957
 
1787
958
    def test_make_branch_and_tree_with_format(self):
1799
970
        tree = self.make_branch_and_memory_tree('a')
1800
971
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1801
972
 
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://'))
 
973
 
 
974
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
 
975
 
 
976
    def test_make_tree_for_sftp_branch(self):
 
977
        """Transports backed by local directories create local trees."""
 
978
 
1808
979
        tree = self.make_branch_and_tree('t1')
1809
980
        base = tree.bzrdir.root_transport.base
1810
 
        self.assertStartsWith(base, 'file://')
 
981
        self.failIf(base.startswith('sftp'),
 
982
                'base %r is on sftp but should be local' % base)
1811
983
        self.assertEquals(tree.bzrdir.root_transport,
1812
984
                tree.branch.bzrdir.root_transport)
1813
985
        self.assertEquals(tree.bzrdir.root_transport,
1814
986
                tree.branch.repository.bzrdir.root_transport)
1815
987
 
1816
988
 
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):
 
989
class TestSelftest(TestCase):
1835
990
    """Tests of bzrlib.tests.selftest."""
1836
991
 
1837
992
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1838
993
        factory_called = []
1839
994
        def factory():
1840
995
            factory_called.append(True)
1841
 
            return TestUtil.TestSuite()
 
996
            return TestSuite()
1842
997
        out = StringIO()
1843
998
        err = StringIO()
1844
 
        self.apply_redirected(out, err, None, bzrlib.tests.selftest,
 
999
        self.apply_redirected(out, err, None, bzrlib.tests.selftest, 
1845
1000
            test_suite_factory=factory)
1846
1001
        self.assertEqual([True], factory_called)
1847
 
 
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
2181
 
        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):
2361
 
 
2362
 
    def test_caching(self):
2363
 
        """Feature._probe is called by the feature at most once."""
2364
 
        class InstrumentedFeature(tests.Feature):
2365
 
            def __init__(self):
2366
 
                super(InstrumentedFeature, self).__init__()
2367
 
                self.calls = []
2368
 
            def _probe(self):
2369
 
                self.calls.append('_probe')
2370
 
                return False
2371
 
        feature = InstrumentedFeature()
2372
 
        feature.available()
2373
 
        self.assertEqual(['_probe'], feature.calls)
2374
 
        feature.available()
2375
 
        self.assertEqual(['_probe'], feature.calls)
2376
 
 
2377
 
    def test_named_str(self):
2378
 
        """Feature.__str__ should thunk to feature_name()."""
2379
 
        class NamedFeature(tests.Feature):
2380
 
            def feature_name(self):
2381
 
                return 'symlinks'
2382
 
        feature = NamedFeature()
2383
 
        self.assertEqual('symlinks', str(feature))
2384
 
 
2385
 
    def test_default_str(self):
2386
 
        """Feature.__str__ should default to __class__.__name__."""
2387
 
        class NamedFeature(tests.Feature):
2388
 
            pass
2389
 
        feature = NamedFeature()
2390
 
        self.assertEqual('NamedFeature', str(feature))
2391
 
 
2392
 
 
2393
 
class TestUnavailableFeature(tests.TestCase):
2394
 
 
2395
 
    def test_access_feature(self):
2396
 
        feature = tests.Feature()
2397
 
        exception = tests.UnavailableFeature(feature)
2398
 
        self.assertIs(feature, exception.args[0])
2399
 
 
2400
 
 
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):
2435
 
 
2436
 
    def setUp(self):
2437
 
        tests.TestCase.setUp(self)
2438
 
        self.suite = TestUtil.TestSuite()
2439
 
        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))
2510
 
 
2511
 
    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)
2515
 
        self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
2516
 
            '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):
2591
 
 
2592
 
    def test_check_inventory_shape(self):
2593
 
        files = ['a', 'b/', 'b/c']
2594
 
        tree = self.make_branch_and_tree('.')
2595
 
        self.build_tree(files)
2596
 
        tree.add(files)
2597
 
        tree.lock_read()
2598
 
        try:
2599
 
            self.check_inventory_shape(tree.inventory, files)
2600
 
        finally:
2601
 
            tree.unlock()
2602
 
 
2603
 
 
2604
 
class TestBlackboxSupport(tests.TestCase):
2605
 
    """Tests for testsuite blackbox features."""
2606
 
 
2607
 
    def test_run_bzr_failure_not_caught(self):
2608
 
        # When we run bzr in blackbox mode, we want any unexpected errors to
2609
 
        # propagate up to the test suite so that it can show the error in the
2610
 
        # usual way, and we won't get a double traceback.
2611
 
        e = self.assertRaises(
2612
 
            AssertionError,
2613
 
            self.run_bzr, ['assert-fail'])
2614
 
        # make sure we got the real thing, not an error from somewhere else in
2615
 
        # the test framework
2616
 
        self.assertEquals('always fails', str(e))
2617
 
        # check that there's no traceback in the test log
2618
 
        self.assertNotContainsRe(self.get_log(), r'Traceback')
2619
 
 
2620
 
    def test_run_bzr_user_error_caught(self):
2621
 
        # Running bzr in blackbox mode, normal/expected/user errors should be
2622
 
        # caught in the regular way and turned into an error message plus exit
2623
 
        # code.
2624
 
        transport_server = memory.MemoryServer()
2625
 
        transport_server.start_server()
2626
 
        self.addCleanup(transport_server.stop_server)
2627
 
        url = transport_server.get_url()
2628
 
        self.permit_url(url)
2629
 
        out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
2630
 
        self.assertEqual(out, '')
2631
 
        self.assertContainsRe(err,
2632
 
            'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
2633
 
 
2634
 
 
2635
 
class TestTestLoader(tests.TestCase):
2636
 
    """Tests for the test loader."""
2637
 
 
2638
 
    def _get_loader_and_module(self):
2639
 
        """Gets a TestLoader and a module with one test in it."""
2640
 
        loader = TestUtil.TestLoader()
2641
 
        module = {}
2642
 
        class Stub(tests.TestCase):
2643
 
            def test_foo(self):
2644
 
                pass
2645
 
        class MyModule(object):
2646
 
            pass
2647
 
        MyModule.a_class = Stub
2648
 
        module = MyModule()
2649
 
        return loader, module
2650
 
 
2651
 
    def test_module_no_load_tests_attribute_loads_classes(self):
2652
 
        loader, module = self._get_loader_and_module()
2653
 
        self.assertEqual(1, loader.loadTestsFromModule(module).countTestCases())
2654
 
 
2655
 
    def test_module_load_tests_attribute_gets_called(self):
2656
 
        loader, module = self._get_loader_and_module()
2657
 
        # 'self' is here because we're faking the module with a class. Regular
2658
 
        # load_tests do not need that :)
2659
 
        def load_tests(self, standard_tests, module, loader):
2660
 
            result = loader.suiteClass()
2661
 
            for test in tests.iter_suite_tests(standard_tests):
2662
 
                result.addTests([test, test])
2663
 
            return result
2664
 
        # add a load_tests() method which multiplies the tests from the module.
2665
 
        module.__class__.load_tests = load_tests
2666
 
        self.assertEqual(2, loader.loadTestsFromModule(module).countTestCases())
2667
 
 
2668
 
    def test_load_tests_from_module_name_smoke_test(self):
2669
 
        loader = TestUtil.TestLoader()
2670
 
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2671
 
        self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2672
 
                          _test_ids(suite))
2673
 
 
2674
 
    def test_load_tests_from_module_name_with_bogus_module_name(self):
2675
 
        loader = TestUtil.TestLoader()
2676
 
        self.assertRaises(ImportError, loader.loadTestsFromModuleName, 'bogus')
2677
 
 
2678
 
 
2679
 
class TestTestIdList(tests.TestCase):
2680
 
 
2681
 
    def _create_id_list(self, test_list):
2682
 
        return tests.TestIdList(test_list)
2683
 
 
2684
 
    def _create_suite(self, test_id_list):
2685
 
 
2686
 
        class Stub(tests.TestCase):
2687
 
            def test_foo(self):
2688
 
                pass
2689
 
 
2690
 
        def _create_test_id(id):
2691
 
            return lambda: id
2692
 
 
2693
 
        suite = TestUtil.TestSuite()
2694
 
        for id in test_id_list:
2695
 
            t  = Stub('test_foo')
2696
 
            t.id = _create_test_id(id)
2697
 
            suite.addTest(t)
2698
 
        return suite
2699
 
 
2700
 
    def _test_ids(self, test_suite):
2701
 
        """Get the ids for the tests in a test suite."""
2702
 
        return [t.id() for t in tests.iter_suite_tests(test_suite)]
2703
 
 
2704
 
    def test_empty_list(self):
2705
 
        id_list = self._create_id_list([])
2706
 
        self.assertEquals({}, id_list.tests)
2707
 
        self.assertEquals({}, id_list.modules)
2708
 
 
2709
 
    def test_valid_list(self):
2710
 
        id_list = self._create_id_list(
2711
 
            ['mod1.cl1.meth1', 'mod1.cl1.meth2',
2712
 
             'mod1.func1', 'mod1.cl2.meth2',
2713
 
             'mod1.submod1',
2714
 
             'mod1.submod2.cl1.meth1', 'mod1.submod2.cl2.meth2',
2715
 
             ])
2716
 
        self.assertTrue(id_list.refers_to('mod1'))
2717
 
        self.assertTrue(id_list.refers_to('mod1.submod1'))
2718
 
        self.assertTrue(id_list.refers_to('mod1.submod2'))
2719
 
        self.assertTrue(id_list.includes('mod1.cl1.meth1'))
2720
 
        self.assertTrue(id_list.includes('mod1.submod1'))
2721
 
        self.assertTrue(id_list.includes('mod1.func1'))
2722
 
 
2723
 
    def test_bad_chars_in_params(self):
2724
 
        id_list = self._create_id_list(['mod1.cl1.meth1(xx.yy)'])
2725
 
        self.assertTrue(id_list.refers_to('mod1'))
2726
 
        self.assertTrue(id_list.includes('mod1.cl1.meth1(xx.yy)'))
2727
 
 
2728
 
    def test_module_used(self):
2729
 
        id_list = self._create_id_list(['mod.class.meth'])
2730
 
        self.assertTrue(id_list.refers_to('mod'))
2731
 
        self.assertTrue(id_list.refers_to('mod.class'))
2732
 
        self.assertTrue(id_list.refers_to('mod.class.meth'))
2733
 
 
2734
 
    def test_test_suite_matches_id_list_with_unknown(self):
2735
 
        loader = TestUtil.TestLoader()
2736
 
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2737
 
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',
2738
 
                     'bogus']
2739
 
        not_found, duplicates = tests.suite_matches_id_list(suite, test_list)
2740
 
        self.assertEquals(['bogus'], not_found)
2741
 
        self.assertEquals([], duplicates)
2742
 
 
2743
 
    def test_suite_matches_id_list_with_duplicates(self):
2744
 
        loader = TestUtil.TestLoader()
2745
 
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2746
 
        dupes = loader.suiteClass()
2747
 
        for test in tests.iter_suite_tests(suite):
2748
 
            dupes.addTest(test)
2749
 
            dupes.addTest(test) # Add it again
2750
 
 
2751
 
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',]
2752
 
        not_found, duplicates = tests.suite_matches_id_list(
2753
 
            dupes, test_list)
2754
 
        self.assertEquals([], not_found)
2755
 
        self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2756
 
                          duplicates)
2757
 
 
2758
 
 
2759
 
class TestTestSuite(tests.TestCase):
2760
 
 
2761
 
    def test__test_suite_testmod_names(self):
2762
 
        # Test that a plausible list of test module names are returned
2763
 
        # by _test_suite_testmod_names.
2764
 
        test_list = tests._test_suite_testmod_names()
2765
 
        self.assertSubset([
2766
 
            'bzrlib.tests.blackbox',
2767
 
            'bzrlib.tests.per_transport',
2768
 
            'bzrlib.tests.test_selftest',
2769
 
            ],
2770
 
            test_list)
2771
 
 
2772
 
    def test__test_suite_modules_to_doctest(self):
2773
 
        # Test that a plausible list of modules to doctest is returned
2774
 
        # by _test_suite_modules_to_doctest.
2775
 
        test_list = tests._test_suite_modules_to_doctest()
2776
 
        if __doc__ is None:
2777
 
            # When docstrings are stripped, there are no modules to doctest
2778
 
            self.assertEqual([], test_list)
2779
 
            return
2780
 
        self.assertSubset([
2781
 
            'bzrlib.timestamp',
2782
 
            ],
2783
 
            test_list)
2784
 
 
2785
 
    def test_test_suite(self):
2786
 
        # test_suite() loads the entire test suite to operate. To avoid this
2787
 
        # overhead, and yet still be confident that things are happening,
2788
 
        # we temporarily replace two functions used by test_suite with 
2789
 
        # test doubles that supply a few sample tests to load, and check they
2790
 
        # are loaded.
2791
 
        calls = []
2792
 
        def testmod_names():
2793
 
            calls.append("testmod_names")
2794
 
            return [
2795
 
                'bzrlib.tests.blackbox.test_branch',
2796
 
                'bzrlib.tests.per_transport',
2797
 
                'bzrlib.tests.test_selftest',
2798
 
                ]
2799
 
        self.overrideAttr(tests, '_test_suite_testmod_names', testmod_names)
2800
 
        def doctests():
2801
 
            calls.append("modules_to_doctest")
2802
 
            if __doc__ is None:
2803
 
                return []
2804
 
            return ['bzrlib.timestamp']
2805
 
        self.overrideAttr(tests, '_test_suite_modules_to_doctest', doctests)
2806
 
        expected_test_list = [
2807
 
            # testmod_names
2808
 
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
2809
 
            ('bzrlib.tests.per_transport.TransportTests'
2810
 
             '.test_abspath(LocalTransport,LocalURLServer)'),
2811
 
            'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
2812
 
            # plugins can't be tested that way since selftest may be run with
2813
 
            # --no-plugins
2814
 
            ]
2815
 
        if __doc__ is not None:
2816
 
            expected_test_list.extend([
2817
 
                # modules_to_doctest
2818
 
                'bzrlib.timestamp.format_highres_date',
2819
 
                ])
2820
 
        suite = tests.test_suite()
2821
 
        self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
2822
 
            set(calls))
2823
 
        self.assertSubset(expected_test_list, _test_ids(suite))
2824
 
 
2825
 
    def test_test_suite_list_and_start(self):
2826
 
        # We cannot test this at the same time as the main load, because we want
2827
 
        # to know that starting_with == None works. So a second load is
2828
 
        # incurred - note that the starting_with parameter causes a partial load
2829
 
        # rather than a full load so this test should be pretty quick.
2830
 
        test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
2831
 
        suite = tests.test_suite(test_list,
2832
 
                                 ['bzrlib.tests.test_selftest.TestTestSuite'])
2833
 
        # test_test_suite_list_and_start is not included 
2834
 
        self.assertEquals(test_list, _test_ids(suite))
2835
 
 
2836
 
 
2837
 
class TestLoadTestIdList(tests.TestCaseInTempDir):
2838
 
 
2839
 
    def _create_test_list_file(self, file_name, content):
2840
 
        fl = open(file_name, 'wt')
2841
 
        fl.write(content)
2842
 
        fl.close()
2843
 
 
2844
 
    def test_load_unknown(self):
2845
 
        self.assertRaises(errors.NoSuchFile,
2846
 
                          tests.load_test_id_list, 'i_do_not_exist')
2847
 
 
2848
 
    def test_load_test_list(self):
2849
 
        test_list_fname = 'test.list'
2850
 
        self._create_test_list_file(test_list_fname,
2851
 
                                    'mod1.cl1.meth1\nmod2.cl2.meth2\n')
2852
 
        tlist = tests.load_test_id_list(test_list_fname)
2853
 
        self.assertEquals(2, len(tlist))
2854
 
        self.assertEquals('mod1.cl1.meth1', tlist[0])
2855
 
        self.assertEquals('mod2.cl2.meth2', tlist[1])
2856
 
 
2857
 
    def test_load_dirty_file(self):
2858
 
        test_list_fname = 'test.list'
2859
 
        self._create_test_list_file(test_list_fname,
2860
 
                                    '  mod1.cl1.meth1\n\nmod2.cl2.meth2  \n'
2861
 
                                    'bar baz\n')
2862
 
        tlist = tests.load_test_id_list(test_list_fname)
2863
 
        self.assertEquals(4, len(tlist))
2864
 
        self.assertEquals('mod1.cl1.meth1', tlist[0])
2865
 
        self.assertEquals('', tlist[1])
2866
 
        self.assertEquals('mod2.cl2.meth2', tlist[2])
2867
 
        self.assertEquals('bar baz', tlist[3])
2868
 
 
2869
 
 
2870
 
class TestFilteredByModuleTestLoader(tests.TestCase):
2871
 
 
2872
 
    def _create_loader(self, test_list):
2873
 
        id_filter = tests.TestIdList(test_list)
2874
 
        loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2875
 
        return loader
2876
 
 
2877
 
    def test_load_tests(self):
2878
 
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2879
 
        loader = self._create_loader(test_list)
2880
 
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2881
 
        self.assertEquals(test_list, _test_ids(suite))
2882
 
 
2883
 
    def test_exclude_tests(self):
2884
 
        test_list = ['bogus']
2885
 
        loader = self._create_loader(test_list)
2886
 
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2887
 
        self.assertEquals([], _test_ids(suite))
2888
 
 
2889
 
 
2890
 
class TestFilteredByNameStartTestLoader(tests.TestCase):
2891
 
 
2892
 
    def _create_loader(self, name_start):
2893
 
        def needs_module(name):
2894
 
            return name.startswith(name_start) or name_start.startswith(name)
2895
 
        loader = TestUtil.FilteredByModuleTestLoader(needs_module)
2896
 
        return loader
2897
 
 
2898
 
    def test_load_tests(self):
2899
 
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2900
 
        loader = self._create_loader('bzrlib.tests.test_samp')
2901
 
 
2902
 
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2903
 
        self.assertEquals(test_list, _test_ids(suite))
2904
 
 
2905
 
    def test_load_tests_inside_module(self):
2906
 
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2907
 
        loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
2908
 
 
2909
 
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2910
 
        self.assertEquals(test_list, _test_ids(suite))
2911
 
 
2912
 
    def test_exclude_tests(self):
2913
 
        test_list = ['bogus']
2914
 
        loader = self._create_loader('bogus')
2915
 
 
2916
 
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2917
 
        self.assertEquals([], _test_ids(suite))
2918
 
 
2919
 
 
2920
 
class TestTestPrefixRegistry(tests.TestCase):
2921
 
 
2922
 
    def _get_registry(self):
2923
 
        tp_registry = tests.TestPrefixAliasRegistry()
2924
 
        return tp_registry
2925
 
 
2926
 
    def test_register_new_prefix(self):
2927
 
        tpr = self._get_registry()
2928
 
        tpr.register('foo', 'fff.ooo.ooo')
2929
 
        self.assertEquals('fff.ooo.ooo', tpr.get('foo'))
2930
 
 
2931
 
    def test_register_existing_prefix(self):
2932
 
        tpr = self._get_registry()
2933
 
        tpr.register('bar', 'bbb.aaa.rrr')
2934
 
        tpr.register('bar', 'bBB.aAA.rRR')
2935
 
        self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
2936
 
        self.assertThat(self.get_log(),
2937
 
            DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR", ELLIPSIS))
2938
 
 
2939
 
    def test_get_unknown_prefix(self):
2940
 
        tpr = self._get_registry()
2941
 
        self.assertRaises(KeyError, tpr.get, 'I am not a prefix')
2942
 
 
2943
 
    def test_resolve_prefix(self):
2944
 
        tpr = self._get_registry()
2945
 
        tpr.register('bar', 'bb.aa.rr')
2946
 
        self.assertEquals('bb.aa.rr', tpr.resolve_alias('bar'))
2947
 
 
2948
 
    def test_resolve_unknown_alias(self):
2949
 
        tpr = self._get_registry()
2950
 
        self.assertRaises(errors.BzrCommandError,
2951
 
                          tpr.resolve_alias, 'I am not a prefix')
2952
 
 
2953
 
    def test_predefined_prefixes(self):
2954
 
        tpr = tests.test_prefix_alias_registry
2955
 
        self.assertEquals('bzrlib', tpr.resolve_alias('bzrlib'))
2956
 
        self.assertEquals('bzrlib.doc', tpr.resolve_alias('bd'))
2957
 
        self.assertEquals('bzrlib.utils', tpr.resolve_alias('bu'))
2958
 
        self.assertEquals('bzrlib.tests', tpr.resolve_alias('bt'))
2959
 
        self.assertEquals('bzrlib.tests.blackbox', tpr.resolve_alias('bb'))
2960
 
        self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
2961
 
 
2962
 
 
2963
 
class TestRunSuite(tests.TestCase):
2964
 
 
2965
 
    def test_runner_class(self):
2966
 
        """run_suite accepts and uses a runner_class keyword argument."""
2967
 
        class Stub(tests.TestCase):
2968
 
            def test_foo(self):
2969
 
                pass
2970
 
        suite = Stub("test_foo")
2971
 
        calls = []
2972
 
        class MyRunner(tests.TextTestRunner):
2973
 
            def run(self, test):
2974
 
                calls.append(test)
2975
 
                return tests.ExtendedTestResult(self.stream, self.descriptions,
2976
 
                                                self.verbosity)
2977
 
        tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
2978
 
        self.assertLength(1, calls)