~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Martin Pool
  • Date: 2009-07-10 06:46:10 UTC
  • mto: (4525.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4526.
  • Revision ID: mbp@sourcefrog.net-20090710064610-sqviksbqp5i34sw2
Rename to per_interrepository

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
"""Tests for the test framework."""
18
18
 
19
19
from cStringIO import StringIO
20
 
from doctest import ELLIPSIS
21
20
import os
22
 
import signal
23
21
import sys
24
 
import threading
25
22
import time
26
23
import unittest
27
24
import warnings
28
25
 
29
 
from testtools import MultiTestResult
30
 
from testtools.content import Content
31
 
from testtools.content_type import ContentType
32
 
from testtools.matchers import (
33
 
    DocTestMatches,
34
 
    Equals,
35
 
    )
36
 
import testtools.tests.helpers
37
 
 
38
26
import bzrlib
39
27
from bzrlib import (
40
28
    branchbuilder,
44
32
    lockdir,
45
33
    memorytree,
46
34
    osutils,
 
35
    progress,
47
36
    remote,
48
37
    repository,
49
38
    symbol_versioning,
50
39
    tests,
51
 
    transport,
52
40
    workingtree,
53
41
    )
54
42
from bzrlib.repofmt import (
55
 
    groupcompress_repo,
56
43
    pack_repo,
57
44
    weaverepo,
58
45
    )
62
49
    deprecated_method,
63
50
    )
64
51
from bzrlib.tests import (
65
 
    features,
66
52
    test_lsprof,
67
 
    test_server,
68
53
    test_sftp_transport,
69
54
    TestUtil,
70
55
    )
71
 
from bzrlib.trace import note, mutter
72
 
from bzrlib.transport import memory
 
56
from bzrlib.trace import note
 
57
from bzrlib.transport.memory import MemoryServer, MemoryTransport
73
58
from bzrlib.version import _get_bzr_source_tree
74
59
 
75
60
 
89
74
                          TestUtil._load_module_by_name,
90
75
                          'bzrlib.no-name-yet')
91
76
 
92
 
 
93
77
class MetaTestLog(tests.TestCase):
94
78
 
95
79
    def test_logging(self):
96
80
        """Test logs are captured when a test fails."""
97
81
        self.log('a test message')
98
 
        details = self.getDetails()
99
 
        log = details['log']
100
 
        self.assertThat(log.content_type, Equals(ContentType(
101
 
            "text", "plain", {"charset": "utf8"})))
102
 
        self.assertThat(u"".join(log.iter_text()), Equals(self.get_log()))
103
 
        self.assertThat(self.get_log(),
104
 
            DocTestMatches(u"...a test message\n", ELLIPSIS))
 
82
        self._log_file.flush()
 
83
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
84
                              'a test message\n')
105
85
 
106
86
 
107
87
class TestUnicodeFilename(tests.TestCase):
123
103
        self.failUnlessExists(filename)
124
104
 
125
105
 
126
 
class TestClassesAvailable(tests.TestCase):
127
 
    """As a convenience we expose Test* classes from bzrlib.tests"""
128
 
 
129
 
    def test_test_case(self):
130
 
        from bzrlib.tests import TestCase
131
 
 
132
 
    def test_test_loader(self):
133
 
        from bzrlib.tests import TestLoader
134
 
 
135
 
    def test_test_suite(self):
136
 
        from bzrlib.tests import TestSuite
137
 
 
138
 
 
139
106
class TestTransportScenarios(tests.TestCase):
140
107
    """A group of tests that test the transport implementation adaption core.
141
108
 
153
120
            def get_test_permutations(self):
154
121
                return sample_permutation
155
122
        sample_permutation = [(1,2), (3,4)]
156
 
        from bzrlib.tests.per_transport import get_transport_test_permutations
 
123
        from bzrlib.tests.test_transport_implementations \
 
124
            import get_transport_test_permutations
157
125
        self.assertEqual(sample_permutation,
158
126
                         get_transport_test_permutations(MockModule()))
159
127
 
160
 
    def test_scenarios_include_all_modules(self):
 
128
    def test_scenarios_invlude_all_modules(self):
161
129
        # this checks that the scenario generator returns as many permutations
162
130
        # as there are in all the registered transport modules - we assume if
163
131
        # this matches its probably doing the right thing especially in
164
132
        # combination with the tests for setting the right classes below.
165
 
        from bzrlib.tests.per_transport import transport_test_permutations
 
133
        from bzrlib.tests.test_transport_implementations \
 
134
            import transport_test_permutations
166
135
        from bzrlib.transport import _get_transport_modules
167
136
        modules = _get_transport_modules()
168
137
        permutation_count = 0
180
149
        # This test used to know about all the possible transports and the
181
150
        # order they were returned but that seems overly brittle (mbp
182
151
        # 20060307)
183
 
        from bzrlib.tests.per_transport import transport_test_permutations
 
152
        from bzrlib.tests.test_transport_implementations \
 
153
            import transport_test_permutations
184
154
        scenarios = transport_test_permutations()
185
155
        # there are at least that many builtin transports
186
156
        self.assertTrue(len(scenarios) > 6)
222
192
    def test_scenarios(self):
223
193
        # check that constructor parameters are passed through to the adapted
224
194
        # test.
225
 
        from bzrlib.tests.per_controldir import make_scenarios
 
195
        from bzrlib.tests.per_bzrdir import make_scenarios
226
196
        vfs_factory = "v"
227
197
        server1 = "a"
228
198
        server2 = "b"
248
218
        from bzrlib.tests.per_repository import formats_to_scenarios
249
219
        formats = [("(c)", remote.RemoteRepositoryFormat()),
250
220
                   ("(d)", repository.format_registry.get(
251
 
                    'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
 
221
                        'Bazaar pack repository format 1 (needs bzr 0.92)\n'))]
252
222
        no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
253
223
            None)
254
224
        vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
255
225
            vfs_transport_factory="vfs")
256
226
        # no_vfs generate scenarios without vfs_transport_factory
257
 
        expected = [
 
227
        self.assertEqual([
258
228
            ('RemoteRepositoryFormat(c)',
259
229
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
260
230
              'repository_format': remote.RemoteRepositoryFormat(),
261
231
              'transport_readonly_server': 'readonly',
262
232
              'transport_server': 'server'}),
263
 
            ('RepositoryFormat2a(d)',
 
233
            ('RepositoryFormatKnitPack1(d)',
264
234
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
265
 
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
235
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
266
236
              'transport_readonly_server': 'readonly',
267
 
              'transport_server': 'server'})]
268
 
        self.assertEqual(expected, no_vfs_scenarios)
 
237
              'transport_server': 'server'})],
 
238
            no_vfs_scenarios)
269
239
        self.assertEqual([
270
240
            ('RemoteRepositoryFormat(c)',
271
241
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
273
243
              'transport_readonly_server': 'readonly',
274
244
              'transport_server': 'server',
275
245
              'vfs_transport_factory': 'vfs'}),
276
 
            ('RepositoryFormat2a(d)',
 
246
            ('RepositoryFormatKnitPack1(d)',
277
247
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
278
 
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
248
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
279
249
              'transport_readonly_server': 'readonly',
280
250
              'transport_server': 'server',
281
251
              'vfs_transport_factory': 'vfs'})],
323
293
    def test_scenarios(self):
324
294
        # check that constructor parameters are passed through to the adapted
325
295
        # test.
326
 
        from bzrlib.tests.per_interrepository import make_scenarios
 
296
        from bzrlib.tests.per_interrepository import \
 
297
            make_scenarios
327
298
        server1 = "a"
328
299
        server2 = "b"
329
 
        formats = [("C0", "C1", "C2", "C3"), ("D0", "D1", "D2", "D3")]
 
300
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
330
301
        scenarios = make_scenarios(server1, server2, formats)
331
302
        self.assertEqual([
332
 
            ('C0,str,str',
333
 
             {'repository_format': 'C1',
 
303
            ('str,str,str',
 
304
             {'interrepo_class': str,
 
305
              'repository_format': 'C1',
334
306
              'repository_format_to': 'C2',
335
307
              'transport_readonly_server': 'b',
336
 
              'transport_server': 'a',
337
 
              'extra_setup': 'C3'}),
338
 
            ('D0,str,str',
339
 
             {'repository_format': 'D1',
 
308
              'transport_server': 'a'}),
 
309
            ('int,str,str',
 
310
             {'interrepo_class': int,
 
311
              'repository_format': 'D1',
340
312
              'repository_format_to': 'D2',
341
313
              'transport_readonly_server': 'b',
342
 
              'transport_server': 'a',
343
 
              'extra_setup': 'D3'})],
 
314
              'transport_server': 'a'})],
344
315
            scenarios)
345
316
 
346
317
 
349
320
    def test_scenarios(self):
350
321
        # check that constructor parameters are passed through to the adapted
351
322
        # test.
352
 
        from bzrlib.tests.per_workingtree import make_scenarios
 
323
        from bzrlib.tests.workingtree_implementations \
 
324
            import make_scenarios
353
325
        server1 = "a"
354
326
        server2 = "b"
355
327
        formats = [workingtree.WorkingTreeFormat2(),
379
351
        # workingtree_to_test_tree attribute set to 'return_parameter' and the
380
352
        # revision one set to revision_tree_from_workingtree.
381
353
 
382
 
        from bzrlib.tests.per_tree import (
 
354
        from bzrlib.tests.tree_implementations import (
383
355
            _dirstate_tree_from_workingtree,
384
356
            make_scenarios,
385
357
            preview_tree_pre,
461
433
        # unlike the TestProviderAdapter we dont want to automatically add a
462
434
        # parameterized one for WorkingTree - the optimisers will tell us what
463
435
        # ones to add.
464
 
        from bzrlib.tests.per_tree import (
 
436
        from bzrlib.tests.tree_implementations import (
465
437
            return_parameter,
466
438
            revision_tree_from_workingtree
467
439
            )
468
 
        from bzrlib.tests.per_intertree import (
 
440
        from bzrlib.tests.intertree_implementations import (
469
441
            make_scenarios,
470
442
            )
471
443
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
521
493
        self.assertEqualStat(real, fake)
522
494
 
523
495
    def test_assertEqualStat_notequal(self):
524
 
        self.build_tree(["foo", "longname"])
 
496
        self.build_tree(["foo", "bar"])
525
497
        self.assertRaises(AssertionError, self.assertEqualStat,
526
 
            os.lstat("foo"), os.lstat("longname"))
 
498
            os.lstat("foo"), os.lstat("bar"))
527
499
 
528
500
 
529
501
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
547
519
        cwd = osutils.getcwd()
548
520
        self.assertIsSameRealPath(self.test_dir, cwd)
549
521
 
550
 
    def test_BZR_HOME_and_HOME_are_bytestrings(self):
551
 
        """The $BZR_HOME and $HOME environment variables should not be unicode.
552
 
 
553
 
        See https://bugs.launchpad.net/bzr/+bug/464174
554
 
        """
555
 
        self.assertIsInstance(os.environ['BZR_HOME'], str)
556
 
        self.assertIsInstance(os.environ['HOME'], str)
557
 
 
558
522
    def test_make_branch_and_memory_tree(self):
559
523
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
560
524
 
616
580
                         self.get_transport().get_bytes(
617
581
                            'dir/.bzr/repository/format'))
618
582
 
 
583
    def test_safety_net(self):
 
584
        """No test should modify the safety .bzr directory.
 
585
 
 
586
        We just test that the _check_safety_net private method raises
 
587
        AssertionError, it's easier than building a test suite with the same
 
588
        test.
 
