/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Aaron Bentley
  • Date: 2008-03-25 05:40:55 UTC
  • mto: This revision was merged to the branch mainline in revision 3304.
  • Revision ID: aaron@aaronbentley.com-20080325054055-se4iycu8hm71i1db
Updates from review

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
 
    treeshape,
116
 
    )
 
95
from bzrlib.tests import TestUtil
117
96
from bzrlib.tests.http_server import HttpServer
118
97
from bzrlib.tests.TestUtil import (
119
98
                          TestSuite,
120
99
                          TestLoader,
121
100
                          )
122
 
from bzrlib.ui import NullProgressView
123
 
from bzrlib.ui.text import TextUIFactory
 
101
from bzrlib.tests.treeshape import build_tree_contents
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,
 
115
        bzrlib.timestamp,
 
116
        bzrlib.errors,
 
117
        bzrlib.export,
 
118
        bzrlib.inventory,
 
119
        bzrlib.iterablefile,
 
120
        bzrlib.lockdir,
 
121
        bzrlib.merge3,
 
122
        bzrlib.option,
 
123
        bzrlib.store,
 
124
        bzrlib.version_info_formats.format_custom,
 
125
        # quoted to avoid module-loading circularity
 
126
        'bzrlib.tests',
 
127
        ]
 
128
 
 
129
 
 
130
def packages_to_test():
 
131
    """Return a list of packages to test.
 
132
 
 
133
    The packages are not globally imported so that import failures are
 
134
    triggered when running selftest, not when importing the command.
 
135
    """
 
136
    import bzrlib.doc
 
137
    import bzrlib.tests.blackbox
 
138
    import bzrlib.tests.branch_implementations
 
139
    import bzrlib.tests.bzrdir_implementations
 
140
    import bzrlib.tests.commands
 
141
    import bzrlib.tests.interrepository_implementations
 
142
    import bzrlib.tests.interversionedfile_implementations
 
143
    import bzrlib.tests.intertree_implementations
 
144
    import bzrlib.tests.inventory_implementations
 
145
    import bzrlib.tests.per_lock
 
146
    import bzrlib.tests.repository_implementations
 
147
    import bzrlib.tests.revisionstore_implementations
 
148
    import bzrlib.tests.tree_implementations
 
149
    import bzrlib.tests.workingtree_implementations
 
150
    return [
 
151
            bzrlib.doc,
 
152
            bzrlib.tests.blackbox,
 
153
            bzrlib.tests.branch_implementations,
 
154
            bzrlib.tests.bzrdir_implementations,
 
155
            bzrlib.tests.commands,
 
156
            bzrlib.tests.interrepository_implementations,
 
157
            bzrlib.tests.interversionedfile_implementations,
 
158
            bzrlib.tests.intertree_implementations,
 
159
            bzrlib.tests.inventory_implementations,
 
160
            bzrlib.tests.per_lock,
 
161
            bzrlib.tests.repository_implementations,
 
162
            bzrlib.tests.revisionstore_implementations,
 
163
            bzrlib.tests.tree_implementations,
 
164
            bzrlib.tests.workingtree_implementations,
 
165
            ]
142
166
 
143
167
 
144
168
class ExtendedTestResult(unittest._TextTestResult):
158
182
    """
159
183
 
160
184
    stop_early = False
161
 
 
 
185
    
162
186
    def __init__(self, stream, descriptions, verbosity,
163
187
                 bench_history=None,
164
 
                 strict=False,
 
188
                 num_tests=None,
165
189
                 ):
166
190
        """Construct new TestResult.
167
191
 
185
209
            bench_history.write("--date %s %s\n" % (time.time(), revision_id))
186
210
        self._bench_history = bench_history
187
211
        self.ui = ui.ui_factory
188
 
        self.num_tests = 0
 
212
        self.num_tests = num_tests
189
213
        self.error_count = 0
190
214
        self.failure_count = 0
191
215
        self.known_failure_count = 0
194
218
        self.unsupported = {}
195
219
        self.count = 0
196
220
        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):
 
221
    
 
222
    def _extractBenchmarkTime(self, testCase):
254
223
        """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
224
        return getattr(testCase, "_benchtime", None)
258
 
 
 
225
    
259
226
    def _elapsedTestTimeString(self):
260
227
        """Return a time string for the overall time the current test has taken."""
261
228
        return self._formatTime(time.time() - self._start_time)
263
230
    def _testTimeString(self, testCase):
264
231
        benchmark_time = self._extractBenchmarkTime(testCase)
265
232
        if benchmark_time is not None:
266
 
            return self._formatTime(benchmark_time) + "*"
 
233
            return "%s/%s" % (
 
234
                self._formatTime(benchmark_time),
 
235
                self._elapsedTestTimeString())
267
236
        else:
268
 
            return self._elapsedTestTimeString()
 
237
            return "           %s" % self._elapsedTestTimeString()
269
238
 
270
239
    def _formatTime(self, seconds):
271
240
        """Format seconds as milliseconds with leading spaces."""
280
249
 
281
250
    def startTest(self, test):
282
251
        unittest.TestResult.startTest(self, test)
283
 
        if self.count == 0:
284
 
            self.startTests()
285
252
        self.report_test_start(test)
286
253
        test.number = self.count
287
254
        self._recordTestStartTime()
288
255
 
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
256
    def _recordTestStartTime(self):
309
257
        """Record that a test has started."""
310
258
        self._start_time = time.time()
322
270
        Called from the TestCase run() method when the test
323
271
        fails with an unexpected error.
324
272
        """
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)
 
273
        self._testConcluded(test)
 
274
        if isinstance(err[1], TestSkipped):
 
275
            return self._addSkipped(test, err)
 
276
        elif isinstance(err[1], UnavailableFeature):
 
277
            return self.addNotSupported(test, err[1].args[0])
 
278
        else:
 
279
            self._cleanupLogFile(test)
 
280
            unittest.TestResult.addError(self, test, err)
 
281
            self.error_count += 1
 
282
            self.report_error(test, err)
 
283
            if self.stop_early:
 
284
                self.stop()
332
285
 
333
286
    def addFailure(self, test, err):
334
287
        """Tell result that test failed.
336
289
        Called from the TestCase run() method when the test
337
290
        fails because e.g. an assert() method failed.
338
291
        """
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)
 
292
        self._testConcluded(test)
 
293
        if isinstance(err[1], KnownFailure):
 
294
            return self._addKnownFailure(test, err)
 
295
        else:
 
296
            self._cleanupLogFile(test)
 
297
            unittest.TestResult.addFailure(self, test, err)
 
298
            self.failure_count += 1
 
299
            self.report_failure(test, err)
 
300
            if self.stop_early:
 
301
                self.stop()
346
302
 
347
 
    def addSuccess(self, test, details=None):
 
303
    def addSuccess(self, test):
348
304
        """Tell result that test completed successfully.
349
305
 
350
306
        Called from the TestCase run()
351
307
        """
 
308
        self._testConcluded(test)
352
309
        if self._bench_history is not None:
353
 
            benchmark_time = self._extractBenchmarkTime(test, details)
 
310
            benchmark_time = self._extractBenchmarkTime(test)
354
311
            if benchmark_time is not None:
355
312
                self._bench_history.write("%s %s\n" % (
356
313
                    self._formatTime(benchmark_time),
358
315
        self.report_success(test)
359
316
        self._cleanupLogFile(test)
360
317
        unittest.TestResult.addSuccess(self, test)
361
 
        test._log_contents = ''
362
 
 
363
 
    def addExpectedFailure(self, test, err):
 
318
 
 
319
    def _testConcluded(self, test):
 
320
        """Common code when a test has finished.
 
321
 
 
322
        Called regardless of whether it succeded, failed, etc.
 
323
        """
 
324
        pass
 
325
 
 
326
    def _addKnownFailure(self, test, err):
364
327
        self.known_failure_count += 1
365
328
        self.report_known_failure(test, err)
366
329
 
368
331
        """The test will not be run because of a missing feature.
369
332
        """
370
333
        # this can be called in two different ways: it may be that the
371
 
        # test started running, and then raised (through requireFeature)
 
334
        # test started running, and then raised (through addError) 
372
335
        # 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.
 
336
        # while probing for features before running the tests; in that
 
337
        # case we will see startTest and stopTest, but the test will never
 
338
        # actually run.
376
339
        self.unsupported.setdefault(str(feature), 0)
377
340
        self.unsupported[str(feature)] += 1
378
341
        self.report_unsupported(test, feature)
379
342
 
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)
 
343
    def _addSkipped(self, test, skip_excinfo):
 
344
        if isinstance(skip_excinfo[1], TestNotApplicable):
 
345
            self.not_applicable_count += 1
 
346
            self.report_not_applicable(test, skip_excinfo)
 
347
        else:
 
348
            self.skip_count += 1
 
349
            self.report_skip(test, skip_excinfo)
 
350
        try:
 
351
            test.tearDown()
 
352
        except KeyboardInterrupt:
 
353
            raise
 
354
        except:
 
355
            self.addError(test, test._exc_info())
 
356
        else:
 
357
            # seems best to treat this as success from point-of-view of unittest
 
358
            # -- it actually does nothing so it barely matters :)
 
359
            unittest.TestResult.addSuccess(self, test)
 
360
 
 
361
    def printErrorList(self, flavour, errors):
 
362
        for test, err in errors:
 
363
            self.stream.writeln(self.separator1)
 
364
            self.stream.write("%s: " % flavour)
 
365
            self.stream.writeln(self.getDescription(test))
 
366
            if getattr(test, '_get_log', None) is not None:
 
367
                self.stream.write('\n')
 
368
                self.stream.write(
 
369
                        ('vvvv[log from %s]' % test.id()).ljust(78,'-'))
 
370
                self.stream.write('\n')
 
371
                self.stream.write(test._get_log())
 
372
                self.stream.write('\n')
 
373
                self.stream.write(
 
374
                        ('^^^^[log from %s]' % test.id()).ljust(78,'-'))
 
375
                self.stream.write('\n')
 
376
            self.stream.writeln(self.separator2)
 
377
            self.stream.writeln("%s" % err)
 
378
 
 
379
    def finished(self):
 
380
        pass
402
381
 
403
382
    def report_cleaning_up(self):
404
383
        pass
405
384
 
406
 
    def startTestRun(self):
407
 
        self.startTime = time.time()
408
 
 
409
385
    def report_success(self, test):
410
386
        pass
411
387
 
420
396
 
421
397
    def __init__(self, stream, descriptions, verbosity,
422
398
                 bench_history=None,
 
399
                 num_tests=None,
423
400
                 pb=None,
424
 
                 strict=None,
425
401
                 ):
426
402
        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()
 
403
            bench_history, num_tests)
 
404
        if pb is None:
 
405
            self.pb = self.ui.nested_progress_bar()
 
406
            self._supplied_pb = False
 
407
        else:
 
408
            self.pb = pb
 
409
            self._supplied_pb = True
433
410
        self.pb.show_pct = False
434
411
        self.pb.show_spinner = False
435
412
        self.pb.show_eta = False,
436
413
        self.pb.show_count = False
437
414
        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()
 
415
 
 
416
    def report_starting(self):
 
417
        self.pb.update('[test 0/%d] starting...' % (self.num_tests))
455
418
 
456
419
    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:
 
420
        a = '[%d' % self.count
 
421
        if self.num_tests is not None:
467
422
            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)
 
423
        a += ' in %ds' % (time.time() - self._overall_start_time)
 
424
        if self.error_count:
 
425
            a += ', %d errors' % self.error_count
 
426
        if self.failure_count:
 
427
            a += ', %d failed' % self.failure_count
 
428
        if self.known_failure_count:
 
429
            a += ', %d known failures' % self.known_failure_count
 
430
        if self.skip_count:
 
431
            a += ', %d skipped' % self.skip_count
 
432
        if self.unsupported:
 
433
            a += ', %d missing features' % len(self.unsupported)
479
434
        a += ']'
480
435
        return a
481
436
 
483
438
        self.count += 1
484
439
        self.pb.update(
485
440
                self._progress_prefix_text()
486
 
                + ' '
 
441
                + ' ' 
487
442
                + self._shortened_test_description(test))
488
443
 
489
444
    def _test_description(self, test):
490
445
        return self._shortened_test_description(test)
491
446
 
492
447
    def report_error(self, test, err):
493
 
        self.stream.write('ERROR: %s\n    %s\n' % (
 
448
        self.pb.note('ERROR: %s\n    %s\n', 
494
449
            self._test_description(test),
495
450
            err[1],
496
 
            ))
 
451
            )
497
452
 
498
453
    def report_failure(self, test, err):
499
 
        self.stream.write('FAIL: %s\n    %s\n' % (
 
454
        self.pb.note('FAIL: %s\n    %s\n', 
500
455
            self._test_description(test),
501
456
            err[1],
502
 
            ))
 
457
            )
503
458
 
504
459
    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):
 
460
        self.pb.note('XFAIL: %s\n%s\n',
 
461
            self._test_description(test), err[1])
 
462
 
 
463
    def report_skip(self, test, skip_excinfo):
 
464
        pass
 
465
 
 
466
    def report_not_applicable(self, test, skip_excinfo):
511
467
        pass
512
468
 
513
469
    def report_unsupported(self, test, feature):
514
470
        """test cannot be run because feature is missing."""
515
 
 
 
471
                  
516
472
    def report_cleaning_up(self):
517
 
        self.pb.update('Cleaning up')
 
473
        self.pb.update('cleaning up...')
 
474
 
 
475
    def finished(self):
 
476
        if not self._supplied_pb:
 
477
            self.pb.finished()
518
478
 
519
479
 
520
480
class VerboseTestResult(ExtendedTestResult):
528
488
            result = a_string
529
489
        return result.ljust(final_width)
530
490
 
531
 
    def startTestRun(self):
532
 
        super(VerboseTestResult, self).startTestRun()
 
491
    def report_starting(self):
533
492
        self.stream.write('running %d tests...\n' % self.num_tests)
534
493
 
535
494
    def report_test_start(self, test):
536
495
        self.count += 1
537
496
        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)
 
497
        # width needs space for 6 char status, plus 1 for slash, plus 2 10-char
 
498
        # numbers, plus a trailing blank
 
499
        # when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
 
500
        self.stream.write(self._ellipsize_to_right(name,
 
501
                          osutils.terminal_width()-30))
547
502
        self.stream.flush()
548
503
 
549
504
    def _error_summary(self, err):
574
529
        # used to show the output in PQM.
575
530
        self.stream.flush()
576
531
 
577
 
    def report_skip(self, test, reason):
 
532
    def report_skip(self, test, skip_excinfo):
578
533
        self.stream.writeln(' SKIP %s\n%s'
579
 
                % (self._testTimeString(test), reason))
 
534
                % (self._testTimeString(test),
 
535
                   self._error_summary(skip_excinfo)))
580
536
 
581
 
    def report_not_applicable(self, test, reason):
582
 
        self.stream.writeln('  N/A %s\n    %s'
583
 
                % (self._testTimeString(test), reason))
 
537
    def report_not_applicable(self, test, skip_excinfo):
 
538
        self.stream.writeln('  N/A %s\n%s'
 
539
                % (self._testTimeString(test),
 
540
                   self._error_summary(skip_excinfo)))
584
541
 
585
542
    def report_unsupported(self, test, feature):
586
543
        """test cannot be run because feature is missing."""
596
553
                 descriptions=0,
597
554
                 verbosity=1,
598
555
                 bench_history=None,
599
 
                 strict=False,
600
 
                 result_decorators=None,
 
556
                 list_only=False
601
557
                 ):
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
558
        self.stream = unittest._WritelnDecorator(stream)
623
559
        self.descriptions = descriptions
624
560
        self.verbosity = verbosity
625
561
        self._bench_history = bench_history
626
 
        self._strict = strict
627
 
        self._result_decorators = result_decorators or []
 
562
        self.list_only = list_only
628
563
 
629
564
    def run(self, test):
630
565
        "Run the given test case or test suite."
 
566
        startTime = time.time()
631
567
        if self.verbosity == 1:
632
568
            result_class = TextTestResult
633
569
        elif self.verbosity >= 2:
634
570
            result_class = VerboseTestResult
635
 
        original_result = result_class(self.stream,
 
571
        result = result_class(self.stream,
636
572
                              self.descriptions,
637
573
                              self.verbosity,
638
574
                              bench_history=self._bench_history,
639
 
                              strict=self._strict,
 
575
                              num_tests=test.countTestCases(),
640
576
                              )
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:
 
577
        result.stop_early = self.stop_on_failure
 
578
        result.report_starting()
 
579
        if self.list_only:
 
580
            if self.verbosity >= 2:
 
581
                self.stream.writeln("Listing tests only ...\n")
 
582
            run = 0
 
583
            for t in iter_suite_tests(test):
 
584
                self.stream.writeln("%s" % (t.id()))
 
585
                run += 1
 
586
            actionTaken = "Listed"
 
587
        else: 
649
588
            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
 
589
            run = result.testsRun
 
590
            actionTaken = "Ran"
 
591
        stopTime = time.time()
 
592
        timeTaken = stopTime - startTime
 
593
        result.printErrors()
 
594
        self.stream.writeln(result.separator2)
 
595
        self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
 
596
                            run, run != 1 and "s" or "", timeTaken))
 
597
        self.stream.writeln()
 
598
        if not result.wasSuccessful():
 
599
            self.stream.write("FAILED (")
 
600
            failed, errored = map(len, (result.failures, result.errors))
 
601
            if failed:
 
602
                self.stream.write("failures=%d" % failed)
 
603
            if errored:
 
604
                if failed: self.stream.write(", ")
 
605
                self.stream.write("errors=%d" % errored)
 
606
            if result.known_failure_count:
 
607
                if failed or errored: self.stream.write(", ")
 
608
                self.stream.write("known_failure_count=%d" %
 
609
                    result.known_failure_count)
 
610
            self.stream.writeln(")")
 
611
        else:
 
612
            if result.known_failure_count:
 
613
                self.stream.writeln("OK (known_failures=%d)" %
 
614
                    result.known_failure_count)
 
615
            else:
 
616
                self.stream.writeln("OK")
 
617
        if result.skip_count > 0:
 
618
            skipped = result.skip_count
 
619
            self.stream.writeln('%d test%s skipped' %
 
620
                                (skipped, skipped != 1 and "s" or ""))
 
