← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Danny van Heumen
  • Date: 2010-03-09 21:42:11 UTC
  • mto: (4634.139.5 2.0)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: danny@dannyvanheumen.nl-20100309214211-iqh42x6qcikgd9p3
Reverted now-useless TODO list.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/__init__.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
"""Testing framework extensions"""
18
17
 
19
18
# TODO: Perhaps there should be an API to find out if bzr running under the
20
19
# test suite -- some plugins might want to avoid making intrusive changes if
29
28
 
30
29
import atexit
31
30
import codecs
32
 
from copy import copy
33
31
from cStringIO import StringIO
34
32
import difflib
35
33
import doctest
47
45
import tempfile
48
46
import threading
49
47
import time
50
 
import traceback
51
48
import unittest
52
49
import warnings
53
50
 
54
 
import testtools
55
 
# nb: check this before importing anything else from within it
56
 
_testtools_version = getattr(testtools, '__version__', ())
57
 
if _testtools_version < (0, 9, 2):
58
 
    raise ImportError("need at least testtools 0.9.2: %s is %r"
59
 
        % (testtools.__file__, _testtools_version))
60
 
from testtools import content
61
51
 
62
52
from bzrlib import (
63
53
    branchbuilder,
64
54
    bzrdir,
65
55
    chk_map,
66
 
    config,
67
56
    debug,
68
57
    errors,
69
58
    hooks,
97
86
from bzrlib.symbol_versioning import (
98
87
    DEPRECATED_PARAMETER,
99
88
    deprecated_function,
100
 
    deprecated_in,
101
89
    deprecated_method,
102
90
    deprecated_passed,
103
91
    )
104
92
import bzrlib.trace
105
 
from bzrlib.transport import (
106
 
    get_transport,
107
 
    memory,
108
 
    pathfilter,
109
 
    )
 
93
from bzrlib.transport import get_transport
110
94
import bzrlib.transport
 
95
from bzrlib.transport.local import LocalURLServer
 
96
from bzrlib.transport.memory import MemoryServer
 
97
from bzrlib.transport.readonly import ReadonlyServer
111
98
from bzrlib.trace import mutter, note
112
 
from bzrlib.tests import (
113
 
    test_server,
114
 
    TestUtil,
115
 
    )
 
99
from bzrlib.tests import TestUtil
116
100
from bzrlib.tests.http_server import HttpServer
117
101
from bzrlib.tests.TestUtil import (
118
102
                          TestSuite,
129
113
# shown frame is the test code, not our assertXYZ.
130
114
__unittest = 1
131
115
 
132
 
default_transport = test_server.LocalURLServer
133
 
 
134
 
 
135
 
_unitialized_attr = object()
136
 
"""A sentinel needed to act as a default value in a method signature."""
137
 
 
 
116
default_transport = LocalURLServer
138
117
 
139
118
# Subunit result codes, defined here to prevent a hard dependency on subunit.
140
119
SUBUNIT_SEEK_SET = 0
196
175
        self._overall_start_time = time.time()
197
176
        self._strict = strict
198
177
 
199
 
    def stopTestRun(self):
200
 
        run = self.testsRun
201
 
        actionTaken = "Ran"
202
 
        stopTime = time.time()
203
 
        timeTaken = stopTime - self.startTime
204
 
        self.printErrors()
205
 
        self.stream.writeln(self.separator2)
206
 
        self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
207
 
                            run, run != 1 and "s" or "", timeTaken))
208
 
        self.stream.writeln()
209
 
        if not self.wasSuccessful():
210
 
            self.stream.write("FAILED (")
211
 
            failed, errored = map(len, (self.failures, self.errors))
212
 
            if failed:
213
 
                self.stream.write("failures=%d" % failed)
214
 
            if errored:
215
 
                if failed: self.stream.write(", ")
216
 
                self.stream.write("errors=%d" % errored)
217
 
            if self.known_failure_count:
218
 
                if failed or errored: self.stream.write(", ")
219
 
                self.stream.write("known_failure_count=%d" %
220
 
                    self.known_failure_count)
221
 
            self.stream.writeln(")")
222
 
        else:
223
 
            if self.known_failure_count:
224
 
                self.stream.writeln("OK (known_failures=%d)" %
225
 
                    self.known_failure_count)
226
 
            else:
227
 
                self.stream.writeln("OK")
228
 
        if self.skip_count > 0:
229
 
            skipped = self.skip_count
230
 
            self.stream.writeln('%d test%s skipped' %
231
 
                                (skipped, skipped != 1 and "s" or ""))
232
 
        if self.unsupported:
233
 
            for feature, count in sorted(self.unsupported.items()):
234
 
                self.stream.writeln("Missing feature '%s' skipped %d tests." %
235
 
                    (feature, count))
 
178
    def done(self):
 
179
        # nb: called stopTestRun in the version of this that Python merged
 
180
        # upstream, according to lifeless 20090803
236
181
        if self._strict:
237
182
            ok = self.wasStrictlySuccessful()
238
183
        else:
239
184
            ok = self.wasSuccessful()
 
185
        if ok:
 
186
            self.stream.write('tests passed\n')
 
187
        else:
 
188
            self.stream.write('tests failed\n')
240
189
        if TestCase._first_thread_leaker_id:
241
190
            self.stream.write(
242
191
                '%s is leaking threads among %d leaking tests.\n' % (
243
192
                TestCase._first_thread_leaker_id,
244
193
                TestCase._leaking_threads_tests))
245
 
            # We don't report the main thread as an active one.
246
 
            self.stream.write(
247
 
                '%d non-main threads were left active in the end.\n'
248
 
                % (TestCase._active_threads - 1))
249
 
 
250
 
    def getDescription(self, test):
251
 
        return test.id()
252
 
 
253
 
    def _extractBenchmarkTime(self, testCase, details=None):
 
194
 
 
195
    def _extractBenchmarkTime(self, testCase):
254
196
        """Add a benchmark time for the current test case."""
255
 
        if details and 'benchtime' in details:
256
 
            return float(''.join(details['benchtime'].iter_bytes()))
257
197
        return getattr(testCase, "_benchtime", None)
258
198
 
259
199
    def _elapsedTestTimeString(self):
293
233
        else:
294
234
            bzr_path = sys.executable
295
235
        self.stream.write(
296
 
            'bzr selftest: %s\n' % (bzr_path,))
 
236
            'testing: %s\n' % (bzr_path,))
297
237
        self.stream.write(
298
238
            '   %s\n' % (
299
239
                    bzrlib.__path__[0],))
322
262
        Called from the TestCase run() method when the test
323
263
        fails with an unexpected error.
324
264
        """
325
 
        self._post_mortem()
326
 
        unittest.TestResult.addError(self, test, err)
327
 
        self.error_count += 1
328
 
        self.report_error(test, err)
329
 
        if self.stop_early:
330
 
            self.stop()
331
 
        self._cleanupLogFile(test)
 
265
        self._testConcluded(test)
 
266
        if isinstance(err[1], TestNotApplicable):
 
267
            return self._addNotApplicable(test, err)
 
268
        elif isinstance(err[1], UnavailableFeature):
 
269
            return self.addNotSupported(test, err[1].args[0])
 
270
        else:
 
271
            unittest.TestResult.addError(self, test, err)
 
272
            self.error_count += 1
 
273
            self.report_error(test, err)
 
274
            if self.stop_early:
 
275
                self.stop()
 
276
            self._cleanupLogFile(test)
332
277
 
333
278
    def addFailure(self, test, err):
334
279
        """Tell result that test failed.
336
281
        Called from the TestCase run() method when the test
337
282
        fails because e.g. an assert() method failed.
338
283
        """
339
 
        self._post_mortem()
340
 
        unittest.TestResult.addFailure(self, test, err)
341
 
        self.failure_count += 1
342
 
        self.report_failure(test, err)
343
 
        if self.stop_early:
344
 
            self.stop()
345
 
        self._cleanupLogFile(test)
 
284
        self._testConcluded(test)
 
285
        if isinstance(err[1], KnownFailure):
 
286
            return self._addKnownFailure(test, err)
 
287
        else:
 
288
            unittest.TestResult.addFailure(self, test, err)
 
289
            self.failure_count += 1
 
290
            self.report_failure(test, err)
 
291
            if self.stop_early:
 
292
                self.stop()
 
293
            self._cleanupLogFile(test)
346
294
 
347
 
    def addSuccess(self, test, details=None):
 
295
    def addSuccess(self, test):
348
296
        """Tell result that test completed successfully.
349
297
 
350
298
        Called from the TestCase run()
351
299
        """
 
300
        self._testConcluded(test)
352
301
        if self._bench_history is not None:
353
 
            benchmark_time = self._extractBenchmarkTime(test, details)
 
302
            benchmark_time = self._extractBenchmarkTime(test)
354
303
            if benchmark_time is not None:
355
304
                self._bench_history.write("%s %s\n" % (
356
305
                    self._formatTime(benchmark_time),
360
309
        unittest.TestResult.addSuccess(self, test)
361
310
        test._log_contents = ''
362
311
 
363
 
    def addExpectedFailure(self, test, err):
 
312
    def _testConcluded(self, test):
 
313
        """Common code when a test has finished.
 
314
 
 
315
        Called regardless of whether it succeded, failed, etc.
 
316
        """
 
317
        pass
 
318
 
 
319
    def _addKnownFailure(self, test, err):
364
320
        self.known_failure_count += 1
365
321
        self.report_known_failure(test, err)
366
322
 
368
324
        """The test will not be run because of a missing feature.
369
325
        """
370
326
        # this can be called in two different ways: it may be that the
371
 
        # test started running, and then raised (through requireFeature)
 
327
        # test started running, and then raised (through addError)
372
328
        # UnavailableFeature.  Alternatively this method can be called
373
 
        # while probing for features before running the test code proper; in
374
 
        # that case we will see startTest and stopTest, but the test will
375
 
        # never actually run.
 
329
        # while probing for features before running the tests; in that
 
330
        # case we will see startTest and stopTest, but the test will never
 
331
        # actually run.
376
332
        self.unsupported.setdefault(str(feature), 0)
377
333
        self.unsupported[str(feature)] += 1
378
334
        self.report_unsupported(test, feature)
382
338
        self.skip_count += 1
383
339
        self.report_skip(test, reason)
384
340
 
385
 
    def addNotApplicable(self, test, reason):
386
 
        self.not_applicable_count += 1
387
 
        self.report_not_applicable(test, reason)
 
341
    def _addNotApplicable(self, test, skip_excinfo):
 
342
        if isinstance(skip_excinfo[1], TestNotApplicable):
 
343
            self.not_applicable_count += 1
 
344
            self.report_not_applicable(test, skip_excinfo)
 
345
        try:
 
346
            test.tearDown()
 
347
        except KeyboardInterrupt:
 
348
            raise
 
349
        except:
 
350
            self.addError(test, test.exc_info())
 
351
        else:
 
352
            # seems best to treat this as success from point-of-view of unittest
 
353
            # -- it actually does nothing so it barely matters :)
 
354
            unittest.TestResult.addSuccess(self, test)
 
355
            test._log_contents = ''
388
356
 
389
 
    def _post_mortem(self):
390
 
        """Start a PDB post mortem session."""
391
 
        if os.environ.get('BZR_TEST_PDB', None):
392
 
            import pdb;pdb.post_mortem()
 
357
    def printErrorList(self, flavour, errors):
 
358
        for test, err in errors:
 
359
            self.stream.writeln(self.separator1)
 
360
            self.stream.write("%s: " % flavour)
 
361
            self.stream.writeln(self.getDescription(test))
 
362
            if getattr(test, '_get_log', None) is not None:
 
363
                log_contents = test._get_log()
 
364
                if log_contents:
 
365
                    self.stream.write('\n')
 
366
                    self.stream.write(
 
367
                            ('vvvv[log from %s]' % test.id()).ljust(78,'-'))
 
368
                    self.stream.write('\n')
 
369
                    self.stream.write(log_contents)
 
370
                    self.stream.write('\n')
 
371
                    self.stream.write(
 
372
                            ('^^^^[log from %s]' % test.id()).ljust(78,'-'))
 
373
                    self.stream.write('\n')
 
374
            self.stream.writeln(self.separator2)
 
375
            self.stream.writeln("%s" % err)
393
376
 
394
377
    def progress(self, offset, whence):
395
378
        """The test is adjusting the count of tests to run."""
400
383
        else:
401
384
            raise errors.BzrError("Unknown whence %r" % whence)
402
385
 
 
386
    def finished(self):
 
387
        pass
 
388
 
403
389
    def report_cleaning_up(self):
404
390
        pass
405
391
 
406
 
    def startTestRun(self):
407
 
        self.startTime = time.time()
408
 
 
409
392
    def report_success(self, test):
410
393
        pass
411
394
 
438
421
        self.pb.update_latency = 0
439
422
        self.pb.show_transport_activity = False
440
423
 
441
 
    def stopTestRun(self):
 
424
    def done(self):
442
425
        # called when the tests that are going to run have run
443
426
        self.pb.clear()
 
427
        super(TextTestResult, self).done()
 
428
 
 
429
    def finished(self):
444
430
        self.pb.finished()
445
 
        super(TextTestResult, self).stopTestRun()
446
431
 
447
 
    def startTestRun(self):
448
 
        super(TextTestResult, self).startTestRun()
 
432
    def report_starting(self):
449
433
        self.pb.update('[test 0/%d] Starting' % (self.num_tests))
450
434
 
451
435
    def printErrors(self):
471
455
            a += '%dm%ds' % (runtime / 60, runtime % 60)
472
456
        else:
473
457
            a += '%ds' % runtime
474
 
        total_fail_count = self.error_count + self.failure_count
475
 
        if total_fail_count:
476
 
            a += ', %d failed' % total_fail_count
477
 
        # if self.unsupported:
478
 
        #     a += ', %d missing' % len(self.unsupported)
 
458
        if self.error_count:
 
459
            a += ', %d err' % self.error_count
 
460
        if self.failure_count:
 
461
            a += ', %d fail' % self.failure_count
 
462
        if self.unsupported:
 
463
            a += ', %d missing' % len(self.unsupported)
479
464
        a += ']'
480
465
        return a
481
466
 
490
475
        return self._shortened_test_description(test)
491
476
 
492
477
    def report_error(self, test, err):
493
 
        self.stream.write('ERROR: %s\n    %s\n' % (
 
478
        self.pb.note('ERROR: %s\n    %s\n',
494
479
            self._test_description(test),
495
480
            err[1],
496
 
            ))
 
481
            )
497
482
 
498
483
    def report_failure(self, test, err):
499
 
        self.stream.write('FAIL: %s\n    %s\n' % (
 
484
        self.pb.note('FAIL: %s\n    %s\n',
500
485
            self._test_description(test),
501
486
            err[1],
502
 
            ))
 
487
            )
503
488
 
504
489
    def report_known_failure(self, test, err):
505
 
        pass
 
490
        self.pb.note('XFAIL: %s\n%s\n',
 
491
            self._test_description(test), err[1])
506
492
 
507
493
    def report_skip(self, test, reason):
508
494
        pass
509
495
 
510
 
    def report_not_applicable(self, test, reason):
 
496
    def report_not_applicable(self, test, skip_excinfo):
511
497
        pass
512
498
 
513
499
    def report_unsupported(self, test, feature):
528
514
            result = a_string
529
515
        return result.ljust(final_width)
530
516
 
531
 
    def startTestRun(self):
532
 
        super(VerboseTestResult, self).startTestRun()
 
517
    def report_starting(self):
533
518
        self.stream.write('running %d tests...\n' % self.num_tests)
534
519
 
535
520
    def report_test_start(self, test):
536
521
        self.count += 1
537
522
        name = self._shortened_test_description(test)
538
 
        width = osutils.terminal_width()
539
 
        if width is not None:
540
 
            # width needs space for 6 char status, plus 1 for slash, plus an
541
 
            # 11-char time string, plus a trailing blank
542
 
            # when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
543
 
            # space
544
 
            self.stream.write(self._ellipsize_to_right(name, width-18))
545
 
        else:
546
 
            self.stream.write(name)
 
523
        # width needs space for 6 char status, plus 1 for slash, plus an
 
524
        # 11-char time string, plus a trailing blank
 
525
        # when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
 
526
        self.stream.write(self._ellipsize_to_right(name,
 
527
                          osutils.terminal_width()-18))
547
528
        self.stream.flush()
548
529
 
549
530
    def _error_summary(self, err):
578
559
        self.stream.writeln(' SKIP %s\n%s'
579
560
                % (self._testTimeString(test), reason))
580
561
 
581
 
    def report_not_applicable(self, test, reason):
582
 
        self.stream.writeln('  N/A %s\n    %s'
583
 
                % (self._testTimeString(test), reason))
 
562
    def report_not_applicable(self, test, skip_excinfo):
 
563
        self.stream.writeln('  N/A %s\n%s'
 
564
                % (self._testTimeString(test),
 
565
                   self._error_summary(skip_excinfo)))
584
566
 
585
567
    def report_unsupported(self, test, feature):
586
568
        """test cannot be run because feature is missing."""
596
578
                 descriptions=0,
597
579
                 verbosity=1,
598
580
                 bench_history=None,
 
581
                 list_only=False,
599
582
                 strict=False,
600
 
                 result_decorators=None,
601
583
                 ):
602
 
        """Create a TextTestRunner.