589
        """
 
590
        # Oops, a commit in the current directory (i.e. without local .bzr
 
591
        # directory) will crawl up the hierarchy to find a .bzr directory.
 
592
        self.run_bzr(['commit', '-mfoo', '--unchanged'])
 
593
        # But we have a safety net in place.
 
594
        self.assertRaises(AssertionError, self._check_safety_net)
 
595
 
619
596
    def test_dangling_locks_cause_failures(self):
620
597
        class TestDanglingLock(tests.TestCaseWithMemoryTransport):
621
598
            def test_function(self):
625
602
                l.attempt_lock()
626
603
        test = TestDanglingLock('test_function')
627
604
        result = test.run()
628
 
        total_failures = result.errors + result.failures
629
 
        if self._lock_check_thorough:
630
 
            self.assertEqual(1, len(total_failures))
631
 
        else:
632
 
            # When _lock_check_thorough is disabled, then we don't trigger a
633
 
            # failure
634
 
            self.assertEqual(0, len(total_failures))
 
605
        self.assertEqual(1, len(result.errors))
635
606
 
636
607
 
637
608
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
638
609
    """Tests for the convenience functions TestCaseWithTransport introduces."""
639
610
 
640
611
    def test_get_readonly_url_none(self):
 
612
        from bzrlib.transport import get_transport
 
613
        from bzrlib.transport.memory import MemoryServer
641
614
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
642
 
        self.vfs_transport_factory = memory.MemoryServer
 
615
        self.vfs_transport_factory = MemoryServer
643
616
        self.transport_readonly_server = None
644
617
        # calling get_readonly_transport() constructs a decorator on the url
645
618
        # for the server
646
619
        url = self.get_readonly_url()
647
620
        url2 = self.get_readonly_url('foo/bar')
648
 
        t = transport.get_transport(url)
649
 
        t2 = transport.get_transport(url2)
 
621
        t = get_transport(url)
 
622
        t2 = get_transport(url2)
650
623
        self.failUnless(isinstance(t, ReadonlyTransportDecorator))
651
624
        self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
652
625
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
653
626
 
654
627
    def test_get_readonly_url_http(self):
655
628
        from bzrlib.tests.http_server import HttpServer
 
629
        from bzrlib.transport import get_transport
 
630
        from bzrlib.transport.local import LocalURLServer
656
631
        from bzrlib.transport.http import HttpTransportBase
657
 
        self.transport_server = test_server.LocalURLServer
 
632
        self.transport_server = LocalURLServer
658
633
        self.transport_readonly_server = HttpServer
659
634
        # calling get_readonly_transport() gives us a HTTP server instance.
660
635
        url = self.get_readonly_url()
661
636
        url2 = self.get_readonly_url('foo/bar')
662
637
        # the transport returned may be any HttpTransportBase subclass
663
 
        t = transport.get_transport(url)
664
 
        t2 = transport.get_transport(url2)
 
638
        t = get_transport(url)
 
639
        t2 = get_transport(url2)
665
640
        self.failUnless(isinstance(t, HttpTransportBase))
666
641
        self.failUnless(isinstance(t2, HttpTransportBase))
667
642
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
691
666
 
692
667
    def setUp(self):
693
668
        super(TestTestCaseTransports, self).setUp()
694
 
        self.vfs_transport_factory = memory.MemoryServer
 
669
        self.vfs_transport_factory = MemoryServer
695
670
 
696
671
    def test_make_bzrdir_preserves_transport(self):
697
672
        t = self.get_transport()
698
673
        result_bzrdir = self.make_bzrdir('subdir')
699
674
        self.assertIsInstance(result_bzrdir.transport,
700
 
                              memory.MemoryTransport)
 
675
                              MemoryTransport)
701
676
        # should not be on disk, should only be in memory
702
677
        self.failIfExists('subdir')
703
678
 
705
680
class TestChrootedTest(tests.ChrootedTestCase):
706
681
 
707
682
    def test_root_is_root(self):
708
 
        t = transport.get_transport(self.get_readonly_url())
 
683
        from bzrlib.transport import get_transport
 
684
        t = get_transport(self.get_readonly_url())
709
685
        url = t.base
710
686
        self.assertEqual(url, t.clone('..').base)
711
687
 
712
688
 
713
 
class TestProfileResult(tests.TestCase):
714
 
 
715
 
    def test_profiles_tests(self):
716
 
        self.requireFeature(test_lsprof.LSProfFeature)
717
 
        terminal = testtools.tests.helpers.ExtendedTestResult()
718
 
        result = tests.ProfileResult(terminal)
719
 
        class Sample(tests.TestCase):
720
 
            def a(self):
721
 
                self.sample_function()
722
 
            def sample_function(self):
723
 
                pass
724
 
        test = Sample("a")
725
 
        test.run(result)
726
 
        case = terminal._events[0][1]
727
 
        self.assertLength(1, case._benchcalls)
728
 
        # We must be able to unpack it as the test reporting code wants
729
 
        (_, _, _), stats = case._benchcalls[0]
730
 
        self.assertTrue(callable(stats.pprint))
 
689
class MockProgress(progress._BaseProgressBar):
 
690
    """Progress-bar standin that records calls.
 
691
 
 
692
    Useful for testing pb using code.
 
693
    """
 
694
 
 
695
    def __init__(self):
 
696
        progress._BaseProgressBar.__init__(self)
 
697
        self.calls = []
 
698
 
 
699
    def tick(self):
 
700
        self.calls.append(('tick',))
 
701
 
 
702
    def update(self, msg=None, current=None, total=None):
 
703
        self.calls.append(('update', msg, current, total))
 
704
 
 
705
    def clear(self):
 
706
        self.calls.append(('clear',))
 
707
 
 
708
    def note(self, msg, *args):
 
709
        self.calls.append(('note', msg, args))
731
710
 
732
711
 
733
712
class TestTestResult(tests.TestCase):
737
716
                descriptions=0,
738
717
                verbosity=1,
739
718
                )
740
 
        capture = testtools.tests.helpers.ExtendedTestResult()
741
 
        test_case.run(MultiTestResult(result, capture))
742
 
        run_case = capture._events[0][1]
743
 
        timed_string = result._testTimeString(run_case)
 
719
        test_case.run(result)
 
720
        timed_string = result._testTimeString(test_case)
744
721
        self.assertContainsRe(timed_string, expected_re)
745
722
 
746
723
    def test_test_reporting(self):
751
728
                self.time(time.sleep, 0.003)
752
729
        self.check_timing(ShortDelayTestCase('test_short_delay'),
753
730
                          r"^ +[0-9]+ms$")
754
 
        # if a benchmark time is given, we now show just that time followed by
755
 
        # a star
 
731
        # if a benchmark time is given, we want a x of y style result.
756
732
        self.check_timing(ShortDelayTestCase('test_short_benchmark'),
757
 
                          r"^ +[0-9]+ms\*$")
 
733
                          r"^ +[0-9]+ms/ +[0-9]+ms$")
758
734
 
759
735
    def test_unittest_reporting_unittest_class(self):
760
736
        # getting the time from a non-bzrlib test works ok
764
740
        self.check_timing(ShortDelayTestCase('test_short_delay'),
765
741
                          r"^ +[0-9]+ms$")
766
742
 
767
 
    def _patch_get_bzr_source_tree(self):
768
 
        # Reading from the actual source tree breaks isolation, but we don't
769
 
        # want to assume that thats *all* that would happen.
770
 
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree', lambda: None)
771
 
 
772
743
    def test_assigned_benchmark_file_stores_date(self):
773
 
        self._patch_get_bzr_source_tree()
774
744
        output = StringIO()
775
745
        result = bzrlib.tests.TextTestResult(self._log_file,
776
746
                                        descriptions=0,
784
754
        self.assertContainsRe(output_string, "--date [0-9.]+")
785
755
 
786
756
    def test_benchhistory_records_test_times(self):
787
 
        self._patch_get_bzr_source_tree()
788
757
        result_stream = StringIO()
789
758
        result = bzrlib.tests.TextTestResult(
790
759
            self._log_file,
817
786
        self.requireFeature(test_lsprof.LSProfFeature)
818
787
        result_stream = StringIO()
819
788
        result = bzrlib.tests.VerboseTestResult(
820
 
            result_stream,
 
789
            unittest._WritelnDecorator(result_stream),
821
790
            descriptions=0,
822
791
            verbosity=2,
823
792
            )
849
818
        self.assertContainsRe(output,
850
819
            r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
851
820
 
852
 
    def test_uses_time_from_testtools(self):
853
 
        """Test case timings in verbose results should use testtools times"""
854
 
        import datetime
855
 
        class TimeAddedVerboseTestResult(tests.VerboseTestResult):
856
 
            def startTest(self, test):
857
 
                self.time(datetime.datetime.utcfromtimestamp(1.145))
858
 
                super(TimeAddedVerboseTestResult, self).startTest(test)
859
 
            def addSuccess(self, test):
860
 
                self.time(datetime.datetime.utcfromtimestamp(51.147))
861
 
                super(TimeAddedVerboseTestResult, self).addSuccess(test)
862
 
            def report_tests_starting(self): pass
863
 
        sio = StringIO()
864
 
        self.get_passing_test().run(TimeAddedVerboseTestResult(sio, 0, 2))
865
 
        self.assertEndsWith(sio.getvalue(), "OK    50002ms\n")
866
 
 
867
821
    def test_known_failure(self):
868
822
        """A KnownFailure being raised should trigger several result actions."""
869
823
        class InstrumentedTestResult(tests.ExtendedTestResult):
870
 
            def stopTestRun(self): pass
871
 
            def report_tests_starting(self): pass
872
 
            def report_known_failure(self, test, err=None, details=None):
873
 
                self._call = test, 'known failure'
 
824
            def done(self): pass
 
825
            def startTests(self): pass
 
826
            def report_test_start(self, test): pass
 
827
            def report_known_failure(self, test, err):
 
828
                self._call = test, err
874
829
        result = InstrumentedTestResult(None, None, None, None)
875
 
        class Test(tests.TestCase):
876
 
            def test_function(self):
877
 
                raise tests.KnownFailure('failed!')
878
 
        test = Test("test_function")
 
830
        def test_function():
 
831
            raise tests.KnownFailure('failed!')
 
832
        test = unittest.FunctionTestCase(test_function)
879
833
        test.run(result)
880
834
        # it should invoke 'report_known_failure'.
881
835
        self.assertEqual(2, len(result._call))
882
 
        self.assertEqual(test.id(), result._call[0].id())
883
 
        self.assertEqual('known failure', result._call[1])
 
836
        self.assertEqual(test, result._call[0])
 
837
        self.assertEqual(tests.KnownFailure, result._call[1][0])
 
838
        self.assertIsInstance(result._call[1][1], tests.KnownFailure)
884
839
        # we dont introspec the traceback, if the rest is ok, it would be
885
840
        # exceptional for it not to be.
886
841
        # it should update the known_failure_count on the object.
892
847
        # verbose test output formatting
893
848
        result_stream = StringIO()
894
849
        result = bzrlib.tests.VerboseTestResult(
895
 
            result_stream,
 
850
            unittest._WritelnDecorator(result_stream),
896
851
            descriptions=0,
897
852
            verbosity=2,
898
853
            )
908
863
        output = result_stream.getvalue()[prefix:]
909
864
        lines = output.splitlines()
910
865
        self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
911
 
        if sys.version_info > (2, 7):
912
 
            self.expectFailure("_ExpectedFailure on 2.7 loses the message",
913
 
                self.assertNotEqual, lines[1], '    ')
914
866
        self.assertEqual(lines[1], '    foo')
915
867
        self.assertEqual(2, len(lines))
916
868
 
 
869
    def test_text_report_known_failure(self):
 
870
        # text test output formatting
 
871
        pb = MockProgress()
 
872
        result = bzrlib.tests.TextTestResult(
 
873
            StringIO(),
 
874
            descriptions=0,
 
875
            verbosity=1,
 
876
            pb=pb,
 
877
            )
 
878
        test = self.get_passing_test()
 
879
        # this seeds the state to handle reporting the test.
 
880
        result.startTest(test)
 
881
        # the err parameter has the shape:
 
882
        # (class, exception object, traceback)
 
883
        # KnownFailures dont get their tracebacks shown though, so we
 
884
        # can skip that.
 
885
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
 
886
        result.report_known_failure(test, err)
 
887
        self.assertEqual(
 
888
            [
 
889
            ('update', '[1 in 0s] passing_test', None, None),
 
890
            ('note', 'XFAIL: %s\n%s\n', ('passing_test', err[1]))
 
891
            ],
 
892
            pb.calls)
 
893
        # known_failures should be printed in the summary, so if we run a test
 
894
        # after there are some known failures, the update prefix should match
 
895
        # this.
 
896
        result.known_failure_count = 3
 
897
        test.run(result)
 
898
        self.assertEqual(
 
899
            [
 
900
            ('update', '[2 in 0s] passing_test', None, None),
 
901
            ],
 
902
            pb.calls[2:])
 
903
 
917
904
    def get_passing_test(self):
918
905
        """Return a test object that can't be run usefully."""
919
906
        def passing_test():
923
910
    def test_add_not_supported(self):
924
911
        """Test the behaviour of invoking addNotSupported."""
925
912
        class InstrumentedTestResult(tests.ExtendedTestResult):
926
 
            def stopTestRun(self): pass
927
 
            def report_tests_starting(self): pass
 
913
            def done(self): pass
 
914
            def startTests(self): pass
 
915
            def report_test_start(self, test): pass
928
916
            def report_unsupported(self, test, feature):
929
917
                self._call = test, feature
930
918
        result = InstrumentedTestResult(None, None, None, None)
949
937
        # verbose test output formatting
950
938
        result_stream = StringIO()
951
939
        result = bzrlib.tests.VerboseTestResult(
952
 
            result_stream,
 
940
            unittest._WritelnDecorator(result_stream),
953
941
            descriptions=0,
954
942
            verbosity=2,
955
943
            )
960
948
        result.report_unsupported(test, feature)
961
949
        output = result_stream.getvalue()[prefix:]
962
950
        lines = output.splitlines()
963
 
        # We don't check for the final '0ms' since it may fail on slow hosts
964
 
        self.assertStartsWith(lines[0], 'NODEP')
965
 
        self.assertEqual(lines[1],
966
 
                         "    The feature 'Feature' is not available.")
 
951
        self.assertEqual(lines, ['NODEP                   0ms',
 
952
                                 "    The feature 'Feature' is not available."])
 
953
 
 
954
    def test_text_report_unsupported(self):
 
955
        # text test output formatting
 
956
        pb = MockProgress()
 
957
        result = bzrlib.tests.TextTestResult(
 
958
            StringIO(),
 
959
            descriptions=0,
 
960
            verbosity=1,
 
961
            pb=pb,
 
962
            )
 
963
        test = self.get_passing_test()
 
964
        feature = tests.Feature()
 
965
        # this seeds the state to handle reporting the test.
 
966
        result.startTest(test)
 
967
        result.report_unsupported(test, feature)
 
968
        # no output on unsupported features
 
969
        self.assertEqual(
 
970
            [('update', '[1 in 0s] passing_test', None, None)
 
971
            ],
 
972
            pb.calls)
 
973
        # the number of missing features should be printed in the progress
 
974
        # summary, so check for that.
 
975
        result.unsupported = {'foo':0, 'bar':0}
 
976
        test.run(result)
 
977
        self.assertEqual(
 
978
            [
 
979
            ('update', '[2 in 0s, 2 missing] passing_test', None, None),
 
980
            ],
 
981
            pb.calls[1:])
967
982
 
968
983
    def test_unavailable_exception(self):
