The try Reference Manual

3.1.1 try/try.asd

Source

try.asd.

Parent Component

try (system).

ASDF Systems

try.

---

3.1.2 try.asdf/try.asdf.asd

Source

try.asdf.asd.

Parent Component

try.asdf (system).

ASDF Systems

try.asdf.

---

3.1.3 try/package.lisp

Source

try.asd.

Parent Component

try (system).

Packages

try.

---

3.1.4 try/util.lisp

Dependency

package.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• on-values (macro).
• print-object (method).

Internals

• %extract-options (function).
• %unwind-protect (macro).
• %wrap-restart-bind-binding-in-lambda (function).
• %wrap-restart-bind-option-in-lambda (function).
• %wrap-restart-case-binding-in-lambda (function).
• %wrap-restart-case-option-in-lambda (function).
• *dummy* (special variable).
• *start-time* (special variable).
• *testing-timing* (special variable).
• bool= (function).
• compiler-policy (function).
• compiler-policy-quantity (function).
• dummy-with-print-object (class).
• ensure-list (function).
• ensure-rest-arg (function).
• get-elapsed-seconds (function).
• intern-hyphenated (function).
• lambda-list-to-arglist-form (function).
• lambda-list-with-&rest-to-arglist-form (function).
• make-gensym (function).
• on-finish (macro).
• on-nlx (macro).
• on-return (macro).
• present-body (function).
• restart-bind (macro).
• restart-case (macro).
• safe-subtypep (function).
• safe-typep (function).
• shuffle (function).
• shuffle! (function).
• shuffle-vector! (function).
• subseq* (function).
• valid-type-specifier (type).
• valid-type-specifier-p (function).
• with-bindings (macro).
• with-circularity-detection (macro).
• with-debugger-hook (macro).
• with-debugger-hook-form (macro).
• with-gensyms (macro).
• with-retry/catch (macro).
• with-retry/go (macro).
• with-timing (macro).
• without-tail-call (macro).

---

3.1.5 try/gray-stream.lisp

Dependency

util.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• close (method).
• initialize-instance (method).
• stream-element-type (method).
• stream-line-column (method).
• stream-write-char (method).

Internals

• column (reader method).
• (setf column) (writer method).
• inner-stream (reader method).
• line (reader method).
• (setf line) (writer method).
• line/column-character-output-stream (class).
• stream-column (generic function).
• stream-line (generic function).
• stream-line-column* (function).
• sync-stream-line-column (function).
• wrapped-stream (class).

---

3.1.6 try/early.lisp

Dependency

gray-stream.lisp (file).

Source

try.asd.

Parent Component

try (system).

Internals

• *record-event* (special variable).
• *trial* (special variable).
• *try-id* (special variable).

---

3.1.7 try/debug.lisp

Dependency

early.lisp (file).

Source

try.asd.

Parent Component

try (system).

Internals

• *dbg* (special variable).
• *internal-error* (special variable).
• dbg (macro).
• nested-error (reader method).
• try-internal-error (condition).
• with-internal-errors (macro).

---

3.1.8 try/events.lisp

Dependency

debug.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• *categories* (special variable).
• *event-print-bindings* (special variable).
• abort* (condition).
• ascii-std-categories (function).
• dismissal (condition).
• event (condition).
• expected (condition).
• expected-failure (type).
• expected-success (type).
• fail (type).
• failure (condition).
• fancy-std-categories (function).
• leaf (condition).
• pass (type).
• print-object (method).
• record-event (function).
• success (condition).
• unexpected (condition).
• unexpected-failure (type).
• unexpected-success (type).

Internals

• @try/categories (special variable).
• @try/concrete-events (special variable).
• @try/event-glue (special variable).
• @try/event-restarts (special variable).
• @try/events (special variable).
• @try/middle-layer-of-events (special variable).
• @try/printing-events (special variable).
• category-marker (function).
• combine-superclasses (function).
• define-combi-event (macro).
• event-category (function).
• signal-with-record-event (function).
• write-event (generic function).

---

3.1.9 try/outcome.lisp

Dependency

events.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• abort-check (function).
• force-expected-failure (function).
• force-expected-success (function).
• force-unexpected-failure (function).
• force-unexpected-success (function).
• outcome (condition).
• retry-check (function).
• skip (condition).
• skip-check (function).
• with-expected-outcome (macro).
• with-failure-expected (macro).
• with-skip (macro).

Internals

• *expected-outcome* (special variable).
• *skip* (special variable).
• @try/check-restarts (special variable).
• @try/checks (special variable).
• @try/outcome-restarts (special variable).
• @try/outcomes (special variable).
• basic-outcome (type).
• determine-outcome-type (function).
• report-change-outcome-to (function).
• signal-outcome (function).

---

3.1.10 try/result.lisp

Dependency

outcome.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• expected-result-failure (condition).
• expected-result-success (condition).
• result (condition).
• result-abort* (condition).
• result-skip (condition).
• unexpected-result-failure (condition).
• unexpected-result-success (condition).

Internals

• %%write-result-msg (function).
• %frob-form-for-printing (function).
• %write-result (function).
• %write-result-captures (function).
• %write-result-ctx (function).
• %write-result-msg (function).
• captures (reader method).
• check (reader method).
• ctx (reader method).
• elapsed-seconds (reader method).
• msg (reader method).
• print-captures (reader method).
• print-form-memoization-data (reader method).
• (setf print-form-memoization-data) (writer method).
• result-failure (condition).
• result-success (condition).
• substitute-tilde-percent (function).
• write-event (method).

---

3.1.11 try/is.lisp

Dependency

result.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• *is-captures* (special variable).
• *is-form* (special variable).
• canonicalize-format-specifier-form (function).
• capture (macro).
• capture-values (macro).
• is (macro).
• make-sub (function).
• sub (structure).
• sub-new-form (reader).
• (setf sub-new-form) (writer).
• sub-subform (reader).
• (setf sub-subform) (writer).
• sub-valuesp (reader).
• (setf sub-valuesp) (writer).
• sub-var (reader).
• (setf sub-var) (writer).
• substitute-is-list-form (generic function).

Internals

• %subs-to-bindings (function).
• %subs-to-captures (function).
• @try/automatic-captures (special variable).
• @try/captures (special variable).
• @try/explicit-captures (special variable).
• @try/format-specifier-forms (special variable).
• @try/is (special variable).
• @try/writing-automatic-capture-rules (special variable).
• capture-explicitp (function).
• (setf capture-explicitp) (function).
• capture-subform (function).
• (setf capture-subform) (function).
• capture-value (function).
• (setf capture-value) (function).
• capture-valuesp (function).
• (setf capture-valuesp) (function).
• constantishp (function).
• copy-sub (function).
• define-macrolet (macro).
• macrolet-dref (class).
• make-capture (function).
• same-but-different-implicit-captures-p (function).
• scrub-captures (function).
• signal-is-outcome (function).
• strip-outer-%-and-%%-from-implicit-captures (function).
• sub-p (function).
• substitute-args (function).
• substitute-in-subs (function).
• substitute-is-form (function).

---

3.1.12 try/checks.lisp

Dependency

is.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• *best-matching-condition* (special variable).
• *condition-matched-p* (special variable).
• *in-time-elapsed-seconds* (special variable).
• different-elements (function).
• fails (macro).
• in-time (macro).
• invokes-debugger (macro).
• invokes-debugger-not (macro).
• match-values (macro).
• mismatch% (function).
• same-set-p (function).
• signals (macro).
• signals-not (macro).
• substitute-is-list-form (method).
• with-shuffling (macro).

Internals

• %describe-condition-for-matching (function).
• %match-condition (function).
• @try/check-library (special variable).
• @try/check-utilities (special variable).
• @try/checking-conditions (special variable).
• @try/misc-checks (special variable).
• check-fails (function).
• check-invokes-debugger (function).
• check-invokes-debugger-not (function).
• check-signals (function).
• check-signals-not (function).
• condition-match-checker (macro).
• invokes-debugger-default-ctx (function).
• invokes-debugger-default-msg (function).
• invokes-debugger-not-default-msg (function).
• match-values% (macro).
• with-condition-matching (macro).

---

3.1.13 try/floats.lisp

Dependency

checks.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• *max-diff-in-ulp* (special variable).
• *max-diff-in-value* (special variable).
• float-~< (function).
• float-~= (function).
• float-~> (function).

Internals

• @try/comparing-floats (special variable).
• double-float-~= (function).
• single-float-~= (function).

---

3.1.14 try/trial-event.lisp

Dependency

floats.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• expected-verdict-failure (condition).
• expected-verdict-success (condition).
• trial (reader method).
• trial-event (condition).
• trial-start (condition).
• unexpected-verdict-failure (condition).
• unexpected-verdict-success (condition).
• verdict (condition).
• verdict-abort* (condition).
• verdict-skip (condition).