603
 
 
604
 
        :param result_decorators: An optional list of decorators to apply
605
 
            to the result object being used by the runner. Decorators are
606
 
            applied left to right - the first element in the list is the 
607
 
            innermost decorator.
608
 
        """
609
 
        # stream may know claim to know to write unicode strings, but in older
610
 
        # pythons this goes sufficiently wrong that it is a bad idea. (
611
 
        # specifically a built in file with encoding 'UTF-8' will still try
612
 
        # to encode using ascii.
613
 
        new_encoding = osutils.get_terminal_encoding()
614
 
        codec = codecs.lookup(new_encoding)
615
 
        if type(codec) is tuple:
616
 
            # Python 2.4
617
 
            encode = codec[0]
618
 
        else:
619
 
            encode = codec.encode
620
 
        stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
621
 
        stream.encoding = new_encoding
622
584
        self.stream = unittest._WritelnDecorator(stream)
623
585
        self.descriptions = descriptions
624
586
        self.verbosity = verbosity
625
587
        self._bench_history = bench_history
 
588
        self.list_only = list_only
626
589
        self._strict = strict
627
 
        self._result_decorators = result_decorators or []
628
590
 
629
591
    def run(self, test):
630
592
        "Run the given test case or test suite."
 
593
        startTime = time.time()
631
594
        if self.verbosity == 1:
632
595
            result_class = TextTestResult
633
596
        elif self.verbosity >= 2:
634
597
            result_class = VerboseTestResult
635
 
        original_result = result_class(self.stream,
 
598
        result = result_class(self.stream,
636
599
                              self.descriptions,
637
600
                              self.verbosity,
638
601
                              bench_history=self._bench_history,
639
602
                              strict=self._strict,
640
603
                              )
641
 
        # Signal to result objects that look at stop early policy to stop,
642
 
        original_result.stop_early = self.stop_on_failure
643
 
        result = original_result
644
 
        for decorator in self._result_decorators:
645
 
            result = decorator(result)
646
 
            result.stop_early = self.stop_on_failure
647
 
        result.startTestRun()
648
 
        try:
649
 
            test.run(result)
650
 
        finally:
651
 
            result.stopTestRun()
652
 
        # higher level code uses our extended protocol to determine
653
 
        # what exit code to give.
654
 
        return original_result
 
604
        result.stop_early = self.stop_on_failure
 
605
        result.report_starting()
 
606
        if self.list_only:
 
607
            if self.verbosity >= 2:
 
608
                self.stream.writeln("Listing tests only ...\n")
 
609
            run = 0
 
610
            for t in iter_suite_tests(test):
 
611
                self.stream.writeln("%s" % (t.id()))
 
612
                run += 1
 
613
            return None
 
614
        else:
 
615
            try:
 
616
                import testtools
 
617
            except ImportError:
 
618
                test.run(result)
 
619
            else:
 
620
                if isinstance(test, testtools.ConcurrentTestSuite):
 
621
                    # We need to catch bzr specific behaviors
 
622
                    test.run(BZRTransformingResult(result))
 
623
                else:
 
624
                    test.run(result)
 
625
            run = result.testsRun
 
626
            actionTaken = "Ran"
 
627
        stopTime = time.time()
 
628
        timeTaken = stopTime - startTime
 
629
        result.printErrors()
 
630
        self.stream.writeln(result.separator2)
 
631
        self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
 
632
                            run, run != 1 and "s" or "", timeTaken))
 
633
        self.stream.writeln()
 
634
        if not result.wasSuccessful():
 
635
            self.stream.write("FAILED (")
 
636
            failed, errored = map(len, (result.failures, result.errors))
 
637
            if failed:
 
638
                self.stream.write("failures=%d" % failed)
 
639
            if errored:
 
640
                if failed: self.stream.write(", ")
 
641
                self.stream.write("errors=%d" % errored)
 
642
            if result.known_failure_count:
 
643
                if failed or errored: self.stream.write(", ")
 
644
                self.stream.write("known_failure_count=%d" %
 
645
                    result.known_failure_count)
 
646
            self.stream.writeln(")")
 
647
        else:
 
648
            if result.known_failure_count:
 
649
                self.stream.writeln("OK (known_failures=%d)" %
 
650
                    result.known_failure_count)
 
651
            else:
 
652
                self.stream.writeln("OK")
 
653
        if result.skip_count > 0:
 
654
            skipped = result.skip_count
 
655
            self.stream.writeln('%d test%s skipped' %
 
656
                                (skipped, skipped != 1 and "s" or ""))
 
657
        if result.unsupported:
 
658
            for feature, count in sorted(result.unsupported.items()):
 
659
                self.stream.writeln("Missing feature '%s' skipped %d tests." %
 
660
                    (feature, count))
 
661
        result.finished()
 
662
        return result
655
663
 
656
664
 
657
665
def iter_suite_tests(suite):
667
675
                        % (type(suite), suite))
668
676
 
669
677
 
670
 
TestSkipped = testtools.testcase.TestSkipped
 
678
class TestSkipped(Exception):
 
679
    """Indicates that a test was intentionally skipped, rather than failing."""
671
680
 
672
681
 
673
682
class TestNotApplicable(TestSkipped):
679
688
    """
680
689
 
681
690
 
682
 
# traceback._some_str fails to format exceptions that have the default
683
 
# __str__ which does an implicit ascii conversion. However, repr() on those
684
 
# objects works, for all that its not quite what the doctor may have ordered.
685
 
def _clever_some_str(value):
686
 
    try:
687
 
        return str(value)
688
 
    except:
689
 
        try:
690
 
            return repr(value).replace('\\n', '\n')
691
 
        except:
692
 
            return '<unprintable %s object>' % type(value).__name__
693
 
 
694
 
traceback._some_str = _clever_some_str
695
 
 
696
 
 
697
 
# deprecated - use self.knownFailure(), or self.expectFailure.
698
 
KnownFailure = testtools.testcase._ExpectedFailure
 
691
class KnownFailure(AssertionError):
 
692
    """Indicates that a test failed in a precisely expected manner.
 
693
 
 
694
    Such failures dont block the whole test suite from passing because they are
 
695
    indicators of partially completed code or of future work. We have an
 
696
    explicit error for them so that we can ensure that they are always visible:
 
697
    KnownFailures are always shown in the output of bzr selftest.
 
698
    """
699
699
 
700
700
 
701
701
class UnavailableFeature(Exception):
702
702
    """A feature required for this test was not available.
703
703
 
704
 
    This can be considered a specialised form of SkippedTest.
705
 
 
706
704
    The feature should be used to construct the exception.
707
705
    """
708
706
 
709
707
 
 
708
class CommandFailed(Exception):
 
709
    pass
 
710
 
 
711
 
710
712
class StringIOWrapper(object):
711
713
    """A wrapper around cStringIO which just adds an encoding attribute.
712
714
 
773
775
        return NullProgressView()
774
776
 
775
777
 
776
 
class TestCase(testtools.TestCase):
 
778
class TestCase(unittest.TestCase):
777
779
    """Base class for bzr unit tests.
778
780
 
779
781
    Tests that need access to disk resources should subclass
798
800
    _leaking_threads_tests = 0
799
801
    _first_thread_leaker_id = None
800
802
    _log_file_name = None
 
803
    _log_contents = ''
 
804
    _keep_log_file = False
801
805
    # record lsprof data when performing benchmark calls.
802
806
    _gather_lsprof_in_benchmarks = False
 
807
    attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
 
808
                     '_log_contents', '_log_file_name', '_benchtime',
 
809
                     '_TestCase__testMethodName', '_TestCase__testMethodDoc',)
803
810
 
804
811
    def __init__(self, methodName='testMethod'):
805
812
        super(TestCase, self).__init__(methodName)
806
813
        self._cleanups = []
807
 
        self._directory_isolation = True
808
 
        self.exception_handlers.insert(0,
809
 
            (UnavailableFeature, self._do_unsupported_or_skip))
810
 
        self.exception_handlers.insert(0,
811
 
            (TestNotApplicable, self._do_not_applicable))
 
814
        self._bzr_test_setUp_run = False
 
815
        self._bzr_test_tearDown_run = False
812
816
 
813
817
    def setUp(self):
814
 
        super(TestCase, self).setUp()
815
 
        for feature in getattr(self, '_test_needs_features', []):
816
 
            self.requireFeature(feature)
817
 
        self._log_contents = None
818
 
        self.addDetail("log", content.Content(content.ContentType("text",
819
 
            "plain", {"charset": "utf8"}),
820
 
            lambda:[self._get_log(keep_log_file=True)]))
 
818
        unittest.TestCase.setUp(self)
 
819
        self._bzr_test_setUp_run = True
821
820
        self._cleanEnvironment()
822
821
        self._silenceUI()
823
822
        self._startLogFile()
824
823
        self._benchcalls = []
825
824
        self._benchtime = None
826
825
        self._clear_hooks()
827
 
        self._track_transports()
828
826
        self._track_locks()
829
827
        self._clear_debug_flags()
830
828
        TestCase._active_threads = threading.activeCount()
839
837
        active = threading.activeCount()
840
838
        leaked_threads = active - TestCase._active_threads
841
839
        TestCase._active_threads = active
842
 
        # If some tests make the number of threads *decrease*, we'll consider
843
 
        # that they are just observing old threads dieing, not agressively kill
844
 
        # random threads. So we don't report these tests as leaking. The risk
845
 
        # is that we have false positives that way (the test see 2 threads
846
 
        # going away but leak one) but it seems less likely than the actual
847
 
        # false positives (the test see threads going away and does not leak).
848
 
        if leaked_threads > 0:
 
840
        if leaked_threads:
849
841
            TestCase._leaking_threads_tests += 1
850
842
            if TestCase._first_thread_leaker_id is None:
851
843
                TestCase._first_thread_leaker_id = self.id()
856
848
        Tests that want to use debug flags can just set them in the
857
849
        debug_flags set during setup/teardown.
858
850
        """
859
 
        # Start with a copy of the current debug flags we can safely modify.
860
 
        self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
 
851
        self._preserved_debug_flags = set(debug.debug_flags)
861
852
        if 'allow_debug' not in selftest_debug_flags:
862
853
            debug.debug_flags.clear()
863
854
        if 'disable_lock_checks' not in selftest_debug_flags:
864
855
            debug.debug_flags.add('strict_locks')
 
856
        self.addCleanup(self._restore_debug_flags)
865
857
 
866
858
    def _clear_hooks(self):
867
859
        # prevent hooks affecting tests
877
869
        # this hook should always be installed
878
870
        request._install_hook()
879
871
 
880
 
    def disable_directory_isolation(self):
881
 
        """Turn off directory isolation checks."""
882
 
        self._directory_isolation = False
883
 
 
884
 
    def enable_directory_isolation(self):
885
 
        """Enable directory isolation checks."""
886
 
        self._directory_isolation = True
887
 
 
888
872
    def _silenceUI(self):
889
873
        """Turn off UI for duration of test"""
890
874
        # by default the UI is off; tests can turn it on if they want it.
891
 
        self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
 
875
        saved = ui.ui_factory
 
876
        def _restore():
 
877
            ui.ui_factory = saved
 
878
        ui.ui_factory = ui.SilentUIFactory()
 
879
        self.addCleanup(_restore)
892
880
 
893
881
    def _check_locks(self):
894
882
        """Check that all lock take/release actions have been paired."""
923
911
            self._lock_check_thorough = False
924
912
        else:
925
913
            self._lock_check_thorough = True
926
 
 
 
914
            
927
915
        self.addCleanup(self._check_locks)
928
916
        _mod_lock.Lock.hooks.install_named_hook('lock_acquired',
929
917
                                                self._lock_acquired, None)
941
929
    def _lock_broken(self, result):
942
930
        self._lock_actions.append(('broken', result))
943
931
 
944
 
    def permit_dir(self, name):
945
 
        """Permit a directory to be used by this test. See permit_url."""
946
 
        name_transport = get_transport(name)
947
 
        self.permit_url(name)
948
 
        self.permit_url(name_transport.base)
949
 
 
950
 
    def permit_url(self, url):
951
 
        """Declare that url is an ok url to use in this test.
