ztest_test.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_TESTSUITE_ZTEST_TEST_H_
#define ZEPHYR_TESTSUITE_ZTEST_TEST_H_
 
#include <app_memory/app_memdomain.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct unit_test {
        const char *name;
        void (*test)(void);
        void (*setup)(void);
        void (*teardown)(void);
        uint32_t thread_options;
};
 
void z_ztest_run_test_suite(const char *name, struct unit_test *suite);
 
void ztest_test_fail(void);
 
void ztest_test_pass(void);
 
void ztest_test_skip(void);
 
static inline void unit_test_noop(void)
{
}
 
#define ztest_unit_test_setup_teardown(fn, setup, teardown) { \
                STRINGIFY(fn), fn, setup, teardown, 0 \
}
 
#define ztest_user_unit_test_setup_teardown(fn, setup, teardown) { \
                STRINGIFY(fn), fn, setup, teardown, K_USER \
}
 
#define ztest_unit_test(fn) \
        ztest_unit_test_setup_teardown(fn, unit_test_noop, unit_test_noop)
 
#define ztest_user_unit_test(fn) \
        ztest_user_unit_test_setup_teardown(fn, unit_test_noop, unit_test_noop)
 
__syscall void z_test_1cpu_start(void);
__syscall void z_test_1cpu_stop(void);
 
#ifdef CONFIG_SMP
#define ztest_1cpu_unit_test(fn)                                        \
        ztest_unit_test_setup_teardown(fn, z_test_1cpu_start, z_test_1cpu_stop)
#else
#define ztest_1cpu_unit_test(fn) ztest_unit_test(fn)
#endif
 
#ifdef CONFIG_SMP
#define ztest_1cpu_user_unit_test(fn) \
        ztest_user_unit_test_setup_teardown(fn, z_test_1cpu_start, z_test_1cpu_stop)
#else
#define ztest_1cpu_user_unit_test(fn) ztest_user_unit_test(fn)
#endif
 
/* definitions for use with testing application shared memory   */
#ifdef CONFIG_USERSPACE
#define ZTEST_DMEM      K_APP_DMEM(ztest_mem_partition)
#define ZTEST_BMEM      K_APP_BMEM(ztest_mem_partition)
#define ZTEST_SECTION   K_APP_DMEM_SECTION(ztest_mem_partition)
extern struct k_mem_partition ztest_mem_partition;
#else
#define ZTEST_DMEM
#define ZTEST_BMEM
#define ZTEST_SECTION   .data
#endif
 
#define ztest_test_suite(suite, ...) \
        static ZTEST_DMEM struct unit_test _##suite[] = { \
                __VA_ARGS__, { 0 } \
        }
#define ztest_run_test_suite(suite) \
        z_ztest_run_test_suite(#suite, _##suite)
 
#ifndef ZTEST_UNITTEST
#include <syscalls/ztest_test.h>
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_TESTSUITE_ZTEST_TEST_H_ */