r5450: *** empty log message ***

[xlunit.git] / result.lisp

diff --git a/result.lisp b/result.lisp
index ba95e4a00eb7658075ed9a9bc51fd6704781c1f9..57ceba31def2df3f9373202cfb578f9b63f8974e 100644 (file)
--- a/result.lisp
+++ b/result.lisp
@@ -2,11 +2,9 @@
 ;;;; *************************************************************************
 ;;;; FILE IDENTIFICATION
 ;;;;
-;;;; Name:        result.lisp
-;;;; Purpose:     Result functions for XLUnit
-;;;; Authors:     Kevin Rosenberg
+;;;; ID:      $Id: result.lisp,v 1.2 2003/08/04 12:16:13 kevin Exp $
+;;;; Purpose:  Result functions for XLUnit
 ;;;;
-;;;; $Id: result.lisp,v 1.1 2003/08/04 12:01:54 kevin Exp $
 ;;;; *************************************************************************
 
 (in-package #:xlunit)
@@ -17,17 +15,23 @@
    (count :initform 0 :accessor test-count)
    (failures :initarg :failures :reader test-failures :initform nil)
    (errors :initarg :errors :reader test-errors :initform nil))
-  (:documentation "The result of applying a test"))
-
+  (:documentation "Results of running test(s)"))
 
 (defun make-test-result ()
   (make-instance 'test-result))
 
 (defclass test-failure ()
   ((failed-test :initarg :failed-test :reader failed-test)
-   (thrown-condition :initarg :thrown-condition :reader thrown-condition)))
+   (thrown-condition :initarg :thrown-condition
+                    :reader thrown-condition))
+  (:documention "Stored failures/errors in test-result slots"))
+
+(defun make-test-failure (test condition)
+  (make-instance 'test-failure :failed-test test
+                :thrown-condition condition))
 
 (defmethod is-failure ((failure test-failure))
+  "Returns T if a failure was a test-failure condition"
   (typep (thrown-condition failure) 'test-failure-condition))
 
 (defmethod print-object ((obj test-failure) stream)
@@ -38,5 +42,5 @@
           (simple-condition-format-arguments (thrown-condition obj)))))
 
 (defmethod was-successful ((result test-result))
-  (and (null (test-failures result))
-       (null (test-errors result))))
+  "Returns T if a result has no failures or errors"
+  (and (null (test-failures result)) (null (test-errors result))))