621
        if result.unsupported:
 
622
            for feature, count in sorted(result.unsupported.items()):
 
623
                self.stream.writeln("Missing feature '%s' skipped %d tests." %
 
624
                    (feature, count))
 
625
        result.finished()
 
626
        return result
655
627
 
656
628
 
657
629
def iter_suite_tests(suite):
658
630
    """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:
 
631
    for item in suite._tests:
 
632
        if isinstance(item, unittest.TestCase):
 
633
            yield item
 
634
        elif isinstance(item, unittest.TestSuite):
663
635
            for r in iter_suite_tests(item):
664
636
                yield r
665
 
    else:
666
 
        raise Exception('unknown type %r for object %r'
667
 
                        % (type(suite), suite))
668
 
 
669
 
 
670
 
TestSkipped = testtools.testcase.TestSkipped
 
637
        else:
 
638
            raise Exception('unknown object %r inside test suite %r'
 
639
                            % (item, suite))
 
640
 
 
641
 
 
642
class TestSkipped(Exception):
 
643
    """Indicates that a test was intentionally skipped, rather than failing."""
671
644
 
672
645
 
673
646
class TestNotApplicable(TestSkipped):
674
647
    """A test is not applicable to the situation where it was run.
675
648
 
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
 
649
    This is only normally raised by parameterized tests, if they find that 
 
650
    the instance they're constructed upon does not support one aspect 
678
651
    of its interface.
679
652
    """
680
653
 
681
654
 
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
 
655
class KnownFailure(AssertionError):
 
656
    """Indicates that a test failed in a precisely expected manner.
 
657
 
 
658
    Such failures dont block the whole test suite from passing because they are
 
659
    indicators of partially completed code or of future work. We have an
 
660
    explicit error for them so that we can ensure that they are always visible:
 
661
    KnownFailures are always shown in the output of bzr selftest.
 
662
    """
699
663
 
700
664
 
701
665
class UnavailableFeature(Exception):
702
666
    """A feature required for this test was not available.
703
667
 
704
 
    This can be considered a specialised form of SkippedTest.
705
 
 
706
668
    The feature should be used to construct the exception.
707
669
    """
708
670
 
709
671
 
 
672
class CommandFailed(Exception):
 
673
    pass
 
674
 
 
675
 
710
676
class StringIOWrapper(object):
711
677
    """A wrapper around cStringIO which just adds an encoding attribute.
712
 
 
 
678
    
713
679
    Internally we can check sys.stdout to see what the output encoding
714
680
    should be. However, cStringIO has no encoding attribute that we can
715
681
    set. So we wrap it instead.
733
699
            return setattr(self._cstring, name, val)
734
700
 
735
701
 
736
 
class TestUIFactory(TextUIFactory):
 
702
class TestUIFactory(ui.CLIUIFactory):
737
703
    """A UI Factory for testing.
738
704
 
739
705
    Hide the progress bar but emit note()s.
740
706
    Redirect stdin.
741
707
    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
708
    """
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
709
 
754
 
    def __init__(self, stdout=None, stderr=None, stdin=None):
 
710
    def __init__(self,
 
711
                 stdout=None,
 
712
                 stderr=None,
 
713
                 stdin=None):
 
714
        super(TestUIFactory, self).__init__()
755
715
        if stdin is not None:
756
716
            # We use a StringIOWrapper to be able to test various
757
717
            # encodings, but the user is still responsible to
758
718
            # encode the string and to set the encoding attribute
759
719
            # of StringIOWrapper.
760
 
            stdin = StringIOWrapper(stdin)
761
 
        super(TestUIFactory, self).__init__(stdin, stdout, stderr)
762
 
 
763
 
    def get_non_echoed_password(self):
 
720
            self.stdin = StringIOWrapper(stdin)
 
721
        if stdout is None:
 
722
            self.stdout = sys.stdout
 
723
        else:
 
724
            self.stdout = stdout
 
725
        if stderr is None:
 
726
            self.stderr = sys.stderr
 
727
        else:
 
728
            self.stderr = stderr
 
729
 
 
730
    def clear(self):
 
731
        """See progress.ProgressBar.clear()."""
 
732
 
 
733
    def clear_term(self):
 
734
        """See progress.ProgressBar.clear_term()."""
 
735
 
 
736
    def clear_term(self):
 
737
        """See progress.ProgressBar.clear_term()."""
 
738
 
 
739
    def finished(self):
 
740
        """See progress.ProgressBar.finished()."""
 
741
 
 
742
    def note(self, fmt_string, *args, **kwargs):
 
743
        """See progress.ProgressBar.note()."""
 
744
        self.stdout.write((fmt_string + "\n") % args)
 
745
 
 
746
    def progress_bar(self):
 
747
        return self
 
748
 
 
749
    def nested_progress_bar(self):
 
750
        return self
 
751
 
 
752
    def update(self, message, count=None, total=None):
 
753
        """See progress.ProgressBar.update()."""
 
754
 
 
755
    def get_non_echoed_password(self, prompt):
764
756
        """Get password from stdin without trying to handle the echo mode"""
 
757
        if prompt:
 
758
            self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
765
759
        password = self.stdin.readline()
766
760
        if not password:
767
761
            raise EOFError
769
763
            password = password[:-1]
770
764
        return password
771
765
 
772
 
    def make_progress_view(self):
773
 
        return NullProgressView()
774
 
 
775
 
 
776
 
class TestCase(testtools.TestCase):
 
766
 
 
767
class TestCase(unittest.TestCase):
777
768
    """Base class for bzr unit tests.
778
 
 
779
 
    Tests that need access to disk resources should subclass
 
769
    
 
770
    Tests that need access to disk resources should subclass 
780
771
    TestCaseInTempDir not TestCase.
781
772
 
782
773
    Error and debug log messages are redirected from their usual
784
775
    retrieved by _get_log().  We use a real OS file, not an in-memory object,
785
776
    so that it can also capture file IO.  When the test completes this file
786
777
    is read into memory and removed from disk.
787
 
 
 
778
       
788
779
    There are also convenience functions to invoke bzr's command-line
789
780
    routine, and to build and check bzr trees.
790
 
 
 
781
   
791
782
    In addition to the usual method of overriding tearDown(), this class also
792
783
    allows subclasses to register functions into the _cleanups list, which is
793
784
    run in order as the object is torn down.  It's less likely this will be
794
785
    accidentally overlooked.
795
786
    """
796
787
 
797
 
    _active_threads = None
798
 
    _leaking_threads_tests = 0
799
 
    _first_thread_leaker_id = None
800
788
    _log_file_name = None
 
789
    _log_contents = ''
 
790
    _keep_log_file = False
801
791
    # record lsprof data when performing benchmark calls.
802
792
    _gather_lsprof_in_benchmarks = False
803
793
 
804
794
    def __init__(self, methodName='testMethod'):
805
795
        super(TestCase, self).__init__(methodName)
806
796
        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
797
 
813
798
    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)]))
 
799
        unittest.TestCase.setUp(self)
821
800
        self._cleanEnvironment()
822
801
        self._silenceUI()
823
802
        self._startLogFile()
824
803
        self._benchcalls = []
825
804
        self._benchtime = None
826
805
        self._clear_hooks()
827
 
        self._track_transports()
828
 
        self._track_locks()
829
806
        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
807
 
853
808
    def _clear_debug_flags(self):
854
809
        """Prevent externally set debug flags affecting tests.
855
 
 
 
810
        
856
811
        Tests that want to use debug flags can just set them in the
857
812
        debug_flags set during setup/teardown.
858
813
        """
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')
 
814
        self._preserved_debug_flags = set(debug.debug_flags)
 
815
        debug.debug_flags.clear()
 
816
        self.addCleanup(self._restore_debug_flags)
865
817
 
866
818
    def _clear_hooks(self):
867
819
        # 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)
 
820
        import bzrlib.branch
 
821
        import bzrlib.smart.server
 
822
        self._preserved_hooks = {
 
823
            bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
 
824
            bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
 
825
            }
873
826
        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
 
827
        # reset all hooks to an empty instance of the appropriate type
 
828
        bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
 
829
        bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
887
830
 
888
831
    def _silenceUI(self):
889
832
        """Turn off UI for duration of test"""
890
833
        # 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.")
 
834
        saved = ui.ui_factory
 
835
        def _restore():
 
836
            ui.ui_factory = saved
 
837
        ui.ui_factory = ui.SilentUIFactory()
 
838
        self.addCleanup(_restore)
1070
839
 
1071
840
    def _ndiff_strings(self, a, b):
1072
841
        """Return ndiff between two strings containing lines.
1073
 
 
 
842
        
1074
843
        A trailing newline is added if missing to make the strings
1075
844
        print properly."""
1076
845
        if b and b[-1] != '\n':
1101
870
 
1102
871
    def assertEqualDiff(self, a, b, message=None):
1103
872
        """Assert two texts are equal, if not raise an exception.
1104
 
 
1105
 
        This is intended for use with multi-line strings where it can
 
873
        
 
874
        This is intended for use with multi-line strings where it can 
1106
875
        be hard to find the differences by eye.
1107
876
        """
1108
877
        # TODO: perhaps override assertEquals to call this for strings?
1110
879
            return
1111
880
        if message is None:
1112
881
            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
882
        raise AssertionError(message +
1118
883
                             self._ndiff_strings(a, b))
1119
 
 
 
884
        
1120
885
    def assertEqualMode(self, mode, mode_test):
1121
886
        self.assertEqual(mode, mode_test,
1122
887
                         'mode mismatch %o != %o' % (mode, mode_test))
1123
888
 
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
889
    def assertPositive(self, val):
1176
890
        """Assert that val is greater than 0."""
1177
891
        self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1189
903
        if not s.endswith(suffix):
1190
904
            raise AssertionError('string %r does not end with %r' % (s, suffix))
1191
905
 
1192
 
    def assertContainsRe(self, haystack, needle_re, flags=0):
 
906
    def assertContainsRe(self, haystack, needle_re):
1193
907
        """Assert that a contains something matching a regular expression."""
1194
 
        if not re.search(needle_re, haystack, flags):
 
908
        if not re.search(needle_re, haystack):
1195
909
            if '\n' in haystack or len(haystack) > 60:
1196
910
                # a long string, format it in a more readable way
1197
911
                raise AssertionError(
1201
915
                raise AssertionError('pattern "%s" not found in "%s"'
1202
916
                        % (needle_re, haystack))
1203
917
 
1204
 
    def assertNotContainsRe(self, haystack, needle_re, flags=0):
 
918
    def assertNotContainsRe(self, haystack, needle_re):
1205
919
        """Assert that a does not match a regular expression"""
1206
 
        if re.search(needle_re, haystack, flags):
 
920
        if re.search(needle_re, haystack):
1207
921
            raise AssertionError('pattern "%s" found in "%s"'
1208
922
                    % (needle_re, haystack))
1209
923
 
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
924
    def assertSubset(self, sublist, superlist):
1215
925
        """Assert that every entry in sublist is present in superlist."""
1216
926
        missing = set(sublist) - set(superlist)
1220
930
 
1221
931
    def assertListRaises(self, excClass, func, *args, **kwargs):
1222
932
        """Fail unless excClass is raised when the iterator from func is used.
1223
 
 
 
933
        
1224
934
        Many functions can return generators this makes sure
1225
935
        to wrap them in a list() call to make sure the whole generator
1226
936
        is run, and that the proper exception is raised.
1227
937
        """
1228
938
        try:
1229
939
            list(func(*args, **kwargs))
1230
 
        except excClass, e:
1231
 
            return e
 
940
        except excClass:
 
941
            return
1232
942
        else:
1233
943
            if getattr(excClass,'__name__', None) is not None:
1234
944
                excName = excClass.__name__
1273
983
                raise AssertionError("%r is %r." % (left, right))
1274
984
 
1275
985
    def assertTransportMode(self, transport, path, mode):
1276
 
        """Fail if a path does not have mode "mode".
1277
 
 
 
986
        """Fail if a path does not have mode mode.
 
987
        
1278
988
        If modes are not supported on this transport, the assertion is ignored.
1279
989
        """
1280
990
        if not transport._can_roundtrip_unix_modebits():
1282
992
        path_stat = transport.stat(path)
1283
993
        actual_mode = stat.S_IMODE(path_stat.st_mode)
1284
994
        self.assertEqual(mode, actual_mode,
1285
 
                         'mode of %r incorrect (%s != %s)'
1286
 
                         % (path, oct(mode), oct(actual_mode)))
 
995
            'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
1287
996
 
1288
997
    def assertIsSameRealPath(self, path1, path2):
1289
998
        """Fail if path1 and path2 points to different files"""
1291
1000
                         osutils.realpath(path2),
1292
1001
                         "apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1293
1002
 
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
 
        """
 
1003
    def assertIsInstance(self, obj, kls):
 
1004
        """Fail if obj is not an instance of kls"""
1299
1005
        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)
 
1006
            self.fail("%r is an instance of %s rather than %s" % (
 
1007
                obj, obj.__class__, kls))
 
1008
 
 
1009
    def expectFailure(self, reason, assertion, *args, **kwargs):
 
1010
        """Invoke a test, expecting it to fail for the given reason.
 
1011
 
 
1012
        This is for assertions that ought to succeed, but currently fail.
 
1013
        (The failure is *expected* but not *wanted*.)  Please be very precise
 
1014
        about the failure you're expecting.  If a new bug is introduced,
 
1015
        AssertionError should be raised, not KnownFailure.
 
1016
 
 
1017
        Frequently, expectFailure should be followed by an opposite assertion.
 
1018
        See example below.
 
1019
 
 
1020
        Intended to be used with a callable that raises AssertionError as the
 
1021
        'assertion' parameter.  args and kwargs are passed to the 'assertion'.
 
1022
 
 
1023
        Raises KnownFailure if the test fails.  Raises AssertionError if the
 
1024
        test succeeds.
 
1025
 
 
1026
        example usage::
 
1027
 
 
1028
          self.expectFailure('Math is broken', self.assertNotEqual, 54,
 
1029
                             dynamic_val)
 
1030
          self.assertEqual(42, dynamic_val)
 
1031
 
 
1032
          This means that a dynamic_val of 54 will cause the test to raise
 
1033
          a KnownFailure.  Once math is fixed and the expectFailure is removed,
 
1034
          only a dynamic_val of 42 will allow the test to pass.  Anything other
 
1035
          than 54 or 42 will cause an AssertionError.
 
1036
        """
 
1037
        try:
 
1038
            assertion(*args, **kwargs)
 
1039
        except AssertionError:
 
1040
            raise KnownFailure(reason)
 
1041
        else:
 
1042
            self.fail('Unexpected success.  Should have failed: %s' % reason)
1305
1043
 
1306
1044
    def assertFileEqual(self, content, path):
1307
1045
        """Fail if path does not contain 'content'."""
1313
1051
            f.close()
1314
1052
        self.assertEqualDiff(content, s)
1315
1053
 
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
1054
    def failUnlessExists(self, path):
1325
1055
        """Fail unless path or paths, which may be abs or relative, exist."""
1326
1056
        if not isinstance(path, basestring):
1369
1099
        To test that a deprecated method raises an error, do something like
1370
1100
        this::
1371
1101
 
1372
 
            self.assertRaises(errors.ReservedId,
1373
 
                self.applyDeprecated,
1374
 
                deprecated_in((1, 5, 0)),
1375
 
                br.append_revision,
1376
 
                'current:')
 
1102
        self.assertRaises(errors.ReservedId,
 
1103
            self.applyDeprecated, zero_ninetyone,
 
1104
                br.append_revision, 'current:')
1377
1105
 
1378
1106
        :param deprecation_format: The deprecation format that the callable
1379
1107
            should have been deprecated with. This is the same type as the
1413
1141
        # warnings.  It's the easiest way to insulate ourselves from -Werror,
1414
1142
        # though.  -- Andrew, 20071062
1415
1143
        wlist = []
1416
 
        def _catcher(message, category, filename, lineno, file=None, line=None):
 
1144
        def _catcher(message, category, filename, lineno, file=None):
1417
1145
            # despite the name, 'message' is normally(?) a Warning subclass
1418
1146
            # instance
1419
1147
            wlist.append(message)
1431
1159
    def callDeprecated(self, expected, callable, *args, **kwargs):
1432
1160
        """Assert that a callable is deprecated in a particular way.
1433
1161
 
1434
 
        This is a very precise test for unusual requirements. The
 
1162
        This is a very precise test for unusual requirements. The 
1435
1163
        applyDeprecated helper function is probably more suited for most tests
1436
1164
        as it allows you to simply specify the deprecation format being used
1437
1165
        and will ensure that that is issued for the function being called.
1466
1194
 
1467
1195
        Close the file and delete it, unless setKeepLogfile was called.
1468
1196
        """
1469
 
        if bzrlib.trace._trace_file:
1470
 
            # flush the log file, to get all content
1471
 
            bzrlib.trace._trace_file.flush()
 
1197
        if self._log_file is None:
 
1198
            return
1472
1199
        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):
 
1200
        self._log_file.close()
 
1201
        self._log_file = None
 
1202
        if not self._keep_log_file:
 
1203
            os.remove(self._log_file_name)
 
1204
            self._log_file_name = None
 
1205
 
 
1206
    def setKeepLogfile(self):
 
1207
        """Make the logfile not be deleted when _finishLogFile is called."""
 
1208
        self._keep_log_file = True
 
1209
 
 
1210
    def addCleanup(self, callable):
1490
1211
        """Arrange to run a callable when this case is torn down.
1491
1212
 
1492
 
        Callables are run in the reverse of the order they are registered,
 
1213
        Callables are run in the reverse of the order they are registered, 
1493
1214
        ie last-in first-out.
1494
1215
        """
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
 
1216
        if callable in self._cleanups:
 
1217
            raise ValueError("cleanup function %r already registered on %s" 
 
1218
                    % (callable, self))
 
1219
        self._cleanups.append(callable)
1515
1220
 
1516
1221
    def _cleanEnvironment(self):
1517
1222
        new_env = {
1518
1223
            'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1519
1224
            '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
 
1225
            'APPDATA': None,  # bzr now use Win32 API and don't rely on APPDATA
1522
1226
            'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1523
 
            'VISUAL': None,
1524
 
            'EDITOR': None,
1525
1227
            'BZR_EMAIL': None,
1526
1228
            'BZREMAIL': None, # may still be present in the environment
1527
1229
            'EMAIL': None,
1528
1230
            'BZR_PROGRESS_BAR': None,
1529
1231
            '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
1232
            # SSH Agent
1543
1233
            'SSH_AUTH_SOCK': None,
1544
1234
            # Proxies
1550
1240
            'NO_PROXY': None,
1551
1241
            'all_proxy': None,
1552
1242
            'ALL_PROXY': None,
1553
 
            # Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
 
1243
            # Nobody cares about these ones AFAIK. So far at
1554
1244
            # least. If you do (care), please update this comment
1555
 
            # -- vila 20080401
 
1245
            # -- vila 20061212
1556
1246
            'ftp_proxy': None,
1557
1247
            'FTP_PROXY': None,
1558
1248
            '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
1249
        }
1565
 
        self._old_env = {}
 
1250
        self.__old_env = {}
1566
1251
        self.addCleanup(self._restoreEnvironment)
1567
1252
        for name, value in new_env.iteritems():
1568
1253
            self._captureVar(name, value)
1569
1254
 
1570
1255
    def _captureVar(self, name, newvalue):
1571
1256
        """Set an environment variable, and reset it when finished."""
1572
 
        self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1257
        self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1258
 
 
1259
    def _restore_debug_flags(self):
 
1260
        debug.debug_flags.clear()
 
1261
        debug.debug_flags.update(self._preserved_debug_flags)
1573
1262
 
1574
1263
    def _restoreEnvironment(self):
1575
 
        for name, value in self._old_env.iteritems():
 
1264
        for name, value in self.__old_env.iteritems():
1576
1265
            osutils.set_or_unset_env(name, value)
1577
1266
 
1578
1267
    def _restoreHooks(self):
1579
 
        for klass, (name, hooks) in self._preserved_hooks.items():
1580
 
            setattr(klass, name, hooks)
 
1268
        for klass, hooks in self._preserved_hooks.items():
 
1269
            setattr(klass, 'hooks', hooks)
1581
1270
 
1582
1271
    def knownFailure(self, reason):
1583
1272
        """This test has failed for some known reason."""
1584
1273
        raise KnownFailure(reason)
1585
1274
 
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)
 
1275
    def run(self, result=None):
 
1276
        if result is None: result = self.defaultTestResult()
 
1277
        for feature in getattr(self, '_test_needs_features', []):
 
1278
            if not feature.available():
 
1279
                result.startTest(self)
 
1280
                if getattr(result, 'addNotSupported', None):
 
1281
                    result.addNotSupported(self, feature)
 
1282
                else:
 
1283
                    result.addSuccess(self)
 
1284
                result.stopTest(self)
 
1285
                return
 
1286
        return unittest.TestCase.run(self, result)
 
1287
 
 
1288
    def tearDown(self):
 
1289
        self._runCleanups()
 
1290
        unittest.TestCase.tearDown(self)
1622
1291
 
1623
1292
    def time(self, callable, *args, **kwargs):
1624
1293
        """Run callable and accrue the time it takes to the benchmark time.
1625
 
 
 
1294
        
1626
1295
        If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1627
1296
        this will cause lsprofile statistics to be gathered and stored in
1628
1297
        self._benchcalls.
1629
1298
        """
1630
1299
        if self._benchtime is None:
1631
 
            self.addDetail('benchtime', content.Content(content.ContentType(
1632
 
                "text", "plain"), lambda:[str(self._benchtime)]))
1633
1300
            self._benchtime = 0
1634
1301
        start = time.time()
1635
1302
        try:
1644
1311
        finally:
1645
1312
            self._benchtime += time.time() - start
1646
1313
 
 
1314
    def _runCleanups(self):
 
1315
        """Run registered cleanup functions. 
 
1316
 
 
1317
        This should only be called from TestCase.tearDown.
 
1318
        """
 
1319
        # TODO: Perhaps this should keep running cleanups even if 
 
1320
        # one of them fails?
 
1321
 
 
1322
        # Actually pop the cleanups from the list so tearDown running
 
1323
        # twice is safe (this happens for skipped tests).
 
1324
        while self._cleanups:
 
1325
            self._cleanups.pop()()
 
1326
 
1647
1327
    def log(self, *args):
1648
1328
        mutter(*args)
1649
1329
 
1650
1330
    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.
 
1331
        """Get the log from bzrlib.trace calls from this test.
1655
1332
 
1656
1333
        :param keep_log_file: When True, if the log is still a file on disk
1657
1334
            leave it as a file on disk. When False, if the log is still a file
1659
1336
            self._log_contents.
1660
1337
        :return: A string containing the log.
1661
1338
        """
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')
 
1339
        # flush the log file, to get all content
 
1340
        import bzrlib.trace
 
1341
        bzrlib.trace._trace_file.flush()
 
1342
        if self._log_contents:
 
1343
            # XXX: this can hardly contain the content flushed above --vila
 
1344
            # 20080128
1668
1345
            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
1346
        if self._log_file_name is not None:
1674
1347
            logfile = open(self._log_file_name)
1675
1348
            try:
1676
1349
                log_contents = logfile.read()
1677
1350
            finally:
1678
1351
                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
1352
            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
1353
                self._log_contents = log_contents
1716
1354
                try:
1717
1355
                    os.remove(self._log_file_name)
1721
1359
                                             ' %r\n' % self._log_file_name))
1722
1360
                    else:
1723
1361
                        raise
1724
 
                self._log_file_name = None
1725
1362
            return log_contents
1726
1363
        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())
 
1364
            return "DELETED log file to reduce memory footprint"
1735
1365
 
1736
1366
    def requireFeature(self, feature):
1737
1367
        """This test requires a specific feature is available.
1754
1384
 
1755
1385
    def _run_bzr_core(self, args, retcode, encoding, stdin,
1756
1386
            working_dir):
1757
 
        # Clear chk_map page cache, because the contents are likely to mask
1758
 
        # locking errors.
1759
 
        chk_map.clear_cache()
1760
1387
        if encoding is None:
1761
 
            encoding = osutils.get_user_encoding()
 
1388
            encoding = bzrlib.user_encoding
1762
1389
        stdout = StringIOWrapper()
1763
1390
        stderr = StringIOWrapper()
1764
1391
        stdout.encoding = encoding
1779
1406
            os.chdir(working_dir)
1780
1407
 
1781
1408
        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)
 
1409
            result = self.apply_redirected(ui.ui_factory.stdin,
 
1410
                stdout, stderr,
 
1411
                bzrlib.commands.run_bzr_catch_user_errors,
 
1412
                args)
1798
1413
        finally:
1799
1414
            logger.removeHandler(handler)
1800
1415
            ui.ui_factory = old_ui_factory
1810
1425
        if retcode is not None:
1811
1426
            self.assertEquals(retcode, result,
1812
1427
                              message='Unexpected return code')
1813
 
        return result, out, err
 
1428
        return out, err
1814
1429
 
1815
1430
    def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1816
1431
                working_dir=None, error_regexes=[], output_encoding=None):
1821
1436
        passed in three ways:
1822
1437
 
1823
1438
        1- A list of strings, eg ["commit", "a"].  This is recommended
1824
 
        when the command contains whitespace or metacharacters, or
 
1439
        when the command contains whitespace or metacharacters, or 
1825
1440
        is built up at run time.
1826
1441
 
1827
 
        2- A single string, eg "add a".  This is the most convenient
 
1442
        2- A single string, eg "add a".  This is the most convenient 
1828
1443
        for hardcoded commands.
1829
1444
 
1830
1445
        This runs bzr through the interface that catches and reports
1845
1460
        :keyword error_regexes: A list of expected error messages.  If
1846
1461
            specified they must be seen in the error output of the command.
1847
1462
        """
