~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Joe Julian
  • Date: 2010-01-10 02:25:31 UTC
  • mto: (4634.119.7 2.0)
  • mto: This revision was merged to the branch mainline in revision 4959.
  • Revision ID: joe@julianfamily.org-20100110022531-wqk61rsagz8xsiga
Added MANIFEST.in to allow bdist_rpm to have all the required include files and tools. bdist_rpm will still fail to build correctly on some distributions due to a disttools bug http://bugs.python.org/issue644744

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
28
28
 
29
29
import atexit
30
30
import codecs
31
 
from copy import copy
32
31
from cStringIO import StringIO
33
32
import difflib
34
33
import doctest
46
45
import tempfile
47
46
import threading
48
47
import time
49
 
import traceback
50
48
import unittest
51
49
import warnings
52
50
 
53
 
import testtools
54
 
# nb: check this before importing anything else from within it
55
 
_testtools_version = getattr(testtools, '__version__', ())
56
 
if _testtools_version < (0, 9, 2):
57
 
    raise ImportError("need at least testtools 0.9.2: %s is %r"
58
 
        % (testtools.__file__, _testtools_version))
59
 
from testtools import content
60
51
 
61
52
from bzrlib import (
62
53
    branchbuilder,
63
54
    bzrdir,
64
55
    chk_map,
65
 
    config,
66
56
    debug,
67
57
    errors,
68
58
    hooks,
96
86
from bzrlib.symbol_versioning import (
97
87
    DEPRECATED_PARAMETER,
98
88
    deprecated_function,
99
 
    deprecated_in,
100
89
    deprecated_method,
101
90
    deprecated_passed,
102
91
    )
103
92
import bzrlib.trace
104
 
from bzrlib.transport import (
105
 
    get_transport,
106
 
    memory,
107
 
    pathfilter,
108
 
    )
 
93
from bzrlib.transport import get_transport
109
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
110
98
from bzrlib.trace import mutter, note
111
 
from bzrlib.tests import (
112
 
    test_server,
113
 
    TestUtil,
114
 
    )
 
99
from bzrlib.tests import TestUtil
115
100
from bzrlib.tests.http_server import HttpServer
116
101
from bzrlib.tests.TestUtil import (
117
102
                          TestSuite,
128
113
# shown frame is the test code, not our assertXYZ.
129
114
__unittest = 1
130
115
 
131
 
default_transport = test_server.LocalURLServer
132
 
 
133
 
 
134
 
_unitialized_attr = object()
135
 
"""A sentinel needed to act as a default value in a method signature."""
136
 
 
 
116
default_transport = LocalURLServer
137
117
 
138
118
# Subunit result codes, defined here to prevent a hard dependency on subunit.
139
119
SUBUNIT_SEEK_SET = 0
195
175
        self._overall_start_time = time.time()
196
176
        self._strict = strict
197
177
 
198
 
    def stopTestRun(self):
199
 
        run = self.testsRun
200
 
        actionTaken = "Ran"
201
 
        stopTime = time.time()
202
 
        timeTaken = stopTime - self.startTime
203
 
        self.printErrors()
204
 
        self.stream.writeln(self.separator2)
205
 
        self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
206
 
                            run, run != 1 and "s" or "", timeTaken))
207
 
        self.stream.writeln()
208
 
        if not self.wasSuccessful():
209
 
            self.stream.write("FAILED (")
210
 
            failed, errored = map(len, (self.failures, self.errors))
211
 
            if failed:
212
 
                self.stream.write("failures=%d" % failed)
213
 
            if errored:
214
 
                if failed: self.stream.write(", ")
215
 
                self.stream.write("errors=%d" % errored)
216
 
            if self.known_failure_count:
217
 
                if failed or errored: self.stream.write(", ")
218
 
                self.stream.write("known_failure_count=%d" %
219
 
                    self.known_failure_count)
220
 
            self.stream.writeln(")")
221
 
        else:
222
 
            if self.known_failure_count:
223
 
                self.stream.writeln("OK (known_failures=%d)" %
224
 
                    self.known_failure_count)
225
 
            else:
226
 
                self.stream.writeln("OK")
227
 
        if self.skip_count > 0:
228
 
            skipped = self.skip_count
229
 
            self.stream.writeln('%d test%s skipped' %
230
 
                                (skipped, skipped != 1 and "s" or ""))
231
 
        if self.unsupported:
232
 
            for feature, count in sorted(self.unsupported.items()):
233
 
                self.stream.writeln("Missing feature '%s' skipped %d tests." %
234
 
                    (feature, count))
 
178
    def done(self):
 
179
        # nb: called stopTestRun in the version of this that Python merged
 
180
        # upstream, according to lifeless 20090803
235
181
        if self._strict:
236
182
            ok = self.wasStrictlySuccessful()
237
183
        else:
238
184
            ok = self.wasSuccessful()
 
185
        if ok:
 
186
            self.stream.write('tests passed\n')
 
187
        else:
 
188
            self.stream.write('tests failed\n')
239
189
        if TestCase._first_thread_leaker_id:
240
190
            self.stream.write(
241
191
                '%s is leaking threads among %d leaking tests.\n' % (
242
192
                TestCase._first_thread_leaker_id,
243
193
                TestCase._leaking_threads_tests))
244
 
            # We don't report the main thread as an active one.
245
 
            self.stream.write(
246
 
                '%d non-main threads were left active in the end.\n'
247
 
                % (TestCase._active_threads - 1))
248
 
 
249
 
    def getDescription(self, test):
250
 
        return test.id()
251
 
 
252
 
    def _extractBenchmarkTime(self, testCase, details=None):
 
194
 
 
195
    def _extractBenchmarkTime(self, testCase):
253
196
        """Add a benchmark time for the current test case."""
254
 
        if details and 'benchtime' in details:
255
 
            return float(''.join(details['benchtime'].iter_bytes()))
256
197
        return getattr(testCase, "_benchtime", None)
257
198
 
258
199
    def _elapsedTestTimeString(self):
292
233
        else:
293
234
            bzr_path = sys.executable
294
235
        self.stream.write(
295
 
            'bzr selftest: %s\n' % (bzr_path,))
 
236
            'testing: %s\n' % (bzr_path,))
296
237
        self.stream.write(
297
238
            '   %s\n' % (
298
239
                    bzrlib.__path__[0],))
321
262
        Called from the TestCase run() method when the test
322
263
        fails with an unexpected error.
323
264
        """
324
 
        self._post_mortem()
325
 
        unittest.TestResult.addError(self, test, err)
326
 
        self.error_count += 1
327
 
        self.report_error(test, err)
328
 
        if self.stop_early:
329
 
            self.stop()
330
 
        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)
331
277
 
332
278
    def addFailure(self, test, err):
333
279
        """Tell result that test failed.
335
281
        Called from the TestCase run() method when the test
336
282
        fails because e.g. an assert() method failed.
337
283
        """
338
 
        self._post_mortem()
339
 
        unittest.TestResult.addFailure(self, test, err)
340
 
        self.failure_count += 1
341
 
        self.report_failure(test, err)
342
 
        if self.stop_early:
343
 
            self.stop()
344
 
        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)
345
294
 
346
 
    def addSuccess(self, test, details=None):
 
295
    def addSuccess(self, test):
347
296
        """Tell result that test completed successfully.
348
297
 
349
298
        Called from the TestCase run()
350
299
        """
 
300
        self._testConcluded(test)
351
301
        if self._bench_history is not None:
352
 
            benchmark_time = self._extractBenchmarkTime(test, details)
 
302
            benchmark_time = self._extractBenchmarkTime(test)
353
303
            if benchmark_time is not None:
354
304
                self._bench_history.write("%s %s\n" % (
355
305
                    self._formatTime(benchmark_time),
359
309
        unittest.TestResult.addSuccess(self, test)
360
310
        test._log_contents = ''
361
311
 
362
 
    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):
363
320
        self.known_failure_count += 1
364
321
        self.report_known_failure(test, err)
365
322
 
367
324
        """The test will not be run because of a missing feature.