952
 
        
953
 
        Do this for memory transports, temporary test directory etc.
954
 
        
955
 
        Do not do this for the current working directory, /tmp, or any other
956
 
        preexisting non isolated url.
957
 
        """
958
 
        if not url.endswith('/'):
959
 
            url += '/'
960
 
        self._bzr_selftest_roots.append(url)
961
 
 
962
 
    def permit_source_tree_branch_repo(self):
963
 
        """Permit the source tree bzr is running from to be opened.
964
 
 
965
 
        Some code such as bzrlib.version attempts to read from the bzr branch
966
 
        that bzr is executing from (if any). This method permits that directory
967
 
        to be used in the test suite.
968
 
        """
969
 
        path = self.get_source_path()
970
 
        self.record_directory_isolation()
971
 
        try:
972
 
            try:
973
 
                workingtree.WorkingTree.open(path)
974
 
            except (errors.NotBranchError, errors.NoWorkingTree):
975
 
                return
976
 
        finally:
977
 
            self.enable_directory_isolation()
978
 
 
979
 
    def _preopen_isolate_transport(self, transport):
980
 
        """Check that all transport openings are done in the test work area."""
981
 
        while isinstance(transport, pathfilter.PathFilteringTransport):
982
 
            # Unwrap pathfiltered transports
983
 
            transport = transport.server.backing_transport.clone(
984
 
                transport._filter('.'))
985
 
        url = transport.base
986
 
        # ReadonlySmartTCPServer_for_testing decorates the backing transport
987
 
        # urls it is given by prepending readonly+. This is appropriate as the
988
 
        # client shouldn't know that the server is readonly (or not readonly).
989
 
        # We could register all servers twice, with readonly+ prepending, but
990
 
        # that makes for a long list; this is about the same but easier to
991
 
        # read.
992
 
        if url.startswith('readonly+'):
993
 
            url = url[len('readonly+'):]
994
 
        self._preopen_isolate_url(url)
995
 
 
996
 
    def _preopen_isolate_url(self, url):
997
 
        if not self._directory_isolation:
998
 
            return
999
 
        if self._directory_isolation == 'record':
1000
 
            self._bzr_selftest_roots.append(url)
1001
 
            return
1002
 
        # This prevents all transports, including e.g. sftp ones backed on disk
1003
 
        # from working unless they are explicitly granted permission. We then
1004
 
        # depend on the code that sets up test transports to check that they are
1005
 
        # appropriately isolated and enable their use by calling
1006
 
        # self.permit_transport()
1007
 
        if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1008
 
            raise errors.BzrError("Attempt to escape test isolation: %r %r"
1009
 
                % (url, self._bzr_selftest_roots))
1010
 
 
1011
 
    def record_directory_isolation(self):
1012
 
        """Gather accessed directories to permit later access.
1013
 
        
1014
 
        This is used for tests that access the branch bzr is running from.
1015
 
        """
1016
 
        self._directory_isolation = "record"
1017
 
 
1018
 
    def start_server(self, transport_server, backing_server=None):
1019
 
        """Start transport_server for this test.
1020
 
 
1021
 
        This starts the server, registers a cleanup for it and permits the
1022
 
        server's urls to be used.
1023
 
        """
1024
 
        if backing_server is None:
1025
 
            transport_server.start_server()
1026
 
        else:
1027
 
            transport_server.start_server(backing_server)
1028
 
        self.addCleanup(transport_server.stop_server)
1029
 
        # Obtain a real transport because if the server supplies a password, it
1030
 
        # will be hidden from the base on the client side.
1031
 
        t = get_transport(transport_server.get_url())
1032
 
        # Some transport servers effectively chroot the backing transport;
1033
 
        # others like SFTPServer don't - users of the transport can walk up the
1034
 
        # transport to read the entire backing transport. This wouldn't matter
1035
 
        # except that the workdir tests are given - and that they expect the
1036
 
        # server's url to point at - is one directory under the safety net. So
1037
 
        # Branch operations into the transport will attempt to walk up one
1038
 
        # directory. Chrooting all servers would avoid this but also mean that
1039
 
        # we wouldn't be testing directly against non-root urls. Alternatively
1040
 
        # getting the test framework to start the server with a backing server
1041
 
        # at the actual safety net directory would work too, but this then
1042
 
        # means that the self.get_url/self.get_transport methods would need
1043
 
        # to transform all their results. On balance its cleaner to handle it
1044
 
        # here, and permit a higher url when we have one of these transports.
1045
 
        if t.base.endswith('/work/'):
1046
 
            # we have safety net/test root/work
1047
 
            t = t.clone('../..')
1048
 
        elif isinstance(transport_server,
1049
 
                        test_server.SmartTCPServer_for_testing):
1050
 
            # The smart server adds a path similar to work, which is traversed
1051
 
            # up from by the client. But the server is chrooted - the actual
1052
 
            # backing transport is not escaped from, and VFS requests to the
1053
 
            # root will error (because they try to escape the chroot).
1054
 
            t2 = t.clone('..')
1055
 
            while t2.base != t.base:
1056
 
                t = t2
1057
 
                t2 = t.clone('..')
1058
 
        self.permit_url(t.base)
1059
 
 
1060
 
    def _track_transports(self):
1061
 
        """Install checks for transport usage."""
1062
 
        # TestCase has no safe place it can write to.
1063
 
        self._bzr_selftest_roots = []
1064
 
        # Currently the easiest way to be sure that nothing is going on is to
1065
 
        # hook into bzr dir opening. This leaves a small window of error for
1066
 
        # transport tests, but they are well known, and we can improve on this
1067
 
        # step.
1068
 
        bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1069
 
            self._preopen_isolate_transport, "Check bzr directories are safe.")
1070
 
 
1071
932
    def _ndiff_strings(self, a, b):
1072
933
        """Return ndiff between two strings containing lines.
1073
934
 
1110
971
            return
1111
972
        if message is None:
1112
973
            message = "texts not equal:\n"
 
974
        if a == b + '\n':
 
975
            message = 'first string is missing a final newline.\n'
1113
976
        if a + '\n' == b:
1114
 
            message = 'first string is missing a final newline.\n'
1115
 
        if a == b + '\n':
1116
977
            message = 'second string is missing a final newline.\n'
1117
978
        raise AssertionError(message +
1118
979
                             self._ndiff_strings(a, b))
1129
990
        :raises AssertionError: If the expected and actual stat values differ
1130
991
            other than by atime.
1131
992
        """
1132
 
        self.assertEqual(expected.st_size, actual.st_size,
1133
 
                         'st_size did not match')
1134
 
        self.assertEqual(expected.st_mtime, actual.st_mtime,
1135
 
                         'st_mtime did not match')
1136
 
        self.assertEqual(expected.st_ctime, actual.st_ctime,
1137
 
                         'st_ctime did not match')
1138
 
        if sys.platform != 'win32':
1139
 
            # On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1140
 
            # is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1141
 
            # odd. Regardless we shouldn't actually try to assert anything
1142
 
            # about their values
1143
 
            self.assertEqual(expected.st_dev, actual.st_dev,
1144
 
                             'st_dev did not match')
1145
 
            self.assertEqual(expected.st_ino, actual.st_ino,
1146
 
                             'st_ino did not match')
1147
 
        self.assertEqual(expected.st_mode, actual.st_mode,
1148
 
                         'st_mode did not match')
 
993
        self.assertEqual(expected.st_size, actual.st_size)
 
994
        self.assertEqual(expected.st_mtime, actual.st_mtime)
 
995
        self.assertEqual(expected.st_ctime, actual.st_ctime)
 
996
        self.assertEqual(expected.st_dev, actual.st_dev)
 
997
        self.assertEqual(expected.st_ino, actual.st_ino)
 
998
        self.assertEqual(expected.st_mode, actual.st_mode)
1149
999
 
1150
1000
    def assertLength(self, length, obj_with_len):
1151
1001
        """Assert that obj_with_len is of length length."""
1153
1003
            self.fail("Incorrect length: wanted %d, got %d for %r" % (
1154
1004
                length, len(obj_with_len), obj_with_len))
1155
1005
 
1156
 
    def assertLogsError(self, exception_class, func, *args, **kwargs):
1157
 
        """Assert that func(*args, **kwargs) quietly logs a specific exception.
1158
 
        """
1159
 
        from bzrlib import trace
1160
 
        captured = []
1161
 
        orig_log_exception_quietly = trace.log_exception_quietly
1162
 
        try:
1163
 
            def capture():
1164
 
                orig_log_exception_quietly()
1165
 
                captured.append(sys.exc_info())
1166
 
            trace.log_exception_quietly = capture
1167
 
            func(*args, **kwargs)
1168
 
        finally:
1169
 
            trace.log_exception_quietly = orig_log_exception_quietly
1170
 
        self.assertLength(1, captured)
1171
 
        err = captured[0][1]
1172
 
        self.assertIsInstance(err, exception_class)
1173
 
        return err
1174
 
 
1175
1006
    def assertPositive(self, val):
1176
1007
        """Assert that val is greater than 0."""
1177
1008
        self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1207
1038
            raise AssertionError('pattern "%s" found in "%s"'
1208
1039
                    % (needle_re, haystack))
1209
1040
 
1210
 
    def assertContainsString(self, haystack, needle):
1211
 
        if haystack.find(needle) == -1:
1212
 
            self.fail("string %r not found in '''%s'''" % (needle, haystack))
1213
 
 
1214
1041
    def assertSubset(self, sublist, superlist):
1215
1042
        """Assert that every entry in sublist is present in superlist."""
1216
1043
        missing = set(sublist) - set(superlist)
1303
1130
                m += ": " + msg
1304
1131
            self.fail(m)
1305
1132
 
 
1133
    def expectFailure(self, reason, assertion, *args, **kwargs):
 
1134
        """Invoke a test, expecting it to fail for the given reason.
 
1135
 
 
1136
        This is for assertions that ought to succeed, but currently fail.
 
1137
        (The failure is *expected* but not *wanted*.)  Please be very precise
 
1138
        about the failure you're expecting.  If a new bug is introduced,
 
1139
        AssertionError should be raised, not KnownFailure.
 
1140
 
 
1141
        Frequently, expectFailure should be followed by an opposite assertion.
 
1142
        See example below.
 
1143
 
 
1144
        Intended to be used with a callable that raises AssertionError as the
 
1145
        'assertion' parameter.  args and kwargs are passed to the 'assertion'.
 
1146
 
 
1147
        Raises KnownFailure if the test fails.  Raises AssertionError if the
 
1148
        test succeeds.
 
1149
 
 
1150
        example usage::
 
1151
 
 
1152
          self.expectFailure('Math is broken', self.assertNotEqual, 54,
 
1153
                             dynamic_val)
 
1154
          self.assertEqual(42, dynamic_val)
 
1155
 
 
1156
          This means that a dynamic_val of 54 will cause the test to raise
 
1157
          a KnownFailure.  Once math is fixed and the expectFailure is removed,
 
1158
          only a dynamic_val of 42 will allow the test to pass.  Anything other
 
1159
          than 54 or 42 will cause an AssertionError.
 
1160
        """
 
1161
        try:
 
1162
            assertion(*args, **kwargs)
 
1163
        except AssertionError:
 
1164
            raise KnownFailure(reason)
 
1165
        else:
 
1166
            self.fail('Unexpected success.  Should have failed: %s' % reason)
 
1167
 
1306
1168
    def assertFileEqual(self, content, path):
1307
1169
        """Fail if path does not contain 'content'."""
1308
1170
        self.failUnlessExists(path)
1313
1175
            f.close()
1314
1176
        self.assertEqualDiff(content, s)
1315
1177
 
1316
 
    def assertDocstring(self, expected_docstring, obj):
1317
 
        """Fail if obj does not have expected_docstring"""
1318
 
        if __doc__ is None:
1319
 
            # With -OO the docstring should be None instead
1320
 
            self.assertIs(obj.__doc__, None)
1321
 
        else:
1322
 
            self.assertEqual(expected_docstring, obj.__doc__)
1323
 
 
1324
1178
    def failUnlessExists(self, path):
1325
1179
        """Fail unless path or paths, which may be abs or relative, exist."""
1326
1180
        if not isinstance(path, basestring):
1466
1320
 
1467
1321
        Close the file and delete it, unless setKeepLogfile was called.
1468
1322
        """
1469
 
        if bzrlib.trace._trace_file:
1470
 
            # flush the log file, to get all content
1471
 
            bzrlib.trace._trace_file.flush()
 
1323
        if self._log_file is None:
 
1324
            return
1472
1325
        bzrlib.trace.pop_log_file(self._log_memento)
1473
 
        # Cache the log result and delete the file on disk
1474
 
        self._get_log(False)
 
1326
        self._log_file.close()
 
1327
        self._log_file = None
 
1328
        if not self._keep_log_file:
 
1329
            os.remove(self._log_file_name)
 
1330
            self._log_file_name = None
 
1331
 
 
1332
    def setKeepLogfile(self):
 
1333
        """Make the logfile not be deleted when _finishLogFile is called."""
 
1334
        self._keep_log_file = True
1475
1335
 
1476
1336
    def thisFailsStrictLockCheck(self):
1477
1337
        """It is known that this test would fail with -Dstrict_locks.
1494
1354
        """
1495
1355
        self._cleanups.append((callable, args, kwargs))
1496
1356
 