1848
 
        retcode, out, err = self._run_bzr_autosplit(
 
1463
        out, err = self._run_bzr_autosplit(
1849
1464
            args=args,
1850
1465
            retcode=retcode,
1851
1466
            encoding=encoding,
1852
1467
            stdin=stdin,
1853
1468
            working_dir=working_dir,
1854
1469
            )
1855
 
        self.assertIsInstance(error_regexes, (list, tuple))
1856
1470
        for regex in error_regexes:
1857
1471
            self.assertContainsRe(err, regex)
1858
1472
        return out, err
1890
1504
    def run_bzr_subprocess(self, *args, **kwargs):
1891
1505
        """Run bzr in a subprocess for testing.
1892
1506
 
1893
 
        This starts a new Python interpreter and runs bzr in there.
 
1507
        This starts a new Python interpreter and runs bzr in there. 
1894
1508
        This should only be used for tests that have a justifiable need for
1895
1509
        this isolation: e.g. they are testing startup time, or signal
1896
 
        handling, or early startup code, etc.  Subprocess code can't be
 
1510
        handling, or early startup code, etc.  Subprocess code can't be 
1897
1511
        profiled or debugged so easily.
1898
1512
 
1899
1513
        :keyword retcode: The status code that is expected.  Defaults to 0.  If
1917
1531
            elif isinstance(args[0], basestring):
1918
1532
                args = list(shlex.split(args[0]))
1919
1533
        else:
1920
 
            raise ValueError("passing varargs to run_bzr_subprocess")
 
1534
            symbol_versioning.warn(zero_ninetyone %
 
1535
                                   "passing varargs to run_bzr_subprocess",
 
1536
                                   DeprecationWarning, stacklevel=3)
1921
1537
        process = self.start_bzr_subprocess(args, env_changes=env_changes,
1922
1538
                                            working_dir=working_dir,
1923
1539
                                            allow_plugins=allow_plugins)
1979
1595
            # so we will avoid using it on all platforms, just to
1980
1596
            # make sure the code path is used, and we don't break on win32
1981
1597
            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)
 
1598
            command = [sys.executable, bzr_path]
1986
1599
            if not allow_plugins:
1987
1600
                command.append('--no-plugins')
1988
1601
            command.extend(process_args)
2002
1615
        """
2003
1616
        return Popen(*args, **kwargs)
2004
1617
 
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
1618
    def get_bzr_path(self):
2010
1619
        """Return the path of the 'bzr' executable for this test suite."""
2011
 
        bzr_path = self.get_source_path()+'/bzr'
 
1620
        bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
2012
1621
        if not os.path.isfile(bzr_path):
2013
1622
            # We are probably installed. Assume sys.argv is the right file
2014
1623
            bzr_path = sys.argv[0]
2100
1709
 
2101
1710
        Tests that expect to provoke LockContention errors should call this.
2102
1711
        """
2103
 
        self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
 
1712
        orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
 
1713
        def resetTimeout():
 
1714
            bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
 
1715
        self.addCleanup(resetTimeout)
 
1716
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2104
1717
 
2105
1718
    def make_utf8_encoded_stringio(self, encoding_type=None):
2106
1719
        """Return a StringIOWrapper instance, that will encode Unicode
2114
1727
        sio.encoding = output_encoding
2115
1728
        return sio
2116
1729
 
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
1730
 
2149
1731
class TestCaseWithMemoryTransport(TestCase):
2150
1732
    """Common test class for tests that do not need disk resources.
2170
1752
 
2171
1753
    def __init__(self, methodName='runTest'):
2172
1754
        # allow test parameterization after test construction and before test
2173
 
        # execution. Variables that the parameterizer sets need to be
 
1755
        # execution. Variables that the parameterizer sets need to be 
2174
1756
        # ones that are not set by setUp, or setUp will trash them.
2175
1757
        super(TestCaseWithMemoryTransport, self).__init__(methodName)
2176
1758
        self.vfs_transport_factory = default_transport
2183
1765
 
2184
1766
        This transport is for the test scratch space relative to
2185
1767
        "self._test_root"
2186
 
 
 
1768
        
2187
1769
        :param relpath: a path relative to the base url.
2188
1770
        """
2189
1771
        t = get_transport(self.get_url(relpath))
2192
1774
 
2193
1775
    def get_readonly_transport(self, relpath=None):
2194
1776
        """Return a readonly transport for the test scratch space
2195
 
 
 
1777
        
2196
1778
        This can be used to test that operations which should only need
2197
1779
        readonly access in fact do not try to write.
2198
1780
 
2217
1799
        if self.__readonly_server is None:
2218
1800
            if self.transport_readonly_server is None:
2219
1801
                # readonly decorator requested
2220
 
                self.__readonly_server = test_server.ReadonlyServer()
 
1802
                # bring up the server
 
1803
                self.__readonly_server = ReadonlyServer()
 
1804
                self.__readonly_server.setUp(self.get_vfs_only_server())
2221
1805
            else:
2222
 
                # explicit readonly transport.
2223
1806
                self.__readonly_server = self.create_transport_readonly_server()
2224
 
            self.start_server(self.__readonly_server,
2225
 
                self.get_vfs_only_server())
 
1807
                self.__readonly_server.setUp(self.get_vfs_only_server())
 
1808
            self.addCleanup(self.__readonly_server.tearDown)
2226
1809
        return self.__readonly_server
2227
1810
 
2228
1811
    def get_readonly_url(self, relpath=None):
2229
1812
        """Get a URL for the readonly transport.
2230
1813
 
2231
 
        This will either be backed by '.' or a decorator to the transport
 
1814
        This will either be backed by '.' or a decorator to the transport 
2232
1815
        used by self.get_url()
2233
1816
        relpath provides for clients to get a path relative to the base url.
2234
1817
        These should only be downwards relative, not upwards.
2246
1829
        is no means to override it.
2247
1830
        """
2248
1831
        if self.__vfs_server is None:
2249
 
            self.__vfs_server = memory.MemoryServer()
2250
 
            self.start_server(self.__vfs_server)
 
1832
            self.__vfs_server = MemoryServer()
 
1833
            self.__vfs_server.setUp()
 
1834
            self.addCleanup(self.__vfs_server.tearDown)
2251
1835
        return self.__vfs_server
2252
1836
 
2253
1837
    def get_server(self):
2260
1844
        then the self.get_vfs_server is returned.
2261
1845
        """
2262
1846
        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()
 
1847
            if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
 
1848
                return self.get_vfs_only_server()
2266
1849
            else:
2267
1850
                # bring up a decorated means of access to the vfs only server.
2268
1851
                self.__server = self.transport_server()
2269
 
                self.start_server(self.__server, self.get_vfs_only_server())
 
1852
                try:
 
1853
                    self.__server.setUp(self.get_vfs_only_server())
 
1854
                except TypeError, e:
 
1855
                    # This should never happen; the try:Except here is to assist
 
1856
                    # developers having to update code rather than seeing an
 
1857
                    # uninformative TypeError.
 
1858
                    raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
 
1859
            self.addCleanup(self.__server.tearDown)
2270
1860
        return self.__server
2271
1861
 
2272
1862
    def _adjust_url(self, base, relpath):
2334
1924
        propagating. This method ensures than a test did not leaked.
2335
1925
        """
2336
1926
        root = TestCaseWithMemoryTransport.TEST_ROOT
2337
 
        self.permit_url(get_transport(root).base)
2338
1927
        wt = workingtree.WorkingTree.open(root)
2339
1928
        last_rev = wt.last_revision()
2340
1929
        if last_rev != 'null:':
2342
1931
            # recreate a new one or all the followng tests will fail.
2343
1932
            # If you need to inspect its content uncomment the following line
2344
1933
            # import pdb; pdb.set_trace()
2345
 
            _rmtree_temp_dir(root + '/.bzr', test_id=self.id())
 
1934
            _rmtree_temp_dir(root + '/.bzr')
2346
1935
            self._create_safety_net()
2347
1936
            raise AssertionError('%s/.bzr should not be modified' % root)
2348
1937
 
2349
1938
    def _make_test_root(self):
2350
1939
        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'))
 
1940
            root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2354
1941
            TestCaseWithMemoryTransport.TEST_ROOT = root
2355
1942
 
2356
1943
            self._create_safety_net()
2359
1946
            # specifically told when all tests are finished.  This will do.
2360
1947
            atexit.register(_rmtree_temp_dir, root)
2361
1948
 
2362
 
        self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2363
1949
        self.addCleanup(self._check_safety_net)
2364
1950
 
2365
1951
    def makeAndChdirToTestDir(self):
2366
1952
        """Create a temporary directories for this one test.
2367
 
 
 
1953
        
2368
1954
        This must set self.test_home_dir and self.test_dir and chdir to
2369
1955
        self.test_dir.
2370
 
 
 
1956
        
2371
1957
        For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2372
1958
        """
2373
1959
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2374
1960
        self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2375
1961
        self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2376
 
        self.permit_dir(self.test_dir)
2377
 
 
 
1962
        
2378
1963
    def make_branch(self, relpath, format=None):
2379
1964
        """Create a branch on the transport at relpath."""
2380
1965
        repo = self.make_repository(relpath, format=format)
2398
1983
 
2399
1984
    def make_repository(self, relpath, shared=False, format=None):
2400
1985
        """Create a repository on our default transport at relpath.
2401
 
 
 
1986
        
2402
1987
        Note that relpath must be a relative path, not a full url.
2403
1988
        """
2404
1989
        # FIXME: If you create a remoterepository this returns the underlying
2405
 
        # real format, which is incorrect.  Actually we should make sure that
 
1990
        # real format, which is incorrect.  Actually we should make sure that 
2406
1991
        # RemoteBzrDir returns a RemoteRepository.
2407
1992
        # maybe  mbp 20070410
2408
1993
        made_control = self.make_bzrdir(relpath, format=format)
2409
1994
        return made_control.create_repository(shared=shared)
2410
1995
 
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
1996
    def make_branch_and_memory_tree(self, relpath, format=None):
2418
1997
        """Create a branch on the default transport and a MemoryTree for it."""
2419
1998
        b = self.make_branch(relpath, format=format)
2420
1999
        return memorytree.MemoryTree.create_on_branch(b)
2421
2000
 
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
2001
    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
 
 
 
2002
        os.environ['HOME'] = self.test_home_dir
 
2003
        os.environ['BZR_HOME'] = self.test_home_dir
 
2004
        
2433
2005
    def setUp(self):
2434
2006
        super(TestCaseWithMemoryTransport, self).setUp()
2435
2007
        self._make_test_root()
2436
 
        self.addCleanup(os.chdir, os.getcwdu())
 
2008
        _currentdir = os.getcwdu()
 
2009
        def _leaveDirectory():
 
2010
            os.chdir(_currentdir)
 
2011
        self.addCleanup(_leaveDirectory)
2437
2012
        self.makeAndChdirToTestDir()
2438
2013
        self.overrideEnvironmentForTesting()
2439
2014
        self.__readonly_server = None
2440
2015
        self.__server = None
2441
2016
        self.reduceLockdirTimeout()
2442
2017
 
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
 
 
 
2018
     
2461
2019
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2462
2020
    """Derived class that runs a test within a temporary directory.
2463
2021
 
2468
2026
    All test cases create their own directory within that.  If the
2469
2027
    tests complete successfully, the directory is removed.
2470
2028
 
2471
 
    :ivar test_base_dir: The path of the top-level directory for this
 
2029
    :ivar test_base_dir: The path of the top-level directory for this 
2472
2030
    test, which contains a home directory and a work directory.
2473
2031
 
2474
2032
    :ivar test_home_dir: An initially empty directory under test_base_dir
2488
2046
            self.log("actually: %r" % contents)
2489
2047
            self.fail("contents of %s not as expected" % filename)
2490
2048
 
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
2049
    def makeAndChdirToTestDir(self):
2502
2050
        """See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2503
 
 
 
2051
        
2504
2052
        For TestCaseInTempDir we create a temporary directory based on the test
2505
2053
        name and then create two subdirs - test and home under it.
2506
2054
        """
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()
 
2055
        # create a directory within the top level test directory
 
2056
        candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
 
2057
        # now create test and home directories within this dir
 
2058
        self.test_base_dir = candidate_dir
2526
2059
        self.test_home_dir = self.test_base_dir + '/home'
2527
2060
        os.mkdir(self.test_home_dir)
2528
2061
        self.test_dir = self.test_base_dir + '/work'
2534
2067
            f.write(self.id())
2535
2068
        finally:
2536
2069
            f.close()
 
2070
        self.addCleanup(self.deleteTestDir)
2537
2071
 
2538
2072
    def deleteTestDir(self):
2539
 
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2540
 
        _rmtree_temp_dir(self.test_base_dir, test_id=self.id())
 
2073
        os.chdir(self.TEST_ROOT)
 
2074
        _rmtree_temp_dir(self.test_base_dir)
2541
2075
 
2542
2076
    def build_tree(self, shape, line_endings='binary', transport=None):
2543
2077
        """Build a test tree according to a pattern.
2564
2098
        if transport is None or transport.is_readonly():
2565
2099
            transport = get_transport(".")
2566
2100
        for name in shape:
2567
 
            self.assertIsInstance(name, basestring)
 
2101
            self.assert_(isinstance(name, basestring))
2568
2102
            if name[-1] == '/':
2569
2103
                transport.mkdir(urlutils.escape(name[:-1]))
2570
2104
            else:
2578
2112
                content = "contents of %s%s" % (name.encode('utf-8'), end)
2579
2113
                transport.put_bytes_non_atomic(urlutils.escape(name), content)
2580
2114
 
2581
 
    build_tree_contents = treeshape.build_tree_contents
 
2115
    def build_tree_contents(self, shape):
 
2116
        build_tree_contents(shape)
2582
2117
 
2583
2118
    def assertInWorkingTree(self, path, root_path='.', tree=None):
2584
2119
        """Assert whether path or paths are in the WorkingTree"""
2586
2121
            tree = workingtree.WorkingTree.open(root_path)
2587
2122
        if not isinstance(path, basestring):
2588
2123
            for p in path:
2589
 
                self.assertInWorkingTree(p, tree=tree)
 
2124
                self.assertInWorkingTree(p,tree=tree)
2590
2125
        else:
2591
2126
            self.assertIsNot(tree.path2id(path), None,
2592
2127
                path+' not in working tree.')
2612
2147
    ReadonlyTransportDecorator is used instead which allows the use of non disk
2613
2148
    based read write transports.
2614
2149
 
2615
 
    If an explicit class is provided for readonly access, that server and the
 
2150
    If an explicit class is provided for readonly access, that server and the 
2616
2151
    readwrite one must both define get_url() as resolving to os.getcwd().
2617
2152
    """
2618
2153
 
2624
2159
        """
2625
2160
        if self.__vfs_server is None:
2626
2161
            self.__vfs_server = self.vfs_transport_factory()
2627
 
            self.start_server(self.__vfs_server)
 
2162
            self.__vfs_server.setUp()
 
2163
            self.addCleanup(self.__vfs_server.tearDown)
2628
2164
        return self.__vfs_server
2629
2165
 
2630
2166
    def make_branch_and_tree(self, relpath, format=None):
2637
2173
        repository will also be accessed locally. Otherwise a lightweight
2638
2174
        checkout is created and returned.
2639
2175
 
2640
 
        We do this because we can't physically create a tree in the local
2641
 
        path, with a branch reference to the transport_factory url, and
2642
 
        a branch + repository in the vfs_transport, unless the vfs_transport
2643
 
        namespace is distinct from the local disk - the two branch objects
2644
 
        would collide. While we could construct a tree with its branch object
2645
 
        pointing at the transport_factory transport in memory, reopening it
2646
 
        would behaving unexpectedly, and has in the past caused testing bugs
2647
 
        when we tried to do it that way.
2648
 
 
2649
2176
        :param format: The BzrDirFormat.
2650
2177
        :returns: the WorkingTree.
2651
2178
        """
2660
2187
            # We can only make working trees locally at the moment.  If the
2661
2188
            # transport can't support them, then we keep the non-disk-backed
2662
2189
            # branch and create a local checkout.
2663
 
            if self.vfs_transport_factory is test_server.LocalURLServer:
 
2190
            if self.vfs_transport_factory is LocalURLServer:
2664
2191
                # the branch is colocated on disk, we cannot create a checkout.
2665
2192
                # hopefully callers will expect this.
2666
2193
                local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2667
 
                wt = local_controldir.create_workingtree()
2668
 
                if wt.branch._format != b._format:
2669
 
                    wt._branch = b
2670
 
                    # Make sure that assigning to wt._branch fixes wt.branch,
2671
 
                    # in case the implementation details of workingtree objects
2672
 
                    # change.
2673
 
                    self.assertIs(b, wt.branch)
2674
 
                return wt
 
2194
                return local_controldir.create_workingtree()
2675
2195
            else:
2676
2196
                return b.create_checkout(relpath, lightweight=True)
2677
2197
 
2703
2223
        super(TestCaseWithTransport, self).setUp()
2704
2224
        self.__vfs_server = None
2705
2225
 
2706
 
    def disable_missing_extensions_warning(self):
2707
 
        """Some tests expect a precise stderr content.
2708
 
 
2709
 
        There is no point in forcing them to duplicate the extension related
2710
 
        warning.
2711
 
        """
2712
 
        config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2713
 
 
2714
2226
 
2715
2227
class ChrootedTestCase(TestCaseWithTransport):
2716
2228
    """A support class that provides readonly urls outside the local namespace.
2720
2232
    for readonly urls.
2721
2233
 
2722
2234
    TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2723
 
                       be used without needed to redo it when a different
 
2235
                       be used without needed to redo it when a different 
2724
2236
                       subclass is in use ?
2725
2237
    """
2726
2238
 
2727
2239
    def setUp(self):
2728
2240
        super(ChrootedTestCase, self).setUp()
2729
 
        if not self.vfs_transport_factory == memory.MemoryServer:
 
2241
        if not self.vfs_transport_factory == MemoryServer:
2730
2242
            self.transport_readonly_server = HttpServer
2731
2243
 
2732
2244
 
2733
2245
def condition_id_re(pattern):
2734
2246
    """Create a condition filter which performs a re check on a test's id.
2735
 
 
 
2247
    
2736
2248
    :param pattern: A regular expression string.
2737
2249
    :return: A callable that returns True if the re matches.
2738
2250
    """
2739
 
    filter_re = osutils.re_compile_checked(pattern, 0,
2740
 
        'test filter')
 
2251
    filter_re = re.compile(pattern)
2741
2252
    def condition(test):
2742
2253
        test_id = test.id()
2743
2254
        return filter_re.search(test_id)
2746
2257
 
2747
2258
def condition_isinstance(klass_or_klass_list):
2748
2259
    """Create a condition filter which returns isinstance(param, klass).
2749
 
 
 
2260
    
2750
2261
    :return: A callable which when called with one parameter obj return the
2751
2262
        result of isinstance(obj, klass_or_klass_list).
2752
2263
    """
2757
2268
 
2758
2269
def condition_id_in_list(id_list):
2759
2270
    """Create a condition filter which verify that test's id in a list.
2760
 
 
2761
 
    :param id_list: A TestIdList object.
 
2271
    
 
2272
    :param name: A TestIdList object.
2762
2273
    :return: A callable that returns True if the test's id appears in the list.
2763
2274
    """
2764
2275
    def condition(test):
2765
 
        return id_list.includes(test.id())
2766
 
    return condition
2767
 
 
2768
 
 
2769
 
def condition_id_startswith(starts):
2770
 
    """Create a condition filter verifying that test's id starts with a string.
2771
 
 
2772
 
    :param starts: A list of string.
2773
 
    :return: A callable that returns True if the test's id starts with one of
2774
 
        the given strings.
2775
 
    """
2776
 
    def condition(test):
2777
 
        for start in starts:
2778
 
            if test.id().startswith(start):
2779
 
                return True
2780
 
        return False
 
2276
        return id_list.test_in(test.id())
2781
2277
    return condition
2782
2278
 
2783
2279
 
2799
2295
 
2800
2296
def filter_suite_by_condition(suite, condition):
2801
2297
    """Create a test suite by filtering another one.
2802
 
 
 
2298
    
2803
2299
    :param suite: The source suite.
2804
2300
    :param condition: A callable whose result evaluates True when called with a
2805
2301
        test case which should be included in the result.
2806
2302
    :return: A suite which contains the tests found in suite that pass
2807
2303
        condition.
2808
 
    """
 
2304
    """ 
2809
2305
    result = []
2810
2306
    for test in iter_suite_tests(suite):
2811
2307
        if condition(test):
2813
2309
    return TestUtil.TestSuite(result)
2814
2310
 
2815
2311
 
2816
 
def filter_suite_by_re(suite, pattern):
 
2312
def filter_suite_by_re(suite, pattern, exclude_pattern=DEPRECATED_PARAMETER,
 
2313
                       random_order=DEPRECATED_PARAMETER):
2817
2314
    """Create a test suite by filtering another one.
2818
 
 
 
2315
    
2819
2316
    :param suite:           the source suite
2820
2317
    :param pattern:         pattern that names must match
 
2318
    :param exclude_pattern: A pattern that names must not match. This parameter
 
2319
        is deprecated as of bzrlib 1.0. Please use the separate function
 
2320
        exclude_tests_by_re instead.
 
2321
    :param random_order:    If True, tests in the new suite will be put in
 
2322
        random order. This parameter is deprecated as of bzrlib 1.0. Please
 
2323
        use the separate function randomize_suite instead.
2821
2324
    :returns: the newly created suite
2822
 
    """
 
2325
    """ 
 
2326
    if deprecated_passed(exclude_pattern):
 
2327
        symbol_versioning.warn(
 
2328
            one_zero % "passing exclude_pattern to filter_suite_by_re",
 
2329
                DeprecationWarning, stacklevel=2)
 
2330
        if exclude_pattern is not None:
 
2331
            suite = exclude_tests_by_re(suite, exclude_pattern)
2823
2332
    condition = condition_id_re(pattern)
2824
2333
    result_suite = filter_suite_by_condition(suite, condition)
 
2334
    if deprecated_passed(random_order):
 
2335
        symbol_versioning.warn(
 
2336
            one_zero % "passing random_order to filter_suite_by_re",
 
2337
                DeprecationWarning, stacklevel=2)
 
2338
        if random_order:
 
2339
            result_suite = randomize_suite(result_suite)
2825
2340
    return result_suite
2826
2341
 
2827
2342
 
2837
2352
    return result_suite
2838
2353
 
2839
2354
 
2840
 
def filter_suite_by_id_startswith(suite, start):
2841
 
    """Create a test suite by filtering another one.
2842
 
 
2843
 
    :param suite: The source suite.
2844
 
    :param start: A list of string the test id must start with one of.
2845
 
    :returns: the newly created suite
2846
 
    """
2847
 
    condition = condition_id_startswith(start)
2848
 
    result_suite = filter_suite_by_condition(suite, condition)
2849
 
    return result_suite
2850
 
 
2851
 
 
2852
2355
def exclude_tests_by_re(suite, pattern):
2853
2356
    """Create a test suite which excludes some tests from suite.
2854
2357
 
2873
2376
 
2874
2377
def randomize_suite(suite):
2875
2378
    """Return a new TestSuite with suite's tests in random order.
2876
 
 
 
2379
    
2877
2380
    The tests in the input suite are flattened into a single suite in order to
2878
2381
    accomplish this. Any nested TestSuites are removed to provide global
2879
2382
    randomness.
2883
2386
    return TestUtil.TestSuite(tests)
2884
2387
 
2885
2388
 
2886
 
def split_suite_by_condition(suite, condition):
2887
 
    """Split a test suite into two by a condition.
 
2389
@deprecated_function(one_zero)
 
2390
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
 
2391
                     random_order=False, append_rest=True):
 
2392
    """DEPRECATED: Create a test suite by sorting another one.
2888
2393
 
2889
 
    :param suite: The suite to split.
2890
 
    :param condition: The condition to match on. Tests that match this
2891
 
        condition are returned in the first test suite, ones that do not match
2892
 
        are in the second suite.
2893
 
    :return: A tuple of two test suites, where the first contains tests from
2894
 
        suite matching the condition, and the second contains the remainder
2895
 
        from suite. The order within each output suite is the same as it was in
2896
 
        suite.
2897
 
    """
2898
 
    matched = []
2899
 
    did_not_match = []
2900
 
    for test in iter_suite_tests(suite):
2901
 
        if condition(test):
2902
 
            matched.append(test)
2903
 
        else:
2904
 
            did_not_match.append(test)
2905
 
    return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
 
2394
    This method has been decomposed into separate helper methods that should be
 
2395
    called directly:
 
2396
     - filter_suite_by_re
 
2397
     - exclude_tests_by_re
 
2398
     - randomize_suite
 
2399
     - split_suite_by_re
 
2400
    
 
2401
    :param suite:           the source suite
 
2402
    :param pattern:         pattern that names must match in order to go
 
2403
                            first in the new suite
 
2404
    :param exclude_pattern: pattern that names must not match, if any
 
2405
    :param random_order:    if True, tests in the new suite will be put in
 
2406
                            random order (with all tests matching pattern
 
2407
                            first).
 
2408
    :param append_rest:     if False, pattern is a strict filter and not
 
2409
                            just an ordering directive
 
2410
    :returns: the newly created suite
 
2411
    """ 
 
2412
    if exclude_pattern is not None:
 
2413
        suite = exclude_tests_by_re(suite, exclude_pattern)
 
2414
    if random_order:
 
2415
        order_changer = randomize_suite
 
2416
    else:
 
2417
        order_changer = preserve_input
 
2418
    if append_rest:
 
2419
        suites = map(order_changer, split_suite_by_re(suite, pattern))
 
2420
        return TestUtil.TestSuite(suites)
 
2421
    else:
 
2422
        return order_changer(filter_suite_by_re(suite, pattern))
2906
2423
 
2907
2424
 
2908
2425
def split_suite_by_re(suite, pattern):
2909
2426
    """Split a test suite into two by a regular expression.
2910
 
 
 
2427
    
2911
2428
    :param suite: The suite to split.
2912
2429
    :param pattern: A regular expression string. Test ids that match this
2913
2430
        pattern will be in the first test suite returned, and the others in the
2916
2433
        suite matching pattern, and the second contains the remainder from
2917
2434
        suite. The order within each output suite is the same as it was in
2918
2435
        suite.
2919
 
    """
2920
 
    return split_suite_by_condition(suite, condition_id_re(pattern))
 
2436
    """ 
 
2437
    matched = []
 
2438
    did_not_match = []
 
2439
    filter_re = re.compile(pattern)
 
2440
    for test in iter_suite_tests(suite):
 
2441
        test_id = test.id()
 
2442
        if filter_re.search(test_id):
 
2443
            matched.append(test)
 
2444
        else:
 
2445
            did_not_match.append(test)
 
2446
    return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2921
2447
 
2922
2448
 
2923
2449
def run_suite(suite, name='test', verbose=False, pattern=".*",
2927
2453
              list_only=False,
2928
2454
              random_seed=None,
2929
2455
              exclude_pattern=None,
2930
 
              strict=False,
2931
 
              runner_class=None,
2932
 
              suite_decorators=None,
2933
 
              stream=None,
2934
 
              result_decorators=None,
2935
 
              ):
2936
 
    """Run a test suite for bzr selftest.
2937
 
 
2938
 
    :param runner_class: The class of runner to use. Must support the
2939
 
        constructor arguments passed by run_suite which are more than standard
2940
 
        python uses.
2941
 
    :return: A boolean indicating success.
2942
 
    """
 
2456
              strict=False):
2943
2457
    TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2944
2458
    if verbose:
2945
2459
        verbosity = 2
2946
2460
    else:
2947
2461
        verbosity = 1
2948
 
    if runner_class is None:
2949
 
        runner_class = TextTestRunner
2950
 
    if stream is None:
2951
 
        stream = sys.stdout
2952
 
    runner = runner_class(stream=stream,
 
2462
    runner = TextTestRunner(stream=sys.stdout,
2953
2463
                            descriptions=0,
2954
2464
                            verbosity=verbosity,
2955
2465
                            bench_history=bench_history,
2956
 
                            strict=strict,
2957
 
                            result_decorators=result_decorators,
 
2466
                            list_only=list_only,
2958
2467
                            )
2959
2468
    runner.stop_on_failure=stop_on_failure
2960
 
    # built in decorator factories:
2961
 
    decorators = [
2962
 
        random_order(random_seed, runner),
2963
 
        exclude_tests(exclude_pattern),
2964
 
        ]
2965
 
    if matching_tests_first:
2966
 
        decorators.append(tests_first(pattern))
 
2469
    # Initialise the random number generator and display the seed used.
 
2470
    # We convert the seed to a long to make it reuseable across invocations.
 
2471
    random_order = False
 
2472
    if random_seed is not None:
 
2473
        random_order = True
 
2474
        if random_seed == "now":
 
2475
            random_seed = long(time.time())
 
2476
        else:
 
2477
            # Convert the seed to a long if we can
 
2478
            try:
 
2479
                random_seed = long(random_seed)
 
2480
            except:
 
2481
                pass
 
2482
        runner.stream.writeln("Randomizing test order using seed %s\n" %
 
2483
            (random_seed))
 
2484
        random.seed(random_seed)
 
2485
    # Customise the list of tests if requested
 
2486
    if exclude_pattern is not None:
 
2487
        suite = exclude_tests_by_re(suite, exclude_pattern)
 
2488
    if random_order:
 
2489
        order_changer = randomize_suite
2967
2490
    else:
2968
 
        decorators.append(filter_tests(pattern))
2969
 
    if suite_decorators:
2970
 
        decorators.extend(suite_decorators)
2971
 
    # tell the result object how many tests will be running: (except if
2972
 
    # --parallel=fork is being used. Robert said he will provide a better
2973
 
    # progress design later -- vila 20090817)
2974
 
    if fork_decorator not in decorators:
2975
 
        decorators.append(CountingDecorator)
2976
 
    for decorator in decorators:
2977
 
        suite = decorator(suite)
2978
 
    if list_only:
2979
 
        # Done after test suite decoration to allow randomisation etc
2980
 
        # to take effect, though that is of marginal benefit.
2981
 
        if verbosity >= 2:
2982
 
            stream.write("Listing tests only ...\n")
2983
 
        for t in iter_suite_tests(suite):
2984
 
            stream.write("%s\n" % (t.id()))
2985
 
        return True
 
2491
        order_changer = preserve_input
 
2492
    if pattern != '.*' or random_order:
 
2493
        if matching_tests_first:
 
2494
            suites = map(order_changer, split_suite_by_re(suite, pattern))
 
2495
            suite = TestUtil.TestSuite(suites)
 
2496
        else:
 
2497
            suite = order_changer(filter_suite_by_re(suite, pattern))
 
2498
 
2986
2499
    result = runner.run(suite)
 
2500
 
2987
2501
    if strict:
2988
2502
        return result.wasStrictlySuccessful()
2989
 
    else:
2990
 
        return result.wasSuccessful()
2991
 
 
2992
 
 
2993
 
# A registry where get() returns a suite decorator.
2994
 
parallel_registry = registry.Registry()
2995
 
 
2996
 
 
2997
 
def fork_decorator(suite):
2998
 
    concurrency = osutils.local_concurrency()
2999
 
    if concurrency == 1:
3000
 
        return suite
3001
 
    from testtools import ConcurrentTestSuite
3002
 
    return ConcurrentTestSuite(suite, fork_for_tests)
3003
 
parallel_registry.register('fork', fork_decorator)
3004
 
 
3005
 
 
3006
 
def subprocess_decorator(suite):
3007
 
    concurrency = osutils.local_concurrency()
3008
 
    if concurrency == 1:
3009
 
        return suite
3010
 
    from testtools import ConcurrentTestSuite
3011
 
    return ConcurrentTestSuite(suite, reinvoke_for_tests)
3012
 
parallel_registry.register('subprocess', subprocess_decorator)
3013
 
 
3014
 
 
3015
 
def exclude_tests(exclude_pattern):
3016
 
    """Return a test suite decorator that excludes tests."""
3017
 
    if exclude_pattern is None:
3018
 
        return identity_decorator
3019
 
    def decorator(suite):
3020
 
        return ExcludeDecorator(suite, exclude_pattern)
3021
 
    return decorator
3022
 
 
3023
 
 
3024
 
def filter_tests(pattern):
3025
 
    if pattern == '.*':
3026
 
        return identity_decorator
3027
 
    def decorator(suite):
3028
 
        return FilterTestsDecorator(suite, pattern)
3029
 
    return decorator
3030
 
 
3031
 
 
3032
 
def random_order(random_seed, runner):
3033
 
    """Return a test suite decorator factory for randomising tests order.
3034
 
    
3035
 
    :param random_seed: now, a string which casts to a long, or a long.
3036
 
    :param runner: A test runner with a stream attribute to report on.
3037
 
    """
3038
 
    if random_seed is None:
3039
 
        return identity_decorator
3040
 
    def decorator(suite):
3041
 
        return RandomDecorator(suite, random_seed, runner.stream)
3042
 
    return decorator
3043
 
 
3044
 
 
3045
 
def tests_first(pattern):
3046
 
    if pattern == '.*':
3047
 
        return identity_decorator
3048
 
    def decorator(suite):
3049
 
        return TestFirstDecorator(suite, pattern)
3050
 
    return decorator
3051
 
 
3052
 
 
3053
 
def identity_decorator(suite):
3054
 
    """Return suite."""
3055
 
    return suite
3056
 
 
3057
 
 
3058
 
class TestDecorator(TestSuite):
3059
 
    """A decorator for TestCase/TestSuite objects.
3060
 
    
3061
 
    Usually, subclasses should override __iter__(used when flattening test
3062
 
    suites), which we do to filter, reorder, parallelise and so on, run() and
3063
 
    debug().
3064
 
    """
3065
 
 
3066
 
    def __init__(self, suite):
3067
 
        TestSuite.__init__(self)
3068
 
        self.addTest(suite)
3069
 
 
3070
 
    def countTestCases(self):
3071
 
        cases = 0
3072
 
        for test in self:
3073
 
            cases += test.countTestCases()
3074
 
        return cases
3075
 
 
3076
 
    def debug(self):
3077
 
        for test in self:
3078
 
            test.debug()
3079
 
 
3080
 
    def run(self, result):
3081
 
        # Use iteration on self, not self._tests, to allow subclasses to hook
3082
 
        # into __iter__.
3083
 
        for test in self:
3084
 
            if result.shouldStop:
3085
 
                break
3086
 
            test.run(result)
3087
 
        return result
3088
 
 
3089
 
 
3090
 
class CountingDecorator(TestDecorator):
3091
 
    """A decorator which calls result.progress(self.countTestCases)."""
3092
 
 
3093
 
    def run(self, result):
3094
 
        progress_method = getattr(result, 'progress', None)
3095
 
        if callable(progress_method):
3096
 
            progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3097
 
        return super(CountingDecorator, self).run(result)
3098
 
 
3099
 
 
3100
 
class ExcludeDecorator(TestDecorator):
3101
 
    """A decorator which excludes test matching an exclude pattern."""
3102
 
 
3103
 
    def __init__(self, suite, exclude_pattern):
3104
 
        TestDecorator.__init__(self, suite)
3105
 
        self.exclude_pattern = exclude_pattern
3106
 
        self.excluded = False
3107
 
 
3108
 
    def __iter__(self):
3109
 
        if self.excluded:
3110
 
            return iter(self._tests)
3111
 
        self.excluded = True
3112
 
        suite = exclude_tests_by_re(self, self.exclude_pattern)
3113
 
        del self._tests[:]
3114
 
        self.addTests(suite)
3115
 
        return iter(self._tests)
3116
 
 
3117
 
 
3118
 
class FilterTestsDecorator(TestDecorator):
3119
 
    """A decorator which filters tests to those matching a pattern."""
3120
 
 
3121
 
    def __init__(self, suite, pattern):
3122
 
        TestDecorator.__init__(self, suite)
3123
 
        self.pattern = pattern
3124
 
        self.filtered = False
3125
 
 
3126
 
    def __iter__(self):
3127
 
        if self.filtered:
3128
 
            return iter(self._tests)
3129
 
        self.filtered = True
3130
 
        suite = filter_suite_by_re(self, self.pattern)
3131
 
        del self._tests[:]
3132
 
        self.addTests(suite)
3133
 
        return iter(self._tests)
3134
 
 
3135
 
 
3136
 
class RandomDecorator(TestDecorator):
3137
 
    """A decorator which randomises the order of its tests."""
3138
 
 
3139
 
    def __init__(self, suite, random_seed, stream):
3140
 
        TestDecorator.__init__(self, suite)
3141
 
        self.random_seed = random_seed
3142
 
        self.randomised = False
3143
 
        self.stream = stream
3144
 
 
3145
 
    def __iter__(self):
3146
 
        if self.randomised:
3147
 
            return iter(self._tests)
3148
 
        self.randomised = True
3149
 
        self.stream.write("Randomizing test order using seed %s\n\n" %
3150
 
            (self.actual_seed()))
3151
 
        # Initialise the random number generator.
3152
 
        random.seed(self.actual_seed())
3153
 
        suite = randomize_suite(self)
3154
 
        del self._tests[:]
3155
 
        self.addTests(suite)
3156
 
        return iter(self._tests)
3157
 
 
3158
 
    def actual_seed(self):
3159
 
        if self.random_seed == "now":
3160
 
            # We convert the seed to a long to make it reuseable across
3161
 
            # invocations (because the user can reenter it).
3162
 
            self.random_seed = long(time.time())
3163
 
        else:
3164
 
            # Convert the seed to a long if we can
3165
 
            try:
3166
 
                self.random_seed = long(self.random_seed)
3167
 
            except:
3168
 
                pass
3169
 
        return self.random_seed
3170
 
 
3171
 
 
3172
 
class TestFirstDecorator(TestDecorator):
3173
 
    """A decorator which moves named tests to the front."""
3174
 
 
3175
 
    def __init__(self, suite, pattern):
3176
 
        TestDecorator.__init__(self, suite)
3177
 
        self.pattern = pattern
3178
 
        self.filtered = False
3179
 
 
3180
 
    def __iter__(self):
3181
 
        if self.filtered:
3182
 
            return iter(self._tests)
3183
 
        self.filtered = True
3184
 
        suites = split_suite_by_re(self, self.pattern)
3185
 
        del self._tests[:]
3186
 
        self.addTests(suites)
3187
 
        return iter(self._tests)
3188
 
 
3189
 
 
3190
 
def partition_tests(suite, count):
3191
 
    """Partition suite into count lists of tests."""
3192
 
    result = []
3193
 
    tests = list(iter_suite_tests(suite))
3194
 
    tests_per_process = int(math.ceil(float(len(tests)) / count))
3195
 
    for block in range(count):
3196
 
        low_test = block * tests_per_process
3197
 
        high_test = low_test + tests_per_process
3198
 
        process_tests = tests[low_test:high_test]
3199
 
        result.append(process_tests)
3200
 
    return result
3201
 
 
3202
 
 
3203
 
def workaround_zealous_crypto_random():
3204
 
    """Crypto.Random want to help us being secure, but we don't care here.
3205
 
 
3206
 
    This workaround some test failure related to the sftp server. Once paramiko
3207
 
    stop using the controversial API in Crypto.Random, we may get rid of it.
3208
 
    """
3209
 
    try:
3210
 
        from Crypto.Random import atfork
3211
 
        atfork()
3212
 
    except ImportError:
3213
 
        pass
3214
 
 
3215
 
 
3216
 
def fork_for_tests(suite):
3217
 
    """Take suite and start up one runner per CPU by forking()
3218
 
 
3219
 
    :return: An iterable of TestCase-like objects which can each have
3220
 
        run(result) called on them to feed tests to result.
3221
 
    """
3222
 
    concurrency = osutils.local_concurrency()
3223
 
    result = []
3224
 
    from subunit import TestProtocolClient, ProtocolTestCase
3225
 
    from subunit.test_results import AutoTimingTestResultDecorator
3226
 
    class TestInOtherProcess(ProtocolTestCase):
3227
 
        # Should be in subunit, I think. RBC.
3228
 
        def __init__(self, stream, pid):
3229
 
            ProtocolTestCase.__init__(self, stream)
3230
 
            self.pid = pid
3231
 
 
3232
 
        def run(self, result):
3233
 
            try:
3234
 
                ProtocolTestCase.run(self, result)
3235
 
            finally:
3236
 
                os.waitpid(self.pid, 0)
3237
 
 
3238
 
    test_blocks = partition_tests(suite, concurrency)
3239
 
    for process_tests in test_blocks:
3240
 
        process_suite = TestSuite()
3241
 
        process_suite.addTests(process_tests)
3242
 
        c2pread, c2pwrite = os.pipe()
3243
 
        pid = os.fork()
3244
 
        if pid == 0:
3245
 
            workaround_zealous_crypto_random()
3246
 
            try:
3247
 
                os.close(c2pread)
3248
 
                # Leave stderr and stdout open so we can see test noise
3249
 
                # Close stdin so that the child goes away if it decides to
3250
 
                # read from stdin (otherwise its a roulette to see what
3251
 
                # child actually gets keystrokes for pdb etc).
3252
 
                sys.stdin.close()
3253
 
                sys.stdin = None
3254
 
                stream = os.fdopen(c2pwrite, 'wb', 1)
3255
 
                subunit_result = AutoTimingTestResultDecorator(
3256
 
                    TestProtocolClient(stream))
3257
 
                process_suite.run(subunit_result)
3258
 
            finally:
3259
 
                os._exit(0)
3260
 
        else:
3261
 
            os.close(c2pwrite)
3262
 
            stream = os.fdopen(c2pread, 'rb', 1)
3263
 
            test = TestInOtherProcess(stream, pid)
3264
 
            result.append(test)
3265
 
    return result
3266
 
 
3267
 
 
3268
 
def reinvoke_for_tests(suite):
3269
 
    """Take suite and start up one runner per CPU using subprocess().
3270
 
 
3271
 
    :return: An iterable of TestCase-like objects which can each have
3272
 
        run(result) called on them to feed tests to result.
3273
 
    """
3274
 
    concurrency = osutils.local_concurrency()
3275
 
    result = []
3276
 
    from subunit import ProtocolTestCase
3277
 
    class TestInSubprocess(ProtocolTestCase):
3278
 
        def __init__(self, process, name):
3279
 
            ProtocolTestCase.__init__(self, process.stdout)
3280
 
            self.process = process
3281
 
            self.process.stdin.close()
3282
 
            self.name = name
3283
 
 
3284
 
        def run(self, result):
3285
 
            try:
3286
 
                ProtocolTestCase.run(self, result)
3287
 
            finally:
3288
 
                self.process.wait()
3289
 
                os.unlink(self.name)
3290
 
            # print "pid %d finished" % finished_process
3291
 
    test_blocks = partition_tests(suite, concurrency)
3292
 
    for process_tests in test_blocks:
3293
 
        # ugly; currently reimplement rather than reuses TestCase methods.
3294
 
        bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3295
 
        if not os.path.isfile(bzr_path):
3296
 
            # We are probably installed. Assume sys.argv is the right file
3297
 
            bzr_path = sys.argv[0]
3298
 
        bzr_path = [bzr_path]
3299
 
        if sys.platform == "win32":
3300
 
            # if we're on windows, we can't execute the bzr script directly
3301
 
            bzr_path = [sys.executable] + bzr_path
3302
 
        fd, test_list_file_name = tempfile.mkstemp()
3303
 
        test_list_file = os.fdopen(fd, 'wb', 1)
3304
 
        for test in process_tests:
3305
 
            test_list_file.write(test.id() + '\n')
3306
 
        test_list_file.close()
3307
 
        try:
3308
 
            argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3309
 
                '--subunit']
3310
 
            if '--no-plugins' in sys.argv:
3311
 
                argv.append('--no-plugins')
3312
 
            # stderr=STDOUT would be ideal, but until we prevent noise on
3313
 
            # stderr it can interrupt the subunit protocol.
3314
 
            process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3315
 
                bufsize=1)
3316
 
            test = TestInSubprocess(process, test_list_file_name)
3317
 
            result.append(test)
3318
 
        except:
3319
 
            os.unlink(test_list_file_name)
3320
 
            raise
3321
 
    return result
3322
 
 
3323
 
 
3324
 
class ForwardingResult(unittest.TestResult):
3325
 
 
3326
 
    def __init__(self, target):
3327
 
        unittest.TestResult.__init__(self)
3328
 
        self.result = target
3329
 
 
3330
 
    def startTest(self, test):
3331
 
        self.result.startTest(test)
3332
 
 
3333
 
    def stopTest(self, test):
3334
 
        self.result.stopTest(test)
3335
 
 
3336
 
    def startTestRun(self):
3337
 
        self.result.startTestRun()
3338
 
 
3339
 
    def stopTestRun(self):
3340
 
        self.result.stopTestRun()
3341
 
 
3342
 
    def addSkip(self, test, reason):
3343
 
        self.result.addSkip(test, reason)
3344
 
 
3345
 
    def addSuccess(self, test):
3346
 
        self.result.addSuccess(test)
3347
 
 
3348
 
    def addError(self, test, err):
3349
 
        self.result.addError(test, err)
3350
 
 
3351
 
    def addFailure(self, test, err):
3352
 
        self.result.addFailure(test, err)
3353
 
ForwardingResult = testtools.ExtendedToOriginalDecorator
3354
 
 
3355
 
 
3356
 
class ProfileResult(ForwardingResult):
3357
 
    """Generate profiling data for all activity between start and success.
3358
 
    
3359
 
    The profile data is appended to the test's _benchcalls attribute and can
3360
 
    be accessed by the forwarded-to TestResult.
3361
 
 
3362
 
    While it might be cleaner do accumulate this in stopTest, addSuccess is
3363
 
    where our existing output support for lsprof is, and this class aims to
3364
 
    fit in with that: while it could be moved it's not necessary to accomplish
3365
 
    test profiling, nor would it be dramatically cleaner.
3366
 
    """
3367
 
 
3368
 
    def startTest(self, test):
3369
 
        self.profiler = bzrlib.lsprof.BzrProfiler()
3370
 
        self.profiler.start()
3371
 
        ForwardingResult.startTest(self, test)
3372
 
 
3373
 
    def addSuccess(self, test):
3374
 
        stats = self.profiler.stop()
3375
 
        try:
3376
 
            calls = test._benchcalls
3377
 
        except AttributeError:
3378
 
            test._benchcalls = []
3379
 
            calls = test._benchcalls
3380
 
        calls.append(((test.id(), "", ""), stats))
3381
 
        ForwardingResult.addSuccess(self, test)
3382
 
 
3383
 
    def stopTest(self, test):
3384
 
        ForwardingResult.stopTest(self, test)
3385
 
        self.profiler = None
3386
 
 
3387
 
 
3388
 
# Controlled by "bzr selftest -E=..." option
3389
 
# Currently supported:
3390
 
#   -Eallow_debug           Will no longer clear debug.debug_flags() so it
3391
 
#                           preserves any flags supplied at the command line.
3392
 
#   -Edisable_lock_checks   Turns errors in mismatched locks into simple prints
3393
 
#                           rather than failing tests. And no longer raise
3394
 
#                           LockContention when fctnl locks are not being used
3395
 
#                           with proper exclusion rules.
3396
 
selftest_debug_flags = set()
 
2503
 
 
2504
    return result.wasSuccessful()
3397
2505
 
3398
2506
 
3399
2507
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3407
2515
             exclude_pattern=None,
3408
2516
             strict=False,
3409
2517
             load_list=None,
3410
 
             debug_flags=None,
3411
 
             starting_with=None,
3412
 
             runner_class=None,
3413
 
             suite_decorators=None,
3414
 
             stream=None,
3415
 
             lsprof_tests=False,
3416
2518
             ):
3417
2519
    """Run the whole test suite under the enhanced runner"""
3418
2520
    # XXX: Very ugly way to do this...
3426
2528
        transport = default_transport
3427
2529
    old_transport = default_transport
3428
2530
    default_transport = transport
3429
 
    global selftest_debug_flags
3430
 
    old_debug_flags = selftest_debug_flags
3431
 
    if debug_flags is not None:
3432
 
        selftest_debug_flags = set(debug_flags)
3433
2531
    try:
3434
2532
        if load_list is None:
3435
2533
            keep_only = None
3436
2534
        else:
3437
2535
            keep_only = load_test_id_list(load_list)
3438
 
        if starting_with:
3439
 
            starting_with = [test_prefix_alias_registry.resolve_alias(start)
3440
 
                             for start in starting_with]
3441
2536
        if test_suite_factory is None:
3442
 
            # Reduce loading time by loading modules based on the starting_with
3443
 
            # patterns.
3444
 
            suite = test_suite(keep_only, starting_with)
 
2537
            suite = test_suite(keep_only)
3445
2538
        else:
3446
2539
            suite = test_suite_factory()
3447
 
        if starting_with:
3448
 
            # But always filter as requested.
3449
 
            suite = filter_suite_by_id_startswith(suite, starting_with)
3450
 
        result_decorators = []
3451
 
        if lsprof_tests:
3452
 
            result_decorators.append(ProfileResult)
3453
2540
        return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3454
2541
                     stop_on_failure=stop_on_failure,
3455
2542
                     transport=transport,
3459
2546
                     list_only=list_only,
3460
2547
                     random_seed=random_seed,
3461
2548
                     exclude_pattern=exclude_pattern,
3462
 
                     strict=strict,
3463
 
                     runner_class=runner_class,
3464
 
                     suite_decorators=suite_decorators,
3465
 
                     stream=stream,
3466
 
                     result_decorators=result_decorators,
3467
 
                     )
 
2549
                     strict=strict)
3468
2550
    finally:
3469
2551
        default_transport = old_transport
3470
 
        selftest_debug_flags = old_debug_flags
3471
2552
 
3472
2553
 
3473
2554
def load_test_id_list(file_name):
3493
2574
    return test_list
3494
2575
 
3495
2576
 
3496
 
def suite_matches_id_list(test_suite, id_list):
3497
 
    """Warns about tests not appearing or appearing more than once.
3498
 
 
3499
 
    :param test_suite: A TestSuite object.
3500
 
    :param test_id_list: The list of test ids that should be found in
3501
 
         test_suite.
3502
 
 
3503
 
    :return: (absents, duplicates) absents is a list containing the test found
3504
 
        in id_list but not in test_suite, duplicates is a list containing the
3505
 
        test found multiple times in test_suite.
3506
 
 
3507
 
    When using a prefined test id list, it may occurs that some tests do not
3508
 
    exist anymore or that some tests use the same id. This function warns the
3509
 
    tester about potential problems in his workflow (test lists are volatile)
3510
 
    or in the test suite itself (using the same id for several tests does not
3511
 
    help to localize defects).
3512
 
    """
3513
 
    # Build a dict counting id occurrences
3514
 
    tests = dict()
3515
 
    for test in iter_suite_tests(test_suite):
3516
 
        id = test.id()
3517
 
        tests[id] = tests.get(id, 0) + 1
3518
 
 
3519
 
    not_found = []
3520
 
    duplicates = []
3521
 
    for id in id_list:
3522
 
        occurs = tests.get(id, 0)
3523
 
        if not occurs:
3524
 
            not_found.append(id)
3525
 
        elif occurs > 1:
3526
 
            duplicates.append(id)
3527
 
 
3528
 
    return not_found, duplicates
3529
 
 
3530
 
 
3531
2577
class TestIdList(object):
3532
2578
    """Test id list to filter a test suite.
3533
2579
 
3564
2610
                modules[mod_name] = True
3565
2611
        self.modules = modules
3566
2612
 
3567
 
    def refers_to(self, module_name):
 
2613
    def is_module_name_used(self, module_name):
3568
2614
        """Is there tests for the module or one of its sub modules."""
3569
2615
        return self.modules.has_key(module_name)
3570
2616
 
3571
 
    def includes(self, test_id):
 
2617
    def test_in(self, test_id):
3572
2618
        return self.tests.has_key(test_id)
3573
2619
 
3574
2620
 
3575
 
class TestPrefixAliasRegistry(registry.Registry):
3576
 
    """A registry for test prefix aliases.
3577
 
 
3578
 
    This helps implement shorcuts for the --starting-with selftest
3579
 
    option. Overriding existing prefixes is not allowed but not fatal (a
3580
 
    warning will be emitted).
3581
 
    """
3582
 
 
3583
 
    def register(self, key, obj, help=None, info=None,
3584
 
                 override_existing=False):
3585
 
        """See Registry.register.
3586
 
 
3587
 
        Trying to override an existing alias causes a warning to be emitted,
3588
 
        not a fatal execption.
3589
 
        """
3590
 
        try:
3591
 
            super(TestPrefixAliasRegistry, self).register(
3592
 
                key, obj, help=help, info=info, override_existing=False)
3593
 
        except KeyError:
3594
 
            actual = self.get(key)
3595
 
            note('Test prefix alias %s is already used for %s, ignoring %s'
3596
 
                 % (key, actual, obj))
3597
 
 
3598
 
    def resolve_alias(self, id_start):
3599
 
        """Replace the alias by the prefix in the given string.
3600
 
 
3601
 
        Using an unknown prefix is an error to help catching typos.
3602
 
        """
3603
 
        parts = id_start.split('.')
3604
 
        try:
3605
 
            parts[0] = self.get(parts[0])
3606
 
        except KeyError:
3607
 
            raise errors.BzrCommandError(
3608
 
                '%s is not a known test prefix alias' % parts[0])
3609
 
        return '.'.join(parts)
3610
 
 
3611
 
 
3612
 
test_prefix_alias_registry = TestPrefixAliasRegistry()
3613
 
"""Registry of test prefix aliases."""
3614
 
 
3615
 
 
3616
 
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3617
 
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3618
 
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3619
 
 
3620
 
# Obvious highest levels prefixes, feel free to add your own via a plugin
3621
 
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3622
 
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3623
 
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3624
 
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3625
 
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3626
 
 
3627
 
 
3628
 
def _test_suite_testmod_names():
3629
 
    """Return the standard list of test module names to test."""
3630
 
    return [
3631
 
        'bzrlib.doc',
3632
 
        'bzrlib.tests.blackbox',
3633
 
        'bzrlib.tests.commands',
3634
 
        'bzrlib.tests.per_branch',
3635
 
        'bzrlib.tests.per_bzrdir',
3636
 
        'bzrlib.tests.per_bzrdir_colo',
3637
 
        'bzrlib.tests.per_foreign_vcs',
3638
 
        'bzrlib.tests.per_interrepository',
3639
 
        'bzrlib.tests.per_intertree',
3640
 
        'bzrlib.tests.per_inventory',
3641
 
        'bzrlib.tests.per_interbranch',
3642
 
        'bzrlib.tests.per_lock',
3643
 
        'bzrlib.tests.per_merger',
3644
 
        'bzrlib.tests.per_transport',
3645
 
        'bzrlib.tests.per_tree',
3646
 
        'bzrlib.tests.per_pack_repository',
3647
 
        'bzrlib.tests.per_repository',
3648
 
        'bzrlib.tests.per_repository_chk',
3649
 
        'bzrlib.tests.per_repository_reference',
3650
 
        'bzrlib.tests.per_uifactory',
3651
 
        'bzrlib.tests.per_versionedfile',
3652
 
        'bzrlib.tests.per_workingtree',
3653
 
        'bzrlib.tests.test__annotator',
3654
 
        'bzrlib.tests.test__bencode',
3655
 
        'bzrlib.tests.test__chk_map',
3656
 
        'bzrlib.tests.test__dirstate_helpers',
3657
 
        'bzrlib.tests.test__groupcompress',
3658
 
        'bzrlib.tests.test__known_graph',
3659
 
        'bzrlib.tests.test__rio',
3660
 
        'bzrlib.tests.test__simple_set',
3661
 
        'bzrlib.tests.test__static_tuple',
3662
 
        'bzrlib.tests.test__walkdirs_win32',
3663
 
        'bzrlib.tests.test_ancestry',
3664
 
        'bzrlib.tests.test_annotate',
3665
 
        'bzrlib.tests.test_api',
3666
 
        'bzrlib.tests.test_atomicfile',
3667
 
        'bzrlib.tests.test_bad_files',
3668
 
        'bzrlib.tests.test_bisect_multi',
3669
 
        'bzrlib.tests.test_branch',
3670
 
        'bzrlib.tests.test_branchbuilder',
3671
 
        'bzrlib.tests.test_btree_index',
3672
 
        'bzrlib.tests.test_bugtracker',
3673
 
        'bzrlib.tests.test_bundle',
3674
 
        'bzrlib.tests.test_bzrdir',
3675
 
        'bzrlib.tests.test__chunks_to_lines',
3676
 
        'bzrlib.tests.test_cache_utf8',
3677
 
        'bzrlib.tests.test_chk_map',
3678
 
        'bzrlib.tests.test_chk_serializer',
3679
 
        'bzrlib.tests.test_chunk_writer',
3680
 
        'bzrlib.tests.test_clean_tree',
3681
 
        'bzrlib.tests.test_cleanup',
3682
 
        'bzrlib.tests.test_cmdline',
3683
 
        'bzrlib.tests.test_commands',
3684
 
        'bzrlib.tests.test_commit',
3685
 
        'bzrlib.tests.test_commit_merge',
3686
 
        'bzrlib.tests.test_config',
3687
 
        'bzrlib.tests.test_conflicts',
3688
 
        'bzrlib.tests.test_counted_lock',
3689
 
        'bzrlib.tests.test_crash',
3690
 
        'bzrlib.tests.test_decorators',
3691
 
        'bzrlib.tests.test_delta',
3692
 
        'bzrlib.tests.test_debug',
3693
 
        'bzrlib.tests.test_deprecated_graph',
3694
 
        'bzrlib.tests.test_diff',
3695
 
        'bzrlib.tests.test_directory_service',
3696
 
        'bzrlib.tests.test_dirstate',
3697
 
        'bzrlib.tests.test_email_message',
3698
 
        'bzrlib.tests.test_eol_filters',
3699
 
        'bzrlib.tests.test_errors',
3700
 
        'bzrlib.tests.test_export',
3701
 
        'bzrlib.tests.test_extract',
3702
 
        'bzrlib.tests.test_fetch',
3703
 
        'bzrlib.tests.test_fifo_cache',
3704
 
        'bzrlib.tests.test_filters',
3705
 
        'bzrlib.tests.test_ftp_transport',
3706
 
        'bzrlib.tests.test_foreign',
3707
 
        'bzrlib.tests.test_generate_docs',
3708
 
        'bzrlib.tests.test_generate_ids',
3709
 
        'bzrlib.tests.test_globbing',
3710
 
        'bzrlib.tests.test_gpg',
3711
 
        'bzrlib.tests.test_graph',
3712
 
        'bzrlib.tests.test_groupcompress',
3713
 
        'bzrlib.tests.test_hashcache',
3714
 
        'bzrlib.tests.test_help',
3715
 
        'bzrlib.tests.test_hooks',
3716
 
        'bzrlib.tests.test_http',
3717
 
        'bzrlib.tests.test_http_response',
3718
 
        'bzrlib.tests.test_https_ca_bundle',
3719
 
        'bzrlib.tests.test_identitymap',
3720
 
        'bzrlib.tests.test_ignores',
3721
 
        'bzrlib.tests.test_index',
3722
 
        'bzrlib.tests.test_import_tariff',
3723
 
        'bzrlib.tests.test_info',
3724
 
        'bzrlib.tests.test_inv',
3725
 
        'bzrlib.tests.test_inventory_delta',
3726
 
        'bzrlib.tests.test_knit',
3727
 
        'bzrlib.tests.test_lazy_import',
3728
 
        'bzrlib.tests.test_lazy_regex',
3729
 
        'bzrlib.tests.test_lock',
3730
 
        'bzrlib.tests.test_lockable_files',
3731
 
        'bzrlib.tests.test_lockdir',
3732
 
        'bzrlib.tests.test_log',
3733
 
        'bzrlib.tests.test_lru_cache',
3734
 
        'bzrlib.tests.test_lsprof',
3735
 
        'bzrlib.tests.test_mail_client',
3736
 
        'bzrlib.tests.test_memorytree',
3737
 
        'bzrlib.tests.test_merge',
3738
 
        'bzrlib.tests.test_merge3',
3739
 
        'bzrlib.tests.test_merge_core',
3740
 
        'bzrlib.tests.test_merge_directive',
3741
 
        'bzrlib.tests.test_missing',
3742
 
        'bzrlib.tests.test_msgeditor',
3743
 
        'bzrlib.tests.test_multiparent',
3744
 
        'bzrlib.tests.test_mutabletree',
3745
 
        'bzrlib.tests.test_nonascii',
3746
 
        'bzrlib.tests.test_options',
3747
 
        'bzrlib.tests.test_osutils',
3748
 
        'bzrlib.tests.test_osutils_encodings',
3749
 
        'bzrlib.tests.test_pack',
3750
 
        'bzrlib.tests.test_patch',
3751
 
        'bzrlib.tests.test_patches',
3752
 
        'bzrlib.tests.test_permissions',
3753
 
        'bzrlib.tests.test_plugins',
3754
 
        'bzrlib.tests.test_progress',
3755
 
        'bzrlib.tests.test_read_bundle',
3756
 
        'bzrlib.tests.test_reconcile',
3757
 
        'bzrlib.tests.test_reconfigure',
3758
 
        'bzrlib.tests.test_registry',
3759
 
        'bzrlib.tests.test_remote',
3760
 
        'bzrlib.tests.test_rename_map',
3761
 
        'bzrlib.tests.test_repository',
3762
 
        'bzrlib.tests.test_revert',
3763
 
        'bzrlib.tests.test_revision',
3764
 
        'bzrlib.tests.test_revisionspec',
3765
 
        'bzrlib.tests.test_revisiontree',
3766
 
        'bzrlib.tests.test_rio',
3767
 
        'bzrlib.tests.test_rules',
3768
 
        'bzrlib.tests.test_sampler',
3769
 
        'bzrlib.tests.test_script',
3770
 
        'bzrlib.tests.test_selftest',
3771
 
        'bzrlib.tests.test_serializer',
3772
 
        'bzrlib.tests.test_setup',
3773
 
        'bzrlib.tests.test_sftp_transport',
3774
 
        'bzrlib.tests.test_shelf',
3775
 
        'bzrlib.tests.test_shelf_ui',
3776
 
        'bzrlib.tests.test_smart',
3777
 
        'bzrlib.tests.test_smart_add',
3778
 
        'bzrlib.tests.test_smart_request',
3779
 
        'bzrlib.tests.test_smart_transport',
3780
 
        'bzrlib.tests.test_smtp_connection',
3781
 
        'bzrlib.tests.test_source',
3782
 
        'bzrlib.tests.test_ssh_transport',
3783
 
        'bzrlib.tests.test_status',
3784
 
        'bzrlib.tests.test_store',
3785
 
        'bzrlib.tests.test_strace',
3786
 
        'bzrlib.tests.test_subsume',
3787
 
        'bzrlib.tests.test_switch',
3788
 
        'bzrlib.tests.test_symbol_versioning',
3789
 
        'bzrlib.tests.test_tag',
3790
 
        'bzrlib.tests.test_testament',
3791
 
        'bzrlib.tests.test_textfile',
3792
 
        'bzrlib.tests.test_textmerge',
3793
 
        'bzrlib.tests.test_timestamp',
3794
 
        'bzrlib.tests.test_trace',
3795
 
        'bzrlib.tests.test_transactions',
3796
 
        'bzrlib.tests.test_transform',
3797
 
        'bzrlib.tests.test_transport',
3798
 
        'bzrlib.tests.test_transport_log',
3799
 
        'bzrlib.tests.test_tree',
3800
 
        'bzrlib.tests.test_treebuilder',
3801
 
        'bzrlib.tests.test_tsort',
3802
 
        'bzrlib.tests.test_tuned_gzip',
3803
 
        'bzrlib.tests.test_ui',
3804
 
        'bzrlib.tests.test_uncommit',
3805
 
        'bzrlib.tests.test_upgrade',
3806
 
        'bzrlib.tests.test_upgrade_stacked',
3807
 
        'bzrlib.tests.test_urlutils',
3808
 
        'bzrlib.tests.test_version',
3809
 
        'bzrlib.tests.test_version_info',
3810
 
        'bzrlib.tests.test_weave',
3811
 
        'bzrlib.tests.test_whitebox',
3812
 
        'bzrlib.tests.test_win32utils',
3813
 
        'bzrlib.tests.test_workingtree',
3814
 
        'bzrlib.tests.test_workingtree_4',
3815
 
        'bzrlib.tests.test_wsgi',
3816
 
        'bzrlib.tests.test_xml',
3817
 
        ]
3818
 
 
3819
 
 
3820
 
def _test_suite_modules_to_doctest():
3821
 
    """Return the list of modules to doctest."""
3822
 
    if __doc__ is None:
3823
 
        # GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3824
 
        return []
3825
 
    return [
3826
 
        'bzrlib',
3827
 
        'bzrlib.branchbuilder',
3828
 
        'bzrlib.decorators',
3829
 
        'bzrlib.export',
3830
 
        'bzrlib.inventory',
3831
 
        'bzrlib.iterablefile',
3832
 
        'bzrlib.lockdir',
3833
 
        'bzrlib.merge3',
3834
 
        'bzrlib.option',
3835
 
        'bzrlib.symbol_versioning',
3836
 
        'bzrlib.tests',
3837
 
        'bzrlib.timestamp',
3838
 
        'bzrlib.version_info_formats.format_custom',
3839
 
        ]
3840
 
 
3841
 
 
3842
 
def test_suite(keep_only=None, starting_with=None):
 
2621
def test_suite(keep_only=None):
3843
2622
    """Build and return TestSuite for the whole of bzrlib.
3844
2623
 
3845
2624
    :param keep_only: A list of test ids limiting the suite returned.
3846
2625
 
3847
 
    :param starting_with: An id limiting the suite returned to the tests
3848
 
         starting with it.
3849
 
 
3850
2626
    This function can be replaced if you need to change the default test
3851
2627
    suite on a global basis, but it is not encouraged.
3852
2628
    """
3853
 
 
 
2629
    testmod_names = [
 
2630
                   'bzrlib.util.tests.test_bencode',
 
2631
                   'bzrlib.tests.test__dirstate_helpers',
 
2632
                   'bzrlib.tests.test_ancestry',
 
2633
                   'bzrlib.tests.test_annotate',
 
2634
                   'bzrlib.tests.test_api',
 
2635
                   'bzrlib.tests.test_atomicfile',
 
2636
                   'bzrlib.tests.test_bad_files',
 
2637
                   'bzrlib.tests.test_bisect_multi',
 
2638
                   'bzrlib.tests.test_branch',
 
2639
                   'bzrlib.tests.test_branchbuilder',
 
2640
                   'bzrlib.tests.test_bugtracker',
 
2641
                   'bzrlib.tests.test_bundle',
 
2642
                   'bzrlib.tests.test_bzrdir',
 
2643
                   'bzrlib.tests.test_cache_utf8',
 
2644
                   'bzrlib.tests.test_commands',
 
2645
                   'bzrlib.tests.test_commit',
 
2646
                   'bzrlib.tests.test_commit_merge',
 
2647
                   'bzrlib.tests.test_config',
 
2648
                   'bzrlib.tests.test_conflicts',
 
2649
                   'bzrlib.tests.test_counted_lock',
 
2650
                   'bzrlib.tests.test_decorators',
 
2651
                   'bzrlib.tests.test_delta',
 
2652
                   'bzrlib.tests.test_deprecated_graph',
 
2653
                   'bzrlib.tests.test_diff',
 
2654
                   'bzrlib.tests.test_dirstate',
 
2655
                   'bzrlib.tests.test_directory_service',
 
2656
                   'bzrlib.tests.test_email_message',
 
2657
                   'bzrlib.tests.test_errors',
 
2658
                   'bzrlib.tests.test_escaped_store',
 
2659
                   'bzrlib.tests.test_extract',
 
2660
                   'bzrlib.tests.test_fetch',
 
2661
                   'bzrlib.tests.test_ftp_transport',
 
2662
                   'bzrlib.tests.test_generate_docs',
 
2663
                   'bzrlib.tests.test_generate_ids',
 
2664
                   'bzrlib.tests.test_globbing',
 
2665
                   'bzrlib.tests.test_gpg',
 
2666
                   'bzrlib.tests.test_graph',
 
2667
                   'bzrlib.tests.test_hashcache',
 
2668
                   'bzrlib.tests.test_help',
 
2669
                   'bzrlib.tests.test_hooks',
 
2670
                   'bzrlib.tests.test_http',
 
2671
                   'bzrlib.tests.test_http_implementations',
 
2672
                   'bzrlib.tests.test_http_response',
 
2673
                   'bzrlib.tests.test_https_ca_bundle',
 
2674
                   'bzrlib.tests.test_identitymap',
 
2675
                   'bzrlib.tests.test_ignores',
 
2676
                   'bzrlib.tests.test_index',
 
2677
                   'bzrlib.tests.test_info',
 
2678
                   'bzrlib.tests.test_inv',
 
2679
                   'bzrlib.tests.test_knit',
 
2680
                   'bzrlib.tests.test_lazy_import',
 
2681
                   'bzrlib.tests.test_lazy_regex',
 
2682
                   'bzrlib.tests.test_lockdir',
 
2683
                   'bzrlib.tests.test_lockable_files',
 
2684
                   'bzrlib.tests.test_log',
 
2685
                   'bzrlib.tests.test_lsprof',
 
2686
                   'bzrlib.tests.test_lru_cache',
 
2687
                   'bzrlib.tests.test_mail_client',
 
2688
                   'bzrlib.tests.test_memorytree',
 
2689
                   'bzrlib.tests.test_merge',
 
2690
                   'bzrlib.tests.test_merge3',
 
2691
                   'bzrlib.tests.test_merge_core',
 
2692
                   'bzrlib.tests.test_merge_directive',
 
2693
                   'bzrlib.tests.test_missing',
 
2694
                   'bzrlib.tests.test_msgeditor',
 
2695
                   'bzrlib.tests.test_multiparent',
 
2696
                   'bzrlib.tests.test_nonascii',
 
2697
                   'bzrlib.tests.test_options',
 
2698
                   'bzrlib.tests.test_osutils',
 
2699
                   'bzrlib.tests.test_osutils_encodings',
 
2700
                   'bzrlib.tests.test_pack',
 
2701
                   'bzrlib.tests.test_patch',
 
2702
                   'bzrlib.tests.test_patches',
 
2703
                   'bzrlib.tests.test_permissions',
 
2704
                   'bzrlib.tests.test_plugins',
 
2705
                   'bzrlib.tests.test_progress',
 
2706
                   'bzrlib.tests.test_reconfigure',
 
2707
                   'bzrlib.tests.test_reconcile',
 
2708
                   'bzrlib.tests.test_registry',
 
2709
                   'bzrlib.tests.test_remote',
 
2710
                   'bzrlib.tests.test_repository',
 
2711
                   'bzrlib.tests.test_revert',
 
2712
                   'bzrlib.tests.test_revision',
 
2713
                   'bzrlib.tests.test_revisionnamespaces',
 
2714
                   'bzrlib.tests.test_revisiontree',
 
2715
                   'bzrlib.tests.test_rio',
 
2716
                   'bzrlib.tests.test_sampler',
 
2717
                   'bzrlib.tests.test_selftest',
 
2718
                   'bzrlib.tests.test_setup',
 
2719
                   'bzrlib.tests.test_sftp_transport',
 
2720
                   'bzrlib.tests.test_smart',
 
2721
                   'bzrlib.tests.test_smart_add',
 
2722
                   'bzrlib.tests.test_smart_transport',
 
2723
                   'bzrlib.tests.test_smtp_connection',
 
2724
                   'bzrlib.tests.test_source',
 
2725
                   'bzrlib.tests.test_ssh_transport',
 
2726
                   'bzrlib.tests.test_status',
 
2727
                   'bzrlib.tests.test_store',
 
2728
                   'bzrlib.tests.test_strace',
 
2729
                   'bzrlib.tests.test_subsume',
 
2730
                   'bzrlib.tests.test_switch',
 
2731
                   'bzrlib.tests.test_symbol_versioning',
 
2732
                   'bzrlib.tests.test_tag',
 
2733
                   'bzrlib.tests.test_testament',
 
2734
                   'bzrlib.tests.test_textfile',
 
2735
                   'bzrlib.tests.test_textmerge',
 
2736
                   'bzrlib.tests.test_timestamp',
 
2737
                   'bzrlib.tests.test_trace',
 
2738
                   'bzrlib.tests.test_transactions',
 
2739
                   'bzrlib.tests.test_transform',
 
2740
                   'bzrlib.tests.test_transport',
 
2741
                   'bzrlib.tests.test_tree',
 
2742
                   'bzrlib.tests.test_treebuilder',
 
2743
                   'bzrlib.tests.test_tsort',
 
2744
                   'bzrlib.tests.test_tuned_gzip',
 
2745
                   'bzrlib.tests.test_ui',
 
2746
                   'bzrlib.tests.test_uncommit',
 
2747
                   'bzrlib.tests.test_upgrade',
 
2748
                   'bzrlib.tests.test_urlutils',
 
2749
                   'bzrlib.tests.test_versionedfile',
 
2750
                   'bzrlib.tests.test_version',
 
2751
                   'bzrlib.tests.test_version_info',
 
2752
                   'bzrlib.tests.test_weave',
 
2753
                   'bzrlib.tests.test_whitebox',
 
2754
                   'bzrlib.tests.test_win32utils',
 
2755
                   'bzrlib.tests.test_workingtree',
 
2756
                   'bzrlib.tests.test_workingtree_4',
 
2757
                   'bzrlib.tests.test_wsgi',
 
2758
                   'bzrlib.tests.test_xml',
 
2759
                   ]
 
2760
    test_transport_implementations = [
 
2761
        'bzrlib.tests.test_transport_implementations',
 
2762
        'bzrlib.tests.test_read_bundle',
 
2763
        ]
 
2764
    suite = TestUtil.TestSuite()
3854
2765
    loader = TestUtil.TestLoader()
3855
2766
 
3856
2767
    if keep_only is not None:
3857
2768
        id_filter = TestIdList(keep_only)
3858
 
    if starting_with:
3859
 
        # We take precedence over keep_only because *at loading time* using
3860
 
        # both options means we will load less tests for the same final result.
3861
 
        def interesting_module(name):
3862
 
            for start in starting_with:
3863
 
                if (
3864
 
                    # Either the module name starts with the specified string
3865
 
                    name.startswith(start)
3866
 
                    # or it may contain tests starting with the specified string
3867
 
                    or start.startswith(name)
3868
 
                    ):
3869
 
                    return True
3870
 
            return False
3871
 
        loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3872
 
 
3873
 
    elif keep_only is not None:
3874
 
        loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3875
 
        def interesting_module(name):
3876
 
            return id_filter.refers_to(name)
3877
 
 
3878
 
    else:
3879
 
        loader = TestUtil.TestLoader()
3880
 
        def interesting_module(name):
3881
 
            # No filtering, all modules are interesting
3882
 
            return True
3883
 
 
3884
 
    suite = loader.suiteClass()
3885
2769
 
3886
2770
    # modules building their suite with loadTestsFromModuleNames
3887
 
    suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3888
 
 
3889
 
    for mod in _test_suite_modules_to_doctest():
3890
 
        if not interesting_module(mod):
3891
 
            # No tests to keep here, move along
3892
 
            continue
 
2771
    if keep_only is None:
 
2772
        suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
 
2773
    else:
 
2774
        for mod in [m for m in testmod_names
 
2775
                    if id_filter.is_module_name_used(m)]:
 
2776
            mod_suite = loader.loadTestsFromModuleNames([mod])
 
2777
            mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
 
2778
            suite.addTest(mod_suite)
 
2779
 
 
2780
    # modules adapted for transport implementations
 
2781
    from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
 
2782
    adapter = TransportTestProviderAdapter()
 
2783
    if keep_only is None:
 
2784
        adapt_modules(test_transport_implementations, adapter, loader, suite)
 
2785
    else:
 
2786
        for mod in [m for m in test_transport_implementations
 
2787
                    if id_filter.is_module_name_used(m)]:
 
2788
            mod_suite = TestUtil.TestSuite()
 
2789
            adapt_modules([mod], adapter, loader, mod_suite)
 
2790
            mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
 
2791
            suite.addTest(mod_suite)
 
2792
 
 
2793
    # modules defining their own test_suite()
 
2794
    for package in [p for p in packages_to_test()
 
2795
                    if (keep_only is None
 
2796
                        or id_filter.is_module_name_used(p.__name__))]:
 
2797
        pack_suite = package.test_suite()
 
2798
        if keep_only is not None:
 
2799
            pack_suite = filter_suite_by_id_list(pack_suite, id_filter)
 
2800
        suite.addTest(pack_suite)
 
2801
 
 
2802
    # XXX: MODULES_TO_TEST should be obsoleted ?
 
2803
    for mod in [m for m in MODULES_TO_TEST
 
2804
                if keep_only is None or id_filter.is_module_name_used(m)]:
 
2805
        mod_suite = loader.loadTestsFromModule(mod)
 
2806
        if keep_only is not None:
 
2807
            mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
 
2808
        suite.addTest(mod_suite)
 
2809
 
 
2810
    for mod in MODULES_TO_DOCTEST:
3893
2811
        try:
3894
 
            # note that this really does mean "report only" -- doctest
3895
 
            # still runs the rest of the examples
3896
 
            doc_suite = doctest.DocTestSuite(mod,
3897
 
                optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
 
2812
            doc_suite = doctest.DocTestSuite(mod)
3898
2813
        except ValueError, e:
3899
2814
            print '**failed to get doctest for: %s\n%s' % (mod, e)
3900
2815
            raise
3901
 
        if len(doc_suite._tests) == 0:
3902
 
            raise errors.BzrError("no doctests found in %s" % (mod,))
 
2816
        if keep_only is not None:
 
2817
            # DocTests may use ids which doesn't contain the module name
 
2818
            doc_suite = filter_suite_by_id_list(doc_suite, id_filter)
3903
2819
        suite.addTest(doc_suite)
3904
2820
 
3905
2821
    default_encoding = sys.getdefaultencoding()
3906
2822
    for name, plugin in bzrlib.plugin.plugins().items():
3907
 
        if not interesting_module(plugin.module.__name__):
3908
 
            continue
 
2823
        if keep_only is not None:
 
2824
            if not id_filter.is_module_name_used(plugin.module.__name__):
 
2825
                continue
3909
2826
        plugin_suite = plugin.test_suite()
3910
2827
        # We used to catch ImportError here and turn it into just a warning,
3911
2828
        # but really if you don't have --no-plugins this should be a failure.
3912
2829
        # mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3913
 
        if plugin_suite is None:
3914
 
            plugin_suite = plugin.load_plugin_tests(loader)
3915
2830
        if plugin_suite is not None:
 
2831
            if keep_only is not None:
 
2832
                plugin_suite = filter_suite_by_id_list(plugin_suite,
 
2833
                                                       id_filter)
3916
2834
            suite.addTest(plugin_suite)
3917
2835
        if default_encoding != sys.getdefaultencoding():
3918
2836
            bzrlib.trace.warning(
3920
2838
                sys.getdefaultencoding())
3921
2839
            reload(sys)
3922
2840
            sys.setdefaultencoding(default_encoding)
3923
 
 
3924
 
    if keep_only is not None:
3925
 
        # Now that the referred modules have loaded their tests, keep only the
3926
 
        # requested ones.
3927
 
        suite = filter_suite_by_id_list(suite, id_filter)
3928
 
        # Do some sanity checks on the id_list filtering
3929
 
        not_found, duplicates = suite_matches_id_list(suite, keep_only)
3930
 
        if starting_with:
3931
 
            # The tester has used both keep_only and starting_with, so he is
3932
 
            # already aware that some tests are excluded from the list, there
3933
 
            # is no need to tell him which.
3934
 
            pass
3935
 
        else:
3936
 
            # Some tests mentioned in the list are not in the test suite. The
3937
 
            # list may be out of date, report to the tester.
3938
 
            for id in not_found:
3939
 
                bzrlib.trace.warning('"%s" not found in the test suite', id)
3940
 
        for id in duplicates:
3941
 
            bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3942
 
 
 
2841
    return suite
 
2842
 
 
2843
 
 
2844
def multiply_tests_from_modules(module_name_list, scenario_iter):
 
2845
    """Adapt all tests in some given modules to given scenarios.
 
2846
 
 
2847
    This is the recommended public interface for test parameterization.
 
2848
    Typically the test_suite() method for a per-implementation test
 
2849
    suite will call multiply_tests_from_modules and return the 
 
2850
    result.
 
2851
 
 
2852
    :param module_name_list: List of fully-qualified names of test
 
2853
        modules.
 
2854
    :param scenario_iter: Iterable of pairs of (scenario_name, 
 
2855
        scenario_param_dict).
 
2856
 
 
2857
    This returns a new TestSuite containing the cross product of
 
2858
    all the tests in all the modules, each repeated for each scenario.
 
2859
    Each test is adapted by adding the scenario name at the end 
 
2860
    of its name, and updating the test object's __dict__ with the
 
2861
    scenario_param_dict.
 
2862
 
 
2863
    >>> r = multiply_tests_from_modules(
 
2864
    ...     ['bzrlib.tests.test_sampler'],
 
2865
    ...     [('one', dict(param=1)), 
 
2866
    ...      ('two', dict(param=2))])
 
2867
    >>> tests = list(iter_suite_tests(r))
 
2868
    >>> len(tests)
 
2869
    2
 
2870
    >>> tests[0].id()
 
2871
    'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
 
2872
    >>> tests[0].param
 
2873
    1
 
2874
    >>> tests[1].param
 
2875
    2
 
2876
    """
 
2877
    loader = TestLoader()
 
2878
    suite = TestSuite()
 
2879
    adapter = TestScenarioApplier()
 
2880
    adapter.scenarios = list(scenario_iter)
 
2881
    adapt_modules(module_name_list, adapter, loader, suite)
3943
2882
    return suite
3944
2883
 
3945
2884
 
3957
2896
        for right_name, right_dict in scenarios_right]
3958
2897
 
3959
2898
 
3960
 
def multiply_tests(tests, scenarios, result):
3961
 
    """Multiply tests_list by scenarios into result.
3962
 
 
3963
 
    This is the core workhorse for test parameterisation.
3964
 
 
3965
 
    Typically the load_tests() method for a per-implementation test suite will
3966
 
    call multiply_tests and return the result.
3967
 
 
3968
 
    :param tests: The tests to parameterise.
3969
 
    :param scenarios: The scenarios to apply: pairs of (scenario_name,
3970
 
        scenario_param_dict).
3971
 
    :param result: A TestSuite to add created tests to.
3972
 
 
3973
 
    This returns the passed in result TestSuite with the cross product of all
3974
 
    the tests repeated once for each scenario.  Each test is adapted by adding
3975
 
    the scenario name at the end of its id(), and updating the test object's
3976
 
    __dict__ with the scenario_param_dict.
3977
 
 
3978
 
    >>> import bzrlib.tests.test_sampler
3979
 
    >>> r = multiply_tests(
3980
 
    ...     bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3981
 
    ...     [('one', dict(param=1)),
3982
 
    ...      ('two', dict(param=2))],
3983
 
    ...     TestSuite())
3984
 
    >>> tests = list(iter_suite_tests(r))
3985
 
    >>> len(tests)
3986
 
    2
3987
 
    >>> tests[0].id()
3988
 
    'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3989
 
    >>> tests[0].param
3990
 
    1
3991
 
    >>> tests[1].param
3992
 
    2
3993
 
    """
3994
 
    for test in iter_suite_tests(tests):
3995
 
        apply_scenarios(test, scenarios, result)
3996
 
    return result
3997
 
 
3998
 
 
3999
 
def apply_scenarios(test, scenarios, result):
4000
 
    """Apply the scenarios in scenarios to test and add to result.
4001
 
 
4002
 
    :param test: The test to apply scenarios to.
4003
 
    :param scenarios: An iterable of scenarios to apply to test.
4004
 
    :return: result
4005
 
    :seealso: apply_scenario
4006
 
    """
4007
 
    for scenario in scenarios:
4008
 
        result.addTest(apply_scenario(test, scenario))
4009
 
    return result
4010
 
 
4011
 
 
4012
 
def apply_scenario(test, scenario):
4013
 
    """Copy test and apply scenario to it.
4014
 
 
4015
 
    :param test: A test to adapt.
4016
 
    :param scenario: A tuple describing the scenarion.
4017
 
        The first element of the tuple is the new test id.
4018
 
        The second element is a dict containing attributes to set on the
4019
 
        test.
4020
 
    :return: The adapted test.
4021
 
    """
4022
 
    new_id = "%s(%s)" % (test.id(), scenario[0])
4023
 
    new_test = clone_test(test, new_id)
4024
 
    for name, value in scenario[1].items():
4025
 
        setattr(new_test, name, value)
4026
 
    return new_test
4027
 
 
4028
 
 
4029
 
def clone_test(test, new_id):
4030
 
    """Clone a test giving it a new id.
4031
 
 
4032
 
    :param test: The test to clone.
4033
 
    :param new_id: The id to assign to it.
4034
 
    :return: The new test.
4035
 
    """
4036
 
    new_test = copy(test)
4037
 
    new_test.id = lambda: new_id
4038
 
    return new_test
4039
 
 
4040
 
 
4041
 
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4042
 
                                ext_module_name):
