Merge pull request #15 from pepe/add-test

Add simple test helper, extracted from janet-lang

README.md

@@ -182,18 +182,78 @@ arguments to `argparse`.
 
 Run `(doc argparse/argparse)` after importing for more information.
 
-## Misc
+## Test
 
-### Dedent
+This module contains a simple test helper when you do not need a specialized
+library.
 
-Remove indentation after concatenating the arguments.
+### assert
+
+Modified version of assert, with some nice error handling.
 
 ```clojure
-(misc/dedent ``
-      ho
-        hoho
-          hohoho
-``))))) => "ho\n  hoho\n    hohoho"
+(test/assert false "How is this?")
+# => ✘ How is this?
+(test/assert true "OK")
+# => ✔true
+```
+
+### assert-not
+
+Invert assert.
+
+```clojure
+(test/assert-not false "OK")
+# => ✔true
+```
+
+### assert-error
+
+Test passes if forms throw errors.
+
+```clojure
+(test/assert-error "To err is natural" (error "Bad"))
+# => ✔true
+```
+
+### assert-no-error
+
+Test passes if forms throw errors.
+
+```clojure
+(test/assert-no-error "To not err is desired" (do "Good"))
+# => ✔true
+```
+
+### start-suite
+
+Starts test suite, which counts all and passed tests.
+
+### end-suite
+
+Ends test suite and print summary.
+
+### All together
+
+Example of simple test suite.
+
+```clojure
+(import spork/test)
+
+(test/start-suite 0)
+
+(test/assert true "is always true")
+(test/assert-not false "is always false")
+(test/assert-error "To err is natural" (error "Bad"))
+(test/assert-no-error "To not err is desired" (do "Good"))
+
+(test/end-suite)
+
+# =>
+
+Test suite 0 finished in 0.000 soconds
+4 of 4 tests passed.
+
 ```
 
 ### timeit
@@ -207,6 +267,42 @@ Elapsed time: 0.0718288 seconds
 6.66666e+08
 ```
 
+### capture-stdout
+
+Runs the form and captures stdout. Returns tuple with result and captured
+stdout in string.
+
+```clojure
+(capture-stdout
+  (do
+    (print "Interesting output")
+    true))
+# => (true "Interesting output")
+```
+
+### supress-stdout
+
+Runs the form, but supresses its stdout.
+
+```clojure
+(suppress-stdout (print "Hello world!"))
+# => nil
+```
+
+## Misc
+
+### Dedent
+
+Remove indentation after concatenating the arguments.
+
+```clojure
+(misc/dedent ``
+      ho
+        hoho
+          hohoho
+``))))) => "ho\n  hoho\n    hohoho"
+```
+
 ### set*
 
 Allow parallel mutation of multiple mutable variables.  (All right
@@ -229,4 +325,4 @@ x => @[3 5]
 
 ```
 [sudo] jpm install https://github.com/janet-lang/spork.git
-```
+```

spork/test/init.janet

