/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: Aaron Bentley
  • Date: 2009-04-03 20:05:25 UTC
  • mto: This revision was merged to the branch mainline in revision 4266.
  • Revision ID: aaron@aaronbentley.com-20090403200525-5vcdyhnjrlsqd6dr
Support hidden options.

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,
70
 
    lock as _mod_lock,
71
58
    memorytree,
72
59
    osutils,
73
60
    progress,
97
84
from bzrlib.symbol_versioning import (
98
85
    DEPRECATED_PARAMETER,
99
86
    deprecated_function,
100
 
    deprecated_in,
101
87
    deprecated_method,
102
88
    deprecated_passed,
103
89
    )
104
90
import bzrlib.trace
105
 
from bzrlib.transport import (
106
 
    get_transport,
107
 
    memory,
108
 
    pathfilter,
109
 
    )
 
91
from bzrlib.transport import get_transport
110
92
import bzrlib.transport
 
93
from bzrlib.transport.local import LocalURLServer
 
94
from bzrlib.transport.memory import MemoryServer
 
95
from bzrlib.transport.readonly import ReadonlyServer
111
96
from bzrlib.trace import mutter, note
112
 
from bzrlib.tests import (
113
 
    test_server,
114
 
    TestUtil,
115
 
    )
 
97
from bzrlib.tests import TestUtil
116
98
from bzrlib.tests.http_server import HttpServer
117
99
from bzrlib.tests.TestUtil import (
118
100
                          TestSuite,
119
101
                          TestLoader,
120
102
                          )
121
103
from bzrlib.tests.treeshape import build_tree_contents
122
 
from bzrlib.ui import NullProgressView
123
 
from bzrlib.ui.text import TextUIFactory
124
104
import bzrlib.version_info_formats.format_custom
125
105
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
126
106
 
129
109
# shown frame is the test code, not our assertXYZ.
130
110
__unittest = 1
131
111
 
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
 
112
default_transport = LocalURLServer
142
113
 
143
114
 
144
115
class ExtendedTestResult(unittest._TextTestResult):
161
132
 
162
133
    def __init__(self, stream, descriptions, verbosity,
163
134
                 bench_history=None,
164
 
                 strict=False,
 
135
                 num_tests=None,
165
136
                 ):
166
137
        """Construct new TestResult.
167
138
 
185
156
            bench_history.write("--date %s %s\n" % (time.time(), revision_id))
186
157
        self._bench_history = bench_history
187
158
        self.ui = ui.ui_factory
188
 
        self.num_tests = 0
 
159
        self.num_tests = num_tests
189
160
        self.error_count = 0
190
161
        self.failure_count = 0
191
162
        self.known_failure_count = 0
194
165
        self.unsupported = {}
195
166
        self.count = 0
196
167
        self._overall_start_time = time.time()
197
 
        self._strict = strict
198
 
 
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))
236
 
        if self._strict:
237
 
            ok = self.wasStrictlySuccessful()
238
 
        else:
239
 
            ok = self.wasSuccessful()
240
 
        if TestCase._first_thread_leaker_id:
241
 
            self.stream.write(
242
 
                '%s is leaking threads among %d leaking tests.\n' % (
243
 
                TestCase._first_thread_leaker_id,
244
 
                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):
 
168
 
 
169
    def _extractBenchmarkTime(self, testCase):
254
170
        """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
171
        return getattr(testCase, "_benchtime", None)
258
172
 
259
173
    def _elapsedTestTimeString(self):
263
177
    def _testTimeString(self, testCase):
264
178
        benchmark_time = self._extractBenchmarkTime(testCase)
265
179
        if benchmark_time is not None:
266
 
            return self._formatTime(benchmark_time) + "*"
 
180
            return "%s/%s" % (
 
181
                self._formatTime(benchmark_time),
 
182
                self._elapsedTestTimeString())
267
183
        else:
268
 
            return self._elapsedTestTimeString()
 
184
            return "           %s" % self._elapsedTestTimeString()
269
185
 
270
186
    def _formatTime(self, seconds):
271
187
        """Format seconds as milliseconds with leading spaces."""
280
196
 
281
197
    def startTest(self, test):
282
198
        unittest.TestResult.startTest(self, test)
283
 
        if self.count == 0:
284
 
            self.startTests()
285
199
        self.report_test_start(test)
286
200
        test.number = self.count
287
201
        self._recordTestStartTime()
288
202
 
289
 
    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' % (
302
 
                    bzrlib.version_string,
303
 
                    bzrlib._format_version_tuple(sys.version_info),
304
 
                    platform.platform(aliased=1),
305
 
                    ))
306
 
        self.stream.write('\n')
307
 
 
308
203
    def _recordTestStartTime(self):
309
204
        """Record that a test has started."""
310
205
        self._start_time = time.time()
322
217
        Called from the TestCase run() method when the test
323
218
        fails with an unexpected error.
324
219
        """
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)
 
220
        self._testConcluded(test)
 
221
        if isinstance(err[1], TestNotApplicable):
 
222
            return self._addNotApplicable(test, err)
 
223
        elif isinstance(err[1], UnavailableFeature):
 
224
            return self.addNotSupported(test, err[1].args[0])
 
225
        else:
 
226
            unittest.TestResult.addError(self, test, err)
 
227
            self.error_count += 1
 
228
            self.report_error(test, err)
 
229
            if self.stop_early:
 
230
                self.stop()
 
231
            self._cleanupLogFile(test)
332
232
 
333
233
    def addFailure(self, test, err):
334
234
        """Tell result that test failed.
336
236
        Called from the TestCase run() method when the test
337
237
        fails because e.g. an assert() method failed.
338
238
        """
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)
 
239
        self._testConcluded(test)
 
240
        if isinstance(err[1], KnownFailure):
 
241
            return self._addKnownFailure(test, err)
 
242
        else:
 
243
            unittest.TestResult.addFailure(self, test, err)
 
244
            self.failure_count += 1
 
245
            self.report_failure(test, err)
 
246
            if self.stop_early:
 
247
                self.stop()
 
248
            self._cleanupLogFile(test)
346
249
 
347
 
    def addSuccess(self, test, details=None):
 
250
    def addSuccess(self, test):
348
251
        """Tell result that test completed successfully.
349
252
 
350
253
        Called from the TestCase run()
351
254
        """
 
255
        self._testConcluded(test)
352
256
        if self._bench_history is not None:
353
 
            benchmark_time = self._extractBenchmarkTime(test, details)
 
257
            benchmark_time = self._extractBenchmarkTime(test)
354
258
            if benchmark_time is not None:
355
259
                self._bench_history.write("%s %s\n" % (
356
260
                    self._formatTime(benchmark_time),
360
264
        unittest.TestResult.addSuccess(self, test)
361
265
        test._log_contents = ''
362
266
 
363
 
    def addExpectedFailure(self, test, err):
 
267
    def _testConcluded(self, test):
 
268
        """Common code when a test has finished.
 
269
 
 
270
        Called regardless of whether it succeded, failed, etc.
 
271
        """
 
272
        pass
 
273
 
 
274
    def _addKnownFailure(self, test, err):
364
275
        self.known_failure_count += 1
365
276
        self.report_known_failure(test, err)
366
277
 
368
279
        """The test will not be run because of a missing feature.
