/* tc_utilities.h - testcase utilities header file */ /* * Copyright (c) 2012-2015 Wind River Systems, Inc. * * SPDX-License-Identifier: Apache-2.0 */ #ifndef ZEPHYR_TESTSUITE_INCLUDE_TC_UTIL_H_ #define ZEPHYR_TESTSUITE_INCLUDE_TC_UTIL_H_ #include #include #ifdef CONFIG_SHELL #include #endif #include #if defined CONFIG_ZTEST_TC_UTIL_USER_OVERRIDE #include #endif #ifndef PRINT_DATA #define PRINT_DATA(fmt, ...) printk(fmt, ##__VA_ARGS__) #endif #if defined CONFIG_ARCH_POSIX #include "posix_board_if.h" #endif /** * @def TC_PRINT_RUNID * @brief Report a Run ID * * When the CPP symbol \c TC_RUNID is defined (for example, from the * compile environment), print the defined string ``RunID: * `` when called (TC_END_REPORT() will also call it). * * This is used mainly when automating the execution and running of * multiple test cases, to verify that the expected image is being * executed (as sometimes the targets fail to flash or reset * properly). * * TC_RUNID is any string, that will be converted to a string literal. */ #define TC_STR_HELPER(x) #x #define TC_STR(x) TC_STR_HELPER(x) #ifdef TC_RUNID #define TC_PRINT_RUNID PRINT_DATA("RunID: " TC_STR(TC_RUNID) "\n") #else #define TC_PRINT_RUNID do {} while (false) #endif #ifndef PRINT_LINE #define PRINT_LINE \ PRINT_DATA( \ "============================================================" \ "=======\n") #endif /* stack size and priority for test suite task */ #define TASK_STACK_SIZE (1024 * 2) #define FMT_ERROR "%s - %s@%d. " #define TC_PASS 0 #define TC_FAIL 1 #define TC_SKIP 2 #define TC_FLAKY 3 #ifndef TC_PASS_STR #define TC_PASS_STR "PASS" #endif #ifndef TC_FAIL_STR #define TC_FAIL_STR "FAIL" #endif #ifndef TC_SKIP_STR #define TC_SKIP_STR "SKIP" #endif #ifndef TC_FLAKY_STR #define TC_FLAKY_STR "FLAKY" #endif static inline const char *TC_RESULT_TO_STR(int result) { switch (result) { case TC_PASS: return TC_PASS_STR; case TC_FAIL: return TC_FAIL_STR; case TC_SKIP: return TC_SKIP_STR; case TC_FLAKY: return TC_FLAKY_STR; default: return "?"; } } static uint32_t tc_start_time; static uint32_t tc_spend_time; static inline void get_start_time_cyc(void) { tc_start_time = k_cycle_get_32(); } static inline void get_test_duration_ms(void) { uint32_t spend_cycle = k_cycle_get_32() - tc_start_time; tc_spend_time = k_cyc_to_ms_ceil32(spend_cycle); } #ifndef TC_ERROR #define TC_ERROR(fmt, ...) \ do { \ PRINT_DATA(FMT_ERROR, "FAIL", __func__, __LINE__); \ PRINT_DATA(fmt, ##__VA_ARGS__); \ } while (false) #endif static inline void print_nothing(const char *fmt, ...) { ARG_UNUSED(fmt); } #ifndef TC_PRINT #if defined(CONFIG_ZTEST_VERBOSE_OUTPUT) #define TC_PRINT(fmt, ...) PRINT_DATA(fmt, ##__VA_ARGS__) #else #define TC_PRINT(fmt, ...) print_nothing(fmt, ##__VA_ARGS__) #endif /* CONFIG_ZTEST_VERBOSE_OUTPUT */ #endif /* TC_PRINT */ #ifndef TC_SUMMARY_PRINT #define TC_SUMMARY_PRINT(fmt, ...) PRINT_DATA(fmt, ##__VA_ARGS__) #endif #ifndef TC_START_PRINT #if defined(CONFIG_ZTEST_VERBOSE_OUTPUT) #define TC_START_PRINT(name) PRINT_DATA("START - %s\n", name); #else #define TC_START_PRINT(name) print_nothing(name) #endif /* CONFIG_ZTEST_VERBOSE_OUTPUT */ #endif /* TC_START_PRINT */ #ifndef TC_START #define TC_START(name) \ do { \ TC_START_PRINT(name); \ } while (0) #endif #ifndef TC_END #define TC_END(result, fmt, ...) PRINT_DATA(fmt, ##__VA_ARGS__) #endif #ifndef TC_END_PRINT #if defined(CONFIG_ZTEST_VERBOSE_OUTPUT) #define TC_END_PRINT(result, fmt, ...) PRINT_DATA(fmt, ##__VA_ARGS__); PRINT_LINE #else #define TC_END_PRINT(result, fmt, ...) print_nothing(fmt) #endif /* CONFIG_ZTEST_VERBOSE_OUTPUT */ #endif /* TC_END_PRINT */ /* prints result and the function name */ #ifndef Z_TC_END_RESULT #define Z_TC_END_RESULT(result, func) \ do { \ TC_END_PRINT(result, " %s - %s in %u.%03u seconds\n", \ TC_RESULT_TO_STR(result), func, tc_spend_time/1000, \ tc_spend_time%1000); \ } while (0) #endif #ifndef TC_END_RESULT #define TC_END_RESULT(result) \ Z_TC_END_RESULT((result), __func__) #endif #ifndef TC_END_RESULT_CUSTOM #define TC_END_RESULT_CUSTOM(result, func) \ Z_TC_END_RESULT((result), func) #endif #ifndef TC_SUITE_PRINT #define TC_SUITE_PRINT(fmt, ...) PRINT_DATA(fmt, ##__VA_ARGS__) #endif #ifndef TC_SUITE_START #define TC_SUITE_START(name) \ do { \ TC_SUITE_PRINT("Running TESTSUITE %s\n", name); \ PRINT_LINE; \ } while (false) #endif #ifndef TC_SUITE_END #define TC_SUITE_END(name, result) \ do { \ if (result != TC_FAIL) { \ TC_SUITE_PRINT("TESTSUITE %s succeeded\n", name); \ } else { \ TC_SUITE_PRINT("TESTSUITE %s failed.\n", name); \ } \ } while (false) #endif #if defined(CONFIG_ARCH_POSIX) #include #define TC_END_POST(result) do { \ LOG_PANIC(); \ posix_exit(result); \ } while (0) #else #define TC_END_POST(result) #endif /* CONFIG_ARCH_POSIX */ #ifndef TC_END_REPORT #define TC_END_REPORT(result) \ do { \ PRINT_LINE; \ TC_PRINT_RUNID; \ TC_END(result, \ "PROJECT EXECUTION %s\n", \ (result) == TC_PASS ? "SUCCESSFUL" : "FAILED"); \ TC_END_POST(result); \ } while (false) #endif #if defined(CONFIG_SHELL) #define TC_CMD_DEFINE(name) \ static int cmd_##name(const struct shell *sh, size_t argc, \ char **argv) \ { \ TC_START(__func__); \ name(); \ TC_END_RESULT(TC_PASS); \ return 0; \ } #define TC_CMD_ITEM(name) cmd_##name #else #define TC_CMD_DEFINE(name) \ int cmd_##name(int argc, char *argv[]) \ { \ TC_START(__func__); \ name(); \ TC_END_RESULT(TC_PASS); \ return 0; \ } #define TC_CMD_ITEM(name) {STRINGIFY(name), cmd_##name, "none"} #endif #endif /* ZEPHYR_TESTSUITE_INCLUDE_TC_UTIL_H_ */