~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_selftest.py

  • Committer: John Arbash Meinel
  • Date: 2006-07-09 15:47:02 UTC
  • mto: This revision was merged to the branch mainline in revision 1846.
  • Revision ID: john@arbash-meinel.com-20060709154702-304436a47a55e265
Renaming LockHelpers.py to lock_helpers.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 by 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 version 2 as published by
 
5
# the Free Software Foundation.
 
6
#
 
7
# This program is distributed in the hope that it will be useful,
 
8
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
9
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
10
# GNU General Public License for more details.
 
11
#
 
12
# You should have received a copy of the GNU General Public License
 
13
# along with this program; if not, write to the Free Software
 
14
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
 
 
16
"""Tests for the test framework."""
 
17
 
 
18
import os
 
19
from StringIO import StringIO
 
20
import sys
 
21
import time
 
22
import unittest
 
23
import warnings
 
24
 
 
25
import bzrlib
 
26
from bzrlib.progress import _BaseProgressBar
 
27
from bzrlib.tests import (
 
28
                          ChrootedTestCase,
 
29
                          TestCase,
 
30
                          TestCaseInTempDir,
 
31
                          TestCaseWithTransport,
 
32
                          TestSkipped,
 
33
                          TestSuite,
 
34
                          TextTestRunner,
 
35
                          )
 
36
from bzrlib.tests.TestUtil import _load_module_by_name
 
37
import bzrlib.errors as errors
 
38
from bzrlib.trace import note
 
39
 
 
40
 
 
41
class SelftestTests(TestCase):
 
42
 
 
43
    def test_import_tests(self):
 
44
        mod = _load_module_by_name('bzrlib.tests.test_selftest')
 
45
        self.assertEqual(mod.SelftestTests, SelftestTests)
 
46
 
 
47
    def test_import_test_failure(self):
 
48
        self.assertRaises(ImportError,
 
49
                          _load_module_by_name,
 
50
                          'bzrlib.no-name-yet')
 
51
 
 
52
 
 
53
class MetaTestLog(TestCase):
 
54
 
 
55
    def test_logging(self):
 
56
        """Test logs are captured when a test fails."""
 
57
        self.log('a test message')
 
58
        self._log_file.flush()
 
59
        self.assertContainsRe(self._get_log(), 'a test message\n')
 
60
 
 
61
 
 
62
class TestTreeShape(TestCaseInTempDir):
 
63
 
 
64
    def test_unicode_paths(self):
 
65
        filename = u'hell\u00d8'
 
66
        try:
 
67
            self.build_tree_contents([(filename, 'contents of hello')])
 
68
        except UnicodeEncodeError:
 
69
            raise TestSkipped("can't build unicode working tree in "
 
70
                "filesystem encoding %s" % sys.getfilesystemencoding())
 
71
        self.failUnlessExists(filename)
 
72
 
 
73
 
 
74
class TestTransportProviderAdapter(TestCase):
 
75
    """A group of tests that test the transport implementation adaption core.
 
76
 
 
77
    This is a meta test that the tests are applied to all available 
 
78
    transports.
 
79
 
 
80
    This will be generalised in the future which is why it is in this 
 
81
    test file even though it is specific to transport tests at the moment.
 
82
    """
 
83
 
 
84
    def test_get_transport_permutations(self):
 
85
        # this checks that we the module get_test_permutations call
 
86
        # is made by the adapter get_transport_test_permitations method.
 
87
        class MockModule(object):
 
88
            def get_test_permutations(self):
 
89
                return sample_permutation
 
90
        sample_permutation = [(1,2), (3,4)]
 
91
        from bzrlib.transport import TransportTestProviderAdapter
 
92
        adapter = TransportTestProviderAdapter()
 
93
        self.assertEqual(sample_permutation,
 
94
                         adapter.get_transport_test_permutations(MockModule()))
 
95
 
 
96
    def test_adapter_checks_all_modules(self):
 
97
        # this checks that the adapter returns as many permurtations as
 
98
        # there are in all the registered# transport modules for there
 
99
        # - we assume if this matches its probably doing the right thing
 
100
        # especially in combination with the tests for setting the right
 
101
        # classes below.
 
102
        from bzrlib.transport import (TransportTestProviderAdapter,
 
103
                                      _get_transport_modules
 
104
                                      )
 
105
        modules = _get_transport_modules()
 
106
        permutation_count = 0
 
107
        for module in modules:
 
108
            try:
 
109
                permutation_count += len(reduce(getattr, 
 
110
                    (module + ".get_test_permutations").split('.')[1:],
 
111
                     __import__(module))())
 
112
            except errors.DependencyNotPresent:
 
113
                pass
 
114
        input_test = TestTransportProviderAdapter(
 
115
            "test_adapter_sets_transport_class")
 
116
        adapter = TransportTestProviderAdapter()
 
117
        self.assertEqual(permutation_count,
 
118
                         len(list(iter(adapter.adapt(input_test)))))
 
119
 
 
120
    def test_adapter_sets_transport_class(self):
 
121
        # Check that the test adapter inserts a transport and server into the
 
122
        # generated test.
 
123
        #
 
124
        # This test used to know about all the possible transports and the
 
125
        # order they were returned but that seems overly brittle (mbp
 
126
        # 20060307)
 
127
        input_test = TestTransportProviderAdapter(
 
128
            "test_adapter_sets_transport_class")
 
129
        from bzrlib.transport import TransportTestProviderAdapter
 
130
        suite = TransportTestProviderAdapter().adapt(input_test)
 
131
        tests = list(iter(suite))
 
132
        self.assertTrue(len(tests) > 6)
 
133
        # there are at least that many builtin transports
 
134
        one_test = tests[0]
 
135
        self.assertTrue(issubclass(one_test.transport_class, 
 
136
                                   bzrlib.transport.Transport))
 
137
        self.assertTrue(issubclass(one_test.transport_server, 
 
138
                                   bzrlib.transport.Server))
 
139
 
 
140
 
 
141
class TestBranchProviderAdapter(TestCase):
 
142
    """A group of tests that test the branch implementation test adapter."""
 
143
 
 
144
    def test_adapted_tests(self):
 
145
        # check that constructor parameters are passed through to the adapted
 
146
        # test.
 
147
        from bzrlib.branch import BranchTestProviderAdapter
 
148
        input_test = TestBranchProviderAdapter(
 
149
            "test_adapted_tests")
 
150
        server1 = "a"
 
151
        server2 = "b"
 
152
        formats = [("c", "C"), ("d", "D")]
 
153
        adapter = BranchTestProviderAdapter(server1, server2, formats)
 
154
        suite = adapter.adapt(input_test)
 
155
        tests = list(iter(suite))
 
156
        self.assertEqual(2, len(tests))
 
157
        self.assertEqual(tests[0].branch_format, formats[0][0])
 
158
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
 
159
        self.assertEqual(tests[0].transport_server, server1)
 
160
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
161
        self.assertEqual(tests[1].branch_format, formats[1][0])
 
162
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
 
163
        self.assertEqual(tests[1].transport_server, server1)
 
164
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
165
 
 
166
 
 
167
class TestBzrDirProviderAdapter(TestCase):
 
168
    """A group of tests that test the bzr dir implementation test adapter."""
 
169
 
 
170
    def test_adapted_tests(self):
 
171
        # check that constructor parameters are passed through to the adapted
 
172
        # test.
 
173
        from bzrlib.bzrdir import BzrDirTestProviderAdapter
 
174
        input_test = TestBzrDirProviderAdapter(
 
175
            "test_adapted_tests")
 
176
        server1 = "a"
 
177
        server2 = "b"
 
178
        formats = ["c", "d"]
 
179
        adapter = BzrDirTestProviderAdapter(server1, server2, formats)
 
180
        suite = adapter.adapt(input_test)
 
181
        tests = list(iter(suite))
 
182
        self.assertEqual(2, len(tests))
 
183
        self.assertEqual(tests[0].bzrdir_format, formats[0])
 
184
        self.assertEqual(tests[0].transport_server, server1)
 
185
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
186
        self.assertEqual(tests[1].bzrdir_format, formats[1])
 
187
        self.assertEqual(tests[1].transport_server, server1)
 
188
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
189
 
 
190
 
 
191
class TestRepositoryProviderAdapter(TestCase):
 
192
    """A group of tests that test the repository implementation test adapter."""
 
