1 /* Copyright (c) 2008 The NetBSD Foundation, Inc.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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. */
26 #include "atf-c/check.h"
37 #include "atf-c/build.h"
38 #include "atf-c/defs.h"
39 #include "atf-c/detail/dynstr.h"
40 #include "atf-c/detail/env.h"
41 #include "atf-c/detail/fs.h"
42 #include "atf-c/detail/list.h"
43 #include "atf-c/detail/process.h"
44 #include "atf-c/detail/sanity.h"
45 #include "atf-c/error.h"
46 #include "atf-c/utils.h"
48 /* ---------------------------------------------------------------------
49 * Auxiliary functions.
50 * --------------------------------------------------------------------- */
54 create_tmpdir(atf_fs_path_t *dir)
58 err = atf_fs_path_init_fmt(dir, "%s/check.XXXXXX",
59 atf_env_get_with_default("TMPDIR", "/tmp"));
60 if (atf_is_error(err))
63 err = atf_fs_mkdtemp(dir);
64 if (atf_is_error(err)) {
65 atf_fs_path_fini(dir);
69 INV(!atf_is_error(err));
76 cleanup_tmpdir(const atf_fs_path_t *dir, const atf_fs_path_t *outfile,
77 const atf_fs_path_t *errfile)
80 atf_error_t err = atf_fs_unlink(outfile);
81 if (atf_is_error(err)) {
82 INV(atf_error_is(err, "libc") &&
83 atf_libc_error_code(err) == ENOENT);
86 INV(!atf_is_error(err));
90 atf_error_t err = atf_fs_unlink(errfile);
91 if (atf_is_error(err)) {
92 INV(atf_error_is(err, "libc") &&
93 atf_libc_error_code(err) == ENOENT);
96 INV(!atf_is_error(err));
100 atf_error_t err = atf_fs_rmdir(dir);
101 INV(!atf_is_error(err));
107 const_execvp(const char *file, const char *const *argv)
109 #define UNCONST(a) ((void *)(unsigned long)(const void *)(a))
110 return execvp(file, UNCONST(argv));
116 init_sb(const atf_fs_path_t *path, atf_process_stream_t *sb)
121 err = atf_process_stream_init_inherit(sb);
123 err = atf_process_stream_init_redirect_path(sb, path);
130 init_sbs(const atf_fs_path_t *outfile, atf_process_stream_t *outsb,
131 const atf_fs_path_t *errfile, atf_process_stream_t *errsb)
135 err = init_sb(outfile, outsb);
136 if (atf_is_error(err))
139 err = init_sb(errfile, errsb);
140 if (atf_is_error(err)) {
141 atf_process_stream_fini(outsb);
150 const char *const *m_argv;
153 static void exec_child(void *) ATF_DEFS_ATTRIBUTE_NORETURN;
159 struct exec_data *ea = v;
161 const_execvp(ea->m_argv[0], ea->m_argv);
162 fprintf(stderr, "execvp(%s) failed: %s\n", ea->m_argv[0], strerror(errno));
168 fork_and_wait(const char *const *argv, const atf_fs_path_t *outfile,
169 const atf_fs_path_t *errfile, atf_process_status_t *status)
172 atf_process_child_t child;
173 atf_process_stream_t outsb, errsb;
174 struct exec_data ea = { argv };
176 err = init_sbs(outfile, &outsb, errfile, &errsb);
177 if (atf_is_error(err))
180 err = atf_process_fork(&child, exec_child, &outsb, &errsb, &ea);
181 if (atf_is_error(err))
184 err = atf_process_child_wait(&child, status);
187 atf_process_stream_fini(&errsb);
188 atf_process_stream_fini(&outsb);
195 update_success_from_status(const char *progname,
196 const atf_process_status_t *status, bool *success)
198 bool s = atf_process_status_exited(status) &&
199 atf_process_status_exitstatus(status) == EXIT_SUCCESS;
201 if (atf_process_status_exited(status)) {
202 if (atf_process_status_exitstatus(status) == EXIT_SUCCESS)
206 fprintf(stderr, "%s failed with exit code %d\n", progname,
207 atf_process_status_exitstatus(status));
209 } else if (atf_process_status_signaled(status)) {
211 fprintf(stderr, "%s failed due to signal %d%s\n", progname,
212 atf_process_status_termsig(status),
213 atf_process_status_coredump(status) ? " (core dumped)" : "");
216 fprintf(stderr, "%s failed due to unknown reason\n", progname);
224 array_to_list(const char *const *a, atf_list_t *l)
228 err = atf_list_init(l);
229 if (atf_is_error(err))
233 char *item = strdup(*a);
235 err = atf_no_memory_error();
239 err = atf_list_append(l, item, true);
240 if (atf_is_error(err))
251 print_array(const char *const *array, const char *pfx)
253 const char *const *ptr;
256 for (ptr = array; *ptr != NULL; ptr++)
263 check_build_run(const char *const *argv, bool *success)
266 atf_process_status_t status;
268 print_array(argv, ">");
270 err = fork_and_wait(argv, NULL, NULL, &status);
271 if (atf_is_error(err))
274 update_success_from_status(argv[0], &status, success);
275 atf_process_status_fini(&status);
277 INV(!atf_is_error(err));
282 /* ---------------------------------------------------------------------
283 * The "atf_check_result" type.
284 * --------------------------------------------------------------------- */
286 struct atf_check_result_impl {
289 atf_fs_path_t m_stdout;
290 atf_fs_path_t m_stderr;
291 atf_process_status_t m_status;
296 atf_check_result_init(atf_check_result_t *r, const char *const *argv,
297 const atf_fs_path_t *dir)
301 r->pimpl = malloc(sizeof(struct atf_check_result_impl));
302 if (r->pimpl == NULL)
303 return atf_no_memory_error();
305 err = array_to_list(argv, &r->pimpl->m_argv);
306 if (atf_is_error(err))
309 err = atf_fs_path_copy(&r->pimpl->m_dir, dir);
310 if (atf_is_error(err))
313 err = atf_fs_path_init_fmt(&r->pimpl->m_stdout, "%s/stdout",
314 atf_fs_path_cstring(dir));
315 if (atf_is_error(err))
318 err = atf_fs_path_init_fmt(&r->pimpl->m_stderr, "%s/stderr",
319 atf_fs_path_cstring(dir));
320 if (atf_is_error(err))
323 INV(!atf_is_error(err));
327 atf_fs_path_fini(&r->pimpl->m_stdout);
329 atf_fs_path_fini(&r->pimpl->m_dir);
331 atf_list_fini(&r->pimpl->m_argv);
337 atf_check_result_fini(atf_check_result_t *r)
339 atf_process_status_fini(&r->pimpl->m_status);
341 cleanup_tmpdir(&r->pimpl->m_dir, &r->pimpl->m_stdout,
342 &r->pimpl->m_stderr);
343 atf_fs_path_fini(&r->pimpl->m_stdout);
344 atf_fs_path_fini(&r->pimpl->m_stderr);
345 atf_fs_path_fini(&r->pimpl->m_dir);
347 atf_list_fini(&r->pimpl->m_argv);
353 atf_check_result_stdout(const atf_check_result_t *r)
355 return atf_fs_path_cstring(&r->pimpl->m_stdout);
359 atf_check_result_stderr(const atf_check_result_t *r)
361 return atf_fs_path_cstring(&r->pimpl->m_stderr);
365 atf_check_result_exited(const atf_check_result_t *r)
367 return atf_process_status_exited(&r->pimpl->m_status);
371 atf_check_result_exitcode(const atf_check_result_t *r)
373 return atf_process_status_exitstatus(&r->pimpl->m_status);
377 atf_check_result_signaled(const atf_check_result_t *r)
379 return atf_process_status_signaled(&r->pimpl->m_status);
383 atf_check_result_termsig(const atf_check_result_t *r)
385 return atf_process_status_termsig(&r->pimpl->m_status);
388 /* ---------------------------------------------------------------------
390 * --------------------------------------------------------------------- */
392 /* XXX: This function shouldn't be in this module. It messes with stdout
393 * and stderr, and it provides a very high-end interface. This belongs,
394 * probably, somewhere related to test cases (such as in the tc module). */
396 atf_check_build_c_o(const char *sfile,
398 const char *const optargs[],
404 err = atf_build_c_o(sfile, ofile, optargs, &argv);
405 if (atf_is_error(err))
408 err = check_build_run((const char *const *)argv, success);
410 atf_utils_free_charpp(argv);
416 atf_check_build_cpp(const char *sfile,
418 const char *const optargs[],
424 err = atf_build_cpp(sfile, ofile, optargs, &argv);
425 if (atf_is_error(err))
428 err = check_build_run((const char *const *)argv, success);
430 atf_utils_free_charpp(argv);
436 atf_check_build_cxx_o(const char *sfile,
438 const char *const optargs[],
444 err = atf_build_cxx_o(sfile, ofile, optargs, &argv);
445 if (atf_is_error(err))
448 err = check_build_run((const char *const *)argv, success);
450 atf_utils_free_charpp(argv);
456 atf_check_exec_array(const char *const *argv, atf_check_result_t *r)
461 err = create_tmpdir(&dir);
462 if (atf_is_error(err))
465 err = atf_check_result_init(r, argv, &dir);
466 if (atf_is_error(err)) {
467 atf_error_t err2 = atf_fs_rmdir(&dir);
468 INV(!atf_is_error(err2));
472 err = fork_and_wait(argv, &r->pimpl->m_stdout, &r->pimpl->m_stderr,
473 &r->pimpl->m_status);
474 if (atf_is_error(err)) {
475 atf_check_result_fini(r);
479 INV(!atf_is_error(err));
481 atf_fs_path_fini(&dir);