~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 13:22:18 UTC
  • mfrom: (6155.2.2 migrate-config-options)
  • Revision ID: pqm@pqm.ubuntu.com-20110922132218-nitl31j5slbcmnm2
(vila) Migrate dpush_strict,
 push_strict and send_strict options to the stack based config design,
 introducing get_config_stack for branches (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Tests for the test framework."""
18
18
 
19
 
import cStringIO
 
19
from cStringIO import StringIO
 
20
import doctest
20
21
import os
21
 
from StringIO import StringIO
 
22
import signal
22
23
import sys
 
24
import threading
23
25
import time
24
26
import unittest
25
27
import warnings
26
28
 
 
29
from testtools import (
 
30
    ExtendedToOriginalDecorator,
 
31
    MultiTestResult,
 
32
    __version__ as testtools_version,
 
33
    )
 
34
from testtools.content import Content
 
35
from testtools.content_type import ContentType
 
36
from testtools.matchers import (
 
37
    DocTestMatches,
 
38
    Equals,
 
39
    )
 
40
import testtools.testresult.doubles
 
41
 
27
42
import bzrlib
28
43
from bzrlib import (
29
44
    branchbuilder,
30
45
    bzrdir,
31
46
    errors,
 
47
    hooks,
 
48
    lockdir,
32
49
    memorytree,
33
50
    osutils,
34
51
    remote,
35
52
    repository,
36
53
    symbol_versioning,
37
54
    tests,
 
55
    transport,
38
56
    workingtree,
 
57
    workingtree_3,
 
58
    workingtree_4,
39
59
    )
40
 
from bzrlib.progress import _BaseProgressBar
41
60
from bzrlib.repofmt import (
42
 
    pack_repo,
43
 
    weaverepo,
 
61
    groupcompress_repo,
44
62
    )
45
63
from bzrlib.symbol_versioning import (
46
 
    one_zero,
47
 
    zero_eleven,
48
 
    zero_ten,
 
64
    deprecated_function,
 
65
    deprecated_in,
 
66
    deprecated_method,
49
67
    )
50
68
from bzrlib.tests import (
51
 
                          ChrootedTestCase,
52
 
                          ExtendedTestResult,
53
 
                          Feature,
54
 
                          KnownFailure,
55
 
                          TestCase,
56
 
                          TestCaseInTempDir,
57
 
                          TestCaseWithMemoryTransport,
58
 
                          TestCaseWithTransport,
59
 
                          TestNotApplicable,
60
 
                          TestSkipped,
61
 
                          TestSuite,
62
 
                          TestUtil,
63
 
                          TextTestRunner,
64
 
                          UnavailableFeature,
65
 
                          condition_id_re,
66
 
                          condition_isinstance,
67
 
                          exclude_tests_by_condition,
68
 
                          exclude_tests_by_re,
69
 
                          filter_suite_by_condition,
70
 
                          filter_suite_by_re,
71
 
                          iter_suite_tests,
72
 
                          preserve_input,
73
 
                          randomize_suite,
74
 
                          run_suite,
75
 
                          split_suite_by_condition,
76
 
                          split_suite_by_re,
77
 
                          test_lsprof,
78
 
                          test_suite,
79
 
                          )
80
 
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
81
 
from bzrlib.tests.TestUtil import _load_module_by_name
82
 
from bzrlib.trace import note
83
 
from bzrlib.transport.memory import MemoryServer, MemoryTransport
84
 
from bzrlib.version import _get_bzr_source_tree
 
69
    features,
 
70
    test_lsprof,
 
71
    test_server,
 
72
    TestUtil,
 
73
    )
 
74
from bzrlib.trace import note, mutter
 
75
from bzrlib.transport import memory
85
76
 
86
77
 
87
78
def _test_ids(test_suite):
88
79
    """Get the ids for the tests in a test suite."""
89
 
    return [t.id() for t in iter_suite_tests(test_suite)]
90
 
 
91
 
 
92
 
class SelftestTests(TestCase):
93
 
 
94
 
    def test_import_tests(self):
95
 
        mod = _load_module_by_name('bzrlib.tests.test_selftest')
96
 
        self.assertEqual(mod.SelftestTests, SelftestTests)
97
 
 
98
 
    def test_import_test_failure(self):
99
 
        self.assertRaises(ImportError,
100
 
                          _load_module_by_name,
101
 
                          'bzrlib.no-name-yet')
102
 
 
103
 
class MetaTestLog(TestCase):
 
80
    return [t.id() for t in tests.iter_suite_tests(test_suite)]
 
81
 
 
82
 
 
83
class MetaTestLog(tests.TestCase):
104
84
 
105
85
    def test_logging(self):
106
86
        """Test logs are captured when a test fails."""
107
87
        self.log('a test message')
108
 
        self._log_file.flush()
109
 
        self.assertContainsRe(self._get_log(keep_log_file=True),
110
 
                              'a test message\n')
111
 
 
112
 
 
113
 
class TestUnicodeFilename(TestCase):
114
 
 
115
 
    def test_probe_passes(self):
116
 
        """UnicodeFilename._probe passes."""
117
 
        # We can't test much more than that because the behaviour depends
118
 
        # on the platform.
119
 
        tests.UnicodeFilename._probe()
120
 
 
121
 
 
122
 
class TestTreeShape(TestCaseInTempDir):
 
88
        details = self.getDetails()
 
89
        log = details['log']
 
90
        self.assertThat(log.content_type, Equals(ContentType(
 
91
            "text", "plain", {"charset": "utf8"})))
 
92
        self.assertThat(u"".join(log.iter_text()), Equals(self.get_log()))
 
93
        self.assertThat(self.get_log(),
 
94
            DocTestMatches(u"...a test message\n", doctest.ELLIPSIS))
 
95
 
 
96
 
 
97
class TestTreeShape(tests.TestCaseInTempDir):
123
98
 
124
99
    def test_unicode_paths(self):
125
 
        self.requireFeature(tests.UnicodeFilename)
 
100
        self.requireFeature(features.UnicodeFilenameFeature)
126
101
 
127
102
        filename = u'hell\u00d8'
128
103
        self.build_tree_contents([(filename, 'contents of hello')])
129
 
        self.failUnlessExists(filename)
130
 
 
131
 
 
132
 
class TestTransportScenarios(TestCase):
 
104
        self.assertPathExists(filename)
 
105
 
 
106
 
 
107
class TestClassesAvailable(tests.TestCase):
 
108
    """As a convenience we expose Test* classes from bzrlib.tests"""
 
109
 
 
110
    def test_test_case(self):
 
111
        from bzrlib.tests import TestCase
 
112
 
 
113
    def test_test_loader(self):
 
114
        from bzrlib.tests import TestLoader
 
115
 
 
116
    def test_test_suite(self):
 
117
        from bzrlib.tests import TestSuite
 
118
 
 
119
 
 
120
class TestTransportScenarios(tests.TestCase):
133
121
    """A group of tests that test the transport implementation adaption core.
134
122
 
135
123
    This is a meta test that the tests are applied to all available
146
134
            def get_test_permutations(self):
147
135
                return sample_permutation
148
136
        sample_permutation = [(1,2), (3,4)]
149
 
        from bzrlib.tests.test_transport_implementations \
150
 
            import get_transport_test_permutations
 
137
        from bzrlib.tests.per_transport import get_transport_test_permutations
151
138
        self.assertEqual(sample_permutation,
152
139
                         get_transport_test_permutations(MockModule()))
153
140
 
154
 
    def test_scenarios_invlude_all_modules(self):
 
141
    def test_scenarios_include_all_modules(self):
155
142
        # this checks that the scenario generator returns as many permutations
156
143
        # as there are in all the registered transport modules - we assume if
157
144
        # this matches its probably doing the right thing especially in
158
145
        # combination with the tests for setting the right classes below.
159
 
        from bzrlib.tests.test_transport_implementations \
160
 
            import transport_test_permutations
 
146
        from bzrlib.tests.per_transport import transport_test_permutations
161
147
        from bzrlib.transport import _get_transport_modules
162
148
        modules = _get_transport_modules()
163
149
        permutation_count = 0
175
161
        # This test used to know about all the possible transports and the
176
162
        # order they were returned but that seems overly brittle (mbp
177
163
        # 20060307)
178
 
        from bzrlib.tests.test_transport_implementations \
179
 
            import transport_test_permutations
 
164
        from bzrlib.tests.per_transport import transport_test_permutations
180
165
        scenarios = transport_test_permutations()
181
166
        # there are at least that many builtin transports
182
167
        self.assertTrue(len(scenarios) > 6)
188
173
                                   bzrlib.transport.Server))
189
174
 
190
175
 
191
 
class TestBranchScenarios(TestCase):
 
176
class TestBranchScenarios(tests.TestCase):
192
177
 
193
178
    def test_scenarios(self):
194
179
        # check that constructor parameters are passed through to the adapted
195
180
        # test.
196
 
        from bzrlib.tests.branch_implementations import make_scenarios
 
181
        from bzrlib.tests.per_branch import make_scenarios
197
182
        server1 = "a"
198
183
        server2 = "b"
199
184
        formats = [("c", "C"), ("d", "D")]
213
198
            scenarios)
214
199
 
215
200
 
216
 
class TestBzrDirScenarios(TestCase):
 
201
class TestBzrDirScenarios(tests.TestCase):
217
202
 
218
203
    def test_scenarios(self):
219
204
        # check that constructor parameters are passed through to the adapted
220
205
        # test.
221
 
        from bzrlib.tests.bzrdir_implementations import make_scenarios
 
206
        from bzrlib.tests.per_controldir import make_scenarios
222
207
        vfs_factory = "v"
223
208
        server1 = "a"
224
209
        server2 = "b"
238
223
            scenarios)
239
224
 
240
225
 
241
 
class TestRepositoryScenarios(TestCase):
 
226
class TestRepositoryScenarios(tests.TestCase):
242
227
 
243
228
    def test_formats_to_scenarios(self):
244
229
        from bzrlib.tests.per_repository import formats_to_scenarios
245
230
        formats = [("(c)", remote.RemoteRepositoryFormat()),
246
231
                   ("(d)", repository.format_registry.get(
247
 
                        'Bazaar pack repository format 1 (needs bzr 0.92)\n'))]
 
232
                    'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
248
233
        no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
249
234
            None)
250
235
        vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
251
236
            vfs_transport_factory="vfs")
252
237
        # no_vfs generate scenarios without vfs_transport_factory
253
 
        self.assertEqual([
 
238
        expected = [
254
239
            ('RemoteRepositoryFormat(c)',
255
240
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
256
241
              'repository_format': remote.RemoteRepositoryFormat(),
257
242
              'transport_readonly_server': 'readonly',
258
243
              'transport_server': 'server'}),
259
 
            ('RepositoryFormatKnitPack1(d)',
 
244
            ('RepositoryFormat2a(d)',
260
245
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
261
 
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
 
246
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
262
247
              'transport_readonly_server': 'readonly',
263
 
              'transport_server': 'server'})],
264
 
            no_vfs_scenarios)
 
248
              'transport_server': 'server'})]
 
249
        self.assertEqual(expected, no_vfs_scenarios)
265
250
        self.assertEqual([
266
251
            ('RemoteRepositoryFormat(c)',
267
252
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
269
254
              'transport_readonly_server': 'readonly',
270
255
              'transport_server': 'server',
271
256
              'vfs_transport_factory': 'vfs'}),
272
 
            ('RepositoryFormatKnitPack1(d)',
 
257
            ('RepositoryFormat2a(d)',
273
258
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
274
 
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
 
259
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
275
260
              'transport_readonly_server': 'readonly',
276
261
              'transport_server': 'server',
277
262
              'vfs_transport_factory': 'vfs'})],
278
263
            vfs_scenarios)
279
264
 
280
265
 
281
 
class TestTestScenarioApplication(TestCase):
 
266
class TestTestScenarioApplication(tests.TestCase):
282
267
    """Tests for the test adaption facilities."""
283
268
 
284
269
    def test_apply_scenario(self):
314
299
            adapted_test2.id())
315
300
 
316
301
 
317
 
class TestInterRepositoryScenarios(TestCase):
 
302
class TestInterRepositoryScenarios(tests.TestCase):
318
303
 
319
304
    def test_scenarios(self):
320
305
        # check that constructor parameters are passed through to the adapted
321
306
        # test.
322
 
        from bzrlib.tests.interrepository_implementations import \
323
 
            make_scenarios
 
307
        from bzrlib.tests.per_interrepository import make_scenarios
324
308
        server1 = "a"
325
309
        server2 = "b"
326
 
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
 
310
        formats = [("C0", "C1", "C2", "C3"), ("D0", "D1", "D2", "D3")]
327
311
        scenarios = make_scenarios(server1, server2, formats)
328
312
        self.assertEqual([
329
 
            ('str,str,str',
330
 
             {'interrepo_class': str,
331
 
              'repository_format': 'C1',
 
313
            ('C0,str,str',
 
314
             {'repository_format': 'C1',
332
315
              'repository_format_to': 'C2',
333
316
              'transport_readonly_server': 'b',
334
 
              'transport_server': 'a'}),
335
 
            ('int,str,str',
336
 
             {'interrepo_class': int,
337
 
              'repository_format': 'D1',
 
317
              'transport_server': 'a',
 
318
              'extra_setup': 'C3'}),
 
319
            ('D0,str,str',
 
320
             {'repository_format': 'D1',
338
321
              'repository_format_to': 'D2',
339
322
              'transport_readonly_server': 'b',
340
 
              'transport_server': 'a'})],
 
323
              'transport_server': 'a',
 
324
              'extra_setup': 'D3'})],
341
325
            scenarios)
342
326
 
343
327
 
344
 
class TestWorkingTreeScenarios(TestCase):
 
328
class TestWorkingTreeScenarios(tests.TestCase):
345
329
 
346
330
    def test_scenarios(self):
347
331
        # check that constructor parameters are passed through to the adapted
348
332
        # test.
349
 
        from bzrlib.tests.workingtree_implementations \
350
 
            import make_scenarios
 
333
        from bzrlib.tests.per_workingtree import make_scenarios
351
334
        server1 = "a"
352
335
        server2 = "b"
353
 
        formats = [workingtree.WorkingTreeFormat2(),
354
 
                   workingtree.WorkingTreeFormat3(),]
 
336
        formats = [workingtree_4.WorkingTreeFormat4(),
 
337
                   workingtree_3.WorkingTreeFormat3(),]
355
338
        scenarios = make_scenarios(server1, server2, formats)
356
339
        self.assertEqual([
357
 
            ('WorkingTreeFormat2',
 
340
            ('WorkingTreeFormat4',
358
341
             {'bzrdir_format': formats[0]._matchingbzrdir,
359
342
              'transport_readonly_server': 'b',
360
343
              'transport_server': 'a',
367
350
            scenarios)
368
351
 
369
352
 
370
 
class TestTreeScenarios(TestCase):
 
353
class TestTreeScenarios(tests.TestCase):
371
354
 
372
355
    def test_scenarios(self):
373
356
        # the tree implementation scenario generator is meant to setup one
377
360
        # workingtree_to_test_tree attribute set to 'return_parameter' and the
378
361
        # revision one set to revision_tree_from_workingtree.
379
362
 
380
 
        from bzrlib.tests.tree_implementations import (
 
363
        from bzrlib.tests.per_tree import (
381
364
            _dirstate_tree_from_workingtree,
382
365
            make_scenarios,
383
366
            preview_tree_pre,
387
370
            )
388
371
        server1 = "a"
389
372
        server2 = "b"
390
 
        formats = [workingtree.WorkingTreeFormat2(),
391
 
                   workingtree.WorkingTreeFormat3(),]
 
373
        formats = [workingtree_4.WorkingTreeFormat4(),
 
374
                   workingtree_3.WorkingTreeFormat3(),]
392
375
        scenarios = make_scenarios(server1, server2, formats)
393
376
        self.assertEqual(7, len(scenarios))
394
 
        default_wt_format = workingtree.WorkingTreeFormat4._default_format
395
 
        wt4_format = workingtree.WorkingTreeFormat4()
396
 
        wt5_format = workingtree.WorkingTreeFormat5()
 
377
        default_wt_format = workingtree.format_registry.get_default()
 
378
        wt4_format = workingtree_4.WorkingTreeFormat4()
 
379
        wt5_format = workingtree_4.WorkingTreeFormat5()
397
380
        expected_scenarios = [
398
 
            ('WorkingTreeFormat2',
 
381
            ('WorkingTreeFormat4',
399
382
             {'bzrdir_format': formats[0]._matchingbzrdir,
400
383
              'transport_readonly_server': 'b',
401
384
              'transport_server': 'a',
446
429
        self.assertEqual(expected_scenarios, scenarios)
447
430
 
448
431
 
449
 
class TestInterTreeScenarios(TestCase):
 
432
class TestInterTreeScenarios(tests.TestCase):
450
433
    """A group of tests that test the InterTreeTestAdapter."""
451
434
 
452
435
    def test_scenarios(self):
459
442
        # unlike the TestProviderAdapter we dont want to automatically add a
460
443
        # parameterized one for WorkingTree - the optimisers will tell us what
461
444
        # ones to add.
462
 
        from bzrlib.tests.tree_implementations import (
 
445
        from bzrlib.tests.per_tree import (
463
446
            return_parameter,
464
 
            revision_tree_from_workingtree
465
447
            )
466
 
        from bzrlib.tests.intertree_implementations import (
 
448
        from bzrlib.tests.per_intertree import (
467
449
            make_scenarios,
468
450
            )
469
 
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
 
451
        from bzrlib.workingtree_3 import WorkingTreeFormat3
 
452
        from bzrlib.workingtree_4 import WorkingTreeFormat4
470
453
        input_test = TestInterTreeScenarios(
471
454
            "test_scenarios")
472
455
        server1 = "a"
473
456
        server2 = "b"
474
 
        format1 = WorkingTreeFormat2()
 
457
        format1 = WorkingTreeFormat4()
475
458
        format2 = WorkingTreeFormat3()
476
459
        formats = [("1", str, format1, format2, "converter1"),
477
460
            ("2", int, format2, format1, "converter2")]
502
485
        self.assertEqual(scenarios, expected_scenarios)
503
486
 
504
487
 
505
 
class TestTestCaseInTempDir(TestCaseInTempDir):
 
488
class TestTestCaseInTempDir(tests.TestCaseInTempDir):
506
489
 
507
490
    def test_home_is_not_working(self):
508
491
        self.assertNotEqual(self.test_dir, self.test_home_dir)
519
502
        self.assertEqualStat(real, fake)
520
503
 
521
504
    def test_assertEqualStat_notequal(self):
522
 
        self.build_tree(["foo", "bar"])
 
505
        self.build_tree(["foo", "longname"])
523
506
        self.assertRaises(AssertionError, self.assertEqualStat,
524
 
            os.lstat("foo"), os.lstat("bar"))
525
 
 
526
 
 
527
 
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
 
507
            os.lstat("foo"), os.lstat("longname"))
 
508
 
 
509
    def test_failUnlessExists(self):
 
510
        """Deprecated failUnlessExists and failIfExists"""
 
511
        self.applyDeprecated(
 
512
            deprecated_in((2, 4)),
 
513
            self.failUnlessExists, '.')
 
514
        self.build_tree(['foo/', 'foo/bar'])
 
515
        self.applyDeprecated(
 
516
            deprecated_in((2, 4)),
 
517
            self.failUnlessExists, 'foo/bar')
 
518
        self.applyDeprecated(
 
519
            deprecated_in((2, 4)),
 
520
            self.failIfExists, 'foo/foo')
 
521
 
 
522
    def test_assertPathExists(self):
 
523
        self.assertPathExists('.')
 
524
        self.build_tree(['foo/', 'foo/bar'])
 
525
        self.assertPathExists('foo/bar')
 
526
        self.assertPathDoesNotExist('foo/foo')
 
527
 
 
528
 
 
529
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
528
530
 
529
531
    def test_home_is_non_existant_dir_under_root(self):
530
532
        """The test_home_dir for TestCaseWithMemoryTransport is missing.
545
547
        cwd = osutils.getcwd()
546
548
        self.assertIsSameRealPath(self.test_dir, cwd)
547
549
 
 
550
    def test_BZR_HOME_and_HOME_are_bytestrings(self):
 
551
        """The $BZR_HOME and $HOME environment variables should not be unicode.
 
552
 
 
553
        See https://bugs.launchpad.net/bzr/+bug/464174
 
554
        """
 
555
        self.assertIsInstance(os.environ['BZR_HOME'], str)
 
556
        self.assertIsInstance(os.environ['HOME'], str)
 
557
 
548
558
    def test_make_branch_and_memory_tree(self):
549
559
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
550
560
 
554
564
        tree = self.make_branch_and_memory_tree('dir')
555
565
        # Guard against regression into MemoryTransport leaking
556
566
        # files to disk instead of keeping them in memory.
557
 
        self.failIf(osutils.lexists('dir'))
 
567
        self.assertFalse(osutils.lexists('dir'))
558
568
        self.assertIsInstance(tree, memorytree.MemoryTree)
559
569
 
560
570
    def test_make_branch_and_memory_tree_with_format(self):
561
571
        """make_branch_and_memory_tree should accept a format option."""
562
572
        format = bzrdir.BzrDirMetaFormat1()
563
 
        format.repository_format = weaverepo.RepositoryFormat7()
 
573
        format.repository_format = repository.format_registry.get_default()
564
574
        tree = self.make_branch_and_memory_tree('dir', format=format)
565
575
        # Guard against regression into MemoryTransport leaking
566
576
        # files to disk instead of keeping them in memory.
567
 
        self.failIf(osutils.lexists('dir'))
 
577
        self.assertFalse(osutils.lexists('dir'))
568
578
        self.assertIsInstance(tree, memorytree.MemoryTree)
569
579
        self.assertEqual(format.repository_format.__class__,
570
580
            tree.branch.repository._format.__class__)
574
584
        self.assertIsInstance(builder, branchbuilder.BranchBuilder)
575
585
        # Guard against regression into MemoryTransport leaking
576
586
        # files to disk instead of keeping them in memory.
577
 
        self.failIf(osutils.lexists('dir'))
 
587
        self.assertFalse(osutils.lexists('dir'))
578
588
 
579
589
    def test_make_branch_builder_with_format(self):
580
590
        # Use a repo layout that doesn't conform to a 'named' layout, to ensure
581
591
        # that the format objects are used.
582
592
        format = bzrdir.BzrDirMetaFormat1()
583
 
        repo_format = weaverepo.RepositoryFormat7()
 
593
        repo_format = repository.format_registry.get_default()
584
594
        format.repository_format = repo_format
585
595
        builder = self.make_branch_builder('dir', format=format)
586
596
        the_branch = builder.get_branch()
587
597
        # Guard against regression into MemoryTransport leaking
588
598
        # files to disk instead of keeping them in memory.
589
 
        self.failIf(osutils.lexists('dir'))
 
599
        self.assertFalse(osutils.lexists('dir'))
590
600
        self.assertEqual(format.repository_format.__class__,
591
601
                         the_branch.repository._format.__class__)
592
602
        self.assertEqual(repo_format.get_format_string(),
598
608
        the_branch = builder.get_branch()
599
609
        # Guard against regression into MemoryTransport leaking
600
610
        # files to disk instead of keeping them in memory.
601
 
        self.failIf(osutils.lexists('dir'))
 
611
        self.assertFalse(osutils.lexists('dir'))
602
612
        dir_format = bzrdir.format_registry.make_bzrdir('knit')
603
613
        self.assertEqual(dir_format.repository_format.__class__,
604
614
                         the_branch.repository._format.__class__)
606
616
                         self.get_transport().get_bytes(
607
617
                            'dir/.bzr/repository/format'))
608
618
 
609
 
    def test_safety_net(self):
610
 
        """No test should modify the safety .bzr directory.
611
 
 
612
 
        We just test that the _check_safety_net private method raises
613
 
        AssertionError, it's easier than building a test suite with the same
614
 
        test.
615
 
        """
616
 
        # Oops, a commit in the current directory (i.e. without local .bzr
617
 
        # directory) will crawl up the hierarchy to find a .bzr directory.
618
 
        self.run_bzr(['commit', '-mfoo', '--unchanged'])
619
 
        # But we have a safety net in place.
620
 
        self.assertRaises(AssertionError, self._check_safety_net)
621
 
 
622
 
 
623
 
class TestTestCaseWithTransport(TestCaseWithTransport):
 
619
    def test_dangling_locks_cause_failures(self):
 
620
        class TestDanglingLock(tests.TestCaseWithMemoryTransport):
 
621
            def test_function(self):
 
622
                t = self.get_transport_from_path('.')
 
623
                l = lockdir.LockDir(t, 'lock')
 
624
                l.create()
 
625
                l.attempt_lock()
 
626
        test = TestDanglingLock('test_function')
 
627
        result = test.run()
 
628
        total_failures = result.errors + result.failures
 
629
        if self._lock_check_thorough:
 
630
            self.assertEqual(1, len(total_failures))
 
631
        else:
 
632
            # When _lock_check_thorough is disabled, then we don't trigger a
 
633
            # failure
 
634
            self.assertEqual(0, len(total_failures))
 
635
 
 
636
 
 
637
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
624
638
    """Tests for the convenience functions TestCaseWithTransport introduces."""
625
639
 
626
640
    def test_get_readonly_url_none(self):
627
 
        from bzrlib.transport import get_transport
628
 
        from bzrlib.transport.memory import MemoryServer
629
641
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
630
 
        self.vfs_transport_factory = MemoryServer
 
642
        self.vfs_transport_factory = memory.MemoryServer
631
643
        self.transport_readonly_server = None
632
644
        # calling get_readonly_transport() constructs a decorator on the url
633
645
        # for the server
634
646
        url = self.get_readonly_url()
635
647
        url2 = self.get_readonly_url('foo/bar')
636
 
        t = get_transport(url)
637
 
        t2 = get_transport(url2)
638
 
        self.failUnless(isinstance(t, ReadonlyTransportDecorator))
639
 
        self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
 
648
        t = transport.get_transport_from_url(url)
 
649
        t2 = transport.get_transport_from_url(url2)
 
650
        self.assertIsInstance(t, ReadonlyTransportDecorator)
 
651
        self.assertIsInstance(t2, ReadonlyTransportDecorator)
640
652
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
641
653
 
642
654
    def test_get_readonly_url_http(self):
643
655
        from bzrlib.tests.http_server import HttpServer
644
 
        from bzrlib.transport import get_transport
645
 
        from bzrlib.transport.local import LocalURLServer
646
656
        from bzrlib.transport.http import HttpTransportBase
647
 
        self.transport_server = LocalURLServer
 
657
        self.transport_server = test_server.LocalURLServer
648
658
        self.transport_readonly_server = HttpServer
649
659
        # calling get_readonly_transport() gives us a HTTP server instance.
650
660
        url = self.get_readonly_url()
651
661
        url2 = self.get_readonly_url('foo/bar')
652
662
        # the transport returned may be any HttpTransportBase subclass
653
 
        t = get_transport(url)
654
 
        t2 = get_transport(url2)
655
 
        self.failUnless(isinstance(t, HttpTransportBase))
656
 
        self.failUnless(isinstance(t2, HttpTransportBase))
 
663
        t = transport.get_transport_from_url(url)
 
664
        t2 = transport.get_transport_from_url(url2)
 
665
        self.assertIsInstance(t, HttpTransportBase)
 
666
        self.assertIsInstance(t2, HttpTransportBase)
657
667
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
658
668
 
659
669
    def test_is_directory(self):
667
677
    def test_make_branch_builder(self):
668
678
        builder = self.make_branch_builder('dir')
669
679
        rev_id = builder.build_commit()
670
 
        self.failUnlessExists('dir')
 
680
        self.assertPathExists('dir')
671
681
        a_dir = bzrdir.BzrDir.open('dir')
672
682
        self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
673
683
        a_branch = a_dir.open_branch()
677
687
        self.assertEqual((1, rev_id), a_branch.last_revision_info())
678
688
 
679
689
 
680
 
class TestTestCaseTransports(TestCaseWithTransport):
 
690
class TestTestCaseTransports(tests.TestCaseWithTransport):
681
691
 
682
692
    def setUp(self):
683
693
        super(TestTestCaseTransports, self).setUp()
684
 
        self.vfs_transport_factory = MemoryServer
 
694
        self.vfs_transport_factory = memory.MemoryServer
685
695
 
686
696
    def test_make_bzrdir_preserves_transport(self):
687
697
        t = self.get_transport()
688
698
        result_bzrdir = self.make_bzrdir('subdir')
689
699
        self.assertIsInstance(result_bzrdir.transport,
690
 
                              MemoryTransport)
 
700
                              memory.MemoryTransport)
691
701
        # should not be on disk, should only be in memory
692
 
        self.failIfExists('subdir')
693
 
 
694
 
 
695
 
class TestChrootedTest(ChrootedTestCase):
 
702
        self.assertPathDoesNotExist('subdir')
 
703
 
 
704
 
 
705
class TestChrootedTest(tests.ChrootedTestCase):
696
706
 
697
707
    def test_root_is_root(self):
698
 
        from bzrlib.transport import get_transport
699
 
        t = get_transport(self.get_readonly_url())
 
708
        t = transport.get_transport_from_url(self.get_readonly_url())
700
709
        url = t.base
701
710
        self.assertEqual(url, t.clone('..').base)
702
711
 
703
712
 
704
 
class MockProgress(_BaseProgressBar):
705
 
    """Progress-bar standin that records calls.
706
 
 
707
 
    Useful for testing pb using code.
708
 
    """
709
 
 
710
 
    def __init__(self):
711
 
        _BaseProgressBar.__init__(self)
712
 
        self.calls = []
713
 
 
714
 
    def tick(self):
715
 
        self.calls.append(('tick',))
716
 
 
717
 
    def update(self, msg=None, current=None, total=None):
718
 
        self.calls.append(('update', msg, current, total))
719
 
 
720
 
    def clear(self):
721
 
        self.calls.append(('clear',))
722
 
 
723
 
    def note(self, msg, *args):
724
 
        self.calls.append(('note', msg, args))
725
 
 
726
 
 
727
 
class TestTestResult(TestCase):
 
713
class TestProfileResult(tests.TestCase):
 
714
 
 
715
    def test_profiles_tests(self):
 
716
        self.requireFeature(features.lsprof_feature)
 
717
        terminal = testtools.testresult.doubles.ExtendedTestResult()
 
718
        result = tests.ProfileResult(terminal)
 
719
        class Sample(tests.TestCase):
 
720
            def a(self):
 
721
                self.sample_function()
 
722
            def sample_function(self):
 
723
                pass
 
724
        test = Sample("a")
 
725
        test.run(result)
 
726
        case = terminal._events[0][1]
 
727
        self.assertLength(1, case._benchcalls)
 
728
        # We must be able to unpack it as the test reporting code wants
 
729
        (_, _, _), stats = case._benchcalls[0]
 
730
        self.assertTrue(callable(stats.pprint))
 
731
 
 
732
 
 
733
class TestTestResult(tests.TestCase):
728
734
 
729
735
    def check_timing(self, test_case, expected_re):
730
736
        result = bzrlib.tests.TextTestResult(self._log_file,
731
737
                descriptions=0,
732
738
                verbosity=1,
733
739
                )
734
 
        test_case.run(result)
735
 
        timed_string = result._testTimeString(test_case)
 
740
        capture = testtools.testresult.doubles.ExtendedTestResult()
 
741
        test_case.run(MultiTestResult(result, capture))
 
742
        run_case = capture._events[0][1]
 
743
        timed_string = result._testTimeString(run_case)
736
744
        self.assertContainsRe(timed_string, expected_re)
737
745
 
738
746
    def test_test_reporting(self):
739
 
        class ShortDelayTestCase(TestCase):
 
747
        class ShortDelayTestCase(tests.TestCase):
740
748
            def test_short_delay(self):
741
749
                time.sleep(0.003)
742
750
            def test_short_benchmark(self):
743
751
                self.time(time.sleep, 0.003)
744
752
        self.check_timing(ShortDelayTestCase('test_short_delay'),
745
753
                          r"^ +[0-9]+ms$")
746
 
        # if a benchmark time is given, we want a x of y style result.
 
754
        # if a benchmark time is given, we now show just that time followed by
 
755
        # a star
747
756
        self.check_timing(ShortDelayTestCase('test_short_benchmark'),
748
 
                          r"^ +[0-9]+ms/ +[0-9]+ms$")
 
757
                          r"^ +[0-9]+ms\*$")
749
758
 
750
759
    def test_unittest_reporting_unittest_class(self):
751
760
        # getting the time from a non-bzrlib test works ok
755
764
        self.check_timing(ShortDelayTestCase('test_short_delay'),
756
765
                          r"^ +[0-9]+ms$")
757
766
 
758
 
    def test_assigned_benchmark_file_stores_date(self):
759
 
        output = StringIO()
760
 
        result = bzrlib.tests.TextTestResult(self._log_file,
761
 
                                        descriptions=0,
762
 
                                        verbosity=1,
763
 
                                        bench_history=output
764
 
                                        )
765
 
        output_string = output.getvalue()
766
 
        # if you are wondering about the regexp please read the comment in
767
 
        # test_bench_history (bzrlib.tests.test_selftest.TestRunner)
768
 
        # XXX: what comment?  -- Andrew Bennetts
769
 
        self.assertContainsRe(output_string, "--date [0-9.]+")
770
 
 
771
 
    def test_benchhistory_records_test_times(self):
772
 
        result_stream = StringIO()
773
 
        result = bzrlib.tests.TextTestResult(
774
 
            self._log_file,
775
 
            descriptions=0,
776
 
            verbosity=1,
777
 
            bench_history=result_stream
778
 
            )
779
 
 
780
 
        # we want profile a call and check that its test duration is recorded
781
 
        # make a new test instance that when run will generate a benchmark
782
 
        example_test_case = TestTestResult("_time_hello_world_encoding")
783
 
        # execute the test, which should succeed and record times
784
 
        example_test_case.run(result)
785
 
        lines = result_stream.getvalue().splitlines()
786
 
        self.assertEqual(2, len(lines))
787
 
        self.assertContainsRe(lines[1],
788
 
            " *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
789
 
            "._time_hello_world_encoding")
790
 
 
791
767
    def _time_hello_world_encoding(self):
792
768
        """Profile two sleep calls
793
769
 
798
774
 
799
775
    def test_lsprofiling(self):
800
776
        """Verbose test result prints lsprof statistics from test cases."""
801
 
        self.requireFeature(test_lsprof.LSProfFeature)
 
777
        self.requireFeature(features.lsprof_feature)
802
778
        result_stream = StringIO()
803
779
        result = bzrlib.tests.VerboseTestResult(
804
 
            unittest._WritelnDecorator(result_stream),
 
780
            result_stream,
805
781
            descriptions=0,
806
782
            verbosity=2,
807
783
            )
833
809
        self.assertContainsRe(output,
834
810
            r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
835
811
 
 
812
    def test_uses_time_from_testtools(self):
 
813
        """Test case timings in verbose results should use testtools times"""
 
814
        import datetime
 
815
        class TimeAddedVerboseTestResult(tests.VerboseTestResult):
 
816
            def startTest(self, test):
 
817
                self.time(datetime.datetime.utcfromtimestamp(1.145))
 
818
                super(TimeAddedVerboseTestResult, self).startTest(test)
 
819
            def addSuccess(self, test):
 
820
                self.time(datetime.datetime.utcfromtimestamp(51.147))
 
821
                super(TimeAddedVerboseTestResult, self).addSuccess(test)
 
822
            def report_tests_starting(self): pass
 
823
        sio = StringIO()
 
824
        self.get_passing_test().run(TimeAddedVerboseTestResult(sio, 0, 2))
 
825
        self.assertEndsWith(sio.getvalue(), "OK    50002ms\n")
 
826
 
836
827
    def test_known_failure(self):
837
 
        """A KnownFailure being raised should trigger several result actions."""
838
 
        class InstrumentedTestResult(ExtendedTestResult):
839
 
 
840
 
            def report_test_start(self, test): pass
841
 
            def report_known_failure(self, test, err):
842
 
                self._call = test, err
 
828
        """Using knownFailure should trigger several result actions."""
 
829
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
830
            def stopTestRun(self): pass
 
831
            def report_tests_starting(self): pass
 
832
            def report_known_failure(self, test, err=None, details=None):
 
833
                self._call = test, 'known failure'
843
834
        result = InstrumentedTestResult(None, None, None, None)
844
 
        def test_function():
845
 
            raise KnownFailure('failed!')
846
 
        test = unittest.FunctionTestCase(test_function)
 
835
        class Test(tests.TestCase):
 
836
            def test_function(self):
 
837
                self.knownFailure('failed!')
 
838
        test = Test("test_function")
847
839
        test.run(result)
848
840
        # it should invoke 'report_known_failure'.
849
841
        self.assertEqual(2, len(result._call))
850
 
        self.assertEqual(test, result._call[0])
851
 
        self.assertEqual(KnownFailure, result._call[1][0])
852
 
        self.assertIsInstance(result._call[1][1], KnownFailure)
 
842
        self.assertEqual(test.id(), result._call[0].id())
 
843
        self.assertEqual('known failure', result._call[1])
853
844
        # we dont introspec the traceback, if the rest is ok, it would be
854
845
        # exceptional for it not to be.
855
846
        # it should update the known_failure_count on the object.
861
852
        # verbose test output formatting
862
853
        result_stream = StringIO()
863
854
        result = bzrlib.tests.VerboseTestResult(
864
 
            unittest._WritelnDecorator(result_stream),
 
855
            result_stream,
865
856
            descriptions=0,
866
857
            verbosity=2,
867
858
            )
868
 
        test = self.get_passing_test()
869
 
        result.startTest(test)
870
 
        prefix = len(result_stream.getvalue())
871
 
        # the err parameter has the shape:
872
 
        # (class, exception object, traceback)
873
 
        # KnownFailures dont get their tracebacks shown though, so we
874
 
        # can skip that.
875
 
        err = (KnownFailure, KnownFailure('foo'), None)
876
 
        result.report_known_failure(test, err)
877
 
        output = result_stream.getvalue()[prefix:]
878
 
        lines = output.splitlines()
879
 
        self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
880
 
        self.assertEqual(lines[1], '    foo')
881
 
        self.assertEqual(2, len(lines))
882
 
 
883
 
    def test_text_report_known_failure(self):
884
 
        # text test output formatting
885
 
        pb = MockProgress()
886
 
        result = bzrlib.tests.TextTestResult(
887
 
            None,
888
 
            descriptions=0,
889
 
            verbosity=1,
890
 
            pb=pb,
891
 
            )
892
 
        test = self.get_passing_test()
893
 
        # this seeds the state to handle reporting the test.
894
 
        result.startTest(test)
895
 
        # the err parameter has the shape:
896
 
        # (class, exception object, traceback)
897
 
        # KnownFailures dont get their tracebacks shown though, so we
898
 
        # can skip that.
899
 
        err = (KnownFailure, KnownFailure('foo'), None)
900
 
        result.report_known_failure(test, err)
901
 
        self.assertEqual(
902
 
            [
903
 
            ('update', '[1 in 0s] passing_test', None, None),
904
 
            ('note', 'XFAIL: %s\n%s\n', ('passing_test', err[1]))
905
 
            ],
906
 
            pb.calls)
907
 
        # known_failures should be printed in the summary, so if we run a test
908
 
        # after there are some known failures, the update prefix should match
909
 
        # this.
910
 
        result.known_failure_count = 3
911
 
        test.run(result)
912
 
        self.assertEqual(
913
 
            [
914
 
            ('update', '[2 in 0s] passing_test', None, None),
915
 
            ],
916
 
            pb.calls[2:])
 
859
        _get_test("test_xfail").run(result)
 
860
        self.assertContainsRe(result_stream.getvalue(),
 
861
            "\n\\S+\\.test_xfail\\s+XFAIL\\s+\\d+ms\n"
 
862
            "\\s*(?:Text attachment: )?reason"
 
863
            "(?:\n-+\n|: {{{)"
 
864
            "this_fails"
 
865
            "(?:\n-+\n|}}}\n)")
917
866
 
918
867
    def get_passing_test(self):
919
868
        """Return a test object that can't be run usefully."""
923
872
 
924
873
    def test_add_not_supported(self):
925
874
        """Test the behaviour of invoking addNotSupported."""
926
 
        class InstrumentedTestResult(ExtendedTestResult):
927
 
            def report_test_start(self, test): pass
 
875
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
876
            def stopTestRun(self): pass
 
877
            def report_tests_starting(self): pass
928
878
            def report_unsupported(self, test, feature):
929
879
                self._call = test, feature
930
880
        result = InstrumentedTestResult(None, None, None, None)
931
881
        test = SampleTestCase('_test_pass')
932
 
        feature = Feature()
 
882
        feature = features.Feature()
933
883
        result.startTest(test)
934
884
        result.addNotSupported(test, feature)
935
885
        # it should invoke 'report_unsupported'.
949
899
        # verbose test output formatting
950
900
        result_stream = StringIO()
951
901
        result = bzrlib.tests.VerboseTestResult(
952
 
            unittest._WritelnDecorator(result_stream),
 
902
            result_stream,
953
903
            descriptions=0,
954
904
            verbosity=2,
955
905
            )
956
906
        test = self.get_passing_test()
957
 
        feature = Feature()
 
907
        feature = features.Feature()
958
908
        result.startTest(test)
959
909
        prefix = len(result_stream.getvalue())
960
910
        result.report_unsupported(test, feature)
961
911
        output = result_stream.getvalue()[prefix:]
962
912
        lines = output.splitlines()
963
 
        self.assertEqual(lines, ['NODEP                   0ms', "    The feature 'Feature' is not available."])
964
 
 
965
 
    def test_text_report_unsupported(self):
966
 
        # text test output formatting
967
 
        pb = MockProgress()
968
 
        result = bzrlib.tests.TextTestResult(
969
 
            None,
970
 
            descriptions=0,
971
 
            verbosity=1,
972
 
            pb=pb,
973
 
            )
974
 
        test = self.get_passing_test()
975
 
        feature = Feature()
976
 
        # this seeds the state to handle reporting the test.
977
 
        result.startTest(test)
978
 
        result.report_unsupported(test, feature)
979
 
        # no output on unsupported features
980
 
        self.assertEqual(
981
 
            [('update', '[1 in 0s] passing_test', None, None)
982
 
            ],
983
 
            pb.calls)
984
 
        # the number of missing features should be printed in the progress
985
 
        # summary, so check for that.
986
 
        result.unsupported = {'foo':0, 'bar':0}
987
 
        test.run(result)
988
 
        self.assertEqual(
989
 
            [
990
 
            ('update', '[2 in 0s, 2 missing] passing_test', None, None),
991
 
            ],
992
 
            pb.calls[1:])
 
913
        # We don't check for the final '0ms' since it may fail on slow hosts
 
914
        self.assertStartsWith(lines[0], 'NODEP')
 
915
        self.assertEqual(lines[1],
 
916
                         "    The feature 'Feature' is not available.")
993
917
 
994
918
    def test_unavailable_exception(self):
995
919
        """An UnavailableFeature being raised should invoke addNotSupported."""
996
 
        class InstrumentedTestResult(ExtendedTestResult):
997
 
 
998
 
            def report_test_start(self, test): pass
 
920
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
921
            def stopTestRun(self): pass
 
922
            def report_tests_starting(self): pass
999
923
            def addNotSupported(self, test, feature):
1000
924
                self._call = test, feature
1001
925
        result = InstrumentedTestResult(None, None, None, None)
1002
 
        feature = Feature()
1003
 
        def test_function():
1004
 
            raise UnavailableFeature(feature)
1005
 
        test = unittest.FunctionTestCase(test_function)
 
926
        feature = features.Feature()
 
927
        class Test(tests.TestCase):
 
928
            def test_function(self):
 
929
                raise tests.UnavailableFeature(feature)
 
930
        test = Test("test_function")
1006
931
        test.run(result)
1007
932
        # it should invoke 'addNotSupported'.
1008
933
        self.assertEqual(2, len(result._call))
1009
 
        self.assertEqual(test, result._call[0])
 
934
        self.assertEqual(test.id(), result._call[0].id())
1010
935
        self.assertEqual(feature, result._call[1])
1011
936
        # and not count as an error
1012
937
        self.assertEqual(0, result.error_count)
1023
948
    def test_strict_with_known_failure(self):
1024
949
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
1025
950
                                             verbosity=1)
1026
 
        test = self.get_passing_test()
1027
 
        err = (KnownFailure, KnownFailure('foo'), None)
1028
 
        result._addKnownFailure(test, err)
 
951
        test = _get_test("test_xfail")
 
952
        test.run(result)
1029
953
        self.assertFalse(result.wasStrictlySuccessful())
1030
954
        self.assertEqual(None, result._extractBenchmarkTime(test))
1031
955
 
1037
961
        self.assertTrue(result.wasStrictlySuccessful())
1038
962
        self.assertEqual(None, result._extractBenchmarkTime(test))
1039
963
 
1040
 
 
1041
 
class TestUnicodeFilenameFeature(TestCase):
1042
 
 
1043
 
    def test_probe_passes(self):
1044
 
        """UnicodeFilenameFeature._probe passes."""
1045
 
        # We can't test much more than that because the behaviour depends
1046
 
        # on the platform.
1047
 
        tests.UnicodeFilenameFeature._probe()
1048
 
 
1049
 
 
1050
 
class TestRunner(TestCase):
 
964
    def test_startTests(self):
 
965
        """Starting the first test should trigger startTests."""
 
966
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
967
            calls = 0
 
968
            def startTests(self): self.calls += 1
 
969
        result = InstrumentedTestResult(None, None, None, None)
 
970
        def test_function():
 
971
            pass
 
972
        test = unittest.FunctionTestCase(test_function)
 
973
        test.run(result)
 
974
        self.assertEquals(1, result.calls)
 
975
 
 
976
    def test_startTests_only_once(self):
 
977
        """With multiple tests startTests should still only be called once"""
 
978
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
979
            calls = 0
 
980
            def startTests(self): self.calls += 1
 
981
        result = InstrumentedTestResult(None, None, None, None)
 
982
        suite = unittest.TestSuite([
 
983
            unittest.FunctionTestCase(lambda: None),
 
984
            unittest.FunctionTestCase(lambda: None)])
 
985
        suite.run(result)
 
986
        self.assertEquals(1, result.calls)
 
987
        self.assertEquals(2, result.count)
 
988
 
 
989
 
 
990
class TestRunner(tests.TestCase):
1051
991
 
1052
992
    def dummy_test(self):
1053
993
        pass
1058
998
        This current saves and restores:
1059
999
        TestCaseInTempDir.TEST_ROOT
1060
1000
 
1061
 
        There should be no tests in this file that use bzrlib.tests.TextTestRunner
1062
 
        without using this convenience method, because of our use of global state.
 
1001
        There should be no tests in this file that use
 
1002
        bzrlib.tests.TextTestRunner without using this convenience method,
 
1003
        because of our use of global state.
1063
1004
        """
1064
 
        old_root = TestCaseInTempDir.TEST_ROOT
 
1005
        old_root = tests.TestCaseInTempDir.TEST_ROOT
1065
1006
        try:
1066
 
            TestCaseInTempDir.TEST_ROOT = None
 
1007
            tests.TestCaseInTempDir.TEST_ROOT = None
1067
1008
            return testrunner.run(test)
1068
1009
        finally:
1069
 
            TestCaseInTempDir.TEST_ROOT = old_root
 
1010
            tests.TestCaseInTempDir.TEST_ROOT = old_root
1070
1011
 
1071
1012
    def test_known_failure_failed_run(self):
1072
1013
        # run a test that generates a known failure which should be printed in
1073
1014
        # the final output when real failures occur.
1074
 
        def known_failure_test():
1075
 
            raise KnownFailure('failed')
 
1015
        class Test(tests.TestCase):
 
1016
            def known_failure_test(self):
 
1017
                self.expectFailure('failed', self.assertTrue, False)
1076
1018
        test = unittest.TestSuite()
1077
 
        test.addTest(unittest.FunctionTestCase(known_failure_test))
 
1019
        test.addTest(Test("known_failure_test"))
1078
1020
        def failing_test():
1079
1021
            raise AssertionError('foo')
1080
1022
        test.addTest(unittest.FunctionTestCase(failing_test))
1081
1023
        stream = StringIO()
1082
 
        runner = TextTestRunner(stream=stream)
 
1024
        runner = tests.TextTestRunner(stream=stream)
1083
1025
        result = self.run_test_runner(runner, test)
1084
1026
        lines = stream.getvalue().splitlines()
1085
 
        self.assertEqual([
1086
 
            '',
1087
 
            '======================================================================',
1088
 
            'FAIL: unittest.FunctionTestCase (failing_test)',
1089
 
            '----------------------------------------------------------------------',
1090
 
            'Traceback (most recent call last):',
1091
 
            '    raise AssertionError(\'foo\')',
1092
 
            'AssertionError: foo',
1093
 
            '',
1094
 
            '----------------------------------------------------------------------',
1095
 
            '',
1096
 
            'FAILED (failures=1, known_failure_count=1)'],
1097
 
            lines[0:5] + lines[6:10] + lines[11:])
 
1027
        self.assertContainsRe(stream.getvalue(),
 
1028
            '(?sm)^bzr selftest.*$'
 
1029
            '.*'
 
1030
            '^======================================================================\n'
 
1031
            '^FAIL: failing_test\n'
 
1032
            '^----------------------------------------------------------------------\n'
 
1033
            'Traceback \\(most recent call last\\):\n'
 
1034
            '  .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
 
1035
            '    raise AssertionError\\(\'foo\'\\)\n'
 
1036
            '.*'
 
1037
            '^----------------------------------------------------------------------\n'
 
1038
            '.*'
 
1039
            'FAILED \\(failures=1, known_failure_count=1\\)'
 
1040
            )
1098
1041
 
1099
1042
    def test_known_failure_ok_run(self):
1100
 
        # run a test that generates a known failure which should be printed in the final output.
1101
 
        def known_failure_test():
1102
 
            raise KnownFailure('failed')
1103
 
        test = unittest.FunctionTestCase(known_failure_test)
 
1043
        # run a test that generates a known failure which should be printed in
 
1044
        # the final output.
 
1045
        class Test(tests.TestCase):
 
1046
            def known_failure_test(self):
 
1047
                self.knownFailure("Never works...")
 
1048
        test = Test("known_failure_test")
1104
1049
        stream = StringIO()
1105
 
        runner = TextTestRunner(stream=stream)
 
1050
        runner = tests.TextTestRunner(stream=stream)
1106
1051
        result = self.run_test_runner(runner, test)
1107
1052
        self.assertContainsRe(stream.getvalue(),
1108
1053
            '\n'
1111
1056
            '\n'
1112
1057
            'OK \\(known_failures=1\\)\n')
1113
1058
 
 
1059
    def test_unexpected_success_bad(self):
 
1060
        class Test(tests.TestCase):
 
1061
            def test_truth(self):
 
1062
                self.expectFailure("No absolute truth", self.assertTrue, True)
 
1063
        runner = tests.TextTestRunner(stream=StringIO())
 
1064
        result = self.run_test_runner(runner, Test("test_truth"))
 
1065
        if testtools_version[:3] <= (0, 9, 11):
 
1066
            self.assertContainsRe(runner.stream.getvalue(),
 
1067
                "=+\n"
 
1068
                "FAIL: \\S+\.test_truth\n"
 
1069
                "-+\n"
 
1070
                "(?:.*\n)*"
 
1071
                "No absolute truth\n"
 
1072
                "(?:.*\n)*"
 
1073
                "-+\n"
 
1074
                "Ran 1 test in .*\n"
 
1075
                "\n"
 
1076
                "FAILED \\(failures=1\\)\n\\Z")
 
1077
        else:
 
1078
            self.assertContainsRe(runner.stream.getvalue(),
 
1079
                "=+\n"
 
1080
                "FAIL: \\S+\.test_truth\n"
 
1081
                "-+\n"
 
1082
                "Empty attachments:\n"
 
1083
                "  log\n"
 
1084
                "\n"
 
1085
                "reason: {{{No absolute truth}}}\n"
 
1086
                "-+\n"
 
1087
                "Ran 1 test in .*\n"
 
1088
                "\n"
 
1089
                "FAILED \\(failures=1\\)\n\\Z")
 
1090
 
 
1091
    def test_result_decorator(self):
 
1092
        # decorate results
 
1093
        calls = []
 
1094
        class LoggingDecorator(ExtendedToOriginalDecorator):
 
1095
            def startTest(self, test):
 
1096
                ExtendedToOriginalDecorator.startTest(self, test)
 
1097
                calls.append('start')
 
1098
        test = unittest.FunctionTestCase(lambda:None)
 
1099
        stream = StringIO()
 
1100
        runner = tests.TextTestRunner(stream=stream,
 
1101
            result_decorators=[LoggingDecorator])
 
1102
        result = self.run_test_runner(runner, test)
 
1103
        self.assertLength(1, calls)
 
1104
 
1114
1105
    def test_skipped_test(self):
1115
1106
        # run a test that is skipped, and check the suite as a whole still
1116
1107
        # succeeds.
1117
1108
        # skipping_test must be hidden in here so it's not run as a real test
1118
 
        class SkippingTest(TestCase):
 
1109
        class SkippingTest(tests.TestCase):
1119
1110
            def skipping_test(self):
1120
 
                raise TestSkipped('test intentionally skipped')
1121
 
        runner = TextTestRunner(stream=self._log_file)
 
1111
                raise tests.TestSkipped('test intentionally skipped')
 
1112
        runner = tests.TextTestRunner(stream=self._log_file)
1122
1113
        test = SkippingTest("skipping_test")
1123
1114
        result = self.run_test_runner(runner, test)
1124
1115
        self.assertTrue(result.wasSuccessful())
1125
1116
 
1126
1117
    def test_skipped_from_setup(self):
1127
1118
        calls = []
1128
 
        class SkippedSetupTest(TestCase):
 
1119
        class SkippedSetupTest(tests.TestCase):
1129
1120
 
1130
1121
            def setUp(self):
1131
1122
                calls.append('setUp')
1132
1123
                self.addCleanup(self.cleanup)
1133
 
                raise TestSkipped('skipped setup')
 
1124
                raise tests.TestSkipped('skipped setup')
1134
1125
 
1135
1126
            def test_skip(self):
1136
1127
                self.fail('test reached')
1138
1129
            def cleanup(self):
1139
1130
                calls.append('cleanup')
1140
1131
 
1141
 
        runner = TextTestRunner(stream=self._log_file)
 
1132
        runner = tests.TextTestRunner(stream=self._log_file)
1142
1133
        test = SkippedSetupTest('test_skip')
1143
1134
        result = self.run_test_runner(runner, test)
1144
1135
        self.assertTrue(result.wasSuccessful())
1147
1138
 
1148
1139
    def test_skipped_from_test(self):
1149
1140
        calls = []
1150
 
        class SkippedTest(TestCase):
 
1141
        class SkippedTest(tests.TestCase):
1151
1142
 
1152
1143
            def setUp(self):
1153
 
                TestCase.setUp(self)
 
1144
                tests.TestCase.setUp(self)
1154
1145
                calls.append('setUp')
1155
1146
                self.addCleanup(self.cleanup)
1156
1147
 
1157
1148
            def test_skip(self):
1158
 
                raise TestSkipped('skipped test')
 
1149
                raise tests.TestSkipped('skipped test')
1159
1150
 
1160
1151
            def cleanup(self):
1161
1152
                calls.append('cleanup')
1162
1153
 
1163
 
        runner = TextTestRunner(stream=self._log_file)
 
1154
        runner = tests.TextTestRunner(stream=self._log_file)
1164
1155
        test = SkippedTest('test_skip')
1165
1156
        result = self.run_test_runner(runner, test)
1166
1157
        self.assertTrue(result.wasSuccessful())
1169
1160
 
1170
1161
    def test_not_applicable(self):
1171
1162
        # run a test that is skipped because it's not applicable
1172
 
        def not_applicable_test():
1173
 
            from bzrlib.tests import TestNotApplicable
1174
 
            raise TestNotApplicable('this test never runs')
 
1163
        class Test(tests.TestCase):
 
1164
            def not_applicable_test(self):
 
1165
                raise tests.TestNotApplicable('this test never runs')
1175
1166
        out = StringIO()
1176
 
        runner = TextTestRunner(stream=out, verbosity=2)
1177
 
        test = unittest.FunctionTestCase(not_applicable_test)
 
1167
        runner = tests.TextTestRunner(stream=out, verbosity=2)
 
1168
        test = Test("not_applicable_test")
1178
1169
        result = self.run_test_runner(runner, test)
1179
1170
        self._log_file.write(out.getvalue())
1180
1171
        self.assertTrue(result.wasSuccessful())
1184
1175
        self.assertContainsRe(out.getvalue(),
1185
1176
                r'(?m)^    this test never runs')
1186
1177
 
1187
 
    def test_not_applicable_demo(self):
1188
 
        # just so you can see it in the test output
1189
 
        raise TestNotApplicable('this test is just a demonstation')
1190
 
 
1191
1178
    def test_unsupported_features_listed(self):
1192
1179
        """When unsupported features are encountered they are detailed."""
1193
 
        class Feature1(Feature):
 
1180
        class Feature1(features.Feature):
1194
1181
            def _probe(self): return False
1195
 
        class Feature2(Feature):
 
1182
        class Feature2(features.Feature):
1196
1183
            def _probe(self): return False
1197
1184
        # create sample tests
1198
1185
        test1 = SampleTestCase('_test_pass')
1203
1190
        test.addTest(test1)
1204
1191
        test.addTest(test2)
1205
1192
        stream = StringIO()
1206
 
        runner = TextTestRunner(stream=stream)
 
1193
        runner = tests.TextTestRunner(stream=stream)
1207
1194
        result = self.run_test_runner(runner, test)
1208
1195
        lines = stream.getvalue().splitlines()
1209
1196
        self.assertEqual([
1213
1200
            ],
1214
1201
            lines[-3:])
1215
1202
 
1216
 
    def test_bench_history(self):
1217
 
        # tests that the running the benchmark produces a history file
1218
 
        # containing a timestamp and the revision id of the bzrlib source which
1219
 
        # was tested.
1220
 
        workingtree = _get_bzr_source_tree()
1221
 
        test = TestRunner('dummy_test')
1222
 
        output = StringIO()
1223
 
        runner = TextTestRunner(stream=self._log_file, bench_history=output)
1224
 
        result = self.run_test_runner(runner, test)
1225
 
        output_string = output.getvalue()
1226
 
        self.assertContainsRe(output_string, "--date [0-9.]+")
1227
 
        if workingtree is not None:
1228
 
            revision_id = workingtree.get_parent_ids()[0]
1229
 
            self.assertEndsWith(output_string.rstrip(), revision_id)
1230
 
 
1231
 
    def assertLogDeleted(self, test):
1232
 
        log = test._get_log()
1233
 
        self.assertEqual("DELETED log file to reduce memory footprint", log)
1234
 
        self.assertEqual('', test._log_contents)
1235
 
        self.assertIs(None, test._log_file_name)
1236
 
 
1237
 
    def test_success_log_deleted(self):
1238
 
        """Successful tests have their log deleted"""
1239
 
 
1240
 
        class LogTester(TestCase):
1241
 
 
1242
 
            def test_success(self):
1243
 
                self.log('this will be removed\n')
1244
 
 
1245
 
        sio = cStringIO.StringIO()
1246
 
        runner = TextTestRunner(stream=sio)
1247
 
        test = LogTester('test_success')
1248
 
        result = self.run_test_runner(runner, test)
1249
 
 
1250
 
        self.assertLogDeleted(test)
1251
 
 
1252
 
    def test_skipped_log_deleted(self):
1253
 
        """Skipped tests have their log deleted"""
1254
 
 
1255
 
        class LogTester(TestCase):
1256
 
 
1257
 
            def test_skipped(self):
1258
 
                self.log('this will be removed\n')
1259
 
                raise tests.TestSkipped()
1260
 
 
1261
 
        sio = cStringIO.StringIO()
1262
 
        runner = TextTestRunner(stream=sio)
1263
 
        test = LogTester('test_skipped')
1264
 
        result = self.run_test_runner(runner, test)
1265
 
 
1266
 
        self.assertLogDeleted(test)
1267
 
 
1268
 
    def test_not_aplicable_log_deleted(self):
1269
 
        """Not applicable tests have their log deleted"""
1270
 
 
1271
 
        class LogTester(TestCase):
1272
 
 
1273
 
            def test_not_applicable(self):
1274
 
                self.log('this will be removed\n')
1275
 
                raise tests.TestNotApplicable()
1276
 
 
1277
 
        sio = cStringIO.StringIO()
1278
 
        runner = TextTestRunner(stream=sio)
1279
 
        test = LogTester('test_not_applicable')
1280
 
        result = self.run_test_runner(runner, test)
1281
 
 
1282
 
        self.assertLogDeleted(test)
1283
 
 
1284
 
    def test_known_failure_log_deleted(self):
1285
 
        """Know failure tests have their log deleted"""
1286
 
 
1287
 
        class LogTester(TestCase):
1288
 
 
1289
 
            def test_known_failure(self):
1290
 
                self.log('this will be removed\n')
1291
 
                raise tests.KnownFailure()
1292
 
 
1293
 
        sio = cStringIO.StringIO()
1294
 
        runner = TextTestRunner(stream=sio)
1295
 
        test = LogTester('test_known_failure')
1296
 
        result = self.run_test_runner(runner, test)
1297
 
 
1298
 
        self.assertLogDeleted(test)
1299
 
 
1300
 
    def test_fail_log_kept(self):
1301
 
        """Failed tests have their log kept"""
1302
 
 
1303
 
        class LogTester(TestCase):
1304
 
 
1305
 
            def test_fail(self):
1306
 
                self.log('this will be kept\n')
1307
 
                self.fail('this test fails')
1308
 
 
1309
 
        sio = cStringIO.StringIO()
1310
 
        runner = TextTestRunner(stream=sio)
1311
 
        test = LogTester('test_fail')
1312
 
        result = self.run_test_runner(runner, test)
1313
 
 
1314
 
        text = sio.getvalue()
1315
 
        self.assertContainsRe(text, 'this will be kept')
1316
 
        self.assertContainsRe(text, 'this test fails')
1317
 
 
1318
 
        log = test._get_log()
1319
 
        self.assertContainsRe(log, 'this will be kept')
1320
 
        self.assertEqual(log, test._log_contents)
1321
 
 
1322
 
    def test_error_log_kept(self):
1323
 
        """Tests with errors have their log kept"""
1324
 
 
1325
 
        class LogTester(TestCase):
1326
 
 
1327
 
            def test_error(self):
1328
 
                self.log('this will be kept\n')
1329
 
                raise ValueError('random exception raised')
1330
 
 
1331
 
        sio = cStringIO.StringIO()
1332
 
        runner = TextTestRunner(stream=sio)
1333
 
        test = LogTester('test_error')
1334
 
        result = self.run_test_runner(runner, test)
1335
 
 
1336
 
        text = sio.getvalue()
1337
 
        self.assertContainsRe(text, 'this will be kept')
1338
 
        self.assertContainsRe(text, 'random exception raised')
1339
 
 
1340
 
        log = test._get_log()
1341
 
        self.assertContainsRe(log, 'this will be kept')
1342
 
        self.assertEqual(log, test._log_contents)
1343
 
 
1344
 
 
1345
 
class SampleTestCase(TestCase):
 
1203
    def test_verbose_test_count(self):
 
1204
        """A verbose test run reports the right test count at the start"""
 
1205
        suite = TestUtil.TestSuite([
 
1206
            unittest.FunctionTestCase(lambda:None),
 
1207
            unittest.FunctionTestCase(lambda:None)])
 
1208
        self.assertEqual(suite.countTestCases(), 2)
 
1209
        stream = StringIO()
 
1210
        runner = tests.TextTestRunner(stream=stream, verbosity=2)
 
1211
        # Need to use the CountingDecorator as that's what sets num_tests
 
1212
        result = self.run_test_runner(runner, tests.CountingDecorator(suite))
 
1213
        self.assertStartsWith(stream.getvalue(), "running 2 tests")
 
1214
 
 
1215
    def test_startTestRun(self):
 
1216
        """run should call result.startTestRun()"""
 
1217
        calls = []
 
1218
        class LoggingDecorator(ExtendedToOriginalDecorator):
 
1219
            def startTestRun(self):
 
1220
                ExtendedToOriginalDecorator.startTestRun(self)
 
1221
                calls.append('startTestRun')
 
1222
        test = unittest.FunctionTestCase(lambda:None)
 
1223
        stream = StringIO()
 
1224
        runner = tests.TextTestRunner(stream=stream,
 
1225
            result_decorators=[LoggingDecorator])
 
1226
        result = self.run_test_runner(runner, test)
 
1227
        self.assertLength(1, calls)
 
1228
 
 
1229
    def test_stopTestRun(self):
 
1230
        """run should call result.stopTestRun()"""
 
1231
        calls = []
 
1232
        class LoggingDecorator(ExtendedToOriginalDecorator):
 
1233
            def stopTestRun(self):
 
1234
                ExtendedToOriginalDecorator.stopTestRun(self)
 
1235
                calls.append('stopTestRun')
 
1236
        test = unittest.FunctionTestCase(lambda:None)
 
1237
        stream = StringIO()
 
1238
        runner = tests.TextTestRunner(stream=stream,
 
1239
            result_decorators=[LoggingDecorator])
 
1240
        result = self.run_test_runner(runner, test)
 
1241
        self.assertLength(1, calls)
 
1242
 
 
1243
    def test_unicode_test_output_on_ascii_stream(self):
 
1244
        """Showing results should always succeed even on an ascii console"""
 
1245
        class FailureWithUnicode(tests.TestCase):
 
1246
            def test_log_unicode(self):
 
1247
                self.log(u"\u2606")
 
1248
                self.fail("Now print that log!")
 
1249
        out = StringIO()
 
1250
        self.overrideAttr(osutils, "get_terminal_encoding",
 
1251
            lambda trace=False: "ascii")
 
1252
        result = self.run_test_runner(tests.TextTestRunner(stream=out),
 
1253
            FailureWithUnicode("test_log_unicode"))
 
1254
        if testtools_version[:3] > (0, 9, 11):
 
1255
            self.assertContainsRe(out.getvalue(), "log: {{{\d+\.\d+  \\\\u2606}}}")
 
1256
        else:
 
1257
            self.assertContainsRe(out.getvalue(),
 
1258
                "Text attachment: log\n"
 
1259
                "-+\n"
 
1260
                "\d+\.\d+  \\\\u2606\n"
 
1261
                "-+\n")
 
1262
 
 
1263
 
 
1264
class SampleTestCase(tests.TestCase):
1346
1265
 
1347
1266
    def _test_pass(self):
1348
1267
        pass
1350
1269
class _TestException(Exception):
1351
1270
    pass
1352
1271
 
1353
 
class TestTestCase(TestCase):
 
1272
 
 
1273
class TestTestCase(tests.TestCase):
1354
1274
    """Tests that test the core bzrlib TestCase."""
1355
1275
 
1356
1276
    def test_assertLength_matches_empty(self):
1373
1293
            exception.args[0])
1374
1294
 
1375
1295
    def test_base_setUp_not_called_causes_failure(self):
1376
 
        class TestCaseWithBrokenSetUp(TestCase):
 
1296
        class TestCaseWithBrokenSetUp(tests.TestCase):
1377
1297
            def setUp(self):
1378
1298
                pass # does not call TestCase.setUp
1379
1299
            def test_foo(self):
1385
1305
        self.assertEqual(1, result.testsRun)
1386
1306
 
1387
1307
    def test_base_tearDown_not_called_causes_failure(self):
1388
 
        class TestCaseWithBrokenTearDown(TestCase):
 
1308
        class TestCaseWithBrokenTearDown(tests.TestCase):
1389
1309
            def tearDown(self):
1390
1310
                pass # does not call TestCase.tearDown
1391
1311
            def test_foo(self):
1399
1319
    def test_debug_flags_sanitised(self):
1400
1320
        """The bzrlib debug flags should be sanitised by setUp."""
1401
1321
        if 'allow_debug' in tests.selftest_debug_flags:
1402
 
            raise TestNotApplicable(
 
1322
            raise tests.TestNotApplicable(
1403
1323
                '-Eallow_debug option prevents debug flag sanitisation')
1404
1324
        # we could set something and run a test that will check
1405
1325
        # it gets santised, but this is probably sufficient for now:
1406
1326
        # if someone runs the test with -Dsomething it will error.
1407
 
        self.assertEqual(set(), bzrlib.debug.debug_flags)
 
1327
        flags = set()
 
1328
        if self._lock_check_thorough:
 
1329
            flags.add('strict_locks')
 
1330
        self.assertEqual(flags, bzrlib.debug.debug_flags)
1408
1331
 
1409
1332
    def change_selftest_debug_flags(self, new_flags):
1410
 
        orig_selftest_flags = tests.selftest_debug_flags
1411
 
        self.addCleanup(self._restore_selftest_debug_flags, orig_selftest_flags)
1412
 
        tests.selftest_debug_flags = set(new_flags)
1413
 
 
1414
 
    def _restore_selftest_debug_flags(self, flags):
1415
 
        tests.selftest_debug_flags = flags
 
1333
        self.overrideAttr(tests, 'selftest_debug_flags', set(new_flags))
1416
1334
 
1417
1335
    def test_allow_debug_flag(self):
1418
1336
        """The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1420
1338
        """
1421
1339
        self.change_selftest_debug_flags(set(['allow_debug']))
1422
1340
        bzrlib.debug.debug_flags = set(['a-flag'])
1423
 
        class TestThatRecordsFlags(TestCase):
1424
 
            def test_foo(nested_self):
1425
 
                self.flags = set(bzrlib.debug.debug_flags)
1426
 
        test = TestThatRecordsFlags('test_foo')
1427
 
        test.run(self.make_test_result())
1428
 
        self.assertEqual(set(['a-flag']), self.flags)
 
1341
        class TestThatRecordsFlags(tests.TestCase):
 
1342
            def test_foo(nested_self):
 
1343
                self.flags = set(bzrlib.debug.debug_flags)
 
1344
        test = TestThatRecordsFlags('test_foo')
 
1345
        test.run(self.make_test_result())
 
1346
        flags = set(['a-flag'])
 
1347
        if 'disable_lock_checks' not in tests.selftest_debug_flags:
 
1348
            flags.add('strict_locks')
 
1349
        self.assertEqual(flags, self.flags)
 
1350
 
 
1351
    def test_disable_lock_checks(self):
 
1352
        """The -Edisable_lock_checks flag disables thorough checks."""
 
1353
        class TestThatRecordsFlags(tests.TestCase):
 
1354
            def test_foo(nested_self):
 
1355
                self.flags = set(bzrlib.debug.debug_flags)
 
1356
                self.test_lock_check_thorough = nested_self._lock_check_thorough
 
1357
        self.change_selftest_debug_flags(set())
 
1358
        test = TestThatRecordsFlags('test_foo')
 
1359
        test.run(self.make_test_result())
 
1360
        # By default we do strict lock checking and thorough lock/unlock
 
1361
        # tracking.
 
1362
        self.assertTrue(self.test_lock_check_thorough)
 
1363
        self.assertEqual(set(['strict_locks']), self.flags)
 
1364
        # Now set the disable_lock_checks flag, and show that this changed.
 
1365
        self.change_selftest_debug_flags(set(['disable_lock_checks']))
 
1366
        test = TestThatRecordsFlags('test_foo')
 
1367
        test.run(self.make_test_result())
 
1368
        self.assertFalse(self.test_lock_check_thorough)
 
1369
        self.assertEqual(set(), self.flags)
 
1370
 
 
1371
    def test_this_fails_strict_lock_check(self):
 
1372
        class TestThatRecordsFlags(tests.TestCase):
 
1373
            def test_foo(nested_self):
 
1374
                self.flags1 = set(bzrlib.debug.debug_flags)
 
1375
                self.thisFailsStrictLockCheck()
 
1376
                self.flags2 = set(bzrlib.debug.debug_flags)
 
1377
        # Make sure lock checking is active
 
1378
        self.change_selftest_debug_flags(set())
 
1379
        test = TestThatRecordsFlags('test_foo')
 
1380
        test.run(self.make_test_result())
 
1381
        self.assertEqual(set(['strict_locks']), self.flags1)
 
1382
        self.assertEqual(set(), self.flags2)
1429
1383
 
1430
1384
    def test_debug_flags_restored(self):
1431
1385
        """The bzrlib debug flags should be restored to their original state
1434
1388
        self.change_selftest_debug_flags(set(['allow_debug']))
1435
1389
        # Now run a test that modifies debug.debug_flags.
1436
1390
        bzrlib.debug.debug_flags = set(['original-state'])
1437
 
        class TestThatModifiesFlags(TestCase):
 
1391
        class TestThatModifiesFlags(tests.TestCase):
1438
1392
            def test_foo(self):
1439
1393
                bzrlib.debug.debug_flags = set(['modified'])
1440
1394
        test = TestThatModifiesFlags('test_foo')
1442
1396
        self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1443
1397
 
1444
1398
    def make_test_result(self):
1445
 
        return bzrlib.tests.TextTestResult(
1446
 
            self._log_file, descriptions=0, verbosity=1)
 
1399
        """Get a test result that writes to the test log file."""
 
1400
        return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
1447
1401
 
1448
1402
    def inner_test(self):
1449
1403
        # the inner child test
1456
1410
        result = self.make_test_result()
1457
1411
        self.inner_test.run(result)
1458
1412
        note("outer finish")
 
1413
        self.addCleanup(osutils.delete_any, self._log_file_name)
1459
1414
 
1460
1415
    def test_trace_nesting(self):
1461
1416
        # this tests that each test case nests its trace facility correctly.
1485
1440
        sample_test = TestTestCase("method_that_times_a_bit_twice")
1486
1441
        output_stream = StringIO()
1487
1442
        result = bzrlib.tests.VerboseTestResult(
1488
 
            unittest._WritelnDecorator(output_stream),
 
1443
            output_stream,
1489
1444
            descriptions=0,
1490
 
            verbosity=2,
1491
 
            num_tests=sample_test.countTestCases())
 
1445
            verbosity=2)
1492
1446
        sample_test.run(result)
1493
1447
        self.assertContainsRe(
1494
1448
            output_stream.getvalue(),
1495
 
            r"\d+ms/ +\d+ms\n$")
 
1449
            r"\d+ms\*\n$")
1496
1450
 
1497
1451
    def test_hooks_sanitised(self):
1498
1452
        """The bzrlib hooks should be sanitised by setUp."""
1499
1453
        # Note this test won't fail with hooks that the core library doesn't
1500
1454
        # use - but it trigger with a plugin that adds hooks, so its still a
1501
1455
        # useful warning in that case.
1502
 
        self.assertEqual(bzrlib.branch.BranchHooks(),
1503
 
            bzrlib.branch.Branch.hooks)
1504
 
        self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
 
1456
        self.assertEqual(bzrlib.branch.BranchHooks(), bzrlib.branch.Branch.hooks)
 
1457
        self.assertEqual(
 
1458
            bzrlib.smart.server.SmartServerHooks(),
1505
1459
            bzrlib.smart.server.SmartTCPServer.hooks)
1506
 
        self.assertEqual(bzrlib.commands.CommandHooks(),
1507
 
            bzrlib.commands.Command.hooks)
 
1460
        self.assertEqual(
 
1461
            bzrlib.commands.CommandHooks(), bzrlib.commands.Command.hooks)
1508
1462
 
1509
1463
    def test__gather_lsprof_in_benchmarks(self):
1510
1464
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1511
1465
 
1512
1466
        Each self.time() call is individually and separately profiled.
1513
1467
        """
1514
 
        self.requireFeature(test_lsprof.LSProfFeature)
 
1468
        self.requireFeature(features.lsprof_feature)
1515
1469
        # overrides the class member with an instance member so no cleanup
1516
1470
        # needed.
1517
1471
        self._gather_lsprof_in_benchmarks = True
1522
1476
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1523
1477
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1524
1478
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
 
1479
        del self._benchcalls[:]
1525
1480
 
1526
1481
    def test_knownFailure(self):
1527
1482
        """Self.knownFailure() should raise a KnownFailure exception."""
1528
 
        self.assertRaises(KnownFailure, self.knownFailure, "A Failure")
 
1483
        self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
 
1484
 
 
1485
    def test_open_bzrdir_safe_roots(self):
 
1486
        # even a memory transport should fail to open when its url isn't 
 
1487
        # permitted.
 
1488
        # Manually set one up (TestCase doesn't and shouldn't provide magic
 
1489
        # machinery)
 
1490
        transport_server = memory.MemoryServer()
 
1491
        transport_server.start_server()
 
1492
        self.addCleanup(transport_server.stop_server)
 
1493
        t = transport.get_transport_from_url(transport_server.get_url())
 
1494
        bzrdir.BzrDir.create(t.base)
 
1495
        self.assertRaises(errors.BzrError,
 
1496
            bzrdir.BzrDir.open_from_transport, t)
 
1497
        # But if we declare this as safe, we can open the bzrdir.
 
1498
        self.permit_url(t.base)
 
1499
        self._bzr_selftest_roots.append(t.base)
 
1500
        bzrdir.BzrDir.open_from_transport(t)
1529
1501
 
1530
1502
    def test_requireFeature_available(self):
1531
1503
        """self.requireFeature(available) is a no-op."""
1532
 
        class Available(Feature):
 
1504
        class Available(features.Feature):
1533
1505
            def _probe(self):return True
1534
1506
        feature = Available()
1535
1507
        self.requireFeature(feature)
1536
1508
 
1537
1509
    def test_requireFeature_unavailable(self):
1538
1510
        """self.requireFeature(unavailable) raises UnavailableFeature."""
1539
 
        class Unavailable(Feature):
 
1511
        class Unavailable(features.Feature):
1540
1512
            def _probe(self):return False
1541
1513
        feature = Unavailable()
1542
 
        self.assertRaises(UnavailableFeature, self.requireFeature, feature)
 
1514
        self.assertRaises(tests.UnavailableFeature,
 
1515
                          self.requireFeature, feature)
1543
1516
 
1544
1517
    def test_run_no_parameters(self):
1545
1518
        test = SampleTestCase('_test_pass')
1575
1548
        """Test disabled tests behaviour with support aware results."""
1576
1549
        test = SampleTestCase('_test_pass')
1577
1550
        class DisabledFeature(object):
 
1551
            def __eq__(self, other):
 
1552
                return isinstance(other, DisabledFeature)
1578
1553
            def available(self):
1579
1554
                return False
1580
1555
        the_feature = DisabledFeature()
1591
1566
                self.calls.append(('addNotSupported', test, feature))
1592
1567
        result = InstrumentedTestResult()
1593
1568
        test.run(result)
 
1569
        case = result.calls[0][1]
1594
1570
        self.assertEqual([
1595
 
            ('startTest', test),
1596
 
            ('addNotSupported', test, the_feature),
1597
 
            ('stopTest', test),
 
1571
            ('startTest', case),
 
1572
            ('addNotSupported', case, the_feature),
 
1573
            ('stopTest', case),
1598
1574
            ],
1599
1575
            result.calls)
1600
1576
 
 
1577
    def test_start_server_registers_url(self):
 
1578
        transport_server = memory.MemoryServer()
 
1579
        # A little strict, but unlikely to be changed soon.
 
1580
        self.assertEqual([], self._bzr_selftest_roots)
 
1581
        self.start_server(transport_server)
 
1582
        self.assertSubset([transport_server.get_url()],
 
1583
            self._bzr_selftest_roots)
 
1584
 
1601
1585
    def test_assert_list_raises_on_generator(self):
1602
1586
        def generator_which_will_raise():
1603
1587
            # This will not raise until after the first yield
1653
1637
        self.assertRaises(AssertionError,
1654
1638
            self.assertListRaises, _TestException, success_generator)
1655
1639
 
1656
 
 
1657
 
@symbol_versioning.deprecated_function(zero_eleven)
 
1640
    def test_overrideAttr_without_value(self):
 
1641
        self.test_attr = 'original' # Define a test attribute
 
1642
        obj = self # Make 'obj' visible to the embedded test
 
1643
        class Test(tests.TestCase):
 
1644
 
 
1645
            def setUp(self):
 
1646
                tests.TestCase.setUp(self)
 
1647
                self.orig = self.overrideAttr(obj, 'test_attr')
 
1648
 
 
1649
            def test_value(self):
 
1650
                self.assertEqual('original', self.orig)
 
1651
                self.assertEqual('original', obj.test_attr)
 
1652
                obj.test_attr = 'modified'
 
1653
                self.assertEqual('modified', obj.test_attr)
 
1654
 
 
1655
        test = Test('test_value')
 
1656
        test.run(unittest.TestResult())
 
1657
        self.assertEqual('original', obj.test_attr)
 
1658
 
 
1659
    def test_overrideAttr_with_value(self):
 
1660
        self.test_attr = 'original' # Define a test attribute
 
1661
        obj = self # Make 'obj' visible to the embedded test
 
1662
        class Test(tests.TestCase):
 
1663
 
 
1664
            def setUp(self):
 
1665
                tests.TestCase.setUp(self)
 
1666
                self.orig = self.overrideAttr(obj, 'test_attr', new='modified')
 
1667
 
 
1668
            def test_value(self):
 
1669
                self.assertEqual('original', self.orig)
 
1670
                self.assertEqual('modified', obj.test_attr)
 
1671
 
 
1672
        test = Test('test_value')
 
1673
        test.run(unittest.TestResult())
 
1674
        self.assertEqual('original', obj.test_attr)
 
1675
 
 
1676
    def test_recordCalls(self):
 
1677
        from bzrlib.tests import test_selftest
 
1678
        calls = self.recordCalls(
 
1679
            test_selftest, '_add_numbers')
 
1680
        self.assertEqual(test_selftest._add_numbers(2, 10),
 
1681
            12)
 
1682
        self.assertEquals(calls, [((2, 10), {})])
 
1683
 
 
1684
 
 
1685
def _add_numbers(a, b):
 
1686
    return a + b
 
1687
 
 
1688
 
 
1689
class _MissingFeature(features.Feature):
 
1690
    def _probe(self):
 
1691
        return False
 
1692
missing_feature = _MissingFeature()
 
1693
 
 
1694
 
 
1695
def _get_test(name):
 
1696
    """Get an instance of a specific example test.
 
1697
 
 
1698
    We protect this in a function so that they don't auto-run in the test
 
1699
    suite.
 
1700
    """
 
1701
 
 
1702
    class ExampleTests(tests.TestCase):
 
1703
 
 
1704
        def test_fail(self):
 
1705
            mutter('this was a failing test')
 
1706
            self.fail('this test will fail')
 
1707
 
 
1708
        def test_error(self):
 
1709
            mutter('this test errored')
 
1710
            raise RuntimeError('gotcha')
 
1711
 
 
1712
        def test_missing_feature(self):
 
1713
            mutter('missing the feature')
 
1714
            self.requireFeature(missing_feature)
 
1715
 
 
1716
        def test_skip(self):
 
1717
            mutter('this test will be skipped')
 
1718
            raise tests.TestSkipped('reason')
 
1719
 
 
1720
        def test_success(self):
 
1721
            mutter('this test succeeds')
 
1722
 
 
1723
        def test_xfail(self):
 
1724
            mutter('test with expected failure')
 
1725
            self.knownFailure('this_fails')
 
1726
 
 
1727
        def test_unexpected_success(self):
 
1728
            mutter('test with unexpected success')
 
1729
            self.expectFailure('should_fail', lambda: None)
 
1730
 
 
1731
    return ExampleTests(name)
 
1732
 
 
1733
 
 
1734
class TestTestCaseLogDetails(tests.TestCase):
 
1735
 
 
1736
    def _run_test(self, test_name):
 
1737
        test = _get_test(test_name)
 
1738
        result = testtools.TestResult()
 
1739
        test.run(result)
 
1740
        return result
 
1741
 
 
1742
    def test_fail_has_log(self):
 
1743
        result = self._run_test('test_fail')
 
1744
        self.assertEqual(1, len(result.failures))
 
1745
        result_content = result.failures[0][1]
 
1746
        if testtools_version < (0, 9, 12):
 
1747
            self.assertContainsRe(result_content, 'Text attachment: log')
 
1748
        self.assertContainsRe(result_content, 'this was a failing test')
 
1749
 
 
1750
    def test_error_has_log(self):
 
1751
        result = self._run_test('test_error')
 
1752
        self.assertEqual(1, len(result.errors))
 
1753
        result_content = result.errors[0][1]
 
1754
        if testtools_version < (0, 9, 12):
 
1755
            self.assertContainsRe(result_content, 'Text attachment: log')
 
1756
        self.assertContainsRe(result_content, 'this test errored')
 
1757
 
 
1758
    def test_skip_has_no_log(self):
 
1759
        result = self._run_test('test_skip')
 
1760
        self.assertEqual(['reason'], result.skip_reasons.keys())
 
1761
        skips = result.skip_reasons['reason']
 
1762
        self.assertEqual(1, len(skips))
 
1763
        test = skips[0]
 
1764
        self.assertFalse('log' in test.getDetails())
 
1765
 
 
1766
    def test_missing_feature_has_no_log(self):
 
1767
        # testtools doesn't know about addNotSupported, so it just gets
 
1768
        # considered as a skip
 
1769
        result = self._run_test('test_missing_feature')
 
1770
        self.assertEqual([missing_feature], result.skip_reasons.keys())
 
1771
        skips = result.skip_reasons[missing_feature]
 
1772
        self.assertEqual(1, len(skips))
 
1773
        test = skips[0]
 
1774
        self.assertFalse('log' in test.getDetails())
 
1775
 
 
1776
    def test_xfail_has_no_log(self):
 
1777
        result = self._run_test('test_xfail')
 
1778
        self.assertEqual(1, len(result.expectedFailures))
 
1779
        result_content = result.expectedFailures[0][1]
 
1780
        self.assertNotContainsRe(result_content, 'Text attachment: log')
 
1781
        self.assertNotContainsRe(result_content, 'test with expected failure')
 
1782
 
 
1783
    def test_unexpected_success_has_log(self):
 
1784
        result = self._run_test('test_unexpected_success')
 
1785
        self.assertEqual(1, len(result.unexpectedSuccesses))
 
1786
        # Inconsistency, unexpectedSuccesses is a list of tests,
 
1787
        # expectedFailures is a list of reasons?
 
1788
        test = result.unexpectedSuccesses[0]
 
1789
        details = test.getDetails()
 
1790
        self.assertTrue('log' in details)
 
1791
 
 
1792
 
 
1793
class TestTestCloning(tests.TestCase):
 
1794
    """Tests that test cloning of TestCases (as used by multiply_tests)."""
 
1795
 
 
1796
    def test_cloned_testcase_does_not_share_details(self):
 
1797
        """A TestCase cloned with clone_test does not share mutable attributes
 
1798
        such as details or cleanups.
 
1799
        """
 
1800
        class Test(tests.TestCase):
 
1801
            def test_foo(self):
 
1802
                self.addDetail('foo', Content('text/plain', lambda: 'foo'))
 
1803
        orig_test = Test('test_foo')
 
1804
        cloned_test = tests.clone_test(orig_test, orig_test.id() + '(cloned)')
 
1805
        orig_test.run(unittest.TestResult())
 
1806
        self.assertEqual('foo', orig_test.getDetails()['foo'].iter_bytes())
 
1807
        self.assertEqual(None, cloned_test.getDetails().get('foo'))
 
1808
 
 
1809
    def test_double_apply_scenario_preserves_first_scenario(self):
 
1810
        """Applying two levels of scenarios to a test preserves the attributes
 
1811
        added by both scenarios.
 
1812
        """
 
1813
        class Test(tests.TestCase):
 
1814
            def test_foo(self):
 
1815
                pass
 
1816
        test = Test('test_foo')
 
1817
        scenarios_x = [('x=1', {'x': 1}), ('x=2', {'x': 2})]
 
1818
        scenarios_y = [('y=1', {'y': 1}), ('y=2', {'y': 2})]
 
1819
        suite = tests.multiply_tests(test, scenarios_x, unittest.TestSuite())
 
1820
        suite = tests.multiply_tests(suite, scenarios_y, unittest.TestSuite())
 
1821
        all_tests = list(tests.iter_suite_tests(suite))
 
1822
        self.assertLength(4, all_tests)
 
1823
        all_xys = sorted((t.x, t.y) for t in all_tests)
 
1824
        self.assertEqual([(1, 1), (1, 2), (2, 1), (2, 2)], all_xys)
 
1825
 
 
1826
 
 
1827
# NB: Don't delete this; it's not actually from 0.11!
 
1828
@deprecated_function(deprecated_in((0, 11, 0)))
1658
1829
def sample_deprecated_function():
1659
1830
    """A deprecated function to test applyDeprecated with."""
1660
1831
    return 2
1667
1838
class ApplyDeprecatedHelper(object):
1668
1839
    """A helper class for ApplyDeprecated tests."""
1669
1840
 
1670
 
    @symbol_versioning.deprecated_method(zero_eleven)
 
1841
    @deprecated_method(deprecated_in((0, 11, 0)))
1671
1842
    def sample_deprecated_method(self, param_one):
1672
1843
        """A deprecated method for testing with."""
1673
1844
        return param_one
1675
1846
    def sample_normal_method(self):
1676
1847
        """A undeprecated method."""
1677
1848
 
1678
 
    @symbol_versioning.deprecated_method(zero_ten)
 
1849
    @deprecated_method(deprecated_in((0, 10, 0)))
1679
1850
    def sample_nested_deprecation(self):
1680
1851
        return sample_deprecated_function()
1681
1852
 
1682
1853
 
1683
 
class TestExtraAssertions(TestCase):
 
1854
class TestExtraAssertions(tests.TestCase):
1684
1855
    """Tests for new test assertions in bzrlib test suite"""
1685
1856
 
1686
1857
    def test_assert_isinstance(self):
1687
1858
        self.assertIsInstance(2, int)
1688
1859
        self.assertIsInstance(u'', basestring)
1689
 
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
 
1860
        e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
 
1861
        self.assertEquals(str(e),
 
1862
            "None is an instance of <type 'NoneType'> rather than <type 'int'>")
1690
1863
        self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
 
1864
        e = self.assertRaises(AssertionError,
 
1865
            self.assertIsInstance, None, int, "it's just not")
 
1866
        self.assertEquals(str(e),
 
1867
            "None is an instance of <type 'NoneType'> rather than <type 'int'>"
 
1868
            ": it's just not")
1691
1869
 
1692
1870
    def test_assertEndsWith(self):
1693
1871
        self.assertEndsWith('foo', 'oo')
1694
1872
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1695
1873
 
 
1874
    def test_assertEqualDiff(self):
 
1875
        e = self.assertRaises(AssertionError,
 
1876
                              self.assertEqualDiff, '', '\n')
 
1877
        self.assertEquals(str(e),
 
1878
                          # Don't blink ! The '+' applies to the second string
 
1879
                          'first string is missing a final newline.\n+ \n')
 
1880
        e = self.assertRaises(AssertionError,
 
1881
                              self.assertEqualDiff, '\n', '')
 
1882
        self.assertEquals(str(e),
 
1883
                          # Don't blink ! The '-' applies to the second string
 
1884
                          'second string is missing a final newline.\n- \n')
 
1885
 
 
1886
 
 
1887
class TestDeprecations(tests.TestCase):
 
1888
 
1696
1889
    def test_applyDeprecated_not_deprecated(self):
1697
1890
        sample_object = ApplyDeprecatedHelper()
1698
1891
        # calling an undeprecated callable raises an assertion
1699
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
 
1892
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1893
            deprecated_in((0, 11, 0)),
1700
1894
            sample_object.sample_normal_method)
1701
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_eleven,
 
1895
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1896
            deprecated_in((0, 11, 0)),
1702
1897
            sample_undeprecated_function, "a param value")
1703
1898
        # calling a deprecated callable (function or method) with the wrong
1704
1899
        # expected deprecation fails.
1705
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
 
1900
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1901
            deprecated_in((0, 10, 0)),
1706
1902
            sample_object.sample_deprecated_method, "a param value")
1707
 
        self.assertRaises(AssertionError, self.applyDeprecated, zero_ten,
 
1903
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1904
            deprecated_in((0, 10, 0)),
1708
1905
            sample_deprecated_function)
1709
1906
        # calling a deprecated callable (function or method) with the right
1710
1907
        # expected deprecation returns the functions result.
1711
 
        self.assertEqual("a param value", self.applyDeprecated(zero_eleven,
 
1908
        self.assertEqual("a param value",
 
1909
            self.applyDeprecated(deprecated_in((0, 11, 0)),
1712
1910
            sample_object.sample_deprecated_method, "a param value"))
1713
 
        self.assertEqual(2, self.applyDeprecated(zero_eleven,
 
1911
        self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 11, 0)),
1714
1912
            sample_deprecated_function))
1715
1913
        # calling a nested deprecation with the wrong deprecation version
1716
1914
        # fails even if a deeper nested function was deprecated with the
1717
1915
        # supplied version.
1718
1916
        self.assertRaises(AssertionError, self.applyDeprecated,
1719
 
            zero_eleven, sample_object.sample_nested_deprecation)
 
1917
            deprecated_in((0, 11, 0)), sample_object.sample_nested_deprecation)
1720
1918
        # calling a nested deprecation with the right deprecation value
1721
1919
        # returns the calls result.
1722
 
        self.assertEqual(2, self.applyDeprecated(zero_ten,
 
1920
        self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 10, 0)),
1723
1921
            sample_object.sample_nested_deprecation))
1724
1922
 
1725
1923
    def test_callDeprecated(self):
1736
1934
        self.callDeprecated([], testfunc, be_deprecated=False)
1737
1935
 
1738
1936
 
1739
 
class TestWarningTests(TestCase):
 
1937
class TestWarningTests(tests.TestCase):
1740
1938
    """Tests for calling methods that raise warnings."""
1741
1939
 
1742
1940
    def test_callCatchWarnings(self):
1752
1950
        self.assertEquals("this is your last warning", str(w0))
1753
1951
 
1754
1952
 
1755
 
class TestConvenienceMakers(TestCaseWithTransport):
 
1953
class TestConvenienceMakers(tests.TestCaseWithTransport):
1756
1954
    """Test for the make_* convenience functions."""
1757
1955
 
1758
1956
    def test_make_branch_and_tree_with_format(self):
1759
1957
        # we should be able to supply a format to make_branch_and_tree
1760
1958
        self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
1761
 
        self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
1762
1959
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
1763
1960
                              bzrlib.bzrdir.BzrDirMetaFormat1)
1764
 
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
1765
 
                              bzrlib.bzrdir.BzrDirFormat6)
1766
1961
 
1767
1962
    def test_make_branch_and_memory_tree(self):
1768
1963
        # we should be able to get a new branch and a mutable tree from
1770
1965
        tree = self.make_branch_and_memory_tree('a')
1771
1966
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1772
1967
 
1773
 
 
1774
 
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
1775
 
 
1776
 
    def test_make_tree_for_sftp_branch(self):
1777
 
        """Transports backed by local directories create local trees."""
1778
 
 
 
1968
    def test_make_tree_for_local_vfs_backed_transport(self):
 
1969
        # make_branch_and_tree has to use local branch and repositories
 
1970
        # when the vfs transport and local disk are colocated, even if
 
1971
        # a different transport is in use for url generation.
 
1972
        self.transport_server = test_server.FakeVFATServer
 
1973
        self.assertFalse(self.get_url('t1').startswith('file://'))
1779
1974
        tree = self.make_branch_and_tree('t1')
1780
1975
        base = tree.bzrdir.root_transport.base
1781
 
        self.failIf(base.startswith('sftp'),
1782
 
                'base %r is on sftp but should be local' % base)
 
1976
        self.assertStartsWith(base, 'file://')
1783
1977
        self.assertEquals(tree.bzrdir.root_transport,
1784
1978
                tree.branch.bzrdir.root_transport)
1785
1979
        self.assertEquals(tree.bzrdir.root_transport,
1786
1980
                tree.branch.repository.bzrdir.root_transport)
1787
1981
 
1788
1982
 
1789
 
class TestSelftest(TestCase):
 
1983
class SelfTestHelper(object):
 
1984
 
 
1985
    def run_selftest(self, **kwargs):
 
1986
        """Run selftest returning its output."""
 
1987
        output = StringIO()
 
1988
        old_transport = bzrlib.tests.default_transport
 
1989
        old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
 
1990
        tests.TestCaseWithMemoryTransport.TEST_ROOT = None
 
1991
        try:
 
1992
            self.assertEqual(True, tests.selftest(stream=output, **kwargs))
 
1993
        finally:
 
1994
            bzrlib.tests.default_transport = old_transport
 
1995
            tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
 
1996
        output.seek(0)
 
1997
        return output
 
1998
 
 
1999
 
 
2000
class TestSelftest(tests.TestCase, SelfTestHelper):
1790
2001
    """Tests of bzrlib.tests.selftest."""
1791
2002
 
1792
2003
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1793
2004
        factory_called = []
1794
2005
        def factory():
1795
2006
            factory_called.append(True)
1796
 
            return TestSuite()
 
2007
            return TestUtil.TestSuite()
1797
2008
        out = StringIO()
1798
2009
        err = StringIO()
1799
2010
        self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1800
2011
            test_suite_factory=factory)
1801
2012
        self.assertEqual([True], factory_called)
1802
2013
 
1803
 
 
1804
 
class TestKnownFailure(TestCase):
1805
 
 
1806
 
    def test_known_failure(self):
1807
 
        """Check that KnownFailure is defined appropriately."""
1808
 
        # a KnownFailure is an assertion error for compatability with unaware
1809
 
        # runners.
1810
 
        self.assertIsInstance(KnownFailure(""), AssertionError)
1811
 
 
1812
 
    def test_expect_failure(self):
1813
 
        try:
1814
 
            self.expectFailure("Doomed to failure", self.assertTrue, False)
1815
 
        except KnownFailure, e:
1816
 
            self.assertEqual('Doomed to failure', e.args[0])
1817
 
        try:
1818
 
            self.expectFailure("Doomed to failure", self.assertTrue, True)
1819
 
        except AssertionError, e:
1820
 
            self.assertEqual('Unexpected success.  Should have failed:'
1821
 
                             ' Doomed to failure', e.args[0])
 
2014
    def factory(self):
 
2015
        """A test suite factory."""
 
2016
        class Test(tests.TestCase):
 
2017
            def a(self):
 
2018
                pass
 
2019
            def b(self):
 
2020
                pass
 
2021
            def c(self):
 
2022
                pass
 
2023
        return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
 
2024
 
 
2025
    def test_list_only(self):
 
2026
        output = self.run_selftest(test_suite_factory=self.factory,
 
2027
            list_only=True)
 
2028
        self.assertEqual(3, len(output.readlines()))
 
2029
 
 
2030
    def test_list_only_filtered(self):
 
2031
        output = self.run_selftest(test_suite_factory=self.factory,
 
2032
            list_only=True, pattern="Test.b")
 
2033
        self.assertEndsWith(output.getvalue(), "Test.b\n")
 
2034
        self.assertLength(1, output.readlines())
 
2035
 
 
2036
    def test_list_only_excludes(self):
 
2037
        output = self.run_selftest(test_suite_factory=self.factory,
 
2038
            list_only=True, exclude_pattern="Test.b")
 
2039
        self.assertNotContainsRe("Test.b", output.getvalue())
 
2040
        self.assertLength(2, output.readlines())
 
2041
 
 
2042
    def test_lsprof_tests(self):
 
2043
        self.requireFeature(features.lsprof_feature)
 
2044
        results = []
 
2045
        class Test(object):
 
2046
            def __call__(test, result):
 
2047
                test.run(result)
 
2048
            def run(test, result):
 
2049
                results.append(result)
 
2050
            def countTestCases(self):
 
2051
                return 1
 
2052
        self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
 
2053
        self.assertLength(1, results)
 
2054
        self.assertIsInstance(results.pop(), ExtendedToOriginalDecorator)
 
2055
 
 
2056
    def test_random(self):
 
2057
        # test randomising by listing a number of tests.
 
2058
        output_123 = self.run_selftest(test_suite_factory=self.factory,
 
2059
            list_only=True, random_seed="123")
 
2060
        output_234 = self.run_selftest(test_suite_factory=self.factory,
 
2061
            list_only=True, random_seed="234")
 
2062
        self.assertNotEqual(output_123, output_234)
 
2063
        # "Randominzing test order..\n\n
 
2064
        self.assertLength(5, output_123.readlines())
 
2065
        self.assertLength(5, output_234.readlines())
 
2066
 
 
2067
    def test_random_reuse_is_same_order(self):
 
2068
        # test randomising by listing a number of tests.
 
2069
        expected = self.run_selftest(test_suite_factory=self.factory,
 
2070
            list_only=True, random_seed="123")
 
2071
        repeated = self.run_selftest(test_suite_factory=self.factory,
 
2072
            list_only=True, random_seed="123")
 
2073
        self.assertEqual(expected.getvalue(), repeated.getvalue())
 
2074
 
 
2075
    def test_runner_class(self):
 
2076
        self.requireFeature(features.subunit)
 
2077
        from subunit import ProtocolTestCase
 
2078
        stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
 
2079
            test_suite_factory=self.factory)
 
2080
        test = ProtocolTestCase(stream)
 
2081
        result = unittest.TestResult()
 
2082
        test.run(result)
 
2083
        self.assertEqual(3, result.testsRun)
 
2084
 
 
2085
    def test_starting_with_single_argument(self):
 
2086
        output = self.run_selftest(test_suite_factory=self.factory,
 
2087
            starting_with=['bzrlib.tests.test_selftest.Test.a'],
 
2088
            list_only=True)
 
2089
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
 
2090
            output.getvalue())
 
2091
 
 
2092
    def test_starting_with_multiple_argument(self):
 
2093
        output = self.run_selftest(test_suite_factory=self.factory,
 
2094
            starting_with=['bzrlib.tests.test_selftest.Test.a',
 
2095
                'bzrlib.tests.test_selftest.Test.b'],
 
2096
            list_only=True)
 
2097
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
 
2098
            'bzrlib.tests.test_selftest.Test.b\n',
 
2099
            output.getvalue())
 
2100
 
 
2101
    def check_transport_set(self, transport_server):
 
2102
        captured_transport = []
 
2103
        def seen_transport(a_transport):
 
2104
            captured_transport.append(a_transport)
 
2105
        class Capture(tests.TestCase):
 
2106
            def a(self):
 
2107
                seen_transport(bzrlib.tests.default_transport)
 
2108
        def factory():
 
2109
            return TestUtil.TestSuite([Capture("a")])
 
2110
        self.run_selftest(transport=transport_server, test_suite_factory=factory)
 
2111
        self.assertEqual(transport_server, captured_transport[0])
 
2112
 
 
2113
    def test_transport_sftp(self):
 
2114
        self.requireFeature(features.paramiko)
 
2115
        from bzrlib.tests import stub_sftp
 
2116
        self.check_transport_set(stub_sftp.SFTPAbsoluteServer)
 
2117
 
 
2118
    def test_transport_memory(self):
 
2119
        self.check_transport_set(memory.MemoryServer)
 
2120
 
 
2121
 
 
2122
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
 
2123
    # Does IO: reads test.list
 
2124
 
 
2125
    def test_load_list(self):
 
2126
        # Provide a list with one test - this test.
 
2127
        test_id_line = '%s\n' % self.id()
 
2128
        self.build_tree_contents([('test.list', test_id_line)])
 
2129
        # And generate a list of the tests in  the suite.
 
2130
        stream = self.run_selftest(load_list='test.list', list_only=True)
 
2131
        self.assertEqual(test_id_line, stream.getvalue())
 
2132
 
 
2133
    def test_load_unknown(self):
 
2134
        # Provide a list with one test - this test.
 
2135
        # And generate a list of the tests in  the suite.
 
2136
        err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
 
2137
            load_list='missing file name', list_only=True)
 
2138
 
 
2139
 
 
2140
class TestSubunitLogDetails(tests.TestCase, SelfTestHelper):
 
2141
 
 
2142
    _test_needs_features = [features.subunit]
 
2143
 
 
2144
    def run_subunit_stream(self, test_name):
 
2145
        from subunit import ProtocolTestCase
 
2146
        def factory():
 
2147
            return TestUtil.TestSuite([_get_test(test_name)])
 
2148
        stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
 
2149
            test_suite_factory=factory)
 
2150
        test = ProtocolTestCase(stream)
 
2151
        result = testtools.TestResult()
 
2152
        test.run(result)
 
2153
        content = stream.getvalue()
 
2154
        return content, result
 
2155
 
 
2156
    def test_fail_has_log(self):
 
2157
        content, result = self.run_subunit_stream('test_fail')
 
2158
        self.assertEqual(1, len(result.failures))
 
2159
        self.assertContainsRe(content, '(?m)^log$')
 
2160
        self.assertContainsRe(content, 'this test will fail')
 
2161
 
 
2162
    def test_error_has_log(self):
 
2163
        content, result = self.run_subunit_stream('test_error')
 
2164
        self.assertContainsRe(content, '(?m)^log$')
 
2165
        self.assertContainsRe(content, 'this test errored')
 
2166
 
 
2167
    def test_skip_has_no_log(self):
 
2168
        content, result = self.run_subunit_stream('test_skip')
 
2169
        self.assertNotContainsRe(content, '(?m)^log$')
 
2170
        self.assertNotContainsRe(content, 'this test will be skipped')
 
2171
        self.assertEqual(['reason'], result.skip_reasons.keys())
 
2172
        skips = result.skip_reasons['reason']
 
2173
        self.assertEqual(1, len(skips))
 
2174
        test = skips[0]
 
2175
        # RemotedTestCase doesn't preserve the "details"
 
2176
        ## self.assertFalse('log' in test.getDetails())
 
2177
 
 
2178
    def test_missing_feature_has_no_log(self):
 
2179
        content, result = self.run_subunit_stream('test_missing_feature')
 
2180
        self.assertNotContainsRe(content, '(?m)^log$')
 
2181
        self.assertNotContainsRe(content, 'missing the feature')
 
2182
        self.assertEqual(['_MissingFeature\n'], result.skip_reasons.keys())
 
2183
        skips = result.skip_reasons['_MissingFeature\n']
 
2184
        self.assertEqual(1, len(skips))
 
2185
        test = skips[0]
 
2186
        # RemotedTestCase doesn't preserve the "details"
 
2187
        ## self.assertFalse('log' in test.getDetails())
 
2188
 
 
2189
    def test_xfail_has_no_log(self):
 
2190
        content, result = self.run_subunit_stream('test_xfail')
 
2191
        self.assertNotContainsRe(content, '(?m)^log$')
 
2192
        self.assertNotContainsRe(content, 'test with expected failure')
 
2193
        self.assertEqual(1, len(result.expectedFailures))
 
2194
        result_content = result.expectedFailures[0][1]
 
2195
        self.assertNotContainsRe(result_content, 'Text attachment: log')
 
2196
        self.assertNotContainsRe(result_content, 'test with expected failure')
 
2197
 
 
2198
    def test_unexpected_success_has_log(self):
 
2199
        content, result = self.run_subunit_stream('test_unexpected_success')
 
2200
        self.assertContainsRe(content, '(?m)^log$')
 
2201
        self.assertContainsRe(content, 'test with unexpected success')
 
2202
        # GZ 2011-05-18: Old versions of subunit treat unexpected success as a
 
2203
        #                success, if a min version check is added remove this
 
2204
        from subunit import TestProtocolClient as _Client
 
2205
        if _Client.addUnexpectedSuccess.im_func is _Client.addSuccess.im_func:
 
2206
            self.expectFailure('subunit treats "unexpectedSuccess"'
 
2207
                               ' as a plain success',
 
2208
                self.assertEqual, 1, len(result.unexpectedSuccesses))
 
2209
        self.assertEqual(1, len(result.unexpectedSuccesses))
 
2210
        test = result.unexpectedSuccesses[0]
 
2211
        # RemotedTestCase doesn't preserve the "details"
 
2212
        ## self.assertTrue('log' in test.getDetails())
 
2213
 
 
2214
    def test_success_has_no_log(self):
 
2215
        content, result = self.run_subunit_stream('test_success')
 
2216
        self.assertEqual(1, result.testsRun)
 
2217
        self.assertNotContainsRe(content, '(?m)^log$')
 
2218
        self.assertNotContainsRe(content, 'this test succeeds')
 
2219
 
 
2220
 
 
2221
class TestRunBzr(tests.TestCase):
 
2222
 
 
2223
    out = ''
 
2224
    err = ''
 
2225
 
 
2226
    def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
 
2227
                         working_dir=None):
 
2228
        """Override _run_bzr_core to test how it is invoked by run_bzr.
 
2229
 
 
2230
        Attempts to run bzr from inside this class don't actually run it.
 
2231
 
 
2232
        We test how run_bzr actually invokes bzr in another location.  Here we
 
2233
        only need to test that it passes the right parameters to run_bzr.
 
2234
        """
 
2235
        self.argv = list(argv)
 
2236
        self.retcode = retcode
 
2237
        self.encoding = encoding
 
2238
        self.stdin = stdin
 
2239
        self.working_dir = working_dir
 
2240
        return self.retcode, self.out, self.err
 
2241
 
 
2242
    def test_run_bzr_error(self):
 
2243
        self.out = "It sure does!\n"
 
2244
        out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
 
2245
        self.assertEqual(['rocks'], self.argv)
 
2246
        self.assertEqual(34, self.retcode)
 
2247
        self.assertEqual('It sure does!\n', out)
 
2248
        self.assertEquals(out, self.out)
 
2249
        self.assertEqual('', err)
 
2250
        self.assertEquals(err, self.err)
 
2251
 
 
2252
    def test_run_bzr_error_regexes(self):
 
2253
        self.out = ''
 
2254
        self.err = "bzr: ERROR: foobarbaz is not versioned"
 
2255
        out, err = self.run_bzr_error(
 
2256
            ["bzr: ERROR: foobarbaz is not versioned"],
 
2257
            ['file-id', 'foobarbaz'])
 
2258
 
 
2259
    def test_encoding(self):
 
2260
        """Test that run_bzr passes encoding to _run_bzr_core"""
 
2261
        self.run_bzr('foo bar')
 
2262
        self.assertEqual(None, self.encoding)
 
2263
        self.assertEqual(['foo', 'bar'], self.argv)
 
2264
 
 
2265
        self.run_bzr('foo bar', encoding='baz')
 
2266
        self.assertEqual('baz', self.encoding)
 
2267
        self.assertEqual(['foo', 'bar'], self.argv)
 
2268
 
 
2269
    def test_retcode(self):
 
2270
        """Test that run_bzr passes retcode to _run_bzr_core"""
 
2271
        # Default is retcode == 0
 
2272
        self.run_bzr('foo bar')
 
2273
        self.assertEqual(0, self.retcode)
 
2274
        self.assertEqual(['foo', 'bar'], self.argv)
 
2275
 
 
2276
        self.run_bzr('foo bar', retcode=1)
 
2277
        self.assertEqual(1, self.retcode)
 
2278
        self.assertEqual(['foo', 'bar'], self.argv)
 
2279
 
 
2280
        self.run_bzr('foo bar', retcode=None)
 
2281
        self.assertEqual(None, self.retcode)
 
2282
        self.assertEqual(['foo', 'bar'], self.argv)
 
2283
 
 
2284
        self.run_bzr(['foo', 'bar'], retcode=3)
 
2285
        self.assertEqual(3, self.retcode)
 
2286
        self.assertEqual(['foo', 'bar'], self.argv)
 
2287
 
 
2288
    def test_stdin(self):
 
2289
        # test that the stdin keyword to run_bzr is passed through to
 
2290
        # _run_bzr_core as-is. We do this by overriding
 
2291
        # _run_bzr_core in this class, and then calling run_bzr,
 
2292
        # which is a convenience function for _run_bzr_core, so
 
2293
        # should invoke it.
 
2294
        self.run_bzr('foo bar', stdin='gam')
 
2295
        self.assertEqual('gam', self.stdin)
 
2296
        self.assertEqual(['foo', 'bar'], self.argv)
 
2297
 
 
2298
        self.run_bzr('foo bar', stdin='zippy')
 
2299
        self.assertEqual('zippy', self.stdin)
 
2300
        self.assertEqual(['foo', 'bar'], self.argv)
 
2301
 
 
2302
    def test_working_dir(self):
 
2303
        """Test that run_bzr passes working_dir to _run_bzr_core"""
 
2304
        self.run_bzr('foo bar')
 
2305
        self.assertEqual(None, self.working_dir)
 
2306
        self.assertEqual(['foo', 'bar'], self.argv)
 
2307
 
 
2308
        self.run_bzr('foo bar', working_dir='baz')
 
2309
        self.assertEqual('baz', self.working_dir)
 
2310
        self.assertEqual(['foo', 'bar'], self.argv)
 
2311
 
 
2312
    def test_reject_extra_keyword_arguments(self):
 
2313
        self.assertRaises(TypeError, self.run_bzr, "foo bar",
 
2314
                          error_regex=['error message'])
 
2315
 
 
2316
 
 
2317
class TestRunBzrCaptured(tests.TestCaseWithTransport):
 
2318
    # Does IO when testing the working_dir parameter.
 
2319
 
 
2320
    def apply_redirected(self, stdin=None, stdout=None, stderr=None,
 
2321
                         a_callable=None, *args, **kwargs):
 
2322
        self.stdin = stdin
 
2323
        self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
 
2324
        self.factory = bzrlib.ui.ui_factory
 
2325
        self.working_dir = osutils.getcwd()
 
2326
        stdout.write('foo\n')
 
2327
        stderr.write('bar\n')
 
2328
        return 0
 
2329
 
 
2330
    def test_stdin(self):
 
2331
        # test that the stdin keyword to _run_bzr_core is passed through to
 
2332
        # apply_redirected as a StringIO. We do this by overriding
 
2333
        # apply_redirected in this class, and then calling _run_bzr_core,
 
2334
        # which calls apply_redirected.
 
2335
        self.run_bzr(['foo', 'bar'], stdin='gam')
 
2336
        self.assertEqual('gam', self.stdin.read())
 
2337
        self.assertTrue(self.stdin is self.factory_stdin)
 
2338
        self.run_bzr(['foo', 'bar'], stdin='zippy')
 
2339
        self.assertEqual('zippy', self.stdin.read())
 
2340
        self.assertTrue(self.stdin is self.factory_stdin)
 
2341
 
 
2342
    def test_ui_factory(self):
 
2343
        # each invocation of self.run_bzr should get its
 
2344
        # own UI factory, which is an instance of TestUIFactory,
 
2345
        # with stdin, stdout and stderr attached to the stdin,
 
2346
        # stdout and stderr of the invoked run_bzr
 
2347
        current_factory = bzrlib.ui.ui_factory
 
2348
        self.run_bzr(['foo'])
 
2349
        self.assertFalse(current_factory is self.factory)
 
2350
        self.assertNotEqual(sys.stdout, self.factory.stdout)
 
2351
        self.assertNotEqual(sys.stderr, self.factory.stderr)
 
2352
        self.assertEqual('foo\n', self.factory.stdout.getvalue())
 
2353
        self.assertEqual('bar\n', self.factory.stderr.getvalue())
 
2354
        self.assertIsInstance(self.factory, tests.TestUIFactory)
 
2355
 
 
2356
    def test_working_dir(self):
 
2357
        self.build_tree(['one/', 'two/'])
 
2358
        cwd = osutils.getcwd()
 
2359
 
 
2360
        # Default is to work in the current directory
 
2361
        self.run_bzr(['foo', 'bar'])
 
2362
        self.assertEqual(cwd, self.working_dir)
 
2363
 
 
2364
        self.run_bzr(['foo', 'bar'], working_dir=None)
 
2365
        self.assertEqual(cwd, self.working_dir)
 
2366
 
 
2367
        # The function should be run in the alternative directory
 
2368
        # but afterwards the current working dir shouldn't be changed
 
2369
        self.run_bzr(['foo', 'bar'], working_dir='one')
 
2370
        self.assertNotEqual(cwd, self.working_dir)
 
2371
        self.assertEndsWith(self.working_dir, 'one')
 
2372
        self.assertEqual(cwd, osutils.getcwd())
 
2373
 
 
2374
        self.run_bzr(['foo', 'bar'], working_dir='two')
 
2375
        self.assertNotEqual(cwd, self.working_dir)
 
2376
        self.assertEndsWith(self.working_dir, 'two')
 
2377
        self.assertEqual(cwd, osutils.getcwd())
 
2378
 
 
2379
 
 
2380
class StubProcess(object):
 
2381
    """A stub process for testing run_bzr_subprocess."""
 
2382
    
 
2383
    def __init__(self, out="", err="", retcode=0):
 
2384
        self.out = out
 
2385
        self.err = err
 
2386
        self.returncode = retcode
 
2387
 
 
2388
    def communicate(self):
 
2389
        return self.out, self.err
 
2390
 
 
2391
 
 
2392
class TestWithFakedStartBzrSubprocess(tests.TestCaseWithTransport):
 
2393
    """Base class for tests testing how we might run bzr."""
 
2394
 
 
2395
    def setUp(self):
 
2396
        tests.TestCaseWithTransport.setUp(self)
 
2397
        self.subprocess_calls = []
 
2398
 
 
2399
    def start_bzr_subprocess(self, process_args, env_changes=None,
 
2400
                             skip_if_plan_to_signal=False,
 
2401
                             working_dir=None,
 
2402
                             allow_plugins=False):
 
2403
        """capture what run_bzr_subprocess tries to do."""
 
2404
        self.subprocess_calls.append({'process_args':process_args,
 
2405
            'env_changes':env_changes,
 
2406
            'skip_if_plan_to_signal':skip_if_plan_to_signal,
 
2407
            'working_dir':working_dir, 'allow_plugins':allow_plugins})
 
2408
        return self.next_subprocess
 
2409
 
 
2410
 
 
2411
class TestRunBzrSubprocess(TestWithFakedStartBzrSubprocess):
 
2412
 
 
2413
    def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
 
2414
        """Run run_bzr_subprocess with args and kwargs using a stubbed process.
 
2415
 
 
2416
        Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
 
2417
        that will return static results. This assertion method populates those
 
2418
        results and also checks the arguments run_bzr_subprocess generates.
 
2419
        """
 
2420
        self.next_subprocess = process
 
2421
        try:
 
2422
            result = self.run_bzr_subprocess(*args, **kwargs)
 
2423
        except:
 
2424
            self.next_subprocess = None
 
2425
            for key, expected in expected_args.iteritems():
 
2426
                self.assertEqual(expected, self.subprocess_calls[-1][key])
 
2427
            raise
1822
2428
        else:
1823
 
            self.fail('Assertion not raised')
1824
 
 
1825
 
 
1826
 
class TestFeature(TestCase):
1827
 
 
1828
 
    def test_caching(self):
1829
 
        """Feature._probe is called by the feature at most once."""
1830
 
        class InstrumentedFeature(Feature):
1831
 
            def __init__(self):
1832
 
                Feature.__init__(self)
1833
 
                self.calls = []
1834
 
            def _probe(self):
1835
 
                self.calls.append('_probe')
1836
 
                return False
1837
 
        feature = InstrumentedFeature()
1838
 
        feature.available()
1839
 
        self.assertEqual(['_probe'], feature.calls)
1840
 
        feature.available()
1841
 
        self.assertEqual(['_probe'], feature.calls)
1842
 
 
1843
 
    def test_named_str(self):
1844
 
        """Feature.__str__ should thunk to feature_name()."""
1845
 
        class NamedFeature(Feature):
1846
 
            def feature_name(self):
1847
 
                return 'symlinks'
1848
 
        feature = NamedFeature()
1849
 
        self.assertEqual('symlinks', str(feature))
1850
 
 
1851
 
    def test_default_str(self):
1852
 
        """Feature.__str__ should default to __class__.__name__."""
1853
 
        class NamedFeature(Feature):
1854
 
            pass
1855
 
        feature = NamedFeature()
1856
 
        self.assertEqual('NamedFeature', str(feature))
1857
 
 
1858
 
 
1859
 
class TestUnavailableFeature(TestCase):
1860
 
 
1861
 
    def test_access_feature(self):
1862
 
        feature = Feature()
1863
 
        exception = UnavailableFeature(feature)
1864
 
        self.assertIs(feature, exception.args[0])
1865
 
 
1866
 
 
1867
 
class TestSelftestFiltering(TestCase):
 
2429
            self.next_subprocess = None
 
2430
            for key, expected in expected_args.iteritems():
 
2431
                self.assertEqual(expected, self.subprocess_calls[-1][key])
 
2432
            return result
 
2433
 
 
2434
    def test_run_bzr_subprocess(self):
 
2435
        """The run_bzr_helper_external command behaves nicely."""
 
2436
        self.assertRunBzrSubprocess({'process_args':['--version']},
 
2437
            StubProcess(), '--version')
 
2438
        self.assertRunBzrSubprocess({'process_args':['--version']},
 
2439
            StubProcess(), ['--version'])
 
2440
        # retcode=None disables retcode checking
 
2441
        result = self.assertRunBzrSubprocess({},
 
2442
            StubProcess(retcode=3), '--version', retcode=None)
 
2443
        result = self.assertRunBzrSubprocess({},
 
2444
            StubProcess(out="is free software"), '--version')
 
2445
        self.assertContainsRe(result[0], 'is free software')
 
2446
        # Running a subcommand that is missing errors
 
2447
        self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
 
2448
            {'process_args':['--versionn']}, StubProcess(retcode=3),
 
2449
            '--versionn')
 
2450
        # Unless it is told to expect the error from the subprocess
 
2451
        result = self.assertRunBzrSubprocess({},
 
2452
            StubProcess(retcode=3), '--versionn', retcode=3)
 
2453
        # Or to ignore retcode checking
 
2454
        result = self.assertRunBzrSubprocess({},
 
2455
            StubProcess(err="unknown command", retcode=3), '--versionn',
 
2456
            retcode=None)
 
2457
        self.assertContainsRe(result[1], 'unknown command')
 
2458
 
 
2459
    def test_env_change_passes_through(self):
 
2460
        self.assertRunBzrSubprocess(
 
2461
            {'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
 
2462
            StubProcess(), '',
 
2463
            env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
 
2464
 
 
2465
    def test_no_working_dir_passed_as_None(self):
 
2466
        self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
 
2467
 
 
2468
    def test_no_working_dir_passed_through(self):
 
2469
        self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
 
2470
            working_dir='dir')
 
2471
 
 
2472
    def test_run_bzr_subprocess_no_plugins(self):
 
2473
        self.assertRunBzrSubprocess({'allow_plugins': False},
 
2474
            StubProcess(), '')
 
2475
 
 
2476
    def test_allow_plugins(self):
 
2477
        self.assertRunBzrSubprocess({'allow_plugins': True},
 
2478
            StubProcess(), '', allow_plugins=True)
 
2479
 
 
2480
 
 
2481
class TestFinishBzrSubprocess(TestWithFakedStartBzrSubprocess):
 
2482
 
 
2483
    def test_finish_bzr_subprocess_with_error(self):
 
2484
        """finish_bzr_subprocess allows specification of the desired exit code.
 
2485
        """
 
2486
        process = StubProcess(err="unknown command", retcode=3)
 
2487
        result = self.finish_bzr_subprocess(process, retcode=3)
 
2488
        self.assertEqual('', result[0])
 
2489
        self.assertContainsRe(result[1], 'unknown command')
 
2490
 
 
2491
    def test_finish_bzr_subprocess_ignoring_retcode(self):
 
2492
        """finish_bzr_subprocess allows the exit code to be ignored."""
 
2493
        process = StubProcess(err="unknown command", retcode=3)
 
2494
        result = self.finish_bzr_subprocess(process, retcode=None)
 
2495
        self.assertEqual('', result[0])
 
2496
        self.assertContainsRe(result[1], 'unknown command')
 
2497
 
 
2498
    def test_finish_subprocess_with_unexpected_retcode(self):
 
2499
        """finish_bzr_subprocess raises self.failureException if the retcode is
 
2500
        not the expected one.
 
2501
        """
 
2502
        process = StubProcess(err="unknown command", retcode=3)
 
2503
        self.assertRaises(self.failureException, self.finish_bzr_subprocess,
 
2504
                          process)
 
2505
 
 
2506
 
 
2507
class _DontSpawnProcess(Exception):
 
2508
    """A simple exception which just allows us to skip unnecessary steps"""
 
2509
 
 
2510
 
 
2511
class TestStartBzrSubProcess(tests.TestCase):
 
2512
    """Stub test start_bzr_subprocess."""
 
2513
 
 
2514
    def _subprocess_log_cleanup(self):
 
2515
        """Inhibits the base version as we don't produce a log file."""
 
2516
 
 
2517
    def _popen(self, *args, **kwargs):
 
2518
        """Override the base version to record the command that is run.
 
2519
 
 
2520
        From there we can ensure it is correct without spawning a real process.
 
2521
        """
 
2522
        self.check_popen_state()
 
2523
        self._popen_args = args
 
2524
        self._popen_kwargs = kwargs
 
2525
        raise _DontSpawnProcess()
 
2526
 
 
2527
    def check_popen_state(self):
 
2528
        """Replace to make assertions when popen is called."""
 
2529
 
 
2530
    def test_run_bzr_subprocess_no_plugins(self):
 
2531
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
 
2532
        command = self._popen_args[0]
 
2533
        self.assertEqual(sys.executable, command[0])
 
2534
        self.assertEqual(self.get_bzr_path(), command[1])
 
2535
        self.assertEqual(['--no-plugins'], command[2:])
 
2536
 
 
2537
    def test_allow_plugins(self):
 
2538
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2539
                          allow_plugins=True)
 
2540
        command = self._popen_args[0]
 
2541
        self.assertEqual([], command[2:])
 
2542
 
 
2543
    def test_set_env(self):
 
2544
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
 
2545
        # set in the child
 
2546
        def check_environment():
 
2547
            self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
 
2548
        self.check_popen_state = check_environment
 
2549
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2550
                          env_changes={'EXISTANT_ENV_VAR':'set variable'})
 
2551
        # not set in theparent
 
2552
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
 
2553
 
 
2554
    def test_run_bzr_subprocess_env_del(self):
 
2555
        """run_bzr_subprocess can remove environment variables too."""
 
2556
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
 
2557
        def check_environment():
 
2558
            self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
 
2559
        os.environ['EXISTANT_ENV_VAR'] = 'set variable'
 
2560
        self.check_popen_state = check_environment
 
2561
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2562
                          env_changes={'EXISTANT_ENV_VAR':None})
 
2563
        # Still set in parent
 
2564
        self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
 
2565
        del os.environ['EXISTANT_ENV_VAR']
 
2566
 
 
2567
    def test_env_del_missing(self):
 
2568
        self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
 
2569
        def check_environment():
 
2570
            self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
 
2571
        self.check_popen_state = check_environment
 
2572
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2573
                          env_changes={'NON_EXISTANT_ENV_VAR':None})
 
2574
 
 
2575
    def test_working_dir(self):
 
2576
        """Test that we can specify the working dir for the child"""
 
2577
        orig_getcwd = osutils.getcwd
 
2578
        orig_chdir = os.chdir
 
2579
        chdirs = []
 
2580
        def chdir(path):
 
2581
            chdirs.append(path)
 
2582
        self.overrideAttr(os, 'chdir', chdir)
 
2583
        def getcwd():
 
2584
            return 'current'
 
2585
        self.overrideAttr(osutils, 'getcwd', getcwd)
 
2586
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2587
                          working_dir='foo')
 
2588
        self.assertEqual(['foo', 'current'], chdirs)
 
2589
 
 
2590
    def test_get_bzr_path_with_cwd_bzrlib(self):
 
2591
        self.get_source_path = lambda: ""
 
2592
        self.overrideAttr(os.path, "isfile", lambda path: True)
 
2593
        self.assertEqual(self.get_bzr_path(), "bzr")
 
2594
 
 
2595
 
 
2596
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
 
2597
    """Tests that really need to do things with an external bzr."""
 
2598
 
 
2599
    def test_start_and_stop_bzr_subprocess_send_signal(self):
 
2600
        """finish_bzr_subprocess raises self.failureException if the retcode is
 
2601
        not the expected one.
 
2602
        """
 
2603
        self.disable_missing_extensions_warning()
 
2604
        process = self.start_bzr_subprocess(['wait-until-signalled'],
 
2605
                                            skip_if_plan_to_signal=True)
 
2606
        self.assertEqual('running\n', process.stdout.readline())
 
2607
        result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
 
2608
                                            retcode=3)
 
2609
        self.assertEqual('', result[0])
 
2610
        self.assertEqual('bzr: interrupted\n', result[1])
 
2611
 
 
2612
 
 
2613
class TestSelftestFiltering(tests.TestCase):
1868
2614
 
1869
2615
    def setUp(self):
1870
 
        TestCase.setUp(self)
 
2616
        tests.TestCase.setUp(self)
1871
2617
        self.suite = TestUtil.TestSuite()
1872
2618
        self.loader = TestUtil.TestLoader()
1873
 
        self.suite.addTest(self.loader.loadTestsFromModuleNames([
1874
 
            'bzrlib.tests.test_selftest']))
 
2619
        self.suite.addTest(self.loader.loadTestsFromModule(
 
2620
            sys.modules['bzrlib.tests.test_selftest']))
1875
2621
        self.all_names = _test_ids(self.suite)
1876
2622
 
1877
2623
    def test_condition_id_re(self):
1878
2624
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
1879
2625
            'test_condition_id_re')
1880
 
        filtered_suite = filter_suite_by_condition(self.suite,
1881
 
            condition_id_re('test_condition_id_re'))
 
2626
        filtered_suite = tests.filter_suite_by_condition(
 
2627
            self.suite, tests.condition_id_re('test_condition_id_re'))
1882
2628
        self.assertEqual([test_name], _test_ids(filtered_suite))
1883
2629
 
1884
2630
    def test_condition_id_in_list(self):
1885
2631
        test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
1886
2632
                      'test_condition_id_in_list']
