Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 1 | #!/usr/bin/env python |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 2 | ''' |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 3 | Python unit testing framework, based on Erich Gamma's JUnit and Kent Beck's |
| 4 | Smalltalk testing framework. |
| 5 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 6 | This module contains the core framework classes that form the basis of |
| 7 | specific test cases and suites (TestCase, TestSuite etc.), and also a |
| 8 | text-based utility class for running the tests and reporting the results |
Jeremy Hylton | efef5da | 2001-10-22 18:14:15 +0000 | [diff] [blame] | 9 | (TextTestRunner). |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 10 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 11 | Simple 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 Purcell | 7b06570 | 2001-09-06 08:24:40 +0000 | [diff] [blame] | 19 | def testMultiply(self): |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 20 | self.assertEquals((0 * 10), 0) |
| 21 | self.assertEquals((5 * 8), 40) |
| 22 | |
| 23 | if __name__ == '__main__': |
| 24 | unittest.main() |
| 25 | |
| 26 | Further information is available in the bundled documentation, and from |
| 27 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 28 | http://docs.python.org/lib/module-unittest.html |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 29 | |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 30 | Copyright (c) 1999-2003 Steve Purcell |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 31 | This module is free software, and you may redistribute it and/or modify |
| 32 | it under the same terms as Python itself, so long as this copyright message |
| 33 | and disclaimer are retained in their original form. |
| 34 | |
| 35 | IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, |
| 36 | SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF |
| 37 | THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH |
| 38 | DAMAGE. |
| 39 | |
| 40 | THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT |
| 41 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A |
| 42 | PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, |
| 43 | AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, |
| 44 | SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 45 | ''' |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 46 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 47 | __author__ = "Steve Purcell" |
| 48 | __email__ = "stephen_purcell at yahoo dot com" |
Steve Purcell | b8d5f24 | 2003-12-06 13:03:13 +0000 | [diff] [blame] | 49 | __version__ = "#Revision: 1.63 $"[11:-2] |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 50 | |
| 51 | import time |
| 52 | import sys |
| 53 | import traceback |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 54 | import os |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 55 | import types |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 56 | |
| 57 | ############################################################################## |
Steve Purcell | d75e7e4 | 2003-09-15 11:01:21 +0000 | [diff] [blame] | 58 | # Exported classes and functions |
| 59 | ############################################################################## |
| 60 | __all__ = ['TestResult', 'TestCase', 'TestSuite', 'TextTestRunner', |
| 61 | 'TestLoader', 'FunctionTestCase', 'main', 'defaultTestLoader'] |
| 62 | |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 63 | # Expose obsolete functions for backwards compatibility |
Steve Purcell | d75e7e4 | 2003-09-15 11:01:21 +0000 | [diff] [blame] | 64 | __all__.extend(['getTestCaseNames', 'makeSuite', 'findTestCases']) |
| 65 | |
| 66 | |
| 67 | ############################################################################## |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 68 | # Test framework core |
| 69 | ############################################################################## |
| 70 | |
Steve Purcell | dc391a6 | 2002-08-09 09:46:23 +0000 | [diff] [blame] | 71 | def _strclass(cls): |
| 72 | return "%s.%s" % (cls.__module__, cls.__name__) |
| 73 | |
Steve Purcell | b8d5f24 | 2003-12-06 13:03:13 +0000 | [diff] [blame] | 74 | __unittest = 1 |
| 75 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 76 | class 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 Purcell | 7b06570 | 2001-09-06 08:24:40 +0000 | [diff] [blame] | 84 | contain tuples of (testcase, exceptioninfo), where exceptioninfo is the |
Fred Drake | 656f9ec | 2001-09-06 19:13:14 +0000 | [diff] [blame] | 85 | formatted traceback of the error that occurred. |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 86 | """ |
| 87 | def __init__(self): |
| 88 | self.failures = [] |
| 89 | self.errors = [] |
| 90 | self.testsRun = 0 |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 91 | self.shouldStop = False |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 92 | |
| 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 Purcell | 7b06570 | 2001-09-06 08:24:40 +0000 | [diff] [blame] | 102 | """Called when an error has occurred. 'err' is a tuple of values as |
| 103 | returned by sys.exc_info(). |
| 104 | """ |
Steve Purcell | b8d5f24 | 2003-12-06 13:03:13 +0000 | [diff] [blame] | 105 | self.errors.append((test, self._exc_info_to_string(err, test))) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 106 | |
| 107 | def addFailure(self, test, err): |
Steve Purcell | 7b06570 | 2001-09-06 08:24:40 +0000 | [diff] [blame] | 108 | """Called when an error has occurred. 'err' is a tuple of values as |
| 109 | returned by sys.exc_info().""" |
Steve Purcell | b8d5f24 | 2003-12-06 13:03:13 +0000 | [diff] [blame] | 110 | self.failures.append((test, self._exc_info_to_string(err, test))) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 111 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 112 | def addSuccess(self, test): |
| 113 | "Called when a test has completed successfully" |
| 114 | pass |
| 115 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 116 | 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 Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 122 | self.shouldStop = True |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 123 | |
Steve Purcell | b8d5f24 | 2003-12-06 13:03:13 +0000 | [diff] [blame] | 124 | def _exc_info_to_string(self, err, test): |
Steve Purcell | 7b06570 | 2001-09-06 08:24:40 +0000 | [diff] [blame] | 125 | """Converts a sys.exc_info()-style tuple of values into a string.""" |
Steve Purcell | b8d5f24 | 2003-12-06 13:03:13 +0000 | [diff] [blame] | 126 | 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 Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 137 | return '__unittest' in tb.tb_frame.f_globals |
Steve Purcell | b8d5f24 | 2003-12-06 13:03:13 +0000 | [diff] [blame] | 138 | |
| 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 Purcell | 7b06570 | 2001-09-06 08:24:40 +0000 | [diff] [blame] | 145 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 146 | def __repr__(self): |
| 147 | return "<%s run=%i errors=%i failures=%i>" % \ |
Steve Purcell | dc391a6 | 2002-08-09 09:46:23 +0000 | [diff] [blame] | 148 | (_strclass(self.__class__), self.testsRun, len(self.errors), |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 149 | len(self.failures)) |
| 150 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 151 | class TestCase: |
| 152 | """A class whose instances are single test cases. |
| 153 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 154 | By default, the test code itself should be placed in a method named |
| 155 | 'runTest'. |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 156 | |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 157 | If the fixture may be used for many test cases, create as |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 158 | 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 Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 161 | |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 162 | Test authors should subclass TestCase for their own tests. Construction |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 163 | 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 Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 171 | """ |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 172 | |
| 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 Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 179 | 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 Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 185 | self._testMethodName = methodName |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 186 | testMethod = getattr(self, methodName) |
Georg Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 187 | self._testMethodDoc = testMethod.__doc__ |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 188 | 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 Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 213 | doc = self._testMethodDoc |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 214 | return doc and doc.split("\n")[0].strip() or None |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 215 | |
| 216 | def id(self): |
Georg Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 217 | return "%s.%s" % (_strclass(self.__class__), self._testMethodName) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 218 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 219 | 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 Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 231 | def __str__(self): |
Georg Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 232 | return "%s (%s)" % (self._testMethodName, _strclass(self.__class__)) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 233 | |
| 234 | def __repr__(self): |
| 235 | return "<%s testMethod=%s>" % \ |
Georg Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 236 | (_strclass(self.__class__), self._testMethodName) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 237 | |
| 238 | def run(self, result=None): |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 239 | if result is None: result = self.defaultTestResult() |
| 240 | result.startTest(self) |
Georg Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 241 | testMethod = getattr(self, self._testMethodName) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 242 | try: |
| 243 | try: |
| 244 | self.setUp() |
Guido van Rossum | 202dd1e | 2001-12-07 03:39:34 +0000 | [diff] [blame] | 245 | except KeyboardInterrupt: |
| 246 | raise |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 247 | except: |
Georg Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 248 | result.addError(self, self._exc_info()) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 249 | return |
| 250 | |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 251 | ok = False |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 252 | try: |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 253 | testMethod() |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 254 | ok = True |
Skip Montanaro | ae5c37b | 2003-07-13 15:18:12 +0000 | [diff] [blame] | 255 | except self.failureException: |
Georg Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 256 | result.addFailure(self, self._exc_info()) |
Guido van Rossum | 202dd1e | 2001-12-07 03:39:34 +0000 | [diff] [blame] | 257 | except KeyboardInterrupt: |
| 258 | raise |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 259 | except: |
Georg Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 260 | result.addError(self, self._exc_info()) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 261 | |
| 262 | try: |
| 263 | self.tearDown() |
Guido van Rossum | 202dd1e | 2001-12-07 03:39:34 +0000 | [diff] [blame] | 264 | except KeyboardInterrupt: |
| 265 | raise |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 266 | except: |
Georg Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 267 | result.addError(self, self._exc_info()) |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 268 | ok = False |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 269 | if ok: result.addSuccess(self) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 270 | finally: |
| 271 | result.stopTest(self) |
| 272 | |
Raymond Hettinger | 664347b | 2004-12-04 21:21:53 +0000 | [diff] [blame] | 273 | def __call__(self, *args, **kwds): |
| 274 | return self.run(*args, **kwds) |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 275 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 276 | def debug(self): |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 277 | """Run the test without collecting errors in a TestResult""" |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 278 | self.setUp() |
Georg Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 279 | getattr(self, self._testMethodName)() |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 280 | self.tearDown() |
| 281 | |
Georg Brandl | 81cdb4e | 2006-01-20 17:55:00 +0000 | [diff] [blame] | 282 | def _exc_info(self): |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 283 | """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 Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 286 | """ |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 287 | return sys.exc_info() |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 288 | |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 289 | def fail(self, msg=None): |
| 290 | """Fail immediately, with the given message.""" |
| 291 | raise self.failureException, msg |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 292 | |
| 293 | def failIf(self, expr, msg=None): |
| 294 | "Fail the test if the expression is true." |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 295 | if expr: raise self.failureException, msg |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 296 | |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 297 | 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 Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 303 | 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 Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 310 | callableObj(*args, **kwargs) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 311 | except excClass: |
| 312 | return |
| 313 | else: |
Guido van Rossum | 2b6a97e | 2007-07-10 09:10:40 +0000 | [diff] [blame^] | 314 | excName = str(getattr(excClass, '__name__', excClass)) |
| 315 | objName = str(getattr(callableObj, '__name__', callableObj)) |
| 316 | raise self.failureException, "%s not raised by %s" % (excName, |
| 317 | objName) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 318 | |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 319 | def failUnlessEqual(self, first, second, msg=None): |
Raymond Hettinger | c377cbf | 2003-04-04 22:56:42 +0000 | [diff] [blame] | 320 | """Fail if the two objects are unequal as determined by the '==' |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 321 | operator. |
| 322 | """ |
Raymond Hettinger | c377cbf | 2003-04-04 22:56:42 +0000 | [diff] [blame] | 323 | if not first == second: |
Steve Purcell | ca9aaf3 | 2001-12-17 10:13:17 +0000 | [diff] [blame] | 324 | raise self.failureException, \ |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 325 | (msg or '%r != %r' % (first, second)) |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 326 | |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 327 | def failIfEqual(self, first, second, msg=None): |
| 328 | """Fail if the two objects are equal as determined by the '==' |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 329 | operator. |
| 330 | """ |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 331 | if first == second: |
Steve Purcell | ca9aaf3 | 2001-12-17 10:13:17 +0000 | [diff] [blame] | 332 | raise self.failureException, \ |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 333 | (msg or '%r == %r' % (first, second)) |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 334 | |
Raymond Hettinger | c7b0769 | 2002-12-29 17:59:24 +0000 | [diff] [blame] | 335 | def failUnlessAlmostEqual(self, first, second, places=7, msg=None): |
| 336 | """Fail if the two objects are unequal as determined by their |
| 337 | difference rounded to the given number of decimal places |
| 338 | (default 7) and comparing to zero. |
| 339 | |
Steve Purcell | 397b45d | 2003-10-26 10:41:03 +0000 | [diff] [blame] | 340 | Note that decimal places (from zero) are usually not the same |
Raymond Hettinger | c7b0769 | 2002-12-29 17:59:24 +0000 | [diff] [blame] | 341 | as significant digits (measured from the most signficant digit). |
| 342 | """ |
| 343 | if round(second-first, places) != 0: |
| 344 | raise self.failureException, \ |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 345 | (msg or '%r != %r within %r places' % (first, second, places)) |
Raymond Hettinger | c7b0769 | 2002-12-29 17:59:24 +0000 | [diff] [blame] | 346 | |
| 347 | def failIfAlmostEqual(self, first, second, places=7, msg=None): |
| 348 | """Fail if the two objects are equal as determined by their |
| 349 | difference rounded to the given number of decimal places |
| 350 | (default 7) and comparing to zero. |
| 351 | |
Steve Purcell | cca3491 | 2003-10-26 16:38:16 +0000 | [diff] [blame] | 352 | Note that decimal places (from zero) are usually not the same |
Raymond Hettinger | c7b0769 | 2002-12-29 17:59:24 +0000 | [diff] [blame] | 353 | as significant digits (measured from the most signficant digit). |
| 354 | """ |
| 355 | if round(second-first, places) == 0: |
| 356 | raise self.failureException, \ |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 357 | (msg or '%r == %r within %r places' % (first, second, places)) |
Raymond Hettinger | c7b0769 | 2002-12-29 17:59:24 +0000 | [diff] [blame] | 358 | |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 359 | # Synonyms for assertion methods |
| 360 | |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 361 | assertEqual = assertEquals = failUnlessEqual |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 362 | |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 363 | assertNotEqual = assertNotEquals = failIfEqual |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 364 | |
Raymond Hettinger | c7b0769 | 2002-12-29 17:59:24 +0000 | [diff] [blame] | 365 | assertAlmostEqual = assertAlmostEquals = failUnlessAlmostEqual |
| 366 | |
| 367 | assertNotAlmostEqual = assertNotAlmostEquals = failIfAlmostEqual |
| 368 | |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 369 | assertRaises = failUnlessRaises |
| 370 | |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 371 | assert_ = assertTrue = failUnless |
| 372 | |
| 373 | assertFalse = failIf |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 374 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 375 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 376 | |
| 377 | class TestSuite: |
| 378 | """A test suite is a composite test consisting of a number of TestCases. |
| 379 | |
| 380 | For use, create an instance of TestSuite, then add test case instances. |
| 381 | When all tests have been added, the suite can be passed to a test |
| 382 | runner, such as TextTestRunner. It will run the individual test cases |
| 383 | in the order in which they were added, aggregating the results. When |
| 384 | subclassing, do not forget to call the base class constructor. |
| 385 | """ |
| 386 | def __init__(self, tests=()): |
| 387 | self._tests = [] |
| 388 | self.addTests(tests) |
| 389 | |
| 390 | def __repr__(self): |
Steve Purcell | dc391a6 | 2002-08-09 09:46:23 +0000 | [diff] [blame] | 391 | return "<%s tests=%s>" % (_strclass(self.__class__), self._tests) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 392 | |
| 393 | __str__ = __repr__ |
| 394 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 395 | def __eq__(self, other): |
| 396 | if type(self) is not type(other): |
| 397 | return False |
| 398 | return self._tests == other._tests |
| 399 | |
| 400 | def __ne__(self, other): |
| 401 | return not self == other |
| 402 | |
Jim Fulton | fafd874 | 2004-08-28 15:22:12 +0000 | [diff] [blame] | 403 | def __iter__(self): |
| 404 | return iter(self._tests) |
| 405 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 406 | def countTestCases(self): |
| 407 | cases = 0 |
| 408 | for test in self._tests: |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 409 | cases += test.countTestCases() |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 410 | return cases |
| 411 | |
| 412 | def addTest(self, test): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 413 | # sanity checks |
Guido van Rossum | d59da4b | 2007-05-22 18:11:13 +0000 | [diff] [blame] | 414 | if not hasattr(test, '__call__'): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 415 | raise TypeError("the test to add must be callable") |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 416 | if isinstance(test, type) and issubclass(test, (TestCase, TestSuite)): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 417 | raise TypeError("TestCases and TestSuites must be instantiated " |
| 418 | "before passing them to addTest()") |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 419 | self._tests.append(test) |
| 420 | |
| 421 | def addTests(self, tests): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 422 | if isinstance(tests, basestring): |
| 423 | raise TypeError("tests must be an iterable of tests, not a string") |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 424 | for test in tests: |
| 425 | self.addTest(test) |
| 426 | |
| 427 | def run(self, result): |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 428 | for test in self._tests: |
| 429 | if result.shouldStop: |
| 430 | break |
| 431 | test(result) |
| 432 | return result |
| 433 | |
Raymond Hettinger | 664347b | 2004-12-04 21:21:53 +0000 | [diff] [blame] | 434 | def __call__(self, *args, **kwds): |
| 435 | return self.run(*args, **kwds) |
| 436 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 437 | def debug(self): |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 438 | """Run the tests without collecting errors in a TestResult""" |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 439 | for test in self._tests: test.debug() |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 440 | |
| 441 | |
| 442 | class 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 Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 446 | unittest framework. Optionally, set-up and tidy-up functions can be |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 447 | 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 Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 473 | 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 Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 489 | def __str__(self): |
Steve Purcell | dc391a6 | 2002-08-09 09:46:23 +0000 | [diff] [blame] | 490 | return "%s (%s)" % (_strclass(self.__class__), self.__testFunc.__name__) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 491 | |
| 492 | def __repr__(self): |
Steve Purcell | dc391a6 | 2002-08-09 09:46:23 +0000 | [diff] [blame] | 493 | return "<%s testFunc=%s>" % (_strclass(self.__class__), self.__testFunc) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 494 | |
| 495 | def shortDescription(self): |
| 496 | if self.__description is not None: return self.__description |
| 497 | doc = self.__testFunc.__doc__ |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 498 | return doc and doc.split("\n")[0].strip() or None |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 499 | |
| 500 | |
| 501 | |
| 502 | ############################################################################## |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 503 | # Locating and loading tests |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 504 | ############################################################################## |
| 505 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 506 | class TestLoader: |
| 507 | """This class is responsible for loading tests according to various |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 508 | criteria and returning them wrapped in a TestSuite |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 509 | """ |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 510 | testMethodPrefix = 'test' |
| 511 | sortTestMethodsUsing = cmp |
| 512 | suiteClass = TestSuite |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 513 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 514 | def loadTestsFromTestCase(self, testCaseClass): |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 515 | """Return a suite of all tests cases contained in testCaseClass""" |
Johannes Gijsbers | d7b6ad4 | 2004-11-07 15:46:25 +0000 | [diff] [blame] | 516 | if issubclass(testCaseClass, TestSuite): |
| 517 | raise TypeError("Test cases should not be derived from TestSuite. Maybe you meant to derive from TestCase?") |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 518 | testCaseNames = self.getTestCaseNames(testCaseClass) |
| 519 | if not testCaseNames and hasattr(testCaseClass, 'runTest'): |
| 520 | testCaseNames = ['runTest'] |
| 521 | return self.suiteClass(map(testCaseClass, testCaseNames)) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 522 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 523 | def loadTestsFromModule(self, module): |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 524 | """Return a suite of all tests cases contained in the given module""" |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 525 | tests = [] |
| 526 | for name in dir(module): |
| 527 | obj = getattr(module, name) |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 528 | if isinstance(obj, type) and issubclass(obj, TestCase): |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 529 | tests.append(self.loadTestsFromTestCase(obj)) |
| 530 | return self.suiteClass(tests) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 531 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 532 | def loadTestsFromName(self, name, module=None): |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 533 | """Return a suite of all tests cases given a string specifier. |
| 534 | |
| 535 | The name may resolve either to a module, a test case class, a |
| 536 | test method within a test case class, or a callable object which |
| 537 | returns a TestCase or TestSuite instance. |
Tim Peters | 613b222 | 2001-04-13 05:37:27 +0000 | [diff] [blame] | 538 | |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 539 | The method optionally resolves the names relative to a given module. |
| 540 | """ |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 541 | parts = name.split('.') |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 542 | if module is None: |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 543 | parts_copy = parts[:] |
| 544 | while parts_copy: |
| 545 | try: |
| 546 | module = __import__('.'.join(parts_copy)) |
| 547 | break |
| 548 | except ImportError: |
| 549 | del parts_copy[-1] |
| 550 | if not parts_copy: raise |
Armin Rigo | 1b3c04b | 2003-10-24 17:15:29 +0000 | [diff] [blame] | 551 | parts = parts[1:] |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 552 | obj = module |
| 553 | for part in parts: |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 554 | parent, obj = obj, getattr(obj, part) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 555 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 556 | if type(obj) == types.ModuleType: |
| 557 | return self.loadTestsFromModule(obj) |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 558 | elif isinstance(obj, type) and issubclass(obj, TestCase): |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 559 | return self.loadTestsFromTestCase(obj) |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 560 | elif (isinstance(obj, types.UnboundMethodType) and |
| 561 | isinstance(parent, type) and |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 562 | issubclass(parent, TestCase)): |
| 563 | return TestSuite([parent(obj.__name__)]) |
Steve Purcell | 397b45d | 2003-10-26 10:41:03 +0000 | [diff] [blame] | 564 | elif isinstance(obj, TestSuite): |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 565 | return obj |
Guido van Rossum | d59da4b | 2007-05-22 18:11:13 +0000 | [diff] [blame] | 566 | elif hasattr(obj, '__call__'): |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 567 | test = obj() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 568 | if isinstance(test, TestSuite): |
| 569 | return test |
| 570 | elif isinstance(test, TestCase): |
| 571 | return TestSuite([test]) |
| 572 | else: |
| 573 | raise TypeError("calling %s returned %s, not a test" % |
| 574 | (obj, test)) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 575 | else: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 576 | raise TypeError("don't know how to make test from: %s" % obj) |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 577 | |
| 578 | def loadTestsFromNames(self, names, module=None): |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 579 | """Return a suite of all tests cases found using the given sequence |
| 580 | of string specifiers. See 'loadTestsFromName()'. |
| 581 | """ |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 582 | suites = [self.loadTestsFromName(name, module) for name in names] |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 583 | return self.suiteClass(suites) |
| 584 | |
| 585 | def getTestCaseNames(self, testCaseClass): |
Steve Purcell | 15d8927 | 2001-04-12 09:05:01 +0000 | [diff] [blame] | 586 | """Return a sorted sequence of method names found within testCaseClass |
| 587 | """ |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 588 | def isTestMethod(attrname, testCaseClass=testCaseClass, prefix=self.testMethodPrefix): |
Guido van Rossum | d59da4b | 2007-05-22 18:11:13 +0000 | [diff] [blame] | 589 | return attrname.startswith(prefix) and hasattr(getattr(testCaseClass, attrname), '__call__') |
Guido van Rossum | c1f779c | 2007-07-03 08:25:58 +0000 | [diff] [blame] | 590 | testFnNames = list(filter(isTestMethod, dir(testCaseClass))) |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 591 | if self.sortTestMethodsUsing: |
| 592 | testFnNames.sort(self.sortTestMethodsUsing) |
| 593 | return testFnNames |
| 594 | |
| 595 | |
| 596 | |
| 597 | defaultTestLoader = TestLoader() |
| 598 | |
| 599 | |
| 600 | ############################################################################## |
| 601 | # Patches for old functions: these functions should be considered obsolete |
| 602 | ############################################################################## |
| 603 | |
| 604 | def _makeLoader(prefix, sortUsing, suiteClass=None): |
| 605 | loader = TestLoader() |
| 606 | loader.sortTestMethodsUsing = sortUsing |
| 607 | loader.testMethodPrefix = prefix |
| 608 | if suiteClass: loader.suiteClass = suiteClass |
| 609 | return loader |
| 610 | |
| 611 | def getTestCaseNames(testCaseClass, prefix, sortUsing=cmp): |
| 612 | return _makeLoader(prefix, sortUsing).getTestCaseNames(testCaseClass) |
| 613 | |
| 614 | def makeSuite(testCaseClass, prefix='test', sortUsing=cmp, suiteClass=TestSuite): |
| 615 | return _makeLoader(prefix, sortUsing, suiteClass).loadTestsFromTestCase(testCaseClass) |
| 616 | |
| 617 | def findTestCases(module, prefix='test', sortUsing=cmp, suiteClass=TestSuite): |
| 618 | return _makeLoader(prefix, sortUsing, suiteClass).loadTestsFromModule(module) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 619 | |
| 620 | |
| 621 | ############################################################################## |
| 622 | # Text UI |
| 623 | ############################################################################## |
| 624 | |
| 625 | class _WritelnDecorator: |
| 626 | """Used to decorate file-like objects with a handy 'writeln' method""" |
| 627 | def __init__(self,stream): |
| 628 | self.stream = stream |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 629 | |
| 630 | def __getattr__(self, attr): |
| 631 | return getattr(self.stream,attr) |
| 632 | |
Raymond Hettinger | 91dd19d | 2003-09-13 02:58:00 +0000 | [diff] [blame] | 633 | def writeln(self, arg=None): |
| 634 | if arg: self.write(arg) |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 635 | self.write('\n') # text-mode streams translate to \r\n if needed |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 636 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 637 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 638 | class _TextTestResult(TestResult): |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 639 | """A test result class that can print formatted text results to a stream. |
| 640 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 641 | Used by TextTestRunner. |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 642 | """ |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 643 | separator1 = '=' * 70 |
| 644 | separator2 = '-' * 70 |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 645 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 646 | def __init__(self, stream, descriptions, verbosity): |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 647 | TestResult.__init__(self) |
| 648 | self.stream = stream |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 649 | self.showAll = verbosity > 1 |
| 650 | self.dots = verbosity == 1 |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 651 | self.descriptions = descriptions |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 652 | |
| 653 | def getDescription(self, test): |
| 654 | if self.descriptions: |
| 655 | return test.shortDescription() or str(test) |
| 656 | else: |
| 657 | return str(test) |
| 658 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 659 | def startTest(self, test): |
| 660 | TestResult.startTest(self, test) |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 661 | if self.showAll: |
| 662 | self.stream.write(self.getDescription(test)) |
| 663 | self.stream.write(" ... ") |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 664 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 665 | def addSuccess(self, test): |
| 666 | TestResult.addSuccess(self, test) |
| 667 | if self.showAll: |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 668 | self.stream.writeln("ok") |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 669 | elif self.dots: |
| 670 | self.stream.write('.') |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 671 | |
| 672 | def addError(self, test, err): |
| 673 | TestResult.addError(self, test, err) |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 674 | if self.showAll: |
| 675 | self.stream.writeln("ERROR") |
| 676 | elif self.dots: |
| 677 | self.stream.write('E') |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 678 | |
| 679 | def addFailure(self, test, err): |
| 680 | TestResult.addFailure(self, test, err) |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 681 | if self.showAll: |
| 682 | self.stream.writeln("FAIL") |
| 683 | elif self.dots: |
| 684 | self.stream.write('F') |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 685 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 686 | def printErrors(self): |
| 687 | if self.dots or self.showAll: |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 688 | self.stream.writeln() |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 689 | self.printErrorList('ERROR', self.errors) |
| 690 | self.printErrorList('FAIL', self.failures) |
| 691 | |
| 692 | def printErrorList(self, flavour, errors): |
| 693 | for test, err in errors: |
| 694 | self.stream.writeln(self.separator1) |
| 695 | self.stream.writeln("%s: %s" % (flavour,self.getDescription(test))) |
| 696 | self.stream.writeln(self.separator2) |
Steve Purcell | 7b06570 | 2001-09-06 08:24:40 +0000 | [diff] [blame] | 697 | self.stream.writeln("%s" % err) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 698 | |
| 699 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 700 | class TextTestRunner: |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 701 | """A test runner class that displays results in textual form. |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 702 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 703 | It prints out the names of tests as they are run, errors as they |
| 704 | occur, and a summary of the results at the end of the test run. |
| 705 | """ |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 706 | def __init__(self, stream=sys.stderr, descriptions=1, verbosity=1): |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 707 | self.stream = _WritelnDecorator(stream) |
| 708 | self.descriptions = descriptions |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 709 | self.verbosity = verbosity |
| 710 | |
| 711 | def _makeResult(self): |
| 712 | return _TextTestResult(self.stream, self.descriptions, self.verbosity) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 713 | |
| 714 | def run(self, test): |
| 715 | "Run the given test case or test suite." |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 716 | result = self._makeResult() |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 717 | startTime = time.time() |
| 718 | test(result) |
| 719 | stopTime = time.time() |
Steve Purcell | 397b45d | 2003-10-26 10:41:03 +0000 | [diff] [blame] | 720 | timeTaken = stopTime - startTime |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 721 | result.printErrors() |
| 722 | self.stream.writeln(result.separator2) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 723 | run = result.testsRun |
| 724 | self.stream.writeln("Ran %d test%s in %.3fs" % |
Neal Norwitz | 7616504 | 2002-05-31 14:15:11 +0000 | [diff] [blame] | 725 | (run, run != 1 and "s" or "", timeTaken)) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 726 | self.stream.writeln() |
| 727 | if not result.wasSuccessful(): |
| 728 | self.stream.write("FAILED (") |
Guido van Rossum | c1f779c | 2007-07-03 08:25:58 +0000 | [diff] [blame] | 729 | failed, errored = len(result.failures), len(result.errors) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 730 | if failed: |
| 731 | self.stream.write("failures=%d" % failed) |
| 732 | if errored: |
| 733 | if failed: self.stream.write(", ") |
| 734 | self.stream.write("errors=%d" % errored) |
| 735 | self.stream.writeln(")") |
| 736 | else: |
| 737 | self.stream.writeln("OK") |
| 738 | return result |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 739 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 740 | |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 741 | |
| 742 | ############################################################################## |
| 743 | # Facilities for running tests from the command line |
| 744 | ############################################################################## |
| 745 | |
| 746 | class TestProgram: |
| 747 | """A command-line program that runs a set of tests; this is primarily |
| 748 | for making test modules conveniently executable. |
| 749 | """ |
| 750 | USAGE = """\ |
Steve Purcell | 17a781b | 2001-04-09 15:37:31 +0000 | [diff] [blame] | 751 | Usage: %(progName)s [options] [test] [...] |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 752 | |
| 753 | Options: |
| 754 | -h, --help Show this message |
| 755 | -v, --verbose Verbose output |
| 756 | -q, --quiet Minimal output |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 757 | |
| 758 | Examples: |
| 759 | %(progName)s - run default set of tests |
| 760 | %(progName)s MyTestSuite - run suite 'MyTestSuite' |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 761 | %(progName)s MyTestCase.testSomething - run MyTestCase.testSomething |
| 762 | %(progName)s MyTestCase - run all 'test*' test methods |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 763 | in MyTestCase |
| 764 | """ |
| 765 | def __init__(self, module='__main__', defaultTest=None, |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 766 | argv=None, testRunner=TextTestRunner, |
| 767 | testLoader=defaultTestLoader): |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 768 | if type(module) == type(''): |
| 769 | self.module = __import__(module) |
Steve Purcell | 7e74384 | 2003-09-22 11:08:12 +0000 | [diff] [blame] | 770 | for part in module.split('.')[1:]: |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 771 | self.module = getattr(self.module, part) |
| 772 | else: |
| 773 | self.module = module |
| 774 | if argv is None: |
| 775 | argv = sys.argv |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 776 | self.verbosity = 1 |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 777 | self.defaultTest = defaultTest |
| 778 | self.testRunner = testRunner |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 779 | self.testLoader = testLoader |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 780 | self.progName = os.path.basename(argv[0]) |
| 781 | self.parseArgs(argv) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 782 | self.runTests() |
| 783 | |
| 784 | def usageExit(self, msg=None): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 785 | if msg: print(msg) |
| 786 | print(self.USAGE % self.__dict__) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 787 | sys.exit(2) |
| 788 | |
| 789 | def parseArgs(self, argv): |
| 790 | import getopt |
| 791 | try: |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 792 | options, args = getopt.getopt(argv[1:], 'hHvq', |
| 793 | ['help','verbose','quiet']) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 794 | for opt, value in options: |
| 795 | if opt in ('-h','-H','--help'): |
| 796 | self.usageExit() |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 797 | if opt in ('-q','--quiet'): |
| 798 | self.verbosity = 0 |
| 799 | if opt in ('-v','--verbose'): |
| 800 | self.verbosity = 2 |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 801 | if len(args) == 0 and self.defaultTest is None: |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 802 | self.test = self.testLoader.loadTestsFromModule(self.module) |
| 803 | return |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 804 | if len(args) > 0: |
| 805 | self.testNames = args |
| 806 | else: |
| 807 | self.testNames = (self.defaultTest,) |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 808 | self.createTests() |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 809 | except getopt.error as msg: |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 810 | self.usageExit(msg) |
| 811 | |
| 812 | def createTests(self): |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 813 | self.test = self.testLoader.loadTestsFromNames(self.testNames, |
| 814 | self.module) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 815 | |
| 816 | def runTests(self): |
Guido van Rossum | 1325790 | 2007-06-07 23:15:56 +0000 | [diff] [blame] | 817 | if isinstance(self.testRunner, type): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 818 | try: |
| 819 | testRunner = self.testRunner(verbosity=self.verbosity) |
| 820 | except TypeError: |
| 821 | # didn't accept the verbosity argument |
| 822 | testRunner = self.testRunner() |
| 823 | else: |
| 824 | # it is assumed to be a TestRunner instance |
| 825 | testRunner = self.testRunner |
| 826 | result = testRunner.run(self.test) |
Tim Peters | a19a168 | 2001-03-29 04:36:09 +0000 | [diff] [blame] | 827 | sys.exit(not result.wasSuccessful()) |
Fred Drake | 0253820 | 2001-03-21 18:09:46 +0000 | [diff] [blame] | 828 | |
| 829 | main = TestProgram |
| 830 | |
| 831 | |
| 832 | ############################################################################## |
| 833 | # Executing this module from the command line |
| 834 | ############################################################################## |
| 835 | |
| 836 | if __name__ == "__main__": |
| 837 | main(module=None) |