vriska/hydra
0
0
Fork 0
forked from lix-project/hydra
Code Pull requests Activity

doc: document how to run tests

Browse source 
Both `make check` and `make && yath test` are now documented ways to
run the test suite.
This commit is contained in:
Cole Helbling 2021-03-05 00:01:49 -08:00
parent 025be052b7
commit 2befb2c1e1
No known key found for this signature in database
GPG key ID: B37E0F2371016A4C
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/manual/src/hacking.md
View file

@ -26,3 +26,21 @@ To build Hydra, you should then do:
You can run the Hydra web server in your source tree as follows:
$ ./src/script/hydra-server
You can run Hydra's test suite with the following:
[nix-shell]$ make check
[nix-shell]$ # to run as many tests as you have cores:
[nix-shell]$ make check YATH_JOB_COUNT=$NIX_BUILD_CORES
[nix-shell]$ # or run yath directly:
[nix-shell]$ yath test
[nix-shell]$ # to run as many tests as you have cores:
[nix-shell]$ yath test -j $NIX_BUILD_CORES
When using `yath` instead of `make check`, ensure you have run `make`
in the root of the repository at least once.
**Warning**: Currently, the tests can fail
if run with high parallelism [due to an issue in
`Test::PostgreSQL`](https://github.com/TJC/Test-postgresql/issues/40)
causing database ports to collide.