/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Jelmer Vernooij
  • Date: 2011-10-24 19:21:00 UTC
  • mto: This revision was merged to the branch mainline in revision 6232.
  • Revision ID: jelmer@samba.org-20111024192100-tirpujp3ycs1btmh
s/importance/necessity

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
"""Tests for the test framework."""
18
18
 
19
19
from cStringIO import StringIO
20
 
from doctest import ELLIPSIS
 
20
import gc
 
21
import doctest
21
22
import os
22
23
import signal
23
24
import sys
 
25
import threading
24
26
import time
25
27
import unittest
26
28
import warnings
27
29
 
28
 
from testtools import MultiTestResult
 
30
from testtools import (
 
31
    ExtendedToOriginalDecorator,
 
32
    MultiTestResult,
 
33
    __version__ as testtools_version,
 
34
    )
 
35
from testtools.content import Content
29
36
from testtools.content_type import ContentType
30
37
from testtools.matchers import (
31
38
    DocTestMatches,
32
39
    Equals,
33
40
    )
34
 
import testtools.tests.helpers
 
41
import testtools.testresult.doubles
35
42
 
36
43
import bzrlib
37
44
from bzrlib import (
38
45
    branchbuilder,
39
46
    bzrdir,
40
 
    debug,
41
47
    errors,
 
48
    hooks,
42
49
    lockdir,
43
50
    memorytree,
44
51
    osutils,
45
 
    progress,
46
52
    remote,
47
53
    repository,
48
54
    symbol_versioning,
49
55
    tests,
50
56
    transport,
51
57
    workingtree,
 
58
    workingtree_3,
 
59
    workingtree_4,
52
60
    )
53
61
from bzrlib.repofmt import (
54
62
    groupcompress_repo,
55
 
    pack_repo,
56
 
    weaverepo,
57
63
    )
58
64
from bzrlib.symbol_versioning import (
59
65
    deprecated_function,
64
70
    features,
65
71
    test_lsprof,
66
72
    test_server,
67
 
    test_sftp_transport,
68
73
    TestUtil,
69
74
    )
70
 
from bzrlib.trace import note
 
75
from bzrlib.trace import note, mutter
71
76
from bzrlib.transport import memory
72
 
from bzrlib.version import _get_bzr_source_tree
73
77
 
74
78
 
75
79
def _test_ids(test_suite):
77
81
    return [t.id() for t in tests.iter_suite_tests(test_suite)]
78
82
 
79
83
 
80
 
class SelftestTests(tests.TestCase):
81
 
 
82
 
    def test_import_tests(self):
83
 
        mod = TestUtil._load_module_by_name('bzrlib.tests.test_selftest')
84
 
        self.assertEqual(mod.SelftestTests, SelftestTests)
85
 
 
86
 
    def test_import_test_failure(self):
87
 
        self.assertRaises(ImportError,
88
 
                          TestUtil._load_module_by_name,
89
 
                          'bzrlib.no-name-yet')
90
 
 
91
 
 
92
84
class MetaTestLog(tests.TestCase):
93
85
 
94
86
    def test_logging(self):
100
92
            "text", "plain", {"charset": "utf8"})))
101
93
        self.assertThat(u"".join(log.iter_text()), Equals(self.get_log()))
102
94
        self.assertThat(self.get_log(),
103
 
            DocTestMatches(u"...a test message\n", ELLIPSIS))
104
 
 
105
 
 
106
 
class TestUnicodeFilename(tests.TestCase):
107
 
 
108
 
    def test_probe_passes(self):
109
 
        """UnicodeFilename._probe passes."""
110
 
        # We can't test much more than that because the behaviour depends
111
 
        # on the platform.
112
 
        tests.UnicodeFilename._probe()
 
95
            DocTestMatches(u"...a test message\n", doctest.ELLIPSIS))
113
96
 
114
97
 
115
98
class TestTreeShape(tests.TestCaseInTempDir):
116
99
 
117
100
    def test_unicode_paths(self):
118
 
        self.requireFeature(tests.UnicodeFilename)
 
101
        self.requireFeature(features.UnicodeFilenameFeature)
119
102
 
120
103
        filename = u'hell\u00d8'
121
104
        self.build_tree_contents([(filename, 'contents of hello')])
122
 
        self.failUnlessExists(filename)
 
105
        self.assertPathExists(filename)
 
106
 
 
107
 
 
108
class TestClassesAvailable(tests.TestCase):
 
109
    """As a convenience we expose Test* classes from bzrlib.tests"""
 
110
 
 
111
    def test_test_case(self):
 
112
        from bzrlib.tests import TestCase
 
113
 
 
114
    def test_test_loader(self):
 
115
        from bzrlib.tests import TestLoader
 
116
 
 
117
    def test_test_suite(self):
 
118
        from bzrlib.tests import TestSuite
123
119
 
124
120
 
125
121
class TestTransportScenarios(tests.TestCase):
208
204
    def test_scenarios(self):
209
205
        # check that constructor parameters are passed through to the adapted
210
206
        # test.
211
 
        from bzrlib.tests.per_bzrdir import make_scenarios
 
207
        from bzrlib.tests.per_controldir import make_scenarios
212
208
        vfs_factory = "v"
213
209
        server1 = "a"
214
210
        server2 = "b"
312
308
        from bzrlib.tests.per_interrepository import make_scenarios
313
309
        server1 = "a"
314
310
        server2 = "b"
315
 
        formats = [("C0", "C1", "C2"), ("D0", "D1", "D2")]
 
311
        formats = [("C0", "C1", "C2", "C3"), ("D0", "D1", "D2", "D3")]
316
312
        scenarios = make_scenarios(server1, server2, formats)
317
313
        self.assertEqual([
318
314
            ('C0,str,str',
319
315
             {'repository_format': 'C1',
320
316
              'repository_format_to': 'C2',
321
317
              'transport_readonly_server': 'b',
322
 
              'transport_server': 'a'}),
 
318
              'transport_server': 'a',
 
319
              'extra_setup': 'C3'}),
323
320
            ('D0,str,str',
324
321
             {'repository_format': 'D1',
325
322
              'repository_format_to': 'D2',
326
323
              'transport_readonly_server': 'b',
327
 
              'transport_server': 'a'})],
 
324
              'transport_server': 'a',
 
325
              'extra_setup': 'D3'})],
328
326
            scenarios)
329
327
 
330
328
 
336
334
        from bzrlib.tests.per_workingtree import make_scenarios
337
335
        server1 = "a"
338
336
        server2 = "b"
339
 
        formats = [workingtree.WorkingTreeFormat2(),
340
 
                   workingtree.WorkingTreeFormat3(),]
 
337
        formats = [workingtree_4.WorkingTreeFormat4(),
 
338
                   workingtree_3.WorkingTreeFormat3(),]
341
339
        scenarios = make_scenarios(server1, server2, formats)
342
340
        self.assertEqual([
343
 
            ('WorkingTreeFormat2',
 
341
            ('WorkingTreeFormat4',
344
342
             {'bzrdir_format': formats[0]._matchingbzrdir,
345
343
              'transport_readonly_server': 'b',
346
344
              'transport_server': 'a',
373
371
            )
374
372
        server1 = "a"
375
373
        server2 = "b"
376
 
        formats = [workingtree.WorkingTreeFormat2(),
377
 
                   workingtree.WorkingTreeFormat3(),]
 
374
        formats = [workingtree_4.WorkingTreeFormat4(),
 
375
                   workingtree_3.WorkingTreeFormat3(),]
378
376
        scenarios = make_scenarios(server1, server2, formats)
379
377
        self.assertEqual(7, len(scenarios))
380
 
        default_wt_format = workingtree.WorkingTreeFormat4._default_format
381
 
        wt4_format = workingtree.WorkingTreeFormat4()
382
 
        wt5_format = workingtree.WorkingTreeFormat5()
 
378
        default_wt_format = workingtree.format_registry.get_default()
 
379
        wt4_format = workingtree_4.WorkingTreeFormat4()
 
380
        wt5_format = workingtree_4.WorkingTreeFormat5()
383
381
        expected_scenarios = [
384
 
            ('WorkingTreeFormat2',
 
382
            ('WorkingTreeFormat4',
385
383
             {'bzrdir_format': formats[0]._matchingbzrdir,
386
384
              'transport_readonly_server': 'b',
387
385
              'transport_server': 'a',
447
445
        # ones to add.
448
446
        from bzrlib.tests.per_tree import (
449
447
            return_parameter,
450
 
            revision_tree_from_workingtree
451
448
            )
452
449
        from bzrlib.tests.per_intertree import (
453
450
            make_scenarios,
454
451
            )
455
 
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
 
452
        from bzrlib.workingtree_3 import WorkingTreeFormat3
 
453
        from bzrlib.workingtree_4 import WorkingTreeFormat4
456
454
        input_test = TestInterTreeScenarios(
457
455
            "test_scenarios")
458
456
        server1 = "a"
459
457
        server2 = "b"
460
 
        format1 = WorkingTreeFormat2()
 
458
        format1 = WorkingTreeFormat4()
461
459
        format2 = WorkingTreeFormat3()
462
460
        formats = [("1", str, format1, format2, "converter1"),
463
461
            ("2", int, format2, format1, "converter2")]
509
507
        self.assertRaises(AssertionError, self.assertEqualStat,
510
508
            os.lstat("foo"), os.lstat("longname"))
511
509
 
 
510
    def test_failUnlessExists(self):
 
511
        """Deprecated failUnlessExists and failIfExists"""
 
512
        self.applyDeprecated(
 
513
            deprecated_in((2, 4)),
 
514
            self.failUnlessExists, '.')
 
515
        self.build_tree(['foo/', 'foo/bar'])
 
516
        self.applyDeprecated(
 
517
            deprecated_in((2, 4)),
 
518
            self.failUnlessExists, 'foo/bar')
 
519
        self.applyDeprecated(
 
520
            deprecated_in((2, 4)),
 
521
            self.failIfExists, 'foo/foo')
 
522
 
 
523
    def test_assertPathExists(self):
 
524
        self.assertPathExists('.')
 
525
        self.build_tree(['foo/', 'foo/bar'])
 
526
        self.assertPathExists('foo/bar')
 
527
        self.assertPathDoesNotExist('foo/foo')
 
528
 
512
529
 
513
530
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
514
531
 
548
565
        tree = self.make_branch_and_memory_tree('dir')
549
566
        # Guard against regression into MemoryTransport leaking
550
567
        # files to disk instead of keeping them in memory.
551
 
        self.failIf(osutils.lexists('dir'))
 
568
        self.assertFalse(osutils.lexists('dir'))
552
569
        self.assertIsInstance(tree, memorytree.MemoryTree)
553
570
 
554
571
    def test_make_branch_and_memory_tree_with_format(self):
555
572
        """make_branch_and_memory_tree should accept a format option."""
556
573
        format = bzrdir.BzrDirMetaFormat1()
557
 
        format.repository_format = weaverepo.RepositoryFormat7()
 
574
        format.repository_format = repository.format_registry.get_default()
558
575
        tree = self.make_branch_and_memory_tree('dir', format=format)
559
576
        # Guard against regression into MemoryTransport leaking
560
577
        # files to disk instead of keeping them in memory.
561
 
        self.failIf(osutils.lexists('dir'))
 
578
        self.assertFalse(osutils.lexists('dir'))
562
579
        self.assertIsInstance(tree, memorytree.MemoryTree)
563
580
        self.assertEqual(format.repository_format.__class__,
564
581
            tree.branch.repository._format.__class__)
568
585
        self.assertIsInstance(builder, branchbuilder.BranchBuilder)
569
586
        # Guard against regression into MemoryTransport leaking
570
587
        # files to disk instead of keeping them in memory.
571
 
        self.failIf(osutils.lexists('dir'))
 
588
        self.assertFalse(osutils.lexists('dir'))
572
589
 
573
590
    def test_make_branch_builder_with_format(self):
574
591
        # Use a repo layout that doesn't conform to a 'named' layout, to ensure
575
592
        # that the format objects are used.
576
593
        format = bzrdir.BzrDirMetaFormat1()
577
 
        repo_format = weaverepo.RepositoryFormat7()
 
594
        repo_format = repository.format_registry.get_default()
578
595
        format.repository_format = repo_format
579
596
        builder = self.make_branch_builder('dir', format=format)
580
597
        the_branch = builder.get_branch()
581
598
        # Guard against regression into MemoryTransport leaking
582
599
        # files to disk instead of keeping them in memory.
583
 
        self.failIf(osutils.lexists('dir'))
 
600
        self.assertFalse(osutils.lexists('dir'))
584
601
        self.assertEqual(format.repository_format.__class__,
585
602
                         the_branch.repository._format.__class__)
586
603
        self.assertEqual(repo_format.get_format_string(),
592
609
        the_branch = builder.get_branch()
593
610
        # Guard against regression into MemoryTransport leaking
594
611
        # files to disk instead of keeping them in memory.
595
 
        self.failIf(osutils.lexists('dir'))
 
612
        self.assertFalse(osutils.lexists('dir'))
596
613
        dir_format = bzrdir.format_registry.make_bzrdir('knit')
597
614
        self.assertEqual(dir_format.repository_format.__class__,
598
615
                         the_branch.repository._format.__class__)
603
620
    def test_dangling_locks_cause_failures(self):
604
621
        class TestDanglingLock(tests.TestCaseWithMemoryTransport):
605
622
            def test_function(self):
606
 
                t = self.get_transport('.')
 
623
                t = self.get_transport_from_path('.')
607
624
                l = lockdir.LockDir(t, 'lock')
608
625
                l.create()
609
626
                l.attempt_lock()
610
627
        test = TestDanglingLock('test_function')
611
628
        result = test.run()
 
629
        total_failures = result.errors + result.failures
612
630
        if self._lock_check_thorough:
613
 
            self.assertEqual(1, len(result.errors))
 
631
            self.assertEqual(1, len(total_failures))
614
632
        else:
615
633
            # When _lock_check_thorough is disabled, then we don't trigger a
616
634
            # failure
617
 
            self.assertEqual(0, len(result.errors))
 
635
            self.assertEqual(0, len(total_failures))
618
636
 
619
637
 
620
638
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
621
639
    """Tests for the convenience functions TestCaseWithTransport introduces."""
622
640
 
623
641
    def test_get_readonly_url_none(self):
624
 
        from bzrlib.transport import get_transport
625
642
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
626
643
        self.vfs_transport_factory = memory.MemoryServer
627
644
        self.transport_readonly_server = None
629
646
        # for the server
630
647
        url = self.get_readonly_url()
631
648
        url2 = self.get_readonly_url('foo/bar')
632
 
        t = get_transport(url)
633
 
        t2 = get_transport(url2)
634
 
        self.failUnless(isinstance(t, ReadonlyTransportDecorator))
635
 
        self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
 
649
        t = transport.get_transport_from_url(url)
 
650
        t2 = transport.get_transport_from_url(url2)
 
651
        self.assertIsInstance(t, ReadonlyTransportDecorator)
 
652
        self.assertIsInstance(t2, ReadonlyTransportDecorator)
636
653
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
637
654
 
638
655
    def test_get_readonly_url_http(self):
639
656
        from bzrlib.tests.http_server import HttpServer
640
 
        from bzrlib.transport import get_transport
641
657
        from bzrlib.transport.http import HttpTransportBase
642
658
        self.transport_server = test_server.LocalURLServer
643
659
        self.transport_readonly_server = HttpServer
645
661
        url = self.get_readonly_url()
646
662
        url2 = self.get_readonly_url('foo/bar')
647
663
        # the transport returned may be any HttpTransportBase subclass
648
 
        t = get_transport(url)
649
 
        t2 = get_transport(url2)
650
 
        self.failUnless(isinstance(t, HttpTransportBase))
651
 
        self.failUnless(isinstance(t2, HttpTransportBase))
 
664
        t = transport.get_transport_from_url(url)
 
665
        t2 = transport.get_transport_from_url(url2)
 
666
        self.assertIsInstance(t, HttpTransportBase)
 
667
        self.assertIsInstance(t2, HttpTransportBase)
652
668
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
653
669
 
654
670
    def test_is_directory(self):
662
678
    def test_make_branch_builder(self):
663
679
        builder = self.make_branch_builder('dir')
664
680
        rev_id = builder.build_commit()
665
 
        self.failUnlessExists('dir')
 
681
        self.assertPathExists('dir')
666
682
        a_dir = bzrdir.BzrDir.open('dir')
667
683
        self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
668
684
        a_branch = a_dir.open_branch()
684
700
        self.assertIsInstance(result_bzrdir.transport,
685
701
                              memory.MemoryTransport)
686
702
        # should not be on disk, should only be in memory
687
 
        self.failIfExists('subdir')
 
703
        self.assertPathDoesNotExist('subdir')
688
704
 
689
705
 
690
706
class TestChrootedTest(tests.ChrootedTestCase):
691
707
 
692
708
    def test_root_is_root(self):
693
 
        from bzrlib.transport import get_transport
694
 
        t = get_transport(self.get_readonly_url())
 
709
        t = transport.get_transport_from_url(self.get_readonly_url())
695
710
        url = t.base
696
711
        self.assertEqual(url, t.clone('..').base)
697
712
 
699
714
class TestProfileResult(tests.TestCase):
700
715
 
701
716
    def test_profiles_tests(self):
702
 
        self.requireFeature(test_lsprof.LSProfFeature)
703
 
        terminal = testtools.tests.helpers.ExtendedTestResult()
 
717
        self.requireFeature(features.lsprof_feature)
 
718
        terminal = testtools.testresult.doubles.ExtendedTestResult()
704
719
        result = tests.ProfileResult(terminal)
705
720
        class Sample(tests.TestCase):
706
721
            def a(self):
723
738
                descriptions=0,
724
739
                verbosity=1,
725
740
                )
726
 
        capture = testtools.tests.helpers.ExtendedTestResult()
 
741
        capture = testtools.testresult.doubles.ExtendedTestResult()
727
742
        test_case.run(MultiTestResult(result, capture))
728
743
        run_case = capture._events[0][1]
729
744
        timed_string = result._testTimeString(run_case)
750
765
        self.check_timing(ShortDelayTestCase('test_short_delay'),
751
766
                          r"^ +[0-9]+ms$")
752
767
 
753
 
    def _patch_get_bzr_source_tree(self):
754
 
        # Reading from the actual source tree breaks isolation, but we don't
755
 
        # want to assume that thats *all* that would happen.
756
 
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree', lambda: None)
757
 
 
758
 
    def test_assigned_benchmark_file_stores_date(self):
759
 
        self._patch_get_bzr_source_tree()
760
 
        output = StringIO()
761
 
        result = bzrlib.tests.TextTestResult(self._log_file,
762
 
                                        descriptions=0,
763
 
                                        verbosity=1,
764
 
                                        bench_history=output
765
 
                                        )
766
 
        output_string = output.getvalue()
767
 
        # if you are wondering about the regexp please read the comment in
768
 
        # test_bench_history (bzrlib.tests.test_selftest.TestRunner)
769
 
        # XXX: what comment?  -- Andrew Bennetts
770
 
        self.assertContainsRe(output_string, "--date [0-9.]+")
771
 
 
772
 
    def test_benchhistory_records_test_times(self):
773
 
        self._patch_get_bzr_source_tree()
774
 
        result_stream = StringIO()
775
 
        result = bzrlib.tests.TextTestResult(
776
 
            self._log_file,
777
 
            descriptions=0,
778
 
            verbosity=1,
779
 
            bench_history=result_stream
780
 
            )
781
 
 
782
 
        # we want profile a call and check that its test duration is recorded
783
 
        # make a new test instance that when run will generate a benchmark
784
 
        example_test_case = TestTestResult("_time_hello_world_encoding")
785
 
        # execute the test, which should succeed and record times
786
 
        example_test_case.run(result)
787
 
        lines = result_stream.getvalue().splitlines()
788
 
        self.assertEqual(2, len(lines))
789
 
        self.assertContainsRe(lines[1],
790
 
            " *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
791
 
            "._time_hello_world_encoding")
792
 
 
793
768
    def _time_hello_world_encoding(self):
794
769
        """Profile two sleep calls
795
770
 
800
775
 
801
776
    def test_lsprofiling(self):
802
777
        """Verbose test result prints lsprof statistics from test cases."""
803
 
        self.requireFeature(test_lsprof.LSProfFeature)
 
778
        self.requireFeature(features.lsprof_feature)
804
779
        result_stream = StringIO()
805
780
        result = bzrlib.tests.VerboseTestResult(
806
 
            unittest._WritelnDecorator(result_stream),
 
781
            result_stream,
807
782
            descriptions=0,
808
783
            verbosity=2,
809
784
            )
835
810
        self.assertContainsRe(output,
836
811
            r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
837
812
 
 
813
    def test_uses_time_from_testtools(self):
 
814
        """Test case timings in verbose results should use testtools times"""
 
815
        import datetime
 
816
        class TimeAddedVerboseTestResult(tests.VerboseTestResult):
 
817
            def startTest(self, test):
 
818
                self.time(datetime.datetime.utcfromtimestamp(1.145))
 
819
                super(TimeAddedVerboseTestResult, self).startTest(test)
 
820
            def addSuccess(self, test):
 
821
                self.time(datetime.datetime.utcfromtimestamp(51.147))
 
822
                super(TimeAddedVerboseTestResult, self).addSuccess(test)
 
823
            def report_tests_starting(self): pass
 
824
        sio = StringIO()
 
825
        self.get_passing_test().run(TimeAddedVerboseTestResult(sio, 0, 2))
 
826
        self.assertEndsWith(sio.getvalue(), "OK    50002ms\n")
 
827
 
838
828
    def test_known_failure(self):
839
 
        """A KnownFailure being raised should trigger several result actions."""
 
829
        """Using knownFailure should trigger several result actions."""
840
830
        class InstrumentedTestResult(tests.ExtendedTestResult):
841
831
            def stopTestRun(self): pass
842
 
            def startTests(self): pass
843
 
            def report_test_start(self, test): pass
 
832
            def report_tests_starting(self): pass
844
833
            def report_known_failure(self, test, err=None, details=None):
845
834
                self._call = test, 'known failure'
846
835
        result = InstrumentedTestResult(None, None, None, None)
847
836
        class Test(tests.TestCase):
848
837
            def test_function(self):
849
 
                raise tests.KnownFailure('failed!')
 
838
                self.knownFailure('failed!')
850
839
        test = Test("test_function")
851
840
        test.run(result)
852
841
        # it should invoke 'report_known_failure'.
864
853
        # verbose test output formatting
865
854
        result_stream = StringIO()
866
855
        result = bzrlib.tests.VerboseTestResult(
867
 
            unittest._WritelnDecorator(result_stream),
 
856
            result_stream,
868
857
            descriptions=0,
869
858
            verbosity=2,
870
859
            )
871
 
        test = self.get_passing_test()
872
 
        result.startTest(test)
873
 
        prefix = len(result_stream.getvalue())
874
 
        # the err parameter has the shape:
875
 
        # (class, exception object, traceback)
876
 
        # KnownFailures dont get their tracebacks shown though, so we
877
 
        # can skip that.
878
 
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
879
 
        result.report_known_failure(test, err)
880
 
        output = result_stream.getvalue()[prefix:]
881
 
        lines = output.splitlines()
882
 
        self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
883
 
        self.assertEqual(lines[1], '    foo')
884
 
        self.assertEqual(2, len(lines))
 
860
        _get_test("test_xfail").run(result)
 
861
        self.assertContainsRe(result_stream.getvalue(),
 
862
            "\n\\S+\\.test_xfail\\s+XFAIL\\s+\\d+ms\n"
 
863
            "\\s*(?:Text attachment: )?reason"
 
864
            "(?:\n-+\n|: {{{)"
 
865
            "this_fails"
 
866
            "(?:\n-+\n|}}}\n)")
885
867
 
886
868
    def get_passing_test(self):
887
869
        """Return a test object that can't be run usefully."""
893
875
        """Test the behaviour of invoking addNotSupported."""
894
876
        class InstrumentedTestResult(tests.ExtendedTestResult):
895
877
            def stopTestRun(self): pass
896
 
            def startTests(self): pass
897
 
            def report_test_start(self, test): pass
 
878
            def report_tests_starting(self): pass
898
879
            def report_unsupported(self, test, feature):
899
880
                self._call = test, feature
900
881
        result = InstrumentedTestResult(None, None, None, None)
901
882
        test = SampleTestCase('_test_pass')
902
 
        feature = tests.Feature()
 
883
        feature = features.Feature()
903
884
        result.startTest(test)
904
885
        result.addNotSupported(test, feature)
905
886
        # it should invoke 'report_unsupported'.
919
900
        # verbose test output formatting
920
901
        result_stream = StringIO()
921
902
        result = bzrlib.tests.VerboseTestResult(
922
 
            unittest._WritelnDecorator(result_stream),
 
903
            result_stream,
923
904
            descriptions=0,
924
905
            verbosity=2,
925
906
            )
926
907
        test = self.get_passing_test()
927
 
        feature = tests.Feature()
 
908
        feature = features.Feature()
928
909
        result.startTest(test)
929
910
        prefix = len(result_stream.getvalue())
930
911
        result.report_unsupported(test, feature)
939
920
        """An UnavailableFeature being raised should invoke addNotSupported."""
940
921
        class InstrumentedTestResult(tests.ExtendedTestResult):
941
922
            def stopTestRun(self): pass
942
 
            def startTests(self): pass
943
 
            def report_test_start(self, test): pass
 
923
            def report_tests_starting(self): pass
944
924
            def addNotSupported(self, test, feature):
945
925
                self._call = test, feature
946
926
        result = InstrumentedTestResult(None, None, None, None)
947
 
        feature = tests.Feature()
 
927
        feature = features.Feature()
948
928
        class Test(tests.TestCase):
949
929
            def test_function(self):
950
930
                raise tests.UnavailableFeature(feature)
969
949
    def test_strict_with_known_failure(self):
970
950
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
971
951
                                             verbosity=1)
972
 
        test = self.get_passing_test()
973
 
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
974
 
        result.addExpectedFailure(test, err)
 
952
        test = _get_test("test_xfail")
 
953
        test.run(result)
975
954
        self.assertFalse(result.wasStrictlySuccessful())
976
955
        self.assertEqual(None, result._extractBenchmarkTime(test))
977
956
 
988
967
        class InstrumentedTestResult(tests.ExtendedTestResult):
989
968
            calls = 0
990
969
            def startTests(self): self.calls += 1
991
 
            def report_test_start(self, test): pass
992
970
        result = InstrumentedTestResult(None, None, None, None)
993
971
        def test_function():
994
972
            pass
996
974
        test.run(result)
997
975
        self.assertEquals(1, result.calls)
998
976
 
999
 
 
1000
 
class TestUnicodeFilenameFeature(tests.TestCase):
1001
 
 
1002
 
    def test_probe_passes(self):
1003
 
        """UnicodeFilenameFeature._probe passes."""
1004
 
        # We can't test much more than that because the behaviour depends
1005
 
        # on the platform.
1006
 
        tests.UnicodeFilenameFeature._probe()
 
977
    def test_startTests_only_once(self):
 
978
        """With multiple tests startTests should still only be called once"""
 
979
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
980
            calls = 0
 
981
            def startTests(self): self.calls += 1
 
982
        result = InstrumentedTestResult(None, None, None, None)
 
983
        suite = unittest.TestSuite([
 
984
            unittest.FunctionTestCase(lambda: None),
 
985
            unittest.FunctionTestCase(lambda: None)])
 
986
        suite.run(result)
 
987
        self.assertEquals(1, result.calls)
 
988
        self.assertEquals(2, result.count)
1007
989
 
1008
990
 
1009
991
class TestRunner(tests.TestCase):
1022
1004
        because of our use of global state.
1023
1005
        """
1024
1006
        old_root = tests.TestCaseInTempDir.TEST_ROOT
1025
 
        old_leak = tests.TestCase._first_thread_leaker_id
1026
1007
        try:
1027
1008
            tests.TestCaseInTempDir.TEST_ROOT = None
1028
 
            tests.TestCase._first_thread_leaker_id = None
1029
1009
            return testrunner.run(test)
1030
1010
        finally:
1031
1011
            tests.TestCaseInTempDir.TEST_ROOT = old_root
1032
 
            tests.TestCase._first_thread_leaker_id = old_leak
1033
1012
 
1034
1013
    def test_known_failure_failed_run(self):
1035
1014
        # run a test that generates a known failure which should be printed in
1040
1019
        test = unittest.TestSuite()
1041
1020
        test.addTest(Test("known_failure_test"))
1042
1021
        def failing_test():
1043
 
            self.fail('foo')
 
1022
            raise AssertionError('foo')
1044
1023
        test.addTest(unittest.FunctionTestCase(failing_test))
1045
1024
        stream = StringIO()
1046
1025
        runner = tests.TextTestRunner(stream=stream)
1054
1033
            '^----------------------------------------------------------------------\n'
1055
1034
            'Traceback \\(most recent call last\\):\n'
1056
1035
            '  .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
1057
 
            '    self.fail\\(\'foo\'\\)\n'
 
1036
            '    raise AssertionError\\(\'foo\'\\)\n'
1058
1037
            '.*'
1059
1038
            '^----------------------------------------------------------------------\n'
1060
1039
            '.*'
1066
1045
        # the final output.
1067
1046
        class Test(tests.TestCase):
1068
1047
            def known_failure_test(self):
1069
 
                self.expectFailure('failed', self.assertTrue, False)
 
1048
                self.knownFailure("Never works...")
1070
1049
        test = Test("known_failure_test")
1071
1050
        stream = StringIO()
1072
1051
        runner = tests.TextTestRunner(stream=stream)
1078
1057
            '\n'
1079
1058
            'OK \\(known_failures=1\\)\n')
1080
1059
 
 
1060
    def test_unexpected_success_bad(self):
 
1061
        class Test(tests.TestCase):
 
1062
            def test_truth(self):
 
1063
                self.expectFailure("No absolute truth", self.assertTrue, True)
 
1064
        runner = tests.TextTestRunner(stream=StringIO())
 
1065
        result = self.run_test_runner(runner, Test("test_truth"))
 
1066
        if testtools_version[:3] <= (0, 9, 11):
 
1067
            self.assertContainsRe(runner.stream.getvalue(),
 
1068
                "=+\n"
 
1069
                "FAIL: \\S+\.test_truth\n"
 
1070
                "-+\n"
 
1071
                "(?:.*\n)*"
 
1072
                "No absolute truth\n"
 
1073
                "(?:.*\n)*"
 
1074
                "-+\n"
 
1075
                "Ran 1 test in .*\n"
 
1076
                "\n"
 
1077
                "FAILED \\(failures=1\\)\n\\Z")
 
1078
        else:
 
1079
            self.assertContainsRe(runner.stream.getvalue(),
 
1080
                "=+\n"
 
1081
                "FAIL: \\S+\.test_truth\n"
 
1082
                "-+\n"
 
1083
                "Empty attachments:\n"
 
1084
                "  log\n"
 
1085
                "\n"
 
1086
                "reason: {{{No absolute truth}}}\n"
 
1087
                "-+\n"
 
1088
                "Ran 1 test in .*\n"
 
1089
                "\n"
 
1090
                "FAILED \\(failures=1\\)\n\\Z")
 
1091
 
1081
1092
    def test_result_decorator(self):
1082
1093
        # decorate results
1083
1094
        calls = []
1084
 
        class LoggingDecorator(tests.ForwardingResult):
 
1095
        class LoggingDecorator(ExtendedToOriginalDecorator):
1085
1096
            def startTest(self, test):
1086
 
                tests.ForwardingResult.startTest(self, test)
 
1097
                ExtendedToOriginalDecorator.startTest(self, test)
1087
1098
                calls.append('start')
1088
1099
        test = unittest.FunctionTestCase(lambda:None)
1089
1100
        stream = StringIO()
1167
1178
 
1168
1179
    def test_unsupported_features_listed(self):
1169
1180
        """When unsupported features are encountered they are detailed."""
1170
 
        class Feature1(tests.Feature):
 
1181
        class Feature1(features.Feature):
1171
1182
            def _probe(self): return False
1172
 
        class Feature2(tests.Feature):
 
1183
        class Feature2(features.Feature):
1173
1184
            def _probe(self): return False
1174
1185
        # create sample tests
1175
1186
        test1 = SampleTestCase('_test_pass')
1190
1201
            ],
1191
1202
            lines[-3:])
1192
1203
 
1193
 
    def _patch_get_bzr_source_tree(self):
1194
 
        # Reading from the actual source tree breaks isolation, but we don't
1195
 
        # want to assume that thats *all* that would happen.
1196
 
        self._get_source_tree_calls = []
1197
 
        def new_get():
1198
 
            self._get_source_tree_calls.append("called")
1199
 
            return None
1200
 
        self.overrideAttr(bzrlib.version, '_get_bzr_source_tree',  new_get)
1201
 
 
1202
 
    def test_bench_history(self):
1203
 
        # tests that the running the benchmark passes bench_history into
1204
 
        # the test result object. We can tell that happens if
1205
 
        # _get_bzr_source_tree is called.
1206
 
        self._patch_get_bzr_source_tree()
1207
 
        test = TestRunner('dummy_test')
1208
 
        output = StringIO()
1209
 
        runner = tests.TextTestRunner(stream=self._log_file,
1210
 
                                      bench_history=output)
1211
 
        result = self.run_test_runner(runner, test)
1212
 
        output_string = output.getvalue()
1213
 
        self.assertContainsRe(output_string, "--date [0-9.]+")
1214
 
        self.assertLength(1, self._get_source_tree_calls)
 
1204
    def test_verbose_test_count(self):
 
1205
        """A verbose test run reports the right test count at the start"""
 
1206
        suite = TestUtil.TestSuite([
 
1207
            unittest.FunctionTestCase(lambda:None),
 
1208
            unittest.FunctionTestCase(lambda:None)])
 
1209
        self.assertEqual(suite.countTestCases(), 2)
 
1210
        stream = StringIO()
 
1211
        runner = tests.TextTestRunner(stream=stream, verbosity=2)
 
1212
        # Need to use the CountingDecorator as that's what sets num_tests
 
1213
        result = self.run_test_runner(runner, tests.CountingDecorator(suite))
 
1214
        self.assertStartsWith(stream.getvalue(), "running 2 tests")
1215
1215
 
1216
1216
    def test_startTestRun(self):
1217
1217
        """run should call result.startTestRun()"""
1218
1218
        calls = []
1219
 
        class LoggingDecorator(tests.ForwardingResult):
 
1219
        class LoggingDecorator(ExtendedToOriginalDecorator):
1220
1220
            def startTestRun(self):
1221
 
                tests.ForwardingResult.startTestRun(self)
 
1221
                ExtendedToOriginalDecorator.startTestRun(self)
1222
1222
                calls.append('startTestRun')
1223
1223
        test = unittest.FunctionTestCase(lambda:None)
1224
1224
        stream = StringIO()
1230
1230
    def test_stopTestRun(self):
1231
1231
        """run should call result.stopTestRun()"""
1232
1232
        calls = []
1233
 
        class LoggingDecorator(tests.ForwardingResult):
 
1233
        class LoggingDecorator(ExtendedToOriginalDecorator):
1234
1234
            def stopTestRun(self):
1235
 
                tests.ForwardingResult.stopTestRun(self)
 
1235
                ExtendedToOriginalDecorator.stopTestRun(self)
1236
1236
                calls.append('stopTestRun')
1237
1237
        test = unittest.FunctionTestCase(lambda:None)
1238
1238
        stream = StringIO()
1241
1241
        result = self.run_test_runner(runner, test)
1242
1242
        self.assertLength(1, calls)
1243
1243
 
 
1244
    def test_unicode_test_output_on_ascii_stream(self):
 
1245
        """Showing results should always succeed even on an ascii console"""
 
1246
        class FailureWithUnicode(tests.TestCase):
 
1247
            def test_log_unicode(self):
 
1248
                self.log(u"\u2606")
 
1249
                self.fail("Now print that log!")
 
1250
        out = StringIO()
 
1251
        self.overrideAttr(osutils, "get_terminal_encoding",
 
1252
            lambda trace=False: "ascii")
 
1253
        result = self.run_test_runner(tests.TextTestRunner(stream=out),
 
1254
            FailureWithUnicode("test_log_unicode"))
 
1255
        if testtools_version[:3] > (0, 9, 11):
 
1256
            self.assertContainsRe(out.getvalue(), "log: {{{\d+\.\d+  \\\\u2606}}}")
 
1257
        else:
 
1258
            self.assertContainsRe(out.getvalue(),
 
1259
                "Text attachment: log\n"
 
1260
                "-+\n"
 
1261
                "\d+\.\d+  \\\\u2606\n"
 
1262
                "-+\n")
 
1263
 
1244
1264
 
1245
1265
class SampleTestCase(tests.TestCase):
1246
1266
 
1421
1441
        sample_test = TestTestCase("method_that_times_a_bit_twice")
1422
1442
        output_stream = StringIO()
1423
1443
        result = bzrlib.tests.VerboseTestResult(
1424
 
            unittest._WritelnDecorator(output_stream),
 
1444
            output_stream,
1425
1445
            descriptions=0,
1426
1446
            verbosity=2)
1427
1447
        sample_test.run(result)
1434
1454
        # Note this test won't fail with hooks that the core library doesn't
1435
1455
        # use - but it trigger with a plugin that adds hooks, so its still a
1436
1456
        # useful warning in that case.
1437
 
        self.assertEqual(bzrlib.branch.BranchHooks(),
1438
 
            bzrlib.branch.Branch.hooks)
1439
 
        self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
 
1457
        self.assertEqual(bzrlib.branch.BranchHooks(), bzrlib.branch.Branch.hooks)
 
1458
        self.assertEqual(
 
1459
            bzrlib.smart.server.SmartServerHooks(),
1440
1460
            bzrlib.smart.server.SmartTCPServer.hooks)
1441
 
        self.assertEqual(bzrlib.commands.CommandHooks(),
1442
 
            bzrlib.commands.Command.hooks)
 
1461
        self.assertEqual(
 
1462
            bzrlib.commands.CommandHooks(), bzrlib.commands.Command.hooks)
1443
1463
 
1444
1464
    def test__gather_lsprof_in_benchmarks(self):
1445
1465
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1446
1466
 
1447
1467
        Each self.time() call is individually and separately profiled.
1448
1468
        """
1449
 
        self.requireFeature(test_lsprof.LSProfFeature)
 
1469
        self.requireFeature(features.lsprof_feature)
1450
1470
        # overrides the class member with an instance member so no cleanup
1451
1471
        # needed.
1452
1472
        self._gather_lsprof_in_benchmarks = True
1471
1491
        transport_server = memory.MemoryServer()
1472
1492
        transport_server.start_server()
1473
1493
        self.addCleanup(transport_server.stop_server)
1474
 
        t = transport.get_transport(transport_server.get_url())
 
1494
        t = transport.get_transport_from_url(transport_server.get_url())
1475
1495
        bzrdir.BzrDir.create(t.base)
1476
1496
        self.assertRaises(errors.BzrError,
1477
1497
            bzrdir.BzrDir.open_from_transport, t)
1482
1502
 
1483
1503
    def test_requireFeature_available(self):
1484
1504
        """self.requireFeature(available) is a no-op."""
1485
 
        class Available(tests.Feature):
 
1505
        class Available(features.Feature):
1486
1506
            def _probe(self):return True
1487
1507
        feature = Available()
1488
1508
        self.requireFeature(feature)
1489
1509
 
1490
1510
    def test_requireFeature_unavailable(self):
1491
1511
        """self.requireFeature(unavailable) raises UnavailableFeature."""
1492
 
        class Unavailable(tests.Feature):
 
1512
        class Unavailable(features.Feature):
1493
1513
            def _probe(self):return False
1494
1514
        feature = Unavailable()
1495
1515
        self.assertRaises(tests.UnavailableFeature,
1654
1674
        test.run(unittest.TestResult())
1655
1675
        self.assertEqual('original', obj.test_attr)
1656
1676
 
 
1677
    def test_recordCalls(self):
 
1678
        from bzrlib.tests import test_selftest
 
1679
        calls = self.recordCalls(
 
1680
            test_selftest, '_add_numbers')
 
1681
        self.assertEqual(test_selftest._add_numbers(2, 10),
 
1682
            12)
 
1683
        self.assertEquals(calls, [((2, 10), {})])
 
1684
 
 
1685
 
 
1686
def _add_numbers(a, b):
 
1687
    return a + b
 
1688
 
 
1689
 
 
1690
class _MissingFeature(features.Feature):
 
1691
    def _probe(self):
 
1692
        return False
 
1693
missing_feature = _MissingFeature()
 
1694
 
 
1695
 
 
1696
def _get_test(name):
 
1697
    """Get an instance of a specific example test.
 
1698
 
 
1699
    We protect this in a function so that they don't auto-run in the test
 
1700
    suite.
 
1701
    """
 
1702
 
 
1703
    class ExampleTests(tests.TestCase):
 
1704
 
 
1705
        def test_fail(self):
 
1706
            mutter('this was a failing test')
 
1707
            self.fail('this test will fail')
 
1708
 
 
1709
        def test_error(self):
 
1710
            mutter('this test errored')
 
1711
            raise RuntimeError('gotcha')
 
1712
 
 
1713
        def test_missing_feature(self):
 
1714
            mutter('missing the feature')
 
1715
            self.requireFeature(missing_feature)
 
1716
 
 
1717
        def test_skip(self):
 
1718
            mutter('this test will be skipped')
 
1719
            raise tests.TestSkipped('reason')
 
1720
 
 
1721
        def test_success(self):
 
1722
            mutter('this test succeeds')
 
1723
 
 
1724
        def test_xfail(self):
 
1725
            mutter('test with expected failure')
 
1726
            self.knownFailure('this_fails')
 
1727
 
 
1728
        def test_unexpected_success(self):
 
1729
            mutter('test with unexpected success')
 
1730
            self.expectFailure('should_fail', lambda: None)
 
1731
 
 
1732
    return ExampleTests(name)
 
1733
 
 
1734
 
 
1735
class TestTestCaseLogDetails(tests.TestCase):
 
1736
 
 
1737
    def _run_test(self, test_name):
 
1738
        test = _get_test(test_name)
 
1739
        result = testtools.TestResult()
 
1740
        test.run(result)
 
1741
        return result
 
1742
 
 
1743
    def test_fail_has_log(self):
 
1744
        result = self._run_test('test_fail')
 
1745
        self.assertEqual(1, len(result.failures))
 
1746
        result_content = result.failures[0][1]
 
1747
        if testtools_version < (0, 9, 12):
 
1748
            self.assertContainsRe(result_content, 'Text attachment: log')
 
1749
        self.assertContainsRe(result_content, 'this was a failing test')
 
1750
 
 
1751
    def test_error_has_log(self):
 
1752
        result = self._run_test('test_error')
 
1753
        self.assertEqual(1, len(result.errors))
 
1754
        result_content = result.errors[0][1]
 
1755
        if testtools_version < (0, 9, 12):
 
1756
            self.assertContainsRe(result_content, 'Text attachment: log')
 
1757
        self.assertContainsRe(result_content, 'this test errored')
 
1758
 
 
1759
    def test_skip_has_no_log(self):
 
1760
        result = self._run_test('test_skip')
 
1761
        self.assertEqual(['reason'], result.skip_reasons.keys())
 
1762
        skips = result.skip_reasons['reason']
 
1763
        self.assertEqual(1, len(skips))
 
1764
        test = skips[0]
 
1765
        self.assertFalse('log' in test.getDetails())
 
1766
 
 
1767
    def test_missing_feature_has_no_log(self):
 
1768
        # testtools doesn't know about addNotSupported, so it just gets
 
1769
        # considered as a skip
 
1770
        result = self._run_test('test_missing_feature')
 
1771
        self.assertEqual([missing_feature], result.skip_reasons.keys())
 
1772
        skips = result.skip_reasons[missing_feature]
 
1773
        self.assertEqual(1, len(skips))
 
1774
        test = skips[0]
 
1775
        self.assertFalse('log' in test.getDetails())
 
1776
 
 
1777
    def test_xfail_has_no_log(self):
 
1778
        result = self._run_test('test_xfail')
 
1779
        self.assertEqual(1, len(result.expectedFailures))
 
1780
        result_content = result.expectedFailures[0][1]
 
1781
        self.assertNotContainsRe(result_content, 'Text attachment: log')
 
1782
        self.assertNotContainsRe(result_content, 'test with expected failure')
 
1783
 
 
1784
    def test_unexpected_success_has_log(self):
 
1785
        result = self._run_test('test_unexpected_success')
 
1786
        self.assertEqual(1, len(result.unexpectedSuccesses))
 
1787
        # Inconsistency, unexpectedSuccesses is a list of tests,
 
1788
        # expectedFailures is a list of reasons?
 
1789
        test = result.unexpectedSuccesses[0]
 
1790
        details = test.getDetails()
 
1791
        self.assertTrue('log' in details)
 
1792
 
 
1793
 
 
1794
class TestTestCloning(tests.TestCase):
 
1795
    """Tests that test cloning of TestCases (as used by multiply_tests)."""
 
1796
 
 
1797
    def test_cloned_testcase_does_not_share_details(self):
 
1798
        """A TestCase cloned with clone_test does not share mutable attributes
 
1799
        such as details or cleanups.
 
1800
        """
 
1801
        class Test(tests.TestCase):
 
1802
            def test_foo(self):
 
1803
                self.addDetail('foo', Content('text/plain', lambda: 'foo'))
 
1804
        orig_test = Test('test_foo')
 
1805
        cloned_test = tests.clone_test(orig_test, orig_test.id() + '(cloned)')
 
1806
        orig_test.run(unittest.TestResult())
 
1807
        self.assertEqual('foo', orig_test.getDetails()['foo'].iter_bytes())
 
1808
        self.assertEqual(None, cloned_test.getDetails().get('foo'))
 
1809
 
 
1810
    def test_double_apply_scenario_preserves_first_scenario(self):
 
1811
        """Applying two levels of scenarios to a test preserves the attributes
 
1812
        added by both scenarios.
 
1813
        """
 
1814
        class Test(tests.TestCase):
 
1815
            def test_foo(self):
 
1816
                pass
 
1817
        test = Test('test_foo')
 
1818
        scenarios_x = [('x=1', {'x': 1}), ('x=2', {'x': 2})]
 
1819
        scenarios_y = [('y=1', {'y': 1}), ('y=2', {'y': 2})]
 
1820
        suite = tests.multiply_tests(test, scenarios_x, unittest.TestSuite())
 
1821
        suite = tests.multiply_tests(suite, scenarios_y, unittest.TestSuite())
 
1822
        all_tests = list(tests.iter_suite_tests(suite))
 
1823
        self.assertLength(4, all_tests)
 
1824
        all_xys = sorted((t.x, t.y) for t in all_tests)
 
1825
        self.assertEqual([(1, 1), (1, 2), (2, 1), (2, 2)], all_xys)
 
1826
 
1657
1827
 
1658
1828
# NB: Don't delete this; it's not actually from 0.11!
1659
1829
@deprecated_function(deprecated_in((0, 11, 0)))
1787
1957
    def test_make_branch_and_tree_with_format(self):
1788
1958
        # we should be able to supply a format to make_branch_and_tree
1789
1959
        self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
1790
 
        self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
1791
1960
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
1792
1961
                              bzrlib.bzrdir.BzrDirMetaFormat1)
1793
 
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
1794
 
                              bzrlib.bzrdir.BzrDirFormat6)
1795
1962
 
1796
1963
    def test_make_branch_and_memory_tree(self):
1797
1964
        # we should be able to get a new branch and a mutable tree from
1814
1981
                tree.branch.repository.bzrdir.root_transport)
1815
1982
 
1816
1983
 
1817
 
class SelfTestHelper:
 
1984
class SelfTestHelper(object):
1818
1985
 
1819
1986
    def run_selftest(self, **kwargs):
1820
1987
        """Run selftest returning its output."""
1874
2041
        self.assertLength(2, output.readlines())
1875
2042
 
1876
2043
    def test_lsprof_tests(self):
1877
 
        self.requireFeature(test_lsprof.LSProfFeature)
1878
 
        calls = []
 
2044
        self.requireFeature(features.lsprof_feature)
 
2045
        results = []
1879
2046
        class Test(object):
1880
2047
            def __call__(test, result):
1881
2048
                test.run(result)
1882
2049
            def run(test, result):
1883
 
                self.assertIsInstance(result, tests.ForwardingResult)
1884
 
                calls.append("called")
 
2050
                results.append(result)
1885
2051
            def countTestCases(self):
1886
2052
                return 1
1887
2053
        self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
1888
 
        self.assertLength(1, calls)
 
2054
        self.assertLength(1, results)
 
2055
        self.assertIsInstance(results.pop(), ExtendedToOriginalDecorator)
1889
2056
 
1890
2057
    def test_random(self):
1891
2058
        # test randomising by listing a number of tests.
1971
2138
            load_list='missing file name', list_only=True)
1972
2139
 
1973
2140
 
 
2141
class TestSubunitLogDetails(tests.TestCase, SelfTestHelper):
 
2142
 
 
2143
    _test_needs_features = [features.subunit]
 
2144
 
 
2145
    def run_subunit_stream(self, test_name):
 
2146
        from subunit import ProtocolTestCase
 
2147
        def factory():
 
2148
            return TestUtil.TestSuite([_get_test(test_name)])
 
2149
        stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
 
2150
            test_suite_factory=factory)
 
2151
        test = ProtocolTestCase(stream)
 
2152
        result = testtools.TestResult()
 
2153
        test.run(result)
 
2154
        content = stream.getvalue()
 
2155
        return content, result
 
2156
 
 
2157
    def test_fail_has_log(self):
 
2158
        content, result = self.run_subunit_stream('test_fail')
 
2159
        self.assertEqual(1, len(result.failures))
 
2160
        self.assertContainsRe(content, '(?m)^log$')
 
2161
        self.assertContainsRe(content, 'this test will fail')
 
2162
 
 
2163
    def test_error_has_log(self):
 
2164
        content, result = self.run_subunit_stream('test_error')
 
2165
        self.assertContainsRe(content, '(?m)^log$')
 
2166
        self.assertContainsRe(content, 'this test errored')
 
2167
 
 
2168
    def test_skip_has_no_log(self):
 
2169
        content, result = self.run_subunit_stream('test_skip')
 
2170
        self.assertNotContainsRe(content, '(?m)^log$')
 
2171
        self.assertNotContainsRe(content, 'this test will be skipped')
 
2172
        self.assertEqual(['reason'], result.skip_reasons.keys())
 
2173
        skips = result.skip_reasons['reason']
 
2174
        self.assertEqual(1, len(skips))
 
2175
        test = skips[0]
 
2176
        # RemotedTestCase doesn't preserve the "details"
 
2177
        ## self.assertFalse('log' in test.getDetails())
 
2178
 
 
2179
    def test_missing_feature_has_no_log(self):
 
2180
        content, result = self.run_subunit_stream('test_missing_feature')
 
2181
        self.assertNotContainsRe(content, '(?m)^log$')
 
2182
        self.assertNotContainsRe(content, 'missing the feature')
 
2183
        self.assertEqual(['_MissingFeature\n'], result.skip_reasons.keys())
 
2184
        skips = result.skip_reasons['_MissingFeature\n']
 
2185
        self.assertEqual(1, len(skips))
 
2186
        test = skips[0]
 
2187
        # RemotedTestCase doesn't preserve the "details"
 
2188
        ## self.assertFalse('log' in test.getDetails())
 
2189
 
 
2190
    def test_xfail_has_no_log(self):
 
2191
        content, result = self.run_subunit_stream('test_xfail')
 
2192
        self.assertNotContainsRe(content, '(?m)^log$')
 
2193
        self.assertNotContainsRe(content, 'test with expected failure')
 
2194
        self.assertEqual(1, len(result.expectedFailures))
 
2195
        result_content = result.expectedFailures[0][1]
 
2196
        self.assertNotContainsRe(result_content, 'Text attachment: log')
 
2197
        self.assertNotContainsRe(result_content, 'test with expected failure')
 
2198
 
 
2199
    def test_unexpected_success_has_log(self):
 
2200
        content, result = self.run_subunit_stream('test_unexpected_success')
 
2201
        self.assertContainsRe(content, '(?m)^log$')
 
2202
        self.assertContainsRe(content, 'test with unexpected success')
 
2203
        # GZ 2011-05-18: Old versions of subunit treat unexpected success as a
 
2204
        #                success, if a min version check is added remove this
 
2205
        from subunit import TestProtocolClient as _Client
 
2206
        if _Client.addUnexpectedSuccess.im_func is _Client.addSuccess.im_func:
 
2207
            self.expectFailure('subunit treats "unexpectedSuccess"'
 
2208
                               ' as a plain success',
 
2209
                self.assertEqual, 1, len(result.unexpectedSuccesses))
 
2210
        self.assertEqual(1, len(result.unexpectedSuccesses))
 
2211
        test = result.unexpectedSuccesses[0]
 
2212
        # RemotedTestCase doesn't preserve the "details"
 
2213
        ## self.assertTrue('log' in test.getDetails())
 
2214
 
 
2215
    def test_success_has_no_log(self):
 
2216
        content, result = self.run_subunit_stream('test_success')
 
2217
        self.assertEqual(1, result.testsRun)
 
2218
        self.assertNotContainsRe(content, '(?m)^log$')
 
2219
        self.assertNotContainsRe(content, 'this test succeeds')
 
2220
 
 
2221
 
1974
2222
class TestRunBzr(tests.TestCase):
1975
2223
 
1976
2224
    out = ''
2099
2347
        # stdout and stderr of the invoked run_bzr
2100
2348
        current_factory = bzrlib.ui.ui_factory
2101
2349
        self.run_bzr(['foo'])
2102
 
        self.failIf(current_factory is self.factory)
 
2350
        self.assertFalse(current_factory is self.factory)
2103
2351
        self.assertNotEqual(sys.stdout, self.factory.stdout)
2104
2352
        self.assertNotEqual(sys.stderr, self.factory.stderr)
2105
2353
        self.assertEqual('foo\n', self.factory.stdout.getvalue())
2262
2510
 
2263
2511
 
2264
2512
class TestStartBzrSubProcess(tests.TestCase):
 
2513
    """Stub test start_bzr_subprocess."""
2265
2514
 
2266
 
    def check_popen_state(self):
2267
 
        """Replace to make assertions when popen is called."""
 
2515
    def _subprocess_log_cleanup(self):
 
2516
        """Inhibits the base version as we don't produce a log file."""
2268
2517
 
2269
2518
    def _popen(self, *args, **kwargs):
2270
 
        """Record the command that is run, so that we can ensure it is correct"""
 
2519
        """Override the base version to record the command that is run.
 
2520
 
 
2521
        From there we can ensure it is correct without spawning a real process.
 
2522
        """
2271
2523
        self.check_popen_state()
2272
2524
        self._popen_args = args
2273
2525
        self._popen_kwargs = kwargs
2274
2526
        raise _DontSpawnProcess()
2275
2527
 
 
2528
    def check_popen_state(self):
 
2529
        """Replace to make assertions when popen is called."""
 
2530
 
2276
2531
    def test_run_bzr_subprocess_no_plugins(self):
2277
2532
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
2278
2533
        command = self._popen_args[0]
2282
2537
 
2283
2538
    def test_allow_plugins(self):
2284
2539
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2285
 
            allow_plugins=True)
 
2540
                          allow_plugins=True)
2286
2541
        command = self._popen_args[0]
2287
2542
        self.assertEqual([], command[2:])
2288
2543
 
2289
2544
    def test_set_env(self):
2290
 
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
 
2545
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2291
2546
        # set in the child
2292
2547
        def check_environment():
2293
2548
            self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2294
2549
        self.check_popen_state = check_environment
2295
2550
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2296
 
            env_changes={'EXISTANT_ENV_VAR':'set variable'})
 
