~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
16
16
 
17
17
"""Tests for the test framework."""
18
18
 
19
 
from cStringIO import StringIO
20
 
import doctest
 
19
import cStringIO
21
20
import os
22
 
import signal
 
21
from StringIO import StringIO
23
22
import sys
24
 
import threading
25
23
import time
26
24
import unittest
27
25
import warnings
28
26
 
29
 
from testtools import (
30
 
    ExtendedToOriginalDecorator,
31
 
    MultiTestResult,
32
 
    )
33
 
from testtools.content import Content
34
 
from testtools.content_type import ContentType
35
 
from testtools.matchers import (
36
 
    DocTestMatches,
37
 
    Equals,
38
 
    )
39
 
import testtools.tests.helpers
40
 
 
41
27
import bzrlib
42
28
from bzrlib import (
43
29
    branchbuilder,
44
30
    bzrdir,
 
31
    debug,
45
32
    errors,
46
33
    lockdir,
47
34
    memorytree,
50
37
    repository,
51
38
    symbol_versioning,
52
39
    tests,
53
 
    transport,
54
40
    workingtree,
55
 
    workingtree_3,
56
 
    workingtree_4,
57
41
    )
 
42
from bzrlib.progress import _BaseProgressBar
58
43
from bzrlib.repofmt import (
59
 
    groupcompress_repo,
 
44
    pack_repo,
 
45
    weaverepo,
60
46
    )
61
47
from bzrlib.symbol_versioning import (
62
48
    deprecated_function,
64
50
    deprecated_method,
65
51
    )
66
52
from bzrlib.tests import (
67
 
    features,
68
 
    test_lsprof,
69
 
    test_server,
70
 
    TestUtil,
71
 
    )
72
 
from bzrlib.trace import note, mutter
73
 
from bzrlib.transport import memory
 
53
                          ChrootedTestCase,
 
54
                          ExtendedTestResult,
 
55
                          Feature,
 
56
                          KnownFailure,
 
57
                          TestCase,
 
58
                          TestCaseInTempDir,
 
59
                          TestCaseWithMemoryTransport,
 
60
                          TestCaseWithTransport,
 
61
                          TestNotApplicable,
 
62
                          TestSkipped,
 
63
                          TestSuite,
 
64
                          TestUtil,
 
65
                          TextTestRunner,
 
66
                          UnavailableFeature,
 
67
                          condition_id_re,
 
68
                          condition_isinstance,
 
69
                          exclude_tests_by_condition,
 
70
                          exclude_tests_by_re,
 
71
                          filter_suite_by_condition,
 
72
                          filter_suite_by_re,
 
73
                          iter_suite_tests,
 
74
                          preserve_input,
 
75
                          randomize_suite,
 
76
                          run_suite,
 
77
                          split_suite_by_condition,
 
78
                          split_suite_by_re,
 
79
                          test_lsprof,
 
80
                          test_suite,
 
81
                          )
 
82
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
 
83
from bzrlib.tests.TestUtil import _load_module_by_name
 
84
from bzrlib.trace import note
 
85
from bzrlib.transport.memory import MemoryServer, MemoryTransport
 
86
from bzrlib.version import _get_bzr_source_tree
74
87
 
75
88
 
76
89
def _test_ids(test_suite):
77
90
    """Get the ids for the tests in a test suite."""
78
 
    return [t.id() for t in tests.iter_suite_tests(test_suite)]
79
 
 
80
 
 
81
 
class MetaTestLog(tests.TestCase):
 
91
    return [t.id() for t in iter_suite_tests(test_suite)]
 
92
 
 
93
 
 
94
class SelftestTests(TestCase):
 
95
 
 
96
    def test_import_tests(self):
 
97
        mod = _load_module_by_name('bzrlib.tests.test_selftest')
 
98
        self.assertEqual(mod.SelftestTests, SelftestTests)
 
99
 
 
100
    def test_import_test_failure(self):
 
101
        self.assertRaises(ImportError,
 
102
                          _load_module_by_name,
 
103
                          'bzrlib.no-name-yet')
 
104
 
 
105
class MetaTestLog(TestCase):
82
106
 
83
107
    def test_logging(self):
84
108
        """Test logs are captured when a test fails."""
85
109
        self.log('a test message')
86
 
        details = self.getDetails()
87
 
        log = details['log']
88
 
        self.assertThat(log.content_type, Equals(ContentType(
89
 
            "text", "plain", {"charset": "utf8"})))
90
 
        self.assertThat(u"".join(log.iter_text()), Equals(self.get_log()))
91
 
        self.assertThat(self.get_log(),
92
 
            DocTestMatches(u"...a test message\n", doctest.ELLIPSIS))
93
 
 
94
 
 
95
 
class TestUnicodeFilename(tests.TestCase):
 
110
        self._log_file.flush()
 
111
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
112
                              'a test message\n')
 
113
 
 
114
 
 
115
class TestUnicodeFilename(TestCase):
96
116
 
97
117
    def test_probe_passes(self):
98
118
        """UnicodeFilename._probe passes."""
101
121
        tests.UnicodeFilename._probe()
102
122
 
103
123
 
104
 
class TestTreeShape(tests.TestCaseInTempDir):
 
124
class TestTreeShape(TestCaseInTempDir):
105
125
 
106
126
    def test_unicode_paths(self):
107
127
        self.requireFeature(tests.UnicodeFilename)
108
128
 
109
129
        filename = u'hell\u00d8'
110
130
        self.build_tree_contents([(filename, 'contents of hello')])
111
 
        self.assertPathExists(filename)
112
 
 
113
 
 
114
 
class TestClassesAvailable(tests.TestCase):
115
 
    """As a convenience we expose Test* classes from bzrlib.tests"""
116
 
 
117
 
    def test_test_case(self):
118
 
        from bzrlib.tests import TestCase
119
 
 
120
 
    def test_test_loader(self):
121
 
        from bzrlib.tests import TestLoader
122
 
 
123
 
    def test_test_suite(self):
124
 
        from bzrlib.tests import TestSuite
125
 
 
126
 
 
127
 
class TestTransportScenarios(tests.TestCase):
 
131
        self.failUnlessExists(filename)
 
132
 
 
133
 
 
134
class TestTransportScenarios(TestCase):
128
135
    """A group of tests that test the transport implementation adaption core.
129
136
 
130
137
    This is a meta test that the tests are applied to all available
141
148
            def get_test_permutations(self):
142
149
                return sample_permutation
143
150
        sample_permutation = [(1,2), (3,4)]
144
 
        from bzrlib.tests.per_transport import get_transport_test_permutations
 
151
        from bzrlib.tests.test_transport_implementations \
 
152
            import get_transport_test_permutations
145
153
        self.assertEqual(sample_permutation,
146
154
                         get_transport_test_permutations(MockModule()))
147
155
 
148
 
    def test_scenarios_include_all_modules(self):
 
156
    def test_scenarios_invlude_all_modules(self):
149
157
        # this checks that the scenario generator returns as many permutations
150
158
        # as there are in all the registered transport modules - we assume if
151
159
        # this matches its probably doing the right thing especially in
152
160
        # combination with the tests for setting the right classes below.
153
 
        from bzrlib.tests.per_transport import transport_test_permutations
 
161
        from bzrlib.tests.test_transport_implementations \
 
162
            import transport_test_permutations
154
163
        from bzrlib.transport import _get_transport_modules
155
164
        modules = _get_transport_modules()
156
165
        permutation_count = 0
168
177
        # This test used to know about all the possible transports and the
169
178
        # order they were returned but that seems overly brittle (mbp
170
179
        # 20060307)
171
 
        from bzrlib.tests.per_transport import transport_test_permutations
 
180
        from bzrlib.tests.test_transport_implementations \
 
181
            import transport_test_permutations
172
182
        scenarios = transport_test_permutations()
173
183
        # there are at least that many builtin transports
174
184
        self.assertTrue(len(scenarios) > 6)
180
190
                                   bzrlib.transport.Server))
181
191
 
182
192
 
183
 
class TestBranchScenarios(tests.TestCase):
 
193
class TestBranchScenarios(TestCase):
184
194
 
185
195
    def test_scenarios(self):
186
196
        # check that constructor parameters are passed through to the adapted
187
197
        # test.
188
 
        from bzrlib.tests.per_branch import make_scenarios
 
198
        from bzrlib.tests.branch_implementations import make_scenarios
189
199
        server1 = "a"
190
200
        server2 = "b"
191
201
        formats = [("c", "C"), ("d", "D")]
205
215
            scenarios)
206
216
 
207
217
 
208
 
class TestBzrDirScenarios(tests.TestCase):
 
218
class TestBzrDirScenarios(TestCase):
209
219
 
210
220
    def test_scenarios(self):
211
221
        # check that constructor parameters are passed through to the adapted
212
222
        # test.
213
 
        from bzrlib.tests.per_controldir import make_scenarios
 
223
        from bzrlib.tests.bzrdir_implementations import make_scenarios
214
224
        vfs_factory = "v"
215
225
        server1 = "a"
216
226
        server2 = "b"
230
240
            scenarios)
231
241
 
232
242
 
233
 
class TestRepositoryScenarios(tests.TestCase):
 
243
class TestRepositoryScenarios(TestCase):
234
244
 
235
245
    def test_formats_to_scenarios(self):
236
246
        from bzrlib.tests.per_repository import formats_to_scenarios
237
247
        formats = [("(c)", remote.RemoteRepositoryFormat()),
238
248
                   ("(d)", repository.format_registry.get(
239
 
                    'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
 
249
                        'Bazaar pack repository format 1 (needs bzr 0.92)\n'))]
240
250
        no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
241
251
            None)
242
252
        vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
243
253
            vfs_transport_factory="vfs")
244
254
        # no_vfs generate scenarios without vfs_transport_factory
245
 
        expected = [
 
255
        self.assertEqual([
246
256
            ('RemoteRepositoryFormat(c)',
247
257
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
248
258
              'repository_format': remote.RemoteRepositoryFormat(),
249
259
              'transport_readonly_server': 'readonly',
250
260
              'transport_server': 'server'}),
251
 
            ('RepositoryFormat2a(d)',
 
261
            ('RepositoryFormatKnitPack1(d)',
252
262
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
253
 
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
263
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
254
264
              'transport_readonly_server': 'readonly',
255
 
              'transport_server': 'server'})]
256
 
        self.assertEqual(expected, no_vfs_scenarios)
 
265
              'transport_server': 'server'})],
 
266
            no_vfs_scenarios)
257
267
        self.assertEqual([
258
268
            ('RemoteRepositoryFormat(c)',
259
269
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
261
271
              'transport_readonly_server': 'readonly',
262
272
              'transport_server': 'server',
263
273
              'vfs_transport_factory': 'vfs'}),
264
 
            ('RepositoryFormat2a(d)',
 
274
            ('RepositoryFormatKnitPack1(d)',
265
275
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
266
 
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
276
              'repository_format': pack_repo.RepositoryFormatKnitPack1(),
267
277
              'transport_readonly_server': 'readonly',
268
278
              'transport_server': 'server',
269
279
              'vfs_transport_factory': 'vfs'})],
270
280
            vfs_scenarios)
271
281
 
272
282
 
273
 
class TestTestScenarioApplication(tests.TestCase):
 
283
class TestTestScenarioApplication(TestCase):
274
284
    """Tests for the test adaption facilities."""
275
285
 
276
286
    def test_apply_scenario(self):
306
316
            adapted_test2.id())
307
317
 
308
318
 
309
 
class TestInterRepositoryScenarios(tests.TestCase):
 
319
class TestInterRepositoryScenarios(TestCase):
310
320
 
311
321
    def test_scenarios(self):
312
322
        # check that constructor parameters are passed through to the adapted
313
323
        # test.
314
 
        from bzrlib.tests.per_interrepository import make_scenarios
 
324
        from bzrlib.tests.interrepository_implementations import \
 
325
            make_scenarios
315
326
        server1 = "a"
316
327
        server2 = "b"
317
 
        formats = [("C0", "C1", "C2", "C3"), ("D0", "D1", "D2", "D3")]
 
328
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
318
329
        scenarios = make_scenarios(server1, server2, formats)
319
330
        self.assertEqual([
320
 
            ('C0,str,str',
321
 
             {'repository_format': 'C1',
 
331
            ('str,str,str',
 
332
             {'interrepo_class': str,
 
333
              'repository_format': 'C1',
322
334
              'repository_format_to': 'C2',
323
335
              'transport_readonly_server': 'b',
324
 
              'transport_server': 'a',
325
 
              'extra_setup': 'C3'}),
326
 
            ('D0,str,str',
327
 
             {'repository_format': 'D1',
 
336
              'transport_server': 'a'}),
 
337
            ('int,str,str',
 
338
             {'interrepo_class': int,
 
339
              'repository_format': 'D1',
328
340
              'repository_format_to': 'D2',
329
341
              'transport_readonly_server': 'b',
330
 
              'transport_server': 'a',
331
 
              'extra_setup': 'D3'})],
 
342
              'transport_server': 'a'})],
332
343
            scenarios)
333
344
 
334
345
 
335
 
class TestWorkingTreeScenarios(tests.TestCase):
 
346
class TestWorkingTreeScenarios(TestCase):
336
347
 
337
348
    def test_scenarios(self):
338
349
        # check that constructor parameters are passed through to the adapted
339
350
        # test.
340
 
        from bzrlib.tests.per_workingtree import make_scenarios
 
351
        from bzrlib.tests.workingtree_implementations \
 
352
            import make_scenarios
341
353
        server1 = "a"
342
354
        server2 = "b"
343
 
        formats = [workingtree_4.WorkingTreeFormat4(),
344
 
                   workingtree_3.WorkingTreeFormat3(),]
 
355
        formats = [workingtree.WorkingTreeFormat2(),
 
356
                   workingtree.WorkingTreeFormat3(),]
345
357
        scenarios = make_scenarios(server1, server2, formats)
346
358
        self.assertEqual([
347
 
            ('WorkingTreeFormat4',
 
359
            ('WorkingTreeFormat2',
348
360
             {'bzrdir_format': formats[0]._matchingbzrdir,
349
361
              'transport_readonly_server': 'b',
350
362
              'transport_server': 'a',
357
369
            scenarios)
358
370
 
359
371
 
360
 
class TestTreeScenarios(tests.TestCase):
 
372
class TestTreeScenarios(TestCase):
361
373
 
362
374
    def test_scenarios(self):
363
375
        # the tree implementation scenario generator is meant to setup one
367
379
        # workingtree_to_test_tree attribute set to 'return_parameter' and the
368
380
        # revision one set to revision_tree_from_workingtree.
369
381
 
370
 
        from bzrlib.tests.per_tree import (
 
382
        from bzrlib.tests.tree_implementations import (
371
383
            _dirstate_tree_from_workingtree,
372
384
            make_scenarios,
373
385
            preview_tree_pre,
377
389
            )
378
390
        server1 = "a"
379
391
        server2 = "b"
380
 
        formats = [workingtree_4.WorkingTreeFormat4(),
381
 
                   workingtree_3.WorkingTreeFormat3(),]
 
392
        formats = [workingtree.WorkingTreeFormat2(),
 
393
                   workingtree.WorkingTreeFormat3(),]
382
394
        scenarios = make_scenarios(server1, server2, formats)
383
395
        self.assertEqual(7, len(scenarios))
384
 
        default_wt_format = workingtree.format_registry.get_default()
385
 
        wt4_format = workingtree_4.WorkingTreeFormat4()
386
 
        wt5_format = workingtree_4.WorkingTreeFormat5()
 
396
        default_wt_format = workingtree.WorkingTreeFormat4._default_format
 
397
        wt4_format = workingtree.WorkingTreeFormat4()
 
398
        wt5_format = workingtree.WorkingTreeFormat5()
387
399
        expected_scenarios = [
388
 
            ('WorkingTreeFormat4',
 
400
            ('WorkingTreeFormat2',
389
401
             {'bzrdir_format': formats[0]._matchingbzrdir,
390
402
              'transport_readonly_server': 'b',
391
403
              'transport_server': 'a',
436
448
        self.assertEqual(expected_scenarios, scenarios)
437
449
 
438
450
 
439
 
class TestInterTreeScenarios(tests.TestCase):
 
451
class TestInterTreeScenarios(TestCase):
440
452
    """A group of tests that test the InterTreeTestAdapter."""
441
453
 
442
454
    def test_scenarios(self):
449
461
        # unlike the TestProviderAdapter we dont want to automatically add a
450
462
        # parameterized one for WorkingTree - the optimisers will tell us what
451
463
        # ones to add.
452
 
        from bzrlib.tests.per_tree import (
 
464
        from bzrlib.tests.tree_implementations import (
453
465
            return_parameter,
 
466
            revision_tree_from_workingtree
454
467
            )
455
 
        from bzrlib.tests.per_intertree import (
 
468
        from bzrlib.tests.intertree_implementations import (
456
469
            make_scenarios,
457
470
            )
458
 
        from bzrlib.workingtree_3 import WorkingTreeFormat3
459
 
        from bzrlib.workingtree_4 import WorkingTreeFormat4
 
471
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
460
472
        input_test = TestInterTreeScenarios(
461
473
            "test_scenarios")
462
474
        server1 = "a"
463
475
        server2 = "b"
464
 
        format1 = WorkingTreeFormat4()
 
476
        format1 = WorkingTreeFormat2()
465
477
        format2 = WorkingTreeFormat3()
466
478
        formats = [("1", str, format1, format2, "converter1"),
467
479
            ("2", int, format2, format1, "converter2")]
492
504
        self.assertEqual(scenarios, expected_scenarios)
493
505
 
494
506
 
495
 
class TestTestCaseInTempDir(tests.TestCaseInTempDir):
 
507
class TestTestCaseInTempDir(TestCaseInTempDir):
496
508
 
497
509
    def test_home_is_not_working(self):
498
510
        self.assertNotEqual(self.test_dir, self.test_home_dir)
509
521
        self.assertEqualStat(real, fake)
510
522
 
511
523
    def test_assertEqualStat_notequal(self):
512
 
        self.build_tree(["foo", "longname"])
 
524
        self.build_tree(["foo", "bar"])
513
525
        self.assertRaises(AssertionError, self.assertEqualStat,
514
 
            os.lstat("foo"), os.lstat("longname"))
515
 
 
516
 
    def test_failUnlessExists(self):
517
 
        """Deprecated failUnlessExists and failIfExists"""
518
 
        self.applyDeprecated(
519
 
            deprecated_in((2, 4)),
520
 
            self.failUnlessExists, '.')
521
 
        self.build_tree(['foo/', 'foo/bar'])
522
 
        self.applyDeprecated(
523
 
            deprecated_in((2, 4)),
524
 
            self.failUnlessExists, 'foo/bar')
525
 
        self.applyDeprecated(
526
 
            deprecated_in((2, 4)),
527
 
            self.failIfExists, 'foo/foo')
528
 
 
529
 
    def test_assertPathExists(self):
530
 
        self.assertPathExists('.')
531
 
        self.build_tree(['foo/', 'foo/bar'])
532
 
        self.assertPathExists('foo/bar')
533
 
        self.assertPathDoesNotExist('foo/foo')
534
 
 
535
 
 
536
 
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
 
526
            os.lstat("foo"), os.lstat("bar"))
 
527
 
 
528
 
 
529
class TestTestCaseWithMemoryTransport(TestCaseWithMemoryTransport):
537
530
 
538
531
    def test_home_is_non_existant_dir_under_root(self):
539
532
        """The test_home_dir for TestCaseWithMemoryTransport is missing.
554
547
        cwd = osutils.getcwd()
555
548
        self.assertIsSameRealPath(self.test_dir, cwd)
556
549
 
557
 
    def test_BZR_HOME_and_HOME_are_bytestrings(self):
