1 ;;;; test-suite/lib.scm --- generic support for testing
2 ;;;; Copyright (C) 1999, 2000, 2001, 2004, 2006, 2007 Free Software Foundation, Inc.
4 ;;;; This program is free software; you can redistribute it and/or modify
5 ;;;; it under the terms of the GNU General Public License as published by
6 ;;;; the Free Software Foundation; either version 2, or (at your option)
7 ;;;; any later version.
9 ;;;; This program is distributed in the hope that it will be useful,
10 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
11 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 ;;;; GNU General Public License for more details.
14 ;;;; You should have received a copy of the GNU General Public License
15 ;;;; along with this software; see the file COPYING. If not, write to
16 ;;;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17 ;;;; Boston, MA 02110-1301 USA
19 (define-module (test-suite lib)
20 :use-module (ice-9 stack-catch)
21 :use-module (ice-9 regex)
24 ;; Exceptions which are commonly being tested for.
25 exception:bad-variable
26 exception:missing-expression
27 exception:out-of-range exception:unbound-var
28 exception:used-before-defined
29 exception:wrong-num-args exception:wrong-type-arg
30 exception:numerical-overflow
31 exception:struct-set!-denied
32 exception:system-error
33 exception:miscellaneous-error
34 exception:string-contains-nul
36 ;; Reporting passes and failures.
39 pass-if-exception expect-fail-exception
41 ;; Naming groups of tests in a regular fashion.
42 with-test-prefix with-test-prefix* current-test-prefix
45 ;; Using the debugging evaluator.
46 with-debugging-evaluator with-debugging-evaluator*
48 ;; Reporting results in various ways.
49 register-reporter unregister-reporter reporter-registered?
50 make-count-reporter print-counts
56 ;;;; If you're using Emacs's Scheme mode:
57 ;;;; (put 'with-test-prefix 'scheme-indent-function 1)
62 ;;;; The function (run-test name expected-result thunk) is the heart of the
63 ;;;; testing environment. The first parameter NAME is a unique name for the
64 ;;;; test to be executed (for an explanation of this parameter see below under
65 ;;;; TEST NAMES). The second parameter EXPECTED-RESULT is a boolean value
66 ;;;; that indicates whether the corresponding test is expected to pass. If
67 ;;;; EXPECTED-RESULT is #t the test is expected to pass, if EXPECTED-RESULT is
68 ;;;; #f the test is expected to fail. Finally, THUNK is the function that
69 ;;;; actually performs the test. For example:
71 ;;;; (run-test "integer addition" #t (lambda () (= 2 (+ 1 1))))
73 ;;;; To report success, THUNK should either return #t or throw 'pass. To
74 ;;;; report failure, THUNK should either return #f or throw 'fail. If THUNK
75 ;;;; returns a non boolean value or throws 'unresolved, this indicates that
76 ;;;; the test did not perform as expected. For example the property that was
77 ;;;; to be tested could not be tested because something else went wrong.
78 ;;;; THUNK may also throw 'untested to indicate that the test was deliberately
79 ;;;; not performed, for example because the test case is not complete yet.
80 ;;;; Finally, if THUNK throws 'unsupported, this indicates that this test
81 ;;;; requires some feature that is not available in the configured testing
82 ;;;; environment. All other exceptions thrown by THUNK are considered as
86 ;;;; Convenience macros for tests expected to pass or fail
88 ;;;; * (pass-if name body) is a short form for
89 ;;;; (run-test name #t (lambda () body))
90 ;;;; * (expect-fail name body) is a short form for
91 ;;;; (run-test name #f (lambda () body))
95 ;;;; (pass-if "integer addition" (= 2 (+ 1 1)))
98 ;;;; Convenience macros to test for exceptions
100 ;;;; The following macros take exception parameters which are pairs
101 ;;;; (type . message), where type is a symbol that denotes an exception type
102 ;;;; like 'wrong-type-arg or 'out-of-range, and message is a string holding a
103 ;;;; regular expression that describes the error message for the exception
104 ;;;; like "Argument .* out of range".
106 ;;;; * (pass-if-exception name exception body) will pass if the execution of
107 ;;;; body causes the given exception to be thrown. If no exception is
108 ;;;; thrown, the test fails. If some other exception is thrown, is is an
110 ;;;; * (expect-fail-exception name exception body) will pass unexpectedly if
111 ;;;; the execution of body causes the given exception to be thrown. If no
112 ;;;; exception is thrown, the test fails expectedly. If some other
113 ;;;; exception is thrown, it is an error.
118 ;;;; Every test in the test suite has a unique name, to help
119 ;;;; developers find tests that are failing (or unexpectedly passing),
120 ;;;; and to help gather statistics.
122 ;;;; A test name is a list of printable objects. For example:
123 ;;;; ("ports.scm" "file" "read and write back list of strings")
124 ;;;; ("ports.scm" "pipe" "read")
126 ;;;; Test names may contain arbitrary objects, but they always have
127 ;;;; the following properties:
128 ;;;; - Test names can be compared with EQUAL?.
129 ;;;; - Test names can be reliably stored and retrieved with the standard WRITE
130 ;;;; and READ procedures; doing so preserves their identity.
134 ;;;; (pass-if "simple addition" (= 4 (+ 2 2)))
136 ;;;; In that case, the test name is the list ("simple addition").
138 ;;;; In the case of simple tests the expression that is tested would often
139 ;;;; suffice as a test name by itself. Therefore, the convenience macros
140 ;;;; pass-if and expect-fail provide a shorthand notation that allows to omit
141 ;;;; a test name in such cases.
143 ;;;; * (pass-if expression) is a short form for
144 ;;;; (run-test 'expression #t (lambda () expression))
145 ;;;; * (expect-fail expression) is a short form for
146 ;;;; (run-test 'expression #f (lambda () expression))
150 ;;;; (pass-if (= 2 (+ 1 1)))
152 ;;;; The WITH-TEST-PREFIX syntax and WITH-TEST-PREFIX* procedure establish
153 ;;;; a prefix for the names of all tests whose results are reported
154 ;;;; within their dynamic scope. For example:
157 ;;;; (with-test-prefix "basic arithmetic"
158 ;;;; (pass-if "addition" (= (+ 2 2) 4))
159 ;;;; (pass-if "subtraction" (= (- 4 2) 2)))
160 ;;;; (pass-if "multiplication" (= (* 2 2) 4)))
162 ;;;; In that example, the three test names are:
163 ;;;; ("basic arithmetic" "addition"),
164 ;;;; ("basic arithmetic" "subtraction"), and
165 ;;;; ("multiplication").
167 ;;;; WITH-TEST-PREFIX can be nested. Each WITH-TEST-PREFIX postpends
168 ;;;; a new element to the current prefix:
170 ;;;; (with-test-prefix "arithmetic"
171 ;;;; (with-test-prefix "addition"
172 ;;;; (pass-if "integer" (= (+ 2 2) 4))
173 ;;;; (pass-if "complex" (= (+ 2+3i 4+5i) 6+8i)))
174 ;;;; (with-test-prefix "subtraction"
175 ;;;; (pass-if "integer" (= (- 2 2) 0))
176 ;;;; (pass-if "complex" (= (- 2+3i 1+2i) 1+1i))))
178 ;;;; The four test names here are:
179 ;;;; ("arithmetic" "addition" "integer")
180 ;;;; ("arithmetic" "addition" "complex")
181 ;;;; ("arithmetic" "subtraction" "integer")
182 ;;;; ("arithmetic" "subtraction" "complex")
184 ;;;; To print a name for a human reader, we DISPLAY its elements,
185 ;;;; separated by ": ". So, the last set of test names would be
188 ;;;; arithmetic: addition: integer
189 ;;;; arithmetic: addition: complex
190 ;;;; arithmetic: subtraction: integer
191 ;;;; arithmetic: subtraction: complex
193 ;;;; The Guile benchmarks use with-test-prefix to include the name of
194 ;;;; the source file containing the test in the test name, to help
195 ;;;; developers to find failing tests, and to provide each file with its
201 ;;;; A reporter is a function which we apply to each test outcome.
202 ;;;; Reporters can log results, print interesting results to the
203 ;;;; standard output, collect statistics, etc.
205 ;;;; A reporter function takes two mandatory arguments, RESULT and TEST, and
206 ;;;; possibly additional arguments depending on RESULT; its return value
207 ;;;; is ignored. RESULT has one of the following forms:
209 ;;;; pass - The test named TEST passed.
210 ;;;; Additional arguments are ignored.
211 ;;;; upass - The test named TEST passed unexpectedly.
212 ;;;; Additional arguments are ignored.
213 ;;;; fail - The test named TEST failed.
214 ;;;; Additional arguments are ignored.
215 ;;;; xfail - The test named TEST failed, as expected.
216 ;;;; Additional arguments are ignored.
217 ;;;; unresolved - The test named TEST did not perform as expected, for
218 ;;;; example the property that was to be tested could not be
219 ;;;; tested because something else went wrong.
220 ;;;; Additional arguments are ignored.
221 ;;;; untested - The test named TEST was not actually performed, for
222 ;;;; example because the test case is not complete yet.
223 ;;;; Additional arguments are ignored.
224 ;;;; unsupported - The test named TEST requires some feature that is not
225 ;;;; available in the configured testing environment.
226 ;;;; Additional arguments are ignored.
227 ;;;; error - An error occurred while the test named TEST was
228 ;;;; performed. Since this result means that the system caught
229 ;;;; an exception it could not handle, the exception arguments
230 ;;;; are passed as additional arguments.
232 ;;;; This library provides some standard reporters for logging results
233 ;;;; to a file, reporting interesting results to the user, and
234 ;;;; collecting totals.
236 ;;;; You can use the REGISTER-REPORTER function and friends to add
237 ;;;; whatever reporting functions you like. If you don't register any
238 ;;;; reporters, the library uses FULL-REPORTER, which simply writes
239 ;;;; all results to the standard output.
245 ;;; Define some exceptions which are commonly being tested for.
246 (define exception:bad-variable
247 (cons 'syntax-error "Bad variable"))
248 (define exception:missing-expression
249 (cons 'misc-error "^missing or extra expression"))
250 (define exception:out-of-range
251 (cons 'out-of-range "^.*out of range"))
252 (define exception:unbound-var
253 (cons 'unbound-variable "^Unbound variable"))
254 (define exception:used-before-defined
255 (cons 'unbound-variable "^Variable used before given a value"))
256 (define exception:wrong-num-args
257 (cons 'wrong-number-of-args "^Wrong number of arguments"))
258 (define exception:wrong-type-arg
259 (cons 'wrong-type-arg "^Wrong type"))
260 (define exception:numerical-overflow
261 (cons 'numerical-overflow "^Numerical overflow"))
262 (define exception:struct-set!-denied
263 (cons 'misc-error "^set! denied for field"))
264 (define exception:system-error
265 (cons 'system-error ".*"))
266 (define exception:miscellaneous-error
267 (cons 'misc-error "^.*"))
269 ;; as per throw in scm_to_locale_stringn()
270 (define exception:string-contains-nul
271 (cons 'misc-error "^string contains #\\\\nul character"))
274 ;;; Display all parameters to the default output port, followed by a newline.
275 (define (display-line . objs)
276 (for-each display objs)
279 ;;; Display all parameters to the given output port, followed by a newline.
280 (define (display-line-port port . objs)
281 (for-each (lambda (obj) (display obj port)) objs)
288 ;;; The central testing routine.
289 ;;; The idea is taken from Greg, the GNUstep regression test environment.
291 (let ((test-running #f))
292 (define (local-run-test name expect-pass thunk)
294 (error "Nested calls to run-test are not permitted.")
295 (let ((test-name (full-name name)))
296 (set! test-running #t)
299 (let ((result (thunk)))
300 (if (eq? result #t) (throw 'pass))
301 (if (eq? result #f) (throw 'fail))
302 (throw 'unresolved)))
306 (report (if expect-pass 'pass 'upass) test-name))
308 (report (if expect-pass 'fail 'xfail) test-name))
309 ((unresolved untested unsupported)
310 (report key test-name))
312 (report 'unresolved test-name)
315 (report 'error test-name (cons key args))))))
316 (set! test-running #f))))
317 (set! run-test local-run-test))
319 ;;; A short form for tests that are expected to pass, taken from Greg.
320 (defmacro pass-if (name . rest)
321 (if (and (null? rest) (pair? name))
322 ;; presume this is a simple test, i.e. (pass-if (even? 2))
323 ;; where the body should also be the name.
324 `(run-test ',name #t (lambda () ,name))
325 `(run-test ,name #t (lambda () ,@rest))))
327 ;;; A short form for tests that are expected to fail, taken from Greg.
328 (defmacro expect-fail (name . rest)
329 (if (and (null? rest) (pair? name))
330 ;; presume this is a simple test, i.e. (expect-fail (even? 2))
331 ;; where the body should also be the name.
332 `(run-test ',name #f (lambda () ,name))
333 `(run-test ,name #f (lambda () ,@rest))))
335 ;;; A helper function to implement the macros that test for exceptions.
336 (define (run-test-exception name exception expect-pass thunk)
337 (run-test name expect-pass
339 (stack-catch (car exception)
340 (lambda () (thunk) #f)
341 (lambda (key proc message . rest)
343 ;; handle explicit key
344 ((string-match (cdr exception) message)
346 ;; handle `(error ...)' which uses `misc-error' for key and doesn't
347 ;; yet format the message and args (we have to do it here).
348 ((and (eq? 'misc-error (car exception))
350 (string-match (cdr exception)
351 (apply simple-format #f message (car rest))))
353 ;; handle syntax errors which use `syntax-error' for key and don't
354 ;; yet format the message and args (we have to do it here).
355 ((and (eq? 'syntax-error (car exception))
357 (string-match (cdr exception)
358 (apply simple-format #f message (car rest))))
360 ;; unhandled; throw again
362 (apply throw key proc message rest))))))))
364 ;;; A short form for tests that expect a certain exception to be thrown.
365 (defmacro pass-if-exception (name exception body . rest)
366 `(,run-test-exception ,name ,exception #t (lambda () ,body ,@rest)))
368 ;;; A short form for tests expected to fail to throw a certain exception.
369 (defmacro expect-fail-exception (name exception body . rest)
370 `(,run-test-exception ,name ,exception #f (lambda () ,body ,@rest)))
376 ;;;; Turn a test name into a nice human-readable string.
377 (define (format-test-name name)
378 (call-with-output-string
380 (let loop ((name name)
384 (display separator port)
385 (display (car name) port)
386 (loop (cdr name) ": ")))))))
388 ;;;; For a given test-name, deliver the full name including all prefixes.
389 (define (full-name name)
390 (append (current-test-prefix) (list name)))
392 ;;; A fluid containing the current test prefix, as a list.
393 (define prefix-fluid (make-fluid))
394 (fluid-set! prefix-fluid '())
395 (define (current-test-prefix)
396 (fluid-ref prefix-fluid))
398 ;;; Postpend PREFIX to the current name prefix while evaluting THUNK.
399 ;;; The name prefix is only changed within the dynamic scope of the
400 ;;; call to with-test-prefix*. Return the value returned by THUNK.
401 (define (with-test-prefix* prefix thunk)
402 (with-fluids ((prefix-fluid
403 (append (fluid-ref prefix-fluid) (list prefix))))
406 ;;; (with-test-prefix PREFIX BODY ...)
407 ;;; Postpend PREFIX to the current name prefix while evaluating BODY ...
408 ;;; The name prefix is only changed within the dynamic scope of the
409 ;;; with-test-prefix expression. Return the value returned by the last
411 (defmacro with-test-prefix (prefix . body)
412 `(with-test-prefix* ,prefix (lambda () ,@body)))
414 ;;; Call THUNK using the debugging evaluator.
415 (define (with-debugging-evaluator* thunk)
419 (set! dopts (debug-options))
420 (debug-enable 'debug))
423 (debug-options dopts)))))
425 ;;; Evaluate BODY... using the debugging evaluator.
426 (define-macro (with-debugging-evaluator . body)
427 `(with-debugging-evaluator* (lambda () ,@body)))
434 ;;; The global list of reporters.
435 (define reporters '())
437 ;;; The default reporter, to be used only if no others exist.
438 (define default-reporter #f)
440 ;;; Add the procedure REPORTER to the current set of reporter functions.
441 ;;; Signal an error if that reporter procedure object is already registered.
442 (define (register-reporter reporter)
443 (if (memq reporter reporters)
444 (error "register-reporter: reporter already registered: " reporter))
445 (set! reporters (cons reporter reporters)))
447 ;;; Remove the procedure REPORTER from the current set of reporter
448 ;;; functions. Signal an error if REPORTER is not currently registered.
449 (define (unregister-reporter reporter)
450 (if (memq reporter reporters)
451 (set! reporters (delq! reporter reporters))
452 (error "unregister-reporter: reporter not registered: " reporter)))
454 ;;; Return true iff REPORTER is in the current set of reporter functions.
455 (define (reporter-registered? reporter)
456 (if (memq reporter reporters) #t #f))
458 ;;; Send RESULT to all currently registered reporter functions.
459 (define (report . args)
460 (if (pair? reporters)
461 (for-each (lambda (reporter) (apply reporter args))
463 (apply default-reporter args)))
466 ;;;; Some useful standard reporters:
467 ;;;; Count reporters count the occurrence of each test result type.
468 ;;;; Log reporters write all test results to a given log file.
469 ;;;; Full reporters write all test results to the standard output.
470 ;;;; User reporters write interesting test results to the standard output.
472 ;;; The complete list of possible test results.
474 '((pass "PASS" "passes: ")
475 (fail "FAIL" "failures: ")
476 (upass "UPASS" "unexpected passes: ")
477 (xfail "XFAIL" "expected failures: ")
478 (unresolved "UNRESOLVED" "unresolved test cases: ")
479 (untested "UNTESTED" "untested test cases: ")
480 (unsupported "UNSUPPORTED" "unsupported test cases: ")
481 (error "ERROR" "errors: ")))
483 ;;; The list of important test results.
484 (define important-result-tags
485 '(fail upass unresolved error))
487 ;;; Display a single test result in formatted form to the given port
488 (define (print-result port result name . args)
489 (let* ((tag (assq result result-tags))
490 (label (if tag (cadr tag) #f)))
495 (display (format-test-name name) port)
498 (display " - arguments: " port)
501 (error "(test-suite lib) FULL-REPORTER: unrecognized result: "
504 ;;; Return a list of the form (COUNTER RESULTS), where:
505 ;;; - COUNTER is a reporter procedure, and
506 ;;; - RESULTS is a procedure taking no arguments which returns the
507 ;;; results seen so far by COUNTER. The return value is an alist
508 ;;; mapping outcome symbols (`pass', `fail', etc.) onto counts.
509 (define (make-count-reporter)
510 (let ((counts (map (lambda (tag) (cons (car tag) 0)) result-tags)))
512 (lambda (result name . args)
513 (let ((pair (assq result counts)))
515 (set-cdr! pair (+ 1 (cdr pair)))
516 (error "count-reporter: unexpected test result: "
517 (cons result (cons name args))))))
519 (append counts '())))))
521 ;;; Print a count reporter's results nicely. Pass this function the value
522 ;;; returned by a count reporter's RESULTS procedure.
523 (define (print-counts results . port?)
524 (let ((port (if (pair? port?)
526 (current-output-port))))
528 (display-line-port port "Totals for this test run:")
531 (let ((result (assq (car tag) results)))
533 (display-line-port port (caddr tag) (cdr result))
534 (display-line-port port
536 "no total available for `" (car tag) "'"))))
540 ;;; Return a reporter procedure which prints all results to the file
541 ;;; FILE, in human-readable form. FILE may be a filename, or a port.
542 (define (make-log-reporter file)
543 (let ((port (if (output-port? file) file
544 (open-output-file file))))
546 (apply print-result port args)
547 (force-output port))))
549 ;;; A reporter that reports all results to the user.
550 (define (full-reporter . args)
551 (apply print-result (current-output-port) args))
553 ;;; A reporter procedure which shows interesting results (failures,
554 ;;; unexpected passes etc.) to the user.
555 (define (user-reporter result name . args)
556 (if (memq result important-result-tags)
557 (apply full-reporter result name args)))
559 (set! default-reporter full-reporter)