1 /* GLib testing utilities
2 * Copyright (C) 2007 Imendio AB
3 * Authors: Tim Janik, Sven Herzberg
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.
23 #include "gtestutils.h"
24 #include "gfileutils.h"
26 #include <sys/types.h>
32 #include <glib/gstdio.h>
37 #ifdef HAVE_SYS_RESOURCE_H
38 #include <sys/resource.h>
46 #ifdef HAVE_SYS_SELECT_H
47 #include <sys/select.h>
48 #endif /* HAVE_SYS_SELECT_H */
53 #include "gstrfuncs.h"
57 #include "glib-private.h"
63 * @short_description: a test framework
64 * @see_also: <link linkend="gtester">gtester</link>,
65 * <link linkend="gtester-report">gtester-report</link>
67 * GLib provides a framework for writing and maintaining unit tests
68 * in parallel to the code they are testing. The API is designed according
69 * to established concepts found in the other test frameworks (JUnit, NUnit,
70 * RUnit), which in turn is based on smalltalk unit testing concepts.
74 * <term>Test case</term>
75 * <listitem>Tests (test methods) are grouped together with their
76 * fixture into test cases.</listitem>
79 * <term>Fixture</term>
80 * <listitem>A test fixture consists of fixture data and setup and
81 * teardown methods to establish the environment for the test
82 * functions. We use fresh fixtures, i.e. fixtures are newly set
83 * up and torn down around each test invocation to avoid dependencies
84 * between tests.</listitem>
87 * <term>Test suite</term>
88 * <listitem>Test cases can be grouped into test suites, to allow
89 * subsets of the available tests to be run. Test suites can be
90 * grouped into other test suites as well.</listitem>
93 * The API is designed to handle creation and registration of test suites
94 * and test cases implicitly. A simple call like
96 * g_test_add_func ("/misc/assertions", test_assertions);
98 * creates a test suite called "misc" with a single test case named
99 * "assertions", which consists of running the test_assertions function.
101 * In addition to the traditional g_assert(), the test framework provides
102 * an extended set of assertions for string and numerical comparisons:
103 * g_assert_cmpfloat(), g_assert_cmpint(), g_assert_cmpuint(),
104 * g_assert_cmphex(), g_assert_cmpstr(). The advantage of these variants
105 * over plain g_assert() is that the assertion messages can be more
106 * elaborate, and include the values of the compared entities.
108 * GLib ships with two utilities called gtester and gtester-report to
109 * facilitate running tests and producing nicely formatted test reports.
113 * g_test_initialized:
115 * Returns %TRUE if g_test_init() has been called.
117 * Returns: %TRUE if g_test_init() has been called.
125 * Returns %TRUE if tests are run in quick mode.
126 * Exactly one of g_test_quick() and g_test_slow() is active in any run;
127 * there is no "medium speed".
129 * Returns: %TRUE if in quick mode
135 * Returns %TRUE if tests are run in slow mode.
136 * Exactly one of g_test_quick() and g_test_slow() is active in any run;
137 * there is no "medium speed".
139 * Returns: the opposite of g_test_quick()
145 * Returns %TRUE if tests are run in thorough mode, equivalent to
148 * Returns: the same thing as g_test_slow()
154 * Returns %TRUE if tests are run in performance mode.
156 * Returns: %TRUE if in performance mode
162 * Returns %TRUE if tests may provoke assertions and other formally-undefined
163 * behaviour, to verify that appropriate warnings are given. It might, in some
164 * cases, be useful to turn this off if running tests under valgrind.
166 * Returns: %TRUE if tests may provoke programming errors
172 * Returns %TRUE if tests are run in verbose mode.
173 * The default is neither g_test_verbose() nor g_test_quiet().
175 * Returns: %TRUE if in verbose mode
181 * Returns %TRUE if tests are run in quiet mode.
182 * The default is neither g_test_verbose() nor g_test_quiet().
184 * Returns: %TRUE if in quiet mode
188 * g_test_queue_unref:
189 * @gobject: the object to unref
191 * Enqueue an object to be released with g_object_unref() during
192 * the next teardown phase. This is equivalent to calling
193 * g_test_queue_destroy() with a destroy callback of g_object_unref().
200 * @G_TEST_TRAP_SILENCE_STDOUT: Redirect stdout of the test child to
201 * <filename>/dev/null</filename> so it cannot be observed on the
202 * console during test runs. The actual output is still captured
203 * though to allow later tests with g_test_trap_assert_stdout().
204 * @G_TEST_TRAP_SILENCE_STDERR: Redirect stderr of the test child to
205 * <filename>/dev/null</filename> so it cannot be observed on the
206 * console during test runs. The actual output is still captured
207 * though to allow later tests with g_test_trap_assert_stderr().
208 * @G_TEST_TRAP_INHERIT_STDIN: If this flag is given, stdin of the
209 * child process is shared with stdin of its parent process.
210 * It is redirected to <filename>/dev/null</filename> otherwise.
212 * Test traps are guards around forked tests.
213 * These flags determine what traps to set.
215 * Deprecated: #GTestTrapFlags is used only with g_test_trap_fork(),
216 * which is deprecated. g_test_trap_subprocess() uses
217 * #GTestTrapSubprocessFlags.
221 * GTestSubprocessFlags:
222 * @G_TEST_SUBPROCESS_INHERIT_STDIN: If this flag is given, the child
223 * process will inherit the parent's stdin. Otherwise, the child's
224 * stdin is redirected to <filename>/dev/null</filename>.
225 * @G_TEST_SUBPROCESS_INHERIT_STDOUT: If this flag is given, the child
226 * process will inherit the parent's stdout. Otherwise, the child's
227 * stdout will not be visible, but it will be captured to allow
228 * later tests with g_test_trap_assert_stdout().
229 * @G_TEST_SUBPROCESS_INHERIT_STDERR: If this flag is given, the child
230 * process will inherit the parent's stderr. Otherwise, the child's
231 * stderr will not be visible, but it will be captured to allow
232 * later tests with g_test_trap_assert_stderr().
234 * Flags to pass to g_test_trap_subprocess() to control input and output.
236 * Note that in contrast with g_test_trap_fork(), the default is to
237 * not show stdout and stderr.
241 * g_test_trap_assert_passed:
243 * Assert that the last test subprocess passed.
244 * See g_test_trap_subprocess().
250 * g_test_trap_assert_failed:
252 * Assert that the last test subprocess failed.
253 * See g_test_trap_subprocess().
255 * This is sometimes used to test situations that are formally considered to
256 * be undefined behaviour, like inputs that fail a g_return_if_fail()
257 * check. In these situations you should skip the entire test, including the
258 * call to g_test_trap_subprocess(), unless g_test_undefined() returns %TRUE
259 * to indicate that undefined behaviour may be tested.
265 * g_test_trap_assert_stdout:
266 * @soutpattern: a glob-style
267 * <link linkend="glib-Glob-style-pattern-matching">pattern</link>
269 * Assert that the stdout output of the last test subprocess matches
270 * @soutpattern. See g_test_trap_subprocess().
276 * g_test_trap_assert_stdout_unmatched:
277 * @soutpattern: a glob-style
278 * <link linkend="glib-Glob-style-pattern-matching">pattern</link>
280 * Assert that the stdout output of the last test subprocess
281 * does not match @soutpattern. See g_test_trap_subprocess().
287 * g_test_trap_assert_stderr:
288 * @serrpattern: a glob-style
289 * <link linkend="glib-Glob-style-pattern-matching">pattern</link>
291 * Assert that the stderr output of the last test subprocess
292 * matches @serrpattern. See g_test_trap_subprocess().
294 * This is sometimes used to test situations that are formally
295 * considered to be undefined behaviour, like code that hits a
296 * g_assert() or g_error(). In these situations you should skip the
297 * entire test, including the call to g_test_trap_subprocess(), unless
298 * g_test_undefined() returns %TRUE to indicate that undefined
299 * behaviour may be tested.
305 * g_test_trap_assert_stderr_unmatched:
306 * @serrpattern: a glob-style
307 * <link linkend="glib-Glob-style-pattern-matching">pattern</link>
309 * Assert that the stderr output of the last test subprocess
310 * does not match @serrpattern. See g_test_trap_subprocess().
318 * Get a reproducible random bit (0 or 1), see g_test_rand_int()
319 * for details on test case random numbers.
326 * @expr: the expression to check
328 * Debugging macro to terminate the application if the assertion
329 * fails. If the assertion fails (i.e. the expression is not true),
330 * an error message is logged and the application is terminated.
332 * The macro can be turned off in final releases of code by defining
333 * <envar>G_DISABLE_ASSERT</envar> when compiling the application.
337 * g_assert_not_reached:
339 * Debugging macro to terminate the application if it is ever
340 * reached. If it is reached, an error message is logged and the
341 * application is terminated.
343 * The macro can be turned off in final releases of code by defining
344 * <envar>G_DISABLE_ASSERT</envar> when compiling the application.
349 * @expr: the expression to check
351 * Debugging macro to check that an expression is true.
353 * If the assertion fails (i.e. the expression is not true),
354 * an error message is logged and the application is either
355 * terminated or the testcase marked as failed.
357 * See g_test_set_nonfatal_assertions().
364 * @expr: the expression to check
366 * Debugging macro to check an expression is false.
368 * If the assertion fails (i.e. the expression is not false),
369 * an error message is logged and the application is either
370 * terminated or the testcase marked as failed.
372 * See g_test_set_nonfatal_assertions().
379 * @expr: the expression to check
381 * Debugging macro to check an expression is %NULL.
383 * If the assertion fails (i.e. the expression is not %NULL),
384 * an error message is logged and the application is either
385 * terminated or the testcase marked as failed.
387 * See g_test_set_nonfatal_assertions().
394 * @expr: the expression to check
396 * Debugging macro to check an expression is not %NULL.
398 * If the assertion fails (i.e. the expression is %NULL),
399 * an error message is logged and the application is either
400 * terminated or the testcase marked as failed.
402 * See g_test_set_nonfatal_assertions().
409 * @s1: a string (may be %NULL)
410 * @cmp: The comparison operator to use.
411 * One of ==, !=, <, >, <=, >=.
412 * @s2: another string (may be %NULL)
414 * Debugging macro to compare two strings. If the comparison fails,
415 * an error message is logged and the application is either terminated
416 * or the testcase marked as failed.
417 * The strings are compared using g_strcmp0().
419 * The effect of <literal>g_assert_cmpstr (s1, op, s2)</literal> is
420 * the same as <literal>g_assert_true (g_strcmp0 (s1, s2) op 0)</literal>.
421 * The advantage of this macro is that it can produce a message that
422 * includes the actual values of @s1 and @s2.
425 * g_assert_cmpstr (mystring, ==, "fubar");
434 * @cmp: The comparison operator to use.
435 * One of ==, !=, <, >, <=, >=.
436 * @n2: another integer
438 * Debugging macro to compare two integers.
440 * The effect of <literal>g_assert_cmpint (n1, op, n2)</literal> is
441 * the same as <literal>g_assert_true (n1 op n2)</literal>. The advantage
442 * of this macro is that it can produce a message that includes the
443 * actual values of @n1 and @n2.
450 * @n1: an unsigned integer
451 * @cmp: The comparison operator to use.
452 * One of ==, !=, <, >, <=, >=.
453 * @n2: another unsigned integer
455 * Debugging macro to compare two unsigned integers.
457 * The effect of <literal>g_assert_cmpuint (n1, op, n2)</literal> is
458 * the same as <literal>g_assert_true (n1 op n2)</literal>. The advantage
459 * of this macro is that it can produce a message that includes the
460 * actual values of @n1 and @n2.
467 * @n1: an unsigned integer
468 * @cmp: The comparison operator to use.
469 * One of ==, !=, <, >, <=, >=.
470 * @n2: another unsigned integer
472 * Debugging macro to compare to unsigned integers.
474 * This is a variant of g_assert_cmpuint() that displays the numbers
475 * in hexadecimal notation in the message.
482 * @n1: an floating point number
483 * @cmp: The comparison operator to use.
484 * One of ==, !=, <, >, <=, >=.
485 * @n2: another floating point number
487 * Debugging macro to compare two floating point numbers.
489 * The effect of <literal>g_assert_cmpfloat (n1, op, n2)</literal> is
490 * the same as <literal>g_assert_true (n1 op n2)</literal>. The advantage
491 * of this macro is that it can produce a message that includes the
492 * actual values of @n1 and @n2.
499 * @err: a #GError, possibly %NULL
501 * Debugging macro to check that a #GError is not set.
503 * The effect of <literal>g_assert_no_error (err)</literal> is
504 * the same as <literal>g_assert_true (err == NULL)</literal>. The advantage
505 * of this macro is that it can produce a message that includes
506 * the error message and code.
513 * @err: a #GError, possibly %NULL
514 * @dom: the expected error domain (a #GQuark)
515 * @c: the expected error code
517 * Debugging macro to check that a method has returned
518 * the correct #GError.
520 * The effect of <literal>g_assert_error (err, dom, c)</literal> is
521 * the same as <literal>g_assert_true (err != NULL && err->domain
522 * == dom && err->code == c)</literal>. The advantage of this
523 * macro is that it can produce a message that includes the incorrect
524 * error message and code.
526 * This can only be used to test for a specific error. If you want to
527 * test that @err is set, but don't care what it's set to, just use
528 * <literal>g_assert (err != NULL)</literal>
536 * An opaque structure representing a test case.
542 * An opaque structure representing a test suite.
546 /* Global variable for storing assertion messages; this is the counterpart to
547 * glibc's (private) __abort_msg variable, and allows developers and crash
548 * analysis systems like Apport and ABRT to fish out assertion messages from
549 * core dumps, instead of having to catch them on screen output.
551 GLIB_VAR char *__glib_assert_msg;
552 char *__glib_assert_msg = NULL;
554 /* --- constants --- */
555 #define G_TEST_STATUS_TIMED_OUT 1024
557 /* --- structures --- */
562 void (*fixture_setup) (void*, gconstpointer);
563 void (*fixture_test) (void*, gconstpointer);
564 void (*fixture_teardown) (void*, gconstpointer);
573 typedef struct DestroyEntry DestroyEntry;
577 GDestroyNotify destroy_func;
578 gpointer destroy_data;
581 /* --- prototypes --- */
582 static void test_run_seed (const gchar *rseed);
583 static void test_trap_clear (void);
584 static guint8* g_test_log_dump (GTestLogMsg *msg,
586 static void gtest_default_log_handler (const gchar *log_domain,
587 GLogLevelFlags log_level,
588 const gchar *message,
589 gpointer unused_data);
596 G_TEST_RUN_INCOMPLETE
599 /* --- variables --- */
600 static int test_log_fd = -1;
601 static gboolean test_mode_fatal = TRUE;
602 static gboolean g_test_run_once = TRUE;
603 static gboolean test_run_list = FALSE;
604 static gchar *test_run_seedstr = NULL;
605 static GRand *test_run_rand = NULL;
606 static gchar *test_run_name = "";
607 static GSList **test_filename_free_list;
608 static guint test_run_forks = 0;
609 static guint test_run_count = 0;
610 static guint test_skipped_count = 0;
611 static GTestResult test_run_success = G_TEST_RUN_FAILURE;
612 static gchar *test_run_msg = NULL;
613 static guint test_startup_skip_count = 0;
614 static GTimer *test_user_timer = NULL;
615 static double test_user_stamp = 0;
616 static GSList *test_paths = NULL;
617 static GSList *test_paths_skipped = NULL;
618 static GTestSuite *test_suite_root = NULL;
619 static int test_trap_last_status = 0;
620 static GPid test_trap_last_pid = 0;
621 static char *test_trap_last_subprocess = NULL;
622 static char *test_trap_last_stdout = NULL;
623 static char *test_trap_last_stderr = NULL;
624 static char *test_uri_base = NULL;
625 static gboolean test_debug_log = FALSE;
626 static gboolean test_tap_log = FALSE;
627 static gboolean test_nonfatal_assertions = FALSE;
628 static DestroyEntry *test_destroy_queue = NULL;
629 static char *test_argv0 = NULL;
630 static char *test_argv0_dirname;
631 static const char *test_disted_files_dir;
632 static const char *test_built_files_dir;
633 static char *test_initial_cwd = NULL;
634 static gboolean test_in_subprocess = FALSE;
635 static GTestConfig mutable_test_config_vars = {
636 FALSE, /* test_initialized */
637 TRUE, /* test_quick */
638 FALSE, /* test_perf */
639 FALSE, /* test_verbose */
640 FALSE, /* test_quiet */
641 TRUE, /* test_undefined */
643 const GTestConfig * const g_test_config_vars = &mutable_test_config_vars;
644 static gboolean no_g_set_prgname = FALSE;
646 /* --- functions --- */
648 g_test_log_type_name (GTestLogType log_type)
652 case G_TEST_LOG_NONE: return "none";
653 case G_TEST_LOG_ERROR: return "error";
654 case G_TEST_LOG_START_BINARY: return "binary";
655 case G_TEST_LOG_LIST_CASE: return "list";
656 case G_TEST_LOG_SKIP_CASE: return "skip";
657 case G_TEST_LOG_START_CASE: return "start";
658 case G_TEST_LOG_STOP_CASE: return "stop";
659 case G_TEST_LOG_MIN_RESULT: return "minperf";
660 case G_TEST_LOG_MAX_RESULT: return "maxperf";
661 case G_TEST_LOG_MESSAGE: return "message";
662 case G_TEST_LOG_START_SUITE: return "start suite";
663 case G_TEST_LOG_STOP_SUITE: return "stop suite";
669 g_test_log_send (guint n_bytes,
670 const guint8 *buffer)
672 if (test_log_fd >= 0)
676 r = write (test_log_fd, buffer, n_bytes);
677 while (r < 0 && errno == EINTR);
681 GTestLogBuffer *lbuffer = g_test_log_buffer_new ();
684 g_test_log_buffer_push (lbuffer, n_bytes, buffer);
685 msg = g_test_log_buffer_pop (lbuffer);
686 g_warn_if_fail (msg != NULL);
687 g_warn_if_fail (lbuffer->data->len == 0);
688 g_test_log_buffer_free (lbuffer);
690 g_printerr ("{*LOG(%s)", g_test_log_type_name (msg->log_type));
691 for (ui = 0; ui < msg->n_strings; ui++)
692 g_printerr (":{%s}", msg->strings[ui]);
696 for (ui = 0; ui < msg->n_nums; ui++)
698 if ((long double) (long) msg->nums[ui] == msg->nums[ui])
699 g_printerr ("%s%ld", ui ? ";" : "", (long) msg->nums[ui]);
701 g_printerr ("%s%.16g", ui ? ";" : "", (double) msg->nums[ui]);
705 g_printerr (":LOG*}\n");
706 g_test_log_msg_free (msg);
711 g_test_log (GTestLogType lbit,
712 const gchar *string1,
713 const gchar *string2,
719 gchar *astrings[3] = { NULL, NULL, NULL };
725 case G_TEST_LOG_START_BINARY:
727 g_print ("# random seed: %s\n", string2);
728 else if (g_test_verbose())
729 g_print ("GTest: random seed: %s\n", string2);
731 case G_TEST_LOG_START_SUITE:
735 g_print ("# Start of %s tests\n", string1);
738 case G_TEST_LOG_STOP_SUITE:
742 g_print ("# End of %s tests\n", string1);
744 g_print ("1..%d\n", test_run_count);
747 case G_TEST_LOG_STOP_CASE:
748 fail = largs[0] != G_TEST_RUN_SUCCESS && largs[0] != G_TEST_RUN_SKIPPED;
751 g_print ("%s %d %s", fail ? "not ok" : "ok", test_run_count, string1);
752 if (largs[0] == G_TEST_RUN_INCOMPLETE)
753 g_print (" # TODO %s\n", string2 ? string2 : "");
754 else if (largs[0] == G_TEST_RUN_SKIPPED)
755 g_print (" # SKIP %s\n", string2 ? string2 : "");
759 else if (g_test_verbose())
760 g_print ("GTest: result: %s\n", fail ? "FAIL" : "OK");
761 else if (!g_test_quiet())
762 g_print ("%s\n", fail ? "FAIL" : "OK");
763 if (fail && test_mode_fatal)
766 g_print ("Bail out!\n");
769 if (largs[0] == G_TEST_RUN_SKIPPED)
770 test_skipped_count++;
772 case G_TEST_LOG_MIN_RESULT:
774 g_print ("# min perf: %s\n", string1);
775 else if (g_test_verbose())
776 g_print ("(MINPERF:%s)\n", string1);
778 case G_TEST_LOG_MAX_RESULT:
780 g_print ("# max perf: %s\n", string1);
781 else if (g_test_verbose())
782 g_print ("(MAXPERF:%s)\n", string1);
784 case G_TEST_LOG_MESSAGE:
785 case G_TEST_LOG_ERROR:
787 g_print ("# %s\n", string1);
788 else if (g_test_verbose())
789 g_print ("(MSG: %s)\n", string1);
795 msg.n_strings = (string1 != NULL) + (string1 && string2);
796 msg.strings = astrings;
797 astrings[0] = (gchar*) string1;
798 astrings[1] = astrings[0] ? (gchar*) string2 : NULL;
801 dbuffer = g_test_log_dump (&msg, &dbufferlen);
802 g_test_log_send (dbufferlen, dbuffer);
807 case G_TEST_LOG_START_CASE:
810 else if (g_test_verbose())
811 g_print ("GTest: run: %s\n", string1);
812 else if (!g_test_quiet())
813 g_print ("%s: ", string1);
819 /* We intentionally parse the command line without GOptionContext
820 * because otherwise you would never be able to test it.
823 parse_args (gint *argc_p,
826 guint argc = *argc_p;
827 gchar **argv = *argv_p;
830 test_argv0 = argv[0];
831 test_initial_cwd = g_get_current_dir ();
833 /* parse known args */
834 for (i = 1; i < argc; i++)
836 if (strcmp (argv[i], "--g-fatal-warnings") == 0)
838 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
839 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
840 g_log_set_always_fatal (fatal_mask);
843 else if (strcmp (argv[i], "--keep-going") == 0 ||
844 strcmp (argv[i], "-k") == 0)
846 test_mode_fatal = FALSE;
849 else if (strcmp (argv[i], "--debug-log") == 0)
851 test_debug_log = TRUE;
854 else if (strcmp (argv[i], "--tap") == 0)
859 else if (strcmp ("--GTestLogFD", argv[i]) == 0 || strncmp ("--GTestLogFD=", argv[i], 13) == 0)
861 gchar *equal = argv[i] + 12;
863 test_log_fd = g_ascii_strtoull (equal + 1, NULL, 0);
864 else if (i + 1 < argc)
867 test_log_fd = g_ascii_strtoull (argv[i], NULL, 0);
871 else if (strcmp ("--GTestSkipCount", argv[i]) == 0 || strncmp ("--GTestSkipCount=", argv[i], 17) == 0)
873 gchar *equal = argv[i] + 16;
875 test_startup_skip_count = g_ascii_strtoull (equal + 1, NULL, 0);
876 else if (i + 1 < argc)
879 test_startup_skip_count = g_ascii_strtoull (argv[i], NULL, 0);
883 else if (strcmp ("--GTestSubprocess", argv[i]) == 0)
885 test_in_subprocess = TRUE;
886 /* We typically expect these child processes to crash, and some
887 * tests spawn a *lot* of them. Avoid spamming system crash
888 * collection programs such as systemd-coredump and abrt.
890 #ifdef HAVE_SYS_RESOURCE_H
892 struct rlimit limit = { 0, 0 };
893 (void) setrlimit (RLIMIT_CORE, &limit);
898 else if (strcmp ("-p", argv[i]) == 0 || strncmp ("-p=", argv[i], 3) == 0)
900 gchar *equal = argv[i] + 2;
902 test_paths = g_slist_prepend (test_paths, equal + 1);
903 else if (i + 1 < argc)
906 test_paths = g_slist_prepend (test_paths, argv[i]);
910 else if (strcmp ("-s", argv[i]) == 0 || strncmp ("-s=", argv[i], 3) == 0)
912 gchar *equal = argv[i] + 2;
914 test_paths_skipped = g_slist_prepend (test_paths_skipped, equal + 1);
915 else if (i + 1 < argc)
918 test_paths_skipped = g_slist_prepend (test_paths_skipped, argv[i]);
922 else if (strcmp ("-m", argv[i]) == 0 || strncmp ("-m=", argv[i], 3) == 0)
924 gchar *equal = argv[i] + 2;
925 const gchar *mode = "";
928 else if (i + 1 < argc)
933 if (strcmp (mode, "perf") == 0)
934 mutable_test_config_vars.test_perf = TRUE;
935 else if (strcmp (mode, "slow") == 0)
936 mutable_test_config_vars.test_quick = FALSE;
937 else if (strcmp (mode, "thorough") == 0)
938 mutable_test_config_vars.test_quick = FALSE;
939 else if (strcmp (mode, "quick") == 0)
941 mutable_test_config_vars.test_quick = TRUE;
942 mutable_test_config_vars.test_perf = FALSE;
944 else if (strcmp (mode, "undefined") == 0)
945 mutable_test_config_vars.test_undefined = TRUE;
946 else if (strcmp (mode, "no-undefined") == 0)
947 mutable_test_config_vars.test_undefined = FALSE;
949 g_error ("unknown test mode: -m %s", mode);
952 else if (strcmp ("-q", argv[i]) == 0 || strcmp ("--quiet", argv[i]) == 0)
954 mutable_test_config_vars.test_quiet = TRUE;
955 mutable_test_config_vars.test_verbose = FALSE;
958 else if (strcmp ("--verbose", argv[i]) == 0)
960 mutable_test_config_vars.test_quiet = FALSE;
961 mutable_test_config_vars.test_verbose = TRUE;
964 else if (strcmp ("-l", argv[i]) == 0)
966 test_run_list = TRUE;
969 else if (strcmp ("--seed", argv[i]) == 0 || strncmp ("--seed=", argv[i], 7) == 0)
971 gchar *equal = argv[i] + 6;
973 test_run_seedstr = equal + 1;
974 else if (i + 1 < argc)
977 test_run_seedstr = argv[i];
981 else if (strcmp ("-?", argv[i]) == 0 ||
982 strcmp ("-h", argv[i]) == 0 ||
983 strcmp ("--help", argv[i]) == 0)
986 " %s [OPTION...]\n\n"
988 " -h, --help Show help options\n\n"
990 " --g-fatal-warnings Make all warnings fatal\n"
991 " -l List test cases available in a test executable\n"
992 " -m {perf|slow|thorough|quick} Execute tests according to mode\n"
993 " -m {undefined|no-undefined} Execute tests according to mode\n"
994 " -p TESTPATH Only start test cases matching TESTPATH\n"
995 " -s TESTPATH Skip all tests matching TESTPATH\n"
996 " -seed=SEEDSTRING Start tests with random seed SEEDSTRING\n"
997 " --debug-log debug test logging output\n"
998 " -q, --quiet Run tests quietly\n"
999 " --verbose Run tests verbosely\n",
1006 for (i = 1; i < argc; i++)
1009 argv[e++] = argv[i];
1018 * @argc: Address of the @argc parameter of the main() function.
1019 * Changed if any arguments were handled.
1020 * @argv: Address of the @argv parameter of main().
1021 * Any parameters understood by g_test_init() stripped before return.
1022 * @...: %NULL-terminated list of special options. Currently the only
1023 * defined option is <literal>"no_g_set_prgname"</literal>, which
1024 * will cause g_test_init() to not call g_set_prgname().
1026 * Initialize the GLib testing framework, e.g. by seeding the
1027 * test random number generator, the name for g_get_prgname()
1028 * and parsing test related command line args.
1029 * So far, the following arguments are understood:
1032 * <term><option>-l</option></term>
1034 * List test cases available in a test executable.
1035 * </para></listitem>
1038 * <term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
1040 * Provide a random seed to reproduce test runs using random numbers.
1041 * </para></listitem>
1044 * <term><option>--verbose</option></term>
1045 * <listitem><para>Run tests verbosely.</para></listitem>
1048 * <term><option>-q</option>, <option>--quiet</option></term>
1049 * <listitem><para>Run tests quietly.</para></listitem>
1052 * <term><option>-p <replaceable>TESTPATH</replaceable></option></term>
1054 * Execute all tests matching <replaceable>TESTPATH</replaceable>.
1055 * This can also be used to force a test to run that would otherwise
1056 * be skipped (ie, a test whose name contains "/subprocess").
1057 * </para></listitem>
1060 * <term><option>-m {perf|slow|thorough|quick|undefined|no-undefined}</option></term>
1062 * Execute tests according to these test modes:
1067 * Performance tests, may take long and report results.
1068 * </para></listitem>
1071 * <term>slow, thorough</term>
1073 * Slow and thorough tests, may take quite long and
1074 * maximize coverage.
1075 * </para></listitem>
1078 * <term>quick</term>
1080 * Quick tests, should run really quickly and give good coverage.
1081 * </para></listitem>
1084 * <term>undefined</term>
1086 * Tests for undefined behaviour, may provoke programming errors
1087 * under g_test_trap_subprocess() or g_test_expect_messages() to check
1088 * that appropriate assertions or warnings are given
1089 * </para></listitem>
1092 * <term>no-undefined</term>
1094 * Avoid tests for undefined behaviour
1095 * </para></listitem>
1098 * </para></listitem>
1101 * <term><option>--debug-log</option></term>
1102 * <listitem><para>Debug test logging output.</para></listitem>
1109 g_test_init (int *argc,
1113 static char seedstr[4 + 4 * 8 + 1];
1116 /* make warnings and criticals fatal for all test programs */
1117 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
1119 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
1120 g_log_set_always_fatal (fatal_mask);
1121 /* check caller args */
1122 g_return_if_fail (argc != NULL);
1123 g_return_if_fail (argv != NULL);
1124 g_return_if_fail (g_test_config_vars->test_initialized == FALSE);
1125 mutable_test_config_vars.test_initialized = TRUE;
1127 va_start (args, argv);
1128 while ((option = va_arg (args, char *)))
1130 if (g_strcmp0 (option, "no_g_set_prgname") == 0)
1131 no_g_set_prgname = TRUE;
1135 /* setup random seed string */
1136 g_snprintf (seedstr, sizeof (seedstr), "R02S%08x%08x%08x%08x", g_random_int(), g_random_int(), g_random_int(), g_random_int());
1137 test_run_seedstr = seedstr;
1139 /* parse args, sets up mode, changes seed, etc. */
1140 parse_args (argc, argv);
1142 if (!g_get_prgname() && !no_g_set_prgname)
1143 g_set_prgname ((*argv)[0]);
1145 /* verify GRand reliability, needed for reliable seeds */
1148 GRand *rg = g_rand_new_with_seed (0xc8c49fb6);
1149 guint32 t1 = g_rand_int (rg), t2 = g_rand_int (rg), t3 = g_rand_int (rg), t4 = g_rand_int (rg);
1150 /* g_print ("GRand-current: 0x%x 0x%x 0x%x 0x%x\n", t1, t2, t3, t4); */
1151 if (t1 != 0xfab39f9b || t2 != 0xb948fb0e || t3 != 0x3d31be26 || t4 != 0x43a19d66)
1152 g_warning ("random numbers are not GRand-2.2 compatible, seeds may be broken (check $G_RANDOM_VERSION)");
1156 /* check rand seed */
1157 test_run_seed (test_run_seedstr);
1159 /* report program start */
1160 g_log_set_default_handler (gtest_default_log_handler, NULL);
1161 g_test_log (G_TEST_LOG_START_BINARY, g_get_prgname(), test_run_seedstr, 0, NULL);
1163 test_argv0_dirname = g_path_get_dirname (test_argv0);
1165 /* Make sure we get the real dirname that the test was run from */
1166 if (g_str_has_suffix (test_argv0_dirname, "/.libs"))
1169 tmp = g_path_get_dirname (test_argv0_dirname);
1170 g_free (test_argv0_dirname);
1171 test_argv0_dirname = tmp;
1174 test_disted_files_dir = g_getenv ("G_TEST_SRCDIR");
1175 if (!test_disted_files_dir)
1176 test_disted_files_dir = test_argv0_dirname;
1178 test_built_files_dir = g_getenv ("G_TEST_BUILDDIR");
1179 if (!test_built_files_dir)
1180 test_built_files_dir = test_argv0_dirname;
1184 test_run_seed (const gchar *rseed)
1186 guint seed_failed = 0;
1188 g_rand_free (test_run_rand);
1189 test_run_rand = NULL;
1190 while (strchr (" \t\v\r\n\f", *rseed))
1192 if (strncmp (rseed, "R02S", 4) == 0) /* seed for random generator 02 (GRand-2.2) */
1194 const char *s = rseed + 4;
1195 if (strlen (s) >= 32) /* require 4 * 8 chars */
1197 guint32 seedarray[4];
1198 gchar *p, hexbuf[9] = { 0, };
1199 memcpy (hexbuf, s + 0, 8);
1200 seedarray[0] = g_ascii_strtoull (hexbuf, &p, 16);
1201 seed_failed += p != NULL && *p != 0;
1202 memcpy (hexbuf, s + 8, 8);
1203 seedarray[1] = g_ascii_strtoull (hexbuf, &p, 16);
1204 seed_failed += p != NULL && *p != 0;
1205 memcpy (hexbuf, s + 16, 8);
1206 seedarray[2] = g_ascii_strtoull (hexbuf, &p, 16);
1207 seed_failed += p != NULL && *p != 0;
1208 memcpy (hexbuf, s + 24, 8);
1209 seedarray[3] = g_ascii_strtoull (hexbuf, &p, 16);
1210 seed_failed += p != NULL && *p != 0;
1213 test_run_rand = g_rand_new_with_seed_array (seedarray, 4);
1218 g_error ("Unknown or invalid random seed: %s", rseed);
1224 * Get a reproducible random integer number.
1226 * The random numbers generated by the g_test_rand_*() family of functions
1227 * change with every new test program start, unless the --seed option is
1228 * given when starting test programs.
1230 * For individual test cases however, the random number generator is
1231 * reseeded, to avoid dependencies between tests and to make --seed
1232 * effective for all test cases.
1234 * Returns: a random number from the seeded random number generator.
1239 g_test_rand_int (void)
1241 return g_rand_int (test_run_rand);
1245 * g_test_rand_int_range:
1246 * @begin: the minimum value returned by this function
1247 * @end: the smallest value not to be returned by this function
1249 * Get a reproducible random integer number out of a specified range,
1250 * see g_test_rand_int() for details on test case random numbers.
1252 * Returns: a number with @begin <= number < @end.
1257 g_test_rand_int_range (gint32 begin,
1260 return g_rand_int_range (test_run_rand, begin, end);
1264 * g_test_rand_double:
1266 * Get a reproducible random floating point number,
1267 * see g_test_rand_int() for details on test case random numbers.
1269 * Returns: a random number from the seeded random number generator.
1274 g_test_rand_double (void)
1276 return g_rand_double (test_run_rand);
1280 * g_test_rand_double_range:
1281 * @range_start: the minimum value returned by this function
1282 * @range_end: the minimum value not returned by this function
1284 * Get a reproducible random floating pointer number out of a specified range,
1285 * see g_test_rand_int() for details on test case random numbers.
1287 * Returns: a number with @range_start <= number < @range_end.
1292 g_test_rand_double_range (double range_start,
1295 return g_rand_double_range (test_run_rand, range_start, range_end);
1299 * g_test_timer_start:
1301 * Start a timing test. Call g_test_timer_elapsed() when the task is supposed
1302 * to be done. Call this function again to restart the timer.
1307 g_test_timer_start (void)
1309 if (!test_user_timer)
1310 test_user_timer = g_timer_new();
1311 test_user_stamp = 0;
1312 g_timer_start (test_user_timer);
1316 * g_test_timer_elapsed:
1318 * Get the time since the last start of the timer with g_test_timer_start().
1320 * Returns: the time since the last start of the timer, as a double
1325 g_test_timer_elapsed (void)
1327 test_user_stamp = test_user_timer ? g_timer_elapsed (test_user_timer, NULL) : 0;
1328 return test_user_stamp;
1332 * g_test_timer_last:
1334 * Report the last result of g_test_timer_elapsed().
1336 * Returns: the last result of g_test_timer_elapsed(), as a double
1341 g_test_timer_last (void)
1343 return test_user_stamp;
1347 * g_test_minimized_result:
1348 * @minimized_quantity: the reported value
1349 * @format: the format string of the report message
1350 * @...: arguments to pass to the printf() function
1352 * Report the result of a performance or measurement test.
1353 * The test should generally strive to minimize the reported
1354 * quantities (smaller values are better than larger ones),
1355 * this and @minimized_quantity can determine sorting
1356 * order for test result reports.
1361 g_test_minimized_result (double minimized_quantity,
1365 long double largs = minimized_quantity;
1369 va_start (args, format);
1370 buffer = g_strdup_vprintf (format, args);
1373 g_test_log (G_TEST_LOG_MIN_RESULT, buffer, NULL, 1, &largs);
1378 * g_test_maximized_result:
1379 * @maximized_quantity: the reported value
1380 * @format: the format string of the report message
1381 * @...: arguments to pass to the printf() function
1383 * Report the result of a performance or measurement test.
1384 * The test should generally strive to maximize the reported
1385 * quantities (larger values are better than smaller ones),
1386 * this and @maximized_quantity can determine sorting
1387 * order for test result reports.
1392 g_test_maximized_result (double maximized_quantity,
1396 long double largs = maximized_quantity;
1400 va_start (args, format);
1401 buffer = g_strdup_vprintf (format, args);
1404 g_test_log (G_TEST_LOG_MAX_RESULT, buffer, NULL, 1, &largs);
1410 * @format: the format string
1411 * @...: printf-like arguments to @format
1413 * Add a message to the test report.
1418 g_test_message (const char *format,
1424 va_start (args, format);
1425 buffer = g_strdup_vprintf (format, args);
1428 g_test_log (G_TEST_LOG_MESSAGE, buffer, NULL, 0, NULL);
1434 * @uri_pattern: the base pattern for bug URIs
1436 * Specify the base URI for bug reports.
1438 * The base URI is used to construct bug report messages for
1439 * g_test_message() when g_test_bug() is called.
1440 * Calling this function outside of a test case sets the
1441 * default base URI for all test cases. Calling it from within
1442 * a test case changes the base URI for the scope of the test
1444 * Bug URIs are constructed by appending a bug specific URI
1445 * portion to @uri_pattern, or by replacing the special string
1446 * '\%s' within @uri_pattern if that is present.
1451 g_test_bug_base (const char *uri_pattern)
1453 g_free (test_uri_base);
1454 test_uri_base = g_strdup (uri_pattern);
1459 * @bug_uri_snippet: Bug specific bug tracker URI portion.
1461 * This function adds a message to test reports that
1462 * associates a bug URI with a test case.
1463 * Bug URIs are constructed from a base URI set with g_test_bug_base()
1464 * and @bug_uri_snippet.
1469 g_test_bug (const char *bug_uri_snippet)
1473 g_return_if_fail (test_uri_base != NULL);
1474 g_return_if_fail (bug_uri_snippet != NULL);
1476 c = strstr (test_uri_base, "%s");
1479 char *b = g_strndup (test_uri_base, c - test_uri_base);
1480 char *s = g_strconcat (b, bug_uri_snippet, c + 2, NULL);
1482 g_test_message ("Bug Reference: %s", s);
1486 g_test_message ("Bug Reference: %s%s", test_uri_base, bug_uri_snippet);
1492 * Get the toplevel test suite for the test path API.
1494 * Returns: the toplevel #GTestSuite
1499 g_test_get_root (void)
1501 if (!test_suite_root)
1503 test_suite_root = g_test_create_suite ("root");
1504 g_free (test_suite_root->name);
1505 test_suite_root->name = g_strdup ("");
1508 return test_suite_root;
1514 * Runs all tests under the toplevel suite which can be retrieved
1515 * with g_test_get_root(). Similar to g_test_run_suite(), the test
1516 * cases to be run are filtered according to
1517 * test path arguments (-p <replaceable>testpath</replaceable>) as
1518 * parsed by g_test_init().
1519 * g_test_run_suite() or g_test_run() may only be called once
1522 * In general, the tests and sub-suites within each suite are run in
1523 * the order in which they are defined. However, note that prior to
1524 * GLib 2.36, there was a bug in the <literal>g_test_add_*</literal>
1525 * functions which caused them to create multiple suites with the same
1526 * name, meaning that if you created tests "/foo/simple",
1527 * "/bar/simple", and "/foo/using-bar" in that order, they would get
1528 * run in that order (since g_test_run() would run the first "/foo"
1529 * suite, then the "/bar" suite, then the second "/foo" suite). As of
1530 * 2.36, this bug is fixed, and adding the tests in that order would
1531 * result in a running order of "/foo/simple", "/foo/using-bar",
1532 * "/bar/simple". If this new ordering is sub-optimal (because it puts
1533 * more-complicated tests before simpler ones, making it harder to
1534 * figure out exactly what has failed), you can fix it by changing the
1535 * test paths to group tests by suite in a way that will result in the
1536 * desired running order. Eg, "/simple/foo", "/simple/bar",
1537 * "/complex/foo-using-bar".
1539 * However, you should never make the actual result of a test depend
1540 * on the order that tests are run in. If you need to ensure that some
1541 * particular code runs before or after a given test case, use
1542 * g_test_add(), which lets you specify setup and teardown functions.
1544 * Returns: 0 on success, 1 on failure (assuming it returns at all),
1545 * 77 if all tests were skipped with g_test_skip().
1552 if (g_test_run_suite (g_test_get_root()) != 0)
1555 if (test_run_count > 0 && test_run_count == test_skipped_count)
1562 * g_test_create_case:
1563 * @test_name: the name for the test case
1564 * @data_size: the size of the fixture data structure
1565 * @test_data: test data argument for the test functions
1566 * @data_setup: the function to set up the fixture data
1567 * @data_test: the actual test function
1568 * @data_teardown: the function to teardown the fixture data
1570 * Create a new #GTestCase, named @test_name, this API is fairly
1571 * low level, calling g_test_add() or g_test_add_func() is preferable.
1572 * When this test is executed, a fixture structure of size @data_size
1573 * will be allocated and filled with 0s. Then @data_setup is called
1574 * to initialize the fixture. After fixture setup, the actual test
1575 * function @data_test is called. Once the test run completed, the
1576 * fixture structure is torn down by calling @data_teardown and
1577 * after that the memory is released.
1579 * Splitting up a test run into fixture setup, test function and
1580 * fixture teardown is most usful if the same fixture is used for
1581 * multiple tests. In this cases, g_test_create_case() will be
1582 * called with the same fixture, but varying @test_name and
1583 * @data_test arguments.
1585 * Returns: a newly allocated #GTestCase.
1590 g_test_create_case (const char *test_name,
1592 gconstpointer test_data,
1593 GTestFixtureFunc data_setup,
1594 GTestFixtureFunc data_test,
1595 GTestFixtureFunc data_teardown)
1599 g_return_val_if_fail (test_name != NULL, NULL);
1600 g_return_val_if_fail (strchr (test_name, '/') == NULL, NULL);
1601 g_return_val_if_fail (test_name[0] != 0, NULL);
1602 g_return_val_if_fail (data_test != NULL, NULL);
1604 tc = g_slice_new0 (GTestCase);
1605 tc->name = g_strdup (test_name);
1606 tc->test_data = (gpointer) test_data;
1607 tc->fixture_size = data_size;
1608 tc->fixture_setup = (void*) data_setup;
1609 tc->fixture_test = (void*) data_test;
1610 tc->fixture_teardown = (void*) data_teardown;
1616 find_suite (gconstpointer l, gconstpointer s)
1618 const GTestSuite *suite = l;
1619 const gchar *str = s;
1621 return strcmp (suite->name, str);
1626 * @fixture: the test fixture
1627 * @user_data: the data provided when registering the test
1629 * The type used for functions that operate on test fixtures. This is
1630 * used for the fixture setup and teardown functions as well as for the
1631 * testcases themselves.
1633 * @user_data is a pointer to the data that was given when registering
1636 * @fixture will be a pointer to the area of memory allocated by the
1637 * test framework, of the size requested. If the requested size was
1638 * zero then @fixture will be equal to @user_data.
1643 g_test_add_vtable (const char *testpath,
1645 gconstpointer test_data,
1646 GTestFixtureFunc data_setup,
1647 GTestFixtureFunc fixture_test_func,
1648 GTestFixtureFunc data_teardown)
1654 g_return_if_fail (testpath != NULL);
1655 g_return_if_fail (g_path_is_absolute (testpath));
1656 g_return_if_fail (fixture_test_func != NULL);
1658 if (g_slist_find_custom (test_paths_skipped, testpath, (GCompareFunc)g_strcmp0))
1661 suite = g_test_get_root();
1662 segments = g_strsplit (testpath, "/", -1);
1663 for (ui = 0; segments[ui] != NULL; ui++)
1665 const char *seg = segments[ui];
1666 gboolean islast = segments[ui + 1] == NULL;
1667 if (islast && !seg[0])
1668 g_error ("invalid test case path: %s", testpath);
1670 continue; /* initial or duplicate slash */
1675 l = g_slist_find_custom (suite->suites, seg, find_suite);
1682 csuite = g_test_create_suite (seg);
1683 g_test_suite_add_suite (suite, csuite);
1689 GTestCase *tc = g_test_create_case (seg, data_size, test_data, data_setup, fixture_test_func, data_teardown);
1690 g_test_suite_add (suite, tc);
1693 g_strfreev (segments);
1699 * Indicates that a test failed. This function can be called
1700 * multiple times from the same test. You can use this function
1701 * if your test failed in a recoverable way.
1703 * Do not use this function if the failure of a test could cause
1704 * other tests to malfunction.
1706 * Calling this function will not stop the test from running, you
1707 * need to return from the test function yourself. So you can
1708 * produce additional diagnostic messages or even continue running
1711 * If not called from inside a test, this function does nothing.
1718 test_run_success = G_TEST_RUN_FAILURE;
1722 * g_test_incomplete:
1723 * @msg: (allow-none): explanation
1725 * Indicates that a test failed because of some incomplete
1726 * functionality. This function can be called multiple times
1727 * from the same test.
1729 * Calling this function will not stop the test from running, you
1730 * need to return from the test function yourself. So you can
1731 * produce additional diagnostic messages or even continue running
1734 * If not called from inside a test, this function does nothing.
1739 g_test_incomplete (const gchar *msg)
1741 test_run_success = G_TEST_RUN_INCOMPLETE;
1742 g_free (test_run_msg);
1743 test_run_msg = g_strdup (msg);
1748 * @msg: (allow-none): explanation
1750 * Indicates that a test was skipped.
1752 * Calling this function will not stop the test from running, you
1753 * need to return from the test function yourself. So you can
1754 * produce additional diagnostic messages or even continue running
1757 * If not called from inside a test, this function does nothing.
1762 g_test_skip (const gchar *msg)
1764 test_run_success = G_TEST_RUN_SKIPPED;
1765 g_free (test_run_msg);
1766 test_run_msg = g_strdup (msg);
1772 * Returns whether a test has already failed. This will
1773 * be the case when g_test_fail(), g_test_incomplete()
1774 * or g_test_skip() have been called, but also if an
1775 * assertion has failed.
1777 * This can be useful to return early from a test if
1778 * continuing after a failed assertion might be harmful.
1780 * The return value of this function is only meaningful
1781 * if it is called from inside a test function.
1783 * Returns: %TRUE if the test has failed
1788 g_test_failed (void)
1790 return test_run_success != G_TEST_RUN_SUCCESS;
1794 * g_test_set_nonfatal_assertions:
1796 * Changes the behaviour of g_assert_cmpstr(), g_assert_cmpint(),
1797 * g_assert_cmpuint(), g_assert_cmphex(), g_assert_cmpfloat(),
1798 * g_assert_true(), g_assert_false(), g_assert_null(), g_assert_no_error(),
1799 * g_assert_error(), g_test_assert_expected_messages() and the various
1800 * g_test_trap_assert_*() macros to not abort to program, but instead
1801 * call g_test_fail() and continue. (This also changes the behavior of
1802 * g_test_fail() so that it will not cause the test program to abort
1803 * after completing the failed test.)
1805 * Note that the g_assert_not_reached() and g_assert() are not
1808 * This function can only be called after g_test_init().
1813 g_test_set_nonfatal_assertions (void)
1815 if (!g_test_config_vars->test_initialized)
1816 g_error ("g_test_set_nonfatal_assertions called without g_test_init");
1817 test_nonfatal_assertions = TRUE;
1818 test_mode_fatal = FALSE;
1824 * The type used for test case functions.
1831 * @testpath: /-separated test case path name for the test.
1832 * @test_func: The test function to invoke for this test.
1834 * Create a new test case, similar to g_test_create_case(). However
1835 * the test is assumed to use no fixture, and test suites are automatically
1836 * created on the fly and added to the root fixture, based on the
1837 * slash-separated portions of @testpath.
1839 * If @testpath includes the component "subprocess" anywhere in it,
1840 * the test will be skipped by default, and only run if explicitly
1841 * required via the <option>-p</option> command-line option or
1842 * g_test_trap_subprocess().
1847 g_test_add_func (const char *testpath,
1848 GTestFunc test_func)
1850 g_return_if_fail (testpath != NULL);
1851 g_return_if_fail (testpath[0] == '/');
1852 g_return_if_fail (test_func != NULL);
1853 g_test_add_vtable (testpath, 0, NULL, NULL, (GTestFixtureFunc) test_func, NULL);
1858 * @user_data: the data provided when registering the test
1860 * The type used for test case functions that take an extra pointer
1867 * g_test_add_data_func:
1868 * @testpath: /-separated test case path name for the test.
1869 * @test_data: Test data argument for the test function.
1870 * @test_func: The test function to invoke for this test.
1872 * Create a new test case, similar to g_test_create_case(). However
1873 * the test is assumed to use no fixture, and test suites are automatically
1874 * created on the fly and added to the root fixture, based on the
1875 * slash-separated portions of @testpath. The @test_data argument
1876 * will be passed as first argument to @test_func.
1878 * If @testpath includes the component "subprocess" anywhere in it,
1879 * the test will be skipped by default, and only run if explicitly
1880 * required via the <option>-p</option> command-line option or
1881 * g_test_trap_subprocess().
1886 g_test_add_data_func (const char *testpath,
1887 gconstpointer test_data,
1888 GTestDataFunc test_func)
1890 g_return_if_fail (testpath != NULL);
1891 g_return_if_fail (testpath[0] == '/');
1892 g_return_if_fail (test_func != NULL);
1894 g_test_add_vtable (testpath, 0, test_data, NULL, (GTestFixtureFunc) test_func, NULL);
1898 * g_test_add_data_func_full:
1899 * @testpath: /-separated test case path name for the test.
1900 * @test_data: Test data argument for the test function.
1901 * @test_func: The test function to invoke for this test.
1902 * @data_free_func: #GDestroyNotify for @test_data.
1904 * Create a new test case, as with g_test_add_data_func(), but freeing
1905 * @test_data after the test run is complete.
1910 g_test_add_data_func_full (const char *testpath,
1912 GTestDataFunc test_func,
1913 GDestroyNotify data_free_func)
1915 g_return_if_fail (testpath != NULL);
1916 g_return_if_fail (testpath[0] == '/');
1917 g_return_if_fail (test_func != NULL);
1919 g_test_add_vtable (testpath, 0, test_data, NULL,
1920 (GTestFixtureFunc) test_func,
1921 (GTestFixtureFunc) data_free_func);
1925 g_test_suite_case_exists (GTestSuite *suite,
1926 const char *test_path)
1933 slash = strchr (test_path, '/');
1937 for (iter = suite->suites; iter; iter = iter->next)
1939 GTestSuite *child_suite = iter->data;
1941 if (!strncmp (child_suite->name, test_path, slash - test_path))
1942 if (g_test_suite_case_exists (child_suite, slash))
1948 for (iter = suite->cases; iter; iter = iter->next)
1951 if (!strcmp (tc->name, test_path))
1960 * g_test_create_suite:
1961 * @suite_name: a name for the suite
1963 * Create a new test suite with the name @suite_name.
1965 * Returns: A newly allocated #GTestSuite instance.
1970 g_test_create_suite (const char *suite_name)
1973 g_return_val_if_fail (suite_name != NULL, NULL);
1974 g_return_val_if_fail (strchr (suite_name, '/') == NULL, NULL);
1975 g_return_val_if_fail (suite_name[0] != 0, NULL);
1976 ts = g_slice_new0 (GTestSuite);
1977 ts->name = g_strdup (suite_name);
1983 * @suite: a #GTestSuite
1984 * @test_case: a #GTestCase
1986 * Adds @test_case to @suite.
1991 g_test_suite_add (GTestSuite *suite,
1992 GTestCase *test_case)
1994 g_return_if_fail (suite != NULL);
1995 g_return_if_fail (test_case != NULL);
1997 suite->cases = g_slist_prepend (suite->cases, test_case);
2001 * g_test_suite_add_suite:
2002 * @suite: a #GTestSuite
2003 * @nestedsuite: another #GTestSuite
2005 * Adds @nestedsuite to @suite.
2010 g_test_suite_add_suite (GTestSuite *suite,
2011 GTestSuite *nestedsuite)
2013 g_return_if_fail (suite != NULL);
2014 g_return_if_fail (nestedsuite != NULL);
2016 suite->suites = g_slist_prepend (suite->suites, nestedsuite);
2020 * g_test_queue_free:
2021 * @gfree_pointer: the pointer to be stored.
2023 * Enqueue a pointer to be released with g_free() during the next
2024 * teardown phase. This is equivalent to calling g_test_queue_destroy()
2025 * with a destroy callback of g_free().
2030 g_test_queue_free (gpointer gfree_pointer)
2033 g_test_queue_destroy (g_free, gfree_pointer);
2037 * g_test_queue_destroy:
2038 * @destroy_func: Destroy callback for teardown phase.
2039 * @destroy_data: Destroy callback data.
2041 * This function enqueus a callback @destroy_func to be executed
2042 * during the next test case teardown phase. This is most useful
2043 * to auto destruct allocted test resources at the end of a test run.
2044 * Resources are released in reverse queue order, that means enqueueing
2045 * callback A before callback B will cause B() to be called before
2046 * A() during teardown.
2051 g_test_queue_destroy (GDestroyNotify destroy_func,
2052 gpointer destroy_data)
2054 DestroyEntry *dentry;
2056 g_return_if_fail (destroy_func != NULL);
2058 dentry = g_slice_new0 (DestroyEntry);
2059 dentry->destroy_func = destroy_func;
2060 dentry->destroy_data = destroy_data;
2061 dentry->next = test_destroy_queue;
2062 test_destroy_queue = dentry;
2066 test_case_run (GTestCase *tc)
2068 gchar *old_name = test_run_name, *old_base = g_strdup (test_uri_base);
2069 GSList **old_free_list, *filename_free_list = NULL;
2070 gboolean success = G_TEST_RUN_SUCCESS;
2072 old_free_list = test_filename_free_list;
2073 test_filename_free_list = &filename_free_list;
2075 test_run_name = g_strconcat (old_name, "/", tc->name, NULL);
2076 if (strstr (test_run_name, "/subprocess"))
2079 gboolean found = FALSE;
2081 for (iter = test_paths; iter; iter = iter->next)
2083 if (!strcmp (test_run_name, iter->data))
2092 if (g_test_verbose ())
2093 g_print ("GTest: skipping: %s\n", test_run_name);
2098 if (++test_run_count <= test_startup_skip_count)
2099 g_test_log (G_TEST_LOG_SKIP_CASE, test_run_name, NULL, 0, NULL);
2100 else if (test_run_list)
2102 g_print ("%s\n", test_run_name);
2103 g_test_log (G_TEST_LOG_LIST_CASE, test_run_name, NULL, 0, NULL);
2107 GTimer *test_run_timer = g_timer_new();
2108 long double largs[3];
2110 g_test_log (G_TEST_LOG_START_CASE, test_run_name, NULL, 0, NULL);
2112 test_run_success = G_TEST_RUN_SUCCESS;
2113 g_clear_pointer (&test_run_msg, g_free);
2114 g_test_log_set_fatal_handler (NULL, NULL);
2115 g_timer_start (test_run_timer);
2116 fixture = tc->fixture_size ? g_malloc0 (tc->fixture_size) : tc->test_data;
2117 test_run_seed (test_run_seedstr);
2118 if (tc->fixture_setup)
2119 tc->fixture_setup (fixture, tc->test_data);
2120 tc->fixture_test (fixture, tc->test_data);
2122 while (test_destroy_queue)
2124 DestroyEntry *dentry = test_destroy_queue;
2125 test_destroy_queue = dentry->next;
2126 dentry->destroy_func (dentry->destroy_data);
2127 g_slice_free (DestroyEntry, dentry);
2129 if (tc->fixture_teardown)
2130 tc->fixture_teardown (fixture, tc->test_data);
2131 if (tc->fixture_size)
2133 g_timer_stop (test_run_timer);
2134 success = test_run_success;
2135 test_run_success = G_TEST_RUN_FAILURE;
2136 largs[0] = success; /* OK */
2137 largs[1] = test_run_forks;
2138 largs[2] = g_timer_elapsed (test_run_timer, NULL);
2139 g_test_log (G_TEST_LOG_STOP_CASE, test_run_name, test_run_msg, G_N_ELEMENTS (largs), largs);
2140 g_clear_pointer (&test_run_msg, g_free);
2141 g_timer_destroy (test_run_timer);
2145 g_slist_free_full (filename_free_list, g_free);
2146 test_filename_free_list = old_free_list;
2147 g_free (test_run_name);
2148 test_run_name = old_name;
2149 g_free (test_uri_base);
2150 test_uri_base = old_base;
2152 return (success == G_TEST_RUN_SUCCESS ||
2153 success == G_TEST_RUN_SKIPPED);
2157 g_test_run_suite_internal (GTestSuite *suite,
2161 gchar *rest, *old_name = test_run_name;
2162 GSList *slist, *reversed;
2164 g_return_val_if_fail (suite != NULL, -1);
2166 g_test_log (G_TEST_LOG_START_SUITE, suite->name, NULL, 0, NULL);
2168 while (path[0] == '/')
2171 rest = strchr (path, '/');
2172 l = rest ? MIN (l, rest - path) : l;
2173 test_run_name = suite->name[0] == 0 ? g_strdup (test_run_name) : g_strconcat (old_name, "/", suite->name, NULL);
2174 reversed = g_slist_reverse (g_slist_copy (suite->cases));
2175 for (slist = reversed; slist; slist = slist->next)
2177 GTestCase *tc = slist->data;
2178 guint n = l ? strlen (tc->name) : 0;
2179 if (l == n && !rest && strncmp (path, tc->name, n) == 0)
2181 if (!test_case_run (tc))
2185 g_slist_free (reversed);
2186 reversed = g_slist_reverse (g_slist_copy (suite->suites));
2187 for (slist = reversed; slist; slist = slist->next)
2189 GTestSuite *ts = slist->data;
2190 guint n = l ? strlen (ts->name) : 0;
2191 if (l == n && strncmp (path, ts->name, n) == 0)
2192 n_bad += g_test_run_suite_internal (ts, rest ? rest : "");
2194 g_slist_free (reversed);
2195 g_free (test_run_name);
2196 test_run_name = old_name;
2198 g_test_log (G_TEST_LOG_STOP_SUITE, suite->name, NULL, 0, NULL);
2205 * @suite: a #GTestSuite
2207 * Execute the tests within @suite and all nested #GTestSuites.
2208 * The test suites to be executed are filtered according to
2209 * test path arguments (-p <replaceable>testpath</replaceable>)
2210 * as parsed by g_test_init(). See the g_test_run() documentation
2211 * for more information on the order that tests are run in.
2213 * g_test_run_suite() or g_test_run() may only be called once
2216 * Returns: 0 on success
2221 g_test_run_suite (GTestSuite *suite)
2223 GSList *my_test_paths;
2226 g_return_val_if_fail (g_test_config_vars->test_initialized, -1);
2227 g_return_val_if_fail (g_test_run_once == TRUE, -1);
2229 g_test_run_once = FALSE;
2232 my_test_paths = g_slist_copy (test_paths);
2234 my_test_paths = g_slist_prepend (NULL, "");
2236 while (my_test_paths)
2238 const char *rest, *path = my_test_paths->data;
2239 guint l, n = strlen (suite->name);
2240 my_test_paths = g_slist_delete_link (my_test_paths, my_test_paths);
2241 while (path[0] == '/')
2243 if (!n) /* root suite, run unconditionally */
2245 n_bad += g_test_run_suite_internal (suite, path);
2248 /* regular suite, match path */
2249 rest = strchr (path, '/');
2251 l = rest ? MIN (l, rest - path) : l;
2252 if ((!l || l == n) && strncmp (path, suite->name, n) == 0)
2253 n_bad += g_test_run_suite_internal (suite, rest ? rest : "");
2260 gtest_default_log_handler (const gchar *log_domain,
2261 GLogLevelFlags log_level,
2262 const gchar *message,
2263 gpointer unused_data)
2265 const gchar *strv[16];
2266 gboolean fatal = FALSE;
2272 strv[i++] = log_domain;
2275 if (log_level & G_LOG_FLAG_FATAL)
2277 strv[i++] = "FATAL-";
2280 if (log_level & G_LOG_FLAG_RECURSION)
2281 strv[i++] = "RECURSIVE-";
2282 if (log_level & G_LOG_LEVEL_ERROR)
2283 strv[i++] = "ERROR";
2284 if (log_level & G_LOG_LEVEL_CRITICAL)
2285 strv[i++] = "CRITICAL";
2286 if (log_level & G_LOG_LEVEL_WARNING)
2287 strv[i++] = "WARNING";
2288 if (log_level & G_LOG_LEVEL_MESSAGE)
2289 strv[i++] = "MESSAGE";
2290 if (log_level & G_LOG_LEVEL_INFO)
2292 if (log_level & G_LOG_LEVEL_DEBUG)
2293 strv[i++] = "DEBUG";
2295 strv[i++] = message;
2298 msg = g_strjoinv ("", (gchar**) strv);
2299 g_test_log (fatal ? G_TEST_LOG_ERROR : G_TEST_LOG_MESSAGE, msg, NULL, 0, NULL);
2300 g_log_default_handler (log_domain, log_level, message, unused_data);
2306 g_assertion_message (const char *domain,
2310 const char *message)
2316 message = "code should not be reached";
2317 g_snprintf (lstr, 32, "%d", line);
2318 s = g_strconcat (domain ? domain : "", domain && domain[0] ? ":" : "",
2319 "ERROR:", file, ":", lstr, ":",
2320 func, func[0] ? ":" : "",
2321 " ", message, NULL);
2322 g_printerr ("**\n%s\n", s);
2324 g_test_log (G_TEST_LOG_ERROR, s, NULL, 0, NULL);
2326 if (test_nonfatal_assertions)
2333 /* store assertion message in global variable, so that it can be found in a
2335 if (__glib_assert_msg != NULL)
2336 /* free the old one */
2337 free (__glib_assert_msg);
2338 __glib_assert_msg = (char*) malloc (strlen (s) + 1);
2339 strcpy (__glib_assert_msg, s);
2343 if (test_in_subprocess)
2345 /* If this is a test case subprocess then it probably hit this
2346 * assertion on purpose, so just exit() rather than abort()ing,
2347 * to avoid triggering any system crash-reporting daemon.
2356 g_assertion_message_expr (const char *domain,
2364 s = g_strdup ("code should not be reached");
2366 s = g_strconcat ("assertion failed: (", expr, ")", NULL);
2367 g_assertion_message (domain, file, line, func, s);
2370 /* Normally g_assertion_message() won't return, but we need this for
2371 * when test_nonfatal_assertions is set, since
2372 * g_assertion_message_expr() is used for always-fatal assertions.
2374 if (test_in_subprocess)
2381 g_assertion_message_cmpnum (const char *domain,
2395 case 'i': s = g_strdup_printf ("assertion failed (%s): (%" G_GINT64_MODIFIER "i %s %" G_GINT64_MODIFIER "i)", expr, (gint64) arg1, cmp, (gint64) arg2); break;
2396 case 'x': s = g_strdup_printf ("assertion failed (%s): (0x%08" G_GINT64_MODIFIER "x %s 0x%08" G_GINT64_MODIFIER "x)", expr, (guint64) arg1, cmp, (guint64) arg2); break;
2397 case 'f': s = g_strdup_printf ("assertion failed (%s): (%.9g %s %.9g)", expr, (double) arg1, cmp, (double) arg2); break;
2398 /* ideally use: floats=%.7g double=%.17g */
2400 g_assertion_message (domain, file, line, func, s);
2405 g_assertion_message_cmpstr (const char *domain,
2414 char *a1, *a2, *s, *t1 = NULL, *t2 = NULL;
2415 a1 = arg1 ? g_strconcat ("\"", t1 = g_strescape (arg1, NULL), "\"", NULL) : g_strdup ("NULL");
2416 a2 = arg2 ? g_strconcat ("\"", t2 = g_strescape (arg2, NULL), "\"", NULL) : g_strdup ("NULL");
2419 s = g_strdup_printf ("assertion failed (%s): (%s %s %s)", expr, a1, cmp, a2);
2422 g_assertion_message (domain, file, line, func, s);
2427 g_assertion_message_error (const char *domain,
2432 const GError *error,
2433 GQuark error_domain,
2438 /* This is used by both g_assert_error() and g_assert_no_error(), so there
2439 * are three cases: expected an error but got the wrong error, expected
2440 * an error but got no error, and expected no error but got an error.
2443 gstring = g_string_new ("assertion failed ");
2445 g_string_append_printf (gstring, "(%s == (%s, %d)): ", expr,
2446 g_quark_to_string (error_domain), error_code);
2448 g_string_append_printf (gstring, "(%s == NULL): ", expr);
2451 g_string_append_printf (gstring, "%s (%s, %d)", error->message,
2452 g_quark_to_string (error->domain), error->code);
2454 g_string_append_printf (gstring, "%s is NULL", expr);
2456 g_assertion_message (domain, file, line, func, gstring->str);
2457 g_string_free (gstring, TRUE);
2462 * @str1: (allow-none): a C string or %NULL
2463 * @str2: (allow-none): another C string or %NULL
2465 * Compares @str1 and @str2 like strcmp(). Handles %NULL
2466 * gracefully by sorting it before non-%NULL strings.
2467 * Comparing two %NULL pointers returns 0.
2469 * Returns: an integer less than, equal to, or greater than zero, if @str1 is <, == or > than @str2.
2474 g_strcmp0 (const char *str1,
2478 return -(str1 != str2);
2480 return str1 != str2;
2481 return strcmp (str1, str2);
2485 test_trap_clear (void)
2487 test_trap_last_status = 0;
2488 test_trap_last_pid = 0;
2489 g_clear_pointer (&test_trap_last_subprocess, g_free);
2490 g_clear_pointer (&test_trap_last_stdout, g_free);
2491 g_clear_pointer (&test_trap_last_stderr, g_free);
2502 ret = dup2 (fd1, fd2);
2503 while (ret < 0 && errno == EINTR);
2514 GIOChannel *stdout_io;
2515 gboolean echo_stdout;
2516 GString *stdout_str;
2518 GIOChannel *stderr_io;
2519 gboolean echo_stderr;
2520 GString *stderr_str;
2524 check_complete (WaitForChildData *data)
2526 if (data->child_status != -1 && data->stdout_io == NULL && data->stderr_io == NULL)
2527 g_main_loop_quit (data->loop);
2531 child_exited (GPid pid,
2535 WaitForChildData *data = user_data;
2538 if (WIFEXITED (status)) /* normal exit */
2539 data->child_status = WEXITSTATUS (status); /* 0..255 */
2540 else if (WIFSIGNALED (status) && WTERMSIG (status) == SIGALRM)
2541 data->child_status = G_TEST_STATUS_TIMED_OUT;
2542 else if (WIFSIGNALED (status))
2543 data->child_status = (WTERMSIG (status) << 12); /* signalled */
2544 else /* WCOREDUMP (status) */
2545 data->child_status = 512; /* coredump */
2547 data->child_status = status;
2550 check_complete (data);
2554 child_timeout (gpointer user_data)
2556 WaitForChildData *data = user_data;
2559 TerminateProcess (data->pid, G_TEST_STATUS_TIMED_OUT);
2561 kill (data->pid, SIGALRM);
2568 child_read (GIOChannel *io, GIOCondition cond, gpointer user_data)
2570 WaitForChildData *data = user_data;
2572 gsize nread, nwrote, total;
2574 FILE *echo_file = NULL;
2576 status = g_io_channel_read_chars (io, buf, sizeof (buf), &nread, NULL);
2577 if (status == G_IO_STATUS_ERROR || status == G_IO_STATUS_EOF)
2579 // FIXME data->error = (status == G_IO_STATUS_ERROR);
2580 if (io == data->stdout_io)
2581 g_clear_pointer (&data->stdout_io, g_io_channel_unref);
2583 g_clear_pointer (&data->stderr_io, g_io_channel_unref);
2585 check_complete (data);
2588 else if (status == G_IO_STATUS_AGAIN)
2591 if (io == data->stdout_io)
2593 g_string_append_len (data->stdout_str, buf, nread);
2594 if (data->echo_stdout)
2599 g_string_append_len (data->stderr_str, buf, nread);
2600 if (data->echo_stderr)
2606 for (total = 0; total < nread; total += nwrote)
2608 nwrote = fwrite (buf + total, 1, nread - total, echo_file);
2610 g_error ("write failed: %s", g_strerror (errno));
2618 wait_for_child (GPid pid,
2619 int stdout_fd, gboolean echo_stdout,
2620 int stderr_fd, gboolean echo_stderr,
2623 WaitForChildData data;
2624 GMainContext *context;
2628 data.child_status = -1;
2630 context = g_main_context_new ();
2631 data.loop = g_main_loop_new (context, FALSE);
2633 source = g_child_watch_source_new (pid);
2634 g_source_set_callback (source, (GSourceFunc) child_exited, &data, NULL);
2635 g_source_attach (source, context);
2636 g_source_unref (source);
2638 data.echo_stdout = echo_stdout;
2639 data.stdout_str = g_string_new (NULL);
2640 data.stdout_io = g_io_channel_unix_new (stdout_fd);
2641 g_io_channel_set_close_on_unref (data.stdout_io, TRUE);
2642 g_io_channel_set_encoding (data.stdout_io, NULL, NULL);
2643 g_io_channel_set_buffered (data.stdout_io, FALSE);
2644 source = g_io_create_watch (data.stdout_io, G_IO_IN | G_IO_ERR | G_IO_HUP);
2645 g_source_set_callback (source, (GSourceFunc) child_read, &data, NULL);
2646 g_source_attach (source, context);
2647 g_source_unref (source);
2649 data.echo_stderr = echo_stderr;
2650 data.stderr_str = g_string_new (NULL);
2651 data.stderr_io = g_io_channel_unix_new (stderr_fd);
2652 g_io_channel_set_close_on_unref (data.stderr_io, TRUE);
2653 g_io_channel_set_encoding (data.stderr_io, NULL, NULL);
2654 g_io_channel_set_buffered (data.stderr_io, FALSE);
2655 source = g_io_create_watch (data.stderr_io, G_IO_IN | G_IO_ERR | G_IO_HUP);
2656 g_source_set_callback (source, (GSourceFunc) child_read, &data, NULL);
2657 g_source_attach (source, context);
2658 g_source_unref (source);
2662 source = g_timeout_source_new (0);
2663 g_source_set_ready_time (source, g_get_monotonic_time () + timeout);
2664 g_source_set_callback (source, (GSourceFunc) child_timeout, &data, NULL);
2665 g_source_attach (source, context);
2666 g_source_unref (source);
2669 g_main_loop_run (data.loop);
2670 g_main_loop_unref (data.loop);
2671 g_main_context_unref (context);
2673 test_trap_last_pid = pid;
2674 test_trap_last_status = data.child_status;
2675 test_trap_last_stdout = g_string_free (data.stdout_str, FALSE);
2676 test_trap_last_stderr = g_string_free (data.stderr_str, FALSE);
2678 g_clear_pointer (&data.stdout_io, g_io_channel_unref);
2679 g_clear_pointer (&data.stderr_io, g_io_channel_unref);
2684 * @usec_timeout: Timeout for the forked test in micro seconds.
2685 * @test_trap_flags: Flags to modify forking behaviour.
2687 * Fork the current test program to execute a test case that might
2688 * not return or that might abort.
2690 * If @usec_timeout is non-0, the forked test case is aborted and
2691 * considered failing if its run time exceeds it.
2693 * The forking behavior can be configured with the #GTestTrapFlags flags.
2695 * In the following example, the test code forks, the forked child
2696 * process produces some sample output and exits successfully.
2697 * The forking parent process then asserts successful child program
2698 * termination and validates child program outputs.
2702 * test_fork_patterns (void)
2704 * if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
2706 * g_print ("some stdout text: somagic17\n");
2707 * g_printerr ("some stderr text: semagic43\n");
2708 * exit (0); /* successful test run */
2710 * g_test_trap_assert_passed ();
2711 * g_test_trap_assert_stdout ("*somagic17*");
2712 * g_test_trap_assert_stderr ("*semagic43*");
2716 * Returns: %TRUE for the forked child and %FALSE for the executing parent process.
2720 * Deprecated: This function is implemented only on Unix platforms,
2721 * and is not always reliable due to problems inherent in
2722 * fork-without-exec. Use g_test_trap_subprocess() instead.
2725 g_test_trap_fork (guint64 usec_timeout,
2726 GTestTrapFlags test_trap_flags)
2729 int stdout_pipe[2] = { -1, -1 };
2730 int stderr_pipe[2] = { -1, -1 };
2733 if (pipe (stdout_pipe) < 0 || pipe (stderr_pipe) < 0)
2734 g_error ("failed to create pipes to fork test program: %s", g_strerror (errno));
2735 test_trap_last_pid = fork ();
2736 if (test_trap_last_pid < 0)
2737 g_error ("failed to fork test program: %s", g_strerror (errno));
2738 if (test_trap_last_pid == 0) /* child */
2741 close (stdout_pipe[0]);
2742 close (stderr_pipe[0]);
2743 if (!(test_trap_flags & G_TEST_TRAP_INHERIT_STDIN))
2744 fd0 = g_open ("/dev/null", O_RDONLY, 0);
2745 if (sane_dup2 (stdout_pipe[1], 1) < 0 || sane_dup2 (stderr_pipe[1], 2) < 0 || (fd0 >= 0 && sane_dup2 (fd0, 0) < 0))
2746 g_error ("failed to dup2() in forked test program: %s", g_strerror (errno));
2749 if (stdout_pipe[1] >= 3)
2750 close (stdout_pipe[1]);
2751 if (stderr_pipe[1] >= 3)
2752 close (stderr_pipe[1]);
2758 close (stdout_pipe[1]);
2759 close (stderr_pipe[1]);
2761 wait_for_child (test_trap_last_pid,
2762 stdout_pipe[0], !(test_trap_flags & G_TEST_TRAP_SILENCE_STDOUT),
2763 stderr_pipe[0], !(test_trap_flags & G_TEST_TRAP_SILENCE_STDERR),
2768 g_message ("Not implemented: g_test_trap_fork");
2775 * g_test_trap_subprocess:
2776 * @test_path: (allow-none): Test to run in a subprocess
2777 * @usec_timeout: Timeout for the subprocess test in micro seconds.
2778 * @test_flags: Flags to modify subprocess behaviour.
2780 * Respawns the test program to run only @test_path in a subprocess.
2781 * This can be used for a test case that might not return, or that
2784 * If @test_path is %NULL then the same test is re-run in a subprocess.
2785 * You can use g_test_subprocess() to determine whether the test is in
2786 * a subprocess or not.
2788 * @test_path can also be the name of the parent
2789 * test, followed by "<literal>/subprocess/</literal>" and then a name
2790 * for the specific subtest (or just ending with
2791 * "<literal>/subprocess</literal>" if the test only has one child
2792 * test); tests with names of this form will automatically be skipped
2793 * in the parent process.
2795 * If @usec_timeout is non-0, the test subprocess is aborted and
2796 * considered failing if its run time exceeds it.
2798 * The subprocess behavior can be configured with the
2799 * #GTestSubprocessFlags flags.
2801 * You can use methods such as g_test_trap_assert_passed(),
2802 * g_test_trap_assert_failed(), and g_test_trap_assert_stderr() to
2803 * check the results of the subprocess. (But note that
2804 * g_test_trap_assert_stdout() and g_test_trap_assert_stderr()
2805 * cannot be used if @test_flags specifies that the child should
2806 * inherit the parent stdout/stderr.)
2808 * If your <literal>main ()</literal> needs to behave differently in
2809 * the subprocess, you can call g_test_subprocess() (after calling
2810 * g_test_init()) to see whether you are in a subprocess.
2812 * The following example tests that calling
2813 * <literal>my_object_new(1000000)</literal> will abort with an error
2818 * test_create_large_object_subprocess (void)
2820 * if (g_test_subprocess ())
2822 * my_object_new (1000000);
2826 * /* Reruns this same test in a subprocess */
2827 * g_test_trap_subprocess (NULL, 0, 0);
2828 * g_test_trap_assert_failed ();
2829 * g_test_trap_assert_stderr ("*ERROR*too large*");
2833 * main (int argc, char **argv)
2835 * g_test_init (&argc, &argv, NULL);
2837 * g_test_add_func ("/myobject/create_large_object",
2838 * test_create_large_object);
2839 * return g_test_run ();
2846 g_test_trap_subprocess (const char *test_path,
2847 guint64 usec_timeout,
2848 GTestSubprocessFlags test_flags)
2850 GError *error = NULL;
2853 int stdout_fd, stderr_fd;
2856 /* Sanity check that they used GTestSubprocessFlags, not GTestTrapFlags */
2857 g_assert ((test_flags & (G_TEST_TRAP_INHERIT_STDIN | G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR)) == 0);
2861 if (!g_test_suite_case_exists (g_test_get_root (), test_path))
2862 g_error ("g_test_trap_subprocess: test does not exist: %s", test_path);
2866 test_path = test_run_name;
2869 if (g_test_verbose ())
2870 g_print ("GTest: subprocess: %s\n", test_path);
2873 test_trap_last_subprocess = g_strdup (test_path);
2875 argv = g_ptr_array_new ();
2876 g_ptr_array_add (argv, test_argv0);
2877 g_ptr_array_add (argv, "-q");
2878 g_ptr_array_add (argv, "-p");
2879 g_ptr_array_add (argv, (char *)test_path);
2880 g_ptr_array_add (argv, "--GTestSubprocess");
2881 if (test_log_fd != -1)
2883 char log_fd_buf[128];
2885 g_ptr_array_add (argv, "--GTestLogFD");
2886 g_snprintf (log_fd_buf, sizeof (log_fd_buf), "%d", test_log_fd);
2887 g_ptr_array_add (argv, log_fd_buf);
2889 g_ptr_array_add (argv, NULL);
2891 flags = G_SPAWN_DO_NOT_REAP_CHILD;
2892 if (test_flags & G_TEST_TRAP_INHERIT_STDIN)
2893 flags |= G_SPAWN_CHILD_INHERITS_STDIN;
2895 if (!g_spawn_async_with_pipes (test_initial_cwd,
2896 (char **)argv->pdata,
2899 &pid, NULL, &stdout_fd, &stderr_fd,
2902 g_error ("g_test_trap_subprocess() failed: %s\n",
2905 g_ptr_array_free (argv, TRUE);
2907 wait_for_child (pid,
2908 stdout_fd, !!(test_flags & G_TEST_SUBPROCESS_INHERIT_STDOUT),
2909 stderr_fd, !!(test_flags & G_TEST_SUBPROCESS_INHERIT_STDERR),
2914 * g_test_subprocess:
2916 * Returns %TRUE (after g_test_init() has been called) if the test
2917 * program is running under g_test_trap_subprocess().
2919 * Returns: %TRUE if the test program is running under
2920 * g_test_trap_subprocess().
2925 g_test_subprocess (void)
2927 return test_in_subprocess;
2931 * g_test_trap_has_passed:
2933 * Check the result of the last g_test_trap_subprocess() call.
2935 * Returns: %TRUE if the last test subprocess terminated successfully.
2940 g_test_trap_has_passed (void)
2942 return test_trap_last_status == 0; /* exit_status == 0 && !signal && !coredump */
2946 * g_test_trap_reached_timeout:
2948 * Check the result of the last g_test_trap_subprocess() call.
2950 * Returns: %TRUE if the last test subprocess got killed due to a timeout.
2955 g_test_trap_reached_timeout (void)
2957 return test_trap_last_status == G_TEST_STATUS_TIMED_OUT;
2961 g_test_trap_assertions (const char *domain,
2965 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
2966 const char *pattern)
2968 gboolean must_pass = assertion_flags == 0;
2969 gboolean must_fail = assertion_flags == 1;
2970 gboolean match_result = 0 == (assertion_flags & 1);
2971 const char *stdout_pattern = (assertion_flags & 2) ? pattern : NULL;
2972 const char *stderr_pattern = (assertion_flags & 4) ? pattern : NULL;
2973 const char *match_error = match_result ? "failed to match" : "contains invalid match";
2977 if (test_trap_last_subprocess != NULL)
2979 process_id = g_strdup_printf ("%s [%d]", test_trap_last_subprocess,
2980 test_trap_last_pid);
2982 else if (test_trap_last_pid != 0)
2983 process_id = g_strdup_printf ("%d", test_trap_last_pid);
2985 if (test_trap_last_subprocess != NULL)
2986 process_id = g_strdup (test_trap_last_subprocess);
2989 g_error ("g_test_trap_ assertion with no trapped test");
2991 if (must_pass && !g_test_trap_has_passed())
2993 char *msg = g_strdup_printf ("child process (%s) failed unexpectedly", process_id);
2994 g_assertion_message (domain, file, line, func, msg);
2997 if (must_fail && g_test_trap_has_passed())
2999 char *msg = g_strdup_printf ("child process (%s) did not fail as expected", process_id);
3000 g_assertion_message (domain, file, line, func, msg);
3003 if (stdout_pattern && match_result == !g_pattern_match_simple (stdout_pattern, test_trap_last_stdout))
3005 char *msg = g_strdup_printf ("stdout of child process (%s) %s: %s", process_id, match_error, stdout_pattern);
3006 g_assertion_message (domain, file, line, func, msg);
3009 if (stderr_pattern && match_result == !g_pattern_match_simple (stderr_pattern, test_trap_last_stderr))
3011 char *msg = g_strdup_printf ("stderr of child process (%s) %s: %s", process_id, match_error, stderr_pattern);
3012 g_assertion_message (domain, file, line, func, msg);
3015 g_free (process_id);
3019 gstring_overwrite_int (GString *gstring,
3023 vuint = g_htonl (vuint);
3024 g_string_overwrite_len (gstring, pos, (const gchar*) &vuint, 4);
3028 gstring_append_int (GString *gstring,
3031 vuint = g_htonl (vuint);
3032 g_string_append_len (gstring, (const gchar*) &vuint, 4);
3036 gstring_append_double (GString *gstring,
3039 union { double vdouble; guint64 vuint64; } u;
3040 u.vdouble = vdouble;
3041 u.vuint64 = GUINT64_TO_BE (u.vuint64);
3042 g_string_append_len (gstring, (const gchar*) &u.vuint64, 8);
3046 g_test_log_dump (GTestLogMsg *msg,
3049 GString *gstring = g_string_sized_new (1024);
3051 gstring_append_int (gstring, 0); /* message length */
3052 gstring_append_int (gstring, msg->log_type);
3053 gstring_append_int (gstring, msg->n_strings);
3054 gstring_append_int (gstring, msg->n_nums);
3055 gstring_append_int (gstring, 0); /* reserved */
3056 for (ui = 0; ui < msg->n_strings; ui++)
3058 guint l = strlen (msg->strings[ui]);
3059 gstring_append_int (gstring, l);
3060 g_string_append_len (gstring, msg->strings[ui], l);
3062 for (ui = 0; ui < msg->n_nums; ui++)
3063 gstring_append_double (gstring, msg->nums[ui]);
3064 *len = gstring->len;
3065 gstring_overwrite_int (gstring, 0, *len); /* message length */
3066 return (guint8*) g_string_free (gstring, FALSE);
3069 static inline long double
3070 net_double (const gchar **ipointer)
3072 union { guint64 vuint64; double vdouble; } u;
3073 guint64 aligned_int64;
3074 memcpy (&aligned_int64, *ipointer, 8);
3076 u.vuint64 = GUINT64_FROM_BE (aligned_int64);
3080 static inline guint32
3081 net_int (const gchar **ipointer)
3083 guint32 aligned_int;
3084 memcpy (&aligned_int, *ipointer, 4);
3086 return g_ntohl (aligned_int);
3090 g_test_log_extract (GTestLogBuffer *tbuffer)
3092 const gchar *p = tbuffer->data->str;
3095 if (tbuffer->data->len < 4 * 5)
3097 mlength = net_int (&p);
3098 if (tbuffer->data->len < mlength)
3100 msg.log_type = net_int (&p);
3101 msg.n_strings = net_int (&p);
3102 msg.n_nums = net_int (&p);
3103 if (net_int (&p) == 0)
3106 msg.strings = g_new0 (gchar*, msg.n_strings + 1);
3107 msg.nums = g_new0 (long double, msg.n_nums);
3108 for (ui = 0; ui < msg.n_strings; ui++)
3110 guint sl = net_int (&p);
3111 msg.strings[ui] = g_strndup (p, sl);
3114 for (ui = 0; ui < msg.n_nums; ui++)
3115 msg.nums[ui] = net_double (&p);
3116 if (p <= tbuffer->data->str + mlength)
3118 g_string_erase (tbuffer->data, 0, mlength);
3119 tbuffer->msgs = g_slist_prepend (tbuffer->msgs, g_memdup (&msg, sizeof (msg)));
3124 g_strfreev (msg.strings);
3125 g_error ("corrupt log stream from test program");
3130 * g_test_log_buffer_new:
3132 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
3135 g_test_log_buffer_new (void)
3137 GTestLogBuffer *tb = g_new0 (GTestLogBuffer, 1);
3138 tb->data = g_string_sized_new (1024);
3143 * g_test_log_buffer_free:
3145 * Internal function for gtester to free test log messages, no ABI guarantees provided.
3148 g_test_log_buffer_free (GTestLogBuffer *tbuffer)
3150 g_return_if_fail (tbuffer != NULL);
3151 while (tbuffer->msgs)
3152 g_test_log_msg_free (g_test_log_buffer_pop (tbuffer));
3153 g_string_free (tbuffer->data, TRUE);
3158 * g_test_log_buffer_push:
3160 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
3163 g_test_log_buffer_push (GTestLogBuffer *tbuffer,
3165 const guint8 *bytes)
3167 g_return_if_fail (tbuffer != NULL);
3170 gboolean more_messages;
3171 g_return_if_fail (bytes != NULL);
3172 g_string_append_len (tbuffer->data, (const gchar*) bytes, n_bytes);
3174 more_messages = g_test_log_extract (tbuffer);
3175 while (more_messages);
3180 * g_test_log_buffer_pop:
3182 * Internal function for gtester to retrieve test log messages, no ABI guarantees provided.
3185 g_test_log_buffer_pop (GTestLogBuffer *tbuffer)
3187 GTestLogMsg *msg = NULL;
3188 g_return_val_if_fail (tbuffer != NULL, NULL);
3191 GSList *slist = g_slist_last (tbuffer->msgs);
3193 tbuffer->msgs = g_slist_delete_link (tbuffer->msgs, slist);
3199 * g_test_log_msg_free:
3201 * Internal function for gtester to free test log messages, no ABI guarantees provided.
3204 g_test_log_msg_free (GTestLogMsg *tmsg)
3206 g_return_if_fail (tmsg != NULL);
3207 g_strfreev (tmsg->strings);
3208 g_free (tmsg->nums);
3213 g_test_build_filename_va (GTestFileType file_type,
3214 const gchar *first_path,
3217 const gchar *pathv[16];
3218 gint num_path_segments;
3220 if (file_type == G_TEST_DIST)
3221 pathv[0] = test_disted_files_dir;
3222 else if (file_type == G_TEST_BUILT)
3223 pathv[0] = test_built_files_dir;
3225 g_assert_not_reached ();
3227 pathv[1] = first_path;
3229 for (num_path_segments = 2; num_path_segments < G_N_ELEMENTS (pathv); num_path_segments++)
3231 pathv[num_path_segments] = va_arg (ap, const char *);
3232 if (pathv[num_path_segments] == NULL)
3236 g_assert_cmpint (num_path_segments, <, G_N_ELEMENTS (pathv));
3238 return g_build_filenamev ((gchar **) pathv);
3242 * g_test_build_filename:
3243 * @file_type: the type of file (built vs. distributed)
3244 * @first_path: the first segment of the pathname
3245 * @...: %NULL-terminated additional path segments
3247 * Creates the pathname to a data file that is required for a test.
3249 * This function is conceptually similar to g_build_filename() except
3250 * that the first argument has been replaced with a #GTestFileType
3253 * The data file should either have been distributed with the module
3254 * containing the test (%G_TEST_DIST) or built as part of the build
3255 * system of that module (%G_TEST_BUILT).
3257 * In order for this function to work in srcdir != builddir situations,
3258 * the G_TEST_SRCDIR and G_TEST_BUILDDIR environment variables need to
3259 * have been defined. As of 2.38, this is done by the Makefile.decl
3260 * included in GLib. Please ensure that your copy is up to date before
3261 * using this function.
3263 * In case neither variable is set, this function will fall back to
3264 * using the dirname portion of argv[0], possibly removing ".libs".
3265 * This allows for casual running of tests directly from the commandline
3266 * in the srcdir == builddir case and should also support running of
3267 * installed tests, assuming the data files have been installed in the
3268 * same relative path as the test binary.
3270 * Returns: the path of the file, to be freed using g_free()
3276 * @G_TEST_DIST: a file that was included in the distribution tarball
3277 * @G_TEST_BUILT: a file that was built on the compiling machine
3279 * The type of file to return the filename for, when used with
3280 * g_test_build_filename().
3282 * These two options correspond rather directly to the 'dist' and
3283 * 'built' terminology that automake uses and are explicitly used to
3284 * distinguish between the 'srcdir' and 'builddir' being separate. All
3285 * files in your project should either be dist (in the
3286 * <literal>DIST_EXTRA</literal> or <literal>dist_schema_DATA</literal>
3287 * sense, in which case they will always be in the srcdir) or built (in
3288 * the <literal>BUILT_SOURCES</literal> sense, in which case they will
3289 * always be in the builddir).
3291 * Note: as a general rule of automake, files that are generated only as
3292 * part of the build-from-git process (but then are distributed with the
3293 * tarball) always go in srcdir (even if doing a srcdir != builddir
3294 * build from git) and are considered as distributed files.
3299 g_test_build_filename (GTestFileType file_type,
3300 const gchar *first_path,
3306 g_assert (g_test_initialized ());
3308 va_start (ap, first_path);
3309 result = g_test_build_filename_va (file_type, first_path, ap);
3317 * @file_type: the type of file (built vs. distributed)
3319 * Gets the pathname of the directory containing test files of the type
3320 * specified by @file_type.
3322 * This is approximately the same as calling g_test_build_filename("."),
3323 * but you don't need to free the return value.
3325 * Returns: the path of the directory, owned by GLib
3330 g_test_get_dir (GTestFileType file_type)
3332 g_assert (g_test_initialized ());
3334 if (file_type == G_TEST_DIST)
3335 return test_disted_files_dir;
3336 else if (file_type == G_TEST_BUILT)
3337 return test_built_files_dir;
3339 g_assert_not_reached ();
3343 * g_test_get_filename:
3344 * @file_type: the type of file (built vs. distributed)
3345 * @first_path: the first segment of the pathname
3346 * @...: %NULL-terminated additional path segments
3348 * Gets the pathname to a data file that is required for a test.
3350 * This is the same as g_test_build_filename() with two differences.
3351 * The first difference is that must only use this function from within
3352 * a testcase function. The second difference is that you need not free
3353 * the return value -- it will be automatically freed when the testcase
3356 * It is safe to use this function from a thread inside of a testcase
3357 * but you must ensure that all such uses occur before the main testcase
3358 * function returns (ie: it is best to ensure that all threads have been
3361 * Returns: the path, automatically freed at the end of the testcase
3366 g_test_get_filename (GTestFileType file_type,
3367 const gchar *first_path,
3374 g_assert (g_test_initialized ());
3375 if (test_filename_free_list == NULL)
3376 g_error ("g_test_get_filename() can only be used within testcase functions");
3378 va_start (ap, first_path);
3379 result = g_test_build_filename_va (file_type, first_path, ap);
3382 node = g_slist_prepend (NULL, result);
3384 node->next = *test_filename_free_list;
3385 while (!g_atomic_pointer_compare_and_exchange (test_filename_free_list, node->next, node));
3390 /* --- macros docs START --- */
3393 * @testpath: The test path for a new test case.
3394 * @Fixture: The type of a fixture data structure.
3395 * @tdata: Data argument for the test functions.
3396 * @fsetup: The function to set up the fixture data.
3397 * @ftest: The actual test function.
3398 * @fteardown: The function to tear down the fixture data.
3400 * Hook up a new test case at @testpath, similar to g_test_add_func().
3401 * A fixture data structure with setup and teardown function may be provided
3402 * though, similar to g_test_create_case().
3403 * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
3404 * fteardown() callbacks can expect a @Fixture pointer as first argument in
3405 * a type safe manner.
3409 /* --- macros docs END --- */