969
984
        """An UnavailableFeature being raised should invoke addNotSupported."""
970
985
        class InstrumentedTestResult(tests.ExtendedTestResult):
971
 
            def stopTestRun(self): pass
972
 
            def report_tests_starting(self): pass
 
986
            def done(self): pass
 
987
            def startTests(self): pass
 
988
            def report_test_start(self, test): pass
973
989
            def addNotSupported(self, test, feature):
974
990
                self._call = test, feature
975
991
        result = InstrumentedTestResult(None, None, None, None)
976
992
        feature = tests.Feature()
977
 
        class Test(tests.TestCase):
978
 
            def test_function(self):
979
 
                raise tests.UnavailableFeature(feature)
980
 
        test = Test("test_function")
 
993
        def test_function():
 
994
            raise tests.UnavailableFeature(feature)
 
995
        test = unittest.FunctionTestCase(test_function)
981
996
        test.run(result)
982
997
        # it should invoke 'addNotSupported'.
983
998
        self.assertEqual(2, len(result._call))
984
 
        self.assertEqual(test.id(), result._call[0].id())
 
999
        self.assertEqual(test, result._call[0])
985
1000
        self.assertEqual(feature, result._call[1])
986
1001
        # and not count as an error
987
1002
        self.assertEqual(0, result.error_count)
1000
1015
                                             verbosity=1)
1001
1016
        test = self.get_passing_test()
1002
1017
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
1003
 
        result.addExpectedFailure(test, err)
 
1018
        result._addKnownFailure(test, err)
1004
1019
        self.assertFalse(result.wasStrictlySuccessful())
1005
1020
        self.assertEqual(None, result._extractBenchmarkTime(test))
1006
1021
 
1017
1032
        class InstrumentedTestResult(tests.ExtendedTestResult):
1018
1033
            calls = 0
1019
1034
            def startTests(self): self.calls += 1
 
1035
            def report_test_start(self, test): pass
1020
1036
        result = InstrumentedTestResult(None, None, None, None)
1021
1037
        def test_function():
1022
1038
            pass
1024
1040
        test.run(result)
1025
1041
        self.assertEquals(1, result.calls)
1026
1042
 
1027
 
    def test_startTests_only_once(self):
1028
 
        """With multiple tests startTests should still only be called once"""
1029
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
1030
 
            calls = 0
1031
 
            def startTests(self): self.calls += 1
1032
 
        result = InstrumentedTestResult(None, None, None, None)
1033
 
        suite = unittest.TestSuite([
1034
 
            unittest.FunctionTestCase(lambda: None),
1035
 
            unittest.FunctionTestCase(lambda: None)])
1036
 
        suite.run(result)
1037
 
        self.assertEquals(1, result.calls)
1038
 
        self.assertEquals(2, result.count)
1039
 
 
1040
1043
 
1041
1044
class TestUnicodeFilenameFeature(tests.TestCase):
1042
1045
 
1072
1075
    def test_known_failure_failed_run(self):
1073
1076
        # run a test that generates a known failure which should be printed in
1074
1077
        # the final output when real failures occur.
1075
 
        class Test(tests.TestCase):
1076
 
            def known_failure_test(self):
1077
 
                self.expectFailure('failed', self.assertTrue, False)
 
1078
        def known_failure_test():
 
1079
            raise tests.KnownFailure('failed')
1078
1080
        test = unittest.TestSuite()
1079
 
        test.addTest(Test("known_failure_test"))
 
1081
        test.addTest(unittest.FunctionTestCase(known_failure_test))
1080
1082
        def failing_test():
1081
 
            self.fail('foo')
 
1083
            raise AssertionError('foo')
1082
1084
        test.addTest(unittest.FunctionTestCase(failing_test))
1083
1085
        stream = StringIO()
1084
1086
        runner = tests.TextTestRunner(stream=stream)
1085
1087
        result = self.run_test_runner(runner, test)
1086
1088
        lines = stream.getvalue().splitlines()
1087
 
        self.assertContainsRe(stream.getvalue(),
1088
 
            '(?sm)^bzr selftest.*$'
1089
 
            '.*'
1090
 
            '^======================================================================\n'
1091
 
            '^FAIL: failing_test\n'
1092
 
            '^----------------------------------------------------------------------\n'
1093
 
            'Traceback \\(most recent call last\\):\n'
1094
 
            '  .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
1095
 
            '    self.fail\\(\'foo\'\\)\n'
1096
 
            '.*'
1097
 
            '^----------------------------------------------------------------------\n'
1098
 
            '.*'
1099
 
            'FAILED \\(failures=1, known_failure_count=1\\)'
1100
 
            )
 
1089
        self.assertEqual([
 
1090
            '',
 
1091
            '======================================================================',
 
1092
            'FAIL: unittest.FunctionTestCase (failing_test)',
 
1093
            '----------------------------------------------------------------------',
 
1094
            'Traceback (most recent call last):',
 
1095
            '    raise AssertionError(\'foo\')',
 
1096
            'AssertionError: foo',
 
1097
            '',
 
1098
            '----------------------------------------------------------------------',
 
1099
            '',
 
1100
            'FAILED (failures=1, known_failure_count=1)'],
 
1101
            lines[3:8] + lines[9:13] + lines[14:])
1101
1102
 
1102
1103
    def test_known_failure_ok_run(self):
1103
 
        # run a test that generates a known failure which should be printed in
1104
 
        # the final output.
1105
 
        class Test(tests.TestCase):
1106
 
            def known_failure_test(self):
1107
 
                self.expectFailure('failed', self.assertTrue, False)
1108
 
        test = Test("known_failure_test")
 
1104
        # run a test that generates a known failure which should be printed in the final output.
 
1105
        def known_failure_test():
 
1106
            raise tests.KnownFailure('failed')
 
1107
        test = unittest.FunctionTestCase(known_failure_test)
1109
1108
        stream = StringIO()
1110
1109
        runner = tests.TextTestRunner(stream=stream)
1111
1110
        result = self.run_test_runner(runner, test)
1116
1115
            '\n'
1117
1116
            'OK \\(known_failures=1\\)\n')
1118
1117
 
1119
 
    def test_result_decorator(self):
1120
 
        # decorate results
1121
 
        calls = []
1122
 
        class LoggingDecorator(tests.ForwardingResult):
1123
 
            def startTest(self, test):
1124
 
                tests.ForwardingResult.startTest(self, test)
1125
 
                calls.append('start')
1126
 
        test = unittest.FunctionTestCase(lambda:None)
1127
 
        stream = StringIO()
1128
 
        runner = tests.TextTestRunner(stream=stream,
1129
 
            result_decorators=[LoggingDecorator])
1130
 
        result = self.run_test_runner(runner, test)
1131
 
        self.assertLength(1, calls)
1132
 
 
1133
1118
    def test_skipped_test(self):
1134
1119
        # run a test that is skipped, and check the suite as a whole still
1135
1120
        # succeeds.
1188
1173
 
1189
1174
    def test_not_applicable(self):
1190
1175
        # run a test that is skipped because it's not applicable
1191
 
        class Test(tests.TestCase):
1192
 
            def not_applicable_test(self):
1193
 
                raise tests.TestNotApplicable('this test never runs')
 
1176
        def not_applicable_test():
 
1177
            raise tests.TestNotApplicable('this test never runs')
1194
1178
        out = StringIO()
1195
1179
        runner = tests.TextTestRunner(stream=out, verbosity=2)
1196
 
        test = Test("not_applicable_test")
 
1180
        test = unittest.FunctionTestCase(not_applicable_test)
1197
1181
        result = self.run_test_runner(runner, test)
1198
1182
        self._log_file.write(out.getvalue())
1199
1183
        self.assertTrue(result.wasSuccessful())
1203
1187
        self.assertContainsRe(out.getvalue(),
1204
1188
                r'(?m)^    this test never runs')
1205
1189
 
 
1190
    def test_not_applicable_demo(self):
 
1191
        # just so you can see it in the test output
 
1192
        raise tests.TestNotApplicable('this test is just a demonstation')
 
1193
 
1206
1194
    def test_unsupported_features_listed(self):
1207
1195
        """When unsupported features are encountered they are detailed."""
1208
1196
        class Feature1(tests.Feature):
1228
1216
            ],
1229
1217
            lines[-3:])
1230
1218
 
1231
 
    def _patch_get_bzr_source_tree(self):
1232
 
        # Reading from the actual source tree breaks isolation, but we don't
1233
 
        # want to assume that thats *all* that would happen.
1234
 
        self._get_source_tree_calls = []
1235
 
        def new_get():
1236
 
            self._get_source_tree_calls.append("called")
1237
 
            return None
1238
 
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree',  new_get)
1239
 
 
1240
1219
    def test_bench_history(self):
1241
 
        # tests that the running the benchmark passes bench_history into
1242
 
        # the test result object. We can tell that happens if
1243
 
        # _get_bzr_source_tree is called.
1244
 
        self._patch_get_bzr_source_tree()
 
1220
        # tests that the running the benchmark produces a history file
 
1221
        # containing a timestamp and the revision id of the bzrlib source which
 
1222
        # was tested.
 
1223
        workingtree = _get_bzr_source_tree()
1245
1224
        test = TestRunner('dummy_test')
1246
1225
        output = StringIO()
1247
1226
        runner = tests.TextTestRunner(stream=self._log_file,
1249
1228
        result = self.run_test_runner(runner, test)
1250
1229
        output_string = output.getvalue()
1251
1230
        self.assertContainsRe(output_string, "--date [0-9.]+")
1252
 
        self.assertLength(1, self._get_source_tree_calls)
1253
 
 
1254
 
    def test_verbose_test_count(self):
1255
 
        """A verbose test run reports the right test count at the start"""
1256
 
        suite = TestUtil.TestSuite([
1257
 
            unittest.FunctionTestCase(lambda:None),
1258
 
            unittest.FunctionTestCase(lambda:None)])
1259
 
        self.assertEqual(suite.countTestCases(), 2)
1260
 
        stream = StringIO()
1261
 
        runner = tests.TextTestRunner(stream=stream, verbosity=2)
1262
 
        # Need to use the CountingDecorator as that's what sets num_tests
1263
 
        result = self.run_test_runner(runner, tests.CountingDecorator(suite))
1264
 
        self.assertStartsWith(stream.getvalue(), "running 2 tests")
1265
 
 
1266
 
    def test_startTestRun(self):
1267
 
        """run should call result.startTestRun()"""
1268
 
        calls = []
1269
 
        class LoggingDecorator(tests.ForwardingResult):
1270
 
            def startTestRun(self):
1271
 
                tests.ForwardingResult.startTestRun(self)
1272
 
                calls.append('startTestRun')
1273
 
        test = unittest.FunctionTestCase(lambda:None)
1274
 
        stream = StringIO()
1275
 
        runner = tests.TextTestRunner(stream=stream,
1276
 
            result_decorators=[LoggingDecorator])
1277
 
        result = self.run_test_runner(runner, test)
1278
 
        self.assertLength(1, calls)
1279
 
 
1280
 
    def test_stopTestRun(self):
1281
 
        """run should call result.stopTestRun()"""
1282
 
        calls = []
1283
 
        class LoggingDecorator(tests.ForwardingResult):
1284
 
            def stopTestRun(self):
1285
 
                tests.ForwardingResult.stopTestRun(self)
1286
 
                calls.append('stopTestRun')
1287
 
        test = unittest.FunctionTestCase(lambda:None)
1288
 
        stream = StringIO()
1289
 
        runner = tests.TextTestRunner(stream=stream,
1290
 
            result_decorators=[LoggingDecorator])
1291
 
        result = self.run_test_runner(runner, test)
1292
 
        self.assertLength(1, calls)
 
1231
        if workingtree is not None:
 
1232
            revision_id = workingtree.get_parent_ids()[0]
 
1233
            self.assertEndsWith(output_string.rstrip(), revision_id)
 
1234
 
 
1235
    def assertLogDeleted(self, test):
 
1236
        log = test._get_log()
 
1237
        self.assertEqual("DELETED log file to reduce memory footprint", log)
 
1238
        self.assertEqual('', test._log_contents)
 
1239
        self.assertIs(None, test._log_file_name)
 
1240
 
 
1241
    def test_success_log_deleted(self):
 
1242
        """Successful tests have their log deleted"""
 
1243
 
 
1244
        class LogTester(tests.TestCase):
 
1245
 
 
1246
            def test_success(self):
 
1247
                self.log('this will be removed\n')
 
1248
 
 
1249
        sio = StringIO()
 
1250
        runner = tests.TextTestRunner(stream=sio)
 
1251
        test = LogTester('test_success')
 
1252
        result = self.run_test_runner(runner, test)
 
1253
 
 
1254
        self.assertLogDeleted(test)
 
1255
 
 
1256
    def test_skipped_log_deleted(self):
 
1257
        """Skipped tests have their log deleted"""
 
1258
 
 
1259
        class LogTester(tests.TestCase):
 
1260
 
 
1261
            def test_skipped(self):
 
1262
                self.log('this will be removed\n')
 
1263
                raise tests.TestSkipped()
 
1264
 
 
1265
        sio = StringIO()
 
1266
        runner = tests.TextTestRunner(stream=sio)
 
1267
        test = LogTester('test_skipped')
 
1268
        result = self.run_test_runner(runner, test)
 
1269
 
 
1270
        self.assertLogDeleted(test)
 
1271
 
 
1272
    def test_not_aplicable_log_deleted(self):
 
1273
        """Not applicable tests have their log deleted"""
 
1274
 
 
1275
        class LogTester(tests.TestCase):
 
1276
 
 
1277
            def test_not_applicable(self):
 
1278
                self.log('this will be removed\n')
 
1279
                raise tests.TestNotApplicable()
 
1280
 
 
1281
        sio = StringIO()
 
1282
        runner = tests.TextTestRunner(stream=sio)
 
1283
        test = LogTester('test_not_applicable')
 
1284
        result = self.run_test_runner(runner, test)
 
1285
 
 
1286
        self.assertLogDeleted(test)
 
1287
 
 
1288
    def test_known_failure_log_deleted(self):
 
1289
        """Know failure tests have their log deleted"""
 
1290
 
 
1291
        class LogTester(tests.TestCase):
 
1292
 
 
1293
            def test_known_failure(self):
 
1294
                self.log('this will be removed\n')
 
1295
                raise tests.KnownFailure()
 
1296
 
 
1297
        sio = StringIO()
 
1298
        runner = tests.TextTestRunner(stream=sio)
 
1299
        test = LogTester('test_known_failure')
 
1300
        result = self.run_test_runner(runner, test)
 
1301
 
 
1302
        self.assertLogDeleted(test)
 
1303
 
 
1304
    def test_fail_log_kept(self):
 
1305
        """Failed tests have their log kept"""
 
1306
 
 
1307
        class LogTester(tests.TestCase):
 
1308
 
 
1309
            def test_fail(self):
 
1310
                self.log('this will be kept\n')
 
1311
                self.fail('this test fails')
 
1312
 
 
1313
        sio = StringIO()
 
1314
        runner = tests.TextTestRunner(stream=sio)
 
1315
        test = LogTester('test_fail')
 
1316
        result = self.run_test_runner(runner, test)
 
1317
 
 
1318
        text = sio.getvalue()
 
1319
        self.assertContainsRe(text, 'this will be kept')
 
1320
        self.assertContainsRe(text, 'this test fails')
 
1321
 
 
1322
        log = test._get_log()
 
1323
        self.assertContainsRe(log, 'this will be kept')
 
1324
        self.assertEqual(log, test._log_contents)
 
1325
 
 
1326
    def test_error_log_kept(self):
 
1327
        """Tests with errors have their log kept"""
 
1328
 
 
1329
        class LogTester(tests.TestCase):
 
1330
 
 
1331
            def test_error(self):
 
1332
                self.log('this will be kept\n')
 
1333
                raise ValueError('random exception raised')
 
1334
 
 
1335
        sio = StringIO()
 
1336
        runner = tests.TextTestRunner(stream=sio)
 
1337
        test = LogTester('test_error')
 
1338
        result = self.run_test_runner(runner, test)
 
1339
 
 
1340
        text = sio.getvalue()
 
1341
        self.assertContainsRe(text, 'this will be kept')
 
1342
        self.assertContainsRe(text, 'random exception raised')
 
1343
 
 
1344
        log = test._get_log()
 
1345
        self.assertContainsRe(log, 'this will be kept')
 
1346
        self.assertEqual(log, test._log_contents)
1293
1347
 
1294
1348
 
1295
1349
class SampleTestCase(tests.TestCase):
1300
1354
class _TestException(Exception):
1301
1355
    pass
1302
1356
 
1303
 
 
1304
1357
class TestTestCase(tests.TestCase):
1305
1358
    """Tests that test the core bzrlib TestCase."""
1306
1359
 
1355
1408
        # we could set something and run a test that will check
1356
1409
        # it gets santised, but this is probably sufficient for now:
1357
1410
        # if someone runs the test with -Dsomething it will error.
1358
 
        flags = set()
1359
 
        if self._lock_check_thorough:
1360
 
            flags.add('strict_locks')
1361
 
        self.assertEqual(flags, bzrlib.debug.debug_flags)
 
1411
        self.assertEqual(set(), bzrlib.debug.debug_flags)
1362
1412
 
1363
1413
    def change_selftest_debug_flags(self, new_flags):
1364
 
        self.overrideAttr(tests, 'selftest_debug_flags', set(new_flags))
 
1414
        orig_selftest_flags = tests.selftest_debug_flags
 
1415
        self.addCleanup(self._restore_selftest_debug_flags, orig_selftest_flags)
 
1416
        tests.selftest_debug_flags = set(new_flags)
 
1417
 
 
1418
    def _restore_selftest_debug_flags(self, flags):
 
1419
        tests.selftest_debug_flags = flags
1365
1420
 
1366
1421
    def test_allow_debug_flag(self):
1367
1422
        """The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1374
1429
                self.flags = set(bzrlib.debug.debug_flags)
1375
1430
        test = TestThatRecordsFlags('test_foo')
1376
1431
        test.run(self.make_test_result())
1377
 
        flags = set(['a-flag'])
1378
 
        if 'disable_lock_checks' not in tests.selftest_debug_flags:
1379
 
            flags.add('strict_locks')
1380
 
        self.assertEqual(flags, self.flags)
1381
 
 
1382
 
    def test_disable_lock_checks(self):
1383
 
        """The -Edisable_lock_checks flag disables thorough checks."""
1384
 
        class TestThatRecordsFlags(tests.TestCase):
1385
 
            def test_foo(nested_self):
1386
 
                self.flags = set(bzrlib.debug.debug_flags)
1387
 
                self.test_lock_check_thorough = nested_self._lock_check_thorough
1388
 
        self.change_selftest_debug_flags(set())
1389
 
        test = TestThatRecordsFlags('test_foo')
1390
 
        test.run(self.make_test_result())
1391
 
        # By default we do strict lock checking and thorough lock/unlock
1392
 
        # tracking.
1393
 
        self.assertTrue(self.test_lock_check_thorough)
1394
 
        self.assertEqual(set(['strict_locks']), self.flags)
1395
 
        # Now set the disable_lock_checks flag, and show that this changed.
1396
 
        self.change_selftest_debug_flags(set(['disable_lock_checks']))
1397
 
        test = TestThatRecordsFlags('test_foo')
1398
 
        test.run(self.make_test_result())
1399
 
        self.assertFalse(self.test_lock_check_thorough)
1400
 
        self.assertEqual(set(), self.flags)
1401
 
 
1402
 
    def test_this_fails_strict_lock_check(self):
1403
 
        class TestThatRecordsFlags(tests.TestCase):
1404
 
            def test_foo(nested_self):
1405
 
                self.flags1 = set(bzrlib.debug.debug_flags)
1406
 
                self.thisFailsStrictLockCheck()
1407
 
                self.flags2 = set(bzrlib.debug.debug_flags)
1408
 
        # Make sure lock checking is active
1409
 
        self.change_selftest_debug_flags(set())
1410
 
        test = TestThatRecordsFlags('test_foo')
1411
 
        test.run(self.make_test_result())
1412
 
        self.assertEqual(set(['strict_locks']), self.flags1)
1413
 
        self.assertEqual(set(), self.flags2)
 
1432
        self.assertEqual(set(['a-flag']), self.flags)
1414
1433
 
1415
1434
    def test_debug_flags_restored(self):
1416
1435
        """The bzrlib debug flags should be restored to their original state
1427
1446
        self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1428
1447
 
1429
1448
    def make_test_result(self):
1430
 
        """Get a test result that writes to the test log file."""
1431
1449
        return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
1432
1450
 
1433
1451
    def inner_test(self):
1441
1459
        result = self.make_test_result()
1442
1460
        self.inner_test.run(result)
1443
1461
        note("outer finish")
1444
 
        self.addCleanup(osutils.delete_any, self._log_file_name)
1445
1462
 
1446
1463
    def test_trace_nesting(self):
1447
1464
        # this tests that each test case nests its trace facility correctly.
1471
1488
        sample_test = TestTestCase("method_that_times_a_bit_twice")
1472
1489
        output_stream = StringIO()
1473
1490
        result = bzrlib.tests.VerboseTestResult(
1474
 
            output_stream,
 
1491
            unittest._WritelnDecorator(output_stream),
1475
1492
            descriptions=0,
1476
 
            verbosity=2)
 
1493
            verbosity=2,
 
1494
            num_tests=sample_test.countTestCases())
1477
1495
        sample_test.run(result)
1478
1496
        self.assertContainsRe(
1479
1497
            output_stream.getvalue(),
1480
 
            r"\d+ms\*\n$")
 
1498
            r"\d+ms/ +\d+ms\n$")
1481
1499
 
1482
1500
    def test_hooks_sanitised(self):
1483
1501
        """The bzrlib hooks should be sanitised by setUp."""
1507
1525
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1508
1526
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1509
1527
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1510
 
        del self._benchcalls[:]
1511
1528
 
1512
1529
    def test_knownFailure(self):
1513
1530
        """Self.knownFailure() should raise a KnownFailure exception."""
1514
1531
        self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
1515
1532
 
1516
 
    def test_open_bzrdir_safe_roots(self):
1517
 
        # even a memory transport should fail to open when its url isn't 
1518
 
        # permitted.
1519
 
        # Manually set one up (TestCase doesn't and shouldn't provide magic
1520
 
        # machinery)
1521
 
        transport_server = memory.MemoryServer()
1522
 
        transport_server.start_server()
1523
 
        self.addCleanup(transport_server.stop_server)
1524
 
        t = transport.get_transport(transport_server.get_url())
1525
 
        bzrdir.BzrDir.create(t.base)
1526
 
        self.assertRaises(errors.BzrError,
1527
 
            bzrdir.BzrDir.open_from_transport, t)
1528
 
        # But if we declare this as safe, we can open the bzrdir.
1529
 
        self.permit_url(t.base)
1530
 
        self._bzr_selftest_roots.append(t.base)
1531
 
        bzrdir.BzrDir.open_from_transport(t)
1532
 
 
1533
1533
    def test_requireFeature_available(self):
1534
1534
        """self.requireFeature(available) is a no-op."""
1535
1535
        class Available(tests.Feature):
1579
1579
        """Test disabled tests behaviour with support aware results."""
1580
1580
        test = SampleTestCase('_test_pass')
1581
1581
        class DisabledFeature(object):
1582
 
            def __eq__(self, other):
1583
 
                return isinstance(other, DisabledFeature)
1584
1582
            def available(self):
1585
1583
                return False
1586
1584
        the_feature = DisabledFeature()
1597
1595
                self.calls.append(('addNotSupported', test, feature))
1598
1596
        result = InstrumentedTestResult()
1599
1597
        test.run(result)
1600
 
        case = result.calls[0][1]
1601
1598
        self.assertEqual([
1602
 
            ('startTest', case),
1603
 
            ('addNotSupported', case, the_feature),
1604
 
            ('stopTest', case),
 
1599
            ('startTest', test),
 
1600
            ('addNotSupported', test, the_feature),
 
1601
            ('stopTest', test),
1605
1602
            ],
1606
1603
            result.calls)
1607
1604
 
1608
 
    def test_start_server_registers_url(self):
1609
 
        transport_server = memory.MemoryServer()
1610
 
        # A little strict, but unlikely to be changed soon.
1611
 
        self.assertEqual([], self._bzr_selftest_roots)
1612
 
        self.start_server(transport_server)
1613
 
        self.assertSubset([transport_server.get_url()],
1614
 
            self._bzr_selftest_roots)
1615
 
 
1616
1605
    def test_assert_list_raises_on_generator(self):
1617
1606
        def generator_which_will_raise():
1618
1607
            # This will not raise until after the first yield
1668
1657
        self.assertRaises(AssertionError,
1669
1658
            self.assertListRaises, _TestException, success_generator)
1670
1659
 
1671
 
    def test_overrideAttr_without_value(self):
1672
 
        self.test_attr = 'original' # Define a test attribute
1673
 
        obj = self # Make 'obj' visible to the embedded test
1674
 
        class Test(tests.TestCase):
1675
 
 
1676
 
            def setUp(self):
1677
 
                tests.TestCase.setUp(self)
1678
 
                self.orig = self.overrideAttr(obj, 'test_attr')
1679
 
 
1680
 
            def test_value(self):
1681
 
                self.assertEqual('original', self.orig)
1682
 
                self.assertEqual('original', obj.test_attr)
1683
 
                obj.test_attr = 'modified'
1684
 
                self.assertEqual('modified', obj.test_attr)
1685
 
 
1686
 
        test = Test('test_value')
1687
 
        test.run(unittest.TestResult())
1688
 
        self.assertEqual('original', obj.test_attr)
1689
 
 
1690
 
    def test_overrideAttr_with_value(self):
1691
 
        self.test_attr = 'original' # Define a test attribute
1692
 
        obj = self # Make 'obj' visible to the embedded test
1693
 
        class Test(tests.TestCase):
1694
 
 
1695
 
            def setUp(self):
1696
 
                tests.TestCase.setUp(self)
1697
 
                self.orig = self.overrideAttr(obj, 'test_attr', new='modified')
1698
 
 
1699
 
            def test_value(self):
1700
 
                self.assertEqual('original', self.orig)
1701
 
                self.assertEqual('modified', obj.test_attr)
1702
 
 
1703
 
        test = Test('test_value')
1704
 
        test.run(unittest.TestResult())
1705
 
        self.assertEqual('original', obj.test_attr)
1706
 
 
1707
 
 
1708
 
class _MissingFeature(tests.Feature):
1709
 
    def _probe(self):
1710
 
        return False
1711
 
missing_feature = _MissingFeature()
1712
 
 
1713
 
 
1714
 
def _get_test(name):
1715
 
    """Get an instance of a specific example test.
1716
 
 
1717
 
    We protect this in a function so that they don't auto-run in the test
1718
 
    suite.
1719
 
    """
1720
 
 
1721
 
    class ExampleTests(tests.TestCase):
1722
 
 
1723
 
        def test_fail(self):
1724
 
            mutter('this was a failing test')
1725
 
            self.fail('this test will fail')
1726
 
 
1727
 
        def test_error(self):
1728
 
            mutter('this test errored')
1729
 
            raise RuntimeError('gotcha')
1730
 
 
1731
 
        def test_missing_feature(self):
1732
 
            mutter('missing the feature')
1733
 
            self.requireFeature(missing_feature)
1734
 
 
1735
 
        def test_skip(self):
1736
 
            mutter('this test will be skipped')
1737
 
            raise tests.TestSkipped('reason')
1738
 
 
1739
 
        def test_success(self):
1740
 
            mutter('this test succeeds')
1741
 
 
1742
 
        def test_xfail(self):
1743
 
            mutter('test with expected failure')
1744
 
            self.knownFailure('this_fails')
1745
 
 
1746
 
        def test_unexpected_success(self):
1747
 
            mutter('test with unexpected success')
1748
 
            self.expectFailure('should_fail', lambda: None)
1749
 
 
1750
 
    return ExampleTests(name)
1751
 
 
1752
 
 
1753
 
class TestTestCaseLogDetails(tests.TestCase):
1754
 
 
1755
 
    def _run_test(self, test_name):
1756
 
        test = _get_test(test_name)
1757
 
        result = testtools.TestResult()
1758
 
        test.run(result)
1759
 
        return result
1760
 
 
1761
 
    def test_fail_has_log(self):
1762
 
        result = self._run_test('test_fail')
1763
 
        self.assertEqual(1, len(result.failures))
1764
 
        result_content = result.failures[0][1]
1765
 
        self.assertContainsRe(result_content, 'Text attachment: log')
1766
 
        self.assertContainsRe(result_content, 'this was a failing test')
1767
 
 
1768
 
    def test_error_has_log(self):
1769
 
        result = self._run_test('test_error')
1770
 
        self.assertEqual(1, len(result.errors))
1771
 
        result_content = result.errors[0][1]
1772
 
        self.assertContainsRe(result_content, 'Text attachment: log')
1773
 
        self.assertContainsRe(result_content, 'this test errored')
1774
 
 
1775
 
    def test_skip_has_no_log(self):
1776
 
        result = self._run_test('test_skip')
1777
 
        self.assertEqual(['reason'], result.skip_reasons.keys())
1778
 
        skips = result.skip_reasons['reason']
1779
 
        self.assertEqual(1, len(skips))
1780
 
        test = skips[0]
1781
 
        self.assertFalse('log' in test.getDetails())
1782
 
 
1783
 
    def test_missing_feature_has_no_log(self):
1784
 
        # testtools doesn't know about addNotSupported, so it just gets
1785
 
        # considered as a skip
1786
 
        result = self._run_test('test_missing_feature')
1787
 
        self.assertEqual([missing_feature], result.skip_reasons.keys())
1788
 
        skips = result.skip_reasons[missing_feature]
1789
 
        self.assertEqual(1, len(skips))
1790
 
        test = skips[0]
1791
 
        self.assertFalse('log' in test.getDetails())
1792
 
 
1793
 
    def test_xfail_has_no_log(self):
1794
 
        result = self._run_test('test_xfail')
1795
 
        self.assertEqual(1, len(result.expectedFailures))
1796
 
        result_content = result.expectedFailures[0][1]
1797
 
        self.assertNotContainsRe(result_content, 'Text attachment: log')
1798
 
        self.assertNotContainsRe(result_content, 'test with expected failure')
1799
 
 
1800
 
    def test_unexpected_success_has_log(self):
1801
 
        result = self._run_test('test_unexpected_success')
1802
 
        self.assertEqual(1, len(result.unexpectedSuccesses))
1803
 
        # Inconsistency, unexpectedSuccesses is a list of tests,
1804
 
        # expectedFailures is a list of reasons?
1805
 
        test = result.unexpectedSuccesses[0]
1806
 
        details = test.getDetails()
1807
 
        self.assertTrue('log' in details)
1808
 
 
1809
 
 
1810
 
class TestTestCloning(tests.TestCase):
1811
 
    """Tests that test cloning of TestCases (as used by multiply_tests)."""
1812
 
 
1813
 
    def test_cloned_testcase_does_not_share_details(self):
1814
 
        """A TestCase cloned with clone_test does not share mutable attributes
1815
 
        such as details or cleanups.
1816
 
        """
1817
 
        class Test(tests.TestCase):
1818
 
            def test_foo(self):
1819
 
                self.addDetail('foo', Content('text/plain', lambda: 'foo'))
1820
 
        orig_test = Test('test_foo')
1821
 
        cloned_test = tests.clone_test(orig_test, orig_test.id() + '(cloned)')
1822
 
        orig_test.run(unittest.TestResult())
1823
 
        self.assertEqual('foo', orig_test.getDetails()['foo'].iter_bytes())
1824
 
        self.assertEqual(None, cloned_test.getDetails().get('foo'))
1825
 
 
1826
 
    def test_double_apply_scenario_preserves_first_scenario(self):
1827
 
        """Applying two levels of scenarios to a test preserves the attributes
1828
 
        added by both scenarios.
1829
 
        """
1830
 
        class Test(tests.TestCase):
1831
 
            def test_foo(self):
1832
 
                pass
1833
 
        test = Test('test_foo')
1834
 
        scenarios_x = [('x=1', {'x': 1}), ('x=2', {'x': 2})]
1835
 
        scenarios_y = [('y=1', {'y': 1}), ('y=2', {'y': 2})]
1836
 
        suite = tests.multiply_tests(test, scenarios_x, unittest.TestSuite())
1837
 
        suite = tests.multiply_tests(suite, scenarios_y, unittest.TestSuite())
1838
 
        all_tests = list(tests.iter_suite_tests(suite))
1839
 
        self.assertLength(4, all_tests)
1840
 
        all_xys = sorted((t.x, t.y) for t in all_tests)
1841
 
        self.assertEqual([(1, 1), (1, 2), (2, 1), (2, 2)], all_xys)
1842
 
 
1843
1660
 
1844
1661
# NB: Don't delete this; it's not actually from 0.11!
1845
1662
@deprecated_function(deprecated_in((0, 11, 0)))
1874
1691
    def test_assert_isinstance(self):
1875
1692
        self.assertIsInstance(2, int)
1876
1693
        self.assertIsInstance(u'', basestring)
1877
 
        e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1878
 
        self.assertEquals(str(e),
1879
 
            "None is an instance of <type 'NoneType'> rather than <type 'int'>")
 
1694
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1880
1695
        self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1881
 
        e = self.assertRaises(AssertionError,
1882
 
            self.assertIsInstance, None, int, "it's just not")
1883
 
        self.assertEquals(str(e),
1884
 
            "None is an instance of <type 'NoneType'> rather than <type 'int'>"
1885
 
            ": it's just not")
1886
1696
 
1887
1697
    def test_assertEndsWith(self):
1888
1698
        self.assertEndsWith('foo', 'oo')
1889
1699
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1890
1700
 
1891
 
    def test_assertEqualDiff(self):
1892
 
        e = self.assertRaises(AssertionError,
1893
 
                              self.assertEqualDiff, '', '\n')
1894
 
        self.assertEquals(str(e),
1895
 
                          # Don't blink ! The '+' applies to the second string
1896
 
                          'first string is missing a final newline.\n+ \n')
1897
 
        e = self.assertRaises(AssertionError,
1898
 
                              self.assertEqualDiff, '\n', '')
1899
 
        self.assertEquals(str(e),
1900
 
                          # Don't blink ! The '-' applies to the second string
1901
 
                          'second string is missing a final newline.\n- \n')
1902
 
 
1903
 
 
1904
 
class TestDeprecations(tests.TestCase):
1905
 
 
1906
1701
    def test_applyDeprecated_not_deprecated(self):
1907
1702
        sample_object = ApplyDeprecatedHelper()
1908
1703
        # calling an undeprecated callable raises an assertion
1985
1780
        tree = self.make_branch_and_memory_tree('a')
1986
1781
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1987
1782
 
1988
 
    def test_make_tree_for_local_vfs_backed_transport(self):
1989
 
        # make_branch_and_tree has to use local branch and repositories
1990
 
        # when the vfs transport and local disk are colocated, even if
1991
 
        # a different transport is in use for url generation.
1992
 
        self.transport_server = test_server.FakeVFATServer
1993
 
        self.assertFalse(self.get_url('t1').startswith('file://'))
 
1783
 
 
1784
class TestSFTPMakeBranchAndTree(test_sftp_transport.TestCaseWithSFTPServer):
 
1785
 
 
1786
    def test_make_tree_for_sftp_branch(self):
 
1787
        """Transports backed by local directories create local trees."""
 
1788
 
1994
1789
        tree = self.make_branch_and_tree('t1')
1995
1790
        base = tree.bzrdir.root_transport.base
1996
 
        self.assertStartsWith(base, 'file://')
 
1791
        self.failIf(base.startswith('sftp'),
 
1792
                'base %r is on sftp but should be local' % base)
1997
1793
        self.assertEquals(tree.bzrdir.root_transport,
1998
1794
                tree.branch.bzrdir.root_transport)
1999
1795
        self.assertEquals(tree.bzrdir.root_transport,
2000
1796
                tree.branch.repository.bzrdir.root_transport)
2001
1797
 
2002
1798
 
2003
 
class SelfTestHelper(object):
2004
 
 
2005
 
    def run_selftest(self, **kwargs):
2006
 
        """Run selftest returning its output."""
2007
 
        output = StringIO()
2008
 
        old_transport = bzrlib.tests.default_transport
2009
 
        old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
2010
 
        tests.TestCaseWithMemoryTransport.TEST_ROOT = None
2011
 
        try:
2012
 
            self.assertEqual(True, tests.selftest(stream=output, **kwargs))
2013
 
        finally:
2014
 
            bzrlib.tests.default_transport = old_transport
2015
 
            tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
2016
 
        output.seek(0)
2017
 
        return output
2018
 
 
2019
 
 
2020
 
class TestSelftest(tests.TestCase, SelfTestHelper):
 
1799
class TestSelftest(tests.TestCase):
2021
1800
    """Tests of bzrlib.tests.selftest."""
2022
1801
 
2023
1802
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
2031
1810
            test_suite_factory=factory)
2032
1811
        self.assertEqual([True], factory_called)
2033
1812
 
2034
 
    def factory(self):
2035
 
        """A test suite factory."""
2036
 
        class Test(tests.TestCase):
2037
 
            def a(self):
2038
 
                pass
2039
 
            def b(self):
2040
 
                pass
2041
 
            def c(self):
2042
 
                pass
2043
 
        return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
2044
 
 
2045
 
    def test_list_only(self):
2046
 
        output = self.run_selftest(test_suite_factory=self.factory,
2047
 
            list_only=True)
2048
 
        self.assertEqual(3, len(output.readlines()))
2049
 
 
2050
 
    def test_list_only_filtered(self):
2051
 
        output = self.run_selftest(test_suite_factory=self.factory,
2052
 
            list_only=True, pattern="Test.b")
2053
 
        self.assertEndsWith(output.getvalue(), "Test.b\n")
2054
 
        self.assertLength(1, output.readlines())
2055
 
 
2056
 
    def test_list_only_excludes(self):
2057
 
        output = self.run_selftest(test_suite_factory=self.factory,
2058
 
            list_only=True, exclude_pattern="Test.b")
2059
 
        self.assertNotContainsRe("Test.b", output.getvalue())
2060
 
        self.assertLength(2, output.readlines())
2061
 
 
2062
 
    def test_lsprof_tests(self):
2063
 
        self.requireFeature(test_lsprof.LSProfFeature)
2064
 
        calls = []
2065
 
        class Test(object):
2066
 
            def __call__(test, result):
2067
 
                test.run(result)
2068
 
            def run(test, result):
2069
 
                self.assertIsInstance(result, tests.ForwardingResult)
2070
 
                calls.append("called")
2071
 
            def countTestCases(self):
2072
 
                return 1
2073
 
        self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
2074
 
        self.assertLength(1, calls)
2075
 
 
2076
 
    def test_random(self):
2077
 
        # test randomising by listing a number of tests.
2078
 
        output_123 = self.run_selftest(test_suite_factory=self.factory,
2079
 
            list_only=True, random_seed="123")
2080
 
        output_234 = self.run_selftest(test_suite_factory=self.factory,
2081
 
            list_only=True, random_seed="234")
2082
 
        self.assertNotEqual(output_123, output_234)
2083
 
        # "Randominzing test order..\n\n
2084
 
        self.assertLength(5, output_123.readlines())
2085
 
        self.assertLength(5, output_234.readlines())
2086
 
 
2087
 
    def test_random_reuse_is_same_order(self):
2088
 
        # test randomising by listing a number of tests.
2089
 
        expected = self.run_selftest(test_suite_factory=self.factory,
2090
 
            list_only=True, random_seed="123")
2091
 
        repeated = self.run_selftest(test_suite_factory=self.factory,
2092
 
            list_only=True, random_seed="123")
2093
 
        self.assertEqual(expected.getvalue(), repeated.getvalue())
2094
 
 
2095
 
    def test_runner_class(self):
2096
 
        self.requireFeature(features.subunit)
2097
 
        from subunit import ProtocolTestCase
2098
 
        stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
2099
 
            test_suite_factory=self.factory)
2100
 
        test = ProtocolTestCase(stream)
2101
 
        result = unittest.TestResult()
2102
 
        test.run(result)
2103
 
        self.assertEqual(3, result.testsRun)
