~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-05-29 15:57:16 UTC
  • mfrom: (3427.5.9 dep_warnings)
  • Revision ID: pqm@pqm.ubuntu.com-20080529155716-0w3kic8lioa63231
(jam) Enable Deprecation Warnings when running -Werror and when
        running selftest

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 by Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License version 2 as published by
5
 
# the Free Software Foundation.
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
6
7
#
7
8
# This program is distributed in the hope that it will be useful,
8
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13
14
# along with this program; if not, write to the Free Software
14
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
15
16
 
16
 
"""Tests for the test framework
17
 
"""
 
17
"""Tests for the test framework."""
18
18
 
 
19
import cStringIO
19
20
import os
 
21
from StringIO import StringIO
20
22
import sys
 
23
import time
21
24
import unittest
22
25
import warnings
23
26
 
24
27
import bzrlib
 
28
from bzrlib import (
 
29
    bzrdir,
 
30
    errors,
 
31
    memorytree,
 
32
    osutils,
 
33
    repository,
 
34
    symbol_versioning,
 
35
    tests,
 
36
    )
 
37
from bzrlib.progress import _BaseProgressBar
 
38
from bzrlib.repofmt import weaverepo
 
39
from bzrlib.symbol_versioning import (
 
40
    one_zero,
 
41
    zero_eleven,
 
42
    zero_ten,
 
43
    )
25
44
from bzrlib.tests import (
26
 
                          _load_module_by_name,
27
45
                          ChrootedTestCase,
 
46
                          ExtendedTestResult,
 
47
                          Feature,
 
48
                          KnownFailure,
28
49
                          TestCase,
29
50
                          TestCaseInTempDir,
 
51
                          TestCaseWithMemoryTransport,
30
52
                          TestCaseWithTransport,
 
53
                          TestNotApplicable,
31
54
                          TestSkipped,
 
55
                          TestSuite,
 
56
                          TestUtil,
32
57
                          TextTestRunner,
 
58
                          UnavailableFeature,
 
59
                          condition_id_re,
 
60
                          condition_isinstance,
 
61
                          exclude_tests_by_condition,
 
62
                          exclude_tests_by_re,
 
63
                          filter_suite_by_condition,
 
64
                          filter_suite_by_re,
 
65
                          iter_suite_tests,
 
66
                          preserve_input,
 
67
                          randomize_suite,
 
68
                          split_suite_by_condition,
 
69
                          split_suite_by_re,
 
70
                          test_lsprof,
 
71
                          test_suite,
33
72
                          )
34
 
import bzrlib.errors as errors
 
73
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
 
74
from bzrlib.tests.TestUtil import _load_module_by_name
 
75
from bzrlib.trace import note
 
76
from bzrlib.transport.memory import MemoryServer, MemoryTransport
 
77
from bzrlib.version import _get_bzr_source_tree
 
78
 
 
79
 
 
80
def _test_ids(test_suite):
 
81
    """Get the ids for the tests in a test suite."""
 
82
    return [t.id() for t in iter_suite_tests(test_suite)]
35
83
 
36
84
 
37
85
class SelftestTests(TestCase):
45
93
                          _load_module_by_name,
46
94
                          'bzrlib.no-name-yet')
47
95
 
48
 
 
49
96
class MetaTestLog(TestCase):
50
97
 
51
98
    def test_logging(self):
52
99
        """Test logs are captured when a test fails."""
53
100
        self.log('a test message')
54
101
        self._log_file.flush()
55
 
        self.assertContainsRe(self._get_log(), 'a test message\n')
 
102
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
103
                              'a test message\n')
56
104
 
57
105
 
58
106
class TestTreeShape(TestCaseInTempDir):
67
115
        self.failUnlessExists(filename)
68
116
 
69
117
 
70
 
class TestSkippedTest(TestCase):
71
 
    """Try running a test which is skipped, make sure it's reported properly."""
72
 
 
73
 
    def test_skipped_test(self):
74
 
        # must be hidden in here so it's not run as a real test
75
 
        def skipping_test():
76
 
            raise TestSkipped('test intentionally skipped')
77
 
        runner = TextTestRunner(stream=self._log_file)
78
 
        test = unittest.FunctionTestCase(skipping_test)
79
 
        result = runner.run(test)
80
 
        self.assertTrue(result.wasSuccessful())
81
 
 
82
 
 
83
118
class TestTransportProviderAdapter(TestCase):
84
119
    """A group of tests that test the transport implementation adaption core.
85
120
 
91
126
    """
92
127
 
93
128
    def test_get_transport_permutations(self):
94
 
        # this checks that we the module get_test_permutations call
95
 
        # is made by the adapter get_transport_test_permitations method.
 
129
        # this checks that get_test_permutations defined by the module is
 
130
        # called by the adapter get_transport_test_permutations method.
96
131
        class MockModule(object):
97
132
            def get_test_permutations(self):
98
133
                return sample_permutation
99
134
        sample_permutation = [(1,2), (3,4)]
100
 
        from bzrlib.transport import TransportTestProviderAdapter
 
135
        from bzrlib.tests.test_transport_implementations \
 
136
            import TransportTestProviderAdapter
101
137
        adapter = TransportTestProviderAdapter()
102
138
        self.assertEqual(sample_permutation,
103
139
                         adapter.get_transport_test_permutations(MockModule()))
104
140
 
105
141
    def test_adapter_checks_all_modules(self):
106
 
        # this checks that the adapter returns as many permurtations as
107
 
        # there are in all the registered# transport modules for there
108
 
        # - we assume if this matches its probably doing the right thing
109
 
        # especially in combination with the tests for setting the right
110
 
        # classes below.
111
 
        from bzrlib.transport import (TransportTestProviderAdapter,
112
 
                                      _get_transport_modules
113
 
                                      )
 
142
        # this checks that the adapter returns as many permutations as there
 
143
        # are in all the registered transport modules - we assume if this
 
144
        # matches its probably doing the right thing especially in combination
 
145
        # with the tests for setting the right classes below.
 
146
        from bzrlib.tests.test_transport_implementations \
 
147
            import TransportTestProviderAdapter
 
148
        from bzrlib.transport import _get_transport_modules
114
149
        modules = _get_transport_modules()
115
150
        permutation_count = 0
116
151
        for module in modules:
133
168
        # This test used to know about all the possible transports and the
134
169
        # order they were returned but that seems overly brittle (mbp
135
170
        # 20060307)
136
 
        input_test = TestTransportProviderAdapter(
137
 
            "test_adapter_sets_transport_class")
138
 
        from bzrlib.transport import TransportTestProviderAdapter
139
 
        suite = TransportTestProviderAdapter().adapt(input_test)
140
 
        tests = list(iter(suite))
141
 
        self.assertTrue(len(tests) > 6)
 
171
        from bzrlib.tests.test_transport_implementations \
 
172
            import TransportTestProviderAdapter
 
173
        scenarios = TransportTestProviderAdapter().scenarios
142
174
        # there are at least that many builtin transports
143
 
        one_test = tests[0]
