/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: John Arbash Meinel
  • Date: 2009-12-15 19:59:00 UTC
  • mfrom: (4634.108.2 2.0)
  • mto: This revision was merged to the branch mainline in revision 4900.
  • Revision ID: john@arbash-meinel.com-20091215195900-fvgxdv9ycbrnzp1o
merge the 2.0.4 branch into 2.1.0b5

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
47
46
import tempfile
48
47
import threading
49
48
import time
50
 
import traceback
51
49
import unittest
52
50
import warnings
53
51
 
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
52
 
62
53
from bzrlib import (
63
54
    branchbuilder,
97
88
from bzrlib.symbol_versioning import (
98
89
    DEPRECATED_PARAMETER,
99
90
    deprecated_function,
100
 
    deprecated_in,
101
91
    deprecated_method,
102
92
    deprecated_passed,
103
93
    )
104
94
import bzrlib.trace
105
 
from bzrlib.transport import (
106
 
    get_transport,
107
 
    memory,
108
 
    pathfilter,
109
 
    )
 
95
from bzrlib.transport import get_transport, pathfilter
110
96
import bzrlib.transport
 
97
from bzrlib.transport.local import LocalURLServer
 
98
from bzrlib.transport.memory import MemoryServer
 
99
from bzrlib.transport.readonly import ReadonlyServer
111
100
from bzrlib.trace import mutter, note
112
 
from bzrlib.tests import (
113
 
    test_server,
114
 
    TestUtil,
115
 
    )
 
101
from bzrlib.tests import TestUtil
116
102
from bzrlib.tests.http_server import HttpServer
117
103
from bzrlib.tests.TestUtil import (
118
104
                          TestSuite,
129
115
# shown frame is the test code, not our assertXYZ.
130
116
__unittest = 1
131
117
 
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
 
 
 
118
default_transport = LocalURLServer
138
119
 
139
120
# Subunit result codes, defined here to prevent a hard dependency on subunit.
140
121
SUBUNIT_SEEK_SET = 0
247
228
                '%d non-main threads were left active in the end.\n'
248
229
                % (TestCase._active_threads - 1))
249
230
 
250
 
    def getDescription(self, test):
251
 
        return test.id()
252
 
 
253
 
    def _extractBenchmarkTime(self, testCase, details=None):
 
231
    def _extractBenchmarkTime(self, testCase):
254
232
        """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
233
        return getattr(testCase, "_benchtime", None)
258
234
 
259
235
    def _elapsedTestTimeString(self):
293
269
        else:
294
270
            bzr_path = sys.executable
295
271
        self.stream.write(
296
 
            'bzr selftest: %s\n' % (bzr_path,))
 
272
            'testing: %s\n' % (bzr_path,))
297
273
        self.stream.write(
298
274
            '   %s\n' % (
299
275
                    bzrlib.__path__[0],))
344
320
            self.stop()
345
321
        self._cleanupLogFile(test)
346
322
 
347
 
    def addSuccess(self, test, details=None):
 
323
    def addSuccess(self, test):
348
324
        """Tell result that test completed successfully.
349
325
 
350
326
        Called from the TestCase run()
351
327
        """
352
328
        if self._bench_history is not None:
353
 
            benchmark_time = self._extractBenchmarkTime(test, details)
 
329
            benchmark_time = self._extractBenchmarkTime(test)
354
330
            if benchmark_time is not None:
355
331
                self._bench_history.write("%s %s\n" % (
356
332
                    self._formatTime(benchmark_time),
386
362
        self.not_applicable_count += 1
387
363
        self.report_not_applicable(test, reason)
388
364
 
 
365
    def printErrorList(self, flavour, errors):
 
366
        for test, err in errors:
 
367
            self.stream.writeln(self.separator1)
 
368
            self.stream.write("%s: " % flavour)
 
369
            self.stream.writeln(self.getDescription(test))
 
370
            if getattr(test, '_get_log', None) is not None:
 
371
                log_contents = test._get_log()
 
372
                if log_contents:
 
373
                    self.stream.write('\n')
 
374
                    self.stream.write(
 
375
                            ('vvvv[log from %s]' % test.id()).ljust(78,'-'))
 
376
                    self.stream.write('\n')
 
377
                    self.stream.write(log_contents)
 
378
                    self.stream.write('\n')
 
379
                    self.stream.write(
 
380
                            ('^^^^[log from %s]' % test.id()).ljust(78,'-'))
 
381
                    self.stream.write('\n')
 
382
            self.stream.writeln(self.separator2)
 
383
            self.stream.writeln("%s" % err)
 
384
 
389
385
    def _post_mortem(self):
390
386
        """Start a PDB post mortem session."""
391
387
        if os.environ.get('BZR_TEST_PDB', None):
471
467
            a += '%dm%ds' % (runtime / 60, runtime % 60)
472
468
        else:
473
469
            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
 
470
        if self.error_count:
 
471
            a += ', %d err' % self.error_count
 
472
        if self.failure_count:
 
473
            a += ', %d fail' % self.failure_count
477
474
        # if self.unsupported:
478
475
        #     a += ', %d missing' % len(self.unsupported)
479
476
        a += ']'
490
487
        return self._shortened_test_description(test)
491
488
 
492
489
    def report_error(self, test, err):
493
 
        self.stream.write('ERROR: %s\n    %s\n' % (
 
490
        ui.ui_factory.note('ERROR: %s\n    %s\n' % (
494
491
            self._test_description(test),
495
492
            err[1],
496
493
            ))
497
494
 
498
495
    def report_failure(self, test, err):
499
 
        self.stream.write('FAIL: %s\n    %s\n' % (
 
496
        ui.ui_factory.note('FAIL: %s\n    %s\n' % (
500
497
            self._test_description(test),
501
498
            err[1],
502
499
            ))
503
500
 
504
501
    def report_known_failure(self, test, err):
505
 
        pass
 
502
        ui.ui_factory.note('XFAIL: %s\n%s\n' % (
 
503
            self._test_description(test), err[1]))
506
504
 
507
505
    def report_skip(self, test, reason):
508
506
        pass
606
604
            applied left to right - the first element in the list is the 
607
605
            innermost decorator.
608
606
        """
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
607
        self.stream = unittest._WritelnDecorator(stream)
623
608
        self.descriptions = descriptions
624
609
        self.verbosity = verbosity
644
629
        for decorator in self._result_decorators:
645
630
            result = decorator(result)
646
631
            result.stop_early = self.stop_on_failure
 
632
        try:
 
633
            import testtools
 
634
        except ImportError:
 
635
            pass
 
636
        else:
 
637
            if isinstance(test, testtools.ConcurrentTestSuite):
 
638
                # We need to catch bzr specific behaviors
 
639
                result = BZRTransformingResult(result)
647
640
        result.startTestRun()
648
641
        try:
649
642
            test.run(result)
667
660
                        % (type(suite), suite))
668
661
 
669
662
 
670
 
TestSkipped = testtools.testcase.TestSkipped
 
663
class TestSkipped(Exception):
 
664
    """Indicates that a test was intentionally skipped, rather than failing."""
671
665
 
672
666
 
673
667
class TestNotApplicable(TestSkipped):
679
673
    """
680
674
 
681
675
 
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
 
676
class KnownFailure(AssertionError):
 
677
    """Indicates that a test failed in a precisely expected manner.
 
678
 
 
679
    Such failures dont block the whole test suite from passing because they are
 
680
    indicators of partially completed code or of future work. We have an
 
681
    explicit error for them so that we can ensure that they are always visible:
 
682
    KnownFailures are always shown in the output of bzr selftest.
 
683
    """
699
684
 
700
685
 
701
686
class UnavailableFeature(Exception):
707
692
    """
708
693
 
709
694
 
 
695
class CommandFailed(Exception):
 
696
    pass
 
697
 
 
698
 
710
699
class StringIOWrapper(object):
711
700
    """A wrapper around cStringIO which just adds an encoding attribute.
712
701
 
773
762
        return NullProgressView()
774
763
 
775
764
 
776
 
class TestCase(testtools.TestCase):
 
765
class TestCase(unittest.TestCase):
777
766
    """Base class for bzr unit tests.
778
767
 
779
768
    Tests that need access to disk resources should subclass
798
787
    _leaking_threads_tests = 0
799
788
    _first_thread_leaker_id = None
800
789
    _log_file_name = None
 
790
    _log_contents = ''
 
791
    _keep_log_file = False
801
792
    # record lsprof data when performing benchmark calls.
802
793
    _gather_lsprof_in_benchmarks = False
 
794
    attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
 
795
                     '_log_contents', '_log_file_name', '_benchtime',
 
796
                     '_TestCase__testMethodName', '_TestCase__testMethodDoc',)
803
797
 
804
798
    def __init__(self, methodName='testMethod'):
805
799
        super(TestCase, self).__init__(methodName)
806
800
        self._cleanups = []
 
801
        self._bzr_test_setUp_run = False
 
802
        self._bzr_test_tearDown_run = False
807
803
        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))
812
804
 
813
805
    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)]))
 
806
        unittest.TestCase.setUp(self)
 
807
        self._bzr_test_setUp_run = True
821
808
        self._cleanEnvironment()
822
809
        self._silenceUI()
823
810
        self._startLogFile()
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
849
        if 'disable_lock_checks' not in selftest_debug_flags:
864
850
            debug.debug_flags.add('strict_locks')
 
851
        self.addCleanup(self._restore_debug_flags)
865
852
 
866
853
    def _clear_hooks(self):
867
854
        # prevent hooks affecting tests
888
875
    def _silenceUI(self):
889
876
        """Turn off UI for duration of test"""
890
877
        # by default the UI is off; tests can turn it on if they want it.
891
 
        self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
 
878
        saved = ui.ui_factory
 
879
        def _restore():
 
880
            ui.ui_factory = saved
 
881
        ui.ui_factory = ui.SilentUIFactory()
 
882
        self.addCleanup(_restore)
892
883
 
893
884
    def _check_locks(self):
894
885
        """Check that all lock take/release actions have been paired."""
923
914
            self._lock_check_thorough = False
924
915
        else:
925
916
            self._lock_check_thorough = True
926
 
 
 
917
            
927
918
        self.addCleanup(self._check_locks)
928
919
        _mod_lock.Lock.hooks.install_named_hook('lock_acquired',
929
920
                                                self._lock_acquired, None)
1022
1013
        server's urls to be used.
1023
1014
        """
1024
1015
        if backing_server is None:
1025
 
            transport_server.start_server()
 
1016
            transport_server.setUp()
1026
1017
        else:
1027
 
            transport_server.start_server(backing_server)
1028
 
        self.addCleanup(transport_server.stop_server)
 
1018
            transport_server.setUp(backing_server)
 
1019
        self.addCleanup(transport_server.tearDown)
1029
1020
        # Obtain a real transport because if the server supplies a password, it
1030
1021
        # will be hidden from the base on the client side.
1031
1022
        t = get_transport(transport_server.get_url())
1045
1036
        if t.base.endswith('/work/'):
1046
1037
            # we have safety net/test root/work
1047
1038
            t = t.clone('../..')
1048
 
        elif isinstance(transport_server,
1049
 
                        test_server.SmartTCPServer_for_testing):
 
1039
        elif isinstance(transport_server, server.SmartTCPServer_for_testing):
1050
1040
            # The smart server adds a path similar to work, which is traversed
1051
1041
            # up from by the client. But the server is chrooted - the actual
1052
1042
            # backing transport is not escaped from, and VFS requests to the
1207
1197
            raise AssertionError('pattern "%s" found in "%s"'
1208
1198
                    % (needle_re, haystack))
1209
1199
 
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
1200
    def assertSubset(self, sublist, superlist):
1215
1201
        """Assert that every entry in sublist is present in superlist."""
1216
1202
        missing = set(sublist) - set(superlist)
1303
1289
                m += ": " + msg
1304
1290
            self.fail(m)
1305
1291
 
 
1292
    def expectFailure(self, reason, assertion, *args, **kwargs):
 
1293
        """Invoke a test, expecting it to fail for the given reason.
 
