/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: John Arbash Meinel
  • Date: 2006-10-06 07:00:57 UTC
  • mto: This revision was merged to the branch mainline in revision 2071.
  • Revision ID: john@arbash-meinel.com-20061006070057-d09e21288bcd371c
Make cmd_version_info.py lazy import most other modules

Show diffs side-by-side

added added

removed removed

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