~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-10-02 00:43:10 UTC
  • mfrom: (2057.1.1 bzr.dev)
  • Revision ID: pqm@pqm.ubuntu.com-20061002004310-6e09ddd7fd28f71c
Merge in 0.11 NEWS entry.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006 by Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
 
18
# TODO: Perhaps there should be an API to find out if bzr running under the
 
19
# test suite -- some plugins might want to avoid making intrusive changes if
 
20
# this is the case.  However, we want behaviour under to test to diverge as
 
21
# little as possible, so this should be used rarely if it's added at all.
 
22
# (Suggestion from j-a-meinel, 2005-11-24)
 
23
 
 
24
# NOTE: Some classes in here use camelCaseNaming() rather than
 
25
# underscore_naming().  That's for consistency with unittest; it's not the
 
26
# general style of bzrlib.  Please continue that consistency when adding e.g.
 
27
# new assertFoo() methods.
 
28
 
 
29
import codecs
18
30
from cStringIO import StringIO
19
31
import difflib
 
32
import doctest
20
33
import errno
21
34
import logging
22
35
import os
23
36
import re
24
 
import shutil
 
37
import shlex
 
38
import stat
 
39
from subprocess import Popen, PIPE
25
40
import sys
26
41
import tempfile
27
42
import unittest
28
43
import time
29
44
 
 
45
 
 
46
from bzrlib import memorytree
 
47
import bzrlib.branch
 
48
import bzrlib.bzrdir as bzrdir
30
49
import bzrlib.commands
 
50
import bzrlib.bundle.serializer
 
51
import bzrlib.errors as errors
 
52
import bzrlib.export
 
53
import bzrlib.inventory
 
54
import bzrlib.iterablefile
 
55
import bzrlib.lockdir
 
56
try:
 
57
    import bzrlib.lsprof
 
58
except ImportError:
 
59
    # lsprof not available
 
60
    pass
 
61
from bzrlib.merge import merge_inner
 
62
import bzrlib.merge3
 
63
import bzrlib.osutils
 
64
import bzrlib.osutils as osutils
 
65
import bzrlib.plugin
 
66
import bzrlib.progress as progress
 
67
from bzrlib.revision import common_ancestor
 
68
import bzrlib.store
 
69
from bzrlib import symbol_versioning
31
70
import bzrlib.trace
32
 
import bzrlib.fetch
33
 
import bzrlib.osutils as osutils
34
 
from bzrlib.selftest import TestUtil
35
 
from bzrlib.selftest.TestUtil import TestLoader, TestSuite
36
 
from bzrlib.selftest.treeshape import build_tree_contents
 
71
from bzrlib.transport import get_transport
 
72
import bzrlib.transport
 
73
from bzrlib.transport.local import LocalRelpathServer
 
74
from bzrlib.transport.readonly import ReadonlyServer
 
75
from bzrlib.trace import mutter
 
76
from bzrlib.tests import TestUtil
 
77
from bzrlib.tests.TestUtil import (
 
78
                          TestSuite,
 
79
                          TestLoader,
 
80
                          )
 
81
from bzrlib.tests.treeshape import build_tree_contents
 
82
import bzrlib.urlutils as urlutils
 
83
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
 
84
 
 
85
default_transport = LocalRelpathServer
37
86
 
38
87
MODULES_TO_TEST = []
39
 
MODULES_TO_DOCTEST = []
40
 
 
41
 
from logging import debug, warning, error
42
 
 
43
 
 
44
 
 
45
 
class EarlyStoppingTestResultAdapter(object):
46
 
    """An adapter for TestResult to stop at the first first failure or error"""
47
 
 
48
 
    def __init__(self, result):
49
 
        self._result = result
50
 
 
51
 
    def addError(self, test, err):
52
 
        self._result.addError(test, err)
53
 
        self._result.stop()
54
 
 
55
 
    def addFailure(self, test, err):
56
 
        self._result.addFailure(test, err)
57
 
        self._result.stop()
58
 
 
59
 
    def __getattr__(self, name):
60
 
        return getattr(self._result, name)
61
 
 
62
 
    def __setattr__(self, name, value):
63
 
        if name == '_result':
64
 
            object.__setattr__(self, name, value)
65
 
        return setattr(self._result, name, value)
 
88
MODULES_TO_DOCTEST = [
 
89
                      bzrlib.branch,
 
90
                      bzrlib.bundle.serializer,
 
91
                      bzrlib.commands,
 
92
                      bzrlib.errors,
 
93
                      bzrlib.export,
 
94
                      bzrlib.inventory,
 
95
                      bzrlib.iterablefile,
 
96
                      bzrlib.lockdir,
 
97
                      bzrlib.merge3,
 
98
                      bzrlib.option,
 
99
                      bzrlib.osutils,
 
100
                      bzrlib.store,
 
101
                      bzrlib.transport,
 
102
                      ]
 
103
 
 
104
 
 
105
def packages_to_test():
 
106
    """Return a list of packages to test.
 
107
 
 
108
    The packages are not globally imported so that import failures are
 
109
    triggered when running selftest, not when importing the command.
 
110
    """
 
111
    import bzrlib.doc
 
112
    import bzrlib.tests.blackbox
 
113
    import bzrlib.tests.branch_implementations
 
114
    import bzrlib.tests.bzrdir_implementations
 
115
    import bzrlib.tests.interrepository_implementations
 
116
    import bzrlib.tests.interversionedfile_implementations
 
117
    import bzrlib.tests.intertree_implementations
 
118
    import bzrlib.tests.repository_implementations
 
119
    import bzrlib.tests.revisionstore_implementations
 
120
    import bzrlib.tests.tree_implementations
 
121
    import bzrlib.tests.workingtree_implementations
 
122
    return [
 
123
            bzrlib.doc,
 
124
            bzrlib.tests.blackbox,
 
125
            bzrlib.tests.branch_implementations,
 
126
            bzrlib.tests.bzrdir_implementations,
 
127
            bzrlib.tests.interrepository_implementations,
 
128
            bzrlib.tests.interversionedfile_implementations,
 
129
            bzrlib.tests.intertree_implementations,
 
130
            bzrlib.tests.repository_implementations,
 
131
            bzrlib.tests.revisionstore_implementations,
 
132
            bzrlib.tests.tree_implementations,
 
133
            bzrlib.tests.workingtree_implementations,
 
134
            ]
66
135
 
67
136
 
68
137
class _MyResult(unittest._TextTestResult):
69
 
    """
70
 
    Custom TestResult.
71
 
 
72
 
    No special behaviour for now.
73
 
    """
74
 
 
75
 
    def _elapsedTime(self):
76
 
        return "(Took %.3fs)" % (time.time() - self._start_time)
 
138
    """Custom TestResult.
 
139
 
 
140
    Shows output in a different format, including displaying runtime for tests.
 
141
    """
 
142
    stop_early = False
 
143
    
 
144
    def __init__(self, stream, descriptions, verbosity, pb=None,
 
145
                 bench_history=None):
 
146
        """Construct new TestResult.
 
147
 
 
148
        :param bench_history: Optionally, a writable file object to accumulate
 
149
            benchmark results.
 
150
        """
 
151
        unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
 
152
        self.pb = pb
 
153
        if bench_history is not None:
 
154
            from bzrlib.version import _get_bzr_source_tree
 
155
            src_tree = _get_bzr_source_tree()
 
156
            if src_tree:
 
157
                try:
 
158
                    revision_id = src_tree.get_parent_ids()[0]
 
159
                except IndexError:
 
160
                    # XXX: if this is a brand new tree, do the same as if there
 
161
                    # is no branch.
 
162
                    revision_id = ''
 
163
            else:
 
164
                # XXX: If there's no branch, what should we do?
 
165
                revision_id = ''
 
166
            bench_history.write("--date %s %s\n" % (time.time(), revision_id))
 
167
        self._bench_history = bench_history
 
168
    
 
169
    def extractBenchmarkTime(self, testCase):
 
170
        """Add a benchmark time for the current test case."""
 
171
        self._benchmarkTime = getattr(testCase, "_benchtime", None)
 
172
    
 
173
    def _elapsedTestTimeString(self):
 
174
        """Return a time string for the overall time the current test has taken."""
 
175
        return self._formatTime(time.time() - self._start_time)
 
176
 
 
177
    def _testTimeString(self):
 
178
        if self._benchmarkTime is not None:
 
179
            return "%s/%s" % (
 
180
                self._formatTime(self._benchmarkTime),
 
181
                self._elapsedTestTimeString())
 
182
        else:
 
183
            return "      %s" % self._elapsedTestTimeString()
 
184
 
 
185
    def _formatTime(self, seconds):
 
186
        """Format seconds as milliseconds with leading spaces."""
 
187
        return "%5dms" % (1000 * seconds)
 
188
 
 
189
    def _ellipsise_unimportant_words(self, a_string, final_width,
 
190
                                   keep_start=False):
 
191
        """Add ellipses (sp?) for overly long strings.
 
192
        
 
193
        :param keep_start: If true preserve the start of a_string rather
 
194
                           than the end of it.
 
195
        """
 
196
        if keep_start:
 
197
            if len(a_string) > final_width:
 
198
                result = a_string[:final_width-3] + '...'
 
199
            else:
 
200
                result = a_string
 
201
        else:
 
202
            if len(a_string) > final_width:
 
203
                result = '...' + a_string[3-final_width:]
 
204
            else:
 
205
                result = a_string
 
206
        return result.ljust(final_width)
77
207
 
78
208
    def startTest(self, test):
79
209
        unittest.TestResult.startTest(self, test)
80
 
        # TODO: Maybe show test.shortDescription somewhere?
81
 
        what = test.shortDescription() or test.id()        
 
210
        # In a short description, the important words are in
 
211
        # the beginning, but in an id, the important words are
 
