From 5c041971eb772ec5257e885d52d1788aa04b404a Mon Sep 17 00:00:00 2001 From: Daan De Meyer Date: Wed, 10 Apr 2024 13:40:16 +0200 Subject: [PATCH] docs: Add Tests section to coding style doc --- docs/CODING_STYLE.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/CODING_STYLE.md b/docs/CODING_STYLE.md index 6d6e549f5c7..7a1977d8045 100644 --- a/docs/CODING_STYLE.md +++ b/docs/CODING_STYLE.md @@ -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. -- 2.47.3