2104
 
 
2105
 
    def test_starting_with_single_argument(self):
2106
 
        output = self.run_selftest(test_suite_factory=self.factory,
2107
 
            starting_with=['bzrlib.tests.test_selftest.Test.a'],
2108
 
            list_only=True)
2109
 
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
2110
 
            output.getvalue())
2111
 
 
2112
 
    def test_starting_with_multiple_argument(self):
2113
 
        output = self.run_selftest(test_suite_factory=self.factory,
2114
 
            starting_with=['bzrlib.tests.test_selftest.Test.a',
2115
 
                'bzrlib.tests.test_selftest.Test.b'],
2116
 
            list_only=True)
2117
 
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
2118
 
            'bzrlib.tests.test_selftest.Test.b\n',
2119
 
            output.getvalue())
2120
 
 
2121
 
    def check_transport_set(self, transport_server):
2122
 
        captured_transport = []
2123
 
        def seen_transport(a_transport):
2124
 
            captured_transport.append(a_transport)
2125
 
        class Capture(tests.TestCase):
2126
 
            def a(self):
2127
 
                seen_transport(bzrlib.tests.default_transport)
2128
 
        def factory():
2129
 
            return TestUtil.TestSuite([Capture("a")])
2130
 
        self.run_selftest(transport=transport_server, test_suite_factory=factory)
2131
 
        self.assertEqual(transport_server, captured_transport[0])
2132
 
 
2133
 
    def test_transport_sftp(self):
2134
 
        self.requireFeature(features.paramiko)
2135
 
        from bzrlib.tests import stub_sftp
2136
 
        self.check_transport_set(stub_sftp.SFTPAbsoluteServer)
2137
 
 
2138
 
    def test_transport_memory(self):
2139
 
        self.check_transport_set(memory.MemoryServer)
2140
 
 
2141
 
 
2142
 
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
2143
 
    # Does IO: reads test.list
2144
 
 
2145
 
    def test_load_list(self):
2146
 
        # Provide a list with one test - this test.
2147
 
        test_id_line = '%s\n' % self.id()
2148
 
        self.build_tree_contents([('test.list', test_id_line)])
2149
 
        # And generate a list of the tests in  the suite.
2150
 
        stream = self.run_selftest(load_list='test.list', list_only=True)
2151
 
        self.assertEqual(test_id_line, stream.getvalue())
2152
 
 
2153
 
    def test_load_unknown(self):
2154
 
        # Provide a list with one test - this test.
2155
 
        # And generate a list of the tests in  the suite.
2156
 
        err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
2157
 
            load_list='missing file name', list_only=True)
2158
 
 
2159
 
 
2160
 
class TestSubunitLogDetails(tests.TestCase, SelfTestHelper):
2161
 
 
2162
 
    _test_needs_features = [features.subunit]
2163
 
 
2164
 
    def run_subunit_stream(self, test_name):
2165
 
        from subunit import ProtocolTestCase
2166
 
        def factory():
2167
 
            return TestUtil.TestSuite([_get_test(test_name)])
2168
 
        stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
2169
 
            test_suite_factory=factory)
2170
 
        test = ProtocolTestCase(stream)
2171
 
        result = testtools.TestResult()
2172
 
        test.run(result)
2173
 
        content = stream.getvalue()
2174
 
        return content, result
2175
 
 
2176
 
    def test_fail_has_log(self):
2177
 
        content, result = self.run_subunit_stream('test_fail')
2178
 
        self.assertEqual(1, len(result.failures))
2179
 
        self.assertContainsRe(content, '(?m)^log$')
2180
 
        self.assertContainsRe(content, 'this test will fail')
2181
 
 
2182
 
    def test_error_has_log(self):
2183
 
        content, result = self.run_subunit_stream('test_error')
2184
 
        self.assertContainsRe(content, '(?m)^log$')
2185
 
        self.assertContainsRe(content, 'this test errored')
2186
 
 
2187
 
    def test_skip_has_no_log(self):
2188
 
        content, result = self.run_subunit_stream('test_skip')
2189
 
        self.assertNotContainsRe(content, '(?m)^log$')
2190
 
        self.assertNotContainsRe(content, 'this test will be skipped')
2191
 
        self.assertEqual(['reason'], result.skip_reasons.keys())
2192
 
        skips = result.skip_reasons['reason']
2193
 
        self.assertEqual(1, len(skips))
2194
 
        test = skips[0]
2195
 
        # RemotedTestCase doesn't preserve the "details"
2196
 
        ## self.assertFalse('log' in test.getDetails())
2197
 
 
2198
 
    def test_missing_feature_has_no_log(self):
2199
 
        content, result = self.run_subunit_stream('test_missing_feature')
2200
 
        self.assertNotContainsRe(content, '(?m)^log$')
2201
 
        self.assertNotContainsRe(content, 'missing the feature')
2202
 
        self.assertEqual(['_MissingFeature\n'], result.skip_reasons.keys())
2203
 
        skips = result.skip_reasons['_MissingFeature\n']
2204
 
        self.assertEqual(1, len(skips))
2205
 
        test = skips[0]
2206
 
        # RemotedTestCase doesn't preserve the "details"
2207
 
        ## self.assertFalse('log' in test.getDetails())
2208
 
 
2209
 
    def test_xfail_has_no_log(self):
2210
 
        content, result = self.run_subunit_stream('test_xfail')
2211
 
        self.assertNotContainsRe(content, '(?m)^log$')
2212
 
        self.assertNotContainsRe(content, 'test with expected failure')
2213
 
        self.assertEqual(1, len(result.expectedFailures))
2214
 
        result_content = result.expectedFailures[0][1]
2215
 
        self.assertNotContainsRe(result_content, 'Text attachment: log')
2216
 
        self.assertNotContainsRe(result_content, 'test with expected failure')
2217
 
 
2218
 
    def test_unexpected_success_has_log(self):
2219
 
        content, result = self.run_subunit_stream('test_unexpected_success')
2220
 
        self.assertContainsRe(content, '(?m)^log$')
2221
 
        self.assertContainsRe(content, 'test with unexpected success')
2222
 
        self.expectFailure('subunit treats "unexpectedSuccess"'
2223
 
                           ' as a plain success',
2224
 
            self.assertEqual, 1, len(result.unexpectedSuccesses))
2225
 
        self.assertEqual(1, len(result.unexpectedSuccesses))
2226
 
        test = result.unexpectedSuccesses[0]
2227
 
        # RemotedTestCase doesn't preserve the "details"
2228
 
        ## self.assertTrue('log' in test.getDetails())
2229
 
 
2230
 
    def test_success_has_no_log(self):
2231
 
        content, result = self.run_subunit_stream('test_success')
2232
 
        self.assertEqual(1, result.testsRun)
2233
 
        self.assertNotContainsRe(content, '(?m)^log$')
2234
 
        self.assertNotContainsRe(content, 'this test succeeds')
2235
 
 
2236
 
 
2237
 
class TestRunBzr(tests.TestCase):
2238
 
 
2239
 
    out = ''
2240
 
    err = ''
2241
 
 
2242
 
    def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
2243
 
                         working_dir=None):
2244
 
        """Override _run_bzr_core to test how it is invoked by run_bzr.
2245
 
 
2246
 
        Attempts to run bzr from inside this class don't actually run it.
2247
 
 
2248
 
        We test how run_bzr actually invokes bzr in another location.  Here we
2249
 
        only need to test that it passes the right parameters to run_bzr.
2250
 
        """
2251
 
        self.argv = list(argv)
2252
 
        self.retcode = retcode
2253
 
        self.encoding = encoding
2254
 
        self.stdin = stdin
2255
 
        self.working_dir = working_dir
2256
 
        return self.retcode, self.out, self.err
2257
 
 
2258
 
    def test_run_bzr_error(self):
2259
 
        self.out = "It sure does!\n"
2260
 
        out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
2261
 
        self.assertEqual(['rocks'], self.argv)
2262
 
        self.assertEqual(34, self.retcode)
2263
 
        self.assertEqual('It sure does!\n', out)
2264
 
        self.assertEquals(out, self.out)
2265
 
        self.assertEqual('', err)
2266
 
        self.assertEquals(err, self.err)
2267
 
 
2268
 
    def test_run_bzr_error_regexes(self):
2269
 
        self.out = ''
2270
 
        self.err = "bzr: ERROR: foobarbaz is not versioned"
2271
 
        out, err = self.run_bzr_error(
2272
 
            ["bzr: ERROR: foobarbaz is not versioned"],
2273
 
            ['file-id', 'foobarbaz'])
2274
 
 
2275
 
    def test_encoding(self):
2276
 
        """Test that run_bzr passes encoding to _run_bzr_core"""
2277
 
        self.run_bzr('foo bar')
2278
 
        self.assertEqual(None, self.encoding)
2279
 
        self.assertEqual(['foo', 'bar'], self.argv)
2280
 
 
2281
 
        self.run_bzr('foo bar', encoding='baz')
2282
 
        self.assertEqual('baz', self.encoding)
2283
 
        self.assertEqual(['foo', 'bar'], self.argv)
2284
 
 
2285
 
    def test_retcode(self):
2286
 
        """Test that run_bzr passes retcode to _run_bzr_core"""
2287
 
        # Default is retcode == 0
2288
 
        self.run_bzr('foo bar')
2289
 
        self.assertEqual(0, self.retcode)
2290
 
        self.assertEqual(['foo', 'bar'], self.argv)
2291
 
 
2292
 
        self.run_bzr('foo bar', retcode=1)
2293
 
        self.assertEqual(1, self.retcode)
2294
 
        self.assertEqual(['foo', 'bar'], self.argv)
2295
 
 
2296
 
        self.run_bzr('foo bar', retcode=None)
2297
 
        self.assertEqual(None, self.retcode)
2298
 
        self.assertEqual(['foo', 'bar'], self.argv)
2299
 
 
2300
 
        self.run_bzr(['foo', 'bar'], retcode=3)
2301
 
        self.assertEqual(3, self.retcode)
2302
 
        self.assertEqual(['foo', 'bar'], self.argv)
2303
 
 
2304
 
    def test_stdin(self):
2305
 
        # test that the stdin keyword to run_bzr is passed through to
2306
 
        # _run_bzr_core as-is. We do this by overriding
2307
 
        # _run_bzr_core in this class, and then calling run_bzr,
2308
 
        # which is a convenience function for _run_bzr_core, so
2309
 
        # should invoke it.
2310
 
        self.run_bzr('foo bar', stdin='gam')
2311
 
        self.assertEqual('gam', self.stdin)
2312
 
        self.assertEqual(['foo', 'bar'], self.argv)
2313
 
 
2314
 
        self.run_bzr('foo bar', stdin='zippy')
2315
 
        self.assertEqual('zippy', self.stdin)
2316
 
        self.assertEqual(['foo', 'bar'], self.argv)
2317
 
 
2318
 
    def test_working_dir(self):
2319
 
        """Test that run_bzr passes working_dir to _run_bzr_core"""
2320
 
        self.run_bzr('foo bar')
2321
 
        self.assertEqual(None, self.working_dir)
2322
 
        self.assertEqual(['foo', 'bar'], self.argv)
2323
 
 
2324
 
        self.run_bzr('foo bar', working_dir='baz')
2325
 
        self.assertEqual('baz', self.working_dir)
2326
 
        self.assertEqual(['foo', 'bar'], self.argv)
2327
 
 
2328
 
    def test_reject_extra_keyword_arguments(self):
2329
 
        self.assertRaises(TypeError, self.run_bzr, "foo bar",
2330
 
                          error_regex=['error message'])
2331
 
 
2332
 
 
2333
 
class TestRunBzrCaptured(tests.TestCaseWithTransport):
2334
 
    # Does IO when testing the working_dir parameter.
2335
 
 
2336
 
    def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2337
 
                         a_callable=None, *args, **kwargs):
2338
 
        self.stdin = stdin
2339
 
        self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
2340
 
        self.factory = bzrlib.ui.ui_factory
2341
 
        self.working_dir = osutils.getcwd()
2342
 
        stdout.write('foo\n')
2343
 
        stderr.write('bar\n')
2344
 
        return 0
2345
 
 
2346
 
    def test_stdin(self):
2347
 
        # test that the stdin keyword to _run_bzr_core is passed through to
2348
 
        # apply_redirected as a StringIO. We do this by overriding
2349
 
        # apply_redirected in this class, and then calling _run_bzr_core,
2350
 
        # which calls apply_redirected.
2351
 
        self.run_bzr(['foo', 'bar'], stdin='gam')
2352
 
        self.assertEqual('gam', self.stdin.read())
2353
 
        self.assertTrue(self.stdin is self.factory_stdin)
2354
 
        self.run_bzr(['foo', 'bar'], stdin='zippy')
2355
 
        self.assertEqual('zippy', self.stdin.read())
2356
 
        self.assertTrue(self.stdin is self.factory_stdin)
2357
 
 
2358
 
    def test_ui_factory(self):
2359
 
        # each invocation of self.run_bzr should get its
2360
 
        # own UI factory, which is an instance of TestUIFactory,
2361
 
        # with stdin, stdout and stderr attached to the stdin,
2362
 
        # stdout and stderr of the invoked run_bzr
2363
 
        current_factory = bzrlib.ui.ui_factory
2364
 
        self.run_bzr(['foo'])
2365
 
        self.failIf(current_factory is self.factory)
2366
 
        self.assertNotEqual(sys.stdout, self.factory.stdout)
2367
 
        self.assertNotEqual(sys.stderr, self.factory.stderr)
2368
 
        self.assertEqual('foo\n', self.factory.stdout.getvalue())