1294
 
 
1295
        This is for assertions that ought to succeed, but currently fail.
 
1296
        (The failure is *expected* but not *wanted*.)  Please be very precise
 
1297
        about the failure you're expecting.  If a new bug is introduced,
 
1298
        AssertionError should be raised, not KnownFailure.
 
1299
 
 
1300
        Frequently, expectFailure should be followed by an opposite assertion.
 
1301
        See example below.
 
1302
 
 
1303
        Intended to be used with a callable that raises AssertionError as the
 
1304
        'assertion' parameter.  args and kwargs are passed to the 'assertion'.
 
1305
 
 
1306
        Raises KnownFailure if the test fails.  Raises AssertionError if the
 
1307
        test succeeds.
 
1308
 
 
1309
        example usage::
 
1310
 
 
1311
          self.expectFailure('Math is broken', self.assertNotEqual, 54,
 
1312
                             dynamic_val)
 
1313
          self.assertEqual(42, dynamic_val)
 
1314
 
 
1315
          This means that a dynamic_val of 54 will cause the test to raise
 
1316
          a KnownFailure.  Once math is fixed and the expectFailure is removed,
 
1317
          only a dynamic_val of 42 will allow the test to pass.  Anything other
 
1318
          than 54 or 42 will cause an AssertionError.
 
1319
        """
 
1320
        try:
 
1321
            assertion(*args, **kwargs)
 
1322
        except AssertionError:
 
1323
            raise KnownFailure(reason)
 
1324
        else:
 
1325
            self.fail('Unexpected success.  Should have failed: %s' % reason)
 
1326
 
1306
1327
    def assertFileEqual(self, content, path):
1307
1328
        """Fail if path does not contain 'content'."""
1308
1329
        self.failUnlessExists(path)
1313
1334
            f.close()
1314
1335
        self.assertEqualDiff(content, s)
1315
1336
 
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
1337
    def failUnlessExists(self, path):
1325
1338
        """Fail unless path or paths, which may be abs or relative, exist."""
1326
1339
        if not isinstance(path, basestring):
1466
1479
 
1467
1480
        Close the file and delete it, unless setKeepLogfile was called.
1468
1481
        """
1469
 
        if bzrlib.trace._trace_file:
1470
 
            # flush the log file, to get all content
1471
 
            bzrlib.trace._trace_file.flush()
 
1482
        if self._log_file is None:
 
1483
            return
1472
1484
        bzrlib.trace.pop_log_file(self._log_memento)
1473
 
        # Cache the log result and delete the file on disk
1474
 
        self._get_log(False)
 
1485
        self._log_file.close()
 
1486
        self._log_file = None
 
1487
        if not self._keep_log_file:
 
1488
            os.remove(self._log_file_name)
 
1489
            self._log_file_name = None
 
1490
 
 
1491
    def setKeepLogfile(self):
 
1492
        """Make the logfile not be deleted when _finishLogFile is called."""
 
1493
        self._keep_log_file = True
1475
1494
 
1476
1495
    def thisFailsStrictLockCheck(self):
1477
1496
        """It is known that this test would fail with -Dstrict_locks.
1494
1513
        """
1495
1514
        self._cleanups.append((callable, args, kwargs))
1496
1515
 
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
1516
    def _cleanEnvironment(self):
1517
1517
        new_env = {
1518
1518
            'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1528
1528
            'BZR_PROGRESS_BAR': None,
1529
1529
            'BZR_LOG': None,
1530
1530
            'BZR_PLUGIN_PATH': None,
1531
 
            'BZR_DISABLE_PLUGINS': None,
1532
 
            'BZR_PLUGINS_AT': None,
1533
1531
            'BZR_CONCURRENCY': None,
1534
1532
            # Make sure that any text ui tests are consistent regardless of
1535
1533
            # the environment the test case is run in; you may want tests that
1556
1554
            'ftp_proxy': None,
1557
1555
            'FTP_PROXY': None,
1558
1556
            '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
1557
        }
1565
 
        self._old_env = {}
 
1558
        self.__old_env = {}
1566
1559
        self.addCleanup(self._restoreEnvironment)
1567
1560
        for name, value in new_env.iteritems():
1568
1561
            self._captureVar(name, value)
1569
1562
 
1570
1563
    def _captureVar(self, name, newvalue):
1571
1564
        """Set an environment variable, and reset it when finished."""
1572
 
        self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1565
        self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1566
 
 
1567
    def _restore_debug_flags(self):
 
1568
        debug.debug_flags.clear()
 
1569
        debug.debug_flags.update(self._preserved_debug_flags)
1573
1570
 
1574
1571
    def _restoreEnvironment(self):
1575
 
        for name, value in self._old_env.iteritems():
 
1572
        for name, value in self.__old_env.iteritems():
1576
1573
            osutils.set_or_unset_env(name, value)
1577
1574
 
1578
1575
    def _restoreHooks(self):
1590
1587
        else:
1591
1588
            addSkip(self, reason)
1592
1589
 
1593
 
    @staticmethod
1594
 
    def _do_known_failure(self, result, e):
 
