ztest_test_deprecated.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 <zephyr/app_memory/app_memdomain.h>
#include <zephyr/init.h>
#include <stdbool.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;
};
 
struct ztest_suite_stats {
        uint32_t run_count;
        uint32_t skip_count;
        uint32_t fail_count;
};
 
struct ztest_suite_node {
        const char *name;
        struct unit_test *suite;
        bool (*predicate)(const void *state);
        struct ztest_suite_stats *stats;
};
 
extern struct ztest_suite_node _ztest_suite_node_list_start[];
extern struct ztest_suite_node _ztest_suite_node_list_end[];
 
#define ztest_register_test_suite(SUITE_NAME, PREDICATE, args...)                                  \
        ztest_test_suite(SUITE_NAME, ##args);                                                      \
        struct ztest_suite_stats UTIL_CAT(z_ztest_test_node_stats_, SUITE_NAME);                   \
        static STRUCT_SECTION_ITERABLE(ztest_suite_node, z_ztest_test_node_##SUITE_NAME) = {       \
                .name = #SUITE_NAME,                                                               \
                .suite = _##SUITE_NAME,                                                            \
                .predicate = PREDICATE,                                                            \
                .stats = &UTIL_CAT(z_ztest_test_node_stats_, SUITE_NAME),                          \
        };
 
int ztest_run_registered_test_suites(const void *state);
 
void ztest_verify_all_registered_test_suites_ran(void);
 
int 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)
 
#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)
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_TESTSUITE_ZTEST_TEST_H_ */