/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Martin Pool
  • Date: 2009-08-20 04:57:58 UTC
  • mto: This revision was merged to the branch mainline in revision 4632.
  • Revision ID: mbp@sourcefrog.net-20090820045758-dop6muwnabugxyp2
Give ApportFeature a nicer name

Show diffs side-by-side

added added

removed removed

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