]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
docs: Add Tests section to coding style doc 32202/head
authorDaan De Meyer <daan.j.demeyer@gmail.com>
Wed, 10 Apr 2024 11:40:16 +0000 (13:40 +0200)
committerDaan De Meyer <daan.j.demeyer@gmail.com>
Wed, 10 Apr 2024 16:24:29 +0000 (18:24 +0200)
docs/CODING_STYLE.md

index 6d6e549f5c7bca80468a4a59c1cfdea50fef0485..7a1977d80450973e617f4bf58914b66a35447384 100644 (file)
@@ -780,3 +780,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later
   good idea where it might end up running inside of libsystemd.so or
   similar. Hence, use TLS (i.e. `thread_local`) where appropriate, and maybe
   the occasional `pthread_once()`.
+
+## Tests
+
+- Use the assertion macros from `tests.h` (`ASSERT_GE()`, `ASSERT_OK()`, ...) to
+  make sure a descriptive error is logged when an assertion fails. If no assertion
+  macro exists for your specific use case, please add a new assertion macro in a
+  separate commit.
+
+- When modifying existing tests, please convert the test to use the new assertion
+  macros from `tests.h` if it is not already using those.