Merge branch '896-variant-type-docs' into 'master'
[glib.git] / glib / gtestutils.h
blob02ab397b3874f36923869e4bf86b50b98e76e78e
1 /* GLib testing utilities
2 * Copyright (C) 2007 Imendio AB
3 * Authors: Tim Janik
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.1 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, see <http://www.gnu.org/licenses/>.
19 #ifndef __G_TEST_UTILS_H__
20 #define __G_TEST_UTILS_H__
22 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
23 #error "Only <glib.h> can be included directly."
24 #endif
26 #include <glib/gmessages.h>
27 #include <glib/gstring.h>
28 #include <glib/gerror.h>
29 #include <glib/gslist.h>
30 #include <string.h>
32 G_BEGIN_DECLS
34 typedef struct GTestCase GTestCase;
35 typedef struct GTestSuite GTestSuite;
36 typedef void (*GTestFunc) (void);
37 typedef void (*GTestDataFunc) (gconstpointer user_data);
38 typedef void (*GTestFixtureFunc) (gpointer fixture,
39 gconstpointer user_data);
41 /* assertion API */
42 #define g_assert_cmpstr(s1, cmp, s2) G_STMT_START { \
43 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); \
47 } G_STMT_END
48 #define g_assert_cmpint(n1, cmp, n2) G_STMT_START { \
49 gint64 __n1 = (n1), __n2 = (n2); \
50 if (__n1 cmp __n2) ; else \
51 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
52 #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'i'); \
53 } G_STMT_END
54 #define g_assert_cmpuint(n1, cmp, n2) G_STMT_START { \
55 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, (long double) __n1, #cmp, (long double) __n2, 'i'); \
59 } G_STMT_END
60 #define g_assert_cmphex(n1, cmp, n2) G_STMT_START {\
61 guint64 __n1 = (n1), __n2 = (n2); \
62 if (__n1 cmp __n2) ; else \
63 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
64 #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'x'); \
65 } G_STMT_END
66 #define g_assert_cmpfloat(n1,cmp,n2) G_STMT_START { \
67 long double __n1 = (n1), __n2 = (n2); \
68 if (__n1 cmp __n2) ; else \
69 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
70 #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'f'); \
71 } G_STMT_END
72 #define g_assert_cmpfloat_with_epsilon(n1,n2,epsilon) \
73 G_STMT_START { \
74 double __n1 = (n1), __n2 = (n2), __epsilon = (epsilon); \
75 if (G_APPROX_VALUE (__n1, __n2, __epsilon)) ; else \
76 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
77 #n1 " == " #n2 " (+/- " #epsilon ")", __n1, "==", __n2, 'f'); \
78 } G_STMT_END
79 #define g_assert_cmpmem(m1, l1, m2, l2) G_STMT_START {\
80 gconstpointer __m1 = m1, __m2 = m2; \
81 int __l1 = l1, __l2 = l2; \
82 if (__l1 != __l2) \
83 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
84 #l1 " (len(" #m1 ")) == " #l2 " (len(" #m2 "))", \
85 (long double) __l1, "==", (long double) __l2, 'i'); \
86 else if (__l1 != 0 && memcmp (__m1, __m2, __l1) != 0) \
87 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
88 "assertion failed (" #m1 " == " #m2 ")"); \
89 } G_STMT_END
90 #define g_assert_no_error(err) G_STMT_START { \
91 if (err) \
92 g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
93 #err, err, 0, 0); \
94 } G_STMT_END
95 #define g_assert_error(err, dom, c) G_STMT_START { \
96 if (!err || (err)->domain != dom || (err)->code != c) \
97 g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
98 #err, err, dom, c); \
99 } G_STMT_END
100 #define g_assert_true(expr) G_STMT_START { \
101 if G_LIKELY (expr) ; else \
102 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
103 "'" #expr "' should be TRUE"); \
104 } G_STMT_END
105 #define g_assert_false(expr) G_STMT_START { \
106 if G_LIKELY (!(expr)) ; else \
107 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
108 "'" #expr "' should be FALSE"); \
109 } G_STMT_END
110 #define g_assert_null(expr) G_STMT_START { if G_LIKELY ((expr) == NULL) ; else \
111 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
112 "'" #expr "' should be NULL"); \
113 } G_STMT_END
114 #define g_assert_nonnull(expr) G_STMT_START { \
115 if G_LIKELY ((expr) != NULL) ; else \
116 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
117 "'" #expr "' should not be NULL"); \
118 } G_STMT_END
119 #ifdef G_DISABLE_ASSERT
120 #define g_assert_not_reached() G_STMT_START { (void) 0; } G_STMT_END
121 #define g_assert(expr) G_STMT_START { (void) 0; } G_STMT_END
122 #else /* !G_DISABLE_ASSERT */
123 #define g_assert_not_reached() G_STMT_START { g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); } G_STMT_END
124 #define g_assert(expr) G_STMT_START { \
125 if G_LIKELY (expr) ; else \
126 g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
127 #expr); \
128 } G_STMT_END
129 #endif /* !G_DISABLE_ASSERT */
131 GLIB_AVAILABLE_IN_ALL
132 int g_strcmp0 (const char *str1,
133 const char *str2);
135 /* report performance results */
136 GLIB_AVAILABLE_IN_ALL
137 void g_test_minimized_result (double minimized_quantity,
138 const char *format,
139 ...) G_GNUC_PRINTF (2, 3);
140 GLIB_AVAILABLE_IN_ALL
141 void g_test_maximized_result (double maximized_quantity,
142 const char *format,
143 ...) G_GNUC_PRINTF (2, 3);
145 /* initialize testing framework */
146 GLIB_AVAILABLE_IN_ALL
147 void g_test_init (int *argc,
148 char ***argv,
149 ...) G_GNUC_NULL_TERMINATED;
150 /* query testing framework config */
151 #define g_test_initialized() (g_test_config_vars->test_initialized)
152 #define g_test_quick() (g_test_config_vars->test_quick)
153 #define g_test_slow() (!g_test_config_vars->test_quick)
154 #define g_test_thorough() (!g_test_config_vars->test_quick)
155 #define g_test_perf() (g_test_config_vars->test_perf)
156 #define g_test_verbose() (g_test_config_vars->test_verbose)
157 #define g_test_quiet() (g_test_config_vars->test_quiet)
158 #define g_test_undefined() (g_test_config_vars->test_undefined)
159 GLIB_AVAILABLE_IN_2_38
160 gboolean g_test_subprocess (void);
162 /* run all tests under toplevel suite (path: /) */
163 GLIB_AVAILABLE_IN_ALL
164 int g_test_run (void);
165 /* hook up a test functions under test path */
166 GLIB_AVAILABLE_IN_ALL
167 void g_test_add_func (const char *testpath,
168 GTestFunc test_func);
170 GLIB_AVAILABLE_IN_ALL
171 void g_test_add_data_func (const char *testpath,
172 gconstpointer test_data,
173 GTestDataFunc test_func);
175 GLIB_AVAILABLE_IN_2_34
176 void g_test_add_data_func_full (const char *testpath,
177 gpointer test_data,
178 GTestDataFunc test_func,
179 GDestroyNotify data_free_func);
181 /* tell about failure */
182 GLIB_AVAILABLE_IN_2_30
183 void g_test_fail (void);
184 GLIB_AVAILABLE_IN_2_38
185 void g_test_incomplete (const gchar *msg);
186 GLIB_AVAILABLE_IN_2_38
187 void g_test_skip (const gchar *msg);
188 GLIB_AVAILABLE_IN_2_38
189 gboolean g_test_failed (void);
190 GLIB_AVAILABLE_IN_2_38
191 void g_test_set_nonfatal_assertions (void);
193 /* hook up a test with fixture under test path */
194 #define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
195 G_STMT_START { \
196 void (*add_vtable) (const char*, \
197 gsize, \
198 gconstpointer, \
199 void (*) (Fixture*, gconstpointer), \
200 void (*) (Fixture*, gconstpointer), \
201 void (*) (Fixture*, gconstpointer)) = (void (*) (const gchar *, gsize, gconstpointer, void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer))) g_test_add_vtable; \
202 add_vtable \
203 (testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown); \
204 } G_STMT_END
206 /* add test messages to the test report */
207 GLIB_AVAILABLE_IN_ALL
208 void g_test_message (const char *format,
209 ...) G_GNUC_PRINTF (1, 2);
210 GLIB_AVAILABLE_IN_ALL
211 void g_test_bug_base (const char *uri_pattern);
212 GLIB_AVAILABLE_IN_ALL
213 void g_test_bug (const char *bug_uri_snippet);
214 /* measure test timings */
215 GLIB_AVAILABLE_IN_ALL
216 void g_test_timer_start (void);
217 GLIB_AVAILABLE_IN_ALL
218 double g_test_timer_elapsed (void); /* elapsed seconds */
219 GLIB_AVAILABLE_IN_ALL
220 double g_test_timer_last (void); /* repeat last elapsed() result */
222 /* automatically g_free or g_object_unref upon teardown */
223 GLIB_AVAILABLE_IN_ALL
224 void g_test_queue_free (gpointer gfree_pointer);
225 GLIB_AVAILABLE_IN_ALL
226 void g_test_queue_destroy (GDestroyNotify destroy_func,
227 gpointer destroy_data);
228 #define g_test_queue_unref(gobject) g_test_queue_destroy (g_object_unref, gobject)
230 typedef enum {
231 G_TEST_TRAP_SILENCE_STDOUT = 1 << 7,
232 G_TEST_TRAP_SILENCE_STDERR = 1 << 8,
233 G_TEST_TRAP_INHERIT_STDIN = 1 << 9
234 } GTestTrapFlags;
236 GLIB_DEPRECATED_IN_2_38_FOR (g_test_trap_subprocess)
237 gboolean g_test_trap_fork (guint64 usec_timeout,
238 GTestTrapFlags test_trap_flags);
240 typedef enum {
241 G_TEST_SUBPROCESS_INHERIT_STDIN = 1 << 0,
242 G_TEST_SUBPROCESS_INHERIT_STDOUT = 1 << 1,
243 G_TEST_SUBPROCESS_INHERIT_STDERR = 1 << 2
244 } GTestSubprocessFlags;
246 GLIB_AVAILABLE_IN_2_38
247 void g_test_trap_subprocess (const char *test_path,
248 guint64 usec_timeout,
249 GTestSubprocessFlags test_flags);
251 GLIB_AVAILABLE_IN_ALL
252 gboolean g_test_trap_has_passed (void);
253 GLIB_AVAILABLE_IN_ALL
254 gboolean g_test_trap_reached_timeout (void);
255 #define g_test_trap_assert_passed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0)
256 #define g_test_trap_assert_failed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 1, 0)
257 #define g_test_trap_assert_stdout(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 2, soutpattern)
258 #define g_test_trap_assert_stdout_unmatched(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 3, soutpattern)
259 #define g_test_trap_assert_stderr(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 4, serrpattern)
260 #define g_test_trap_assert_stderr_unmatched(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 5, serrpattern)
262 /* provide seed-able random numbers for tests */
263 #define g_test_rand_bit() (0 != (g_test_rand_int() & (1 << 15)))
264 GLIB_AVAILABLE_IN_ALL
265 gint32 g_test_rand_int (void);
266 GLIB_AVAILABLE_IN_ALL
267 gint32 g_test_rand_int_range (gint32 begin,
268 gint32 end);
269 GLIB_AVAILABLE_IN_ALL
270 double g_test_rand_double (void);
271 GLIB_AVAILABLE_IN_ALL
272 double g_test_rand_double_range (double range_start,
273 double range_end);
276 * semi-internal API: non-documented symbols with stable ABI. You
277 * should use the non-internal helper macros instead. However, for
278 * compatibility reason, you may use this semi-internal API.
280 GLIB_AVAILABLE_IN_ALL
281 GTestCase* g_test_create_case (const char *test_name,
282 gsize data_size,
283 gconstpointer test_data,
284 GTestFixtureFunc data_setup,
285 GTestFixtureFunc data_test,
286 GTestFixtureFunc data_teardown);
287 GLIB_AVAILABLE_IN_ALL
288 GTestSuite* g_test_create_suite (const char *suite_name);
289 GLIB_AVAILABLE_IN_ALL
290 GTestSuite* g_test_get_root (void);
291 GLIB_AVAILABLE_IN_ALL
292 void g_test_suite_add (GTestSuite *suite,
293 GTestCase *test_case);
294 GLIB_AVAILABLE_IN_ALL
295 void g_test_suite_add_suite (GTestSuite *suite,
296 GTestSuite *nestedsuite);
297 GLIB_AVAILABLE_IN_ALL
298 int g_test_run_suite (GTestSuite *suite);
300 GLIB_AVAILABLE_IN_ALL
301 void g_test_trap_assertions (const char *domain,
302 const char *file,
303 int line,
304 const char *func,
305 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
306 const char *pattern);
307 GLIB_AVAILABLE_IN_ALL
308 void g_assertion_message (const char *domain,
309 const char *file,
310 int line,
311 const char *func,
312 const char *message);
313 GLIB_AVAILABLE_IN_ALL
314 void g_assertion_message_expr (const char *domain,
315 const char *file,
316 int line,
317 const char *func,
318 const char *expr) G_GNUC_NORETURN;
319 GLIB_AVAILABLE_IN_ALL
320 void g_assertion_message_cmpstr (const char *domain,
321 const char *file,
322 int line,
323 const char *func,
324 const char *expr,
325 const char *arg1,
326 const char *cmp,
327 const char *arg2);
328 GLIB_AVAILABLE_IN_ALL
329 void g_assertion_message_cmpnum (const char *domain,
330 const char *file,
331 int line,
332 const char *func,
333 const char *expr,
334 long double arg1,
335 const char *cmp,
336 long double arg2,
337 char numtype);
338 GLIB_AVAILABLE_IN_ALL
339 void g_assertion_message_error (const char *domain,
340 const char *file,
341 int line,
342 const char *func,
343 const char *expr,
344 const GError *error,
345 GQuark error_domain,
346 int error_code);
347 GLIB_AVAILABLE_IN_ALL
348 void g_test_add_vtable (const char *testpath,
349 gsize data_size,
350 gconstpointer test_data,
351 GTestFixtureFunc data_setup,
352 GTestFixtureFunc data_test,
353 GTestFixtureFunc data_teardown);
354 typedef struct {
355 gboolean test_initialized;
356 gboolean test_quick; /* disable thorough tests */
357 gboolean test_perf; /* run performance tests */
358 gboolean test_verbose; /* extra info */
359 gboolean test_quiet; /* reduce output */
360 gboolean test_undefined; /* run tests that are meant to assert */
361 } GTestConfig;
362 GLIB_VAR const GTestConfig * const g_test_config_vars;
364 /* internal logging API */
365 typedef enum {
366 G_TEST_RUN_SUCCESS,
367 G_TEST_RUN_SKIPPED,
368 G_TEST_RUN_FAILURE,
369 G_TEST_RUN_INCOMPLETE
370 } GTestResult;
372 typedef enum {
373 G_TEST_LOG_NONE,
374 G_TEST_LOG_ERROR, /* s:msg */
375 G_TEST_LOG_START_BINARY, /* s:binaryname s:seed */
376 G_TEST_LOG_LIST_CASE, /* s:testpath */
377 G_TEST_LOG_SKIP_CASE, /* s:testpath */
378 G_TEST_LOG_START_CASE, /* s:testpath */
379 G_TEST_LOG_STOP_CASE, /* d:status d:nforks d:elapsed */
380 G_TEST_LOG_MIN_RESULT, /* s:blurb d:result */
381 G_TEST_LOG_MAX_RESULT, /* s:blurb d:result */
382 G_TEST_LOG_MESSAGE, /* s:blurb */
383 G_TEST_LOG_START_SUITE,
384 G_TEST_LOG_STOP_SUITE
385 } GTestLogType;
387 typedef struct {
388 GTestLogType log_type;
389 guint n_strings;
390 gchar **strings; /* NULL terminated */
391 guint n_nums;
392 long double *nums;
393 } GTestLogMsg;
394 typedef struct {
395 /*< private >*/
396 GString *data;
397 GSList *msgs;
398 } GTestLogBuffer;
400 GLIB_AVAILABLE_IN_ALL
401 const char* g_test_log_type_name (GTestLogType log_type);
402 GLIB_AVAILABLE_IN_ALL
403 GTestLogBuffer* g_test_log_buffer_new (void);
404 GLIB_AVAILABLE_IN_ALL
405 void g_test_log_buffer_free (GTestLogBuffer *tbuffer);
406 GLIB_AVAILABLE_IN_ALL
407 void g_test_log_buffer_push (GTestLogBuffer *tbuffer,
408 guint n_bytes,
409 const guint8 *bytes);
410 GLIB_AVAILABLE_IN_ALL
411 GTestLogMsg* g_test_log_buffer_pop (GTestLogBuffer *tbuffer);
412 GLIB_AVAILABLE_IN_ALL
413 void g_test_log_msg_free (GTestLogMsg *tmsg);
416 * GTestLogFatalFunc:
417 * @log_domain: the log domain of the message
418 * @log_level: the log level of the message (including the fatal and recursion flags)
419 * @message: the message to process
420 * @user_data: user data, set in g_test_log_set_fatal_handler()
422 * Specifies the prototype of fatal log handler functions.
424 * Returns: %TRUE if the program should abort, %FALSE otherwise
426 * Since: 2.22
428 typedef gboolean (*GTestLogFatalFunc) (const gchar *log_domain,
429 GLogLevelFlags log_level,
430 const gchar *message,
431 gpointer user_data);
432 GLIB_AVAILABLE_IN_ALL
433 void
434 g_test_log_set_fatal_handler (GTestLogFatalFunc log_func,
435 gpointer user_data);
437 GLIB_AVAILABLE_IN_2_34
438 void g_test_expect_message (const gchar *log_domain,
439 GLogLevelFlags log_level,
440 const gchar *pattern);
441 GLIB_AVAILABLE_IN_2_34
442 void g_test_assert_expected_messages_internal (const char *domain,
443 const char *file,
444 int line,
445 const char *func);
447 typedef enum
449 G_TEST_DIST,
450 G_TEST_BUILT
451 } GTestFileType;
453 GLIB_AVAILABLE_IN_2_38
454 gchar * g_test_build_filename (GTestFileType file_type,
455 const gchar *first_path,
456 ...) G_GNUC_NULL_TERMINATED;
457 GLIB_AVAILABLE_IN_2_38
458 const gchar *g_test_get_dir (GTestFileType file_type);
459 GLIB_AVAILABLE_IN_2_38
460 const gchar *g_test_get_filename (GTestFileType file_type,
461 const gchar *first_path,
462 ...) G_GNUC_NULL_TERMINATED;
464 #define g_test_assert_expected_messages() g_test_assert_expected_messages_internal (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC)
466 G_END_DECLS
468 #endif /* __G_TEST_UTILS_H__ */