558
 
        """The $BZR_HOME and $HOME environment variables should not be unicode.
559
 
 
560
 
        See https://bugs.launchpad.net/bzr/+bug/464174
561
 
        """
562
 
        self.assertIsInstance(os.environ['BZR_HOME'], str)
563
 
        self.assertIsInstance(os.environ['HOME'], str)
564
 
 
565
550
    def test_make_branch_and_memory_tree(self):
566
551
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
567
552
 
571
556
        tree = self.make_branch_and_memory_tree('dir')
572
557
        # Guard against regression into MemoryTransport leaking
573
558
        # files to disk instead of keeping them in memory.
574
 
        self.assertFalse(osutils.lexists('dir'))
 
559
        self.failIf(osutils.lexists('dir'))
575
560
        self.assertIsInstance(tree, memorytree.MemoryTree)
576
561
 
577
562
    def test_make_branch_and_memory_tree_with_format(self):
578
563
        """make_branch_and_memory_tree should accept a format option."""
579
564
        format = bzrdir.BzrDirMetaFormat1()
580
 
        format.repository_format = repository.format_registry.get_default()
 
565
        format.repository_format = weaverepo.RepositoryFormat7()
581
566
        tree = self.make_branch_and_memory_tree('dir', format=format)
582
567
        # Guard against regression into MemoryTransport leaking
583
568
        # files to disk instead of keeping them in memory.
584
 
        self.assertFalse(osutils.lexists('dir'))
 
569
        self.failIf(osutils.lexists('dir'))
585
570
        self.assertIsInstance(tree, memorytree.MemoryTree)
586
571
        self.assertEqual(format.repository_format.__class__,
587
572
            tree.branch.repository._format.__class__)
591
576
        self.assertIsInstance(builder, branchbuilder.BranchBuilder)
592
577
        # Guard against regression into MemoryTransport leaking
593
578
        # files to disk instead of keeping them in memory.
594
 
        self.assertFalse(osutils.lexists('dir'))
 
579
        self.failIf(osutils.lexists('dir'))
595
580
 
596
581
    def test_make_branch_builder_with_format(self):
597
582
        # Use a repo layout that doesn't conform to a 'named' layout, to ensure
598
583
        # that the format objects are used.
599
584
        format = bzrdir.BzrDirMetaFormat1()
600
 
        repo_format = repository.format_registry.get_default()
 
585
        repo_format = weaverepo.RepositoryFormat7()
601
586
        format.repository_format = repo_format
602
587
        builder = self.make_branch_builder('dir', format=format)
603
588
        the_branch = builder.get_branch()
604
589
        # Guard against regression into MemoryTransport leaking
605
590
        # files to disk instead of keeping them in memory.
606
 
        self.assertFalse(osutils.lexists('dir'))
 
591
        self.failIf(osutils.lexists('dir'))
607
592
        self.assertEqual(format.repository_format.__class__,
608
593
                         the_branch.repository._format.__class__)
609
594
        self.assertEqual(repo_format.get_format_string(),
615
600
        the_branch = builder.get_branch()
616
601
        # Guard against regression into MemoryTransport leaking
617
602
        # files to disk instead of keeping them in memory.
618
 
        self.assertFalse(osutils.lexists('dir'))
 
603
        self.failIf(osutils.lexists('dir'))
619
604
        dir_format = bzrdir.format_registry.make_bzrdir('knit')
620
605
        self.assertEqual(dir_format.repository_format.__class__,
621
606
                         the_branch.repository._format.__class__)
623
608
                         self.get_transport().get_bytes(
624
609
                            'dir/.bzr/repository/format'))
625
610
 
 
611
    def test_safety_net(self):
 
612
        """No test should modify the safety .bzr directory.
 
613
 
 
614
        We just test that the _check_safety_net private method raises
 
615
        AssertionError, it's easier than building a test suite with the same
 
616
        test.
 
617
        """
 
618
        # Oops, a commit in the current directory (i.e. without local .bzr
 
619
        # directory) will crawl up the hierarchy to find a .bzr directory.
 
620
        self.run_bzr(['commit', '-mfoo', '--unchanged'])
 
621
        # But we have a safety net in place.
 
622
        self.assertRaises(AssertionError, self._check_safety_net)
 
623
 
626
624
    def test_dangling_locks_cause_failures(self):
627
 
        class TestDanglingLock(tests.TestCaseWithMemoryTransport):
 
625
        class TestDanglingLock(TestCaseWithMemoryTransport):
628
626
            def test_function(self):
629
627
                t = self.get_transport('.')
630
628
                l = lockdir.LockDir(t, 'lock')
632
630
                l.attempt_lock()
633
631
        test = TestDanglingLock('test_function')
634
632
        result = test.run()
635
 
        total_failures = result.errors + result.failures
636
 
        if self._lock_check_thorough:
637
 
            self.assertEqual(1, len(total_failures))
638
 
        else:
639
 
            # When _lock_check_thorough is disabled, then we don't trigger a
640
 
            # failure
641
 
            self.assertEqual(0, len(total_failures))
642
 
 
643
 
 
644
 
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
 
633
        self.assertEqual(1, len(result.errors))
 
634
 
 
635
 
 
636
class TestTestCaseWithTransport(TestCaseWithTransport):
645
637
    """Tests for the convenience functions TestCaseWithTransport introduces."""
646
638
 
647
639
    def test_get_readonly_url_none(self):
 
640
        from bzrlib.transport import get_transport
 
641
        from bzrlib.transport.memory import MemoryServer
648
642
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
649
 
        self.vfs_transport_factory = memory.MemoryServer
 
643
        self.vfs_transport_factory = MemoryServer
650
644
        self.transport_readonly_server = None
651
645
        # calling get_readonly_transport() constructs a decorator on the url
652
646
        # for the server
653
647
        url = self.get_readonly_url()
654
648
        url2 = self.get_readonly_url('foo/bar')
655
 
        t = transport.get_transport(url)
656
 
        t2 = transport.get_transport(url2)
657
 
        self.assertIsInstance(t, ReadonlyTransportDecorator)
658
 
        self.assertIsInstance(t2, ReadonlyTransportDecorator)
 
649
        t = get_transport(url)
 
650
        t2 = get_transport(url2)
 
651
        self.failUnless(isinstance(t, ReadonlyTransportDecorator))
 
652
        self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
659
653
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
660
654
 
661
655
    def test_get_readonly_url_http(self):
662
656
        from bzrlib.tests.http_server import HttpServer
 
657
        from bzrlib.transport import get_transport
 
658
        from bzrlib.transport.local import LocalURLServer
663
659
        from bzrlib.transport.http import HttpTransportBase
664
 
        self.transport_server = test_server.LocalURLServer
 
660
        self.transport_server = LocalURLServer
665
661
        self.transport_readonly_server = HttpServer
666
662
        # calling get_readonly_transport() gives us a HTTP server instance.
667
663
        url = self.get_readonly_url()
668
664
        url2 = self.get_readonly_url('foo/bar')
669
665
        # the transport returned may be any HttpTransportBase subclass
670
 
        t = transport.get_transport(url)
671
 
        t2 = transport.get_transport(url2)
672
 
        self.assertIsInstance(t, HttpTransportBase)
673
 
        self.assertIsInstance(t2, HttpTransportBase)
 
666
        t = get_transport(url)
 
667
        t2 = get_transport(url2)
 
668
        self.failUnless(isinstance(t, HttpTransportBase))
 
669
        self.failUnless(isinstance(t2, HttpTransportBase))
674
670
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
675
671
 
676
672
    def test_is_directory(self):
684
680
    def test_make_branch_builder(self):
685
681
        builder = self.make_branch_builder('dir')
686
682
        rev_id = builder.build_commit()
687
 
        self.assertPathExists('dir')
 
683
        self.failUnlessExists('dir')
688
684
        a_dir = bzrdir.BzrDir.open('dir')
689
685
        self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
690
686
        a_branch = a_dir.open_branch()
694
690
        self.assertEqual((1, rev_id), a_branch.last_revision_info())
695
691
 
696
692
 
697
 
class TestTestCaseTransports(tests.TestCaseWithTransport):
 
693
class TestTestCaseTransports(TestCaseWithTransport):
698
694
 
699
695
    def setUp(self):
700
696
        super(TestTestCaseTransports, self).setUp()
701
 
        self.vfs_transport_factory = memory.MemoryServer
 
697
        self.vfs_transport_factory = MemoryServer
702
698
 
703
699
    def test_make_bzrdir_preserves_transport(self):
704
700
        t = self.get_transport()
705
701
        result_bzrdir = self.make_bzrdir('subdir')
706
702
        self.assertIsInstance(result_bzrdir.transport,
707
 
                              memory.MemoryTransport)
 
703
                              MemoryTransport)
708
704
        # should not be on disk, should only be in memory
709
 
        self.assertPathDoesNotExist('subdir')
710
 
 
711
 
 
712
 
class TestChrootedTest(tests.ChrootedTestCase):
 
705
        self.failIfExists('subdir')
 
706
 
 
707
 
 
708
class TestChrootedTest(ChrootedTestCase):
713
709
 
714
710
    def test_root_is_root(self):
715
 
        t = transport.get_transport(self.get_readonly_url())
 
711
        from bzrlib.transport import get_transport
 
712
        t = get_transport(self.get_readonly_url())
716
713
        url = t.base
717
714
        self.assertEqual(url, t.clone('..').base)
718
715
 
719
716
 
720
 
class TestProfileResult(tests.TestCase):
721
 
 
722
 
    def test_profiles_tests(self):
723
 
        self.requireFeature(test_lsprof.LSProfFeature)
724
 
        terminal = testtools.tests.helpers.ExtendedTestResult()
725
 
        result = tests.ProfileResult(terminal)
726
 
        class Sample(tests.TestCase):
727
 
            def a(self):
728
 
                self.sample_function()
729
 
            def sample_function(self):
730
 
                pass
731
 
        test = Sample("a")
732
 
        test.run(result)
733
 
        case = terminal._events[0][1]
734
 
        self.assertLength(1, case._benchcalls)
735
 
        # We must be able to unpack it as the test reporting code wants
736
 
        (_, _, _), stats = case._benchcalls[0]
737
 
        self.assertTrue(callable(stats.pprint))
738
 
 
739
 
 
740
 
class TestTestResult(tests.TestCase):
 
717
class MockProgress(_BaseProgressBar):
 
718
    """Progress-bar standin that records calls.
 
719
 
 
720
    Useful for testing pb using code.
 
721
    """
 
722
 
 
723
    def __init__(self):
 
724
        _BaseProgressBar.__init__(self)
 
725
        self.calls = []
 
726
 
 
727
    def tick(self):
 
728
        self.calls.append(('tick',))
 
729
 
 
730
    def update(self, msg=None, current=None, total=None):
 
731
        self.calls.append(('update', msg, current, total))
 
732
 
 
733
    def clear(self):
 
734
        self.calls.append(('clear',))
 
735
 
 
736
    def note(self, msg, *args):
 
737
        self.calls.append(('note', msg, args))
 
738
 
 
739
 
 
740
class TestTestResult(TestCase):
741
741
 
742
742
    def check_timing(self, test_case, expected_re):
743
743
        result = bzrlib.tests.TextTestResult(self._log_file,
744
744
                descriptions=0,
745
745
                verbosity=1,
746
746
                )
747
 
        capture = testtools.tests.helpers.ExtendedTestResult()
748
 
        test_case.run(MultiTestResult(result, capture))
749
 
        run_case = capture._events[0][1]
750
 
        timed_string = result._testTimeString(run_case)
 
747
        test_case.run(result)
 
748
        timed_string = result._testTimeString(test_case)
751
749
        self.assertContainsRe(timed_string, expected_re)
752
750
 
753
751
    def test_test_reporting(self):
754
 
        class ShortDelayTestCase(tests.TestCase):
 
752
        class ShortDelayTestCase(TestCase):
755
753
            def test_short_delay(self):
756
754
                time.sleep(0.003)
757
755
            def test_short_benchmark(self):
758
756
                self.time(time.sleep, 0.003)
759
757
        self.check_timing(ShortDelayTestCase('test_short_delay'),
760
758
                          r"^ +[0-9]+ms$")
761
 
        # if a benchmark time is given, we now show just that time followed by
762
 
        # a star
 
759
        # if a benchmark time is given, we want a x of y style result.
763
760
        self.check_timing(ShortDelayTestCase('test_short_benchmark'),
764
 
                          r"^ +[0-9]+ms\*$")
 
761
                          r"^ +[0-9]+ms/ +[0-9]+ms$")
765
762
 
766
763
    def test_unittest_reporting_unittest_class(self):
767
764
        # getting the time from a non-bzrlib test works ok
771
768
        self.check_timing(ShortDelayTestCase('test_short_delay'),
772
769
                          r"^ +[0-9]+ms$")
773
770
 
 
771
    def test_assigned_benchmark_file_stores_date(self):
 
772
        output = StringIO()
 
773
        result = bzrlib.tests.TextTestResult(self._log_file,
 
774
                                        descriptions=0,
 
775
                                        verbosity=1,
 
776
                                        bench_history=output
 
777
                                        )
 
778
        output_string = output.getvalue()
 
779
        # if you are wondering about the regexp please read the comment in
 
780
        # test_bench_history (bzrlib.tests.test_selftest.TestRunner)
 
781
        # XXX: what comment?  -- Andrew Bennetts
 
782
        self.assertContainsRe(output_string, "--date [0-9.]+")
 
783
 
 
784
    def test_benchhistory_records_test_times(self):
 
785
        result_stream = StringIO()
 
786
        result = bzrlib.tests.TextTestResult(
 
787
            self._log_file,
 
788
            descriptions=0,
 
789
            verbosity=1,
 
790
            bench_history=result_stream
 
791
            )
 
792
 
 
793
        # we want profile a call and check that its test duration is recorded
 
794
        # make a new test instance that when run will generate a benchmark
 
795
        example_test_case = TestTestResult("_time_hello_world_encoding")
 
796
        # execute the test, which should succeed and record times
 
797
        example_test_case.run(result)
 
798
        lines = result_stream.getvalue().splitlines()
 
799
        self.assertEqual(2, len(lines))
 
800
        self.assertContainsRe(lines[1],
 
801
            " *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
 
802
            "._time_hello_world_encoding")
 
803
 
774
804
    def _time_hello_world_encoding(self):
775
805
        """Profile two sleep calls
776
806
 
784
814
        self.requireFeature(test_lsprof.LSProfFeature)
785
815
        result_stream = StringIO()
786
816
        result = bzrlib.tests.VerboseTestResult(
787
 
            result_stream,
 
817
            unittest._WritelnDecorator(result_stream),
788
818
            descriptions=0,
789
819
            verbosity=2,
790
820
            )
816
846
        self.assertContainsRe(output,
817
847
            r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
818
848
 
819
 
    def test_uses_time_from_testtools(self):
820
 
        """Test case timings in verbose results should use testtools times"""
821
 
        import datetime
822
 
        class TimeAddedVerboseTestResult(tests.VerboseTestResult):
823
 
            def startTest(self, test):
824
 
                self.time(datetime.datetime.utcfromtimestamp(1.145))
825
 
                super(TimeAddedVerboseTestResult, self).startTest(test)
826
 
            def addSuccess(self, test):
827
 
                self.time(datetime.datetime.utcfromtimestamp(51.147))
828
 
                super(TimeAddedVerboseTestResult, self).addSuccess(test)
829
 
            def report_tests_starting(self): pass
830
 
        sio = StringIO()
831
 
        self.get_passing_test().run(TimeAddedVerboseTestResult(sio, 0, 2))
832
 
        self.assertEndsWith(sio.getvalue(), "OK    50002ms\n")
833
 
 
834
849
    def test_known_failure(self):
835
850
        """A KnownFailure being raised should trigger several result actions."""
836
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
837
 
            def stopTestRun(self): pass
838
 
            def report_tests_starting(self): pass
839
 
            def report_known_failure(self, test, err=None, details=None):
840
 
                self._call = test, 'known failure'
 
851
        class InstrumentedTestResult(ExtendedTestResult):
 
852
            def done(self): pass
 
853
            def startTests(self): pass
 
854
            def report_test_start(self, test): pass
 
855
            def report_known_failure(self, test, err):
 
856
                self._call = test, err
841
857
        result = InstrumentedTestResult(None, None, None, None)
842
 
        class Test(tests.TestCase):
843
 
            def test_function(self):
844
 
                raise tests.KnownFailure('failed!')
845
 
        test = Test("test_function")
 
858
        def test_function():
 
859
            raise KnownFailure('failed!')
 
860
        test = unittest.FunctionTestCase(test_function)
846
861
        test.run(result)
847
862
        # it should invoke 'report_known_failure'.
848
863
        self.assertEqual(2, len(result._call))
849
 
        self.assertEqual(test.id(), result._call[0].id())
850
 
        self.assertEqual('known failure', result._call[1])
 
864
        self.assertEqual(test, result._call[0])
 
865
        self.assertEqual(KnownFailure, result._call[1][0])
 
866
        self.assertIsInstance(result._call[1][1], KnownFailure)
851
867
        # we dont introspec the traceback, if the rest is ok, it would be
852
868
        # exceptional for it not to be.
853
869
        # it should update the known_failure_count on the object.
859
875
        # verbose test output formatting
860
876
        result_stream = StringIO()
861
877
        result = bzrlib.tests.VerboseTestResult(
862
 
            result_stream,
 
878
            unittest._WritelnDecorator(result_stream),
863
879
            descriptions=0,
864
880
            verbosity=2,
865
881
            )
870
886
        # (class, exception object, traceback)
871
887
        # KnownFailures dont get their tracebacks shown though, so we
872
888
        # can skip that.
873
 
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
 
889
        err = (KnownFailure, KnownFailure('foo'), None)
874
890
        result.report_known_failure(test, err)
875
891
        output = result_stream.getvalue()[prefix:]
876
892
        lines = output.splitlines()
877
893
        self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
878
 
        if sys.version_info > (2, 7):
879
 
            self.expectFailure("_ExpectedFailure on 2.7 loses the message",
880
 
                self.assertNotEqual, lines[1], '    ')
881
894
        self.assertEqual(lines[1], '    foo')
882
895
        self.assertEqual(2, len(lines))
883
896
 
 
897
    def test_text_report_known_failure(self):
 
898
        # text test output formatting
 
899
        pb = MockProgress()
 
900
        result = bzrlib.tests.TextTestResult(
 
901
            StringIO(),
 
902
            descriptions=0,
 
903
            verbosity=1,
 
904
            pb=pb,
 
905
            )
 
906
        test = self.get_passing_test()
 
907
        # this seeds the state to handle reporting the test.
 
908
        result.startTest(test)
 
909
        # the err parameter has the shape:
 
910
        # (class, exception object, traceback)
 
911
        # KnownFailures dont get their tracebacks shown though, so we
 
912
        # can skip that.
 
913
        err = (KnownFailure, KnownFailure('foo'), None)
 
914
        result.report_known_failure(test, err)
 
915
        self.assertEqual(
 
916
            [
 
917
            ('update', '[1 in 0s] passing_test', None, None),
 
918
            ('note', 'XFAIL: %s\n%s\n', ('passing_test', err[1]))
 
919
            ],
 
920
            pb.calls)
 
921
        # known_failures should be printed in the summary, so if we run a test
 
922
        # after there are some known failures, the update prefix should match
 
923
        # this.
 
924
        result.known_failure_count = 3
 
925
        test.run(result)
 
926
        self.assertEqual(
 
927
            [
 
928
            ('update', '[2 in 0s] passing_test', None, None),
 
929
            ],
 
930
            pb.calls[2:])
 
931
 
884
932
    def get_passing_test(self):
885
933
        """Return a test object that can't be run usefully."""
886
934
        def passing_test():
889
937
 
890
938
    def test_add_not_supported(self):
891
939
        """Test the behaviour of invoking addNotSupported."""
