1/*
2 * Automated Testing Framework (atf)
3 *
4 * Copyright (c) 2008, 2009, 2010 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(ATF_C_TC_H)
31#define ATF_C_TC_H
32
33#include <stdbool.h>
34#include <stddef.h>
35
36#include <atf-c/defs.h>
37#include <atf-c/error_fwd.h>
38
39struct atf_tc;
40
41typedef void (*atf_tc_head_t)(struct atf_tc *);
42typedef void (*atf_tc_body_t)(const struct atf_tc *);
43typedef void (*atf_tc_cleanup_t)(const struct atf_tc *);
44
45/* ---------------------------------------------------------------------
46 * The "atf_tc_pack" type.
47 * --------------------------------------------------------------------- */
48
49/* For static initialization only. */
50struct atf_tc_pack {
51    const char *m_ident;
52
53    const char *const *m_config;
54
55    atf_tc_head_t m_head;
56    atf_tc_body_t m_body;
57    atf_tc_cleanup_t m_cleanup;
58};
59typedef const struct atf_tc_pack atf_tc_pack_t;
60
61/* ---------------------------------------------------------------------
62 * The "atf_tc" type.
63 * --------------------------------------------------------------------- */
64
65struct atf_tc_impl;
66struct atf_tc {
67    struct atf_tc_impl *pimpl;
68};
69typedef struct atf_tc atf_tc_t;
70
71/* Constructors/destructors. */
72atf_error_t atf_tc_init(atf_tc_t *, const char *, atf_tc_head_t,
73                        atf_tc_body_t, atf_tc_cleanup_t,
74                        const char *const *);
75atf_error_t atf_tc_init_pack(atf_tc_t *, atf_tc_pack_t *,
76                             const char *const *);
77void atf_tc_fini(atf_tc_t *);
78
79/* Getters. */
80const char *atf_tc_get_ident(const atf_tc_t *);
81const char *atf_tc_get_config_var(const atf_tc_t *, const char *);
82const char *atf_tc_get_config_var_wd(const atf_tc_t *, const char *,
83                                     const char *);
84bool atf_tc_get_config_var_as_bool(const atf_tc_t *, const char *);
85bool atf_tc_get_config_var_as_bool_wd(const atf_tc_t *, const char *,
86                                      const bool);
87long atf_tc_get_config_var_as_long(const atf_tc_t *, const char *);
88long atf_tc_get_config_var_as_long_wd(const atf_tc_t *, const char *,
89                                      const long);
90const char *atf_tc_get_md_var(const atf_tc_t *, const char *);
91char **atf_tc_get_md_vars(const atf_tc_t *);
92bool atf_tc_has_config_var(const atf_tc_t *, const char *);
93bool atf_tc_has_md_var(const atf_tc_t *, const char *);
94
95/* Modifiers. */
96atf_error_t atf_tc_set_md_var(atf_tc_t *, const char *, const char *, ...);
97
98/* ---------------------------------------------------------------------
99 * Free functions.
100 * --------------------------------------------------------------------- */
101
102atf_error_t atf_tc_run(const atf_tc_t *, const char *);
103atf_error_t atf_tc_cleanup(const atf_tc_t *);
104
105/* To be run from test case bodies only. */
106void atf_tc_fail(const char *, ...) ATF_DEFS_ATTRIBUTE_NORETURN;
107void atf_tc_fail_nonfatal(const char *, ...);
108void atf_tc_pass(void) ATF_DEFS_ATTRIBUTE_NORETURN;
109void atf_tc_require_prog(const char *);
110void atf_tc_skip(const char *, ...) ATF_DEFS_ATTRIBUTE_NORETURN;
111void atf_tc_expect_pass(void);
112void atf_tc_expect_fail(const char *, ...);
113void atf_tc_expect_exit(const int, const char *, ...);
114void atf_tc_expect_signal(const int, const char *, ...);
115void atf_tc_expect_death(const char *, ...);
116void atf_tc_expect_timeout(const char *, ...);
117
118/* To be run from test case bodies only; internal to macros.h. */
119void atf_tc_fail_check(const char *, const size_t, const char *, ...);
120void atf_tc_fail_requirement(const char *, const size_t, const char *, ...)
121     ATF_DEFS_ATTRIBUTE_NORETURN;
122void atf_tc_check_errno(const char *, const size_t, const int,
123                        const char *, const bool);
124void atf_tc_require_errno(const char *, const size_t, const int,
125                          const char *, const bool);
126
127#endif /* ATF_C_TC_H */
128