Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the slite Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 06:07:30 2022 GMT+0.
• Introduction | What slite is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
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.
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.
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:
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
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.
Built by Arnold Noronha arnold@tdrhq.com
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The slite system |
Arnold Noronha <arnold@jipr.io>
Apache License, Version 2.0
SLIME based Test-runner for FiveAM tests (and possibly others in the future)
0.0.1
slite.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The slite.asd file | ||
• The slite/api.lisp file | ||
• The slite/slite.lisp file | ||
• The slite/fiveam.lisp file |
Next: The slite/api․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
slite.asd
slite (system)
Next: The slite/slite․lisp file, Previous: The slite․asd file, Up: Lisp files [Contents][Index]
slite (system)
api.lisp
Next: The slite/fiveam․lisp file, Previous: The slite/api․lisp file, Up: Lisp files [Contents][Index]
api.lisp (file)
slite (system)
slite.lisp
Previous: The slite/slite․lisp file, Up: Lisp files [Contents][Index]
slite.lisp (file)
slite (system)
fiveam.lisp
guess-fiveam (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The slite/api package | ||
• The slite package | ||
• The slite/fiveam package |
Next: The slite package, Previous: Packages, Up: Packages [Contents][Index]
api.lisp (file)
common-lisp
Next: The slite/fiveam package, Previous: The slite/api package, Up: Packages [Contents][Index]
slite.lisp (file)
Previous: The slite package, Up: Packages [Contents][Index]
fiveam.lisp (file)
guess-fiveam (function)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported classes |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
slite.lisp (file)
Next: Exported generic functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
slite.lisp (file)
Next: Exported classes, Previous: Exported functions, Up: Exported definitions [Contents][Index]
api.lisp (file)
fiveam.lisp (file)
slite.lisp (file)
slite.lisp (file)
api.lisp (file)
fiveam.lisp (file)
slite.lisp (file)
slite.lisp (file)
fiveam.lisp (file)
slite.lisp (file)
fiveam.lisp (file)
slite.lisp (file)
fiveam.lisp (file)
slite.lisp (file)
fiveam.lisp (file)
slite.lisp (file)
fiveam.lisp (file)
slite.lisp (file)
fiveam.lisp (file)
slite.lisp (file)
slite.lisp (file)
fiveam.lisp (file)
fiveam.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
An abstraction over the test framework to integrate with slite
slite.lisp (file)
standard-object (class)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal functions | ||
• Internal generic functions |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
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
slite.lisp (file)
Next: Internal generic functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
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
slite.lisp (file)
fiveam.lisp (file)
slite.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
slite.lisp (file)
slite.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L S |
---|
Jump to: | F L S |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | E F G M O P R S T |
---|
Jump to: | E F G M O P R S T |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
S |
---|
Jump to: | *
S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C E P S |
---|
Jump to: | C E P S |
---|