193
 
 
194
    def test_adapted_tests(self):
 
195
        # check that constructor parameters are passed through to the adapted
 
196
        # test.
 
197
        from bzrlib.repository import RepositoryTestProviderAdapter
 
198
        input_test = TestRepositoryProviderAdapter(
 
199
            "test_adapted_tests")
 
200
        server1 = "a"
 
201
        server2 = "b"
 
202
        formats = [("c", "C"), ("d", "D")]
 
203
        adapter = RepositoryTestProviderAdapter(server1, server2, formats)
 
204
        suite = adapter.adapt(input_test)
 
205
        tests = list(iter(suite))
 
206
        self.assertEqual(2, len(tests))
 
207
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
 
208
        self.assertEqual(tests[0].repository_format, formats[0][0])
 
209
        self.assertEqual(tests[0].transport_server, server1)
 
210
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
211
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
 
212
        self.assertEqual(tests[1].repository_format, formats[1][0])
 
213
        self.assertEqual(tests[1].transport_server, server1)
 
214
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
215
 
 
216
 
 
217
class TestInterRepositoryProviderAdapter(TestCase):
 
218
    """A group of tests that test the InterRepository test adapter."""
 
219
 
 
220
    def test_adapted_tests(self):
 
221
        # check that constructor parameters are passed through to the adapted
 
222
        # test.
 
223
        from bzrlib.repository import InterRepositoryTestProviderAdapter
 
224
        input_test = TestInterRepositoryProviderAdapter(
 
225
            "test_adapted_tests")
 
226
        server1 = "a"
 
227
        server2 = "b"
 
228
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
 
229
        adapter = InterRepositoryTestProviderAdapter(server1, server2, formats)
 
230
        suite = adapter.adapt(input_test)
 
231
        tests = list(iter(suite))
 
232
        self.assertEqual(2, len(tests))
 
233
        self.assertEqual(tests[0].interrepo_class, formats[0][0])
 
234
        self.assertEqual(tests[0].repository_format, formats[0][1])
 
235
        self.assertEqual(tests[0].repository_format_to, formats[0][2])
 
236
        self.assertEqual(tests[0].transport_server, server1)
 
237
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
238
        self.assertEqual(tests[1].interrepo_class, formats[1][0])
 
239
        self.assertEqual(tests[1].repository_format, formats[1][1])
 
240
        self.assertEqual(tests[1].repository_format_to, formats[1][2])
 
241
        self.assertEqual(tests[1].transport_server, server1)
 
242
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
243
 
 
244
 
 
245
class TestInterVersionedFileProviderAdapter(TestCase):
 
246
    """A group of tests that test the InterVersionedFile test adapter."""
 
247
 
 
248
    def test_adapted_tests(self):
 
249
        # check that constructor parameters are passed through to the adapted
 
250
        # test.
 
251
        from bzrlib.versionedfile import InterVersionedFileTestProviderAdapter
 
252
        input_test = TestInterRepositoryProviderAdapter(
 
253
            "test_adapted_tests")
 
254
        server1 = "a"
 
255
        server2 = "b"
 
256
        formats = [(str, "C1", "C2"), (int, "D1", "D2")]
 
257
        adapter = InterVersionedFileTestProviderAdapter(server1, server2, formats)
 
258
        suite = adapter.adapt(input_test)
 
259
        tests = list(iter(suite))
 
260
        self.assertEqual(2, len(tests))
 
261
        self.assertEqual(tests[0].interversionedfile_class, formats[0][0])
 
262
        self.assertEqual(tests[0].versionedfile_factory, formats[0][1])
 
263
        self.assertEqual(tests[0].versionedfile_factory_to, formats[0][2])
 
264
        self.assertEqual(tests[0].transport_server, server1)
 
265
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
266
        self.assertEqual(tests[1].interversionedfile_class, formats[1][0])
 
267
        self.assertEqual(tests[1].versionedfile_factory, formats[1][1])
 
268
        self.assertEqual(tests[1].versionedfile_factory_to, formats[1][2])
 
269
        self.assertEqual(tests[1].transport_server, server1)
 
270
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
271
 
 
272
 
 
273
class TestRevisionStoreProviderAdapter(TestCase):
 
