/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Martin Pool
  • Date: 2008-02-13 03:25:53 UTC
  • mto: This revision was merged to the branch mainline in revision 3223.
  • Revision ID: mbp@sourcefrog.net-20080213032553-3b7vz132w0mje0gd
Open 1.3 development

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
36
34
import errno
37
35
import logging
38
 
import math
39
36
import os
40
37
from pprint import pformat
41
38
import random
42
39
import re
43
40
import shlex
44
41
import stat
45
 
from subprocess import Popen, PIPE, STDOUT
 
42
from subprocess import Popen, PIPE
46
43
import sys
47
44
import tempfile
48
 
import threading
49
45
import time
50
 
import traceback
51
46
import unittest
52
47
import warnings
53
48
 
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
49
 
62
50
from bzrlib import (
63
 
    branchbuilder,
64
51
    bzrdir,
65
 
    chk_map,
66
 
    config,
67
52
    debug,
68
53
    errors,
69
 
    hooks,
70
 
    lock as _mod_lock,
71
54
    memorytree,
72
55
    osutils,
73
56
    progress,
74
57
    ui,
75
58
    urlutils,
76
 
    registry,
77
59
    workingtree,
78
60
    )
79
61
import bzrlib.branch
91
73
from bzrlib.merge import merge_inner
92
74
import bzrlib.merge3
93
75
import bzrlib.plugin
94
 
from bzrlib.smart import client, request, server
 
76
from bzrlib.revision import common_ancestor
95
77
import bzrlib.store
96
78
from bzrlib import symbol_versioning
97
79
from bzrlib.symbol_versioning import (
98
80
    DEPRECATED_PARAMETER,
99
81
    deprecated_function,
100
 
    deprecated_in,
101
82
    deprecated_method,
102
83
    deprecated_passed,
 
84
    zero_ninetyone,
 
85
    zero_ninetytwo,
 
86
    one_zero,
103
87
    )
104
88
import bzrlib.trace
105
 
from bzrlib.transport import (
106
 
    get_transport,
107
 
    memory,
108
 
    pathfilter,
109
 
    )
 
89
from bzrlib.transport import get_transport
110
90
import bzrlib.transport
 
91
from bzrlib.transport.local import LocalURLServer
 
92
from bzrlib.transport.memory import MemoryServer
 
93
from bzrlib.transport.readonly import ReadonlyServer
111
94
from bzrlib.trace import mutter, note
112
 
from bzrlib.tests import (
113
 
    test_server,
114
 
    TestUtil,
115
 
    )
 
95
from bzrlib.tests import TestUtil
116
96
from bzrlib.tests.http_server import HttpServer
117
97
from bzrlib.tests.TestUtil import (
118
98
                          TestSuite,
119
99
                          TestLoader,
120
100
                          )
121
101
from bzrlib.tests.treeshape import build_tree_contents
122
 
from bzrlib.ui import NullProgressView
123
 
from bzrlib.ui.text import TextUIFactory
124
102
import bzrlib.version_info_formats.format_custom
125
103
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
126
104
 
129
107
# shown frame is the test code, not our assertXYZ.
130
108
__unittest = 1
131
109
 
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
 
110
default_transport = LocalURLServer
 
111
 
 
112
MODULES_TO_TEST = []
 
113
MODULES_TO_DOCTEST = [
 
114
        bzrlib.timestamp,
 
115
        bzrlib.errors,
 
116
        bzrlib.export,
 
117
        bzrlib.inventory,
 
118
        bzrlib.iterablefile,
 
119
        bzrlib.lockdir,
 
120
        bzrlib.merge3,
 
121
        bzrlib.option,
 
122
        bzrlib.store,
 
123
        bzrlib.version_info_formats.format_custom,
 
124
        # quoted to avoid module-loading circularity
 
125
        'bzrlib.tests',
 
126
        ]
 
127
 
 
128
 
 
129
def packages_to_test():
 
130
    """Return a list of packages to test.
 
131
 
 
132
    The packages are not globally imported so that import failures are
 
133
    triggered when running selftest, not when importing the command.
 
134
    """
 
135
    import bzrlib.doc
 
136
    import bzrlib.tests.blackbox
 
137
    import bzrlib.tests.branch_implementations
 
138
    import bzrlib.tests.bzrdir_implementations
 
139
    import bzrlib.tests.commands
 
140
    import bzrlib.tests.interrepository_implementations
 
141
    import bzrlib.tests.interversionedfile_implementations
 
142
    import bzrlib.tests.intertree_implementations
 
143
    import bzrlib.tests.inventory_implementations
 
144
    import bzrlib.tests.per_lock
 
145
    import bzrlib.tests.repository_implementations
 
146
    import bzrlib.tests.revisionstore_implementations
 
147
    import bzrlib.tests.tree_implementations
 
148
    import bzrlib.tests.workingtree_implementations
 
149
    return [
 
150
            bzrlib.doc,
 
151
            bzrlib.tests.blackbox,
 
152
            bzrlib.tests.branch_implementations,
 
153
            bzrlib.tests.bzrdir_implementations,
 
154
            bzrlib.tests.commands,
 
155
            bzrlib.tests.interrepository_implementations,
 
156
            bzrlib.tests.interversionedfile_implementations,
 
157
            bzrlib.tests.intertree_implementations,
 
158
            bzrlib.tests.inventory_implementations,
 
159
            bzrlib.tests.per_lock,
 
160
            bzrlib.tests.repository_implementations,
 
161
            bzrlib.tests.revisionstore_implementations,
 
162
            bzrlib.tests.tree_implementations,
 
163
            bzrlib.tests.workingtree_implementations,
 
164
            ]
142
165
 
143
166
 
144
167
class ExtendedTestResult(unittest._TextTestResult):
158
181
    """
159
182
 
160
183
    stop_early = False
161
 
 
 
184
    
162
185
    def __init__(self, stream, descriptions, verbosity,
163
186
                 bench_history=None,
164
 
                 strict=False,
 
187
                 num_tests=None,
165
188
                 ):
166
189
        """Construct new TestResult.
167
190
 
185
208
            bench_history.write("--date %s %s\n" % (time.time(), revision_id))
186
209
        self._bench_history = bench_history
187
210
        self.ui = ui.ui_factory
188
 
        self.num_tests = 0
 
211
        self.num_tests = num_tests
189
212
        self.error_count = 0
190
213
        self.failure_count = 0
191
214
        self.known_failure_count = 0
194
217
        self.unsupported = {}
195
218
        self.count = 0
196
219
        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):
 
220
    
 
221
    def _extractBenchmarkTime(self, testCase):
254
222
        """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
223
        return getattr(testCase, "_benchtime", None)
258
 
 
 
224
    
259
225
    def _elapsedTestTimeString(self):
260
226
        """Return a time string for the overall time the current test has taken."""
261
227
        return self._formatTime(time.time() - self._start_time)
263
229
    def _testTimeString(self, testCase):
264
230
        benchmark_time = self._extractBenchmarkTime(testCase)
265
231
        if benchmark_time is not None:
266
 
            return self._formatTime(benchmark_time) + "*"
 
232
            return "%s/%s" % (
 
233
                self._formatTime(benchmark_time),
 
234
                self._elapsedTestTimeString())
267
235
        else:
268
 
            return self._elapsedTestTimeString()
 
236
            return "           %s" % self._elapsedTestTimeString()
269
237
 
270
238
    def _formatTime(self, seconds):
271
239
        """Format seconds as milliseconds with leading spaces."""
280
248
 
281
249
    def startTest(self, test):
282
250
        unittest.TestResult.startTest(self, test)
283
 
        if self.count == 0:
284
 
            self.startTests()
285
251
        self.report_test_start(test)
286
252
        test.number = self.count
287
253
        self._recordTestStartTime()
288
254
 
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
255
    def _recordTestStartTime(self):
309
256
        """Record that a test has started."""
310
257
        self._start_time = time.time()
322
269
        Called from the TestCase run() method when the test
323
270
        fails with an unexpected error.
324
271
        """
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)
 
272
        self._testConcluded(test)
 
273
        if isinstance(err[1], TestSkipped):
 
274
            return self._addSkipped(test, err)
 
275
        elif isinstance(err[1], UnavailableFeature):
 
276
            return self.addNotSupported(test, err[1].args[0])
 
277
        else:
 
278
            self._cleanupLogFile(test)
 
279
            unittest.TestResult.addError(self, test, err)
 
280
            self.error_count += 1
 
281
            self.report_error(test, err)
 
282
            if self.stop_early:
 
283
                self.stop()
332
284
 
333
285
    def addFailure(self, test, err):
334
286
        """Tell result that test failed.
336
288
        Called from the TestCase run() method when the test
337
289
        fails because e.g. an assert() method failed.
338
290
        """
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)
 
291
        self._testConcluded(test)
 
292
        if isinstance(err[1], KnownFailure):
 
293
            return self._addKnownFailure(test, err)
 
294
        else:
 
295
            self._cleanupLogFile(test)
 
296
            unittest.TestResult.addFailure(self, test, err)
 
297
            self.failure_count += 1
 
298
            self.report_failure(test, err)
 
299
            if self.stop_early:
 
300
                self.stop()
346
301
 
347
 
    def addSuccess(self, test, details=None):
 
302
    def addSuccess(self, test):
348
303
        """Tell result that test completed successfully.
349
304
 
350
305
        Called from the TestCase run()
351
306
        """
 
307
        self._testConcluded(test)
352
308
        if self._bench_history is not None:
353
 
            benchmark_time = self._extractBenchmarkTime(test, details)
 
309
            benchmark_time = self._extractBenchmarkTime(test)
354
310
            if benchmark_time is not None:
355
311
                self._bench_history.write("%s %s\n" % (
356
312
                    self._formatTime(benchmark_time),
358
314
        self.report_success(test)
359
315
        self._cleanupLogFile(test)
360
316
        unittest.TestResult.addSuccess(self, test)
361
 
        test._log_contents = ''
362
 
 
363
 
    def addExpectedFailure(self, test, err):
 
317
 
 
318
    def _testConcluded(self, test):
 
319
        """Common code when a test has finished.
 
320
 
 
321
        Called regardless of whether it succeded, failed, etc.
 
322
        """
 
323
        pass
 
324
 
 
325
    def _addKnownFailure(self, test, err):
364
326
        self.known_failure_count += 1
365
327
        self.report_known_failure(test, err)
366
328
 
368
330
        """The test will not be run because of a missing feature.
369
331
        """
370
332
        # this can be called in two different ways: it may be that the
371
 
        # test started running, and then raised (through requireFeature)
 
333
        # test started running, and then raised (through addError) 
372
334
        # 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.
 
335
        # while probing for features before running the tests; in that
 
336
        # case we will see startTest and stopTest, but the test will never
 
337
        # actually run.
376
338
        self.unsupported.setdefault(str(feature), 0)
377
339
        self.unsupported[str(feature)] += 1
378
340
        self.report_unsupported(test, feature)
379
341
 
380
 
    def addSkip(self, test, reason):
381
 
        """A test has not run for 'reason'."""
382
 
        self.skip_count += 1
383
 
        self.report_skip(test, reason)
384
 
 
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
400
 
        else:
401
 
            raise errors.BzrError("Unknown whence %r" % whence)
 
342
    def _addSkipped(self, test, skip_excinfo):
 
343
        if isinstance(skip_excinfo[1], TestNotApplicable):
 
344
            self.not_applicable_count += 1
 
345
            self.report_not_applicable(test, skip_excinfo)
 
346
        else:
 
347
            self.skip_count += 1
 
348
            self.report_skip(test, skip_excinfo)
 
349
        try:
 
350
            test.tearDown()
 
351
        except KeyboardInterrupt:
 
352
            raise
 
353
        except:
 
354
            self.addError(test, test._exc_info())
 
355
        else:
 
356
            # seems best to treat this as success from point-of-view of unittest
 
357
            # -- it actually does nothing so it barely matters :)
 
358
            unittest.TestResult.addSuccess(self, test)
 
359
 
 
360
    def printErrorList(self, flavour, errors):
 
361
        for test, err in errors:
 
362
            self.stream.writeln(self.separator1)
 
363
            self.stream.write("%s: " % flavour)
 
364
            self.stream.writeln(self.getDescription(test))
 
365
            if getattr(test, '_get_log', None) is not None:
 
366
                self.stream.write('\n')
 
367
                self.stream.write(
 
368
                        ('vvvv[log from %s]' % test.id()).ljust(78,'-'))
 
369
                self.stream.write('\n')
 
370
                self.stream.write(test._get_log())
 
371
                self.stream.write('\n')
 
372
                self.stream.write(
 
373
                        ('^^^^[log from %s]' % test.id()).ljust(78,'-'))
 
374
                self.stream.write('\n')
 
375
            self.stream.writeln(self.separator2)
 
376
            self.stream.writeln("%s" % err)
 
377
 
 
378
    def finished(self):
 
379
        pass
402
380
 
403
381
    def report_cleaning_up(self):
404
382
        pass
405
383
 
406
 
    def startTestRun(self):
407
 
        self.startTime = time.time()
408
 
 
409
384
    def report_success(self, test):
410
385
        pass
411
386
 
420
395
 
421
396
    def __init__(self, stream, descriptions, verbosity,
422
397
                 bench_history=None,
 
398
                 num_tests=None,
423
399
                 pb=None,
424
 
                 strict=None,
425
400
                 ):
426
401
        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()
 
402
            bench_history, num_tests)
 
403
        if pb is None:
 
404
            self.pb = self.ui.nested_progress_bar()
 
405
            self._supplied_pb = False
 
406
        else:
 
407
            self.pb = pb
 
408
            self._supplied_pb = True
433
409
        self.pb.show_pct = False
434
410
        self.pb.show_spinner = False
435
411
        self.pb.show_eta = False,
436
412
        self.pb.show_count = False
437
413
        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()
449
 
        self.pb.update('[test 0/%d] Starting' % (self.num_tests))
450
 
 
451
 
    def printErrors(self):
452
 
        # clear the pb to make room for the error listing
453
 
        self.pb.clear()
454
 
        super(TextTestResult, self).printErrors()
 
414
 
 
415
    def report_starting(self):
 
416
        self.pb.update('[test 0/%d] starting...' % (self.num_tests))
455
417
 
456
418
    def _progress_prefix_text(self):
457
 
        # the longer this text, the less space we have to show the test
458
 
        # name...
459
 
        a = '[%d' % self.count              # total that have been run
460
 
        # tests skipped as known not to be relevant are not important enough
461
 
        # to show here
462
 
        ## if self.skip_count:
463
 
        ##     a += ', %d skip' % self.skip_count
464
 
        ## if self.known_failure_count:
465
 
        ##     a += '+%dX' % self.known_failure_count
466
 
        if self.num_tests:
 
419
        a = '[%d' % self.count
 
420
        if self.num_tests is not None:
467
421
            a +='/%d' % self.num_tests
468
 
        a += ' in '
469
 
        runtime = time.time() - self._overall_start_time
470
 
        if runtime >= 60:
471
 
            a += '%dm%ds' % (runtime / 60, runtime % 60)
472
 
        else:
473
 
            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)
 
422
        a += ' in %ds' % (time.time() - self._overall_start_time)
 
423
        if self.error_count:
 
424
            a += ', %d errors' % self.error_count
 
425
        if self.failure_count:
 
426
            a += ', %d failed' % self.failure_count
 
427
        if self.known_failure_count:
 
428
            a += ', %d known failures' % self.known_failure_count
 
429
        if self.skip_count:
 
430
            a += ', %d skipped' % self.skip_count
 
431
        if self.unsupported:
 
432
            a += ', %d missing features' % len(self.unsupported)
479
433
        a += ']'
480
434
        return a
481
435
 
483
437
        self.count += 1
484
438
        self.pb.update(
485
439
                self._progress_prefix_text()
486
 
                + ' '
 
440
                + ' ' 
487
441
                + self._shortened_test_description(test))
488
442
 
489
443
    def _test_description(self, test):
490
444
        return self._shortened_test_description(test)
491
445
 
492
446
    def report_error(self, test, err):
493
 
        self.stream.write('ERROR: %s\n    %s\n' % (
 
447
        self.pb.note('ERROR: %s\n    %s\n', 
494
448
            self._test_description(test),
495
449
            err[1],
496
 
            ))
 
450
            )
497
451
 
498
452
    def report_failure(self, test, err):
499
 
        self.stream.write('FAIL: %s\n    %s\n' % (
 
453
        self.pb.note('FAIL: %s\n    %s\n', 
500
454
            self._test_description(test),
501
455
            err[1],
502
 
            ))
 
456
            )
503
457
 
504
458
    def report_known_failure(self, test, err):
505
 
        pass
506
 
 
507
 
    def report_skip(self, test, reason):
508
 
        pass
509
 
 
510
 
    def report_not_applicable(self, test, reason):
 
459
        self.pb.note('XFAIL: %s\n%s\n',
 
460
            self._test_description(test), err[1])
 
461
 
 
462
    def report_skip(self, test, skip_excinfo):
 
463
        pass
 
464
 
 
465
    def report_not_applicable(self, test, skip_excinfo):
511
466
        pass
512
467
 
513
468
    def report_unsupported(self, test, feature):
514
469
        """test cannot be run because feature is missing."""
515
 
 
 
470
                  
516
471
    def report_cleaning_up(self):
517
 
        self.pb.update('Cleaning up')
 
472
        self.pb.update('cleaning up...')
 
473
 
 
474
    def finished(self):
 
475
        if not self._supplied_pb:
 
476
            self.pb.finished()
518
477
 
519
478
 
520
479
class VerboseTestResult(ExtendedTestResult):
528
487
            result = a_string
529
488
        return result.ljust(final_width)
530
489
 
531
 
    def startTestRun(self):
532
 
        super(VerboseTestResult, self).startTestRun()
 
490
    def report_starting(self):
533
491
        self.stream.write('running %d tests...\n' % self.num_tests)
534
492
 
535
493
    def report_test_start(self, test):
536
494
        self.count += 1
537
495
        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)
 
496
        # width needs space for 6 char status, plus 1 for slash, plus 2 10-char
 
497
        # numbers, plus a trailing blank
 
498
        # when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
 
499
        self.stream.write(self._ellipsize_to_right(name,
 
500
                          osutils.terminal_width()-30))
547
501
        self.stream.flush()
548
502
 
549
503
    def _error_summary(self, err):
574
528
        # used to show the output in PQM.
575
529
        self.stream.flush()
576
530
 
577
 
    def report_skip(self, test, reason):
 
531
    def report_skip(self, test, skip_excinfo):
578
532
        self.stream.writeln(' SKIP %s\n%s'
579
 
                % (self._testTimeString(test), reason))
 
533
                % (self._testTimeString(test),
 
534
                   self._error_summary(skip_excinfo)))
580
535
 
581
 
    def report_not_applicable(self, test, reason):
582
 
        self.stream.writeln('  N/A %s\n    %s'
583
 
                % (self._testTimeString(test), reason))
 
536
    def report_not_applicable(self, test, skip_excinfo):
 
537
        self.stream.writeln('  N/A %s\n%s'
 
538
                % (self._testTimeString(test),
 
539
                   self._error_summary(skip_excinfo)))
584
540
 
585
541
    def report_unsupported(self, test, feature):
586
542
        """test cannot be run because feature is missing."""
596
552
                 descriptions=0,
597
553
                 verbosity=1,
598
554
                 bench_history=None,
599
 
                 strict=False,
600
 
                 result_decorators=None,
 
555
                 list_only=False
601
556
                 ):
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
557
        self.stream = unittest._WritelnDecorator(stream)
623
558
        self.descriptions = descriptions
624
559
        self.verbosity = verbosity
625
560
        self._bench_history = bench_history
626
 
        self._strict = strict
627
 
        self._result_decorators = result_decorators or []
 
561
        self.list_only = list_only
628
562
 
629
563
    def run(self, test):
630
564
        "Run the given test case or test suite."
 
565
        startTime = time.time()
631
566
        if self.verbosity == 1:
632
567
            result_class = TextTestResult
633
568
        elif self.verbosity >= 2:
634
569
            result_class = VerboseTestResult
635
 
        original_result = result_class(self.stream,
 
570
        result = result_class(self.stream,
636
571
                              self.descriptions,
637
572
                              self.verbosity,
638
573
                              bench_history=self._bench_history,
639
 
                              strict=self._strict,
 
574
                              num_tests=test.countTestCases(),
640
575
                              )
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:
 
576
        result.stop_early = self.stop_on_failure
 
577
        result.report_starting()
 
578
        if self.list_only:
 
579
            if self.verbosity >= 2:
 
580
                self.stream.writeln("Listing tests only ...\n")
 
581
            run = 0
 
582
            for t in iter_suite_tests(test):
 
583
                self.stream.writeln("%s" % (t.id()))
 
584
                run += 1
 
585
            actionTaken = "Listed"
 
586
        else: 
649
587
            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
 
588
            run = result.testsRun
 
589
            actionTaken = "Ran"
 
590
        stopTime = time.time()
 
591
        timeTaken = stopTime - startTime
 
592
        result.printErrors()
 
593
        self.stream.writeln(result.separator2)
 
594
        self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
 
595
                            run, run != 1 and "s" or "", timeTaken))
 
596
        self.stream.writeln()
 
597
        if not result.wasSuccessful():
 
598
            self.stream.write("FAILED (")
 
599
            failed, errored = map(len, (result.failures, result.errors))
 
600
            if failed:
 
601
                self.stream.write("failures=%d" % failed)
 
602
            if errored:
 
603
                if failed: self.stream.write(", ")
 
604
                self.stream.write("errors=%d" % errored)
 
605
            if result.known_failure_count:
 
606
                if failed or errored: self.stream.write(", ")
 
607
                self.stream.write("known_failure_count=%d" %
 
608
                    result.known_failure_count)
 
609
            self.stream.writeln(")")
 
610
        else:
 
611
            if result.known_failure_count:
 
612
                self.stream.writeln("OK (known_failures=%d)" %
 
613
                    result.known_failure_count)
 
614
            else:
 
615
                self.stream.writeln("OK")
 
616
        if result.skip_count > 0:
 
617
            skipped = result.skip_count
 
618
            self.stream.writeln('%d test%s skipped' %
 
619
                                (skipped, skipped != 1 and "s" or ""))
 
620
        if result.unsupported:
 
621
            for feature, count in sorted(result.unsupported.items()):
 
622
                self.stream.writeln("Missing feature '%s' skipped %d tests." %
 
623
                    (feature, count))
 
624
        result.finished()
 
625
        return result
655
626
 
656
627
 
657
628
def iter_suite_tests(suite):
658
629
    """Return all tests in a suite, recursing through nested suites"""
659
 
    if isinstance(suite, unittest.TestCase):
660
 
        yield suite
661
 
    elif isinstance(suite, unittest.TestSuite):
662
 
        for item in suite:
 
630
    for item in suite._tests:
 
631
        if isinstance(item, unittest.TestCase):
 
632
            yield item
 
633
        elif isinstance(item, unittest.TestSuite):
663
634
            for r in iter_suite_tests(item):
664
635
                yield r
665
 
    else:
666
 
        raise Exception('unknown type %r for object %r'
667
 
                        % (type(suite), suite))
668
 
 
669
 
 
670
 
TestSkipped = testtools.testcase.TestSkipped
 
636
        else:
 
637
            raise Exception('unknown object %r inside test suite %r'
 
638
                            % (item, suite))
 
639
 
 
640
 
 
641
class TestSkipped(Exception):
 
642
    """Indicates that a test was intentionally skipped, rather than failing."""
671
643
 
672
644
 
673
645
class TestNotApplicable(TestSkipped):
674
646
    """A test is not applicable to the situation where it was run.
675
647
 
676
 
    This is only normally raised by parameterized tests, if they find that
677
 
    the instance they're constructed upon does not support one aspect
 
648
    This is only normally raised by parameterized tests, if they find that 
 
649
    the instance they're constructed upon does not support one aspect 
678
650
    of its interface.
679
651
    """
680
652
 
681
653
 
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
 
654
class KnownFailure(AssertionError):
 
655
    """Indicates that a test failed in a precisely expected manner.
 
656
 
 
657
    Such failures dont block the whole test suite from passing because they are
 
658
    indicators of partially completed code or of future work. We have an
 
659
    explicit error for them so that we can ensure that they are always visible:
 
660
    KnownFailures are always shown in the output of bzr selftest.
 
661
    """
699
662
 
700
663
 
701
664
class UnavailableFeature(Exception):
702
665
    """A feature required for this test was not available.
703
666
 
704
 
    This can be considered a specialised form of SkippedTest.
705
 
 
706
667
    The feature should be used to construct the exception.
707
668
    """
708
669
 
709
670
 
 
671
class CommandFailed(Exception):
 
672
    pass
 
673
 
 
674
 
710
675
class StringIOWrapper(object):
711
676
    """A wrapper around cStringIO which just adds an encoding attribute.
712
 
 
 
677
    
713
678
    Internally we can check sys.stdout to see what the output encoding
714
679
    should be. However, cStringIO has no encoding attribute that we can
715
680
    set. So we wrap it instead.
733
698
            return setattr(self._cstring, name, val)
734
699
 
735
700
 
736
 
class TestUIFactory(TextUIFactory):
 
701
class TestUIFactory(ui.CLIUIFactory):
737
702
    """A UI Factory for testing.
738
703
 
739
704
    Hide the progress bar but emit note()s.
740
705
    Redirect stdin.
741
706
    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
707
    """
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
708
 
754
 
    def __init__(self, stdout=None, stderr=None, stdin=None):
 
709
    def __init__(self,
 
710
                 stdout=None,
 
711
                 stderr=None,
 
712
                 stdin=None):
 
713
        super(TestUIFactory, self).__init__()
755
714
        if stdin is not None:
756
715
            # We use a StringIOWrapper to be able to test various
757
716
            # encodings, but the user is still responsible to
758
717
            # encode the string and to set the encoding attribute
759
718
            # of StringIOWrapper.
760
 
            stdin = StringIOWrapper(stdin)
761
 
        super(TestUIFactory, self).__init__(stdin, stdout, stderr)
762
 
 
763
 
    def get_non_echoed_password(self):
 
719
            self.stdin = StringIOWrapper(stdin)
 
720
        if stdout is None:
 
721
            self.stdout = sys.stdout
 
722
        else:
 
723
            self.stdout = stdout
 
724
        if stderr is None:
 
725
            self.stderr = sys.stderr
 
726
        else:
 
727
            self.stderr = stderr
 
728
 
 
729
    def clear(self):
 
730
        """See progress.ProgressBar.clear()."""
 
731
 
 
732
    def clear_term(self):
 
733
        """See progress.ProgressBar.clear_term()."""
 
734
 
 
735
    def clear_term(self):
 
736
        """See progress.ProgressBar.clear_term()."""
 
737
 
 
738
    def finished(self):
 
739
        """See progress.ProgressBar.finished()."""
 
740
 
 
741
    def note(self, fmt_string, *args, **kwargs):
 
742
        """See progress.ProgressBar.note()."""
 
743
        self.stdout.write((fmt_string + "\n") % args)
 
744
 
 
745
    def progress_bar(self):
 
746
        return self
 
747
 
 
748
    def nested_progress_bar(self):
 
749
        return self
 
750
 
 
751
    def update(self, message, count=None, total=None):
 
752
        """See progress.ProgressBar.update()."""
 
753
 
 
754
    def get_non_echoed_password(self, prompt):
764
755
        """Get password from stdin without trying to handle the echo mode"""
 
756
        if prompt:
 
757
            self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
765
758
        password = self.stdin.readline()
766
759
        if not password:
767
760
            raise EOFError
769
762
            password = password[:-1]
770
763
        return password
771
764
 
772
 
    def make_progress_view(self):
773
 
        return NullProgressView()
774
 
 
775
 
 
776
 
class TestCase(testtools.TestCase):
 
765
 
 
766
class TestCase(unittest.TestCase):
777
767
    """Base class for bzr unit tests.
778
 
 
779
 
    Tests that need access to disk resources should subclass
 
768
    
 
769
    Tests that need access to disk resources should subclass 
780
770
    TestCaseInTempDir not TestCase.
781
771
 
782
772
    Error and debug log messages are redirected from their usual
784
774
    retrieved by _get_log().  We use a real OS file, not an in-memory object,
785
775
    so that it can also capture file IO.  When the test completes this file
786
776
    is read into memory and removed from disk.
787
 
 
 
777
       
788
778
    There are also convenience functions to invoke bzr's command-line
789
779
    routine, and to build and check bzr trees.
790
 
 
 
780
   
791
781
    In addition to the usual method of overriding tearDown(), this class also
792
782
    allows subclasses to register functions into the _cleanups list, which is
793
783
    run in order as the object is torn down.  It's less likely this will be
794
784
    accidentally overlooked.
795
785
    """
796
786
 
797
 
    _active_threads = None
798
 
    _leaking_threads_tests = 0
799
 
    _first_thread_leaker_id = None
800
787
    _log_file_name = None
 
788
    _log_contents = ''
 
789
    _keep_log_file = False
801
790
    # record lsprof data when performing benchmark calls.
802
791
    _gather_lsprof_in_benchmarks = False
803
792
 
804
793
    def __init__(self, methodName='testMethod'):
805
794
        super(TestCase, self).__init__(methodName)
806
795
        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))
812
796
 
813
797
    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)]))
 
798
        unittest.TestCase.setUp(self)
821
799
        self._cleanEnvironment()
822
800
        self._silenceUI()
823
801
        self._startLogFile()
824
802
        self._benchcalls = []
825
803
        self._benchtime = None
826
804
        self._clear_hooks()
827
 
        self._track_transports()
828
 
        self._track_locks()
829
805
        self._clear_debug_flags()
830
 
        TestCase._active_threads = threading.activeCount()
831
 
        self.addCleanup(self._check_leaked_threads)
832
 
 
833
 
    def debug(self):
834
 
        # debug a frame up.
835
 
        import pdb
836
 
        pdb.Pdb().set_trace(sys._getframe().f_back)
837
 
 
838
 
    def _check_leaked_threads(self):
839
 
        active = threading.activeCount()
840
 
        leaked_threads = active - TestCase._active_threads
841
 
        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:
849
 
            TestCase._leaking_threads_tests += 1
850
 
            if TestCase._first_thread_leaker_id is None:
851
 
                TestCase._first_thread_leaker_id = self.id()
852
806
 
853
807
    def _clear_debug_flags(self):
854
808
        """Prevent externally set debug flags affecting tests.
855
 
 
 
809
        
856
810
        Tests that want to use debug flags can just set them in the
857
811
        debug_flags set during setup/teardown.
858
812
        """
859
 
        # Start with a copy of the current debug flags we can safely modify.
860
 
        self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
861
 
        if 'allow_debug' not in selftest_debug_flags:
862
 
            debug.debug_flags.clear()
863
 
        if 'disable_lock_checks' not in selftest_debug_flags:
864
 
            debug.debug_flags.add('strict_locks')
 
813
        self._preserved_debug_flags = set(debug.debug_flags)
 
814
        debug.debug_flags.clear()
 
815
        self.addCleanup(self._restore_debug_flags)
865
816
 
866
817
    def _clear_hooks(self):
867
818
        # prevent hooks affecting tests
868
 
        self._preserved_hooks = {}
869
 
        for key, factory in hooks.known_hooks.items():
870
 
            parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
871
 
            current_hooks = hooks.known_hooks_key_to_object(key)
872
 
            self._preserved_hooks[parent] = (name, current_hooks)
 
819
        import bzrlib.branch
 
820
        import bzrlib.smart.server
 
821
        self._preserved_hooks = {
 
822
            bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
 
823
            bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
 
824
            }
873
825
        self.addCleanup(self._restoreHooks)
874
 
        for key, factory in hooks.known_hooks.items():
875
 
            parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
876
 
            setattr(parent, name, factory())
877
 
        # this hook should always be installed
878
 
        request._install_hook()
879
 
 
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
 
826
        # reset all hooks to an empty instance of the appropriate type
 
827
        bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
 
828
        bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
887
829
 
888
830
    def _silenceUI(self):
889
831
        """Turn off UI for duration of test"""
890
832
        # 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.")
 
833
        saved = ui.ui_factory
 
834
        def _restore():
 
835
            ui.ui_factory = saved
 
836
        ui.ui_factory = ui.SilentUIFactory()
 
837
        self.addCleanup(_restore)
1070
838
 
1071
839
    def _ndiff_strings(self, a, b):
1072
840
        """Return ndiff between two strings containing lines.
1073
 
 
 
841
        
1074
842
        A trailing newline is added if missing to make the strings
1075
843
        print properly."""
1076
844
        if b and b[-1] != '\n':
1101
869
 
1102
870
    def assertEqualDiff(self, a, b, message=None):
1103
871
        """Assert two texts are equal, if not raise an exception.
1104
 
 
1105
 
        This is intended for use with multi-line strings where it can
 
872
        
 
873
        This is intended for use with multi-line strings where it can 
1106
874
        be hard to find the differences by eye.
1107
875
        """
1108
876
        # TODO: perhaps override assertEquals to call this for strings?
1110
878
            return
1111
879
        if message is None:
1112
880
            message = "texts not equal:\n"
1113
 
        if a + '\n' == b:
1114
 
            message = 'first string is missing a final newline.\n'
1115
 
        if a == b + '\n':
1116
 
            message = 'second string is missing a final newline.\n'
1117
881
        raise AssertionError(message +
1118
882
                             self._ndiff_strings(a, b))
1119
 
 
 
883
        
1120
884
    def assertEqualMode(self, mode, mode_test):
1121
885
        self.assertEqual(mode, mode_test,
1122
886
                         'mode mismatch %o != %o' % (mode, mode_test))
1123
887
 
1124
 
    def assertEqualStat(self, expected, actual):
1125
 
        """assert that expected and actual are the same stat result.
1126
 
 
1127
 
        :param expected: A stat result.
1128
 
        :param actual: A stat result.
1129
 
        :raises AssertionError: If the expected and actual stat values differ
1130
 
            other than by atime.
1131
 
        """
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')
1149
 
 
1150
 
    def assertLength(self, length, obj_with_len):
1151
 
        """Assert that obj_with_len is of length length."""
1152
 
        if len(obj_with_len) != length:
1153
 
            self.fail("Incorrect length: wanted %d, got %d for %r" % (
1154
 
                length, len(obj_with_len), obj_with_len))
1155
 
 
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
888
    def assertPositive(self, val):
1176
889
        """Assert that val is greater than 0."""
1177
890
        self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1189
902
        if not s.endswith(suffix):
1190
903
            raise AssertionError('string %r does not end with %r' % (s, suffix))
1191
904
 
1192
 
    def assertContainsRe(self, haystack, needle_re, flags=0):
 
905
    def assertContainsRe(self, haystack, needle_re):
1193
906
        """Assert that a contains something matching a regular expression."""
1194
 
        if not re.search(needle_re, haystack, flags):
 
907
        if not re.search(needle_re, haystack):
1195
908
            if '\n' in haystack or len(haystack) > 60:
1196
909
                # a long string, format it in a more readable way
1197
910
                raise AssertionError(
1201
914
                raise AssertionError('pattern "%s" not found in "%s"'
1202
915
                        % (needle_re, haystack))
1203
916
 
1204
 
    def assertNotContainsRe(self, haystack, needle_re, flags=0):
 
917
    def assertNotContainsRe(self, haystack, needle_re):
1205
918
        """Assert that a does not match a regular expression"""
1206
 
        if re.search(needle_re, haystack, flags):
 
919
        if re.search(needle_re, haystack):
1207
920
            raise AssertionError('pattern "%s" found in "%s"'
1208
921
                    % (needle_re, haystack))
1209
922
 
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
923
    def assertSubset(self, sublist, superlist):
1215
924
        """Assert that every entry in sublist is present in superlist."""
1216
925
        missing = set(sublist) - set(superlist)
1220
929
 
1221
930
    def assertListRaises(self, excClass, func, *args, **kwargs):
1222
931
        """Fail unless excClass is raised when the iterator from func is used.
1223
 
 
 
932
        
1224
933
        Many functions can return generators this makes sure
1225
934
        to wrap them in a list() call to make sure the whole generator
1226
935
        is run, and that the proper exception is raised.
1227
936
        """
1228
937
        try:
1229
938
            list(func(*args, **kwargs))
1230
 
        except excClass, e:
1231
 
            return e
 
939
        except excClass:
 
940
            return
1232
941
        else:
1233
942
            if getattr(excClass,'__name__', None) is not None:
1234
943
                excName = excClass.__name__
1273
982
                raise AssertionError("%r is %r." % (left, right))
1274
983
 
1275
984
    def assertTransportMode(self, transport, path, mode):
1276
 
        """Fail if a path does not have mode "mode".
1277
 
 
 
985
        """Fail if a path does not have mode mode.
 
986
        
1278
987
        If modes are not supported on this transport, the assertion is ignored.
1279
988
        """
1280
989
        if not transport._can_roundtrip_unix_modebits():
1282
991
        path_stat = transport.stat(path)
1283
992
        actual_mode = stat.S_IMODE(path_stat.st_mode)
1284
993
        self.assertEqual(mode, actual_mode,
1285
 
                         'mode of %r incorrect (%s != %s)'
1286
 
                         % (path, oct(mode), oct(actual_mode)))
 
994
            'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
1287
995
 
1288
996
    def assertIsSameRealPath(self, path1, path2):
1289
997
        """Fail if path1 and path2 points to different files"""
1291
999
                         osutils.realpath(path2),
1292
1000
                         "apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1293
1001
 
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
 
        """
 
1002
    def assertIsInstance(self, obj, kls):
 
1003
        """Fail if obj is not an instance of kls"""
1299
1004
        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)
 
1005
            self.fail("%r is an instance of %s rather than %s" % (
 
1006
                obj, obj.__class__, kls))
 
1007
 
 
1008
    def expectFailure(self, reason, assertion, *args, **kwargs):
 
1009
        """Invoke a test, expecting it to fail for the given reason.
 
1010
 
 
1011
        This is for assertions that ought to succeed, but currently fail.
 
1012
        (The failure is *expected* but not *wanted*.)  Please be very precise
 
1013
        about the failure you're expecting.  If a new bug is introduced,
 
1014
        AssertionError should be raised, not KnownFailure.
 
1015
 
 
1016
        Frequently, expectFailure should be followed by an opposite assertion.
 
1017
        See example below.
 
1018
 
 
1019
        Intended to be used with a callable that raises AssertionError as the
 
1020
        'assertion' parameter.  args and kwargs are passed to the 'assertion'.
 
1021
 
 
1022
        Raises KnownFailure if the test fails.  Raises AssertionError if the
 
1023
        test succeeds.
 
1024
 
 
1025
        example usage::
 
1026
 
 
1027
          self.expectFailure('Math is broken', self.assertNotEqual, 54,
 
1028
                             dynamic_val)
 
1029
          self.assertEqual(42, dynamic_val)
 
1030
 
 
1031
          This means that a dynamic_val of 54 will cause the test to raise
 
1032
          a KnownFailure.  Once math is fixed and the expectFailure is removed,
 
1033
          only a dynamic_val of 42 will allow the test to pass.  Anything other
 
1034
          than 54 or 42 will cause an AssertionError.
 
1035
        """
 
1036
        try:
 
1037
            assertion(*args, **kwargs)
 
1038
        except AssertionError:
 
1039
            raise KnownFailure(reason)
 
1040
        else:
 
1041
            self.fail('Unexpected success.  Should have failed: %s' % reason)
1305
1042
 
1306
1043
    def assertFileEqual(self, content, path):
1307
1044
        """Fail if path does not contain 'content'."""
1313
1050
            f.close()
1314
1051
        self.assertEqualDiff(content, s)
1315
1052
 
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
1053
    def failUnlessExists(self, path):
1325
1054
        """Fail unless path or paths, which may be abs or relative, exist."""
1326
1055
        if not isinstance(path, basestring):
1369
1098
        To test that a deprecated method raises an error, do something like
1370
1099
        this::
1371
1100
 
1372
 
            self.assertRaises(errors.ReservedId,
1373
 
                self.applyDeprecated,
1374
 
                deprecated_in((1, 5, 0)),
1375
 
                br.append_revision,
1376
 
                'current:')
 
1101
        self.assertRaises(errors.ReservedId,
 
1102
            self.applyDeprecated, zero_ninetyone,
 
1103
                br.append_revision, 'current:')
1377
1104
 
1378
1105
        :param deprecation_format: The deprecation format that the callable
1379
1106
            should have been deprecated with. This is the same type as the
1413
1140
        # warnings.  It's the easiest way to insulate ourselves from -Werror,
1414
1141
        # though.  -- Andrew, 20071062
1415
1142
        wlist = []
1416
 
        def _catcher(message, category, filename, lineno, file=None, line=None):
 
1143
        def _catcher(message, category, filename, lineno, file=None):
1417
1144
            # despite the name, 'message' is normally(?) a Warning subclass
1418
1145
            # instance
1419
1146
            wlist.append(message)
1431
1158
    def callDeprecated(self, expected, callable, *args, **kwargs):
1432
1159
        """Assert that a callable is deprecated in a particular way.
1433
1160
 
1434
 
        This is a very precise test for unusual requirements. The
 
1161
        This is a very precise test for unusual requirements. The 
1435
1162
        applyDeprecated helper function is probably more suited for most tests
1436
1163
        as it allows you to simply specify the deprecation format being used
1437
1164
        and will ensure that that is issued for the function being called.
1466
1193
 
1467
1194
        Close the file and delete it, unless setKeepLogfile was called.
1468
1195
        """
1469
 
        if bzrlib.trace._trace_file:
1470
 
            # flush the log file, to get all content
1471
 
            bzrlib.trace._trace_file.flush()
 
1196
        if self._log_file is None:
 
1197
            return
1472
1198
        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')
1488
 
 
1489
 
    def addCleanup(self, callable, *args, **kwargs):
 
1199
        self._log_file.close()
 
1200
        self._log_file = None
 
1201
        if not self._keep_log_file:
 
1202
            os.remove(self._log_file_name)
 
1203
            self._log_file_name = None
 
1204
 
 
1205
    def setKeepLogfile(self):
 
1206
        """Make the logfile not be deleted when _finishLogFile is called."""
 
1207
        self._keep_log_file = True
 
1208
 
 
1209
    def addCleanup(self, callable):
1490
1210
        """Arrange to run a callable when this case is torn down.
1491
1211
 
1492
 
        Callables are run in the reverse of the order they are registered,
 
1212
        Callables are run in the reverse of the order they are registered, 
1493
1213
        ie last-in first-out.
1494
1214
        """
1495
 
        self._cleanups.append((callable, args, kwargs))
1496
 
 
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
 
1215
        if callable in self._cleanups:
 
1216
            raise ValueError("cleanup function %r already registered on %s" 
 
1217
                    % (callable, self))
 
1218
        self._cleanups.append(callable)
1515
1219
 
1516
1220
    def _cleanEnvironment(self):
1517
1221
        new_env = {
1518
1222
            'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1519
1223
            'HOME': os.getcwd(),
1520
 
            # bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1521
 
            # tests do check our impls match APPDATA
 
1224
            'APPDATA': None,  # bzr now use Win32 API and don't rely on APPDATA
1522
1225
            'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1523
 
            'VISUAL': None,
1524
 
            'EDITOR': None,
1525
1226
            'BZR_EMAIL': None,
1526
1227
            'BZREMAIL': None, # may still be present in the environment
1527
1228
            'EMAIL': None,
1528
1229
            'BZR_PROGRESS_BAR': None,
1529
 
            'BZR_LOG': None,
1530
 
            '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
1230
            # SSH Agent
1543
1231
            'SSH_AUTH_SOCK': None,
1544
1232
            # Proxies
1550
1238
            'NO_PROXY': None,
1551
1239
            'all_proxy': None,
1552
1240
            'ALL_PROXY': None,
1553
 
            # Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
 
1241
            # Nobody cares about these ones AFAIK. So far at
1554
1242
            # least. If you do (care), please update this comment
1555
 
            # -- vila 20080401
 
1243
            # -- vila 20061212
1556
1244
            'ftp_proxy': None,
1557
1245
            'FTP_PROXY': None,
1558
1246
            '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
1247
        }
1565
 
        self._old_env = {}
 
1248
        self.__old_env = {}
1566
1249
        self.addCleanup(self._restoreEnvironment)
1567
1250
        for name, value in new_env.iteritems():
1568
1251
            self._captureVar(name, value)
1569
1252
 
1570
1253
    def _captureVar(self, name, newvalue):
1571
1254
        """Set an environment variable, and reset it when finished."""
1572
 
        self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1255
        self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1256
 
 
1257
    def _restore_debug_flags(self):
 
1258
        debug.debug_flags.clear()
 
1259
        debug.debug_flags.update(self._preserved_debug_flags)
1573
1260
 
1574
1261
    def _restoreEnvironment(self):
1575
 
        for name, value in self._old_env.iteritems():
 
1262
        for name, value in self.__old_env.iteritems():
1576
1263
            osutils.set_or_unset_env(name, value)
1577
1264
 
1578
1265
    def _restoreHooks(self):
1579
 
        for klass, (name, hooks) in self._preserved_hooks.items():
1580
 
            setattr(klass, name, hooks)
 
1266
        for klass, hooks in self._preserved_hooks.items():
 
1267
            setattr(klass, 'hooks', hooks)
1581
1268
 
1582
1269
    def knownFailure(self, reason):
1583
1270
        """This test has failed for some known reason."""
1584
1271
        raise KnownFailure(reason)
1585
1272
 
1586
 
    def _do_skip(self, result, reason):
1587
 
        addSkip = getattr(result, 'addSkip', None)
1588
 
        if not callable(addSkip):
1589
 
            result.addSuccess(result)
1590
 
        else:
1591
 
            addSkip(self, reason)
1592
 
 
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)
 
1273
    def run(self, result=None):
 
1274
        if result is None: result = self.defaultTestResult()
 
1275
        for feature in getattr(self, '_test_needs_features', []):
 
1276
            if not feature.available():
 
1277
                result.startTest(self)
 
1278
                if getattr(result, 'addNotSupported', None):
 
1279
                    result.addNotSupported(self, feature)
 
1280
                else:
 
1281
                    result.addSuccess(self)
 
1282
                result.stopTest(self)
 
1283
                return
 
1284
        return unittest.TestCase.run(self, result)
 
1285
 
 
1286
    def tearDown(self):
 
1287
        self._runCleanups()
 
1288
        unittest.TestCase.tearDown(self)
1622
1289
 
1623
1290
    def time(self, callable, *args, **kwargs):
1624
1291
        """Run callable and accrue the time it takes to the benchmark time.
1625
 
 
 
1292
        
1626
1293
        If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1627
1294
        this will cause lsprofile statistics to be gathered and stored in
1628
1295
        self._benchcalls.
1629
1296
        """
1630
1297
        if self._benchtime is None:
1631
 
            self.addDetail('benchtime', content.Content(content.ContentType(
1632
 
                "text", "plain"), lambda:[str(self._benchtime)]))
1633
1298
            self._benchtime = 0
1634
1299
        start = time.time()
1635
1300
        try:
1644
1309
        finally:
1645
1310
            self._benchtime += time.time() - start
1646
1311
 
 
1312
    def _runCleanups(self):
 
1313
        """Run registered cleanup functions. 
 
1314
 
 
1315
        This should only be called from TestCase.tearDown.
 
1316
        """
 
1317
        # TODO: Perhaps this should keep running cleanups even if 
 
1318
        # one of them fails?
 
1319
 
 
1320
        # Actually pop the cleanups from the list so tearDown running
 
1321
        # twice is safe (this happens for skipped tests).
 
1322
        while self._cleanups:
 
1323
            self._cleanups.pop()()
 
1324
 
1647
1325
    def log(self, *args):
1648
1326
        mutter(*args)
1649
1327
 
1650
1328
    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.
 
1329
        """Get the log from bzrlib.trace calls from this test.
1655
1330
 
1656
1331
        :param keep_log_file: When True, if the log is still a file on disk
1657
1332
            leave it as a file on disk. When False, if the log is still a file
1659
1334
            self._log_contents.
1660
1335
        :return: A string containing the log.
1661
1336
        """
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')
 
1337
        # flush the log file, to get all content
 
1338
        import bzrlib.trace
 
1339
        bzrlib.trace._trace_file.flush()
 
1340
        if self._log_contents:
 
1341
            # XXX: this can hardly contain the content flushed above --vila
 
1342
            # 20080128
1668
1343
            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
1344
        if self._log_file_name is not None:
1674
1345
            logfile = open(self._log_file_name)
1675
1346
            try:
1676
1347
                log_contents = logfile.read()
1677
1348
            finally:
1678
1349
                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
1350
            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
1351
                self._log_contents = log_contents
1716
1352
                try:
1717
1353
                    os.remove(self._log_file_name)
1721
1357
                                             ' %r\n' % self._log_file_name))
1722
1358
                    else:
1723
1359
                        raise
1724
 
                self._log_file_name = None
1725
1360
            return log_contents
1726
1361
        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())
 
1362
            return "DELETED log file to reduce memory footprint"
1735
1363
 
1736
1364
    def requireFeature(self, feature):
1737
1365
        """This test requires a specific feature is available.
1754
1382
 
1755
1383
    def _run_bzr_core(self, args, retcode, encoding, stdin,
1756
1384
            working_dir):
1757
 
        # Clear chk_map page cache, because the contents are likely to mask
1758
 
        # locking errors.
1759
 
        chk_map.clear_cache()
1760
1385
        if encoding is None:
1761
 
            encoding = osutils.get_user_encoding()
 
1386
            encoding = bzrlib.user_encoding
1762
1387
        stdout = StringIOWrapper()
1763
1388
        stderr = StringIOWrapper()
1764
1389
        stdout.encoding = encoding
1779
1404
            os.chdir(working_dir)
1780
1405
 
1781
1406
        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)
 
1407
            result = self.apply_redirected(ui.ui_factory.stdin,
 
1408
                stdout, stderr,
 
1409
                bzrlib.commands.run_bzr_catch_user_errors,
 
1410
                args)
1798
1411
        finally:
1799
1412
            logger.removeHandler(handler)
1800
1413
            ui.ui_factory = old_ui_factory
1810
1423
        if retcode is not None:
1811
1424
            self.assertEquals(retcode, result,
1812
1425
                              message='Unexpected return code')
1813
 
        return result, out, err
 
1426
        return out, err
1814
1427
 
1815
1428
    def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1816
1429
                working_dir=None, error_regexes=[], output_encoding=None):
1821
1434
        passed in three ways:
1822
1435
 
1823
1436
        1- A list of strings, eg ["commit", "a"].  This is recommended
1824
 
        when the command contains whitespace or metacharacters, or
 
1437
        when the command contains whitespace or metacharacters, or 
1825
1438
        is built up at run time.
1826
1439
 
1827
 
        2- A single string, eg "add a".  This is the most convenient
 
1440
        2- A single string, eg "add a".  This is the most convenient 
1828
1441
        for hardcoded commands.
1829
1442
 
1830
1443
        This runs bzr through the interface that catches and reports
1845
1458
        :keyword error_regexes: A list of expected error messages.  If
1846
1459
            specified they must be seen in the error output of the command.
1847
1460
        """
1848
 
        retcode, out, err = self._run_bzr_autosplit(
 
1461
        out, err = self._run_bzr_autosplit(
1849
1462
            args=args,
1850
1463
            retcode=retcode,
1851
1464
            encoding=encoding,
1852
1465
            stdin=stdin,
1853
1466
            working_dir=working_dir,
1854
1467
            )
1855
 
        self.assertIsInstance(error_regexes, (list, tuple))
1856
1468
        for regex in error_regexes:
1857
1469
            self.assertContainsRe(err, regex)
1858
1470
        return out, err
1890
1502
    def run_bzr_subprocess(self, *args, **kwargs):
1891
1503
        """Run bzr in a subprocess for testing.
1892
1504
 
1893
 
        This starts a new Python interpreter and runs bzr in there.
 
1505
        This starts a new Python interpreter and runs bzr in there. 
1894
1506
        This should only be used for tests that have a justifiable need for
1895
1507
        this isolation: e.g. they are testing startup time, or signal
1896
 
        handling, or early startup code, etc.  Subprocess code can't be
 
1508
        handling, or early startup code, etc.  Subprocess code can't be 
1897
1509
        profiled or debugged so easily.
1898
1510
 
1899
1511
        :keyword retcode: The status code that is expected.  Defaults to 0.  If
1917
1529
            elif isinstance(args[0], basestring):
1918
1530
                args = list(shlex.split(args[0]))
1919
1531
        else:
1920
 
            raise ValueError("passing varargs to run_bzr_subprocess")
 
1532
            symbol_versioning.warn(zero_ninetyone %
 
1533
                                   "passing varargs to run_bzr_subprocess",
 
1534
                                   DeprecationWarning, stacklevel=3)
1921
1535
        process = self.start_bzr_subprocess(args, env_changes=env_changes,
1922
1536
                                            working_dir=working_dir,
1923
1537
                                            allow_plugins=allow_plugins)
1979
1593
            # so we will avoid using it on all platforms, just to
1980
1594
            # make sure the code path is used, and we don't break on win32
1981
1595
            cleanup_environment()
1982
 
            command = [sys.executable]
1983
 
            # frozen executables don't need the path to bzr
1984
 
            if getattr(sys, "frozen", None) is None:
1985
 
                command.append(bzr_path)
 
1596
            command = [sys.executable, bzr_path]
1986
1597
            if not allow_plugins:
1987
1598
                command.append('--no-plugins')
1988
1599
            command.extend(process_args)
2002
1613
        """
2003
1614
        return Popen(*args, **kwargs)
2004
1615
 
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
1616
    def get_bzr_path(self):
2010
1617
        """Return the path of the 'bzr' executable for this test suite."""
2011
 
        bzr_path = self.get_source_path()+'/bzr'
 
1618
        bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
2012
1619
        if not os.path.isfile(bzr_path):
2013
1620
            # We are probably installed. Assume sys.argv is the right file
2014
1621
            bzr_path = sys.argv[0]
2100
1707
 
2101
1708
        Tests that expect to provoke LockContention errors should call this.
2102
1709
        """
2103
 
        self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
 
1710
        orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
 
1711
        def resetTimeout():
 
1712
            bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
 
1713
        self.addCleanup(resetTimeout)
 
1714
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2104
1715
 
2105
1716
    def make_utf8_encoded_stringio(self, encoding_type=None):
2106
1717
        """Return a StringIOWrapper instance, that will encode Unicode
2114
1725
        sio.encoding = output_encoding
2115
1726
        return sio
2116
1727
 
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
 
 
2126
 
class CapturedCall(object):
2127
 
    """A helper for capturing smart server calls for easy debug analysis."""
2128
 
 
2129
 
    def __init__(self, params, prefix_length):
2130
 
        """Capture the call with params and skip prefix_length stack frames."""
2131
 
        self.call = params
2132
 
        import traceback
2133
 
        # The last 5 frames are the __init__, the hook frame, and 3 smart
2134
 
        # client frames. Beyond this we could get more clever, but this is good
2135
 
        # enough for now.
2136
 
        stack = traceback.extract_stack()[prefix_length:-5]
2137
 
        self.stack = ''.join(traceback.format_list(stack))
2138
 
 
2139
 
    def __str__(self):
2140
 
        return self.call.method
2141
 
 
2142
 
    def __repr__(self):
2143
 
        return self.call.method
2144
 
 
2145
 
    def stack(self):
2146
 
        return self.stack
2147
 
 
2148
1728
 
2149
1729
class TestCaseWithMemoryTransport(TestCase):
2150
1730
    """Common test class for tests that do not need disk resources.
2170
1750
 
2171
1751
    def __init__(self, methodName='runTest'):
2172
1752
        # allow test parameterization after test construction and before test
2173
 
        # execution. Variables that the parameterizer sets need to be
 
1753
        # execution. Variables that the parameterizer sets need to be 
2174
1754
        # ones that are not set by setUp, or setUp will trash them.
2175
1755
        super(TestCaseWithMemoryTransport, self).__init__(methodName)
2176
1756
        self.vfs_transport_factory = default_transport
2183
1763
 
2184
1764
        This transport is for the test scratch space relative to
2185
1765
        "self._test_root"
2186
 
 
 
1766
        
2187
1767
        :param relpath: a path relative to the base url.
2188
1768
        """
2189
1769
        t = get_transport(self.get_url(relpath))
2192
1772
 
2193
1773
    def get_readonly_transport(self, relpath=None):
2194
1774
        """Return a readonly transport for the test scratch space
2195
 
 
 
1775
        
2196
1776
        This can be used to test that operations which should only need
2197
1777
        readonly access in fact do not try to write.
2198
1778
 
2217
1797
        if self.__readonly_server is None:
2218
1798
            if self.transport_readonly_server is None:
2219
1799
                # readonly decorator requested
2220
 
                self.__readonly_server = test_server.ReadonlyServer()
 
1800
                # bring up the server
 
1801
                self.__readonly_server = ReadonlyServer()
 
1802
                self.__readonly_server.setUp(self.get_vfs_only_server())
2221
1803
            else:
2222
 
                # explicit readonly transport.
2223
1804
                self.__readonly_server = self.create_transport_readonly_server()
2224
 
            self.start_server(self.__readonly_server,
2225
 
                self.get_vfs_only_server())
 
1805
                self.__readonly_server.setUp(self.get_vfs_only_server())
 
1806
            self.addCleanup(self.__readonly_server.tearDown)
2226
1807
        return self.__readonly_server
2227
1808
 
2228
1809
    def get_readonly_url(self, relpath=None):
2229
1810
        """Get a URL for the readonly transport.
2230
1811
 
2231
 
        This will either be backed by '.' or a decorator to the transport
 
1812
        This will either be backed by '.' or a decorator to the transport 
2232
1813
        used by self.get_url()
2233
1814
        relpath provides for clients to get a path relative to the base url.
2234
1815
        These should only be downwards relative, not upwards.
2246
1827
        is no means to override it.
2247
1828
        """
2248
1829
        if self.__vfs_server is None:
2249
 
            self.__vfs_server = memory.MemoryServer()
2250
 
            self.start_server(self.__vfs_server)
 
1830
            self.__vfs_server = MemoryServer()
 
1831
            self.__vfs_server.setUp()
 
1832
            self.addCleanup(self.__vfs_server.tearDown)
2251
1833
        return self.__vfs_server
2252
1834
 
2253
1835
    def get_server(self):
2260
1842
        then the self.get_vfs_server is returned.
2261
1843
        """
2262
1844
        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()
 
1845
            if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
 
1846
                return self.get_vfs_only_server()
2266
1847
            else:
2267
1848
                # bring up a decorated means of access to the vfs only server.
2268
1849
                self.__server = self.transport_server()
2269
 
                self.start_server(self.__server, self.get_vfs_only_server())
 
1850
                try:
 
1851
                    self.__server.setUp(self.get_vfs_only_server())
 
1852
                except TypeError, e:
 
1853
                    # This should never happen; the try:Except here is to assist
 
1854
                    # developers having to update code rather than seeing an
 
1855
                    # uninformative TypeError.
 
1856
                    raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
 
1857
            self.addCleanup(self.__server.tearDown)
2270
1858
        return self.__server
2271
1859
 
2272
1860
    def _adjust_url(self, base, relpath):
2334
1922
        propagating. This method ensures than a test did not leaked.
2335
1923
        """
2336
1924
        root = TestCaseWithMemoryTransport.TEST_ROOT
2337
 
        self.permit_url(get_transport(root).base)
2338
1925
        wt = workingtree.WorkingTree.open(root)
2339
1926
        last_rev = wt.last_revision()
2340
1927
        if last_rev != 'null:':
2342
1929
            # recreate a new one or all the followng tests will fail.
2343
1930
            # If you need to inspect its content uncomment the following line
2344
1931
            # import pdb; pdb.set_trace()
2345
 
            _rmtree_temp_dir(root + '/.bzr', test_id=self.id())
 
1932
            _rmtree_temp_dir(root + '/.bzr')
2346
1933
            self._create_safety_net()
2347
1934
            raise AssertionError('%s/.bzr should not be modified' % root)
2348
1935
 
2349
1936
    def _make_test_root(self):
2350
1937
        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'))
 
1938
            root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2354
1939
            TestCaseWithMemoryTransport.TEST_ROOT = root
2355
1940
 
2356
1941
            self._create_safety_net()
2359
1944
            # specifically told when all tests are finished.  This will do.
2360
1945
            atexit.register(_rmtree_temp_dir, root)
2361
1946
 
2362
 
        self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2363
1947
        self.addCleanup(self._check_safety_net)
2364
1948
 
2365
1949
    def makeAndChdirToTestDir(self):
2366
1950
        """Create a temporary directories for this one test.
2367
 
 
 
1951
        
2368
1952
        This must set self.test_home_dir and self.test_dir and chdir to
2369
1953
        self.test_dir.
2370
 
 
 
1954
        
2371
1955
        For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2372
1956
        """
2373
1957
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2374
1958
        self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2375
1959
        self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2376
 
        self.permit_dir(self.test_dir)
2377
 
 
 
1960
        
2378
1961
    def make_branch(self, relpath, format=None):
2379
1962
        """Create a branch on the transport at relpath."""
2380
1963
        repo = self.make_repository(relpath, format=format)
2398
1981
 
2399
1982
    def make_repository(self, relpath, shared=False, format=None):
2400
1983
        """Create a repository on our default transport at relpath.
2401
 
 
 
1984
        
2402
1985
        Note that relpath must be a relative path, not a full url.
2403
1986
        """
2404
1987
        # FIXME: If you create a remoterepository this returns the underlying
2405
 
        # real format, which is incorrect.  Actually we should make sure that
 
1988
        # real format, which is incorrect.  Actually we should make sure that 
2406
1989
        # RemoteBzrDir returns a RemoteRepository.
2407
1990
        # maybe  mbp 20070410
2408
1991
        made_control = self.make_bzrdir(relpath, format=format)
2409
1992
        return made_control.create_repository(shared=shared)
2410
1993
 
2411
 
    def make_smart_server(self, path):
2412
 
        smart_server = test_server.SmartTCPServer_for_testing()
2413
 
        self.start_server(smart_server, self.get_server())
2414
 
        remote_transport = get_transport(smart_server.get_url()).clone(path)
2415
 
        return remote_transport
2416
 
 
2417
1994
    def make_branch_and_memory_tree(self, relpath, format=None):
2418
1995
        """Create a branch on the default transport and a MemoryTree for it."""
2419
1996
        b = self.make_branch(relpath, format=format)
2420
1997
        return memorytree.MemoryTree.create_on_branch(b)
2421
1998
 
2422
 
    def make_branch_builder(self, relpath, format=None):
2423
 
        branch = self.make_branch(relpath, format=format)
2424
 
        return branchbuilder.BranchBuilder(branch=branch)
2425
 
 
2426
1999
    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
2432
 
 
 
2000
        os.environ['HOME'] = self.test_home_dir
 
2001
        os.environ['BZR_HOME'] = self.test_home_dir
 
2002
        
2433
2003
    def setUp(self):
2434
2004
        super(TestCaseWithMemoryTransport, self).setUp()
2435
2005
        self._make_test_root()
2436
 
        self.addCleanup(os.chdir, os.getcwdu())
 
2006
        _currentdir = os.getcwdu()
 
2007
        def _leaveDirectory():
 
2008
            os.chdir(_currentdir)
 
2009
        self.addCleanup(_leaveDirectory)
2437
2010
        self.makeAndChdirToTestDir()
2438
2011
        self.overrideEnvironmentForTesting()
2439
2012
        self.__readonly_server = None
2440
2013
        self.__server = None
2441
2014
        self.reduceLockdirTimeout()
2442
2015
 
2443
 
    def setup_smart_server_with_call_log(self):
2444
 
        """Sets up a smart server as the transport server with a call log."""
2445
 
        self.transport_server = test_server.SmartTCPServer_for_testing
2446
 
        self.hpss_calls = []
2447
 
        import traceback
2448
 
        # Skip the current stack down to the caller of
2449
 
        # setup_smart_server_with_call_log
2450
 
        prefix_length = len(traceback.extract_stack()) - 2
2451
 
        def capture_hpss_call(params):
2452
 
            self.hpss_calls.append(
2453
 
                CapturedCall(params, prefix_length))
2454
 
        client._SmartClient.hooks.install_named_hook(
2455
 
            'call', capture_hpss_call, None)
2456
 
 
2457
 
    def reset_smart_call_log(self):
2458
 
        self.hpss_calls = []
2459
 
 
2460
 
 
 
2016
     
2461
2017
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2462
2018
    """Derived class that runs a test within a temporary directory.
2463
2019
 
2468
2024
    All test cases create their own directory within that.  If the
2469
2025
    tests complete successfully, the directory is removed.
2470
2026
 
2471
 
    :ivar test_base_dir: The path of the top-level directory for this
 
2027
    :ivar test_base_dir: The path of the top-level directory for this 
2472
2028
    test, which contains a home directory and a work directory.
2473
2029
 
2474
2030
    :ivar test_home_dir: An initially empty directory under test_base_dir
2488
2044
            self.log("actually: %r" % contents)
2489
2045
            self.fail("contents of %s not as expected" % filename)
2490
2046
 
2491
 
    def _getTestDirPrefix(self):
2492
 
        # create a directory within the top level test directory
2493
 
        if sys.platform in ('win32', 'cygwin'):
2494
 
            name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2495
 
            # windows is likely to have path-length limits so use a short name
2496
 
            name_prefix = name_prefix[-30:]
2497
 
        else:
2498
 
            name_prefix = re.sub('[/]', '_', self.id())
2499
 
        return name_prefix
2500
 
 
2501
2047
    def makeAndChdirToTestDir(self):
2502
2048
        """See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2503
 
 
 
2049
        
2504
2050
        For TestCaseInTempDir we create a temporary directory based on the test
2505
2051
        name and then create two subdirs - test and home under it.
2506
2052
        """
2507
 
        name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2508
 
            self._getTestDirPrefix())
2509
 
        name = name_prefix
2510
 
        for i in range(100):
2511
 
            if os.path.exists(name):
2512
 
                name = name_prefix + '_' + str(i)
2513
 
            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)
2518
 
                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()
 
2053
        # create a directory within the top level test directory
 
2054
        candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
 
2055
        # now create test and home directories within this dir
 
2056
        self.test_base_dir = candidate_dir
2526
2057
        self.test_home_dir = self.test_base_dir + '/home'
2527
2058
        os.mkdir(self.test_home_dir)
2528
2059
        self.test_dir = self.test_base_dir + '/work'
2534
2065
            f.write(self.id())
2535
2066
        finally:
2536
2067
            f.close()
 
2068
        self.addCleanup(self.deleteTestDir)
2537
2069
 
2538
2070
    def deleteTestDir(self):
2539
 
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2540
 
        _rmtree_temp_dir(self.test_base_dir, test_id=self.id())
 
2071
        os.chdir(self.TEST_ROOT)
 
2072
        _rmtree_temp_dir(self.test_base_dir)
2541
2073
 
2542
2074
    def build_tree(self, shape, line_endings='binary', transport=None):
2543
2075
        """Build a test tree according to a pattern.
2564
2096
        if transport is None or transport.is_readonly():
2565
2097
            transport = get_transport(".")
2566
2098
        for name in shape:
2567
 
            self.assertIsInstance(name, basestring)
 
2099
            self.assert_(isinstance(name, basestring))
2568
2100
            if name[-1] == '/':
2569
2101
                transport.mkdir(urlutils.escape(name[:-1]))
2570
2102
            else:
2587
2119
            tree = workingtree.WorkingTree.open(root_path)
2588
2120
        if not isinstance(path, basestring):
2589
2121
            for p in path:
2590
 
                self.assertInWorkingTree(p, tree=tree)
 
2122
                self.assertInWorkingTree(p,tree=tree)
2591
2123
        else:
2592
2124
            self.assertIsNot(tree.path2id(path), None,
2593
2125
                path+' not in working tree.')
2613
2145
    ReadonlyTransportDecorator is used instead which allows the use of non disk
2614
2146
    based read write transports.
2615
2147
 
2616
 
    If an explicit class is provided for readonly access, that server and the
 
2148
    If an explicit class is provided for readonly access, that server and the 
2617
2149
    readwrite one must both define get_url() as resolving to os.getcwd().
2618
2150
    """
2619
2151
 
2625
2157
        """
2626
2158
        if self.__vfs_server is None:
2627
2159
            self.__vfs_server = self.vfs_transport_factory()
2628
 
            self.start_server(self.__vfs_server)
 
2160
            self.__vfs_server.setUp()
 
2161
            self.addCleanup(self.__vfs_server.tearDown)
2629
2162
        return self.__vfs_server
2630
2163
 
2631
2164
    def make_branch_and_tree(self, relpath, format=None):
2638
2171
        repository will also be accessed locally. Otherwise a lightweight
2639
2172
        checkout is created and returned.
2640
2173
 
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
2174
        :param format: The BzrDirFormat.
2651
2175
        :returns: the WorkingTree.
2652
2176
        """
2661
2185
            # We can only make working trees locally at the moment.  If the
2662
2186
            # transport can't support them, then we keep the non-disk-backed
2663
2187
            # branch and create a local checkout.
2664
 
            if self.vfs_transport_factory is test_server.LocalURLServer:
 
2188
            if self.vfs_transport_factory is LocalURLServer:
2665
2189
                # the branch is colocated on disk, we cannot create a checkout.
2666
2190
                # hopefully callers will expect this.
2667
2191
                local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2668
 
                wt = local_controldir.create_workingtree()
2669
 
                if wt.branch._format != b._format:
2670
 
                    wt._branch = b
2671
 
                    # Make sure that assigning to wt._branch fixes wt.branch,
2672
 
                    # in case the implementation details of workingtree objects
2673
 
                    # change.
2674
 
                    self.assertIs(b, wt.branch)
2675
 
                return wt
 
2192
                return local_controldir.create_workingtree()
2676
2193
            else:
2677
2194
                return b.create_checkout(relpath, lightweight=True)
2678
2195
 
2704
2221
        super(TestCaseWithTransport, self).setUp()
2705
2222
        self.__vfs_server = None
2706
2223
 
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
2224
 
2716
2225
class ChrootedTestCase(TestCaseWithTransport):
2717
2226
    """A support class that provides readonly urls outside the local namespace.
2721
2230
    for readonly urls.
2722
2231
 
2723
2232
    TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2724
 
                       be used without needed to redo it when a different
 
2233
                       be used without needed to redo it when a different 
2725
2234
                       subclass is in use ?
2726
2235
    """
2727
2236
 
2728
2237
    def setUp(self):
2729
2238
        super(ChrootedTestCase, self).setUp()
2730
 
        if not self.vfs_transport_factory == memory.MemoryServer:
 
2239
        if not self.vfs_transport_factory == MemoryServer:
2731
2240
            self.transport_readonly_server = HttpServer
2732
2241
 
2733
2242
 
2734
2243
def condition_id_re(pattern):
2735
2244
    """Create a condition filter which performs a re check on a test's id.
2736
 
 
 
2245
    
2737
2246
    :param pattern: A regular expression string.
2738
2247
    :return: A callable that returns True if the re matches.
2739
2248
    """
2740
 
    filter_re = osutils.re_compile_checked(pattern, 0,
2741
 
        'test filter')
 
2249
    filter_re = re.compile(pattern)
2742
2250
    def condition(test):
2743
2251
        test_id = test.id()
2744
2252
        return filter_re.search(test_id)
2747
2255
 
2748
2256
def condition_isinstance(klass_or_klass_list):
2749
2257
    """Create a condition filter which returns isinstance(param, klass).
2750
 
 
 
2258
    
2751
2259
    :return: A callable which when called with one parameter obj return the
2752
2260
        result of isinstance(obj, klass_or_klass_list).
2753
2261
    """
2758
2266
 
2759
2267
def condition_id_in_list(id_list):
2760
2268
    """Create a condition filter which verify that test's id in a list.
2761
 
 
2762
 
    :param id_list: A TestIdList object.
 
2269
    
 
2270
    :param name: A TestIdList object.
2763
2271
    :return: A callable that returns True if the test's id appears in the list.
2764
2272
    """
2765
2273
    def condition(test):
2766
 
        return id_list.includes(test.id())
2767
 
    return condition
2768
 
 
2769
 
 
2770
 
def condition_id_startswith(starts):
2771
 
    """Create a condition filter verifying that test's id starts with a string.
2772
 
 
2773
 
    :param starts: A list of string.
2774
 
    :return: A callable that returns True if the test's id starts with one of
2775
 
        the given strings.
2776
 
    """
2777
 
    def condition(test):
2778
 
        for start in starts:
2779
 
            if test.id().startswith(start):
2780
 
                return True
2781
 
        return False
 
2274
        return id_list.test_in(test.id())
2782
2275
    return condition
2783
2276
 
2784
2277
 
2800
2293
 
2801
2294
def filter_suite_by_condition(suite, condition):
2802
2295
    """Create a test suite by filtering another one.
2803
 
 
 
2296
    
2804
2297
    :param suite: The source suite.
2805
2298
    :param condition: A callable whose result evaluates True when called with a
2806
2299
        test case which should be included in the result.
2807
2300
    :return: A suite which contains the tests found in suite that pass
2808
2301
        condition.
2809
 
    """
 
2302
    """ 
2810
2303
    result = []
2811
2304
    for test in iter_suite_tests(suite):
2812
2305
        if condition(test):
2814
2307
    return TestUtil.TestSuite(result)
2815
2308
 
2816
2309
 
2817
 
def filter_suite_by_re(suite, pattern):
 
2310
def filter_suite_by_re(suite, pattern, exclude_pattern=DEPRECATED_PARAMETER,
 
2311
                       random_order=DEPRECATED_PARAMETER):
2818
2312
    """Create a test suite by filtering another one.
2819
 
 
 
2313
    
2820
2314
    :param suite:           the source suite
2821
2315
    :param pattern:         pattern that names must match
 
2316
    :param exclude_pattern: A pattern that names must not match. This parameter
 
2317
        is deprecated as of bzrlib 1.0. Please use the separate function
 
2318
        exclude_tests_by_re instead.
 
2319
    :param random_order:    If True, tests in the new suite will be put in
 
2320
        random order. This parameter is deprecated as of bzrlib 1.0. Please
 
2321
        use the separate function randomize_suite instead.
2822
2322
    :returns: the newly created suite
2823
 
    """
 
2323
    """ 
 
2324
    if deprecated_passed(exclude_pattern):
 
2325
        symbol_versioning.warn(
 
2326
            one_zero % "passing exclude_pattern to filter_suite_by_re",
 
2327
                DeprecationWarning, stacklevel=2)
 
2328
        if exclude_pattern is not None:
 
2329
            suite = exclude_tests_by_re(suite, exclude_pattern)
2824
2330
    condition = condition_id_re(pattern)
2825
2331
    result_suite = filter_suite_by_condition(suite, condition)
 
2332
    if deprecated_passed(random_order):
 
2333
        symbol_versioning.warn(
 
2334
            one_zero % "passing random_order to filter_suite_by_re",
 
2335
                DeprecationWarning, stacklevel=2)
 
2336
        if random_order:
 
2337
            result_suite = randomize_suite(result_suite)
2826
2338
    return result_suite
2827
2339
 
2828
2340
 
2838
2350
    return result_suite
2839
2351
 
2840
2352
 
2841
 
def filter_suite_by_id_startswith(suite, start):
2842
 
    """Create a test suite by filtering another one.
2843
 
 
2844
 
    :param suite: The source suite.
2845
 
    :param start: A list of string the test id must start with one of.
2846
 
    :returns: the newly created suite
2847
 
    """
2848
 
    condition = condition_id_startswith(start)
2849
 
    result_suite = filter_suite_by_condition(suite, condition)
2850
 
    return result_suite
2851
 
 
2852
 
 
2853
2353
def exclude_tests_by_re(suite, pattern):
2854
2354
    """Create a test suite which excludes some tests from suite.
2855
2355
 
2874
2374
 
2875
2375
def randomize_suite(suite):
2876
2376
    """Return a new TestSuite with suite's tests in random order.
2877
 
 
 
2377
    
2878
2378
    The tests in the input suite are flattened into a single suite in order to
2879
2379
    accomplish this. Any nested TestSuites are removed to provide global
2880
2380
    randomness.
2884
2384
    return TestUtil.TestSuite(tests)
2885
2385
 
2886
2386
 
2887
 
def split_suite_by_condition(suite, condition):
2888
 
    """Split a test suite into two by a condition.
 
2387
@deprecated_function(one_zero)
 
2388
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
 
2389
                     random_order=False, append_rest=True):
 
2390
    """DEPRECATED: Create a test suite by sorting another one.
2889
2391
 
2890
 
    :param suite: The suite to split.
2891
 
    :param condition: The condition to match on. Tests that match this
2892
 
        condition are returned in the first test suite, ones that do not match
2893
 
        are in the second suite.
2894
 
    :return: A tuple of two test suites, where the first contains tests from
2895
 
        suite matching the condition, and the second contains the remainder
2896
 
        from suite. The order within each output suite is the same as it was in
2897
 
        suite.
2898
 
    """
2899
 
    matched = []
2900
 
    did_not_match = []
2901
 
    for test in iter_suite_tests(suite):
2902
 
        if condition(test):
2903
 
            matched.append(test)
2904
 
        else:
2905
 
            did_not_match.append(test)
2906
 
    return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
 
2392
    This method has been decomposed into separate helper methods that should be
 
2393
    called directly:
 
2394
     - filter_suite_by_re
 
2395
     - exclude_tests_by_re
 
2396
     - randomize_suite
 
2397
     - split_suite_by_re
 
2398
    
 
2399
    :param suite:           the source suite
 
2400
    :param pattern:         pattern that names must match in order to go
 
2401
                            first in the new suite
 
2402
    :param exclude_pattern: pattern that names must not match, if any
 
2403
    :param random_order:    if True, tests in the new suite will be put in
 
2404
                            random order (with all tests matching pattern
 
2405
                            first).
 
2406
    :param append_rest:     if False, pattern is a strict filter and not
 
2407
                            just an ordering directive
 
2408
    :returns: the newly created suite
 
2409
    """ 
 
2410
    if exclude_pattern is not None:
 
2411
        suite = exclude_tests_by_re(suite, exclude_pattern)
 
2412
    if random_order:
 
2413
        order_changer = randomize_suite
 
2414
    else:
 
2415
        order_changer = preserve_input
 
2416
    if append_rest:
 
2417
        suites = map(order_changer, split_suite_by_re(suite, pattern))
 
2418
        return TestUtil.TestSuite(suites)
 
2419
    else:
 
2420
        return order_changer(filter_suite_by_re(suite, pattern))
2907
2421
 
2908
2422
 
2909
2423
def split_suite_by_re(suite, pattern):
2910
2424
    """Split a test suite into two by a regular expression.
2911
 
 
 
2425
    
2912
2426
    :param suite: The suite to split.
2913
2427
    :param pattern: A regular expression string. Test ids that match this
2914
2428
        pattern will be in the first test suite returned, and the others in the
2917
2431
        suite matching pattern, and the second contains the remainder from
2918
2432
        suite. The order within each output suite is the same as it was in
2919
2433
        suite.
2920
 
    """
2921
 
    return split_suite_by_condition(suite, condition_id_re(pattern))
 
2434
    """ 
 
2435
    matched = []
 
2436
    did_not_match = []
 
2437
    filter_re = re.compile(pattern)
 
2438
    for test in iter_suite_tests(suite):
 
2439
        test_id = test.id()
 
2440
        if filter_re.search(test_id):
 
2441
            matched.append(test)
 
2442
        else:
 
2443
            did_not_match.append(test)
 
2444
    return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2922
2445
 
2923
2446
 
2924
2447
def run_suite(suite, name='test', verbose=False, pattern=".*",
2928
2451
              list_only=False,
2929
2452
              random_seed=None,
2930
2453
              exclude_pattern=None,
2931
 
              strict=False,
2932
 
              runner_class=None,
2933
 
              suite_decorators=None,
2934
 
              stream=None,
2935
 
              result_decorators=None,
2936
 
              ):
2937
 
    """Run a test suite for bzr selftest.
2938
 
 
2939
 
    :param runner_class: The class of runner to use. Must support the
2940
 
        constructor arguments passed by run_suite which are more than standard
2941
 
        python uses.
2942
 
    :return: A boolean indicating success.
2943
 
    """
 
2454
              strict=False):
2944
2455
    TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2945
2456
    if verbose:
2946
2457
        verbosity = 2
2947
2458
    else:
2948
2459
        verbosity = 1
2949
 
    if runner_class is None:
2950
 
        runner_class = TextTestRunner
2951
 
    if stream is None:
2952
 
        stream = sys.stdout
