Fetching contributors…
Cannot retrieve contributors at this time
executable file 197 lines (165 sloc) 6.35 KB
#!/usr/bin/env python
# WvTest:
# Copyright (C)2007-2012 Versabanq Innovations Inc. and contributors.
# Licensed under the GNU Library General Public License, version 2.
# See the included file named LICENSE for license information.
# You can get wvtest from:
import atexit
import inspect
import os
import re
import sys
import traceback
# Why do we do we need the "!= main" check? Because if you run
# as a main program and it imports your test files, then
# those test files will try to import the wvtest module recursively.
# That actually *works* fine, because we don't run this main program
# when we're imported as a module. But you end up with two separate
# wvtest modules, the one that gets imported, and the one that's the
# main program. Each of them would have duplicated global variables
# (most importantly, wvtest._registered), and so screwy things could
# happen. Thus, we make the main program module *totally* different
# from the imported module. Then we import wvtest (the module) into
# wvtest (the main program) here and make sure to refer to the right
# versions of global variables.
# All this is done just so that can be a single file that's
# easy to import into your own applications.
if __name__ != '__main__': # we're imported as a module
_registered = []
_tests = 0
_fails = 0
def wvtest(func):
""" Use this decorator (@wvtest) in front of any function you want to
run as part of the unit test suite. Then run:
python path/to/ [other files...]
to run all the @wvtest functions in the given file(s).
return func
def _result(msg, tb, code):
global _tests, _fails
_tests += 1
if code != 'ok':
_fails += 1
(filename, line, func, text) = tb
filename = os.path.basename(filename)
msg = re.sub(r'\s+', ' ', str(msg))
print '! %-70s %s' % ('%s:%-4d %s' % (filename, line, msg),
def _check(cond, msg = 'unknown', tb = None):
if tb == None: tb = traceback.extract_stack()[-3]
if cond:
_result(msg, tb, 'ok')
_result(msg, tb, 'FAILED')
return cond
def _code():
(filename, line, func, text) = traceback.extract_stack()[-3]
text = re.sub(r'^\w+\((.*)\)(\s*#.*)?$', r'\1', text);
return text
def WVPASS(cond = True):
''' Counts a test failure unless cond is true. '''
return _check(cond, _code())
def WVFAIL(cond = True):
''' Counts a test failure unless cond is false. '''
return _check(not cond, 'NOT(%s)' % _code())
def WVPASSEQ(a, b):
''' Counts a test failure unless a == b. '''
return _check(a == b, '%s == %s' % (repr(a), repr(b)))
def WVPASSNE(a, b):
''' Counts a test failure unless a != b. '''
return _check(a != b, '%s != %s' % (repr(a), repr(b)))
def WVPASSLT(a, b):
''' Counts a test failure unless a < b. '''
return _check(a < b, '%s < %s' % (repr(a), repr(b)))
def WVPASSLE(a, b):
''' Counts a test failure unless a <= b. '''
return _check(a <= b, '%s <= %s' % (repr(a), repr(b)))
def WVPASSGT(a, b):
''' Counts a test failure unless a > b. '''
return _check(a > b, '%s > %s' % (repr(a), repr(b)))
def WVPASSGE(a, b):
''' Counts a test failure unless a >= b. '''
return _check(a >= b, '%s >= %s' % (repr(a), repr(b)))
def WVEXCEPT(etype, func, *args, **kwargs):
''' Counts a test failure unless func throws an 'etype' exception.
You have to spell out the function name and arguments, rather than
calling the function yourself, so that WVEXCEPT can run before
your test code throws an exception.
func(*args, **kwargs)
except etype, e:
return _check(True, 'EXCEPT(%s)' % _code())
_check(False, 'EXCEPT(%s)' % _code())
return _check(False, 'EXCEPT(%s)' % _code())
def _check_unfinished():
if _registered:
for func in _registered:
print 'WARNING: not run: %r' % (func,)
WVFAIL('wvtest_main() not called')
if _fails:
def _run_in_chdir(path, func, *args, **kwargs):
oldwd = os.getcwd()
oldpath = sys.path
sys.path += [path, os.path.split(path)[0]]
return func(*args, **kwargs)
sys.path = oldpath
def _runtest(fname, f):
mod = inspect.getmodule(f)
relpath = os.path.relpath(mod.__file__, os.getcwd()).replace('.pyc', '.py')
print 'Testing "%s" in %s:' % (fname, relpath)
_run_in_chdir(os.path.split(mod.__file__)[0], f)
except Exception, e:
print traceback.format_exc()
tb = sys.exc_info()[2]
wvtest._result(e, traceback.extract_tb(tb)[1], 'EXCEPTION')
def _run_registered_tests():
import wvtest as _wvtestmod
while _wvtestmod._registered:
t = _wvtestmod._registered.pop(0)
_runtest(t.func_name, t)
def wvtest_main(extra_testfiles=[]):
import wvtest as _wvtestmod
for modname in extra_testfiles:
if not os.path.exists(modname):
print 'Skipping: %s' % modname
if modname.endswith('.py'):
modname = modname[:-3]
print 'Importing: %s' % modname
path, mod = os.path.split(os.path.abspath(modname))
nicename = modname.replace(os.path.sep, '.')
while nicename.startswith('.'):
nicename = modname[1:]
_run_in_chdir(path, __import__, nicename, None, None, [])
print 'WvTest: %d tests, %d failures.' % (_wvtestmod._tests,
if __name__ == '__main__':
import wvtest as _wvtestmod
sys.modules['wvtest'] = _wvtestmod
sys.modules['wvtest.wvtest'] = _wvtestmod