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(G_DISABLE_SINGLE_INCLUDES) && !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;
39 #define g_assert_cmpstr(s1, cmp, s2) do { const char *__s1 = (s1), *__s2 = (s2); \
40 if (g_strcmp0 (__s1, __s2) cmp 0) ; else \
41 g_assertion_message_cmpstr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
42 #s1 " " #cmp " " #s2, __s1, #cmp, __s2); } while (0)
43 #define g_assert_cmpint(n1, cmp, n2) do { gint64 __n1 = (n1), __n2 = (n2); \
44 if (__n1 cmp __n2) ; else \
45 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
46 #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'i'); } while (0)
47 #define g_assert_cmpuint(n1, cmp, n2) do { guint64 __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_cmphex(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, 'x'); } while (0)
55 #define g_assert_cmpfloat(n1,cmp,n2) do { long double __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, 'f'); } while (0)
59 #define g_assert_no_error(err) do { if (err) \
60 g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
61 #err, err, 0, 0); } while (0)
62 #define g_assert_error(err, dom, c) do { if (!err || (err)->domain != dom || (err)->code != c) \
63 g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
64 #err, err, dom, c); } while (0)
65 #ifdef G_DISABLE_ASSERT
66 #define g_assert_not_reached() do { (void) 0; } while (0)
67 #define g_assert(expr) do { (void) 0; } while (0)
68 #else /* !G_DISABLE_ASSERT */
69 #define g_assert_not_reached() do { g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); } while (0)
70 #define g_assert(expr) do { if G_LIKELY (expr) ; else \
71 g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
73 #endif /* !G_DISABLE_ASSERT */
75 int g_strcmp0 (const char *str1,
78 /* report performance results */
79 void g_test_minimized_result (double minimized_quantity,
81 ...) G_GNUC_PRINTF (2, 3);
82 void g_test_maximized_result (double maximized_quantity,
84 ...) G_GNUC_PRINTF (2, 3);
86 /* initialize testing framework */
87 void g_test_init (int *argc,
90 /* query testing framework config */
91 #define g_test_quick() (g_test_config_vars->test_quick)
92 #define g_test_slow() (!g_test_config_vars->test_quick)
93 #define g_test_thorough() (!g_test_config_vars->test_quick)
94 #define g_test_perf() (g_test_config_vars->test_perf)
95 #define g_test_verbose() (g_test_config_vars->test_verbose)
96 #define g_test_quiet() (g_test_config_vars->test_quiet)
97 /* run all tests under toplevel suite (path: /) */
98 int g_test_run (void);
99 /* hook up a test functions under test path */
100 void g_test_add_func (const char *testpath,
101 void (*test_func) (void));
102 void g_test_add_data_func (const char *testpath,
103 gconstpointer test_data,
104 void (*test_func) (gconstpointer));
105 /* hook up a test with fixture under test path */
106 #define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
108 void (*add_vtable) (const char*, \
111 void (*) (Fixture*, gconstpointer), \
112 void (*) (Fixture*, gconstpointer), \
113 void (*) (Fixture*, gconstpointer)) = (void (*) (const gchar *, gsize, gconstpointer, void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer))) g_test_add_vtable; \
115 (testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown); \
118 /* add test messages to the test report */
119 void g_test_message (const char *format,
120 ...) G_GNUC_PRINTF (1, 2);
121 void g_test_bug_base (const char *uri_pattern);
122 void g_test_bug (const char *bug_uri_snippet);
123 /* measure test timings */
124 void g_test_timer_start (void);
125 double g_test_timer_elapsed (void); /* elapsed seconds */
126 double g_test_timer_last (void); /* repeat last elapsed() result */
128 /* automatically g_free or g_object_unref upon teardown */
129 void g_test_queue_free (gpointer gfree_pointer);
130 void g_test_queue_destroy (GDestroyNotify destroy_func,
131 gpointer destroy_data);
132 #define g_test_queue_unref(gobject) g_test_queue_destroy (g_object_unref, gobject)
134 /* test traps are guards used around forked tests */
136 G_TEST_TRAP_SILENCE_STDOUT = 1 << 7,
137 G_TEST_TRAP_SILENCE_STDERR = 1 << 8,
138 G_TEST_TRAP_INHERIT_STDIN = 1 << 9
140 gboolean g_test_trap_fork (guint64 usec_timeout,
141 GTestTrapFlags test_trap_flags);
142 gboolean g_test_trap_has_passed (void);
143 gboolean g_test_trap_reached_timeout (void);
144 #define g_test_trap_assert_passed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0)
145 #define g_test_trap_assert_failed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 1, 0)
146 #define g_test_trap_assert_stdout(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 2, soutpattern)
147 #define g_test_trap_assert_stdout_unmatched(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 3, soutpattern)
148 #define g_test_trap_assert_stderr(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 4, serrpattern)
149 #define g_test_trap_assert_stderr_unmatched(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 5, serrpattern)
151 /* provide seed-able random numbers for tests */
152 #define g_test_rand_bit() (0 != (g_test_rand_int() & (1 << 15)))
153 gint32 g_test_rand_int (void);
154 gint32 g_test_rand_int_range (gint32 begin,
156 double g_test_rand_double (void);
157 double g_test_rand_double_range (double range_start,
160 /* semi-internal API */
161 GTestCase* g_test_create_case (const char *test_name,
163 gconstpointer test_data,
164 void (*data_setup) (void),
165 void (*data_test) (void),
166 void (*data_teardown) (void));
167 GTestSuite* g_test_create_suite (const char *suite_name);
168 GTestSuite* g_test_get_root (void);
169 void g_test_suite_add (GTestSuite *suite,
170 GTestCase *test_case);
171 void g_test_suite_add_suite (GTestSuite *suite,
172 GTestSuite *nestedsuite);
173 int g_test_run_suite (GTestSuite *suite);
176 void g_test_trap_assertions (const char *domain,
180 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
181 const char *pattern);
182 void g_assertion_message (const char *domain,
186 const char *message) G_GNUC_NORETURN;
187 void g_assertion_message_expr (const char *domain,
191 const char *expr) G_GNUC_NORETURN;
192 void g_assertion_message_cmpstr (const char *domain,
199 const char *arg2) G_GNUC_NORETURN;
200 void g_assertion_message_cmpnum (const char *domain,
208 char numtype) G_GNUC_NORETURN;
209 void g_assertion_message_error (const char *domain,
216 int error_code) G_GNUC_NORETURN;
217 void g_test_add_vtable (const char *testpath,
219 gconstpointer test_data,
220 void (*data_setup) (void),
221 void (*data_test) (void),
222 void (*data_teardown) (void));
224 gboolean test_initialized;
225 gboolean test_quick; /* disable thorough tests */
226 gboolean test_perf; /* run performance tests */
227 gboolean test_verbose; /* extra info */
228 gboolean test_quiet; /* reduce output */
230 GLIB_VAR const GTestConfig * const g_test_config_vars;
232 /* internal logging API */
235 G_TEST_LOG_ERROR, /* s:msg */
236 G_TEST_LOG_START_BINARY, /* s:binaryname s:seed */
237 G_TEST_LOG_LIST_CASE, /* s:testpath */
238 G_TEST_LOG_SKIP_CASE, /* s:testpath */
239 G_TEST_LOG_START_CASE, /* s:testpath */
240 G_TEST_LOG_STOP_CASE, /* d:status d:nforks d:elapsed */
241 G_TEST_LOG_MIN_RESULT, /* s:blurb d:result */
242 G_TEST_LOG_MAX_RESULT, /* s:blurb d:result */
243 G_TEST_LOG_MESSAGE /* s:blurb */
247 GTestLogType log_type;
249 gchar **strings; /* NULL terminated */
259 const char* g_test_log_type_name (GTestLogType log_type);
260 GTestLogBuffer* g_test_log_buffer_new (void);
261 void g_test_log_buffer_free (GTestLogBuffer *tbuffer);
262 void g_test_log_buffer_push (GTestLogBuffer *tbuffer,
264 const guint8 *bytes);
265 GTestLogMsg* g_test_log_buffer_pop (GTestLogBuffer *tbuffer);
266 void g_test_log_msg_free (GTestLogMsg *tmsg);
270 * @log_domain: the log domain of the message
271 * @log_level: the log level of the message (including the fatal and recursion flags)
272 * @message: the message to process
273 * @user_data: user data, set in g_test_log_set_fatal_handler()
275 * Specifies the prototype of fatal log handler functions.
277 * Return value: %TRUE if the program should abort, %FALSE otherwise
281 typedef gboolean (*GTestLogFatalFunc) (const gchar *log_domain,
282 GLogLevelFlags log_level,
283 const gchar *message,
286 g_test_log_set_fatal_handler (GTestLogFatalFunc log_func,
291 #endif /* __G_TEST_UTILS_H__ */