Merge pull request #5 from nomennescio/feature-with-passed-failed

Add with-passed, with-failed, and with-passed-failed for custom error messages

Author: nomennescio

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 nomennescio
+Copyright (c) 2019-2022 nomennescio
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

test/README.md

@@ -3,4 +3,6 @@ Simple tests to verify the Factor Testest framework is still working
 Run all tests by executing
 run-tests.py
 
+Requires Python 2 or 3 and Factor to be in your PATH
+
 To show more verbose output, use -v, to show less verbose output, use -q

test/run-tests.py

@@ -1,16 +1,19 @@
 #!/usr/bin/env python
-# Copyright 2019 nomennescio
+# Copyright 2019-2022 nomennescio
 
 import glob, os, re, sys
 
 passed, failed, verbose, quiet = 0, 0, 0, 0
 
+# run Factor on source code file
 def run (factorfile):
     return os.popen ("bash -c 'FACTOR_ROOTS=`pwd`/.. factor " + factorfile + "'").readlines ()
 
+# remove timing information
 def timeless (lines):
     return [re.sub(r'\d+', '0', l) if "<COMPLETEDIN::>" in l else l for l in lines]
 
+# test single Factor source code file
 def test (filename):
     global passed, failed
     actual = run (filename)

test/test-with-passed-failed.expected

@@ -0,0 +1,88 @@
+
+<DESCRIBE::>custom message
+
+<IT::>short strings
+
+<PASSED::>Just passed
+
+<PASSED::>Just passed
+
+<COMPLETEDIN::>0.066171 ms
+
+<IT::>failing compares
+
+<FAILED::>Just failed
+
+<FAILED::>Just failed
+
+<COMPLETEDIN::>0.057857 ms
+
+<IT::>short strings
+
+<PASSED::>Test passed
+
+<PASSED::>Test passed
+
+<COMPLETEDIN::>0.018855 ms
+
+<IT::>failing compares
+
+<FAILED::>Expected :<:LF:>"Hello Worlds!"<:LF:>but got :<:LF:>"Hello World!"
+
+<FAILED::>Expected :<:LF:>"Hello Worlds! "<:LF:>but got :<:LF:>"Hello Worlds!"
+
+<COMPLETEDIN::>0.131308 ms
+
+<IT::>short strings
+
+<PASSED::>Test Passed
+
+<PASSED::>Test Passed
+
+<COMPLETEDIN::>0.019944 ms
+
+<IT::>failing compares
+
+<FAILED::>Test Failed : Expected :<:LF:>"Hello Worlds!"<:LF:>but got :<:LF:>"Hello World!"
+
+<FAILED::>Test Failed : Expected :<:LF:>"Hello Worlds! "<:LF:>but got :<:LF:>"Hello Worlds!"
+
+<COMPLETEDIN::>0.060291 ms
+
+<COMPLETEDIN::>0.540606 ms
+
+<DESCRIBE::>nested custom messages
+
+<IT::>short strings
+
+<PASSED::>Passed 1
+
+<PASSED::>Passed 2
+
+<COMPLETEDIN::>0.031492 ms
+
+<IT::>failing compares
+
+<FAILED::>Test failed A Expected :<:LF:>"Hello Worlds!"<:LF:>but got :<:LF:>"Hello World!"
+
+<FAILED::>Test failed A Expected :<:LF:>"Hello Worlds! "<:LF:>but got :<:LF:>"Hello Worlds!"
+
+<COMPLETEDIN::>0.044357 ms
+
+<IT::>short strings
+
+<PASSED::>Test passed B
+
+<PASSED::>Test passed B
+
+<COMPLETEDIN::>0.018118 ms
+
+<IT::>failing compares
+
+<FAILED::>Failed 3
+
+<FAILED::>Failed 4
+
+<COMPLETEDIN::>0.035839 ms
+
+<COMPLETEDIN::>0.151897 ms

test/test-with-passed-failed.factor

@@ -0,0 +1,57 @@
+! Copyright 2022 nomennescio
+
+USING: accessors debugger io kernel namespaces sequences tools.testest ;
+IN: tests
+
+: pass1 ( -- ) <{ "Hello World!" -> "Hello World!" }> ;
+: pass2 ( -- ) <{ "Hello Worlds!" -> "Hello Worlds!" }> ;
+: fail1 ( -- ) <{ "Hello World!" -> "Hello Worlds!" }> ;
+: fail2 ( -- ) <{ "Hello Worlds!" -> "Hello Worlds! " }> ;
+
+: run-test ( -- )
+  "short strings" it#{ pass1 pass2 }#
+  "failing compares" it#{ fail1 fail2 }#
+;
+
+: custom1 ( -- ) [ "Just passed" write ] [ "Just failed" write drop ] [ run-test ] with-passed-failed ;
+: custom2 ( -- ) [ "Test passed" write ] [ error. ] [ run-test ] with-passed-failed ;
+: custom3 ( -- ) run-test ;
+
+: run-tests ( -- )
+
+  "custom message" describe#{
+    custom1
+    custom2
+    custom3
+  }#
+  
+  "nested custom messages" describe#{
+
+    [ "Test passed A" write ] [ "Test failed A " write error. ] [
+      "short strings" it#{
+        [ "Passed 1" write ] [ pass1 ] with-passed
+        [ "Passed 2" write ] [ pass2 ] with-passed
+      }#
+      
+      "failing compares" it#{
+        [ "Passed 3" write ] [ fail1 ] with-passed
+        [ "Passed 4" write ] [ fail2 ] with-passed
+      }#
+    ] with-passed-failed
+    
+    [ "Test passed B" write ] [ "Test failed B " write error. ] [
+      "short strings" it#{
+        [ "Failed 1" write drop ] [ pass1 ] with-failed
+        [ "Failed 2" write drop ] [ pass2 ] with-failed
+      }#
+      
+      "failing compares" it#{
+        [ "Failed 3" write drop ] [ fail1 ] with-failed
+        [ "Failed 4" write drop ] [ fail2 ] with-failed
+      }#
+    ] with-passed-failed
+
+  }#
+;
+
+MAIN: run-tests

tools/testest/testest.factor

@@ -1,7 +1,7 @@
-! Copyright 2019 nomennescio
+! Copyright 2019-2022 nomennescio
 
-USING: accessors continuations debugger formatting io io.styles kernel locals math namespaces
-parser prettyprint prettyprint.config quotations sequences system ;
+USING: accessors continuations debugger formatting fry io io.styles kernel locals math
+namespaces parser prettyprint prettyprint.config quotations sequences system ;
 IN: tools.testest
 
 : describe#{ ( description -- starttime ) nl "<DESCRIBE::>%s" printf nl nano-count ;
@@ -22,14 +22,18 @@ IN: tools.testest
   ] each
 ;
 
-! user redefinable test result messages
+! user redefinable test result message quotations
 
 SYMBOL: test-passed.
 SYMBOL: test-failed.
 
 [ "Test Passed" write ] test-passed. set-global
 [ "Test Failed : " write error. ] test-failed. set-global
 
+: with-passed ( passed quot -- ) '[ _ test-passed. set @ ] with-scope ; inline
+: with-failed ( failed quot -- ) '[ _ test-failed. set @ ] with-scope ; inline
+: with-passed-failed ( passed failed quot -- ) '[ _ test-passed. set _ test-failed. set @ ] with-scope ; inline
+
 <PRIVATE
 
 : passed. ( -- ) test-passed. get call( -- ) ; inline