369
280
        """
370
281
        # this can be called in two different ways: it may be that the
371
 
        # test started running, and then raised (through requireFeature)
 
282
        # test started running, and then raised (through addError)
372
283
        # 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.
 
284
        # while probing for features before running the tests; in that
 
285
        # case we will see startTest and stopTest, but the test will never
 
286
        # actually run.
376
287
        self.unsupported.setdefault(str(feature), 0)
377
288
        self.unsupported[str(feature)] += 1
378
289
        self.report_unsupported(test, feature)
382
293
        self.skip_count += 1
383
294
        self.report_skip(test, reason)
384
295
 
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
 
296
    def _addNotApplicable(self, test, skip_excinfo):
 
297
        if isinstance(skip_excinfo[1], TestNotApplicable):
 
298
            self.not_applicable_count += 1
 
299
            self.report_not_applicable(test, skip_excinfo)
 
300
        try:
 
301
            test.tearDown()
 
302
        except KeyboardInterrupt:
 
303
            raise
 
304
        except:
 
305
            self.addError(test, test.exc_info())
400
306
        else:
401
 
            raise errors.BzrError("Unknown whence %r" % whence)
 
307
            # seems best to treat this as success from point-of-view of unittest
 
308
            # -- it actually does nothing so it barely matters :)
 
309
            unittest.TestResult.addSuccess(self, test)
 
310
            test._log_contents = ''
 
311
 
 
312
    def printErrorList(self, flavour, errors):
 
313
        for test, err in errors:
 
314
            self.stream.writeln(self.separator1)
 
315
            self.stream.write("%s: " % flavour)
 
316
            self.stream.writeln(self.getDescription(test))
 
317
            if getattr(test, '_get_log', None) is not None:
 
318
                self.stream.write('\n')
 
319
                self.stream.write(
 
320
                        ('vvvv[log from %s]' % test.id()).ljust(78,'-'))
 
321
                self.stream.write('\n')
 
322
                self.stream.write(test._get_log())
 
323
                self.stream.write('\n')
 
324
                self.stream.write(
 
325
                        ('^^^^[log from %s]' % test.id()).ljust(78,'-'))
 
326
                self.stream.write('\n')
 
327
            self.stream.writeln(self.separator2)
 
328
            self.stream.writeln("%s" % err)
 
329
 
 
330
    def finished(self):
 
331
        pass
402
332
 
403
333
    def report_cleaning_up(self):
404
334
        pass
405
335
 
406
 
    def startTestRun(self):
407
 
        self.startTime = time.time()
408
 
 
409
336
    def report_success(self, test):
410
337
        pass
411
338
 
420
347
 
421
348
    def __init__(self, stream, descriptions, verbosity,
422
349
                 bench_history=None,
 
350
                 num_tests=None,
423
351
                 pb=None,
424
 
                 strict=None,
425
352
                 ):
426
353
        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()
 
354
            bench_history, num_tests)
 
355
        if pb is None:
 
356
            self.pb = self.ui.nested_progress_bar()
 
357
            self._supplied_pb = False
 
358
        else:
 
359
            self.pb = pb
 
360
            self._supplied_pb = True
433
361
        self.pb.show_pct = False
434
362
        self.pb.show_spinner = False
435
363
        self.pb.show_eta = False,
436
364
        self.pb.show_count = False
437
365
        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()
 
366
 
 
367
    def report_starting(self):
449
368
        self.pb.update('[test 0/%d] Starting' % (self.num_tests))
450
369
 
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
370
    def _progress_prefix_text(self):
457
371
        # the longer this text, the less space we have to show the test
458
372
        # name...
463
377
        ##     a += ', %d skip' % self.skip_count
464
378
        ## if self.known_failure_count:
465
379
        ##     a += '+%dX' % self.known_failure_count
466
 
        if self.num_tests:
 
380
        if self.num_tests is not None:
467
381
            a +='/%d' % self.num_tests
468
382
        a += ' in '
469
383
        runtime = time.time() - self._overall_start_time
471
385
            a += '%dm%ds' % (runtime / 60, runtime % 60)
472
386
        else:
473
387
            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)
 
388
        if self.error_count:
 
389
            a += ', %d err' % self.error_count
 
390
        if self.failure_count:
 
391
            a += ', %d fail' % self.failure_count
 
392
        if self.unsupported:
 
393
            a += ', %d missing' % len(self.unsupported)
479
394
        a += ']'
480
395
        return a
481
396
 
490
405
        return self._shortened_test_description(test)
491
406
 
492
407
    def report_error(self, test, err):
493
 
        self.stream.write('ERROR: %s\n    %s\n' % (
 
408
        self.pb.note('ERROR: %s\n    %s\n',
494
409
            self._test_description(test),
495
410
            err[1],
496
 
            ))
 
411
            )
497
412
 
498
413
    def report_failure(self, test, err):
499
 
        self.stream.write('FAIL: %s\n    %s\n' % (
 
414
        self.pb.note('FAIL: %s\n    %s\n',
500
415
            self._test_description(test),
501
416
            err[1],
502
 
            ))
 
417
            )
503
418
 
504
419
    def report_known_failure(self, test, err):
505
 
        pass
 
420
        self.pb.note('XFAIL: %s\n%s\n',
 
421
            self._test_description(test), err[1])
506
422
 
507
423
    def report_skip(self, test, reason):
508
424
        pass
509
425
 
510
 
    def report_not_applicable(self, test, reason):
 
426
    def report_not_applicable(self, test, skip_excinfo):
511
427
        pass
512
428
 
513
429
    def report_unsupported(self, test, feature):
516
432
    def report_cleaning_up(self):
517
433
        self.pb.update('Cleaning up')
518
434
 
 
435
    def finished(self):
 
436
        if not self._supplied_pb:
 
437
            self.pb.finished()
 
438
 
519
439
 
520
440
class VerboseTestResult(ExtendedTestResult):
521
441
    """Produce long output, with one line per test run plus times"""
528
448
            result = a_string
529
449
        return result.ljust(final_width)
530
450
 
531
 
    def startTestRun(self):
532
 
        super(VerboseTestResult, self).startTestRun()
 
451
    def report_starting(self):
533
452
        self.stream.write('running %d tests...\n' % self.num_tests)
534
453
 
535
454
    def report_test_start(self, test):
536
455
        self.count += 1
537
456
        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)
 
457
        # width needs space for 6 char status, plus 1 for slash, plus 2 10-char
 
458
        # numbers, plus a trailing blank
 
459
        # when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
 
460
        self.stream.write(self._ellipsize_to_right(name,
 
461
                          osutils.terminal_width()-30))
547
462
        self.stream.flush()
548
463
 
549
464
    def _error_summary(self, err):
578
493
        self.stream.writeln(' SKIP %s\n%s'
579
494
                % (self._testTimeString(test), reason))
580
495
 
581
 
    def report_not_applicable(self, test, reason):
582
 
        self.stream.writeln('  N/A %s\n    %s'
583
 
                % (self._testTimeString(test), reason))
 
496
    def report_not_applicable(self, test, skip_excinfo):
 
497
        self.stream.writeln('  N/A %s\n%s'
 
498
                % (self._testTimeString(test),
 
499
                   self._error_summary(skip_excinfo)))
584
500
 
585
501
    def report_unsupported(self, test, feature):
586
502
        """test cannot be run because feature is missing."""
596
512
                 descriptions=0,
597
513
                 verbosity=1,
598
514
                 bench_history=None,
599
 
                 strict=False,
600
 
                 result_decorators=None,
 
515
                 list_only=False
601
516
                 ):
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
517
        self.stream = unittest._WritelnDecorator(stream)
623
518
        self.descriptions = descriptions
624
519
        self.verbosity = verbosity
625
520
        self._bench_history = bench_history
626
 
        self._strict = strict
627
 
        self._result_decorators = result_decorators or []
 
521
        self.list_only = list_only
628
522
 
629
523
    def run(self, test):
630
524
        "Run the given test case or test suite."
 
525
        startTime = time.time()
631
526
        if self.verbosity == 1:
632
527
            result_class = TextTestResult
633
528
        elif self.verbosity >= 2:
634
529
            result_class = VerboseTestResult
635
 
        original_result = result_class(self.stream,
 
530
        result = result_class(self.stream,
636
531
                              self.descriptions,
637
532
                              self.verbosity,
638
533
                              bench_history=self._bench_history,
639
 
                              strict=self._strict,
 
534
                              num_tests=test.countTestCases(),
640
535
                              )
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
 
536
        result.stop_early = self.stop_on_failure
 
537
        result.report_starting()
 
538
        if self.list_only:
 
539
            if self.verbosity >= 2:
 
540
                self.stream.writeln("Listing tests only ...\n")
 
541
            run = 0
 
542
            for t in iter_suite_tests(test):
 
543
                self.stream.writeln("%s" % (t.id()))
 
544
                run += 1
 
545
            actionTaken = "Listed"
 
546
        else:
 
547
            try:
 
548
                import testtools
 
549
            except ImportError:
 
550
                test.run(result)
 
551
            else:
 
552
                if isinstance(test, testtools.ConcurrentTestSuite):
 
553
                    # We need to catch bzr specific behaviors
 
554
                    test.run(BZRTransformingResult(result))
 
555
                else:
 
556
                    test.run(result)
 
557
            run = result.testsRun
 
558
            actionTaken = "Ran"
 
559
        stopTime = time.time()
 
560
        timeTaken = stopTime - startTime
 
561
        result.printErrors()
 
562
        self.stream.writeln(result.separator2)
 
563
        self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
 
564
                            run, run != 1 and "s" or "", timeTaken))
 
565
        self.stream.writeln()
 
566
        if not result.wasSuccessful():
 
567
            self.stream.write("FAILED (")
 
568
            failed, errored = map(len, (result.failures, result.errors))
 
569
            if failed:
 
570
                self.stream.write("failures=%d" % failed)
 
571
            if errored:
 
572
                if failed: self.stream.write(", ")
 
573
                self.stream.write("errors=%d" % errored)
 
574
            if result.known_failure_count:
 
575
                if failed or errored: self.stream.write(", ")
 
576
                self.stream.write("known_failure_count=%d" %
 
577
                    result.known_failure_count)
 
578
            self.stream.writeln(")")
 
579
        else:
 
580
            if result.known_failure_count:
 
581
                self.stream.writeln("OK (known_failures=%d)" %
 
582
                    result.known_failure_count)
 
583
            else:
 
584
                self.stream.writeln("OK")
 
585
        if result.skip_count > 0:
 
586
            skipped = result.skip_count
 
587
            self.stream.writeln('%d test%s skipped' %
 
588
                                (skipped, skipped != 1 and "s" or ""))
 
589
        if result.unsupported:
 
590
            for feature, count in sorted(result.unsupported.items()):
 
591
                self.stream.writeln("Missing feature '%s' skipped %d tests." %
 
592
                    (feature, count))
 
593
        result.finished()
 
594
        return result
655
595
 
656
596
 
657
597
def iter_suite_tests(suite):
667
607
                        % (type(suite), suite))
668
608
 
669
609
 
670
 
TestSkipped = testtools.testcase.TestSkipped
 
610
class TestSkipped(Exception):
 
611
    """Indicates that a test was intentionally skipped, rather than failing."""
671
612
 
672
613
 
673
614
class TestNotApplicable(TestSkipped):
679
620
    """
680
621
 
681
622
 
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
 
623
class KnownFailure(AssertionError):
 
624
    """Indicates that a test failed in a precisely expected manner.
 
625
 
 
626
    Such failures dont block the whole test suite from passing because they are
 
627
    indicators of partially completed code or of future work. We have an
 
628
    explicit error for them so that we can ensure that they are always visible:
 
629
    KnownFailures are always shown in the output of bzr selftest.
 
630
    """
699
631
 
700
632
 
701
633
class UnavailableFeature(Exception):
702
634
    """A feature required for this test was not available.
703
635
 
704
 
    This can be considered a specialised form of SkippedTest.
705
 
 
706
636
    The feature should be used to construct the exception.
707
637
    """
708
638
 
709
639
 
 
640
class CommandFailed(Exception):
 
641
    pass
 
642
 
 
643
 
710
644
class StringIOWrapper(object):
711
645
    """A wrapper around cStringIO which just adds an encoding attribute.
712
646
 
733
667
            return setattr(self._cstring, name, val)
734
668
 
735
669
 
736
 
class TestUIFactory(TextUIFactory):
 
670
class TestUIFactory(ui.CLIUIFactory):
737
671
    """A UI Factory for testing.
738
672
 
739
673
    Hide the progress bar but emit note()s.
740
674
    Redirect stdin.
741
675
    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
