/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

Seperate SmartServer{Pipe,Socket}StreamMedium out of SmartServerStreamMedium.  Use recv to make the socket server medium better.

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