2551
                          env_changes={'EXISTANT_ENV_VAR':'set variable'})
2297
2552
        # not set in theparent
2298
2553
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2299
2554
 
2300
2555
    def test_run_bzr_subprocess_env_del(self):
2301
2556
        """run_bzr_subprocess can remove environment variables too."""
2302
 
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
 
2557
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2303
2558
        def check_environment():
2304
2559
            self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2305
2560
        os.environ['EXISTANT_ENV_VAR'] = 'set variable'
2306
2561
        self.check_popen_state = check_environment
2307
2562
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2308
 
            env_changes={'EXISTANT_ENV_VAR':None})
 
2563
                          env_changes={'EXISTANT_ENV_VAR':None})
2309
2564
        # Still set in parent
2310
2565
        self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2311
2566
        del os.environ['EXISTANT_ENV_VAR']
2312
2567
 
2313
2568
    def test_env_del_missing(self):
2314
 
        self.failIf('NON_EXISTANT_ENV_VAR' in os.environ)
 
2569
        self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2315
2570
        def check_environment():
2316
2571
            self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2317
2572
        self.check_popen_state = check_environment
2318
2573
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2319
 
            env_changes={'NON_EXISTANT_ENV_VAR':None})
 
2574
                          env_changes={'NON_EXISTANT_ENV_VAR':None})
