~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/selftest/__init__.py

  • Committer: Martin Pool
  • Date: 2005-09-30 00:58:02 UTC
  • mto: (1185.14.2)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: mbp@sourcefrog.net-20050930005802-721cfc318e393817
- copy_branch creates destination if it doesn't exist

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
 
18
from cStringIO import StringIO
18
19
import logging
19
20
import unittest
20
21
import tempfile
21
22
import os
22
23
import sys
 
24
import errno
23
25
import subprocess
 
26
import shutil
24
27
 
25
 
from testsweet import run_suite
26
28
import bzrlib.commands
27
 
 
28
29
import bzrlib.trace
29
30
import bzrlib.fetch
 
31
from bzrlib.selftest import TestUtil
 
32
from bzrlib.selftest.TestUtil import TestLoader, TestSuite
30
33
 
31
34
 
32
35
MODULES_TO_TEST = []
34
37
 
35
38
from logging import debug, warning, error
36
39
 
 
40
 
 
41
 
 
42
class EarlyStoppingTestResultAdapter(object):
 
43
    """An adapter for TestResult to stop at the first first failure or error"""
 
44
 
 
45
    def __init__(self, result):
 
46
        self._result = result
 
47
 
 
48
    def addError(self, test, err):
 
49
        self._result.addError(test, err)
 
50
        self._result.stop()
 
51
 
 
52
    def addFailure(self, test, err):
 
53
        self._result.addFailure(test, err)
 
54
        self._result.stop()
 
55
 
 
56
    def __getattr__(self, name):
 
57
        return getattr(self._result, name)
 
58
 
 
59
    def __setattr__(self, name, value):
 
60
        if name == '_result':
 
61
            object.__setattr__(self, name, value)
 
62
        return setattr(self._result, name, value)
 
63
 
 
64
 
 
65
class _MyResult(unittest._TextTestResult):
 
66
    """
 
67
    Custom TestResult.
 
68
 
 
69
    No special behaviour for now.
 
70
    """
 
71
 
 
72
    def startTest(self, test):
 
73
        unittest.TestResult.startTest(self, test)
 
74
        # TODO: Maybe show test.shortDescription somewhere?
 
75
        what = test.shortDescription() or test.id()        
 
76
        if self.showAll:
 
77
            self.stream.write('%-70.70s' % what)
 
78
        self.stream.flush()
 
79
 
 
80
    def addError(self, test, err):
 
81
        super(_MyResult, self).addError(test, err)
 
82
        self.stream.flush()
 
83
 
 
84
    def addFailure(self, test, err):
 
85
        super(_MyResult, self).addFailure(test, err)
 
86
        self.stream.flush()
 
87
 
 
88
    def addSuccess(self, test):
 
89
        if self.showAll:
 
90
            self.stream.writeln('OK')
 
91
        elif self.dots:
 
92
            self.stream.write('~')
 
93
        self.stream.flush()
 
94
        unittest.TestResult.addSuccess(self, test)
 
95
 
 
96
    def printErrorList(self, flavour, errors):
 
97
        for test, err in errors:
 
98
            self.stream.writeln(self.separator1)
 
99
            self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
 
100
            if hasattr(test, '_get_log'):
 
101
                self.stream.writeln()
 
102
                self.stream.writeln('log from this test:')
 
103
                print >>self.stream, test._get_log()
 
104
            self.stream.writeln(self.separator2)
 
105
            self.stream.writeln("%s" % err)
 
106
 
 
107
 
 
108
class TextTestRunner(unittest.TextTestRunner):
 
109
 
 
110
    def _makeResult(self):
 
111
        result = _MyResult(self.stream, self.descriptions, self.verbosity)
 
112
        return EarlyStoppingTestResultAdapter(result)
 
113
 
 
114
 
 
115
class filteringVisitor(TestUtil.TestVisitor):
 
116
    """I accruse all the testCases I visit that pass a regexp filter on id
 
117
    into my suite
 
118
    """
 
119
 
 
120
    def __init__(self, filter):
 
121
        import re
 
122
        TestUtil.TestVisitor.__init__(self)
 
123
        self._suite=None
 
124
        self.filter=re.compile(filter)
 
125
 
 
126
    def suite(self):
 
127
        """answer the suite we are building"""
 
128
        if self._suite is None:
 
129
            self._suite=TestUtil.TestSuite()
 
130
        return self._suite
 
131
 
 
132
    def visitCase(self, aCase):
 
133
        if self.filter.match(aCase.id()):
 
134
            self.suite().addTest(aCase)
 
135
 
 
136
class TestSkipped(Exception):
 
137
    """Indicates that a test was intentionally skipped, rather than failing."""
 
138
    # XXX: Not used yet
 
139
 
 
140
 
37
141
class CommandFailed(Exception):
38
142
    pass
