1 ;;;; -*- Mode: Lisp; indent-tabs-mode: nil -*-
3 (in-package :it.bese.fiveam)
7 ;;;; Once the programmer has defined what the tests are these need to
8 ;;;; be run and the expected effects should be compared with the
9 ;;;; actual effects. FiveAM provides the function RUN for this
10 ;;;; purpose, RUN executes a number of tests and collects the results
11 ;;;; of each individual check into a list which is then
12 ;;;; returned. There are three types of test results: passed, failed
13 ;;;; and skipped, these are represented by TEST-RESULT objects.
15 ;;;; Generally running a test will return normally, but there are two
16 ;;;; exceptional situations which can occur:
18 ;;;; - An exception is signaled while running the test. If the
19 ;;;; variable *debug-on-error* is T than FiveAM will enter the
20 ;;;; debugger, otherwise a test failure (of type
21 ;;;; unexpected-test-failure) is returned. When entering the
22 ;;;; debugger two restarts are made available, one simply reruns the
23 ;;;; current test and another signals a test-failure and continues
24 ;;;; with the remaining tests.
26 ;;;; - A circular dependency is detected. An error is signaled and a
27 ;;;; restart is made available which signals a test-skipped and
28 ;;;; continues with the remaining tests. This restart also sets the
29 ;;;; dependency status of the test to nil, so any tests which depend
30 ;;;; on this one (even if the dependency is not circular) will be
33 ;;;; The functions RUN!, !, !! and !!! are convenient wrappers around
36 (defparameter *debug-on-error* nil
37 "T if we should drop into a debugger on error, NIL otherwise.")
39 (defparameter *debug-on-failure* nil
40 "T if we should drop into a debugger on a failing check, NIL otherwise.")
42 (defun import-testing-symbols (package-designator)
43 (import '(5am::is 5am::is-true 5am::is-false 5am::signals 5am::finishes)
46 (defparameter *run-queue* '()
47 "List of test waiting to be run.")
49 (define-condition circular-dependency (error)
50 ((test-case :initarg :test-case))
51 (:report (lambda (cd stream)
52 (format stream "A circular dependency wes detected in ~S." (slot-value cd 'test-case))))
53 (:documentation "Condition signaled when a circular dependency
54 between test-cases has been detected."))
56 (defgeneric run-resolving-dependencies (test)
57 (:documentation "Given a dependency spec determine if the spec
58 is satisfied or not, this will generally involve running other
59 tests. If the dependency spec can be satisfied the test is also
62 (defmethod run-resolving-dependencies ((test test-case))
63 "Return true if this test, and its dependencies, are satisfied,
67 (setf (status test) :resolving)
68 (if (or (not (depends-on test))
69 (eql t (resolve-dependencies (depends-on test))))
71 (run-test-lambda test)
73 (with-run-state (result-list)
74 (unless (eql :circular (status test))
75 (push (make-instance 'test-skipped
77 :reason "Dependencies not satisfied")
79 (setf (status test) :depends-not-satisfied)))))
82 (error 'circular-dependency :test-case test)
85 (format s "Skip the test ~S and all its dependencies." (name test)))
86 (with-run-state (result-list)
87 (push (make-instance 'test-skipped :reason "Circular dependencies" :test-case test)
89 (setf (status test) :circular))))
92 (defgeneric resolve-dependencies (depends-on))
94 (defmethod resolve-dependencies ((depends-on symbol))
95 "A test which depends on a symbol is interpreted as `(AND
97 (run-resolving-dependencies (get-test depends-on)))
99 (defmethod resolve-dependencies ((depends-on list))
100 "Return true if the dependency spec DEPENDS-ON is satisfied,
102 (if (null depends-on)
104 (flet ((satisfies-depends-p (test)
105 (funcall test (lambda (dep)
106 (eql t (resolve-dependencies dep)))
108 (ecase (car depends-on)
109 (and (satisfies-depends-p #'every))
110 (or (satisfies-depends-p #'some))
111 (not (satisfies-depends-p #'notany))
112 (:before (every #'(lambda (dep)
113 (let ((status (status (get-test dep))))
114 (eql :unknown status)))
115 (cdr depends-on)))))))
117 (defun results-status (result-list)
118 "Given a list of test results (generated while running a test)
119 return true if all of the results are of type TEST-PASSED,
122 (typep res 'test-passed))
125 (defun return-result-list (test-lambda)
126 "Run the test function TEST-LAMBDA and return a list of all
127 test results generated, does not modify the special environment
128 variable RESULT-LIST."
129 (bind-run-state ((result-list '()))
130 (funcall test-lambda)
133 (defgeneric run-test-lambda (test))
135 (defmethod run-test-lambda ((test test-case))
136 (with-run-state (result-list)
137 (bind-run-state ((current-test test))
138 (labels ((abort-test (e)
139 (add-result 'unexpected-test-failure
142 :reason (format nil "Unexpected Error: ~S~%~A." e e)
145 (let ((result-list '()))
146 (declare (special result-list))
147 (handler-bind ((check-failure (lambda (e)
149 (unless *debug-on-failure*
151 (find-restart 'ignore-failure)))))
153 (unless (or *debug-on-error*
154 (typep e 'check-failure))
156 (return-from run-it result-list)))))
158 (let ((*readtable* (copy-readtable))
159 (*package* (runtime-package test)))
160 (if (collect-profiling-info test)
161 ;; Timing info doesn't get collected ATM, we need a portable library
162 ;; (setf (profiling-info test) (collect-timing (test-lambda test)))
163 (funcall (test-lambda test))
164 (funcall (test-lambda test))))
166 :report (lambda (stream)
167 (format stream "~@<Rerun the test ~S~@:>" test))
168 (return-from run-it (run-it)))
170 :report (lambda (stream)
171 (format stream "~@<Signal an exceptional test failure and abort the test ~S.~@:>" test))
172 (abort-test (make-instance 'test-failure :test-case test
173 :reason "Failure restart."))))
175 (let ((results (run-it)))
176 (setf (status test) (results-status results)
177 result-list (nconc result-list results)))))))
179 (defgeneric %run (test-spec)
180 (:documentation "Internal method for running a test. Does not
181 update the status of the tests nor the special variables !,
184 (defmethod %run ((test test-case))
185 (run-resolving-dependencies test))
187 (defmethod %run ((tests list))
190 (defmethod %run ((suite test-suite))
191 (let ((suite-results '()))
194 for test being the hash-values of (tests suite)
197 (bind-run-state ((result-list '()))
199 (if (collect-profiling-info suite)
200 ;; Timing info doesn't get collected ATM, we need a portable library
201 ;; (setf (profiling-info suite) (collect-timing #'run-tests))
204 (setf suite-results result-list
205 (status suite) (every (lambda (res)
206 (typep res 'test-passed))
208 (with-run-state (result-list)
209 (setf result-list (nconc result-list suite-results)))))))
211 (defmethod %run ((test-name symbol))
212 (when-let (test (get-test test-name))
215 (defvar *initial-!* (lambda () (format t "Haven't run that many tests yet.~%")))
217 (defvar *!* *initial-!*)
218 (defvar *!!* *initial-!*)
219 (defvar *!!!* *initial-!*)
221 ;;;; ** Public entry points
223 (defun run! (&optional (test-spec *suite*))
224 "Equivalent to (explain! (run TEST-SPEC))."
225 (explain! (run test-spec)))
227 (defun explain! (result-list)
228 "Explain the results of RESULT-LIST using a
229 detailed-text-explainer with output going to *test-dribble*"
230 (explain (make-instance 'detailed-text-explainer) result-list *test-dribble*))
232 (defun debug! (&optional (test-spec *suite*))
233 "Calls (run! test-spec) but enters the debugger if any kind of error happens."
234 (let ((*debug-on-error* t)
235 (*debug-on-failure* t))
238 (defun reset-all-tests-status (&optional (tests *test*))
239 "Resets the status of all TESTS to :unknown."
242 (setf (status test) :unknown))
245 (defun run-and-set-recently (function)
246 "Shifts the recently executed tests and lastly executes FUNCTION."
247 (shiftf *!!!* *!!* *!* function)
250 (defun run-and-bind-result-list (function)
251 (run-and-set-recently
253 (reset-all-tests-status)
254 (bind-run-state ((result-list '()))
256 (explain "Ignore the rest of the tests and explain current results")
260 (defun run (test-spec)
261 "Run the test specified by TEST-SPEC.
263 TEST-SPEC can be either a symbol naming a test or test suite, or
264 a testable-object object. This function changes the operations
265 performed by the !, !! and !!! functions."
266 (run-and-bind-result-list (lambda () (%run test-spec))))
269 "Rerun the most recently run test and explain the results."
270 (explain! (funcall *!*)))
273 "Rerun the second most recently run test and explain the results."
274 (explain! (funcall *!!*)))
277 "Rerun the third most recently run test and explain the results."
278 (explain! (funcall *!!!*)))
280 (defun run-all-tests ()
281 "Run all tests in arbitrary order."
282 (run-and-bind-result-list
286 (when (typep test 'test-case)
290 (defun run-all-tests! ()
291 "Equivalent to (explain! (run-all-tests))."
292 (explain! (run-all-tests)))
294 (defun run-all-test-suites ()
295 "Run all test suites in arbitrary order."
296 (run-and-bind-result-list
300 (when (typep test 'test-suite)
301 (format *test-dribble* "~& ~A: " (name test))
305 (defun run-all-test-suites! ()
306 "Equivalent to (explain (run-all-test-suites))."
307 (explain! (run-all-test-suites)))
309 ;; Copyright (c) 2002-2003, Edward Marco Baringer
310 ;; All rights reserved.
312 ;; Redistribution and use in source and binary forms, with or without
313 ;; modification, are permitted provided that the following conditions are
316 ;; - Redistributions of source code must retain the above copyright
317 ;; notice, this list of conditions and the following disclaimer.
319 ;; - Redistributions in binary form must reproduce the above copyright
320 ;; notice, this list of conditions and the following disclaimer in the
321 ;; documentation and/or other materials provided with the distribution.
323 ;; - Neither the name of Edward Marco Baringer, nor BESE, nor the names
324 ;; of its contributors may be used to endorse or promote products
325 ;; derived from this software without specific prior written permission.
327 ;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
328 ;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
329 ;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
330 ;; A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
331 ;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
332 ;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
333 ;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
334 ;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
335 ;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
336 ;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
337 ;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.