The stefil+ Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The stefil+ Reference Manual

This is the stefil+ Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 15:07:49 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

STEFIL+

Enhancements to the stefil library adding:


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Next: , Previous: , Up: Systems   [Contents][Index]

2.1 stefil+

Author

GrammaTech

License

Public Domain

Description

Simple Test Framework in Lisp

Defsystem Dependency

asdf-package-system

Dependency

stefil+/stefil+ (system)

Source

stefil+.asd (file)


Previous: , Up: Systems   [Contents][Index]

2.2 stefil+/stefil+

Author

GrammaTech

License

Public Domain

Dependencies
Source

stefil+.asd (file)

Component

lisp.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 stefil+.asd

Location

stefil+.asd

Systems

Previous: , Up: Lisp files   [Contents][Index]

3.1.2 stefil+/stefil+/lisp.lisp

Parent

stefil+/stefil+ (system)

Location

stefil+.lisp

Packages

stefil+

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 stefil+

Source

lisp.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *long-tests*

Control execution of slow tests.

Package

stefil+

Source

lisp.lisp (file)

Special Variable: *success*

Hold success of the last ‘run-batch’ run.

Package

stefil+

Source

lisp.lisp (file)

Special Variable: *time-threshold*

Time threshold for tests (in seconds).

Package

stefil+

Source

lisp.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: defroot NAME
Package

stefil+

Source

lisp.lisp (file)

Macro: defsuite NAME DOCUMENTATION &optional TEST-PRE-CHECK

Define NAME with DOCUMENTATION.
Optional TEST-PRE-CHECK if present should be one of the following: :SILENT — silently skip this test suite
NIL ——- skip this test suite with the default warning Otherwise - test-pre-check will be invoked at runtime
return non-nil when the test suite should be run and nil otherwise.

Package

stefil+

Source

lisp.lisp (file)

Macro: deftest NAME ARGS &body BODY

Expands on STEFIL::DEFTEST in these ways:
- Accepts (<test-name> :LONG-RUNNING) in place of <test-name> for the name - When the test is executed, if the execution time (real time) is longer than *TIME-THRESHOLD* seconds, a warning is output.

Package

stefil+

Source

lisp.lisp (file)

Macro: with-retries (NUMBER &optional FAILURE) &body BODY

Try BODY NUMBER times. If no try returns then return FAILURE. Body is executed inside of an ‘iter’ form, so iteration forms may be present.

Package

stefil+

Source

lisp.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: long-running-p TEST

Given the name of a test, returns true iff test has been flagged long-running.

Package

stefil+

Source

lisp.lisp (file)

Function: run-batch &optional TEST &rest ARGS

Run TESTS in ’batch’ mode, printing results as a string.

Package

stefil+

Source

lisp.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: +long-suite-suffix+

Suffix for version of suite which contains long running tests.

Package

stefil+

Source

lisp.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Special variables

Special Variable: *root-suite*

Default suite in which ‘sel-suite*’ should define tests.

Package

stefil+

Source

lisp.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Macros

Macro: check-time TEST-NAME &body BODY

If elapsed real time of test exceeds *time-threshold*, a warning
is output. In any case, this macro executes BODY and returns any resulting values.

Package

stefil+

Source

lisp.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Functions

Function: find-long-running-suite SUITE-NAME

Determine the name of the long-running suite associated with the passed suite name. If the passed suite name ends with +long-suite-suffix+ it returns the argument.

Package

stefil+

Source

lisp.lisp (file)

Function: mov-test TEST-NAME NEW-PARENT-NAME &rest TEST-ARGS

Move a child test to a different parent.

Package

stefil+

Source

lisp.lisp (file)

Function: run-child-tests-of TEST
Package

stefil+

Source

lisp.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Generic functions

Generic Function: test-exceeds-threshold-name CONDITION
Package

stefil+

Methods
Method: test-exceeds-threshold-name (CONDITION test-exceeds-time-threshold)
Source

lisp.lisp (file)

Generic Function: test-exceeds-threshold-time CONDITION
Package

stefil+

Methods
Method: test-exceeds-threshold-time (CONDITION test-exceeds-time-threshold)
Source

lisp.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.6 Conditions

Condition: test-exceeds-time-threshold ()
Package

stefil+

Source

lisp.lisp (file)

Direct superclasses

simple-warning (condition)

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

test-exceeds-threshold-name (generic function)

Slot: time
Initargs

:time

Readers

test-exceeds-threshold-time (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

F
File, Lisp, stefil+.asd: The stefil+․asd file
File, Lisp, stefil+/stefil+/lisp.lisp: The stefil+/stefil+/lisp․lisp file

L
Lisp File, stefil+.asd: The stefil+․asd file
Lisp File, stefil+/stefil+/lisp.lisp: The stefil+/stefil+/lisp․lisp file

S
stefil+.asd: The stefil+․asd file
stefil+/stefil+/lisp.lisp: The stefil+/stefil+/lisp․lisp file

Jump to:   F   L   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   D   F   G   L   M   R   T   W  
Index Entry  Section

C
check-time: Internal macros

D
defroot: Exported macros
defsuite: Exported macros
deftest: Exported macros

F
find-long-running-suite: Internal functions
Function, find-long-running-suite: Internal functions
Function, long-running-p: Exported functions
Function, mov-test: Internal functions
Function, run-batch: Exported functions
Function, run-child-tests-of: Internal functions

G
Generic Function, test-exceeds-threshold-name: Internal generic functions
Generic Function, test-exceeds-threshold-time: Internal generic functions

L
long-running-p: Exported functions

M
Macro, check-time: Internal macros
Macro, defroot: Exported macros
Macro, defsuite: Exported macros
Macro, deftest: Exported macros
Macro, with-retries: Exported macros
Method, test-exceeds-threshold-name: Internal generic functions
Method, test-exceeds-threshold-time: Internal generic functions
mov-test: Internal functions

R
run-batch: Exported functions
run-child-tests-of: Internal functions

T
test-exceeds-threshold-name: Internal generic functions
test-exceeds-threshold-name: Internal generic functions
test-exceeds-threshold-time: Internal generic functions
test-exceeds-threshold-time: Internal generic functions

W
with-retries: Exported macros

Jump to:   C   D   F   G   L   M   R   T   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
C   N   S   T  
Index Entry  Section

*
*long-tests*: Exported special variables
*root-suite*: Internal special variables
*success*: Exported special variables
*time-threshold*: Exported special variables

+
+long-suite-suffix+: Internal constants

C
Constant, +long-suite-suffix+: Internal constants

N
name: Internal conditions

S
Slot, name: Internal conditions
Slot, time: Internal conditions
Special Variable, *long-tests*: Exported special variables
Special Variable, *root-suite*: Internal special variables
Special Variable, *success*: Exported special variables
Special Variable, *time-threshold*: Exported special variables

T
time: Internal conditions

Jump to:   *   +  
C   N   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S   T  
Index Entry  Section

C
Condition, test-exceeds-time-threshold: Internal conditions

P
Package, stefil+: The stefil+ package

S
stefil+: The stefil+ system
stefil+: The stefil+ package
stefil+/stefil+: The stefil+/stefil+ system
System, stefil+: The stefil+ system
System, stefil+/stefil+: The stefil+/stefil+ system

T
test-exceeds-time-threshold: Internal conditions

Jump to:   C   P   S   T