1
/* GLib testing utilities
2
* Copyright (C) 2007 Imendio AB
5
* This library is free software; you can redistribute it and/or
6
* modify it under the terms of the GNU Lesser General Public
7
* License as published by the Free Software Foundation; either
8
* version 2 of the License, or (at your option) any later version.
10
* This library is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
* Lesser General Public License for more details.
15
* You should have received a copy of the GNU Lesser General Public
16
* License along with this library; if not, write to the
17
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18
* Boston, MA 02111-1307, USA.
21
#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
22
#error "Only <glib.h> can be included directly."
25
#ifndef __G_TEST_UTILS_H__
26
#define __G_TEST_UTILS_H__
28
#include <glib/gmessages.h>
29
#include <glib/gstring.h>
30
#include <glib/gerror.h>
31
#include <glib/gslist.h>
35
typedef struct GTestCase GTestCase;
36
typedef struct GTestSuite GTestSuite;
37
typedef void (*GTestFunc) (void);
38
typedef void (*GTestDataFunc) (gconstpointer user_data);
39
typedef void (*GTestFixtureFunc) (gpointer fixture,
40
gconstpointer user_data);
43
#define g_assert_cmpstr(s1, cmp, s2) do { const char *__s1 = (s1), *__s2 = (s2); \
44
if (g_strcmp0 (__s1, __s2) cmp 0) ; else \
45
g_assertion_message_cmpstr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
46
#s1 " " #cmp " " #s2, __s1, #cmp, __s2); } while (0)
47
#define g_assert_cmpint(n1, cmp, n2) do { gint64 __n1 = (n1), __n2 = (n2); \
48
if (__n1 cmp __n2) ; else \
49
g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
50
#n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'i'); } while (0)
51
#define g_assert_cmpuint(n1, cmp, n2) do { guint64 __n1 = (n1), __n2 = (n2); \
52
if (__n1 cmp __n2) ; else \
53
g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
54
#n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'i'); } while (0)
55
#define g_assert_cmphex(n1, cmp, n2) do { guint64 __n1 = (n1), __n2 = (n2); \
56
if (__n1 cmp __n2) ; else \
57
g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
58
#n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'x'); } while (0)
59
#define g_assert_cmpfloat(n1,cmp,n2) do { long double __n1 = (n1), __n2 = (n2); \
60
if (__n1 cmp __n2) ; else \
61
g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
62
#n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'f'); } while (0)
63
#define g_assert_no_error(err) do { if (err) \
64
g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
65
#err, err, 0, 0); } while (0)
66
#define g_assert_error(err, dom, c) do { if (!err || (err)->domain != dom || (err)->code != c) \
67
g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
68
#err, err, dom, c); } while (0)
69
#ifdef G_DISABLE_ASSERT
70
#define g_assert_not_reached() do { (void) 0; } while (0)
71
#define g_assert(expr) do { (void) 0; } while (0)
72
#else /* !G_DISABLE_ASSERT */
73
#define g_assert_not_reached() do { g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); } while (0)
74
#define g_assert(expr) do { if G_LIKELY (expr) ; else \
75
g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
77
#endif /* !G_DISABLE_ASSERT */
79
int g_strcmp0 (const char *str1,
82
/* report performance results */
83
void g_test_minimized_result (double minimized_quantity,
85
...) G_GNUC_PRINTF (2, 3);
86
void g_test_maximized_result (double maximized_quantity,
88
...) G_GNUC_PRINTF (2, 3);
90
/* initialize testing framework */
91
void g_test_init (int *argc,
94
/* query testing framework config */
95
#define g_test_quick() (g_test_config_vars->test_quick)
96
#define g_test_slow() (!g_test_config_vars->test_quick)
97
#define g_test_thorough() (!g_test_config_vars->test_quick)
98
#define g_test_perf() (g_test_config_vars->test_perf)
99
#define g_test_verbose() (g_test_config_vars->test_verbose)
100
#define g_test_quiet() (g_test_config_vars->test_quiet)
101
#define g_test_undefined() (g_test_config_vars->test_undefined)
102
/* run all tests under toplevel suite (path: /) */
103
int g_test_run (void);
104
/* hook up a test functions under test path */
105
void g_test_add_func (const char *testpath,
106
GTestFunc test_func);
108
void g_test_add_data_func (const char *testpath,
109
gconstpointer test_data,
110
GTestDataFunc test_func);
111
/* tell about failure */
112
void g_test_fail (void);
114
/* hook up a test with fixture under test path */
115
#define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
117
void (*add_vtable) (const char*, \
120
void (*) (Fixture*, gconstpointer), \
121
void (*) (Fixture*, gconstpointer), \
122
void (*) (Fixture*, gconstpointer)) = (void (*) (const gchar *, gsize, gconstpointer, void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer))) g_test_add_vtable; \
124
(testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown); \
127
/* add test messages to the test report */
128
void g_test_message (const char *format,
129
...) G_GNUC_PRINTF (1, 2);
130
void g_test_bug_base (const char *uri_pattern);
131
void g_test_bug (const char *bug_uri_snippet);
132
/* measure test timings */
133
void g_test_timer_start (void);
134
double g_test_timer_elapsed (void); /* elapsed seconds */
135
double g_test_timer_last (void); /* repeat last elapsed() result */
137
/* automatically g_free or g_object_unref upon teardown */
138
void g_test_queue_free (gpointer gfree_pointer);
139
void g_test_queue_destroy (GDestroyNotify destroy_func,
140
gpointer destroy_data);
141
#define g_test_queue_unref(gobject) g_test_queue_destroy (g_object_unref, gobject)
143
/* test traps are guards used around forked tests */
145
G_TEST_TRAP_SILENCE_STDOUT = 1 << 7,
146
G_TEST_TRAP_SILENCE_STDERR = 1 << 8,
147
G_TEST_TRAP_INHERIT_STDIN = 1 << 9
149
gboolean g_test_trap_fork (guint64 usec_timeout,
150
GTestTrapFlags test_trap_flags);
151
gboolean g_test_trap_has_passed (void);
152
gboolean g_test_trap_reached_timeout (void);
153
#define g_test_trap_assert_passed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0)
154
#define g_test_trap_assert_failed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 1, 0)
155
#define g_test_trap_assert_stdout(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 2, soutpattern)
156
#define g_test_trap_assert_stdout_unmatched(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 3, soutpattern)
157
#define g_test_trap_assert_stderr(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 4, serrpattern)
158
#define g_test_trap_assert_stderr_unmatched(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 5, serrpattern)
160
/* provide seed-able random numbers for tests */
161
#define g_test_rand_bit() (0 != (g_test_rand_int() & (1 << 15)))
162
gint32 g_test_rand_int (void);
163
gint32 g_test_rand_int_range (gint32 begin,
165
double g_test_rand_double (void);
166
double g_test_rand_double_range (double range_start,
169
/* semi-internal API */
170
GTestCase* g_test_create_case (const char *test_name,
172
gconstpointer test_data,
173
GTestFixtureFunc data_setup,
174
GTestFixtureFunc data_test,
175
GTestFixtureFunc data_teardown);
176
GTestSuite* g_test_create_suite (const char *suite_name);
177
GTestSuite* g_test_get_root (void);
178
void g_test_suite_add (GTestSuite *suite,
179
GTestCase *test_case);
180
void g_test_suite_add_suite (GTestSuite *suite,
181
GTestSuite *nestedsuite);
182
int g_test_run_suite (GTestSuite *suite);
185
void g_test_trap_assertions (const char *domain,
189
guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
190
const char *pattern);
191
void g_assertion_message (const char *domain,
195
const char *message) G_GNUC_NORETURN;
196
void g_assertion_message_expr (const char *domain,
200
const char *expr) G_GNUC_NORETURN;
201
void g_assertion_message_cmpstr (const char *domain,
208
const char *arg2) G_GNUC_NORETURN;
209
void g_assertion_message_cmpnum (const char *domain,
217
char numtype) G_GNUC_NORETURN;
218
void g_assertion_message_error (const char *domain,
225
int error_code) G_GNUC_NORETURN;
226
void g_test_add_vtable (const char *testpath,
228
gconstpointer test_data,
229
GTestFixtureFunc data_setup,
230
GTestFixtureFunc data_test,
231
GTestFixtureFunc data_teardown);
233
gboolean test_initialized;
234
gboolean test_quick; /* disable thorough tests */
235
gboolean test_perf; /* run performance tests */
236
gboolean test_verbose; /* extra info */
237
gboolean test_quiet; /* reduce output */
238
gboolean test_undefined; /* run tests that are meant to assert */
240
GLIB_VAR const GTestConfig * const g_test_config_vars;
242
/* internal logging API */
245
G_TEST_LOG_ERROR, /* s:msg */
246
G_TEST_LOG_START_BINARY, /* s:binaryname s:seed */
247
G_TEST_LOG_LIST_CASE, /* s:testpath */
248
G_TEST_LOG_SKIP_CASE, /* s:testpath */
249
G_TEST_LOG_START_CASE, /* s:testpath */
250
G_TEST_LOG_STOP_CASE, /* d:status d:nforks d:elapsed */
251
G_TEST_LOG_MIN_RESULT, /* s:blurb d:result */
252
G_TEST_LOG_MAX_RESULT, /* s:blurb d:result */
253
G_TEST_LOG_MESSAGE /* s:blurb */
257
GTestLogType log_type;
259
gchar **strings; /* NULL terminated */
269
const char* g_test_log_type_name (GTestLogType log_type);
270
GTestLogBuffer* g_test_log_buffer_new (void);
271
void g_test_log_buffer_free (GTestLogBuffer *tbuffer);
272
void g_test_log_buffer_push (GTestLogBuffer *tbuffer,
274
const guint8 *bytes);
275
GTestLogMsg* g_test_log_buffer_pop (GTestLogBuffer *tbuffer);
276
void g_test_log_msg_free (GTestLogMsg *tmsg);
280
* @log_domain: the log domain of the message
281
* @log_level: the log level of the message (including the fatal and recursion flags)
282
* @message: the message to process
283
* @user_data: user data, set in g_test_log_set_fatal_handler()
285
* Specifies the prototype of fatal log handler functions.
287
* Return value: %TRUE if the program should abort, %FALSE otherwise
291
typedef gboolean (*GTestLogFatalFunc) (const gchar *log_domain,
292
GLogLevelFlags log_level,
293
const gchar *message,
296
g_test_log_set_fatal_handler (GTestLogFatalFunc log_func,
301
#endif /* __G_TEST_UTILS_H__ */