2953
 
    runner = runner_class(stream=stream,
 
2460
    runner = TextTestRunner(stream=sys.stdout,
2954
2461
                            descriptions=0,
2955
2462
                            verbosity=verbosity,
2956
2463
                            bench_history=bench_history,
2957
 
                            strict=strict,
2958
 
                            result_decorators=result_decorators,
 
2464
                            list_only=list_only,
2959
2465
                            )
2960
2466
    runner.stop_on_failure=stop_on_failure
2961
 
    # built in decorator factories:
2962
 
    decorators = [
2963
 
        random_order(random_seed, runner),
2964
 
        exclude_tests(exclude_pattern),
2965
 
        ]
2966
 
    if matching_tests_first:
2967
 
        decorators.append(tests_first(pattern))
 
2467
    # Initialise the random number generator and display the seed used.
 
2468
    # We convert the seed to a long to make it reuseable across invocations.
 
2469
    random_order = False
 
2470
    if random_seed is not None:
 
2471
        random_order = True
 
2472
        if random_seed == "now":
 
2473
            random_seed = long(time.time())
 
2474
        else:
 
2475
            # Convert the seed to a long if we can
 
2476
            try:
 
2477
                random_seed = long(random_seed)
 
2478
            except:
 
2479
                pass
 
2480
        runner.stream.writeln("Randomizing test order using seed %s\n" %
 
2481
            (random_seed))
 
2482
        random.seed(random_seed)
 
2483
    # Customise the list of tests if requested
 
2484
    if exclude_pattern is not None:
 
2485
        suite = exclude_tests_by_re(suite, exclude_pattern)
 
2486
    if random_order:
 
2487
        order_changer = randomize_suite
2968
2488
    else:
2969
 
        decorators.append(filter_tests(pattern))
2970
 
    if suite_decorators:
2971
 
        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
 
    for decorator in decorators:
2978
 
        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
 
2489
        order_changer = preserve_input
 
2490
    if pattern != '.*' or random_order:
 
2491
        if matching_tests_first:
 
2492
            suites = map(order_changer, split_suite_by_re(suite, pattern))
 
2493
            suite = TestUtil.TestSuite(suites)
 
2494
        else:
 
2495
            suite = order_changer(filter_suite_by_re(suite, pattern))
 
2496
 
2987
2497
    result = runner.run(suite)
 
2498
 
2988
2499
    if strict:
2989
2500
        return result.wasStrictlySuccessful()
2990
 
    else:
2991
 
        return result.wasSuccessful()
2992
 
 
2993
 
 
2994
 
# A registry where get() returns a suite decorator.
2995
 
parallel_registry = registry.Registry()
2996
 
 
2997
 
 
2998
 
def fork_decorator(suite):
2999
 
    concurrency = osutils.local_concurrency()
3000
 
    if concurrency == 1:
3001
 
        return suite
3002
 
    from testtools import ConcurrentTestSuite
3003
 
    return ConcurrentTestSuite(suite, fork_for_tests)
3004
 
parallel_registry.register('fork', fork_decorator)
3005
 
 
3006
 
 
3007
 
def subprocess_decorator(suite):
3008
 
    concurrency = osutils.local_concurrency()
3009
 
    if concurrency == 1:
3010
 
        return suite
3011
 
    from testtools import ConcurrentTestSuite
3012
 
    return ConcurrentTestSuite(suite, reinvoke_for_tests)
3013
 
parallel_registry.register('subprocess', subprocess_decorator)
3014
 
 
3015
 
 
3016
 
def exclude_tests(exclude_pattern):
3017
 
    """Return a test suite decorator that excludes tests."""
3018
 
    if exclude_pattern is None:
3019
 
        return identity_decorator
3020
 
    def decorator(suite):
3021
 
        return ExcludeDecorator(suite, exclude_pattern)
3022
 
    return decorator
3023
 
 
3024
 
 
3025
 
def filter_tests(pattern):
3026
 
    if pattern == '.*':
3027
 
        return identity_decorator
3028
 
    def decorator(suite):
3029
 
        return FilterTestsDecorator(suite, pattern)
3030
 
    return decorator
3031
 
 
3032
 
 
3033
 
def random_order(random_seed, runner):
3034
 
    """Return a test suite decorator factory for randomising tests order.
3035
 
    
3036
 
    :param random_seed: now, a string which casts to a long, or a long.
3037
 
    :param runner: A test runner with a stream attribute to report on.
3038
 
    """
3039
 
    if random_seed is None:
3040
 
        return identity_decorator
3041
 
    def decorator(suite):
3042
 
        return RandomDecorator(suite, random_seed, runner.stream)
3043
 
    return decorator
3044
 
 
3045
 
 
3046
 
def tests_first(pattern):
3047
 
    if pattern == '.*':
3048
 
        return identity_decorator
3049
 
    def decorator(suite):
3050
 
        return TestFirstDecorator(suite, pattern)
3051
 
    return decorator
3052
 
 
3053
 
 
3054
 
def identity_decorator(suite):
3055
 
    """Return suite."""
3056
 
    return suite
3057
 
 
3058
 
 
3059
 
class TestDecorator(TestSuite):
3060
 
    """A decorator for TestCase/TestSuite objects.
3061
 
    
3062
 
    Usually, subclasses should override __iter__(used when flattening test
3063
 
    suites), which we do to filter, reorder, parallelise and so on, run() and
3064
 
    debug().
3065
 
    """
3066
 
 
3067
 
    def __init__(self, suite):
3068
 
        TestSuite.__init__(self)
3069
 
        self.addTest(suite)
3070
 
 
3071
 
    def countTestCases(self):
3072
 
        cases = 0
3073
 
        for test in self:
3074
 
            cases += test.countTestCases()
3075
 
        return cases
3076
 
 
3077
 
    def debug(self):
3078
 
        for test in self:
3079
 
            test.debug()
3080
 
 
3081
 
    def run(self, result):
3082
 
        # Use iteration on self, not self._tests, to allow subclasses to hook
3083
 
        # into __iter__.
3084
 
        for test in self:
3085
 
            if result.shouldStop:
3086
 
                break
3087
 
            test.run(result)
3088
 
        return result
3089
 
 
3090
 
 
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
 
class ExcludeDecorator(TestDecorator):
3102
 
    """A decorator which excludes test matching an exclude pattern."""
3103
 
 
3104
 
    def __init__(self, suite, exclude_pattern):
3105
 
        TestDecorator.__init__(self, suite)
3106
 
        self.exclude_pattern = exclude_pattern
3107
 
        self.excluded = False
3108
 
 
3109
 
    def __iter__(self):
3110
 
        if self.excluded:
3111
 
            return iter(self._tests)
3112
 
        self.excluded = True
3113
 
        suite = exclude_tests_by_re(self, self.exclude_pattern)
3114
 
        del self._tests[:]
3115
 
        self.addTests(suite)
3116
 
        return iter(self._tests)
3117
 
 
3118
 
 
3119
 
class FilterTestsDecorator(TestDecorator):
3120
 
    """A decorator which filters tests to those matching a pattern."""
3121
 
 
3122
 
    def __init__(self, suite, pattern):
3123
 
        TestDecorator.__init__(self, suite)
3124
 
        self.pattern = pattern
3125
 
        self.filtered = False
3126
 
 
3127
 
    def __iter__(self):
3128
 
        if self.filtered:
3129
 
            return iter(self._tests)
3130
 
        self.filtered = True
3131
 
        suite = filter_suite_by_re(self, self.pattern)
3132
 
        del self._tests[:]
3133
 
        self.addTests(suite)
3134
 
        return iter(self._tests)
3135
 
 
3136
 
 
3137
 
class RandomDecorator(TestDecorator):
3138
 
    """A decorator which randomises the order of its tests."""
3139
 
 
3140
 
    def __init__(self, suite, random_seed, stream):
3141
 
        TestDecorator.__init__(self, suite)
3142
 
        self.random_seed = random_seed
3143
 
        self.randomised = False
3144
 
        self.stream = stream
3145
 
 
3146
 
    def __iter__(self):
3147
 
        if self.randomised:
3148
 
            return iter(self._tests)
3149
 
        self.randomised = True
3150
 
        self.stream.write("Randomizing test order using seed %s\n\n" %
3151
 
            (self.actual_seed()))
3152
 
        # Initialise the random number generator.
3153
 
        random.seed(self.actual_seed())
3154
 
        suite = randomize_suite(self)
3155
 
        del self._tests[:]
3156
 
        self.addTests(suite)
3157
 
        return iter(self._tests)
3158
 
 
3159
 
    def actual_seed(self):
3160
 
        if self.random_seed == "now":
3161
 
            # We convert the seed to a long to make it reuseable across
3162
 
            # invocations (because the user can reenter it).
3163
 
            self.random_seed = long(time.time())
3164
 
        else:
3165
 
            # Convert the seed to a long if we can
3166
 
            try:
3167
 
                self.random_seed = long(self.random_seed)
3168
 
            except:
3169
 
                pass
3170
 
        return self.random_seed
3171
 
 
3172
 
 
3173
 
class TestFirstDecorator(TestDecorator):
3174
 
    """A decorator which moves named tests to the front."""
3175
 
 
3176
 
    def __init__(self, suite, pattern):
3177
 
        TestDecorator.__init__(self, suite)
3178
 
        self.pattern = pattern
3179
 
        self.filtered = False
3180
 
 
3181
 
    def __iter__(self):
3182
 
        if self.filtered:
3183
 
            return iter(self._tests)
3184
 
        self.filtered = True
3185
 
        suites = split_suite_by_re(self, self.pattern)
3186
 
        del self._tests[:]
3187
 
        self.addTests(suites)
3188
 
        return iter(self._tests)
3189
 
 
3190
 
 
3191
 
def partition_tests(suite, count):
3192
 
    """Partition suite into count lists of tests."""
3193
 
    result = []
3194
 
    tests = list(iter_suite_tests(suite))
3195
 
    tests_per_process = int(math.ceil(float(len(tests)) / count))
3196
 
    for block in range(count):
3197
 
        low_test = block * tests_per_process
3198
 
        high_test = low_test + tests_per_process
3199
 
        process_tests = tests[low_test:high_test]
3200
 
        result.append(process_tests)
3201
 
    return result
3202
 
 
3203
 
 
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
 
def fork_for_tests(suite):
3218
 
    """Take suite and start up one runner per CPU by forking()
3219
 
 
3220
 
    :return: An iterable of TestCase-like objects which can each have
3221
 
        run(result) called on them to feed tests to result.
3222
 
    """
3223
 
    concurrency = osutils.local_concurrency()
3224
 
    result = []
3225
 
    from subunit import TestProtocolClient, ProtocolTestCase
3226
 
    from subunit.test_results import AutoTimingTestResultDecorator
3227
 
    class TestInOtherProcess(ProtocolTestCase):
3228
 
        # Should be in subunit, I think. RBC.
3229
 
        def __init__(self, stream, pid):
3230
 
            ProtocolTestCase.__init__(self, stream)
3231
 
            self.pid = pid
3232
 
 
3233
 
        def run(self, result):
3234
 
            try:
3235
 
                ProtocolTestCase.run(self, result)
3236
 
            finally:
3237
 
                os.waitpid(self.pid, 0)
3238
 
 
3239
 
    test_blocks = partition_tests(suite, concurrency)
3240
 
    for process_tests in test_blocks:
3241
 
        process_suite = TestSuite()
3242
 
        process_suite.addTests(process_tests)
3243
 
        c2pread, c2pwrite = os.pipe()
3244
 
        pid = os.fork()
3245
 
        if pid == 0:
3246
 
            workaround_zealous_crypto_random()
3247
 
            try:
3248
 
                os.close(c2pread)
3249
 
                # Leave stderr and stdout open so we can see test noise
3250
 
                # Close stdin so that the child goes away if it decides to
3251
 
                # read from stdin (otherwise its a roulette to see what
3252
 
                # child actually gets keystrokes for pdb etc).
3253
 
                sys.stdin.close()
3254
 
                sys.stdin = None
3255
 
                stream = os.fdopen(c2pwrite, 'wb', 1)
3256
 
                subunit_result = AutoTimingTestResultDecorator(
3257
 
                    TestProtocolClient(stream))
3258
 
                process_suite.run(subunit_result)
3259
 
            finally:
3260
 
                os._exit(0)
3261
 
        else:
3262
 
            os.close(c2pwrite)
3263
 
            stream = os.fdopen(c2pread, 'rb', 1)
3264
 
            test = TestInOtherProcess(stream, pid)
3265
 
            result.append(test)
3266
 
    return result
3267
 
 
3268
 
 
3269
 
def reinvoke_for_tests(suite):
3270
 
    """Take suite and start up one runner per CPU using subprocess().
3271
 
 
3272
 
    :return: An iterable of TestCase-like objects which can each have
3273
 
        run(result) called on them to feed tests to result.
3274
 
    """
3275
 
    concurrency = osutils.local_concurrency()
3276
 
    result = []
3277
 
    from subunit import ProtocolTestCase
3278
 
    class TestInSubprocess(ProtocolTestCase):
3279
 
        def __init__(self, process, name):
3280
 
            ProtocolTestCase.__init__(self, process.stdout)
3281
 
            self.process = process
3282
 
            self.process.stdin.close()
3283
 
            self.name = name
3284
 
 
3285
 
        def run(self, result):
3286
 
            try:
3287
 
                ProtocolTestCase.run(self, result)
3288
 
            finally:
3289
 
                self.process.wait()
3290
 
                os.unlink(self.name)
3291
 
            # print "pid %d finished" % finished_process
3292
 
    test_blocks = partition_tests(suite, concurrency)
3293
 
    for process_tests in test_blocks:
3294
 
        # ugly; currently reimplement rather than reuses TestCase methods.
3295
 
        bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3296
 
        if not os.path.isfile(bzr_path):
3297
 
            # We are probably installed. Assume sys.argv is the right file
3298
 
            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
 
        fd, test_list_file_name = tempfile.mkstemp()
3304
 
        test_list_file = os.fdopen(fd, 'wb', 1)
3305
 
        for test in process_tests:
3306
 
            test_list_file.write(test.id() + '\n')
3307
 
        test_list_file.close()
3308
 
        try:
3309
 
            argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3310
 
                '--subunit']
3311
 
            if '--no-plugins' in sys.argv:
3312
 
                argv.append('--no-plugins')
3313
 
            # stderr=STDOUT would be ideal, but until we prevent noise on
3314
 
            # stderr it can interrupt the subunit protocol.
3315
 
            process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3316
 
                bufsize=1)
3317
 
            test = TestInSubprocess(process, test_list_file_name)
3318
 
            result.append(test)
3319
 
        except:
3320
 
            os.unlink(test_list_file_name)
3321
 
            raise
3322
 
    return result
3323
 
 
3324
 
 
3325
 
class ForwardingResult(unittest.TestResult):
3326
 
 
3327
 
    def __init__(self, target):
3328
 
        unittest.TestResult.__init__(self)
3329
 
        self.result = target
3330
 
 
3331
 
    def startTest(self, test):
3332
 
        self.result.startTest(test)
3333
 
 
3334
 
    def stopTest(self, test):
3335
 
        self.result.stopTest(test)
3336
 
 
3337
 
    def startTestRun(self):
3338
 
        self.result.startTestRun()
3339
 
 
3340
 
    def stopTestRun(self):
3341
 
        self.result.stopTestRun()
3342
 
 
3343
 
    def addSkip(self, test, reason):
3344
 
        self.result.addSkip(test, reason)
3345
 
 
3346
 
    def addSuccess(self, test):
3347
 
        self.result.addSuccess(test)
3348
 
 
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
3387
 
 
3388
 
 
3389
 
# 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
 
selftest_debug_flags = set()
 
2501
 
 
2502
    return result.wasSuccessful()
3398
2503
 
3399
2504
 
3400
2505
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3408
2513
             exclude_pattern=None,
3409
2514
             strict=False,
3410
2515
             load_list=None,
3411
 
             debug_flags=None,
3412
 
             starting_with=None,
3413
 
             runner_class=None,
3414
 
             suite_decorators=None,
3415
 
             stream=None,
3416
 
             lsprof_tests=False,
3417
2516
             ):
3418
2517
    """Run the whole test suite under the enhanced runner"""
3419
2518
    # XXX: Very ugly way to do this...
3427
2526
        transport = default_transport
3428
2527
    old_transport = default_transport
3429
2528
    default_transport = transport
3430
 
    global selftest_debug_flags
3431
 
    old_debug_flags = selftest_debug_flags
3432
 
    if debug_flags is not None:
3433
 
        selftest_debug_flags = set(debug_flags)
3434
2529
    try:
3435
2530
        if load_list is None:
3436
2531
            keep_only = None
3437
2532
        else:
3438
2533
            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
2534
        if test_suite_factory is None:
3443
 
            # Reduce loading time by loading modules based on the starting_with
3444
 
            # patterns.
3445
 
            suite = test_suite(keep_only, starting_with)
 
2535
            suite = test_suite(keep_only)
3446
2536
        else:
3447
2537
            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
2538
        return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3455
2539
                     stop_on_failure=stop_on_failure,
3456
2540
                     transport=transport,
3460
2544
                     list_only=list_only,
3461
2545
                     random_seed=random_seed,
3462
2546
                     exclude_pattern=exclude_pattern,
3463
 
                     strict=strict,
3464
 
                     runner_class=runner_class,
3465
 
                     suite_decorators=suite_decorators,
3466
 
                     stream=stream,
3467
 
                     result_decorators=result_decorators,
3468
 
                     )
 
2547
                     strict=strict)
3469
2548
    finally:
3470
2549
        default_transport = old_transport
3471
 
        selftest_debug_flags = old_debug_flags
3472
2550
 
3473
2551
 
3474
2552
def load_test_id_list(file_name):
3494
2572
    return test_list
3495
2573
 
3496
2574
 
3497
 
def suite_matches_id_list(test_suite, id_list):
3498
 
    """Warns about tests not appearing or appearing more than once.
3499
 
 
3500
 
    :param test_suite: A TestSuite object.
3501
 
    :param test_id_list: The list of test ids that should be found in
3502
 
         test_suite.
3503
 
 
3504
 
    :return: (absents, duplicates) absents is a list containing the test found
3505
 
        in id_list but not in test_suite, duplicates is a list containing the
3506
 
        test found multiple times in test_suite.
3507
 
 
3508
 
    When using a prefined test id list, it may occurs that some tests do not
3509
 
    exist anymore or that some tests use the same id. This function warns the
3510
 
    tester about potential problems in his workflow (test lists are volatile)
3511
 
    or in the test suite itself (using the same id for several tests does not
3512
 
    help to localize defects).
3513
 
    """