892
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
893
 
            def stopTestRun(self): pass
894
 
            def report_tests_starting(self): pass
 
940
        class InstrumentedTestResult(ExtendedTestResult):
 
941
            def done(self): pass
 
942
            def startTests(self): pass
 
943
            def report_test_start(self, test): pass
895
944
            def report_unsupported(self, test, feature):
896
945
                self._call = test, feature
897
946
        result = InstrumentedTestResult(None, None, None, None)
898
947
        test = SampleTestCase('_test_pass')
899
 
        feature = tests.Feature()
 
948
        feature = Feature()
900
949
        result.startTest(test)
901
950
        result.addNotSupported(test, feature)
902
951
        # it should invoke 'report_unsupported'.
916
965
        # verbose test output formatting
917
966
        result_stream = StringIO()
918
967
        result = bzrlib.tests.VerboseTestResult(
919
 
            result_stream,
 
968
            unittest._WritelnDecorator(result_stream),
920
969
            descriptions=0,
921
970
            verbosity=2,
922
971
            )
923
972
        test = self.get_passing_test()
924
 
        feature = tests.Feature()
 
973
        feature = Feature()
925
974
        result.startTest(test)
926
975
        prefix = len(result_stream.getvalue())
927
976
        result.report_unsupported(test, feature)
928
977
        output = result_stream.getvalue()[prefix:]
929
978
        lines = output.splitlines()
930
 
        # We don't check for the final '0ms' since it may fail on slow hosts
931
 
        self.assertStartsWith(lines[0], 'NODEP')
932
 
        self.assertEqual(lines[1],
933
 
                         "    The feature 'Feature' is not available.")
 
979
        self.assertEqual(lines, ['NODEP                   0ms', "    The feature 'Feature' is not available."])
 
980
 
 
981
    def test_text_report_unsupported(self):
 
982
        # text test output formatting
 
983
        pb = MockProgress()
 
984
        result = bzrlib.tests.TextTestResult(
 
985
            StringIO(),
 
986
            descriptions=0,
 
987
            verbosity=1,
 
988
            pb=pb,
 
989
            )
 
990
        test = self.get_passing_test()
 
991
        feature = Feature()
 
992
        # this seeds the state to handle reporting the test.
 
993
        result.startTest(test)
 
994
        result.report_unsupported(test, feature)
 
995
        # no output on unsupported features
 
996
        self.assertEqual(
 
997
            [('update', '[1 in 0s] passing_test', None, None)
 
998
            ],
 
999
            pb.calls)
 
1000
        # the number of missing features should be printed in the progress
 
1001
        # summary, so check for that.
 
1002
        result.unsupported = {'foo':0, 'bar':0}
 
1003
        test.run(result)
 
1004
        self.assertEqual(
 
1005
            [
 
1006
            ('update', '[2 in 0s, 2 missing] passing_test', None, None),
 
1007
            ],
 
1008
            pb.calls[1:])
934
1009
 
935
1010
    def test_unavailable_exception(self):
936
1011
        """An UnavailableFeature being raised should invoke addNotSupported."""
937
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
938
 
            def stopTestRun(self): pass
939
 
            def report_tests_starting(self): pass
 
1012
        class InstrumentedTestResult(ExtendedTestResult):
 
1013
            def done(self): pass
 
1014
            def startTests(self): pass
 
1015
            def report_test_start(self, test): pass
940
1016
            def addNotSupported(self, test, feature):
941
1017
                self._call = test, feature
942
1018
        result = InstrumentedTestResult(None, None, None, None)
943
 
        feature = tests.Feature()
944
 
        class Test(tests.TestCase):
945
 
            def test_function(self):
946
 
                raise tests.UnavailableFeature(feature)
947
 
        test = Test("test_function")
 
1019
        feature = Feature()
 
1020
        def test_function():
 
1021
            raise UnavailableFeature(feature)
 
1022
        test = unittest.FunctionTestCase(test_function)
948
1023
        test.run(result)
949
1024
        # it should invoke 'addNotSupported'.
950
1025
        self.assertEqual(2, len(result._call))
951
 
        self.assertEqual(test.id(), result._call[0].id())
 
1026
        self.assertEqual(test, result._call[0])
952
1027
        self.assertEqual(feature, result._call[1])
953
1028
        # and not count as an error
954
1029
        self.assertEqual(0, result.error_count)
966
1041
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
967
1042
                                             verbosity=1)
968
1043
        test = self.get_passing_test()
969
 
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
970
 
        result.addExpectedFailure(test, err)
 
1044
        err = (KnownFailure, KnownFailure('foo'), None)
 
1045
        result._addKnownFailure(test, err)
971
1046
        self.assertFalse(result.wasStrictlySuccessful())
972
1047
        self.assertEqual(None, result._extractBenchmarkTime(test))
973
1048
 
981
1056
 
982
1057
    def test_startTests(self):
983
1058
        """Starting the first test should trigger startTests."""
984
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
1059
        class InstrumentedTestResult(ExtendedTestResult):
985
1060
            calls = 0
986
1061
            def startTests(self): self.calls += 1
 
1062
            def report_test_start(self, test): pass
987
1063
        result = InstrumentedTestResult(None, None, None, None)
988
1064
        def test_function():
989
1065
            pass
991
1067
        test.run(result)
992
1068
        self.assertEquals(1, result.calls)
993
1069
 
994
 
    def test_startTests_only_once(self):
995
 
        """With multiple tests startTests should still only be called once"""
996
 
        class InstrumentedTestResult(tests.ExtendedTestResult):
997
 
            calls = 0
998
 
            def startTests(self): self.calls += 1
999
 
        result = InstrumentedTestResult(None, None, None, None)
1000
 
        suite = unittest.TestSuite([
1001
 
            unittest.FunctionTestCase(lambda: None),
1002
 
            unittest.FunctionTestCase(lambda: None)])
1003
 
        suite.run(result)
1004
 
        self.assertEquals(1, result.calls)
1005
 
        self.assertEquals(2, result.count)
1006
 
 
1007
 
 
1008
 
class TestUnicodeFilenameFeature(tests.TestCase):
 
1070
 
 
1071
class TestUnicodeFilenameFeature(TestCase):
1009
1072
 
1010
1073
    def test_probe_passes(self):
1011
1074
        """UnicodeFilenameFeature._probe passes."""
1014
1077
        tests.UnicodeFilenameFeature._probe()
1015
1078
 
1016
1079
 
1017
 
class TestRunner(tests.TestCase):
 
1080
class TestRunner(TestCase):
1018
1081
 
1019
1082
    def dummy_test(self):
1020
1083
        pass
1025
1088
        This current saves and restores:
1026
1089
        TestCaseInTempDir.TEST_ROOT
1027
1090
 
1028
 
        There should be no tests in this file that use
1029
 
        bzrlib.tests.TextTestRunner without using this convenience method,
1030
 
        because of our use of global state.
 
1091
        There should be no tests in this file that use bzrlib.tests.TextTestRunner
 
1092
        without using this convenience method, because of our use of global state.
1031
1093
        """
1032
 
        old_root = tests.TestCaseInTempDir.TEST_ROOT
 
1094
        old_root = TestCaseInTempDir.TEST_ROOT
1033
1095
        try:
1034
 
            tests.TestCaseInTempDir.TEST_ROOT = None
 
1096
            TestCaseInTempDir.TEST_ROOT = None
1035
1097
            return testrunner.run(test)
1036
1098
        finally:
1037
 
            tests.TestCaseInTempDir.TEST_ROOT = old_root
 
1099
            TestCaseInTempDir.TEST_ROOT = old_root
1038
1100
 
1039
1101
    def test_known_failure_failed_run(self):
1040
1102
        # run a test that generates a known failure which should be printed in
1041
1103
        # the final output when real failures occur.
1042
 
        class Test(tests.TestCase):
1043
 
            def known_failure_test(self):
1044
 
                self.expectFailure('failed', self.assertTrue, False)
 
1104
        def known_failure_test():
 
1105
            raise KnownFailure('failed')
1045
1106
        test = unittest.TestSuite()
1046
 
        test.addTest(Test("known_failure_test"))
 
1107
        test.addTest(unittest.FunctionTestCase(known_failure_test))
1047
1108
        def failing_test():
1048
 
            self.fail('foo')
 
1109
            raise AssertionError('foo')
1049
1110
        test.addTest(unittest.FunctionTestCase(failing_test))
1050
1111
        stream = StringIO()
1051
 
        runner = tests.TextTestRunner(stream=stream)
 
1112
        runner = TextTestRunner(stream=stream)
1052
1113
        result = self.run_test_runner(runner, test)
1053
1114
        lines = stream.getvalue().splitlines()
1054
 
        self.assertContainsRe(stream.getvalue(),
1055
 
            '(?sm)^bzr selftest.*$'
1056
 
            '.*'
1057
 
            '^======================================================================\n'
1058
 
            '^FAIL: failing_test\n'
1059
 
            '^----------------------------------------------------------------------\n'
1060
 
            'Traceback \\(most recent call last\\):\n'
1061
 
            '  .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
1062
 
            '    self.fail\\(\'foo\'\\)\n'
1063
 
            '.*'
1064
 
            '^----------------------------------------------------------------------\n'
1065
 
            '.*'
1066
 
            'FAILED \\(failures=1, known_failure_count=1\\)'
1067
 
            )
 
1115
        self.assertEqual([
 
1116
            '',
 
1117
            '======================================================================',
 
1118
            'FAIL: unittest.FunctionTestCase (failing_test)',
 
1119
            '----------------------------------------------------------------------',
 
1120
            'Traceback (most recent call last):',
 
1121
            '    raise AssertionError(\'foo\')',
 
1122
            'AssertionError: foo',
 
1123
            '',
 
1124
            '----------------------------------------------------------------------',
 
1125
            '',
 
1126
            'FAILED (failures=1, known_failure_count=1)'],
 
1127
            lines[3:8] + lines[9:13] + lines[14:])
1068
1128
 
1069
1129
    def test_known_failure_ok_run(self):
1070
 
        # run a test that generates a known failure which should be printed in
1071
 
        # the final output.
1072
 
        class Test(tests.TestCase):
1073
 
            def known_failure_test(self):
1074
 
                self.expectFailure('failed', self.assertTrue, False)
1075
 
        test = Test("known_failure_test")
 
1130
        # run a test that generates a known failure which should be printed in the final output.
 
1131
        def known_failure_test():
 
1132
            raise KnownFailure('failed')
 
1133
        test = unittest.FunctionTestCase(known_failure_test)
1076
1134
        stream = StringIO()
1077
 
        runner = tests.TextTestRunner(stream=stream)
 
1135
        runner = TextTestRunner(stream=stream)
1078
1136
        result = self.run_test_runner(runner, test)
1079
1137
        self.assertContainsRe(stream.getvalue(),
1080
1138
            '\n'
1083
1141
            '\n'
1084
1142
            'OK \\(known_failures=1\\)\n')
1085
1143
 
1086
 
    def test_result_decorator(self):
1087
 
        # decorate results
1088
 
        calls = []
1089
 
        class LoggingDecorator(ExtendedToOriginalDecorator):
1090
 
            def startTest(self, test):
1091
 
                ExtendedToOriginalDecorator.startTest(self, test)
1092
 
                calls.append('start')
1093
 
        test = unittest.FunctionTestCase(lambda:None)
1094
 
        stream = StringIO()
1095
 
        runner = tests.TextTestRunner(stream=stream,
1096
 
            result_decorators=[LoggingDecorator])
1097
 
        result = self.run_test_runner(runner, test)
1098
 
        self.assertLength(1, calls)
1099
 
 
1100
1144
    def test_skipped_test(self):
1101
1145
        # run a test that is skipped, and check the suite as a whole still
1102
1146
        # succeeds.
1103
1147
        # skipping_test must be hidden in here so it's not run as a real test
1104
 
        class SkippingTest(tests.TestCase):
 
1148
        class SkippingTest(TestCase):
1105
1149
            def skipping_test(self):
1106
 
                raise tests.TestSkipped('test intentionally skipped')
1107
 
        runner = tests.TextTestRunner(stream=self._log_file)
 
1150
                raise TestSkipped('test intentionally skipped')
 
1151
        runner = TextTestRunner(stream=self._log_file)
1108
1152
        test = SkippingTest("skipping_test")
1109
1153
        result = self.run_test_runner(runner, test)
1110
1154
        self.assertTrue(result.wasSuccessful())
1111
1155
 
1112
1156
    def test_skipped_from_setup(self):
1113
1157
        calls = []
1114
 
        class SkippedSetupTest(tests.TestCase):
 
1158
        class SkippedSetupTest(TestCase):
1115
1159
 
1116
1160
            def setUp(self):
1117
1161
                calls.append('setUp')
1118
1162
                self.addCleanup(self.cleanup)
1119
 
                raise tests.TestSkipped('skipped setup')
 
1163
                raise TestSkipped('skipped setup')
1120
1164
 
1121
1165
            def test_skip(self):
1122
1166
                self.fail('test reached')
1124
1168
            def cleanup(self):
1125
1169
                calls.append('cleanup')
1126
1170
 
1127
 
        runner = tests.TextTestRunner(stream=self._log_file)
 
1171
        runner = TextTestRunner(stream=self._log_file)
1128
1172
        test = SkippedSetupTest('test_skip')
1129
1173
        result = self.run_test_runner(runner, test)
1130
1174
        self.assertTrue(result.wasSuccessful())
1133
1177
 
1134
1178
    def test_skipped_from_test(self):
1135
1179
        calls = []
1136
 
        class SkippedTest(tests.TestCase):
 
1180
        class SkippedTest(TestCase):
1137
1181
 
1138
1182
            def setUp(self):
1139
 
                tests.TestCase.setUp(self)
 
1183
                TestCase.setUp(self)
1140
1184
                calls.append('setUp')
1141
1185
                self.addCleanup(self.cleanup)
1142
1186
 
1143
1187
            def test_skip(self):
1144
 
                raise tests.TestSkipped('skipped test')
 
1188
                raise TestSkipped('skipped test')
1145
1189
 
1146
1190
            def cleanup(self):
1147
1191
                calls.append('cleanup')
1148
1192
 
1149
 
        runner = tests.TextTestRunner(stream=self._log_file)
 
1193
        runner = TextTestRunner(stream=self._log_file)
1150
1194
        test = SkippedTest('test_skip')
1151
1195
        result = self.run_test_runner(runner, test)
1152
1196
        self.assertTrue(result.wasSuccessful())
1155
1199
 
1156
1200
    def test_not_applicable(self):
1157
1201
        # run a test that is skipped because it's not applicable
1158
 
        class Test(tests.TestCase):
1159
 
            def not_applicable_test(self):
1160
 
                raise tests.TestNotApplicable('this test never runs')
 
1202
        def not_applicable_test():
 
1203
            from bzrlib.tests import TestNotApplicable
 
1204
            raise TestNotApplicable('this test never runs')
1161
1205
        out = StringIO()
1162
 
        runner = tests.TextTestRunner(stream=out, verbosity=2)
1163
 
        test = Test("not_applicable_test")
 
1206
        runner = TextTestRunner(stream=out, verbosity=2)
 
1207
        test = unittest.FunctionTestCase(not_applicable_test)
1164
1208
        result = self.run_test_runner(runner, test)
1165
1209
        self._log_file.write(out.getvalue())
1166
1210
        self.assertTrue(result.wasSuccessful())
1170
1214
        self.assertContainsRe(out.getvalue(),
1171
1215
                r'(?m)^    this test never runs')
1172
1216
 
 
1217
    def test_not_applicable_demo(self):
 
1218
        # just so you can see it in the test output
 
1219
        raise TestNotApplicable('this test is just a demonstation')
 
1220
 
1173
1221
    def test_unsupported_features_listed(self):
1174
1222
        """When unsupported features are encountered they are detailed."""
1175
 
        class Feature1(tests.Feature):
 
1223
        class Feature1(Feature):
1176
1224
            def _probe(self): return False
1177
 
        class Feature2(tests.Feature):
 
1225
        class Feature2(Feature):
1178
1226
            def _probe(self): return False
1179
1227
        # create sample tests
1180
1228
        test1 = SampleTestCase('_test_pass')
1185
1233
        test.addTest(test1)
1186
1234
        test.addTest(test2)
1187
1235
        stream = StringIO()
1188
 
        runner = tests.TextTestRunner(stream=stream)
 
1236
        runner = TextTestRunner(stream=stream)
1189
1237
        result = self.run_test_runner(runner, test)
1190
1238
        lines = stream.getvalue().splitlines()
1191
1239
        self.assertEqual([
1195
1243
            ],
1196
1244
            lines[-3:])
1197
1245
 
1198
 
    def test_verbose_test_count(self):
1199
 
        """A verbose test run reports the right test count at the start"""
1200
 
        suite = TestUtil.TestSuite([
1201
 
            unittest.FunctionTestCase(lambda:None),
1202
 
            unittest.FunctionTestCase(lambda:None)])
1203
 
        self.assertEqual(suite.countTestCases(), 2)
1204
 
        stream = StringIO()
1205
 
        runner = tests.TextTestRunner(stream=stream, verbosity=2)
1206
 
        # Need to use the CountingDecorator as that's what sets num_tests
1207
 
        result = self.run_test_runner(runner, tests.CountingDecorator(suite))
1208
 
        self.assertStartsWith(stream.getvalue(), "running 2 tests")
1209
 
 
1210
 
    def test_startTestRun(self):
1211
 
        """run should call result.startTestRun()"""
1212
 
        calls = []
1213
 
        class LoggingDecorator(ExtendedToOriginalDecorator):
1214
 
            def startTestRun(self):
1215
 
                ExtendedToOriginalDecorator.startTestRun(self)
1216
 
                calls.append('startTestRun')
1217
 
        test = unittest.FunctionTestCase(lambda:None)
1218
 
        stream = StringIO()
1219
 
        runner = tests.TextTestRunner(stream=stream,
1220
 
            result_decorators=[LoggingDecorator])
1221
 
        result = self.run_test_runner(runner, test)
1222
 
        self.assertLength(1, calls)
1223
 
 
1224
 
    def test_stopTestRun(self):
1225
 
        """run should call result.stopTestRun()"""
1226
 
        calls = []
1227
 
        class LoggingDecorator(ExtendedToOriginalDecorator):
1228
 
            def stopTestRun(self):
1229
 
                ExtendedToOriginalDecorator.stopTestRun(self)
1230
 
                calls.append('stopTestRun')
1231
 
        test = unittest.FunctionTestCase(lambda:None)
1232
 
        stream = StringIO()
1233
 
        runner = tests.TextTestRunner(stream=stream,
1234
 
            result_decorators=[LoggingDecorator])
1235
 
        result = self.run_test_runner(runner, test)
1236
 
        self.assertLength(1, calls)
1237
 
 
1238
 
    def test_unicode_test_output_on_ascii_stream(self):
1239
 
        """Showing results should always succeed even on an ascii console"""
1240
 
        class FailureWithUnicode(tests.TestCase):
1241
 
            def test_log_unicode(self):
1242
 
                self.log(u"\u2606")
1243
 
                self.fail("Now print that log!")
1244
 
        out = StringIO()
1245
 
        self.overrideAttr(osutils, "get_terminal_encoding",
1246
 
            lambda trace=False: "ascii")
1247
 
        result = self.run_test_runner(tests.TextTestRunner(stream=out),
1248
 
            FailureWithUnicode("test_log_unicode"))
1249
 
        self.assertContainsRe(out.getvalue(),
1250
 
            "Text attachment: log\n"
1251
 
            "-+\n"
1252
 
            "\d+\.\d+  \\\\u2606\n"
1253
 
            "-+\n")
1254
 
 
1255
 
 
1256
 
class SampleTestCase(tests.TestCase):
 
1246
    def test_bench_history(self):
 
1247
        # tests that the running the benchmark produces a history file
 
1248
        # containing a timestamp and the revision id of the bzrlib source which
 
1249
        # was tested.
 
1250
        workingtree = _get_bzr_source_tree()
 
1251
        test = TestRunner('dummy_test')
 
1252
        output = StringIO()
 
1253
        runner = TextTestRunner(stream=self._log_file, bench_history=output)
 
1254
        result = self.run_test_runner(runner, test)
 
1255
        output_string = output.getvalue()
 
1256
        self.assertContainsRe(output_string, "--date [0-9.]+")
 
1257
        if workingtree is not None:
 
1258
            revision_id = workingtree.get_parent_ids()[0]
 
1259
            self.assertEndsWith(output_string.rstrip(), revision_id)
 
1260
 
 
1261
    def assertLogDeleted(self, test):
 
1262
        log = test._get_log()
 
1263
        self.assertEqual("DELETED log file to reduce memory footprint", log)
 
1264
        self.assertEqual('', test._log_contents)
 
1265
        self.assertIs(None, test._log_file_name)
 
1266
 
 
1267
    def test_success_log_deleted(self):
 
1268
        """Successful tests have their log deleted"""
 
1269
 
 
1270
        class LogTester(TestCase):
 
1271
 
 
1272
            def test_success(self):
 
1273
                self.log('this will be removed\n')
 
1274
 
 
1275
        sio = cStringIO.StringIO()
 
1276
        runner = TextTestRunner(stream=sio)
 
1277
        test = LogTester('test_success')
 
1278
        result = self.run_test_runner(runner, test)
 
1279
 
 
1280
        self.assertLogDeleted(test)
 
1281
 
 
1282
    def test_skipped_log_deleted(self):
 
1283
        """Skipped tests have their log deleted"""
 
1284
 
 
1285
        class LogTester(TestCase):
 
1286
 
 
1287
            def test_skipped(self):
 
1288
                self.log('this will be removed\n')
 
1289
                raise tests.TestSkipped()
 
1290
 
 
1291
        sio = cStringIO.StringIO()
 
1292
        runner = TextTestRunner(stream=sio)
 
1293
        test = LogTester('test_skipped')
 
1294
        result = self.run_test_runner(runner, test)
 
1295
 
 
1296
        self.assertLogDeleted(test)
 
1297
 
 
1298
    def test_not_aplicable_log_deleted(self):
 
1299
        """Not applicable tests have their log deleted"""
 
1300
 
 
1301
        class LogTester(TestCase):
 
1302
 
 
1303
            def test_not_applicable(self):
 
1304
                self.log('this will be removed\n')
 
1305
                raise tests.TestNotApplicable()
 
1306
 
 
1307
        sio = cStringIO.StringIO()
 
1308
        runner = TextTestRunner(stream=sio)
 
1309
        test = LogTester('test_not_applicable')
 
1310
        result = self.run_test_runner(runner, test)
 
1311
 
 
1312
        self.assertLogDeleted(test)
 
1313
 
 
1314
    def test_known_failure_log_deleted(self):
 
1315
        """Know failure tests have their log deleted"""
 
1316
 
 
1317
        class LogTester(TestCase):
 
1318
 
 
1319
            def test_known_failure(self):
 
1320
                self.log('this will be removed\n')
 
1321
                raise tests.KnownFailure()
 
1322
 
 
1323
        sio = cStringIO.StringIO()
 
1324
        runner = TextTestRunner(stream=sio)
 
1325
        test = LogTester('test_known_failure')
 
1326
        result = self.run_test_runner(runner, test)
 
1327
 
 
1328
        self.assertLogDeleted(test)
 
1329
 
 
1330
    def test_fail_log_kept(self):
 
1331
        """Failed tests have their log kept"""
 
1332
 
 
1333
        class LogTester(TestCase):
 
1334
 
 
1335
            def test_fail(self):
 
1336
                self.log('this will be kept\n')
 
1337
                self.fail('this test fails')
 
1338
 
 
1339
        sio = cStringIO.StringIO()
 
1340
        runner = TextTestRunner(stream=sio)
 
1341
        test = LogTester('test_fail')
 
1342
        result = self.run_test_runner(runner, test)
 
1343
 
 
1344
        text = sio.getvalue()
 
1345
        self.assertContainsRe(text, 'this will be kept')
 
1346
        self.assertContainsRe(text, 'this test fails')
 
1347
 
 
1348
        log = test._get_log()
 
1349
        self.assertContainsRe(log, 'this will be kept')
 
1350
        self.assertEqual(log, test._log_contents)
 
1351
 
 
1352
    def test_error_log_kept(self):
 
1353
        """Tests with errors have their log kept"""
 
1354
 
 
1355
        class LogTester(TestCase):
 
1356
 
 
1357
            def test_error(self):
 
1358
                self.log('this will be kept\n')
 
1359
                raise ValueError('random exception raised')
 
1360
 
 
1361
        sio = cStringIO.StringIO()
 
1362
        runner = TextTestRunner(stream=sio)
 
1363
        test = LogTester('test_error')
 
1364
        result = self.run_test_runner(runner, test)
 
1365
 
 
1366
        text = sio.getvalue()
 
1367
        self.assertContainsRe(text, 'this will be kept')
 
1368
        self.assertContainsRe(text, 'random exception raised')
 
1369
 
 
1370
        log = test._get_log()
 
1371
        self.assertContainsRe(log, 'this will be kept')
 
1372
        self.assertEqual(log, test._log_contents)
 
1373
 
 
1374
 
 
1375
class SampleTestCase(TestCase):
1257
1376
 
1258
1377
    def _test_pass(self):
1259
1378
        pass
1261
1380
class _TestException(Exception):
1262
1381
    pass
1263
1382
 
1264
 
 
1265
 
class TestTestCase(tests.TestCase):
 
1383
class TestTestCase(TestCase):
1266
1384
    """Tests that test the core bzrlib TestCase."""
1267
1385
 
1268
1386
    def test_assertLength_matches_empty(self):
1285
1403
            exception.args[0])
1286
1404
 
1287
1405
    def test_base_setUp_not_called_causes_failure(self):
1288
 
        class TestCaseWithBrokenSetUp(tests.TestCase):
 
1406
        class TestCaseWithBrokenSetUp(TestCase):
1289
1407
            def setUp(self):
1290
1408
                pass # does not call TestCase.setUp
1291
1409
            def test_foo(self):
1297
1415
        self.assertEqual(1, result.testsRun)
1298
1416
 
1299
1417
    def test_base_tearDown_not_called_causes_failure(self):
1300
 
        class TestCaseWithBrokenTearDown(tests.TestCase):
 
1418
        class TestCaseWithBrokenTearDown(TestCase):
1301
1419
            def tearDown(self):
1302
1420
                pass # does not call TestCase.tearDown
1303
1421
            def test_foo(self):
1311
1429
    def test_debug_flags_sanitised(self):
1312
1430
        """The bzrlib debug flags should be sanitised by setUp."""
1313
1431
        if 'allow_debug' in tests.selftest_debug_flags:
1314
 
            raise tests.TestNotApplicable(
 
1432
            raise TestNotApplicable(
1315
1433
                '-Eallow_debug option prevents debug flag sanitisation')
1316
1434
        # we could set something and run a test that will check
1317
1435
        # it gets santised, but this is probably sufficient for now:
1318
1436
        # if someone runs the test with -Dsomething it will error.
1319
 
        flags = set()
1320
 
        if self._lock_check_thorough:
1321
 
            flags.add('strict_locks')
1322
 
        self.assertEqual(flags, bzrlib.debug.debug_flags)
 
1437
        self.assertEqual(set(), bzrlib.debug.debug_flags)
1323
1438
 
1324
1439
    def change_selftest_debug_flags(self, new_flags):
1325
 
        self.overrideAttr(tests, 'selftest_debug_flags', set(new_flags))
 
1440
        orig_selftest_flags = tests.selftest_debug_flags
 
1441
        self.addCleanup(self._restore_selftest_debug_flags, orig_selftest_flags)
 
1442
        tests.selftest_debug_flags = set(new_flags)
 
1443
 
 
1444
    def _restore_selftest_debug_flags(self, flags):
 
1445
        tests.selftest_debug_flags = flags
1326
1446
 
1327
1447
    def test_allow_debug_flag(self):
1328
1448
        """The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1330
