The 1am Reference Manual

This is the 1am Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:07:10 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 1am

A minimal testing framework.

Author

James M. Lawrence <>

License

MIT

Source

1am.asd.

Child Component

1am.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 1am/1am.asd

Source

1am.asd.

Parent Component

1am (system).

ASDF Systems

1am.


3.1.2 1am/1am.lisp

Source

1am.asd.

Parent Component

1am (system).

Packages

1am.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 1am

Source

1am.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *tests*

A list of tests; the default argument to ‘run’.

Package

1am.

Source

1am.lisp.


5.1.2 Macros

Macro: is (form)

Assert that ‘form’ evaluates to non-nil.

Package

1am.

Source

1am.lisp.

Macro: signals (condition &body body)

Assert that ‘body’ signals a condition of type ‘condition’.

Package

1am.

Source

1am.lisp.

Macro: test (name &body body)

Define a test function and add it to ‘*tests*’.

Package

1am.

Source

1am.lisp.


5.1.3 Ordinary functions

Function: run (&optional tests)

Run each test in the sequence ‘tests’. Default is ‘*tests*’.

Package

1am.

Source

1am.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *failed-random-state*
Package

1am.

Source

1am.lisp.

Special Variable: *pass-count*
Package

1am.

Source

1am.lisp.

Special Variable: *running*
Package

1am.

Source

1am.lisp.


5.2.2 Ordinary functions

Function: %run (fn test-count)
Package

1am.

Source

1am.lisp.

Function: %shuffle (vector)
Package

1am.

Source

1am.lisp.

Function: %signals (expected fn)
Package

1am.

Source

1am.lisp.

Function: call-test (name fn)
Package

1am.

Source

1am.lisp.

Function: call-with-random-state (fn)
Package

1am.

Source

1am.lisp.

Function: passed ()
Package

1am.

Source

1am.lisp.

Function: report (test-count pass-count)
Package

1am.

Source

1am.lisp.

Function: shuffle (sequence)
Package

1am.

Source

1am.lisp.


Appendix A Indexes


A.1 Concepts