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.
16 :documentation "Lookup table mapping test (and test suite)
20 (loop for test being the hash-keys of *test*
23 (defmacro test (name &body body)
24 "Create a test named NAME. If NAME is a list it must be of the
27 (name &key depends-on suite fixture compile-at)
29 NAME is the symbol which names the test.
31 DEPENDS-ON is a list of the form:
33 (AND . test-names) - This test is run only if all of the tests
34 in TEST-NAMES have passed, otherwise a single test-skipped
37 (OR . test-names) - If any of TEST-NAMES has passed this test is
38 run, otherwise a test-skipped result is generated.
40 (NOT test-name) - This is test is run only if TEST-NAME failed.
42 AND, OR and NOT can be combined to produce complex dependencies.
44 If DEPENDS-ON is a symbol it is interpreted as `(AND
45 ,depends-on), this is accomadate the common case of one test
48 SUITE defaults to the current value of *SUITE*.
50 FIXTURE specifies a fixtrue to wrap the body in."
51 (destructuring-bind (name &key depends-on (suite nil suite-supplied-p)
52 (compile-at :run-time) fixture)
54 (declare (type (member :run-time :definition-time) compile-at))
55 (let ((description (if (stringp (car body))
58 (effective-body (if fixture
59 (destructuring-bind (name &rest args)
61 `((with-fixture ,name ,args ,@body)))
64 (setf (get-test ',name) (make-instance 'test-case
66 :runtime-package ,*package*
71 (let ((*package* (find-package ',(package-name *package*))))
72 (compile nil '(lambda ()
73 ,@effective-body))))))
74 (:definition-time effective-body)))
75 :description ,description
76 :depends-on ',depends-on))
78 `(setf (gethash ',name (tests (get-test ',suite)))
80 `(setf (gethash ',name (tests (or *suite* (get-test 'NIL))))
82 (when *run-test-when-defined*
86 (defvar *run-test-when-defined* nil
87 "When non-NIL tests are run as soon as they are defined.")
89 ;; Copyright (c) 2002-2003, Edward Marco Baringer
90 ;; All rights reserved.
92 ;; Redistribution and use in source and binary forms, with or without
93 ;; modification, are permitted provided that the following conditions are
96 ;; - Redistributions of source code must retain the above copyright
97 ;; notice, this list of conditions and the following disclaimer.
99 ;; - Redistributions in binary form must reproduce the above copyright
100 ;; notice, this list of conditions and the following disclaimer in the
101 ;; documentation and/or other materials provided with the distribution.
103 ;; - Neither the name of Edward Marco Baringer, nor BESE, nor the names
104 ;; of its contributors may be used to endorse or promote products
105 ;; derived from this software without specific prior written permission.
107 ;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
108 ;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
109 ;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
110 ;; A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
111 ;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
112 ;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
113 ;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
114 ;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
115 ;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
116 ;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
117 ;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.