~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Ian Clatworthy
  • Date: 2009-07-02 08:26:00 UTC
  • mto: (4527.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4529.
  • Revision ID: ian.clatworthy@canonical.com-20090702082600-qwb1evvvfa8ctnye
first draft of a 2.0 Upgrade Guide

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
22
import time
25
23
import unittest
26
24
import warnings
27
25
 
28
 
from testtools import MultiTestResult
29
 
from testtools.content_type import ContentType
30
 
from testtools.matchers import (
31
 
    DocTestMatches,
32
 
    Equals,
33
 
    )
34
 
import testtools.tests.helpers
35
 
 
36
26
import bzrlib
37
27
from bzrlib import (
38
28
    branchbuilder,
47
37
    repository,
48
38
    symbol_versioning,
49
39
    tests,
50
 
    transport,
51
40
    workingtree,
52
41
    )
53
42
from bzrlib.repofmt import (
54
 
    groupcompress_repo,
55
43
    pack_repo,
56
44
    weaverepo,
57
45
    )
61
49
    deprecated_method,
62
50
    )
63
51
from bzrlib.tests import (
64
 
    features,
65
 
    stub_sftp,
66
52
    test_lsprof,
67
 
    test_server,
68
53
    test_sftp_transport,
69
54
    TestUtil,
70
55
    )
71
56
from bzrlib.trace import note
72
 
from bzrlib.transport import memory
 
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):
140
120
            def get_test_permutations(self):
141
121
                return sample_permutation
142
122
        sample_permutation = [(1,2), (3,4)]
143
 
        from bzrlib.tests.per_transport import get_transport_test_permutations
 
123
        from bzrlib.tests.test_transport_implementations \
 
124
            import get_transport_test_permutations
144
125
        self.assertEqual(sample_permutation,
145
126
                         get_transport_test_permutations(MockModule()))
146
127
 
147
 
    def test_scenarios_include_all_modules(self):
 
128
    def test_scenarios_invlude_all_modules(self):
148
129
        # this checks that the scenario generator returns as many permutations
149
130
        # as there are in all the registered transport modules - we assume if
150
131
        # this matches its probably doing the right thing especially in
151
132
        # combination with the tests for setting the right classes below.
152
 
        from bzrlib.tests.per_transport import transport_test_permutations
 
133
        from bzrlib.tests.test_transport_implementations \
 
134
            import transport_test_permutations
153
135
        from bzrlib.transport import _get_transport_modules
154
136
        modules = _get_transport_modules()
155
137
        permutation_count = 0
167
149
        # This test used to know about all the possible transports and the
168
150
        # order they were returned but that seems overly brittle (mbp
169
151
        # 20060307)
170
 
        from bzrlib.tests.per_transport import transport_test_permutations
 
152
        from bzrlib.tests.test_transport_implementations \
 
153
            import transport_test_permutations
171
154
        scenarios = transport_test_permutations()
172
155
        # there are at least that many builtin transports
173
156
        self.assertTrue(len(scenarios) > 6)
184
167
    def test_scenarios(self):
185
168
        # check that constructor parameters are passed through to the adapted
186
169
        # test.
187
 
        from bzrlib.tests.per_branch import make_scenarios
 
170
        from bzrlib.tests.branch_implementations import make_scenarios
188
171
        server1 = "a"
189
172
        server2 = "b"
190
173
        formats = [("c", "C"), ("d", "D")]
209
192
    def test_scenarios(self):
210
193
        # check that constructor parameters are passed through to the adapted
211
194
        # test.
212
 
        from bzrlib.tests.per_bzrdir import make_scenarios
 
195
        from bzrlib.tests.bzrdir_implementations import make_scenarios
213
196
        vfs_factory = "v"
214
197
        server1 = "a"
215
198
        server2 = "b"
235
218
        from bzrlib.tests.per_repository import formats_to_scenarios
236
219
        formats = [("(c)", remote.RemoteRepositoryFormat()),
237
220
                   ("(d)", repository.format_registry.get(
238
 
                    'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
 
221
                        'Bazaar pack repository format 1 (needs bzr 0.92)\n'))]
239
222
        no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
240
223
            None)
241
224
        vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
242
225
            vfs_transport_factory="vfs")
243
226
        # no_vfs generate scenarios without vfs_transport_factory
244
 
        expected = [
 
227
        self.assertEqual([
245
228
            ('RemoteRepositoryFormat(c)',
246
229
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
247
230
              'repository_format': remote.RemoteRepositoryFormat(),
248
231
              'transport_readonly_server': 'readonly',
249
232
              'transport_server': 'server'}),
250
 
            ('RepositoryFormat2a(d)',
 
233
            ('RepositoryFormatKnitPack1(d)',
251
234
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
252
 
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
235
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
253
236
              'transport_readonly_server': 'readonly',
254
 
              'transport_server': 'server'})]
255
 
        self.assertEqual(expected, no_vfs_scenarios)
 
237
              'transport_server': 'server'})],
 
238
            no_vfs_scenarios)
256
239
        self.assertEqual([
257
240
            ('RemoteRepositoryFormat(c)',
258
241
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
260
243
              'transport_readonly_server': 'readonly',
261
244
              'transport_server': 'server',
262
245
              'vfs_transport_factory': 'vfs'}),
263
 
            ('RepositoryFormat2a(d)',
 
246
            ('RepositoryFormatKnitPack1(d)',
264
247
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
265
 
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
248
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
266
249
              'transport_readonly_server': 'readonly',
267
250
              'transport_server': 'server',
268
251
              'vfs_transport_factory': 'vfs'})],
310
293
    def test_scenarios(self):
311
294
        # check that constructor parameters are passed through to the adapted
312
295
        # test.
313
 
        from bzrlib.tests.per_interrepository import make_scenarios
 
296
        from bzrlib.tests.interrepository_implementations import \
 
297
            make_scenarios
314
298
        server1 = "a"
315
299
        server2 = "b"
316
 
        formats = [("C0", "C1", "C2"), ("D0", "D1", "D2")]
 
300
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
317
301
        scenarios = make_scenarios(server1, server2, formats)
