~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/__init__.py

  • Committer: Olaf Conradi
  • Date: 2006-03-28 23:30:02 UTC
  • mto: (1661.1.1 bzr.mbp.remember)
  • mto: This revision was merged to the branch mainline in revision 1663.
  • Revision ID: olaf@conradi.org-20060328233002-f6262df0e19c1963
Added testcases for using pull with --remember. Moved remember code to
beginning of cmd_pull. This remembers the location in case of a failure
during pull.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005, 2006 by Canonical Ltd
2
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
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
18
30
from cStringIO import StringIO
19
31
import difflib
20
32
import errno
22
34
import os
23
35
import re
24
36
import shutil
 
37
import stat
25
38
import sys
26
39
import tempfile
27
40
import unittest
28
41
import time
29
42
 
 
43
 
 
44
import bzrlib.branch
 
45
import bzrlib.bzrdir as bzrdir
30
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
31
56
import bzrlib.trace
32
 
import bzrlib.fetch
33
 
import bzrlib.osutils as osutils
34
 
from bzrlib.selftest import TestUtil
35
 
from bzrlib.selftest.TestUtil import TestLoader, TestSuite
36
 
from bzrlib.selftest.treeshape import build_tree_contents
 
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
37
67
 
38
68
MODULES_TO_TEST = []
39
 
MODULES_TO_DOCTEST = []
40
 
 
41
 
from logging import debug, warning, error
42
 
 
43
 
 
44
 
 
45
 
class EarlyStoppingTestResultAdapter(object):
46
 
    """An adapter for TestResult to stop at the first first failure or error"""
47
 
 
48
 
    def __init__(self, result):
49
 
        self._result = result
50
 
 
51
 
    def addError(self, test, err):
52
 
        self._result.addError(test, err)
53
 
        self._result.stop()
54
 
 
55
 
    def addFailure(self, test, err):
56
 
        self._result.addFailure(test, err)
57
 
        self._result.stop()
58
 
 
59
 
    def __getattr__(self, name):
60
 
        return getattr(self._result, name)
61
 
 
62
 
    def __setattr__(self, name, value):
63
 
        if name == '_result':
64
 
            object.__setattr__(self, name, value)
65
 
        return setattr(self._result, name, value)
 
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
            ]
66
107
 
67
108
 
68
109
class _MyResult(unittest._TextTestResult):
69
 
    """
70
 
    Custom TestResult.
 
110
    """Custom TestResult.
71
111
 
72
 
    No special behaviour for now.
 
112
    Shows output in a different format, including displaying runtime for tests.
73
113
    """
 
114
    stop_early = False
74
115
 
75
116
    def _elapsedTime(self):
76
 
        return "(Took %.3fs)" % (time.time() - self._start_time)
 
117
        return "%5dms" % (1000 * (time.time() - self._start_time))
77
118
 
78
119
    def startTest(self, test):
79
120
        unittest.TestResult.startTest(self, test)
80
 
        # TODO: Maybe show test.shortDescription somewhere?
81
 
        what = test.shortDescription() or test.id()        
 
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
82
125
        if self.showAll:
83
 
            self.stream.write('%-70.70s' % what)
 
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)
84
142
        self.stream.flush()
85
143
        self._start_time = time.time()
86
144
 
87
145
    def addError(self, test, err):
 
146
        if isinstance(err[1], TestSkipped):
 
147
            return self.addSkipped(test, err)    
88
148
        unittest.TestResult.addError(self, test, err)
89
149
        if self.showAll:
90
150
            self.stream.writeln("ERROR %s" % self._elapsedTime())
91
151
        elif self.dots:
92
152
            self.stream.write('E')
93
153
        self.stream.flush()
 
154
        if self.stop_early:
 
155
            self.stop()
94
156
 
95
157
    def addFailure(self, test, err):
96
158
        unittest.TestResult.addFailure(self, test, err)
97
159
        if self.showAll:
98
 
            self.stream.writeln("FAIL %s" % self._elapsedTime())
 
160
            self.stream.writeln(" FAIL %s" % self._elapsedTime())
99
161
        elif self.dots:
100
162
            self.stream.write('F')
101
163
        self.stream.flush()
 
164
        if self.stop_early:
 
165
            self.stop()
102
166
 
103
167
    def addSuccess(self, test):
104
168
        if self.showAll:
105
 
            self.stream.writeln('OK %s' % self._elapsedTime())
 
169
            self.stream.writeln('   OK %s' % self._elapsedTime())
106
170
        elif self.dots:
107
171
            self.stream.write('~')
108
172
        self.stream.flush()
109
173
        unittest.TestResult.addSuccess(self, test)
110
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
 
111
186
    def printErrorList(self, flavour, errors):
112
187
        for test, err in errors:
113
188
            self.stream.writeln(self.separator1)
114
 
            self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
115
 
            if hasattr(test, '_get_log'):
116
 
                self.stream.writeln()
117
 
                self.stream.writeln('log from this test:')
 
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,'-')
118
194
                print >>self.stream, test._get_log()
 
195
                print >>self.stream, \
 
196
                        ('^^^^[log from %s]' % test.id()).ljust(78,'-')
119
197
            self.stream.writeln(self.separator2)
120
198
            self.stream.writeln("%s" % err)
121
199
 
125
203
 
126
204
    def _makeResult(self):
127
205
        result = _MyResult(self.stream, self.descriptions, self.verbosity)
128
 
        if self.stop_on_failure:
129
 
            result = EarlyStoppingTestResultAdapter(result)
 
206
        result.stop_early = self.stop_on_failure
130
207
        return result
131
208
 
132
209
 
159
236
 
160
237
    Error and debug log messages are redirected from their usual
161
238
    location into a temporary file, the contents of which can be
162
 
    retrieved by _get_log().
 
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.
163
242
       
164
243
    There are also convenience functions to invoke bzr's command-line
165
 
    routine, and to build and check bzr trees."""
 
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
    """
166
251
 
167
252
    BZRPATH = 'bzr'
168
253
    _log_file_name = None
 
254
    _log_contents = ''
 
255
 
 
256
    def __init__(self, methodName='testMethod'):
 
257
        super(TestCase, self).__init__(methodName)
 
258
        self._cleanups = []
169
259
 
170
260
    def setUp(self):
171
261
        unittest.TestCase.setUp(self)
172
 
        self.oldenv = os.environ.get('HOME', None)
173
 
        os.environ['HOME'] = os.getcwd()
174
 
        self.bzr_email = os.environ.get('BZREMAIL')
175
 
        if self.bzr_email is not None:
176
 
            del os.environ['BZREMAIL']
177
 
        self.email = os.environ.get('EMAIL')
178
 
        if self.email is not None:
179
 
            del os.environ['EMAIL']
 
262
        self._cleanEnvironment()
180
263
        bzrlib.trace.disable_default_logging()
181
 
        self._enable_file_logging()
 
264
        self._startLogFile()
182
265
 
183
266
    def _ndiff_strings(self, a, b):
184
267
        """Return ndiff between two strings containing lines.
