/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: INADA Naoki
  • Date: 2010-02-22 08:28:41 UTC
  • mto: (4634.141.1 2.0-integration)
  • mto: This revision was merged to the branch mainline in revision 5075.
  • Revision ID: songofacandy@gmail.com-20100222082841-mqbzd2allwtzpgok
Use O_NOINHERIT flag in AtomicFile.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Tests for the test framework."""
 
18
 
 
19
from cStringIO import StringIO
 
20
import os
 
21
import signal
 
22
import sys
 
23
import time
 
24
import unittest
 
25
import warnings
 
26
 
 
27
import bzrlib
 
28
from bzrlib import (
 
29
    branchbuilder,
 
30
    bzrdir,
 
31
    debug,
 
32
    errors,
 
33
    lockdir,
 
34
    memorytree,
 
35
    osutils,
 
36
    progress,
 
37
    remote,
 
38
    repository,
 
39
    symbol_versioning,
 
40
    tests,
 
41
    workingtree,
 
42
    )
 
43
from bzrlib.repofmt import (
 
44
    groupcompress_repo,
 
45
    pack_repo,
 
46
    weaverepo,
 
47
    )
 
48
from bzrlib.symbol_versioning import (
 
49
    deprecated_function,
 
50
    deprecated_in,
 
51
    deprecated_method,
 
52
    )
 
53
from bzrlib.tests import (
 
54
    SubUnitFeature,
 
55
    test_lsprof,
 
56
    test_sftp_transport,
 
57
    TestUtil,
 
58
    )
 
59
from bzrlib.trace import note
 
60
from bzrlib.transport.memory import MemoryServer, MemoryTransport
 
61
from bzrlib.version import _get_bzr_source_tree
 
62
 
 
63
 
 
64
def _test_ids(test_suite):
 
65
    """Get the ids for the tests in a test suite."""
 
66
    return [t.id() for t in tests.iter_suite_tests(test_suite)]
 
67
 
 
68
 
 
69
class SelftestTests(tests.TestCase):
 
70
 
 
71
    def test_import_tests(self):
 
72
        mod = TestUtil._load_module_by_name('bzrlib.tests.test_selftest')
 
73
        self.assertEqual(mod.SelftestTests, SelftestTests)
 
74
 
 
75
    def test_import_test_failure(self):
 
76
        self.assertRaises(ImportError,
 
77
                          TestUtil._load_module_by_name,
 
78
                          'bzrlib.no-name-yet')
 
79
 
 
80
class MetaTestLog(tests.TestCase):
 
81
 
 
82
    def test_logging(self):
 
83
        """Test logs are captured when a test fails."""
 
84
        self.log('a test message')
 
85
        self._log_file.flush()
 
86
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
87
                              'a test message\n')
 
88
 
 
89
 
 
90
class TestUnicodeFilename(tests.TestCase):
 
91
 
 
92
    def test_probe_passes(self):
 
93
        """UnicodeFilename._probe passes."""
 
94
        # We can't test much more than that because the behaviour depends
 
95
        # on the platform.
 
96
        tests.UnicodeFilename._probe()
 
97
 
 
98
 
 
99
class TestTreeShape(tests.TestCaseInTempDir):
 
100
 
 
101
    def test_unicode_paths(self):
 
102
        self.requireFeature(tests.UnicodeFilename)
 
103
 
 
104
        filename = u'hell\u00d8'
 
105
        self.build_tree_contents([(filename, 'contents of hello')])
 
106
        self.failUnlessExists(filename)
 
107
 
 
108
 
 
109
class TestTransportScenarios(tests.TestCase):
 
110
    """A group of tests that test the transport implementation adaption core.
 
111
 
 
112
    This is a meta test that the tests are applied to all available
 
113
    transports.
 
114
 
 
115
    This will be generalised in the future which is why it is in this
 
116
    test file even though it is specific to transport tests at the moment.
 
117
    """
 
118
 
 
119
    def test_get_transport_permutations(self):
 
120
        # this checks that get_test_permutations defined by the module is
 
121
        # called by the get_transport_test_permutations function.
 
122
        class MockModule(object):
 
123
            def get_test_permutations(self):
 
124
                return sample_permutation
 
125
        sample_permutation = [(1,2), (3,4)]
 
126
        from bzrlib.tests.per_transport import get_transport_test_permutations
 
127
        self.assertEqual(sample_permutation,
 
128
                         get_transport_test_permutations(MockModule()))
 
129
 
 
130
    def test_scenarios_include_all_modules(self):
 
131
        # this checks that the scenario generator returns as many permutations
 
132
        # as there are in all the registered transport modules - we assume if
 
133
        # this matches its probably doing the right thing especially in
 
134
        # combination with the tests for setting the right classes below.
 
135
        from bzrlib.tests.per_transport import transport_test_permutations
 
136
        from bzrlib.transport import _get_transport_modules
 
137
        modules = _get_transport_modules()
 
138
        permutation_count = 0
 
139
        for module in modules:
 
140
            try:
 
141
                permutation_count += len(reduce(getattr,
 
142
                    (module + ".get_test_permutations").split('.')[1:],
 
143
                     __import__(module))())
 
144
            except errors.DependencyNotPresent:
 
145
                pass
 
146
        scenarios = transport_test_permutations()
 
147
        self.assertEqual(permutation_count, len(scenarios))
 
148
 
 
149
    def test_scenarios_include_transport_class(self):
 
150
        # This test used to know about all the possible transports and the
 
151
        # order they were returned but that seems overly brittle (mbp
 
152
        # 20060307)
 
153
        from bzrlib.tests.per_transport import transport_test_permutations
 
154
        scenarios = transport_test_permutations()
 
155
        # there are at least that many builtin transports
 
156
        self.assertTrue(len(scenarios) > 6)
 
157
        one_scenario = scenarios[0]
 
158
        self.assertIsInstance(one_scenario[0], str)
 
159
        self.assertTrue(issubclass(one_scenario[1]["transport_class"],
 
160
                                   bzrlib.transport.Transport))
 
161
        self.assertTrue(issubclass(one_scenario[1]["transport_server"],
 
162
                                   bzrlib.transport.Server))
 
163
 
 
164
 
 
165
class TestBranchScenarios(tests.TestCase):
 
166
 
 
167
    def test_scenarios(self):
 
168
        # check that constructor parameters are passed through to the adapted
 
169
        # test.
 
170
        from bzrlib.tests.per_branch import make_scenarios
 
171
        server1 = "a"
 
172
        server2 = "b"
 
173
        formats = [("c", "C"), ("d", "D")]
 
174
        scenarios = make_scenarios(server1, server2, formats)
 
175
        self.assertEqual(2, len(scenarios))
 
176
        self.assertEqual([
 
177
            ('str',
 
178
             {'branch_format': 'c',
 
179
              'bzrdir_format': 'C',
 
180
              'transport_readonly_server': 'b',
 
181
              'transport_server': 'a'}),
 
182
            ('str',
 
183
             {'branch_format': 'd',
 
184
              'bzrdir_format': 'D',
 
185
              'transport_readonly_server': 'b',
 
186
              'transport_server': 'a'})],
 
187
            scenarios)
 
188
 
 
189
 
 
190
class TestBzrDirScenarios(tests.TestCase):
 
191
 
 
192
    def test_scenarios(self):
 
193
        # check that constructor parameters are passed through to the adapted
 
194
        # test.
 
195
        from bzrlib.tests.per_bzrdir import make_scenarios
 
196
        vfs_factory = "v"
 
197
        server1 = "a"
 
198
        server2 = "b"
 
199
        formats = ["c", "d"]
 
200
        scenarios = make_scenarios(vfs_factory, server1, server2, formats)
 
201
        self.assertEqual([
 
202
            ('str',
 
203
             {'bzrdir_format': 'c',
 
204
              'transport_readonly_server': 'b',
 
205
              'transport_server': 'a',
 
206
              'vfs_transport_factory': 'v'}),
 
207
            ('str',
 
208
             {'bzrdir_format': 'd',
 
209
              'transport_readonly_server': 'b',
 
210
              'transport_server': 'a',
 
211
              'vfs_transport_factory': 'v'})],
 
212
            scenarios)
 
213
 
 
214
 
 
215
class TestRepositoryScenarios(tests.TestCase):
 
216
 
 
217
    def test_formats_to_scenarios(self):
 
218
        from bzrlib.tests.per_repository import formats_to_scenarios
 
219
        formats = [("(c)", remote.RemoteRepositoryFormat()),
 
220
                   ("(d)", repository.format_registry.get(
 
221
                    'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
 
222
        no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
 
223
            None)
 
224
        vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
 
225
            vfs_transport_factory="vfs")
 
226
        # no_vfs generate scenarios without vfs_transport_factory
 
227
        expected = [
 
228
            ('RemoteRepositoryFormat(c)',
 
229
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
 
230
              'repository_format': remote.RemoteRepositoryFormat(),
 
231
              'transport_readonly_server': 'readonly',
 
232
              'transport_server': 'server'}),
 
233
            ('RepositoryFormat2a(d)',
 
234
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
 
235
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
236
              'transport_readonly_server': 'readonly',
 
237
              'transport_server': 'server'})]
 
238
        self.assertEqual(expected, no_vfs_scenarios)
 
239
        self.assertEqual([
 
240
            ('RemoteRepositoryFormat(c)',
 
241
             {'bzrdir_format': remote.RemoteBzrDirFormat(),
 
242
              'repository_format': remote.RemoteRepositoryFormat(),
 
243
              'transport_readonly_server': 'readonly',
 
244
              'transport_server': 'server',
 
245
              'vfs_transport_factory': 'vfs'}),
 
246
            ('RepositoryFormat2a(d)',
 
247
             {'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
 
248
              'repository_format': groupcompress_repo.RepositoryFormat2a(),
 
249
              'transport_readonly_server': 'readonly',
 
250
              'transport_server': 'server',
 
251
              'vfs_transport_factory': 'vfs'})],
 
252
            vfs_scenarios)
 
253
 
 
254
 
 
255
class TestTestScenarioApplication(tests.TestCase):
 
256
    """Tests for the test adaption facilities."""
 
257
 
 
258
    def test_apply_scenario(self):
 
259
        from bzrlib.tests import apply_scenario
 
260
        input_test = TestTestScenarioApplication("test_apply_scenario")
 
261
        # setup two adapted tests
 
262
        adapted_test1 = apply_scenario(input_test,
 
263
            ("new id",
 
264
            {"bzrdir_format":"bzr_format",
 
265
             "repository_format":"repo_fmt",
 
266
             "transport_server":"transport_server",
 
267
             "transport_readonly_server":"readonly-server"}))
 
268
        adapted_test2 = apply_scenario(input_test,
 
269
            ("new id 2", {"bzrdir_format":None}))
 
270
        # input_test should have been altered.
 
271
        self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
 
272
        # the new tests are mutually incompatible, ensuring it has
 
273
        # made new ones, and unspecified elements in the scenario
 
274
        # should not have been altered.
 
275
        self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
 
276
        self.assertEqual("repo_fmt", adapted_test1.repository_format)
 
277
        self.assertEqual("transport_server", adapted_test1.transport_server)
 
278
        self.assertEqual("readonly-server",
 
279
            adapted_test1.transport_readonly_server)
 
280
        self.assertEqual(
 
281
            "bzrlib.tests.test_selftest.TestTestScenarioApplication."
 
282
            "test_apply_scenario(new id)",
 
283
            adapted_test1.id())
 
284
        self.assertEqual(None, adapted_test2.bzrdir_format)
 
285
        self.assertEqual(
 
286
            "bzrlib.tests.test_selftest.TestTestScenarioApplication."
 
287
            "test_apply_scenario(new id 2)",
 
288
            adapted_test2.id())
 
289
 
 
290
 
 
291
class TestInterRepositoryScenarios(tests.TestCase):
 
292
 
 
293
    def test_scenarios(self):
 
294
        # check that constructor parameters are passed through to the adapted
 
295
        # test.
 
296
        from bzrlib.tests.per_interrepository import make_scenarios
 
297
        server1 = "a"
 
298
        server2 = "b"
 
299
        formats = [("C0", "C1", "C2"), ("D0", "D1", "D2")]
 
300
        scenarios = make_scenarios(server1, server2, formats)
 
301
        self.assertEqual([
 
302
            ('C0,str,str',
 
303
             {'repository_format': 'C1',
 
304
              'repository_format_to': 'C2',
 
305
              'transport_readonly_server': 'b',
 
306
              'transport_server': 'a'}),
 
307
            ('D0,str,str',
 
308
             {'repository_format': 'D1',
 
309
              'repository_format_to': 'D2',
 
310
              'transport_readonly_server': 'b',
 
311
              'transport_server': 'a'})],
 
312
            scenarios)
 
313
 
 
314
 
 
315
class TestWorkingTreeScenarios(tests.TestCase):
 
316
 
 
317
    def test_scenarios(self):
 
318
        # check that constructor parameters are passed through to the adapted
 
319
        # test.
 
320
        from bzrlib.tests.per_workingtree import make_scenarios
 
321
        server1 = "a"
 
322
        server2 = "b"
 
323
        formats = [workingtree.WorkingTreeFormat2(),
 
324
                   workingtree.WorkingTreeFormat3(),]
 
325
        scenarios = make_scenarios(server1, server2, formats)
 
326
        self.assertEqual([
 
327
            ('WorkingTreeFormat2',
 
328
             {'bzrdir_format': formats[0]._matchingbzrdir,
 
329
              'transport_readonly_server': 'b',
 
330
              'transport_server': 'a',
 
331
              'workingtree_format': formats[0]}),
 
332
            ('WorkingTreeFormat3',
 
333
             {'bzrdir_format': formats[1]._matchingbzrdir,
 
334
              'transport_readonly_server': 'b',
 
335
              'transport_server': 'a',
 
336
              'workingtree_format': formats[1]})],
 
337
            scenarios)
 
338
 
 
339
 
 
340
class TestTreeScenarios(tests.TestCase):
 
341
 
 
342
    def test_scenarios(self):
 
343
        # the tree implementation scenario generator is meant to setup one
 
344
        # instance for each working tree format, and one additional instance
 
345
        # that will use the default wt format, but create a revision tree for
 
346
        # the tests.  this means that the wt ones should have the
 
347
        # workingtree_to_test_tree attribute set to 'return_parameter' and the
 
348
        # revision one set to revision_tree_from_workingtree.
 
349
 
 
350
        from bzrlib.tests.per_tree import (
 
351
            _dirstate_tree_from_workingtree,
 
352
            make_scenarios,
 
353
            preview_tree_pre,
 
354
            preview_tree_post,
 
355
            return_parameter,
 
356
            revision_tree_from_workingtree
 
357
            )
 
358
        server1 = "a"
 
359
        server2 = "b"
 
360
        formats = [workingtree.WorkingTreeFormat2(),
 
361
                   workingtree.WorkingTreeFormat3(),]
 
362
        scenarios = make_scenarios(server1, server2, formats)
 
363
        self.assertEqual(7, len(scenarios))
 
364
        default_wt_format = workingtree.WorkingTreeFormat4._default_format
 
365
        wt4_format = workingtree.WorkingTreeFormat4()
 
366
        wt5_format = workingtree.WorkingTreeFormat5()
 
367
        expected_scenarios = [
 
368
            ('WorkingTreeFormat2',
 
369
             {'bzrdir_format': formats[0]._matchingbzrdir,
 
370
              'transport_readonly_server': 'b',
 
371
              'transport_server': 'a',
 
372
              'workingtree_format': formats[0],
 
373
              '_workingtree_to_test_tree': return_parameter,
 
374
              }),
 
375
            ('WorkingTreeFormat3',
 
376
             {'bzrdir_format': formats[1]._matchingbzrdir,
 
377
              'transport_readonly_server': 'b',
 
378
              'transport_server': 'a',
 
379
              'workingtree_format': formats[1],
 
380
              '_workingtree_to_test_tree': return_parameter,
 
381
             }),
 
382
            ('RevisionTree',
 
383
             {'_workingtree_to_test_tree': revision_tree_from_workingtree,
 
384
              'bzrdir_format': default_wt_format._matchingbzrdir,
 
385
              'transport_readonly_server': 'b',
 
386
              'transport_server': 'a',
 
387
              'workingtree_format': default_wt_format,
 
388
             }),
 
389
            ('DirStateRevisionTree,WT4',
 
390
             {'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
 
391
              'bzrdir_format': wt4_format._matchingbzrdir,
 
392
              'transport_readonly_server': 'b',
 
393
              'transport_server': 'a',
 
394
              'workingtree_format': wt4_format,
 
395
             }),
 
396
            ('DirStateRevisionTree,WT5',
 
397
             {'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
 
398
              'bzrdir_format': wt5_format._matchingbzrdir,
 
399
              'transport_readonly_server': 'b',
 
400
              'transport_server': 'a',
 
401
              'workingtree_format': wt5_format,
 
402
             }),
 
403
            ('PreviewTree',
 
404
             {'_workingtree_to_test_tree': preview_tree_pre,
 
405
              'bzrdir_format': default_wt_format._matchingbzrdir,
 
406
              'transport_readonly_server': 'b',
 
407
              'transport_server': 'a',
 
408
              'workingtree_format': default_wt_format}),
 
409
            ('PreviewTreePost',
 
410
             {'_workingtree_to_test_tree': preview_tree_post,
 
411
              'bzrdir_format': default_wt_format._matchingbzrdir,
 
412
              'transport_readonly_server': 'b',
 
413
              'transport_server': 'a',
 
414
              'workingtree_format': default_wt_format}),
 
415
             ]
 
416
        self.assertEqual(expected_scenarios, scenarios)
 
417
 
 
418
 
 
419
class TestInterTreeScenarios(tests.TestCase):
 
420
    """A group of tests that test the InterTreeTestAdapter."""
 
421
 
 
422
    def test_scenarios(self):
 
423
        # check that constructor parameters are passed through to the adapted
 
424
        # test.
 
425
        # for InterTree tests we want the machinery to bring up two trees in
 
426
        # each instance: the base one, and the one we are interacting with.
 
427
        # because each optimiser can be direction specific, we need to test
 
428
        # each optimiser in its chosen direction.
 
429
        # unlike the TestProviderAdapter we dont want to automatically add a
 
430
        # parameterized one for WorkingTree - the optimisers will tell us what
 
431
        # ones to add.
 
432
        from bzrlib.tests.per_tree import (
 
433
            return_parameter,
 
434
            revision_tree_from_workingtree
 
435
            )
 
436
        from bzrlib.tests.per_intertree import (
 
437
            make_scenarios,
 
438
            )
 
439
        from bzrlib.workingtree import WorkingTreeFormat2, WorkingTreeFormat3
 
440
        input_test = TestInterTreeScenarios(
 
441
            "test_scenarios")
 
442
        server1 = "a"
 
443
        server2 = "b"
 
444
        format1 = WorkingTreeFormat2()
 
445
        format2 = WorkingTreeFormat3()
 
446
        formats = [("1", str, format1, format2, "converter1"),
 
447
            ("2", int, format2, format1, "converter2")]
 
448
        scenarios = make_scenarios(server1, server2, formats)
 
449
        self.assertEqual(2, len(scenarios))
 
450
        expected_scenarios = [
 
451
            ("1", {
 
452
                "bzrdir_format": format1._matchingbzrdir,
 
453
                "intertree_class": formats[0][1],
 
454
                "workingtree_format": formats[0][2],
 
455
                "workingtree_format_to": formats[0][3],
 
456
                "mutable_trees_to_test_trees": formats[0][4],
 
457
                "_workingtree_to_test_tree": return_parameter,
 
458
                "transport_server": server1,
 
459
                "transport_readonly_server": server2,
 
460
                }),
 
461
            ("2", {
 
462
                "bzrdir_format": format2._matchingbzrdir,
 
463
                "intertree_class": formats[1][1],
 
464
                "workingtree_format": formats[1][2],
 
465
                "workingtree_format_to": formats[1][3],
 
466
                "mutable_trees_to_test_trees": formats[1][4],
 
467
                "_workingtree_to_test_tree": return_parameter,
 
468
                "transport_server": server1,
 
469
                "transport_readonly_server": server2,
 
470
                }),
 
471
            ]
 
472
        self.assertEqual(scenarios, expected_scenarios)
 
473
 
 
474
 
 
475
class TestTestCaseInTempDir(tests.TestCaseInTempDir):
 
476
 
 
477
    def test_home_is_not_working(self):
 
478
        self.assertNotEqual(self.test_dir, self.test_home_dir)
 
479
        cwd = osutils.getcwd()
 
480
        self.assertIsSameRealPath(self.test_dir, cwd)
 
481
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
 
482
 
 
483
    def test_assertEqualStat_equal(self):
 
484
        from bzrlib.tests.test_dirstate import _FakeStat
 
485
        self.build_tree(["foo"])
 
486
        real = os.lstat("foo")
 
487
        fake = _FakeStat(real.st_size, real.st_mtime, real.st_ctime,
 
488
            real.st_dev, real.st_ino, real.st_mode)
 
489
        self.assertEqualStat(real, fake)
 
490
 
 
491
    def test_assertEqualStat_notequal(self):
 
492
        self.build_tree(["foo", "bar"])
 
493
        self.assertRaises(AssertionError, self.assertEqualStat,
 
494
            os.lstat("foo"), os.lstat("bar"))
 
495
 
 
496
 
 
497
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
 
498
 
 
499
    def test_home_is_non_existant_dir_under_root(self):
 
500
        """The test_home_dir for TestCaseWithMemoryTransport is missing.
 