2369
 
        self.assertEqual('bar\n', self.factory.stderr.getvalue())
2370
 
        self.assertIsInstance(self.factory, tests.TestUIFactory)
2371
 
 
2372
 
    def test_working_dir(self):
2373
 
        self.build_tree(['one/', 'two/'])
2374
 
        cwd = osutils.getcwd()
2375
 
 
2376
 
        # Default is to work in the current directory
2377
 
        self.run_bzr(['foo', 'bar'])
2378
 
        self.assertEqual(cwd, self.working_dir)
2379
 
 
2380
 
        self.run_bzr(['foo', 'bar'], working_dir=None)
2381
 
        self.assertEqual(cwd, self.working_dir)
2382
 
 
2383
 
        # The function should be run in the alternative directory
2384
 
        # but afterwards the current working dir shouldn't be changed
2385
 
        self.run_bzr(['foo', 'bar'], working_dir='one')
2386
 
        self.assertNotEqual(cwd, self.working_dir)
2387
 
        self.assertEndsWith(self.working_dir, 'one')
2388
 
        self.assertEqual(cwd, osutils.getcwd())
2389
 
 
2390
 
        self.run_bzr(['foo', 'bar'], working_dir='two')
2391
 
        self.assertNotEqual(cwd, self.working_dir)
2392
 
        self.assertEndsWith(self.working_dir, 'two')
2393
 
        self.assertEqual(cwd, osutils.getcwd())
2394
 
 
2395
 
 
2396
 
class StubProcess(object):
2397
 
    """A stub process for testing run_bzr_subprocess."""
2398
 
    
2399
 
    def __init__(self, out="", err="", retcode=0):
2400
 
        self.out = out
2401
 
        self.err = err
2402
 
        self.returncode = retcode
2403
 
 
2404
 
    def communicate(self):
2405
 
        return self.out, self.err
2406
 
 
2407
 
 
2408
 
class TestWithFakedStartBzrSubprocess(tests.TestCaseWithTransport):
2409
 
    """Base class for tests testing how we might run bzr."""
2410
 
 
2411
 
    def setUp(self):
2412
 
        tests.TestCaseWithTransport.setUp(self)
2413
 
        self.subprocess_calls = []
2414
 
 
2415
 
    def start_bzr_subprocess(self, process_args, env_changes=None,
2416
 
                             skip_if_plan_to_signal=False,
2417
 
                             working_dir=None,
2418
 
                             allow_plugins=False):
2419
 
        """capture what run_bzr_subprocess tries to do."""
2420
 
        self.subprocess_calls.append({'process_args':process_args,
2421
 
            'env_changes':env_changes,
2422
 
            'skip_if_plan_to_signal':skip_if_plan_to_signal,
2423
 
            'working_dir':working_dir, 'allow_plugins':allow_plugins})
2424
 
        return self.next_subprocess
2425
 
 
2426
 
 
2427
 
class TestRunBzrSubprocess(TestWithFakedStartBzrSubprocess):
2428
 
 
2429
 
    def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
2430
 
        """Run run_bzr_subprocess with args and kwargs using a stubbed process.
2431
 
 
2432
 
        Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
2433
 
        that will return static results. This assertion method populates those
2434
 
        results and also checks the arguments run_bzr_subprocess generates.
2435
 
        """
2436
 
        self.next_subprocess = process
2437
 
        try:
2438
 
            result = self.run_bzr_subprocess(*args, **kwargs)
2439
 
        except:
2440
 
            self.next_subprocess = None
2441
 
            for key, expected in expected_args.iteritems():
2442
 
                self.assertEqual(expected, self.subprocess_calls[-1][key])
2443
 
            raise
 
1813
 
 
1814
class TestKnownFailure(tests.TestCase):
 
1815
 
 
1816
    def test_known_failure(self):
 
1817
        """Check that KnownFailure is defined appropriately."""
 
1818
        # a KnownFailure is an assertion error for compatability with unaware
 
1819
        # runners.
 
1820
        self.assertIsInstance(tests.KnownFailure(""), AssertionError)
 
1821
 
 
1822
    def test_expect_failure(self):
 
1823
        try:
 
1824
            self.expectFailure("Doomed to failure", self.assertTrue, False)
 
1825
        except tests.KnownFailure, e:
 
1826
            self.assertEqual('Doomed to failure', e.args[0])
 
1827
        try:
 
1828
            self.expectFailure("Doomed to failure", self.assertTrue, True)
 
1829
        except AssertionError, e:
 
1830
            self.assertEqual('Unexpected success.  Should have failed:'
 
1831
                             ' Doomed to failure', e.args[0])
2444
1832
        else:
2445
 
            self.next_subprocess = None
2446
 
            for key, expected in expected_args.iteritems():
2447
 
                self.assertEqual(expected, self.subprocess_calls[-1][key])
2448
 
            return result
2449
 
 
2450
 
    def test_run_bzr_subprocess(self):
2451
 
        """The run_bzr_helper_external command behaves nicely."""
2452
 
        self.assertRunBzrSubprocess({'process_args':['--version']},
2453
 
            StubProcess(), '--version')
2454
 
        self.assertRunBzrSubprocess({'process_args':['--version']},
2455
 
            StubProcess(), ['--version'])
2456
 
        # retcode=None disables retcode checking
2457
 
        result = self.assertRunBzrSubprocess({},
2458
 
            StubProcess(retcode=3), '--version', retcode=None)
2459
 
        result = self.assertRunBzrSubprocess({},
2460
 
            StubProcess(out="is free software"), '--version')
2461
 
        self.assertContainsRe(result[0], 'is free software')
2462
 
        # Running a subcommand that is missing errors
2463
 
        self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
2464
 
            {'process_args':['--versionn']}, StubProcess(retcode=3),
2465
 
            '--versionn')
2466
 
        # Unless it is told to expect the error from the subprocess
2467
 
        result = self.assertRunBzrSubprocess({},
2468
 
            StubProcess(retcode=3), '--versionn', retcode=3)
2469
 
        # Or to ignore retcode checking
2470
 
        result = self.assertRunBzrSubprocess({},
2471
 
            StubProcess(err="unknown command", retcode=3), '--versionn',
2472
 
            retcode=None)
2473
 
        self.assertContainsRe(result[1], 'unknown command')
2474
 
 
2475
 
    def test_env_change_passes_through(self):
2476
 
        self.assertRunBzrSubprocess(
2477
 
            {'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
2478
 
            StubProcess(), '',
2479
 
            env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
2480
 
 
2481
 
    def test_no_working_dir_passed_as_None(self):
2482
 
        self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
2483
 
 
2484
 
    def test_no_working_dir_passed_through(self):
2485
 
        self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
2486
 
            working_dir='dir')
2487
 
 
2488
 
    def test_run_bzr_subprocess_no_plugins(self):
2489
 
        self.assertRunBzrSubprocess({'allow_plugins': False},
2490
 
            StubProcess(), '')
2491
 
 
2492
 
    def test_allow_plugins(self):
2493
 
        self.assertRunBzrSubprocess({'allow_plugins': True},
2494
 
            StubProcess(), '', allow_plugins=True)
2495
 
 
2496
 
 
2497
 
class TestFinishBzrSubprocess(TestWithFakedStartBzrSubprocess):
2498
 
 
2499
 
    def test_finish_bzr_subprocess_with_error(self):
2500
 
        """finish_bzr_subprocess allows specification of the desired exit code.
2501
 
        """
2502
 
        process = StubProcess(err="unknown command", retcode=3)
2503
 
        result = self.finish_bzr_subprocess(process, retcode=3)
2504
 
        self.assertEqual('', result[0])
2505
 
        self.assertContainsRe(result[1], 'unknown command')
2506
 
 
2507
 
    def test_finish_bzr_subprocess_ignoring_retcode(self):
2508
 
        """finish_bzr_subprocess allows the exit code to be ignored."""
2509
 
        process = StubProcess(err="unknown command", retcode=3)
2510
 
        result = self.finish_bzr_subprocess(process, retcode=None)
2511
 
        self.assertEqual('', result[0])
2512
 
        self.assertContainsRe(result[1], 'unknown command')
2513
 
 
2514
 
    def test_finish_subprocess_with_unexpected_retcode(self):
2515
 
        """finish_bzr_subprocess raises self.failureException if the retcode is
2516
 
        not the expected one.
2517
 
        """
2518
 
        process = StubProcess(err="unknown command", retcode=3)
2519
 
        self.assertRaises(self.failureException, self.finish_bzr_subprocess,
2520
 
                          process)
2521
 
 
2522
 
 
2523
 
class _DontSpawnProcess(Exception):
2524
 
    """A simple exception which just allows us to skip unnecessary steps"""
2525
 
 
2526
 
 
2527
 
class TestStartBzrSubProcess(tests.TestCase):
2528
 
 
2529
 
    def check_popen_state(self):
2530
 
        """Replace to make assertions when popen is called."""
2531
 
 
2532
 
    def _popen(self, *args, **kwargs):
2533
 
        """Record the command that is run, so that we can ensure it is correct"""
2534
 
        self.check_popen_state()
2535
 
        self._popen_args = args
2536
 
        self._popen_kwargs = kwargs
2537
 
        raise _DontSpawnProcess()
2538
 
 
2539
 
    def test_run_bzr_subprocess_no_plugins(self):
2540
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
2541
 
        command = self._popen_args[0]
2542
 
        self.assertEqual(sys.executable, command[0])
2543
 
        self.assertEqual(self.get_bzr_path(), command[1])
2544
 
        self.assertEqual(['--no-plugins'], command[2:])
2545
 
 
2546
 
    def test_allow_plugins(self):
2547
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2548
 
            allow_plugins=True)
2549
 
        command = self._popen_args[0]
2550
 
        self.assertEqual([], command[2:])
2551
 
 
2552
 
    def test_set_env(self):
2553
 
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
2554
 
        # set in the child
2555
 
        def check_environment():
2556
 
            self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2557
 
        self.check_popen_state = check_environment
2558
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2559
 
            env_changes={'EXISTANT_ENV_VAR':'set variable'})
2560
 
        # not set in theparent
2561
 
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2562
 
 
2563
 
    def test_run_bzr_subprocess_env_del(self):
2564
 
        """run_bzr_subprocess can remove environment variables too."""
2565
 
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
2566
 
        def check_environment():
2567
 
            self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2568
 
        os.environ['EXISTANT_ENV_VAR'] = 'set variable'
2569
 
        self.check_popen_state = check_environment
2570
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2571
 
            env_changes={'EXISTANT_ENV_VAR':None})
2572
 
        # Still set in parent
2573
 
        self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2574
 
        del os.environ['EXISTANT_ENV_VAR']
2575
 
 
2576
 
    def test_env_del_missing(self):
2577
 
        self.failIf('NON_EXISTANT_ENV_VAR' in os.environ)
2578
 
        def check_environment():
2579
 
            self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2580
 
        self.check_popen_state = check_environment
2581
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2582
 
            env_changes={'NON_EXISTANT_ENV_VAR':None})
2583
 
 
2584
 
    def test_working_dir(self):
2585
 
        """Test that we can specify the working dir for the child"""
2586
 
        orig_getcwd = osutils.getcwd
2587
 
        orig_chdir = os.chdir
2588
 
        chdirs = []
2589
 
        def chdir(path):
2590
 
            chdirs.append(path)
2591
 
        os.chdir = chdir
2592
 
        try:
2593
 
            def getcwd():
2594
 
                return 'current'
2595
 
            osutils.getcwd = getcwd
2596
 
            try:
2597
 
                self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2598
 
                    working_dir='foo')
2599
 
            finally:
2600
 
                osutils.getcwd = orig_getcwd
2601
 
        finally:
2602
 
            os.chdir = orig_chdir
2603
 
        self.assertEqual(['foo', 'current'], chdirs)
2604
 
 
2605
 
    def test_get_bzr_path_with_cwd_bzrlib(self):
2606
 
        self.get_source_path = lambda: ""
2607
 
        self.overrideAttr(os.path, "isfile", lambda path: True)
2608
 
        self.assertEqual(self.get_bzr_path(), "bzr")
2609
 
 
2610
 
 
2611
 
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
2612
 
    """Tests that really need to do things with an external bzr."""
2613
 
 
2614
 
    def test_start_and_stop_bzr_subprocess_send_signal(self):
2615
 
        """finish_bzr_subprocess raises self.failureException if the retcode is
2616
 
        not the expected one.
2617
 
        """
2618
 
        self.disable_missing_extensions_warning()
2619
 
        process = self.start_bzr_subprocess(['wait-until-signalled'],
2620
 
                                            skip_if_plan_to_signal=True)
2621
 
        self.assertEqual('running\n', process.stdout.readline())
2622
 
        result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
2623
 
                                            retcode=3)
2624
 
        self.assertEqual('', result[0])
2625
 
        self.assertEqual('bzr: interrupted\n', result[1])
 
1833
            self.fail('Assertion not raised')
2626
1834
 
2627
1835
 
2628
1836
class TestFeature(tests.TestCase):
2666
1874
        self.assertIs(feature, exception.args[0])
2667
1875
 
2668
1876
 
2669
 
simple_thunk_feature = tests._CompatabilityThunkFeature(
2670
 
    deprecated_in((2, 1, 0)),
2671
 
    'bzrlib.tests.test_selftest',
2672
 
    'simple_thunk_feature','UnicodeFilename',
2673
 
    replacement_module='bzrlib.tests'
2674
 
    )
2675
 
 
2676
 
class Test_CompatibilityFeature(tests.TestCase):
2677
 
 
2678
 
    def test_does_thunk(self):
