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 |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame^] | 33 | use_resources = None # Flag set to [] by regrtest.py |
| 34 | max_memuse = 0 # Disable bigmem tests (they will still be run with |
| 35 | # small sizes, to make sure they work.) |
Guido van Rossum | 531661c | 1996-12-20 02:58:22 +0000 | [diff] [blame] | 36 | |
Tim Peters | 8dee809 | 2001-09-25 20:05:11 +0000 | [diff] [blame] | 37 | # _original_stdout is meant to hold stdout at the time regrtest began. |
| 38 | # This may be "the real" stdout, or IDLE's emulation of stdout, or whatever. |
| 39 | # The point is to have some flavor of stdout the user can actually see. |
| 40 | _original_stdout = None |
| 41 | def record_original_stdout(stdout): |
| 42 | global _original_stdout |
| 43 | _original_stdout = stdout |
| 44 | |
| 45 | def get_original_stdout(): |
| 46 | return _original_stdout or sys.stdout |
| 47 | |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 48 | def unload(name): |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 49 | try: |
| 50 | del sys.modules[name] |
| 51 | except KeyError: |
| 52 | pass |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 53 | |
Neal Norwitz | 0e17f8c | 2006-01-23 07:51:27 +0000 | [diff] [blame] | 54 | def unlink(filename): |
| 55 | import os |
| 56 | try: |
| 57 | os.unlink(filename) |
| 58 | except OSError: |
| 59 | pass |
| 60 | |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 61 | def forget(modname): |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 62 | '''"Forget" a module was ever imported by removing it from sys.modules and |
| 63 | deleting any .pyc and .pyo files.''' |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 64 | unload(modname) |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 65 | import os |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 66 | for dirname in sys.path: |
Neal Norwitz | 0e17f8c | 2006-01-23 07:51:27 +0000 | [diff] [blame] | 67 | unlink(os.path.join(dirname, modname + os.extsep + 'pyc')) |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 68 | # Deleting the .pyo file cannot be within the 'try' for the .pyc since |
| 69 | # the chance exists that there is no .pyc (and thus the 'try' statement |
| 70 | # is exited) but there is a .pyo file. |
Neal Norwitz | 0e17f8c | 2006-01-23 07:51:27 +0000 | [diff] [blame] | 71 | unlink(os.path.join(dirname, modname + os.extsep + 'pyo')) |
Guido van Rossum | 3bead09 | 1992-01-27 17:00:37 +0000 | [diff] [blame] | 72 | |
Tim Peters | b4ee4eb | 2002-12-04 03:26:57 +0000 | [diff] [blame] | 73 | def is_resource_enabled(resource): |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 74 | """Test whether a resource is enabled. Known resources are set by |
| 75 | regrtest.py.""" |
Tim Peters | b4ee4eb | 2002-12-04 03:26:57 +0000 | [diff] [blame] | 76 | return use_resources is not None and resource in use_resources |
| 77 | |
Barry Warsaw | c0fb605 | 2001-08-20 22:29:23 +0000 | [diff] [blame] | 78 | def requires(resource, msg=None): |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 79 | """Raise ResourceDenied if the specified resource is not available. |
| 80 | |
| 81 | If the caller's module is __main__ then automatically return True. The |
| 82 | possibility of False being returned occurs when regrtest.py is executing.""" |
Skip Montanaro | d839ecd | 2003-04-24 19:06:57 +0000 | [diff] [blame] | 83 | # see if the caller's module is __main__ - if so, treat as if |
| 84 | # the resource was set |
| 85 | if sys._getframe().f_back.f_globals.get("__name__") == "__main__": |
| 86 | return |
Tim Peters | b4ee4eb | 2002-12-04 03:26:57 +0000 | [diff] [blame] | 87 | if not is_resource_enabled(resource): |
Barry Warsaw | c0fb605 | 2001-08-20 22:29:23 +0000 | [diff] [blame] | 88 | if msg is None: |
| 89 | msg = "Use of the `%s' resource not enabled" % resource |
Fred Drake | 9a0db07 | 2003-02-03 15:19:30 +0000 | [diff] [blame] | 90 | raise ResourceDenied(msg) |
Barry Warsaw | c0fb605 | 2001-08-20 22:29:23 +0000 | [diff] [blame] | 91 | |
Guido van Rossum | 35fb82a | 1993-01-26 13:04:43 +0000 | [diff] [blame] | 92 | FUZZ = 1e-6 |
| 93 | |
| 94 | def fcmp(x, y): # fuzzy comparison function |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 95 | if type(x) == type(0.0) or type(y) == type(0.0): |
| 96 | try: |
| 97 | x, y = coerce(x, y) |
| 98 | fuzz = (abs(x) + abs(y)) * FUZZ |
| 99 | if abs(x-y) <= fuzz: |
| 100 | return 0 |
| 101 | except: |
| 102 | pass |
| 103 | elif type(x) == type(y) and type(x) in (type(()), type([])): |
| 104 | for i in range(min(len(x), len(y))): |
| 105 | outcome = fcmp(x[i], y[i]) |
Fred Drake | 132dce2 | 2000-12-12 23:11:42 +0000 | [diff] [blame] | 106 | if outcome != 0: |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 107 | return outcome |
| 108 | return cmp(len(x), len(y)) |
| 109 | return cmp(x, y) |
Guido van Rossum | 35fb82a | 1993-01-26 13:04:43 +0000 | [diff] [blame] | 110 | |
Martin v. Löwis | 339d0f7 | 2001-08-17 18:39:25 +0000 | [diff] [blame] | 111 | try: |
| 112 | unicode |
| 113 | have_unicode = 1 |
| 114 | except NameError: |
| 115 | have_unicode = 0 |
| 116 | |
Finn Bock | 57bc5fa | 2002-11-01 18:02:03 +0000 | [diff] [blame] | 117 | is_jython = sys.platform.startswith('java') |
| 118 | |
Guido van Rossum | a8f7e59 | 2001-03-13 09:31:07 +0000 | [diff] [blame] | 119 | import os |
Barry Warsaw | 559f668 | 2001-03-23 18:04:02 +0000 | [diff] [blame] | 120 | # Filename used for testing |
| 121 | if os.name == 'java': |
| 122 | # Jython disallows @ in module names |
| 123 | TESTFN = '$test' |
Martin v. Löwis | a94568a | 2003-05-10 07:36:56 +0000 | [diff] [blame] | 124 | elif os.name == 'riscos': |
| 125 | TESTFN = 'testfile' |
| 126 | else: |
Barry Warsaw | 559f668 | 2001-03-23 18:04:02 +0000 | [diff] [blame] | 127 | TESTFN = '@test' |
Mark Hammond | ef8b654 | 2001-05-13 08:04:26 +0000 | [diff] [blame] | 128 | # 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] | 129 | if have_unicode: |
Mark Hammond | b337dd9 | 2003-12-03 01:27:23 +0000 | [diff] [blame] | 130 | # Assuming sys.getfilesystemencoding()!=sys.getdefaultencoding() |
| 131 | # TESTFN_UNICODE is a filename that can be encoded using the |
| 132 | # file system encoding, but *not* with the default (ascii) encoding |
Martin v. Löwis | 2411a2d | 2002-11-09 19:57:26 +0000 | [diff] [blame] | 133 | if isinstance('', unicode): |
| 134 | # python -U |
| 135 | # XXX perhaps unicode() should accept Unicode strings? |
Tim Peters | c6c5ece | 2003-12-04 05:39:43 +0000 | [diff] [blame] | 136 | TESTFN_UNICODE = "@test-\xe0\xf2" |
Martin v. Löwis | 2411a2d | 2002-11-09 19:57:26 +0000 | [diff] [blame] | 137 | else: |
Tim Peters | c6c5ece | 2003-12-04 05:39:43 +0000 | [diff] [blame] | 138 | # 2 latin characters. |
| 139 | TESTFN_UNICODE = unicode("@test-\xe0\xf2", "latin-1") |
| 140 | TESTFN_ENCODING = sys.getfilesystemencoding() |
| 141 | # TESTFN_UNICODE_UNENCODEABLE is a filename that should *not* be |
Mark Hammond | b337dd9 | 2003-12-03 01:27:23 +0000 | [diff] [blame] | 142 | # able to be encoded by *either* the default or filesystem encoding. |
Tim Peters | c6c5ece | 2003-12-04 05:39:43 +0000 | [diff] [blame] | 143 | # This test really only makes sense on Windows NT platforms |
Mark Hammond | 2e8624c | 2003-12-03 22:16:47 +0000 | [diff] [blame] | 144 | # which have special Unicode support in posixmodule. |
Tim Peters | c6c5ece | 2003-12-04 05:39:43 +0000 | [diff] [blame] | 145 | if (not hasattr(sys, "getwindowsversion") or |
| 146 | sys.getwindowsversion()[3] < 2): # 0=win32s or 1=9x/ME |
Tim Peters | 58eb11c | 2004-01-18 20:29:55 +0000 | [diff] [blame] | 147 | TESTFN_UNICODE_UNENCODEABLE = None |
Mark Hammond | b337dd9 | 2003-12-03 01:27:23 +0000 | [diff] [blame] | 148 | else: |
Mark Hammond | 2e8624c | 2003-12-03 22:16:47 +0000 | [diff] [blame] | 149 | # Japanese characters (I think - from bug 846133) |
Martin v. Löwis | e2713be | 2005-03-08 15:03:08 +0000 | [diff] [blame] | 150 | TESTFN_UNICODE_UNENCODEABLE = eval('u"@test-\u5171\u6709\u3055\u308c\u308b"') |
Mark Hammond | 2e8624c | 2003-12-03 22:16:47 +0000 | [diff] [blame] | 151 | try: |
| 152 | # XXX - Note - should be using TESTFN_ENCODING here - but for |
Tim Peters | c6c5ece | 2003-12-04 05:39:43 +0000 | [diff] [blame] | 153 | # Windows, "mbcs" currently always operates as if in |
Mark Hammond | 2e8624c | 2003-12-03 22:16:47 +0000 | [diff] [blame] | 154 | # errors=ignore' mode - hence we get '?' characters rather than |
| 155 | # the exception. 'Latin1' operates as we expect - ie, fails. |
| 156 | # See [ 850997 ] mbcs encoding ignores errors |
| 157 | TESTFN_UNICODE_UNENCODEABLE.encode("Latin1") |
| 158 | except UnicodeEncodeError: |
| 159 | pass |
| 160 | else: |
| 161 | print \ |
| 162 | 'WARNING: The filename %r CAN be encoded by the filesystem. ' \ |
| 163 | 'Unicode filename tests may not be effective' \ |
| 164 | % TESTFN_UNICODE_UNENCODEABLE |
Neal Norwitz | 26a1eef | 2002-11-03 00:35:53 +0000 | [diff] [blame] | 165 | |
| 166 | # Make sure we can write to TESTFN, try in /tmp if we can't |
| 167 | fp = None |
| 168 | try: |
| 169 | fp = open(TESTFN, 'w+') |
| 170 | except IOError: |
| 171 | TMP_TESTFN = os.path.join('/tmp', TESTFN) |
| 172 | try: |
| 173 | fp = open(TMP_TESTFN, 'w+') |
| 174 | TESTFN = TMP_TESTFN |
| 175 | del TMP_TESTFN |
| 176 | except IOError: |
Tim Peters | 3de7526 | 2002-11-09 05:26:15 +0000 | [diff] [blame] | 177 | print ('WARNING: tests will fail, unable to write to: %s or %s' % |
Neal Norwitz | 26a1eef | 2002-11-03 00:35:53 +0000 | [diff] [blame] | 178 | (TESTFN, TMP_TESTFN)) |
| 179 | if fp is not None: |
| 180 | fp.close() |
Neal Norwitz | 0e17f8c | 2006-01-23 07:51:27 +0000 | [diff] [blame] | 181 | unlink(TESTFN) |
Neal Norwitz | 26a1eef | 2002-11-03 00:35:53 +0000 | [diff] [blame] | 182 | del os, fp |
Guido van Rossum | a8f7e59 | 2001-03-13 09:31:07 +0000 | [diff] [blame] | 183 | |
Guido van Rossum | e26132c | 1998-04-23 20:13:30 +0000 | [diff] [blame] | 184 | def findfile(file, here=__file__): |
Brett Cannon | f1cfb62 | 2003-05-04 21:15:27 +0000 | [diff] [blame] | 185 | """Try to find a file on sys.path and the working directory. If it is not |
| 186 | found the argument passed to the function is returned (this does not |
| 187 | necessarily signal failure; could still be the legitimate path).""" |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 188 | import os |
| 189 | if os.path.isabs(file): |
| 190 | return file |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 191 | path = sys.path |
| 192 | path = [os.path.dirname(here)] + path |
| 193 | for dn in path: |
| 194 | fn = os.path.join(dn, file) |
| 195 | if os.path.exists(fn): return fn |
| 196 | return file |
Marc-André Lemburg | 3661908 | 2001-01-17 19:11:13 +0000 | [diff] [blame] | 197 | |
| 198 | def verify(condition, reason='test failed'): |
Guido van Rossum | a1374e4 | 2001-01-19 19:01:56 +0000 | [diff] [blame] | 199 | """Verify that condition is true. If not, raise TestFailed. |
Marc-André Lemburg | 3661908 | 2001-01-17 19:11:13 +0000 | [diff] [blame] | 200 | |
Skip Montanaro | c955f89 | 2001-01-20 19:12:54 +0000 | [diff] [blame] | 201 | The optional argument reason can be given to provide |
Tim Peters | 983874d | 2001-01-19 05:59:21 +0000 | [diff] [blame] | 202 | a better error text. |
Tim Peters | d2bf3b7 | 2001-01-18 02:22:22 +0000 | [diff] [blame] | 203 | """ |
Tim Peters | 983874d | 2001-01-19 05:59:21 +0000 | [diff] [blame] | 204 | |
Tim Peters | d2bf3b7 | 2001-01-18 02:22:22 +0000 | [diff] [blame] | 205 | if not condition: |
Guido van Rossum | a1374e4 | 2001-01-19 19:01:56 +0000 | [diff] [blame] | 206 | raise TestFailed(reason) |
Jeremy Hylton | 4779399 | 2001-02-19 15:35:26 +0000 | [diff] [blame] | 207 | |
Tim Peters | c2fe618 | 2001-10-30 23:20:46 +0000 | [diff] [blame] | 208 | def vereq(a, b): |
Tim Peters | 7790297 | 2001-12-29 17:34:57 +0000 | [diff] [blame] | 209 | """Raise TestFailed if a == b is false. |
| 210 | |
| 211 | This is better than verify(a == b) because, in case of failure, the |
| 212 | error message incorporates repr(a) and repr(b) so you can see the |
| 213 | inputs. |
| 214 | |
| 215 | Note that "not (a == b)" isn't necessarily the same as "a != b"; the |
| 216 | former is tested. |
| 217 | """ |
| 218 | |
Tim Peters | c2fe618 | 2001-10-30 23:20:46 +0000 | [diff] [blame] | 219 | if not (a == b): |
| 220 | raise TestFailed, "%r == %r" % (a, b) |
| 221 | |
Tim Peters | 2f228e7 | 2001-05-13 00:19:31 +0000 | [diff] [blame] | 222 | def sortdict(dict): |
| 223 | "Like repr(dict), but in sorted order." |
| 224 | items = dict.items() |
| 225 | items.sort() |
| 226 | reprpairs = ["%r: %r" % pair for pair in items] |
| 227 | withcommas = ", ".join(reprpairs) |
| 228 | return "{%s}" % withcommas |
| 229 | |
Jeremy Hylton | 4779399 | 2001-02-19 15:35:26 +0000 | [diff] [blame] | 230 | def check_syntax(statement): |
| 231 | try: |
| 232 | compile(statement, '<string>', 'exec') |
| 233 | except SyntaxError: |
| 234 | pass |
| 235 | else: |
| 236 | print 'Missing SyntaxError: "%s"' % statement |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 237 | |
Hye-Shik Chang | aaa2f1d | 2005-12-10 17:44:27 +0000 | [diff] [blame] | 238 | def open_urlresource(url): |
| 239 | import urllib, urlparse |
| 240 | import os.path |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 241 | |
Hye-Shik Chang | aaa2f1d | 2005-12-10 17:44:27 +0000 | [diff] [blame] | 242 | filename = urlparse.urlparse(url)[2].split('/')[-1] # '/': it's URL! |
| 243 | |
| 244 | for path in [os.path.curdir, os.path.pardir]: |
| 245 | fn = os.path.join(path, filename) |
| 246 | if os.path.exists(fn): |
| 247 | return open(fn) |
| 248 | |
| 249 | requires('urlfetch') |
| 250 | print >> get_original_stdout(), '\tfetching %s ...' % url |
| 251 | fn, _ = urllib.urlretrieve(url, filename) |
| 252 | return open(fn) |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 253 | |
| 254 | #======================================================================= |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame^] | 255 | # Decorator for running a function in a different locale, correctly resetting |
| 256 | # it afterwards. |
| 257 | |
| 258 | def run_with_locale(catstr, *locales): |
| 259 | def decorator(func): |
| 260 | def inner(*args, **kwds): |
| 261 | try: |
| 262 | import locale |
| 263 | category = getattr(locale, catstr) |
| 264 | orig_locale = locale.setlocale(category) |
| 265 | except AttributeError: |
| 266 | # if the test author gives us an invalid category string |
| 267 | raise |
| 268 | except: |
| 269 | # cannot retrieve original locale, so do nothing |
| 270 | locale = orig_locale = None |
| 271 | else: |
| 272 | for loc in locales: |
| 273 | try: |
| 274 | locale.setlocale(category, loc) |
| 275 | break |
| 276 | except: |
| 277 | pass |
| 278 | |
| 279 | # now run the function, resetting the locale on exceptions |
| 280 | try: |
| 281 | return func(*args, **kwds) |
| 282 | finally: |
| 283 | if locale and orig_locale: |
| 284 | locale.setlocale(category, orig_locale) |
| 285 | inner.func_name = func.func_name |
| 286 | inner.__doc__ = func.__doc__ |
| 287 | return inner |
| 288 | return decorator |
| 289 | |
| 290 | #======================================================================= |
| 291 | # Big-memory-test support. Separate from 'resources' because memory use should be configurable. |
| 292 | |
| 293 | # Some handy shorthands. Note that these are used for byte-limits as well |
| 294 | # as size-limits, in the various bigmem tests |
| 295 | _1M = 1024*1024 |
| 296 | _1G = 1024 * _1M |
| 297 | _2G = 2 * _1G |
| 298 | |
| 299 | def set_memlimit(limit): |
| 300 | import re |
| 301 | global max_memuse |
| 302 | sizes = { |
| 303 | 'k': 1024, |
| 304 | 'm': _1M, |
| 305 | 'g': _1G, |
| 306 | 't': 1024*_1G, |
| 307 | } |
| 308 | m = re.match(r'(\d+(\.\d+)?) (K|M|G|T)b?$', limit, |
| 309 | re.IGNORECASE | re.VERBOSE) |
| 310 | if m is None: |
| 311 | raise ValueError('Invalid memory limit %r' % (limit,)) |
| 312 | memlimit = int(float(m.group(1)) * sizes[m.group(3).lower()]) |
| 313 | if memlimit < 2.5*_1G: |
| 314 | raise ValueError('Memory limit %r too low to be useful' % (limit,)) |
| 315 | max_memuse = memlimit |
| 316 | |
| 317 | def bigmemtest(minsize, memuse, overhead=5*_1M): |
| 318 | """Decorator for bigmem tests. |
| 319 | |
| 320 | 'minsize' is the minimum useful size for the test (in arbitrary, |
| 321 | test-interpreted units.) 'memuse' is the number of 'bytes per size' for |
| 322 | the test, or a good estimate of it. 'overhead' specifies fixed overhead, |
| 323 | independant of the testsize, and defaults to 5Mb. |
| 324 | |
| 325 | The decorator tries to guess a good value for 'size' and passes it to |
| 326 | the decorated test function. If minsize * memuse is more than the |
| 327 | allowed memory use (as defined by max_memuse), the test is skipped. |
| 328 | Otherwise, minsize is adjusted upward to use up to max_memuse. |
| 329 | """ |
| 330 | def decorator(f): |
| 331 | def wrapper(self): |
| 332 | if not max_memuse: |
| 333 | # If max_memuse is 0 (the default), |
| 334 | # we still want to run the tests with size set to a few kb, |
| 335 | # to make sure they work. We still want to avoid using |
| 336 | # too much memory, though, but we do that noisily. |
| 337 | maxsize = 5147 |
| 338 | self.failIf(maxsize * memuse + overhead > 20 * _1M) |
| 339 | else: |
| 340 | maxsize = int((max_memuse - overhead) / memuse) |
| 341 | if maxsize < minsize: |
| 342 | # Really ought to print 'test skipped' or something |
| 343 | if verbose: |
| 344 | sys.stderr.write("Skipping %s because of memory " |
| 345 | "constraint\n" % (f.__name__,)) |
| 346 | return |
| 347 | # Try to keep some breathing room in memory use |
| 348 | maxsize = max(maxsize - 50 * _1M, minsize) |
| 349 | return f(self, maxsize) |
| 350 | wrapper.minsize = minsize |
| 351 | wrapper.memuse = memuse |
| 352 | wrapper.overhead = overhead |
| 353 | return wrapper |
| 354 | return decorator |
| 355 | |
| 356 | #======================================================================= |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 357 | # Preliminary PyUNIT integration. |
| 358 | |
| 359 | import unittest |
| 360 | |
| 361 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 362 | class BasicTestRunner: |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 363 | def run(self, test): |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 364 | result = unittest.TestResult() |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 365 | test(result) |
| 366 | return result |
| 367 | |
| 368 | |
Fred Drake | 2664103 | 2001-10-04 19:46:07 +0000 | [diff] [blame] | 369 | def run_suite(suite, testclass=None): |
Barry Warsaw | c88425e | 2001-09-20 06:31:22 +0000 | [diff] [blame] | 370 | """Run tests from a unittest.TestSuite-derived class.""" |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 371 | if verbose: |
Fred Drake | 84a5934 | 2001-03-23 04:21:17 +0000 | [diff] [blame] | 372 | runner = unittest.TextTestRunner(sys.stdout, verbosity=2) |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 373 | else: |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 374 | runner = BasicTestRunner() |
Fred Drake | cd1b1dd | 2001-03-21 18:26:33 +0000 | [diff] [blame] | 375 | |
Steve Purcell | 5ddd1a8 | 2001-03-22 08:45:36 +0000 | [diff] [blame] | 376 | result = runner.run(suite) |
| 377 | if not result.wasSuccessful(): |
Fred Drake | 14f6c18 | 2001-07-16 18:51:32 +0000 | [diff] [blame] | 378 | if len(result.errors) == 1 and not result.failures: |
| 379 | err = result.errors[0][1] |
| 380 | elif len(result.failures) == 1 and not result.errors: |
| 381 | err = result.failures[0][1] |
| 382 | else: |
Fred Drake | 2664103 | 2001-10-04 19:46:07 +0000 | [diff] [blame] | 383 | if testclass is None: |
| 384 | msg = "errors occurred; run in verbose mode for details" |
| 385 | else: |
| 386 | msg = "errors occurred in %s.%s" \ |
| 387 | % (testclass.__module__, testclass.__name__) |
| 388 | raise TestFailed(msg) |
Tim Peters | 2d84f2c | 2001-09-08 03:37:56 +0000 | [diff] [blame] | 389 | raise TestFailed(err) |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 390 | |
Barry Warsaw | c10d690 | 2001-09-20 06:30:41 +0000 | [diff] [blame] | 391 | |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 392 | def run_unittest(*classes): |
| 393 | """Run tests from unittest.TestCase-derived classes.""" |
Raymond Hettinger | 9dcbbea | 2003-04-27 07:54:23 +0000 | [diff] [blame] | 394 | suite = unittest.TestSuite() |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 395 | for cls in classes: |
Raymond Hettinger | f359062 | 2003-07-16 04:29:42 +0000 | [diff] [blame] | 396 | if isinstance(cls, (unittest.TestSuite, unittest.TestCase)): |
Raymond Hettinger | 21d9987 | 2003-07-16 02:59:32 +0000 | [diff] [blame] | 397 | suite.addTest(cls) |
| 398 | else: |
| 399 | suite.addTest(unittest.makeSuite(cls)) |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 400 | if len(classes)==1: |
| 401 | testclass = classes[0] |
| 402 | else: |
| 403 | testclass = None |
| 404 | run_suite(suite, testclass) |
Raymond Hettinger | 9dcbbea | 2003-04-27 07:54:23 +0000 | [diff] [blame] | 405 | |
Barry Warsaw | c10d690 | 2001-09-20 06:30:41 +0000 | [diff] [blame] | 406 | |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 407 | #======================================================================= |
| 408 | # doctest driver. |
| 409 | |
| 410 | def run_doctest(module, verbosity=None): |
Tim Peters | 17111f3 | 2001-10-03 04:08:26 +0000 | [diff] [blame] | 411 | """Run doctest on the given module. Return (#failures, #tests). |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 412 | |
| 413 | If optional argument verbosity is not specified (or is None), pass |
Tim Peters | bea3fb8 | 2001-09-10 01:39:21 +0000 | [diff] [blame] | 414 | test_support's belief about verbosity on to doctest. Else doctest's |
| 415 | usual behavior is used (it searches sys.argv for -v). |
Tim Peters | a0a6222 | 2001-09-09 06:12:01 +0000 | [diff] [blame] | 416 | """ |
| 417 | |
| 418 | import doctest |
| 419 | |
| 420 | if verbosity is None: |
| 421 | verbosity = verbose |
| 422 | else: |
| 423 | verbosity = None |
| 424 | |
Tim Peters | 342ca75 | 2001-09-25 19:13:20 +0000 | [diff] [blame] | 425 | # Direct doctest output (normally just errors) to real stdout; doctest |
| 426 | # output shouldn't be compared by regrtest. |
| 427 | save_stdout = sys.stdout |
Tim Peters | 8dee809 | 2001-09-25 20:05:11 +0000 | [diff] [blame] | 428 | sys.stdout = get_original_stdout() |
Tim Peters | 342ca75 | 2001-09-25 19:13:20 +0000 | [diff] [blame] | 429 | try: |
| 430 | f, t = doctest.testmod(module, verbose=verbosity) |
| 431 | if f: |
| 432 | raise TestFailed("%d of %d doctests failed" % (f, t)) |
| 433 | finally: |
| 434 | sys.stdout = save_stdout |
Raymond Hettinger | 35b34bd | 2003-05-17 00:58:33 +0000 | [diff] [blame] | 435 | if verbose: |
Raymond Hettinger | 1ba24b4 | 2003-05-17 01:59:57 +0000 | [diff] [blame] | 436 | print 'doctest (%s) ... %d tests with zero failures' % (module.__name__, t) |
Raymond Hettinger | 35b34bd | 2003-05-17 00:58:33 +0000 | [diff] [blame] | 437 | return f, t |