1450
        """
1331
1451
        self.change_selftest_debug_flags(set(['allow_debug']))
1332
1452
        bzrlib.debug.debug_flags = set(['a-flag'])
1333
 
        class TestThatRecordsFlags(tests.TestCase):
1334
 
            def test_foo(nested_self):
1335
 
                self.flags = set(bzrlib.debug.debug_flags)
1336
 
        test = TestThatRecordsFlags('test_foo')
1337
 
        test.run(self.make_test_result())
1338
 
        flags = set(['a-flag'])
1339
 
        if 'disable_lock_checks' not in tests.selftest_debug_flags:
1340
 
            flags.add('strict_locks')
1341
 
        self.assertEqual(flags, self.flags)
1342
 
 
1343
 
    def test_disable_lock_checks(self):
1344
 
        """The -Edisable_lock_checks flag disables thorough checks."""
1345
 
        class TestThatRecordsFlags(tests.TestCase):
1346
 
            def test_foo(nested_self):
1347
 
                self.flags = set(bzrlib.debug.debug_flags)
1348
 
                self.test_lock_check_thorough = nested_self._lock_check_thorough
1349
 
        self.change_selftest_debug_flags(set())
1350
 
        test = TestThatRecordsFlags('test_foo')
1351
 
        test.run(self.make_test_result())
1352
 
        # By default we do strict lock checking and thorough lock/unlock
1353
 
        # tracking.
1354
 
        self.assertTrue(self.test_lock_check_thorough)
1355
 
        self.assertEqual(set(['strict_locks']), self.flags)
1356
 
        # Now set the disable_lock_checks flag, and show that this changed.
1357
 
        self.change_selftest_debug_flags(set(['disable_lock_checks']))
1358
 
        test = TestThatRecordsFlags('test_foo')
1359
 
        test.run(self.make_test_result())
1360
 
        self.assertFalse(self.test_lock_check_thorough)
1361
 
        self.assertEqual(set(), self.flags)
1362
 
 
1363
 
    def test_this_fails_strict_lock_check(self):
1364
 
        class TestThatRecordsFlags(tests.TestCase):
1365
 
            def test_foo(nested_self):
1366
 
                self.flags1 = set(bzrlib.debug.debug_flags)
1367
 
                self.thisFailsStrictLockCheck()
1368
 
                self.flags2 = set(bzrlib.debug.debug_flags)
1369
 
        # Make sure lock checking is active
1370
 
        self.change_selftest_debug_flags(set())
1371
 
        test = TestThatRecordsFlags('test_foo')
1372
 
        test.run(self.make_test_result())
1373
 
        self.assertEqual(set(['strict_locks']), self.flags1)
1374
 
        self.assertEqual(set(), self.flags2)
 
1453
        class TestThatRecordsFlags(TestCase):
 
1454
            def test_foo(nested_self):
 
1455
                self.flags = set(bzrlib.debug.debug_flags)
 
1456
        test = TestThatRecordsFlags('test_foo')
 
1457
        test.run(self.make_test_result())
 
1458
        self.assertEqual(set(['a-flag']), self.flags)
1375
1459
 
1376
1460
    def test_debug_flags_restored(self):
1377
1461
        """The bzrlib debug flags should be restored to their original state
1380
1464
        self.change_selftest_debug_flags(set(['allow_debug']))
1381
1465
        # Now run a test that modifies debug.debug_flags.
1382
1466
        bzrlib.debug.debug_flags = set(['original-state'])
1383
 
        class TestThatModifiesFlags(tests.TestCase):
 
1467
        class TestThatModifiesFlags(TestCase):
1384
1468
            def test_foo(self):
1385
1469
                bzrlib.debug.debug_flags = set(['modified'])
1386
1470
        test = TestThatModifiesFlags('test_foo')
1388
1472
        self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1389
1473
 
1390
1474
    def make_test_result(self):
1391
 
        """Get a test result that writes to the test log file."""
1392
 
        return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
 
1475
        return bzrlib.tests.TextTestResult(
 
1476
            self._log_file, descriptions=0, verbosity=1)
1393
1477
 
1394
1478
    def inner_test(self):
1395
1479
        # the inner child test
1402
1486
        result = self.make_test_result()
1403
1487
        self.inner_test.run(result)
1404
1488
        note("outer finish")
1405
 
        self.addCleanup(osutils.delete_any, self._log_file_name)
1406
1489
 
1407
1490
    def test_trace_nesting(self):
1408
1491
        # this tests that each test case nests its trace facility correctly.
1432
1515
        sample_test = TestTestCase("method_that_times_a_bit_twice")
1433
1516
        output_stream = StringIO()
1434
1517
        result = bzrlib.tests.VerboseTestResult(
1435
 
            output_stream,
 
1518
            unittest._WritelnDecorator(output_stream),
1436
1519
            descriptions=0,
1437
 
            verbosity=2)
 
1520
            verbosity=2,
 
1521
            num_tests=sample_test.countTestCases())
1438
1522
        sample_test.run(result)
1439
1523
        self.assertContainsRe(
1440
1524
            output_stream.getvalue(),
1441
 
            r"\d+ms\*\n$")
 
1525
            r"\d+ms/ +\d+ms\n$")
1442
1526
 
1443
1527
    def test_hooks_sanitised(self):
1444
1528
        """The bzrlib hooks should be sanitised by setUp."""
1445
1529
        # Note this test won't fail with hooks that the core library doesn't
1446
1530
        # use - but it trigger with a plugin that adds hooks, so its still a
1447
1531
        # useful warning in that case.
1448
 
        self.assertEqual(bzrlib.branch.BranchHooks(), bzrlib.branch.Branch.hooks)
1449
 
        self.assertEqual(
1450
 
            bzrlib.smart.server.SmartServerHooks(),
 
1532
        self.assertEqual(bzrlib.branch.BranchHooks(),
 
1533
            bzrlib.branch.Branch.hooks)
 
1534
        self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
1451
1535
            bzrlib.smart.server.SmartTCPServer.hooks)
1452
 
        self.assertEqual(
1453
 
            bzrlib.commands.CommandHooks(), bzrlib.commands.Command.hooks)
 
1536
        self.assertEqual(bzrlib.commands.CommandHooks(),
 
1537
            bzrlib.commands.Command.hooks)
1454
1538
 
1455
1539
    def test__gather_lsprof_in_benchmarks(self):
1456
1540
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1468
1552
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1469
1553
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1470
1554
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1471
 
        del self._benchcalls[:]
1472
1555
 
1473
1556
    def test_knownFailure(self):
1474
1557
        """Self.knownFailure() should raise a KnownFailure exception."""
1475
 
        self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
1476
 
 
1477
 
    def test_open_bzrdir_safe_roots(self):
1478
 
        # even a memory transport should fail to open when its url isn't 
1479
 
        # permitted.
1480
 
        # Manually set one up (TestCase doesn't and shouldn't provide magic
1481
 
        # machinery)
1482
 
        transport_server = memory.MemoryServer()
1483
 
        transport_server.start_server()
1484
 
        self.addCleanup(transport_server.stop_server)
1485
 
        t = transport.get_transport(transport_server.get_url())
1486
 
        bzrdir.BzrDir.create(t.base)
1487
 
        self.assertRaises(errors.BzrError,
1488
 
            bzrdir.BzrDir.open_from_transport, t)
1489
 
        # But if we declare this as safe, we can open the bzrdir.
1490
 
        self.permit_url(t.base)
1491
 
        self._bzr_selftest_roots.append(t.base)
1492
 
        bzrdir.BzrDir.open_from_transport(t)
 
1558
        self.assertRaises(KnownFailure, self.knownFailure, "A Failure")
1493
1559
 
1494
1560
    def test_requireFeature_available(self):
1495
1561
        """self.requireFeature(available) is a no-op."""
1496
 
        class Available(tests.Feature):
 
1562
        class Available(Feature):
1497
1563
            def _probe(self):return True
1498
1564
        feature = Available()
1499
1565
        self.requireFeature(feature)
1500
1566
 
1501
1567
    def test_requireFeature_unavailable(self):
1502
1568
        """self.requireFeature(unavailable) raises UnavailableFeature."""
1503
 
        class Unavailable(tests.Feature):
 
1569
        class Unavailable(Feature):
1504
1570
            def _probe(self):return False
1505
1571
        feature = Unavailable()
1506
 
        self.assertRaises(tests.UnavailableFeature,
1507
 
                          self.requireFeature, feature)
 
1572
        self.assertRaises(UnavailableFeature, self.requireFeature, feature)
1508
1573
 
1509
1574
    def test_run_no_parameters(self):
1510
1575
        test = SampleTestCase('_test_pass')
1540
1605
        """Test disabled tests behaviour with support aware results."""
1541
1606
        test = SampleTestCase('_test_pass')
1542
1607
        class DisabledFeature(object):
1543
 
            def __eq__(self, other):
1544
 
                return isinstance(other, DisabledFeature)
1545
1608
            def available(self):
1546
1609
                return False
1547
1610
        the_feature = DisabledFeature()
1558
1621
                self.calls.append(('addNotSupported', test, feature))
1559
1622
        result = InstrumentedTestResult()
1560
1623
        test.run(result)
1561
 
        case = result.calls[0][1]
1562
1624
        self.assertEqual([
1563
 
            ('startTest', case),
1564
 
            ('addNotSupported', case, the_feature),
1565
 
            ('stopTest', case),
 
1625
            ('startTest', test),
 
1626
            ('addNotSupported', test, the_feature),
 
1627
            ('stopTest', test),
1566
1628
            ],
1567
1629
            result.calls)
1568
1630
 
1569
 
    def test_start_server_registers_url(self):
1570
 
        transport_server = memory.MemoryServer()
1571
 
        # A little strict, but unlikely to be changed soon.
1572
 
        self.assertEqual([], self._bzr_selftest_roots)
1573
 
        self.start_server(transport_server)
1574
 
        self.assertSubset([transport_server.get_url()],
1575
 
            self._bzr_selftest_roots)
1576
 
 
1577
1631
    def test_assert_list_raises_on_generator(self):
1578
1632
        def generator_which_will_raise():
1579
1633
            # This will not raise until after the first yield
1629
1683
        self.assertRaises(AssertionError,
1630
1684
            self.assertListRaises, _TestException, success_generator)
1631
1685
 
1632
 
    def test_overrideAttr_without_value(self):
1633
 
        self.test_attr = 'original' # Define a test attribute
1634
 
        obj = self # Make 'obj' visible to the embedded test
1635
 
        class Test(tests.TestCase):
1636
 
 
1637
 
            def setUp(self):
1638
 
                tests.TestCase.setUp(self)
1639
 
                self.orig = self.overrideAttr(obj, 'test_attr')
1640
 
 
1641
 
            def test_value(self):
1642
 
                self.assertEqual('original', self.orig)
1643
 
                self.assertEqual('original', obj.test_attr)
1644
 
                obj.test_attr = 'modified'
1645
 
                self.assertEqual('modified', obj.test_attr)
1646
 
 
1647
 
        test = Test('test_value')
1648
 
        test.run(unittest.TestResult())
1649
 
        self.assertEqual('original', obj.test_attr)
1650
 
 
1651
 
    def test_overrideAttr_with_value(self):
1652
 
        self.test_attr = 'original' # Define a test attribute
1653
 
        obj = self # Make 'obj' visible to the embedded test
1654
 
        class Test(tests.TestCase):
1655
 
 
1656
 
            def setUp(self):
1657
 
                tests.TestCase.setUp(self)
1658
 
                self.orig = self.overrideAttr(obj, 'test_attr', new='modified')
1659
 
 
1660
 
            def test_value(self):
1661
 
                self.assertEqual('original', self.orig)