1887
2633
        id_list = tests.TestIdList(test_names)
1888
 
        filtered_suite = filter_suite_by_condition(
 
2634
        filtered_suite = tests.filter_suite_by_condition(
1889
2635
            self.suite, tests.condition_id_in_list(id_list))
1890
2636
        my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
1891
 
        re_filtered = filter_suite_by_re(self.suite, my_pattern)
 
2637
        re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
1892
2638
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
1893
2639
 
1894
2640
    def test_condition_id_startswith(self):
1898
2644
        test_names = [ klass + 'test_condition_id_in_list',
1899
2645
                      klass + 'test_condition_id_startswith',
1900
2646
                     ]
1901
 
        filtered_suite = filter_suite_by_condition(
 
2647
        filtered_suite = tests.filter_suite_by_condition(
1902
2648
            self.suite, tests.condition_id_startswith([start1, start2]))
1903
2649
        self.assertEqual(test_names, _test_ids(filtered_suite))
1904
2650
 
1905
2651
    def test_condition_isinstance(self):
1906
 
        filtered_suite = filter_suite_by_condition(self.suite,
1907
 
            condition_isinstance(self.__class__))
 
2652
        filtered_suite = tests.filter_suite_by_condition(
 
2653
            self.suite, tests.condition_isinstance(self.__class__))
1908
2654
        class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
1909
 
        re_filtered = filter_suite_by_re(self.suite, class_pattern)
 
2655
        re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
1910
2656
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
1911
2657
 
1912
2658
    def test_exclude_tests_by_condition(self):
1913
2659
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
1914
2660
            'test_exclude_tests_by_condition')
1915
 
        filtered_suite = exclude_tests_by_condition(self.suite,
 
2661
        filtered_suite = tests.exclude_tests_by_condition(self.suite,
1916
2662
            lambda x:x.id() == excluded_name)
1917
2663
        self.assertEqual(len(self.all_names) - 1,
1918
2664
            filtered_suite.countTestCases())
1923
2669
 
1924
2670
    def test_exclude_tests_by_re(self):
1925
2671
        self.all_names = _test_ids(self.suite)
1926
 
        filtered_suite = exclude_tests_by_re(self.suite, 'exclude_tests_by_re')
 
2672
        filtered_suite = tests.exclude_tests_by_re(self.suite,
 
2673
                                                   'exclude_tests_by_re')
1927
2674
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
1928
2675
            'test_exclude_tests_by_re')
1929
2676
        self.assertEqual(len(self.all_names) - 1,
1936
2683
    def test_filter_suite_by_condition(self):
1937
2684
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
1938
2685
            'test_filter_suite_by_condition')
1939
 
        filtered_suite = filter_suite_by_condition(self.suite,
 
2686
        filtered_suite = tests.filter_suite_by_condition(self.suite,
1940
2687
            lambda x:x.id() == test_name)
1941
2688
        self.assertEqual([test_name], _test_ids(filtered_suite))
1942
2689
 
1943
2690
    def test_filter_suite_by_re(self):
1944
 
        filtered_suite = filter_suite_by_re(self.suite, 'test_filter_suite_by_r')
 
2691
        filtered_suite = tests.filter_suite_by_re(self.suite,
 
2692
                                                  'test_filter_suite_by_r')
1945
2693
        filtered_names = _test_ids(filtered_suite)
1946
2694
        self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
1947
2695
            'TestSelftestFiltering.test_filter_suite_by_re'])
