README.md

   1 ## lisp-unit
   2
   3 *lisp-unit* is a Common Lisp library that supports unit testing. It is
   4 an extension of the [library written by Chris Riesbeck][orig]. There
   5 is a long history of testing packages in Lisp, usually called
   6 "regression" testers. More recent packages in Lisp and other languages
   7 have been inspired by [JUnit for Java][JUnit].
   8
   9 [Documentation is located on the project wiki.][wiki]
  10
  11 ### Features
  12
  13 * Written in portable Common Lisp
  14 * Loadable as a single file
  15 * Loadable with [ASDF][] or [Quicklisp][]
  16 * Simple to define and run tests
  17 * Redefine functions and macros without reloading tests
  18 * Test return values, printed output, macro expansions, and conditions
  19 * Fine-grained control over the testing output
  20 * Store all test results in a database object that can be examined
  21 * Group tests by package for modularity
  22 * Group tests using tags
  23 * Signal test completion and return results with the condition.
  24
  25 ### Extensions
  26
  27 * Floating point predicates
  28 * [Test Anything Protocol][TAP] output
  29
  30 ### How to use lisp-unit
  31
  32 The core definitions of *lisp-unit* may be used by loading the single
  33 file 'lisp-unit.lisp'. To use the extensions, *lisp-unit* must be
  34 loaded using either [Quicklisp][] or [ASDF][].
  35
  36 1. Load (or compile and load) as a single file : `(load "lisp-unit")`.
  37 2. Load using [Quicklisp][] : `(ql:quickload :lisp-unit)`.
  38 3. Load using [ASDF][] : `(asdf:load-system :lisp-unit)`.
  39
  40 ## Development Plan
  41
  42 * Version 1.1.0 : Summarize test from multiple packages
  43 * Version 1.2.0 : Improve integration with IDE (mainly SLIME)
  44
  45 ## Acknowledgments
  46
  47 Contributions to *lisp-unit* are [noted in the wiki][credits].
  48 Please let me know if any contributions have not been acknowledged.
  49
  50 [orig]: <http://www.cs.northwestern.edu/academics/courses/325/readings/lisp-unit.html>
  51   "Original Lisp Unit"
  52 [wiki]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki>
  53   "Lisp Unit Wiki"
  54 [credits]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki/Acknowledgments>
  55   "Acknowledgments"
  56 [JUnit]: <http://www.junit.org> "JUnit"
  57 [Quicklisp]: <http://www.quicklisp.org> "Quicklisp"
  58 [ASDF]: <http://common-lisp.net/project/asdf/> "ASDF"
  59 [TAP]: <http://testanything.org/> "Test Anything Protocol"