;-*-syntax:COMMON-LISP;Package:(RT :use "COMMON-LISP" :colon-mode :external)-*-

#|----------------------------------------------------------------------------|
 | Copyright 1990 by the Massachusetts Institute of Technology, Cambridge MA. |
 |                                                                            |
 | Permission  to  use,  copy, modify, and distribute this software  and  its |
 | documentation for any purpose  and without fee is hereby granted, provided |
 | that this copyright  and  permission  notice  appear  in  all  copies  and |
 | supporting  documentation,  and  that  the  name  of M.I.T. not be used in |
 | advertising or  publicity  pertaining  to  distribution  of  the  software |
 | without   specific,   written   prior   permission.      M.I.T.  makes  no |
 | representations  about  the  suitability of this software for any purpose. |
 | It is provided "as is" without express or implied warranty.                |
 |                                                                            |
 |  M.I.T. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,  INCLUDING  |
 |  ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL  |
 |  M.I.T. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL  DAMAGES  OR  |
 |  ANY  DAMAGES  WHATSOEVER  RESULTING  FROM  LOSS OF USE, DATA OR PROFITS,  |
 |  WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER  TORTIOUS  ACTION,  |
 |  ARISING  OUT  OF  OR  IN  CONNECTION WITH THE USE OR PERFORMANCE OF THIS  |
 |  SOFTWARE.                                                                 |
 |----------------------------------------------------------------------------|#

;This was the December 19, 1990 version of the regression tester, but
;has since been modified.

(in-package :regression-test)

(declaim (ftype (function (t) t) get-entry expanded-eval do-entries))
(declaim (type list *entries*))
(declaim (ftype (function (t &rest t) t) report-error))
(declaim (ftype (function (t &optional t) t) do-entry))