1497
 
    def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1498
 
        """Overrides an object attribute restoring it after the test.
1499
 
 
1500
 
        :param obj: The object that will be mutated.
1501
 
 
1502
 
        :param attr_name: The attribute name we want to preserve/override in
1503
 
            the object.
1504
 
 
1505
 
        :param new: The optional value we want to set the attribute to.
1506
 
 
1507
 
        :returns: The actual attr value.
1508
 
        """
1509
 
        value = getattr(obj, attr_name)
1510
 
        # The actual value is captured by the call below
1511
 
        self.addCleanup(setattr, obj, attr_name, value)
1512
 
        if new is not _unitialized_attr:
1513
 
            setattr(obj, attr_name, new)
1514
 
        return value
1515
 
 
1516
1357
    def _cleanEnvironment(self):
1517
1358
        new_env = {
1518
1359
            'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1528
1369
            'BZR_PROGRESS_BAR': None,
1529
1370
            'BZR_LOG': None,
1530
1371
            'BZR_PLUGIN_PATH': None,
1531
 
            'BZR_DISABLE_PLUGINS': None,
1532
 
            'BZR_PLUGINS_AT': None,
1533
 
            'BZR_CONCURRENCY': None,
1534
1372
            # Make sure that any text ui tests are consistent regardless of
1535
1373
            # the environment the test case is run in; you may want tests that
1536
1374
            # test other combinations.  'dumb' is a reasonable guess for tests
1538
1376
            'TERM': 'dumb',
1539
1377
            'LINES': '25',
1540
1378
            'COLUMNS': '80',
1541
 
            'BZR_COLUMNS': '80',
1542
1379
            # SSH Agent
1543
1380
            'SSH_AUTH_SOCK': None,
1544
1381
            # Proxies
1556
1393
            'ftp_proxy': None,
1557
1394
            'FTP_PROXY': None,
1558
1395
            'BZR_REMOTE_PATH': None,
1559
 
            # Generally speaking, we don't want apport reporting on crashes in
1560
 
            # the test envirnoment unless we're specifically testing apport,
1561
 
            # so that it doesn't leak into the real system environment.  We
1562
 
            # use an env var so it propagates to subprocesses.
1563
 
            'APPORT_DISABLE': '1',
1564
1396
        }
1565
 
        self._old_env = {}
 
1397
        self.__old_env = {}
1566
1398
        self.addCleanup(self._restoreEnvironment)
1567
1399
        for name, value in new_env.iteritems():
1568
1400
            self._captureVar(name, value)
1569
1401
 
1570
1402
    def _captureVar(self, name, newvalue):
1571
1403
        """Set an environment variable, and reset it when finished."""
1572
 
        self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1404
        self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1405
 
 
1406
    def _restore_debug_flags(self):
 
1407
        debug.debug_flags.clear()
 
1408
        debug.debug_flags.update(self._preserved_debug_flags)
1573
1409
 
1574
1410
    def _restoreEnvironment(self):
1575
 
        for name, value in self._old_env.iteritems():
 
1411
        for name, value in self.__old_env.iteritems():
1576
1412
            osutils.set_or_unset_env(name, value)
1577
1413
 
1578
1414
    def _restoreHooks(self):
1586
1422
    def _do_skip(self, result, reason):
1587
1423
        addSkip = getattr(result, 'addSkip', None)
1588
1424
        if not callable(addSkip):
1589
 
            result.addSuccess(result)
 
1425
            result.addError(self, sys.exc_info())
1590
1426
        else:
1591
1427
            addSkip(self, reason)
1592
1428
 
1593
 
    @staticmethod
1594
 
    def _do_known_failure(self, result, e):
1595
 
        err = sys.exc_info()
1596
 
        addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1597
 
        if addExpectedFailure is not None:
1598
 
            addExpectedFailure(self, err)
1599
 
        else:
1600
 
            result.addSuccess(self)
1601
 
 
1602
 
    @staticmethod
1603
 
    def _do_not_applicable(self, result, e):
1604
 
        if not e.args:
1605
 
            reason = 'No reason given'
1606
 
        else:
1607
 
            reason = e.args[0]
1608
 
        addNotApplicable = getattr(result, 'addNotApplicable', None)
1609
 
        if addNotApplicable is not None:
1610
 
            result.addNotApplicable(self, reason)
1611
 
        else:
1612
 
            self._do_skip(result, reason)
1613
 
 
1614
 
    @staticmethod
1615
 
    def _do_unsupported_or_skip(self, result, e):
1616
 
        reason = e.args[0]
1617
 
        addNotSupported = getattr(result, 'addNotSupported', None)
1618
 
        if addNotSupported is not None:
1619
 
            result.addNotSupported(self, reason)
1620
 
        else:
1621
 
            self._do_skip(result, reason)
 
1429
    def run(self, result=None):
 
1430
        if result is None: result = self.defaultTestResult()
 
1431
        for feature in getattr(self, '_test_needs_features', []):
 
1432
            if not feature.available():
 
1433
                result.startTest(self)
 
1434
                if getattr(result, 'addNotSupported', None):
 
1435
                    result.addNotSupported(self, feature)
 
1436
                else:
 
1437
                    result.addSuccess(self)
 
1438
                result.stopTest(self)
 
1439
                return result
 
1440
        try:
 
1441
            try:
 
1442
                result.startTest(self)
 
1443
                absent_attr = object()
 
1444
                # Python 2.5
 
1445
                method_name = getattr(self, '_testMethodName', absent_attr)
 
1446
                if method_name is absent_attr:
 
1447
                    # Python 2.4
 
1448
                    method_name = getattr(self, '_TestCase__testMethodName')
 
1449
                testMethod = getattr(self, method_name)
 
1450
                try:
 
1451
                    try:
 
1452
                        self.setUp()
 
1453
                        if not self._bzr_test_setUp_run:
 
1454
                            self.fail(
 
1455
                                "test setUp did not invoke "
 
1456
                                "bzrlib.tests.TestCase's setUp")
 
1457
                    except KeyboardInterrupt:
 
1458
                        self._runCleanups()
 
1459
                        raise
 
1460
                    except TestSkipped, e:
 
1461
                        self._do_skip(result, e.args[0])
 
1462
                        self.tearDown()
 
1463
                        return result
 
1464
                    except:
 
1465
                        result.addError(self, sys.exc_info())
 
1466
                        self._runCleanups()
 
1467
                        return result
 
1468
 
 
1469
                    ok = False
 
1470
                    try:
 
1471
                        testMethod()
 
1472
                        ok = True
 
1473
                    except self.failureException:
 
1474
                        result.addFailure(self, sys.exc_info())
 
1475
                    except TestSkipped, e:
 
1476
                        if not e.args:
 
1477
                            reason = "No reason given."
 
1478
                        else:
 
1479
                            reason = e.args[0]
 
1480
                        self._do_skip(result, reason)
 
1481
                    except KeyboardInterrupt:
 
1482
                        self._runCleanups()
 
1483
                        raise
 
1484
                    except:
 
1485
                        result.addError(self, sys.exc_info())
 
1486
 
 
1487
                    try:
 
1488
                        self.tearDown()
 
1489
                        if not self._bzr_test_tearDown_run:
 
1490
                            self.fail(
 
1491
                                "test tearDown did not invoke "
 
1492
                                "bzrlib.tests.TestCase's tearDown")
 
1493
                    except KeyboardInterrupt:
 
1494
                        self._runCleanups()
 
1495
                        raise
 
1496
                    except:
 
1497
                        result.addError(self, sys.exc_info())
 
1498
                        self._runCleanups()
 
1499
                        ok = False
 
1500
                    if ok: result.addSuccess(self)
 
1501
                finally:
 
1502
                    result.stopTest(self)
 
1503
                return result
 
1504
            except TestNotApplicable:
 
1505
                # Not moved from the result [yet].
 
1506
                self._runCleanups()
 
1507
                raise
 
1508
            except KeyboardInterrupt:
 
1509
                self._runCleanups()
 
1510
                raise
 
1511
        finally:
 
1512
            saved_attrs = {}
 
1513
            for attr_name in self.attrs_to_keep:
 
1514
                if attr_name in self.__dict__:
 
1515
                    saved_attrs[attr_name] = self.__dict__[attr_name]
 
1516
            self.__dict__ = saved_attrs
 
1517
 
 
1518
    def tearDown(self):
 
1519
        self._runCleanups()
 
1520
        self._log_contents = ''
 
1521
        self._bzr_test_tearDown_run = True
 
1522
        unittest.TestCase.tearDown(self)
1622
1523
 
1623
1524
    def time(self, callable, *args, **kwargs):
1624
1525
        """Run callable and accrue the time it takes to the benchmark time.
1628
1529
        self._benchcalls.
1629
1530
        """
1630
1531
        if self._benchtime is None:
1631
 
            self.addDetail('benchtime', content.Content(content.ContentType(
1632
 
                "text", "plain"), lambda:[str(self._benchtime)]))
1633
1532
            self._benchtime = 0
1634
1533
        start = time.time()
1635
1534
        try:
1644
1543
        finally:
1645
1544
            self._benchtime += time.time() - start
1646
1545
 
 
1546
    def _runCleanups(self):
 
1547
        """Run registered cleanup functions.
 
1548
 
 
1549
        This should only be called from TestCase.tearDown.
 
1550
        """
 
1551
        # TODO: Perhaps this should keep running cleanups even if
 
1552
        # one of them fails?
 
1553
 
 
1554
        # Actually pop the cleanups from the list so tearDown running
 
1555
        # twice is safe (this happens for skipped tests).
 
1556
        while self._cleanups:
 
1557
            cleanup, args, kwargs = self._cleanups.pop()
 
1558
            cleanup(*args, **kwargs)
 
1559
 
1647
1560
    def log(self, *args):
1648
1561
        mutter(*args)
1649
1562
 
1650
1563
    def _get_log(self, keep_log_file=False):
1651
 
        """Internal helper to get the log from bzrlib.trace for this test.
1652
 
 
1653
 
        Please use self.getDetails, or self.get_log to access this in test case
1654
 
        code.
 
1564
        """Get the log from bzrlib.trace calls from this test.
1655
1565
 
1656
1566
        :param keep_log_file: When True, if the log is still a file on disk
1657
1567
            leave it as a file on disk. When False, if the log is still a file
1659
1569
            self._log_contents.
1660
1570
        :return: A string containing the log.
1661
1571
        """
1662
 
        if self._log_contents is not None:
1663
 
            try:
1664
 
                self._log_contents.decode('utf8')
1665
 
            except UnicodeDecodeError:
1666
 
                unicodestr = self._log_contents.decode('utf8', 'replace')
1667
 
                self._log_contents = unicodestr.encode('utf8')
 
1572
        # flush the log file, to get all content
 
1573
        import bzrlib.trace
 
1574
        if bzrlib.trace._trace_file:
 
1575
            bzrlib.trace._trace_file.flush()
 
1576
        if self._log_contents:
 
1577
            # XXX: this can hardly contain the content flushed above --vila
 
1578
            # 20080128
1668
1579
            return self._log_contents
1669
 
        import bzrlib.trace
1670
 
        if bzrlib.trace._trace_file:
1671
 
            # flush the log file, to get all content
1672
 
            bzrlib.trace._trace_file.flush()
1673
1580
        if self._log_file_name is not None:
1674
1581
            logfile = open(self._log_file_name)
1675
1582
            try:
1676
1583
                log_contents = logfile.read()
1677
1584
            finally:
1678
1585
                logfile.close()
1679
 
            try:
1680
 
                log_contents.decode('utf8')
1681
 
            except UnicodeDecodeError:
1682
 
                unicodestr = log_contents.decode('utf8', 'replace')
1683
 
                log_contents = unicodestr.encode('utf8')
1684
1586
            if not keep_log_file:
1685
 
                close_attempts = 0
1686
 
                max_close_attempts = 100
1687
 
                first_close_error = None
1688
 
                while close_attempts < max_close_attempts:
1689
 
                    close_attempts += 1
1690
 
                    try:
1691
 
                        self._log_file.close()
1692
 
                    except IOError, ioe:
1693
 
                        if ioe.errno is None:
1694
 
                            # No errno implies 'close() called during
1695
 
                            # concurrent operation on the same file object', so
1696
 
                            # retry.  Probably a thread is trying to write to
1697
 
                            # the log file.
1698
 
                            if first_close_error is None:
1699
 
                                first_close_error = ioe
1700
 
                            continue
1701
 
                        raise
1702
 
                    else:
1703
 
                        break
1704
 
                if close_attempts > 1:
1705
 
                    sys.stderr.write(
1706
 
                        'Unable to close log file on first attempt, '
1707
 
                        'will retry: %s\n' % (first_close_error,))
1708
 
                    if close_attempts == max_close_attempts:
1709
 
                        sys.stderr.write(
1710
 
                            'Unable to close log file after %d attempts.\n'
1711
 
                            % (max_close_attempts,))
1712
 
                self._log_file = None
1713
 
                # Permit multiple calls to get_log until we clean it up in
1714
 
                # finishLogFile
1715
1587
                self._log_contents = log_contents
1716
1588
                try:
1717
1589
                    os.remove(self._log_file_name)
1721
1593
                                             ' %r\n' % self._log_file_name))
1722
1594
                    else:
1723
1595
                        raise
1724
 
                self._log_file_name = None
1725
1596
            return log_contents
1726
1597
        else:
1727
 
            return "No log file content and no log file name."
1728
 
 
1729
 
    def get_log(self):
1730
 
        """Get a unicode string containing the log from bzrlib.trace.
1731
 
 
1732
 
        Undecodable characters are replaced.
1733
 
        """
1734
 
        return u"".join(self.getDetails()['log'].iter_text())
 
1598
            return "DELETED log file to reduce memory footprint"
1735
1599
 
1736
1600
    def requireFeature(self, feature):
1737
1601
        """This test requires a specific feature is available.
1779
1643
            os.chdir(working_dir)
1780
1644
 
1781
1645
        try:
1782
 
            try:
1783
 
                result = self.apply_redirected(ui.ui_factory.stdin,
1784
 
                    stdout, stderr,
1785
 
                    bzrlib.commands.run_bzr_catch_user_errors,
1786
 
                    args)
1787
 
            except KeyboardInterrupt:
1788
 
                # Reraise KeyboardInterrupt with contents of redirected stdout
