coreboot-mirror
/
cmocka
mirror of https://review.coreboot.org/cmocka.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Implement assert macros with user provided error messages 

Signed-off-by: Friedrich Schwedler <fschwedler@emlix.com>
Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
This commit is contained in:
Friedrich Schwedler 2024-03-12 17:13:10 +01:00 committed by Andreas Schneider
parent 9fd057cc71
commit 614175f145
2 changed files with 111 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
include/cmocka.h
View File

@ -1649,6 +1649,24 @@ void assert_non_null(void *pointer);
#define assert_non_null(c) assert_ptr_not_equal((c), NULL)
#endif
#ifdef DOXYGEN
/**
* @brief Assert that the given pointer is non-NULL.
*
* The function prints an error message extended by message to standard error
* and terminates the test by calling fail() if the pointer is NULL.
*
* @param[in] pointer The pointer to evaluate.
*
* @param[in] message The message to print when the pointer is NULL.
*
* @see assert_null_msg()
*/
void assert_non_null_msg(void *pointer, const char *const message);
#else
#define assert_non_null_msg(c, msg) assert_ptr_not_equal_msg((c), NULL, (msg))
#endif
#ifdef DOXYGEN
/**
* @brief Assert that the given pointer is NULL.
@ -1665,6 +1683,24 @@ void assert_null(void *pointer);
#define assert_null(c) assert_ptr_equal((c), NULL)
#endif
#ifdef DOXYGEN
/**
* @brief Assert that the given pointer is NULL.
*
* The function prints an error message extended by message to standard error
* and terminates the test by calling fail() if the pointer is non-NULL.
*
* @param[in] pointer The pointer to evaluate.
*
* @param[in] message The message to print when the pointer is not NULL.
*
* @see assert_non_null_msg()
*/
void assert_null_msg(void *pointer, const char *const message);
#else
#define assert_null_msg(c, msg) assert_ptr_equal_msg((c), NULL, (msg))
#endif
#ifdef DOXYGEN
/**
* @brief Assert that the two given pointers are equal.
@ -1681,6 +1717,25 @@ void assert_ptr_equal(void *a, void *b);
#define assert_ptr_equal(a, b) _assert_ptr_equal((a), (b), __FILE__, __LINE__)
#endif
#ifdef DOXYGEN
/**
* @brief Assert that the two given pointers are equal.
*
* The function prints the failing comparision and the error message given by the user
* and then terminates the test by calling fail() if the pointers are not equal.
*
* @param[in] a The first pointer to compare.
*
* @param[in] b The pointer to compare against the first one.
*
* @param[in] msg The error message to print when a & b are not equal.
*/
void assert_ptr_equal_msg(void *a, void *b, const char *const msg);
#else
#define assert_ptr_equal_msg(a, b, msg) \
_assert_ptr_equal_msg((a), (b), __FILE__, __LINE__, (msg))
#endif
#ifdef DOXYGEN
/**
* @brief Assert that the two given pointers are not equal.
@ -1698,6 +1753,25 @@ void assert_ptr_not_equal(void *a, void *b);
_assert_ptr_not_equal((a), (b), __FILE__, __LINE__)
#endif
#ifdef DOXYGEN
/**
* @brief Assert that the two given pointers are not equal.
*
* The function prints the failing comparision and the error message given by the user
* and then terminates the test by calling fail() if the pointers are equal.
*
* @param[in] a The first pointer to compare.
*
* @param[in] b The pointer to compare against the first one.
*
* @param[in] msg The error message to print when a & b are equal.
*/
void assert_ptr_not_equal_msg(void *a, void *b, const char *const msg);
#else
#define assert_ptr_not_equal_msg(a, b, msg) \
_assert_ptr_not_equal_msg((a), (b), __FILE__, __LINE__, (msg))
#endif
#ifdef DOXYGEN
/**
* @brief Assert that the two given integers are equal.
@ -3091,10 +3165,22 @@ void _assert_ptr_equal(const void *a,
const char *const file,
const int line);
CMOCKA_NO_ACCESS_ATTRIBUTE
void _assert_ptr_equal_msg(const void *a,
const void *b,
const char *const file,
const int line,
const char *const msg);
CMOCKA_NO_ACCESS_ATTRIBUTE
void _assert_ptr_not_equal(const void *a,
const void *b,
const char *const file,
const int line);
CMOCKA_NO_ACCESS_ATTRIBUTE
void _assert_ptr_not_equal_msg(const void *a,
const void *b,
const char *const file,
const int line,
const char *const msg);
void _assert_string_equal(const char * const a, const char * const b,
const char * const file, const int line);
void _assert_string_not_equal(const char * const a, const char * const b,

25
src/cmocka.c
View File

@ -2392,6 +2392,18 @@ void _assert_ptr_equal(const void *a,
}
}
void _assert_ptr_equal_msg(const void *a,
const void *b,
const char *const file,
const int line,
const char *const msg)
{
if (!ptr_values_equal_display_error(a, b)) {
_additional_msg(msg);
_fail(file, line);
}
}
void _assert_ptr_not_equal(const void *a,
const void *b,
const char *const file,
@ -2402,6 +2414,19 @@ void _assert_ptr_not_equal(const void *a,
}
}
void _assert_ptr_not_equal_msg(const void *a,
const void *b,
const char *const file,
const int line,
const char *const msg)
{
if (!ptr_values_not_equal_display_error(a, b)) {
_additional_msg(msg);
_fail(file, line);
}
}
void _assert_string_equal(const char * const a, const char * const b,
const char * const file, const int line) {
if (!string_equal_display_error(a, b)) {