diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 45 |
1 files changed, 38 insertions, 7 deletions
@@ -12,13 +12,15 @@ during interactive development! A work in progress. But here is the basic idea: - (defun/t fibble (x y &key (z 10)) - "Hey, a docstring." + (defun/t sum-3 (x y &key (z 10)) + "Sums three numbers, Z has a default value of 10" :tests - (= (1 2) 13) - (>= (1 2 :z 1) -5) - (:outputp (0 0 :z 0) (lambda (result) (equalp result 0))) - (:fails ("strings" "ain't" :z "numbers")) + (= (1 2) 13) ; (sum-3 1 2) == 13 + (= (1 2 :z 3) 6) ; (sum-3 1 2 :z 3) == 6 + (:output (0 0) ; tests that (sum-3 0 0) passes the predicate + (lambda (result) (= 10 result))) + (:fails ; ensures that (sum-3 "strings" "ain't" :z "numbers") fails + ("strings" "ain't" :z "numbers")) :end (+ x y z)) @@ -38,7 +40,7 @@ it to a VALUE. For example, `(>= (1 2 :z 1) -5)` runs the test - (assert (>= (fibble 1 2 :z 1) -5)) + (assert (>= (sum-3 1 2 :z 1) -5)) ## additional tests @@ -54,6 +56,10 @@ Where `TERM` varies according to the `KEYWORD` supplied. A few of these are +- `(:program FUNCTION-NAME ARGS...)` runs a funcion named + FUNCTION-NAME with arguments ARGS. This function is meant to act as + a test suite for the function being defined with defun/t. It may + call that function and ASSERT things about it. - `(:outputp (..ARGS...) PREDICATE)` asserts that the output passes the one-argument predicate. - `(:afterp (...ARGS...) THUNK)` asserts that the thunk should return @@ -109,3 +115,28 @@ questions. Useful for mocking. In the above, the temporary redefinition of JUST-A-FUNCTION is used. +# `WITH-STUBS` and `:PROGRAM` Style Tests + +By using the `:program` test and the `with-stubs` macro, you can +define just about any kind of test. In the following, you use +`with-stubs` to mock a function that makes an http request and returns +a string. + + + (defun test-url-word-counter () + "Stub the function that makes requests that word-counter uses, and then test word counter." + (with-stubs + ((make-drakma-request () "one two three four five six seven")) + (assert (= (count-words) 7)))) + + (defun/t count-words () + "Fetches a url and counts now many words the page contains." + :tests + (:program test-url-word-counter) + :end + (let ((fetched + (make-drakma-request))) + (1+ (count #\space fetched)))) + + +If `test-url-word-counter` fails, `count-words` isn't defined. |