212
        # at the end
 
213
        SHOW_DESCRIPTIONS = False
 
214
 
 
215
        if not self.showAll and self.dots and self.pb is not None:
 
216
            final_width = 13
 
217
        else:
 
218
            final_width = osutils.terminal_width()
 
219
            final_width = final_width - 15 - 8
 
220
        what = None
 
221
        if SHOW_DESCRIPTIONS:
 
222
            what = test.shortDescription()
 
223
            if what:
 
224
                what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
 
225
        if what is None:
 
226
            what = test.id()
 
227
            if what.startswith('bzrlib.tests.'):
 
228
                what = what[13:]
 
229
            what = self._ellipsise_unimportant_words(what, final_width)
82
230
        if self.showAll:
83
 
            self.stream.write('%-70.70s' % what)
 
231
            self.stream.write(what)
 
232
        elif self.dots and self.pb is not None:
 
233
            self.pb.update(what, self.testsRun - 1, None)
84
234
        self.stream.flush()
 
235
        self._recordTestStartTime()
 
236
 
 
237
    def _recordTestStartTime(self):
 
238
        """Record that a test has started."""
85
239
        self._start_time = time.time()
86
240
 
87
241
    def addError(self, test, err):
 
242
        if isinstance(err[1], TestSkipped):
 
243
            return self.addSkipped(test, err)    
88
244
        unittest.TestResult.addError(self, test, err)
 
245
        # We can only do this if we have one of our TestCases, not if
 
246
        # we have a doctest.
 
247
        setKeepLogfile = getattr(test, 'setKeepLogfile', None)
 
248
        if setKeepLogfile is not None:
 
249
            setKeepLogfile()
 
250
        self.extractBenchmarkTime(test)
89
251
        if self.showAll:
90
 
            self.stream.writeln("ERROR %s" % self._elapsedTime())
91
 
        elif self.dots:
 
252
            self.stream.writeln("ERROR %s" % self._testTimeString())
 
253
        elif self.dots and self.pb is None:
92
254
            self.stream.write('E')
 
255
        elif self.dots:
 
256
            self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
 
257
            self.pb.note(self._ellipsise_unimportant_words(
 
258
                            test.id() + ': ERROR',
 
259
                            osutils.terminal_width()))
93
260
        self.stream.flush()
 
261
        if self.stop_early:
 
262
            self.stop()
94
263
 
95
264
    def addFailure(self, test, err):
96
265
        unittest.TestResult.addFailure(self, test, err)
 
266
        # We can only do this if we have one of our TestCases, not if
 
267
        # we have a doctest.
 
268
        setKeepLogfile = getattr(test, 'setKeepLogfile', None)
 
269
        if setKeepLogfile is not None:
 
270
            setKeepLogfile()
 
271
        self.extractBenchmarkTime(test)
97
272
        if self.showAll:
98
 
            self.stream.writeln("FAIL %s" % self._elapsedTime())
99
 
        elif self.dots:
 
273
            self.stream.writeln(" FAIL %s" % self._testTimeString())
 
274
        elif self.dots and self.pb is None:
100
275
            self.stream.write('F')
 
276
        elif self.dots:
 
277
            self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
 
278
            self.pb.note(self._ellipsise_unimportant_words(
 
279
                            test.id() + ': FAIL',
 
280
                            osutils.terminal_width()))
101
281
        self.stream.flush()
 
282
        if self.stop_early:
 
283
            self.stop()
102
284
 
103
285
    def addSuccess(self, test):
 
286
        self.extractBenchmarkTime(test)
 
287
        if self._bench_history is not None:
 
288
            if self._benchmarkTime is not None:
 
289
                self._bench_history.write("%s %s\n" % (
 
290
                    self._formatTime(self._benchmarkTime),
 
291
                    test.id()))
104
292
        if self.showAll:
105
 
            self.stream.writeln('OK %s' % self._elapsedTime())
106
 
        elif self.dots:
 
293
            self.stream.writeln('   OK %s' % self._testTimeString())
 
294
            for bench_called, stats in getattr(test, '_benchcalls', []):
 
295
                self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
 
296
                stats.pprint(file=self.stream)
 
297
        elif self.dots and self.pb is None:
107
298
            self.stream.write('~')
 
299
        elif self.dots:
 
300
            self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
108
301
        self.stream.flush()
109
302
        unittest.TestResult.addSuccess(self, test)
110
303
 
 
304
    def addSkipped(self, test, skip_excinfo):
 
305
        self.extractBenchmarkTime(test)
 
306
        if self.showAll:
 
307
            print >>self.stream, ' SKIP %s' % self._testTimeString()
 
308
            print >>self.stream, '     %s' % skip_excinfo[1]
 
309
        elif self.dots and self.pb is None:
 
310
            self.stream.write('S')
 
311
        elif self.dots:
 
312
            self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
 
313
        self.stream.flush()
 
314
        # seems best to treat this as success from point-of-view of unittest
 
315
        # -- it actually does nothing so it barely matters :)
 
316
        try:
 
317
            test.tearDown()
 
318
        except KeyboardInterrupt:
 
319
            raise
 
320
        except:
 
321
            self.addError(test, test.__exc_info())
 
322
        else:
 
323
            unittest.TestResult.addSuccess(self, test)
 
324
 
111
325
    def printErrorList(self, flavour, errors):
112
326
        for test, err in errors:
113
327
            self.stream.writeln(self.separator1)
114
 
            self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
115
 
            if hasattr(test, '_get_log'):
116
 
                self.stream.writeln()
117
 
                self.stream.writeln('log from this test:')
 
328
            self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
 
329
            if getattr(test, '_get_log', None) is not None:
 
330
                print >>self.stream
 
331
                print >>self.stream, \
 
332
                        ('vvvv[log from %s]' % test.id()).ljust(78,'-')
118
333
                print >>self.stream, test._get_log()
 
334
                print >>self.stream, \
 
335
                        ('^^^^[log from %s]' % test.id()).ljust(78,'-')
119
336
            self.stream.writeln(self.separator2)
120
337
            self.stream.writeln("%s" % err)
121
338
 
122
339
 
123
 
class TextTestRunner(unittest.TextTestRunner):
 
340
class TextTestRunner(object):
124
341
    stop_on_failure = False
125
342
 
 
343
    def __init__(self,
 
344
                 stream=sys.stderr,
 
345
                 descriptions=0,
 
346
                 verbosity=1,
 
347
                 keep_output=False,
 
348
                 pb=None,
 
349
                 bench_history=None):
 
350
        self.stream = unittest._WritelnDecorator(stream)
 
351
        self.descriptions = descriptions
 
352
        self.verbosity = verbosity
 
353
        self.keep_output = keep_output
 
354
        self.pb = pb
 
355
        self._bench_history = bench_history
 
356
 
126
357
    def _makeResult(self):
127
 
        result = _MyResult(self.stream, self.descriptions, self.verbosity)
128
 
        if self.stop_on_failure:
129
 
            result = EarlyStoppingTestResultAdapter(result)
 
358
        result = _MyResult(self.stream,
 
359
                           self.descriptions,
 
360
                           self.verbosity,
 
361
                           pb=self.pb,
 
362
                           bench_history=self._bench_history)
 
363
        result.stop_early = self.stop_on_failure
 
364
        return result
 
365
 
 
366
    def run(self, test):
 
367
        "Run the given test case or test suite."
 
368
        result = self._makeResult()
 
369
        startTime = time.time()
 
370
        if self.pb is not None:
 
371
            self.pb.update('Running tests', 0, test.countTestCases())
 
372
        test.run(result)
 
373
        stopTime = time.time()
 
374
        timeTaken = stopTime - startTime
 
375
        result.printErrors()
 
376
        self.stream.writeln(result.separator2)
 
377
        run = result.testsRun
 
378
        self.stream.writeln("Ran %d test%s in %.3fs" %
 
379
                            (run, run != 1 and "s" or "", timeTaken))
 
380
        self.stream.writeln()
 
381
        if not result.wasSuccessful():
 
382
            self.stream.write("FAILED (")
 
383
            failed, errored = map(len, (result.failures, result.errors))
 
384
            if failed:
 
385
                self.stream.write("failures=%d" % failed)
 
386
            if errored:
 
387
                if failed: self.stream.write(", ")
 
388
                self.stream.write("errors=%d" % errored)
 
389
            self.stream.writeln(")")
 
390
        else:
 
391
            self.stream.writeln("OK")
 
392
        if self.pb is not None:
 
393
            self.pb.update('Cleaning up', 0, 1)
 
394
        # This is still a little bogus, 
 
395
        # but only a little. Folk not using our testrunner will
 
396
        # have to delete their temp directories themselves.
 
397
        test_root = TestCaseInTempDir.TEST_ROOT
 
398
        if result.wasSuccessful() or not self.keep_output:
 
399
            if test_root is not None:
 
400
                # If LANG=C we probably have created some bogus paths
 
401
                # which rmtree(unicode) will fail to delete
 
402
                # so make sure we are using rmtree(str) to delete everything
 
403
                # except on win32, where rmtree(str) will fail
 
404
                # since it doesn't have the property of byte-stream paths
 
405
                # (they are either ascii or mbcs)
 
406
                if sys.platform == 'win32':
 
407
                    # make sure we are using the unicode win32 api
 
408
                    test_root = unicode(test_root)
 
409
                else:
 
410
                    test_root = test_root.encode(
 
411
                        sys.getfilesystemencoding())
 
412
                osutils.rmtree(test_root)
 
413
        else:
 
414
            if self.pb is not None:
 
415
                self.pb.note("Failed tests working directories are in '%s'\n",
 
416
                             test_root)
 
417
            else:
 
418
                self.stream.writeln(
 
419
                    "Failed tests working directories are in '%s'\n" %
 
420
                    test_root)
 
421
        TestCaseInTempDir.TEST_ROOT = None
 
422
        if self.pb is not None:
 
423
            self.pb.clear()
130
424
        return result
131
425
 
132
426
 
145
439
 
146
440
class TestSkipped(Exception):
147
441
    """Indicates that a test was intentionally skipped, rather than failing."""
148
 
    # XXX: Not used yet
149
442
 
150
443
 
151
444
class CommandFailed(Exception):
152
445
    pass
153
446
 
 
447
 
 
448
class StringIOWrapper(object):
 
449
    """A wrapper around cStringIO which just adds an encoding attribute.
 
450
    
 
451
    Internally we can check sys.stdout to see what the output encoding
 
452
    should be. However, cStringIO has no encoding attribute that we can
 
453
    set. So we wrap it instead.
 
454
    """
 
455
    encoding='ascii'
 
456
    _cstring = None
 
457
 
 
458
    def __init__(self, s=None):
 
459
        if s is not None:
 
460
            self.__dict__['_cstring'] = StringIO(s)
 
461
        else:
 
462
            self.__dict__['_cstring'] = StringIO()
 
463
 
 
464
    def __getattr__(self, name, getattr=getattr):
 
465
        return getattr(self.__dict__['_cstring'], name)
 
466
 
 
467
    def __setattr__(self, name, val):
 
468
        if name == 'encoding':
 
469
            self.__dict__['encoding'] = val
 
470
        else:
 
471
            return setattr(self._cstring, name, val)
 
472
 
 
473
 
154
474
class TestCase(unittest.TestCase):
155
475
    """Base class for bzr unit tests.
156
476
    
159
479
 
160
480
    Error and debug log messages are redirected from their usual
161
481
    location into a temporary file, the contents of which can be
162
 
    retrieved by _get_log().
 
482
    retrieved by _get_log().  We use a real OS file, not an in-memory object,
 
483
    so that it can also capture file IO.  When the test completes this file
 
484
    is read into memory and removed from disk.
163
485
       
164
486
    There are also convenience functions to invoke bzr's command-line
165
 
    routine, and to build and check bzr trees."""
 
487
    routine, and to build and check bzr trees.
 
488
   
 
489
    In addition to the usual method of overriding tearDown(), this class also
 
490
    allows subclasses to register functions into the _cleanups list, which is
 
491
    run in order as the object is torn down.  It's less likely this will be
 
492
    accidentally overlooked.
 
493
    """
166
494
 
167
 
    BZRPATH = 'bzr'
168
495
    _log_file_name = None
 
496
    _log_contents = ''
 
497
    _keep_log_file = False
 
498
    # record lsprof data when performing benchmark calls.
 
499
    _gather_lsprof_in_benchmarks = False
 
500
 
 
501
    def __init__(self, methodName='testMethod'):
 
502
        super(TestCase, self).__init__(methodName)
 
503
        self._cleanups = []
169
504
 
170
505
    def setUp(self):
171
506
        unittest.TestCase.setUp(self)
172
 
        self.oldenv = os.environ.get('HOME', None)
173
 
        os.environ['HOME'] = os.getcwd()
174
 
        self.bzr_email = os.environ.get('BZREMAIL')
175
 
        if self.bzr_email is not None:
176
 
            del os.environ['BZREMAIL']
177
 
        self.email = os.environ.get('EMAIL')
178
 
        if self.email is not None:
179
 
            del os.environ['EMAIL']
 
507
        self._cleanEnvironment()
180
508
        bzrlib.trace.disable_default_logging()
181
 
        self._enable_file_logging()
 
509
        self._startLogFile()
 
510
        self._benchcalls = []
 
511
        self._benchtime = None
182
512
 
183
513
    def _ndiff_strings(self, a, b):
184
514
        """Return ndiff between two strings containing lines.
195
525
                                  charjunk=lambda x: False)
196
526
        return ''.join(difflines)
197
527
 
198
 
    def assertEqualDiff(self, a, b):
 
528
    def assertEqualDiff(self, a, b, message=None):
199
529
        """Assert two texts are equal, if not raise an exception.
200
530
        
201
531
        This is intended for use with multi-line strings where it can 
204
534
        # TODO: perhaps override assertEquals to call this for strings?
205
535
        if a == b:
206
536
            return
207
 
        raise AssertionError("texts not equal:\n" + 
 
537
        if message is None:
 
538
            message = "texts not equal:\n"
 
539
        raise AssertionError(message + 
208
540
                             self._ndiff_strings(a, b))      
 
541
        
 
542
    def assertEqualMode(self, mode, mode_test):
 
543
        self.assertEqual(mode, mode_test,
 
544
                         'mode mismatch %o != %o' % (mode, mode_test))
 
545
 
 
546
    def assertStartsWith(self, s, prefix):
 
547
        if not s.startswith(prefix):
 
548
            raise AssertionError('string %r does not start with %r' % (s, prefix))
 
549
 
 
550
    def assertEndsWith(self, s, suffix):
 
551
        """Asserts that s ends with suffix."""
 
552
        if not s.endswith(suffix):
 
553
            raise AssertionError('string %r does not end with %r' % (s, suffix))
209
554
 
210
555
    def assertContainsRe(self, haystack, needle_re):
211
556
        """Assert that a contains something matching a regular expression."""
213
558
            raise AssertionError('pattern "%s" not found in "%s"'
214
559
                    % (needle_re, haystack))
215
560
 
216
 
    def _enable_file_logging(self):
 
561
    def assertNotContainsRe(self, haystack, needle_re):
 
562
        """Assert that a does not match a regular expression"""
 
563
        if re.search(needle_re, haystack):
 
564
            raise AssertionError('pattern "%s" found in "%s"'
 
565
                    % (needle_re, haystack))
 
566
 
 
567
    def assertSubset(self, sublist, superlist):
 
568
        """Assert that every entry in sublist is present in superlist."""
 
569
        missing = []
 
570
        for entry in sublist:
 
571
            if entry not in superlist:
 
572
                missing.append(entry)
 
573
        if len(missing) > 0:
 
574
            raise AssertionError("value(s) %r not present in container %r" % 
 
575
                                 (missing, superlist))
 
576
 
 
577
    def assertIs(self, left, right):
 
578
        if not (left is right):
 
579
            raise AssertionError("%r is not %r." % (left, right))
 
580
 
 
581
    def assertTransportMode(self, transport, path, mode):
 
582
        """Fail if a path does not have mode mode.
 
583
        
 
584
        If modes are not supported on this transport, the assertion is ignored.
 
585
        """
 
586
        if not transport._can_roundtrip_unix_modebits():
 
587
            return
 
588
        path_stat = transport.stat(path)
 
589
        actual_mode = stat.S_IMODE(path_stat.st_mode)
 
590
        self.assertEqual(mode, actual_mode,
 
591
            'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
 
592
 
 
593
    def assertIsInstance(self, obj, kls):
 
594
        """Fail if obj is not an instance of kls"""
 
595
        if not isinstance(obj, kls):
 
596
            self.fail("%r is an instance of %s rather than %s" % (
 
597
                obj, obj.__class__, kls))
 
598
 
 
599
    def _capture_warnings(self, a_callable, *args, **kwargs):
 
600
        """A helper for callDeprecated and applyDeprecated.
 
601
 
 
602
        :param a_callable: A callable to call.
 
603
        :param args: The positional arguments for the callable
 
604
        :param kwargs: The keyword arguments for the callable
 
605
        :return: A tuple (warnings, result). result is the result of calling
 
606
            a_callable(*args, **kwargs).
 
607
        """
 
608
        local_warnings = []
 
609
        def capture_warnings(msg, cls, stacklevel=None):
 
610
            # we've hooked into a deprecation specific callpath,
 
611
            # only deprecations should getting sent via it.
 
612
            self.assertEqual(cls, DeprecationWarning)
 
613
            local_warnings.append(msg)
 
614
        original_warning_method = symbol_versioning.warn
 
615
        symbol_versioning.set_warning_method(capture_warnings)
 
616
        try:
 
617
            result = a_callable(*args, **kwargs)
 
618
        finally:
 
619
            symbol_versioning.set_warning_method(original_warning_method)
 
620
        return (local_warnings, result)
 
621
 
 
622
    def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
 
623
        """Call a deprecated callable without warning the user.
 
624
 
 
625
        :param deprecation_format: The deprecation format that the callable
 
626
            should have been deprecated with. This is the same type as the 
 
627
            parameter to deprecated_method/deprecated_function. If the 
 
628
            callable is not deprecated with this format, an assertion error
 
629
            will be raised.
 
630
        :param a_callable: A callable to call. This may be a bound method or
 
631
            a regular function. It will be called with *args and **kwargs.
 
632
        :param args: The positional arguments for the callable
 
633
        :param kwargs: The keyword arguments for the callable
 
634
        :return: The result of a_callable(*args, **kwargs)
 
635
        """
 
636
        call_warnings, result = self._capture_warnings(a_callable,
 
637
            *args, **kwargs)
 
638
        expected_first_warning = symbol_versioning.deprecation_string(
 
639
            a_callable, deprecation_format)
 
640
        if len(call_warnings) == 0:
 
641
            self.fail("No assertion generated by call to %s" %
 
642
                a_callable)
 
643
        self.assertEqual(expected_first_warning, call_warnings[0])
 
644
        return result
 
645
 
 
646
    def callDeprecated(self, expected, callable, *args, **kwargs):
 
647
        """Assert that a callable is deprecated in a particular way.
 
648
 
 
649
        This is a very precise test for unusual requirements. The 
 
650
        applyDeprecated helper function is probably more suited for most tests
 
651
        as it allows you to simply specify the deprecation format being used
 
652
        and will ensure that that is issued for the function being called.
 
653
 
 
654
        :param expected: a list of the deprecation warnings expected, in order
 
655
        :param callable: The callable to call
 
656
        :param args: The positional arguments for the callable
 
657
        :param kwargs: The keyword arguments for the callable
 
658
        """
 
659
        call_warnings, result = self._capture_warnings(callable,
 
660
            *args, **kwargs)
 
661
        self.assertEqual(expected, call_warnings)
 
662
        return result
 
663
 
 
664
    def _startLogFile(self):
 
665
        """Send bzr and test log messages to a temporary file.
 
666
 
 
667
        The file is removed as the test is torn down.
 
668
        """
217
669
        fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
218
 
 
219
670
        self._log_file = os.fdopen(fileno, 'w+')
220
 
 
221
 
        hdlr = logging.StreamHandler(self._log_file)
222
 
        hdlr.setLevel(logging.DEBUG)
223
 
        hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
224
 
        logging.getLogger('').addHandler(hdlr)
225
 
        logging.getLogger('').setLevel(logging.DEBUG)
226
 
        self._log_hdlr = hdlr
227
 
        debug('opened log file %s', name)
228
 
        
 
671
        self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
229
672
        self._log_file_name = name
230
 
 
231
 
    def tearDown(self):
232
 
        os.environ['HOME'] = self.oldenv
233
 
        if os.environ.get('BZREMAIL') is not None:
234
 
            del os.environ['BZREMAIL']
235
 
        if self.bzr_email is not None:
236
 
            os.environ['BZREMAIL'] = self.bzr_email
237
 
        if os.environ.get('EMAIL') is not None:
238
 
            del os.environ['EMAIL']
239
 
        if self.email is not None:
240
 
            os.environ['EMAIL'] = self.email
241
 
        logging.getLogger('').removeHandler(self._log_hdlr)
242
 
        bzrlib.trace.enable_default_logging()
243
 
        logging.debug('%s teardown', self.id())
 
673
        self.addCleanup(self._finishLogFile)
 
674
 
 
675
    def _finishLogFile(self):
 
676
        """Finished with the log file.
 
677
 
 
678
        Close the file and delete it, unless setKeepLogfile was called.
 
679
        """
 
680
        if self._log_file is None:
 
681
            return
 
682
        bzrlib.trace.disable_test_log(self._log_nonce)
244
683
        self._log_file.close()
 
684
        self._log_file = None
 
685
        if not self._keep_log_file:
 
686
            os.remove(self._log_file_name)
 
687
            self._log_file_name = None
 
688
 
 
689
    def setKeepLogfile(self):
 
690
        """Make the logfile not be deleted when _finishLogFile is called."""
 
691
        self._keep_log_file = True
 
692
 
 
693
    def addCleanup(self, callable):
 
694
        """Arrange to run a callable when this case is torn down.
 
695
 
 
696
        Callables are run in the reverse of the order they are registered, 
 
697
        ie last-in first-out.
 
698
        """
 
699
        if callable in self._cleanups:
 
700
            raise ValueError("cleanup function %r already registered on %s" 
 
701
                    % (callable, self))
 
702
        self._cleanups.append(callable)
 
703
 
 
704
    def _cleanEnvironment(self):
 
705
        new_env = {
 
706
            'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
 
707
            'HOME': os.getcwd(),
 
708
            'APPDATA': os.getcwd(),
 
709
            'BZR_EMAIL': None,
 
710
            'BZREMAIL': None, # may still be present in the environment
 
711
            'EMAIL': None,
 
712
            'BZR_PROGRESS_BAR': None,
 
713
        }
 
714
        self.__old_env = {}
 
715
        self.addCleanup(self._restoreEnvironment)
 
716
        for name, value in new_env.iteritems():
 
717
            self._captureVar(name, value)
 
718
 
 
719
    def _captureVar(self, name, newvalue):
 
720
        """Set an environment variable, and reset it when finished."""
 
721
        self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
 
722
 
 
723
    def _restoreEnvironment(self):
 
724
        for name, value in self.__old_env.iteritems():
 
725
            osutils.set_or_unset_env(name, value)
 
726
 
 
727
    def tearDown(self):
 
728
        self._runCleanups()
245
729
        unittest.TestCase.tearDown(self)
246
730
 
 
731
    def time(self, callable, *args, **kwargs):
 
732
        """Run callable and accrue the time it takes to the benchmark time.
 
733
        
 
734
        If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
 
735
        this will cause lsprofile statistics to be gathered and stored in
 
736
        self._benchcalls.
 
737
        """
 
738
        if self._benchtime is None:
 
739
            self._benchtime = 0
 
740
        start = time.time()
 
741
        try:
 
742
            if not self._gather_lsprof_in_benchmarks:
 
743
                return callable(*args, **kwargs)
 
744
            else:
 
745
                # record this benchmark
 
746
                ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
 
747
                stats.sort()
 
748
                self._benchcalls.append(((callable, args, kwargs), stats))
 
749
                return ret
 
750
        finally:
 
751
            self._benchtime += time.time() - start
 
752
 
 
753
    def _runCleanups(self):
 
754
        """Run registered cleanup functions. 
 
755
 
 
756
        This should only be called from TestCase.tearDown.
 
757
        """
 
758
        # TODO: Perhaps this should keep running cleanups even if 
 
759
        # one of them fails?
 
760
        for cleanup_fn in reversed(self._cleanups):
 
761
            cleanup_fn()
 
762
 
247
763
    def log(self, *args):
248
 
        logging.debug(*args)
 
764
        mutter(*args)
249
765
 
250
 
    def _get_log(self):
251
 
        """Return as a string the log for this test"""
252
 
        if self._log_file_name:
253
 
            return open(self._log_file_name).read()
 
766
    def _get_log(self, keep_log_file=False):
 
767
        """Return as a string the log for this test. If the file is still
 
768
        on disk and keep_log_file=False, delete the log file and store the
 
769
        content in self._log_contents."""
 
770
        # flush the log file, to get all content
 
771
        import bzrlib.trace
 
772
        bzrlib.trace._trace_file.flush()
 
773
        if self._log_contents:
 
774
            return self._log_contents
 
775
        if self._log_file_name is not None:
 
776
            logfile = open(self._log_file_name)
 
777
            try:
 
778
                log_contents = logfile.read()
 
779
            finally:
 
780
                logfile.close()
 
781
            if not keep_log_file:
 
782
                self._log_contents = log_contents
 
783
                os.remove(self._log_file_name)
 
784
            return log_contents
254
785
        else:
255
 
            return ''
 
786
            return "DELETED log file to reduce memory footprint"
256
787
 
257
 
    def capture(self, cmd):
 
788
    def capture(self, cmd, retcode=0):
258
789
        """Shortcut that splits cmd into words, runs, and returns stdout"""
259
 
        return self.run_bzr_captured(cmd.split())[0]
 
790
        return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
260
791
 
261
 
    def run_bzr_captured(self, argv, retcode=0):
262
 
        """Invoke bzr and return (result, stdout, stderr).
 
792
    def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
 
793
                         working_dir=None):
 
794
        """Invoke bzr and return (stdout, stderr).
263
795
 
264
796
        Useful for code that wants to check the contents of the
265
797
        output, the way error messages are presented, etc.
275
807
        errors, and with logging set to something approximating the
276
808
        default, so that error reporting can be checked.
277
809
 
278
 
        argv -- arguments to invoke bzr
279
 
        retcode -- expected return code, or None for don't-care.
 
810
        :param argv: arguments to invoke bzr
 
811
        :param retcode: expected return code, or None for don't-care.
 
812
        :param encoding: encoding for sys.stdout and sys.stderr
 
813
        :param stdin: A string to be used as stdin for the command.
 
814
        :param working_dir: Change to this directory before running
280
815
        """
281
 
        stdout = StringIO()
282
 
        stderr = StringIO()
283
 
        self.log('run bzr: %s', ' '.join(argv))
 
816
        if encoding is None:
 
817
            encoding = bzrlib.user_encoding
 
818
        if stdin is not None:
 
819
            stdin = StringIO(stdin)
 
820
        stdout = StringIOWrapper()
 
821
        stderr = StringIOWrapper()
 
822
        stdout.encoding = encoding
 
823
        stderr.encoding = encoding
 
824
 
 
825
        self.log('run bzr: %r', argv)
 
826
        # FIXME: don't call into logging here
284
827
        handler = logging.StreamHandler(stderr)
285
 
        handler.setFormatter(bzrlib.trace.QuietFormatter())
286
828
        handler.setLevel(logging.INFO)
287
829
        logger = logging.getLogger('')
288
830
        logger.addHandler(handler)
 
831
        old_ui_factory = bzrlib.ui.ui_factory
 
832
        bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
 
833
            stdout=stdout,
 
834
            stderr=stderr)
 
835
        bzrlib.ui.ui_factory.stdin = stdin
 
836
 
 
837
        cwd = None
 
838
        if working_dir is not None:
 
839
            cwd = osutils.getcwd()
 
840
            os.chdir(working_dir)
 
841
 
289
842
        try:
290
 
            result = self.apply_redirected(None, stdout, stderr,
 
843
            result = self.apply_redirected(stdin, stdout, stderr,
291
844
                                           bzrlib.commands.run_bzr_catch_errors,
292
845
                                           argv)
293
846
        finally:
294
847
            logger.removeHandler(handler)
 
848
            bzrlib.ui.ui_factory = old_ui_factory
 
849
            if cwd is not None:
 
850
                os.chdir(cwd)
 
851
 
295
852
        out = stdout.getvalue()
296
853
        err = stderr.getvalue()
297
854
        if out:
298
 
            self.log('output:\n%s', out)
 
855
            self.log('output:\n%r', out)
299
856
        if err:
300
 
            self.log('errors:\n%s', err)
 
857
            self.log('errors:\n%r', err)
301
858
        if retcode is not None:
302
 
            self.assertEquals(result, retcode)
 
859
            self.assertEquals(retcode, result)
303
860
        return out, err
304
861
 
305
862
    def run_bzr(self, *args, **kwargs):
311
868
 
312
869
        This sends the stdout/stderr results into the test's log,
313
870
        where it may be useful for debugging.  See also run_captured.
 
871
 
 
872
        :param stdin: A string to be used as stdin for the command.
314
873
        """
315
874
        retcode = kwargs.pop('retcode', 0)
316
 
        return self.run_bzr_captured(args, retcode)
 
875
        encoding = kwargs.pop('encoding', None)
 
876
        stdin = kwargs.pop('stdin', None)
 
877
        working_dir = kwargs.pop('working_dir', None)
 
878
        return self.run_bzr_captured(args, retcode=retcode, encoding=encoding,
 
879
                                     stdin=stdin, working_dir=working_dir)
 
880
 
 
881
    def run_bzr_decode(self, *args, **kwargs):
 
882
        if 'encoding' in kwargs:
 
883
            encoding = kwargs['encoding']
 
884
        else:
 
885
            encoding = bzrlib.user_encoding
 
886
        return self.run_bzr(*args, **kwargs)[0].decode(encoding)
 
887
 
 
888
    def run_bzr_error(self, error_regexes, *args, **kwargs):
 
889
        """Run bzr, and check that stderr contains the supplied regexes
 
890
        
 
891
        :param error_regexes: Sequence of regular expressions which 
 
892
            must each be found in the error output. The relative ordering
 
893
            is not enforced.
 
894
        :param args: command-line arguments for bzr
 
895
        :param kwargs: Keyword arguments which are interpreted by run_bzr
 
896
            This function changes the default value of retcode to be 3,
 
897
            since in most cases this is run when you expect bzr to fail.
 
898
        :return: (out, err) The actual output of running the command (in case you
 
899
                 want to do more inspection)
 
900
 
 
901
        Examples of use:
 
902
            # Make sure that commit is failing because there is nothing to do
 
903
            self.run_bzr_error(['no changes to commit'],
 
904
                               'commit', '-m', 'my commit comment')
 
905
            # Make sure --strict is handling an unknown file, rather than
 
906
            # giving us the 'nothing to do' error
 
907
            self.build_tree(['unknown'])
 
908
            self.run_bzr_error(['Commit refused because there are unknown files'],
 
909
                               'commit', '--strict', '-m', 'my commit comment')
 
910
        """
 
911
        kwargs.setdefault('retcode', 3)
 
912
        out, err = self.run_bzr(*args, **kwargs)
 
913
        for regex in error_regexes:
 
914
            self.assertContainsRe(err, regex)
 
915
        return out, err
 
916
 
 
917
    def run_bzr_subprocess(self, *args, **kwargs):
 
918
        """Run bzr in a subprocess for testing.
 
919
 
 
920
        This starts a new Python interpreter and runs bzr in there. 
 
921
        This should only be used for tests that have a justifiable need for
 
922
        this isolation: e.g. they are testing startup time, or signal
 
923
        handling, or early startup code, etc.  Subprocess code can't be 
 
924
        profiled or debugged so easily.
 
925
 
 
926
        :param retcode: The status code that is expected.  Defaults to 0.  If
 
927
            None is supplied, the status code is not checked.
 
928
        :param env_changes: A dictionary which lists changes to environment
 
929
            variables. A value of None will unset the env variable.
 
930
            The values must be strings. The change will only occur in the
 
931
            child, so you don't need to fix the environment after running.
 
932
        :param universal_newlines: Convert CRLF => LF
 
933
        """
 
934
        env_changes = kwargs.get('env_changes', {})
 
935
        working_dir = kwargs.get('working_dir', None)
 
936
        process = self.start_bzr_subprocess(args, env_changes=env_changes,
 
937
                                            working_dir=working_dir)
 
938
        # We distinguish between retcode=None and retcode not passed.
 
939
        supplied_retcode = kwargs.get('retcode', 0)
 
940
        return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
 
941
            universal_newlines=kwargs.get('universal_newlines', False),
 
942
            process_args=args)
 
943
 
 
944
    def start_bzr_subprocess(self, process_args, env_changes=None,
 
945
                             skip_if_plan_to_signal=False,
 
946
                             working_dir=None):
 
947
        """Start bzr in a subprocess for testing.
 
948
 
 
949
        This starts a new Python interpreter and runs bzr in there.
 
950
        This should only be used for tests that have a justifiable need for
 
951
        this isolation: e.g. they are testing startup time, or signal
 
952
        handling, or early startup code, etc.  Subprocess code can't be
 
953
        profiled or debugged so easily.
 
954
 
 
955
        :param process_args: a list of arguments to pass to the bzr executable,
 
956
            for example `['--version']`.
 
957
        :param env_changes: A dictionary which lists changes to environment
 
958
            variables. A value of None will unset the env variable.
 
959
            The values must be strings. The change will only occur in the
 
960
            child, so you don't need to fix the environment after running.
 
961
        :param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
 
962
            is not available.
 
963
 
 
964
        :returns: Popen object for the started process.
 
965
        """
 
966
        if skip_if_plan_to_signal:
 
967
            if not getattr(os, 'kill', None):
 
968
                raise TestSkipped("os.kill not available.")
 
969
 
 
970
        if env_changes is None:
 
971
            env_changes = {}
 
972
        old_env = {}
 
973
 
 
974
        def cleanup_environment():
 
975
            for env_var, value in env_changes.iteritems():
 
976
                old_env[env_var] = osutils.set_or_unset_env(env_var, value)
 
977
 
 
978
        def restore_environment():
 
979
            for env_var, value in old_env.iteritems():
 
980
                osutils.set_or_unset_env(env_var, value)
 
981
 
 
982
        bzr_path = self.get_bzr_path()
 
983
 
 
984
        cwd = None
 
985
        if working_dir is not None:
 
986
            cwd = osutils.getcwd()
 
987
            os.chdir(working_dir)
 
988
 
 
989
        try:
 
990
            # win32 subprocess doesn't support preexec_fn
 
991
            # so we will avoid using it on all platforms, just to
 
992
            # make sure the code path is used, and we don't break on win32
 
993
            cleanup_environment()
 
994
            process = Popen([sys.executable, bzr_path] + list(process_args),
 
995
                             stdin=PIPE, stdout=PIPE, stderr=PIPE)
 
996
        finally:
 
997
            restore_environment()
 
998
            if cwd is not None:
 
999
                os.chdir(cwd)
 
1000
 
 
1001
        return process
 
1002
 
 
1003
    def get_bzr_path(self):
 
1004
        """Return the path of the 'bzr' executable for this test suite."""
 
1005
        bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
 
1006
        if not os.path.isfile(bzr_path):
 
1007
            # We are probably installed. Assume sys.argv is the right file
 
1008
            bzr_path = sys.argv[0]
 
1009
        return bzr_path
 
1010
 
 
1011
    def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
 
1012
                              universal_newlines=False, process_args=None):
 
1013
        """Finish the execution of process.
 
1014
 
 
1015
        :param process: the Popen object returned from start_bzr_subprocess.
 
1016
        :param retcode: The status code that is expected.  Defaults to 0.  If
 
1017
            None is supplied, the status code is not checked.
 
1018
        :param send_signal: an optional signal to send to the process.
 
1019
        :param universal_newlines: Convert CRLF => LF
 
1020
        :returns: (stdout, stderr)
 
1021
        """
 
1022
        if send_signal is not None:
 
1023
            os.kill(process.pid, send_signal)
 
1024
        out, err = process.communicate()
 
1025
 
 
1026
        if universal_newlines:
 
1027
            out = out.replace('\r\n', '\n')
 
1028
            err = err.replace('\r\n', '\n')
 
1029
 
 
1030
        if retcode is not None and retcode != process.returncode:
 
1031
            if process_args is None:
 
1032
                process_args = "(unknown args)"
 
1033
            mutter('Output of bzr %s:\n%s', process_args, out)
 
1034
            mutter('Error for bzr %s:\n%s', process_args, err)
 
1035
            self.fail('Command bzr %s failed with retcode %s != %s'
 
1036
                      % (process_args, retcode, process.returncode))
 
1037
        return [out, err]
317
1038
 
318
1039
    def check_inventory_shape(self, inv, shape):
319
1040
        """Compare an inventory to a list of expected names.
345
1066
        if stdin is None:
346
1067
            stdin = StringIO("")
347
1068
        if stdout is None:
348
 
            if hasattr(self, "_log_file"):
 
1069
            if getattr(self, "_log_file", None) is not None:
349
1070
                stdout = self._log_file
350
1071
            else:
351
1072
                stdout = StringIO()
352
1073
        if stderr is None:
353
 
            if hasattr(self, "_log_file"):
 
1074
            if getattr(self, "_log_file", None is not None):
354
1075
                stderr = self._log_file
355
1076
            else:
356
1077
                stderr = StringIO()
367
1088
            sys.stderr = real_stderr
368
1089
            sys.stdin = real_stdin
369
1090
 
 
1091
    @symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
 
1092
    def merge(self, branch_from, wt_to):
 
1093
        """A helper for tests to do a ui-less merge.
 
1094
 
 
1095
        This should move to the main library when someone has time to integrate
 
1096
        it in.
 
1097
        """
 
1098
        # minimal ui-less merge.
 
1099
        wt_to.branch.fetch(branch_from)
 
1100
        base_rev = common_ancestor(branch_from.last_revision(),
 
1101
                                   wt_to.branch.last_revision(),
 
1102
                                   wt_to.branch.repository)
 
1103
        merge_inner(wt_to.branch, branch_from.basis_tree(),
 
1104
                    wt_to.branch.repository.revision_tree(base_rev),
 
1105
                    this_tree=wt_to)
 
1106
        wt_to.add_parent_tree_id(branch_from.last_revision())
 
1107
 
370
1108
 
371
1109
BzrTestBase = TestCase
372
1110
 
401
1139
            return
402
1140
        i = 0
403
1141
        while True:
404
 
            root = 'test%04d.tmp' % i
 
1142
            root = u'test%04d.tmp' % i
405
1143
            try:
406
1144
                os.mkdir(root)
407
1145
            except OSError, e:
411
1149
                else:
412
1150
                    raise
413
1151
            # successfully created
414
 
            TestCaseInTempDir.TEST_ROOT = os.path.abspath(root)
 
1152
            TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
415
1153
            break
416
1154
        # make a fake bzr directory there to prevent any tests propagating
417
1155
        # up onto the source directory's real branch
418
 
        os.mkdir(os.path.join(TestCaseInTempDir.TEST_ROOT, '.bzr'))
 
1156
        bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
419
1157
 
420
1158
    def setUp(self):
 
1159
        super(TestCaseInTempDir, self).setUp()
421
1160
        self._make_test_root()
422
 
        self._currentdir = os.getcwdu()
423
 
        short_id = self.id().replace('bzrlib.selftest.', '') \
424
 
                   .replace('__main__.', '')
425
 
        self.test_dir = os.path.join(self.TEST_ROOT, short_id)
426
 
        os.mkdir(self.test_dir)
427
 
        os.chdir(self.test_dir)
428
 
        super(TestCaseInTempDir, self).setUp()
 
1161
        _currentdir = os.getcwdu()
 
1162
        # shorten the name, to avoid test failures due to path length
 
1163
        short_id = self.id().replace('bzrlib.tests.', '') \
 
1164
                   .replace('__main__.', '')[-100:]
 
1165
        # it's possible the same test class is run several times for
 
1166
        # parameterized tests, so make sure the names don't collide.  
 
1167
        i = 0
 
1168
        while True:
 
1169
            if i > 0:
 
1170
                candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
 
1171
            else:
 
1172
                candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
 
1173
            if os.path.exists(candidate_dir):
 
1174
                i = i + 1
 
1175
                continue
 
1176
            else:
 
1177
                os.mkdir(candidate_dir)
 
1178
                self.test_home_dir = candidate_dir + '/home'
 
1179
                os.mkdir(self.test_home_dir)
 
1180
                self.test_dir = candidate_dir + '/work'
 
1181
                os.mkdir(self.test_dir)
 
1182
                os.chdir(self.test_dir)
 
1183
                break
 
1184
        os.environ['HOME'] = self.test_home_dir
 
1185
        os.environ['APPDATA'] = self.test_home_dir
 
1186
        def _leaveDirectory():
 
1187
            os.chdir(_currentdir)
 
1188
        self.addCleanup(_leaveDirectory)
429
1189
        
430
 
    def tearDown(self):
431
 
        os.chdir(self._currentdir)
432
 
        super(TestCaseInTempDir, self).tearDown()
433
 
 
434
 
    def build_tree(self, shape):
 
1190
    def build_tree(self, shape, line_endings='native', transport=None):
435
1191
        """Build a test tree according to a pattern.
436
1192
 
437
1193
        shape is a sequence of file specifications.  If the final
438
1194
        character is '/', a directory is created.
439
1195
 
 
1196
        This assumes that all the elements in the tree being built are new.
 
1197
 
440
1198
        This doesn't add anything to a branch.
 
1199
        :param line_endings: Either 'binary' or 'native'
 
1200
                             in binary mode, exact contents are written
 
1201
                             in native mode, the line endings match the
 
1202
                             default platform endings.
 
1203
 
 
1204
        :param transport: A transport to write to, for building trees on 
 
1205
                          VFS's. If the transport is readonly or None,
 
1206
                          "." is opened automatically.
441
1207
        """
442
 
        # XXX: It's OK to just create them using forward slashes on windows?
 
1208
        # It's OK to just create them using forward slashes on windows.
 
1209
        if transport is None or transport.is_readonly():
 
1210
            transport = get_transport(".")
443
1211
        for name in shape:
444
 
            assert isinstance(name, basestring)
 
1212
            self.assert_(isinstance(name, basestring))
445
1213
            if name[-1] == '/':
446
 
                os.mkdir(name[:-1])
 
1214
                transport.mkdir(urlutils.escape(name[:-1]))
447
1215
            else:
448
 
                f = file(name, 'wt')
449
 
                print >>f, "contents of", name
450
 
                f.close()
 
1216
                if line_endings == 'binary':
 
1217
                    end = '\n'
 
1218
                elif line_endings == 'native':
 
1219
                    end = os.linesep
 
1220
                else:
 
1221
                    raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
 
1222
                content = "contents of %s%s" % (name.encode('utf-8'), end)
 
1223
                # Technically 'put()' is the right command. However, put
 
1224
                # uses an AtomicFile, which requires an extra rename into place
 
1225
                # As long as the files didn't exist in the past, append() will
 
1226
                # do the same thing as put()
 
1227
                # On jam's machine, make_kernel_like_tree is:
 
1228
                #   put:    4.5-7.5s (averaging 6s)
 
1229
                #   append: 2.9-4.5s
 
1230
                #   put_non_atomic: 2.9-4.5s
 
1231
                transport.put_bytes_non_atomic(urlutils.escape(name), content)
451
1232
 
452
1233
    def build_tree_contents(self, shape):
453
 
        bzrlib.selftest.build_tree_contents(shape)
 
1234
        build_tree_contents(shape)
454
1235
 
455
1236
    def failUnlessExists(self, path):
456
1237
        """Fail unless path, which may be abs or relative, exists."""
457
1238
        self.failUnless(osutils.lexists(path))
 
1239
 
 
1240
    def failIfExists(self, path):
 
1241
        """Fail if path, which may be abs or relative, exists."""
 
1242
        self.failIf(osutils.lexists(path))
458
1243
        
459
1244
    def assertFileEqual(self, content, path):
460
1245
        """Fail if path does not contain 'content'."""
461
1246
        self.failUnless(osutils.lexists(path))
 
1247
        # TODO: jam 20060427 Shouldn't this be 'rb'?
462
1248
        self.assertEqualDiff(content, open(path, 'r').read())
 
1249
 
 
1250
 
 
1251
class TestCaseWithTransport(TestCaseInTempDir):
 
1252
    """A test case that provides get_url and get_readonly_url facilities.
 
1253
 
 
1254
    These back onto two transport servers, one for readonly access and one for
 
1255
    read write access.
 
1256
 
 
1257
    If no explicit class is provided for readonly access, a
 
1258
    ReadonlyTransportDecorator is used instead which allows the use of non disk
 
1259
    based read write transports.
 
1260
 
 
1261
    If an explicit class is provided for readonly access, that server and the 
 
1262
    readwrite one must both define get_url() as resolving to os.getcwd().
 
1263
    """
 
1264
 
 
1265
    def __init__(self, methodName='testMethod'):
 
1266
        super(TestCaseWithTransport, self).__init__(methodName)
 
1267
        self.__readonly_server = None
 
1268
        self.__server = None
 
1269
        self.transport_server = default_transport
 
1270
        self.transport_readonly_server = None
 
1271
 
 
1272
    def get_readonly_url(self, relpath=None):
 
1273
        """Get a URL for the readonly transport.
 
1274
 
 
1275
        This will either be backed by '.' or a decorator to the transport 
 
1276
        used by self.get_url()
 
1277
        relpath provides for clients to get a path relative to the base url.
 
1278
        These should only be downwards relative, not upwards.
 
1279
        """
 
1280
        base = self.get_readonly_server().get_url()
 
1281
        if relpath is not None:
 
1282
            if not base.endswith('/'):
 
1283
                base = base + '/'
 
1284
            base = base + relpath
 
1285
        return base
 
1286
 
 
1287
    def get_readonly_server(self):
 
1288
        """Get the server instance for the readonly transport
 
1289
 
 
1290
        This is useful for some tests with specific servers to do diagnostics.
 
1291
        """
 
1292
        if self.__readonly_server is None:
 
1293
            if self.transport_readonly_server is None:
 
1294
                # readonly decorator requested
 
1295
                # bring up the server
 
1296
                self.get_url()
 
1297
                self.__readonly_server = ReadonlyServer()
 
1298
                self.__readonly_server.setUp(self.__server)
 
1299
            else:
 
1300
                self.__readonly_server = self.transport_readonly_server()
 
1301
                self.__readonly_server.setUp()
 
1302
            self.addCleanup(self.__readonly_server.tearDown)
 
1303
        return self.__readonly_server
 
1304
 
 
1305
    def get_server(self):
 
1306
        """Get the read/write server instance.
 
1307
 
 
1308
        This is useful for some tests with specific servers that need
 
1309
        diagnostics.
 
1310
        """
 
1311
        if self.__server is None:
 
1312
            self.__server = self.transport_server()
 
1313
            self.__server.setUp()
 
1314
            self.addCleanup(self.__server.tearDown)
 
1315
        return self.__server
 
1316
 
 
1317
    def get_url(self, relpath=None):
 
1318
        """Get a URL (or maybe a path) for the readwrite transport.
 
1319
 
 
1320
        This will either be backed by '.' or to an equivalent non-file based
 
1321
        facility.
 
1322
        relpath provides for clients to get a path relative to the base url.
 
1323
        These should only be downwards relative, not upwards.
 
1324
        """
 
1325
        base = self.get_server().get_url()
 
1326
        if relpath is not None and relpath != '.':
 
1327
            if not base.endswith('/'):
 
1328
                base = base + '/'
 
1329
            # XXX: Really base should be a url; we did after all call
 
1330
            # get_url()!  But sometimes it's just a path (from
 
1331
            # LocalAbspathServer), and it'd be wrong to append urlescaped data
 
1332
            # to a non-escaped local path.
 
1333
            if base.startswith('./') or base.startswith('/'):
 
1334
                base += relpath
 
1335
            else:
 
1336
                base += urlutils.escape(relpath)
 
1337
        return base
 
1338
 
 
1339
    def get_transport(self):
 
1340
        """Return a writeable transport for the test scratch space"""
 
1341
        t = get_transport(self.get_url())
 
1342
        self.assertFalse(t.is_readonly())
 
1343
        return t
 
1344
 
 
1345
    def get_readonly_transport(self):
 
1346
        """Return a readonly transport for the test scratch space
463
1347
        
464
 
 
465
 
class MetaTestLog(TestCase):
466
 
    def test_logging(self):
467
 
        """Test logs are captured when a test fails."""
468
 
        logging.info('an info message')
469
 
        warning('something looks dodgy...')
470
 
        logging.debug('hello, test is running')
471
 
        ## assert 0
 
1348
        This can be used to test that operations which should only need
 
1349
        readonly access in fact do not try to write.
 
1350
        """
 
1351
        t = get_transport(self.get_readonly_url())
 
1352
        self.assertTrue(t.is_readonly())
 
1353
        return t
 
1354
 
 
1355
    def make_branch(self, relpath, format=None):
 
1356
        """Create a branch on the transport at relpath."""
 
1357
        repo = self.make_repository(relpath, format=format)
 
1358
        return repo.bzrdir.create_branch()
 
1359
 
 
1360
    def make_bzrdir(self, relpath, format=None):
 
1361
        try:
 
1362
            # might be a relative or absolute path
 
1363
            maybe_a_url = self.get_url(relpath)
 
1364
            segments = maybe_a_url.rsplit('/', 1)
 
1365
            t = get_transport(maybe_a_url)
 
1366
            if len(segments) > 1 and segments[-1] not in ('', '.'):
 
1367
                try:
 
1368
                    t.mkdir('.')
 
1369
                except errors.FileExists:
 
1370
                    pass
 
1371
            if format is None:
 
1372
                format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
 
1373
            return format.initialize_on_transport(t)
 
1374
        except errors.UninitializableFormat:
 
1375
            raise TestSkipped("Format %s is not initializable." % format)
 
1376
 
 
1377
    def make_repository(self, relpath, shared=False, format=None):
 
1378
        """Create a repository on our default transport at relpath."""
 
1379
        made_control = self.make_bzrdir(relpath, format=format)
 
1380
        return made_control.create_repository(shared=shared)
 
1381
 
 
1382
    def make_branch_and_memory_tree(self, relpath):
 
1383
        """Create a branch on the default transport and a MemoryTree for it."""
 
1384
        b = self.make_branch(relpath)
 
1385
        return memorytree.MemoryTree.create_on_branch(b)
 
1386
 
 
1387
    def make_branch_and_tree(self, relpath, format=None):
 
1388
        """Create a branch on the transport and a tree locally.
 
1389
 
 
1390
        If the transport is not a LocalTransport, the Tree can't be created on
 
1391
        the transport.  In that case the working tree is created in the local
 
1392
        directory, and the returned tree's branch and repository will also be
 
1393
        accessed locally.
 
1394
 
 
1395
        This will fail if the original default transport for this test
 
1396
        case wasn't backed by the working directory, as the branch won't
 
1397
        be on disk for us to open it.  
 
1398
 
 
1399
        :param format: The BzrDirFormat.
 
1400
        :returns: the WorkingTree.
 
1401
        """
 
1402
        # TODO: always use the local disk path for the working tree,
 
1403
        # this obviously requires a format that supports branch references
 
1404
        # so check for that by checking bzrdir.BzrDirFormat.get_default_format()
 
1405
        # RBC 20060208
 
1406
        b = self.make_branch(relpath, format=format)
 
1407
        try:
 
1408
            return b.bzrdir.create_workingtree()
 
1409
        except errors.NotLocalUrl:
 
1410
            # We can only make working trees locally at the moment.  If the
 
1411
            # transport can't support them, then reopen the branch on a local
 
1412
            # transport, and create the working tree there.  
 
1413
            #
 
1414
            # Possibly we should instead keep
 
1415
            # the non-disk-backed branch and create a local checkout?
 
1416
            bd = bzrdir.BzrDir.open(relpath)
 
1417
            return bd.create_workingtree()
 
1418
 
 
1419
    def assertIsDirectory(self, relpath, transport):
 
1420
        """Assert that relpath within transport is a directory.
 
1421
 
 
1422
        This may not be possible on all transports; in that case it propagates
 
1423
        a TransportNotPossible.
 
1424
        """
 
1425
        try:
 
1426
            mode = transport.stat(relpath).st_mode
 
1427
        except errors.NoSuchFile:
 
1428
            self.fail("path %s is not a directory; no such file"
 
1429
                      % (relpath))
 
1430
        if not stat.S_ISDIR(mode):
 
1431
            self.fail("path %s is not a directory; has mode %#o"
 
1432
                      % (relpath, mode))
 
1433
 
 
1434
 
 
1435
class ChrootedTestCase(TestCaseWithTransport):
 
1436
    """A support class that provides readonly urls outside the local namespace.
 
1437
 
 
1438
    This is done by checking if self.transport_server is a MemoryServer. if it
 
1439
    is then we are chrooted already, if it is not then an HttpServer is used
 
1440
    for readonly urls.
 
1441
 
 
1442
    TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
 
1443
                       be used without needed to redo it when a different 
 
1444
                       subclass is in use ?
 
1445
    """
 
1446
 
 
1447
    def setUp(self):
 
1448
        super(ChrootedTestCase, self).setUp()
 
1449
        if not self.transport_server == bzrlib.transport.memory.MemoryServer:
 
1450
            self.transport_readonly_server = bzrlib.transport.http.HttpServer
472
1451
 
473
1452
 
474
1453
def filter_suite_by_re(suite, pattern):
481
1460
 
482
1461
 
483
1462
def run_suite(suite, name='test', verbose=False, pattern=".*",
484
 
              stop_on_failure=False):
 
1463
              stop_on_failure=False, keep_output=False,
 
1464
              transport=None, lsprof_timed=None, bench_history=None):
485
1465
    TestCaseInTempDir._TEST_NAME = name
 
1466
    TestCase._gather_lsprof_in_benchmarks = lsprof_timed
486
1467
    if verbose:
487
1468
        verbosity = 2
 
1469
        pb = None
488
1470
    else:
489
1471
        verbosity = 1
 
1472
        pb = progress.ProgressBar()
490
1473
    runner = TextTestRunner(stream=sys.stdout,
491
1474
                            descriptions=0,
492
 
                            verbosity=verbosity)
 
1475
                            verbosity=verbosity,
 
1476
                            keep_output=keep_output,
 
1477
                            pb=pb,
 
1478
                            bench_history=bench_history)
493
1479
    runner.stop_on_failure=stop_on_failure
494
1480
    if pattern != '.*':
495
1481
        suite = filter_suite_by_re(suite, pattern)
496
1482
    result = runner.run(suite)
497
 
    # This is still a little bogus, 
498
 
    # but only a little. Folk not using our testrunner will
499
 
    # have to delete their temp directories themselves.
500
 
    if result.wasSuccessful():
501
 
        if TestCaseInTempDir.TEST_ROOT is not None:
502
 
            shutil.rmtree(TestCaseInTempDir.TEST_ROOT) 
503
 
    else:
504
 
        print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