1789
 
                # and stderr as arguments, for tests which are interested in
1790
 
                # stdout and stderr and are expecting the exception.
1791
 
                out = stdout.getvalue()
1792
 
                err = stderr.getvalue()
1793
 
                if out:
1794
 
                    self.log('output:\n%r', out)
1795
 
                if err:
1796
 
                    self.log('errors:\n%r', err)
1797
 
                raise KeyboardInterrupt(out, err)
 
1646
            result = self.apply_redirected(ui.ui_factory.stdin,
 
1647
                stdout, stderr,
 
1648
                bzrlib.commands.run_bzr_catch_user_errors,
 
1649
                args)
1798
1650
        finally:
1799
1651
            logger.removeHandler(handler)
1800
1652
            ui.ui_factory = old_ui_factory
1810
1662
        if retcode is not None:
1811
1663
            self.assertEquals(retcode, result,
1812
1664
                              message='Unexpected return code')
1813
 
        return result, out, err
 
1665
        return out, err
1814
1666
 
1815
1667
    def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1816
1668
                working_dir=None, error_regexes=[], output_encoding=None):
1845
1697
        :keyword error_regexes: A list of expected error messages.  If
1846
1698
            specified they must be seen in the error output of the command.
1847
1699
        """
1848
 
        retcode, out, err = self._run_bzr_autosplit(
 
1700
        out, err = self._run_bzr_autosplit(
1849
1701
            args=args,
1850
1702
            retcode=retcode,
1851
1703
            encoding=encoding,
2002
1854
        """
2003
1855
        return Popen(*args, **kwargs)
2004
1856
 
2005
 
    def get_source_path(self):
2006
 
        """Return the path of the directory containing bzrlib."""
2007
 
        return os.path.dirname(os.path.dirname(bzrlib.__file__))
2008
 
 
2009
1857
    def get_bzr_path(self):
2010
1858
        """Return the path of the 'bzr' executable for this test suite."""
2011
 
        bzr_path = self.get_source_path()+'/bzr'
 
1859
        bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
2012
1860
        if not os.path.isfile(bzr_path):
2013
1861
            # We are probably installed. Assume sys.argv is the right file
2014
1862
            bzr_path = sys.argv[0]
2100
1948
 
2101
1949
        Tests that expect to provoke LockContention errors should call this.
2102
1950
        """
2103
 
        self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
 
1951
        orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
 
1952
        def resetTimeout():
 
1953
            bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
 
1954
        self.addCleanup(resetTimeout)
 
1955
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2104
1956
 
2105
1957
    def make_utf8_encoded_stringio(self, encoding_type=None):
2106
1958
        """Return a StringIOWrapper instance, that will encode Unicode
2120
1972
        request_handlers = request.request_handlers
2121
1973
        orig_method = request_handlers.get(verb)
2122
1974
        request_handlers.remove(verb)
2123
 
        self.addCleanup(request_handlers.register, verb, orig_method)
 
1975
        def restoreVerb():
 
1976
            request_handlers.register(verb, orig_method)
 
1977
        self.addCleanup(restoreVerb)
2124
1978
 
2125
1979
 
2126
1980
class CapturedCall(object):
2217
2071
        if self.__readonly_server is None:
2218
2072
            if self.transport_readonly_server is None:
2219
2073
                # readonly decorator requested
2220
 
                self.__readonly_server = test_server.ReadonlyServer()
 
2074
                # bring up the server
 
2075
                self.__readonly_server = ReadonlyServer()
 
2076
                self.__readonly_server.setUp(self.get_vfs_only_server())
2221
2077
            else:
2222
 
                # explicit readonly transport.
2223
2078
                self.__readonly_server = self.create_transport_readonly_server()
2224
 
            self.start_server(self.__readonly_server,
2225
 
                self.get_vfs_only_server())
 
2079
                self.__readonly_server.setUp(self.get_vfs_only_server())
 
2080
            self.addCleanup(self.__readonly_server.tearDown)
2226
2081
        return self.__readonly_server
2227
2082
 
2228
2083
    def get_readonly_url(self, relpath=None):
2246
2101
        is no means to override it.
2247
2102
        """
2248
2103
        if self.__vfs_server is None:
2249
 
            self.__vfs_server = memory.MemoryServer()
2250
 
            self.start_server(self.__vfs_server)
 
2104
            self.__vfs_server = MemoryServer()
 
2105
            self.__vfs_server.setUp()
 
2106
            self.addCleanup(self.__vfs_server.tearDown)
2251
2107
        return self.__vfs_server
2252
2108
 
2253
2109
    def get_server(self):
2260
2116
        then the self.get_vfs_server is returned.
2261
2117
        """
2262
2118
        if self.__server is None:
2263
 
            if (self.transport_server is None or self.transport_server is
2264
 
                self.vfs_transport_factory):
2265
 
                self.__server = self.get_vfs_only_server()
 
2119
            if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
 
2120
                return self.get_vfs_only_server()
2266
2121
            else:
2267
2122
                # bring up a decorated means of access to the vfs only server.
2268
2123
                self.__server = self.transport_server()
2269
 
                self.start_server(self.__server, self.get_vfs_only_server())
 
2124
                try:
 
2125
                    self.__server.setUp(self.get_vfs_only_server())
 
2126
                except TypeError, e:
 
2127
                    # This should never happen; the try:Except here is to assist
 
2128
                    # developers having to update code rather than seeing an
 
2129
                    # uninformative TypeError.
 
2130
                    raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
 
2131
            self.addCleanup(self.__server.tearDown)
2270
2132
        return self.__server
2271
2133
 
2272
2134
    def _adjust_url(self, base, relpath):
2334
2196
        propagating. This method ensures than a test did not leaked.
2335
2197
        """
2336
2198
        root = TestCaseWithMemoryTransport.TEST_ROOT
2337
 
        self.permit_url(get_transport(root).base)
2338
2199
        wt = workingtree.WorkingTree.open(root)
2339
2200
        last_rev = wt.last_revision()
2340
2201
        if last_rev != 'null:':
2342
2203
            # recreate a new one or all the followng tests will fail.
2343
2204
            # If you need to inspect its content uncomment the following line
2344
2205
            # import pdb; pdb.set_trace()
2345
 
            _rmtree_temp_dir(root + '/.bzr', test_id=self.id())
 
2206
            _rmtree_temp_dir(root + '/.bzr')
2346
2207
            self._create_safety_net()
2347
2208
            raise AssertionError('%s/.bzr should not be modified' % root)
2348
2209
 
2349
2210
    def _make_test_root(self):
2350
2211
        if TestCaseWithMemoryTransport.TEST_ROOT is None:
2351
 
            # Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2352
 
            root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2353
 
                                                    suffix='.tmp'))
 
2212
            root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2354
2213
            TestCaseWithMemoryTransport.TEST_ROOT = root
2355
2214
 
2356
2215
            self._create_safety_net()
2359
2218
            # specifically told when all tests are finished.  This will do.
2360
2219
            atexit.register(_rmtree_temp_dir, root)
2361
2220
 
2362
 
        self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2363
2221
        self.addCleanup(self._check_safety_net)
2364
2222
 
2365
2223
    def makeAndChdirToTestDir(self):
2373
2231
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2374
2232
        self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2375
2233
        self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2376
 
        self.permit_dir(self.test_dir)
2377
2234
 
2378
2235
    def make_branch(self, relpath, format=None):
2379
2236
        """Create a branch on the transport at relpath."""
2409
2266
        return made_control.create_repository(shared=shared)
2410
2267
 
2411
2268
    def make_smart_server(self, path):
2412
 
        smart_server = test_server.SmartTCPServer_for_testing()
2413
 
        self.start_server(smart_server, self.get_server())
 
2269
        smart_server = server.SmartTCPServer_for_testing()
 
2270
        smart_server.setUp(self.get_server())
2414
2271
        remote_transport = get_transport(smart_server.get_url()).clone(path)
 
2272
        self.addCleanup(smart_server.tearDown)
2415
2273
        return remote_transport
2416
2274
 
2417
2275
    def make_branch_and_memory_tree(self, relpath, format=None):
2424
2282
        return branchbuilder.BranchBuilder(branch=branch)
2425
2283
 
2426
2284
    def overrideEnvironmentForTesting(self):
2427
 
        test_home_dir = self.test_home_dir
2428
 
        if isinstance(test_home_dir, unicode):
2429
 
            test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2430
 
        os.environ['HOME'] = test_home_dir
2431
 
        os.environ['BZR_HOME'] = test_home_dir
 
2285
        os.environ['HOME'] = self.test_home_dir
 
2286
        os.environ['BZR_HOME'] = self.test_home_dir
2432
2287
 
2433
2288
    def setUp(self):
2434
2289
        super(TestCaseWithMemoryTransport, self).setUp()
2435
2290
        self._make_test_root()
2436
 
        self.addCleanup(os.chdir, os.getcwdu())
 
2291
        _currentdir = os.getcwdu()
 
2292
        def _leaveDirectory():
 
2293
            os.chdir(_currentdir)
 
2294
        self.addCleanup(_leaveDirectory)
2437
2295
        self.makeAndChdirToTestDir()
2438
2296
        self.overrideEnvironmentForTesting()
2439
2297
        self.__readonly_server = None
2442
2300
 
2443
2301
    def setup_smart_server_with_call_log(self):
2444
2302
        """Sets up a smart server as the transport server with a call log."""
2445
 
        self.transport_server = test_server.SmartTCPServer_for_testing
 
2303
        self.transport_server = server.SmartTCPServer_for_testing
2446
2304
        self.hpss_calls = []
2447
2305
        import traceback
2448
2306
        # Skip the current stack down to the caller of
2511
2369
            if os.path.exists(name):
2512
2370
                name = name_prefix + '_' + str(i)
2513
2371
            else:
2514
 
                # now create test and home directories within this dir
2515
 
                self.test_base_dir = name
2516
 
                self.addCleanup(self.deleteTestDir)
2517
 
                os.mkdir(self.test_base_dir)
 
2372
                os.mkdir(name)
2518
2373
                break
2519
 
        self.permit_dir(self.test_base_dir)
2520
 
        # 'sprouting' and 'init' of a branch both walk up the tree to find
2521
 
        # stacking policy to honour; create a bzr dir with an unshared
2522
 
        # repository (but not a branch - our code would be trying to escape
2523
 
        # then!) to stop them, and permit it to be read.
2524
 
        # control = bzrdir.BzrDir.create(self.test_base_dir)
2525
 
        # control.create_repository()
 
2374
        # now create test and home directories within this dir
 
2375
        self.test_base_dir = name
2526
2376
        self.test_home_dir = self.test_base_dir + '/home'
2527
2377
        os.mkdir(self.test_home_dir)
2528
2378
        self.test_dir = self.test_base_dir + '/work'
2534
2384
            f.write(self.id())
2535
2385
        finally:
2536
2386
            f.close()
 
2387
        self.addCleanup(self.deleteTestDir)
2537
2388
 
2538
2389
    def deleteTestDir(self):
2539
2390
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2540
 
        _rmtree_temp_dir(self.test_base_dir, test_id=self.id())
 
2391
        _rmtree_temp_dir(self.test_base_dir)
2541
2392
 
2542
2393
    def build_tree(self, shape, line_endings='binary', transport=None):
2543
2394
        """Build a test tree according to a pattern.
2625
2476
        """
2626
2477
        if self.__vfs_server is None:
2627
2478
            self.__vfs_server = self.vfs_transport_factory()
2628
 
            self.start_server(self.__vfs_server)
 
2479
            self.__vfs_server.setUp()
 
2480
            self.addCleanup(self.__vfs_server.tearDown)
2629
2481
        return self.__vfs_server
2630
2482
 
2631
2483
    def make_branch_and_tree(self, relpath, format=None):
2638
2490
        repository will also be accessed locally. Otherwise a lightweight
2639
2491
        checkout is created and returned.
2640
2492
 
2641
 
        We do this because we can't physically create a tree in the local
2642
 
        path, with a branch reference to the transport_factory url, and
2643
 
        a branch + repository in the vfs_transport, unless the vfs_transport
2644
 
        namespace is distinct from the local disk - the two branch objects
2645
 
        would collide. While we could construct a tree with its branch object
2646
 
        pointing at the transport_factory transport in memory, reopening it
2647
 
        would behaving unexpectedly, and has in the past caused testing bugs
2648
 
        when we tried to do it that way.
2649
 
 
2650
2493
        :param format: The BzrDirFormat.
2651
2494
        :returns: the WorkingTree.
2652
2495
        """
2661
2504
            # We can only make working trees locally at the moment.  If the
2662
2505
            # transport can't support them, then we keep the non-disk-backed
2663
2506
            # branch and create a local checkout.
2664
 
            if self.vfs_transport_factory is test_server.LocalURLServer:
 
2507
            if self.vfs_transport_factory is LocalURLServer:
2665
2508
                # the branch is colocated on disk, we cannot create a checkout.
2666
2509
                # hopefully callers will expect this.
2667
2510
                local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2704
2547
        super(TestCaseWithTransport, self).setUp()
2705
2548
        self.__vfs_server = None
2706
2549
 
2707
 
    def disable_missing_extensions_warning(self):
2708
 
        """Some tests expect a precise stderr content.
2709
 
 
2710
 
        There is no point in forcing them to duplicate the extension related
2711
 
        warning.
2712
 
        """
2713
 
        config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2714
 
 
2715
2550
 
2716
2551
class ChrootedTestCase(TestCaseWithTransport):
2717
2552
    """A support class that provides readonly urls outside the local namespace.
2727
2562
 
2728
2563
    def setUp(self):
2729
2564
        super(ChrootedTestCase, self).setUp()
2730
 
        if not self.vfs_transport_factory == memory.MemoryServer:
 
2565
        if not self.vfs_transport_factory == MemoryServer:
2731
2566
            self.transport_readonly_server = HttpServer
2732
2567
 
2733
2568
 
2931
2766
              strict=False,
2932
2767
              runner_class=None,
2933
2768
              suite_decorators=None,
2934
 
              stream=None,
2935
 
              result_decorators=None,
2936
 
              ):
 
2769
              stream=None):
2937
2770
    """Run a test suite for bzr selftest.
2938
2771
 
2939
2772
    :param runner_class: The class of runner to use. Must support the
2954
2787
                            descriptions=0,