1590
    def _do_known_failure(self, result):
1595
1591
        err = sys.exc_info()
1596
1592
        addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1597
1593
        if addExpectedFailure is not None:
1599
1595
        else:
1600
1596
            result.addSuccess(self)
1601
1597
 
1602
 
    @staticmethod
1603
1598
    def _do_not_applicable(self, result, e):
1604
1599
        if not e.args:
1605
1600
            reason = 'No reason given'
1611
1606
        else:
1612
1607
            self._do_skip(result, reason)
1613
1608
 
1614
 
    @staticmethod
1615
 
    def _do_unsupported_or_skip(self, result, e):
1616
 
        reason = e.args[0]
 
1609
    def _do_unsupported_or_skip(self, result, reason):
1617
1610
        addNotSupported = getattr(result, 'addNotSupported', None)
1618
1611
        if addNotSupported is not None:
1619
1612
            result.addNotSupported(self, reason)
1620
1613
        else:
1621
1614
            self._do_skip(result, reason)
1622
1615
 
 
1616
    def run(self, result=None):
 
1617
        if result is None: result = self.defaultTestResult()
 
1618
        result.startTest(self)
 
1619
        try:
 
1620
            self._run(result)
 
1621
            return result
 
1622
        finally:
 
1623
            result.stopTest(self)
 
1624
 
 
1625
    def _run(self, result):
 
1626
        for feature in getattr(self, '_test_needs_features', []):
 
1627
            if not feature.available():
 
1628
                return self._do_unsupported_or_skip(result, feature)
 
1629
        try:
 
1630
            absent_attr = object()
 
1631
            # Python 2.5
 
1632
            method_name = getattr(self, '_testMethodName', absent_attr)
 
1633
            if method_name is absent_attr:
 
1634
                # Python 2.4
 
1635
                method_name = getattr(self, '_TestCase__testMethodName')
 
1636
            testMethod = getattr(self, method_name)
 
1637
            try:
 
1638
                try:
 
1639
                    self.setUp()
 
1640
                    if not self._bzr_test_setUp_run:
 
1641
                        self.fail(
 
1642
                            "test setUp did not invoke "
 
1643
                            "bzrlib.tests.TestCase's setUp")
 
1644
                except KeyboardInterrupt:
 
1645
                    self._runCleanups()
 
1646
                    raise
 
1647
                except KnownFailure:
 
1648
                    self._do_known_failure(result)
 
1649
                    self.tearDown()
 
1650
                    return
 
1651
                except TestNotApplicable, e:
 
1652
                    self._do_not_applicable(result, e)
 
1653
                    self.tearDown()
 
1654
                    return
 
1655
                except TestSkipped, e:
 
1656
                    self._do_skip(result, e.args[0])
 
1657
                    self.tearDown()
 
1658
                    return result
 
1659
                except UnavailableFeature, e:
 
1660
                    self._do_unsupported_or_skip(result, e.args[0])
 
1661
                    self.tearDown()
 
1662
                    return
 
1663
                except:
 
1664
                    result.addError(self, sys.exc_info())
 
1665
                    self._runCleanups()
 
1666
                    return result
 
1667
 
 
1668
                ok = False
 
1669
                try:
 
1670
                    testMethod()
 
1671
                    ok = True
 
1672
                except KnownFailure:
 
1673
                    self._do_known_failure(result)
 
1674
                except self.failureException:
 
1675
                    result.addFailure(self, sys.exc_info())
 
1676
                except TestNotApplicable, e:
 
1677
                    self._do_not_applicable(result, e)
 
1678
                except TestSkipped, e:
 
1679
                    if not e.args:
 
1680
                        reason = "No reason given."
 
1681
                    else:
 
1682
                        reason = e.args[0]
 
1683
                    self._do_skip(result, reason)
 
1684
                except UnavailableFeature, e:
 
1685
                    self._do_unsupported_or_skip(result, e.args[0])
 
1686
                except KeyboardInterrupt:
 
1687
                    self._runCleanups()
 
1688
                    raise
 
1689
                except:
 
1690
                    result.addError(self, sys.exc_info())
 
1691
 
 
1692
                try:
 
1693
                    self.tearDown()
 
1694
                    if not self._bzr_test_tearDown_run:
 
1695
                        self.fail(
 
1696
                            "test tearDown did not invoke "
 
1697
                            "bzrlib.tests.TestCase's tearDown")
 
1698
                except KeyboardInterrupt:
 
1699
                    self._runCleanups()
 
1700
                    raise
 
1701
                except:
 
1702
                    result.addError(self, sys.exc_info())
 
1703
                    self._runCleanups()
 
1704
                    ok = False
 
1705
                if ok: result.addSuccess(self)
 
1706
                return result
 
1707
            except KeyboardInterrupt:
 
1708
                self._runCleanups()
 
1709
                raise
 
1710
        finally:
 
1711
            saved_attrs = {}
 
1712
            for attr_name in self.attrs_to_keep:
 
1713
                if attr_name in self.__dict__:
 
1714
                    saved_attrs[attr_name] = self.__dict__[attr_name]
 
1715
            self.__dict__ = saved_attrs
 
1716
 
 
1717
    def tearDown(self):
 
1718
        self._runCleanups()
 
1719
        self._log_contents = ''
 
1720
        self._bzr_test_tearDown_run = True
 
1721
        unittest.TestCase.tearDown(self)
 
1722
 
1623
1723
    def time(self, callable, *args, **kwargs):
1624
1724
        """Run callable and accrue the time it takes to the benchmark time.
1625
1725
 
1628
1728
        self._benchcalls.
1629
1729
        """
1630
1730
        if self._benchtime is None:
1631
 
            self.addDetail('benchtime', content.Content(content.ContentType(
1632
 
                "text", "plain"), lambda:[str(self._benchtime)]))
1633
1731
            self._benchtime = 0
1634
1732
        start = time.time()
1635
1733
        try:
1644
1742
        finally:
1645
1743
            self._benchtime += time.time() - start
1646
1744
 
 
1745
    def _runCleanups(self):
 
1746
        """Run registered cleanup functions.
 
1747
 
 
1748
        This should only be called from TestCase.tearDown.
 
1749
        """
 
1750
        # TODO: Perhaps this should keep running cleanups even if
 
1751
        # one of them fails?
 
1752
 
 
1753
        # Actually pop the cleanups from the list so tearDown running
 
1754
        # twice is safe (this happens for skipped tests).
 
1755
        while self._cleanups:
 
1756
            cleanup, args, kwargs = self._cleanups.pop()
 
1757
            cleanup(*args, **kwargs)
 
1758
 
1647
1759
    def log(self, *args):
1648
1760
        mutter(*args)
1649
1761
 
1650
1762
    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.
 
1763
        """Get the log from bzrlib.trace calls from this test.
1655
1764
 
1656
1765
        :param keep_log_file: When True, if the log is still a file on disk
1657
1766
            leave it as a file on disk. When False, if the log is still a file
1659
1768
            self._log_contents.
1660
1769
        :return: A string containing the log.
1661
1770
        """
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')
 
1771
        # flush the log file, to get all content
 
1772
        import bzrlib.trace
 
1773
        if bzrlib.trace._trace_file:
 
1774
            bzrlib.trace._trace_file.flush()
 
1775
        if self._log_contents:
 
1776
            # XXX: this can hardly contain the content flushed above --vila
 
1777
            # 20080128
1668
1778
            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
1779
        if self._log_file_name is not None:
1674
1780
            logfile = open(self._log_file_name)
1675
1781
            try:
1676
1782
                log_contents = logfile.read()
1677
1783
            finally:
1678
1784
                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
1785
            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
1786
                self._log_contents = log_contents
1716
1787
                try:
1717
1788
                    os.remove(self._log_file_name)
1721
1792
                                             ' %r\n' % self._log_file_name))
1722
1793
                    else:
1723
1794
                        raise
1724
 
                self._log_file_name = None
1725
1795
            return log_contents
1726
1796
        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())
 
1797
            return "DELETED log file to reduce memory footprint"
1735
1798
 
1736
1799
    def requireFeature(self, feature):
1737
1800
        """This test requires a specific feature is available.
2100
2163
 
2101
2164
        Tests that expect to provoke LockContention errors should call this.
2102
2165
        """
2103
 
        self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
 
2166
        orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
 
2167
        def resetTimeout():
 
2168
            bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
 
2169
        self.addCleanup(resetTimeout)
 
2170
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2104
2171
 
2105
2172
    def make_utf8_encoded_stringio(self, encoding_type=None):
2106
2173
        """Return a StringIOWrapper instance, that will encode Unicode
2120
2187
        request_handlers = request.request_handlers
2121
2188
        orig_method = request_handlers.get(verb)
2122
2189
        request_handlers.remove(verb)
2123
 
        self.addCleanup(request_handlers.register, verb, orig_method)
 
2190
        def restoreVerb():
 
2191
            request_handlers.register(verb, orig_method)
 
2192
        self.addCleanup(restoreVerb)
2124
2193
 
2125
2194
 
2126
2195
class CapturedCall(object):
2217
2286
        if self.__readonly_server is None:
2218
2287
            if self.transport_readonly_server is None:
2219
2288
                # readonly decorator requested
2220
 
                self.__readonly_server = test_server.ReadonlyServer()
 
2289
                self.__readonly_server = ReadonlyServer()
2221
2290
            else:
2222
2291
                # explicit readonly transport.
2223
2292
                self.__readonly_server = self.create_transport_readonly_server()
2246
2315
        is no means to override it.
2247
2316
        """
2248
2317
        if self.__vfs_server is None:
2249
 
            self.__vfs_server = memory.MemoryServer()
 
2318
            self.__vfs_server = MemoryServer()
2250
2319
            self.start_server(self.__vfs_server)
2251
2320
        return self.__vfs_server
2252
2321
 
2409
2478
        return made_control.create_repository(shared=shared)
2410
2479
 
2411
2480
    def make_smart_server(self, path):
2412
 
        smart_server = test_server.SmartTCPServer_for_testing()
 
2481
        smart_server = server.SmartTCPServer_for_testing()
2413
2482
        self.start_server(smart_server, self.get_server())
2414
2483
        remote_transport = get_transport(smart_server.get_url()).clone(path)
2415
2484
        return remote_transport
2433
2502
    def setUp(self):
2434
2503
        super(TestCaseWithMemoryTransport, self).setUp()
2435
2504
        self._make_test_root()
2436
 
        self.addCleanup(os.chdir, os.getcwdu())
 
2505
        _currentdir = os.getcwdu()
 
2506
        def _leaveDirectory():
 
2507
            os.chdir(_currentdir)
 
2508
        self.addCleanup(_leaveDirectory)
2437
2509
        self.makeAndChdirToTestDir()
2438
2510
        self.overrideEnvironmentForTesting()
2439
2511
        self.__readonly_server = None
2442
2514
 
2443
2515
    def setup_smart_server_with_call_log(self):
2444
2516
        """Sets up a smart server as the transport server with a call log."""
2445
 
        self.transport_server = test_server.SmartTCPServer_for_testing
 
2517
        self.transport_server = server.SmartTCPServer_for_testing
2446
2518
        self.hpss_calls = []
2447
2519
        import traceback
2448
2520
        # Skip the current stack down to the caller of
2661
2733
            # We can only make working trees locally at the moment.  If the
2662
2734
            # transport can't support them, then we keep the non-disk-backed
