/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-24 05:12:24 UTC
  • mfrom: (4189.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090324051224-rneg6bkbzjyd85rl
(mbp) merge update to FSF address

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/__init__.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
"""Testing framework extensions"""
18
17
 
19
18
# TODO: Perhaps there should be an API to find out if bzr running under the
20
19
# test suite -- some plugins might want to avoid making intrusive changes if
29
28
 
30
29
import atexit
31
30
import codecs
32
 
from copy import copy
33
31
from cStringIO import StringIO
34
32
import difflib
35
33
import doctest
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
45
import threading
49
46
import time
50
 
import traceback
51
47
import unittest
52
48
import warnings
53
49
 
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
50
 
62
51
from bzrlib import (
63
52
    branchbuilder,
64
53
    bzrdir,
65
 
    chk_map,
66
 
    config,
67
54
    debug,
68
55
    errors,
69
56
    hooks,
70
 
    lock as _mod_lock,
71
57
    memorytree,
72
58
    osutils,
73
59
    progress,
91
77
from bzrlib.merge import merge_inner
92
78
import bzrlib.merge3
93
79
import bzrlib.plugin
94
 
from bzrlib.smart import client, request, server
 
80
from bzrlib.smart import client, server
95
81
import bzrlib.store
96
82
from bzrlib import symbol_versioning
97
83
from bzrlib.symbol_versioning import (
98
84
    DEPRECATED_PARAMETER,
99
85
    deprecated_function,
100
 
    deprecated_in,
101
86
    deprecated_method,
102
87
    deprecated_passed,
103
88
    )
104
89
import bzrlib.trace
105
 
from bzrlib.transport import (
106
 
    get_transport,
107
 
    memory,
108
 
    pathfilter,
109
 
    )
 
90
from bzrlib.transport import get_transport
110
91
import bzrlib.transport
 
92
from bzrlib.transport.local import LocalURLServer
 
93
from bzrlib.transport.memory import MemoryServer
 
94
from bzrlib.transport.readonly import ReadonlyServer
111
95
from bzrlib.trace import mutter, note
112
 
from bzrlib.tests import (
113
 
    test_server,
114
 
    TestUtil,
115
 
    )
 
96
from bzrlib.tests import TestUtil
116
97
from bzrlib.tests.http_server import HttpServer
117
98
from bzrlib.tests.TestUtil import (
118
99
                          TestSuite,
119
100
                          TestLoader,
120
101
                          )
121
102
from bzrlib.tests.treeshape import build_tree_contents
122
 
from bzrlib.ui import NullProgressView
123
 
from bzrlib.ui.text import TextUIFactory
124
103
import bzrlib.version_info_formats.format_custom
125
104
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
126
105
 
129
108
# shown frame is the test code, not our assertXYZ.
130
109
__unittest = 1
131
110
 
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
 
111
default_transport = LocalURLServer
142
112
 
143
113
 
144
114
class ExtendedTestResult(unittest._TextTestResult):
161
131
 
162
132
    def __init__(self, stream, descriptions, verbosity,
163
133
                 bench_history=None,
164
 
                 strict=False,
 
134
                 num_tests=None,
165
135
                 ):
166
136
        """Construct new TestResult.
167
137
 
185
155
            bench_history.write("--date %s %s\n" % (time.time(), revision_id))
186
156
        self._bench_history = bench_history
187
157
        self.ui = ui.ui_factory
188
 
        self.num_tests = 0
 
158
        self.num_tests = num_tests
189
159
        self.error_count = 0
190
160
        self.failure_count = 0
191
161
        self.known_failure_count = 0
194
164
        self.unsupported = {}
195
165
        self.count = 0
196
166
        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):
 
167
 
 
168
    def _extractBenchmarkTime(self, testCase):
254
169
        """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
170
        return getattr(testCase, "_benchtime", None)
258
171
 
259
172
    def _elapsedTestTimeString(self):
263
176
    def _testTimeString(self, testCase):
264
177
        benchmark_time = self._extractBenchmarkTime(testCase)
265
178
        if benchmark_time is not None:
266
 
            return self._formatTime(benchmark_time) + "*"
 
179
            return "%s/%s" % (
 
180
                self._formatTime(benchmark_time),
 
181
                self._elapsedTestTimeString())
267
182
        else:
268
 
            return self._elapsedTestTimeString()
 
183
            return "           %s" % self._elapsedTestTimeString()
269
184
 
270
185
    def _formatTime(self, seconds):
271
186
        """Format seconds as milliseconds with leading spaces."""
280
195
 
281
196
    def startTest(self, test):
282
197
        unittest.TestResult.startTest(self, test)
283
 
        if self.count == 0:
284
 
            self.startTests()
285
198
        self.report_test_start(test)
286
199
        test.number = self.count
287
200
        self._recordTestStartTime()
288
201
 
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
202
    def _recordTestStartTime(self):
309
203
        """Record that a test has started."""
310
204
        self._start_time = time.time()
322
216
        Called from the TestCase run() method when the test
323
217
        fails with an unexpected error.
324
218
        """
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)
 
219
        self._testConcluded(test)
 
220
        if isinstance(err[1], TestNotApplicable):
 
221
            return self._addNotApplicable(test, err)
 
222
        elif isinstance(err[1], UnavailableFeature):
 
223
            return self.addNotSupported(test, err[1].args[0])
 
224
        else:
 
225
            unittest.TestResult.addError(self, test, err)
 
226
            self.error_count += 1
 
227
            self.report_error(test, err)
 
228
            if self.stop_early:
 
229
                self.stop()
 
230
            self._cleanupLogFile(test)
332
231
 
333
232
    def addFailure(self, test, err):
334
233
        """Tell result that test failed.
336
235
        Called from the TestCase run() method when the test
337
236
        fails because e.g. an assert() method failed.
338
237
        """
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)
 
238
        self._testConcluded(test)
 
239
        if isinstance(err[1], KnownFailure):
 
240
            return self._addKnownFailure(test, err)
 
241
        else:
 
242
            unittest.TestResult.addFailure(self, test, err)
 
243
            self.failure_count += 1
 
244
            self.report_failure(test, err)
 
245
            if self.stop_early:
 
246
                self.stop()
 
247
            self._cleanupLogFile(test)
346
248
 
347
 
    def addSuccess(self, test, details=None):
 
249
    def addSuccess(self, test):
348
250
        """Tell result that test completed successfully.
349
251
 
350
252
        Called from the TestCase run()
351
253
        """
 
254
        self._testConcluded(test)
352
255
        if self._bench_history is not None:
353
 
            benchmark_time = self._extractBenchmarkTime(test, details)
 
256
            benchmark_time = self._extractBenchmarkTime(test)
354
257
            if benchmark_time is not None:
355
258
                self._bench_history.write("%s %s\n" % (
356
259
                    self._formatTime(benchmark_time),
360
263
        unittest.TestResult.addSuccess(self, test)
361
264
        test._log_contents = ''
362
265
 
363
 
    def addExpectedFailure(self, test, err):
 
266
    def _testConcluded(self, test):
 
267
        """Common code when a test has finished.
 
268
 
 
269
        Called regardless of whether it succeded, failed, etc.
 
270
        """
 
271
        pass
 
272
 
 
273
    def _addKnownFailure(self, test, err):
364
274
        self.known_failure_count += 1
365
275
        self.report_known_failure(test, err)
366
276
 
368
278
        """The test will not be run because of a missing feature.
369
279
        """
370
280
        # this can be called in two different ways: it may be that the
371
 
        # test started running, and then raised (through requireFeature)
 
281
        # test started running, and then raised (through addError)
372
282
        # 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.
 
283
        # while probing for features before running the tests; in that
 
284
        # case we will see startTest and stopTest, but the test will never
 
285
        # actually run.
376
286
        self.unsupported.setdefault(str(feature), 0)
377
287
        self.unsupported[str(feature)] += 1
378
288
        self.report_unsupported(test, feature)
382
292
        self.skip_count += 1
383
293
        self.report_skip(test, reason)
384
294
 
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
 
295
    def _addNotApplicable(self, test, skip_excinfo):
 
296
        if isinstance(skip_excinfo[1], TestNotApplicable):
 
297
            self.not_applicable_count += 1
 
298
            self.report_not_applicable(test, skip_excinfo)
 
299
        try:
 
300
            test.tearDown()
 
301
        except KeyboardInterrupt:
 
302
            raise
 
303
        except:
 
304
            self.addError(test, test.exc_info())
400
305
        else:
401
 
            raise errors.BzrError("Unknown whence %r" % whence)
 
306
            # seems best to treat this as success from point-of-view of unittest
 
307
            # -- it actually does nothing so it barely matters :)
 
308
            unittest.TestResult.addSuccess(self, test)
 
309
            test._log_contents = ''
 
310
 
 
311
    def printErrorList(self, flavour, errors):
 
312
        for test, err in errors:
 
313
            self.stream.writeln(self.separator1)
 
314
            self.stream.write("%s: " % flavour)
 
315
            self.stream.writeln(self.getDescription(test))
 
316
            if getattr(test, '_get_log', None) is not None:
 
317
                self.stream.write('\n')
 
318
                self.stream.write(
 
319
                        ('vvvv[log from %s]' % test.id()).ljust(78,'-'))
 
320
                self.stream.write('\n')
 
321
                self.stream.write(test._get_log())
 
322
                self.stream.write('\n')
 
323
                self.stream.write(
 
324
                        ('^^^^[log from %s]' % test.id()).ljust(78,'-'))
 
325
                self.stream.write('\n')
 
326
            self.stream.writeln(self.separator2)
 
327
            self.stream.writeln("%s" % err)
 
328
 
 
329
    def finished(self):
 
330
        pass
402
331
 
403
332
    def report_cleaning_up(self):
404
333
        pass
405
334
 
406
 
    def startTestRun(self):
407
 
        self.startTime = time.time()
408
 
 
409
335
    def report_success(self, test):
410
336
        pass
411
337
 
420
346
 
421
347
    def __init__(self, stream, descriptions, verbosity,
422
348
                 bench_history=None,
 
349
                 num_tests=None,
423
350
                 pb=None,
424
 
                 strict=None,
425
351
                 ):
426
352
        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()
 
353
            bench_history, num_tests)
 
354
        if pb is None:
 
355
            self.pb = self.ui.nested_progress_bar()
 
356
            self._supplied_pb = False
 
357
        else:
 
358
            self.pb = pb
 
359
            self._supplied_pb = True
433
360
        self.pb.show_pct = False
434
361
        self.pb.show_spinner = False
435
362
        self.pb.show_eta = False,
436
363
        self.pb.show_count = False
437
364
        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()
 
365
 
 
366
    def report_starting(self):
449
367
        self.pb.update('[test 0/%d] Starting' % (self.num_tests))
450
368
 
451
 
    def printErrors(self):
452
 
        # clear the pb to make room for the error listing
453
 
        self.pb.clear()
454
 
        super(TextTestResult, self).printErrors()
455
 
 
456
369
    def _progress_prefix_text(self):
457
370
        # the longer this text, the less space we have to show the test
458
371
        # name...
463
376
        ##     a += ', %d skip' % self.skip_count
464
377
        ## if self.known_failure_count:
465
378
        ##     a += '+%dX' % self.known_failure_count
466
 
        if self.num_tests:
 
379
        if self.num_tests is not None:
467
380
            a +='/%d' % self.num_tests
468
381
        a += ' in '
469
382
        runtime = time.time() - self._overall_start_time
471
384
            a += '%dm%ds' % (runtime / 60, runtime % 60)
472
385
        else:
473
386
            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)
 
387
        if self.error_count:
 
388
            a += ', %d err' % self.error_count
 
389
        if self.failure_count:
 
390
            a += ', %d fail' % self.failure_count
 
391
        if self.unsupported:
 
392
            a += ', %d missing' % len(self.unsupported)
479
393
        a += ']'
480
394
        return a
481
395
 
490
404
        return self._shortened_test_description(test)
491
405
 
492
406
    def report_error(self, test, err):
493
 
        self.stream.write('ERROR: %s\n    %s\n' % (
 
407
        self.pb.note('ERROR: %s\n    %s\n',
494
408
            self._test_description(test),
495
409
            err[1],
496
 
            ))
 
410
            )
497
411
 
498
412
    def report_failure(self, test, err):
499
 
        self.stream.write('FAIL: %s\n    %s\n' % (
 
413
        self.pb.note('FAIL: %s\n    %s\n',
500
414
            self._test_description(test),
501
415
            err[1],
502
 
            ))
 
416
            )
503
417
 
504
418
    def report_known_failure(self, test, err):
505
 
        pass
 
419
        self.pb.note('XFAIL: %s\n%s\n',
 
420
            self._test_description(test), err[1])
506
421
 
507
422
    def report_skip(self, test, reason):
508
423
        pass
509
424
 
510
 
    def report_not_applicable(self, test, reason):
 
425
    def report_not_applicable(self, test, skip_excinfo):
511
426
        pass
512
427
 
513
428
    def report_unsupported(self, test, feature):
516
431
    def report_cleaning_up(self):
517
432
        self.pb.update('Cleaning up')
518
433
 
 
434
    def finished(self):
 
435
        if not self._supplied_pb:
 
436
            self.pb.finished()
 
437
 
519
438
 
520
439
class VerboseTestResult(ExtendedTestResult):
521
440
    """Produce long output, with one line per test run plus times"""
528
447
            result = a_string
529
448
        return result.ljust(final_width)
530
449
 
531
 
    def startTestRun(self):
532
 
        super(VerboseTestResult, self).startTestRun()
 
450
    def report_starting(self):
533
451
        self.stream.write('running %d tests...\n' % self.num_tests)
534
452
 
535
453
    def report_test_start(self, test):
536
454
        self.count += 1
537
455
        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)
 
456
        # width needs space for 6 char status, plus 1 for slash, plus 2 10-char
 
457
        # numbers, plus a trailing blank
 
458
        # when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
 
459
        self.stream.write(self._ellipsize_to_right(name,
 
460
                          osutils.terminal_width()-30))
547
461
        self.stream.flush()
548
462
 
549
463
    def _error_summary(self, err):
578
492
        self.stream.writeln(' SKIP %s\n%s'
579
493
                % (self._testTimeString(test), reason))
580
494
 
581
 
    def report_not_applicable(self, test, reason):
582
 
        self.stream.writeln('  N/A %s\n    %s'
583
 
                % (self._testTimeString(test), reason))
 
495
    def report_not_applicable(self, test, skip_excinfo):
 
496
        self.stream.writeln('  N/A %s\n%s'
 
497
                % (self._testTimeString(test),
 
498
                   self._error_summary(skip_excinfo)))
584
499
 
585
500
    def report_unsupported(self, test, feature):
586
501
        """test cannot be run because feature is missing."""
596
511
                 descriptions=0,
597
512
                 verbosity=1,
598
513
                 bench_history=None,
599
 
                 strict=False,
600
 
                 result_decorators=None,
 
514
                 list_only=False
601
515
                 ):
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
516
        self.stream = unittest._WritelnDecorator(stream)
623
517
        self.descriptions = descriptions
624
518
        self.verbosity = verbosity
625
519
        self._bench_history = bench_history
626
 
        self._strict = strict
627
 
        self._result_decorators = result_decorators or []
 
520
        self.list_only = list_only
628
521
 
629
522
    def run(self, test):
630
523
        "Run the given test case or test suite."
 
524
        startTime = time.time()
631
525
        if self.verbosity == 1:
632
526
            result_class = TextTestResult
633
527
        elif self.verbosity >= 2:
634
528
            result_class = VerboseTestResult
635
 
        original_result = result_class(self.stream,
 
529
        result = result_class(self.stream,
636
530
                              self.descriptions,
637
531
                              self.verbosity,
638
532
                              bench_history=self._bench_history,
639
 
                              strict=self._strict,
 
533
                              num_tests=test.countTestCases(),
640
534
                              )
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:
 
535
        result.stop_early = self.stop_on_failure
 
536
        result.report_starting()
 
537
        if self.list_only:
 
538
            if self.verbosity >= 2:
 
539
                self.stream.writeln("Listing tests only ...\n")
 
540
            run = 0
 
541
            for t in iter_suite_tests(test):
 
542
                self.stream.writeln("%s" % (t.id()))
 
543
                run += 1
 
544
            actionTaken = "Listed"
 
545
        else:
649
546
            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
 
547
            run = result.testsRun
 
548
            actionTaken = "Ran"
 
549
        stopTime = time.time()
 
550
        timeTaken = stopTime - startTime
 
551
        result.printErrors()
 
552
        self.stream.writeln(result.separator2)
 
553
        self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
 
554
                            run, run != 1 and "s" or "", timeTaken))
 
555
        self.stream.writeln()
 
556
        if not result.wasSuccessful():
 
557
            self.stream.write("FAILED (")
 
558
            failed, errored = map(len, (result.failures, result.errors))
 
559
            if failed:
 
560
                self.stream.write("failures=%d" % failed)
 
561
            if errored:
 
562
                if failed: self.stream.write(", ")
 
563
                self.stream.write("errors=%d" % errored)
 
564
            if result.known_failure_count:
 
565
                if failed or errored: self.stream.write(", ")
 
566
                self.stream.write("known_failure_count=%d" %
 
567
                    result.known_failure_count)
 
568
            self.stream.writeln(")")
 
569
        else:
 
570
            if result.known_failure_count:
 
571
                self.stream.writeln("OK (known_failures=%d)" %
 
572
                    result.known_failure_count)
 
573
            else:
 
574
                self.stream.writeln("OK")
 
575
        if result.skip_count > 0:
 
576
            skipped = result.skip_count
 
577
            self.stream.writeln('%d test%s skipped' %
 
578
                                (skipped, skipped != 1 and "s" or ""))
 
579
        if result.unsupported:
 
580
            for feature, count in sorted(result.unsupported.items()):
 
581
                self.stream.writeln("Missing feature '%s' skipped %d tests." %
 
582
                    (feature, count))
 
583
        result.finished()
 
584
        return result
655
585
 
656
586
 
657
587
def iter_suite_tests(suite):
659
589
    if isinstance(suite, unittest.TestCase):
660
590
        yield suite
661
591
    elif isinstance(suite, unittest.TestSuite):
662
 
        for item in suite:
 
592
        for item in suite._tests:
663
593
            for r in iter_suite_tests(item):
664
594
                yield r
665
595
    else:
667
597
                        % (type(suite), suite))
668
598
 
669
599
 
670
 
TestSkipped = testtools.testcase.TestSkipped
 
600
class TestSkipped(Exception):
 
601
    """Indicates that a test was intentionally skipped, rather than failing."""
671
602
 
672
603
 
673
604
class TestNotApplicable(TestSkipped):
679
610
    """
680
611
 
681
612
 
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
 
613
class KnownFailure(AssertionError):
 
614
    """Indicates that a test failed in a precisely expected manner.
 
615
 
 
616
    Such failures dont block the whole test suite from passing because they are
 
617
    indicators of partially completed code or of future work. We have an
 
618
    explicit error for them so that we can ensure that they are always visible:
 
619
    KnownFailures are always shown in the output of bzr selftest.
 
620
    """
699
621
 
700
622
 
701
623
class UnavailableFeature(Exception):
702
624
    """A feature required for this test was not available.
703
625
 
704
 
    This can be considered a specialised form of SkippedTest.
705
 
 
706
626
    The feature should be used to construct the exception.
707
627
    """
708
628
 
709
629
 
 
630
class CommandFailed(Exception):
 
631
    pass
 
632
 
 
633
 
710
634
class StringIOWrapper(object):
711
635
    """A wrapper around cStringIO which just adds an encoding attribute.
712
636
 
733
657
            return setattr(self._cstring, name, val)
734
658
 
735
659
 
736
 
class TestUIFactory(TextUIFactory):
 
660
class TestUIFactory(ui.CLIUIFactory):
737
661
    """A UI Factory for testing.
738
662
 
739
663
    Hide the progress bar but emit note()s.
740
664
    Redirect stdin.
741
665
    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
666
    """
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
667
 
754
 
    def __init__(self, stdout=None, stderr=None, stdin=None):
 
668
    def __init__(self,
 
669
                 stdout=None,
 
670
                 stderr=None,
 
671
                 stdin=None):
 
672
        super(TestUIFactory, self).__init__()
755
673
        if stdin is not None:
756
674
            # We use a StringIOWrapper to be able to test various
757
675
            # encodings, but the user is still responsible to
758
676
            # encode the string and to set the encoding attribute
759
677
            # of StringIOWrapper.
760
 
            stdin = StringIOWrapper(stdin)
761
 
        super(TestUIFactory, self).__init__(stdin, stdout, stderr)
762
 
 
763
 
    def get_non_echoed_password(self):
 
678
            self.stdin = StringIOWrapper(stdin)
 
679
        if stdout is None:
 
680
            self.stdout = sys.stdout
 
681
        else:
 
682
            self.stdout = stdout
 
683
        if stderr is None:
 
684
            self.stderr = sys.stderr
 
685
        else:
 
686
            self.stderr = stderr
 
687
 
 
688
    def clear(self):
 
689
        """See progress.ProgressBar.clear()."""
 
690
 
 
691
    def clear_term(self):
 
692
        """See progress.ProgressBar.clear_term()."""
 
693
 
 
694
    def clear_term(self):
 
695
        """See progress.ProgressBar.clear_term()."""
 
696
 
 
697
    def finished(self):
 
698
        """See progress.ProgressBar.finished()."""
 
699
 
 
700
    def note(self, fmt_string, *args, **kwargs):
 
701
        """See progress.ProgressBar.note()."""
 
702
        self.stdout.write((fmt_string + "\n") % args)
 
703
 
 
704
    def progress_bar(self):
 
705
        return self
 
706
 
 
707
    def nested_progress_bar(self):
 
708
        return self
 
709
 
 
710
    def update(self, message, count=None, total=None):
 
711
        """See progress.ProgressBar.update()."""
 
712
 
 
713
    def get_non_echoed_password(self, prompt):
764
714
        """Get password from stdin without trying to handle the echo mode"""
 
715
        if prompt:
 
716
            self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
765
717
        password = self.stdin.readline()
766
718
        if not password:
767
719
            raise EOFError
769
721
            password = password[:-1]
770
722
        return password
771
723
 
772
 
    def make_progress_view(self):
773
 
        return NullProgressView()
774
 
 
775
 
 
776
 
class TestCase(testtools.TestCase):
 
724
 
 
725
def _report_leaked_threads():
 
726
    bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
 
727
                         TestCase._first_thread_leaker_id,
 
728
                         TestCase._leaking_threads_tests)
 
729
 
 
730
 
 
731
class TestCase(unittest.TestCase):
777
732
    """Base class for bzr unit tests.
778
733
 
779
734
    Tests that need access to disk resources should subclass
798
753
    _leaking_threads_tests = 0
799
754
    _first_thread_leaker_id = None
800
755
    _log_file_name = None
 
756
    _log_contents = ''
 
757
    _keep_log_file = False
801
758
    # record lsprof data when performing benchmark calls.
802
759
    _gather_lsprof_in_benchmarks = False
 
760
    attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
 
761
                     '_log_contents', '_log_file_name', '_benchtime',
 
762
                     '_TestCase__testMethodName')
803
763
 
804
764
    def __init__(self, methodName='testMethod'):
805
765
        super(TestCase, self).__init__(methodName)
806
766
        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))
 