2955
2788
                            verbosity=verbosity,
2956
2789
                            bench_history=bench_history,
 
2790
                            list_only=list_only,
2957
2791
                            strict=strict,
2958
 
                            result_decorators=result_decorators,
2959
2792
                            )
2960
2793
    runner.stop_on_failure=stop_on_failure
2961
2794
    # built in decorator factories:
2976
2809
        decorators.append(CountingDecorator)
2977
2810
    for decorator in decorators:
2978
2811
        suite = decorator(suite)
 
2812
    result = runner.run(suite)
2979
2813
    if list_only:
2980
 
        # Done after test suite decoration to allow randomisation etc
2981
 
        # to take effect, though that is of marginal benefit.
2982
 
        if verbosity >= 2:
2983
 
            stream.write("Listing tests only ...\n")
2984
 
        for t in iter_suite_tests(suite):
2985
 
            stream.write("%s\n" % (t.id()))
2986
2814
        return True
2987
 
    result = runner.run(suite)
 
2815
    result.done()
2988
2816
    if strict:
2989
2817
        return result.wasStrictlySuccessful()
2990
2818
    else:
3147
2975
        if self.randomised:
3148
2976
            return iter(self._tests)
3149
2977
        self.randomised = True
3150
 
        self.stream.write("Randomizing test order using seed %s\n\n" %
 
2978
        self.stream.writeln("Randomizing test order using seed %s\n" %
3151
2979
            (self.actual_seed()))
3152
2980
        # Initialise the random number generator.
3153
2981
        random.seed(self.actual_seed())
3201
3029
    return result
3202
3030
 
3203
3031
 
3204
 
def workaround_zealous_crypto_random():
3205
 
    """Crypto.Random want to help us being secure, but we don't care here.
3206
 
 
3207
 
    This workaround some test failure related to the sftp server. Once paramiko
3208
 
    stop using the controversial API in Crypto.Random, we may get rid of it.
3209
 
    """
3210
 
    try:
3211
 
        from Crypto.Random import atfork
3212
 
        atfork()
3213
 
    except ImportError:
3214
 
        pass
3215
 
 
3216
 
 
3217
3032
def fork_for_tests(suite):
3218
3033
    """Take suite and start up one runner per CPU by forking()
3219
3034
 
3223
3038
    concurrency = osutils.local_concurrency()
3224
3039
    result = []
3225
3040
    from subunit import TestProtocolClient, ProtocolTestCase
3226
 
    from subunit.test_results import AutoTimingTestResultDecorator
 
3041
    try:
 
3042
        from subunit.test_results import AutoTimingTestResultDecorator
 
3043
    except ImportError:
 
3044
        AutoTimingTestResultDecorator = lambda x:x
3227
3045
    class TestInOtherProcess(ProtocolTestCase):
3228
3046
        # Should be in subunit, I think. RBC.
3229
3047
        def __init__(self, stream, pid):
3234
3052
            try:
3235
3053
                ProtocolTestCase.run(self, result)
3236
3054
            finally:
3237
 
                os.waitpid(self.pid, 0)
 
3055
                os.waitpid(self.pid, os.WNOHANG)
3238
3056
 
3239
3057
    test_blocks = partition_tests(suite, concurrency)
3240
3058
    for process_tests in test_blocks:
3243
3061
        c2pread, c2pwrite = os.pipe()
3244
3062
        pid = os.fork()
3245
3063
        if pid == 0:
3246
 
            workaround_zealous_crypto_random()
3247
3064
            try:
3248
3065
                os.close(c2pread)
3249
3066
                # Leave stderr and stdout open so we can see test noise
3296
3113
        if not os.path.isfile(bzr_path):
3297
3114
            # We are probably installed. Assume sys.argv is the right file
3298
3115
            bzr_path = sys.argv[0]
3299
 
        bzr_path = [bzr_path]
3300
 
        if sys.platform == "win32":
3301
 
            # if we're on windows, we can't execute the bzr script directly
3302
 
            bzr_path = [sys.executable] + bzr_path
3303
3116
        fd, test_list_file_name = tempfile.mkstemp()
3304
3117
        test_list_file = os.fdopen(fd, 'wb', 1)
3305
3118
        for test in process_tests:
3306
3119
            test_list_file.write(test.id() + '\n')
3307
3120
        test_list_file.close()
3308
3121
        try:
3309
 
            argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
 
3122
            argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3310
3123
                '--subunit']
3311
3124
            if '--no-plugins' in sys.argv:
3312
3125
                argv.append('--no-plugins')
3322
3135
    return result
3323
3136
 
3324
3137
 
3325
 
class ForwardingResult(unittest.TestResult):
 
3138
class BZRTransformingResult(unittest.TestResult):
3326
3139
 
3327
3140
    def __init__(self, target):
3328
3141
        unittest.TestResult.__init__(self)
3334
3147
    def stopTest(self, test):
3335
3148
        self.result.stopTest(test)
3336
3149
 
3337
 
    def startTestRun(self):
3338
 
        self.result.startTestRun()
 
3150
    def addError(self, test, err):
 
3151
        feature = self._error_looks_like('UnavailableFeature: ', err)
 
3152
        if feature is not None:
 
3153
            self.result.addNotSupported(test, feature)
 
3154
        else:
 
3155
            self.result.addError(test, err)
3339
3156
 
3340
 
    def stopTestRun(self):
3341
 
        self.result.stopTestRun()
 
3157
    def addFailure(self, test, err):
 
3158
        known = self._error_looks_like('KnownFailure: ', err)
 
3159
        if known is not None:
 
3160
            self.result._addKnownFailure(test, [KnownFailure,
 
3161
                                                KnownFailure(known), None])
 
3162
        else:
 
3163
            self.result.addFailure(test, err)
3342
3164
 
3343
3165
    def addSkip(self, test, reason):
3344
3166
        self.result.addSkip(test, reason)
3346
3168
    def addSuccess(self, test):
3347
3169
        self.result.addSuccess(test)
3348
3170
 
3349
 
    def addError(self, test, err):
3350
 
        self.result.addError(test, err)
3351
 
 
3352
 
    def addFailure(self, test, err):
3353
 
        self.result.addFailure(test, err)
3354
 
ForwardingResult = testtools.ExtendedToOriginalDecorator
3355
 
 
3356
 
 
3357
 
class ProfileResult(ForwardingResult):
3358
 
    """Generate profiling data for all activity between start and success.
3359
 
    
3360
 
    The profile data is appended to the test's _benchcalls attribute and can
3361
 
    be accessed by the forwarded-to TestResult.
3362
 
 
3363
 
    While it might be cleaner do accumulate this in stopTest, addSuccess is
3364
 
    where our existing output support for lsprof is, and this class aims to
3365
 
    fit in with that: while it could be moved it's not necessary to accomplish
3366
 
    test profiling, nor would it be dramatically cleaner.
3367
 
    """
3368
 
 
3369
 
    def startTest(self, test):
3370
 
        self.profiler = bzrlib.lsprof.BzrProfiler()
3371
 
        self.profiler.start()
3372
 
        ForwardingResult.startTest(self, test)
3373
 
 
3374
 
    def addSuccess(self, test):
3375
 
        stats = self.profiler.stop()
3376
 
        try:
3377
 
            calls = test._benchcalls
3378
 
        except AttributeError:
3379
 
            test._benchcalls = []
3380
 
            calls = test._benchcalls
3381
 
        calls.append(((test.id(), "", ""), stats))
3382
 
        ForwardingResult.addSuccess(self, test)
3383
 
 
3384
 
    def stopTest(self, test):
3385
 
        ForwardingResult.stopTest(self, test)
3386
 
        self.profiler = None
 
3171
    def _error_looks_like(self, prefix, err):
 
3172
        """Deserialize exception and returns the stringify value."""
 
3173
        import subunit
 
3174
        value = None
 
3175
        typ, exc, _ = err
 
3176
        if isinstance(exc, subunit.RemoteException):
 
3177
            # stringify the exception gives access to the remote traceback
 
3178
            # We search the last line for 'prefix'
 
3179
            lines = str(exc).split('\n')
 
3180
            while lines and not lines[-1]:
 
3181
                lines.pop(-1)
 
3182
            if lines:
 
3183
                if lines[-1].startswith(prefix):
 
3184
                    value = lines[-1][len(prefix):]
 
3185
        return value
3387
3186
 
3388
3187
 
3389
3188
# Controlled by "bzr selftest -E=..." option
3413
3212
             runner_class=None,
3414
3213
             suite_decorators=None,
3415
3214
             stream=None,
3416
 
             lsprof_tests=False,
3417
3215
             ):
3418
3216
    """Run the whole test suite under the enhanced runner"""
3419
3217
    # XXX: Very ugly way to do this...
3448
3246
        if starting_with:
3449
3247
            # But always filter as requested.
3450
3248
            suite = filter_suite_by_id_startswith(suite, starting_with)
3451
 
        result_decorators = []
3452
 
        if lsprof_tests:
3453
 
            result_decorators.append(ProfileResult)
3454
3249
        return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3455
3250
                     stop_on_failure=stop_on_failure,
3456
3251
                     transport=transport,
3464
3259
                     runner_class=runner_class,
3465
3260
                     suite_decorators=suite_decorators,
3466
3261
                     stream=stream,
3467
 
                     result_decorators=result_decorators,
3468
3262
                     )
3469
3263
    finally:
3470
3264
        default_transport = old_transport
3618
3412
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3619
3413
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3620
3414
 
3621
 
# Obvious highest levels prefixes, feel free to add your own via a plugin
 
3415
# Obvious higest levels prefixes, feel free to add your own via a plugin
3622
3416
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3623
3417
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3624
3418
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3626
3420
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3627
3421
 
3628
3422
 
3629
 
def _test_suite_testmod_names():
3630
 
    """Return the standard list of test module names to test."""
3631
 
    return [
3632
 
        'bzrlib.doc',
3633
 
        'bzrlib.tests.blackbox',
3634
 
        'bzrlib.tests.commands',
3635
 
        'bzrlib.tests.per_branch',
3636
 
        'bzrlib.tests.per_bzrdir',
3637
 
        'bzrlib.tests.per_bzrdir_colo',
3638
 
        'bzrlib.tests.per_foreign_vcs',
3639
 
        'bzrlib.tests.per_interrepository',
3640
 
        'bzrlib.tests.per_intertree',
3641
 
        'bzrlib.tests.per_inventory',
3642
 
        'bzrlib.tests.per_interbranch',
3643
 
        'bzrlib.tests.per_lock',
3644
 
        'bzrlib.tests.per_merger',
3645
 
        'bzrlib.tests.per_transport',
3646
 
        'bzrlib.tests.per_tree',
3647
 
        'bzrlib.tests.per_pack_repository',
3648
 
        'bzrlib.tests.per_repository',
3649
 
        'bzrlib.tests.per_repository_chk',
3650
 
        'bzrlib.tests.per_repository_reference',
3651
 
        'bzrlib.tests.per_uifactory',
3652
 
        'bzrlib.tests.per_versionedfile',
3653
 
        'bzrlib.tests.per_workingtree',
3654
 
        'bzrlib.tests.test__annotator',
3655
 
        'bzrlib.tests.test__bencode',
3656
 
        'bzrlib.tests.test__chk_map',
3657
 
        'bzrlib.tests.test__dirstate_helpers',
3658
 
        'bzrlib.tests.test__groupcompress',
3659
 
        'bzrlib.tests.test__known_graph',
3660
 
        'bzrlib.tests.test__rio',
3661
 
        'bzrlib.tests.test__simple_set',
3662
 
        'bzrlib.tests.test__static_tuple',
3663
 
        'bzrlib.tests.test__walkdirs_win32',
3664
 
        'bzrlib.tests.test_ancestry',
3665
 
        'bzrlib.tests.test_annotate',
3666
 
        'bzrlib.tests.test_api',
3667
 
        'bzrlib.tests.test_atomicfile',
3668
 
        'bzrlib.tests.test_bad_files',
3669
 
        'bzrlib.tests.test_bisect_multi',
3670
 
        'bzrlib.tests.test_branch',
3671
 
        'bzrlib.tests.test_branchbuilder',
3672
 
        'bzrlib.tests.test_btree_index',
3673
 
        'bzrlib.tests.test_bugtracker',
3674
 
        'bzrlib.tests.test_bundle',
3675
 
        'bzrlib.tests.test_bzrdir',
3676
 
        'bzrlib.tests.test__chunks_to_lines',
3677
 
        'bzrlib.tests.test_cache_utf8',
3678
 
        'bzrlib.tests.test_chk_map',
3679
 
        'bzrlib.tests.test_chk_serializer',
3680
 
        'bzrlib.tests.test_chunk_writer',
3681
 
        'bzrlib.tests.test_clean_tree',
3682
 
        'bzrlib.tests.test_cleanup',
3683
 
        'bzrlib.tests.test_cmdline',
3684
 
        'bzrlib.tests.test_commands',
3685
 
        'bzrlib.tests.test_commit',
3686
 
        'bzrlib.tests.test_commit_merge',
3687
 
        'bzrlib.tests.test_config',
3688
 
        'bzrlib.tests.test_conflicts',
3689
 
        'bzrlib.tests.test_counted_lock',
3690
 
        'bzrlib.tests.test_crash',
3691
 
        'bzrlib.tests.test_decorators',
3692
 
        'bzrlib.tests.test_delta',
3693
 
        'bzrlib.tests.test_debug',
3694
 
        'bzrlib.tests.test_deprecated_graph',
3695
 
        'bzrlib.tests.test_diff',
3696
 
        'bzrlib.tests.test_directory_service',
3697
 
        'bzrlib.tests.test_dirstate',
3698
 
        'bzrlib.tests.test_email_message',
3699
 
        'bzrlib.tests.test_eol_filters',
3700
 
        'bzrlib.tests.test_errors',
3701
 
        'bzrlib.tests.test_export',
3702
 
        'bzrlib.tests.test_extract',
3703
 
        'bzrlib.tests.test_fetch',
3704
 
        'bzrlib.tests.test_fifo_cache',
3705
 
        'bzrlib.tests.test_filters',
3706
 
        'bzrlib.tests.test_ftp_transport',
3707
 
        'bzrlib.tests.test_foreign',
3708
 
        'bzrlib.tests.test_generate_docs',
3709
 
        'bzrlib.tests.test_generate_ids',
3710
 
        'bzrlib.tests.test_globbing',
3711
 
        'bzrlib.tests.test_gpg',
3712
 
        'bzrlib.tests.test_graph',
3713
 
        'bzrlib.tests.test_groupcompress',
3714
 
        'bzrlib.tests.test_hashcache',
3715
 
        'bzrlib.tests.test_help',
3716
 
        'bzrlib.tests.test_hooks',
3717
 
        'bzrlib.tests.test_http',
3718
 
        'bzrlib.tests.test_http_response',
3719
 
        'bzrlib.tests.test_https_ca_bundle',
3720
 
        'bzrlib.tests.test_identitymap',
3721
 
        'bzrlib.tests.test_ignores',
3722
 
        'bzrlib.tests.test_index',
3723
 
        'bzrlib.tests.test_import_tariff',
3724
 
        'bzrlib.tests.test_info',
3725
 
        'bzrlib.tests.test_inv',
3726
 
        'bzrlib.tests.test_inventory_delta',
3727
 
        'bzrlib.tests.test_knit',
3728
 
        'bzrlib.tests.test_lazy_import',
3729
 
        'bzrlib.tests.test_lazy_regex',
3730
 
        'bzrlib.tests.test_lock',
3731
 
        'bzrlib.tests.test_lockable_files',
3732
 
        'bzrlib.tests.test_lockdir',
3733
 
        'bzrlib.tests.test_log',
3734
 
        'bzrlib.tests.test_lru_cache',
3735
 
        'bzrlib.tests.test_lsprof',
3736
 
        'bzrlib.tests.test_mail_client',
3737
 
        'bzrlib.tests.test_memorytree',
3738
 
        'bzrlib.tests.test_merge',
3739
 
        'bzrlib.tests.test_merge3',
3740
 
        'bzrlib.tests.test_merge_core',
3741
 
        'bzrlib.tests.test_merge_directive',
3742
 
        'bzrlib.tests.test_missing',
3743
 
        'bzrlib.tests.test_msgeditor',
3744
 
        'bzrlib.tests.test_multiparent',
3745
 
        'bzrlib.tests.test_mutabletree',
3746
 
        'bzrlib.tests.test_nonascii',
3747
 
        'bzrlib.tests.test_options',
3748
 
        'bzrlib.tests.test_osutils',
3749
 
        'bzrlib.tests.test_osutils_encodings',
3750
 
        'bzrlib.tests.test_pack',
3751
 
        'bzrlib.tests.test_patch',
3752
 
        'bzrlib.tests.test_patches',
3753
 
        'bzrlib.tests.test_permissions',
3754
 
        'bzrlib.tests.test_plugins',
3755
 
        'bzrlib.tests.test_progress',
3756
 
        'bzrlib.tests.test_read_bundle',
3757
 
        'bzrlib.tests.test_reconcile',
3758
 
        'bzrlib.tests.test_reconfigure',
3759
 
        'bzrlib.tests.test_registry',
3760
 
        'bzrlib.tests.test_remote',
3761
 
        'bzrlib.tests.test_rename_map',
3762
 
        'bzrlib.tests.test_repository',
3763
 
        'bzrlib.tests.test_revert',
3764
 
        'bzrlib.tests.test_revision',
3765
 
        'bzrlib.tests.test_revisionspec',
3766
 
        'bzrlib.tests.test_revisiontree',
3767
 
        'bzrlib.tests.test_rio',
3768
 
        'bzrlib.tests.test_rules',
3769
 
        'bzrlib.tests.test_sampler',
3770
 
        'bzrlib.tests.test_script',
3771
 
        'bzrlib.tests.test_selftest',
3772
 
        'bzrlib.tests.test_serializer',
3773
 
        'bzrlib.tests.test_setup',
3774
 
        'bzrlib.tests.test_sftp_transport',
3775
 
        'bzrlib.tests.test_shelf',
3776
 
        'bzrlib.tests.test_shelf_ui',
3777
 
        'bzrlib.tests.test_smart',
3778
 
        'bzrlib.tests.test_smart_add',
3779
 
        'bzrlib.tests.test_smart_request',
3780
 
        'bzrlib.tests.test_smart_transport',
3781
 
        'bzrlib.tests.test_smtp_connection',
3782
 
        'bzrlib.tests.test_source',
3783
 
        'bzrlib.tests.test_ssh_transport',
3784
 
        'bzrlib.tests.test_status',
3785
 
        'bzrlib.tests.test_store',
3786
 
        'bzrlib.tests.test_strace',
3787
 
        'bzrlib.tests.test_subsume',
3788
 
        'bzrlib.tests.test_switch',
3789
 
        'bzrlib.tests.test_symbol_versioning',
3790
 
        'bzrlib.tests.test_tag',
3791
 
        'bzrlib.tests.test_testament',
3792
 
        'bzrlib.tests.test_textfile',
3793
 
        'bzrlib.tests.test_textmerge',
3794
 
        'bzrlib.tests.test_timestamp',
3795
 
        'bzrlib.tests.test_trace',
3796
 
        'bzrlib.tests.test_transactions',
3797
 
        'bzrlib.tests.test_transform',
3798
 
        'bzrlib.tests.test_transport',
3799
 
        'bzrlib.tests.test_transport_log',
3800
 
        'bzrlib.tests.test_tree',
3801
 
        'bzrlib.tests.test_treebuilder',
3802
 
        'bzrlib.tests.test_tsort',
3803
 
        'bzrlib.tests.test_tuned_gzip',
3804
 
        'bzrlib.tests.test_ui',
3805
 
        'bzrlib.tests.test_uncommit',
3806
 
        'bzrlib.tests.test_upgrade',
3807
 
        'bzrlib.tests.test_upgrade_stacked',
3808
 
        'bzrlib.tests.test_urlutils',
3809
 
        'bzrlib.tests.test_version',
3810
 
        'bzrlib.tests.test_version_info',
3811
 
        'bzrlib.tests.test_weave',
3812
 
        'bzrlib.tests.test_whitebox',
3813
 
        'bzrlib.tests.test_win32utils',
3814
 
        'bzrlib.tests.test_workingtree',
3815
 
        'bzrlib.tests.test_workingtree_4',
3816
 
        'bzrlib.tests.test_wsgi',
3817
 
        'bzrlib.tests.test_xml',
3818
 
        ]
3819
 
 
3820
 
 
3821
 
def _test_suite_modules_to_doctest():
3822
 
    """Return the list of modules to doctest."""
3823
 
    if __doc__ is None:
3824
 
        # GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3825
 
        return []
3826
 
    return [
3827
 
        'bzrlib',
3828
 
        'bzrlib.branchbuilder',
3829
 
        'bzrlib.decorators',
3830
 
        'bzrlib.export',
3831
 
        'bzrlib.inventory',
3832
 
        'bzrlib.iterablefile',
3833
 
        'bzrlib.lockdir',
3834
 
        'bzrlib.merge3',
3835
 
        'bzrlib.option',
3836
 
        'bzrlib.symbol_versioning',
3837
 
        'bzrlib.tests',
3838
 
        'bzrlib.timestamp',
3839
 
        'bzrlib.version_info_formats.format_custom',
3840
 
        ]
3841
 
 
3842
 
 
3843
3423
def test_suite(keep_only=None, starting_with=None):
3844
3424
    """Build and return TestSuite for the whole of bzrlib.
3845
3425
 
3851
3431
    This function can be replaced if you need to change the default test
3852
3432
    suite on a global basis, but it is not encouraged.
3853
3433
    """
 
3434
    testmod_names = [
 
3435
                   'bzrlib.doc',
 
3436
                   'bzrlib.tests.blackbox',
 
3437
                   'bzrlib.tests.commands',
 
3438
                   'bzrlib.tests.per_branch',
 
3439
                   'bzrlib.tests.per_bzrdir',
 
3440
                   'bzrlib.tests.per_interrepository',
 
3441
                   'bzrlib.tests.per_intertree',
 
3442
                   'bzrlib.tests.per_inventory',
 
3443
                   'bzrlib.tests.per_interbranch',
 
3444
                   'bzrlib.tests.per_lock',
 
3445
                   'bzrlib.tests.per_transport',
 
3446
                   'bzrlib.tests.per_tree',
 
3447
                   'bzrlib.tests.per_pack_repository',
 
3448
                   'bzrlib.tests.per_repository',
 
3449
                   'bzrlib.tests.per_repository_chk',
 
3450
                   'bzrlib.tests.per_repository_reference',
 
3451
                   'bzrlib.tests.per_versionedfile',
 
3452
                   'bzrlib.tests.per_workingtree',
 
3453
                   'bzrlib.tests.test__annotator',
 
3454
                   'bzrlib.tests.test__chk_map',
 
3455
                   'bzrlib.tests.test__dirstate_helpers',
 
3456
                   'bzrlib.tests.test__groupcompress',
 
3457
                   'bzrlib.tests.test__known_graph',
 
3458
                   'bzrlib.tests.test__rio',
 
3459
                   'bzrlib.tests.test__walkdirs_win32',
 
3460
                   'bzrlib.tests.test_ancestry',
 
3461
                   'bzrlib.tests.test_annotate',
 
3462
                   'bzrlib.tests.test_api',
 
3463
                   'bzrlib.tests.test_atomicfile',
 
3464
                   'bzrlib.tests.test_bad_files',
 
3465
                   'bzrlib.tests.test_bencode',
 
3466
                   'bzrlib.tests.test_bisect_multi',
 
3467
                   'bzrlib.tests.test_branch',
 
3468
                   'bzrlib.tests.test_branchbuilder',
 
3469
                   'bzrlib.tests.test_btree_index',
 
3470
                   'bzrlib.tests.test_bugtracker',
 
3471
                   'bzrlib.tests.test_bundle',
 
3472
                   'bzrlib.tests.test_bzrdir',
 
3473
                   'bzrlib.tests.test__chunks_to_lines',
 
3474
                   'bzrlib.tests.test_cache_utf8',
 
3475
                   'bzrlib.tests.test_chk_map',
 
3476
                   'bzrlib.tests.test_chk_serializer',
 
3477
                   'bzrlib.tests.test_chunk_writer',
 
3478
                   'bzrlib.tests.test_clean_tree',
 
3479
                   'bzrlib.tests.test_commands',
 
3480
                   'bzrlib.tests.test_commit',
 
3481
                   'bzrlib.tests.test_commit_merge',
 
3482
                   'bzrlib.tests.test_config',
 
3483
                   'bzrlib.tests.test_conflicts',
 
3484
                   'bzrlib.tests.test_counted_lock',
 
3485
                   'bzrlib.tests.test_crash',
 
3486
                   'bzrlib.tests.test_decorators',
 
3487
                   'bzrlib.tests.test_delta',
 
3488
                   'bzrlib.tests.test_debug',
 
3489
                   'bzrlib.tests.test_deprecated_graph',
 
3490
                   'bzrlib.tests.test_diff',
 
3491
                   'bzrlib.tests.test_directory_service',
 
3492
                   'bzrlib.tests.test_dirstate',
 
3493
                   'bzrlib.tests.test_email_message',
 
3494
                   'bzrlib.tests.test_eol_filters',
 
3495
                   'bzrlib.tests.test_errors',
 
3496
                   'bzrlib.tests.test_export',
 
3497
                   'bzrlib.tests.test_extract',
 
3498
                   'bzrlib.tests.test_fetch',
 
3499
                   'bzrlib.tests.test_fifo_cache',
 
3500
                   'bzrlib.tests.test_filters',
 
3501
                   'bzrlib.tests.test_ftp_transport',
 
3502
                   'bzrlib.tests.test_foreign',
 
3503
                   'bzrlib.tests.test_generate_docs',
 
3504
                   'bzrlib.tests.test_generate_ids',
 
3505
                   'bzrlib.tests.test_globbing',
 
3506
                   'bzrlib.tests.test_gpg',
 
3507
                   'bzrlib.tests.test_graph',
 
3508
                   'bzrlib.tests.test_groupcompress',
 
3509
                   'bzrlib.tests.test_hashcache',
 
3510
                   'bzrlib.tests.test_help',
 
3511
                   'bzrlib.tests.test_hooks',
 
3512
                   'bzrlib.tests.test_http',
 
3513
                   'bzrlib.tests.test_http_response',
 
3514
                   'bzrlib.tests.test_https_ca_bundle',
 
3515
                   'bzrlib.tests.test_identitymap',
 
3516
                   'bzrlib.tests.test_ignores',
 
3517
                   'bzrlib.tests.test_index',
 
3518
                   'bzrlib.tests.test_info',
 
3519
                   'bzrlib.tests.test_inv',
 
3520
                   'bzrlib.tests.test_inventory_delta',
 
3521
                   'bzrlib.tests.test_knit',
 
3522
                   'bzrlib.tests.test_lazy_import',
 
3523
                   'bzrlib.tests.test_lazy_regex',
 
3524
                   'bzrlib.tests.test_lock',
 
3525
                   'bzrlib.tests.test_lockable_files',
 
3526
                   'bzrlib.tests.test_lockdir',
 
3527
                   'bzrlib.tests.test_log',
 
3528
                   'bzrlib.tests.test_lru_cache',
 
3529
                   'bzrlib.tests.test_lsprof',
 
3530
                   'bzrlib.tests.test_mail_client',
 
3531
                   'bzrlib.tests.test_memorytree',
 
3532
                   'bzrlib.tests.test_merge',
 
3533
                   'bzrlib.tests.test_merge3',
 
3534
                   'bzrlib.tests.test_merge_core',
 
3535
                   'bzrlib.tests.test_merge_directive',
 
3536
                   'bzrlib.tests.test_missing',
 
3537
                   'bzrlib.tests.test_msgeditor',
 
3538
                   'bzrlib.tests.test_multiparent',
 
3539
                   'bzrlib.tests.test_mutabletree',
 
3540
                   'bzrlib.tests.test_nonascii',
 
3541
                   'bzrlib.tests.test_options',
 
3542
                   'bzrlib.tests.test_osutils',
 
3543
                   'bzrlib.tests.test_osutils_encodings',
 
3544
                   'bzrlib.tests.test_pack',
 
3545
                   'bzrlib.tests.test_patch',
 
3546
                   'bzrlib.tests.test_patches',
 
3547
                   'bzrlib.tests.test_permissions',
 
3548
                   'bzrlib.tests.test_plugins',
 
3549
                   'bzrlib.tests.test_progress',
 
3550
                   'bzrlib.tests.test_read_bundle',
 
3551
                   'bzrlib.tests.test_reconcile',
 
3552
                   'bzrlib.tests.test_reconfigure',
 
3553
                   'bzrlib.tests.test_registry',
 
3554
                   'bzrlib.tests.test_remote',
 
3555
                   'bzrlib.tests.test_rename_map',
 
3556
                   'bzrlib.tests.test_repository',
 
3557
                   'bzrlib.tests.test_revert',
 
3558
                   'bzrlib.tests.test_revision',
 
3559
                   'bzrlib.tests.test_revisionspec',
 
3560
                   'bzrlib.tests.test_revisiontree',
 
3561
                   'bzrlib.tests.test_rio',
 
3562
                   'bzrlib.tests.test_rules',
 
3563
                   'bzrlib.tests.test_sampler',
 
3564
                   'bzrlib.tests.test_selftest',
 
3565
                   'bzrlib.tests.test_serializer',
 
3566
                   'bzrlib.tests.test_setup',
 
3567
                   'bzrlib.tests.test_sftp_transport',
 
3568
                   'bzrlib.tests.test_shelf',
 
3569
                   'bzrlib.tests.test_shelf_ui',
 
3570
                   'bzrlib.tests.test_smart',
 
3571
                   'bzrlib.tests.test_smart_add',
 
3572
                   'bzrlib.tests.test_smart_request',
 
3573
                   'bzrlib.tests.test_smart_transport',
 
3574
                   'bzrlib.tests.test_smtp_connection',
 
3575
                   'bzrlib.tests.test_source',
 
3576
                   'bzrlib.tests.test_ssh_transport',
 
3577
                   'bzrlib.tests.test_status',
 
3578
                   'bzrlib.tests.test_store',
 
3579
                   'bzrlib.tests.test_strace',
 
3580
                   'bzrlib.tests.test_subsume',
 
3581
                   'bzrlib.tests.test_switch',
 
3582
                   'bzrlib.tests.test_symbol_versioning',
 
3583
                   'bzrlib.tests.test_tag',
 
3584
                   'bzrlib.tests.test_testament',
 
3585
                   'bzrlib.tests.test_textfile',
 
3586
                   'bzrlib.tests.test_textmerge',
 
3587
                   'bzrlib.tests.test_timestamp',
 
3588
                   'bzrlib.tests.test_trace',
 
3589
                   'bzrlib.tests.test_transactions',
 
3590
                   'bzrlib.tests.test_transform',
 
3591
                   'bzrlib.tests.test_transport',
 
3592
                   'bzrlib.tests.test_transport_log',
 
3593
                   'bzrlib.tests.test_tree',
 
3594
                   'bzrlib.tests.test_treebuilder',
 
3595
                   'bzrlib.tests.test_tsort',
 
3596
                   'bzrlib.tests.test_tuned_gzip',
 
3597
                   'bzrlib.tests.test_ui',
 
3598
                   'bzrlib.tests.test_uncommit',
 
3599
                   'bzrlib.tests.test_upgrade',
 
3600
                   'bzrlib.tests.test_upgrade_stacked',
 
3601
                   'bzrlib.tests.test_urlutils',
 
3602
                   'bzrlib.tests.test_version',
 
3603
                   'bzrlib.tests.test_version_info',
 
3604
                   'bzrlib.tests.test_weave',
 
3605
                   'bzrlib.tests.test_whitebox',
 
3606
                   'bzrlib.tests.test_win32utils',
 
3607
                   'bzrlib.tests.test_workingtree',
 
3608
                   'bzrlib.tests.test_workingtree_4',
 
3609
                   'bzrlib.tests.test_wsgi',
 
3610
                   'bzrlib.tests.test_xml',
 
3611
                   ]
3854
3612
 
3855
3613
    loader = TestUtil.TestLoader()
3856
3614
 
3885
3643
    suite = loader.suiteClass()
3886
3644
 
3887
3645
    # modules building their suite with loadTestsFromModuleNames
3888
 
    suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3889
 
 
3890
 
    for mod in _test_suite_modules_to_doctest():
 
3646
    suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
 
3647
 
 
3648
    modules_to_doctest = [
 
3649
        'bzrlib',
 
3650
        'bzrlib.branchbuilder',
 
3651
        'bzrlib.export',
 
3652
        'bzrlib.inventory',
 
3653
        'bzrlib.iterablefile',
 
3654
        'bzrlib.lockdir',
 
3655
        'bzrlib.merge3',
 
3656
        'bzrlib.option',
 
3657
        'bzrlib.symbol_versioning',
 
3658
        'bzrlib.tests',
 
3659
        'bzrlib.timestamp',
 
3660
        'bzrlib.version_info_formats.format_custom',
 
3661
        ]
 
3662
 
 
3663
    for mod in modules_to_doctest:
3891
3664
        if not interesting_module(mod):
3892
3665
            # No tests to keep here, move along
3893
3666
            continue
4034
3807
    :param new_id: The id to assign to it.
4035
3808
    :return: The new test.
4036
3809
    """
4037
 
    new_test = copy(test)
 
3810
    from copy import deepcopy
 
3811
    new_test = deepcopy(test)
4038
3812
    new_test.id = lambda: new_id
4039
3813
    return new_test
4040
3814
 
4041
3815
 
4042
 
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4043
 
                                ext_module_name):
4044
 
    """Helper for permutating tests against an extension module.
4045
 
 
4046
 
    This is meant to be used inside a modules 'load_tests()' function. It will
4047
 
    create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4048
 
    against both implementations. Setting 'test.module' to the appropriate
4049
 
    module. See bzrlib.tests.test__chk_map.load_tests as an example.
4050
 
 
4051
 
    :param standard_tests: A test suite to permute
4052
 
    :param loader: A TestLoader
4053
 
    :param py_module_name: The python path to a python module that can always
4054
 
        be loaded, and will be considered the 'python' implementation. (eg
4055
 
        'bzrlib._chk_map_py')
4056
 
    :param ext_module_name: The python path to an extension module. If the
4057
 
        module cannot be loaded, a single test will be added, which notes that
4058
 
        the module is not available. If it can be loaded, all standard_tests
4059
 
        will be run against that module.
4060
 
    :return: (suite, feature) suite is a test-suite that has all the permuted
4061
 
        tests. feature is the Feature object that can be used to determine if
4062
 
        the module is available.
4063
 
    """
4064
 
 
4065
 
    py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4066
 
    scenarios = [
4067
 
        ('python', {'module': py_module}),
4068
 
    ]
4069
 
    suite = loader.suiteClass()
4070
 
    feature = ModuleAvailableFeature(ext_module_name)
