renun/koreader
1
0
Fork 0
mirror of https://github.com/koreader/koreader.git synced 2025-08-10 00:52:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: update testing instructions

Browse Source
This commit is contained in:
Benoit Pierre
2025-06-14 12:57:20 +02:00
committed by Frans de Jonge
parent ce8d338d94
commit 4dc4339bc7
1 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/Unit_tests.md
View File

@@ -1,16 +1,14 @@
# Unit Tests
Unit tests are automatically performed using [busted](http://olivinelabs.com/busted/). It depends on `luarocks`.
Unit tests are written for [busted](https://lunarmodules.github.io/busted/)
(a version is automatically provided by the build system), and executed in
parallel with the meson test runner.
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.0-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.0-1
```
Then you can set up the environment variables with `./kodev activate`.
You can run them with `./kodev test`, examples:
If all went well, you'll now be able to run `./kodev test front` (for the frontend) or `./kodev test base` (for koreader-base).
- to run all tests (frontend & base): `./kodev test`
- frontend only: `./kodev test front`
- to run one specific base test: `./kodev test base util`
- to list available tests: `./kodev test -l`
You can run individual tests using `./kodev test front testname_spec.lua`.
Check the output of `./kodev test -h` for the full usage.