Pring tests name being ran
[fiveam.git] / src / run.lisp
index 0ebc771..d9cb767 100644 (file)
@@ -1,6 +1,6 @@
-;; -*- lisp -*-
+;;;; -*- Mode: Lisp; indent-tabs-mode: nil -*-
 
-(in-package :it.bese.FiveAM)
+(in-package :it.bese.fiveam)
 
 ;;;; * Running Tests
 
@@ -39,6 +39,9 @@
 (defparameter *debug-on-failure* nil
   "T if we should drop into a debugger on a failing check, NIL otherwise.")
 
+(defparameter *print-names* t
+  "T if we should print test running progress, NIL otherwise.")
+
 (defun import-testing-symbols (package-designator)
   (import '(5am::is 5am::is-true 5am::is-false 5am::signals 5am::finishes)
           package-designator))
@@ -56,7 +59,7 @@ between test-cases has been detected."))
 (defgeneric run-resolving-dependencies (test)
   (:documentation "Given a dependency spec determine if the spec
 is satisfied or not, this will generally involve running other
-tests. If the dependency spec can be satisfied the test is alos
+tests. If the dependency spec can be satisfied the test is also
 run."))
 
 (defmethod run-resolving-dependencies ((test test-case))
@@ -89,6 +92,8 @@ run."))
          (setf (status test) :circular))))
     (t (status test))))
 
+(defgeneric resolve-dependencies (depends-on))
+
 (defmethod resolve-dependencies ((depends-on symbol))
   "A test which depends on a symbol is interpreted as `(AND
   ,DEPENDS-ON)."
@@ -115,10 +120,12 @@ run."))
 (defun results-status (result-list)
   "Given a list of test results (generated while running a test)
   return true if all of the results are of type TEST-PASSED,
-  faile otherwise."
-  (every (lambda (res)
-           (typep res 'test-passed))
-         result-list))
+  fail otherwise.
+  Returns a second value, which is the set of failed tests."
+  (let ((failed-tests
+          (remove-if #'test-passed-p result-list)))
+    (values (null failed-tests)
+            failed-tests)))
 
 (defun return-result-list (test-lambda)
   "Run the test function TEST-LAMBDA and return a list of all
@@ -128,6 +135,8 @@ run."))
     (funcall test-lambda)
     result-list))
 
+(defgeneric run-test-lambda (test))
+
 (defmethod run-test-lambda ((test test-case))
   (with-run-state (result-list)
     (bind-run-state ((current-test test))
@@ -154,8 +163,9 @@ run."))
                          (let ((*readtable* (copy-readtable))
                                (*package* (runtime-package test)))
                            (if (collect-profiling-info test)
-                               (setf (profiling-info test)
-                                     (arnesi:collect-timing (test-lambda test)))
+                               ;; Timing info doesn't get collected ATM, we need a portable library
+                               ;; (setf (profiling-info test) (collect-timing (test-lambda test)))
+                               (funcall (test-lambda test))
                                (funcall (test-lambda test))))
                        (retest ()
                          :report (lambda (stream)
@@ -177,12 +187,16 @@ run."))
   !!, !!!"))
 
 (defmethod %run ((test test-case))
+  (when *print-names*
+    (format *debug-io* "~% Running test ~A " (name test)))
   (run-resolving-dependencies test))
 
 (defmethod %run ((tests list))
   (mapc #'%run tests))
 
 (defmethod %run ((suite test-suite))
+  (when *print-names*
+    (format *debug-io* "~%Running test suite ~A~%" (name suite)))
   (let ((suite-results '()))
     (flet ((run-tests ()
              (loop
@@ -192,17 +206,17 @@ run."))
            (bind-run-state ((result-list '()))
              (unwind-protect
                   (if (collect-profiling-info suite)
-                      (setf (profiling-info suite) (collect-timing #'run-tests))
+                      ;; Timing info doesn't get collected ATM, we need a portable library
+                      ;; (setf (profiling-info suite) (collect-timing #'run-tests))
+                      (run-tests)
                       (run-tests)))
              (setf suite-results result-list
-                   (status suite) (every (lambda (res)
-                                           (typep res 'test-passed))
-                                         suite-results)))
+                   (status suite) (every #'test-passed-p suite-results)))
         (with-run-state (result-list)
           (setf result-list (nconc result-list suite-results)))))))
 
 (defmethod %run ((test-name symbol))
-  (when-bind test (get-test test-name)
+  (when-let (test (get-test test-name))
     (%run test)))
 
 (defvar *initial-!* (lambda () (format t "Haven't run that many tests yet.~%")))
@@ -213,8 +227,9 @@ run."))
 
 ;;;; ** Public entry points
 
-(defun run! (&optional (test-spec *suite*))
-  "Equivalent to (explain (run TEST-SPEC))."
+(defun run! (&optional (test-spec *suite*)
+             &key ((:print-names *print-names*) *print-names*))
+  "Equivalent to (explain! (run TEST-SPEC))."
   (explain! (run test-spec)))
 
 (defun explain! (result-list)
@@ -228,15 +243,15 @@ detailed-text-explainer with output going to *test-dribble*"
         (*debug-on-failure* t))
     (run! test-spec)))
 
-(defun run (test-spec)
+(defun run (test-spec &key ((:print-names *print-names*) *print-names*))
   "Run the test specified by TEST-SPEC.
 
 TEST-SPEC can be either a symbol naming a test or test suite, or
 a testable-object object. This function changes the operations
 performed by the !, !! and !!! functions."
   (psetf *!* (lambda ()
-               (loop for test being the hash-keys of *test*
-                     do (setf (status (get-test test)) :unknown))
+               (loop :for test :being :the :hash-keys :of *test*
+                     :do (setf (status (get-test test)) :unknown))
                (bind-run-state ((result-list '()))
                  (with-simple-restart (explain "Ignore the rest of the tests and explain current results")
                    (%run test-spec))