src/packages.lisp

   1 ;; -*- lisp -*-
   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 :it.bese.arnesi)
  22   (:nicknames :5am)
  23   (:export ;; creating tests and test-suites
  24            #:make-suite
  25            #:def-suite
  26            #:in-suite
  27            #:in-suite*
  28            #:make-test
  29            #:test
  30            #:get-test
  31            #:rem-test
  32            #:test-names
  33            ;; fixtures
  34            #:make-fixture
  35            #:def-fixture
  36            #:with-fixture
  37            #:get-fixture
  38            #:rem-fixture
  39            ;; running checks
  40            #:is
  41            #:is-equal
  42            #:is-string=
  43            #:is-true
  44            #:is-false
  45            #:signals
  46            #:finishes
  47            #:skip
  48            #:pass
  49            #:fail
  50            #:*test-dribble*
  51            #:for-all
  52            #:gen-integer
  53            #:gen-float
  54            #:gen-character
  55            #:gen-string
  56            #:gen-list
  57            #:gen-buffer
  58            #:gen-one-element
  59            ;; running tests
  60            #:run
  61            #:run-all-tests
  62            #:explain
  63            #:explain!
  64            #:run!
  65            #:!
  66            #:!!
  67            #:!!!
  68            #:*run-test-when-defined*
  69            #:*debug-on-error*
  70            #:*debug-on-failure*
  71            #:*verbose-failures*))
  72
  73 ;;;; You can use #+5am to put your test-defining code inline with your
  74 ;;;; other code - and not require people to have fiveam to run your
  75 ;;;; package.
  76
  77 (pushnew :5am *features*)
  78
  79 ;;;;@include "check.lisp"
  80
  81 ;;;;@include "random.lisp"
  82
  83 ;;;;@include "fixture.lisp"
  84
  85 ;;;;@include "test.lisp"
  86
  87 ;;;;@include "suite.lisp"
  88
  89 ;;;;@include "run.lisp"
  90
  91 ;;;;@include "explain.lisp"
  92
  93 ;;;; * Colophon
  94
  95 ;;;; This documentaion was written by Edward Marco Baringer
  96 ;;;; <mb@bese.it> and generated by qbook.
  97
  98 ;;;; ** COPYRIGHT
  99
 100 ;;;; Copyright (c) 2002-2003, Edward Marco Baringer
 101 ;;;; All rights reserved.
 102
 103 ;;;; Redistribution and use in source and binary forms, with or without
 104 ;;;; modification, are permitted provided that the following conditions are
 105 ;;;; met:
 106
 107 ;;;;  - Redistributions of source code must retain the above copyright
 108 ;;;;    notice, this list of conditions and the following disclaimer.
 109
 110 ;;;;  - Redistributions in binary form must reproduce the above copyright
 111 ;;;;    notice, this list of conditions and the following disclaimer in the
 112 ;;;;    documentation and/or other materials provided with the distribution.
 113
 114 ;;;;  - Neither the name of Edward Marco Baringer, nor BESE, nor the names
 115 ;;;;    of its contributors may be used to endorse or promote products
 116 ;;;;    derived from this software without specific prior written permission.
 117
 118 ;;;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 119 ;;;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 120 ;;;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 121 ;;;; A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
 122 ;;;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 123 ;;;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 124 ;;;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 125 ;;;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 126 ;;;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 127 ;;;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 128 ;;;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE