/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-07-27 06:22:57 UTC
  • mfrom: (4556.1.1 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20090727062257-im0nsixc2e9ua9ac
(mbp) Make 'rm --keep' help more clear

Show diffs side-by-side

added added

removed removed

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