/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Martin Pool
  • Date: 2006-05-05 00:55:41 UTC
  • mto: This revision was merged to the branch mainline in revision 1699.
  • Revision ID: mbp@sourcefrog.net-20060505005541-7ad07e37a4508ea8
Create lockdir info files using transport.append

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