676
    """
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
677
 
754
678
    def __init__(self, stdout=None, stderr=None, stdin=None):
755
679
        if stdin is not None:
760
684
            stdin = StringIOWrapper(stdin)
761
685
        super(TestUIFactory, self).__init__(stdin, stdout, stderr)
762
686
 
 
687
    def clear(self):
 
688
        """See progress.ProgressBar.clear()."""
 
689
 
 
690
    def clear_term(self):
 
691
        """See progress.ProgressBar.clear_term()."""
 
692
 
 
693
    def finished(self):
 
694
        """See progress.ProgressBar.finished()."""
 
695
 
 
696
    def note(self, fmt_string, *args, **kwargs):
 
697
        """See progress.ProgressBar.note()."""
 
698
        self.stdout.write((fmt_string + "\n") % args)
 
699
 
 
700
    def progress_bar(self):
 
701
        return self
 
702
 
 
703
    def nested_progress_bar(self):
 
704
        return self
 
705
 
 
706
    def update(self, message, count=None, total=None):
 
707
        """See progress.ProgressBar.update()."""
 
708
 
763
709
    def get_non_echoed_password(self):
764
710
        """Get password from stdin without trying to handle the echo mode"""
765
711
        password = self.stdin.readline()
769
715
            password = password[:-1]
770
716
        return password
771
717
 
772
 
    def make_progress_view(self):
773
 
        return NullProgressView()
774
 
 
775
 
 
776
 
class TestCase(testtools.TestCase):
 
718
 
 
719
def _report_leaked_threads():
 
720
    bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
 
721
                         TestCase._first_thread_leaker_id,
 
722
                         TestCase._leaking_threads_tests)
 
723
 
 
724
 
 
725
class TestCase(unittest.TestCase):
777
726
    """Base class for bzr unit tests.
778
727
 
779
728
    Tests that need access to disk resources should subclass
798
747
    _leaking_threads_tests = 0
799
748
    _first_thread_leaker_id = None
800
749
    _log_file_name = None
 
750
    _log_contents = ''
 
751
    _keep_log_file = False
801
752
    # record lsprof data when performing benchmark calls.
802
753
    _gather_lsprof_in_benchmarks = False
 
754
    attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
 
755
                     '_log_contents', '_log_file_name', '_benchtime',
 
756
                     '_TestCase__testMethodName')
803
757
 
804
758
    def __init__(self, methodName='testMethod'):
805
759
        super(TestCase, self).__init__(methodName)
806
760
        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))
 
761
        self._bzr_test_setUp_run = False
 
762
        self._bzr_test_tearDown_run = False
812
763
 
813
764
    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)]))
 
765
        unittest.TestCase.setUp(self)
 
766
        self._bzr_test_setUp_run = True
821
767
        self._cleanEnvironment()
822
768
        self._silenceUI()
823
769
        self._startLogFile()
824
770
        self._benchcalls = []
825
771
        self._benchtime = None
826
772
        self._clear_hooks()
827
 
        self._track_transports()
828
 
        self._track_locks()
829
773
        self._clear_debug_flags()
830
774
        TestCase._active_threads = threading.activeCount()
831
775
        self.addCleanup(self._check_leaked_threads)
839
783
        active = threading.activeCount()
840
784
        leaked_threads = active - TestCase._active_threads
841
785
        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:
 
786
        if leaked_threads:
849
787
            TestCase._leaking_threads_tests += 1
850
788
            if TestCase._first_thread_leaker_id is None:
851
789
                TestCase._first_thread_leaker_id = self.id()
 
790
                # we're not specifically told when all tests are finished.
 
791
                # This will do. We use a function to avoid keeping a reference
 
792
                # to a TestCase object.
 
793
                atexit.register(_report_leaked_threads)
852
794
 
853
795
    def _clear_debug_flags(self):
854
796
        """Prevent externally set debug flags affecting tests.
856
798
        Tests that want to use debug flags can just set them in the
857
799
        debug_flags set during setup/teardown.
858
800
        """
859
 
        # Start with a copy of the current debug flags we can safely modify.
860
 
        self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
 
801
        self._preserved_debug_flags = set(debug.debug_flags)
861
802
        if 'allow_debug' not in selftest_debug_flags:
862
803
            debug.debug_flags.clear()
863
 
        if 'disable_lock_checks' not in selftest_debug_flags:
864
 
            debug.debug_flags.add('strict_locks')
 
804
        self.addCleanup(self._restore_debug_flags)
865
805
 
866
806
    def _clear_hooks(self):
867
807
        # prevent hooks affecting tests
877
817
        # this hook should always be installed
878
818
        request._install_hook()
879
819
 
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
820
    def _silenceUI(self):
889
821
        """Turn off UI for duration of test"""
890
822
        # by default the UI is off; tests can turn it on if they want it.
891
 
        self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
892
 
 
893
 
    def _check_locks(self):
894
 
        """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.
898
 
        # unhook:
899
 
        acquired_locks = [lock for action, lock in self._lock_actions
900
 
                          if action == 'acquired']
901
 
        released_locks = [lock for action, lock in self._lock_actions
902
 
                          if action == 'released']
903
 
        broken_locks = [lock for action, lock in self._lock_actions
904
 
                        if action == 'broken']
905
 
        # trivially, given the tests for lock acquistion and release, if we
906
 
        # have as many in each list, it should be ok. Some lock tests also
907
 
        # break some locks on purpose and should be taken into account by
908
 
        # considering that breaking a lock is just a dirty way of releasing it.
909
 
        if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
910
 
            message = ('Different number of acquired and '
911
 
                       'released or broken locks. (%s, %s + %s)' %
912
 
                       (acquired_locks, released_locks, broken_locks))
913
 
            if not self._lock_check_thorough:
914
 
                # Rather than fail, just warn
915
 
                print "Broken test %s: %s" % (self, message)
916
 
                return
917
 
            self.fail(message)
918
 
 
919
 
    def _track_locks(self):
920
 
        """Track lock activity during tests."""
921
 
        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
 
 
927
 
        self.addCleanup(self._check_locks)
928
 
        _mod_lock.Lock.hooks.install_named_hook('lock_acquired',
929
 
                                                self._lock_acquired, None)
930
 
        _mod_lock.Lock.hooks.install_named_hook('lock_released',
931
 
                                                self._lock_released, None)
932
 
        _mod_lock.Lock.hooks.install_named_hook('lock_broken',
933
 
                                                self._lock_broken, None)
934
 
 
935
 
    def _lock_acquired(self, result):
936
 
        self._lock_actions.append(('acquired', result))
937
 
 
938
 
    def _lock_released(self, result):
939
 
        self._lock_actions.append(('released', result))
940
 
 
941
 
    def _lock_broken(self, result):
942
 
        self._lock_actions.append(('broken', result))
943
 
 
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.")
 
823
        saved = ui.ui_factory
 
824
        def _restore():
 
825
            ui.ui_factory = saved
 
826
        ui.ui_factory = ui.SilentUIFactory()
 
827
        self.addCleanup(_restore)
1070
828
 
1071
829
    def _ndiff_strings(self, a, b):
1072
830
        """Return ndiff between two strings containing lines.
1110
868
            return
1111
869
        if message is None:
1112
870
            message = "texts not equal:\n"
 
871
        if a == b + '\n':
 
872
            message = 'first string is missing a final newline.\n'
1113
873
        if a + '\n' == b:
1114
 
            message = 'first string is missing a final newline.\n'
1115
 
        if a == b + '\n':
1116
874
            message = 'second string is missing a final newline.\n'
1117
875
        raise AssertionError(message +
1118
876
                             self._ndiff_strings(a, b))
1129
887
        :raises AssertionError: If the expected and actual stat values differ
1130
888
            other than by atime.
1131
889
        """
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')
 
890
        self.assertEqual(expected.st_size, actual.st_size)
 
891
        self.assertEqual(expected.st_mtime, actual.st_mtime)
 
892
        self.assertEqual(expected.st_ctime, actual.st_ctime)
 
893
        self.assertEqual(expected.st_dev, actual.st_dev)
 
894
        self.assertEqual(expected.st_ino, actual.st_ino)
 
895
        self.assertEqual(expected.st_mode, actual.st_mode)
1149
896
 
1150
897
    def assertLength(self, length, obj_with_len):
1151
898
        """Assert that obj_with_len is of length length."""
1153
900
            self.fail("Incorrect length: wanted %d, got %d for %r" % (
1154
901
                length, len(obj_with_len), obj_with_len))
1155
902
 
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
903
    def assertPositive(self, val):
1176
904
        """Assert that val is greater than 0."""
1177
905
        self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1207
935
            raise AssertionError('pattern "%s" found in "%s"'
1208
936
                    % (needle_re, haystack))
1209
937
 
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
938
    def assertSubset(self, sublist, superlist):
1215
939
        """Assert that every entry in sublist is present in superlist."""
1216
940
        missing = set(sublist) - set(superlist)
1273
997
                raise AssertionError("%r is %r." % (left, right))
1274
998
 
1275
999
    def assertTransportMode(self, transport, path, mode):
1276
 
        """Fail if a path does not have mode "mode".
 
1000
        """Fail if a path does not have mode mode.
1277
1001
 
1278
1002
        If modes are not supported on this transport, the assertion is ignored.
1279
1003
        """
1291
1015
                         osutils.realpath(path2),
1292
1016
                         "apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1293
1017
 
1294
 
    def assertIsInstance(self, obj, kls, msg=None):
1295
 
        """Fail if obj is not an instance of kls
1296
 
        
1297
 
        :param msg: Supplementary message to show if the assertion fails.
1298
 
        """
 
1018
    def assertIsInstance(self, obj, kls):
 
1019
        """Fail if obj is not an instance of kls"""
1299
1020
        if not isinstance(obj, kls):
1300
 
            m = "%r is an instance of %s rather than %s" % (
1301
 
                obj, obj.__class__, kls)
1302
 
            if msg:
1303
 
                m += ": " + msg
1304
 
            self.fail(m)
 
1021
            self.fail("%r is an instance of %s rather than %s" % (
 
1022
                obj, obj.__class__, kls))
 
1023
 
 
1024
    def expectFailure(self, reason, assertion, *args, **kwargs):
 
