blob: b5c6befe90d3693fb62e99f72e39e098574453e8 [file] [log] [blame]
Fred Drake02538202001-03-21 18:09:46 +00001#!/usr/bin/env python
Steve Purcell5ddd1a82001-03-22 08:45:36 +00002'''
Fred Drake02538202001-03-21 18:09:46 +00003Python unit testing framework, based on Erich Gamma's JUnit and Kent Beck's
4Smalltalk testing framework.
5
Fred Drake02538202001-03-21 18:09:46 +00006This module contains the core framework classes that form the basis of
7specific test cases and suites (TestCase, TestSuite etc.), and also a
8text-based utility class for running the tests and reporting the results
Jeremy Hyltonefef5da2001-10-22 18:14:15 +00009 (TextTestRunner).
Fred Drake02538202001-03-21 18:09:46 +000010
Steve Purcell5ddd1a82001-03-22 08:45:36 +000011Simple usage:
12
13 import unittest
14
15 class IntegerArithmenticTestCase(unittest.TestCase):
16 def testAdd(self): ## test method names begin 'test*'
17 self.assertEquals((1 + 2), 3)
18 self.assertEquals(0 + 1, 1)
Steve Purcell7b065702001-09-06 08:24:40 +000019 def testMultiply(self):
Steve Purcell5ddd1a82001-03-22 08:45:36 +000020 self.assertEquals((0 * 10), 0)
21 self.assertEquals((5 * 8), 40)
22
23 if __name__ == '__main__':
24 unittest.main()
25
26Further information is available in the bundled documentation, and from
27
Georg Brandl15c5ce92007-03-07 09:09:40 +000028 http://docs.python.org/lib/module-unittest.html
Steve Purcell5ddd1a82001-03-22 08:45:36 +000029
Steve Purcell7e743842003-09-22 11:08:12 +000030Copyright (c) 1999-2003 Steve Purcell
Fred Drake02538202001-03-21 18:09:46 +000031This module is free software, and you may redistribute it and/or modify
32it under the same terms as Python itself, so long as this copyright message
33and disclaimer are retained in their original form.
34
35IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
36SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF
37THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
38DAMAGE.
39
40THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
41LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
42PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS,
43AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
44SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
Steve Purcell5ddd1a82001-03-22 08:45:36 +000045'''
Fred Drake02538202001-03-21 18:09:46 +000046
Steve Purcell5ddd1a82001-03-22 08:45:36 +000047__author__ = "Steve Purcell"
48__email__ = "stephen_purcell at yahoo dot com"
Steve Purcellb8d5f242003-12-06 13:03:13 +000049__version__ = "#Revision: 1.63 $"[11:-2]
Fred Drake02538202001-03-21 18:09:46 +000050
51import time
52import sys
53import traceback
Fred Drake02538202001-03-21 18:09:46 +000054import os
Steve Purcell5ddd1a82001-03-22 08:45:36 +000055import types
Fred Drake02538202001-03-21 18:09:46 +000056
57##############################################################################
Steve Purcelld75e7e42003-09-15 11:01:21 +000058# Exported classes and functions
59##############################################################################
60__all__ = ['TestResult', 'TestCase', 'TestSuite', 'TextTestRunner',
61 'TestLoader', 'FunctionTestCase', 'main', 'defaultTestLoader']
62
Steve Purcell7e743842003-09-22 11:08:12 +000063# Expose obsolete functions for backwards compatibility
Steve Purcelld75e7e42003-09-15 11:01:21 +000064__all__.extend(['getTestCaseNames', 'makeSuite', 'findTestCases'])
65
66
67##############################################################################
Steve Purcell7e743842003-09-22 11:08:12 +000068# Backward compatibility
69##############################################################################
70if sys.version_info[:2] < (2, 2):
Steve Purcell7e743842003-09-22 11:08:12 +000071 def isinstance(obj, clsinfo):
72 import __builtin__
Raymond Hettingerf7153662005-02-07 14:16:21 +000073 if type(clsinfo) in (tuple, list):
Steve Purcell7e743842003-09-22 11:08:12 +000074 for cls in clsinfo:
75 if cls is type: cls = types.ClassType
76 if __builtin__.isinstance(obj, cls):
77 return 1
78 return 0
79 else: return __builtin__.isinstance(obj, clsinfo)
80
Raymond Hettinger5930d8f2008-07-10 16:06:41 +000081def _CmpToKey(mycmp):
82 'Convert a cmp= function into a key= function'
83 class K(object):
84 def __init__(self, obj):
85 self.obj = obj
86 def __lt__(self, other):
87 return mycmp(self.obj, other.obj) == -1
88 return K
Steve Purcell7e743842003-09-22 11:08:12 +000089
90##############################################################################
Fred Drake02538202001-03-21 18:09:46 +000091# Test framework core
92##############################################################################
93
Steve Purcell824574d2002-08-08 13:38:02 +000094# All classes defined herein are 'new-style' classes, allowing use of 'super()'
95__metaclass__ = type
96
Steve Purcelldc391a62002-08-09 09:46:23 +000097def _strclass(cls):
98 return "%s.%s" % (cls.__module__, cls.__name__)
99
Steve Purcellb8d5f242003-12-06 13:03:13 +0000100__unittest = 1
101
Fred Drake02538202001-03-21 18:09:46 +0000102class TestResult:
103 """Holder for test result information.
104
105 Test results are automatically managed by the TestCase and TestSuite
106 classes, and do not need to be explicitly manipulated by writers of tests.
107
108 Each instance holds the total number of tests run, and collections of
109 failures and errors that occurred among those test runs. The collections
Steve Purcell7b065702001-09-06 08:24:40 +0000110 contain tuples of (testcase, exceptioninfo), where exceptioninfo is the
Fred Drake656f9ec2001-09-06 19:13:14 +0000111 formatted traceback of the error that occurred.
Fred Drake02538202001-03-21 18:09:46 +0000112 """
113 def __init__(self):
114 self.failures = []
115 self.errors = []
116 self.testsRun = 0
Georg Brandl15c5ce92007-03-07 09:09:40 +0000117 self.shouldStop = False
Fred Drake02538202001-03-21 18:09:46 +0000118
119 def startTest(self, test):
120 "Called when the given test is about to be run"
121 self.testsRun = self.testsRun + 1
122
123 def stopTest(self, test):
124 "Called when the given test has been run"
125 pass
126
127 def addError(self, test, err):
Steve Purcell7b065702001-09-06 08:24:40 +0000128 """Called when an error has occurred. 'err' is a tuple of values as
129 returned by sys.exc_info().
130 """
Steve Purcellb8d5f242003-12-06 13:03:13 +0000131 self.errors.append((test, self._exc_info_to_string(err, test)))
Fred Drake02538202001-03-21 18:09:46 +0000132
133 def addFailure(self, test, err):
Steve Purcell7b065702001-09-06 08:24:40 +0000134 """Called when an error has occurred. 'err' is a tuple of values as
135 returned by sys.exc_info()."""
Steve Purcellb8d5f242003-12-06 13:03:13 +0000136 self.failures.append((test, self._exc_info_to_string(err, test)))
Fred Drake02538202001-03-21 18:09:46 +0000137
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000138 def addSuccess(self, test):
139 "Called when a test has completed successfully"
140 pass
141
Fred Drake02538202001-03-21 18:09:46 +0000142 def wasSuccessful(self):
143 "Tells whether or not this result was a success"
144 return len(self.failures) == len(self.errors) == 0
145
146 def stop(self):
147 "Indicates that the tests should be aborted"
Steve Purcell7e743842003-09-22 11:08:12 +0000148 self.shouldStop = True
Tim Petersa19a1682001-03-29 04:36:09 +0000149
Steve Purcellb8d5f242003-12-06 13:03:13 +0000150 def _exc_info_to_string(self, err, test):
Steve Purcell7b065702001-09-06 08:24:40 +0000151 """Converts a sys.exc_info()-style tuple of values into a string."""
Steve Purcellb8d5f242003-12-06 13:03:13 +0000152 exctype, value, tb = err
153 # Skip test runner traceback levels
154 while tb and self._is_relevant_tb_level(tb):
155 tb = tb.tb_next
156 if exctype is test.failureException:
157 # Skip assert*() traceback levels
158 length = self._count_relevant_tb_levels(tb)
159 return ''.join(traceback.format_exception(exctype, value, tb, length))
160 return ''.join(traceback.format_exception(exctype, value, tb))
161
162 def _is_relevant_tb_level(self, tb):
163 return tb.tb_frame.f_globals.has_key('__unittest')
164
165 def _count_relevant_tb_levels(self, tb):
166 length = 0
167 while tb and not self._is_relevant_tb_level(tb):
168 length += 1
169 tb = tb.tb_next
170 return length
Steve Purcell7b065702001-09-06 08:24:40 +0000171
Fred Drake02538202001-03-21 18:09:46 +0000172 def __repr__(self):
173 return "<%s run=%i errors=%i failures=%i>" % \
Steve Purcelldc391a62002-08-09 09:46:23 +0000174 (_strclass(self.__class__), self.testsRun, len(self.errors),
Fred Drake02538202001-03-21 18:09:46 +0000175 len(self.failures))
176
Fred Drake02538202001-03-21 18:09:46 +0000177class TestCase:
178 """A class whose instances are single test cases.
179
Fred Drake02538202001-03-21 18:09:46 +0000180 By default, the test code itself should be placed in a method named
181 'runTest'.
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000182
Tim Petersa19a1682001-03-29 04:36:09 +0000183 If the fixture may be used for many test cases, create as
Fred Drake02538202001-03-21 18:09:46 +0000184 many test methods as are needed. When instantiating such a TestCase
185 subclass, specify in the constructor arguments the name of the test method
186 that the instance is to execute.
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000187
Tim Petersa19a1682001-03-29 04:36:09 +0000188 Test authors should subclass TestCase for their own tests. Construction
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000189 and deconstruction of the test's environment ('fixture') can be
190 implemented by overriding the 'setUp' and 'tearDown' methods respectively.
191
192 If it is necessary to override the __init__ method, the base class
193 __init__ method must always be called. It is important that subclasses
194 should not change the signature of their __init__ method, since instances
195 of the classes are instantiated automatically by parts of the framework
196 in order to be run.
Fred Drake02538202001-03-21 18:09:46 +0000197 """
Steve Purcell15d89272001-04-12 09:05:01 +0000198
199 # This attribute determines which exception will be raised when
200 # the instance's assertion methods fail; test methods raising this
201 # exception will be deemed to have 'failed' rather than 'errored'
202
203 failureException = AssertionError
204
Fred Drake02538202001-03-21 18:09:46 +0000205 def __init__(self, methodName='runTest'):
206 """Create an instance of the class that will use the named test
207 method when executed. Raises a ValueError if the instance does
208 not have a method with the specified name.
209 """
210 try:
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000211 self._testMethodName = methodName
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000212 testMethod = getattr(self, methodName)
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000213 self._testMethodDoc = testMethod.__doc__
Fred Drake02538202001-03-21 18:09:46 +0000214 except AttributeError:
215 raise ValueError, "no such test method in %s: %s" % \
216 (self.__class__, methodName)
217
218 def setUp(self):
219 "Hook method for setting up the test fixture before exercising it."
220 pass
221
222 def tearDown(self):
223 "Hook method for deconstructing the test fixture after testing it."
224 pass
225
226 def countTestCases(self):
227 return 1
228
229 def defaultTestResult(self):
230 return TestResult()
231
232 def shortDescription(self):
233 """Returns a one-line description of the test, or None if no
234 description has been provided.
235
236 The default implementation of this method returns the first line of
237 the specified test method's docstring.
238 """
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000239 doc = self._testMethodDoc
Steve Purcell7e743842003-09-22 11:08:12 +0000240 return doc and doc.split("\n")[0].strip() or None
Fred Drake02538202001-03-21 18:09:46 +0000241
242 def id(self):
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000243 return "%s.%s" % (_strclass(self.__class__), self._testMethodName)
Fred Drake02538202001-03-21 18:09:46 +0000244
Georg Brandl15c5ce92007-03-07 09:09:40 +0000245 def __eq__(self, other):
246 if type(self) is not type(other):
247 return False
248
249 return self._testMethodName == other._testMethodName
250
251 def __ne__(self, other):
252 return not self == other
253
254 def __hash__(self):
Collin Winter9453e5d2007-03-09 23:30:39 +0000255 return hash((type(self), self._testMethodName))
Georg Brandl15c5ce92007-03-07 09:09:40 +0000256
Fred Drake02538202001-03-21 18:09:46 +0000257 def __str__(self):
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000258 return "%s (%s)" % (self._testMethodName, _strclass(self.__class__))
Fred Drake02538202001-03-21 18:09:46 +0000259
260 def __repr__(self):
261 return "<%s testMethod=%s>" % \
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000262 (_strclass(self.__class__), self._testMethodName)
Fred Drake02538202001-03-21 18:09:46 +0000263
264 def run(self, result=None):
Fred Drake02538202001-03-21 18:09:46 +0000265 if result is None: result = self.defaultTestResult()
266 result.startTest(self)
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000267 testMethod = getattr(self, self._testMethodName)
Fred Drake02538202001-03-21 18:09:46 +0000268 try:
269 try:
270 self.setUp()
Guido van Rossum202dd1e2001-12-07 03:39:34 +0000271 except KeyboardInterrupt:
272 raise
Fred Drake02538202001-03-21 18:09:46 +0000273 except:
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000274 result.addError(self, self._exc_info())
Fred Drake02538202001-03-21 18:09:46 +0000275 return
276
Steve Purcell7e743842003-09-22 11:08:12 +0000277 ok = False
Fred Drake02538202001-03-21 18:09:46 +0000278 try:
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000279 testMethod()
Steve Purcell7e743842003-09-22 11:08:12 +0000280 ok = True
Skip Montanaroae5c37b2003-07-13 15:18:12 +0000281 except self.failureException:
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000282 result.addFailure(self, self._exc_info())
Guido van Rossum202dd1e2001-12-07 03:39:34 +0000283 except KeyboardInterrupt:
284 raise
Fred Drake02538202001-03-21 18:09:46 +0000285 except:
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000286 result.addError(self, self._exc_info())
Fred Drake02538202001-03-21 18:09:46 +0000287
288 try:
289 self.tearDown()
Guido van Rossum202dd1e2001-12-07 03:39:34 +0000290 except KeyboardInterrupt:
291 raise
Fred Drake02538202001-03-21 18:09:46 +0000292 except:
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000293 result.addError(self, self._exc_info())
Steve Purcell7e743842003-09-22 11:08:12 +0000294 ok = False
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000295 if ok: result.addSuccess(self)
Fred Drake02538202001-03-21 18:09:46 +0000296 finally:
297 result.stopTest(self)
298
Raymond Hettinger664347b2004-12-04 21:21:53 +0000299 def __call__(self, *args, **kwds):
300 return self.run(*args, **kwds)
Steve Purcell7e743842003-09-22 11:08:12 +0000301
Fred Drake02538202001-03-21 18:09:46 +0000302 def debug(self):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000303 """Run the test without collecting errors in a TestResult"""
Fred Drake02538202001-03-21 18:09:46 +0000304 self.setUp()
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000305 getattr(self, self._testMethodName)()
Fred Drake02538202001-03-21 18:09:46 +0000306 self.tearDown()
307
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000308 def _exc_info(self):
Steve Purcell15d89272001-04-12 09:05:01 +0000309 """Return a version of sys.exc_info() with the traceback frame
310 minimised; usually the top level of the traceback frame is not
311 needed.
Fred Drake02538202001-03-21 18:09:46 +0000312 """
Georg Brandl15c5ce92007-03-07 09:09:40 +0000313 return sys.exc_info()
Fred Drake02538202001-03-21 18:09:46 +0000314
Steve Purcell15d89272001-04-12 09:05:01 +0000315 def fail(self, msg=None):
316 """Fail immediately, with the given message."""
317 raise self.failureException, msg
Fred Drake02538202001-03-21 18:09:46 +0000318
319 def failIf(self, expr, msg=None):
320 "Fail the test if the expression is true."
Steve Purcell15d89272001-04-12 09:05:01 +0000321 if expr: raise self.failureException, msg
Fred Drake02538202001-03-21 18:09:46 +0000322
Steve Purcell15d89272001-04-12 09:05:01 +0000323 def failUnless(self, expr, msg=None):
324 """Fail the test unless the expression is true."""
325 if not expr: raise self.failureException, msg
326
327 def failUnlessRaises(self, excClass, callableObj, *args, **kwargs):
328 """Fail unless an exception of class excClass is thrown
Fred Drake02538202001-03-21 18:09:46 +0000329 by callableObj when invoked with arguments args and keyword
330 arguments kwargs. If a different type of exception is
331 thrown, it will not be caught, and the test case will be
332 deemed to have suffered an error, exactly as for an
333 unexpected exception.
334 """
335 try:
Guido van Rossum68468eb2003-02-27 20:14:51 +0000336 callableObj(*args, **kwargs)
Fred Drake02538202001-03-21 18:09:46 +0000337 except excClass:
338 return
339 else:
340 if hasattr(excClass,'__name__'): excName = excClass.__name__
341 else: excName = str(excClass)
Steve Purcell7e743842003-09-22 11:08:12 +0000342 raise self.failureException, "%s not raised" % excName
Fred Drake02538202001-03-21 18:09:46 +0000343
Steve Purcell15d89272001-04-12 09:05:01 +0000344 def failUnlessEqual(self, first, second, msg=None):
Raymond Hettingerc377cbf2003-04-04 22:56:42 +0000345 """Fail if the two objects are unequal as determined by the '=='
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000346 operator.
347 """
Raymond Hettingerc377cbf2003-04-04 22:56:42 +0000348 if not first == second:
Steve Purcellca9aaf32001-12-17 10:13:17 +0000349 raise self.failureException, \
Walter Dörwald70a6b492004-02-12 17:35:32 +0000350 (msg or '%r != %r' % (first, second))
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000351
Steve Purcell15d89272001-04-12 09:05:01 +0000352 def failIfEqual(self, first, second, msg=None):
353 """Fail if the two objects are equal as determined by the '=='
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000354 operator.
355 """
Steve Purcell15d89272001-04-12 09:05:01 +0000356 if first == second:
Steve Purcellca9aaf32001-12-17 10:13:17 +0000357 raise self.failureException, \
Walter Dörwald70a6b492004-02-12 17:35:32 +0000358 (msg or '%r == %r' % (first, second))
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000359
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000360 def failUnlessAlmostEqual(self, first, second, places=7, msg=None):
361 """Fail if the two objects are unequal as determined by their
362 difference rounded to the given number of decimal places
363 (default 7) and comparing to zero.
364
Steve Purcell397b45d2003-10-26 10:41:03 +0000365 Note that decimal places (from zero) are usually not the same
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000366 as significant digits (measured from the most signficant digit).
367 """
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +0000368 if round(abs(second-first), places) != 0:
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000369 raise self.failureException, \
Walter Dörwald70a6b492004-02-12 17:35:32 +0000370 (msg or '%r != %r within %r places' % (first, second, places))
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000371
372 def failIfAlmostEqual(self, first, second, places=7, msg=None):
373 """Fail if the two objects are equal as determined by their
374 difference rounded to the given number of decimal places
375 (default 7) and comparing to zero.
376
Steve Purcellcca34912003-10-26 16:38:16 +0000377 Note that decimal places (from zero) are usually not the same
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000378 as significant digits (measured from the most signficant digit).
379 """
Jeffrey Yasskin2f3c16b2008-01-03 02:21:52 +0000380 if round(abs(second-first), places) == 0:
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000381 raise self.failureException, \
Walter Dörwald70a6b492004-02-12 17:35:32 +0000382 (msg or '%r == %r within %r places' % (first, second, places))
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000383
Steve Purcell7e743842003-09-22 11:08:12 +0000384 # Synonyms for assertion methods
385
Steve Purcell15d89272001-04-12 09:05:01 +0000386 assertEqual = assertEquals = failUnlessEqual
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000387
Steve Purcell15d89272001-04-12 09:05:01 +0000388 assertNotEqual = assertNotEquals = failIfEqual
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000389
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000390 assertAlmostEqual = assertAlmostEquals = failUnlessAlmostEqual
391
392 assertNotAlmostEqual = assertNotAlmostEquals = failIfAlmostEqual
393
Steve Purcell15d89272001-04-12 09:05:01 +0000394 assertRaises = failUnlessRaises
395
Steve Purcell7e743842003-09-22 11:08:12 +0000396 assert_ = assertTrue = failUnless
397
398 assertFalse = failIf
Steve Purcell15d89272001-04-12 09:05:01 +0000399
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000400
Fred Drake02538202001-03-21 18:09:46 +0000401
402class TestSuite:
403 """A test suite is a composite test consisting of a number of TestCases.
404
405 For use, create an instance of TestSuite, then add test case instances.
406 When all tests have been added, the suite can be passed to a test
407 runner, such as TextTestRunner. It will run the individual test cases
408 in the order in which they were added, aggregating the results. When
409 subclassing, do not forget to call the base class constructor.
410 """
411 def __init__(self, tests=()):
412 self._tests = []
413 self.addTests(tests)
414
415 def __repr__(self):
Steve Purcelldc391a62002-08-09 09:46:23 +0000416 return "<%s tests=%s>" % (_strclass(self.__class__), self._tests)
Fred Drake02538202001-03-21 18:09:46 +0000417
418 __str__ = __repr__
419
Georg Brandl15c5ce92007-03-07 09:09:40 +0000420 def __eq__(self, other):
421 if type(self) is not type(other):
422 return False
423 return self._tests == other._tests
424
425 def __ne__(self, other):
426 return not self == other
427
Jim Fultonfafd8742004-08-28 15:22:12 +0000428 def __iter__(self):
429 return iter(self._tests)
430
Fred Drake02538202001-03-21 18:09:46 +0000431 def countTestCases(self):
432 cases = 0
433 for test in self._tests:
Steve Purcell7e743842003-09-22 11:08:12 +0000434 cases += test.countTestCases()
Fred Drake02538202001-03-21 18:09:46 +0000435 return cases
436
437 def addTest(self, test):
Georg Brandld9e50262007-03-07 11:54:49 +0000438 # sanity checks
Raymond Hettinger5930d8f2008-07-10 16:06:41 +0000439 if not hasattr(test, '__call__'):
Georg Brandld9e50262007-03-07 11:54:49 +0000440 raise TypeError("the test to add must be callable")
441 if (isinstance(test, (type, types.ClassType)) and
442 issubclass(test, (TestCase, TestSuite))):
443 raise TypeError("TestCases and TestSuites must be instantiated "
444 "before passing them to addTest()")
Fred Drake02538202001-03-21 18:09:46 +0000445 self._tests.append(test)
446
447 def addTests(self, tests):
Georg Brandld9e50262007-03-07 11:54:49 +0000448 if isinstance(tests, basestring):
449 raise TypeError("tests must be an iterable of tests, not a string")
Fred Drake02538202001-03-21 18:09:46 +0000450 for test in tests:
451 self.addTest(test)
452
453 def run(self, result):
Fred Drake02538202001-03-21 18:09:46 +0000454 for test in self._tests:
455 if result.shouldStop:
456 break
457 test(result)
458 return result
459
Raymond Hettinger664347b2004-12-04 21:21:53 +0000460 def __call__(self, *args, **kwds):
461 return self.run(*args, **kwds)
462
Fred Drake02538202001-03-21 18:09:46 +0000463 def debug(self):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000464 """Run the tests without collecting errors in a TestResult"""
Fred Drake02538202001-03-21 18:09:46 +0000465 for test in self._tests: test.debug()
Fred Drake02538202001-03-21 18:09:46 +0000466
467
468class FunctionTestCase(TestCase):
469 """A test case that wraps a test function.
470
471 This is useful for slipping pre-existing test functions into the
Georg Brandl15c5ce92007-03-07 09:09:40 +0000472 unittest framework. Optionally, set-up and tidy-up functions can be
Fred Drake02538202001-03-21 18:09:46 +0000473 supplied. As with TestCase, the tidy-up ('tearDown') function will
474 always be called if the set-up ('setUp') function ran successfully.
475 """
476
477 def __init__(self, testFunc, setUp=None, tearDown=None,
478 description=None):
479 TestCase.__init__(self)
480 self.__setUpFunc = setUp
481 self.__tearDownFunc = tearDown
482 self.__testFunc = testFunc
483 self.__description = description
484
485 def setUp(self):
486 if self.__setUpFunc is not None:
487 self.__setUpFunc()
488
489 def tearDown(self):
490 if self.__tearDownFunc is not None:
491 self.__tearDownFunc()
492
493 def runTest(self):
494 self.__testFunc()
495
496 def id(self):
497 return self.__testFunc.__name__
498
Georg Brandl15c5ce92007-03-07 09:09:40 +0000499 def __eq__(self, other):
500 if type(self) is not type(other):
501 return False
502
503 return self.__setUpFunc == other.__setUpFunc and \
504 self.__tearDownFunc == other.__tearDownFunc and \
505 self.__testFunc == other.__testFunc and \
506 self.__description == other.__description
507
508 def __ne__(self, other):
509 return not self == other
510
511 def __hash__(self):
Collin Winter9453e5d2007-03-09 23:30:39 +0000512 return hash((type(self), self.__setUpFunc, self.__tearDownFunc,
513 self.__testFunc, self.__description))
Georg Brandl15c5ce92007-03-07 09:09:40 +0000514
Fred Drake02538202001-03-21 18:09:46 +0000515 def __str__(self):
Steve Purcelldc391a62002-08-09 09:46:23 +0000516 return "%s (%s)" % (_strclass(self.__class__), self.__testFunc.__name__)
Fred Drake02538202001-03-21 18:09:46 +0000517
518 def __repr__(self):
Steve Purcelldc391a62002-08-09 09:46:23 +0000519 return "<%s testFunc=%s>" % (_strclass(self.__class__), self.__testFunc)
Fred Drake02538202001-03-21 18:09:46 +0000520
521 def shortDescription(self):
522 if self.__description is not None: return self.__description
523 doc = self.__testFunc.__doc__
Steve Purcell7e743842003-09-22 11:08:12 +0000524 return doc and doc.split("\n")[0].strip() or None
Fred Drake02538202001-03-21 18:09:46 +0000525
526
527
528##############################################################################
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000529# Locating and loading tests
Fred Drake02538202001-03-21 18:09:46 +0000530##############################################################################
531
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000532class TestLoader:
533 """This class is responsible for loading tests according to various
Georg Brandl15c5ce92007-03-07 09:09:40 +0000534 criteria and returning them wrapped in a TestSuite
Fred Drake02538202001-03-21 18:09:46 +0000535 """
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000536 testMethodPrefix = 'test'
537 sortTestMethodsUsing = cmp
538 suiteClass = TestSuite
Fred Drake02538202001-03-21 18:09:46 +0000539
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000540 def loadTestsFromTestCase(self, testCaseClass):
Steve Purcell15d89272001-04-12 09:05:01 +0000541 """Return a suite of all tests cases contained in testCaseClass"""
Johannes Gijsbersd7b6ad42004-11-07 15:46:25 +0000542 if issubclass(testCaseClass, TestSuite):
543 raise TypeError("Test cases should not be derived from TestSuite. Maybe you meant to derive from TestCase?")
Steve Purcell7e743842003-09-22 11:08:12 +0000544 testCaseNames = self.getTestCaseNames(testCaseClass)
545 if not testCaseNames and hasattr(testCaseClass, 'runTest'):
546 testCaseNames = ['runTest']
547 return self.suiteClass(map(testCaseClass, testCaseNames))
Fred Drake02538202001-03-21 18:09:46 +0000548
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000549 def loadTestsFromModule(self, module):
Steve Purcell15d89272001-04-12 09:05:01 +0000550 """Return a suite of all tests cases contained in the given module"""
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000551 tests = []
552 for name in dir(module):
553 obj = getattr(module, name)
Guido van Rossum67911372002-09-30 19:25:56 +0000554 if (isinstance(obj, (type, types.ClassType)) and
555 issubclass(obj, TestCase)):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000556 tests.append(self.loadTestsFromTestCase(obj))
557 return self.suiteClass(tests)
Fred Drake02538202001-03-21 18:09:46 +0000558
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000559 def loadTestsFromName(self, name, module=None):
Steve Purcell15d89272001-04-12 09:05:01 +0000560 """Return a suite of all tests cases given a string specifier.
561
562 The name may resolve either to a module, a test case class, a
563 test method within a test case class, or a callable object which
564 returns a TestCase or TestSuite instance.
Tim Peters613b2222001-04-13 05:37:27 +0000565
Steve Purcell15d89272001-04-12 09:05:01 +0000566 The method optionally resolves the names relative to a given module.
567 """
Steve Purcell7e743842003-09-22 11:08:12 +0000568 parts = name.split('.')
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000569 if module is None:
Steve Purcell7e743842003-09-22 11:08:12 +0000570 parts_copy = parts[:]
571 while parts_copy:
572 try:
573 module = __import__('.'.join(parts_copy))
574 break
575 except ImportError:
576 del parts_copy[-1]
577 if not parts_copy: raise
Armin Rigo1b3c04b2003-10-24 17:15:29 +0000578 parts = parts[1:]
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000579 obj = module
580 for part in parts:
Steve Purcell7e743842003-09-22 11:08:12 +0000581 parent, obj = obj, getattr(obj, part)
Fred Drake02538202001-03-21 18:09:46 +0000582
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000583 if type(obj) == types.ModuleType:
584 return self.loadTestsFromModule(obj)
Guido van Rossum67911372002-09-30 19:25:56 +0000585 elif (isinstance(obj, (type, types.ClassType)) and
Steve Purcell397b45d2003-10-26 10:41:03 +0000586 issubclass(obj, TestCase)):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000587 return self.loadTestsFromTestCase(obj)
Georg Brandl15c5ce92007-03-07 09:09:40 +0000588 elif (type(obj) == types.UnboundMethodType and
589 isinstance(parent, (type, types.ClassType)) and
590 issubclass(parent, TestCase)):
591 return TestSuite([parent(obj.__name__)])
Steve Purcell397b45d2003-10-26 10:41:03 +0000592 elif isinstance(obj, TestSuite):
Steve Purcell7e743842003-09-22 11:08:12 +0000593 return obj
Raymond Hettinger5930d8f2008-07-10 16:06:41 +0000594 elif hasattr(obj, '__call__'):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000595 test = obj()
Georg Brandl15c5ce92007-03-07 09:09:40 +0000596 if isinstance(test, TestSuite):
597 return test
598 elif isinstance(test, TestCase):
599 return TestSuite([test])
600 else:
601 raise TypeError("calling %s returned %s, not a test" %
602 (obj, test))
Fred Drake02538202001-03-21 18:09:46 +0000603 else:
Georg Brandl15c5ce92007-03-07 09:09:40 +0000604 raise TypeError("don't know how to make test from: %s" % obj)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000605
606 def loadTestsFromNames(self, names, module=None):
Steve Purcell15d89272001-04-12 09:05:01 +0000607 """Return a suite of all tests cases found using the given sequence
608 of string specifiers. See 'loadTestsFromName()'.
609 """
Steve Purcell7e743842003-09-22 11:08:12 +0000610 suites = [self.loadTestsFromName(name, module) for name in names]
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000611 return self.suiteClass(suites)
612
613 def getTestCaseNames(self, testCaseClass):
Steve Purcell15d89272001-04-12 09:05:01 +0000614 """Return a sorted sequence of method names found within testCaseClass
615 """
Steve Purcell7e743842003-09-22 11:08:12 +0000616 def isTestMethod(attrname, testCaseClass=testCaseClass, prefix=self.testMethodPrefix):
Raymond Hettinger5930d8f2008-07-10 16:06:41 +0000617 return attrname.startswith(prefix) and hasattr(getattr(testCaseClass, attrname), '__call__')
Steve Purcell7e743842003-09-22 11:08:12 +0000618 testFnNames = filter(isTestMethod, dir(testCaseClass))
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000619 if self.sortTestMethodsUsing:
Raymond Hettinger5930d8f2008-07-10 16:06:41 +0000620 testFnNames.sort(key=_CmpToKey(self.sortTestMethodsUsing))
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000621 return testFnNames
622
623
624
625defaultTestLoader = TestLoader()
626
627
628##############################################################################
629# Patches for old functions: these functions should be considered obsolete
630##############################################################################
631
632def _makeLoader(prefix, sortUsing, suiteClass=None):
633 loader = TestLoader()
634 loader.sortTestMethodsUsing = sortUsing
635 loader.testMethodPrefix = prefix
636 if suiteClass: loader.suiteClass = suiteClass
637 return loader
638
639def getTestCaseNames(testCaseClass, prefix, sortUsing=cmp):
640 return _makeLoader(prefix, sortUsing).getTestCaseNames(testCaseClass)
641
642def makeSuite(testCaseClass, prefix='test', sortUsing=cmp, suiteClass=TestSuite):
643 return _makeLoader(prefix, sortUsing, suiteClass).loadTestsFromTestCase(testCaseClass)
644
645def findTestCases(module, prefix='test', sortUsing=cmp, suiteClass=TestSuite):
646 return _makeLoader(prefix, sortUsing, suiteClass).loadTestsFromModule(module)
Fred Drake02538202001-03-21 18:09:46 +0000647
648
649##############################################################################
650# Text UI
651##############################################################################
652
653class _WritelnDecorator:
654 """Used to decorate file-like objects with a handy 'writeln' method"""
655 def __init__(self,stream):
656 self.stream = stream
Fred Drake02538202001-03-21 18:09:46 +0000657
658 def __getattr__(self, attr):
659 return getattr(self.stream,attr)
660
Raymond Hettinger91dd19d2003-09-13 02:58:00 +0000661 def writeln(self, arg=None):
662 if arg: self.write(arg)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000663 self.write('\n') # text-mode streams translate to \r\n if needed
Tim Petersa19a1682001-03-29 04:36:09 +0000664
Fred Drake02538202001-03-21 18:09:46 +0000665
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000666class _TextTestResult(TestResult):
Fred Drake02538202001-03-21 18:09:46 +0000667 """A test result class that can print formatted text results to a stream.
668
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000669 Used by TextTestRunner.
Fred Drake02538202001-03-21 18:09:46 +0000670 """
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000671 separator1 = '=' * 70
672 separator2 = '-' * 70
Fred Drake02538202001-03-21 18:09:46 +0000673
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000674 def __init__(self, stream, descriptions, verbosity):
Fred Drake02538202001-03-21 18:09:46 +0000675 TestResult.__init__(self)
676 self.stream = stream
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000677 self.showAll = verbosity > 1
678 self.dots = verbosity == 1
Fred Drake02538202001-03-21 18:09:46 +0000679 self.descriptions = descriptions
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000680
681 def getDescription(self, test):
682 if self.descriptions:
683 return test.shortDescription() or str(test)
684 else:
685 return str(test)
686
Fred Drake02538202001-03-21 18:09:46 +0000687 def startTest(self, test):
688 TestResult.startTest(self, test)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000689 if self.showAll:
690 self.stream.write(self.getDescription(test))
691 self.stream.write(" ... ")
Georg Brandld0632402008-05-11 15:17:41 +0000692 self.stream.flush()
Fred Drake02538202001-03-21 18:09:46 +0000693
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000694 def addSuccess(self, test):
695 TestResult.addSuccess(self, test)
696 if self.showAll:
Fred Drake02538202001-03-21 18:09:46 +0000697 self.stream.writeln("ok")
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000698 elif self.dots:
699 self.stream.write('.')
Georg Brandld0632402008-05-11 15:17:41 +0000700 self.stream.flush()
Fred Drake02538202001-03-21 18:09:46 +0000701
702 def addError(self, test, err):
703 TestResult.addError(self, test, err)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000704 if self.showAll:
705 self.stream.writeln("ERROR")
706 elif self.dots:
707 self.stream.write('E')
Georg Brandld0632402008-05-11 15:17:41 +0000708 self.stream.flush()
Fred Drake02538202001-03-21 18:09:46 +0000709
710 def addFailure(self, test, err):
711 TestResult.addFailure(self, test, err)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000712 if self.showAll:
713 self.stream.writeln("FAIL")
714 elif self.dots:
715 self.stream.write('F')
Georg Brandld0632402008-05-11 15:17:41 +0000716 self.stream.flush()
Fred Drake02538202001-03-21 18:09:46 +0000717
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000718 def printErrors(self):
719 if self.dots or self.showAll:
Fred Drake02538202001-03-21 18:09:46 +0000720 self.stream.writeln()
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000721 self.printErrorList('ERROR', self.errors)
722 self.printErrorList('FAIL', self.failures)
723
724 def printErrorList(self, flavour, errors):
725 for test, err in errors:
726 self.stream.writeln(self.separator1)
727 self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
728 self.stream.writeln(self.separator2)
Steve Purcell7b065702001-09-06 08:24:40 +0000729 self.stream.writeln("%s" % err)
Fred Drake02538202001-03-21 18:09:46 +0000730
731
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000732class TextTestRunner:
Fred Drake02538202001-03-21 18:09:46 +0000733 """A test runner class that displays results in textual form.
Tim Petersa19a1682001-03-29 04:36:09 +0000734
Fred Drake02538202001-03-21 18:09:46 +0000735 It prints out the names of tests as they are run, errors as they
736 occur, and a summary of the results at the end of the test run.
737 """
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000738 def __init__(self, stream=sys.stderr, descriptions=1, verbosity=1):
Fred Drake02538202001-03-21 18:09:46 +0000739 self.stream = _WritelnDecorator(stream)
740 self.descriptions = descriptions
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000741 self.verbosity = verbosity
742
743 def _makeResult(self):
744 return _TextTestResult(self.stream, self.descriptions, self.verbosity)
Fred Drake02538202001-03-21 18:09:46 +0000745
746 def run(self, test):
747 "Run the given test case or test suite."
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000748 result = self._makeResult()
Fred Drake02538202001-03-21 18:09:46 +0000749 startTime = time.time()
750 test(result)
751 stopTime = time.time()
Steve Purcell397b45d2003-10-26 10:41:03 +0000752 timeTaken = stopTime - startTime
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000753 result.printErrors()
754 self.stream.writeln(result.separator2)
Fred Drake02538202001-03-21 18:09:46 +0000755 run = result.testsRun
756 self.stream.writeln("Ran %d test%s in %.3fs" %
Neal Norwitz76165042002-05-31 14:15:11 +0000757 (run, run != 1 and "s" or "", timeTaken))
Fred Drake02538202001-03-21 18:09:46 +0000758 self.stream.writeln()
759 if not result.wasSuccessful():
760 self.stream.write("FAILED (")
761 failed, errored = map(len, (result.failures, result.errors))
762 if failed:
763 self.stream.write("failures=%d" % failed)
764 if errored:
765 if failed: self.stream.write(", ")
766 self.stream.write("errors=%d" % errored)
767 self.stream.writeln(")")
768 else:
769 self.stream.writeln("OK")
770 return result
Tim Petersa19a1682001-03-29 04:36:09 +0000771
Fred Drake02538202001-03-21 18:09:46 +0000772
Fred Drake02538202001-03-21 18:09:46 +0000773
774##############################################################################
775# Facilities for running tests from the command line
776##############################################################################
777
778class TestProgram:
779 """A command-line program that runs a set of tests; this is primarily
780 for making test modules conveniently executable.
781 """
782 USAGE = """\
Steve Purcell17a781b2001-04-09 15:37:31 +0000783Usage: %(progName)s [options] [test] [...]
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000784
785Options:
786 -h, --help Show this message
787 -v, --verbose Verbose output
788 -q, --quiet Minimal output
Fred Drake02538202001-03-21 18:09:46 +0000789
790Examples:
791 %(progName)s - run default set of tests
792 %(progName)s MyTestSuite - run suite 'MyTestSuite'
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000793 %(progName)s MyTestCase.testSomething - run MyTestCase.testSomething
794 %(progName)s MyTestCase - run all 'test*' test methods
Fred Drake02538202001-03-21 18:09:46 +0000795 in MyTestCase
796"""
797 def __init__(self, module='__main__', defaultTest=None,
Georg Brandld0a96252007-03-07 09:21:06 +0000798 argv=None, testRunner=TextTestRunner,
799 testLoader=defaultTestLoader):
Fred Drake02538202001-03-21 18:09:46 +0000800 if type(module) == type(''):
801 self.module = __import__(module)
Steve Purcell7e743842003-09-22 11:08:12 +0000802 for part in module.split('.')[1:]:
Fred Drake02538202001-03-21 18:09:46 +0000803 self.module = getattr(self.module, part)
804 else:
805 self.module = module
806 if argv is None:
807 argv = sys.argv
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000808 self.verbosity = 1
Fred Drake02538202001-03-21 18:09:46 +0000809 self.defaultTest = defaultTest
810 self.testRunner = testRunner
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000811 self.testLoader = testLoader
Fred Drake02538202001-03-21 18:09:46 +0000812 self.progName = os.path.basename(argv[0])
813 self.parseArgs(argv)
Fred Drake02538202001-03-21 18:09:46 +0000814 self.runTests()
815
816 def usageExit(self, msg=None):
817 if msg: print msg
818 print self.USAGE % self.__dict__
819 sys.exit(2)
820
821 def parseArgs(self, argv):
822 import getopt
823 try:
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000824 options, args = getopt.getopt(argv[1:], 'hHvq',
825 ['help','verbose','quiet'])
Fred Drake02538202001-03-21 18:09:46 +0000826 for opt, value in options:
827 if opt in ('-h','-H','--help'):
828 self.usageExit()
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000829 if opt in ('-q','--quiet'):
830 self.verbosity = 0
831 if opt in ('-v','--verbose'):
832 self.verbosity = 2
Fred Drake02538202001-03-21 18:09:46 +0000833 if len(args) == 0 and self.defaultTest is None:
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000834 self.test = self.testLoader.loadTestsFromModule(self.module)
835 return
Fred Drake02538202001-03-21 18:09:46 +0000836 if len(args) > 0:
837 self.testNames = args
838 else:
839 self.testNames = (self.defaultTest,)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000840 self.createTests()
Fred Drake02538202001-03-21 18:09:46 +0000841 except getopt.error, msg:
842 self.usageExit(msg)
843
844 def createTests(self):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000845 self.test = self.testLoader.loadTestsFromNames(self.testNames,
846 self.module)
Fred Drake02538202001-03-21 18:09:46 +0000847
848 def runTests(self):
Georg Brandld0a96252007-03-07 09:21:06 +0000849 if isinstance(self.testRunner, (type, types.ClassType)):
850 try:
851 testRunner = self.testRunner(verbosity=self.verbosity)
852 except TypeError:
853 # didn't accept the verbosity argument
854 testRunner = self.testRunner()
855 else:
856 # it is assumed to be a TestRunner instance
857 testRunner = self.testRunner
858 result = testRunner.run(self.test)
Tim Petersa19a1682001-03-29 04:36:09 +0000859 sys.exit(not result.wasSuccessful())
Fred Drake02538202001-03-21 18:09:46 +0000860
861main = TestProgram
862
863
864##############################################################################
865# Executing this module from the command line
866##############################################################################
867
868if __name__ == "__main__":
869 main(module=None)