Add function documentation checker/converter
[sheep] / src / test / main.lisp
1 (in-package #:docgen-test)
2
3 (defvar *tests* nil)
4
5 ; This really is just here to check against regressions
6 (defun run-all-tests ()
7  (let
8   ((results (mapcar #'funcall (reverse *tests*))))
9   (every #'identity results)))
10
11 (defun slurp-file (filename &key (element-type 'character) (sequence-type 'string))
12  (with-open-file (str filename :element-type element-type)
13   (let ((seq (make-sequence sequence-type (file-length str)))) (read-sequence seq str) seq)))
14
15 (defmacro deftest (name f)
16  `(push
17    (lambda ()
18     (let
19      ((success (funcall ,f)))
20      (if success
21       (format t "~c[1;32m- ~A passed~c[0m~%" #\Esc ,name #\Esc)
22       (format t "~c[1;31m- ~A failed~c[0m~%" #\Esc ,name #\Esc))
23      success))
24    *tests*))
25
26 (defmacro defsuccesstest (pkg source target)
27  `(deftest
28    ,source
29    (lambda ()
30     (load ,source)
31     (ignore-errors (string= (slurp-file ,target) (docgen:export-package ,pkg))))))
32
33 (defmacro deffailure-func-test (name doc expected)
34  `(deftest
35    ,name
36    (lambda ()
37     (handler-case
38      (progn
39       (funcall
40        (symbol-function (find-symbol "INTERNAL-DOC->AST" :docgen-func))
41        'unused
42        ,doc)
43       nil)
44      (docgen:validation-failure (vf)
45       (let
46        ((result (funcall (symbol-function (find-symbol "VALIDATION-FAILURE-MSG" :docgen)) vf)))
47        (or
48         (string= ,expected result)
49         (format t "  Got error:~%~S~%  but expected~%~S~%" result ,expected))))))))
50
51 (defsuccesstest :success1 "resources/success1.lisp" "resources/success1.md")