/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Andrew Bennetts
  • Date: 2009-07-08 02:23:24 UTC
  • mto: (4476.3.44 inventory-delta)
  • mto: This revision was merged to the branch mainline in revision 4608.
  • Revision ID: andrew.bennetts@canonical.com-20090708022324-jka0d4wnu239e7g2
Clean up some more nits.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
16
16
 
17
17
"""Tests for the test framework."""
18
18
 
19
 
from cStringIO import StringIO
20
 
from doctest import ELLIPSIS
 
19
import cStringIO
21
20
import os
22
 
import signal
 
21
from StringIO import StringIO
23
22
import sys
24
23
import time
25
24
import unittest
26
25
import warnings
27
26
 
28
 
from testtools import MultiTestResult
29
 
from testtools.content_type import ContentType
30
 
from testtools.matchers import (
31
 
    DocTestMatches,
32
 
    Equals,
33
 
    )
34
 
import testtools.tests.helpers
35
 
 
36
27
import bzrlib
37
28
from bzrlib import (
38
29
    branchbuilder,
42
33
    lockdir,
43
34
    memorytree,
44
35
    osutils,
45
 
    progress,
46
36
    remote,
47
37
    repository,
48
38
    symbol_versioning,
49
39
    tests,
50
 
    transport,
51
40
    workingtree,
52
41
    )
 
42
from bzrlib.progress import _BaseProgressBar
53
43
from bzrlib.repofmt import (
54
 
    groupcompress_repo,
55
44
    pack_repo,
56
45
    weaverepo,
57
46
    )
61
50
    deprecated_method,
62
51
    )
63
52
from bzrlib.tests import (
64
 
    features,
65
 
    test_lsprof,
66
 
    test_server,
67
 
    test_sftp_transport,
68
 
    TestUtil,
69
 
    )
 
53
                          ChrootedTestCase,
 
54
                          ExtendedTestResult,
 
55
                          Feature,
 
56
                          KnownFailure,
 
57
                          TestCase,
 
58
                          TestCaseInTempDir,
 
59
                          TestCaseWithMemoryTransport,
 
60
                          TestCaseWithTransport,
 
61
                          TestNotApplicable,
 
62
                          TestSkipped,
 
63
                          TestSuite,
 
64
                          TestUtil,
 
65
                          TextTestRunner,
 
66
                          UnavailableFeature,
 
67
                          condition_id_re,
 
68
                          condition_isinstance,
 
69
                          exclude_tests_by_condition,
 
70
                          exclude_tests_by_re,
 
71
                          filter_suite_by_condition,
 
72
                          filter_suite_by_re,
 
73
                          iter_suite_tests,
 
74
                          preserve_input,
 
75
                          randomize_suite,
 
76
                          run_suite,
 
77
                          split_suite_by_condition,
 
78
                          split_suite_by_re,
 
79
                          test_lsprof,
 
80
                          test_suite,
 
81
                          )
 
82
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
 
83
from bzrlib.tests.TestUtil import _load_module_by_name
70
84
from bzrlib.trace import note
71
 
from bzrlib.transport import memory
 
85
from bzrlib.transport.memory import MemoryServer, MemoryTransport
72
86
from bzrlib.version import _get_bzr_source_tree
73
87
 
74
88
 
75
89
def _test_ids(test_suite):
76
90
    """Get the ids for the tests in a test suite."""
77
 
    return [t.id() for t in tests.iter_suite_tests(test_suite)]
78
 
 
79
 
 
80
 
class SelftestTests(tests.TestCase):
 
91
    return [t.id() for t in iter_suite_tests(test_suite)]
 
92
 
 
93
 
 
94
class SelftestTests(TestCase):
81
95
 
82
96
    def test_import_tests(self):
83
 
        mod = TestUtil._load_module_by_name('bzrlib.tests.test_selftest')
 
97
        mod = _load_module_by_name('bzrlib.tests.test_selftest')
84
98
        self.assertEqual(mod.SelftestTests, SelftestTests)
85
99
 
86
100
    def test_import_test_failure(self):
87
101
        self.assertRaises(ImportError,
88
 
                          TestUtil._load_module_by_name,
 
102
                          _load_module_by_name,
89
103
                          'bzrlib.no-name-yet')
90
104
 
91
 
 
92
 
class MetaTestLog(tests.TestCase):
 
105
class MetaTestLog(TestCase):
93
106
 
94
107
    def test_logging(self):
95
108
        """Test logs are captured when a test fails."""
96
109
        self.log('a test message')
97
 
        details = self.getDetails()
98
 
        log = details['log']
99
 
        self.assertThat(log.content_type, Equals(ContentType(
100
 
            "text", "plain", {"charset": "utf8"})))
101
 
        self.assertThat(u"".join(log.iter_text()), Equals(self.get_log()))
102
 
        self.assertThat(self.get_log(),
103
 
            DocTestMatches(u"...a test message\n", ELLIPSIS))
104
 
 
105
 
 
106
 
class TestUnicodeFilename(tests.TestCase):
 
110
        self._log_file.flush()
 
111
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
112
                              'a test message\n')
 
113
 
 
114
 
 
115
class TestUnicodeFilename(TestCase):
107
116
 
108
117
    def test_probe_passes(self):
109
118
        """UnicodeFilename._probe passes."""
112
121
        tests.UnicodeFilename._probe()
113
122
 
114
123
 
115
 
class TestTreeShape(tests.TestCaseInTempDir):
 
124
class TestTreeShape(TestCaseInTempDir):
116
125
 
117
126
    def test_unicode_paths(self):
118
127
        self.requireFeature(tests.UnicodeFilename)
122
131
        self.failUnlessExists(filename)
123
132
 
124
133
 
125
 
class TestTransportScenarios(tests.TestCase):
 
134
class TestTransportScenarios(TestCase):
126
135
    """A group of tests that test the transport implementation adaption core.
127
136
 
128
137
    This is a meta test that the tests are applied to all available
139
148
            def get_test_permutations(self):
140
149
                return sample_permutation
141
150
        sample_permutation = [(1,2), (3,4)]
142
 
        from bzrlib.tests.per_transport import get_transport_test_permutations
 
151
        from bzrlib.tests.test_transport_implementations \
 
152
            import get_transport_test_permutations
143
153
        self.assertEqual(sample_permutation,
144
154
                         get_transport_test_permutations(MockModule()))
145
155
 
148
158
        # as there are in all the registered transport modules - we assume if
149
159
        # this matches its probably doing the right thing especially in
150
160
        # combination with the tests for setting the right classes below.
151
 
        from bzrlib.tests.per_transport import transport_test_permutations
 
161
        from bzrlib.tests.test_transport_implementations \
 
162
            import transport_test_permutations
152
163
        from bzrlib.transport import _get_transport_modules
153
164
        modules = _get_transport_modules()
154
165
        permutation_count = 0
166
177
        # This test used to know about all the possible transports and the
167
178
        # order they were returned but that seems overly brittle (mbp
168
179
        # 20060307)
169
 
        from bzrlib.tests.per_transport import transport_test_permutations
 
180
        from bzrlib.tests.test_transport_implementations \
 
181
            import transport_test_permutations
170
182
        scenarios = transport_test_permutations()
171
183
        # there are at least that many builtin transports
172
184
        self.assertTrue(len(scenarios) > 6)
178
190
                                   bzrlib.transport.Server))
179
191
 
180
192
 
181
 
class TestBranchScenarios(tests.TestCase):
 
193
class TestBranchScenarios(TestCase):
182
194
 
183
195
    def test_scenarios(self):
184
196
        # check that constructor parameters are passed through to the adapted
185
197
        # test.
186
 
        from bzrlib.tests.per_branch import make_scenarios
 
198
        from bzrlib.tests.branch_implementations import make_scenarios
187
199
        server1 = "a"
188
200
        server2 = "b"
189
201
        formats = [("c", "C"), ("d", "D")]
203
215
            scenarios)
204
216
 
205
217
 
206
 
class TestBzrDirScenarios(tests.TestCase):
 
218
class TestBzrDirScenarios(TestCase):
207
219
 
208
220
    def test_scenarios(self):
209
221
        # check that constructor parameters are passed through to the adapted
210
222
        # test.
211
 
        from bzrlib.tests.per_bzrdir import make_scenarios
 
223
        from bzrlib.tests.bzrdir_implementations import make_scenarios
212
224
        vfs_factory = "v"
213
225
        server1 = "a"
214
226
        server2 = "b"
228
240
            scenarios)
229
241
 
230
242
 
231
 
class TestRepositoryScenarios(tests.TestCase):
 
243
class TestRepositoryScenarios(TestCase):
232
244
 
233
245
    def test_formats_to_scenarios(self):
234
246
        from bzrlib.tests.per_repository import formats_to_scenarios
235
247
        formats = [("(c)", remote.RemoteRepositoryFormat()),
236
248
                   ("(d)", repository.format_registry.get(
237
 
                    'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
 
249
                        'Bazaar pack repository format 1 (needs bzr 0.92)\n'))]
238
250
        no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
239
251
            None)
240
252
        vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
241
253
            vfs_transport_factory="vfs")
242
254
        # no_vfs generate scenarios without vfs_transport_factory
243
 
        expected = [
 
255
        self.assertEqual([
244
256
            ('RemoteRepositoryFormat(c)',
245
257
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
246
258
              'repository_format': remote.RemoteRepositoryFormat(),
247
259
              'transport_readonly_server': 'readonly',
248
260
              'transport_server': 'server'}),
249
 
            ('RepositoryFormat2a(d)',
 
261
            ('RepositoryFormatKnitPack1(d)',
250
262
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
251
 
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
263
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
252
264
              'transport_readonly_server': 'readonly',
253
 
              'transport_server': 'server'})]
254
 
        self.assertEqual(expected, no_vfs_scenarios)
 
265
              'transport_server': 'server'})],
 
266
            no_vfs_scenarios)
255
267
        self.assertEqual([
256
268
            ('RemoteRepositoryFormat(c)',
257
269
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
259
271
              'transport_readonly_server': 'readonly',
260
272
              'transport_server': 'server',
261
273
              'vfs_transport_factory': 'vfs'}),
262
 
            ('RepositoryFormat2a(d)',
 
274
            ('RepositoryFormatKnitPack1(d)',
263
275
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
264
 
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
276
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
265
277
              'transport_readonly_server': 'readonly',
266
278
              'transport_server': 'server',
267
279
              'vfs_transport_factory': 'vfs'})],
268
280
            vfs_scenarios)
269
281
 
270
282
 
271
 
class TestTestScenarioApplication(tests.TestCase):
 
283
class TestTestScenarioApplication(TestCase):
272
284
    """Tests for the test adaption facilities."""
273
285
 
274
286
    def test_apply_scenario(self):
304
316
            adapted_test2.id())
305
317
 
306
318
 
307
 
class TestInterRepositoryScenarios(tests.TestCase):
 
319
class TestInterRepositoryScenarios(TestCase):
308
320
 
309
321
    def test_scenarios(self):
310
322
        # check that constructor parameters are passed through to the adapted
311
323
        # test.
312
 
        from bzrlib.tests.per_interrepository import make_scenarios
 
324
        from bzrlib.tests.interrepository_implementations import \
 
325
            make_scenarios
313
326
        server1 = "a"
314
327
        server2 = "b"
315
 
        formats = [("C0", "C1", "C2"), ("D0", "D1", "D2")]
 
328
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
316
329
        scenarios = make_scenarios(server1, server2, formats)
317
330
        self.assertEqual([
318
 
            ('C0,str,str',
 
331
            ('str,str,str',
319
332
             {'repository_format': 'C1',
320
333
              'repository_format_to': 'C2',
321
334
              'transport_readonly_server': 'b',
322
335
              'transport_server': 'a'}),
323
 
            ('D0,str,str',
 
336
            ('int,str,str',
324
337
             {'repository_format': 'D1',
325
338
              'repository_format_to': 'D2',
326
339
              'transport_readonly_server': 'b',
328
341
            scenarios)
329
342
 
330
343
 
331
 
class TestWorkingTreeScenarios(tests.TestCase):
 
344
class TestWorkingTreeScenarios(TestCase):
332
345
 
333
346
    def test_scenarios(self):
334
347
        # check that constructor parameters are passed through to the adapted
335
348
        # test.
336
 
        from bzrlib.tests.per_workingtree import make_scenarios
 
349
        from bzrlib.tests.workingtree_implementations \
 
350
            import make_scenarios
337
351
        server1 = "a"
338
352
        server2 = "b"
339
353
        formats = [workingtree.WorkingTreeFormat2(),
353
367
            scenarios)
354
368
 
355
369
 
356
 
class TestTreeScenarios(tests.TestCase):
 
370
class TestTreeScenarios(TestCase):
357
371
 
358
372
    def test_scenarios(self):
359
373
        # the tree implementation scenario generator is meant to setup one
363
377
        # workingtree_to_test_tree attribute set to 'return_parameter' and the
364
378
        # revision one set to revision_tree_from_workingtree.
365
379
 
366
 
        from bzrlib.tests.per_tree import (
 
380
        from bzrlib.tests.tree_implementations import (
367
381
            _dirstate_tree_from_workingtree,
368
382
            make_scenarios,
369
383
            preview_tree_pre,
432
446
        self.assertEqual(expected_scenarios, scenarios)
433
447
 
434
448
 
435
 
class TestInterTreeScenarios(tests.TestCase):
 
449
class TestInterTreeScenarios(TestCase):
436
450
    """A group of tests that test the InterTreeTestAdapter."""
437
451
 
438
452
    def test_scenarios(self):
445
459
        # unlike the TestProviderAdapter we dont want to automatically add a
446
460
        # parameterized one for WorkingTree - the optimisers will tell us what
447
461
        # ones to add.
448
 
        from bzrlib.tests.per_tree import (
 
462
        from bzrlib.tests.tree_implementations import (
449
463
            return_parameter,
450
464
            revision_tree_from_workingtree
451
465
            )
452
 
        from bzrlib.tests.per_intertree import (
 
466
        from bzrlib.tests.intertree_implementations import (
453
467
            make_scenarios,
454
468
            )
455
469
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
488
502
        self.assertEqual(scenarios, expected_scenarios)
489
503
 
490
504
 
491
 
class TestTestCaseInTempDir(tests.TestCaseInTempDir):
 
505
class TestTestCaseInTempDir(TestCaseInTempDir):
492
506
 
493
507
    def test_home_is_not_working(self):
494
508
        self.assertNotEqual(self.test_dir, self.test_home_dir)
505
519
        self.assertEqualStat(real, fake)
506
520
 
507
521
    def test_assertEqualStat_notequal(self):
508
 
        self.build_tree(["foo", "longname"])
 
522
        self.build_tree(["foo", "bar"])
509
523
        self.assertRaises(AssertionError, self.assertEqualStat,
510
 
            os.lstat("foo"), os.lstat("longname"))
511
 
 
512
 
 
513
 
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
 
524
            os.lstat("foo"), os.lstat("bar"))
 
525
 
 
526
 
 
527
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
514
528
 
515
529
    def test_home_is_non_existant_dir_under_root(self):
516
530
        """The test_home_dir for TestCaseWithMemoryTransport is missing.