1025
        """Invoke a test, expecting it to fail for the given reason.
 
1026
 
 
1027
        This is for assertions that ought to succeed, but currently fail.
 
1028
        (The failure is *expected* but not *wanted*.)  Please be very precise
 
1029
        about the failure you're expecting.  If a new bug is introduced,
 
1030
        AssertionError should be raised, not KnownFailure.
 
1031
 
 
1032
        Frequently, expectFailure should be followed by an opposite assertion.
 
1033
        See example below.
 
1034
 
 
1035
        Intended to be used with a callable that raises AssertionError as the
 
1036
        'assertion' parameter.  args and kwargs are passed to the 'assertion'.
 
1037
 
 
1038
        Raises KnownFailure if the test fails.  Raises AssertionError if the
 
1039
        test succeeds.
 
1040
 
 
1041
        example usage::
 
1042
 
 
1043
          self.expectFailure('Math is broken', self.assertNotEqual, 54,
 
1044
                             dynamic_val)
 
1045
          self.assertEqual(42, dynamic_val)
 
1046
 
 
1047
          This means that a dynamic_val of 54 will cause the test to raise
 
1048
          a KnownFailure.  Once math is fixed and the expectFailure is removed,
 
1049
          only a dynamic_val of 42 will allow the test to pass.  Anything other
 
1050
          than 54 or 42 will cause an AssertionError.
 
1051
        """
 
1052
        try:
 
1053
            assertion(*args, **kwargs)
 
1054
        except AssertionError:
 
1055
            raise KnownFailure(reason)
 
1056
        else:
 
1057
            self.fail('Unexpected success.  Should have failed: %s' % reason)
1305
1058
 
1306
1059
    def assertFileEqual(self, content, path):
1307
1060
        """Fail if path does not contain 'content'."""
1313
1066
            f.close()
1314
1067
        self.assertEqualDiff(content, s)
1315
1068
 
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
1069
    def failUnlessExists(self, path):
1325
1070
        """Fail unless path or paths, which may be abs or relative, exist."""
1326
1071
        if not isinstance(path, basestring):
1466
1211
 
1467
1212
        Close the file and delete it, unless setKeepLogfile was called.
1468
1213
        """
1469
 
        if bzrlib.trace._trace_file:
1470
 
            # flush the log file, to get all content
1471
 
            bzrlib.trace._trace_file.flush()
 
1214
        if self._log_file is None:
 
1215
            return
1472
1216
        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')
 
1217
        self._log_file.close()
 
1218
        self._log_file = None
 
1219
        if not self._keep_log_file:
 
1220
            os.remove(self._log_file_name)
 
1221
            self._log_file_name = None
 
1222
 
 
1223
    def setKeepLogfile(self):
 
1224
        """Make the logfile not be deleted when _finishLogFile is called."""
 
1225
        self._keep_log_file = True
1488
1226
 
1489
1227
    def addCleanup(self, callable, *args, **kwargs):
1490
1228
        """Arrange to run a callable when this case is torn down.
1494
1232
        """
1495
1233
        self._cleanups.append((callable, args, kwargs))
1496
1234
 
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
1235
    def _cleanEnvironment(self):
1517
1236
        new_env = {
1518
1237
            'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1528
1247
            'BZR_PROGRESS_BAR': None,
1529
1248
            'BZR_LOG': None,
1530
1249
            'BZR_PLUGIN_PATH': None,
1531
 
            'BZR_DISABLE_PLUGINS': None,
1532
 
            'BZR_PLUGINS_AT': None,
1533
 
            'BZR_CONCURRENCY': None,
1534
 
            # Make sure that any text ui tests are consistent regardless of
1535
 
            # the environment the test case is run in; you may want tests that
1536
 
            # test other combinations.  'dumb' is a reasonable guess for tests
1537
 
            # going to a pipe or a StringIO.
1538
 
            'TERM': 'dumb',
1539
 
            'LINES': '25',
1540
 
            'COLUMNS': '80',
1541
 
            'BZR_COLUMNS': '80',
1542
1250
            # SSH Agent
1543
1251
            'SSH_AUTH_SOCK': None,
1544
1252
            # Proxies
1556
1264
            'ftp_proxy': None,
1557
1265
            'FTP_PROXY': None,
1558
1266
            '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
1267
        }
1565
 
        self._old_env = {}
 
1268
        self.__old_env = {}
1566
1269
        self.addCleanup(self._restoreEnvironment)
1567
1270
        for name, value in new_env.iteritems():
1568
1271
            self._captureVar(name, value)
1569
1272
 
1570
1273
    def _captureVar(self, name, newvalue):
1571
1274
        """Set an environment variable, and reset it when finished."""
1572
 
        self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1275
        self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1276
 
 
1277
    def _restore_debug_flags(self):
 
1278
        debug.debug_flags.clear()
 
1279
        debug.debug_flags.update(self._preserved_debug_flags)
1573
1280
 
1574
1281
    def _restoreEnvironment(self):
1575
 
        for name, value in self._old_env.iteritems():
 
1282
        for name, value in self.__old_env.iteritems():
1576
1283
            osutils.set_or_unset_env(name, value)
1577
1284
 
1578
1285
    def _restoreHooks(self):
1586
1293
    def _do_skip(self, result, reason):
1587
1294
        addSkip = getattr(result, 'addSkip', None)
1588
1295
        if not callable(addSkip):
1589
 
            result.addSuccess(result)
 
1296
            result.addError(self, sys.exc_info())
1590
1297
        else:
1591
1298
            addSkip(self, reason)
1592
1299
 
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)
 
1300
    def run(self, result=None):
 
1301
        if result is None: result = self.defaultTestResult()
 
1302
        for feature in getattr(self, '_test_needs_features', []):
 
1303
            if not feature.available():
 
1304
                result.startTest(self)
 
1305
                if getattr(result, 'addNotSupported', None):
 
1306
                    result.addNotSupported(self, feature)
 
1307
                else:
 
1308
                    result.addSuccess(self)
 
1309
                result.stopTest(self)
 
1310
                return
 
1311
        try:
 
1312
            try:
 
1313
                result.startTest(self)
 
1314
                absent_attr = object()
 
1315
                # Python 2.5
 
1316
                method_name = getattr(self, '_testMethodName', absent_attr)
 
1317
                if method_name is absent_attr:
 
1318
                    # Python 2.4
 
1319
                    method_name = getattr(self, '_TestCase__testMethodName')
 
1320
                testMethod = getattr(self, method_name)
 
1321
                try:
 
1322
                    try:
 
1323
                        self.setUp()
 
1324
                        if not self._bzr_test_setUp_run:
 
1325
                            self.fail(
 
1326
                                "test setUp did not invoke "
 
1327
                                "bzrlib.tests.TestCase's setUp")
 
1328
                    except KeyboardInterrupt:
 
1329
                        raise
 
1330
                    except TestSkipped, e:
 
1331
                        self._do_skip(result, e.args[0])
 
1332
                        self.tearDown()
 
1333
                        return
 
1334
                    except:
 
1335
                        result.addError(self, sys.exc_info())
 
1336
                        return
 
1337
 
 
1338
                    ok = False
 
1339
                    try:
 
1340
                        testMethod()
 
1341
                        ok = True
 
1342
                    except self.failureException:
 
1343
                        result.addFailure(self, sys.exc_info())
 
1344
                    except TestSkipped, e:
 
1345
                        if not e.args:
 
1346
                            reason = "No reason given."
 
1347
                        else:
 
1348
                            reason = e.args[0]
 
1349
                        self._do_skip(result, reason)
 
1350
                    except KeyboardInterrupt:
 
1351
                        raise
 
1352
                    except:
 
1353
                        result.addError(self, sys.exc_info())
 
1354
 
 
1355
                    try:
 
1356
                        self.tearDown()
 
1357
                        if not self._bzr_test_tearDown_run:
 
1358
                            self.fail(
 
1359
                                "test tearDown did not invoke "
 
1360
                                "bzrlib.tests.TestCase's tearDown")
 
1361
                    except KeyboardInterrupt:
 
1362
                        raise
 
1363
                    except:
 
1364
                        result.addError(self, sys.exc_info())
 
1365
                        ok = False
 
1366
                    if ok: result.addSuccess(self)
 
1367
                finally:
 
1368
                    result.stopTest(self)
 
1369
                return
 
1370
            except TestNotApplicable:
 
1371
                # Not moved from the result [yet].
 
1372
                raise
 
1373
            except KeyboardInterrupt:
 
1374
                raise
 
1375
        finally:
 
1376
            saved_attrs = {}
 
1377
            absent_attr = object()
 
1378
            for attr_name in self.attrs_to_keep:
 
1379
                attr = getattr(self, attr_name, absent_attr)
 
1380
                if attr is not absent_attr:
 
1381
                    saved_attrs[attr_name] = attr
 
1382
            self.__dict__ = saved_attrs
 
1383
 
 
1384
    def tearDown(self):
 
1385
        self._bzr_test_tearDown_run = True
 
1386
        self._runCleanups()
 
1387
        self._log_contents = ''
 
1388
        unittest.TestCase.tearDown(self)
1622
1389
 
1623
1390
    def time(self, callable, *args, **kwargs):
1624
1391
        """Run callable and accrue the time it takes to the benchmark time.
1628
1395
        self._benchcalls.
1629
1396
        """
1630
1397
        if self._benchtime is None:
1631
 
            self.addDetail('benchtime', content.Content(content.ContentType(
1632
 
                "text", "plain"), lambda:[str(self._benchtime)]))
1633
1398
            self._benchtime = 0
1634
1399
        start = time.time()
1635
1400
        try:
1644
1409
        finally:
1645
1410
            self._benchtime += time.time() - start
1646
1411
 
 
1412
    def _runCleanups(self):
 
1413
        """Run registered cleanup functions.
 
1414
 
 
1415
        This should only be called from TestCase.tearDown.
 
1416
        """
 
1417
        # TODO: Perhaps this should keep running cleanups even if
 
1418
        # one of them fails?
 
1419
 
 
1420
        # Actually pop the cleanups from the list so tearDown running
 
1421
        # twice is safe (this happens for skipped tests).
 
1422
        while self._cleanups:
 
1423
            cleanup, args, kwargs = self._cleanups.pop()
 
1424
            cleanup(*args, **kwargs)
 
1425
 
1647
1426
    def log(self, *args):
1648
1427
        mutter(*args)
1649
1428
 
1650
1429
    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.
 
1430
        """Get the log from bzrlib.trace calls from this test.