767
        self._bzr_test_setUp_run = False
 
768
        self._bzr_test_tearDown_run = False
812
769
 
813
770
    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)]))
 
771
        unittest.TestCase.setUp(self)
 
772
        self._bzr_test_setUp_run = True
821
773
        self._cleanEnvironment()
822
774
        self._silenceUI()
823
775
        self._startLogFile()
824
776
        self._benchcalls = []
825
777
        self._benchtime = None
826
778
        self._clear_hooks()
827
 
        self._track_transports()
828
 
        self._track_locks()
829
779
        self._clear_debug_flags()
830
780
        TestCase._active_threads = threading.activeCount()
831
781
        self.addCleanup(self._check_leaked_threads)
835
785
        import pdb
836
786
        pdb.Pdb().set_trace(sys._getframe().f_back)
837
787
 
 
788
    def exc_info(self):
 
789
        absent_attr = object()
 
790
        exc_info = getattr(self, '_exc_info', absent_attr)
 
791
        if exc_info is absent_attr:
 
792
            exc_info = getattr(self, '_TestCase__exc_info')
 
793
        return exc_info()
 
794
 
838
795
    def _check_leaked_threads(self):
839
796
        active = threading.activeCount()
840
797
        leaked_threads = active - TestCase._active_threads
841
798
        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:
 
799
        if leaked_threads:
849
800
            TestCase._leaking_threads_tests += 1
850
801
            if TestCase._first_thread_leaker_id is None:
851
802
                TestCase._first_thread_leaker_id = self.id()
 
803
                # we're not specifically told when all tests are finished.
 
804
                # This will do. We use a function to avoid keeping a reference
 
805
                # to a TestCase object.
 
806
                atexit.register(_report_leaked_threads)
852
807
 
853
808
    def _clear_debug_flags(self):
854
809
        """Prevent externally set debug flags affecting tests.
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))
 
814
        self._preserved_debug_flags = set(debug.debug_flags)
861
815
        if 'allow_debug' not in selftest_debug_flags:
862
816
            debug.debug_flags.clear()
863
 
        if 'disable_lock_checks' not in selftest_debug_flags:
864
 
            debug.debug_flags.add('strict_locks')
 
817
        self.addCleanup(self._restore_debug_flags)
865
818
 
866
819
    def _clear_hooks(self):
867
820
        # prevent hooks affecting tests
874
827
        for key, factory in hooks.known_hooks.items():
875
828
            parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
876
829
            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
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.
1110
879
            return
1111
880
        if message is None:
1112
881
            message = "texts not equal:\n"
 
882
        if a == b + '\n':
 
883
            message = 'first string is missing a final newline.\n'
1113
884
        if a + '\n' == b:
1114
 
            message = 'first string is missing a final newline.\n'
1115
 
        if a == b + '\n':
1116
885
            message = 'second string is missing a final newline.\n'
1117
886
        raise AssertionError(message +
1118
887
                             self._ndiff_strings(a, b))
1129
898
        :raises AssertionError: If the expected and actual stat values differ
1130
899
            other than by atime.
1131
900
        """
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')
 
901
        self.assertEqual(expected.st_size, actual.st_size)
 
902
        self.assertEqual(expected.st_mtime, actual.st_mtime)
 
903
        self.assertEqual(expected.st_ctime, actual.st_ctime)
 
904
        self.assertEqual(expected.st_dev, actual.st_dev)
 
905
        self.assertEqual(expected.st_ino, actual.st_ino)
 
906
        self.assertEqual(expected.st_mode, actual.st_mode)
1149
907
 
1150
908
    def assertLength(self, length, obj_with_len):
1151
909
        """Assert that obj_with_len is of length length."""
1153
911
            self.fail("Incorrect length: wanted %d, got %d for %r" % (
1154
912
                length, len(obj_with_len), obj_with_len))
1155
913
 
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
914
    def assertPositive(self, val):
1176
915
        """Assert that val is greater than 0."""
1177
916
        self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1207
946
            raise AssertionError('pattern "%s" found in "%s"'
1208
947
                    % (needle_re, haystack))
1209
948
 
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
949
    def assertSubset(self, sublist, superlist):
1215
950
        """Assert that every entry in sublist is present in superlist."""
1216
951
        missing = set(sublist) - set(superlist)
1273
1008
                raise AssertionError("%r is %r." % (left, right))
1274
1009
 
1275
1010
    def assertTransportMode(self, transport, path, mode):
1276
 
        """Fail if a path does not have mode "mode".
 
1011
        """Fail if a path does not have mode mode.
1277
1012
 
1278
1013
        If modes are not supported on this transport, the assertion is ignored.