368
325
        """
369
326
        # this can be called in two different ways: it may be that the
370
 
        # test started running, and then raised (through requireFeature)
 
327
        # test started running, and then raised (through addError)
371
328
        # UnavailableFeature.  Alternatively this method can be called
372
 
        # while probing for features before running the test code proper; in
373
 
        # that case we will see startTest and stopTest, but the test will
374
 
        # 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.
375
332
        self.unsupported.setdefault(str(feature), 0)
376
333
        self.unsupported[str(feature)] += 1
377
334
        self.report_unsupported(test, feature)
381
338
        self.skip_count += 1
382
339
        self.report_skip(test, reason)
383
340
 
384
 
    def addNotApplicable(self, test, reason):
385
 
        self.not_applicable_count += 1
386
 
        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 = ''
387
356
 
388
 
    def _post_mortem(self):
389
 
        """Start a PDB post mortem session."""
390
 
        if os.environ.get('BZR_TEST_PDB', None):
391
 
            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)
392
376
 
393
377
    def progress(self, offset, whence):
394
378
        """The test is adjusting the count of tests to run."""
399
383
        else:
400
384
            raise errors.BzrError("Unknown whence %r" % whence)
401
385
 
 
386
    def finished(self):
 
387
        pass
 
388
 
402
389
    def report_cleaning_up(self):
403
390
        pass
404
391
 
405
 
    def startTestRun(self):
406
 
        self.startTime = time.time()
407
 
 
408
392
    def report_success(self, test):
409
393
        pass
410
394
 
437
421
        self.pb.update_latency = 0
438
422
        self.pb.show_transport_activity = False
439
423
 
440
 
    def stopTestRun(self):
 
424
    def done(self):
441
425
        # called when the tests that are going to run have run
442
426
        self.pb.clear()
 
427
        super(TextTestResult, self).done()
 
428
 
 
429
    def finished(self):
443
430
        self.pb.finished()
444
 
        super(TextTestResult, self).stopTestRun()
445
431
 
446
 
    def startTestRun(self):
447
 
        super(TextTestResult, self).startTestRun()
 
432
    def report_starting(self):
448
433
        self.pb.update('[test 0/%d] Starting' % (self.num_tests))
449
434
 
450
435
    def printErrors(self):
470
455
            a += '%dm%ds' % (runtime / 60, runtime % 60)
471
456
        else:
472
457
            a += '%ds' % runtime
473
 
        total_fail_count = self.error_count + self.failure_count
474
 
        if total_fail_count:
475
 
            a += ', %d failed' % total_fail_count
476
 
        # if self.unsupported:
477
 
        #     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)
478
464
        a += ']'
479
465
        return a
480
466
 
489
475
        return self._shortened_test_description(test)
490
476
 
491
477
    def report_error(self, test, err):
492
 
        self.ui.note('ERROR: %s\n    %s\n' % (
 
478
        self.pb.note('ERROR: %s\n    %s\n',
493
479
            self._test_description(test),
494
480
            err[1],
495
 
            ))
 
481
            )
496
482
 
497
483
    def report_failure(self, test, err):
498
 
        self.ui.note('FAIL: %s\n    %s\n' % (
 
484
        self.pb.note('FAIL: %s\n    %s\n',
499
485
            self._test_description(test),
500
486
            err[1],
501
 
            ))
 
487
            )
502
488
 
503
489
    def report_known_failure(self, test, err):
504
 
        pass
 
490
        self.pb.note('XFAIL: %s\n%s\n',
 
491
            self._test_description(test), err[1])
505
492
 
506
493
    def report_skip(self, test, reason):
507
494
        pass
508
495
 
509
 
    def report_not_applicable(self, test, reason):
 
496
    def report_not_applicable(self, test, skip_excinfo):
510
497
        pass
511
498
 
512
499
    def report_unsupported(self, test, feature):
527
514
            result = a_string
528
515
        return result.ljust(final_width)
529
516
 
530
 
    def startTestRun(self):
531
 
        super(VerboseTestResult, self).startTestRun()
 
517
    def report_starting(self):
532
518
        self.stream.write('running %d tests...\n' % self.num_tests)
533
519
 
534
520
    def report_test_start(self, test):
535
521
        self.count += 1
536
522
        name = self._shortened_test_description(test)
537
 
        width = osutils.terminal_width()
538
 
        if width is not None:
539
 
            # width needs space for 6 char status, plus 1 for slash, plus an
540
 
            # 11-char time string, plus a trailing blank
541
 
            # when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
542
 
            # space
543
 
            self.stream.write(self._ellipsize_to_right(name, width-18))
544
 
        else:
545
 
            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))
546
528
        self.stream.flush()
547
529
 
548
530
    def _error_summary(self, err):
577
559
        self.stream.writeln(' SKIP %s\n%s'
578
560
                % (self._testTimeString(test), reason))
579
561
 
580
 
    def report_not_applicable(self, test, reason):
581
 
        self.stream.writeln('  N/A %s\n    %s'
582
 
                % (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)))
583
566
 
584
567
    def report_unsupported(self, test, feature):
585
568
        """test cannot be run because feature is missing."""
595
578
                 descriptions=0,
596
579
                 verbosity=1,
597
580
                 bench_history=None,
 
581
                 list_only=False,
598
582
                 strict=False,
599
 
                 result_decorators=None,
600
583
                 ):
601
 
        """Create a TextTestRunner.
602
 
 
603
 
        :param result_decorators: An optional list of decorators to apply
604
 
            to the result object being used by the runner. Decorators are
605
 
            applied left to right - the first element in the list is the 
606
 
            innermost decorator.
607
 
        """
608
 
        # stream may know claim to know to write unicode strings, but in older
609
 
        # pythons this goes sufficiently wrong that it is a bad idea. (
610
 
        # specifically a built in file with encoding 'UTF-8' will still try
611
 
        # to encode using ascii.
612
 
        new_encoding = osutils.get_terminal_encoding()
613
 
        codec = codecs.lookup(new_encoding)
614
 
        if type(codec) is tuple:
615
 
            # Python 2.4
616
 
            encode = codec[0]
617
 
        else:
618
 
            encode = codec.encode
619
 
        stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
620
 
        stream.encoding = new_encoding
621
584
        self.stream = unittest._WritelnDecorator(stream)
622
585
        self.descriptions = descriptions
623
586
        self.verbosity = verbosity
624
587
        self._bench_history = bench_history
 
588
        self.list_only = list_only
625
589
        self._strict = strict
626
 
        self._result_decorators = result_decorators or []
627
590
 
628
591
    def run(self, test):
629
592
        "Run the given test case or test suite."
 
593
        startTime = time.time()
630
594
        if self.verbosity == 1:
631
595
            result_class = TextTestResult
632
596
        elif self.verbosity >= 2:
633
597
            result_class = VerboseTestResult
634
 
        original_result = result_class(self.stream,
 
598
        result = result_class(self.stream,
635
599
                              self.descriptions,
636
600
                              self.verbosity,
637
601
                              bench_history=self._bench_history,
638
602
                              strict=self._strict,
639
603
                              )
640
 
        # Signal to result objects that look at stop early policy to stop,
641
 
        original_result.stop_early = self.stop_on_failure
642
 
        result = original_result
643
 
        for decorator in self._result_decorators:
644
 
            result = decorator(result)
645
 
            result.stop_early = self.stop_on_failure
646
 
        result.startTestRun()
647
 
        try:
648
 
            test.run(result)
649
 
        finally:
650
 
            result.stopTestRun()
651
 
        # higher level code uses our extended protocol to determine
652
 
        # what exit code to give.
653
 
        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
654
663
 
655
664
 
656
665
def iter_suite_tests(suite):
666
675
                        % (type(suite), suite))
667
676
 
668
677
 
669
 
TestSkipped = testtools.testcase.TestSkipped
 
678
class TestSkipped(Exception):
 
679
    """Indicates that a test was intentionally skipped, rather than failing."""
670
680
 
671
681
 
672
682
class TestNotApplicable(TestSkipped):
678
688
    """
679
689
 
680
690
 
681
 
# traceback._some_str fails to format exceptions that have the default
682
 
# __str__ which does an implicit ascii conversion. However, repr() on those
683
 
# objects works, for all that its not quite what the doctor may have ordered.
684
 
def _clever_some_str(value):
685
 
    try:
686
 
        return str(value)
687
 
    except:
688
 
        try:
689
 
            return repr(value).replace('\\n', '\n')
690
 
        except:
691
 
            return '<unprintable %s object>' % type(value).__name__
692
 
 
693
 
traceback._some_str = _clever_some_str
694
 
 
695
 
 
696
 
# deprecated - use self.knownFailure(), or self.expectFailure.
697
 
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
    """
698
699
 
699
700
 
700
701
class UnavailableFeature(Exception):
701
702
    """A feature required for this test was not available.
702
703
 
703
 
    This can be considered a specialised form of SkippedTest.
704
 
 
705
704
    The feature should be used to construct the exception.
706
705
    """
707
706
 
708
707
 
 
708
class CommandFailed(Exception):
 
709
    pass
 
710
 
 
711
 
709
712
class StringIOWrapper(object):
710
713
    """A wrapper around cStringIO which just adds an encoding attribute.
711
714
 
772
775
        return NullProgressView()
773
776
 
774
777
 
775
 
class TestCase(testtools.TestCase):
 
778
class TestCase(unittest.TestCase):
776
779
    """Base class for bzr unit tests.
777
780
 
778
781
    Tests that need access to disk resources should subclass
797
800
    _leaking_threads_tests = 0
798
801
    _first_thread_leaker_id = None
799
802
    _log_file_name = None
 
803
    _log_contents = ''
 
804
    _keep_log_file = False
800
805
    # record lsprof data when performing benchmark calls.
801
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',)
802
810
 
803
811
    def __init__(self, methodName='testMethod'):
804
812
        super(TestCase, self).__init__(methodName)
805
813
        self._cleanups = []
806
 
        self._directory_isolation = True
807
 
        self.exception_handlers.insert(0,
808
 
            (UnavailableFeature, self._do_unsupported_or_skip))
809
 
        self.exception_handlers.insert(0,
810
 
            (TestNotApplicable, self._do_not_applicable))
 
814
        self._bzr_test_setUp_run = False
 
815
        self._bzr_test_tearDown_run = False
811
816
 
812
817
    def setUp(self):
813
 
        super(TestCase, self).setUp()
814
 
        for feature in getattr(self, '_test_needs_features', []):
815
 
            self.requireFeature(feature)
816
 
        self._log_contents = None
817
 
        self.addDetail("log", content.Content(content.ContentType("text",
818
 
            "plain", {"charset": "utf8"}),
819
 
            lambda:[self._get_log(keep_log_file=True)]))
 
818
        unittest.TestCase.setUp(self)
 
819
        self._bzr_test_setUp_run = True
820
820
        self._cleanEnvironment()
821
821
        self._silenceUI()
822
822
        self._startLogFile()
823
823
        self._benchcalls = []
824
824
        self._benchtime = None
825
825
        self._clear_hooks()
826
 
        self._track_transports()
827
826
        self._track_locks()
828
827
        self._clear_debug_flags()
829
828
        TestCase._active_threads = threading.activeCount()
838
837
        active = threading.activeCount()
839
838
        leaked_threads = active - TestCase._active_threads
840
839
        TestCase._active_threads = active
841
 
        # If some tests make the number of threads *decrease*, we'll consider
842
 
        # that they are just observing old threads dieing, not agressively kill
843
 
        # random threads. So we don't report these tests as leaking. The risk
844
 
        # is that we have false positives that way (the test see 2 threads
845
 
        # going away but leak one) but it seems less likely than the actual
846
 
        # false positives (the test see threads going away and does not leak).
847
 
        if leaked_threads > 0:
 
840
        if leaked_threads:
848
841
            TestCase._leaking_threads_tests += 1
849
842
            if TestCase._first_thread_leaker_id is None:
850
843
                TestCase._first_thread_leaker_id = self.id()
855
848
        Tests that want to use debug flags can just set them in the
856
849
        debug_flags set during setup/teardown.
857
850
        """
858
 
        # Start with a copy of the current debug flags we can safely modify.
859
 
        self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
 
851
        self._preserved_debug_flags = set(debug.debug_flags)
860
852
        if 'allow_debug' not in selftest_debug_flags:
861
853
            debug.debug_flags.clear()
862
854
        if 'disable_lock_checks' not in selftest_debug_flags:
863
855
            debug.debug_flags.add('strict_locks')
 
856
        self.addCleanup(self._restore_debug_flags)
864
857
 
865
858
    def _clear_hooks(self):
866
859
        # prevent hooks affecting tests
876
869
        # this hook should always be installed
877
870
        request._install_hook()
878
871
 
879
 
    def disable_directory_isolation(self):
880
 
        """Turn off directory isolation checks."""
881
 
        self._directory_isolation = False
882
 
 
883
 
    def enable_directory_isolation(self):
884
 
        """Enable directory isolation checks."""
885
 
        self._directory_isolation = True
886
 
 
887
872
    def _silenceUI(self):
888
873
        """Turn off UI for duration of test"""
889
874
        # by default the UI is off; tests can turn it on if they want it.
890
 
        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)
891
880
 
892
881
    def _check_locks(self):
893
882
        """Check that all lock take/release actions have been paired."""
922
911
            self._lock_check_thorough = False
923
912
        else:
924
913
            self._lock_check_thorough = True
925
 
 
 
914
            
926
915
        self.addCleanup(self._check_locks)
927
916
        _mod_lock.Lock.hooks.install_named_hook('lock_acquired',
928
917
                                                self._lock_acquired, None)
940
929
    def _lock_broken(self, result):
941
930
        self._lock_actions.append(('broken', result))
942
931
 
943
 
    def permit_dir(self, name):
944
 
        """Permit a directory to be used by this test. See permit_url."""
945
 
        name_transport = get_transport(name)
946
 
        self.permit_url(name)
947
 
        self.permit_url(name_transport.base)
948
 
 
949
 
    def permit_url(self, url):
950
 
        """Declare that url is an ok url to use in this test.
951
 
        
952
 
        Do this for memory transports, temporary test directory etc.
953
 
        
954
 
        Do not do this for the current working directory, /tmp, or any other
955
 
        preexisting non isolated url.
956
 
        """
957
 
        if not url.endswith('/'):
958
 
            url += '/'
959
 
        self._bzr_selftest_roots.append(url)
960
 
 
961
 
    def permit_source_tree_branch_repo(self):
962
 
        """Permit the source tree bzr is running from to be opened.
963
 
 
964
 
        Some code such as bzrlib.version attempts to read from the bzr branch
965
 
        that bzr is executing from (if any). This method permits that directory
966
 
        to be used in the test suite.
967
 
        """
968
 
        path = self.get_source_path()
969
 
        self.record_directory_isolation()
970
 
        try:
971
 
            try:
972
 
                workingtree.WorkingTree.open(path)
973
 
            except (errors.NotBranchError, errors.NoWorkingTree):
974
 
                return
975
 
        finally:
976
 
            self.enable_directory_isolation()
977
 
 
978
 
    def _preopen_isolate_transport(self, transport):
979
 
        """Check that all transport openings are done in the test work area."""
980
 
        while isinstance(transport, pathfilter.PathFilteringTransport):
981
 
            # Unwrap pathfiltered transports
982
 
            transport = transport.server.backing_transport.clone(
983
 
                transport._filter('.'))
984
 
        url = transport.base
985
 
        # ReadonlySmartTCPServer_for_testing decorates the backing transport
986
 
        # urls it is given by prepending readonly+. This is appropriate as the
987
 
        # client shouldn't know that the server is readonly (or not readonly).
988
 
        # We could register all servers twice, with readonly+ prepending, but
989
 
        # that makes for a long list; this is about the same but easier to
990
 
        # read.
991
 
        if url.startswith('readonly+'):
992
 
            url = url[len('readonly+'):]
993
 
        self._preopen_isolate_url(url)
994
 
 
995
 
    def _preopen_isolate_url(self, url):
996
 
        if not self._directory_isolation:
997
 
            return
998
 
        if self._directory_isolation == 'record':
999
 
            self._bzr_selftest_roots.append(url)
1000
 
            return
1001
 
        # This prevents all transports, including e.g. sftp ones backed on disk
1002
 
        # from working unless they are explicitly granted permission. We then
1003
 
        # depend on the code that sets up test transports to check that they are
1004
 
        # appropriately isolated and enable their use by calling
1005
 
        # self.permit_transport()
1006
 
        if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1007
 
            raise errors.BzrError("Attempt to escape test isolation: %r %r"
1008
 
                % (url, self._bzr_selftest_roots))
1009
 
 
1010
 
    def record_directory_isolation(self):
1011
 
        """Gather accessed directories to permit later access.
1012
 
        
1013
 
        This is used for tests that access the branch bzr is running from.
1014
 
        """
1015
 
        self._directory_isolation = "record"
1016
 
 
1017
 
    def start_server(self, transport_server, backing_server=None):
1018
 
        """Start transport_server for this test.
1019
 
 
1020
 
        This starts the server, registers a cleanup for it and permits the
1021
 
        server's urls to be used.
1022
 
        """
1023
 
        if backing_server is None:
1024
 
            transport_server.start_server()
1025
 
        else:
1026
 
            transport_server.start_server(backing_server)
1027
 
        self.addCleanup(transport_server.stop_server)
1028
 
        # Obtain a real transport because if the server supplies a password, it
1029
 
        # will be hidden from the base on the client side.
1030
 
        t = get_transport(transport_server.get_url())
1031
 
        # Some transport servers effectively chroot the backing transport;
1032
 
        # others like SFTPServer don't - users of the transport can walk up the
1033
 
        # transport to read the entire backing transport. This wouldn't matter
1034
 
        # except that the workdir tests are given - and that they expect the
1035
 
        # server's url to point at - is one directory under the safety net. So
1036
 
        # Branch operations into the transport will attempt to walk up one
1037
 
        # directory. Chrooting all servers would avoid this but also mean that
1038
 
        # we wouldn't be testing directly against non-root urls. Alternatively
1039
 
        # getting the test framework to start the server with a backing server
1040
 
        # at the actual safety net directory would work too, but this then
1041
 
        # means that the self.get_url/self.get_transport methods would need
1042
 
        # to transform all their results. On balance its cleaner to handle it
1043
 
        # here, and permit a higher url when we have one of these transports.
1044
 
        if t.base.endswith('/work/'):
1045
 
            # we have safety net/test root/work
1046
 
            t = t.clone('../..')
1047
 
        elif isinstance(transport_server,
1048
 
                        test_server.SmartTCPServer_for_testing):
1049
 
            # The smart server adds a path similar to work, which is traversed
1050
 
            # up from by the client. But the server is chrooted - the actual
1051
 
            # backing transport is not escaped from, and VFS requests to the
1052
 
            # root will error (because they try to escape the chroot).
1053
 
            t2 = t.clone('..')
1054
 
            while t2.base != t.base:
1055
 
                t = t2
1056
 
                t2 = t.clone('..')
1057
 
        self.permit_url(t.base)
1058
 
 
1059
 
    def _track_transports(self):
1060
 
        """Install checks for transport usage."""
1061
 
        # TestCase has no safe place it can write to.
1062
 
        self._bzr_selftest_roots = []
1063
 
        # Currently the easiest way to be sure that nothing is going on is to
1064
 
        # hook into bzr dir opening. This leaves a small window of error for
1065
 
        # transport tests, but they are well known, and we can improve on this
1066
 
        # step.
1067
 
        bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1068
 
            self._preopen_isolate_transport, "Check bzr directories are safe.")
1069
 
 
1070
932
    def _ndiff_strings(self, a, b):
1071
933
        """Return ndiff between two strings containing lines.
1072
934
 
1109
971
            return
1110
972
        if message is None:
1111
973
            message = "texts not equal:\n"
 
974
        if a == b + '\n':
 
975
            message = 'first string is missing a final newline.\n'
1112
976
        if a + '\n' == b:
1113
 
            message = 'first string is missing a final newline.\n'
1114
 
        if a == b + '\n':
1115
977
            message = 'second string is missing a final newline.\n'
1116
978
        raise AssertionError(message +
1117
979
                             self._ndiff_strings(a, b))
1128
990
        :raises AssertionError: If the expected and actual stat values differ
1129
991
            other than by atime.
1130
992
        """
1131
 
        self.assertEqual(expected.st_size, actual.st_size,
1132
 
                         'st_size did not match')
1133
 
        self.assertEqual(expected.st_mtime, actual.st_mtime,
1134
 
                         'st_mtime did not match')
1135
 
        self.assertEqual(expected.st_ctime, actual.st_ctime,
1136
 
                         'st_ctime did not match')
1137
 
        if sys.platform != 'win32':
1138
 
            # On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1139
 
            # is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1140
 
            # odd. Regardless we shouldn't actually try to assert anything
1141
 
            # about their values
1142
 
            self.assertEqual(expected.st_dev, actual.st_dev,
1143
 
                             'st_dev did not match')
1144
 
            self.assertEqual(expected.st_ino, actual.st_ino,
1145
 
                             'st_ino did not match')
1146
 
        self.assertEqual(expected.st_mode, actual.st_mode,
1147
 
                         '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)
1148
999
 
1149
1000
    def assertLength(self, length, obj_with_len):
1150
1001
        """Assert that obj_with_len is of length length."""
1152
1003
            self.fail("Incorrect length: wanted %d, got %d for %r" % (
1153
1004
                length, len(obj_with_len), obj_with_len))
1154
1005
 
1155
 
    def assertLogsError(self, exception_class, func, *args, **kwargs):
1156
 
        """Assert that func(*args, **kwargs) quietly logs a specific exception.
1157
 
        """
1158
 
        from bzrlib import trace
1159
 
        captured = []
1160
 
        orig_log_exception_quietly = trace.log_exception_quietly
1161
 
        try:
1162
 
            def capture():
1163
 
                orig_log_exception_quietly()
1164
 
                captured.append(sys.exc_info())
1165
 
            trace.log_exception_quietly = capture
1166
 
            func(*args, **kwargs)
1167
 
        finally:
1168
 
            trace.log_exception_quietly = orig_log_exception_quietly
1169
 
        self.assertLength(1, captured)
1170
 
        err = captured[0][1]
1171
 
        self.assertIsInstance(err, exception_class)
1172
 
        return err
1173
 
 
1174
1006
    def assertPositive(self, val):
1175
1007
        """Assert that val is greater than 0."""
1176
1008
        self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1206
1038
            raise AssertionError('pattern "%s" found in "%s"'
1207
1039
                    % (needle_re, haystack))
1208
1040
 
1209
 
    def assertContainsString(self, haystack, needle):
1210
 
        if haystack.find(needle) == -1:
1211
 
            self.fail("string %r not found in '''%s'''" % (needle, haystack))
1212
 
 
1213
1041
    def assertSubset(self, sublist, superlist):
1214
1042
        """Assert that every entry in sublist is present in superlist."""
1215
1043
        missing = set(sublist) - set(superlist)
1302
1130
                m += ": " + msg
1303
1131
            self.fail(m)
1304
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
 
1305
1168
    def assertFileEqual(self, content, path):
1306
1169
        """Fail if path does not contain 'content'."""
1307
1170
        self.failUnlessExists(path)
1457
1320
 
1458
1321
        Close the file and delete it, unless setKeepLogfile was called.
1459
1322
        """
1460
 
        if bzrlib.trace._trace_file:
1461
 
            # flush the log file, to get all content
1462
 
            bzrlib.trace._trace_file.flush()
 
1323
        if self._log_file is None:
 
1324
            return
1463
1325
        bzrlib.trace.pop_log_file(self._log_memento)
1464
 
        # Cache the log result and delete the file on disk
1465
 
        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
1466
1335
 
1467
1336
    def thisFailsStrictLockCheck(self):
1468
1337
        """It is known that this test would fail with -Dstrict_locks.
1485
1354
        """
1486
1355
        self._cleanups.append((callable, args, kwargs))
1487
1356
 
1488
 
    def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1489
 
        """Overrides an object attribute restoring it after the test.
1490
 
 
1491
 
        :param obj: The object that will be mutated.
1492
 
 
1493
 
        :param attr_name: The attribute name we want to preserve/override in
1494
 
            the object.
1495
 
 
1496
 
        :param new: The optional value we want to set the attribute to.
1497
 
 
1498
 
        :returns: The actual attr value.
1499
 
        """
1500
 
        value = getattr(obj, attr_name)
1501
 
        # The actual value is captured by the call below
1502
 
        self.addCleanup(setattr, obj, attr_name, value)
1503
 
        if new is not _unitialized_attr:
1504
 
            setattr(obj, attr_name, new)
1505
 
        return value
1506
 
 
1507
1357
    def _cleanEnvironment(self):
1508
1358
        new_env = {
1509
1359
            'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1519
1369
            'BZR_PROGRESS_BAR': None,
1520
1370
            'BZR_LOG': None,
1521
1371
            'BZR_PLUGIN_PATH': None,
1522
 
            'BZR_CONCURRENCY': None,
1523
1372
            # Make sure that any text ui tests are consistent regardless of
1524
1373
            # the environment the test case is run in; you may want tests that
1525
1374
            # test other combinations.  'dumb' is a reasonable guess for tests
1527
1376
            'TERM': 'dumb',
1528
1377
            'LINES': '25',
1529
1378
            'COLUMNS': '80',
1530
 
            'BZR_COLUMNS': '80',
1531
1379
            # SSH Agent
1532
1380
            'SSH_AUTH_SOCK': None,
1533
1381
            # Proxies
1545
1393
            'ftp_proxy': None,
1546
1394
            'FTP_PROXY': None,
1547
1395
            'BZR_REMOTE_PATH': None,
1548
 
            # Generally speaking, we don't want apport reporting on crashes in
1549
 
            # the test envirnoment unless we're specifically testing apport,
1550
 
            # so that it doesn't leak into the real system environment.  We
1551
 
            # use an env var so it propagates to subprocesses.
1552
 
            'APPORT_DISABLE': '1',
1553
1396
        }
1554
 
        self._old_env = {}
 
1397
        self.__old_env = {}
1555
1398
        self.addCleanup(self._restoreEnvironment)
1556
1399
        for name, value in new_env.iteritems():
1557
1400
            self._captureVar(name, value)
1558
1401
 
1559
1402
    def _captureVar(self, name, newvalue):
1560
1403
        """Set an environment variable, and reset it when finished."""
1561
 
        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)
1562
1409
 
1563
1410
    def _restoreEnvironment(self):
1564
 
        for name, value in self._old_env.iteritems():
 
1411
        for name, value in self.__old_env.iteritems():
1565
1412
            osutils.set_or_unset_env(name, value)
1566
1413
 
1567
1414
    def _restoreHooks(self):
1575
1422
    def _do_skip(self, result, reason):
1576
1423
        addSkip = getattr(result, 'addSkip', None)
1577
1424
        if not callable(addSkip):
1578
 
            result.addSuccess(result)
 
1425
            result.addError(self, sys.exc_info())
1579
1426
        else:
1580
1427
            addSkip(self, reason)
1581
1428
 
1582
 
    @staticmethod
1583
 
    def _do_known_failure(self, result, e):
1584
 
        err = sys.exc_info()
1585
 
        addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1586
 
        if addExpectedFailure is not None:
1587
 
            addExpectedFailure(self, err)
1588
 
        else:
1589
 
            result.addSuccess(self)
1590
 
 
1591
 
    @staticmethod
1592
 
    def _do_not_applicable(self, result, e):
1593
 
        if not e.args:
1594
 
            reason = 'No reason given'
1595
 
        else:
1596
 
            reason = e.args[0]
1597
 
        addNotApplicable = getattr(result, 'addNotApplicable', None)
1598
 
        if addNotApplicable is not None:
1599
 
            result.addNotApplicable(self, reason)
1600
 
        else:
1601
 
            self._do_skip(result, reason)
1602
 
 
1603
 
    @staticmethod
1604
 
    def _do_unsupported_or_skip(self, result, e):
1605
 
        reason = e.args[0]
1606
 
        addNotSupported = getattr(result, 'addNotSupported', None)
1607
 
        if addNotSupported is not None:
1608
 
            result.addNotSupported(self, reason)
1609
 
        else:
1610
 
            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)
1611
1523
 
1612
1524
    def time(self, callable, *args, **kwargs):
1613
1525
        """Run callable and accrue the time it takes to the benchmark time.
1617
1529
        self._benchcalls.
1618
1530
        """
1619
1531
        if self._benchtime is None:
1620
 
            self.addDetail('benchtime', content.Content(content.ContentType(
1621
 
                "text", "plain"), lambda:[str(self._benchtime)]))
1622
1532
            self._benchtime = 0
1623
1533
        start = time.time()
1624
1534
        try:
1633
1543
        finally:
1634
1544
            self._benchtime += time.time() - start
1635
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
 
1636
1560
    def log(self, *args):
1637
1561
        mutter(*args)
1638
1562
 
1639
1563
    def _get_log(self, keep_log_file=False):
1640
 
        """Internal helper to get the log from bzrlib.trace for this test.
1641
 
 
1642
 
        Please use self.getDetails, or self.get_log to access this in test case
1643
 
        code.
 
1564
        """Get the log from bzrlib.trace calls from this test.
1644
1565
 
1645
1566
        :param keep_log_file: When True, if the log is still a file on disk
1646
1567
            leave it as a file on disk. When False, if the log is still a file
1648
1569
            self._log_contents.
1649
1570
        :return: A string containing the log.
1650
1571
        """
1651
 
        if self._log_contents is not None:
1652
 
            try:
1653
 
                self._log_contents.decode('utf8')
1654
 
            except UnicodeDecodeError:
1655
 
                unicodestr = self._log_contents.decode('utf8', 'replace')
1656
 
                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
1657
1579
            return self._log_contents
1658
 
        import bzrlib.trace
1659
 
        if bzrlib.trace._trace_file:
1660
 
            # flush the log file, to get all content
1661
 
            bzrlib.trace._trace_file.flush()
1662
1580
        if self._log_file_name is not None:
1663
1581
            logfile = open(self._log_file_name)
1664
1582
            try:
1665
1583
                log_contents = logfile.read()
1666
1584
            finally:
1667
1585
                logfile.close()
1668
 
            try:
1669
 
                log_contents.decode('utf8')
1670
 
            except UnicodeDecodeError:
1671
 
                unicodestr = log_contents.decode('utf8', 'replace')
1672
 
                log_contents = unicodestr.encode('utf8')
1673
1586
            if not keep_log_file:
1674
 
                self._log_file.close()
1675
 
                self._log_file = None
1676
 
                # Permit multiple calls to get_log until we clean it up in
1677
 
                # finishLogFile
1678
1587
                self._log_contents = log_contents
1679
1588
                try:
1680
1589
                    os.remove(self._log_file_name)
1684
1593
                                             ' %r\n' % self._log_file_name))
1685
1594
                    else:
1686
1595
                        raise
1687
 
                self._log_file_name = None
1688
1596
            return log_contents
1689
1597
        else:
1690
 
            return "No log file content and no log file name."
1691
 
 
1692
 
    def get_log(self):
1693
 
        """Get a unicode string containing the log from bzrlib.trace.
1694
 
 
1695
 
        Undecodable characters are replaced.
1696
 
        """
1697
 
        return u"".join(self.getDetails()['log'].iter_text())
 
1598
            return "DELETED log file to reduce memory footprint"
1698
1599
 
1699
1600
    def requireFeature(self, feature):
1700
1601
        """This test requires a specific feature is available.
1742
1643
            os.chdir(working_dir)
1743
1644
 
1744
1645
        try:
1745
 
            try:
1746
 
                result = self.apply_redirected(ui.ui_factory.stdin,
1747
 
                    stdout, stderr,
1748
 
                    bzrlib.commands.run_bzr_catch_user_errors,
1749
 
                    args)
1750
 
            except KeyboardInterrupt:
1751
 
                # Reraise KeyboardInterrupt with contents of redirected stdout
1752
 
                # and stderr as arguments, for tests which are interested in
1753
 
                # stdout and stderr and are expecting the exception.
1754
 
                out = stdout.getvalue()
1755
 
                err = stderr.getvalue()
1756
 
                if out:
1757
 
                    self.log('output:\n%r', out)
1758
 
                if err:
1759
 
                    self.log('errors:\n%r', err)
1760
 
                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)
1761
1650
        finally:
1762
1651
            logger.removeHandler(handler)
1763
1652
            ui.ui_factory = old_ui_factory
1773
1662
        if retcode is not None:
1774
1663
            self.assertEquals(retcode, result,
1775
1664
                              message='Unexpected return code')
1776
 
        return result, out, err
 
1665
        return out, err
1777
1666
 
1778
1667
    def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1779
1668
                working_dir=None, error_regexes=[], output_encoding=None):
1808
1697
        :keyword error_regexes: A list of expected error messages.  If
1809
1698
            specified they must be seen in the error output of the command.
1810
1699
        """
