/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-16 06:31:55 UTC
  • mto: This revision was merged to the branch mainline in revision 2082.
  • Revision ID: john@arbash-meinel.com-20061016063155-4ebed425a35c9adb
Make 'bzr remerge' not use deprecated WorkingTree.iter_conflicts

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 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
        :param allow_plugins: By default the subprocess is run with
 
931
            --no-plugins to ensure test reproducibility. Also, it is possible
 
932
            for system-wide plugins to create unexpected output on stderr,
 
933
            which can cause unnecessary test failures.
 
934
        """
 
935
        env_changes = kwargs.get('env_changes', {})
 
936
        working_dir = kwargs.get('working_dir', None)
 
937
        allow_plugins = kwargs.get('allow_plugins', False)
 
938
        process = self.start_bzr_subprocess(args, env_changes=env_changes,
 
939
                                            working_dir=working_dir,
 
940
                                            allow_plugins=allow_plugins)
 
941
        # We distinguish between retcode=None and retcode not passed.
 
942
        supplied_retcode = kwargs.get('retcode', 0)
 
943
        return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
 
944
            universal_newlines=kwargs.get('universal_newlines', False),
 
945
            process_args=args)
 
946
 
 
947
    def start_bzr_subprocess(self, process_args, env_changes=None,
 
948
                             skip_if_plan_to_signal=False,
 
949
                             working_dir=None,
 
950
                             allow_plugins=False):
 
951
        """Start bzr in a subprocess for testing.
 
952
 
 
953
        This starts a new Python interpreter and runs bzr in there.
 
954
        This should only be used for tests that have a justifiable need for
 
955
        this isolation: e.g. they are testing startup time, or signal
 
956
        handling, or early startup code, etc.  Subprocess code can't be
 
957
        profiled or debugged so easily.
 
958
 
 
959
        :param process_args: a list of arguments to pass to the bzr executable,
 
960
            for example `['--version']`.
 
961
        :param env_changes: A dictionary which lists changes to environment
 
962
            variables. A value of None will unset the env variable.
 
963
            The values must be strings. The change will only occur in the
 
964
            child, so you don't need to fix the environment after running.
 
965
        :param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
 
966
            is not available.
 
967
        :param allow_plugins: If False (default) pass --no-plugins to bzr.
 
968
 
 
969
        :returns: Popen object for the started process.
 
970
        """
 
971
        if skip_if_plan_to_signal:
 
972
            if not getattr(os, 'kill', None):
 
973
                raise TestSkipped("os.kill not available.")
 
974
 
 
975
        if env_changes is None:
 
976
            env_changes = {}
 
977
        old_env = {}
 
978
 
 
979
        def cleanup_environment():
 
980
            for env_var, value in env_changes.iteritems():
 
981
                old_env[env_var] = osutils.set_or_unset_env(env_var, value)
 
982
 
 
983
        def restore_environment():
 
984
            for env_var, value in old_env.iteritems():
 
985
                osutils.set_or_unset_env(env_var, value)
 
986
 
 
987
        bzr_path = self.get_bzr_path()
 
988
 
 
989
        cwd = None
 
990
        if working_dir is not None:
 
991
            cwd = osutils.getcwd()
 
992
            os.chdir(working_dir)
 
993
 
 
994
        try:
 
995
            # win32 subprocess doesn't support preexec_fn
 
996
            # so we will avoid using it on all platforms, just to
 
997
            # make sure the code path is used, and we don't break on win32
 
998
            cleanup_environment()
 
999
            command = [sys.executable, bzr_path]
 
1000
            if not allow_plugins:
 
1001
                command.append('--no-plugins')
 
1002
            command.extend(process_args)
 
1003
            process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
 
1004
        finally:
 
1005
            restore_environment()
 
1006
            if cwd is not None:
 
1007
                os.chdir(cwd)
 
1008
 
 
1009
        return process
 
1010
 
 
1011
    def _popen(self, *args, **kwargs):
 
1012
        """Place a call to Popen.
 
1013
 
 
1014
        Allows tests to override this method to intercept the calls made to
 
1015
        Popen for introspection.
 
1016
        """
 
1017
        return Popen(*args, **kwargs)
 
1018
 
 
1019
    def get_bzr_path(self):
 
1020
        """Return the path of the 'bzr' executable for this test suite."""
 
1021
        bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
 
1022
        if not os.path.isfile(bzr_path):
 
1023
            # We are probably installed. Assume sys.argv is the right file
 
1024
            bzr_path = sys.argv[0]
 
1025
        return bzr_path
 
1026
 
 
1027
    def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
 
1028
                              universal_newlines=False, process_args=None):
 
1029
        """Finish the execution of process.
 
