This is testeez.egg.info, produced by makeinfo version 4.7 from
eggdoc-output.texi.

INFO-DIR-SECTION The Algorithmic Language Scheme
START-INFO-DIR-ENTRY
* testeez.egg: (testeez.egg).		A lightweight unit test mechanism for Scheme.
END-INFO-DIR-ENTRY


File: testeez.egg.info,  Node: Top,  Next: About this egg,  Up: (dir)

testeez egg
***********

A lightweight unit test mechanism for Scheme.

Written by Neil W. Van Dyke (http://www.neilvandyke.org/testeez/)

   This manual corresponds to version 0.3 of the testeez extension
library for Chicken Scheme.

* Menu:

* About this egg::
* Documentation::
* Examples::
* License::
* Index::


File: testeez.egg.info,  Node: About this egg,  Next: Documentation,  Prev: Top,  Up: Top

1 About this egg
****************

* Menu:

* Version history::
* Usage::


File: testeez.egg.info,  Node: Version history,  Next: Usage,  Up: About this egg

1.1 Version history
===================

`0.3'
     Synchronize with upstream 0.3, expose test/equiv (Zbigniew)

`0.1.1'
     test-define with low-level macros didn't show description

`0.1'
     Initial port of upstream 0.1 (Felix)


File: testeez.egg.info,  Node: Usage,  Prev: Version history,  Up: About this egg

1.2 Usage
=========

Load this egg like so:

   `(require-extension testeez)'


File: testeez.egg.info,  Node: Documentation,  Next: Examples,  Prev: About this egg,  Up: Top

2 Documentation
***************

See the official documentation
(http://www.neilvandyke.org/testeez/testeez.html).  There are a couple
of additions for Chicken:

 -- test clause: test/equiv
          (test/equiv DESC EXPR EXPECTED (PRED ...))

     Additional clause form which allows you to specify one or more
     custom equivalence predicates.  You should either specify one
     predicate, which will be checked against every value expected; or
     N predicates, where N is the number of values expected.  In the
     latter case, each predicate is checked only against its
     corresponding value.

     The form `(test/eq DESC EXPR EXPECTED)' is exactly the same as
     `(test/equiv DESC EXPR EXPECTED (eq?))'.

     This clause is non-public in the upstream version, but has been
     exposed since it seems useful.  Its syntax is subject to change.

 -- procedure: %testeez:self-test
          (%testeez:self-test)

     See example below.


File: testeez.egg.info,  Node: Examples,  Next: License,  Prev: Documentation,  Up: Top

3 Examples
**********

The following definition is made available as `%testeez:self-test' if
the `debug' feature is registered at runtime.   For example, run `csi
-D debug -R testeez -eval "(%testeez:self-test)"'.


(define (%testeez:self-test)
  (testeez
   "Foo Station"

   (test/equal "Put two and two together" (+ 2 2) 4)

   (test-define "Bar function" bar (lambda (x) (+ x 42)))

   (test/equal "Bar scene" (bar 69) 0)  ;; will fail

   (test/eqv   "Full circle" (* (bar -21) 2) 42)

   (test/equal "Multiple"
               (values (+ 2 2) (string #h #i) (char-upcase #p))
               (values 4 "hi" #P))

   (test/equiv "Multiple predicates"
               (values (+ 2 2) (string #h #i) (char-upcase #p))
               (values 4 "hi" #P)
               (eqv? string=? char=?))))

   Output:


#;1> (%testeez:self-test)

;;; BEGIN "Foo Station" TESTS

;; 1. Put two and two together
(+ 2 2)
;; ==> 4
;; Passed.

;; DEFINE: Bar function
(define bar (lambda (x) (+ x 42)))

;; 2. Bar scene
(bar 69)
;; ==> 111
;; FAILED!  Expected:
;;     0

;; 3. Full circle
(* (bar -21) 2)
;; ==> 42
;; Passed.

;; 4. Multiple
(values (+ 2 2) (string #h #i) (char-upcase #p))
;; ==> 4
;;     "hi"
;;     #P
;; Passed.

;; 5. Multiple predicates
(values (+ 2 2) (string #h #i) (char-upcase #p))
;; ==> 4
;;     "hi"
;;     #P
;; Passed.

;;; END "Foo Station" TESTS: FAILED
;;;     (Total: 5  Passed: 4  Failed: 1)


File: testeez.egg.info,  Node: License,  Next: Index,  Prev: Examples,  Up: Top

4 License
*********


Copyright (c) 2005 Neil W. Van Dyke. This program is Free Software; you can
redistribute it and/or modify it under the terms of the GNU Lesser General
Public License as published by the Free Software Foundation; either version 2.1
of the License, or (at your option) any later version. This program is
distributed in the hope that it will be useful, but without any warranty;
without even the implied warranty of merchantability or fitness for a particular
purpose.  See <http://www.gnu.org/copyleft/lesser.html> for details.  For other
license options and consulting, contact the author.


File: testeez.egg.info,  Node: Index,  Prev: License,  Up: Top

Index
*****

 [index ]
* Menu:

* %testeez:self-test:                    Documentation.        (line 27)
* test/equiv:                            Documentation.        (line 11)



Tag Table:
Node: Top252
Node: About this egg642
Node: Version history810
Node: Usage1129
Node: Documentation1293
Node: Examples2344
Node: License3849
Node: Index4544

End Tag Table