531
545
        cwd = osutils.getcwd()
532
546
        self.assertIsSameRealPath(self.test_dir, cwd)
533
547
 
534
 
    def test_BZR_HOME_and_HOME_are_bytestrings(self):
535
 
        """The $BZR_HOME and $HOME environment variables should not be unicode.
536
 
 
537
 
        See https://bugs.launchpad.net/bzr/+bug/464174
538
 
        """
539
 
        self.assertIsInstance(os.environ['BZR_HOME'], str)
540
 
        self.assertIsInstance(os.environ['HOME'], str)
541
 
 
542
548
    def test_make_branch_and_memory_tree(self):
543
549
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
544
550
 
600
606
                         self.get_transport().get_bytes(
601
607
                            'dir/.bzr/repository/format'))
602
608
 
 
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
 
603
622
    def test_dangling_locks_cause_failures(self):
604
 
        class TestDanglingLock(tests.TestCaseWithMemoryTransport):
 
623
        class TestDanglingLock(TestCaseWithMemoryTransport):
605
624
            def test_function(self):
606
625
                t = self.get_transport('.')
607
626
                l = lockdir.LockDir(t, 'lock')
609
628
                l.attempt_lock()
610
629
        test = TestDanglingLock('test_function')
611
630
        result = test.run()
612
 
        if self._lock_check_thorough:
613
 
            self.assertEqual(1, len(result.errors))
614
 
        else:
615
 
            # When _lock_check_thorough is disabled, then we don't trigger a
616
 
            # failure
617
 
            self.assertEqual(0, len(result.errors))
618
 
 
619
 
 
620
 
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
 
631
        self.assertEqual(1, len(result.errors))
 
632
 
 
633
 
 
634
class TestTestCaseWithTransport(TestCaseWithTransport):
621
635
    """Tests for the convenience functions TestCaseWithTransport introduces."""
622
636
 
623
637
    def test_get_readonly_url_none(self):
624
638
        from bzrlib.transport import get_transport
 
639
        from bzrlib.transport.memory import MemoryServer
625
640
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
626
 
        self.vfs_transport_factory = memory.MemoryServer
 
641
        self.vfs_transport_factory = MemoryServer
627
642
        self.transport_readonly_server = None
628
643
        # calling get_readonly_transport() constructs a decorator on the url
629
644
        # for the server
638
653
    def test_get_readonly_url_http(self):
639
654
        from bzrlib.tests.http_server import HttpServer
640
655
        from bzrlib.transport import get_transport
 
656
        from bzrlib.transport.local import LocalURLServer
641
657
        from bzrlib.transport.http import HttpTransportBase
642
 
        self.transport_server = test_server.LocalURLServer
 
658
        self.transport_server = LocalURLServer
643
659
        self.transport_readonly_server = HttpServer
644
660
        # calling get_readonly_transport() gives us a HTTP server instance.
645
661
        url = self.get_readonly_url()
672
688
        self.assertEqual((1, rev_id), a_branch.last_revision_info())
673
689
 
674
690
 
675
 
class TestTestCaseTransports(tests.TestCaseWithTransport):
 
691
class TestTestCaseTransports(TestCaseWithTransport):
676
692
 
677
693
    def setUp(self):
678
694
        super(TestTestCaseTransports, self).setUp()
679
 
        self.vfs_transport_factory = memory.MemoryServer
 
695
        self.vfs_transport_factory = MemoryServer
680
696
 
681
697
    def test_make_bzrdir_preserves_transport(self):
682
698
        t = self.get_transport()
683
699
        result_bzrdir = self.make_bzrdir('subdir')
684
700
        self.assertIsInstance(result_bzrdir.transport,
685
 
                              memory.MemoryTransport)
 
701
                              MemoryTransport)
686
702
        # should not be on disk, should only be in memory
687
703
        self.failIfExists('subdir')
688
704
 
689
705
 
690
 
class TestChrootedTest(tests.ChrootedTestCase):
 
706
class TestChrootedTest(ChrootedTestCase):
691
707
 
692
708
    def test_root_is_root(self):
693
709
        from bzrlib.transport import get_transport
696
712
        self.assertEqual(url, t.clone('..').base)
697
713
 
698
714
 
699
 
class TestProfileResult(tests.TestCase):
700
 
 
701
 
    def test_profiles_tests(self):
702
 
        self.requireFeature(test_lsprof.LSProfFeature)
703
 
        terminal = testtools.tests.helpers.ExtendedTestResult()
704
 
        result = tests.ProfileResult(terminal)
705
 
        class Sample(tests.TestCase):
706
 
            def a(self):
707
 
                self.sample_function()
708
 
            def sample_function(self):
709
 
                pass
710
 
        test = Sample("a")
711
 
        test.run(result)
712
 
        case = terminal._events[0][1]
713
 
        self.assertLength(1, case._benchcalls)
714
 
        # We must be able to unpack it as the test reporting code wants
715
 
        (_, _, _), stats = case._benchcalls[0]
716
 
        self.assertTrue(callable(stats.pprint))
717
 
 
718
 
 
719
 
class TestTestResult(tests.TestCase):
 
715
class MockProgress(_BaseProgressBar):
 
716
    """Progress-bar standin that records calls.
 
717
 
 
718
    Useful for testing pb using code.
 
719
    """
 
720
 
 
721
    def __init__(self):
 
722
        _BaseProgressBar.__init__(self)
 
723
        self.calls = []
 
724
 
 
725
    def tick(self):
 
726
        self.calls.append(('tick',))
 
727
 
 
728
    def update(self, msg=None, current=None, total=None):
 
729
        self.calls.append(('update', msg, current, total))
 
730
 
 
731
    def clear(self):
 
732
        self.calls.append(('clear',))
 
733
 
 
734
    def note(self, msg, *args):
 
735
        self.calls.append(('note', msg, args))
 
736
 
 
737
 
 
738
class TestTestResult(TestCase):
720
739
 
721
740
    def check_timing(self, test_case, expected_re):
722
741
        result = bzrlib.tests.TextTestResult(self._log_file,
723
742
                descriptions=0,
724
743
                verbosity=1,
725
744
                )
726
 
        capture = testtools.tests.helpers.ExtendedTestResult()
727
 
        test_case.run(MultiTestResult(result, capture))
728
 
        run_case = capture._events[0][1]
729
 
        timed_string = result._testTimeString(run_case)
 
745
        test_case.run(result)
 
746
        timed_string = result._testTimeString(test_case)
730
747
        self.assertContainsRe(timed_string, expected_re)
731
748
 
732
749
    def test_test_reporting(self):
733
 
        class ShortDelayTestCase(tests.TestCase):
 
750
        class ShortDelayTestCase(TestCase):
734
751
            def test_short_delay(self):
735
752
                time.sleep(0.003)
736
753
            def test_short_benchmark(self):
737
754
                self.time(time.sleep, 0.003)
738
755
        self.check_timing(ShortDelayTestCase('test_short_delay'),
739
756
                          r"^ +[0-9]+ms$")
740
 
        # if a benchmark time is given, we now show just that time followed by
741
 
        # a star
 
757
        # if a benchmark time is given, we want a x of y style result.
742
758
        self.check_timing(ShortDelayTestCase('test_short_benchmark'),
743
 
                          r"^ +[0-9]+ms\*$")
 
759
                          r"^ +[0-9]+ms/ +[0-9]+ms$")
744
760
 
745
761
    def test_unittest_reporting_unittest_class(self):
746
762
        # getting the time from a non-bzrlib test works ok
750
766
        self.check_timing(ShortDelayTestCase('test_short_delay'),
751
767
                          r"^ +[0-9]+ms$")
752
768
 
753
 
    def _patch_get_bzr_source_tree(self):
754
 
        # Reading from the actual source tree breaks isolation, but we don't
755
 
        # want to assume that thats *all* that would happen.
756
 
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree', lambda: None)
757
 
 
758
769
    def test_assigned_benchmark_file_stores_date(self):
759
 
        self._patch_get_bzr_source_tree()
760
770
        output = StringIO()
761
771
        result = bzrlib.tests.TextTestResult(self._log_file,
762
772
                                        descriptions=0,
770
780
        self.assertContainsRe(output_string, "--date [0-9.]+")
771
781
 
772
782
    def test_benchhistory_records_test_times(self):
773
 
        self._patch_get_bzr_source_tree()
774
783
        result_stream = StringIO()
775
784
        result = bzrlib.tests.TextTestResult(
776
785
            self._log_file,
837
846
 
838
847
    def test_known_failure(self):
839
848
        """A KnownFailure being raised should trigger several result actions."""
840
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
841
 
            def stopTestRun(self): pass
 
849
        class InstrumentedTestResult(ExtendedTestResult):
 
850
            def done(self): pass
842
851
            def startTests(self): pass
843
852
            def report_test_start(self, test): pass
844
 
            def report_known_failure(self, test, err=None, details=None):
845
 
                self._call = test, 'known failure'
 
853
            def report_known_failure(self, test, err):
 
854
                self._call = test, err
846
855
        result = InstrumentedTestResult(None, None, None, None)
847
 
        class Test(tests.TestCase):
848
 
            def test_function(self):
849
 
                raise tests.KnownFailure('failed!')
850
 
        test = Test("test_function")
 
856
        def test_function():
 
857
            raise KnownFailure('failed!')
 
858
        test = unittest.FunctionTestCase(test_function)
851
859
        test.run(result)
852
860
        # it should invoke 'report_known_failure'.
853
861
        self.assertEqual(2, len(result._call))
854
 
        self.assertEqual(test.id(), result._call[0].id())
855
 
        self.assertEqual('known failure', result._call[1])
 
862
        self.assertEqual(test, result._call[0])
 
863
        self.assertEqual(KnownFailure, result._call[1][0])
 
864
        self.assertIsInstance(result._call[1][1], KnownFailure)
856
865
        # we dont introspec the traceback, if the rest is ok, it would be
857
866
        # exceptional for it not to be.
858
867
        # it should update the known_failure_count on the object.
875
884
        # (class, exception object, traceback)
876
885
        # KnownFailures dont get their tracebacks shown though, so we
877
886
        # can skip that.
878
 
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
 
887
        err = (KnownFailure, KnownFailure('foo'), None)
879
888
        result.report_known_failure(test, err)
880
889
        output = result_stream.getvalue()[prefix:]
881
890
        lines = output.splitlines()
883
892
        self.assertEqual(lines[1], '    foo')
884
893
        self.assertEqual(2, len(lines))
885
894
 
 
895
    def test_text_report_known_failure(self):
 
896
        # text test output formatting
 
897
        pb = MockProgress()
 
898
        result = bzrlib.tests.TextTestResult(
 
899
            StringIO(),
 
900
            descriptions=0,
 
901
            verbosity=1,
 
902
            pb=pb,
 
903
            )
 
904
        test = self.get_passing_test()
 
905
        # this seeds the state to handle reporting the test.
 
906
        result.startTest(test)
 
907
        # the err parameter has the shape:
 
908
        # (class, exception object, traceback)
 
909
        # KnownFailures dont get their tracebacks shown though, so we
 
910
        # can skip that.
 
911
        err = (KnownFailure, KnownFailure('foo'), None)
 
912
        result.report_known_failure(test, err)
 
913
        self.assertEqual(
 
914
            [
 
915
            ('update', '[1 in 0s] passing_test', None, None),
 
916
            ('note', 'XFAIL: %s\n%s\n', ('passing_test', err[1]))
 
917
            ],
 
918
            pb.calls)
 
919
        # known_failures should be printed in the summary, so if we run a test
 
920
        # after there are some known failures, the update prefix should match
 
921
        # this.
 
922
        result.known_failure_count = 3
 
923
        test.run(result)
 
924
        self.assertEqual(
 
925
            [
 
926
            ('update', '[2 in 0s] passing_test', None, None),
 
927
            ],
 
928
            pb.calls[2:])
 
929
 
886
930
    def get_passing_test(self):
887
931
        """Return a test object that can't be run usefully."""
888
932
        def passing_test():
891
935
 
892
936
    def test_add_not_supported(self):
893
937
        """Test the behaviour of invoking addNotSupported."""
894
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
895
 
            def stopTestRun(self): pass
 
938
        class InstrumentedTestResult(ExtendedTestResult):
 
939
            def done(self): pass
896
940
            def startTests(self): pass
897
941
            def report_test_start(self, test): pass
898
942
            def report_unsupported(self, test, feature):
899
943
                self._call = test, feature
900
944
        result = InstrumentedTestResult(None, None, None, None)
901
945
        test = SampleTestCase('_test_pass')
902
 
        feature = tests.Feature()
 
946
        feature = Feature()
903
947
        result.startTest(test)
904
948
        result.addNotSupported(test, feature)
905
949
        # it should invoke 'report_unsupported'.
924
968
            verbosity=2,
925
969
            )
926
970
        test = self.get_passing_test()
927
 
        feature = tests.Feature()
 
971
        feature = Feature()
928
972
        result.startTest(test)
929
973
        prefix = len(result_stream.getvalue())
930
974
        result.report_unsupported(test, feature)
931
975
        output = result_stream.getvalue()[prefix:]
932
976
        lines = output.splitlines()
933
 
        # We don't check for the final '0ms' since it may fail on slow hosts
934
 
        self.assertStartsWith(lines[0], 'NODEP')
935
 
        self.assertEqual(lines[1],
936
 
                         "    The feature 'Feature' is not available.")
 
977
        self.assertEqual(lines, ['NODEP                   0ms', "    The feature 'Feature' is not available."])
 
978
 
 
979
    def test_text_report_unsupported(self):
 
980
        # text test output formatting
 
981
        pb = MockProgress()
 
982
        result = bzrlib.tests.TextTestResult(
 
983
            StringIO(),
 
984
            descriptions=0,
 
985
            verbosity=1,
 
986
            pb=pb,
 
987
            )
 
988
        test = self.get_passing_test()
 
989
        feature = Feature()
 
990
        # this seeds the state to handle reporting the test.
 
991
        result.startTest(test)
 
992
        result.report_unsupported(test, feature)
 
993
        # no output on unsupported features
 
994
        self.assertEqual(
 
995
            [('update', '[1 in 0s] passing_test', None, None)
 
996
            ],
 
997
            pb.calls)
 
998
        # the number of missing features should be printed in the progress
 
999
        # summary, so check for that.
 
1000
        result.unsupported = {'foo':0, 'bar':0}
 
1001
        test.run(result)
 
1002
        self.assertEqual(
 
1003
            [
 
1004
            ('update', '[2 in 0s, 2 missing] passing_test', None, None),
 
1005
            ],
 
1006
            pb.calls[1:])
937
1007
 
938
1008
    def test_unavailable_exception(self):
939
1009
        """An UnavailableFeature being raised should invoke addNotSupported."""
940
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
941
 
            def stopTestRun(self): pass
 
1010
        class InstrumentedTestResult(ExtendedTestResult):
 
1011
            def done(self): pass
942
1012
            def startTests(self): pass
943
1013
            def report_test_start(self, test): pass
944
1014
            def addNotSupported(self, test, feature):
945
1015
                self._call = test, feature
946
1016
        result = InstrumentedTestResult(None, None, None, None)
947
 
        feature = tests.Feature()
948
 
        class Test(tests.TestCase):
949
 
            def test_function(self):
950
 
                raise tests.UnavailableFeature(feature)
951
 
        test = Test("test_function")
 
1017
        feature = Feature()
 
1018
        def test_function():
 
1019
            raise UnavailableFeature(feature)
 
1020
        test = unittest.FunctionTestCase(test_function)
952
1021
        test.run(result)
953
1022
        # it should invoke 'addNotSupported'.
954
1023
        self.assertEqual(2, len(result._call))
955
 
        self.assertEqual(test.id(), result._call[0].id())
 
1024
        self.assertEqual(test, result._call[0])
956
1025
        self.assertEqual(feature, result._call[1])
957
1026
        # and not count as an error
958
1027
        self.assertEqual(0, result.error_count)
970
1039
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
971
1040
                                             verbosity=1)
