xref: /freebsd/contrib/atf/atf-c/detail/test_helpers.h (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1 /* Copyright (c) 2008 The NetBSD Foundation, Inc.
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
14  * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
15  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
16  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
20  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
22  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
24  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  */
25 
26 #if defined(ATF_C_DETAIL_TEST_HELPERS_H)
27 #   error "Cannot include test_helpers.h more than once."
28 #else
29 #   define ATF_C_DETAIL_TEST_HELPERS_H
30 #endif
31 
32 #include <stdbool.h>
33 
34 #include <atf-c.h>
35 
36 #include <atf-c/error_fwd.h>
37 #include <atf-c/tc.h>
38 
39 struct atf_dynstr;
40 struct atf_fs_path;
41 
42 #define CE(stm) ATF_CHECK(!atf_is_error(stm))
43 #define RE(stm) ATF_REQUIRE(!atf_is_error(stm))
44 
45 #define HEADER_TC(name, hdrname) \
46     ATF_TC(name); \
47     ATF_TC_HEAD(name, tc) \
48     { \
49         atf_tc_set_md_var(tc, "descr", "Tests that the " hdrname " file can " \
50             "be included on its own, without any prerequisites"); \
51     } \
52     ATF_TC_BODY(name, tc) \
53     { \
54         header_check(hdrname); \
55     }
56 
57 #define BUILD_TC(name, sfile, descr, failmsg) \
58     ATF_TC(name); \
59     ATF_TC_HEAD(name, tc) \
60     { \
61         atf_tc_set_md_var(tc, "descr", descr); \
62     } \
63     ATF_TC_BODY(name, tc) \
64     { \
65         if (!build_check_c_o_srcdir(tc, sfile)) \
66             atf_tc_fail("%s", failmsg); \
67     }
68 
69 bool build_check_c_o(const char *);
70 bool build_check_c_o_srcdir(const atf_tc_t *, const char *);
71 void header_check(const char *);
72 void get_process_helpers_path(const atf_tc_t *, const bool,
73                               struct atf_fs_path *);
74 bool read_line(int, struct atf_dynstr *);
75 void run_h_tc(atf_tc_t *, const char *, const char *, const char *);
76