2663
2735
            # branch and create a local checkout.
2664
 
            if self.vfs_transport_factory is test_server.LocalURLServer:
 
2736
            if self.vfs_transport_factory is LocalURLServer:
2665
2737
                # the branch is colocated on disk, we cannot create a checkout.
2666
2738
                # hopefully callers will expect this.
2667
2739
                local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2727
2799
 
2728
2800
    def setUp(self):
2729
2801
        super(ChrootedTestCase, self).setUp()
2730
 
        if not self.vfs_transport_factory == memory.MemoryServer:
 
2802
        if not self.vfs_transport_factory == MemoryServer:
2731
2803
            self.transport_readonly_server = HttpServer
2732
2804
 
2733
2805
 
3147
3219
        if self.randomised:
3148
3220
            return iter(self._tests)
3149
3221
        self.randomised = True
3150
 
        self.stream.write("Randomizing test order using seed %s\n\n" %
 
3222
        self.stream.writeln("Randomizing test order using seed %s\n" %
3151
3223
            (self.actual_seed()))
3152
3224
        # Initialise the random number generator.
3153
3225
        random.seed(self.actual_seed())
3201
3273
    return result
3202
3274
 
3203
3275
 
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
3276
def fork_for_tests(suite):
3218
3277
    """Take suite and start up one runner per CPU by forking()
3219
3278
 
3223
3282
    concurrency = osutils.local_concurrency()
3224
3283
    result = []
3225
3284
    from subunit import TestProtocolClient, ProtocolTestCase
3226
 
    from subunit.test_results import AutoTimingTestResultDecorator
3227
3285
    class TestInOtherProcess(ProtocolTestCase):
3228
3286
        # Should be in subunit, I think. RBC.
3229
3287
        def __init__(self, stream, pid):
3234
3292
            try:
3235
3293
                ProtocolTestCase.run(self, result)
3236
3294
            finally:
3237
 
                os.waitpid(self.pid, 0)
 
3295
                os.waitpid(self.pid, os.WNOHANG)
3238
3296
 
3239
3297
    test_blocks = partition_tests(suite, concurrency)
3240
3298
    for process_tests in test_blocks:
3243
3301
        c2pread, c2pwrite = os.pipe()
3244
3302
        pid = os.fork()
3245
3303
        if pid == 0:
3246
 
            workaround_zealous_crypto_random()
3247
3304
            try:
3248
3305
                os.close(c2pread)
3249
3306
                # Leave stderr and stdout open so we can see test noise
3253
3310
                sys.stdin.close()
3254
3311
                sys.stdin = None
3255
3312
                stream = os.fdopen(c2pwrite, 'wb', 1)
3256
 
                subunit_result = AutoTimingTestResultDecorator(
 
3313
                subunit_result = BzrAutoTimingTestResultDecorator(
3257
3314
                    TestProtocolClient(stream))
3258
3315
                process_suite.run(subunit_result)
3259
3316
            finally:
3351
3408
 
3352
3409
    def addFailure(self, test, err):
3353
3410
        self.result.addFailure(test, err)
3354
 
ForwardingResult = testtools.ExtendedToOriginalDecorator
 
3411
 
 
3412
 
 
3413
class BZRTransformingResult(ForwardingResult):
 
3414
 
 
3415
    def addError(self, test, err):
 
3416
        feature = self._error_looks_like('UnavailableFeature: ', err)
 
3417
        if feature is not None:
 
3418
            self.result.addNotSupported(test, feature)
 
3419
        else:
 
3420
            self.result.addError(test, err)
 
3421
 
 
3422
    def addFailure(self, test, err):
 
3423
        known = self._error_looks_like('KnownFailure: ', err)
 
3424
        if known is not None:
 
3425
            self.result.addExpectedFailure(test,
 
3426
                [KnownFailure, KnownFailure(known), None])
 
3427
        else:
 
3428
            self.result.addFailure(test, err)
 
3429
 
 
3430
    def _error_looks_like(self, prefix, err):
 
3431
        """Deserialize exception and returns the stringify value."""
 
3432
        import subunit
 
3433
        value = None
 
3434
        typ, exc, _ = err
 
3435
        if isinstance(exc, subunit.RemoteException):
 
3436
            # stringify the exception gives access to the remote traceback
 
3437
            # We search the last line for 'prefix'
 
3438
            lines = str(exc).split('\n')
 
3439
            while lines and not lines[-1]:
 
3440
                lines.pop(-1)
 
3441
            if lines:
 
3442
                if lines[-1].startswith(prefix):
 
3443
                    value = lines[-1][len(prefix):]
 
3444
        return value
 
3445
 
 
3446
 
 
3447
try:
 
3448
    from subunit.test_results import AutoTimingTestResultDecorator
 
3449
    # Expected failure should be seen as a success not a failure Once subunit
 
3450
    # provide native support for that, BZRTransformingResult and this class
 
3451
    # will become useless.
 
3452
    class BzrAutoTimingTestResultDecorator(AutoTimingTestResultDecorator):
 
3453
 
 
3454
        def addExpectedFailure(self, test, err):
 
3455
            self._before_event()
 
3456
            return self._call_maybe("addExpectedFailure", self._degrade_skip,
 
3457
                                    test, err)
 
3458
except ImportError:
 
3459
    # Let's just define a no-op decorator
 
3460
    BzrAutoTimingTestResultDecorator = lambda x:x
3355
3461
 
3356
3462
 
3357
3463
class ProfileResult(ForwardingResult):
3618
3724
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3619
3725
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3620
3726
 
3621
 
# Obvious highest levels prefixes, feel free to add your own via a plugin
 
3727
# Obvious higest levels prefixes, feel free to add your own via a plugin
3622
3728
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3623
3729
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3624
3730
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3634
3740
        'bzrlib.tests.commands',
3635
3741
        'bzrlib.tests.per_branch',
3636
3742
        'bzrlib.tests.per_bzrdir',
3637
 
        'bzrlib.tests.per_bzrdir_colo',
3638
3743
        'bzrlib.tests.per_foreign_vcs',
3639
3744
        'bzrlib.tests.per_interrepository',
3640
3745
        'bzrlib.tests.per_intertree',
3641
3746
        'bzrlib.tests.per_inventory',
3642
3747
        'bzrlib.tests.per_interbranch',
3643
3748
        'bzrlib.tests.per_lock',
3644
 
        'bzrlib.tests.per_merger',
3645
3749
        'bzrlib.tests.per_transport',
3646
3750
        'bzrlib.tests.per_tree',
3647
3751
        'bzrlib.tests.per_pack_repository',
3652
3756
        'bzrlib.tests.per_versionedfile',
3653
3757
        'bzrlib.tests.per_workingtree',
3654
3758
        'bzrlib.tests.test__annotator',
3655
 
        'bzrlib.tests.test__bencode',
3656
3759
        'bzrlib.tests.test__chk_map',
3657
3760
        'bzrlib.tests.test__dirstate_helpers',
3658
3761
        'bzrlib.tests.test__groupcompress',
3666
3769
        'bzrlib.tests.test_api',
3667
3770
        'bzrlib.tests.test_atomicfile',
3668
3771
        'bzrlib.tests.test_bad_files',
 
3772
        'bzrlib.tests.test_bencode',
3669
3773
        'bzrlib.tests.test_bisect_multi',
3670
3774
        'bzrlib.tests.test_branch',
3671
3775
        'bzrlib.tests.test_branchbuilder',
3680
3784
        'bzrlib.tests.test_chunk_writer',
3681
3785
        'bzrlib.tests.test_clean_tree',
3682
3786
        'bzrlib.tests.test_cleanup',
3683
 
        'bzrlib.tests.test_cmdline',
3684
3787
        'bzrlib.tests.test_commands',
3685
3788
        'bzrlib.tests.test_commit',
3686
3789
        'bzrlib.tests.test_commit_merge',
3720
3823
        'bzrlib.tests.test_identitymap',
3721
3824
        'bzrlib.tests.test_ignores',
3722
3825
        'bzrlib.tests.test_index',
3723
 
        'bzrlib.tests.test_import_tariff',
3724
3826
        'bzrlib.tests.test_info',
3725
3827
        'bzrlib.tests.test_inv',
3726
3828
        'bzrlib.tests.test_inventory_delta',
3734
3836
        'bzrlib.tests.test_lru_cache',
3735
3837
        'bzrlib.tests.test_lsprof',
3736
3838
        'bzrlib.tests.test_mail_client',
3737
 
        'bzrlib.tests.test_matchers',
3738
3839
        'bzrlib.tests.test_memorytree',
3739
3840
        'bzrlib.tests.test_merge',
3740
3841
        'bzrlib.tests.test_merge3',
3820
3921
 
3821
3922
 
3822
3923
def _test_suite_modules_to_doctest():
3823
 
    """Return the list of modules to doctest."""
3824
 
    if __doc__ is None:
3825
 
        # GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3826
 
        return []
 
3924
    """Return the list of modules to doctest."""   
3827
3925
    return [
3828
3926
        'bzrlib',
3829
3927
        'bzrlib.branchbuilder',
3830
 
        'bzrlib.decorators',
3831
3928
        'bzrlib.export',
3832
3929
        'bzrlib.inventory',
3833
3930
        'bzrlib.iterablefile',
4040
4137
    return new_test
4041
4138
 
4042
4139
 
4043
 
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4044
 
                                ext_module_name):
4045
 
    """Helper for permutating tests against an extension module.
4046
 
 
4047
 
    This is meant to be used inside a modules 'load_tests()' function. It will
4048
 
    create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4049
 
    against both implementations. Setting 'test.module' to the appropriate
4050
 
    module. See bzrlib.tests.test__chk_map.load_tests as an example.
4051
 
 
4052
 
    :param standard_tests: A test suite to permute
4053
 
    :param loader: A TestLoader
4054
 
    :param py_module_name: The python path to a python module that can always
4055
 
        be loaded, and will be considered the 'python' implementation. (eg
4056
 
        'bzrlib._chk_map_py')
4057
 
    :param ext_module_name: The python path to an extension module. If the
4058
 
        module cannot be loaded, a single test will be added, which notes that
4059
 
        the module is not available. If it can be loaded, all standard_tests
4060
 
        will be run against that module.
4061
 
    :return: (suite, feature) suite is a test-suite that has all the permuted
4062
 
        tests. feature is the Feature object that can be used to determine if
4063
 
        the module is available.
4064
 
    """
4065
 
 
4066
 
    py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4067
 
    scenarios = [
4068
 
        ('python', {'module': py_module}),
4069
 
    ]
4070
 
    suite = loader.suiteClass()
4071
 
    feature = ModuleAvailableFeature(ext_module_name)
4072
 
    if feature.available():
4073
 
        scenarios.append(('C', {'module': feature.module}))
4074
 
    else:
4075
 
        # the compiled module isn't available, so we add a failing test
4076
 
        class FailWithoutFeature(TestCase):
4077
 
            def test_fail(self):
4078
 
                self.requireFeature(feature)
4079
 
        suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4080
 
    result = multiply_tests(standard_tests, scenarios, suite)
4081
 
    return result, feature
4082
 
 
4083
 
 
4084
4140
def _rmtree_temp_dir(dirname, test_id=None):
4085
4141
    # If LANG=C we probably have created some bogus paths
4086
4142
    # which rmtree(unicode) will fail to delete
4191
4247
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4192
4248
 
4193
4249
 
4194
 
class _CompatabilityThunkFeature(Feature):
4195
 
    """This feature is just a thunk to another feature.
4196
 
 
4197
 
    It issues a deprecation warning if it is accessed, to let you know that you
4198
 
    should really use a different feature.
4199
 
    """
4200
 
 
4201
 
    def __init__(self, dep_version, module, name,
4202
 
                 replacement_name, replacement_module=None):
4203
 
        super(_CompatabilityThunkFeature, self).__init__()
4204
 
        self._module = module
4205
 
        if replacement_module is None:
4206
 
            replacement_module = module
4207
 
        self._replacement_module = replacement_module
4208
 
        self._name = name
4209
 
        self._replacement_name = replacement_name
4210
 
        self._dep_version = dep_version
4211
 
        self._feature = None
4212
 
 
4213
 
    def _ensure(self):
4214
 
        if self._feature is None:
4215
 
            depr_msg = self._dep_version % ('%s.%s'
4216
 
                                            % (self._module, self._name))
4217
 
            use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4218
 
                                               self._replacement_name)
4219
 
            symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4220
 
            # Import the new feature and use it as a replacement for the
4221
 
            # deprecated one.
4222
 
            mod = __import__(self._replacement_module, {}, {},
4223
 
                             [self._replacement_name])
4224
 
            self._feature = getattr(mod, self._replacement_name)
4225
 
 
4226
 
    def _probe(self):
4227
 
        self._ensure()
4228
 
        return self._feature._probe()
4229
 
 
4230
 
 
4231
4250
class ModuleAvailableFeature(Feature):
4232
4251
    """This is a feature than describes a module we want to be available.
4233
4252
 
4253
4272
        if self.available(): # Make sure the probe has been done
4254
4273
            return self._module
4255
4274
        return None
4256
 
 
 
4275
    
4257
4276
    def feature_name(self):
4258
4277
        return self.module_name
4259
4278
 
4260
4279
 
4261
 
# This is kept here for compatibility, it is recommended to use
4262
 
# 'bzrlib.tests.feature.paramiko' instead
4263
 
ParamikoFeature = _CompatabilityThunkFeature(
4264
 
    deprecated_in((2,1,0)),
4265
 
    'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4266
 
 
4267
4280
 
4268
4281
def probe_unicode_in_user_encoding():
4269
4282
    """Try to encode several unicode strings to use in unicode-aware tests.
4319
4332
HTTPSServerFeature = _HTTPSServerFeature()
4320
4333
 
4321
4334
 
 
4335
class _ParamikoFeature(Feature):
 
4336
    """Is paramiko available?"""
 
4337
 
 
4338
    def _probe(self):
 
4339
        try:
 
4340
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
4341
            return True
 
4342
        except errors.ParamikoNotPresent:
 
4343
            return False
 
4344
 
 
4345
    def feature_name(self):
 
4346
        return "Paramiko"
 
4347
 
 
4348
 
 
4349
ParamikoFeature = _ParamikoFeature()
 
4350
 
 
4351
 
4322
4352
class _UnicodeFilename(Feature):
4323
4353
    """Does the filesystem support Unicode filenames?"""
4324
4354
 
4429
4459
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4430
4460
 
4431
4461
 
4432
 
class _CaseSensitiveFilesystemFeature(Feature):
 
4462
class _SubUnitFeature(Feature):
 
4463
    """Check if subunit is available."""
4433
4464
 
4434
4465
    def _probe(self):
4435
 
        if CaseInsCasePresFilenameFeature.available():
4436
 
            return False
4437
 
        elif CaseInsensitiveFilesystemFeature.available():
4438
 
            return False
4439
 
        else:
 
4466
        try:
 
4467
            import subunit
4440
4468
            return True
 
4469
        except ImportError:
 
4470
            return False
4441
4471
 
4442
4472
    def feature_name(self):
4443
 
        return 'case-sensitive filesystem'
4444
 
 
4445
 
# new coding style is for feature instances to be lowercase
4446
 
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4447
 
 
4448
 
 
4449
 
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4450
 
SubUnitFeature = _CompatabilityThunkFeature(
4451
 
    deprecated_in((2,1,0)),
4452
 
    'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
 
4473
        return 'subunit'
 
4474
 
 
4475
SubUnitFeature = _SubUnitFeature()
4453
4476
# Only define SubUnitBzrRunner if subunit is available.
4454
4477
try:
4455
4478
    from subunit import TestProtocolClient
4456
 
    from subunit.test_results import AutoTimingTestResultDecorator
4457
4479
    class SubUnitBzrRunner(TextTestRunner):
4458
4480
        def run(self, test):
4459
 
            result = AutoTimingTestResultDecorator(
 
4481
            result = BzrAutoTimingTestResultDecorator(
4460
4482
                TestProtocolClient(self.stream))
4461
4483
            test.run(result)
4462
4484
            return result
4463
4485
except ImportError:
4464
4486
    pass
4465
 
 
4466
 
class _PosixPermissionsFeature(Feature):
4467
 
 
4468
 
    def _probe(self):
4469
 
        def has_perms():
4470
 
            # create temporary file and check if specified perms are maintained.
4471
 
            import tempfile
4472
 
 
4473
 
            write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4474
 
            f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4475
 
            fd, name = f
4476
 
            os.close(fd)
4477
 
            os.chmod(name, write_perms)
4478
 
 
4479
 
            read_perms = os.stat(name).st_mode & 0777
4480
 
            os.unlink(name)
4481
 
            return (write_perms == read_perms)
4482
 
 
4483
 
        return (os.name == 'posix') and has_perms()
4484
 
 
4485
 
    def feature_name(self):
4486
 
        return 'POSIX permissions support'
4487
 
 
4488
 
posix_permissions_feature = _PosixPermissionsFeature()