~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Aaron Bentley
  • Date: 2007-02-06 14:52:16 UTC
  • mfrom: (2266 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2268.
  • Revision ID: abentley@panoramicfeedback.com-20070206145216-fcpi8o3ufvuzwbp9
Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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
26
26
# general style of bzrlib.  Please continue that consistency when adding e.g.
27
27
# new assertFoo() methods.
28
28
 
29
 
import atexit
30
29
import codecs
31
30
from cStringIO import StringIO
32
31
import difflib
34
33
import errno
35
34
import logging
36
35
import os
37
 
from pprint import pformat
38
 
import random
39
36
import re
40
37
import shlex
41
38
import stat
42
39
from subprocess import Popen, PIPE
43
40
import sys
44
41
import tempfile
45
 
import threading
 
42
import unittest
46
43
import time
47
 
import unittest
48
 
import warnings
49
44
 
50
45
 
51
46
from bzrlib import (
52
 
    branchbuilder,
53
47
    bzrdir,
54
48
    debug,
55
49
    errors,
56
50
    memorytree,
57
51
    osutils,
58
52
    progress,
59
 
    ui,
60
53
    urlutils,
61
 
    workingtree,
62
54
    )
63
55
import bzrlib.branch
64
56
import bzrlib.commands
65
 
import bzrlib.timestamp
 
57
import bzrlib.bundle.serializer
66
58
import bzrlib.export
67
59
import bzrlib.inventory
68
60
import bzrlib.iterablefile
74
66
    pass
75
67
from bzrlib.merge import merge_inner
76
68
import bzrlib.merge3
 
69
import bzrlib.osutils
77
70
import bzrlib.plugin
 
71
from bzrlib.revision import common_ancestor
78
72
import bzrlib.store
79
73
from bzrlib import symbol_versioning
80
 
from bzrlib.symbol_versioning import (
81
 
    DEPRECATED_PARAMETER,
82
 
    deprecated_function,
83
 
    deprecated_method,
84
 
    deprecated_passed,
85
 
    )
86
74
import bzrlib.trace
87
75
from bzrlib.transport import get_transport
88
76
import bzrlib.transport
91
79
from bzrlib.transport.readonly import ReadonlyServer
92
80
from bzrlib.trace import mutter, note
93
81
from bzrlib.tests import TestUtil
94
 
from bzrlib.tests.http_server import HttpServer
 
82
from bzrlib.tests.HttpServer import HttpServer
95
83
from bzrlib.tests.TestUtil import (
96
84
                          TestSuite,
97
85
                          TestLoader,
98
86
                          )
99
87
from bzrlib.tests.treeshape import build_tree_contents
100
 
import bzrlib.version_info_formats.format_custom
101
88
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
102
89
 
103
 
# Mark this python module as being part of the implementation
104
 
# of unittest: this gives us better tracebacks where the last
105
 
# shown frame is the test code, not our assertXYZ.
106
 
__unittest = 1
107
 
 
108
90
default_transport = LocalURLServer
109
91
 
 
92
MODULES_TO_TEST = []
 
93
MODULES_TO_DOCTEST = [
 
94
                      bzrlib.bundle.serializer,
 
95
                      bzrlib.errors,
 
96
                      bzrlib.export,
 
97
                      bzrlib.inventory,
 
98
                      bzrlib.iterablefile,
 
99
                      bzrlib.lockdir,
 
100
                      bzrlib.merge3,
 
101
                      bzrlib.option,
 
102
                      bzrlib.store,
 
103
                      ]
 
104
 
 
105
 
 
106
def packages_to_test():
 
107
    """Return a list of packages to test.
 
108
 
 
109
    The packages are not globally imported so that import failures are
 
110
    triggered when running selftest, not when importing the command.
 
111
    """
 
112
    import bzrlib.doc
 
113
    import bzrlib.tests.blackbox
 
114
    import bzrlib.tests.branch_implementations
 
115
    import bzrlib.tests.bzrdir_implementations
 
116
    import bzrlib.tests.interrepository_implementations
 
117
    import bzrlib.tests.interversionedfile_implementations
 
118
    import bzrlib.tests.intertree_implementations
 
119
    import bzrlib.tests.repository_implementations
 
120
    import bzrlib.tests.revisionstore_implementations
 
121
    import bzrlib.tests.tree_implementations
 
122
    import bzrlib.tests.workingtree_implementations
 
123
    return [
 
124
            bzrlib.doc,
 
125
            bzrlib.tests.blackbox,
 
126
            bzrlib.tests.branch_implementations,
 
127
            bzrlib.tests.bzrdir_implementations,
 
128
            bzrlib.tests.interrepository_implementations,
 
129
            bzrlib.tests.interversionedfile_implementations,
 
130
            bzrlib.tests.intertree_implementations,
 
131
            bzrlib.tests.repository_implementations,
 
132
            bzrlib.tests.revisionstore_implementations,
 
133
            bzrlib.tests.tree_implementations,
 
134
            bzrlib.tests.workingtree_implementations,
 
135
            ]
 
136
 
110
137
 
111
138
class ExtendedTestResult(unittest._TextTestResult):
112
139
    """Accepts, reports and accumulates the results of running tests.
113
140
 
114
 
    Compared to the unittest version this class adds support for
115
 
    profiling, benchmarking, stopping as soon as a test fails,  and
116
 
    skipping tests.  There are further-specialized subclasses for
117
 
    different types of display.
118
 
 
119
 
    When a test finishes, in whatever way, it calls one of the addSuccess,
120
 
    addFailure or addError classes.  These in turn may redirect to a more
121
 
    specific case for the special test results supported by our extended
122
 
    tests.
123
 
 
124
 
    Note that just one of these objects is fed the results from many tests.
 
141
    Compared to this unittest version this class adds support for profiling,
 
142
    benchmarking, stopping as soon as a test fails,  and skipping tests.
 
143
    There are further-specialized subclasses for different types of display.
125
144
    """
126
145
 
127
146
    stop_early = False
151
170
                revision_id = ''
152
171
            bench_history.write("--date %s %s\n" % (time.time(), revision_id))
153
172
        self._bench_history = bench_history
154
 
        self.ui = ui.ui_factory
 
173
        self.ui = bzrlib.ui.ui_factory
155
174
        self.num_tests = num_tests
156
175
        self.error_count = 0
157
176
        self.failure_count = 0
158
 
        self.known_failure_count = 0
159
177
        self.skip_count = 0
160
 
        self.not_applicable_count = 0
161
 
        self.unsupported = {}
162
178
        self.count = 0
163
179
        self._overall_start_time = time.time()
164
180
    
165
 
    def _extractBenchmarkTime(self, testCase):
 
181
    def extractBenchmarkTime(self, testCase):
166
182
        """Add a benchmark time for the current test case."""
167
 
        return getattr(testCase, "_benchtime", None)
 
183
        self._benchmarkTime = getattr(testCase, "_benchtime", None)
168
184
    
169
185
    def _elapsedTestTimeString(self):
170
186
        """Return a time string for the overall time the current test has taken."""
171
187
        return self._formatTime(time.time() - self._start_time)
172
188
 
173
 
    def _testTimeString(self, testCase):
174
 
        benchmark_time = self._extractBenchmarkTime(testCase)
175
 
        if benchmark_time is not None:
 
189
    def _testTimeString(self):
 
190
        if self._benchmarkTime is not None:
176
191
            return "%s/%s" % (
177
 
                self._formatTime(benchmark_time),
 
192
                self._formatTime(self._benchmarkTime),
178
193
                self._elapsedTestTimeString())
179
194
        else:
180
195
            return "           %s" % self._elapsedTestTimeString()
193
208
    def startTest(self, test):
194
209
        unittest.TestResult.startTest(self, test)
195
210
        self.report_test_start(test)
196
 
        test.number = self.count
197
211
        self._recordTestStartTime()
198
212
 
199
213
    def _recordTestStartTime(self):
200
214
        """Record that a test has started."""
201
215
        self._start_time = time.time()
202
216
 
203
 
    def _cleanupLogFile(self, test):
204
 
        # We can only do this if we have one of our TestCases, not if
205
 
        # we have a doctest.
206
 
        setKeepLogfile = getattr(test, 'setKeepLogfile', None)
207
 
        if setKeepLogfile is not None:
208
 
            setKeepLogfile()
209
 
 
210
217
    def addError(self, test, err):
211
 
        """Tell result that test finished with an error.
212
 
 
213
 
        Called from the TestCase run() method when the test
214
 
        fails with an unexpected error.
215
 
        """
216
 
        self._testConcluded(test)
217
218
        if isinstance(err[1], TestSkipped):
218
 
            return self._addSkipped(test, err)
219
 
        elif isinstance(err[1], UnavailableFeature):
220
 
            return self.addNotSupported(test, err[1].args[0])
221
 
        else:
222
 
            unittest.TestResult.addError(self, test, err)
223
 
            self.error_count += 1
224
 
            self.report_error(test, err)
225
 
            if self.stop_early:
226
 
                self.stop()
227
 
            self._cleanupLogFile(test)
 
219
            return self.addSkipped(test, err)    
 
220
        unittest.TestResult.addError(self, test, err)
 
221
        # We can only do this if we have one of our TestCases, not if
 
222
        # we have a doctest.
 
223
        setKeepLogfile = getattr(test, 'setKeepLogfile', None)
 
224
        if setKeepLogfile is not None:
 
225
            setKeepLogfile()
 
226
        self.extractBenchmarkTime(test)
 
227
        self.report_error(test, err)
 
228
        if self.stop_early:
 
229
            self.stop()
228
230
 
229
231
    def addFailure(self, test, err):
230
 
        """Tell result that test failed.
231
 
 
232
 
        Called from the TestCase run() method when the test
233
 
        fails because e.g. an assert() method failed.
234
 
        """
235
 
        self._testConcluded(test)
236
 
        if isinstance(err[1], KnownFailure):
237
 
            return self._addKnownFailure(test, err)
238
 
        else:
239
 
            unittest.TestResult.addFailure(self, test, err)
240
 
            self.failure_count += 1
241
 
            self.report_failure(test, err)
242
 
            if self.stop_early:
243
 
                self.stop()
244
 
            self._cleanupLogFile(test)
 
232
        unittest.TestResult.addFailure(self, test, err)
 
233
        # We can only do this if we have one of our TestCases, not if
 
234
        # we have a doctest.
 
235
        setKeepLogfile = getattr(test, 'setKeepLogfile', None)
 
236
        if setKeepLogfile is not None:
 
237
            setKeepLogfile()
 
238
        self.extractBenchmarkTime(test)
 
239
        self.report_failure(test, err)
 
240
        if self.stop_early:
 
241
            self.stop()
245
242
 
246
243
    def addSuccess(self, test):
247
 
        """Tell result that test completed successfully.
248
 
 
249
 
        Called from the TestCase run()
250
 
        """
251
 
        self._testConcluded(test)
 
244
        self.extractBenchmarkTime(test)
252
245
        if self._bench_history is not None:
253
 
            benchmark_time = self._extractBenchmarkTime(test)
254
 
            if benchmark_time is not None:
 
246
            if self._benchmarkTime is not None:
255
247
                self._bench_history.write("%s %s\n" % (
256
 
                    self._formatTime(benchmark_time),
 
248
                    self._formatTime(self._benchmarkTime),
257
249
                    test.id()))
258
250
        self.report_success(test)
259
 
        self._cleanupLogFile(test)
260
251
        unittest.TestResult.addSuccess(self, test)
261
 
        test._log_contents = ''
262
 
 
263
 
    def _testConcluded(self, test):
264
 
        """Common code when a test has finished.
265
 
 
266
 
        Called regardless of whether it succeded, failed, etc.
267
 
        """
268
 
        pass
269
 
 
270
 
    def _addKnownFailure(self, test, err):
271
 
        self.known_failure_count += 1
272
 
        self.report_known_failure(test, err)
273
 
 
274
 
    def addNotSupported(self, test, feature):
275
 
        """The test will not be run because of a missing feature.
276
 
        """
277
 
        # this can be called in two different ways: it may be that the
278
 
        # test started running, and then raised (through addError) 
279
 
        # UnavailableFeature.  Alternatively this method can be called
280
 
        # while probing for features before running the tests; in that
281
 
        # case we will see startTest and stopTest, but the test will never
282
 
        # actually run.
283
 
        self.unsupported.setdefault(str(feature), 0)
284
 
        self.unsupported[str(feature)] += 1
285
 
        self.report_unsupported(test, feature)
286
 
 
287
 
    def _addSkipped(self, test, skip_excinfo):
288
 
        if isinstance(skip_excinfo[1], TestNotApplicable):
289
 
            self.not_applicable_count += 1
290
 
            self.report_not_applicable(test, skip_excinfo)
291
 
        else:
292
 
            self.skip_count += 1
293
 
            self.report_skip(test, skip_excinfo)
 
252
 
 
253
    def addSkipped(self, test, skip_excinfo):
 
254
        self.extractBenchmarkTime(test)
 
255
        self.report_skip(test, skip_excinfo)
 
256
        # seems best to treat this as success from point-of-view of unittest
 
257
        # -- it actually does nothing so it barely matters :)
294
258
        try:
295
259
            test.tearDown()
296
260
        except KeyboardInterrupt:
297
261
            raise
298
262
        except:
299
 
            self.addError(test, test._exc_info())
 
263
            self.addError(test, test.__exc_info())
300
264
        else:
301
 
            # seems best to treat this as success from point-of-view of unittest
302
 
            # -- it actually does nothing so it barely matters :)
303
265
            unittest.TestResult.addSuccess(self, test)
304
 
            test._log_contents = ''
305
266
 
306
267
    def printErrorList(self, flavour, errors):
307
268
        for test, err in errors:
308
269
            self.stream.writeln(self.separator1)
309
 
            self.stream.write("%s: " % flavour)
310
 
            self.stream.writeln(self.getDescription(test))
 
270
            self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
311
271
            if getattr(test, '_get_log', None) is not None:
312
 
                self.stream.write('\n')
313
 
                self.stream.write(
314
 
                        ('vvvv[log from %s]' % test.id()).ljust(78,'-'))
315
 
                self.stream.write('\n')
316
 
                self.stream.write(test._get_log())
317
 
                self.stream.write('\n')
318
 
                self.stream.write(
319
 
                        ('^^^^[log from %s]' % test.id()).ljust(78,'-'))
320
 
                self.stream.write('\n')
 
272
                print >>self.stream
 
273
                print >>self.stream, \
 
274
                        ('vvvv[log from %s]' % test.id()).ljust(78,'-')
 
275
                print >>self.stream, test._get_log()
 
276
                print >>self.stream, \
 
277
                        ('^^^^[log from %s]' % test.id()).ljust(78,'-')
321
278
            self.stream.writeln(self.separator2)
322
279
            self.stream.writeln("%s" % err)
323
280
 
330
287
    def report_success(self, test):
331
288
        pass
332
289
 
333
 
    def wasStrictlySuccessful(self):
334
 
        if self.unsupported or self.known_failure_count:
335
 
            return False
336
 
        return self.wasSuccessful()
337
 
 
338
290
 
339
291
class TextTestResult(ExtendedTestResult):
340
292
    """Displays progress and results of tests in text form"""
341
293
 
342
 
    def __init__(self, stream, descriptions, verbosity,
343
 
                 bench_history=None,
344
 
                 num_tests=None,
345
 
                 pb=None,
346
 
                 ):
347
 
        ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
348
 
            bench_history, num_tests)
349
 
        if pb is None:
350
 
            self.pb = self.ui.nested_progress_bar()
351
 
            self._supplied_pb = False
352
 
        else:
353
 
            self.pb = pb
354
 
            self._supplied_pb = True
 
294
    def __init__(self, *args, **kw):
 
295
        ExtendedTestResult.__init__(self, *args, **kw)
 
296
        self.pb = self.ui.nested_progress_bar()
355
297
        self.pb.show_pct = False
356
298
        self.pb.show_spinner = False
357
 
        self.pb.show_eta = False,
 
299
        self.pb.show_eta = False, 
358
300
        self.pb.show_count = False
359
301
        self.pb.show_bar = False
360
302
 
362
304
        self.pb.update('[test 0/%d] starting...' % (self.num_tests))
363
305
 
364
306
    def _progress_prefix_text(self):
365
 
        # the longer this text, the less space we have to show the test
366
 
        # name...
367
 
        a = '[%d' % self.count              # total that have been run
368
 
        # tests skipped as known not to be relevant are not important enough
369
 
        # to show here
370
 
        ## if self.skip_count:
371
 
        ##     a += ', %d skip' % self.skip_count
372
 
        ## if self.known_failure_count:
373
 
        ##     a += '+%dX' % self.known_failure_count
 
307
        a = '[%d' % self.count
374
308
        if self.num_tests is not None:
375
309
            a +='/%d' % self.num_tests
376
 
        a += ' in '
377
 
        runtime = time.time() - self._overall_start_time
378
 
        if runtime >= 60:
379
 
            a += '%dm%ds' % (runtime / 60, runtime % 60)
380
 
        else:
381
 
            a += '%ds' % runtime
 
310
        a += ' in %ds' % (time.time() - self._overall_start_time)
382
311
        if self.error_count:
383
 
            a += ', %d err' % self.error_count
 
