From: Iker Pedrosa Date: Fri, 15 Sep 2023 07:24:41 +0000 (+0200) Subject: doc: add unit tests X-Git-Tag: 4.15.0-rc1~171 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=4f49e3fd3e869246a4f78efe07c104c0b681e41b;p=thirdparty%2Fshadow.git doc: add unit tests Brief description of the unit testing framework and how to create test cases with it. Signed-off-by: Iker Pedrosa --- diff --git a/doc/contributions/tests.md b/doc/contributions/tests.md index db7218d95..e765fe690 100644 --- a/doc/contributions/tests.md +++ b/doc/contributions/tests.md @@ -1,6 +1,22 @@ # Tests -Currently, shadow only provides system tests. +Currently, shadow provides unit and system tests. + +## Unit tests + +Unit testing is provided by the [cmocka](https://cmocka.org/) framework. It's +recommended to read the +[basics](https://cmocka.org/talks/cmocka_unit_testing_and_mocking.pdf) and +[API](https://api.cmocka.org/) before writing any test case. + +In addition, you can check [test_logind.c](../../tests/unit/test_logind.c) to +get a general idea on how to implement unit tests for shadow using cmocka. + +You can execute unit tests by running: + +``` +make check +``` ## System tests