2320
2575
 
2321
2576
    def test_working_dir(self):
2322
2577
        """Test that we can specify the working dir for the child"""
2325
2580
        chdirs = []
2326
2581
        def chdir(path):
2327
2582
            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
 
2583
        self.overrideAttr(os, 'chdir', chdir)
 
2584
        def getcwd():
 
2585
            return 'current'
 
2586
        self.overrideAttr(osutils, 'getcwd', getcwd)
 
2587
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2588
                          working_dir='foo')
2340
2589
        self.assertEqual(['foo', 'current'], chdirs)
2341
2590
 
 
2591
    def test_get_bzr_path_with_cwd_bzrlib(self):
 
2592
        self.get_source_path = lambda: ""
 
2593
        self.overrideAttr(os.path, "isfile", lambda path: True)
 
2594
        self.assertEqual(self.get_bzr_path(), "bzr")
 
2595
 
2342
2596
 
2343
2597
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
2344
2598
    """Tests that really need to do things with an external bzr."""
2357
2611
        self.assertEqual('bzr: interrupted\n', result[1])
2358
2612
 
2359
2613
 
2360
 
class TestFeature(tests.TestCase):
2361
 
 
2362
 
    def test_caching(self):
2363
 
        """Feature._probe is called by the feature at most once."""