144
 
        self.assertTrue(issubclass(one_test.transport_class, 
 
175
        self.assertTrue(len(scenarios) > 6)
 
176
        one_scenario = scenarios[0]
 
177
        self.assertIsInstance(one_scenario[0], str)
 
178
        self.assertTrue(issubclass(one_scenario[1]["transport_class"],
145
179
                                   bzrlib.transport.Transport))
146
 
        self.assertTrue(issubclass(one_test.transport_server, 
 
180
        self.assertTrue(issubclass(one_scenario[1]["transport_server"],
147
181
                                   bzrlib.transport.Server))
148
182
 
149
183
 
150
184
class TestBranchProviderAdapter(TestCase):
151
185
    """A group of tests that test the branch implementation test adapter."""
152
186
 
153
 
    def test_adapted_tests(self):
 
187
    def test_constructor(self):
154
188
        # check that constructor parameters are passed through to the adapted
155
189
        # test.
156
 
        from bzrlib.branch import BranchTestProviderAdapter
157
 
        input_test = TestBranchProviderAdapter(
158
 
            "test_adapted_tests")
 
190
        from bzrlib.tests.branch_implementations import BranchTestProviderAdapter
159
191
        server1 = "a"
160
192
        server2 = "b"
161
193
        formats = [("c", "C"), ("d", "D")]
162
194
        adapter = BranchTestProviderAdapter(server1, server2, formats)
163
 
        suite = adapter.adapt(input_test)
164
 
        tests = list(iter(suite))
165
 
        self.assertEqual(2, len(tests))
166
 
        self.assertEqual(tests[0].branch_format, formats[0][0])
167
 
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
168
 
        self.assertEqual(tests[0].transport_server, server1)
169
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
170
 
        self.assertEqual(tests[1].branch_format, formats[1][0])
171
 
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
172
 
        self.assertEqual(tests[1].transport_server, server1)
173
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
195
        self.assertEqual(2, len(adapter.scenarios))
 
196
        self.assertEqual([
 
197
            ('str',
 
198
             {'branch_format': 'c',
 
199
              'bzrdir_format': 'C',
 
200
              'transport_readonly_server': 'b',
 
201
              'transport_server': 'a'}),
 
202
            ('str',
 
203
             {'branch_format': 'd',
 
204
              'bzrdir_format': 'D',
 
205
              'transport_readonly_server': 'b',
 
206
              'transport_server': 'a'})],
 
207
            adapter.scenarios)
174
208
 
175
209
 
176
210
class TestBzrDirProviderAdapter(TestCase):
179
213
    def test_adapted_tests(self):
180
214
        # check that constructor parameters are passed through to the adapted
181
215
        # test.
182
 
        from bzrlib.bzrdir import BzrDirTestProviderAdapter
183
 
        input_test = TestBzrDirProviderAdapter(
184
 
            "test_adapted_tests")
 
216
        from bzrlib.tests.bzrdir_implementations import BzrDirTestProviderAdapter
 
217
        vfs_factory = "v"
185
218
        server1 = "a"
186
219
        server2 = "b"
187
220
        formats = ["c", "d"]
188
 
        adapter = BzrDirTestProviderAdapter(server1, server2, formats)
189
 
        suite = adapter.adapt(input_test)
190
 
        tests = list(iter(suite))
191
 
        self.assertEqual(2, len(tests))
192
 
        self.assertEqual(tests[0].bzrdir_format, formats[0])
193
 
        self.assertEqual(tests[0].transport_server, server1)
194
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
195
 
        self.assertEqual(tests[1].bzrdir_format, formats[1])
196
 
        self.assertEqual(tests[1].transport_server, server1)
197
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
221
        adapter = BzrDirTestProviderAdapter(vfs_factory,
 
222
            server1, server2, formats)
 
223
        self.assertEqual([
 
224
            ('str',
 
225
             {'bzrdir_format': 'c',
 
226
              'transport_readonly_server': 'b',
 
227
              'transport_server': 'a',
 
228
              'vfs_transport_factory': 'v'}),
 
229
            ('str',
 
230
             {'bzrdir_format': 'd',
 
231
              'transport_readonly_server': 'b',
 
232
              'transport_server': 'a',
 
233
              'vfs_transport_factory': 'v'})],
 
234
            adapter.scenarios)
198
235
 
199
236
 
200
237
class TestRepositoryProviderAdapter(TestCase):
201
238
    """A group of tests that test the repository implementation test adapter."""
202
239
 
203
 
    def test_adapted_tests(self):
204
 
        # check that constructor parameters are passed through to the adapted
205
 
        # test.
206
 
        from bzrlib.repository import RepositoryTestProviderAdapter
207
 
        input_test = TestRepositoryProviderAdapter(
208
 
            "test_adapted_tests")
 
240
    def test_constructor(self):
 
241
        # check that constructor parameters are passed through to the
 
242
        # scenarios.
 
243
        from bzrlib.tests.repository_implementations import RepositoryTestProviderAdapter
209
244
        server1 = "a"
210
245
        server2 = "b"
211
246
        formats = [("c", "C"), ("d", "D")]
212
247
        adapter = RepositoryTestProviderAdapter(server1, server2, formats)
213
 
        suite = adapter.adapt(input_test)
214
 
        tests = list(iter(suite))
215
 
        self.assertEqual(2, len(tests))
216
 
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
217
 
        self.assertEqual(tests[0].repository_format, formats[0][0])
218
 
        self.assertEqual(tests[0].transport_server, server1)
219
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
220
 
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
221
 
        self.assertEqual(tests[1].repository_format, formats[1][0])
222
 
        self.assertEqual(tests[1].transport_server, server1)
223
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
248
        self.assertEqual([
 
249
            ('str',
 
250
             {'bzrdir_format': 'C',
 
251
              'repository_format': 'c',
 
252
              'transport_readonly_server': 'b',
 
253
              'transport_server': 'a'}),
 
254
            ('str',
 
255
             {'bzrdir_format': 'D',
 
256
              'repository_format': 'd',
 
257
              'transport_readonly_server': 'b',
 
258
              'transport_server': 'a'})],
 
259
            adapter.scenarios)
 
260
 
 
261
    def test_setting_vfs_transport(self):
 
262
        """The vfs_transport_factory can be set optionally."""
 
263
        from bzrlib.tests.repository_implementations import RepositoryTestProviderAdapter
 
264
        formats = [("a", "b"), ("c", "d")]
 
265
        adapter = RepositoryTestProviderAdapter(None, None, formats,
 
266
            vfs_transport_factory="vfs")
 
267
        self.assertEqual([
 
268
            ('str',
 
269
             {'bzrdir_format': 'b',
 
270
              'repository_format': 'a',
 
271
              'transport_readonly_server': None,
 
272
              'transport_server': None,
 
273
              'vfs_transport_factory': 'vfs'}),
 
274
            ('str',
 
275
             {'bzrdir_format': 'd',
 
276
              'repository_format': 'c',
 
277
              'transport_readonly_server': None,
 
278
              'transport_server': None,
 
279
              'vfs_transport_factory': 'vfs'})],
 
280
            adapter.scenarios)
 
281
 
 
282
    def test_formats_to_scenarios(self):
 
283
        """The adapter can generate all the scenarios needed."""
 
284
        from bzrlib.tests.repository_implementations import RepositoryTestProviderAdapter
 
285
        no_vfs_adapter = RepositoryTestProviderAdapter("server", "readonly",
 
286
            [], None)
 
287
        vfs_adapter = RepositoryTestProviderAdapter("server", "readonly",
 
288
            [], vfs_transport_factory="vfs")
 
289
        # no_vfs generate scenarios without vfs_transport_factor
 
290
        formats = [("c", "C"), (1, "D")]
 
291
        self.assertEqual([
 
292
            ('str',
 
293
             {'bzrdir_format': 'C',
 
294
              'repository_format': 'c',
 
295
              'transport_readonly_server': 'readonly',
 
296
              'transport_server': 'server'}),
 
297
            ('int',
 
298
             {'bzrdir_format': 'D',
 
299
              'repository_format': 1,
 
300
              'transport_readonly_server': 'readonly',
 
301
              'transport_server': 'server'})],
 
302
            no_vfs_adapter.formats_to_scenarios(formats))
 
303
        self.assertEqual([
 
304
            ('str',
 
305
             {'bzrdir_format': 'C',
 
306
              'repository_format': 'c',
 
307
              'transport_readonly_server': 'readonly',
 
308
              'transport_server': 'server',
 
309
              'vfs_transport_factory': 'vfs'}),
 
310
            ('int',
 
311
             {'bzrdir_format': 'D',
 
312
              'repository_format': 1,
 
313
              'transport_readonly_server': 'readonly',
 
314
              'transport_server': 'server',
 
315
              'vfs_transport_factory': 'vfs'})],
 
316
            vfs_adapter.formats_to_scenarios(formats))
 
317
 
 
318
 
 
319
class TestTestScenarioApplier(TestCase):
 
320
    """Tests for the test adaption facilities."""
 
321
 
 
322
    def test_adapt_applies_scenarios(self):
 
323
        from bzrlib.tests.repository_implementations import TestScenarioApplier
 
324
        input_test = TestTestScenarioApplier("test_adapt_test_to_scenario")
 
325
        adapter = TestScenarioApplier()
 
326
        adapter.scenarios = [("1", "dict"), ("2", "settings")]
 
327
        calls = []
 
328
        def capture_call(test, scenario):
 
329
            calls.append((test, scenario))
 
330
            return test
 
331
        adapter.adapt_test_to_scenario = capture_call
 
332
        adapter.adapt(input_test)
 
333
        self.assertEqual([(input_test, ("1", "dict")),
 
334
            (input_test, ("2", "settings"))], calls)
 
335
 
 
336
    def test_adapt_test_to_scenario(self):
 
337
        from bzrlib.tests.repository_implementations import TestScenarioApplier
 
338
        input_test = TestTestScenarioApplier("test_adapt_test_to_scenario")
 
339
        adapter = TestScenarioApplier()
 
340
        # setup two adapted tests
 
341
        adapted_test1 = adapter.adapt_test_to_scenario(input_test,
 
342
            ("new id",
 
343
            {"bzrdir_format":"bzr_format",
 
344
             "repository_format":"repo_fmt",
 
345
             "transport_server":"transport_server",
 
346
             "transport_readonly_server":"readonly-server"}))
 
347
        adapted_test2 = adapter.adapt_test_to_scenario(input_test,
 
348
            ("new id 2", {"bzrdir_format":None}))
 
349
        # input_test should have been altered.
 
350
        self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
 
351
        # the new tests are mutually incompatible, ensuring it has 
 
352
        # made new ones, and unspecified elements in the scenario
 
353
        # should not have been altered.
 
354
        self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
 
355
        self.assertEqual("repo_fmt", adapted_test1.repository_format)
 
356
        self.assertEqual("transport_server", adapted_test1.transport_server)
 
357
        self.assertEqual("readonly-server",
 
358
            adapted_test1.transport_readonly_server)
 
359
        self.assertEqual(
 
360
            "bzrlib.tests.test_selftest.TestTestScenarioApplier."
 
361
            "test_adapt_test_to_scenario(new id)",
 
362
            adapted_test1.id())
 
363
        self.assertEqual(None, adapted_test2.bzrdir_format)
 
364
        self.assertEqual(
 
365
            "bzrlib.tests.test_selftest.TestTestScenarioApplier."
 
366
            "test_adapt_test_to_scenario(new id 2)",
 
367
            adapted_test2.id())
224
368
 
225
369
 
226
370
class TestInterRepositoryProviderAdapter(TestCase):
229
373
    def test_adapted_tests(self):
230
374
        # check that constructor parameters are passed through to the adapted
231
375
        # test.
232
 
        from bzrlib.repository import InterRepositoryTestProviderAdapter
233
 
        input_test = TestInterRepositoryProviderAdapter(
234
 
            "test_adapted_tests")
 
376
        from bzrlib.tests.interrepository_implementations import \
 
377
            InterRepositoryTestProviderAdapter
235
378
        server1 = "a"
236
379
        server2 = "b"
237
380
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
238
381
        adapter = InterRepositoryTestProviderAdapter(server1, server2, formats)
239
 
        suite = adapter.adapt(input_test)
240
 
        tests = list(iter(suite))
241
 
        self.assertEqual(2, len(tests))
242
 
        self.assertEqual(tests[0].interrepo_class, formats[0][0])
243
 
        self.assertEqual(tests[0].repository_format, formats[0][1])
244
 
        self.assertEqual(tests[0].repository_format_to, formats[0][2])
245
 
        self.assertEqual(tests[0].transport_server, server1)
246
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
247
 
        self.assertEqual(tests[1].interrepo_class, formats[1][0])
248
 
        self.assertEqual(tests[1].repository_format, formats[1][1])
249
 
        self.assertEqual(tests[1].repository_format_to, formats[1][2])
250
 
        self.assertEqual(tests[1].transport_server, server1)
251
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
382
        self.assertEqual([
 
383
            ('str,str,str',
 
384
             {'interrepo_class': str,
 
385
              'repository_format': 'C1',
 
386
              'repository_format_to': 'C2',
 
387
              'transport_readonly_server': 'b',
 
388
              'transport_server': 'a'}),
 
389
            ('int,str,str',
 
390
             {'interrepo_class': int,
 
391
              'repository_format': 'D1',
 
392
              'repository_format_to': 'D2',
 
393
              'transport_readonly_server': 'b',
 
394
              'transport_server': 'a'})],
 
395
            adapter.formats_to_scenarios(formats))
252
396
 
253
397
 
254
398
class TestInterVersionedFileProviderAdapter(TestCase):
255
399
    """A group of tests that test the InterVersionedFile test adapter."""
256
400
 
257
 
    def test_adapted_tests(self):
 
401
    def test_scenarios(self):
258
402
        # check that constructor parameters are passed through to the adapted
259
403
        # test.
260
 
        from bzrlib.versionedfile import InterVersionedFileTestProviderAdapter
261
 
        input_test = TestInterRepositoryProviderAdapter(
262
 
            "test_adapted_tests")
 
404
        from bzrlib.tests.interversionedfile_implementations \
 
405
            import InterVersionedFileTestProviderAdapter
263
406
        server1 = "a"
264
407
        server2 = "b"
265
408
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
266
409
        adapter = InterVersionedFileTestProviderAdapter(server1, server2, formats)
267
 
        suite = adapter.adapt(input_test)
268
 
        tests = list(iter(suite))
269
 
        self.assertEqual(2, len(tests))
270
 
        self.assertEqual(tests[0].interversionedfile_class, formats[0][0])
271
 
        self.assertEqual(tests[0].versionedfile_factory, formats[0][1])
272
 
        self.assertEqual(tests[0].versionedfile_factory_to, formats[0][2])
273
 
        self.assertEqual(tests[0].transport_server, server1)
274
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
275
 
        self.assertEqual(tests[1].interversionedfile_class, formats[1][0])
276
 
        self.assertEqual(tests[1].versionedfile_factory, formats[1][1])
277
 
        self.assertEqual(tests[1].versionedfile_factory_to, formats[1][2])
278
 
        self.assertEqual(tests[1].transport_server, server1)
279
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
410
        self.assertEqual([
 
411
            ('str',
 
412
             {'interversionedfile_class':str,
 
413
              'transport_readonly_server': 'b',
 
414
              'transport_server': 'a',
 
415
              'versionedfile_factory': 'C1',
 
416
              'versionedfile_factory_to': 'C2'}),
 
417
            ('int',
 
418
             {'interversionedfile_class': int,
 
419
              'transport_readonly_server': 'b',
 
420
              'transport_server': 'a',
 
421
              'versionedfile_factory': 'D1',
 
422
              'versionedfile_factory_to': 'D2'})],
 
423
            adapter.scenarios)
280
424
 
281
425
 
282
426
class TestRevisionStoreProviderAdapter(TestCase):
283
427
    """A group of tests that test the RevisionStore test adapter."""
284
428
 
285
 
    def test_adapted_tests(self):
 
429
    def test_scenarios(self):
286
430
        # check that constructor parameters are passed through to the adapted
287
431
        # test.
288
 
        from bzrlib.store.revision import RevisionStoreTestProviderAdapter
289
 
        input_test = TestRevisionStoreProviderAdapter(
290
 
            "test_adapted_tests")
 
432
        from bzrlib.tests.revisionstore_implementations \
 
433
            import RevisionStoreTestProviderAdapter
291
434
        # revision stores need a store factory - i.e. RevisionKnit
292
435
        #, a readonly and rw transport 
293
436
        # transport servers:
295
438
        server2 = "b"
296
439
        store_factories = ["c", "d"]
297
440
        adapter = RevisionStoreTestProviderAdapter(server1, server2, store_factories)
298
 
        suite = adapter.adapt(input_test)
299
 
        tests = list(iter(suite))
300
 
        self.assertEqual(2, len(tests))
301
 
        self.assertEqual(tests[0].store_factory, store_factories[0][0])
302
 
        self.assertEqual(tests[0].transport_server, server1)
303
 
        self.assertEqual(tests[0].transport_readonly_server, server2)
304
 
        self.assertEqual(tests[1].store_factory, store_factories[1][0])
305
 
        self.assertEqual(tests[1].transport_server, server1)
306
 
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
441
        self.assertEqual([
 
442
            ('c',
 
443
             {'store_factory': 'c',
 
444
              'transport_readonly_server': 'b',
 
445
              'transport_server': 'a'}),
 
446
            ('d',
 
447
             {'store_factory': 'd',
 
448
              'transport_readonly_server': 'b',
 
449
              'transport_server': 'a'})],
 
450
            adapter.scenarios)
307
451
 
308
452
 
309
453
class TestWorkingTreeProviderAdapter(TestCase):
310
454
    """A group of tests that test the workingtree implementation test adapter."""
311
455
 
312
 
    def test_adapted_tests(self):
 
456
    def test_scenarios(self):
313
457
        # check that constructor parameters are passed through to the adapted
314
458
        # test.
315
 
        from bzrlib.workingtree import WorkingTreeTestProviderAdapter
316
 
        input_test = TestWorkingTreeProviderAdapter(
317
 
            "test_adapted_tests")
 
459
        from bzrlib.tests.workingtree_implementations \
 
460
            import WorkingTreeTestProviderAdapter
318
461
        server1 = "a"
319
462
        server2 = "b"
320
463
        formats = [("c", "C"), ("d", "D")]
321
464
        adapter = WorkingTreeTestProviderAdapter(server1, server2, formats)
 
465
        self.assertEqual([
 
466
            ('str',
 
467
             {'bzrdir_format': 'C',
 
468
              'transport_readonly_server': 'b',
 
469
              'transport_server': 'a',
 
470
              'workingtree_format': 'c'}),
 
471
            ('str',
 
472
             {'bzrdir_format': 'D',
 
473
              'transport_readonly_server': 'b',
 
474
              'transport_server': 'a',
 
475
              'workingtree_format': 'd'})],
 
476
            adapter.scenarios)
 
477
 
 
478
 
 
479
class TestTreeProviderAdapter(TestCase):
 
480
    """Test the setup of tree_implementation tests."""
 
481
 
 
482
    def test_adapted_tests(self):
 
483
        # the tree implementation adapter is meant to setup one instance for
 
484
        # each working tree format, and one additional instance that will
 
485
        # use the default wt format, but create a revision tree for the tests.
 
486
        # this means that the wt ones should have the workingtree_to_test_tree
 
487
        # attribute set to 'return_parameter' and the revision one set to
 
488
        # revision_tree_from_workingtree.
 
489
 
 
490
        from bzrlib.tests.tree_implementations import (
 
491
            TreeTestProviderAdapter,
 
492
            return_parameter,
 
493
            revision_tree_from_workingtree
 
494
            )
 
495
        from bzrlib.workingtree import WorkingTreeFormat, WorkingTreeFormat3
 
496
        input_test = TestTreeProviderAdapter(
 
497
            "test_adapted_tests")
 
498
        server1 = "a"
 
499
        server2 = "b"
 
500
        formats = [("c", "C"), ("d", "D")]
 
501
        adapter = TreeTestProviderAdapter(server1, server2, formats)
322
502
        suite = adapter.adapt(input_test)
323
503
        tests = list(iter(suite))
324
 
        self.assertEqual(2, len(tests))
 
504
        # XXX We should not have tests fail as we add more scenarios
 
505
        # abentley 20080412
 
506
        self.assertEqual(5, len(tests))
 
507
        # this must match the default format setp up in
 
508
        # TreeTestProviderAdapter.adapt
 
509
        default_format = WorkingTreeFormat3
325
510
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
326
511
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
327
512
        self.assertEqual(tests[0].transport_server, server1)
328
513
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
514
        self.assertEqual(tests[0]._workingtree_to_test_tree, return_parameter)
329
515
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
330
516
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
331
517
        self.assertEqual(tests[1].transport_server, server1)
332
518
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
519
        self.assertEqual(tests[1]._workingtree_to_test_tree, return_parameter)
 
520
        self.assertIsInstance(tests[2].workingtree_format, default_format)
 
521
        #self.assertEqual(tests[2].bzrdir_format,
 
522
        #                 default_format._matchingbzrdir)
 
523
        self.assertEqual(tests[2].transport_server, server1)
 
524
        self.assertEqual(tests[2].transport_readonly_server, server2)
 
525
        self.assertEqual(tests[2]._workingtree_to_test_tree,
 
526
            revision_tree_from_workingtree)
 
527
 
 
528
 
 
529
class TestInterTreeProviderAdapter(TestCase):
 
530
    """A group of tests that test the InterTreeTestAdapter."""
 
531
 
 
532
    def test_adapted_tests(self):
 
533
        # check that constructor parameters are passed through to the adapted
 
534
        # test.
 
535
        # for InterTree tests we want the machinery to bring up two trees in
 
536
        # each instance: the base one, and the one we are interacting with.
 
537
        # because each optimiser can be direction specific, we need to test
 
538
        # each optimiser in its chosen direction.
 
539
        # unlike the TestProviderAdapter we dont want to automatically add a
 
540
        # parameterized one for WorkingTree - the optimisers will tell us what
 
541
        # ones to add.
 
542
        from bzrlib.tests.tree_implementations import (
 
543
            return_parameter,
 
544
            revision_tree_from_workingtree
 
545
            )
 
546
        from bzrlib.tests.intertree_implementations import (
 
547
            InterTreeTestProviderAdapter,
 
548
            )
 
549
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
 
550
        input_test = TestInterTreeProviderAdapter(
 
551
            "test_adapted_tests")
 
552
        server1 = "a"
 
553
        server2 = "b"
 
554
        format1 = WorkingTreeFormat2()
 
555
        format2 = WorkingTreeFormat3()
 
556
        formats = [(str, format1, format2, "converter1"),
 
557
            (int, format2, format1, "converter2")]
 
558
        adapter = InterTreeTestProviderAdapter(server1, server2, formats)
 
559
        suite = adapter.adapt(input_test)
 
560
        tests = list(iter(suite))
 
561
        self.assertEqual(2, len(tests))
 
562
        self.assertEqual(tests[0].intertree_class, formats[0][0])
 
563
        self.assertEqual(tests[0].workingtree_format, formats[0][1])
 
564
        self.assertEqual(tests[0].workingtree_format_to, formats[0][2])
 
565
        self.assertEqual(tests[0].mutable_trees_to_test_trees, formats[0][3])
 
566
        self.assertEqual(tests[0]._workingtree_to_test_tree, return_parameter)
 
567
        self.assertEqual(tests[0].transport_server, server1)
 
568
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
569
        self.assertEqual(tests[1].intertree_class, formats[1][0])
 
570
        self.assertEqual(tests[1].workingtree_format, formats[1][1])
 
571
        self.assertEqual(tests[1].workingtree_format_to, formats[1][2])
 
572
        self.assertEqual(tests[1].mutable_trees_to_test_trees, formats[1][3])
 
573
        self.assertEqual(tests[1]._workingtree_to_test_tree, return_parameter)
 
574
        self.assertEqual(tests[1].transport_server, server1)
 
575
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
576
 
 
577
 
 
578
class TestTestCaseInTempDir(TestCaseInTempDir):
 
579
 
 
580
    def test_home_is_not_working(self):
 
581
        self.assertNotEqual(self.test_dir, self.test_home_dir)
 
582
        cwd = osutils.getcwd()
 
583
        self.assertIsSameRealPath(self.test_dir, cwd)
 
584
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
 
585
 
 
586
 
 
587
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
 
588
 
 
589
    def test_home_is_non_existant_dir_under_root(self):
 
590
        """The test_home_dir for TestCaseWithMemoryTransport is missing.
 
591
 
 
592
        This is because TestCaseWithMemoryTransport is for tests that do not
 
593
        need any disk resources: they should be hooked into bzrlib in such a 
 
594
        way that no global settings are being changed by the test (only a 
 
595
        few tests should need to do that), and having a missing dir as home is
 
596
        an effective way to ensure that this is the case.
 
597
        """
 
598
        self.assertIsSameRealPath(
 
599
            self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
 
600
            self.test_home_dir)
 
601
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
 
602
        
 
603
    def test_cwd_is_TEST_ROOT(self):
 
604
        self.assertIsSameRealPath(self.test_dir, self.TEST_ROOT)
 
605
        cwd = osutils.getcwd()
 
606
        self.assertIsSameRealPath(self.test_dir, cwd)
 
607
 
 
608
    def test_make_branch_and_memory_tree(self):
 
609
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
 
610
 
 
611
        This is hard to comprehensively robustly test, so we settle for making
 
612
        a branch and checking no directory was created at its relpath.
 
613
        """
 
614
        tree = self.make_branch_and_memory_tree('dir')
 
615
        # Guard against regression into MemoryTransport leaking
 
616
        # files to disk instead of keeping them in memory.
 
617
        self.failIf(osutils.lexists('dir'))
 
618
        self.assertIsInstance(tree, memorytree.MemoryTree)
 
619
 
 
620
    def test_make_branch_and_memory_tree_with_format(self):
 
621
        """make_branch_and_memory_tree should accept a format option."""
 
622
        format = bzrdir.BzrDirMetaFormat1()
 
623
        format.repository_format = weaverepo.RepositoryFormat7()
 
624
        tree = self.make_branch_and_memory_tree('dir', format=format)
 
625
        # Guard against regression into MemoryTransport leaking
 
626
        # files to disk instead of keeping them in memory.
 
627
        self.failIf(osutils.lexists('dir'))
 
628
        self.assertIsInstance(tree, memorytree.MemoryTree)
 
629
        self.assertEqual(format.repository_format.__class__,
 
630
            tree.branch.repository._format.__class__)
 
631
 
 
632
    def test_safety_net(self):
 
633
        """No test should modify the safety .bzr directory.
 
634
 
 
635
        We just test that the _check_safety_net private method raises
 
636
        AssertionError, it's easier than building a test suite with the same
 
637
        test.
 
638
        """
 
639
        # Oops, a commit in the current directory (i.e. without local .bzr
 
640
        # directory) will crawl up the hierarchy to find a .bzr directory.
 
641
        self.run_bzr(['commit', '-mfoo', '--unchanged'])
 
642
        # But we have a safety net in place.
 
643
        self.assertRaises(AssertionError, self._check_safety_net)
333
644
 
334
645
 
335
646
class TestTestCaseWithTransport(TestCaseWithTransport):
339
650
        from bzrlib.transport import get_transport
340
651
        from bzrlib.transport.memory import MemoryServer
341
652
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
342
 
        self.transport_server = MemoryServer
 
653
        self.vfs_transport_factory = MemoryServer
343
654
        self.transport_readonly_server = None
344
655
        # calling get_readonly_transport() constructs a decorator on the url
345
656
        # for the server
352
663
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
353
664
 
354
665
    def test_get_readonly_url_http(self):
 
666
        from bzrlib.tests.http_server import HttpServer
355
667
        from bzrlib.transport import get_transport
356
 
        from bzrlib.transport.local import LocalRelpathServer
357
 
        from bzrlib.transport.http import HttpServer, HttpTransportBase
358
 
        self.transport_server = LocalRelpathServer
 
668
        from bzrlib.transport.local import LocalURLServer
 
669
        from bzrlib.transport.http import HttpTransportBase
 
670
        self.transport_server = LocalURLServer
359
671
        self.transport_readonly_server = HttpServer
360
672
        # calling get_readonly_transport() gives us a HTTP server instance.
361
673
        url = self.get_readonly_url()
375
687
        self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
376
688
        self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
377
689
 
 
690
 
 
691
class TestTestCaseTransports(TestCaseWithTransport):
 
692
 
 
693
    def setUp(self):
 
694
        super(TestTestCaseTransports, self).setUp()
 
695
        self.vfs_transport_factory = MemoryServer
 
696
 
 
697
    def test_make_bzrdir_preserves_transport(self):
 
698
        t = self.get_transport()
 
699
        result_bzrdir = self.make_bzrdir('subdir')
 
700
        self.assertIsInstance(result_bzrdir.transport, 
 
701
                              MemoryTransport)
 
702
        # should not be on disk, should only be in memory
 
703
        self.failIfExists('subdir')
 
704
 
 
705
 
378
706
class TestChrootedTest(ChrootedTestCase):
379
707
 
380
708
    def test_root_is_root(self):
384
712
        self.assertEqual(url, t.clone('..').base)
385
713
 
386
714
 
 
715
class MockProgress(_BaseProgressBar):
 
716
    """Progress-bar standin that records calls.
 
717
 
 
718
    Useful for testing pb using code.
 
719
    """
 
720
 
 
721
    def __init__(self):
 
722
        _BaseProgressBar.__init__(self)
 
723
        self.calls = []
 
724
 
 
725
    def tick(self):
 
726
        self.calls.append(('tick',))
 
727
 
 
728
    def update(self, msg=None, current=None, total=None):
 
729
        self.calls.append(('update', msg, current, total))
 
730
 
 
731
    def clear(self):
 
732
        self.calls.append(('clear',))
 
733
 
 
734
    def note(self, msg, *args):
 
735
        self.calls.append(('note', msg, args))
 
736
 
 
737
 
 
738
class TestTestResult(TestCase):
 
739
 
 
740
    def check_timing(self, test_case, expected_re):
 
741
        result = bzrlib.tests.TextTestResult(self._log_file,
 
742
                descriptions=0,
 
743
                verbosity=1,
 
744
                )
 
745
        test_case.run(result)
 
746
        timed_string = result._testTimeString(test_case)
 
747
        self.assertContainsRe(timed_string, expected_re)
 
748
 
 
749
    def test_test_reporting(self):
 
750
        class ShortDelayTestCase(TestCase):
 
751
            def test_short_delay(self):
 
752
                time.sleep(0.003)
 
753
            def test_short_benchmark(self):
 
754
                self.time(time.sleep, 0.003)
 
755
        self.check_timing(ShortDelayTestCase('test_short_delay'),
 
756
                          r"^ +[0-9]+ms$")
 
757
        # if a benchmark time is given, we want a x of y style result.
 
758
        self.check_timing(ShortDelayTestCase('test_short_benchmark'),
 
759
                          r"^ +[0-9]+ms/ +[0-9]+ms$")
 
760
 
 
761
    def test_unittest_reporting_unittest_class(self):
 
762
        # getting the time from a non-bzrlib test works ok
 
763
        class ShortDelayTestCase(unittest.TestCase):
 
764
            def test_short_delay(self):
 
765
                time.sleep(0.003)
 
766
        self.check_timing(ShortDelayTestCase('test_short_delay'),
 
767
                          r"^ +[0-9]+ms$")
 
768
        
 
769
    def test_assigned_benchmark_file_stores_date(self):
 
770
        output = StringIO()
 
771
        result = bzrlib.tests.TextTestResult(self._log_file,
 
772
                                        descriptions=0,
 
773
                                        verbosity=1,
 
774
                                        bench_history=output
 
775
                                        )
 
776
        output_string = output.getvalue()
 
777
        # if you are wondering about the regexp please read the comment in
 
778
        # test_bench_history (bzrlib.tests.test_selftest.TestRunner)
 
779
        # XXX: what comment?  -- Andrew Bennetts
 
780
        self.assertContainsRe(output_string, "--date [0-9.]+")
 
781
 
 
782
    def test_benchhistory_records_test_times(self):
 
783
        result_stream = StringIO()
 
784
        result = bzrlib.tests.TextTestResult(
 
785
            self._log_file,
 
786
            descriptions=0,
 
787
            verbosity=1,
 
788
            bench_history=result_stream
 
789
            )
 
790
 
 
791
        # we want profile a call and check that its test duration is recorded
 
792
        # make a new test instance that when run will generate a benchmark
 
793
        example_test_case = TestTestResult("_time_hello_world_encoding")
 
794
        # execute the test, which should succeed and record times
 
795
        example_test_case.run(result)
 
796
        lines = result_stream.getvalue().splitlines()
 
797
        self.assertEqual(2, len(lines))
 
798
        self.assertContainsRe(lines[1],
 
799
            " *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
 
800
            "._time_hello_world_encoding")
 
801
 
 
802
    def _time_hello_world_encoding(self):
 
803
        """Profile two sleep calls
 
804
        
 
805
        This is used to exercise the test framework.
 
806
        """
 
807
        self.time(unicode, 'hello', errors='replace')
 
808
        self.time(unicode, 'world', errors='replace')
 
809
 
 
810
    def test_lsprofiling(self):
 
811
        """Verbose test result prints lsprof statistics from test cases."""
 
812
        self.requireFeature(test_lsprof.LSProfFeature)
 
813
        result_stream = StringIO()
 
814
        result = bzrlib.tests.VerboseTestResult(
 
815
            unittest._WritelnDecorator(result_stream),
 
816
            descriptions=0,
 
817
            verbosity=2,
 
818
            )
 
819
        # we want profile a call of some sort and check it is output by
 
820
        # addSuccess. We dont care about addError or addFailure as they
 
821
        # are not that interesting for performance tuning.
 
822
        # make a new test instance that when run will generate a profile
 
823
        example_test_case = TestTestResult("_time_hello_world_encoding")
 
824
        example_test_case._gather_lsprof_in_benchmarks = True
 
825
        # execute the test, which should succeed and record profiles
 
826
        example_test_case.run(result)
 
827
        # lsprofile_something()
 
828
        # if this worked we want 
 
829
        # LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
 
830
        #    CallCount    Recursive    Total(ms)   Inline(ms) module:lineno(function)
 
831
        # (the lsprof header)
 
832
        # ... an arbitrary number of lines
 
833
        # and the function call which is time.sleep.
 
834
        #           1        0            ???         ???       ???(sleep) 
 
835
        # and then repeated but with 'world', rather than 'hello'.
 
836
        # this should appear in the output stream of our test result.
 
837
        output = result_stream.getvalue()
 
838
        self.assertContainsRe(output,
 
839
            r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
 
840
        self.assertContainsRe(output,
 
841
            r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
 
842
        self.assertContainsRe(output,
 
843
            r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
 
844
        self.assertContainsRe(output,
 
845
            r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
 
846
 
 
847
    def test_known_failure(self):
 
848
        """A KnownFailure being raised should trigger several result actions."""
 
849
        class InstrumentedTestResult(ExtendedTestResult):
 
850
 
 
851
            def report_test_start(self, test): pass
 
852
            def report_known_failure(self, test, err):
 
853
                self._call = test, err
 
854
        result = InstrumentedTestResult(None, None, None, None)
 
855
        def test_function():
 
856
            raise KnownFailure('failed!')
 
857
        test = unittest.FunctionTestCase(test_function)
 
858
        test.run(result)
 
859
        # it should invoke 'report_known_failure'.
 
860
        self.assertEqual(2, len(result._call))
 
861
        self.assertEqual(test, result._call[0])
 
862
        self.assertEqual(KnownFailure, result._call[1][0])
 
863
        self.assertIsInstance(result._call[1][1], KnownFailure)
 
864
        # we dont introspec the traceback, if the rest is ok, it would be
 
865
        # exceptional for it not to be.
 
866
        # it should update the known_failure_count on the object.
 
867
        self.assertEqual(1, result.known_failure_count)
 
868
        # the result should be successful.
 
869
        self.assertTrue(result.wasSuccessful())
 
870
 
 
871
    def test_verbose_report_known_failure(self):
 
872
        # verbose test output formatting
 
873
        result_stream = StringIO()
 
874
        result = bzrlib.tests.VerboseTestResult(
 
875
            unittest._WritelnDecorator(result_stream),
 
876
            descriptions=0,
 
877
            verbosity=2,
 
878
            )
 
879
        test = self.get_passing_test()
 
880
        result.startTest(test)
 
881
        prefix = len(result_stream.getvalue())
 
882
        # the err parameter has the shape:
 
883
        # (class, exception object, traceback)
 
884
        # KnownFailures dont get their tracebacks shown though, so we
 
885
        # can skip that.
 
886
        err = (KnownFailure, KnownFailure('foo'), None)
 
887
        result.report_known_failure(test, err)
 
888
        output = result_stream.getvalue()[prefix:]
 
889
        lines = output.splitlines()
 
890
        self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
 
891
        self.assertEqual(lines[1], '    foo')
 
892
        self.assertEqual(2, len(lines))
 
893
 
 
894
    def test_text_report_known_failure(self):
 
895
        # text test output formatting
 
896
        pb = MockProgress()
 
897
        result = bzrlib.tests.TextTestResult(
 
898
            None,
 
899
            descriptions=0,
 
900
            verbosity=1,
 
901
            pb=pb,
 
902
            )
 
903
        test = self.get_passing_test()
 
904
        # this seeds the state to handle reporting the test.
 
905
        result.startTest(test)
 
906
        # the err parameter has the shape:
 
907
        # (class, exception object, traceback)
 
908
        # KnownFailures dont get their tracebacks shown though, so we
 
909
        # can skip that.
 
910
        err = (KnownFailure, KnownFailure('foo'), None)
 
911
        result.report_known_failure(test, err)
 
912
        self.assertEqual(
 
913
            [
 
914
            ('update', '[1 in 0s] passing_test', None, None),
 
915
            ('note', 'XFAIL: %s\n%s\n', ('passing_test', err[1]))
 
916
            ],
 
917
            pb.calls)
 
918
        # known_failures should be printed in the summary, so if we run a test
 
919
        # after there are some known failures, the update prefix should match
 
920
        # this.
 
921
        result.known_failure_count = 3
 
922
        test.run(result)
 
923
        self.assertEqual(
 
924
            [
 
925
            ('update', '[2 in 0s] passing_test', None, None),
 
926
            ],
 
927
            pb.calls[2:])
 
928
 
 
929
    def get_passing_test(self):
 
930
        """Return a test object that can't be run usefully."""
 
931
        def passing_test():
 
932
            pass
 
933
        return unittest.FunctionTestCase(passing_test)
 
934
 
 
935
    def test_add_not_supported(self):
 
936
        """Test the behaviour of invoking addNotSupported."""
 
937
        class InstrumentedTestResult(ExtendedTestResult):
 
938
            def report_test_start(self, test): pass
 
939
            def report_unsupported(self, test, feature):
 
940
                self._call = test, feature
 
941
        result = InstrumentedTestResult(None, None, None, None)
 
942
        test = SampleTestCase('_test_pass')
 
943
        feature = Feature()
 
944
        result.startTest(test)
 
945
        result.addNotSupported(test, feature)
 
946
        # it should invoke 'report_unsupported'.
 
947
        self.assertEqual(2, len(result._call))
 
948
        self.assertEqual(test, result._call[0])
 
949
        self.assertEqual(feature, result._call[1])
 
950
        # the result should be successful.
 
951
        self.assertTrue(result.wasSuccessful())
 
952
        # it should record the test against a count of tests not run due to
 
953
        # this feature.
 
954
        self.assertEqual(1, result.unsupported['Feature'])
 
955
        # and invoking it again should increment that counter
 
956
        result.addNotSupported(test, feature)
 
957
        self.assertEqual(2, result.unsupported['Feature'])
 
958
 
 
959
    def test_verbose_report_unsupported(self):
 
960
        # verbose test output formatting
 
961
        result_stream = StringIO()
 
962
        result = bzrlib.tests.VerboseTestResult(
 
963
            unittest._WritelnDecorator(result_stream),
 
964
            descriptions=0,
 
965
            verbosity=2,
 
966
            )
 
967
        test = self.get_passing_test()
 
968
        feature = Feature()
 
969
        result.startTest(test)
 
970
        prefix = len(result_stream.getvalue())
 
971
        result.report_unsupported(test, feature)
 
972
        output = result_stream.getvalue()[prefix:]
 
973
        lines = output.splitlines()
 
974
        self.assertEqual(lines, ['NODEP                   0ms', "    The feature 'Feature' is not available."])
 
975
    
 
976
    def test_text_report_unsupported(self):
 
977
        # text test output formatting
 
978
        pb = MockProgress()
 
979
        result = bzrlib.tests.TextTestResult(
 
980
            None,
 
981
            descriptions=0,
 
982
            verbosity=1,
 
983
            pb=pb,
 
984
            )
 
985
        test = self.get_passing_test()
 
986
        feature = Feature()
 
987
        # this seeds the state to handle reporting the test.
 
988
        result.startTest(test)
 
989
        result.report_unsupported(test, feature)
 
990
        # no output on unsupported features
 
991
        self.assertEqual(
 
992
            [('update', '[1 in 0s] passing_test', None, None)
 
993
            ],
 
994
            pb.calls)
 
995
        # the number of missing features should be printed in the progress
 
996
        # summary, so check for that.
 
997
        result.unsupported = {'foo':0, 'bar':0}
 
998
        test.run(result)
 
999
        self.assertEqual(
 
1000
            [
 
1001
            ('update', '[2 in 0s, 2 missing] passing_test', None, None),
 
1002
            ],
 
1003
            pb.calls[1:])
 
1004
    
 
1005
    def test_unavailable_exception(self):
 
1006
        """An UnavailableFeature being raised should invoke addNotSupported."""
 
1007
        class InstrumentedTestResult(ExtendedTestResult):
 
1008
 
 
1009
            def report_test_start(self, test): pass
 
1010
            def addNotSupported(self, test, feature):
 
1011
                self._call = test, feature
 
1012
        result = InstrumentedTestResult(None, None, None, None)
 
1013
        feature = Feature()
 
1014
        def test_function():
 
1015
            raise UnavailableFeature(feature)
 
1016
        test = unittest.FunctionTestCase(test_function)
 
1017
        test.run(result)
 
1018
        # it should invoke 'addNotSupported'.
 
1019
        self.assertEqual(2, len(result._call))
 
1020
        self.assertEqual(test, result._call[0])
 
1021
        self.assertEqual(feature, result._call[1])
 
1022
        # and not count as an error
 
1023
        self.assertEqual(0, result.error_count)
 
1024
 
 
1025
    def test_strict_with_unsupported_feature(self):
 
1026
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
1027
                                             verbosity=1)
 
1028
        test = self.get_passing_test()
 
1029
        feature = "Unsupported Feature"
 
1030
        result.addNotSupported(test, feature)
 
1031
        self.assertFalse(result.wasStrictlySuccessful())
 
1032
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
1033
 
 
1034
    def test_strict_with_known_failure(self):
 
1035
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
1036
                                             verbosity=1)
 
1037
        test = self.get_passing_test()
 
1038
        err = (KnownFailure, KnownFailure('foo'), None)
 
1039
        result._addKnownFailure(test, err)
 
1040
        self.assertFalse(result.wasStrictlySuccessful())
 
1041
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
1042
 
 
1043
    def test_strict_with_success(self):
 
1044
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
1045
                                             verbosity=1)
 
1046
        test = self.get_passing_test()
 
1047
        result.addSuccess(test)
 
1048
        self.assertTrue(result.wasStrictlySuccessful())
 
1049
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
1050
 
 
1051
 
 
1052
class TestRunner(TestCase):
 
1053
 
 
1054
    def dummy_test(self):
 
1055
        pass
 
1056
 
 
1057
    def run_test_runner(self, testrunner, test):
 
1058
        """Run suite in testrunner, saving global state and restoring it.
 
1059
 
 
1060
        This current saves and restores:
 
1061
        TestCaseInTempDir.TEST_ROOT
 
1062
        
 
1063
        There should be no tests in this file that use bzrlib.tests.TextTestRunner
 
1064
        without using this convenience method, because of our use of global state.
 
1065
        """
 
1066
        old_root = TestCaseInTempDir.TEST_ROOT
 
1067
        try:
 
1068
            TestCaseInTempDir.TEST_ROOT = None
 
1069
            return testrunner.run(test)
 
1070
        finally:
 
1071
            TestCaseInTempDir.TEST_ROOT = old_root
 
1072
 
 
1073
    def test_known_failure_failed_run(self):
 
1074
        # run a test that generates a known failure which should be printed in
 
1075
        # the final output when real failures occur.
 
1076
        def known_failure_test():
 
1077
            raise KnownFailure('failed')
 
1078
        test = unittest.TestSuite()
 
1079
        test.addTest(unittest.FunctionTestCase(known_failure_test))
 
1080
        def failing_test():
 
1081
            raise AssertionError('foo')
 
1082
        test.addTest(unittest.FunctionTestCase(failing_test))
 
1083
        stream = StringIO()
 
1084
        runner = TextTestRunner(stream=stream)
 
1085
        result = self.run_test_runner(runner, test)
 
1086
        lines = stream.getvalue().splitlines()
 
1087
        self.assertEqual([
 
1088
            '',
 
1089
            '======================================================================',
 
1090
            'FAIL: unittest.FunctionTestCase (failing_test)',
 
1091
            '----------------------------------------------------------------------',
 
1092
            'Traceback (most recent call last):',
 
1093
            '    raise AssertionError(\'foo\')',
 
1094
            'AssertionError: foo',
 
1095
            '',
 
1096
            '----------------------------------------------------------------------',
 
1097
            '',
 
1098
            'FAILED (failures=1, known_failure_count=1)'],
 
1099
            lines[0:5] + lines[6:10] + lines[11:])
 
1100
 
 
1101
    def test_known_failure_ok_run(self):
 
1102
        # run a test that generates a known failure which should be printed in the final output.
 
1103
        def known_failure_test():
 
1104
            raise KnownFailure('failed')
 
1105
        test = unittest.FunctionTestCase(known_failure_test)
 
1106
        stream = StringIO()
 
1107
        runner = TextTestRunner(stream=stream)
 
1108
        result = self.run_test_runner(runner, test)
 
1109
        self.assertContainsRe(stream.getvalue(),
 
1110
            '\n'
 
1111
            '-*\n'
 
1112
            'Ran 1 test in .*\n'
 
1113
            '\n'
 
1114
            'OK \\(known_failures=1\\)\n')
 
1115
 
 
1116
    def test_skipped_test(self):
 
1117
        # run a test that is skipped, and check the suite as a whole still
 
1118
        # succeeds.
 
1119
        # skipping_test must be hidden in here so it's not run as a real test
 
1120
        def skipping_test():
 
1121
            raise TestSkipped('test intentionally skipped')
 
1122
 
 
1123
        runner = TextTestRunner(stream=self._log_file)
 
1124
        test = unittest.FunctionTestCase(skipping_test)
 
1125
        result = self.run_test_runner(runner, test)
 
1126
        self.assertTrue(result.wasSuccessful())
 
1127
 
 
1128
    def test_skipped_from_setup(self):
 
1129
        calls = []
 
1130
        class SkippedSetupTest(TestCase):
 
1131
 
 
1132
            def setUp(self):
 
1133
                calls.append('setUp')
 
1134
                self.addCleanup(self.cleanup)
 
1135
                raise TestSkipped('skipped setup')
 
1136
 
 
1137
            def test_skip(self):
 
1138
                self.fail('test reached')
 
1139
 
 
1140
            def cleanup(self):
 
1141
                calls.append('cleanup')
 
1142
 
 
1143
        runner = TextTestRunner(stream=self._log_file)
 
1144
        test = SkippedSetupTest('test_skip')
 
1145
        result = self.run_test_runner(runner, test)
 
1146
        self.assertTrue(result.wasSuccessful())
 
1147
        # Check if cleanup was called the right number of times.
 
1148
        self.assertEqual(['setUp', 'cleanup'], calls)
 
1149
 
 
1150
    def test_skipped_from_test(self):
 
1151
        calls = []
 
1152
        class SkippedTest(TestCase):
 
1153
 
 
1154
            def setUp(self):
 
1155
                calls.append('setUp')
 
1156
                self.addCleanup(self.cleanup)
 
1157
 
 
1158
            def test_skip(self):
 
1159
                raise TestSkipped('skipped test')
 
1160
 
 
1161
            def cleanup(self):
 
1162
                calls.append('cleanup')
 
1163
 
 
1164
        runner = TextTestRunner(stream=self._log_file)
 
1165
        test = SkippedTest('test_skip')
 
1166
        result = self.run_test_runner(runner, test)
 
1167
        self.assertTrue(result.wasSuccessful())
 
1168
        # Check if cleanup was called the right number of times.
 
1169
        self.assertEqual(['setUp', 'cleanup'], calls)
 
1170
 
 
1171
    def test_not_applicable(self):
 
1172
        # run a test that is skipped because it's not applicable
 
1173
        def not_applicable_test():
 
1174
            from bzrlib.tests import TestNotApplicable
 
1175
            raise TestNotApplicable('this test never runs')
 
1176
        out = StringIO()
 
1177
        runner = TextTestRunner(stream=out, verbosity=2)
 
1178
        test = unittest.FunctionTestCase(not_applicable_test)
 
1179
        result = self.run_test_runner(runner, test)
 
1180
        self._log_file.write(out.getvalue())
 
1181
        self.assertTrue(result.wasSuccessful())
 
1182
        self.assertTrue(result.wasStrictlySuccessful())
 
1183
        self.assertContainsRe(out.getvalue(),
 
1184
                r'(?m)not_applicable_test   * N/A')
 
1185
        self.assertContainsRe(out.getvalue(),
 
1186
                r'(?m)^    this test never runs')
 
1187
 
 
1188
    def test_not_applicable_demo(self):
 
1189
        # just so you can see it in the test output
 
1190
        raise TestNotApplicable('this test is just a demonstation')
 
1191
 
 
1192
    def test_unsupported_features_listed(self):
 
1193
        """When unsupported features are encountered they are detailed."""
 
1194
        class Feature1(Feature):
 
1195
            def _probe(self): return False
 
1196
        class Feature2(Feature):
 
1197
            def _probe(self): return False
 
1198
        # create sample tests
 
1199
        test1 = SampleTestCase('_test_pass')
 
1200
        test1._test_needs_features = [Feature1()]
 
1201
        test2 = SampleTestCase('_test_pass')
 
1202
        test2._test_needs_features = [Feature2()]
 
1203
        test = unittest.TestSuite()
 
1204
        test.addTest(test1)
 
1205
        test.addTest(test2)
 
1206
        stream = StringIO()
 
1207
        runner = TextTestRunner(stream=stream)
 
1208
        result = self.run_test_runner(runner, test)
 
1209
        lines = stream.getvalue().splitlines()
 
1210
        self.assertEqual([
 
1211
            'OK',
 
1212
            "Missing feature 'Feature1' skipped 1 tests.",
 
1213
            "Missing feature 'Feature2' skipped 1 tests.",
 
1214
            ],
 
1215
            lines[-3:])
 
1216
 
 
1217
    def test_bench_history(self):
 
1218
        # tests that the running the benchmark produces a history file
 
1219
        # containing a timestamp and the revision id of the bzrlib source which
 
1220
        # was tested.
 
1221
        workingtree = _get_bzr_source_tree()
 
1222
        test = TestRunner('dummy_test')
 
1223
        output = StringIO()
 
1224
        runner = TextTestRunner(stream=self._log_file, bench_history=output)
 
1225
        result = self.run_test_runner(runner, test)
 
1226
        output_string = output.getvalue()
 
1227
        self.assertContainsRe(output_string, "--date [0-9.]+")
 
1228
        if workingtree is not None:
 
1229
            revision_id = workingtree.get_parent_ids()[0]
 
1230
            self.assertEndsWith(output_string.rstrip(), revision_id)
 
1231
 
 
1232
    def assertLogDeleted(self, test):
 
1233
        log = test._get_log()
 
1234
        self.assertEqual("DELETED log file to reduce memory footprint", log)
 
1235
        self.assertEqual('', test._log_contents)
 
1236
        self.assertIs(None, test._log_file_name)
 
1237
 
 
1238
    def test_success_log_deleted(self):
 
1239
        """Successful tests have their log deleted"""
 
1240
 
 
1241
        class LogTester(TestCase):
 
1242
 
 
1243
            def test_success(self):
 
1244
                self.log('this will be removed\n')
 
1245
 
 
1246
        sio = cStringIO.StringIO()
 
1247
        runner = TextTestRunner(stream=sio)
 
1248
        test = LogTester('test_success')
 
1249
        result = self.run_test_runner(runner, test)
 
1250
 
 
1251
        self.assertLogDeleted(test)
 
1252
 
 
1253
    def test_skipped_log_deleted(self):
 
1254
        """Skipped tests have their log deleted"""
 
1255
 
 
1256
        class LogTester(TestCase):
 
1257
 
 
1258
            def test_skipped(self):
 
1259
                self.log('this will be removed\n')
 
1260
                raise tests.TestSkipped()
 
1261
 
 
1262
        sio = cStringIO.StringIO()
 
1263
        runner = TextTestRunner(stream=sio)
 
1264
        test = LogTester('test_skipped')
 
1265
        result = self.run_test_runner(runner, test)
 
1266
 
 
1267
        self.assertLogDeleted(test)
 
1268
 
 
1269
    def test_not_aplicable_log_deleted(self):
 
1270
        """Not applicable tests have their log deleted"""
 
1271
 
 
1272
        class LogTester(TestCase):
 
1273
 
 
1274
            def test_not_applicable(self):
 
1275
                self.log('this will be removed\n')
 
1276
                raise tests.TestNotApplicable()
 
1277
 
 
1278
        sio = cStringIO.StringIO()
 
1279
        runner = TextTestRunner(stream=sio)
 
1280
        test = LogTester('test_not_applicable')
 
1281
        result = self.run_test_runner(runner, test)
 
1282
 
 
1283
        self.assertLogDeleted(test)
 
1284
 
 
1285
    def test_known_failure_log_deleted(self):
 
1286
        """Know failure tests have their log deleted"""
 
1287
 
 
1288
        class LogTester(TestCase):
 
1289
 
 
1290
            def test_known_failure(self):
 
1291
                self.log('this will be removed\n')
 
1292
                raise tests.KnownFailure()
 
1293
 
 
1294
        sio = cStringIO.StringIO()
 
1295
        runner = TextTestRunner(stream=sio)
 
1296
        test = LogTester('test_known_failure')
 
1297
        result = self.run_test_runner(runner, test)
 
1298
 
 
1299
        self.assertLogDeleted(test)
 
1300
 
 
1301
    def test_fail_log_kept(self):
 
1302
        """Failed tests have their log kept"""
 
1303
 
 
1304
        class LogTester(TestCase):
 
1305
 
 
1306
            def test_fail(self):
 
1307
                self.log('this will be kept\n')
 
1308
                self.fail('this test fails')
 
1309
 
 
1310
        sio = cStringIO.StringIO()
 
1311
        runner = TextTestRunner(stream=sio)
 
1312
        test = LogTester('test_fail')
 
1313
        result = self.run_test_runner(runner, test)
 
1314
 
 
1315
        text = sio.getvalue()
 
1316
        self.assertContainsRe(text, 'this will be kept')
 
1317
        self.assertContainsRe(text, 'this test fails')
 
1318
 
 
1319
        log = test._get_log()
 
1320
        self.assertContainsRe(log, 'this will be kept')
 
1321
        self.assertEqual(log, test._log_contents)
 
1322
 
 
1323
    def test_error_log_kept(self):
 
1324
        """Tests with errors have their log kept"""
 
1325
 
 
1326
        class LogTester(TestCase):
 
1327
 
 
1328
            def test_error(self):
 
1329
                self.log('this will be kept\n')
 
1330
                raise ValueError('random exception raised')
 
1331
 
 
1332
        sio = cStringIO.StringIO()
 
1333
        runner = TextTestRunner(stream=sio)
 
1334
        test = LogTester('test_error')
 
1335
        result = self.run_test_runner(runner, test)
 
1336
 
 
1337
        text = sio.getvalue()
 
1338
        self.assertContainsRe(text, 'this will be kept')
 
1339
        self.assertContainsRe(text, 'random exception raised')
 
1340
 
 
1341
        log = test._get_log()
 
1342
        self.assertContainsRe(log, 'this will be kept')
 
1343
        self.assertEqual(log, test._log_contents)
 
1344
 
 
1345
 
 
1346
class SampleTestCase(TestCase):
 
1347
 
 
1348
    def _test_pass(self):
 
1349
        pass
 
1350
 
 
1351
 
 
1352
class TestTestCase(TestCase):
 
1353
    """Tests that test the core bzrlib TestCase."""
 
1354
 
 
1355
    def test_debug_flags_sanitised(self):
 
1356
        """The bzrlib debug flags should be sanitised by setUp."""
 
1357
        # we could set something and run a test that will check
 
1358
        # it gets santised, but this is probably sufficient for now:
 
1359
        # if someone runs the test with -Dsomething it will error.
 
1360
        self.assertEqual(set(), bzrlib.debug.debug_flags)
 
1361
 
 
1362
    def inner_test(self):
 
1363
        # the inner child test
 
1364
        note("inner_test")
 
1365
 
 
1366
    def outer_child(self):
 
1367
        # the outer child test
 
1368
        note("outer_start")
 
1369
        self.inner_test = TestTestCase("inner_child")
 
1370
        result = bzrlib.tests.TextTestResult(self._log_file,
 
1371
                                        descriptions=0,
 
1372
                                        verbosity=1)
 
1373
        self.inner_test.run(result)
 
1374
        note("outer finish")
 
1375
 
 
1376
    def test_trace_nesting(self):
 
1377
        # this tests that each test case nests its trace facility correctly.
 
1378
        # we do this by running a test case manually. That test case (A)
 
1379
        # should setup a new log, log content to it, setup a child case (B),
 
1380
        # which should log independently, then case (A) should log a trailer
 
1381
        # and return.
 
1382
        # we do two nested children so that we can verify the state of the 
 
1383
        # logs after the outer child finishes is correct, which a bad clean
 
1384
        # up routine in tearDown might trigger a fault in our test with only
 
1385
        # one child, we should instead see the bad result inside our test with
 
1386
        # the two children.
 
1387
        # the outer child test
 
1388
        original_trace = bzrlib.trace._trace_file
 
1389
        outer_test = TestTestCase("outer_child")
 
1390
        result = bzrlib.tests.TextTestResult(self._log_file,
 
1391
                                        descriptions=0,
 
1392
                                        verbosity=1)
 
1393
        outer_test.run(result)
 
1394
        self.assertEqual(original_trace, bzrlib.trace._trace_file)
 
1395
 
 
1396
    def method_that_times_a_bit_twice(self):
 
1397
        # call self.time twice to ensure it aggregates
 
1398
        self.time(time.sleep, 0.007)
 
1399
        self.time(time.sleep, 0.007)
 
1400
 
 
1401
    def test_time_creates_benchmark_in_result(self):
 
1402
        """Test that the TestCase.time() method accumulates a benchmark time."""
 
1403
        sample_test = TestTestCase("method_that_times_a_bit_twice")
 
1404
        output_stream = StringIO()
 
1405
        result = bzrlib.tests.VerboseTestResult(
 
1406
            unittest._WritelnDecorator(output_stream),
 
1407
            descriptions=0,
 
1408
            verbosity=2,
 
1409
            num_tests=sample_test.countTestCases())
 
1410
        sample_test.run(result)
 
1411
        self.assertContainsRe(
 
1412
            output_stream.getvalue(),
 
1413
            r"\d+ms/ +\d+ms\n$")
 
1414
 
 
1415
    def test_hooks_sanitised(self):
 
1416
        """The bzrlib hooks should be sanitised by setUp."""
 
1417
        self.assertEqual(bzrlib.branch.BranchHooks(),
 
1418
            bzrlib.branch.Branch.hooks)
 
1419
        self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
 
1420
            bzrlib.smart.server.SmartTCPServer.hooks)
 