1030
 
 
1031
        :param process: the Popen object returned from start_bzr_subprocess.
 
1032
        :param retcode: The status code that is expected.  Defaults to 0.  If
 
1033
            None is supplied, the status code is not checked.
 
1034
        :param send_signal: an optional signal to send to the process.
 
1035
        :param universal_newlines: Convert CRLF => LF
 
1036
        :returns: (stdout, stderr)
 
1037
        """
 
1038
        if send_signal is not None:
 
1039
            os.kill(process.pid, send_signal)
 
1040
        out, err = process.communicate()
 
1041
 
 
1042
        if universal_newlines:
 
1043
            out = out.replace('\r\n', '\n')
 
1044
            err = err.replace('\r\n', '\n')
 
1045
 
 
1046
        if retcode is not None and retcode != process.returncode:
 
1047
            if process_args is None:
 
1048
                process_args = "(unknown args)"
 
1049
            mutter('Output of bzr %s:\n%s', process_args, out)
 
1050
            mutter('Error for bzr %s:\n%s', process_args, err)
 
1051
            self.fail('Command bzr %s failed with retcode %s != %s'
 
1052
                      % (process_args, retcode, process.returncode))
 
1053
        return [out, err]
 
1054
 
 
1055
    def check_inventory_shape(self, inv, shape):
 
1056
        """Compare an inventory to a list of expected names.
 
1057
 
 
1058
        Fail if they are not precisely equal.
 
1059
        """
 
1060
        extras = []
 
1061
        shape = list(shape)             # copy
 
1062
        for path, ie in inv.entries():
 
1063
            name = path.replace('\\', '/')
 
1064
            if ie.kind == 'dir':
 
1065
                name = name + '/'
 
1066
            if name in shape:
 
1067
                shape.remove(name)
 
1068
            else:
 
1069
                extras.append(name)
 
1070
        if shape:
 
1071
            self.fail("expected paths not found in inventory: %r" % shape)
 
1072
        if extras:
 
1073
            self.fail("unexpected paths found in inventory: %r" % extras)
 
1074
 
 
1075
    def apply_redirected(self, stdin=None, stdout=None, stderr=None,
 
1076
                         a_callable=None, *args, **kwargs):
 
1077
        """Call callable with redirected std io pipes.
 
1078
 
 
1079
        Returns the return code."""
 
1080
        if not callable(a_callable):
 
1081
            raise ValueError("a_callable must be callable.")
 
1082
        if stdin is None:
 
1083
            stdin = StringIO("")
 
1084
        if stdout is None:
 
1085
            if getattr(self, "_log_file", None) is not None:
 
1086
                stdout = self._log_file
 
1087
            else:
 
1088
                stdout = StringIO()
 
1089
        if stderr is None:
 
1090
            if getattr(self, "_log_file", None is not None):
 
1091
                stderr = self._log_file
 
1092
            else:
 
1093
                stderr = StringIO()
 
1094
        real_stdin = sys.stdin
 
1095
        real_stdout = sys.stdout
 
1096
        real_stderr = sys.stderr
 
1097
        try:
 
1098
            sys.stdout = stdout
 
1099
            sys.stderr = stderr
 
1100
            sys.stdin = stdin
 
1101
            return a_callable(*args, **kwargs)
 
1102
        finally:
 
1103
            sys.stdout = real_stdout
 
1104
            sys.stderr = real_stderr
 
1105
            sys.stdin = real_stdin
 
1106
 
 
1107
    @symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
 
1108
    def merge(self, branch_from, wt_to):
 
1109
        """A helper for tests to do a ui-less merge.
 
1110
 
 
1111
        This should move to the main library when someone has time to integrate
 
1112
        it in.
 
1113
        """
 
1114
        # minimal ui-less merge.
 
1115
        wt_to.branch.fetch(branch_from)
 
1116
        base_rev = common_ancestor(branch_from.last_revision(),
 
1117
                                   wt_to.branch.last_revision(),
 
1118
                                   wt_to.branch.repository)
 
1119
        merge_inner(wt_to.branch, branch_from.basis_tree(),
 
1120
                    wt_to.branch.repository.revision_tree(base_rev),
 
1121
                    this_tree=wt_to)
 
1122
        wt_to.add_parent_tree_id(branch_from.last_revision())
 
1123
 
 
1124
 
 
1125
BzrTestBase = TestCase
 
1126
 
 
1127
 
 
1128
class TestCaseWithMemoryTransport(TestCase):
 
1129
    """Common test class for tests that do not need disk resources.
 
1130
 
 
1131
    Tests that need disk resources should derive from TestCaseWithTransport.
 
1132
 
 
1133
    TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
 
