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 ### How to use lisp-unit
  12
  13 The core definitions of *lisp-unit* may be used by loading the single
  14 file 'lisp-unit.lisp'. To use the extensions, *lisp-unit* must be
  15 loaded using either [Quicklisp][] or [ASDF][].
  16
  17 1. Load (or compile and load) as a single file : `(load "lisp-unit")`.
  18 2. Load using [Quicklisp][] : `(ql:quickload :lisp-unit)`.
  19 3. Load using [ASDF][] : `(asdf:load-system :lisp-unit)`.
  20
  21 ## Version 0.9.2 Features
  22
  23 ### Simplified Interface
  24
  25 The interface for managing tests has been simplified beginning in
  26 Version 0.9.0. The simplified interface is fully described on the
  27 [Reference page][reference]. The motivation for simplifying the
  28 interface and a comparison with the original interface is described on
  29 the [Simplified Interface page][interface].
  30
  31 [reference]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki/Reference>
  32 [interface]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki/Simplified-Interface>
  33
  34 ### Test Documentation
  35
  36 A documentation string can now be used in `define-test` like it is in
  37 `defun`.
  38
  39 ### Test tags
  40
  41 Tests can be tagged by adding on or more `(:tag tag1 tag2 ...)` forms
  42 after the name or documentation string in `define-test`. The tags can
  43 then be used to run subsets of the unit tests with `run-tags`.
  44
  45 ## Version 1 Remaining Tasks
  46
  47 * (1.0.0) Expanded internal testing.
  48
  49 ### Future Features
  50
  51 * Fixtures
  52 * Test Suites
  53 * Benchmarking tools
  54 * Test Anything Protocol(TAP) support.
  55
  56 [orig]: <http://www.cs.northwestern.edu/academics/courses/325/readings/lisp-unit.html>
  57   "Original Lisp Unit"
  58 [wiki]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki>
  59   "Lisp Unit Wiki"
  60 [JUnit]: <http://www.junit.org> "JUnit"
  61 [Quicklisp]: <http://www.quicklisp.org> "Quicklisp"
  62 [ASDF]: <http://common-lisp.net/project/asdf/> "ASDF"