501
 
 
502
        This is because TestCaseWithMemoryTransport is for tests that do not
 
503
        need any disk resources: they should be hooked into bzrlib in such a
 
504
        way that no global settings are being changed by the test (only a
 
505
        few tests should need to do that), and having a missing dir as home is
 
506
        an effective way to ensure that this is the case.
 
507
        """
 
508
        self.assertIsSameRealPath(
 
509
            self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
 
510
            self.test_home_dir)
 
511
        self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
 
512
 
 
513
    def test_cwd_is_TEST_ROOT(self):
 
514
        self.assertIsSameRealPath(self.test_dir, self.TEST_ROOT)
 
515
        cwd = osutils.getcwd()
 
516
        self.assertIsSameRealPath(self.test_dir, cwd)
 
517
 
 
518
    def test_make_branch_and_memory_tree(self):
 
519
        """In TestCaseWithMemoryTransport we should not make the branch on disk.
 
520
 
 
521
        This is hard to comprehensively robustly test, so we settle for making
 
522
        a branch and checking no directory was created at its relpath.
 
523
        """
 
524
        tree = self.make_branch_and_memory_tree('dir')
 
525
        # Guard against regression into MemoryTransport leaking
 
526
        # files to disk instead of keeping them in memory.
 
527
        self.failIf(osutils.lexists('dir'))
 
528
        self.assertIsInstance(tree, memorytree.MemoryTree)
 
529
 
 
530
    def test_make_branch_and_memory_tree_with_format(self):
 
531
        """make_branch_and_memory_tree should accept a format option."""
 
532
        format = bzrdir.BzrDirMetaFormat1()
 
533
        format.repository_format = weaverepo.RepositoryFormat7()
 
534
        tree = self.make_branch_and_memory_tree('dir', format=format)
 
535
        # Guard against regression into MemoryTransport leaking
 
536
        # files to disk instead of keeping them in memory.
 
537
        self.failIf(osutils.lexists('dir'))
 
538
        self.assertIsInstance(tree, memorytree.MemoryTree)
 
539
        self.assertEqual(format.repository_format.__class__,
 
540
            tree.branch.repository._format.__class__)
 
541
 
 
542
    def test_make_branch_builder(self):
 
543
        builder = self.make_branch_builder('dir')
 
544
        self.assertIsInstance(builder, branchbuilder.BranchBuilder)
 
545
        # Guard against regression into MemoryTransport leaking
 
546
        # files to disk instead of keeping them in memory.
 
547
        self.failIf(osutils.lexists('dir'))
 
548
 
 
549
    def test_make_branch_builder_with_format(self):
 
550
        # Use a repo layout that doesn't conform to a 'named' layout, to ensure
 
551
        # that the format objects are used.
 
552
        format = bzrdir.BzrDirMetaFormat1()
 
553
        repo_format = weaverepo.RepositoryFormat7()
 
554
        format.repository_format = repo_format
 
555
        builder = self.make_branch_builder('dir', format=format)
 
556
        the_branch = builder.get_branch()
 
557
        # Guard against regression into MemoryTransport leaking
 
558
        # files to disk instead of keeping them in memory.
 
559
        self.failIf(osutils.lexists('dir'))
 
560
        self.assertEqual(format.repository_format.__class__,
 
561
                         the_branch.repository._format.__class__)
 
562
        self.assertEqual(repo_format.get_format_string(),
 
563
                         self.get_transport().get_bytes(
 
564
                            'dir/.bzr/repository/format'))
 
565
 
 
566
    def test_make_branch_builder_with_format_name(self):
 
567
        builder = self.make_branch_builder('dir', format='knit')
 
568
        the_branch = builder.get_branch()
 
569
        # Guard against regression into MemoryTransport leaking
 
570
        # files to disk instead of keeping them in memory.
 
571
        self.failIf(osutils.lexists('dir'))
 
572
        dir_format = bzrdir.format_registry.make_bzrdir('knit')
 
573
        self.assertEqual(dir_format.repository_format.__class__,
 
574
                         the_branch.repository._format.__class__)
 
575
        self.assertEqual('Bazaar-NG Knit Repository Format 1',
 
576
                         self.get_transport().get_bytes(
 
577
                            'dir/.bzr/repository/format'))
 
578
 
 
579
    def test_safety_net(self):
 
580
        """No test should modify the safety .bzr directory.
 
581
 
 
582
        We just test that the _check_safety_net private method raises
 
583
        AssertionError, it's easier than building a test suite with the same
 
584
        test.
 
585
        """
 
586
        # Oops, a commit in the current directory (i.e. without local .bzr
 
587
        # directory) will crawl up the hierarchy to find a .bzr directory.
 
588
        self.run_bzr(['commit', '-mfoo', '--unchanged'])
 
589
        # But we have a safety net in place.
 
590
        self.assertRaises(AssertionError, self._check_safety_net)
 
591
 
 
592
    def test_dangling_locks_cause_failures(self):
 
593
        class TestDanglingLock(tests.TestCaseWithMemoryTransport):
 
594
            def test_function(self):
 
595
                t = self.get_transport('.')
 
596
                l = lockdir.LockDir(t, 'lock')
 
597
                l.create()
 
598
                l.attempt_lock()
 
599
        test = TestDanglingLock('test_function')
 
600
        result = test.run()
 
601
        if self._lock_check_thorough:
 
602
            self.assertEqual(1, len(result.errors))
 
603
        else:
 
604
            # When _lock_check_thorough is disabled, then we don't trigger a
 
605
            # failure
 
606
            self.assertEqual(0, len(result.errors))
 
607
 
 
608
 
 
609
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
 
610
    """Tests for the convenience functions TestCaseWithTransport introduces."""
 
611
 
 
612
    def test_get_readonly_url_none(self):
 
613
        from bzrlib.transport import get_transport
 
614
        from bzrlib.transport.memory import MemoryServer
 
615
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
 
616
        self.vfs_transport_factory = MemoryServer
 
617
        self.transport_readonly_server = None
 
618
        # calling get_readonly_transport() constructs a decorator on the url
 
619
        # for the server
 
620
        url = self.get_readonly_url()
 
621
        url2 = self.get_readonly_url('foo/bar')
 
622
        t = get_transport(url)
 
623
        t2 = get_transport(url2)
 
624
        self.failUnless(isinstance(t, ReadonlyTransportDecorator))
 
625
        self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
 
626
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
 
627
 
 
628
    def test_get_readonly_url_http(self):
 
629
        from bzrlib.tests.http_server import HttpServer
 
630
        from bzrlib.transport import get_transport
 
631
        from bzrlib.transport.local import LocalURLServer
 
632
        from bzrlib.transport.http import HttpTransportBase
 
633
        self.transport_server = LocalURLServer
 
634
        self.transport_readonly_server = HttpServer
 
635
        # calling get_readonly_transport() gives us a HTTP server instance.
 
636
        url = self.get_readonly_url()
 
637
        url2 = self.get_readonly_url('foo/bar')
 
638
        # the transport returned may be any HttpTransportBase subclass
 
639
        t = get_transport(url)
 
640
        t2 = get_transport(url2)
 
641
        self.failUnless(isinstance(t, HttpTransportBase))
 
642
        self.failUnless(isinstance(t2, HttpTransportBase))
 
643
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
 
644
 
 
645
    def test_is_directory(self):
 
646
        """Test assertIsDirectory assertion"""
 
647
        t = self.get_transport()
 
648
        self.build_tree(['a_dir/', 'a_file'], transport=t)
 
649
        self.assertIsDirectory('a_dir', t)
 
650
        self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
 
651
        self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
 
652
 
 
653
    def test_make_branch_builder(self):
 
654
        builder = self.make_branch_builder('dir')
 
655
        rev_id = builder.build_commit()
 
656
        self.failUnlessExists('dir')
 
657
        a_dir = bzrdir.BzrDir.open('dir')
 
658
        self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
 
659
        a_branch = a_dir.open_branch()
 
660
        builder_branch = builder.get_branch()
 
661
        self.assertEqual(a_branch.base, builder_branch.base)
 
662
        self.assertEqual((1, rev_id), builder_branch.last_revision_info())
 
663
        self.assertEqual((1, rev_id), a_branch.last_revision_info())
 
664
 
 
665
 
 
666
class TestTestCaseTransports(tests.TestCaseWithTransport):
 
667
 
 
668
    def setUp(self):
 
669
        super(TestTestCaseTransports, self).setUp()
 
670
        self.vfs_transport_factory = MemoryServer
 
671
 
 
672
    def test_make_bzrdir_preserves_transport(self):
 
673
        t = self.get_transport()
 
674
        result_bzrdir = self.make_bzrdir('subdir')
 
675
        self.assertIsInstance(result_bzrdir.transport,
 
676
                              MemoryTransport)
 
677
        # should not be on disk, should only be in memory
 
678
        self.failIfExists('subdir')
 
679
 
 
680
 
 
681
class TestChrootedTest(tests.ChrootedTestCase):
 
682
 
 
683
    def test_root_is_root(self):
 
684
        from bzrlib.transport import get_transport
 
685
        t = get_transport(self.get_readonly_url())
 
686
        url = t.base
 
687
        self.assertEqual(url, t.clone('..').base)
 
688
 
 
689
 
 
690
class TestTestResult(tests.TestCase):
 
691
 
 
692
    def check_timing(self, test_case, expected_re):
 
693
        result = bzrlib.tests.TextTestResult(self._log_file,
 
694
                descriptions=0,
 
695
                verbosity=1,
 
696
                )
 
697
        test_case.run(result)
 
698
        timed_string = result._testTimeString(test_case)
 
699
        self.assertContainsRe(timed_string, expected_re)
 
700
 
 
701
    def test_test_reporting(self):
 
702
        class ShortDelayTestCase(tests.TestCase):
 
703
            def test_short_delay(self):
 
704
                time.sleep(0.003)
 
705
            def test_short_benchmark(self):
 
706
                self.time(time.sleep, 0.003)
 
707
        self.check_timing(ShortDelayTestCase('test_short_delay'),
 
708
                          r"^ +[0-9]+ms$")
 
709
        # if a benchmark time is given, we now show just that time followed by
 
710
        # a star
 
711
        self.check_timing(ShortDelayTestCase('test_short_benchmark'),
 
712
                          r"^ +[0-9]+ms\*$")
 
713
 
 
714
    def test_unittest_reporting_unittest_class(self):
 
715
        # getting the time from a non-bzrlib test works ok
 
716
        class ShortDelayTestCase(unittest.TestCase):
 
717
            def test_short_delay(self):
 
718
                time.sleep(0.003)
 
719
        self.check_timing(ShortDelayTestCase('test_short_delay'),
 
720
                          r"^ +[0-9]+ms$")
 
721
 
 
722
    def test_assigned_benchmark_file_stores_date(self):
 
723
        output = StringIO()
 
724
        result = bzrlib.tests.TextTestResult(self._log_file,
 
725
                                        descriptions=0,
 
726
                                        verbosity=1,
 
727
                                        bench_history=output
 
728
                                        )
 
729
        output_string = output.getvalue()
 
730
        # if you are wondering about the regexp please read the comment in
 
731
        # test_bench_history (bzrlib.tests.test_selftest.TestRunner)
 
732
        # XXX: what comment?  -- Andrew Bennetts
 
733
        self.assertContainsRe(output_string, "--date [0-9.]+")
 
734
 
 
735
    def test_benchhistory_records_test_times(self):
 
736
        result_stream = StringIO()
 
737
        result = bzrlib.tests.TextTestResult(
 
738
            self._log_file,
 
739
            descriptions=0,
 
740
            verbosity=1,
 
741
            bench_history=result_stream
 
742
            )
 
743
 
 
744
        # we want profile a call and check that its test duration is recorded
 
745
        # make a new test instance that when run will generate a benchmark
 
746
        example_test_case = TestTestResult("_time_hello_world_encoding")
 
747
        # execute the test, which should succeed and record times
 
748
        example_test_case.run(result)
 
749
        lines = result_stream.getvalue().splitlines()
 
750
        self.assertEqual(2, len(lines))
 
751
        self.assertContainsRe(lines[1],
 
752
            " *[0-9]+ms bzrlib.tests.test_selftest.TestTestResult"
 
753
            "._time_hello_world_encoding")
 
754
 
 
755
    def _time_hello_world_encoding(self):
 
756
        """Profile two sleep calls
 