1811
 
        retcode, out, err = self._run_bzr_autosplit(
 
1700
        out, err = self._run_bzr_autosplit(
1812
1701
            args=args,
1813
1702
            retcode=retcode,
1814
1703
            encoding=encoding,
1965
1854
        """
1966
1855
        return Popen(*args, **kwargs)
1967
1856
 
1968
 
    def get_source_path(self):
1969
 
        """Return the path of the directory containing bzrlib."""
1970
 
        return os.path.dirname(os.path.dirname(bzrlib.__file__))
1971
 
 
1972
1857
    def get_bzr_path(self):
1973
1858
        """Return the path of the 'bzr' executable for this test suite."""
1974
 
        bzr_path = self.get_source_path()+'/bzr'
 
1859
        bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1975
1860
        if not os.path.isfile(bzr_path):
1976
1861
            # We are probably installed. Assume sys.argv is the right file
1977
1862
            bzr_path = sys.argv[0]
2063
1948
 
2064
1949
        Tests that expect to provoke LockContention errors should call this.
2065
1950
        """
2066
 
        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
2067
1956
 
2068
1957
    def make_utf8_encoded_stringio(self, encoding_type=None):
2069
1958
        """Return a StringIOWrapper instance, that will encode Unicode
2083
1972
        request_handlers = request.request_handlers
2084
1973
        orig_method = request_handlers.get(verb)
2085
1974
        request_handlers.remove(verb)
2086
 
        self.addCleanup(request_handlers.register, verb, orig_method)
 
1975
        def restoreVerb():
 
1976
            request_handlers.register(verb, orig_method)
 
1977
        self.addCleanup(restoreVerb)
2087
1978
 
2088
1979
 
2089
1980
class CapturedCall(object):
2180
2071
        if self.__readonly_server is None:
2181
2072
            if self.transport_readonly_server is None:
2182
2073
                # readonly decorator requested
2183
 
                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())
2184
2077
            else:
2185
 
                # explicit readonly transport.
2186
2078
                self.__readonly_server = self.create_transport_readonly_server()
2187
 
            self.start_server(self.__readonly_server,
2188
 
                self.get_vfs_only_server())
 
2079
                self.__readonly_server.setUp(self.get_vfs_only_server())
 
2080
            self.addCleanup(self.__readonly_server.tearDown)
2189
2081
        return self.__readonly_server
2190
2082
 
2191
2083
    def get_readonly_url(self, relpath=None):
2209
2101
        is no means to override it.
2210
2102
        """
2211
2103
        if self.__vfs_server is None:
2212
 
            self.__vfs_server = memory.MemoryServer()
2213
 
            self.start_server(self.__vfs_server)
 
2104
            self.__vfs_server = MemoryServer()
 
2105
            self.__vfs_server.setUp()
 
2106
            self.addCleanup(self.__vfs_server.tearDown)
2214
2107
        return self.__vfs_server
2215
2108
 
2216
2109
    def get_server(self):
2223
2116
        then the self.get_vfs_server is returned.
2224
2117
        """
2225
2118
        if self.__server is None:
2226
 
            if (self.transport_server is None or self.transport_server is
2227
 
                self.vfs_transport_factory):
2228
 
                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()
2229
2121
            else:
2230
2122
                # bring up a decorated means of access to the vfs only server.
2231
2123
                self.__server = self.transport_server()
2232
 
                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)
2233
2132
        return self.__server
2234
2133
 
2235
2134
    def _adjust_url(self, base, relpath):
2297
2196
        propagating. This method ensures than a test did not leaked.
2298
2197
        """
2299
2198
        root = TestCaseWithMemoryTransport.TEST_ROOT
2300
 
        self.permit_url(get_transport(root).base)
2301
2199
        wt = workingtree.WorkingTree.open(root)
2302
2200
        last_rev = wt.last_revision()
2303
2201
        if last_rev != 'null:':
2305
2203
            # recreate a new one or all the followng tests will fail.
2306
2204
            # If you need to inspect its content uncomment the following line
2307
2205
            # import pdb; pdb.set_trace()
2308
 
            _rmtree_temp_dir(root + '/.bzr', test_id=self.id())
 
2206
            _rmtree_temp_dir(root + '/.bzr')
2309
2207
            self._create_safety_net()
2310
2208
            raise AssertionError('%s/.bzr should not be modified' % root)
2311
2209
 
2312
2210
    def _make_test_root(self):
2313
2211
        if TestCaseWithMemoryTransport.TEST_ROOT is None:
2314
 
            # Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2315
 
            root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2316
 
                                                    suffix='.tmp'))
 
2212
            root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2317
2213
            TestCaseWithMemoryTransport.TEST_ROOT = root
2318
2214
 
2319
2215
            self._create_safety_net()
2322
2218
            # specifically told when all tests are finished.  This will do.
2323
2219
            atexit.register(_rmtree_temp_dir, root)
2324
2220
 
2325
 
        self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2326
2221
        self.addCleanup(self._check_safety_net)
2327
2222
 
2328
2223
    def makeAndChdirToTestDir(self):
2336
2231
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2337
2232
        self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2338
2233
        self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2339
 
        self.permit_dir(self.test_dir)
2340
2234
 
2341
2235
    def make_branch(self, relpath, format=None):
2342
2236
        """Create a branch on the transport at relpath."""
2372
2266
        return made_control.create_repository(shared=shared)
2373
2267
 
2374
2268
    def make_smart_server(self, path):
2375
 
        smart_server = test_server.SmartTCPServer_for_testing()
2376
 
        self.start_server(smart_server, self.get_server())
 
2269
        smart_server = server.SmartTCPServer_for_testing()
 
2270
        smart_server.setUp(self.get_server())
2377
2271
        remote_transport = get_transport(smart_server.get_url()).clone(path)
 
2272
        self.addCleanup(smart_server.tearDown)
2378
2273
        return remote_transport
2379
2274
 
2380
2275
    def make_branch_and_memory_tree(self, relpath, format=None):
2387
2282
        return branchbuilder.BranchBuilder(branch=branch)
2388
2283
 
2389
2284
    def overrideEnvironmentForTesting(self):
2390
 
        test_home_dir = self.test_home_dir
2391
 
        if isinstance(test_home_dir, unicode):
2392
 
            test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2393
 
        os.environ['HOME'] = test_home_dir
2394
 
        os.environ['BZR_HOME'] = test_home_dir
 
2285
        os.environ['HOME'] = self.test_home_dir
 
2286
        os.environ['BZR_HOME'] = self.test_home_dir
2395
2287
 
2396
2288
    def setUp(self):
2397
2289
        super(TestCaseWithMemoryTransport, self).setUp()
2398
2290
        self._make_test_root()
2399
 
        self.addCleanup(os.chdir, os.getcwdu())
 
2291
        _currentdir = os.getcwdu()
 
2292
        def _leaveDirectory():
 
2293
            os.chdir(_currentdir)
 
2294
        self.addCleanup(_leaveDirectory)
2400
2295
        self.makeAndChdirToTestDir()
2401
2296
        self.overrideEnvironmentForTesting()
2402
2297
        self.__readonly_server = None
2405
2300
 
2406
2301
    def setup_smart_server_with_call_log(self):
2407
2302
        """Sets up a smart server as the transport server with a call log."""
2408
 
        self.transport_server = test_server.SmartTCPServer_for_testing
 
2303
        self.transport_server = server.SmartTCPServer_for_testing
2409
2304
        self.hpss_calls = []
2410
2305
        import traceback
2411
2306
        # Skip the current stack down to the caller of
2474
2369
            if os.path.exists(name):
2475
2370
                name = name_prefix + '_' + str(i)
2476
2371
            else:
2477
 
                # now create test and home directories within this dir
2478
 
                self.test_base_dir = name
2479
 
                self.addCleanup(self.deleteTestDir)
2480
 
                os.mkdir(self.test_base_dir)
 
2372
                os.mkdir(name)
2481
2373
                break
2482
 
        self.permit_dir(self.test_base_dir)
2483
 
        # 'sprouting' and 'init' of a branch both walk up the tree to find
2484
 
        # stacking policy to honour; create a bzr dir with an unshared
2485
 
        # repository (but not a branch - our code would be trying to escape
2486
 
        # then!) to stop them, and permit it to be read.
2487
 
        # control = bzrdir.BzrDir.create(self.test_base_dir)
2488
 
        # control.create_repository()
 
2374
        # now create test and home directories within this dir
 
2375
        self.test_base_dir = name
2489
2376
        self.test_home_dir = self.test_base_dir + '/home'
2490
2377
        os.mkdir(self.test_home_dir)
2491
2378
        self.test_dir = self.test_base_dir + '/work'
2497
2384
            f.write(self.id())
2498
2385
        finally:
2499
2386
            f.close()
 
2387
        self.addCleanup(self.deleteTestDir)
2500
2388
 
2501
2389
    def deleteTestDir(self):
2502
2390
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2503
 
        _rmtree_temp_dir(self.test_base_dir, test_id=self.id())
 
2391
        _rmtree_temp_dir(self.test_base_dir)
2504
2392
 
2505
2393
    def build_tree(self, shape, line_endings='binary', transport=None):
2506
2394
        """Build a test tree according to a pattern.
2588
2476
        """
2589
2477
        if self.__vfs_server is None:
2590
2478
            self.__vfs_server = self.vfs_transport_factory()
2591
 
            self.start_server(self.__vfs_server)
 
2479
            self.__vfs_server.setUp()
 
2480
            self.addCleanup(self.__vfs_server.tearDown)
2592
2481
        return self.__vfs_server
2593
2482
 
2594
2483
    def make_branch_and_tree(self, relpath, format=None):
2601
2490
        repository will also be accessed locally. Otherwise a lightweight
2602
2491
        checkout is created and returned.
2603
2492
 