(defvar *test* nil "Current test name")
(defvar *do-tests-when-defined* nil)
(defvar *entries* (list nil) "Test database.  Has a leading dummy cell that does not contain an entry.")
(defvar *entries-tail* *entries* "Tail of the *entries* list")
(defvar *entries-table* (make-hash-table :test #'equal)
    "Map the names of entries to the cons cell in *entries* that precedes the one whose car is the entry.")
(defvar *in-test* nil "Used by TEST")
(defvar *debug* nil "For debugging")
(defvar *catch-errors* t "When true, causes errors in a test to be caught.")
(defvar *print-circle-on-failure* nil
  "Failure reports are printed with *PRINT-CIRCLE* bound to this value.")

(defvar *compile-tests* nil "When true, compile the tests before running them.")
(defvar *expanded-eval* nil "When true, convert the tests into a form that is less likely to have compiler optimizations.")
(defvar *optimization-settings* '((safety 3)))
(defvar *compile-batch-size*
  #+ecl 512
  #-ecl 16
  "Number of tests to compile at the same time.")

(defvar *failed-tests* nil "After DO-TESTS, becomes the list of names of tests that have failed")
(defvar *passed-tests* nil "After DO-TESTS, becomes the list of names of tests that have passed")

(defvar *expected-failures* nil
  "A list of test names that are expected to fail.")

(defvar *unknown-expected-failures* nil
  "A list of test names that are expected to fail but are not valid names.")

(defvar *unexpected-successes* nil
  "A list of tests that passed but were expected to fail.")

(defvar *unexpected-failures* nil
  "A list of tests that failed but were not expected to fail.")

(defvar *notes* (make-hash-table :test 'equal)
  "A mapping from names of notes to note objects.")

(defstruct (entry (:conc-name nil))
  pend name props form test-function vals)

;;; Note objects are used to attach information to tests.
;;; A typical use is to mark tests that depend on a particular
;;; part of a set of requirements, or a particular interpretation
;;; of the requirements.

(defstruct note
  name
  contents
  disabled ;; When true, tests with this note are considered inactive
  )

;; (defmacro vals (entry) `(cdddr ,entry))

(defmacro defn (entry)
  (let ((var (gensym)))
    `(let ((,var ,entry))
       (list* (name ,var) (form ,var) (vals ,var)))))

(defun entry-notes (entry)
  (let* ((props (props entry))
         (notes (getf props :notes)))
    (if (listp notes)
        notes
      (list notes))))

(defun has-disabled-note (entry)
  (let ((notes (entry-notes entry)))
    (loop for n in notes
          for note = (if (note-p n) n
                       (gethash n *notes*))
          thereis (and note (note-disabled note)))))

(defun has-note (entry note)
  (unless (note-p note)
    (let ((new-note (gethash note *notes*)))
      (setf note new-note)))
  (and note (not (not (member note (entry-notes entry))))))

(defun pending-tests ()
  (loop for entry in (cdr *entries*)
        when (and (pend entry) (not (has-disabled-note entry)))
        collect (name entry)))

(defun rem-all-tests ()
  (setq *entries* (list nil))
  (setq *entries-tail* *entries*)
  (clrhash *entries-table*)
  nil)

(defun rem-test (&optional (name *test*))
  (let ((pred (gethash name *entries-table*)))
    (when pred
      (if (null (cddr pred))
          (setq *entries-tail* pred)
        (setf (gethash (name (caddr pred)) *entries-table*) pred))
      (setf (cdr pred) (cddr pred))
      (remhash name *entries-table*)
      name)))

(defun get-test (&optional (name *test*))
  (defn (get-entry name)))

(defun get-entry (name)
  (let ((entry ;; (find name (the list (cdr *entries*))
               ;;     :key #'name :test #'equal)
         (cadr (gethash name *entries-table*))
         ))
    (when (null entry)
      (report-error t
        "~%No test with name ~:@(~S~)."
        name))
    entry))

(defmacro deftest (name &rest body)
  (let* ((p body)
         (properties
          (loop while (keywordp (first p))
                unless (cadr p)
                do (error "Poorly formed deftest: ~A~%"
                          (list* 'deftest name body))
                append (list (pop p) (pop p))))
         (form (pop p))
         (vals p))
    `(add-entry (make-entry :pend t
                            :name ',name
                            :props ',properties
                            :form ',form
                            :vals ',vals))))

(defun add-entry (entry)
  (setq entry (copy-entry entry))
  (let* ((pred (gethash (name entry) *entries-table*)))
    (cond
     (pred
      (setf (cadr pred) entry)
      (report-error nil
        "Redefining test ~:@(~S~)"
        (name entry)))
     (t
      (setf (gethash (name entry) *entries-table*) *entries-tail*)
      (setf (cdr *entries-tail*) (cons entry nil))
      (setf *entries-tail* (cdr *entries-tail*))
      )))
  (when *do-tests-when-defined*
    (do-entry entry))
  (setq *test* (name entry)))

(defun report-error (error? &rest args)
  (cond (*debug*
         (apply #'format t args)
         (if error? (throw '*debug* nil)))
        (error? (apply #'error args))
        (t (apply #'warn args)))
  nil)

(defun do-test (&optional (name *test*) &rest key-args)
  (flet ((%parse-key-args
          (&key
           ((:catch-errors *catch-errors*) *catch-errors*)
           ((:compile *compile-tests*) *compile-tests*))
          (do-entry (get-entry name))))
    (apply #'%parse-key-args key-args)))

(defun my-aref (a &rest args)
  (apply #'aref a args))

(defun my-row-major-aref (a index)
  (row-major-aref a index))

(defun equalp-with-case (x y)
  "Like EQUALP, but doesn't do case conversion of characters.
   Currently doesn't work on arrays of dimension > 2."
  (cond
   ((eq x y) t)
   ((consp x)
    (and (consp y)
         (equalp-with-case (car x) (car y))
         (equalp-with-case (cdr x) (cdr y))))
   ((and (typep x 'array)
         (= (array-rank x) 0))
    (equalp-with-case (my-aref x) (my-aref y)))
   ((typep x 'vector)
    (and (typep y 'vector)
         (let ((x-len (length x))
               (y-len (length y)))
           (and (eql x-len y-len)
                (loop
                 for i from 0 below x-len
                 for e1 = (my-aref x i)
                 for e2 = (my-aref y i)
                 always (equalp-with-case e1 e2))))))
   ((and (typep x 'array)
         (typep y 'array)
         (not (equal (array-dimensions x)
                     (array-dimensions y))))
    nil)

   ((typep x 'array)
    (and (typep y 'array)
         (let ((size (array-total-size x)))
           (loop for i from 0 below size
                 always (equalp-with-case (my-row-major-aref x i)
                                          (my-row-major-aref y i))))))
   ((typep x 'pathname)
    (equal x y))
   (t (eql x y))))

(defun compile* (lambda-expr &optional do-not-muffle-warnings)
  (if do-not-muffle-warnings
      (compile nil lambda-expr)
      (handler-bind
          ((style-warning #'(lambda (c) (muffle-warning c))))
        ;; redirecting *error-output* is the best way to get rid of
        ;; annoying output from the compiler
        (let ((*error-output* (make-broadcast-stream)))
          (compile nil lambda-expr)))))

(defun compile-test-function (entry)
  (or (test-function entry)
      (setf (test-function entry)
            (compile* `(lambda ()
                         (declare (optimize ,@*optimization-settings*))
                         ,(form entry))
                      (has-note entry :do-not-muffle-warnings)))))

(defun do-entry (entry &optional
                       (s *standard-output*))
  (catch '*in-test*
    (setq *test* (name entry))
    (setf (pend entry) t)
    (let* ((*in-test* t)
           ;; (*break-on-warnings* t)
           (aborted nil)
           r)
      ;; (declare (special *break-on-warnings*))

      (block aborted
        (setf r
              (flet ((%do ()
                          (handler-bind
                           #-sbcl nil
                           #+sbcl ((sb-ext:code-deletion-note #'(lambda (c)
                                                                  (if (has-note entry :do-not-muffle)
                                                                      nil
                                                                    (muffle-warning c)))))
                           (cond
                            (*compile-tests*
                             (multiple-value-list
                              (funcall (compile-test-function entry))))
                            (*expanded-eval*
                             (multiple-value-list
                              (expanded-eval (form entry))))
                            (t
                             (multiple-value-list
                              (eval (form entry))))))))
                (if *catch-errors*
                    (handler-bind
                     ((style-warning #'(lambda (c) (if (has-note entry :do-not-muffle-warnings)
                                                       c
                                                       (muffle-warning c))))
                      (error #'(lambda (c)
                                 (setf aborted t)
                                 (setf r (list c))
                                 (return-from aborted nil))))
                      (%do))
                    (%do)))))

      (setf (pend entry)
            (or aborted
                (not (equalp-with-case r (vals entry)))))

      (when (pend entry)
        (let ((*print-circle* *print-circle-on-failure*))
          (format s "~&Test ~:@(~S~) failed~%Form: ~S~%Expected value~P:~%"
                  *test* (form entry) (length (vals entry)))
          (dolist (v (vals entry)) (format s "~10t~S~%" v))
          (handler-case
              (progn
                (format s "Actual value~P:~%" (length r))
                (dolist (v r)
                  (format s "~10t~S~:[~; [~2:*~A]~]~%"
                          v (typep v 'condition))))
            (error () (format s "Actual value: #<error during printing>~%")))
          (finish-output s)))))
  (when (not (pend entry)) *test*))

(defun expanded-eval (form)
  "Split off top level of a form and eval separately.  This reduces the chance that
   compiler optimizations will fold away runtime computation."
  (if (not (consp form))
      (eval form)
   (let ((op (car form)))
     (cond
      ((eq op 'let)
       (let* ((bindings (loop for b in (cadr form)
                              collect (if (consp b) b (list b nil))))
              (vars (mapcar #'car bindings))
              (binding-forms (mapcar #'cadr bindings)))
         (apply
          (the function
            (eval `(lambda ,vars ,@(cddr form))))
          (mapcar #'eval binding-forms))))
      ((and (eq op 'let*) (cadr form))
       (let* ((bindings (loop for b in (cadr form)
                              collect (if (consp b) b (list b nil))))
              (vars (mapcar #'car bindings))
              (binding-forms (mapcar #'cadr bindings)))
         (funcall
          (the function
            (eval `(lambda (,(car vars) &aux ,@(cdr bindings)) ,@(cddr form))))
          (eval (car binding-forms)))))
      ((eq op 'progn)
       (loop for e on (cdr form)
             do (if (null (cdr e)) (return (eval (car e)))
                  (eval (car e)))))
      ((and (symbolp op) (fboundp op)
            (not (macro-function op))
            (not (special-operator-p op)))
       (apply (symbol-function op)
              (mapcar #'eval (cdr form))))
      (t (eval form))))))

(defun continue-testing ()
  (if *in-test*
      (throw '*in-test* nil)
      (do-entries *standard-output*)))

(defun exit (successp &aux (code (if successp 0 1)))
  #+abcl (ext:quit :status code)
  #+acl (excl:exit code :no-unwind t :quiet t)
  #+ccl (ccl:quit code)
  #+cmucl (handler-case (ext:quit nil code)
            ;; Only the most recent versions of cmucl support an exit code.
            ;; If it doesn't, we get a program error (wrong number of args),
            ;; so catch that and just call quit without the arg.
            (program-error ()
              (ext:quit)))
  #+(or clasp clisp ecl) (ext:quit code)
  #+gcl (lisp:quit code)
  #+lispworks (lispworks:quit :status code :ignore-errors-p t)
  #+sbcl (sb-ext:exit :code code))

(defun load-expected-failures (expected-failures &key (if-does-not-exist :error))
  "Initialize *expected-failures* and disabled notes from expected-failures.
If expected-failures is a list then just iterate through the list. If the
item is a keyword then disable the note by that name. Otherwise add the test
name to *expected-failures*. If expected-failures is a string or a pathname
then repeatedly READ each symbol from the file and use the same logic as
above. if-does-not-exist is passed to OPEN so it behaves as it does there."
  (let ((*package* (find-package "CL-TEST")))
    (flet ((add-expected-failure (name)
             (cond ((and (keywordp name) (disable-note name nil)))
                   ((member name (cdr *entries*) :key #'name)
                    (push name *expected-failures*))
                   (t
                    (push name *unknown-expected-failures*)))))
      (maphash (lambda (key note)
                 (declare (ignore key))
                 (enable-note note))
               *notes*)
      (setf *expected-failures* nil)
      (if (or (stringp expected-failures)
              (pathnamep expected-failures))
          (with-open-file (stream expected-failures :if-does-not-exist if-does-not-exist)
            (cond (stream
                   (format t "Loading expected failures from ~s~%" expected-failures)
                   (do ((name (read stream nil stream) (read stream nil stream)))
                       ((eq name stream))
                     (add-expected-failure name)))
                  (t
                   (format t "Expected failures file ~s not found~%" expected-failures))))
          (dolist (name expected-failures)
            (add-expected-failure name))))
    (setq *unknown-expected-failures* (nreverse *unknown-expected-failures*)
          *expected-failures* (nreverse *expected-failures*))))

(defparameter *sandbox-path* (ignore-errors (truename #P"sandbox/")))

(defun do-tests (&key (out *standard-output*)
                      ((:catch-errors *catch-errors*) *catch-errors*)
                      ((:compile *compile-tests*) *compile-tests*)
                      (expected-failures nil expected-failures-p)
                      exit)
  (let ((*package* (find-package "CL-TEST")))
    (setq *failed-tests* nil
          *passed-tests* nil
          *unexpected-failures* nil
          *unexpected-successes* nil)
    (dolist (entry (cdr *entries*))
      (setf (pend entry) t))
    (when expected-failures-p
      (load-expected-failures expected-failures))
    (let* ((*default-pathname-defaults* *sandbox-path*)
           (successp (if (streamp out)
                         (do-entries out)
                         (with-open-file
                             (stream out :direction :output)
                           (do-entries stream)))))
      (when exit
        (exit successp))
      successp)))

(defun compile-entries (stream entries &optional
                                         (number-of-entries (length entries))
                                         (batch-size (min number-of-entries *compile-batch-size*))
                                         silent)
  "Compile all test functions in batches"
  (do ((remaining-entries entries (nthcdr batch-size remaining-entries))
       (remaining-number-of-entries number-of-entries (- remaining-number-of-entries batch-size))
       (body nil nil))
      ((or (null remaining-entries) (<= remaining-number-of-entries 0)))
    (unless (or silent
                (let ((processed-number-of-entries
                       (- number-of-entries remaining-number-of-entries)))
                  ;; only output the message every 1024 entries
                  (= (ceiling processed-number-of-entries 1024)
                     (ceiling (+ processed-number-of-entries batch-size)
                              1024))))
      (format stream "~&~A of ~A tests remaining to be compiled.~%"
              remaining-number-of-entries number-of-entries))
    (do ((n 0 (1+ n))
         (current-entries remaining-entries (rest current-entries)))
        ((or (null current-entries) (>= n batch-size)
             (>= n remaining-number-of-entries)))
      (let ((entry (first current-entries)))
        (unless (has-note entry :do-not-muffle-warnings)
          (push `(setf (test-function ,entry)
                       (lambda ()
                         (declare (optimize ,@*optimization-settings*))
                         ,(form entry)))
                body))))
    (multiple-value-bind (function warnings-p failure-p)
        (handler-case
            (compile* `(lambda () ,@body))
          (warning () (values nil t t))
          (error () (values nil t t)))
      (declare (ignore warnings-p))
      (if (not failure-p)
          (funcall function)
          (if (= batch-size 1)
              (format stream "~&Cannot compile test function for entry ~A.~%"
                      (name (first remaining-entries)))
              ;; Something went wrong, try to narrow down where
              (compile-entries stream remaining-entries
                               batch-size (floor batch-size 2)
                               t))))))

(defun do-entries (s)
  (let ((count (count t (the list (cdr *entries*)) :key #'pend)))
    (format s "~&Doing ~A pending test~:P of ~A test~:P total.~%"
            count (length (cdr *entries*)))
    (finish-output s)
    (when *compile-tests*
      (compile-entries s (cdr *entries*)))
    (dolist (entry (cdr *entries*))
      (when (and (pend entry)
                 (not (has-disabled-note entry)))
        (let ((success? (do-entry entry s)))
          (cond (success?
                 (push (name entry) *passed-tests*)
                 (when (member (name entry) *expected-failures*)
                   (push (name entry) *unexpected-successes*)))
                (t
                 (push (name entry) *failed-tests*)
                 (unless (member (name entry) *expected-failures*)
                   (push (name entry) *unexpected-failures*))))
          (format s "~@[~<~%~:; ~:@(~S~)~>~]" success?))
        (finish-output s)))
    (setq *passed-tests* (nreverse *passed-tests*)
          *failed-tests* (nreverse *failed-tests*)
          *unexpected-failures* (nreverse *unexpected-failures*)
          *unexpected-successes* (nreverse *unexpected-successes*))
    (format s "~&~@[Found unknown test or note names in expected failure list:~
               ~%  ~<~@{~S~^, ~:_~}~:>~%~]~
             ~A failure~:P with ~A unexpected failure~:P and ~A unexpected ~
             success~:*~[es~;~:;es~] out of ~A test~:P.~%~
             ~:[No failures~;~:*Failures: ~{~%  ~S~}~]~%~
             ~:[No unexpected failures~;~:*Unexpected failures: ~{~%  ~S~}~]~%~
             ~:[No unexpected successes~;~:*Unexpected successes: ~{~%  ~S~}~]~%"
            *unknown-expected-failures*
            (length *failed-tests*) (length *unexpected-failures*)
            (length *unexpected-successes*) count
            *failed-tests* *unexpected-failures*
            *unexpected-successes*)
    (terpri)
    (finish-output s)
    (null *unexpected-failures*)))

;;; Note handling functions and macros

(defmacro defnote (name contents &optional disabled)
  `(eval-when (:load-toplevel :execute)
     (let ((note (make-note :name ',name
                            :contents ',contents
                            :disabled ',disabled)))
       (setf (gethash (note-name note) *notes*) note)
       note)))

(defun disable-note (n &optional (errorp t))
  (let ((note (if (note-p n) n
                  (setf n (gethash n *notes*)))))
    (cond (note
           (setf (note-disabled note) t)
           note)
          (errorp
           (error "~A is not a note or note name." n))
          (t
           nil))))

(defun enable-note (n &optional (errorp t))
  (let ((note (if (note-p n) n
                (setf n (gethash n *notes*)))))
    (cond (note
           (setf (note-disabled note) nil)
           note)
          (errorp
           (error "~A is not a note or note name." n))
          (t
           nil))))

;;; Extended random regression

(defun do-extended-tests (&key (tests *passed-tests*) (count nil)
                               ((:catch-errors *catch-errors*) *catch-errors*)
                               ((:compile *compile-tests*) *compile-tests*))
  "Execute randomly chosen tests from TESTS until one fails or until
   COUNT is an integer and that many tests have been executed."
  (let ((*package* (find-package "CL-TEST"))
        (*default-pathname-defaults* (make-pathname :directory (append (pathname-directory (or *compile-file-pathname*
                                                                                               *load-pathname*
                                                                                               *default-pathname-defaults*))
                                                                       '("sandbox"))))
        (test-vector (coerce tests 'simple-vector)))
    (let ((n (length test-vector)))
      (when (= n 0) (error "Must provide at least one test."))
      (loop for i from 0
            for name = (svref test-vector (random n))
            until (eql i count)
            do (print name)
            unless (do-test name) return (values name (1+ i))))))