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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/* Insanity QA system
insanitytest.h
Copyright (c) 2012, Collabora Ltd <vincent@collabora.co.uk>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this program; if not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef INSANITY_TEST_H_GUARD
#define INSANITY_TEST_H_GUARD
#include <glib.h>
#include <glib-object.h>
#include <insanity/insanitydefs.h>
G_BEGIN_DECLS
typedef enum {
INSANITY_LOG_LEVEL_NONE,
INSANITY_LOG_LEVEL_INFO,
INSANITY_LOG_LEVEL_DEBUG,
INSANITY_LOG_LEVEL_SPAM,
} InsanityLogLevel;
typedef struct _InsanityTest InsanityTest;
typedef struct _InsanityTestClass InsanityTestClass;
typedef struct _InsanityTestPrivateData InsanityTestPrivateData;
/**
* InsanityTest:
*
* The opaque #InsanityTest data structure.
*/
struct _InsanityTest {
GObject parent;
/*< private >*/
InsanityTestPrivateData *priv;
gpointer _insanity_reserved[INSANITY_PADDING];
};
/**
* InsanityTestClass:
* @parent_class: the parent class structure
* @setup: setup anything the test needs before starting. Arguments are
* now available at this time. Any cleanup for this work should
* be done in teardown.
* @start: start the test. Should signal ready when done.
* @stop: stop the test.
* @teardown: cleanup anything before leaving the test. The test will not
* be started again after this.
*
* Insanity test class. Override the vmethods to customize functionality.
*/
struct _InsanityTestClass
{
GObjectClass parent_class;
/*< public >*/
/* vtable */
gboolean (*setup) (InsanityTest *test);
gboolean (*start) (InsanityTest *test);
void (*stop) (InsanityTest *test);
void (*teardown) (InsanityTest *test);
/*< private >*/
gpointer _insanity_reserved[INSANITY_PADDING];
};
/* Handy macros */
#define INSANITY_TYPE_TEST (insanity_test_get_type ())
#define INSANITY_TEST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), INSANITY_TYPE_TEST, InsanityTest))
#define INSANITY_TEST_CLASS(c) (G_TYPE_CHECK_CLASS_CAST ((c), INSANITY_TYPE_TEST, InsanityTestClass))
#define INSANITY_IS_TEST(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), INSANITY_TYPE_TEST))
#define INSANITY_IS_TEST_CLASS(c) (G_TYPE_CHECK_CLASS_TYPE ((c), INSANITY_TYPE_TEST))
#define INSANITY_TEST_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), INSANITY_TYPE_TEST, InsanityTestClass))
GType insanity_test_get_type (void);
InsanityTest *insanity_test_new(const char *name, const char *description, const char *full_description);
void insanity_test_add_checklist_item(InsanityTest *test, const char *label, const char *description, const char *error_hint, gboolean global);
void insanity_test_add_argument(InsanityTest *test, const char *label, const char *description, const char *full_description, gboolean global, const GValue *default_value);
void insanity_test_add_output_file(InsanityTest *test, const char *label, const char *description, gboolean global);
void insanity_test_add_extra_info(InsanityTest *test, const char *label, const char *description);
gboolean insanity_test_get_argument(InsanityTest *test, const char *label, GValue *value);
const char *insanity_test_get_output_filename(InsanityTest *test, const char *label);
void insanity_test_done(InsanityTest *test);
gboolean insanity_test_checklist_item_set_global(InsanityTest *test, const char *label, gboolean global);
void insanity_test_validate_checklist_item(InsanityTest *test, const char *label, gboolean success, const char *description);
void insanity_test_set_extra_info(InsanityTest *test, const char *label, const GValue *data);
void insanity_test_ping(InsanityTest *test);
gboolean insanity_test_check (InsanityTest *test, const char *label, gboolean expr, const char *msg, ...);
#define INSANITY_TEST_CHECK(test, label, expr) insanity_test_check(test, label, (expr), "%s:%u: check failed: %s", __FILE__, __LINE__, #expr)
/* Logging */
void insanity_test_logv (InsanityTest *test, const char *category, InsanityLogLevel level, const char *file, unsigned int line, const char *format, va_list args);
void insanity_test_log (InsanityTest *test, const char *category, InsanityLogLevel level, const char *file, unsigned int line, const char *format, ...);
#define INSANITY_LOG(test, category, loglevel, format, args...) \
insanity_test_log(test, category, loglevel, __FILE__, __LINE__, format, ##args)
#define insanity_test_printf(test,format,args...) \
INSANITY_LOG(test, "default", INSANITY_LOG_LEVEL_DEBUG, format, ##args)
#define insanity_test_report(test,format,args...) \
INSANITY_LOG(test, "report", INSANITY_LOG_LEVEL_INFO, format, ##args)
gboolean insanity_test_run(InsanityTest *test, int *argc, char ***argv);
/* convenience functions to avoid the heavy GValue use on common uses */
void insanity_test_add_string_argument(InsanityTest *test, const char *label, const char *description, const char *full_description, gboolean global, const char *default_value);
void insanity_test_add_int_argument(InsanityTest *test, const char *label, const char *description, const char *full_description, gboolean global, gint default_value);
void insanity_test_add_uint_argument(InsanityTest *test, const char *label, const char *description, const char *full_description, gboolean global, guint default_value);
void insanity_test_add_int64_argument(InsanityTest *test, const char *label, const char *description, const char *full_description, gboolean global, gint64 default_value);
void insanity_test_add_uint64_argument(InsanityTest *test, const char *label, const char *description, const char *full_description, gboolean global, guint64 default_value);
void insanity_test_add_double_argument(InsanityTest *test, const char *label, const char *description, const char *full_description, gboolean global, gdouble default_value);
void insanity_test_add_boolean_argument(InsanityTest *test, const char *label, const char *description, const char *full_description, gboolean global, gboolean default_value);
gboolean insanity_test_get_string_argument(InsanityTest *test, const char *label, char **value);
gboolean insanity_test_get_int_argument(InsanityTest *test, const char *label, gint *value);
gboolean insanity_test_get_uint_argument(InsanityTest *test, const char *label, guint *value);
gboolean insanity_test_get_int64_argument(InsanityTest *test, const char *label, gint64 *value);
gboolean insanity_test_get_uint64_argument(InsanityTest *test, const char *label, guint64 *value);
gboolean insanity_test_get_double_argument(InsanityTest *test, const char *label, gdouble *value);
gboolean insanity_test_get_boolean_argument(InsanityTest *test, const char *label, gboolean *value);
void insanity_test_set_string_extra_info (InsanityTest * test, const char *label, const char *data);
void insanity_test_set_int_extra_info (InsanityTest * test, const char *label, gint data);
void insanity_test_set_uint_extra_info (InsanityTest * test, const char *label, guint data);
void insanity_test_set_int64_extra_info (InsanityTest * test, const char *label, gint64 data);
void insanity_test_set_uint64_extra_info (InsanityTest * test, const char *label, guint64 data);
void insanity_test_set_double_extra_info (InsanityTest * test, const char *label, gdouble data);
void insanity_test_set_boolean_extra_info (InsanityTest * test, const char *label, gboolean data);
G_END_DECLS
#endif
|
