~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2013, 2015, 2016 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
16
16
 
17
17
"""Testing framework extensions"""
18
18
 
19
 
# TODO: Perhaps there should be an API to find out if bzr running under the
20
 
# test suite -- some plugins might want to avoid making intrusive changes if
21
 
# this is the case.  However, we want behaviour under to test to diverge as
22
 
# little as possible, so this should be used rarely if it's added at all.
23
 
# (Suggestion from j-a-meinel, 2005-11-24)
 
19
from __future__ import absolute_import
24
20
 
25
21
# NOTE: Some classes in here use camelCaseNaming() rather than
26
22
# underscore_naming().  That's for consistency with unittest; it's not the
38
34
import logging
39
35
import math
40
36
import os
 
37
import platform
41
38
import pprint
42
39
import random
43
40
import re
44
41
import shlex
 
42
import site
45
43
import stat
46
44
import subprocess
47
45
import sys
55
53
import testtools
56
54
# nb: check this before importing anything else from within it
57
55
_testtools_version = getattr(testtools, '__version__', ())
58
 
if _testtools_version < (0, 9, 2):
59
 
    raise ImportError("need at least testtools 0.9.2: %s is %r"
 
56
if _testtools_version < (0, 9, 5):
 
57
    raise ImportError("need at least testtools 0.9.5: %s is %r"
60
58
        % (testtools.__file__, _testtools_version))
61
59
from testtools import content
62
60
 
 
61
import bzrlib
63
62
from bzrlib import (
64
63
    branchbuilder,
65
 
    bzrdir,
 
64
    controldir,
66
65
    chk_map,
 
66
    commands as _mod_commands,
67
67
    config,
 
68
    i18n,
68
69
    debug,
69
70
    errors,
70
71
    hooks,
71
72
    lock as _mod_lock,
 
73
    lockdir,
72
74
    memorytree,
73
75
    osutils,
74
 
    progress,
 
76
    plugin as _mod_plugin,
 
77
    pyutils,
75
78
    ui,
76
79
    urlutils,
77
80
    registry,
 
81
    symbol_versioning,
 
82
    trace,
78
83
    transport as _mod_transport,
79
84
    workingtree,
80
85
    )
81
 
import bzrlib.branch
82
 
import bzrlib.commands
83
 
import bzrlib.timestamp
84
 
import bzrlib.export
85
 
import bzrlib.inventory
86
 
import bzrlib.iterablefile
87
 
import bzrlib.lockdir
88
86
try:
89
87
    import bzrlib.lsprof
90
88
except ImportError:
91
89
    # lsprof not available
92
90
    pass
93
 
from bzrlib.merge import merge_inner
94
 
import bzrlib.merge3
95
 
import bzrlib.plugin
96
 
from bzrlib.smart import client, request, server
97
 
import bzrlib.store
98
 
from bzrlib import symbol_versioning
 
91
from bzrlib.smart import client, request
 
92
from bzrlib.transport import (
 
93
    memory,
 
94
    pathfilter,
 
95
    )
99
96
from bzrlib.symbol_versioning import (
100
 
    DEPRECATED_PARAMETER,
101
97
    deprecated_function,
102
98
    deprecated_in,
103
 
    deprecated_method,
104
 
    deprecated_passed,
105
 
    )
106
 
import bzrlib.trace
107
 
from bzrlib.transport import (
108
 
    memory,
109
 
    pathfilter,
110
 
    )
111
 
from bzrlib.trace import mutter, note
 
99
    )
112
100
from bzrlib.tests import (
 
101
    fixtures,
113
102
    test_server,
114
103
    TestUtil,
115
104
    treeshape,
116
105
    )
117
106
from bzrlib.ui import NullProgressView
118
107
from bzrlib.ui.text import TextUIFactory
119
 
import bzrlib.version_info_formats.format_custom
120
 
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
 
108
from bzrlib.tests.features import _CompatabilityThunkFeature
121
109
 
122
110
# Mark this python module as being part of the implementation
123
111
# of unittest: this gives us better tracebacks where the last
135
123
SUBUNIT_SEEK_SET = 0
136
124
SUBUNIT_SEEK_CUR = 1
137
125
 
 
126
# These are intentionally brought into this namespace. That way plugins, etc
 
127
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
 
128
TestSuite = TestUtil.TestSuite
 
129
TestLoader = TestUtil.TestLoader
 
130
 
 
131
# Tests should run in a clean and clearly defined environment. The goal is to
 
132
# keep them isolated from the running environment as mush as possible. The test
 
133
# framework ensures the variables defined below are set (or deleted if the
 
134
# value is None) before a test is run and reset to their original value after
 
135
# the test is run. Generally if some code depends on an environment variable,
 
136
# the tests should start without this variable in the environment. There are a
 
137
# few exceptions but you shouldn't violate this rule lightly.
 
138
isolated_environ = {
 
139
    'BZR_HOME': None,
 
140
    'HOME': None,
 
141
    'XDG_CONFIG_HOME': None,
 
142
    # bzr now uses the Win32 API and doesn't rely on APPDATA, but the
 
143
    # tests do check our impls match APPDATA
 
144
    'BZR_EDITOR': None, # test_msgeditor manipulates this variable
 
145
    'VISUAL': None,
 
146
    'EDITOR': None,
 
147
    'BZR_EMAIL': None,
 
148
    'BZREMAIL': None, # may still be present in the environment
 
149
    'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
 
150
    'BZR_PROGRESS_BAR': None,
 
151
    # This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
 
152
    # as a base class instead of TestCaseInTempDir. Tests inheriting from
 
153
    # TestCase should not use disk resources, BZR_LOG is one.
 
154
    'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
 
155
    'BZR_PLUGIN_PATH': None,
 
156
    'BZR_DISABLE_PLUGINS': None,
 
157
    'BZR_PLUGINS_AT': None,
 
158
    'BZR_CONCURRENCY': None,
 
159
    # Make sure that any text ui tests are consistent regardless of
 
160
    # the environment the test case is run in; you may want tests that
 
161
    # test other combinations.  'dumb' is a reasonable guess for tests
 
162
    # going to a pipe or a StringIO.
 
163
    'TERM': 'dumb',
 
164
    'LINES': '25',
 
165
    'COLUMNS': '80',
 
166
    'BZR_COLUMNS': '80',
 
167
    # Disable SSH Agent
 
168
    'SSH_AUTH_SOCK': None,
 
169
    # Proxies
 
170
    'http_proxy': None,
 
171
    'HTTP_PROXY': None,
 
172
    'https_proxy': None,
 
173
    'HTTPS_PROXY': None,
 
174
    'no_proxy': None,
 
175
    'NO_PROXY': None,
 
176
    'all_proxy': None,
 
177
    'ALL_PROXY': None,
 
178
    # Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
 
179
    # least. If you do (care), please update this comment
 
180
    # -- vila 20080401
 
181
    'ftp_proxy': None,
 
182
    'FTP_PROXY': None,
 
183
    'BZR_REMOTE_PATH': None,
 
184
    # Generally speaking, we don't want apport reporting on crashes in
 
185
    # the test envirnoment unless we're specifically testing apport,
 
186
    # so that it doesn't leak into the real system environment.  We
 
187
    # use an env var so it propagates to subprocesses.
 
188
    'APPORT_DISABLE': '1',
 
189
    }
 
190
 
 
191
 
 
192
def override_os_environ(test, env=None):
 
193
    """Modify os.environ keeping a copy.
 
194
    
 
195
    :param test: A test instance
 
196
 
 
197
    :param env: A dict containing variable definitions to be installed
 
198
    """
 
199
    if env is None:
 
200
        env = isolated_environ
 
201
    test._original_os_environ = dict([(var, value)
 
202
                                      for var, value in os.environ.iteritems()])
 
203
    for var, value in env.iteritems():
 
204
        osutils.set_or_unset_env(var, value)
 
205
        if var not in test._original_os_environ:
 
206
            # The var is new, add it with a value of None, so
 
207
            # restore_os_environ will delete it
 
208
            test._original_os_environ[var] = None
 
209
 
 
210
 
 
211
def restore_os_environ(test):
 
212
    """Restore os.environ to its original state.
 
213
 
 
214
    :param test: A test instance previously passed to override_os_environ.
 
215
    """
 
216
    for var, value in test._original_os_environ.iteritems():
 
217
        # Restore the original value (or delete it if the value has been set to
 
218
        # None in override_os_environ).
 
219
        osutils.set_or_unset_env(var, value)
 
220
 
 
221
 
 
222
def _clear__type_equality_funcs(test):
 
223
    """Cleanup bound methods stored on TestCase instances
 
224
 
 
225
    Clear the dict breaking a few (mostly) harmless cycles in the affected
 
226
    unittests released with Python 2.6 and initial Python 2.7 versions.
 
227
 
 
228
    For a few revisions between Python 2.7.1 and Python 2.7.2 that annoyingly
 
229
    shipped in Oneiric, an object with no clear method was used, hence the
 
230
    extra complications, see bug 809048 for details.
 
231
    """
 
232
    type_equality_funcs = getattr(test, "_type_equality_funcs", None)
 
233
    if type_equality_funcs is not None:
 
234
        tef_clear = getattr(type_equality_funcs, "clear", None)
 
235
        if tef_clear is None:
 
236
            tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
 
237
            if tef_instance_dict is not None:
 
238
                tef_clear = tef_instance_dict.clear
 
239
        if tef_clear is not None:
 
240
            tef_clear()
 
241
 
138
242
 
139
243
class ExtendedTestResult(testtools.TextTestResult):
140
244
    """Accepts, reports and accumulates the results of running tests.
145
249
    different types of display.
146
250
 
147
251
    When a test finishes, in whatever way, it calls one of the addSuccess,
148
 
    addFailure or addError classes.  These in turn may redirect to a more
 
252
    addFailure or addError methods.  These in turn may redirect to a more
149
253
    specific case for the special test results supported by our extended
150
254
    tests.
151
255
 
190
294
        self.count = 0
191
295
        self._overall_start_time = time.time()
192
296
        self._strict = strict
 
297
        self._first_thread_leaker_id = None
 
298
        self._tests_leaking_threads_count = 0
 
299
        self._traceback_from_test = None
193
300
 
194
301
    def stopTestRun(self):
195
302
        run = self.testsRun
234
341
            ok = self.wasStrictlySuccessful()
235
342
        else:
236
343
            ok = self.wasSuccessful()
237
 
        if TestCase._first_thread_leaker_id:
 
344
        if self._first_thread_leaker_id:
238
345
            self.stream.write(
239
346
                '%s is leaking threads among %d leaking tests.\n' % (
240
 
                TestCase._first_thread_leaker_id,
241
 
                TestCase._leaking_threads_tests))
 
347
                self._first_thread_leaker_id,
 
348
                self._tests_leaking_threads_count))
242
349
            # We don't report the main thread as an active one.
243
350
            self.stream.write(
244
351
                '%d non-main threads were left active in the end.\n'
245
 
                % (TestCase._active_threads - 1))
 
352
                % (len(self._active_threads) - 1))
246
353
 
247
354
    def getDescription(self, test):
248
355
        return test.id()
253
360
            return float(''.join(details['benchtime'].iter_bytes()))
254
361
        return getattr(testCase, "_benchtime", None)
255
362
 
 
363
    def _delta_to_float(self, a_timedelta, precision):
 
364
        # This calls ceiling to ensure that the most pessimistic view of time
 
365
        # taken is shown (rather than leaving it to the Python %f operator
 
366
        # to decide whether to round/floor/ceiling. This was added when we
 
367
        # had pyp3 test failures that suggest a floor was happening.
 
368
        shift = 10 ** precision
 
369
        return math.ceil((a_timedelta.days * 86400.0 + a_timedelta.seconds +
 
370
            a_timedelta.microseconds / 1000000.0) * shift) / shift
 
371
 
256
372
    def _elapsedTestTimeString(self):
257
373
        """Return a time string for the overall time the current test has taken."""
258
 
        return self._formatTime(time.time() - self._start_time)
 
374
        return self._formatTime(self._delta_to_float(
 
375
            self._now() - self._start_datetime, 3))
259
376
 
260
377
    def _testTimeString(self, testCase):
261
378
        benchmark_time = self._extractBenchmarkTime(testCase)
275
392
        what = re.sub(r'^bzrlib\.tests\.', '', what)
276
393
        return what
277
394
 
 
395
    # GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
 
396
    #                multiple times in a row, because the handler is added for
 
397
    #                each test but the container list is shared between cases.
 
398
    #                See lp:498869 lp:625574 and lp:637725 for background.
 
399
    def _record_traceback_from_test(self, exc_info):
 
400
        """Store the traceback from passed exc_info tuple till"""
 
401
        self._traceback_from_test = exc_info[2]
 
402
 
278
403
    def startTest(self, test):
279
404
        super(ExtendedTestResult, self).startTest(test)
280
405
        if self.count == 0:
281
406
            self.startTests()
 
407
        self.count += 1
282
408
        self.report_test_start(test)
283
409
        test.number = self.count
284
410
        self._recordTestStartTime()
 
411
        # Make testtools cases give us the real traceback on failure
 
412
        addOnException = getattr(test, "addOnException", None)
 
413
        if addOnException is not None:
 
414
            addOnException(self._record_traceback_from_test)
 
415
        # Only check for thread leaks on bzrlib derived test cases
 
416
        if isinstance(test, TestCase):
 
417
            test.addCleanup(self._check_leaked_threads, test)
 
418
 
 
419
    def stopTest(self, test):
 
420
        super(ExtendedTestResult, self).stopTest(test)
 
421
        # Manually break cycles, means touching various private things but hey
 
422
        getDetails = getattr(test, "getDetails", None)
 
423
        if getDetails is not None:
 
424
            getDetails().clear()
 
425
        _clear__type_equality_funcs(test)
 
426
        self._traceback_from_test = None
285
427
 
286
428
    def startTests(self):
287
 
        import platform
288
 
        if getattr(sys, 'frozen', None) is None:
289
 
            bzr_path = osutils.realpath(sys.argv[0])
290
 
        else:
291
 
            bzr_path = sys.executable
292
 
        self.stream.write(
293
 
            'bzr selftest: %s\n' % (bzr_path,))
294
 
        self.stream.write(
295
 
            '   %s\n' % (
296
 
                    bzrlib.__path__[0],))
297
 
        self.stream.write(
298
 
            '   bzr-%s python-%s %s\n' % (
299
 
                    bzrlib.version_string,
300
 
                    bzrlib._format_version_tuple(sys.version_info),
301
 
                    platform.platform(aliased=1),
302
 
                    ))
303
 
        self.stream.write('\n')
 
429
        self.report_tests_starting()
 
430
        self._active_threads = threading.enumerate()
 
431
 
 
432
    def _check_leaked_threads(self, test):
 
433
        """See if any threads have leaked since last call
 
434
 
 
435
        A sample of live threads is stored in the _active_threads attribute,
 
436
        when this method runs it compares the current live threads and any not
 
437
        in the previous sample are treated as having leaked.
 