2364
 
        class InstrumentedFeature(tests.Feature):
2365
 
            def __init__(self):
2366
 
                super(InstrumentedFeature, self).__init__()
2367
 
                self.calls = []
2368
 
            def _probe(self):
2369
 
                self.calls.append('_probe')
2370
 
                return False
2371
 
        feature = InstrumentedFeature()
2372
 
        feature.available()
2373
 
        self.assertEqual(['_probe'], feature.calls)
2374
 
        feature.available()
2375
 
        self.assertEqual(['_probe'], feature.calls)
2376
 
 
2377
 
    def test_named_str(self):
2378
 
        """Feature.__str__ should thunk to feature_name()."""
2379
 
        class NamedFeature(tests.Feature):
2380
 
            def feature_name(self):
2381
 
                return 'symlinks'
2382
 
        feature = NamedFeature()
2383
 
        self.assertEqual('symlinks', str(feature))
2384
 
 
2385
 
    def test_default_str(self):
2386
 
        """Feature.__str__ should default to __class__.__name__."""
2387
 
        class NamedFeature(tests.Feature):
2388
 
            pass
2389
 
        feature = NamedFeature()
2390
 
        self.assertEqual('NamedFeature', str(feature))
2391
 
 
2392
 
 
2393
 
class TestUnavailableFeature(tests.TestCase):
2394
 
 
2395
 
    def test_access_feature(self):