1655
1431
 
1656
1432
        :param keep_log_file: When True, if the log is still a file on disk
1657
1433
            leave it as a file on disk. When False, if the log is still a file
1659
1435
            self._log_contents.
1660
1436
        :return: A string containing the log.
1661
1437
        """
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')
 
1438
        # flush the log file, to get all content
 
1439
        import bzrlib.trace
 
1440
        if bzrlib.trace._trace_file:
 
1441
            bzrlib.trace._trace_file.flush()
 
1442
        if self._log_contents:
 
1443
            # XXX: this can hardly contain the content flushed above --vila
 
1444
            # 20080128
1668
1445
            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
1446
        if self._log_file_name is not None:
1674
1447
            logfile = open(self._log_file_name)
1675
1448
            try:
1676
1449
                log_contents = logfile.read()
1677
1450
            finally:
1678
1451
                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
1452
            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
1453
                self._log_contents = log_contents
1716
1454
                try:
1717
1455
                    os.remove(self._log_file_name)
1721
1459
                                             ' %r\n' % self._log_file_name))
1722
1460
                    else:
1723
1461
                        raise
1724
 
                self._log_file_name = None
1725
1462
            return log_contents
1726
1463
        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())
 
1464
            return "DELETED log file to reduce memory footprint"
1735
1465
 
1736
1466
    def requireFeature(self, feature):
1737
1467
        """This test requires a specific feature is available.
1754
1484
 
1755
1485
    def _run_bzr_core(self, args, retcode, encoding, stdin,
1756
1486
            working_dir):
1757
 
        # Clear chk_map page cache, because the contents are likely to mask
1758
 
        # locking errors.
1759
 
        chk_map.clear_cache()
1760
1487
        if encoding is None:
1761
1488
            encoding = osutils.get_user_encoding()
1762
1489
        stdout = StringIOWrapper()
1779
1506
            os.chdir(working_dir)
1780
1507
 
1781
1508
        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)
 
1509
            result = self.apply_redirected(ui.ui_factory.stdin,
 
1510
                stdout, stderr,
 
1511
                bzrlib.commands.run_bzr_catch_user_errors,
 
1512
                args)
1798
1513
        finally:
1799
1514
            logger.removeHandler(handler)
1800
1515
            ui.ui_factory = old_ui_factory
1810
1525
        if retcode is not None:
1811
1526
            self.assertEquals(retcode, result,
1812
1527
                              message='Unexpected return code')
1813
 
        return result, out, err
 
1528
        return out, err
1814
1529
 
1815
1530
    def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1816
1531
                working_dir=None, error_regexes=[], output_encoding=None):
1845
1560
        :keyword error_regexes: A list of expected error messages.  If
1846
1561
            specified they must be seen in the error output of the command.
1847
1562
        """
1848
 
        retcode, out, err = self._run_bzr_autosplit(
 
1563
        out, err = self._run_bzr_autosplit(
1849
1564
            args=args,
1850
1565
            retcode=retcode,
1851
1566
            encoding=encoding,
1852
1567
            stdin=stdin,
1853
1568
            working_dir=working_dir,
1854
1569
            )
1855
 
        self.assertIsInstance(error_regexes, (list, tuple))
1856
1570
        for regex in error_regexes:
1857
1571
            self.assertContainsRe(err, regex)
1858
1572
        return out, err
2002
1716
        """
2003
1717
        return Popen(*args, **kwargs)
2004
1718
 
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
1719
    def get_bzr_path(self):
2010
1720
        """Return the path of the 'bzr' executable for this test suite."""
2011
 
        bzr_path = self.get_source_path()+'/bzr'
 
1721
        bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
2012
1722
        if not os.path.isfile(bzr_path):
2013
1723
            # We are probably installed. Assume sys.argv is the right file
2014
1724
            bzr_path = sys.argv[0]
2100
1810
 
2101
1811
        Tests that expect to provoke LockContention errors should call this.
2102
1812
        """
2103
 
        self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
 
1813
        orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
 
1814
        def resetTimeout():
 
1815
            bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
 
1816
        self.addCleanup(resetTimeout)
 
1817
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2104
1818
 
2105
1819
    def make_utf8_encoded_stringio(self, encoding_type=None):
2106
1820
        """Return a StringIOWrapper instance, that will encode Unicode
2114
1828
        sio.encoding = output_encoding
2115
1829
        return sio
2116
1830
 
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
1831
 
2126
1832
class CapturedCall(object):
2127
1833
    """A helper for capturing smart server calls for easy debug analysis."""
2217
1923
        if self.__readonly_server is None:
2218
1924
            if self.transport_readonly_server is None:
2219
1925
                # readonly decorator requested
2220
 
                self.__readonly_server = test_server.ReadonlyServer()
 
1926
                # bring up the server
 
1927
                self.__readonly_server = ReadonlyServer()
 
1928
                self.__readonly_server.setUp(self.get_vfs_only_server())
2221
1929
            else:
2222
 
                # explicit readonly transport.
2223
1930
                self.__readonly_server = self.create_transport_readonly_server()
2224
 
            self.start_server(self.__readonly_server,
2225
 
                self.get_vfs_only_server())
 
1931
                self.__readonly_server.setUp(self.get_vfs_only_server())
 
1932
            self.addCleanup(self.__readonly_server.tearDown)
2226
1933
        return self.__readonly_server
2227
1934
 
2228
1935
    def get_readonly_url(self, relpath=None):
2246
1953
        is no means to override it.
2247
1954
        """
2248
1955
        if self.__vfs_server is None:
2249
 
            self.__vfs_server = memory.MemoryServer()
2250
 
            self.start_server(self.__vfs_server)
 
1956
            self.__vfs_server = MemoryServer()
 
1957
            self.__vfs_server.setUp()
 
1958
            self.addCleanup(self.__vfs_server.tearDown)
2251
1959
        return self.__vfs_server
2252
1960
 
2253
1961
    def get_server(self):
2260
1968
        then the self.get_vfs_server is returned.
2261
1969
        """
2262
1970
        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()
 
1971
            if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
 
1972
                return self.get_vfs_only_server()
2266
1973
            else:
2267
1974
                # bring up a decorated means of access to the vfs only server.
2268
1975
                self.__server = self.transport_server()
2269
 
                self.start_server(self.__server, self.get_vfs_only_server())
 
1976
                try:
 
1977
                    self.__server.setUp(self.get_vfs_only_server())
 
1978
                except TypeError, e:
 
1979
                    # This should never happen; the try:Except here is to assist
 
1980
                    # developers having to update code rather than seeing an
 
1981
                    # uninformative TypeError.
 
1982
                    raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
 
1983
            self.addCleanup(self.__server.tearDown)
2270
1984
        return self.__server
2271
1985
 
2272
1986
    def _adjust_url(self, base, relpath):
2334
2048
        propagating. This method ensures than a test did not leaked.
2335
2049
        """
2336
2050
        root = TestCaseWithMemoryTransport.TEST_ROOT
2337
 
        self.permit_url(get_transport(root).base)
2338
2051
        wt = workingtree.WorkingTree.open(root)
2339
2052
        last_rev = wt.last_revision()
2340
2053
        if last_rev != 'null:':
2342
2055
            # recreate a new one or all the followng tests will fail.
2343
2056
            # If you need to inspect its content uncomment the following line
2344
2057
            # import pdb; pdb.set_trace()
2345
 
            _rmtree_temp_dir(root + '/.bzr', test_id=self.id())
 
2058
            _rmtree_temp_dir(root + '/.bzr')
2346
2059
            self._create_safety_net()
2347
2060
            raise AssertionError('%s/.bzr should not be modified' % root)
2348
2061
 
2349
2062
    def _make_test_root(self):
2350
2063
        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'))
 
2064
            root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2354
2065
            TestCaseWithMemoryTransport.TEST_ROOT = root
2355
2066
 
2356
2067
            self._create_safety_net()
2359
2070
            # specifically told when all tests are finished.  This will do.
2360
2071
            atexit.register(_rmtree_temp_dir, root)
2361
2072
 
2362
 
        self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2363
2073
        self.addCleanup(self._check_safety_net)
2364
2074
 
2365
2075
    def makeAndChdirToTestDir(self):
2373
2083
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2374
2084
        self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2375
2085
        self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2376
 
        self.permit_dir(self.test_dir)
2377
2086
 
2378
2087
    def make_branch(self, relpath, format=None):
2379
2088
        """Create a branch on the transport at relpath."""
2409
2118
        return made_control.create_repository(shared=shared)
2410
2119
 
2411
2120
    def make_smart_server(self, path):
2412
 
        smart_server = test_server.SmartTCPServer_for_testing()
2413
 
        self.start_server(smart_server, self.get_server())
 
2121
        smart_server = server.SmartTCPServer_for_testing()
 
2122
        smart_server.setUp(self.get_server())
2414
2123
        remote_transport = get_transport(smart_server.get_url()).clone(path)
 
2124
        self.addCleanup(smart_server.tearDown)
2415
2125
        return remote_transport
2416
2126
 
2417
2127
    def make_branch_and_memory_tree(self, relpath, format=None):
2420
2130
        return memorytree.MemoryTree.create_on_branch(b)
2421
2131
 
2422
2132
    def make_branch_builder(self, relpath, format=None):
2423
 
        branch = self.make_branch(relpath, format=format)
2424
 
        return branchbuilder.BranchBuilder(branch=branch)
 
2133
        return branchbuilder.BranchBuilder(self.get_transport(relpath),
 
2134
            format=format)
2425
2135
 
2426
2136
    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
 
2137
        os.environ['HOME'] = self.test_home_dir
 
2138
        os.environ['BZR_HOME'] = self.test_home_dir
2432
2139
 
2433
2140
    def setUp(self):
2434
2141
        super(TestCaseWithMemoryTransport, self).setUp()
2435
2142
        self._make_test_root()
2436
 
        self.addCleanup(os.chdir, os.getcwdu())
 
2143
        _currentdir = os.getcwdu()
 
2144
        def _leaveDirectory():
 
2145
            os.chdir(_currentdir)
 
2146
        self.addCleanup(_leaveDirectory)
2437
2147
        self.makeAndChdirToTestDir()
2438
2148
        self.overrideEnvironmentForTesting()
2439
2149
        self.__readonly_server = None
2442
2152
 
2443
2153
    def setup_smart_server_with_call_log(self):
2444
2154
        """Sets up a smart server as the transport server with a call log."""
2445
 
        self.transport_server = test_server.SmartTCPServer_for_testing
 
2155
        self.transport_server = server.SmartTCPServer_for_testing
2446
2156
        self.hpss_calls = []
2447
2157
        import traceback
2448
2158
        # Skip the current stack down to the caller of
2490
2200
 
2491
2201
    def _getTestDirPrefix(self):
2492
2202
        # create a directory within the top level test directory
2493
 
        if sys.platform in ('win32', 'cygwin'):
 
2203
        if sys.platform == 'win32':
2494
2204
            name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2495
2205
            # windows is likely to have path-length limits so use a short name
2496
2206
            name_prefix = name_prefix[-30:]
2511
2221
            if os.path.exists(name):
2512
2222
                name = name_prefix + '_' + str(i)
2513
2223
            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)
 
2224
                os.mkdir(name)
2518
2225
                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()
 
2226
        # now create test and home directories within this dir
 
2227
        self.test_base_dir = name
2526
2228
        self.test_home_dir = self.test_base_dir + '/home'
2527
2229
        os.mkdir(self.test_home_dir)
2528
2230
        self.test_dir = self.test_base_dir + '/work'
2534
2236
            f.write(self.id())
2535
2237
        finally:
2536
2238
            f.close()
 
2239
        self.addCleanup(self.deleteTestDir)
2537
2240
 
2538
2241
    def deleteTestDir(self):
2539
2242
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2540
 
        _rmtree_temp_dir(self.test_base_dir, test_id=self.id())
 
2243
        _rmtree_temp_dir(self.test_base_dir)
2541
2244
 
2542
2245
    def build_tree(self, shape, line_endings='binary', transport=None):
2543
2246
        """Build a test tree according to a pattern.