1279
1014
        """
1291
1026
                         osutils.realpath(path2),
1292
1027
                         "apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1293
1028
 
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
 
        """
 
1029
    def assertIsInstance(self, obj, kls):
 
1030
        """Fail if obj is not an instance of kls"""
1299
1031
        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)
 
1032
            self.fail("%r is an instance of %s rather than %s" % (
 
1033
                obj, obj.__class__, kls))
 
1034
 
 
1035
    def expectFailure(self, reason, assertion, *args, **kwargs):
 
1036
        """Invoke a test, expecting it to fail for the given reason.
 
1037
 
 
1038
        This is for assertions that ought to succeed, but currently fail.
 
1039
        (The failure is *expected* but not *wanted*.)  Please be very precise
 
1040
        about the failure you're expecting.  If a new bug is introduced,
 
1041
        AssertionError should be raised, not KnownFailure.
 
1042
 
 
1043
        Frequently, expectFailure should be followed by an opposite assertion.
 
1044
        See example below.
 
1045
 
 
1046
        Intended to be used with a callable that raises AssertionError as the
 
1047
        'assertion' parameter.  args and kwargs are passed to the 'assertion'.
 
1048
 
 
1049
        Raises KnownFailure if the test fails.  Raises AssertionError if the
 
1050
        test succeeds.
 
1051
 
 
1052
        example usage::
 
1053
 
 
1054
          self.expectFailure('Math is broken', self.assertNotEqual, 54,
 
1055
                             dynamic_val)
 
1056
          self.assertEqual(42, dynamic_val)
 
1057
 
 
1058
          This means that a dynamic_val of 54 will cause the test to raise
 
1059
          a KnownFailure.  Once math is fixed and the expectFailure is removed,
 
1060
          only a dynamic_val of 42 will allow the test to pass.  Anything other
 
1061
          than 54 or 42 will cause an AssertionError.
 
1062
        """
 
1063
        try:
 
1064
            assertion(*args, **kwargs)
 
1065
        except AssertionError:
 
1066
            raise KnownFailure(reason)
 
1067
        else:
 
1068
            self.fail('Unexpected success.  Should have failed: %s' % reason)
1305
1069
 
1306
1070
    def assertFileEqual(self, content, path):
1307
1071
        """Fail if path does not contain 'content'."""
1313
1077
            f.close()
1314
1078
        self.assertEqualDiff(content, s)
1315
1079
 
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
1080
    def failUnlessExists(self, path):
1325
1081
        """Fail unless path or paths, which may be abs or relative, exist."""
1326
1082
        if not isinstance(path, basestring):
1466
1222
 
1467
1223
        Close the file and delete it, unless setKeepLogfile was called.
1468
1224
        """
1469
 
        if bzrlib.trace._trace_file:
1470
 
            # flush the log file, to get all content
1471
 
            bzrlib.trace._trace_file.flush()
 
1225
        if self._log_file is None:
 
1226
            return
1472
1227
        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')
 
1228
        self._log_file.close()
 
1229
        self._log_file = None
 
1230
        if not self._keep_log_file:
 
1231
            os.remove(self._log_file_name)
 
1232
            self._log_file_name = None
 
1233
 
 
1234
    def setKeepLogfile(self):
 
1235
        """Make the logfile not be deleted when _finishLogFile is called."""
 
1236
        self._keep_log_file = True
1488
1237
 
1489
1238
    def addCleanup(self, callable, *args, **kwargs):
1490
1239
        """Arrange to run a callable when this case is torn down.
1494
1243
        """
1495
1244
        self._cleanups.append((callable, args, kwargs))
1496
1245
 
1497
 
    def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1498
 
        """Overrides an object attribute restoring it after the test.
1499
 
 
1500
 
        :param obj: The object that will be mutated.
1501
 
 
1502
 
        :param attr_name: The attribute name we want to preserve/override in
1503
 
            the object.
1504
 
 
1505
 
        :param new: The optional value we want to set the attribute to.
1506
 
 
1507
 
        :returns: The actual attr value.
1508
 
        """
1509
 
        value = getattr(obj, attr_name)
1510
 
        # The actual value is captured by the call below
1511
 
        self.addCleanup(setattr, obj, attr_name, value)
1512
 
        if new is not _unitialized_attr:
1513
 
            setattr(obj, attr_name, new)
1514
 
        return value
1515
 
 
1516
1246
    def _cleanEnvironment(self):
1517
1247
        new_env = {
1518
1248
            'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1528
1258
            'BZR_PROGRESS_BAR': None,
1529
1259
            'BZR_LOG': None,
1530
1260
            '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
1261
            # SSH Agent
1543
1262
            'SSH_AUTH_SOCK': None,
1544
1263
            # Proxies
1550
1269
            'NO_PROXY': None,
1551
1270
            'all_proxy': None,
1552
1271
            'ALL_PROXY': None,
1553
 
            # Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
 
1272
            # Nobody cares about these ones AFAIK. So far at
1554
1273
            # least. If you do (care), please update this comment
1555
 
            # -- vila 20080401
 
1274
            # -- vila 20061212
1556
1275
            'ftp_proxy': None,
1557
1276
            'FTP_PROXY': None,
1558
1277
            '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
1278
        }
1565
 
        self._old_env = {}
 
1279
        self.__old_env = {}
1566
1280
        self.addCleanup(self._restoreEnvironment)
1567
1281
        for name, value in new_env.iteritems():
1568
1282
            self._captureVar(name, value)
1569
1283
 
1570
1284
    def _captureVar(self, name, newvalue):
1571
1285
        """Set an environment variable, and reset it when finished."""
1572
 
        self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1286
        self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
1287
 
 
1288
    def _restore_debug_flags(self):
 
1289
        debug.debug_flags.clear()
 
1290
        debug.debug_flags.update(self._preserved_debug_flags)
1573
1291
 
1574
1292
    def _restoreEnvironment(self):
1575
 
        for name, value in self._old_env.iteritems():
 
1293
        for name, value in self.__old_env.iteritems():
1576
1294
            osutils.set_or_unset_env(name, value)
1577
1295
 
1578
1296
    def _restoreHooks(self):
1586
1304
    def _do_skip(self, result, reason):
1587
1305
        addSkip = getattr(result, 'addSkip', None)
1588
1306
        if not callable(addSkip):
1589
 
            result.addSuccess(result)
 
1307
            result.addError(self, self.exc_info())
1590
1308
        else:
1591
1309
            addSkip(self, reason)
1592
1310
 
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)
 
1311
    def run(self, result=None):
 
1312
        if result is None: result = self.defaultTestResult()
 
1313
        for feature in getattr(self, '_test_needs_features', []):
 
1314
            if not feature.available():
 
1315
                result.startTest(self)
 
1316
                if getattr(result, 'addNotSupported', None):
 
1317
                    result.addNotSupported(self, feature)
 
1318
                else:
 
1319
                    result.addSuccess(self)
 
1320
                result.stopTest(self)
 
1321
                return
 
1322
        try:
 
1323
            try:
 
1324
                result.startTest(self)
 
1325
                absent_attr = object()
 
1326
                # Python 2.5
 
1327
                method_name = getattr(self, '_testMethodName', absent_attr)
 
1328
                if method_name is absent_attr:
 
1329
                    # Python 2.4
 
1330
                    method_name = getattr(self, '_TestCase__testMethodName')
 
1331
                testMethod = getattr(self, method_name)
 
1332
                try:
 
1333
                    try:
 
1334
                        self.setUp()
 
1335
                        if not self._bzr_test_setUp_run:
 
1336
                            self.fail(
 
1337
                                "test setUp did not invoke "
 
1338
                                "bzrlib.tests.TestCase's setUp")
 
1339
                    except KeyboardInterrupt:
 
1340
                        raise
 
1341
                    except TestSkipped, e:
 
1342
                        self._do_skip(result, e.args[0])
 
1343
                        self.tearDown()
 
1344
                        return
 
1345
                    except:
 
1346
                        result.addError(self, self.exc_info())
 
1347
                        return
 
1348
 
 
1349
                    ok = False
 
1350
                    try:
 
1351
                        testMethod()
 
1352
                        ok = True
 
1353
                    except self.failureException:
 
1354
                        result.addFailure(self, self.exc_info())
 
1355
                    except TestSkipped, e:
 
1356
                        if not e.args:
 
1357
                            reason = "No reason given."
 
1358
                        else:
 
1359
                            reason = e.args[0]
 
1360
                        self._do_skip(result, reason)
 
1361
                    except KeyboardInterrupt:
 
1362
                        raise
 
1363
                    except:
 
1364
                        result.addError(self, self.exc_info())
 
1365
 
 
1366
                    try:
 
1367
                        self.tearDown()
 
1368
                        if not self._bzr_test_tearDown_run:
 
1369
                            self.fail(
 
1370
                                "test tearDown did not invoke "
 
1371
                                "bzrlib.tests.TestCase's tearDown")
 
1372
                    except KeyboardInterrupt:
 
1373
                        raise
 
1374
                    except:
 
1375
                        result.addError(self, self.exc_info())
 
1376
                        ok = False
 
1377
                    if ok: result.addSuccess(self)
 
1378
                finally:
 
1379
                    result.stopTest(self)
 
1380
                return
 
1381
            except TestNotApplicable:
 
1382
                # Not moved from the result [yet].
 
1383
                raise
 
1384
            except KeyboardInterrupt:
 
1385
                raise
 
1386
        finally:
 
1387
            saved_attrs = {}
 
1388
            absent_attr = object()
 
1389
            for attr_name in self.attrs_to_keep:
 
1390
                attr = getattr(self, attr_name, absent_attr)
 
1391
                if attr is not absent_attr:
 
1392
                    saved_attrs[attr_name] = attr
 
1393
            self.__dict__ = saved_attrs
 
1394
 
 
1395
    def tearDown(self):
 
1396
        self._bzr_test_tearDown_run = True
 
1397
        self._runCleanups()
 
1398
        self._log_contents = ''
 
1399
        unittest.TestCase.tearDown(self)
1622
1400
 
1623
1401
    def time(self, callable, *args, **kwargs):
1624
1402
        """Run callable and accrue the time it takes to the benchmark time.
1628
1406
        self._benchcalls.
1629
1407
        """
1630
1408
        if self._benchtime is None:
1631
 
            self.addDetail('benchtime', content.Content(content.ContentType(
1632
 
                "text", "plain"), lambda:[str(self._benchtime)]))
1633
1409
            self._benchtime = 0
1634
1410
        start = time.time()
1635
1411
        try:
1644
1420
        finally:
1645
1421
            self._benchtime += time.time() - start
1646
1422
 
 
1423
    def _runCleanups(self):
 
1424
        """Run registered cleanup functions.
 
1425
 
 
1426
        This should only be called from TestCase.tearDown.
 
1427
        """
 
1428
        # TODO: Perhaps this should keep running cleanups even if
 
1429
        # one of them fails?
 
1430
 
 
1431
        # Actually pop the cleanups from the list so tearDown running
 
1432
        # twice is safe (this happens for skipped tests).
 
1433
        while self._cleanups:
 
1434
            cleanup, args, kwargs = self._cleanups.pop()
 
1435
            cleanup(*args, **kwargs)
 
1436
 
1647
1437
    def log(self, *args):
1648
1438
        mutter(*args)
1649
1439
 
1650
1440
    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.
 
1441
        """Get the log from bzrlib.trace calls from this test.
1655
1442
 
1656
1443
        :param keep_log_file: When True, if the log is still a file on disk
1657
1444
            leave it as a file on disk. When False, if the log is still a file
1659
1446
            self._log_contents.
1660
1447
        :return: A string containing the log.
1661
1448
        """
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')
 
1449
        # flush the log file, to get all content
 
1450
        import bzrlib.trace
 
1451
        if bzrlib.trace._trace_file:
 
1452
            bzrlib.trace._trace_file.flush()
 
1453
        if self._log_contents:
 
1454
            # XXX: this can hardly contain the content flushed above --vila
 
1455
            # 20080128
1668
1456
            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
1457
        if self._log_file_name is not None:
1674
1458
            logfile = open(self._log_file_name)
1675
1459
            try:
1676
1460
                log_contents = logfile.read()
1677
1461
            finally:
1678
1462
                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
1463
            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
1464
                self._log_contents = log_contents
1716
1465
                try:
1717
1466
                    os.remove(self._log_file_name)
1721
1470
                                             ' %r\n' % self._log_file_name))
1722
1471
                    else:
1723
1472
                        raise
1724
 
                self._log_file_name = None
1725
1473
            return log_contents
1726
1474
        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())
 
1475
            return "DELETED log file to reduce memory footprint"
1735
1476
 
1736
1477
    def requireFeature(self, feature):
1737
1478
        """This test requires a specific feature is available.
1754
1495
 
1755
1496
    def _run_bzr_core(self, args, retcode, encoding, stdin,
1756
1497
            working_dir):
1757
 
        # Clear chk_map page cache, because the contents are likely to mask
1758
 
        # locking errors.
1759
 
        chk_map.clear_cache()
1760
1498
        if encoding is None:
1761
1499
            encoding = osutils.get_user_encoding()
1762
1500
        stdout = StringIOWrapper()
1779
1517
            os.chdir(working_dir)
1780
1518
 
1781
1519
        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)
 
1520
            result = self.apply_redirected(ui.ui_factory.stdin,
 
1521
                stdout, stderr,
 
1522
                bzrlib.commands.run_bzr_catch_user_errors,
 
1523
                args)
1798
1524
        finally:
1799
1525
            logger.removeHandler(handler)
1800
1526
            ui.ui_factory = old_ui_factory
1810
1536
        if retcode is not None:
1811
1537
            self.assertEquals(retcode, result,
1812
1538
                              message='Unexpected return code')
1813
 
        return result, out, err
 
1539
        return out, err
1814
1540
 
1815
1541
    def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1816
1542
                working_dir=None, error_regexes=[], output_encoding=None):
1845
1571
        :keyword error_regexes: A list of expected error messages.  If
1846
1572
            specified they must be seen in the error output of the command.
1847
1573
        """
1848
 
        retcode, out, err = self._run_bzr_autosplit(
 
1574
        out, err = self._run_bzr_autosplit(
1849
1575
            args=args,
1850
1576
            retcode=retcode,
1851
1577
            encoding=encoding,
1852
1578
            stdin=stdin,
1853
1579
            working_dir=working_dir,
1854
1580
            )
1855
 
        self.assertIsInstance(error_regexes, (list, tuple))
1856
1581
        for regex in error_regexes:
1857
1582
            self.assertContainsRe(err, regex)
1858
1583
        return out, err
2002
1727
        """
2003
1728
        return Popen(*args, **kwargs)
2004
1729
 
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
1730
    def get_bzr_path(self):
2010
1731
        """Return the path of the 'bzr' executable for this test suite."""
2011
 
        bzr_path = self.get_source_path()+'/bzr'
 
1732
        bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
2012
1733
        if not os.path.isfile(bzr_path):
2013
1734
            # We are probably installed. Assume sys.argv is the right file
2014
1735
            bzr_path = sys.argv[0]
2100
1821
 
2101
1822
        Tests that expect to provoke LockContention errors should call this.
2102
1823
        """
2103
 
        self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
 
1824
        orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
 
1825
        def resetTimeout():
 
1826
            bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
 
1827
        self.addCleanup(resetTimeout)
 
1828
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2104
1829
 
2105
1830
    def make_utf8_encoded_stringio(self, encoding_type=None):
2106
1831
        """Return a StringIOWrapper instance, that will encode Unicode
2114
1839
        sio.encoding = output_encoding
2115
1840
        return sio
2116
1841
 
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
1842
 
2126
1843
class CapturedCall(object):
2127
1844
    """A helper for capturing smart server calls for easy debug analysis."""
2217
1934
        if self.__readonly_server is None:
2218
1935
            if self.transport_readonly_server is None:
2219
1936
                # readonly decorator requested
2220
 
                self.__readonly_server = test_server.ReadonlyServer()
 
1937
                # bring up the server
 
1938
                self.__readonly_server = ReadonlyServer()
 
1939
                self.__readonly_server.setUp(self.get_vfs_only_server())
2221
1940
            else:
2222
 
                # explicit readonly transport.
2223
1941
                self.__readonly_server = self.create_transport_readonly_server()
2224
 
            self.start_server(self.__readonly_server,
2225
 
                self.get_vfs_only_server())
 
1942
                self.__readonly_server.setUp(self.get_vfs_only_server())
 
1943
            self.addCleanup(self.__readonly_server.tearDown)
2226
1944
        return self.__readonly_server
2227
1945
 
2228
1946
    def get_readonly_url(self, relpath=None):
2246
1964
        is no means to override it.
2247
1965
        """
2248
1966
        if self.__vfs_server is None:
2249
 
            self.__vfs_server = memory.MemoryServer()
2250
 
            self.start_server(self.__vfs_server)
 
1967
            self.__vfs_server = MemoryServer()
 
1968
            self.__vfs_server.setUp()
 
1969
            self.addCleanup(self.__vfs_server.tearDown)
2251
1970
        return self.__vfs_server
2252
1971
 
2253
1972
    def get_server(self):
2260
1979
        then the self.get_vfs_server is returned.
2261
1980
        """
2262
1981
        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()
 
1982
            if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
 
1983
                return self.get_vfs_only_server()
2266
1984
            else:
2267
1985
                # bring up a decorated means of access to the vfs only server.
2268
1986
                self.__server = self.transport_server()
2269
 
                self.start_server(self.__server, self.get_vfs_only_server())
 
1987
                try:
 
1988
                    self.__server.setUp(self.get_vfs_only_server())
 
1989
                except TypeError, e:
 
1990
                    # This should never happen; the try:Except here is to assist
 
1991
                    # developers having to update code rather than seeing an
 
1992
                    # uninformative TypeError.
 
1993
                    raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
 
1994
            self.addCleanup(self.__server.tearDown)
2270
1995
        return self.__server
2271
1996
 
2272
1997
    def _adjust_url(self, base, relpath):
2334
2059
        propagating. This method ensures than a test did not leaked.
2335
2060
        """
2336
2061
        root = TestCaseWithMemoryTransport.TEST_ROOT
2337
 
        self.permit_url(get_transport(root).base)
2338
2062
        wt = workingtree.WorkingTree.open(root)
2339
2063
        last_rev = wt.last_revision()
2340
2064
        if last_rev != 'null:':
2342
2066
            # recreate a new one or all the followng tests will fail.
2343
2067
            # If you need to inspect its content uncomment the following line
2344
2068
            # import pdb; pdb.set_trace()
2345
 
            _rmtree_temp_dir(root + '/.bzr', test_id=self.id())
 
2069
            _rmtree_temp_dir(root + '/.bzr')
2346
2070
            self._create_safety_net()
2347
2071
            raise AssertionError('%s/.bzr should not be modified' % root)
2348
2072
 
2349
2073
    def _make_test_root(self):
2350
2074
        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'))
 
2075
            root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2354
2076
            TestCaseWithMemoryTransport.TEST_ROOT = root
2355
2077
 
2356
2078
            self._create_safety_net()
2359
2081
            # specifically told when all tests are finished.  This will do.
2360
2082
            atexit.register(_rmtree_temp_dir, root)
2361
2083
 
2362
 
        self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2363
2084
        self.addCleanup(self._check_safety_net)
2364
2085
 
2365
2086
    def makeAndChdirToTestDir(self):
2373
2094
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2374
2095
        self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2375
2096
        self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2376
 
        self.permit_dir(self.test_dir)
2377
2097
 
2378
2098
    def make_branch(self, relpath, format=None):
2379
2099
        """Create a branch on the transport at relpath."""
2409
2129
        return made_control.create_repository(shared=shared)
2410
2130
 
2411
2131
    def make_smart_server(self, path):
2412
 
        smart_server = test_server.SmartTCPServer_for_testing()
2413
 
        self.start_server(smart_server, self.get_server())
 
2132
        smart_server = server.SmartTCPServer_for_testing()
 
2133
        smart_server.setUp(self.get_server())
2414
2134
        remote_transport = get_transport(smart_server.get_url()).clone(path)
 
2135
        self.addCleanup(smart_server.tearDown)
2415
2136
        return remote_transport
2416
2137
 
2417
2138
    def make_branch_and_memory_tree(self, relpath, format=None):
2420
2141
        return memorytree.MemoryTree.create_on_branch(b)
2421
2142
 
2422
2143
    def make_branch_builder(self, relpath, format=None):
2423
 
        branch = self.make_branch(relpath, format=format)
2424
 
        return branchbuilder.BranchBuilder(branch=branch)
 
2144
        return branchbuilder.BranchBuilder(self.get_transport(relpath),
 
2145
            format=format)
2425
2146
 
2426
2147
    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
 
2148
        os.environ['HOME'] = self.test_home_dir
 
2149
        os.environ['BZR_HOME'] = self.test_home_dir
2432
2150
 
2433
2151
    def setUp(self):
2434
2152
        super(TestCaseWithMemoryTransport, self).setUp()
2435
2153
        self._make_test_root()
2436
 
        self.addCleanup(os.chdir, os.getcwdu())
 
2154
        _currentdir = os.getcwdu()
 
2155
        def _leaveDirectory():
 
2156
            os.chdir(_currentdir)
 
2157
        self.addCleanup(_leaveDirectory)
2437
2158
        self.makeAndChdirToTestDir()
2438
2159
        self.overrideEnvironmentForTesting()
2439
2160
        self.__readonly_server = None
2442
2163
 
2443
2164
    def setup_smart_server_with_call_log(self):
2444
2165
        """Sets up a smart server as the transport server with a call log."""
2445
 
        self.transport_server = test_server.SmartTCPServer_for_testing
 
2166
        self.transport_server = server.SmartTCPServer_for_testing
2446
2167
        self.hpss_calls = []
2447
2168
        import traceback
2448
2169
        # Skip the current stack down to the caller of
2490
2211
 
2491
2212
    def _getTestDirPrefix(self):
2492
2213
        # create a directory within the top level test directory
2493
 
        if sys.platform in ('win32', 'cygwin'):
 
2214
        if sys.platform == 'win32':
2494
2215
            name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2495
2216
            # windows is likely to have path-length limits so use a short name
2496
2217
            name_prefix = name_prefix[-30:]
2504
2225
        For TestCaseInTempDir we create a temporary directory based on the test
2505
2226
        name and then create two subdirs - test and home under it.
2506
2227
        """
2507
 
        name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2508
 
            self._getTestDirPrefix())
 
2228
        name_prefix = osutils.pathjoin(self.TEST_ROOT, self._getTestDirPrefix())
2509
2229
        name = name_prefix
2510
2230
        for i in range(100):
2511
2231
            if os.path.exists(name):
2512
2232
                name = name_prefix + '_' + str(i)
2513
2233
            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)
 
2234
                os.mkdir(name)
2518
2235
                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()
 
2236
        # now create test and home directories within this dir
 
2237
        self.test_base_dir = name
2526
2238
        self.test_home_dir = self.test_base_dir + '/home'
2527
2239
        os.mkdir(self.test_home_dir)
2528
2240
        self.test_dir = self.test_base_dir + '/work'
2534
2246
            f.write(self.id())
2535
2247
        finally:
2536
2248
            f.close()
 
2249
        self.addCleanup(self.deleteTestDir)
2537
2250
 
2538
2251
    def deleteTestDir(self):
2539
 
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2540
 
        _rmtree_temp_dir(self.test_base_dir, test_id=self.id())
 
2252
        os.chdir(self.TEST_ROOT)
 
2253
        _rmtree_temp_dir(self.test_base_dir)
2541
2254
 
2542
2255
    def build_tree(self, shape, line_endings='binary', transport=None):
2543
2256
        """Build a test tree according to a pattern.
2625
2338
        """
2626
2339
        if self.__vfs_server is None:
2627
2340
            self.__vfs_server = self.vfs_transport_factory()
2628
 
            self.start_server(self.__vfs_server)
 
2341
            self.__vfs_server.setUp()
 
2342
            self.addCleanup(self.__vfs_server.tearDown)
2629
2343
        return self.__vfs_server
2630
2344
 
2631
2345
    def make_branch_and_tree(self, relpath, format=None):
2638
2352
        repository will also be accessed locally. Otherwise a lightweight
2639
2353
        checkout is created and returned.
2640
2354
 
2641
 
        We do this because we can't physically create a tree in the local
2642
 
        path, with a branch reference to the transport_factory url, and
2643
 
        a branch + repository in the vfs_transport, unless the vfs_transport
2644
 
        namespace is distinct from the local disk - the two branch objects
2645
 
        would collide. While we could construct a tree with its branch object
2646
 
        pointing at the transport_factory transport in memory, reopening it
2647
 
        would behaving unexpectedly, and has in the past caused testing bugs
2648
 
        when we tried to do it that way.
2649
 
 
2650
2355
        :param format: The BzrDirFormat.
2651
2356
        :returns: the WorkingTree.
2652
2357
        """
2661
2366
            # We can only make working trees locally at the moment.  If the
2662
2367
            # transport can't support them, then we keep the non-disk-backed
2663
2368
            # branch and create a local checkout.
2664
 
            if self.vfs_transport_factory is test_server.LocalURLServer:
 
2369
            if self.vfs_transport_factory is LocalURLServer:
2665
2370
                # the branch is colocated on disk, we cannot create a checkout.
2666
2371
                # hopefully callers will expect this.
2667
2372
                local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2704
2409
        super(TestCaseWithTransport, self).setUp()
2705
2410
        self.__vfs_server = None
2706
2411
 
2707
 
    def disable_missing_extensions_warning(self):
2708
 
        """Some tests expect a precise stderr content.
2709
 
 
2710
 
        There is no point in forcing them to duplicate the extension related
2711
 
        warning.
2712
 
        """
2713
 
        config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2714
 
 
2715
2412
 
2716
2413
class ChrootedTestCase(TestCaseWithTransport):
2717
2414
    """A support class that provides readonly urls outside the local namespace.
2727
2424
 
2728
2425
    def setUp(self):
2729
2426
        super(ChrootedTestCase, self).setUp()
2730
 
        if not self.vfs_transport_factory == memory.MemoryServer:
 
2427
        if not self.vfs_transport_factory == MemoryServer:
2731
2428
            self.transport_readonly_server = HttpServer
2732
2429
 
2733
2430
 
2929
2626
              random_seed=None,
2930
2627
              exclude_pattern=None,
2931
2628
              strict=False,
2932
 
              runner_class=None,
2933
 
              suite_decorators=None,
2934
 
              stream=None,
2935
 
              result_decorators=None,
2936
 
              ):
 
2629
              runner_class=None):
