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

   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 #if defined(TESTS_ATF_ATF_C_TEST_HELPERS_H)
  31 #   error "Cannot include test_helpers.h more than once."
  32 #else
  33 #   define TESTS_ATF_ATF_C_TEST_HELPERS_H
  34 #endif
  35
  36 #include <stdbool.h>
  37
  38 #include "atf-c/error_fwd.h"
  39
  40 struct atf_dynstr;
  41 struct atf_fs_path;
  42
  43 #define CE(stm) ATF_CHECK(!atf_is_error(stm))
  44 #define RE(stm) ATF_REQUIRE(!atf_is_error(stm))
  45
  46 #define HEADER_TC(name, hdrname) \
  47     ATF_TC(name); \
  48     ATF_TC_HEAD(name, tc) \
  49     { \
  50         atf_tc_set_md_var(tc, "descr", "Tests that the " hdrname " file can " \
  51             "be included on its own, without any prerequisites"); \
  52     } \
  53     ATF_TC_BODY(name, tc) \
  54     { \
  55         header_check(hdrname); \
  56     }
  57
  58 #define BUILD_TC(name, sfile, descr, failmsg) \
  59     ATF_TC(name); \
  60     ATF_TC_HEAD(name, tc) \
  61     { \
  62         atf_tc_set_md_var(tc, "descr", descr); \
  63     } \
  64     ATF_TC_BODY(name, tc) \
  65     { \
  66         build_check_c_o(tc, sfile, failmsg, true);   \
  67     }
  68
  69 #define BUILD_TC_FAIL(name, sfile, descr, failmsg) \
  70     ATF_TC(name); \
  71     ATF_TC_HEAD(name, tc) \
  72     { \
  73         atf_tc_set_md_var(tc, "descr", descr); \
  74     } \
  75     ATF_TC_BODY(name, tc) \
  76     { \
  77         build_check_c_o(tc, sfile, failmsg, false);   \
  78     }
  79
  80 void build_check_c_o(const atf_tc_t *, const char *, const char *, const bool);
  81 void header_check(const char *);
  82 void get_process_helpers_path(const atf_tc_t *, const bool,
  83                               struct atf_fs_path *);
  84 bool grep_string(const struct atf_dynstr *, const char *);
  85 bool grep_file(const char *, const char *, ...);
  86 bool read_line(int, struct atf_dynstr *);
  87 void run_h_tc(atf_tc_t *, const char *, const char *, const char *);