/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

(jblack,mbp) merge documentation updates

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 errno
 
33
import logging
 
34
import os
 
35
import re
 
36
import stat
 
37
import sys
 
38
import tempfile
 
39
import unittest
 
40
import time
 
41
 
 
42
 
 
43
import bzrlib.branch
 
44
import bzrlib.bzrdir as bzrdir
 
45
import bzrlib.commands
 
46
import bzrlib.errors as errors
 
47
import bzrlib.inventory
 
48
import bzrlib.iterablefile
 
49
import bzrlib.lockdir
 
50
from bzrlib.merge import merge_inner
 
51
import bzrlib.merge3
 
52
import bzrlib.osutils
 
53
import bzrlib.osutils as osutils
 
54
import bzrlib.plugin
 
55
from bzrlib.revision import common_ancestor
 
56
import bzrlib.store
 
57
import bzrlib.trace
 
58
from bzrlib.transport import urlescape, get_transport
 
59
import bzrlib.transport
 
60
from bzrlib.transport.local import LocalRelpathServer
 
61
from bzrlib.transport.readonly import ReadonlyServer
 
62
from bzrlib.trace import mutter
 
63
from bzrlib.tests.TestUtil import TestLoader, TestSuite
 
64
from bzrlib.tests.treeshape import build_tree_contents
 
65
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
 
66
 
 
67
default_transport = LocalRelpathServer
 
68
 
 
69
MODULES_TO_TEST = []
 
70
MODULES_TO_DOCTEST = [
 
71
                      bzrlib.branch,
 
72
                      bzrlib.commands,
 
73
                      bzrlib.errors,
 
74
                      bzrlib.inventory,
 
75
                      bzrlib.iterablefile,
 
76
                      bzrlib.lockdir,
 
77
                      bzrlib.merge3,
 
78
                      bzrlib.option,
 
79
                      bzrlib.osutils,
 
80
                      bzrlib.store
 
81
                      ]
 
82
def packages_to_test():
 
83
    """Return a list of packages to test.
 
84
 
 
85
    The packages are not globally imported so that import failures are
 
86
    triggered when running selftest, not when importing the command.
 
87
    """
 
88
    import bzrlib.doc
 
89
    import bzrlib.tests.blackbox
 
90
    import bzrlib.tests.branch_implementations
 
91
    import bzrlib.tests.bzrdir_implementations
 
92
    import bzrlib.tests.interrepository_implementations
 
93
    import bzrlib.tests.interversionedfile_implementations
 
94
    import bzrlib.tests.repository_implementations
 
95
    import bzrlib.tests.revisionstore_implementations
 
96
    import bzrlib.tests.workingtree_implementations
 
97
    return [
 
98
            bzrlib.doc,
 
99
            bzrlib.tests.blackbox,
 
100
            bzrlib.tests.branch_implementations,
 
101
            bzrlib.tests.bzrdir_implementations,
 
102
            bzrlib.tests.interrepository_implementations,
 
103
            bzrlib.tests.interversionedfile_implementations,
 
104
            bzrlib.tests.repository_implementations,
 
105
            bzrlib.tests.revisionstore_implementations,
 
106
            bzrlib.tests.workingtree_implementations,
 
107
            ]
 
108
 
 
109
 
 
110
class _MyResult(unittest._TextTestResult):
 
111
    """Custom TestResult.
 
112
 
 
113
    Shows output in a different format, including displaying runtime for tests.
 
114
    """
 
115
    stop_early = False
 
116
 
 
117
    def _elapsedTime(self):
 
118
        return "%5dms" % (1000 * (time.time() - self._start_time))
 
119
 
 
120
    def startTest(self, test):
 
121
        unittest.TestResult.startTest(self, test)
 
122
        # In a short description, the important words are in
 
123
        # the beginning, but in an id, the important words are
 
124
        # at the end
 
125
        SHOW_DESCRIPTIONS = False
 
126
        if self.showAll:
 
127
            width = osutils.terminal_width()
 
128
            name_width = width - 15
 
129
            what = None
 
130
            if SHOW_DESCRIPTIONS:
 
131
                what = test.shortDescription()
 
132
                if what:
 
133
                    if len(what) > name_width:
 
134
                        what = what[:name_width-3] + '...'
 
135
            if what is None:
 
136
                what = test.id()
 
137
                if what.startswith('bzrlib.tests.'):
 
138
                    what = what[13:]
 
139
                if len(what) > name_width:
 
140
                    what = '...' + what[3-name_width:]
 
141
            what = what.ljust(name_width)
 
142
            self.stream.write(what)
 
143
        self.stream.flush()
 
144
        self._start_time = time.time()
 
145
 
 
146
    def addError(self, test, err):
 
147
        if isinstance(err[1], TestSkipped):
 
148
            return self.addSkipped(test, err)    
 
149
        unittest.TestResult.addError(self, test, err)
 
150
        if self.showAll:
 
151
            self.stream.writeln("ERROR %s" % self._elapsedTime())
 
152
        elif self.dots:
 
153
            self.stream.write('E')
 
154
        self.stream.flush()
 
155
        if self.stop_early:
 
156
            self.stop()
 
157
 
 
158
    def addFailure(self, test, err):
 
159
        unittest.TestResult.addFailure(self, test, err)
 
160
        if self.showAll:
 
161
            self.stream.writeln(" FAIL %s" % self._elapsedTime())
 
162
        elif self.dots:
 
163
            self.stream.write('F')
 
164
        self.stream.flush()
 
165
        if self.stop_early:
 