2937
2630
    """Run a test suite for bzr selftest.
2938
2631
 
2939
2632
    :param runner_class: The class of runner to use. Must support the
2948
2641
        verbosity = 1
2949
2642
    if runner_class is None:
2950
2643
        runner_class = TextTestRunner
2951
 
    if stream is None:
2952
 
        stream = sys.stdout
2953
 
    runner = runner_class(stream=stream,
 
2644
    runner = runner_class(stream=sys.stdout,
2954
2645
                            descriptions=0,
2955
2646
                            verbosity=verbosity,
2956
2647
                            bench_history=bench_history,
2957
 
                            strict=strict,
2958
 
                            result_decorators=result_decorators,
 
2648
                            list_only=list_only,
2959
2649
                            )
2960
2650
    runner.stop_on_failure=stop_on_failure
2961
 
    # built in decorator factories:
2962
 
    decorators = [
2963
 
        random_order(random_seed, runner),
2964
 
        exclude_tests(exclude_pattern),
2965
 
        ]
2966
 
    if matching_tests_first:
2967
 
        decorators.append(tests_first(pattern))
 
2651
    # Initialise the random number generator and display the seed used.
 
2652
    # We convert the seed to a long to make it reuseable across invocations.
 
2653
    random_order = False
 
2654
    if random_seed is not None:
 
2655
        random_order = True
 
2656
        if random_seed == "now":
 
2657
            random_seed = long(time.time())
 
2658
        else:
 
2659
            # Convert the seed to a long if we can
 
2660
            try:
 
2661
                random_seed = long(random_seed)
 
2662
            except:
 
2663
                pass
 
2664
        runner.stream.writeln("Randomizing test order using seed %s\n" %
 
2665
            (random_seed))
 
2666
        random.seed(random_seed)
 
2667
    # Customise the list of tests if requested
 
2668
    if exclude_pattern is not None:
 
2669
        suite = exclude_tests_by_re(suite, exclude_pattern)
 
2670
    if random_order:
 
2671
        order_changer = randomize_suite
2968
2672
    else:
2969
 
        decorators.append(filter_tests(pattern))
2970
 
    if suite_decorators:
2971
 
        decorators.extend(suite_decorators)
2972
 
    # tell the result object how many tests will be running: (except if
2973
 
    # --parallel=fork is being used. Robert said he will provide a better
2974
 
    # progress design later -- vila 20090817)
2975
 
    if fork_decorator not in decorators:
2976
 
        decorators.append(CountingDecorator)
2977
 
    for decorator in decorators:
2978
 
        suite = decorator(suite)
2979
 
    if list_only:
2980
 
        # Done after test suite decoration to allow randomisation etc
2981
 
        # to take effect, though that is of marginal benefit.
2982
 
        if verbosity >= 2:
2983
 
            stream.write("Listing tests only ...\n")
2984
 
        for t in iter_suite_tests(suite):
2985
 
            stream.write("%s\n" % (t.id()))
2986
 
        return True
 
2673
        order_changer = preserve_input
 
2674
    if pattern != '.*' or random_order:
 
2675
        if matching_tests_first:
 
2676
            suites = map(order_changer, split_suite_by_re(suite, pattern))
 
2677
            suite = TestUtil.TestSuite(suites)
 
2678
        else:
 
2679
            suite = order_changer(filter_suite_by_re(suite, pattern))
 
2680
 
2987
2681
    result = runner.run(suite)
 
2682
 
2988
2683
    if strict:
2989
2684
        return result.wasStrictlySuccessful()
2990
 
    else:
2991
 
        return result.wasSuccessful()
2992
 
 
2993
 
 
2994
 
# A registry where get() returns a suite decorator.
2995
 
parallel_registry = registry.Registry()
2996
 
 
2997
 
 
2998
 
def fork_decorator(suite):
2999
 
    concurrency = osutils.local_concurrency()
3000
 
    if concurrency == 1:
3001
 
        return suite
3002
 
    from testtools import ConcurrentTestSuite
3003
 
    return ConcurrentTestSuite(suite, fork_for_tests)
3004
 
parallel_registry.register('fork', fork_decorator)
3005
 
 
3006
 
 
3007
 
def subprocess_decorator(suite):
3008
 
    concurrency = osutils.local_concurrency()
3009
 
    if concurrency == 1:
3010
 
        return suite
3011
 
    from testtools import ConcurrentTestSuite
3012
 
    return ConcurrentTestSuite(suite, reinvoke_for_tests)
3013
 
parallel_registry.register('subprocess', subprocess_decorator)
3014
 
 
3015
 
 
3016
 
def exclude_tests(exclude_pattern):
3017
 
    """Return a test suite decorator that excludes tests."""
3018
 
    if exclude_pattern is None:
3019
 
        return identity_decorator
3020
 
    def decorator(suite):
3021
 
        return ExcludeDecorator(suite, exclude_pattern)
3022
 
    return decorator
3023
 
 
3024
 
 
3025
 
def filter_tests(pattern):
3026
 
    if pattern == '.*':
3027
 
        return identity_decorator
3028
 
    def decorator(suite):
3029
 
        return FilterTestsDecorator(suite, pattern)
3030
 
    return decorator
3031
 
 
3032
 
 
3033
 
def random_order(random_seed, runner):
3034
 
    """Return a test suite decorator factory for randomising tests order.
3035
 
    
3036
 
    :param random_seed: now, a string which casts to a long, or a long.
3037
 
    :param runner: A test runner with a stream attribute to report on.
3038
 
    """
3039
 
    if random_seed is None:
3040
 
        return identity_decorator
3041
 
    def decorator(suite):
3042
 
        return RandomDecorator(suite, random_seed, runner.stream)
3043
 
    return decorator
3044
 
 
3045
 
 
3046
 
def tests_first(pattern):
3047
 
    if pattern == '.*':
3048
 
        return identity_decorator
3049
 
    def decorator(suite):
3050
 
        return TestFirstDecorator(suite, pattern)
3051
 
    return decorator
3052
 
 
3053
 
 
3054
 
def identity_decorator(suite):
3055
 
    """Return suite."""
3056
 
    return suite
3057
 
 
3058
 
 
3059
 
class TestDecorator(TestSuite):
3060
 
    """A decorator for TestCase/TestSuite objects.
3061
 
    
3062
 
    Usually, subclasses should override __iter__(used when flattening test
3063
 
    suites), which we do to filter, reorder, parallelise and so on, run() and
3064
 
    debug().
3065
 
    """
3066
 
 
3067
 
    def __init__(self, suite):
3068
 
        TestSuite.__init__(self)
3069
 
        self.addTest(suite)
3070
 
 
3071
 
    def countTestCases(self):
3072
 
        cases = 0
3073
 
        for test in self:
3074
 
            cases += test.countTestCases()
3075
 
        return cases
3076
 
 
3077
 
    def debug(self):
3078
 
        for test in self:
3079
 
            test.debug()
3080
 
 
3081
 
    def run(self, result):
3082
 
        # Use iteration on self, not self._tests, to allow subclasses to hook
3083
 
        # into __iter__.
3084
 
        for test in self:
3085
 
            if result.shouldStop:
3086
 
                break
3087
 
            test.run(result)
3088
 
        return result
3089
 
 
3090
 
 
3091
 
class CountingDecorator(TestDecorator):
3092
 
    """A decorator which calls result.progress(self.countTestCases)."""
3093
 
 
3094
 
    def run(self, result):
3095
 
        progress_method = getattr(result, 'progress', None)
3096
 
        if callable(progress_method):
3097
 
            progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3098
 
        return super(CountingDecorator, self).run(result)
3099
 
 
3100
 
 
3101
 
class ExcludeDecorator(TestDecorator):
3102
 
    """A decorator which excludes test matching an exclude pattern."""
3103
 
 
3104
 
    def __init__(self, suite, exclude_pattern):
3105
 
        TestDecorator.__init__(self, suite)
3106
 
        self.exclude_pattern = exclude_pattern
3107
 
        self.excluded = False
3108
 
 
3109
 
    def __iter__(self):
3110
 
        if self.excluded:
3111
 
            return iter(self._tests)
3112
 
        self.excluded = True
3113
 
        suite = exclude_tests_by_re(self, self.exclude_pattern)
3114
 
        del self._tests[:]
3115
 
        self.addTests(suite)
3116
 
        return iter(self._tests)
3117
 
 
3118
 
 
3119
 
class FilterTestsDecorator(TestDecorator):
3120
 
    """A decorator which filters tests to those matching a pattern."""
3121
 
 
3122
 
    def __init__(self, suite, pattern):
3123
 
        TestDecorator.__init__(self, suite)
3124
 
        self.pattern = pattern
3125
 
        self.filtered = False
3126
 
 
3127
 
    def __iter__(self):
3128
 
        if self.filtered:
3129
 
            return iter(self._tests)
3130
 
        self.filtered = True
3131
 
        suite = filter_suite_by_re(self, self.pattern)
3132
 
        del self._tests[:]
3133
 
        self.addTests(suite)
3134
 
        return iter(self._tests)
3135
 
 
3136
 
 
3137
 
class RandomDecorator(TestDecorator):
3138
 
    """A decorator which randomises the order of its tests."""
3139
 
 
3140
 
    def __init__(self, suite, random_seed, stream):
3141
 
        TestDecorator.__init__(self, suite)
3142
 
        self.random_seed = random_seed
3143
 
        self.randomised = False
3144
 
        self.stream = stream
3145
 
 
3146
 
    def __iter__(self):
3147
 
        if self.randomised:
3148
 
            return iter(self._tests)
3149
 
        self.randomised = True
3150
 
        self.stream.write("Randomizing test order using seed %s\n\n" %
3151
 
            (self.actual_seed()))
3152
 
        # Initialise the random number generator.
3153
 
        random.seed(self.actual_seed())
3154
 
        suite = randomize_suite(self)
3155
 
        del self._tests[:]
3156
 
        self.addTests(suite)
3157
 
        return iter(self._tests)
3158
 
 
3159
 
    def actual_seed(self):
3160
 
        if self.random_seed == "now":
3161
 
            # We convert the seed to a long to make it reuseable across
3162
 
            # invocations (because the user can reenter it).
3163
 
            self.random_seed = long(time.time())
3164
 
        else:
3165
 
            # Convert the seed to a long if we can
3166
 
            try:
3167
 
                self.random_seed = long(self.random_seed)
3168
 
            except:
3169
 
                pass
3170
 
        return self.random_seed
3171
 
 
3172
 
 
3173
 
class TestFirstDecorator(TestDecorator):
3174
 
    """A decorator which moves named tests to the front."""
3175
 
 
3176
 
    def __init__(self, suite, pattern):
3177
 
        TestDecorator.__init__(self, suite)
3178
 
        self.pattern = pattern
3179
 
        self.filtered = False
3180
 
 
3181
 
    def __iter__(self):
3182
 
        if self.filtered:
3183
 
            return iter(self._tests)
3184
 
        self.filtered = True
3185
 
        suites = split_suite_by_re(self, self.pattern)
3186
 
        del self._tests[:]
3187
 
        self.addTests(suites)
3188
 
        return iter(self._tests)
3189
 
 
3190
 
 
3191
 
def partition_tests(suite, count):
3192
 
    """Partition suite into count lists of tests."""
3193
 
    result = []
3194
 
    tests = list(iter_suite_tests(suite))
3195
 
    tests_per_process = int(math.ceil(float(len(tests)) / count))
3196
 
    for block in range(count):
3197
 
        low_test = block * tests_per_process
3198
 
        high_test = low_test + tests_per_process
3199
 
        process_tests = tests[low_test:high_test]
3200
 
        result.append(process_tests)
3201
 
    return result
3202
 
 
3203
 
 
3204
 
def workaround_zealous_crypto_random():
3205
 
    """Crypto.Random want to help us being secure, but we don't care here.
3206
 
 
3207
 
    This workaround some test failure related to the sftp server. Once paramiko
3208
 
    stop using the controversial API in Crypto.Random, we may get rid of it.
3209
 
    """
3210
 
    try:
3211
 
        from Crypto.Random import atfork
3212
 
        atfork()
3213
 
    except ImportError:
3214
 
        pass
3215
 
 
3216
 
 
3217
 
def fork_for_tests(suite):
3218
 
    """Take suite and start up one runner per CPU by forking()
3219
 
 
3220
 
    :return: An iterable of TestCase-like objects which can each have
3221
 
        run(result) called on them to feed tests to result.
3222
 
    """
3223
 
    concurrency = osutils.local_concurrency()
3224
 
    result = []
3225
 
    from subunit import TestProtocolClient, ProtocolTestCase
3226
 
    from subunit.test_results import AutoTimingTestResultDecorator
3227
 
    class TestInOtherProcess(ProtocolTestCase):
3228
 
        # Should be in subunit, I think. RBC.
3229
 
        def __init__(self, stream, pid):
3230
 
            ProtocolTestCase.__init__(self, stream)
3231
 
            self.pid = pid
3232
 
 
3233
 
        def run(self, result):
3234
 
            try:
3235
 
                ProtocolTestCase.run(self, result)
3236
 
            finally:
3237
 
                os.waitpid(self.pid, 0)
3238
 
 
3239
 
    test_blocks = partition_tests(suite, concurrency)
3240
 
    for process_tests in test_blocks:
3241
 
        process_suite = TestSuite()
3242
 
        process_suite.addTests(process_tests)
3243
 
        c2pread, c2pwrite = os.pipe()
3244
 
        pid = os.fork()
3245
 
        if pid == 0:
3246
 
            workaround_zealous_crypto_random()
3247
 
            try:
3248
 
                os.close(c2pread)
3249
 
                # Leave stderr and stdout open so we can see test noise
3250
 
                # Close stdin so that the child goes away if it decides to
3251
 
                # read from stdin (otherwise its a roulette to see what
3252
 
                # child actually gets keystrokes for pdb etc).
3253
 
                sys.stdin.close()
3254
 
                sys.stdin = None
3255
 
                stream = os.fdopen(c2pwrite, 'wb', 1)
3256
 
                subunit_result = AutoTimingTestResultDecorator(
3257
 
                    TestProtocolClient(stream))
3258
 
                process_suite.run(subunit_result)
3259
 
            finally:
3260
 
                os._exit(0)
3261
 
        else:
3262
 
            os.close(c2pwrite)
3263
 
            stream = os.fdopen(c2pread, 'rb', 1)
3264
 
            test = TestInOtherProcess(stream, pid)
3265
 
            result.append(test)
3266
 
    return result
3267
 
 
3268
 
 
3269
 
def reinvoke_for_tests(suite):
3270
 
    """Take suite and start up one runner per CPU using subprocess().
3271
 
 
3272
 
    :return: An iterable of TestCase-like objects which can each have
3273
 
        run(result) called on them to feed tests to result.