195
278
                                  charjunk=lambda x: False)
196
279
        return ''.join(difflines)
197
280
 
198
 
    def assertEqualDiff(self, a, b):
 
281
    def assertEqualDiff(self, a, b, message=None):
199
282
        """Assert two texts are equal, if not raise an exception.
200
283
        
201
284
        This is intended for use with multi-line strings where it can 
204
287
        # TODO: perhaps override assertEquals to call this for strings?
205
288
        if a == b:
206
289
            return
207
 
        raise AssertionError("texts not equal:\n" + 
 
290
        if message is None:
 
291
            message = "texts not equal:\n"
 
292
        raise AssertionError(message + 
208
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))
209
306
 
210
307
    def assertContainsRe(self, haystack, needle_re):
211
308
        """Assert that a contains something matching a regular expression."""
213
310
            raise AssertionError('pattern "%s" not found in "%s"'
214
311
                    % (needle_re, haystack))
215
312
 
216
 
    def _enable_file_logging(self):
 
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 assertIsInstance(self, obj, kls):
 
340
        """Fail if obj is not an instance of kls"""
 
341
        if not isinstance(obj, kls):
 
342
            self.fail("%r is not an instance of %s" % (obj, kls))
 
343
 
 
344
    def _startLogFile(self):
 
345
        """Send bzr and test log messages to a temporary file.
 
346
 
 
347
        The file is removed as the test is torn down.
 
348
        """
217
349
        fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
218
 
 
219
 
        self._log_file = os.fdopen(fileno, 'w+')
220
 
 
221
 
        hdlr = logging.StreamHandler(self._log_file)
222
 
        hdlr.setLevel(logging.DEBUG)
223
 
        hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
224
 
        logging.getLogger('').addHandler(hdlr)
225
 
        logging.getLogger('').setLevel(logging.DEBUG)
226
 
        self._log_hdlr = hdlr
227
 
        debug('opened log file %s', name)
228
 
        
 
350
        encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
 
351
        self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
 
352
        self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
229
353
        self._log_file_name = name
230
 
 
231
 
    def tearDown(self):
232
 
        os.environ['HOME'] = self.oldenv
233
 
        if os.environ.get('BZREMAIL') is not None:
234
 
            del os.environ['BZREMAIL']
235
 
        if self.bzr_email is not None:
236
 
            os.environ['BZREMAIL'] = self.bzr_email
237
 
        if os.environ.get('EMAIL') is not None:
238
 
            del os.environ['EMAIL']
239
 
        if self.email is not None:
240
 
            os.environ['EMAIL'] = self.email
241
 
        logging.getLogger('').removeHandler(self._log_hdlr)
242
 
        bzrlib.trace.enable_default_logging()
243
 
        logging.debug('%s teardown', self.id())
 
354
        self.addCleanup(self._finishLogFile)
 
355
 
 
356
    def _finishLogFile(self):
 
357
        """Finished with the log file.
 