312
            a += ', %d errors' % self.error_count
384
313
        if self.failure_count:
385
 
            a += ', %d fail' % self.failure_count
386
 
        if self.unsupported:
387
 
            a += ', %d missing' % len(self.unsupported)
 
314
            a += ', %d failed' % self.failure_count
 
315
        if self.skip_count:
 
316
            a += ', %d skipped' % self.skip_count
388
317
        a += ']'
389
318
        return a
390
319
 
395
324
                + ' ' 
396
325
                + self._shortened_test_description(test))
397
326
 
398
 
    def _test_description(self, test):
399
 
        return self._shortened_test_description(test)
400
 
 
401
327
    def report_error(self, test, err):
 
328
        self.error_count += 1
402
329
        self.pb.note('ERROR: %s\n    %s\n', 
403
 
            self._test_description(test),
 
330
            self._shortened_test_description(test),
404
331
            err[1],
405
332
            )
406
333
 
407
334
    def report_failure(self, test, err):
 
335
        self.failure_count += 1
408
336
        self.pb.note('FAIL: %s\n    %s\n', 
409
 
            self._test_description(test),
 
337
            self._shortened_test_description(test),
410
338
            err[1],
411
339
            )
412
340
 
413
 
    def report_known_failure(self, test, err):
414
 
        self.pb.note('XFAIL: %s\n%s\n',
415
 
            self._test_description(test), err[1])
416
 
 
417
341
    def report_skip(self, test, skip_excinfo):
418
 
        pass
419
 
 
420
 
    def report_not_applicable(self, test, skip_excinfo):
421
 
        pass
422
 
 
423
 
    def report_unsupported(self, test, feature):
424
 
        """test cannot be run because feature is missing."""
425
 
                  
 
342
        self.skip_count += 1
 
343
        if False:
 
344
            # at the moment these are mostly not things we can fix
 
345
            # and so they just produce stipple; use the verbose reporter
 
346
            # to see them.
 
347
            if False:
 
348
                # show test and reason for skip
 
349
                self.pb.note('SKIP: %s\n    %s\n', 
 
350
                    self._shortened_test_description(test),
 
351
                    skip_excinfo[1])
 
352
            else:
 
353
                # since the class name was left behind in the still-visible
 
354
                # progress bar...
 
355
                self.pb.note('SKIP: %s', skip_excinfo[1])
 
356
 
426
357
    def report_cleaning_up(self):
427
358
        self.pb.update('cleaning up...')
428
359
 
429
360
    def finished(self):
430
 
        if not self._supplied_pb:
431
 
            self.pb.finished()
 
361
        self.pb.finished()
432
362
 
433
363
 
434
364
class VerboseTestResult(ExtendedTestResult):
450
380
        name = self._shortened_test_description(test)
451
381
        # width needs space for 6 char status, plus 1 for slash, plus 2 10-char
452
382
        # numbers, plus a trailing blank
453
 
        # when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
454
383
        self.stream.write(self._ellipsize_to_right(name,
455
 
                          osutils.terminal_width()-30))
 
384
                            osutils.terminal_width()-30))
456
385
        self.stream.flush()
457
386
 
458
 
    def _error_summary(self, err):
459
 
        indent = ' ' * 4
460
 
        return '%s%s' % (indent, err[1])
461
 
 
462
387
    def report_error(self, test, err):
463
 
        self.stream.writeln('ERROR %s\n%s'
464
 
                % (self._testTimeString(test),
465
 
                   self._error_summary(err)))
 
388
        self.error_count += 1
 
389
        self.stream.writeln('ERROR %s\n    %s' 
 
390
                % (self._testTimeString(), err[1]))
466
391
 
467
392
    def report_failure(self, test, err):
468
 
        self.stream.writeln(' FAIL %s\n%s'
469
 
                % (self._testTimeString(test),
470
 
                   self._error_summary(err)))
471
 
 
472
 
    def report_known_failure(self, test, err):
473
 
        self.stream.writeln('XFAIL %s\n%s'
474
 
                % (self._testTimeString(test),
475
 
                   self._error_summary(err)))
 
393
        self.failure_count += 1
 
394
        self.stream.writeln(' FAIL %s\n    %s'
 
395
                % (self._testTimeString(), err[1]))
476
396
 
477
397
    def report_success(self, test):
478
 
        self.stream.writeln('   OK %s' % self._testTimeString(test))
 
398
        self.stream.writeln('   OK %s' % self._testTimeString())
479
399
        for bench_called, stats in getattr(test, '_benchcalls', []):
480
400
            self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
481
401
            stats.pprint(file=self.stream)
482
 
        # flush the stream so that we get smooth output. This verbose mode is
483
 
        # used to show the output in PQM.
484
402
        self.stream.flush()
485
403
 
486
404
    def report_skip(self, test, skip_excinfo):
487
 
        self.stream.writeln(' SKIP %s\n%s'
488
 
                % (self._testTimeString(test),
489
 
                   self._error_summary(skip_excinfo)))
490
 
 
491
 
    def report_not_applicable(self, test, skip_excinfo):
492
 
        self.stream.writeln('  N/A %s\n%s'
493
 
                % (self._testTimeString(test),
494
 
                   self._error_summary(skip_excinfo)))
495
 
 
496
 
    def report_unsupported(self, test, feature):
497
 
        """test cannot be run because feature is missing."""
498
 
        self.stream.writeln("NODEP %s\n    The feature '%s' is not available."
499
 
                %(self._testTimeString(test), feature))
 
405
        print >>self.stream, ' SKIP %s' % self._testTimeString()
 
406
        print >>self.stream, '     %s' % skip_excinfo[1]
500
407
 
501
408
 
502
409
class TextTestRunner(object):
506
413
                 stream=sys.stderr,
507
414
                 descriptions=0,
508
415
                 verbosity=1,
509
 
                 bench_history=None,
510
 
                 list_only=False
511
 
                 ):
 
416
                 keep_output=False,
 
417
                 bench_history=None):
512
418
        self.stream = unittest._WritelnDecorator(stream)
513
419
        self.descriptions = descriptions
514
420
        self.verbosity = verbosity
 
421
        self.keep_output = keep_output
515
422
        self._bench_history = bench_history
516
 
        self.list_only = list_only
517
423
 
518
424
    def run(self, test):
519
425
        "Run the given test case or test suite."
530
436
                              )
531
437
        result.stop_early = self.stop_on_failure
532
438
        result.report_starting()
533
 
        if self.list_only:
534
 
            if self.verbosity >= 2:
535
 
                self.stream.writeln("Listing tests only ...\n")
536
 
            run = 0
537
 
            for t in iter_suite_tests(test):
538
 
                self.stream.writeln("%s" % (t.id()))
539
 
                run += 1
540
 
            actionTaken = "Listed"
541
 
        else: 
542
 
            test.run(result)
543
 
            run = result.testsRun
544
 
            actionTaken = "Ran"
 
439
        test.run(result)
545
440
        stopTime = time.time()
546
441
        timeTaken = stopTime - startTime
547
442
        result.printErrors()
548
443
        self.stream.writeln(result.separator2)
549
 
        self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
550
 
                            run, run != 1 and "s" or "", timeTaken))
 
444
        run = result.testsRun
 
445
        self.stream.writeln("Ran %d test%s in %.3fs" %
 
446
                            (run, run != 1 and "s" or "", timeTaken))
551
447
        self.stream.writeln()
552
448
        if not result.wasSuccessful():
553
449
            self.stream.write("FAILED (")
557
453
            if errored:
558
454
                if failed: self.stream.write(", ")
559
455
                self.stream.write("errors=%d" % errored)
560
 
            if result.known_failure_count:
561
 
                if failed or errored: self.stream.write(", ")
562
 
                self.stream.write("known_failure_count=%d" %
563
 
                    result.known_failure_count)
564
456
            self.stream.writeln(")")
565
457
        else:
566
 
            if result.known_failure_count:
567
 
                self.stream.writeln("OK (known_failures=%d)" %
568
 
                    result.known_failure_count)
569
 
            else:
570
 
                self.stream.writeln("OK")
571
 
        if result.skip_count > 0:
572
 
            skipped = result.skip_count
573
 
            self.stream.writeln('%d test%s skipped' %
574
 
                                (skipped, skipped != 1 and "s" or ""))
575
 
        if result.unsupported:
576
 
            for feature, count in sorted(result.unsupported.items()):
577
 
                self.stream.writeln("Missing feature '%s' skipped %d tests." %
578
 
                    (feature, count))
 
458
            self.stream.writeln("OK")
 
459
        result.report_cleaning_up()
 
460
        # This is still a little bogus, 
 
461
        # but only a little. Folk not using our testrunner will
 
462
        # have to delete their temp directories themselves.
 
463
        test_root = TestCaseWithMemoryTransport.TEST_ROOT
 
464
        if result.wasSuccessful() or not self.keep_output:
 
465
            if test_root is not None:
 
466
                # If LANG=C we probably have created some bogus paths
 
467
                # which rmtree(unicode) will fail to delete
 
468
                # so make sure we are using rmtree(str) to delete everything
 
469
                # except on win32, where rmtree(str) will fail
 
470
                # since it doesn't have the property of byte-stream paths
 
471
                # (they are either ascii or mbcs)
 
472
                if sys.platform == 'win32':
 
473
                    # make sure we are using the unicode win32 api
 
474
                    test_root = unicode(test_root)
 
475
                else:
 
476
                    test_root = test_root.encode(
 
477
                        sys.getfilesystemencoding())
 
478
                osutils.rmtree(test_root)
 
479
        else:
 
480
            note("Failed tests working directories are in '%s'\n", test_root)
 
481
        TestCaseWithMemoryTransport.TEST_ROOT = None
579
482
        result.finished()
580
483
        return result
581
484
 
597
500
    """Indicates that a test was intentionally skipped, rather than failing."""
598
501
 
599
502
 
600
 
class TestNotApplicable(TestSkipped):
601
 
    """A test is not applicable to the situation where it was run.
602
 
 
603
 
    This is only normally raised by parameterized tests, if they find that 
604
 
    the instance they're constructed upon does not support one aspect 
605
 
    of its interface.
606
 
    """
607
 
 
608
 
 
609
 
class KnownFailure(AssertionError):
610
 
    """Indicates that a test failed in a precisely expected manner.
611
 
 
612
 
    Such failures dont block the whole test suite from passing because they are
613
 
    indicators of partially completed code or of future work. We have an
614
 
    explicit error for them so that we can ensure that they are always visible:
615
 
    KnownFailures are always shown in the output of bzr selftest.
616
 
    """
617
 
 
618
 
 
619
 
class UnavailableFeature(Exception):
620
 
    """A feature required for this test was not available.
621
 
 
622
 
    The feature should be used to construct the exception.
623
 
    """
624
 
 
625
 
 
626
503
class CommandFailed(Exception):
627
504
    pass
628
505
 
653
530
            return setattr(self._cstring, name, val)
654
531
 
655
532
 
656
 
class TestUIFactory(ui.CLIUIFactory):
657
 
    """A UI Factory for testing.
658
 
 
659
 
    Hide the progress bar but emit note()s.
660
 
    Redirect stdin.
661
 
    Allows get_password to be tested without real tty attached.
662
 
    """
663
 
 
664
 
    def __init__(self,
665
 
                 stdout=None,
666
 
                 stderr=None,
667
 
                 stdin=None):
668
 
        super(TestUIFactory, self).__init__()
669
 
        if stdin is not None:
670
 
            # We use a StringIOWrapper to be able to test various
671
 
            # encodings, but the user is still responsible to
672
 
            # encode the string and to set the encoding attribute
673
 
            # of StringIOWrapper.
674
 
            self.stdin = StringIOWrapper(stdin)
675
 
        if stdout is None:
676
 
            self.stdout = sys.stdout
677
 
        else:
678
 
            self.stdout = stdout
679
 
        if stderr is None:
680
 
            self.stderr = sys.stderr
681
 
        else:
682
 
            self.stderr = stderr
683
 
 
684
 
    def clear(self):
685
 
        """See progress.ProgressBar.clear()."""
686
 
 
687
 
    def clear_term(self):
688
 
        """See progress.ProgressBar.clear_term()."""
689
 
 
690
 
    def clear_term(self):
691
 
        """See progress.ProgressBar.clear_term()."""
692
 
 
693
 
    def finished(self):
694
 
        """See progress.ProgressBar.finished()."""
695
 
 
696
 
    def note(self, fmt_string, *args, **kwargs):
697
 
        """See progress.ProgressBar.note()."""
698
 
        self.stdout.write((fmt_string + "\n") % args)
699
 
 
700
 
    def progress_bar(self):
701
 
        return self
702
 
 
703
 
    def nested_progress_bar(self):
704
 
        return self
705
 
 
706
 
    def update(self, message, count=None, total=None):
707
 
        """See progress.ProgressBar.update()."""
708
 
 
709
 
    def get_non_echoed_password(self, prompt):
710
 
        """Get password from stdin without trying to handle the echo mode"""
711
 
        if prompt:
712
 
            self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
713
 
        password = self.stdin.readline()
714
 
        if not password:
715
 
            raise EOFError
716
 
        if password[-1] == '\n':
717
 
            password = password[:-1]
718
 
        return password
719
 
 
720
 
 
721
 
def _report_leaked_threads():
722
 
    bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
723
 
                         TestCase._first_thread_leaker_id,
724
 
                         TestCase._leaking_threads_tests)
725
 
 
726
 
 
727
533
class TestCase(unittest.TestCase):
728
534
    """Base class for bzr unit tests.
729
535
    
745
551
    accidentally overlooked.
746
552
    """
747
553
 
748
 
    _active_threads = None
749
 
    _leaking_threads_tests = 0
750
 
    _first_thread_leaker_id = None
751
554
    _log_file_name = None
752
555
    _log_contents = ''
753
556
    _keep_log_file = False
754
557
    # record lsprof data when performing benchmark calls.
755
558
    _gather_lsprof_in_benchmarks = False
756
 
    attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
757
 
                     '_log_contents', '_log_file_name', '_benchtime',
758
 
                     '_TestCase__testMethodName')
759
559
 
760
560
    def __init__(self, methodName='testMethod'):
761
561
        super(TestCase, self).__init__(methodName)
764
564
    def setUp(self):
765
565
        unittest.TestCase.setUp(self)
766
566
        self._cleanEnvironment()
 
567
        bzrlib.trace.disable_default_logging()
767
568
        self._silenceUI()
768
569
        self._startLogFile()
769
570
        self._benchcalls = []
770
571
        self._benchtime = None
771
 
        self._clear_hooks()
772
 
        self._clear_debug_flags()
773
 
        TestCase._active_threads = threading.activeCount()
774
 
        self.addCleanup(self._check_leaked_threads)
775
 
 
776
 
    def _check_leaked_threads(self):
777
 
        active = threading.activeCount()
778
 
        leaked_threads = active - TestCase._active_threads
779
 
        TestCase._active_threads = active
780
 
        if leaked_threads:
781
 
            TestCase._leaking_threads_tests += 1
782
 
            if TestCase._first_thread_leaker_id is None:
783
 
                TestCase._first_thread_leaker_id = self.id()
784
 
                # we're not specifically told when all tests are finished.
785
 
                # This will do. We use a function to avoid keeping a reference
786
 
                # to a TestCase object.
787
 
                atexit.register(_report_leaked_threads)
788
 
 
789
 
    def _clear_debug_flags(self):
790
 
        """Prevent externally set debug flags affecting tests.
791
 
        
792
 
        Tests that want to use debug flags can just set them in the
793
 
        debug_flags set during setup/teardown.
794
 
        """
795
 
        if 'allow_debug' not in selftest_debug_flags:
796
 
            self._preserved_debug_flags = set(debug.debug_flags)
797
 
            debug.debug_flags.clear()
798
 
            self.addCleanup(self._restore_debug_flags)
799
 
 
800
 
    def _clear_hooks(self):
801
572
        # prevent hooks affecting tests
802
 
        import bzrlib.branch
803
 
        import bzrlib.smart.server
804
 
        self._preserved_hooks = {
805
 
            bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
806
 
            bzrlib.mutabletree.MutableTree: bzrlib.mutabletree.MutableTree.hooks,
807
 
            bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
808
 
            }
 
573
        self._preserved_hooks = bzrlib.branch.Branch.hooks
809
574
        self.addCleanup(self._restoreHooks)
810
 
        # reset all hooks to an empty instance of the appropriate type
 
575
        # this list of hooks must be kept in sync with the defaults
 
576
        # in branch.py
811
577
        bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
812
 
        bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
813
578
 
814
579
    def _silenceUI(self):
815
580
        """Turn off UI for duration of test"""
816
581
        # by default the UI is off; tests can turn it on if they want it.
817
 
        saved = ui.ui_factory
 
582
        saved = bzrlib.ui.ui_factory
818
583
        def _restore():
819
 
            ui.ui_factory = saved
820
 
        ui.ui_factory = ui.SilentUIFactory()
 
584
            bzrlib.ui.ui_factory = saved
 
585
        bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
821
586
        self.addCleanup(_restore)
822
587
 
823
588
    def _ndiff_strings(self, a, b):
835
600
                                  charjunk=lambda x: False)
836
601
        return ''.join(difflines)
837
602
 