1975
2723
 
1976
2724
    def test_preserve_input(self):
1977
2725
        # NB: Surely this is something in the stdlib to do this?
1978
 
        self.assertTrue(self.suite is preserve_input(self.suite))
1979
 
        self.assertTrue("@#$" is preserve_input("@#$"))
 
2726
        self.assertTrue(self.suite is tests.preserve_input(self.suite))
 
2727
        self.assertTrue("@#$" is tests.preserve_input("@#$"))
1980
2728
 
1981
2729
    def test_randomize_suite(self):
1982
 
        randomized_suite = randomize_suite(self.suite)
 
2730
        randomized_suite = tests.randomize_suite(self.suite)
1983
2731
        # randomizing should not add or remove test names.
1984
2732
        self.assertEqual(set(_test_ids(self.suite)),
1985
2733
                         set(_test_ids(randomized_suite)))
1995
2743
 
1996
2744
    def test_split_suit_by_condition(self):
1997
2745
        self.all_names = _test_ids(self.suite)
1998
 
        condition = condition_id_re('test_filter_suite_by_r')
1999
 
        split_suite = split_suite_by_condition(self.suite, condition)
 
2746
        condition = tests.condition_id_re('test_filter_suite_by_r')
 
2747
        split_suite = tests.split_suite_by_condition(self.suite, condition)