1662
 
                self.assertEqual('modified', obj.test_attr)
1663
 
 
1664
 
        test = Test('test_value')
1665
 
        test.run(unittest.TestResult())
1666
 
        self.assertEqual('original', obj.test_attr)
1667
 
 
1668
 
 
1669
 
class _MissingFeature(tests.Feature):
1670
 
    def _probe(self):
1671
 
        return False
1672
 
missing_feature = _MissingFeature()
1673
 
 
1674
 
 
1675
 
def _get_test(name):
1676
 
    """Get an instance of a specific example test.
1677
 
 
1678
 
    We protect this in a function so that they don't auto-run in the test
1679
 
    suite.
1680
 
    """
1681
 
 
1682
 
    class ExampleTests(tests.TestCase):
1683
 
 
1684
 
        def test_fail(self):
1685
 
            mutter('this was a failing test')
1686
 
            self.fail('this test will fail')
1687
 
 
1688
 
        def test_error(self):
1689
 
            mutter('this test errored')
1690
 
            raise RuntimeError('gotcha')
1691
 
 
1692
 
        def test_missing_feature(self):
1693
 
            mutter('missing the feature')
1694
 
            self.requireFeature(missing_feature)
1695
 
 
1696
 
        def test_skip(self):
1697
 
            mutter('this test will be skipped')
1698
 
            raise tests.TestSkipped('reason')
1699
 
 
1700
 
        def test_success(self):
1701
 
            mutter('this test succeeds')
1702
 
 
1703
 
        def test_xfail(self):
1704
 
            mutter('test with expected failure')
1705
 
            self.knownFailure('this_fails')
1706
 
 
1707
 
        def test_unexpected_success(self):
1708
 
            mutter('test with unexpected success')
1709
 
            self.expectFailure('should_fail', lambda: None)
1710
 
 
1711
 
    return ExampleTests(name)
1712
 
 
1713
 
 
1714
 
class TestTestCaseLogDetails(tests.TestCase):
1715
 
 
1716
 
    def _run_test(self, test_name):
1717
 
        test = _get_test(test_name)
1718
 
        result = testtools.TestResult()
1719
 
        test.run(result)
1720
 
        return result
1721
 
 
1722
 
    def test_fail_has_log(self):
1723
 
        result = self._run_test('test_fail')
1724
 
        self.assertEqual(1, len(result.failures))
1725
 
        result_content = result.failures[0][1]
1726
 
        self.assertContainsRe(result_content, 'Text attachment: log')
1727
 
        self.assertContainsRe(result_content, 'this was a failing test')
1728
 
 
1729
 
    def test_error_has_log(self):
1730
 
        result = self._run_test('test_error')
1731
 
        self.assertEqual(1, len(result.errors))
1732
 
        result_content = result.errors[0][1]
1733
 
        self.assertContainsRe(result_content, 'Text attachment: log')
1734
 
        self.assertContainsRe(result_content, 'this test errored')
1735
 
 
1736
 
    def test_skip_has_no_log(self):
1737
 
        result = self._run_test('test_skip')
1738
 
        self.assertEqual(['reason'], result.skip_reasons.keys())
1739
 
        skips = result.skip_reasons['reason']
1740
 
        self.assertEqual(1, len(skips))
1741
 
        test = skips[0]
1742
 
        self.assertFalse('log' in test.getDetails())
1743
 
 
1744
 
    def test_missing_feature_has_no_log(self):
1745
 
        # testtools doesn't know about addNotSupported, so it just gets
1746
 
        # considered as a skip
1747
 
        result = self._run_test('test_missing_feature')
1748
 
        self.assertEqual([missing_feature], result.skip_reasons.keys())
1749
 
        skips = result.skip_reasons[missing_feature]
1750
 
        self.assertEqual(1, len(skips))
1751
 
        test = skips[0]
1752
 
        self.assertFalse('log' in test.getDetails())
1753
 
 
1754
 
    def test_xfail_has_no_log(self):
1755
 
        result = self._run_test('test_xfail')
1756
 
        self.assertEqual(1, len(result.expectedFailures))
1757
 
        result_content = result.expectedFailures[0][1]
1758
 
        self.assertNotContainsRe(result_content, 'Text attachment: log')
1759
 
        self.assertNotContainsRe(result_content, 'test with expected failure')
1760
 
 
1761
 
    def test_unexpected_success_has_log(self):
1762
 
        result = self._run_test('test_unexpected_success')
1763
 
        self.assertEqual(1, len(result.unexpectedSuccesses))
1764
 
        # Inconsistency, unexpectedSuccesses is a list of tests,
1765
 
        # expectedFailures is a list of reasons?
1766
 
        test = result.unexpectedSuccesses[0]
1767
 
        details = test.getDetails()
1768
 
        self.assertTrue('log' in details)
1769
 
 
1770
 
 
1771
 
class TestTestCloning(tests.TestCase):
1772
 
    """Tests that test cloning of TestCases (as used by multiply_tests)."""
1773
 
 
1774
 
    def test_cloned_testcase_does_not_share_details(self):
1775
 
        """A TestCase cloned with clone_test does not share mutable attributes
1776
 
        such as details or cleanups.
1777
 
        """
1778
 
        class Test(tests.TestCase):
1779
 
            def test_foo(self):
1780
 
                self.addDetail('foo', Content('text/plain', lambda: 'foo'))
1781
 
        orig_test = Test('test_foo')
1782
 
        cloned_test = tests.clone_test(orig_test, orig_test.id() + '(cloned)')
1783
 
        orig_test.run(unittest.TestResult())
1784
 
        self.assertEqual('foo', orig_test.getDetails()['foo'].iter_bytes())
1785
 
        self.assertEqual(None, cloned_test.getDetails().get('foo'))
1786
 
 
1787
 
    def test_double_apply_scenario_preserves_first_scenario(self):
1788
 
        """Applying two levels of scenarios to a test preserves the attributes
1789
 
        added by both scenarios.
1790
 
        """
1791
 
        class Test(tests.TestCase):
1792
 
            def test_foo(self):
1793
 
                pass
1794
 
        test = Test('test_foo')
1795
 
        scenarios_x = [('x=1', {'x': 1}), ('x=2', {'x': 2})]
1796
 
        scenarios_y = [('y=1', {'y': 1}), ('y=2', {'y': 2})]
1797
 
        suite = tests.multiply_tests(test, scenarios_x, unittest.TestSuite())
1798
 
        suite = tests.multiply_tests(suite, scenarios_y, unittest.TestSuite())
1799
 
        all_tests = list(tests.iter_suite_tests(suite))
1800
 
        self.assertLength(4, all_tests)
1801
 
        all_xys = sorted((t.x, t.y) for t in all_tests)
1802
 
        self.assertEqual([(1, 1), (1, 2), (2, 1), (2, 2)], all_xys)
1803
 
 
1804
1686
 
1805
1687
# NB: Don't delete this; it's not actually from 0.11!
1806
1688
@deprecated_function(deprecated_in((0, 11, 0)))
1829
1711
        return sample_deprecated_function()
1830
1712
 
1831
1713
 
1832
 
class TestExtraAssertions(tests.TestCase):
 
1714
class TestExtraAssertions(TestCase):
1833
1715
    """Tests for new test assertions in bzrlib test suite"""
1834
1716
 
1835
1717
    def test_assert_isinstance(self):
1836
1718
        self.assertIsInstance(2, int)
1837
1719
        self.assertIsInstance(u'', basestring)
1838
 
        e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1839
 
        self.assertEquals(str(e),
1840
 
            "None is an instance of <type 'NoneType'> rather than <type 'int'>")
 
1720
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1841
1721
        self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1842
 
        e = self.assertRaises(AssertionError,
1843
 
            self.assertIsInstance, None, int, "it's just not")
1844
 
        self.assertEquals(str(e),
1845
 
            "None is an instance of <type 'NoneType'> rather than <type 'int'>"
1846
 
            ": it's just not")
1847
1722
 
1848
1723
    def test_assertEndsWith(self):
1849
1724
        self.assertEndsWith('foo', 'oo')
1850
1725
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1851
1726
 
1852
 
    def test_assertEqualDiff(self):
1853
 
        e = self.assertRaises(AssertionError,
1854
 
                              self.assertEqualDiff, '', '\n')
1855
 
        self.assertEquals(str(e),
1856
 
                          # Don't blink ! The '+' applies to the second string
1857
 
                          'first string is missing a final newline.\n+ \n')
1858
 
        e = self.assertRaises(AssertionError,
1859
 
                              self.assertEqualDiff, '\n', '')
1860
 
        self.assertEquals(str(e),
1861
 
                          # Don't blink ! The '-' applies to the second string
1862
 
                          'second string is missing a final newline.\n- \n')
1863
 
 
1864
 
 
1865
 
class TestDeprecations(tests.TestCase):
1866
 
 
1867
1727
    def test_applyDeprecated_not_deprecated(self):
1868
1728
        sample_object = ApplyDeprecatedHelper()
1869
1729
        # calling an undeprecated callable raises an assertion
1912
1772
        self.callDeprecated([], testfunc, be_deprecated=False)
1913
1773
 
1914
1774
 
1915
 
class TestWarningTests(tests.TestCase):
 
1775
class TestWarningTests(TestCase):
1916
1776
    """Tests for calling methods that raise warnings."""
1917
1777
 
1918
1778
    def test_callCatchWarnings(self):
1928
1788
        self.assertEquals("this is your last warning", str(w0))
1929
1789
 
1930
1790
 
1931
 
class TestConvenienceMakers(tests.TestCaseWithTransport):
 
1791
class TestConvenienceMakers(TestCaseWithTransport):
1932
1792
    """Test for the make_* convenience functions."""
1933
1793
 
1934
1794
    def test_make_branch_and_tree_with_format(self):
1935
1795
        # we should be able to supply a format to make_branch_and_tree
1936
1796
        self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
 
1797
        self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
1937
1798
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
1938
1799
                              bzrlib.bzrdir.BzrDirMetaFormat1)
 
1800
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
 
1801
                              bzrlib.bzrdir.BzrDirFormat6)
1939
1802
 
1940
1803
    def test_make_branch_and_memory_tree(self):
1941
1804
        # we should be able to get a new branch and a mutable tree from
1943
1806
        tree = self.make_branch_and_memory_tree('a')
1944
1807
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1945
1808
 
1946
 
    def test_make_tree_for_local_vfs_backed_transport(self):
1947
 
        # make_branch_and_tree has to use local branch and repositories
1948
 
        # when the vfs transport and local disk are colocated, even if
1949
 
        # a different transport is in use for url generation.
1950
 
        self.transport_server = test_server.FakeVFATServer
1951
 
        self.assertFalse(self.get_url('t1').startswith('file://'))
 
1809
 
 
1810
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
 
1811
 
 
1812
    def test_make_tree_for_sftp_branch(self):
 
1813
        """Transports backed by local directories create local trees."""
 
1814
 
1952
1815
        tree = self.make_branch_and_tree('t1')
1953
1816
        base = tree.bzrdir.root_transport.base
1954
 
        self.assertStartsWith(base, 'file://')
 
1817
        self.failIf(base.startswith('sftp'),
 
1818
                'base %r is on sftp but should be local' % base)
1955
1819
        self.assertEquals(tree.bzrdir.root_transport,
1956
1820
                tree.branch.bzrdir.root_transport)
1957
1821
        self.assertEquals(tree.bzrdir.root_transport,
1958
1822
                tree.branch.repository.bzrdir.root_transport)
1959
1823
 
1960
1824
 
1961
 
class SelfTestHelper(object):
1962
 
 
1963
 
    def run_selftest(self, **kwargs):
1964
 
        """Run selftest returning its output."""
1965
 
        output = StringIO()
1966
 
        old_transport = bzrlib.tests.default_transport
1967
 
        old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
1968
 
        tests.TestCaseWithMemoryTransport.TEST_ROOT = None
1969
 
        try:
1970
 
            self.assertEqual(True, tests.selftest(stream=output, **kwargs))
1971
 
        finally:
1972
 
            bzrlib.tests.default_transport = old_transport
1973
 
            tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
1974
 
        output.seek(0)
1975
 
        return output
1976
 
 
1977
 
 
1978
 
class TestSelftest(tests.TestCase, SelfTestHelper):
 
1825
class TestSelftest(TestCase):
1979
1826
    """Tests of bzrlib.tests.selftest."""
1980
1827
 
1981
1828
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1982
1829
        factory_called = []
1983
1830
        def factory():
1984
1831
            factory_called.append(True)
1985
 
            return TestUtil.TestSuite()
 
1832
            return TestSuite()
1986
1833
        out = StringIO()
1987
1834
        err = StringIO()
1988
1835
        self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1989
1836
            test_suite_factory=factory)
1990
1837
        self.assertEqual([True], factory_called)
1991
1838
 
1992
 
    def factory(self):
1993
 
        """A test suite factory."""
1994
 
        class Test(tests.TestCase):
1995
 
            def a(self):
1996
 
                pass
1997
 
            def b(self):
1998
 
                pass
1999
 
            def c(self):
2000
 
                pass
2001
 
        return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
2002
 
 
2003
 
    def test_list_only(self):
2004
 
        output = self.run_selftest(test_suite_factory=self.factory,
2005
 
            list_only=True)
2006
 
        self.assertEqual(3, len(output.readlines()))
2007
 
 
2008
 
    def test_list_only_filtered(self):
2009
 
        output = self.run_selftest(test_suite_factory=self.factory,
2010
 
            list_only=True, pattern="Test.b")
2011
 
        self.assertEndsWith(output.getvalue(), "Test.b\n")
2012
 
        self.assertLength(1, output.readlines())
2013
 
 
2014
 
    def test_list_only_excludes(self):
2015
 
        output = self.run_selftest(test_suite_factory=self.factory,
2016
 
            list_only=True, exclude_pattern="Test.b")
2017
 
        self.assertNotContainsRe("Test.b", output.getvalue())
2018
 
        self.assertLength(2, output.readlines())
2019
 
 
2020
 
    def test_lsprof_tests(self):
2021
 
        self.requireFeature(test_lsprof.LSProfFeature)
2022
 
        calls = []
2023
 
        class Test(object):
2024
 
            def __call__(test, result):
2025
 
                test.run(result)
2026
 
            def run(test, result):
2027
 
                self.assertIsInstance(result, ExtendedToOriginalDecorator)
2028
 
                calls.append("called")
2029
 
            def countTestCases(self):
2030
 
                return 1
2031
 
        self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
2032
 
        self.assertLength(1, calls)
2033
 
 
2034
 
    def test_random(self):
2035
 
        # test randomising by listing a number of tests.
2036
 
        output_123 = self.run_selftest(test_suite_factory=self.factory,
2037
 
            list_only=True, random_seed="123")
2038
 
        output_234 = self.run_selftest(test_suite_factory=self.factory,
2039
 
            list_only=True, random_seed="234")
2040
 
        self.assertNotEqual(output_123, output_234)
2041
 
        # "Randominzing test order..\n\n
2042
 
        self.assertLength(5, output_123.readlines())
2043
 
        self.assertLength(5, output_234.readlines())
2044
 
 
2045
 
    def test_random_reuse_is_same_order(self):
2046
 
        # test randomising by listing a number of tests.
2047
 
        expected = self.run_selftest(test_suite_factory=self.factory,
2048
 
            list_only=True, random_seed="123")
2049
 
        repeated = self.run_selftest(test_suite_factory=self.factory,
2050
 
            list_only=True, random_seed="123")
2051
 
        self.assertEqual(expected.getvalue(), repeated.getvalue())
2052
 
 
2053
 
    def test_runner_class(self):
2054
 
        self.requireFeature(features.subunit)
2055
 
        from subunit import ProtocolTestCase
2056
 
        stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
2057
 
            test_suite_factory=self.factory)
2058
 
        test = ProtocolTestCase(stream)
2059
 
        result = unittest.TestResult()
2060
 
        test.run(result)
2061
 
        self.assertEqual(3, result.testsRun)
2062
 
 
2063
 
    def test_starting_with_single_argument(self):
2064
 
        output = self.run_selftest(test_suite_factory=self.factory,
2065
 
            starting_with=['bzrlib.tests.test_selftest.Test.a'],
2066
 
            list_only=True)
2067
 
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
2068
 
            output.getvalue())
2069
 
 
2070
 
    def test_starting_with_multiple_argument(self):
2071
 
        output = self.run_selftest(test_suite_factory=self.factory,
2072
 
            starting_with=['bzrlib.tests.test_selftest.Test.a',
2073
 
                'bzrlib.tests.test_selftest.Test.b'],
2074
 
            list_only=True)
2075
 
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
2076
 
            'bzrlib.tests.test_selftest.Test.b\n',
2077
 
            output.getvalue())
2078
 
 
2079
 
    def check_transport_set(self, transport_server):
2080
 
        captured_transport = []
2081
 
        def seen_transport(a_transport):
2082
 
            captured_transport.append(a_transport)
2083
 
        class Capture(tests.TestCase):
2084
 
            def a(self):
2085
 
                seen_transport(bzrlib.tests.default_transport)
2086
 
        def factory():
2087
 
            return TestUtil.TestSuite([Capture("a")])
2088
 
        self.run_selftest(transport=transport_server, test_suite_factory=factory)
2089
 
        self.assertEqual(transport_server, captured_transport[0])
2090
 
 
2091
 
    def test_transport_sftp(self):
2092
 
        self.requireFeature(features.paramiko)
2093
 
        from bzrlib.tests import stub_sftp
2094
 
        self.check_transport_set(stub_sftp.SFTPAbsoluteServer)
2095
 
 
2096
 
    def test_transport_memory(self):
2097
 
        self.check_transport_set(memory.MemoryServer)
2098
 
 
2099
 
 
2100
 
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
2101
 
    # Does IO: reads test.list
2102
 
 
2103
 
    def test_load_list(self):
2104
 
        # Provide a list with one test - this test.
2105
 
        test_id_line = '%s\n' % self.id()
2106
 
        self.build_tree_contents([('test.list', test_id_line)])
2107
 
        # And generate a list of the tests in  the suite.
2108
 
        stream = self.run_selftest(load_list='test.list', list_only=True)
2109
 
        self.assertEqual(test_id_line, stream.getvalue())
2110
 
 
2111
 
    def test_load_unknown(self):
2112
 
        # Provide a list with one test - this test.
2113
 
        # And generate a list of the tests in  the suite.
2114
 
        err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
2115
 
            load_list='missing file name', list_only=True)
2116
 
 
2117
 
 
2118
 
class TestSubunitLogDetails(tests.TestCase, SelfTestHelper):
2119
 
 
2120
 
    _test_needs_features = [features.subunit]
2121
 
 
2122
 
    def run_subunit_stream(self, test_name):
2123
 
        from subunit import ProtocolTestCase
2124
 
        def factory():
2125
 
            return TestUtil.TestSuite([_get_test(test_name)])
2126
 
        stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
2127
 
            test_suite_factory=factory)
2128
 
        test = ProtocolTestCase(stream)
2129
 
        result = testtools.TestResult()
2130
 
        test.run(result)
2131
 
        content = stream.getvalue()
2132
 
        return content, result
2133
 
 
2134
 
    def test_fail_has_log(self):
2135
 
        content, result = self.run_subunit_stream('test_fail')
2136
 
        self.assertEqual(1, len(result.failures))
2137
 
        self.assertContainsRe(content, '(?m)^log$')
2138
 
        self.assertContainsRe(content, 'this test will fail')
2139
 
 
2140
 
    def test_error_has_log(self):
2141
 
        content, result = self.run_subunit_stream('test_error')
2142
 
        self.assertContainsRe(content, '(?m)^log$')
2143
 
        self.assertContainsRe(content, 'this test errored')
2144
 
 
2145
 
    def test_skip_has_no_log(self):
2146
 
        content, result = self.run_subunit_stream('test_skip')
2147
 
        self.assertNotContainsRe(content, '(?m)^log$')
2148
 
        self.assertNotContainsRe(content, 'this test will be skipped')
2149
 
        self.assertEqual(['reason'], result.skip_reasons.keys())
2150
 
        skips = result.skip_reasons['reason']
2151
 
        self.assertEqual(1, len(skips))
2152
 
        test = skips[0]
2153
 
        # RemotedTestCase doesn't preserve the "details"
2154
 
        ## self.assertFalse('log' in test.getDetails())
2155
 
 
2156
 
    def test_missing_feature_has_no_log(self):
2157
 
        content, result = self.run_subunit_stream('test_missing_feature')
2158
 
        self.assertNotContainsRe(content, '(?m)^log$')
2159
 
        self.assertNotContainsRe(content, 'missing the feature')
2160
 
        self.assertEqual(['_MissingFeature\n'], result.skip_reasons.keys())
2161
 
        skips = result.skip_reasons['_MissingFeature\n']
2162
 
        self.assertEqual(1, len(skips))
2163
 
        test = skips[0]
2164
 
        # RemotedTestCase doesn't preserve the "details"
2165
 
        ## self.assertFalse('log' in test.getDetails())
2166
 
 
2167
 
    def test_xfail_has_no_log(self):
2168
 
        content, result = self.run_subunit_stream('test_xfail')
2169
 
        self.assertNotContainsRe(content, '(?m)^log$')
2170
 
        self.assertNotContainsRe(content, 'test with expected failure')
2171
 
        self.assertEqual(1, len(result.expectedFailures))
2172
 
        result_content = result.expectedFailures[0][1]
2173
 
        self.assertNotContainsRe(result_content, 'Text attachment: log')
2174
 
        self.assertNotContainsRe(result_content, 'test with expected failure')
2175
 
 
2176
 
    def test_unexpected_success_has_log(self):
2177
 
        content, result = self.run_subunit_stream('test_unexpected_success')
2178
 
        self.assertContainsRe(content, '(?m)^log$')
2179
 
        self.assertContainsRe(content, 'test with unexpected success')
2180
 
        self.expectFailure('subunit treats "unexpectedSuccess"'
2181
 
                           ' as a plain success',
2182
 
            self.assertEqual, 1, len(result.unexpectedSuccesses))
2183
 
        self.assertEqual(1, len(result.unexpectedSuccesses))
2184
 
        test = result.unexpectedSuccesses[0]
2185
 
        # RemotedTestCase doesn't preserve the "details"
2186
 
        ## self.assertTrue('log' in test.getDetails())
2187
 
 
2188
 
    def test_success_has_no_log(self):
2189
 
        content, result = self.run_subunit_stream('test_success')
2190
 
        self.assertEqual(1, result.testsRun)
2191
 
        self.assertNotContainsRe(content, '(?m)^log$')
2192
 
        self.assertNotContainsRe(content, 'this test succeeds')
2193
 
 
2194
 
 
2195
 
class TestRunBzr(tests.TestCase):
2196
 
 
2197
 
    out = ''
2198
 
    err = ''
2199
 
 
2200
 
    def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
2201
 
                         working_dir=None):
2202
 
        """Override _run_bzr_core to test how it is invoked by run_bzr.
2203
 
 
2204
 
        Attempts to run bzr from inside this class don't actually run it.
2205
 
 
2206
 
        We test how run_bzr actually invokes bzr in another location.  Here we
2207
 
        only need to test that it passes the right parameters to run_bzr.
2208
 
        """
2209
 
        self.argv = list(argv)
2210
 
        self.retcode = retcode
2211
 
        self.encoding = encoding
2212
 
        self.stdin = stdin
2213
 
        self.working_dir = working_dir
2214
 
        return self.retcode, self.out, self.err
2215
 
 
2216
 
    def test_run_bzr_error(self):
2217
 
        self.out = "It sure does!\n"
2218
 
        out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
2219
 
        self.assertEqual(['rocks'], self.argv)
2220
 
        self.assertEqual(34, self.retcode)
2221
 
        self.assertEqual('It sure does!\n', out)
2222
 
        self.assertEquals(out, self.out)
2223
 
        self.assertEqual('', err)
2224
 
        self.assertEquals(err, self.err)
2225
 
 
2226
 
    def test_run_bzr_error_regexes(self):
2227
 
        self.out = ''
2228
 
        self.err = "bzr: ERROR: foobarbaz is not versioned"
2229
 
        out, err = self.run_bzr_error(
2230
 
            ["bzr: ERROR: foobarbaz is not versioned"],
2231
 
            ['file-id', 'foobarbaz'])
2232
 
 
2233
 
    def test_encoding(self):
2234
 
        """Test that run_bzr passes encoding to _run_bzr_core"""
2235
 
        self.run_bzr('foo bar')
2236
 
        self.assertEqual(None, self.encoding)
2237
 
        self.assertEqual(['foo', 'bar'], self.argv)
2238
 
 
2239
 
        self.run_bzr('foo bar', encoding='baz')
2240
 
        self.assertEqual('baz', self.encoding)
2241
 
        self.assertEqual(['foo', 'bar'], self.argv)
2242
 
 
2243
 
    def test_retcode(self):
2244
 
        """Test that run_bzr passes retcode to _run_bzr_core"""
2245
 
        # Default is retcode == 0
2246
 
        self.run_bzr('foo bar')
2247
 
        self.assertEqual(0, self.retcode)
2248
 
        self.assertEqual(['foo', 'bar'], self.argv)
2249
 
 
2250
 
        self.run_bzr('foo bar', retcode=1)
2251
 
        self.assertEqual(1, self.retcode)
2252
 
        self.assertEqual(['foo', 'bar'], self.argv)
2253
 
 
2254
 
        self.run_bzr('foo bar', retcode=None)
2255
 
        self.assertEqual(None, self.retcode)
2256
 
        self.assertEqual(['foo', 'bar'], self.argv)
2257
 
 
2258
 
        self.run_bzr(['foo', 'bar'], retcode=3)
2259
 
        self.assertEqual(3, self.retcode)
2260
 
        self.assertEqual(['foo', 'bar'], self.argv)
2261
 
 
2262
 
    def test_stdin(self):
2263
 
        # test that the stdin keyword to run_bzr is passed through to
2264
 
        # _run_bzr_core as-is. We do this by overriding
2265
 
        # _run_bzr_core in this class, and then calling run_bzr,
2266
 
        # which is a convenience function for _run_bzr_core, so
2267
 
        # should invoke it.
2268
 
        self.run_bzr('foo bar', stdin='gam')
2269
 
        self.assertEqual('gam', self.stdin)
2270
 
        self.assertEqual(['foo', 'bar'], self.argv)
2271
 
 
2272
 
        self.run_bzr('foo bar', stdin='zippy')
2273
 
        self.assertEqual('zippy', self.stdin)
2274
 
        self.assertEqual(['foo', 'bar'], self.argv)
2275
 
 
2276
 
    def test_working_dir(self):
2277
 
        """Test that run_bzr passes working_dir to _run_bzr_core"""
2278
 
        self.run_bzr('foo bar')
2279
 
        self.assertEqual(None, self.working_dir)
2280
 
        self.assertEqual(['foo', 'bar'], self.argv)
2281
 
 
2282
 
        self.run_bzr('foo bar', working_dir='baz')
2283
 
        self.assertEqual('baz', self.working_dir)
2284
 
        self.assertEqual(['foo', 'bar'], self.argv)
2285
 
 
2286
 
    def test_reject_extra_keyword_arguments(self):
2287
 
        self.assertRaises(TypeError, self.run_bzr, "foo bar",
2288
 
                          error_regex=['error message'])
2289
 
 
2290
 
 
2291
 
class TestRunBzrCaptured(tests.TestCaseWithTransport):
2292
 
    # Does IO when testing the working_dir parameter.
2293
 
 
2294
 
    def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2295
 
                         a_callable=None, *args, **kwargs):
2296
 
        self.stdin = stdin
2297
 
        self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
2298
 
        self.factory = bzrlib.ui.ui_factory
2299
 
        self.working_dir = osutils.getcwd()
2300
 
        stdout.write('foo\n')
2301
 
        stderr.write('bar\n')
2302
 
        return 0
2303
 
 
2304
 
    def test_stdin(self):
2305
 
        # test that the stdin keyword to _run_bzr_core is passed through to
2306
 
        # apply_redirected as a StringIO. We do this by overriding
2307
 
        # apply_redirected in this class, and then calling _run_bzr_core,
2308
 
        # which calls apply_redirected.
2309
 
        self.run_bzr(['foo', 'bar'], stdin='gam')
2310
 
        self.assertEqual('gam', self.stdin.read())
2311
 
        self.assertTrue(self.stdin is self.factory_stdin)
2312
 
        self.run_bzr(['foo', 'bar'], stdin='zippy')
2313
 
        self.assertEqual('zippy', self.stdin.read())
2314
 
        self.assertTrue(self.stdin is self.factory_stdin)
2315
 
 
2316
 
    def test_ui_factory(self):
2317
 
        # each invocation of self.run_bzr should get its
2318
 
        # own UI factory, which is an instance of TestUIFactory,
2319
 
        # with stdin, stdout and stderr attached to the stdin,
2320
 
        # stdout and stderr of the invoked run_bzr
2321
 
        current_factory = bzrlib.ui.ui_factory
2322
 
        self.run_bzr(['foo'])
2323
 
        self.assertFalse(current_factory is self.factory)
2324
 
        self.assertNotEqual(sys.stdout, self.factory.stdout)
2325
 
        self.assertNotEqual(sys.stderr, self.factory.stderr)
2326
 
        self.assertEqual('foo\n', self.factory.stdout.getvalue())
2327
 
        self.assertEqual('bar\n', self.factory.stderr.getvalue())
2328
 
        self.assertIsInstance(self.factory, tests.TestUIFactory)
2329
 
 
2330
 
    def test_working_dir(self):
2331
 
        self.build_tree(['one/', 'two/'])
2332
 
        cwd = osutils.getcwd()
2333
 
 
2334
 
        # Default is to work in the current directory
2335
 
        self.run_bzr(['foo', 'bar'])
2336
 
        self.assertEqual(cwd, self.working_dir)
2337
 
 
2338
 
        self.run_bzr(['foo', 'bar'], working_dir=None)
2339
 
        self.assertEqual(cwd, self.working_dir)
2340
 
 
2341
 
        # The function should be run in the alternative directory
2342
 
        # but afterwards the current working dir shouldn't be changed
2343
 
        self.run_bzr(['foo', 'bar'], working_dir='one')
2344
 
        self.assertNotEqual(cwd, self.working_dir)
2345
 
        self.assertEndsWith(self.working_dir, 'one')
2346
 
        self.assertEqual(cwd, osutils.getcwd())
2347
 
 
2348
 
        self.run_bzr(['foo', 'bar'], working_dir='two')
2349
 
        self.assertNotEqual(cwd, self.working_dir)
2350
 
        self.assertEndsWith(self.working_dir, 'two')
2351
 
        self.assertEqual(cwd, osutils.getcwd())
2352
 
 
2353
 
 
2354
 
class StubProcess(object):
2355
 
    """A stub process for testing run_bzr_subprocess."""
2356
 
    
2357
 
    def __init__(self, out="", err="", retcode=0):
2358
 
        self.out = out
2359
 
        self.err = err
2360
 
        self.returncode = retcode
2361
 
 
2362
 
    def communicate(self):
2363
 
        return self.out, self.err
2364
 
 
2365
 
 
2366
 
class TestWithFakedStartBzrSubprocess(tests.TestCaseWithTransport):
2367
 
    """Base class for tests testing how we might run bzr."""
2368
 
 
2369
 
    def setUp(self):
2370
 
        tests.TestCaseWithTransport.setUp(self)
2371
 
        self.subprocess_calls = []
2372
 
 
2373
 
    def start_bzr_subprocess(self, process_args, env_changes=None,
2374
 
                             skip_if_plan_to_signal=False,
2375
 
                             working_dir=None,
2376
 
                             allow_plugins=False):
2377
 
        """capture what run_bzr_subprocess tries to do."""
2378
 
        self.subprocess_calls.append({'process_args':process_args,
2379
 
            'env_changes':env_changes,
2380
 
            'skip_if_plan_to_signal':skip_if_plan_to_signal,
2381
 
            'working_dir':working_dir, 'allow_plugins':allow_plugins})
2382
 
        return self.next_subprocess
2383
 
 
2384
 
 
2385
 
class TestRunBzrSubprocess(TestWithFakedStartBzrSubprocess):
2386
 
 
2387
 
    def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
2388
 
        """Run run_bzr_subprocess with args and kwargs using a stubbed process.
2389
 
 
2390
 
        Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
2391
 
        that will return static results. This assertion method populates those
2392
 
        results and also checks the arguments run_bzr_subprocess generates.
2393
 
        """
2394
 
        self.next_subprocess = process
2395
 
        try:
2396
 
            result = self.run_bzr_subprocess(*args, **kwargs)
2397
 
        except:
2398
 
            self.next_subprocess = None
2399
 
            for key, expected in expected_args.iteritems():
2400
 
                self.assertEqual(expected, self.subprocess_calls[-1][key])
2401
 
            raise
 
1839
 
 
1840
class TestKnownFailure(TestCase):
 
1841
 
 
1842
    def test_known_failure(self):
 
1843
        """Check that KnownFailure is defined appropriately."""
 
1844
        # a KnownFailure is an assertion error for compatability with unaware
 
1845
        # runners.
 
1846
        self.assertIsInstance(KnownFailure(""), AssertionError)
 
1847
 
 
1848
    def test_expect_failure(self):
 
1849
        try:
 
1850
            self.expectFailure("Doomed to failure", self.assertTrue, False)
 
1851
        except KnownFailure, e:
 
1852
            self.assertEqual('Doomed to failure', e.args[0])
 
1853
        try:
 
1854
            self.expectFailure("Doomed to failure", self.assertTrue, True)
 
1855
        except AssertionError, e:
 
1856
            self.assertEqual('Unexpected success.  Should have failed:'
 
1857
                             ' Doomed to failure', e.args[0])
2402
1858
        else:
2403
 
            self.next_subprocess = None
2404
 
            for key, expected in expected_args.iteritems():
2405
 
                self.assertEqual(expected, self.subprocess_calls[-1][key])
2406
 
            return result
2407
 
 
2408
 
    def test_run_bzr_subprocess(self):
2409
 
        """The run_bzr_helper_external command behaves nicely."""
2410
 
        self.assertRunBzrSubprocess({'process_args':['--version']},
2411
 
            StubProcess(), '--version')
2412
 
        self.assertRunBzrSubprocess({'process_args':['--version']},
2413
 
            StubProcess(), ['--version'])
2414
 
        # retcode=None disables retcode checking
2415
 
        result = self.assertRunBzrSubprocess({},
2416
 
            StubProcess(retcode=3), '--version', retcode=None)
2417
 
        result = self.assertRunBzrSubprocess({},
2418
 
            StubProcess(out="is free software"), '--version')
2419
 
        self.assertContainsRe(result[0], 'is free software')
2420
 
        # Running a subcommand that is missing errors
2421
 
        self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
2422
 
            {'process_args':['--versionn']}, StubProcess(retcode=3),
2423
 
            '--versionn')
2424
 
        # Unless it is told to expect the error from the subprocess
2425
 
        result = self.assertRunBzrSubprocess({},
2426
 
            StubProcess(retcode=3), '--versionn', retcode=3)
2427
 
        # Or to ignore retcode checking
2428
 
        result = self.assertRunBzrSubprocess({},
2429
 
            StubProcess(err="unknown command", retcode=3), '--versionn',
2430
 
            retcode=None)
2431
 
        self.assertContainsRe(result[1], 'unknown command')
2432
 
 
2433
 
    def test_env_change_passes_through(self):
2434
 
        self.assertRunBzrSubprocess(
2435
 
            {'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
2436
 
            StubProcess(), '',
2437
 
            env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
2438
 
 
2439
 
    def test_no_working_dir_passed_as_None(self):
2440
 
        self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
2441
 
 
2442
 
    def test_no_working_dir_passed_through(self):
2443
 
        self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
2444
 
            working_dir='dir')
2445
 
 
2446
 
    def test_run_bzr_subprocess_no_plugins(self):
2447
 
        self.assertRunBzrSubprocess({'allow_plugins': False},
2448
 
            StubProcess(), '')
2449
 
 
2450
 
    def test_allow_plugins(self):
2451
 
        self.assertRunBzrSubprocess({'allow_plugins': True},
2452
 
            StubProcess(), '', allow_plugins=True)
2453
 
 
2454
 
 
2455
 
class TestFinishBzrSubprocess(TestWithFakedStartBzrSubprocess):
2456
 
 
2457
 
    def test_finish_bzr_subprocess_with_error(self):
2458
 
        """finish_bzr_subprocess allows specification of the desired exit code.
2459
 
        """
2460
 
        process = StubProcess(err="unknown command", retcode=3)
2461
 
        result = self.finish_bzr_subprocess(process, retcode=3)
2462
 
        self.assertEqual('', result[0])
2463
 
        self.assertContainsRe(result[1], 'unknown command')
2464
 
 
2465
 
    def test_finish_bzr_subprocess_ignoring_retcode(self):
2466
 
        """finish_bzr_subprocess allows the exit code to be ignored."""
2467
 
        process = StubProcess(err="unknown command", retcode=3)
2468
 
        result = self.finish_bzr_subprocess(process, retcode=None)
2469
 
        self.assertEqual('', result[0])
2470
 
        self.assertContainsRe(result[1], 'unknown command')
2471
 
 
2472
 
    def test_finish_subprocess_with_unexpected_retcode(self):
2473
 
        """finish_bzr_subprocess raises self.failureException if the retcode is
2474
 
        not the expected one.
2475
 
        """
2476
 
        process = StubProcess(err="unknown command", retcode=3)
2477
 
        self.assertRaises(self.failureException, self.finish_bzr_subprocess,
2478
 
                          process)
2479
 
 
2480
 
 
2481
 
class _DontSpawnProcess(Exception):
2482
 
    """A simple exception which just allows us to skip unnecessary steps"""
2483
 
 
2484
 
 
2485
 
class TestStartBzrSubProcess(tests.TestCase):
2486
 
 
2487
 
    def check_popen_state(self):
2488
 
        """Replace to make assertions when popen is called."""
2489
 
 
2490
 
    def _popen(self, *args, **kwargs):
2491
 
        """Record the command that is run, so that we can ensure it is correct"""
2492
 
        self.check_popen_state()
2493
 
        self._popen_args = args
2494
 
        self._popen_kwargs = kwargs
2495
 
        raise _DontSpawnProcess()
2496
 
 
2497
 
    def test_run_bzr_subprocess_no_plugins(self):
2498
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
2499
 
        command = self._popen_args[0]
2500
 
        self.assertEqual(sys.executable, command[0])
2501
 
        self.assertEqual(self.get_bzr_path(), command[1])
2502
 
        self.assertEqual(['--no-plugins'], command[2:])
2503
 
 
2504
 
    def test_allow_plugins(self):
2505
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2506
 
            allow_plugins=True)
2507
 
        command = self._popen_args[0]
2508
 
        self.assertEqual([], command[2:])
2509
 
 
2510
 
    def test_set_env(self):
2511
 
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2512
 
        # set in the child
2513
 
        def check_environment():
2514
 
            self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2515
 
        self.check_popen_state = check_environment
2516
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2517
 
            env_changes={'EXISTANT_ENV_VAR':'set variable'})
2518
 
        # not set in theparent
2519
 
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2520
 
 
2521
 
    def test_run_bzr_subprocess_env_del(self):
2522
 
        """run_bzr_subprocess can remove environment variables too."""
2523
 
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2524
 
        def check_environment():