358
 
 
359
        Read contents into memory, close, and delete.
 
360
        """
 
361
        bzrlib.trace.disable_test_log(self._log_nonce)
 
362
        self._log_file.seek(0)
 
363
        self._log_contents = self._log_file.read()
244
364
        self._log_file.close()
 
365
        os.remove(self._log_file_name)
 
366
        self._log_file = self._log_file_name = None
 
367
 
 
368
    def addCleanup(self, callable):
 
369
        """Arrange to run a callable when this case is torn down.
 
370
 
 
371
        Callables are run in the reverse of the order they are registered, 
 
372
        ie last-in first-out.
 
373
        """
 
374
        if callable in self._cleanups:
 
375
            raise ValueError("cleanup function %r already registered on %s" 
 
376
                    % (callable, self))
 
377
        self._cleanups.append(callable)
 
378
 
 
379
    def _cleanEnvironment(self):
 
380
        new_env = {
 
381
            'HOME': os.getcwd(),
 
382
            'APPDATA': os.getcwd(),
 
383
            'BZREMAIL': None,
 
384
            'EMAIL': None,
 
385
        }
 
386
        self.__old_env = {}
 
387
        self.addCleanup(self._restoreEnvironment)
 
388
        for name, value in new_env.iteritems():
 
389
            self._captureVar(name, value)
 
390
 
 
391
 
 
392
    def _captureVar(self, name, newvalue):
 
393
        """Set an environment variable, preparing it to be reset when finished."""
 
394
        self.__old_env[name] = os.environ.get(name, None)
 
395
        if newvalue is None:
 
396
            if name in os.environ:
 
397
                del os.environ[name]
 
398
        else:
 
399
            os.environ[name] = newvalue
 
400
 
 
401
    @staticmethod
 
402
    def _restoreVar(name, value):
 
403
        if value is None:
 
404
            if name in os.environ:
 
405
                del os.environ[name]
 
406
        else:
 
407
            os.environ[name] = value
 
408
 
 
409
    def _restoreEnvironment(self):
 
410
        for name, value in self.__old_env.iteritems():
 
411
            self._restoreVar(name, value)
 
412
 
 
413
    def tearDown(self):
 
414
        self._runCleanups()
245
415
        unittest.TestCase.tearDown(self)
246
416
 
 
417
    def _runCleanups(self):
 
418
        """Run registered cleanup functions. 
 
419
 
 
420
        This should only be called from TestCase.tearDown.
 
421
        """
 
422
        # TODO: Perhaps this should keep running cleanups even if 
 
423
        # one of them fails?
 
424
        for cleanup_fn in reversed(self._cleanups):
 
425
            cleanup_fn()
 
426
 
247
427
    def log(self, *args):
248
 
        logging.debug(*args)
 
428
        mutter(*args)
249
429
 
250
430
    def _get_log(self):
251
431
        """Return as a string the log for this test"""
252
432
        if self._log_file_name:
253
433
            return open(self._log_file_name).read()
254
434
        else:
255
 
            return ''
 
435
            return self._log_contents
 
436
        # TODO: Delete the log after it's been read in
256
437
 
257
 
    def capture(self, cmd):
 
438
    def capture(self, cmd, retcode=0):
258
439
        """Shortcut that splits cmd into words, runs, and returns stdout"""
259
 
        return self.run_bzr_captured(cmd.split())[0]
 
440
        return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
260
441
 
261
442
    def run_bzr_captured(self, argv, retcode=0):
262
 
        """Invoke bzr and return (result, stdout, stderr).
 