505
1483
    return result.wasSuccessful()
506
1484
 
507
1485
 
508
 
def selftest(verbose=False, pattern=".*", stop_on_failure=True):
 
1486
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
 
1487
             keep_output=False,
 
1488
             transport=None,
 
1489
             test_suite_factory=None,
 
1490
             lsprof_timed=None,
 
1491
             bench_history=None):
509
1492
    """Run the whole test suite under the enhanced runner"""
510
 
    return run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern,
511
 
                     stop_on_failure=stop_on_failure)
 
1493
    # XXX: Very ugly way to do this...
 
1494
    # Disable warning about old formats because we don't want it to disturb
 
1495
    # any blackbox tests.
 
1496
    from bzrlib import repository
 
1497
    repository._deprecation_warning_done = True
 
1498
 
 
1499
    global default_transport
 
1500
    if transport is None:
 
1501
        transport = default_transport
 
1502
    old_transport = default_transport
 
1503
    default_transport = transport
 
1504
    try:
 
1505
        if test_suite_factory is None:
 
1506
            suite = test_suite()
 
1507
        else:
 
1508
            suite = test_suite_factory()
 
1509
        return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
 
1510
                     stop_on_failure=stop_on_failure, keep_output=keep_output,
 
1511
                     transport=transport,
 
1512
                     lsprof_timed=lsprof_timed,
 
1513
                     bench_history=bench_history)
 
1514
    finally:
 
1515
        default_transport = old_transport
512
1516
 
513
1517
 
514
1518
def test_suite():
515
 
    """Build and return TestSuite for the whole program."""
516
 
    import bzrlib.store, bzrlib.inventory, bzrlib.branch
517
 
    import bzrlib.osutils, bzrlib.merge3, bzrlib.plugin
518
 
    from doctest import DocTestSuite
519
 
 
520
 
    global MODULES_TO_TEST, MODULES_TO_DOCTEST
521
 
 
522
 
    testmod_names = \