2396
 
        feature = tests.Feature()
2397
 
        exception = tests.UnavailableFeature(feature)
2398
 
        self.assertIs(feature, exception.args[0])
2399
 
 
2400
 
 
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
2614
class TestSelftestFiltering(tests.TestCase):
2435
2615
 
2436
2616
    def setUp(self):
2587
2767
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2588
2768
 
2589
2769
 
2590
 
class TestCheckInventoryShape(tests.TestCaseWithTransport):
 
2770
class TestCheckTreeShape(tests.TestCaseWithTransport):
2591
2771
 
2592
 
    def test_check_inventory_shape(self):
 
2772
    def test_check_tree_shape(self):
2593
2773
        files = ['a', 'b/', 'b/c']
2594
2774
        tree = self.make_branch_and_tree('.')
2595
2775
        self.build_tree(files)
2596
2776
        tree.add(files)
2597
2777
        tree.lock_read()
2598
2778
        try:
2599
 
            self.check_inventory_shape(tree.inventory, files)
 
2779
            self.check_tree_shape(tree, files)
2600
2780
        finally:
2601
2781
            tree.unlock()
2602
2782
 
2934
3114
        tpr.register('bar', 'bBB.aAA.rRR')
2935
3115
        self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
2936
3116
        self.assertThat(self.get_log(),
2937
 
            DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR", ELLIPSIS))
 
3117
            DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR",
 
3118
                           doctest.ELLIPSIS))
2938
3119
 
2939
3120
    def test_get_unknown_prefix(self):
2940
3121
        tpr = self._get_registry()
2960
3141
        self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
2961
3142
 
2962
3143
 
 
3144
class TestThreadLeakDetection(tests.TestCase):
 
3145
    """Ensure when tests leak threads we detect and report it"""
 
3146
 
 
3147
    class LeakRecordingResult(tests.ExtendedTestResult):
 
3148
        def __init__(self):
 
3149
            tests.ExtendedTestResult.__init__(self, StringIO(), 0, 1)
 
3150
            self.leaks = []
 
3151
        def _report_thread_leak(self, test, leaks, alive):
 
3152
            self.leaks.append((test, leaks))
 
3153
 
 
3154
    def test_testcase_without_addCleanups(self):
 
3155
        """Check old TestCase instances don't break with leak detection"""
 
3156
        class Test(unittest.TestCase):
 
3157
            def runTest(self):
 
3158
                pass
 
3159
        result = self.LeakRecordingResult()
 
3160
        test = Test()
 
3161
        result.startTestRun()
 
3162
        test.run(result)
 
3163
        result.stopTestRun()
 
3164
        self.assertEqual(result._tests_leaking_threads_count, 0)
 
3165
        self.assertEqual(result.leaks, [])
 
3166
        
 
3167
    def test_thread_leak(self):
 
3168
        """Ensure a thread that outlives the running of a test is reported
 
3169
 
 
3170
        Uses a thread that blocks on an event, and is started by the inner
 
3171
        test case. As the thread outlives the inner case's run, it should be
 
3172
        detected as a leak, but the event is then set so that the thread can
 
3173
        be safely joined in cleanup so it's not leaked for real.
 
3174
        """
 
3175
        event = threading.Event()
 
3176
        thread = threading.Thread(name="Leaker", target=event.wait)
 
3177
        class Test(tests.TestCase):
 
3178
            def test_leak(self):
 
3179
                thread.start()
 
3180
        result = self.LeakRecordingResult()
 
3181
        test = Test("test_leak")
 
3182
        self.addCleanup(thread.join)
 
3183
        self.addCleanup(event.set)
 
3184
        result.startTestRun()
 
3185
        test.run(result)
 
3186
        result.stopTestRun()
 
3187
        self.assertEqual(result._tests_leaking_threads_count, 1)
 
3188
        self.assertEqual(result._first_thread_leaker_id, test.id())
 
3189
        self.assertEqual(result.leaks, [(test, set([thread]))])
 
3190
        self.assertContainsString(result.stream.getvalue(), "leaking threads")
 