1134
 
 
1135
    For TestCaseWithMemoryTransport the test_home_dir is set to the name of
 
1136
    a directory which does not exist. This serves to help ensure test isolation
 
1137
    is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
 
1138
    must exist. However, TestCaseWithMemoryTransport does not offer local
 
1139
    file defaults for the transport in tests, nor does it obey the command line
 
1140
    override, so tests that accidentally write to the common directory should
 
1141
    be rare.
 
1142
    """
 
1143
 
 
1144
    TEST_ROOT = None
 
1145
    _TEST_NAME = 'test'
 
1146
 
 
1147
 
 
1148
    def __init__(self, methodName='runTest'):
 
1149
        # allow test parameterisation after test construction and before test
 
1150
        # execution. Variables that the parameteriser sets need to be 
 
1151
        # ones that are not set by setUp, or setUp will trash them.
 
1152
        super(TestCaseWithMemoryTransport, self).__init__(methodName)
 
1153
        self.transport_server = default_transport
 
1154
        self.transport_readonly_server = None
 
1155
 
 
1156
    def failUnlessExists(self, path):
 
1157
        """Fail unless path, which may be abs or relative, exists."""
 
1158
        self.failUnless(osutils.lexists(path))
 
1159
 
 
1160
    def failIfExists(self, path):
 
1161
        """Fail if path, which may be abs or relative, exists."""
 
1162
        self.failIf(osutils.lexists(path))
 
1163
        
 
1164
    def get_transport(self):
 
1165
        """Return a writeable transport for the test scratch space"""
 
1166
        t = get_transport(self.get_url())
 
1167
        self.assertFalse(t.is_readonly())
 
1168
        return t
 
1169
 
 
1170
    def get_readonly_transport(self):
 
1171
        """Return a readonly transport for the test scratch space
 
1172
        
 
1173
        This can be used to test that operations which should only need
 
1174
        readonly access in fact do not try to write.
 
1175
        """
 
1176
        t = get_transport(self.get_readonly_url())
 
1177
        self.assertTrue(t.is_readonly())
 
1178
        return t
 
1179
 
 
1180
    def get_readonly_server(self):
 
1181
        """Get the server instance for the readonly transport
 
1182
 
 
1183
        This is useful for some tests with specific servers to do diagnostics.
 
1184
        """
 
1185
        if self.__readonly_server is None:
 
1186
            if self.transport_readonly_server is None:
 
1187
                # readonly decorator requested
 
1188
                # bring up the server
 
1189
                self.get_url()
 
1190
                self.__readonly_server = ReadonlyServer()
 
1191
                self.__readonly_server.setUp(self.__server)
 
1192
            else:
 
1193
                self.__readonly_server = self.transport_readonly_server()
 
1194
                self.__readonly_server.setUp()
 
1195
            self.addCleanup(self.__readonly_server.tearDown)
 
1196
        return self.__readonly_server
 
1197
 
 
1198
    def get_readonly_url(self, relpath=None):
 
1199
        """Get a URL for the readonly transport.
 
1200
 
 
1201
        This will either be backed by '.' or a decorator to the transport 
 
1202
        used by self.get_url()
 
1203
        relpath provides for clients to get a path relative to the base url.
 
1204
        These should only be downwards relative, not upwards.
 
1205
        """
 
1206
        base = self.get_readonly_server().get_url()
 
1207
        if relpath is not None:
 
1208
            if not base.endswith('/'):
 
1209
                base = base + '/'
 
1210
            base = base + relpath
 
1211
        return base
 
1212
 
 
1213
    def get_server(self):
 
1214
        """Get the read/write server instance.
 
1215
 
 
1216
        This is useful for some tests with specific servers that need
 
1217
        diagnostics.
 
1218
 
 
1219
        For TestCaseWithMemoryTransport this is always a MemoryServer, and there
 
1220
        is no means to override it.
 
1221
        """
 
1222
        if self.__server is None:
 
1223
            self.__server = MemoryServer()
 
1224
            self.__server.setUp()
 
1225
            self.addCleanup(self.__server.tearDown)
 
1226
        return self.__server
 
1227
 
 
1228
    def get_url(self, relpath=None):
 
1229
        """Get a URL (or maybe a path) for the readwrite transport.
 
1230
 
 
1231
        This will either be backed by '.' or to an equivalent non-file based
 
1232
        facility.
 
1233
        relpath provides for clients to get a path relative to the base url.
 
1234
        These should only be downwards relative, not upwards.
 
