~bzr-pqm/bzr/bzr.dev

841 by Martin Pool
- Start splitting bzr-independent parts of the test framework into
1
# Copyright (C) 2005 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
"""Enhanced layer on unittest.
19
20
This does several things:
21
22
* nicer reporting as tests run
23
24
* test code can log messages into a buffer that is recorded to disk
25
  and displayed if the test fails
26
27
* tests can be run in a separate directory, which is useful for code that
28
  wants to create files
29
30
* utilities to run external commands and check their return code
31
  and/or output
32
1102 by Martin Pool
- merge test refactoring from robertc
33
Test cases should normally subclass testsweet.TestCase.  The test runner should
841 by Martin Pool
- Start splitting bzr-independent parts of the test framework into
34
call runsuite().
35
36
This is meant to become independent of bzr, though that's not quite
37
true yet.
38
"""  
39
1102 by Martin Pool
- merge test refactoring from robertc
40
import unittest
41
import sys
1092.1.20 by Robert Collins
import and use TestUtil to do regex based partial test runs
42
from bzrlib.selftest import TestUtil
841 by Martin Pool
- Start splitting bzr-independent parts of the test framework into
43
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
44
# XXX: Don't need this anymore now we depend on python2.4
841 by Martin Pool
- Start splitting bzr-independent parts of the test framework into
45
def _need_subprocess():
46
    sys.stderr.write("sorry, this test suite requires the subprocess module\n"
47
                     "this is shipped with python2.4 and available separately for 2.3\n")
48
    
49
50
class CommandFailed(Exception):
51
    pass
52
53
54
class TestSkipped(Exception):
55
    """Indicates that a test was intentionally skipped, rather than failing."""
56
    # XXX: Not used yet
57
1092.1.19 by Robert Collins
make tests stop at the first failure, preventing multi-page omgs
58
class EarlyStoppingTestResultAdapter(object):
59
    """An adapter for TestResult to stop at the first first failure or error"""
60
61
    def __init__(self, result):
62
        self._result = result
63
64
    def addError(self, test, err):
65
        self._result.addError(test, err)
66
        self._result.stop()
67
68
    def addFailure(self, test, err):
69
        self._result.addFailure(test, err)
70
        self._result.stop()
71
72
    def __getattr__(self, name):
73
        return getattr(self._result, name)
74
75
    def __setattr__(self, name, value):
76
        if name == '_result':
77
            object.__setattr__(self, name, value)
78
        return setattr(self._result, name, value)
79
80
1102 by Martin Pool
- merge test refactoring from robertc
81
class _MyResult(unittest._TextTestResult):
841 by Martin Pool
- Start splitting bzr-independent parts of the test framework into
82
    """
83
    Custom TestResult.
84
85
    No special behaviour for now.
86
    """
965 by Martin Pool
- selftest is less verbose by default, and takes a -v option if you want it
87
841 by Martin Pool
- Start splitting bzr-independent parts of the test framework into
88
    def startTest(self, test):
1102 by Martin Pool
- merge test refactoring from robertc
89
        unittest.TestResult.startTest(self, test)
841 by Martin Pool
- Start splitting bzr-independent parts of the test framework into
90
        # TODO: Maybe show test.shortDescription somewhere?
1185.3.22 by Martin Pool
- Show short test descriptions if any in verbose runs
91
        what = test.shortDescription() or test.id()        
1102 by Martin Pool
- merge test refactoring from robertc
92
        if self.showAll:
1185.3.22 by Martin Pool
- Show short test descriptions if any in verbose runs
93
            self.stream.write('%-70.70s' % what)
1102 by Martin Pool
- merge test refactoring from robertc
94
        self.stream.flush()
841 by Martin Pool
- Start splitting bzr-independent parts of the test framework into
95
96
    def addError(self, test, err):
1102 by Martin Pool
- merge test refactoring from robertc
97
        super(_MyResult, self).addError(test, err)
98
        self.stream.flush()
841 by Martin Pool
- Start splitting bzr-independent parts of the test framework into
99
100
    def addFailure(self, test, err):
1102 by Martin Pool
- merge test refactoring from robertc
101
        super(_MyResult, self).addFailure(test, err)