3274
 
    """
3275
 
    concurrency = osutils.local_concurrency()
3276
 
    result = []
3277
 
    from subunit import ProtocolTestCase
3278
 
    class TestInSubprocess(ProtocolTestCase):
3279
 
        def __init__(self, process, name):
3280
 
            ProtocolTestCase.__init__(self, process.stdout)
3281
 
            self.process = process
3282
 
            self.process.stdin.close()
3283
 
            self.name = name
3284
 
 
3285
 
        def run(self, result):
3286
 
            try:
3287
 
                ProtocolTestCase.run(self, result)
3288
 
            finally:
3289
 
                self.process.wait()
3290
 
                os.unlink(self.name)
3291
 
            # print "pid %d finished" % finished_process
3292
 
    test_blocks = partition_tests(suite, concurrency)
3293
 
    for process_tests in test_blocks:
3294
 
        # ugly; currently reimplement rather than reuses TestCase methods.
3295
 
        bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3296
 
        if not os.path.isfile(bzr_path):
3297
 
            # We are probably installed. Assume sys.argv is the right file
3298
 
            bzr_path = sys.argv[0]
3299
 
        bzr_path = [bzr_path]
3300
 
        if sys.platform == "win32":
3301
 
            # if we're on windows, we can't execute the bzr script directly
3302
 
            bzr_path = [sys.executable] + bzr_path
3303
 
        fd, test_list_file_name = tempfile.mkstemp()
3304
 
        test_list_file = os.fdopen(fd, 'wb', 1)
3305
 
        for test in process_tests:
3306
 
            test_list_file.write(test.id() + '\n')
3307
 
        test_list_file.close()
3308
 
        try:
3309
 
            argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3310
 
                '--subunit']
3311
 
            if '--no-plugins' in sys.argv:
3312
 
                argv.append('--no-plugins')
3313
 
            # stderr=STDOUT would be ideal, but until we prevent noise on
3314
 
            # stderr it can interrupt the subunit protocol.
3315
 
            process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3316
 
                bufsize=1)
3317
 
            test = TestInSubprocess(process, test_list_file_name)
3318
 
            result.append(test)
3319
 
        except:
3320
 
            os.unlink(test_list_file_name)
3321
 
            raise
3322
 
    return result
3323
 
 
3324
 
 
3325
 
class ForwardingResult(unittest.TestResult):
3326
 
 
3327
 
    def __init__(self, target):
3328
 
        unittest.TestResult.__init__(self)
3329
 
        self.result = target
3330
 
 
3331
 
    def startTest(self, test):
3332
 
        self.result.startTest(test)
3333
 
 
3334
 
    def stopTest(self, test):
3335
 
        self.result.stopTest(test)
3336
 
 
3337
 
    def startTestRun(self):
3338
 
        self.result.startTestRun()
3339
 
 
3340
 
    def stopTestRun(self):
3341
 
        self.result.stopTestRun()
3342
 
 
3343
 
    def addSkip(self, test, reason):
3344
 
        self.result.addSkip(test, reason)
3345
 
 
3346
 
    def addSuccess(self, test):
3347
 
        self.result.addSuccess(test)
3348
 
 
3349
 
    def addError(self, test, err):
3350
 
        self.result.addError(test, err)
3351
 
 
3352
 
    def addFailure(self, test, err):
3353
 
        self.result.addFailure(test, err)
3354
 
ForwardingResult = testtools.ExtendedToOriginalDecorator
3355
 
 
3356
 
 
3357
 
class ProfileResult(ForwardingResult):
3358
 
    """Generate profiling data for all activity between start and success.
3359
 
    
3360
 
    The profile data is appended to the test's _benchcalls attribute and can
3361
 
    be accessed by the forwarded-to TestResult.
3362
 
 
3363
 
    While it might be cleaner do accumulate this in stopTest, addSuccess is
3364
 
    where our existing output support for lsprof is, and this class aims to
3365
 
    fit in with that: while it could be moved it's not necessary to accomplish
3366
 
    test profiling, nor would it be dramatically cleaner.
3367
 
    """
3368
 
 
3369
 
    def startTest(self, test):
3370
 
        self.profiler = bzrlib.lsprof.BzrProfiler()
3371
 
        self.profiler.start()
3372
 
        ForwardingResult.startTest(self, test)
3373
 
 
3374
 
    def addSuccess(self, test):
3375
 
        stats = self.profiler.stop()
3376
 
        try:
3377
 
            calls = test._benchcalls
3378
 
        except AttributeError:
3379
 
            test._benchcalls = []
3380
 
            calls = test._benchcalls
3381
 
        calls.append(((test.id(), "", ""), stats))
3382
 
        ForwardingResult.addSuccess(self, test)
3383
 
 
3384
 
    def stopTest(self, test):
3385
 
        ForwardingResult.stopTest(self, test)
3386
 
        self.profiler = None
 
2685
 
 
2686
    return result.wasSuccessful()
3387
2687
 
3388
2688
 
3389
2689
# Controlled by "bzr selftest -E=..." option
3390
 
# Currently supported:
3391
 
#   -Eallow_debug           Will no longer clear debug.debug_flags() so it
3392
 
#                           preserves any flags supplied at the command line.
3393
 
#   -Edisable_lock_checks   Turns errors in mismatched locks into simple prints
3394
 
#                           rather than failing tests. And no longer raise
3395
 
#                           LockContention when fctnl locks are not being used
3396
 
#                           with proper exclusion rules.
3397
2690
selftest_debug_flags = set()
3398
2691
 
3399
2692
 
3411
2704
             debug_flags=None,
3412
2705
             starting_with=None,
3413
2706
             runner_class=None,
3414
 
             suite_decorators=None,
3415
 
             stream=None,
3416
 
             lsprof_tests=False,
3417
2707
             ):
3418
2708
    """Run the whole test suite under the enhanced runner"""
3419
2709
    # XXX: Very ugly way to do this...
3436
2726
            keep_only = None
3437
2727
        else:
3438
2728
            keep_only = load_test_id_list(load_list)
3439
 
        if starting_with:
3440
 
            starting_with = [test_prefix_alias_registry.resolve_alias(start)
3441
 
                             for start in starting_with]
3442
2729
        if test_suite_factory is None:
3443
 
            # Reduce loading time by loading modules based on the starting_with
3444
 
            # patterns.
3445
2730
            suite = test_suite(keep_only, starting_with)
3446
2731
        else:
3447
2732
            suite = test_suite_factory()
3448
 
        if starting_with:
3449
 
            # But always filter as requested.
3450
 
            suite = filter_suite_by_id_startswith(suite, starting_with)
3451
 
        result_decorators = []
3452
 
        if lsprof_tests:
3453
 
            result_decorators.append(ProfileResult)
3454
2733
        return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3455
2734
                     stop_on_failure=stop_on_failure,
3456
2735
                     transport=transport,
3462
2741
                     exclude_pattern=exclude_pattern,
3463
2742
                     strict=strict,
3464
2743
                     runner_class=runner_class,
3465
 
                     suite_decorators=suite_decorators,
3466
 
                     stream=stream,
3467
 
                     result_decorators=result_decorators,
3468
2744
                     )
3469
2745
    finally:
3470
2746
        default_transport = old_transport
3618
2894
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3619
2895
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3620
2896
 
3621
 
# Obvious highest levels prefixes, feel free to add your own via a plugin
 
2897
# Obvious higest levels prefixes, feel free to add your own via a plugin
3622
2898
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3623
2899
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3624
2900
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3626
2902
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3627
2903
 
3628
2904
 
3629
 
def _test_suite_testmod_names():
3630
 
    """Return the standard list of test module names to test."""
3631
 
    return [
3632
 
        'bzrlib.doc',
3633
 
        'bzrlib.tests.blackbox',
3634
 
        'bzrlib.tests.commands',
3635
 
        'bzrlib.tests.per_branch',
3636
 
        'bzrlib.tests.per_bzrdir',
3637
 
        'bzrlib.tests.per_bzrdir_colo',
3638
 
        'bzrlib.tests.per_foreign_vcs',
3639
 
        'bzrlib.tests.per_interrepository',
3640
 
        'bzrlib.tests.per_intertree',
3641
 
        'bzrlib.tests.per_inventory',
3642
 
        'bzrlib.tests.per_interbranch',
3643
 
        'bzrlib.tests.per_lock',
3644
 
        'bzrlib.tests.per_merger',
3645
 
        'bzrlib.tests.per_transport',
3646
 
        'bzrlib.tests.per_tree',
3647
 
        'bzrlib.tests.per_pack_repository',
3648
 
        'bzrlib.tests.per_repository',
3649
 
        'bzrlib.tests.per_repository_chk',
3650
 
        'bzrlib.tests.per_repository_reference',
3651
 
        'bzrlib.tests.per_uifactory',
3652
 
        'bzrlib.tests.per_versionedfile',
3653
 
        'bzrlib.tests.per_workingtree',
3654
 
        'bzrlib.tests.test__annotator',
3655
 
        'bzrlib.tests.test__bencode',
3656
 
        'bzrlib.tests.test__chk_map',
3657
 
        'bzrlib.tests.test__dirstate_helpers',
3658
 
        'bzrlib.tests.test__groupcompress',
3659
 
        'bzrlib.tests.test__known_graph',
3660
 
        'bzrlib.tests.test__rio',
3661
 
        'bzrlib.tests.test__simple_set',
3662
 
        'bzrlib.tests.test__static_tuple',
3663
 
        'bzrlib.tests.test__walkdirs_win32',
3664
 
        'bzrlib.tests.test_ancestry',
3665
 
        'bzrlib.tests.test_annotate',
3666
 
        'bzrlib.tests.test_api',
3667
 
        'bzrlib.tests.test_atomicfile',
3668
 
        'bzrlib.tests.test_bad_files',
3669
 
        'bzrlib.tests.test_bisect_multi',
3670
 
        'bzrlib.tests.test_branch',
3671
 
        'bzrlib.tests.test_branchbuilder',
3672
 
        'bzrlib.tests.test_btree_index',
3673
 
        'bzrlib.tests.test_bugtracker',
3674
 
        'bzrlib.tests.test_bundle',
3675
 
        'bzrlib.tests.test_bzrdir',
3676
 
        'bzrlib.tests.test__chunks_to_lines',
3677
 
        'bzrlib.tests.test_cache_utf8',
3678
 
        'bzrlib.tests.test_chk_map',
3679
 
        'bzrlib.tests.test_chk_serializer',
3680
 
        'bzrlib.tests.test_chunk_writer',
3681
 
        'bzrlib.tests.test_clean_tree',
3682
 
        'bzrlib.tests.test_cleanup',
3683
 
        'bzrlib.tests.test_cmdline',
3684
 
        'bzrlib.tests.test_commands',
3685
 
        'bzrlib.tests.test_commit',
3686
 
        'bzrlib.tests.test_commit_merge',
3687
 
        'bzrlib.tests.test_config',
3688
 
        'bzrlib.tests.test_conflicts',
3689
 
        'bzrlib.tests.test_counted_lock',
3690
 
        'bzrlib.tests.test_crash',
3691
 
        'bzrlib.tests.test_decorators',
3692
 
        'bzrlib.tests.test_delta',
3693
 
        'bzrlib.tests.test_debug',
3694
 
        'bzrlib.tests.test_deprecated_graph',
3695
 
        'bzrlib.tests.test_diff',
3696
 
        'bzrlib.tests.test_directory_service',
3697
 
        'bzrlib.tests.test_dirstate',
3698
 
        'bzrlib.tests.test_email_message',
3699
 
        'bzrlib.tests.test_eol_filters',
3700
 
        'bzrlib.tests.test_errors',
3701
 
        'bzrlib.tests.test_export',
3702
 
        'bzrlib.tests.test_extract',
3703
 
        'bzrlib.tests.test_fetch',
3704
 
        'bzrlib.tests.test_fifo_cache',
3705
 
        'bzrlib.tests.test_filters',
3706
 
        'bzrlib.tests.test_ftp_transport',
3707
 
        'bzrlib.tests.test_foreign',
3708
 
        'bzrlib.tests.test_generate_docs',
3709
 
        'bzrlib.tests.test_generate_ids',
3710
 
        'bzrlib.tests.test_globbing',
3711
 
        'bzrlib.tests.test_gpg',
3712
 
        'bzrlib.tests.test_graph',
3713
 
        'bzrlib.tests.test_groupcompress',
3714
 
        'bzrlib.tests.test_hashcache',
3715
 
        'bzrlib.tests.test_help',
3716
 
        'bzrlib.tests.test_hooks',
3717
 
        'bzrlib.tests.test_http',
3718
 
        'bzrlib.tests.test_http_response',
3719
 
        'bzrlib.tests.test_https_ca_bundle',
3720
 
        'bzrlib.tests.test_identitymap',
3721
 
        'bzrlib.tests.test_ignores',
3722
 
        'bzrlib.tests.test_index',
3723
 
        'bzrlib.tests.test_import_tariff',
3724
 
        'bzrlib.tests.test_info',
3725
 
        'bzrlib.tests.test_inv',
3726
 
        'bzrlib.tests.test_inventory_delta',
3727
 
        'bzrlib.tests.test_knit',
3728
 
        'bzrlib.tests.test_lazy_import',
3729
 
        'bzrlib.tests.test_lazy_regex',
3730
 
        'bzrlib.tests.test_lock',
3731
 
        'bzrlib.tests.test_lockable_files',
3732
 
        'bzrlib.tests.test_lockdir',
3733
 
        'bzrlib.tests.test_log',
3734
 
        'bzrlib.tests.test_lru_cache',
3735
 
        'bzrlib.tests.test_lsprof',
3736
 
        'bzrlib.tests.test_mail_client',
3737
 
        'bzrlib.tests.test_matchers',
3738
 
        'bzrlib.tests.test_memorytree',
3739
 
        'bzrlib.tests.test_merge',
3740
 
        'bzrlib.tests.test_merge3',
3741
 
        'bzrlib.tests.test_merge_core',
3742
 
        'bzrlib.tests.test_merge_directive',
3743
 
        'bzrlib.tests.test_missing',
3744
 
        'bzrlib.tests.test_msgeditor',
3745
 
        'bzrlib.tests.test_multiparent',
3746
 
        'bzrlib.tests.test_mutabletree',
3747
 
        'bzrlib.tests.test_nonascii',
3748
 
        'bzrlib.tests.test_options',
3749
 
        'bzrlib.tests.test_osutils',
3750
 
        'bzrlib.tests.test_osutils_encodings',
3751
 
        'bzrlib.tests.test_pack',
3752
 
        'bzrlib.tests.test_patch',
3753
 
        'bzrlib.tests.test_patches',
3754
 
        'bzrlib.tests.test_permissions',
3755
 
        'bzrlib.tests.test_plugins',
3756
 
        'bzrlib.tests.test_progress',
3757
 
        'bzrlib.tests.test_read_bundle',
3758
 
        'bzrlib.tests.test_reconcile',
3759
 
        'bzrlib.tests.test_reconfigure',
3760
 
        'bzrlib.tests.test_registry',
3761
 
        'bzrlib.tests.test_remote',
3762
 
        'bzrlib.tests.test_rename_map',
3763
 
        'bzrlib.tests.test_repository',
3764
 
        'bzrlib.tests.test_revert',
3765
 
        'bzrlib.tests.test_revision',
3766
 
        'bzrlib.tests.test_revisionspec',
3767
 
        'bzrlib.tests.test_revisiontree',
3768
 
        'bzrlib.tests.test_rio',
3769
 
        'bzrlib.tests.test_rules',
3770
 
        'bzrlib.tests.test_sampler',
3771
 
        'bzrlib.tests.test_script',
3772
 
        'bzrlib.tests.test_selftest',
3773
 
        'bzrlib.tests.test_serializer',
3774
 
        'bzrlib.tests.test_setup',
3775
 
        'bzrlib.tests.test_sftp_transport',
3776
 
        'bzrlib.tests.test_shelf',
3777
 
        'bzrlib.tests.test_shelf_ui',
3778
 
        'bzrlib.tests.test_smart',
3779
 
        'bzrlib.tests.test_smart_add',
3780
 
        'bzrlib.tests.test_smart_request',
3781
 
        'bzrlib.tests.test_smart_transport',
3782
 
        'bzrlib.tests.test_smtp_connection',
3783
 
        'bzrlib.tests.test_source',
3784
 
        'bzrlib.tests.test_ssh_transport',
3785
 
        'bzrlib.tests.test_status',
3786
 
        'bzrlib.tests.test_store',
3787
 
        'bzrlib.tests.test_strace',
3788
 
        'bzrlib.tests.test_subsume',
3789
 
        'bzrlib.tests.test_switch',
3790
 
        'bzrlib.tests.test_symbol_versioning',
3791
 
        'bzrlib.tests.test_tag',
3792
 
        'bzrlib.tests.test_testament',
3793
 
        'bzrlib.tests.test_textfile',
3794
 
        'bzrlib.tests.test_textmerge',
3795
 
        'bzrlib.tests.test_timestamp',
3796
 
        'bzrlib.tests.test_trace',
3797
 
        'bzrlib.tests.test_transactions',
3798
 
        'bzrlib.tests.test_transform',
3799
 
        'bzrlib.tests.test_transport',
3800
 
        'bzrlib.tests.test_transport_log',
3801
 
        'bzrlib.tests.test_tree',
3802
 
        'bzrlib.tests.test_treebuilder',
3803
 
        'bzrlib.tests.test_tsort',
3804
 
        'bzrlib.tests.test_tuned_gzip',
3805
 
        'bzrlib.tests.test_ui',
3806
 
        'bzrlib.tests.test_uncommit',
3807
 
        'bzrlib.tests.test_upgrade',
3808
 
        'bzrlib.tests.test_upgrade_stacked',
3809
 
        'bzrlib.tests.test_urlutils',
3810
 
        'bzrlib.tests.test_version',
3811
 
        'bzrlib.tests.test_version_info',
3812
 
        'bzrlib.tests.test_weave',
3813
 
        'bzrlib.tests.test_whitebox',
3814
 
        'bzrlib.tests.test_win32utils',
3815
 
        'bzrlib.tests.test_workingtree',
3816
 
        'bzrlib.tests.test_workingtree_4',
3817
 
        'bzrlib.tests.test_wsgi',
3818
 
        'bzrlib.tests.test_xml',
3819
 
        ]
3820
 
 
3821
 
 
3822
 
def _test_suite_modules_to_doctest():
3823
 
    """Return the list of modules to doctest."""
3824
 
    if __doc__ is None:
3825
 
        # GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3826
 
        return []
3827
 
    return [
3828
 
        'bzrlib',
3829
 
        'bzrlib.branchbuilder',
3830
 
        'bzrlib.decorators',
3831
 
        'bzrlib.export',
3832
 
        'bzrlib.inventory',
3833
 
        'bzrlib.iterablefile',
3834
 
        'bzrlib.lockdir',
3835
 
        'bzrlib.merge3',
3836
 
        'bzrlib.option',
3837
 
        'bzrlib.symbol_versioning',
3838
 
        'bzrlib.tests',
3839
 
        'bzrlib.timestamp',
3840
 
        'bzrlib.version_info_formats.format_custom',
3841
 
        ]
3842
 
 
3843
 
 
3844
2905
def test_suite(keep_only=None, starting_with=None):
3845
2906
    """Build and return TestSuite for the whole of bzrlib.