2525
 
            self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2526
 
        os.environ['EXISTANT_ENV_VAR'] = 'set variable'
2527
 
        self.check_popen_state = check_environment
2528
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2529
 
            env_changes={'EXISTANT_ENV_VAR':None})
2530
 
        # Still set in parent
2531
 
        self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2532
 
        del os.environ['EXISTANT_ENV_VAR']
2533
 
 
2534
 
    def test_env_del_missing(self):
2535
 
        self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2536
 
        def check_environment():
2537
 
            self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2538
 
        self.check_popen_state = check_environment
2539
 
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2540
 
            env_changes={'NON_EXISTANT_ENV_VAR':None})
2541
 
 
2542
 
    def test_working_dir(self):
2543
 
        """Test that we can specify the working dir for the child"""
2544
 
        orig_getcwd = osutils.getcwd
2545
 
        orig_chdir = os.chdir
2546
 
        chdirs = []
2547
 
        def chdir(path):
2548
 
            chdirs.append(path)
2549
 
        os.chdir = chdir
2550
 
        try:
2551
 
            def getcwd():
2552
 
                return 'current'
2553
 
            osutils.getcwd = getcwd
2554
 
            try:
2555
 
                self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2556
 
                    working_dir='foo')
2557
 
            finally:
2558
 
                osutils.getcwd = orig_getcwd
2559
 
        finally:
2560
 
            os.chdir = orig_chdir
2561
 
        self.assertEqual(['foo', 'current'], chdirs)
2562
 
 
2563
 
    def test_get_bzr_path_with_cwd_bzrlib(self):
2564
 
        self.get_source_path = lambda: ""
2565
 
        self.overrideAttr(os.path, "isfile", lambda path: True)
2566
 
        self.assertEqual(self.get_bzr_path(), "bzr")
2567
 
 
2568
 
 
2569
 
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
2570
 
    """Tests that really need to do things with an external bzr."""
2571
 
 
2572
 
    def test_start_and_stop_bzr_subprocess_send_signal(self):
2573
 
        """finish_bzr_subprocess raises self.failureException if the retcode is
2574
 
        not the expected one.
2575
 
        """
2576
 
        self.disable_missing_extensions_warning()
2577
 
        process = self.start_bzr_subprocess(['wait-until-signalled'],
2578
 
                                            skip_if_plan_to_signal=True)
2579
 
        self.assertEqual('running\n', process.stdout.readline())
2580
 
        result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
2581
 
                                            retcode=3)
2582
 
        self.assertEqual('', result[0])
2583
 
        self.assertEqual('bzr: interrupted\n', result[1])
2584
 
 
2585
 
 
2586
 
class TestFeature(tests.TestCase):
 
1859
            self.fail('Assertion not raised')
 
1860
 
 
1861
 
 
1862
class TestFeature(TestCase):
2587
1863
 
2588
1864
    def test_caching(self):
2589
1865
        """Feature._probe is called by the feature at most once."""
2590
 
        class InstrumentedFeature(tests.Feature):
 
1866
        class InstrumentedFeature(Feature):
2591
1867
            def __init__(self):
2592
 
                super(InstrumentedFeature, self).__init__()
 
1868
                Feature.__init__(self)
2593
1869
                self.calls = []
2594
1870
            def _probe(self):
2595
1871
                self.calls.append('_probe')
2602
1878
 
2603
1879
    def test_named_str(self):
2604
1880
        """Feature.__str__ should thunk to feature_name()."""
2605
 
        class NamedFeature(tests.Feature):
 
1881
        class NamedFeature(Feature):
2606
1882
            def feature_name(self):
2607
1883
                return 'symlinks'
2608
1884
        feature = NamedFeature()
2610
1886
 
2611
1887
    def test_default_str(self):
2612
1888
        """Feature.__str__ should default to __class__.__name__."""
2613
 
        class NamedFeature(tests.Feature):
 
1889
        class NamedFeature(Feature):
2614
1890
            pass
2615
1891
        feature = NamedFeature()
2616
1892
        self.assertEqual('NamedFeature', str(feature))
2617
1893
 
2618
1894
 
2619
 
class TestUnavailableFeature(tests.TestCase):
 
1895
class TestUnavailableFeature(TestCase):
2620
1896
 
2621
1897
    def test_access_feature(self):
2622
 
        feature = tests.Feature()
2623
 
        exception = tests.UnavailableFeature(feature)
 
1898
        feature = Feature()
 
1899
        exception = UnavailableFeature(feature)
2624
1900
        self.assertIs(feature, exception.args[0])
2625
1901
 
2626
1902
 
2627
 
simple_thunk_feature = tests._CompatabilityThunkFeature(
2628
 
    deprecated_in((2, 1, 0)),
2629
 
    'bzrlib.tests.test_selftest',
2630
 
    'simple_thunk_feature','UnicodeFilename',
2631
 
    replacement_module='bzrlib.tests'
2632
 
    )
2633
 
 
2634
 
class Test_CompatibilityFeature(tests.TestCase):
2635
 
 
2636
 
    def test_does_thunk(self):
2637
 
        res = self.callDeprecated(
2638
 
            ['bzrlib.tests.test_selftest.simple_thunk_feature was deprecated'
2639
 
             ' in version 2.1.0. Use bzrlib.tests.UnicodeFilename instead.'],
2640
 
            simple_thunk_feature.available)
2641
 
        self.assertEqual(tests.UnicodeFilename.available(), res)
2642
 
 
2643
 
 
2644
 
class TestModuleAvailableFeature(tests.TestCase):
2645
 
 
2646
 
    def test_available_module(self):
2647
 
        feature = tests.ModuleAvailableFeature('bzrlib.tests')
2648
 
        self.assertEqual('bzrlib.tests', feature.module_name)
2649
 
        self.assertEqual('bzrlib.tests', str(feature))
2650
 
        self.assertTrue(feature.available())
2651
 
        self.assertIs(tests, feature.module)
2652
 
 
2653
 
    def test_unavailable_module(self):
2654
 
        feature = tests.ModuleAvailableFeature('bzrlib.no_such_module_exists')
2655
 
        self.assertEqual('bzrlib.no_such_module_exists', str(feature))
2656
 
        self.assertFalse(feature.available())
2657
 
        self.assertIs(None, feature.module)
2658
 
 
2659
 
 
2660
 
class TestSelftestFiltering(tests.TestCase):
 
1903
class TestSelftestFiltering(TestCase):
2661
1904
 
2662
1905
    def setUp(self):
2663
 
        tests.TestCase.setUp(self)
 
1906
        TestCase.setUp(self)
2664
1907
        self.suite = TestUtil.TestSuite()
2665
1908
        self.loader = TestUtil.TestLoader()
2666
 
        self.suite.addTest(self.loader.loadTestsFromModule(
2667
 
            sys.modules['bzrlib.tests.test_selftest']))
 
1909
        self.suite.addTest(self.loader.loadTestsFromModuleNames([
 
1910
            'bzrlib.tests.test_selftest']))
2668
1911
        self.all_names = _test_ids(self.suite)
2669
1912
 
2670
1913
    def test_condition_id_re(self):
2671
1914
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2672
1915
            'test_condition_id_re')
2673
 
        filtered_suite = tests.filter_suite_by_condition(
2674
 
            self.suite, tests.condition_id_re('test_condition_id_re'))
 
1916
        filtered_suite = filter_suite_by_condition(self.suite,
 
1917
            condition_id_re('test_condition_id_re'))
2675
1918
        self.assertEqual([test_name], _test_ids(filtered_suite))
2676
1919
 
2677
1920
    def test_condition_id_in_list(self):
2678
1921
        test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
2679
1922
                      'test_condition_id_in_list']
2680
1923
        id_list = tests.TestIdList(test_names)
2681
 
        filtered_suite = tests.filter_suite_by_condition(
 
1924
        filtered_suite = filter_suite_by_condition(
2682
1925
            self.suite, tests.condition_id_in_list(id_list))
2683
1926
        my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
2684
 
        re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
 
1927
        re_filtered = filter_suite_by_re(self.suite, my_pattern)
2685
1928
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2686
1929
 
2687
1930
    def test_condition_id_startswith(self):
2691
1934
        test_names = [ klass + 'test_condition_id_in_list',
2692
1935
                      klass + 'test_condition_id_startswith',
2693
1936
                     ]
2694
 
        filtered_suite = tests.filter_suite_by_condition(
 
1937
        filtered_suite = filter_suite_by_condition(
2695
1938
            self.suite, tests.condition_id_startswith([start1, start2]))
2696
1939
        self.assertEqual(test_names, _test_ids(filtered_suite))
2697
1940
 
2698
1941
    def test_condition_isinstance(self):
2699
 
        filtered_suite = tests.filter_suite_by_condition(
2700
 
            self.suite, tests.condition_isinstance(self.__class__))
 
1942
        filtered_suite = filter_suite_by_condition(self.suite,
 
1943
            condition_isinstance(self.__class__))
2701
1944
        class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2702
 
        re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
 
1945
        re_filtered = filter_suite_by_re(self.suite, class_pattern)
2703
1946
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2704
1947
 
2705
1948
    def test_exclude_tests_by_condition(self):
2706
1949
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2707
1950
            'test_exclude_tests_by_condition')
2708
 
        filtered_suite = tests.exclude_tests_by_condition(self.suite,
 
1951
        filtered_suite = exclude_tests_by_condition(self.suite,
2709
1952
            lambda x:x.id() == excluded_name)
2710
1953
        self.assertEqual(len(self.all_names) - 1,
2711
1954
            filtered_suite.countTestCases())
2716
1959
 
2717
1960
    def test_exclude_tests_by_re(self):
2718
1961
        self.all_names = _test_ids(self.suite)
2719
 
        filtered_suite = tests.exclude_tests_by_re(self.suite,
2720
 
                                                   'exclude_tests_by_re')
 
1962
        filtered_suite = exclude_tests_by_re(self.suite, 'exclude_tests_by_re')
2721
1963
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2722
1964
            'test_exclude_tests_by_re')
2723
1965
        self.assertEqual(len(self.all_names) - 1,
2730
1972
    def test_filter_suite_by_condition(self):
2731
1973
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2732
1974
            'test_filter_suite_by_condition')
2733
 
        filtered_suite = tests.filter_suite_by_condition(self.suite,
 
1975
        filtered_suite = filter_suite_by_condition(self.suite,
2734
1976
            lambda x:x.id() == test_name)
2735
1977
        self.assertEqual([test_name], _test_ids(filtered_suite))
2736
1978
 
2737
1979
    def test_filter_suite_by_re(self):
2738
 
        filtered_suite = tests.filter_suite_by_re(self.suite,
2739
 
                                                  'test_filter_suite_by_r')
 
1980
        filtered_suite = filter_suite_by_re(self.suite, 'test_filter_suite_by_r')
2740
1981
        filtered_names = _test_ids(filtered_suite)
2741
1982
        self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
2742
1983
            'TestSelftestFiltering.test_filter_suite_by_re'])
2770
2011
 
2771
2012
    def test_preserve_input(self):
2772
2013
        # NB: Surely this is something in the stdlib to do this?
2773
 
        self.assertTrue(self.suite is tests.preserve_input(self.suite))
2774
 
        self.assertTrue("@#$" is tests.preserve_input("@#$"))
 
2014
        self.assertTrue(self.suite is preserve_input(self.suite))
 
2015
        self.assertTrue("@#$" is preserve_input("@#$"))
2775
2016
 
2776
2017
    def test_randomize_suite(self):
2777
 
        randomized_suite = tests.randomize_suite(self.suite)
 
2018
        randomized_suite = randomize_suite(self.suite)
2778
2019
        # randomizing should not add or remove test names.
2779
2020
        self.assertEqual(set(_test_ids(self.suite)),
2780
2021
                         set(_test_ids(randomized_suite)))
2790
2031
 
2791
2032
    def test_split_suit_by_condition(self):
2792
2033
        self.all_names = _test_ids(self.suite)
2793
 
        condition = tests.condition_id_re('test_filter_suite_by_r')
2794
 
        split_suite = tests.split_suite_by_condition(self.suite, condition)
 
2034
        condition = condition_id_re('test_filter_suite_by_r')
 
2035
        split_suite = split_suite_by_condition(self.suite, condition)
2795
2036
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2796
2037
            'test_filter_suite_by_re')
2797
2038
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2802
2043
 
2803
2044
    def test_split_suit_by_re(self):
2804
2045
        self.all_names = _test_ids(self.suite)
2805
 
        split_suite = tests.split_suite_by_re(self.suite,
2806
 
                                              'test_filter_suite_by_r')
 
2046
        split_suite = split_suite_by_re(self.suite, 'test_filter_suite_by_r')
2807
2047
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2808
2048
            'test_filter_suite_by_re')
2809
2049
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2813
2053
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2814
2054
 
2815
2055
 
2816
 
class TestCheckTreeShape(tests.TestCaseWithTransport):
 
2056
class TestCheckInventoryShape(TestCaseWithTransport):
2817
2057
 
2818
 
    def test_check_tree_shape(self):
 
2058
    def test_check_inventory_shape(self):
2819
2059
        files = ['a', 'b/', 'b/c']
2820
2060
        tree = self.make_branch_and_tree('.')
2821
2061
        self.build_tree(files)
2822
2062
        tree.add(files)
2823
2063
        tree.lock_read()
2824
2064
        try:
2825
 
            self.check_tree_shape(tree, files)
 
2065
            self.check_inventory_shape(tree.inventory, files)
2826
2066
        finally:
2827
2067
            tree.unlock()
2828
2068
 
2829
2069
 
2830
 
class TestBlackboxSupport(tests.TestCase):
 
2070
class TestBlackboxSupport(TestCase):
2831
2071
    """Tests for testsuite blackbox features."""
2832
2072
 
2833
2073
    def test_run_bzr_failure_not_caught(self):
2841
2081
        # the test framework
2842
2082
        self.assertEquals('always fails', str(e))
2843
2083
        # check that there's no traceback in the test log
2844
 
        self.assertNotContainsRe(self.get_log(), r'Traceback')
 
2084
        self.assertNotContainsRe(self._get_log(keep_log_file=True),
 
2085
            r'Traceback')
2845
2086
 
2846
2087
    def test_run_bzr_user_error_caught(self):
2847
2088
        # Running bzr in blackbox mode, normal/expected/user errors should be
2848
2089
        # caught in the regular way and turned into an error message plus exit
2849
2090
        # code.
2850
 
        transport_server = memory.MemoryServer()
2851
 
        transport_server.start_server()
2852
 
        self.addCleanup(transport_server.stop_server)
2853
 
        url = transport_server.get_url()
2854
 
        self.permit_url(url)
2855
 
        out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
 
2091
        out, err = self.run_bzr(["log", "/nonexistantpath"], retcode=3)
2856
2092
        self.assertEqual(out, '')
2857
2093
        self.assertContainsRe(err,
2858
2094
            'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
2859
2095
 
2860
2096
 
2861
 
class TestTestLoader(tests.TestCase):
 
2097
class TestTestLoader(TestCase):
2862
2098
    """Tests for the test loader."""
2863
2099
 
2864
2100
    def _get_loader_and_module(self):
2865
2101
        """Gets a TestLoader and a module with one test in it."""
2866
2102
        loader = TestUtil.TestLoader()
2867
2103
        module = {}
2868
 
        class Stub(tests.TestCase):
 
2104
        class Stub(TestCase):
2869
2105
            def test_foo(self):
2870
2106
                pass
2871
2107
        class MyModule(object):
2884
2120
        # load_tests do not need that :)
2885
2121
        def load_tests(self, standard_tests, module, loader):
2886
2122
            result = loader.suiteClass()
2887
 
            for test in tests.iter_suite_tests(standard_tests):
 
2123
            for test in iter_suite_tests(standard_tests):
2888
2124
                result.addTests([test, test])
2889
2125
            return result
2890
2126
        # add a load_tests() method which multiplies the tests from the module.
2909
2145
 
2910
2146
    def _create_suite(self, test_id_list):
2911
2147
 
2912
 
        class Stub(tests.TestCase):
 
2148
        class Stub(TestCase):
2913
2149
            def test_foo(self):
2914
2150
                pass
2915
2151
 
2925
2161
 
2926
2162
    def _test_ids(self, test_suite):
2927
2163
        """Get the ids for the tests in a test suite."""
2928
 
        return [t.id() for t in tests.iter_suite_tests(test_suite)]
 
2164
        return [t.id() for t in iter_suite_tests(test_suite)]
2929
2165
 
2930
2166
    def test_empty_list(self):
2931
2167
        id_list = self._create_id_list([])
2957
2193
        self.assertTrue(id_list.refers_to('mod.class'))
2958
2194
        self.assertTrue(id_list.refers_to('mod.class.meth'))
2959
2195
 
 
2196
    def test_test_suite(self):
 
2197
        # This test is slow, so we do a single test with one test in each
 
2198
        # category
 
2199
        test_list = [
 
2200
            # testmod_names
 
2201
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
 
2202
            'bzrlib.tests.test_selftest.TestTestIdList.test_test_suite',
 
2203
            # transport implementations
 
2204
            'bzrlib.tests.test_transport_implementations.TransportTests'
 
2205
            '.test_abspath(LocalURLServer)',
 
2206
            # modules_to_doctest
 
2207
            'bzrlib.timestamp.format_highres_date',
 
2208
            # plugins can't be tested that way since selftest may be run with
 
2209
            # --no-plugins
 
2210
            ]
 
2211
        suite = tests.test_suite(test_list)
 
2212
        self.assertEquals(test_list, _test_ids(suite))
 
2213
 
2960
2214
    def test_test_suite_matches_id_list_with_unknown(self):
2961
2215
        loader = TestUtil.TestLoader()
2962
2216
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2970
2224
        loader = TestUtil.TestLoader()
2971
2225
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2972
2226
        dupes = loader.suiteClass()
2973
 
        for test in tests.iter_suite_tests(suite):
 
2227
        for test in iter_suite_tests(suite):
2974
2228
            dupes.addTest(test)
2975
2229
            dupes.addTest(test) # Add it again
2976
2230
 
2982
2236
                          duplicates)
2983
2237
 
2984
2238
 
2985
 
class TestTestSuite(tests.TestCase):
2986
 
 
2987
 
    def test__test_suite_testmod_names(self):
2988
 
        # Test that a plausible list of test module names are returned
2989
 
        # by _test_suite_testmod_names.
2990
 
        test_list = tests._test_suite_testmod_names()
2991
 
        self.assertSubset([
2992
 
            'bzrlib.tests.blackbox',
2993
 
            'bzrlib.tests.per_transport',
2994
 
            'bzrlib.tests.test_selftest',
2995
 
            ],
2996
 
            test_list)
2997
 
 
2998
 
    def test__test_suite_modules_to_doctest(self):
2999
 
        # Test that a plausible list of modules to doctest is returned
3000
 
        # by _test_suite_modules_to_doctest.
3001
 
        test_list = tests._test_suite_modules_to_doctest()
3002
 
        if __doc__ is None:
3003
 
            # When docstrings are stripped, there are no modules to doctest
3004
 
            self.assertEqual([], test_list)
3005
 
            return
3006
 
        self.assertSubset([
3007
 
            'bzrlib.timestamp',
3008
 
            ],
3009
 
            test_list)
3010
 
 
3011
 
    def test_test_suite(self):
3012
 
        # test_suite() loads the entire test suite to operate. To avoid this
3013
 
        # overhead, and yet still be confident that things are happening,
3014
 
        # we temporarily replace two functions used by test_suite with 
3015
 
        # test doubles that supply a few sample tests to load, and check they
3016
 
        # are loaded.
3017
 
        calls = []
3018
 
        def testmod_names():
3019
 
            calls.append("testmod_names")