972
1041
        test = self.get_passing_test()
973
 
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
974
 
        result.addExpectedFailure(test, err)
 
1042
        err = (KnownFailure, KnownFailure('foo'), None)
 
1043
        result._addKnownFailure(test, err)
975
1044
        self.assertFalse(result.wasStrictlySuccessful())
976
1045
        self.assertEqual(None, result._extractBenchmarkTime(test))
977
1046
 
985
1054
 
986
1055
    def test_startTests(self):
987
1056
        """Starting the first test should trigger startTests."""
988
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
1057
        class InstrumentedTestResult(ExtendedTestResult):
989
1058
            calls = 0
990
1059
            def startTests(self): self.calls += 1
991
1060
            def report_test_start(self, test): pass
997
1066
        self.assertEquals(1, result.calls)
998
1067
 
999
1068
 
1000
 
class TestUnicodeFilenameFeature(tests.TestCase):
 
1069
class TestUnicodeFilenameFeature(TestCase):
1001
1070
 
1002
1071
    def test_probe_passes(self):
1003
1072
        """UnicodeFilenameFeature._probe passes."""
1006
1075
        tests.UnicodeFilenameFeature._probe()
1007
1076
 
1008
1077
 
1009
 
class TestRunner(tests.TestCase):
 
1078
class TestRunner(TestCase):
1010
1079
 
1011
1080
    def dummy_test(self):
1012
1081
        pass
1017
1086
        This current saves and restores:
1018
1087
        TestCaseInTempDir.TEST_ROOT
1019
1088
 
1020
 
        There should be no tests in this file that use
1021
 
        bzrlib.tests.TextTestRunner without using this convenience method,
1022
 
        because of our use of global state.
 
1089
        There should be no tests in this file that use bzrlib.tests.TextTestRunner
 
1090
        without using this convenience method, because of our use of global state.
1023
1091
        """
1024
 
        old_root = tests.TestCaseInTempDir.TEST_ROOT
1025
 
        old_leak = tests.TestCase._first_thread_leaker_id
 
1092
        old_root = TestCaseInTempDir.TEST_ROOT
1026
1093
        try:
1027
 
            tests.TestCaseInTempDir.TEST_ROOT = None
1028
 
            tests.TestCase._first_thread_leaker_id = None
 
1094
            TestCaseInTempDir.TEST_ROOT = None
1029
1095
            return testrunner.run(test)
1030
1096
        finally:
1031
 
            tests.TestCaseInTempDir.TEST_ROOT = old_root
1032
 
            tests.TestCase._first_thread_leaker_id = old_leak
 
1097
            TestCaseInTempDir.TEST_ROOT = old_root
1033
1098
 
1034
1099
    def test_known_failure_failed_run(self):
1035
1100
        # run a test that generates a known failure which should be printed in
1036
1101
        # the final output when real failures occur.
1037
 
        class Test(tests.TestCase):
1038
 
            def known_failure_test(self):
1039
 
                self.expectFailure('failed', self.assertTrue, False)
 
1102
        def known_failure_test():
 
1103
            raise KnownFailure('failed')
1040
1104
        test = unittest.TestSuite()
1041
 
        test.addTest(Test("known_failure_test"))
 
1105
        test.addTest(unittest.FunctionTestCase(known_failure_test))
1042
1106
        def failing_test():
1043
 
            self.fail('foo')
 
1107
            raise AssertionError('foo')
1044
1108
        test.addTest(unittest.FunctionTestCase(failing_test))
1045
1109
        stream = StringIO()
1046
 
        runner = tests.TextTestRunner(stream=stream)
 
1110
        runner = TextTestRunner(stream=stream)
1047
1111
        result = self.run_test_runner(runner, test)
1048
1112
        lines = stream.getvalue().splitlines()
1049
 
        self.assertContainsRe(stream.getvalue(),
1050
 
            '(?sm)^bzr selftest.*$'
1051
 
            '.*'
1052
 
            '^======================================================================\n'
1053
 
            '^FAIL: failing_test\n'
1054
 
            '^----------------------------------------------------------------------\n'
1055
 
            'Traceback \\(most recent call last\\):\n'
1056
 
            '  .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
1057
 
            '    self.fail\\(\'foo\'\\)\n'
1058
 
            '.*'
1059
 
            '^----------------------------------------------------------------------\n'
1060
 
            '.*'
1061
 
            'FAILED \\(failures=1, known_failure_count=1\\)'
1062
 
            )
 
1113
        self.assertEqual([
 
1114
            '',
 
1115
            '======================================================================',
 
1116
            'FAIL: unittest.FunctionTestCase (failing_test)',
 
1117
            '----------------------------------------------------------------------',
 
1118
            'Traceback (most recent call last):',
 
1119
            '    raise AssertionError(\'foo\')',
 
1120
            'AssertionError: foo',
 
1121
            '',
 
1122
            '----------------------------------------------------------------------',
 
1123
            '',
 
1124
            'FAILED (failures=1, known_failure_count=1)'],
 
1125
            lines[3:8] + lines[9:13] + lines[14:])
1063
1126
 
1064
1127
    def test_known_failure_ok_run(self):
1065
 
        # run a test that generates a known failure which should be printed in
1066
 
        # the final output.
1067
 
        class Test(tests.TestCase):
1068
 
            def known_failure_test(self):
1069
 
                self.expectFailure('failed', self.assertTrue, False)
1070
 
        test = Test("known_failure_test")
 
1128
        # run a test that generates a known failure which should be printed in the final output.
 
1129
        def known_failure_test():
 
1130
            raise KnownFailure('failed')
 
1131
        test = unittest.FunctionTestCase(known_failure_test)
1071
1132
        stream = StringIO()
1072
 
        runner = tests.TextTestRunner(stream=stream)
 
1133
        runner = TextTestRunner(stream=stream)
1073
1134
        result = self.run_test_runner(runner, test)
1074
1135
        self.assertContainsRe(stream.getvalue(),
1075
1136
            '\n'
1078
1139
            '\n'
1079
1140
            'OK \\(known_failures=1\\)\n')
1080
1141
 
1081
 
    def test_result_decorator(self):
1082
 
        # decorate results
1083
 
        calls = []
1084
 
        class LoggingDecorator(tests.ForwardingResult):
1085
 
            def startTest(self, test):
1086
 
                tests.ForwardingResult.startTest(self, test)
1087
 
                calls.append('start')
1088
 
        test = unittest.FunctionTestCase(lambda:None)
1089
 
        stream = StringIO()
1090
 
        runner = tests.TextTestRunner(stream=stream,
1091
 
            result_decorators=[LoggingDecorator])
1092
 
        result = self.run_test_runner(runner, test)
1093
 
        self.assertLength(1, calls)
1094
 
 
1095
1142
    def test_skipped_test(self):
1096
1143
        # run a test that is skipped, and check the suite as a whole still
1097
1144
        # succeeds.
1098
1145
        # skipping_test must be hidden in here so it's not run as a real test
1099
 
        class SkippingTest(tests.TestCase):
 
1146
        class SkippingTest(TestCase):
1100
1147
            def skipping_test(self):
1101
 
                raise tests.TestSkipped('test intentionally skipped')
1102
 
        runner = tests.TextTestRunner(stream=self._log_file)
 
1148
                raise TestSkipped('test intentionally skipped')
 
1149
        runner = TextTestRunner(stream=self._log_file)
1103
1150
        test = SkippingTest("skipping_test")
1104
1151
        result = self.run_test_runner(runner, test)
1105
1152
        self.assertTrue(result.wasSuccessful())
1106
1153
 
1107
1154
    def test_skipped_from_setup(self):
1108
1155
        calls = []
1109
 
        class SkippedSetupTest(tests.TestCase):
 
1156
        class SkippedSetupTest(TestCase):
1110
1157
 
1111
1158
            def setUp(self):
1112
1159
                calls.append('setUp')
1113
1160
                self.addCleanup(self.cleanup)
1114
 
                raise tests.TestSkipped('skipped setup')
 
1161
                raise TestSkipped('skipped setup')
1115
1162
 
1116
1163
            def test_skip(self):
1117
1164
                self.fail('test reached')
1119
1166
            def cleanup(self):
1120
1167
                calls.append('cleanup')
1121
1168
 
1122
 
        runner = tests.TextTestRunner(stream=self._log_file)
 
1169
        runner = TextTestRunner(stream=self._log_file)
1123
1170
        test = SkippedSetupTest('test_skip')
1124
1171
        result = self.run_test_runner(runner, test)
1125
1172
        self.assertTrue(result.wasSuccessful())
1128
1175
 
1129
1176
    def test_skipped_from_test(self):
1130
1177
        calls = []
1131
 
        class SkippedTest(tests.TestCase):
 
1178
        class SkippedTest(TestCase):
1132
1179
 
1133
1180
            def setUp(self):
1134
 
                tests.TestCase.setUp(self)
 
1181
                TestCase.setUp(self)
1135
1182
                calls.append('setUp')
1136
1183
                self.addCleanup(self.cleanup)
1137
1184
 
1138
1185
            def test_skip(self):
1139
 
                raise tests.TestSkipped('skipped test')
 
1186
                raise TestSkipped('skipped test')
1140
1187
 
1141
1188
            def cleanup(self):
1142
1189
                calls.append('cleanup')
1143
1190
 
1144
 
        runner = tests.TextTestRunner(stream=self._log_file)
 
1191
        runner = TextTestRunner(stream=self._log_file)
1145
1192
        test = SkippedTest('test_skip')
1146
1193
        result = self.run_test_runner(runner, test)
1147
1194
        self.assertTrue(result.wasSuccessful())
1150
1197
 
1151
1198
    def test_not_applicable(self):
1152
1199
        # run a test that is skipped because it's not applicable
1153
 
        class Test(tests.TestCase):
1154
 
            def not_applicable_test(self):
1155
 
                raise tests.TestNotApplicable('this test never runs')
 
1200
        def not_applicable_test():
 
1201
            from bzrlib.tests import TestNotApplicable
 
1202
            raise TestNotApplicable('this test never runs')
1156
1203
        out = StringIO()
1157
 
        runner = tests.TextTestRunner(stream=out, verbosity=2)
1158
 
        test = Test("not_applicable_test")
 
1204
        runner = TextTestRunner(stream=out, verbosity=2)
 
1205
        test = unittest.FunctionTestCase(not_applicable_test)
1159
1206
        result = self.run_test_runner(runner, test)
1160
1207
        self._log_file.write(out.getvalue())
1161
1208
        self.assertTrue(result.wasSuccessful())
1165
1212
        self.assertContainsRe(out.getvalue(),
1166
1213
                r'(?m)^    this test never runs')
1167
1214
 
 
1215
    def test_not_applicable_demo(self):
 
1216
        # just so you can see it in the test output
 
1217
        raise TestNotApplicable('this test is just a demonstation')
 
1218
 
1168
1219
    def test_unsupported_features_listed(self):
1169
1220
        """When unsupported features are encountered they are detailed."""
1170
 
        class Feature1(tests.Feature):
 
1221
        class Feature1(Feature):
1171
1222
            def _probe(self): return False
1172
 
        class Feature2(tests.Feature):
 
1223
        class Feature2(Feature):
1173
1224
            def _probe(self): return False
1174
1225
        # create sample tests
1175
1226
        test1 = SampleTestCase('_test_pass')
1180
1231
        test.addTest(test1)
1181
1232
        test.addTest(test2)
1182
1233
        stream = StringIO()
1183
 
        runner = tests.TextTestRunner(stream=stream)
 
1234
        runner = TextTestRunner(stream=stream)
1184
1235
        result = self.run_test_runner(runner, test)
1185
1236
        lines = stream.getvalue().splitlines()
1186
1237
        self.assertEqual([
1190
1241
            ],
1191
1242
            lines[-3:])
1192
1243
 
1193
 
    def _patch_get_bzr_source_tree(self):
1194
 
        # Reading from the actual source tree breaks isolation, but we don't
1195
 
        # want to assume that thats *all* that would happen.
1196
 
        self._get_source_tree_calls = []
1197
 
        def new_get():
1198
 
            self._get_source_tree_calls.append("called")
1199
 
            return None
1200
 
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree',  new_get)
1201
 
 
1202
1244
    def test_bench_history(self):
1203
 
        # tests that the running the benchmark passes bench_history into
1204
 
        # the test result object. We can tell that happens if
1205
 
        # _get_bzr_source_tree is called.
1206
 
        self._patch_get_bzr_source_tree()
 
1245
        # tests that the running the benchmark produces a history file
 
1246
        # containing a timestamp and the revision id of the bzrlib source which
 
1247
        # was tested.
 
1248
        workingtree = _get_bzr_source_tree()
1207
1249
        test = TestRunner('dummy_test')
1208
1250
        output = StringIO()
1209
 
        runner = tests.TextTestRunner(stream=self._log_file,
1210
 
                                      bench_history=output)
 
1251
        runner = TextTestRunner(stream=self._log_file, bench_history=output)
1211
1252
        result = self.run_test_runner(runner, test)
1212
1253
        output_string = output.getvalue()
1213
1254
        self.assertContainsRe(output_string, "--date [0-9.]+")
1214
 
        self.assertLength(1, self._get_source_tree_calls)
1215
 
 
1216
 
    def test_startTestRun(self):
1217
 
        """run should call result.startTestRun()"""
1218
 
        calls = []
1219
 
        class LoggingDecorator(tests.ForwardingResult):
1220
 
            def startTestRun(self):
1221
 
                tests.ForwardingResult.startTestRun(self)
1222
 
                calls.append('startTestRun')
1223
 
        test = unittest.FunctionTestCase(lambda:None)
1224
 
        stream = StringIO()
1225
 
        runner = tests.TextTestRunner(stream=stream,
1226
 
            result_decorators=[LoggingDecorator])
1227
 
        result = self.run_test_runner(runner, test)
1228
 
        self.assertLength(1, calls)
1229
 
 
1230
 
    def test_stopTestRun(self):
1231
 
        """run should call result.stopTestRun()"""
1232
 
        calls = []
1233
 
        class LoggingDecorator(tests.ForwardingResult):
1234
 
            def stopTestRun(self):
1235
 
                tests.ForwardingResult.stopTestRun(self)
1236
 
                calls.append('stopTestRun')
1237
 
        test = unittest.FunctionTestCase(lambda:None)
1238
 
        stream = StringIO()
1239
 
        runner = tests.TextTestRunner(stream=stream,
1240
 
            result_decorators=[LoggingDecorator])
1241
 
        result = self.run_test_runner(runner, test)
1242
 
        self.assertLength(1, calls)
1243
 
 
1244
 
 
1245
 
class SampleTestCase(tests.TestCase):
 
1255
        if workingtree is not None:
 
1256
            revision_id = workingtree.get_parent_ids()[0]
 
1257
            self.assertEndsWith(output_string.rstrip(), revision_id)
 
1258
 
 
1259
    def assertLogDeleted(self, test):
 
1260
        log = test._get_log()
 
1261
        self.assertEqual("DELETED log file to reduce memory footprint", log)
 
1262
        self.assertEqual('', test._log_contents)
 
1263
        self.assertIs(None, test._log_file_name)
 
1264
 
 
1265
    def test_success_log_deleted(self):
 
1266
        """Successful tests have their log deleted"""
 
1267
 
 
1268
        class LogTester(TestCase):
 
1269
 
 
1270
            def test_success(self):
 
1271
                self.log('this will be removed\n')
 
1272
 
 
1273
        sio = cStringIO.StringIO()
 
1274
        runner = TextTestRunner(stream=sio)
 
1275
        test = LogTester('test_success')
 
1276
        result = self.run_test_runner(runner, test)
 
1277
 
 
1278
        self.assertLogDeleted(test)
 
1279
 
 
1280
    def test_skipped_log_deleted(self):
 
1281
        """Skipped tests have their log deleted"""
 
1282
 
 
1283
        class LogTester(TestCase):
 
1284
 
 
1285
            def test_skipped(self):
 
1286
                self.log('this will be removed\n')
 
1287
                raise tests.TestSkipped()
 
1288
 
 
1289
        sio = cStringIO.StringIO()
 
1290
        runner = TextTestRunner(stream=sio)
 
1291
        test = LogTester('test_skipped')
 
1292
        result = self.run_test_runner(runner, test)
 
1293
 
 
1294
        self.assertLogDeleted(test)
 
1295
 
 
1296
    def test_not_aplicable_log_deleted(self):
 
1297
        """Not applicable tests have their log deleted"""
 
1298
 
 
1299
        class LogTester(TestCase):
 
1300
 
 
1301
            def test_not_applicable(self):
 
1302
                self.log('this will be removed\n')
 
1303
                raise tests.TestNotApplicable()
 
1304
 
 
1305
        sio = cStringIO.StringIO()
 
1306
        runner = TextTestRunner(stream=sio)
 
1307
        test = LogTester('test_not_applicable')
 
1308
        result = self.run_test_runner(runner, test)
 
1309
 
 
1310
        self.assertLogDeleted(test)
 
1311
 
 
1312
    def test_known_failure_log_deleted(self):
 
1313
        """Know failure tests have their log deleted"""
 
1314
 
 
1315
        class LogTester(TestCase):
 
1316
 
 
1317
            def test_known_failure(self):
 
1318
                self.log('this will be removed\n')
 
1319
                raise tests.KnownFailure()
 
1320
 
 
1321
        sio = cStringIO.StringIO()
 
1322
        runner = TextTestRunner(stream=sio)
 
1323
        test = LogTester('test_known_failure')
 
1324
        result = self.run_test_runner(runner, test)
 
1325
 
 
1326
        self.assertLogDeleted(test)
 
1327
 
 
1328
    def test_fail_log_kept(self):
 
1329
        """Failed tests have their log kept"""
 
1330
 
 
1331
        class LogTester(TestCase):
 
1332
 
 
1333
            def test_fail(self):
 
1334
                self.log('this will be kept\n')
 
1335
                self.fail('this test fails')
 
1336
 
 
1337
        sio = cStringIO.StringIO()
 
1338
        runner = TextTestRunner(stream=sio)
 
1339
        test = LogTester('test_fail')
 
1340
        result = self.run_test_runner(runner, test)
 
1341
 
 
1342
        text = sio.getvalue()
 
1343
        self.assertContainsRe(text, 'this will be kept')
 
1344
        self.assertContainsRe(text, 'this test fails')
 
1345
 
 
1346
        log = test._get_log()
 
1347
        self.assertContainsRe(log, 'this will be kept')
 
1348
        self.assertEqual(log, test._log_contents)
 
1349
 
 
1350
    def test_error_log_kept(self):
 
1351
        """Tests with errors have their log kept"""
 
1352
 
 
1353
        class LogTester(TestCase):
 
1354
 
 
1355
            def test_error(self):
 
1356
                self.log('this will be kept\n')
 
1357
                raise ValueError('random exception raised')
 
1358
 
 
1359
        sio = cStringIO.StringIO()
 
1360
        runner = TextTestRunner(stream=sio)
 
1361
        test = LogTester('test_error')
 
1362
        result = self.run_test_runner(runner, test)
 
1363
 
 
1364
        text = sio.getvalue()
 
1365
        self.assertContainsRe(text, 'this will be kept')
 
1366
        self.assertContainsRe(text, 'random exception raised')
 
1367
 
 
1368
        log = test._get_log()
 
1369
        self.assertContainsRe(log, 'this will be kept')
 
1370
        self.assertEqual(log, test._log_contents)
 
1371
 
 
1372
 
 
1373
class SampleTestCase(TestCase):
1246
1374
 
1247
1375
    def _test_pass(self):
1248
1376
        pass
1250
1378
class _TestException(Exception):
1251
1379
    pass
1252
1380
 
1253
 
 
1254
 
class TestTestCase(tests.TestCase):
 
1381
class TestTestCase(TestCase):
1255
1382
    """Tests that test the core bzrlib TestCase."""
1256
1383
 
1257
1384
    def test_assertLength_matches_empty(self):
1274
1401
            exception.args[0])
1275
1402
 
1276
1403
    def test_base_setUp_not_called_causes_failure(self):
1277
 
        class TestCaseWithBrokenSetUp(tests.TestCase):
 
1404
        class TestCaseWithBrokenSetUp(TestCase):
1278
1405
            def setUp(self):
1279
1406
                pass # does not call TestCase.setUp
1280
1407
            def test_foo(self):
1286
1413
        self.assertEqual(1, result.testsRun)
1287
1414
 
1288
1415
    def test_base_tearDown_not_called_causes_failure(self):
1289
 
        class TestCaseWithBrokenTearDown(tests.TestCase):
 
1416
        class TestCaseWithBrokenTearDown(TestCase):
1290
1417
            def tearDown(self):
1291
1418
                pass # does not call TestCase.tearDown
1292
1419
            def test_foo(self):
1300
1427
    def test_debug_flags_sanitised(self):
1301
1428
        """The bzrlib debug flags should be sanitised by setUp."""
1302
1429
        if 'allow_debug' in tests.selftest_debug_flags:
1303
 
            raise tests.TestNotApplicable(
 
1430
            raise TestNotApplicable(
1304
1431
                '-Eallow_debug option prevents debug flag sanitisation')
1305
1432
        # we could set something and run a test that will check
1306
1433
        # it gets santised, but this is probably sufficient for now:
1307
1434
        # if someone runs the test with -Dsomething it will error.
1308
 
        flags = set()
1309
 
        if self._lock_check_thorough:
1310
 
            flags.add('strict_locks')
1311
 
        self.assertEqual(flags, bzrlib.debug.debug_flags)
 
1435
        self.assertEqual(set(), bzrlib.debug.debug_flags)
1312
1436
 
1313
1437
    def change_selftest_debug_flags(self, new_flags):
1314
 
        self.overrideAttr(tests, 'selftest_debug_flags', set(new_flags))
 
1438
        orig_selftest_flags = tests.selftest_debug_flags
 
1439
        self.addCleanup(self._restore_selftest_debug_flags, orig_selftest_flags)
 
1440
        tests.selftest_debug_flags = set(new_flags)
 
1441
 
 
1442
    def _restore_selftest_debug_flags(self, flags):
 
1443
        tests.selftest_debug_flags = flags
1315
1444
 
1316
1445
    def test_allow_debug_flag(self):
1317
1446
        """The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1319
1448
        """
1320
1449
        self.change_selftest_debug_flags(set(['allow_debug']))
1321
1450
        bzrlib.debug.debug_flags = set(['a-flag'])
1322
 
        class TestThatRecordsFlags(tests.TestCase):
1323
 
            def test_foo(nested_self):
1324
 
                self.flags = set(bzrlib.debug.debug_flags)
1325
 
        test = TestThatRecordsFlags('test_foo')
1326
 
        test.run(self.make_test_result())
1327
 
        flags = set(['a-flag'])
1328
 
        if 'disable_lock_checks' not in tests.selftest_debug_flags:
1329
 
            flags.add('strict_locks')
1330
 
        self.assertEqual(flags, self.flags)
1331
 
 
1332
 
    def test_disable_lock_checks(self):
1333
 
        """The -Edisable_lock_checks flag disables thorough checks."""
1334
 
        class TestThatRecordsFlags(tests.TestCase):
1335
 
            def test_foo(nested_self):
1336
 
                self.flags = set(bzrlib.debug.debug_flags)
1337
 
                self.test_lock_check_thorough = nested_self._lock_check_thorough
1338
 
        self.change_selftest_debug_flags(set())
1339
 
        test = TestThatRecordsFlags('test_foo')
1340
 
        test.run(self.make_test_result())
1341
 
        # By default we do strict lock checking and thorough lock/unlock
1342
 
        # tracking.
1343
 
        self.assertTrue(self.test_lock_check_thorough)
1344
 
        self.assertEqual(set(['strict_locks']), self.flags)
1345
 
        # Now set the disable_lock_checks flag, and show that this changed.
1346
 
        self.change_selftest_debug_flags(set(['disable_lock_checks']))
1347
 
        test = TestThatRecordsFlags('test_foo')
1348
 
        test.run(self.make_test_result())
1349
 
        self.assertFalse(self.test_lock_check_thorough)
1350
 
        self.assertEqual(set(), self.flags)
1351
 
 
1352
 
    def test_this_fails_strict_lock_check(self):
1353
 
        class TestThatRecordsFlags(tests.TestCase):
1354
 
            def test_foo(nested_self):
1355
 
                self.flags1 = set(bzrlib.debug.debug_flags)
1356
 
                self.thisFailsStrictLockCheck()
1357
 
                self.flags2 = set(bzrlib.debug.debug_flags)
1358
 
        # Make sure lock checking is active
1359
 
        self.change_selftest_debug_flags(set())
1360
 
        test = TestThatRecordsFlags('test_foo')
1361
 
        test.run(self.make_test_result())
1362
 
        self.assertEqual(set(['strict_locks']), self.flags1)
1363
 
        self.assertEqual(set(), self.flags2)
 
1451
        class TestThatRecordsFlags(TestCase):
 
1452
            def test_foo(nested_self):
 
1453
                self.flags = set(bzrlib.debug.debug_flags)
 
1454
        test = TestThatRecordsFlags('test_foo')
 
1455
        test.run(self.make_test_result())
 
1456
        self.assertEqual(set(['a-flag']), self.flags)
1364
1457
 
1365
1458
    def test_debug_flags_restored(self):
1366
1459
        """The bzrlib debug flags should be restored to their original state
1369
1462
        self.change_selftest_debug_flags(set(['allow_debug']))
1370
1463
        # Now run a test that modifies debug.debug_flags.
1371
1464
        bzrlib.debug.debug_flags = set(['original-state'])
1372
 
        class TestThatModifiesFlags(tests.TestCase):
 
1465
        class TestThatModifiesFlags(TestCase):
1373
1466
            def test_foo(self):
1374
1467
                bzrlib.debug.debug_flags = set(['modified'])
1375
1468
        test = TestThatModifiesFlags('test_foo')
1377
1470
        self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1378
1471
 
1379
1472
    def make_test_result(self):
1380
 
        """Get a test result that writes to the test log file."""
1381
 
        return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
 
1473
        return bzrlib.tests.TextTestResult(
 
1474
            self._log_file, descriptions=0, verbosity=1)
1382
1475
 
1383
1476
    def inner_test(self):
1384
1477
        # the inner child test
1391
1484
        result = self.make_test_result()
1392
1485
        self.inner_test.run(result)
1393
1486
        note("outer finish")
1394
 
        self.addCleanup(osutils.delete_any, self._log_file_name)
1395
1487
 
1396
1488
    def test_trace_nesting(self):
1397
1489
        # this tests that each test case nests its trace facility correctly.
1423
1515
        result = bzrlib.tests.VerboseTestResult(
1424
1516
            unittest._WritelnDecorator(output_stream),
1425
1517
            descriptions=0,
1426
 
            verbosity=2)
 
1518
            verbosity=2,
 
1519
            num_tests=sample_test.countTestCases())
1427
1520
        sample_test.run(result)
1428
1521
        self.assertContainsRe(
1429
1522
            output_stream.getvalue(),
1430
 
            r"\d+ms\*\n$")
 
