1/*	$NetBSD: tc.h,v 1.1.1.1 2011/09/11 17:20:29 christos Exp $	*/
2
3/*
4 * Automated Testing Framework (atf)
5 *
6 * Copyright (c) 2008, 2009, 2010 The NetBSD Foundation, Inc.
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
19 * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
20 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
25 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
27 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
29 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#if !defined(ATF_C_TC_H)
33#define ATF_C_TC_H
34
35#include <stdbool.h>
36#include <stddef.h>
37
38#include <atf-c/defs.h>
39#include <atf-c/error_fwd.h>
40
41struct atf_tc;
42
43typedef void (*atf_tc_head_t)(struct atf_tc *);
44typedef void (*atf_tc_body_t)(const struct atf_tc *);
45typedef void (*atf_tc_cleanup_t)(const struct atf_tc *);
46
47/* ---------------------------------------------------------------------
48 * The "atf_tc_pack" type.
49 * --------------------------------------------------------------------- */
50
51/* For static initialization only. */
52struct atf_tc_pack {
53    const char *m_ident;
54
55    const char *const *m_config;
56
57    atf_tc_head_t m_head;
58    atf_tc_body_t m_body;
59    atf_tc_cleanup_t m_cleanup;
60};
61typedef const struct atf_tc_pack atf_tc_pack_t;
62
63/* ---------------------------------------------------------------------
64 * The "atf_tc" type.
65 * --------------------------------------------------------------------- */
66
67struct atf_tc_impl;
68struct atf_tc {
69    struct atf_tc_impl *pimpl;
70};
71typedef struct atf_tc atf_tc_t;
72
73/* Constructors/destructors. */
74atf_error_t atf_tc_init(atf_tc_t *, const char *, atf_tc_head_t,
75                        atf_tc_body_t, atf_tc_cleanup_t,
76                        const char *const *);
77atf_error_t atf_tc_init_pack(atf_tc_t *, atf_tc_pack_t *,
78                             const char *const *);
79void atf_tc_fini(atf_tc_t *);
80
81/* Getters. */
82const char *atf_tc_get_ident(const atf_tc_t *);
83const char *atf_tc_get_config_var(const atf_tc_t *, const char *);
84const char *atf_tc_get_config_var_wd(const atf_tc_t *, const char *,
85                                     const char *);
86bool atf_tc_get_config_var_as_bool(const atf_tc_t *, const char *);
87bool atf_tc_get_config_var_as_bool_wd(const atf_tc_t *, const char *,
88                                      const bool);
89long atf_tc_get_config_var_as_long(const atf_tc_t *, const char *);
90long atf_tc_get_config_var_as_long_wd(const atf_tc_t *, const char *,
91                                      const long);
92const char *atf_tc_get_md_var(const atf_tc_t *, const char *);
93char **atf_tc_get_md_vars(const atf_tc_t *);
94bool atf_tc_has_config_var(const atf_tc_t *, const char *);
95bool atf_tc_has_md_var(const atf_tc_t *, const char *);
96
97/* Modifiers. */
98atf_error_t atf_tc_set_md_var(atf_tc_t *, const char *, const char *, ...);
99
100/* ---------------------------------------------------------------------
101 * Free functions.
102 * --------------------------------------------------------------------- */
103
104atf_error_t atf_tc_run(const atf_tc_t *, const char *);
105atf_error_t atf_tc_cleanup(const atf_tc_t *);
106
107/* To be run from test case bodies only. */
108void atf_tc_fail(const char *, ...) ATF_DEFS_ATTRIBUTE_NORETURN;
109void atf_tc_fail_nonfatal(const char *, ...);
110void atf_tc_pass(void) ATF_DEFS_ATTRIBUTE_NORETURN;
111void atf_tc_require_prog(const char *);
112void atf_tc_skip(const char *, ...) ATF_DEFS_ATTRIBUTE_NORETURN;
113void atf_tc_expect_pass(void);
114void atf_tc_expect_fail(const char *, ...);
115void atf_tc_expect_exit(const int, const char *, ...);
116void atf_tc_expect_signal(const int, const char *, ...);
117void atf_tc_expect_death(const char *, ...);
118void atf_tc_expect_timeout(const char *, ...);
119
120/* To be run from test case bodies only; internal to macros.h. */
121void atf_tc_fail_check(const char *, const size_t, const char *, ...);
122void atf_tc_fail_requirement(const char *, const size_t, const char *, ...)
123     ATF_DEFS_ATTRIBUTE_NORETURN;
124void atf_tc_check_errno(const char *, const size_t, const int,
125                        const char *, const bool);
126void atf_tc_require_errno(const char *, const size_t, const int,
127                          const char *, const bool);
128
129#endif /* ATF_C_TC_H */
130