4043
 
    """Helper for permutating tests against an extension module.
4044
 
 
4045
 
    This is meant to be used inside a modules 'load_tests()' function. It will
4046
 
    create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4047
 
    against both implementations. Setting 'test.module' to the appropriate
4048
 
    module. See bzrlib.tests.test__chk_map.load_tests as an example.
4049
 
 
4050
 
    :param standard_tests: A test suite to permute
4051
 
    :param loader: A TestLoader
4052
 
    :param py_module_name: The python path to a python module that can always
4053
 
        be loaded, and will be considered the 'python' implementation. (eg
4054
 
        'bzrlib._chk_map_py')
4055
 
    :param ext_module_name: The python path to an extension module. If the
4056
 
        module cannot be loaded, a single test will be added, which notes that
4057
 
        the module is not available. If it can be loaded, all standard_tests
4058
 
        will be run against that module.
4059
 
    :return: (suite, feature) suite is a test-suite that has all the permuted
4060
 
        tests. feature is the Feature object that can be used to determine if
4061
 
        the module is available.
4062
 
    """
4063
 
 
4064
 
    py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4065
 
    scenarios = [
4066
 
        ('python', {'module': py_module}),
4067
 
    ]
4068
 
    suite = loader.suiteClass()
4069
 
    feature = ModuleAvailableFeature(ext_module_name)
