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 * Redfine functions and macros without reloading tests
  18 * Test return values, printed output, macro expansions, and conditions
  19 * Fined 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
  24 ### How to use lisp-unit
  25
  26 The core definitions of *lisp-unit* may be used by loading the single
  27 file 'lisp-unit.lisp'. To use the extensions, *lisp-unit* must be
  28 loaded using either [Quicklisp][] or [ASDF][].
  29
  30 1. Load (or compile and load) as a single file : `(load "lisp-unit")`.
  31 2. Load using [Quicklisp][] : `(ql:quickload :lisp-unit)`.
  32 3. Load using [ASDF][] : `(asdf:load-system :lisp-unit)`.
  33
  34 ## Version 0.9.3 Features
  35
  36 A comprehensive test results database has been implemented for Version
  37 0.9.3. `run-tests` and `run-tags` return the test results database
  38 object. Two new functions have been added for examining the results,
  39 `print-failures` and `print-errors`.
  40
  41 ## Version 1 Remaining Tasks
  42
  43 * (1.0.0) Expanded internal testing.
  44
  45 ### Future Features
  46
  47 * Fixtures
  48 * Test Suites
  49 * Benchmarking tools
  50 * Test Anything Protocol(TAP) support.
  51
  52 [orig]: <http://www.cs.northwestern.edu/academics/courses/325/readings/lisp-unit.html>
  53   "Original Lisp Unit"
  54 [wiki]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki>
  55   "Lisp Unit Wiki"
  56 [JUnit]: <http://www.junit.org> "JUnit"
  57 [Quicklisp]: <http://www.quicklisp.org> "Quicklisp"
  58 [ASDF]: <http://common-lisp.net/project/asdf/> "ASDF"