ztest_assert.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_TESTSUITE_ZTEST_ASSERT_H_
#define ZEPHYR_TESTSUITE_ZTEST_ASSERT_H_
 
#include <ztest.h>
#include <stdarg.h>
#include <stdio.h>
#include <string.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
const char *ztest_relative_filename(const char *file);
void ztest_test_fail(void);
#if CONFIG_ZTEST_ASSERT_VERBOSE == 0
 
static inline bool z_zassert_(bool cond, const char *file, int line)
{
        if (cond == false) {
                PRINT("\n    Assertion failed at %s:%d\n",
                      ztest_relative_filename(file), line);
                ztest_test_fail();
                return false;
        }
 
        return true;
}
 
#define z_zassert(cond, default_msg, file, line, func, msg, ...)        \
        z_zassert_(cond, file, line)
 
#else /* CONFIG_ZTEST_ASSERT_VERBOSE != 0 */
 
static inline bool 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",
                      ztest_relative_filename(file), line, func, default_msg);
                vprintk(msg, vargs);
                printk("\n");
                va_end(vargs);
                ztest_test_fail();
                return false;
        }
#if CONFIG_ZTEST_ASSERT_VERBOSE == 2
        else {
                PRINT("\n   Assertion succeeded at %s:%d (%s)\n",
                      ztest_relative_filename(file), line, func);
        }
#endif
        return true;
}
 
#endif /* CONFIG_ZTEST_ASSERT_VERBOSE */
 
 
#define zassert(cond, default_msg, msg, ...) do { \
        bool _ret = z_zassert(cond, msg ? ("(" default_msg ")") : (default_msg), \
                             __FILE__, __LINE__, __func__, \
                             msg ? msg : "", ##__VA_ARGS__); \
        if (!_ret) { \
                /* If kernel but without multithreading return. */ \
                COND_CODE_1(KERNEL, \
                            (COND_CODE_1(CONFIG_MULTITHREADING, (), (return;))), \
                            ()) \
        } \
} while (0)
 
#define zassert_unreachable(msg, ...) zassert(0, "Reached unreachable code", \
                                              msg, ##__VA_ARGS__)
 
#define zassert_true(cond, msg, ...) zassert(cond, #cond " is false", \
                                             msg, ##__VA_ARGS__)
 
#define zassert_false(cond, msg, ...) zassert(!(cond), #cond " is true", \
                                              msg, ##__VA_ARGS__)
 
#define zassert_ok(cond, msg, ...) zassert(!(cond), #cond " is non-zero", \
                                              msg, ##__VA_ARGS__)
 
#define zassert_is_null(ptr, msg, ...) zassert((ptr) == NULL,       \
                                               #ptr " is not NULL", \
                                               msg, ##__VA_ARGS__)
 
#define zassert_not_null(ptr, msg, ...) zassert((ptr) != NULL,        \
                                                #ptr " is NULL", msg, \
                                                ##__VA_ARGS__)
 
#define zassert_equal(a, b, msg, ...) zassert((a) == (b),             \
                                              #a " not equal to " #b, \
                                              msg, ##__VA_ARGS__)
 
#define zassert_not_equal(a, b, msg, ...) zassert((a) != (b),         \
                                                  #a " equal to " #b, \
                                                  msg, ##__VA_ARGS__)
 
#define zassert_equal_ptr(a, b, msg, ...)                           \
        zassert((void *)(a) == (void *)(b), #a " not equal to " #b, \
                msg, ##__VA_ARGS__)
 
#define zassert_within(a, b, d, msg, ...)                            \
        zassert(((a) >= ((b) - (d))) && ((a) <= ((b) + (d))),        \
                #a " not within " #b " +/- " #d,                     \
                msg, ##__VA_ARGS__)
 
#define zassert_mem_equal(...) \
        zassert_mem_equal__(__VA_ARGS__)
 
#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 /* ZEPHYR_TESTSUITE_ZTEST_ASSERT_H_ */