4071
 
    if feature.available():
4072
 
        scenarios.append(('C', {'module': feature.module}))
4073
 
    else:
4074
 
        # the compiled module isn't available, so we add a failing test
4075
 
        class FailWithoutFeature(TestCase):
4076
 
            def test_fail(self):
4077
 
                self.requireFeature(feature)
4078
 
        suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4079
 
    result = multiply_tests(standard_tests, scenarios, suite)
4080
 
    return result, feature
4081
 
 
4082
 
 
4083
 
def _rmtree_temp_dir(dirname, test_id=None):
 
3816
def _rmtree_temp_dir(dirname):
4084
3817
    # If LANG=C we probably have created some bogus paths
4085
3818
    # which rmtree(unicode) will fail to delete
4086
3819
    # so make sure we are using rmtree(str) to delete everything
4098
3831
        # We don't want to fail here because some useful display will be lost
4099
3832
        # otherwise. Polluting the tmp dir is bad, but not giving all the
4100
3833
        # possible info to the test runner is even worse.
4101
 
        if test_id != None:
4102
 
            ui.ui_factory.clear_term()
4103
 
            sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4104
3834
        sys.stderr.write('Unable to remove testing dir %s\n%s'
4105
3835
                         % (os.path.basename(dirname), e))
4106
3836
 
4190
3920
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4191
3921
 
4192
3922
 
4193
 
class _CompatabilityThunkFeature(Feature):
4194
 
    """This feature is just a thunk to another feature.
4195
 
 
4196
 
    It issues a deprecation warning if it is accessed, to let you know that you
4197
 
    should really use a different feature.
4198
 
    """
4199
 
 
4200
 
    def __init__(self, dep_version, module, name,
4201
 
                 replacement_name, replacement_module=None):
4202
 
        super(_CompatabilityThunkFeature, self).__init__()
4203
 
        self._module = module
4204
 
        if replacement_module is None:
4205
 
            replacement_module = module
4206
 
        self._replacement_module = replacement_module
4207
 
        self._name = name
4208
 
        self._replacement_name = replacement_name
4209
 
        self._dep_version = dep_version
4210
 
        self._feature = None
4211
 
 
4212
 
    def _ensure(self):
4213
 
        if self._feature is None:
4214
 
            depr_msg = self._dep_version % ('%s.%s'
4215
 
                                            % (self._module, self._name))
4216
 
            use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4217
 
                                               self._replacement_name)
4218
 
            symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4219
 
            # Import the new feature and use it as a replacement for the
4220
 
            # deprecated one.
4221
 
            mod = __import__(self._replacement_module, {}, {},
4222
 
                             [self._replacement_name])
4223
 
            self._feature = getattr(mod, self._replacement_name)
4224
 
 
4225
 
    def _probe(self):
4226
 
        self._ensure()
4227
 
        return self._feature._probe()
4228
 
 
4229
 
 
4230
 
class ModuleAvailableFeature(Feature):
4231
 
    """This is a feature than describes a module we want to be available.
4232
 
 
4233
 
    Declare the name of the module in __init__(), and then after probing, the
4234
 
    module will be available as 'self.module'.
4235
 
 
4236
 
    :ivar module: The module if it is available, else None.
4237
 
    """
4238
 
 
4239
 
    def __init__(self, module_name):
4240
 
        super(ModuleAvailableFeature, self).__init__()
4241
 
        self.module_name = module_name
4242
 
 
4243
 
    def _probe(self):
4244
 
        try:
4245
 
            self._module = __import__(self.module_name, {}, {}, [''])
4246
 
            return True
4247
 
        except ImportError:
4248
 
            return False
4249
 
 
4250
 
    @property
4251
 
    def module(self):
4252
 
        if self.available(): # Make sure the probe has been done
4253
 
            return self._module
4254
 
        return None
4255
 
 
4256
 
    def feature_name(self):
4257
 
        return self.module_name
4258
 
 
4259
 
 
4260
 
# This is kept here for compatibility, it is recommended to use
4261
 
# 'bzrlib.tests.feature.paramiko' instead
4262
 
ParamikoFeature = _CompatabilityThunkFeature(
4263
 
    deprecated_in((2,1,0)),
4264
 
    'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4265
 
 
4266
 
 
4267
3923
def probe_unicode_in_user_encoding():
4268
3924
    """Try to encode several unicode strings to use in unicode-aware tests.
4269
3925
    Return first successfull match.
4349
4005
UTF8Filesystem = _UTF8Filesystem()
4350
4006
 
4351
4007
 
4352
 
class _BreakinFeature(Feature):
4353
 
    """Does this platform support the breakin feature?"""
4354
 
 
4355
 
    def _probe(self):
4356
 
        from bzrlib import breakin
4357
 
        if breakin.determine_signal() is None:
4358
 
            return False
4359
 
        if sys.platform == 'win32':
4360
 
            # Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4361
 
            # We trigger SIGBREAK via a Console api so we need ctypes to
4362
 
            # access the function
4363
 
            try:
4364
 
                import ctypes
4365
 
            except OSError:
4366
 
                return False
4367
 
        return True
4368
 
 
4369
 
    def feature_name(self):
4370
 
        return "SIGQUIT or SIGBREAK w/ctypes on win32"
4371
 
 
4372
 
 
4373
 
BreakinFeature = _BreakinFeature()
4374
 
 
4375
 
 
4376
4008
class _CaseInsCasePresFilenameFeature(Feature):
4377
4009
    """Is the file-system case insensitive, but case-preserving?"""
4378
4010
 
4445
4077
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4446
4078
 
4447
4079
 
4448
 
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4449
 
SubUnitFeature = _CompatabilityThunkFeature(
4450
 
    deprecated_in((2,1,0)),
4451
 
    'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
 
4080
class _SubUnitFeature(Feature):
 
4081
    """Check if subunit is available."""
 
4082
 
 
4083
    def _probe(self):
 
4084
        try:
 
4085
            import subunit
 
4086
            return True
 
4087
        except ImportError:
 
4088
            return False
 
4089
 
 
4090
    def feature_name(self):
 
4091
        return 'subunit'
 
4092
 
 
4093
SubUnitFeature = _SubUnitFeature()
4452
4094
# Only define SubUnitBzrRunner if subunit is available.
4453
4095
try:
4454
4096
    from subunit import TestProtocolClient
4455
 
    from subunit.test_results import AutoTimingTestResultDecorator
 
4097
    try:
 
4098
        from subunit.test_results import AutoTimingTestResultDecorator
 
4099
    except ImportError:
 
4100
        AutoTimingTestResultDecorator = lambda x:x
4456
4101
    class SubUnitBzrRunner(TextTestRunner):
4457
4102
        def run(self, test):
4458
4103
            result = AutoTimingTestResultDecorator(
4461
4106
            return result
4462
4107
except ImportError:
4463
4108
    pass
4464
 
 
4465
 
class _PosixPermissionsFeature(Feature):
4466
 
 
4467
 
    def _probe(self):
4468
 
        def has_perms():
4469
 
            # create temporary file and check if specified perms are maintained.
4470
 
            import tempfile
4471
 
 
4472
 
            write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4473
 
            f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4474
 
            fd, name = f
4475
 
            os.close(fd)
4476
 
            os.chmod(name, write_perms)
4477
 
 
4478
 
            read_perms = os.stat(name).st_mode & 0777
4479
 
            os.unlink(name)
4480
 
            return (write_perms == read_perms)
4481
 
 
4482
 
        return (os.name == 'posix') and has_perms()
4483
 
 
4484
 
    def feature_name(self):
4485
 
        return 'POSIX permissions support'
4486
 
 
4487
 
posix_permissions_feature = _PosixPermissionsFeature()