~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Jelmer Vernooij
  • Date: 2009-01-28 18:42:55 UTC
  • mto: This revision was merged to the branch mainline in revision 3968.
  • Revision ID: jelmer@samba.org-20090128184255-bdmklkvm83ltk191
Update NEWS

Show diffs side-by-side

added added

removed removed

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