838
 
    def assertEqual(self, a, b, message=''):
839
 
        try:
840
 
            if a == b:
841
 
                return
842
 
        except UnicodeError, e:
843
 
            # If we can't compare without getting a UnicodeError, then
844
 
            # obviously they are different
845
 
            mutter('UnicodeError: %s', e)
846
 
        if message:
847
 
            message += '\n'
848
 
        raise AssertionError("%snot equal:\na = %s\nb = %s\n"
849
 
            % (message,
850
 
               pformat(a), pformat(b)))
851
 
 
852
 
    assertEquals = assertEqual
853
 
 
854
603
    def assertEqualDiff(self, a, b, message=None):
855
604
        """Assert two texts are equal, if not raise an exception.
856
605
        
862
611
            return
863
612
        if message is None:
864
613
            message = "texts not equal:\n"
865
 
        if a == b + '\n':
866
 
            message = 'first string is missing a final newline.\n'
867
 
        if a + '\n' == b:
868
 
            message = 'second string is missing a final newline.\n'
869
 
        raise AssertionError(message +
870
 
                             self._ndiff_strings(a, b))
 
614
        raise AssertionError(message + 
 
615
                             self._ndiff_strings(a, b))      
871
616
        
872
617
    def assertEqualMode(self, mode, mode_test):
873
618
        self.assertEqual(mode, mode_test,
874
619
                         'mode mismatch %o != %o' % (mode, mode_test))
875
620
 
876
 
    def assertPositive(self, val):
877
 
        """Assert that val is greater than 0."""
878
 
        self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
879
 
 
880
 
    def assertNegative(self, val):
881
 
        """Assert that val is less than 0."""
882
 
        self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
883
 
 
884
621
    def assertStartsWith(self, s, prefix):
885
622
        if not s.startswith(prefix):
886
623
            raise AssertionError('string %r does not start with %r' % (s, prefix))
893
630
    def assertContainsRe(self, haystack, needle_re):
894
631
        """Assert that a contains something matching a regular expression."""
895
632
        if not re.search(needle_re, haystack):
896
 
            if '\n' in haystack or len(haystack) > 60:
897
 
                # a long string, format it in a more readable way
898
 
                raise AssertionError(
899
 
                        'pattern "%s" not found in\n"""\\\n%s"""\n'
900
 
                        % (needle_re, haystack))
901
 
            else:
902
 
                raise AssertionError('pattern "%s" not found in "%s"'
903
 
                        % (needle_re, haystack))
 
633
            raise AssertionError('pattern "%s" not found in "%s"'
 
634
                    % (needle_re, haystack))
904
635
 
905
636
    def assertNotContainsRe(self, haystack, needle_re):
906
637
        """Assert that a does not match a regular expression"""
910
641
 
911
642
    def assertSubset(self, sublist, superlist):
912
643
        """Assert that every entry in sublist is present in superlist."""
913
 
        missing = set(sublist) - set(superlist)
 
644
        missing = []
 
645
        for entry in sublist:
 
646
            if entry not in superlist:
 
647
                missing.append(entry)
914
648
        if len(missing) > 0:
915
 
            raise AssertionError("value(s) %r not present in container %r" %
 
649
            raise AssertionError("value(s) %r not present in container %r" % 
916
650
                                 (missing, superlist))
917
651
 
918
652
    def assertListRaises(self, excClass, func, *args, **kwargs):
924
658
        """
925
659
        try:
926
660
            list(func(*args, **kwargs))
927
 
        except excClass, e:
928
 
            return e
929
 
        else:
930
 
            if getattr(excClass,'__name__', None) is not None:
931
 
                excName = excClass.__name__
932
 
            else:
933
 
                excName = str(excClass)
934
 
            raise self.failureException, "%s not raised" % excName
935
 
 
936
 
    def assertRaises(self, excClass, callableObj, *args, **kwargs):
937
 
        """Assert that a callable raises a particular exception.
938
 
 
939
 
        :param excClass: As for the except statement, this may be either an
940
 
            exception class, or a tuple of classes.
941
 
        :param callableObj: A callable, will be passed ``*args`` and
942
 
            ``**kwargs``.
943
 
 
944
 
        Returns the exception so that you can examine it.
945
 
        """
946
 
        try:
947
 
            callableObj(*args, **kwargs)
948
 
        except excClass, e:
949
 
            return e
950
 
        else:
951
 
            if getattr(excClass,'__name__', None) is not None:
952
 
                excName = excClass.__name__
953
 
            else:
954
 
                # probably a tuple
 
661
        except excClass:
 
662
            return
 
663
        else:
 
664
            if getattr(excClass,'__name__', None) is not None:
 
665
                excName = excClass.__name__
 
666
            else:
955
667
                excName = str(excClass)
956
668
            raise self.failureException, "%s not raised" % excName
957
669
 
981
693
        self.assertEqual(mode, actual_mode,
982
694
            'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
983
695
 
984
 
    def assertIsSameRealPath(self, path1, path2):
985
 
        """Fail if path1 and path2 points to different files"""
986
 
        self.assertEqual(osutils.realpath(path1),
987
 
                         osutils.realpath(path2),
988
 
                         "apparent paths:\na = %s\nb = %s\n," % (path1, path2))
989
 
 
990
696
    def assertIsInstance(self, obj, kls):
991
697
        """Fail if obj is not an instance of kls"""
992
698
        if not isinstance(obj, kls):
993
699
            self.fail("%r is an instance of %s rather than %s" % (
994
700
                obj, obj.__class__, kls))
995
701
 
996
 
    def expectFailure(self, reason, assertion, *args, **kwargs):
997
 
        """Invoke a test, expecting it to fail for the given reason.
998
 
 
999
 
        This is for assertions that ought to succeed, but currently fail.
1000
 
        (The failure is *expected* but not *wanted*.)  Please be very precise
1001
 
        about the failure you're expecting.  If a new bug is introduced,
1002
 
        AssertionError should be raised, not KnownFailure.
1003
 
 
1004
 
        Frequently, expectFailure should be followed by an opposite assertion.
1005
 
        See example below.
1006
 
 
1007
 
        Intended to be used with a callable that raises AssertionError as the
1008
 
        'assertion' parameter.  args and kwargs are passed to the 'assertion'.
1009
 
 
1010
 
        Raises KnownFailure if the test fails.  Raises AssertionError if the
1011
 
        test succeeds.
1012
 
 
1013
 
        example usage::
1014
 
 
1015
 
          self.expectFailure('Math is broken', self.assertNotEqual, 54,
1016
 
                             dynamic_val)
1017
 
          self.assertEqual(42, dynamic_val)
1018
 
 
1019
 
          This means that a dynamic_val of 54 will cause the test to raise
1020
 
          a KnownFailure.  Once math is fixed and the expectFailure is removed,
1021
 
          only a dynamic_val of 42 will allow the test to pass.  Anything other
1022
 
          than 54 or 42 will cause an AssertionError.
1023
 
        """
1024
 
        try:
1025
 
            assertion(*args, **kwargs)
1026
 
        except AssertionError:
1027
 
            raise KnownFailure(reason)
1028
 
        else:
1029
 
            self.fail('Unexpected success.  Should have failed: %s' % reason)
1030
 
 
1031
 
    def assertFileEqual(self, content, path):
1032
 
        """Fail if path does not contain 'content'."""
1033
 
        self.failUnlessExists(path)
1034
 
        f = file(path, 'rb')
1035
 
        try:
1036
 
            s = f.read()
1037
 
        finally:
1038
 
            f.close()
1039
 
        self.assertEqualDiff(content, s)
1040
 
 
1041
 
    def failUnlessExists(self, path):
1042
 
        """Fail unless path or paths, which may be abs or relative, exist."""
1043
 
        if not isinstance(path, basestring):
1044
 
            for p in path:
1045
 
                self.failUnlessExists(p)
1046
 
        else:
1047
 
            self.failUnless(osutils.lexists(path),path+" does not exist")
1048
 
 
1049
 
    def failIfExists(self, path):
1050
 
        """Fail if path or paths, which may be abs or relative, exist."""
1051
 
        if not isinstance(path, basestring):
1052
 
            for p in path:
1053
 
                self.failIfExists(p)
1054
 
        else:
1055
 
            self.failIf(osutils.lexists(path),path+" exists")
1056
 
 
1057
 
    def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
 
702
    def _capture_warnings(self, a_callable, *args, **kwargs):
1058
703
        """A helper for callDeprecated and applyDeprecated.
1059
704
 
1060
705
        :param a_callable: A callable to call.
1061
706
        :param args: The positional arguments for the callable
1062
707
        :param kwargs: The keyword arguments for the callable
1063
708
        :return: A tuple (warnings, result). result is the result of calling
1064
 
            a_callable(``*args``, ``**kwargs``).
 
709
            a_callable(*args, **kwargs).
1065
710
        """
1066
711
        local_warnings = []
1067
712
        def capture_warnings(msg, cls=None, stacklevel=None):
1080
725
    def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1081
726
        """Call a deprecated callable without warning the user.
1082
727
 
1083
 
        Note that this only captures warnings raised by symbol_versioning.warn,
1084
 
        not other callers that go direct to the warning module.
1085
 
 
1086
 
        To test that a deprecated method raises an error, do something like
1087
 
        this::
1088
 
 
1089
 
            self.assertRaises(errors.ReservedId,
1090
 
                self.applyDeprecated,
1091
 
                deprecated_in((1, 5, 0)),
1092
 
                br.append_revision,
1093
 
                'current:')
1094
 
 
1095
728
        :param deprecation_format: The deprecation format that the callable
1096
 
            should have been deprecated with. This is the same type as the
1097
 
            parameter to deprecated_method/deprecated_function. If the
 
729
            should have been deprecated with. This is the same type as the 
 
730
            parameter to deprecated_method/deprecated_function. If the 
1098
731
            callable is not deprecated with this format, an assertion error
1099
732
            will be raised.
1100
733
        :param a_callable: A callable to call. This may be a bound method or
1101
 
            a regular function. It will be called with ``*args`` and
1102
 
            ``**kwargs``.
 
734
            a regular function. It will be called with *args and **kwargs.
1103
735
        :param args: The positional arguments for the callable
1104
736
        :param kwargs: The keyword arguments for the callable
1105
 
        :return: The result of a_callable(``*args``, ``**kwargs``)
 
737
        :return: The result of a_callable(*args, **kwargs)
1106
738
        """
1107
 
        call_warnings, result = self._capture_deprecation_warnings(a_callable,
 
739
        call_warnings, result = self._capture_warnings(a_callable,
1108
740
            *args, **kwargs)
1109
741
        expected_first_warning = symbol_versioning.deprecation_string(
1110
742
            a_callable, deprecation_format)
1111
743
        if len(call_warnings) == 0:
1112
 
            self.fail("No deprecation warning generated by call to %s" %
 
744
            self.fail("No assertion generated by call to %s" %
1113
745
                a_callable)
1114
746
        self.assertEqual(expected_first_warning, call_warnings[0])
1115
747
        return result
1116
748
 
1117
 
    def callCatchWarnings(self, fn, *args, **kw):
1118
 
        """Call a callable that raises python warnings.
1119
 
 
1120
 
        The caller's responsible for examining the returned warnings.
1121
 
 
1122
 
        If the callable raises an exception, the exception is not
1123
 
        caught and propagates up to the caller.  In that case, the list
1124
 
        of warnings is not available.
1125
 
 
1126
 
        :returns: ([warning_object, ...], fn_result)
1127
 
        """
1128
 
        # XXX: This is not perfect, because it completely overrides the
1129
 
        # warnings filters, and some code may depend on suppressing particular
1130
 
        # warnings.  It's the easiest way to insulate ourselves from -Werror,
1131
 
        # though.  -- Andrew, 20071062
1132
 
        wlist = []
1133
 
        def _catcher(message, category, filename, lineno, file=None):
1134
 
            # despite the name, 'message' is normally(?) a Warning subclass
1135
 
            # instance
1136
 
            wlist.append(message)
1137
 
        saved_showwarning = warnings.showwarning
1138
 
        saved_filters = warnings.filters
1139
 
        try:
1140
 
            warnings.showwarning = _catcher
1141
 
            warnings.filters = []
1142
 
            result = fn(*args, **kw)
1143
 
        finally:
1144
 
            warnings.showwarning = saved_showwarning
1145
 
            warnings.filters = saved_filters
1146
 
        return wlist, result
1147
 
 
1148
749
    def callDeprecated(self, expected, callable, *args, **kwargs):
1149
750
        """Assert that a callable is deprecated in a particular way.
1150
751
 
1153
754
        as it allows you to simply specify the deprecation format being used
1154
755
        and will ensure that that is issued for the function being called.
1155
756
 
1156
 
        Note that this only captures warnings raised by symbol_versioning.warn,
1157
 
        not other callers that go direct to the warning module.  To catch
1158
 
        general warnings, use callCatchWarnings.
1159
 
 
1160
757
        :param expected: a list of the deprecation warnings expected, in order
1161
758
        :param callable: The callable to call
1162
759
        :param args: The positional arguments for the callable
1163
760
        :param kwargs: The keyword arguments for the callable
1164
761
        """
1165
 
        call_warnings, result = self._capture_deprecation_warnings(callable,
 
762
        call_warnings, result = self._capture_warnings(callable,
1166
763
            *args, **kwargs)
1167
764
        self.assertEqual(expected, call_warnings)
1168
765
        return result
1174
771
        """
1175
772
        fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1176
773
        self._log_file = os.fdopen(fileno, 'w+')
1177
 
        self._log_memento = bzrlib.trace.push_log_file(self._log_file)
 
774
        self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1178
775
        self._log_file_name = name
1179
776
        self.addCleanup(self._finishLogFile)
1180
777
 
1185
782
        """
1186
783
        if self._log_file is None:
1187
784
            return
1188
 
        bzrlib.trace.pop_log_file(self._log_memento)
 
785
        bzrlib.trace.disable_test_log(self._log_nonce)
1189
786
        self._log_file.close()
1190
787
        self._log_file = None
1191
788
        if not self._keep_log_file:
1211
808
        new_env = {
1212
809
            'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1213
810
            'HOME': os.getcwd(),
1214
 
            'APPDATA': None,  # bzr now use Win32 API and don't rely on APPDATA
1215
 
            'BZR_EDITOR': None, # test_msgeditor manipulates this variable
 
811
            'APPDATA': os.getcwd(),
1216
812
            'BZR_EMAIL': None,
1217
813
            'BZREMAIL': None, # may still be present in the environment
1218
814
            'EMAIL': None,
1219
815
            'BZR_PROGRESS_BAR': None,
1220
 
            'BZR_LOG': None,
1221
 
            # SSH Agent
1222
 
            'SSH_AUTH_SOCK': None,
1223
816
            # Proxies
1224
817
            'http_proxy': None,
1225
818
            'HTTP_PROXY': None,
1234
827
            # -- vila 20061212
1235
828
            'ftp_proxy': None,
1236
829
            'FTP_PROXY': None,
1237
 
            'BZR_REMOTE_PATH': None,
1238
830
        }
1239
831
        self.__old_env = {}
1240
832
        self.addCleanup(self._restoreEnvironment)
1245
837
        """Set an environment variable, and reset it when finished."""
1246
838
        self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1247
839
 
1248
 
    def _restore_debug_flags(self):
1249
 
        debug.debug_flags.clear()
1250
 
        debug.debug_flags.update(self._preserved_debug_flags)
1251
 
 
1252
840
    def _restoreEnvironment(self):
1253
841
        for name, value in self.__old_env.iteritems():
1254
842
            osutils.set_or_unset_env(name, value)
1255
843
 
1256
844
    def _restoreHooks(self):
1257
 
        for klass, hooks in self._preserved_hooks.items():
1258
 
            setattr(klass, 'hooks', hooks)
1259
 
 
1260
 
    def knownFailure(self, reason):
1261
 
        """This test has failed for some known reason."""
1262
 
        raise KnownFailure(reason)
1263
 
 
1264
 
    def run(self, result=None):
1265
 
        if result is None: result = self.defaultTestResult()
1266
 
        for feature in getattr(self, '_test_needs_features', []):
1267
 
            if not feature.available():
1268
 
                result.startTest(self)
1269
 
                if getattr(result, 'addNotSupported', None):
1270
 
                    result.addNotSupported(self, feature)
1271
 
                else:
1272
 
                    result.addSuccess(self)
1273
 
                result.stopTest(self)
1274
 
                return
1275
 
        try:
1276
 
            return unittest.TestCase.run(self, result)
1277
 
        finally:
1278
 
            saved_attrs = {}
1279
 
            absent_attr = object()
1280
 
            for attr_name in self.attrs_to_keep:
1281
 
                attr = getattr(self, attr_name, absent_attr)
1282
 
                if attr is not absent_attr:
1283
 
                    saved_attrs[attr_name] = attr
1284
 
            self.__dict__ = saved_attrs
 
845
        bzrlib.branch.Branch.hooks = self._preserved_hooks
1285
846
 
1286
847
    def tearDown(self):
1287
848
        self._runCleanups()
1316
877
        """
1317
878
        # TODO: Perhaps this should keep running cleanups even if 
1318
879
        # one of them fails?
1319
 
 
1320
 
        # Actually pop the cleanups from the list so tearDown running
1321
 
        # twice is safe (this happens for skipped tests).
1322
 
        while self._cleanups:
1323
 
            self._cleanups.pop()()
 
880
        for cleanup_fn in reversed(self._cleanups):
 
881
            cleanup_fn()
1324
882
 
1325
883
    def log(self, *args):
1326
884
        mutter(*args)
1327
885
 
1328
886
    def _get_log(self, keep_log_file=False):
1329
 
        """Get the log from bzrlib.trace calls from this test.
1330
 
 
1331
 
        :param keep_log_file: When True, if the log is still a file on disk
1332
 
            leave it as a file on disk. When False, if the log is still a file
1333
 
            on disk, the log file is deleted and the log preserved as
1334
 
            self._log_contents.
1335
 
        :return: A string containing the log.
1336
 
        """
 
887
        """Return as a string the log for this test. If the file is still
 
888
        on disk and keep_log_file=False, delete the log file and store the
 
889
        content in self._log_contents."""
1337
890
        # flush the log file, to get all content
1338
891
        import bzrlib.trace
1339
892
        bzrlib.trace._trace_file.flush()
1340
893
        if self._log_contents:
1341
 
            # XXX: this can hardly contain the content flushed above --vila
1342
 
            # 20080128
1343
894
            return self._log_contents
1344
895
        if self._log_file_name is not None:
1345
896
            logfile = open(self._log_file_name)
1349
900
                logfile.close()
1350
901
            if not keep_log_file:
1351
902
                self._log_contents = log_contents
1352
 
                try:
1353
 
                    os.remove(self._log_file_name)
1354
 
                except OSError, e:
1355
 
                    if sys.platform == 'win32' and e.errno == errno.EACCES:
1356
 
                        sys.stderr.write(('Unable to delete log file '
1357
 
                                             ' %r\n' % self._log_file_name))
1358
 
                    else:
1359
 
                        raise
 
903
                os.remove(self._log_file_name)
1360
904
            return log_contents
1361
905
        else:
1362
906
            return "DELETED log file to reduce memory footprint"
1363
907
 
1364
 
    def requireFeature(self, feature):
1365
 
        """This test requires a specific feature is available.
1366
 
 
1367
 
        :raises UnavailableFeature: When feature is not available.
 
908
    def capture(self, cmd, retcode=0):
 
909
        """Shortcut that splits cmd into words, runs, and returns stdout"""
 
910
        return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
 
911
 
 
912
    def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
 
913
                         working_dir=None):
 
914
        """Invoke bzr and return (stdout, stderr).
 
915
 
 
916
        Useful for code that wants to check the contents of the
 
917
        output, the way error messages are presented, etc.
 
918
 
 
919
        This should be the main method for tests that want to exercise the
 
920
        overall behavior of the bzr application (rather than a unit test
 
921
        or a functional test of the library.)
 
922
 
 
923
        Much of the old code runs bzr by forking a new copy of Python, but
 
924
        that is slower, harder to debug, and generally not necessary.
 
925
 
 
926
        This runs bzr through the interface that catches and reports
 
927
        errors, and with logging set to something approximating the
 
928
        default, so that error reporting can be checked.
 
929
 
 
930
        :param argv: arguments to invoke bzr
 
931
        :param retcode: expected return code, or None for don't-care.
 
932
        :param encoding: encoding for sys.stdout and sys.stderr
 
933
        :param stdin: A string to be used as stdin for the command.
 
934
        :param working_dir: Change to this directory before running
1368
935
        """
1369
 
        if not feature.available():
1370
 
            raise UnavailableFeature(feature)
1371
 
 
1372
 
    def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1373
 
            working_dir):
1374
 
        """Run bazaar command line, splitting up a string command line."""
1375
 
        if isinstance(args, basestring):
1376
 
            # shlex don't understand unicode strings,
1377
 
            # so args should be plain string (bialix 20070906)
1378
 
            args = list(shlex.split(str(args)))
1379
 
        return self._run_bzr_core(args, retcode=retcode,
1380
 
                encoding=encoding, stdin=stdin, working_dir=working_dir,
1381
 
                )
1382
 
 
1383
 
    def _run_bzr_core(self, args, retcode, encoding, stdin,
1384
 
            working_dir):
1385
936
        if encoding is None:
1386
937
            encoding = bzrlib.user_encoding
 
938
        if stdin is not None:
 
939
            stdin = StringIO(stdin)
1387
940
        stdout = StringIOWrapper()
1388
941
        stderr = StringIOWrapper()
1389
942
        stdout.encoding = encoding
1390
943
        stderr.encoding = encoding
1391
944
 
1392
 
        self.log('run bzr: %r', args)
 
945
        self.log('run bzr: %r', argv)
1393
946
        # FIXME: don't call into logging here
1394
947
        handler = logging.StreamHandler(stderr)
1395
948
        handler.setLevel(logging.INFO)
1396
949
        logger = logging.getLogger('')
1397
950
        logger.addHandler(handler)
1398
 
        old_ui_factory = ui.ui_factory
1399
 
        ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
 
951
        old_ui_factory = bzrlib.ui.ui_factory
 
952
        bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
 
953
            stdout=stdout,
 
954
            stderr=stderr)
 
955
        bzrlib.ui.ui_factory.stdin = stdin
1400
956
 
1401
957
        cwd = None
1402
958
        if working_dir is not None:
1404
960
            os.chdir(working_dir)
1405
961
 
1406
962
        try:
1407
 
            result = self.apply_redirected(ui.ui_factory.stdin,
1408
 
                stdout, stderr,
1409
 
                bzrlib.commands.run_bzr_catch_user_errors,
1410
 
                args)
 
963
            saved_debug_flags = frozenset(debug.debug_flags)
 
964
            debug.debug_flags.clear()
 
965
            try:
 
966
                result = self.apply_redirected(stdin, stdout, stderr,
 
967
                                               bzrlib.commands.run_bzr_catch_errors,
 
968
                                               argv)
 
969
            finally:
 
970
                debug.debug_flags.update(saved_debug_flags)
1411
971
        finally:
1412
972
            logger.removeHandler(handler)
1413
 
            ui.ui_factory = old_ui_factory
 
973
            bzrlib.ui.ui_factory = old_ui_factory
1414
974
            if cwd is not None:
1415
975
                os.chdir(cwd)
1416
976
 
1421
981
        if err:
1422
982
            self.log('errors:\n%r', err)
1423
983
        if retcode is not None:
1424
 
            self.assertEquals(retcode, result,
1425
 
                              message='Unexpected return code')
 
984
            self.assertEquals(retcode, result)
1426
985
        return out, err
1427
986
 
1428
 
    def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1429
 
                working_dir=None, error_regexes=[], output_encoding=None):
 
