Disroot/gpg-lacre
8
14
Fork 4
Code Issues 38 Pull requests 1 Releases 3 Wiki Activity

Update testing documentation

Browse source
This commit is contained in:
Piotr F. Mieszkowski 2022-04-23 13:13:57 +02:00
parent ffc53b935a
commit b19a76e297
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/testing.md
View file

@ -6,10 +6,17 @@ feed some input to GPG Mailgate and inspect the output.
## Running tests
To run tests, use command `make test` or `make unittest`.
To run tests, use command `make test`.
Tests produce some helpful logs, so inspect contents of `test/logs` directory
if something goes wrong.
There are 3 types of tests:
* `make e2etest` -- they cover a complete Lacre flow, from feeding it with
an email to accepting its encrypted form;
* `make unittest` -- just small tests of small units of code;
* `make crontest` -- execute cron job with a SQLite database.
E2E tests (`make e2etest`) should produce some helpful logs, so inspect
contents of `test/logs` directory if something goes wrong.
If your system's Python binary isn't found in your `$PATH` or you want to use
a specific binary, use make's macro overriding: `make test