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