757
 
 
758
        This is used to exercise the test framework.
 
759
        """
 
760
        self.time(unicode, 'hello', errors='replace')
 
761
        self.time(unicode, 'world', errors='replace')
 
762
 
 
763
    def test_lsprofiling(self):
 
764
        """Verbose test result prints lsprof statistics from test cases."""
 
765
        self.requireFeature(test_lsprof.LSProfFeature)
 
766
        result_stream = StringIO()
 
767
        result = bzrlib.tests.VerboseTestResult(
 
768
            unittest._WritelnDecorator(result_stream),
 
769
            descriptions=0,
 
770
            verbosity=2,
 
771
            )
 
772
        # we want profile a call of some sort and check it is output by
 
773
        # addSuccess. We dont care about addError or addFailure as they
 
774
        # are not that interesting for performance tuning.
 
775
        # make a new test instance that when run will generate a profile
 
776
        example_test_case = TestTestResult("_time_hello_world_encoding")
 
777
        example_test_case._gather_lsprof_in_benchmarks = True
 
778
        # execute the test, which should succeed and record profiles
 
779
        example_test_case.run(result)
 
780
        # lsprofile_something()
 
781
        # if this worked we want
 
782
        # LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
 
783
        #    CallCount    Recursive    Total(ms)   Inline(ms) module:lineno(function)
 
784
        # (the lsprof header)
 
785
        # ... an arbitrary number of lines
 
786
        # and the function call which is time.sleep.
 
787
        #           1        0            ???         ???       ???(sleep)
 
788
        # and then repeated but with 'world', rather than 'hello'.
 
789
        # this should appear in the output stream of our test result.
 
790
        output = result_stream.getvalue()
 
791
        self.assertContainsRe(output,
 
792
            r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
 
793
        self.assertContainsRe(output,
 
794
            r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
 
795
        self.assertContainsRe(output,
 
796
            r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
 
797
        self.assertContainsRe(output,
 
798
            r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
 
799
 
 
800
    def test_known_failure(self):
 
801
        """A KnownFailure being raised should trigger several result actions."""
 
802
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
803
            def done(self): pass
 
804
            def startTests(self): pass
 
805
            def report_test_start(self, test): pass
 
806
            def report_known_failure(self, test, err):
 
807
                self._call = test, err
 
808
        result = InstrumentedTestResult(None, None, None, None)
 
809
        def test_function():
 
810
            raise tests.KnownFailure('failed!')
 
811
        test = unittest.FunctionTestCase(test_function)
 
812
        test.run(result)
 
813
        # it should invoke 'report_known_failure'.
 
814
        self.assertEqual(2, len(result._call))
 
815
        self.assertEqual(test, result._call[0])
 
816
        self.assertEqual(tests.KnownFailure, result._call[1][0])
 
817
        self.assertIsInstance(result._call[1][1], tests.KnownFailure)
 
818
        # we dont introspec the traceback, if the rest is ok, it would be
 
819
        # exceptional for it not to be.
 
820
        # it should update the known_failure_count on the object.
 
821
        self.assertEqual(1, result.known_failure_count)
 
822
        # the result should be successful.
 
823
        self.assertTrue(result.wasSuccessful())
 
824
 
 
825
    def test_verbose_report_known_failure(self):
 
826
        # verbose test output formatting
 
827
        result_stream = StringIO()
 
828
        result = bzrlib.tests.VerboseTestResult(
 
829
            unittest._WritelnDecorator(result_stream),
 
830
            descriptions=0,
 
831
            verbosity=2,
 
832
            )
 
833
        test = self.get_passing_test()
 
834
        result.startTest(test)
 
835
        prefix = len(result_stream.getvalue())
 
836
        # the err parameter has the shape:
 
837
        # (class, exception object, traceback)
 
838
        # KnownFailures dont get their tracebacks shown though, so we
 
839
        # can skip that.
 
840
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
 
841
        result.report_known_failure(test, err)
 
842
        output = result_stream.getvalue()[prefix:]
 
843
        lines = output.splitlines()
 
844
        self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
 
845
        self.assertEqual(lines[1], '    foo')
 
846
        self.assertEqual(2, len(lines))
 
847
 
 
848
    def get_passing_test(self):
 
849
        """Return a test object that can't be run usefully."""
 
850
        def passing_test():
 
851
            pass
 
852
        return unittest.FunctionTestCase(passing_test)
 
853
 
 
854
    def test_add_not_supported(self):
 
855
        """Test the behaviour of invoking addNotSupported."""
 
856
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
857
            def done(self): pass
 
858
            def startTests(self): pass
 
859
            def report_test_start(self, test): pass
 
860
            def report_unsupported(self, test, feature):
 
861
                self._call = test, feature
 
862
        result = InstrumentedTestResult(None, None, None, None)
 
863
        test = SampleTestCase('_test_pass')
 
864
        feature = tests.Feature()
 
865
        result.startTest(test)
 
866
        result.addNotSupported(test, feature)
 
867
        # it should invoke 'report_unsupported'.
 
868
        self.assertEqual(2, len(result._call))
 
869
        self.assertEqual(test, result._call[0])
 
870
        self.assertEqual(feature, result._call[1])
 
871
        # the result should be successful.
 
872
        self.assertTrue(result.wasSuccessful())
 
873
        # it should record the test against a count of tests not run due to
 
874
        # this feature.
 
875
        self.assertEqual(1, result.unsupported['Feature'])
 
876
        # and invoking it again should increment that counter
 
877
        result.addNotSupported(test, feature)
 
878
        self.assertEqual(2, result.unsupported['Feature'])
 
879
 
 
880
    def test_verbose_report_unsupported(self):
 
881
        # verbose test output formatting
 
882
        result_stream = StringIO()
 
883
        result = bzrlib.tests.VerboseTestResult(
 
884
            unittest._WritelnDecorator(result_stream),
 
885
            descriptions=0,
 
886
            verbosity=2,
 
887
            )
 
888
        test = self.get_passing_test()
 
889
        feature = tests.Feature()
 
890
        result.startTest(test)
 
891
        prefix = len(result_stream.getvalue())
 
892
        result.report_unsupported(test, feature)
 
893
        output = result_stream.getvalue()[prefix:]
 
894
        lines = output.splitlines()
 
895
        # XXX: This is a timing dependent test. I've had it fail because it
 
896
        #      took 6ms to evaluate... :(
 
897
        self.assertEqual(lines, ['NODEP        0ms',
 
898
                                 "    The feature 'Feature' is not available."])
 
899
 
 
900
    def test_unavailable_exception(self):
 
901
        """An UnavailableFeature being raised should invoke addNotSupported."""
 
902
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
903
            def done(self): pass
 
904
            def startTests(self): pass
 
905
            def report_test_start(self, test): pass
 
906
            def addNotSupported(self, test, feature):
 
907
                self._call = test, feature
 
908
        result = InstrumentedTestResult(None, None, None, None)
 
909
        feature = tests.Feature()
 
910
        def test_function():
 
911
            raise tests.UnavailableFeature(feature)
 
912
        test = unittest.FunctionTestCase(test_function)
 
913
        test.run(result)
 
914
        # it should invoke 'addNotSupported'.
 
915
        self.assertEqual(2, len(result._call))
 
916
        self.assertEqual(test, result._call[0])
 
917
        self.assertEqual(feature, result._call[1])
 
918
        # and not count as an error
 
919
        self.assertEqual(0, result.error_count)
 
920
 
 
921
    def test_strict_with_unsupported_feature(self):
 
922
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
923
                                             verbosity=1)
 
924
        test = self.get_passing_test()
 
925
        feature = "Unsupported Feature"
 
926
        result.addNotSupported(test, feature)
 
927
        self.assertFalse(result.wasStrictlySuccessful())
 
928
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
929
 
 
930
    def test_strict_with_known_failure(self):
 
931
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
932
                                             verbosity=1)
 
933
        test = self.get_passing_test()
 
934
        err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
 
935
        result._addKnownFailure(test, err)
 
936
        self.assertFalse(result.wasStrictlySuccessful())
 
937
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
938
 
 
939
    def test_strict_with_success(self):
 
940
        result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
 
941
                                             verbosity=1)
 
942
        test = self.get_passing_test()
 
943
        result.addSuccess(test)
 
944
        self.assertTrue(result.wasStrictlySuccessful())
 
945
        self.assertEqual(None, result._extractBenchmarkTime(test))
 
946
 
 
947
    def test_startTests(self):
 
948
        """Starting the first test should trigger startTests."""
 
949
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
950
            calls = 0
 
951
            def startTests(self): self.calls += 1
 
952
            def report_test_start(self, test): pass
 
953
        result = InstrumentedTestResult(None, None, None, None)
 
954
        def test_function():
 
955
            pass
 
956
        test = unittest.FunctionTestCase(test_function)
 
957
        test.run(result)
 
958
        self.assertEquals(1, result.calls)
 
959
 
 
960
 
 
961
class TestUnicodeFilenameFeature(tests.TestCase):
 
962
 
 
963
    def test_probe_passes(self):
 
964
        """UnicodeFilenameFeature._probe passes."""
 
965
        # We can't test much more than that because the behaviour depends
 
966
        # on the platform.
 
967
        tests.UnicodeFilenameFeature._probe()
 
968
 
 
969
 
 
970
class TestRunner(tests.TestCase):
 
971
 
 
972
    def dummy_test(self):
 
973
        pass
 
974
 
 
975
    def run_test_runner(self, testrunner, test):
 
976
        """Run suite in testrunner, saving global state and restoring it.
 
977
 
 
978
        This current saves and restores:
 
979
        TestCaseInTempDir.TEST_ROOT
 
980
 
 
981
        There should be no tests in this file that use
 
982
        bzrlib.tests.TextTestRunner without using this convenience method,
 
983
        because of our use of global state.
 
984
        """
 
985
        old_root = tests.TestCaseInTempDir.TEST_ROOT
 
986
        try:
 
987
            tests.TestCaseInTempDir.TEST_ROOT = None
 
988
            return testrunner.run(test)
 
989
        finally:
 
990
            tests.TestCaseInTempDir.TEST_ROOT = old_root
 
991
 
 
992
    def test_known_failure_failed_run(self):
 
993
        # run a test that generates a known failure which should be printed in
 
994
        # the final output when real failures occur.
 
995
        def known_failure_test():
 
996
            raise tests.KnownFailure('failed')
 
997
        test = unittest.TestSuite()
 
998
        test.addTest(unittest.FunctionTestCase(known_failure_test))
 
999
        def failing_test():
 
1000
            raise AssertionError('foo')
 
1001
        test.addTest(unittest.FunctionTestCase(failing_test))
 
1002
        stream = StringIO()
 
1003
        runner = tests.TextTestRunner(stream=stream)
 
1004
        result = self.run_test_runner(runner, test)
 
1005
        lines = stream.getvalue().splitlines()
 
1006
        self.assertContainsRe(stream.getvalue(),
 
1007
            '(?sm)^testing.*$'
 
1008
            '.*'
 
1009
            '^======================================================================\n'
 
1010
            '^FAIL: unittest.FunctionTestCase \\(failing_test\\)\n'
 
1011
            '^----------------------------------------------------------------------\n'
 
1012
            'Traceback \\(most recent call last\\):\n'
 
1013
            '  .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
 
1014
            '    raise AssertionError\\(\'foo\'\\)\n'
 
1015
            '.*'
 
1016
            '^----------------------------------------------------------------------\n'
 
1017
            '.*'
 
1018
            'FAILED \\(failures=1, known_failure_count=1\\)'
 
1019
            )
 
1020
 
 
1021
    def test_known_failure_ok_run(self):
 
1022
        # run a test that generates a known failure which should be printed in the final output.
 
1023
        def known_failure_test():
 
1024
            raise tests.KnownFailure('failed')
 
1025
        test = unittest.FunctionTestCase(known_failure_test)
 
1026
        stream = StringIO()
 
1027
        runner = tests.TextTestRunner(stream=stream)
 
1028
        result = self.run_test_runner(runner, test)
 
1029
        self.assertContainsRe(stream.getvalue(),
 
1030
            '\n'
 
1031
            '-*\n'
 
1032
            'Ran 1 test in .*\n'
 
1033
            '\n'
 
1034
            'OK \\(known_failures=1\\)\n')
 
1035
 
 
1036
    def test_skipped_test(self):
 
1037
        # run a test that is skipped, and check the suite as a whole still
 
1038
        # succeeds.
 
1039
        # skipping_test must be hidden in here so it's not run as a real test
 
1040
        class SkippingTest(tests.TestCase):
 
1041
            def skipping_test(self):
 
1042
                raise tests.TestSkipped('test intentionally skipped')
 
1043
        runner = tests.TextTestRunner(stream=self._log_file)
 
1044
        test = SkippingTest("skipping_test")
 
1045
        result = self.run_test_runner(runner, test)
 
1046
        self.assertTrue(result.wasSuccessful())
 
1047
 
 
1048
    def test_skipped_from_setup(self):
 
1049
        calls = []
 
1050
        class SkippedSetupTest(tests.TestCase):
 
1051
 
 
1052
            def setUp(self):
 
1053
                calls.append('setUp')
 
1054
                self.addCleanup(self.cleanup)
 
1055
                raise tests.TestSkipped('skipped setup')
 
1056
 
 
1057
            def test_skip(self):
 
1058
                self.fail('test reached')
 
1059
 
 
1060
            def cleanup(self):
 
1061
                calls.append('cleanup')
 
1062
 
 
1063
        runner = tests.TextTestRunner(stream=self._log_file)
 
1064
        test = SkippedSetupTest('test_skip')
 
1065
        result = self.run_test_runner(runner, test)
 
1066
        self.assertTrue(result.wasSuccessful())
 
1067
        # Check if cleanup was called the right number of times.
 
1068
        self.assertEqual(['setUp', 'cleanup'], calls)
 
1069
 
 
1070
    def test_skipped_from_test(self):
 
1071
        calls = []
 
1072
        class SkippedTest(tests.TestCase):
 
1073
 
 
1074
            def setUp(self):
 
1075
                tests.TestCase.setUp(self)
 
1076
                calls.append('setUp')
 
1077
                self.addCleanup(self.cleanup)
 
1078
 
 
1079
            def test_skip(self):
 
1080
                raise tests.TestSkipped('skipped test')
 
1081
 
 
1082
            def cleanup(self):
 
1083
                calls.append('cleanup')
 
1084
 
 
1085
        runner = tests.TextTestRunner(stream=self._log_file)
 
1086
        test = SkippedTest('test_skip')
 
1087
        result = self.run_test_runner(runner, test)
 
1088
        self.assertTrue(result.wasSuccessful())
 
1089
        # Check if cleanup was called the right number of times.
 
1090
        self.assertEqual(['setUp', 'cleanup'], calls)
 
1091
 
 
1092
    def test_not_applicable(self):
 
1093
        # run a test that is skipped because it's not applicable
 
1094
        def not_applicable_test():
 
1095
            raise tests.TestNotApplicable('this test never runs')
 
1096
        out = StringIO()
 
1097
        runner = tests.TextTestRunner(stream=out, verbosity=2)
 
1098
        test = unittest.FunctionTestCase(not_applicable_test)
 
1099
        result = self.run_test_runner(runner, test)
 
1100
        self._log_file.write(out.getvalue())
 
1101
        self.assertTrue(result.wasSuccessful())
 
1102
        self.assertTrue(result.wasStrictlySuccessful())
 
1103
        self.assertContainsRe(out.getvalue(),
 
1104
                r'(?m)not_applicable_test   * N/A')
 
1105
        self.assertContainsRe(out.getvalue(),
 
1106
                r'(?m)^    this test never runs')
 
1107
 
 
1108
    def test_not_applicable_demo(self):
 
1109
        # just so you can see it in the test output
 
1110
        raise tests.TestNotApplicable('this test is just a demonstation')
 
1111
 
 
1112
    def test_unsupported_features_listed(self):
 