2000
2748
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2001
2749
            'test_filter_suite_by_re')
2002
2750
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2007
2755
 
2008
2756
    def test_split_suit_by_re(self):
2009
2757
        self.all_names = _test_ids(self.suite)
2010
 
        split_suite = split_suite_by_re(self.suite, 'test_filter_suite_by_r')
 
2758
        split_suite = tests.split_suite_by_re(self.suite,
 
2759
                                              'test_filter_suite_by_r')
2011
2760
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2012
2761
            'test_filter_suite_by_re')
2013
2762
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2017
2766
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2018
2767
 
2019
2768
 
2020
 
class TestCheckInventoryShape(TestCaseWithTransport):
 
2769
class TestCheckTreeShape(tests.TestCaseWithTransport):
2021
2770
 
2022
 
    def test_check_inventory_shape(self):
 
2771
    def test_check_tree_shape(self):
2023
2772
        files = ['a', 'b/', 'b/c']
2024
2773
        tree = self.make_branch_and_tree('.')
2025
2774
        self.build_tree(files)
2026
2775
        tree.add(files)
2027
2776
        tree.lock_read()
2028
2777
        try:
2029
 
            self.check_inventory_shape(tree.inventory, files)
 
2778
            self.check_tree_shape(tree, files)
2030
2779
        finally:
2031
2780
            tree.unlock()
2032
2781
 
2033
2782
 
2034
 
class TestBlackboxSupport(TestCase):
 
2783
class TestBlackboxSupport(tests.TestCase):
2035
2784
    """Tests for testsuite blackbox features."""
2036
2785
 
2037
2786
    def test_run_bzr_failure_not_caught(self):
2045
2794
        # the test framework
2046
2795
        self.assertEquals('always fails', str(e))
2047
2796
        # check that there's no traceback in the test log
2048
 
        self.assertNotContainsRe(self._get_log(keep_log_file=True),
2049
 
            r'Traceback')
 
2797
        self.assertNotContainsRe(self.get_log(), r'Traceback')
2050
2798
 
2051
2799
    def test_run_bzr_user_error_caught(self):
2052
2800
        # Running bzr in blackbox mode, normal/expected/user errors should be
2053
2801
        # caught in the regular way and turned into an error message plus exit
2054
2802
        # code.
2055
 
        out, err = self.run_bzr(["log", "/nonexistantpath"], retcode=3)
 
2803
        transport_server = memory.MemoryServer()
 
2804
        transport_server.start_server()
 
2805
        self.addCleanup(transport_server.stop_server)
 
2806
        url = transport_server.get_url()
 
2807
        self.permit_url(url)
 
