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

The 1am Reference Manual

This is the 1am Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:24:36 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The 1am Reference Manual, Up: The 1am Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The 1am Reference Manual [Contents][Index]

2 Systems

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

1am

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

2.1 `1am`

A minimal testing framework.

Author: James M. Lawrence <llmjjmll@gmail.com>
License: MIT
Source: 1am.asd.
Child Component: 1am.lisp (file).

Next: Packages, Previous: Systems, Up: The 1am Reference Manual [Contents][Index]

3 Files

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

Lisp

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

3.1 Lisp

1am/1am.asd
1am/1am.lisp

Next: 1am/1am.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `1am/1am.asd`

Source: 1am.asd.
Parent Component: 1am (system).
ASDF Systems: 1am.

Previous: 1am/1am.asd, Up: Lisp [Contents][Index]

3.1.2 `1am/1am.lisp`

Source

Parent Component

1am (system).

Packages

Public Interface

*tests* (special variable).
is (macro).
run (function).
signals (macro).
test (macro).

Internals

%run (function).
%shuffle (function).
%signals (function).
*failed-random-state* (special variable).
*pass-count* (special variable).
*running* (special variable).
call-test (function).
call-with-random-state (function).
passed (function).
report (function).
shuffle (function).

Next: Definitions, Previous: Files, Up: The 1am Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

1am

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

4.1 `1am`

Source

Use List

common-lisp.

Public Interface

*tests* (special variable).
is (macro).
run (function).
signals (macro).
test (macro).

Internals

%run (function).
%shuffle (function).
%signals (function).
*failed-random-state* (special variable).
*pass-count* (special variable).
*running* (special variable).
call-test (function).
call-with-random-state (function).
passed (function).
report (function).
shuffle (function).

Next: Indexes, Previous: Packages, Up: The 1am Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Special variables
Macros
Ordinary functions

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Special variables

Special Variable: *tests* ¶

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

Package: 1am.
Source: 1am.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]

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.

Previous: Macros, Up: Public Interface [Contents][Index]

5.1.3 Ordinary functions

Function: run (&optional tests) ¶

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

Package: 1am.
Source: 1am.lisp.

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

5.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

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.

Previous: Special variables, Up: Internals [Contents][Index]

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.

Previous: Definitions, Up: The 1am Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	% C F I M P R S T

	Index Entry		Section

%
	`%run`:		Private ordinary functions
	`%shuffle`:		Private ordinary functions
	`%signals`:		Private ordinary functions

C
	`call-test`:		Private ordinary functions
	`call-with-random-state`:		Private ordinary functions

F
	`Function, %run`:		Private ordinary functions
	`Function, %shuffle`:		Private ordinary functions
	`Function, %signals`:		Private ordinary functions
	`Function, call-test`:		Private ordinary functions
	`Function, call-with-random-state`:		Private ordinary functions
	`Function, passed`:		Private ordinary functions
	`Function, report`:		Private ordinary functions
	`Function, run`:		Public ordinary functions
	`Function, shuffle`:		Private ordinary functions

I
	`is`:		Public macros

M
	`Macro, is`:		Public macros
	`Macro, signals`:		Public macros
	`Macro, test`:		Public macros

P
	`passed`:		Private ordinary functions

R
	`report`:		Private ordinary functions
	`run`:		Public ordinary functions

S
	`shuffle`:		Private ordinary functions
	`signals`:		Public macros

T
	`test`:		Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry		Section

*
	`failed-random-state`:		Private special variables
	`pass-count`:		Private special variables
	`running`:		Private special variables
	`tests`:		Public special variables

S
	`Special Variable, failed-random-state`:		Private special variables
	`Special Variable, pass-count`:		Private special variables
	`Special Variable, running`:		Private special variables
	`Special Variable, tests`:		Public special variables

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

A.4 Data types

Jump to:	1 F P S

	Index Entry		Section

1
	`1am`:		The 1am system
	`1am`:		The 1am package
	`1am.asd`:		The 1am/1am․asd file
	`1am.lisp`:		The 1am/1am․lisp file

F
	`File, 1am.asd`:		The 1am/1am․asd file
	`File, 1am.lisp`:		The 1am/1am․lisp file

P
	`Package, 1am`:		The 1am package

S
	`System, 1am`:		The 1am system