1/* tinytest.h -- Copyright 2009-2012 Nick Mathewson
2 *
3 * Redistribution and use in source and binary forms, with or without
4 * modification, are permitted provided that the following conditions
5 * are met:
6 * 1. Redistributions of source code must retain the above copyright
7 *    notice, this list of conditions and the following disclaimer.
8 * 2. Redistributions in binary form must reproduce the above copyright
9 *    notice, this list of conditions and the following disclaimer in the
10 *    documentation and/or other materials provided with the distribution.
11 * 3. The name of the author may not be used to endorse or promote products
12 *    derived from this software without specific prior written permission.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef _TINYTEST_H
27#define _TINYTEST_H
28
29/** Flag for a test that needs to run in a subprocess. */
30#define TT_FORK  (1<<0)
31/** Runtime flag for a test we've decided to skip. */
32#define TT_SKIP  (1<<1)
33/** Internal runtime flag for a test we've decided to run. */
34#define _TT_ENABLED  (1<<2)
35/** If you add your own flags, make them start at this point. */
36#define TT_FIRST_USER_FLAG (1<<3)
37
38typedef void (*testcase_fn)(void *);
39
40struct testcase_t;
41
42/** Functions to initialize/teardown a structure for a testcase. */
43struct testcase_setup_t {
44	/** Return a new structure for use by a given testcase. */
45	void *(*setup_fn)(const struct testcase_t *);
46	/** Clean/free a structure from setup_fn. Return 1 if ok, 0 on err. */
47	int (*cleanup_fn)(const struct testcase_t *, void *);
48};
49
50/** A single test-case that you can run. */
51struct testcase_t {
52	const char *name; /**< An identifier for this case. */
53	testcase_fn fn; /**< The function to run to implement this case. */
54	unsigned long flags; /**< Bitfield of TT_* flags. */
55	const struct testcase_setup_t *setup; /**< Optional setup/cleanup fns*/
56	void *setup_data; /**< Extra data usable by setup function */
57};
58#define END_OF_TESTCASES { NULL, NULL, 0, NULL, NULL }
59
60/** A group of tests that are selectable together. */
61struct testgroup_t {
62	const char *prefix; /**< Prefix to prepend to testnames. */
63	struct testcase_t *cases; /** Array, ending with END_OF_TESTCASES */
64};
65#define END_OF_GROUPS { NULL, NULL}
66
67/** Implementation: called from a test to indicate failure, before logging. */
68void _tinytest_set_test_failed(void);
69/** Implementation: called from a test to indicate that we're skipping. */
70void _tinytest_set_test_skipped(void);
71/** Implementation: return 0 for quiet, 1 for normal, 2 for loud. */
72int _tinytest_get_verbosity(void);
73/** Implementation: Set a flag on tests matching a name; returns number
74 * of tests that matched. */
75int _tinytest_set_flag(struct testgroup_t *, const char *, unsigned long);
76
77/** Set all tests in 'groups' matching the name 'named' to be skipped. */
78#define tinytest_skip(groups, named) \
79	_tinytest_set_flag(groups, named, TT_SKIP)
80
81/** Run a single testcase in a single group. */
82int testcase_run_one(const struct testgroup_t *,const struct testcase_t *);
83/** Run a set of testcases from an END_OF_GROUPS-terminated array of groups,
84    as selected from the command line. */
85int tinytest_main(int argc, const char **argv, struct testgroup_t *groups);
86
87#endif
88