443
        """Invoke bzr and return (stdout, stderr).
263
444
 
264
445
        Useful for code that wants to check the contents of the
265
446
        output, the way error messages are presented, etc.
281
462
        stdout = StringIO()
282
463
        stderr = StringIO()
283
464
        self.log('run bzr: %s', ' '.join(argv))
 
465
        # FIXME: don't call into logging here
284
466
        handler = logging.StreamHandler(stderr)
285
467
        handler.setFormatter(bzrlib.trace.QuietFormatter())
286
468
        handler.setLevel(logging.INFO)
345
527
        if stdin is None:
346
528
            stdin = StringIO("")
347
529
        if stdout is None:
348
 
            if hasattr(self, "_log_file"):
 
530
            if getattr(self, "_log_file", None) is not None:
349
531
                stdout = self._log_file
350
532
            else:
351
533
                stdout = StringIO()
352
534
        if stderr is None:
353
 
            if hasattr(self, "_log_file"):
 
535
            if getattr(self, "_log_file", None is not None):
354
536
                stderr = self._log_file
355
537
            else:
356
538
                stderr = StringIO()
401
583
            return
402
584
        i = 0
403
585
        while True:
404
 
            root = 'test%04d.tmp' % i
 
586
            root = u'test%04d.tmp' % i
405
587
            try:
406
588
                os.mkdir(root)
407
589
            except OSError, e:
411
593
                else:
412
594
                    raise
413
595
            # successfully created
414
 
            TestCaseInTempDir.TEST_ROOT = os.path.abspath(root)
 
596
            TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
415
597
            break
416
598
        # make a fake bzr directory there to prevent any tests propagating
417
599
        # up onto the source directory's real branch
418
 
        os.mkdir(os.path.join(TestCaseInTempDir.TEST_ROOT, '.bzr'))
 
600
        bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
419
601
 
420
602
    def setUp(self):
 
603
        super(TestCaseInTempDir, self).setUp()
421
604
        self._make_test_root()
422
 
        self._currentdir = os.getcwdu()
423
 
        short_id = self.id().replace('bzrlib.selftest.', '') \
 
605
        _currentdir = os.getcwdu()
 
606
        short_id = self.id().replace('bzrlib.tests.', '') \
424
607
                   .replace('__main__.', '')
425
 
        self.test_dir = os.path.join(self.TEST_ROOT, short_id)
426
 
        os.mkdir(self.test_dir)
427
 
        os.chdir(self.test_dir)
428
 
        super(TestCaseInTempDir, self).setUp()
 
608
        # it's possible the same test class is run several times for
 
609
        # parameterized tests, so make sure the names don't collide.  
 
610
        i = 0
 
611
        while True:
 
612
            if i > 0:
 
613
                candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
 
614
            else:
 
615
                candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
 
616
            if os.path.exists(candidate_dir):
 
617
                i = i + 1
 
618
                continue
 
619
            else:
 
620
                self.test_dir = candidate_dir
 
621
                os.mkdir(self.test_dir)
 
622
                os.chdir(self.test_dir)
 
623
                break
 
624
        os.environ['HOME'] = self.test_dir
 
625
        os.environ['APPDATA'] = self.test_dir
 
626
        def _leaveDirectory():
 
627
            os.chdir(_currentdir)
 
628
        self.addCleanup(_leaveDirectory)
429
629
        
430
 
    def tearDown(self):
431
 
        os.chdir(self._currentdir)
432
 
        super(TestCaseInTempDir, self).tearDown()
433
 
 
434
 
    def build_tree(self, shape):
 
630
    def build_tree(self, shape, line_endings='native', transport=None):
435
631
        """Build a test tree according to a pattern.
436
632
 
437
633
        shape is a sequence of file specifications.  If the final
438
634
        character is '/', a directory is created.
439
635
 
440
636
        This doesn't add anything to a branch.
 
637
        :param line_endings: Either 'binary' or 'native'
 
638
                             in binary mode, exact contents are written
 
639
                             in native mode, the line endings match the
 
640
                             default platform endings.
 
641
 
 
642
        :param transport: A transport to write to, for building trees on 
 
643
                          VFS's. If the transport is readonly or None,
 
644
                          "." is opened automatically.
441
645
        """
442
646
        # XXX: It's OK to just create them using forward slashes on windows?
 
647
        if transport is None or transport.is_readonly():
 
648
            transport = get_transport(".")
443
649
        for name in shape:
444
 
            assert isinstance(name, basestring)
 
650
            self.assert_(isinstance(name, basestring))
445
651
            if name[-1] == '/':
446
 
                os.mkdir(name[:-1])
 
652
                transport.mkdir(urlescape(name[:-1]))
447
653
            else:
448
 
                f = file(name, 'wt')
449
 
                print >>f, "contents of", name
450
 
                f.close()
 
654
                if line_endings == 'binary':
 
655
                    end = '\n'
 
656
                elif line_endings == 'native':
 
657
                    end = os.linesep
 
658
                else:
 
659
                    raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
 
660
                content = "contents of %s%s" % (name, end)
 
661
                transport.put(urlescape(name), StringIO(content))
451
662
 
452
663
    def build_tree_contents(self, shape):
453
 
        bzrlib.selftest.build_tree_contents(shape)
 
664
        build_tree_contents(shape)
454
665
 
455
666
    def failUnlessExists(self, path):
456
667
        """Fail unless path, which may be abs or relative, exists."""
457
668
        self.failUnless(osutils.lexists(path))
 
669
 
 
670
    def failIfExists(self, path):
 
671
        """Fail if path, which may be abs or relative, exists."""
 
672
        self.failIf(osutils.lexists(path))
458
673
        
459
674
    def assertFileEqual(self, content, path):
460
675
        """Fail if path does not contain 'content'."""
461
676
        self.failUnless(osutils.lexists(path))
462
677
        self.assertEqualDiff(content, open(path, 'r').read())
 
678
 
 
679
 
 
680
class TestCaseWithTransport(TestCaseInTempDir):
 
681
    """A test case that provides get_url and get_readonly_url facilities.
 
682
 
 
683
    These back onto two transport servers, one for readonly access and one for
 
684
    read write access.
 
685
 
 
686
    If no explicit class is provided for readonly access, a
 