987
    def run_bzr(self, *args, **kwargs):
1430
988
        """Invoke bzr, as if it were run from the command line.
1431
989
 
1432
 
        The argument list should not include the bzr program name - the
1433
 
        first argument is normally the bzr command.  Arguments may be
1434
 
        passed in three ways:
1435
 
 
1436
 
        1- A list of strings, eg ["commit", "a"].  This is recommended
1437
 
        when the command contains whitespace or metacharacters, or 
1438
 
        is built up at run time.
1439
 
 
1440
 
        2- A single string, eg "add a".  This is the most convenient 
1441
 
        for hardcoded commands.
1442
 
 
1443
 
        This runs bzr through the interface that catches and reports
1444
 
        errors, and with logging set to something approximating the
1445
 
        default, so that error reporting can be checked.
1446
 
 
1447
990
        This should be the main method for tests that want to exercise the
1448
991
        overall behavior of the bzr application (rather than a unit test
1449
992
        or a functional test of the library.)
1451
994
        This sends the stdout/stderr results into the test's log,
1452
995
        where it may be useful for debugging.  See also run_captured.
1453
996
 
1454
 
        :keyword stdin: A string to be used as stdin for the command.
1455
 
        :keyword retcode: The status code the command should return;
1456
 
            default 0.
1457
 
        :keyword working_dir: The directory to run the command in
1458
 
        :keyword error_regexes: A list of expected error messages.  If
1459
 
            specified they must be seen in the error output of the command.
 
997
        :param stdin: A string to be used as stdin for the command.
1460
998
        """
1461
 
        out, err = self._run_bzr_autosplit(
1462
 
            args=args,
1463
 
            retcode=retcode,
1464
 
            encoding=encoding,
1465
 
            stdin=stdin,
1466
 
            working_dir=working_dir,
1467
 
            )
1468
 
        for regex in error_regexes:
1469
 
            self.assertContainsRe(err, regex)
1470
 
        return out, err
 
999
        retcode = kwargs.pop('retcode', 0)
 
1000
        encoding = kwargs.pop('encoding', None)
 
1001
        stdin = kwargs.pop('stdin', None)
 
1002
        working_dir = kwargs.pop('working_dir', None)
 
1003
        return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
 
1004
                                     stdin=stdin, working_dir=working_dir)
 
1005
 
 
1006
    def run_bzr_decode(self, *args, **kwargs):
 
1007
        if 'encoding' in kwargs:
 
1008
            encoding = kwargs['encoding']
 
1009
        else:
 
1010
            encoding = bzrlib.user_encoding
 
1011
        return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1471
1012
 
1472
1013
    def run_bzr_error(self, error_regexes, *args, **kwargs):
1473
1014
        """Run bzr, and check that stderr contains the supplied regexes
1474
 
 
1475
 
        :param error_regexes: Sequence of regular expressions which
 
1015
        
 
1016
        :param error_regexes: Sequence of regular expressions which 
1476
1017
            must each be found in the error output. The relative ordering
1477
1018
            is not enforced.
1478
1019
        :param args: command-line arguments for bzr
1479
1020
        :param kwargs: Keyword arguments which are interpreted by run_bzr
1480
1021
            This function changes the default value of retcode to be 3,
1481
1022
            since in most cases this is run when you expect bzr to fail.
1482
 
 
1483
 
        :return: (out, err) The actual output of running the command (in case
1484
 
            you want to do more inspection)
1485
 
 
1486
 
        Examples of use::
1487
 
 
 
1023
        :return: (out, err) The actual output of running the command (in case you
 
1024
                 want to do more inspection)
 
1025
 
 
1026
        Examples of use:
1488
1027
            # Make sure that commit is failing because there is nothing to do
1489
1028
            self.run_bzr_error(['no changes to commit'],
1490
 
                               ['commit', '-m', 'my commit comment'])
 
1029
                               'commit', '-m', 'my commit comment')
1491
1030
            # Make sure --strict is handling an unknown file, rather than
1492
1031
            # giving us the 'nothing to do' error
1493
1032
            self.build_tree(['unknown'])
1494
1033
            self.run_bzr_error(['Commit refused because there are unknown files'],
1495
 
                               ['commit', --strict', '-m', 'my commit comment'])
 
1034
                               'commit', '--strict', '-m', 'my commit comment')
1496
1035
        """
1497
1036
        kwargs.setdefault('retcode', 3)
1498
 
        kwargs['error_regexes'] = error_regexes
1499
1037
        out, err = self.run_bzr(*args, **kwargs)
 
1038
        for regex in error_regexes:
 
1039
            self.assertContainsRe(err, regex)
1500
1040
        return out, err
1501
1041
 
1502
1042
    def run_bzr_subprocess(self, *args, **kwargs):
1508
1048
        handling, or early startup code, etc.  Subprocess code can't be 
1509
1049
        profiled or debugged so easily.
1510
1050
 
1511
 
        :keyword retcode: The status code that is expected.  Defaults to 0.  If
 
1051
        :param retcode: The status code that is expected.  Defaults to 0.  If
1512
1052
            None is supplied, the status code is not checked.
1513
 
        :keyword env_changes: A dictionary which lists changes to environment
 
1053
        :param env_changes: A dictionary which lists changes to environment
1514
1054
            variables. A value of None will unset the env variable.
1515
1055
            The values must be strings. The change will only occur in the
1516
1056
            child, so you don't need to fix the environment after running.
1517
 
        :keyword universal_newlines: Convert CRLF => LF
1518
 
        :keyword allow_plugins: By default the subprocess is run with
 
1057
        :param universal_newlines: Convert CRLF => LF
 
1058
        :param allow_plugins: By default the subprocess is run with
1519
1059
            --no-plugins to ensure test reproducibility. Also, it is possible
1520
1060
            for system-wide plugins to create unexpected output on stderr,
1521
1061
            which can cause unnecessary test failures.
1523
1063
        env_changes = kwargs.get('env_changes', {})
1524
1064
        working_dir = kwargs.get('working_dir', None)
1525
1065
        allow_plugins = kwargs.get('allow_plugins', False)
1526
 
        if len(args) == 1:
1527
 
            if isinstance(args[0], list):
1528
 
                args = args[0]
1529
 
            elif isinstance(args[0], basestring):
1530
 
                args = list(shlex.split(args[0]))
1531
 
        else:
1532
 
            raise ValueError("passing varargs to run_bzr_subprocess")
1533
1066
        process = self.start_bzr_subprocess(args, env_changes=env_changes,
1534
1067
                                            working_dir=working_dir,
1535
1068
                                            allow_plugins=allow_plugins)
1552
1085
        profiled or debugged so easily.
1553
1086
 
1554
1087
        :param process_args: a list of arguments to pass to the bzr executable,
1555
 
            for example ``['--version']``.
 
1088
            for example `['--version']`.
1556
1089
        :param env_changes: A dictionary which lists changes to environment
1557
1090
            variables. A value of None will unset the env variable.
1558
1091
            The values must be strings. The change will only occur in the
1656
1189
        shape = list(shape)             # copy
1657
1190
        for path, ie in inv.entries():
1658
1191
            name = path.replace('\\', '/')
1659
 
            if ie.kind == 'directory':
 
1192
            if ie.kind == 'dir':
1660
1193
                name = name + '/'
1661
1194
            if name in shape:
1662
1195
                shape.remove(name)
1699
1232
            sys.stderr = real_stderr
1700
1233
            sys.stdin = real_stdin
1701
1234
 
1702
 
    def reduceLockdirTimeout(self):
1703
 
        """Reduce the default lock timeout for the duration of the test, so that
1704
 
        if LockContention occurs during a test, it does so quickly.
1705
 
 
1706
 
        Tests that expect to provoke LockContention errors should call this.
1707
 
        """
1708
 
        orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1709
 
        def resetTimeout():
1710
 
            bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1711
 
        self.addCleanup(resetTimeout)
1712
 
        bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1713
 
 
1714
 
    def make_utf8_encoded_stringio(self, encoding_type=None):
1715
 
        """Return a StringIOWrapper instance, that will encode Unicode
1716
 
        input to UTF-8.
1717
 
        """
1718
 
        if encoding_type is None:
1719
 
            encoding_type = 'strict'
1720
 
        sio = StringIO()
1721
 
        output_encoding = 'utf-8'
1722
 
        sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1723
 
        sio.encoding = output_encoding
1724
 
        return sio
 
1235
    @symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
 
1236
    def merge(self, branch_from, wt_to):
 
1237
        """A helper for tests to do a ui-less merge.
 
1238
 
 
1239
        This should move to the main library when someone has time to integrate
 
1240
        it in.
 
1241
        """
 
1242
        # minimal ui-less merge.
 
1243
        wt_to.branch.fetch(branch_from)
 
1244
        base_rev = common_ancestor(branch_from.last_revision(),
 
1245
                                   wt_to.branch.last_revision(),
 
1246
                                   wt_to.branch.repository)
 
1247
        merge_inner(wt_to.branch, branch_from.basis_tree(),
 
1248
                    wt_to.branch.repository.revision_tree(base_rev),
 
1249
                    this_tree=wt_to)
 
1250
        wt_to.add_parent_tree_id(branch_from.last_revision())
 
1251
 
 
1252
 
 
1253
BzrTestBase = TestCase
1725
1254
 
1726
1255
 
1727
1256
class TestCaseWithMemoryTransport(TestCase):
1738
1267
    file defaults for the transport in tests, nor does it obey the command line
1739
1268
    override, so tests that accidentally write to the common directory should
1740
1269
    be rare.
1741
 
 
1742
 
    :cvar TEST_ROOT: Directory containing all temporary directories, plus
1743
 
    a .bzr directory that stops us ascending higher into the filesystem.
1744
1270
    """
1745
1271
 
1746
1272
    TEST_ROOT = None
1747
1273
    _TEST_NAME = 'test'
1748
1274
 
 
1275
 
1749
1276
    def __init__(self, methodName='runTest'):
1750
 
        # allow test parameterization after test construction and before test
1751
 
        # execution. Variables that the parameterizer sets need to be 
 
1277
        # allow test parameterisation after test construction and before test
 
1278
        # execution. Variables that the parameteriser sets need to be 
1752
1279
        # ones that are not set by setUp, or setUp will trash them.
1753
1280
        super(TestCaseWithMemoryTransport, self).__init__(methodName)
1754
 
        self.vfs_transport_factory = default_transport
1755
 
        self.transport_server = None
 
1281
        self.transport_server = default_transport
1756
1282
        self.transport_readonly_server = None
1757
 
        self.__vfs_server = None
1758
 
 
1759
 
    def get_transport(self, relpath=None):
1760
 
        """Return a writeable transport.
1761
 
 
1762
 
        This transport is for the test scratch space relative to
1763
 
        "self._test_root"
1764
 
        
1765
 
        :param relpath: a path relative to the base url.
1766
 
        """
1767
 
        t = get_transport(self.get_url(relpath))
 
1283
 
 
1284
    def get_transport(self):
 
1285
        """Return a writeable transport for the test scratch space"""
 
1286
        t = get_transport(self.get_url())
1768
1287
        self.assertFalse(t.is_readonly())
1769
1288
        return t
1770
1289
 
1771
 
    def get_readonly_transport(self, relpath=None):
 
1290
    def get_readonly_transport(self):
1772
1291
        """Return a readonly transport for the test scratch space
1773
1292
        
1774
1293
        This can be used to test that operations which should only need
1775
1294
        readonly access in fact do not try to write.
1776
 
 
1777
 
        :param relpath: a path relative to the base url.
1778
1295
        """
1779
 
        t = get_transport(self.get_readonly_url(relpath))
 
1296
        t = get_transport(self.get_readonly_url())
1780
1297
        self.assertTrue(t.is_readonly())
1781
1298
        return t
1782
1299
 
1796
1313
            if self.transport_readonly_server is None:
1797
1314
                # readonly decorator requested
1798
1315
                # bring up the server
 
1316
                self.get_url()
1799
1317
                self.__readonly_server = ReadonlyServer()
1800
 
                self.__readonly_server.setUp(self.get_vfs_only_server())
 
1318
                self.__readonly_server.setUp(self.__server)
1801
1319
            else:
1802
1320
                self.__readonly_server = self.create_transport_readonly_server()
1803
 
                self.__readonly_server.setUp(self.get_vfs_only_server())
 
1321
                self.__readonly_server.setUp()
1804
1322
            self.addCleanup(self.__readonly_server.tearDown)
1805
1323
        return self.__readonly_server
1806
1324
 
1813
1331
        These should only be downwards relative, not upwards.
1814
1332
        """
1815
1333
        base = self.get_readonly_server().get_url()
1816
 
        return self._adjust_url(base, relpath)
 
1334
        if relpath is not None:
 
1335
            if not base.endswith('/'):
 
1336
                base = base + '/'
 
1337
            base = base + relpath
 
1338
        return base
1817
1339
 
1818
 
    def get_vfs_only_server(self):
1819
 
        """Get the vfs only read/write server instance.
 
1340
    def get_server(self):
 
1341
        """Get the read/write server instance.
1820
1342
 
1821
1343
        This is useful for some tests with specific servers that need
1822
1344
        diagnostics.
1824
1346
        For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1825
1347
        is no means to override it.
1826
1348
        """
1827
 
        if self.__vfs_server is None:
1828
 
            self.__vfs_server = MemoryServer()
1829
 
            self.__vfs_server.setUp()
1830
 
            self.addCleanup(self.__vfs_server.tearDown)
1831
 
        return self.__vfs_server
1832
 
 
1833
 
    def get_server(self):
1834
 
        """Get the read/write server instance.
1835
 
 
1836
 
        This is useful for some tests with specific servers that need
1837
 
        diagnostics.
1838
 
 
1839
 
        This is built from the self.transport_server factory. If that is None,
1840
 
        then the self.get_vfs_server is returned.
1841
 
        """
1842
1349
        if self.__server is None:
1843
 
            if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1844
 
                return self.get_vfs_only_server()
1845
 
            else:
1846
 
                # bring up a decorated means of access to the vfs only server.
1847
 
                self.__server = self.transport_server()
1848
 
                try:
1849
 
                    self.__server.setUp(self.get_vfs_only_server())
1850
 
                except TypeError, e:
1851
 
                    # This should never happen; the try:Except here is to assist
1852
 
                    # developers having to update code rather than seeing an
1853
 
                    # uninformative TypeError.
1854
 
                    raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
 
1350
            self.__server = MemoryServer()
 
1351
            self.__server.setUp()
1855
1352
            self.addCleanup(self.__server.tearDown)
1856
1353
        return self.__server
1857
1354
 
1858
 
    def _adjust_url(self, base, relpath):
 
1355
    def get_url(self, relpath=None):
1859
1356
        """Get a URL (or maybe a path) for the readwrite transport.
1860
1357
 
1861
1358
        This will either be backed by '.' or to an equivalent non-file based
1863
1360
        relpath provides for clients to get a path relative to the base url.
1864
1361
        These should only be downwards relative, not upwards.
1865
1362
        """
 
1363
        base = self.get_server().get_url()
1866
1364
        if relpath is not None and relpath != '.':
1867
1365
            if not base.endswith('/'):
1868
1366
                base = base + '/'
1876
1374
                base += urlutils.escape(relpath)
1877
1375
        return base
1878
1376
 
1879
 
    def get_url(self, relpath=None):
1880
 
        """Get a URL (or maybe a path) for the readwrite transport.
1881
 
 
1882
 
        This will either be backed by '.' or to an equivalent non-file based
1883
 
        facility.
1884
 
        relpath provides for clients to get a path relative to the base url.
1885
 
        These should only be downwards relative, not upwards.