438
        """
 
439
        now_active_threads = set(threading.enumerate())
 
440
        threads_leaked = now_active_threads.difference(self._active_threads)
 
441
        if threads_leaked:
 
442
            self._report_thread_leak(test, threads_leaked, now_active_threads)
 
443
            self._tests_leaking_threads_count += 1
 
444
            if self._first_thread_leaker_id is None:
 
445
                self._first_thread_leaker_id = test.id()
 
446
            self._active_threads = now_active_threads
304
447
 
305
448
    def _recordTestStartTime(self):
306
449
        """Record that a test has started."""
307
 
        self._start_time = time.time()
308
 
 
309
 
    def _cleanupLogFile(self, test):
310
 
        # We can only do this if we have one of our TestCases, not if
311
 
        # we have a doctest.
312
 
        setKeepLogfile = getattr(test, 'setKeepLogfile', None)
313
 
        if setKeepLogfile is not None:
314
 
            setKeepLogfile()
 
450
        self._start_datetime = self._now()
315
451
 
316
452
    def addError(self, test, err):
317
453
        """Tell result that test finished with an error.
319
455
        Called from the TestCase run() method when the test
320
456
        fails with an unexpected error.
321
457
        """
322
 
        self._post_mortem()
 
458
        self._post_mortem(self._traceback_from_test)
323
459
        super(ExtendedTestResult, self).addError(test, err)
324
460
        self.error_count += 1
325
461
        self.report_error(test, err)
326
462
        if self.stop_early:
327
463
            self.stop()
328
 
        self._cleanupLogFile(test)
329
464
 
330
465
    def addFailure(self, test, err):
331
466
        """Tell result that test failed.
333
468
        Called from the TestCase run() method when the test
334
469
        fails because e.g. an assert() method failed.
335
470
        """
336
 
        self._post_mortem()
 
471
        self._post_mortem(self._traceback_from_test)
337
472
        super(ExtendedTestResult, self).addFailure(test, err)
338
473
        self.failure_count += 1
339
474
        self.report_failure(test, err)
340
475
        if self.stop_early:
341
476
            self.stop()
342
 
        self._cleanupLogFile(test)
343
477
 
344
478
    def addSuccess(self, test, details=None):
345
479
        """Tell result that test completed successfully.
353
487
                    self._formatTime(benchmark_time),
354
488
                    test.id()))
355
489
        self.report_success(test)
356
 
        self._cleanupLogFile(test)
357
490
        super(ExtendedTestResult, self).addSuccess(test)
358
491
        test._log_contents = ''
359
492
 
361
494
        self.known_failure_count += 1
362
495
        self.report_known_failure(test, err)
363
496
 
 
497
    def addUnexpectedSuccess(self, test, details=None):
 
498
        """Tell result the test unexpectedly passed, counting as a failure
 
499
 
 
500
        When the minimum version of testtools required becomes 0.9.8 this
 
501
        can be updated to use the new handling there.
 
502
        """
 
503
        super(ExtendedTestResult, self).addFailure(test, details=details)
 
504
        self.failure_count += 1
 
505
        self.report_unexpected_success(test,
 
506
            "".join(details["reason"].iter_text()))
 
507
        if self.stop_early:
 
508
            self.stop()
 
509
 
364
510
    def addNotSupported(self, test, feature):
365
511
        """The test will not be run because of a missing feature.
366
512
        """
383
529
        self.not_applicable_count += 1
384
530
        self.report_not_applicable(test, reason)
385
531
 
386
 
    def _post_mortem(self):
 
532
    def _count_stored_tests(self):
 
533
        """Count of tests instances kept alive due to not succeeding"""
 
534
        return self.error_count + self.failure_count + self.known_failure_count
 
535
 
 
536
    def _post_mortem(self, tb=None):
387
537
        """Start a PDB post mortem session."""
388
538
        if os.environ.get('BZR_TEST_PDB', None):
389
 
            import pdb;pdb.post_mortem()
 
539
            import pdb
 
540
            pdb.post_mortem(tb)
390
541
 
391
542
    def progress(self, offset, whence):
392
543
        """The test is adjusting the count of tests to run."""
397
548
        else:
398
549
            raise errors.BzrError("Unknown whence %r" % whence)
399
550
 
400
 
    def report_cleaning_up(self):
401
 
        pass
 
551
    def report_tests_starting(self):
 
552
        """Display information before the test run begins"""
 
553
        if getattr(sys, 'frozen', None) is None:
 
554
            bzr_path = osutils.realpath(sys.argv[0])
 
555
        else:
 
556
            bzr_path = sys.executable
 
557
        self.stream.write(
 
558
            'bzr selftest: %s\n' % (bzr_path,))
 
559
        self.stream.write(
 
560
            '   %s\n' % (
 
561
                    bzrlib.__path__[0],))
 
562
        self.stream.write(
 
563
            '   bzr-%s python-%s %s\n' % (
 
564
                    bzrlib.version_string,
 
565
                    bzrlib._format_version_tuple(sys.version_info),
 
566
                    platform.platform(aliased=1),
 
567
                    ))
 
568
        self.stream.write('\n')
 
569
 
 
570
    def report_test_start(self, test):
 
571
        """Display information on the test just about to be run"""
 
572
 
 
573
    def _report_thread_leak(self, test, leaked_threads, active_threads):
 
574
        """Display information on a test that leaked one or more threads"""
 
575
        # GZ 2010-09-09: A leak summary reported separately from the general
 
576
        #                thread debugging would be nice. Tests under subunit
 
577
        #                need something not using stream, perhaps adding a
 
578
        #                testtools details object would be fitting.
 
579
        if 'threads' in selftest_debug_flags:
 
580
            self.stream.write('%s is leaking, active is now %d\n' %
 
581
                (test.id(), len(active_threads)))
402
582
 
403
583
    def startTestRun(self):
404
584
        self.startTime = time.time()
441
621
        self.pb.finished()
442
622
        super(TextTestResult, self).stopTestRun()
443
623
 
444
 
    def startTestRun(self):
445
 
        super(TextTestResult, self).startTestRun()
 
624
    def report_tests_starting(self):
 
625
        super(TextTestResult, self).report_tests_starting()
446
626
        self.pb.update('[test 0/%d] Starting' % (self.num_tests))
447
627
 
448
 
    def printErrors(self):
449
 
        # clear the pb to make room for the error listing
450
 
        self.pb.clear()
451
 
        super(TextTestResult, self).printErrors()
452
 
 
453
628
    def _progress_prefix_text(self):
454
629
        # the longer this text, the less space we have to show the test
455
630
        # name...
477
652
        return a
478
653
 
479
654
    def report_test_start(self, test):
480
 
        self.count += 1
481
655
        self.pb.update(
482
656
                self._progress_prefix_text()
483
657
                + ' '
501
675
    def report_known_failure(self, test, err):
502
676
        pass
503
677
 
 
678
    def report_unexpected_success(self, test, reason):
 
679
        self.stream.write('FAIL: %s\n    %s: %s\n' % (
 
680
            self._test_description(test),
 
681
            "Unexpected success. Should have failed",
 
682
            reason,
 
683
            ))
 
684
 
504
685
    def report_skip(self, test, reason):
505
686
        pass
506
687
 
510
691
    def report_unsupported(self, test, feature):
511
692
        """test cannot be run because feature is missing."""
512
693
 
513
 
    def report_cleaning_up(self):
514
 
        self.pb.update('Cleaning up')
515
 
 
516
694
 
517
695
class VerboseTestResult(ExtendedTestResult):
518
696
    """Produce long output, with one line per test run plus times"""
525
703
            result = a_string
526
704
        return result.ljust(final_width)
527
705
 
528
 
    def startTestRun(self):
529
 
        super(VerboseTestResult, self).startTestRun()
 
706
    def report_tests_starting(self):
530
707
        self.stream.write('running %d tests...\n' % self.num_tests)
 
708
        super(VerboseTestResult, self).report_tests_starting()
531
709
 
532
710
    def report_test_start(self, test):
533
 
        self.count += 1
534
711
        name = self._shortened_test_description(test)
535
712
        width = osutils.terminal_width()
536
713
        if width is not None:
562
739
                % (self._testTimeString(test),
563
740
                   self._error_summary(err)))
564
741
 
 
742
    def report_unexpected_success(self, test, reason):
 
743
        self.stream.write(' FAIL %s\n%s: %s\n'
 
744
                % (self._testTimeString(test),
 
745
                   "Unexpected success. Should have failed",
 
746
                   reason))
 
747
 
565
748
    def report_success(self, test):
566
749
        self.stream.write('   OK %s\n' % self._testTimeString(test))
567
750
        for bench_called, stats in getattr(test, '_benchcalls', []):
614
797
            encode = codec[0]
615
798
        else:
616
799
            encode = codec.encode
617
 
        stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
 
800
        # GZ 2010-09-08: Really we don't want to be writing arbitrary bytes,
 
801
        #                so should swap to the plain codecs.StreamWriter
 
802
        stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream,
 
803
            "backslashreplace")
618
804
        stream.encoding = new_encoding
619
805
        self.stream = stream
620
806
        self.descriptions = descriptions
770
956
        return NullProgressView()
771
957
 
772
958
 
 
959
def isolated_doctest_setUp(test):
 
960
    override_os_environ(test)
 
961
 
 
962
 
 
963
def isolated_doctest_tearDown(test):
 
964
    restore_os_environ(test)
 
965
 
 
966
 
 
967
def IsolatedDocTestSuite(*args, **kwargs):
 
968
    """Overrides doctest.DocTestSuite to handle isolation.
 
969
 
 
970
    The method is really a factory and users are expected to use it as such.
 
971
    """
 
972
 
 
973
    kwargs['setUp'] = isolated_doctest_setUp
 
974
    kwargs['tearDown'] = isolated_doctest_tearDown
 
975
    return doctest.DocTestSuite(*args, **kwargs)
 
976
 
 
977
 
773
978
class TestCase(testtools.TestCase):
774
979
    """Base class for bzr unit tests.
775
980
 
786
991
    routine, and to build and check bzr trees.
787
992
 
788
993
    In addition to the usual method of overriding tearDown(), this class also
789
 
    allows subclasses to register functions into the _cleanups list, which is
 
994
    allows subclasses to register cleanup functions via addCleanup, which are
790
995
    run in order as the object is torn down.  It's less likely this will be
791
996
    accidentally overlooked.
792
997
    """
793
998
 
794
 
    _active_threads = None
795
 
    _leaking_threads_tests = 0
796
 
    _first_thread_leaker_id = None
797
 
    _log_file_name = None
 
999
    _log_file = None
798
1000
    # record lsprof data when performing benchmark calls.
799
1001
    _gather_lsprof_in_benchmarks = False
800
1002
 
801
1003
    def __init__(self, methodName='testMethod'):
802
1004
        super(TestCase, self).__init__(methodName)
803
 
        self._cleanups = []
804
1005
        self._directory_isolation = True
805
1006
        self.exception_handlers.insert(0,
806
1007
            (UnavailableFeature, self._do_unsupported_or_skip))
809
1010
 
810
1011
    def setUp(self):
811
1012
        super(TestCase, self).setUp()
 
1013
 
 
1014
        # At this point we're still accessing the config files in $BZR_HOME (as
 
1015
        # set by the user running selftest).
 
1016
        timeout = config.GlobalStack().get('selftest.timeout')
 
1017
        if timeout:
 
1018
            timeout_fixture = fixtures.TimeoutFixture(timeout)
 
1019
            timeout_fixture.setUp()
 
1020
            self.addCleanup(timeout_fixture.cleanUp)
 
1021
 
812
1022
        for feature in getattr(self, '_test_needs_features', []):
813
1023
            self.requireFeature(feature)
814
 
        self._log_contents = None
815
 
        self.addDetail("log", content.Content(content.ContentType("text",
816
 
            "plain", {"charset": "utf8"}),
817
 
            lambda:[self._get_log(keep_log_file=True)]))
818
1024
        self._cleanEnvironment()
 
1025
 
 
1026
        if bzrlib.global_state is not None:
 
1027
            self.overrideAttr(bzrlib.global_state, 'cmdline_overrides',
 
1028
                              config.CommandLineStore())
 
1029
 
819
1030
        self._silenceUI()
820
1031
        self._startLogFile()
821
1032
        self._benchcalls = []
824
1035
        self._track_transports()
825
1036
        self._track_locks()
826
1037
        self._clear_debug_flags()
827
 
        TestCase._active_threads = threading.activeCount()
828
 
        self.addCleanup(self._check_leaked_threads)
 
1038
        # Isolate global verbosity level, to make sure it's reproducible
 
1039
        # between tests.  We should get rid of this altogether: bug 656694. --
 
1040
        # mbp 20101008
 
1041
        self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
 
1042
        self._log_files = set()
 
1043
        # Each key in the ``_counters`` dict holds a value for a different
 
1044
        # counter. When the test ends, addDetail() should be used to output the
 
1045
        # counter values. This happens in install_counter_hook().
 
1046
        self._counters = {}
 
1047
        if 'config_stats' in selftest_debug_flags:
 
1048
            self._install_config_stats_hooks()
 
1049
        # Do not use i18n for tests (unless the test reverses this)
 
1050
        i18n.disable_i18n()
829
1051
 
830
1052
    def debug(self):
831
1053
        # debug a frame up.
832
1054
        import pdb
833
 
        pdb.Pdb().set_trace(sys._getframe().f_back)
834
 
 
835
 
    def _check_leaked_threads(self):
836
 
        active = threading.activeCount()
837
 
        leaked_threads = active - TestCase._active_threads
838
 
        TestCase._active_threads = active
839
 
        # If some tests make the number of threads *decrease*, we'll consider
840
 
        # that they are just observing old threads dieing, not agressively kill
841
 
        # random threads. So we don't report these tests as leaking. The risk
842
 
        # is that we have false positives that way (the test see 2 threads
843
 
        # going away but leak one) but it seems less likely than the actual
844
 
        # false positives (the test see threads going away and does not leak).
845
 
        if leaked_threads > 0:
846
 
            if 'threads' in selftest_debug_flags:
847
 
                print '%s is leaking, active is now %d' % (self.id(), active)
848
 
            TestCase._leaking_threads_tests += 1
849
 
            if TestCase._first_thread_leaker_id is None:
850
 
                TestCase._first_thread_leaker_id = self.id()
 
1055
        # The sys preserved stdin/stdout should allow blackbox tests debugging
 
1056
        pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
 
1057
                ).set_trace(sys._getframe().f_back)
 
1058
 
 
1059
    def discardDetail(self, name):
 
1060
        """Extend the addDetail, getDetails api so we can remove a detail.
 
1061
 
 
1062
        eg. bzr always adds the 'log' detail at startup, but we don't want to
 
1063
        include it for skipped, xfail, etc tests.
 
1064
 
 
1065
        It is safe to call this for a detail that doesn't exist, in case this
 
1066
        gets called multiple times.
 
1067
        """
 
1068
        # We cheat. details is stored in __details which means we shouldn't
 
1069
        # touch it. but getDetails() returns the dict directly, so we can
 
1070
        # mutate it.
 
1071
        details = self.getDetails()
 
1072
        if name in details:
 
1073
            del details[name]
 
1074
 
 
1075
    def install_counter_hook(self, hooks, name, counter_name=None):
 
