https://github.com/tdrhq/slite
a SLIme-based TEst runner for FiveAM and Parachute Tests
https://github.com/tdrhq/slite
Last synced: 3 months ago
JSON representation
a SLIme-based TEst runner for FiveAM and Parachute Tests
- Host: GitHub
- URL: https://github.com/tdrhq/slite
- Owner: tdrhq
- License: apache-2.0
- Created: 2021-07-21T05:33:19.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-22T16:43:18.000Z (over 2 years ago)
- Last Synced: 2024-05-19T05:36:28.590Z (almost 2 years ago)
- Language: Common Lisp
- Homepage:
- Size: 97.7 KB
- Stars: 50
- Watchers: 5
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cl - Slite - a test runner for FiveAM. (Emacs ## / Third-party APIs)
README
# SLITE
[](https://app.circleci.com/pipelines/github/tdrhq/slite?branch=main)
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 Delete to delete a test (useful when you rename a test and want
to delete the old 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](https://github.com/tdrhq/fiveam) version of FiveAM)
Press `C-c j` to compile the current expression, and then rerun the
tests. (Essentially equivalent to `C-c C-c` followed by `C-c v`)
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 of [Screenshotbot](https://screenshotbot.io).