The slite Reference Manual

Table of Contents

The slite Reference Manual

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.

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

2 Systems

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

2.1 slite

Author

Arnold Noronha <arnold@jipr.io>

License

Apache License, Version 2.0

Description

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

Version

0.0.1

Dependencies

• str
• fiveam

Source

slite.asd (file)

Components

• api.lisp (file)
• slite.lisp (file)
• fiveam.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 slite.asd

Location

slite.asd

Systems

slite (system)

3.1.2 slite/api.lisp

Parent

slite (system)

Location

api.lisp

Packages

slite/api

Exported Definitions

• *framework-guessors* (special variable)
• guess-framework (function)
• rem-test (generic function)
• rerun-in-debugger (generic function)

3.1.3 slite/slite.lisp

Dependency

api.lisp (file)

Parent

slite (system)

Location

slite.lisp

Packages

slite

Exported Definitions

• *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-list (method)
• test-result-success-p (generic function)

Internal Definitions

• *last-results* (special variable)
• ensure-safe-for-sl* (function)
• get-test-case-details (method)
• process-results (method)
• serialize-result (function)

3.1.4 slite/fiveam.lisp

Dependency

slite.lisp (file)

Parent

slite (system)

Location

fiveam.lisp

Packages

slite/fiveam

Exported Definitions

• 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)

Internal Definitions

guess-fiveam (function)

4 Packages

Packages are listed by definition order.

4.1 slite/api

Source

api.lisp (file)

Use List

common-lisp

Exported Definitions

• *framework-guessors* (special variable)
• guess-framework (function)
• rem-test (generic function)
• rem-test (method)
• rem-test (method)
• rerun-in-debugger (generic function)
• rerun-in-debugger (method)
• rerun-in-debugger (method)

4.2 slite

Source

slite.lisp (file)

Use List

• alexandria
• common-lisp

Exported Definitions

• *engine* (special variable)
• engine (class)
• on-pass (function)
• remove-test (generic function)
• rerun-in-debugger-impl (generic function)
• run-all-fiveam-tests (generic function)
• run-all-fiveam-tests (method)
• test-case (generic function)
• test-case (method)
• test-case-package (generic function)
• test-case-package (method)
• test-expression (generic function)
• test-expression (method)
• test-message (generic function)
• test-message (method)
• test-name (generic function)
• test-name (method)
• test-result-list (generic function)
• test-result-list (method)
• test-result-success-p (generic function)
• test-result-success-p (method)
• test-result-success-p (method)

Internal Definitions

• *last-results* (special variable)
• ensure-safe-for-sl* (function)
• get-test-case-details (generic function)
• get-test-case-details (method)
• process-results (generic function)
• process-results (method)
• serialize-result (function)

4.3 slite/fiveam

Source

fiveam.lisp (file)

Use List

• alexandria
• common-lisp

Internal Definitions

guess-fiveam (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *engine*

Package

slite

Source

slite.lisp (file)

Special Variable: *framework-guessors*

Package

slite/api

Source

api.lisp (file)

5.1.2 Functions

Function: guess-framework RESULT

Package

slite/api

Source

api.lisp (file)

Function: on-pass RESULTS &key SHELL

Package

slite

Source

slite.lisp (file)

5.1.3 Generic functions

Generic Function: rem-test FRAMEWORK NAME PACKAGE

Package

slite/api

Source

api.lisp (file)

Methods

Method: rem-test (FRAMWORK (eql fiveam)) NAME PACKAGE

Source

fiveam.lisp (file)

Method: rem-test FRAMEWORK NAME PACKAGE around

Source

slite.lisp (file)

Generic Function: remove-test ENGINE NAME PACKAGE

Package

slite

Source

slite.lisp (file)

Generic Function: rerun-in-debugger FRAMEWORK NAME PACKAGE

Package

slite/api

Source

api.lisp (file)

Methods

Method: rerun-in-debugger (FRAMEWORK (eql fiveam)) NAME PACKAGE

Source

fiveam.lisp (file)

Method: rerun-in-debugger FRAMEWORK NAME PACKAGE around

Source

slite.lisp (file)

Generic Function: rerun-in-debugger-impl ENGINE NAME PACKAGE

Package

slite

Source

slite.lisp (file)

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

Package

slite

Methods

Method: run-all-fiveam-tests ()

Source

fiveam.lisp (file)

Generic Function: test-case TEST-RESULT

Package

slite

Source

slite.lisp (file)

Methods

Method: test-case (RESULT test-result)

Source

fiveam.lisp (file)

Generic Function: test-case-package RESULT

Package

slite

Source

slite.lisp (file)

Methods

Method: test-case-package (TEST-CASE test-case)

Source

fiveam.lisp (file)

Generic Function: test-expression RESULT

Package

slite

Source

slite.lisp (file)

Methods

Method: test-expression (RESULT test-result)

Source

fiveam.lisp (file)

Generic Function: test-message RESULT

Package

slite

Source

slite.lisp (file)

Methods

Method: test-message (RESULT test-result)

Source

fiveam.lisp (file)

Generic Function: test-name TEST-CASE

Package

slite

Source

slite.lisp (file)

Methods

Method: test-name (TEST-CASE test-case)

Source

fiveam.lisp (file)

Generic Function: test-result-list RESPONSE

Package

slite

Source

slite.lisp (file)

Methods

Method: test-result-list (RESPONSE list)

Generic Function: test-result-success-p RESULT

Package

slite

Source

slite.lisp (file)

Methods

Method: test-result-success-p (RESULT test-result)

Source

fiveam.lisp (file)

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

Source

fiveam.lisp (file)

5.1.4 Classes

Class: engine ()

An abstraction over the test framework to integrate with slite

Package

slite

Source

slite.lisp (file)

Direct superclasses

standard-object (class)

5.2 Internal definitions

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 (file)

5.2.2 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 (file)

Function: guess-fiveam RESULT

Package

slite/fiveam

Source

fiveam.lisp (file)

Function: serialize-result RESULT

Package

slite

Source

slite.lisp (file)

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 (file)

Generic Function: process-results RESULTS

Package

slite

Methods

Method: process-results RESULTS

Source

slite.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types