blob: 6ede5ad59054ff120d5e99e65cc2d5926e41ad85 [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
Guido van Rossumd8faa362007-04-27 19:54:29 +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##############################################################################
Fred Drake02538202001-03-21 18:09:46 +000068# Test framework core
69##############################################################################
70
Steve Purcelldc391a62002-08-09 09:46:23 +000071def _strclass(cls):
72 return "%s.%s" % (cls.__module__, cls.__name__)
73
Steve Purcellb8d5f242003-12-06 13:03:13 +000074__unittest = 1
75
Fred Drake02538202001-03-21 18:09:46 +000076class TestResult:
77 """Holder for test result information.
78
79 Test results are automatically managed by the TestCase and TestSuite
80 classes, and do not need to be explicitly manipulated by writers of tests.
81
82 Each instance holds the total number of tests run, and collections of
83 failures and errors that occurred among those test runs. The collections
Steve Purcell7b065702001-09-06 08:24:40 +000084 contain tuples of (testcase, exceptioninfo), where exceptioninfo is the
Fred Drake656f9ec2001-09-06 19:13:14 +000085 formatted traceback of the error that occurred.
Fred Drake02538202001-03-21 18:09:46 +000086 """
87 def __init__(self):
88 self.failures = []
89 self.errors = []
90 self.testsRun = 0
Guido van Rossumd8faa362007-04-27 19:54:29 +000091 self.shouldStop = False
Fred Drake02538202001-03-21 18:09:46 +000092
93 def startTest(self, test):
94 "Called when the given test is about to be run"
95 self.testsRun = self.testsRun + 1
96
97 def stopTest(self, test):
98 "Called when the given test has been run"
99 pass
100
101 def addError(self, test, err):
Steve Purcell7b065702001-09-06 08:24:40 +0000102 """Called when an error has occurred. 'err' is a tuple of values as
103 returned by sys.exc_info().
104 """
Steve Purcellb8d5f242003-12-06 13:03:13 +0000105 self.errors.append((test, self._exc_info_to_string(err, test)))
Fred Drake02538202001-03-21 18:09:46 +0000106
107 def addFailure(self, test, err):
Steve Purcell7b065702001-09-06 08:24:40 +0000108 """Called when an error has occurred. 'err' is a tuple of values as
109 returned by sys.exc_info()."""
Steve Purcellb8d5f242003-12-06 13:03:13 +0000110 self.failures.append((test, self._exc_info_to_string(err, test)))
Fred Drake02538202001-03-21 18:09:46 +0000111
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000112 def addSuccess(self, test):
113 "Called when a test has completed successfully"
114 pass
115
Fred Drake02538202001-03-21 18:09:46 +0000116 def wasSuccessful(self):
117 "Tells whether or not this result was a success"
118 return len(self.failures) == len(self.errors) == 0
119
120 def stop(self):
121 "Indicates that the tests should be aborted"
Steve Purcell7e743842003-09-22 11:08:12 +0000122 self.shouldStop = True
Tim Petersa19a1682001-03-29 04:36:09 +0000123
Steve Purcellb8d5f242003-12-06 13:03:13 +0000124 def _exc_info_to_string(self, err, test):
Steve Purcell7b065702001-09-06 08:24:40 +0000125 """Converts a sys.exc_info()-style tuple of values into a string."""
Steve Purcellb8d5f242003-12-06 13:03:13 +0000126 exctype, value, tb = err
127 # Skip test runner traceback levels
128 while tb and self._is_relevant_tb_level(tb):
129 tb = tb.tb_next
130 if exctype is test.failureException:
131 # Skip assert*() traceback levels
132 length = self._count_relevant_tb_levels(tb)
133 return ''.join(traceback.format_exception(exctype, value, tb, length))
134 return ''.join(traceback.format_exception(exctype, value, tb))
135
136 def _is_relevant_tb_level(self, tb):
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000137 return '__unittest' in tb.tb_frame.f_globals
Steve Purcellb8d5f242003-12-06 13:03:13 +0000138
139 def _count_relevant_tb_levels(self, tb):
140 length = 0
141 while tb and not self._is_relevant_tb_level(tb):
142 length += 1
143 tb = tb.tb_next
144 return length
Steve Purcell7b065702001-09-06 08:24:40 +0000145
Fred Drake02538202001-03-21 18:09:46 +0000146 def __repr__(self):
147 return "<%s run=%i errors=%i failures=%i>" % \
Steve Purcelldc391a62002-08-09 09:46:23 +0000148 (_strclass(self.__class__), self.testsRun, len(self.errors),
Fred Drake02538202001-03-21 18:09:46 +0000149 len(self.failures))
150
Fred Drake02538202001-03-21 18:09:46 +0000151class TestCase:
152 """A class whose instances are single test cases.
153
Fred Drake02538202001-03-21 18:09:46 +0000154 By default, the test code itself should be placed in a method named
155 'runTest'.
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000156
Tim Petersa19a1682001-03-29 04:36:09 +0000157 If the fixture may be used for many test cases, create as
Fred Drake02538202001-03-21 18:09:46 +0000158 many test methods as are needed. When instantiating such a TestCase
159 subclass, specify in the constructor arguments the name of the test method
160 that the instance is to execute.
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000161
Tim Petersa19a1682001-03-29 04:36:09 +0000162 Test authors should subclass TestCase for their own tests. Construction
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000163 and deconstruction of the test's environment ('fixture') can be
164 implemented by overriding the 'setUp' and 'tearDown' methods respectively.
165
166 If it is necessary to override the __init__ method, the base class
167 __init__ method must always be called. It is important that subclasses
168 should not change the signature of their __init__ method, since instances
169 of the classes are instantiated automatically by parts of the framework
170 in order to be run.
Fred Drake02538202001-03-21 18:09:46 +0000171 """
Steve Purcell15d89272001-04-12 09:05:01 +0000172
173 # This attribute determines which exception will be raised when
174 # the instance's assertion methods fail; test methods raising this
175 # exception will be deemed to have 'failed' rather than 'errored'
176
177 failureException = AssertionError
178
Fred Drake02538202001-03-21 18:09:46 +0000179 def __init__(self, methodName='runTest'):
180 """Create an instance of the class that will use the named test
181 method when executed. Raises a ValueError if the instance does
182 not have a method with the specified name.
183 """
184 try:
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000185 self._testMethodName = methodName
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000186 testMethod = getattr(self, methodName)
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000187 self._testMethodDoc = testMethod.__doc__
Fred Drake02538202001-03-21 18:09:46 +0000188 except AttributeError:
189 raise ValueError, "no such test method in %s: %s" % \
190 (self.__class__, methodName)
191
192 def setUp(self):
193 "Hook method for setting up the test fixture before exercising it."
194 pass
195
196 def tearDown(self):
197 "Hook method for deconstructing the test fixture after testing it."
198 pass
199
200 def countTestCases(self):
201 return 1
202
203 def defaultTestResult(self):
204 return TestResult()
205
206 def shortDescription(self):
207 """Returns a one-line description of the test, or None if no
208 description has been provided.
209
210 The default implementation of this method returns the first line of
211 the specified test method's docstring.
212 """
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000213 doc = self._testMethodDoc
Steve Purcell7e743842003-09-22 11:08:12 +0000214 return doc and doc.split("\n")[0].strip() or None
Fred Drake02538202001-03-21 18:09:46 +0000215
216 def id(self):
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000217 return "%s.%s" % (_strclass(self.__class__), self._testMethodName)
Fred Drake02538202001-03-21 18:09:46 +0000218
Guido van Rossumd8faa362007-04-27 19:54:29 +0000219 def __eq__(self, other):
220 if type(self) is not type(other):
221 return False
222
223 return self._testMethodName == other._testMethodName
224
225 def __ne__(self, other):
226 return not self == other
227
228 def __hash__(self):
229 return hash((type(self), self._testMethodName))
230
Fred Drake02538202001-03-21 18:09:46 +0000231 def __str__(self):
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000232 return "%s (%s)" % (self._testMethodName, _strclass(self.__class__))
Fred Drake02538202001-03-21 18:09:46 +0000233
234 def __repr__(self):
235 return "<%s testMethod=%s>" % \
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000236 (_strclass(self.__class__), self._testMethodName)
Fred Drake02538202001-03-21 18:09:46 +0000237
238 def run(self, result=None):
Fred Drake02538202001-03-21 18:09:46 +0000239 if result is None: result = self.defaultTestResult()
240 result.startTest(self)
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000241 testMethod = getattr(self, self._testMethodName)
Fred Drake02538202001-03-21 18:09:46 +0000242 try:
243 try:
244 self.setUp()
Guido van Rossum202dd1e2001-12-07 03:39:34 +0000245 except KeyboardInterrupt:
246 raise
Fred Drake02538202001-03-21 18:09:46 +0000247 except:
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000248 result.addError(self, self._exc_info())
Fred Drake02538202001-03-21 18:09:46 +0000249 return
250
Steve Purcell7e743842003-09-22 11:08:12 +0000251 ok = False
Fred Drake02538202001-03-21 18:09:46 +0000252 try:
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000253 testMethod()
Steve Purcell7e743842003-09-22 11:08:12 +0000254 ok = True
Skip Montanaroae5c37b2003-07-13 15:18:12 +0000255 except self.failureException:
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000256 result.addFailure(self, self._exc_info())
Guido van Rossum202dd1e2001-12-07 03:39:34 +0000257 except KeyboardInterrupt:
258 raise
Fred Drake02538202001-03-21 18:09:46 +0000259 except:
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000260 result.addError(self, self._exc_info())
Fred Drake02538202001-03-21 18:09:46 +0000261
262 try:
263 self.tearDown()
Guido van Rossum202dd1e2001-12-07 03:39:34 +0000264 except KeyboardInterrupt:
265 raise
Fred Drake02538202001-03-21 18:09:46 +0000266 except:
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000267 result.addError(self, self._exc_info())
Steve Purcell7e743842003-09-22 11:08:12 +0000268 ok = False
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000269 if ok: result.addSuccess(self)
Fred Drake02538202001-03-21 18:09:46 +0000270 finally:
271 result.stopTest(self)
272
Raymond Hettinger664347b2004-12-04 21:21:53 +0000273 def __call__(self, *args, **kwds):
274 return self.run(*args, **kwds)
Steve Purcell7e743842003-09-22 11:08:12 +0000275
Fred Drake02538202001-03-21 18:09:46 +0000276 def debug(self):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000277 """Run the test without collecting errors in a TestResult"""
Fred Drake02538202001-03-21 18:09:46 +0000278 self.setUp()
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000279 getattr(self, self._testMethodName)()
Fred Drake02538202001-03-21 18:09:46 +0000280 self.tearDown()
281
Georg Brandl81cdb4e2006-01-20 17:55:00 +0000282 def _exc_info(self):
Steve Purcell15d89272001-04-12 09:05:01 +0000283 """Return a version of sys.exc_info() with the traceback frame
284 minimised; usually the top level of the traceback frame is not
285 needed.
Fred Drake02538202001-03-21 18:09:46 +0000286 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000287 return sys.exc_info()
Fred Drake02538202001-03-21 18:09:46 +0000288
Steve Purcell15d89272001-04-12 09:05:01 +0000289 def fail(self, msg=None):
290 """Fail immediately, with the given message."""
291 raise self.failureException, msg
Fred Drake02538202001-03-21 18:09:46 +0000292
293 def failIf(self, expr, msg=None):
294 "Fail the test if the expression is true."
Steve Purcell15d89272001-04-12 09:05:01 +0000295 if expr: raise self.failureException, msg
Fred Drake02538202001-03-21 18:09:46 +0000296
Steve Purcell15d89272001-04-12 09:05:01 +0000297 def failUnless(self, expr, msg=None):
298 """Fail the test unless the expression is true."""
299 if not expr: raise self.failureException, msg
300
301 def failUnlessRaises(self, excClass, callableObj, *args, **kwargs):
302 """Fail unless an exception of class excClass is thrown
Fred Drake02538202001-03-21 18:09:46 +0000303 by callableObj when invoked with arguments args and keyword
304 arguments kwargs. If a different type of exception is
305 thrown, it will not be caught, and the test case will be
306 deemed to have suffered an error, exactly as for an
307 unexpected exception.
308 """
309 try:
Guido van Rossum68468eb2003-02-27 20:14:51 +0000310 callableObj(*args, **kwargs)
Fred Drake02538202001-03-21 18:09:46 +0000311 except excClass:
312 return
313 else:
314 if hasattr(excClass,'__name__'): excName = excClass.__name__
315 else: excName = str(excClass)
Steve Purcell7e743842003-09-22 11:08:12 +0000316 raise self.failureException, "%s not raised" % excName
Fred Drake02538202001-03-21 18:09:46 +0000317
Steve Purcell15d89272001-04-12 09:05:01 +0000318 def failUnlessEqual(self, first, second, msg=None):
Raymond Hettingerc377cbf2003-04-04 22:56:42 +0000319 """Fail if the two objects are unequal as determined by the '=='
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000320 operator.
321 """
Raymond Hettingerc377cbf2003-04-04 22:56:42 +0000322 if not first == second:
Steve Purcellca9aaf32001-12-17 10:13:17 +0000323 raise self.failureException, \
Walter Dörwald70a6b492004-02-12 17:35:32 +0000324 (msg or '%r != %r' % (first, second))
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000325
Steve Purcell15d89272001-04-12 09:05:01 +0000326 def failIfEqual(self, first, second, msg=None):
327 """Fail if the two objects are equal as determined by the '=='
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000328 operator.
329 """
Steve Purcell15d89272001-04-12 09:05:01 +0000330 if first == second:
Steve Purcellca9aaf32001-12-17 10:13:17 +0000331 raise self.failureException, \
Walter Dörwald70a6b492004-02-12 17:35:32 +0000332 (msg or '%r == %r' % (first, second))
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000333
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000334 def failUnlessAlmostEqual(self, first, second, places=7, msg=None):
335 """Fail if the two objects are unequal as determined by their
336 difference rounded to the given number of decimal places
337 (default 7) and comparing to zero.
338
Steve Purcell397b45d2003-10-26 10:41:03 +0000339 Note that decimal places (from zero) are usually not the same
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000340 as significant digits (measured from the most signficant digit).
341 """
342 if round(second-first, places) != 0:
343 raise self.failureException, \
Walter Dörwald70a6b492004-02-12 17:35:32 +0000344 (msg or '%r != %r within %r places' % (first, second, places))
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000345
346 def failIfAlmostEqual(self, first, second, places=7, msg=None):
347 """Fail if the two objects are equal as determined by their
348 difference rounded to the given number of decimal places
349 (default 7) and comparing to zero.
350
Steve Purcellcca34912003-10-26 16:38:16 +0000351 Note that decimal places (from zero) are usually not the same
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000352 as significant digits (measured from the most signficant digit).
353 """
354 if round(second-first, places) == 0:
355 raise self.failureException, \
Walter Dörwald70a6b492004-02-12 17:35:32 +0000356 (msg or '%r == %r within %r places' % (first, second, places))
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000357
Steve Purcell7e743842003-09-22 11:08:12 +0000358 # Synonyms for assertion methods
359
Steve Purcell15d89272001-04-12 09:05:01 +0000360 assertEqual = assertEquals = failUnlessEqual
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000361
Steve Purcell15d89272001-04-12 09:05:01 +0000362 assertNotEqual = assertNotEquals = failIfEqual
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000363
Raymond Hettingerc7b07692002-12-29 17:59:24 +0000364 assertAlmostEqual = assertAlmostEquals = failUnlessAlmostEqual
365
366 assertNotAlmostEqual = assertNotAlmostEquals = failIfAlmostEqual
367
Steve Purcell15d89272001-04-12 09:05:01 +0000368 assertRaises = failUnlessRaises
369
Steve Purcell7e743842003-09-22 11:08:12 +0000370 assert_ = assertTrue = failUnless
371
372 assertFalse = failIf
Steve Purcell15d89272001-04-12 09:05:01 +0000373
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000374
Fred Drake02538202001-03-21 18:09:46 +0000375
376class TestSuite:
377 """A test suite is a composite test consisting of a number of TestCases.
378
379 For use, create an instance of TestSuite, then add test case instances.
380 When all tests have been added, the suite can be passed to a test
381 runner, such as TextTestRunner. It will run the individual test cases
382 in the order in which they were added, aggregating the results. When
383 subclassing, do not forget to call the base class constructor.
384 """
385 def __init__(self, tests=()):
386 self._tests = []
387 self.addTests(tests)
388
389 def __repr__(self):
Steve Purcelldc391a62002-08-09 09:46:23 +0000390 return "<%s tests=%s>" % (_strclass(self.__class__), self._tests)
Fred Drake02538202001-03-21 18:09:46 +0000391
392 __str__ = __repr__
393
Guido van Rossumd8faa362007-04-27 19:54:29 +0000394 def __eq__(self, other):
395 if type(self) is not type(other):
396 return False
397 return self._tests == other._tests
398
399 def __ne__(self, other):
400 return not self == other
401
Jim Fultonfafd8742004-08-28 15:22:12 +0000402 def __iter__(self):
403 return iter(self._tests)
404
Fred Drake02538202001-03-21 18:09:46 +0000405 def countTestCases(self):
406 cases = 0
407 for test in self._tests:
Steve Purcell7e743842003-09-22 11:08:12 +0000408 cases += test.countTestCases()
Fred Drake02538202001-03-21 18:09:46 +0000409 return cases
410
411 def addTest(self, test):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000412 # sanity checks
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000413 if not hasattr(test, '__call__'):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000414 raise TypeError("the test to add must be callable")
415 if (isinstance(test, (type, types.ClassType)) and
416 issubclass(test, (TestCase, TestSuite))):
417 raise TypeError("TestCases and TestSuites must be instantiated "
418 "before passing them to addTest()")
Fred Drake02538202001-03-21 18:09:46 +0000419 self._tests.append(test)
420
421 def addTests(self, tests):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000422 if isinstance(tests, basestring):
423 raise TypeError("tests must be an iterable of tests, not a string")
Fred Drake02538202001-03-21 18:09:46 +0000424 for test in tests:
425 self.addTest(test)
426
427 def run(self, result):
Fred Drake02538202001-03-21 18:09:46 +0000428 for test in self._tests:
429 if result.shouldStop:
430 break
431 test(result)
432 return result
433
Raymond Hettinger664347b2004-12-04 21:21:53 +0000434 def __call__(self, *args, **kwds):
435 return self.run(*args, **kwds)
436
Fred Drake02538202001-03-21 18:09:46 +0000437 def debug(self):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000438 """Run the tests without collecting errors in a TestResult"""
Fred Drake02538202001-03-21 18:09:46 +0000439 for test in self._tests: test.debug()
Fred Drake02538202001-03-21 18:09:46 +0000440
441
442class FunctionTestCase(TestCase):
443 """A test case that wraps a test function.
444
445 This is useful for slipping pre-existing test functions into the
Guido van Rossumd8faa362007-04-27 19:54:29 +0000446 unittest framework. Optionally, set-up and tidy-up functions can be
Fred Drake02538202001-03-21 18:09:46 +0000447 supplied. As with TestCase, the tidy-up ('tearDown') function will
448 always be called if the set-up ('setUp') function ran successfully.
449 """
450
451 def __init__(self, testFunc, setUp=None, tearDown=None,
452 description=None):
453 TestCase.__init__(self)
454 self.__setUpFunc = setUp
455 self.__tearDownFunc = tearDown
456 self.__testFunc = testFunc
457 self.__description = description
458
459 def setUp(self):
460 if self.__setUpFunc is not None:
461 self.__setUpFunc()
462
463 def tearDown(self):
464 if self.__tearDownFunc is not None:
465 self.__tearDownFunc()
466
467 def runTest(self):
468 self.__testFunc()
469
470 def id(self):
471 return self.__testFunc.__name__
472
Guido van Rossumd8faa362007-04-27 19:54:29 +0000473 def __eq__(self, other):
474 if type(self) is not type(other):
475 return False
476
477 return self.__setUpFunc == other.__setUpFunc and \
478 self.__tearDownFunc == other.__tearDownFunc and \
479 self.__testFunc == other.__testFunc and \
480 self.__description == other.__description
481
482 def __ne__(self, other):
483 return not self == other
484
485 def __hash__(self):
486 return hash((type(self), self.__setUpFunc, self.__tearDownFunc,
487 self.__testFunc, self.__description))
488
Fred Drake02538202001-03-21 18:09:46 +0000489 def __str__(self):
Steve Purcelldc391a62002-08-09 09:46:23 +0000490 return "%s (%s)" % (_strclass(self.__class__), self.__testFunc.__name__)
Fred Drake02538202001-03-21 18:09:46 +0000491
492 def __repr__(self):
Steve Purcelldc391a62002-08-09 09:46:23 +0000493 return "<%s testFunc=%s>" % (_strclass(self.__class__), self.__testFunc)
Fred Drake02538202001-03-21 18:09:46 +0000494
495 def shortDescription(self):
496 if self.__description is not None: return self.__description
497 doc = self.__testFunc.__doc__
Steve Purcell7e743842003-09-22 11:08:12 +0000498 return doc and doc.split("\n")[0].strip() or None
Fred Drake02538202001-03-21 18:09:46 +0000499
500
501
502##############################################################################
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000503# Locating and loading tests
Fred Drake02538202001-03-21 18:09:46 +0000504##############################################################################
505
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000506class TestLoader:
507 """This class is responsible for loading tests according to various
Guido van Rossumd8faa362007-04-27 19:54:29 +0000508 criteria and returning them wrapped in a TestSuite
Fred Drake02538202001-03-21 18:09:46 +0000509 """
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000510 testMethodPrefix = 'test'
511 sortTestMethodsUsing = cmp
512 suiteClass = TestSuite
Fred Drake02538202001-03-21 18:09:46 +0000513
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000514 def loadTestsFromTestCase(self, testCaseClass):
Steve Purcell15d89272001-04-12 09:05:01 +0000515 """Return a suite of all tests cases contained in testCaseClass"""
Johannes Gijsbersd7b6ad42004-11-07 15:46:25 +0000516 if issubclass(testCaseClass, TestSuite):
517 raise TypeError("Test cases should not be derived from TestSuite. Maybe you meant to derive from TestCase?")
Steve Purcell7e743842003-09-22 11:08:12 +0000518 testCaseNames = self.getTestCaseNames(testCaseClass)
519 if not testCaseNames and hasattr(testCaseClass, 'runTest'):
520 testCaseNames = ['runTest']
521 return self.suiteClass(map(testCaseClass, testCaseNames))
Fred Drake02538202001-03-21 18:09:46 +0000522
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000523 def loadTestsFromModule(self, module):
Steve Purcell15d89272001-04-12 09:05:01 +0000524 """Return a suite of all tests cases contained in the given module"""
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000525 tests = []
526 for name in dir(module):
527 obj = getattr(module, name)
Guido van Rossum67911372002-09-30 19:25:56 +0000528 if (isinstance(obj, (type, types.ClassType)) and
529 issubclass(obj, TestCase)):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000530 tests.append(self.loadTestsFromTestCase(obj))
531 return self.suiteClass(tests)
Fred Drake02538202001-03-21 18:09:46 +0000532
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000533 def loadTestsFromName(self, name, module=None):
Steve Purcell15d89272001-04-12 09:05:01 +0000534 """Return a suite of all tests cases given a string specifier.
535
536 The name may resolve either to a module, a test case class, a
537 test method within a test case class, or a callable object which
538 returns a TestCase or TestSuite instance.
Tim Peters613b2222001-04-13 05:37:27 +0000539
Steve Purcell15d89272001-04-12 09:05:01 +0000540 The method optionally resolves the names relative to a given module.
541 """
Steve Purcell7e743842003-09-22 11:08:12 +0000542 parts = name.split('.')
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000543 if module is None:
Steve Purcell7e743842003-09-22 11:08:12 +0000544 parts_copy = parts[:]
545 while parts_copy:
546 try:
547 module = __import__('.'.join(parts_copy))
548 break
549 except ImportError:
550 del parts_copy[-1]
551 if not parts_copy: raise
Armin Rigo1b3c04b2003-10-24 17:15:29 +0000552 parts = parts[1:]
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000553 obj = module
554 for part in parts:
Steve Purcell7e743842003-09-22 11:08:12 +0000555 parent, obj = obj, getattr(obj, part)
Fred Drake02538202001-03-21 18:09:46 +0000556
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000557 if type(obj) == types.ModuleType:
558 return self.loadTestsFromModule(obj)
Guido van Rossum67911372002-09-30 19:25:56 +0000559 elif (isinstance(obj, (type, types.ClassType)) and
Steve Purcell397b45d2003-10-26 10:41:03 +0000560 issubclass(obj, TestCase)):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000561 return self.loadTestsFromTestCase(obj)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000562 elif (type(obj) == types.UnboundMethodType and
563 isinstance(parent, (type, types.ClassType)) and
564 issubclass(parent, TestCase)):
565 return TestSuite([parent(obj.__name__)])
Steve Purcell397b45d2003-10-26 10:41:03 +0000566 elif isinstance(obj, TestSuite):
Steve Purcell7e743842003-09-22 11:08:12 +0000567 return obj
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000568 elif hasattr(obj, '__call__'):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000569 test = obj()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000570 if isinstance(test, TestSuite):
571 return test
572 elif isinstance(test, TestCase):
573 return TestSuite([test])
574 else:
575 raise TypeError("calling %s returned %s, not a test" %
576 (obj, test))
Fred Drake02538202001-03-21 18:09:46 +0000577 else:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000578 raise TypeError("don't know how to make test from: %s" % obj)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000579
580 def loadTestsFromNames(self, names, module=None):
Steve Purcell15d89272001-04-12 09:05:01 +0000581 """Return a suite of all tests cases found using the given sequence
582 of string specifiers. See 'loadTestsFromName()'.
583 """
Steve Purcell7e743842003-09-22 11:08:12 +0000584 suites = [self.loadTestsFromName(name, module) for name in names]
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000585 return self.suiteClass(suites)
586
587 def getTestCaseNames(self, testCaseClass):
Steve Purcell15d89272001-04-12 09:05:01 +0000588 """Return a sorted sequence of method names found within testCaseClass
589 """
Steve Purcell7e743842003-09-22 11:08:12 +0000590 def isTestMethod(attrname, testCaseClass=testCaseClass, prefix=self.testMethodPrefix):
Guido van Rossumd59da4b2007-05-22 18:11:13 +0000591 return attrname.startswith(prefix) and hasattr(getattr(testCaseClass, attrname), '__call__')
Steve Purcell7e743842003-09-22 11:08:12 +0000592 testFnNames = filter(isTestMethod, dir(testCaseClass))
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000593 if self.sortTestMethodsUsing:
594 testFnNames.sort(self.sortTestMethodsUsing)
595 return testFnNames
596
597
598
599defaultTestLoader = TestLoader()
600
601
602##############################################################################
603# Patches for old functions: these functions should be considered obsolete
604##############################################################################
605
606def _makeLoader(prefix, sortUsing, suiteClass=None):
607 loader = TestLoader()
608 loader.sortTestMethodsUsing = sortUsing
609 loader.testMethodPrefix = prefix
610 if suiteClass: loader.suiteClass = suiteClass
611 return loader
612
613def getTestCaseNames(testCaseClass, prefix, sortUsing=cmp):
614 return _makeLoader(prefix, sortUsing).getTestCaseNames(testCaseClass)
615
616def makeSuite(testCaseClass, prefix='test', sortUsing=cmp, suiteClass=TestSuite):
617 return _makeLoader(prefix, sortUsing, suiteClass).loadTestsFromTestCase(testCaseClass)
618
619def findTestCases(module, prefix='test', sortUsing=cmp, suiteClass=TestSuite):
620 return _makeLoader(prefix, sortUsing, suiteClass).loadTestsFromModule(module)
Fred Drake02538202001-03-21 18:09:46 +0000621
622
623##############################################################################
624# Text UI
625##############################################################################
626
627class _WritelnDecorator:
628 """Used to decorate file-like objects with a handy 'writeln' method"""
629 def __init__(self,stream):
630 self.stream = stream
Fred Drake02538202001-03-21 18:09:46 +0000631
632 def __getattr__(self, attr):
633 return getattr(self.stream,attr)
634
Raymond Hettinger91dd19d2003-09-13 02:58:00 +0000635 def writeln(self, arg=None):
636 if arg: self.write(arg)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000637 self.write('\n') # text-mode streams translate to \r\n if needed
Tim Petersa19a1682001-03-29 04:36:09 +0000638
Fred Drake02538202001-03-21 18:09:46 +0000639
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000640class _TextTestResult(TestResult):
Fred Drake02538202001-03-21 18:09:46 +0000641 """A test result class that can print formatted text results to a stream.
642
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000643 Used by TextTestRunner.
Fred Drake02538202001-03-21 18:09:46 +0000644 """
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000645 separator1 = '=' * 70
646 separator2 = '-' * 70
Fred Drake02538202001-03-21 18:09:46 +0000647
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000648 def __init__(self, stream, descriptions, verbosity):
Fred Drake02538202001-03-21 18:09:46 +0000649 TestResult.__init__(self)
650 self.stream = stream
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000651 self.showAll = verbosity > 1
652 self.dots = verbosity == 1
Fred Drake02538202001-03-21 18:09:46 +0000653 self.descriptions = descriptions
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000654
655 def getDescription(self, test):
656 if self.descriptions:
657 return test.shortDescription() or str(test)
658 else:
659 return str(test)
660
Fred Drake02538202001-03-21 18:09:46 +0000661 def startTest(self, test):
662 TestResult.startTest(self, test)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000663 if self.showAll:
664 self.stream.write(self.getDescription(test))
665 self.stream.write(" ... ")
Fred Drake02538202001-03-21 18:09:46 +0000666
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000667 def addSuccess(self, test):
668 TestResult.addSuccess(self, test)
669 if self.showAll:
Fred Drake02538202001-03-21 18:09:46 +0000670 self.stream.writeln("ok")
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000671 elif self.dots:
672 self.stream.write('.')
Fred Drake02538202001-03-21 18:09:46 +0000673
674 def addError(self, test, err):
675 TestResult.addError(self, test, err)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000676 if self.showAll:
677 self.stream.writeln("ERROR")
678 elif self.dots:
679 self.stream.write('E')
Fred Drake02538202001-03-21 18:09:46 +0000680
681 def addFailure(self, test, err):
682 TestResult.addFailure(self, test, err)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000683 if self.showAll:
684 self.stream.writeln("FAIL")
685 elif self.dots:
686 self.stream.write('F')
Fred Drake02538202001-03-21 18:09:46 +0000687
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000688 def printErrors(self):
689 if self.dots or self.showAll:
Fred Drake02538202001-03-21 18:09:46 +0000690 self.stream.writeln()
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000691 self.printErrorList('ERROR', self.errors)
692 self.printErrorList('FAIL', self.failures)
693
694 def printErrorList(self, flavour, errors):
695 for test, err in errors:
696 self.stream.writeln(self.separator1)
697 self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
698 self.stream.writeln(self.separator2)
Steve Purcell7b065702001-09-06 08:24:40 +0000699 self.stream.writeln("%s" % err)
Fred Drake02538202001-03-21 18:09:46 +0000700
701
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000702class TextTestRunner:
Fred Drake02538202001-03-21 18:09:46 +0000703 """A test runner class that displays results in textual form.
Tim Petersa19a1682001-03-29 04:36:09 +0000704
Fred Drake02538202001-03-21 18:09:46 +0000705 It prints out the names of tests as they are run, errors as they
706 occur, and a summary of the results at the end of the test run.
707 """
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000708 def __init__(self, stream=sys.stderr, descriptions=1, verbosity=1):
Fred Drake02538202001-03-21 18:09:46 +0000709 self.stream = _WritelnDecorator(stream)
710 self.descriptions = descriptions
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000711 self.verbosity = verbosity
712
713 def _makeResult(self):
714 return _TextTestResult(self.stream, self.descriptions, self.verbosity)
Fred Drake02538202001-03-21 18:09:46 +0000715
716 def run(self, test):
717 "Run the given test case or test suite."
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000718 result = self._makeResult()
Fred Drake02538202001-03-21 18:09:46 +0000719 startTime = time.time()
720 test(result)
721 stopTime = time.time()
Steve Purcell397b45d2003-10-26 10:41:03 +0000722 timeTaken = stopTime - startTime
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000723 result.printErrors()
724 self.stream.writeln(result.separator2)
Fred Drake02538202001-03-21 18:09:46 +0000725 run = result.testsRun
726 self.stream.writeln("Ran %d test%s in %.3fs" %
Neal Norwitz76165042002-05-31 14:15:11 +0000727 (run, run != 1 and "s" or "", timeTaken))
Fred Drake02538202001-03-21 18:09:46 +0000728 self.stream.writeln()
729 if not result.wasSuccessful():
730 self.stream.write("FAILED (")
731 failed, errored = map(len, (result.failures, result.errors))
732 if failed:
733 self.stream.write("failures=%d" % failed)
734 if errored:
735 if failed: self.stream.write(", ")
736 self.stream.write("errors=%d" % errored)
737 self.stream.writeln(")")
738 else:
739 self.stream.writeln("OK")
740 return result
Tim Petersa19a1682001-03-29 04:36:09 +0000741
Fred Drake02538202001-03-21 18:09:46 +0000742
Fred Drake02538202001-03-21 18:09:46 +0000743
744##############################################################################
745# Facilities for running tests from the command line
746##############################################################################
747
748class TestProgram:
749 """A command-line program that runs a set of tests; this is primarily
750 for making test modules conveniently executable.
751 """
752 USAGE = """\
Steve Purcell17a781b2001-04-09 15:37:31 +0000753Usage: %(progName)s [options] [test] [...]
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000754
755Options:
756 -h, --help Show this message
757 -v, --verbose Verbose output
758 -q, --quiet Minimal output
Fred Drake02538202001-03-21 18:09:46 +0000759
760Examples:
761 %(progName)s - run default set of tests
762 %(progName)s MyTestSuite - run suite 'MyTestSuite'
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000763 %(progName)s MyTestCase.testSomething - run MyTestCase.testSomething
764 %(progName)s MyTestCase - run all 'test*' test methods
Fred Drake02538202001-03-21 18:09:46 +0000765 in MyTestCase
766"""
767 def __init__(self, module='__main__', defaultTest=None,
Guido van Rossumd8faa362007-04-27 19:54:29 +0000768 argv=None, testRunner=TextTestRunner,
769 testLoader=defaultTestLoader):
Fred Drake02538202001-03-21 18:09:46 +0000770 if type(module) == type(''):
771 self.module = __import__(module)
Steve Purcell7e743842003-09-22 11:08:12 +0000772 for part in module.split('.')[1:]:
Fred Drake02538202001-03-21 18:09:46 +0000773 self.module = getattr(self.module, part)
774 else:
775 self.module = module
776 if argv is None:
777 argv = sys.argv
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000778 self.verbosity = 1
Fred Drake02538202001-03-21 18:09:46 +0000779 self.defaultTest = defaultTest
780 self.testRunner = testRunner
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000781 self.testLoader = testLoader
Fred Drake02538202001-03-21 18:09:46 +0000782 self.progName = os.path.basename(argv[0])
783 self.parseArgs(argv)
Fred Drake02538202001-03-21 18:09:46 +0000784 self.runTests()
785
786 def usageExit(self, msg=None):
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000787 if msg: print(msg)
788 print(self.USAGE % self.__dict__)
Fred Drake02538202001-03-21 18:09:46 +0000789 sys.exit(2)
790
791 def parseArgs(self, argv):
792 import getopt
793 try:
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000794 options, args = getopt.getopt(argv[1:], 'hHvq',
795 ['help','verbose','quiet'])
Fred Drake02538202001-03-21 18:09:46 +0000796 for opt, value in options:
797 if opt in ('-h','-H','--help'):
798 self.usageExit()
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000799 if opt in ('-q','--quiet'):
800 self.verbosity = 0
801 if opt in ('-v','--verbose'):
802 self.verbosity = 2
Fred Drake02538202001-03-21 18:09:46 +0000803 if len(args) == 0 and self.defaultTest is None:
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000804 self.test = self.testLoader.loadTestsFromModule(self.module)
805 return
Fred Drake02538202001-03-21 18:09:46 +0000806 if len(args) > 0:
807 self.testNames = args
808 else:
809 self.testNames = (self.defaultTest,)
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000810 self.createTests()
Guido van Rossumb940e112007-01-10 16:19:56 +0000811 except getopt.error as msg:
Fred Drake02538202001-03-21 18:09:46 +0000812 self.usageExit(msg)
813
814 def createTests(self):
Steve Purcell5ddd1a82001-03-22 08:45:36 +0000815 self.test = self.testLoader.loadTestsFromNames(self.testNames,
816 self.module)
Fred Drake02538202001-03-21 18:09:46 +0000817
818 def runTests(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000819 if isinstance(self.testRunner, (type, types.ClassType)):
820 try:
821 testRunner = self.testRunner(verbosity=self.verbosity)
822 except TypeError:
823 # didn't accept the verbosity argument
824 testRunner = self.testRunner()
825 else:
826 # it is assumed to be a TestRunner instance
827 testRunner = self.testRunner
828 result = testRunner.run(self.test)
Tim Petersa19a1682001-03-29 04:36:09 +0000829 sys.exit(not result.wasSuccessful())
Fred Drake02538202001-03-21 18:09:46 +0000830
831main = TestProgram
832
833
834##############################################################################
835# Executing this module from the command line
836##############################################################################
837
838if __name__ == "__main__":
839 main(module=None)