166
            self.stop()
 
167
 
 
168
    def addSuccess(self, test):
 
169
        if self.showAll:
 
170
            self.stream.writeln('   OK %s' % self._elapsedTime())
 
171
        elif self.dots:
 
172
            self.stream.write('~')
 
173
        self.stream.flush()
 
174
        unittest.TestResult.addSuccess(self, test)
 
175
 
 
176
    def addSkipped(self, test, skip_excinfo):
 
177
        if self.showAll:
 
178
            print >>self.stream, ' SKIP %s' % self._elapsedTime()
 
179
            print >>self.stream, '     %s' % skip_excinfo[1]
 
180
        elif self.dots:
 
181
            self.stream.write('S')
 
182
        self.stream.flush()
 
183
        # seems best to treat this as success from point-of-view of unittest
 
184
        # -- it actually does nothing so it barely matters :)
 
185
        unittest.TestResult.addSuccess(self, test)
 
186
 
 
187
    def printErrorList(self, flavour, errors):
 
188
        for test, err in errors:
 
189
            self.stream.writeln(self.separator1)
 
190
            self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
 
191
            if getattr(test, '_get_log', None) is not None:
 
192
                print >>self.stream
 
193
                print >>self.stream, \
 
194
                        ('vvvv[log from %s]' % test.id()).ljust(78,'-')
 
195
                print >>self.stream, test._get_log()
 
196
                print >>self.stream, \
 
197
                        ('^^^^[log from %s]' % test.id()).ljust(78,'-')
 
198
            self.stream.writeln(self.separator2)
 
199
            self.stream.writeln("%s" % err)
 
200
 
 
201
 
 
202
class TextTestRunner(unittest.TextTestRunner):
 
203
    stop_on_failure = False
 
204
 
 
205
    def _makeResult(self):
 
206
        result = _MyResult(self.stream, self.descriptions, self.verbosity)
 
207
        result.stop_early = self.stop_on_failure
 
208
        return result
 
209
 
 
210
 
 
211
def iter_suite_tests(suite):
 
212
    """Return all tests in a suite, recursing through nested suites"""
 
213
    for item in suite._tests:
 
214
        if isinstance(item, unittest.TestCase):
 
215
            yield item
 
216
        elif isinstance(item, unittest.TestSuite):
 
217
            for r in iter_suite_tests(item):
 
218
                yield r
 
219
        else:
 
220
            raise Exception('unknown object %r inside test suite %r'
 
221
                            % (item, suite))
 
222
 
 
223
 
 
224
class TestSkipped(Exception):
 
225
    """Indicates that a test was intentionally skipped, rather than failing."""
 
226
    # XXX: Not used yet
 
227
 
 
228
 
 
229
class CommandFailed(Exception):
 
230
    pass
 
231
 
 
232
class TestCase(unittest.TestCase):
 
233
    """Base class for bzr unit tests.
 
234
    
 
235
    Tests that need access to disk resources should subclass 
 
236
    TestCaseInTempDir not TestCase.
 
237
 
 
238
    Error and debug log messages are redirected from their usual
 
239
    location into a temporary file, the contents of which can be
 
240
    retrieved by _get_log().  We use a real OS file, not an in-memory object,
 
241
    so that it can also capture file IO.  When the test completes this file
 
242
    is read into memory and removed from disk.
 
243
       
 
244
    There are also convenience functions to invoke bzr's command-line
 
245
    routine, and to build and check bzr trees.
 
246
   
 
247
    In addition to the usual method of overriding tearDown(), this class also
 
248
    allows subclasses to register functions into the _cleanups list, which is
 
249
    run in order as the object is torn down.  It's less likely this will be
 
250
    accidentally overlooked.
 
251
    """
 
252
 
 
253
    BZRPATH = 'bzr'
 
254
    _log_file_name = None
 
255
    _log_contents = ''
 
256
 
 
257
    def __init__(self, methodName='testMethod'):
 
258
        super(TestCase, self).__init__(methodName)
 
259
        self._cleanups = []
 
260
 
 
261
    def setUp(self):
 
262
        unittest.TestCase.setUp(self)
 
263
        self._cleanEnvironment()
 
264
        bzrlib.trace.disable_default_logging()
 
265
        self._startLogFile()
 
266
 
 
267
    def _ndiff_strings(self, a, b):
 
268
        """Return ndiff between two strings containing lines.
 
269
        
 
270
        A trailing newline is added if missing to make the strings
 
271
        print properly."""
 
272
        if b and b[-1] != '\n':
 
273
            b += '\n'
 
274
        if a and a[-1] != '\n':
 
275
            a += '\n'
 
276
        difflines = difflib.ndiff(a.splitlines(True),
 
277
                                  b.splitlines(True),
 
278
                                  linejunk=lambda x: False,
 
279
                                  charjunk=lambda x: False)
 
280
        return ''.join(difflines)
 
281
 
 
282
    def assertEqualDiff(self, a, b, message=None):
 
283
        """Assert two texts are equal, if not raise an exception.
 
284
        
 
285
        This is intended for use with multi-line strings where it can 
 
286
        be hard to find the differences by eye.
 
287
        """
 
288
        # TODO: perhaps override assertEquals to call this for strings?
 
289
        if a == b:
 
290
            return
 
291
        if message is None:
 
292
            message = "texts not equal:\n"
 
293
        raise AssertionError(message + 
 
294
                             self._ndiff_strings(a, b))      
 
295
        
 
296
    def assertEqualMode(self, mode, mode_test):
 
297
        self.assertEqual(mode, mode_test,
 
298
                         'mode mismatch %o != %o' % (mode, mode_test))
 
299
 
 
300
    def assertStartsWith(self, s, prefix):
 
301
        if not s.startswith(prefix):
 
302
            raise AssertionError('string %r does not start with %r' % (s, prefix))
 
303
 
 
304
    def assertEndsWith(self, s, suffix):
 
305
        """Asserts that s ends with suffix."""
 
306
        if not s.endswith(suffix):
 
307
            raise AssertionError('string %r does not end with %r' % (s, suffix))
 
308
 
 
309
    def assertContainsRe(self, haystack, needle_re):
 
310
        """Assert that a contains something matching a regular expression."""
 
311
        if not re.search(needle_re, haystack):
 
312
            raise AssertionError('pattern "%s" not found in "%s"'
 
313
                    % (needle_re, haystack))
 
314
 
 
315
    def assertSubset(self, sublist, superlist):
 
316
        """Assert that every entry in sublist is present in superlist."""
 
317
        missing = []
 
318
        for entry in sublist:
 
319
            if entry not in superlist:
 
320
                missing.append(entry)
 
321
        if len(missing) > 0:
 
322
            raise AssertionError("value(s) %r not present in container %r" % 
 
323
                                 (missing, superlist))
 
324
 
 
325
    def assertIs(self, left, right):
 
326
        if not (left is right):
 
327
            raise AssertionError("%r is not %r." % (left, right))
 
328
 
 
329
    def assertTransportMode(self, transport, path, mode):
 
330
        """Fail if a path does not have mode mode.
 
331
        
 
332
        If modes are not supported on this transport, the assertion is ignored.
 
333
        """
 
334
        if not transport._can_roundtrip_unix_modebits():
 
335
            return
 
336
        path_stat = transport.stat(path)
 
337
        actual_mode = stat.S_IMODE(path_stat.st_mode)
 
338
        self.assertEqual(mode, actual_mode,
 
339
            'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
 
340
 
 
341
    def assertIsInstance(self, obj, kls):
 
342
        """Fail if obj is not an instance of kls"""
 
343
        if not isinstance(obj, kls):
 
344
            self.fail("%r is an instance of %s rather than %s" % (
 
345
                obj, obj.__class__, kls))
 
346
 
 
347
    def _startLogFile(self):
 
348
        """Send bzr and test log messages to a temporary file.
 
349
 
 
350
        The file is removed as the test is torn down.
 
351
        """
 
352
        fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
 
353
        encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
 
354
        self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
 
355
        self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
 
356
        self._log_file_name = name
 
357
        self.addCleanup(self._finishLogFile)
 
358
 
 
359
    def _finishLogFile(self):
 
360
        """Finished with the log file.
 
361
 
 
362
        Read contents into memory, close, and delete.
 
363
        """
 
364
        bzrlib.trace.disable_test_log(self._log_nonce)
 
365
        self._log_file.seek(0)
 
366
        self._log_contents = self._log_file.read()
 
367
        self._log_file.close()
 
368
        os.remove(self._log_file_name)
 
369
        self._log_file = self._log_file_name = None
 
370
 
 
371
    def addCleanup(self, callable):
 
372
        """Arrange to run a callable when this case is torn down.
 
373
 
 
374
        Callables are run in the reverse of the order they are registered, 
 
375
        ie last-in first-out.
 
376
        """
 
377
        if callable in self._cleanups:
 
378
            raise ValueError("cleanup function %r already registered on %s" 
 
379
                    % (callable, self))
 
380
        self._cleanups.append(callable)
 
381
 
 
382
    def _cleanEnvironment(self):
 
383
        new_env = {
 
384
            'HOME': os.getcwd(),
 
385
            'APPDATA': os.getcwd(),
 
386
            'BZREMAIL': None,
 
387
            'EMAIL': None,
 
388
        }
 
389
        self.__old_env = {}
 
390
        self.addCleanup(self._restoreEnvironment)
 
391
        for name, value in new_env.iteritems():
 
392
            self._captureVar(name, value)
 
393
 
 
394
 
 
395
    def _captureVar(self, name, newvalue):
 
396
        """Set an environment variable, preparing it to be reset when finished."""
 
397
        self.__old_env[name] = os.environ.get(name, None)
 
398
        if newvalue is None:
 
399
            if name in os.environ:
 
400
                del os.environ[name]
 
401
        else:
 
402
            os.environ[name] = newvalue
 
403
 
 
404
    @staticmethod
 
405
    def _restoreVar(name, value):
 
406
        if value is None:
 
407
            if name in os.environ:
 
408
                del os.environ[name]
 
409
        else:
 
410
            os.environ[name] = value
 
411
 
 
412
    def _restoreEnvironment(self):
 
413
        for name, value in self.__old_env.iteritems():
 
414
            self._restoreVar(name, value)
 
415
 
 
416
    def tearDown(self):
 
417
        self._runCleanups()
 
418
        unittest.TestCase.tearDown(self)
 
419
 
 
420
    def _runCleanups(self):
 
421
        """Run registered cleanup functions. 
 
422
 
 
423
        This should only be called from TestCase.tearDown.
 
424
        """
 
425
        # TODO: Perhaps this should keep running cleanups even if 
 
426
        # one of them fails?
 
427
        for cleanup_fn in reversed(self._cleanups):
 
428
            cleanup_fn()
 
429
 
 
430
    def log(self, *args):
 
431
        mutter(*args)
 
432
 
 
433
    def _get_log(self):
 
434
        """Return as a string the log for this test"""
 
435
        if self._log_file_name:
 
436
            return open(self._log_file_name).read()
 
437
        else:
 
438
            return self._log_contents
 
439
        # TODO: Delete the log after it's been read in
 
440
 
 
441
    def capture(self, cmd, retcode=0):
 
442
        """Shortcut that splits cmd into words, runs, and returns stdout"""
 
443
        return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
 
444
 
 
445
    def run_bzr_captured(self, argv, retcode=0):
 
446
        """Invoke bzr and return (stdout, stderr).
 
447
 
 
448
        Useful for code that wants to check the contents of the
 
449
        output, the way error messages are presented, etc.
 
450
 
 
451
        This should be the main method for tests that want to exercise the
 
452
        overall behavior of the bzr application (rather than a unit test
 
453
        or a functional test of the library.)
 
454
 
 
455
        Much of the old code runs bzr by forking a new copy of Python, but
 
456
        that is slower, harder to debug, and generally not necessary.
 
457
 
 
458
        This runs bzr through the interface that catches and reports
 
459
        errors, and with logging set to something approximating the
 
460
        default, so that error reporting can be checked.
 
461
 
 
462
        argv -- arguments to invoke bzr
 
463
        retcode -- expected return code, or None for don't-care.
 
464
        """
 
465
        stdout = StringIO()
 
466
        stderr = StringIO()
 
467
        self.log('run bzr: %s', ' '.join(argv))
 
468
        # FIXME: don't call into logging here
 
469
        handler = logging.StreamHandler(stderr)
 
470
        handler.setFormatter(bzrlib.trace.QuietFormatter())
 
471
        handler.setLevel(logging.INFO)
 
472
        logger = logging.getLogger('')
 
473
        logger.addHandler(handler)
 
474
        try:
 
475
            result = self.apply_redirected(None, stdout, stderr,
 
476
                                           bzrlib.commands.run_bzr_catch_errors,
 
477
                                           argv)
 
478
        finally:
 
479
            logger.removeHandler(handler)
 
480
        out = stdout.getvalue()
 
481
        err = stderr.getvalue()
 
482
        if out:
 
483
            self.log('output:\n%s', out)
 
484
        if err:
 
485
            self.log('errors:\n%s', err)
 
486
        if retcode is not None:
 
487
            self.assertEquals(result, retcode)
 
488
        return out, err
 
489
 
 
490
    def run_bzr(self, *args, **kwargs):
 
491
        """Invoke bzr, as if it were run from the command line.
 
492
 
 
493
        This should be the main method for tests that want to exercise the
 
494
        overall behavior of the bzr application (rather than a unit test
 
495
        or a functional test of the library.)
 
496
 
 
497
        This sends the stdout/stderr results into the test's log,
 
498
        where it may be useful for debugging.  See also run_captured.
 
499
        """
 
500
        retcode = kwargs.pop('retcode', 0)
 
501
        return self.run_bzr_captured(args, retcode)
 
502
 
 
503
    def check_inventory_shape(self, inv, shape):
 
504
        """Compare an inventory to a list of expected names.
 
505
 
 
506
        Fail if they are not precisely equal.
 
507
        """
 
508
        extras = []
 
509
        shape = list(shape)             # copy
 
510
        for path, ie in inv.entries():
 
511
            name = path.replace('\\', '/')
 
512
            if ie.kind == 'dir':
 
513
                name = name + '/'
 
514
            if name in shape:
 
515
                shape.remove(name)
 
516
            else:
 
517
                extras.append(name)
 
518
        if shape:
 
519
            self.fail("expected paths not found in inventory: %r" % shape)
 
520
        if extras:
 
521
            self.fail("unexpected paths found in inventory: %r" % extras)
 
522
 
 
523
    def apply_redirected(self, stdin=None, stdout=None, stderr=None,
 
524
                         a_callable=None, *args, **kwargs):
 
525
        """Call callable with redirected std io pipes.
 
526
 
 
527
        Returns the return code."""
 
528
        if not callable(a_callable):
 
529
            raise ValueError("a_callable must be callable.")
 
530
        if stdin is None:
 
531
            stdin = StringIO("")
 
532
        if stdout is None:
 
533
            if getattr(self, "_log_file", None) is not None:
 
534
                stdout = self._log_file
 
535
            else:
 
536
                stdout = StringIO()
 
537
        if stderr is None:
 
538
            if getattr(self, "_log_file", None is not None):
 
539
                stderr = self._log_file
 
540
            else:
 
541
                stderr = StringIO()
 
542
        real_stdin = sys.stdin
 
543
        real_stdout = sys.stdout
 
544
        real_stderr = sys.stderr
 
545
        try:
 
546
            sys.stdout = stdout
 
547
            sys.stderr = stderr
 
548
            sys.stdin = stdin
 
549
            return a_callable(*args, **kwargs)
 
550
        finally:
 
551
            sys.stdout = real_stdout
 
552
            sys.stderr = real_stderr
 
553
            sys.stdin = real_stdin
 
554
 
 
555
    def merge(self, branch_from, wt_to):
 
556
        """A helper for tests to do a ui-less merge.
 
557
 
 
558
        This should move to the main library when someone has time to integrate
 
559
        it in.
 
560
        """
 
561
        # minimal ui-less merge.
 
562
        wt_to.branch.fetch(branch_from)
 
563
        base_rev = common_ancestor(branch_from.last_revision(),
 
564
                                   wt_to.branch.last_revision(),
 
565
                                   wt_to.branch.repository)
 
566
        merge_inner(wt_to.branch, branch_from.basis_tree(), 
 
567
                    wt_to.branch.repository.revision_tree(base_rev),
 
568
                    this_tree=wt_to)
 
569
        wt_to.add_pending_merge(branch_from.last_revision())
 
570
 
 
571
 
 
572
BzrTestBase = TestCase
 
573
 
 
574
     
 
575
class TestCaseInTempDir(TestCase):
 
576
    """Derived class that runs a test within a temporary directory.
 
577
 
 
578
    This is useful for tests that need to create a branch, etc.
 
579
 
 
580
    The directory is created in a slightly complex way: for each
 
581
    Python invocation, a new temporary top-level directory is created.
 
582
    All test cases create their own directory within that.  If the
 
583
    tests complete successfully, the directory is removed.
 
584
 
 
585
    InTempDir is an old alias for FunctionalTestCase.
 
586
    """
 
587
 
 
588
    TEST_ROOT = None
 
589
    _TEST_NAME = 'test'
 
590
    OVERRIDE_PYTHON = 'python'
 
591
 
 
592
    def check_file_contents(self, filename, expect):
 
593
        self.log("check contents of file %s" % filename)
 
594
        contents = file(filename, 'r').read()
 
595
        if contents != expect:
 
596
            self.log("expected: %r" % expect)
 
597
            self.log("actually: %r" % contents)
 
598
            self.fail("contents of %s not as expected" % filename)
 
599
 
 
600
    def _make_test_root(self):
 
601
        if TestCaseInTempDir.TEST_ROOT is not None:
 
602
            return
 
603
        i = 0
 
604
        while True:
 
605
            root = u'test%04d.tmp' % i
 
606
            try:
 
607
                os.mkdir(root)
 
608
            except OSError, e:
 
609
                if e.errno == errno.EEXIST:
 
610
                    i += 1
 
611
                    continue
 
612
                else:
 
613
                    raise
 
614
            # successfully created
 
615
            TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
 
616
            break
 
617
        # make a fake bzr directory there to prevent any tests propagating
 
618
        # up onto the source directory's real branch
 
619
        bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
 
620
 
 
621
    def setUp(self):
 
622
        super(TestCaseInTempDir, self).setUp()
 
623
        self._make_test_root()
 
624
        _currentdir = os.getcwdu()
 
625
        # shorten the name, to avoid test failures due to path length
 
626
        short_id = self.id().replace('bzrlib.tests.', '') \
 
627
                   .replace('__main__.', '')[-100:]
 
628
        # it's possible the same test class is run several times for
 
629
        # parameterized tests, so make sure the names don't collide.  
 
630
        i = 0
 
631
        while True:
 
632
            if i > 0:
 
633
                candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
 
634
            else:
 
635
                candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
 
636
            if os.path.exists(candidate_dir):
 
637
                i = i + 1
 
638
                continue
 
639
            else:
 
640
                self.test_dir = candidate_dir
 
641
                os.mkdir(self.test_dir)
 
642
                os.chdir(self.test_dir)
 
643
                break
 
644
        os.environ['HOME'] = self.test_dir
 
645
        os.environ['APPDATA'] = self.test_dir
 
646
        def _leaveDirectory():
 
647
            os.chdir(_currentdir)
 
648
        self.addCleanup(_leaveDirectory)
 
649
        
 
650
    def build_tree(self, shape, line_endings='native', transport=None):
 
651
        """Build a test tree according to a pattern.
 
652
 
 
653
        shape is a sequence of file specifications.  If the final
 
654
        character is '/', a directory is created.
 
655
 
 
656
        This doesn't add anything to a branch.
 
657
        :param line_endings: Either 'binary' or 'native'
 
658
                             in binary mode, exact contents are written
 
659
                             in native mode, the line endings match the
 
660
                             default platform endings.
 
661
 
 
662
        :param transport: A transport to write to, for building trees on 
 
663
                          VFS's. If the transport is readonly or None,
 
664
                          "." is opened automatically.
 
665
        """
 
666
        # XXX: It's OK to just create them using forward slashes on windows?
 
667
        if transport is None or transport.is_readonly():
 
668
            transport = get_transport(".")
 
669
        for name in shape:
 
670
            self.assert_(isinstance(name, basestring))
 
671
            if name[-1] == '/':
 
672
                transport.mkdir(urlescape(name[:-1]))
 
673
            else:
 
674
                if line_endings == 'binary':
 
675
                    end = '\n'
 
676
                elif line_endings == 'native':
 
677
                    end = os.linesep
 
678
                else:
 
679
                    raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
 
680
                content = "contents of %s%s" % (name, end)
 
681
                transport.put(urlescape(name), StringIO(content))
 
682
 
 
683
    def build_tree_contents(self, shape):
 
684
        build_tree_contents(shape)
 
685
 
 
686
    def failUnlessExists(self, path):
 
687
        """Fail unless path, which may be abs or relative, exists."""
 
688
        self.failUnless(osutils.lexists(path))
 
689
 
 
690
    def failIfExists(self, path):
 
691
        """Fail if path, which may be abs or relative, exists."""
 
692
        self.failIf(osutils.lexists(path))
 
693
        
 
694
    def assertFileEqual(self, content, path):
 
695
        """Fail if path does not contain 'content'."""
 
696
        self.failUnless(osutils.lexists(path))
 
697
        self.assertEqualDiff(content, open(path, 'r').read())
 
698
 
 
699
 
 
700
class TestCaseWithTransport(TestCaseInTempDir):
 
701
    """A test case that provides get_url and get_readonly_url facilities.
 
702
 
 
703
    These back onto two transport servers, one for readonly access and one for
 
704
    read write access.
 
705
 
 
706
    If no explicit class is provided for readonly access, a
 
707
    ReadonlyTransportDecorator is used instead which allows the use of non disk
 
708
    based read write transports.
 
709
 
 
710
    If an explicit class is provided for readonly access, that server and the 
 
711
    readwrite one must both define get_url() as resolving to os.getcwd().
 
712
    """
 
713
 
 
714
    def __init__(self, methodName='testMethod'):
 
715
        super(TestCaseWithTransport, self).__init__(methodName)
 
716
        self.__readonly_server = None
 
717
        self.__server = None
 
718
        self.transport_server = default_transport
 
719
        self.transport_readonly_server = None
 
720
 
 
721
    def get_readonly_url(self, relpath=None):
 
722
        """Get a URL for the readonly transport.
 
723
 
 
724
        This will either be backed by '.' or a decorator to the transport 
 
725
        used by self.get_url()
 
726
        relpath provides for clients to get a path relative to the base url.
 
727
        These should only be downwards relative, not upwards.
 
728
        """
 
729
        base = self.get_readonly_server().get_url()
 
730
        if relpath is not None:
 
731
            if not base.endswith('/'):
 
732
                base = base + '/'
 
733
            base = base + relpath
 
734
        return base
 
735
 
 
736
    def get_readonly_server(self):
 
737
        """Get the server instance for the readonly transport
 
738
 
 
739
        This is useful for some tests with specific servers to do diagnostics.
 
740
        """
 
741
        if self.__readonly_server is None:
 
742
            if self.transport_readonly_server is None:
 
743
                # readonly decorator requested
 
744
                # bring up the server
 
745
                self.get_url()
 
746
                self.__readonly_server = ReadonlyServer()
 
747
                self.__readonly_server.setUp(self.__server)
 
748
            else:
 
749
                self.__readonly_server = self.transport_readonly_server()
 
750
                self.__readonly_server.setUp()
 
751
            self.addCleanup(self.__readonly_server.tearDown)
 
752
        return self.__readonly_server
 
753
 
 
754
    def get_server(self):
 
755
        """Get the read/write server instance.
 
756
 
 
757
        This is useful for some tests with specific servers that need
 
758
        diagnostics.
 
759
        """
 
760
        if self.__server is None:
 
761
            self.__server = self.transport_server()
 
762
            self.__server.setUp()
 
763
            self.addCleanup(self.__server.tearDown)
 
764
        return self.__server
 
765
 
 
766
    def get_url(self, relpath=None):
 
767
        """Get a URL for the readwrite transport.
 
768
 
 
769
        This will either be backed by '.' or to an equivalent non-file based
 
770
        facility.
 
771
        relpath provides for clients to get a path relative to the base url.
 
772
        These should only be downwards relative, not upwards.
 
773
        """
 
774
        base = self.get_server().get_url()
 
775
        if relpath is not None and relpath != '.':
 
776
            if not base.endswith('/'):
 
777
                base = base + '/'
 
778
            base = base + relpath
 
779
        return base
 
780
 
 
781
    def get_transport(self):
 
782
        """Return a writeable transport for the test scratch space"""
 
783
        t = get_transport(self.get_url())
 
784
        self.assertFalse(t.is_readonly())
 
785
        return t
 
786
 
 
787
    def get_readonly_transport(self):
 
788
        """Return a readonly transport for the test scratch space
 
789
        
 
790
        This can be used to test that operations which should only need
 
791
        readonly access in fact do not try to write.
 
792
        """
 
793
        t = get_transport(self.get_readonly_url())
 
794
        self.assertTrue(t.is_readonly())
 
795
        return t
 
796
 
 
797
    def make_branch(self, relpath, format=None):
 
798
        """Create a branch on the transport at relpath."""
 
799
        repo = self.make_repository(relpath, format=format)
 
800
        return repo.bzrdir.create_branch()
 
801
 
 
802
    def make_bzrdir(self, relpath, format=None):
 
803
        try:
 
804
            url = self.get_url(relpath)
 
805
            segments = relpath.split('/')
 
806
            if segments and segments[-1] not in ('', '.'):
 
807
                parent = self.get_url('/'.join(segments[:-1]))
 
808
                t = get_transport(parent)
 
809
                try:
 
810
                    t.mkdir(segments[-1])
 
811
                except errors.FileExists:
 
812
                    pass
 
813
            if format is None:
 
814
                format=bzrlib.bzrdir.BzrDirFormat.get_default_format()
 
815
            # FIXME: make this use a single transport someday. RBC 20060418
 
816
            return format.initialize_on_transport(get_transport(relpath))
 
817
        except errors.UninitializableFormat:
 
818
            raise TestSkipped("Format %s is not initializable." % format)
 
819
 
 
820
    def make_repository(self, relpath, shared=False, format=None):
 
821
        """Create a repository on our default transport at relpath."""
 
822
        made_control = self.make_bzrdir(relpath, format=format)
 
823
        return made_control.create_repository(shared=shared)
 
824
 
 
825
    def make_branch_and_tree(self, relpath, format=None):
 
826
        """Create a branch on the transport and a tree locally.
 
827
 
 
828
        Returns the tree.
 
829
        """
 
830
        # TODO: always use the local disk path for the working tree,
 
831
        # this obviously requires a format that supports branch references
 
832
        # so check for that by checking bzrdir.BzrDirFormat.get_default_format()
 
833
        # RBC 20060208
 
834
        b = self.make_branch(relpath, format=format)
 
835
        try:
 
836
            return b.bzrdir.create_workingtree()
 
837
        except errors.NotLocalUrl:
 
838
            # new formats - catch No tree error and create
 
839
            # a branch reference and a checkout.
 
840
            # old formats at that point - raise TestSkipped.
 
841
            # TODO: rbc 20060208
 
842
            return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
 
843
 
 
844
    def assertIsDirectory(self, relpath, transport):
 
845
        """Assert that relpath within transport is a directory.
 
846
 
 
847
        This may not be possible on all transports; in that case it propagates
 
848
        a TransportNotPossible.
 
849
        """
 
850
        try:
 
851
            mode = transport.stat(relpath).st_mode
 
852
        except errors.NoSuchFile:
 
853
            self.fail("path %s is not a directory; no such file"
 
854
                      % (relpath))
 
855
        if not stat.S_ISDIR(mode):
 
856
            self.fail("path %s is not a directory; has mode %#o"
 
857
                      % (relpath, mode))
 
858
 
 
859
 
 
860
class ChrootedTestCase(TestCaseWithTransport):
 
861
    """A support class that provides readonly urls outside the local namespace.
 
862
 
 
863
    This is done by checking if self.transport_server is a MemoryServer. if it
 
864
    is then we are chrooted already, if it is not then an HttpServer is used
 
865
    for readonly urls.
 
866
 
 
867
    TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
 
868
                       be used without needed to redo it when a different 
 
869
                       subclass is in use ?
 
870
    """
 
871
 
 
872
    def setUp(self):
 
873
        super(ChrootedTestCase, self).setUp()
 
874
        if not self.transport_server == bzrlib.transport.memory.MemoryServer:
 
875
            self.transport_readonly_server = bzrlib.transport.http.HttpServer
 
876
 
 
877
 
 
878
def filter_suite_by_re(suite, pattern):
 
879
    result = TestSuite()
 
880
    filter_re = re.compile(pattern)
 
881
    for test in iter_suite_tests(suite):
 
882
        if filter_re.search(test.id()):
 
883
            result.addTest(test)
 
884
    return result
 
885
 
 
886
 
 
887
def run_suite(suite, name='test', verbose=False, pattern=".*",
 
888
              stop_on_failure=False, keep_output=False,
 
889
              transport=None):
 
890
    TestCaseInTempDir._TEST_NAME = name
 
891
    if verbose:
 
892
        verbosity = 2
 
893
    else:
 
894
        verbosity = 1
 
895
    runner = TextTestRunner(stream=sys.stdout,
 
896
                            descriptions=0,
 
897
                            verbosity=verbosity)
 
898
    runner.stop_on_failure=stop_on_failure
 
899
    if pattern != '.*':
 
900
        suite = filter_suite_by_re(suite, pattern)
 
901
    result = runner.run(suite)
 
902
    # This is still a little bogus, 
 
903
    # but only a little. Folk not using our testrunner will
 
904
    # have to delete their temp directories themselves.
 
905
    test_root = TestCaseInTempDir.TEST_ROOT
 
906
    if result.wasSuccessful() or not keep_output:
 
907
        if test_root is not None:
 
908
            print 'Deleting test root %s...' % test_root
 
909
            try:
 
910
                osutils.rmtree(test_root)
 
911
            finally:
 
912
                print
 
913
    else:
 
914
        print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
 
915
    return result.wasSuccessful()
 
916
 
 
917
 
 
918
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
 
919
             keep_output=False,
 
920
             transport=None):
 