1076
        """Install a counting hook.
 
1077
 
 
1078
        Any hook can be counted as long as it doesn't need to return a value.
 
1079
 
 
1080
        :param hooks: Where the hook should be installed.
 
1081
 
 
1082
        :param name: The hook name that will be counted.
 
1083
 
 
1084
        :param counter_name: The counter identifier in ``_counters``, defaults
 
1085
            to ``name``.
 
1086
        """
 
1087
        _counters = self._counters # Avoid closing over self
 
1088
        if counter_name is None:
 
1089
            counter_name = name
 
1090
        if _counters.has_key(counter_name):
 
1091
            raise AssertionError('%s is already used as a counter name'
 
1092
                                  % (counter_name,))
 
1093
        _counters[counter_name] = 0
 
1094
        self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
 
1095
            lambda: ['%d' % (_counters[counter_name],)]))
 
1096
        def increment_counter(*args, **kwargs):
 
1097
            _counters[counter_name] += 1
 
1098
        label = 'count %s calls' % (counter_name,)
 
1099
        hooks.install_named_hook(name, increment_counter, label)
 
1100
        self.addCleanup(hooks.uninstall_named_hook, name, label)
 
1101
 
 
1102
    def _install_config_stats_hooks(self):
 
1103
        """Install config hooks to count hook calls.
 
1104
 
 
1105
        """
 
1106
        for hook_name in ('get', 'set', 'remove', 'load', 'save'):
 
1107
            self.install_counter_hook(config.ConfigHooks, hook_name,
 
1108
                                       'config.%s' % (hook_name,))
 
1109
 
 
1110
        # The OldConfigHooks are private and need special handling to protect
 
1111
        # against recursive tests (tests that run other tests), so we just do
 
1112
        # manually what registering them into _builtin_known_hooks will provide
 
1113
        # us.
 
1114
        self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
 
1115
        for hook_name in ('get', 'set', 'remove', 'load', 'save'):
 
1116
            self.install_counter_hook(config.OldConfigHooks, hook_name,
 
1117
                                      'old_config.%s' % (hook_name,))
851
1118
 
852
1119
    def _clear_debug_flags(self):
853
1120
        """Prevent externally set debug flags affecting tests.
864
1131
 
865
1132
    def _clear_hooks(self):
866
1133
        # prevent hooks affecting tests
 
1134
        known_hooks = hooks.known_hooks
867
1135
        self._preserved_hooks = {}
868
 
        for key, factory in hooks.known_hooks.items():
869
 
            parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
870
 
            current_hooks = hooks.known_hooks_key_to_object(key)
 
1136
        for key, (parent, name) in known_hooks.iter_parent_objects():
 
1137
            current_hooks = getattr(parent, name)
871
1138
            self._preserved_hooks[parent] = (name, current_hooks)
 
1139
        self._preserved_lazy_hooks = hooks._lazy_hooks
 
1140
        hooks._lazy_hooks = {}
872
1141
        self.addCleanup(self._restoreHooks)
873
 
        for key, factory in hooks.known_hooks.items():
874
 
            parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
 
1142
        for key, (parent, name) in known_hooks.iter_parent_objects():
 
1143
            factory = known_hooks.get(key)
875
1144
            setattr(parent, name, factory())
876
1145
        # this hook should always be installed
877
1146
        request._install_hook()
906
1175
        # break some locks on purpose and should be taken into account by
907
1176
        # considering that breaking a lock is just a dirty way of releasing it.
908
1177
        if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
909
 
            message = ('Different number of acquired and '
910
 
                       'released or broken locks. (%s, %s + %s)' %
911
 
                       (acquired_locks, released_locks, broken_locks))
 
1178
            message = (
 
1179
                'Different number of acquired and '
 
1180
                'released or broken locks.\n'
 
1181
                'acquired=%s\n'
 
1182
                'released=%s\n'
 
1183
                'broken=%s\n' %
 
1184
                (acquired_locks, released_locks, broken_locks))
912
1185
            if not self._lock_check_thorough:
913
1186
                # Rather than fail, just warn
914
1187
                print "Broken test %s: %s" % (self, message)
942
1215
 
943
1216
    def permit_dir(self, name):
944
1217
        """Permit a directory to be used by this test. See permit_url."""
945
 
        name_transport = _mod_transport.get_transport(name)
 
1218
        name_transport = _mod_transport.get_transport_from_path(name)
946
1219
        self.permit_url(name)
947
1220
        self.permit_url(name_transport.base)
948
1221
 
971
1244
            try:
972
1245
                workingtree.WorkingTree.open(path)
973
1246
            except (errors.NotBranchError, errors.NoWorkingTree):
974
 
                return
 
1247
                raise TestSkipped('Needs a working tree of bzr sources')
975
1248
        finally:
976
1249
            self.enable_directory_isolation()
977
1250
 
1027
1300
        self.addCleanup(transport_server.stop_server)
1028
1301
        # Obtain a real transport because if the server supplies a password, it
1029
1302
        # will be hidden from the base on the client side.
1030
 
        t = _mod_transport.get_transport(transport_server.get_url())
 
1303
        t = _mod_transport.get_transport_from_url(transport_server.get_url())
1031
1304
        # Some transport servers effectively chroot the backing transport;
1032
1305
        # others like SFTPServer don't - users of the transport can walk up the
1033
1306
        # transport to read the entire backing transport. This wouldn't matter
1064
1337
        # hook into bzr dir opening. This leaves a small window of error for
1065
1338
        # transport tests, but they are well known, and we can improve on this
1066
1339
        # step.
1067
 
        bzrdir.BzrDir.hooks.install_named_hook("pre_open",
 
1340
        controldir.ControlDir.hooks.install_named_hook("pre_open",
1068
1341
            self._preopen_isolate_transport, "Check bzr directories are safe.")
1069
1342
 
1070
1343
    def _ndiff_strings(self, a, b):
1089
1362
        except UnicodeError, e:
1090
1363
            # If we can't compare without getting a UnicodeError, then
1091
1364
            # obviously they are different
1092
 
            mutter('UnicodeError: %s', e)
 
1365
            trace.mutter('UnicodeError: %s', e)
1093
1366
        if message:
1094
1367
            message += '\n'
1095
1368
        raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1096
1369
            % (message,
1097
1370
               pprint.pformat(a), pprint.pformat(b)))
1098
1371
 
 
1372
    # FIXME: This is deprecated in unittest2 but plugins may still use it so we
 
1373
    # need a deprecation period for them -- vila 2016-02-01
1099
1374
    assertEquals = assertEqual
1100
1375
 
1101
1376
    def assertEqualDiff(self, a, b, message=None):
1104
1379
        This is intended for use with multi-line strings where it can
1105
1380
        be hard to find the differences by eye.
1106
1381
        """
1107
 
        # TODO: perhaps override assertEquals to call this for strings?
 
1382
        # TODO: perhaps override assertEqual to call this for strings?
1108
1383
        if a == b:
1109
1384
            return
1110
1385
        if message is None:
1134
1409
                         'st_mtime did not match')
1135
1410
        self.assertEqual(expected.st_ctime, actual.st_ctime,
1136
1411
                         'st_ctime did not match')
1137
 
        if sys.platform != 'win32':
 
1412
        if sys.platform == 'win32':
1138
1413
            # On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1139
1414
            # is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1140
 
            # odd. Regardless we shouldn't actually try to assert anything
1141
 
            # about their values
 
1415
            # odd. We just force it to always be 0 to avoid any problems.
 
1416
            self.assertEqual(0, expected.st_dev)
 
1417
            self.assertEqual(0, actual.st_dev)
 
1418
            self.assertEqual(0, expected.st_ino)
 
1419
            self.assertEqual(0, actual.st_ino)
 
1420
        else:
1142
1421
            self.assertEqual(expected.st_dev, actual.st_dev,
1143
1422
                             'st_dev did not match')
1144
1423
            self.assertEqual(expected.st_ino, actual.st_ino,
1153
1432
                length, len(obj_with_len), obj_with_len))
1154
1433
 
1155
1434
    def assertLogsError(self, exception_class, func, *args, **kwargs):
1156
 
        """Assert that func(*args, **kwargs) quietly logs a specific exception.
 
1435
        """Assert that `func(*args, **kwargs)` quietly logs a specific error.
1157
1436
        """
1158
 
        from bzrlib import trace
1159
1437
        captured = []
1160
1438
        orig_log_exception_quietly = trace.log_exception_quietly
1161
1439
        try:
1162
1440
            def capture():
1163
1441
                orig_log_exception_quietly()
1164
 
                captured.append(sys.exc_info())
 
1442
                captured.append(sys.exc_info()[1])
1165
1443
            trace.log_exception_quietly = capture
1166
1444
            func(*args, **kwargs)
1167
1445
        finally:
1168
1446
            trace.log_exception_quietly = orig_log_exception_quietly
1169
1447
        self.assertLength(1, captured)
1170
 
        err = captured[0][1]
 
1448
        err = captured[0]
1171
1449
        self.assertIsInstance(err, exception_class)
1172
1450
        return err
1173
1451
 
1210
1488
        if haystack.find(needle) == -1:
1211
1489
            self.fail("string %r not found in '''%s'''" % (needle, haystack))
1212
1490
 
 
1491
    def assertNotContainsString(self, haystack, needle):
 
1492
        if haystack.find(needle) != -1:
 
1493
            self.fail("string %r found in '''%s'''" % (needle, haystack))
 
1494
 
1213
1495
    def assertSubset(self, sublist, superlist):
1214
1496
        """Assert that every entry in sublist is present in superlist."""
1215
1497
        missing = set(sublist) - set(superlist)
1304
1586
 
1305
1587
    def assertFileEqual(self, content, path):
1306
1588
        """Fail if path does not contain 'content'."""
1307
 
        self.failUnlessExists(path)
 
1589
        self.assertPathExists(path)
1308
1590
        f = file(path, 'rb')
1309
1591
        try:
1310
1592
            s = f.read()
1320
1602
        else:
1321
1603
            self.assertEqual(expected_docstring, obj.__doc__)
1322
1604
 
 
1605
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1323
1606
    def failUnlessExists(self, path):
 
1607
        return self.assertPathExists(path)
 
1608
 
 
1609
    def assertPathExists(self, path):
1324
1610
        """Fail unless path or paths, which may be abs or relative, exist."""
1325
1611
        if not isinstance(path, basestring):
1326
1612
            for p in path:
1327
 
                self.failUnlessExists(p)
 
1613
                self.assertPathExists(p)
1328
1614
        else:
1329
 
            self.failUnless(osutils.lexists(path),path+" does not exist")
 
1615
            self.assertTrue(osutils.lexists(path),
 
1616
                path + " does not exist")
1330
1617
 
 
1618
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1331
1619
    def failIfExists(self, path):
 
1620
        return self.assertPathDoesNotExist(path)
 
1621
 
 
1622
    def assertPathDoesNotExist(self, path):
1332
1623
        """Fail if path or paths, which may be abs or relative, exist."""
1333
1624
        if not isinstance(path, basestring):
1334
1625
            for p in path:
1335
 
                self.failIfExists(p)
 
1626
                self.assertPathDoesNotExist(p)
1336
1627
        else:
1337
 
            self.failIf(osutils.lexists(path),path+" exists")
 
1628
            self.assertFalse(osutils.lexists(path),
 
1629
                path + " exists")
1338
1630
 
1339
1631
    def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1340
1632
        """A helper for callDeprecated and applyDeprecated.
1366
1658
        not other callers that go direct to the warning module.
1367
1659
 
1368
1660
        To test that a deprecated method raises an error, do something like
1369
 
        this::
 
1661
        this (remember that both assertRaises and applyDeprecated delays *args
 
1662
        and **kwargs passing)::
1370
1663
 
