Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
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 Thu Sep 15 06:10:35 2022 GMT+0.
Table of Contents
Next: Systems, Previous: The slite Reference Manual, Up: The slite Reference Manual [Contents][Index]
1 Introduction
SLITE
Slite stands for SLIme TEst runner. Slite interactively runs your Common Lisp tests (currently only FiveAM and Parachute are supported). It allows you to see the summary of test failures, jump to test definitions, rerun tests with debugger all from inside Emacs.
We support both SLIME and SLY.
Slite allows for fast Test Driven Development with CL.
At the moment, treat this software as Alpha quality. Things will break, APIs will change, but your feedback will be very valuable.
Installation
I'll expand on this later. Basically you need to (asdf:load-system :slite), and also need to load slite.el into emacs. That should be
all you need to do.
Run all you FiveAM tests
This is the function you'll call most often. In a Common Lisp buffer,
press C-c v or M-x slite-run. You can then provide the expression
as (slite:run-all-fiveam-tests). You could run a specific test suite
with (fiveam:run test-suite-name).
You'll get a table of all the tests and their results. The failed tests will be on the top.
Press RET on a test to see details about the failure. On the table,
or in the details buffer, press r to re-run the test with debugger
(i.e. when the test fails the debugger will open up). Delete a test
with M-x slite-delete-test.
Press M-. on the test name in the details view to jump to the
test. (This only works on Lispworks, and only if you use a
patched version of FiveAM)
Honestly, that's about all you need to know. Although, there's one more neat little feature:
Running shell commands when tests pass
When I do TDD, I usually run my tests and immediately if the test
passes I run git commit -a -m .... So my Emacs compile command might
look like make tests && git commit ... .
There are two ways to do this with slite: you could do this as part of
the lisp expression that you pass to slite-run, or you could use the
slite-success-shell-hook from the Emacs side. The latter option will
work even when you're using a remote slime session.
For example, (setq slite-success-shell-hook "cd ~/code && git commit -a -m ...") will do essentially what I was suggesting earlier. This
API is a little awkward, so we might change this in the future
Run Parachute tests
Ensure you (asdf:load-system :slite/parachute). At this point, you
use M-x slite-run to run tests like (parachute:test 'foo-bar). All
the same functionality such as debugging, deleting should
work. Jumping to test is currently not surpported.
Authors
Built by Arnold Noronha arnold@tdrhq.com
Next: Files, Previous: Introduction, Up: The slite Reference Manual [Contents][Index]
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 <arnold@jipr.io>
- License
Apache License, Version 2.0
- Version
0.0.1
- Dependencies
- str (system).
- fiveam (system).
- Source
- Child Components
- api.lisp (file).
- slite.lisp (file).
- fiveam.lisp (file).
Next: Packages, Previous: Systems, Up: The slite Reference Manual [Contents][Index]
3 Files
Files are sorted by type and then listed depth-first from the systems components trees.
3.1 Lisp
Next: slite/slite.lisp, Previous: slite/slite.asd, Up: Lisp [Contents][Index]
3.1.2 slite/api.lisp
- Source
- Parent Component
slite (system).
- Packages
- Public Interface
- *framework-guessors* (special variable).
- guess-framework (function).
- rem-test (generic function).
- rerun-in-debugger (generic function).
Next: slite/fiveam.lisp, Previous: slite/api.lisp, Up: Lisp [Contents][Index]
3.1.3 slite/slite.lisp
- Dependency
api.lisp (file).
- Source
- Parent Component
slite (system).
- Packages
- Public Interface
- *engine* (special variable).
- engine (class).
- on-pass (function).
- rem-test (method).
- remove-test (generic function).
- rerun-in-debugger (method).
- rerun-in-debugger-impl (generic function).
- test-case (generic function).
- test-case-package (generic function).
- test-expression (generic function).
- test-message (generic function).
- test-name (generic function).
- test-result-list (generic function).
- test-result-success-p (generic function).
- Internals
- *last-results* (special variable).
- ensure-safe-for-sl* (function).
- get-test-case-details (method).
- process-results (method).
- serialize-result (function).
Previous: slite/slite.lisp, Up: Lisp [Contents][Index]
3.1.4 slite/fiveam.lisp
- Dependency
slite.lisp (file).
- Source
- Parent Component
slite (system).
- Packages
- Public Interface
- rem-test (method).
- rerun-in-debugger (method).
- run-all-fiveam-tests (method).
- test-case (method).
- test-case-package (method).
- test-expression (method).
- test-message (method).
- test-name (method).
- test-result-success-p (method).
- test-result-success-p (method).
- Internals
guess-fiveam (function).
Next: Definitions, Previous: Files, Up: The slite Reference Manual [Contents][Index]
4 Packages
Packages are listed by definition order.
Next: slite/fiveam, Previous: Packages, Up: Packages [Contents][Index]
4.1 slite/api
- Source
- Use List
common-lisp.
- Public Interface
- *framework-guessors* (special variable).
- guess-framework (function).
- rem-test (generic function).
- rerun-in-debugger (generic function).
Previous: slite/fiveam, Up: Packages [Contents][Index]
4.3 slite
- Source
- Use List
- alexandria.
- common-lisp.
- Public Interface
- *engine* (special variable).
- engine (class).
- on-pass (function).
- remove-test (generic function).
- rerun-in-debugger-impl (generic function).
- run-all-fiveam-tests (generic function).
- test-case (generic function).
- test-case-package (generic function).
- test-expression (generic function).
- test-message (generic function).
- test-name (generic function).
- test-result-list (generic function).
- test-result-success-p (generic function).
- Internals
- *last-results* (special variable).
- ensure-safe-for-sl* (function).
- get-test-case-details (generic function).
- process-results (generic function).
- serialize-result (function).
Next: Indexes, Previous: Packages, Up: The slite Reference Manual [Contents][Index]
5 Definitions
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
5.1 Public Interface
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
5.1.1 Special variables
- Special Variable: *engine* ¶
-
- Package
- Source
Next: Generic functions, Previous: Special variables, Up: Public Interface [Contents][Index]
5.1.2 Ordinary functions
- Function: on-pass (results &key shell) ¶
-
- Package
- Source
Next: Classes, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
5.1.3 Generic functions
- Generic Function: rem-test (framework name package) ¶
- Generic Function: remove-test (engine name package) ¶
-
- Package
- Source
- Generic Function: rerun-in-debugger (framework name package) ¶
- Generic Function: rerun-in-debugger-impl (engine name package) ¶
-
- Package
- Source
- Generic Function: run-all-fiveam-tests () ¶
-
- Package
- Methods
- Method: run-all-fiveam-tests () ¶
-
- Source
- Generic Function: test-case (test-result) ¶
-
- Package
- Source
- Methods
- Method: test-case ((result test-result)) ¶
-
- Source
- Generic Function: test-case-package (result) ¶
-
- Package
- Source
- Methods
- Method: test-case-package ((test-case test-case)) ¶
-
- Source
- Generic Function: test-expression (result) ¶
-
- Package
- Source
- Methods
- Method: test-expression ((result test-result)) ¶
-
- Source
- Generic Function: test-message (result) ¶
-
- Package
- Source
- Methods
- Method: test-message ((result test-result)) ¶
-
- Source
- Generic Function: test-name (test-case) ¶
-
- Package
- Source
- Methods
- Method: test-name ((test-case test-case)) ¶
-
- Source
- Generic Function: test-result-list (response) ¶
-
- Package
- Source
- Methods
- Method: test-result-list ((response list)) ¶
- Generic Function: test-result-success-p (result) ¶
Previous: Generic functions, Up: Public Interface [Contents][Index]
5.1.4 Classes
- Class: engine ¶
-
An abstraction over the test framework to integrate with slite
- Package
- Source
Previous: Public Interface, Up: Definitions [Contents][Index]
5.2 Internals
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
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
- Source
Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]
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
- Source
- Function: guess-fiveam (result) ¶
-
- Package
- Source
- Function: serialize-result (result) ¶
-
- Package
- Source
Previous: Ordinary functions, Up: Internals [Contents][Index]
5.2.3 Generic functions
- Generic Function: get-test-case-details (test-case) ¶
-
- Package
- Methods
- Method: get-test-case-details (test-case) ¶
-
- Source
- Generic Function: process-results (results) ¶
-
- Package
- Methods
- Method: process-results (results) ¶
-
- Source
Previous: Definitions, Up: The slite Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| Jump to: | E F G M O P R S T |
|---|
| Jump to: | E F G M O P R S T |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
A.3 Variables
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
A.4 Data types
| Jump to: | A C E F P S |
|---|
| Jump to: | A C E F P S |
|---|