README.md

RCLootCouncil Tests

Tests are made using busted. Each test can be run individually from it's file (assuming path is pointing at the project root), or globally.

Tests are run automatically on the repo, and should be run before commits aswell (see below for instructions).

Structure

I hate the standard busted *_spec.lua convention and have opted for *.spec.lua instead. Busted should pick up spec files no matter where they are, but for structure I try to keep them in /.specs (which also automatically avoids having them packaged).

Paths

AddonLoader.lua (which basically all test script uses to load files) relies on __tests/wow_api.lua and __tests/wow_item_api.lua being in the execution path. There's several ways to do this depending on your OS, but in VS Code using sumneko.lua extension, the required settings are set in ./.vscode/settings.json.

Running tests

When using the tools below, running the tests is as easy as running any of the Busted tasks. Alternatively one can invoke busted in the root folder, assuming busted.bat is in the current PATH.

Tools

Below is my collection of useful tools for the testing environment and development.

VS Code

See extensions.json

Git pre-commit

To automatically run the tests before committing, simply add this following to .git/hooks/pre-commit:

#!/bin/sh

branch="$(git rev-parse --abbrev-ref HEAD)"

if [ "$branch" = "master" ]; then
  echo "You can't commit directly to master branch"
  exit 1
else
  echo "Running tests"
  # Add wow_api's to path to complete tests
  LUA_PATH=".\\__tests\\?.lua;$LUA_PATH"
  exec busted.bat -o=TAP --no-coverage
fi

That's a file named pre-commit.