Implement RUN-ALL-TESTS and friends.
[fiveam.git] / src / package.lisp
1 ;;;; -*- Mode: Lisp; indent-tabs-mode: nil -*-
2
3 ;;;; * Introduction
4
5 ;;;; FiveAM is a testing framework. It takes care of all the boring
6 ;;;; bookkeeping associated with managing a test framework allowing
7 ;;;; the developer to focus on writing tests and code.
8
9 ;;;; FiveAM was designed with the following premises:
10
11 ;;;; - Defining tests should be about writing tests, not
12 ;;;; infrastructure. The developer should be able to focus on what
13 ;;;; they're testing, not the testing framework.
14
15 ;;;; - Interactive testing is the norm. Common Lisp is an interactive
16 ;;;; development environment, the testing environment should allow the
17 ;;;; developer to quickly and easily redefine, change, remove and run
18 ;;;; tests.
19
20 (defpackage :it.bese.fiveam
21   (:use :common-lisp :alexandria)
22   (:nicknames :5am :fiveam)
23   (:export
24    ;; creating tests and test-suites
25    #:make-suite
26    #:def-suite
27    #:in-suite
28    #:in-suite*
29    #:make-test
30    #:test
31    #:def-test
32    #:get-test
33    #:rem-test
34    #:test-names
35    ;; fixtures
36    #:make-fixture
37    #:def-fixture
38    #:with-fixture
39    #:get-fixture
40    #:rem-fixture
41    ;; running checks
42    #:is
43    #:is-every
44    #:is-true
45    #:is-false
46    #:signals
47    #:finishes
48    #:skip
49    #:pass
50    #:fail
51    #:*test-dribble*
52    #:for-all
53    #:gen-integer
54    #:gen-float
55    #:gen-character
56    #:gen-string
57    #:gen-list
58    #:gen-tree
59    #:gen-buffer
60    #:gen-one-element
61    ;; running tests
62    #:run
63    #:run-all-tests
64    #:run-all-test-suites
65    #:explain
66    #:explain!
67    #:run!
68    #:run-all-tests!
69    #:run-all-test-suites!
70    #:debug!
71    #:!
72    #:!!
73    #:!!!
74    #:*run-test-when-defined*
75    #:*debug-on-error*
76    #:*debug-on-failure*
77    #:*verbose-failures*
78    #:results-status))
79
80 ;;;; You can use #+5am to put your test-defining code inline with your
81 ;;;; other code - and not require people to have fiveam to run your
82 ;;;; package.
83
84 (pushnew :5am *features*)
85
86 ;;;;@include "check.lisp"
87
88 ;;;;@include "random.lisp"
89
90 ;;;;@include "fixture.lisp"
91
92 ;;;;@include "test.lisp"
93
94 ;;;;@include "suite.lisp"
95
96 ;;;;@include "run.lisp"
97
98 ;;;;@include "explain.lisp"
99
100 ;;;; * Colophon
101
102 ;;;; This documentaion was written by Edward Marco Baringer
103 ;;;; <mb@bese.it> and generated by qbook.
104
105 ;;;; ** COPYRIGHT
106
107 ;;;; Copyright (c) 2002-2003, Edward Marco Baringer
108 ;;;; All rights reserved.
109
110 ;;;; Redistribution and use in source and binary forms, with or without
111 ;;;; modification, are permitted provided that the following conditions are
112 ;;;; met:
113
114 ;;;;  - Redistributions of source code must retain the above copyright
115 ;;;;    notice, this list of conditions and the following disclaimer.
116
117 ;;;;  - Redistributions in binary form must reproduce the above copyright
118 ;;;;    notice, this list of conditions and the following disclaimer in the
119 ;;;;    documentation and/or other materials provided with the distribution.
120
121 ;;;;  - Neither the name of Edward Marco Baringer, nor BESE, nor the names
122 ;;;;    of its contributors may be used to endorse or promote products
123 ;;;;    derived from this software without specific prior written permission.
124
125 ;;;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
126 ;;;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
127 ;;;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
128 ;;;; A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
129 ;;;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
130 ;;;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
131 ;;;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
132 ;;;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
133 ;;;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
134 ;;;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
135 ;;;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE