contrib/atf/atf-c/detail/test_helpers.c

   1 /*
   2  * Automated Testing Framework (atf)
   3  *
   4  * Copyright (c) 2008 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  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.
  15  *
  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.
  28  */
  29
  30 #include <fcntl.h>
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <unistd.h>
  34
  35 #include "atf-c/build.h"
  36 #include "atf-c/check.h"
  37 #include "atf-c/config.h"
  38 #include "atf-c/error.h"
  39 #include "atf-c/macros.h"
  40
  41 #include "dynstr.h"
  42 #include "fs.h"
  43 #include "process.h"
  44 #include "test_helpers.h"
  45
  46 static
  47 void
  48 build_check_c_o_aux(const char *path, const char *failmsg,
  49                     const bool expect_pass)
  50 {
  51     bool success;
  52     atf_dynstr_t iflag;
  53     const char *optargs[4];
  54
  55     RE(atf_dynstr_init_fmt(&iflag, "-I%s", atf_config_get("atf_includedir")));
  56
  57     optargs[0] = atf_dynstr_cstring(&iflag);
  58     optargs[1] = "-Wall";
  59     optargs[2] = "-Werror";
  60     optargs[3] = NULL;
  61
  62     RE(atf_check_build_c_o(path, "test.o", optargs, &success));
  63
  64     atf_dynstr_fini(&iflag);
  65
  66     if ((expect_pass && !success) || (!expect_pass && success))
  67         atf_tc_fail("%s", failmsg);
  68 }
  69
  70 void
  71 build_check_c_o(const atf_tc_t *tc, const char *sfile, const char *failmsg,
  72                 const bool expect_pass)
  73 {
  74     atf_fs_path_t path;
  75
  76     RE(atf_fs_path_init_fmt(&path, "%s/%s",
  77                             atf_tc_get_config_var(tc, "srcdir"), sfile));
  78     build_check_c_o_aux(atf_fs_path_cstring(&path), failmsg, expect_pass);
  79     atf_fs_path_fini(&path);
  80 }
  81
  82 void
  83 header_check(const char *hdrname)
  84 {
  85     FILE *srcfile;
  86     char failmsg[128];
  87
  88     srcfile = fopen("test.c", "w");
  89     ATF_REQUIRE(srcfile != NULL);
  90     fprintf(srcfile, "#include <%s>\n", hdrname);
  91     fclose(srcfile);
  92
  93     snprintf(failmsg, sizeof(failmsg),
  94              "Header check failed; %s is not self-contained", hdrname);
  95
  96     build_check_c_o_aux("test.c", failmsg, true);
  97 }
  98
  99 void
 100 get_process_helpers_path(const atf_tc_t *tc, const bool is_detail,
 101                          atf_fs_path_t *path)
 102 {
 103     RE(atf_fs_path_init_fmt(path, "%s/%sprocess_helpers",
 104                             atf_tc_get_config_var(tc, "srcdir"),
 105                             is_detail ? "" : "detail/"));
 106 }
 107
 108 struct run_h_tc_data {
 109     atf_tc_t *m_tc;
 110     const char *m_resname;
 111 };
 112
 113 static
 114 void
 115 run_h_tc_child(void *v)
 116 {
 117     struct run_h_tc_data *data = (struct run_h_tc_data *)v;
 118
 119     RE(atf_tc_run(data->m_tc, data->m_resname));
 120 }
 121
 122 /* TODO: Investigate if it's worth to add this functionality as part of
 123  * the public API.  I.e. a function to easily run a test case body in a
 124  * subprocess. */
 125 void
 126 run_h_tc(atf_tc_t *tc, const char *outname, const char *errname,
 127          const char *resname)
 128 {
 129     atf_fs_path_t outpath, errpath;
 130     atf_process_stream_t outb, errb;
 131     atf_process_child_t child;
 132     atf_process_status_t status;
 133
 134     RE(atf_fs_path_init_fmt(&outpath, outname));
 135     RE(atf_fs_path_init_fmt(&errpath, errname));
 136
 137     struct run_h_tc_data data = { tc, resname };
 138
 139     RE(atf_process_stream_init_redirect_path(&outb, &outpath));
 140     RE(atf_process_stream_init_redirect_path(&errb, &errpath));
 141     RE(atf_process_fork(&child, run_h_tc_child, &outb, &errb, &data));
 142     atf_process_stream_fini(&errb);
 143     atf_process_stream_fini(&outb);
 144
 145     RE(atf_process_child_wait(&child, &status));
 146     ATF_CHECK(atf_process_status_exited(&status));
 147     atf_process_status_fini(&status);
 148
 149     atf_fs_path_fini(&errpath);
 150     atf_fs_path_fini(&outpath);
 151 }