4070
 
    if feature.available():
4071
 
        scenarios.append(('C', {'module': feature.module}))
4072
 
    else:
4073
 
        # the compiled module isn't available, so we add a failing test
4074
 
        class FailWithoutFeature(TestCase):
4075
 
            def test_fail(self):
4076
 
                self.requireFeature(feature)
4077
 
        suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4078
 
    result = multiply_tests(standard_tests, scenarios, suite)
4079
 
    return result, feature
4080
 
 
4081
 
 
4082
 
def _rmtree_temp_dir(dirname, test_id=None):
 
2899
 
 
2900
def adapt_modules(mods_list, adapter, loader, suite):
 
2901
    """Adapt the modules in mods_list using adapter and add to suite."""
 
2902
    for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
 
2903
        suite.addTests(adapter.adapt(test))
 
2904
 
 
2905
 
 
2906
def adapt_tests(tests_list, adapter, loader, suite):
 
2907
    """Adapt the tests in tests_list using adapter and add to suite."""
 
2908
    for test in tests_list:
 
2909
        suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
 
2910
 
 
2911
 
 
2912
def _rmtree_temp_dir(dirname):
4083
2913
    # If LANG=C we probably have created some bogus paths
4084
2914
    # which rmtree(unicode) will fail to delete
4085
2915
    # so make sure we are using rmtree(str) to delete everything