2625
2328
        """
2626
2329
        if self.__vfs_server is None:
2627
2330
            self.__vfs_server = self.vfs_transport_factory()
2628
 
            self.start_server(self.__vfs_server)
 
2331
            self.__vfs_server.setUp()
 
2332
            self.addCleanup(self.__vfs_server.tearDown)
2629
2333
        return self.__vfs_server
2630
2334
 
2631
2335
    def make_branch_and_tree(self, relpath, format=None):
2638
2342
        repository will also be accessed locally. Otherwise a lightweight
2639
2343
        checkout is created and returned.
2640
2344
 
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
2345
        :param format: The BzrDirFormat.
2651
2346
        :returns: the WorkingTree.
2652
2347
        """
2661
2356
            # We can only make working trees locally at the moment.  If the
2662
2357
            # transport can't support them, then we keep the non-disk-backed
2663
2358
            # branch and create a local checkout.
2664
 
            if self.vfs_transport_factory is test_server.LocalURLServer:
 
2359
            if self.vfs_transport_factory is LocalURLServer:
2665
2360
                # the branch is colocated on disk, we cannot create a checkout.
2666
2361
                # hopefully callers will expect this.
2667
2362
                local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2704
2399
        super(TestCaseWithTransport, self).setUp()
2705
2400
        self.__vfs_server = None
2706
2401
 
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
2402
 
2716
2403
class ChrootedTestCase(TestCaseWithTransport):
2717
2404
    """A support class that provides readonly urls outside the local namespace.
2727
2414
 
2728
2415
    def setUp(self):
2729
2416
        super(ChrootedTestCase, self).setUp()
2730
 
        if not self.vfs_transport_factory == memory.MemoryServer:
 
2417
        if not self.vfs_transport_factory == MemoryServer:
2731
2418
            self.transport_readonly_server = HttpServer
2732
2419
 
2733
2420
 
2930
2617
              exclude_pattern=None,
2931
2618
              strict=False,
2932
2619
              runner_class=None,
2933
 
              suite_decorators=None,
2934
 
              stream=None,
2935
 
              result_decorators=None,
2936
 
              ):
 
2620
              suite_decorators=None):
2937
2621
    """Run a test suite for bzr selftest.
2938
2622
 
2939
2623
    :param runner_class: The class of runner to use. Must support the
2948
2632
        verbosity = 1
2949
2633
    if runner_class is None:
2950
2634
        runner_class = TextTestRunner
2951
 
    if stream is None:
2952
 
        stream = sys.stdout
