The slite Reference Manual

This is the slite Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 07:43:53 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 slite

SLIME based Test-runner for FiveAM tests (and possibly others in the future)

Author

Arnold Noronha <>

License

Apache License, Version 2.0

Version

0.0.1

Dependencies
  • str (system).
  • fiveam (system).
Source

slite.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 slite/slite.asd

Source

slite.asd.

Parent Component

slite (system).

ASDF Systems

slite.


3.1.2 slite/api.lisp

Source

slite.asd.

Parent Component

slite (system).

Packages

slite/api.

Public Interface

3.1.3 slite/slite.lisp

Dependency

api.lisp (file).

Source

slite.asd.

Parent Component

slite (system).

Packages

slite.

Public Interface
Internals

3.1.4 slite/fiveam.lisp

Dependency

slite.lisp (file).

Source

slite.asd.

Parent Component

slite (system).

Packages

slite/fiveam.

Public Interface
Internals

guess-fiveam (function).


4 Packages

Packages are listed by definition order.


4.1 slite/api

Source

api.lisp.

Use List

common-lisp.

Public Interface

4.2 slite/fiveam

Source

fiveam.lisp.

Use List
  • alexandria.
  • common-lisp.
Internals

guess-fiveam (function).


4.3 slite

Source

slite.lisp.

Use List
  • alexandria.
  • 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: *engine*
Package

slite.

Source

slite.lisp.

Special Variable: *framework-guessors*
Package

slite/api.

Source

api.lisp.


5.1.2 Ordinary functions

Function: guess-framework (result)
Package

slite/api.

Source

api.lisp.

Function: on-pass (results &key shell)
Package

slite.

Source

slite.lisp.


5.1.3 Generic functions

Generic Function: rem-test (framework name package)
Package

slite/api.

Source

api.lisp.

Methods
Method: rem-test ((framwork (eql :fiveam)) name package)
Source

fiveam.lisp.

Method: rem-test :around (framework name package)
Source

slite.lisp.

Generic Function: remove-test (engine name package)
Package

slite.

Source

slite.lisp.

Generic Function: rerun-in-debugger (framework name package)
Package

slite/api.

Source

api.lisp.

Methods
Method: rerun-in-debugger ((framework (eql :fiveam)) name package)
Source

fiveam.lisp.

Method: rerun-in-debugger :around (framework name package)
Source

slite.lisp.

Generic Function: rerun-in-debugger-impl (engine name package)
Package

slite.

Source

slite.lisp.

Generic Function: run-all-fiveam-tests ()
Package

slite.

Methods
Method: run-all-fiveam-tests ()
Source

fiveam.lisp.

Generic Function: test-case (test-result)
Package

slite.

Source

slite.lisp.

Methods
Method: test-case ((result test-result))
Source

fiveam.lisp.

Generic Function: test-case-package (result)
Package

slite.

Source

slite.lisp.

Methods
Method: test-case-package ((test-case test-case))
Source

fiveam.lisp.

Generic Function: test-expression (result)
Package

slite.

Source

slite.lisp.

Methods
Method: test-expression ((result test-result))
Source

fiveam.lisp.

Generic Function: test-message (result)
Package

slite.

Source

slite.lisp.

Methods
Method: test-message ((result test-result))
Source

fiveam.lisp.

Generic Function: test-name (test-case)
Package

slite.

Source

slite.lisp.

Methods
Method: test-name ((test-case test-case))
Source

fiveam.lisp.

Generic Function: test-result-list (response)
Package

slite.

Source

slite.lisp.

Methods
Method: test-result-list ((response list))
Generic Function: test-result-success-p (result)
Package

slite.

Source

slite.lisp.

Methods
Method: test-result-success-p ((result test-result))
Source

fiveam.lisp.

Method: test-result-success-p ((result test-passed))
Source

fiveam.lisp.


5.1.4 Classes

Class: engine

An abstraction over the test framework to integrate with slite

Package

slite.

Source

slite.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *last-results*

Stores the last test result. We’ll always store this just before rendering so that we can run actions on this, and the test results aren’t garbage collected in the meantime

Package

slite.

Source

slite.lisp.


5.2.2 Ordinary functions

Function: ensure-safe-for-sl* (x)

If we send a bad object over the wire, SLY/SLIME can go into a bad state, so let’s get rid of it early

Package

slite.

Source

slite.lisp.

Function: guess-fiveam (result)
Package

slite/fiveam.

Source

fiveam.lisp.

Function: serialize-result (result)
Package

slite.

Source

slite.lisp.


5.2.3 Generic functions

Generic Function: get-test-case-details (test-case)
Package

slite.

Methods
Method: get-test-case-details (test-case)
Source

slite.lisp.

Generic Function: process-results (results)
Package

slite.

Methods
Method: process-results (results)
Source

slite.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   E   F   G   M   O   P   R   S   T  
Index Entry  Section

E
ensure-safe-for-sl*: Private ordinary functions

F
Function, ensure-safe-for-sl*: Private ordinary functions
Function, guess-fiveam: Private ordinary functions
Function, guess-framework: Public ordinary functions
Function, on-pass: Public ordinary functions
Function, serialize-result: Private ordinary functions

G
Generic Function, get-test-case-details: Private generic functions
Generic Function, process-results: Private generic functions
Generic Function, rem-test: Public generic functions
Generic Function, remove-test: Public generic functions
Generic Function, rerun-in-debugger: Public generic functions
Generic Function, rerun-in-debugger-impl: Public generic functions
Generic Function, run-all-fiveam-tests: Public generic functions
Generic Function, test-case: Public generic functions
Generic Function, test-case-package: Public generic functions
Generic Function, test-expression: Public generic functions
Generic Function, test-message: Public generic functions
Generic Function, test-name: Public generic functions
Generic Function, test-result-list: Public generic functions
Generic Function, test-result-success-p: Public generic functions
get-test-case-details: Private generic functions
get-test-case-details: Private generic functions
guess-fiveam: Private ordinary functions
guess-framework: Public ordinary functions

M
Method, get-test-case-details: Private generic functions
Method, process-results: Private generic functions
Method, rem-test: Public generic functions
Method, rem-test: Public generic functions
Method, rerun-in-debugger: Public generic functions
Method, rerun-in-debugger: Public generic functions
Method, run-all-fiveam-tests: Public generic functions
Method, test-case: Public generic functions
Method, test-case-package: Public generic functions
Method, test-expression: Public generic functions
Method, test-message: Public generic functions
Method, test-name: Public generic functions
Method, test-result-list: Public generic functions
Method, test-result-success-p: Public generic functions
Method, test-result-success-p: Public generic functions

O
on-pass: Public ordinary functions

P
process-results: Private generic functions
process-results: Private generic functions

R
rem-test: Public generic functions
rem-test: Public generic functions
rem-test: Public generic functions
remove-test: Public generic functions
rerun-in-debugger: Public generic functions
rerun-in-debugger: Public generic functions
rerun-in-debugger: Public generic functions
rerun-in-debugger-impl: Public generic functions
run-all-fiveam-tests: Public generic functions
run-all-fiveam-tests: Public generic functions

S
serialize-result: Private ordinary functions

T
test-case: Public generic functions
test-case: Public generic functions
test-case-package: Public generic functions
test-case-package: Public generic functions
test-expression: Public generic functions
test-expression: Public generic functions
test-message: Public generic functions
test-message: Public generic functions
test-name: Public generic functions
test-name: Public generic functions
test-result-list: Public generic functions
test-result-list: Public generic functions
test-result-success-p: Public generic functions
test-result-success-p: Public generic functions
test-result-success-p: Public generic functions