274
    """A group of tests that test the RevisionStore test adapter."""
 
275
 
 
276
    def test_adapted_tests(self):
 
277
        # check that constructor parameters are passed through to the adapted
 
278
        # test.
 
279
        from bzrlib.store.revision import RevisionStoreTestProviderAdapter
 
280
        input_test = TestRevisionStoreProviderAdapter(
 
281
            "test_adapted_tests")
 
282
        # revision stores need a store factory - i.e. RevisionKnit
 
283
        #, a readonly and rw transport 
 
284
        # transport servers:
 
285
        server1 = "a"
 
286
        server2 = "b"
 
287
        store_factories = ["c", "d"]
 
288
        adapter = RevisionStoreTestProviderAdapter(server1, server2, store_factories)
 
289
        suite = adapter.adapt(input_test)
 
290
        tests = list(iter(suite))
 
291
        self.assertEqual(2, len(tests))
 
292
        self.assertEqual(tests[0].store_factory, store_factories[0][0])
 
293
        self.assertEqual(tests[0].transport_server, server1)
 
294
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
295
        self.assertEqual(tests[1].store_factory, store_factories[1][0])
 
296
        self.assertEqual(tests[1].transport_server, server1)
 
297
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
298
 
 
299
 
 
300
class TestWorkingTreeProviderAdapter(TestCase):
 
301
    """A group of tests that test the workingtree implementation test adapter."""
 
302
 
 
303
    def test_adapted_tests(self):
 
304
        # check that constructor parameters are passed through to the adapted
 
305
        # test.
 
306
        from bzrlib.workingtree import WorkingTreeTestProviderAdapter
 
307
        input_test = TestWorkingTreeProviderAdapter(
 
308
            "test_adapted_tests")
 
309
        server1 = "a"
 
310
        server2 = "b"
 
311
        formats = [("c", "C"), ("d", "D")]
 
312
        adapter = WorkingTreeTestProviderAdapter(server1, server2, formats)
 
313
        suite = adapter.adapt(input_test)
 
314
        tests = list(iter(suite))
 
315
        self.assertEqual(2, len(tests))
 
316
        self.assertEqual(tests[0].workingtree_format, formats[0][0])
 
317
        self.assertEqual(tests[0].bzrdir_format, formats[0][1])
 
318
        self.assertEqual(tests[0].transport_server, server1)
 
319
        self.assertEqual(tests[0].transport_readonly_server, server2)
 
320
        self.assertEqual(tests[1].workingtree_format, formats[1][0])
 
321
        self.assertEqual(tests[1].bzrdir_format, formats[1][1])
 
322
        self.assertEqual(tests[1].transport_server, server1)
 
323
        self.assertEqual(tests[1].transport_readonly_server, server2)
 
324
 
 
325
 
 
326
class TestTestCaseWithTransport(TestCaseWithTransport):
 
327
    """Tests for the convenience functions TestCaseWithTransport introduces."""
 
328
 
 
329
    def test_get_readonly_url_none(self):
 
330
        from bzrlib.transport import get_transport
 
331
        from bzrlib.transport.memory import MemoryServer
 
332
        from bzrlib.transport.readonly import ReadonlyTransportDecorator
 
333
        self.transport_server = MemoryServer
 
334
        self.transport_readonly_server = None
 
335
        # calling get_readonly_transport() constructs a decorator on the url
 
336
        # for the server
 
337
        url = self.get_readonly_url()
 
338
        url2 = self.get_readonly_url('foo/bar')
 
339
        t = get_transport(url)
 
340
        t2 = get_transport(url2)
 
341
        self.failUnless(isinstance(t, ReadonlyTransportDecorator))
 
342
        self.failUnless(isinstance(t2, ReadonlyTransportDecorator))
 
343
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
 
344
 
 
345
    def test_get_readonly_url_http(self):
 
346
        from bzrlib.transport import get_transport
 
347
        from bzrlib.transport.local import LocalRelpathServer
 
348
        from bzrlib.transport.http import HttpServer, HttpTransportBase
 
349
        self.transport_server = LocalRelpathServer
 
350
        self.transport_readonly_server = HttpServer
 
351
        # calling get_readonly_transport() gives us a HTTP server instance.
 
352
        url = self.get_readonly_url()
 
353
        url2 = self.get_readonly_url('foo/bar')
 
354
        # the transport returned may be any HttpTransportBase subclass
 
355
        t = get_transport(url)
 
356
        t2 = get_transport(url2)
 
357
        self.failUnless(isinstance(t, HttpTransportBase))
 
358
        self.failUnless(isinstance(t2, HttpTransportBase))
 
359
        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
 
360
 
 
361
    def test_is_directory(self):
 
362
        """Test assertIsDirectory assertion"""
 
363
        t = self.get_transport()
 
364
        self.build_tree(['a_dir/', 'a_file'], transport=t)
 
365
        self.assertIsDirectory('a_dir', t)
 
366
        self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
 
367
        self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
 
368
 
 
369
 
 
370
class TestChrootedTest(ChrootedTestCase):
 
371
 
 
372
    def test_root_is_root(self):
 
373
        from bzrlib.transport import get_transport
 
374
        t = get_transport(self.get_readonly_url())
 
375
        url = t.base
 
376
        self.assertEqual(url, t.clone('..').base)
 
377
 
 
378
 
 
379
class MockProgress(_BaseProgressBar):
 
380
    """Progress-bar standin that records calls.
 
381
 
 
382
    Useful for testing pb using code.
 
383
    """
 
384
 
 
385
    def __init__(self):
 
386
        _BaseProgressBar.__init__(self)
 
387
        self.calls = []
 
388
 
 
389
    def tick(self):
 
390
        self.calls.append(('tick',))
 
391
 
 
392
    def update(self, msg=None, current=None, total=None):
 
393
        self.calls.append(('update', msg, current, total))
 
394
 
 
395
    def clear(self):
 
396
        self.calls.append(('clear',))
 
397
 
 
398
 
 
399
class TestTestResult(TestCase):
 
400
 
 
401
    def test_progress_bar_style_quiet(self):
 
402
        # test using a progress bar.
 
403
        dummy_test = TestTestResult('test_progress_bar_style_quiet')
 
404
        dummy_error = (Exception, None, [])
 
405
        mypb = MockProgress()
 
406
        mypb.update('Running tests', 0, 4)
 
407
        last_calls = mypb.calls[:]
 
408
        result = bzrlib.tests._MyResult(self._log_file,
 
409
                                        descriptions=0,
 
410
                                        verbosity=1,
 
411
                                        pb=mypb)
 
412
        self.assertEqual(last_calls, mypb.calls)
 
413
 
 
414
        # an error 
 
415
        result.startTest(dummy_test)
 
416
        # starting a test prints the test name
 
417
        self.assertEqual(last_calls + [('update', '...tyle_quiet', 0, None)], mypb.calls)
 
418
        last_calls = mypb.calls[:]
 
419
        result.addError(dummy_test, dummy_error)
 
420
        self.assertEqual(last_calls + [('update', 'ERROR        ', 1, None)], mypb.calls)
 
421
        last_calls = mypb.calls[:]
 
422
 
 
423
        # a failure
 
424
        result.startTest(dummy_test)
 
425
        self.assertEqual(last_calls + [('update', '...tyle_quiet', 1, None)], mypb.calls)
 
426
        last_calls = mypb.calls[:]
 
427
        result.addFailure(dummy_test, dummy_error)
 
428
        self.assertEqual(last_calls + [('update', 'FAIL         ', 2, None)], mypb.calls)
 
429
        last_calls = mypb.calls[:]
 
430
 
 
431
        # a success
 
432
        result.startTest(dummy_test)
 
433
        self.assertEqual(last_calls + [('update', '...tyle_quiet', 2, None)], mypb.calls)
 
434
        last_calls = mypb.calls[:]
 
435
        result.addSuccess(dummy_test)
 
436
        self.assertEqual(last_calls + [('update', 'OK           ', 3, None)], mypb.calls)
 
437
        last_calls = mypb.calls[:]
 
438
 
 
439
        # a skip
 
440
        result.startTest(dummy_test)
 
441
        self.assertEqual(last_calls + [('update', '...tyle_quiet', 3, None)], mypb.calls)
 
442
        last_calls = mypb.calls[:]
 
443
        result.addSkipped(dummy_test, dummy_error)
 
444
        self.assertEqual(last_calls + [('update', 'SKIP         ', 4, None)], mypb.calls)
 
445
        last_calls = mypb.calls[:]
 
446
 
 
447
    def test_elapsed_time_with_benchmarking(self):
 
448
        result = bzrlib.tests._MyResult(self._log_file,
 
449
                                        descriptions=0,
 
450
                                        verbosity=1,
 
451
                                        )
 
452
        result._recordTestStartTime()
 
453
        time.sleep(0.003)
 
454
        result.extractBenchmarkTime(self)
 
455
        timed_string = result._testTimeString()
 
456
        # without explicit benchmarking, we should get a simple time.
 
457
        self.assertContainsRe(timed_string, "^         [ 1-9][0-9]ms$")
 
458
        # if a benchmark time is given, we want a x of y style result.
 
459
        self.time(time.sleep, 0.001)
 
460
        result.extractBenchmarkTime(self)
 
461
        timed_string = result._testTimeString()
 
462
        self.assertContainsRe(timed_string, "^   [ 1-9][0-9]ms/   [ 1-9][0-9]ms$")
 
463
        # extracting the time from a non-bzrlib testcase sets to None
 
464
        result._recordTestStartTime()
 
465
        result.extractBenchmarkTime(
 
466
            unittest.FunctionTestCase(self.test_elapsed_time_with_benchmarking))
 
467
        timed_string = result._testTimeString()
 
468
        self.assertContainsRe(timed_string, "^         [ 1-9][0-9]ms$")
 
469
        # cheat. Yes, wash thy mouth out with soap.
 
470
        self._benchtime = None
 
471
 
 
472
    def _time_hello_world_encoding(self):
 
473
        """Profile two sleep calls
 
474
        
 
475
        This is used to exercise the test framework.
 
476
        """
 
477
        self.time(unicode, 'hello', errors='replace')
 
478
        self.time(unicode, 'world', errors='replace')
 
479
 
 
480
    def test_lsprofiling(self):
 
481
        """Verbose test result prints lsprof statistics from test cases."""
 
482
        try:
 
483
            import bzrlib.lsprof
 
484
        except ImportError:
 
485
            raise TestSkipped("lsprof not installed.")
 
486
        result_stream = StringIO()
 
487
        result = bzrlib.tests._MyResult(
 
488
            unittest._WritelnDecorator(result_stream),
 
489
            descriptions=0,
 
490
            verbosity=2,
 
491
            )
 
492
        # we want profile a call of some sort and check it is output by
 
493
        # addSuccess. We dont care about addError or addFailure as they
 
494
        # are not that interesting for performance tuning.
 
495
        # make a new test instance that when run will generate a profile
 
496
        example_test_case = TestTestResult("_time_hello_world_encoding")
 
497
        example_test_case._gather_lsprof_in_benchmarks = True
 
498
        # execute the test, which should succeed and record profiles
 
499
        example_test_case.run(result)
 
500
        # lsprofile_something()
 
501
        # if this worked we want 
 
502
        # LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
 
503
        #    CallCount    Recursive    Total(ms)   Inline(ms) module:lineno(function)
 
504
        # (the lsprof header)
 
505
        # ... an arbitrary number of lines
 
506
        # and the function call which is time.sleep.
 
507
        #           1        0            ???         ???       ???(sleep) 
 
508
        # and then repeated but with 'world', rather than 'hello'.
 
509
        # this should appear in the output stream of our test result.
 
510
        output = result_stream.getvalue()
 
511
        self.assertContainsRe(output,
 
512
            r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
 
513
        self.assertContainsRe(output,
 
514
            r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
 
515
        self.assertContainsRe(output,
 
516
            r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
 
517
        self.assertContainsRe(output,
 
518
            r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
 
519
 
 
520
 
 
521
class TestRunner(TestCase):
 
522
 
 
523
    def dummy_test(self):
 
524
        pass
 
525
 
 
526
    def run_test_runner(self, testrunner, test):
 
527
        """Run suite in testrunner, saving global state and restoring it.
 
528
 
 
529
        This current saves and restores:
 
530
        TestCaseInTempDir.TEST_ROOT
 
531
        
 
532
        There should be no tests in this file that use bzrlib.tests.TextTestRunner
 
533
        without using this convenience method, because of our use of global state.
 
534
        """
 
535
        old_root = TestCaseInTempDir.TEST_ROOT
 
536
        try:
 
537
            TestCaseInTempDir.TEST_ROOT = None
 
538
            return testrunner.run(test)
 
539
        finally:
 
540
            TestCaseInTempDir.TEST_ROOT = old_root
 
541
 
 
542
    def test_accepts_and_uses_pb_parameter(self):
 
543
        test = TestRunner('dummy_test')
 
544
        mypb = MockProgress()
 
545
        self.assertEqual([], mypb.calls)
 
546
        runner = TextTestRunner(stream=self._log_file, pb=mypb)
 
547
        result = self.run_test_runner(runner, test)
 
548
        self.assertEqual(1, result.testsRun)
 
549
        self.assertEqual(('update', 'Running tests', 0, 1), mypb.calls[0])
 
550
        self.assertEqual(('update', '...dummy_test', 0, None), mypb.calls[1])
 
551
        self.assertEqual(('update', 'OK           ', 1, None), mypb.calls[2])
 
552
        self.assertEqual(('update', 'Cleaning up', 0, 1), mypb.calls[3])
 
553
        self.assertEqual(('clear',), mypb.calls[4])
 
554
        self.assertEqual(5, len(mypb.calls))
 
555
 
 
556
    def test_skipped_test(self):
 
557
        # run a test that is skipped, and check the suite as a whole still
 
558
        # succeeds.
 
559
        # skipping_test must be hidden in here so it's not run as a real test
 
560
        def skipping_test():
 
561
            raise TestSkipped('test intentionally skipped')
 
562
        runner = TextTestRunner(stream=self._log_file, keep_output=True)
 
563
        test = unittest.FunctionTestCase(skipping_test)
 
564
        result = self.run_test_runner(runner, test)
 
565
        self.assertTrue(result.wasSuccessful())
 
566
 
 
567
 
 
568
class TestTestCase(TestCase):
 
569
    """Tests that test the core bzrlib TestCase."""
 
570
 
 
571
    def inner_test(self):
 
572
        # the inner child test
 
573
        note("inner_test")
 
574
 
 
575
    def outer_child(self):
 
576
        # the outer child test
 
577
        note("outer_start")
 
578
        self.inner_test = TestTestCase("inner_child")
 
579
        result = bzrlib.tests._MyResult(self._log_file,
 
580
                                        descriptions=0,
 
581
                                        verbosity=1)
 
582
        self.inner_test.run(result)
 
583
        note("outer finish")
 
584
 
 
585
    def test_trace_nesting(self):
 
586
        # this tests that each test case nests its trace facility correctly.
 
587
        # we do this by running a test case manually. That test case (A)
 
588
        # should setup a new log, log content to it, setup a child case (B),
 
589
        # which should log independently, then case (A) should log a trailer
 
590
        # and return.
 
591
        # we do two nested children so that we can verify the state of the 
 
592
        # logs after the outer child finishes is correct, which a bad clean
 
593
        # up routine in tearDown might trigger a fault in our test with only
 
594
        # one child, we should instead see the bad result inside our test with
 
595
        # the two children.
 
596
        # the outer child test
 
597
        original_trace = bzrlib.trace._trace_file
 
598
        outer_test = TestTestCase("outer_child")
 
599
        result = bzrlib.tests._MyResult(self._log_file,
 
600
                                        descriptions=0,
 
601
                                        verbosity=1)
 
602
        outer_test.run(result)
 
603
        self.assertEqual(original_trace, bzrlib.trace._trace_file)
 
604
 
 
605
    def method_that_times_a_bit_twice(self):
 
606
        # call self.time twice to ensure it aggregates
 
607
        self.time(time.sleep, 0.007)
 
608
        self.time(time.sleep, 0.007)
 
609
 
 
610
    def test_time_creates_benchmark_in_result(self):
 
611
        """Test that the TestCase.time() method accumulates a benchmark time."""
 
612
        sample_test = TestTestCase("method_that_times_a_bit_twice")
 
613
        output_stream = StringIO()
 
614
        result = bzrlib.tests._MyResult(
 
615
            unittest._WritelnDecorator(output_stream),
 
616
            descriptions=0,
 
617
            verbosity=2)
 
618
        sample_test.run(result)
 
619
        self.assertContainsRe(
 
620
            output_stream.getvalue(),
 
621
            "[1-9][0-9]ms/   [1-9][0-9]ms\n$")
 
622
        
 
623
    def test__gather_lsprof_in_benchmarks(self):
 
624
        """When _gather_lsprof_in_benchmarks is on, accumulate profile data.
 
625
        
 
626
        Each self.time() call is individually and separately profiled.
 
627
        """
 
628
        try:
 
629
            import bzrlib.lsprof
 
630
        except ImportError:
 
631
            raise TestSkipped("lsprof not installed.")
 
632
        # overrides the class member with an instance member so no cleanup 
 
633
        # needed.
 
634
        self._gather_lsprof_in_benchmarks = True
 
635
        self.time(time.sleep, 0.000)
 
636
        self.time(time.sleep, 0.003)
 
637
        self.assertEqual(2, len(self._benchcalls))
 
638
        self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
 
639
        self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
 
640
        self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
 
641
        self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
 
642
 
 
643
 
 
644
class TestExtraAssertions(TestCase):
 
645
    """Tests for new test assertions in bzrlib test suite"""
 
646
 
 
647
    def test_assert_isinstance(self):
 
648
        self.assertIsInstance(2, int)
 
649
        self.assertIsInstance(u'', basestring)
 
650
        self.assertRaises(AssertionError, self.assertIsInstance, None, int)
 
651
        self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
 
652
 
 
653
    def test_assertEndsWith(self):
 
654
        self.assertEndsWith('foo', 'oo')
 
655
        self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
 
656
 
 
657
 
 
658
class TestConvenienceMakers(TestCaseWithTransport):
 
659
    """Test for the make_* convenience functions."""
 
660
 
 
661
    def test_make_branch_and_tree_with_format(self):
 
662
        # we should be able to supply a format to make_branch_and_tree
 
663
        self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
 
664
        self.make_branch_and_tree('b', format=bzrlib.bzrdir.BzrDirFormat6())
 
665
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
 
666
                              bzrlib.bzrdir.BzrDirMetaFormat1)
 
667
        self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('b')._format,
 
668
                              bzrlib.bzrdir.BzrDirFormat6)
 
669
 
 
670
 
 
671
class TestSelftest(TestCase):
 
672
    """Tests of bzrlib.tests.selftest."""
 
673
 
 
674
    def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
 
675
        factory_called = []
 
676
        def factory():
 
677
            factory_called.append(True)
 
678
            return TestSuite()
 
679
        out = StringIO()
 
680
        err = StringIO()
 
681
        self.apply_redirected(out, err, None, bzrlib.tests.selftest, 
 
682
            test_suite_factory=factory)
 
683
        self.assertEqual([True], factory_called)
 
684
 
 
685
    def test_run_bzr_subprocess(self):
 
686
        """The run_bzr_helper_external comand behaves nicely."""
 
687
        result = self.run_bzr_subprocess('--version')
 
688
        result = self.run_bzr_subprocess('--version', retcode=None)
 
689
        self.assertContainsRe(result[0], 'is free software')
 
690
        self.assertRaises(AssertionError, self.run_bzr_subprocess, 
 
691
                          '--versionn')
 
692
        result = self.run_bzr_subprocess('--versionn', retcode=3)
 
693
        result = self.run_bzr_subprocess('--versionn', retcode=None)
 
694
        self.assertContainsRe(result[1], 'unknown command')
 
695
        err = self.run_bzr_subprocess('merge', '--merge-type', 'magic merge', 
 
696
                                      retcode=3)[1]
 
697
        self.assertContainsRe(err, 'No known merge type magic merge')
 
698
 
 
699
    def test_run_bzr_error(self):
 
700
        out, err = self.run_bzr_error(['^$'], 'rocks', retcode=0)
 
701
        self.assertEqual(out, 'it sure does!\n')
 
702
 
 
703
        out, err = self.run_bzr_error(["'foobarbaz' is not a versioned file"],
 
704
                                      'file-id', 'foobarbaz')