3514
 
    # Build a dict counting id occurrences
3515
 
    tests = dict()
3516
 
    for test in iter_suite_tests(test_suite):
3517
 
        id = test.id()
3518
 
        tests[id] = tests.get(id, 0) + 1
3519
 
 
3520
 
    not_found = []
3521
 
    duplicates = []
3522
 
    for id in id_list:
3523
 
        occurs = tests.get(id, 0)
3524
 
        if not occurs:
3525
 
            not_found.append(id)
3526
 
        elif occurs > 1:
3527
 
            duplicates.append(id)
3528
 
 
3529
 
    return not_found, duplicates
3530
 
 
3531
 
 
3532
2575
class TestIdList(object):
3533
2576
    """Test id list to filter a test suite.
3534
2577
 
3565
2608
                modules[mod_name] = True
3566
2609
        self.modules = modules
3567
2610
 
3568
 
    def refers_to(self, module_name):
 
2611
    def is_module_name_used(self, module_name):
3569
2612
        """Is there tests for the module or one of its sub modules."""
3570
2613
        return self.modules.has_key(module_name)
3571
2614
 
3572
 
    def includes(self, test_id):
 
2615
    def test_in(self, test_id):
3573
2616
        return self.tests.has_key(test_id)
3574
2617
 
3575
2618
 
3576
 
class TestPrefixAliasRegistry(registry.Registry):
3577
 
    """A registry for test prefix aliases.
3578
 
 
3579
 
    This helps implement shorcuts for the --starting-with selftest
3580
 
    option. Overriding existing prefixes is not allowed but not fatal (a
3581
 
    warning will be emitted).
3582
 
    """
3583
 
 
3584
 
    def register(self, key, obj, help=None, info=None,
3585
 
                 override_existing=False):
3586
 
        """See Registry.register.
3587
 
 
3588
 
        Trying to override an existing alias causes a warning to be emitted,
3589
 
        not a fatal execption.
3590
 
        """
3591
 
        try:
3592
 
            super(TestPrefixAliasRegistry, self).register(
3593
 
                key, obj, help=help, info=info, override_existing=False)
3594
 
        except KeyError:
3595
 
            actual = self.get(key)
3596
 
            note('Test prefix alias %s is already used for %s, ignoring %s'
3597
 
                 % (key, actual, obj))
3598
 
 
3599
 
    def resolve_alias(self, id_start):
3600
 
        """Replace the alias by the prefix in the given string.
3601
 
 
3602
 
        Using an unknown prefix is an error to help catching typos.
3603
 
        """
3604
 
        parts = id_start.split('.')
3605
 
        try:
3606
 
            parts[0] = self.get(parts[0])
3607
 
        except KeyError:
3608
 
            raise errors.BzrCommandError(
3609
 
                '%s is not a known test prefix alias' % parts[0])
3610
 
        return '.'.join(parts)
3611
 
 
3612
 
 
3613
 
test_prefix_alias_registry = TestPrefixAliasRegistry()
3614
 
"""Registry of test prefix aliases."""
3615
 
 
3616
 
 
3617
 
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3618
 
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3619
 
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3620
 
 
3621
 
# Obvious highest levels prefixes, feel free to add your own via a plugin
3622
 
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3623
 
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3624
 
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3625
 
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3626
 
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3627
 
 
3628
 
 
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
 
def test_suite(keep_only=None, starting_with=None):
 
2619
def test_suite(keep_only=None):
3845
2620
    """Build and return TestSuite for the whole of bzrlib.
3846
2621
 
3847
2622
    :param keep_only: A list of test ids limiting the suite returned.
3848
2623
 
3849
 
    :param starting_with: An id limiting the suite returned to the tests
3850
 
         starting with it.
3851
 
 
3852
2624
    This function can be replaced if you need to change the default test
3853
2625
    suite on a global basis, but it is not encouraged.
3854
2626
    """
3855
 
 
 
2627
    testmod_names = [
 
2628
                   'bzrlib.util.tests.test_bencode',
 
2629
                   'bzrlib.tests.test__dirstate_helpers',
 
2630
                   'bzrlib.tests.test_ancestry',
 
2631
                   'bzrlib.tests.test_annotate',
 
2632
                   'bzrlib.tests.test_api',
 
2633
                   'bzrlib.tests.test_atomicfile',
 
2634
                   'bzrlib.tests.test_bad_files',
 
2635
                   'bzrlib.tests.test_bisect_multi',
 
2636
                   'bzrlib.tests.test_branch',
 
2637
                   'bzrlib.tests.test_branchbuilder',
 
2638
                   'bzrlib.tests.test_bugtracker',
 
2639
                   'bzrlib.tests.test_bundle',
 
2640
                   'bzrlib.tests.test_bzrdir',
 
2641
                   'bzrlib.tests.test_cache_utf8',
 
2642
                   'bzrlib.tests.test_commands',
 
2643
                   'bzrlib.tests.test_commit',
 
2644
                   'bzrlib.tests.test_commit_merge',
 
2645
                   'bzrlib.tests.test_config',
 
2646
                   'bzrlib.tests.test_conflicts',
 
2647
                   'bzrlib.tests.test_counted_lock',
 
2648
                   'bzrlib.tests.test_decorators',
 
2649
                   'bzrlib.tests.test_delta',
 
2650
                   'bzrlib.tests.test_deprecated_graph',
 
2651
                   'bzrlib.tests.test_diff',
 
2652
                   'bzrlib.tests.test_dirstate',
 
2653
                   'bzrlib.tests.test_email_message',
 
2654
                   'bzrlib.tests.test_errors',
 
2655
                   'bzrlib.tests.test_escaped_store',
 
2656
                   'bzrlib.tests.test_extract',
 
2657
                   'bzrlib.tests.test_fetch',
 
2658
                   'bzrlib.tests.test_ftp_transport',
 
2659
                   'bzrlib.tests.test_generate_docs',
 
2660
                   'bzrlib.tests.test_generate_ids',
 
2661
                   'bzrlib.tests.test_globbing',
 
2662
                   'bzrlib.tests.test_gpg',
 
2663
                   'bzrlib.tests.test_graph',
 
2664
                   'bzrlib.tests.test_hashcache',
 
2665
                   'bzrlib.tests.test_help',
 
2666
                   'bzrlib.tests.test_hooks',
 
2667
                   'bzrlib.tests.test_http',
 
2668
                   'bzrlib.tests.test_http_implementations',
 
2669
                   'bzrlib.tests.test_http_response',
 
2670
                   'bzrlib.tests.test_https_ca_bundle',
 
2671
                   'bzrlib.tests.test_identitymap',
 
2672
                   'bzrlib.tests.test_ignores',
 
2673
                   'bzrlib.tests.test_index',
 
2674
                   'bzrlib.tests.test_info',
 
2675
                   'bzrlib.tests.test_inv',
 
2676
                   'bzrlib.tests.test_knit',
 
2677
                   'bzrlib.tests.test_lazy_import',
 
2678
                   'bzrlib.tests.test_lazy_regex',
 
2679
                   'bzrlib.tests.test_lockdir',
 
2680
                   'bzrlib.tests.test_lockable_files',
 
2681
                   'bzrlib.tests.test_log',
 
2682
                   'bzrlib.tests.test_lsprof',
 
2683
                   'bzrlib.tests.test_lru_cache',
 
2684
                   'bzrlib.tests.test_mail_client',
 
2685
                   'bzrlib.tests.test_memorytree',
 
2686
                   'bzrlib.tests.test_merge',
 
2687
                   'bzrlib.tests.test_merge3',
 
2688
                   'bzrlib.tests.test_merge_core',
 
2689
                   'bzrlib.tests.test_merge_directive',
 
2690
                   'bzrlib.tests.test_missing',
 
2691
                   'bzrlib.tests.test_msgeditor',
 
2692
                   'bzrlib.tests.test_multiparent',
 
2693
                   'bzrlib.tests.test_nonascii',
 
2694
                   'bzrlib.tests.test_options',
 
2695
                   'bzrlib.tests.test_osutils',
 
2696
                   'bzrlib.tests.test_osutils_encodings',
 
2697
                   'bzrlib.tests.test_pack',
 
2698
                   'bzrlib.tests.test_patch',
 
2699
                   'bzrlib.tests.test_patches',
 
2700
                   'bzrlib.tests.test_permissions',
 
2701
                   'bzrlib.tests.test_plugins',
 
2702
                   'bzrlib.tests.test_progress',
 
2703
                   'bzrlib.tests.test_reconfigure',
 
2704
                   'bzrlib.tests.test_reconcile',
 
2705
                   'bzrlib.tests.test_registry',
 
2706
                   'bzrlib.tests.test_remote',
 
2707
                   'bzrlib.tests.test_repository',
 
2708
                   'bzrlib.tests.test_revert',
 
2709
                   'bzrlib.tests.test_revision',
 
2710
                   'bzrlib.tests.test_revisionnamespaces',
 
2711
                   'bzrlib.tests.test_revisiontree',
 
2712
                   'bzrlib.tests.test_rio',
 
2713
                   'bzrlib.tests.test_sampler',
 
2714
                   'bzrlib.tests.test_selftest',
 
2715
                   'bzrlib.tests.test_setup',
 
2716
                   'bzrlib.tests.test_sftp_transport',
 
2717
                   'bzrlib.tests.test_smart',
 
2718
                   'bzrlib.tests.test_smart_add',
 
2719
                   'bzrlib.tests.test_smart_transport',
 
2720
                   'bzrlib.tests.test_smtp_connection',
 
2721
                   'bzrlib.tests.test_source',
 
2722
                   'bzrlib.tests.test_ssh_transport',
 
2723
                   'bzrlib.tests.test_status',
 
2724
                   'bzrlib.tests.test_store',
 
2725
                   'bzrlib.tests.test_strace',
 
2726
                   'bzrlib.tests.test_subsume',
 
2727
                   'bzrlib.tests.test_switch',
 
2728
                   'bzrlib.tests.test_symbol_versioning',
 
2729
                   'bzrlib.tests.test_tag',
 
2730
                   'bzrlib.tests.test_testament',
 
2731
                   'bzrlib.tests.test_textfile',
 
2732
                   'bzrlib.tests.test_textmerge',
 
2733
                   'bzrlib.tests.test_timestamp',
 
2734
                   'bzrlib.tests.test_trace',
 
2735
                   'bzrlib.tests.test_transactions',
 
2736
                   'bzrlib.tests.test_transform',
 
2737
                   'bzrlib.tests.test_transport',
 
2738
                   'bzrlib.tests.test_tree',
 
2739
                   'bzrlib.tests.test_treebuilder',
 
2740
                   'bzrlib.tests.test_tsort',
 
2741
                   'bzrlib.tests.test_tuned_gzip',
 
2742
                   'bzrlib.tests.test_ui',
 
2743
                   'bzrlib.tests.test_upgrade',
 
2744
                   'bzrlib.tests.test_urlutils',
 
2745
                   'bzrlib.tests.test_versionedfile',
 
2746
                   'bzrlib.tests.test_version',
 
2747
                   'bzrlib.tests.test_version_info',
 
2748
                   'bzrlib.tests.test_weave',
 
2749
                   'bzrlib.tests.test_whitebox',
 
2750
                   'bzrlib.tests.test_win32utils',
 
2751
                   'bzrlib.tests.test_workingtree',
 
2752
                   'bzrlib.tests.test_workingtree_4',
 
2753
                   'bzrlib.tests.test_wsgi',
 
2754
                   'bzrlib.tests.test_xml',
 
2755
                   ]
 
2756
    test_transport_implementations = [
 
2757
        'bzrlib.tests.test_transport_implementations',
 
2758
        'bzrlib.tests.test_read_bundle',
 
2759
        ]
 
2760
    suite = TestUtil.TestSuite()
3856
2761
    loader = TestUtil.TestLoader()
3857
2762
 
3858
2763
    if keep_only is not None:
3859
2764
        id_filter = TestIdList(keep_only)
3860
 
    if starting_with:
3861
 
        # We take precedence over keep_only because *at loading time* using
3862
 
        # both options means we will load less tests for the same final result.
3863
 
        def interesting_module(name):
3864
 
            for start in starting_with:
3865
 
                if (
3866
 
                    # Either the module name starts with the specified string
3867
 
                    name.startswith(start)
3868
 
                    # or it may contain tests starting with the specified string
3869
 
                    or start.startswith(name)
3870
 
                    ):
3871
 
                    return True
3872
 
            return False
3873
 
        loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3874
 
 
3875
 
    elif keep_only is not None:
3876
 
        loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3877
 
        def interesting_module(name):
3878
 
            return id_filter.refers_to(name)
3879
 
 
3880
 
    else:
3881
 
        loader = TestUtil.TestLoader()
3882
 
        def interesting_module(name):
3883
 
            # No filtering, all modules are interesting
3884
 
            return True
3885
 
 
3886
 
    suite = loader.suiteClass()
3887
2765
 
3888
2766
    # 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():
3892
 
        if not interesting_module(mod):
3893
 
            # No tests to keep here, move along
3894
 
            continue
 
2767
    if keep_only is None:
 
2768
        suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
 
2769
    else:
 
2770
        for mod in [m for m in testmod_names
 
2771
                    if id_filter.is_module_name_used(m)]:
 
2772
            mod_suite = loader.loadTestsFromModuleNames([mod])
 
2773
            mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
 
2774
            suite.addTest(mod_suite)
 
2775
 
 
2776
    # modules adapted for transport implementations
 
2777
    from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
 
2778
    adapter = TransportTestProviderAdapter()
 
2779
    if keep_only is None:
 
2780
        adapt_modules(test_transport_implementations, adapter, loader, suite)
 
2781
    else:
 
2782
        for mod in [m for m in test_transport_implementations
 
2783
                    if id_filter.is_module_name_used(m)]:
 
2784
            mod_suite = TestUtil.TestSuite()
 
2785
            adapt_modules([mod], adapter, loader, mod_suite)
 
2786
            mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
 
2787
            suite.addTest(mod_suite)
 
2788
 
 
2789
    # modules defining their own test_suite()
 
2790
    for package in [p for p in packages_to_test()
 
2791
                    if (keep_only is None
 
2792
                        or id_filter.is_module_name_used(p.__name__))]:
 
2793
        pack_suite = package.test_suite()
 
2794
        if keep_only is not None:
 
2795
            pack_suite = filter_suite_by_id_list(pack_suite, id_filter)
 
2796
        suite.addTest(pack_suite)
 
2797
 
 
2798
    # XXX: MODULES_TO_TEST should be obsoleted ?
 
2799
    for mod in [m for m in MODULES_TO_TEST
 
2800
                if keep_only is None or id_filter.is_module_name_used(m)]:
 
2801
        mod_suite = loader.loadTestsFromModule(mod)
 
2802
        if keep_only is not None:
 
2803
            mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
 
2804
        suite.addTest(mod_suite)
 
2805
 
 
2806
    for mod in MODULES_TO_DOCTEST:
3895
2807
        try:
3896
 
            # note that this really does mean "report only" -- doctest
3897
 
            # still runs the rest of the examples
3898
 
            doc_suite = doctest.DocTestSuite(mod,
3899
 
                optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
 
2808
            doc_suite = doctest.DocTestSuite(mod)
3900
2809
        except ValueError, e:
3901
2810
            print '**failed to get doctest for: %s\n%s' % (mod, e)
3902
2811
            raise
3903
 
        if len(doc_suite._tests) == 0:
3904
 
            raise errors.BzrError("no doctests found in %s" % (mod,))
 
2812
        if keep_only is not None:
 
2813
            # DocTests may use ids which doesn't contain the module name
 
2814
            doc_suite = filter_suite_by_id_list(doc_suite, id_filter)
3905
2815
        suite.addTest(doc_suite)
3906
2816
 
3907
2817
    default_encoding = sys.getdefaultencoding()
3908
 
    for name, plugin in bzrlib.plugin.plugins().items():
3909
 
        if not interesting_module(plugin.module.__name__):
3910
 
            continue
3911
 
        plugin_suite = plugin.test_suite()
3912
 
        # We used to catch ImportError here and turn it into just a warning,
3913
 
        # but really if you don't have --no-plugins this should be a failure.
3914
 
        # mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3915
 
        if plugin_suite is None:
3916
 
            plugin_suite = plugin.load_plugin_tests(loader)
3917
 
        if plugin_suite is not None:
3918
 
            suite.addTest(plugin_suite)
 
2818
    for name, plugin in  [(n, p) for (n, p) in bzrlib.plugin.plugins().items()
 
2819
                          if (keep_only is None
 
2820
                              or id_filter.is_module_name_used(
 
2821
                p.module.__name__))]:
 
2822
        try:
 
2823
            plugin_suite = plugin.test_suite()
 
2824
        except ImportError, e:
 
2825
            bzrlib.trace.warning(
 
2826
                'Unable to test plugin "%s": %s', name, e)
 
2827
        else:
 
2828
            if plugin_suite is not None:
 
2829
                if keep_only is not None:
 
2830
                    plugin_suite = filter_suite_by_id_list(plugin_suite,
 
2831
                                                           id_filter)
 
2832
                suite.addTest(plugin_suite)
3919
2833
        if default_encoding != sys.getdefaultencoding():
3920
2834
            bzrlib.trace.warning(
3921
2835
                'Plugin "%s" tried to reset default encoding to: %s', name,
3922
2836
                sys.getdefaultencoding())
3923
2837
            reload(sys)
3924
2838
            sys.setdefaultencoding(default_encoding)
3925
 
 
3926
 
    if keep_only is not None:
3927
 
        # Now that the referred modules have loaded their tests, keep only the
3928
 
        # requested ones.
3929
 
        suite = filter_suite_by_id_list(suite, id_filter)
3930
 
        # Do some sanity checks on the id_list filtering
3931
 
        not_found, duplicates = suite_matches_id_list(suite, keep_only)
3932
 
        if starting_with:
3933
 
            # The tester has used both keep_only and starting_with, so he is
3934
 
            # already aware that some tests are excluded from the list, there
3935
 
            # is no need to tell him which.
3936
 
            pass
3937
 
        else:
3938
 
            # Some tests mentioned in the list are not in the test suite. The
3939
 
            # list may be out of date, report to the tester.
3940
 
            for id in not_found:
3941
 
                bzrlib.trace.warning('"%s" not found in the test suite', id)
3942
 
        for id in duplicates:
3943
 
            bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3944
 
 
 
2839
    return suite
 
2840
 
 
2841
 
 
2842
def multiply_tests_from_modules(module_name_list, scenario_iter):
 
2843
    """Adapt all tests in some given modules to given scenarios.
 
