xref: /minix3/external/bsd/bind/dist/unit/atf-src/atf-c/detail/test_helpers.c (revision 00b67f09dd46474d133c95011a48590a8e8f94c7)
1*00b67f09SDavid van Moolenbroek /*	$NetBSD: test_helpers.c,v 1.3 2014/12/10 04:38:03 christos Exp $	*/
2*00b67f09SDavid van Moolenbroek 
3*00b67f09SDavid van Moolenbroek /*
4*00b67f09SDavid van Moolenbroek  * Automated Testing Framework (atf)
5*00b67f09SDavid van Moolenbroek  *
6*00b67f09SDavid van Moolenbroek  * Copyright (c) 2008 The NetBSD Foundation, Inc.
7*00b67f09SDavid van Moolenbroek  * All rights reserved.
8*00b67f09SDavid van Moolenbroek  *
9*00b67f09SDavid van Moolenbroek  * Redistribution and use in source and binary forms, with or without
10*00b67f09SDavid van Moolenbroek  * modification, are permitted provided that the following conditions
11*00b67f09SDavid van Moolenbroek  * are met:
12*00b67f09SDavid van Moolenbroek  * 1. Redistributions of source code must retain the above copyright
13*00b67f09SDavid van Moolenbroek  *    notice, this list of conditions and the following disclaimer.
14*00b67f09SDavid van Moolenbroek  * 2. Redistributions in binary form must reproduce the above copyright
15*00b67f09SDavid van Moolenbroek  *    notice, this list of conditions and the following disclaimer in the
16*00b67f09SDavid van Moolenbroek  *    documentation and/or other materials provided with the distribution.
17*00b67f09SDavid van Moolenbroek  *
18*00b67f09SDavid van Moolenbroek  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
19*00b67f09SDavid van Moolenbroek  * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
20*00b67f09SDavid van Moolenbroek  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21*00b67f09SDavid van Moolenbroek  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22*00b67f09SDavid van Moolenbroek  * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
23*00b67f09SDavid van Moolenbroek  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24*00b67f09SDavid van Moolenbroek  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
25*00b67f09SDavid van Moolenbroek  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26*00b67f09SDavid van Moolenbroek  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
27*00b67f09SDavid van Moolenbroek  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28*00b67f09SDavid van Moolenbroek  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
29*00b67f09SDavid van Moolenbroek  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30*00b67f09SDavid van Moolenbroek  */
31*00b67f09SDavid van Moolenbroek 
32*00b67f09SDavid van Moolenbroek #include <fcntl.h>
33*00b67f09SDavid van Moolenbroek #include <stdio.h>
34*00b67f09SDavid van Moolenbroek #include <stdlib.h>
35*00b67f09SDavid van Moolenbroek #include <unistd.h>
36*00b67f09SDavid van Moolenbroek 
37*00b67f09SDavid van Moolenbroek #include "atf-c/build.h"
38*00b67f09SDavid van Moolenbroek #include "atf-c/check.h"
39*00b67f09SDavid van Moolenbroek #include "atf-c/config.h"
40*00b67f09SDavid van Moolenbroek #include "atf-c/error.h"
41*00b67f09SDavid van Moolenbroek #include "atf-c/macros.h"
42*00b67f09SDavid van Moolenbroek 
43*00b67f09SDavid van Moolenbroek #include "dynstr.h"
44*00b67f09SDavid van Moolenbroek #include "fs.h"
45*00b67f09SDavid van Moolenbroek #include "process.h"
46*00b67f09SDavid van Moolenbroek #include "test_helpers.h"
47*00b67f09SDavid van Moolenbroek 
48*00b67f09SDavid van Moolenbroek static
49*00b67f09SDavid van Moolenbroek void
build_check_c_o_aux(const char * path,const char * failmsg,const bool expect_pass)50*00b67f09SDavid van Moolenbroek build_check_c_o_aux(const char *path, const char *failmsg,
51*00b67f09SDavid van Moolenbroek                     const bool expect_pass)
52*00b67f09SDavid van Moolenbroek {
53*00b67f09SDavid van Moolenbroek     bool success;
54*00b67f09SDavid van Moolenbroek     atf_dynstr_t iflag;
55*00b67f09SDavid van Moolenbroek     const char *optargs[4];
56*00b67f09SDavid van Moolenbroek 
57*00b67f09SDavid van Moolenbroek     RE(atf_dynstr_init_fmt(&iflag, "-I%s", atf_config_get("atf_includedir")));
58*00b67f09SDavid van Moolenbroek 
59*00b67f09SDavid van Moolenbroek     optargs[0] = atf_dynstr_cstring(&iflag);
60*00b67f09SDavid van Moolenbroek     optargs[1] = "-Wall";
61*00b67f09SDavid van Moolenbroek     optargs[2] = "-Werror";
62*00b67f09SDavid van Moolenbroek     optargs[3] = NULL;
63*00b67f09SDavid van Moolenbroek 
64*00b67f09SDavid van Moolenbroek     RE(atf_check_build_c_o(path, "test.o", optargs, &success));
65*00b67f09SDavid van Moolenbroek 
66*00b67f09SDavid van Moolenbroek     atf_dynstr_fini(&iflag);
67*00b67f09SDavid van Moolenbroek 
68*00b67f09SDavid van Moolenbroek     if ((expect_pass && !success) || (!expect_pass && success))
69*00b67f09SDavid van Moolenbroek         atf_tc_fail("%s", failmsg);
70*00b67f09SDavid van Moolenbroek }
71*00b67f09SDavid van Moolenbroek 
72*00b67f09SDavid van Moolenbroek void
build_check_c_o(const atf_tc_t * tc,const char * sfile,const char * failmsg,const bool expect_pass)73*00b67f09SDavid van Moolenbroek build_check_c_o(const atf_tc_t *tc, const char *sfile, const char *failmsg,
74*00b67f09SDavid van Moolenbroek                 const bool expect_pass)
75*00b67f09SDavid van Moolenbroek {
76*00b67f09SDavid van Moolenbroek     atf_fs_path_t path;
77*00b67f09SDavid van Moolenbroek 
78*00b67f09SDavid van Moolenbroek     RE(atf_fs_path_init_fmt(&path, "%s/%s",
79*00b67f09SDavid van Moolenbroek                             atf_tc_get_config_var(tc, "srcdir"), sfile));
80*00b67f09SDavid van Moolenbroek     build_check_c_o_aux(atf_fs_path_cstring(&path), failmsg, expect_pass);
81*00b67f09SDavid van Moolenbroek     atf_fs_path_fini(&path);
82*00b67f09SDavid van Moolenbroek }
83*00b67f09SDavid van Moolenbroek 
84*00b67f09SDavid van Moolenbroek void
header_check(const char * hdrname)85*00b67f09SDavid van Moolenbroek header_check(const char *hdrname)
86*00b67f09SDavid van Moolenbroek {
87*00b67f09SDavid van Moolenbroek     FILE *srcfile;
88*00b67f09SDavid van Moolenbroek     char failmsg[128];
89*00b67f09SDavid van Moolenbroek 
90*00b67f09SDavid van Moolenbroek     srcfile = fopen("test.c", "w");
91*00b67f09SDavid van Moolenbroek     ATF_REQUIRE(srcfile != NULL);
92*00b67f09SDavid van Moolenbroek     fprintf(srcfile, "#include <%s>\n", hdrname);
93*00b67f09SDavid van Moolenbroek     fclose(srcfile);
94*00b67f09SDavid van Moolenbroek 
95*00b67f09SDavid van Moolenbroek     snprintf(failmsg, sizeof(failmsg),
96*00b67f09SDavid van Moolenbroek              "Header check failed; %s is not self-contained", hdrname);
97*00b67f09SDavid van Moolenbroek 
98*00b67f09SDavid van Moolenbroek     build_check_c_o_aux("test.c", failmsg, true);
99*00b67f09SDavid van Moolenbroek }
100*00b67f09SDavid van Moolenbroek 
101*00b67f09SDavid van Moolenbroek void
get_process_helpers_path(const atf_tc_t * tc,const bool is_detail,atf_fs_path_t * path)102*00b67f09SDavid van Moolenbroek get_process_helpers_path(const atf_tc_t *tc, const bool is_detail,
103*00b67f09SDavid van Moolenbroek                          atf_fs_path_t *path)
104*00b67f09SDavid van Moolenbroek {
105*00b67f09SDavid van Moolenbroek     RE(atf_fs_path_init_fmt(path, "%s/%sprocess_helpers",
106*00b67f09SDavid van Moolenbroek                             atf_tc_get_config_var(tc, "srcdir"),
107*00b67f09SDavid van Moolenbroek                             is_detail ? "" : "detail/"));
108*00b67f09SDavid van Moolenbroek }
109*00b67f09SDavid van Moolenbroek 
110*00b67f09SDavid van Moolenbroek struct run_h_tc_data {
111*00b67f09SDavid van Moolenbroek     atf_tc_t *m_tc;
112*00b67f09SDavid van Moolenbroek     const char *m_resname;
113*00b67f09SDavid van Moolenbroek };
114*00b67f09SDavid van Moolenbroek 
115*00b67f09SDavid van Moolenbroek static
116*00b67f09SDavid van Moolenbroek void
run_h_tc_child(void * v)117*00b67f09SDavid van Moolenbroek run_h_tc_child(void *v)
118*00b67f09SDavid van Moolenbroek {
119*00b67f09SDavid van Moolenbroek     struct run_h_tc_data *data = (struct run_h_tc_data *)v;
120*00b67f09SDavid van Moolenbroek 
121*00b67f09SDavid van Moolenbroek     RE(atf_tc_run(data->m_tc, data->m_resname));
122*00b67f09SDavid van Moolenbroek }
123*00b67f09SDavid van Moolenbroek 
124*00b67f09SDavid van Moolenbroek /* TODO: Investigate if it's worth to add this functionality as part of
125*00b67f09SDavid van Moolenbroek  * the public API.  I.e. a function to easily run a test case body in a
126*00b67f09SDavid van Moolenbroek  * subprocess. */
127*00b67f09SDavid van Moolenbroek void
run_h_tc(atf_tc_t * tc,const char * outname,const char * errname,const char * resname)128*00b67f09SDavid van Moolenbroek run_h_tc(atf_tc_t *tc, const char *outname, const char *errname,
129*00b67f09SDavid van Moolenbroek          const char *resname)
130*00b67f09SDavid van Moolenbroek {
131*00b67f09SDavid van Moolenbroek     atf_fs_path_t outpath, errpath;
132*00b67f09SDavid van Moolenbroek     atf_process_stream_t outb, errb;
133*00b67f09SDavid van Moolenbroek     atf_process_child_t child;
134*00b67f09SDavid van Moolenbroek     atf_process_status_t status;
135*00b67f09SDavid van Moolenbroek 
136*00b67f09SDavid van Moolenbroek     RE(atf_fs_path_init_fmt(&outpath, outname));
137*00b67f09SDavid van Moolenbroek     RE(atf_fs_path_init_fmt(&errpath, errname));
138*00b67f09SDavid van Moolenbroek 
139*00b67f09SDavid van Moolenbroek     struct run_h_tc_data data = { tc, resname };
140*00b67f09SDavid van Moolenbroek 
141*00b67f09SDavid van Moolenbroek     RE(atf_process_stream_init_redirect_path(&outb, &outpath));
142*00b67f09SDavid van Moolenbroek     RE(atf_process_stream_init_redirect_path(&errb, &errpath));
143*00b67f09SDavid van Moolenbroek     RE(atf_process_fork(&child, run_h_tc_child, &outb, &errb, &data));
144*00b67f09SDavid van Moolenbroek     atf_process_stream_fini(&errb);
145*00b67f09SDavid van Moolenbroek     atf_process_stream_fini(&outb);
146*00b67f09SDavid van Moolenbroek 
147*00b67f09SDavid van Moolenbroek     RE(atf_process_child_wait(&child, &status));
148*00b67f09SDavid van Moolenbroek     ATF_CHECK(atf_process_status_exited(&status));
149*00b67f09SDavid van Moolenbroek     atf_process_status_fini(&status);
150*00b67f09SDavid van Moolenbroek 
151*00b67f09SDavid van Moolenbroek     atf_fs_path_fini(&errpath);
152*00b67f09SDavid van Moolenbroek     atf_fs_path_fini(&outpath);
153*00b67f09SDavid van Moolenbroek }
154