2604
 
        We do this because we can't physically create a tree in the local
2605
 
        path, with a branch reference to the transport_factory url, and
2606
 
        a branch + repository in the vfs_transport, unless the vfs_transport
2607
 
        namespace is distinct from the local disk - the two branch objects
2608
 
        would collide. While we could construct a tree with its branch object
2609
 
        pointing at the transport_factory transport in memory, reopening it
2610
 
        would behaving unexpectedly, and has in the past caused testing bugs
2611
 
        when we tried to do it that way.
2612
 
 
2613
2493
        :param format: The BzrDirFormat.
2614
2494
        :returns: the WorkingTree.
2615
2495
        """
2624
2504
            # We can only make working trees locally at the moment.  If the
2625
2505
            # transport can't support them, then we keep the non-disk-backed
2626
2506
            # branch and create a local checkout.
2627
 
            if self.vfs_transport_factory is test_server.LocalURLServer:
 
2507
            if self.vfs_transport_factory is LocalURLServer:
2628
2508
                # the branch is colocated on disk, we cannot create a checkout.
2629
2509
                # hopefully callers will expect this.
2630
2510
                local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2667
2547
        super(TestCaseWithTransport, self).setUp()
2668
2548
        self.__vfs_server = None
2669
2549
 
2670
 
    def disable_missing_extensions_warning(self):
2671
 
        """Some tests expect a precise stderr content.
2672
 
 
2673
 
        There is no point in forcing them to duplicate the extension related
2674
 
        warning.
2675
 
        """
2676
 
        config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2677
 
 
2678
2550
 
2679
2551
class ChrootedTestCase(TestCaseWithTransport):
2680
2552
    """A support class that provides readonly urls outside the local namespace.
2690
2562
 
2691
2563
    def setUp(self):
2692
2564
        super(ChrootedTestCase, self).setUp()
2693
 
        if not self.vfs_transport_factory == memory.MemoryServer:
 
2565
        if not self.vfs_transport_factory == MemoryServer:
2694
2566
            self.transport_readonly_server = HttpServer
2695
2567
 
2696
2568
 
2894
2766
              strict=False,
2895
2767
              runner_class=None,
2896
2768
              suite_decorators=None,
2897
 
              stream=None,
2898
 
              result_decorators=None,
2899
 
              ):
 
2769
              stream=None):
2900
2770
    """Run a test suite for bzr selftest.
2901
2771
 
2902
2772
    :param runner_class: The class of runner to use. Must support the
2917
2787
                            descriptions=0,
2918
2788
                            verbosity=verbosity,
2919
2789
                            bench_history=bench_history,
 
2790
                            list_only=list_only,
2920
2791
                            strict=strict,
2921
 
                            result_decorators=result_decorators,
2922
2792
                            )
2923
2793
    runner.stop_on_failure=stop_on_failure
2924
2794
    # built in decorator factories:
2939
2809
        decorators.append(CountingDecorator)
2940
2810
    for decorator in decorators:
2941
2811
        suite = decorator(suite)
 
2812
    result = runner.run(suite)
2942
2813
    if list_only:
2943
 
        # Done after test suite decoration to allow randomisation etc
2944
 
        # to take effect, though that is of marginal benefit.
2945
 
        if verbosity >= 2:
2946
 
            stream.write("Listing tests only ...\n")
2947
 
        for t in iter_suite_tests(suite):
2948
 
            stream.write("%s\n" % (t.id()))
2949
2814
        return True
2950
 
    result = runner.run(suite)
 
2815
    result.done()
2951
2816
    if strict:
2952
2817
        return result.wasStrictlySuccessful()
2953
2818
    else:
3110
2975
        if self.randomised:
3111
2976
            return iter(self._tests)
3112
2977
        self.randomised = True
3113
 
        self.stream.write("Randomizing test order using seed %s\n\n" %
 
2978
        self.stream.writeln("Randomizing test order using seed %s\n" %
3114
2979
            (self.actual_seed()))
3115
2980
        # Initialise the random number generator.
3116
2981
        random.seed(self.actual_seed())
3173
3038
    concurrency = osutils.local_concurrency()
3174
3039
    result = []
3175
3040
    from subunit import TestProtocolClient, ProtocolTestCase
3176
 
    from subunit.test_results import AutoTimingTestResultDecorator
 
3041
    try:
 
3042
        from subunit.test_results import AutoTimingTestResultDecorator
 
3043
    except ImportError:
 
3044
        AutoTimingTestResultDecorator = lambda x:x
3177
3045
    class TestInOtherProcess(ProtocolTestCase):
3178
3046
        # Should be in subunit, I think. RBC.
3179
3047
        def __init__(self, stream, pid):
3245
3113
        if not os.path.isfile(bzr_path):
3246
3114
            # We are probably installed. Assume sys.argv is the right file
3247
3115
            bzr_path = sys.argv[0]
3248
 
        bzr_path = [bzr_path]
3249
 
        if sys.platform == "win32":
3250
 
            # if we're on windows, we can't execute the bzr script directly
3251
 
            bzr_path = [sys.executable] + bzr_path
3252
3116
        fd, test_list_file_name = tempfile.mkstemp()
3253
3117
        test_list_file = os.fdopen(fd, 'wb', 1)
3254
3118
        for test in process_tests:
3255
3119
            test_list_file.write(test.id() + '\n')
3256
3120
        test_list_file.close()
3257
3121
        try:
3258
 
            argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
 
3122
            argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3259
3123
                '--subunit']
3260
3124
            if '--no-plugins' in sys.argv:
3261
3125
                argv.append('--no-plugins')
3271
3135
    return result
3272
3136
 
3273
3137
 
3274
 
class ForwardingResult(unittest.TestResult):
 
3138
class BZRTransformingResult(unittest.TestResult):
3275
3139
 
3276
3140
    def __init__(self, target):
3277
3141
        unittest.TestResult.__init__(self)
3283
3147
    def stopTest(self, test):
3284
3148
        self.result.stopTest(test)
3285
3149
 
3286
 
    def startTestRun(self):
3287
 
        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)
3288
3156
 
3289
 
    def stopTestRun(self):
3290
 
        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)
3291
3164
 
3292
3165
    def addSkip(self, test, reason):
3293
3166
        self.result.addSkip(test, reason)
3295
3168
    def addSuccess(self, test):
3296
3169
        self.result.addSuccess(test)
3297
3170
 
3298
 
    def addError(self, test, err):
3299
 
        self.result.addError(test, err)
3300
 
 
3301
 
    def addFailure(self, test, err):
3302
 
        self.result.addFailure(test, err)
3303
 
ForwardingResult = testtools.ExtendedToOriginalDecorator
3304
 
 
3305
 
 
3306
 
class ProfileResult(ForwardingResult):
3307
 
    """Generate profiling data for all activity between start and success.
3308
 
    
3309
 
    The profile data is appended to the test's _benchcalls attribute and can
3310
 
    be accessed by the forwarded-to TestResult.
3311
 
 
3312
 
    While it might be cleaner do accumulate this in stopTest, addSuccess is
3313
 
    where our existing output support for lsprof is, and this class aims to
3314
 
    fit in with that: while it could be moved it's not necessary to accomplish
3315
 
    test profiling, nor would it be dramatically cleaner.