3846
2907
 
3852
2913
    This function can be replaced if you need to change the default test
3853
2914
    suite on a global basis, but it is not encouraged.
3854
2915
    """
 
2916
    testmod_names = [
 
2917
                   'bzrlib.doc',
 
2918
                   'bzrlib.tests.blackbox',
 
2919
                   'bzrlib.tests.branch_implementations',
 
2920
                   'bzrlib.tests.bzrdir_implementations',
 
2921
                   'bzrlib.tests.commands',
 
2922
                   'bzrlib.tests.interrepository_implementations',
 
2923
                   'bzrlib.tests.intertree_implementations',
 
2924
                   'bzrlib.tests.inventory_implementations',
 
2925
                   'bzrlib.tests.per_interbranch',
 
2926
                   'bzrlib.tests.per_lock',
 
2927
                   'bzrlib.tests.per_repository',
 
2928
                   'bzrlib.tests.per_repository_reference',
 
2929
                   'bzrlib.tests.test__dirstate_helpers',
 
2930
                   'bzrlib.tests.test__walkdirs_win32',
 
2931
                   'bzrlib.tests.test_ancestry',
 
2932
                   'bzrlib.tests.test_annotate',
 
2933
                   'bzrlib.tests.test_api',
 
2934
                   'bzrlib.tests.test_atomicfile',
 
2935
                   'bzrlib.tests.test_bad_files',
 
2936
                   'bzrlib.tests.test_bisect_multi',
 
2937
                   'bzrlib.tests.test_branch',
 
2938
                   'bzrlib.tests.test_branchbuilder',
 
2939
                   'bzrlib.tests.test_btree_index',
 
2940
                   'bzrlib.tests.test_bugtracker',
 
2941
                   'bzrlib.tests.test_bundle',
 
2942
                   'bzrlib.tests.test_bzrdir',
 
2943
                   'bzrlib.tests.test_cache_utf8',
 
2944
                   'bzrlib.tests.test_clean_tree',
 
2945
                   'bzrlib.tests.test_chunk_writer',
 
2946
                   'bzrlib.tests.test__chunks_to_lines',
 
2947
                   'bzrlib.tests.test_commands',
 
2948
                   'bzrlib.tests.test_commit',
 
2949
                   'bzrlib.tests.test_commit_merge',
 
2950
                   'bzrlib.tests.test_config',
 
2951
                   'bzrlib.tests.test_conflicts',
 
2952
                   'bzrlib.tests.test_counted_lock',
 
2953
                   'bzrlib.tests.test_decorators',
 
2954
                   'bzrlib.tests.test_delta',
 
2955
                   'bzrlib.tests.test_debug',
 
2956
                   'bzrlib.tests.test_deprecated_graph',
 
2957
                   'bzrlib.tests.test_diff',
 
2958
                   'bzrlib.tests.test_directory_service',
 
2959
                   'bzrlib.tests.test_dirstate',
 
2960
                   'bzrlib.tests.test_email_message',
 
2961
                   'bzrlib.tests.test_errors',
 
2962
                   'bzrlib.tests.test_export',
 
2963
                   'bzrlib.tests.test_extract',
 
2964
                   'bzrlib.tests.test_fetch',
 
2965
                   'bzrlib.tests.test_fifo_cache',
 
2966
                   'bzrlib.tests.test_filters',
 
2967
                   'bzrlib.tests.test_ftp_transport',
 
2968
                   'bzrlib.tests.test_foreign',
 
2969
                   'bzrlib.tests.test_generate_docs',
 
2970
                   'bzrlib.tests.test_generate_ids',
 
2971
                   'bzrlib.tests.test_globbing',
 
2972
                   'bzrlib.tests.test_gpg',
 
2973
                   'bzrlib.tests.test_graph',
 
2974
                   'bzrlib.tests.test_hashcache',
 
2975
                   'bzrlib.tests.test_help',
 
2976
                   'bzrlib.tests.test_hooks',
 
2977
                   'bzrlib.tests.test_http',
 
2978
                   'bzrlib.tests.test_http_implementations',
 
2979
                   'bzrlib.tests.test_http_response',
 
2980
                   'bzrlib.tests.test_https_ca_bundle',
 
2981
                   'bzrlib.tests.test_identitymap',
 
2982
                   'bzrlib.tests.test_ignores',
 
2983
                   'bzrlib.tests.test_index',
 
2984
                   'bzrlib.tests.test_info',
 
2985
                   'bzrlib.tests.test_inv',
 
2986
                   'bzrlib.tests.test_knit',
 
2987
                   'bzrlib.tests.test_lazy_import',
 
2988
                   'bzrlib.tests.test_lazy_regex',
 
2989
                   'bzrlib.tests.test_lockable_files',
 
2990
                   'bzrlib.tests.test_lockdir',
 
2991
                   'bzrlib.tests.test_log',
 
2992
                   'bzrlib.tests.test_lru_cache',
 
2993
                   'bzrlib.tests.test_lsprof',
 
2994
                   'bzrlib.tests.test_mail_client',
 
2995
                   'bzrlib.tests.test_memorytree',
 
2996
                   'bzrlib.tests.test_merge',
 
2997
                   'bzrlib.tests.test_merge3',
 
2998
                   'bzrlib.tests.test_merge_core',
 
2999
                   'bzrlib.tests.test_merge_directive',
 
3000
                   'bzrlib.tests.test_missing',
 
3001
                   'bzrlib.tests.test_msgeditor',
 
3002
                   'bzrlib.tests.test_multiparent',
 
3003
                   'bzrlib.tests.test_mutabletree',
 
3004
                   'bzrlib.tests.test_nonascii',
 
3005
                   'bzrlib.tests.test_options',
 
3006
                   'bzrlib.tests.test_osutils',
 
3007
                   'bzrlib.tests.test_osutils_encodings',
 
3008
                   'bzrlib.tests.test_pack',
 
3009
                   'bzrlib.tests.test_pack_repository',
 
3010
                   'bzrlib.tests.test_patch',
 
3011
                   'bzrlib.tests.test_patches',
 
3012
                   'bzrlib.tests.test_permissions',
 
3013
                   'bzrlib.tests.test_plugins',
 
3014
                   'bzrlib.tests.test_progress',
 
3015
                   'bzrlib.tests.test_read_bundle',
 
3016
                   'bzrlib.tests.test_reconcile',
 
3017
                   'bzrlib.tests.test_reconfigure',
 
3018
                   'bzrlib.tests.test_registry',
 
3019
                   'bzrlib.tests.test_remote',
 
3020
                   'bzrlib.tests.test_repository',
 
3021
                   'bzrlib.tests.test_revert',
 
3022
                   'bzrlib.tests.test_revision',
 
3023
                   'bzrlib.tests.test_revisionspec',
 
3024
                   'bzrlib.tests.test_revisiontree',
 
3025
                   'bzrlib.tests.test_rio',
 
3026
                   'bzrlib.tests.test_rules',
 
3027
                   'bzrlib.tests.test_sampler',
 
3028
                   'bzrlib.tests.test_selftest',
 
3029
                   'bzrlib.tests.test_setup',
 
3030
                   'bzrlib.tests.test_sftp_transport',
 
3031
                   'bzrlib.tests.test_shelf',
 
3032
                   'bzrlib.tests.test_shelf_ui',
 
3033
                   'bzrlib.tests.test_smart',
 
3034
                   'bzrlib.tests.test_smart_add',
 
3035
                   'bzrlib.tests.test_smart_request',
 
3036
                   'bzrlib.tests.test_smart_transport',
 
3037
                   'bzrlib.tests.test_smtp_connection',
 
3038
                   'bzrlib.tests.test_source',
 
3039
                   'bzrlib.tests.test_ssh_transport',
 
3040
                   'bzrlib.tests.test_status',
 
3041
                   'bzrlib.tests.test_store',
 
3042
                   'bzrlib.tests.test_strace',
 
3043
                   'bzrlib.tests.test_subsume',
 
3044
                   'bzrlib.tests.test_switch',
 
3045
                   'bzrlib.tests.test_symbol_versioning',
 
3046
                   'bzrlib.tests.test_tag',
 
3047
                   'bzrlib.tests.test_testament',
 
3048
                   'bzrlib.tests.test_textfile',
 
3049
                   'bzrlib.tests.test_textmerge',
 
3050
                   'bzrlib.tests.test_timestamp',
 
3051
                   'bzrlib.tests.test_trace',
 
3052
                   'bzrlib.tests.test_transactions',
 
3053
                   'bzrlib.tests.test_transform',
 
3054
                   'bzrlib.tests.test_transport',
 
3055
                   'bzrlib.tests.test_transport_implementations',
 
3056
                   'bzrlib.tests.test_transport_log',
 
3057
                   'bzrlib.tests.test_tree',
 
3058
                   'bzrlib.tests.test_treebuilder',
 
3059
                   'bzrlib.tests.test_tsort',
 
3060
                   'bzrlib.tests.test_tuned_gzip',
 
3061
                   'bzrlib.tests.test_ui',
 
3062
                   'bzrlib.tests.test_uncommit',
 
3063
                   'bzrlib.tests.test_upgrade',
 
3064
                   'bzrlib.tests.test_upgrade_stacked',
 
3065
                   'bzrlib.tests.test_urlutils',
 
3066
                   'bzrlib.tests.test_version',
 
3067
                   'bzrlib.tests.test_version_info',
 
3068
                   'bzrlib.tests.test_versionedfile',
 
3069
                   'bzrlib.tests.test_weave',
 
3070
                   'bzrlib.tests.test_whitebox',
 
3071
                   'bzrlib.tests.test_win32utils',
 
3072
                   'bzrlib.tests.test_workingtree',
 
3073
                   'bzrlib.tests.test_workingtree_4',
 
3074
                   'bzrlib.tests.test_wsgi',
 
3075
                   'bzrlib.tests.test_xml',
 
3076
                   'bzrlib.tests.tree_implementations',
 
3077
                   'bzrlib.tests.workingtree_implementations',
 
3078
                   'bzrlib.util.tests.test_bencode',
 
3079
                   ]
3855
3080
 
3856
3081
    loader = TestUtil.TestLoader()
3857
3082
 
3858
 
    if keep_only is not None:
3859
 
        id_filter = TestIdList(keep_only)
3860
3083
    if starting_with:
 
3084
        starting_with = [test_prefix_alias_registry.resolve_alias(start)
 
3085
                         for start in starting_with]
3861
3086
        # We take precedence over keep_only because *at loading time* using
3862
3087
        # both options means we will load less tests for the same final result.
3863
3088
        def interesting_module(name):
3873
3098
        loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3874
3099
 
3875
3100
    elif keep_only is not None:
 
3101
        id_filter = TestIdList(keep_only)
3876
3102
        loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3877
3103
        def interesting_module(name):
3878
3104
            return id_filter.refers_to(name)
3886
3112
    suite = loader.suiteClass()
3887
3113
 
3888
3114
    # modules building their suite with loadTestsFromModuleNames
3889
 
    suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3890
 
 
3891
 
    for mod in _test_suite_modules_to_doctest():
 
3115
    suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
 
3116
 
 
3117
    modules_to_doctest = [
 
3118
        'bzrlib',
 
3119
        'bzrlib.branchbuilder',
 
3120
        'bzrlib.export',
 
3121
        'bzrlib.inventory',
 
3122
        'bzrlib.iterablefile',
 
3123
        'bzrlib.lockdir',
 
3124
        'bzrlib.merge3',
 
3125
        'bzrlib.option',
 
3126
        'bzrlib.symbol_versioning',
 
3127
        'bzrlib.tests',
 
3128
        'bzrlib.timestamp',
 
3129
        'bzrlib.version_info_formats.format_custom',
 
3130
        ]
 
3131
 
 
3132
    for mod in modules_to_doctest:
3892
3133
        if not interesting_module(mod):
3893
3134
            # No tests to keep here, move along
3894
3135
            continue
3923
3164
            reload(sys)
3924
3165
            sys.setdefaultencoding(default_encoding)
3925
3166
 
 
3167
    if starting_with:
 
3168
        suite = filter_suite_by_id_startswith(suite, starting_with)
 
3169
 
3926
3170
    if keep_only is not None:
3927
3171
        # Now that the referred modules have loaded their tests, keep only the
3928
3172
        # requested ones.
3977
3221
    the scenario name at the end of its id(), and updating the test object's
3978
3222
    __dict__ with the scenario_param_dict.
3979
3223
 
3980
 
    >>> import bzrlib.tests.test_sampler
3981
3224
    >>> r = multiply_tests(
3982
3225
    ...     bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3983
3226
    ...     [('one', dict(param=1)),
4035
3278
    :param new_id: The id to assign to it.
4036
3279
    :return: The new test.
4037
3280
    """
