rrthomas / specl

Behaviour Driven Development for Lua.

SPECL

Specl is a testing tool for Lua, providing a Behaviour Driven Development framework in the vein of RSpec.

• a rich command line program (the specl command)
• textual descriptions of examples and groups (spec files use YAML)
• flexible and customizable reporting (formatters)
• extensible expectation language (matchers)

Installation

There's no need to download a Specl release, or clone the git repo, unless you want to modify the code. If you use LuaRocks, you can use it to install the latest release from its repository:

luarocks install specl

Or from the rockspec inside the release tarball:

luarocks make specl-?-1.rockspec

To install current git master from GitHub (for testing):

luarocks install \
  https://raw.githubusercontent.com/gvvaughan/specl/master/specl-git-1.rockspec

To install without LuaRocks, clone the sources from the repository, and then run the following commands:

cd specl
./bootstrap
./configure --prefix=INSTALLATION-ROOT-DIRECTORY
make all check install

The dependencies are listed in the dependencies entry of the file rockspec.conf. You will also need Autoconf and Automake.

See INSTALL for instructions for configure.

Documentation

Specl includes comprehensive documentation.