3316
 
    """
3317
 
 
3318
 
    def startTest(self, test):
3319
 
        self.profiler = bzrlib.lsprof.BzrProfiler()
3320
 
        self.profiler.start()
3321
 
        ForwardingResult.startTest(self, test)
3322
 
 
3323
 
    def addSuccess(self, test):
3324
 
        stats = self.profiler.stop()
3325
 
        try:
3326
 
            calls = test._benchcalls
3327
 
        except AttributeError:
3328
 
            test._benchcalls = []
3329
 
            calls = test._benchcalls
3330
 
        calls.append(((test.id(), "", ""), stats))
3331
 
        ForwardingResult.addSuccess(self, test)
3332
 
 
3333
 
    def stopTest(self, test):
3334
 
        ForwardingResult.stopTest(self, test)
3335
 
        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
3336
3186
 
3337
3187
 
3338
3188
# Controlled by "bzr selftest -E=..." option
3362
3212
             runner_class=None,
3363
3213
             suite_decorators=None,
3364
3214
             stream=None,
3365
 
             lsprof_tests=False,
3366
3215
             ):
3367
3216
    """Run the whole test suite under the enhanced runner"""
3368
3217
    # XXX: Very ugly way to do this...
3397
3246
        if starting_with:
3398
3247
            # But always filter as requested.
3399
3248
            suite = filter_suite_by_id_startswith(suite, starting_with)
3400
 
        result_decorators = []
3401
 
        if lsprof_tests:
3402
 
            result_decorators.append(ProfileResult)
3403
3249
        return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3404
3250
                     stop_on_failure=stop_on_failure,
3405
3251
                     transport=transport,
3413
3259
                     runner_class=runner_class,
3414
3260
                     suite_decorators=suite_decorators,
3415
3261
                     stream=stream,
3416
 
                     result_decorators=result_decorators,
3417
3262
                     )
3418
3263
    finally:
3419
3264
        default_transport = old_transport
3567
3412
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3568
3413
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3569
3414
 
3570
 
# 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
3571
3416
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3572
3417
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3573
3418
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3575
3420
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3576
3421
 
3577
3422
 
3578
 
def _test_suite_testmod_names():
3579
 
    """Return the standard list of test module names to test."""
3580
 
    return [
3581
 
        'bzrlib.doc',
3582
 
        'bzrlib.tests.blackbox',
3583
 
        'bzrlib.tests.commands',
3584
 
        'bzrlib.tests.per_branch',
3585
 
        'bzrlib.tests.per_bzrdir',
3586
 
        'bzrlib.tests.per_foreign_vcs',
3587
 
        'bzrlib.tests.per_interrepository',
3588
 
        'bzrlib.tests.per_intertree',
3589
 
        'bzrlib.tests.per_inventory',
3590
 
        'bzrlib.tests.per_interbranch',
3591
 
        'bzrlib.tests.per_lock',
3592
 
        'bzrlib.tests.per_merger',
3593
 
        'bzrlib.tests.per_transport',
3594
 
        'bzrlib.tests.per_tree',
3595
 
        'bzrlib.tests.per_pack_repository',
3596
 
        'bzrlib.tests.per_repository',
3597
 
        'bzrlib.tests.per_repository_chk',
3598
 
        'bzrlib.tests.per_repository_reference',
3599
 
        'bzrlib.tests.per_uifactory',
3600
 
        'bzrlib.tests.per_versionedfile',
3601
 
        'bzrlib.tests.per_workingtree',
3602
 
        'bzrlib.tests.test__annotator',
3603
 
        'bzrlib.tests.test__bencode',
3604
 
        'bzrlib.tests.test__chk_map',
3605
 
        'bzrlib.tests.test__dirstate_helpers',
3606
 
        'bzrlib.tests.test__groupcompress',
3607
 
        'bzrlib.tests.test__known_graph',
3608
 
        'bzrlib.tests.test__rio',
3609
 
        'bzrlib.tests.test__simple_set',
3610
 
        'bzrlib.tests.test__static_tuple',
3611
 
        'bzrlib.tests.test__walkdirs_win32',
3612
 
        'bzrlib.tests.test_ancestry',
3613
 
        'bzrlib.tests.test_annotate',
3614
 
        'bzrlib.tests.test_api',
3615
 
        'bzrlib.tests.test_atomicfile',
3616
 
        'bzrlib.tests.test_bad_files',
3617
 
        'bzrlib.tests.test_bisect_multi',
3618
 
        'bzrlib.tests.test_branch',
3619
 
        'bzrlib.tests.test_branchbuilder',
3620
 
        'bzrlib.tests.test_btree_index',
3621
 
        'bzrlib.tests.test_bugtracker',
3622
 
        'bzrlib.tests.test_bundle',
3623
 
        'bzrlib.tests.test_bzrdir',
3624
 
        'bzrlib.tests.test__chunks_to_lines',
3625
 
        'bzrlib.tests.test_cache_utf8',
3626
 
        'bzrlib.tests.test_chk_map',
3627
 
        'bzrlib.tests.test_chk_serializer',
3628
 
        'bzrlib.tests.test_chunk_writer',
3629
 
        'bzrlib.tests.test_clean_tree',
3630
 
        'bzrlib.tests.test_cleanup',
3631
 
        'bzrlib.tests.test_cmdline',
3632
 
        'bzrlib.tests.test_commands',
3633
 
        'bzrlib.tests.test_commit',
3634
 
        'bzrlib.tests.test_commit_merge',
3635
 
        'bzrlib.tests.test_config',
3636
 
        'bzrlib.tests.test_conflicts',
3637
 
        'bzrlib.tests.test_counted_lock',
3638
 
        'bzrlib.tests.test_crash',
3639
 
        'bzrlib.tests.test_decorators',
3640
 
        'bzrlib.tests.test_delta',
3641
 
        'bzrlib.tests.test_debug',
3642
 
        'bzrlib.tests.test_deprecated_graph',
3643
 
        'bzrlib.tests.test_diff',
3644
 
        'bzrlib.tests.test_directory_service',
3645
 
        'bzrlib.tests.test_dirstate',
3646
 
        'bzrlib.tests.test_email_message',
3647
 
        'bzrlib.tests.test_eol_filters',
3648
 
        'bzrlib.tests.test_errors',
3649
 
        'bzrlib.tests.test_export',
3650
 
        'bzrlib.tests.test_extract',
3651
 
        'bzrlib.tests.test_fetch',
3652
 
        'bzrlib.tests.test_fifo_cache',
3653
 
        'bzrlib.tests.test_filters',
3654
 
        'bzrlib.tests.test_ftp_transport',
3655
 
        'bzrlib.tests.test_foreign',
3656
 
        'bzrlib.tests.test_generate_docs',
3657
 
        'bzrlib.tests.test_generate_ids',
3658
 
        'bzrlib.tests.test_globbing',
3659
 
        'bzrlib.tests.test_gpg',
3660
 
        'bzrlib.tests.test_graph',
3661
 
        'bzrlib.tests.test_groupcompress',
3662
 
        'bzrlib.tests.test_hashcache',
3663
 
        'bzrlib.tests.test_help',
3664
 
        'bzrlib.tests.test_hooks',
3665
 
        'bzrlib.tests.test_http',
3666
 
        'bzrlib.tests.test_http_response',
3667
 
        'bzrlib.tests.test_https_ca_bundle',
3668
 
        'bzrlib.tests.test_identitymap',
3669
 
        'bzrlib.tests.test_ignores',
3670
 
        'bzrlib.tests.test_index',
3671
 
        'bzrlib.tests.test_import_tariff',
3672
 
        'bzrlib.tests.test_info',
3673
 
        'bzrlib.tests.test_inv',
3674
 
        'bzrlib.tests.test_inventory_delta',
3675
 
        'bzrlib.tests.test_knit',
3676
 
        'bzrlib.tests.test_lazy_import',
3677
 
        'bzrlib.tests.test_lazy_regex',
3678
 
        'bzrlib.tests.test_lock',
3679
 
        'bzrlib.tests.test_lockable_files',
3680
 
        'bzrlib.tests.test_lockdir',
3681
 
        'bzrlib.tests.test_log',
3682
 
        'bzrlib.tests.test_lru_cache',
3683
 
        'bzrlib.tests.test_lsprof',
3684
 
        'bzrlib.tests.test_mail_client',
3685
 
        'bzrlib.tests.test_memorytree',
3686
 
        'bzrlib.tests.test_merge',
3687
 
        'bzrlib.tests.test_merge3',
3688
 
        'bzrlib.tests.test_merge_core',
3689
 
        'bzrlib.tests.test_merge_directive',
3690
 
        'bzrlib.tests.test_missing',
3691
 
        'bzrlib.tests.test_msgeditor',
3692
 
        'bzrlib.tests.test_multiparent',
3693
 
        'bzrlib.tests.test_mutabletree',
3694
 
        'bzrlib.tests.test_nonascii',
3695
 
        'bzrlib.tests.test_options',
3696
 
        'bzrlib.tests.test_osutils',
3697
 
        'bzrlib.tests.test_osutils_encodings',
3698
 
        'bzrlib.tests.test_pack',
3699
 
        'bzrlib.tests.test_patch',
3700
 
        'bzrlib.tests.test_patches',
3701
 
        'bzrlib.tests.test_permissions',
3702
 
        'bzrlib.tests.test_plugins',
3703
 
        'bzrlib.tests.test_progress',
3704
 
        'bzrlib.tests.test_read_bundle',
3705
 
        'bzrlib.tests.test_reconcile',
3706
 
        'bzrlib.tests.test_reconfigure',
3707
 
        'bzrlib.tests.test_registry',
3708
 
        'bzrlib.tests.test_remote',
3709
 
        'bzrlib.tests.test_rename_map',
3710
 
        'bzrlib.tests.test_repository',
3711
 
        'bzrlib.tests.test_revert',
3712
 
        'bzrlib.tests.test_revision',
3713
 
        'bzrlib.tests.test_revisionspec',
3714
 
        'bzrlib.tests.test_revisiontree',
3715
 
        'bzrlib.tests.test_rio',
3716
 
        'bzrlib.tests.test_rules',
3717
 
        'bzrlib.tests.test_sampler',
3718
 
        'bzrlib.tests.test_script',
3719
 
        'bzrlib.tests.test_selftest',
3720
 
        'bzrlib.tests.test_serializer',
3721
 
        'bzrlib.tests.test_setup',
3722
 
        'bzrlib.tests.test_sftp_transport',
3723
 
        'bzrlib.tests.test_shelf',
3724
 
        'bzrlib.tests.test_shelf_ui',
3725
 
        'bzrlib.tests.test_smart',
3726
 
        'bzrlib.tests.test_smart_add',
3727
 
        'bzrlib.tests.test_smart_request',
3728
 
        'bzrlib.tests.test_smart_transport',
3729
 
        'bzrlib.tests.test_smtp_connection',
3730
 
        'bzrlib.tests.test_source',
3731
 
        'bzrlib.tests.test_ssh_transport',
3732
 
        'bzrlib.tests.test_status',
3733
 
        'bzrlib.tests.test_store',
3734
 
        'bzrlib.tests.test_strace',
3735
 
        'bzrlib.tests.test_subsume',
3736
 
        'bzrlib.tests.test_switch',
3737
 
        'bzrlib.tests.test_symbol_versioning',
3738
 
        'bzrlib.tests.test_tag',
3739
 
        'bzrlib.tests.test_testament',
3740
 
        'bzrlib.tests.test_textfile',
3741
 
        'bzrlib.tests.test_textmerge',
3742
 
        'bzrlib.tests.test_timestamp',
3743
 
        'bzrlib.tests.test_trace',
3744
 
        'bzrlib.tests.test_transactions',
3745
 
        'bzrlib.tests.test_transform',
3746
 
        'bzrlib.tests.test_transport',
3747
 
        'bzrlib.tests.test_transport_log',
3748
 
        'bzrlib.tests.test_tree',
3749
 
        'bzrlib.tests.test_treebuilder',
3750
 
        'bzrlib.tests.test_tsort',
3751
 
        'bzrlib.tests.test_tuned_gzip',
3752
 
        'bzrlib.tests.test_ui',
3753
 
        'bzrlib.tests.test_uncommit',
3754
 
        'bzrlib.tests.test_upgrade',
3755
 
        'bzrlib.tests.test_upgrade_stacked',
3756
 
        'bzrlib.tests.test_urlutils',
3757
 
        'bzrlib.tests.test_version',
3758
 
        'bzrlib.tests.test_version_info',
3759
 
        'bzrlib.tests.test_weave',
3760
 
        'bzrlib.tests.test_whitebox',
3761
 
        'bzrlib.tests.test_win32utils',
3762
 
        'bzrlib.tests.test_workingtree',
3763
 
        'bzrlib.tests.test_workingtree_4',
3764
 
        'bzrlib.tests.test_wsgi',
3765
 
        'bzrlib.tests.test_xml',
3766
 
        ]
3767
 
 
3768
 
 
3769
 
def _test_suite_modules_to_doctest():
3770
 
    """Return the list of modules to doctest."""   
3771
 
    return [
3772
 
        'bzrlib',
3773
 
        'bzrlib.branchbuilder',
3774
 
        'bzrlib.decorators',
3775
 
        'bzrlib.export',
3776
 
        'bzrlib.inventory',
3777
 
        'bzrlib.iterablefile',
3778
 
        'bzrlib.lockdir',
3779
 
        'bzrlib.merge3',
3780
 
        'bzrlib.option',
3781
 
        'bzrlib.symbol_versioning',
3782
 
        'bzrlib.tests',
3783
 
        'bzrlib.timestamp',
3784
 
        'bzrlib.version_info_formats.format_custom',
3785
 
        ]
3786
 
 
3787
 
 
3788
3423
def test_suite(keep_only=None, starting_with=None):
3789
3424
    """Build and return TestSuite for the whole of bzrlib.