3191
 
 
3192
    def test_multiple_leaks(self):
 
3193
        """Check multiple leaks are blamed on the test cases at fault
 
3194
 
 
3195
        Same concept as the previous test, but has one inner test method that
 
3196
        leaks two threads, and one that doesn't leak at all.
 
3197
        """
 
3198
        event = threading.Event()
 
3199
        thread_a = threading.Thread(name="LeakerA", target=event.wait)
 
3200
        thread_b = threading.Thread(name="LeakerB", target=event.wait)
 
3201
        thread_c = threading.Thread(name="LeakerC", target=event.wait)
 
3202
        class Test(tests.TestCase):
 
3203
            def test_first_leak(self):
 
3204
                thread_b.start()
 
3205
            def test_second_no_leak(self):
 
3206
                pass
 
3207
            def test_third_leak(self):
 
3208
                thread_c.start()
 
3209
                thread_a.start()
 
3210
        result = self.LeakRecordingResult()
 
3211
        first_test = Test("test_first_leak")
 
3212
        third_test = Test("test_third_leak")
 
3213
        self.addCleanup(thread_a.join)
 
3214
        self.addCleanup(thread_b.join)
 
3215
        self.addCleanup(thread_c.join)
 
3216
        self.addCleanup(event.set)
 
3217
        result.startTestRun()
 
3218
        unittest.TestSuite(
 
3219
            [first_test, Test("test_second_no_leak"), third_test]
 
3220
            ).run(result)
 
3221
        result.stopTestRun()
 
3222
        self.assertEqual(result._tests_leaking_threads_count, 2)
 
3223
        self.assertEqual(result._first_thread_leaker_id, first_test.id())
 
3224
        self.assertEqual(result.leaks, [
 
3225
            (first_test, set([thread_b])),
 
3226
            (third_test, set([thread_a, thread_c]))])
 
3227
        self.assertContainsString(result.stream.getvalue(), "leaking threads")
 
3228
 
 
3229
 
 
3230
class TestPostMortemDebugging(tests.TestCase):
 
3231
    """Check post mortem debugging works when tests fail or error"""
 
3232
 
 
3233
    class TracebackRecordingResult(tests.ExtendedTestResult):
 
3234
        def __init__(self):
 
3235
            tests.ExtendedTestResult.__init__(self, StringIO(), 0, 1)
 
3236
            self.postcode = None
 
3237
        def _post_mortem(self, tb=None):
 
3238
            """Record the code object at the end of the current traceback"""
 
3239
            tb = tb or sys.exc_info()[2]
 
3240
            if tb is not None:
 
3241
                next = tb.tb_next
 
3242
                while next is not None:
 
3243
                    tb = next
 
3244
                    next = next.tb_next
 
3245
                self.postcode = tb.tb_frame.f_code
 
3246
        def report_error(self, test, err):
 
3247
            pass
 
3248
        def report_failure(self, test, err):
 
3249
            pass
 
3250
 
 
3251
    def test_location_unittest_error(self):
 
3252
        """Needs right post mortem traceback with erroring unittest case"""
 
3253
        class Test(unittest.TestCase):
 
3254
            def runTest(self):
 
3255
                raise RuntimeError
 
3256
        result = self.TracebackRecordingResult()
 
3257
        Test().run(result)
 
3258
        self.assertEqual(result.postcode, Test.runTest.func_code)
 
3259
 
 
3260
    def test_location_unittest_failure(self):
 
3261
        """Needs right post mortem traceback with failing unittest case"""
 
3262
        class Test(unittest.TestCase):
 
3263
            def runTest(self):
 
3264
                raise self.failureException
 
3265
        result = self.TracebackRecordingResult()
 
3266
        Test().run(result)
 
3267
        self.assertEqual(result.postcode, Test.runTest.func_code)
 
3268
 
 
3269
    def test_location_bt_error(self):
 
3270
        """Needs right post mortem traceback with erroring bzrlib.tests case"""
 
3271
        class Test(tests.TestCase):
 
3272
            def test_error(self):
 
3273
                raise RuntimeError
 
3274
        result = self.TracebackRecordingResult()
 
3275
        Test("test_error").run(result)
 
3276
        self.assertEqual(result.postcode, Test.test_error.func_code)
 
3277
 
 
3278
    def test_location_bt_failure(self):
 
3279
        """Needs right post mortem traceback with failing bzrlib.tests case"""
 
3280
        class Test(tests.TestCase):
 
3281
            def test_failure(self):
 
3282
                raise self.failureException
 
3283
        result = self.TracebackRecordingResult()
 
3284
        Test("test_failure").run(result)
 
3285
        self.assertEqual(result.postcode, Test.test_failure.func_code)
 
3286
 
 
3287
    def test_env_var_triggers_post_mortem(self):
 
3288
        """Check pdb.post_mortem is called iff BZR_TEST_PDB is set"""
 
3289
        import pdb
 
3290
        result = tests.ExtendedTestResult(StringIO(), 0, 1)
 
3291
        post_mortem_calls = []
 
3292
        self.overrideAttr(pdb, "post_mortem", post_mortem_calls.append)
 
3293
        self.overrideEnv('BZR_TEST_PDB', None)
 
3294
        result._post_mortem(1)
 
3295
        self.overrideEnv('BZR_TEST_PDB', 'on')
 
3296
        result._post_mortem(2)
 
3297
        self.assertEqual([2], post_mortem_calls)
 
3298
 
 
3299
 
2963
3300
class TestRunSuite(tests.TestCase):
2964
3301
 
2965
3302
    def test_runner_class(self):
2976
3313
                                                self.verbosity)
2977
3314
        tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
2978
3315
        self.assertLength(1, calls)
 
3316
 
 
3317
 
 
3318
class TestUncollectedWarnings(tests.TestCase):
 
3319
    """Check a test case still alive after being run emits a warning"""
 
3320
 
 
3321
    class Test(tests.TestCase):
 
3322
        def test_pass(self):
 
3323
            pass
 
3324
        def test_self_ref(self):
 
3325
            self.also_self = self.test_self_ref
 
3326
        def test_skip(self):
 
3327
            self.skip("Don't need")
 
3328
 
 
3329
    def _get_suite(self):
 
3330
        return TestUtil.TestSuite([
 
3331
            self.Test("test_pass"),
 
3332
            self.Test("test_self_ref"),
 
3333
            self.Test("test_skip"),
 
3334
            ])
 
3335
 
 
3336
    def _inject_stream_into_subunit(self, stream):
 
3337
        """To be overridden by subclasses that run tests out of process"""
 
3338
 
 
3339
    def _run_selftest_with_suite(self, **kwargs):
 
3340
        sio = StringIO()
 
3341
        self._inject_stream_into_subunit(sio)
 
3342
        old_flags = tests.selftest_debug_flags
 
3343
        tests.selftest_debug_flags = old_flags.union(["uncollected_cases"])
 
3344
        gc_on = gc.isenabled()
 
3345
        if gc_on:
 
3346
            gc.disable()
 
3347
        try:
 
3348
            tests.selftest(test_suite_factory=self._get_suite, stream=sio,
 
3349
                stop_on_failure=False, **kwargs)
 
3350
        finally:
 
3351
            if gc_on:
 
3352
                gc.enable()
 
3353
            tests.selftest_debug_flags = old_flags
 
3354
        output = sio.getvalue()
 
3355
        self.assertNotContainsRe(output, "Uncollected test case.*test_pass")
 
3356
        self.assertContainsRe(output, "Uncollected test case.*test_self_ref")
 
3357
        return output
 
3358
 
 
3359
    def test_testsuite(self):
 
3360
        self._run_selftest_with_suite()
 
3361
 
 
3362
    def test_pattern(self):
 
3363
        out = self._run_selftest_with_suite(pattern="test_(?:pass|self_ref)$")
 
3364
        self.assertNotContainsRe(out, "test_skip")
 
3365
 
 
3366
    def test_exclude_pattern(self):
 
3367
        out = self._run_selftest_with_suite(exclude_pattern="test_skip$")
 
3368
        self.assertNotContainsRe(out, "test_skip")
 
3369
 
 
3370
    def test_random_seed(self):
 
3371
        self._run_selftest_with_suite(random_seed="now")
 
3372
 
 
3373
    def test_matching_tests_first(self):
 
3374
        self._run_selftest_with_suite(matching_tests_first=True,
 
3375
            pattern="test_self_ref$")
 
3376
 
 
3377
    def test_starting_with_and_exclude(self):
 
3378
        out = self._run_selftest_with_suite(starting_with=["bt."],
 
3379
            exclude_pattern="test_skip$")
 
3380
        self.assertNotContainsRe(out, "test_skip")
 
3381
 
 
3382
    def test_additonal_decorator(self):
 
3383
        out = self._run_selftest_with_suite(
 
3384
            suite_decorators=[tests.TestDecorator])
 
3385
 
 
3386
 
 
3387
class TestUncollectedWarningsSubunit(TestUncollectedWarnings):
 
3388
    """Check warnings from tests staying alive are emitted with subunit"""
 
3389
 
 
3390
    _test_needs_features = [features.subunit]
 
3391
 
 
3392
    def _run_selftest_with_suite(self, **kwargs):
 
3393
        return TestUncollectedWarnings._run_selftest_with_suite(self,
 
3394
            runner_class=tests.SubUnitBzrRunner, **kwargs)
 
3395
 
 
3396
 
 
3397
class TestUncollectedWarningsForking(TestUncollectedWarnings):
 
3398
    """Check warnings from tests staying alive are emitted when forking"""
 
3399
 
 
3400
    _test_needs_features = [features.subunit]
 
3401
 
 
3402
    def _inject_stream_into_subunit(self, stream):
 
3403
        """Monkey-patch subunit so the extra output goes to stream not stdout
 
3404
 
 
3405
        Some APIs need rewriting so this kind of bogus hackery can be replaced
 
3406
        by passing the stream param from run_tests down into ProtocolTestCase.
 
3407
        """
 
3408
        from subunit import ProtocolTestCase
 
3409
        _original_init = ProtocolTestCase.__init__
 
3410
        def _init_with_passthrough(self, *args, **kwargs):
 
3411
            _original_init(self, *args, **kwargs)
 
3412
            self._passthrough = stream
 
3413
        self.overrideAttr(ProtocolTestCase, "__init__", _init_with_passthrough)
 
3414
 
 
3415
    def _run_selftest_with_suite(self, **kwargs):
 
3416
        # GZ 2011-05-26: Add a PosixSystem feature so this check can go away
 
3417
        if getattr(os, "fork", None) is None:
 
3418
            raise tests.TestNotApplicable("Platform doesn't support forking")
 
3419
        # Make sure the fork code is actually invoked by claiming two cores
 
3420
        self.overrideAttr(osutils, "local_concurrency", lambda: 2)
 