1523
            r"\d+ms/ +\d+ms\n$")
1431
1524
 
1432
1525
    def test_hooks_sanitised(self):
1433
1526
        """The bzrlib hooks should be sanitised by setUp."""
1457
1550
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1458
1551
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1459
1552
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1460
 
        del self._benchcalls[:]
1461
1553
 
1462
1554
    def test_knownFailure(self):
1463
1555
        """Self.knownFailure() should raise a KnownFailure exception."""
1464
 
        self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
1465
 
 
1466
 
    def test_open_bzrdir_safe_roots(self):
1467
 
        # even a memory transport should fail to open when its url isn't 
1468
 
        # permitted.
1469
 
        # Manually set one up (TestCase doesn't and shouldn't provide magic
1470
 
        # machinery)
1471
 
        transport_server = memory.MemoryServer()
1472
 
        transport_server.start_server()
1473
 
        self.addCleanup(transport_server.stop_server)
1474
 
        t = transport.get_transport(transport_server.get_url())
1475
 
        bzrdir.BzrDir.create(t.base)
1476
 
        self.assertRaises(errors.BzrError,
1477
 
            bzrdir.BzrDir.open_from_transport, t)
1478
 
        # But if we declare this as safe, we can open the bzrdir.
1479
 
        self.permit_url(t.base)
1480
 
        self._bzr_selftest_roots.append(t.base)
1481
 
        bzrdir.BzrDir.open_from_transport(t)
 
1556
        self.assertRaises(KnownFailure, self.knownFailure, "A Failure")
1482
1557
 
1483
1558
    def test_requireFeature_available(self):
1484
1559
        """self.requireFeature(available) is a no-op."""
1485
 
        class Available(tests.Feature):
 
1560
        class Available(Feature):
1486
1561
            def _probe(self):return True
1487
1562
        feature = Available()
1488
1563
        self.requireFeature(feature)
1489
1564
 
1490
1565
    def test_requireFeature_unavailable(self):
1491
1566
        """self.requireFeature(unavailable) raises UnavailableFeature."""
1492
 
        class Unavailable(tests.Feature):
 
1567
        class Unavailable(Feature):
1493
1568
            def _probe(self):return False
1494
1569
        feature = Unavailable()
1495
 
        self.assertRaises(tests.UnavailableFeature,
1496
 
                          self.requireFeature, feature)
 
1570
        self.assertRaises(UnavailableFeature, self.requireFeature, feature)
1497
1571
 
1498
1572
    def test_run_no_parameters(self):
1499
1573
        test = SampleTestCase('_test_pass')
1529
1603
        """Test disabled tests behaviour with support aware results."""
1530
1604
        test = SampleTestCase('_test_pass')
1531
1605
        class DisabledFeature(object):
1532
 
            def __eq__(self, other):
1533
 
                return isinstance(other, DisabledFeature)
1534
1606
            def available(self):
1535
1607
                return False
1536
1608
        the_feature = DisabledFeature()
1547
1619
                self.calls.append(('addNotSupported', test, feature))
1548
1620
        result = InstrumentedTestResult()
1549
1621
        test.run(result)
1550
 
        case = result.calls[0][1]
1551
1622
        self.assertEqual([
1552
 
            ('startTest', case),
1553
 
            ('addNotSupported', case, the_feature),
1554
 
            ('stopTest', case),
 
1623
            ('startTest', test),
 
1624
            ('addNotSupported', test, the_feature),
 
1625
            ('stopTest', test),
1555
1626
            ],
1556
1627
            result.calls)
1557
1628
 
1558
 
    def test_start_server_registers_url(self):
1559
 
        transport_server = memory.MemoryServer()
1560
 
        # A little strict, but unlikely to be changed soon.
1561
 
        self.assertEqual([], self._bzr_selftest_roots)
1562
 
        self.start_server(transport_server)
1563
 
        self.assertSubset([transport_server.get_url()],
1564
 
            self._bzr_selftest_roots)
1565
 
 
1566
1629
    def test_assert_list_raises_on_generator(self):
1567
1630
        def generator_which_will_raise():
1568
1631
            # This will not raise until after the first yield
1618
1681
        self.assertRaises(AssertionError,
1619
1682
            self.assertListRaises, _TestException, success_generator)
1620
1683
 
1621
 
    def test_overrideAttr_without_value(self):
1622
 
        self.test_attr = 'original' # Define a test attribute
1623
 
        obj = self # Make 'obj' visible to the embedded test
1624
 
        class Test(tests.TestCase):
1625
 
 
1626
 
            def setUp(self):
1627
 
                tests.TestCase.setUp(self)
1628
 
                self.orig = self.overrideAttr(obj, 'test_attr')
1629
 
 
1630
 
            def test_value(self):
1631
 
                self.assertEqual('original', self.orig)
1632
 
                self.assertEqual('original', obj.test_attr)
1633
 
                obj.test_attr = 'modified'
1634
 
                self.assertEqual('modified', obj.test_attr)
1635
 
 
1636
 
        test = Test('test_value')
1637
 
        test.run(unittest.TestResult())
1638
 
        self.assertEqual('original', obj.test_attr)
1639
 
 
1640
 
    def test_overrideAttr_with_value(self):
1641
 
        self.test_attr = 'original' # Define a test attribute
1642
 
        obj = self # Make 'obj' visible to the embedded test
1643
 
        class Test(tests.TestCase):
1644
 
 
1645
 
            def setUp(self):
1646
 
                tests.TestCase.setUp(self)
1647
 
                self.orig = self.overrideAttr(obj, 'test_attr', new='modified')
1648
 
 
1649
 
            def test_value(self):
1650
 
                self.assertEqual('original', self.orig)
1651
 
                self.assertEqual('modified', obj.test_attr)
1652
 
 
1653
 
        test = Test('test_value')
1654
 
        test.run(unittest.TestResult())
1655
 
        self.assertEqual('original', obj.test_attr)
1656
 
 
1657
1684
 
1658
1685
# NB: Don't delete this; it's not actually from 0.11!
1659
1686
@deprecated_function(deprecated_in((0, 11, 0)))
1682
1709
        return sample_deprecated_function()
1683
1710
 
1684
1711
 
1685
 
class TestExtraAssertions(tests.TestCase):
 
1712
class TestExtraAssertions(TestCase):
1686
1713
    """Tests for new test assertions in bzrlib test suite"""
1687
1714
 
1688
1715
    def test_assert_isinstance(self):
1689
1716
        self.assertIsInstance(2, int)
1690
1717
        self.assertIsInstance(u'', basestring)
1691
 
        e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1692
 
        self.assertEquals(str(e),
1693
 
            "None is an instance of <type 'NoneType'> rather than <type 'int'>")
 
1718
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1694
1719
        self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1695
 
        e = self.assertRaises(AssertionError,
1696
 
            self.assertIsInstance, None, int, "it's just not")
1697
 
        self.assertEquals(str(e),
1698
 
            "None is an instance of <type 'NoneType'> rather than <type 'int'>"
1699
 
            ": it's just not")
1700
1720
 
1701
1721
    def test_assertEndsWith(self):
1702
1722
        self.assertEndsWith('foo', 'oo')
1703
1723
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1704
1724
 
1705
 
    def test_assertEqualDiff(self):
1706
 
        e = self.assertRaises(AssertionError,
1707
 
                              self.assertEqualDiff, '', '\n')
1708
 
        self.assertEquals(str(e),
1709
 
                          # Don't blink ! The '+' applies to the second string
1710
 
                          'first string is missing a final newline.\n+ \n')
1711
 
        e = self.assertRaises(AssertionError,
1712
 
                              self.assertEqualDiff, '\n', '')
1713
 
        self.assertEquals(str(e),
1714
 
                          # Don't blink ! The '-' applies to the second string
1715
 
                          'second string is missing a final newline.\n- \n')
1716
 
 
1717
 
 
1718
 
class TestDeprecations(tests.TestCase):
1719
 
 
1720
1725
    def test_applyDeprecated_not_deprecated(self):
1721
1726
        sample_object = ApplyDeprecatedHelper()
1722
1727
        # calling an undeprecated callable raises an assertion
1765
1770
        self.callDeprecated([], testfunc, be_deprecated=False)
1766
1771
 
1767
1772
 
1768
 
class TestWarningTests(tests.TestCase):
 
1773
class TestWarningTests(TestCase):
1769
1774
    """Tests for calling methods that raise warnings."""
1770
1775
 
1771
1776
    def test_callCatchWarnings(self):
1781
1786
        self.assertEquals("this is your last warning", str(w0))
1782
1787
 
1783
1788
 
1784
 
class TestConvenienceMakers(tests.TestCaseWithTransport):
 
1789
class TestConvenienceMakers(TestCaseWithTransport):
1785
1790
    """Test for the make_* convenience functions."""
1786
1791
 
1787
1792
    def test_make_branch_and_tree_with_format(self):
1799
1804
        tree = self.make_branch_and_memory_tree('a')
1800
1805
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1801
1806
 
1802
 
    def test_make_tree_for_local_vfs_backed_transport(self):
1803
 
        # make_branch_and_tree has to use local branch and repositories
1804
 
        # when the vfs transport and local disk are colocated, even if
1805
 
        # a different transport is in use for url generation.
1806
 
        self.transport_server = test_server.FakeVFATServer
1807
 
        self.assertFalse(self.get_url('t1').startswith('file://'))
 
1807
 
 
1808
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
 
1809
 
 
1810
    def test_make_tree_for_sftp_branch(self):
 
1811
        """Transports backed by local directories create local trees."""
 
1812
 
1808
1813
        tree = self.make_branch_and_tree('t1')
1809
1814
        base = tree.bzrdir.root_transport.base
1810
 
        self.assertStartsWith(base, 'file://')
 
1815
        self.failIf(base.startswith('sftp'),
 
1816
                'base %r is on sftp but should be local' % base)
1811
1817
        self.assertEquals(tree.bzrdir.root_transport,
1812
1818
                tree.branch.bzrdir.root_transport)
1813
1819
        self.assertEquals(tree.bzrdir.root_transport,
1814
1820
                tree.branch.repository.bzrdir.root_transport)
1815
1821
 
1816
1822
 
1817
 
class SelfTestHelper:
1818
 
 
1819
 
    def run_selftest(self, **kwargs):
1820
 
        """Run selftest returning its output."""
1821
 
        output = StringIO()
1822
 
        old_transport = bzrlib.tests.default_transport
1823
 
        old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
1824
 
        tests.TestCaseWithMemoryTransport.TEST_ROOT = None
1825
 
        try:
1826
 
            self.assertEqual(True, tests.selftest(stream=output, **kwargs))
1827
 
        finally:
1828
 
            bzrlib.tests.default_transport = old_transport
1829
 
            tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
1830
 
        output.seek(0)
1831
 
        return output
1832
 
 
1833
 
 
1834
 
class TestSelftest(tests.TestCase, SelfTestHelper):
 
1823
class TestSelftest(TestCase):
1835
1824
    """Tests of bzrlib.tests.selftest."""
1836
1825
 
1837
1826
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1838
1827
        factory_called = []
1839
1828
        def factory():
1840
1829
            factory_called.append(True)
1841
 
            return TestUtil.TestSuite()
 
1830
            return TestSuite()
1842
1831
        out = StringIO()
1843
1832
        err = StringIO()
1844
1833
        self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1845
1834
            test_suite_factory=factory)
1846
1835
        self.assertEqual([True], factory_called)
1847
1836
 
1848
 
    def factory(self):
1849
 
        """A test suite factory."""
1850
 
        class Test(tests.TestCase):
1851
 
            def a(self):
1852
 
                pass
1853
 
            def b(self):
1854
 
                pass
1855
 
            def c(self):
1856
 
                pass
1857
 
        return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
1858
 
 
1859
 
    def test_list_only(self):
1860
 
        output = self.run_selftest(test_suite_factory=self.factory,
1861
 
            list_only=True)
1862
 
        self.assertEqual(3, len(output.readlines()))
1863
 
 
1864
 
    def test_list_only_filtered(self):
1865
 
        output = self.run_selftest(test_suite_factory=self.factory,
1866
 
            list_only=True, pattern="Test.b")
1867
 
        self.assertEndsWith(output.getvalue(), "Test.b\n")
1868
 
        self.assertLength(1, output.readlines())
1869
 
 
1870
 
    def test_list_only_excludes(self):
1871
 
        output = self.run_selftest(test_suite_factory=self.factory,
1872
 
            list_only=True, exclude_pattern="Test.b")
1873
 
        self.assertNotContainsRe("Test.b", output.getvalue())
1874
 
        self.assertLength(2, output.readlines())
1875
 
 
1876
 
    def test_lsprof_tests(self):
1877
 
        self.requireFeature(test_lsprof.LSProfFeature)
1878
 
        calls = []
1879
 
        class Test(object):
1880
 
            def __call__(test, result):
1881
 
                test.run(result)
1882
 
            def run(test, result):
1883
 
                self.assertIsInstance(result, tests.ForwardingResult)
1884
 
                calls.append("called")
1885
 
            def countTestCases(self):
1886
 
                return 1
1887
 
        self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
1888
 
        self.assertLength(1, calls)
1889
 
 
1890
 
    def test_random(self):
1891
 
        # test randomising by listing a number of tests.
1892
 
        output_123 = self.run_selftest(test_suite_factory=self.factory,
1893
 
            list_only=True, random_seed="123")
1894
 
        output_234 = self.run_selftest(test_suite_factory=self.factory,
1895
 
            list_only=True, random_seed="234")
1896
 
        self.assertNotEqual(output_123, output_234)
1897
 
        # "Randominzing test order..\n\n
1898
 
        self.assertLength(5, output_123.readlines())
1899
 
        self.assertLength(5, output_234.readlines())
1900
 
 
1901
 
    def test_random_reuse_is_same_order(self):
1902
 
        # test randomising by listing a number of tests.
1903
 
        expected = self.run_selftest(test_suite_factory=self.factory,
1904
 
            list_only=True, random_seed="123")
1905
 
        repeated = self.run_selftest(test_suite_factory=self.factory,
1906
 
            list_only=True, random_seed="123")
1907
 
        self.assertEqual(expected.getvalue(), repeated.getvalue())
1908
 
 
1909
 
    def test_runner_class(self):
1910
 
        self.requireFeature(features.subunit)
1911
 
        from subunit import ProtocolTestCase
1912
 
        stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
1913
 
            test_suite_factory=self.factory)
1914
 
        test = ProtocolTestCase(stream)
1915
 
        result = unittest.TestResult()
1916
 
        test.run(result)
1917
 
        self.assertEqual(3, result.testsRun)
