diff options
Diffstat (limited to 'tests')
| -rw-r--r-- | tests/README.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/tests/README.rst b/tests/README.rst index 69393dcc..37867b38 100644 --- a/tests/README.rst +++ b/tests/README.rst @@ -1,13 +1,13 @@ .. SPDX-License-Identifier: GPL-3.0-or-later Tests ------ +===== The following is a non-comprehensitve lists of various tests that can be found in this repo. These can be enabled by the build system. Unit tests -~~~~~~~~~~ +---------- The unit tests depend on cmocka_ and can easily be executed after compilation. They are enabled by default (if ``cmocka`` is found). @@ -18,7 +18,7 @@ They are enabled by default (if ``cmocka`` is found). $ meson test -C build_dir --suite unit Postinstall tests -~~~~~~~~~~~~~~~~~ +----------------- There following tests require a working installation of kresd. The binary ``kresd`` found in ``$PATH`` will be tested. When testing through meson, @@ -30,7 +30,7 @@ kresd first. $ ninja install -C build_dir Config tests -~~~~~~~~~~~~ +------------ Config tests utilize the kresd's lua config file to execute arbitrary tests, typically testing various modules, their API etc. @@ -46,7 +46,7 @@ the build dir). $ meson test -C build_dir --suite config Extra tests -~~~~~~~~~~~ +----------- The extra tests require a large set of additional dependencies and executing them outside of upstream development is probably redundant. @@ -82,7 +82,7 @@ example TCP, TLS and its connection management. $ meson test -C build_dir --suite pytests Useful meson commands -~~~~~~~~~~~~~~~~~~~~~ +--------------------- It's possible to run only specific test suite or a test. |