2 * Automated Testing Framework (atf)
4 * Copyright (c) 2008 The NetBSD Foundation, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
17 * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 #include "atf-c/build.h"
40 #include "atf-c/check.h"
41 #include "atf-c/config.h"
42 #include "atf-c/defs.h"
43 #include "atf-c/error.h"
44 #include "atf-c/utils.h"
46 #include "detail/dynstr.h"
47 #include "detail/fs.h"
48 #include "detail/list.h"
49 #include "detail/process.h"
50 #include "detail/sanity.h"
52 /* ---------------------------------------------------------------------
53 * Auxiliary functions.
54 * --------------------------------------------------------------------- */
58 create_tmpdir(atf_fs_path_t *dir)
62 err = atf_fs_path_init_fmt(dir, "%s/check.XXXXXX",
63 atf_config_get("atf_workdir"));
64 if (atf_is_error(err))
67 err = atf_fs_mkdtemp(dir);
68 if (atf_is_error(err)) {
69 atf_fs_path_fini(dir);
73 INV(!atf_is_error(err));
80 cleanup_tmpdir(const atf_fs_path_t *dir, const atf_fs_path_t *outfile,
81 const atf_fs_path_t *errfile)
84 atf_error_t err = atf_fs_unlink(outfile);
85 if (atf_is_error(err)) {
86 INV(atf_error_is(err, "libc") &&
87 atf_libc_error_code(err) == ENOENT);
90 INV(!atf_is_error(err));
94 atf_error_t err = atf_fs_unlink(errfile);
95 if (atf_is_error(err)) {
96 INV(atf_error_is(err, "libc") &&
97 atf_libc_error_code(err) == ENOENT);
100 INV(!atf_is_error(err));
104 atf_error_t err = atf_fs_rmdir(dir);
105 INV(!atf_is_error(err));
111 const_execvp(const char *file, const char *const *argv)
113 #define UNCONST(a) ((void *)(unsigned long)(const void *)(a))
114 return execvp(file, UNCONST(argv));
120 init_sb(const atf_fs_path_t *path, atf_process_stream_t *sb)
125 err = atf_process_stream_init_inherit(sb);
127 err = atf_process_stream_init_redirect_path(sb, path);
134 init_sbs(const atf_fs_path_t *outfile, atf_process_stream_t *outsb,
135 const atf_fs_path_t *errfile, atf_process_stream_t *errsb)
139 err = init_sb(outfile, outsb);
140 if (atf_is_error(err))
143 err = init_sb(errfile, errsb);
144 if (atf_is_error(err)) {
145 atf_process_stream_fini(outsb);
154 const char *const *m_argv;
157 static void exec_child(void *) ATF_DEFS_ATTRIBUTE_NORETURN;
163 struct exec_data *ea = v;
165 const_execvp(ea->m_argv[0], ea->m_argv);
166 fprintf(stderr, "execvp(%s) failed: %s\n", ea->m_argv[0], strerror(errno));
172 fork_and_wait(const char *const *argv, const atf_fs_path_t *outfile,
173 const atf_fs_path_t *errfile, atf_process_status_t *status)
176 atf_process_child_t child;
177 atf_process_stream_t outsb, errsb;
178 struct exec_data ea = { argv };
180 err = init_sbs(outfile, &outsb, errfile, &errsb);
181 if (atf_is_error(err))
184 err = atf_process_fork(&child, exec_child, &outsb, &errsb, &ea);
185 if (atf_is_error(err))
188 err = atf_process_child_wait(&child, status);
191 atf_process_stream_fini(&errsb);
192 atf_process_stream_fini(&outsb);
199 update_success_from_status(const char *progname,
200 const atf_process_status_t *status, bool *success)
202 bool s = atf_process_status_exited(status) &&
203 atf_process_status_exitstatus(status) == EXIT_SUCCESS;
205 if (atf_process_status_exited(status)) {
206 if (atf_process_status_exitstatus(status) == EXIT_SUCCESS)
210 fprintf(stderr, "%s failed with exit code %d\n", progname,
211 atf_process_status_exitstatus(status));
213 } else if (atf_process_status_signaled(status)) {
215 fprintf(stderr, "%s failed due to signal %d%s\n", progname,
216 atf_process_status_termsig(status),
217 atf_process_status_coredump(status) ? " (core dumped)" : "");
220 fprintf(stderr, "%s failed due to unknown reason\n", progname);
228 array_to_list(const char *const *a, atf_list_t *l)
232 err = atf_list_init(l);
233 if (atf_is_error(err))
237 char *item = strdup(*a);
239 err = atf_no_memory_error();
243 err = atf_list_append(l, item, true);
244 if (atf_is_error(err))
255 print_array(const char *const *array, const char *pfx)
257 const char *const *ptr;
260 for (ptr = array; *ptr != NULL; ptr++)
267 check_build_run(const char *const *argv, bool *success)
270 atf_process_status_t status;
272 print_array(argv, ">");
274 err = fork_and_wait(argv, NULL, NULL, &status);
275 if (atf_is_error(err))
278 update_success_from_status(argv[0], &status, success);
279 atf_process_status_fini(&status);
281 INV(!atf_is_error(err));
286 /* ---------------------------------------------------------------------
287 * The "atf_check_result" type.
288 * --------------------------------------------------------------------- */
290 struct atf_check_result_impl {
293 atf_fs_path_t m_stdout;
294 atf_fs_path_t m_stderr;
295 atf_process_status_t m_status;
300 atf_check_result_init(atf_check_result_t *r, const char *const *argv,
301 const atf_fs_path_t *dir)
305 r->pimpl = malloc(sizeof(struct atf_check_result_impl));
306 if (r->pimpl == NULL)
307 return atf_no_memory_error();
309 err = array_to_list(argv, &r->pimpl->m_argv);
310 if (atf_is_error(err))
313 err = atf_fs_path_copy(&r->pimpl->m_dir, dir);
314 if (atf_is_error(err))
317 err = atf_fs_path_init_fmt(&r->pimpl->m_stdout, "%s/stdout",
318 atf_fs_path_cstring(dir));
319 if (atf_is_error(err))
322 err = atf_fs_path_init_fmt(&r->pimpl->m_stderr, "%s/stderr",
323 atf_fs_path_cstring(dir));
324 if (atf_is_error(err))
327 INV(!atf_is_error(err));
331 atf_fs_path_fini(&r->pimpl->m_stdout);
333 atf_fs_path_fini(&r->pimpl->m_dir);
335 atf_list_fini(&r->pimpl->m_argv);
341 atf_check_result_fini(atf_check_result_t *r)
343 atf_process_status_fini(&r->pimpl->m_status);
345 cleanup_tmpdir(&r->pimpl->m_dir, &r->pimpl->m_stdout,
346 &r->pimpl->m_stderr);
347 atf_fs_path_fini(&r->pimpl->m_stdout);
348 atf_fs_path_fini(&r->pimpl->m_stderr);
349 atf_fs_path_fini(&r->pimpl->m_dir);
351 atf_list_fini(&r->pimpl->m_argv);
357 atf_check_result_stdout(const atf_check_result_t *r)
359 return atf_fs_path_cstring(&r->pimpl->m_stdout);
363 atf_check_result_stderr(const atf_check_result_t *r)
365 return atf_fs_path_cstring(&r->pimpl->m_stderr);
369 atf_check_result_exited(const atf_check_result_t *r)
371 return atf_process_status_exited(&r->pimpl->m_status);
375 atf_check_result_exitcode(const atf_check_result_t *r)
377 return atf_process_status_exitstatus(&r->pimpl->m_status);
381 atf_check_result_signaled(const atf_check_result_t *r)
383 return atf_process_status_signaled(&r->pimpl->m_status);
387 atf_check_result_termsig(const atf_check_result_t *r)
389 return atf_process_status_termsig(&r->pimpl->m_status);
392 /* ---------------------------------------------------------------------
394 * --------------------------------------------------------------------- */
396 /* XXX: This function shouldn't be in this module. It messes with stdout
397 * and stderr, and it provides a very high-end interface. This belongs,
398 * probably, somewhere related to test cases (such as in the tc module). */
400 atf_check_build_c_o(const char *sfile,
402 const char *const optargs[],
408 err = atf_build_c_o(sfile, ofile, optargs, &argv);
409 if (atf_is_error(err))
412 err = check_build_run((const char *const *)argv, success);
414 atf_utils_free_charpp(argv);
420 atf_check_build_cpp(const char *sfile,
422 const char *const optargs[],
428 err = atf_build_cpp(sfile, ofile, optargs, &argv);
429 if (atf_is_error(err))
432 err = check_build_run((const char *const *)argv, success);
434 atf_utils_free_charpp(argv);
440 atf_check_build_cxx_o(const char *sfile,
442 const char *const optargs[],
448 err = atf_build_cxx_o(sfile, ofile, optargs, &argv);
449 if (atf_is_error(err))
452 err = check_build_run((const char *const *)argv, success);
454 atf_utils_free_charpp(argv);
460 atf_check_exec_array(const char *const *argv, atf_check_result_t *r)
465 err = create_tmpdir(&dir);
466 if (atf_is_error(err))
469 err = atf_check_result_init(r, argv, &dir);
470 if (atf_is_error(err)) {
471 atf_error_t err2 = atf_fs_rmdir(&dir);
472 INV(!atf_is_error(err2));
476 err = fork_and_wait(argv, &r->pimpl->m_stdout, &r->pimpl->m_stderr,
477 &r->pimpl->m_status);
478 if (atf_is_error(err)) {
479 atf_check_result_fini(r);
483 INV(!atf_is_error(err));
485 atf_fs_path_fini(&dir);