2808
        out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
2056
2809
        self.assertEqual(out, '')
2057
2810
        self.assertContainsRe(err,
2058
2811
            'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
2059
2812
 
2060
2813
 
2061
 
class TestTestLoader(TestCase):
 
2814
class TestTestLoader(tests.TestCase):
2062
2815
    """Tests for the test loader."""
2063
2816
 
2064
2817
    def _get_loader_and_module(self):
2065
2818
        """Gets a TestLoader and a module with one test in it."""
2066
2819
        loader = TestUtil.TestLoader()
2067
2820
        module = {}
2068
 
        class Stub(TestCase):
 
2821
        class Stub(tests.TestCase):
2069
2822
            def test_foo(self):
2070
2823
                pass
2071
2824
        class MyModule(object):
2084
2837
        # load_tests do not need that :)
2085
2838
        def load_tests(self, standard_tests, module, loader):
2086
2839
            result = loader.suiteClass()
2087
 
            for test in iter_suite_tests(standard_tests):
 
2840
            for test in tests.iter_suite_tests(standard_tests):
2088
2841
                result.addTests([test, test])
2089
2842
            return result
2090
2843
        # add a load_tests() method which multiplies the tests from the module.
2109
2862
 
2110
2863
    def _create_suite(self, test_id_list):
2111
2864
 
2112
 
        class Stub(TestCase):
 
2865
        class Stub(tests.TestCase):
2113
2866
            def test_foo(self):
2114
2867
                pass
2115
2868
 
2125
2878
 
2126
2879
    def _test_ids(self, test_suite):
2127
2880
        """Get the ids for the tests in a test suite."""
2128
 
        return [t.id() for t in iter_suite_tests(test_suite)]
 
2881
        return [t.id() for t in tests.iter_suite_tests(test_suite)]
2129
2882
 
2130
2883
    def test_empty_list(self):
2131
2884
        id_list = self._create_id_list([])
2157
2910
        self.assertTrue(id_list.refers_to('mod.class'))
2158
2911
        self.assertTrue(id_list.refers_to('mod.class.meth'))
2159
2912
 
2160
 
    def test_test_suite(self):
2161
 
        # This test is slow, so we do a single test with one test in each
2162
 
        # category
2163
 
        test_list = [
2164
 
            # testmod_names
2165
 
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
2166
 
            'bzrlib.tests.test_selftest.TestTestIdList.test_test_suite',
2167
 
            # transport implementations
2168
 
            'bzrlib.tests.test_transport_implementations.TransportTests'
2169
 
            '.test_abspath(LocalURLServer)',
2170
 
            # modules_to_doctest
2171
 
            'bzrlib.timestamp.format_highres_date',
2172
 
            # plugins can't be tested that way since selftest may be run with
2173
 
            # --no-plugins
2174
 
            ]
2175
 
        suite = tests.test_suite(test_list)
2176
 
        self.assertEquals(test_list, _test_ids(suite))
2177
 
 
2178
2913
    def test_test_suite_matches_id_list_with_unknown(self):
2179
2914
        loader = TestUtil.TestLoader()
2180
2915
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2188
2923
        loader = TestUtil.TestLoader()
2189
2924
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2190
2925
        dupes = loader.suiteClass()
2191
 
        for test in iter_suite_tests(suite):
 
2926
        for test in tests.iter_suite_tests(suite):
2192
2927
            dupes.addTest(test)
2193
2928
            dupes.addTest(test) # Add it again
2194
2929
 
2200
2935
                          duplicates)
2201
2936
 
2202
2937
 
 
2938
class TestTestSuite(tests.TestCase):
 
2939
 
 
2940
    def test__test_suite_testmod_names(self):
 
2941
        # Test that a plausible list of test module names are returned
 
2942
        # by _test_suite_testmod_names.
 
2943
        test_list = tests._test_suite_testmod_names()
 
2944
        self.assertSubset([
 
2945
            'bzrlib.tests.blackbox',
 
2946
            'bzrlib.tests.per_transport',
 
2947
            'bzrlib.tests.test_selftest',
 
2948
            ],
 
2949
            test_list)
 
2950
 
 
2951
    def test__test_suite_modules_to_doctest(self):
 
2952
        # Test that a plausible list of modules to doctest is returned
 
2953
        # by _test_suite_modules_to_doctest.
 
2954
        test_list = tests._test_suite_modules_to_doctest()
 
2955
        if __doc__ is None:
 
2956
            # When docstrings are stripped, there are no modules to doctest
 
2957
            self.assertEqual([], test_list)
 
2958
            return
 
2959
        self.assertSubset([
 
2960
            'bzrlib.timestamp',
 
2961
            ],
 
2962
            test_list)
 
2963
 
 
2964
    def test_test_suite(self):
 
2965
        # test_suite() loads the entire test suite to operate. To avoid this
 
2966
        # overhead, and yet still be confident that things are happening,
 
2967
        # we temporarily replace two functions used by test_suite with 
 
2968
        # test doubles that supply a few sample tests to load, and check they
 
2969
        # are loaded.
 
2970
        calls = []
 
2971
        def testmod_names():
 
2972
            calls.append("testmod_names")
 
2973
            return [
 
2974
                'bzrlib.tests.blackbox.test_branch',
 
2975
                'bzrlib.tests.per_transport',
 
2976
                'bzrlib.tests.test_selftest',
 
2977
                ]
 
2978
        self.overrideAttr(tests, '_test_suite_testmod_names', testmod_names)
 
2979
        def doctests():
 
2980
            calls.append("modules_to_doctest")
 
2981
            if __doc__ is None:
 
2982
                return []
 
2983
            return ['bzrlib.timestamp']
 
2984
        self.overrideAttr(tests, '_test_suite_modules_to_doctest', doctests)
 
2985
        expected_test_list = [
 
2986
            # testmod_names
 
2987
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
 
2988
            ('bzrlib.tests.per_transport.TransportTests'
 
2989
             '.test_abspath(LocalTransport,LocalURLServer)'),
 
2990
            'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
 
2991
            # plugins can't be tested that way since selftest may be run with
 
2992
            # --no-plugins
 
2993
            ]
 
2994
        if __doc__ is not None:
 
2995
            expected_test_list.extend([
 
2996
                # modules_to_doctest
 
2997
                'bzrlib.timestamp.format_highres_date',
 
2998
                ])
 
2999
        suite = tests.test_suite()
 
3000
        self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
 
3001
            set(calls))
 
3002
        self.assertSubset(expected_test_list, _test_ids(suite))
 
3003
 
 
3004
    def test_test_suite_list_and_start(self):
 
3005
        # We cannot test this at the same time as the main load, because we want
 
3006
        # to know that starting_with == None works. So a second load is
 
3007
        # incurred - note that the starting_with parameter causes a partial load
 
3008
        # rather than a full load so this test should be pretty quick.
 
3009
        test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
 
3010
        suite = tests.test_suite(test_list,
 
3011
                                 ['bzrlib.tests.test_selftest.TestTestSuite'])
 
