1 ;;;; -*- Mode: Lisp; indent-tabs-mode: nil -*-
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.
9 ;;;; FiveAM was designed with the following premises:
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.
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
20 (defpackage :it.bese.fiveam
21 (:use :common-lisp :alexandria)
22 (:nicknames :5am :fiveam)
26 ;; creating tests and test-suites
73 #:*run-test-when-defined*
81 ;;;; You can use #+5am to put your test-defining code inline with your
82 ;;;; other code - and not require people to have fiveam to run your
85 (pushnew :5am *features*)
87 ;;;;@include "check.lisp"
89 ;;;;@include "random.lisp"
91 ;;;;@include "fixture.lisp"
93 ;;;;@include "test.lisp"
95 ;;;;@include "suite.lisp"
97 ;;;;@include "run.lisp"
99 ;;;;@include "explain.lisp"
103 ;;;; This documentaion was written by Edward Marco Baringer
104 ;;;; <mb@bese.it> and generated by qbook.
108 ;;;; Copyright (c) 2002-2003, Edward Marco Baringer
109 ;;;; All rights reserved.
111 ;;;; Redistribution and use in source and binary forms, with or without
112 ;;;; modification, are permitted provided that the following conditions are
115 ;;;; - Redistributions of source code must retain the above copyright
116 ;;;; notice, this list of conditions and the following disclaimer.
118 ;;;; - Redistributions in binary form must reproduce the above copyright
119 ;;;; notice, this list of conditions and the following disclaimer in the
120 ;;;; documentation and/or other materials provided with the distribution.
122 ;;;; - Neither the name of Edward Marco Baringer, nor BESE, nor the names
123 ;;;; of its contributors may be used to endorse or promote products
124 ;;;; derived from this software without specific prior written permission.
126 ;;;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
127 ;;;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
128 ;;;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
129 ;;;; A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
130 ;;;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
131 ;;;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
132 ;;;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
133 ;;;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
134 ;;;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
135 ;;;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
136 ;;;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE