diff options
| author | Eelco Dolstra <edolstra@gmail.com> | 2022-05-16 13:19:03 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-16 13:19:03 +0200 |
| commit | 937a10610005c723286b2a43c1533f907b9f6b59 (patch) | |
| tree | a6480e2aeb6cdfd5e8374bf296875a4f77996007 | |
| parent | bf89cd95a4af35ab15f7fad3186c8f6190f87c84 (diff) | |
| parent | 65a913d29be7305b2c743fb92c93f0e6bb12d610 (diff) | |
Merge pull request #6517 from NixOS/document-the-libexpr-tests
Expand the testing section of the hacking docs
| -rw-r--r-- | doc/manual/src/contributing/hacking.md | 38 |
1 files changed, 26 insertions, 12 deletions
diff --git a/doc/manual/src/contributing/hacking.md b/doc/manual/src/contributing/hacking.md index 90a8f1f94..59ce5cac7 100644 --- a/doc/manual/src/contributing/hacking.md +++ b/doc/manual/src/contributing/hacking.md @@ -71,18 +71,6 @@ To install it in `$(pwd)/outputs` and test it: nix (Nix) 3.0 ``` -To run a functional test: - -```console -make tests/test-name-should-auto-complete.sh.test -``` - -To run the unit-tests for C++ code: - -``` -make check -``` - If you have a flakes-enabled Nix you can replace: ```console @@ -94,3 +82,29 @@ by: ```console $ nix develop ``` + +## Testing + +Nix comes with three different flavors of tests: unit, functional and integration. + +### Unit-tests + +The unit-tests for each Nix library (`libexpr`, `libstore`, etc..) are defined +under `src/{library_name}/tests` using the +[googletest](https://google.github.io/googletest/) framework. + +You can run the whole testsuite with `make check`, or the tests for a specific component with `make libfoo-tests_RUN`. Finer-grained filtering is also possible using the [--gtest_filter](https://google.github.io/googletest/advanced.html#running-a-subset-of-the-tests) command-line option. + +### Functional tests + +The functional tests reside under the `tests` directory and are listed in `tests/local.mk`. +The whole testsuite can be run with `make install && make installcheck`. +Individual tests can be run with `make tests/{testName}.sh.test`. + +### Integration tests + +The integration tests are defined in the Nix flake under the `hydraJobs.tests` attribute. +These tests include everything that needs to interact with external services or run Nix in a non-trivial distributed setup. +Because these tests are expensive and require more than what the standard github-actions setup provides, they only run on the master branch (on <https://hydra.nixos.org/jobset/nix/master>). + +You can run them manually with `nix build .#hydraJobs.tests.{testName}` or `nix-build -A hydraJobs.tests.{testName}` |