1 /* $OpenBSD: atf-c.h,v 1.2 2022/05/28 18:39:39 mbuhl Exp $ */ 2 /* 3 * Copyright (c) 2019-2021 Moritz Buhl <mbuhl@openbsd.org> 4 * 5 * Permission to use, copy, modify, and distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16 */ 17 18 #if !defined(ATF_C_H) 19 #define ATF_C_H 20 21 #include <pwd.h> 22 #include <stdbool.h> 23 #include <stdio.h> 24 #include <string.h> 25 #include <unistd.h> 26 27 int atf_test(int, int); 28 void atf_require(int, int, const char *, const char *, const int, char *, ...); 29 void atf_tc_fail(char *, ...) 30 __attribute__((__noreturn__, __format__ (printf, 1, 2))); 31 #define atf_tc_fail_check(file, line, fmt, ...) \ 32 atf_tc_fail(file ":%d " fmt, line, ##__VA_ARGS__) 33 #define atf_tc_get_config_var_as_bool_wd(a, b ,c) c 34 35 #define ATF_INSPECT_TEST 1 36 #define ATF_RUN_TEST 2 37 #define ATF_CLEANUP_TEST 3 38 39 #define ATF_TC_FUNCTIONS(fn) \ 40 void atf_head_##fn(void); \ 41 void atf_body_##fn(void); \ 42 void atf_cleanup_##fn(void); 43 44 #define ATF_TC(fn) \ 45 ATF_TC_FUNCTIONS(fn) \ 46 void atf_cleanup_##fn(void) { return; } 47 48 #define ATF_TC_WITH_CLEANUP(fn) \ 49 ATF_TC_FUNCTIONS(fn) 50 51 #define ATF_TC_WITHOUT_HEAD(fn) void atf_cleanup_##fn(void) {} \ 52 void atf_head_##fn(void) {} 53 #define ATF_TC_HEAD(fn, tc) void atf_head_##fn(void) 54 #define ATF_TC_BODY(fn, tc) void atf_body_##fn(void) 55 #define ATF_TC_CLEANUP(fn, tc) void atf_cleanup_##fn(void) 56 57 #define ATF_TP_ADD_TCS(tp) int atf_test(int tst, int what) 58 #define ATF_TP_ADD_TC(tp, fn) tst--; \ 59 if (tst == 0) { \ 60 if (what == ATF_INSPECT_TEST) \ 61 atf_head_##fn(); \ 62 else if (what == ATF_RUN_TEST) \ 63 atf_body_##fn(); \ 64 else if (what == ATF_CLEANUP_TEST) \ 65 atf_cleanup_##fn(); \ 66 return 0; \ 67 } 68 69 #define atf_no_error() (-tst) 70 71 #define ATF_INSPECT(i) atf_test(i, ATF_INSPECT_TEST) 72 #define ATF_RUN(i) atf_test(i, ATF_RUN_TEST) 73 #define ATF_CLEANUP(i) atf_test(i, ATF_CLEANUP_TEST) 74 75 #define atf_tc_set_md_var(tc, attr, fmt, ...) \ 76 if (strcmp(attr, "descr") == 0) \ 77 printf("DESCR=\"" fmt "\"\n", ##__VA_ARGS__); \ 78 else if (strcmp(attr, "require.user") == 0) \ 79 printf("REQ_USER=" fmt "\n", ##__VA_ARGS__); 80 81 #define ATF_CHECK ATF_REQUIRE 82 #define ATF_CHECK_MSG ATF_REQUIRE_MSG 83 #define ATF_CHECK_EQ ATF_REQUIRE_EQ 84 #define ATF_CHECK_ERRNO ATF_REQUIRE_ERRNO 85 #define ATF_CHECK_EQ_MSG ATF_REQUIRE_EQ_MSG 86 #define ATF_CHECK_STREQ ATF_REQUIRE_STREQ 87 88 #define atf_req(exp, err, msg, ...) \ 89 atf_require(exp, err, #exp, __FILE__, __LINE__, msg, ##__VA_ARGS__) 90 #define ATF_REQUIRE(exp) atf_req(exp, -1, NULL) 91 #define ATF_REQUIRE_ERRNO(no, exp) atf_req(exp, no, NULL) 92 #define ATF_REQUIRE_MSG(exp, fmt, ...) atf_req(exp, -1, fmt, ##__VA_ARGS__) 93 #define ATF_REQUIRE_EQ(a, b) atf_req((a) == (b), -1, NULL) 94 #define ATF_REQUIRE_EQ_MSG(a, b, fmt, ...) \ 95 atf_req((a) == (b), -1, fmt, ##__VA_ARGS__) 96 #define ATF_REQUIRE_STREQ(x, y) \ 97 ATF_REQUIRE_MSG(strcmp(x, y) == 0, "%s != %s (%s != %s)", #x, #y, x, y) 98 99 #define atf_tc_fail_nonfatal(fmt, ...) atf_tc_fail(fmt, ##__VA_ARGS__) 100 #define atf_tc_expect_fail(fmt, ...) \ 101 atf_tc_fail(fmt "\nEXPECTED_FAIL", ##__VA_ARGS__) 102 #define atf_tc_skip(fmt, ...) \ 103 atf_tc_fail(fmt "\nSKIPPING", ##__VA_ARGS__) 104 #define atf_tc_pass() exit(0) 105 106 #define atf_tc_get_config_var(a, b) "." 107 108 #define atf_utils_fork() fork() 109 110 #endif /* !defined(ATF_C_H) */ 111