1371
1664
            self.assertRaises(errors.ReservedId,
1372
1665
                self.applyDeprecated,
1450
1743
        return result
1451
1744
 
1452
1745
    def _startLogFile(self):
1453
 
        """Send bzr and test log messages to a temporary file.
1454
 
 
1455
 
        The file is removed as the test is torn down.
1456
 
        """
1457
 
        fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1458
 
        self._log_file = os.fdopen(fileno, 'w+')
1459
 
        self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1460
 
        self._log_file_name = name
 
1746
        """Setup a in-memory target for bzr and testcase log messages"""
 
1747
        pseudo_log_file = StringIO()
 
1748
        def _get_log_contents_for_weird_testtools_api():
 
1749
            return [pseudo_log_file.getvalue().decode(
 
1750
                "utf-8", "replace").encode("utf-8")]
 
1751
        self.addDetail("log", content.Content(content.ContentType("text",
 
1752
            "plain", {"charset": "utf8"}),
 
1753
            _get_log_contents_for_weird_testtools_api))
 
1754
        self._log_file = pseudo_log_file
 
1755
        self._log_memento = trace.push_log_file(self._log_file)
1461
1756
        self.addCleanup(self._finishLogFile)
1462
1757
 
1463
1758
    def _finishLogFile(self):
1464
 
        """Finished with the log file.
1465
 
 
1466
 
        Close the file and delete it, unless setKeepLogfile was called.
1467
 
        """
1468
 
        if bzrlib.trace._trace_file:
 
1759
        """Flush and dereference the in-memory log for this testcase"""
 
1760
        if trace._trace_file:
1469
1761
            # flush the log file, to get all content
1470
 
            bzrlib.trace._trace_file.flush()
1471
 
        bzrlib.trace.pop_log_file(self._log_memento)
1472
 
        # Cache the log result and delete the file on disk
1473
 
        self._get_log(False)
 
1762
            trace._trace_file.flush()
 
1763
        trace.pop_log_file(self._log_memento)
 
1764
        # The logging module now tracks references for cleanup so discard ours
 
1765
        del self._log_memento
1474
1766
 
1475
1767
    def thisFailsStrictLockCheck(self):
1476
1768
        """It is known that this test would fail with -Dstrict_locks.
1485
1777
        """
1486
1778
        debug.debug_flags.discard('strict_locks')
1487
1779
 
1488
 
    def addCleanup(self, callable, *args, **kwargs):
1489
 
        """Arrange to run a callable when this case is torn down.
1490
 
 
1491
 
        Callables are run in the reverse of the order they are registered,
1492
 
        ie last-in first-out.
1493
 
        """
1494
 
        self._cleanups.append((callable, args, kwargs))
1495
 
 
1496
1780
    def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1497
1781
        """Overrides an object attribute restoring it after the test.
1498
1782
 
 
1783
        :note: This should be used with discretion; you should think about
 
1784
        whether it's better to make the code testable without monkey-patching.
 
1785
 
1499
1786
        :param obj: The object that will be mutated.
1500
1787
 
1501
1788
        :param attr_name: The attribute name we want to preserve/override in
1505
1792
 
1506
1793
        :returns: The actual attr value.
1507
1794
        """
1508
 
        value = getattr(obj, attr_name)
1509
1795
        # The actual value is captured by the call below
1510
 
        self.addCleanup(setattr, obj, attr_name, value)
 
1796
        value = getattr(obj, attr_name, _unitialized_attr)
 
1797
        if value is _unitialized_attr:
 
1798
            # When the test completes, the attribute should not exist, but if
 
1799
            # we aren't setting a value, we don't need to do anything.
 
1800
            if new is not _unitialized_attr:
 
1801
                self.addCleanup(delattr, obj, attr_name)
 
1802
        else:
 
1803
            self.addCleanup(setattr, obj, attr_name, value)
1511
1804
        if new is not _unitialized_attr:
1512
1805
            setattr(obj, attr_name, new)
1513
1806
        return value
1514
1807
 
 
1808
    def overrideEnv(self, name, new):
 
1809
        """Set an environment variable, and reset it after the test.
 
1810
 
 
1811
        :param name: The environment variable name.
 
1812
 
 
1813
        :param new: The value to set the variable to. If None, the 
 
1814
            variable is deleted from the environment.
 
1815
 
 
1816
        :returns: The actual variable value.
 
1817
        """
 
1818
        value = osutils.set_or_unset_env(name, new)
 
1819
        self.addCleanup(osutils.set_or_unset_env, name, value)
 
1820
        return value
 
1821
 
 
1822
    def recordCalls(self, obj, attr_name):
 
1823
        """Monkeypatch in a wrapper that will record calls.
 
1824
 
 
1825
        The monkeypatch is automatically removed when the test concludes.
 
1826
 
 
1827
        :param obj: The namespace holding the reference to be replaced;
 
1828
            typically a module, class, or object.
 
1829
        :param attr_name: A string for the name of the attribute to 
 
1830
            patch.
 
1831
        :returns: A list that will be extended with one item every time the
 
1832
            function is called, with a tuple of (args, kwargs).
 
1833
        """
 
1834
        calls = []
 
1835
 
 
1836
        def decorator(*args, **kwargs):
 
1837
            calls.append((args, kwargs))
 
1838
            return orig(*args, **kwargs)
 
1839
        orig = self.overrideAttr(obj, attr_name, decorator)
 
1840
        return calls
 
1841
 
1515
1842
    def _cleanEnvironment(self):
1516
 
        new_env = {
1517
 
            'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1518
 
            'HOME': os.getcwd(),
1519
 
            # bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1520
 
            # tests do check our impls match APPDATA
1521
 
            'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1522
 
            'VISUAL': None,
1523
 
            'EDITOR': None,
1524
 
            'BZR_EMAIL': None,
1525
 
            'BZREMAIL': None, # may still be present in the environment
1526
 
            'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
1527
 
            'BZR_PROGRESS_BAR': None,
1528
 
            'BZR_LOG': None,
1529
 
            'BZR_PLUGIN_PATH': None,
1530
 
            'BZR_DISABLE_PLUGINS': None,
1531
 
            'BZR_PLUGINS_AT': None,
1532
 
            'BZR_CONCURRENCY': None,
1533
 
            # Make sure that any text ui tests are consistent regardless of
1534
 
            # the environment the test case is run in; you may want tests that
1535
 
            # test other combinations.  'dumb' is a reasonable guess for tests
1536
 
            # going to a pipe or a StringIO.
1537
 
            'TERM': 'dumb',
1538
 
            'LINES': '25',
1539
 
            'COLUMNS': '80',
1540
 
            'BZR_COLUMNS': '80',
1541
 
            # SSH Agent
1542
 
            'SSH_AUTH_SOCK': None,
1543
 
            # Proxies
1544
 
            'http_proxy': None,
1545
 
            'HTTP_PROXY': None,
1546
 
            'https_proxy': None,
1547
 
            'HTTPS_PROXY': None,
1548
 
            'no_proxy': None,
1549
 
            'NO_PROXY': None,
1550
 
            'all_proxy': None,
1551
 
            'ALL_PROXY': None,
1552
 
            # Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1553
 
            # least. If you do (care), please update this comment
1554
 
            # -- vila 20080401
1555
 
            'ftp_proxy': None,
1556
 
            'FTP_PROXY': None,
1557
 
            'BZR_REMOTE_PATH': None,
1558
 
            # Generally speaking, we don't want apport reporting on crashes in
1559
 
            # the test envirnoment unless we're specifically testing apport,
1560
 
            # so that it doesn't leak into the real system environment.  We
1561
 
            # use an env var so it propagates to subprocesses.
1562
 
            'APPORT_DISABLE': '1',
1563
 
        }
1564
 
        self._old_env = {}
1565
 
        self.addCleanup(self._restoreEnvironment)
1566
 
        for name, value in new_env.iteritems():
1567
 
            self._captureVar(name, value)
1568
 
 
1569
 
    def _captureVar(self, name, newvalue):
1570
 
        """Set an environment variable, and reset it when finished."""
1571
 
        self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
1572
 
 
1573
 
    def _restoreEnvironment(self):
1574
 
        for name, value in self._old_env.iteritems():
1575
 
            osutils.set_or_unset_env(name, value)
 
1843
        for name, value in isolated_environ.iteritems():
 
1844
            self.overrideEnv(name, value)
1576
1845
 
1577
1846
    def _restoreHooks(self):
1578
1847
        for klass, (name, hooks) in self._preserved_hooks.items():
1579
1848
            setattr(klass, name, hooks)
 
1849
        self._preserved_hooks.clear()
 
1850
        bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
 
1851
        self._preserved_lazy_hooks.clear()
1580
1852
 
1581
1853
    def knownFailure(self, reason):
1582
 
        """This test has failed for some known reason."""
1583
 
        raise KnownFailure(reason)
 
1854
        """Declare that this test fails for a known reason
 
1855
 
 
1856
        Tests that are known to fail should generally be using expectedFailure
 
1857
        with an appropriate reverse assertion if a change could cause the test
 
1858
        to start passing. Conversely if the test has no immediate prospect of
 
1859
        succeeding then using skip is more suitable.
 
1860
 
 
1861
        When this method is called while an exception is being handled, that
 
1862
        traceback will be used, otherwise a new exception will be thrown to
 
1863
        provide one but won't be reported.
 
1864
        """
 
1865
        self._add_reason(reason)
 
1866
        try:
 
1867
            exc_info = sys.exc_info()
 
1868
            if exc_info != (None, None, None):
 
1869
                self._report_traceback(exc_info)
 
1870
            else:
 
1871
                try:
 
1872
                    raise self.failureException(reason)
 
1873
                except self.failureException:
 
1874
                    exc_info = sys.exc_info()
 
1875
            # GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
 
1876
            raise testtools.testcase._ExpectedFailure(exc_info)
 
1877
        finally:
 
1878
            del exc_info
 
1879
 
 
1880
    def _suppress_log(self):
 
1881
        """Remove the log info from details."""
 
1882
        self.discardDetail('log')
1584
1883
 
1585
1884
    def _do_skip(self, result, reason):
 
1885
        self._suppress_log()
1586
1886
        addSkip = getattr(result, 'addSkip', None)
1587
1887
        if not callable(addSkip):
1588
1888
            result.addSuccess(result)
1591
1891
 
1592
1892
    @staticmethod
1593
1893
    def _do_known_failure(self, result, e):
 
1894
        self._suppress_log()
1594
1895
        err = sys.exc_info()
1595
1896
        addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1596
1897
        if addExpectedFailure is not None:
1604
1905
            reason = 'No reason given'
1605
1906
        else:
1606
1907
            reason = e.args[0]
 
1908
        self._suppress_log ()
1607
1909
        addNotApplicable = getattr(result, 'addNotApplicable', None)
1608
1910
        if addNotApplicable is not None:
1609
1911
            result.addNotApplicable(self, reason)
1611
1913
            self._do_skip(result, reason)
1612
1914
 
1613
1915
    @staticmethod
 
1916
    def _report_skip(self, result, err):
 
1917
        """Override the default _report_skip.
 
1918
 
 
1919
        We want to strip the 'log' detail. If we waint until _do_skip, it has
 
1920
        already been formatted into the 'reason' string, and we can't pull it
 
1921
        out again.
 
1922
        """
 
1923
        self._suppress_log()
 
1924
        super(TestCase, self)._report_skip(self, result, err)
 
1925
 
 
1926
    @staticmethod
 
1927
    def _report_expected_failure(self, result, err):
 
1928
        """Strip the log.
 
1929
 
 
1930
        See _report_skip for motivation.
 
1931
        """
 
1932
        self._suppress_log()
 
1933
        super(TestCase, self)._report_expected_failure(self, result, err)
 
1934
 
 
1935
    @staticmethod
1614
1936
    def _do_unsupported_or_skip(self, result, e):
1615
1937
        reason = e.args[0]
 
1938
        self._suppress_log()
1616
1939
        addNotSupported = getattr(result, 'addNotSupported', None)
1617
1940
        if addNotSupported is not None:
1618
1941
            result.addNotSupported(self, reason)
1644
1967
            self._benchtime += time.time() - start
1645
1968
 
1646
1969
    def log(self, *args):
1647
 
        mutter(*args)
1648
 
 
1649
 
    def _get_log(self, keep_log_file=False):
1650
 
        """Internal helper to get the log from bzrlib.trace for this test.
1651
 
 
1652
 
        Please use self.getDetails, or self.get_log to access this in test case
1653
 
        code.
1654
 
 
1655
 
        :param keep_log_file: When True, if the log is still a file on disk
1656
 
            leave it as a file on disk. When False, if the log is still a file
1657
 
            on disk, the log file is deleted and the log preserved as
1658
 
            self._log_contents.
1659
 
        :return: A string containing the log.
1660
 
        """
1661
 
        if self._log_contents is not None:
1662
 
            try:
1663
 
                self._log_contents.decode('utf8')
1664
 
            except UnicodeDecodeError:
1665
 
                unicodestr = self._log_contents.decode('utf8', 'replace')
1666
 
                self._log_contents = unicodestr.encode('utf8')
1667
 
            return self._log_contents
1668
 
        import bzrlib.trace
1669
 
        if bzrlib.trace._trace_file:
1670
 
            # flush the log file, to get all content
1671
 
            bzrlib.trace._trace_file.flush()
1672
 
        if self._log_file_name is not None:
1673
 
            logfile = open(self._log_file_name)
1674
 
            try:
1675
 
                log_contents = logfile.read()
1676
 
            finally:
1677
 
                logfile.close()
1678
 
            try:
1679
 
                log_contents.decode('utf8')
1680
 
            except UnicodeDecodeError:
1681
 
                unicodestr = log_contents.decode('utf8', 'replace')
1682
 
                log_contents = unicodestr.encode('utf8')
1683
 
            if not keep_log_file:
1684
 
                close_attempts = 0
1685
 
                max_close_attempts = 100
1686
 
                first_close_error = None
1687
 
                while close_attempts < max_close_attempts:
1688
 
                    close_attempts += 1
1689
 
                    try:
1690
 
                        self._log_file.close()
1691
 
                    except IOError, ioe:
1692
 
                        if ioe.errno is None:
1693
 
                            # No errno implies 'close() called during
1694
 
                            # concurrent operation on the same file object', so
1695
 
                            # retry.  Probably a thread is trying to write to
1696
 
                            # the log file.
1697
 
                            if first_close_error is None:
1698
 
                                first_close_error = ioe
1699
 
                            continue
1700
 
                        raise
1701
 
                    else:
1702
 
                        break
1703
 
                if close_attempts > 1:
1704
 
                    sys.stderr.write(
1705
 
                        'Unable to close log file on first attempt, '
1706
 
                        'will retry: %s\n' % (first_close_error,))
1707
 
                    if close_attempts == max_close_attempts:
1708
 
                        sys.stderr.write(
1709
 
                            'Unable to close log file after %d attempts.\n'
1710
 
                            % (max_close_attempts,))
1711
 
                self._log_file = None
1712
 
                # Permit multiple calls to get_log until we clean it up in
1713
 
                # finishLogFile
1714
 
                self._log_contents = log_contents
1715
 
                try:
1716
 
                    os.remove(self._log_file_name)
1717
 
                except OSError, e:
1718
 
                    if sys.platform == 'win32' and e.errno == errno.EACCES:
1719
 
                        sys.stderr.write(('Unable to delete log file '
1720
 
                                             ' %r\n' % self._log_file_name))
1721
 
                    else:
1722
 
                        raise
1723
 
                self._log_file_name = None
1724
 
            return log_contents
1725
 
        else:
1726
 
            return "No log file content and no log file name."
 
1970
        trace.mutter(*args)
1727
1971
 
1728
1972
    def get_log(self):
1729
1973
        """Get a unicode string containing the log from bzrlib.trace.
1765
2009
 
1766
2010
        self.log('run bzr: %r', args)
1767
2011
        # FIXME: don't call into logging here
1768
 
        handler = logging.StreamHandler(stderr)
1769
 
        handler.setLevel(logging.INFO)
 
2012
        handler = trace.EncodedStreamHandler(stderr, errors="replace",
 
2013
            level=logging.INFO)
1770
2014
        logger = logging.getLogger('')
1771
2015
        logger.addHandler(handler)
1772
2016
        old_ui_factory = ui.ui_factory
1779
2023
 
1780
2024
        try:
1781
2025
            try:
1782
 
                result = self.apply_redirected(ui.ui_factory.stdin,
 
2026
                result = self.apply_redirected(
 
2027
                    ui.ui_factory.stdin,
1783
2028
                    stdout, stderr,
1784
 
                    bzrlib.commands.run_bzr_catch_user_errors,
 
2029
                    _mod_commands.run_bzr_catch_user_errors,
1785
2030
                    args)
1786
2031
            except KeyboardInterrupt:
1787
2032
                # Reraise KeyboardInterrupt with contents of redirected stdout
1807
2052
        if err:
1808
2053
            self.log('errors:\n%r', err)
1809
2054
        if retcode is not None:
1810
 
            self.assertEquals(retcode, result,
 
2055
            self.assertEqual(retcode, result,
1811
2056
                              message='Unexpected return code')
1812
2057
        return result, out, err
1813
2058
 
1929
2174
    def start_bzr_subprocess(self, process_args, env_changes=None,
1930
2175
                             skip_if_plan_to_signal=False,
1931
2176
                             working_dir=None,
1932
 
                             allow_plugins=False):
 
2177
                             allow_plugins=False, stderr=subprocess.PIPE):
1933
2178
        """Start bzr in a subprocess for testing.
1934
2179
 
1935
2180
        This starts a new Python interpreter and runs bzr in there.
1944
2189
            variables. A value of None will unset the env variable.
1945
2190
            The values must be strings. The change will only occur in the
1946
2191
            child, so you don't need to fix the environment after running.
1947
 
        :param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1948
 
            is not available.
 
2192
        :param skip_if_plan_to_signal: raise TestSkipped when true and system
 
2193
            doesn't support signalling subprocesses.
1949
2194
        :param allow_plugins: If False (default) pass --no-plugins to bzr.
 
2195
        :param stderr: file to use for the subprocess's stderr.  Valid values
 
2196
            are those valid for the stderr argument of `subprocess.Popen`.
 
2197
            Default value is ``subprocess.PIPE``.
1950
2198
 
1951
2199
        :returns: Popen object for the started process.
1952
2200
        """
1953
2201
        if skip_if_plan_to_signal:
1954
 
            if not getattr(os, 'kill', None):
1955
 
                raise TestSkipped("os.kill not available.")
 
2202
            if os.name != "posix":
 
2203
                raise TestSkipped("Sending signals not supported")
1956
2204
 
1957
2205
        if env_changes is None:
1958
2206
            env_changes = {}
 
2207
        # Because $HOME is set to a tempdir for the context of a test, modules
 
2208
        # installed in the user dir will not be found unless $PYTHONUSERBASE
 
2209
        # gets set to the computed directory of this parent process.
 
2210
        if site.USER_BASE is not None:
 
2211
            env_changes["PYTHONUSERBASE"] = site.USER_BASE
1959
2212
        old_env = {}
1960
2213
 
1961
2214
        def cleanup_environment():
1978
2231
            # so we will avoid using it on all platforms, just to
1979
2232
            # make sure the code path is used, and we don't break on win32
1980
2233
            cleanup_environment()
 
2234
            # Include the subprocess's log file in the test details, in case
 
2235
            # the test fails due to an error in the subprocess.
 
2236
            self._add_subprocess_log(trace._get_bzr_log_filename())
1981
2237
            command = [sys.executable]
1982
2238
            # frozen executables don't need the path to bzr
1983
2239
            if getattr(sys, "frozen", None) is None:
1987
2243
            command.extend(process_args)
1988
2244
            process = self._popen(command, stdin=subprocess.PIPE,
1989
2245
                                  stdout=subprocess.PIPE,
1990
 
                                  stderr=subprocess.PIPE)
 
2246
                                  stderr=stderr)
1991
2247
        finally:
1992
2248
            restore_environment()
1993
2249
            if cwd is not None:
1995
2251
 
1996
2252
        return process
1997
2253
 
 
2254
    def _add_subprocess_log(self, log_file_path):
 
2255
        if len(self._log_files) == 0:
 
2256
            # Register an addCleanup func.  We do this on the first call to
 
2257
            # _add_subprocess_log rather than in TestCase.setUp so that this
 
2258
            # addCleanup is registered after any cleanups for tempdirs that
 
2259
            # subclasses might create, which will probably remove the log file
 
2260
            # we want to read.
 
2261
            self.addCleanup(self._subprocess_log_cleanup)
 
2262
        # self._log_files is a set, so if a log file is reused we won't grab it
 
2263
        # twice.
 
2264
        self._log_files.add(log_file_path)
 
2265
 
 
2266
    def _subprocess_log_cleanup(self):
 
2267
        for count, log_file_path in enumerate(self._log_files):
 
2268
            # We use buffer_now=True to avoid holding the file open beyond
 
2269
            # the life of this function, which might interfere with e.g.
 
2270
            # cleaning tempdirs on Windows.
 
2271
            # XXX: Testtools 0.9.5 doesn't have the content_from_file helper
 
2272
            #detail_content = content.content_from_file(
 
2273
            #    log_file_path, buffer_now=True)
 
2274
            with open(log_file_path, 'rb') as log_file:
 
2275
                log_file_bytes = log_file.read()
 
2276
            detail_content = content.Content(content.ContentType("text",
 
2277
                "plain", {"charset": "utf8"}), lambda: [log_file_bytes])
 
2278
            self.addDetail("start_bzr_subprocess-log-%d" % (count,),
 
2279
                detail_content)
 
2280
 
1998
2281
    def _popen(self, *args, **kwargs):
1999
2282
        """Place a call to Popen.
2000
2283
 
2037
2320
        if retcode is not None and retcode != process.returncode:
2038
2321
            if process_args is None:
2039
2322
                process_args = "(unknown args)"
2040
 
            mutter('Output of bzr %s:\n%s', process_args, out)
2041
 
            mutter('Error for bzr %s:\n%s', process_args, err)
 
2323
            trace.mutter('Output of bzr %s:\n%s', process_args, out)
 
2324
            trace.mutter('Error for bzr %s:\n%s', process_args, err)
2042
2325
            self.fail('Command bzr %s failed with retcode %s != %s'
2043
2326
                      % (process_args, retcode, process.returncode))
2044
2327
        return [out, err]
2045
2328
 
2046
 
    def check_inventory_shape(self, inv, shape):
2047
 
        """Compare an inventory to a list of expected names.
 
2329
    def check_tree_shape(self, tree, shape):
 
2330
        """Compare a tree to a list of expected names.
2048
2331
 
2049
2332
        Fail if they are not precisely equal.
2050
2333
        """
2051
2334
        extras = []
2052
2335
        shape = list(shape)             # copy
2053
 
        for path, ie in inv.entries():
 
2336
        for path, ie in tree.iter_entries_by_dir():
2054
2337
            name = path.replace('\\', '/')
2055
2338
            if ie.kind == 'directory':
2056
2339
                name = name + '/'
2057
 
            if name in shape:
 
2340
            if name == "/":
 
2341
                pass # ignore root entry
 
2342
            elif name in shape:
2058
2343
                shape.remove(name)
2059
2344
            else:
2060
2345
                extras.append(name)
2101
2386
 
2102
2387
        Tests that expect to provoke LockContention errors should call this.
2103
2388
        """
2104
 
        self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
 
2389
        self.overrideAttr(lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2105
2390
 
2106
2391
    def make_utf8_encoded_stringio(self, encoding_type=None):
2107
2392
        """Return a StringIOWrapper instance, that will encode Unicode
2120
2405
        from bzrlib.smart import request
2121
2406
        request_handlers = request.request_handlers
2122
2407
        orig_method = request_handlers.get(verb)
 
2408
        orig_info = request_handlers.get_info(verb)
2123
2409
        request_handlers.remove(verb)
2124
 
        self.addCleanup(request_handlers.register, verb, orig_method)
 
2410
        self.addCleanup(request_handlers.register, verb, orig_method,
 
2411
            info=orig_info)
2125
2412
 
2126
2413
 
2127
2414
class CapturedCall(object):
2150
2437
class TestCaseWithMemoryTransport(TestCase):
2151
2438
    """Common test class for tests that do not need disk resources.
2152
2439
 
2153
 
    Tests that need disk resources should derive from TestCaseWithTransport.
 
2440
    Tests that need disk resources should derive from TestCaseInTempDir
 
2441
    orTestCaseWithTransport.
2154
2442
 
2155
2443
    TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2156
2444
 
2157
 
    For TestCaseWithMemoryTransport the test_home_dir is set to the name of
 
2445
    For TestCaseWithMemoryTransport the ``test_home_dir`` is set to the name of
2158
2446
    a directory which does not exist. This serves to help ensure test isolation
2159
 
    is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2160
 
    must exist. However, TestCaseWithMemoryTransport does not offer local
2161
 
    file defaults for the transport in tests, nor does it obey the command line
 
2447
    is preserved. ``test_dir`` is set to the TEST_ROOT, as is cwd, because they
 
2448
    must exist. However, TestCaseWithMemoryTransport does not offer local file
 
2449
    defaults for the transport in tests, nor does it obey the command line
2162
2450
    override, so tests that accidentally write to the common directory should
2163
2451
    be rare.
2164
2452
 
2165
 
    :cvar TEST_ROOT: Directory containing all temporary directories, plus
2166
 
    a .bzr directory that stops us ascending higher into the filesystem.
 
2453
    :cvar TEST_ROOT: Directory containing all temporary directories, plus a
 
2454
        ``.bzr`` directory that stops us ascending higher into the filesystem.
2167
2455
    """
2168
2456
 
2169
2457
    TEST_ROOT = None
2179
2467
        self.transport_readonly_server = None
2180
2468
        self.__vfs_server = None
2181
2469
 
 
2470
    def setUp(self):
 
2471
        super(TestCaseWithMemoryTransport, self).setUp()
 
2472
 
 
2473
        def _add_disconnect_cleanup(transport):
 
2474
            """Schedule disconnection of given transport at test cleanup
 
2475
 
 
2476
            This needs to happen for all connected transports or leaks occur.
 
2477
 
 
2478
            Note reconnections may mean we call disconnect multiple times per
 
2479
            transport which is suboptimal but seems harmless.
 
2480
            """
 
2481
            self.addCleanup(transport.disconnect)
 
2482
 
 
2483
        _mod_transport.Transport.hooks.install_named_hook('post_connect',
 
2484
            _add_disconnect_cleanup, None)
 
2485
 
 
2486
        self._make_test_root()
 
2487
        self.addCleanup(os.chdir, os.getcwdu())
 
2488
        self.makeAndChdirToTestDir()
 
2489
        self.overrideEnvironmentForTesting()
 
2490
        self.__readonly_server = None
 
2491
        self.__server = None
 
2492
        self.reduceLockdirTimeout()
 
2493
        # Each test may use its own config files even if the local config files
 
2494
        # don't actually exist. They'll rightly fail if they try to create them
 
2495
        # though.
 
2496
        self.overrideAttr(config, '_shared_stores', {})
 
2497
 
2182
2498
    def get_transport(self, relpath=None):
2183
2499
        """Return a writeable transport.
2184
2500
 
2187
2503
 
2188
2504
        :param relpath: a path relative to the base url.
2189
2505
        """
2190
 
        t = _mod_transport.get_transport(self.get_url(relpath))
 
2506
        t = _mod_transport.get_transport_from_url(self.get_url(relpath))
2191
2507
        self.assertFalse(t.is_readonly())
2192
2508
        return t
2193
2509
 
2199
2515
 
2200
2516
        :param relpath: a path relative to the base url.
2201
2517
        """
2202
 
        t = _mod_transport.get_transport(self.get_readonly_url(relpath))
 
2518
        t = _mod_transport.get_transport_from_url(
 
2519
            self.get_readonly_url(relpath))
2203
2520
        self.assertTrue(t.is_readonly())
2204
2521
        return t
2205
2522
 
2326
2643
        real branch.
2327
2644
        """
2328
2645
        root = TestCaseWithMemoryTransport.TEST_ROOT
2329
 
        bzrdir.BzrDir.create_standalone_workingtree(root)
 
2646
        try:
 
2647
            # Make sure we get a readable and accessible home for .bzr.log
 
2648
            # and/or config files, and not fallback to weird defaults (see
 
2649
            # http://pad.lv/825027).
 
2650
            self.assertIs(None, os.environ.get('BZR_HOME', None))
 
2651
            os.environ['BZR_HOME'] = root
 
2652
            wt = controldir.ControlDir.create_standalone_workingtree(root)
 
2653
            del os.environ['BZR_HOME']
 
2654
        except Exception, e:
 
2655
            self.fail("Fail to initialize the safety net: %r\n" % (e,))
 
2656
        # Hack for speed: remember the raw bytes of the dirstate file so that
 
2657
        # we don't need to re-open the wt to check it hasn't changed.
 
2658
        TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE = (
 
2659
            wt.control_transport.get_bytes('dirstate'))
2330
2660
 
2331
2661
    def _check_safety_net(self):
2332
2662
        """Check that the safety .bzr directory have not been touched.
2335
2665
        propagating. This method ensures than a test did not leaked.
2336
2666
        """
2337
2667
        root = TestCaseWithMemoryTransport.TEST_ROOT
2338
 
        self.permit_url(_mod_transport.get_transport(root).base)
2339
 
        wt = workingtree.WorkingTree.open(root)
2340
 
        last_rev = wt.last_revision()
2341
 
        if last_rev != 'null:':
 
2668
        t = _mod_transport.get_transport_from_path(root)
 
2669
        self.permit_url(t.base)
 
2670
        if (t.get_bytes('.bzr/checkout/dirstate') != 
 
2671
                TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE):
2342
2672
            # The current test have modified the /bzr directory, we need to
2343
2673
            # recreate a new one or all the followng tests will fail.
2344
2674
            # If you need to inspect its content uncomment the following line
2376
2706
        self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2377
2707
        self.permit_dir(self.test_dir)
2378
2708
 
2379
 
    def make_branch(self, relpath, format=None):
 
2709
    def make_branch(self, relpath, format=None, name=None):
2380
2710
        """Create a branch on the transport at relpath."""
2381
2711
        repo = self.make_repository(relpath, format=format)
2382
 
        return repo.bzrdir.create_branch()
 
2712
        return repo.bzrdir.create_branch(append_revisions_only=False,
 
2713
                                         name=name)
 
2714
 
 
2715
    def get_default_format(self):
 
2716
        return 'default'
 
2717
 
 
2718
    def resolve_format(self, format):
 
2719
        """Resolve an object to a ControlDir format object.
 
2720
 
 
2721
        The initial format object can either already be
 
2722
        a ControlDirFormat, None (for the default format),
 
2723
        or a string with the name of the control dir format.
 
2724
 
 
2725
        :param format: Object to resolve
 
2726
        :return A ControlDirFormat instance
 
2727
        """
 
2728
        if format is None:
 
2729
            format = self.get_default_format()
 
2730
        if isinstance(format, basestring):
 
2731
            format = controldir.format_registry.make_bzrdir(format)
 
2732
        return format
2383
2733
 
2384
2734
    def make_bzrdir(self, relpath, format=None):
2385
2735
        try:
2389
2739
            t = _mod_transport.get_transport(maybe_a_url)
2390
2740
            if len(segments) > 1 and segments[-1] not in ('', '.'):
2391
2741
                t.ensure_base()
2392
 
            if format is None:
2393
 
                format = 'default'
2394
 
            if isinstance(format, basestring):
2395
 
                format = bzrdir.format_registry.make_bzrdir(format)
 
2742
            format = self.resolve_format(format)
2396
2743
            return format.initialize_on_transport(t)
2397
2744
        except errors.UninitializableFormat:
2398
2745
            raise TestSkipped("Format %s is not initializable." % format)
2399
2746
 
2400
 
    def make_repository(self, relpath, shared=False, format=None):
 
2747
    def make_repository(self, relpath, shared=None, format=None):
2401
2748
        """Create a repository on our default transport at relpath.
2402
2749
 
2403
2750
        Note that relpath must be a relative path, not a full url.
2414
2761
            backing_server = self.get_server()
2415
2762
        smart_server = test_server.SmartTCPServer_for_testing()
2416
2763
        self.start_server(smart_server, backing_server)
2417
 
        remote_transport = _mod_transport.get_transport(smart_server.get_url()
 
2764
        remote_transport = _mod_transport.get_transport_from_url(smart_server.get_url()
2418
2765
                                                   ).clone(path)
2419
2766
        return remote_transport
2420
2767
 
2431
2778
        test_home_dir = self.test_home_dir
2432
2779
        if isinstance(test_home_dir, unicode):
2433
2780
            test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2434
 
        os.environ['HOME'] = test_home_dir
2435
 
        os.environ['BZR_HOME'] = test_home_dir
2436
 
 
2437
 
    def setUp(self):
2438
 
        super(TestCaseWithMemoryTransport, self).setUp()
2439
 
        # Ensure that ConnectedTransport doesn't leak sockets
2440
 
        def get_transport_with_cleanup(*args, **kwargs):
2441
 
            t = orig_get_transport(*args, **kwargs)
2442
 
            if isinstance(t, _mod_transport.ConnectedTransport):
2443
 
                self.addCleanup(t.disconnect)
2444
 
            return t
2445
 
 
2446
 
        orig_get_transport = self.overrideAttr(_mod_transport, 'get_transport',
2447
 
                                               get_transport_with_cleanup)
2448
 
        self._make_test_root()
2449
 
        self.addCleanup(os.chdir, os.getcwdu())
2450
 
        self.makeAndChdirToTestDir()
2451
 
        self.overrideEnvironmentForTesting()
2452
 
        self.__readonly_server = None
2453
 
        self.__server = None
2454
 
        self.reduceLockdirTimeout()
 
2781
        self.overrideEnv('HOME', test_home_dir)
 
2782
        self.overrideEnv('BZR_HOME', test_home_dir)
2455
2783
 
2456
2784
    def setup_smart_server_with_call_log(self):
2457
2785
        """Sets up a smart server as the transport server with a call log."""
2458
2786
        self.transport_server = test_server.SmartTCPServer_for_testing
 
2787
        self.hpss_connections = []
2459
2788
        self.hpss_calls = []
2460
2789
        import traceback
2461
2790
        # Skip the current stack down to the caller of
2464
2793
        def capture_hpss_call(params):
2465
2794
            self.hpss_calls.append(
2466
2795
                CapturedCall(params, prefix_length))
 
2796
        def capture_connect(transport):
 
2797
            self.hpss_connections.append(transport)
2467
2798
        client._SmartClient.hooks.install_named_hook(
2468
2799
            'call', capture_hpss_call, None)
 
2800
        _mod_transport.Transport.hooks.install_named_hook(
 
2801
            'post_connect', capture_connect, None)
2469
2802
 
2470
2803
    def reset_smart_call_log(self):
2471
2804
        self.hpss_calls = []
 
2805
        self.hpss_connections = []
2472
2806
 
2473
2807
 
2474
2808
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2493
2827
 
2494
2828
    OVERRIDE_PYTHON = 'python'
2495
2829
 
 
2830
    def setUp(self):
 
2831
        super(TestCaseInTempDir, self).setUp()
 
2832
        # Remove the protection set in isolated_environ, we have a proper
 
2833
        # access to disk resources now.
 
2834
        self.overrideEnv('BZR_LOG', None)
 
2835
 
2496
2836
    def check_file_contents(self, filename, expect):
2497
2837
        self.log("check contents of file %s" % filename)
2498
2838
        f = file(filename)
2538
2878
        # stacking policy to honour; create a bzr dir with an unshared
2539
2879
        # repository (but not a branch - our code would be trying to escape
2540
2880
        # then!) to stop them, and permit it to be read.
2541
 
        # control = bzrdir.BzrDir.create(self.test_base_dir)
 
2881
        # control = controldir.ControlDir.create(self.test_base_dir)
2542
2882
        # control.create_repository()
2543
2883
        self.test_home_dir = self.test_base_dir + '/home'
2544
2884
        os.mkdir(self.test_home_dir)
2579
2919
                "a list or a tuple. Got %r instead" % (shape,))
2580
2920
        # It's OK to just create them using forward slashes on windows.
2581
2921
        if transport is None or transport.is_readonly():
2582
 
            transport = _mod_transport.get_transport(".")
 
2922
            transport = _mod_transport.get_transport_from_path(".")
2583
2923
        for name in shape:
2584
2924
            self.assertIsInstance(name, basestring)
2585
2925
            if name[-1] == '/':
2633
2973
    readwrite one must both define get_url() as resolving to os.getcwd().
2634
2974
    """
2635
2975
 
 
2976
    def setUp(self):
 
2977
        super(TestCaseWithTransport, self).setUp()
 
2978
        self.__vfs_server = None
 
2979
 
2636
2980
    def get_vfs_only_server(self):
2637
2981
        """See TestCaseWithMemoryTransport.
2638
2982
 
2670
3014
        # this obviously requires a format that supports branch references
2671
3015
        # so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2672
3016
        # RBC 20060208
 
3017
        format = self.resolve_format(format=format)
 
3018
        if not format.supports_workingtrees:
 
3019
            b = self.make_branch(relpath+'.branch', format=format)
 
3020
            return b.create_checkout(relpath, lightweight=True)
2673
3021
        b = self.make_branch(relpath, format=format)
2674
3022
        try:
2675
3023
            return b.bzrdir.create_workingtree()
2680
3028
            if self.vfs_transport_factory is test_server.LocalURLServer:
2681
3029
                # the branch is colocated on disk, we cannot create a checkout.
2682
3030
                # hopefully callers will expect this.
2683
 
                local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
 
3031
                local_controldir = controldir.ControlDir.open(
 
3032
                    self.get_vfs_only_url(relpath))
2684
3033
                wt = local_controldir.create_workingtree()
2685
3034
                if wt.branch._format != b._format:
2686
3035
                    wt._branch = b
2716
3065
        self.assertFalse(differences.has_changed(),
2717
3066
            "Trees %r and %r are different: %r" % (left, right, differences))
2718
3067
 
2719
 
    def setUp(self):
2720
 
        super(TestCaseWithTransport, self).setUp()
2721
 
        self.__vfs_server = None
2722
 
 
2723
3068
    def disable_missing_extensions_warning(self):
2724
3069
        """Some tests expect a precise stderr content.
2725
3070
 
2726
3071
        There is no point in forcing them to duplicate the extension related
2727
3072
        warning.
2728
3073
        """
2729
 
        config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
 
3074
        config.GlobalStack().set('ignore_missing_extensions', True)
2730
3075
 
2731
3076
 
2732
3077
class ChrootedTestCase(TestCaseWithTransport):
2974
3319
                            result_decorators=result_decorators,
2975
3320
                            )
2976
3321
    runner.stop_on_failure=stop_on_failure
 
3322
    if isinstance(suite, unittest.TestSuite):
 
3323
        # Empty out _tests list of passed suite and populate new TestSuite
 
3324
        suite._tests[:], suite = [], TestSuite(suite)
2977
3325
    # built in decorator factories:
2978
3326
    decorators = [
2979
3327
        random_order(random_seed, runner),
3012
3360
 
3013
3361
 
3014
3362
def fork_decorator(suite):
 
3363
    if getattr(os, "fork", None) is None:
 
3364
        raise errors.BzrCommandError("platform does not support fork,"
 
3365
            " try --parallel=subprocess instead.")
3015
3366
    concurrency = osutils.local_concurrency()
3016
3367
    if concurrency == 1:
3017
3368
        return suite
3074
3425
 
3075
3426
class TestDecorator(TestUtil.TestSuite):
3076
3427
    """A decorator for TestCase/TestSuite objects.
3077
 
    
3078
 
    Usually, subclasses should override __iter__(used when flattening test
3079
 
    suites), which we do to filter, reorder, parallelise and so on, run() and
3080
 
    debug().
 
3428
 
 
3429
    Contains rather than flattening suite passed on construction
3081
3430
    """
3082
3431
 
3083
 
    def __init__(self, suite):
3084
 
        TestUtil.TestSuite.__init__(self)
3085
 
        self.addTest(suite)
3086
 
 
3087
 
    def countTestCases(self):
3088
 
        cases = 0
3089
 
        for test in self:
3090
 
            cases += test.countTestCases()
3091
 
        return cases
3092
 
 
3093
 
    def debug(self):
3094
 
        for test in self:
3095
 
            test.debug()
3096
 
 
3097
 
    def run(self, result):
3098
 
        # Use iteration on self, not self._tests, to allow subclasses to hook
3099
 
        # into __iter__.
3100
 
        for test in self:
3101
 
            if result.shouldStop:
3102
 
                break
3103
 
            test.run(result)
3104
 
        return result
 
3432
    def __init__(self, suite=None):
 
3433
        super(TestDecorator, self).__init__()
 
3434
        if suite is not None:
 
3435
            self.addTest(suite)
 
3436
 
 
3437
    # Don't need subclass run method with suite emptying
 
3438
    run = unittest.TestSuite.run
3105
3439
 
3106
3440
 
3107
3441
class CountingDecorator(TestDecorator):
3118
3452
    """A decorator which excludes test matching an exclude pattern."""
3119
3453
 
3120
3454
    def __init__(self, suite, exclude_pattern):
3121
 
        TestDecorator.__init__(self, suite)
3122
 
        self.exclude_pattern = exclude_pattern
3123
 
        self.excluded = False
3124
 
 
3125
 
    def __iter__(self):
3126
 
        if self.excluded:
3127
 
            return iter(self._tests)
3128
 
        self.excluded = True
3129
 
        suite = exclude_tests_by_re(self, self.exclude_pattern)
3130
 
        del self._tests[:]
3131
 
        self.addTests(suite)
3132
 
        return iter(self._tests)
 
3455
        super(ExcludeDecorator, self).__init__(
 
3456
            exclude_tests_by_re(suite, exclude_pattern))
3133
3457
 
3134
3458
 
3135
3459
class FilterTestsDecorator(TestDecorator):
3136
3460
    """A decorator which filters tests to those matching a pattern."""
3137
3461
 
3138
3462
    def __init__(self, suite, pattern):
3139
 
        TestDecorator.__init__(self, suite)
3140
 
        self.pattern = pattern
3141
 
        self.filtered = False
3142
 
 
3143
 
    def __iter__(self):
3144
 
        if self.filtered:
3145
 
            return iter(self._tests)
3146
 
        self.filtered = True
3147
 
        suite = filter_suite_by_re(self, self.pattern)
3148
 
        del self._tests[:]
3149
 
        self.addTests(suite)
3150
 
        return iter(self._tests)
 
3463
        super(FilterTestsDecorator, self).__init__(
 
3464
            filter_suite_by_re(suite, pattern))
3151
3465
 
3152
3466
 
3153
3467
class RandomDecorator(TestDecorator):
3154
3468
    """A decorator which randomises the order of its tests."""
3155
3469
 
3156
3470
    def __init__(self, suite, random_seed, stream):
3157
 
        TestDecorator.__init__(self, suite)
3158
 
        self.random_seed = random_seed
3159
 
        self.randomised = False
3160
 
        self.stream = stream
3161
 
 
3162
 
    def __iter__(self):
3163
 
        if self.randomised:
3164
 
            return iter(self._tests)
3165
 
        self.randomised = True
3166
 
        self.stream.write("Randomizing test order using seed %s\n\n" %
3167
 
            (self.actual_seed()))
 
3471
        random_seed = self.actual_seed(random_seed)
 
3472
        stream.write("Randomizing test order using seed %s\n\n" %
 
3473
            (random_seed,))
3168
3474
        # Initialise the random number generator.
3169
 
        random.seed(self.actual_seed())
3170
 
        suite = randomize_suite(self)
3171
 
        del self._tests[:]
3172
 
        self.addTests(suite)
3173
 
        return iter(self._tests)
 
3475
        random.seed(random_seed)
 
3476
        super(RandomDecorator, self).__init__(randomize_suite(suite))
3174
3477
 
3175
 
    def actual_seed(self):
3176
 
        if self.random_seed == "now":
 
3478
    @staticmethod
 
3479
    def actual_seed(seed):
 
3480
        if seed == "now":
3177
3481
            # We convert the seed to a long to make it reuseable across
3178
3482
            # invocations (because the user can reenter it).
3179
 
            self.random_seed = long(time.time())
 
3483
            return long(time.time())
3180
3484
        else:
3181
3485
            # Convert the seed to a long if we can
3182
3486
            try:
3183
 
                self.random_seed = long(self.random_seed)
3184
 
            except:
 
3487
                return long(seed)
 
3488
            except (TypeError, ValueError):
3185
3489
                pass
3186
 
        return self.random_seed
 
3490
        return seed
3187
3491
 
3188
3492
 
3189
3493
class TestFirstDecorator(TestDecorator):
3190
3494
    """A decorator which moves named tests to the front."""
3191
3495
 
3192
3496
    def __init__(self, suite, pattern):
3193
 
        TestDecorator.__init__(self, suite)
3194
 
        self.pattern = pattern
3195
 
        self.filtered = False
3196
 
 
3197
 
    def __iter__(self):
3198
 
        if self.filtered:
3199
 
            return iter(self._tests)
3200
 
        self.filtered = True
3201
 
        suites = split_suite_by_re(self, self.pattern)
3202
 
        del self._tests[:]
3203
 
        self.addTests(suites)
3204
 
        return iter(self._tests)
 
3497
        super(TestFirstDecorator, self).__init__()
 
3498
        self.addTests(split_suite_by_re(suite, pattern))
3205
3499
 
3206
3500
 
3207
3501
def partition_tests(suite, count):
3239
3533
    """
3240
3534
    concurrency = osutils.local_concurrency()
3241
3535
    result = []
3242
 
    from subunit import TestProtocolClient, ProtocolTestCase
 
3536
    from subunit import ProtocolTestCase
3243
3537
    from subunit.test_results import AutoTimingTestResultDecorator
3244
3538
    class TestInOtherProcess(ProtocolTestCase):
3245
3539
        # Should be in subunit, I think. RBC.
3251
3545
            try:
3252
3546
                ProtocolTestCase.run(self, result)
3253
3547
            finally:
3254
 
                os.waitpid(self.pid, 0)
 
3548
                pid, status = os.waitpid(self.pid, 0)
 
3549
            # GZ 2011-10-18: If status is nonzero, should report to the result
 
3550
            #                that something went wrong.
3255
3551
 
3256
3552
    test_blocks = partition_tests(suite, concurrency)
 
3553
    # Clear the tests from the original suite so it doesn't keep them alive
 
3554
    suite._tests[:] = []
3257
3555
    for process_tests in test_blocks:
3258
 
        process_suite = TestUtil.TestSuite()
3259
 
        process_suite.addTests(process_tests)
 
3556
        process_suite = TestUtil.TestSuite(process_tests)
 
3557
        # Also clear each split list so new suite has only reference
 
3558
        process_tests[:] = []
3260
3559
        c2pread, c2pwrite = os.pipe()
3261
3560
        pid = os.fork()
3262
3561
        if pid == 0:
3263
 
            workaround_zealous_crypto_random()
3264
3562
            try:
 
3563
                stream = os.fdopen(c2pwrite, 'wb', 1)
 
3564
                workaround_zealous_crypto_random()
3265
3565
                os.close(c2pread)
3266
3566
                # Leave stderr and stdout open so we can see test noise
3267
3567
                # Close stdin so that the child goes away if it decides to
3268
3568
                # read from stdin (otherwise its a roulette to see what
3269
3569
                # child actually gets keystrokes for pdb etc).
3270
3570
                sys.stdin.close()
3271
 
                sys.stdin = None
3272
 
                stream = os.fdopen(c2pwrite, 'wb', 1)
3273
3571
                subunit_result = AutoTimingTestResultDecorator(
3274
 
                    TestProtocolClient(stream))
 
3572
                    SubUnitBzrProtocolClient(stream))
3275
3573
                process_suite.run(subunit_result)
3276
 
            finally:
3277
 
                os._exit(0)
 
3574
            except:
 
3575
                # Try and report traceback on stream, but exit with error even
 
3576
                # if stream couldn't be created or something else goes wrong.
 
3577
                # The traceback is formatted to a string and written in one go
 
3578
                # to avoid interleaving lines from multiple failing children.
 
3579
                try:
 
3580
                    stream.write(traceback.format_exc())
 
3581
                finally:
 
3582
                    os._exit(1)
 
3583
            os._exit(0)
3278
3584
        else:
3279
3585
            os.close(c2pwrite)
3280
3586
            stream = os.fdopen(c2pread, 'rb', 1)
3341
3647
    return result
3342
3648
 
3343
3649
 
3344
 
class ForwardingResult(unittest.TestResult):
3345
 
 
3346
 
    def __init__(self, target):
3347
 
        unittest.TestResult.__init__(self)
3348
 
        self.result = target
3349
 
 
3350
 
    def startTest(self, test):
3351
 
        self.result.startTest(test)
3352
 
 
3353
 
    def stopTest(self, test):
3354
 
        self.result.stopTest(test)
3355
 
 
3356
 
    def startTestRun(self):
3357
 
        self.result.startTestRun()
3358
 
 
3359
 
    def stopTestRun(self):
3360
 
        self.result.stopTestRun()
3361
 
 
3362
 
    def addSkip(self, test, reason):
3363
 
        self.result.addSkip(test, reason)
3364
 
 
3365
 
    def addSuccess(self, test):
3366
 
        self.result.addSuccess(test)
3367
 
 
3368
 
    def addError(self, test, err):
3369
 
        self.result.addError(test, err)
3370
 
 
3371
 
    def addFailure(self, test, err):
3372
 
        self.result.addFailure(test, err)
3373
 
ForwardingResult = testtools.ExtendedToOriginalDecorator
3374
 
 
3375
 
 
3376
 
class ProfileResult(ForwardingResult):
 
3650
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3377
3651
    """Generate profiling data for all activity between start and success.
3378
3652
    
3379
3653
    The profile data is appended to the test's _benchcalls attribute and can
3391
3665
        # unavoidably fail.
3392
3666
        bzrlib.lsprof.BzrProfiler.profiler_block = 0
3393
3667
        self.profiler.start()
3394
 
        ForwardingResult.startTest(self, test)
 
3668
        testtools.ExtendedToOriginalDecorator.startTest(self, test)
3395
3669
 
3396
3670
    def addSuccess(self, test):
3397
3671
        stats = self.profiler.stop()
3401
3675
            test._benchcalls = []
3402
3676
            calls = test._benchcalls
3403
3677
        calls.append(((test.id(), "", ""), stats))
3404
 
        ForwardingResult.addSuccess(self, test)
 
3678
        testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3405
3679
 
3406
3680
    def stopTest(self, test):
3407
 
        ForwardingResult.stopTest(self, test)
 
3681
        testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3408
3682
        self.profiler = None
3409
3683
 
3410
3684
 
3418
3692
#                           with proper exclusion rules.
3419
3693
#   -Ethreads               Will display thread ident at creation/join time to
3420
3694
#                           help track thread leaks
 
3695
#   -Euncollected_cases     Display the identity of any test cases that weren't
 
3696
#                           deallocated after being completed.
 
3697
#   -Econfig_stats          Will collect statistics using addDetail
3421
3698
selftest_debug_flags = set()
3422
3699
 
3423
3700
 
3527
3804
 
3528
3805
    :return: (absents, duplicates) absents is a list containing the test found
3529
3806
        in id_list but not in test_suite, duplicates is a list containing the
3530
 
        test found multiple times in test_suite.
 
3807
        tests found multiple times in test_suite.
3531
3808
 
3532
3809
    When using a prefined test id list, it may occurs that some tests do not
3533
3810
    exist anymore or that some tests use the same id. This function warns the
3617
3894
                key, obj, help=help, info=info, override_existing=False)
3618
3895
        except KeyError:
3619
3896
            actual = self.get(key)
3620
 
            note('Test prefix alias %s is already used for %s, ignoring %s'
3621
 
                 % (key, actual, obj))
 
3897
            trace.note(
 
3898
                'Test prefix alias %s is already used for %s, ignoring %s'
 
3899
                % (key, actual, obj))
3622
3900
 
3623
3901
    def resolve_alias(self, id_start):
3624
3902
        """Replace the alias by the prefix in the given string.
3656
3934
        'bzrlib.doc',
3657
3935
        'bzrlib.tests.blackbox',
3658
3936
        'bzrlib.tests.commands',
3659
 
        'bzrlib.tests.doc_generate',
3660
3937
        'bzrlib.tests.per_branch',
 
3938
        'bzrlib.tests.per_bzrdir',
3661
3939
        'bzrlib.tests.per_controldir',
3662
3940
        'bzrlib.tests.per_controldir_colo',
3663
3941
        'bzrlib.tests.per_foreign_vcs',
3673
3951
        'bzrlib.tests.per_repository',
3674
3952
        'bzrlib.tests.per_repository_chk',
3675
3953
        'bzrlib.tests.per_repository_reference',
 
3954
        'bzrlib.tests.per_repository_vf',
3676
3955
        'bzrlib.tests.per_uifactory',
3677
3956
        'bzrlib.tests.per_versionedfile',
3678
3957
        'bzrlib.tests.per_workingtree',
3712
3991
        'bzrlib.tests.test_commit_merge',
3713
3992
        'bzrlib.tests.test_config',
3714
3993
        'bzrlib.tests.test_conflicts',
 
3994
        'bzrlib.tests.test_controldir',
3715
3995
        'bzrlib.tests.test_counted_lock',
3716
3996
        'bzrlib.tests.test_crash',
3717
3997
        'bzrlib.tests.test_decorators',
3718
3998
        'bzrlib.tests.test_delta',
3719
3999
        'bzrlib.tests.test_debug',
3720
 
        'bzrlib.tests.test_deprecated_graph',
3721
4000
        'bzrlib.tests.test_diff',
3722
4001
        'bzrlib.tests.test_directory_service',
3723
4002
        'bzrlib.tests.test_dirstate',
3724
4003
        'bzrlib.tests.test_email_message',
3725
4004
        'bzrlib.tests.test_eol_filters',
3726
4005
        'bzrlib.tests.test_errors',
 
4006
        'bzrlib.tests.test_estimate_compressed_size',
3727
4007
        'bzrlib.tests.test_export',
 
4008
        'bzrlib.tests.test_export_pot',
3728
4009
        'bzrlib.tests.test_extract',
 
4010
        'bzrlib.tests.test_features',
3729
4011
        'bzrlib.tests.test_fetch',
3730
4012
        'bzrlib.tests.test_fixtures',
3731
4013
        'bzrlib.tests.test_fifo_cache',
3732
4014
        'bzrlib.tests.test_filters',
 
4015
        'bzrlib.tests.test_filter_tree',
3733
4016
        'bzrlib.tests.test_ftp_transport',
3734
4017
        'bzrlib.tests.test_foreign',
3735
4018
        'bzrlib.tests.test_generate_docs',
3744
4027
        'bzrlib.tests.test_http',
3745
4028
        'bzrlib.tests.test_http_response',
3746
4029
        'bzrlib.tests.test_https_ca_bundle',
 
4030
        'bzrlib.tests.test_https_urllib',
 
4031
        'bzrlib.tests.test_i18n',
3747
4032
        'bzrlib.tests.test_identitymap',
3748
4033
        'bzrlib.tests.test_ignores',
3749
4034
        'bzrlib.tests.test_index',
3768
4053
        'bzrlib.tests.test_merge3',
3769
4054
        'bzrlib.tests.test_merge_core',
3770
4055
        'bzrlib.tests.test_merge_directive',
 
4056
        'bzrlib.tests.test_mergetools',
3771
4057
        'bzrlib.tests.test_missing',
3772
4058
        'bzrlib.tests.test_msgeditor',
3773
4059
        'bzrlib.tests.test_multiparent',
3782
4068
        'bzrlib.tests.test_permissions',
3783
4069
        'bzrlib.tests.test_plugins',
3784
4070
        'bzrlib.tests.test_progress',
 
4071
        'bzrlib.tests.test_pyutils',
3785
4072
        'bzrlib.tests.test_read_bundle',
3786
4073
        'bzrlib.tests.test_reconcile',
3787
4074
        'bzrlib.tests.test_reconfigure',
3795
4082
        'bzrlib.tests.test_revisiontree',
3796
4083
        'bzrlib.tests.test_rio',
3797
4084
        'bzrlib.tests.test_rules',
 
4085
        'bzrlib.tests.test_url_policy_open',
3798
4086
        'bzrlib.tests.test_sampler',
 
4087
        'bzrlib.tests.test_scenarios',
3799
4088
        'bzrlib.tests.test_script',
3800
4089
        'bzrlib.tests.test_selftest',
3801
4090
        'bzrlib.tests.test_serializer',
3806
4095
        'bzrlib.tests.test_smart',
3807
4096
        'bzrlib.tests.test_smart_add',
3808
4097
        'bzrlib.tests.test_smart_request',
 
4098
        'bzrlib.tests.test_smart_signals',
3809
4099
        'bzrlib.tests.test_smart_transport',
3810
4100
        'bzrlib.tests.test_smtp_connection',
3811
4101
        'bzrlib.tests.test_source',
3821
4111
        'bzrlib.tests.test_testament',
3822
4112
        'bzrlib.tests.test_textfile',
3823
4113
        'bzrlib.tests.test_textmerge',
 
4114
        'bzrlib.tests.test_cethread',
3824
4115
        'bzrlib.tests.test_timestamp',
3825
4116
        'bzrlib.tests.test_trace',
3826
4117
        'bzrlib.tests.test_transactions',
3837
4128
        'bzrlib.tests.test_upgrade',
3838
4129
        'bzrlib.tests.test_upgrade_stacked',
3839
4130
        'bzrlib.tests.test_urlutils',
 
4131
        'bzrlib.tests.test_utextwrap',
3840
4132
        'bzrlib.tests.test_version',
3841
4133
        'bzrlib.tests.test_version_info',
3842
4134
        'bzrlib.tests.test_versionedfile',
 
4135
        'bzrlib.tests.test_vf_search',
3843
4136
        'bzrlib.tests.test_weave',
3844
4137
        'bzrlib.tests.test_whitebox',
3845
4138
        'bzrlib.tests.test_win32utils',
3859
4152
        'bzrlib',
3860
4153
        'bzrlib.branchbuilder',
3861
4154
        'bzrlib.decorators',
3862
 
        'bzrlib.export',
3863
4155
        'bzrlib.inventory',
3864
4156
        'bzrlib.iterablefile',
3865
4157
        'bzrlib.lockdir',
3866
4158
        'bzrlib.merge3',
3867
4159
        'bzrlib.option',
 
4160
        'bzrlib.pyutils',
3868
4161
        'bzrlib.symbol_versioning',
3869
4162
        'bzrlib.tests',
3870
4163
        'bzrlib.tests.fixtures',
3871
4164
        'bzrlib.timestamp',
 
4165
        'bzrlib.transport.http',
3872
4166
        'bzrlib.version_info_formats.format_custom',
3873
4167
        ]
3874
4168
 
3927
4221
        try:
3928
4222
            # note that this really does mean "report only" -- doctest
3929
4223
            # still runs the rest of the examples
3930
 
            doc_suite = doctest.DocTestSuite(mod,
3931
 
                optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
 
4224
            doc_suite = IsolatedDocTestSuite(
 
4225
                mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3932
4226
        except ValueError, e:
3933
4227
            print '**failed to get doctest for: %s\n%s' % (mod, e)
3934
4228
            raise
3937
4231
        suite.addTest(doc_suite)
3938
4232
 
3939
4233
    default_encoding = sys.getdefaultencoding()
3940
 
    for name, plugin in bzrlib.plugin.plugins().items():
 
4234
    for name, plugin in _mod_plugin.plugins().items():
3941
4235
        if not interesting_module(plugin.module.__name__):
3942
4236
            continue
3943
4237
        plugin_suite = plugin.test_suite()
3949
4243
        if plugin_suite is not None:
3950
4244
            suite.addTest(plugin_suite)
3951
4245
        if default_encoding != sys.getdefaultencoding():
3952
 
            bzrlib.trace.warning(
 
4246
            trace.warning(
3953
4247
                'Plugin "%s" tried to reset default encoding to: %s', name,
3954
4248
                sys.getdefaultencoding())
3955
4249
            reload(sys)
3970
4264
            # Some tests mentioned in the list are not in the test suite. The
3971
4265
            # list may be out of date, report to the tester.
3972
4266
            for id in not_found:
3973
 
                bzrlib.trace.warning('"%s" not found in the test suite', id)
 
4267
                trace.warning('"%s" not found in the test suite', id)
3974
4268
        for id in duplicates:
3975
 
            bzrlib.trace.warning('"%s" is used as an id by several tests', id)
 
4269
            trace.warning('"%s" is used as an id by several tests', id)
3976
4270
 
3977
4271
    return suite
3978
4272
 
3979
4273
 
3980
 
def multiply_scenarios(scenarios_left, scenarios_right):
 
4274
def multiply_scenarios(*scenarios):
 
4275
    """Multiply two or more iterables of scenarios.
 
4276
 
 
4277
    It is safe to pass scenario generators or iterators.
 
4278
 
 
4279
    :returns: A list of compound scenarios: the cross-product of all 
 
4280
        scenarios, with the names concatenated and the parameters
 
4281
        merged together.
 
4282
    """
 
4283
    return reduce(_multiply_two_scenarios, map(list, scenarios))
 
4284
 
 
4285
 
 
4286
def _multiply_two_scenarios(scenarios_left, scenarios_right):
3981
4287
    """Multiply two sets of scenarios.
3982
4288
 
3983
4289
    :returns: the cartesian product of the two sets of scenarios, that is
4047
4353
    """Copy test and apply scenario to it.
4048
4354
 
4049
4355
    :param test: A test to adapt.
4050
 
    :param scenario: A tuple describing the scenarion.
 
4356
    :param scenario: A tuple describing the scenario.
4051
4357
        The first element of the tuple is the new test id.
4052
4358
        The second element is a dict containing attributes to set on the
4053
4359
        test.
4069
4375
    """
4070
4376
    new_test = copy.copy(test)
4071
4377
    new_test.id = lambda: new_id
 
4378
    # XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
 
4379
    # causes cloned tests to share the 'details' dict.  This makes it hard to
 
4380
    # read the test output for parameterized tests, because tracebacks will be
 
4381
    # associated with irrelevant tests.
 
4382
    try:
 
4383
        details = new_test._TestCase__details
 
4384
    except AttributeError:
 
4385
        # must be a different version of testtools than expected.  Do nothing.
 
4386
        pass
 
4387
    else:
 
4388
        # Reset the '__details' dict.
 
4389
        new_test._TestCase__details = {}
4072
4390
    return new_test
4073
4391
 
4074
4392
 
4095
4413
        the module is available.
4096
4414
    """
4097
4415
 
4098
 
    py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
 
4416
    from bzrlib.tests.features import ModuleAvailableFeature
 
4417
    py_module = pyutils.get_named_object(py_module_name)
4099
4418
    scenarios = [
4100
4419
        ('python', {'module': py_module}),
4101
4420
    ]
4141
4460
                         % (os.path.basename(dirname), printable_e))
4142
4461
 
4143
4462
 
4144
 
class Feature(object):
4145
 
    """An operating system Feature."""
4146
 
 
4147
 
    def __init__(self):
4148
 
        self._available = None
4149
 
 
4150
 
    def available(self):
4151
 
        """Is the feature available?
4152
 
 
4153
 
        :return: True if the feature is available.
4154
 
        """
4155
 
        if self._available is None:
4156
 
            self._available = self._probe()
4157
 
        return self._available
4158
 
 
4159
 
    def _probe(self):
4160
 
        """Implement this method in concrete features.
4161
 
 
4162
 
        :return: True if the feature is available.
4163
 
        """
4164
 
        raise NotImplementedError
4165
 
 
4166
 
    def __str__(self):
4167
 
        if getattr(self, 'feature_name', None):
4168
 
            return self.feature_name()
4169
 
        return self.__class__.__name__
4170
 
 
4171
 
 
4172
 
class _SymlinkFeature(Feature):
4173
 
 
4174
 
    def _probe(self):
4175
 
        return osutils.has_symlinks()
4176
 
 
4177
 
    def feature_name(self):
4178
 
        return 'symlinks'
4179
 
 
4180
 
SymlinkFeature = _SymlinkFeature()
4181
 
 
4182
 
 
4183
 
class _HardlinkFeature(Feature):
4184
 
 
4185
 
    def _probe(self):
4186
 
        return osutils.has_hardlinks()
4187
 
 
4188
 
    def feature_name(self):
4189
 
        return 'hardlinks'
4190
 
 
4191
 
HardlinkFeature = _HardlinkFeature()
4192
 
 
4193
 
 
4194
 
class _OsFifoFeature(Feature):
4195
 
 
4196
 
    def _probe(self):
4197
 
        return getattr(os, 'mkfifo', None)
4198
 
 
4199
 
    def feature_name(self):
4200
 
        return 'filesystem fifos'
4201
 
 
4202
 
OsFifoFeature = _OsFifoFeature()
4203
 
 
4204
 
 
4205
 
class _UnicodeFilenameFeature(Feature):
4206
 
    """Does the filesystem support Unicode filenames?"""
4207
 
 
4208
 
    def _probe(self):
4209
 
        try:
4210
 
            # Check for character combinations unlikely to be covered by any
4211
 
            # single non-unicode encoding. We use the characters
4212
 
            # - greek small letter alpha (U+03B1) and
4213
 
            # - braille pattern dots-123456 (U+283F).
4214
 
            os.stat(u'\u03b1\u283f')
4215
 
        except UnicodeEncodeError:
4216
 
            return False
4217
 
        except (IOError, OSError):
4218
 
            # The filesystem allows the Unicode filename but the file doesn't
4219
 
            # exist.
4220
 
            return True
4221
 
        else:
4222
 
            # The filesystem allows the Unicode filename and the file exists,
4223
 
            # for some reason.
4224
 
            return True
4225
 
 
4226
 
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4227
 
 
4228
 
 
4229
 
class _CompatabilityThunkFeature(Feature):
4230
 
    """This feature is just a thunk to another feature.
4231
 
 
4232
 
    It issues a deprecation warning if it is accessed, to let you know that you
4233
 
    should really use a different feature.
4234
 
    """
4235
 
 
4236
 
    def __init__(self, dep_version, module, name,
4237
 
                 replacement_name, replacement_module=None):
4238
 
        super(_CompatabilityThunkFeature, self).__init__()
4239
 
        self._module = module
4240
 
        if replacement_module is None:
4241
 
            replacement_module = module
4242
 
        self._replacement_module = replacement_module
4243
 
        self._name = name
4244
 
        self._replacement_name = replacement_name
4245
 
        self._dep_version = dep_version
4246
 
        self._feature = None
4247
 
 
4248
 
    def _ensure(self):
4249
 
        if self._feature is None:
4250
 
            depr_msg = self._dep_version % ('%s.%s'
4251
 
                                            % (self._module, self._name))
4252
 
            use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4253
 
                                               self._replacement_name)
4254
 
            symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4255
 
            # Import the new feature and use it as a replacement for the
4256
 
            # deprecated one.
4257
 
            mod = __import__(self._replacement_module, {}, {},
4258
 
                             [self._replacement_name])
4259
 
            self._feature = getattr(mod, self._replacement_name)
4260
 
 
4261
 
    def _probe(self):
4262
 
        self._ensure()
4263
 
        return self._feature._probe()
4264
 
 
4265
 
 
4266
 
class ModuleAvailableFeature(Feature):
4267
 
    """This is a feature than describes a module we want to be available.
4268
 
 
4269
 
    Declare the name of the module in __init__(), and then after probing, the
4270
 
    module will be available as 'self.module'.
4271
 
 
4272
 
    :ivar module: The module if it is available, else None.
4273
 
    """
4274
 
 
4275
 
    def __init__(self, module_name):
4276
 
        super(ModuleAvailableFeature, self).__init__()
4277
 
        self.module_name = module_name
4278
 
 
4279
 
    def _probe(self):
4280
 
        try:
4281
 
            self._module = __import__(self.module_name, {}, {}, [''])
4282
 
            return True
4283
 
        except ImportError:
4284
 
            return False
4285
 
 
4286
 
    @property
4287
 
    def module(self):
4288
 
        if self.available(): # Make sure the probe has been done
4289
 
            return self._module
4290
 
        return None
4291
 
 
4292
 
    def feature_name(self):
4293
 
        return self.module_name
4294
 
 
4295
 
 
4296
 
# This is kept here for compatibility, it is recommended to use
4297
 
# 'bzrlib.tests.feature.paramiko' instead
4298
 
ParamikoFeature = _CompatabilityThunkFeature(
4299
 
    deprecated_in((2,1,0)),
4300
 
    'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4301
 
 
4302
 
 
4303
4463
def probe_unicode_in_user_encoding():
4304
4464
    """Try to encode several unicode strings to use in unicode-aware tests.
4305
4465
    Return first successfull match.
4333
4493
    return None
4334
4494
 
4335
4495
 
4336
 
class _HTTPSServerFeature(Feature):
4337
 
    """Some tests want an https Server, check if one is available.
4338
 
 
4339
 
    Right now, the only way this is available is under python2.6 which provides
4340
 
    an ssl module.
4341
 
    """
4342
 
 
4343
 
    def _probe(self):
4344
 
        try:
4345
 
            import ssl
4346
 
            return True
4347
 
        except ImportError:
4348
 
            return False
4349
 
 
4350
 
    def feature_name(self):
4351
 
        return 'HTTPSServer'
4352
 
 
4353
 
 
4354
 
HTTPSServerFeature = _HTTPSServerFeature()
4355
 
 
4356
 
 
4357
 
class _UnicodeFilename(Feature):
4358
 
    """Does the filesystem support Unicode filenames?"""
4359
 
 
4360
 
    def _probe(self):
4361
 
        try:
4362
 
            os.stat(u'\u03b1')
4363
 
        except UnicodeEncodeError:
4364
 
            return False
4365
 
        except (IOError, OSError):
4366
 
            # The filesystem allows the Unicode filename but the file doesn't
4367
 
            # exist.
4368
 
            return True
4369
 
        else:
4370
 
            # The filesystem allows the Unicode filename and the file exists,
4371
 
            # for some reason.
4372
 
            return True
4373
 
 
4374
 
UnicodeFilename = _UnicodeFilename()
4375
 
 
4376
 
 
4377
 
class _ByteStringNamedFilesystem(Feature):
4378
 
    """Is the filesystem based on bytes?"""
4379
 
 
4380
 
    def _probe(self):
4381
 
        if os.name == "posix":
4382
 
            return True
4383
 
        return False
4384
 
 
4385
 
ByteStringNamedFilesystem = _ByteStringNamedFilesystem()
4386
 
 
4387
 
 
4388
 
class _UTF8Filesystem(Feature):
4389
 
    """Is the filesystem UTF-8?"""
4390
 
 
4391
 
    def _probe(self):
4392
 
        if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4393
 
            return True
4394
 
        return False
4395
 
 
4396
 
UTF8Filesystem = _UTF8Filesystem()
4397
 
 
4398
 
 
4399
 
class _BreakinFeature(Feature):
4400
 
    """Does this platform support the breakin feature?"""
4401
 
 
4402
 
    def _probe(self):
4403
 
        from bzrlib import breakin
4404
 
        if breakin.determine_signal() is None:
4405
 
            return False
4406
 
        if sys.platform == 'win32':
4407
 
            # Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4408
 
            # We trigger SIGBREAK via a Console api so we need ctypes to
4409
 
            # access the function
4410
 
            try:
4411
 
                import ctypes
4412
 
            except OSError:
4413
 
                return False
4414
 
        return True
4415
 
 
4416
 
    def feature_name(self):
4417
 
        return "SIGQUIT or SIGBREAK w/ctypes on win32"
4418
 
 
4419
 
 
4420
 
BreakinFeature = _BreakinFeature()
4421
 
 
4422
 
 
4423
 
class _CaseInsCasePresFilenameFeature(Feature):
4424
 
    """Is the file-system case insensitive, but case-preserving?"""
4425
 
 
4426
 
    def _probe(self):
4427
 
        fileno, name = tempfile.mkstemp(prefix='MixedCase')
4428
 
        try:
4429
 
            # first check truly case-preserving for created files, then check
4430
 
            # case insensitive when opening existing files.
4431
 
            name = osutils.normpath(name)
4432
 
            base, rel = osutils.split(name)
4433
 
            found_rel = osutils.canonical_relpath(base, name)
4434
 
            return (found_rel == rel
4435
 
                    and os.path.isfile(name.upper())
4436
 
                    and os.path.isfile(name.lower()))
4437
 
        finally:
4438
 
            os.close(fileno)
4439
 
            os.remove(name)
4440
 
 
4441
 
    def feature_name(self):
4442
 
        return "case-insensitive case-preserving filesystem"
4443
 
 
4444
 
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4445
 
 
4446
 
 
4447
 
class _CaseInsensitiveFilesystemFeature(Feature):
4448
 
    """Check if underlying filesystem is case-insensitive but *not* case
4449
 
    preserving.
4450
 
    """
4451
 
    # Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4452
 
    # more likely to be case preserving, so this case is rare.
4453
 
 
4454
 
    def _probe(self):
4455
 
        if CaseInsCasePresFilenameFeature.available():
4456
 
            return False
4457
 
 
4458
 
        if TestCaseWithMemoryTransport.TEST_ROOT is None:
4459
 
            root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4460
 
            TestCaseWithMemoryTransport.TEST_ROOT = root
4461
 
        else:
4462
 
            root = TestCaseWithMemoryTransport.TEST_ROOT
4463
 
        tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4464
 
            dir=root)