921
    """Run the whole test suite under the enhanced runner"""
 
922
    global default_transport
 
923
    if transport is None:
 
924
        transport = default_transport
 
925
    old_transport = default_transport
 
926
    default_transport = transport
 
927
    suite = test_suite()
 
928
    try:
 
929
        return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
 
930
                     stop_on_failure=stop_on_failure, keep_output=keep_output,
 
931
                     transport=transport)
 
932
    finally:
 
933
        default_transport = old_transport
 
934
 
 
935
 
 
936
 
 
937
def test_suite():
 
938
    """Build and return TestSuite for the whole program."""
 
939
    from doctest import DocTestSuite
 
940
 
 
941
    global MODULES_TO_DOCTEST
 
942
 
 
943
    testmod_names = [ \
 
944
                   'bzrlib.tests.test_ancestry',
 
945
                   'bzrlib.tests.test_api',
 
946
                   'bzrlib.tests.test_bad_files',
 
947
                   'bzrlib.tests.test_branch',
 
948
                   'bzrlib.tests.test_bzrdir',
 
949
                   'bzrlib.tests.test_command',
 
950
                   'bzrlib.tests.test_commit',
 
951
                   'bzrlib.tests.test_commit_merge',
 
952
                   'bzrlib.tests.test_config',
 
953
                   'bzrlib.tests.test_conflicts',
 
954
                   'bzrlib.tests.test_decorators',
 
955
                   'bzrlib.tests.test_diff',
 
956
                   'bzrlib.tests.test_doc_generate',
 
957
                   'bzrlib.tests.test_errors',
 
958
                   'bzrlib.tests.test_escaped_store',
 
959
                   'bzrlib.tests.test_fetch',
 
960
                   'bzrlib.tests.test_gpg',
 
961
                   'bzrlib.tests.test_graph',
 
962
                   'bzrlib.tests.test_hashcache',
 
963
                   'bzrlib.tests.test_http',
 
964
                   'bzrlib.tests.test_identitymap',
 
965
                   'bzrlib.tests.test_inv',
 
966
                   'bzrlib.tests.test_knit',
 
967
                   'bzrlib.tests.test_lockdir',
 
968
                   'bzrlib.tests.test_lockable_files',
 
969
                   'bzrlib.tests.test_log',
 
970
                   'bzrlib.tests.test_merge',
 
971
                   'bzrlib.tests.test_merge3',
 
972
                   'bzrlib.tests.test_merge_core',
 
973
                   'bzrlib.tests.test_missing',
 
974
                   'bzrlib.tests.test_msgeditor',
 
975
                   'bzrlib.tests.test_nonascii',
 
976
                   'bzrlib.tests.test_options',
 
977
                   'bzrlib.tests.test_osutils',
 
978
                   'bzrlib.tests.test_patch',
 
979
                   'bzrlib.tests.test_permissions',
 
980
                   'bzrlib.tests.test_plugins',
 
981
                   'bzrlib.tests.test_progress',
 
982
                   'bzrlib.tests.test_reconcile',
 
983
                   'bzrlib.tests.test_repository',
 
984
                   'bzrlib.tests.test_revision',
 
985
                   'bzrlib.tests.test_revisionnamespaces',
 
986
                   'bzrlib.tests.test_revprops',
 
987
                   'bzrlib.tests.test_rio',
 
988
                   'bzrlib.tests.test_sampler',
 
989
                   'bzrlib.tests.test_selftest',
 
990
                   'bzrlib.tests.test_setup',
 
991
                   'bzrlib.tests.test_sftp_transport',
 
992
                   'bzrlib.tests.test_smart_add',
 
993
                   'bzrlib.tests.test_source',
 
994
                   'bzrlib.tests.test_store',
 
995
                   'bzrlib.tests.test_symbol_versioning',
 
996
                   'bzrlib.tests.test_testament',
 
997
                   'bzrlib.tests.test_textfile',
 
998
                   'bzrlib.tests.test_textmerge',
 
999
                   'bzrlib.tests.test_trace',
 
1000
                   'bzrlib.tests.test_transactions',
 
1001
                   'bzrlib.tests.test_transform',
 
1002
                   'bzrlib.tests.test_transport',
 
1003
                   'bzrlib.tests.test_tsort',
 
1004
                   'bzrlib.tests.test_tuned_gzip',
 
1005
                   'bzrlib.tests.test_ui',
 
1006
                   'bzrlib.tests.test_upgrade',
 
1007
                   'bzrlib.tests.test_versionedfile',
 
1008
                   'bzrlib.tests.test_weave',
 
1009
                   'bzrlib.tests.test_whitebox',
 
1010
                   'bzrlib.tests.test_workingtree',
 
1011
                   'bzrlib.tests.test_xml',
 
1012
                   ]
 