4094
2924
    try:
4095
2925
        osutils.rmtree(dirname)
4096
2926
    except OSError, e:
4097
 
        # We don't want to fail here because some useful display will be lost
4098
 
        # otherwise. Polluting the tmp dir is bad, but not giving all the
4099
 
        # possible info to the test runner is even worse.
4100
 
        if test_id != None:
4101
 
            ui.ui_factory.clear_term()
4102
 
            sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4103
 
        sys.stderr.write('Unable to remove testing dir %s\n%s'
4104
 
                         % (os.path.basename(dirname), e))
 
2927
        if sys.platform == 'win32' and e.errno == errno.EACCES:
 
2928
            sys.stderr.write(('Permission denied: '
 
2929
                                 'unable to remove testing dir '
 
2930
                                 '%s\n' % os.path.basename(dirname)))
 
2931
        else:
 
2932
            raise
4105
2933
 
4106
2934
 
4107
2935
class Feature(object):
4165
2993
OsFifoFeature = _OsFifoFeature()
4166
2994
 
4167
2995
 
4168
 
class _UnicodeFilenameFeature(Feature):
4169
 
    """Does the filesystem support Unicode filenames?"""
4170
 
 
4171
 
    def _probe(self):
4172
 
        try:
4173
 
            # Check for character combinations unlikely to be covered by any
