1 ;;;; -*- Mode: Lisp; indent-tabs-mode: nil -*-
3 (in-package :it.bese.fiveam)
7 ;;;; While executing checks and collecting the results is the core job
8 ;;;; of a testing framework it is also important to be able to
9 ;;;; organize checks into groups, fiveam provides two mechanisms for
10 ;;;; organizing checks: tests and test suites. A test is a named
11 ;;;; collection of checks which can be run and a test suite is a named
12 ;;;; collection of tests and test suites.
15 (make-hash-table :test 'eql)
16 "Lookup table mapping test (and test suite)
19 (defun get-test (key &optional default)
20 (gethash key *test* default))
22 (defun (setf get-test) (value key)
23 (setf (gethash key *test*) value))
29 (loop for test being the hash-keys of *test*
32 (defmacro test (name &body body)
33 "Create a test named NAME. If NAME is a list it must be of the
36 (name &key depends-on suite fixture compile-at profile)
38 NAME is the symbol which names the test.
40 DEPENDS-ON is a list of the form:
42 (AND . test-names) - This test is run only if all of the tests
43 in TEST-NAMES have passed, otherwise a single test-skipped
46 (OR . test-names) - If any of TEST-NAMES has passed this test is
47 run, otherwise a test-skipped result is generated.
49 (NOT test-name) - This is test is run only if TEST-NAME failed.
51 AND, OR and NOT can be combined to produce complex dependencies.
53 If DEPENDS-ON is a symbol it is interpreted as `(AND
54 ,depends-on), this is accomadate the common case of one test
57 FIXTURE specifies a fixture to wrap the body in.
59 If PROFILE is T profiling information will be collected as well."
60 (destructuring-bind (name &rest args)
62 `(def-test ,name (,@args) ,@body)))
64 (defmacro def-test (name (&key depends-on (suite '*suite* suite-p) fixture
65 (compile-at :run-time) profile)
67 "Create a test named NAME.
69 NAME is the symbol which names the test.
71 DEPENDS-ON is a list of the form:
73 (AND . test-names) - This test is run only if all of the tests
74 in TEST-NAMES have passed, otherwise a single test-skipped
77 (OR . test-names) - If any of TEST-NAMES has passed this test is
78 run, otherwise a test-skipped result is generated.
80 (NOT test-name) - This is test is run only if TEST-NAME failed.
82 AND, OR and NOT can be combined to produce complex dependencies.
84 If DEPENDS-ON is a symbol it is interpreted as `(AND
85 ,depends-on), this is accomadate the common case of one test
88 FIXTURE specifies a fixture to wrap the body in.
90 If PROFILE is T profiling information will be collected as well."
91 (check-type compile-at (member :run-time :definition-time))
92 (multiple-value-bind (forms decls docstring)
93 (parse-body body :documentation t :whole name)
94 (let* ((description (or docstring ""))
95 (body-forms (append decls forms))
96 (suite-form (if suite-p
99 (effective-body (if fixture
100 (destructuring-bind (name &rest args)
101 (ensure-list fixture)
102 `((with-fixture ,name ,args ,@body-forms)))
105 (register-test ',name ,description ',effective-body ,suite-form ',depends-on ,compile-at ,profile)
106 (when *run-test-when-defined*
110 (defun register-test (name description body suite depends-on compile-at profile)
112 (format-symbol t "%~A-~A" '#:test name))
114 (format-symbol t "%~A-~A" '#:inner-test name)))
115 (setf (get-test name)
116 (make-instance 'test-case
118 :runtime-package (find-package (package-name *package*))
121 `(named-lambda ,lambda-name ()
123 (:run-time `((funcall
124 (let ((*package* (find-package ',(package-name *package*))))
125 (compile ',inner-lambda-name
126 '(lambda () ,@body))))))
127 (:definition-time body))))
128 :description description
129 :depends-on depends-on
130 :collect-profiling-info profile))
131 (setf (gethash name (tests suite)) name)))
133 (defvar *run-test-when-defined* nil
134 "When non-NIL tests are run as soon as they are defined.")
136 ;; Copyright (c) 2002-2003, Edward Marco Baringer
137 ;; All rights reserved.
139 ;; Redistribution and use in source and binary forms, with or without
140 ;; modification, are permitted provided that the following conditions are
143 ;; - Redistributions of source code must retain the above copyright
144 ;; notice, this list of conditions and the following disclaimer.
146 ;; - Redistributions in binary form must reproduce the above copyright
147 ;; notice, this list of conditions and the following disclaimer in the
148 ;; documentation and/or other materials provided with the distribution.
150 ;; - Neither the name of Edward Marco Baringer, nor BESE, nor the names
151 ;; of its contributors may be used to endorse or promote products
152 ;; derived from this software without specific prior written permission.
154 ;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
155 ;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
156 ;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
157 ;; A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
158 ;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
159 ;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
160 ;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
161 ;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
162 ;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
163 ;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
164 ;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.