parachute

API Reference

parachute

An extensible and cross-compatible testing framework.

PARACHUTE

  • Macro WITH-SHUFFLING (&body body)
  • Variable *FIXTURE-CAPTURES*
    (make-hash-table :test 'eql)
  • Variable *FIXTURE-RESTORES*
    (make-hash-table :test 'eql)
  • Macro DEFINE-FIXTURE-CAPTURE (name args &body body)
  • Macro DEFINE-FIXTURE-RESTORE (name args &body body)
  • Function PACKAGE-FIXTURES (name)
  • Function CAPTURE-FIXTURES (fixture)
  • Function RESTORE-FIXTURES (fixtures)
  • Function CALL-WITH-FIXTURES (function fixtures)
  • Macro WITH-FIXTURES (fixtures &body body)
  • Class TEST
    NAME   Reader: NAME
    HOME   Reader: HOME
    DESCRIPTION   Accessor: DESCRIPTION
    PARENT   Accessor: PARENT
    CHILDREN   Accessor: CHILDREN
    DEPENDENCIES   Accessor: REFERENCED-DEPENDENCIES
    FIXTURES   Accessor: FIXTURES
    TIME-LIMIT   Accessor: TIME-LIMIT
    SKIPPED-CHILDREN   Accessor: REFERENCED-SKIPS
    TESTS   Accessor: TESTS
    SERIAL   Accessor: SERIAL
  • Method DEPENDENCIES ((test test))
  • Method SKIPPED-CHILDREN ((test test))
  • Method CHILDREN ((test test))
  • Method TESTS ((test test))
  • Function FIND-TEST (name &optional package-ish)
  • Function (setf FIND-TEST) (test-instance name &optional package-ish)
  • Function REMOVE-TEST (name &optional package-ish)
  • Macro DEFINE-TEST (name &body arguments-and-body)
  • Function PACKAGE-TESTS (package)
  • Method EVAL-IN-CONTEXT (context (test test))
  • Variable *PARENT*
    nil
  • Variable *CONTEXT*
    nil
  • Method EVAL-IN-CONTEXT (context thing)
  • Method RESULT-FOR-TESTABLE ((test test) context)
  • Class RESULT
    EXPRESSION   Accessor: EXPRESSION
    STATUS   Accessor: STATUS
    DURATION   Accessor: DURATION
    DESCRIPTION   Accessor: DESCRIPTION
  • Method FORMAT-RESULT ((result result) (type (eql :oneline)))
  • Method FORMAT-RESULT ((result result) (type (eql :extensive)))
  • Method EVAL-IN-CONTEXT (context (result result))
  • Class VALUE-RESULT  (RESULT)
    VALUE   Accessor: VALUE
    BODY   Accessor: BODY
  • Method EVAL-IN-CONTEXT (context (result value-result))
  • Class MULTIPLE-VALUE-RESULT  (VALUE-RESULT)
    VALUE   Accessor: VALUE
    BODY   Accessor: BODY
  • Method EVAL-IN-CONTEXT (context (result multiple-value-result))
  • Class FINISHING-RESULT  (VALUE-RESULT)
    No slots.
  • Method EVAL-IN-CONTEXT (context (result finishing-result))
  • Method FORMAT-RESULT ((result finishing-result) (type (eql :extensive)))
  • Class COMPARISON-RESULT  (VALUE-RESULT)
    VALUE-FORM   Accessor: VALUE-FORM
    EXPECTED   Accessor: EXPECTED
    COMPARISON   Accessor: COMPARISON
    COMPARISON-GEQ   Accessor: COMPARISON-GEQ
  • Method FORMAT-RESULT ((result comparison-result) (type (eql :extensive)))
  • Method EVAL-IN-CONTEXT (context (result comparison-result))
  • Class MULTIPLE-VALUE-COMPARISON-RESULT  (MULTIPLE-VALUE-RESULT)
    VALUE-FORM   Accessor: VALUE-FORM
    EXPECTED   Accessor: EXPECTED
    COMPARISON   Accessor: COMPARISON
    COMPARISON-GEQ   Accessor: COMPARISON-GEQ
  • Method FORMAT-RESULT ((result multiple-value-comparison-result) (type (eql :extensive)))
  • Method EVAL-IN-CONTEXT (context (result multiple-value-comparison-result))
  • Class PARENT-RESULT  (RESULT)
    RESULTS   Accessor: RESULTS
  • Method RESULT-FOR-TESTABLE ((test test) (result parent-result))
  • Method EVAL-IN-CONTEXT (context (result parent-result))
  • Method EVAL-IN-CONTEXT (context (result parent-result))
  • Method FIND-CHILD-RESULT (test (result parent-result))
  • Method RESULTS-WITH-STATUS (status (result parent-result))
  • Class TEST-RESULT  (PARENT-RESULT)
    No slots.
  • Method FORMAT-RESULT ((result test-result) (type (eql :oneline)))
  • Method FORMAT-RESULT ((result test-result) (type (eql :extensive)))
  • Method EVAL-IN-CONTEXT (context (result test-result))
  • Method EVAL-IN-CONTEXT (context (result test-result))
  • Method EVAL-IN-CONTEXT (context (result controlling-result))
  • Method EVAL-IN-CONTEXT (context (result controlling-result))
  • Method EVAL-IN-CONTEXT ((context controlling-result) (result result))
  • Method EVAL-IN-CONTEXT ((context controlling-result) (result value-result))
  • Method FORMAT-RESULT ((result controlling-result) (type (eql :oneline)))
  • Macro TRUE (form &optional description &rest format-args)
  • Macro FALSE (form &optional description &rest format-args)
  • Macro IS (comp expected form &optional description &rest format-args)
  • Macro ISNT (comp expected form &optional description &rest format-args)
  • Macro IS-VALUES (form &body body)
  • Macro ISNT-VALUES (form &body body)
  • Macro FAIL (form &optional (type 'error) description &rest format-args)
  • Macro OF-TYPE (type form &optional description &rest format-args)
  • Macro FINISH (form &optional description &rest format-args)
  • Macro WITH-FORCED-STATUS ((status &optional description &rest format-args) &body tests)
  • Macro SKIP (desc &body tests)
  • Function TEST (designator &rest args &key (report 'plain) &allow-other-keys)
  • Function TEST-TOPLEVEL (designator/s &rest args)
  • Class REPORT  (PARENT-RESULT)
    No slots.
  • Method TESTS-WITH-STATUS (status (report report))
  • Class QUIET  (REPORT)
    No slots.
  • Method EVAL-IN-CONTEXT ((report quiet) (result result))
  • Class PLAIN  (REPORT)
    OUTPUT   Accessor: OUTPUT
  • Method EVAL-IN-CONTEXT ((report plain) (result parent-result))
  • Method EVAL-IN-CONTEXT ((report plain) (result result))
  • Method EVAL-IN-CONTEXT ((report plain) (result value-result))
  • Method EVAL-IN-CONTEXT ((report plain) (result result))
  • Method REPORT-ON ((result result) (report plain))
  • Method REPORT-ON (thing (report plain))
  • Method REPORT-ON ((result result) (report plain))
  • Class INTERACTIVE  (REPORT)
    No slots.
  • Method EVAL-IN-CONTEXT ((report interactive) (result result))
  • Method EVAL-IN-CONTEXT ((report interactive) (result result))

parachute-fiveam

Parachute's FiveAM compatibility layer.

ORG.SHIRAKUMO.PARACHUTE.5AM

  • Variable *TEST-DRIBBLE*
    t
  • Variable *DEBUG-ON-ERROR*
    nil
  • Variable *DEBUG-ON-FAILURE*
    nil
  • Variable *VERBOSE-FAILURES*
    nil
  • Variable *RUN-TEST-WHEN-DEFINED*
    nil
  • Variable *DEFAULT-TEST-COMPILATION-TIME*
    :run-time
  • Function MAKE-SUITE (name &key description in)
  • Macro DEF-SUITE (name &key description in)
  • Macro IN-SUITE (suite-name)
  • Function GET-TEST (key &optional default)
  • Function REM-TEST (key)
  • Macro TEST (name &body body)
  • Macro DEF-TEST (name (&key depends-on (suite *suite*) fixture (compile-at *default-test-compilation-time*) profile) &body body)
  • Function GET-FIXTURE (key &optional default)
  • Function (setf GET-FIXTURE) (value key)
  • Macro DEF-FIXTURE (name args &body body)
  • Macro WITH-FIXTURE (name args &body body)
  • Macro IS (test &rest reason-args)
  • Macro IS-TRUE (condition &rest reason)
  • Macro IS-FALSE (condition &rest reason)
  • Macro SIGNALS (condition-spec &body body)
  • Macro FINISHES (&body body)
  • Macro SKIP (&rest reason)
  • Macro PASS (&rest reason)
  • Macro FAIL (&rest reason)
  • Macro FOR-ALL (bindings &body body)
  • Function GEN-INTEGER (&key (max (1+ most-positive-fixnum)) (min (1- most-negative-fixnum)))
  • Function GEN-FLOAT (&key bound (type 'short-float))
  • Function GEN-CHARACTER (&key (code-limit char-code-limit) (code (gen-integer :min 0 :max (1- code-limit))) (alphanumericp nil))
  • Function GEN-STRING (&key (length (gen-integer :min 0 :max 80)) (elements (gen-character)) (element-type 'character))
  • Function GEN-LIST (&key (length (gen-integer :min 0 :max 10)) (elements (gen-integer :min -10 :max 10)))
  • Function GEN-TREE (&key (size 20) (elements (gen-integer :min -10 :max 10)))
  • Function GEN-BUFFER (&key (length (gen-integer :min 0 :max 50)) (element-type '(unsigned-byte 8)) (elements (gen-integer :min 0 :max (1- (expt 2 8)))))
  • Function GEN-ONE-ELEMENT (&rest elements)
  • Function RUN (test)
  • Function RUN! (test)
  • Function EXPLAIN! (result-list)
  • Function EXPLAIN (report-type results &optional stream recursive-depth)
  • Function !
  • Function !!
  • Function !!!

parachute-lisp-unit

Parachute's lisp-unit compatibility layer.

ORG.SHIRAKUMO.PARACHUTE.LISP-UNIT

  • Variable *PRINT-SUMMARY*
    t
  • Variable *PRINT-FAILURES*
    t
  • Variable *PRINT-ERRORS*
    t
  • Variable *SUMMARIZE-RESULTS*
    t
  • Macro ASSERT-EQ (expected form)
  • Macro ASSERT-EQL (expected form)
  • Macro ASSERT-EQUAL (expected form)
  • Macro ASSERT-EQUALP (expected form)
  • Macro ASSERT-ERROR (condition form)
  • Macro ASSERT-EXPANDS (expansion form)
  • Macro ASSERT-EQUALITY (test expected form)
  • Macro ASSERT-PRINTS (output form)
  • Macro ASSERT-NIL (form)
  • Macro ASSERT-FALSE (form)
  • Macro ASSERT-TRUE (form)
  • Macro DEFINE-TEST (name &body body)
  • Function LIST-TESTS (&optional (package *package*))
  • Function TEST-CODE (name &optional (package *package*))
  • Function TEST-DOCUMENTATION (name &optional (package *package*))
  • Function REMOVE-TESTS (&optional (names :all) (package *package*))
  • Function RUN-TESTS (&optional (test-names :all) (package *package*))
  • Function USE-DEBUGGER (&optional (flag t))
  • Function LIST-TAGS (&optional (package *package*))
  • Function TAGGED-TESTS (&optional (tags :all) (package *package*))
  • Function REMOVE-TAGS (&optional (tags :all) (package *package*))
  • Function RUN-TAGS (&optional (tags :all) (package *package*))
  • Function TEST-NAMES
  • Function FAILED-TESTS (report)
  • Function ERROR-TESTS (report)
  • Function MISSING-TESTS (report)
  • Generic-Function PRINT-FAILURES (result &optional stream)
  • Method PRINT-FAILURES (result &optional stream)
  • Method PRINT-FAILURES (result &optional stream)
  • Method PRINT-FAILURES (result &optional stream)
  • Generic-Function PRINT-ERRORS (result &optional stream)
  • Method PRINT-ERRORS (result &optional stream)
  • Method PRINT-ERRORS (result &optional stream)
  • Method PRINT-ERRORS (result &optional stream)
  • Function SUMMARIZE-RESULTS (results &optional (stream *standard-output*))
  • Function REDUCE-TEST-RESULTS-DBS (all-results &key merge)
  • Function SIGNAL-RESULTS (&optional (flag t))
  • Condition TEST-RUN-COMPLETE
  • Function LOGICALLY-EQUAL (a b)
  • Function SET-EQUAL (a b &key key (test #'equal))

parachute-prove

Parachute's Prove compatibility layer.

ORG.SHIRAKUMO.PARACHUTE.PROVE

  • Variable *TEST-RESULT-OUTPUT*
    t
  • Variable *SUITE*
    nil
  • Variable *DEBUG-ON-ERROR*
    nil
  • Variable *DEFAULT-TEST-FUNCTION*
    #'equal
  • Variable *DEFAULT-REPORTER*
    'parachute:plain
  • Variable *GENSYM-PREFIX*
    "$"
  • Variable *DEFAULT-SLOW-THRESHOLD*
    75
  • Variable *ENABLE-COLORS*
    nil
  • Class TEST-FILE  (CL-SOURCE-FILE)
    No slots.
  • Function RUN-TEST-SYSTEM (system-designator)
  • Function RUN (object &key reporter)
  • Macro OK (test &optional description)
  • Macro IS (got expected &rest args)
  • Macro ISNT (got expected &rest args)
  • Macro IS-VALUES (got expected &rest args)
  • Macro IS-PRINT (got expected &optional desc)
  • Macro IS-CONDITION (got condition &optional desc)
  • Macro IS-ERROR (got condition &optional desc)
  • Macro IS-TYPE (got expected &optional desc)
  • Macro LIKE (got regex &optional desc)
  • Macro IS-EXPAND (got expected &optional desc)
  • Function DIAG (desc)
  • Function SKIP (how-many why &rest format-args)
  • Function PASS (desc)
  • Function FAIL (desc)
  • Class SUBTEST  (PARENT-RESULT)
    BODY   Accessor: BODY
  • Macro SUBTEST (desc &body body)
  • Macro DEFTEST (name &body test-forms)
  • Function RUN-TEST (name)
  • Function RUN-TEST-PACKAGE (package)
  • Function RUN-TEST-ALL
  • Function REMOVE-TEST (name)
  • Function REMOVE-TEST-ALL
  • Class SUITE  (PLAIN)
    TO-SKIP   Accessor: TO-SKIP
  • Class PACKAGE-SUITE  (SUITE)
    No slots.
  • Function SLOW-THRESHOLD (&optional new-threshold)
  • Function CURRENT-SUITE
  • Function RESET-SUITE (suite)
  • Function PLAN (n)
  • Function FINALIZE