102
        self.stream.flush()
841 by Martin Pool
- Start splitting bzr-independent parts of the test framework into
103
104
    def addSuccess(self, test):
1102 by Martin Pool
- merge test refactoring from robertc
105
        if self.showAll:
106
            self.stream.writeln('OK')
107
        elif self.dots:
108
            self.stream.write('~')
109
        self.stream.flush()
110
        unittest.TestResult.addSuccess(self, test)
111
112
    def printErrorList(self, flavour, errors):
113
        for test, err in errors:
114
            self.stream.writeln(self.separator1)
115
            self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
1123 by Martin Pool
* move bzr-specific code from testsweet into bzrlib.selftest
116
            if hasattr(test, '_get_log'):
1102 by Martin Pool
- merge test refactoring from robertc
117
                self.stream.writeln()
118
                self.stream.writeln('log from this test:')
119
                print >>self.stream, test._get_log()
1185.1.42 by Robert Collins
print test case exceptions after the test log
120
            self.stream.writeln(self.separator2)
121
            self.stream.writeln("%s" % err)
1102 by Martin Pool
- merge test refactoring from robertc
122
123
124
class TextTestRunner(unittest.TextTestRunner):
125
126
    def _makeResult(self):
1092.1.19 by Robert Collins
make tests stop at the first failure, preventing multi-page omgs
127
        result = _MyResult(self.stream, self.descriptions, self.verbosity)
128
        return EarlyStoppingTestResultAdapter(result)
1092.1.4 by Robert Collins
move error printing into the TestResult and use the TextTestRunner from unittest
129
130
1092.1.20 by Robert Collins
import and use TestUtil to do regex based partial test runs
131
class filteringVisitor(TestUtil.TestVisitor):
132
    """I accruse all the testCases I visit that pass a regexp filter on id
133
    into my suite
134
    """
135
136
    def __init__(self, filter):
137
        import re
138
        TestUtil.TestVisitor.__init__(self)
139
        self._suite=None
140
        self.filter=re.compile(filter)
141
142
    def suite(self):
143
        """answer the suite we are building"""
144
        if self._suite is None:
145
            self._suite=TestUtil.TestSuite()
146
        return self._suite
147
148
    def visitCase(self, aCase):
149
        if self.filter.match(aCase.id()):
150
            self.suite().addTest(aCase)
151
152
153
def run_suite(suite, name='test', verbose=False, pattern=".*"):
1092.1.9 by Robert Collins
move working dir creation into InTempDir and nuke the TestSuite subclass as unneeded
154
    import shutil
1141 by Martin Pool
- rename FunctionalTest to TestCaseInTempDir
155
    from bzrlib.selftest import TestCaseInTempDir
156
    TestCaseInTempDir._TEST_NAME = name
1102 by Martin Pool
- merge test refactoring from robertc
157
    if verbose:
158
        verbosity = 2
159
    else:
160
        verbosity = 1
161
    runner = TextTestRunner(stream=sys.stdout,
162
                            descriptions=0,
163
                            verbosity=verbosity)
1092.2.11 by Robert Collins
dont filter unless we need to (dont interfere with constructed testsuite structure
164
    if not pattern or pattern == ".*":
165
        result = runner.run(suite)
166
    else:
167
        visitor = filteringVisitor(pattern)
168
        suite.visit(visitor)
169
        result = runner.run(visitor.suite())
1102 by Martin Pool
- merge test refactoring from robertc
170
    # This is still a little bogus, 
171
    # but only a little. Folk not using our testrunner will
172
    # have to delete their temp directories themselves.
173
    if result.wasSuccessful():
1092.1.48 by Robert Collins
really merge mpool
174
        if TestCaseInTempDir.TEST_ROOT is not None:
1141 by Martin Pool
- rename FunctionalTest to TestCaseInTempDir
175
            shutil.rmtree(TestCaseInTempDir.TEST_ROOT) 
1102 by Martin Pool
- merge test refactoring from robertc
176
    else:
1141 by Martin Pool
- rename FunctionalTest to TestCaseInTempDir
177
        print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
841 by Martin Pool
- Start splitting bzr-independent parts of the test framework into
178
    return result.wasSuccessful()