2953
 
    runner = runner_class(stream=stream,
 
2635
    runner = runner_class(stream=sys.stdout,
2954
2636
                            descriptions=0,
2955
2637
                            verbosity=verbosity,
2956
2638
                            bench_history=bench_history,
2957
 
                            strict=strict,
2958
 
                            result_decorators=result_decorators,
 
2639
                            list_only=list_only,
2959
2640
                            )
2960
2641
    runner.stop_on_failure=stop_on_failure
2961
2642
    # built in decorator factories:
2969
2650
        decorators.append(filter_tests(pattern))
2970
2651
    if suite_decorators:
2971
2652
        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
2653
    for decorator in decorators:
2978
2654
        suite = decorator(suite)
2979
 
    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
 
        return True
2987
2655
    result = runner.run(suite)
2988
2656
    if strict:
2989
2657
        return result.wasStrictlySuccessful()
2996
2664
 
2997
2665
 
2998
2666
def fork_decorator(suite):
2999
 
    concurrency = osutils.local_concurrency()
 
2667
    concurrency = local_concurrency()
3000
2668
    if concurrency == 1:
3001
2669
        return suite
3002
2670
    from testtools import ConcurrentTestSuite
3005
2673
 
3006
2674
 
3007
2675
def subprocess_decorator(suite):
3008
 
    concurrency = osutils.local_concurrency()
 
2676
    concurrency = local_concurrency()
3009
2677
    if concurrency == 1:
3010
2678
        return suite
3011
2679
    from testtools import ConcurrentTestSuite
3088
2756
        return result
3089
2757
 
3090
2758
 
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
2759
class ExcludeDecorator(TestDecorator):
3102
2760
    """A decorator which excludes test matching an exclude pattern."""
3103
2761
 
3147
2805
        if self.randomised:
3148
2806
            return iter(self._tests)
3149
2807
        self.randomised = True
3150
 
        self.stream.write("Randomizing test order using seed %s\n\n" %
 
2808
        self.stream.writeln("Randomizing test order using seed %s\n" %
3151
2809
            (self.actual_seed()))
3152
2810
        # Initialise the random number generator.
3153
2811
        random.seed(self.actual_seed())
3201
2859
    return result
3202
2860
 
3203
2861
 
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
2862
def fork_for_tests(suite):
3218
2863
    """Take suite and start up one runner per CPU by forking()
3219
2864
 
3220
2865
    :return: An iterable of TestCase-like objects which can each have
3221
2866
        run(result) called on them to feed tests to result.
3222
2867
    """
3223
 
    concurrency = osutils.local_concurrency()
 
2868
    concurrency = local_concurrency()
3224
2869
    result = []
3225
2870
    from subunit import TestProtocolClient, ProtocolTestCase
3226
 
    from subunit.test_results import AutoTimingTestResultDecorator
3227
2871
    class TestInOtherProcess(ProtocolTestCase):
3228
2872
        # Should be in subunit, I think. RBC.
3229
2873
        def __init__(self, stream, pid):
3234
2878
            try:
3235
2879
                ProtocolTestCase.run(self, result)
3236
2880
            finally:
3237
 
                os.waitpid(self.pid, 0)
 
2881
                os.waitpid(self.pid, os.WNOHANG)
3238
2882
 
3239
2883
    test_blocks = partition_tests(suite, concurrency)
3240
2884
    for process_tests in test_blocks:
3243
2887
        c2pread, c2pwrite = os.pipe()
3244
2888
        pid = os.fork()
3245
2889
        if pid == 0:
3246
 
            workaround_zealous_crypto_random()
3247
2890
            try:
3248
2891
                os.close(c2pread)
3249
2892
                # Leave stderr and stdout open so we can see test noise
3253
2896
                sys.stdin.close()
3254
2897
                sys.stdin = None
3255
2898
                stream = os.fdopen(c2pwrite, 'wb', 1)
3256
 
                subunit_result = AutoTimingTestResultDecorator(
3257
 
                    TestProtocolClient(stream))
 
2899
                subunit_result = TestProtocolClient(stream)
3258
2900
                process_suite.run(subunit_result)
3259
2901
            finally:
3260
2902
                os._exit(0)
3272
2914
    :return: An iterable of TestCase-like objects which can each have
3273
2915
        run(result) called on them to feed tests to result.
3274
2916
    """
3275
 
    concurrency = osutils.local_concurrency()
 
2917
    concurrency = local_concurrency()
3276
2918
    result = []
3277
 
    from subunit import ProtocolTestCase
 
2919
    from subunit import TestProtocolClient, ProtocolTestCase
3278
2920
    class TestInSubprocess(ProtocolTestCase):
3279
2921
        def __init__(self, process, name):
3280
2922
            ProtocolTestCase.__init__(self, process.stdout)
3296
2938
        if not os.path.isfile(bzr_path):
3297
2939
            # We are probably installed. Assume sys.argv is the right file
3298
2940
            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
2941
        fd, test_list_file_name = tempfile.mkstemp()
3304
2942
        test_list_file = os.fdopen(fd, 'wb', 1)
3305
2943
        for test in process_tests:
3306
2944
            test_list_file.write(test.id() + '\n')
3307
2945
        test_list_file.close()
3308
2946
        try:
3309
 
            argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
 
2947
            argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3310
2948
                '--subunit']
3311
2949
            if '--no-plugins' in sys.argv:
3312
2950
                argv.append('--no-plugins')
3322
2960
    return result
3323
2961
 
3324
2962
 
3325
 
class ForwardingResult(unittest.TestResult):
 
2963
def cpucount(content):
 
2964
    lines = content.splitlines()
 
2965
    prefix = 'processor'
 
2966
    for line in lines:
 
2967
        if line.startswith(prefix):
 
2968
            concurrency = int(line[line.find(':')+1:]) + 1
 
2969
    return concurrency
 
2970
 
 
2971
 
 
2972
def local_concurrency():
 
2973
    try:
 
2974
        content = file('/proc/cpuinfo', 'rb').read()
 
2975
        concurrency = cpucount(content)
 
2976
    except Exception, e:
 
2977
        concurrency = 1
 
2978
    return concurrency
 
2979
 
 
2980
 
 
2981
class BZRTransformingResult(unittest.TestResult):
3326
2982
 
3327
2983
    def __init__(self, target):
3328
2984
        unittest.TestResult.__init__(self)
3334
2990
    def stopTest(self, test):
3335
2991
        self.result.stopTest(test)
3336
2992
 
3337
 
    def startTestRun(self):
3338
 
        self.result.startTestRun()
 
2993
    def addError(self, test, err):
 
2994
        feature = self._error_looks_like('UnavailableFeature: ', err)
 
2995
        if feature is not None:
 
2996
            self.result.addNotSupported(test, feature)
 
2997
        else:
 
2998
            self.result.addError(test, err)
3339
2999
 
3340
 
    def stopTestRun(self):
3341
 
        self.result.stopTestRun()
 
3000
    def addFailure(self, test, err):
 
3001
        known = self._error_looks_like('KnownFailure: ', err)
 
3002
        if known is not None:
 
3003
            self.result._addKnownFailure(test, [KnownFailure,
 
3004
                                                KnownFailure(known), None])
 
3005
        else:
 
3006
            self.result.addFailure(test, err)
3342
3007
 
3343
3008
    def addSkip(self, test, reason):
3344
3009
        self.result.addSkip(test, reason)
3346
3011
    def addSuccess(self, test):
3347
3012
        self.result.addSuccess(test)
3348
3013
 
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
 
3014
    def _error_looks_like(self, prefix, err):
 
3015
        """Deserialize exception and returns the stringify value."""
 
3016
        import subunit
 
3017
        value = None
 
3018
        typ, exc, _ = err
 
3019
        if isinstance(exc, subunit.RemoteException):
 
3020
            # stringify the exception gives access to the remote traceback
 
3021
            # We search the last line for 'prefix'
 
3022
            lines = str(exc).split('\n')
 
3023
            if len(lines) > 1:
 
3024
                last = lines[-2] # -1 is empty, final \n
 
3025
            else:
 
3026
                last = lines[-1]
 
3027
            if last.startswith(prefix):
 
3028
                value = last[len(prefix):]
 
3029
        return value
3387
3030
 
3388
3031
 
3389
3032
# 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
3033
selftest_debug_flags = set()
3398
3034
 
3399
3035
 
3412
3048
             starting_with=None,
3413
3049
             runner_class=None,
3414
3050
             suite_decorators=None,
3415
 
             stream=None,
3416
 
             lsprof_tests=False,
3417
3051
             ):
3418
3052
    """Run the whole test suite under the enhanced runner"""
3419
3053
    # XXX: Very ugly way to do this...
3436
3070
            keep_only = None
3437
3071
        else:
3438
3072
            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
3073
        if test_suite_factory is None:
3443
 
            # Reduce loading time by loading modules based on the starting_with
3444
 
            # patterns.
3445
3074
            suite = test_suite(keep_only, starting_with)
3446
3075
        else:
3447
3076
            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
3077
        return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3455
3078
                     stop_on_failure=stop_on_failure,
3456
3079
                     transport=transport,
3463
3086
                     strict=strict,
3464
3087
                     runner_class=runner_class,
3465
3088
                     suite_decorators=suite_decorators,
3466
 
                     stream=stream,
3467
 
                     result_decorators=result_decorators,
3468
3089
                     )
3469
3090
    finally:
3470
3091
        default_transport = old_transport
3618
3239
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3619
3240
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3620
3241
 
3621
 
# Obvious highest levels prefixes, feel free to add your own via a plugin
 
3242
# Obvious higest levels prefixes, feel free to add your own via a plugin
3622
3243
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3623
3244
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3624
3245
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3626
3247
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3627
3248
 
3628
3249
 
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
3250
def test_suite(keep_only=None, starting_with=None):
3845
3251
    """Build and return TestSuite for the whole of bzrlib.
3846
3252
 
3852
3258
    This function can be replaced if you need to change the default test
3853
3259
    suite on a global basis, but it is not encouraged.
3854
3260
    """
 
3261
    testmod_names = [
 
3262
                   'bzrlib.doc',
 
3263
                   'bzrlib.tests.blackbox',
 
3264
                   'bzrlib.tests.branch_implementations',
 
3265
                   'bzrlib.tests.bzrdir_implementations',
 
3266
                   'bzrlib.tests.commands',
 
3267
                   'bzrlib.tests.interrepository_implementations',
 
3268
                   'bzrlib.tests.intertree_implementations',
 
3269
                   'bzrlib.tests.inventory_implementations',
 
3270
                   'bzrlib.tests.per_interbranch',
 
3271
                   'bzrlib.tests.per_lock',
 
3272
                   'bzrlib.tests.per_repository',
 
3273
                   'bzrlib.tests.per_repository_reference',
 
3274
                   'bzrlib.tests.test__dirstate_helpers',
 
3275
                   'bzrlib.tests.test__walkdirs_win32',
 
3276
                   'bzrlib.tests.test_ancestry',
 
3277
                   'bzrlib.tests.test_annotate',
 
3278
                   'bzrlib.tests.test_api',
 
3279
                   'bzrlib.tests.test_atomicfile',
 
3280
                   'bzrlib.tests.test_bad_files',
 
3281
                   'bzrlib.tests.test_bisect_multi',
 
3282
                   'bzrlib.tests.test_branch',
 
3283
                   'bzrlib.tests.test_branchbuilder',
 
3284
                   'bzrlib.tests.test_btree_index',
 
3285
                   'bzrlib.tests.test_bugtracker',
 
3286
                   'bzrlib.tests.test_bundle',
 
3287
                   'bzrlib.tests.test_bzrdir',
 
3288
                   'bzrlib.tests.test_cache_utf8',
 
3289
                   'bzrlib.tests.test_clean_tree',
 
3290
                   'bzrlib.tests.test_chunk_writer',
 
3291
                   'bzrlib.tests.test__chunks_to_lines',
 
3292
                   'bzrlib.tests.test_commands',
 
3293
                   'bzrlib.tests.test_commit',
 
3294
                   'bzrlib.tests.test_commit_merge',
 
3295
                   'bzrlib.tests.test_config',
 
3296
                   'bzrlib.tests.test_conflicts',
 
3297
                   'bzrlib.tests.test_counted_lock',
 
3298
                   'bzrlib.tests.test_decorators',
 
3299
                   'bzrlib.tests.test_delta',
 
3300
                   'bzrlib.tests.test_debug',
 
3301
                   'bzrlib.tests.test_deprecated_graph',
 
3302
                   'bzrlib.tests.test_diff',
 
3303
                   'bzrlib.tests.test_directory_service',
 
3304
                   'bzrlib.tests.test_dirstate',
 
3305
                   'bzrlib.tests.test_email_message',
 
3306
                   'bzrlib.tests.test_eol_filters',
 
3307
                   'bzrlib.tests.test_errors',
 
3308
                   'bzrlib.tests.test_export',
 
3309
                   'bzrlib.tests.test_extract',
 
3310
                   'bzrlib.tests.test_fetch',
 
3311
                   'bzrlib.tests.test_fifo_cache',
 
3312
                   'bzrlib.tests.test_filters',
 
3313
                   'bzrlib.tests.test_ftp_transport',
 
3314
                   'bzrlib.tests.test_foreign',
 
3315
                   'bzrlib.tests.test_generate_docs',
 
3316
                   'bzrlib.tests.test_generate_ids',
 
3317
                   'bzrlib.tests.test_globbing',
 
3318
                   'bzrlib.tests.test_gpg',
 
3319
                   'bzrlib.tests.test_graph',
 
3320
                   'bzrlib.tests.test_hashcache',
 
3321
                   'bzrlib.tests.test_help',
 
3322
                   'bzrlib.tests.test_hooks',
 
3323
                   'bzrlib.tests.test_http',
 
3324
                   'bzrlib.tests.test_http_implementations',
 
3325
                   'bzrlib.tests.test_http_response',
 
3326
                   'bzrlib.tests.test_https_ca_bundle',
 
3327
                   'bzrlib.tests.test_identitymap',
 
3328
                   'bzrlib.tests.test_ignores',
 
3329
                   'bzrlib.tests.test_index',
 
3330
                   'bzrlib.tests.test_info',
 
3331
                   'bzrlib.tests.test_inv',
 
3332
                   'bzrlib.tests.test_inventory_delta',
 
3333
                   'bzrlib.tests.test_knit',
 
3334
                   'bzrlib.tests.test_lazy_import',
 
3335
                   'bzrlib.tests.test_lazy_regex',
 
3336
                   'bzrlib.tests.test_lockable_files',
 
3337
                   'bzrlib.tests.test_lockdir',
 
3338
                   'bzrlib.tests.test_log',
 
3339
                   'bzrlib.tests.test_lru_cache',
 
3340
                   'bzrlib.tests.test_lsprof',
 
3341
                   'bzrlib.tests.test_mail_client',
 
3342
                   'bzrlib.tests.test_memorytree',
 
3343
                   'bzrlib.tests.test_merge',
 
3344
                   'bzrlib.tests.test_merge3',
 
3345
                   'bzrlib.tests.test_merge_core',
 
3346
                   'bzrlib.tests.test_merge_directive',
 
3347
                   'bzrlib.tests.test_missing',
 
3348
                   'bzrlib.tests.test_msgeditor',
 
3349
                   'bzrlib.tests.test_multiparent',
 
3350
                   'bzrlib.tests.test_mutabletree',
 
3351
                   'bzrlib.tests.test_nonascii',
 
3352
                   'bzrlib.tests.test_options',
 
3353
                   'bzrlib.tests.test_osutils',
 
3354
                   'bzrlib.tests.test_osutils_encodings',
 
3355
                   'bzrlib.tests.test_pack',
 
3356
                   'bzrlib.tests.test_pack_repository',
 
3357
                   'bzrlib.tests.test_patch',
 
3358
                   'bzrlib.tests.test_patches',
 
3359
                   'bzrlib.tests.test_permissions',
 
3360
                   'bzrlib.tests.test_plugins',
 
3361
                   'bzrlib.tests.test_progress',
 
3362
                   'bzrlib.tests.test_read_bundle',
 
3363
                   'bzrlib.tests.test_reconcile',
 
3364
                   'bzrlib.tests.test_reconfigure',
 
3365
                   'bzrlib.tests.test_registry',
 
3366
                   'bzrlib.tests.test_remote',
 
3367
                   'bzrlib.tests.test_rename_map',
 
3368
                   'bzrlib.tests.test_repository',
 
3369
                   'bzrlib.tests.test_revert',
 
3370
                   'bzrlib.tests.test_revision',
 
3371
                   'bzrlib.tests.test_revisionspec',
 
3372
                   'bzrlib.tests.test_revisiontree',
 
3373
                   'bzrlib.tests.test_rio',
 
3374
                   'bzrlib.tests.test_rules',
 
3375
                   'bzrlib.tests.test_sampler',
 
3376
                   'bzrlib.tests.test_selftest',
 
3377
                   'bzrlib.tests.test_setup',
 
3378
                   'bzrlib.tests.test_sftp_transport',
 
3379
                   'bzrlib.tests.test_shelf',
 
3380
                   'bzrlib.tests.test_shelf_ui',
 
3381
                   'bzrlib.tests.test_smart',
 
3382
                   'bzrlib.tests.test_smart_add',
 
3383
                   'bzrlib.tests.test_smart_request',
 
3384
                   'bzrlib.tests.test_smart_transport',
 
3385
                   'bzrlib.tests.test_smtp_connection',
 
3386
                   'bzrlib.tests.test_source',
 
3387
                   'bzrlib.tests.test_ssh_transport',
 
3388
                   'bzrlib.tests.test_status',
 
3389
                   'bzrlib.tests.test_store',
 
3390
                   'bzrlib.tests.test_strace',
 
3391
                   'bzrlib.tests.test_subsume',
 
3392
                   'bzrlib.tests.test_switch',
 
3393
                   'bzrlib.tests.test_symbol_versioning',
 
3394
                   'bzrlib.tests.test_tag',
 
3395
                   'bzrlib.tests.test_testament',
 
3396
                   'bzrlib.tests.test_textfile',
 
3397
                   'bzrlib.tests.test_textmerge',
 
3398
                   'bzrlib.tests.test_timestamp',
 
3399
                   'bzrlib.tests.test_trace',
 
3400
                   'bzrlib.tests.test_transactions',
 
3401
                   'bzrlib.tests.test_transform',
 
3402
                   'bzrlib.tests.test_transport',
 
3403
                   'bzrlib.tests.test_transport_implementations',
 
3404
                   'bzrlib.tests.test_transport_log',
 
3405
                   'bzrlib.tests.test_tree',
 
3406
                   'bzrlib.tests.test_treebuilder',
 
3407
                   'bzrlib.tests.test_tsort',
 
3408
                   'bzrlib.tests.test_tuned_gzip',
 
3409
                   'bzrlib.tests.test_ui',
 
3410
                   'bzrlib.tests.test_uncommit',
 
3411
                   'bzrlib.tests.test_upgrade',
 
3412
                   'bzrlib.tests.test_upgrade_stacked',
 
3413
                   'bzrlib.tests.test_urlutils',
 
3414
                   'bzrlib.tests.test_version',
 
3415
                   'bzrlib.tests.test_version_info',
 
3416
                   'bzrlib.tests.test_versionedfile',
 
3417
                   'bzrlib.tests.test_weave',
 
3418
                   'bzrlib.tests.test_whitebox',
 
3419
                   'bzrlib.tests.test_win32utils',
 
3420
                   'bzrlib.tests.test_workingtree',
 
3421
                   'bzrlib.tests.test_workingtree_4',
 
3422
                   'bzrlib.tests.test_wsgi',
 
3423
                   'bzrlib.tests.test_xml',
 
3424
                   'bzrlib.tests.tree_implementations',
 
3425
                   'bzrlib.tests.workingtree_implementations',
 
3426
                   'bzrlib.util.tests.test_bencode',
 
3427
                   ]
3855
3428
 
3856
3429
    loader = TestUtil.TestLoader()
3857
3430
 
3858
 
    if keep_only is not None:
3859
 
        id_filter = TestIdList(keep_only)
3860
3431
    if starting_with:
 
3432
        starting_with = [test_prefix_alias_registry.resolve_alias(start)
 
3433
                         for start in starting_with]
3861
3434
        # We take precedence over keep_only because *at loading time* using
3862
3435
        # both options means we will load less tests for the same final result.
3863
3436
        def interesting_module(name):
3873
3446
        loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3874
3447
 
3875
3448
    elif keep_only is not None:
 
3449
        id_filter = TestIdList(keep_only)
3876
3450
        loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3877
3451
        def interesting_module(name):
3878
3452
            return id_filter.refers_to(name)
3886
3460
    suite = loader.suiteClass()
3887
3461
 
3888
3462
    # 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():
 
3463
    suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
 
3464
 
 
3465
    modules_to_doctest = [
 
3466
        'bzrlib',
 
3467
        'bzrlib.branchbuilder',
 
3468
        'bzrlib.export',
 
3469
        'bzrlib.inventory',
 
3470
        'bzrlib.iterablefile',
 
3471
        'bzrlib.lockdir',
 
3472
        'bzrlib.merge3',
 
3473
        'bzrlib.option',
 
3474
        'bzrlib.symbol_versioning',
 
3475
        'bzrlib.tests',
 
3476
        'bzrlib.timestamp',
 
3477
        'bzrlib.version_info_formats.format_custom',
 
3478
        ]
 
3479
 
 
3480
    for mod in modules_to_doctest:
3892
3481
        if not interesting_module(mod):
3893
3482
            # No tests to keep here, move along
3894
3483
            continue
3923
3512
            reload(sys)
3924
3513
            sys.setdefaultencoding(default_encoding)
3925
3514
 
 
3515
    if starting_with:
 
3516
        suite = filter_suite_by_id_startswith(suite, starting_with)
 
3517
 
3926
3518
    if keep_only is not None:
3927
3519
        # Now that the referred modules have loaded their tests, keep only the
3928
3520
        # requested ones.
4035
3627
    :param new_id: The id to assign to it.
4036
3628
    :return: The new test.
4037
3629
    """
4038
 
    new_test = copy(test)
 
3630
    from copy import deepcopy
 
3631
    new_test = deepcopy(test)
4039
3632
    new_test.id = lambda: new_id
4040
3633
    return new_test
4041
3634
 
4042
3635
 
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):
 
3636
def _rmtree_temp_dir(dirname):
4085
3637
    # If LANG=C we probably have created some bogus paths
4086
3638
    # which rmtree(unicode) will fail to delete
4087
3639
    # so make sure we are using rmtree(str) to delete everything
4096
3648
    try:
4097
3649
        osutils.rmtree(dirname)
4098
3650
    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))
 
