src/packages.lisp

   1 ;; -*- lisp -*-
   2
   3 ;;;; * Introduction
   4
   5 ;;;; FiveAM is A simple Common Lisp unit testing library.
   6
   7 ;;;; FiveAM is a testing framework. It takes care of all the boring
   8 ;;;; bookkeeping associated with managing a test framework allowing
   9 ;;;; the developer to focus on writing tests and code.
  10
  11 ;;;; FiveAM was designed with the following premises:
  12
  13 ;;;; - Defining tests should be about writing tests, not
  14 ;;;;   infrastructure. The developer should be able to focus on what
  15 ;;;;   they're testing, not the testing framework.
  16
  17 ;;;; - Interactive testing is the norm. Common Lisp is an interactive
  18 ;;;;  development environment, the testing environment should allow
  19 ;;;;  the developer to quickly and easily redefine, change, remove
  20 ;;;;  and run tests.
  21
  22 (defpackage :it.bese.FiveAM
  23   (:use :common-lisp :it.bese.arnesi)
  24   (:nicknames :5am)
  25   (:export ;; creating tests and test-suites
  26            #:make-suite
  27            #:def-suite
  28            #:in-suite
  29            #:make-test
  30            #:test
  31            #:get-test
  32            #:rem-test
  33            ;; fixtures
  34            #:make-fixture
  35            #:def-fixture
  36            #:with-fixture
  37            #:get-fixture
  38            #:rem-fixture
  39            ;; running checks
  40            #:is
  41            #:is-true
  42            #:is-false
  43            #:signals
  44            #:finishes
  45            #:skip
  46            #:pass
  47            #:fail
  48            #:*test-dribble*
  49            ;; running tests
  50            #:run
  51            #:run-all-tests
  52            #:explain
  53            #:run!
  54            #:!
  55            #:!!
  56            #:!!!
  57            #:*debug-on-error*))
  58
  59 ;;;; You can use #+5am to put your test-defining code inline with your
  60 ;;;; other code - and not require people to have fiveam to run your
  61 ;;;; package.
  62
  63 (pushnew :5am *features*)
  64
  65 ;;;;@include "check.lisp"
  66
  67 ;;;;@include "test.lisp"
  68
  69 ;;;;@include "fixture.lisp"
  70
  71 ;;;;@include "suite.lisp"
  72
  73 ;;;;@include "run.lisp"
  74
  75 ;;;;@include "explain.lisp"
  76
  77 ;;;; * Examples
  78
  79 #| (def-suite my-suite :description "My Example Suite")
  80
  81  (in-suite my-suite)
  82
  83  (test my-tests
  84   "Example"
  85   (is (= 4 (+ 2 2)) "2 plus 2 wasn't equal to 4 (using #'= to test equality)")
  86   (is (= 0 (+ -1 1)))
  87   (throws (error "Trying to add 4 to FOO didn't signal an error")
  88      (+ 'foo 4))
  89   (is (= 0 (+ 1 1)) "this should have failed"))
  90
  91  (run! 'my-suite)
  92 ;; Running suite MY-SUITE
  93 ..F.
  94 Suite My Example Suite ran 4 tests (3/0/1) - 1 FAILED -
  95 Failed Tests:
  96 MY-TESTS FAILED: (+ 1 1) was not = to 0 (returned 2 instead)
  97    Description: Example.
  98    Message:     this should have failed
  99 NIL |#
 100
 101 ;;;; * Colophon
 102
 103 ;;;; This documentaion was written by Edward Marco Baringer
 104 ;;;; <mb@bese.it> and generated by qbook.
 105
 106 ;;;; ** COPYRIGHT
 107
 108 ;;;; Copyright (c) 2002-2003, Edward Marco Baringer
 109 ;;;; All rights reserved.
 110
 111 ;;;; Redistribution and use in source and binary forms, with or without
 112 ;;;; modification, are permitted provided that the following conditions are
 113 ;;;; met:
 114
 115 ;;;;  - Redistributions of source code must retain the above copyright
 116 ;;;;    notice, this list of conditions and the following disclaimer.
 117
 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.
 121
 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.
 125
 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