1
# Copyright (C) 2005 by Canonical Ltd
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.
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.
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
18
"""Enhanced layer on unittest.
20
This does several things:
22
* nicer reporting as tests run
24
* test code can log messages into a buffer that is recorded to disk
25
and displayed if the test fails
27
* tests can be run in a separate directory, which is useful for code that
30
* utilities to run external commands and check their return code
33
Test cases should normally subclass testsweet.TestCase. The test runner should
36
This is meant to become independent of bzr, though that's not quite
42
from bzrlib.selftest import TestUtil
44
# XXX: Don't need this anymore now we depend on python2.4
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")
50
class CommandFailed(Exception):
54
class TestSkipped(Exception):
55
"""Indicates that a test was intentionally skipped, rather than failing."""
59
class EarlyStoppingTestResultAdapter(object):
60
"""An adapter for TestResult to stop at the first first failure or error"""
62
def __init__(self, result):
65
def addError(self, test, err):
66
self._result.addError(test, err)
69
def addFailure(self, test, err):
70
self._result.addFailure(test, err)
73
def __getattr__(self, name):
74
return getattr(self._result, name)
76
def __setattr__(self, name, value):
78
object.__setattr__(self, name, value)
79
return setattr(self._result, name, value)
82
class _MyResult(unittest._TextTestResult):
86
No special behaviour for now.
89
def startTest(self, test):
90
unittest.TestResult.startTest(self, test)
91
# TODO: Maybe show test.shortDescription somewhere?
92
what = test.shortDescription() or test.id()
94
self.stream.write('%-70.70s' % what)
97
def addError(self, test, err):
98
super(_MyResult, self).addError(test, err)
101
def addFailure(self, test, err):
102
super(_MyResult, self).addFailure(test, err)
105
def addSuccess(self, test):
107
self.stream.writeln('OK')
109
self.stream.write('~')
111
unittest.TestResult.addSuccess(self, test)
113
def printErrorList(self, flavour, errors):
114
for test, err in errors:
115
self.stream.writeln(self.separator1)
116
self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
117
self.stream.writeln(self.separator2)
118
self.stream.writeln("%s" % err)
119
if hasattr(test, '_get_log'):
120
self.stream.writeln()
121
self.stream.writeln('log from this test:')
122
print >>self.stream, test._get_log()
125
class TextTestRunner(unittest.TextTestRunner):
127
def _makeResult(self):
128
result = _MyResult(self.stream, self.descriptions, self.verbosity)
129
return EarlyStoppingTestResultAdapter(result)
132
class filteringVisitor(TestUtil.TestVisitor):
133
"""I accruse all the testCases I visit that pass a regexp filter on id
137
def __init__(self, filter):
139
TestUtil.TestVisitor.__init__(self)
141
self.filter=re.compile(filter)
144
"""answer the suite we are building"""
145
if self._suite is None:
146
self._suite=TestUtil.TestSuite()
149
def visitCase(self, aCase):
150
if self.filter.match(aCase.id()):
151
self.suite().addTest(aCase)
154
def run_suite(suite, name='test', verbose=False, pattern=".*"):
156
from bzrlib.selftest import TestCaseInTempDir
157
TestCaseInTempDir._TEST_NAME = name
162
runner = TextTestRunner(stream=sys.stdout,
165
visitor = filteringVisitor(pattern)
167
result = runner.run(visitor.suite())
168
# This is still a little bogus,
169
# but only a little. Folk not using our testrunner will
170
# have to delete their temp directories themselves.
171
if result.wasSuccessful():
172
if TestCaseInTempDir.TEST_ROOT is not None:
173
shutil.rmtree(TestCaseInTempDir.TEST_ROOT)
175
print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
176
return result.wasSuccessful()
added
removed
testsweet.py
