Renamed the default suite to T; allow a suite parameter of NIL to mean a test/suite...
[fiveam.git] / src / suite.lisp
index 362dc04..8fd2218 100644 (file)
 
 ;;;; ** Creating Suits
 
-(defmacro def-suite (name &key description in)
+(defvar *suites* (make-hash-table :test 'eql))
+
+(defmacro def-suite (name &key description (in nil in-p) (fixture nil fixture-p))
   "Define a new test-suite named NAME.
 
 IN (a symbol), if provided, causes this suite te be nested in the
 suite named by IN. NB: This macro is built on top of make-suite,
 as such it, like make-suite, will overrwrite any existing suite
-named NAME."
+named NAME.
+
+DESCRIPTION is just a string.
+
+FIXTURE is the fixture argument (exactly like the :fixture argument to
+def-test) to pass to tests in this suite."
   `(eval-when (:compile-toplevel :load-toplevel :execute)
      (make-suite ',name
                  ,@(when description `(:description ,description))
-                 ,@(when in `(:in ',in)))
+                 ,@(when in-p      `(:in ',in))
+                 ,@(when fixture-p `(:fixture ',fixture)))
      ',name))
 
 (defmacro def-suite* (name &rest def-suite-args)
@@ -34,14 +42,23 @@ named NAME."
      (def-suite ,name ,@def-suite-args)
      (in-suite ,name)))
 
-(defun make-suite (name &key description in)
+(defun remove-from-suites (test-name)
+  (when (get-test test-name)
+    ;; if this suite alruady exists, and its :IN some other suite, remove it.
+    (dolist (s (list-all-suites))
+      (when (gethash test-name (tests s))
+        (remhash test-name (tests s))))))
+
+(defun make-suite (name &key description ((:in parent-suite) *suite*) fixture)
   "Create a new test suite object.
 
-Overides any existing suite named NAME."
-  (let ((suite (make-instance 'test-suite :name name)))
+Overrides any existing suite named NAME."
+  (remove-from-suites name)
+  (let ((suite (make-instance 'test-suite :name name :fixture fixture)))
     (when description
       (setf (description suite) description))
-    (loop for i in (ensure-list in)
+    (setf (gethash name *suites*) suite)
+    (loop for i in (ensure-list parent-suite)
           for in-suite = (get-test i)
           do (progn
                (when (null in-suite)
@@ -52,10 +69,13 @@ Overides any existing suite named NAME."
     (setf (get-test name) suite)
     suite))
 
+(defun list-all-suites ()
+  (loop for suite being the hash-value in *suites*
+       collect suite))
+
 ;;;; ** Managing the Current Suite
 
-(defvar *suite* (setf (get-test 'NIL)
-                      (make-suite 'NIL :description "Global Suite"))
+(defvar *suite* (setf (get-test 'T) (make-suite 'T :description "Default global suite" :in nil))
   "The current test suite object")
 
 (defmacro in-suite (suite-name)
@@ -67,11 +87,13 @@ See also: DEF-SUITE *SUITE*"
   `(eval-when (:compile-toplevel :load-toplevel :execute)
      (%in-suite ,suite-name)))
 
-(defmacro in-suite* (suite-name &key in)
+(defmacro in-suite* (suite-name &key (in nil in-p))
   "Just like in-suite, but silently creates missing suites."
-  `(%in-suite ,suite-name :in ,in :fail-on-error nil))
+  `(%in-suite ,suite-name
+              ,@(when in-p `(:in ,in))
+              :fail-on-error nil))
 
-(defmacro %in-suite (suite-name &key (fail-on-error t) in)
+(defmacro %in-suite (suite-name &key (fail-on-error t) (in nil in-p))
   (with-gensyms (suite)
     `(progn
        (if-let (,suite (get-test ',suite-name))
@@ -79,8 +101,8 @@ See also: DEF-SUITE *SUITE*"
          (progn
            (when ,fail-on-error
              (cerror "Create a new suite named ~A."
-                     "Unkown suite ~A." ',suite-name))
-           (setf (get-test ',suite-name) (make-suite ',suite-name :in ',in)
+                     "Unknown suite ~A." ',suite-name))
+           (setf (get-test ',suite-name) (make-suite ',suite-name ,@(when in-p `(:in ',in)))
                  *suite* (get-test ',suite-name))))
        ',suite-name)))