1235
        """
 
1236
        base = self.get_server().get_url()
 
1237
        if relpath is not None and relpath != '.':
 
1238
            if not base.endswith('/'):
 
1239
                base = base + '/'
 
1240
            # XXX: Really base should be a url; we did after all call
 
1241
            # get_url()!  But sometimes it's just a path (from
 
1242
            # LocalAbspathServer), and it'd be wrong to append urlescaped data
 
1243
            # to a non-escaped local path.
 
1244
            if base.startswith('./') or base.startswith('/'):
 
1245
                base += relpath
 
1246
            else:
 
1247
                base += urlutils.escape(relpath)
 
1248
        return base
 
1249
 
 
1250
    def _make_test_root(self):
 
1251
        if TestCaseWithMemoryTransport.TEST_ROOT is not None:
 
1252
            return
 
1253
        i = 0
 
1254
        while True:
 
1255
            root = u'test%04d.tmp' % i
 
1256
            try:
 
1257
                os.mkdir(root)
 
1258
            except OSError, e:
 
1259
                if e.errno == errno.EEXIST:
 
1260
                    i += 1
 
1261
                    continue
 
1262
                else:
 
1263
                    raise
 
1264
            # successfully created
 
1265
            TestCaseWithMemoryTransport.TEST_ROOT = osutils.abspath(root)
 
1266
            break
 
1267
        # make a fake bzr directory there to prevent any tests propagating
 
1268
        # up onto the source directory's real branch
 
1269
        bzrdir.BzrDir.create_standalone_workingtree(
 
1270
            TestCaseWithMemoryTransport.TEST_ROOT)
 
1271
 
 
1272
    def makeAndChdirToTestDir(self):
 
1273
        """Create a temporary directories for this one test.
 
1274
        
 
1275
        This must set self.test_home_dir and self.test_dir and chdir to
 
1276
        self.test_dir.
 
1277
        
 
1278
        For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
 
1279
        """
 
1280
        os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
 
1281
        self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
 
1282
        self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
 
1283
        
 
1284
    def make_branch(self, relpath, format=None):
 
1285
        """Create a branch on the transport at relpath."""
 
1286
        repo = self.make_repository(relpath, format=format)
 
1287
        return repo.bzrdir.create_branch()
 
1288
 
 
1289
    def make_bzrdir(self, relpath, format=None):
 
1290
        try:
 
1291
            # might be a relative or absolute path
 
1292
            maybe_a_url = self.get_url(relpath)
 
1293
            segments = maybe_a_url.rsplit('/', 1)
 
1294
            t = get_transport(maybe_a_url)
 
1295
            if len(segments) > 1 and segments[-1] not in ('', '.'):
 
1296
                try:
 
1297
                    t.mkdir('.')
 
1298
                except errors.FileExists:
 
1299
                    pass
 
1300
            if format is None:
 
1301
                format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
 
1302
            return format.initialize_on_transport(t)
 
1303
        except errors.UninitializableFormat:
 
1304
            raise TestSkipped("Format %s is not initializable." % format)
 
1305
 
 
1306
    def make_repository(self, relpath, shared=False, format=None):
 
1307
        """Create a repository on our default transport at relpath."""
 
1308
        made_control = self.make_bzrdir(relpath, format=format)
 
1309
        return made_control.create_repository(shared=shared)
 
1310
 
 
1311
    def make_branch_and_memory_tree(self, relpath, format=None):
 
1312
        """Create a branch on the default transport and a MemoryTree for it."""
 
1313
        b = self.make_branch(relpath, format=format)
 
1314
        return memorytree.MemoryTree.create_on_branch(b)
 
1315
 
 
1316
    def overrideEnvironmentForTesting(self):
 
1317
        os.environ['HOME'] = self.test_home_dir
 
1318
        os.environ['APPDATA'] = self.test_home_dir
 
1319
        
 
1320
    def setUp(self):
 
1321
        super(TestCaseWithMemoryTransport, self).setUp()
 
1322
        self._make_test_root()
 
1323
        _currentdir = os.getcwdu()
 
1324
        def _leaveDirectory():
 
1325
            os.chdir(_currentdir)
 
1326
        self.addCleanup(_leaveDirectory)
 
1327
        self.makeAndChdirToTestDir()
 
1328
        self.overrideEnvironmentForTesting()
 
1329
        self.__readonly_server = None
 
1330
        self.__server = None
 
1331
 
 
1332
     
 
1333
class TestCaseInTempDir(TestCaseWithMemoryTransport):
 
1334
    """Derived class that runs a test within a temporary directory.
 
1335
 
 
1336
    This is useful for tests that need to create a branch, etc.
 
1337
 
 
1338
    The directory is created in a slightly complex way: for each
 
1339
    Python invocation, a new temporary top-level directory is created.
 
1340
    All test cases create their own directory within that.  If the
 
1341
    tests complete successfully, the directory is removed.
 
1342
 
 
1343
    InTempDir is an old alias for FunctionalTestCase.
 
1344
    """
 
1345
 
 
1346
    OVERRIDE_PYTHON = 'python'
 
1347
 
 
1348
    def check_file_contents(self, filename, expect):
 
1349
        self.log("check contents of file %s" % filename)
 
1350
        contents = file(filename, 'r').read()
 
1351
        if contents != expect:
 
1352
            self.log("expected: %r" % expect)
 
1353
            self.log("actually: %r" % contents)
 
1354
            self.fail("contents of %s not as expected" % filename)
 
1355
 
 
1356
    def makeAndChdirToTestDir(self):
 
1357
        """See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
 
1358
        
 
1359
        For TestCaseInTempDir we create a temporary directory based on the test
 
1360
        name and then create two subdirs - test and home under it.
 
1361
        """
 
1362
        # shorten the name, to avoid test failures due to path length
 
1363
        short_id = self.id().replace('bzrlib.tests.', '') \
 
1364
                   .replace('__main__.', '')[-100:]
 
1365
        # it's possible the same test class is run several times for
 
1366
        # parameterized tests, so make sure the names don't collide.  
 
1367
        i = 0
 
1368
        while True:
 
1369
            if i > 0:
 
1370
                candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
 
1371
            else:
 
1372
                candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
 
1373
            if os.path.exists(candidate_dir):
 
1374
                i = i + 1
 
1375
                continue
 
1376
            else:
 
1377
                os.mkdir(candidate_dir)
 
1378
                self.test_home_dir = candidate_dir + '/home'
 
1379
                os.mkdir(self.test_home_dir)
 
1380
                self.test_dir = candidate_dir + '/work'
 
1381
                os.mkdir(self.test_dir)
 
1382
                os.chdir(self.test_dir)
 
1383
                break
 
1384
 
 
1385
    def build_tree(self, shape, line_endings='native', transport=None):
 
1386
        """Build a test tree according to a pattern.
 
1387
 
 
1388
        shape is a sequence of file specifications.  If the final
 
1389
        character is '/', a directory is created.
 
1390
 
 
1391
        This assumes that all the elements in the tree being built are new.
 
1392
 
 
1393
        This doesn't add anything to a branch.
 
1394
        :param line_endings: Either 'binary' or 'native'
 
1395
                             in binary mode, exact contents are written
 
1396
                             in native mode, the line endings match the
 
1397
                             default platform endings.
 
1398
 
 
1399
        :param transport: A transport to write to, for building trees on 
 
1400
                          VFS's. If the transport is readonly or None,
 
1401
                          "." is opened automatically.
 
1402
        """
 
1403
        # It's OK to just create them using forward slashes on windows.
 
1404
        if transport is None or transport.is_readonly():
 
1405
            transport = get_transport(".")
 
1406
        for name in shape:
 
1407
            self.assert_(isinstance(name, basestring))
 
1408
            if name[-1] == '/':
 
1409
                transport.mkdir(urlutils.escape(name[:-1]))
 
1410
            else:
 
1411
                if line_endings == 'binary':
 
1412
                    end = '\n'
 
1413
                elif line_endings == 'native':
 
1414
                    end = os.linesep
 
1415
                else:
 
1416
                    raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
 
1417
                content = "contents of %s%s" % (name.encode('utf-8'), end)
 
1418
                # Technically 'put()' is the right command. However, put
 
1419
                # uses an AtomicFile, which requires an extra rename into place
 
1420
                # As long as the files didn't exist in the past, append() will
 
1421
                # do the same thing as put()
 
1422
                # On jam's machine, make_kernel_like_tree is:
 
1423
                #   put:    4.5-7.5s (averaging 6s)
 
1424
                #   append: 2.9-4.5s
 
1425
                #   put_non_atomic: 2.9-4.5s
 
1426
                transport.put_bytes_non_atomic(urlutils.escape(name), content)
 
1427
 
 
1428
    def build_tree_contents(self, shape):
 
1429
        build_tree_contents(shape)
 
1430
 
 
1431
    def assertFileEqual(self, content, path):
 
1432
        """Fail if path does not contain 'content'."""
 
1433
        self.failUnless(osutils.lexists(path))
 
1434
        # TODO: jam 20060427 Shouldn't this be 'rb'?
 
1435
        self.assertEqualDiff(content, open(path, 'r').read())
 
1436
 
 
1437
 
 
1438
class TestCaseWithTransport(TestCaseInTempDir):
 
1439
    """A test case that provides get_url and get_readonly_url facilities.
 
1440
 
 
1441
    These back onto two transport servers, one for readonly access and one for
 
1442
    read write access.
 
1443
 
 
1444
    If no explicit class is provided for readonly access, a
 
1445
    ReadonlyTransportDecorator is used instead which allows the use of non disk
 
1446
    based read write transports.
 
1447
 
 
1448
    If an explicit class is provided for readonly access, that server and the 
 
1449
    readwrite one must both define get_url() as resolving to os.getcwd().
 
1450
    """
 
1451
 
 
1452
    def get_server(self):
 
1453
        """See TestCaseWithMemoryTransport.
 
1454
 
 
1455
        This is useful for some tests with specific servers that need
 
1456
        diagnostics.
 
1457
        """
 
1458
        if self.__server is None:
 
1459
            self.__server = self.transport_server()
 
1460
            self.__server.setUp()
 
1461
            self.addCleanup(self.__server.tearDown)
 
1462
        return self.__server
 
1463
 
 
1464
    def make_branch_and_tree(self, relpath, format=None):
 
1465
        """Create a branch on the transport and a tree locally.
 
1466
 
 
1467
        If the transport is not a LocalTransport, the Tree can't be created on
 
1468
        the transport.  In that case the working tree is created in the local
 
1469
        directory, and the returned tree's branch and repository will also be
 
1470
        accessed locally.
 
1471
 
 
1472
        This will fail if the original default transport for this test
 
1473
        case wasn't backed by the working directory, as the branch won't
 
1474
        be on disk for us to open it.  
 
1475
 
 
1476
        :param format: The BzrDirFormat.
 
1477
        :returns: the WorkingTree.
 
1478
        """
 
1479
        # TODO: always use the local disk path for the working tree,
 
1480
        # this obviously requires a format that supports branch references
 
1481
        # so check for that by checking bzrdir.BzrDirFormat.get_default_format()
 
1482
        # RBC 20060208
 
1483
        b = self.make_branch(relpath, format=format)
 
1484
        try:
 
1485
            return b.bzrdir.create_workingtree()
 
1486
        except errors.NotLocalUrl:
 
1487
            # We can only make working trees locally at the moment.  If the
 
1488
            # transport can't support them, then reopen the branch on a local
 
1489
            # transport, and create the working tree there.  
 
1490
            #
 
1491
            # Possibly we should instead keep
 
1492
            # the non-disk-backed branch and create a local checkout?
 
1493
            bd = bzrdir.BzrDir.open(relpath)
 
1494
            return bd.create_workingtree()
 
1495
 
 
1496
    def assertIsDirectory(self, relpath, transport):
 
1497
        """Assert that relpath within transport is a directory.
 
1498
 
 
1499
        This may not be possible on all transports; in that case it propagates
 
1500
        a TransportNotPossible.
 
1501
        """
 
1502
        try:
 
1503
            mode = transport.stat(relpath).st_mode
 
1504
        except errors.NoSuchFile:
 
1505
            self.fail("path %s is not a directory; no such file"
 
1506
                      % (relpath))
 
1507
        if not stat.S_ISDIR(mode):
 
1508
            self.fail("path %s is not a directory; has mode %#o"
 
1509
                      % (relpath, mode))
 
1510
 
 
1511
    def setUp(self):
 
1512
        super(TestCaseWithTransport, self).setUp()
 
1513
        self.__server = None
 
1514
        self.transport_server = default_transport
 
1515
 
 
1516
 
 
1517
class ChrootedTestCase(TestCaseWithTransport):
 
1518
    """A support class that provides readonly urls outside the local namespace.
 
1519
 
 
1520
    This is done by checking if self.transport_server is a MemoryServer. if it
 
1521
    is then we are chrooted already, if it is not then an HttpServer is used
 
1522
    for readonly urls.
 
1523
 
 
1524
    TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
 
1525
                       be used without needed to redo it when a different 
 
1526
                       subclass is in use ?
 