Internals

• @try/trial-events (special variable).
• elapsed-seconds (reader method).
• verdict-failure (condition).
• verdict-success (condition).
• write-event (method).
• write-event (method).

---

3.1.15 try/error.lisp

Dependency

trial-event.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• *gather-backtrace* (special variable).
• backtrace-of (reader method).
• debugger-invoked-p (reader method).
• error* (condition).
• nested-condition (reader method).
• nlx (condition).
• test-name (reader method).
• unhandled-error (condition).

Internals

• *print-backtrace* (special variable).
• @try/errors (special variable).
• basic-error*-outcome (type).
• describe-condition (function).
• extra-message (reader method).
• maybe-backtrace (function).
• signal-error* (function).
• write-event (method).
• write-event (method).

---

3.1.16 try/count.lisp

Dependency

error.lisp (file).

Source

try.asd.

Parent Component

try (system).

Internals

• %make-counter (function).
• @try/count (special variable).
• add-to-counter (function).
• bump-counter (function).
• copy-counter (function).
• counter (structure).
• counter-categories (reader).
• (setf counter-categories) (writer).
• counter-counts (reader).
• (setf counter-counts) (writer).
• counter-p (function).
• make-counter (function).
• reset-counter (function).

---

3.1.17 try/trial.lisp

Dependency

count.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• abort-trial (function).
• children (reader method).
• current-trial (function).
• failedp (function).
• initialize-instance (method).
• n-retries (reader method).
• passedp (function).
• print-object (method).
• retry-trial (function).
• runningp (function).
• skip-trial (function).
• test-name (reader method).
• trial (class).
• trial-start (reader method).
• verdict (reader method).

Internals

• %trial-basic-verdict (function).
• @try/trial-restarts (special variable).
• @try/trial-verdicts (special variable).
• @try/trials (special variable).
• abort-restart (reader method).
• (setf abort-restart) (writer method).
• categories (reader method).
• cform (reader method).
• check-trial-running (function).
• clean-up-cancelled-nlx-of-retry-for-end-trial (function).
• clear-trial-restarts (function).
• count-of (reader method).
• counter (reader method).
• depth (reader method).
• elapsed-seconds (reader method).
• end-trial (function).
• has-non-collected-failed-child-p (reader method).
• how-it-ended (reader method).
• how-to-end (reader method).
• (setf how-to-end) (writer method).
• lambda-trial-p (function).
• named-trial-p (function).
• non-collected-counter (reader method).
• parent (reader method).
• retry-restart (reader method).
• (setf retry-restart) (writer method).
• say-how-to-end (function).
• set-up-trial-restarts (function).
• skip-restart (reader method).
• (setf skip-restart) (writer method).
• start-retry-for-trial (function).
• start-trial (function).
• trialp (function).
• try-trial-p (function).
• try-trial-testable (function).
• verdict-for-trial-p (function).
• with-error*-handled (macro).
• with-trial (macro).
• with-trial-restarts (macro).

---

3.1.18 try/test.lisp

Dependency

trial.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• *run-deftest-when* (special variable).
• deftest (macro).
• list-package-tests (function).
• test-bound-p (function).
• warn-on-tests-not-run (macro).
• with-test (macro).
• with-tests-run (macro).

Internals

• *call-test* (special variable).
• *call-test-fn* (special variable).
• *tests-run* (special variable).
• *trial-initargs* (special variable).
• @try/tests (special variable).
• call-test (function).
• deftest-registry-var-name (function).
• ensure-deftest-registry (function).
• expand-with-trial-in-deftest-p (function).
• get-deftest-registry (function).
• invoke-test-interactively (function).
• make-trial (function).
• maybe-mark-test-run (function).
• read-argument-list (function).
• register-deftest (function).
• wrap-trial-body-for-return (macro).

---

3.1.19 try/testable.lisp

Dependency

test.lisp (file).

Source

try.asd.

Parent Component

try (system).

Internals

• @try/testables (special variable).
• call-testable (function).
• call-with-wrapper (function).
• list-function-designators (function).

---

3.1.20 try/rerun.lisp

Dependency

testable.lisp (file).

Source

try.asd.

Parent Component

try (system).

Internals

• %make-rerun-trial-event-handler (function).
• @try/rerun (special variable).
• call-lambda-trial (function).
• call-named-trial (function).
• call-trial (function).
• call-try-trial (function).
• child-trials (function).
• trial-call-= (function).
• trial-has-event-of-type-p (function).

---

3.1.21 try/print.lisp

Dependency

rerun.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• *defer-describe* (special variable).
• *print-compactly* (special variable).
• *print-duration* (special variable).
• *print-indentation* (special variable).
• *print-parent* (special variable).
• initialize-instance (method).
• tree-printer (class).

Internals

• %ensure-new-line (function).
• %ensure-trial-printed (function).
• %make-indent (function).
• %print-event (function).
• %print-indent-for (function).
• %print-leaf (function).
• %print-verdict (function).
• @try/print (special variable).
• ancestor-trial-names (function).
• ancestors-from-oldest (function).
• copy-print-state (function).
• defer-describe (reader method).
• describe-leaf (generic function).
• describe-to-be-described (function).
• describe-type (reader method).
• event-print-depth (function).
• finish-printing (generic function).
• indentation (reader method).
• make-print-state (function).
• print-compactly (reader method).
• print-duration (function).
• print-duration-p (reader method).
• print-event (generic function).
• print-event-header (function).
• print-parent (reader method).
• print-state (structure).
• print-state-first-line-and-column (reader).
• (setf print-state-first-line-and-column) (writer).
• print-state-n-retries (reader).
• (setf print-state-n-retries) (writer).
• print-state-p (function).
• print-state-trial (reader).
• (setf print-state-trial) (writer).
• print-state-trial-printed-p (function).
• print-type (reader method).
• printer (class).
• printer-depth (function).
• stream-of (reader method).
• to-be-described (reader method).
• (setf to-be-described) (writer method).
• trial-print-states (reader method).
• trial-printed-p (function).
• write-trial-counts (function).

---

3.1.22 try/collect.lisp

Dependency

print.lisp (file).

Source

try.asd.

Parent Component

try (system).

Internals

• %collector (structure).
• %collector-collect-type (reader).
• (setf %collector-collect-type) (writer).
• %collector-count-type (reader).
• (setf %collector-count-type) (writer).
• %collector-p (function).
• %count-and-collect-event (function).
• @try/collect (special variable).
• copy-%collector (function).
• count-and-collect-leaf (function).
• count-and-collect-verdict (function).
• count-collected-leaf (function).
• count-collected-verdict (function).
• count-non-collected-leaf (function).
• count-non-collected-verdict (function).
• count-trial-start (function).
• make-%collector (function).

---

3.1.23 try/try.lisp

Dependency

collect.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

• ! (special variable).
• !! (special variable).
• !!! (special variable).
• *collect* (special variable).
• *count* (special variable).
• *debug* (special variable).
• *describe* (special variable).
• *n-recent-trials* (special variable).
• *print* (special variable).
• *printer* (special variable).
• *rerun* (special variable).
• *stream* (special variable).
• *try-collect* (special variable).
• *try-count* (special variable).
• *try-debug* (special variable).
• *try-describe* (special variable).
• *try-print* (special variable).
• *try-printer* (special variable).
• *try-rerun* (special variable).
• *try-stream* (special variable).
• recent-trial (function).
• set-try-debug (function).
• try (function).

Internals

• %maybe-invoke-debugger (function).
• *invoking-debugger* (special variable).
• *recent-trials* (special variable).
• @try/explicit-try (special variable).
• @try/implicit-try (special variable).
• @try/implicit-try-implementation (special variable).
• add-to-recent-trials (function).
• check-event-type (function).
• check-printer-arg (function).
• read-try-debug (function).
• remembering-most-recent-trials (macro).
• try-default-unspecified-args (macro).
• try-for-emacs (function).
• try/implicit (function).
• with-current-debug (macro).
• with-try-context (macro).

---

3.1.24 try/replay.lisp

Dependency

try.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

replay-events (function).

Internals

• %replay-events (function).
• %replay-trial-initargs (function).
• @try/replay (special variable).

---

3.1.25 try/manual.lisp

Dependency

replay.lisp (file).

Source

try.asd.

Parent Component

try (system).

Public Interface

install-try-elisp (function).

Internals

• @cancelled-nlx (special variable).
• @funcallable-instance (special variable).
• @try-manual (special variable).
• @try/emacs (special variable).
• @try/emacs-setup (special variable).
• @try/glossary (special variable).
• @try/implementation-notes (special variable).
• @try/links (special variable).
• @try/tutorial (special variable).