1113
        """When unsupported features are encountered they are detailed."""
 
1114
        class Feature1(tests.Feature):
 
1115
            def _probe(self): return False
 
1116
        class Feature2(tests.Feature):
 
1117
            def _probe(self): return False
 
1118
        # create sample tests
 
1119
        test1 = SampleTestCase('_test_pass')
 
1120
        test1._test_needs_features = [Feature1()]
 
1121
        test2 = SampleTestCase('_test_pass')
 
1122
        test2._test_needs_features = [Feature2()]
 
1123
        test = unittest.TestSuite()
 
1124
        test.addTest(test1)
 
1125
        test.addTest(test2)
 
1126
        stream = StringIO()
 
1127
        runner = tests.TextTestRunner(stream=stream)
 
1128
        result = self.run_test_runner(runner, test)
 
1129
        lines = stream.getvalue().splitlines()
 
1130
        self.assertEqual([
 
1131
            'OK',
 
1132
            "Missing feature 'Feature1' skipped 1 tests.",
 
1133
            "Missing feature 'Feature2' skipped 1 tests.",
 
1134
            ],
 
1135
            lines[-3:])
 
1136
 
 
1137
    def test_bench_history(self):
 
1138
        # tests that the running the benchmark produces a history file
 
1139
        # containing a timestamp and the revision id of the bzrlib source which
 
1140
        # was tested.
 
1141
        workingtree = _get_bzr_source_tree()
 
1142
        test = TestRunner('dummy_test')
 
1143
        output = StringIO()
 
1144
        runner = tests.TextTestRunner(stream=self._log_file,
 
1145
                                      bench_history=output)
 
1146
        result = self.run_test_runner(runner, test)
 
1147
        output_string = output.getvalue()
 
1148
        self.assertContainsRe(output_string, "--date [0-9.]+")
 
1149
        if workingtree is not None:
 
1150
            revision_id = workingtree.get_parent_ids()[0]
 
1151
            self.assertEndsWith(output_string.rstrip(), revision_id)
 
1152
 
 
1153
    def assertLogDeleted(self, test):
 
1154
        log = test._get_log()
 
1155
        self.assertEqual("DELETED log file to reduce memory footprint", log)
 
1156
        self.assertEqual('', test._log_contents)
 
1157
        self.assertIs(None, test._log_file_name)
 
1158
 
 
1159
    def test_success_log_deleted(self):
 
1160
        """Successful tests have their log deleted"""
 
1161
 
 
1162
        class LogTester(tests.TestCase):
 
1163
 
 
1164
            def test_success(self):
 
1165
                self.log('this will be removed\n')
 
1166
 
 
1167
        sio = StringIO()
 
1168
        runner = tests.TextTestRunner(stream=sio)
 
1169
        test = LogTester('test_success')
 
1170
        result = self.run_test_runner(runner, test)
 
1171
 
 
1172
        self.assertLogDeleted(test)
 
1173
 
 
1174
    def test_skipped_log_deleted(self):
 
1175
        """Skipped tests have their log deleted"""
 
1176
 
 
1177
        class LogTester(tests.TestCase):
 
1178
 
 
1179
            def test_skipped(self):
 
1180
                self.log('this will be removed\n')
 
1181
                raise tests.TestSkipped()
 
1182
 
 
1183
        sio = StringIO()
 
1184
        runner = tests.TextTestRunner(stream=sio)
 
1185
        test = LogTester('test_skipped')
 
1186
        result = self.run_test_runner(runner, test)
 
1187
 
 
1188
        self.assertLogDeleted(test)
 
1189
 
 
1190
    def test_not_aplicable_log_deleted(self):
 
1191
        """Not applicable tests have their log deleted"""
 
1192
 
 
1193
        class LogTester(tests.TestCase):
 
1194
 
 
1195
            def test_not_applicable(self):
 
1196
                self.log('this will be removed\n')
 
1197
                raise tests.TestNotApplicable()
 
1198
 
 
1199
        sio = StringIO()
 
1200
        runner = tests.TextTestRunner(stream=sio)
 
1201
        test = LogTester('test_not_applicable')
 
1202
        result = self.run_test_runner(runner, test)
 
1203
 
 
1204
        self.assertLogDeleted(test)
 
1205
 
 
1206
    def test_known_failure_log_deleted(self):
 
1207
        """Know failure tests have their log deleted"""
 
1208
 
 
1209
        class LogTester(tests.TestCase):
 
1210
 
 
1211
            def test_known_failure(self):
 
1212
                self.log('this will be removed\n')
 
1213
                raise tests.KnownFailure()
 
1214
 
 
1215
        sio = StringIO()
 
1216
        runner = tests.TextTestRunner(stream=sio)
 
1217
        test = LogTester('test_known_failure')
 
1218
        result = self.run_test_runner(runner, test)
 
1219
 
 
1220
        self.assertLogDeleted(test)
 
1221
 
 
1222
    def test_fail_log_kept(self):
 
1223
        """Failed tests have their log kept"""
 
1224
 
 
1225
        class LogTester(tests.TestCase):
 
1226
 
 
1227
            def test_fail(self):
 
1228
                self.log('this will be kept\n')
 
1229
                self.fail('this test fails')
 
1230
 
 
1231
        sio = StringIO()
 
1232
        runner = tests.TextTestRunner(stream=sio)
 
1233
        test = LogTester('test_fail')
 
1234
        result = self.run_test_runner(runner, test)
 
1235
 
 
1236
        text = sio.getvalue()
 
1237
        self.assertContainsRe(text, 'this will be kept')
 
1238
        self.assertContainsRe(text, 'this test fails')
 
1239
 
 
1240
        log = test._get_log()
 
1241
        self.assertContainsRe(log, 'this will be kept')
 
1242
        self.assertEqual(log, test._log_contents)
 
1243
 
 
1244
    def test_error_log_kept(self):
 
1245
        """Tests with errors have their log kept"""
 
1246
 
 
1247
        class LogTester(tests.TestCase):
 
1248
 
 
1249
            def test_error(self):
 
1250
                self.log('this will be kept\n')
 
1251
                raise ValueError('random exception raised')
 
1252
 
 
1253
        sio = StringIO()
 
1254
        runner = tests.TextTestRunner(stream=sio)
 
1255
        test = LogTester('test_error')
 
1256
        result = self.run_test_runner(runner, test)
 
1257
 
 
1258
        text = sio.getvalue()
 
1259
        self.assertContainsRe(text, 'this will be kept')
 
1260
        self.assertContainsRe(text, 'random exception raised')
 
1261
 
 
1262
        log = test._get_log()
 
1263
        self.assertContainsRe(log, 'this will be kept')
 
1264
        self.assertEqual(log, test._log_contents)
 
1265
 
 
1266
 
 
1267
class SampleTestCase(tests.TestCase):
 
1268
 
 
1269
    def _test_pass(self):
 
1270
        pass
 
1271
 
 
1272
class _TestException(Exception):
 
1273
    pass
 
1274
 
 
1275
 
 
1276
class TestTestCase(tests.TestCase):
 
1277
    """Tests that test the core bzrlib TestCase."""
 
1278
 
 
1279
    def test_assertLength_matches_empty(self):
 
1280
        a_list = []
 
1281
        self.assertLength(0, a_list)
 
1282
 
 
1283
    def test_assertLength_matches_nonempty(self):
 
1284
        a_list = [1, 2, 3]
 
1285
        self.assertLength(3, a_list)
 
1286
 
 
1287
    def test_assertLength_fails_different(self):
 
1288
        a_list = []
 
1289
        self.assertRaises(AssertionError, self.assertLength, 1, a_list)
 
1290
 
 
1291
    def test_assertLength_shows_sequence_in_failure(self):
 
1292
        a_list = [1, 2, 3]
 
1293
        exception = self.assertRaises(AssertionError, self.assertLength, 2,
 
1294
            a_list)
 
1295
        self.assertEqual('Incorrect length: wanted 2, got 3 for [1, 2, 3]',
 
1296
            exception.args[0])
 
1297
 
 
1298
    def test_base_setUp_not_called_causes_failure(self):
 
1299
        class TestCaseWithBrokenSetUp(tests.TestCase):
 
1300
            def setUp(self):
 
1301
                pass # does not call TestCase.setUp
 
1302
            def test_foo(self):
 
1303
                pass
 
1304
        test = TestCaseWithBrokenSetUp('test_foo')
 
1305
        result = unittest.TestResult()
 
1306
        test.run(result)
 
1307
        self.assertFalse(result.wasSuccessful())
 
1308
        self.assertEqual(1, result.testsRun)
 
1309
 
 
1310
    def test_base_tearDown_not_called_causes_failure(self):
 
1311
        class TestCaseWithBrokenTearDown(tests.TestCase):
 
1312
            def tearDown(self):
 
1313
                pass # does not call TestCase.tearDown
 
1314
            def test_foo(self):
 
1315
                pass
 
1316
        test = TestCaseWithBrokenTearDown('test_foo')
 
1317
        result = unittest.TestResult()
 
1318
        test.run(result)
 
1319
        self.assertFalse(result.wasSuccessful())
 
1320
        self.assertEqual(1, result.testsRun)
 
1321
 
 
1322
    def test_debug_flags_sanitised(self):
 
1323
        """The bzrlib debug flags should be sanitised by setUp."""
 
1324
        if 'allow_debug' in tests.selftest_debug_flags:
 
1325
            raise tests.TestNotApplicable(
 
1326
                '-Eallow_debug option prevents debug flag sanitisation')
 
1327
        # we could set something and run a test that will check
 
1328
        # it gets santised, but this is probably sufficient for now:
 
1329
        # if someone runs the test with -Dsomething it will error.
 
1330
        flags = set()
 
1331
        if self._lock_check_thorough:
 
1332
            flags.add('strict_locks')
 
1333
        self.assertEqual(flags, bzrlib.debug.debug_flags)
 
1334
 
 
1335
    def change_selftest_debug_flags(self, new_flags):
 
1336
        orig_selftest_flags = tests.selftest_debug_flags
 
1337
        self.addCleanup(self._restore_selftest_debug_flags, orig_selftest_flags)
 
1338
        tests.selftest_debug_flags = set(new_flags)
 
1339
 
 
1340
    def _restore_selftest_debug_flags(self, flags):
 
1341
        tests.selftest_debug_flags = flags
 
1342
 
 
1343
    def test_allow_debug_flag(self):
 
1344
        """The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
 
1345
        sanitised (i.e. cleared) before running a test.
 
1346
        """
 
1347
        self.change_selftest_debug_flags(set(['allow_debug']))
 
1348
        bzrlib.debug.debug_flags = set(['a-flag'])
 
1349
        class TestThatRecordsFlags(tests.TestCase):
 
1350
            def test_foo(nested_self):
 
1351
                self.flags = set(bzrlib.debug.debug_flags)
 
1352
        test = TestThatRecordsFlags('test_foo')
 
1353
        test.run(self.make_test_result())
 
1354
        flags = set(['a-flag'])
 
1355
        if 'disable_lock_checks' not in tests.selftest_debug_flags:
 
1356
            flags.add('strict_locks')
 
1357
        self.assertEqual(flags, self.flags)
 
1358
 
 
1359
    def test_disable_lock_checks(self):
 
1360
        """The -Edisable_lock_checks flag disables thorough checks."""
 
1361
        class TestThatRecordsFlags(tests.TestCase):
 
1362
            def test_foo(nested_self):
 
1363
                self.flags = set(bzrlib.debug.debug_flags)
 
1364
                self.test_lock_check_thorough = nested_self._lock_check_thorough
 
1365
        self.change_selftest_debug_flags(set())
 
1366
        test = TestThatRecordsFlags('test_foo')
 
1367
        test.run(self.make_test_result())
 
1368
        # By default we do strict lock checking and thorough lock/unlock
 
1369
        # tracking.
 
1370
        self.assertTrue(self.test_lock_check_thorough)
 
1371
        self.assertEqual(set(['strict_locks']), self.flags)
 
1372
        # Now set the disable_lock_checks flag, and show that this changed.
 
1373
        self.change_selftest_debug_flags(set(['disable_lock_checks']))
 
1374
        test = TestThatRecordsFlags('test_foo')
 
1375
        test.run(self.make_test_result())
 
1376
        self.assertFalse(self.test_lock_check_thorough)
 
1377
        self.assertEqual(set(), self.flags)
 
1378
 
 
1379
    def test_this_fails_strict_lock_check(self):
 
1380
        class TestThatRecordsFlags(tests.TestCase):
 
1381
            def test_foo(nested_self):
 
1382
                self.flags1 = set(bzrlib.debug.debug_flags)
 
1383
                self.thisFailsStrictLockCheck()
 
1384
                self.flags2 = set(bzrlib.debug.debug_flags)
 
1385
        # Make sure lock checking is active
 
1386
        self.change_selftest_debug_flags(set())
 
1387
        test = TestThatRecordsFlags('test_foo')
 
1388
        test.run(self.make_test_result())
 
1389
        self.assertEqual(set(['strict_locks']), self.flags1)
 
1390
        self.assertEqual(set(), self.flags2)
 
1391
 
 
1392
    def test_debug_flags_restored(self):
 
1393
        """The bzrlib debug flags should be restored to their original state
 
1394
        after the test was run, even if allow_debug is set.
 
1395
        """
 
1396
        self.change_selftest_debug_flags(set(['allow_debug']))
 
1397
        # Now run a test that modifies debug.debug_flags.
 
1398
        bzrlib.debug.debug_flags = set(['original-state'])
 
1399
        class TestThatModifiesFlags(tests.TestCase):
 
1400
            def test_foo(self):
 
1401
                bzrlib.debug.debug_flags = set(['modified'])
 
1402
        test = TestThatModifiesFlags('test_foo')
 
1403
        test.run(self.make_test_result())
 
1404
        self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
 
1405
 
 
1406
    def make_test_result(self):
 
1407
        return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
 
1408
 
 
1409
    def inner_test(self):
 
1410
        # the inner child test
 
1411
        note("inner_test")
 
1412
 
 
1413
    def outer_child(self):
 
1414
        # the outer child test
 
1415
        note("outer_start")
 
1416
        self.inner_test = TestTestCase("inner_child")
 
1417
        result = self.make_test_result()
 
1418
        self.inner_test.run(result)
 
1419
        note("outer finish")
 
1420
 
 
1421
    def test_trace_nesting(self):
 
1422
        # this tests that each test case nests its trace facility correctly.
 
1423
        # we do this by running a test case manually. That test case (A)
 
1424
        # should setup a new log, log content to it, setup a child case (B),
 
1425
        # which should log independently, then case (A) should log a trailer
 
1426
        # and return.
 
1427
        # we do two nested children so that we can verify the state of the
 
1428
        # logs after the outer child finishes is correct, which a bad clean
 
1429
        # up routine in tearDown might trigger a fault in our test with only
 
1430
        # one child, we should instead see the bad result inside our test with
 
1431
        # the two children.
 
1432
        # the outer child test
 
1433
        original_trace = bzrlib.trace._trace_file
 
1434
        outer_test = TestTestCase("outer_child")
 
1435
        result = self.make_test_result()
 
1436
        outer_test.run(result)
 
1437
        self.assertEqual(original_trace, bzrlib.trace._trace_file)
 
1438
 
 
1439
    def method_that_times_a_bit_twice(self):
 
1440
        # call self.time twice to ensure it aggregates
 
1441
        self.time(time.sleep, 0.007)
 
1442
        self.time(time.sleep, 0.007)
 
1443
 
 
1444
    def test_time_creates_benchmark_in_result(self):
 
1445
        """Test that the TestCase.time() method accumulates a benchmark time."""
 
1446
        sample_test = TestTestCase("method_that_times_a_bit_twice")
 
1447
        output_stream = StringIO()
 
1448
        result = bzrlib.tests.VerboseTestResult(
 
1449
            unittest._WritelnDecorator(output_stream),
 
1450
            descriptions=0,
 
1451
            verbosity=2)
 
1452
        sample_test.run(result)
 
1453
        self.assertContainsRe(
 
1454
            output_stream.getvalue(),
 
1455
            r"\d+ms\*\n$")
 
1456
 
 
1457
    def test_hooks_sanitised(self):
 
1458
        """The bzrlib hooks should be sanitised by setUp."""
 
1459
        # Note this test won't fail with hooks that the core library doesn't
 
1460
        # use - but it trigger with a plugin that adds hooks, so its still a
 
1461
        # useful warning in that case.
 
1462
        self.assertEqual(bzrlib.branch.BranchHooks(),
 
1463
            bzrlib.branch.Branch.hooks)
 
1464
        self.assertEqual(bzrlib.smart.server.SmartServerHooks(),
 
1465
            bzrlib.smart.server.SmartTCPServer.hooks)
 
1466
        self.assertEqual(bzrlib.commands.CommandHooks(),
 
1467
            bzrlib.commands.Command.hooks)
 
1468
 
 
1469
    def test__gather_lsprof_in_benchmarks(self):
 
1470
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
 
1471
 
 
1472
        Each self.time() call is individually and separately profiled.
 
1473
        """
 
1474
        self.requireFeature(test_lsprof.LSProfFeature)
 
1475
        # overrides the class member with an instance member so no cleanup
 
1476
        # needed.
 
1477
        self._gather_lsprof_in_benchmarks = True
 
1478
        self.time(time.sleep, 0.000)
 
1479
        self.time(time.sleep, 0.003)
 
1480
        self.assertEqual(2, len(self._benchcalls))
 
1481
        self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
 
1482
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
 
1483
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
 
1484
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
 
1485
 
 
1486
    def test_knownFailure(self):
 
1487
        """Self.knownFailure() should raise a KnownFailure exception."""
 
1488
        self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
 
1489
 
 
1490
    def test_requireFeature_available(self):
 
1491
        """self.requireFeature(available) is a no-op."""
 
1492
        class Available(tests.Feature):
 
1493
            def _probe(self):return True
 
1494
        feature = Available()
 
1495
        self.requireFeature(feature)
 
1496
 
 
1497
    def test_requireFeature_unavailable(self):
 
1498
        """self.requireFeature(unavailable) raises UnavailableFeature."""
 
1499
        class Unavailable(tests.Feature):
 
1500
            def _probe(self):return False
 
1501
        feature = Unavailable()
 
1502
        self.assertRaises(tests.UnavailableFeature,
 
1503
                          self.requireFeature, feature)
 
1504
 
 
1505
    def test_run_no_parameters(self):
 
1506
        test = SampleTestCase('_test_pass')
 
1507
        test.run()
 
1508
 
 
1509
    def test_run_enabled_unittest_result(self):
 
1510
        """Test we revert to regular behaviour when the test is enabled."""
 
1511
        test = SampleTestCase('_test_pass')
 
1512
        class EnabledFeature(object):
 
1513
            def available(self):
 
1514
                return True
 
1515
        test._test_needs_features = [EnabledFeature()]
 
1516
        result = unittest.TestResult()
 
1517
        test.run(result)
 
1518
        self.assertEqual(1, result.testsRun)
 
1519
        self.assertEqual([], result.errors)
 
1520
        self.assertEqual([], result.failures)
 
1521
 
 
1522
    def test_run_disabled_unittest_result(self):
 
1523
        """Test our compatability for disabled tests with unittest results."""
 
1524
        test = SampleTestCase('_test_pass')
 
1525
        class DisabledFeature(object):
 
1526
            def available(self):
 
1527
                return False
 
1528
        test._test_needs_features = [DisabledFeature()]
 
1529
        result = unittest.TestResult()
 
1530
        test.run(result)
 
1531
        self.assertEqual(1, result.testsRun)
 
1532
        self.assertEqual([], result.errors)
 
1533
        self.assertEqual([], result.failures)
 
1534
 
 
1535
    def test_run_disabled_supporting_result(self):
 
1536
        """Test disabled tests behaviour with support aware results."""
 
1537
        test = SampleTestCase('_test_pass')
 
1538
        class DisabledFeature(object):
 
1539
            def available(self):
 
1540
                return False
 
1541
        the_feature = DisabledFeature()
 
1542
        test._test_needs_features = [the_feature]
 
1543
        class InstrumentedTestResult(unittest.TestResult):
 
1544
            def __init__(self):
 
1545
                unittest.TestResult.__init__(self)
 
1546
                self.calls = []
 
1547
            def startTest(self, test):
 
1548
                self.calls.append(('startTest', test))
 
1549
            def stopTest(self, test):
 
1550
                self.calls.append(('stopTest', test))
 
1551
            def addNotSupported(self, test, feature):
 
1552
                self.calls.append(('addNotSupported', test, feature))
 
1553
        result = InstrumentedTestResult()
 
1554
        test.run(result)
 
1555
        self.assertEqual([
 
1556
            ('startTest', test),
 
1557
            ('addNotSupported', test, the_feature),
 
1558
            ('stopTest', test),
 
1559
            ],
 
1560
            result.calls)
 
1561
 
 
1562
    def test_assert_list_raises_on_generator(self):
 
1563
        def generator_which_will_raise():
 
1564
            # This will not raise until after the first yield
 
1565
            yield 1
 
1566
            raise _TestException()
 
1567
 
 
1568
        e = self.assertListRaises(_TestException, generator_which_will_raise)
 
1569
        self.assertIsInstance(e, _TestException)
 
1570
 
 
1571
        e = self.assertListRaises(Exception, generator_which_will_raise)
 
1572
        self.assertIsInstance(e, _TestException)
 
1573
 
 
1574
    def test_assert_list_raises_on_plain(self):
 
1575
        def plain_exception():
 
1576
            raise _TestException()
 
1577
            return []
 
1578
 
 
1579
        e = self.assertListRaises(_TestException, plain_exception)
 
1580
        self.assertIsInstance(e, _TestException)
 
1581
 
 
1582
        e = self.assertListRaises(Exception, plain_exception)
 
1583
        self.assertIsInstance(e, _TestException)
 
1584
 
 
1585
    def test_assert_list_raises_assert_wrong_exception(self):
 
1586
        class _NotTestException(Exception):
 
1587
            pass
 
1588
 
 
1589
        def wrong_exception():
 
1590
            raise _NotTestException()
 
1591
 
 
1592
        def wrong_exception_generator():
 
1593
            yield 1
 
1594
            yield 2
 
1595
            raise _NotTestException()
 
1596
 
 
1597
        # Wrong exceptions are not intercepted
 
1598
        self.assertRaises(_NotTestException,
 
1599
            self.assertListRaises, _TestException, wrong_exception)
 
1600
        self.assertRaises(_NotTestException,
 
1601
            self.assertListRaises, _TestException, wrong_exception_generator)
 
1602
 
 
1603
    def test_assert_list_raises_no_exception(self):
 
1604
        def success():
 
1605
            return []
 
1606
 
 
1607
        def success_generator():
 
1608
            yield 1
 
1609
            yield 2
 
1610
 
 
1611
        self.assertRaises(AssertionError,
 
1612
            self.assertListRaises, _TestException, success)
 
1613
 
 
1614
        self.assertRaises(AssertionError,
 
1615
            self.assertListRaises, _TestException, success_generator)
 
1616
 
 
1617
 
 
1618
# NB: Don't delete this; it's not actually from 0.11!
 
1619
@deprecated_function(deprecated_in((0, 11, 0)))
 
1620
def sample_deprecated_function():
 
1621
    """A deprecated function to test applyDeprecated with."""
 
1622
    return 2
 
1623
 
 
1624
 
 
1625
def sample_undeprecated_function(a_param):
 
1626
    """A undeprecated function to test applyDeprecated with."""
 
1627
 
 
1628
 
 
1629
class ApplyDeprecatedHelper(object):
 
1630
    """A helper class for ApplyDeprecated tests."""
 
1631
 
 
1632
    @deprecated_method(deprecated_in((0, 11, 0)))
 
1633
    def sample_deprecated_method(self, param_one):
 
1634
        """A deprecated method for testing with."""
 
1635
        return param_one
 
1636
 
 
1637
    def sample_normal_method(self):
 
1638
        """A undeprecated method."""
 
1639
 
 
1640
    @deprecated_method(deprecated_in((0, 10, 0)))
 
1641
    def sample_nested_deprecation(self):
 
1642
        return sample_deprecated_function()
 
1643
 
 
1644
 
 
1645
class TestExtraAssertions(tests.TestCase):
 
1646
    """Tests for new test assertions in bzrlib test suite"""
 
1647
 
 
1648
    def test_assert_isinstance(self):
 
1649
        self.assertIsInstance(2, int)
 
1650
        self.assertIsInstance(u'', basestring)
 
1651
        e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
 
1652
        self.assertEquals(str(e),
 
1653
            "None is an instance of <type 'NoneType'> rather than <type 'int'>")
 
1654
        self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
 
1655
        e = self.assertRaises(AssertionError,
 
1656
            self.assertIsInstance, None, int, "it's just not")
 
1657
        self.assertEquals(str(e),
 
1658
            "None is an instance of <type 'NoneType'> rather than <type 'int'>"
 
1659
            ": it's just not")
 
1660
 
 
1661
    def test_assertEndsWith(self):
 
1662
        self.assertEndsWith('foo', 'oo')
 
1663
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
 
1664
 
 
1665
    def test_applyDeprecated_not_deprecated(self):
 
1666
        sample_object = ApplyDeprecatedHelper()
 
1667
        # calling an undeprecated callable raises an assertion
 
1668
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1669
            deprecated_in((0, 11, 0)),
 
1670
            sample_object.sample_normal_method)
 
1671
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1672
            deprecated_in((0, 11, 0)),
 
1673
            sample_undeprecated_function, "a param value")
 
1674
        # calling a deprecated callable (function or method) with the wrong
 
1675
        # expected deprecation fails.
 
1676
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1677
            deprecated_in((0, 10, 0)),
 
1678
            sample_object.sample_deprecated_method, "a param value")
 
1679
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1680
            deprecated_in((0, 10, 0)),
 
1681
            sample_deprecated_function)
 
1682
        # calling a deprecated callable (function or method) with the right
 
1683
        # expected deprecation returns the functions result.
 
1684
        self.assertEqual("a param value",
 
1685
            self.applyDeprecated(deprecated_in((0, 11, 0)),
 
1686
            sample_object.sample_deprecated_method, "a param value"))
 
1687
        self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 11, 0)),
 
1688
            sample_deprecated_function))
 
1689
        # calling a nested deprecation with the wrong deprecation version
 
1690
        # fails even if a deeper nested function was deprecated with the
 
1691
        # supplied version.
 
1692
        self.assertRaises(AssertionError, self.applyDeprecated,
 
1693
            deprecated_in((0, 11, 0)), sample_object.sample_nested_deprecation)
 
1694
        # calling a nested deprecation with the right deprecation value
 
1695
        # returns the calls result.
 
1696
        self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 10, 0)),
 
1697
            sample_object.sample_nested_deprecation))
 
1698
 
 
1699
    def test_callDeprecated(self):
 
1700
        def testfunc(be_deprecated, result=None):
 
1701
            if be_deprecated is True:
 
1702
                symbol_versioning.warn('i am deprecated', DeprecationWarning,
 
1703
                                       stacklevel=1)
 
1704
            return result
 
1705
        result = self.callDeprecated(['i am deprecated'], testfunc, True)
 
1706
        self.assertIs(None, result)
 
1707
        result = self.callDeprecated([], testfunc, False, 'result')
 
1708
        self.assertEqual('result', result)
 
1709
        self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
 
1710
        self.callDeprecated([], testfunc, be_deprecated=False)
 
1711
 
 
1712
 
 
1713
class TestWarningTests(tests.TestCase):
 
1714
    """Tests for calling methods that raise warnings."""
 
1715
 
 
1716
    def test_callCatchWarnings(self):
 
1717
        def meth(a, b):
 
1718
            warnings.warn("this is your last warning")
 
1719
            return a + b
 
1720
        wlist, result = self.callCatchWarnings(meth, 1, 2)
 
1721
        self.assertEquals(3, result)
 
1722
        # would like just to compare them, but UserWarning doesn't implement
 
1723
        # eq well
 
1724
        w0, = wlist
 
1725
        self.assertIsInstance(w0, UserWarning)
 
1726
        self.assertEquals("this is your last warning", str(w0))
 
1727
 
 
1728
 
 
1729
class TestConvenienceMakers(tests.TestCaseWithTransport):
 
1730
    """Test for the make_* convenience functions."""
 
1731
 
 
1732
    def test_make_branch_and_tree_with_format(self):
 
1733
        # we should be able to supply a format to make_branch_and_tree
 
1734
        self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
 
1735
        self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
 
1736
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
 
1737
                              bzrlib.bzrdir.BzrDirMetaFormat1)
 
1738
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
 
1739
                              bzrlib.bzrdir.BzrDirFormat6)
 
1740
 
 
1741
    def test_make_branch_and_memory_tree(self):
 
1742
        # we should be able to get a new branch and a mutable tree from
 
1743
        # TestCaseWithTransport
 
1744
        tree = self.make_branch_and_memory_tree('a')
 
1745
        self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
 
1746
 
 
1747
 
 
1748
class TestSFTPMakeBranchAndTree(test_sftp_transport.TestCaseWithSFTPServer):
 
1749
 
 
1750
    def test_make_tree_for_sftp_branch(self):
 
1751
        """Transports backed by local directories create local trees."""
 
1752
        # NB: This is arguably a bug in the definition of make_branch_and_tree.
 
1753
        tree = self.make_branch_and_tree('t1')
 
1754
        base = tree.bzrdir.root_transport.base
 
1755
        self.failIf(base.startswith('sftp'),
 
1756
                'base %r is on sftp but should be local' % base)
 
1757
        self.assertEquals(tree.bzrdir.root_transport,
 
1758
                tree.branch.bzrdir.root_transport)
 
1759
        self.assertEquals(tree.bzrdir.root_transport,
 
1760
                tree.branch.repository.bzrdir.root_transport)
 
1761
 
 
1762
 
 
1763
class SelfTestHelper:
 
1764
 
 
1765
    def run_selftest(self, **kwargs):
 
1766
        """Run selftest returning its output."""
 
1767
        output = StringIO()
 
1768
        old_transport = bzrlib.tests.default_transport
 
1769
        old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
 
1770
        tests.TestCaseWithMemoryTransport.TEST_ROOT = None
 
1771
        try:
 
1772
            self.assertEqual(True, tests.selftest(stream=output, **kwargs))
 
1773
        finally:
 
1774
            bzrlib.tests.default_transport = old_transport
 
1775
            tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
 
1776
        output.seek(0)
 
1777
        return output
 
1778
 
 
1779
 
 
1780
class TestSelftest(tests.TestCase, SelfTestHelper):
 
1781
    """Tests of bzrlib.tests.selftest."""
 
1782
 
 
1783
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
 
1784
        factory_called = []
 
1785
        def factory():
 
1786
            factory_called.append(True)
 
1787
            return TestUtil.TestSuite()
 
1788
        out = StringIO()
 
1789
        err = StringIO()
 
1790
        self.apply_redirected(out, err, None, bzrlib.tests.selftest,
 
1791
            test_suite_factory=factory)
 
1792
        self.assertEqual([True], factory_called)
 
1793
 
 
1794
    def factory(self):
 
1795
        """A test suite factory."""
 
1796
        class Test(tests.TestCase):
 
1797
            def a(self):
 
1798
                pass
 
1799
            def b(self):
 
1800
                pass
 
1801
            def c(self):
 
1802
                pass
 
1803
        return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
 
1804
 
 
1805
    def test_list_only(self):
 
1806
        output = self.run_selftest(test_suite_factory=self.factory,
 
1807
            list_only=True)
 
1808
        self.assertEqual(3, len(output.readlines()))
 
1809
 
 
1810
    def test_list_only_filtered(self):
 
1811
        output = self.run_selftest(test_suite_factory=self.factory,
 
1812
            list_only=True, pattern="Test.b")
 
1813
        self.assertEndsWith(output.getvalue(), "Test.b\n")
 
1814
        self.assertLength(1, output.readlines())
 
1815
 
 
1816
    def test_list_only_excludes(self):
 
1817
        output = self.run_selftest(test_suite_factory=self.factory,
 
1818
            list_only=True, exclude_pattern="Test.b")
 
1819
        self.assertNotContainsRe("Test.b", output.getvalue())
 
1820
        self.assertLength(2, output.readlines())
 
1821
 
 
1822
    def test_random(self):
 
1823
        # test randomising by listing a number of tests.
 
1824
        output_123 = self.run_selftest(test_suite_factory=self.factory,
 
1825
            list_only=True, random_seed="123")
 
1826
        output_234 = self.run_selftest(test_suite_factory=self.factory,
 
1827
            list_only=True, random_seed="234")
 
1828
        self.assertNotEqual(output_123, output_234)
 
1829
        # "Randominzing test order..\n\n
 
1830
        self.assertLength(5, output_123.readlines())
 
1831
        self.assertLength(5, output_234.readlines())
 
1832
 
 
1833
    def test_random_reuse_is_same_order(self):
 
1834
        # test randomising by listing a number of tests.
 
1835
        expected = self.run_selftest(test_suite_factory=self.factory,
 
1836
            list_only=True, random_seed="123")
 
1837
        repeated = self.run_selftest(test_suite_factory=self.factory,
 
1838
            list_only=True, random_seed="123")
 
1839
        self.assertEqual(expected.getvalue(), repeated.getvalue())
 
1840
 
 
1841
    def test_runner_class(self):
 
1842
        self.requireFeature(SubUnitFeature)
 
1843
        from subunit import ProtocolTestCase
 
1844
        stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
 
1845
            test_suite_factory=self.factory)
 
1846
        test = ProtocolTestCase(stream)
 
1847
        result = unittest.TestResult()
 
1848
        test.run(result)
 
1849
        self.assertEqual(3, result.testsRun)
 
1850
 
 
1851
    def test_starting_with_single_argument(self):
 
1852
        output = self.run_selftest(test_suite_factory=self.factory,
 
1853
            starting_with=['bzrlib.tests.test_selftest.Test.a'],
 
1854
            list_only=True)
 
1855
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
 
1856
            output.getvalue())
 
1857
 
 
1858
    def test_starting_with_multiple_argument(self):
 
1859
        output = self.run_selftest(test_suite_factory=self.factory,
 
1860
            starting_with=['bzrlib.tests.test_selftest.Test.a',
 
1861
                'bzrlib.tests.test_selftest.Test.b'],
 
1862
            list_only=True)
 
1863
        self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
 
1864
            'bzrlib.tests.test_selftest.Test.b\n',
 
1865
            output.getvalue())
 
1866
 
 
1867
    def check_transport_set(self, transport_server):
 
1868
        captured_transport = []
 
1869
        def seen_transport(a_transport):
 
1870
            captured_transport.append(a_transport)
 
1871
        class Capture(tests.TestCase):
 
1872
            def a(self):
 
1873
                seen_transport(bzrlib.tests.default_transport)
 
1874
        def factory():
 
1875
            return TestUtil.TestSuite([Capture("a")])
 
1876
        self.run_selftest(transport=transport_server, test_suite_factory=factory)
 
1877
        self.assertEqual(transport_server, captured_transport[0])
 
1878
 
 
1879
    def test_transport_sftp(self):
 
1880
        try:
 
1881
            import bzrlib.transport.sftp
 
1882
        except errors.ParamikoNotPresent:
 
1883
            raise tests.TestSkipped("Paramiko not present")
 
1884
        self.check_transport_set(bzrlib.transport.sftp.SFTPAbsoluteServer)
 
1885
 
 
1886
    def test_transport_memory(self):
 
1887
        self.check_transport_set(bzrlib.transport.memory.MemoryServer)
 
1888
 
 
1889
 
 
1890
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
 
1891
    # Does IO: reads test.list
 
1892
 
 
1893
    def test_load_list(self):
 
1894
        # Provide a list with one test - this test.
 
1895
        test_id_line = '%s\n' % self.id()
 
1896
        self.build_tree_contents([('test.list', test_id_line)])
 
1897
        # And generate a list of the tests in  the suite.
 
1898
        stream = self.run_selftest(load_list='test.list', list_only=True)
 
1899
        self.assertEqual(test_id_line, stream.getvalue())
 
1900
 
 
1901
    def test_load_unknown(self):
 
1902
        # Provide a list with one test - this test.
 
1903
        # And generate a list of the tests in  the suite.
 
1904
        err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
 
1905
            load_list='missing file name', list_only=True)
 
1906
 
 
1907
 
 
1908
class TestRunBzr(tests.TestCase):
 
1909
 
 
1910
    out = ''
 
1911
    err = ''
 
1912
 
 
1913
    def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
 
1914
                         working_dir=None):
 
1915
        """Override _run_bzr_core to test how it is invoked by run_bzr.
 
1916
 
 
1917
        Attempts to run bzr from inside this class don't actually run it.
 
1918
 
 
1919
        We test how run_bzr actually invokes bzr in another location.
 
1920
        Here we only need to test that it is run_bzr passes the right
 
1921
        parameters to run_bzr.
 
1922
        """
 
1923
        self.argv = list(argv)
 
1924
        self.retcode = retcode
 
1925
        self.encoding = encoding
 
1926
        self.stdin = stdin
 
1927
        self.working_dir = working_dir
 
1928
        return self.out, self.err
 
1929
 
 
1930
    def test_run_bzr_error(self):
 
1931
        self.out = "It sure does!\n"
 
1932
        out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
 
1933
        self.assertEqual(['rocks'], self.argv)
 
1934
        self.assertEqual(34, self.retcode)
 
1935
        self.assertEqual(out, 'It sure does!\n')
 
1936
 
 
1937
    def test_run_bzr_error_regexes(self):
 
1938
        self.out = ''
 
1939
        self.err = "bzr: ERROR: foobarbaz is not versioned"
 
1940
        out, err = self.run_bzr_error(
 
1941
                ["bzr: ERROR: foobarbaz is not versioned"],
 
1942
                ['file-id', 'foobarbaz'])
 
1943
 
 
1944
    def test_encoding(self):
 
1945
        """Test that run_bzr passes encoding to _run_bzr_core"""
 
1946
        self.run_bzr('foo bar')
 
1947
        self.assertEqual(None, self.encoding)
 
1948
        self.assertEqual(['foo', 'bar'], self.argv)
 
1949
 
 
1950
        self.run_bzr('foo bar', encoding='baz')
 
1951
        self.assertEqual('baz', self.encoding)
 
1952
        self.assertEqual(['foo', 'bar'], self.argv)
 
1953
 
 
1954
    def test_retcode(self):
 
1955
        """Test that run_bzr passes retcode to _run_bzr_core"""
 
1956
        # Default is retcode == 0
 
1957
        self.run_bzr('foo bar')
 
1958
        self.assertEqual(0, self.retcode)
 
1959
        self.assertEqual(['foo', 'bar'], self.argv)
 
1960
 
 
1961
        self.run_bzr('foo bar', retcode=1)
 
1962
        self.assertEqual(1, self.retcode)
 
1963
        self.assertEqual(['foo', 'bar'], self.argv)
 
1964
 
 
1965
        self.run_bzr('foo bar', retcode=None)
 
1966
        self.assertEqual(None, self.retcode)
 
1967
        self.assertEqual(['foo', 'bar'], self.argv)
 
1968
 
 
1969
        self.run_bzr(['foo', 'bar'], retcode=3)
 
1970
        self.assertEqual(3, self.retcode)
 
1971
        self.assertEqual(['foo', 'bar'], self.argv)
 
1972
 
 
1973
    def test_stdin(self):
 
1974
        # test that the stdin keyword to run_bzr is passed through to
 
1975
        # _run_bzr_core as-is. We do this by overriding
 
1976
        # _run_bzr_core in this class, and then calling run_bzr,
 
1977
        # which is a convenience function for _run_bzr_core, so
 
1978
        # should invoke it.
 
1979
        self.run_bzr('foo bar', stdin='gam')
 
1980
        self.assertEqual('gam', self.stdin)
 
1981
        self.assertEqual(['foo', 'bar'], self.argv)
 
1982
 
 
1983
        self.run_bzr('foo bar', stdin='zippy')
 
1984
        self.assertEqual('zippy', self.stdin)
 
1985
        self.assertEqual(['foo', 'bar'], self.argv)
 
1986
 
 
1987
    def test_working_dir(self):
 
1988
        """Test that run_bzr passes working_dir to _run_bzr_core"""
 
1989
        self.run_bzr('foo bar')
 
1990
        self.assertEqual(None, self.working_dir)
 
1991
        self.assertEqual(['foo', 'bar'], self.argv)
 
1992
 
 
1993
        self.run_bzr('foo bar', working_dir='baz')
 
1994
        self.assertEqual('baz', self.working_dir)
 
1995
        self.assertEqual(['foo', 'bar'], self.argv)
 
1996
 
 
1997
    def test_reject_extra_keyword_arguments(self):
 
1998
        self.assertRaises(TypeError, self.run_bzr, "foo bar",
 
1999
                          error_regex=['error message'])
 
2000
 
 
2001
 
 
2002
class TestRunBzrCaptured(tests.TestCaseWithTransport):
 
2003
    # Does IO when testing the working_dir parameter.
 
2004
 
 
2005
    def apply_redirected(self, stdin=None, stdout=None, stderr=None,
 
2006
                         a_callable=None, *args, **kwargs):
 
2007
        self.stdin = stdin
 
2008
        self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
 
2009
        self.factory = bzrlib.ui.ui_factory
 
2010
        self.working_dir = osutils.getcwd()
 
2011
        stdout.write('foo\n')
 
2012
        stderr.write('bar\n')
 
2013
        return 0
 
2014
 
 
2015
    def test_stdin(self):
 
2016
        # test that the stdin keyword to _run_bzr_core is passed through to
 
2017
        # apply_redirected as a StringIO. We do this by overriding
 
2018
        # apply_redirected in this class, and then calling _run_bzr_core,
 
2019
        # which calls apply_redirected.
 
2020
        self.run_bzr(['foo', 'bar'], stdin='gam')
 
2021
        self.assertEqual('gam', self.stdin.read())
 
2022
        self.assertTrue(self.stdin is self.factory_stdin)
 
2023
        self.run_bzr(['foo', 'bar'], stdin='zippy')
 
2024
        self.assertEqual('zippy', self.stdin.read())
 
2025
        self.assertTrue(self.stdin is self.factory_stdin)
 
2026
 
 
2027
    def test_ui_factory(self):
 
2028
        # each invocation of self.run_bzr should get its
 
2029
        # own UI factory, which is an instance of TestUIFactory,
 
2030
        # with stdin, stdout and stderr attached to the stdin,
 
2031
        # stdout and stderr of the invoked run_bzr
 
2032
        current_factory = bzrlib.ui.ui_factory
 
2033
        self.run_bzr(['foo'])
 
2034
        self.failIf(current_factory is self.factory)
 
2035
        self.assertNotEqual(sys.stdout, self.factory.stdout)
 
2036
        self.assertNotEqual(sys.stderr, self.factory.stderr)
 
2037
        self.assertEqual('foo\n', self.factory.stdout.getvalue())
 
2038
        self.assertEqual('bar\n', self.factory.stderr.getvalue())
 
2039
        self.assertIsInstance(self.factory, tests.TestUIFactory)
 
2040
 
 
2041
    def test_working_dir(self):
 
2042
        self.build_tree(['one/', 'two/'])
 
2043
        cwd = osutils.getcwd()
 
2044
 
 
2045
        # Default is to work in the current directory
 
2046
        self.run_bzr(['foo', 'bar'])
 
2047
        self.assertEqual(cwd, self.working_dir)
 
2048
 
 
2049
        self.run_bzr(['foo', 'bar'], working_dir=None)
 
2050
        self.assertEqual(cwd, self.working_dir)
 
2051
 
 
2052
        # The function should be run in the alternative directory
 
2053
        # but afterwards the current working dir shouldn't be changed
 
2054
        self.run_bzr(['foo', 'bar'], working_dir='one')
 
2055
        self.assertNotEqual(cwd, self.working_dir)
 
2056
        self.assertEndsWith(self.working_dir, 'one')
 
2057
        self.assertEqual(cwd, osutils.getcwd())
 
2058
 
 
2059
        self.run_bzr(['foo', 'bar'], working_dir='two')
 
2060
        self.assertNotEqual(cwd, self.working_dir)
 
2061
        self.assertEndsWith(self.working_dir, 'two')
 
2062
        self.assertEqual(cwd, osutils.getcwd())
 
2063
 
 
2064
 
 
2065
class StubProcess(object):
 
2066
    """A stub process for testing run_bzr_subprocess."""
 
2067
    
 
2068
    def __init__(self, out="", err="", retcode=0):
 
2069
        self.out = out
 
2070
        self.err = err
 
2071
        self.returncode = retcode
 
2072
 
 
2073
    def communicate(self):
 
2074
        return self.out, self.err
 
2075
 
 
2076
 
 
2077
class TestRunBzrSubprocess(tests.TestCaseWithTransport):
 
2078
 
 
2079
    def setUp(self):
 
2080
        tests.TestCaseWithTransport.setUp(self)
 
2081
        self.subprocess_calls = []
 
2082
 
 
2083
    def start_bzr_subprocess(self, process_args, env_changes=None,
 
2084
                             skip_if_plan_to_signal=False,
 
2085
                             working_dir=None,
 
2086
                             allow_plugins=False):
 
2087
        """capture what run_bzr_subprocess tries to do."""
 
2088
        self.subprocess_calls.append({'process_args':process_args,
 
2089
            'env_changes':env_changes,
 
2090
            'skip_if_plan_to_signal':skip_if_plan_to_signal,
 
2091
            'working_dir':working_dir, 'allow_plugins':allow_plugins})
 
2092
        return self.next_subprocess
 
2093
 
 
2094
    def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
 
2095
        """Run run_bzr_subprocess with args and kwargs using a stubbed process.
 
2096
 
 
2097
        Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
 
2098
        that will return static results. This assertion method populates those
 
2099
        results and also checks the arguments run_bzr_subprocess generates.
 
2100
        """
 
2101
        self.next_subprocess = process
 
2102
        try:
 
2103
            result = self.run_bzr_subprocess(*args, **kwargs)
 
2104
        except:
 
2105
            self.next_subprocess = None
 
2106
            for key, expected in expected_args.iteritems():
 
2107
                self.assertEqual(expected, self.subprocess_calls[-1][key])
 
2108
            raise
 
2109
        else:
 
2110
            self.next_subprocess = None
 
2111
            for key, expected in expected_args.iteritems():
 
2112
                self.assertEqual(expected, self.subprocess_calls[-1][key])
 
2113
            return result
 
2114
 
 
2115
    def test_run_bzr_subprocess(self):
 
2116
        """The run_bzr_helper_external command behaves nicely."""
 
2117
        self.assertRunBzrSubprocess({'process_args':['--version']},
 
2118
            StubProcess(), '--version')
 
2119
        self.assertRunBzrSubprocess({'process_args':['--version']},
 
2120
            StubProcess(), ['--version'])
 
2121
        # retcode=None disables retcode checking
 
2122
        result = self.assertRunBzrSubprocess({},
 
2123
            StubProcess(retcode=3), '--version', retcode=None)
 
2124
        result = self.assertRunBzrSubprocess({},
 
2125
            StubProcess(out="is free software"), '--version')
 
2126
        self.assertContainsRe(result[0], 'is free software')
 
2127
        # Running a subcommand that is missing errors
 
2128
        self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
 
2129
            {'process_args':['--versionn']}, StubProcess(retcode=3),
 
2130
            '--versionn')
 
2131
        # Unless it is told to expect the error from the subprocess
 
2132
        result = self.assertRunBzrSubprocess({},
 
2133
            StubProcess(retcode=3), '--versionn', retcode=3)
 
2134
        # Or to ignore retcode checking
 
2135
        result = self.assertRunBzrSubprocess({},
 
2136
            StubProcess(err="unknown command", retcode=3), '--versionn',
 
2137
            retcode=None)
 
2138
        self.assertContainsRe(result[1], 'unknown command')
 
2139
 
 
2140
    def test_env_change_passes_through(self):
 
2141
        self.assertRunBzrSubprocess(
 
2142
            {'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
 
2143
            StubProcess(), '',
 
2144
            env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
 
2145
 
 
2146
    def test_no_working_dir_passed_as_None(self):
 
2147
        self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
 
2148
 
 
2149
    def test_no_working_dir_passed_through(self):
 
2150
        self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
 
2151
            working_dir='dir')
 
2152
 
 
2153
    def test_run_bzr_subprocess_no_plugins(self):
 
2154
        self.assertRunBzrSubprocess({'allow_plugins': False},
 
2155
            StubProcess(), '')
 
2156
 
 
2157
    def test_allow_plugins(self):
 
2158
        self.assertRunBzrSubprocess({'allow_plugins': True},
 
2159
            StubProcess(), '', allow_plugins=True)
 
2160
 
 
2161
 
 
2162
class _DontSpawnProcess(Exception):
 
2163
    """A simple exception which just allows us to skip unnecessary steps"""
 
2164
 
 
2165
 
 
2166
class TestStartBzrSubProcess(tests.TestCase):
 
2167
 
 
2168
    def check_popen_state(self):
 
2169
        """Replace to make assertions when popen is called."""
 
2170
 
 
2171
    def _popen(self, *args, **kwargs):
 
2172
        """Record the command that is run, so that we can ensure it is correct"""
 
2173
        self.check_popen_state()
 
2174
        self._popen_args = args
 
2175
        self._popen_kwargs = kwargs
 
2176
        raise _DontSpawnProcess()
 
2177
 
 
2178
    def test_run_bzr_subprocess_no_plugins(self):
 
2179
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
 
2180
        command = self._popen_args[0]
 
2181
        self.assertEqual(sys.executable, command[0])
 
2182
        self.assertEqual(self.get_bzr_path(), command[1])
 
2183
        self.assertEqual(['--no-plugins'], command[2:])
 
2184
 
 
2185
    def test_allow_plugins(self):
 
2186
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2187
            allow_plugins=True)
 
2188
        command = self._popen_args[0]
 
2189
        self.assertEqual([], command[2:])
 
2190
 
 
2191
    def test_set_env(self):
 
2192
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
 
2193
        # set in the child
 
2194
        def check_environment():
 
2195
            self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
 
2196
        self.check_popen_state = check_environment
 
2197
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2198
            env_changes={'EXISTANT_ENV_VAR':'set variable'})
 
2199
        # not set in theparent
 
2200
        self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
 
2201
 
 
2202
    def test_run_bzr_subprocess_env_del(self):
 
2203
        """run_bzr_subprocess can remove environment variables too."""
 
2204
        self.failIf('EXISTANT_ENV_VAR' in os.environ)
 
2205
        def check_environment():
 
2206
            self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
 
2207
        os.environ['EXISTANT_ENV_VAR'] = 'set variable'
 
2208
        self.check_popen_state = check_environment
 
2209
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2210
            env_changes={'EXISTANT_ENV_VAR':None})
 
2211
        # Still set in parent
 
2212
        self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
 
2213
        del os.environ['EXISTANT_ENV_VAR']
 
2214
 
 
2215
    def test_env_del_missing(self):
 
2216
        self.failIf('NON_EXISTANT_ENV_VAR' in os.environ)
 
2217
        def check_environment():
 
2218
            self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
 
2219
        self.check_popen_state = check_environment
 
2220
        self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2221
            env_changes={'NON_EXISTANT_ENV_VAR':None})
 
2222
 
 
2223
    def test_working_dir(self):
 
2224
        """Test that we can specify the working dir for the child"""
 
2225
        orig_getcwd = osutils.getcwd
 
2226
        orig_chdir = os.chdir
 
2227
        chdirs = []
 
2228
        def chdir(path):
 
2229
            chdirs.append(path)
 
2230
        os.chdir = chdir
 
2231
        try:
 
2232
            def getcwd():
 
2233
                return 'current'
 
2234
            osutils.getcwd = getcwd
 
2235
            try:
 
2236
                self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
 
2237
                    working_dir='foo')
 
2238
            finally:
 
2239
                osutils.getcwd = orig_getcwd
 
2240
        finally:
 
2241
            os.chdir = orig_chdir
 
2242
        self.assertEqual(['foo', 'current'], chdirs)
 
2243
 
 
2244
 
 
2245
class TestBzrSubprocess(tests.TestCaseWithTransport):
 
2246
 
 
2247
    def test_start_and_stop_bzr_subprocess(self):
 
2248
        """We can start and perform other test actions while that process is
 
2249
        still alive.
 
2250
        """
 
2251
        process = self.start_bzr_subprocess(['--version'])
 
2252
        result = self.finish_bzr_subprocess(process)
 
2253
        self.assertContainsRe(result[0], 'is free software')
 
2254
        self.assertEqual('', result[1])
 
2255
 
 
2256
    def test_start_and_stop_bzr_subprocess_with_error(self):
 
2257
        """finish_bzr_subprocess allows specification of the desired exit code.
 
2258
        """
 
2259
        process = self.start_bzr_subprocess(['--versionn'])
 
2260
        result = self.finish_bzr_subprocess(process, retcode=3)
 
2261
        self.assertEqual('', result[0])
 
2262
        self.assertContainsRe(result[1], 'unknown command')
 
2263
 
 
2264
    def test_start_and_stop_bzr_subprocess_ignoring_retcode(self):
 
2265
        """finish_bzr_subprocess allows the exit code to be ignored."""
 
2266
        process = self.start_bzr_subprocess(['--versionn'])
 
2267
        result = self.finish_bzr_subprocess(process, retcode=None)
 
2268
        self.assertEqual('', result[0])
 
2269
        self.assertContainsRe(result[1], 'unknown command')
 
2270
 
 
2271
    def test_start_and_stop_bzr_subprocess_with_unexpected_retcode(self):
 
2272
        """finish_bzr_subprocess raises self.failureException if the retcode is
 
2273
        not the expected one.
 
2274
        """
 
2275
        process = self.start_bzr_subprocess(['--versionn'])
 
2276
        self.assertRaises(self.failureException, self.finish_bzr_subprocess,
 
2277
                          process)
 
2278
 
 
2279
    def test_start_and_stop_bzr_subprocess_send_signal(self):
 
2280
        """finish_bzr_subprocess raises self.failureException if the retcode is
 
2281
        not the expected one.
 
2282
        """
 
2283
        process = self.start_bzr_subprocess(['wait-until-signalled'],
 
2284
                                            skip_if_plan_to_signal=True)
 
2285
        self.assertEqual('running\n', process.stdout.readline())
 
2286
        result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
 
2287
                                            retcode=3)
 
2288
        self.assertEqual('', result[0])
 
2289
        self.assertEqual('bzr: interrupted\n', result[1])
 
2290
 
 
2291
    def test_start_and_stop_working_dir(self):
 
2292
        cwd = osutils.getcwd()
 
2293
        self.make_branch_and_tree('one')
 
2294
        process = self.start_bzr_subprocess(['root'], working_dir='one')
 
2295
        result = self.finish_bzr_subprocess(process, universal_newlines=True)
 
2296
        self.assertEndsWith(result[0], 'one\n')
 
2297
        self.assertEqual('', result[1])
 
2298
 
 
2299
 
 
2300
class TestKnownFailure(tests.TestCase):
 
2301
 
 
2302
    def test_known_failure(self):
 
2303
        """Check that KnownFailure is defined appropriately."""
 
2304
        # a KnownFailure is an assertion error for compatability with unaware
 
2305
        # runners.
 
2306
        self.assertIsInstance(tests.KnownFailure(""), AssertionError)
 
2307
 
 
2308
    def test_expect_failure(self):
 
2309
        try:
 
2310
            self.expectFailure("Doomed to failure", self.assertTrue, False)
 
2311
        except tests.KnownFailure, e:
 
2312
            self.assertEqual('Doomed to failure', e.args[0])
 
2313
        try:
 
2314
            self.expectFailure("Doomed to failure", self.assertTrue, True)
 
2315
        except AssertionError, e:
 
2316
            self.assertEqual('Unexpected success.  Should have failed:'
 
2317
                             ' Doomed to failure', e.args[0])
 
2318
        else:
 
2319
            self.fail('Assertion not raised')
 
2320
 
 
2321
 
 
2322
class TestFeature(tests.TestCase):
 
2323
 
 
2324
    def test_caching(self):
 
2325
        """Feature._probe is called by the feature at most once."""
 
2326
        class InstrumentedFeature(tests.Feature):
 
2327
            def __init__(self):
 
2328
                super(InstrumentedFeature, self).__init__()
 
2329
                self.calls = []
 
2330
            def _probe(self):
 
2331
                self.calls.append('_probe')
 
2332
                return False
 
2333
        feature = InstrumentedFeature()
 
2334
        feature.available()
 
2335
        self.assertEqual(['_probe'], feature.calls)
 
2336
        feature.available()
 
2337
        self.assertEqual(['_probe'], feature.calls)
 
2338
 
 
2339
    def test_named_str(self):
 
2340
        """Feature.__str__ should thunk to feature_name()."""
 
2341
        class NamedFeature(tests.Feature):
 
2342
            def feature_name(self):
 
2343
                return 'symlinks'
 
2344
        feature = NamedFeature()
 
2345
        self.assertEqual('symlinks', str(feature))
 
2346
 
 
2347
    def test_default_str(self):
 
2348
        """Feature.__str__ should default to __class__.__name__."""
 
2349
        class NamedFeature(tests.Feature):
 
2350
            pass
 
2351
        feature = NamedFeature()
 
2352
        self.assertEqual('NamedFeature', str(feature))
 
2353
 
 
2354
 
 
2355
class TestUnavailableFeature(tests.TestCase):
 
2356
 
 
2357
    def test_access_feature(self):
 
2358
        feature = tests.Feature()
 
2359
        exception = tests.UnavailableFeature(feature)
 
2360
        self.assertIs(feature, exception.args[0])
 
2361
 
 
2362
 
 
2363
class TestSelftestFiltering(tests.TestCase):
 
2364
 
 
2365
    def setUp(self):
 
2366
        tests.TestCase.setUp(self)
 
2367
        self.suite = TestUtil.TestSuite()
 
2368
        self.loader = TestUtil.TestLoader()
 
2369
        self.suite.addTest(self.loader.loadTestsFromModule(
 
2370
            sys.modules['bzrlib.tests.test_selftest']))
 
2371
        self.all_names = _test_ids(self.suite)
 
2372
 
 
2373
    def test_condition_id_re(self):
 
2374
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2375
            'test_condition_id_re')
 
2376
        filtered_suite = tests.filter_suite_by_condition(
 
2377
            self.suite, tests.condition_id_re('test_condition_id_re'))
 
2378
        self.assertEqual([test_name], _test_ids(filtered_suite))
 
2379
 
 
2380
    def test_condition_id_in_list(self):
 
2381
        test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2382
                      'test_condition_id_in_list']
 
2383
        id_list = tests.TestIdList(test_names)
 
2384
        filtered_suite = tests.filter_suite_by_condition(
 
2385
            self.suite, tests.condition_id_in_list(id_list))
 
2386
        my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
 
2387
        re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
 
2388
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
 
2389
 
 
2390
    def test_condition_id_startswith(self):
 
2391
        klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2392
        start1 = klass + 'test_condition_id_starts'
 
2393
        start2 = klass + 'test_condition_id_in'
 
2394
        test_names = [ klass + 'test_condition_id_in_list',
 
2395
                      klass + 'test_condition_id_startswith',
 
2396
                     ]
 
2397
        filtered_suite = tests.filter_suite_by_condition(
 
2398
            self.suite, tests.condition_id_startswith([start1, start2]))
 
2399
        self.assertEqual(test_names, _test_ids(filtered_suite))
 
2400
 
 
2401
    def test_condition_isinstance(self):
 
2402
        filtered_suite = tests.filter_suite_by_condition(
 
2403
            self.suite, tests.condition_isinstance(self.__class__))
 
2404
        class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2405
        re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
 
2406
        self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
 
2407
 
 
2408
    def test_exclude_tests_by_condition(self):
 
2409
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2410
            'test_exclude_tests_by_condition')
 
2411
        filtered_suite = tests.exclude_tests_by_condition(self.suite,
 
2412
            lambda x:x.id() == excluded_name)
 
2413
        self.assertEqual(len(self.all_names) - 1,
 
2414
            filtered_suite.countTestCases())
 
2415
        self.assertFalse(excluded_name in _test_ids(filtered_suite))
 
2416
        remaining_names = list(self.all_names)
 
2417
        remaining_names.remove(excluded_name)
 
2418
        self.assertEqual(remaining_names, _test_ids(filtered_suite))
 
2419
 
 
2420
    def test_exclude_tests_by_re(self):
 
2421
        self.all_names = _test_ids(self.suite)
 
2422
        filtered_suite = tests.exclude_tests_by_re(self.suite,
 
2423
                                                   'exclude_tests_by_re')
 
2424
        excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2425
            'test_exclude_tests_by_re')
 
2426
        self.assertEqual(len(self.all_names) - 1,
 
2427
            filtered_suite.countTestCases())
 
2428
        self.assertFalse(excluded_name in _test_ids(filtered_suite))
 
2429
        remaining_names = list(self.all_names)
 
2430
        remaining_names.remove(excluded_name)
 
2431
        self.assertEqual(remaining_names, _test_ids(filtered_suite))
 
2432
 
 
2433
    def test_filter_suite_by_condition(self):
 
2434
        test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2435
            'test_filter_suite_by_condition')
 
2436
        filtered_suite = tests.filter_suite_by_condition(self.suite,
 
2437
            lambda x:x.id() == test_name)
 
2438
        self.assertEqual([test_name], _test_ids(filtered_suite))
 
2439
 
 
2440
    def test_filter_suite_by_re(self):
 
2441
        filtered_suite = tests.filter_suite_by_re(self.suite,
 
2442
                                                  'test_filter_suite_by_r')
 
2443
        filtered_names = _test_ids(filtered_suite)
 
2444
        self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
 
2445
            'TestSelftestFiltering.test_filter_suite_by_re'])
 
2446
 
 
2447
    def test_filter_suite_by_id_list(self):
 
2448
        test_list = ['bzrlib.tests.test_selftest.'
 
2449
                     'TestSelftestFiltering.test_filter_suite_by_id_list']
 
2450
        filtered_suite = tests.filter_suite_by_id_list(
 
2451
            self.suite, tests.TestIdList(test_list))
 
2452
        filtered_names = _test_ids(filtered_suite)
 
2453
        self.assertEqual(
 
2454
            filtered_names,
 
2455
            ['bzrlib.tests.test_selftest.'
 
2456
             'TestSelftestFiltering.test_filter_suite_by_id_list'])
 
2457
 
 
2458
    def test_filter_suite_by_id_startswith(self):
 
2459
        # By design this test may fail if another test is added whose name also
 
2460
        # begins with one of the start value used.
 
2461
        klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2462
        start1 = klass + 'test_filter_suite_by_id_starts'
 
2463
        start2 = klass + 'test_filter_suite_by_id_li'
 
2464
        test_list = [klass + 'test_filter_suite_by_id_list',
 
2465
                     klass + 'test_filter_suite_by_id_startswith',
 
2466
                     ]
 
2467
        filtered_suite = tests.filter_suite_by_id_startswith(
 
2468
            self.suite, [start1, start2])
 
2469
        self.assertEqual(
 
2470
            test_list,
 
2471
            _test_ids(filtered_suite),
 
2472
            )
 
2473
 
 
2474
    def test_preserve_input(self):
 
2475
        # NB: Surely this is something in the stdlib to do this?
 
2476
        self.assertTrue(self.suite is tests.preserve_input(self.suite))
 
2477
        self.assertTrue("@#$" is tests.preserve_input("@#$"))
 
2478
 
 
2479
    def test_randomize_suite(self):
 
2480
        randomized_suite = tests.randomize_suite(self.suite)
 
2481
        # randomizing should not add or remove test names.
 
2482
        self.assertEqual(set(_test_ids(self.suite)),
 
2483
                         set(_test_ids(randomized_suite)))
 
2484
        # Technically, this *can* fail, because random.shuffle(list) can be
 
2485
        # equal to list. Trying multiple times just pushes the frequency back.
 
2486
        # As its len(self.all_names)!:1, the failure frequency should be low
 
2487
        # enough to ignore. RBC 20071021.
 
2488
        # It should change the order.
 
2489
        self.assertNotEqual(self.all_names, _test_ids(randomized_suite))
 
2490
        # But not the length. (Possibly redundant with the set test, but not
 
2491
        # necessarily.)
 
2492
        self.assertEqual(len(self.all_names), len(_test_ids(randomized_suite)))
 
2493
 
 
2494
    def test_split_suit_by_condition(self):
 
2495
        self.all_names = _test_ids(self.suite)
 
2496
        condition = tests.condition_id_re('test_filter_suite_by_r')
 
2497
        split_suite = tests.split_suite_by_condition(self.suite, condition)
 
2498
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2499
            'test_filter_suite_by_re')
 
2500
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
 
2501
        self.assertFalse(filtered_name in _test_ids(split_suite[1]))
 
2502
        remaining_names = list(self.all_names)
 
2503
        remaining_names.remove(filtered_name)
 
2504
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
 
2505
 
 
2506
    def test_split_suit_by_re(self):
 
2507
        self.all_names = _test_ids(self.suite)
 
2508
        split_suite = tests.split_suite_by_re(self.suite,
 
2509
                                              'test_filter_suite_by_r')
 
2510
        filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
 
2511
            'test_filter_suite_by_re')
 
2512
        self.assertEqual([filtered_name], _test_ids(split_suite[0]))
 
2513
        self.assertFalse(filtered_name in _test_ids(split_suite[1]))
 
2514
        remaining_names = list(self.all_names)
 
2515
        remaining_names.remove(filtered_name)
 
2516
        self.assertEqual(remaining_names, _test_ids(split_suite[1]))
 
2517
 
 
2518
 
 
2519
class TestCheckInventoryShape(tests.TestCaseWithTransport):
 
2520
 
 
2521
    def test_check_inventory_shape(self):
 
2522
        files = ['a', 'b/', 'b/c']
 
2523
        tree = self.make_branch_and_tree('.')
 
2524
        self.build_tree(files)
 
2525
        tree.add(files)
 
2526
        tree.lock_read()
 
2527
        try:
 
2528
            self.check_inventory_shape(tree.inventory, files)
 
2529
        finally:
 
2530
            tree.unlock()
 
2531
 
 
2532
 
 
2533
class TestBlackboxSupport(tests.TestCase):
 
2534
    """Tests for testsuite blackbox features."""
 
2535
 
 
2536
    def test_run_bzr_failure_not_caught(self):
 
2537
        # When we run bzr in blackbox mode, we want any unexpected errors to
 
2538
        # propagate up to the test suite so that it can show the error in the
 
2539
        # usual way, and we won't get a double traceback.
 
2540
        e = self.assertRaises(
 
2541
            AssertionError,
 
2542
            self.run_bzr, ['assert-fail'])
 
2543
        # make sure we got the real thing, not an error from somewhere else in
 
2544
        # the test framework
 
2545
        self.assertEquals('always fails', str(e))
 
2546
        # check that there's no traceback in the test log
 
2547
        self.assertNotContainsRe(self._get_log(keep_log_file=True),
 
2548
            r'Traceback')
 
2549
 
 
2550
    def test_run_bzr_user_error_caught(self):
 
2551
        # Running bzr in blackbox mode, normal/expected/user errors should be
 
2552
        # caught in the regular way and turned into an error message plus exit
 
2553
        # code.
 
2554
        out, err = self.run_bzr(["log", "/nonexistantpath"], retcode=3)
 
2555
        self.assertEqual(out, '')
 
2556
        self.assertContainsRe(err,
 
2557
            'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
 
2558
 
 
2559
 
 
2560
class TestTestLoader(tests.TestCase):
 
2561
    """Tests for the test loader."""
 
2562
 
 
2563
    def _get_loader_and_module(self):
 
2564
        """Gets a TestLoader and a module with one test in it."""
 
2565
        loader = TestUtil.TestLoader()
 
2566
        module = {}
 
2567
        class Stub(tests.TestCase):
 
2568
            def test_foo(self):
 
2569
                pass
 
2570
        class MyModule(object):
 
2571
            pass
 
2572
        MyModule.a_class = Stub
 
2573
        module = MyModule()
 
2574
        return loader, module
 
2575
 
 
2576
    def test_module_no_load_tests_attribute_loads_classes(self):
 
2577
        loader, module = self._get_loader_and_module()
 
2578
        self.assertEqual(1, loader.loadTestsFromModule(module).countTestCases())
 
2579
 
 
2580
    def test_module_load_tests_attribute_gets_called(self):
 
2581
        loader, module = self._get_loader_and_module()
 
2582
        # 'self' is here because we're faking the module with a class. Regular
 
2583
        # load_tests do not need that :)
 
2584
        def load_tests(self, standard_tests, module, loader):
 
2585
            result = loader.suiteClass()
 
2586
            for test in tests.iter_suite_tests(standard_tests):
 
2587
                result.addTests([test, test])
 
2588
            return result
 
2589
        # add a load_tests() method which multiplies the tests from the module.
 
2590
        module.__class__.load_tests = load_tests
 
2591
        self.assertEqual(2, loader.loadTestsFromModule(module).countTestCases())
 
2592
 
 
2593
    def test_load_tests_from_module_name_smoke_test(self):
 
2594
        loader = TestUtil.TestLoader()
 
2595
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2596
        self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
 
2597
                          _test_ids(suite))
 
2598
 
 
2599
    def test_load_tests_from_module_name_with_bogus_module_name(self):
 
2600
        loader = TestUtil.TestLoader()
 
2601
        self.assertRaises(ImportError, loader.loadTestsFromModuleName, 'bogus')
 
2602
 
 
2603
 
 
2604
class TestTestIdList(tests.TestCase):
 
2605
 
 
2606
    def _create_id_list(self, test_list):
 
2607
        return tests.TestIdList(test_list)
 
2608
 
 
2609
    def _create_suite(self, test_id_list):
 
2610
 
 
2611
        class Stub(tests.TestCase):
 
2612
            def test_foo(self):
 
2613
                pass
 
2614
 
 
2615
        def _create_test_id(id):
 
2616
            return lambda: id
 
2617
 
 
2618
        suite = TestUtil.TestSuite()
 
2619
        for id in test_id_list:
 
2620
            t  = Stub('test_foo')
 
2621
            t.id = _create_test_id(id)
 
2622
            suite.addTest(t)
 
2623
        return suite
 
2624
 
 
2625
    def _test_ids(self, test_suite):
 
2626
        """Get the ids for the tests in a test suite."""
 
2627
        return [t.id() for t in tests.iter_suite_tests(test_suite)]
 
2628
 
 
2629
    def test_empty_list(self):
 
2630
        id_list = self._create_id_list([])
 
2631
        self.assertEquals({}, id_list.tests)
 
2632
        self.assertEquals({}, id_list.modules)
 
2633
 
 
2634
    def test_valid_list(self):
 
2635
        id_list = self._create_id_list(
 
2636
            ['mod1.cl1.meth1', 'mod1.cl1.meth2',
 
2637
             'mod1.func1', 'mod1.cl2.meth2',
 
2638
             'mod1.submod1',
 
2639
             'mod1.submod2.cl1.meth1', 'mod1.submod2.cl2.meth2',
 
2640
             ])
 
2641
        self.assertTrue(id_list.refers_to('mod1'))
 
2642
        self.assertTrue(id_list.refers_to('mod1.submod1'))
 
2643
        self.assertTrue(id_list.refers_to('mod1.submod2'))
 
2644
        self.assertTrue(id_list.includes('mod1.cl1.meth1'))
 
2645
        self.assertTrue(id_list.includes('mod1.submod1'))
 
2646
        self.assertTrue(id_list.includes('mod1.func1'))
 
2647
 
 
2648
    def test_bad_chars_in_params(self):
 
2649
        id_list = self._create_id_list(['mod1.cl1.meth1(xx.yy)'])
 
2650
        self.assertTrue(id_list.refers_to('mod1'))
 
2651
        self.assertTrue(id_list.includes('mod1.cl1.meth1(xx.yy)'))
 
2652
 
 
2653
    def test_module_used(self):
 
2654
        id_list = self._create_id_list(['mod.class.meth'])
 
2655
        self.assertTrue(id_list.refers_to('mod'))
 
2656
        self.assertTrue(id_list.refers_to('mod.class'))
 
2657
        self.assertTrue(id_list.refers_to('mod.class.meth'))
 
2658
 
 
2659
    def test_test_suite_matches_id_list_with_unknown(self):
 
2660
        loader = TestUtil.TestLoader()
 
2661
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2662
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',
 
2663
                     'bogus']
 
2664
        not_found, duplicates = tests.suite_matches_id_list(suite, test_list)
 
2665
        self.assertEquals(['bogus'], not_found)
 
2666
        self.assertEquals([], duplicates)
 
2667
 
 
2668
    def test_suite_matches_id_list_with_duplicates(self):
 
2669
        loader = TestUtil.TestLoader()
 
2670
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2671
        dupes = loader.suiteClass()
 
2672
        for test in tests.iter_suite_tests(suite):
 
2673
            dupes.addTest(test)
 
2674
            dupes.addTest(test) # Add it again
 
2675
 
 
2676
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',]
 
2677
        not_found, duplicates = tests.suite_matches_id_list(
 
2678
            dupes, test_list)
 
2679
        self.assertEquals([], not_found)
 
2680
        self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
 
2681
                          duplicates)
 
2682
 
 
2683
 
 
2684
class TestTestSuite(tests.TestCase):
 
2685
 
 
2686
    def test_test_suite(self):
 
2687
        # This test is slow - it loads the entire test suite to operate, so we
 
2688
        # do a single test with one test in each category
 
2689
        test_list = [
 
2690
            # testmod_names
 
2691
            'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
 
2692
            ('bzrlib.tests.per_transport.TransportTests'
 
2693
             '.test_abspath(LocalURLServer)'),
 
2694
            'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
 
2695
            # modules_to_doctest
 
2696
            'bzrlib.timestamp.format_highres_date',
 
2697
            # plugins can't be tested that way since selftest may be run with
 
2698
            # --no-plugins
 
2699
            ]
 
2700
        suite = tests.test_suite(test_list)
 
2701
        self.assertEquals(test_list, _test_ids(suite))
 
2702
 
 
2703
    def test_test_suite_list_and_start(self):
 
2704
        # We cannot test this at the same time as the main load, because we want
 
2705
        # to know that starting_with == None works. So a second full load is
 
2706
        # incurred.
 
2707
        test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
 
2708
        suite = tests.test_suite(test_list,
 
2709
                                 ['bzrlib.tests.test_selftest.TestTestSuite'])
 
2710
        # test_test_suite_list_and_start is not included 
 
2711
        self.assertEquals(test_list, _test_ids(suite))
 
2712
 
 
2713
 
 
2714
class TestLoadTestIdList(tests.TestCaseInTempDir):
 
2715
 
 
2716
    def _create_test_list_file(self, file_name, content):
 
2717
        fl = open(file_name, 'wt')
 
2718
        fl.write(content)
 
2719
        fl.close()
 
2720
 
 
2721
    def test_load_unknown(self):
 
2722
        self.assertRaises(errors.NoSuchFile,
 
2723
                          tests.load_test_id_list, 'i_do_not_exist')
 
2724
 
 
2725
    def test_load_test_list(self):
 
2726
        test_list_fname = 'test.list'
 
2727
        self._create_test_list_file(test_list_fname,
 
2728
                                    'mod1.cl1.meth1\nmod2.cl2.meth2\n')
 
2729
        tlist = tests.load_test_id_list(test_list_fname)
 
2730
        self.assertEquals(2, len(tlist))
 
2731
        self.assertEquals('mod1.cl1.meth1', tlist[0])
 
2732
        self.assertEquals('mod2.cl2.meth2', tlist[1])
 
2733
 
 
2734
    def test_load_dirty_file(self):
 
2735
        test_list_fname = 'test.list'
 
2736
        self._create_test_list_file(test_list_fname,
 
2737
                                    '  mod1.cl1.meth1\n\nmod2.cl2.meth2  \n'
 
2738
                                    'bar baz\n')
 
2739
        tlist = tests.load_test_id_list(test_list_fname)
 
2740
        self.assertEquals(4, len(tlist))
 
2741
        self.assertEquals('mod1.cl1.meth1', tlist[0])
 
2742
        self.assertEquals('', tlist[1])
 
2743
        self.assertEquals('mod2.cl2.meth2', tlist[2])
 
2744
        self.assertEquals('bar baz', tlist[3])
 
2745
 
 
2746
 
 
2747
class TestFilteredByModuleTestLoader(tests.TestCase):
 
2748
 
 
2749
    def _create_loader(self, test_list):
 
2750
        id_filter = tests.TestIdList(test_list)
 
2751
        loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
 
2752
        return loader
 
2753
 
 
2754
    def test_load_tests(self):
 
2755
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2756
        loader = self._create_loader(test_list)
 
2757
 
 
2758
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2759
        self.assertEquals(test_list, _test_ids(suite))
 
2760
 
 
2761
    def test_exclude_tests(self):
 
2762
        test_list = ['bogus']
 
2763
        loader = self._create_loader(test_list)
 
2764
 
 
2765
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2766
        self.assertEquals([], _test_ids(suite))
 
2767
 
 
2768
 
 
2769
class TestFilteredByNameStartTestLoader(tests.TestCase):
 
2770
 
 
2771
    def _create_loader(self, name_start):
 
2772
        def needs_module(name):
 
2773
            return name.startswith(name_start) or name_start.startswith(name)
 
2774
        loader = TestUtil.FilteredByModuleTestLoader(needs_module)
 
2775
        return loader
 
2776
 
 
2777
    def test_load_tests(self):
 
2778
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2779
        loader = self._create_loader('bzrlib.tests.test_samp')
 
2780
 
 
2781
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2782
        self.assertEquals(test_list, _test_ids(suite))
 
2783
 
 
2784
    def test_load_tests_inside_module(self):
 
2785
        test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
 
2786
        loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
 
2787
 
 
2788
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2789
        self.assertEquals(test_list, _test_ids(suite))
 
2790
 
 
2791
    def test_exclude_tests(self):
 
2792
        test_list = ['bogus']
 
2793
        loader = self._create_loader('bogus')
 
2794
 
 
2795
        suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
 
2796
        self.assertEquals([], _test_ids(suite))
 
2797
 
 
2798
 
 
2799
class TestTestPrefixRegistry(tests.TestCase):
 
2800
 
 
2801
    def _get_registry(self):
 
2802
        tp_registry = tests.TestPrefixAliasRegistry()
 
2803
        return tp_registry
 
2804
 
 
2805
    def test_register_new_prefix(self):
 
2806
        tpr = self._get_registry()
 
2807
        tpr.register('foo', 'fff.ooo.ooo')
 
2808
        self.assertEquals('fff.ooo.ooo', tpr.get('foo'))
 
2809
 
 
2810
    def test_register_existing_prefix(self):
 
2811
        tpr = self._get_registry()
 
2812
        tpr.register('bar', 'bbb.aaa.rrr')
 
2813
        tpr.register('bar', 'bBB.aAA.rRR')
 
2814
        self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
 
2815
        self.assertContainsRe(self._get_log(keep_log_file=True),
 
2816
                              r'.*bar.*bbb.aaa.rrr.*bBB.aAA.rRR')
 
2817
 
 
2818
    def test_get_unknown_prefix(self):
 
2819
        tpr = self._get_registry()
 
2820
        self.assertRaises(KeyError, tpr.get, 'I am not a prefix')
 
2821
 
 
2822
    def test_resolve_prefix(self):
 
2823
        tpr = self._get_registry()
 
2824
        tpr.register('bar', 'bb.aa.rr')
 
2825
        self.assertEquals('bb.aa.rr', tpr.resolve_alias('bar'))
 
2826
 
 
2827
    def test_resolve_unknown_alias(self):
 
2828
        tpr = self._get_registry()
 
2829
        self.assertRaises(errors.BzrCommandError,
 
2830
                          tpr.resolve_alias, 'I am not a prefix')
 
2831
 
 
2832
    def test_predefined_prefixes(self):
 
2833
        tpr = tests.test_prefix_alias_registry
 
2834
        self.assertEquals('bzrlib', tpr.resolve_alias('bzrlib'))
 
2835
        self.assertEquals('bzrlib.doc', tpr.resolve_alias('bd'))
 
2836
        self.assertEquals('bzrlib.utils', tpr.resolve_alias('bu'))
 
2837
        self.assertEquals('bzrlib.tests', tpr.resolve_alias('bt'))
 
2838
        self.assertEquals('bzrlib.tests.blackbox', tpr.resolve_alias('bb'))
 
2839
        self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
 
2840
 
 
2841
 
 
2842
class TestRunSuite(tests.TestCase):
 
2843
 
 
2844
    def test_runner_class(self):
 
2845
        """run_suite accepts and uses a runner_class keyword argument."""
 
2846
        class Stub(tests.TestCase):
 
2847
            def test_foo(self):
 
2848
                pass
 
2849
        suite = Stub("test_foo")
 
2850
        calls = []
 
2851
        class MyRunner(tests.TextTestRunner):
 
2852
            def run(self, test):
 
2853
                calls.append(test)
 
2854
                return tests.ExtendedTestResult(self.stream, self.descriptions,
 
2855
                                                self.verbosity)
 
2856
        tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
 
2857
        self.assertLength(1, calls)
 
2858
 
 
2859
    def test_done(self):
 
2860
        """run_suite should call result.done()"""
 
2861
        self.calls = 0
 
2862
        def one_more_call(): self.calls += 1
 
2863
        def test_function():
 
2864
            pass
 
2865
        test = unittest.FunctionTestCase(test_function)
 
2866
        class InstrumentedTestResult(tests.ExtendedTestResult):
 
2867
            def done(self): one_more_call()
 
2868
        class MyRunner(tests.TextTestRunner):
 
2869
            def run(self, test):
 
2870
                return InstrumentedTestResult(self.stream, self.descriptions,
 
2871
                                              self.verbosity)
 
2872
        tests.run_suite(test, runner_class=MyRunner, stream=StringIO())
 
2873
        self.assertEquals(1, self.calls)