1918
 
 
1919
 
    def test_starting_with_single_argument(self):
1920
 
        output = self.run_selftest(test_suite_factory=self.factory,
1921
 
            starting_with=['bzrlib.tests.test_selftest.Test.a'],
1922
 
            list_only=True)
1923
 
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
1924
 
            output.getvalue())
1925
 
 
1926
 
    def test_starting_with_multiple_argument(self):
1927
 
        output = self.run_selftest(test_suite_factory=self.factory,
1928
 
            starting_with=['bzrlib.tests.test_selftest.Test.a',
1929
 
                'bzrlib.tests.test_selftest.Test.b'],
1930
 
            list_only=True)
1931
 
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
1932
 
            'bzrlib.tests.test_selftest.Test.b\n',
1933
 
            output.getvalue())
1934
 
 
1935
 
    def check_transport_set(self, transport_server):
1936
 
        captured_transport = []
1937
 
        def seen_transport(a_transport):
1938
 
            captured_transport.append(a_transport)
1939
 
        class Capture(tests.TestCase):
1940
 
            def a(self):
1941
 
                seen_transport(bzrlib.tests.default_transport)
1942
 
        def factory():
1943
 
            return TestUtil.TestSuite([Capture("a")])
1944
 
        self.run_selftest(transport=transport_server, test_suite_factory=factory)
1945
 
        self.assertEqual(transport_server, captured_transport[0])
1946
 
 
1947
 
    def test_transport_sftp(self):
1948
 
        self.requireFeature(features.paramiko)
1949
 
        from bzrlib.tests import stub_sftp
1950
 
        self.check_transport_set(stub_sftp.SFTPAbsoluteServer)
1951
 
 
1952
 
    def test_transport_memory(self):
1953
 
        self.check_transport_set(memory.MemoryServer)
1954
 
 
1955
 
 
1956
 
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
1957
 
    # Does IO: reads test.list
1958
 
 
1959
 
    def test_load_list(self):
1960
 
        # Provide a list with one test - this test.
1961
 
        test_id_line = '%s\n' % self.id()
1962
 
        self.build_tree_contents([('test.list', test_id_line)])
1963
 
        # And generate a list of the tests in  the suite.
1964
 
        stream = self.run_selftest(load_list='test.list', list_only=True)
1965
 
        self.assertEqual(test_id_line, stream.getvalue())
1966
 
 
1967
 
    def test_load_unknown(self):
1968
 
        # Provide a list with one test - this test.
1969
 
        # And generate a list of the tests in  the suite.
1970
 
        err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
1971
 
            load_list='missing file name', list_only=True)
1972
 
 
1973
 
 
1974
 
class TestRunBzr(tests.TestCase):
1975
 
 
1976
 
    out = ''
1977
 
    err = ''
1978
 
 
1979
 
    def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
1980
 
                         working_dir=None):
1981
 
        """Override _run_bzr_core to test how it is invoked by run_bzr.
1982
 
 
1983
 
        Attempts to run bzr from inside this class don't actually run it.
1984
 
 
1985
 
        We test how run_bzr actually invokes bzr in another location.  Here we
1986
 
        only need to test that it passes the right parameters to run_bzr.
1987
 
        """
1988
 
        self.argv = list(argv)
1989
 
        self.retcode = retcode
1990
 
        self.encoding = encoding
1991
 
        self.stdin = stdin
1992
 
        self.working_dir = working_dir
1993
 
        return self.retcode, self.out, self.err
1994
 
 
1995
 
    def test_run_bzr_error(self):
1996
 
        self.out = "It sure does!\n"
1997
 
        out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
1998
 
        self.assertEqual(['rocks'], self.argv)
1999
 
        self.assertEqual(34, self.retcode)
2000
 
        self.assertEqual('It sure does!\n', out)
2001
 
        self.assertEquals(out, self.out)
2002
 
        self.assertEqual('', err)
2003
 
        self.assertEquals(err, self.err)
2004
 
 
2005
 
    def test_run_bzr_error_regexes(self):
2006
 
        self.out = ''
2007
 
        self.err = "bzr: ERROR: foobarbaz is not versioned"
2008
 
        out, err = self.run_bzr_error(
2009
 
            ["bzr: ERROR: foobarbaz is not versioned"],
2010
 
            ['file-id', 'foobarbaz'])
2011
 
 
2012
 
    def test_encoding(self):
2013
 
        """Test that run_bzr passes encoding to _run_bzr_core"""
2014
 
        self.run_bzr('foo bar')
2015
 
        self.assertEqual(None, self.encoding)
2016
 
        self.assertEqual(['foo', 'bar'], self.argv)
2017
 
 
2018
 
        self.run_bzr('foo bar', encoding='baz')
2019
 
        self.assertEqual('baz', self.encoding)
2020
 
        self.assertEqual(['foo', 'bar'], self.argv)
2021
 
 
2022
 
    def test_retcode(self):
2023
 
        """Test that run_bzr passes retcode to _run_bzr_core"""
2024
 
        # Default is retcode == 0
2025
 
        self.run_bzr('foo bar')
2026
 
        self.assertEqual(0, self.retcode)
2027
 
        self.assertEqual(['foo', 'bar'], self.argv)
2028
 
 
2029
 
        self.run_bzr('foo bar', retcode=1)
2030
 
        self.assertEqual(1, self.retcode)
2031
 
        self.assertEqual(['foo', 'bar'], self.argv)
2032
 
 
2033
 
        self.run_bzr('foo bar', retcode=None)
2034
 
        self.assertEqual(None, self.retcode)
2035
 
        self.assertEqual(['foo', 'bar'], self.argv)
2036
 
 
2037
 
        self.run_bzr(['foo', 'bar'], retcode=3)
2038
 
        self.assertEqual(3, self.retcode)
2039
 
        self.assertEqual(['foo', 'bar'], self.argv)
2040
 
 
2041
 
    def test_stdin(self):
2042
 
        # test that the stdin keyword to run_bzr is passed through to
2043
 
        # _run_bzr_core as-is. We do this by overriding
2044
 
        # _run_bzr_core in this class, and then calling run_bzr,
2045
 
        # which is a convenience function for _run_bzr_core, so
2046
 
        # should invoke it.
2047
 
        self.run_bzr('foo bar', stdin='gam')
2048
 
        self.assertEqual('gam', self.stdin)
2049
 
        self.assertEqual(['foo', 'bar'], self.argv)
2050
 
 
2051
 
        self.run_bzr('foo bar', stdin='zippy')
2052
 
        self.assertEqual('zippy', self.stdin)
2053
 
        self.assertEqual(['foo', 'bar'], self.argv)
2054
 
 
2055
 
    def test_working_dir(self):
2056
 
        """Test that run_bzr passes working_dir to _run_bzr_core"""
2057
 
        self.run_bzr('foo bar')
2058
 
        self.assertEqual(None, self.working_dir)
2059
 
        self.assertEqual(['foo', 'bar'], self.argv)
2060
 
 
2061
 
        self.run_bzr('foo bar', working_dir='baz')
2062
 
        self.assertEqual('baz', self.working_dir)
2063
 
        self.assertEqual(['foo', 'bar'], self.argv)
2064
 
 
2065
 
    def test_reject_extra_keyword_arguments(self):
2066
 
        self.assertRaises(TypeError, self.run_bzr, "foo bar",
2067
 
                          error_regex=['error message'])
2068
 
 
2069
 
 
2070
 
class TestRunBzrCaptured(tests.TestCaseWithTransport):
2071
 
    # Does IO when testing the working_dir parameter.
2072
 
 
2073
 
    def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2074
 
                         a_callable=None, *args, **kwargs):
2075
 
        self.stdin = stdin
2076
 
        self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
2077
 
        self.factory = bzrlib.ui.ui_factory
2078
 
        self.working_dir = osutils.getcwd()
2079
 
        stdout.write('foo\n')
2080
 
        stderr.write('bar\n')
2081
 
        return 0
2082
 
 
2083
 
    def test_stdin(self):
2084
 
        # test that the stdin keyword to _run_bzr_core is passed through to
2085
 
        # apply_redirected as a StringIO. We do this by overriding
2086
 
        # apply_redirected in this class, and then calling _run_bzr_core,
2087
 
        # which calls apply_redirected.
2088
 
        self.run_bzr(['foo', 'bar'], stdin='gam')
2089
 
        self.assertEqual('gam', self.stdin.read())
2090
 
        self.assertTrue(self.stdin is self.factory_stdin)
2091
 
        self.run_bzr(['foo', 'bar'], stdin='zippy')
2092
 
        self.assertEqual('zippy', self.stdin.read())
2093
 
        self.assertTrue(self.stdin is self.factory_stdin)
2094
 
 
2095
 
    def test_ui_factory(self):
2096
 
        # each invocation of self.run_bzr should get its
2097
 
        # own UI factory, which is an instance of TestUIFactory,
2098
 
        # with stdin, stdout and stderr attached to the stdin,
2099
 
        # stdout and stderr of the invoked run_bzr
2100
 
        current_factory = bzrlib.ui.ui_factory
2101
 
        self.run_bzr(['foo'])
2102
 
        self.failIf(current_factory is self.factory)
2103
 
        self.assertNotEqual(sys.stdout, self.factory.stdout)
2104
 
        self.assertNotEqual(sys.stderr, self.factory.stderr)
2105
 
        self.assertEqual('foo\n', self.factory.stdout.getvalue())
2106
 
        self.assertEqual('bar\n', self.factory.stderr.getvalue())
2107
 
        self.assertIsInstance(self.factory, tests.TestUIFactory)
2108
 
 
2109
 
    def test_working_dir(self):
2110
 
        self.build_tree(['one/', 'two/'])
2111
 
        cwd = osutils.getcwd()
2112
 
 
2113
 
        # Default is to work in the current directory
2114
 
        self.run_bzr(['foo', 'bar'])
2115
 
        self.assertEqual(cwd, self.working_dir)
2116
 
 
2117
 
        self.run_bzr(['foo', 'bar'], working_dir=None)
2118
 
        self.assertEqual(cwd, self.working_dir)
2119
 
 
2120
 
        # The function should be run in the alternative directory
2121
 
        # but afterwards the current working dir shouldn't be changed
2122
 
        self.run_bzr(['foo', 'bar'], working_dir='one')
2123
 
        self.assertNotEqual(cwd, self.working_dir)
2124
 
        self.assertEndsWith(self.working_dir, 'one')
2125
 
        self.assertEqual(cwd, osutils.getcwd())
2126
 
 
2127
 
        self.run_bzr(['foo', 'bar'], working_dir='two')
2128
 
        self.assertNotEqual(cwd, self.working_dir)
2129
 
        self.assertEndsWith(self.working_dir, 'two')
2130
 
        self.assertEqual(cwd, osutils.getcwd())
2131
 
 
2132
 
 
2133
 
class StubProcess(object):
2134
 
    """A stub process for testing run_bzr_subprocess."""
2135
 
    
2136
 
    def __init__(self, out="", err="", retcode=0):
2137
 
        self.out = out
2138
 
        self.err = err
2139
 
        self.returncode = retcode
2140
 
 
2141
 
    def communicate(self):
2142
 
        return self.out, self.err
2143
 
 
2144
 
 
2145
 
class TestWithFakedStartBzrSubprocess(tests.TestCaseWithTransport):
2146
 
    """Base class for tests testing how we might run bzr."""
2147
 
 
2148
 
    def setUp(self):
2149
 
        tests.TestCaseWithTransport.setUp(self)
2150
 
        self.subprocess_calls = []
2151
 
 
2152
 
    def start_bzr_subprocess(self, process_args, env_changes=None,
2153
 
                             skip_if_plan_to_signal=False,
2154
 
                             working_dir=None,
2155
 
                             allow_plugins=False):
2156
 
        """capture what run_bzr_subprocess tries to do."""
2157
 
        self.subprocess_calls.append({'process_args':process_args,
2158
 
            'env_changes':env_changes,
2159
 
            'skip_if_plan_to_signal':skip_if_plan_to_signal,
2160
 
            'working_dir':working_dir, 'allow_plugins':allow_plugins})
2161
 
        return self.next_subprocess
2162
 
 
2163
 
 
2164
 
class TestRunBzrSubprocess(TestWithFakedStartBzrSubprocess):
2165
 
 
2166
 
    def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
2167
 
        """Run run_bzr_subprocess with args and kwargs using a stubbed process.
2168
 
 
2169
 
        Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
2170
 
        that will return static results. This assertion method populates those
2171
 
        results and also checks the arguments run_bzr_subprocess generates.
2172
 
        """
2173
 
        self.next_subprocess = process
2174
 
        try:
2175
 
            result = self.run_bzr_subprocess(*args, **kwargs)
2176
 
        except:
2177
 
            self.next_subprocess = None
2178
 
            for key, expected in expected_args.iteritems():
2179
 
                self.assertEqual(expected, self.subprocess_calls[-1][key])
2180
 
            raise
 
1837
 
 
1838
class TestKnownFailure(TestCase):
 
1839
 
 
1840
    def test_known_failure(self):
 
1841
        """Check that KnownFailure is defined appropriately."""
 
1842
        # a KnownFailure is an assertion error for compatability with unaware
 
1843
        # runners.
 
1844
        self.assertIsInstance(KnownFailure(""), AssertionError)
 
1845
 
 
1846
    def test_expect_failure(self):
 
1847
        try:
 
1848
            self.expectFailure("Doomed to failure", self.assertTrue, False)
 
1849
        except KnownFailure, e:
 
1850
            self.assertEqual('Doomed to failure', e.args[0])
 
1851
        try:
 
1852
            self.expectFailure("Doomed to failure", self.assertTrue, True)
 
1853
        except AssertionError, e:
 
1854
            self.assertEqual('Unexpected success.  Should have failed:'
 
1855
                             ' Doomed to failure', e.args[0])
2181
1856
        else:
2182
 
            self.next_subprocess = None
2183
 
            for key, expected in expected_args.iteritems():
2184
 
                self.assertEqual(expected, self.subprocess_calls[-1][key])
2185
 
            return result
2186
 
 
2187
 
    def test_run_bzr_subprocess(self):
2188
 
        """The run_bzr_helper_external command behaves nicely."""
2189
 
        self.assertRunBzrSubprocess({'process_args':['--version']},
2190
 
            StubProcess(), '--version')
2191
 
        self.assertRunBzrSubprocess({'process_args':['--version']},
2192
 
            StubProcess(), ['--version'])
2193
 
        # retcode=None disables retcode checking
2194
 
        result = self.assertRunBzrSubprocess({},
2195
 
            StubProcess(retcode=3), '--version', retcode=None)