4174
 
            # single non-unicode encoding. We use the characters
4175
 
            # - greek small letter alpha (U+03B1) and
4176
 
            # - braille pattern dots-123456 (U+283F).
4177
 
            os.stat(u'\u03b1\u283f')
4178
 
        except UnicodeEncodeError:
4179
 
            return False
4180
 
        except (IOError, OSError):
4181
 
            # The filesystem allows the Unicode filename but the file doesn't
4182
 
            # exist.
4183
 
            return True
4184
 
        else:
4185
 
            # The filesystem allows the Unicode filename and the file exists,
4186
 
            # for some reason.
4187
 
            return True
4188
 
 
4189
 
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4190
 
 
4191
 
 
4192
 
class _CompatabilityThunkFeature(Feature):
4193
 
    """This feature is just a thunk to another feature.
4194
 
 
4195
 
    It issues a deprecation warning if it is accessed, to let you know that you
4196
 
    should really use a different feature.
4197
 
    """
4198
 
 
4199
 
    def __init__(self, dep_version, module, name,
4200
 
                 replacement_name, replacement_module=None):
4201
 
        super(_CompatabilityThunkFeature, self).__init__()
4202
 
        self._module = module
4203
 
        if replacement_module is None:
4204
 
            replacement_module = module
4205
 
        self._replacement_module = replacement_module
4206
 
        self._name = name
4207
 
        self._replacement_name = replacement_name
4208
 
        self._dep_version = dep_version
4209
 
        self._feature = None
4210
 
 
4211
 
    def _ensure(self):
4212
 
        if self._feature is None:
4213
 
            depr_msg = self._dep_version % ('%s.%s'
4214
 
                                            % (self._module, self._name))
4215
 
            use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4216
 
                                               self._replacement_name)
4217
 
            symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4218
 
            # Import the new feature and use it as a replacement for the
4219
 
            # deprecated one.
4220
 
            mod = __import__(self._replacement_module, {}, {},
4221
 
                             [self._replacement_name])
4222
 
            self._feature = getattr(mod, self._replacement_name)
4223
 
 
4224
 
    def _probe(self):
4225
 
        self._ensure()
4226
 
        return self._feature._probe()
4227
 
 
4228
 
 
4229
 
class ModuleAvailableFeature(Feature):
4230
 
    """This is a feature than describes a module we want to be available.
4231
 
 
4232
 
    Declare the name of the module in __init__(), and then after probing, the
4233
 
    module will be available as 'self.module'.
4234
 
 
4235
 
    :ivar module: The module if it is available, else None.
4236
 
    """
4237
 
 
4238
 
    def __init__(self, module_name):
4239
 
        super(ModuleAvailableFeature, self).__init__()
4240
 
        self.module_name = module_name
4241
 
 
4242
 
    def _probe(self):
4243
 
        try:
4244
 
            self._module = __import__(self.module_name, {}, {}, [''])
4245
 
            return True
4246
 
        except ImportError:
4247
 
            return False
4248
 
 
4249
 
    @property
4250
 
    def module(self):
4251
 
        if self.available(): # Make sure the probe has been done
4252
 
            return self._module
4253
 
        return None
4254
 
 
4255
 
    def feature_name(self):
4256
 
        return self.module_name
4257
 
 
4258
 
 
4259
 
# This is kept here for compatibility, it is recommended to use
4260
 
# 'bzrlib.tests.feature.paramiko' instead
4261
 
ParamikoFeature = _CompatabilityThunkFeature(
4262
 
    deprecated_in((2,1,0)),
4263
 
    'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
 
2996
class TestScenarioApplier(object):
 
2997
    """A tool to apply scenarios to tests."""
 
2998
 
 
2999
    def adapt(self, test):
 
3000
        """Return a TestSuite containing a copy of test for each scenario."""
 
3001
        result = unittest.TestSuite()
 
3002
        for scenario in self.scenarios:
 
3003
            result.addTest(self.adapt_test_to_scenario(test, scenario))
 
3004
        return result
 
3005
 
 
3006
    def adapt_test_to_scenario(self, test, scenario):
 
3007
        """Copy test and apply scenario to it.
 
3008
 
 
3009
        :param test: A test to adapt.
 
3010
        :param scenario: A tuple describing the scenarion.
 
3011
            The first element of the tuple is the new test id.
 
3012
            The second element is a dict containing attributes to set on the
 
3013
            test.
 
3014
        :return: The adapted test.
 
3015
        """
 
3016
        from copy import deepcopy
 
3017
        new_test = deepcopy(test)
 
3018
        for name, value in scenario[1].items():
 
3019
            setattr(new_test, name, value)
 
3020
        new_id = "%s(%s)" % (new_test.id(), scenario[0])
 
3021
        new_test.id = lambda: new_id
 
3022
        return new_test
4264
3023
 
4265
3024
 
4266
3025
def probe_unicode_in_user_encoding():
4272
3031
    possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4273
3032
    for uni_val in possible_vals:
4274
3033
        try:
4275
 
            str_val = uni_val.encode(osutils.get_user_encoding())
 
3034
            str_val = uni_val.encode(bzrlib.user_encoding)
4276
3035
        except UnicodeEncodeError:
4277
3036
            # Try a different character
4278
3037
            pass
4296
3055
    return None
4297
3056
 
4298
3057
 
4299
 
class _HTTPSServerFeature(Feature):
4300
 
    """Some tests want an https Server, check if one is available.
 
3058
class _FTPServerFeature(Feature):
 
3059
    """Some tests want an FTP Server, check if one is available.
4301
3060
 
4302
 
    Right now, the only way this is available is under python2.6 which provides
4303
 
    an ssl module.
 
3061
    Right now, the only way this is available is if 'medusa' is installed.
 
3062
    http://www.amk.ca/python/code/medusa.html
4304
3063
    """
4305
3064
 
4306
3065
    def _probe(self):
4307
3066
        try:
4308
 
            import ssl
 
3067
            import bzrlib.tests.ftp_server
4309
3068
            return True
4310
3069
        except ImportError:
4311
3070
            return False
4312
3071
 
4313
3072
    def feature_name(self):
4314
 
        return 'HTTPSServer'
4315
 
 
4316
 
 
4317
 
HTTPSServerFeature = _HTTPSServerFeature()
4318
 
 
4319
 
 
4320
 
class _UnicodeFilename(Feature):
4321
 
    """Does the filesystem support Unicode filenames?"""
4322
 
 
4323
 
    def _probe(self):
4324
 
        try:
4325
 
            os.stat(u'\u03b1')
4326
 
        except UnicodeEncodeError:
4327
 
            return False
4328
 
        except (IOError, OSError):
4329
 
            # The filesystem allows the Unicode filename but the file doesn't
4330
 
            # exist.
4331
 
            return True
4332
 
        else:
4333
 
            # The filesystem allows the Unicode filename and the file exists,
4334
 
            # for some reason.
4335
 
            return True
4336
 
 
4337
 
UnicodeFilename = _UnicodeFilename()
4338
 
 
4339
 
 
4340
 
class _UTF8Filesystem(Feature):
4341
 
    """Is the filesystem UTF-8?"""
4342
 
 
4343
 
    def _probe(self):
4344
 
        if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4345
 
            return True
4346
 
        return False
4347
 
 
4348
 
UTF8Filesystem = _UTF8Filesystem()
4349
 
 
4350
 
 
4351
 
class _BreakinFeature(Feature):
4352
 
    """Does this platform support the breakin feature?"""
4353
 
 
4354
 
    def _probe(self):
4355
 
        from bzrlib import breakin
4356
 
        if breakin.determine_signal() is None:
4357
 
            return False
4358
 
        if sys.platform == 'win32':
4359
 
            # Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4360
 
            # We trigger SIGBREAK via a Console api so we need ctypes to
4361
 
            # access the function
4362
 
            try:
4363
 
                import ctypes
4364
 
            except OSError:
4365
 
                return False
4366
 
        return True
4367
 
 
4368
 
    def feature_name(self):
4369
 
        return "SIGQUIT or SIGBREAK w/ctypes on win32"
4370
 
 
4371
 
 
4372
 
BreakinFeature = _BreakinFeature()
4373
 
 
4374
 
 
4375
 
class _CaseInsCasePresFilenameFeature(Feature):
4376
 
    """Is the file-system case insensitive, but case-preserving?"""
4377
 
 
4378
 
    def _probe(self):
4379
 
        fileno, name = tempfile.mkstemp(prefix='MixedCase')
4380
 
        try:
4381
 
            # first check truly case-preserving for created files, then check
4382
 
            # case insensitive when opening existing files.
4383
 
            name = osutils.normpath(name)
4384
 
            base, rel = osutils.split(name)
4385
 
            found_rel = osutils.canonical_relpath(base, name)
4386
 
            return (found_rel == rel
4387
 
                    and os.path.isfile(name.upper())
4388
 
                    and os.path.isfile(name.lower()))
4389
 
        finally:
4390
 
            os.close(fileno)
4391
 
            os.remove(name)
4392
 
 
4393
 
    def feature_name(self):
4394
 
        return "case-insensitive case-preserving filesystem"
4395
 
 
4396
 
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
 
3073
        return 'FTPServer'
 
3074
 
 
3075
FTPServerFeature = _FTPServerFeature()
4397
3076
 
4398
3077
 
4399
3078
class _CaseInsensitiveFilesystemFeature(Feature):
4400
 
    """Check if underlying filesystem is case-insensitive but *not* case
4401
 
    preserving.
 
3079
    """Check if underlined filesystem is case-insensitive
 
3080
    (e.g. on Windows, Cygwin, MacOS)
4402
3081
    """
4403
 
    # Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4404
 
    # more likely to be case preserving, so this case is rare.
4405
3082
 
4406
3083
    def _probe(self):
4407
 
        if CaseInsCasePresFilenameFeature.available():
4408
 
            return False
4409
 
 
4410
3084
        if TestCaseWithMemoryTransport.TEST_ROOT is None:
4411
3085
            root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4412
3086
            TestCaseWithMemoryTransport.TEST_ROOT = root
4425
3099
        return 'case-insensitive filesystem'
4426
3100
 
4427
3101
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4428
 
 
4429
 
 
4430
 
class _CaseSensitiveFilesystemFeature(Feature):
4431
 
 
4432
 
    def _probe(self):
4433
 
        if CaseInsCasePresFilenameFeature.available():
4434
 
            return False
4435
 
        elif CaseInsensitiveFilesystemFeature.available():
4436
 
            return False
4437
 
        else:
4438
 
            return True
4439
 
 
4440
 
    def feature_name(self):
4441
 
        return 'case-sensitive filesystem'
4442
 
 
4443
 
# new coding style is for feature instances to be lowercase
4444
 
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4445
 
 
4446
 
 
4447
 
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4448
 
SubUnitFeature = _CompatabilityThunkFeature(
4449
 
    deprecated_in((2,1,0)),
4450
 
    'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4451
 
# Only define SubUnitBzrRunner if subunit is available.
4452
 
try:
4453
 
    from subunit import TestProtocolClient
4454
 
    from subunit.test_results import AutoTimingTestResultDecorator
4455
 
    class SubUnitBzrRunner(TextTestRunner):
4456
 
        def run(self, test):
4457
 
            result = AutoTimingTestResultDecorator(
4458
 
                TestProtocolClient(self.stream))
4459
 
            test.run(result)
4460
 
            return result
4461
 
except ImportError:
4462
 
    pass
4463
 
 
4464
 
class _PosixPermissionsFeature(Feature):
4465
 
 
4466
 
    def _probe(self):
4467
 
        def has_perms():
4468
 
            # create temporary file and check if specified perms are maintained.
4469
 
            import tempfile
4470
 
 
4471
 
            write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4472
 
            f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4473
 
            fd, name = f
4474
 
            os.close(fd)
4475
 
            os.chmod(name, write_perms)
4476
 
 
4477
 
            read_perms = os.stat(name).st_mode & 0777
4478
 
            os.unlink(name)
4479
 
            return (write_perms == read_perms)
4480
 
 
4481
 
        return (os.name == 'posix') and has_perms()
4482
 
 
4483
 
    def feature_name(self):
4484
 
        return 'POSIX permissions support'
4485
 
 
4486
 
posix_permissions_feature = _PosixPermissionsFeature()