1527
    """
 
1528
 
 
1529
    def setUp(self):
 
1530
        super(ChrootedTestCase, self).setUp()
 
1531
        if not self.transport_server == bzrlib.transport.memory.MemoryServer:
 
1532
            self.transport_readonly_server = bzrlib.transport.http.HttpServer
 
1533
 
 
1534
 
 
1535
def filter_suite_by_re(suite, pattern):
 
1536
    result = TestUtil.TestSuite()
 
1537
    filter_re = re.compile(pattern)
 
1538
    for test in iter_suite_tests(suite):
 
1539
        if filter_re.search(test.id()):
 
1540
            result.addTest(test)
 
1541
    return result
 
1542
 
 
1543
 
 
1544
def run_suite(suite, name='test', verbose=False, pattern=".*",
 
1545
              stop_on_failure=False, keep_output=False,
 
1546
              transport=None, lsprof_timed=None, bench_history=None):
 
1547
    TestCase._gather_lsprof_in_benchmarks = lsprof_timed
 
1548
    if verbose:
 
1549
        verbosity = 2
 
1550
        pb = None
 
1551
    else:
 
1552
        verbosity = 1
 
1553
        pb = progress.ProgressBar()
 
1554
    runner = TextTestRunner(stream=sys.stdout,
 
1555
                            descriptions=0,
 
1556
                            verbosity=verbosity,
 
1557
                            keep_output=keep_output,
 
1558
                            pb=pb,
 
1559
                            bench_history=bench_history)
 
1560
    runner.stop_on_failure=stop_on_failure
 
1561
    if pattern != '.*':
 
1562
        suite = filter_suite_by_re(suite, pattern)
 
1563
    result = runner.run(suite)
 
1564
    return result.wasSuccessful()
 
1565
 
 
1566
 
 
1567
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
 
1568
             keep_output=False,
 
1569
             transport=None,
 
1570
             test_suite_factory=None,
 
1571
             lsprof_timed=None,
 
1572
             bench_history=None):
 
1573
    """Run the whole test suite under the enhanced runner"""
 
1574
    # XXX: Very ugly way to do this...
 
1575
    # Disable warning about old formats because we don't want it to disturb
 
1576
    # any blackbox tests.
 
1577
    from bzrlib import repository
 
1578
    repository._deprecation_warning_done = True
 
1579
 
 
1580
    global default_transport
 
1581
    if transport is None:
 
1582
        transport = default_transport
 
1583
    old_transport = default_transport
 
1584
    default_transport = transport
 
1585
    try:
 
1586
        if test_suite_factory is None:
 
1587
            suite = test_suite()
 
1588
        else:
 
1589
            suite = test_suite_factory()
 
1590
        return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
 
1591
                     stop_on_failure=stop_on_failure, keep_output=keep_output,
 
1592
                     transport=transport,
 
1593
                     lsprof_timed=lsprof_timed,
 
1594
                     bench_history=bench_history)
 
1595
    finally:
 
1596
        default_transport = old_transport
 
1597
 
 
1598
 
 
1599
def test_suite():
 
1600
    """Build and return TestSuite for the whole of bzrlib.
 
1601
    
 
1602
    This function can be replaced if you need to change the default test
 
1603
    suite on a global basis, but it is not encouraged.
 
1604
    """
 
1605
    testmod_names = [
 
1606
                   'bzrlib.tests.test_ancestry',
 
1607
                   'bzrlib.tests.test_api',
 
1608
                   'bzrlib.tests.test_atomicfile',
 
1609
                   'bzrlib.tests.test_bad_files',
 
1610
                   'bzrlib.tests.test_branch',
 
1611
                   'bzrlib.tests.test_bundle',
 
1612
                   'bzrlib.tests.test_bzrdir',
 
1613
                   'bzrlib.tests.test_cache_utf8',
 
1614
                   'bzrlib.tests.test_command',
 
1615
                   'bzrlib.tests.test_commit',
 
1616
                   'bzrlib.tests.test_commit_merge',
 
1617
                   'bzrlib.tests.test_config',
 
1618
                   'bzrlib.tests.test_conflicts',
 
1619
                   'bzrlib.tests.test_decorators',
 
1620
                   'bzrlib.tests.test_diff',
 
1621
                   'bzrlib.tests.test_doc_generate',
 
1622
                   'bzrlib.tests.test_errors',
 
1623
                   'bzrlib.tests.test_escaped_store',
 
1624
                   'bzrlib.tests.test_fetch',
 
1625
                   'bzrlib.tests.test_ftp_transport',
 
1626
                   'bzrlib.tests.test_gpg',
 
1627
                   'bzrlib.tests.test_graph',
 
1628
                   'bzrlib.tests.test_hashcache',
 
1629
                   'bzrlib.tests.test_http',
 
1630
                   'bzrlib.tests.test_http_response',
 
1631
                   'bzrlib.tests.test_identitymap',
 
1632
                   'bzrlib.tests.test_ignores',
 
1633
                   'bzrlib.tests.test_inv',
 
1634
                   'bzrlib.tests.test_knit',
 
1635
                   'bzrlib.tests.test_lazy_import',
 
1636
                   'bzrlib.tests.test_lazy_regex',
 
1637
                   'bzrlib.tests.test_lockdir',
 
1638
                   'bzrlib.tests.test_lockable_files',
 
1639
                   'bzrlib.tests.test_log',
 
1640
                   'bzrlib.tests.test_memorytree',
 
1641
                   'bzrlib.tests.test_merge',
 
1642
                   'bzrlib.tests.test_merge3',
 
1643
                   'bzrlib.tests.test_merge_core',
 
1644
                   'bzrlib.tests.test_missing',
 
1645
                   'bzrlib.tests.test_msgeditor',
 
1646
                   'bzrlib.tests.test_nonascii',
 
1647
                   'bzrlib.tests.test_options',
 
1648
                   'bzrlib.tests.test_osutils',
 
1649
                   'bzrlib.tests.test_patch',
 
1650
                   'bzrlib.tests.test_patches',
 
1651
                   'bzrlib.tests.test_permissions',
 
1652
                   'bzrlib.tests.test_plugins',
 
1653
                   'bzrlib.tests.test_progress',
 
1654
                   'bzrlib.tests.test_reconcile',
 
1655
                   'bzrlib.tests.test_registry',
 
1656
                   'bzrlib.tests.test_repository',
 
1657
                   'bzrlib.tests.test_revert',
 
1658
                   'bzrlib.tests.test_revision',
 
1659
                   'bzrlib.tests.test_revisionnamespaces',
 
1660
                   'bzrlib.tests.test_revisiontree',
 
1661
                   'bzrlib.tests.test_rio',
 
1662
                   'bzrlib.tests.test_sampler',
 
1663
                   'bzrlib.tests.test_selftest',
 
1664
                   'bzrlib.tests.test_setup',
 
1665
                   'bzrlib.tests.test_sftp_transport',
 
1666
                   'bzrlib.tests.test_smart_add',
 
1667
                   'bzrlib.tests.test_smart_transport',
 
1668
                   'bzrlib.tests.test_source',
 
1669
                   'bzrlib.tests.test_status',
 
1670
                   'bzrlib.tests.test_store',
 
1671
                   'bzrlib.tests.test_symbol_versioning',
 
1672
                   'bzrlib.tests.test_testament',
 
1673
                   'bzrlib.tests.test_textfile',
 
1674
                   'bzrlib.tests.test_textmerge',
 
1675
                   'bzrlib.tests.test_trace',
 
1676
                   'bzrlib.tests.test_transactions',
 
1677
                   'bzrlib.tests.test_transform',
 
1678
                   'bzrlib.tests.test_transport',
 
1679
                   'bzrlib.tests.test_tree',
 
1680
                   'bzrlib.tests.test_treebuilder',
 
1681
                   'bzrlib.tests.test_tsort',
 
1682
                   'bzrlib.tests.test_tuned_gzip',
 
1683
                   'bzrlib.tests.test_ui',
 
1684
                   'bzrlib.tests.test_upgrade',
 
1685
                   'bzrlib.tests.test_urlutils',
 
1686
                   'bzrlib.tests.test_versionedfile',
 
1687
                   'bzrlib.tests.test_version',
 
1688
                   'bzrlib.tests.test_version_info',
 
1689
                   'bzrlib.tests.test_weave',
 
1690
                   'bzrlib.tests.test_whitebox',
 
1691
                   'bzrlib.tests.test_workingtree',
 
1692
                   'bzrlib.tests.test_xml',
 
1693
                   ]
 
1694
    test_transport_implementations = [
 
1695
        'bzrlib.tests.test_transport_implementations',
 
1696
        'bzrlib.tests.test_read_bundle',
 
1697
        ]
 
1698
    suite = TestUtil.TestSuite()
 
1699
    loader = TestUtil.TestLoader()
 
1700
    suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
 
1701
    from bzrlib.transport import TransportTestProviderAdapter
 
1702
    adapter = TransportTestProviderAdapter()
 
1703
    adapt_modules(test_transport_implementations, adapter, loader, suite)
 
1704
    for package in packages_to_test():
 
1705
        suite.addTest(package.test_suite())
 
1706
    for m in MODULES_TO_TEST:
 
1707
        suite.addTest(loader.loadTestsFromModule(m))
 
1708
    for m in MODULES_TO_DOCTEST:
 
1709
        try:
 
1710
            suite.addTest(doctest.DocTestSuite(m))
 
1711
        except ValueError, e:
 
1712
            print '**failed to get doctest for: %s\n%s' %(m,e)
 
1713
            raise
 
1714
    for name, plugin in bzrlib.plugin.all_plugins().items():
 
1715
        if getattr(plugin, 'test_suite', None) is not None:
 
1716
            suite.addTest(plugin.test_suite())
 
1717
    return suite
 
1718
 
 
1719
 
 
1720
def adapt_modules(mods_list, adapter, loader, suite):
 
1721
    """Adapt the modules in mods_list using adapter and add to suite."""
 
1722
    for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
 
1723
        suite.addTests(adapter.adapt(test))