1013
    test_transport_implementations = [
 
1014
        'bzrlib.tests.test_transport_implementations']
 
1015
 
 
1016
    TestCase.BZRPATH = osutils.pathjoin(
 
1017
            osutils.realpath(osutils.dirname(bzrlib.__path__[0])), 'bzr')
 
1018
    print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
 
1019
    print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
 
1020
    print
 
1021
    suite = TestSuite()
 
1022
    # python2.4's TestLoader.loadTestsFromNames gives very poor 
 
1023
    # errors if it fails to load a named module - no indication of what's
 
1024
    # actually wrong, just "no such module".  We should probably override that
 
1025
    # class, but for the moment just load them ourselves. (mbp 20051202)
 
1026
    loader = TestLoader()
 
1027
    from bzrlib.transport import TransportTestProviderAdapter
 
1028
    adapter = TransportTestProviderAdapter()
 
1029
    adapt_modules(test_transport_implementations, adapter, loader, suite)
 
1030
    for mod_name in testmod_names:
 
1031
        mod = _load_module_by_name(mod_name)
 
1032
        suite.addTest(loader.loadTestsFromModule(mod))
 
1033
    for package in packages_to_test():
 
1034
        suite.addTest(package.test_suite())
 
1035
    for m in MODULES_TO_TEST:
 
