-;; -*- lisp -*-
+;;;; -*- Mode: Lisp; indent-tabs-mode: nil -*-
-(in-package :it.bese.FiveAM)
+(in-package :it.bese.fiveam)
;;;; * Tests
;;;; While executing checks and collecting the results is the core job
;;;; of a testing framework it is also important to be able to
-;;;; organize checks into groups, FiveAM provides two mechanisms for
+;;;; organize checks into groups, fiveam provides two mechanisms for
;;;; organizing checks: tests and test suites. A test is a named
;;;; collection of checks which can be run and a test suite is a named
;;;; collection of tests and test suites.
-(deflookup-table test
- :at-redefinition nil
- :documentation "Lookup table mapping test (and test suite)
+(defvar *suite* nil
+ "The current test suite object")
+
+(defvar *test*
+ (make-hash-table :test 'eql)
+ "Lookup table mapping test (and test suite)
names to objects.")
+(defun get-test (key &optional default)
+ (gethash key *test* default))
+
+(defun (setf get-test) (value key)
+ (setf (gethash key *test*) value))
+
+(defun rem-test (key)
+ (remhash key *test*))
+
(defun test-names ()
(loop for test being the hash-keys of *test*
collect test))
"Create a test named NAME. If NAME is a list it must be of the
form:
- (name &key depends-on suite)
+ (name &key depends-on suite fixture compile-at profile)
NAME is the symbol which names the test.
,depends-on), this is accomadate the common case of one test
depending on another.
-SUITE defaults to the current value of *SUITE*."
- (destructuring-bind (name &key depends-on (suite nil suite-supplied-p))
+FIXTURE specifies a fixture to wrap the body in.
+
+If PROFILE is T profiling information will be collected as well."
+ (destructuring-bind (name &rest args)
(ensure-list name)
- (let (description)
- (setf description (if (stringp (car body))
- (pop body)
- ""))
+ `(def-test ,name (,@args) ,@body)))
+
+(defmacro def-test (name (&key depends-on (suite '*suite* suite-p) fixture
+ (compile-at :run-time) profile)
+ &body body)
+ "Create a test named NAME.
+
+NAME is the symbol which names the test.
+
+DEPENDS-ON is a list of the form:
+
+ (AND . test-names) - This test is run only if all of the tests
+ in TEST-NAMES have passed, otherwise a single test-skipped
+ result is generated.
+
+ (OR . test-names) - If any of TEST-NAMES has passed this test is
+ run, otherwise a test-skipped result is generated.
+
+ (NOT test-name) - This is test is run only if TEST-NAME failed.
+
+AND, OR and NOT can be combined to produce complex dependencies.
+
+If DEPENDS-ON is a symbol it is interpreted as `(AND
+,depends-on), this is accomadate the common case of one test
+depending on another.
+
+FIXTURE specifies a fixture to wrap the body in.
+
+If PROFILE is T profiling information will be collected as well."
+ (check-type compile-at (member :run-time :definition-time))
+ (multiple-value-bind (forms decls docstring)
+ (parse-body body :documentation t :whole name)
+ (let* ((description (or docstring ""))
+ (body-forms (append decls forms))
+ (suite-form (if suite-p
+ `(get-test ',suite)
+ (or suite '*suite*)))
+ (effective-body (if fixture
+ (destructuring-bind (name &rest args)
+ (ensure-list fixture)
+ `((with-fixture ,name ,args ,@body-forms)))
+ body-forms)))
`(progn
- (setf (get-test ',name) (make-instance 'test-case
- :name ',name
- :runtime-package ,*package*
- :test-lambda
- (lambda ()
- (funcall (let ((*package* ,*package*))
- (compile nil '(lambda () ,@body)))))
- :description ,description
- :depends-on ',depends-on))
- ,(if suite-supplied-p
- `(setf (gethash ',name (tests (get-test ',suite)))
- ',name)
- `(setf (gethash ',name (tests (or *suite* (get-test 'NIL))))
- ',name))
+ (register-test ',name ,description ',effective-body ,suite-form ',depends-on ,compile-at ,profile)
(when *run-test-when-defined*
(run! ',name))
- ',name))))
+ ',name))))
+
+(defun register-test (name description body suite depends-on compile-at profile)
+ (let ((lambda-name
+ (format-symbol t "%~A-~A" '#:test name))
+ (inner-lambda-name
+ (format-symbol t "%~A-~A" '#:inner-test name)))
+ (setf (get-test name)
+ (make-instance 'test-case
+ :name name
+ :runtime-package (find-package (package-name *package*))
+ :test-lambda
+ (eval
+ `(named-lambda ,lambda-name ()
+ ,@(ecase compile-at
+ (:run-time `((funcall
+ (let ((*package* (find-package ',(package-name *package*))))
+ (compile ',inner-lambda-name
+ '(lambda () ,@body))))))
+ (:definition-time body))))
+ :description description
+ :depends-on depends-on
+ :collect-profiling-info profile))
+ (setf (gethash name (tests suite)) name)))
(defvar *run-test-when-defined* nil
"When non-NIL tests are run as soon as they are defined.")
;; Copyright (c) 2002-2003, Edward Marco Baringer
-;; All rights reserved.
-;;
+;; All rights reserved.
+;;
;; Redistribution and use in source and binary forms, with or without
;; modification, are permitted provided that the following conditions are
;; met:
-;;
+;;
;; - Redistributions of source code must retain the above copyright
;; notice, this list of conditions and the following disclaimer.
-;;
+;;
;; - Redistributions in binary form must reproduce the above copyright
;; notice, this list of conditions and the following disclaimer in the
;; documentation and/or other materials provided with the distribution.
;; - Neither the name of Edward Marco Baringer, nor BESE, nor the names
;; of its contributors may be used to endorse or promote products
;; derived from this software without specific prior written permission.
-;;
+;;
;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
projects / fiveam.git / blobdiff