1421
 
 
1422
    def test__gather_lsprof_in_benchmarks(self):
 
1423
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
 
1424
        
 
1425
        Each self.time() call is individually and separately profiled.
 
1426
        """
 
1427
        self.requireFeature(test_lsprof.LSProfFeature)
 
1428
        # overrides the class member with an instance member so no cleanup 
 
1429
        # needed.
 
1430
        self._gather_lsprof_in_benchmarks = True
 
1431
        self.time(time.sleep, 0.000)
 
1432
        self.time(time.sleep, 0.003)
 
1433
        self.assertEqual(2, len(self._benchcalls))
 
1434
        self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
 
1435
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
 
1436
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
 
1437
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
 
1438
 
 
1439
    def test_knownFailure(self):
 
1440
        """Self.knownFailure() should raise a KnownFailure exception."""
 
1441
        self.assertRaises(KnownFailure, self.knownFailure, "A Failure")
 
1442
 
 
1443
    def test_requireFeature_available(self):
 
1444
        """self.requireFeature(available) is a no-op."""
 
1445
        class Available(Feature):
 
1446
            def _probe(self):return True
 
1447
        feature = Available()
 
1448
        self.requireFeature(feature)
 
1449
 
 
1450
    def test_requireFeature_unavailable(self):
 
1451
        """self.requireFeature(unavailable) raises UnavailableFeature."""
 
1452
        class Unavailable(Feature):
 
1453
            def _probe(self):return False
 
1454
        feature = Unavailable()
 
1455
        self.assertRaises(UnavailableFeature, self.requireFeature, feature)
 
1456
 
 
1457
    def test_run_no_parameters(self):
 
1458
        test = SampleTestCase('_test_pass')
 
1459
        test.run()
 
1460
    
 
1461
    def test_run_enabled_unittest_result(self):
 
1462
        """Test we revert to regular behaviour when the test is enabled."""
 
1463
        test = SampleTestCase('_test_pass')
 
1464
        class EnabledFeature(object):
 
1465
            def available(self):
 
1466
                return True
 
1467
        test._test_needs_features = [EnabledFeature()]
 
1468
        result = unittest.TestResult()
 
1469
        test.run(result)
 
1470
        self.assertEqual(1, result.testsRun)
 
1471
        self.assertEqual([], result.errors)
 
1472
        self.assertEqual([], result.failures)
 
1473
 
 
1474
    def test_run_disabled_unittest_result(self):
 
1475
        """Test our compatability for disabled tests with unittest results."""
 
1476
        test = SampleTestCase('_test_pass')
 
1477
        class DisabledFeature(object):
 
1478
            def available(self):
 
1479
                return False
 
1480
        test._test_needs_features = [DisabledFeature()]
 
1481
        result = unittest.TestResult()
 
1482
        test.run(result)
 
1483
        self.assertEqual(1, result.testsRun)
 
1484
        self.assertEqual([], result.errors)
 
1485
        self.assertEqual([], result.failures)
 
1486
 
 
1487
    def test_run_disabled_supporting_result(self):
 
1488
        """Test disabled tests behaviour with support aware results."""
 
1489
        test = SampleTestCase('_test_pass')
 
1490
        class DisabledFeature(object):
 
1491
            def available(self):
 
1492
                return False
 
1493
        the_feature = DisabledFeature()
 
1494
        test._test_needs_features = [the_feature]
 
1495
        class InstrumentedTestResult(unittest.TestResult):
 
1496
            def __init__(self):
 
1497
                unittest.TestResult.__init__(self)
 
1498
                self.calls = []
 
1499
            def startTest(self, test):
 
1500
                self.calls.append(('startTest', test))
 
1501
            def stopTest(self, test):
 
1502
                self.calls.append(('stopTest', test))
 
1503
            def addNotSupported(self, test, feature):
 
1504
                self.calls.append(('addNotSupported', test, feature))
 
1505
        result = InstrumentedTestResult()
 
1506
        test.run(result)
 
1507
        self.assertEqual([
 
1508
            ('startTest', test),
 
1509
            ('addNotSupported', test, the_feature),
 
1510
            ('stopTest', test),
 
1511
            ],
 
1512
            result.calls)
 
1513
 
 
1514
 
 
1515
@symbol_versioning.deprecated_function(zero_eleven)
 
1516
def sample_deprecated_function():
 
1517
    """A deprecated function to test applyDeprecated with."""
 
1518
    return 2
 
1519
 
 
1520
 
 
1521
def sample_undeprecated_function(a_param):
 
1522
    """A undeprecated function to test applyDeprecated with."""
 
1523
 
 
1524
 
 
1525
class ApplyDeprecatedHelper(object):
 
1526
    """A helper class for ApplyDeprecated tests."""
 
1527
 
 
1528
    @symbol_versioning.deprecated_method(zero_eleven)
 
1529
    def sample_deprecated_method(self, param_one):
 
1530
        """A deprecated method for testing with."""
 
1531
        return param_one
 
1532
 
 
1533
    def sample_normal_method(self):
 
1534
        """A undeprecated method."""
 
1535
 
 
1536
    @symbol_versioning.deprecated_method(zero_ten)
 
1537
    def sample_nested_deprecation(self):
 
1538
        return sample_deprecated_function()
 
1539
 
 
1540
 
387
1541
class TestExtraAssertions(TestCase):
388
1542
    """Tests for new test assertions in bzrlib test suite"""
389
1543
 
392
1546
        self.assertIsInstance(u'', basestring)
393
1547
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
394
1548
        self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
 
1549
 
 
1550
    def test_assertEndsWith(self):
 
1551
        self.assertEndsWith('foo', 'oo')
 
1552
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
 
1553
 
 
1554
    def test_applyDeprecated_not_deprecated(self):
 
1555
        sample_object = ApplyDeprecatedHelper()
 
1556
        # calling an undeprecated callable raises an assertion
 
1557
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
 
1558
            sample_object.sample_normal_method)
 
1559
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
 
1560
            sample_undeprecated_function, "a param value")
 
1561
        # calling a deprecated callable (function or method) with the wrong
 
1562
        # expected deprecation fails.
 
1563
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
 
1564
            sample_object.sample_deprecated_method, "a param value")
 
1565
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
 
1566
            sample_deprecated_function)
 
1567
        # calling a deprecated callable (function or method) with the right
 
1568
        # expected deprecation returns the functions result.
 
1569
        self.assertEqual("a param value", self.applyDeprecated(zero_eleven,
 
1570
            sample_object.sample_deprecated_method, "a param value"))
 
1571
        self.assertEqual(2, self.applyDeprecated(zero_eleven,
 
1572
            sample_deprecated_function))
 
1573
        # calling a nested deprecation with the wrong deprecation version
 
1574
        # fails even if a deeper nested function was deprecated with the 
 
1575
        # supplied version.
 
1576
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1577
            zero_eleven, sample_object.sample_nested_deprecation)
 
1578
        # calling a nested deprecation with the right deprecation value
 
1579
        # returns the calls result.
 
1580
        self.assertEqual(2, self.applyDeprecated(zero_ten,
 
1581
            sample_object.sample_nested_deprecation))
 
1582
 
 
1583
    def test_callDeprecated(self):
 
1584
        def testfunc(be_deprecated, result=None):
 
1585
            if be_deprecated is True:
 
1586
                symbol_versioning.warn('i am deprecated', DeprecationWarning, 
 
1587
                                       stacklevel=1)
 
1588
            return result
 
1589
        result = self.callDeprecated(['i am deprecated'], testfunc, True)
 
1590
        self.assertIs(None, result)
 
1591
        result = self.callDeprecated([], testfunc, False, 'result')
 
1592
        self.assertEqual('result', result)
 
1593
        self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
 
1594
        self.callDeprecated([], testfunc, be_deprecated=False)
 
1595
 
 
1596
 
 
1597
class TestWarningTests(TestCase):
 
1598
    """Tests for calling methods that raise warnings."""
 
1599
 
 
1600
    def test_callCatchWarnings(self):
 
1601
        def meth(a, b):
 
1602
            warnings.warn("this is your last warning")
 
1603
            return a + b
 
1604
        wlist, result = self.callCatchWarnings(meth, 1, 2)
 
1605
        self.assertEquals(3, result)
 
1606
        # would like just to compare them, but UserWarning doesn't implement
 
1607
        # eq well
 
1608
        w0, = wlist
 
1609
        self.assertIsInstance(w0, UserWarning)
 
1610
        self.assertEquals("this is your last warning", str(w0))
 
1611
 
 
1612
 
 
1613
class TestConvenienceMakers(TestCaseWithTransport):
 
1614
    """Test for the make_* convenience functions."""
 
1615
 
 
1616
    def test_make_branch_and_tree_with_format(self):
 
1617
        # we should be able to supply a format to make_branch_and_tree
 
1618
        self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
 
1619
        self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
 
1620
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
 
1621
                              bzrlib.bzrdir.BzrDirMetaFormat1)
 
1622
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
 
1623
                              bzrlib.bzrdir.BzrDirFormat6)
 
1624
 
 
1625
    def test_make_branch_and_memory_tree(self):
 
1626
        # we should be able to get a new branch and a mutable tree from
 
1627
        # TestCaseWithTransport
 
1628
        tree = self.make_branch_and_memory_tree('a')
 
1629
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
 
1630
 
 
1631
 
 
1632
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
 
1633
 
 
1634
    def test_make_tree_for_sftp_branch(self):
 
1635
        """Transports backed by local directories create local trees."""
 
1636
 
 
1637
        tree = self.make_branch_and_tree('t1')
 
1638
        base = tree.bzrdir.root_transport.base
 
1639
        self.failIf(base.startswith('sftp'),
 
1640
                'base %r is on sftp but should be local' % base)
 
1641
        self.assertEquals(tree.bzrdir.root_transport,
 
1642
                tree.branch.bzrdir.root_transport)
 
1643
        self.assertEquals(tree.bzrdir.root_transport,
 
1644
                tree.branch.repository.bzrdir.root_transport)
 
1645
 
 
1646
 
 
1647
class TestSelftest(TestCase):
 
1648
    """Tests of bzrlib.tests.selftest."""
 
1649
 
 
1650
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
 
1651
        factory_called = []
 
1652
        def factory():
 
1653
            factory_called.append(True)
 
1654
            return TestSuite()
 
1655
        out = StringIO()
 
1656
        err = StringIO()
 
1657
        self.apply_redirected(out, err, None, bzrlib.tests.selftest, 
 
1658
            test_suite_factory=factory)
 
1659
        self.assertEqual([True], factory_called)
 
1660
 
 
1661
 
 
1662
class TestKnownFailure(TestCase):
 
1663
 
 
1664
    def test_known_failure(self):
 
1665
        """Check that KnownFailure is defined appropriately."""
 
1666
        # a KnownFailure is an assertion error for compatability with unaware
 
1667
        # runners.
 
1668
        self.assertIsInstance(KnownFailure(""), AssertionError)
 
1669
 
 
1670
    def test_expect_failure(self):
 
1671
        try:
 
1672
            self.expectFailure("Doomed to failure", self.assertTrue, False)
 
1673
        except KnownFailure, e:
 
1674
            self.assertEqual('Doomed to failure', e.args[0])
 
1675
        try:
 
1676
            self.expectFailure("Doomed to failure", self.assertTrue, True)
 
1677
        except AssertionError, e:
 
1678
            self.assertEqual('Unexpected success.  Should have failed:'
 
1679
                             ' Doomed to failure', e.args[0])
 
1680
        else:
 
1681
            self.fail('Assertion not raised')
 
1682
 
 
1683
 
 
1684
class TestFeature(TestCase):
 
1685
 
 
1686
    def test_caching(self):
 
1687
        """Feature._probe is called by the feature at most once."""
 
1688
        class InstrumentedFeature(Feature):
 
1689
            def __init__(self):
 
1690
                Feature.__init__(self)
 
1691
                self.calls = []
 
1692
            def _probe(self):
 
1693
                self.calls.append('_probe')
 
1694
                return False
 
1695
        feature = InstrumentedFeature()
 
1696
        feature.available()
 
1697
        self.assertEqual(['_probe'], feature.calls)
 
1698
        feature.available()
 
1699
        self.assertEqual(['_probe'], feature.calls)
 
1700
 
 
1701
    def test_named_str(self):
 
1702
        """Feature.__str__ should thunk to feature_name()."""
 
1703
        class NamedFeature(Feature):
 
1704
            def feature_name(self):
 
1705
                return 'symlinks'
 
1706
        feature = NamedFeature()
 
1707
        self.assertEqual('symlinks', str(feature))
 
1708
 
 
1709
    def test_default_str(self):
 
1710
        """Feature.__str__ should default to __class__.__name__."""
 
1711
        class NamedFeature(Feature):
 
1712
            pass
 
1713
        feature = NamedFeature()
 
1714
        self.assertEqual('NamedFeature', str(feature))
 
1715
 
 
1716
 
 
1717
class TestUnavailableFeature(TestCase):
 
1718
 
 
1719
    def test_access_feature(self):
 
1720
        feature = Feature()
 
1721
        exception = UnavailableFeature(feature)
 
1722
        self.assertIs(feature, exception.args[0])
 
1723
 
 
1724
 
 
1725
class TestSelftestFiltering(TestCase):
 
1726
 
 
1727
    def setUp(self):
 
1728
        self.suite = TestUtil.TestSuite()
 
1729
        self.loader = TestUtil.TestLoader()
 
1730
        self.suite.addTest(self.loader.loadTestsFromModuleNames([
 
1731
            'bzrlib.tests.test_selftest']))
 
1732
        self.all_names = _test_ids(self.suite)
 
1733
 
 
1734
    def test_condition_id_re(self):
 
1735
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1736
            'test_condition_id_re')
 
1737
        filtered_suite = filter_suite_by_condition(self.suite,
 
1738
            condition_id_re('test_condition_id_re'))
 
1739
        self.assertEqual([test_name], _test_ids(filtered_suite))
 
1740
 
 
1741
    def test_condition_id_in_list(self):
 
1742
        test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1743
                      'test_condition_id_in_list']
 
1744
        id_list = tests.TestIdList(test_names)
 
1745
        filtered_suite = filter_suite_by_condition(
 
1746
            self.suite, tests.condition_id_in_list(id_list))
 
1747
        my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
 
1748
        re_filtered = filter_suite_by_re(self.suite, my_pattern)
 
1749
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
 
1750
 
 
1751
    def test_condition_id_startswith(self):
 
1752
        klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1753
        start = klass + 'test_condition_id_starts'
 
1754
        test_names = [klass + 'test_condition_id_startswith']
 
1755
        filtered_suite = filter_suite_by_condition(
 
1756
            self.suite, tests.condition_id_startswith(start))
 
1757
        my_pattern = 'TestSelftestFiltering.*test_condition_id_startswith'
 
1758
        re_filtered = filter_suite_by_re(self.suite, my_pattern)
 
1759
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
 
1760
 
 
1761
    def test_condition_isinstance(self):
 
1762
        filtered_suite = filter_suite_by_condition(self.suite,
 
1763
            condition_isinstance(self.__class__))
 
1764
        class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1765
        re_filtered = filter_suite_by_re(self.suite, class_pattern)
 
1766
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
 
1767
 
 
1768
    def test_exclude_tests_by_condition(self):
 
1769
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1770
            'test_exclude_tests_by_condition')
 
1771
        filtered_suite = exclude_tests_by_condition(self.suite,
 
1772
            lambda x:x.id() == excluded_name)
 
1773
        self.assertEqual(len(self.all_names) - 1,
 
1774
            filtered_suite.countTestCases())
 
1775
        self.assertFalse(excluded_name in _test_ids(filtered_suite))
 
1776
        remaining_names = list(self.all_names)
 
1777
        remaining_names.remove(excluded_name)
 
1778
        self.assertEqual(remaining_names, _test_ids(filtered_suite))
 
1779
 
 
1780
    def test_exclude_tests_by_re(self):
 
1781
        self.all_names = _test_ids(self.suite)
 
1782
        filtered_suite = exclude_tests_by_re(self.suite, 'exclude_tests_by_re')
 
1783
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1784
            'test_exclude_tests_by_re')
 
1785
        self.assertEqual(len(self.all_names) - 1,
 
1786
            filtered_suite.countTestCases())
 
1787
        self.assertFalse(excluded_name in _test_ids(filtered_suite))
 
1788
        remaining_names = list(self.all_names)
 
1789
        remaining_names.remove(excluded_name)
 
1790
        self.assertEqual(remaining_names, _test_ids(filtered_suite))
 
1791
 
 
1792
    def test_filter_suite_by_condition(self):
 
1793
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1794
            'test_filter_suite_by_condition')
 
1795
        filtered_suite = filter_suite_by_condition(self.suite,
 
1796
            lambda x:x.id() == test_name)
 
1797
        self.assertEqual([test_name], _test_ids(filtered_suite))
 
1798
 
 
1799
    def test_filter_suite_by_re(self):
 
1800
        filtered_suite = filter_suite_by_re(self.suite, 'test_filter_suite_by_r')
 
1801
        filtered_names = _test_ids(filtered_suite)
 
1802
        self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
 
1803
            'TestSelftestFiltering.test_filter_suite_by_re'])
 
1804
 
 
1805
    def test_filter_suite_by_id_list(self):
 
1806
        test_list = ['bzrlib.tests.test_selftest.'
 
1807
                     'TestSelftestFiltering.test_filter_suite_by_id_list']
 
1808
        filtered_suite = tests.filter_suite_by_id_list(
 
1809
            self.suite, tests.TestIdList(test_list))
 
1810
        filtered_names = _test_ids(filtered_suite)
 
1811
        self.assertEqual(
 
1812
            filtered_names,
 
1813
            ['bzrlib.tests.test_selftest.'
 
1814
             'TestSelftestFiltering.test_filter_suite_by_id_list'])
 
1815
 
 
1816
    def test_filter_suite_by_id_startswith(self):
 
1817
        # By design this test may fail if another test is added whose name also
 
1818
        # begins with the start value used.
 
1819
        klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1820
        start = klass + 'test_filter_suite_by_id_starts'
 
1821
        test_list = [klass + 'test_filter_suite_by_id_startswith']
 
1822
        filtered_suite = tests.filter_suite_by_id_startswith(self.suite, start)
 
1823
        filtered_names = _test_ids(filtered_suite)
 
1824
        self.assertEqual(
 
1825
            filtered_names,
 
1826
            ['bzrlib.tests.test_selftest.'
 
1827
             'TestSelftestFiltering.test_filter_suite_by_id_startswith'])
 
1828
 
 
1829
    def test_preserve_input(self):
 
1830
        # NB: Surely this is something in the stdlib to do this?
 
1831
        self.assertTrue(self.suite is preserve_input(self.suite))
 
1832
        self.assertTrue("@#$" is preserve_input("@#$"))
 
1833
 
 
1834
    def test_randomize_suite(self):
 
1835
        randomized_suite = randomize_suite(self.suite)
 
1836
        # randomizing should not add or remove test names.
 
1837
        self.assertEqual(set(_test_ids(self.suite)),
 
1838
                         set(_test_ids(randomized_suite)))
 
1839
        # Technically, this *can* fail, because random.shuffle(list) can be
 
1840
        # equal to list. Trying multiple times just pushes the frequency back.
 
1841
        # As its len(self.all_names)!:1, the failure frequency should be low
 
1842
        # enough to ignore. RBC 20071021.
 
1843
        # It should change the order.
 
1844
        self.assertNotEqual(self.all_names, _test_ids(randomized_suite))
 
1845
        # But not the length. (Possibly redundant with the set test, but not
 
1846
        # necessarily.)
 
1847
        self.assertEqual(len(self.all_names), len(_test_ids(randomized_suite)))
 
1848
 
 
1849
    def test_split_suit_by_condition(self):
 
1850
        self.all_names = _test_ids(self.suite)
 
1851
        condition = condition_id_re('test_filter_suite_by_r')
 
1852
        split_suite = split_suite_by_condition(self.suite, condition)
 
1853
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1854
            'test_filter_suite_by_re')
 
1855
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
 
1856
        self.assertFalse(filtered_name in _test_ids(split_suite[1]))
 
1857
        remaining_names = list(self.all_names)
 
1858
        remaining_names.remove(filtered_name)
 
1859
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
 
1860
 
 
1861
    def test_split_suit_by_re(self):
 
1862
        self.all_names = _test_ids(self.suite)
 
1863
        split_suite = split_suite_by_re(self.suite, 'test_filter_suite_by_r')
 
1864
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
1865
            'test_filter_suite_by_re')
 
1866
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
 
1867
        self.assertFalse(filtered_name in _test_ids(split_suite[1]))
 
1868
        remaining_names = list(self.all_names)
 
1869
        remaining_names.remove(filtered_name)
 
1870
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
 
1871
 
 
1872
 
 
1873
class TestCheckInventoryShape(TestCaseWithTransport):
 
1874
 
 
1875
    def test_check_inventory_shape(self):
 
1876
        files = ['a', 'b/', 'b/c']
 
1877
        tree = self.make_branch_and_tree('.')
 
1878
        self.build_tree(files)
 
1879
        tree.add(files)
 
1880
        tree.lock_read()
 
1881
        try:
 
1882
            self.check_inventory_shape(tree.inventory, files)
 
1883
        finally:
 
1884
            tree.unlock()
 
1885
 
 
1886
 
 
1887
class TestBlackboxSupport(TestCase):
 
1888
    """Tests for testsuite blackbox features."""
 
1889
 
 
1890
    def test_run_bzr_failure_not_caught(self):
 
1891
        # When we run bzr in blackbox mode, we want any unexpected errors to
 
1892
        # propagate up to the test suite so that it can show the error in the
 
1893
        # usual way, and we won't get a double traceback.
 
1894
        e = self.assertRaises(
 
1895
            AssertionError,
 
1896
            self.run_bzr, ['assert-fail'])
 
1897
        # make sure we got the real thing, not an error from somewhere else in
 
1898
        # the test framework
 
1899
        self.assertEquals('always fails', str(e))
 
1900
        # check that there's no traceback in the test log
 
1901
        self.assertNotContainsRe(self._get_log(keep_log_file=True),
 
1902
            r'Traceback')
 
1903
 
 
1904
    def test_run_bzr_user_error_caught(self):
 
1905
        # Running bzr in blackbox mode, normal/expected/user errors should be
 
1906
        # caught in the regular way and turned into an error message plus exit
 
1907
        # code.
 
1908
        out, err = self.run_bzr(["log", "/nonexistantpath"], retcode=3)
 
1909
        self.assertEqual(out, '')
 
1910
        self.assertContainsRe(err,
 
1911
            'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
 
1912
 
 
1913
 
 
1914
class TestTestLoader(TestCase):
 
1915
    """Tests for the test loader."""
 
1916
 
 
1917
    def _get_loader_and_module(self):
 
1918
        """Gets a TestLoader and a module with one test in it."""
 
1919
        loader = TestUtil.TestLoader()
 
1920
        module = {}
 
1921
        class Stub(TestCase):
 
1922
            def test_foo(self):
 
1923
                pass
 
1924
        class MyModule(object):
 
1925
            pass
 
1926
        MyModule.a_class = Stub
 
1927
        module = MyModule()
 
1928
        return loader, module
 
1929
 
 
1930
    def test_module_no_load_tests_attribute_loads_classes(self):
 
1931
        loader, module = self._get_loader_and_module()
 
1932
        self.assertEqual(1, loader.loadTestsFromModule(module).countTestCases())
 
1933
 
 
1934
    def test_module_load_tests_attribute_gets_called(self):
 
1935
        loader, module = self._get_loader_and_module()
 
1936
        # 'self' is here because we're faking the module with a class. Regular
 
1937
        # load_tests do not need that :)
 
1938
        def load_tests(self, standard_tests, module, loader):
 
1939
            result = loader.suiteClass()
 
1940
            for test in iter_suite_tests(standard_tests):
 
1941
                result.addTests([test, test])
 
1942
            return result
 
1943
        # add a load_tests() method which multiplies the tests from the module.
 
1944
        module.__class__.load_tests = load_tests
 
1945
        self.assertEqual(2, loader.loadTestsFromModule(module).countTestCases())
 
1946
 
 
1947
    def test_load_tests_from_module_name_smoke_test(self):
 
1948
        loader = TestUtil.TestLoader()
 
1949
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
1950
        self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
 
1951
                          _test_ids(suite))
 
1952
 
 
1953
    def test_load_tests_from_module_name_with_bogus_module_name(self):
 
1954
        loader = TestUtil.TestLoader()
 
1955
        self.assertRaises(ImportError, loader.loadTestsFromModuleName, 'bogus')
 
1956
 
 
1957
 
 
1958
class TestTestIdList(tests.TestCase):
 
1959
 
 
1960
    def _create_id_list(self, test_list):
 
1961
        return tests.TestIdList(test_list)
 
1962
 
 
1963
    def _create_suite(self, test_id_list):
 
1964
 
 
1965
        class Stub(TestCase):
 
1966
            def test_foo(self):
 
1967
                pass
 
1968
 
 
1969
        def _create_test_id(id):
 
1970
            return lambda: id
 
1971
 
 
1972
        suite = TestUtil.TestSuite()
 
1973
        for id in test_id_list:
 
1974
            t  = Stub('test_foo')
 
1975
            t.id = _create_test_id(id)
 
1976
            suite.addTest(t)
 
1977
        return suite
 
1978
 
 
1979
    def _test_ids(self, test_suite):
 
1980
        """Get the ids for the tests in a test suite."""
 
1981
        return [t.id() for t in iter_suite_tests(test_suite)]
 
1982
 
 
1983
    def test_empty_list(self):
 
1984
        id_list = self._create_id_list([])
 
1985
        self.assertEquals({}, id_list.tests)
 
1986
        self.assertEquals({}, id_list.modules)
 
1987
 
 
1988
    def test_valid_list(self):
 
1989
        id_list = self._create_id_list(
 
1990
            ['mod1.cl1.meth1', 'mod1.cl1.meth2',
 
1991
             'mod1.func1', 'mod1.cl2.meth2',
 
1992
             'mod1.submod1',
 
1993
             'mod1.submod2.cl1.meth1', 'mod1.submod2.cl2.meth2',
 
1994
             ])
 
1995
        self.assertTrue(id_list.refers_to('mod1'))
 
1996
        self.assertTrue(id_list.refers_to('mod1.submod1'))
 
1997
        self.assertTrue(id_list.refers_to('mod1.submod2'))
 
1998
        self.assertTrue(id_list.includes('mod1.cl1.meth1'))
 
1999
        self.assertTrue(id_list.includes('mod1.submod1'))
 
2000
        self.assertTrue(id_list.includes('mod1.func1'))
 
2001
 
 
2002
    def test_bad_chars_in_params(self):
 
2003
        id_list = self._create_id_list(['mod1.cl1.meth1(xx.yy)'])
 
2004
        self.assertTrue(id_list.refers_to('mod1'))
 
2005
        self.assertTrue(id_list.includes('mod1.cl1.meth1(xx.yy)'))
 
2006
 
 
2007
    def test_module_used(self):
 
2008
        id_list = self._create_id_list(['mod.class.meth'])
 
2009
        self.assertTrue(id_list.refers_to('mod'))
 
2010
        self.assertTrue(id_list.refers_to('mod.class'))
 
2011
        self.assertTrue(id_list.refers_to('mod.class.meth'))
 
2012
 
 
2013
    def test_test_suite(self):
 
2014
        # This test is slow, so we do a single test with one test in each
 
2015
        # category
 
2016
        test_list = [
 
2017
            # testmod_names
 
2018
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
 
2019
            'bzrlib.tests.test_selftest.TestTestIdList.test_test_suite',
 
2020
            # transport implementations
 
2021
            'bzrlib.tests.test_transport_implementations.TransportTests'
 
2022
            '.test_abspath(LocalURLServer)',
 
2023
            # modules_to_doctest
 
2024
            'bzrlib.timestamp.format_highres_date',
 
2025
            # plugins can't be tested that way since selftest may be run with
 
2026
            # --no-plugins
 
2027
            ]
 
2028
        suite = tests.test_suite(test_list)
 
2029
        self.assertEquals(test_list, _test_ids(suite))
 
2030
 
 
2031
    def test_test_suite_matches_id_list_with_unknown(self):
 
2032
        loader = TestUtil.TestLoader()
 
2033
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2034
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',
 
2035
                     'bogus']
 
2036
        not_found, duplicates = tests.suite_matches_id_list(suite, test_list)
 
2037
        self.assertEquals(['bogus'], not_found)
 
2038
        self.assertEquals([], duplicates)
 
2039
 
 
2040
    def test_suite_matches_id_list_with_duplicates(self):
 
2041
        loader = TestUtil.TestLoader()
 
2042
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2043
        dupes = loader.suiteClass()
 
2044
        for test in iter_suite_tests(suite):
 
2045
            dupes.addTest(test)
 
2046
            dupes.addTest(test) # Add it again
 
2047
 
 
2048
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',]
 
2049
        not_found, duplicates = tests.suite_matches_id_list(
 
2050
            dupes, test_list)
 
2051
        self.assertEquals([], not_found)
 
2052
        self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
 
2053
                          duplicates)
 
2054
 
 
2055
 
 
2056
class TestLoadTestIdList(tests.TestCaseInTempDir):
 
2057
 
 
2058
    def _create_test_list_file(self, file_name, content):
 
2059
        fl = open(file_name, 'wt')
 
2060
        fl.write(content)
 
2061
        fl.close()
 
2062
 
 
2063
    def test_load_unknown(self):
 
2064
        self.assertRaises(errors.NoSuchFile,
 
2065
                          tests.load_test_id_list, 'i_do_not_exist')
 
2066
 
 
2067
    def test_load_test_list(self):
 
2068
        test_list_fname = 'test.list'
 
2069
        self._create_test_list_file(test_list_fname,
 
2070
                                    'mod1.cl1.meth1\nmod2.cl2.meth2\n')
 
2071
        tlist = tests.load_test_id_list(test_list_fname)
 
2072
        self.assertEquals(2, len(tlist))
 
2073
        self.assertEquals('mod1.cl1.meth1', tlist[0])
 
2074
        self.assertEquals('mod2.cl2.meth2', tlist[1])
 
2075
 
 
2076
    def test_load_dirty_file(self):
 
2077
        test_list_fname = 'test.list'
 
2078
        self._create_test_list_file(test_list_fname,
 
2079
                                    '  mod1.cl1.meth1\n\nmod2.cl2.meth2  \n'
 
2080
                                    'bar baz\n')
 
2081
        tlist = tests.load_test_id_list(test_list_fname)
 
2082
        self.assertEquals(4, len(tlist))
 
2083
        self.assertEquals('mod1.cl1.meth1', tlist[0])
 
2084
        self.assertEquals('', tlist[1])
 
2085
        self.assertEquals('mod2.cl2.meth2', tlist[2])
 
2086
        self.assertEquals('bar baz', tlist[3])
 
2087
 
 
2088
 
 
2089
class TestFilteredByModuleTestLoader(tests.TestCase):
 
2090
 
 
2091
    def _create_loader(self, test_list):
 
2092
        id_filter = tests.TestIdList(test_list)
 
2093
        loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
 
2094
        return loader
 
2095
 
 
2096
    def test_load_tests(self):
 
2097
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2098
        loader = self._create_loader(test_list)
 
2099
 
 
2100
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2101
        self.assertEquals(test_list, _test_ids(suite))
 
2102
 
 
2103
    def test_exclude_tests(self):
 
2104
        test_list = ['bogus']
 
2105
        loader = self._create_loader(test_list)
 
2106
 
 
2107
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2108
        self.assertEquals([], _test_ids(suite))
 
2109
 
 
2110
 
 
2111
class TestFilteredByNameStartTestLoader(tests.TestCase):
 
2112
 
 
2113
    def _create_loader(self, name_start):
 
2114
        def needs_module(name):
 
2115
            return name.startswith(name_start) or name_start.startswith(name)
 
2116
        loader = TestUtil.FilteredByModuleTestLoader(needs_module)
 
2117
        return loader
 
2118
 
 
2119
    def test_load_tests(self):
 
2120
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2121
        loader = self._create_loader('bzrlib.tests.test_samp')
 
2122
 
 
2123
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2124
        self.assertEquals(test_list, _test_ids(suite))
 
2125
 
 
2126
    def test_load_tests_inside_module(self):
 
2127
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2128
        loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
 
2129
 
 
2130
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2131
        self.assertEquals(test_list, _test_ids(suite))
 
2132
 
 
2133
    def test_exclude_tests(self):
 
2134
        test_list = ['bogus']
 
2135
        loader = self._create_loader('bogus')
 
2136
 
 
2137
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2138
        self.assertEquals([], _test_ids(suite))