4038
 
    new_test = copy(test)
 
3281
    from copy import deepcopy
 
3282
    new_test = deepcopy(test)
4039
3283
    new_test.id = lambda: new_id
4040
3284
    return new_test
4041
3285
 
4042
3286
 
4043
 
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4044
 
                                ext_module_name):
4045
 
    """Helper for permutating tests against an extension module.
4046
 
 
4047
 
    This is meant to be used inside a modules 'load_tests()' function. It will
4048
 
    create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4049
 
    against both implementations. Setting 'test.module' to the appropriate
4050
 
    module. See bzrlib.tests.test__chk_map.load_tests as an example.
4051
 
 
4052
 
    :param standard_tests: A test suite to permute
4053
 
    :param loader: A TestLoader
4054
 
    :param py_module_name: The python path to a python module that can always
4055
 
        be loaded, and will be considered the 'python' implementation. (eg
4056
 
        'bzrlib._chk_map_py')
4057
 
    :param ext_module_name: The python path to an extension module. If the
4058
 
        module cannot be loaded, a single test will be added, which notes that
4059
 
        the module is not available. If it can be loaded, all standard_tests
4060
 
        will be run against that module.
4061
 
    :return: (suite, feature) suite is a test-suite that has all the permuted
4062
 
        tests. feature is the Feature object that can be used to determine if
4063
 
        the module is available.
4064
 
    """
4065
 
 
4066
 
    py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4067
 
    scenarios = [
4068
 
        ('python', {'module': py_module}),
4069
 
    ]
4070
 
    suite = loader.suiteClass()
4071
 
    feature = ModuleAvailableFeature(ext_module_name)
4072
 
    if feature.available():
4073
 
        scenarios.append(('C', {'module': feature.module}))
4074
 
    else:
4075
 
        # the compiled module isn't available, so we add a failing test
4076
 
        class FailWithoutFeature(TestCase):
4077
 
            def test_fail(self):
4078
 
                self.requireFeature(feature)
4079
 
        suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4080
 
    result = multiply_tests(standard_tests, scenarios, suite)
4081
 
    return result, feature
4082
 
 
4083
 
 
4084
 
def _rmtree_temp_dir(dirname, test_id=None):
 
3287
def _rmtree_temp_dir(dirname):
4085
3288
    # If LANG=C we probably have created some bogus paths
4086
3289
    # which rmtree(unicode) will fail to delete
4087
3290
    # so make sure we are using rmtree(str) to delete everything
4096
3299
    try:
4097
3300
        osutils.rmtree(dirname)
4098
3301
    except OSError, e:
4099
 
        # We don't want to fail here because some useful display will be lost
4100
 
        # otherwise. Polluting the tmp dir is bad, but not giving all the
4101
 
        # possible info to the test runner is even worse.
4102
 
        if test_id != None:
4103
 
            ui.ui_factory.clear_term()
4104
 
            sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4105
 
        sys.stderr.write('Unable to remove testing dir %s\n%s'
4106
 
                         % (os.path.basename(dirname), e))
 
3302
        if sys.platform == 'win32' and e.errno == errno.EACCES:
 
3303
            sys.stderr.write(('Permission denied: '
 
3304
                                 'unable to remove testing dir '
 
3305
                                 '%s\n' % os.path.basename(dirname)))
 
3306
        else:
 
3307
            raise
4107
3308
 
4108
3309
 
4109
3310
class Feature(object):
4191
3392
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4192
3393
 
4193
3394
 
4194
 
class _CompatabilityThunkFeature(Feature):
4195
 
    """This feature is just a thunk to another feature.
4196
 
 
4197
 
    It issues a deprecation warning if it is accessed, to let you know that you
4198
 
    should really use a different feature.
4199
 
    """
4200
 
 
4201
 
    def __init__(self, dep_version, module, name,
4202
 
                 replacement_name, replacement_module=None):
4203
 
        super(_CompatabilityThunkFeature, self).__init__()
4204
 
        self._module = module
4205
 
        if replacement_module is None:
4206
 
            replacement_module = module
4207
 
        self._replacement_module = replacement_module
4208
 
        self._name = name
4209
 
        self._replacement_name = replacement_name
4210
 
        self._dep_version = dep_version
4211
 
        self._feature = None
4212
 
 
4213
 
    def _ensure(self):
4214
 
        if self._feature is None:
4215
 
            depr_msg = self._dep_version % ('%s.%s'
4216
 
                                            % (self._module, self._name))
4217
 
            use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4218
 
                                               self._replacement_name)
4219
 
            symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4220
 
            # Import the new feature and use it as a replacement for the
4221
 
            # deprecated one.
4222
 
            mod = __import__(self._replacement_module, {}, {},
4223
 
                             [self._replacement_name])
4224
 
            self._feature = getattr(mod, self._replacement_name)
4225
 
 
4226
 
    def _probe(self):
4227
 
        self._ensure()
4228
 
        return self._feature._probe()
4229
 
 
4230
 
 
4231
 
class ModuleAvailableFeature(Feature):
4232
 
    """This is a feature than describes a module we want to be available.
4233
 
 
4234
 
    Declare the name of the module in __init__(), and then after probing, the
4235
 
    module will be available as 'self.module'.
4236
 
 
4237
 
    :ivar module: The module if it is available, else None.
4238
 
    """
4239
 
 
4240
 
    def __init__(self, module_name):
4241
 
        super(ModuleAvailableFeature, self).__init__()
4242
 
        self.module_name = module_name
4243
 
 
4244
 
    def _probe(self):
4245
 
        try:
4246
 
            self._module = __import__(self.module_name, {}, {}, [''])
4247
 
            return True
4248
 
        except ImportError:
4249
 
            return False
4250
 
 
4251
 
    @property
4252
 
    def module(self):
4253
 
        if self.available(): # Make sure the probe has been done
4254
 
            return self._module
4255
 
        return None
4256
 
 
4257
 
    def feature_name(self):
4258
 
        return self.module_name
4259
 
 
4260
 
 
4261
 
# This is kept here for compatibility, it is recommended to use
4262
 
# 'bzrlib.tests.feature.paramiko' instead
4263
 
ParamikoFeature = _CompatabilityThunkFeature(
4264
 
    deprecated_in((2,1,0)),
4265
 
    'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4266
 
 
4267
 
 
4268
3395
def probe_unicode_in_user_encoding():
4269
3396
    """Try to encode several unicode strings to use in unicode-aware tests.
4270
3397
    Return first successfull match.
4350
3477
UTF8Filesystem = _UTF8Filesystem()
4351
3478
 
4352
3479
 
4353
 
class _BreakinFeature(Feature):
4354
 
    """Does this platform support the breakin feature?"""
4355
 
 
4356
 
    def _probe(self):
4357
 
        from bzrlib import breakin
4358
 
        if breakin.determine_signal() is None:
4359
 
            return False
4360
 
        if sys.platform == 'win32':
4361
 
            # Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4362
 
            # We trigger SIGBREAK via a Console api so we need ctypes to
4363
 
            # access the function
4364
 
            try:
4365
 
                import ctypes
4366
 
            except OSError:
4367
 
                return False
4368
 
        return True
4369
 
 
4370
 
    def feature_name(self):
4371
 
        return "SIGQUIT or SIGBREAK w/ctypes on win32"
4372
 
 
4373
 
 
4374
 
BreakinFeature = _BreakinFeature()
4375
 
 
4376
 
 
4377
3480
class _CaseInsCasePresFilenameFeature(Feature):
4378
3481
    """Is the file-system case insensitive, but case-preserving?"""
4379
3482
 
4429
3532
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4430
3533
 
4431
3534
 
4432
 
class _CaseSensitiveFilesystemFeature(Feature):
 
3535
class _SubUnitFeature(Feature):
 
3536
    """Check if subunit is available."""
4433
3537
 
4434
3538
    def _probe(self):
4435
 
        if CaseInsCasePresFilenameFeature.available():
4436
 
            return False
4437
 
        elif CaseInsensitiveFilesystemFeature.available():
4438
 
            return False
4439
 
        else:
 
3539
        try:
 
3540
            import subunit
4440
3541
            return True
 
3542
        except ImportError:
 
3543
            return False
4441
3544
 
4442
3545
    def feature_name(self):
4443
 
        return 'case-sensitive filesystem'
4444
 
 
4445
 
# new coding style is for feature instances to be lowercase
4446
 
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4447
 
 
4448
 
 
4449
 
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4450
 
SubUnitFeature = _CompatabilityThunkFeature(
4451
 
    deprecated_in((2,1,0)),
4452
 
    'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
 
3546
        return 'subunit'
 
3547
 
 
3548
SubUnitFeature = _SubUnitFeature()
4453
3549
# Only define SubUnitBzrRunner if subunit is available.
4454
3550
try:
4455
3551
    from subunit import TestProtocolClient
4456
 
    from subunit.test_results import AutoTimingTestResultDecorator
4457
3552
    class SubUnitBzrRunner(TextTestRunner):
4458
3553
        def run(self, test):
4459
 
            result = AutoTimingTestResultDecorator(
4460
 
                TestProtocolClient(self.stream))
 
3554
            # undo out claim for testing which looks like a test start to subunit
 
3555
            self.stream.write("success: %s\n" % (osutils.realpath(sys.argv[0]),))
 
3556
            result = TestProtocolClient(self.stream)
4461
3557
            test.run(result)
4462
3558
            return result
4463
3559
except ImportError:
4464
3560
    pass
4465
 
 
4466
 
class _PosixPermissionsFeature(Feature):
4467
 
 
4468
 
    def _probe(self):
4469
 
        def has_perms():
4470
 
            # create temporary file and check if specified perms are maintained.
4471
 
            import tempfile
4472
 
 
4473
 
            write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4474
 
            f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4475
 
            fd, name = f
4476
 
            os.close(fd)
4477
 
            os.chmod(name, write_perms)
4478
 
 
4479
 
            read_perms = os.stat(name).st_mode & 0777
4480
 
            os.unlink(name)
4481
 
            return (write_perms == read_perms)
4482
 
 
4483
 
        return (os.name == 'posix') and has_perms()
4484
 
 
4485
 
    def feature_name(self):
4486
 
        return 'POSIX permissions support'
4487
 
 
4488
 
posix_permissions_feature = _PosixPermissionsFeature()