1036
        suite.addTest(loader.loadTestsFromModule(m))
 
1037
    for m in (MODULES_TO_DOCTEST):
 
1038
        suite.addTest(DocTestSuite(m))
 
1039
    for name, plugin in bzrlib.plugin.all_plugins().items():
 
1040
        if getattr(plugin, 'test_suite', None) is not None:
 
1041
            suite.addTest(plugin.test_suite())
 
1042
    return suite
 
1043
 
 
1044
 
 
1045
def adapt_modules(mods_list, adapter, loader, suite):
 
1046
    """Adapt the modules in mods_list using adapter and add to suite."""
 
1047
    for mod_name in mods_list:
 
1048
        mod = _load_module_by_name(mod_name)
 
1049
        for test in iter_suite_tests(loader.loadTestsFromModule(mod)):
 
1050
            suite.addTests(adapter.adapt(test))
 
1051
 
 
1052
 
 
1053
def _load_module_by_name(mod_name):
 
1054
    parts = mod_name.split('.')
 
1055
    module = __import__(mod_name)
 
1056
    del parts[0]
 
1057
    # for historical reasons python returns the top-level module even though
 
1058
    # it loads the submodule; we need to walk down to get the one we want.
 
1059
    while parts:
 
1060
        module = getattr(module, parts.pop(0))
 
1061
    return module