2844
 
 
2845
    This is the recommended public interface for test parameterization.
 
2846
    Typically the test_suite() method for a per-implementation test
 
2847
    suite will call multiply_tests_from_modules and return the 
 
2848
    result.
 
2849
 
 
2850
    :param module_name_list: List of fully-qualified names of test
 
2851
        modules.
 
2852
    :param scenario_iter: Iterable of pairs of (scenario_name, 
 
2853
        scenario_param_dict).
 
2854
 
 
2855
    This returns a new TestSuite containing the cross product of
 
2856
    all the tests in all the modules, each repeated for each scenario.
 
2857
    Each test is adapted by adding the scenario name at the end 
 
2858
    of its name, and updating the test object's __dict__ with the
 
2859
    scenario_param_dict.
 
2860
 
 
2861
    >>> r = multiply_tests_from_modules(
 
2862
    ...     ['bzrlib.tests.test_sampler'],
 
2863
    ...     [('one', dict(param=1)), 
 
2864
    ...      ('two', dict(param=2))])
 
2865
    >>> tests = list(iter_suite_tests(r))
 
2866
    >>> len(tests)
 
2867
    2
 
2868
    >>> tests[0].id()
 
2869
    'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
 
2870
    >>> tests[0].param
 
2871
    1
 
2872
    >>> tests[1].param
 
2873
    2
 
2874
    """
 
2875
    loader = TestLoader()
 
2876
    suite = TestSuite()
 
2877
    adapter = TestScenarioApplier()
 
2878
    adapter.scenarios = list(scenario_iter)
 
2879
    adapt_modules(module_name_list, adapter, loader, suite)
3945
2880
    return suite
3946
2881
 
3947
2882
 
3959
2894
        for right_name, right_dict in scenarios_right]
3960
2895
 
3961
2896
 
3962
 
def multiply_tests(tests, scenarios, result):
3963
 
    """Multiply tests_list by scenarios into result.
3964
 
 
3965
 
    This is the core workhorse for test parameterisation.
3966
 
 
3967
 
    Typically the load_tests() method for a per-implementation test suite will
3968
 
    call multiply_tests and return the result.
3969
 
 
3970
 
    :param tests: The tests to parameterise.
3971
 
    :param scenarios: The scenarios to apply: pairs of (scenario_name,
3972
 
        scenario_param_dict).
3973
 
    :param result: A TestSuite to add created tests to.
3974
 
 
3975
 
    This returns the passed in result TestSuite with the cross product of all
3976
 
    the tests repeated once for each scenario.  Each test is adapted by adding
3977
 
    the scenario name at the end of its id(), and updating the test object's
3978
 
    __dict__ with the scenario_param_dict.
3979
 
 
3980
 
    >>> import bzrlib.tests.test_sampler
3981
 
    >>> r = multiply_tests(
3982
 
    ...     bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3983
 
    ...     [('one', dict(param=1)),
3984
 
    ...      ('two', dict(param=2))],
3985
 
    ...     TestSuite())
3986
 
    >>> tests = list(iter_suite_tests(r))
3987
 
    >>> len(tests)
3988
 
    2
3989
 
    >>> tests[0].id()
3990
 
    'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3991
 
    >>> tests[0].param
3992
 
    1
3993
 
    >>> tests[1].param
3994
 
    2
3995
 
    """
3996
 
    for test in iter_suite_tests(tests):
3997
 
        apply_scenarios(test, scenarios, result)
3998
 
    return result
3999
 
 
4000
 
 
4001
 
def apply_scenarios(test, scenarios, result):
4002
 
    """Apply the scenarios in scenarios to test and add to result.
4003
 
 
4004
 
    :param test: The test to apply scenarios to.
4005
 
    :param scenarios: An iterable of scenarios to apply to test.
4006
 
    :return: result
4007
 
    :seealso: apply_scenario
4008
 
    """
4009
 
    for scenario in scenarios:
4010
 
        result.addTest(apply_scenario(test, scenario))
4011
 
    return result
4012
 
 
4013
 
 
4014
 
def apply_scenario(test, scenario):
4015
 
    """Copy test and apply scenario to it.
4016
 
 
4017
 
    :param test: A test to adapt.
4018
 
    :param scenario: A tuple describing the scenarion.
4019
 
        The first element of the tuple is the new test id.
4020
 
        The second element is a dict containing attributes to set on the
4021
 
        test.
4022
 
    :return: The adapted test.
4023
 
    """
4024
 
    new_id = "%s(%s)" % (test.id(), scenario[0])
4025
 
    new_test = clone_test(test, new_id)
4026
 
    for name, value in scenario[1].items():
4027
 
        setattr(new_test, name, value)
4028
 
    return new_test
4029
 
 
4030
 
 
4031
 
def clone_test(test, new_id):
4032
 
    """Clone a test giving it a new id.
4033
 
 
4034
 
    :param test: The test to clone.
4035
 
    :param new_id: The id to assign to it.
4036
 
    :return: The new test.
4037
 
    """
4038
 
    new_test = copy(test)
4039
 
    new_test.id = lambda: new_id
4040
 
    return new_test
4041
 
 
4042
 
 
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):
 
2897
 
 
2898
def adapt_modules(mods_list, adapter, loader, suite):
 
2899
    """Adapt the modules in mods_list using adapter and add to suite."""
 
2900
    for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
 
2901
        suite.addTests(adapter.adapt(test))
 
2902
 
 
2903
 
 
2904
def adapt_tests(tests_list, adapter, loader, suite):
 
2905
    """Adapt the tests in tests_list using adapter and add to suite."""
 
2906
    for test in tests_list:
 
2907
        suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
 
2908
 
 
2909
 
 
2910
def _rmtree_temp_dir(dirname):
4085
2911
    # If LANG=C we probably have created some bogus paths
4086
2912
    # which rmtree(unicode) will fail to delete
4087
2913
    # so make sure we are using rmtree(str) to delete everything
4096
2922
    try:
4097
2923
        osutils.rmtree(dirname)
4098
2924
    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))
 
2925
        if sys.platform == 'win32' and e.errno == errno.EACCES:
 
2926
            sys.stderr.write(('Permission denied: '
 
2927
                                 'unable to remove testing dir '
 
2928
                                 '%s\n' % os.path.basename(dirname)))
 
2929
        else:
 
2930
            raise
4107
2931
 
4108
2932
 
4109
2933
class Feature(object):
4145
2969
SymlinkFeature = _SymlinkFeature()
4146
2970
 
4147
2971
 
4148
 
class _HardlinkFeature(Feature):
4149
 
 
4150
 
    def _probe(self):
4151
 
        return osutils.has_hardlinks()
4152
 
 
4153
 
    def feature_name(self):
4154
 
        return 'hardlinks'
4155
 
 
4156
 
HardlinkFeature = _HardlinkFeature()
4157
 
 
4158
 
 
4159
2972
class _OsFifoFeature(Feature):
4160
2973
 
4161
2974
    def _probe(self):
4167
2980
OsFifoFeature = _OsFifoFeature()
4168
2981
 
4169
2982
 
4170
 
class _UnicodeFilenameFeature(Feature):
4171
 
    """Does the filesystem support Unicode filenames?"""
4172
 
 
4173
 
    def _probe(self):
4174
 
        try:
4175
 
            # Check for character combinations unlikely to be covered by any
4176
 
            # single non-unicode encoding. We use the characters
4177
 
            # - greek small letter alpha (U+03B1) and
4178
 
            # - braille pattern dots-123456 (U+283F).
4179
 
            os.stat(u'\u03b1\u283f')
4180
 
        except UnicodeEncodeError:
4181
 
            return False
4182
 
        except (IOError, OSError):
4183
 
            # The filesystem allows the Unicode filename but the file doesn't
4184
 
            # exist.
4185
 
            return True
4186
 
        else:
4187
 
            # The filesystem allows the Unicode filename and the file exists,
4188
 
            # for some reason.
4189
 
            return True
4190
 
 
4191
 
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4192
 
 
4193
 
 
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')
 
2983
class TestScenarioApplier(object):
 
2984
    """A tool to apply scenarios to tests."""
 
2985
 
 
2986
    def adapt(self, test):
 
2987
        """Return a TestSuite containing a copy of test for each scenario."""
 
2988
        result = unittest.TestSuite()
 
2989
        for scenario in self.scenarios:
 
2990
            result.addTest(self.adapt_test_to_scenario(test, scenario))
 
2991
        return result
 
2992
 
 
2993
    def adapt_test_to_scenario(self, test, scenario):
 
2994
        """Copy test and apply scenario to it.
 
2995
 
 
2996
        :param test: A test to adapt.
 
2997
        :param scenario: A tuple describing the scenarion.
 
2998
            The first element of the tuple is the new test id.
 
2999
            The second element is a dict containing attributes to set on the
 
3000
            test.
 
3001
        :return: The adapted test.
 
3002
        """
 
3003
        from copy import deepcopy
 
3004
        new_test = deepcopy(test)
 
3005
        for name, value in scenario[1].items():
 
3006
            setattr(new_test, name, value)
 
3007
        new_id = "%s(%s)" % (new_test.id(), scenario[0])
 
3008
        new_test.id = lambda: new_id
 
3009
        return new_test
4266
3010
 
4267
3011
 
4268
3012
def probe_unicode_in_user_encoding():
4274
3018
    possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4275
3019
    for uni_val in possible_vals:
4276
3020
        try:
4277
 
            str_val = uni_val.encode(osutils.get_user_encoding())
 
3021
            str_val = uni_val.encode(bzrlib.user_encoding)
4278
3022
        except UnicodeEncodeError:
4279
3023
            # Try a different character
4280
3024
            pass
4298
3042
    return None
4299
3043
 
4300
3044
 
4301
 
class _HTTPSServerFeature(Feature):
4302
 
    """Some tests want an https Server, check if one is available.
 
3045
class _FTPServerFeature(Feature):
 
3046
    """Some tests want an FTP Server, check if one is available.
4303
3047
 
4304
 
    Right now, the only way this is available is under python2.6 which provides
4305
 
    an ssl module.
 
3048
    Right now, the only way this is available is if 'medusa' is installed.
 
3049
    http://www.amk.ca/python/code/medusa.html
4306
3050
    """
4307
3051
 
4308
3052
    def _probe(self):
4309
3053
        try:
4310
 
            import ssl
 
3054
            import bzrlib.tests.ftp_server
4311
3055
            return True
4312
3056
        except ImportError:
4313
3057
            return False
4314
3058
 
4315
3059
    def feature_name(self):
4316
 
        return 'HTTPSServer'
4317
 
 
4318
 
 
4319
 
HTTPSServerFeature = _HTTPSServerFeature()
4320
 
 
4321
 
 
4322
 
class _UnicodeFilename(Feature):
4323
 
    """Does the filesystem support Unicode filenames?"""
4324
 
 
4325
 
    def _probe(self):
4326
 
        try:
4327
 
            os.stat(u'\u03b1')
4328
 
        except UnicodeEncodeError:
4329
 
            return False
4330
 
        except (IOError, OSError):
4331
 
            # The filesystem allows the Unicode filename but the file doesn't
4332
 
            # exist.
4333
 
            return True
4334
 
        else:
4335
 
            # The filesystem allows the Unicode filename and the file exists,
4336
 
            # for some reason.
4337
 
            return True
4338
 
 
4339
 
UnicodeFilename = _UnicodeFilename()
4340
 
 
4341
 
 
4342
 
class _UTF8Filesystem(Feature):
4343
 
    """Is the filesystem UTF-8?"""
4344
 
 
4345
 
    def _probe(self):
4346
 
        if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4347
 
            return True
4348
 
        return False
4349
 
 
4350
 
UTF8Filesystem = _UTF8Filesystem()
4351
 
 
4352
 
 
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
 
class _CaseInsCasePresFilenameFeature(Feature):
4378
 
    """Is the file-system case insensitive, but case-preserving?"""
4379
 
 
4380
 
    def _probe(self):
4381
 
        fileno, name = tempfile.mkstemp(prefix='MixedCase')
4382
 
        try:
4383
 
            # first check truly case-preserving for created files, then check
4384
 
            # case insensitive when opening existing files.
4385
 
            name = osutils.normpath(name)
4386
 
            base, rel = osutils.split(name)
4387
 
            found_rel = osutils.canonical_relpath(base, name)
4388
 
            return (found_rel == rel
4389
 
                    and os.path.isfile(name.upper())
4390
 
                    and os.path.isfile(name.lower()))
4391
 
        finally:
4392
 
            os.close(fileno)
4393
 
            os.remove(name)
4394
 
 
4395
 
    def feature_name(self):
4396
 
        return "case-insensitive case-preserving filesystem"
4397
 
 
4398
 
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
 
3060
        return 'FTPServer'
 
3061
 
 
3062
FTPServerFeature = _FTPServerFeature()
4399
3063
 
4400
3064
 
4401
3065
class _CaseInsensitiveFilesystemFeature(Feature):
4402
 
    """Check if underlying filesystem is case-insensitive but *not* case
4403
 
    preserving.
 
3066
    """Check if underlined filesystem is case-insensitive
 
3067
    (e.g. on Windows, Cygwin, MacOS)
4404
3068
    """
4405
 
    # Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4406
 
    # more likely to be case preserving, so this case is rare.
4407
3069
 
4408
3070
    def _probe(self):
4409
 
        if CaseInsCasePresFilenameFeature.available():
4410
 
            return False
4411
 
 
4412
3071
        if TestCaseWithMemoryTransport.TEST_ROOT is None:
4413
3072
            root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4414
3073
            TestCaseWithMemoryTransport.TEST_ROOT = root
4427
3086
        return 'case-insensitive filesystem'
4428
3087
 
4429
3088
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4430
 
 
4431
 
 
4432
 
class _CaseSensitiveFilesystemFeature(Feature):
4433
 
 
4434
 
    def _probe(self):
4435
 
        if CaseInsCasePresFilenameFeature.available():
4436
 
            return False
4437
 
        elif CaseInsensitiveFilesystemFeature.available():
4438
 
            return False
4439
 
        else:
4440
 
            return True
4441
 
 
4442
 
    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')
4453
 
# Only define SubUnitBzrRunner if subunit is available.
4454
 
try:
4455
 
    from subunit import TestProtocolClient
4456
 
    from subunit.test_results import AutoTimingTestResultDecorator
4457
 
    class SubUnitBzrRunner(TextTestRunner):
4458
 
        def run(self, test):
4459
 
            result = AutoTimingTestResultDecorator(
4460
 
                TestProtocolClient(self.stream))
4461
 
            test.run(result)
4462
 
            return result
4463
 
except ImportError:
4464
 
    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()