/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

Better (but still incomplete) design for bogus servers.

* bzrlib/transport/http/_urllib2_wrappers.py:
(AbstractHTTPHandler): Add 'Accept: */*' again to default headers
until I fully understand why and when it's needed or not (curl add
it if no Accept header is present).

* bzrlib/transport/http/_pycurl.py:
(PyCurlTransport._curl_perform): CURLE_GOT_NOTHING may be
considered as a ConnectionError, inspection of curl code reveals
that the case is sufficiently rare and low level related to not be
considered an http error per se.

* bzrlib/transport/http/__init__.py:
(WallHttpServer): Deleted.

* bzrlib/tests/test_http.py:
(TestBogusServer): Factor out the tests common to the bogus
servers.

* bzrlib/tests/__init__.py:
(TestCaseWithTransport.create_transport_server,
TestCaseWithTransport.create_transport_readonly_server): New
methods, allows test cases to specify the transport servers
without defining useless classes.
(TestCaseWithTransport.get_readonly_server): Use
create_transport_readonly_server.
(TestCaseWithTransport.get_server): Use create_transport_server.

* bzrlib/tests/HTTPTestUtil.py:
(TestCaseWithWebserver): Fix typo in doc string.
(TestCaseWithWallserver): Deleted.

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