2196
 
        result = self.assertRunBzrSubprocess({},
2197
 
            StubProcess(out="is free software"), '--version')
2198
 
        self.assertContainsRe(result[0], 'is free software')
2199
 
        # Running a subcommand that is missing errors
2200
 
        self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
2201
 
            {'process_args':['--versionn']}, StubProcess(retcode=3),
2202
 
            '--versionn')
2203
 
        # Unless it is told to expect the error from the subprocess
2204
 
        result = self.assertRunBzrSubprocess({},
2205
 
            StubProcess(retcode=3), '--versionn', retcode=3)
2206
 
        # Or to ignore retcode checking
2207
 
        result = self.assertRunBzrSubprocess({},
2208
 
            StubProcess(err="unknown command", retcode=3), '--versionn',
2209
 
            retcode=None)
2210
 
        self.assertContainsRe(result[1], 'unknown command')
2211
 
 
2212
 
    def test_env_change_passes_through(self):
2213
 
        self.assertRunBzrSubprocess(
2214
 
            {'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
2215
 
            StubProcess(), '',
2216
 
            env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
2217
 
 
2218
 
    def test_no_working_dir_passed_as_None(self):
2219
 
        self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
2220
 
 
2221
 
    def test_no_working_dir_passed_through(self):
2222
 
        self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
2223
 
            working_dir='dir')
2224
 
 
2225
 
    def test_run_bzr_subprocess_no_plugins(self):
2226
 
        self.assertRunBzrSubprocess({'allow_plugins': False},
2227
 
            StubProcess(), '')
2228
 
 
2229
 
    def test_allow_plugins(self):
2230
 
        self.assertRunBzrSubprocess({'allow_plugins': True},
2231
 
            StubProcess(), '', allow_plugins=True)
2232
 
 
2233
 
 
2234
 
class TestFinishBzrSubprocess(TestWithFakedStartBzrSubprocess):
2235
 
 
2236
 
    def test_finish_bzr_subprocess_with_error(self):
2237
 
        """finish_bzr_subprocess allows specification of the desired exit code.
2238
 
        """
2239
 
        process = StubProcess(err="unknown command", retcode=3)
2240
 
        result = self.finish_bzr_subprocess(process, retcode=3)
2241
 
        self.assertEqual('', result[0])
2242
 
        self.assertContainsRe(result[1], 'unknown command')
2243
 
 
2244
 
    def test_finish_bzr_subprocess_ignoring_retcode(self):
2245
 
        """finish_bzr_subprocess allows the exit code to be ignored."""
2246
 
        process = StubProcess(err="unknown command", retcode=3)
2247
 
        result = self.finish_bzr_subprocess(process, retcode=None)
2248
 
        self.assertEqual('', result[0])
2249
 
        self.assertContainsRe(result[1], 'unknown command')
2250
 
 
2251
 
    def test_finish_subprocess_with_unexpected_retcode(self):
2252
 
        """finish_bzr_subprocess raises self.failureException if the retcode is
2253
 
        not the expected one.
2254
 
        """
2255
 
        process = StubProcess(err="unknown command", retcode=3)
2256
 
        self.assertRaises(self.failureException, self.finish_bzr_subprocess,
2257
 
                          process)
2258
 
 
2259
 
 
2260
 
class _DontSpawnProcess(Exception):
2261
 
    """A simple exception which just allows us to skip unnecessary steps"""
2262
 
 
2263
 
 
2264
 
class TestStartBzrSubProcess(tests.TestCase):
2265
 
 
2266
 
    def check_popen_state(self):
2267
 
        """Replace to make assertions when popen is called."""
2268
 
 
2269
 
    def _popen(self, *args, **kwargs):
2270
 
        """Record the command that is run, so that we can ensure it is correct"""
2271
 
        self.check_popen_state()
2272
 
        self._popen_args = args
2273
 
        self._popen_kwargs = kwargs
2274
 
        raise _DontSpawnProcess()
2275
 
 
2276
 
    def test_run_bzr_subprocess_no_plugins(self):
2277
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
2278
 
        command = self._popen_args[0]
2279
 
        self.assertEqual(sys.executable, command[0])
2280
 
        self.assertEqual(self.get_bzr_path(), command[1])
2281
 
        self.assertEqual(['--no-plugins'], command[2:])
2282
 
 
2283
 
    def test_allow_plugins(self):
2284
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2285
 
            allow_plugins=True)
2286
 
        command = self._popen_args[0]
2287
 
        self.assertEqual([], command[2:])
2288
 
 
2289
 
    def test_set_env(self):
2290
 
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
2291
 
        # set in the child
2292
 
        def check_environment():
2293
 
            self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2294
 
        self.check_popen_state = check_environment
2295
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2296
 
            env_changes={'EXISTANT_ENV_VAR':'set variable'})
2297
 
        # not set in theparent
2298
 
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2299
 
 
2300
 
    def test_run_bzr_subprocess_env_del(self):
2301
 
        """run_bzr_subprocess can remove environment variables too."""
2302
 
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
2303
 
        def check_environment():
2304
 
            self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2305
 
        os.environ['EXISTANT_ENV_VAR'] = 'set variable'
2306
 
        self.check_popen_state = check_environment
2307
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2308
 
            env_changes={'EXISTANT_ENV_VAR':None})
2309
 
        # Still set in parent
2310
 
        self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2311
 
        del os.environ['EXISTANT_ENV_VAR']
2312
 
 
2313
 
    def test_env_del_missing(self):
2314
 
        self.failIf('NON_EXISTANT_ENV_VAR' in os.environ)
2315
 
        def check_environment():
2316
 
            self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2317
 
        self.check_popen_state = check_environment
2318
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2319
 
            env_changes={'NON_EXISTANT_ENV_VAR':None})
2320
 
 
2321
 
    def test_working_dir(self):
2322
 
        """Test that we can specify the working dir for the child"""
2323
 
        orig_getcwd = osutils.getcwd
2324
 
        orig_chdir = os.chdir
2325
 
        chdirs = []
2326
 
        def chdir(path):
2327
 
            chdirs.append(path)
2328
 
        os.chdir = chdir
2329
 
        try:
2330
 
            def getcwd():
2331
 
                return 'current'
2332
 
            osutils.getcwd = getcwd
2333
 
            try:
2334
 
                self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2335
 
                    working_dir='foo')
2336
 
            finally:
2337
 
                osutils.getcwd = orig_getcwd
2338
 
        finally:
2339
 
            os.chdir = orig_chdir
2340
 
        self.assertEqual(['foo', 'current'], chdirs)
2341
 
 
2342
 
 
2343
 
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
2344
 
    """Tests that really need to do things with an external bzr."""
2345
 
 
2346
 
    def test_start_and_stop_bzr_subprocess_send_signal(self):
2347
 
        """finish_bzr_subprocess raises self.failureException if the retcode is
2348
 
        not the expected one.
2349
 
        """
2350
 
        self.disable_missing_extensions_warning()
2351
 
        process = self.start_bzr_subprocess(['wait-until-signalled'],
2352
 
                                            skip_if_plan_to_signal=True)
2353
 
        self.assertEqual('running\n', process.stdout.readline())
2354
 
        result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
2355
 
                                            retcode=3)
2356
 
        self.assertEqual('', result[0])
2357
 
        self.assertEqual('bzr: interrupted\n', result[1])
2358
 
 
2359
 
 
2360
 
class TestFeature(tests.TestCase):
 
1857
            self.fail('Assertion not raised')
 
1858
 
 
1859
 
 
1860
class TestFeature(TestCase):
2361
1861
 
2362
1862
    def test_caching(self):
2363
1863
        """Feature._probe is called by the feature at most once."""
2364
 
        class InstrumentedFeature(tests.Feature):
 
1864
        class InstrumentedFeature(Feature):
2365
1865
            def __init__(self):
2366
 
                super(InstrumentedFeature, self).__init__()
 
1866
                Feature.__init__(self)
2367
1867
                self.calls = []
2368
1868
            def _probe(self):
2369
1869
                self.calls.append('_probe')
2376
1876
 
2377
1877
    def test_named_str(self):
2378
1878
        """Feature.__str__ should thunk to feature_name()."""
2379
 
        class NamedFeature(tests.Feature):
 
1879
        class NamedFeature(Feature):
2380
1880
            def feature_name(self):
2381
1881
                return 'symlinks'
2382
1882
        feature = NamedFeature()
2384
1884
 
2385
1885
    def test_default_str(self):
2386
1886
        """Feature.__str__ should default to __class__.__name__."""
2387
 
        class NamedFeature(tests.Feature):
 
1887
        class NamedFeature(Feature):
2388
1888
            pass
2389
1889
        feature = NamedFeature()
2390
1890
        self.assertEqual('NamedFeature', str(feature))
2391
1891
 
2392
1892
 
2393
 
class TestUnavailableFeature(tests.TestCase):
 
1893
class TestUnavailableFeature(TestCase):
2394
1894
 
2395
1895
    def test_access_feature(self):
2396
 
        feature = tests.Feature()
2397
 
        exception = tests.UnavailableFeature(feature)
 
1896
        feature = Feature()
 
1897
        exception = UnavailableFeature(feature)
2398
1898
        self.assertIs(feature, exception.args[0])
2399
1899
 
2400
1900
 
2401
 
simple_thunk_feature = tests._CompatabilityThunkFeature(
2402
 
    deprecated_in((2, 1, 0)),
2403
 
    'bzrlib.tests.test_selftest',
2404
 
    'simple_thunk_feature','UnicodeFilename',
2405
 
    replacement_module='bzrlib.tests'
2406
 
    )
2407
 
 
2408
 
class Test_CompatibilityFeature(tests.TestCase):
2409
 
 
2410
 
    def test_does_thunk(self):
2411
 
        res = self.callDeprecated(
2412
 
            ['bzrlib.tests.test_selftest.simple_thunk_feature was deprecated'
2413
 
             ' in version 2.1.0. Use bzrlib.tests.UnicodeFilename instead.'],
2414
 
            simple_thunk_feature.available)
2415
 
        self.assertEqual(tests.UnicodeFilename.available(), res)
2416
 
 
2417
 
 
2418
 
class TestModuleAvailableFeature(tests.TestCase):
2419
 
 
2420
 
    def test_available_module(self):
2421
 
        feature = tests.ModuleAvailableFeature('bzrlib.tests')
2422
 
        self.assertEqual('bzrlib.tests', feature.module_name)
2423
 
        self.assertEqual('bzrlib.tests', str(feature))
2424
 
        self.assertTrue(feature.available())
2425
 
        self.assertIs(tests, feature.module)
2426
 
 
2427
 
    def test_unavailable_module(self):
2428
 
        feature = tests.ModuleAvailableFeature('bzrlib.no_such_module_exists')
2429
 
        self.assertEqual('bzrlib.no_such_module_exists', str(feature))
2430
 
        self.assertFalse(feature.available())
2431
 
        self.assertIs(None, feature.module)
2432
 
 
2433
 
 
2434
 
class TestSelftestFiltering(tests.TestCase):
 
1901
class TestSelftestFiltering(TestCase):
2435
1902
 
2436
1903
    def setUp(self):
2437
 
        tests.TestCase.setUp(self)
 
1904
        TestCase.setUp(self)
2438
1905
        self.suite = TestUtil.TestSuite()
2439
1906
        self.loader = TestUtil.TestLoader()
2440
 
        self.suite.addTest(self.loader.loadTestsFromModule(
2441
 
            sys.modules['bzrlib.tests.test_selftest']))
 
1907
        self.suite.addTest(self.loader.loadTestsFromModuleNames([
 
1908
            'bzrlib.tests.test_selftest']))
2442
1909
        self.all_names = _test_ids(self.suite)
2443
1910
 
2444
1911
    def test_condition_id_re(self):
2445
1912
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2446
1913
            'test_condition_id_re')
2447
 
        filtered_suite = tests.filter_suite_by_condition(
2448
 
            self.suite, tests.condition_id_re('test_condition_id_re'))
 
1914
        filtered_suite = filter_suite_by_condition(self.suite,
 
1915
            condition_id_re('test_condition_id_re'))
2449
1916
        self.assertEqual([test_name], _test_ids(filtered_suite))
2450
1917
 
2451
1918
    def test_condition_id_in_list(self):
2452
1919
        test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
2453
1920
                      'test_condition_id_in_list']
2454
1921
        id_list = tests.TestIdList(test_names)
2455
 
        filtered_suite = tests.filter_suite_by_condition(
 
1922
        filtered_suite = filter_suite_by_condition(
2456
1923
            self.suite, tests.condition_id_in_list(id_list))
2457
1924
        my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
2458
 
        re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
 
1925
        re_filtered = filter_suite_by_re(self.suite, my_pattern)
2459
1926
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2460
1927
 
2461
1928
    def test_condition_id_startswith(self):
2465
1932
        test_names = [ klass + 'test_condition_id_in_list',
2466
1933
                      klass + 'test_condition_id_startswith',
2467
1934
                     ]
2468
 
        filtered_suite = tests.filter_suite_by_condition(
 
1935
        filtered_suite = filter_suite_by_condition(
2469
1936
            self.suite, tests.condition_id_startswith([start1, start2]))
2470
1937
        self.assertEqual(test_names, _test_ids(filtered_suite))
2471
1938
 
2472
1939
    def test_condition_isinstance(self):
2473
 
        filtered_suite = tests.filter_suite_by_condition(
2474
 
            self.suite, tests.condition_isinstance(self.__class__))
 
1940
        filtered_suite = filter_suite_by_condition(self.suite,
 
1941
            condition_isinstance(self.__class__))
2475
1942
        class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2476
 
        re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
 
1943
        re_filtered = filter_suite_by_re(self.suite, class_pattern)
2477
1944
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2478
1945
 
2479
1946
    def test_exclude_tests_by_condition(self):
2480
1947
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2481
1948
            'test_exclude_tests_by_condition')
2482
 
        filtered_suite = tests.exclude_tests_by_condition(self.suite,
 
1949
        filtered_suite = exclude_tests_by_condition(self.suite,
2483
1950
            lambda x:x.id() == excluded_name)
2484
1951
        self.assertEqual(len(self.all_names) - 1,
2485
1952
            filtered_suite.countTestCases())
2490
1957
 
2491
1958
    def test_exclude_tests_by_re(self):
2492
1959
        self.all_names = _test_ids(self.suite)
2493
 
        filtered_suite = tests.exclude_tests_by_re(self.suite,
2494
 
                                                   'exclude_tests_by_re')
 
1960
        filtered_suite = exclude_tests_by_re(self.suite, 'exclude_tests_by_re')
2495
1961
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2496
1962
            'test_exclude_tests_by_re')
2497
1963
        self.assertEqual(len(self.all_names) - 1,
2504
1970
    def test_filter_suite_by_condition(self):
2505
1971
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2506
1972
            'test_filter_suite_by_condition')
2507
 
        filtered_suite = tests.filter_suite_by_condition(self.suite,
 
1973
        filtered_suite = filter_suite_by_condition(self.suite,
2508
1974
            lambda x:x.id() == test_name)
2509
1975
        self.assertEqual([test_name], _test_ids(filtered_suite))
2510
1976
 
2511
1977
    def test_filter_suite_by_re(self):
2512
 
        filtered_suite = tests.filter_suite_by_re(self.suite,
2513
 
                                                  'test_filter_suite_by_r')
 
1978
        filtered_suite = filter_suite_by_re(self.suite, 'test_filter_suite_by_r')
2514
1979
        filtered_names = _test_ids(filtered_suite)
2515
1980
        self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
2516
1981
            'TestSelftestFiltering.test_filter_suite_by_re'])
