~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: Andrew Bennetts
  • Date: 2009-07-01 10:53:08 UTC
  • mto: This revision was merged to the branch mainline in revision 4504.
  • Revision ID: andrew.bennetts@canonical.com-20090701105308-8892qpe3lhikhe3g
RemoveĀ unusedĀ import.

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