r'''A simple test harness These should be trivial, but all the standard ones in python suck. This one sucks far less. ''' import sys import numpy as np import os import re from inspect import currentframe Nchecks = 0 NchecksFailed = 0 # no line breaks. Useful for test reporting. Yes, this sets global state, but # we're running a test harness. This is fine np.set_printoptions(linewidth=1e10, suppress=True) def test_location(): r'''Reports string describing current location in the test Skips over the backtrace entries that are in the test harness itself ''' filename_this = os.path.split( __file__ )[1] if filename_this.endswith(".pyc"): filename_this = filename_this[:-1] frame = currentframe().f_back.f_back while frame: if frame.f_back is None or \ not frame.f_code.co_filename.endswith(filename_this): break frame = frame.f_back testfile = os.path.split(frame.f_code.co_filename)[1] try: return "{}:{} {}()".format(testfile, frame.f_lineno, frame.f_code.co_name) except: return '' def print_red(x): """print the message in red""" sys.stdout.write("\x1b[31m" + test_location() + ": " + x + "\x1b[0m\n") def print_green(x): """Print the message in green""" sys.stdout.write("\x1b[32m" + test_location() + ": " + x + "\x1b[0m\n") def confirm_equal(x, xref, msg='', eps=1e-6): r'''If x is equal to xref, report test success. msg identifies this check. eps sets the RMS equality tolerance. The x,xref arguments can be given as many different types. This function tries to do the right thing. ''' global Nchecks global NchecksFailed Nchecks = Nchecks + 1 # strip all trailing whitespace in each line, in case these are strings if isinstance(x, str): x = re.sub('[ \t]+(\n|$)', '\\1', x) if isinstance(xref, str): xref = re.sub('[ \t]+(\n|$)', '\\1', xref) # convert data to numpy if possible try: xref = np.array(xref) except: pass try: x = np.array(x) except: pass try: # flatten array if possible x = x.ravel() xref = xref.ravel() except: pass try: N = x.shape[0] except: N = 1 try: Nref = xref.shape[0] except: Nref = 1 if N != Nref: print_red(("FAILED{}: mismatched array sizes: N = {} but Nref = {}. Arrays: \n" + "x = {}\n" + "xref = {}"). format((': ' + msg) if msg else '', N, Nref, x, xref)) NchecksFailed = NchecksFailed + 1 return False if N != 0: try: # I I can subtract, get the error that way diff = x - xref def norm2sq(x): """Return 2 norm""" return np.inner(x, x) rms = np.sqrt(norm2sq(diff) / N) if not np.all(np.isfinite(rms)): print_red("FAILED{}: Some comparison results are NaN or Inf. " "rms error = {}. x = {}, xref = {}".format( (': ' + msg) if msg else '', rms, x, xref)) NchecksFailed = NchecksFailed + 1 return False if rms > eps: print_red("FAILED{}: rms error = {}.\nx,xref,err =\n{}".format( (': ' + msg) if msg else '', rms, np.vstack((x, xref, diff)).transpose())) NchecksFailed = NchecksFailed + 1 return False except: # Can't subtract. Do == instead if not np.array_equal(x, xref): print_red("FAILED{}: x =\n'{}', xref =\n'{}'".format( (': ' + msg) if msg else '', x, xref)) NchecksFailed = NchecksFailed + 1 return False print_green("OK{}".format((': ' + msg) if msg else '')) return True def confirm(x, msg=''): r'''If x is true, report test success. msg identifies this check''' global Nchecks global NchecksFailed Nchecks = Nchecks + 1 if not x: print_red("FAILED{}".format((': ' + msg) if msg else '')) NchecksFailed = NchecksFailed + 1 return False print_green("OK{}".format((': ' + msg) if msg else '')) return True def confirm_is(x, xref, msg=''): r'''If x is xref, report test success. msg identifies this check ''' global Nchecks global NchecksFailed Nchecks = Nchecks + 1 if x is xref: print_green("OK{}".format((': ' + msg) if msg else '')) return True print_red("FAILED{}".format((': ' + msg) if msg else '')) NchecksFailed = NchecksFailed + 1 return False def confirm_raises(f, msg=''): r'''If f() raises an exception, report test success. msg identifies this check''' global Nchecks global NchecksFailed Nchecks = Nchecks + 1 try: f() print_red("FAILED{}".format((': ' + msg) if msg else '')) NchecksFailed = NchecksFailed + 1 return False except: print_green("OK{}".format((': ' + msg) if msg else '')) return True def confirm_does_not_raise(f, msg=''): r'''If f() raises an exception, report test failure. msg identifies this check''' global Nchecks global NchecksFailed Nchecks = Nchecks + 1 try: f() print_green("OK{}".format((': ' + msg) if msg else '')) return True except Exception as e: print_red("FAILED{}. Exception: {}".format((': ' + msg) if msg else '', e)) NchecksFailed = NchecksFailed + 1 return False def finish(): r'''Finalize the executed tests. Prints the test summary. Exits successfully iff all the tests passed. ''' if not Nchecks and not NchecksFailed: print_red("No tests defined") sys.exit(0) if NchecksFailed: print_red("Some tests failed: {} out of {}".format(NchecksFailed, Nchecks)) sys.exit(1) print_green("All tests passed: {} total".format(Nchecks)) sys.exit(0) # numpysane-specific tests. Keep these in this file to make sure test-harness # line numbers are not reported def assertValueShape(value_ref, s, f, *args, **kwargs): r'''Makes sure a given call produces a given value and shape. It is redundant to specify both, but it makes it clear I'm asking for what I think I'm asking. The value check can be skipped by passing None. ''' try: res = f(*args, **kwargs) except Exception as e: print_red("FAILED: Exception \"{}\" calling \"{}\"".format(e,f)) global NchecksFailed NchecksFailed += 1 return if 'out' in kwargs: confirm(res is kwargs['out'], msg='returning same matrix as the given "out"') if s is not None: try: shape = res.shape except: shape = () confirm_equal(shape, s, msg='shape matches') if value_ref is not None: confirm_equal(value_ref, res, msg='value matches') if 'dtype' in kwargs: confirm_equal(np.dtype(res.dtype), np.dtype(kwargs['dtype']), msg='matching dtype') def assertResult_inoutplace( ref, func, *args, **kwargs ): r'''makes sure func(a,b) == ref. Tests both a pre-allocated array and a slice-at-a-time allocate/copy mode Only one test-specific kwarg is known: 'out_inplace_dtype'. The rest are passed down to the test function ''' out_inplace_dtype = kwargs.get('out_inplace_dtype', None) try: del kwargs['out_inplace_dtype'] except: pass assertValueShape( ref, ref.shape, func, *args, **kwargs ) output = np.empty(ref.shape, dtype=out_inplace_dtype) assertValueShape( ref, ref.shape, func, *args, out=output, **kwargs) confirm_equal(ref, output)