---

3.1.26 try/doc.lisp

Dependency

manual.lisp (file).

Source

try.asd.

Parent Component

try (system).

Internals

• pax-pages (function).
• pax-sections (function).
• try-transcript (function).
• try-transcript-normalize-output (function).
• try-transcript-normalize-unreadable (function).
• try-transcript-output= (function).
• try-transcript-unreadable= (function).
• try-transcript-upcase-trial (function).

---

3.1.27 try.asdf/asdf.lisp

Source

try.asdf.asd.

Parent Component

try.asdf (system).

Packages

try/asdf.

Public Interface

compile-wrapper (function).

---

5.1.1 Special variables

Special Variable: ! ¶

The most recent trial. Equivalent to ‘(RECENT-TRIAL 0)‘.

Package

try.

Source

try.lisp.

Special Variable: !! ¶

Equivalent to ‘(RECENT-TRIAL 1)‘.

Package

try.

Source

try.lisp.

Special Variable: !!! ¶

Equivalent to ‘(RECENT-TRIAL 2)‘.

Package

try.

Source

try.lisp.

Special Variable: *best-matching-condition* ¶

Bound when a check described in @TRY/CHECKING-CONDITIONS
signals its OUTCOME. If *CONDITION-MATCHED-P*, then it is the most recent condition that matched both CONDITION-TYPE and PRED. Else, it is the most recent condition that matched CONDITION-TYPE or NIL if no such conditions were detected.

Package

try.

Source

checks.lisp.

Special Variable: *categories* ¶

A list of of elements like ‘(TYPE &KEY MARKER)‘.
When @TRY/PRINT, @TRY/CONCRETE-EVENTS are printed with the marker of the first matching type. When @TRY/COUNT, the counts associated with all matching types are incremented.

Package

try.

Source

events.lisp.

Special Variable: *collect* ¶

To save memory, only the UNEXPECTED are collected by default. See @TRY/COLLECT.

Package

try.

Source

try.lisp.

Special Variable: *condition-matched-p* ¶

When a check described in @TRY/CHECKING-CONDITIONS signals its OUTCOME, this variable is bound to a boolean value to indicate whether a condition that matched CONDITION-TYPE and PRED was found.

Package

try.

Source

checks.lisp.

Special Variable: *count* ¶

Although the default value of *CATEGORIES* lumps RESULTs and VERDICTs together, with the default of LEAF, VERDICTs are not counted. See @TRY/COUNT.

Package

try.

Source

try.lisp.

Special Variable: *debug* ¶

The default value makes TRY invoke the debugger on UNHANDLED-ERROR, RESULT-ABORT*, UNEXPECTED-RESULT-FAILURE, and UNEXPECTED-RESULT-SUCCESS. NLX is excluded because it is caught as the test function is being exited, but by that time the dynamic environment of the actual cause is likely gone. VERDICT is excluded because it is a consequence of its child outcomes.

Package

try.

Source

try.lisp.

Special Variable: *defer-describe* ¶

When an EVENT is to be ‘*DESCRIBE*‘d and its type matches *DEFER-DESCRIBE*, then instead of printing the often longish context information in the tree of events, it is deferred until after TRY has finished. The following example only prints LEAF events (due to *PRINT* and *PRINT-PARENT*) and in compact form (see *PRINT-COMPACTLY*), deferring description of events matching *DESCRIBE* until the end.

“‘cl-transcript (:dynenv try-transcript)
(let ((*print* ’leaf)
(*print-parent* nil)
(*print-compactly* t)
(*defer-describe* t)
(*debug* nil))
(with-test (outer)
(loop repeat 10 do (is t))
(with-test (inner)
(is (= (1+ 5) 7)))))
.. ⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅⊠
..
.. ;; UNEXPECTED-RESULT-FAILURE (⊠) in OUTER INNER:
.. (IS (= #1=(1+ 5) 7))
.. where
.. #1# = 6
..
==> #<TRIAL (WITH-TEST (OUTER)) UNEXPECTED-FAILURE 0.000s ⊠1 ⋅10> “‘

Package

try.

Source

print.lisp.

Special Variable: *describe* ¶

By default, the context (e.g. @TRY/CAPTURES, and the CTX argument of is and other checks) of UNEXPECTED events is described. See @TRY/PRINT.

Package

try.

Source

try.lisp.

Special Variable: *event-print-bindings* ¶

EVENTs are conditions signalled in code that may change printer variables such as *PRINT-CIRCLE*, *PRINT-LENGTH*, etc. To control how events are printed, the list of variable bindings in *EVENT-PRINT-BINDINGS* is established whenever an EVENT is printed as if with:

“‘
(progv (mapcar #’first *event-print-bindings*)
(mapcar #’second *event-print-bindings*)
...)
“‘

The default value ensures that shared structure is recognized (see @TRY/CAPTURES). If the ‘#N#‘ syntax feels cumbersome, then change this variable.

Package

try.

Source

events.lisp.

Special Variable: *gather-backtrace* ¶

Capturing the backtrace can be expensive. *GATHER-BACKTRACE* controls whether UNHANDLED-ERRORs shall have their BACKTRACE-OF populated.

Package

try.

Source

error.lisp.

Special Variable: *in-time-elapsed-seconds* ¶

Bound to the number of seconds passed during the evaluation of BODY when IN-TIME signals its OUTCOME.

Package

try.

Source

checks.lisp.

Special Variable: *is-captures* ¶

Captures made during an IS evaluation are made available for CTX via *IS-CAPTURES*.

Package

try.

Source

is.lisp.

Special Variable: *is-form* ¶

IS binds this to its FORM argument for CTX and MSG.

Package

try.

Source

is.lisp.

Special Variable: *max-diff-in-ulp* ¶

The default value of the MAX-DIFF-IN-ULP argument of FLOAT-~=.

Package

try.

Source

floats.lisp.

Special Variable: *max-diff-in-value* ¶

The default value of the MAX-DIFF-IN-VALUE argument of FLOAT-~=.

Package

try.

Source

floats.lisp.

Special Variable: *n-recent-trials* ¶

See *RECENT-TRIALS*.

Package

try.

Source

try.lisp.

Special Variable: *print* ¶

With the default of LEAF combined with the default *PRINT-PARENT* T, only TRIALs with checks or ERROR* in them are printed. If UNEXPECTED, only the interesting things are printed. See @TRY/PRINT.

Package

try.

Source

try.lisp.

Special Variable: *print-compactly* ¶

EVENTs whose type matches *PRINT-COMPACTLY* are printed less verbosely. LEAF events are printed only with their marker, and VERDICTs of trials without printed child trials are printed with ‘=> <MARKER>‘ (see *CATEGORIES*).

“‘cl-transcript (:dynenv try-transcript)
(let ((*print-compactly* t)
(*debug* nil)
(*describe* nil))
(with-test (outer)
(loop repeat 10 do (is t))
(with-test (inner)
(is t)
(is nil)
(error "xxx"))
(loop repeat 10 do (is t))))
.. OUTER ⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅
.. INNER ⋅⊠⊟ => ⊟
.. ⋅⋅⋅⋅⋅⋅⋅⋅⋅⋅
.. ⊠ OUTER ⊟1 ⊠1 ⋅21
..
==> #<TRIAL (WITH-TEST (OUTER)) UNEXPECTED-FAILURE 0.000s ⊟1 ⊠1 ⋅21> “‘

*PRINT-COMPACTLY* has no effect on events being ‘DESCRIBE‘d.

Package

try.

Source

print.lisp.

Special Variable: *print-duration* ¶

If true, the number of seconds spent during execution is printed.

“‘cl-transcript (:check-consistency nil)
(let ((*print-duration* t)
(*debug* nil)
(*describe* nil))
(with-test (timed)
(is (progn (sleep 0.3) t))
(is (progn (sleep 0.2) t))
(error "xxx")))
.. TIMED
.. 0.300 ⋅ (IS (PROGN (SLEEP 0.3) T))
.. 0.200 ⋅ (IS (PROGN (SLEEP 0.2) T))
.. ⊟ ""xxx (SIMPLE-ERROR)
.. 0.504 ⊟ TIMED ⊟1 ⋅2
..
==> #<TRIAL (WITH-TEST (TIMED)) ABORT* 0.504s ⊟1 ⋅2>
“‘

Timing is available for all OUTCOMEs (i.e. for @TRY/CHECKS and TRIALs). Checks generally measure the time spent during evaluation the form they are wrapping. Trials measure the time between TRIAL-START and the VERDICT.

Timing information is not available for TRIAL-START and ERROR* events.

Package

try.

Source

print.lisp.

Special Variable: *print-indentation* ¶

The number of spaces each printed TRIAL increases the indentation of its children.

Package

try.

Source

print.lisp.

Special Variable: *print-parent* ¶

When an EVENT is signalled and its parent TRIAL’s type matches *PRINT-PARENT*, the trial is printed as if its TRIAL-START matched the PRINT argument of TRY.

“‘cl-transcript (:dynenv try-transcript)
(let ((*print* ’leaf)
(*print-parent* t))
(with-test (t0)
(is t)
(is t)))
.. T0
.. ⋅ (IS T)
.. ⋅ (IS T)
.. ⋅ T0 ⋅2
..
==> #<TRIAL (WITH-TEST (T0)) EXPECTED-SUCCESS 0.000s ⋅2>
“‘

“‘cl-transcript (:dynenv try-transcript)
(let ((*print* ’leaf)
(*print-parent* nil))
(with-test (t0)
(is t)
(is t)))
.. ⋅ (IS T)
.. ⋅ (IS T)
..
==> #<TRIAL (WITH-TEST (T0)) EXPECTED-SUCCESS 0.000s ⋅2>
“‘

*PRINT-PARENT* NIL combined with printing VERDICTs results in a flat output:

“‘cl-transcript (:dynenv try-transcript)
(let ((*print* ’(or leaf verdict))
(*print-parent* nil))
(with-test (outer)
(with-test (inner)
(is t :msg "inner-t"))
(is t :msg "outer-t")))
.. ⋅ inner-t
.. ⋅ INNER ⋅1
.. ⋅ outer-t
.. ⋅ OUTER ⋅2
..
==> #<TRIAL (WITH-TEST (OUTER)) EXPECTED-SUCCESS 0.000s ⋅2> “‘

Package

try.

Source

print.lisp.

Special Variable: *printer* ¶

Package

try.

Source

try.lisp.

Special Variable: *rerun* ¶

The default matches that of *COLLECT*. See @TRY/RERUN.

Package

try.

Source

try.lisp.

Special Variable: *run-deftest-when* ¶

This may be any of :COMPILE-TOPLEVEL, :LOAD-TOPLEVEL, :EXECUTE, or a list thereof. The value of *RUN-DEFTEST-WHEN* determines in what EVAL-WHEN situation to call the test function immediately after it has been defined with DEFTEST.

For interactive development, it may be convenient to set it to :EXECUTE and have the test run when the DEFTEST is evaluated (maybe with Slime ‘C-M-x‘, ‘slime-eval-defun‘). Or set it to :COMPILE-TOPLEVEL, and have it rerun on Slime ‘C-c C-c‘, ‘slime-compile-defun‘.

If the test has required arguments, an argument list is prompted for and read from *QUERY-IO*.

Package

try.

Source

test.lisp.

Special Variable: *stream* ¶

Package

try.

Source

try.lisp.

Special Variable: *try-collect* ¶

The default value for TRY’s :COLLECT argument. If :UNSPECIFIED, then the value of *COLLECT* is used instead.

Package

try.

Source

try.lisp.

Special Variable: *try-count* ¶

The default value for TRY’s :COUNT argument. If :UNSPECIFIED, then the value of *COUNT* is used instead.

Package

try.

Source

try.lisp.

Special Variable: *try-debug* ¶

The default value for TRY’s :DEBUG argument. If :UNSPECIFIED, then the value of *DEBUG* is used instead.

Package

try.

Source

try.lisp.

Special Variable: *try-describe* ¶

The default value for TRY’s :DESCRIBE argument. If :UNSPECIFIED, then the value of *DESCRIBE* is used instead.

Package

try.

Source

try.lisp.

Special Variable: *try-print* ¶

The default value for TRY’s :PRINT argument. If :UNSPECIFIED, then the value of *PRINT* is used instead.

Package

try.

Source

try.lisp.

Special Variable: *try-printer* ¶

The default value for TRY’s :PRINTER argument. If :UNSPECIFIED, then the value of *PRINTER* is used instead.

Package

try.

Source

try.lisp.

Special Variable: *try-rerun* ¶

The default value for TRY’s :RERUN argument. If :UNSPECIFIED, then the value of *RERUN* is used instead.

Package

try.

Source

try.lisp.

Special Variable: *try-stream* ¶

The default value for TRY’s :STREAM argument. If :UNSPECIFIED, then the value of *STREAM* is used instead.

Package

try.

Source

try.lisp.

---

5.1.2 Macros

Macro: capture (form) ¶

Evaluate FORM, record its primary return value if within the dynamic extent of an IS evaluation, and finally return that value. If CAPTURE is used within the lexical scope of IS, then CAPTURE itself will show up in the form that the default MSG prints. Thus it is recommended to use the equivalent MACROLET ‘%‘ in the lexical scope as ‘%‘ is removed before printing.

Package

try.

Source

is.lisp.

Macro: capture-values (form) ¶

Like CAPTURE-VALUES, but record and return all values returned by FORM. It is recommended to use the equivalent MACROLET ‘%%‘ in the lexical scope as ‘%%‘ is removed before printing.

Package

try.

Source

is.lisp.

Macro: deftest (name lambda-list &body body) ¶

DEFTEST is a wrapper around DEFUN to define global test functions. See DEFUN for a description of NAME, LAMBDA-LIST, and BODY. The behaviour common with WITH-TEST is described in @TRY/TESTS.

“‘cl-transcript (:dynenv try-transcript)
(deftest my-test ()
(write-string "hey"))
=> MY-TEST

(test-bound-p ’my-test)
=> T

(my-test)
.. hey
==> #<TRIAL (MY-TEST) EXPECTED-SUCCESS 0.000s>
“‘

Although the common case is for tests to have no arguments, DEFTEST supports general function lambda lists. Within a global test,

- NAME is bound to the TRIAL object

- the first return value is the trial

- values are not returned implicitly

- values returned with an explicit RETURN-FROM are returned as values after the trial

“‘cl-transcript (:dynenv try-transcript)
(deftest my-test ()
(prin1 my-test)
(return-from my-test (values 2 3)))

(my-test)
.. #<TRIAL (MY-TEST) RUNNING>
==> #<TRIAL (MY-TEST) EXPECTED-SUCCESS 0.000s>
=> 2
=> 3
“‘

Package

try.

Source

test.lisp.

Macro: fails ((&key name msg ctx) &body body) ¶

Check that BODY performs a [non-local exit][clhs] but do not cancel it (see @CANCELLED-NLX). See @TRY/CHECK-LIBRARY for the descriptions of the other arguments.

In the following example, FAILS signals a SUCCESS.

“‘cl-transcript (:dynenv try-transcript)
(catch ’foo
(fails ()
(throw ’foo 7)))
=> 7
“‘

Next, FAILS signals an UNEXPECTED-FAILURE because BODY returns normally.

“‘cl-transcript (:dynenv try-transcript)
(fails ()
(print ’hey))
..
.. HEY
.. debugger invoked on UNEXPECTED-RESULT-FAILURE:
.. UNEXPECTED-FAILURE in check:
.. (PRINT ’HEY) does not return normally.
“‘

Note that there is no ‘FAILS-NOT‘ as WITH-TEST fills that role.

Package

try.

Source

checks.lisp.

Macro: in-time ((seconds &key on-return on-nlx name msg ctx) &body body) ¶

Check that BODY finishes in SECONDS. See @TRY/CHECK-LIBRARY for the descriptions of the other arguments.

“‘
(in-time (1)
(sleep 2))
.. debugger invoked on UNEXPECTED-RESULT-FAILURE:
.. UNEXPECTED-FAILURE in check:
.. (SLEEP 2) finishes within 1s.
.. Took 2.000s.
“‘

RETRY-CHECK restarts timing.

Package

try.

Source

checks.lisp.

Macro: invokes-debugger ((condition-type &key pred handler on-return on-nlx name msg ctx) &body body) ¶

Check that BODY enters the debugger with a CONDITION of CONDITION-TYPE (not evaluated) that matches PRED. To detect matching conditions, INVOKES-DEBUGGER sets up a *DEBUGGER-HOOK*. Thus, if *DEBUGGER-HOOK* is changed by BODY, it may not detect the condition. The arguments are described in @TRY/CHECKING-CONDITIONS.

Note that in a trial (see CURRENT-TRIAL), all ERRORs are handled, and a *DEBUGGER-HOOK* is set up (see UNHANDLED-ERROR). Thus, invoking debugger would normally cause the trial to abort.

“‘cl-transcript (:dynenv try-transcript)
(invokes-debugger (error :pred "xxx")
(handler-bind ((error #’invoke-debugger))
(error "xxx")))
=> NIL
“‘

Package

try.

Source

checks.lisp.

Macro: invokes-debugger-not ((condition-type &key pred handler on-return on-nlx name msg ctx) &body body) ¶

Check that BODY does not enter the debugger with a CONDITION of CONDITION-TYPE (not evaluated) that matches PRED. To detect matching conditions, INVOKES-DEBUGGER-NOT sets up a *DEBUGGER-HOOK*. Thus, if *DEBUGGER-HOOK* is changed by BODY, it may not detect the condition. The arguments are described in @TRY/CHECKING-CONDITIONS.

Package

try.

Source

checks.lisp.

Macro: is (form &key msg ctx capture print-captures retry) ¶

Evaluate FORM and signal a RESULT SUCCESS if its first return value is not NIL, else signal a RESULT FAILURE (see @TRY/OUTCOMES). IS returns normally if

- the RECORD-EVENT restart is invoked (available when running in a trial), or
- the CONTINUE restart is invoked (available when not running in a trial), or
- the signalled RESULT condition is not handled (possible only when not running in a trial, and the result is a PASS).

The return value of IS is T if the last condition signalled is a SUCCESS, and NIL otherwise.

MSG and CTX are @TRY/FORMAT-SPECIFIER-FORMS. MSG prints a description of the check being made, which is by default the whole IS form. Due to how conditions are printed, MSG says what the desired outcome is, and CTX provides information about the evaluation.

“‘cl-transcript (:check-consistency #+sbcl t #-sbcl nil)
(is (equal (prin1-to-string ’hello) "hello")
:msg "Symbols are replacements for strings."
:ctx ("*PACKAGE* is ~S and *PRINT-CASE* is ~S~%"
*package* *print-case*))
.. debugger invoked on UNEXPECTED-RESULT-FAILURE:
.. UNEXPECTED-FAILURE in check:
.. Symbols are replacements for strings.
.. where
.. (PRIN1-TO-STRING ’HELLO) = "HELLO"
.. *PACKAGE* is #<PACKAGE "TRY"> and *PRINT-CASE* is :UPCASE ..
“‘

If CAPTURE is true, the value(s) of some subforms of FORM may be automatically recorded in the condition and also made available for CTX via *IS-CAPTURES*. See @TRY/CAPTURES for more.

If PRINT-CAPTURES is true, the captures made are printed when the RESULT condition is displayed in the debugger or ‘*DESCRIBE*‘d (see @TRY/PRINT). This is the ‘where (PRIN1-TO-STRING ’HELLO) ="HELLO"‘ part above. If PRINT-CAPTURES is NIL, the captures are still available in *IS-CAPTURES* for writing custom CTX messages.

If RETRY is true, then the RETRY-CHECK restart evaluates FORM again and signals a new RESULT. If RETRY is NIL, then the RETRY-CHECK restart returns :RETRY, which allows complex checks such as SIGNALS to implement their own retry mechanism.

Package

try.

Source

is.lisp.

Macro: match-values (form &body body) ¶

MATCH-VALUES returns true iff all return values of FORM satisfy the predicates given by BODY, which are described in ON-VALUES. The :TRUNCATE option of ON-VALUES is supported, but :ON-LENGTH-MISMATCH always returns NIL.

“‘cl-transcript (:dynenv try-transcript)
;; no values
(is (match-values (values)))
;; single value success
(is (match-values 1
(= * 1)))
;; success with different types
(is (match-values (values 1 "sdf")
(= * 1)
(string= * "sdf")))
;; too few values
(is (not (match-values 1
(= * 1)
(string= * "sdf"))))
;; too many values
(is (not (match-values (values 1 "sdf" 3)
(= * 1)
(string= * "sdf"))))
;; too many values, but truncated
(is (match-values (values 1 "sdf" 3)
(:truncate t)
(= * 1)
(string= * "sdf")))
“‘

Package

try.

Source

checks.lisp.

Macro: on-values (form &body body) ¶

ON-VALUES evaluates FORM and transforms its return values one by one based on forms in BODY. The Nth value is replaced by the return value of the Nth form of BODY evaluated with [‘*‘][dislocated] bound to the Nth value. If the number of values exceeds the number of transformation forms in BODY then the excess values are returned as is.

“‘cl-transcript
(on-values (values 1 "abc" 7)
(1+ *)
(length *))
=> 2
=> 3
=> 7
“‘

If the number of values is less than the number of transformation forms, then in later transformation forms [‘*‘][dislocated] is bound to NIL.

“‘cl-transcript
(on-values (values)
*
*)
=> NIL
=> NIL
“‘

The first forms in BODY may be options. Options must precede transformation forms. With :TRUNCATE T, the excess values are discarded.

“‘cl-transcript
(on-values (values 1 "abc" 7)
(:truncate t)
(1+ *)
(length *))
=> 2
=> 3
“‘

The :ON-LENGTH-MISMATCH option may be NIL or a function of a single argument. If the number of values and the number of transformation forms are different, then this function is called to transform the list of values. :TRUNCATE is handled before :ON-LENGTH-MISMATCH.

“‘cl-transcript
(on-values 1
(:on-length-mismatch (lambda (values)
(if (= (length values) 1)
(append values ’("abc")) values)))
(1+ *)
*)
=> 2
=> "abc"
“‘

If the same option is specified multiple times, the first one is in effect.

Package

try.

Source

util.lisp.

Macro: signals ((condition-type &key pred handler on-return on-nlx name msg ctx) &body body) ¶

Check that BODY signals a CONDITION of CONDITION-TYPE (not evaluated) that matches PRED. To detect matching conditions, SIGNALS sets up a HANDLER-BIND. Thus it can only see what BODY does not handle. The arguments are described in @TRY/CHECKING-CONDITIONS.

“‘cl-transcript (:dynenv try-transcript)
(signals (error)
(error "xxx"))
=> NIL
“‘

The following example shows a failure where CONDITION-TYPE matches but PRED does not.

“‘cl-transcript (:dynenv try-transcript)
(signals (error :pred "non-matching")
(error "xxx"))
.. debugger invoked on UNEXPECTED-RESULT-FAILURE:
.. UNEXPECTED-FAILURE in check:
.. (ERROR "xxx") signals a condition of type ERROR that matches .. "non-matching".
.. The predicate did not match "xxx".
“‘

Package

try.

Source

checks.lisp.

Macro: signals-not ((condition-type &key pred handler on-return on-nlx name msg ctx) &body body) ¶

Check that BODY does not signal a CONDITION of CONDITION-TYPE (not evaluated) that matches PRED. To detect matching conditions, SIGNALS-NOT sets up a HANDLER-BIND. Thus, it can only see what BODY does not handle. The arguments are described in @TRY/CHECKING-CONDITIONS.

Package

try.

Source

checks.lisp.

Macro: warn-on-tests-not-run ((&optional package) &body body) ¶

A convenience utility to that records the global tests run by BODY with WITH-TESTS-RUN and, when BODY finishes, signals a warning for each global tests in PACKAGE not run.

This is how Try runs its own tests:

“‘
(defun test ()
;; Bind *PACKAGE* so that names of tests printed have package names, ;; and M-. works on them in Slime.
(let ((*package* (find-package :common-lisp))) (warn-on-tests-not-run ((find-package :try))
(print (try ’test-all
:print ’unexpected
:describe ’unexpected)))))
“‘

Package

try.

Source

test.lisp.

Macro: with-expected-outcome ((expected-type) &body body) ¶

When an OUTCOME is to be signalled, EXPECTED-TYPE determines
whether it’s going to be EXPECTED. The concrete OUTCOME classes are ‘{EXPECTED,UNEXPECTED}-{RESULT,VERDICT}-{SUCCESS,FAILURE}‘ (see @TRY/EVENTS), of which RESULT or VERDICT and SUCCESS or FAILURE are already known. If a RESULT FAILURE is to be signalled, then the
moral equivalent of ‘(SUBTYPEP ’(AND RESULT FAILURE) EXPECTED-TYPE)‘
is evaluated and depending on whether it’s true, EXPECTED-RESULT-FAILURE or UNEXPECTED-RESULT-FAILURE is signalled.

By default, SUCCESS is expected. The following example shows how to expect both SUCCESS and FAILURE for RESULTs, while requiring
VERDICTs to succeed:

“‘cl-transcript (:dynenv try-transcript)
(let ((*debug* nil))
(with-expected-outcome (’(or result (and verdict success))) (with-test (t1)
(is nil))))
.. T1
.. × (IS NIL)
.. ⋅ T1 ×1
..
==> #<TRIAL (WITH-TEST (T1)) EXPECTED-SUCCESS 0.000s ×1>
“‘

This is equivalent to ‘(WITH-FAILURE-EXPECTED () ...)‘. To make
result failures expected but result successes unexpected:

“‘cl-transcript (:dynenv try-transcript)
(let ((*debug* nil))
(with-expected-outcome (’(or (and result failure) (and verdict success))) (with-test (t1)
(is t)
(is nil))))
.. T1
.. ⊡ (IS T)
.. × (IS NIL)
.. ⋅ T1 ⊡1 ×1
..
==> #<TRIAL (WITH-TEST (T1)) EXPECTED-SUCCESS 0.000s ⊡1 ×1>
“‘

This is equivalent to ‘(WITH-FAILURE-EXPECTED (’FAILURE) ...)‘. The final example leaves result failures unexpected but makes both
verdict successes and failures expected:

“‘cl-transcript (:dynenv try-transcript)
(let ((*debug* nil))
(with-expected-outcome (’(or (and result success) verdict)) (with-test (t1)
(is nil))))
.. T1
.. ⊠ (IS NIL)
.. × T1 ⊠1
..
==> #<TRIAL (WITH-TEST (T1)) EXPECTED-FAILURE 0.004s ⊠1>
“‘

Package

try.

Source

outcome.lisp.

Macro: with-failure-expected ((&optional result-expected-type verdict-expected-type) &body body) ¶

A convenience macro on top of WITH-EXPECTED-OUTCOME, WITH-FAILURE-EXPECTED expects VERDICTs to have VERDICT-EXPECTED-TYPE and RESULTs to have RESULT-EXPECTED-TYPE. A simple ‘(WITH-FAILURE-EXPECTED () ...)‘ makes all RESULT SUCCESSes and FAILUREs EXPECTED. ‘(WITH-FAILURE-EXPECTED (’FAILURE) ..)‘ expects FAILUREs only, and any SUCCESSes will be UNEXPECTED.

Package

try.

Source

outcome.lisp.

Macro: with-shuffling (() &body body) ¶

Execute the forms that make up the list of forms BODY in random order and return NIL. This may be useful to prevent writing tests that accidentally depend on the order in which subtests are called.

“‘cl-transcript (:check-consistency nil)
(loop repeat 3 do
(with-shuffling ()
(prin1 1)
(prin1 2)))
.. 122112
=> NIL
“‘

Package

try.

Source

checks.lisp.

Macro: with-skip ((&optional skip) &body body) ¶

WITH-SKIP skips checks and trials. It forces an immediate SKIP-TRIAL whenever a trial is started (which turns into a VERDICT-SKIP) and makes checks (without intervening trials, of course) evaluate normally but signal RESULT-SKIP. SKIP is NIL cancels the effect of any enclosing WITH-SKIP with SKIP true.

Package

try.

Source

outcome.lisp.

Macro: with-test ((&optional trial-var &key name) &body body) ¶

Define a so-called lambda test to group together CHECKs and other tests it executes. WITH-TEST executes BODY in its lexical environment even on a rerun (see @TRY/RERUN).

If TRIAL-VAR is a non-‘NIL‘ symbol, bind it to the trial object. NAME may be any type, it is purely for presentation purposes. If NAME is NIL, then it defaults to TRIAL-VAR.

To facilitate returning values, a BLOCK is wrapped around BODY. The name of the block is TRIAL-VAR if it is a symbol, else it’s NIL.

When both TRIAL-VAR and NAME are specified:

“‘cl-transcript (:dynenv try-transcript)
(with-test (some-feature :name "obscure feature")
(prin1 some-feature)
(is t)
(return-from some-feature (values 1 2)))
.. #<TRIAL (WITH-TEST ("obscure feature")) RUNNING>
.. obscure feature
.. ⋅ (IS T)
.. ⋅ obscure feature ⋅1
..
==> #<TRIAL (WITH-TEST ("obscure feature")) EXPECTED-SUCCESS 0.002s ⋅1> => 1
=> 2
“‘

If only TRIAL-VAR is specified:

“‘cl-transcript (:dynenv try-transcript)
(with-test (some-feature)
(prin1 some-feature)
(is t)
(return-from some-feature (values 1 2)))
.. #<TRIAL (WITH-TEST (SOME-FEATURE)) RUNNING>
.. SOME-FEATURE
.. ⋅ (IS T)
.. ⋅ SOME-FEATURE ⋅1
..
==> #<TRIAL (WITH-TEST (SOME-FEATURE)) EXPECTED-SUCCESS 0.000s ⋅1> => 1
=> 2
“‘

If neither is specified:

“‘cl-transcript (:dynenv try-transcript)
(with-test ()
(prin1 (current-trial))
(is t)
(return (values 1 2)))
.. #<TRIAL (WITH-TEST (NIL)) RUNNING>
.. NIL
.. ⋅ (IS T)
.. ⋅ NIL ⋅1
..
==> #<TRIAL (WITH-TEST (NIL)) EXPECTED-SUCCESS 0.000s ⋅1>
=> 1
=> 2
“‘

Finally, using that NAME defaults to TRIAL-VAR and that it is valid to specify non-symbols for TRIAL-VAR, one can also write:

“‘cl-transcript (:dynenv try-transcript)
(with-test ("Some feature")
(prin1 (current-trial))
(is t)
(return (values 1 2)))
.. #<TRIAL (WITH-TEST ("Some feature")) RUNNING>
.. Some feature
.. ⋅ (IS T)
.. ⋅ Some feature ⋅1
..
==> #<TRIAL (WITH-TEST ("Some feature")) EXPECTED-SUCCESS 0.000s ⋅1> => 1
=> 2
“‘

In summary and in contrast to global tests (those defined with DEFTEST), lambda tests

- have no arguments,
- are defined and called at the same time,
- may not bind their trial object to any variable,
- may have a BLOCK named NIL,
- have a NAME purely for presentation purposes.

Lambda tests can be thought of as analogous to ‘(FUNCALL (LAMBDA () BODY))‘. The presence of the LAMBDA is important because it is stored in the TRIAL object to support @TRY/RERUN.

Package

try.

Source

test.lisp.

Macro: with-tests-run ((tests-run) &body body) ¶

Bind the symbol TESTS-RUN to an empty ‘EQ‘ hash table and execute BODY. The has table reflects call counts to global tests. Keys are symbols naming global tests, and the values are the number of times the keys have been called.

Package

try.

Source

test.lisp.

---

5.1.3 Ordinary functions

Function: abort-check (&optional condition) ¶

Change the OUTCOME of the check being signalled to ‘RESULT-ABORT*‘. ‘RESULT-ABORT*‘, being ‘(NOT PASS)‘, will cause the check to return NIL if RECORD-EVENT is invoked on it.

Package

try.

Source

outcome.lisp.

Function: abort-trial (&optional condition trial) ¶

Invoke the ABORT-TRIAL restart of a RUNNINGP TRIAL.

When CONDITION is a VERDICT for TRIAL, ABORT-TRIAL signals a new verdict of type VERDICT-ABORT\*. This behavior is similar to that of ABORT-CHECK. Else, the ABORT-TRIAL restart may record CONDITION, then it initiates a [non-local exit][clhs] to return from the test function with VERDICT-ABORT\*. If during the unwinding SKIP-TRIAL or RETRY-TRIAL is called, then the abort is cancelled.

Since ABORT* is an UNEXPECTED EVENT, ABORT-TRIAL is rarely used programatically. Signalling any error in a trial that’s not caught before the trial’s handler catches it will get turned into an UNHANDLED-ERROR, and TRY will invoke ABORT-TRIAL with it. Thus, instead of invoking ABORT-TRIAL directly, signalling an error will often suffice.

Package

try.

Source

trial.lisp.

Function: ascii-std-categories () ¶

Returns a value suitable for *CATEGORIES*, which uses only ASCII characters for the markers.

“‘
’((abort* :marker "!")
(unexpected-failure :marker "F")
(unexpected-success :marker ":")
(skip :marker "-")
(expected-failure :marker "f")
(expected-success :marker "."))
“‘

Package

try.

Source

events.lisp.

Function: canonicalize-format-specifier-form (form) ¶

Ensure that the format specifier form FORM is in its full form.

Package

try.

Source

is.lisp.

Function: compile-wrapper (continuation) ¶

Package

try/asdf.

Source

asdf.lisp.

Function: current-trial () ¶

TRIALs, like the calls to tests they stand for, nest. CURRENT-TRIAL returns the innermost trial. If there is no currently running test, then an error is signalled. The returned trial is RUNNINGP.

Package

try.

Source

trial.lisp.

Function: different-elements (sequence1 sequence2 &key pred missing) ¶

Return the different elements under PRED in the given sequences as a list of ‘(:INDEX <INDEX> <E1> <E2>)‘ elements, where ‘E1‘ and ‘E2‘ are elements of SEQUENCE1 and SEQUENCE2 at ‘<INDEX>‘, respectively, and they may be MISSING if the corresponding sequence is too short.

“‘cl-transcript (:dynenv try-transcript)
(is (endp (different-elements ’(1 2 3) ’(1 b 3 d))))
.. debugger invoked on UNEXPECTED-RESULT-FAILURE:
.. UNEXPECTED-FAILURE in check:
.. (IS (ENDP #1=(DIFFERENT-ELEMENTS ’(1 2 3) ’(1 B 3 D)))) .. where
.. #1# = ((:INDEX 1 2 B) (:INDEX 3 :MISSING D))
“‘

Package

try.

Source

checks.lisp.

Function: failedp (trial) ¶

See if TRIAL has finished and its [VERDICT][(reader trial)] is a FAIL.

Package

try.

Source

trial.lisp.

Function: fancy-std-categories () ¶

Returns the default value of *CATEGORIES* (see @TRY/CATEGORIES), which contains some fancy Unicode characters.

Package

try.

Source

events.lisp.

Function: float-~< (x y &key max-diff-in-value max-diff-in-ulp) ¶

Return whether X is approximately less than Y. Equivalent to ‘<‘, but it also allows for approximate equality according to FLOAT-~=.

Package

try.

Source

floats.lisp.

Function: float-~= (x y &key max-diff-in-value max-diff-in-ulp) ¶

Return whether two numbers, X and Y, are approximately equal either according to MAX-DIFF-IN-VALUE or MAX-DIFF-IN-ULP.

If the absolute value of the difference of two floats is not greater than MAX-DIFF-IN-VALUE, then they are considered equal.

If two floats are of the same sign and the number of representable floats (ULP, unit in the last place) between them is less than MAX-DIFF-IN-ULP, then they are considered equal.

If neither X nor Y are floats, then the comparison is done with ‘=‘. If one of them is a DOUBLE-FLOAT, then the other is converted to a double float, and the comparison takes place in double float space. Else, both are converted to SINGLE-FLOAT and the comparison takes place in single float space.

Package

try.

Source

floats.lisp.

Function: float-~> (x y &key max-diff-in-value max-diff-in-ulp) ¶

Return whether X is approximately greater than Y. Equivalent to ‘>‘, but it also allows for approximate equality according to FLOAT-~=.

Package

try.

Source

floats.lisp.

Function: force-expected-failure (&optional condition) ¶

Change the type of OUTCOME being signalled to EXPECTED and FAILURE.

Package

try.

Source

outcome.lisp.

Function: force-expected-success (&optional condition) ¶

Change the type of the OUTCOME being signalled to EXPECTED and SUCCESS. If the original condition is a RESULT, then this will be EXPECTED-RESULT-SUCCESS, if it is a VERDICT, then EXPECTED-VERDICT-SUCCESS.

Package

try.

Source

outcome.lisp.

Function: force-unexpected-failure (&optional condition) ¶

Change the type of OUTCOME being signalled to UNEXPECTED and FAILURE.

Package

try.

Source

outcome.lisp.

Function: force-unexpected-success (&optional condition) ¶

Change the type of OUTCOME being signalled to UNEXPECTED and SUCCESS.

Package

try.

Source

outcome.lisp.

Function: install-try-elisp (target-dir) ¶

Copy ‘mgl-try.el‘ distributed with this package to TARGET-DIR.

Package

try.

Source

manual.lisp.

Function: list-package-tests (&optional package) ¶

List all symbols in PACKAGE that name global tests in the sense of TEST-BOUND-P.

Package

try.

Source

test.lisp.

Function: make-sub (var subform new-form valuesp) ¶

Package

try.

Source

is.lisp.

Function: mismatch% (sequence1 sequence2 &key from-end test start1 end1 start2 end2 key max-prefix-length max-suffix-length) ¶

Like CL:MISMATCH but CAPTUREs and returns the common prefix and the mismatched suffixes. The ‘TEST-NOT‘ argument is deprecated by the CLHS and is not supported. In addition, if MAX-PREFIX-LENGTH and MAX-SUFFIX-LENGTH are non-‘NIL‘, they must be non-negative integers, and they limit the number of elements in the prefix and the suffixes.

“‘cl-transcript (:dynenv try-transcript)
(is (null (mismatch% ’(1 2 3) ’(1 2 4 5))))
.. debugger invoked on UNEXPECTED-RESULT-FAILURE:
.. UNEXPECTED-FAILURE in check:
.. (IS (NULL #1=(MISMATCH% ’(1 2 3) ’(1 2 4 5))))
.. where
.. COMMON-PREFIX = (1 2)
.. MISMATCHED-SUFFIX-1 = (3)
.. MISMATCHED-SUFFIX-2 = (4 5)
.. #1# = 2
“‘

“‘cl-transcript (:dynenv try-transcript)
(is (null (mismatch% "Hello, World!"
"Hello, world!")))
.. debugger invoked on UNEXPECTED-RESULT-FAILURE:
.. UNEXPECTED-FAILURE in check:
.. (IS (NULL #1=(MISMATCH% "Hello, World!" "Hello, world!"))) .. where
.. COMMON-PREFIX = "Hello, "
.. MISMATCHED-SUFFIX-1 = "World!"
.. MISMATCHED-SUFFIX-2 = "world!"
.. #1# = 7
“‘

Package

try.

Source

checks.lisp.

Function: passedp (trial) ¶

See if TRIAL has finished and its [VERDICT][(reader trial)] is a PASS.

Package

try.

Source

trial.lisp.

Function: recent-trial (&optional n) ¶

Returns the ‘N‘th most recent trial or NIL if there are not enough trials recorded. Every TRIAL returned by TRY gets pushed onto a list of trials, but only *N-RECENT-TRIALS* are kept.

Package

try.

Source

try.lisp.

Function: record-event (&optional condition) ¶

This restart is always the first restart available when an EVENT is signalled running under TRY (i.e. there is a CURRENT-TRIAL). TRY always invokes RECORD-EVENT when handling events.

Package

try.

Source

events.lisp.

Function: replay-events (trial &key collect print describe stream printer) ¶

REPLAY-EVENTS reprocesses the events collected (see @TRY/COLLECT) in TRIAL. It takes the same arguments as TRY except [DEBUG][argument], [COUNT][argument] and RERUN. This is because REPLAY-EVENTS does not run any tests. It simply signals the events collected in TRIAL again to allow further processing. The values of *CATEGORIES* and *COUNT* that were in effect for TRIAL are used, and their current values are ignored to be able to keep consistent counts (see @TRY/COUNT).

Suppose we have run a large test using the default ‘:PRINT ’LEAF‘ ‘:COLLECT ’UNEXPECTED‘ arguments for TRY, and now we have too much output to look at. Instead of searching for the interesting bits in the output, we can replay the events and print only the UNEXPECTED events:

“‘
(replay-events ! :print ’unexpected)
“‘

Or we could tell the printer to just print markers for *CATEGORIES* and :DESCRIBE at the end:

“‘
(let ((*print-parent* nil)
(*print-compactly* t)
(*defer-describe* t)
(*categories* (ascii-std-categories)))
(replay-events !))
.. ................F................!.....
..
.. ;; UNEXPECTED-FAILURE (F) in SOME-TEST INNER-TEST:
.. (IS (= 5 6))
.. debug info
..
.. ;; UNHANDLED-ERROR (!) in SOME-TEST:
.. "my-msg" (MY-ERR)
“‘

Package

try.

Source

replay.lisp.

Function: retry-check (&optional condition) ¶

Initiate a [non-local exit][clhs] to go reevaluate the forms wrapped by the check without signalling an OUTCOME.

Package

try.

Source

outcome.lisp.

Function: retry-trial (&optional condition trial) ¶

Invoke the RETRY-TRIAL restart of RUNNINGP TRIAL. The RETRY-TRIAL restart may record CONDITION, then it initiates a [non-local exit][clhs] to go back to the beginning of the test function. If the non-local exit completes, then

- (N-RETRIES TRIAL) is incremented,
- collected results and trials are cleared (see @TRY/COLLECT),
- counts are zeroed (see @TRY/COUNT), and
- TRIAL-START is signalled again.

If during the unwinding ABORT-TRIAL or SKIP-TRIAL is called, then the retry is cancelled.

CONDITION (which may be NIL) is recorded if it is an EVENT but not the VERDICT of TRIAL, and the RECORD-EVENT restart is available.

Package

try.

Source

trial.lisp.

Function: runningp (trial) ¶

See if the function call associated with TRIAL has not returned yet. Trials that are not running have a VERDICT and are said to be finished.

Package

try.

Source

trial.lisp.

Function: same-set-p (list1 list2 &key key test) ¶

See if LIST1 and LIST2 represent the same set.
See CL:SET-DIFFERENCE for a description of the KEY and TEST arguments.

“‘cl-transcript (:dynenv try-transcript)
(try:is (try:same-set-p ’(1) ’(2)))
.. debugger invoked on UNEXPECTED-RESULT-FAILURE:
.. UNEXPECTED-FAILURE in check:
.. (IS (SAME-SET-P ’(1) ’(2)))
.. where
.. ONLY-IN-1 = (1)
.. ONLY-IN-2 = (2)
“‘

Package

try.

Source

checks.lisp.

Function: set-try-debug (debug) ¶

Invoke the SET-TRY-DEBUG restart to override the DEBUG argument of the currently running TRY. DEBUG must thus be a suitable type. When the SET-TRY-DEBUG restart is invoked interactively, DEBUG is read as a non-evaluated form from *QUERY-IO*.

Package

try.

Source

try.lisp.

Function: skip-check (&optional condition) ¶

Change the OUTCOME of the check being signalled to RESULT-SKIP. RESULT-SKIP, being a PASS, will cause the check to return T if CONTINUE or RECORD-EVENT is invoked on it.

Package

try.

Source

outcome.lisp.

Function: skip-trial (&optional condition trial) ¶

Invoke the SKIP-TRIAL restart of a RUNNINGP TRIAL.

When CONDITION is a VERDICT for TRIAL, SKIP-TRIAL signals a new
verdict of type VERDICT-SKIP. This behavior is similar to that of SKIP-CHECK. Else, the SKIP-TRIAL restart may record CONDITION, then
it initiates a [non-local exit][clhs] to return from the test function with VERDICT-SKIP. If during the unwinding ABORT-TRIAL or RETRY-TRIAL is called, then the skip is cancelled.

“‘cl-transcript (:dynenv try-transcript)
(with-test (skipped)
(handler-bind ((unexpected-result-failure #’skip-trial))
(is nil)))
.. SKIPPED
.. ⊠ (IS NIL)
.. - SKIPPED ⊠1
..
==> #<TRIAL (WITH-TEST (SKIPPED)) SKIP 0.000s ⊠1>
“‘

Invoking SKIP-TRIAL on the TRIAL’s own TRIAL-START skips the trial being started.

“‘cl-transcript (:dynenv try-transcript)
(let ((*print* ’(or outcome leaf)))
(with-test (parent)
(handler-bind ((trial-start #’skip-trial))
(with-test (child)
(is nil)))))
.. PARENT
.. - CHILD
.. ⋅ PARENT
..
“‘

Package

try.

Source

trial.lisp.

Reader: sub-new-form (instance) ¶

Writer: (setf sub-new-form) (instance) ¶

Package

try.

Source

is.lisp.

Target Slot

new-form.

Reader: sub-subform (instance) ¶

Writer: (setf sub-subform) (instance) ¶

Package

try.

Source

is.lisp.

Target Slot

subform.

Reader: sub-valuesp (instance) ¶

Writer: (setf sub-valuesp) (instance) ¶

Package

try.

Source

is.lisp.

Target Slot

valuesp.

Reader: sub-var (instance) ¶

Writer: (setf sub-var) (instance) ¶

Package

try.

Source

is.lisp.

Target Slot

var.

Function: test-bound-p (symbol) ¶

See if SYMBOL names a global test (i.e. a test defined with DEFTEST). If since the execution of DEFTEST, the symbol has been UNINTERNed, FMAKUNBOUNDed, or redefined with DEFUN, then it no longer names a global test.

Package

try.

Source

test.lisp.

Function: try (testable &key debug count collect rerun print describe stream printer) ¶

TRY runs TESTABLE and handles the EVENTs to collect, debug, print the results of checks and trials, and to decide what tests to skip and what to rerun.

DEBUG, COUNT, COLLECT, RERUN, PRINT, and DESCRIBE must all be valid specifiers for types that are either NIL (the empty type) or have a non-empty intersection with the type EVENT (e.g. T, OUTCOME, UNEXPECTED, VERDICT).

TRY sets up a HANDLER-BIND handler for EVENTs and runs TESTABLE (see @TRY/TESTABLES). When an EVENT is signalled, the handler matches its type to the value of the DEBUG argument (in the sense of ‘(TYPEP EVENT DEBUG)‘). If it matches, then the debugger is invoked with the event. In the debugger, the user has a number of restarts available to change (see @TRY/EVENT-RESTARTS, @TRY/OUTCOME-RESTARTS, @TRY/CHECK-RESTARTS, @TRY/TRIAL-RESTARTS, and SET-TRY-DEBUG.

If the debugger is not invoked, TRY invokes the very first restart available, which is always RECORD-EVENT.

Recording the event is performed as follows.

- Outcome counts are updated (see @TRY/COUNT).
- The event is passed to the collector (see @TRY/COLLECT).
- The event is passed to the printer (see @TRY/PRINT).
- Finally, when rerunning a trial (i.e. when TESTABLE is a trial), on a TRIAL-START event, the trial may be skipped (see @TRY/RERUN).

TRY returns the values returned by the outermost trial (see @TRY/TESTS).

Package

try.

Source

try.lisp.

---

5.1.4 Generic functions

Generic Reader: backtrace-of (condition) ¶

Package

try.

Methods

Reader Method: backtrace-of ((condition unhandled-error)) ¶

Source

error.lisp.

Target Slot

backtrace.

Generic Reader: children (object) ¶

Package

try.

Methods

Reader Method: children ((trial trial)) ¶

A list of immediate child VERDICTs, RESULTs, and
ERROR*s collected in reverse chronological order (see @TRY/COLLECT). The VERDICT of this TRIAL is not among CHILDREN, but the VERDICTs of child trials’ are.

Source

trial.lisp.

Target Slot

children.

Generic Reader: debugger-invoked-p (condition) ¶

Package

try.

Methods

Reader Method: debugger-invoked-p ((condition unhandled-error)) ¶

Source

error.lisp.

Target Slot

debugger-invoked-p.

Generic Reader: n-retries (object) ¶

Package

try.

Methods

Reader Method: n-retries ((trial trial)) ¶

The number of times this [TRIAL][dislocated] has been retried. See RETRY-TRIAL.

Source

trial.lisp.

Target Slot

n-retries.

Generic Reader: nested-condition (condition) ¶

Package

try.

Methods

Reader Method: nested-condition ((condition unhandled-error)) ¶

Source

error.lisp.

Target Slot

nested-condition.

Generic Function: substitute-is-list-form (first form env) ¶

In the list FORM, whose CAR is FIRST, substitute
subexpressions of interest with a GENSYM and return the new form. As the second value, return a list of SUBs.

For example, consider ‘(IS (FIND (FOO) LIST))‘. When SUBSTITUTE-IS-LIST-FORM is invoked on ‘(FIND (FOO) LIST)‘, it substitutes each argument of FIND with a variable, returning the new form ‘(FIND TEMP1 TEMP2)‘ and the list of two
substitutions ‘((TEMP2 (FOO) (FOO) NIL) (TEMP3 LIST LIST NIL))‘. This allows the original form to be rewritten as

“‘
(let* ((temp1 (foo))
(temp2 list))
(find temp1 temp2))
“‘

TEMP1 and TEMP2 may then be reported in the OUTCOME condition signalled by IS like this:

The following check failed:
(is (find #1=(foo) #2=list))
where
#1# = <return-value-of-foo>
#2# = <value-of-variable-list>

Package

try.

Source

is.lisp.

Methods

Method: substitute-is-list-form ((first (eql try:match-values)) form env) ¶

Source

checks.lisp.

Method: substitute-is-list-form ((first (eql not)) form env) ¶

Method: substitute-is-list-form ((first (eql endp)) form env) ¶

Method: substitute-is-list-form ((first (eql null)) form env) ¶

Method: substitute-is-list-form (first form env) ¶

Generic Reader: test-name (condition) ¶

Package

try.

Methods

Reader Method: test-name ((trial trial)) ¶

automatically generated reader method

Source

trial.lisp.

Target Slot

test-name.

Reader Method: test-name ((condition error*)) ¶

Source

error.lisp.

Target Slot

test-name.

Generic Reader: trial (condition) ¶

Package

try.

Methods

Reader Method: trial ((condition trial-event)) ¶

Source

trial-event.lisp.

Target Slot

trial.

Generic Reader: trial-start (object) ¶

Package

try.

Methods

Reader Method: trial-start ((trial trial)) ¶

automatically generated reader method

Source

trial.lisp.

Target Slot

trial-start.

Generic Reader: verdict (object) ¶

Package

try.

Methods

Reader Method: verdict ((trial trial)) ¶

The [VERDICT][condition] EVENT signalled when this [TRIAL][dislocated] finished or NIL if it has not finished yet.

Source

trial.lisp.

Target Slot

verdict.

---