4465
 
        name_a = osutils.pathjoin(tdir, 'a')
4466
 
        name_A = osutils.pathjoin(tdir, 'A')
4467
 
        os.mkdir(name_a)
4468
 
        result = osutils.isdir(name_A)
4469
 
        _rmtree_temp_dir(tdir)
4470
 
        return result
4471
 
 
4472
 
    def feature_name(self):
4473
 
        return 'case-insensitive filesystem'
4474
 
 
4475
 
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4476
 
 
4477
 
 
4478
 
class _CaseSensitiveFilesystemFeature(Feature):
4479
 
 
4480
 
    def _probe(self):
4481
 
        if CaseInsCasePresFilenameFeature.available():
4482
 
            return False
4483
 
        elif CaseInsensitiveFilesystemFeature.available():
4484
 
            return False
4485
 
        else:
4486
 
            return True
4487
 
 
4488
 
    def feature_name(self):
4489
 
        return 'case-sensitive filesystem'
4490
 
 
4491
 
# new coding style is for feature instances to be lowercase
4492
 
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4493
 
 
4494
 
 
4495
 
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4496
 
SubUnitFeature = _CompatabilityThunkFeature(
4497
 
    deprecated_in((2,1,0)),
4498
 
    'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4499
4496
# Only define SubUnitBzrRunner if subunit is available.
4500
4497
try:
4501
4498
    from subunit import TestProtocolClient
4502
4499
    from subunit.test_results import AutoTimingTestResultDecorator
 
4500
    class SubUnitBzrProtocolClient(TestProtocolClient):
 
4501
 
 
4502
        def stopTest(self, test):
 
4503
            super(SubUnitBzrProtocolClient, self).stopTest(test)
 
4504
            _clear__type_equality_funcs(test)
 
4505
 
 
4506
        def addSuccess(self, test, details=None):
 
4507
            # The subunit client always includes the details in the subunit
 
4508
            # stream, but we don't want to include it in ours.
 
4509
            if details is not None and 'log' in details:
 
4510
                del details['log']
 
4511
            return super(SubUnitBzrProtocolClient, self).addSuccess(
 
4512
                test, details)
 
4513
 
4503
4514
    class SubUnitBzrRunner(TextTestRunner):
4504
4515
        def run(self, test):
4505
4516
            result = AutoTimingTestResultDecorator(
4506
 
                TestProtocolClient(self.stream))
 
4517
                SubUnitBzrProtocolClient(self.stream))
