~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-01-14 00:01:32 UTC
  • mfrom: (4957.1.1 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100114000132-3p3rabnonjw3gzqb
(jam) Merge bzr.stable, bringing in bug fixes #175839, #504390

Show diffs side-by-side

added added

removed removed

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