~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Ian Clatworthy
  • Date: 2010-03-03 03:28:30 UTC
  • mto: (4797.31.1 integration-2.1)
  • mto: This revision was merged to the branch mainline in revision 5075.
  • Revision ID: ian.clatworthy@canonical.com-20100303032830-qf3ty4z40i410bem
add What's New to the list of PDF documents generated

Show diffs side-by-side

added added

removed removed

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