4507
4518
            test.run(result)
4508
4519
            return result
4509
4520
except ImportError:
4510
4521
    pass
4511
4522
 
4512
 
class _PosixPermissionsFeature(Feature):
4513
 
 
4514
 
    def _probe(self):
4515
 
        def has_perms():
4516
 
            # create temporary file and check if specified perms are maintained.
4517
 
            import tempfile
4518
 
 
4519
 
            write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4520
 
            f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4521
 
            fd, name = f
4522
 
            os.close(fd)
4523
 
            os.chmod(name, write_perms)
4524
 
 
4525
 
            read_perms = os.stat(name).st_mode & 0777
4526
 
            os.unlink(name)
4527
 
            return (write_perms == read_perms)
4528
 
 
4529
 
        return (os.name == 'posix') and has_perms()
4530
 
 
4531
 
    def feature_name(self):
4532
 
        return 'POSIX permissions support'
4533
 
 
4534
 
posix_permissions_feature = _PosixPermissionsFeature()
 
4523
 
 
4524
# API compatibility for old plugins; see bug 892622.
 
4525
for name in [
 
4526
    'Feature',
 
4527
    'HTTPServerFeature', 
 
4528
    'ModuleAvailableFeature',
 
4529
    'HTTPSServerFeature', 'SymlinkFeature', 'HardlinkFeature',
 
4530
    'OsFifoFeature', 'UnicodeFilenameFeature',
 
4531
    'ByteStringNamedFilesystem', 'UTF8Filesystem',
 
4532
    'BreakinFeature', 'CaseInsCasePresFilenameFeature',
 
4533
    'CaseInsensitiveFilesystemFeature', 'case_sensitive_filesystem_feature',
 
4534
    'posix_permissions_feature',
 
4535
    ]:
 
4536
    globals()[name] = _CompatabilityThunkFeature(
 
4537
        symbol_versioning.deprecated_in((2, 5, 0)),
 
4538
        'bzrlib.tests', name,
 
4539
        name, 'bzrlib.tests.features')
 
4540
 
 
4541
 
 
4542
for (old_name, new_name) in [
 
4543
    ('UnicodeFilename', 'UnicodeFilenameFeature'),
 
4544
    ]:
 
4545
    globals()[name] = _CompatabilityThunkFeature(
 
4546
        symbol_versioning.deprecated_in((2, 5, 0)),
 
4547
        'bzrlib.tests', old_name,
 
4548
        new_name, 'bzrlib.tests.features')