3651
        if sys.platform == 'win32' and e.errno == errno.EACCES:
 
3652
            sys.stderr.write(('Permission denied: '
 
3653
                                 'unable to remove testing dir '
 
3654
                                 '%s\n' % os.path.basename(dirname)))
 
3655
        else:
 
3656
            raise
4107
3657
 
4108
3658
 
4109
3659
class Feature(object):
4191
3741
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4192
3742
 
4193
3743
 
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
3744
def probe_unicode_in_user_encoding():
4269
3745
    """Try to encode several unicode strings to use in unicode-aware tests.
4270
3746
    Return first successfull match.
4350
3826
UTF8Filesystem = _UTF8Filesystem()
4351
3827
 
4352
3828
 
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
3829
class _CaseInsCasePresFilenameFeature(Feature):
4378
3830
    """Is the file-system case insensitive, but case-preserving?"""
4379
3831
 
4429
3881
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4430
3882
 
4431
3883
 
4432
 
class _CaseSensitiveFilesystemFeature(Feature):
 
3884
class _SubUnitFeature(Feature):
 
3885
    """Check if subunit is available."""
4433
3886
 
4434
3887
    def _probe(self):
4435
 
        if CaseInsCasePresFilenameFeature.available():
4436
 
            return False
4437
 
        elif CaseInsensitiveFilesystemFeature.available():
4438
 
            return False
4439
 
        else:
 
3888
        try:
 
3889
            import subunit
4440
3890
            return True
 
3891
        except ImportError:
 
3892
            return False
4441
3893
 
4442
3894
    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')
 
3895
        return 'subunit'
 
3896
 
 
3897
SubUnitFeature = _SubUnitFeature()
4453
3898
# Only define SubUnitBzrRunner if subunit is available.
4454
3899
try:
4455
3900
    from subunit import TestProtocolClient
4456
 
    from subunit.test_results import AutoTimingTestResultDecorator
4457
3901
    class SubUnitBzrRunner(TextTestRunner):
4458
3902
        def run(self, test):
4459
 
            result = AutoTimingTestResultDecorator(
4460
 
                TestProtocolClient(self.stream))
 
3903
            # undo out claim for testing which looks like a test start to subunit
 
3904
            self.stream.write("success: %s\n" % (osutils.realpath(sys.argv[0]),))
 
3905
            result = TestProtocolClient(self.stream)
4461
3906
            test.run(result)
4462
3907
            return result
4463
3908
except ImportError:
4464
3909
    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()