Skip to content

Commit

Permalink
Dev docs: added "Unit tests"
Browse files Browse the repository at this point in the history
  • Loading branch information
Frenzie committed Apr 8, 2017
1 parent f36bcce commit 1f230d9
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/Unit tests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Unit Tests

Unit tests are automatically performed using [busted](http://olivinelabs.com/busted/). It depends on `luarocks`.

To grab busted, install the same version [as used in the automated tests](https://github.com/koreader/koreader/blob/master/.ci/install.sh). At the time of writing that is 2.0.rc12-1:
```bash
mkdir $HOME/.luarocks
cp /etc/luarocks/config.lua $HOME/.luarocks/config.lua
echo "wrap_bin_scripts = false" >> $HOME/.luarocks/config.lua
luarocks --local install busted 2.0.rc12-1
```
Then you can set up the environment variables with `./kodev activate`.

If all went well, you'll now be able to run `./kodev test front` (for the frontend) or `./kodev test base` (for koreader-base).

0 comments on commit 1f230d9

Please sign in to comment.