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;
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 /* run all tests under toplevel suite (path: /) */
102 int g_test_run (void);
103 /* hook up a test functions under test path */
104 void g_test_add_func (const char *testpath,
105 GTestFunc test_func);
107 void g_test_add_data_func (const char *testpath,
108 gconstpointer test_data,
109 GTestDataFunc test_func);
111 /* hook up a test with fixture under test path */
112 #define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
114 void (*add_vtable) (const char*, \
117 void (*) (Fixture*, gconstpointer), \
118 void (*) (Fixture*, gconstpointer), \
119 void (*) (Fixture*, gconstpointer)) = (void (*) (const gchar *, gsize, gconstpointer, void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer))) g_test_add_vtable; \
121 (testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown); \
124 /* add test messages to the test report */
125 void g_test_message (const char *format,
126 ...) G_GNUC_PRINTF (1, 2);
127 void g_test_bug_base (const char *uri_pattern);
128 void g_test_bug (const char *bug_uri_snippet);
129 /* measure test timings */
130 void g_test_timer_start (void);
131 double g_test_timer_elapsed (void); /* elapsed seconds */
132 double g_test_timer_last (void); /* repeat last elapsed() result */
134 /* automatically g_free or g_object_unref upon teardown */
135 void g_test_queue_free (gpointer gfree_pointer);
136 void g_test_queue_destroy (GDestroyNotify destroy_func,
137 gpointer destroy_data);
138 #define g_test_queue_unref(gobject) g_test_queue_destroy (g_object_unref, gobject)
140 /* test traps are guards used around forked tests */
142 G_TEST_TRAP_SILENCE_STDOUT = 1 << 7,
143 G_TEST_TRAP_SILENCE_STDERR = 1 << 8,
144 G_TEST_TRAP_INHERIT_STDIN = 1 << 9
146 gboolean g_test_trap_fork (guint64 usec_timeout,
147 GTestTrapFlags test_trap_flags);
148 gboolean g_test_trap_has_passed (void);
149 gboolean g_test_trap_reached_timeout (void);
150 #define g_test_trap_assert_passed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0)
151 #define g_test_trap_assert_failed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 1, 0)
152 #define g_test_trap_assert_stdout(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 2, soutpattern)
153 #define g_test_trap_assert_stdout_unmatched(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 3, soutpattern)
154 #define g_test_trap_assert_stderr(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 4, serrpattern)
155 #define g_test_trap_assert_stderr_unmatched(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 5, serrpattern)
157 /* provide seed-able random numbers for tests */
158 #define g_test_rand_bit() (0 != (g_test_rand_int() & (1 << 15)))
159 gint32 g_test_rand_int (void);
160 gint32 g_test_rand_int_range (gint32 begin,
162 double g_test_rand_double (void);
163 double g_test_rand_double_range (double range_start,
166 /* semi-internal API */
167 GTestCase* g_test_create_case (const char *test_name,
169 gconstpointer test_data,
170 GTestFixtureFunc data_setup,
171 GTestFixtureFunc data_test,
172 GTestFixtureFunc data_teardown);
173 GTestSuite* g_test_create_suite (const char *suite_name);
174 GTestSuite* g_test_get_root (void);
175 void g_test_suite_add (GTestSuite *suite,
176 GTestCase *test_case);
177 void g_test_suite_add_suite (GTestSuite *suite,
178 GTestSuite *nestedsuite);
179 int g_test_run_suite (GTestSuite *suite);
182 void g_test_trap_assertions (const char *domain,
186 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
187 const char *pattern);
188 void g_assertion_message (const char *domain,
192 const char *message) G_GNUC_NORETURN;
193 void g_assertion_message_expr (const char *domain,
197 const char *expr) G_GNUC_NORETURN;
198 void g_assertion_message_cmpstr (const char *domain,
205 const char *arg2) G_GNUC_NORETURN;
206 void g_assertion_message_cmpnum (const char *domain,
214 char numtype) G_GNUC_NORETURN;
215 void g_assertion_message_error (const char *domain,
222 int error_code) G_GNUC_NORETURN;
223 void g_test_add_vtable (const char *testpath,
225 gconstpointer test_data,
226 GTestFixtureFunc data_setup,
227 GTestFixtureFunc data_test,
228 GTestFixtureFunc data_teardown);
230 gboolean test_initialized;
231 gboolean test_quick; /* disable thorough tests */
232 gboolean test_perf; /* run performance tests */
233 gboolean test_verbose; /* extra info */
234 gboolean test_quiet; /* reduce output */
236 GLIB_VAR const GTestConfig * const g_test_config_vars;
238 /* internal logging API */
241 G_TEST_LOG_ERROR, /* s:msg */
242 G_TEST_LOG_START_BINARY, /* s:binaryname s:seed */
243 G_TEST_LOG_LIST_CASE, /* s:testpath */
244 G_TEST_LOG_SKIP_CASE, /* s:testpath */
245 G_TEST_LOG_START_CASE, /* s:testpath */
246 G_TEST_LOG_STOP_CASE, /* d:status d:nforks d:elapsed */
247 G_TEST_LOG_MIN_RESULT, /* s:blurb d:result */
248 G_TEST_LOG_MAX_RESULT, /* s:blurb d:result */
249 G_TEST_LOG_MESSAGE /* s:blurb */
253 GTestLogType log_type;
255 gchar **strings; /* NULL terminated */
265 const char* g_test_log_type_name (GTestLogType log_type);
266 GTestLogBuffer* g_test_log_buffer_new (void);
267 void g_test_log_buffer_free (GTestLogBuffer *tbuffer);
268 void g_test_log_buffer_push (GTestLogBuffer *tbuffer,
270 const guint8 *bytes);
271 GTestLogMsg* g_test_log_buffer_pop (GTestLogBuffer *tbuffer);
272 void g_test_log_msg_free (GTestLogMsg *tmsg);
276 * @log_domain: the log domain of the message
277 * @log_level: the log level of the message (including the fatal and recursion flags)
278 * @message: the message to process
279 * @user_data: user data, set in g_test_log_set_fatal_handler()
281 * Specifies the prototype of fatal log handler functions.
283 * Return value: %TRUE if the program should abort, %FALSE otherwise
287 typedef gboolean (*GTestLogFatalFunc) (const gchar *log_domain,
288 GLogLevelFlags log_level,
289 const gchar *message,
292 g_test_log_set_fatal_handler (GTestLogFatalFunc log_func,
297 #endif /* __G_TEST_UTILS_H__ */