2544
2009
 
2545
2010
    def test_preserve_input(self):
2546
2011
        # NB: Surely this is something in the stdlib to do this?
2547
 
        self.assertTrue(self.suite is tests.preserve_input(self.suite))
2548
 
        self.assertTrue("@#$" is tests.preserve_input("@#$"))
 
2012
        self.assertTrue(self.suite is preserve_input(self.suite))
 
2013
        self.assertTrue("@#$" is preserve_input("@#$"))
2549
2014
 
2550
2015
    def test_randomize_suite(self):
2551
 
        randomized_suite = tests.randomize_suite(self.suite)
 
2016
        randomized_suite = randomize_suite(self.suite)
2552
2017
        # randomizing should not add or remove test names.
2553
2018
        self.assertEqual(set(_test_ids(self.suite)),
2554
2019
                         set(_test_ids(randomized_suite)))
2564
2029
 
2565
2030
    def test_split_suit_by_condition(self):
2566
2031
        self.all_names = _test_ids(self.suite)
2567
 
        condition = tests.condition_id_re('test_filter_suite_by_r')
2568
 
        split_suite = tests.split_suite_by_condition(self.suite, condition)
 
2032
        condition = condition_id_re('test_filter_suite_by_r')
 
2033
        split_suite = split_suite_by_condition(self.suite, condition)
2569
2034
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2570
2035
            'test_filter_suite_by_re')
2571
2036
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2576
2041
 
2577
2042
    def test_split_suit_by_re(self):
2578
2043
        self.all_names = _test_ids(self.suite)
2579
 
        split_suite = tests.split_suite_by_re(self.suite,
2580
 
                                              'test_filter_suite_by_r')
 
2044
        split_suite = split_suite_by_re(self.suite, 'test_filter_suite_by_r')
2581
2045
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2582
2046
            'test_filter_suite_by_re')
2583
2047
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2587
2051
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2588
2052
 
2589
2053
 
2590
 
class TestCheckInventoryShape(tests.TestCaseWithTransport):
 
2054
class TestCheckInventoryShape(TestCaseWithTransport):
2591
2055
 
2592
2056
    def test_check_inventory_shape(self):
2593
2057
        files = ['a', 'b/', 'b/c']
2601
2065
            tree.unlock()
2602
2066
 
2603
2067
 
2604
 
class TestBlackboxSupport(tests.TestCase):
 
2068
class TestBlackboxSupport(TestCase):
2605
2069
    """Tests for testsuite blackbox features."""
2606
2070
 
2607
2071
    def test_run_bzr_failure_not_caught(self):
2615
2079
        # the test framework
2616
2080
        self.assertEquals('always fails', str(e))
2617
2081
        # check that there's no traceback in the test log
2618
 
        self.assertNotContainsRe(self.get_log(), r'Traceback')
 
2082
        self.assertNotContainsRe(self._get_log(keep_log_file=True),
 
2083
            r'Traceback')
2619
2084
 
2620
2085
    def test_run_bzr_user_error_caught(self):
2621
2086
        # Running bzr in blackbox mode, normal/expected/user errors should be
2622
2087
        # caught in the regular way and turned into an error message plus exit
2623
2088
        # code.
2624
 
        transport_server = memory.MemoryServer()
2625
 
        transport_server.start_server()
2626
 
        self.addCleanup(transport_server.stop_server)
2627
 
        url = transport_server.get_url()
2628
 
        self.permit_url(url)
2629
 
        out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
 
2089
        out, err = self.run_bzr(["log", "/nonexistantpath"], retcode=3)
2630
2090
        self.assertEqual(out, '')
2631
2091
        self.assertContainsRe(err,
2632
2092
            'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
2633
2093
 
2634
2094
 
2635
 
class TestTestLoader(tests.TestCase):
 
2095
class TestTestLoader(TestCase):
2636
2096
    """Tests for the test loader."""
2637
2097
 
2638
2098
    def _get_loader_and_module(self):
2639
2099
        """Gets a TestLoader and a module with one test in it."""
2640
2100
        loader = TestUtil.TestLoader()
2641
2101
        module = {}
2642
 
        class Stub(tests.TestCase):
 
2102
        class Stub(TestCase):
2643
2103
            def test_foo(self):
2644
2104
                pass
2645
2105
        class MyModule(object):
2658
2118
        # load_tests do not need that :)
2659
2119
        def load_tests(self, standard_tests, module, loader):
2660
2120
            result = loader.suiteClass()
2661
 
            for test in tests.iter_suite_tests(standard_tests):
 
2121
            for test in iter_suite_tests(standard_tests):
2662
2122
                result.addTests([test, test])
2663
2123
            return result
2664
2124
        # add a load_tests() method which multiplies the tests from the module.
2683
2143
 
2684
2144
    def _create_suite(self, test_id_list):
2685
2145
 
2686
 
        class Stub(tests.TestCase):
 
2146
        class Stub(TestCase):
2687
2147
            def test_foo(self):
2688
2148
                pass
2689
2149
 
2699
2159
 
2700
2160
    def _test_ids(self, test_suite):
2701
2161
        """Get the ids for the tests in a test suite."""
2702
 
        return [t.id() for t in tests.iter_suite_tests(test_suite)]
 
2162
        return [t.id() for t in iter_suite_tests(test_suite)]
2703
2163
 
2704
2164
    def test_empty_list(self):
2705
2165
        id_list = self._create_id_list([])
2731
2191
        self.assertTrue(id_list.refers_to('mod.class'))
2732
2192
        self.assertTrue(id_list.refers_to('mod.class.meth'))
2733
2193
 
 
2194
    def test_test_suite(self):
 
2195
        # This test is slow, so we do a single test with one test in each
 
2196
        # category
 
2197
        test_list = [
 
2198
            # testmod_names
 
2199
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
 
2200
            'bzrlib.tests.test_selftest.TestTestIdList.test_test_suite',
 
2201
            # transport implementations
 
2202
            'bzrlib.tests.test_transport_implementations.TransportTests'
 
2203
            '.test_abspath(LocalURLServer)',
 
2204
            # modules_to_doctest
 
2205
            'bzrlib.timestamp.format_highres_date',
 
2206
            # plugins can't be tested that way since selftest may be run with
 
2207
            # --no-plugins
 
2208
            ]
 
2209
        suite = tests.test_suite(test_list)
 
2210
        self.assertEquals(test_list, _test_ids(suite))
 
2211
 
2734
2212
    def test_test_suite_matches_id_list_with_unknown(self):
2735
2213
        loader = TestUtil.TestLoader()
2736
2214
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2744
2222
        loader = TestUtil.TestLoader()
2745
2223
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2746
2224
        dupes = loader.suiteClass()
2747
 
        for test in tests.iter_suite_tests(suite):
 
2225
        for test in iter_suite_tests(suite):
2748
2226
            dupes.addTest(test)
2749
2227
            dupes.addTest(test) # Add it again
2750
2228
 
2756
2234
                          duplicates)
2757
2235
 
2758
2236
 
2759
 
class TestTestSuite(tests.TestCase):
2760
 
 
2761
 
    def test__test_suite_testmod_names(self):
2762
 
        # Test that a plausible list of test module names are returned
2763
 
        # by _test_suite_testmod_names.
2764
 
        test_list = tests._test_suite_testmod_names()
2765
 
        self.assertSubset([
2766
 
            'bzrlib.tests.blackbox',
2767
 
            'bzrlib.tests.per_transport',
2768
 
            'bzrlib.tests.test_selftest',
2769
 
            ],
2770
 
            test_list)
2771
 
 
2772
 
    def test__test_suite_modules_to_doctest(self):
2773
 
        # Test that a plausible list of modules to doctest is returned
2774
 
        # by _test_suite_modules_to_doctest.
2775
 
        test_list = tests._test_suite_modules_to_doctest()
2776
 
        if __doc__ is None:
2777
 
            # When docstrings are stripped, there are no modules to doctest
2778
 
            self.assertEqual([], test_list)
2779
 
            return
2780
 
        self.assertSubset([
2781
 
            'bzrlib.timestamp',
2782
 
            ],
2783
 
            test_list)
2784
 
 
2785
 
    def test_test_suite(self):
2786
 
        # test_suite() loads the entire test suite to operate. To avoid this
2787
 
        # overhead, and yet still be confident that things are happening,
2788
 
        # we temporarily replace two functions used by test_suite with 
2789
 
        # test doubles that supply a few sample tests to load, and check they
2790
 
        # are loaded.
2791
 
        calls = []
2792
 
        def testmod_names():
2793
 
            calls.append("testmod_names")
2794
 
            return [
2795
 
                'bzrlib.tests.blackbox.test_branch',
2796
 
                'bzrlib.tests.per_transport',
2797
 
                'bzrlib.tests.test_selftest',
2798
 
                ]
2799
 
        self.overrideAttr(tests, '_test_suite_testmod_names', testmod_names)
2800
 
        def doctests():
2801
 
            calls.append("modules_to_doctest")
2802
 
            if __doc__ is None:
2803
 
                return []
2804
 
            return ['bzrlib.timestamp']
2805
 
        self.overrideAttr(tests, '_test_suite_modules_to_doctest', doctests)
2806
 
        expected_test_list = [
2807
 
            # testmod_names
2808
 
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
2809
 
            ('bzrlib.tests.per_transport.TransportTests'
2810
 
             '.test_abspath(LocalTransport,LocalURLServer)'),
2811
 
            'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
2812
 
            # plugins can't be tested that way since selftest may be run with
2813
 
            # --no-plugins
2814
 
            ]
2815
 
        if __doc__ is not None:
2816
 
            expected_test_list.extend([
2817
 
                # modules_to_doctest
2818
 
                'bzrlib.timestamp.format_highres_date',
2819
 
                ])
2820
 
        suite = tests.test_suite()
2821
 
        self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
2822
 
            set(calls))
2823
 
        self.assertSubset(expected_test_list, _test_ids(suite))
2824
 
 
2825
 
    def test_test_suite_list_and_start(self):
2826
 
        # We cannot test this at the same time as the main load, because we want
2827
 
        # to know that starting_with == None works. So a second load is
2828
 
        # incurred - note that the starting_with parameter causes a partial load
2829
 
        # rather than a full load so this test should be pretty quick.
2830
 
        test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
2831
 
        suite = tests.test_suite(test_list,
2832
 
                                 ['bzrlib.tests.test_selftest.TestTestSuite'])
2833
 
        # test_test_suite_list_and_start is not included 
2834
 
        self.assertEquals(test_list, _test_ids(suite))
2835
 
 
2836
 
 
2837
2237
class TestLoadTestIdList(tests.TestCaseInTempDir):
2838
2238
 
2839
2239
    def _create_test_list_file(self, file_name, content):
2877
2277
    def test_load_tests(self):
2878
2278
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2879
2279
        loader = self._create_loader(test_list)
 
2280
 
2880
2281
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2881
2282
        self.assertEquals(test_list, _test_ids(suite))
2882
2283
 
2883
2284
    def test_exclude_tests(self):
2884
2285
        test_list = ['bogus']
2885
2286
        loader = self._create_loader(test_list)
 
2287
 
2886
2288
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2887
2289
        self.assertEquals([], _test_ids(suite))
2888
2290
 
2933
2335
        tpr.register('bar', 'bbb.aaa.rrr')
2934
2336
        tpr.register('bar', 'bBB.aAA.rRR')
2935
2337
        self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
2936
 
        self.assertThat(self.get_log(),
2937
 
            DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR", ELLIPSIS))
 
2338
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
2339
                              r'.*bar.*bbb.aaa.rrr.*bBB.aAA.rRR')
2938
2340
 
2939
2341
    def test_get_unknown_prefix(self):
2940
2342
        tpr = self._get_registry()
2960
2362
        self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
2961
2363
 
2962
2364
 
2963
 
class TestRunSuite(tests.TestCase):
 
2365
class TestRunSuite(TestCase):
2964
2366
 
2965
2367
    def test_runner_class(self):
2966
2368
        """run_suite accepts and uses a runner_class keyword argument."""
2967
 
        class Stub(tests.TestCase):
 
2369
        class Stub(TestCase):
2968
2370
            def test_foo(self):
2969
2371
                pass
2970
2372
        suite = Stub("test_foo")
2971
2373
        calls = []
2972
 
        class MyRunner(tests.TextTestRunner):
 
2374
        class MyRunner(TextTestRunner):
2973
2375
            def run(self, test):
2974
2376
                calls.append(test)
2975
 
                return tests.ExtendedTestResult(self.stream, self.descriptions,
2976
 
                                                self.verbosity)
2977
 
        tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
2978
 
        self.assertLength(1, calls)
 
2377
                return ExtendedTestResult(self.stream, self.descriptions,
 
2378
                    self.verbosity)
 
2379
        run_suite(suite, runner_class=MyRunner, stream=StringIO())
 
2380
        self.assertEqual(calls, [suite])
 
2381
 
 
2382
    def test_done(self):
 
2383
        """run_suite should call result.done()"""
 
2384
        self.calls = 0
 
2385
        def one_more_call(): self.calls += 1
 
2386
        def test_function():
 
2387
            pass
 
2388
        test = unittest.FunctionTestCase(test_function)
 
2389
        class InstrumentedTestResult(ExtendedTestResult):
 
2390
            def done(self): one_more_call()
 
2391
        class MyRunner(TextTestRunner):
 
2392
            def run(self, test):
 
2393
                return InstrumentedTestResult(self.stream, self.descriptions,
 
2394
                                              self.verbosity)
 
2395
        run_suite(test, runner_class=MyRunner, stream=StringIO())
 
2396
        self.assertEquals(1, self.calls)