Feature/zephyr ztest (#118)
* Leverage (older) embedded unit tests into external unit tests build upon copy of Zephyr's ztest library and CMake. * Expand top-level CMake build to run external unit tests. * Expand Zephyr module extension to run external unit tests via west or sanitycheck. Co-authored-by: Gregory Shue <gregory.shue@legrand.us>
This commit is contained in:
Greg Shue
@@ -0,0 +1,225 @@
|
||||
/*
|
||||
* Copyright (c) 2016 Intel Corporation
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Zephyr testing framework assertion macros
|
||||
*/
|
||||
|
||||
#ifndef __ZTEST_ASSERT_H__
|
||||
#define __ZTEST_ASSERT_H__
|
||||
|
||||
#include <ztest.h>
|
||||
#include <stdarg.h>
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
void ztest_test_fail(void);
|
||||
#if CONFIG_ZTEST_ASSERT_VERBOSE == 0
|
||||
|
||||
static inline void z_zassert_(bool cond, const char *file, int line)
|
||||
{
|
||||
if (cond == false) {
|
||||
PRINT("\n Assertion failed at %s:%d\n",
|
||||
file, line);
|
||||
ztest_test_fail();
|
||||
}
|
||||
}
|
||||
|
||||
#define z_zassert(cond, default_msg, file, line, func, msg, ...) \
|
||||
z_zassert_(cond, file, line)
|
||||
|
||||
#else /* CONFIG_ZTEST_ASSERT_VERBOSE != 0 */
|
||||
|
||||
static inline void z_zassert(bool cond,
|
||||
const char *default_msg,
|
||||
const char *file,
|
||||
int line, const char *func,
|
||||
const char *msg, ...)
|
||||
{
|
||||
if (cond == false) {
|
||||
va_list vargs;
|
||||
|
||||
va_start(vargs, msg);
|
||||
PRINT("\n Assertion failed at %s:%d: %s: %s\n",
|
||||
file, line, func, default_msg);
|
||||
vprintk(msg, vargs);
|
||||
printk("\n");
|
||||
va_end(vargs);
|
||||
ztest_test_fail();
|
||||
}
|
||||
#if CONFIG_ZTEST_ASSERT_VERBOSE == 2
|
||||
else {
|
||||
PRINT("\n Assertion succeeded at %s:%d (%s)\n",
|
||||
file, line, func);
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
#endif /* CONFIG_ZTEST_ASSERT_VERBOSE */
|
||||
|
||||
|
||||
/**
|
||||
* @defgroup ztest_assert Ztest assertion macros
|
||||
* @ingroup ztest
|
||||
*
|
||||
* This module provides assertions when using Ztest.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief Fail the test, if @a cond is false
|
||||
*
|
||||
* You probably don't need to call this macro directly. You should
|
||||
* instead use zassert_{condition} macros below.
|
||||
*
|
||||
* @param cond Condition to check
|
||||
* @param msg Optional, can be NULL. Message to print if @a cond is false.
|
||||
* @param default_msg Message to print if @a cond is false
|
||||
*/
|
||||
|
||||
#define zassert(cond, default_msg, msg, ...) \
|
||||
z_zassert(cond, msg ? ("(" default_msg ")") : (default_msg), \
|
||||
__FILE__, __LINE__, __func__, msg ? msg : "", ##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Assert that this function call won't be reached
|
||||
* @param msg Optional message to print if the assertion fails
|
||||
*/
|
||||
#define zassert_unreachable(msg, ...) zassert(0, "Reached unreachable code", \
|
||||
msg, ##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Assert that @a cond is true
|
||||
* @param cond Condition to check
|
||||
* @param msg Optional message to print if the assertion fails
|
||||
*/
|
||||
#define zassert_true(cond, msg, ...) zassert(cond, #cond " is false", \
|
||||
msg, ##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Assert that @a cond is false
|
||||
* @param cond Condition to check
|
||||
* @param msg Optional message to print if the assertion fails
|
||||
*/
|
||||
#define zassert_false(cond, msg, ...) zassert(!(cond), #cond " is true", \
|
||||
msg, ##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Assert that @a ptr is NULL
|
||||
* @param ptr Pointer to compare
|
||||
* @param msg Optional message to print if the assertion fails
|
||||
*/
|
||||
#define zassert_is_null(ptr, msg, ...) zassert((ptr) == NULL, \
|
||||
#ptr " is not NULL", \
|
||||
msg, ##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Assert that @a ptr is not NULL
|
||||
* @param ptr Pointer to compare
|
||||
* @param msg Optional message to print if the assertion fails
|
||||
*/
|
||||
#define zassert_not_null(ptr, msg, ...) zassert((ptr) != NULL, \
|
||||
#ptr " is NULL", msg, \
|
||||
##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Assert that @a a equals @a b
|
||||
*
|
||||
* @a a and @a b won't be converted and will be compared directly.
|
||||
*
|
||||
* @param a Value to compare
|
||||
* @param b Value to compare
|
||||
* @param msg Optional message to print if the assertion fails
|
||||
*/
|
||||
#define zassert_equal(a, b, msg, ...) zassert((a) == (b), \
|
||||
#a " not equal to " #b, \
|
||||
msg, ##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Assert that @a a does not equal @a b
|
||||
*
|
||||
* @a a and @a b won't be converted and will be compared directly.
|
||||
*
|
||||
* @param a Value to compare
|
||||
* @param b Value to compare
|
||||
* @param msg Optional message to print if the assertion fails
|
||||
*/
|
||||
#define zassert_not_equal(a, b, msg, ...) zassert((a) != (b), \
|
||||
#a " equal to " #b, \
|
||||
msg, ##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Assert that @a a equals @a b
|
||||
*
|
||||
* @a a and @a b will be converted to `void *` before comparing.
|
||||
*
|
||||
* @param a Value to compare
|
||||
* @param b Value to compare
|
||||
* @param msg Optional message to print if the assertion fails
|
||||
*/
|
||||
#define zassert_equal_ptr(a, b, msg, ...) \
|
||||
zassert((void *)(a) == (void *)(b), #a " not equal to " #b, \
|
||||
msg, ##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Assert that @a a is within @a b with delta @a d
|
||||
*
|
||||
* @param a Value to compare
|
||||
* @param b Value to compare
|
||||
* @param d Delta
|
||||
* @param msg Optional message to print if the assertion fails
|
||||
*/
|
||||
#define zassert_within(a, b, d, msg, ...) \
|
||||
zassert(((a) > ((b) - (d))) && ((a) < ((b) + (d))), \
|
||||
#a " not within " #b " +/- " #d, \
|
||||
msg, ##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Assert that 2 memory buffers have the same contents
|
||||
*
|
||||
* This macro calls the final memory comparison assertion macro.
|
||||
* Using double expansion allows providing some arguments by macros that
|
||||
* would expand to more than one values (ANSI-C99 defines that all the macro
|
||||
* arguments have to be expanded before macro call).
|
||||
*
|
||||
* @param ... Arguments, see @ref zassert_mem_equal__
|
||||
* for real arguments accepted.
|
||||
*/
|
||||
#define zassert_mem_equal(...) \
|
||||
zassert_mem_equal__(__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @brief Internal assert that 2 memory buffers have the same contents
|
||||
*
|
||||
* @note This is internal macro, to be used as a second expansion.
|
||||
* See @ref zassert_mem_equal.
|
||||
*
|
||||
* @param buf Buffer to compare
|
||||
* @param exp Buffer with expected contents
|
||||
* @param size Size of buffers
|
||||
* @param msg Optional message to print if the assertion fails
|
||||
*/
|
||||
#define zassert_mem_equal__(buf, exp, size, msg, ...) \
|
||||
zassert(memcmp(buf, exp, size) == 0, #buf " not equal to " #exp, \
|
||||
msg, ##__VA_ARGS__)
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* __ZTEST_ASSERT_H__ */
|
||||
Reference in New Issue
Block a user