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 GTestResult test_run_success = G_TEST_RUN_FAILURE;
611 static gchar *test_run_msg = NULL;
612 static guint test_skip_count = 0;
613 static GTimer *test_user_timer = NULL;
614 static double test_user_stamp = 0;
615 static GSList *test_paths = NULL;
616 static GSList *test_paths_skipped = NULL;
617 static GTestSuite *test_suite_root = NULL;
618 static int test_trap_last_status = 0;
619 static GPid test_trap_last_pid = 0;
620 static char *test_trap_last_subprocess = NULL;
621 static char *test_trap_last_stdout = NULL;
622 static char *test_trap_last_stderr = NULL;
623 static char *test_uri_base = NULL;
624 static gboolean test_debug_log = FALSE;
625 static gboolean test_tap_log = FALSE;
626 static gboolean test_nonfatal_assertions = FALSE;
627 static DestroyEntry *test_destroy_queue = NULL;
628 static char *test_argv0 = NULL;
629 static char *test_argv0_dirname;
630 static const char *test_disted_files_dir;
631 static const char *test_built_files_dir;
632 static char *test_initial_cwd = NULL;
633 static gboolean test_in_subprocess = FALSE;
634 static GTestConfig mutable_test_config_vars = {
635 FALSE, /* test_initialized */
636 TRUE, /* test_quick */
637 FALSE, /* test_perf */
638 FALSE, /* test_verbose */
639 FALSE, /* test_quiet */
640 TRUE, /* test_undefined */
642 const GTestConfig * const g_test_config_vars = &mutable_test_config_vars;
643 static gboolean no_g_set_prgname = FALSE;
645 /* --- functions --- */
647 g_test_log_type_name (GTestLogType log_type)
651 case G_TEST_LOG_NONE: return "none";
652 case G_TEST_LOG_ERROR: return "error";
653 case G_TEST_LOG_START_BINARY: return "binary";
654 case G_TEST_LOG_LIST_CASE: return "list";
655 case G_TEST_LOG_SKIP_CASE: return "skip";
656 case G_TEST_LOG_START_CASE: return "start";
657 case G_TEST_LOG_STOP_CASE: return "stop";
658 case G_TEST_LOG_MIN_RESULT: return "minperf";
659 case G_TEST_LOG_MAX_RESULT: return "maxperf";
660 case G_TEST_LOG_MESSAGE: return "message";
661 case G_TEST_LOG_START_SUITE: return "start suite";
662 case G_TEST_LOG_STOP_SUITE: return "stop suite";
668 g_test_log_send (guint n_bytes,
669 const guint8 *buffer)
671 if (test_log_fd >= 0)
675 r = write (test_log_fd, buffer, n_bytes);
676 while (r < 0 && errno == EINTR);
680 GTestLogBuffer *lbuffer = g_test_log_buffer_new ();
683 g_test_log_buffer_push (lbuffer, n_bytes, buffer);
684 msg = g_test_log_buffer_pop (lbuffer);
685 g_warn_if_fail (msg != NULL);
686 g_warn_if_fail (lbuffer->data->len == 0);
687 g_test_log_buffer_free (lbuffer);
689 g_printerr ("{*LOG(%s)", g_test_log_type_name (msg->log_type));
690 for (ui = 0; ui < msg->n_strings; ui++)
691 g_printerr (":{%s}", msg->strings[ui]);
695 for (ui = 0; ui < msg->n_nums; ui++)
697 if ((long double) (long) msg->nums[ui] == msg->nums[ui])
698 g_printerr ("%s%ld", ui ? ";" : "", (long) msg->nums[ui]);
700 g_printerr ("%s%.16g", ui ? ";" : "", (double) msg->nums[ui]);
704 g_printerr (":LOG*}\n");
705 g_test_log_msg_free (msg);
710 g_test_log (GTestLogType lbit,
711 const gchar *string1,
712 const gchar *string2,
718 gchar *astrings[3] = { NULL, NULL, NULL };
724 case G_TEST_LOG_START_BINARY:
726 g_print ("# random seed: %s\n", string2);
727 else if (g_test_verbose())
728 g_print ("GTest: random seed: %s\n", string2);
730 case G_TEST_LOG_START_SUITE:
734 g_print ("# Start of %s tests\n", string1);
737 case G_TEST_LOG_STOP_SUITE:
741 g_print ("# End of %s tests\n", string1);
743 g_print ("1..%d\n", test_run_count);
746 case G_TEST_LOG_STOP_CASE:
747 fail = largs[0] != G_TEST_RUN_SUCCESS && largs[0] != G_TEST_RUN_SKIPPED;
750 g_print ("%s %d %s", fail ? "not ok" : "ok", test_run_count, string1);
751 if (largs[0] == G_TEST_RUN_INCOMPLETE)
752 g_print (" # TODO %s\n", string2 ? string2 : "");
753 else if (largs[0] == G_TEST_RUN_SKIPPED)
754 g_print (" # SKIP %s\n", string2 ? string2 : "");
758 else if (g_test_verbose())
759 g_print ("GTest: result: %s\n", fail ? "FAIL" : "OK");
760 else if (!g_test_quiet())
761 g_print ("%s\n", fail ? "FAIL" : "OK");
762 if (fail && test_mode_fatal)
765 g_print ("Bail out!\n");
769 case G_TEST_LOG_MIN_RESULT:
771 g_print ("# min perf: %s\n", string1);
772 else if (g_test_verbose())
773 g_print ("(MINPERF:%s)\n", string1);
775 case G_TEST_LOG_MAX_RESULT:
777 g_print ("# max perf: %s\n", string1);
778 else if (g_test_verbose())
779 g_print ("(MAXPERF:%s)\n", string1);
781 case G_TEST_LOG_MESSAGE:
782 case G_TEST_LOG_ERROR:
784 g_print ("# %s\n", string1);
785 else if (g_test_verbose())
786 g_print ("(MSG: %s)\n", string1);
792 msg.n_strings = (string1 != NULL) + (string1 && string2);
793 msg.strings = astrings;
794 astrings[0] = (gchar*) string1;
795 astrings[1] = astrings[0] ? (gchar*) string2 : NULL;
798 dbuffer = g_test_log_dump (&msg, &dbufferlen);
799 g_test_log_send (dbufferlen, dbuffer);
804 case G_TEST_LOG_START_CASE:
807 else if (g_test_verbose())
808 g_print ("GTest: run: %s\n", string1);
809 else if (!g_test_quiet())
810 g_print ("%s: ", string1);
816 /* We intentionally parse the command line without GOptionContext
817 * because otherwise you would never be able to test it.
820 parse_args (gint *argc_p,
823 guint argc = *argc_p;
824 gchar **argv = *argv_p;
827 test_argv0 = argv[0];
828 test_initial_cwd = g_get_current_dir ();
830 /* parse known args */
831 for (i = 1; i < argc; i++)
833 if (strcmp (argv[i], "--g-fatal-warnings") == 0)
835 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
836 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
837 g_log_set_always_fatal (fatal_mask);
840 else if (strcmp (argv[i], "--keep-going") == 0 ||
841 strcmp (argv[i], "-k") == 0)
843 test_mode_fatal = FALSE;
846 else if (strcmp (argv[i], "--debug-log") == 0)
848 test_debug_log = TRUE;
851 else if (strcmp (argv[i], "--tap") == 0)
856 else if (strcmp ("--GTestLogFD", argv[i]) == 0 || strncmp ("--GTestLogFD=", argv[i], 13) == 0)
858 gchar *equal = argv[i] + 12;
860 test_log_fd = g_ascii_strtoull (equal + 1, NULL, 0);
861 else if (i + 1 < argc)
864 test_log_fd = g_ascii_strtoull (argv[i], NULL, 0);
868 else if (strcmp ("--GTestSkipCount", argv[i]) == 0 || strncmp ("--GTestSkipCount=", argv[i], 17) == 0)
870 gchar *equal = argv[i] + 16;
872 test_skip_count = g_ascii_strtoull (equal + 1, NULL, 0);
873 else if (i + 1 < argc)
876 test_skip_count = g_ascii_strtoull (argv[i], NULL, 0);
880 else if (strcmp ("--GTestSubprocess", argv[i]) == 0)
882 test_in_subprocess = TRUE;
883 /* We typically expect these child processes to crash, and some
884 * tests spawn a *lot* of them. Avoid spamming system crash
885 * collection programs such as systemd-coredump and abrt.
887 #ifdef HAVE_SYS_RESOURCE_H
889 struct rlimit limit = { 0, 0 };
890 (void) setrlimit (RLIMIT_CORE, &limit);
895 else if (strcmp ("-p", argv[i]) == 0 || strncmp ("-p=", argv[i], 3) == 0)
897 gchar *equal = argv[i] + 2;
899 test_paths = g_slist_prepend (test_paths, equal + 1);
900 else if (i + 1 < argc)
903 test_paths = g_slist_prepend (test_paths, argv[i]);
907 else if (strcmp ("-s", argv[i]) == 0 || strncmp ("-s=", argv[i], 3) == 0)
909 gchar *equal = argv[i] + 2;
911 test_paths_skipped = g_slist_prepend (test_paths_skipped, equal + 1);
912 else if (i + 1 < argc)
915 test_paths_skipped = g_slist_prepend (test_paths_skipped, argv[i]);
919 else if (strcmp ("-m", argv[i]) == 0 || strncmp ("-m=", argv[i], 3) == 0)
921 gchar *equal = argv[i] + 2;
922 const gchar *mode = "";
925 else if (i + 1 < argc)
930 if (strcmp (mode, "perf") == 0)
931 mutable_test_config_vars.test_perf = TRUE;
932 else if (strcmp (mode, "slow") == 0)
933 mutable_test_config_vars.test_quick = FALSE;
934 else if (strcmp (mode, "thorough") == 0)
935 mutable_test_config_vars.test_quick = FALSE;
936 else if (strcmp (mode, "quick") == 0)
938 mutable_test_config_vars.test_quick = TRUE;
939 mutable_test_config_vars.test_perf = FALSE;
941 else if (strcmp (mode, "undefined") == 0)
942 mutable_test_config_vars.test_undefined = TRUE;
943 else if (strcmp (mode, "no-undefined") == 0)
944 mutable_test_config_vars.test_undefined = FALSE;
946 g_error ("unknown test mode: -m %s", mode);
949 else if (strcmp ("-q", argv[i]) == 0 || strcmp ("--quiet", argv[i]) == 0)
951 mutable_test_config_vars.test_quiet = TRUE;
952 mutable_test_config_vars.test_verbose = FALSE;
955 else if (strcmp ("--verbose", argv[i]) == 0)
957 mutable_test_config_vars.test_quiet = FALSE;
958 mutable_test_config_vars.test_verbose = TRUE;
961 else if (strcmp ("-l", argv[i]) == 0)
963 test_run_list = TRUE;
966 else if (strcmp ("--seed", argv[i]) == 0 || strncmp ("--seed=", argv[i], 7) == 0)
968 gchar *equal = argv[i] + 6;
970 test_run_seedstr = equal + 1;
971 else if (i + 1 < argc)
974 test_run_seedstr = argv[i];
978 else if (strcmp ("-?", argv[i]) == 0 ||
979 strcmp ("-h", argv[i]) == 0 ||
980 strcmp ("--help", argv[i]) == 0)
983 " %s [OPTION...]\n\n"
985 " -h, --help Show help options\n\n"
987 " --g-fatal-warnings Make all warnings fatal\n"
988 " -l List test cases available in a test executable\n"
989 " -m {perf|slow|thorough|quick} Execute tests according to mode\n"
990 " -m {undefined|no-undefined} Execute tests according to mode\n"
991 " -p TESTPATH Only start test cases matching TESTPATH\n"
992 " -s TESTPATH Skip all tests matching TESTPATH\n"
993 " -seed=SEEDSTRING Start tests with random seed SEEDSTRING\n"
994 " --debug-log debug test logging output\n"
995 " -q, --quiet Run tests quietly\n"
996 " --verbose Run tests verbosely\n",
1003 for (i = 1; i < argc; i++)
1006 argv[e++] = argv[i];
1015 * @argc: Address of the @argc parameter of the main() function.
1016 * Changed if any arguments were handled.
1017 * @argv: Address of the @argv parameter of main().
1018 * Any parameters understood by g_test_init() stripped before return.
1019 * @...: %NULL-terminated list of special options. Currently the only
1020 * defined option is <literal>"no_g_set_prgname"</literal>, which
1021 * will cause g_test_init() to not call g_set_prgname().
1023 * Initialize the GLib testing framework, e.g. by seeding the
1024 * test random number generator, the name for g_get_prgname()
1025 * and parsing test related command line args.
1026 * So far, the following arguments are understood:
1029 * <term><option>-l</option></term>
1031 * List test cases available in a test executable.
1032 * </para></listitem>
1035 * <term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
1037 * Provide a random seed to reproduce test runs using random numbers.
1038 * </para></listitem>
1041 * <term><option>--verbose</option></term>
1042 * <listitem><para>Run tests verbosely.</para></listitem>
1045 * <term><option>-q</option>, <option>--quiet</option></term>
1046 * <listitem><para>Run tests quietly.</para></listitem>
1049 * <term><option>-p <replaceable>TESTPATH</replaceable></option></term>
1051 * Execute all tests matching <replaceable>TESTPATH</replaceable>.
1052 * This can also be used to force a test to run that would otherwise
1053 * be skipped (ie, a test whose name contains "/subprocess").
1054 * </para></listitem>
1057 * <term><option>-m {perf|slow|thorough|quick|undefined|no-undefined}</option></term>
1059 * Execute tests according to these test modes:
1064 * Performance tests, may take long and report results.
1065 * </para></listitem>
1068 * <term>slow, thorough</term>
1070 * Slow and thorough tests, may take quite long and
1071 * maximize coverage.
1072 * </para></listitem>
1075 * <term>quick</term>
1077 * Quick tests, should run really quickly and give good coverage.
1078 * </para></listitem>
1081 * <term>undefined</term>
1083 * Tests for undefined behaviour, may provoke programming errors
1084 * under g_test_trap_subprocess() or g_test_expect_messages() to check
1085 * that appropriate assertions or warnings are given
1086 * </para></listitem>
1089 * <term>no-undefined</term>
1091 * Avoid tests for undefined behaviour
1092 * </para></listitem>
1095 * </para></listitem>
1098 * <term><option>--debug-log</option></term>
1099 * <listitem><para>Debug test logging output.</para></listitem>
1106 g_test_init (int *argc,
1110 static char seedstr[4 + 4 * 8 + 1];
1113 /* make warnings and criticals fatal for all test programs */
1114 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
1116 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
1117 g_log_set_always_fatal (fatal_mask);
1118 /* check caller args */
1119 g_return_if_fail (argc != NULL);
1120 g_return_if_fail (argv != NULL);
1121 g_return_if_fail (g_test_config_vars->test_initialized == FALSE);
1122 mutable_test_config_vars.test_initialized = TRUE;
1124 va_start (args, argv);
1125 while ((option = va_arg (args, char *)))
1127 if (g_strcmp0 (option, "no_g_set_prgname") == 0)
1128 no_g_set_prgname = TRUE;
1132 /* setup random seed string */
1133 g_snprintf (seedstr, sizeof (seedstr), "R02S%08x%08x%08x%08x", g_random_int(), g_random_int(), g_random_int(), g_random_int());
1134 test_run_seedstr = seedstr;
1136 /* parse args, sets up mode, changes seed, etc. */
1137 parse_args (argc, argv);
1139 if (!g_get_prgname() && !no_g_set_prgname)
1140 g_set_prgname ((*argv)[0]);
1142 /* verify GRand reliability, needed for reliable seeds */
1145 GRand *rg = g_rand_new_with_seed (0xc8c49fb6);
1146 guint32 t1 = g_rand_int (rg), t2 = g_rand_int (rg), t3 = g_rand_int (rg), t4 = g_rand_int (rg);
1147 /* g_print ("GRand-current: 0x%x 0x%x 0x%x 0x%x\n", t1, t2, t3, t4); */
1148 if (t1 != 0xfab39f9b || t2 != 0xb948fb0e || t3 != 0x3d31be26 || t4 != 0x43a19d66)
1149 g_warning ("random numbers are not GRand-2.2 compatible, seeds may be broken (check $G_RANDOM_VERSION)");
1153 /* check rand seed */
1154 test_run_seed (test_run_seedstr);
1156 /* report program start */
1157 g_log_set_default_handler (gtest_default_log_handler, NULL);
1158 g_test_log (G_TEST_LOG_START_BINARY, g_get_prgname(), test_run_seedstr, 0, NULL);
1160 test_argv0_dirname = g_path_get_dirname (test_argv0);
1162 /* Make sure we get the real dirname that the test was run from */
1163 if (g_str_has_suffix (test_argv0_dirname, "/.libs"))
1166 tmp = g_path_get_dirname (test_argv0_dirname);
1167 g_free (test_argv0_dirname);
1168 test_argv0_dirname = tmp;
1171 test_disted_files_dir = g_getenv ("G_TEST_SRCDIR");
1172 if (!test_disted_files_dir)
1173 test_disted_files_dir = test_argv0_dirname;
1175 test_built_files_dir = g_getenv ("G_TEST_BUILDDIR");
1176 if (!test_built_files_dir)
1177 test_built_files_dir = test_argv0_dirname;
1181 test_run_seed (const gchar *rseed)
1183 guint seed_failed = 0;
1185 g_rand_free (test_run_rand);
1186 test_run_rand = NULL;
1187 while (strchr (" \t\v\r\n\f", *rseed))
1189 if (strncmp (rseed, "R02S", 4) == 0) /* seed for random generator 02 (GRand-2.2) */
1191 const char *s = rseed + 4;
1192 if (strlen (s) >= 32) /* require 4 * 8 chars */
1194 guint32 seedarray[4];
1195 gchar *p, hexbuf[9] = { 0, };
1196 memcpy (hexbuf, s + 0, 8);
1197 seedarray[0] = g_ascii_strtoull (hexbuf, &p, 16);
1198 seed_failed += p != NULL && *p != 0;
1199 memcpy (hexbuf, s + 8, 8);
1200 seedarray[1] = g_ascii_strtoull (hexbuf, &p, 16);
1201 seed_failed += p != NULL && *p != 0;
1202 memcpy (hexbuf, s + 16, 8);
1203 seedarray[2] = g_ascii_strtoull (hexbuf, &p, 16);
1204 seed_failed += p != NULL && *p != 0;
1205 memcpy (hexbuf, s + 24, 8);
1206 seedarray[3] = g_ascii_strtoull (hexbuf, &p, 16);
1207 seed_failed += p != NULL && *p != 0;
1210 test_run_rand = g_rand_new_with_seed_array (seedarray, 4);
1215 g_error ("Unknown or invalid random seed: %s", rseed);
1221 * Get a reproducible random integer number.
1223 * The random numbers generated by the g_test_rand_*() family of functions
1224 * change with every new test program start, unless the --seed option is
1225 * given when starting test programs.
1227 * For individual test cases however, the random number generator is
1228 * reseeded, to avoid dependencies between tests and to make --seed
1229 * effective for all test cases.
1231 * Returns: a random number from the seeded random number generator.
1236 g_test_rand_int (void)
1238 return g_rand_int (test_run_rand);
1242 * g_test_rand_int_range:
1243 * @begin: the minimum value returned by this function
1244 * @end: the smallest value not to be returned by this function
1246 * Get a reproducible random integer number out of a specified range,
1247 * see g_test_rand_int() for details on test case random numbers.
1249 * Returns: a number with @begin <= number < @end.
1254 g_test_rand_int_range (gint32 begin,
1257 return g_rand_int_range (test_run_rand, begin, end);
1261 * g_test_rand_double:
1263 * Get a reproducible random floating point number,
1264 * see g_test_rand_int() for details on test case random numbers.
1266 * Returns: a random number from the seeded random number generator.
1271 g_test_rand_double (void)
1273 return g_rand_double (test_run_rand);
1277 * g_test_rand_double_range:
1278 * @range_start: the minimum value returned by this function
1279 * @range_end: the minimum value not returned by this function
1281 * Get a reproducible random floating pointer number out of a specified range,
1282 * see g_test_rand_int() for details on test case random numbers.
1284 * Returns: a number with @range_start <= number < @range_end.
1289 g_test_rand_double_range (double range_start,
1292 return g_rand_double_range (test_run_rand, range_start, range_end);
1296 * g_test_timer_start:
1298 * Start a timing test. Call g_test_timer_elapsed() when the task is supposed
1299 * to be done. Call this function again to restart the timer.
1304 g_test_timer_start (void)
1306 if (!test_user_timer)
1307 test_user_timer = g_timer_new();
1308 test_user_stamp = 0;
1309 g_timer_start (test_user_timer);
1313 * g_test_timer_elapsed:
1315 * Get the time since the last start of the timer with g_test_timer_start().
1317 * Returns: the time since the last start of the timer, as a double
1322 g_test_timer_elapsed (void)
1324 test_user_stamp = test_user_timer ? g_timer_elapsed (test_user_timer, NULL) : 0;
1325 return test_user_stamp;
1329 * g_test_timer_last:
1331 * Report the last result of g_test_timer_elapsed().
1333 * Returns: the last result of g_test_timer_elapsed(), as a double
1338 g_test_timer_last (void)
1340 return test_user_stamp;
1344 * g_test_minimized_result:
1345 * @minimized_quantity: the reported value
1346 * @format: the format string of the report message
1347 * @...: arguments to pass to the printf() function
1349 * Report the result of a performance or measurement test.
1350 * The test should generally strive to minimize the reported
1351 * quantities (smaller values are better than larger ones),
1352 * this and @minimized_quantity can determine sorting
1353 * order for test result reports.
1358 g_test_minimized_result (double minimized_quantity,
1362 long double largs = minimized_quantity;
1366 va_start (args, format);
1367 buffer = g_strdup_vprintf (format, args);
1370 g_test_log (G_TEST_LOG_MIN_RESULT, buffer, NULL, 1, &largs);
1375 * g_test_maximized_result:
1376 * @maximized_quantity: the reported value
1377 * @format: the format string of the report message
1378 * @...: arguments to pass to the printf() function
1380 * Report the result of a performance or measurement test.
1381 * The test should generally strive to maximize the reported
1382 * quantities (larger values are better than smaller ones),
1383 * this and @maximized_quantity can determine sorting
1384 * order for test result reports.
1389 g_test_maximized_result (double maximized_quantity,
1393 long double largs = maximized_quantity;
1397 va_start (args, format);
1398 buffer = g_strdup_vprintf (format, args);
1401 g_test_log (G_TEST_LOG_MAX_RESULT, buffer, NULL, 1, &largs);
1407 * @format: the format string
1408 * @...: printf-like arguments to @format
1410 * Add a message to the test report.
1415 g_test_message (const char *format,
1421 va_start (args, format);
1422 buffer = g_strdup_vprintf (format, args);
1425 g_test_log (G_TEST_LOG_MESSAGE, buffer, NULL, 0, NULL);
1431 * @uri_pattern: the base pattern for bug URIs
1433 * Specify the base URI for bug reports.
1435 * The base URI is used to construct bug report messages for
1436 * g_test_message() when g_test_bug() is called.
1437 * Calling this function outside of a test case sets the
1438 * default base URI for all test cases. Calling it from within
1439 * a test case changes the base URI for the scope of the test
1441 * Bug URIs are constructed by appending a bug specific URI
1442 * portion to @uri_pattern, or by replacing the special string
1443 * '\%s' within @uri_pattern if that is present.
1448 g_test_bug_base (const char *uri_pattern)
1450 g_free (test_uri_base);
1451 test_uri_base = g_strdup (uri_pattern);
1456 * @bug_uri_snippet: Bug specific bug tracker URI portion.
1458 * This function adds a message to test reports that
1459 * associates a bug URI with a test case.
1460 * Bug URIs are constructed from a base URI set with g_test_bug_base()
1461 * and @bug_uri_snippet.
1466 g_test_bug (const char *bug_uri_snippet)
1470 g_return_if_fail (test_uri_base != NULL);
1471 g_return_if_fail (bug_uri_snippet != NULL);
1473 c = strstr (test_uri_base, "%s");
1476 char *b = g_strndup (test_uri_base, c - test_uri_base);
1477 char *s = g_strconcat (b, bug_uri_snippet, c + 2, NULL);
1479 g_test_message ("Bug Reference: %s", s);
1483 g_test_message ("Bug Reference: %s%s", test_uri_base, bug_uri_snippet);
1489 * Get the toplevel test suite for the test path API.
1491 * Returns: the toplevel #GTestSuite
1496 g_test_get_root (void)
1498 if (!test_suite_root)
1500 test_suite_root = g_test_create_suite ("root");
1501 g_free (test_suite_root->name);
1502 test_suite_root->name = g_strdup ("");
1505 return test_suite_root;
1511 * Runs all tests under the toplevel suite which can be retrieved
1512 * with g_test_get_root(). Similar to g_test_run_suite(), the test
1513 * cases to be run are filtered according to
1514 * test path arguments (-p <replaceable>testpath</replaceable>) as
1515 * parsed by g_test_init().
1516 * g_test_run_suite() or g_test_run() may only be called once
1519 * Returns: 0 on success
1526 return g_test_run_suite (g_test_get_root());
1530 * g_test_create_case:
1531 * @test_name: the name for the test case
1532 * @data_size: the size of the fixture data structure
1533 * @test_data: test data argument for the test functions
1534 * @data_setup: the function to set up the fixture data
1535 * @data_test: the actual test function
1536 * @data_teardown: the function to teardown the fixture data
1538 * Create a new #GTestCase, named @test_name, this API is fairly
1539 * low level, calling g_test_add() or g_test_add_func() is preferable.
1540 * When this test is executed, a fixture structure of size @data_size
1541 * will be allocated and filled with 0s. Then @data_setup is called
1542 * to initialize the fixture. After fixture setup, the actual test
1543 * function @data_test is called. Once the test run completed, the
1544 * fixture structure is torn down by calling @data_teardown and
1545 * after that the memory is released.
1547 * Splitting up a test run into fixture setup, test function and
1548 * fixture teardown is most usful if the same fixture is used for
1549 * multiple tests. In this cases, g_test_create_case() will be
1550 * called with the same fixture, but varying @test_name and
1551 * @data_test arguments.
1553 * Returns: a newly allocated #GTestCase.
1558 g_test_create_case (const char *test_name,
1560 gconstpointer test_data,
1561 GTestFixtureFunc data_setup,
1562 GTestFixtureFunc data_test,
1563 GTestFixtureFunc data_teardown)
1567 g_return_val_if_fail (test_name != NULL, NULL);
1568 g_return_val_if_fail (strchr (test_name, '/') == NULL, NULL);
1569 g_return_val_if_fail (test_name[0] != 0, NULL);
1570 g_return_val_if_fail (data_test != NULL, NULL);
1572 tc = g_slice_new0 (GTestCase);
1573 tc->name = g_strdup (test_name);
1574 tc->test_data = (gpointer) test_data;
1575 tc->fixture_size = data_size;
1576 tc->fixture_setup = (void*) data_setup;
1577 tc->fixture_test = (void*) data_test;
1578 tc->fixture_teardown = (void*) data_teardown;
1584 find_suite (gconstpointer l, gconstpointer s)
1586 const GTestSuite *suite = l;
1587 const gchar *str = s;
1589 return strcmp (suite->name, str);
1594 * @fixture: the test fixture
1595 * @user_data: the data provided when registering the test
1597 * The type used for functions that operate on test fixtures. This is
1598 * used for the fixture setup and teardown functions as well as for the
1599 * testcases themselves.
1601 * @user_data is a pointer to the data that was given when registering
1604 * @fixture will be a pointer to the area of memory allocated by the
1605 * test framework, of the size requested. If the requested size was
1606 * zero then @fixture will be equal to @user_data.
1611 g_test_add_vtable (const char *testpath,
1613 gconstpointer test_data,
1614 GTestFixtureFunc data_setup,
1615 GTestFixtureFunc fixture_test_func,
1616 GTestFixtureFunc data_teardown)
1622 g_return_if_fail (testpath != NULL);
1623 g_return_if_fail (g_path_is_absolute (testpath));
1624 g_return_if_fail (fixture_test_func != NULL);
1626 if (g_slist_find_custom (test_paths_skipped, testpath, (GCompareFunc)g_strcmp0))
1629 suite = g_test_get_root();
1630 segments = g_strsplit (testpath, "/", -1);
1631 for (ui = 0; segments[ui] != NULL; ui++)
1633 const char *seg = segments[ui];
1634 gboolean islast = segments[ui + 1] == NULL;
1635 if (islast && !seg[0])
1636 g_error ("invalid test case path: %s", testpath);
1638 continue; /* initial or duplicate slash */
1643 l = g_slist_find_custom (suite->suites, seg, find_suite);
1650 csuite = g_test_create_suite (seg);
1651 g_test_suite_add_suite (suite, csuite);
1657 GTestCase *tc = g_test_create_case (seg, data_size, test_data, data_setup, fixture_test_func, data_teardown);
1658 g_test_suite_add (suite, tc);
1661 g_strfreev (segments);
1667 * Indicates that a test failed. This function can be called
1668 * multiple times from the same test. You can use this function
1669 * if your test failed in a recoverable way.
1671 * Do not use this function if the failure of a test could cause
1672 * other tests to malfunction.
1674 * Calling this function will not stop the test from running, you
1675 * need to return from the test function yourself. So you can
1676 * produce additional diagnostic messages or even continue running
1679 * If not called from inside a test, this function does nothing.
1686 test_run_success = G_TEST_RUN_FAILURE;
1690 * g_test_incomplete:
1691 * @msg: (allow-none): explanation
1693 * Indicates that a test failed because of some incomplete
1694 * functionality. This function can be called multiple times
1695 * from the same test.
1697 * Calling this function will not stop the test from running, you
1698 * need to return from the test function yourself. So you can
1699 * produce additional diagnostic messages or even continue running
1702 * If not called from inside a test, this function does nothing.
1707 g_test_incomplete (const gchar *msg)
1709 test_run_success = G_TEST_RUN_INCOMPLETE;
1710 g_free (test_run_msg);
1711 test_run_msg = g_strdup (msg);
1716 * @msg: (allow-none): explanation
1718 * Indicates that a test was skipped.
1720 * Calling this function will not stop the test from running, you
1721 * need to return from the test function yourself. So you can
1722 * produce additional diagnostic messages or even continue running
1725 * If not called from inside a test, this function does nothing.
1730 g_test_skip (const gchar *msg)
1732 test_run_success = G_TEST_RUN_SKIPPED;
1733 g_free (test_run_msg);
1734 test_run_msg = g_strdup (msg);
1740 * Returns whether a test has already failed. This will
1741 * be the case when g_test_fail(), g_test_incomplete()
1742 * or g_test_skip() have been called, but also if an
1743 * assertion has failed.
1745 * This can be useful to return early from a test if
1746 * continuing after a failed assertion might be harmful.
1748 * The return value of this function is only meaningful
1749 * if it is called from inside a test function.
1751 * Returns: %TRUE if the test has failed
1756 g_test_failed (void)
1758 return test_run_success != G_TEST_RUN_SUCCESS;
1762 * g_test_set_nonfatal_assertions:
1764 * Changes the behaviour of g_assert_cmpstr(), g_assert_cmpint(),
1765 * g_assert_cmpuint(), g_assert_cmphex(), g_assert_cmpfloat(),
1766 * g_assert_true(), g_assert_false(), g_assert_null(), g_assert_no_error(),
1767 * g_assert_error(), g_test_assert_expected_messages() and the various
1768 * g_test_trap_assert_*() macros to not abort to program, but instead
1769 * call g_test_fail() and continue. (This also changes the behavior of
1770 * g_test_fail() so that it will not cause the test program to abort
1771 * after completing the failed test.)
1773 * Note that the g_assert_not_reached() and g_assert() are not
1776 * This function can only be called after g_test_init().
1781 g_test_set_nonfatal_assertions (void)
1783 if (!g_test_config_vars->test_initialized)
1784 g_error ("g_test_set_nonfatal_assertions called without g_test_init");
1785 test_nonfatal_assertions = TRUE;
1786 test_mode_fatal = FALSE;
1792 * The type used for test case functions.
1799 * @testpath: /-separated test case path name for the test.
1800 * @test_func: The test function to invoke for this test.
1802 * Create a new test case, similar to g_test_create_case(). However
1803 * the test is assumed to use no fixture, and test suites are automatically
1804 * created on the fly and added to the root fixture, based on the
1805 * slash-separated portions of @testpath.
1807 * If @testpath includes the component "subprocess" anywhere in it,
1808 * the test will be skipped by default, and only run if explicitly
1809 * required via the <option>-p</option> command-line option or
1810 * g_test_trap_subprocess().
1815 g_test_add_func (const char *testpath,
1816 GTestFunc test_func)
1818 g_return_if_fail (testpath != NULL);
1819 g_return_if_fail (testpath[0] == '/');
1820 g_return_if_fail (test_func != NULL);
1821 g_test_add_vtable (testpath, 0, NULL, NULL, (GTestFixtureFunc) test_func, NULL);
1826 * @user_data: the data provided when registering the test
1828 * The type used for test case functions that take an extra pointer
1835 * g_test_add_data_func:
1836 * @testpath: /-separated test case path name for the test.
1837 * @test_data: Test data argument for the test function.
1838 * @test_func: The test function to invoke for this test.
1840 * Create a new test case, similar to g_test_create_case(). However
1841 * the test is assumed to use no fixture, and test suites are automatically
1842 * created on the fly and added to the root fixture, based on the
1843 * slash-separated portions of @testpath. The @test_data argument
1844 * will be passed as first argument to @test_func.
1846 * If @testpath includes the component "subprocess" anywhere in it,
1847 * the test will be skipped by default, and only run if explicitly
1848 * required via the <option>-p</option> command-line option or
1849 * g_test_trap_subprocess().
1854 g_test_add_data_func (const char *testpath,
1855 gconstpointer test_data,
1856 GTestDataFunc test_func)
1858 g_return_if_fail (testpath != NULL);
1859 g_return_if_fail (testpath[0] == '/');
1860 g_return_if_fail (test_func != NULL);
1862 g_test_add_vtable (testpath, 0, test_data, NULL, (GTestFixtureFunc) test_func, NULL);
1866 * g_test_add_data_func_full:
1867 * @testpath: /-separated test case path name for the test.
1868 * @test_data: Test data argument for the test function.
1869 * @test_func: The test function to invoke for this test.
1870 * @data_free_func: #GDestroyNotify for @test_data.
1872 * Create a new test case, as with g_test_add_data_func(), but freeing
1873 * @test_data after the test run is complete.
1878 g_test_add_data_func_full (const char *testpath,
1880 GTestDataFunc test_func,
1881 GDestroyNotify data_free_func)
1883 g_return_if_fail (testpath != NULL);
1884 g_return_if_fail (testpath[0] == '/');
1885 g_return_if_fail (test_func != NULL);
1887 g_test_add_vtable (testpath, 0, test_data, NULL,
1888 (GTestFixtureFunc) test_func,
1889 (GTestFixtureFunc) data_free_func);
1893 g_test_suite_case_exists (GTestSuite *suite,
1894 const char *test_path)
1901 slash = strchr (test_path, '/');
1905 for (iter = suite->suites; iter; iter = iter->next)
1907 GTestSuite *child_suite = iter->data;
1909 if (!strncmp (child_suite->name, test_path, slash - test_path))
1910 if (g_test_suite_case_exists (child_suite, slash))
1916 for (iter = suite->cases; iter; iter = iter->next)
1919 if (!strcmp (tc->name, test_path))
1928 * g_test_create_suite:
1929 * @suite_name: a name for the suite
1931 * Create a new test suite with the name @suite_name.
1933 * Returns: A newly allocated #GTestSuite instance.
1938 g_test_create_suite (const char *suite_name)
1941 g_return_val_if_fail (suite_name != NULL, NULL);
1942 g_return_val_if_fail (strchr (suite_name, '/') == NULL, NULL);
1943 g_return_val_if_fail (suite_name[0] != 0, NULL);
1944 ts = g_slice_new0 (GTestSuite);
1945 ts->name = g_strdup (suite_name);
1951 * @suite: a #GTestSuite
1952 * @test_case: a #GTestCase
1954 * Adds @test_case to @suite.
1959 g_test_suite_add (GTestSuite *suite,
1960 GTestCase *test_case)
1962 g_return_if_fail (suite != NULL);
1963 g_return_if_fail (test_case != NULL);
1965 suite->cases = g_slist_prepend (suite->cases, test_case);
1969 * g_test_suite_add_suite:
1970 * @suite: a #GTestSuite
1971 * @nestedsuite: another #GTestSuite
1973 * Adds @nestedsuite to @suite.
1978 g_test_suite_add_suite (GTestSuite *suite,
1979 GTestSuite *nestedsuite)
1981 g_return_if_fail (suite != NULL);
1982 g_return_if_fail (nestedsuite != NULL);
1984 suite->suites = g_slist_prepend (suite->suites, nestedsuite);
1988 * g_test_queue_free:
1989 * @gfree_pointer: the pointer to be stored.
1991 * Enqueue a pointer to be released with g_free() during the next
1992 * teardown phase. This is equivalent to calling g_test_queue_destroy()
1993 * with a destroy callback of g_free().
1998 g_test_queue_free (gpointer gfree_pointer)
2001 g_test_queue_destroy (g_free, gfree_pointer);
2005 * g_test_queue_destroy:
2006 * @destroy_func: Destroy callback for teardown phase.
2007 * @destroy_data: Destroy callback data.
2009 * This function enqueus a callback @destroy_func to be executed
2010 * during the next test case teardown phase. This is most useful
2011 * to auto destruct allocted test resources at the end of a test run.
2012 * Resources are released in reverse queue order, that means enqueueing
2013 * callback A before callback B will cause B() to be called before
2014 * A() during teardown.
2019 g_test_queue_destroy (GDestroyNotify destroy_func,
2020 gpointer destroy_data)
2022 DestroyEntry *dentry;
2024 g_return_if_fail (destroy_func != NULL);
2026 dentry = g_slice_new0 (DestroyEntry);
2027 dentry->destroy_func = destroy_func;
2028 dentry->destroy_data = destroy_data;
2029 dentry->next = test_destroy_queue;
2030 test_destroy_queue = dentry;
2034 test_case_run (GTestCase *tc)
2036 gchar *old_name = test_run_name, *old_base = g_strdup (test_uri_base);
2037 GSList **old_free_list, *filename_free_list = NULL;
2038 gboolean success = G_TEST_RUN_SUCCESS;
2040 old_free_list = test_filename_free_list;
2041 test_filename_free_list = &filename_free_list;
2043 test_run_name = g_strconcat (old_name, "/", tc->name, NULL);
2044 if (strstr (test_run_name, "/subprocess"))
2047 gboolean found = FALSE;
2049 for (iter = test_paths; iter; iter = iter->next)
2051 if (!strcmp (test_run_name, iter->data))
2060 if (g_test_verbose ())
2061 g_print ("GTest: skipping: %s\n", test_run_name);
2066 if (++test_run_count <= test_skip_count)
2067 g_test_log (G_TEST_LOG_SKIP_CASE, test_run_name, NULL, 0, NULL);
2068 else if (test_run_list)
2070 g_print ("%s\n", test_run_name);
2071 g_test_log (G_TEST_LOG_LIST_CASE, test_run_name, NULL, 0, NULL);
2075 GTimer *test_run_timer = g_timer_new();
2076 long double largs[3];
2078 g_test_log (G_TEST_LOG_START_CASE, test_run_name, NULL, 0, NULL);
2080 test_run_success = G_TEST_RUN_SUCCESS;
2081 g_clear_pointer (&test_run_msg, g_free);
2082 g_test_log_set_fatal_handler (NULL, NULL);
2083 g_timer_start (test_run_timer);
2084 fixture = tc->fixture_size ? g_malloc0 (tc->fixture_size) : tc->test_data;
2085 test_run_seed (test_run_seedstr);
2086 if (tc->fixture_setup)
2087 tc->fixture_setup (fixture, tc->test_data);
2088 tc->fixture_test (fixture, tc->test_data);
2090 while (test_destroy_queue)
2092 DestroyEntry *dentry = test_destroy_queue;
2093 test_destroy_queue = dentry->next;
2094 dentry->destroy_func (dentry->destroy_data);
2095 g_slice_free (DestroyEntry, dentry);
2097 if (tc->fixture_teardown)
2098 tc->fixture_teardown (fixture, tc->test_data);
2099 if (tc->fixture_size)
2101 g_timer_stop (test_run_timer);
2102 success = test_run_success;
2103 test_run_success = G_TEST_RUN_FAILURE;
2104 largs[0] = success; /* OK */
2105 largs[1] = test_run_forks;
2106 largs[2] = g_timer_elapsed (test_run_timer, NULL);
2107 g_test_log (G_TEST_LOG_STOP_CASE, test_run_name, test_run_msg, G_N_ELEMENTS (largs), largs);
2108 g_clear_pointer (&test_run_msg, g_free);
2109 g_timer_destroy (test_run_timer);
2113 g_slist_free_full (filename_free_list, g_free);
2114 test_filename_free_list = old_free_list;
2115 g_free (test_run_name);
2116 test_run_name = old_name;
2117 g_free (test_uri_base);
2118 test_uri_base = old_base;
2120 return success == G_TEST_RUN_SUCCESS;
2124 g_test_run_suite_internal (GTestSuite *suite,
2128 gchar *rest, *old_name = test_run_name;
2129 GSList *slist, *reversed;
2131 g_return_val_if_fail (suite != NULL, -1);
2133 g_test_log (G_TEST_LOG_START_SUITE, suite->name, NULL, 0, NULL);
2135 while (path[0] == '/')
2138 rest = strchr (path, '/');
2139 l = rest ? MIN (l, rest - path) : l;
2140 test_run_name = suite->name[0] == 0 ? g_strdup (test_run_name) : g_strconcat (old_name, "/", suite->name, NULL);
2141 reversed = g_slist_reverse (g_slist_copy (suite->cases));
2142 for (slist = reversed; slist; slist = slist->next)
2144 GTestCase *tc = slist->data;
2145 guint n = l ? strlen (tc->name) : 0;
2146 if (l == n && !rest && strncmp (path, tc->name, n) == 0)
2148 if (!test_case_run (tc))
2152 g_slist_free (reversed);
2153 reversed = g_slist_reverse (g_slist_copy (suite->suites));
2154 for (slist = reversed; slist; slist = slist->next)
2156 GTestSuite *ts = slist->data;
2157 guint n = l ? strlen (ts->name) : 0;
2158 if (l == n && strncmp (path, ts->name, n) == 0)
2159 n_bad += g_test_run_suite_internal (ts, rest ? rest : "");
2161 g_slist_free (reversed);
2162 g_free (test_run_name);
2163 test_run_name = old_name;
2165 g_test_log (G_TEST_LOG_STOP_SUITE, suite->name, NULL, 0, NULL);
2172 * @suite: a #GTestSuite
2174 * Execute the tests within @suite and all nested #GTestSuites.
2175 * The test suites to be executed are filtered according to
2176 * test path arguments (-p <replaceable>testpath</replaceable>)
2177 * as parsed by g_test_init().
2178 * g_test_run_suite() or g_test_run() may only be called once
2181 * Returns: 0 on success
2186 g_test_run_suite (GTestSuite *suite)
2188 GSList *my_test_paths;
2191 g_return_val_if_fail (g_test_config_vars->test_initialized, -1);
2192 g_return_val_if_fail (g_test_run_once == TRUE, -1);
2194 g_test_run_once = FALSE;
2197 my_test_paths = g_slist_copy (test_paths);
2199 my_test_paths = g_slist_prepend (NULL, "");
2201 while (my_test_paths)
2203 const char *rest, *path = my_test_paths->data;
2204 guint l, n = strlen (suite->name);
2205 my_test_paths = g_slist_delete_link (my_test_paths, my_test_paths);
2206 while (path[0] == '/')
2208 if (!n) /* root suite, run unconditionally */
2210 n_bad += g_test_run_suite_internal (suite, path);
2213 /* regular suite, match path */
2214 rest = strchr (path, '/');
2216 l = rest ? MIN (l, rest - path) : l;
2217 if ((!l || l == n) && strncmp (path, suite->name, n) == 0)
2218 n_bad += g_test_run_suite_internal (suite, rest ? rest : "");
2225 gtest_default_log_handler (const gchar *log_domain,
2226 GLogLevelFlags log_level,
2227 const gchar *message,
2228 gpointer unused_data)
2230 const gchar *strv[16];
2231 gboolean fatal = FALSE;
2237 strv[i++] = log_domain;
2240 if (log_level & G_LOG_FLAG_FATAL)
2242 strv[i++] = "FATAL-";
2245 if (log_level & G_LOG_FLAG_RECURSION)
2246 strv[i++] = "RECURSIVE-";
2247 if (log_level & G_LOG_LEVEL_ERROR)
2248 strv[i++] = "ERROR";
2249 if (log_level & G_LOG_LEVEL_CRITICAL)
2250 strv[i++] = "CRITICAL";
2251 if (log_level & G_LOG_LEVEL_WARNING)
2252 strv[i++] = "WARNING";
2253 if (log_level & G_LOG_LEVEL_MESSAGE)
2254 strv[i++] = "MESSAGE";
2255 if (log_level & G_LOG_LEVEL_INFO)
2257 if (log_level & G_LOG_LEVEL_DEBUG)
2258 strv[i++] = "DEBUG";
2260 strv[i++] = message;
2263 msg = g_strjoinv ("", (gchar**) strv);
2264 g_test_log (fatal ? G_TEST_LOG_ERROR : G_TEST_LOG_MESSAGE, msg, NULL, 0, NULL);
2265 g_log_default_handler (log_domain, log_level, message, unused_data);
2271 g_assertion_message (const char *domain,
2275 const char *message)
2281 message = "code should not be reached";
2282 g_snprintf (lstr, 32, "%d", line);
2283 s = g_strconcat (domain ? domain : "", domain && domain[0] ? ":" : "",
2284 "ERROR:", file, ":", lstr, ":",
2285 func, func[0] ? ":" : "",
2286 " ", message, NULL);
2287 g_printerr ("**\n%s\n", s);
2289 g_test_log (G_TEST_LOG_ERROR, s, NULL, 0, NULL);
2291 if (test_nonfatal_assertions)
2298 /* store assertion message in global variable, so that it can be found in a
2300 if (__glib_assert_msg != NULL)
2301 /* free the old one */
2302 free (__glib_assert_msg);
2303 __glib_assert_msg = (char*) malloc (strlen (s) + 1);
2304 strcpy (__glib_assert_msg, s);
2308 if (test_in_subprocess)
2310 /* If this is a test case subprocess then it probably hit this
2311 * assertion on purpose, so just exit() rather than abort()ing,
2312 * to avoid triggering any system crash-reporting daemon.
2321 g_assertion_message_expr (const char *domain,
2329 s = g_strdup ("code should not be reached");
2331 s = g_strconcat ("assertion failed: (", expr, ")", NULL);
2332 g_assertion_message (domain, file, line, func, s);
2335 /* Normally g_assertion_message() won't return, but we need this for
2336 * when test_nonfatal_assertions is set, since
2337 * g_assertion_message_expr() is used for always-fatal assertions.
2339 if (test_in_subprocess)
2346 g_assertion_message_cmpnum (const char *domain,
2360 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;
2361 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;
2362 case 'f': s = g_strdup_printf ("assertion failed (%s): (%.9g %s %.9g)", expr, (double) arg1, cmp, (double) arg2); break;
2363 /* ideally use: floats=%.7g double=%.17g */
2365 g_assertion_message (domain, file, line, func, s);
2370 g_assertion_message_cmpstr (const char *domain,
2379 char *a1, *a2, *s, *t1 = NULL, *t2 = NULL;
2380 a1 = arg1 ? g_strconcat ("\"", t1 = g_strescape (arg1, NULL), "\"", NULL) : g_strdup ("NULL");
2381 a2 = arg2 ? g_strconcat ("\"", t2 = g_strescape (arg2, NULL), "\"", NULL) : g_strdup ("NULL");
2384 s = g_strdup_printf ("assertion failed (%s): (%s %s %s)", expr, a1, cmp, a2);
2387 g_assertion_message (domain, file, line, func, s);
2392 g_assertion_message_error (const char *domain,
2397 const GError *error,
2398 GQuark error_domain,
2403 /* This is used by both g_assert_error() and g_assert_no_error(), so there
2404 * are three cases: expected an error but got the wrong error, expected
2405 * an error but got no error, and expected no error but got an error.
2408 gstring = g_string_new ("assertion failed ");
2410 g_string_append_printf (gstring, "(%s == (%s, %d)): ", expr,
2411 g_quark_to_string (error_domain), error_code);
2413 g_string_append_printf (gstring, "(%s == NULL): ", expr);
2416 g_string_append_printf (gstring, "%s (%s, %d)", error->message,
2417 g_quark_to_string (error->domain), error->code);
2419 g_string_append_printf (gstring, "%s is NULL", expr);
2421 g_assertion_message (domain, file, line, func, gstring->str);
2422 g_string_free (gstring, TRUE);
2427 * @str1: (allow-none): a C string or %NULL
2428 * @str2: (allow-none): another C string or %NULL
2430 * Compares @str1 and @str2 like strcmp(). Handles %NULL
2431 * gracefully by sorting it before non-%NULL strings.
2432 * Comparing two %NULL pointers returns 0.
2434 * Returns: an integer less than, equal to, or greater than zero, if @str1 is <, == or > than @str2.
2439 g_strcmp0 (const char *str1,
2443 return -(str1 != str2);
2445 return str1 != str2;
2446 return strcmp (str1, str2);
2450 test_trap_clear (void)
2452 test_trap_last_status = 0;
2453 test_trap_last_pid = 0;
2454 g_clear_pointer (&test_trap_last_subprocess, g_free);
2455 g_clear_pointer (&test_trap_last_stdout, g_free);
2456 g_clear_pointer (&test_trap_last_stderr, g_free);
2467 ret = dup2 (fd1, fd2);
2468 while (ret < 0 && errno == EINTR);
2479 GIOChannel *stdout_io;
2480 gboolean echo_stdout;
2481 GString *stdout_str;
2483 GIOChannel *stderr_io;
2484 gboolean echo_stderr;
2485 GString *stderr_str;
2489 check_complete (WaitForChildData *data)
2491 if (data->child_status != -1 && data->stdout_io == NULL && data->stderr_io == NULL)
2492 g_main_loop_quit (data->loop);
2496 child_exited (GPid pid,
2500 WaitForChildData *data = user_data;
2503 if (WIFEXITED (status)) /* normal exit */
2504 data->child_status = WEXITSTATUS (status); /* 0..255 */
2505 else if (WIFSIGNALED (status) && WTERMSIG (status) == SIGALRM)
2506 data->child_status = G_TEST_STATUS_TIMED_OUT;
2507 else if (WIFSIGNALED (status))
2508 data->child_status = (WTERMSIG (status) << 12); /* signalled */
2509 else /* WCOREDUMP (status) */
2510 data->child_status = 512; /* coredump */
2512 data->child_status = status;
2515 check_complete (data);
2519 child_timeout (gpointer user_data)
2521 WaitForChildData *data = user_data;
2524 TerminateProcess (data->pid, G_TEST_STATUS_TIMED_OUT);
2526 kill (data->pid, SIGALRM);
2533 child_read (GIOChannel *io, GIOCondition cond, gpointer user_data)
2535 WaitForChildData *data = user_data;
2537 gsize nread, nwrote, total;
2539 FILE *echo_file = NULL;
2541 status = g_io_channel_read_chars (io, buf, sizeof (buf), &nread, NULL);
2542 if (status == G_IO_STATUS_ERROR || status == G_IO_STATUS_EOF)
2544 // FIXME data->error = (status == G_IO_STATUS_ERROR);
2545 if (io == data->stdout_io)
2546 g_clear_pointer (&data->stdout_io, g_io_channel_unref);
2548 g_clear_pointer (&data->stderr_io, g_io_channel_unref);
2550 check_complete (data);
2553 else if (status == G_IO_STATUS_AGAIN)
2556 if (io == data->stdout_io)
2558 g_string_append_len (data->stdout_str, buf, nread);
2559 if (data->echo_stdout)
2564 g_string_append_len (data->stderr_str, buf, nread);
2565 if (data->echo_stderr)
2571 for (total = 0; total < nread; total += nwrote)
2573 nwrote = fwrite (buf + total, 1, nread - total, echo_file);
2575 g_error ("write failed: %s", g_strerror (errno));
2583 wait_for_child (GPid pid,
2584 int stdout_fd, gboolean echo_stdout,
2585 int stderr_fd, gboolean echo_stderr,
2588 WaitForChildData data;
2589 GMainContext *context;
2593 data.child_status = -1;
2595 context = g_main_context_new ();
2596 data.loop = g_main_loop_new (context, FALSE);
2598 source = g_child_watch_source_new (pid);
2599 g_source_set_callback (source, (GSourceFunc) child_exited, &data, NULL);
2600 g_source_attach (source, context);
2601 g_source_unref (source);
2603 data.echo_stdout = echo_stdout;
2604 data.stdout_str = g_string_new (NULL);
2605 data.stdout_io = g_io_channel_unix_new (stdout_fd);
2606 g_io_channel_set_close_on_unref (data.stdout_io, TRUE);
2607 g_io_channel_set_encoding (data.stdout_io, NULL, NULL);
2608 g_io_channel_set_buffered (data.stdout_io, FALSE);
2609 source = g_io_create_watch (data.stdout_io, G_IO_IN | G_IO_ERR | G_IO_HUP);
2610 g_source_set_callback (source, (GSourceFunc) child_read, &data, NULL);
2611 g_source_attach (source, context);
2612 g_source_unref (source);
2614 data.echo_stderr = echo_stderr;
2615 data.stderr_str = g_string_new (NULL);
2616 data.stderr_io = g_io_channel_unix_new (stderr_fd);
2617 g_io_channel_set_close_on_unref (data.stderr_io, TRUE);
2618 g_io_channel_set_encoding (data.stderr_io, NULL, NULL);
2619 g_io_channel_set_buffered (data.stderr_io, FALSE);
2620 source = g_io_create_watch (data.stderr_io, G_IO_IN | G_IO_ERR | G_IO_HUP);
2621 g_source_set_callback (source, (GSourceFunc) child_read, &data, NULL);
2622 g_source_attach (source, context);
2623 g_source_unref (source);
2627 source = g_timeout_source_new (0);
2628 g_source_set_ready_time (source, g_get_monotonic_time () + timeout);
2629 g_source_set_callback (source, (GSourceFunc) child_timeout, &data, NULL);
2630 g_source_attach (source, context);
2631 g_source_unref (source);
2634 g_main_loop_run (data.loop);
2635 g_main_loop_unref (data.loop);
2636 g_main_context_unref (context);
2638 test_trap_last_pid = pid;
2639 test_trap_last_status = data.child_status;
2640 test_trap_last_stdout = g_string_free (data.stdout_str, FALSE);
2641 test_trap_last_stderr = g_string_free (data.stderr_str, FALSE);
2643 g_clear_pointer (&data.stdout_io, g_io_channel_unref);
2644 g_clear_pointer (&data.stderr_io, g_io_channel_unref);
2649 * @usec_timeout: Timeout for the forked test in micro seconds.
2650 * @test_trap_flags: Flags to modify forking behaviour.
2652 * Fork the current test program to execute a test case that might
2653 * not return or that might abort.
2655 * If @usec_timeout is non-0, the forked test case is aborted and
2656 * considered failing if its run time exceeds it.
2658 * The forking behavior can be configured with the #GTestTrapFlags flags.
2660 * In the following example, the test code forks, the forked child
2661 * process produces some sample output and exits successfully.
2662 * The forking parent process then asserts successful child program
2663 * termination and validates child program outputs.
2667 * test_fork_patterns (void)
2669 * if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
2671 * g_print ("some stdout text: somagic17\n");
2672 * g_printerr ("some stderr text: semagic43\n");
2673 * exit (0); /* successful test run */
2675 * g_test_trap_assert_passed ();
2676 * g_test_trap_assert_stdout ("*somagic17*");
2677 * g_test_trap_assert_stderr ("*semagic43*");
2681 * Returns: %TRUE for the forked child and %FALSE for the executing parent process.
2685 * Deprecated: This function is implemented only on Unix platforms,
2686 * and is not always reliable due to problems inherent in
2687 * fork-without-exec. Use g_test_trap_subprocess() instead.
2690 g_test_trap_fork (guint64 usec_timeout,
2691 GTestTrapFlags test_trap_flags)
2694 int stdout_pipe[2] = { -1, -1 };
2695 int stderr_pipe[2] = { -1, -1 };
2698 if (pipe (stdout_pipe) < 0 || pipe (stderr_pipe) < 0)
2699 g_error ("failed to create pipes to fork test program: %s", g_strerror (errno));
2700 test_trap_last_pid = fork ();
2701 if (test_trap_last_pid < 0)
2702 g_error ("failed to fork test program: %s", g_strerror (errno));
2703 if (test_trap_last_pid == 0) /* child */
2706 close (stdout_pipe[0]);
2707 close (stderr_pipe[0]);
2708 if (!(test_trap_flags & G_TEST_TRAP_INHERIT_STDIN))
2709 fd0 = g_open ("/dev/null", O_RDONLY, 0);
2710 if (sane_dup2 (stdout_pipe[1], 1) < 0 || sane_dup2 (stderr_pipe[1], 2) < 0 || (fd0 >= 0 && sane_dup2 (fd0, 0) < 0))
2711 g_error ("failed to dup2() in forked test program: %s", g_strerror (errno));
2714 if (stdout_pipe[1] >= 3)
2715 close (stdout_pipe[1]);
2716 if (stderr_pipe[1] >= 3)
2717 close (stderr_pipe[1]);
2723 close (stdout_pipe[1]);
2724 close (stderr_pipe[1]);
2726 wait_for_child (test_trap_last_pid,
2727 stdout_pipe[0], !(test_trap_flags & G_TEST_TRAP_SILENCE_STDOUT),
2728 stderr_pipe[0], !(test_trap_flags & G_TEST_TRAP_SILENCE_STDERR),
2733 g_message ("Not implemented: g_test_trap_fork");
2740 * g_test_trap_subprocess:
2741 * @test_path: Test to run in a subprocess
2742 * @usec_timeout: Timeout for the subprocess test in micro seconds.
2743 * @test_flags: Flags to modify subprocess behaviour.
2745 * Respawns the test program to run only @test_path in a subprocess.
2746 * This can be used for a test case that might not return, or that
2747 * might abort. @test_path will normally be the name of the parent
2748 * test, followed by "<literal>/subprocess/</literal>" and then a name
2749 * for the specific subtest (or just ending with
2750 * "<literal>/subprocess</literal>" if the test only has one child
2751 * test); tests with names of this form will automatically be skipped
2752 * in the parent process.
2754 * If @usec_timeout is non-0, the test subprocess is aborted and
2755 * considered failing if its run time exceeds it.
2757 * The subprocess behavior can be configured with the
2758 * #GTestSubprocessFlags flags.
2760 * You can use methods such as g_test_trap_assert_passed(),
2761 * g_test_trap_assert_failed(), and g_test_trap_assert_stderr() to
2762 * check the results of the subprocess. (But note that
2763 * g_test_trap_assert_stdout() and g_test_trap_assert_stderr()
2764 * cannot be used if @test_flags specifies that the child should
2765 * inherit the parent stdout/stderr.)
2767 * If your <literal>main ()</literal> needs to behave differently in
2768 * the subprocess, you can call g_test_subprocess() (after calling
2769 * g_test_init()) to see whether you are in a subprocess.
2771 * The following example tests that calling
2772 * <literal>my_object_new(1000000)</literal> will abort with an error
2777 * test_create_large_object_subprocess (void)
2779 * my_object_new (1000000);
2783 * test_create_large_object (void)
2785 * g_test_trap_subprocess ("/myobject/create_large_object/subprocess", 0, 0);
2786 * g_test_trap_assert_failed ();
2787 * g_test_trap_assert_stderr ("*ERROR*too large*");
2791 * main (int argc, char **argv)
2793 * g_test_init (&argc, &argv, NULL);
2795 * g_test_add_func ("/myobject/create_large_object",
2796 * test_create_large_object);
2797 * /* Because of the '/subprocess' in the name, this test will
2798 * * not be run by the g_test_run () call below.
2800 * g_test_add_func ("/myobject/create_large_object/subprocess",
2801 * test_create_large_object_subprocess);
2803 * return g_test_run ();
2810 g_test_trap_subprocess (const char *test_path,
2811 guint64 usec_timeout,
2812 GTestSubprocessFlags test_flags)
2814 GError *error = NULL;
2817 int stdout_fd, stderr_fd;
2820 /* Sanity check that they used GTestSubprocessFlags, not GTestTrapFlags */
2821 g_assert ((test_flags & (G_TEST_TRAP_INHERIT_STDIN | G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR)) == 0);
2823 if (!g_test_suite_case_exists (g_test_get_root (), test_path))
2824 g_error ("g_test_trap_subprocess: test does not exist: %s", test_path);
2826 if (g_test_verbose ())
2827 g_print ("GTest: subprocess: %s\n", test_path);
2830 test_trap_last_subprocess = g_strdup (test_path);
2832 argv = g_ptr_array_new ();
2833 g_ptr_array_add (argv, test_argv0);
2834 g_ptr_array_add (argv, "-q");
2835 g_ptr_array_add (argv, "-p");
2836 g_ptr_array_add (argv, (char *)test_path);
2837 g_ptr_array_add (argv, "--GTestSubprocess");
2838 if (test_log_fd != -1)
2840 char log_fd_buf[128];
2842 g_ptr_array_add (argv, "--GTestLogFD");
2843 g_snprintf (log_fd_buf, sizeof (log_fd_buf), "%d", test_log_fd);
2844 g_ptr_array_add (argv, log_fd_buf);
2846 g_ptr_array_add (argv, NULL);
2848 flags = G_SPAWN_DO_NOT_REAP_CHILD;
2849 if (test_flags & G_TEST_TRAP_INHERIT_STDIN)
2850 flags |= G_SPAWN_CHILD_INHERITS_STDIN;
2852 if (!g_spawn_async_with_pipes (test_initial_cwd,
2853 (char **)argv->pdata,
2856 &pid, NULL, &stdout_fd, &stderr_fd,
2859 g_error ("g_test_trap_subprocess() failed: %s\n",
2862 g_ptr_array_free (argv, TRUE);
2864 wait_for_child (pid,
2865 stdout_fd, !!(test_flags & G_TEST_SUBPROCESS_INHERIT_STDOUT),
2866 stderr_fd, !!(test_flags & G_TEST_SUBPROCESS_INHERIT_STDERR),
2871 * g_test_subprocess:
2873 * Returns %TRUE (after g_test_init() has been called) if the test
2874 * program is running under g_test_trap_subprocess().
2876 * Returns: %TRUE if the test program is running under
2877 * g_test_trap_subprocess().
2882 g_test_subprocess (void)
2884 return test_in_subprocess;
2888 * g_test_trap_has_passed:
2890 * Check the result of the last g_test_trap_subprocess() call.
2892 * Returns: %TRUE if the last test subprocess terminated successfully.
2897 g_test_trap_has_passed (void)
2899 return test_trap_last_status == 0; /* exit_status == 0 && !signal && !coredump */
2903 * g_test_trap_reached_timeout:
2905 * Check the result of the last g_test_trap_subprocess() call.
2907 * Returns: %TRUE if the last test subprocess got killed due to a timeout.
2912 g_test_trap_reached_timeout (void)
2914 return test_trap_last_status != G_TEST_STATUS_TIMED_OUT;
2918 g_test_trap_assertions (const char *domain,
2922 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
2923 const char *pattern)
2925 gboolean must_pass = assertion_flags == 0;
2926 gboolean must_fail = assertion_flags == 1;
2927 gboolean match_result = 0 == (assertion_flags & 1);
2928 const char *stdout_pattern = (assertion_flags & 2) ? pattern : NULL;
2929 const char *stderr_pattern = (assertion_flags & 4) ? pattern : NULL;
2930 const char *match_error = match_result ? "failed to match" : "contains invalid match";
2934 if (test_trap_last_subprocess != NULL)
2936 process_id = g_strdup_printf ("%s [%d]", test_trap_last_subprocess,
2937 test_trap_last_pid);
2939 else if (test_trap_last_pid != 0)
2940 process_id = g_strdup_printf ("%d", test_trap_last_pid);
2942 if (test_trap_last_subprocess != NULL)
2943 process_id = g_strdup (test_trap_last_subprocess);
2946 g_error ("g_test_trap_ assertion with no trapped test");
2948 if (must_pass && !g_test_trap_has_passed())
2950 char *msg = g_strdup_printf ("child process (%s) failed unexpectedly", process_id);
2951 g_assertion_message (domain, file, line, func, msg);
2954 if (must_fail && g_test_trap_has_passed())
2956 char *msg = g_strdup_printf ("child process (%s) did not fail as expected", process_id);
2957 g_assertion_message (domain, file, line, func, msg);
2960 if (stdout_pattern && match_result == !g_pattern_match_simple (stdout_pattern, test_trap_last_stdout))
2962 char *msg = g_strdup_printf ("stdout of child process (%s) %s: %s", process_id, match_error, stdout_pattern);
2963 g_assertion_message (domain, file, line, func, msg);
2966 if (stderr_pattern && match_result == !g_pattern_match_simple (stderr_pattern, test_trap_last_stderr))
2968 char *msg = g_strdup_printf ("stderr of child process (%s) %s: %s", process_id, match_error, stderr_pattern);
2969 g_assertion_message (domain, file, line, func, msg);
2972 g_free (process_id);
2976 gstring_overwrite_int (GString *gstring,
2980 vuint = g_htonl (vuint);
2981 g_string_overwrite_len (gstring, pos, (const gchar*) &vuint, 4);
2985 gstring_append_int (GString *gstring,
2988 vuint = g_htonl (vuint);
2989 g_string_append_len (gstring, (const gchar*) &vuint, 4);
2993 gstring_append_double (GString *gstring,
2996 union { double vdouble; guint64 vuint64; } u;
2997 u.vdouble = vdouble;
2998 u.vuint64 = GUINT64_TO_BE (u.vuint64);
2999 g_string_append_len (gstring, (const gchar*) &u.vuint64, 8);
3003 g_test_log_dump (GTestLogMsg *msg,
3006 GString *gstring = g_string_sized_new (1024);
3008 gstring_append_int (gstring, 0); /* message length */
3009 gstring_append_int (gstring, msg->log_type);
3010 gstring_append_int (gstring, msg->n_strings);
3011 gstring_append_int (gstring, msg->n_nums);
3012 gstring_append_int (gstring, 0); /* reserved */
3013 for (ui = 0; ui < msg->n_strings; ui++)
3015 guint l = strlen (msg->strings[ui]);
3016 gstring_append_int (gstring, l);
3017 g_string_append_len (gstring, msg->strings[ui], l);
3019 for (ui = 0; ui < msg->n_nums; ui++)
3020 gstring_append_double (gstring, msg->nums[ui]);
3021 *len = gstring->len;
3022 gstring_overwrite_int (gstring, 0, *len); /* message length */
3023 return (guint8*) g_string_free (gstring, FALSE);
3026 static inline long double
3027 net_double (const gchar **ipointer)
3029 union { guint64 vuint64; double vdouble; } u;
3030 guint64 aligned_int64;
3031 memcpy (&aligned_int64, *ipointer, 8);
3033 u.vuint64 = GUINT64_FROM_BE (aligned_int64);
3037 static inline guint32
3038 net_int (const gchar **ipointer)
3040 guint32 aligned_int;
3041 memcpy (&aligned_int, *ipointer, 4);
3043 return g_ntohl (aligned_int);
3047 g_test_log_extract (GTestLogBuffer *tbuffer)
3049 const gchar *p = tbuffer->data->str;
3052 if (tbuffer->data->len < 4 * 5)
3054 mlength = net_int (&p);
3055 if (tbuffer->data->len < mlength)
3057 msg.log_type = net_int (&p);
3058 msg.n_strings = net_int (&p);
3059 msg.n_nums = net_int (&p);
3060 if (net_int (&p) == 0)
3063 msg.strings = g_new0 (gchar*, msg.n_strings + 1);
3064 msg.nums = g_new0 (long double, msg.n_nums);
3065 for (ui = 0; ui < msg.n_strings; ui++)
3067 guint sl = net_int (&p);
3068 msg.strings[ui] = g_strndup (p, sl);
3071 for (ui = 0; ui < msg.n_nums; ui++)
3072 msg.nums[ui] = net_double (&p);
3073 if (p <= tbuffer->data->str + mlength)
3075 g_string_erase (tbuffer->data, 0, mlength);
3076 tbuffer->msgs = g_slist_prepend (tbuffer->msgs, g_memdup (&msg, sizeof (msg)));
3081 g_strfreev (msg.strings);
3082 g_error ("corrupt log stream from test program");
3087 * g_test_log_buffer_new:
3089 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
3092 g_test_log_buffer_new (void)
3094 GTestLogBuffer *tb = g_new0 (GTestLogBuffer, 1);
3095 tb->data = g_string_sized_new (1024);
3100 * g_test_log_buffer_free:
3102 * Internal function for gtester to free test log messages, no ABI guarantees provided.
3105 g_test_log_buffer_free (GTestLogBuffer *tbuffer)
3107 g_return_if_fail (tbuffer != NULL);
3108 while (tbuffer->msgs)
3109 g_test_log_msg_free (g_test_log_buffer_pop (tbuffer));
3110 g_string_free (tbuffer->data, TRUE);
3115 * g_test_log_buffer_push:
3117 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
3120 g_test_log_buffer_push (GTestLogBuffer *tbuffer,
3122 const guint8 *bytes)
3124 g_return_if_fail (tbuffer != NULL);
3127 gboolean more_messages;
3128 g_return_if_fail (bytes != NULL);
3129 g_string_append_len (tbuffer->data, (const gchar*) bytes, n_bytes);
3131 more_messages = g_test_log_extract (tbuffer);
3132 while (more_messages);
3137 * g_test_log_buffer_pop:
3139 * Internal function for gtester to retrieve test log messages, no ABI guarantees provided.
3142 g_test_log_buffer_pop (GTestLogBuffer *tbuffer)
3144 GTestLogMsg *msg = NULL;
3145 g_return_val_if_fail (tbuffer != NULL, NULL);
3148 GSList *slist = g_slist_last (tbuffer->msgs);
3150 tbuffer->msgs = g_slist_delete_link (tbuffer->msgs, slist);
3156 * g_test_log_msg_free:
3158 * Internal function for gtester to free test log messages, no ABI guarantees provided.
3161 g_test_log_msg_free (GTestLogMsg *tmsg)
3163 g_return_if_fail (tmsg != NULL);
3164 g_strfreev (tmsg->strings);
3165 g_free (tmsg->nums);
3170 g_test_build_filename_va (GTestFileType file_type,
3171 const gchar *first_path,
3174 const gchar *pathv[16];
3175 gint num_path_segments;
3177 if (file_type == G_TEST_DIST)
3178 pathv[0] = test_disted_files_dir;
3179 else if (file_type == G_TEST_BUILT)
3180 pathv[0] = test_built_files_dir;
3182 g_assert_not_reached ();
3184 pathv[1] = first_path;
3186 for (num_path_segments = 2; num_path_segments < G_N_ELEMENTS (pathv); num_path_segments++)
3188 pathv[num_path_segments] = va_arg (ap, const char *);
3189 if (pathv[num_path_segments] == NULL)
3193 g_assert_cmpint (num_path_segments, <, G_N_ELEMENTS (pathv));
3195 return g_build_filenamev ((gchar **) pathv);
3199 * g_test_build_filename:
3200 * @file_type: the type of file (built vs. distributed)
3201 * @first_path: the first segment of the pathname
3202 * @...: %NULL-terminated additional path segments
3204 * Creates the pathname to a data file that is required for a test.
3206 * This function is conceptually similar to g_build_filename() except
3207 * that the first argument has been replaced with a #GTestFileType
3210 * The data file should either have been distributed with the module
3211 * containing the test (%G_TEST_DIST) or built as part of the build
3212 * system of that module (%G_TEST_BUILT).
3214 * In order for this function to work in srcdir != builddir situations,
3215 * the G_TEST_SRCDIR and G_TEST_BUILDDIR environment variables need to
3216 * have been defined. As of 2.38, this is done by the Makefile.decl
3217 * included in GLib. Please ensure that your copy is up to date before
3218 * using this function.
3220 * In case neither variable is set, this function will fall back to
3221 * using the dirname portion of argv[0], possibly removing ".libs".
3222 * This allows for casual running of tests directly from the commandline
3223 * in the srcdir == builddir case and should also support running of
3224 * installed tests, assuming the data files have been installed in the
3225 * same relative path as the test binary.
3227 * Returns: the path of the file, to be freed using g_free()
3233 * @G_TEST_DIST: a file that was included in the distribution tarball
3234 * @G_TEST_BUILT: a file that was built on the compiling machine
3236 * The type of file to return the filename for, when used with
3237 * g_test_build_filename().
3239 * These two options correspond rather directly to the 'dist' and
3240 * 'built' terminology that automake uses and are explicitly used to
3241 * distinguish between the 'srcdir' and 'builddir' being separate. All
3242 * files in your project should either be dist (in the
3243 * <literal>DIST_EXTRA</literal> or <literal>dist_schema_DATA</literal>
3244 * sense, in which case they will always be in the srcdir) or built (in
3245 * the <literal>BUILT_SOURCES</literal> sense, in which case they will
3246 * always be in the builddir).
3248 * Note: as a general rule of automake, files that are generated only as
3249 * part of the build-from-git process (but then are distributed with the
3250 * tarball) always go in srcdir (even if doing a srcdir != builddir
3251 * build from git) and are considered as distributed files.
3256 g_test_build_filename (GTestFileType file_type,
3257 const gchar *first_path,
3263 g_assert (g_test_initialized ());
3265 va_start (ap, first_path);
3266 result = g_test_build_filename_va (file_type, first_path, ap);
3274 * @file_type: the type of file (built vs. distributed)
3276 * Gets the pathname of the directory containing test files of the type
3277 * specified by @file_type.
3279 * This is approximately the same as calling g_test_build_filename("."),
3280 * but you don't need to free the return value.
3282 * Returns: the path of the directory, owned by GLib
3287 g_test_get_dir (GTestFileType file_type)
3289 g_assert (g_test_initialized ());
3291 if (file_type == G_TEST_DIST)
3292 return test_disted_files_dir;
3293 else if (file_type == G_TEST_BUILT)
3294 return test_built_files_dir;
3296 g_assert_not_reached ();
3300 * g_test_get_filename:
3301 * @file_type: the type of file (built vs. distributed)
3302 * @first_path: the first segment of the pathname
3303 * @...: %NULL-terminated additional path segments
3305 * Gets the pathname to a data file that is required for a test.
3307 * This is the same as g_test_build_filename() with two differences.
3308 * The first difference is that must only use this function from within
3309 * a testcase function. The second difference is that you need not free
3310 * the return value -- it will be automatically freed when the testcase
3313 * It is safe to use this function from a thread inside of a testcase
3314 * but you must ensure that all such uses occur before the main testcase
3315 * function returns (ie: it is best to ensure that all threads have been
3318 * Returns: the path, automatically freed at the end of the testcase
3323 g_test_get_filename (GTestFileType file_type,
3324 const gchar *first_path,
3331 g_assert (g_test_initialized ());
3332 if (test_filename_free_list == NULL)
3333 g_error ("g_test_get_filename() can only be used within testcase functions");
3335 va_start (ap, first_path);
3336 result = g_test_build_filename_va (file_type, first_path, ap);
3339 node = g_slist_prepend (NULL, result);
3341 node->next = *test_filename_free_list;
3342 while (!g_atomic_pointer_compare_and_exchange (test_filename_free_list, node->next, node));
3347 /* --- macros docs START --- */
3350 * @testpath: The test path for a new test case.
3351 * @Fixture: The type of a fixture data structure.
3352 * @tdata: Data argument for the test functions.
3353 * @fsetup: The function to set up the fixture data.
3354 * @ftest: The actual test function.
3355 * @fteardown: The function to tear down the fixture data.
3357 * Hook up a new test case at @testpath, similar to g_test_add_func().
3358 * A fixture data structure with setup and teardown function may be provided
3359 * though, similar to g_test_create_case().
3360 * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
3361 * fteardown() callbacks can expect a @Fixture pointer as first argument in
3362 * a type safe manner.
3366 /* --- macros docs END --- */