39
143
 
53
157
    BZRPATH = 'bzr'
54
158
 
55
159
    def setUp(self):
56
 
        # this replaces the default testsweet.TestCase; we don't want logging changed
57
160
        unittest.TestCase.setUp(self)
58
161
        bzrlib.trace.disable_default_logging()
59
162
        self._enable_file_logging()
66
169
 
67
170
        hdlr = logging.StreamHandler(self._log_file)
68
171
        hdlr.setLevel(logging.DEBUG)
69
 
        hdlr.setFormatter(logging.Formatter('%(levelname)4.4s  %(message)s'))
 
172
        hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
70
173
        logging.getLogger('').addHandler(hdlr)
71
174
        logging.getLogger('').setLevel(logging.DEBUG)
72
175
        self._log_hdlr = hdlr
74
177
        
75
178
        self._log_file_name = name
76
179
 
77
 
        
78
180
    def tearDown(self):
79
181
        logging.getLogger('').removeHandler(self._log_hdlr)
80
182
        bzrlib.trace.enable_default_logging()
82
184
        self._log_file.close()
83
185
        unittest.TestCase.tearDown(self)
84
186
 
85
 
 
86
187
    def log(self, *args):
87
188
        logging.debug(*args)
88
189
 
90
191
        """Return as a string the log for this test"""
91
192
        return open(self._log_file_name).read()
92
193
 
 
194
 
 
195
    def capture(self, cmd):
 
196
        """Shortcut that splits cmd into words, runs, and returns stdout"""
 
197
        return self.run_bzr_captured(cmd.split())[0]
 
198
 
 
199
    def run_bzr_captured(self, argv, retcode=0):
 
200
        """Invoke bzr and return (result, stdout, stderr).
 
201
 
 
202
        Useful for code that wants to check the contents of the
 
203
        output, the way error messages are presented, etc.
 
204
 
 
205
        This should be the main method for tests that want to exercise the
 
206
        overall behavior of the bzr application (rather than a unit test
 
207
        or a functional test of the library.)
 
208
 
 
209
        Much of the old code runs bzr by forking a new copy of Python, but
 
210
        that is slower, harder to debug, and generally not necessary.
 
211
 
 
212
        This runs bzr through the interface that catches and reports
 
213
        errors, and with logging set to something approximating the
 
214
        default, so that error reporting can be checked.
 
215
 
 
216
        argv -- arguments to invoke bzr
 
217
        retcode -- expected return code, or None for don't-care.
 
218
        """
 
219
        stdout = StringIO()
 
220
        stderr = StringIO()
 
221
        self.log('run bzr: %s', ' '.join(argv))
 
222
        handler = logging.StreamHandler(stderr)
 
223
        handler.setFormatter(bzrlib.trace.QuietFormatter())
 
224
        handler.setLevel(logging.INFO)
 
225
        logger = logging.getLogger('')
 
226
        logger.addHandler(handler)
 
227
        try:
 
228
            result = self.apply_redirected(None, stdout, stderr,
 
229
                                           bzrlib.commands.run_bzr_catch_errors,
 
230
                                           argv)
 
231
        finally:
 
232
            logger.removeHandler(handler)
 
233
        out = stdout.getvalue()
 
234
        err = stderr.getvalue()
 
235
        if out:
 
236
            self.log('output:\n%s', out)
 
237
        if err:
 
238
            self.log('errors:\n%s', err)
 
239
        if retcode is not None:
 
240
            self.assertEquals(result, retcode)
 
241
        return out, err
 
242
 
93
243
    def run_bzr(self, *args, **kwargs):
94
244
        """Invoke bzr, as if it were run from the command line.
95
245
 
97
247
        overall behavior of the bzr application (rather than a unit test
98
248
        or a functional test of the library.)
99
249
 
100
 
        Much of the old code runs bzr by forking a new copy of Python, but
101
 
        that is slower, harder to debug, and generally not necessary.
 
250
        This sends the stdout/stderr results into the test's log,
 
251
        where it may be useful for debugging.  See also run_captured.
102
252
        """
103
 
        retcode = kwargs.get('retcode', 0)
104
 
        result = self.apply_redirected(None, None, None,
105
 
                                       bzrlib.commands.run_bzr, args)
106
 
        self.assertEquals(result, retcode)
107
 
        
108
 
        
 
253
        retcode = kwargs.pop('retcode', 0)
 
254
        return self.run_bzr_captured(args, retcode)
 
255
 
109
256
    def check_inventory_shape(self, inv, shape):
110
 
        """
111
 
        Compare an inventory to a list of expected names.
 
257
        """Compare an inventory to a list of expected names.
112
258
 
113
259
        Fail if they are not precisely equal.
114
260
        """
132
278
        """Call callable with redirected std io pipes.
133
279
 
134
280
        Returns the return code."""
135
 
        from StringIO import StringIO
136
281
        if not callable(a_callable):
137
282
            raise ValueError("a_callable must be callable.")
138
283
        if stdin is None:
139
284
            stdin = StringIO("")
140
285
        if stdout is None:
141
 
            stdout = self._log_file
 
286
            if hasattr(self, "_log_file"):
 
287
                stdout = self._log_file
 
288
            else:
 
289
                stdout = StringIO()
142
290
        if stderr is None:
143
 
            stderr = self._log_file
 
291
            if hasattr(self, "_log_file"):
 
292
                stderr = self._log_file
 
293
            else:
 
294
                stderr = StringIO()
144
295
        real_stdin = sys.stdin
145
296
        real_stdout = sys.stdout
146
297
        real_stderr = sys.stderr
181
332
        if contents != expect:
182
333
            self.log("expected: %r" % expect)
183
334
            self.log("actually: %r" % contents)
184
 
            self.fail("contents of %s not as expected")
 
335
            self.fail("contents of %s not as expected" % filename)
185
336
 
186
337
    def _make_test_root(self):
187
 
        import os
188
 
        import shutil
189
 
        import tempfile
190
 
        
191
338
        if TestCaseInTempDir.TEST_ROOT is not None:
192
339
            return
193
 
        TestCaseInTempDir.TEST_ROOT = os.path.abspath(
194
 
                                 tempfile.mkdtemp(suffix='.tmp',
195
 
                                                  prefix=self._TEST_NAME + '-',
196
 
                                                  dir=os.curdir))
197
 
    
 
340
        i = 0
 
341
        while True:
 
342
            root = 'test%04d.tmp' % i
 
343
            try:
 
344
                os.mkdir(root)
 
345
            except OSError, e:
 
346
                if e.errno == errno.EEXIST:
 
347
                    i += 1
 
348
                    continue
 
349
                else:
 
350
                    raise
 
351
            # successfully created
 
352
            TestCaseInTempDir.TEST_ROOT = os.path.abspath(root)
 
353
            break
198
354
        # make a fake bzr directory there to prevent any tests propagating
199
355
        # up onto the source directory's real branch
200
356
        os.mkdir(os.path.join(TestCaseInTempDir.TEST_ROOT, '.bzr'))
201
357
 
202
358
    def setUp(self):
203
359
        super(TestCaseInTempDir, self).setUp()
204
 
        import os
205
360
        self._make_test_root()
206
361
        self._currentdir = os.getcwdu()
207
 
        self.test_dir = os.path.join(self.TEST_ROOT, self.id())
 
362
        short_id = self.id().replace('bzrlib.selftest.', '') \
 
363
                   .replace('__main__.', '')
 
364
        self.test_dir = os.path.join(self.TEST_ROOT, short_id)
208
365
        os.mkdir(self.test_dir)
209
366
        os.chdir(self.test_dir)
210
367
        
211
368
    def tearDown(self):
212
 
        import os
213
369
        os.chdir(self._currentdir)
214
370
        super(TestCaseInTempDir, self).tearDown()
215
371
 
216
 
    def _formcmd(self, cmd):
217
 
        if isinstance(cmd, basestring):
218
 
            cmd = cmd.split()
219
 
        if cmd[0] == 'bzr':
220
 
            cmd[0] = self.BZRPATH
221
 
            if self.OVERRIDE_PYTHON:
222
 
                cmd.insert(0, self.OVERRIDE_PYTHON)
223
 
        self.log('$ %r' % cmd)
224
 
        return cmd
225
 
 
226
 
    def runcmd(self, cmd, retcode=0):
227
 
        """Run one command and check the return code.
228
 
 
229
 
        Returns a tuple of (stdout,stderr) strings.
230
 
 
231
 
        If a single string is based, it is split into words.
232
 
        For commands that are not simple space-separated words, please
233
 
        pass a list instead."""
234
 
        cmd = self._formcmd(cmd)
235
 
        self.log('$ ' + ' '.join(cmd))
236
 
        actual_retcode = subprocess.call(cmd, stdout=self._log_file,
237
 
                                         stderr=self._log_file)
238
 
        if retcode != actual_retcode:
239
 
            raise CommandFailed("test failed: %r returned %d, expected %d"
240
 
                                % (cmd, actual_retcode, retcode))
241
 
 
242
 
    def backtick(self, cmd, retcode=0):
243
 
        """Run a command and return its output"""
244
 
        cmd = self._formcmd(cmd)
245
 
        child = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=self._log_file)
246
 
        outd, errd = child.communicate()
247
 
        self.log(outd)
248
 
        actual_retcode = child.wait()
249
 
 
250
 
        outd = outd.replace('\r', '')
251
 
 
252
 
        if retcode != actual_retcode:
253
 
            raise CommandFailed("test failed: %r returned %d, expected %d"
254
 
                                % (cmd, actual_retcode, retcode))
255
 
 
256
 
        return outd
257
 
 
258
 
 
259
 
 
260
372
    def build_tree(self, shape):
261
373
        """Build a test tree according to a pattern.