687
    ReadonlyTransportDecorator is used instead which allows the use of non disk
 
688
    based read write transports.
 
689
 
 
690
    If an explicit class is provided for readonly access, that server and the 
 
691
    readwrite one must both define get_url() as resolving to os.getcwd().
 
692
    """
 
693
 
 
694
    def __init__(self, methodName='testMethod'):
 
695
        super(TestCaseWithTransport, self).__init__(methodName)
 
696
        self.__readonly_server = None
 
697
        self.__server = None
 
698
        self.transport_server = default_transport
 
699
        self.transport_readonly_server = None
 
700
 
 
701
    def get_readonly_url(self, relpath=None):
 
702
        """Get a URL for the readonly transport.
 
703
 
 
704
        This will either be backed by '.' or a decorator to the transport 
 
705
        used by self.get_url()
 
706
        relpath provides for clients to get a path relative to the base url.
 
707
        These should only be downwards relative, not upwards.
 
708
        """
 
709
        base = self.get_readonly_server().get_url()
 
710
        if relpath is not None:
 
711
            if not base.endswith('/'):
 
712
                base = base + '/'
 
713
            base = base + relpath
 
714
        return base
 
715
 
 
716
    def get_readonly_server(self):
 
717
        """Get the server instance for the readonly transport
 
718
 
 
719
        This is useful for some tests with specific servers to do diagnostics.
 
720
        """
 
721
        if self.__readonly_server is None:
 
722
            if self.transport_readonly_server is None:
 
723
                # readonly decorator requested
 
724
                # bring up the server
 
725
                self.get_url()
 
726
                self.__readonly_server = ReadonlyServer()
 
727
                self.__readonly_server.setUp(self.__server)
 
728
            else:
 
729
                self.__readonly_server = self.transport_readonly_server()
 
730
                self.__readonly_server.setUp()
 
731
            self.addCleanup(self.__readonly_server.tearDown)
 
732
        return self.__readonly_server
 
733
 
 
734
    def get_server(self):
 
735
        """Get the read/write server instance.
 
736
 
 
737
        This is useful for some tests with specific servers that need
 
738
        diagnostics.
 
739
        """
 
740
        if self.__server is None:
 
741
            self.__server = self.transport_server()
 
742
            self.__server.setUp()
 
743
            self.addCleanup(self.__server.tearDown)
 
744
        return self.__server
 
745
 
 
746
    def get_url(self, relpath=None):
 
747
        """Get a URL for the readwrite transport.
 
748
 
 
749
        This will either be backed by '.' or to an equivalent non-file based
 
750
        facility.
 
751
        relpath provides for clients to get a path relative to the base url.
 
752
        These should only be downwards relative, not upwards.
 
753
        """
 
754
        base = self.get_server().get_url()
 
755
        if relpath is not None and relpath != '.':
 
756
            if not base.endswith('/'):
 
757
                base = base + '/'
 
758
            base = base + relpath
 
759
        return base
 
760
 
 
761
    def get_transport(self):
 
762
        """Return a writeable transport for the test scratch space"""
 
763
        t = get_transport(self.get_url())
 
764
        self.assertFalse(t.is_readonly())
 
765
        return t
 
766
 
 
767
    def get_readonly_transport(self):
 
768
        """Return a readonly transport for the test scratch space
463
769
        
464
 
 
465
 
class MetaTestLog(TestCase):
466
 
    def test_logging(self):
467
 
        """Test logs are captured when a test fails."""
468
 
        logging.info('an info message')
469
 
        warning('something looks dodgy...')
470
 
        logging.debug('hello, test is running')
471
 
        ## assert 0
 
770
        This can be used to test that operations which should only need
 
771
        readonly access in fact do not try to write.
 
772
        """
 
773
        t = get_transport(self.get_readonly_url())
 
774
        self.assertTrue(t.is_readonly())
 
775
        return t
 
776
 
 
777
    def make_branch(self, relpath):
 
778
        """Create a branch on the transport at relpath."""
 
779
        repo = self.make_repository(relpath)
 
780
        return repo.bzrdir.create_branch()
 
781
 
 
782
    def make_bzrdir(self, relpath):
 
783
        try:
 
784
            url = self.get_url(relpath)
 
785
            segments = relpath.split('/')
 
786
            if segments and segments[-1] not in ('', '.'):
 
787
                parent = self.get_url('/'.join(segments[:-1]))
 
788
                t = get_transport(parent)
 
789
                try:
 
790
                    t.mkdir(segments[-1])
 
791
                except errors.FileExists:
 
792
                    pass
 
793
            return bzrlib.bzrdir.BzrDir.create(url)
 
794
        except errors.UninitializableFormat:
 
795
            raise TestSkipped("Format %s is not initializable.")
 
796
 
 
797
    def make_repository(self, relpath, shared=False):
 
798
        """Create a repository on our default transport at relpath."""
 
799
        made_control = self.make_bzrdir(relpath)
 
800
        return made_control.create_repository(shared=shared)
 
801
 
 
802
    def make_branch_and_tree(self, relpath):
 
803
        """Create a branch on the transport and a tree locally.
 