1886
 
        """
1887
 
        base = self.get_server().get_url()
1888
 
        return self._adjust_url(base, relpath)
1889
 
 
1890
 
    def get_vfs_only_url(self, relpath=None):
1891
 
        """Get a URL (or maybe a path for the plain old vfs transport.
1892
 
 
1893
 
        This will never be a smart protocol.  It always has all the
1894
 
        capabilities of the local filesystem, but it might actually be a
1895
 
        MemoryTransport or some other similar virtual filesystem.
1896
 
 
1897
 
        This is the backing transport (if any) of the server returned by
1898
 
        get_url and get_readonly_url.
1899
 
 
1900
 
        :param relpath: provides for clients to get a path relative to the base
1901
 
            url.  These should only be downwards relative, not upwards.
1902
 
        :return: A URL
1903
 
        """
1904
 
        base = self.get_vfs_only_server().get_url()
1905
 
        return self._adjust_url(base, relpath)
1906
 
 
1907
 
    def _create_safety_net(self):
1908
 
        """Make a fake bzr directory.
1909
 
 
1910
 
        This prevents any tests propagating up onto the TEST_ROOT directory's
1911
 
        real branch.
1912
 
        """
1913
 
        root = TestCaseWithMemoryTransport.TEST_ROOT
1914
 
        bzrdir.BzrDir.create_standalone_workingtree(root)
1915
 
 
1916
 
    def _check_safety_net(self):
1917
 
        """Check that the safety .bzr directory have not been touched.
1918
 
 
1919
 
        _make_test_root have created a .bzr directory to prevent tests from
1920
 
        propagating. This method ensures than a test did not leaked.
1921
 
        """
1922
 
        root = TestCaseWithMemoryTransport.TEST_ROOT
1923
 
        wt = workingtree.WorkingTree.open(root)
1924
 
        last_rev = wt.last_revision()
1925
 
        if last_rev != 'null:':
1926
 
            # The current test have modified the /bzr directory, we need to
1927
 
            # recreate a new one or all the followng tests will fail.
1928
 
            # If you need to inspect its content uncomment the following line
1929
 
            # import pdb; pdb.set_trace()
1930
 
            _rmtree_temp_dir(root + '/.bzr')
1931
 
            self._create_safety_net()
1932
 
            raise AssertionError('%s/.bzr should not be modified' % root)
1933
 
 
1934
1377
    def _make_test_root(self):
1935
 
        if TestCaseWithMemoryTransport.TEST_ROOT is None:
1936
 
            root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1937
 
            TestCaseWithMemoryTransport.TEST_ROOT = root
1938
 
 
1939
 
            self._create_safety_net()
1940
 
 
1941
 
            # The same directory is used by all tests, and we're not
1942
 
            # specifically told when all tests are finished.  This will do.
1943
 
            atexit.register(_rmtree_temp_dir, root)
1944
 
 
1945
 
        self.addCleanup(self._check_safety_net)
 
1378
        if TestCaseWithMemoryTransport.TEST_ROOT is not None:
 
1379
            return
 
1380
        i = 0
 
1381
        while True:
 
1382
            root = u'test%04d.tmp' % i
 
1383
            try:
 
1384
                os.mkdir(root)
 
1385
            except OSError, e:
 
1386
                if e.errno == errno.EEXIST:
 
1387
                    i += 1
 
1388
                    continue
 
1389
                else:
 
1390
                    raise
 
1391
            # successfully created
 
1392
            TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
 
1393
            break
 
1394
        # make a fake bzr directory there to prevent any tests propagating
 
1395
        # up onto the source directory's real branch
 
1396
        bzrdir.BzrDir.create_standalone_workingtree(
 
1397
            TestCaseWithMemoryTransport.TEST_ROOT)
1946
1398
 
1947
1399
    def makeAndChdirToTestDir(self):
1948
1400
        """Create a temporary directories for this one test.
1968
1420
            segments = maybe_a_url.rsplit('/', 1)
1969
1421
            t = get_transport(maybe_a_url)
1970
1422
            if len(segments) > 1 and segments[-1] not in ('', '.'):
1971
 
                t.ensure_base()
1972
 
            if format is None:
1973
 
                format = 'default'
 
1423
                try:
 
1424
                    t.mkdir('.')
 
1425
                except errors.FileExists:
 
1426
                    pass
1974
1427
            if isinstance(format, basestring):
1975
1428
                format = bzrdir.format_registry.make_bzrdir(format)
 
1429
            elif format is None:
 
1430
                format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
1976
1431
            return format.initialize_on_transport(t)
1977
1432
        except errors.UninitializableFormat:
1978
1433
            raise TestSkipped("Format %s is not initializable." % format)
1979
1434
 
1980
1435
    def make_repository(self, relpath, shared=False, format=None):
1981
 
        """Create a repository on our default transport at relpath.
1982
 
        
1983
 
        Note that relpath must be a relative path, not a full url.
1984
 
        """
1985
 
        # FIXME: If you create a remoterepository this returns the underlying
1986
 
        # real format, which is incorrect.  Actually we should make sure that 
1987
 
        # RemoteBzrDir returns a RemoteRepository.
1988
 
        # maybe  mbp 20070410
 
1436
        """Create a repository on our default transport at relpath."""
1989
1437
        made_control = self.make_bzrdir(relpath, format=format)
1990
1438
        return made_control.create_repository(shared=shared)
1991
1439
 
1994
1442
        b = self.make_branch(relpath, format=format)
1995
1443
        return memorytree.MemoryTree.create_on_branch(b)
1996
1444
 
1997
 
    def make_branch_builder(self, relpath, format=None):
1998
 
        url = self.get_url(relpath)
1999
 
        tran = get_transport(url)
2000
 
        return branchbuilder.BranchBuilder(get_transport(url), format=format)
2001
 
 
2002
1445
    def overrideEnvironmentForTesting(self):
2003
1446
        os.environ['HOME'] = self.test_home_dir
2004
 
        os.environ['BZR_HOME'] = self.test_home_dir
 
1447
        os.environ['APPDATA'] = self.test_home_dir
2005
1448
        
2006
1449
    def setUp(self):
2007
1450
        super(TestCaseWithMemoryTransport, self).setUp()
2014
1457
        self.overrideEnvironmentForTesting()
2015
1458
        self.__readonly_server = None
2016
1459
        self.__server = None
2017
 
        self.reduceLockdirTimeout()
2018
1460
 
2019
1461
     
2020
1462
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2027
1469
    All test cases create their own directory within that.  If the
2028
1470
    tests complete successfully, the directory is removed.
2029
1471
 
2030
 
    :ivar test_base_dir: The path of the top-level directory for this 
2031
 
    test, which contains a home directory and a work directory.
2032
 
 
2033
 
    :ivar test_home_dir: An initially empty directory under test_base_dir
2034
 
    which is used as $HOME for this test.
2035
 
 
2036
 
    :ivar test_dir: A directory under test_base_dir used as the current
2037
 
    directory when the test proper is run.
 
1472
    InTempDir is an old alias for FunctionalTestCase.
2038
1473
    """
2039
1474
 
2040
1475
    OVERRIDE_PYTHON = 'python'
2047
1482
            self.log("actually: %r" % contents)
2048
1483
            self.fail("contents of %s not as expected" % filename)
2049
1484
 
2050
 
    def _getTestDirPrefix(self):
2051
 
        # create a directory within the top level test directory
2052
 
        if sys.platform == 'win32':
2053
 
            name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2054
 
            # windows is likely to have path-length limits so use a short name
2055
 
            name_prefix = name_prefix[-30:]
2056
 
        else:
2057
 
            name_prefix = re.sub('[/]', '_', self.id())
2058
 
        return name_prefix
2059
 
 
2060
1485
    def makeAndChdirToTestDir(self):
2061
1486
        """See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2062
1487
        
2063
1488
        For TestCaseInTempDir we create a temporary directory based on the test
2064
1489
        name and then create two subdirs - test and home under it.
2065
1490
        """
2066
 
        name_prefix = os.path.join(self.TEST_ROOT, self._getTestDirPrefix())
2067
 
        name = name_prefix
2068
 
        for i in range(100):
2069
 
            if os.path.exists(name):
2070
 
                name = name_prefix + '_' + str(i)
2071
 
            else:
2072
 
                os.mkdir(name)
 
1491
        # shorten the name, to avoid test failures due to path length
 
1492
        short_id = self.id().replace('bzrlib.tests.', '') \
 
1493
                   .replace('__main__.', '')[-100:]
 
1494
        # it's possible the same test class is run several times for
 
1495
        # parameterized tests, so make sure the names don't collide.  
 
1496
        i = 0
 
1497
        while True:
 
1498
            if i > 0:
 
1499
                candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
 
1500
            else:
 
1501
                candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
 
1502
            if os.path.exists(candidate_dir):
 
1503
                i = i + 1
 
1504
                continue
 
1505
            else:
 
1506
                os.mkdir(candidate_dir)
 
1507
                self.test_home_dir = candidate_dir + '/home'
 
1508
                os.mkdir(self.test_home_dir)
 
1509
                self.test_dir = candidate_dir + '/work'
 
1510
                os.mkdir(self.test_dir)
 
1511
                os.chdir(self.test_dir)
2073
1512
                break
2074
 
        # now create test and home directories within this dir
2075
 
        self.test_base_dir = name
2076
 
        self.test_home_dir = self.test_base_dir + '/home'
2077
 
        os.mkdir(self.test_home_dir)
2078
 
        self.test_dir = self.test_base_dir + '/work'
2079
 
        os.mkdir(self.test_dir)
2080
 
        os.chdir(self.test_dir)
2081
 
        # put name of test inside
2082
 
        f = file(self.test_base_dir + '/name', 'w')
2083
 
        try:
2084
 
            f.write(self.id())
2085
 
        finally:
2086
 
            f.close()
2087
 
        self.addCleanup(self.deleteTestDir)
2088
 
 
2089
 
    def deleteTestDir(self):
2090
 
        os.chdir(self.TEST_ROOT)
2091
 
        _rmtree_temp_dir(self.test_base_dir)
2092
1513
 
2093
1514
    def build_tree(self, shape, line_endings='binary', transport=None):
2094
1515
        """Build a test tree according to a pattern.
2099
1520
        This assumes that all the elements in the tree being built are new.
2100
1521
 
2101
1522
        This doesn't add anything to a branch.
2102
 
 
2103
 
        :type shape:    list or tuple.
2104
1523
        :param line_endings: Either 'binary' or 'native'
2105
 
            in binary mode, exact contents are written in native mode, the
2106
 
            line endings match the default platform endings.
2107
 
        :param transport: A transport to write to, for building trees on VFS's.
2108
 
            If the transport is readonly or None, "." is opened automatically.
2109
 
        :return: None
 
1524
                             in binary mode, exact contents are written
 
1525
                             in native mode, the line endings match the
 
1526
                             default platform endings.
 
1527
 
 
1528
        :param transport: A transport to write to, for building trees on 
 
1529
                          VFS's. If the transport is readonly or None,
 
1530
                          "." is opened automatically.
2110
1531
        """
2111
 
        if type(shape) not in (list, tuple):
2112
 
            raise AssertionError("Parameter 'shape' should be "
2113
 
                "a list or a tuple. Got %r instead" % (shape,))
2114
1532
        # It's OK to just create them using forward slashes on windows.
2115
1533
        if transport is None or transport.is_readonly():
2116
1534
            transport = get_transport(".")
2132
1550
    def build_tree_contents(self, shape):
2133
1551
        build_tree_contents(shape)
2134
1552
 
2135
 
    def assertInWorkingTree(self, path, root_path='.', tree=None):
2136
 
        """Assert whether path or paths are in the WorkingTree"""
2137
 
        if tree is None:
2138
 
            tree = workingtree.WorkingTree.open(root_path)
2139
 
        if not isinstance(path, basestring):
2140
 
            for p in path:
2141
 
                self.assertInWorkingTree(p, tree=tree)
2142
 
        else:
2143
 
            self.assertIsNot(tree.path2id(path), None,
2144
 
                path+' not in working tree.')
2145
 
 
2146
 
    def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2147
 
        """Assert whether path or paths are not in the WorkingTree"""
2148
 
        if tree is None:
2149
 
            tree = workingtree.WorkingTree.open(root_path)
2150
 
        if not isinstance(path, basestring):
2151
 
            for p in path:
2152
 
                self.assertNotInWorkingTree(p,tree=tree)
2153
 
        else:
2154
 
            self.assertIs(tree.path2id(path), None, path+' in working tree.')
 
1553
    def assertFileEqual(self, content, path):
 
1554
        """Fail if path does not contain 'content'."""
 
1555
        self.failUnlessExists(path)
 
1556
        # TODO: jam 20060427 Shouldn't this be 'rb'?
 
1557
        self.assertEqualDiff(content, open(path, 'r').read())
 
1558
 
 
1559
    def failUnlessExists(self, path):
 
1560
        """Fail unless path, which may be abs or relative, exists."""
 
1561
        self.failUnless(osutils.lexists(path),path+" does not exist")
 
1562
 
 
1563
    def failIfExists(self, path):
 
1564
        """Fail if path, which may be abs or relative, exists."""
 
1565
        self.failIf(osutils.lexists(path),path+" exists")
2155
1566
 
2156
1567
 
2157
1568
class TestCaseWithTransport(TestCaseInTempDir):
2168
1579
    readwrite one must both define get_url() as resolving to os.getcwd().
2169
1580
    """
2170
1581
 
2171
 
    def get_vfs_only_server(self):
 
1582
    def create_transport_server(self):
 
1583
        """Create a transport server from class defined at init.
 
1584
 
 
1585
        This is mostly a hook for daughter classes.
 
1586
        """
 
1587
        return self.transport_server()
 
1588
 
 
1589
    def get_server(self):
2172
1590
        """See TestCaseWithMemoryTransport.
2173
1591
 
2174
1592
        This is useful for some tests with specific servers that need
2175
1593
        diagnostics.
2176
1594
        """
2177
 
        if self.__vfs_server is None:
2178
 
            self.__vfs_server = self.vfs_transport_factory()
2179
 
            self.__vfs_server.setUp()
2180
 
            self.addCleanup(self.__vfs_server.tearDown)
2181
 
        return self.__vfs_server
 
1595
        if self.__server is None:
 
1596
            self.__server = self.create_transport_server()
 
1597
            self.__server.setUp()
 
1598
            self.addCleanup(self.__server.tearDown)
 
1599
        return self.__server
2182
1600
 
2183
1601
    def make_branch_and_tree(self, relpath, format=None):
2184
1602
        """Create a branch on the transport and a tree locally.
2185
1603
 
2186
1604
        If the transport is not a LocalTransport, the Tree can't be created on
2187
 
        the transport.  In that case if the vfs_transport_factory is
2188
 
        LocalURLServer the working tree is created in the local
2189
 
        directory backing the transport, and the returned tree's branch and
2190
 
        repository will also be accessed locally. Otherwise a lightweight
2191
 
        checkout is created and returned.
 
1605
        the transport.  In that case the working tree is created in the local
 
1606
        directory, and the returned tree's branch and repository will also be
 
1607
        accessed locally.
 
1608
 
 
1609
        This will fail if the original default transport for this test
 
1610
        case wasn't backed by the working directory, as the branch won't
 
1611
        be on disk for us to open it.  
2192
1612
 
2193
1613
        :param format: The BzrDirFormat.
2194
1614
        :returns: the WorkingTree.
2202
1622
            return b.bzrdir.create_workingtree()
2203
1623
        except errors.NotLocalUrl:
2204
1624
            # We can only make working trees locally at the moment.  If the
2205
 
            # transport can't support them, then we keep the non-disk-backed
2206
 
            # branch and create a local checkout.
2207
 
            if self.vfs_transport_factory is LocalURLServer:
2208
 
                # the branch is colocated on disk, we cannot create a checkout.
2209
 
                # hopefully callers will expect this.
2210
 
                local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2211
 
                wt = local_controldir.create_workingtree()
2212
 
                if wt.branch._format != b._format:
2213
 
                    wt._branch = b
2214
 
                    # Make sure that assigning to wt._branch fixes wt.branch,
2215
 
                    # in case the implementation details of workingtree objects
2216
 
                    # change.
2217
 
                    self.assertIs(b, wt.branch)
2218
 
                return wt
2219
 
            else:
2220
 
                return b.create_checkout(relpath, lightweight=True)
 
1625
            # transport can't support them, then reopen the branch on a local
 
1626
            # transport, and create the working tree there.  
 
1627
            #
 
1628
            # Possibly we should instead keep
 
1629
            # the non-disk-backed branch and create a local checkout?
 
1630
            bd = bzrdir.BzrDir.open(relpath)
 
1631
            return bd.create_workingtree()
2221
1632
 
2222
1633
    def assertIsDirectory(self, relpath, transport):
2223
1634
        """Assert that relpath within transport is a directory.
2234
1645
            self.fail("path %s is not a directory; has mode %#o"
2235
1646
                      % (relpath, mode))
2236
1647
 
2237
 
    def assertTreesEqual(self, left, right):
2238
 
        """Check that left and right have the same content and properties."""
2239
 
        # we use a tree delta to check for equality of the content, and we
2240
 
        # manually check for equality of other things such as the parents list.
2241
 
        self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2242
 
        differences = left.changes_from(right)
2243
 
        self.assertFalse(differences.has_changed(),
2244
 
            "Trees %r and %r are different: %r" % (left, right, differences))
2245
 
 
2246
1648
    def setUp(self):
2247
1649
        super(TestCaseWithTransport, self).setUp()
2248
 
        self.__vfs_server = None
 
1650
        self.__server = None
2249
1651
 
2250
1652
 
2251
1653
class ChrootedTestCase(TestCaseWithTransport):
2262
1664
 
2263
1665
    def setUp(self):
2264
1666
        super(ChrootedTestCase, self).setUp()
2265
 
        if not self.vfs_transport_factory == MemoryServer:
 
1667
        if not self.transport_server == MemoryServer:
2266
1668
            self.transport_readonly_server = HttpServer
2267
1669
 
2268
1670
 
2269
 
def condition_id_re(pattern):
2270
 
    """Create a condition filter which performs a re check on a test's id.
2271
 
    
2272
 
    :param pattern: A regular expression string.
2273
 
    :return: A callable that returns True if the re matches.
2274
 
    """
2275
 
    filter_re = re.compile(pattern)
2276
 
    def condition(test):
2277
 
        test_id = test.id()
2278
 
        return filter_re.search(test_id)
2279
 
    return condition
2280
 
 
2281
 
 
2282
 
def condition_isinstance(klass_or_klass_list):
2283
 
    """Create a condition filter which returns isinstance(param, klass).
2284
 
    
2285
 
    :return: A callable which when called with one parameter obj return the
2286
 
        result of isinstance(obj, klass_or_klass_list).
2287
 
    """
2288
 
    def condition(obj):
2289
 
        return isinstance(obj, klass_or_klass_list)
2290
 
    return condition
2291
 
 
2292
 
 
2293
 
def condition_id_in_list(id_list):
2294
 
    """Create a condition filter which verify that test's id in a list.
2295
 
    
2296
 
    :param id_list: A TestIdList object.
2297
 
    :return: A callable that returns True if the test's id appears in the list.
2298
 
    """
2299
 
    def condition(test):
2300
 
        return id_list.includes(test.id())
2301
 
    return condition
2302
 
 
2303
 
 
2304
 
def condition_id_startswith(start):
2305
 
    """Create a condition filter verifying that test's id starts with a string.
2306
 
    
2307
 
    :param start: A string.
2308
 
    :return: A callable that returns True if the test's id starts with the
2309
 
        given string.
2310
 
    """
2311
 
    def condition(test):
2312
 
        return test.id().startswith(start)
2313
 
    return condition
2314
 
 
2315
 
 
2316
 
def exclude_tests_by_condition(suite, condition):
2317
 
    """Create a test suite which excludes some tests from suite.
2318
 
 
2319
 
    :param suite: The suite to get tests from.
2320
 
    :param condition: A callable whose result evaluates True when called with a
2321
 
        test case which should be excluded from the result.
2322
 
    :return: A suite which contains the tests found in suite that fail
2323
 
        condition.
2324
 
    """
2325
 
    result = []
2326
 
    for test in iter_suite_tests(suite):
2327
 
        if not condition(test):
2328
 
            result.append(test)
2329
 
    return TestUtil.TestSuite(result)
2330
 
 
2331
 
 
2332
 
def filter_suite_by_condition(suite, condition):
2333
 
    """Create a test suite by filtering another one.
2334
 
    
2335
 
    :param suite: The source suite.
2336
 
    :param condition: A callable whose result evaluates True when called with a
2337
 
        test case which should be included in the result.
2338
 
    :return: A suite which contains the tests found in suite that pass
2339
 
        condition.
2340
 
    """ 
2341
 
    result = []
2342
 
    for test in iter_suite_tests(suite):
2343
 
        if condition(test):
2344
 
            result.append(test)
2345
 
    return TestUtil.TestSuite(result)
2346
 
 
2347
 
 
2348
1671
def filter_suite_by_re(suite, pattern):
2349
 
    """Create a test suite by filtering another one.
2350
 
    
2351
 
    :param suite:           the source suite
2352
 
    :param pattern:         pattern that names must match
2353
 
    :returns: the newly created suite
2354
 
    """ 
2355
 
    condition = condition_id_re(pattern)
2356
 
    result_suite = filter_suite_by_condition(suite, condition)
2357
 
    return result_suite
2358
 
 
2359
 
 
2360
 
def filter_suite_by_id_list(suite, test_id_list):
2361
 
    """Create a test suite by filtering another one.
2362
 
 
2363
 
    :param suite: The source suite.
2364
 
    :param test_id_list: A list of the test ids to keep as strings.
2365
 
    :returns: the newly created suite
2366
 
    """
2367
 
    condition = condition_id_in_list(test_id_list)
2368
 
    result_suite = filter_suite_by_condition(suite, condition)
2369
 
    return result_suite
2370
 
 
2371
 
 
2372
 
def filter_suite_by_id_startswith(suite, start):
2373
 
    """Create a test suite by filtering another one.
2374
 
 
2375
 
    :param suite: The source suite.
2376
 
    :param start: A string the test id must start with.
2377
 
    :returns: the newly created suite
2378
 
    """
2379
 
    condition = condition_id_startswith(start)
2380
 
    result_suite = filter_suite_by_condition(suite, condition)
2381
 
    return result_suite
2382
 
 
2383
 
 
2384
 
def exclude_tests_by_re(suite, pattern):
2385
 
    """Create a test suite which excludes some tests from suite.
2386
 
 
2387
 
    :param suite: The suite to get tests from.
2388
 
    :param pattern: A regular expression string. Test ids that match this
2389
 
        pattern will be excluded from the result.
2390
 
    :return: A TestSuite that contains all the tests from suite without the
2391
 
        tests that matched pattern. The order of tests is the same as it was in
2392
 
        suite.
2393
 
    """
2394
 
    return exclude_tests_by_condition(suite, condition_id_re(pattern))
2395
 
 
2396
 
 
2397
 
def preserve_input(something):
2398
 
    """A helper for performing test suite transformation chains.
2399
 
 
2400
 
    :param something: Anything you want to preserve.
2401
 
    :return: Something.
2402
 
    """
2403
 
    return something
2404
 
 
2405
 
 
2406
 
def randomize_suite(suite):
2407
 
    """Return a new TestSuite with suite's tests in random order.
2408
 
    
2409
 
    The tests in the input suite are flattened into a single suite in order to
2410
 
    accomplish this. Any nested TestSuites are removed to provide global
2411
 
    randomness.
2412
 
    """
2413
 
    tests = list(iter_suite_tests(suite))
2414
 
    random.shuffle(tests)
2415
 
    return TestUtil.TestSuite(tests)
2416
 
 
2417
 
 
2418
 
def split_suite_by_condition(suite, condition):
2419
 
    """Split a test suite into two by a condition.
2420
 
    
2421
 
    :param suite: The suite to split.
2422
 
    :param condition: The condition to match on. Tests that match this
2423
 
        condition are returned in the first test suite, ones that do not match
2424
 
        are in the second suite.
2425
 
    :return: A tuple of two test suites, where the first contains tests from
2426
 
        suite matching the condition, and the second contains the remainder
2427
 
        from suite. The order within each output suite is the same as it was in
2428
 
        suite.
2429
 
    """ 
2430
 
    matched = []
2431
 
    did_not_match = []
2432
 
    for test in iter_suite_tests(suite):
2433
 
        if condition(test):
2434
 
            matched.append(test)
 
1672
    result = TestUtil.TestSuite()
 
1673
    filter_re = re.compile(pattern)
 
1674
    for test in iter_suite_tests(suite):
 
1675
        if filter_re.search(test.id()):
 
1676
            result.addTest(test)
 
1677
    return result
 
1678
 
 
1679
 
 
1680
def sort_suite_by_re(suite, pattern):
 
1681
    first = []
 
1682
    second = []
 
1683
    filter_re = re.compile(pattern)
 
1684
    for test in iter_suite_tests(suite):
 
1685
        if filter_re.search(test.id()):
 
1686
            first.append(test)
2435
1687
        else:
2436
 
            did_not_match.append(test)
2437
 
    return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2438
 
 
2439
 
 
2440
 
def split_suite_by_re(suite, pattern):
2441
 
    """Split a test suite into two by a regular expression.
2442
 
    
2443
 
    :param suite: The suite to split.
2444
 
    :param pattern: A regular expression string. Test ids that match this
2445
 
        pattern will be in the first test suite returned, and the others in the
2446
 
        second test suite returned.
2447
 
    :return: A tuple of two test suites, where the first contains tests from
2448
 
        suite matching pattern, and the second contains the remainder from
2449
 
        suite. The order within each output suite is the same as it was in
2450
 
        suite.
2451
 
    """ 
2452
 
    return split_suite_by_condition(suite, condition_id_re(pattern))
 
1688
            second.append(test)
 
1689
    return TestUtil.TestSuite(first + second)
2453
1690
 
2454
1691
 
2455
1692
def run_suite(suite, name='test', verbose=False, pattern=".*",
2456
 
              stop_on_failure=False,
 
1693
              stop_on_failure=False, keep_output=False,
2457
1694
              transport=None, lsprof_timed=None, bench_history=None,
2458
 
              matching_tests_first=None,
2459
 
              list_only=False,
2460
 
              random_seed=None,
2461
 
              exclude_pattern=None,
2462
 
              strict=False):
 
1695
              matching_tests_first=None):
2463
1696
    TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2464
1697
    if verbose:
2465
1698
        verbosity = 2
2468
1701
    runner = TextTestRunner(stream=sys.stdout,
2469
1702
                            descriptions=0,
2470
1703
                            verbosity=verbosity,
2471
 
                            bench_history=bench_history,
2472
 
                            list_only=list_only,
2473
 
                            )
 
1704
                            keep_output=keep_output,
 
1705
                            bench_history=bench_history)
2474
1706
    runner.stop_on_failure=stop_on_failure
2475
 
    # Initialise the random number generator and display the seed used.
2476
 
    # We convert the seed to a long to make it reuseable across invocations.
2477
 
    random_order = False
2478
 
    if random_seed is not None:
2479
 
        random_order = True
2480
 
        if random_seed == "now":
2481
 
            random_seed = long(time.time())
2482
 
        else:
2483
 
            # Convert the seed to a long if we can
2484
 
            try:
2485
 
                random_seed = long(random_seed)
2486
 
            except:
2487
 
                pass
2488
 
        runner.stream.writeln("Randomizing test order using seed %s\n" %
2489
 
            (random_seed))
2490
 
        random.seed(random_seed)
2491
 
    # Customise the list of tests if requested
2492
 
    if exclude_pattern is not None:
2493
 
        suite = exclude_tests_by_re(suite, exclude_pattern)
2494
 
    if random_order:
2495
 
        order_changer = randomize_suite
2496
 
    else:
2497
 
        order_changer = preserve_input
2498
 
    if pattern != '.*' or random_order:
 
1707
    if pattern != '.*':
2499
1708
        if matching_tests_first:
2500
 
            suites = map(order_changer, split_suite_by_re(suite, pattern))
2501
 
            suite = TestUtil.TestSuite(suites)
 
1709
            suite = sort_suite_by_re(suite, pattern)
2502
1710
        else:
2503
 
            suite = order_changer(filter_suite_by_re(suite, pattern))
2504
 
 
 
1711
            suite = filter_suite_by_re(suite, pattern)
2505
1712
    result = runner.run(suite)
2506
 
 
2507
 
    if strict:
2508
 
        return result.wasStrictlySuccessful()
2509
 
 
2510
1713
    return result.wasSuccessful()
2511
1714
 
2512
1715
 
2513
 
# Controlled by "bzr selftest -E=..." option
2514
 
selftest_debug_flags = set()
2515
 
 
2516
 
 
2517
1716
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
 
1717
             keep_output=False,
2518
1718
             transport=None,
2519
1719
             test_suite_factory=None,
2520
1720
             lsprof_timed=None,
2521
1721
             bench_history=None,
2522
 
             matching_tests_first=None,
2523
 
             list_only=False,
2524
 
             random_seed=None,
2525
 
             exclude_pattern=None,
2526
 
             strict=False,
2527
 
             load_list=None,
2528
 
             debug_flags=None,
2529
 
             starting_with=None,
2530
 
             ):
 
1722
             matching_tests_first=None):
2531
1723
    """Run the whole test suite under the enhanced runner"""
2532
1724
    # XXX: Very ugly way to do this...
2533
1725
    # Disable warning about old formats because we don't want it to disturb
2540
1732
        transport = default_transport
2541
1733
    old_transport = default_transport
2542
1734
    default_transport = transport
2543
 
    global selftest_debug_flags
2544
 
    old_debug_flags = selftest_debug_flags
2545
 
    if debug_flags is not None:
2546
 
        selftest_debug_flags = set(debug_flags)
2547
1735
    try:
2548
 
        if load_list is None:
2549
 
            keep_only = None
2550
 
        else:
2551
 
            keep_only = load_test_id_list(load_list)
2552
1736
        if test_suite_factory is None:
2553
 
            suite = test_suite(keep_only, starting_with)
 
1737
            suite = test_suite()
2554
1738
        else:
2555
1739
            suite = test_suite_factory()
2556
1740
        return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2557
 
                     stop_on_failure=stop_on_failure,
 
1741
                     stop_on_failure=stop_on_failure, keep_output=keep_output,
2558
1742
                     transport=transport,
2559
1743
                     lsprof_timed=lsprof_timed,
2560
1744
                     bench_history=bench_history,
2561
 
                     matching_tests_first=matching_tests_first,
2562
 
                     list_only=list_only,
2563
 
                     random_seed=random_seed,
2564
 
                     exclude_pattern=exclude_pattern,
2565
 
                     strict=strict)
 
1745
                     matching_tests_first=matching_tests_first)
2566
1746
    finally:
2567
1747
        default_transport = old_transport
2568
 
        selftest_debug_flags = old_debug_flags
2569
 
 
2570
 
 
2571
 
def load_test_id_list(file_name):
2572
 
    """Load a test id list from a text file.
2573
 
 
2574
 
    The format is one test id by line.  No special care is taken to impose
2575
 
    strict rules, these test ids are used to filter the test suite so a test id
2576
 
    that do not match an existing test will do no harm. This allows user to add
2577
 
    comments, leave blank lines, etc.
2578
 
    """
2579
 
    test_list = []
2580
 
    try:
2581
 
        ftest = open(file_name, 'rt')
2582
 
    except IOError, e:
2583
 
        if e.errno != errno.ENOENT:
2584
 
            raise
2585
 
        else:
2586
 
            raise errors.NoSuchFile(file_name)
2587
 
 
2588
 
    for test_name in ftest.readlines():
2589
 
        test_list.append(test_name.strip())
2590
 
    ftest.close()
2591
 
    return test_list
2592
 
 
2593
 
 
2594
 
def suite_matches_id_list(test_suite, id_list):
2595
 
    """Warns about tests not appearing or appearing more than once.
2596
 
 
2597
 
    :param test_suite: A TestSuite object.
2598
 
    :param test_id_list: The list of test ids that should be found in 
2599
 
         test_suite.
2600
 
 
2601
 
    :return: (absents, duplicates) absents is a list containing the test found
2602
 
        in id_list but not in test_suite, duplicates is a list containing the
2603
 
        test found multiple times in test_suite.
2604
 
 
2605
 
    When using a prefined test id list, it may occurs that some tests do not
2606
 
    exist anymore or that some tests use the same id. This function warns the
2607
 
    tester about potential problems in his workflow (test lists are volatile)
2608
 
    or in the test suite itself (using the same id for several tests does not
2609
 
    help to localize defects).
2610
 
    """
2611
 
    # Build a dict counting id occurrences
2612
 
    tests = dict()
2613
 
    for test in iter_suite_tests(test_suite):
2614
 
        id = test.id()
2615
 
        tests[id] = tests.get(id, 0) + 1
2616
 
 
2617
 
    not_found = []
2618
 
    duplicates = []
2619
 
    for id in id_list:
2620
 
        occurs = tests.get(id, 0)
2621
 
        if not occurs:
2622
 
            not_found.append(id)
2623
 
        elif occurs > 1:
2624
 
            duplicates.append(id)
2625
 
 
2626
 
    return not_found, duplicates
2627
 
 
2628
 
 
2629
 
class TestIdList(object):
2630
 
    """Test id list to filter a test suite.
2631
 
 
2632
 
    Relying on the assumption that test ids are built as:
2633
 
    <module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2634
 
    notation, this class offers methods to :
2635
 
    - avoid building a test suite for modules not refered to in the test list,
2636
 
    - keep only the tests listed from the module test suite.
2637
 
    """
2638
 
 
2639
 
    def __init__(self, test_id_list):
2640
 
        # When a test suite needs to be filtered against us we compare test ids
2641
 
        # for equality, so a simple dict offers a quick and simple solution.
2642
 
        self.tests = dict().fromkeys(test_id_list, True)
2643
 
 
2644
 
        # While unittest.TestCase have ids like:
2645
 
        # <module>.<class>.<method>[(<param+)],
2646
 
        # doctest.DocTestCase can have ids like:
2647
 
        # <module>
2648
 
        # <module>.<class>
2649
 
        # <module>.<function>
2650
 
        # <module>.<class>.<method>
2651
 
 
2652
 
        # Since we can't predict a test class from its name only, we settle on
2653
 
        # a simple constraint: a test id always begins with its module name.
2654
 
 
2655
 
        modules = {}
2656
 
        for test_id in test_id_list:
2657
 
            parts = test_id.split('.')
2658
 
            mod_name = parts.pop(0)
2659
 
            modules[mod_name] = True
2660
 
            for part in parts:
2661
 
                mod_name += '.' + part
2662
 
                modules[mod_name] = True
2663
 
        self.modules = modules
2664
 
 
2665
 
    def refers_to(self, module_name):
2666
 
        """Is there tests for the module or one of its sub modules."""
2667
 
        return self.modules.has_key(module_name)
2668
 
 
2669
 
    def includes(self, test_id):
2670
 
        return self.tests.has_key(test_id)
2671
 
 
2672
 
 
2673
 
def test_suite(keep_only=None, starting_with=None):
 
1748
 
 
1749
 
 
1750
def test_suite():
2674
1751
    """Build and return TestSuite for the whole of bzrlib.
2675
 
 
2676
 
    :param keep_only: A list of test ids limiting the suite returned.
2677
 
 
2678
 
    :param starting_with: An id limiting the suite returned to the tests
2679
 
         starting with it.
2680
 
 
 
1752
    
2681
1753
    This function can be replaced if you need to change the default test
2682
1754
    suite on a global basis, but it is not encouraged.
2683
1755
    """
2684
1756
    testmod_names = [
2685
 
                   'bzrlib.doc',
2686
 
                   'bzrlib.util.tests.test_bencode',
2687
 
                   'bzrlib.tests.blackbox',
2688
 
                   'bzrlib.tests.branch_implementations',
2689
 
                   'bzrlib.tests.bzrdir_implementations',
2690
 
                   'bzrlib.tests.commands',
2691
 
                   'bzrlib.tests.inventory_implementations',
2692
 
                   'bzrlib.tests.interrepository_implementations',
2693
 
                   'bzrlib.tests.intertree_implementations',
2694
 
                   'bzrlib.tests.per_lock',
2695
 
                   'bzrlib.tests.repository_implementations',
2696
 
                   'bzrlib.tests.test__dirstate_helpers',
2697
1757
                   'bzrlib.tests.test_ancestry',
2698
1758
                   'bzrlib.tests.test_annotate',
2699
1759
                   'bzrlib.tests.test_api',
2700
1760
                   'bzrlib.tests.test_atomicfile',
2701
1761
                   'bzrlib.tests.test_bad_files',
2702
 
                   'bzrlib.tests.test_bisect_multi',
2703
1762
                   'bzrlib.tests.test_branch',
2704
 
                   'bzrlib.tests.test_branchbuilder',
2705
 
                   'bzrlib.tests.test_bugtracker',
2706
1763
                   'bzrlib.tests.test_bundle',
2707
1764
                   'bzrlib.tests.test_bzrdir',
2708
1765
                   'bzrlib.tests.test_cache_utf8',
2711
1768
                   'bzrlib.tests.test_commit_merge',
2712
1769
                   'bzrlib.tests.test_config',
2713
1770
                   'bzrlib.tests.test_conflicts',
2714
 
                   'bzrlib.tests.test_counted_lock',
2715
1771
                   'bzrlib.tests.test_decorators',
2716
1772
                   'bzrlib.tests.test_delta',
2717
 
                   'bzrlib.tests.test_deprecated_graph',
2718
1773
                   'bzrlib.tests.test_diff',
2719
 
                   'bzrlib.tests.test_dirstate',
2720
 
                   'bzrlib.tests.test_directory_service',
2721
 
                   'bzrlib.tests.test_email_message',
 
1774
                   'bzrlib.tests.test_doc_generate',
2722
1775
                   'bzrlib.tests.test_errors',
2723
 
                   'bzrlib.tests.test_extract',
 
1776
                   'bzrlib.tests.test_escaped_store',
2724
1777
                   'bzrlib.tests.test_fetch',
2725
1778
                   'bzrlib.tests.test_ftp_transport',
2726
1779
                   'bzrlib.tests.test_generate_docs',
2729
1782
                   'bzrlib.tests.test_gpg',
2730
1783
                   'bzrlib.tests.test_graph',
2731
1784
                   'bzrlib.tests.test_hashcache',
2732
 
                   'bzrlib.tests.test_help',
2733
 
                   'bzrlib.tests.test_hooks',
2734
1785
                   'bzrlib.tests.test_http',
2735
 
                   'bzrlib.tests.test_http_implementations',
2736
1786
                   'bzrlib.tests.test_http_response',
2737
 
                   'bzrlib.tests.test_https_ca_bundle',
2738
1787
                   'bzrlib.tests.test_identitymap',
2739
1788
                   'bzrlib.tests.test_ignores',
2740
 
                   'bzrlib.tests.test_index',
2741
 
                   'bzrlib.tests.test_info',
2742
1789
                   'bzrlib.tests.test_inv',
2743
1790
                   'bzrlib.tests.test_knit',
2744
1791
                   'bzrlib.tests.test_lazy_import',
2746
1793
                   'bzrlib.tests.test_lockdir',
2747
1794
                   'bzrlib.tests.test_lockable_files',
2748
1795
                   'bzrlib.tests.test_log',
2749
 
                   'bzrlib.tests.test_lsprof',
2750
 
                   'bzrlib.tests.test_lru_cache',
2751
 
                   'bzrlib.tests.test_mail_client',
2752
1796
                   'bzrlib.tests.test_memorytree',
2753
1797
                   'bzrlib.tests.test_merge',
2754
1798
                   'bzrlib.tests.test_merge3',
2755
1799
                   'bzrlib.tests.test_merge_core',
2756
 
                   'bzrlib.tests.test_merge_directive',
2757
1800
                   'bzrlib.tests.test_missing',
2758
1801
                   'bzrlib.tests.test_msgeditor',
2759
 
                   'bzrlib.tests.test_multiparent',
2760
 
                   'bzrlib.tests.test_mutabletree',
2761
1802
                   'bzrlib.tests.test_nonascii',
2762
1803
                   'bzrlib.tests.test_options',
2763
1804
                   'bzrlib.tests.test_osutils',
2764
1805
                   'bzrlib.tests.test_osutils_encodings',
2765
 
                   'bzrlib.tests.test_pack',
2766
1806
                   'bzrlib.tests.test_patch',
2767
1807
                   'bzrlib.tests.test_patches',
2768
1808
                   'bzrlib.tests.test_permissions',
2769
1809
                   'bzrlib.tests.test_plugins',
2770
1810
                   'bzrlib.tests.test_progress',
2771
 
                   'bzrlib.tests.test_read_bundle',
2772
 
                   'bzrlib.tests.test_reconfigure',
2773
1811
                   'bzrlib.tests.test_reconcile',
2774
1812
                   'bzrlib.tests.test_registry',
2775
 
                   'bzrlib.tests.test_remote',
2776
1813
                   'bzrlib.tests.test_repository',
2777
 
                   'bzrlib.tests.per_repository_reference',
2778
1814
                   'bzrlib.tests.test_revert',
2779
1815
                   'bzrlib.tests.test_revision',
2780
 
                   'bzrlib.tests.test_revisionspec',
 
1816
                   'bzrlib.tests.test_revisionnamespaces',
2781
1817
                   'bzrlib.tests.test_revisiontree',
2782
1818
                   'bzrlib.tests.test_rio',
2783
 
                   'bzrlib.tests.test_rules',
2784
1819
                   'bzrlib.tests.test_sampler',
2785
1820
                   'bzrlib.tests.test_selftest',
2786
1821
                   'bzrlib.tests.test_setup',
2787
1822
                   'bzrlib.tests.test_sftp_transport',
2788
 
                   'bzrlib.tests.test_smart',
2789
1823
                   'bzrlib.tests.test_smart_add',
2790
1824
                   'bzrlib.tests.test_smart_transport',
2791
 
                   'bzrlib.tests.test_smtp_connection',
2792
1825
                   'bzrlib.tests.test_source',
2793
 
                   'bzrlib.tests.test_ssh_transport',
2794
1826
                   'bzrlib.tests.test_status',
2795
1827
                   'bzrlib.tests.test_store',
2796
 
                   'bzrlib.tests.test_strace',
2797
 
                   'bzrlib.tests.test_subsume',
2798
 
                   'bzrlib.tests.test_switch',
2799
1828
                   'bzrlib.tests.test_symbol_versioning',
2800
 
                   'bzrlib.tests.test_tag',
2801
1829
                   'bzrlib.tests.test_testament',
2802
1830
                   'bzrlib.tests.test_textfile',
2803
1831
                   'bzrlib.tests.test_textmerge',
2804
 
                   'bzrlib.tests.test_timestamp',
2805
1832
                   'bzrlib.tests.test_trace',
2806
1833
                   'bzrlib.tests.test_transactions',
2807
1834
                   'bzrlib.tests.test_transform',
2808
1835
                   'bzrlib.tests.test_transport',
2809
 
                   'bzrlib.tests.test_transport_implementations',
2810
1836
                   'bzrlib.tests.test_tree',
2811
1837
                   'bzrlib.tests.test_treebuilder',
2812
1838
                   'bzrlib.tests.test_tsort',
2813
1839
                   'bzrlib.tests.test_tuned_gzip',
2814
1840
                   'bzrlib.tests.test_ui',
2815
 
                   'bzrlib.tests.test_uncommit',
2816
1841
                   'bzrlib.tests.test_upgrade',
2817
1842
                   'bzrlib.tests.test_urlutils',
2818
1843
                   'bzrlib.tests.test_versionedfile',
2819
1844
                   'bzrlib.tests.test_version',
2820
1845
                   'bzrlib.tests.test_version_info',
2821
 
                   'bzrlib.tests.test__walkdirs_win32',
2822
1846
                   'bzrlib.tests.test_weave',
2823
1847
                   'bzrlib.tests.test_whitebox',
2824
 
                   'bzrlib.tests.test_win32utils',
2825
1848
                   'bzrlib.tests.test_workingtree',
2826
 
                   'bzrlib.tests.test_workingtree_4',
2827
1849
                   'bzrlib.tests.test_wsgi',
2828
1850
                   'bzrlib.tests.test_xml',
2829
 
                   'bzrlib.tests.tree_implementations',
2830
 
                   'bzrlib.tests.workingtree_implementations',
2831
1851
                   ]
2832
 
 
 
1852
    test_transport_implementations = [
 
1853
        'bzrlib.tests.test_transport_implementations',
 
1854
        'bzrlib.tests.test_read_bundle',
 
1855
        ]
 
1856
    suite = TestUtil.TestSuite()
2833
1857
    loader = TestUtil.TestLoader()
2834
 
 
2835
 
    if starting_with is not None:
2836
 
        # We take precedence over keep_only because *at loading time* using
2837
 
        # both options means we will load less tests for the same final result.
2838
 
        def interesting_module(name):
2839
 
            return (
2840
 
                # Either the module name starts with the specified string
2841
 
                name.startswith(starting_with)
2842
 
                # or it may contain tests starting with the specified string
2843
 
                or starting_with.startswith(name)
2844
 
                )
2845
 
        loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
2846
 
 
2847
 
    elif keep_only is not None:
2848
 
        id_filter = TestIdList(keep_only)
2849
 
        loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2850
 
        def interesting_module(name):
2851
 
            return id_filter.refers_to(name)
2852
 
 
2853
 
    else:
2854
 
        loader = TestUtil.TestLoader()
2855
 
        def interesting_module(name):
2856
 
            # No filtering, all modules are interesting
2857
 
            return True
2858
 
 
2859
 
    suite = loader.suiteClass()
2860
 
 
2861
 
    # modules building their suite with loadTestsFromModuleNames
2862
1858
    suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2863
 
 
2864
 
    modules_to_doctest = [
2865
 
        'bzrlib',
2866
 
        'bzrlib.errors',
2867
 
        'bzrlib.export',
2868
 
        'bzrlib.inventory',
2869
 
        'bzrlib.iterablefile',
2870
 
        'bzrlib.lockdir',
2871
 
        'bzrlib.merge3',
2872
 
        'bzrlib.option',
2873
 
        'bzrlib.store',
2874
 
        'bzrlib.symbol_versioning',
2875
 
        'bzrlib.tests',
2876
 
        'bzrlib.timestamp',
2877
 
        'bzrlib.version_info_formats.format_custom',
2878
 
        ]
2879
 
 
2880
 
    for mod in modules_to_doctest:
2881
 
        if not interesting_module(mod):
2882
 
            # No tests to keep here, move along
2883
 
            continue
 
1859
    from bzrlib.transport import TransportTestProviderAdapter
 
1860
    adapter = TransportTestProviderAdapter()
 
1861
    adapt_modules(test_transport_implementations, adapter, loader, suite)
 
1862
    for package in packages_to_test():
 
1863
        suite.addTest(package.test_suite())
 
1864
    for m in MODULES_TO_TEST:
 
1865
        suite.addTest(loader.loadTestsFromModule(m))
 
1866
    for m in MODULES_TO_DOCTEST:
2884
1867
        try:
2885
 
            doc_suite = doctest.DocTestSuite(mod)
 
1868
            suite.addTest(doctest.DocTestSuite(m))
2886
1869
        except ValueError, e:
2887
 
            print '**failed to get doctest for: %s\n%s' % (mod, e)
 
1870
            print '**failed to get doctest for: %s\n%s' %(m,e)
2888
1871
            raise
2889
 
        suite.addTest(doc_suite)
2890
 
 
2891
 
    default_encoding = sys.getdefaultencoding()
2892
 
    for name, plugin in bzrlib.plugin.plugins().items():
2893
 
        if not interesting_module(plugin.module.__name__):
2894
 
            continue
2895
 
        plugin_suite = plugin.test_suite()
2896
 
        # We used to catch ImportError here and turn it into just a warning,
2897
 
        # but really if you don't have --no-plugins this should be a failure.
2898
 
        # mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
2899
 
        if plugin_suite is None:
2900
 
            plugin_suite = plugin.load_plugin_tests(loader)
2901
 
        if plugin_suite is not None:
2902
 
            suite.addTest(plugin_suite)
2903
 
        if default_encoding != sys.getdefaultencoding():
2904
 
            bzrlib.trace.warning(
2905
 
                'Plugin "%s" tried to reset default encoding to: %s', name,
2906
 
                sys.getdefaultencoding())
2907
 
            reload(sys)
2908
 
            sys.setdefaultencoding(default_encoding)
2909
 
 
2910
 
    if starting_with is not None:
2911
 
        suite = filter_suite_by_id_startswith(suite, starting_with)
2912
 
 
2913
 
    if keep_only is not None:
2914
 
        # Now that the referred modules have loaded their tests, keep only the
2915
 
        # requested ones.
2916
 
        suite = filter_suite_by_id_list(suite, id_filter)
2917
 
        # Do some sanity checks on the id_list filtering
2918
 
        not_found, duplicates = suite_matches_id_list(suite, keep_only)
2919
 
        if starting_with is not None:
2920
 
            # The tester has used both keep_only and starting_with, so he is
2921
 
            # already aware that some tests are excluded from the list, there
2922
 
            # is no need to tell him which.
2923
 
            pass
2924
 
        else:
2925
 
            # Some tests mentioned in the list are not in the test suite. The
2926
 
            # list may be out of date, report to the tester.
2927
 
            for id in not_found:
2928
 
                bzrlib.trace.warning('"%s" not found in the test suite', id)
2929
 
        for id in duplicates:
2930
 
            bzrlib.trace.warning('"%s" is used as an id by several tests', id)
2931
 
 
2932
 
    return suite
2933
 
 
2934
 
 
2935
 
def multiply_tests_from_modules(module_name_list, scenario_iter, loader=None):
2936
 
    """Adapt all tests in some given modules to given scenarios.
2937
 
 
2938
 
    This is the recommended public interface for test parameterization.
2939
 
    Typically the test_suite() method for a per-implementation test
2940
 
    suite will call multiply_tests_from_modules and return the 
2941
 
    result.
2942
 
 
2943
 
    :param module_name_list: List of fully-qualified names of test
2944
 
        modules.
2945
 
    :param scenario_iter: Iterable of pairs of (scenario_name, 
2946
 
        scenario_param_dict).
2947
 
    :param loader: If provided, will be used instead of a new 
2948
 
        bzrlib.tests.TestLoader() instance.
2949
 
 
2950
 
    This returns a new TestSuite containing the cross product of
2951
 
    all the tests in all the modules, each repeated for each scenario.
2952
 
    Each test is adapted by adding the scenario name at the end 
2953
 
    of its name, and updating the test object's __dict__ with the
2954
 
    scenario_param_dict.
2955
 
 
2956
 
    >>> r = multiply_tests_from_modules(
2957
 
    ...     ['bzrlib.tests.test_sampler'],
2958
 
    ...     [('one', dict(param=1)), 
2959
 
    ...      ('two', dict(param=2))])
2960
 
    >>> tests = list(iter_suite_tests(r))
2961
 
    >>> len(tests)
2962
 
    2
2963
 
    >>> tests[0].id()
2964
 
    'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2965
 
    >>> tests[0].param
2966
 
    1
2967
 
    >>> tests[1].param
2968
 
    2
2969
 
    """
2970
 
    # XXX: Isn't load_tests() a better way to provide the same functionality
2971
 
    # without forcing a predefined TestScenarioApplier ? --vila 080215
2972
 
    if loader is None:
2973
 
        loader = TestUtil.TestLoader()
2974
 
 
2975
 
    suite = loader.suiteClass()
2976
 
 
2977
 
    adapter = TestScenarioApplier()
2978
 
    adapter.scenarios = list(scenario_iter)
2979
 
    adapt_modules(module_name_list, adapter, loader, suite)
2980
 
    return suite
2981
 
 
2982
 
 
2983
 
def multiply_scenarios(scenarios_left, scenarios_right):
2984
 
    """Multiply two sets of scenarios.
2985
 
 
2986
 
    :returns: the cartesian product of the two sets of scenarios, that is
2987
 
        a scenario for every possible combination of a left scenario and a
2988
 
        right scenario.
2989
 
    """
2990
 
    return [
2991
 
        ('%s,%s' % (left_name, right_name),
2992
 
         dict(left_dict.items() + right_dict.items()))
2993
 
        for left_name, left_dict in scenarios_left
2994
 
        for right_name, right_dict in scenarios_right]
2995
 
 
 
1872
    for name, plugin in bzrlib.plugin.all_plugins().items():
 
1873
        if getattr(plugin, 'test_suite', None) is not None:
 
1874
            suite.addTest(plugin.test_suite())
 
1875
    return suite
2996
1876
 
2997
1877
 
2998
1878
def adapt_modules(mods_list, adapter, loader, suite):
2999
1879
    """Adapt the modules in mods_list using adapter and add to suite."""
3000
 
    tests = loader.loadTestsFromModuleNames(mods_list)
3001
 
    adapt_tests(tests, adapter, suite)
3002
 
 
3003
 
 
3004
 
def adapt_tests(tests_list, adapter, suite):
3005
 
    """Adapt the tests in tests_list using adapter and add to suite."""
3006
 
    for test in iter_suite_tests(tests_list):
 
1880
    for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
3007
1881
        suite.addTests(adapter.adapt(test))
3008
1882
 
3009
1883
 
3010
 
def _rmtree_temp_dir(dirname):
3011
 
    # If LANG=C we probably have created some bogus paths
3012
 
    # which rmtree(unicode) will fail to delete
3013
 
    # so make sure we are using rmtree(str) to delete everything
3014
 
    # except on win32, where rmtree(str) will fail
3015
 
    # since it doesn't have the property of byte-stream paths
3016
 
    # (they are either ascii or mbcs)
3017
 
    if sys.platform == 'win32':
3018
 
        # make sure we are using the unicode win32 api
3019
 
        dirname = unicode(dirname)
3020
 
    else:
3021
 
        dirname = dirname.encode(sys.getfilesystemencoding())
3022
 
    try:
3023
 
        osutils.rmtree(dirname)
3024
 
    except OSError, e:
3025
 
        if sys.platform == 'win32' and e.errno == errno.EACCES:
3026
 
            sys.stderr.write(('Permission denied: '
3027
 
                                 'unable to remove testing dir '
3028
 
                                 '%s\n' % os.path.basename(dirname)))
3029
 
        else:
3030
 
            raise
3031
 
 
3032
 
 
3033
 
class Feature(object):
3034
 
    """An operating system Feature."""
3035
 
 
3036
 
    def __init__(self):
3037
 
        self._available = None
3038
 
 
3039
 
    def available(self):
3040
 
        """Is the feature available?
3041
 
 
3042
 
        :return: True if the feature is available.
3043
 
        """
3044
 
        if self._available is None:
3045
 
            self._available = self._probe()
3046
 
        return self._available
3047
 
 
3048
 
    def _probe(self):
3049
 
        """Implement this method in concrete features.
3050
 
 
3051
 
        :return: True if the feature is available.
3052
 
        """
3053
 
        raise NotImplementedError
3054
 
 
3055
 
    def __str__(self):
3056
 
        if getattr(self, 'feature_name', None):
3057
 
            return self.feature_name()
3058
 
        return self.__class__.__name__
3059
 
 
3060
 
 
3061
 
class _SymlinkFeature(Feature):
3062
 
 
3063
 
    def _probe(self):
3064
 
        return osutils.has_symlinks()
3065
 
 
3066
 
    def feature_name(self):
3067
 
        return 'symlinks'
3068
 
 
3069
 
SymlinkFeature = _SymlinkFeature()
3070
 
 
3071
 
 
3072
 
class _HardlinkFeature(Feature):
3073
 
 
3074
 
    def _probe(self):
3075
 
        return osutils.has_hardlinks()
3076
 
 
3077
 
    def feature_name(self):
3078
 
        return 'hardlinks'
3079
 
 
3080
 
HardlinkFeature = _HardlinkFeature()
3081
 
 
3082
 
 
3083
 
class _OsFifoFeature(Feature):
3084
 
 
3085
 
    def _probe(self):
3086
 
        return getattr(os, 'mkfifo', None)
3087
 
 
3088
 
    def feature_name(self):
3089
 
        return 'filesystem fifos'
3090
 
 
3091
 
OsFifoFeature = _OsFifoFeature()
3092
 
 
3093
 
 
3094
 
class _UnicodeFilenameFeature(Feature):
3095
 
    """Does the filesystem support Unicode filenames?"""
3096
 
 
3097
 
    def _probe(self):
3098
 
        try:
3099
 
            # Check for character combinations unlikely to be covered by any
3100
 
            # single non-unicode encoding. We use the characters
3101
 
            # - greek small letter alpha (U+03B1) and
3102
 
            # - braille pattern dots-123456 (U+283F).
3103
 
            os.stat(u'\u03b1\u283f')
3104
 
        except UnicodeEncodeError:
3105
 
            return False
3106
 
        except (IOError, OSError):
3107
 
            # The filesystem allows the Unicode filename but the file doesn't
3108
 
            # exist.
3109
 
            return True
3110
 
        else:
3111
 
            # The filesystem allows the Unicode filename and the file exists,
3112
 
            # for some reason.
3113
 
            return True
3114
 
 
3115
 
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3116
 
 
3117
 
 
3118
 
class TestScenarioApplier(object):
3119
 
    """A tool to apply scenarios to tests."""
3120
 
 
3121
 
    def adapt(self, test):
3122
 
        """Return a TestSuite containing a copy of test for each scenario."""
3123
 
        result = unittest.TestSuite()
3124
 
        for scenario in self.scenarios:
3125
 
            result.addTest(self.adapt_test_to_scenario(test, scenario))
3126
 
        return result
3127
 
 
3128
 
    def adapt_test_to_scenario(self, test, scenario):
3129
 
        """Copy test and apply scenario to it.
3130
 
 
3131
 
        :param test: A test to adapt.
3132
 
        :param scenario: A tuple describing the scenarion.
3133
 
            The first element of the tuple is the new test id.
3134
 
            The second element is a dict containing attributes to set on the
3135
 
            test.
3136
 
        :return: The adapted test.
3137
 
        """
3138
 
        from copy import deepcopy
3139
 
        new_test = deepcopy(test)
3140
 
        for name, value in scenario[1].items():
3141
 
            setattr(new_test, name, value)
3142
 
        new_id = "%s(%s)" % (new_test.id(), scenario[0])
3143
 
        new_test.id = lambda: new_id
3144
 
        return new_test
3145
 
 
3146
 
 
3147
 
def probe_unicode_in_user_encoding():
3148
 
    """Try to encode several unicode strings to use in unicode-aware tests.
3149
 
    Return first successfull match.
3150
 
 
3151
 
    :return:  (unicode value, encoded plain string value) or (None, None)
3152
 
    """
3153
 
    possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3154
 
    for uni_val in possible_vals:
3155
 
        try:
3156
 
            str_val = uni_val.encode(bzrlib.user_encoding)
3157
 
        except UnicodeEncodeError:
3158
 
            # Try a different character
3159
 
            pass
3160
 
        else:
3161
 
            return uni_val, str_val
3162
 
    return None, None
3163
 
 
3164
 
 
3165
 
def probe_bad_non_ascii(encoding):
3166
 
    """Try to find [bad] character with code [128..255]
3167
 
    that cannot be decoded to unicode in some encoding.
3168
 
    Return None if all non-ascii characters is valid
3169
 
    for given encoding.
3170
 
    """
3171
 
    for i in xrange(128, 256):
3172
 
        char = chr(i)
3173
 
        try:
3174
 
            char.decode(encoding)
3175
 
        except UnicodeDecodeError:
3176
 
            return char
3177
 
    return None
3178
 
 
3179
 
 
3180
 
class _FTPServerFeature(Feature):
3181
 
    """Some tests want an FTP Server, check if one is available.
3182
 
 
3183
 
    Right now, the only way this is available is if 'medusa' is installed.
3184
 
    http://www.amk.ca/python/code/medusa.html
3185
 
    """
3186
 
 
3187
 
    def _probe(self):
3188
 
        try:
3189
 
            import bzrlib.tests.ftp_server
3190
 
            return True
3191
 
        except ImportError:
3192
 
            return False
3193
 
 
3194
 
    def feature_name(self):
3195
 
        return 'FTPServer'
3196
 
 
3197
 
FTPServerFeature = _FTPServerFeature()
3198
 
 
3199
 
 
3200
 
class _UnicodeFilename(Feature):
3201
 
    """Does the filesystem support Unicode filenames?"""
3202
 
 
3203
 
    def _probe(self):
3204
 
        try:
3205
 
            os.stat(u'\u03b1')
3206
 
        except UnicodeEncodeError:
3207
 
            return False
3208
 
        except (IOError, OSError):
3209
 
            # The filesystem allows the Unicode filename but the file doesn't
3210
 
            # exist.
3211
 
            return True
3212
 
        else:
3213
 
            # The filesystem allows the Unicode filename and the file exists,
3214
 
            # for some reason.
3215
 
            return True
3216
 
 
3217
 
UnicodeFilename = _UnicodeFilename()
3218
 
 
3219
 
 
3220
 
class _UTF8Filesystem(Feature):
3221
 
    """Is the filesystem UTF-8?"""
3222
 
 
3223
 
    def _probe(self):
3224
 
        if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3225
 
            return True
3226
 
        return False
3227
 
 
3228
 
UTF8Filesystem = _UTF8Filesystem()
3229
 
 
3230
 
 
3231
 
class _CaseInsensitiveFilesystemFeature(Feature):
3232
 
    """Check if underlined filesystem is case-insensitive
3233
 
    (e.g. on Windows, Cygwin, MacOS)
3234
 
    """
3235
 
 
3236
 
    def _probe(self):
3237
 
        if TestCaseWithMemoryTransport.TEST_ROOT is None:
3238
 
            root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3239
 
            TestCaseWithMemoryTransport.TEST_ROOT = root
3240
 
        else:
3241
 
            root = TestCaseWithMemoryTransport.TEST_ROOT
3242
 
        tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3243
 
            dir=root)
3244
 
        name_a = osutils.pathjoin(tdir, 'a')
3245
 
        name_A = osutils.pathjoin(tdir, 'A')
3246
 
        os.mkdir(name_a)
3247
 
        result = osutils.isdir(name_A)
3248
 
        _rmtree_temp_dir(tdir)
3249
 
        return result
3250
 
 
3251
 
    def feature_name(self):
3252
 
        return 'case-insensitive filesystem'
3253
 
 
3254
 
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
 
1884
def clean_selftest_output(root=None, quiet=False):
 
1885
    """Remove all selftest output directories from root directory.
 
1886
 
 
1887
    :param  root:   root directory for clean
 
1888
                    (if ommitted or None then clean current directory).
 
1889
    :param  quiet:  suppress report about deleting directories
 
1890
    """
 
1891
    import re
 
1892
    import shutil
 
1893
 
 
1894
    re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
 
1895
    if root is None:
 
1896
        root = u'.'
 
1897
    for i in os.listdir(root):
 
1898
        if os.path.isdir(i) and re_dir.match(i):
 
1899
            if not quiet:
 
1900
                print 'delete directory:', i
 
1901
            shutil.rmtree(i)