318
302
        self.assertEqual([
319
 
            ('C0,str,str',
320
 
             {'repository_format': 'C1',
 
303
            ('str,str,str',
 
304
             {'interrepo_class': str,
 
305
              'repository_format': 'C1',
321
306
              'repository_format_to': 'C2',
322
307
              'transport_readonly_server': 'b',
323
308
              'transport_server': 'a'}),
324
 
            ('D0,str,str',
325
 
             {'repository_format': 'D1',
 
309
            ('int,str,str',
 
310
             {'interrepo_class': int,
 
311
              'repository_format': 'D1',
326
312
              'repository_format_to': 'D2',
327
313
              'transport_readonly_server': 'b',
328
314
              'transport_server': 'a'})],
334
320
    def test_scenarios(self):
335
321
        # check that constructor parameters are passed through to the adapted
336
322
        # test.
337
 
        from bzrlib.tests.per_workingtree import make_scenarios
 
323
        from bzrlib.tests.workingtree_implementations \
 
324
            import make_scenarios
338
325
        server1 = "a"
339
326
        server2 = "b"
340
327
        formats = [workingtree.WorkingTreeFormat2(),
364
351
        # workingtree_to_test_tree attribute set to 'return_parameter' and the
365
352
        # revision one set to revision_tree_from_workingtree.
366
353
 
367
 
        from bzrlib.tests.per_tree import (
 
354
        from bzrlib.tests.tree_implementations import (
368
355
            _dirstate_tree_from_workingtree,
369
356
            make_scenarios,
370
357
            preview_tree_pre,
446
433
        # unlike the TestProviderAdapter we dont want to automatically add a
447
434
        # parameterized one for WorkingTree - the optimisers will tell us what
448
435
        # ones to add.
449
 
        from bzrlib.tests.per_tree import (
 
436
        from bzrlib.tests.tree_implementations import (
450
437
            return_parameter,
451
438
            revision_tree_from_workingtree
452
439
            )
453
 
        from bzrlib.tests.per_intertree import (
 
440
        from bzrlib.tests.intertree_implementations import (
454
441
            make_scenarios,
455
442
            )
456
443
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
506
493
        self.assertEqualStat(real, fake)
507
494
 
508
495
    def test_assertEqualStat_notequal(self):
509
 
        self.build_tree(["foo", "longname"])
 
496
        self.build_tree(["foo", "bar"])
510
497
        self.assertRaises(AssertionError, self.assertEqualStat,
511
 
            os.lstat("foo"), os.lstat("longname"))
 
498
            os.lstat("foo"), os.lstat("bar"))
512
499
 
513
500
 
514
501
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
532
519
        cwd = osutils.getcwd()
533
520
        self.assertIsSameRealPath(self.test_dir, cwd)
534
521
 
535
 
    def test_BZR_HOME_and_HOME_are_bytestrings(self):
536
 
        """The $BZR_HOME and $HOME environment variables should not be unicode.
537
 
 
538
 
        See https://bugs.launchpad.net/bzr/+bug/464174
539
 
        """
540
 
        self.assertIsInstance(os.environ['BZR_HOME'], str)
541
 
        self.assertIsInstance(os.environ['HOME'], str)
542
 
 
543
522
    def test_make_branch_and_memory_tree(self):
544
523
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
545
524
 
601
580
                         self.get_transport().get_bytes(
602
581
                            'dir/.bzr/repository/format'))
603
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
 
604
596
    def test_dangling_locks_cause_failures(self):
605
597
        class TestDanglingLock(tests.TestCaseWithMemoryTransport):
606
598
            def test_function(self):
610
602
                l.attempt_lock()
611
603
        test = TestDanglingLock('test_function')
612
604
        result = test.run()
613
 
        if self._lock_check_thorough:
614
 
            self.assertEqual(1, len(result.errors))
615
 
        else:
616
 
            # When _lock_check_thorough is disabled, then we don't trigger a
617
 
            # failure
618
 
            self.assertEqual(0, len(result.errors))
 
605
        self.assertEqual(1, len(result.errors))
619
606
 
620
607
 
621
608
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
623
610
 
624
611
    def test_get_readonly_url_none(self):
625
612
        from bzrlib.transport import get_transport
 
613
        from bzrlib.transport.memory import MemoryServer
626
614
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
627
 
        self.vfs_transport_factory = memory.MemoryServer
 
615
        self.vfs_transport_factory = MemoryServer
628
616
        self.transport_readonly_server = None
629
617
        # calling get_readonly_transport() constructs a decorator on the url
630
618
        # for the server
639
627
    def test_get_readonly_url_http(self):
640
628
        from bzrlib.tests.http_server import HttpServer
641
629
        from bzrlib.transport import get_transport
 
630
        from bzrlib.transport.local import LocalURLServer
642
631
        from bzrlib.transport.http import HttpTransportBase
643
 
        self.transport_server = test_server.LocalURLServer
 
632
        self.transport_server = LocalURLServer
644
633
        self.transport_readonly_server = HttpServer
645
634
        # calling get_readonly_transport() gives us a HTTP server instance.
646
635
        url = self.get_readonly_url()
677
666
 
678
667
    def setUp(self):
679
668
        super(TestTestCaseTransports, self).setUp()
680
 
        self.vfs_transport_factory = memory.MemoryServer
 
669
        self.vfs_transport_factory = MemoryServer
681
670
 
682
671
    def test_make_bzrdir_preserves_transport(self):
683
672
        t = self.get_transport()
684
673
        result_bzrdir = self.make_bzrdir('subdir')
685
674
        self.assertIsInstance(result_bzrdir.transport,
686
 
                              memory.MemoryTransport)
 
675
                              MemoryTransport)
687
676
        # should not be on disk, should only be in memory
688
677
        self.failIfExists('subdir')
689
678
 
697
686
        self.assertEqual(url, t.clone('..').base)
698
687
 
699
688
 
700
 
class TestProfileResult(tests.TestCase):
701
 
 
702
 
    def test_profiles_tests(self):
703
 
        self.requireFeature(test_lsprof.LSProfFeature)
704
 
        terminal = testtools.tests.helpers.ExtendedTestResult()
705
 
        result = tests.ProfileResult(terminal)
706
 
        class Sample(tests.TestCase):
707
 
            def a(self):
708
 
                self.sample_function()
709
 
            def sample_function(self):
710
 
                pass
711
 
        test = Sample("a")
712
 
        test.run(result)
713
 
        case = terminal._events[0][1]
714
 
        self.assertLength(1, case._benchcalls)
715
 
        # We must be able to unpack it as the test reporting code wants
716
 
        (_, _, _), stats = case._benchcalls[0]
717
 
        self.assertTrue(callable(stats.pprint))
 
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))
718
710
 
719
711
 
720
712
class TestTestResult(tests.TestCase):
724
716
                descriptions=0,
725
717
                verbosity=1,
726
718
                )
727
 
        capture = testtools.tests.helpers.ExtendedTestResult()
728
 
        test_case.run(MultiTestResult(result, capture))
729
 
        run_case = capture._events[0][1]
730
 
        timed_string = result._testTimeString(run_case)
 
719
        test_case.run(result)
 
720
        timed_string = result._testTimeString(test_case)
731
721
        self.assertContainsRe(timed_string, expected_re)
732
722
 
733
723
    def test_test_reporting(self):
738
728
                self.time(time.sleep, 0.003)
739
729
        self.check_timing(ShortDelayTestCase('test_short_delay'),
740
730
                          r"^ +[0-9]+ms$")
741
 
        # if a benchmark time is given, we now show just that time followed by
742
 
        # a star
 
731
        # if a benchmark time is given, we want a x of y style result.
743
732
        self.check_timing(ShortDelayTestCase('test_short_benchmark'),
744
 
                          r"^ +[0-9]+ms\*$")
 
733
                          r"^ +[0-9]+ms/ +[0-9]+ms$")
745
734
 
746
735
    def test_unittest_reporting_unittest_class(self):
747
736
        # getting the time from a non-bzrlib test works ok
751
740
        self.check_timing(ShortDelayTestCase('test_short_delay'),
752
741
                          r"^ +[0-9]+ms$")
753
742
 
754
 
    def _patch_get_bzr_source_tree(self):
755
 
        # Reading from the actual source tree breaks isolation, but we don't
756
 
        # want to assume that thats *all* that would happen.
757
 
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree', lambda: None)
758
 
 
759
743
    def test_assigned_benchmark_file_stores_date(self):
760
 
        self._patch_get_bzr_source_tree()
761
744
        output = StringIO()
762
745
        result = bzrlib.tests.TextTestResult(self._log_file,
763
746
                                        descriptions=0,
771
754
        self.assertContainsRe(output_string, "--date [0-9.]+")
772
755
 
773
756
    def test_benchhistory_records_test_times(self):
774
 
        self._patch_get_bzr_source_tree()
775
757
        result_stream = StringIO()
776
758
        result = bzrlib.tests.TextTestResult(
777
759
            self._log_file,
839
821
    def test_known_failure(self):
840
822
        """A KnownFailure being raised should trigger several result actions."""
841
823
        class InstrumentedTestResult(tests.ExtendedTestResult):
842
 
            def stopTestRun(self): pass
 
824
            def done(self): pass
843
825
            def startTests(self): pass
844
826
            def report_test_start(self, test): pass
845
 
            def report_known_failure(self, test, err=None, details=None):
846
 
                self._call = test, 'known failure'
 
827
            def report_known_failure(self, test, err):
 
828
                self._call = test, err
847
829
        result = InstrumentedTestResult(None, None, None, None)
848
 
        class Test(tests.TestCase):
849
 
            def test_function(self):
850
 
                raise tests.KnownFailure('failed!')
851
 
        test = Test("test_function")
 
830
        def test_function():
 
831
            raise tests.KnownFailure('failed!')
 
832
        test = unittest.FunctionTestCase(test_function)
852
833
        test.run(result)
853
834
        # it should invoke 'report_known_failure'.
854
835
        self.assertEqual(2, len(result._call))
855
 
        self.assertEqual(test.id(), result._call[0].id())
856
 
        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)
857
839
        # we dont introspec the traceback, if the rest is ok, it would be
858
840
        # exceptional for it not to be.
859
841
        # it should update the known_failure_count on the object.
884
866
        self.assertEqual(lines[1], '    foo')
885
867
        self.assertEqual(2, len(lines))
886
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
 
887
904
    def get_passing_test(self):
888
905
        """Return a test object that can't be run usefully."""
889
906
        def passing_test():
893
910
    def test_add_not_supported(self):
894
911
        """Test the behaviour of invoking addNotSupported."""
895
912
        class InstrumentedTestResult(tests.ExtendedTestResult):
896
 
            def stopTestRun(self): pass
 
913
            def done(self): pass
897
914
            def startTests(self): pass
898
915
            def report_test_start(self, test): pass
899
916
            def report_unsupported(self, test, feature):
931
948
        result.report_unsupported(test, feature)
932
949
        output = result_stream.getvalue()[prefix:]
933
950
        lines = output.splitlines()
934
 
        # We don't check for the final '0ms' since it may fail on slow hosts
935
 
        self.assertStartsWith(lines[0], 'NODEP')
936
 
        self.assertEqual(lines[1],
937
 
                         "    The feature 'Feature' is not available.")
 
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:])
938
982
 
939
983
    def test_unavailable_exception(self):
940
984
        """An UnavailableFeature being raised should invoke addNotSupported."""
941
985
        class InstrumentedTestResult(tests.ExtendedTestResult):
942
 
            def stopTestRun(self): pass
 
986
            def done(self): pass
943
987
            def startTests(self): pass
944
988
            def report_test_start(self, test): pass
945
989
            def addNotSupported(self, test, feature):
946
990
                self._call = test, feature
947
991
        result = InstrumentedTestResult(None, None, None, None)
948
992
        feature = tests.Feature()
949
 
        class Test(tests.TestCase):
950
 
            def test_function(self):
951
 
                raise tests.UnavailableFeature(feature)
952
 
        test = Test("test_function")
 
993
        def test_function():
 
994
            raise tests.UnavailableFeature(feature)
 
995
        test = unittest.FunctionTestCase(test_function)
953
996
        test.run(result)
954
997
        # it should invoke 'addNotSupported'.
955
998
        self.assertEqual(2, len(result._call))
956
 
        self.assertEqual(test.id(), result._call[0].id())
 
999
        self.assertEqual(test, result._call[0])
957
1000
        self.assertEqual(feature, result._call[1])
958
1001
        # and not count as an error
959
1002
        self.assertEqual(0, result.error_count)
972
1015
                                             verbosity=1)
973
1016
        test = self.get_passing_test()
974
1017
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
975
 
        result.addExpectedFailure(test, err)
 
1018
        result._addKnownFailure(test, err)
976
1019
        self.assertFalse(result.wasStrictlySuccessful())
977
1020
        self.assertEqual(None, result._extractBenchmarkTime(test))
978
1021
 
1023
1066
        because of our use of global state.
1024
1067
        """
1025
1068
        old_root = tests.TestCaseInTempDir.TEST_ROOT
1026
 
        old_leak = tests.TestCase._first_thread_leaker_id
1027
1069
        try:
1028
1070
            tests.TestCaseInTempDir.TEST_ROOT = None
1029
 
            tests.TestCase._first_thread_leaker_id = None
1030
1071
            return testrunner.run(test)
1031
1072
        finally:
1032
1073
            tests.TestCaseInTempDir.TEST_ROOT = old_root
1033
 
            tests.TestCase._first_thread_leaker_id = old_leak
1034
1074
 
1035
1075
    def test_known_failure_failed_run(self):
1036
1076
        # run a test that generates a known failure which should be printed in
1037
1077
        # the final output when real failures occur.
1038
 
        class Test(tests.TestCase):
1039
 
            def known_failure_test(self):
1040
 
                self.expectFailure('failed', self.assertTrue, False)
 
1078
        def known_failure_test():
 
1079
            raise tests.KnownFailure('failed')
1041
1080
        test = unittest.TestSuite()
1042
 
        test.addTest(Test("known_failure_test"))
 
1081
        test.addTest(unittest.FunctionTestCase(known_failure_test))
1043
1082
        def failing_test():
1044
 
            self.fail('foo')
 
1083
            raise AssertionError('foo')
1045
1084
        test.addTest(unittest.FunctionTestCase(failing_test))
1046
1085
        stream = StringIO()
1047
1086
        runner = tests.TextTestRunner(stream=stream)
1048
1087
        result = self.run_test_runner(runner, test)
1049
1088
        lines = stream.getvalue().splitlines()
1050
 
        self.assertContainsRe(stream.getvalue(),
1051
 
            '(?sm)^bzr selftest.*$'
1052
 
            '.*'
1053
 
            '^======================================================================\n'
1054
 
            '^FAIL: failing_test\n'
1055
 
            '^----------------------------------------------------------------------\n'
1056
 
            'Traceback \\(most recent call last\\):\n'
1057
 
            '  .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
1058
 
            '    self.fail\\(\'foo\'\\)\n'
1059
 
            '.*'
1060
 
            '^----------------------------------------------------------------------\n'
1061
 
            '.*'
1062
 
            'FAILED \\(failures=1, known_failure_count=1\\)'
1063
 
            )
 
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:])
1064
1102
 
1065
1103
    def test_known_failure_ok_run(self):
1066
 
        # run a test that generates a known failure which should be printed in
1067
 
        # the final output.
1068
 
        class Test(tests.TestCase):
1069
 
            def known_failure_test(self):
1070
 
                self.expectFailure('failed', self.assertTrue, False)
1071
 
        test = Test("known_failure_test")
 
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)
1072
1108
        stream = StringIO()
1073
1109
        runner = tests.TextTestRunner(stream=stream)
1074
1110
        result = self.run_test_runner(runner, test)
1079
1115
            '\n'
1080
1116
            'OK \\(known_failures=1\\)\n')
1081
1117
 
1082
 
    def test_result_decorator(self):
1083
 
        # decorate results
1084
 
        calls = []
1085
 
        class LoggingDecorator(tests.ForwardingResult):
1086
 
            def startTest(self, test):
1087
 
                tests.ForwardingResult.startTest(self, test)
1088
 
                calls.append('start')
1089
 
        test = unittest.FunctionTestCase(lambda:None)
1090
 
        stream = StringIO()
1091
 
        runner = tests.TextTestRunner(stream=stream,
1092
 
            result_decorators=[LoggingDecorator])
1093
 
        result = self.run_test_runner(runner, test)
1094
 
        self.assertLength(1, calls)
1095
 
 
1096
1118
    def test_skipped_test(self):
1097
1119
        # run a test that is skipped, and check the suite as a whole still
1098
1120
        # succeeds.
1151
1173
 
1152
1174
    def test_not_applicable(self):
1153
1175
        # run a test that is skipped because it's not applicable
1154
 
        class Test(tests.TestCase):
1155
 
            def not_applicable_test(self):
1156
 
                raise tests.TestNotApplicable('this test never runs')
 
1176
        def not_applicable_test():
 
1177
            raise tests.TestNotApplicable('this test never runs')
1157
1178
        out = StringIO()
1158
1179
        runner = tests.TextTestRunner(stream=out, verbosity=2)
1159
 
        test = Test("not_applicable_test")
 
1180
        test = unittest.FunctionTestCase(not_applicable_test)
1160
1181
        result = self.run_test_runner(runner, test)
1161
1182
        self._log_file.write(out.getvalue())
1162
1183
        self.assertTrue(result.wasSuccessful())
1166
1187
        self.assertContainsRe(out.getvalue(),
1167
1188
                r'(?m)^    this test never runs')
1168
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
 
1169
1194
    def test_unsupported_features_listed(self):
1170
1195
        """When unsupported features are encountered they are detailed."""
1171
1196
        class Feature1(tests.Feature):
1191
1216
            ],
1192
1217
            lines[-3:])
1193
1218
 
1194
 
    def _patch_get_bzr_source_tree(self):
1195
 
        # Reading from the actual source tree breaks isolation, but we don't
1196
 
        # want to assume that thats *all* that would happen.
1197
 
        self._get_source_tree_calls = []
1198
 
        def new_get():
1199
 
            self._get_source_tree_calls.append("called")
1200
 
            return None
1201
 
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree',  new_get)
1202
 
 
1203
1219
    def test_bench_history(self):
1204
 
        # tests that the running the benchmark passes bench_history into
1205
 
        # the test result object. We can tell that happens if
1206
 
        # _get_bzr_source_tree is called.
1207
 
        self._patch_get_bzr_source_tree()
 
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()
1208
1224
        test = TestRunner('dummy_test')
1209
1225
        output = StringIO()
1210
1226
        runner = tests.TextTestRunner(stream=self._log_file,
1212
1228
        result = self.run_test_runner(runner, test)
1213
1229
        output_string = output.getvalue()
1214
1230
        self.assertContainsRe(output_string, "--date [0-9.]+")
1215
 
        self.assertLength(1, self._get_source_tree_calls)
1216
 
 
1217
 
    def test_startTestRun(self):
1218
 
        """run should call result.startTestRun()"""
1219
 
        calls = []
1220
 
        class LoggingDecorator(tests.ForwardingResult):
1221
 
            def startTestRun(self):
1222
 
                tests.ForwardingResult.startTestRun(self)
1223
 
                calls.append('startTestRun')
1224
 
        test = unittest.FunctionTestCase(lambda:None)
1225
 
        stream = StringIO()
1226
 
        runner = tests.TextTestRunner(stream=stream,
1227
 
            result_decorators=[LoggingDecorator])
1228
 
        result = self.run_test_runner(runner, test)
1229
 
        self.assertLength(1, calls)
1230
 
 
1231
 
    def test_stopTestRun(self):
1232
 
        """run should call result.stopTestRun()"""
1233
 
        calls = []
1234
 
        class LoggingDecorator(tests.ForwardingResult):
1235
 
            def stopTestRun(self):
1236
 
                tests.ForwardingResult.stopTestRun(self)
1237
 
                calls.append('stopTestRun')
1238
 
        test = unittest.FunctionTestCase(lambda:None)
1239
 
        stream = StringIO()
1240
 
        runner = tests.TextTestRunner(stream=stream,
1241
 
            result_decorators=[LoggingDecorator])
1242
 
        result = self.run_test_runner(runner, test)
1243
 
        self.assertLength(1, calls)
 
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)
1244
1347
 
1245
1348
 
1246
1349
class SampleTestCase(tests.TestCase):
1251
1354
class _TestException(Exception):
1252
1355
    pass
1253
1356
 
1254
 
 
1255
1357
class TestTestCase(tests.TestCase):
1256
1358
    """Tests that test the core bzrlib TestCase."""
1257
1359
 
1306
1408
        # we could set something and run a test that will check
1307
1409
        # it gets santised, but this is probably sufficient for now:
1308
1410
        # if someone runs the test with -Dsomething it will error.
1309
 
        flags = set()
1310
 
        if self._lock_check_thorough:
1311
 
            flags.add('strict_locks')
1312
 
        self.assertEqual(flags, bzrlib.debug.debug_flags)
 
1411
        self.assertEqual(set(), bzrlib.debug.debug_flags)
1313
1412
 
1314
1413
    def change_selftest_debug_flags(self, new_flags):
1315
 
        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
1316
1420
 
1317
1421
    def test_allow_debug_flag(self):
1318
1422
        """The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1325
1429
                self.flags = set(bzrlib.debug.debug_flags)
1326
1430
        test = TestThatRecordsFlags('test_foo')
1327
1431
        test.run(self.make_test_result())
1328
 
        flags = set(['a-flag'])
1329
 
        if 'disable_lock_checks' not in tests.selftest_debug_flags:
1330
 
            flags.add('strict_locks')
1331
 
        self.assertEqual(flags, self.flags)
1332
 
 
1333
 
    def test_disable_lock_checks(self):
1334
 
        """The -Edisable_lock_checks flag disables thorough checks."""
1335
 
        class TestThatRecordsFlags(tests.TestCase):
1336
 
            def test_foo(nested_self):
1337
 
                self.flags = set(bzrlib.debug.debug_flags)
1338
 
                self.test_lock_check_thorough = nested_self._lock_check_thorough
1339
 
        self.change_selftest_debug_flags(set())
1340
 
        test = TestThatRecordsFlags('test_foo')
1341
 
        test.run(self.make_test_result())
1342
 
        # By default we do strict lock checking and thorough lock/unlock
1343
 
        # tracking.
1344
 
        self.assertTrue(self.test_lock_check_thorough)
1345
 
        self.assertEqual(set(['strict_locks']), self.flags)
1346
 
        # Now set the disable_lock_checks flag, and show that this changed.
1347
 
        self.change_selftest_debug_flags(set(['disable_lock_checks']))
1348
 
        test = TestThatRecordsFlags('test_foo')
1349
 
        test.run(self.make_test_result())
1350
 
        self.assertFalse(self.test_lock_check_thorough)
1351
 
        self.assertEqual(set(), self.flags)
1352
 
 
1353
 
    def test_this_fails_strict_lock_check(self):
1354
 
        class TestThatRecordsFlags(tests.TestCase):
1355
 
            def test_foo(nested_self):
1356
 
                self.flags1 = set(bzrlib.debug.debug_flags)
1357
 
                self.thisFailsStrictLockCheck()
1358
 
                self.flags2 = set(bzrlib.debug.debug_flags)
1359
 
        # Make sure lock checking is active
1360
 
        self.change_selftest_debug_flags(set())
1361
 
        test = TestThatRecordsFlags('test_foo')
1362
 
        test.run(self.make_test_result())
1363
 
        self.assertEqual(set(['strict_locks']), self.flags1)
1364
 
        self.assertEqual(set(), self.flags2)
 
1432
        self.assertEqual(set(['a-flag']), self.flags)
1365
1433
 
1366
1434
    def test_debug_flags_restored(self):
1367
1435
        """The bzrlib debug flags should be restored to their original state
1378
1446
        self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1379
1447
 
1380
1448
    def make_test_result(self):
1381
 
        """Get a test result that writes to the test log file."""
1382
1449
        return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
1383
1450
 
1384
1451
    def inner_test(self):
1392
1459
        result = self.make_test_result()
1393
1460
        self.inner_test.run(result)
1394
1461
        note("outer finish")
1395
 
        self.addCleanup(osutils.delete_any, self._log_file_name)
1396
1462
 
1397
1463
    def test_trace_nesting(self):
1398
1464
        # this tests that each test case nests its trace facility correctly.
1424
1490
        result = bzrlib.tests.VerboseTestResult(
1425
1491
            unittest._WritelnDecorator(output_stream),
1426
1492
            descriptions=0,
1427
 
            verbosity=2)
 
1493
            verbosity=2,
 
1494
            num_tests=sample_test.countTestCases())
1428
1495
        sample_test.run(result)
1429
1496
        self.assertContainsRe(
1430
1497
            output_stream.getvalue(),
1431
 
            r"\d+ms\*\n$")
 
1498
            r"\d+ms/ +\d+ms\n$")
1432
1499
 
1433
1500
    def test_hooks_sanitised(self):
1434
1501
        """The bzrlib hooks should be sanitised by setUp."""
1458
1525
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1459
1526
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1460
1527
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1461
 
        del self._benchcalls[:]
1462
1528
 
1463
1529
    def test_knownFailure(self):
1464
1530
        """Self.knownFailure() should raise a KnownFailure exception."""
1465
1531
        self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
1466
1532
 
1467
 
    def test_open_bzrdir_safe_roots(self):
1468
 
        # even a memory transport should fail to open when its url isn't 
1469
 
        # permitted.
1470
 
        # Manually set one up (TestCase doesn't and shouldn't provide magic
1471
 
        # machinery)
1472
 
        transport_server = memory.MemoryServer()
1473
 
        transport_server.start_server()
1474
 
        self.addCleanup(transport_server.stop_server)
1475
 
        t = transport.get_transport(transport_server.get_url())
1476
 
        bzrdir.BzrDir.create(t.base)
1477
 
        self.assertRaises(errors.BzrError,
1478
 
            bzrdir.BzrDir.open_from_transport, t)
1479
 
        # But if we declare this as safe, we can open the bzrdir.
1480
 
        self.permit_url(t.base)
1481
 
        self._bzr_selftest_roots.append(t.base)
1482
 
        bzrdir.BzrDir.open_from_transport(t)
1483
 
 
1484
1533
    def test_requireFeature_available(self):
1485
1534
        """self.requireFeature(available) is a no-op."""
1486
1535
        class Available(tests.Feature):
1530
1579
        """Test disabled tests behaviour with support aware results."""
1531
1580
        test = SampleTestCase('_test_pass')
1532
1581
        class DisabledFeature(object):
1533
 
            def __eq__(self, other):
1534
 
                return isinstance(other, DisabledFeature)
1535
1582
            def available(self):
1536
1583
                return False
1537
1584
        the_feature = DisabledFeature()
1548
1595
                self.calls.append(('addNotSupported', test, feature))
1549
1596
        result = InstrumentedTestResult()
1550
1597
        test.run(result)
1551
 
        case = result.calls[0][1]
1552
1598
        self.assertEqual([
1553
 
            ('startTest', case),
1554
 
            ('addNotSupported', case, the_feature),
1555
 
            ('stopTest', case),
 
1599
            ('startTest', test),
 
1600
            ('addNotSupported', test, the_feature),
 
1601
            ('stopTest', test),
1556
1602
            ],
1557
1603
            result.calls)
1558
1604
 
1559
 
    def test_start_server_registers_url(self):
1560
 
        transport_server = memory.MemoryServer()
1561
 
        # A little strict, but unlikely to be changed soon.
1562
 
        self.assertEqual([], self._bzr_selftest_roots)
1563
 
        self.start_server(transport_server)
1564
 
        self.assertSubset([transport_server.get_url()],
1565
 
            self._bzr_selftest_roots)
1566
 
 
1567
1605
    def test_assert_list_raises_on_generator(self):
1568
1606
        def generator_which_will_raise():
1569
1607
            # This will not raise until after the first yield
1619
1657
        self.assertRaises(AssertionError,
1620
1658
            self.assertListRaises, _TestException, success_generator)
1621
1659
 
1622
 
    def test_overrideAttr_without_value(self):
1623
 
        self.test_attr = 'original' # Define a test attribute
1624
 
        obj = self # Make 'obj' visible to the embedded test
1625
 
        class Test(tests.TestCase):
1626
 
 
1627
 
            def setUp(self):
1628
 
                tests.TestCase.setUp(self)
1629
 
                self.orig = self.overrideAttr(obj, 'test_attr')
1630
 
 
1631
 
            def test_value(self):
1632
 
                self.assertEqual('original', self.orig)
1633
 
                self.assertEqual('original', obj.test_attr)
1634
 
                obj.test_attr = 'modified'
1635
 
                self.assertEqual('modified', obj.test_attr)
1636
 
 
1637
 
        test = Test('test_value')
1638
 
        test.run(unittest.TestResult())
1639
 
        self.assertEqual('original', obj.test_attr)
1640
 
 
1641
 
    def test_overrideAttr_with_value(self):
1642
 
        self.test_attr = 'original' # Define a test attribute
1643
 
        obj = self # Make 'obj' visible to the embedded test
1644
 
        class Test(tests.TestCase):
1645
 
 
1646
 
            def setUp(self):
1647
 
                tests.TestCase.setUp(self)
1648
 
                self.orig = self.overrideAttr(obj, 'test_attr', new='modified')
1649
 
 
1650
 
            def test_value(self):
1651
 
                self.assertEqual('original', self.orig)
1652
 
                self.assertEqual('modified', obj.test_attr)
1653
 
 
1654
 
        test = Test('test_value')
1655
 
        test.run(unittest.TestResult())
1656
 
        self.assertEqual('original', obj.test_attr)
1657
 
 
1658
1660
 
1659
1661
# NB: Don't delete this; it's not actually from 0.11!
1660
1662
@deprecated_function(deprecated_in((0, 11, 0)))
1689
1691
    def test_assert_isinstance(self):
1690
1692
        self.assertIsInstance(2, int)
1691
1693
        self.assertIsInstance(u'', basestring)
1692
 
        e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1693
 
        self.assertEquals(str(e),
1694
 
            "None is an instance of <type 'NoneType'> rather than <type 'int'>")
 
1694
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1695
1695
        self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1696
 
        e = self.assertRaises(AssertionError,
1697
 
            self.assertIsInstance, None, int, "it's just not")
1698
 
        self.assertEquals(str(e),
1699
 
            "None is an instance of <type 'NoneType'> rather than <type 'int'>"
1700
 
            ": it's just not")
1701
1696
 
1702
1697
    def test_assertEndsWith(self):
1703
1698
        self.assertEndsWith('foo', 'oo')
1704
1699
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1705
1700
 
1706
 
    def test_assertEqualDiff(self):
1707
 
        e = self.assertRaises(AssertionError,
1708
 
                              self.assertEqualDiff, '', '\n')
1709
 
        self.assertEquals(str(e),
1710
 
                          # Don't blink ! The '+' applies to the second string
1711
 
                          'first string is missing a final newline.\n+ \n')
1712
 
        e = self.assertRaises(AssertionError,
1713
 
                              self.assertEqualDiff, '\n', '')
1714
 
        self.assertEquals(str(e),
1715
 
                          # Don't blink ! The '-' applies to the second string
1716
 
                          'second string is missing a final newline.\n- \n')
1717
 
 
1718
 
 
1719
 
class TestDeprecations(tests.TestCase):
1720
 
 
1721
1701
    def test_applyDeprecated_not_deprecated(self):
1722
1702
        sample_object = ApplyDeprecatedHelper()
1723
1703
        # calling an undeprecated callable raises an assertion
1800
1780
        tree = self.make_branch_and_memory_tree('a')
1801
1781
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1802
1782
 
1803
 
    def test_make_tree_for_local_vfs_backed_transport(self):
1804
 
        # make_branch_and_tree has to use local branch and repositories
1805
 
        # when the vfs transport and local disk are colocated, even if
1806
 
        # a different transport is in use for url generation.
1807
 
        self.transport_server = test_server.FakeVFATServer
1808
 
        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
 
1809
1789
        tree = self.make_branch_and_tree('t1')
1810
1790
        base = tree.bzrdir.root_transport.base
1811
 
        self.assertStartsWith(base, 'file://')
 
1791
        self.failIf(base.startswith('sftp'),
 
1792
                'base %r is on sftp but should be local' % base)
1812
1793
        self.assertEquals(tree.bzrdir.root_transport,
1813
1794
                tree.branch.bzrdir.root_transport)
1814
1795
        self.assertEquals(tree.bzrdir.root_transport,
1815
1796
                tree.branch.repository.bzrdir.root_transport)
1816
1797
 
1817
1798
 
1818
 
class SelfTestHelper:
1819
 
 
1820
 
    def run_selftest(self, **kwargs):
1821
 
        """Run selftest returning its output."""
1822
 
        output = StringIO()
1823
 
        old_transport = bzrlib.tests.default_transport
1824
 
        old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
1825
 
        tests.TestCaseWithMemoryTransport.TEST_ROOT = None
1826
 
        try:
1827
 
            self.assertEqual(True, tests.selftest(stream=output, **kwargs))
1828
 
        finally:
1829
 
            bzrlib.tests.default_transport = old_transport
1830
 
            tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
1831
 
        output.seek(0)
1832
 
        return output
1833
 
 
1834
 
 
1835
 
class TestSelftest(tests.TestCase, SelfTestHelper):
 
1799
class TestSelftest(tests.TestCase):
1836
1800
    """Tests of bzrlib.tests.selftest."""
1837
1801
 
1838
1802
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1846
1810
            test_suite_factory=factory)
1847
1811
        self.assertEqual([True], factory_called)
1848
1812
 
1849
 
    def factory(self):
1850
 
        """A test suite factory."""
1851
 
        class Test(tests.TestCase):
1852
 
            def a(self):
1853
 
                pass
1854
 
            def b(self):
1855
 
                pass
1856
 
            def c(self):
1857
 
                pass
1858
 
        return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
1859
 
 
1860
 
    def test_list_only(self):
1861
 
        output = self.run_selftest(test_suite_factory=self.factory,
1862
 
            list_only=True)
1863
 
        self.assertEqual(3, len(output.readlines()))
1864
 
 
1865
 
    def test_list_only_filtered(self):
1866
 
        output = self.run_selftest(test_suite_factory=self.factory,
1867
 
            list_only=True, pattern="Test.b")
1868
 
        self.assertEndsWith(output.getvalue(), "Test.b\n")
1869
 
        self.assertLength(1, output.readlines())
1870
 
 
1871
 
    def test_list_only_excludes(self):
1872
 
        output = self.run_selftest(test_suite_factory=self.factory,
1873
 
            list_only=True, exclude_pattern="Test.b")
1874
 
        self.assertNotContainsRe("Test.b", output.getvalue())
1875
 
        self.assertLength(2, output.readlines())
1876
 
 
1877
 
    def test_lsprof_tests(self):
1878
 
        self.requireFeature(test_lsprof.LSProfFeature)
1879
 
        calls = []
1880
 
        class Test(object):
1881
 
            def __call__(test, result):
1882
 
                test.run(result)
1883
 
            def run(test, result):
1884
 
                self.assertIsInstance(result, tests.ForwardingResult)
1885
 
                calls.append("called")
1886
 
            def countTestCases(self):
1887
 
                return 1
1888
 
        self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
1889
 
        self.assertLength(1, calls)
1890
 
 
1891
 
    def test_random(self):
1892
 
        # test randomising by listing a number of tests.
1893
 
        output_123 = self.run_selftest(test_suite_factory=self.factory,
1894
 
            list_only=True, random_seed="123")
1895
 
        output_234 = self.run_selftest(test_suite_factory=self.factory,
1896
 
            list_only=True, random_seed="234")
1897
 
        self.assertNotEqual(output_123, output_234)
1898
 
        # "Randominzing test order..\n\n
1899
 
        self.assertLength(5, output_123.readlines())
1900
 
        self.assertLength(5, output_234.readlines())
1901
 
 
1902
 
    def test_random_reuse_is_same_order(self):
1903
 
        # test randomising by listing a number of tests.
1904
 
        expected = self.run_selftest(test_suite_factory=self.factory,
1905
 
            list_only=True, random_seed="123")
1906
 
        repeated = self.run_selftest(test_suite_factory=self.factory,
1907
 
            list_only=True, random_seed="123")
1908
 
        self.assertEqual(expected.getvalue(), repeated.getvalue())
1909
 
 
1910
 
    def test_runner_class(self):
1911
 
        self.requireFeature(features.subunit)
1912
 
        from subunit import ProtocolTestCase
1913
 
        stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
1914
 
            test_suite_factory=self.factory)
1915
 
        test = ProtocolTestCase(stream)
1916
 
        result = unittest.TestResult()
1917
 
        test.run(result)
1918
 
        self.assertEqual(3, result.testsRun)
1919
 
 
1920
 
    def test_starting_with_single_argument(self):
1921
 
        output = self.run_selftest(test_suite_factory=self.factory,
1922
 
            starting_with=['bzrlib.tests.test_selftest.Test.a'],
1923
 
            list_only=True)
1924
 
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
1925
 
            output.getvalue())
1926
 
 
1927
 
    def test_starting_with_multiple_argument(self):
1928
 
        output = self.run_selftest(test_suite_factory=self.factory,
1929
 
            starting_with=['bzrlib.tests.test_selftest.Test.a',
1930
 
                'bzrlib.tests.test_selftest.Test.b'],
1931
 
            list_only=True)
1932
 
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
1933
 
            'bzrlib.tests.test_selftest.Test.b\n',
1934
 
            output.getvalue())
1935
 
 
1936
 
    def check_transport_set(self, transport_server):
1937
 
        captured_transport = []
1938
 
        def seen_transport(a_transport):
1939
 
            captured_transport.append(a_transport)
1940
 
        class Capture(tests.TestCase):
1941
 
            def a(self):
1942
 
                seen_transport(bzrlib.tests.default_transport)
1943
 
        def factory():
1944
 
            return TestUtil.TestSuite([Capture("a")])
1945
 
        self.run_selftest(transport=transport_server, test_suite_factory=factory)
1946
 
        self.assertEqual(transport_server, captured_transport[0])
1947
 
 
1948
 
    def test_transport_sftp(self):
1949
 
        self.requireFeature(features.paramiko)
1950
 
        self.check_transport_set(stub_sftp.SFTPAbsoluteServer)
1951
 
 
1952
 
    def test_transport_memory(self):
1953
 
        self.check_transport_set(memory.MemoryServer)
1954
 
 
1955
 
 
1956
 
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
1957
 
    # Does IO: reads test.list
1958
 
 
1959
 
    def test_load_list(self):
1960
 
        # Provide a list with one test - this test.
1961
 
        test_id_line = '%s\n' % self.id()
1962
 
        self.build_tree_contents([('test.list', test_id_line)])
1963
 
        # And generate a list of the tests in  the suite.
1964
 
        stream = self.run_selftest(load_list='test.list', list_only=True)
1965
 
        self.assertEqual(test_id_line, stream.getvalue())
1966
 
 
1967
 
    def test_load_unknown(self):
1968
 
        # Provide a list with one test - this test.
1969
 
        # And generate a list of the tests in  the suite.
1970
 
        err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
1971
 
            load_list='missing file name', list_only=True)
1972
 
 
1973
 
 
1974
 
class TestRunBzr(tests.TestCase):
1975
 
 
1976
 
    out = ''
1977
 
    err = ''
1978
 
 
1979
 
    def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
1980
 
                         working_dir=None):
1981
 
        """Override _run_bzr_core to test how it is invoked by run_bzr.
1982
 
 
1983
 
        Attempts to run bzr from inside this class don't actually run it.
1984
 
 
1985
 
        We test how run_bzr actually invokes bzr in another location.  Here we
1986
 
        only need to test that it passes the right parameters to run_bzr.
1987
 
        """
1988
 
        self.argv = list(argv)
1989
 
        self.retcode = retcode
1990
 
        self.encoding = encoding
1991
 
        self.stdin = stdin
1992
 
        self.working_dir = working_dir
1993
 
        return self.retcode, self.out, self.err
1994
 
 
1995
 
    def test_run_bzr_error(self):
1996
 
        self.out = "It sure does!\n"
1997
 
        out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
1998
 
        self.assertEqual(['rocks'], self.argv)
1999
 
        self.assertEqual(34, self.retcode)
2000
 
        self.assertEqual('It sure does!\n', out)
2001
 
        self.assertEquals(out, self.out)
2002
 
        self.assertEqual('', err)
2003
 
        self.assertEquals(err, self.err)
2004
 
 
2005
 
    def test_run_bzr_error_regexes(self):
2006
 
        self.out = ''
2007
 
        self.err = "bzr: ERROR: foobarbaz is not versioned"
2008
 
        out, err = self.run_bzr_error(
2009
 
            ["bzr: ERROR: foobarbaz is not versioned"],
2010
 
            ['file-id', 'foobarbaz'])
2011
 
 
2012
 
    def test_encoding(self):
2013
 
        """Test that run_bzr passes encoding to _run_bzr_core"""
2014
 
        self.run_bzr('foo bar')
2015
 
        self.assertEqual(None, self.encoding)
2016
 
        self.assertEqual(['foo', 'bar'], self.argv)
2017
 
 
2018
 
        self.run_bzr('foo bar', encoding='baz')
2019
 
        self.assertEqual('baz', self.encoding)
2020
 
        self.assertEqual(['foo', 'bar'], self.argv)
2021
 
 
2022
 
    def test_retcode(self):
2023
 
        """Test that run_bzr passes retcode to _run_bzr_core"""
2024
 
        # Default is retcode == 0
2025
 
        self.run_bzr('foo bar')
2026
 
        self.assertEqual(0, self.retcode)
2027
 
        self.assertEqual(['foo', 'bar'], self.argv)
2028
 
 
2029
 
        self.run_bzr('foo bar', retcode=1)
2030
 
        self.assertEqual(1, self.retcode)
2031
 
        self.assertEqual(['foo', 'bar'], self.argv)
2032
 
 
2033
 
        self.run_bzr('foo bar', retcode=None)
2034
 
        self.assertEqual(None, self.retcode)
2035
 
        self.assertEqual(['foo', 'bar'], self.argv)
2036
 
 
2037
 
        self.run_bzr(['foo', 'bar'], retcode=3)
2038
 
        self.assertEqual(3, self.retcode)
2039
 
        self.assertEqual(['foo', 'bar'], self.argv)
2040
 
 
2041
 
    def test_stdin(self):
2042
 
        # test that the stdin keyword to run_bzr is passed through to
2043
 
        # _run_bzr_core as-is. We do this by overriding
2044
 
        # _run_bzr_core in this class, and then calling run_bzr,
2045
 
        # which is a convenience function for _run_bzr_core, so
2046
 
        # should invoke it.
2047
 
        self.run_bzr('foo bar', stdin='gam')
2048
 
        self.assertEqual('gam', self.stdin)
2049
 
        self.assertEqual(['foo', 'bar'], self.argv)
2050
 
 
2051
 
        self.run_bzr('foo bar', stdin='zippy')
2052
 
        self.assertEqual('zippy', self.stdin)
2053
 
        self.assertEqual(['foo', 'bar'], self.argv)
2054
 
 
2055
 
    def test_working_dir(self):
2056
 
        """Test that run_bzr passes working_dir to _run_bzr_core"""
2057
 
        self.run_bzr('foo bar')
2058
 
        self.assertEqual(None, self.working_dir)
2059
 
        self.assertEqual(['foo', 'bar'], self.argv)
2060
 
 
2061
 
        self.run_bzr('foo bar', working_dir='baz')
2062
 
        self.assertEqual('baz', self.working_dir)
2063
 
        self.assertEqual(['foo', 'bar'], self.argv)
2064
 
 
2065
 
    def test_reject_extra_keyword_arguments(self):
2066
 
        self.assertRaises(TypeError, self.run_bzr, "foo bar",
2067
 
                          error_regex=['error message'])
2068
 
 
2069
 
 
2070
 
class TestRunBzrCaptured(tests.TestCaseWithTransport):
2071
 
    # Does IO when testing the working_dir parameter.
2072
 
 
2073
 
    def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2074
 
                         a_callable=None, *args, **kwargs):
2075
 
        self.stdin = stdin
2076
 
        self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
2077
 
        self.factory = bzrlib.ui.ui_factory
2078
 
        self.working_dir = osutils.getcwd()
2079
 
        stdout.write('foo\n')
2080
 
        stderr.write('bar\n')
2081
 
        return 0
2082
 
 
2083
 
    def test_stdin(self):
2084
 
        # test that the stdin keyword to _run_bzr_core is passed through to
2085
 
        # apply_redirected as a StringIO. We do this by overriding
2086
 
        # apply_redirected in this class, and then calling _run_bzr_core,
2087
 
        # which calls apply_redirected.
2088
 
        self.run_bzr(['foo', 'bar'], stdin='gam')
2089
 
        self.assertEqual('gam', self.stdin.read())
2090
 
        self.assertTrue(self.stdin is self.factory_stdin)
2091
 
        self.run_bzr(['foo', 'bar'], stdin='zippy')
2092
 
        self.assertEqual('zippy', self.stdin.read())
2093
 
        self.assertTrue(self.stdin is self.factory_stdin)
2094
 
 
2095
 
    def test_ui_factory(self):
2096
 
        # each invocation of self.run_bzr should get its
2097
 
        # own UI factory, which is an instance of TestUIFactory,
2098
 
        # with stdin, stdout and stderr attached to the stdin,
2099
 
        # stdout and stderr of the invoked run_bzr
2100
 
        current_factory = bzrlib.ui.ui_factory
2101
 
        self.run_bzr(['foo'])
2102
 
        self.failIf(current_factory is self.factory)
2103
 
        self.assertNotEqual(sys.stdout, self.factory.stdout)
2104
 
        self.assertNotEqual(sys.stderr, self.factory.stderr)
2105
 
        self.assertEqual('foo\n', self.factory.stdout.getvalue())
2106
 
        self.assertEqual('bar\n', self.factory.stderr.getvalue())
2107
 
        self.assertIsInstance(self.factory, tests.TestUIFactory)
2108
 
 
2109
 
    def test_working_dir(self):
2110
 
        self.build_tree(['one/', 'two/'])
2111
 
        cwd = osutils.getcwd()
2112
 
 
2113
 
        # Default is to work in the current directory
2114
 
        self.run_bzr(['foo', 'bar'])
2115
 
        self.assertEqual(cwd, self.working_dir)
2116
 
 
2117
 
        self.run_bzr(['foo', 'bar'], working_dir=None)
2118
 
        self.assertEqual(cwd, self.working_dir)
2119
 
 
2120
 
        # The function should be run in the alternative directory
2121
 
        # but afterwards the current working dir shouldn't be changed
2122
 
        self.run_bzr(['foo', 'bar'], working_dir='one')
2123
 
        self.assertNotEqual(cwd, self.working_dir)
2124
 
        self.assertEndsWith(self.working_dir, 'one')
2125
 
        self.assertEqual(cwd, osutils.getcwd())
2126
 
 
2127
 
        self.run_bzr(['foo', 'bar'], working_dir='two')
2128
 
        self.assertNotEqual(cwd, self.working_dir)
2129
 
        self.assertEndsWith(self.working_dir, 'two')
2130
 
        self.assertEqual(cwd, osutils.getcwd())
2131
 
 
2132
 
 
2133
 
class StubProcess(object):
2134
 
    """A stub process for testing run_bzr_subprocess."""
2135
 
    
2136
 
    def __init__(self, out="", err="", retcode=0):
2137
 
        self.out = out
2138
 
        self.err = err
2139
 
        self.returncode = retcode
2140
 
 
2141
 
    def communicate(self):
2142
 
        return self.out, self.err
2143
 
 
2144
 
 
2145
 
class TestWithFakedStartBzrSubprocess(tests.TestCaseWithTransport):
2146
 
    """Base class for tests testing how we might run bzr."""
2147
 
 
2148
 
    def setUp(self):
2149
 
        tests.TestCaseWithTransport.setUp(self)
2150
 
        self.subprocess_calls = []
2151
 
 
2152
 
    def start_bzr_subprocess(self, process_args, env_changes=None,
2153
 
                             skip_if_plan_to_signal=False,
2154
 
                             working_dir=None,
2155
 
                             allow_plugins=False):
2156
 
        """capture what run_bzr_subprocess tries to do."""
2157
 
        self.subprocess_calls.append({'process_args':process_args,
2158
 
            'env_changes':env_changes,
2159
 
            'skip_if_plan_to_signal':skip_if_plan_to_signal,
2160
 
            'working_dir':working_dir, 'allow_plugins':allow_plugins})
2161
 
        return self.next_subprocess
2162
 
 
2163
 
 
2164
 
class TestRunBzrSubprocess(TestWithFakedStartBzrSubprocess):
2165
 
 
2166
 
    def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
2167
 
        """Run run_bzr_subprocess with args and kwargs using a stubbed process.
2168
 
 
2169
 
        Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
2170
 
        that will return static results. This assertion method populates those
2171
 
        results and also checks the arguments run_bzr_subprocess generates.
2172
 
        """
2173
 
        self.next_subprocess = process
2174
 
        try:
2175
 
            result = self.run_bzr_subprocess(*args, **kwargs)
2176
 
        except:
2177
 
            self.next_subprocess = None
2178
 
            for key, expected in expected_args.iteritems():
2179
 
                self.assertEqual(expected, self.subprocess_calls[-1][key])
2180
 
            raise
 
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])
2181
1832
        else:
2182
 
            self.next_subprocess = None
2183
 
            for key, expected in expected_args.iteritems():
2184
 
                self.assertEqual(expected, self.subprocess_calls[-1][key])
2185
 
            return result
2186
 
 
2187
 
    def test_run_bzr_subprocess(self):
2188
 
        """The run_bzr_helper_external command behaves nicely."""
2189
 
        self.assertRunBzrSubprocess({'process_args':['--version']},
2190
 
            StubProcess(), '--version')
2191
 
        self.assertRunBzrSubprocess({'process_args':['--version']},
2192
 
            StubProcess(), ['--version'])
2193
 
        # retcode=None disables retcode checking
2194
 
        result = self.assertRunBzrSubprocess({},
2195
 
            StubProcess(retcode=3), '--version', retcode=None)
2196
 
        result = self.assertRunBzrSubprocess({},
2197
 
            StubProcess(out="is free software"), '--version')
2198
 
        self.assertContainsRe(result[0], 'is free software')
2199
 
        # Running a subcommand that is missing errors
2200
 
        self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
2201
 
            {'process_args':['--versionn']}, StubProcess(retcode=3),
2202
 
            '--versionn')
2203
 
        # Unless it is told to expect the error from the subprocess
2204
 
        result = self.assertRunBzrSubprocess({},
2205
 
            StubProcess(retcode=3), '--versionn', retcode=3)
2206
 
        # Or to ignore retcode checking
2207
 
        result = self.assertRunBzrSubprocess({},
2208
 
            StubProcess(err="unknown command", retcode=3), '--versionn',
2209
 
            retcode=None)
2210
 
        self.assertContainsRe(result[1], 'unknown command')
2211
 
 
2212
 
    def test_env_change_passes_through(self):
2213
 
        self.assertRunBzrSubprocess(
2214
 
            {'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
2215
 
            StubProcess(), '',
2216
 
            env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
2217
 
 
2218
 
    def test_no_working_dir_passed_as_None(self):
2219
 
        self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
2220
 
 
2221
 
    def test_no_working_dir_passed_through(self):
2222
 
        self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
2223
 
            working_dir='dir')
2224
 
 
2225
 
    def test_run_bzr_subprocess_no_plugins(self):
2226
 
        self.assertRunBzrSubprocess({'allow_plugins': False},
2227
 
            StubProcess(), '')
2228
 
 
2229
 
    def test_allow_plugins(self):
2230
 
        self.assertRunBzrSubprocess({'allow_plugins': True},
2231
 
            StubProcess(), '', allow_plugins=True)
2232
 
 
2233
 
 
2234
 
class TestFinishBzrSubprocess(TestWithFakedStartBzrSubprocess):
2235
 
 
2236
 
    def test_finish_bzr_subprocess_with_error(self):
2237
 
        """finish_bzr_subprocess allows specification of the desired exit code.
2238
 
        """
2239
 
        process = StubProcess(err="unknown command", retcode=3)
2240
 
        result = self.finish_bzr_subprocess(process, retcode=3)
2241
 
        self.assertEqual('', result[0])
2242
 
        self.assertContainsRe(result[1], 'unknown command')
2243
 
 
2244
 
    def test_finish_bzr_subprocess_ignoring_retcode(self):
2245
 
        """finish_bzr_subprocess allows the exit code to be ignored."""
2246
 
        process = StubProcess(err="unknown command", retcode=3)
2247
 
        result = self.finish_bzr_subprocess(process, retcode=None)
2248
 
        self.assertEqual('', result[0])
2249
 
        self.assertContainsRe(result[1], 'unknown command')
2250
 
 
2251
 
    def test_finish_subprocess_with_unexpected_retcode(self):
2252
 
        """finish_bzr_subprocess raises self.failureException if the retcode is
2253
 
        not the expected one.
2254
 
        """
2255
 
        process = StubProcess(err="unknown command", retcode=3)
2256
 
        self.assertRaises(self.failureException, self.finish_bzr_subprocess,
2257
 
                          process)
2258
 
 
2259
 
 
2260
 
class _DontSpawnProcess(Exception):
2261
 
    """A simple exception which just allows us to skip unnecessary steps"""
2262
 
 
2263
 
 
2264
 
class TestStartBzrSubProcess(tests.TestCase):
2265
 
 
2266
 
    def check_popen_state(self):
2267
 
        """Replace to make assertions when popen is called."""
2268
 
 
2269
 
    def _popen(self, *args, **kwargs):
2270
 
        """Record the command that is run, so that we can ensure it is correct"""
2271
 
        self.check_popen_state()
2272
 
        self._popen_args = args
2273
 
        self._popen_kwargs = kwargs
2274
 
        raise _DontSpawnProcess()
2275
 
 
2276
 
    def test_run_bzr_subprocess_no_plugins(self):
2277
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
2278
 
        command = self._popen_args[0]
2279
 
        self.assertEqual(sys.executable, command[0])
2280
 
        self.assertEqual(self.get_bzr_path(), command[1])
2281
 
        self.assertEqual(['--no-plugins'], command[2:])
2282
 
 
2283
 
    def test_allow_plugins(self):
2284
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2285
 
            allow_plugins=True)
2286
 
        command = self._popen_args[0]
2287
 
        self.assertEqual([], command[2:])
2288
 
 
2289
 
    def test_set_env(self):
2290
 
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
2291
 
        # set in the child
2292
 
        def check_environment():
2293
 
            self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2294
 
        self.check_popen_state = check_environment
2295
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2296
 
            env_changes={'EXISTANT_ENV_VAR':'set variable'})
2297
 
        # not set in theparent
2298
 
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2299
 
 
2300
 
    def test_run_bzr_subprocess_env_del(self):
2301
 
        """run_bzr_subprocess can remove environment variables too."""
2302
 
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
2303
 
        def check_environment():
2304
 
            self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2305
 
        os.environ['EXISTANT_ENV_VAR'] = 'set variable'
2306
 
        self.check_popen_state = check_environment
2307
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2308
 
            env_changes={'EXISTANT_ENV_VAR':None})
2309
 
        # Still set in parent
2310
 
        self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2311
 
        del os.environ['EXISTANT_ENV_VAR']
2312
 
 
2313
 
    def test_env_del_missing(self):
2314
 
        self.failIf('NON_EXISTANT_ENV_VAR' in os.environ)
2315
 
        def check_environment():
2316
 
            self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2317
 
        self.check_popen_state = check_environment
2318
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2319
 
            env_changes={'NON_EXISTANT_ENV_VAR':None})
2320
 
 
2321
 
    def test_working_dir(self):
2322
 
        """Test that we can specify the working dir for the child"""
2323
 
        orig_getcwd = osutils.getcwd
2324
 
        orig_chdir = os.chdir
2325
 
        chdirs = []
2326
 
        def chdir(path):
2327
 
            chdirs.append(path)
2328
 
        os.chdir = chdir
2329
 
        try:
2330
 
            def getcwd():
2331
 
                return 'current'
2332
 
            osutils.getcwd = getcwd
2333
 
            try:
2334
 
                self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2335
 
                    working_dir='foo')
2336
 
            finally:
2337
 
                osutils.getcwd = orig_getcwd
2338
 
        finally:
2339
 
            os.chdir = orig_chdir
2340
 
        self.assertEqual(['foo', 'current'], chdirs)
2341
 
 
2342
 
 
2343
 
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
2344
 
    """Tests that really need to do things with an external bzr."""
2345
 
 
2346
 
    def test_start_and_stop_bzr_subprocess_send_signal(self):
2347
 
        """finish_bzr_subprocess raises self.failureException if the retcode is
2348
 
        not the expected one.
2349
 
        """
2350
 
        self.disable_missing_extensions_warning()
2351
 
        process = self.start_bzr_subprocess(['wait-until-signalled'],
2352
 
                                            skip_if_plan_to_signal=True)
2353
 
        self.assertEqual('running\n', process.stdout.readline())
2354
 
        result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
2355
 
                                            retcode=3)
2356
 
        self.assertEqual('', result[0])
2357
 
        self.assertEqual('bzr: interrupted\n', result[1])
 
1833
            self.fail('Assertion not raised')
2358
1834
 
2359
1835
 
2360
1836
class TestFeature(tests.TestCase):
2398
1874
        self.assertIs(feature, exception.args[0])
2399
1875
 
2400
1876
 
2401
 
simple_thunk_feature = tests._CompatabilityThunkFeature(
2402
 
    deprecated_in((2, 1, 0)),
2403
 
    'bzrlib.tests.test_selftest',
2404
 
    'simple_thunk_feature','UnicodeFilename',
2405
 
    replacement_module='bzrlib.tests'
2406
 
    )
2407
 
 
2408
 
class Test_CompatibilityFeature(tests.TestCase):
2409
 
 
2410
 
    def test_does_thunk(self):
2411
 
        res = self.callDeprecated(
2412
 
            ['bzrlib.tests.test_selftest.simple_thunk_feature was deprecated'
2413
 
             ' in version 2.1.0. Use bzrlib.tests.UnicodeFilename instead.'],
2414
 
            simple_thunk_feature.available)
2415
 
        self.assertEqual(tests.UnicodeFilename.available(), res)
2416
 
 
2417
 
 
2418
 
class TestModuleAvailableFeature(tests.TestCase):
2419
 
 
2420
 
    def test_available_module(self):
2421
 
        feature = tests.ModuleAvailableFeature('bzrlib.tests')
2422
 
        self.assertEqual('bzrlib.tests', feature.module_name)
2423
 
        self.assertEqual('bzrlib.tests', str(feature))
2424
 
        self.assertTrue(feature.available())
2425
 
        self.assertIs(tests, feature.module)
2426
 
 
2427
 
    def test_unavailable_module(self):
2428
 
        feature = tests.ModuleAvailableFeature('bzrlib.no_such_module_exists')
2429
 
        self.assertEqual('bzrlib.no_such_module_exists', str(feature))
2430
 
        self.assertFalse(feature.available())
2431
 
        self.assertIs(None, feature.module)
2432
 
 
2433
 
 
2434
1877
class TestSelftestFiltering(tests.TestCase):
2435
1878
 
2436
1879
    def setUp(self):
2437
1880
        tests.TestCase.setUp(self)
2438
1881
        self.suite = TestUtil.TestSuite()
2439
1882
        self.loader = TestUtil.TestLoader()
2440
 
        self.suite.addTest(self.loader.loadTestsFromModule(
2441
 
            sys.modules['bzrlib.tests.test_selftest']))
 
1883
        self.suite.addTest(self.loader.loadTestsFromModuleNames([
 
1884
            'bzrlib.tests.test_selftest']))
2442
1885
        self.all_names = _test_ids(self.suite)
2443
1886
 
2444
1887
    def test_condition_id_re(self):
2615
2058
        # the test framework
2616
2059
        self.assertEquals('always fails', str(e))
2617
2060
        # check that there's no traceback in the test log
2618
 
        self.assertNotContainsRe(self.get_log(), r'Traceback')
 
2061
        self.assertNotContainsRe(self._get_log(keep_log_file=True),
 
2062
            r'Traceback')
2619
2063
 
2620
2064
    def test_run_bzr_user_error_caught(self):
2621
2065
        # Running bzr in blackbox mode, normal/expected/user errors should be
2622
2066
        # caught in the regular way and turned into an error message plus exit
2623
2067
        # code.
2624
 
        transport_server = memory.MemoryServer()
2625
 
        transport_server.start_server()
2626
 
        self.addCleanup(transport_server.stop_server)
2627
 
        url = transport_server.get_url()
2628
 
        self.permit_url(url)
2629
 
        out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
 
2068
        out, err = self.run_bzr(["log", "/nonexistantpath"], retcode=3)
2630
2069
        self.assertEqual(out, '')
2631
2070
        self.assertContainsRe(err,
2632
2071
            'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
2731
2170
        self.assertTrue(id_list.refers_to('mod.class'))
2732
2171
        self.assertTrue(id_list.refers_to('mod.class.meth'))
2733
2172
 
 
2173
    def test_test_suite(self):
 
2174
        # This test is slow, so we do a single test with one test in each
 
2175
        # category
 
2176
        test_list = [
 
2177
            # testmod_names
 
2178
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
 
2179
            'bzrlib.tests.test_selftest.TestTestIdList.test_test_suite',
 
2180
            # transport implementations
 
2181
            'bzrlib.tests.test_transport_implementations.TransportTests'
 
2182
            '.test_abspath(LocalURLServer)',
 
2183
            # modules_to_doctest
 
2184
            'bzrlib.timestamp.format_highres_date',
 
2185
            # plugins can't be tested that way since selftest may be run with
 
2186
            # --no-plugins
 
2187
            ]
 
2188
        suite = tests.test_suite(test_list)
 
2189
        self.assertEquals(test_list, _test_ids(suite))
 
2190
 
2734
2191
    def test_test_suite_matches_id_list_with_unknown(self):
2735
2192
        loader = TestUtil.TestLoader()
2736
2193
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2756
2213
                          duplicates)
2757
2214
 
2758
2215
 
2759
 
class TestTestSuite(tests.TestCase):
2760
 
 
2761
 
    def test__test_suite_testmod_names(self):
2762
 
        # Test that a plausible list of test module names are returned
2763
 
        # by _test_suite_testmod_names.
2764
 
        test_list = tests._test_suite_testmod_names()
2765
 
        self.assertSubset([
2766
 
            'bzrlib.tests.blackbox',
2767
 
            'bzrlib.tests.per_transport',
2768
 
            'bzrlib.tests.test_selftest',
2769
 
            ],
2770
 
            test_list)
2771
 
 
2772
 
    def test__test_suite_modules_to_doctest(self):
2773
 
        # Test that a plausible list of modules to doctest is returned
2774
 
        # by _test_suite_modules_to_doctest.
2775
 
        test_list = tests._test_suite_modules_to_doctest()
2776
 
        self.assertSubset([
2777
 
            'bzrlib.timestamp',
2778
 
            ],
2779
 
            test_list)
2780
 
 
2781
 
    def test_test_suite(self):
2782
 
        # test_suite() loads the entire test suite to operate. To avoid this
2783
 
        # overhead, and yet still be confident that things are happening,
2784
 
        # we temporarily replace two functions used by test_suite with 
2785
 
        # test doubles that supply a few sample tests to load, and check they
2786
 
        # are loaded.
2787
 
        calls = []
2788
 
        def testmod_names():
2789
 
            calls.append("testmod_names")
2790
 
            return [
2791
 
                'bzrlib.tests.blackbox.test_branch',
2792
 
                'bzrlib.tests.per_transport',
2793
 
                'bzrlib.tests.test_selftest',
2794
 
                ]
2795
 
        self.overrideAttr(tests, '_test_suite_testmod_names', testmod_names)
2796
 
        def doctests():
2797
 
            calls.append("modules_to_doctest")
2798
 
            return ['bzrlib.timestamp']
2799
 
        self.overrideAttr(tests, '_test_suite_modules_to_doctest', doctests)
2800
 
        expected_test_list = [
2801
 
            # testmod_names
2802
 
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
2803
 
            ('bzrlib.tests.per_transport.TransportTests'
2804
 
             '.test_abspath(LocalTransport,LocalURLServer)'),
2805
 
            'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
2806
 
            # modules_to_doctest
2807
 
            'bzrlib.timestamp.format_highres_date',
2808
 
            # plugins can't be tested that way since selftest may be run with
2809
 
            # --no-plugins
2810
 
            ]
2811
 
        suite = tests.test_suite()
2812
 
        self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
2813
 
            set(calls))
2814
 
        self.assertSubset(expected_test_list, _test_ids(suite))
2815
 
 
2816
 
    def test_test_suite_list_and_start(self):
2817
 
        # We cannot test this at the same time as the main load, because we want
2818
 
        # to know that starting_with == None works. So a second load is
2819
 
        # incurred - note that the starting_with parameter causes a partial load
2820
 
        # rather than a full load so this test should be pretty quick.
2821
 
        test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
2822
 
        suite = tests.test_suite(test_list,
2823
 
                                 ['bzrlib.tests.test_selftest.TestTestSuite'])
2824
 
        # test_test_suite_list_and_start is not included 
2825
 
        self.assertEquals(test_list, _test_ids(suite))
2826
 
 
2827
 
 
2828
2216
class TestLoadTestIdList(tests.TestCaseInTempDir):
2829
2217
 
2830
2218
    def _create_test_list_file(self, file_name, content):
2868
2256
    def test_load_tests(self):
2869
2257
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
2870
2258
        loader = self._create_loader(test_list)
 
2259
 
2871
2260
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2872
2261
        self.assertEquals(test_list, _test_ids(suite))
2873
2262
 
2874
2263
    def test_exclude_tests(self):
2875
2264
        test_list = ['bogus']
2876
2265
        loader = self._create_loader(test_list)
 
2266
 
2877
2267
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2878
2268
        self.assertEquals([], _test_ids(suite))
2879
2269
 
2924
2314
        tpr.register('bar', 'bbb.aaa.rrr')
2925
2315
        tpr.register('bar', 'bBB.aAA.rRR')
2926
2316
        self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
2927
 
        self.assertThat(self.get_log(),
2928
 
            DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR", ELLIPSIS))
 
2317
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
2318
                              r'.*bar.*bbb.aaa.rrr.*bBB.aAA.rRR')
2929
2319
 
2930
2320
    def test_get_unknown_prefix(self):
2931
2321
        tpr = self._get_registry()
2966
2356
                return tests.ExtendedTestResult(self.stream, self.descriptions,
2967
2357
                                                self.verbosity)
2968
2358
        tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
2969
 
        self.assertLength(1, calls)
 
2359
        self.assertEqual(calls, [suite])
 
2360
 
 
2361
    def test_done(self):
 
2362
        """run_suite should call result.done()"""
 
2363
        self.calls = 0
 
2364
        def one_more_call(): self.calls += 1
 
2365
        def test_function():
 
2366
            pass
 
2367
        test = unittest.FunctionTestCase(test_function)
 
2368
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
2369
            def done(self): one_more_call()
 
2370
        class MyRunner(tests.TextTestRunner):
 
2371
            def run(self, test):
 
2372
                return InstrumentedTestResult(self.stream, self.descriptions,
 
2373
                                              self.verbosity)
 
2374
        tests.run_suite(test, runner_class=MyRunner, stream=StringIO())
 
2375
        self.assertEquals(1, self.calls)