[unittest] the check macro will print the values of params involved in failed proc calls
This commit is contained in:
Zahary Karadjov
parent
b2814df5cd
commit
36155a6813
2 changed files with 213 additions and 185 deletions
|
|
@ -1,187 +1,215 @@
|
||||||
#
|
#
|
||||||
#
|
#
|
||||||
# Nimrod's Runtime Library
|
# Nimrod's Runtime Library
|
||||||
# (c) Copyright 2012 Nimrod Contributors
|
# (c) Copyright 2012 Nimrod Contributors
|
||||||
#
|
#
|
||||||
# See the file "copying.txt", included in this
|
# See the file "copying.txt", included in this
|
||||||
# distribution, for details about the copyright.
|
# distribution, for details about the copyright.
|
||||||
#
|
#
|
||||||
|
|
||||||
## :Author: Zahary Karadjov (zah@github)
|
## :Author: Zahary Karadjov
|
||||||
##
|
##
|
||||||
## This module implements the standard unit testing facilities such as
|
## This module implements the standard unit testing facilities such as
|
||||||
## suites, fixtures and test cases as well as facilities for combinatorial
|
## suites, fixtures and test cases as well as facilities for combinatorial
|
||||||
## and randomzied test case generation (not yet available)
|
## and randomzied test case generation (not yet available)
|
||||||
## and object mocking (not yet available)
|
## and object mocking (not yet available)
|
||||||
##
|
##
|
||||||
## It is loosely based on C++'s boost.test and Haskell's QuickTest
|
## It is loosely based on C++'s boost.test and Haskell's QuickTest
|
||||||
|
|
||||||
import
|
import
|
||||||
macros, terminal, os
|
macros, terminal, os
|
||||||
|
|
||||||
type
|
type
|
||||||
TTestStatus* = enum OK, FAILED
|
TTestStatus* = enum OK, FAILED
|
||||||
TOutputLevel* = enum PRINT_ALL, PRINT_FAILURES, PRINT_NONE
|
TOutputLevel* = enum PRINT_ALL, PRINT_FAILURES, PRINT_NONE
|
||||||
|
|
||||||
var
|
var
|
||||||
# XXX: These better be thread-local
|
# XXX: These better be thread-local
|
||||||
AbortOnError*: bool
|
AbortOnError*: bool
|
||||||
OutputLevel*: TOutputLevel
|
OutputLevel*: TOutputLevel
|
||||||
ColorOutput*: bool
|
ColorOutput*: bool
|
||||||
|
|
||||||
checkpoints: seq[string] = @[]
|
|
||||||
|
|
||||||
template TestSetupIMPL*: stmt {.immediate, dirty.} = nil
|
|
||||||
template TestTeardownIMPL*: stmt {.immediate, dirty.} = nil
|
|
||||||
|
|
||||||
proc shouldRun(testName: string): bool =
|
|
||||||
result = true
|
|
||||||
|
|
||||||
template suite*(name: expr, body: stmt): stmt {.immediate, dirty.} =
|
|
||||||
block:
|
|
||||||
template setup*(setupBody: stmt): stmt {.immediate, dirty.} =
|
|
||||||
template TestSetupIMPL: stmt {.immediate, dirty.} = setupBody
|
|
||||||
|
|
||||||
template teardown*(teardownBody: stmt): stmt {.immediate, dirty.} =
|
|
||||||
template TestTeardownIMPL: stmt {.immediate, dirty.} = teardownBody
|
|
||||||
|
|
||||||
body
|
|
||||||
|
|
||||||
proc testDone(name: string, s: TTestStatus) =
|
|
||||||
if s == FAILED:
|
|
||||||
program_result += 1
|
|
||||||
|
|
||||||
if OutputLevel != PRINT_NONE and (OutputLevel == PRINT_ALL or s == FAILED):
|
|
||||||
var color = (if s == OK: fgGreen else: fgRed)
|
|
||||||
|
|
||||||
if ColorOutput:
|
|
||||||
styledEcho styleBright, color, "[", $s, "] ", fgWhite, name, "\n"
|
|
||||||
else:
|
|
||||||
echo "[", $s, "] ", name, "\n"
|
|
||||||
|
|
||||||
template test*(name: expr, body: stmt): stmt {.immediate, dirty.} =
|
|
||||||
bind shouldRun, checkpoints, testDone
|
|
||||||
|
|
||||||
if shouldRun(name):
|
|
||||||
checkpoints = @[]
|
|
||||||
var TestStatusIMPL {.inject.} = OK
|
|
||||||
|
|
||||||
try:
|
|
||||||
TestSetupIMPL()
|
|
||||||
body
|
|
||||||
|
|
||||||
except:
|
|
||||||
checkpoint("Unhandled exception: " & getCurrentExceptionMsg())
|
|
||||||
fail()
|
|
||||||
|
|
||||||
finally:
|
|
||||||
TestTeardownIMPL()
|
|
||||||
testDone name, TestStatusIMPL
|
|
||||||
|
|
||||||
proc checkpoint*(msg: string) =
|
|
||||||
checkpoints.add(msg)
|
|
||||||
# TODO: add support for something like SCOPED_TRACE from Google Test
|
|
||||||
|
|
||||||
template fail* =
|
|
||||||
bind checkpoints
|
|
||||||
for msg in items(checkpoints):
|
|
||||||
echo msg
|
|
||||||
|
|
||||||
if AbortOnError: quit(1)
|
|
||||||
|
|
||||||
TestStatusIMPL = FAILED
|
|
||||||
checkpoints = @[]
|
|
||||||
|
|
||||||
macro check*(conditions: stmt): stmt {.immediate.} =
|
|
||||||
let conditions = callsite()
|
|
||||||
|
|
||||||
proc standardRewrite(e: PNimrodNode): PNimrodNode =
|
checkpoints: seq[string] = @[]
|
||||||
template rewrite(Exp, lineInfoLit: expr, expLit: string): stmt =
|
|
||||||
if not Exp:
|
template TestSetupIMPL*: stmt {.immediate, dirty.} = nil
|
||||||
checkpoint(lineInfoLit & ": Check failed: " & expLit)
|
template TestTeardownIMPL*: stmt {.immediate, dirty.} = nil
|
||||||
fail()
|
|
||||||
|
proc shouldRun(testName: string): bool =
|
||||||
result = getAst(rewrite(e, e.lineinfo, e.toStrLit))
|
result = true
|
||||||
|
|
||||||
case conditions.kind
|
template suite*(name: expr, body: stmt): stmt {.immediate, dirty.} =
|
||||||
of nnkCall, nnkCommand, nnkMacroStmt:
|
block:
|
||||||
case conditions[1].kind
|
template setup*(setupBody: stmt): stmt {.immediate, dirty.} =
|
||||||
of nnkInfix:
|
template TestSetupIMPL: stmt {.immediate, dirty.} = setupBody
|
||||||
proc rewriteBinaryOp(op: PNimrodNode): PNimrodNode =
|
|
||||||
template rewrite(op, left, right, lineInfoLit: expr, opLit,
|
template teardown*(teardownBody: stmt): stmt {.immediate, dirty.} =
|
||||||
leftLit, rightLit: string, printLhs, printRhs: bool): stmt =
|
template TestTeardownIMPL: stmt {.immediate, dirty.} = teardownBody
|
||||||
block:
|
|
||||||
var
|
body
|
||||||
lhs = left
|
|
||||||
rhs = right
|
proc testDone(name: string, s: TTestStatus) =
|
||||||
|
if s == FAILED:
|
||||||
if not `op`(lhs, rhs):
|
program_result += 1
|
||||||
checkpoint(lineInfoLit & ": Check failed: " & opLit)
|
|
||||||
when printLhs: checkpoint(" " & leftLit & " was " & $lhs)
|
if OutputLevel != PRINT_NONE and (OutputLevel == PRINT_ALL or s == FAILED):
|
||||||
when printRhs: checkpoint(" " & rightLit & " was " & $rhs)
|
var color = (if s == OK: fgGreen else: fgRed)
|
||||||
fail()
|
|
||||||
|
if ColorOutput:
|
||||||
result = getAst(rewrite(
|
styledEcho styleBright, color, "[", $s, "] ", fgWhite, name, "\n"
|
||||||
op[0], op[1], op[2],
|
else:
|
||||||
op.lineinfo,
|
echo "[", $s, "] ", name, "\n"
|
||||||
op.toStrLit,
|
|
||||||
op[1].toStrLit,
|
template test*(name: expr, body: stmt): stmt {.immediate, dirty.} =
|
||||||
op[2].toStrLit,
|
bind shouldRun, checkpoints, testDone
|
||||||
op[1].kind notin nnkLiterals,
|
|
||||||
op[2].kind notin nnkLiterals))
|
if shouldRun(name):
|
||||||
|
checkpoints = @[]
|
||||||
result = rewriteBinaryOp(conditions[1])
|
var TestStatusIMPL {.inject.} = OK
|
||||||
|
|
||||||
of nnkCall, nnkCommand:
|
try:
|
||||||
# TODO: We can print out the call arguments in case of failure
|
TestSetupIMPL()
|
||||||
result = standardRewrite(conditions[1])
|
body
|
||||||
|
|
||||||
of nnkStmtList:
|
except:
|
||||||
result = newNimNode(nnkStmtList)
|
checkpoint("Unhandled exception: " & getCurrentExceptionMsg())
|
||||||
for i in countup(0, conditions[1].len - 1):
|
fail()
|
||||||
result.add(newCall(!"check", conditions[1][i]))
|
|
||||||
|
finally:
|
||||||
else:
|
TestTeardownIMPL()
|
||||||
result = standardRewrite(conditions[1])
|
testDone name, TestStatusIMPL
|
||||||
|
|
||||||
else:
|
proc checkpoint*(msg: string) =
|
||||||
var ast = conditions.treeRepr
|
checkpoints.add(msg)
|
||||||
error conditions.lineinfo & ": Malformed check statement:\n" & ast
|
# TODO: add support for something like SCOPED_TRACE from Google Test
|
||||||
|
|
||||||
template require*(conditions: stmt): stmt {.immediate, dirty.} =
|
template fail* =
|
||||||
block:
|
bind checkpoints
|
||||||
const AbortOnError {.inject.} = true
|
for msg in items(checkpoints):
|
||||||
check conditions
|
echo msg
|
||||||
|
|
||||||
macro expect*(exp: stmt): stmt {.immediate.} =
|
if AbortOnError: quit(1)
|
||||||
|
|
||||||
|
TestStatusIMPL = FAILED
|
||||||
|
checkpoints = @[]
|
||||||
|
|
||||||
|
macro check*(conditions: stmt): stmt {.immediate.} =
|
||||||
|
let conditions = callsite()
|
||||||
|
|
||||||
|
case conditions.kind
|
||||||
|
of nnkCall, nnkCommand, nnkMacroStmt:
|
||||||
|
case conditions[1].kind
|
||||||
|
of nnkInfix:
|
||||||
|
proc rewriteBinaryOp(op: PNimrodNode): PNimrodNode =
|
||||||
|
template rewrite(op, left, right, lineInfoLit: expr, opLit,
|
||||||
|
leftLit, rightLit: string, printLhs, printRhs: bool): stmt =
|
||||||
|
block:
|
||||||
|
var
|
||||||
|
lhs = left
|
||||||
|
rhs = right
|
||||||
|
|
||||||
|
if not `op`(lhs, rhs):
|
||||||
|
checkpoint(lineInfoLit & ": Check failed: " & opLit)
|
||||||
|
when printLhs: checkpoint(" " & leftLit & " was " & $lhs)
|
||||||
|
when printRhs: checkpoint(" " & rightLit & " was " & $rhs)
|
||||||
|
fail()
|
||||||
|
|
||||||
|
result = getAst(rewrite(
|
||||||
|
op[0], op[1], op[2],
|
||||||
|
op.lineinfo,
|
||||||
|
op.toStrLit,
|
||||||
|
op[1].toStrLit,
|
||||||
|
op[2].toStrLit,
|
||||||
|
op[1].kind notin nnkLiterals,
|
||||||
|
op[2].kind notin nnkLiterals))
|
||||||
|
|
||||||
|
result = rewriteBinaryOp(conditions[1])
|
||||||
|
|
||||||
|
of nnkCall, nnkCommand:
|
||||||
|
proc rewriteCall(op: PNimrodNode): PNimrodNode =
|
||||||
|
template rewrite(call, lineInfoLit: expr, expLit: string,
|
||||||
|
argAssgs, argPrintOuts: stmt): stmt =
|
||||||
|
block:
|
||||||
|
argAssgs
|
||||||
|
if not call:
|
||||||
|
checkpoint(lineInfoLit & ": Check failed: " & expLit)
|
||||||
|
argPrintOuts
|
||||||
|
fail()
|
||||||
|
|
||||||
|
template asgn(a, value: expr): stmt =
|
||||||
|
let a = value
|
||||||
|
|
||||||
|
template print(name, value: expr): stmt =
|
||||||
|
checkpoint(name & " was " & $value)
|
||||||
|
|
||||||
|
var
|
||||||
|
argsAsgns = newNimNode(nnkStmtList)
|
||||||
|
argsPrintOuts = newNimNode(nnkStmtList)
|
||||||
|
opStr = op.toStrLit
|
||||||
|
|
||||||
|
for i in 1 .. <op.len:
|
||||||
|
if op[i].kind notin nnkLiterals:
|
||||||
|
# TODO: print only types that are printable
|
||||||
|
var arg = newIdentNode(":param" & ($i))
|
||||||
|
argsAsgns.add getAst(asgn(arg, op[i]))
|
||||||
|
argsPrintOuts.add getAst(print(op[i].toStrLit, arg))
|
||||||
|
op[i] = arg
|
||||||
|
|
||||||
|
result = getAst(rewrite(op, op.lineinfo, opStr, argsAsgns, argsPrintOuts))
|
||||||
|
|
||||||
|
result = rewriteCall(conditions[1])
|
||||||
|
|
||||||
|
of nnkStmtList:
|
||||||
|
result = newNimNode(nnkStmtList)
|
||||||
|
for i in countup(0, conditions[1].len - 1):
|
||||||
|
result.add(newCall(!"check", conditions[1][i]))
|
||||||
|
|
||||||
|
else:
|
||||||
|
template rewrite(Exp, lineInfoLit: expr, expLit: string): stmt =
|
||||||
|
if not Exp:
|
||||||
|
checkpoint(lineInfoLit & ": Check failed: " & expLit)
|
||||||
|
fail()
|
||||||
|
|
||||||
|
let e = conditions[1]
|
||||||
|
result = getAst(rewrite(e, e.lineinfo, e.toStrLit))
|
||||||
|
|
||||||
|
else:
|
||||||
|
var ast = conditions.treeRepr
|
||||||
|
error conditions.lineinfo & ": Malformed check statement:\n" & ast
|
||||||
|
|
||||||
|
template require*(conditions: stmt): stmt {.immediate, dirty.} =
|
||||||
|
block:
|
||||||
|
const AbortOnError {.inject.} = true
|
||||||
|
check conditions
|
||||||
|
|
||||||
|
macro expect*(exp: stmt): stmt {.immediate.} =
|
||||||
let exp = callsite()
|
let exp = callsite()
|
||||||
template expectBody(errorTypes, lineInfoLit: expr,
|
template expectBody(errorTypes, lineInfoLit: expr,
|
||||||
body: stmt): PNimrodNode {.dirty.} =
|
body: stmt): PNimrodNode {.dirty.} =
|
||||||
try:
|
try:
|
||||||
body
|
body
|
||||||
checkpoint(lineInfoLit & ": Expect Failed, no exception was thrown.")
|
checkpoint(lineInfoLit & ": Expect Failed, no exception was thrown.")
|
||||||
fail()
|
fail()
|
||||||
except errorTypes:
|
except errorTypes:
|
||||||
nil
|
nil
|
||||||
|
|
||||||
var expectCall = exp[0]
|
var expectCall = exp[0]
|
||||||
var body = exp[1]
|
var body = exp[1]
|
||||||
|
|
||||||
var errorTypes = newNimNode(nnkBracket)
|
var errorTypes = newNimNode(nnkBracket)
|
||||||
for i in countup(1, expectCall.len - 1):
|
for i in countup(1, expectCall.len - 1):
|
||||||
errorTypes.add(expectCall[i])
|
errorTypes.add(expectCall[i])
|
||||||
|
|
||||||
result = getAst(expectBody(errorTypes, exp.lineinfo, body))
|
result = getAst(expectBody(errorTypes, exp.lineinfo, body))
|
||||||
|
|
||||||
|
|
||||||
## Reading settings
|
## Reading settings
|
||||||
var envOutLvl = os.getEnv("NIMTEST_OUTPUT_LVL").string
|
var envOutLvl = os.getEnv("NIMTEST_OUTPUT_LVL").string
|
||||||
|
|
||||||
if envOutLvl.len > 0:
|
if envOutLvl.len > 0:
|
||||||
for opt in countup(low(TOutputLevel), high(TOutputLevel)):
|
for opt in countup(low(TOutputLevel), high(TOutputLevel)):
|
||||||
if $opt == envOutLvl:
|
if $opt == envOutLvl:
|
||||||
OutputLevel = opt
|
OutputLevel = opt
|
||||||
break
|
break
|
||||||
|
|
||||||
AbortOnError = existsEnv("NIMTEST_ABORT_ON_ERROR")
|
AbortOnError = existsEnv("NIMTEST_ABORT_ON_ERROR")
|
||||||
ColorOutput = not existsEnv("NIMTEST_NO_COLOR")
|
ColorOutput = not existsEnv("NIMTEST_NO_COLOR")
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
|
var s = @[]
|
||||||
|
|
||||||
proc `*` *(a, b: seq[int]): seq[int] =
|
proc `*` *(a, b: seq[int]): seq[int] =
|
||||||
# allocate a new sequence:
|
# allocate a new sequence:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue