4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews/* Copyright (c) 2008 The NetBSD Foundation, Inc.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * All rights reserved.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt *
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * Redistribution and use in source and binary forms, with or without
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * modification, are permitted provided that the following conditions
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * are met:
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * 1. Redistributions of source code must retain the above copyright
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * notice, this list of conditions and the following disclaimer.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * 2. Redistributions in binary form must reproduce the above copyright
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * notice, this list of conditions and the following disclaimer in the
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * documentation and/or other materials provided with the distribution.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt *
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#if !defined(ATF_C_TC_H)
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#define ATF_C_TC_H
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <stdbool.h>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <stddef.h>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <atf-c/defs.h>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt#include <atf-c/error_fwd.h>
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntstruct atf_tc;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunttypedef void (*atf_tc_head_t)(struct atf_tc *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunttypedef void (*atf_tc_body_t)(const struct atf_tc *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunttypedef void (*atf_tc_cleanup_t)(const struct atf_tc *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt/* ---------------------------------------------------------------------
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * The "atf_tc_pack" type.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * --------------------------------------------------------------------- */
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt/* For static initialization only. */
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntstruct atf_tc_pack {
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt const char *m_ident;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt const char *const *m_config;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf_tc_head_t m_head;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf_tc_body_t m_body;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf_tc_cleanup_t m_cleanup;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt};
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunttypedef const struct atf_tc_pack atf_tc_pack_t;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt/* ---------------------------------------------------------------------
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * The "atf_tc" type.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * --------------------------------------------------------------------- */
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntstruct atf_tc_impl;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntstruct atf_tc {
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt struct atf_tc_impl *pimpl;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt};
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunttypedef struct atf_tc atf_tc_t;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt/* Constructors/destructors. */
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntatf_error_t atf_tc_init(atf_tc_t *, const char *, atf_tc_head_t,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt atf_tc_body_t, atf_tc_cleanup_t,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt const char *const *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntatf_error_t atf_tc_init_pack(atf_tc_t *, atf_tc_pack_t *,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt const char *const *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntvoid atf_tc_fini(atf_tc_t *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt/* Getters. */
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntconst char *atf_tc_get_ident(const atf_tc_t *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntconst char *atf_tc_get_config_var(const atf_tc_t *, const char *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntconst char *atf_tc_get_config_var_wd(const atf_tc_t *, const char *,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt const char *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntbool atf_tc_get_config_var_as_bool(const atf_tc_t *, const char *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntbool atf_tc_get_config_var_as_bool_wd(const atf_tc_t *, const char *,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt const bool);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntlong atf_tc_get_config_var_as_long(const atf_tc_t *, const char *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntlong atf_tc_get_config_var_as_long_wd(const atf_tc_t *, const char *,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt const long);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntconst char *atf_tc_get_md_var(const atf_tc_t *, const char *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntchar **atf_tc_get_md_vars(const atf_tc_t *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntbool atf_tc_has_config_var(const atf_tc_t *, const char *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntbool atf_tc_has_md_var(const atf_tc_t *, const char *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt/* Modifiers. */
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntatf_error_t atf_tc_set_md_var(atf_tc_t *, const char *, const char *, ...);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt/* ---------------------------------------------------------------------
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * Free functions.
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt * --------------------------------------------------------------------- */
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntatf_error_t atf_tc_run(const atf_tc_t *, const char *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntatf_error_t atf_tc_cleanup(const atf_tc_t *);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt/* To be run from test case bodies only. */
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Huntvoid atf_tc_fail(const char *, ...)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_NORETURN;
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Huntvoid atf_tc_fail_nonfatal(const char *, ...)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2);
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Huntvoid atf_tc_pass(void)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_NORETURN;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntvoid atf_tc_require_prog(const char *);
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Huntvoid atf_tc_skip(const char *, ...)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_NORETURN;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntvoid atf_tc_expect_pass(void);
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Huntvoid atf_tc_expect_fail(const char *, ...)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2);
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Huntvoid atf_tc_expect_exit(const int, const char *, ...)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(2, 3);
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Huntvoid atf_tc_expect_signal(const int, const char *, ...)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(2, 3);
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Huntvoid atf_tc_expect_death(const char *, ...)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2);
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Huntvoid atf_tc_expect_timeout(const char *, ...)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt/* To be run from test case bodies only; internal to macros.h. */
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Huntvoid atf_tc_fail_check(const char *, const size_t, const char *, ...)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(3, 4);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntvoid atf_tc_fail_requirement(const char *, const size_t, const char *, ...)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(3, 4)
a747113422afaa29ce72d2c5ba7f0b7ea9ec2054Evan Hunt ATF_DEFS_ATTRIBUTE_NORETURN;
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntvoid atf_tc_check_errno(const char *, const size_t, const int,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt const char *, const bool);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Huntvoid atf_tc_require_errno(const char *, const size_t, const int,
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt const char *, const bool);
ef421f66f47224a42073deaf087378c5d0c9952eEvan Hunt
4a53e3c2b83c476a93148eaee0272649beb221caMark Andrews#endif /* !defined(ATF_C_TC_H) */