tc.h revision 240116
1240116Smarcel/* 2240116Smarcel * Automated Testing Framework (atf) 3240116Smarcel * 4240116Smarcel * Copyright (c) 2008 The NetBSD Foundation, Inc. 5240116Smarcel * All rights reserved. 6240116Smarcel * 7240116Smarcel * Redistribution and use in source and binary forms, with or without 8240116Smarcel * modification, are permitted provided that the following conditions 9240116Smarcel * are met: 10240116Smarcel * 1. Redistributions of source code must retain the above copyright 11240116Smarcel * notice, this list of conditions and the following disclaimer. 12240116Smarcel * 2. Redistributions in binary form must reproduce the above copyright 13240116Smarcel * notice, this list of conditions and the following disclaimer in the 14240116Smarcel * documentation and/or other materials provided with the distribution. 15240116Smarcel * 16240116Smarcel * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND 17240116Smarcel * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 18240116Smarcel * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 19240116Smarcel * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20240116Smarcel * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY 21240116Smarcel * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22240116Smarcel * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 23240116Smarcel * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24240116Smarcel * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 25240116Smarcel * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 26240116Smarcel * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 27240116Smarcel * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28240116Smarcel */ 29240116Smarcel 30240116Smarcel#if !defined(ATF_C_TC_H) 31240116Smarcel#define ATF_C_TC_H 32240116Smarcel 33240116Smarcel#include <stdbool.h> 34240116Smarcel#include <stddef.h> 35240116Smarcel 36240116Smarcel#include <atf-c/defs.h> 37240116Smarcel#include <atf-c/error_fwd.h> 38240116Smarcel 39240116Smarcelstruct atf_tc; 40240116Smarcel 41240116Smarceltypedef void (*atf_tc_head_t)(struct atf_tc *); 42240116Smarceltypedef void (*atf_tc_body_t)(const struct atf_tc *); 43240116Smarceltypedef void (*atf_tc_cleanup_t)(const struct atf_tc *); 44240116Smarcel 45240116Smarcel/* --------------------------------------------------------------------- 46240116Smarcel * The "atf_tc_pack" type. 47240116Smarcel * --------------------------------------------------------------------- */ 48240116Smarcel 49240116Smarcel/* For static initialization only. */ 50240116Smarcelstruct atf_tc_pack { 51240116Smarcel const char *m_ident; 52240116Smarcel 53240116Smarcel const char *const *m_config; 54240116Smarcel 55240116Smarcel atf_tc_head_t m_head; 56240116Smarcel atf_tc_body_t m_body; 57240116Smarcel atf_tc_cleanup_t m_cleanup; 58240116Smarcel}; 59240116Smarceltypedef const struct atf_tc_pack atf_tc_pack_t; 60240116Smarcel 61240116Smarcel/* --------------------------------------------------------------------- 62240116Smarcel * The "atf_tc" type. 63240116Smarcel * --------------------------------------------------------------------- */ 64240116Smarcel 65240116Smarcelstruct atf_tc_impl; 66240116Smarcelstruct atf_tc { 67240116Smarcel struct atf_tc_impl *pimpl; 68240116Smarcel}; 69240116Smarceltypedef struct atf_tc atf_tc_t; 70240116Smarcel 71240116Smarcel/* Constructors/destructors. */ 72240116Smarcelatf_error_t atf_tc_init(atf_tc_t *, const char *, atf_tc_head_t, 73240116Smarcel atf_tc_body_t, atf_tc_cleanup_t, 74240116Smarcel const char *const *); 75240116Smarcelatf_error_t atf_tc_init_pack(atf_tc_t *, atf_tc_pack_t *, 76240116Smarcel const char *const *); 77240116Smarcelvoid atf_tc_fini(atf_tc_t *); 78240116Smarcel 79240116Smarcel/* Getters. */ 80240116Smarcelconst char *atf_tc_get_ident(const atf_tc_t *); 81240116Smarcelconst char *atf_tc_get_config_var(const atf_tc_t *, const char *); 82240116Smarcelconst char *atf_tc_get_config_var_wd(const atf_tc_t *, const char *, 83240116Smarcel const char *); 84240116Smarcelbool atf_tc_get_config_var_as_bool(const atf_tc_t *, const char *); 85240116Smarcelbool atf_tc_get_config_var_as_bool_wd(const atf_tc_t *, const char *, 86240116Smarcel const bool); 87240116Smarcellong atf_tc_get_config_var_as_long(const atf_tc_t *, const char *); 88240116Smarcellong atf_tc_get_config_var_as_long_wd(const atf_tc_t *, const char *, 89240116Smarcel const long); 90240116Smarcelconst char *atf_tc_get_md_var(const atf_tc_t *, const char *); 91240116Smarcelchar **atf_tc_get_md_vars(const atf_tc_t *); 92240116Smarcelbool atf_tc_has_config_var(const atf_tc_t *, const char *); 93240116Smarcelbool atf_tc_has_md_var(const atf_tc_t *, const char *); 94240116Smarcel 95240116Smarcel/* Modifiers. */ 96240116Smarcelatf_error_t atf_tc_set_md_var(atf_tc_t *, const char *, const char *, ...); 97240116Smarcel 98240116Smarcel/* --------------------------------------------------------------------- 99240116Smarcel * Free functions. 100240116Smarcel * --------------------------------------------------------------------- */ 101240116Smarcel 102240116Smarcelatf_error_t atf_tc_run(const atf_tc_t *, const char *); 103240116Smarcelatf_error_t atf_tc_cleanup(const atf_tc_t *); 104240116Smarcel 105240116Smarcel/* To be run from test case bodies only. */ 106240116Smarcelvoid atf_tc_fail(const char *, ...) 107240116Smarcel ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2) 108240116Smarcel ATF_DEFS_ATTRIBUTE_NORETURN; 109240116Smarcelvoid atf_tc_fail_nonfatal(const char *, ...) 110240116Smarcel ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2); 111240116Smarcelvoid atf_tc_pass(void) 112240116Smarcel ATF_DEFS_ATTRIBUTE_NORETURN; 113240116Smarcelvoid atf_tc_require_prog(const char *); 114240116Smarcelvoid atf_tc_skip(const char *, ...) 115240116Smarcel ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2) 116240116Smarcel ATF_DEFS_ATTRIBUTE_NORETURN; 117240116Smarcelvoid atf_tc_expect_pass(void); 118240116Smarcelvoid atf_tc_expect_fail(const char *, ...) 119240116Smarcel ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2); 120240116Smarcelvoid atf_tc_expect_exit(const int, const char *, ...) 121240116Smarcel ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(2, 3); 122240116Smarcelvoid atf_tc_expect_signal(const int, const char *, ...) 123240116Smarcel ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(2, 3); 124240116Smarcelvoid atf_tc_expect_death(const char *, ...) 125240116Smarcel ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2); 126240116Smarcelvoid atf_tc_expect_timeout(const char *, ...) 127240116Smarcel ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(1, 2); 128240116Smarcel 129240116Smarcel/* To be run from test case bodies only; internal to macros.h. */ 130240116Smarcelvoid atf_tc_fail_check(const char *, const size_t, const char *, ...) 131240116Smarcel ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(3, 4); 132240116Smarcelvoid atf_tc_fail_requirement(const char *, const size_t, const char *, ...) 133240116Smarcel ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(3, 4) 134240116Smarcel ATF_DEFS_ATTRIBUTE_NORETURN; 135240116Smarcelvoid atf_tc_check_errno(const char *, const size_t, const int, 136240116Smarcel const char *, const bool); 137240116Smarcelvoid atf_tc_require_errno(const char *, const size_t, const int, 138240116Smarcel const char *, const bool); 139240116Smarcel 140240116Smarcel#endif /* ATF_C_TC_H */ 141