Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 1 | """Supporting definitions for the Python regression tests.""" |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 2 | |
Barry Warsaw | 408b6d3 | 2002-07-30 23:27:12 +0000 | [diff] [blame] | 3 | if __name__ != 'test.test_support': |
| 4 | raise ImportError, 'test_support must be imported from the test package' |
| 5 | |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 6 | import sys |
| 7 | |
Fred Drake | 1790dd4 | 2000-07-24 06:55:00 +0000 | [diff] [blame] | 8 | class Error(Exception): |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 9 | """Base class for regression test exceptions.""" |
Fred Drake | 1790dd4 | 2000-07-24 06:55:00 +0000 | [diff] [blame] | 10 | |
| 11 | class TestFailed(Error): |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 12 | """Test failed.""" |
Fred Drake | 1790dd4 | 2000-07-24 06:55:00 +0000 | [diff] [blame] | 13 | |
| 14 | class TestSkipped(Error): |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 15 | """Test skipped. |
Fred Drake | 1790dd4 | 2000-07-24 06:55:00 +0000 | [diff] [blame] | 16 | |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 17 | This can be raised to indicate that a test was deliberatly |
| 18 | skipped, but not because a feature wasn't available. For |
| 19 | example, if some resource can't be used, such as the network |
| 20 | appears to be unavailable, this should be raised instead of |
| 21 | TestFailed. |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 22 | """ |
Fred Drake | 1790dd4 | 2000-07-24 06:55:00 +0000 | [diff] [blame] | 23 | |
Fred Drake | 9a0db07 | 2003-02-03 15:19:30 +0000 | [diff] [blame] | 24 | class ResourceDenied(TestSkipped): |
| 25 | """Test skipped because it requested a disallowed resource. |
| 26 | |
| 27 | This is raised when a test calls requires() for a resource that |
| 28 | has not be enabled. It is used to distinguish between expected |
| 29 | and unexpected skips. |
| 30 | """ |
| 31 | |
Barry Warsaw | c0fb605 | 2001-08-20 22:29:23 +0000 | [diff] [blame] | 32 | verbose = 1 # Flag set to 0 by regrtest.py |
Guido van Rossum | fe3f696 | 2001-09-06 16:09:41 +0000 | [diff] [blame] | 33 | use_resources = None # Flag set to [] by regrtest.py |
Guido van Rossum | 531661c | 1996-12-20 02:58:22 +0000 | [diff] [blame] | 34 | |
Tim Peters | 8dee809 | 2001-09-25 20:05:11 +0000 | [diff] [blame] | 35 | # _original_stdout is meant to hold stdout at the time regrtest began. |
| 36 | # This may be "the real" stdout, or IDLE's emulation of stdout, or whatever. |
| 37 | # The point is to have some flavor of stdout the user can actually see. |
| 38 | _original_stdout = None |
| 39 | def record_original_stdout(stdout): |
| 40 | global _original_stdout |
| 41 | _original_stdout = stdout |
| 42 | |
| 43 | def get_original_stdout(): |
| 44 | return _original_stdout or sys.stdout |
| 45 | |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 46 | def unload(name): |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 47 | try: |
| 48 | del sys.modules[name] |
| 49 | except KeyError: |
| 50 | pass |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 51 | |
| 52 | def forget(modname): |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 53 | '''"Forget" a module was ever imported by removing it from sys.modules and |
| 54 | deleting any .pyc and .pyo files.''' |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 55 | unload(modname) |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 56 | import os |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 57 | for dirname in sys.path: |
| 58 | try: |
Martin v. Löwis | a94568a | 2003-05-10 07:36:56 +0000 | [diff] [blame] | 59 | os.unlink(os.path.join(dirname, modname + os.extsep + 'pyc')) |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 60 | except os.error: |
| 61 | pass |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 62 | # Deleting the .pyo file cannot be within the 'try' for the .pyc since |
| 63 | # the chance exists that there is no .pyc (and thus the 'try' statement |
| 64 | # is exited) but there is a .pyo file. |
| 65 | try: |
Martin v. Löwis | a94568a | 2003-05-10 07:36:56 +0000 | [diff] [blame] | 66 | os.unlink(os.path.join(dirname, modname + os.extsep + 'pyo')) |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 67 | except os.error: |
| 68 | pass |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 69 | |
Tim Peters | b4ee4eb | 2002-12-04 03:26:57 +0000 | [diff] [blame] | 70 | def is_resource_enabled(resource): |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 71 | """Test whether a resource is enabled. Known resources are set by |
| 72 | regrtest.py.""" |
Tim Peters | b4ee4eb | 2002-12-04 03:26:57 +0000 | [diff] [blame] | 73 | return use_resources is not None and resource in use_resources |
| 74 | |
Barry Warsaw | c0fb605 | 2001-08-20 22:29:23 +0000 | [diff] [blame] | 75 | def requires(resource, msg=None): |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 76 | """Raise ResourceDenied if the specified resource is not available. |
| 77 | |
| 78 | If the caller's module is __main__ then automatically return True. The |
| 79 | possibility of False being returned occurs when regrtest.py is executing.""" |
Skip Montanaro | d839ecd | 2003-04-24 19:06:57 +0000 | [diff] [blame] | 80 | # see if the caller's module is __main__ - if so, treat as if |
| 81 | # the resource was set |
| 82 | if sys._getframe().f_back.f_globals.get("__name__") == "__main__": |
| 83 | return |
Tim Peters | b4ee4eb | 2002-12-04 03:26:57 +0000 | [diff] [blame] | 84 | if not is_resource_enabled(resource): |
Barry Warsaw | c0fb605 | 2001-08-20 22:29:23 +0000 | [diff] [blame] | 85 | if msg is None: |
| 86 | msg = "Use of the `%s' resource not enabled" % resource |
Fred Drake | 9a0db07 | 2003-02-03 15:19:30 +0000 | [diff] [blame] | 87 | raise ResourceDenied(msg) |
Barry Warsaw | c0fb605 | 2001-08-20 22:29:23 +0000 | [diff] [blame] | 88 | |
Guido van Rossum | 35fb82a | 1993-01-26 13:04:43 +0000 | [diff] [blame] | 89 | FUZZ = 1e-6 |
| 90 | |
| 91 | def fcmp(x, y): # fuzzy comparison function |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 92 | if type(x) == type(0.0) or type(y) == type(0.0): |
| 93 | try: |
| 94 | x, y = coerce(x, y) |
| 95 | fuzz = (abs(x) + abs(y)) * FUZZ |
| 96 | if abs(x-y) <= fuzz: |
| 97 | return 0 |
| 98 | except: |
| 99 | pass |
| 100 | elif type(x) == type(y) and type(x) in (type(()), type([])): |
| 101 | for i in range(min(len(x), len(y))): |
| 102 | outcome = fcmp(x[i], y[i]) |
Fred Drake | 132dce2 | 2000-12-12 23:11:42 +0000 | [diff] [blame] | 103 | if outcome != 0: |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 104 | return outcome |
| 105 | return cmp(len(x), len(y)) |
| 106 | return cmp(x, y) |
Guido van Rossum | 35fb82a | 1993-01-26 13:04:43 +0000 | [diff] [blame] | 107 | |
Martin v. Löwis | 339d0f7 | 2001-08-17 18:39:25 +0000 | [diff] [blame] | 108 | try: |
| 109 | unicode |
| 110 | have_unicode = 1 |
| 111 | except NameError: |
| 112 | have_unicode = 0 |
| 113 | |
Finn Bock | 57bc5fa | 2002-11-01 18:02:03 +0000 | [diff] [blame] | 114 | is_jython = sys.platform.startswith('java') |
| 115 | |
Guido van Rossum | a8f7e59 | 2001-03-13 09:31:07 +0000 | [diff] [blame] | 116 | import os |
Barry Warsaw | 559f668 | 2001-03-23 18:04:02 +0000 | [diff] [blame] | 117 | # Filename used for testing |
| 118 | if os.name == 'java': |
| 119 | # Jython disallows @ in module names |
| 120 | TESTFN = '$test' |
Martin v. Löwis | a94568a | 2003-05-10 07:36:56 +0000 | [diff] [blame] | 121 | elif os.name == 'riscos': |
| 122 | TESTFN = 'testfile' |
| 123 | else: |
Barry Warsaw | 559f668 | 2001-03-23 18:04:02 +0000 | [diff] [blame] | 124 | TESTFN = '@test' |
Mark Hammond | ef8b654 | 2001-05-13 08:04:26 +0000 | [diff] [blame] | 125 | # Unicode name only used if TEST_FN_ENCODING exists for the platform. |
Martin v. Löwis | 339d0f7 | 2001-08-17 18:39:25 +0000 | [diff] [blame] | 126 | if have_unicode: |
Martin v. Löwis | 2411a2d | 2002-11-09 19:57:26 +0000 | [diff] [blame] | 127 | if isinstance('', unicode): |
| 128 | # python -U |
| 129 | # XXX perhaps unicode() should accept Unicode strings? |
| 130 | TESTFN_UNICODE="@test-\xe0\xf2" |
| 131 | else: |
| 132 | TESTFN_UNICODE=unicode("@test-\xe0\xf2", "latin-1") # 2 latin characters. |
Martin v. Löwis | 73d538b | 2003-03-05 15:13:47 +0000 | [diff] [blame] | 133 | TESTFN_ENCODING=sys.getfilesystemencoding() |
Neal Norwitz | 26a1eef | 2002-11-03 00:35:53 +0000 | [diff] [blame] | 134 | |
| 135 | # Make sure we can write to TESTFN, try in /tmp if we can't |
| 136 | fp = None |
| 137 | try: |
| 138 | fp = open(TESTFN, 'w+') |
| 139 | except IOError: |
| 140 | TMP_TESTFN = os.path.join('/tmp', TESTFN) |
| 141 | try: |
| 142 | fp = open(TMP_TESTFN, 'w+') |
| 143 | TESTFN = TMP_TESTFN |
| 144 | del TMP_TESTFN |
| 145 | except IOError: |
Tim Peters | 3de7526 | 2002-11-09 05:26:15 +0000 | [diff] [blame] | 146 | print ('WARNING: tests will fail, unable to write to: %s or %s' % |
Neal Norwitz | 26a1eef | 2002-11-03 00:35:53 +0000 | [diff] [blame] | 147 | (TESTFN, TMP_TESTFN)) |
| 148 | if fp is not None: |
| 149 | fp.close() |
| 150 | try: |
| 151 | os.unlink(TESTFN) |
| 152 | except: |
| 153 | pass |
| 154 | del os, fp |
Guido van Rossum | a8f7e59 | 2001-03-13 09:31:07 +0000 | [diff] [blame] | 155 | |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 156 | from os import unlink |
Guido van Rossum | e26132c | 1998-04-23 20:13:30 +0000 | [diff] [blame] | 157 | |
| 158 | def findfile(file, here=__file__): |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 159 | """Try to find a file on sys.path and the working directory. If it is not |
| 160 | found the argument passed to the function is returned (this does not |
| 161 | necessarily signal failure; could still be the legitimate path).""" |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 162 | import os |
| 163 | if os.path.isabs(file): |
| 164 | return file |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 165 | path = sys.path |
| 166 | path = [os.path.dirname(here)] + path |
| 167 | for dn in path: |
| 168 | fn = os.path.join(dn, file) |
| 169 | if os.path.exists(fn): return fn |
| 170 | return file |
Marc-André Lemburg | 3661908 | 2001-01-17 19:11:13 +0000 | [diff] [blame] | 171 | |
| 172 | def verify(condition, reason='test failed'): |
Guido van Rossum | a1374e4 | 2001-01-19 19:01:56 +0000 | [diff] [blame] | 173 | """Verify that condition is true. If not, raise TestFailed. |
Marc-André Lemburg | 3661908 | 2001-01-17 19:11:13 +0000 | [diff] [blame] | 174 | |
Skip Montanaro | c955f89 | 2001-01-20 19:12:54 +0000 | [diff] [blame] | 175 | The optional argument reason can be given to provide |
Tim Peters | 983874d | 2001-01-19 05:59:21 +0000 | [diff] [blame] | 176 | a better error text. |
Tim Peters | d2bf3b7 | 2001-01-18 02:22:22 +0000 | [diff] [blame] | 177 | """ |
Tim Peters | 983874d | 2001-01-19 05:59:21 +0000 | [diff] [blame] | 178 | |
Tim Peters | d2bf3b7 | 2001-01-18 02:22:22 +0000 | [diff] [blame] | 179 | if not condition: |
Guido van Rossum | a1374e4 | 2001-01-19 19:01:56 +0000 | [diff] [blame] | 180 | raise TestFailed(reason) |
Jeremy Hylton | 4779399 | 2001-02-19 15:35:26 +0000 | [diff] [blame] | 181 | |
Tim Peters | c2fe618 | 2001-10-30 23:20:46 +0000 | [diff] [blame] | 182 | def vereq(a, b): |
Tim Peters | 7790297 | 2001-12-29 17:34:57 +0000 | [diff] [blame] | 183 | """Raise TestFailed if a == b is false. |
| 184 | |
| 185 | This is better than verify(a == b) because, in case of failure, the |
| 186 | error message incorporates repr(a) and repr(b) so you can see the |
| 187 | inputs. |
| 188 | |
| 189 | Note that "not (a == b)" isn't necessarily the same as "a != b"; the |
| 190 | former is tested. |
| 191 | """ |
| 192 | |
Tim Peters | c2fe618 | 2001-10-30 23:20:46 +0000 | [diff] [blame] | 193 | if not (a == b): |
| 194 | raise TestFailed, "%r == %r" % (a, b) |
| 195 | |
Tim Peters | 2f228e7 | 2001-05-13 00:19:31 +0000 | [diff] [blame] | 196 | def sortdict(dict): |
| 197 | "Like repr(dict), but in sorted order." |
| 198 | items = dict.items() |
| 199 | items.sort() |
| 200 | reprpairs = ["%r: %r" % pair for pair in items] |
| 201 | withcommas = ", ".join(reprpairs) |
| 202 | return "{%s}" % withcommas |
| 203 | |
Jeremy Hylton | 4779399 | 2001-02-19 15:35:26 +0000 | [diff] [blame] | 204 | def check_syntax(statement): |
| 205 | try: |
| 206 | compile(statement, '<string>', 'exec') |
| 207 | except SyntaxError: |
| 208 | pass |
| 209 | else: |
| 210 | print 'Missing SyntaxError: "%s"' % statement |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 211 | |
| 212 | |
| 213 | |
| 214 | #======================================================================= |
| 215 | # Preliminary PyUNIT integration. |
| 216 | |
| 217 | import unittest |
| 218 | |
| 219 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 220 | class BasicTestRunner: |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 221 | def run(self, test): |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 222 | result = unittest.TestResult() |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 223 | test(result) |
| 224 | return result |
| 225 | |
| 226 | |
Fred Drake | 2664103 | 2001-10-04 19:46:07 +0000 | [diff] [blame] | 227 | def run_suite(suite, testclass=None): |
Barry Warsaw | c88425e | 2001-09-20 06:31:22 +0000 | [diff] [blame] | 228 | """Run tests from a unittest.TestSuite-derived class.""" |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 229 | if verbose: |
Fred Drake | 84a5934 | 2001-03-23 04:21:17 +0000 | [diff] [blame] | 230 | runner = unittest.TextTestRunner(sys.stdout, verbosity=2) |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 231 | else: |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 232 | runner = BasicTestRunner() |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 233 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 234 | result = runner.run(suite) |
| 235 | if not result.wasSuccessful(): |
Fred Drake | 14f6c18 | 2001-07-16 18:51:32 +0000 | [diff] [blame] | 236 | if len(result.errors) == 1 and not result.failures: |
| 237 | err = result.errors[0][1] |
| 238 | elif len(result.failures) == 1 and not result.errors: |
| 239 | err = result.failures[0][1] |
| 240 | else: |
Fred Drake | 2664103 | 2001-10-04 19:46:07 +0000 | [diff] [blame] | 241 | if testclass is None: |
| 242 | msg = "errors occurred; run in verbose mode for details" |
| 243 | else: |
| 244 | msg = "errors occurred in %s.%s" \ |
| 245 | % (testclass.__module__, testclass.__name__) |
| 246 | raise TestFailed(msg) |
Tim Peters | 2d84f2c | 2001-09-08 03:37:56 +0000 | [diff] [blame] | 247 | raise TestFailed(err) |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 248 | |
Barry Warsaw | c10d690 | 2001-09-20 06:30:41 +0000 | [diff] [blame] | 249 | |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 250 | def run_unittest(*classes): |
| 251 | """Run tests from unittest.TestCase-derived classes.""" |
Raymond Hettinger | 9dcbbea | 2003-04-27 07:54:23 +0000 | [diff] [blame] | 252 | suite = unittest.TestSuite() |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 253 | for cls in classes: |
Raymond Hettinger | 21d9987 | 2003-07-16 02:59:32 +0000 | [diff] [blame^] | 254 | if isinstance(cls, unittest.TestCase): |
| 255 | suite.addTest(cls) |
| 256 | else: |
| 257 | suite.addTest(unittest.makeSuite(cls)) |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 258 | if len(classes)==1: |
| 259 | testclass = classes[0] |
| 260 | else: |
| 261 | testclass = None |
| 262 | run_suite(suite, testclass) |
Raymond Hettinger | 9dcbbea | 2003-04-27 07:54:23 +0000 | [diff] [blame] | 263 | |
Barry Warsaw | c10d690 | 2001-09-20 06:30:41 +0000 | [diff] [blame] | 264 | |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 265 | #======================================================================= |
| 266 | # doctest driver. |
| 267 | |
| 268 | def run_doctest(module, verbosity=None): |
Tim Peters | 17111f3 | 2001-10-03 04:08:26 +0000 | [diff] [blame] | 269 | """Run doctest on the given module. Return (#failures, #tests). |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 270 | |
| 271 | If optional argument verbosity is not specified (or is None), pass |
Tim Peters | bea3fb8 | 2001-09-10 01:39:21 +0000 | [diff] [blame] | 272 | test_support's belief about verbosity on to doctest. Else doctest's |
| 273 | usual behavior is used (it searches sys.argv for -v). |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 274 | """ |
| 275 | |
| 276 | import doctest |
| 277 | |
| 278 | if verbosity is None: |
| 279 | verbosity = verbose |
| 280 | else: |
| 281 | verbosity = None |
| 282 | |
Tim Peters | 342ca75 | 2001-09-25 19:13:20 +0000 | [diff] [blame] | 283 | # Direct doctest output (normally just errors) to real stdout; doctest |
| 284 | # output shouldn't be compared by regrtest. |
| 285 | save_stdout = sys.stdout |
Tim Peters | 8dee809 | 2001-09-25 20:05:11 +0000 | [diff] [blame] | 286 | sys.stdout = get_original_stdout() |
Tim Peters | 342ca75 | 2001-09-25 19:13:20 +0000 | [diff] [blame] | 287 | try: |
| 288 | f, t = doctest.testmod(module, verbose=verbosity) |
| 289 | if f: |
| 290 | raise TestFailed("%d of %d doctests failed" % (f, t)) |
| 291 | finally: |
| 292 | sys.stdout = save_stdout |
Raymond Hettinger | 35b34bd | 2003-05-17 00:58:33 +0000 | [diff] [blame] | 293 | if verbose: |
Raymond Hettinger | 1ba24b4 | 2003-05-17 01:59:57 +0000 | [diff] [blame] | 294 | print 'doctest (%s) ... %d tests with zero failures' % (module.__name__, t) |
Raymond Hettinger | 35b34bd | 2003-05-17 00:58:33 +0000 | [diff] [blame] | 295 | return f, t |