523
 
                  ['bzrlib.selftest.MetaTestLog',
524
 
                   'bzrlib.selftest.testgpg',
525
 
                   'bzrlib.selftest.testidentitymap',
526
 
                   'bzrlib.selftest.testinv',
527
 
                   'bzrlib.selftest.test_ancestry',
528
 
                   'bzrlib.selftest.test_commit',
529
 
                   'bzrlib.selftest.test_commit_merge',
530
 
                   'bzrlib.selftest.testconfig',
531
 
                   'bzrlib.selftest.versioning',
532
 
                   'bzrlib.selftest.testmerge3',
533
 
                   'bzrlib.selftest.testmerge',
534
 
                   'bzrlib.selftest.testhashcache',
535
 
                   'bzrlib.selftest.teststatus',
536
 
                   'bzrlib.selftest.testlog',
537
 
                   'bzrlib.selftest.testrevisionnamespaces',
538
 
                   'bzrlib.selftest.testbranch',
539
 
                   'bzrlib.selftest.testrevision',
540
 
                   'bzrlib.selftest.test_revision_info',
541
 
                   'bzrlib.selftest.test_merge_core',
542
 
                   'bzrlib.selftest.test_smart_add',
543
 
                   'bzrlib.selftest.test_bad_files',
544
 
                   'bzrlib.selftest.testdiff',
545
 
                   'bzrlib.selftest.test_parent',
546
 
                   'bzrlib.selftest.test_xml',
547
 
                   'bzrlib.selftest.test_weave',
548
 
                   'bzrlib.selftest.testfetch',
549
 
                   'bzrlib.selftest.whitebox',
550
 
                   'bzrlib.selftest.teststore',
551
 
                   'bzrlib.selftest.blackbox',
552
 
                   'bzrlib.selftest.testsampler',
553
 
                   'bzrlib.selftest.testtransactions',
554
 
                   'bzrlib.selftest.testtransport',
555
 
                   'bzrlib.selftest.testgraph',
556
 
                   'bzrlib.selftest.testworkingtree',
557
 
                   'bzrlib.selftest.test_upgrade',
558
 
                   'bzrlib.selftest.test_conflicts',
559
 
                   'bzrlib.selftest.testtestament',
560
 
                   'bzrlib.selftest.testannotate',
561
 
                   'bzrlib.selftest.testrevprops',
562
 
                   'bzrlib.selftest.testoptions',
563
 
                   'bzrlib.selftest.testhttp',
564
 
                   'bzrlib.selftest.testnonascii',
 
1519
    """Build and return TestSuite for the whole of bzrlib.
 
1520
    
 
1521
    This function can be replaced if you need to change the default test
 
1522
    suite on a global basis, but it is not encouraged.
 
1523
    """
 
1524
    testmod_names = [
 
1525
                   'bzrlib.tests.test_ancestry',
 
1526
                   'bzrlib.tests.test_api',
 
1527
                   'bzrlib.tests.test_atomicfile',
 
1528
                   'bzrlib.tests.test_bad_files',
 
1529
                   'bzrlib.tests.test_branch',
 
1530
                   'bzrlib.tests.test_bundle',
 
1531
                   'bzrlib.tests.test_bzrdir',
 
1532
                   'bzrlib.tests.test_cache_utf8',
 
1533
                   'bzrlib.tests.test_command',
 
1534
                   'bzrlib.tests.test_commit',
 
1535
                   'bzrlib.tests.test_commit_merge',
 
1536
                   'bzrlib.tests.test_config',
 
1537
                   'bzrlib.tests.test_conflicts',
 
1538
                   'bzrlib.tests.test_decorators',
 
1539
                   'bzrlib.tests.test_diff',
 
1540
                   'bzrlib.tests.test_doc_generate',
 
1541
                   'bzrlib.tests.test_errors',
 
1542
                   'bzrlib.tests.test_escaped_store',
 
1543
                   'bzrlib.tests.test_fetch',
 
1544
                   'bzrlib.tests.test_ftp_transport',
 
1545
                   'bzrlib.tests.test_gpg',
 
1546
                   'bzrlib.tests.test_graph',
 
1547
                   'bzrlib.tests.test_hashcache',
 
1548
                   'bzrlib.tests.test_http',
 
1549
                   'bzrlib.tests.test_http_response',
 
1550
                   'bzrlib.tests.test_identitymap',
 
1551
                   'bzrlib.tests.test_ignores',
 
1552
                   'bzrlib.tests.test_inv',
 
1553
                   'bzrlib.tests.test_knit',
 
1554
                   'bzrlib.tests.test_lazy_import',
 
1555
                   'bzrlib.tests.test_lockdir',
 
1556
                   'bzrlib.tests.test_lockable_files',
 
1557
                   'bzrlib.tests.test_log',
 
1558
                   'bzrlib.tests.test_memorytree',
 
1559
                   'bzrlib.tests.test_merge',
 
1560
                   'bzrlib.tests.test_merge3',
 
1561
                   'bzrlib.tests.test_merge_core',
 
1562
                   'bzrlib.tests.test_missing',
 
1563
                   'bzrlib.tests.test_msgeditor',
 
1564
                   'bzrlib.tests.test_nonascii',
 
1565
                   'bzrlib.tests.test_options',
 
1566
                   'bzrlib.tests.test_osutils',
 
1567
                   'bzrlib.tests.test_patch',
 
1568
                   'bzrlib.tests.test_patches',
 
1569
                   'bzrlib.tests.test_permissions',
 
1570
                   'bzrlib.tests.test_plugins',
 
1571
                   'bzrlib.tests.test_progress',
 
1572
                   'bzrlib.tests.test_reconcile',
 
1573
                   'bzrlib.tests.test_repository',
 
1574
                   'bzrlib.tests.test_revert',
 
1575
                   'bzrlib.tests.test_revision',
 
1576
                   'bzrlib.tests.test_revisionnamespaces',
 
1577
                   'bzrlib.tests.test_revisiontree',
 
1578
                   'bzrlib.tests.test_rio',
 
1579
                   'bzrlib.tests.test_sampler',
 
1580
                   'bzrlib.tests.test_selftest',
 
1581
                   'bzrlib.tests.test_setup',
 
1582
                   'bzrlib.tests.test_sftp_transport',
 
1583
                   'bzrlib.tests.test_smart_add',
 
1584
                   'bzrlib.tests.test_smart_transport',
 
1585
                   'bzrlib.tests.test_source',
 
1586
                   'bzrlib.tests.test_status',
 
1587
                   'bzrlib.tests.test_store',
 
1588
                   'bzrlib.tests.test_symbol_versioning',
 
1589
                   'bzrlib.tests.test_testament',
 
1590
                   'bzrlib.tests.test_textfile',
 
1591
                   'bzrlib.tests.test_textmerge',
 
1592
                   'bzrlib.tests.test_trace',
 
1593
                   'bzrlib.tests.test_transactions',
 
1594
                   'bzrlib.tests.test_transform',
 
1595
                   'bzrlib.tests.test_transport',
 
1596
                   'bzrlib.tests.test_tree',
 
1597
                   'bzrlib.tests.test_treebuilder',
 
1598
                   'bzrlib.tests.test_tsort',
 
1599
                   'bzrlib.tests.test_tuned_gzip',
 
1600
                   'bzrlib.tests.test_ui',
 
1601
                   'bzrlib.tests.test_upgrade',
 
1602
                   'bzrlib.tests.test_urlutils',
 
1603
                   'bzrlib.tests.test_versionedfile',
 
1604
                   'bzrlib.tests.test_version',
 
1605
                   'bzrlib.tests.test_version_info',
 
1606
                   'bzrlib.tests.test_weave',
 
1607
                   'bzrlib.tests.test_whitebox',
 
1608
                   'bzrlib.tests.test_workingtree',
 
1609
                   'bzrlib.tests.test_xml',
565
1610
                   ]
566
 
 
567
 
    for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
568
 
              bzrlib.osutils, bzrlib.commands, bzrlib.merge3,
569
 
              bzrlib.errors,
570
 
              ):
571
 
        if m not in MODULES_TO_DOCTEST:
572
 
            MODULES_TO_DOCTEST.append(m)
573
 
 
574
 
    TestCase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
575
 
    print '%-30s %s' % ('bzr binary', TestCase.BZRPATH)
576
 
    print
577
 
    suite = TestSuite()
578
 
    suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
 
1611
    test_transport_implementations = [
 
1612
        'bzrlib.tests.test_transport_implementations',
 
1613
        'bzrlib.tests.test_read_bundle',
 
1614
        ]
 
1615
    suite = TestUtil.TestSuite()
 
1616
    loader = TestUtil.TestLoader()
 
1617
    suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
 
1618
    from bzrlib.transport import TransportTestProviderAdapter
 
1619
    adapter = TransportTestProviderAdapter()
 
1620
    adapt_modules(test_transport_implementations, adapter, loader, suite)
 
1621
    for package in packages_to_test():
 
1622
        suite.addTest(package.test_suite())
579
1623
    for m in MODULES_TO_TEST:
580
 
         suite.addTest(TestLoader().loadTestsFromModule(m))
581
 
    for m in (MODULES_TO_DOCTEST):
582
 
        suite.addTest(DocTestSuite(m))
583
 
    for p in bzrlib.plugin.all_plugins:
584
 
        if hasattr(p, 'test_suite'):
585
 
            suite.addTest(p.test_suite())
 
1624
        suite.addTest(loader.loadTestsFromModule(m))
 
1625
    for m in MODULES_TO_DOCTEST:
 
1626
        suite.addTest(doctest.DocTestSuite(m))
 
1627
    for name, plugin in bzrlib.plugin.all_plugins().items():
 
1628
        if getattr(plugin, 'test_suite', None) is not None:
 
1629
            suite.addTest(plugin.test_suite())
586
1630
    return suite
587
1631
 
 
1632
 
 
1633
def adapt_modules(mods_list, adapter, loader, suite):
 
1634
    """Adapt the modules in mods_list using adapter and add to suite."""
 
1635
    for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
 
1636
        suite.addTests(adapter.adapt(test))