Create named test lambdas
[fiveam.git] / src / test.lisp
index 7d763d1..2712d6a 100644 (file)
@@ -1,25 +1,39 @@
-;; -*- 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
-  :documentation "Lookup table mapping test (and test suite)
+(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))
+
 (defmacro test (name &body body)
   "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.
 
@@ -40,38 +54,65 @@ 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.
 
-SUITE defaults to the current value of *SUITE*."
-  (destructuring-bind (name &key depends-on (suite nil suite-supplied-p))
-      (ensure-list name)
-    (let (description)
-      (setf description (if (stringp (car body))
-                           (pop body)
-                           ""))
-      `(progn
-        (setf (get-test ',name) (make-instance 'test-case
-                                                :name ',name
-                                                :test-lambda
-                                                (lambda ()
-                                                  (funcall (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))
-        ',name))))
+FIXTURE specifies a fixtrue to wrap the body in.
+
+If PROFILE is T profiling information will be collected as well."
+  (let* ((tmp (gensym))
+         (suite-arg (getf (cdr (ensure-list name)) :suite tmp))
+         (suite-form (cond
+                       ((eq tmp suite-arg) '*suite*)
+                       (t                  `(get-test ',suite-arg)))))
+    (when (consp name)
+      (remf (cdr name) :suite))
+    (destructuring-bind (name &key depends-on (compile-at :run-time) fixture profile)
+        (ensure-list name)
+      (declare (type (member :run-time :definition-time) compile-at))
+      (let ((description (if (stringp (car body))
+                             (pop body)
+                             ""))
+            (effective-body (if fixture
+                                (destructuring-bind (name &rest args)
+                                    (ensure-list fixture)
+                                  `((with-fixture ,name ,args ,@body)))
+                                body))
+            (lambda-name
+              (format-symbol t "%~A-~A" '#:test name))
+            (inner-lambda-name
+              (format-symbol t "%~A-~A" '#:inner-test name)))
+        `(progn
+           (setf (get-test ',name)
+                 (make-instance 'test-case
+                                :name ',name
+                                :runtime-package (find-package ,(package-name *package*))
+                                :test-lambda
+                                (named-lambda ,lambda-name ()
+                                  ,@ (ecase compile-at
+                                       (:run-time `((funcall
+                                                     (let ((*package* (find-package ',(package-name *package*))))
+                                                       (compile ',inner-lambda-name
+                                                                '(lambda () ,@effective-body))))))
+                                       (:definition-time effective-body)))
+                                :description ,description
+                                :depends-on ',depends-on
+                                :collect-profiling-info ,profile))
+           (setf (gethash ',name (tests ,suite-form)) ',name)
+           (when *run-test-when-defined*
+             (run! ',name))
+           ',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.
@@ -79,7 +120,7 @@ SUITE defaults to the current value of *SUITE*."
 ;;  - 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