3421
        kwargs.setdefault("suite_decorators", []).append(tests.fork_decorator)
 
3422
        return TestUncollectedWarnings._run_selftest_with_suite(self, **kwargs)
 
3423
 
 
3424
 
 
3425
class TestEnvironHandling(tests.TestCase):
 
3426
 
 
3427
    def test_overrideEnv_None_called_twice_doesnt_leak(self):
 
3428
        self.assertFalse('MYVAR' in os.environ)
 
3429
        self.overrideEnv('MYVAR', '42')
 
3430
        # We use an embedded test to make sure we fix the _captureVar bug
 
3431
        class Test(tests.TestCase):
 
3432
            def test_me(self):
 
3433
                # The first call save the 42 value
 
3434
                self.overrideEnv('MYVAR', None)
 
3435
                self.assertEquals(None, os.environ.get('MYVAR'))
 
3436
                # Make sure we can call it twice
 
3437
                self.overrideEnv('MYVAR', None)
 
3438
                self.assertEquals(None, os.environ.get('MYVAR'))
 
3439
        output = StringIO()
 
3440
        result = tests.TextTestResult(output, 0, 1)
 
3441
        Test('test_me').run(result)
 
3442
        if not result.wasStrictlySuccessful():
 
3443
            self.fail(output.getvalue())
 
3444
        # We get our value back
 
3445
        self.assertEquals('42', os.environ.get('MYVAR'))
 
3446
 
 
3447
 
 
3448
class TestIsolatedEnv(tests.TestCase):
 
3449
    """Test isolating tests from os.environ.
 
3450
 
 
3451
    Since we use tests that are already isolated from os.environ a bit of care
 
3452
    should be taken when designing the tests to avoid bootstrap side-effects.
 
3453
    The tests start an already clean os.environ which allow doing valid
 
3454
    assertions about which variables are present or not and design tests around
 
3455
    these assertions.
 
3456
    """
 
3457
 
 
3458
    class ScratchMonkey(tests.TestCase):
 
3459
 
 
3460
        def test_me(self):
 
3461
            pass
 
3462
 
 
3463
    def test_basics(self):
 
3464
        # Make sure we know the definition of BZR_HOME: not part of os.environ
 
3465
        # for tests.TestCase.
 
3466
        self.assertTrue('BZR_HOME' in tests.isolated_environ)
 
3467
        self.assertEquals(None, tests.isolated_environ['BZR_HOME'])
 
3468
        # Being part of isolated_environ, BZR_HOME should not appear here
 
3469
        self.assertFalse('BZR_HOME' in os.environ)
 
3470
        # Make sure we know the definition of LINES: part of os.environ for
 
3471
        # tests.TestCase
 
3472
        self.assertTrue('LINES' in tests.isolated_environ)
 
3473
        self.assertEquals('25', tests.isolated_environ['LINES'])
 
3474
        self.assertEquals('25', os.environ['LINES'])
 
3475
 
 
3476
    def test_injecting_unknown_variable(self):
 
3477
        # BZR_HOME is known to be absent from os.environ
 
3478
        test = self.ScratchMonkey('test_me')
 
3479
        tests.override_os_environ(test, {'BZR_HOME': 'foo'})
 
3480
        self.assertEquals('foo', os.environ['BZR_HOME'])
 
3481
        tests.restore_os_environ(test)
 
3482
        self.assertFalse('BZR_HOME' in os.environ)
 
3483
 
 
3484
    def test_injecting_known_variable(self):
 
3485
        test = self.ScratchMonkey('test_me')
 
3486
        # LINES is known to be present in os.environ
 
3487
        tests.override_os_environ(test, {'LINES': '42'})
 
3488
        self.assertEquals('42', os.environ['LINES'])
 
3489
        tests.restore_os_environ(test)
 
3490
        self.assertEquals('25', os.environ['LINES'])
 
3491
 
 
3492
    def test_deleting_variable(self):
 
3493
        test = self.ScratchMonkey('test_me')
 
3494
        # LINES is known to be present in os.environ
 
3495
        tests.override_os_environ(test, {'LINES': None})
 
3496
        self.assertTrue('LINES' not in os.environ)
 
3497
        tests.restore_os_environ(test)
 
3498
        self.assertEquals('25', os.environ['LINES'])
 
3499
 
 
3500
 
 
3501
class TestDocTestSuiteIsolation(tests.TestCase):
 
3502
    """Test that `tests.DocTestSuite` isolates doc tests from os.environ.
 
3503
 
 
3504
    Since tests.TestCase alreay provides an isolation from os.environ, we use
 
3505
    the clean environment as a base for testing. To precisely capture the
 
3506
    isolation provided by tests.DocTestSuite, we use doctest.DocTestSuite to
 
3507
    compare against.
 
3508
 
 
3509
    We want to make sure `tests.DocTestSuite` respect `tests.isolated_environ`,
 
3510
    not `os.environ` so each test overrides it to suit its needs.
 
3511
 
 
3512
    """
 
3513
 
 
3514
    def get_doctest_suite_for_string(self, klass, string):
 
3515
        class Finder(doctest.DocTestFinder):
 
3516
 
 
3517
            def find(*args, **kwargs):
 
3518
                test = doctest.DocTestParser().get_doctest(
 
3519
                    string, {}, 'foo', 'foo.py', 0)
 
3520
                return [test]
 
3521
 
 
3522
        suite = klass(test_finder=Finder())
 
3523
        return suite
 
3524
 
 
3525
    def run_doctest_suite_for_string(self, klass, string):
 
3526
        suite = self.get_doctest_suite_for_string(klass, string)
 
3527
        output = StringIO()
 
3528
        result = tests.TextTestResult(output, 0, 1)
 
3529
        suite.run(result)
 
3530
        return result, output
 
3531
 
 
3532
    def assertDocTestStringSucceds(self, klass, string):
 
3533
        result, output = self.run_doctest_suite_for_string(klass, string)
 
3534
        if not result.wasStrictlySuccessful():
 
3535
            self.fail(output.getvalue())
 
3536
 
 
3537
    def assertDocTestStringFails(self, klass, string):
 
3538
        result, output = self.run_doctest_suite_for_string(klass, string)
 
3539
        if result.wasStrictlySuccessful():
 
3540
            self.fail(output.getvalue())
 
3541
 
 
3542
    def test_injected_variable(self):
 
3543
        self.overrideAttr(tests, 'isolated_environ', {'LINES': '42'})
 
3544
        test = """
 
3545
            >>> import os
 
3546
            >>> os.environ['LINES']
 
3547
            '42'
 
3548
            """
 
3549
        # doctest.DocTestSuite fails as it sees '25'
 
3550
        self.assertDocTestStringFails(doctest.DocTestSuite, test)
 
3551
        # tests.DocTestSuite sees '42'
 
3552
        self.assertDocTestStringSucceds(tests.IsolatedDocTestSuite, test)
 
3553
 
 
3554
    def test_deleted_variable(self):
 
3555
        self.overrideAttr(tests, 'isolated_environ', {'LINES': None})
 
3556
        test = """
 
3557
            >>> import os
 
3558
            >>> os.environ.get('LINES')
 
3559
            """
 
3560
        # doctest.DocTestSuite fails as it sees '25'
 
3561
        self.assertDocTestStringFails(doctest.DocTestSuite, test)
 
3562
        # tests.DocTestSuite sees None
 
3563
        self.assertDocTestStringSucceds(tests.IsolatedDocTestSuite, test)
 
3564
 
 
3565
 
 
3566
class TestSelftestExcludePatterns(tests.TestCase):
 
3567
 
 
3568
    def setUp(self):
 
3569
        super(TestSelftestExcludePatterns, self).setUp()
 
3570
        self.overrideAttr(tests, 'test_suite', self.suite_factory)
 
3571
 
 
3572
    def suite_factory(self, keep_only=None, starting_with=None):
 
3573
        """A test suite factory with only a few tests."""
 
3574
        class Test(tests.TestCase):
 
3575
            def id(self):
 
3576
                # We don't need the full class path
 
3577
                return self._testMethodName
 
3578
            def a(self):
 
3579
                pass
 
3580
            def b(self):
 
3581
                pass
 
3582
            def c(self):
 
3583
                pass
 
3584
        return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
 
3585
 
 
3586
    def assertTestList(self, expected, *selftest_args):
 
3587
        # We rely on setUp installing the right test suite factory so we can
 
3588
        # test at the command level without loading the whole test suite
 
3589
        out, err = self.run_bzr(('selftest', '--list') + selftest_args)
 
3590
        actual = out.splitlines()
 
3591
        self.assertEquals(expected, actual)
 
3592
 
 
3593
    def test_full_list(self):
 
3594
        self.assertTestList(['a', 'b', 'c'])
 
3595
 
 
3596
    def test_single_exclude(self):
 
3597
        self.assertTestList(['b', 'c'], '-x', 'a')
 
3598
 
 
3599
    def test_mutiple_excludes(self):
 
3600
        self.assertTestList(['c'], '-x', 'a', '-x', 'b')
 
3601
 
 
3602
 
 
3603
class TestCounterHooks(tests.TestCase, SelfTestHelper):
 
3604
 
 
3605
    _test_needs_features = [features.subunit]
 
3606
 
 
3607
    def setUp(self):
 
3608
        super(TestCounterHooks, self).setUp()
 
3609
        class Test(tests.TestCase):
 
3610
 
 
3611
            def setUp(self):
 
3612
                super(Test, self).setUp()
 
3613
                self.hooks = hooks.Hooks()
 
3614
                self.hooks.add_hook('myhook', 'Foo bar blah', (2,4))
 
3615
                self.install_counter_hook(self.hooks, 'myhook')
 
3616
 
 
3617
            def no_hook(self):
 
3618
                pass
 
3619
 
 
3620
            def run_hook_once(self):
 
3621
                for hook in self.hooks['myhook']:
 
3622
                    hook(self)
 
3623
 
 
3624
        self.test_class = Test
 
3625
 
 
3626
    def assertHookCalls(self, expected_calls, test_name):
 
3627
        test = self.test_class(test_name)
 
3628
        result = unittest.TestResult()
 
3629
        test.run(result)
 
3630
        self.assertTrue(hasattr(test, '_counters'))
 
3631
        self.assertTrue(test._counters.has_key('myhook'))
 
3632
        self.assertEquals(expected_calls, test._counters['myhook'])
 
3633
 
 
3634
    def test_no_hook(self):
 
3635
        self.assertHookCalls(0, 'no_hook')
 
3636
 
 
3637
    def test_run_hook_once(self):
 
3638
        tt = features.testtools
 
3639
        if tt.module.__version__ < (0, 9, 8):
 
3640
            raise tests.TestSkipped('testtools-0.9.8 required for addDetail')
 
3641
        self.assertHookCalls(1, 'run_hook_once')