~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: John Ferlito
  • Date: 2009-05-25 10:59:42 UTC
  • mto: (4665.4.1 ppa-doc)
  • mto: This revision was merged to the branch mainline in revision 4693.
  • Revision ID: johnf@inodes.org-20090525105942-5xkcbe37m1u5lp5z
Update packaging scripts to make deployment a bit easier
Update documentation for deploying to PPA

Show diffs side-by-side

added added

removed removed

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