ztest_mock.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_TESTSUITE_ZTEST_MOCK_H_
#define ZEPHYR_TESTSUITE_ZTEST_MOCK_H_
 
#define ztest_expect_value(func, param, value)                                 \
        z_ztest_expect_value(STRINGIFY(func), STRINGIFY(param),                \
                             (uintptr_t)(value))
 
#define ztest_check_expected_value(param)                                      \
        z_ztest_check_expected_value(__func__, STRINGIFY(param),               \
                                     (uintptr_t)(param))
 
#define ztest_expect_data(func, param, data)                                   \
        z_ztest_expect_data(STRINGIFY(func), STRINGIFY(param), (void *)(data))
 
#define ztest_check_expected_data(param, length)                               \
        z_ztest_check_expected_data(__func__, STRINGIFY(param),                \
                                    (void *)(param), (length))
 
#define ztest_return_data(func, param, data)                                   \
        z_ztest_return_data(STRINGIFY(func), STRINGIFY(param), (void *)(data))
 
#define ztest_copy_return_data(param, length)                                  \
        z_ztest_copy_return_data(__func__, STRINGIFY(param),                   \
                                 (void *)(param), (length))
#define ztest_returns_value(func, value)                                       \
        z_ztest_returns_value(STRINGIFY(func), (uintptr_t)(value))
 
#define ztest_get_return_value() z_ztest_get_return_value(__func__)
 
#define ztest_get_return_value_ptr()                                           \
        ((void *)z_ztest_get_return_value(__func__))
 
#ifdef CONFIG_ZTEST_MOCKING
 
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
void z_init_mock(void);
int z_cleanup_mock(void);
 
void z_ztest_expect_value(const char *fn, const char *name, uintptr_t value);
void z_ztest_check_expected_value(const char *fn, const char *param,
                                  uintptr_t value);
 
void z_ztest_expect_data(const char *fn, const char *name, void *val);
void z_ztest_check_expected_data(const char *fn, const char *name, void *data,
                                 uint32_t length);
 
void z_ztest_return_data(const char *fn, const char *name, void *val);
void z_ztest_copy_return_data(const char *fn, const char *name, void *data,
                              uint32_t length);
 
void z_ztest_returns_value(const char *fn, uintptr_t value);
uintptr_t z_ztest_get_return_value(const char *fn);
 
#ifdef __cplusplus
}
#endif
 
#else /* !CONFIG_ZTEST_MOCKING */
 
#define z_init_mock()
#define z_cleanup_mock() 0
 
#endif /* CONFIG_ZTEST_MOCKING */
 
#endif /* ZEPHYR_TESTSUITE_ZTEST_MOCK_H_ */