155 lines
3.9 KiB
C
155 lines
3.9 KiB
C
|
|
/*
|
|
* Copyright (c) 2016 Intel Corporation
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
*
|
|
* @brief Zephyr testing framework assertion macros
|
|
*/
|
|
|
|
#ifndef __ZTEST_ASSERT_H__
|
|
#define __ZTEST_ASSERT_H__
|
|
|
|
#include <ztest.h>
|
|
|
|
#ifdef assert
|
|
#undef assert
|
|
#endif
|
|
|
|
void ztest_test_fail(void);
|
|
|
|
#if CONFIG_ZTEST_ASSERT_VERBOSE == 0
|
|
|
|
static inline void _assert_(int cond, const char *file, int line)
|
|
{
|
|
if (!(cond)) {
|
|
PRINT("\n Assertion failed at %s:%d\n",
|
|
file, line);
|
|
ztest_test_fail();
|
|
}
|
|
}
|
|
|
|
#define _assert(cond, msg, default_msg, file, line, func) \
|
|
_assert_(cond, file, line)
|
|
|
|
#else /* CONFIG_ZTEST_ASSERT_VERBOSE != 0 */
|
|
|
|
static inline void _assert(int cond, const char *msg, const char *default_msg,
|
|
const char *file, int line, const char *func)
|
|
{
|
|
if (!(cond)) {
|
|
PRINT("\n Assertion failed at %s:%d: %s: %s %s\n",
|
|
file, line, func, msg, default_msg);
|
|
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 assert_{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 assert(cond, msg, default_msg) \
|
|
_assert(cond, msg, msg ? ("(" default_msg ")") : (default_msg), \
|
|
__FILE__, __LINE__, __func__)
|
|
|
|
/**
|
|
* @brief Assert that this function call won't be reached
|
|
* @param msg Optional message to print if the assertion fails
|
|
*/
|
|
#define assert_unreachable(msg) assert(0, msg, "Reached unreachable code")
|
|
|
|
/**
|
|
* @brief Assert that @a cond is true
|
|
* @param cond Condition to check
|
|
* @param msg Optional message to print if the assertion fails
|
|
*/
|
|
#define assert_true(cond, msg) assert(cond, msg, #cond " is false")
|
|
|
|
/**
|
|
* @brief Assert that @a cond is false
|
|
* @param cond Condition to check
|
|
* @param msg Optional message to print if the assertion fails
|
|
*/
|
|
#define assert_false(cond, msg) assert(!(cond), msg, #cond " is true")
|
|
|
|
/**
|
|
* @brief Assert that @a ptr is NULL
|
|
* @param ptr Pointer to compare
|
|
* @param msg Optional message to print if the assertion fails
|
|
*/
|
|
#define assert_is_null(ptr, msg) assert((ptr) == NULL, msg, #ptr " is not NULL")
|
|
|
|
/**
|
|
* @brief Assert that @a ptr is not NULL
|
|
* @param ptr Pointer to compare
|
|
* @param msg Optional message to print if the assertion fails
|
|
*/
|
|
#define assert_not_null(ptr, msg) assert((ptr) != NULL, msg, #ptr " is NULL")
|
|
|
|
/**
|
|
* @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 assert_equal(a, b, msg) assert((a) == (b), msg, #a " not equal to " #b)
|
|
|
|
/**
|
|
* @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 assert_equal_ptr(a, b, msg) \
|
|
assert((void *)(a) == (void *)(b), msg, #a " not equal to " #b)
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* __ZTEST_ASSERT_H__ */
|