3020
 
            return [
3021
 
                'bzrlib.tests.blackbox.test_branch',
3022
 
                'bzrlib.tests.per_transport',
3023
 
                'bzrlib.tests.test_selftest',
3024
 
                ]
3025
 
        self.overrideAttr(tests, '_test_suite_testmod_names', testmod_names)
3026
 
        def doctests():
3027
 
            calls.append("modules_to_doctest")
3028
 
            if __doc__ is None:
3029
 
                return []
3030
 
            return ['bzrlib.timestamp']
3031
 
        self.overrideAttr(tests, '_test_suite_modules_to_doctest', doctests)
3032
 
        expected_test_list = [
3033
 
            # testmod_names
3034
 
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
3035
 
            ('bzrlib.tests.per_transport.TransportTests'
3036
 
             '.test_abspath(LocalTransport,LocalURLServer)'),
3037
 
            'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
3038
 
            # plugins can't be tested that way since selftest may be run with
3039
 
            # --no-plugins
3040
 
            ]
3041
 
        if __doc__ is not None:
3042
 
            expected_test_list.extend([
3043
 
                # modules_to_doctest
3044
 
                'bzrlib.timestamp.format_highres_date',
3045
 
                ])
3046
 
        suite = tests.test_suite()
3047
 
        self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
3048
 
            set(calls))
3049
 
        self.assertSubset(expected_test_list, _test_ids(suite))
3050
 
 
3051
 
    def test_test_suite_list_and_start(self):
3052
 
        # We cannot test this at the same time as the main load, because we want
3053
 
        # to know that starting_with == None works. So a second load is
3054
 
        # incurred - note that the starting_with parameter causes a partial load
3055
 
        # rather than a full load so this test should be pretty quick.
3056
 
        test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
3057
 
        suite = tests.test_suite(test_list,
3058
 
                                 ['bzrlib.tests.test_selftest.TestTestSuite'])
3059
 
        # test_test_suite_list_and_start is not included 
3060
 
        self.assertEquals(test_list, _test_ids(suite))
3061
 
 
3062
 
 
3063
2239
class TestLoadTestIdList(tests.TestCaseInTempDir):
3064
2240
 
3065
2241
    def _create_test_list_file(self, file_name, content):
3103
2279
    def test_load_tests(self):
3104
2280
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
3105
2281
        loader = self._create_loader(test_list)
 
2282
 
3106
2283
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3107
2284
        self.assertEquals(test_list, _test_ids(suite))
3108
2285
 
3109
2286
    def test_exclude_tests(self):
3110
2287
        test_list = ['bogus']
3111
2288
        loader = self._create_loader(test_list)
 
2289
 
3112
2290
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3113
2291
        self.assertEquals([], _test_ids(suite))
3114
2292
 
3159
2337
        tpr.register('bar', 'bbb.aaa.rrr')
3160
2338
        tpr.register('bar', 'bBB.aAA.rRR')
3161
2339
        self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
3162
 
        self.assertThat(self.get_log(),
3163
 
            DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR",
3164
 
                           doctest.ELLIPSIS))
 
2340
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
2341
                              r'.*bar.*bbb.aaa.rrr.*bBB.aAA.rRR')
3165
2342
 
3166
2343
    def test_get_unknown_prefix(self):
3167
2344
        tpr = self._get_registry()
3187
2364
        self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
3188
2365
 
3189
2366
 
3190
 
class TestThreadLeakDetection(tests.TestCase):
3191
 
    """Ensure when tests leak threads we detect and report it"""
3192
 
 
3193
 
    class LeakRecordingResult(tests.ExtendedTestResult):
3194
 
        def __init__(self):
3195
 
            tests.ExtendedTestResult.__init__(self, StringIO(), 0, 1)
3196
 
            self.leaks = []
3197
 
        def _report_thread_leak(self, test, leaks, alive):
3198
 
            self.leaks.append((test, leaks))
3199
 
 
3200
 
    def test_testcase_without_addCleanups(self):
3201
 
        """Check old TestCase instances don't break with leak detection"""
3202
 
        class Test(unittest.TestCase):
3203
 
            def runTest(self):
3204
 
                pass
3205
 
        result = self.LeakRecordingResult()
3206
 
        test = Test()
3207
 
        result.startTestRun()
3208
 
        test.run(result)
3209
 
        result.stopTestRun()
3210
 
        self.assertEqual(result._tests_leaking_threads_count, 0)
3211
 
        self.assertEqual(result.leaks, [])
3212
 
        
3213
 
    def test_thread_leak(self):
3214
 
        """Ensure a thread that outlives the running of a test is reported
3215
 
 
3216
 
        Uses a thread that blocks on an event, and is started by the inner
3217
 
        test case. As the thread outlives the inner case's run, it should be
3218
 
        detected as a leak, but the event is then set so that the thread can
3219
 
        be safely joined in cleanup so it's not leaked for real.
3220
 
        """
3221
 
        event = threading.Event()
3222
 
        thread = threading.Thread(name="Leaker", target=event.wait)
3223
 
        class Test(tests.TestCase):
3224
 
            def test_leak(self):
3225
 
                thread.start()
3226
 
        result = self.LeakRecordingResult()
3227
 
        test = Test("test_leak")
3228
 
        self.addCleanup(thread.join)
3229
 
        self.addCleanup(event.set)
3230
 
        result.startTestRun()
3231
 
        test.run(result)
3232
 
        result.stopTestRun()
3233
 
        self.assertEqual(result._tests_leaking_threads_count, 1)
3234
 
        self.assertEqual(result._first_thread_leaker_id, test.id())
3235
 
        self.assertEqual(result.leaks, [(test, set([thread]))])
3236
 
        self.assertContainsString(result.stream.getvalue(), "leaking threads")
3237
 
 
3238
 
    def test_multiple_leaks(self):
3239
 
        """Check multiple leaks are blamed on the test cases at fault
3240
 
 
3241
 
        Same concept as the previous test, but has one inner test method that
3242
 
        leaks two threads, and one that doesn't leak at all.
3243
 
        """
3244
 
        event = threading.Event()
3245
 
        thread_a = threading.Thread(name="LeakerA", target=event.wait)
3246
 
        thread_b = threading.Thread(name="LeakerB", target=event.wait)
3247
 
        thread_c = threading.Thread(name="LeakerC", target=event.wait)
3248
 
        class Test(tests.TestCase):
3249
 
            def test_first_leak(self):
3250
 
                thread_b.start()
3251
 
            def test_second_no_leak(self):
3252
 
                pass
3253
 
            def test_third_leak(self):
3254
 
                thread_c.start()
3255
 
                thread_a.start()
3256
 
        result = self.LeakRecordingResult()
3257
 
        first_test = Test("test_first_leak")
3258
 
        third_test = Test("test_third_leak")
3259
 
        self.addCleanup(thread_a.join)
3260
 
        self.addCleanup(thread_b.join)
3261
 
        self.addCleanup(thread_c.join)
3262
 
        self.addCleanup(event.set)
3263
 
        result.startTestRun()
3264
 
        unittest.TestSuite(
3265
 
            [first_test, Test("test_second_no_leak"), third_test]
3266
 
            ).run(result)
3267
 
        result.stopTestRun()
3268
 
        self.assertEqual(result._tests_leaking_threads_count, 2)
3269
 
        self.assertEqual(result._first_thread_leaker_id, first_test.id())
3270
 
        self.assertEqual(result.leaks, [
3271
 
            (first_test, set([thread_b])),
3272
 
            (third_test, set([thread_a, thread_c]))])
3273
 
        self.assertContainsString(result.stream.getvalue(), "leaking threads")
3274
 
 
3275
 
 
3276
 
class TestPostMortemDebugging(tests.TestCase):
3277
 
    """Check post mortem debugging works when tests fail or error"""
3278
 
 
3279
 
    class TracebackRecordingResult(tests.ExtendedTestResult):
3280
 
        def __init__(self):
3281
 
            tests.ExtendedTestResult.__init__(self, StringIO(), 0, 1)
3282
 
            self.postcode = None
3283
 
        def _post_mortem(self, tb=None):
3284
 
            """Record the code object at the end of the current traceback"""
3285
 
            tb = tb or sys.exc_info()[2]
3286
 
            if tb is not None:
3287
 
                next = tb.tb_next
3288
 
                while next is not None:
3289
 
                    tb = next
3290
 
                    next = next.tb_next
3291
 
                self.postcode = tb.tb_frame.f_code
3292
 
        def report_error(self, test, err):
3293
 
            pass
3294
 
        def report_failure(self, test, err):
3295
 
            pass
3296
 
 
3297
 
    def test_location_unittest_error(self):
3298
 
        """Needs right post mortem traceback with erroring unittest case"""
3299
 
        class Test(unittest.TestCase):
3300
 
            def runTest(self):
3301
 
                raise RuntimeError
3302
 
        result = self.TracebackRecordingResult()
3303
 
        Test().run(result)
3304
 
        self.assertEqual(result.postcode, Test.runTest.func_code)
3305
 
 
3306
 
    def test_location_unittest_failure(self):
3307
 
        """Needs right post mortem traceback with failing unittest case"""
3308
 
        class Test(unittest.TestCase):
3309
 
            def runTest(self):
3310
 
                raise self.failureException
3311
 
        result = self.TracebackRecordingResult()
3312
 
        Test().run(result)
3313
 
        self.assertEqual(result.postcode, Test.runTest.func_code)
3314
 
 
3315
 
    def test_location_bt_error(self):
3316
 
        """Needs right post mortem traceback with erroring bzrlib.tests case"""
3317
 
        class Test(tests.TestCase):
3318
 
            def test_error(self):
3319
 
                raise RuntimeError
3320
 
        result = self.TracebackRecordingResult()
3321
 
        Test("test_error").run(result)
3322
 
        self.assertEqual(result.postcode, Test.test_error.func_code)
3323
 
 
3324
 
    def test_location_bt_failure(self):
3325
 
        """Needs right post mortem traceback with failing bzrlib.tests case"""
3326
 
        class Test(tests.TestCase):
3327
 
            def test_failure(self):
3328
 
                raise self.failureException
3329
 
        result = self.TracebackRecordingResult()
3330
 
        Test("test_failure").run(result)
3331
 
        self.assertEqual(result.postcode, Test.test_failure.func_code)
3332
 
 
3333
 
    def test_env_var_triggers_post_mortem(self):
3334
 
        """Check pdb.post_mortem is called iff BZR_TEST_PDB is set"""
3335
 
        import pdb
3336
 
        result = tests.ExtendedTestResult(StringIO(), 0, 1)
3337
 
        post_mortem_calls = []
3338
 
        self.overrideAttr(pdb, "post_mortem", post_mortem_calls.append)
3339
 
        self.overrideEnv('BZR_TEST_PDB', None)
3340
 
        result._post_mortem(1)
3341
 
        self.overrideEnv('BZR_TEST_PDB', 'on')
3342
 
        result._post_mortem(2)
3343
 
        self.assertEqual([2], post_mortem_calls)
3344
 
 
3345
 
 
3346
 
class TestRunSuite(tests.TestCase):
 
2367
class TestRunSuite(TestCase):
3347
2368
 
3348
2369
    def test_runner_class(self):
3349
2370
        """run_suite accepts and uses a runner_class keyword argument."""
3350
 
        class Stub(tests.TestCase):
 
2371
        class Stub(TestCase):
3351
2372
            def test_foo(self):
3352
2373
                pass
3353
2374
        suite = Stub("test_foo")
3354
2375
        calls = []
3355
 
        class MyRunner(tests.TextTestRunner):
 
2376
        class MyRunner(TextTestRunner):
3356
2377
            def run(self, test):
3357
2378
                calls.append(test)
3358
 
                return tests.ExtendedTestResult(self.stream, self.descriptions,
3359
 
                                                self.verbosity)
3360
 
        tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
3361
 
        self.assertLength(1, calls)
3362
 
 
3363
 
 
3364
 
class TestEnvironHandling(tests.TestCase):
3365
 
 
3366
 
    def test_overrideEnv_None_called_twice_doesnt_leak(self):
3367
 
        self.assertFalse('MYVAR' in os.environ)
3368
 
        self.overrideEnv('MYVAR', '42')
3369
 
        # We use an embedded test to make sure we fix the _captureVar bug
3370
 
        class Test(tests.TestCase):
3371
 
            def test_me(self):
3372
 
                # The first call save the 42 value
3373
 
                self.overrideEnv('MYVAR', None)
3374
 
                self.assertEquals(None, os.environ.get('MYVAR'))
3375
 
                # Make sure we can call it twice
3376
 
                self.overrideEnv('MYVAR', None)
3377
 
                self.assertEquals(None, os.environ.get('MYVAR'))
3378
 
        output = StringIO()
3379
 
        result = tests.TextTestResult(output, 0, 1)
3380
 
        Test('test_me').run(result)
3381
 
        if not result.wasStrictlySuccessful():
3382
 
            self.fail(output.getvalue())
3383
 
        # We get our value back
3384
 
        self.assertEquals('42', os.environ.get('MYVAR'))
3385
 
 
3386
 
 
3387
 
class TestIsolatedEnv(tests.TestCase):
3388
 
    """Test isolating tests from os.environ.
3389
 
 
3390
 
    Since we use tests that are already isolated from os.environ a bit of care
3391
 
    should be taken when designing the tests to avoid bootstrap side-effects.
3392
 
    The tests start an already clean os.environ which allow doing valid
3393
 
    assertions about which variables are present or not and design tests around
3394
 
    these assertions.
3395
 
    """
3396
 
 
3397
 
    class ScratchMonkey(tests.TestCase):
3398
 
 
3399
 
        def test_me(self):
 
2379
                return ExtendedTestResult(self.stream, self.descriptions,
 
2380
                    self.verbosity)
 
2381
        run_suite(suite, runner_class=MyRunner, stream=StringIO())
 
2382
        self.assertEqual(calls, [suite])
 
2383
 
 
2384
    def test_done(self):
 
2385
        """run_suite should call result.done()"""
 
2386
        self.calls = 0
 
2387
        def one_more_call(): self.calls += 1
 
2388
        def test_function():
3400
2389
            pass
3401
 
 
3402
 
    def test_basics(self):
3403
 
        # Make sure we know the definition of BZR_HOME: not part of os.environ
3404
 
        # for tests.TestCase.
3405
 
        self.assertTrue('BZR_HOME' in tests.isolated_environ)
3406
 
        self.assertEquals(None, tests.isolated_environ['BZR_HOME'])
3407
 
        # Being part of isolated_environ, BZR_HOME should not appear here
3408
 
        self.assertFalse('BZR_HOME' in os.environ)
3409
 
        # Make sure we know the definition of LINES: part of os.environ for
3410
 
        # tests.TestCase
3411
 
        self.assertTrue('LINES' in tests.isolated_environ)
3412
 
        self.assertEquals('25', tests.isolated_environ['LINES'])
3413
 
        self.assertEquals('25', os.environ['LINES'])
3414
 
 
3415
 
    def test_injecting_unknown_variable(self):
3416
 
        # BZR_HOME is known to be absent from os.environ
3417
 
        test = self.ScratchMonkey('test_me')
3418
 
        tests.override_os_environ(test, {'BZR_HOME': 'foo'})
3419
 
        self.assertEquals('foo', os.environ['BZR_HOME'])
3420
 
        tests.restore_os_environ(test)
3421
 
        self.assertFalse('BZR_HOME' in os.environ)
3422
 
 
3423
 
    def test_injecting_known_variable(self):
3424
 
        test = self.ScratchMonkey('test_me')
3425
 
        # LINES is known to be present in os.environ
3426
 
        tests.override_os_environ(test, {'LINES': '42'})
3427
 
        self.assertEquals('42', os.environ['LINES'])
3428
 
        tests.restore_os_environ(test)
3429
 
        self.assertEquals('25', os.environ['LINES'])
3430
 
 
3431
 
    def test_deleting_variable(self):
3432
 
        test = self.ScratchMonkey('test_me')
3433
 
        # LINES is known to be present in os.environ
3434
 
        tests.override_os_environ(test, {'LINES': None})
3435
 
        self.assertTrue('LINES' not in os.environ)
3436
 
        tests.restore_os_environ(test)
3437
 
        self.assertEquals('25', os.environ['LINES'])
3438
 
 
3439
 
 
3440
 
class TestDocTestSuiteIsolation(tests.TestCase):
3441
 
    """Test that `tests.DocTestSuite` isolates doc tests from os.environ.
3442
 
 
3443
 
    Since tests.TestCase alreay provides an isolation from os.environ, we use
3444
 
    the clean environment as a base for testing. To precisely capture the
3445
 
    isolation provided by tests.DocTestSuite, we use doctest.DocTestSuite to
3446
 
    compare against.
3447
 
 
3448
 
    We want to make sure `tests.DocTestSuite` respect `tests.isolated_environ`,
3449
 
    not `os.environ` so each test overrides it to suit its needs.
3450
 
 
3451
 
    """
3452
 
 
3453
 
    def get_doctest_suite_for_string(self, klass, string):
3454
 
        class Finder(doctest.DocTestFinder):
3455
 
 
3456
 
            def find(*args, **kwargs):
3457
 
                test = doctest.DocTestParser().get_doctest(
3458
 
                    string, {}, 'foo', 'foo.py', 0)
3459
 
                return [test]
3460
 
 
3461
 
        suite = klass(test_finder=Finder())
3462
 
        return suite
3463
 
 
3464
 
    def run_doctest_suite_for_string(self, klass, string):
3465
 
        suite = self.get_doctest_suite_for_string(klass, string)
3466
 
        output = StringIO()
3467
 
        result = tests.TextTestResult(output, 0, 1)
3468
 
        suite.run(result)
3469
 
        return result, output
3470
 
 
3471
 
    def assertDocTestStringSucceds(self, klass, string):
3472
 
        result, output = self.run_doctest_suite_for_string(klass, string)
3473
 
        if not result.wasStrictlySuccessful():
3474
 
            self.fail(output.getvalue())
3475
 
 
3476
 
    def assertDocTestStringFails(self, klass, string):
3477
 
        result, output = self.run_doctest_suite_for_string(klass, string)
3478
 
        if result.wasStrictlySuccessful():
3479
 
            self.fail(output.getvalue())
3480
 
 
3481
 
    def test_injected_variable(self):
3482
 
        self.overrideAttr(tests, 'isolated_environ', {'LINES': '42'})
3483
 
        test = """
3484
 
            >>> import os
3485
 
            >>> os.environ['LINES']
3486
 
            '42'
3487
 
            """
3488
 
        # doctest.DocTestSuite fails as it sees '25'
3489
 
        self.assertDocTestStringFails(doctest.DocTestSuite, test)
3490
 
        # tests.DocTestSuite sees '42'
3491
 
        self.assertDocTestStringSucceds(tests.IsolatedDocTestSuite, test)
3492
 
 
3493
 
    def test_deleted_variable(self):
3494
 
        self.overrideAttr(tests, 'isolated_environ', {'LINES': None})
3495
 
        test = """
3496
 
            >>> import os
3497
 
            >>> os.environ.get('LINES')
3498
 
            """
3499
 
        # doctest.DocTestSuite fails as it sees '25'
3500
 
        self.assertDocTestStringFails(doctest.DocTestSuite, test)
3501
 
        # tests.DocTestSuite sees None
3502
 
        self.assertDocTestStringSucceds(tests.IsolatedDocTestSuite, test)
 
2390
        test = unittest.FunctionTestCase(test_function)
 
2391
        class InstrumentedTestResult(ExtendedTestResult):
 
2392
            def done(self): one_more_call()
 
2393
        class MyRunner(TextTestRunner):
 
2394
            def run(self, test):
 
2395
                return InstrumentedTestResult(self.stream, self.descriptions,
 
2396
                                              self.verbosity)
 
2397
        run_suite(test, runner_class=MyRunner, stream=StringIO())
 
2398
        self.assertEquals(1, self.calls)