3012
        # test_test_suite_list_and_start is not included 
 
3013
        self.assertEquals(test_list, _test_ids(suite))
 
3014
 
 
3015
 
2203
3016
class TestLoadTestIdList(tests.TestCaseInTempDir):
2204
3017
 
2205
3018
    def _create_test_list_file(self, file_name, content):
2243
3056
    def test_load_tests(self):
2244
3057
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2245
3058
        loader = self._create_loader(test_list)
2246
 
 
2247
3059
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2248
3060
        self.assertEquals(test_list, _test_ids(suite))
2249
3061
 
2250
3062
    def test_exclude_tests(self):
2251
3063
        test_list = ['bogus']
2252
3064
        loader = self._create_loader(test_list)
2253
 
 
2254
3065
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2255
3066
        self.assertEquals([], _test_ids(suite))
2256
3067
 
2301
3112
        tpr.register('bar', 'bbb.aaa.rrr')
2302
3113
        tpr.register('bar', 'bBB.aAA.rRR')
2303
3114
        self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
2304
 
        self.assertContainsRe(self._get_log(keep_log_file=True),
2305
 
                              r'.*bar.*bbb.aaa.rrr.*bBB.aAA.rRR')
 
3115
        self.assertThat(self.get_log(),
 
3116
            DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR",
 
3117
                           doctest.ELLIPSIS))
2306
3118
 
2307
3119
    def test_get_unknown_prefix(self):
2308
3120
        tpr = self._get_registry()
2328
3140
        self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
2329
3141
 
2330
3142
 
2331
 
class TestRunSuite(TestCase):
 
3143
class TestThreadLeakDetection(tests.TestCase):
 
3144
    """Ensure when tests leak threads we detect and report it"""
 
3145
 
 
3146
    class LeakRecordingResult(tests.ExtendedTestResult):
 
3147
        def __init__(self):
 
3148
            tests.ExtendedTestResult.__init__(self, StringIO(), 0, 1)
 
3149
            self.leaks = []
 
3150
        def _report_thread_leak(self, test, leaks, alive):
 
3151
            self.leaks.append((test, leaks))
 
3152
 
 
3153
    def test_testcase_without_addCleanups(self):
 
3154
        """Check old TestCase instances don't break with leak detection"""
 
3155
        class Test(unittest.TestCase):
 
3156
            def runTest(self):
 
3157
                pass
 
3158
        result = self.LeakRecordingResult()
 
3159
        test = Test()
 
3160
        result.startTestRun()
 
3161
        test.run(result)
 
3162
        result.stopTestRun()
 
3163
        self.assertEqual(result._tests_leaking_threads_count, 0)
 
3164
        self.assertEqual(result.leaks, [])
 
3165
        
 
3166
    def test_thread_leak(self):
 
3167
        """Ensure a thread that outlives the running of a test is reported
 
3168
 
 
3169
        Uses a thread that blocks on an event, and is started by the inner
 
3170
        test case. As the thread outlives the inner case's run, it should be
 
3171
        detected as a leak, but the event is then set so that the thread can
 
3172
        be safely joined in cleanup so it's not leaked for real.
 
3173
        """
 
3174
        event = threading.Event()
 
3175
        thread = threading.Thread(name="Leaker", target=event.wait)
 
3176
        class Test(tests.TestCase):
 
3177
            def test_leak(self):
 
3178
                thread.start()
 
3179
        result = self.LeakRecordingResult()
 
3180
        test = Test("test_leak")
 
3181
        self.addCleanup(thread.join)
 
3182
        self.addCleanup(event.set)
 
3183
        result.startTestRun()
 
3184
        test.run(result)
 
3185
        result.stopTestRun()
 
3186
        self.assertEqual(result._tests_leaking_threads_count, 1)
 
3187
        self.assertEqual(result._first_thread_leaker_id, test.id())
 
3188
        self.assertEqual(result.leaks, [(test, set([thread]))])
 
3189
        self.assertContainsString(result.stream.getvalue(), "leaking threads")
 
3190
 
 
3191
    def test_multiple_leaks(self):
 
3192
        """Check multiple leaks are blamed on the test cases at fault
 
3193
 
 
3194
        Same concept as the previous test, but has one inner test method that
 
3195
        leaks two threads, and one that doesn't leak at all.
 
3196
        """
 
3197
        event = threading.Event()
 
3198
        thread_a = threading.Thread(name="LeakerA", target=event.wait)
 
3199
        thread_b = threading.Thread(name="LeakerB", target=event.wait)
 
3200
        thread_c = threading.Thread(name="LeakerC", target=event.wait)
 
3201
        class Test(tests.TestCase):
 
3202
            def test_first_leak(self):
 
3203
                thread_b.start()
 
3204
            def test_second_no_leak(self):
 
3205
                pass
 
3206
            def test_third_leak(self):
 
3207
                thread_c.start()
 
3208
                thread_a.start()
 
3209
        result = self.LeakRecordingResult()
 
3210
        first_test = Test("test_first_leak")
 
3211
        third_test = Test("test_third_leak")
 
3212
        self.addCleanup(thread_a.join)
 
3213
        self.addCleanup(thread_b.join)
 
3214
        self.addCleanup(thread_c.join)
 
3215
        self.addCleanup(event.set)
 
3216
        result.startTestRun()
 
3217
        unittest.TestSuite(
 
3218
            [first_test, Test("test_second_no_leak"), third_test]
 
3219
            ).run(result)
 
3220
        result.stopTestRun()
 
3221
        self.assertEqual(result._tests_leaking_threads_count, 2)
 
3222
        self.assertEqual(result._first_thread_leaker_id, first_test.id())
 
3223
        self.assertEqual(result.leaks, [
 
3224
            (first_test, set([thread_b])),
 
3225
            (third_test, set([thread_a, thread_c]))])
 
3226
        self.assertContainsString(result.stream.getvalue(), "leaking threads")
 
3227
 
 
3228
 
 
3229
class TestPostMortemDebugging(tests.TestCase):
 
3230
    """Check post mortem debugging works when tests fail or error"""
 
3231
 
 
3232
    class TracebackRecordingResult(tests.ExtendedTestResult):
 
3233
        def __init__(self):
 
3234
            tests.ExtendedTestResult.__init__(self, StringIO(), 0, 1)
 
3235
            self.postcode = None
 
3236
        def _post_mortem(self, tb=None):
 
3237
            """Record the code object at the end of the current traceback"""
 
3238
            tb = tb or sys.exc_info()[2]
 
3239
            if tb is not None:
 
3240
                next = tb.tb_next
 
3241
                while next is not None:
 
3242
                    tb = next
 
3243
                    next = next.tb_next
 
3244
                self.postcode = tb.tb_frame.f_code
 
3245
        def report_error(self, test, err):
 
3246
            pass
 
3247
        def report_failure(self, test, err):
 
3248
            pass
 
3249
 
 
3250
    def test_location_unittest_error(self):
 
3251
        """Needs right post mortem traceback with erroring unittest case"""
 
3252
        class Test(unittest.TestCase):
 
3253
            def runTest(self):
 
3254
                raise RuntimeError
 
3255
        result = self.TracebackRecordingResult()
 
3256
        Test().run(result)
 
3257
        self.assertEqual(result.postcode, Test.runTest.func_code)
 
3258
 
 
3259
    def test_location_unittest_failure(self):
 
3260
        """Needs right post mortem traceback with failing unittest case"""
 
3261
        class Test(unittest.TestCase):
 
3262
            def runTest(self):
 
3263
                raise self.failureException
 
3264
        result = self.TracebackRecordingResult()
 
3265
        Test().run(result)
 
3266
        self.assertEqual(result.postcode, Test.runTest.func_code)
 
3267
 
 
3268
    def test_location_bt_error(self):
 
3269
        """Needs right post mortem traceback with erroring bzrlib.tests case"""
 
3270
        class Test(tests.TestCase):
 
3271
            def test_error(self):
 
3272
                raise RuntimeError
 
3273
        result = self.TracebackRecordingResult()
 
3274
        Test("test_error").run(result)
 
3275
        self.assertEqual(result.postcode, Test.test_error.func_code)
 
3276
 
 
3277
    def test_location_bt_failure(self):
 
3278
        """Needs right post mortem traceback with failing bzrlib.tests case"""
 
3279
        class Test(tests.TestCase):
 
3280
            def test_failure(self):
 
3281
                raise self.failureException
 
3282
        result = self.TracebackRecordingResult()
 
3283
        Test("test_failure").run(result)
 
3284
        self.assertEqual(result.postcode, Test.test_failure.func_code)
 
3285
 
 
3286
    def test_env_var_triggers_post_mortem(self):
 
3287
        """Check pdb.post_mortem is called iff BZR_TEST_PDB is set"""
 
3288
        import pdb
 
3289
        result = tests.ExtendedTestResult(StringIO(), 0, 1)
 
3290
        post_mortem_calls = []
 
3291
        self.overrideAttr(pdb, "post_mortem", post_mortem_calls.append)
 
3292
        self.overrideEnv('BZR_TEST_PDB', None)
 
3293
        result._post_mortem(1)
 
3294
        self.overrideEnv('BZR_TEST_PDB', 'on')
 
3295
        result._post_mortem(2)
 
3296
        self.assertEqual([2], post_mortem_calls)
 
3297
 
 
3298
 
 
3299
class TestRunSuite(tests.TestCase):
2332
3300
 
2333
3301
    def test_runner_class(self):
2334
3302
        """run_suite accepts and uses a runner_class keyword argument."""
2335
 
        class Stub(TestCase):
 
3303
        class Stub(tests.TestCase):
2336
3304
            def test_foo(self):
2337
3305
                pass
2338
3306
        suite = Stub("test_foo")
2339
3307
        calls = []
2340
 
        class MyRunner(TextTestRunner):
 
3308
        class MyRunner(tests.TextTestRunner):
2341
3309
            def run(self, test):
2342
3310
                calls.append(test)
2343
 
                return ExtendedTestResult(self.stream, self.descriptions,
2344
 
                    self.verbosity)
2345
 
        run_suite(suite, runner_class=MyRunner)
2346
 
        self.assertEqual(calls, [suite])
 
3311
                return tests.ExtendedTestResult(self.stream, self.descriptions,
 
3312
                                                self.verbosity)
 
3313
        tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
 
3314
        self.assertLength(1, calls)
 
3315
 
 
3316
 
 
3317
class TestEnvironHandling(tests.TestCase):
 
3318
 
 
3319
    def test_overrideEnv_None_called_twice_doesnt_leak(self):
 
3320
        self.assertFalse('MYVAR' in os.environ)
 
3321
        self.overrideEnv('MYVAR', '42')
 
3322
        # We use an embedded test to make sure we fix the _captureVar bug
 
3323
        class Test(tests.TestCase):
 
3324
            def test_me(self):
 
3325
                # The first call save the 42 value
 
3326
                self.overrideEnv('MYVAR', None)
 
3327
                self.assertEquals(None, os.environ.get('MYVAR'))
 
3328
                # Make sure we can call it twice
 
3329
                self.overrideEnv('MYVAR', None)
 
3330
                self.assertEquals(None, os.environ.get('MYVAR'))
 
3331
        output = StringIO()
 
3332
        result = tests.TextTestResult(output, 0, 1)
 
3333
        Test('test_me').run(result)
 
3334
        if not result.wasStrictlySuccessful():
 
3335
            self.fail(output.getvalue())
 
3336
        # We get our value back
 
3337
        self.assertEquals('42', os.environ.get('MYVAR'))
 
3338
 
 
3339
 
 
3340
class TestIsolatedEnv(tests.TestCase):
 
3341
    """Test isolating tests from os.environ.
 
3342
 
 
3343
    Since we use tests that are already isolated from os.environ a bit of care
 
3344
    should be taken when designing the tests to avoid bootstrap side-effects.
 
3345
    The tests start an already clean os.environ which allow doing valid
 
3346
    assertions about which variables are present or not and design tests around
 
3347
    these assertions.
 
3348
    """
 
3349
 
 
3350
    class ScratchMonkey(tests.TestCase):
 
3351
 
 
3352
        def test_me(self):
 
3353
            pass
 
3354
 
 
3355
    def test_basics(self):
 
3356
        # Make sure we know the definition of BZR_HOME: not part of os.environ
 
3357
        # for tests.TestCase.
 
3358
        self.assertTrue('BZR_HOME' in tests.isolated_environ)
 
3359
        self.assertEquals(None, tests.isolated_environ['BZR_HOME'])
 
3360
        # Being part of isolated_environ, BZR_HOME should not appear here
 
3361
        self.assertFalse('BZR_HOME' in os.environ)
 
3362
        # Make sure we know the definition of LINES: part of os.environ for
 
3363
        # tests.TestCase
 
3364
        self.assertTrue('LINES' in tests.isolated_environ)
 
3365
        self.assertEquals('25', tests.isolated_environ['LINES'])
 
3366
        self.assertEquals('25', os.environ['LINES'])
 
3367
 
 
3368
    def test_injecting_unknown_variable(self):
 
3369
        # BZR_HOME is known to be absent from os.environ
 
3370
        test = self.ScratchMonkey('test_me')
 
3371
        tests.override_os_environ(test, {'BZR_HOME': 'foo'})
 
3372
        self.assertEquals('foo', os.environ['BZR_HOME'])
 
3373
        tests.restore_os_environ(test)
 
3374
        self.assertFalse('BZR_HOME' in os.environ)
 
3375
 
 
3376
    def test_injecting_known_variable(self):
 
3377
        test = self.ScratchMonkey('test_me')
 
3378
        # LINES is known to be present in os.environ
 
3379
        tests.override_os_environ(test, {'LINES': '42'})
 
3380
        self.assertEquals('42', os.environ['LINES'])
 
3381
        tests.restore_os_environ(test)
 
3382
        self.assertEquals('25', os.environ['LINES'])
 
3383
 
 
3384
    def test_deleting_variable(self):
 
3385
        test = self.ScratchMonkey('test_me')
 
3386
        # LINES is known to be present in os.environ
 
3387
        tests.override_os_environ(test, {'LINES': None})
 
3388
        self.assertTrue('LINES' not in os.environ)
 
3389
        tests.restore_os_environ(test)
 
3390
        self.assertEquals('25', os.environ['LINES'])
 
3391
 
 
3392
 
 
3393
class TestDocTestSuiteIsolation(tests.TestCase):
 
3394
    """Test that `tests.DocTestSuite` isolates doc tests from os.environ.
 
3395
 
 
3396
    Since tests.TestCase alreay provides an isolation from os.environ, we use
 
3397
    the clean environment as a base for testing. To precisely capture the
 
3398
    isolation provided by tests.DocTestSuite, we use doctest.DocTestSuite to
 
3399
    compare against.
 
3400
 
 
3401
    We want to make sure `tests.DocTestSuite` respect `tests.isolated_environ`,
 
3402
    not `os.environ` so each test overrides it to suit its needs.
 
3403
 
 
3404
    """
 
3405
 
 
3406
    def get_doctest_suite_for_string(self, klass, string):
 
3407
        class Finder(doctest.DocTestFinder):
 
3408
 
 
3409
            def find(*args, **kwargs):
 
3410
                test = doctest.DocTestParser().get_doctest(
 
3411
                    string, {}, 'foo', 'foo.py', 0)
 
3412
                return [test]
 
3413
 
 
3414
        suite = klass(test_finder=Finder())
 
3415
        return suite
 
3416
 
 
3417
    def run_doctest_suite_for_string(self, klass, string):
 
3418
        suite = self.get_doctest_suite_for_string(klass, string)
 
3419
        output = StringIO()
 
3420
        result = tests.TextTestResult(output, 0, 1)
 
3421
        suite.run(result)
 
3422
        return result, output
 
3423
 
 
3424
    def assertDocTestStringSucceds(self, klass, string):
 
3425
        result, output = self.run_doctest_suite_for_string(klass, string)
 
3426
        if not result.wasStrictlySuccessful():
 
3427
            self.fail(output.getvalue())
 
3428
 
 
3429
    def assertDocTestStringFails(self, klass, string):
 
3430
        result, output = self.run_doctest_suite_for_string(klass, string)
 
3431
        if result.wasStrictlySuccessful():
 
3432
            self.fail(output.getvalue())
 
3433
 
 
3434
    def test_injected_variable(self):
 
3435
        self.overrideAttr(tests, 'isolated_environ', {'LINES': '42'})
 
3436
        test = """
 
3437
            >>> import os
 
3438
            >>> os.environ['LINES']
 
3439
            '42'
 
3440
            """
 
3441
        # doctest.DocTestSuite fails as it sees '25'
 
3442
        self.assertDocTestStringFails(doctest.DocTestSuite, test)
 
3443
        # tests.DocTestSuite sees '42'
 
3444
        self.assertDocTestStringSucceds(tests.IsolatedDocTestSuite, test)
 
3445
 
 
3446
    def test_deleted_variable(self):
 
3447
        self.overrideAttr(tests, 'isolated_environ', {'LINES': None})
 
3448
        test = """
 
3449
            >>> import os
 
3450
            >>> os.environ.get('LINES')
 
3451
            """
 
3452
        # doctest.DocTestSuite fails as it sees '25'
 
3453
        self.assertDocTestStringFails(doctest.DocTestSuite, test)
 
3454
        # tests.DocTestSuite sees None
 
3455
        self.assertDocTestStringSucceds(tests.IsolatedDocTestSuite, test)
 
3456
 
 
3457
 
 
3458
class TestSelftestExcludePatterns(tests.TestCase):
 
3459
 
 
3460
    def setUp(self):
 
3461
        super(TestSelftestExcludePatterns, self).setUp()
 
3462
        self.overrideAttr(tests, 'test_suite', self.suite_factory)
 
3463
 
 
3464
    def suite_factory(self, keep_only=None, starting_with=None):
 
3465
        """A test suite factory with only a few tests."""
 
3466
        class Test(tests.TestCase):
 
3467
            def id(self):
 
3468
                # We don't need the full class path
 
3469
                return self._testMethodName
 
3470
            def a(self):
 
3471
                pass
 
3472
            def b(self):
 
3473
                pass
 
3474
            def c(self):
 
3475
                pass
 
3476
        return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
 
3477
 
 
3478
    def assertTestList(self, expected, *selftest_args):
 
3479
        # We rely on setUp installing the right test suite factory so we can
 
3480
        # test at the command level without loading the whole test suite
 
3481
        out, err = self.run_bzr(('selftest', '--list') + selftest_args)
 
3482
        actual = out.splitlines()
 
3483
        self.assertEquals(expected, actual)
 
3484
 
 
3485
    def test_full_list(self):
 
3486
        self.assertTestList(['a', 'b', 'c'])
 
3487
 
 
3488
    def test_single_exclude(self):
 
3489
        self.assertTestList(['b', 'c'], '-x', 'a')
 
3490
 
 
3491
    def test_mutiple_excludes(self):
 
3492
        self.assertTestList(['c'], '-x', 'a', '-x', 'b')
 
3493
 
 
3494
 
 
3495
class TestCounterHooks(tests.TestCase, SelfTestHelper):
 
3496
 
 
3497
    _test_needs_features = [features.subunit]
 
3498
 
 
3499
    def setUp(self):
 
3500
        super(TestCounterHooks, self).setUp()
 
3501
        class Test(tests.TestCase):
 
3502
 
 
3503
            def setUp(self):
 
3504
                super(Test, self).setUp()
 
3505
                self.hooks = hooks.Hooks()
 
3506
                self.hooks.add_hook('myhook', 'Foo bar blah', (2,4))
 
3507
                self.install_counter_hook(self.hooks, 'myhook')
 
3508
 
 
3509
            def no_hook(self):
 
3510
                pass
 
3511
 
 
3512
            def run_hook_once(self):
 
3513
                for hook in self.hooks['myhook']:
 
3514
                    hook(self)
 
3515
 
 
3516
        self.test_class = Test
 
3517
 
 
3518
    def assertHookCalls(self, expected_calls, test_name):
 
3519
        test = self.test_class(test_name)
 
3520
        result = unittest.TestResult()
 
3521
        test.run(result)
 
3522
        self.assertTrue(hasattr(test, '_counters'))
 
3523
        self.assertTrue(test._counters.has_key('myhook'))
 
3524
        self.assertEquals(expected_calls, test._counters['myhook'])
 
3525
 
 
3526
    def test_no_hook(self):
 
3527
        self.assertHookCalls(0, 'no_hook')
 
3528
 
 
3529
    def test_run_hook_once(self):
 
3530
        tt = features.testtools
 
3531
        if tt.module.__version__ < (0, 9, 8):
 
3532
            raise tests.TestSkipped('testtools-0.9.8 required for addDetail')
 
3533
        self.assertHookCalls(1, 'run_hook_once')