3790
3425
 
3796
3431
    This function can be replaced if you need to change the default test
3797
3432
    suite on a global basis, but it is not encouraged.
3798
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
                   ]
3799
3612
 
3800
3613
    loader = TestUtil.TestLoader()
3801
3614
 
3830
3643
    suite = loader.suiteClass()
3831
3644
 
3832
3645
    # modules building their suite with loadTestsFromModuleNames
3833
 
    suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3834
 
 
3835
 
    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:
3836
3664
        if not interesting_module(mod):
3837
3665
            # No tests to keep here, move along
3838
3666
            continue
3979
3807
    :param new_id: The id to assign to it.
3980
3808
    :return: The new test.
3981
3809
    """
3982
 
    new_test = copy(test)
 
3810
    from copy import deepcopy
 
3811
    new_test = deepcopy(test)
3983
3812
    new_test.id = lambda: new_id
3984
3813
    return new_test
3985
3814
 
3986
3815
 
3987
 
def permute_tests_for_extension(standard_tests, loader, py_module_name,
3988
 
                                ext_module_name):
3989
 
    """Helper for permutating tests against an extension module.
3990
 
 
3991
 
    This is meant to be used inside a modules 'load_tests()' function. It will
3992
 
    create 2 scenarios, and cause all tests in the 'standard_tests' to be run
3993
 
    against both implementations. Setting 'test.module' to the appropriate
3994
 
    module. See bzrlib.tests.test__chk_map.load_tests as an example.
3995
 
 
3996
 
    :param standard_tests: A test suite to permute
3997
 
    :param loader: A TestLoader
3998
 
    :param py_module_name: The python path to a python module that can always
3999
 
        be loaded, and will be considered the 'python' implementation. (eg
4000
 
        'bzrlib._chk_map_py')
4001
 
    :param ext_module_name: The python path to an extension module. If the
4002
 
        module cannot be loaded, a single test will be added, which notes that
4003
 
        the module is not available. If it can be loaded, all standard_tests
4004
 
        will be run against that module.
4005
 
    :return: (suite, feature) suite is a test-suite that has all the permuted
4006
 
        tests. feature is the Feature object that can be used to determine if
4007
 
        the module is available.
4008
 
    """
4009
 
 
4010
 
    py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4011
 
    scenarios = [
4012
 
        ('python', {'module': py_module}),
4013
 
    ]
4014
 
    suite = loader.suiteClass()
4015
 
    feature = ModuleAvailableFeature(ext_module_name)
4016
 
    if feature.available():
4017
 
        scenarios.append(('C', {'module': feature.module}))
4018
 
    else:
4019
 
        # the compiled module isn't available, so we add a failing test
4020
 
        class FailWithoutFeature(TestCase):
4021
 
            def test_fail(self):
4022
 
                self.requireFeature(feature)
4023
 
        suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4024
 
    result = multiply_tests(standard_tests, scenarios, suite)
4025
 
    return result, feature
4026
 
 
4027
 
 
4028
 
def _rmtree_temp_dir(dirname, test_id=None):
 
3816
def _rmtree_temp_dir(dirname):
4029
3817
    # If LANG=C we probably have created some bogus paths
4030
3818
    # which rmtree(unicode) will fail to delete
4031
3819
    # so make sure we are using rmtree(str) to delete everything
4043
3831
        # We don't want to fail here because some useful display will be lost
4044
3832
        # otherwise. Polluting the tmp dir is bad, but not giving all the
4045
3833
        # possible info to the test runner is even worse.
4046
 
        if test_id != None:
4047
 
            ui.ui_factory.clear_term()
4048
 
            sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4049
3834
        sys.stderr.write('Unable to remove testing dir %s\n%s'
4050
3835
                         % (os.path.basename(dirname), e))
4051
3836
 
4135
3920
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4136
3921
 
4137
3922
 
4138
 
class _CompatabilityThunkFeature(Feature):
4139
 
    """This feature is just a thunk to another feature.
4140
 
 
4141
 
    It issues a deprecation warning if it is accessed, to let you know that you
4142
 
    should really use a different feature.
4143
 
    """
4144
 
 
4145
 
    def __init__(self, dep_version, module, name,
4146
 
                 replacement_name, replacement_module=None):
4147
 
        super(_CompatabilityThunkFeature, self).__init__()
4148
 
        self._module = module
4149
 
        if replacement_module is None:
4150
 
            replacement_module = module
4151
 
        self._replacement_module = replacement_module
4152
 
        self._name = name
4153
 
        self._replacement_name = replacement_name
4154
 
        self._dep_version = dep_version
4155
 
        self._feature = None
4156
 
 
4157
 
    def _ensure(self):
4158
 
        if self._feature is None:
4159
 
            depr_msg = self._dep_version % ('%s.%s'
4160
 
                                            % (self._module, self._name))
4161
 
            use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4162
 
                                               self._replacement_name)
4163
 
            symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4164
 
            # Import the new feature and use it as a replacement for the
4165
 
            # deprecated one.
4166
 
            mod = __import__(self._replacement_module, {}, {},
4167
 
                             [self._replacement_name])
4168
 
            self._feature = getattr(mod, self._replacement_name)
4169
 
 
4170
 
    def _probe(self):
4171
 
        self._ensure()
4172
 
        return self._feature._probe()
4173
 
 
4174
 
 
4175
 
class ModuleAvailableFeature(Feature):
4176
 
    """This is a feature than describes a module we want to be available.
4177
 
 
4178
 
    Declare the name of the module in __init__(), and then after probing, the
4179
 
    module will be available as 'self.module'.
4180
 
 
4181
 
    :ivar module: The module if it is available, else None.
4182
 
    """
4183
 
 
4184
 
    def __init__(self, module_name):
4185
 
        super(ModuleAvailableFeature, self).__init__()
4186
 
        self.module_name = module_name
4187
 
 
4188
 
    def _probe(self):
4189
 
        try:
4190
 
            self._module = __import__(self.module_name, {}, {}, [''])
4191
 
            return True
4192
 
        except ImportError:
4193
 
            return False
4194
 
 
4195
 
    @property
4196
 
    def module(self):
4197
 
        if self.available(): # Make sure the probe has been done
4198
 
            return self._module
4199
 
        return None
4200
 
 
4201
 
    def feature_name(self):
4202
 
        return self.module_name
4203
 
 
4204
 
 
4205
 
# This is kept here for compatibility, it is recommended to use
4206
 
# 'bzrlib.tests.feature.paramiko' instead
4207
 
ParamikoFeature = _CompatabilityThunkFeature(
4208
 
    deprecated_in((2,1,0)),
4209
 
    'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4210
 
 
4211
 
 
4212
3923
def probe_unicode_in_user_encoding():
4213
3924
    """Try to encode several unicode strings to use in unicode-aware tests.
4214
3925
    Return first successfull match.
4294
4005
UTF8Filesystem = _UTF8Filesystem()
4295
4006
 
4296
4007
 
4297
 
class _BreakinFeature(Feature):
4298
 
    """Does this platform support the breakin feature?"""
4299
 
 
4300
 
    def _probe(self):
4301
 
        from bzrlib import breakin
4302
 
        if breakin.determine_signal() is None:
4303
 
            return False
4304
 
        if sys.platform == 'win32':
4305
 
            # Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4306
 
            # We trigger SIGBREAK via a Console api so we need ctypes to
4307
 
            # access the function
4308
 
            try:
4309
 
                import ctypes
4310
 
            except OSError:
4311
 
                return False
4312
 
        return True
4313
 
 
4314
 
    def feature_name(self):
4315
 
        return "SIGQUIT or SIGBREAK w/ctypes on win32"
4316
 
 
4317
 
 
4318
 
BreakinFeature = _BreakinFeature()
4319
 
 
4320
 
 
4321
4008
class _CaseInsCasePresFilenameFeature(Feature):
4322
4009
    """Is the file-system case insensitive, but case-preserving?"""
4323
4010
 
4373
4060
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4374
4061
 
4375
4062
 
4376
 
class _CaseSensitiveFilesystemFeature(Feature):
 
4063
class _SubUnitFeature(Feature):
 
4064
    """Check if subunit is available."""
4377
4065
 
4378
4066
    def _probe(self):
4379
 
        if CaseInsCasePresFilenameFeature.available():
4380
 
            return False
4381
 
        elif CaseInsensitiveFilesystemFeature.available():
4382
 
            return False
4383
 
        else:
 
4067
        try:
 
4068
            import subunit
4384
4069
            return True
 
4070
        except ImportError:
 
4071
            return False
4385
4072
 
4386
4073
    def feature_name(self):
4387
 
        return 'case-sensitive filesystem'
4388
 
 
4389
 
# new coding style is for feature instances to be lowercase
4390
 
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4391
 
 
4392
 
 
4393
 
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4394
 
SubUnitFeature = _CompatabilityThunkFeature(
4395
 
    deprecated_in((2,1,0)),
4396
 
    'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
 
4074
        return 'subunit'
 
4075
 
 
4076
SubUnitFeature = _SubUnitFeature()
4397
4077
# Only define SubUnitBzrRunner if subunit is available.
4398
4078
try:
4399
4079
    from subunit import TestProtocolClient
4400
 
    from subunit.test_results import AutoTimingTestResultDecorator
 
4080
    try:
 
4081
        from subunit.test_results import AutoTimingTestResultDecorator
 
4082
    except ImportError:
 
4083
        AutoTimingTestResultDecorator = lambda x:x
4401
4084
    class SubUnitBzrRunner(TextTestRunner):
4402
4085
        def run(self, test):
4403
4086
            result = AutoTimingTestResultDecorator(