@@ -0,0 +1,89 @@
+# Helper code for running tests
+
+(var num-tests-passed 0)
+(var num-tests-run 0)
+(var suite-num 0)
+(var numchecks 0)
+(var start-time 0)
+
+(defn assert
+  "Override's the default assert with some nice error handling."
+  [x &opt e]
+  (default e "assert error")
+  (++ num-tests-run)
+  (if x (++ num-tests-passed))
+  (if x
+    (do
+      (when (= numchecks 25)
+        (set numchecks 0)
+        (print))
+      (++ numchecks)
+      (prin "\e[32m✔\e[0m"))
+    (do
+      (prin "\n\e[31m✘\e[0m  ")
+      (set numchecks 0)
+      (print e)))
+  x)
+
+(defn assert-not
+  "Invert assert."
+  [x &opt e]
+  (assert (not x) e))
+
+(defmacro assert-error
+  "Test passes if forms error."
+  [msg & forms]
+  (def errsym (keyword (gensym)))
+  ~(,assert (= ,errsym (try (do ,;forms) ([_] ,errsym))) ,msg))
+
+(defmacro assert-no-error
+  "Test passes if forms do not error."
+  [msg & forms]
+  (def errsym (keyword (gensym)))
+  ~(,assert (not= ,errsym (try (do ,;forms) ([_] ,errsym))) ,msg))
+
+(defn start-suite [x]
+  "Starts test suite."
+  (set suite-num x)
+  (set start-time (os/clock))
+  (print "\nRunning test suite " x " tests...\n"))
+
+(defn end-suite []
+  "Ends test suite."
+  (def delta (- (os/clock) start-time))
+  (printf "\n\nTest suite %d finished in %.3f soconds" suite-num delta)
+  (print num-tests-passed " of " num-tests-run " tests passed.\n")
+  (if (not= num-tests-passed num-tests-run) (os/exit 1)))
+
+(defmacro timeit
+  ```
+  Time the execution of `form` using `os/clock` before and after,
+  and print the result to stdout.  returns: result of executing `form`.
+  Uses `tag` (default "Elapsed time:") to tag the printout.
+  ```
+  [form &opt tag]
+  (default tag "Elapsed time:")
+  (with-syms [start result end]
+    ~(do
+       (def ,start (os/clock))
+       (def ,result ,form)
+       (def ,end (os/clock))
+       (print ,tag " " (- ,end ,start) " seconds")
+       ,result)))
+
+(defmacro capture-stdout
+  ```
+  Runs the form and captures stdout. Returns tuple with result of the form
+  and a string with captured stdout.
+  ```
+  [form]
+  (with-syms [buf res]
+    ~(do
+       (def ,buf @"")
+       (with-dyns [:out ,buf]
+         (def ,res ,form)
+         [,res (string ,buf)]))))
+
+(defmacro suppress-stdout [& body]
+  "Suppreses stdout from the body"
+  ~(with-dyns [:out @""] ,;body))

test/suite0.janet

@@ -1,4 +1,4 @@
-(use ./helper)
+(use ../spork/test)
 (import ../spork/fmt)
 
 (start-suite 0)
@@ -9,7 +9,7 @@
   (fmt/format-print "(\n print\n \"HOHOHO\")"))
 (assert (deep= b @"(print\n  \"HOHOHO\")\n") "format-print")
 
- # regresion with comment in the collection literals
+# regresion with comment in the collection literals
 (buffer/clear b)
 (with-dyns [:out b]
   (fmt/format-print "{:a 0\n:b 1 # test comment\n}"))

test/suite1.janet

@@ -1,39 +1,11 @@
-(use ./helper)
+(use ../spork/test)
 (import ../spork/misc)
 
 (start-suite 1)
 
 #misc/dedent
 (assert (= (misc/dedent "  a\n    b\n   c\n     d") "a\n  b\n c\n   d") "dedent")
 
-#misc/timeit
-(defmacro- capture-stdout
-  [form]
-  (with-syms [buf res]
-    ~(do
-      (def ,buf (buffer/new 1024))
-      (with-dyns [:out ,buf]
-        (def ,res ,form)
-        [,res (string ,buf)]))))
-
-(do
-  (def [result output]
-    (capture-stdout
-      (misc/timeit (loop [i :range [1 100000]] i) "foo:")))
-  (assert (nil? result))
-  (def m (peg/match '(* "foo: " (<- (some :S)) " seconds\n" -1) output))
-  (assert (truthy? m) "timeit -- invalid output")
-  (assert (scan-number (in m 0)) "timeit -- invalid number of seconds"))
-
-(do
-  (def [result output]
-    (capture-stdout
-      (misc/timeit "someresult")))
-  (assert (= result "someresult") "timeit2 -- invalid return")
-  (def m (peg/match '(* "Elapsed time: " (<- (some :S)) " seconds\n" -1) output))
-  (assert (truthy? m) "timeit2 -- invalid output")
-  (assert (scan-number (in m 0)) "timeit2 -- invalid number of seconds"))
-
 #misc/set*
 (do
   (var x 2)

test/suite2.janet

@@ -1,4 +1,4 @@
-(use ./helper)
+(use ../spork/test)
 (import ../spork/rpc)
 
 (start-suite 2)

test/suite3.janet

@@ -1,4 +1,4 @@
-(use ./helper)
+(use ../spork/test)
 (import ../spork/msg)
 
 (start-suite 3)

test/suite4.janet

@@ -1,4 +1,4 @@
-(use ./helper)
+(use ../spork/test)
 (import ../spork/regex)
 
 (start-suite 4)