/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

Made ConfigObj output binary-identical files on win32 and *nix

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