[Zope-Checkins] CVS: Zope2 - unittest.py:1.1.4.5
Andreas Jung
andreas@yetix.digicool.com
Thu, 8 Mar 2001 06:29:24 -0500
Update of /mnt/cvs-repository/Zope2/lib/python/Testing
In directory yetix:/work/Zope2/Catalog-BTrees-Integration/lib/python/Testing
Modified Files:
Tag: Catalog-BTrees-Integration
unittest.py
Log Message:
constructor of TestCase now allows parameters that are
passed to the testmethod
--- Updated File unittest.py in package Zope2 --
--- unittest.py 2001/03/07 13:12:30 1.1.4.4
+++ unittest.py 2001/03/08 11:29:19 1.1.4.5
@@ -29,7 +29,8 @@
SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
"""
-__author__ = "Steve Purcell (stephen_purcell@yahoo.com)"
+__author__ = "Steve Purcell"
+__email__ = "stephen_purcell@yahoo.com"
__version__ = "$Revision$"[11:-2]
import time
@@ -53,10 +54,10 @@
class TestResult:
"""Holder for test result information.
-
+
Test results are automatically managed by the TestCase and TestSuite
classes, and do not need to be explicitly manipulated by writers of tests.
-
+
Each instance holds the total number of tests run, and collections of
failures and errors that occurred among those test runs. The collections
contain tuples of (testcase, exceptioninfo), where exceptioninfo is a
@@ -67,44 +68,44 @@
self.errors = []
self.testsRun = 0
self.shouldStop = 0
-
+
def startTest(self, test):
"Called when the given test is about to be run"
self.testsRun = self.testsRun + 1
-
+
def stopTest(self, test):
"Called when the given test has been run"
pass
-
+
def addError(self, test, err):
"Called when an error has occurred"
self.errors.append((test, err))
-
+
def addFailure(self, test, err):
"Called when a failure has occurred"
self.failures.append((test, err))
-
+
def wasSuccessful(self):
"Tells whether or not this result was a success"
return len(self.failures) == len(self.errors) == 0
-
+
def stop(self):
"Indicates that the tests should be aborted"
self.shouldStop = 1
-
+
def __repr__(self):
return "<%s run=%i errors=%i failures=%i>" % \
(self.__class__, self.testsRun, len(self.errors),
len(self.failures))
-
-
+
+
class TestCase:
"""A class whose instances are single test cases.
-
+
Test authors should subclass TestCase for their own tests. Construction
and deconstruction of the test's environment ('fixture') can be
implemented by overriding the 'setUp' and 'tearDown' methods respectively.
-
+
By default, the test code itself should be placed in a method named
'runTest'.
@@ -112,103 +113,108 @@
many test methods as are needed. When instantiating such a TestCase
subclass, specify in the constructor arguments the name of the test method
that the instance is to execute.
+
+ If it is necessary to override the __init__ method, the base class
+ __init__ method must always be called.
"""
- def __init__(self, methodName='runTest',args=(),kw={}):
+ def __init__(self, methodName='runTest',*args,**kw):
"""Create an instance of the class that will use the named test
method when executed. Raises a ValueError if the instance does
not have a method with the specified name.
"""
+
try:
- self.__testMethod = getattr(self,methodName)
- self.__args = args
- self.__kw = kw
+ self.__testMethodName = methodName
+ testMethod = getattr(self, methodName)
+ self.__testMethodDoc = testMethod.__doc__
except AttributeError:
raise ValueError, "no such test method in %s: %s" % \
(self.__class__, methodName)
-
+
+ self.__args = args
+ self.__kw = kw
+
def setUp(self):
"Hook method for setting up the test fixture before exercising it."
pass
-
+
def tearDown(self):
"Hook method for deconstructing the test fixture after testing it."
pass
-
+
def countTestCases(self):
return 1
-
+
def defaultTestResult(self):
return TestResult()
-
+
def shortDescription(self):
"""Returns a one-line description of the test, or None if no
description has been provided.
-
+
The default implementation of this method returns the first line of
the specified test method's docstring.
"""
- doc = self.__testMethod.__doc__
+ doc = self.__testMethodDoc
return doc and string.strip(string.split(doc, "\n")[0]) or None
-
+
def id(self):
- return "%s.%s" % (self.__class__, self.__testMethod.__name__)
-
+ return "%s.%s" % (self.__class__, self.__testMethodName)
+
def __str__(self):
- return "%s (%s)" % (self.__testMethod.__name__, self.__class__)
-
+ return "%s (%s)" % (self.__testMethodName, self.__class__)
+
def __repr__(self):
return "<%s testMethod=%s>" % \
- (self.__class__, self.__testMethod.__name__)
-
+ (self.__class__, self.__testMethodName)
+
def run(self, result=None):
return self(result)
-
+
def __call__(self, result=None):
if result is None: result = self.defaultTestResult()
result.startTest(self)
+ testMethod = getattr(self, self.__testMethodName)
try:
try:
self.setUp()
except:
result.addError(self,self.__exc_info())
return
-
- try:
- if self.__args() and self.__kw=={}
- self.__testMethod()
- else:
- self.__testMethod(self.__args,self.__kw)
+ try:
+ apply(testMethod,self.__args,self.__kw)
except AssertionError, e:
result.addFailure(self,self.__exc_info())
except:
result.addError(self,self.__exc_info())
-
+
try:
self.tearDown()
except:
result.addError(self,self.__exc_info())
finally:
result.stopTest(self)
-
+
def debug(self):
+ """Run the test without collecting errors in a TestResult"""
self.setUp()
- self.__testMethod()
+ getattr(self, self.__testMethodName)()
self.tearDown()
-
+
def assert_(self, expr, msg=None):
"""Equivalent of built-in 'assert', but is not optimised out when
__debug__ is false.
"""
if not expr:
raise AssertionError, msg
-
+
failUnless = assert_
-
+
def failIf(self, expr, msg=None):
"Fail the test if the expression is true."
apply(self.assert_,(not expr,msg))
-
+
def assertRaises(self, excClass, callableObj, *args, **kwargs):
"""Assert that an exception of class excClass is thrown
by callableObj when invoked with arguments args and keyword
@@ -225,11 +231,17 @@
if hasattr(excClass,'__name__'): excName = excClass.__name__
else: excName = str(excClass)
raise AssertionError, excName
-
+
+ def assertEqual(self, first, second, msg=None):
+ """Assert that the two objects are equal as determined by the '=='
+ operator.
+ """
+ self.assert_((first == second), msg or '%s != %s' % (first, second))
+
def fail(self, msg=None):
"""Fail immediately, with the given message."""
raise AssertionError, msg
-
+
def __exc_info(self):
"""Return a version of sys.exc_info() with the traceback frame
minimised; usually the top level of the traceback frame is not
@@ -240,11 +252,11 @@
if newtb is None:
return (exctype, excvalue, tb)
return (exctype, excvalue, newtb)
-
-
+
+
class TestSuite:
"""A test suite is a composite test consisting of a number of TestCases.
-
+
For use, create an instance of TestSuite, then add test case instances.
When all tests have been added, the suite can be passed to a test
runner, such as TextTestRunner. It will run the individual test cases
@@ -254,49 +266,49 @@
def __init__(self, tests=()):
self._tests = []
self.addTests(tests)
-
+
def __repr__(self):
return "<%s tests=%s>" % (self.__class__, self._tests)
-
+
__str__ = __repr__
-
+
def countTestCases(self):
cases = 0
for test in self._tests:
cases = cases + test.countTestCases()
return cases
-
+
def addTest(self, test):
self._tests.append(test)
-
+
def addTests(self, tests):
for test in tests:
self.addTest(test)
-
+
def run(self, result):
return self(result)
-
+
def __call__(self, result):
for test in self._tests:
if result.shouldStop:
break
test(result)
return result
-
+
def debug(self):
+ """Run the tests without collecting errors in a TestResult"""
for test in self._tests: test.debug()
-
-
-
+
+
class FunctionTestCase(TestCase):
"""A test case that wraps a test function.
-
+
This is useful for slipping pre-existing test functions into the
PyUnit framework. Optionally, set-up and tidy-up functions can be
supplied. As with TestCase, the tidy-up ('tearDown') function will
always be called if the set-up ('setUp') function ran successfully.
"""
-
+
def __init__(self, testFunc, setUp=None, tearDown=None,
description=None):
TestCase.__init__(self)
@@ -304,38 +316,38 @@
self.__tearDownFunc = tearDown
self.__testFunc = testFunc
self.__description = description
-
+
def setUp(self):
if self.__setUpFunc is not None:
self.__setUpFunc()
-
+
def tearDown(self):
if self.__tearDownFunc is not None:
self.__tearDownFunc()
-
+
def runTest(self):
self.__testFunc()
-
+
def id(self):
return self.__testFunc.__name__
-
+
def __str__(self):
return "%s (%s)" % (self.__class__, self.__testFunc.__name__)
-
+
def __repr__(self):
return "<%s testFunc=%s>" % (self.__class__, self.__testFunc)
-
+
def shortDescription(self):
if self.__description is not None: return self.__description
doc = self.__testFunc.__doc__
return doc and string.strip(string.split(doc, "\n")[0]) or None
-
-
-
- ##############################################################################
- # Convenience functions
- ##############################################################################
-
+
+
+
+##############################################################################
+# Convenience functions
+##############################################################################
+
def getTestCaseNames(testCaseClass, prefix, sortUsing=cmp):
"""Extracts all the names of functions in the given test case class
and its base classes that start with the given prefix. This is used
@@ -349,9 +361,9 @@
if sortUsing:
testFnNames.sort(sortUsing)
return testFnNames
-
-
-def makeSuite(testCaseClass, prefix='test', sortUsing=cmp):
+
+
+def makeSuite(testCaseClass, prefix='test', sortUsing=cmp, suiteClass=TestSuite):
"""Returns a TestSuite instance built from all of the test functions
in the given test case class whose names begin with the given
prefix. The cases are sorted by their function names
@@ -359,16 +371,27 @@
"""
cases = map(testCaseClass,
getTestCaseNames(testCaseClass, prefix, sortUsing))
- return TestSuite(cases)
-
-
-def createTestInstance(name, module=None):
+ return suiteClass(cases)
+
+
+def findTestCases(module, prefix='test', sortUsing=cmp, suiteClass=TestSuite):
+ import types
+ tests = []
+ for name in dir(module):
+ obj = getattr(module, name)
+ if type(obj) == types.ClassType and issubclass(obj, TestCase):
+ tests.append(makeSuite(obj, prefix=prefix,
+ sortUsing=sortUsing, suiteClass=suiteClass))
+ return suiteClass(tests)
+
+
+def createTestInstance(name, module=None, suiteClass=TestSuite):
"""Finds tests by their name, optionally only within the given module.
-
+
Return the newly-constructed test, ready to run. If the name contains a ':'
then the portion of the name after the colon is used to find a specific
test case within the test case class named before the colon.
-
+
Examples:
findTest('examples.listtests.suite')
-- returns result of calling 'suite'
@@ -377,7 +400,6 @@
findTest('examples.listtests.ListTestCase:check-')
-- returns result of calling makeSuite(ListTestCase, prefix="check")
"""
-
spec = string.split(name, ':')
if len(spec) > 2: raise ValueError, "illegal test name: %s" % name
if len(spec) == 1:
@@ -402,7 +424,7 @@
prefix = caseName[:-1]
if not prefix:
raise ValueError, "prefix too short: %s" % name
- test = makeSuite(constructor, prefix=prefix)
+ test = makeSuite(constructor, prefix=prefix, suiteClass=suiteClass)
else:
test = constructor(caseName)
else:
@@ -411,12 +433,12 @@
raise TypeError, \
"object %s found with spec %s is not a test" % (test, name)
return test
-
-
- ##############################################################################
- # Text UI
- ##############################################################################
-
+
+
+##############################################################################
+# Text UI
+##############################################################################
+
class _WritelnDecorator:
"""Used to decorate file-like objects with a handy 'writeln' method"""
def __init__(self,stream):
@@ -426,41 +448,41 @@
self.linesep = java.lang.System.getProperty("line.separator")
else:
self.linesep = os.linesep
-
+
def __getattr__(self, attr):
return getattr(self.stream,attr)
-
+
def writeln(self, *args):
if args: apply(self.write, args)
self.write(self.linesep)
-
-
+
+
class _JUnitTextTestResult(TestResult):
"""A test result class that can print formatted text results to a stream.
-
+
Used by JUnitTextTestRunner.
"""
def __init__(self, stream):
self.stream = stream
TestResult.__init__(self)
-
+
def addError(self, test, error):
TestResult.addError(self,test,error)
self.stream.write('E')
self.stream.flush()
if error[0] is KeyboardInterrupt:
self.shouldStop = 1
-
+
def addFailure(self, test, error):
TestResult.addFailure(self,test,error)
self.stream.write('F')
self.stream.flush()
-
+
def startTest(self, test):
TestResult.startTest(self,test)
self.stream.write('.')
self.stream.flush()
-
+
def printNumberedErrors(self,errFlavour,errors):
if not errors: return
if len(errors) == 1:
@@ -474,13 +496,13 @@
self.stream.writeln("%i) %s" % (i, test))
self.stream.writeln(errString)
i = i + 1
-
+
def printErrors(self):
self.printNumberedErrors("error",self.errors)
-
+
def printFailures(self):
self.printNumberedErrors("failure",self.failures)
-
+
def printHeader(self):
self.stream.writeln()
if self.wasSuccessful():
@@ -497,8 +519,8 @@
self.printHeader()
self.printErrors()
self.printFailures()
-
-
+
+
class JUnitTextTestRunner:
"""A test runner class that displays results in textual form.
@@ -507,7 +529,7 @@
"""
def __init__(self, stream=sys.stderr):
self.stream = _WritelnDecorator(stream)
-
+
def run(self, test):
"Run the given test case or test suite."
result = _JUnitTextTestResult(self.stream)
@@ -518,15 +540,15 @@
self.stream.writeln("Time: %.3fs" % float(stopTime - startTime))
result.printResult()
return result
-
-
- ##############################################################################
- # Verbose text UI
- ##############################################################################
-
+
+
+##############################################################################
+# Verbose text UI
+##############################################################################
+
class _VerboseTextTestResult(TestResult):
"""A test result class that can print formatted text results to a stream.
-
+
Used by VerboseTextTestRunner.
"""
def __init__(self, stream, descriptions):
@@ -542,24 +564,24 @@
else:
self.stream.write(str(test))
self.stream.write(" ... ")
-
+
def stopTest(self, test):
TestResult.stopTest(self, test)
if self.lastFailure is not test:
self.stream.writeln("ok")
-
+
def addError(self, test, err):
TestResult.addError(self, test, err)
self._printError("ERROR", test, err)
self.lastFailure = test
if err[0] is KeyboardInterrupt:
self.shouldStop = 1
-
+
def addFailure(self, test, err):
TestResult.addFailure(self, test, err)
self._printError("FAIL", test, err)
self.lastFailure = test
-
+
def _printError(self, flavour, test, err):
errLines = []
separator1 = "\t" + '=' * 70
@@ -573,8 +595,8 @@
for l in string.split(line,"\n")[:-1]:
self.stream.writeln("\t%s" % l)
self.stream.writeln(separator1)
-
-
+
+
class VerboseTextTestRunner:
"""A test runner class that displays results in textual form.
@@ -584,7 +606,7 @@
def __init__(self, stream=sys.stderr, descriptions=1):
self.stream = _WritelnDecorator(stream)
self.descriptions = descriptions
-
+
def run(self, test):
"Run the given test case or test suite."
result = _VerboseTextTestResult(self.stream, self.descriptions)
@@ -609,9 +631,9 @@
else:
self.stream.writeln("OK")
return result
-
- # Which flavour of TextTestRunner is the default?
+
+# Which flavour of TextTestRunner is the default?
TextTestRunner = VerboseTextTestRunner
@@ -624,17 +646,17 @@
for making test modules conveniently executable.
"""
USAGE = """\
- Usage: %(progName)s [-h|--help] [test[:(casename|prefix-)]] [...]
-
- Examples:
- %(progName)s - run default set of tests
- %(progName)s MyTestSuite - run suite 'MyTestSuite'
- %(progName)s MyTestCase:checkSomething - run MyTestCase.checkSomething
- %(progName)s MyTestCase:check- - run all 'check*' test methods
+Usage: %(progName)s [-h|--help] [test[:(casename|prefix-)]] [...]
+
+Examples:
+ %(progName)s - run default set of tests
+ %(progName)s MyTestSuite - run suite 'MyTestSuite'
+ %(progName)s MyTestCase:checkSomething - run MyTestCase.checkSomething
+ %(progName)s MyTestCase:check- - run all 'check*' test methods
in MyTestCase
- """
+"""
def __init__(self, module='__main__', defaultTest=None,
- argv=None, testRunner=None):
+ argv=None, testRunner=None, suiteClass=TestSuite):
if type(module) == type(''):
self.module = __import__(module)
for part in string.split(module,'.')[1:]:
@@ -645,16 +667,16 @@
argv = sys.argv
self.defaultTest = defaultTest
self.testRunner = testRunner
+ self.suiteClass = suiteClass
self.progName = os.path.basename(argv[0])
self.parseArgs(argv)
- self.createTests()
self.runTests()
-
+
def usageExit(self, msg=None):
if msg: print msg
print self.USAGE % self.__dict__
sys.exit(2)
-
+
def parseArgs(self, argv):
import getopt
try:
@@ -664,26 +686,30 @@
if opt in ('-h','-H','--help'):
self.usageExit()
if len(args) == 0 and self.defaultTest is None:
- raise getopt.error, "No default test is defined."
+ self.test = findTestCases(self.module,
+ suiteClass=self.suiteClass)
+ return
if len(args) > 0:
self.testNames = args
else:
self.testNames = (self.defaultTest,)
+ self.createTests()
except getopt.error, msg:
self.usageExit(msg)
-
+
def createTests(self):
tests = []
for testName in self.testNames:
- tests.append(createTestInstance(testName, self.module))
- self.test = TestSuite(tests)
-
+ tests.append(createTestInstance(testName, self.module,
+ suiteClass=self.suiteClass))
+ self.test = self.suiteClass(tests)
+
def runTests(self):
if self.testRunner is None:
self.testRunner = TextTestRunner()
result = self.testRunner.run(self.test)
sys.exit(not result.wasSuccessful())
-
+
main = TestProgram