aboutsummaryrefslogtreecommitdiffstats
path: root/src/charon/plugins/unit_tester/unit_tester.h
blob: 7d117be4a333cb32dd33b8bbfc010faba6819cf3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*
 * Copyright (C) 2007 Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 *
 * $Id$
 */

/**
 * @defgroup unit_tester unit_tester
 * @{ @ingroup cplugins
 */

#ifndef UNIT_TESTER_H_
#define UNIT_TESTER_H_

#include <plugins/plugin.h>

typedef struct unit_tester_t unit_tester_t;

/**
 * Unit testing plugin.
 *
 * The unit testing plugin runs tests on plugin initialization. Tests are 
 * defined in tests.h using the DEFINE_TEST macro. Implementation of the
 * tests is done in the tests folder. Each test has uses a function which
 * returns TRUE for success or FALSE for failure.
 */
struct unit_tester_t {

	/**
	 * Implements the plugin interface.
	 */
	plugin_t plugin;
};

/**
 * Create a unit_tester plugin.
 */
plugin_t *plugin_create();

#endif /** UNIT_TESTER_H_ @}*/