1 /* GLib testing utilities
2 * Copyright (C) 2007 Imendio AB
5 * SPDX-License-Identifier: LGPL-2.1-or-later
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 #ifndef __G_TEST_UTILS_H__
22 #define __G_TEST_UTILS_H__
24 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
25 #error "Only <glib.h> can be included directly."
28 #include <glib/gmessages.h>
29 #include <glib/gstring.h>
30 #include <glib/gerror.h>
31 #include <glib/gslist.h>
38 typedef struct GTestCase GTestCase;
39 typedef struct GTestSuite GTestSuite;
40 typedef void (*GTestFunc) (void);
41 typedef void (*GTestDataFunc) (gconstpointer user_data);
42 typedef void (*GTestFixtureFunc) (gpointer fixture,
43 gconstpointer user_data);
46 #define g_assert_cmpstr(s1, cmp, s2) G_STMT_START { \
47 const char *__s1 = (s1), *__s2 = (s2); \
48 if (g_strcmp0 (__s1, __s2) cmp 0) ; else \
49 g_assertion_message_cmpstr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
50 #s1 " " #cmp " " #s2, __s1, #cmp, __s2); \
52 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_78
53 #define g_assert_cmpint(n1, cmp, n2) G_STMT_START { \
54 gint64 __n1 = (n1), __n2 = (n2); \
55 if (__n1 cmp __n2) ; else \
56 g_assertion_message_cmpint (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
57 #n1 " " #cmp " " #n2, (guint64)__n1, #cmp, (guint64)__n2, 'i'); \
59 #define g_assert_cmpuint(n1, cmp, n2) G_STMT_START { \
60 guint64 __n1 = (n1), __n2 = (n2); \
61 if (__n1 cmp __n2) ; else \
62 g_assertion_message_cmpint (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
63 #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'u'); \
65 #define g_assert_cmphex(n1, cmp, n2) G_STMT_START { \
66 guint64 __n1 = (n1), __n2 = (n2); \
67 if (__n1 cmp __n2) ; else \
68 g_assertion_message_cmpint (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
69 #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'x'); \
71 #else /* GLIB_VERSION_MIN_REQUIRED < GLIB_VERSION_2_78 */
72 #define g_assert_cmpint(n1, cmp, n2) G_STMT_START { \
73 gint64 __n1 = (n1), __n2 = (n2); \
74 if (__n1 cmp __n2) ; else \
75 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
76 #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'i'); \
78 #define g_assert_cmpuint(n1, cmp, n2) G_STMT_START { \
79 guint64 __n1 = (n1), __n2 = (n2); \
80 if (__n1 cmp __n2) ; else \
81 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
82 #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'i'); \
84 #define g_assert_cmphex(n1, cmp, n2) G_STMT_START {\
85 guint64 __n1 = (n1), __n2 = (n2); \
86 if (__n1 cmp __n2) ; else \
87 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
88 #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'x'); \
90 #endif /* GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_78 */
91 #define g_assert_cmpfloat(n1,cmp,n2) G_STMT_START { \
92 long double __n1 = (long double) (n1), __n2 = (long double) (n2); \
93 if (__n1 cmp __n2) ; else \
94 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
95 #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'f'); \
97 #define g_assert_cmpfloat_with_epsilon(n1,n2,epsilon) \
99 double __n1 = (n1), __n2 = (n2), __epsilon = (epsilon); \
100 if (G_APPROX_VALUE (__n1, __n2, __epsilon)) ; else \
101 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
102 #n1 " == " #n2 " (+/- " #epsilon ")", __n1, "==", __n2, 'f'); \
104 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_78
105 #define g_assert_cmpmem(m1, l1, m2, l2) G_STMT_START {\
106 gconstpointer __m1 = m1, __m2 = m2; \
107 size_t __l1 = (size_t) l1, __l2 = (size_t) l2; \
108 if (__l1 != 0 && __m1 == NULL) \
109 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
110 "assertion failed (" #l1 " == 0 || " #m1 " != NULL)"); \
111 else if (__l2 != 0 && __m2 == NULL) \
112 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
113 "assertion failed (" #l2 " == 0 || " #m2 " != NULL)"); \
114 else if (__l1 != __l2) \
115 g_assertion_message_cmpint (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
116 #l1 " (len(" #m1 ")) == " #l2 " (len(" #m2 "))", \
117 __l1, "==", __l2, 'u'); \
118 else if (__l1 != 0 && __m2 != NULL && memcmp (__m1, __m2, __l1) != 0) \
119 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
120 "assertion failed (" #m1 " == " #m2 ")"); \
122 #else /* GLIB_VERSION_MIN_REQUIRED < GLIB_VERSION_2_78 */
123 #define g_assert_cmpmem(m1, l1, m2, l2) G_STMT_START {\
124 gconstpointer __m1 = m1, __m2 = m2; \
125 size_t __l1 = (size_t) l1, __l2 = (size_t) l2; \
126 if (__l1 != 0 && __m1 == NULL) \
127 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
128 "assertion failed (" #l1 " == 0 || " #m1 " != NULL)"); \
129 else if (__l2 != 0 && __m2 == NULL) \
130 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
131 "assertion failed (" #l2 " == 0 || " #m2 " != NULL)"); \
132 else if (__l1 != __l2) \
133 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
134 #l1 " (len(" #m1 ")) == " #l2 " (len(" #m2 "))", \
135 (long double) __l1, "==", (long double) __l2, 'i'); \
136 else if (__l1 != 0 && __m2 != NULL && memcmp (__m1, __m2, __l1) != 0) \
137 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
138 "assertion failed (" #m1 " == " #m2 ")"); \
140 #endif /* GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_78 */
141 #define g_assert_cmpvariant(v1, v2) \
144 GVariant *__v1 = (v1), *__v2 = (v2); \
145 if (!g_variant_equal (__v1, __v2)) \
147 gchar *__s1, *__s2, *__msg; \
148 __s1 = g_variant_print (__v1, TRUE); \
149 __s2 = g_variant_print (__v2, TRUE); \
150 __msg = g_strdup_printf ("assertion failed (" #v1 " == " #v2 "): %s does not equal %s", __s1, __s2); \
151 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, __msg); \
158 #define g_assert_cmpstrv(strv1, strv2) \
161 const char * const *__strv1 = (const char * const *) (strv1); \
162 const char * const *__strv2 = (const char * const *) (strv2); \
163 if (!__strv1 || !__strv2) \
167 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
168 "assertion failed (" #strv1 " == " #strv2 "): " #strv2 " is NULL, but " #strv1 " is not"); \
172 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
173 "assertion failed (" #strv1 " == " #strv2 "): " #strv1 " is NULL, but " #strv2 " is not"); \
178 guint __l1 = g_strv_length ((char **) __strv1); \
179 guint __l2 = g_strv_length ((char **) __strv2); \
183 __msg = g_strdup_printf ("assertion failed (" #strv1 " == " #strv2 "): length %u does not equal length %u", __l1, __l2); \
184 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, __msg); \
190 for (__i = 0; __i < __l1; __i++) \
192 if (g_strcmp0 (__strv1[__i], __strv2[__i]) != 0) \
194 g_assertion_message_cmpstrv (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
195 #strv1 " == " #strv2, \
196 __strv1, __strv2, __i); \
203 #define g_assert_no_errno(expr) G_STMT_START { \
204 int __ret, __errsv; \
211 __msg = g_strdup_printf ("assertion failed (" #expr " >= 0): errno %i: %s", __errsv, g_strerror (__errsv)); \
212 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, __msg); \
216 GLIB_AVAILABLE_MACRO_IN_2_66
217 #define g_assert_no_error(err) G_STMT_START { \
219 g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
222 #define g_assert_error(err, dom, c) G_STMT_START { \
223 if (!err || (err)->domain != dom || (err)->code != c) \
224 g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
225 #err, err, dom, c); \
227 #define g_assert_true(expr) G_STMT_START { \
228 if G_LIKELY (expr) ; else \
229 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
230 "'" #expr "' should be TRUE"); \
232 #define g_assert_false(expr) G_STMT_START { \
233 if G_LIKELY (!(expr)) ; else \
234 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
235 "'" #expr "' should be FALSE"); \
238 /* Use nullptr in C++ to catch misuse of these macros. */
239 #if G_CXX_STD_CHECK_VERSION (11)
240 #define g_assert_null(expr) G_STMT_START { if G_LIKELY ((expr) == nullptr) ; else \
241 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
242 "'" #expr "' should be nullptr"); \
244 #define g_assert_nonnull(expr) G_STMT_START { \
245 if G_LIKELY ((expr) != nullptr) ; else \
246 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
247 "'" #expr "' should not be nullptr"); \
250 #define g_assert_null(expr) G_STMT_START { if G_LIKELY ((expr) == NULL) ; else \
251 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
252 "'" #expr "' should be NULL"); \
254 #define g_assert_nonnull(expr) G_STMT_START { \
255 if G_LIKELY ((expr) != NULL) ; else \
256 g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
257 "'" #expr "' should not be NULL"); \
261 #ifdef G_DISABLE_ASSERT
262 /* https://gcc.gnu.org/onlinedocs/gcc-8.3.0/gcc/Other-Builtins.html#index-_005f_005fbuiltin_005funreachable
263 * GCC 5 is not a strict lower bound for versions of GCC which provide __builtin_unreachable(). */
264 #if __GNUC__ >= 5 || g_macro__has_builtin(__builtin_unreachable)
265 #define g_assert_not_reached() G_STMT_START { (void) 0; __builtin_unreachable (); } G_STMT_END
266 #elif defined (_MSC_VER)
267 #define g_assert_not_reached() G_STMT_START { (void) 0; __assume (0); } G_STMT_END
268 #else /* if __builtin_unreachable() is not supported: */
269 #define g_assert_not_reached() G_STMT_START { (void) 0; } G_STMT_END
272 #define g_assert(expr) G_STMT_START { (void) 0; } G_STMT_END
273 #define g_assert_se(expr) ((void) (expr))
274 #else /* !G_DISABLE_ASSERT */
275 #define g_assert_not_reached() G_STMT_START { g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); } G_STMT_END
276 #define g_assert(expr) G_STMT_START { \
277 if G_LIKELY (expr) ; else \
278 g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
281 #define g_assert_se(expr) g_assert((expr))
282 #endif /* !G_DISABLE_ASSERT */
284 GLIB_AVAILABLE_IN_ALL
285 int g_strcmp0 (const char *str1,
288 /* report performance results */
289 GLIB_AVAILABLE_IN_ALL
290 void g_test_minimized_result (double minimized_quantity,
292 ...) G_GNUC_PRINTF (2, 3);
293 GLIB_AVAILABLE_IN_ALL
294 void g_test_maximized_result (double maximized_quantity,
296 ...) G_GNUC_PRINTF (2, 3);
298 /* initialize testing framework */
299 GLIB_AVAILABLE_IN_ALL
300 void g_test_init (int *argc,
302 ...) G_GNUC_NULL_TERMINATED;
305 * G_TEST_OPTION_ISOLATE_DIRS:
307 * Creates a unique temporary directory for each unit test and uses
308 * g_set_user_dirs() to set XDG directories to point into subdirectories of it
309 * for the duration of the unit test. The directory tree is cleaned up after the
310 * test finishes successfully. Note that this doesn’t take effect until
311 * g_test_run() is called, so calls to (for example) g_get_user_home_dir() will
312 * return the system-wide value when made in a test program’s main() function.
314 * The following functions will return subdirectories of the temporary directory
315 * when this option is used. The specific subdirectory paths in use are not
316 * guaranteed to be stable API — always use a getter function to retrieve them.
319 * - g_get_user_cache_dir()
320 * - g_get_system_config_dirs()
321 * - g_get_user_config_dir()
322 * - g_get_system_data_dirs()
323 * - g_get_user_data_dir()
324 * - g_get_user_state_dir()
325 * - g_get_user_runtime_dir()
327 * The subdirectories may not be created by the test harness; as with normal
328 * calls to functions like g_get_user_cache_dir(), the caller must be prepared
329 * to create the directory if it doesn’t exist.
333 #define G_TEST_OPTION_ISOLATE_DIRS "isolate_dirs"
335 /* While we discourage its use, g_assert() is often used in unit tests
336 * (especially in legacy code). g_assert_*() should really be used instead.
337 * g_assert() can be disabled at client program compile time, which can render
338 * tests useless. Highlight that to the user. */
339 #ifdef G_DISABLE_ASSERT
340 #if defined(G_HAVE_ISO_VARARGS)
341 #define g_test_init(argc, argv, ...) \
343 g_printerr ("Tests were compiled with G_DISABLE_ASSERT and are likely no-ops. Aborting.\n"); \
346 #elif defined(G_HAVE_GNUC_VARARGS)
347 #define g_test_init(argc, argv...) \
349 g_printerr ("Tests were compiled with G_DISABLE_ASSERT and are likely no-ops. Aborting.\n"); \
352 #else /* no varargs */
354 #endif /* varargs support */
355 #endif /* G_DISABLE_ASSERT */
357 /* query testing framework config */
358 #define g_test_initialized() (g_test_config_vars->test_initialized)
359 #define g_test_quick() (g_test_config_vars->test_quick)
360 #define g_test_slow() (!g_test_config_vars->test_quick)
361 #define g_test_thorough() (!g_test_config_vars->test_quick)
362 #define g_test_perf() (g_test_config_vars->test_perf)
363 #define g_test_verbose() (g_test_config_vars->test_verbose)
364 #define g_test_quiet() (g_test_config_vars->test_quiet)
365 #define g_test_undefined() (g_test_config_vars->test_undefined)
366 GLIB_AVAILABLE_IN_2_38
367 gboolean g_test_subprocess (void);
369 /* run all tests under toplevel suite (path: /) */
370 GLIB_AVAILABLE_IN_ALL
371 int g_test_run (void);
372 /* hook up a test functions under test path */
373 GLIB_AVAILABLE_IN_ALL
374 void g_test_add_func (const char *testpath,
375 GTestFunc test_func);
377 GLIB_AVAILABLE_IN_ALL
378 void g_test_add_data_func (const char *testpath,
379 gconstpointer test_data,
380 GTestDataFunc test_func);
382 GLIB_AVAILABLE_IN_2_34
383 void g_test_add_data_func_full (const char *testpath,
385 GTestDataFunc test_func,
386 GDestroyNotify data_free_func);
388 /* tell about currently run test */
389 GLIB_AVAILABLE_IN_2_68
390 const char * g_test_get_path (void);
392 /* tell about failure */
393 GLIB_AVAILABLE_IN_2_30
394 void g_test_fail (void);
395 GLIB_AVAILABLE_IN_2_70
396 void g_test_fail_printf (const char *format,
397 ...) G_GNUC_PRINTF (1, 2);
398 GLIB_AVAILABLE_IN_2_38
399 void g_test_incomplete (const gchar *msg);
400 GLIB_AVAILABLE_IN_2_70
401 void g_test_incomplete_printf (const char *format,
402 ...) G_GNUC_PRINTF (1, 2);
403 GLIB_AVAILABLE_IN_2_38
404 void g_test_skip (const gchar *msg);
405 GLIB_AVAILABLE_IN_2_70
406 void g_test_skip_printf (const char *format,
407 ...) G_GNUC_PRINTF (1, 2);
408 GLIB_AVAILABLE_IN_2_38
409 gboolean g_test_failed (void);
410 GLIB_AVAILABLE_IN_2_38
411 void g_test_set_nonfatal_assertions (void);
412 GLIB_AVAILABLE_IN_2_78
413 void g_test_disable_crash_reporting (void);
417 * @testpath: The test path for a new test case.
418 * @Fixture: The type of a fixture data structure.
419 * @tdata: Data argument for the test functions.
420 * @fsetup: The function to set up the fixture data.
421 * @ftest: The actual test function.
422 * @fteardown: The function to tear down the fixture data.
424 * Hook up a new test case at @testpath, similar to g_test_add_func().
425 * A fixture data structure with setup and teardown functions may be provided,
426 * similar to g_test_create_case().
428 * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
429 * fteardown() callbacks can expect a @Fixture pointer as their first argument
430 * in a type safe manner. They otherwise have type #GTestFixtureFunc.
434 #define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
436 void (*add_vtable) (const char*, \
439 void (*) (Fixture*, gconstpointer), \
440 void (*) (Fixture*, gconstpointer), \
441 void (*) (Fixture*, gconstpointer)) = (void (*) (const gchar *, gsize, gconstpointer, void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer))) g_test_add_vtable; \
443 (testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown); \
446 /* add test messages to the test report */
447 GLIB_AVAILABLE_IN_ALL
448 void g_test_message (const char *format,
449 ...) G_GNUC_PRINTF (1, 2);
450 GLIB_AVAILABLE_IN_ALL
451 void g_test_bug_base (const char *uri_pattern);
452 GLIB_AVAILABLE_IN_ALL
453 void g_test_bug (const char *bug_uri_snippet);
454 GLIB_AVAILABLE_IN_2_62
455 void g_test_summary (const char *summary);
456 /* measure test timings */
457 GLIB_AVAILABLE_IN_ALL
458 void g_test_timer_start (void);
459 GLIB_AVAILABLE_IN_ALL
460 double g_test_timer_elapsed (void); /* elapsed seconds */
461 GLIB_AVAILABLE_IN_ALL
462 double g_test_timer_last (void); /* repeat last elapsed() result */
464 /* automatically g_free or g_object_unref upon teardown */
465 GLIB_AVAILABLE_IN_ALL
466 void g_test_queue_free (gpointer gfree_pointer);
467 GLIB_AVAILABLE_IN_ALL
468 void g_test_queue_destroy (GDestroyNotify destroy_func,
469 gpointer destroy_data);
470 #define g_test_queue_unref(gobject) g_test_queue_destroy (g_object_unref, gobject)
474 * @G_TEST_TRAP_DEFAULT: Default behaviour. Since: 2.74
475 * @G_TEST_TRAP_SILENCE_STDOUT: Redirect stdout of the test child to
476 * `/dev/null` so it cannot be observed on the console during test
477 * runs. The actual output is still captured though to allow later
478 * tests with g_test_trap_assert_stdout().
479 * @G_TEST_TRAP_SILENCE_STDERR: Redirect stderr of the test child to
480 * `/dev/null` so it cannot be observed on the console during test
481 * runs. The actual output is still captured though to allow later
482 * tests with g_test_trap_assert_stderr().
483 * @G_TEST_TRAP_INHERIT_STDIN: If this flag is given, stdin of the
484 * child process is shared with stdin of its parent process.
485 * It is redirected to `/dev/null` otherwise.
487 * Test traps are guards around forked tests.
488 * These flags determine what traps to set.
490 * Deprecated: 2.38: #GTestTrapFlags is used only with g_test_trap_fork(),
491 * which is deprecated. g_test_trap_subprocess() uses
492 * #GTestSubprocessFlags.
495 G_TEST_TRAP_DEFAULT GLIB_AVAILABLE_ENUMERATOR_IN_2_74 = 0,
496 G_TEST_TRAP_SILENCE_STDOUT = 1 << 7,
497 G_TEST_TRAP_SILENCE_STDERR = 1 << 8,
498 G_TEST_TRAP_INHERIT_STDIN = 1 << 9
499 } GTestTrapFlags GLIB_DEPRECATED_TYPE_IN_2_38_FOR(GTestSubprocessFlags);
501 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
503 GLIB_DEPRECATED_IN_2_38_FOR (g_test_trap_subprocess)
504 gboolean g_test_trap_fork (guint64 usec_timeout,
505 GTestTrapFlags test_trap_flags);
507 G_GNUC_END_IGNORE_DEPRECATIONS
510 G_TEST_SUBPROCESS_DEFAULT GLIB_AVAILABLE_ENUMERATOR_IN_2_74 = 0,
511 G_TEST_SUBPROCESS_INHERIT_STDIN = 1 << 0,
512 G_TEST_SUBPROCESS_INHERIT_STDOUT = 1 << 1,
513 G_TEST_SUBPROCESS_INHERIT_STDERR = 1 << 2
514 } GTestSubprocessFlags;
516 GLIB_AVAILABLE_IN_2_38
517 void g_test_trap_subprocess (const char *test_path,
518 guint64 usec_timeout,
519 GTestSubprocessFlags test_flags);
520 GLIB_AVAILABLE_IN_2_80
521 void g_test_trap_subprocess_with_envp (const char *test_path,
522 const char * const *envp,
523 guint64 usec_timeout,
524 GTestSubprocessFlags test_flags);
526 GLIB_AVAILABLE_IN_ALL
527 gboolean g_test_trap_has_passed (void);
528 GLIB_AVAILABLE_IN_ALL
529 gboolean g_test_trap_reached_timeout (void);
530 #define g_test_trap_assert_passed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0)
531 #define g_test_trap_assert_failed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 1, 0)
532 #define g_test_trap_assert_stdout(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 2, soutpattern)
533 #define g_test_trap_assert_stdout_unmatched(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 3, soutpattern)
534 #define g_test_trap_assert_stderr(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 4, serrpattern)
535 #define g_test_trap_assert_stderr_unmatched(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 5, serrpattern)
537 /* provide seed-able random numbers for tests */
538 #define g_test_rand_bit() (0 != (g_test_rand_int() & (1 << 15)))
539 GLIB_AVAILABLE_IN_ALL
540 gint32 g_test_rand_int (void);
541 GLIB_AVAILABLE_IN_ALL
542 gint32 g_test_rand_int_range (gint32 begin,
544 GLIB_AVAILABLE_IN_ALL
545 double g_test_rand_double (void);
546 GLIB_AVAILABLE_IN_ALL
547 double g_test_rand_double_range (double range_start,
551 * semi-internal API: non-documented symbols with stable ABI. You
552 * should use the non-internal helper macros instead. However, for
553 * compatibility reason, you may use this semi-internal API.
555 GLIB_AVAILABLE_IN_ALL
556 GTestCase* g_test_create_case (const char *test_name,
558 gconstpointer test_data,
559 GTestFixtureFunc data_setup,
560 GTestFixtureFunc data_test,
561 GTestFixtureFunc data_teardown);
562 GLIB_AVAILABLE_IN_ALL
563 GTestSuite* g_test_create_suite (const char *suite_name);
564 GLIB_AVAILABLE_IN_ALL
565 GTestSuite* g_test_get_root (void);
566 GLIB_AVAILABLE_IN_ALL
567 void g_test_suite_add (GTestSuite *suite,
568 GTestCase *test_case);
569 GLIB_AVAILABLE_IN_ALL
570 void g_test_suite_add_suite (GTestSuite *suite,
571 GTestSuite *nestedsuite);
572 GLIB_AVAILABLE_IN_ALL
573 int g_test_run_suite (GTestSuite *suite);
575 GLIB_AVAILABLE_IN_2_70
576 void g_test_case_free (GTestCase *test_case);
578 GLIB_AVAILABLE_IN_2_70
579 void g_test_suite_free (GTestSuite *suite);
581 GLIB_AVAILABLE_IN_ALL
582 void g_test_trap_assertions (const char *domain,
586 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
587 const char *pattern);
588 GLIB_AVAILABLE_IN_ALL
589 void g_assertion_message (const char *domain,
593 const char *message) G_ANALYZER_NORETURN;
595 GLIB_AVAILABLE_IN_ALL
596 void g_assertion_message_expr (const char *domain,
601 GLIB_AVAILABLE_IN_ALL
602 void g_assertion_message_cmpstr (const char *domain,
609 const char *arg2) G_ANALYZER_NORETURN;
611 GLIB_AVAILABLE_IN_2_68
612 void g_assertion_message_cmpstrv (const char *domain,
617 const char * const *arg1,
618 const char * const *arg2,
619 gsize first_wrong_idx) G_ANALYZER_NORETURN;
620 GLIB_AVAILABLE_IN_2_78
621 void g_assertion_message_cmpint (const char *domain,
629 char numtype) G_ANALYZER_NORETURN;
630 GLIB_AVAILABLE_IN_ALL
631 void g_assertion_message_cmpnum (const char *domain,
639 char numtype) G_ANALYZER_NORETURN;
640 GLIB_AVAILABLE_IN_ALL
641 void g_assertion_message_error (const char *domain,
648 int error_code) G_ANALYZER_NORETURN;
649 GLIB_AVAILABLE_IN_ALL
650 void g_test_add_vtable (const char *testpath,
652 gconstpointer test_data,
653 GTestFixtureFunc data_setup,
654 GTestFixtureFunc data_test,
655 GTestFixtureFunc data_teardown);
657 gboolean test_initialized;
658 gboolean test_quick; /* disable thorough tests */
659 gboolean test_perf; /* run performance tests */
660 gboolean test_verbose; /* extra info */
661 gboolean test_quiet; /* reduce output */
662 gboolean test_undefined; /* run tests that are meant to assert */
664 GLIB_VAR const GTestConfig * const g_test_config_vars;
666 /* internal logging API */
671 G_TEST_RUN_INCOMPLETE
676 G_TEST_LOG_ERROR, /* s:msg */
677 G_TEST_LOG_START_BINARY, /* s:binaryname s:seed */
678 G_TEST_LOG_LIST_CASE, /* s:testpath */
679 G_TEST_LOG_SKIP_CASE, /* s:testpath */
680 G_TEST_LOG_START_CASE, /* s:testpath */
681 G_TEST_LOG_STOP_CASE, /* d:status d:nforks d:elapsed */
682 G_TEST_LOG_MIN_RESULT, /* s:blurb d:result */
683 G_TEST_LOG_MAX_RESULT, /* s:blurb d:result */
684 G_TEST_LOG_MESSAGE, /* s:blurb */
685 G_TEST_LOG_START_SUITE,
686 G_TEST_LOG_STOP_SUITE
690 GTestLogType log_type;
692 gchar **strings; /* NULL terminated */
702 GLIB_AVAILABLE_IN_ALL
703 const char* g_test_log_type_name (GTestLogType log_type);
704 GLIB_AVAILABLE_IN_ALL
705 GTestLogBuffer* g_test_log_buffer_new (void);
706 GLIB_AVAILABLE_IN_ALL
707 void g_test_log_buffer_free (GTestLogBuffer *tbuffer);
708 GLIB_AVAILABLE_IN_ALL
709 void g_test_log_buffer_push (GTestLogBuffer *tbuffer,
711 const guint8 *bytes);
712 GLIB_AVAILABLE_IN_ALL
713 GTestLogMsg* g_test_log_buffer_pop (GTestLogBuffer *tbuffer);
714 GLIB_AVAILABLE_IN_ALL
715 void g_test_log_msg_free (GTestLogMsg *tmsg);
719 * @log_domain: the log domain of the message
720 * @log_level: the log level of the message (including the fatal and recursion flags)
721 * @message: the message to process
722 * @user_data: user data, set in g_test_log_set_fatal_handler()
724 * Specifies the prototype of fatal log handler functions.
726 * Returns: %TRUE if the program should abort, %FALSE otherwise
730 typedef gboolean (*GTestLogFatalFunc) (const gchar *log_domain,
731 GLogLevelFlags log_level,
732 const gchar *message,
734 GLIB_AVAILABLE_IN_ALL
736 g_test_log_set_fatal_handler (GTestLogFatalFunc log_func,
739 GLIB_AVAILABLE_IN_2_34
740 void g_test_expect_message (const gchar *log_domain,
741 GLogLevelFlags log_level,
742 const gchar *pattern);
743 GLIB_AVAILABLE_IN_2_34
744 void g_test_assert_expected_messages_internal (const char *domain,
755 GLIB_AVAILABLE_IN_2_38
756 gchar * g_test_build_filename (GTestFileType file_type,
757 const gchar *first_path,
758 ...) G_GNUC_NULL_TERMINATED;
759 GLIB_AVAILABLE_IN_2_38
760 const gchar *g_test_get_dir (GTestFileType file_type);
761 GLIB_AVAILABLE_IN_2_38
762 const gchar *g_test_get_filename (GTestFileType file_type,
763 const gchar *first_path,
764 ...) G_GNUC_NULL_TERMINATED;
766 #define g_test_assert_expected_messages() g_test_assert_expected_messages_internal (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC)
770 #endif /* __G_TEST_UTILS_H__ */