d61eb53686
Started as fixing misindented definitions, then more indentations, then a bunch of similar things (square brackets, huge spaces at end-of-lines, etc).
101 lines
3.0 KiB
Racket
101 lines
3.0 KiB
Racket
#lang scribble/doc
|
|
@(require scribble/manual
|
|
(for-label racket/base
|
|
test-engine/racket-tests
|
|
(prefix-in gui: test-engine/racket-gui)))
|
|
|
|
@title{Test Support}
|
|
|
|
@author["Kathryn Gray"]
|
|
|
|
@table-of-contents[]
|
|
|
|
@; ----------------------------------------------------------------------
|
|
|
|
@section{Using Check Forms}
|
|
|
|
@defmodule[test-engine/racket-tests]
|
|
|
|
This module provides test forms for use in Racket programs, as well
|
|
as parameters to configure the behavior of test reports.
|
|
|
|
Each check form may only occur at the top-level; results are collected
|
|
and reported by the test function. Note that the check forms only
|
|
register checks to be performed. The checks are actually run by the
|
|
@racket[test] function.
|
|
|
|
@defproc[(check-expect (test any/c) (expected any/c)) void?]{
|
|
|
|
Accepts two value-producing expressions and structurally compares the
|
|
resulting values.
|
|
|
|
It is an error to produce a function value or an inexact number.}
|
|
|
|
|
|
@defproc[(check-within (test any/c) (expected any/c) (delta number?)) void?]{
|
|
|
|
Like @racket[check-expect], but with an extra expression that produces
|
|
a number delta. Every number in the first expression must be within
|
|
delta of the cooresponding number in the second expression.
|
|
|
|
It is an error to produce a function value.}
|
|
|
|
|
|
@defproc*[([(check-error (test any/c) (msg string?)) void?]
|
|
[(check-error (test any/c)) void?])]{
|
|
|
|
Checks that evaluating the first expression signals an error, where
|
|
the error message matches the string, if it is present.}
|
|
|
|
@defform[(check-member-of (test any/c) (expected any/c) ...)]{
|
|
|
|
Accepts at least two value-producing expressions. Structurally compares the first
|
|
value to each value subsequent value specified.
|
|
|
|
It is an error to produce a function value.}
|
|
|
|
@defform[(check-range (test number/c) (min number/c) (max number/c))]{
|
|
|
|
Accepts three number-producing expressions. Performs the following comparison:
|
|
min <= test <= max.}
|
|
|
|
@defproc[(test) void?]{
|
|
|
|
Runs all of the tests specified by check forms in the current module
|
|
and reports the results. When using the gui module, the results are
|
|
provided in a separate window, otherwise the results are printed to
|
|
the current output port.}
|
|
|
|
@defparam[test-format format (any/c . -> . string?)]{
|
|
|
|
A parameter that stores the formatting function for the values tested
|
|
by the check forms.}
|
|
|
|
|
|
@defboolparam[test-silence silence?]{
|
|
|
|
A parameter that stores a boolean, defaults to #f, that can be used to
|
|
suppress the printed summary from test.}
|
|
|
|
|
|
@defboolparam[test-execute execute?]{
|
|
|
|
A parameter that stores a boolean, defaults to #t, that can be used to
|
|
suppress evaluation of test expressions.
|
|
}
|
|
|
|
@section{GUI Interface}
|
|
|
|
@defmodule[test-engine/racket-gui]
|
|
|
|
@; FIXME: need to actually list the bindings here, so they're found in
|
|
@; the index
|
|
|
|
This module requires GRacket and produces an independent window when
|
|
displaying test results. It provides the same bindings as
|
|
@racket[test-engine/racket-tests].
|
|
|
|
@section{Integrating languages with Test Engine}
|
|
|
|
@italic{(To be written.)}
|