262
374
 
266
378
        This doesn't add anything to a branch.
267
379
        """
268
380
        # XXX: It's OK to just create them using forward slashes on windows?
269
 
        import os
270
381
        for name in shape:
271
382
            assert isinstance(name, basestring)
272
383
            if name[-1] == '/':
275
386
                f = file(name, 'wt')
276
387
                print >>f, "contents of", name
277
388
                f.close()
278
 
                
279
389
 
280
390
 
281
391
class MetaTestLog(TestCase):
287
397
        ##assert 0
288
398
 
289
399
 
 
400
 
 
401
def run_suite(suite, name='test', verbose=False, pattern=".*"):
 
402
    TestCaseInTempDir._TEST_NAME = name
 
403
    if verbose:
 
404
        verbosity = 2
 
405
    else:
 
406
        verbosity = 1
 
407
    runner = TextTestRunner(stream=sys.stdout,
 
408
                            descriptions=0,
 
409
                            verbosity=verbosity)
 
410
    visitor = filteringVisitor(pattern)
 
411
    suite.visit(visitor)
 
412
    result = runner.run(visitor.suite())
 
413
    # This is still a little bogus, 
 
414
    # but only a little. Folk not using our testrunner will
 
415
    # have to delete their temp directories themselves.
 
416
    if result.wasSuccessful():
 
417
        if TestCaseInTempDir.TEST_ROOT is not None:
 
418
            shutil.rmtree(TestCaseInTempDir.TEST_ROOT) 
 
419
    else:
 
420
        print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
 
421
    return result.wasSuccessful()
 
422
 
 
423
 
290
424
def selftest(verbose=False, pattern=".*"):
 
425
    """Run the whole test suite under the enhanced runner"""
291
426
    return run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern)
292
427
 
293
428
 
294
429
def test_suite():
295
 
    from bzrlib.selftest.TestUtil import TestLoader, TestSuite
296
 
    import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
297
 
    import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
 
430
    """Build and return TestSuite for the whole program."""
 
431
    import bzrlib.store, bzrlib.inventory, bzrlib.branch
 
432
    import bzrlib.osutils, bzrlib.merge3, bzrlib.plugin
298
433
    from doctest import DocTestSuite
299
 
    import os
300
 
    import shutil
301
 
    import time
302
 
    import sys
303
434
 
304
435
    global MODULES_TO_TEST, MODULES_TO_DOCTEST
305
436
 
306
437
    testmod_names = \
307
438
                  ['bzrlib.selftest.MetaTestLog',
308
 
                   'bzrlib.selftest.test_parent',
309
439
                   'bzrlib.selftest.testinv',
310
 
                   'bzrlib.selftest.testfetch',
 
440
                   'bzrlib.selftest.test_ancestry',
 
441
                   'bzrlib.selftest.test_commit',
 
442
                   'bzrlib.selftest.test_commit_merge',
311
443
                   'bzrlib.selftest.versioning',
312
 
                   'bzrlib.selftest.whitebox',
313
444
                   'bzrlib.selftest.testmerge3',
 
445
                   'bzrlib.selftest.testmerge',
314
446
                   'bzrlib.selftest.testhashcache',
315
447
                   'bzrlib.selftest.teststatus',
316
448
                   'bzrlib.selftest.testlog',
317
 
                   'bzrlib.selftest.blackbox',
318
449
                   'bzrlib.selftest.testrevisionnamespaces',
319
450
                   'bzrlib.selftest.testbranch',
 
451
                   'bzrlib.selftest.testremotebranch',
320
452
                   'bzrlib.selftest.testrevision',
 
453
                   'bzrlib.selftest.test_revision_info',
321
454
                   'bzrlib.selftest.test_merge_core',
322
455
                   'bzrlib.selftest.test_smart_add',
 
456
                   'bzrlib.selftest.test_bad_files',
323
457
                   'bzrlib.selftest.testdiff',
324
 
                   'bzrlib.fetch',
 
458
                   'bzrlib.selftest.test_parent',
 
459
                   'bzrlib.selftest.test_xml',
 
460
                   'bzrlib.selftest.test_weave',
 
461
                   'bzrlib.selftest.testfetch',
 
462
                   'bzrlib.selftest.whitebox',
325
463
                   'bzrlib.selftest.teststore',
 
464
                   'bzrlib.selftest.blackbox',
 
465
                   'bzrlib.selftest.testgraph',
326
466
                   ]
327
467
 
328
468
    for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,