2679
 
        res = self.callDeprecated(
2680
 
            ['bzrlib.tests.test_selftest.simple_thunk_feature was deprecated'
2681
 
             ' in version 2.1.0. Use bzrlib.tests.UnicodeFilename instead.'],
2682
 
            simple_thunk_feature.available)
2683
 
        self.assertEqual(tests.UnicodeFilename.available(), res)
2684
 
 
2685
 
 
2686
 
class TestModuleAvailableFeature(tests.TestCase):
2687
 
 
2688
 
    def test_available_module(self):
2689
 
        feature = tests.ModuleAvailableFeature('bzrlib.tests')
2690
 
        self.assertEqual('bzrlib.tests', feature.module_name)
2691
 
        self.assertEqual('bzrlib.tests', str(feature))
2692
 
        self.assertTrue(feature.available())
2693
 
        self.assertIs(tests, feature.module)
2694
 
 
2695
 
    def test_unavailable_module(self):
2696
 
        feature = tests.ModuleAvailableFeature('bzrlib.no_such_module_exists')
2697
 
        self.assertEqual('bzrlib.no_such_module_exists', str(feature))
2698
 
        self.assertFalse(feature.available())
2699
 
        self.assertIs(None, feature.module)
2700
 
 
2701
 
 
2702
1877
class TestSelftestFiltering(tests.TestCase):
2703
1878
 
2704
1879
    def setUp(self):
2705
1880
        tests.TestCase.setUp(self)
2706
1881
        self.suite = TestUtil.TestSuite()
2707
1882
        self.loader = TestUtil.TestLoader()
2708
 
        self.suite.addTest(self.loader.loadTestsFromModule(
2709
 
            sys.modules['bzrlib.tests.test_selftest']))
 
1883
        self.suite.addTest(self.loader.loadTestsFromModuleNames([
 
1884
            'bzrlib.tests.test_selftest']))
2710
1885
        self.all_names = _test_ids(self.suite)
2711
1886
 
2712
1887
    def test_condition_id_re(self):
2883
2058
        # the test framework
2884
2059
        self.assertEquals('always fails', str(e))
2885
2060
        # check that there's no traceback in the test log
2886
 
        self.assertNotContainsRe(self.get_log(), r'Traceback')
 
2061
        self.assertNotContainsRe(self._get_log(keep_log_file=True),
 
2062
            r'Traceback')
2887
2063
 
2888
2064
    def test_run_bzr_user_error_caught(self):
2889
2065
        # Running bzr in blackbox mode, normal/expected/user errors should be
2890
2066
        # caught in the regular way and turned into an error message plus exit
2891
2067
        # code.
2892
 
        transport_server = memory.MemoryServer()
2893
 
        transport_server.start_server()
2894
 
        self.addCleanup(transport_server.stop_server)
2895
 
        url = transport_server.get_url()
2896
 
        self.permit_url(url)
2897
 
        out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
 
2068
        out, err = self.run_bzr(["log", "/nonexistantpath"], retcode=3)
2898
2069
        self.assertEqual(out, '')
2899
2070
        self.assertContainsRe(err,
2900
2071
            'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
3026
2197
 
3027
2198
class TestTestSuite(tests.TestCase):
3028
2199
 
3029
 
    def test__test_suite_testmod_names(self):
3030
 
        # Test that a plausible list of test module names are returned
3031
 
        # by _test_suite_testmod_names.
3032
 
        test_list = tests._test_suite_testmod_names()
3033
 
        self.assertSubset([
3034
 
            'bzrlib.tests.blackbox',
3035
 
            'bzrlib.tests.per_transport',
3036
 
            'bzrlib.tests.test_selftest',
3037
 
            ],
3038
 
            test_list)
3039
 
 
3040
 
    def test__test_suite_modules_to_doctest(self):
3041
 
        # Test that a plausible list of modules to doctest is returned
3042
 
        # by _test_suite_modules_to_doctest.
3043
 
        test_list = tests._test_suite_modules_to_doctest()
3044
 
        if __doc__ is None:
3045
 
            # When docstrings are stripped, there are no modules to doctest
3046
 
            self.assertEqual([], test_list)
3047
 
            return
3048
 
        self.assertSubset([
3049
 
            'bzrlib.timestamp',
3050
 
            ],
3051
 
            test_list)
3052
 
 
3053
2200
    def test_test_suite(self):
3054
 
        # test_suite() loads the entire test suite to operate. To avoid this
3055
 
        # overhead, and yet still be confident that things are happening,
3056
 
        # we temporarily replace two functions used by test_suite with 
3057
 
        # test doubles that supply a few sample tests to load, and check they
3058
 
        # are loaded.
3059
 
        calls = []
3060
 
        def testmod_names():
3061
 
            calls.append("testmod_names")
3062
 
            return [
3063
 
                'bzrlib.tests.blackbox.test_branch',
3064
 
                'bzrlib.tests.per_transport',
3065
 
                'bzrlib.tests.test_selftest',
3066
 
                ]
3067
 
        self.overrideAttr(tests, '_test_suite_testmod_names', testmod_names)
3068
 
        def doctests():
3069
 
            calls.append("modules_to_doctest")
3070
 
            if __doc__ is None:
3071
 
                return []
3072
 
            return ['bzrlib.timestamp']
3073
 
        self.overrideAttr(tests, '_test_suite_modules_to_doctest', doctests)
3074
 
        expected_test_list = [
 
2201
        # This test is slow, so we do a single test with one test in each
 
2202
        # category
 
2203
        test_list = [
3075
2204
            # testmod_names
3076
2205
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
3077
 
            ('bzrlib.tests.per_transport.TransportTests'
3078
 
             '.test_abspath(LocalTransport,LocalURLServer)'),
3079
2206
            'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
 
2207
            # transport implementations
 
2208
            'bzrlib.tests.test_transport_implementations.TransportTests'
 
2209
            '.test_abspath(LocalURLServer)',
 
2210
            # modules_to_doctest
 
2211
            'bzrlib.timestamp.format_highres_date',
3080
2212
            # plugins can't be tested that way since selftest may be run with
3081
2213
            # --no-plugins
3082
2214
            ]
3083
 
        if __doc__ is not None:
3084
 
            expected_test_list.extend([
3085
 
                # modules_to_doctest
3086
 
                'bzrlib.timestamp.format_highres_date',
3087
 
                ])
3088
 
        suite = tests.test_suite()
3089
 
        self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
3090
 
            set(calls))
3091
 
        self.assertSubset(expected_test_list, _test_ids(suite))
 
2215
        suite = tests.test_suite(test_list)
 
2216
        self.assertEquals(test_list, _test_ids(suite))
3092
2217
 
3093
2218
    def test_test_suite_list_and_start(self):
3094
 
        # We cannot test this at the same time as the main load, because we want
3095
 
        # to know that starting_with == None works. So a second load is
3096
 
        # incurred - note that the starting_with parameter causes a partial load
3097
 
        # rather than a full load so this test should be pretty quick.
3098
2219
        test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
3099
2220
        suite = tests.test_suite(test_list,
3100
2221
                                 ['bzrlib.tests.test_selftest.TestTestSuite'])
3145
2266
    def test_load_tests(self):
3146
2267
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
3147
2268
        loader = self._create_loader(test_list)
 
2269
 
3148
2270
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3149
2271
        self.assertEquals(test_list, _test_ids(suite))
3150
2272
 
3151
2273
    def test_exclude_tests(self):
3152
2274
        test_list = ['bogus']
3153
2275
        loader = self._create_loader(test_list)
 
2276
 
3154
2277
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3155
2278
        self.assertEquals([], _test_ids(suite))
3156
2279
 
3201
2324
        tpr.register('bar', 'bbb.aaa.rrr')
3202
2325
        tpr.register('bar', 'bBB.aAA.rRR')
3203
2326
        self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
3204
 
        self.assertThat(self.get_log(),
3205
 
            DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR", ELLIPSIS))
 
2327
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
2328
                              r'.*bar.*bbb.aaa.rrr.*bBB.aAA.rRR')
3206
2329
 
3207
2330
    def test_get_unknown_prefix(self):
3208
2331
        tpr = self._get_registry()
3228
2351
        self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
3229
2352
 
3230
2353
 
3231
 
class TestThreadLeakDetection(tests.TestCase):
3232
 
    """Ensure when tests leak threads we detect and report it"""
3233
 
 
3234
 
    class LeakRecordingResult(tests.ExtendedTestResult):
3235
 
        def __init__(self):
3236
 
            tests.ExtendedTestResult.__init__(self, StringIO(), 0, 1)
3237
 
            self.leaks = []
3238
 
        def _report_thread_leak(self, test, leaks, alive):
3239
 
            self.leaks.append((test, leaks))
3240
 
 
3241
 
    def test_testcase_without_addCleanups(self):
3242
 
        """Check old TestCase instances don't break with leak detection"""
3243
 
        class Test(unittest.TestCase):
3244
 
            def runTest(self):
3245
 
                pass
3246
 
            addCleanup = None # for when on Python 2.7 with native addCleanup
3247
 
        result = self.LeakRecordingResult()
3248
 
        test = Test()
3249
 
        self.assertIs(getattr(test, "addCleanup", None), None)
3250
 
        result.startTestRun()
3251
 
        test.run(result)
3252
 
        result.stopTestRun()
3253
 
        self.assertEqual(result._tests_leaking_threads_count, 0)
3254
 
        self.assertEqual(result.leaks, [])
3255
 
        
3256
 
    def test_thread_leak(self):
3257
 
        """Ensure a thread that outlives the running of a test is reported
3258
 
 
3259
 
        Uses a thread that blocks on an event, and is started by the inner
3260
 
        test case. As the thread outlives the inner case's run, it should be
3261
 
        detected as a leak, but the event is then set so that the thread can
3262
 
        be safely joined in cleanup so it's not leaked for real.
3263
 
        """
3264
 
        event = threading.Event()
3265
 
        thread = threading.Thread(name="Leaker", target=event.wait)
3266
 
        class Test(tests.TestCase):
3267
 
            def test_leak(self):
3268
 
                thread.start()
3269
 
        result = self.LeakRecordingResult()
3270
 
        test = Test("test_leak")
3271
 
        self.addCleanup(thread.join)
3272
 
        self.addCleanup(event.set)
3273
 
        result.startTestRun()
3274
 
        test.run(result)
3275
 
        result.stopTestRun()
3276
 
        self.assertEqual(result._tests_leaking_threads_count, 1)
3277
 
        self.assertEqual(result._first_thread_leaker_id, test.id())
3278
 
        self.assertEqual(result.leaks, [(test, set([thread]))])
3279
 
        self.assertContainsString(result.stream.getvalue(), "leaking threads")
3280
 
 
3281
 
    def test_multiple_leaks(self):
3282
 
        """Check multiple leaks are blamed on the test cases at fault
3283
 
 
3284
 
        Same concept as the previous test, but has one inner test method that
3285
 
        leaks two threads, and one that doesn't leak at all.
3286
 
        """
3287
 
        event = threading.Event()
3288
 
        thread_a = threading.Thread(name="LeakerA", target=event.wait)
3289
 
        thread_b = threading.Thread(name="LeakerB", target=event.wait)
3290
 
        thread_c = threading.Thread(name="LeakerC", target=event.wait)
3291
 
        class Test(tests.TestCase):
3292
 
            def test_first_leak(self):
3293
 
                thread_b.start()
3294
 
            def test_second_no_leak(self):
3295
 
                pass
3296
 
            def test_third_leak(self):
3297
 
                thread_c.start()
3298
 
                thread_a.start()
3299
 
        result = self.LeakRecordingResult()
3300
 
        first_test = Test("test_first_leak")
3301
 
        third_test = Test("test_third_leak")
3302
 
        self.addCleanup(thread_a.join)
3303
 
        self.addCleanup(thread_b.join)
3304
 
        self.addCleanup(thread_c.join)
3305
 
        self.addCleanup(event.set)
3306
 
        result.startTestRun()
3307
 
        unittest.TestSuite(
3308
 
            [first_test, Test("test_second_no_leak"), third_test]
3309
 
            ).run(result)
3310
 
        result.stopTestRun()
3311
 
        self.assertEqual(result._tests_leaking_threads_count, 2)
3312
 
        self.assertEqual(result._first_thread_leaker_id, first_test.id())
3313
 
        self.assertEqual(result.leaks, [
3314
 
            (first_test, set([thread_b])),
3315
 
            (third_test, set([thread_a, thread_c]))])
3316
 
        self.assertContainsString(result.stream.getvalue(), "leaking threads")
3317
 
 
3318
 
 
3319
2354
class TestRunSuite(tests.TestCase):
3320
2355
 
3321
2356
    def test_runner_class(self):
3331
2366
                return tests.ExtendedTestResult(self.stream, self.descriptions,
3332
2367
                                                self.verbosity)
3333
2368
        tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
3334
 
        self.assertLength(1, calls)
 
2369
        self.assertEqual(calls, [suite])
 
2370
 
 
2371
    def test_done(self):
 
2372
        """run_suite should call result.done()"""
 
2373
        self.calls = 0
 
2374
        def one_more_call(): self.calls += 1
 
2375
        def test_function():
 
2376
            pass
 
2377
        test = unittest.FunctionTestCase(test_function)
 
2378
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
2379
            def done(self): one_more_call()
 
2380
        class MyRunner(tests.TextTestRunner):
 
2381
            def run(self, test):
 
2382
                return InstrumentedTestResult(self.stream, self.descriptions,
 
2383
                                              self.verbosity)
 
2384
        tests.run_suite(test, runner_class=MyRunner, stream=StringIO())
 
2385
        self.assertEquals(1, self.calls)