804
 
 
805
        Returns the tree.
 
806
        """
 
807
        # TODO: always use the local disk path for the working tree,
 
808
        # this obviously requires a format that supports branch references
 
809
        # so check for that by checking bzrdir.BzrDirFormat.get_default_format()
 
810
        # RBC 20060208
 
811
        b = self.make_branch(relpath)
 
812
        try:
 
813
            return b.bzrdir.create_workingtree()
 
814
        except errors.NotLocalUrl:
 
815
            # new formats - catch No tree error and create
 
816
            # a branch reference and a checkout.
 
817
            # old formats at that point - raise TestSkipped.
 
818
            # TODO: rbc 20060208
 
819
            return WorkingTreeFormat2().initialize(bzrdir.BzrDir.open(relpath))
 
820
 
 
821
    def assertIsDirectory(self, relpath, transport):
 
822
        """Assert that relpath within transport is a directory.
 
823
 
 
824
        This may not be possible on all transports; in that case it propagates
 
825
        a TransportNotPossible.
 
826
        """
 
827
        try:
 
828
            mode = transport.stat(relpath).st_mode
 
829
        except errors.NoSuchFile:
 
830
            self.fail("path %s is not a directory; no such file"
 
831
                      % (relpath))
 
832
        if not stat.S_ISDIR(mode):
 
833
            self.fail("path %s is not a directory; has mode %#o"
 
834
                      % (relpath, mode))
 
835
 
 
836
 
 
837
class ChrootedTestCase(TestCaseWithTransport):
 
838
    """A support class that provides readonly urls outside the local namespace.
 
839
 
 
840
    This is done by checking if self.transport_server is a MemoryServer. if it
 
841
    is then we are chrooted already, if it is not then an HttpServer is used
 
842
    for readonly urls.
 
843
 
 
844
    TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
 
845
                       be used without needed to redo it when a different 
 
846
                       subclass is in use ?
 
847
    """
 
848
 
 
849
    def setUp(self):
 
850
        super(ChrootedTestCase, self).setUp()
 
851
        if not self.transport_server == bzrlib.transport.memory.MemoryServer:
 
852
            self.transport_readonly_server = bzrlib.transport.http.HttpServer
472
853
 
473
854
 
474
855
def filter_suite_by_re(suite, pattern):
475
 
    result = TestUtil.TestSuite()
 
856
    result = TestSuite()
476
857
    filter_re = re.compile(pattern)
477
858
    for test in iter_suite_tests(suite):
478
859
        if filter_re.search(test.id()):
481
862
 
482
863
 
483
864
def run_suite(suite, name='test', verbose=False, pattern=".*",
484
 
              stop_on_failure=False):
 
865
              stop_on_failure=False, keep_output=False,
 
866
              transport=None):
485
867
    TestCaseInTempDir._TEST_NAME = name
486
868
    if verbose:
487
869
        verbosity = 2
497
879
    # This is still a little bogus, 
498
880
    # but only a little. Folk not using our testrunner will
499
881
    # have to delete their temp directories themselves.
500
 
    if result.wasSuccessful():
501
 
        if TestCaseInTempDir.TEST_ROOT is not None:
502
 
            shutil.rmtree(TestCaseInTempDir.TEST_ROOT) 
 
882
    test_root = TestCaseInTempDir.TEST_ROOT
 
883
    if result.wasSuccessful() or not keep_output:
 
884
        if test_root is not None:
 
885
            print 'Deleting test root %s...' % test_root
 
886
            try:
 
887
                shutil.rmtree(test_root)
 
888
            finally:
 
889
                print
503
890
    else:
504
891
        print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
505
892
    return result.wasSuccessful()
506
893
 
507
894
 
508
 
def selftest(verbose=False, pattern=".*", stop_on_failure=True):
 
895
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
 
896
             keep_output=False,
 
897
             transport=None):
509
898
    """Run the whole test suite under the enhanced runner"""
510
 
    return run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern,
511
 
                     stop_on_failure=stop_on_failure)
 
899
    global default_transport
 
900
    if transport is None:
 
901
        transport = default_transport
 
902
    old_transport = default_transport
 
903
    default_transport = transport
 
904
    suite = test_suite()
 
905
    try:
 
906
        return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
 
907
                     stop_on_failure=stop_on_failure, keep_output=keep_output,
 
908
                     transport=transport)
 
909
    finally:
 
910
        default_transport = old_transport
 
911
 
512
912
 
513
913
 
514
914
def test_suite():
515
915
    """Build and return TestSuite for the whole program."""
516
 
    import bzrlib.store, bzrlib.inventory, bzrlib.branch
517
 
    import bzrlib.osutils, bzrlib.merge3, bzrlib.plugin
518
916
    from doctest import DocTestSuite
519
917
 
520
 
    global MODULES_TO_TEST, MODULES_TO_DOCTEST
 
918
    global MODULES_TO_DOCTEST
521
919
 
522
 
    testmod_names = \
523
 
                  ['bzrlib.selftest.MetaTestLog',
524
 
                   'bzrlib.selftest.testgpg',
525
 
                   'bzrlib.selftest.testidentitymap',
526
 
                   'bzrlib.selftest.testinv',
527
 
                   'bzrlib.selftest.test_ancestry',
528
 
                   'bzrlib.selftest.test_commit',
529
 
                   'bzrlib.selftest.test_commit_merge',
530
 
                   'bzrlib.selftest.testconfig',
531
 
                   'bzrlib.selftest.versioning',
532
 
                   'bzrlib.selftest.testmerge3',
533
 
                   'bzrlib.selftest.testmerge',
534
 
                   'bzrlib.selftest.testhashcache',
535
 
                   'bzrlib.selftest.teststatus',
536
 
                   'bzrlib.selftest.testlog',
537
 
                   'bzrlib.selftest.testrevisionnamespaces',
538
 
                   'bzrlib.selftest.testbranch',
539
 
                   'bzrlib.selftest.testrevision',
540
 
                   'bzrlib.selftest.test_revision_info',
541
 
                   'bzrlib.selftest.test_merge_core',
542
 
                   'bzrlib.selftest.test_smart_add',
543
 
                   'bzrlib.selftest.test_bad_files',
544
 
                   'bzrlib.selftest.testdiff',
545
 
                   'bzrlib.selftest.test_parent',
546
 
                   'bzrlib.selftest.test_xml',
547
 
                   'bzrlib.selftest.test_weave',
548
 
                   'bzrlib.selftest.testfetch',
549
 
                   'bzrlib.selftest.whitebox',
550
 
                   'bzrlib.selftest.teststore',
551
 
                   'bzrlib.selftest.blackbox',
552
 
                   'bzrlib.selftest.testsampler',
553
 
                   'bzrlib.selftest.testtransactions',
554
 
                   'bzrlib.selftest.testtransport',
555
 
                   'bzrlib.selftest.testgraph',
556
 
                   'bzrlib.selftest.testworkingtree',
557
 
                   'bzrlib.selftest.test_upgrade',
558
 
                   'bzrlib.selftest.test_conflicts',
559
 
                   'bzrlib.selftest.testtestament',
560
 
                   'bzrlib.selftest.testannotate',
561
 
                   'bzrlib.selftest.testrevprops',
562
 
                   'bzrlib.selftest.testoptions',
563
 
                   'bzrlib.selftest.testhttp',
564
 
                   'bzrlib.selftest.testnonascii',
 
920
    testmod_names = [ \
 
921
                   'bzrlib.tests.test_ancestry',
 
922
                   'bzrlib.tests.test_annotate',
 
923
                   'bzrlib.tests.test_api',
 
924
                   'bzrlib.tests.test_bad_files',
 
925
                   'bzrlib.tests.test_basis_inventory',
 
926
                   'bzrlib.tests.test_branch',
 
927
                   'bzrlib.tests.test_bzrdir',
 
928
                   'bzrlib.tests.test_command',
 
929
                   'bzrlib.tests.test_commit',
 
930
                   'bzrlib.tests.test_commit_merge',
 
931
                   'bzrlib.tests.test_config',
 
932
                   'bzrlib.tests.test_conflicts',
 
933
                   'bzrlib.tests.test_decorators',
 
934
                   'bzrlib.tests.test_diff',
 
935
                   'bzrlib.tests.test_doc_generate',
 
936
                   'bzrlib.tests.test_errors',
 
937
                   'bzrlib.tests.test_fetch',
 
938
                   'bzrlib.tests.test_gpg',
 
939
                   'bzrlib.tests.test_graph',
 
940
                   'bzrlib.tests.test_hashcache',
 
941
                   'bzrlib.tests.test_http',
 
942
                   'bzrlib.tests.test_identitymap',
 
943
                   'bzrlib.tests.test_inv',
 
944
                   'bzrlib.tests.test_knit',
 
945
                   'bzrlib.tests.test_lockdir',
 
946
                   'bzrlib.tests.test_lockable_files',
 
947
                   'bzrlib.tests.test_log',
 
948
                   'bzrlib.tests.test_merge',
 
949
                   'bzrlib.tests.test_merge3',
 
950
                   'bzrlib.tests.test_merge_core',
 
951
                   'bzrlib.tests.test_missing',
 
952
                   'bzrlib.tests.test_msgeditor',
 
953
                   'bzrlib.tests.test_nonascii',
 
954
                   'bzrlib.tests.test_options',
 
955
                   'bzrlib.tests.test_osutils',
 
956
                   'bzrlib.tests.test_permissions',
 
957
                   'bzrlib.tests.test_plugins',
 
958
                   'bzrlib.tests.test_progress',
 
959
                   'bzrlib.tests.test_reconcile',
 
960
                   'bzrlib.tests.test_repository',
 
961
                   'bzrlib.tests.test_revision',
 
962
                   'bzrlib.tests.test_revisionnamespaces',
 
963
                   'bzrlib.tests.test_revprops',
 
964
                   'bzrlib.tests.test_rio',
 
965
                   'bzrlib.tests.test_sampler',
 
966
                   'bzrlib.tests.test_selftest',
 
967
                   'bzrlib.tests.test_setup',
 
968
                   'bzrlib.tests.test_sftp_transport',
 
969
                   'bzrlib.tests.test_smart_add',
 
970
                   'bzrlib.tests.test_source',
 
971
                   'bzrlib.tests.test_store',
 
972
                   'bzrlib.tests.test_symbol_versioning',
 
973
                   'bzrlib.tests.test_testament',
 
974
                   'bzrlib.tests.test_trace',
 
975
                   'bzrlib.tests.test_transactions',
 
976
                   'bzrlib.tests.test_transform',
 
977
                   'bzrlib.tests.test_transport',
 
978
                   'bzrlib.tests.test_tsort',
 
979
                   'bzrlib.tests.test_ui',
 
980
                   'bzrlib.tests.test_uncommit',
 
981
                   'bzrlib.tests.test_upgrade',
 
982
                   'bzrlib.tests.test_versionedfile',
 
983
                   'bzrlib.tests.test_weave',
 
984
                   'bzrlib.tests.test_whitebox',
 
985
                   'bzrlib.tests.test_workingtree',
 
986
                   'bzrlib.tests.test_xml',
565
987
                   ]
566
 
 
567
 
    for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
568
 
              bzrlib.osutils, bzrlib.commands, bzrlib.merge3,
569
 
              bzrlib.errors,
570
 
              ):
571
 
        if m not in MODULES_TO_DOCTEST:
572
 
            MODULES_TO_DOCTEST.append(m)
573
 
 
574
 
    TestCase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
575
 
    print '%-30s %s' % ('bzr binary', TestCase.BZRPATH)
 
988
    test_transport_implementations = [
 
989
        'bzrlib.tests.test_transport_implementations']
 
990
 
 
991
    TestCase.BZRPATH = osutils.pathjoin(
 
992
            osutils.realpath(osutils.dirname(bzrlib.__path__[0])), 'bzr')
 
993
    print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
 
994
    print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
576
995
    print
577
996
    suite = TestSuite()
578
 
    suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
 
997
    # python2.4's TestLoader.loadTestsFromNames gives very poor 
 
998
    # errors if it fails to load a named module - no indication of what's
 
999
    # actually wrong, just "no such module".  We should probably override that
 
1000
    # class, but for the moment just load them ourselves. (mbp 20051202)
 
1001
    loader = TestLoader()
 
1002
    from bzrlib.transport import TransportTestProviderAdapter
 
1003
    adapter = TransportTestProviderAdapter()
 
1004
    adapt_modules(test_transport_implementations, adapter, loader, suite)
 
1005
    for mod_name in testmod_names:
 
1006
        mod = _load_module_by_name(mod_name)
 
1007
        suite.addTest(loader.loadTestsFromModule(mod))
 
1008
    for package in packages_to_test():
 
1009
        suite.addTest(package.test_suite())
579
1010
    for m in MODULES_TO_TEST:
580
 
         suite.addTest(TestLoader().loadTestsFromModule(m))
 
1011
        suite.addTest(loader.loadTestsFromModule(m))
581
1012
    for m in (MODULES_TO_DOCTEST):
582
1013
        suite.addTest(DocTestSuite(m))
583
 
    for p in bzrlib.plugin.all_plugins:
584
 
        if hasattr(p, 'test_suite'):
585
 
            suite.addTest(p.test_suite())
 
1014
    for name, plugin in bzrlib.plugin.all_plugins().items():
 
1015
        if getattr(plugin, 'test_suite', None) is not None:
 
1016
            suite.addTest(plugin.test_suite())
586
1017
    return suite
587
1018
 
 
1019
 
 
1020
def adapt_modules(mods_list, adapter, loader, suite):
 
1021
    """Adapt the modules in mods_list using adapter and add to suite."""
 
1022
    for mod_name in mods_list:
 
1023
        mod = _load_module_by_name(mod_name)
 
1024
        for test in iter_suite_tests(loader.loadTestsFromModule(mod)):
 
1025
            suite.addTests(adapter.adapt(test))
 
1026
 
 
1027
 
 
1028
def _load_module_by_name(mod_name):
 
1029
    parts = mod_name.split('.')
 
1030
    module = __import__(mod_name)
 
1031
    del parts[0]
 
1032
    # for historical reasons python returns the top-level module even though
 
1033
    # it loads the submodule; we need to walk down to get the one we want.
 
1034
    while parts:
 
1035
        module = getattr(module, parts.pop(0))
 
1036
    return module