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 "gmessages-private.h"
25 #include "gfileutils.h"
27 #include <sys/types.h>
32 #include <glib/gstdio.h>
40 #ifdef HAVE_SYS_RESOURCE_H
41 #include <sys/resource.h>
49 #ifdef HAVE_SYS_SELECT_H
50 #include <sys/select.h>
51 #endif /* HAVE_SYS_SELECT_H */
56 #include "gstrfuncs.h"
60 #include "glib-private.h"
61 #include "gmessages-private.h"
67 * @short_description: a test framework
68 * @see_also: <link linkend="gtester">gtester</link>,
69 * <link linkend="gtester-report">gtester-report</link>
71 * GLib provides a framework for writing and maintaining unit tests
72 * in parallel to the code they are testing. The API is designed according
73 * to established concepts found in the other test frameworks (JUnit, NUnit,
74 * RUnit), which in turn is based on smalltalk unit testing concepts.
78 * <term>Test case</term>
79 * <listitem>Tests (test methods) are grouped together with their
80 * fixture into test cases.</listitem>
83 * <term>Fixture</term>
84 * <listitem>A test fixture consists of fixture data and setup and
85 * teardown methods to establish the environment for the test
86 * functions. We use fresh fixtures, i.e. fixtures are newly set
87 * up and torn down around each test invocation to avoid dependencies
88 * between tests.</listitem>
91 * <term>Test suite</term>
92 * <listitem>Test cases can be grouped into test suites, to allow
93 * subsets of the available tests to be run. Test suites can be
94 * grouped into other test suites as well.</listitem>
97 * The API is designed to handle creation and registration of test suites
98 * and test cases implicitly. A simple call like
100 * g_test_add_func ("/misc/assertions", test_assertions);
102 * creates a test suite called "misc" with a single test case named
103 * "assertions", which consists of running the test_assertions function.
105 * In addition to the traditional g_assert(), the test framework provides
106 * an extended set of assertions for string and numerical comparisons:
107 * g_assert_cmpfloat(), g_assert_cmpint(), g_assert_cmpuint(),
108 * g_assert_cmphex(), g_assert_cmpstr(). The advantage of these variants
109 * over plain g_assert() is that the assertion messages can be more
110 * elaborate, and include the values of the compared entities.
112 * GLib ships with two utilities called gtester and gtester-report to
113 * facilitate running tests and producing nicely formatted test reports.
117 * g_test_initialized:
119 * Returns %TRUE if g_test_init() has been called.
121 * Returns: %TRUE if g_test_init() has been called.
129 * Returns %TRUE if tests are run in quick mode.
130 * Exactly one of g_test_quick() and g_test_slow() is active in any run;
131 * there is no "medium speed".
133 * Returns: %TRUE if in quick mode
139 * Returns %TRUE if tests are run in slow mode.
140 * Exactly one of g_test_quick() and g_test_slow() is active in any run;
141 * there is no "medium speed".
143 * Returns: the opposite of g_test_quick()
149 * Returns %TRUE if tests are run in thorough mode, equivalent to
152 * Returns: the same thing as g_test_slow()
158 * Returns %TRUE if tests are run in performance mode.
160 * Returns: %TRUE if in performance mode
166 * Returns %TRUE if tests may provoke assertions and other formally-undefined
167 * behaviour, to verify that appropriate warnings are given. It might, in some
168 * cases, be useful to turn this off if running tests under valgrind.
170 * Returns: %TRUE if tests may provoke programming errors
176 * Returns %TRUE if tests are run in verbose mode.
177 * The default is neither g_test_verbose() nor g_test_quiet().
179 * Returns: %TRUE if in verbose mode
185 * Returns %TRUE if tests are run in quiet mode.
186 * The default is neither g_test_verbose() nor g_test_quiet().
188 * Returns: %TRUE if in quiet mode
192 * g_test_queue_unref:
193 * @gobject: the object to unref
195 * Enqueue an object to be released with g_object_unref() during
196 * the next teardown phase. This is equivalent to calling
197 * g_test_queue_destroy() with a destroy callback of g_object_unref().
204 * @G_TEST_TRAP_SILENCE_STDOUT: Redirect stdout 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_stdout().
208 * @G_TEST_TRAP_SILENCE_STDERR: Redirect stderr of the test child to
209 * <filename>/dev/null</filename> so it cannot be observed on the
210 * console during test runs. The actual output is still captured
211 * though to allow later tests with g_test_trap_assert_stderr().
212 * @G_TEST_TRAP_INHERIT_STDIN: If this flag is given, stdin of the
213 * child process is shared with stdin of its parent process.
214 * It is redirected to <filename>/dev/null</filename> otherwise.
216 * Test traps are guards around forked tests.
217 * These flags determine what traps to set.
219 * Deprecated: #GTestTrapFlags is used only with g_test_trap_fork(),
220 * which is deprecated. g_test_trap_subprocess() uses
221 * #GTestTrapSubprocessFlags.
225 * GTestSubprocessFlags:
226 * @G_TEST_SUBPROCESS_INHERIT_STDIN: If this flag is given, the child
227 * process will inherit the parent's stdin. Otherwise, the child's
228 * stdin is redirected to <filename>/dev/null</filename>.
229 * @G_TEST_SUBPROCESS_INHERIT_STDOUT: If this flag is given, the child
230 * process will inherit the parent's stdout. Otherwise, the child's
231 * stdout will not be visible, but it will be captured to allow
232 * later tests with g_test_trap_assert_stdout().
233 * @G_TEST_SUBPROCESS_INHERIT_STDERR: If this flag is given, the child
234 * process will inherit the parent's stderr. Otherwise, the child's
235 * stderr will not be visible, but it will be captured to allow
236 * later tests with g_test_trap_assert_stderr().
238 * Flags to pass to g_test_trap_subprocess() to control input and output.
240 * Note that in contrast with g_test_trap_fork(), the default is to
241 * not show stdout and stderr.
245 * g_test_trap_assert_passed:
247 * Assert that the last test subprocess passed.
248 * See g_test_trap_subprocess().
254 * g_test_trap_assert_failed:
256 * Assert that the last test subprocess failed.
257 * See g_test_trap_subprocess().
259 * This is sometimes used to test situations that are formally considered to
260 * be undefined behaviour, like inputs that fail a g_return_if_fail()
261 * check. In these situations you should skip the entire test, including the
262 * call to g_test_trap_subprocess(), unless g_test_undefined() returns %TRUE
263 * to indicate that undefined behaviour may be tested.
269 * g_test_trap_assert_stdout:
270 * @soutpattern: a glob-style
271 * <link linkend="glib-Glob-style-pattern-matching">pattern</link>
273 * Assert that the stdout output of the last test subprocess matches
274 * @soutpattern. See g_test_trap_subprocess().
280 * g_test_trap_assert_stdout_unmatched:
281 * @soutpattern: a glob-style
282 * <link linkend="glib-Glob-style-pattern-matching">pattern</link>
284 * Assert that the stdout output of the last test subprocess
285 * does not match @soutpattern. See g_test_trap_subprocess().
291 * g_test_trap_assert_stderr:
292 * @serrpattern: a glob-style
293 * <link linkend="glib-Glob-style-pattern-matching">pattern</link>
295 * Assert that the stderr output of the last test subprocess
296 * matches @serrpattern. See g_test_trap_subprocess().
298 * This is sometimes used to test situations that are formally
299 * considered to be undefined behaviour, like code that hits a
300 * g_assert() or g_error(). In these situations you should skip the
301 * entire test, including the call to g_test_trap_subprocess(), unless
302 * g_test_undefined() returns %TRUE to indicate that undefined
303 * behaviour may be tested.
309 * g_test_trap_assert_stderr_unmatched:
310 * @serrpattern: a glob-style
311 * <link linkend="glib-Glob-style-pattern-matching">pattern</link>
313 * Assert that the stderr output of the last test subprocess
314 * does not match @serrpattern. See g_test_trap_subprocess().
322 * Get a reproducible random bit (0 or 1), see g_test_rand_int()
323 * for details on test case random numbers.
330 * @expr: the expression to check
332 * Debugging macro to terminate the application if the assertion
333 * fails. If the assertion fails (i.e. the expression is not true),
334 * an error message is logged and the application is terminated.
336 * The macro can be turned off in final releases of code by defining
337 * <envar>G_DISABLE_ASSERT</envar> when compiling the application.
341 * g_assert_not_reached:
343 * Debugging macro to terminate the application if it is ever
344 * reached. If it is reached, an error message is logged and the
345 * application is terminated.
347 * The macro can be turned off in final releases of code by defining
348 * <envar>G_DISABLE_ASSERT</envar> when compiling the application.
353 * @expr: the expression to check
355 * Debugging macro to check that an expression is true.
362 * @expr: the expression to check
364 * Debugging macro to check an expression is false.
371 * @expr: the expression to check
373 * Debugging macro to check an expression is %NULL.
380 * @s1: a string (may be %NULL)
381 * @cmp: The comparison operator to use.
382 * One of ==, !=, <, >, <=, >=.
383 * @s2: another string (may be %NULL)
385 * Debugging macro to terminate the application with a warning
386 * message if a string comparison fails. The strings are compared
389 * The effect of <literal>g_assert_cmpstr (s1, op, s2)</literal> is
390 * the same as <literal>g_assert (g_strcmp0 (s1, s2) op 0)</literal>.
391 * The advantage of this macro is that it can produce a message that
392 * includes the actual values of @s1 and @s2.
395 * g_assert_cmpstr (mystring, ==, "fubar");
404 * @cmp: The comparison operator to use.
405 * One of ==, !=, <, >, <=, >=.
406 * @n2: another integer
408 * Debugging macro to terminate the application with a warning
409 * message if an integer comparison fails.
411 * The effect of <literal>g_assert_cmpint (n1, op, n2)</literal> is
412 * the same as <literal>g_assert (n1 op n2)</literal>. The advantage
413 * of this macro is that it can produce a message that includes the
414 * actual values of @n1 and @n2.
421 * @n1: an unsigned integer
422 * @cmp: The comparison operator to use.
423 * One of ==, !=, <, >, <=, >=.
424 * @n2: another unsigned integer
426 * Debugging macro to terminate the application with a warning
427 * message if an unsigned integer comparison fails.
429 * The effect of <literal>g_assert_cmpuint (n1, op, n2)</literal> is
430 * the same as <literal>g_assert (n1 op n2)</literal>. The advantage
431 * of this macro is that it can produce a message that includes the
432 * actual values of @n1 and @n2.
439 * @n1: an unsigned integer
440 * @cmp: The comparison operator to use.
441 * One of ==, !=, <, >, <=, >=.
442 * @n2: another unsigned integer
444 * Debugging macro to terminate the application with a warning
445 * message if an unsigned integer comparison fails.
447 * This is a variant of g_assert_cmpuint() that displays the numbers
448 * in hexadecimal notation in the message.
455 * @n1: an floating point number
456 * @cmp: The comparison operator to use.
457 * One of ==, !=, <, >, <=, >=.
458 * @n2: another floating point number
460 * Debugging macro to terminate the application with a warning
461 * message if a floating point number comparison fails.
463 * The effect of <literal>g_assert_cmpfloat (n1, op, n2)</literal> is
464 * the same as <literal>g_assert (n1 op n2)</literal>. The advantage
465 * of this macro is that it can produce a message that includes the
466 * actual values of @n1 and @n2.
473 * @err: a #GError, possibly %NULL
475 * Debugging macro to terminate the application with a warning
476 * message if a method has returned a #GError.
478 * The effect of <literal>g_assert_no_error (err)</literal> is
479 * the same as <literal>g_assert (err == NULL)</literal>. The advantage
480 * of this macro is that it can produce a message that includes
481 * the error message and code.
488 * @err: a #GError, possibly %NULL
489 * @dom: the expected error domain (a #GQuark)
490 * @c: the expected error code
492 * Debugging macro to terminate the application with a warning
493 * message if a method has not returned the correct #GError.
495 * The effect of <literal>g_assert_error (err, dom, c)</literal> is
496 * the same as <literal>g_assert (err != NULL && err->domain
497 * == dom && err->code == c)</literal>. The advantage of this
498 * macro is that it can produce a message that includes the incorrect
499 * error message and code.
501 * This can only be used to test for a specific error. If you want to
502 * test that @err is set, but don't care what it's set to, just use
503 * <literal>g_assert (err != NULL)</literal>
511 * An opaque structure representing a test case.
517 * An opaque structure representing a test suite.
521 /* Global variable for storing assertion messages; this is the counterpart to
522 * glibc's (private) __abort_msg variable, and allows developers and crash
523 * analysis systems like Apport and ABRT to fish out assertion messages from
524 * core dumps, instead of having to catch them on screen output.
526 GLIB_VAR char *__glib_assert_msg;
527 char *__glib_assert_msg = NULL;
529 /* --- constants --- */
530 #define G_TEST_STATUS_TIMED_OUT 1024
532 /* --- structures --- */
537 void (*fixture_setup) (void*, gconstpointer);
538 void (*fixture_test) (void*, gconstpointer);
539 void (*fixture_teardown) (void*, gconstpointer);
548 typedef struct DestroyEntry DestroyEntry;
552 GDestroyNotify destroy_func;
553 gpointer destroy_data;
556 /* --- prototypes --- */
557 static void test_run_seed (const gchar *rseed);
558 static void test_trap_clear (void);
559 static guint8* g_test_log_dump (GTestLogMsg *msg,
561 static void gtest_default_log_handler (const gchar *log_domain,
562 GLogLevelFlags log_level,
563 const gchar *message,
564 gpointer unused_data);
571 G_TEST_RUN_INCOMPLETE
574 /* --- variables --- */
575 static int test_log_fd = -1;
576 static gboolean test_mode_fatal = TRUE;
577 static gboolean g_test_run_once = TRUE;
578 static gboolean test_run_list = FALSE;
579 static gchar *test_run_seedstr = NULL;
580 static GRand *test_run_rand = NULL;
581 static gchar *test_run_name = "";
582 static GSList **test_filename_free_list;
583 static guint test_run_forks = 0;
584 static guint test_run_count = 0;
585 static GTestResult test_run_success = G_TEST_RUN_FAILURE;
586 static gchar *test_run_msg = NULL;
587 static guint test_skip_count = 0;
588 static GTimer *test_user_timer = NULL;
589 static double test_user_stamp = 0;
590 static GSList *test_paths = NULL;
591 static GSList *test_paths_skipped = NULL;
592 static GTestSuite *test_suite_root = NULL;
593 static int test_trap_last_status = 0;
594 static GPid test_trap_last_pid = 0;
595 static char *test_trap_last_subprocess = NULL;
596 static char *test_trap_last_stdout = NULL;
597 static char *test_trap_last_stderr = NULL;
598 static char *test_uri_base = NULL;
599 static gboolean test_debug_log = FALSE;
600 static gboolean test_tap_log = FALSE;
601 static DestroyEntry *test_destroy_queue = NULL;
602 static char *test_argv0 = NULL;
603 static char *test_argv0_dirname;
604 static const char *test_disted_files_dir;
605 static const char *test_built_files_dir;
606 static char *test_initial_cwd = NULL;
607 static gboolean test_in_subprocess = FALSE;
608 static GTestConfig mutable_test_config_vars = {
609 FALSE, /* test_initialized */
610 TRUE, /* test_quick */
611 FALSE, /* test_perf */
612 FALSE, /* test_verbose */
613 FALSE, /* test_quiet */
614 TRUE, /* test_undefined */
616 const GTestConfig * const g_test_config_vars = &mutable_test_config_vars;
618 /* --- functions --- */
620 g_test_log_type_name (GTestLogType log_type)
624 case G_TEST_LOG_NONE: return "none";
625 case G_TEST_LOG_ERROR: return "error";
626 case G_TEST_LOG_START_BINARY: return "binary";
627 case G_TEST_LOG_LIST_CASE: return "list";
628 case G_TEST_LOG_SKIP_CASE: return "skip";
629 case G_TEST_LOG_START_CASE: return "start";
630 case G_TEST_LOG_STOP_CASE: return "stop";
631 case G_TEST_LOG_MIN_RESULT: return "minperf";
632 case G_TEST_LOG_MAX_RESULT: return "maxperf";
633 case G_TEST_LOG_MESSAGE: return "message";
634 case G_TEST_LOG_START_SUITE: return "start suite";
635 case G_TEST_LOG_STOP_SUITE: return "stop suite";
641 g_test_log_send (guint n_bytes,
642 const guint8 *buffer)
644 if (test_log_fd >= 0)
648 r = write (test_log_fd, buffer, n_bytes);
649 while (r < 0 && errno == EINTR);
653 GTestLogBuffer *lbuffer = g_test_log_buffer_new ();
656 g_test_log_buffer_push (lbuffer, n_bytes, buffer);
657 msg = g_test_log_buffer_pop (lbuffer);
658 g_warn_if_fail (msg != NULL);
659 g_warn_if_fail (lbuffer->data->len == 0);
660 g_test_log_buffer_free (lbuffer);
662 g_printerr ("{*LOG(%s)", g_test_log_type_name (msg->log_type));
663 for (ui = 0; ui < msg->n_strings; ui++)
664 g_printerr (":{%s}", msg->strings[ui]);
668 for (ui = 0; ui < msg->n_nums; ui++)
670 if ((long double) (long) msg->nums[ui] == msg->nums[ui])
671 g_printerr ("%s%ld", ui ? ";" : "", (long) msg->nums[ui]);
673 g_printerr ("%s%.16g", ui ? ";" : "", (double) msg->nums[ui]);
677 g_printerr (":LOG*}\n");
678 g_test_log_msg_free (msg);
683 g_test_log (GTestLogType lbit,
684 const gchar *string1,
685 const gchar *string2,
691 gchar *astrings[3] = { NULL, NULL, NULL };
697 case G_TEST_LOG_START_BINARY:
699 g_print ("# random seed: %s\n", string2);
700 else if (g_test_verbose())
701 g_print ("GTest: random seed: %s\n", string2);
703 case G_TEST_LOG_START_SUITE:
707 g_print ("# Start of %s tests\n", string1);
710 case G_TEST_LOG_STOP_SUITE:
714 g_print ("# End of %s tests\n", string1);
716 g_print ("1..%d\n", test_run_count);
719 case G_TEST_LOG_STOP_CASE:
720 fail = largs[0] != G_TEST_RUN_SUCCESS && largs[0] != G_TEST_RUN_SKIPPED;
723 g_print ("%s %d %s", fail ? "not ok" : "ok", test_run_count, string1);
724 if (largs[0] == G_TEST_RUN_INCOMPLETE)
725 g_print (" # TODO %s\n", string2 ? string2 : "");
726 else if (largs[0] == G_TEST_RUN_SKIPPED)
727 g_print (" # SKIP %s\n", string2 ? string2 : "");
731 else if (g_test_verbose())
732 g_print ("GTest: result: %s\n", fail ? "FAIL" : "OK");
733 else if (!g_test_quiet())
734 g_print ("%s\n", fail ? "FAIL" : "OK");
735 if (fail && test_mode_fatal)
738 g_print ("Bail out!\n");
742 case G_TEST_LOG_MIN_RESULT:
744 g_print ("# min perf: %s\n", string1);
745 else if (g_test_verbose())
746 g_print ("(MINPERF:%s)\n", string1);
748 case G_TEST_LOG_MAX_RESULT:
750 g_print ("# max perf: %s\n", string1);
751 else if (g_test_verbose())
752 g_print ("(MAXPERF:%s)\n", string1);
754 case G_TEST_LOG_MESSAGE:
755 case G_TEST_LOG_ERROR:
757 g_print ("# %s\n", string1);
758 else if (g_test_verbose())
759 g_print ("(MSG: %s)\n", string1);
765 msg.n_strings = (string1 != NULL) + (string1 && string2);
766 msg.strings = astrings;
767 astrings[0] = (gchar*) string1;
768 astrings[1] = astrings[0] ? (gchar*) string2 : NULL;
771 dbuffer = g_test_log_dump (&msg, &dbufferlen);
772 g_test_log_send (dbufferlen, dbuffer);
777 case G_TEST_LOG_START_CASE:
780 else if (g_test_verbose())
781 g_print ("GTest: run: %s\n", string1);
782 else if (!g_test_quiet())
783 g_print ("%s: ", string1);
789 /* We intentionally parse the command line without GOptionContext
790 * because otherwise you would never be able to test it.
793 parse_args (gint *argc_p,
796 guint argc = *argc_p;
797 gchar **argv = *argv_p;
800 test_argv0 = argv[0];
801 test_initial_cwd = g_get_current_dir ();
803 /* parse known args */
804 for (i = 1; i < argc; i++)
806 if (strcmp (argv[i], "--g-fatal-warnings") == 0)
808 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
809 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
810 g_log_set_always_fatal (fatal_mask);
813 else if (strcmp (argv[i], "--keep-going") == 0 ||
814 strcmp (argv[i], "-k") == 0)
816 test_mode_fatal = FALSE;
819 else if (strcmp (argv[i], "--debug-log") == 0)
821 test_debug_log = TRUE;
824 else if (strcmp (argv[i], "--tap") == 0)
829 else if (strcmp ("--GTestLogFD", argv[i]) == 0 || strncmp ("--GTestLogFD=", argv[i], 13) == 0)
831 gchar *equal = argv[i] + 12;
833 test_log_fd = g_ascii_strtoull (equal + 1, NULL, 0);
834 else if (i + 1 < argc)
837 test_log_fd = g_ascii_strtoull (argv[i], NULL, 0);
841 else if (strcmp ("--GTestSkipCount", argv[i]) == 0 || strncmp ("--GTestSkipCount=", argv[i], 17) == 0)
843 gchar *equal = argv[i] + 16;
845 test_skip_count = g_ascii_strtoull (equal + 1, NULL, 0);
846 else if (i + 1 < argc)
849 test_skip_count = g_ascii_strtoull (argv[i], NULL, 0);
853 else if (strcmp ("--GTestSubprocess", argv[i]) == 0)
855 test_in_subprocess = TRUE;
856 /* We typically expect these child processes to crash, and some
857 * tests spawn a *lot* of them. Avoid spamming system crash
858 * collection programs such as systemd-coredump and abrt.
860 #ifdef HAVE_SYS_RESOURCE_H
862 struct rlimit limit = { 0, 0 };
863 (void) setrlimit (RLIMIT_CORE, &limit);
866 _g_log_set_exit_on_fatal ();
869 else if (strcmp ("-p", argv[i]) == 0 || strncmp ("-p=", argv[i], 3) == 0)
871 gchar *equal = argv[i] + 2;
873 test_paths = g_slist_prepend (test_paths, equal + 1);
874 else if (i + 1 < argc)
877 test_paths = g_slist_prepend (test_paths, argv[i]);
881 else if (strcmp ("-s", argv[i]) == 0 || strncmp ("-s=", argv[i], 3) == 0)
883 gchar *equal = argv[i] + 2;
885 test_paths_skipped = g_slist_prepend (test_paths_skipped, equal + 1);
886 else if (i + 1 < argc)
889 test_paths_skipped = g_slist_prepend (test_paths_skipped, argv[i]);
893 else if (strcmp ("-m", argv[i]) == 0 || strncmp ("-m=", argv[i], 3) == 0)
895 gchar *equal = argv[i] + 2;
896 const gchar *mode = "";
899 else if (i + 1 < argc)
904 if (strcmp (mode, "perf") == 0)
905 mutable_test_config_vars.test_perf = TRUE;
906 else if (strcmp (mode, "slow") == 0)
907 mutable_test_config_vars.test_quick = FALSE;
908 else if (strcmp (mode, "thorough") == 0)
909 mutable_test_config_vars.test_quick = FALSE;
910 else if (strcmp (mode, "quick") == 0)
912 mutable_test_config_vars.test_quick = TRUE;
913 mutable_test_config_vars.test_perf = FALSE;
915 else if (strcmp (mode, "undefined") == 0)
916 mutable_test_config_vars.test_undefined = TRUE;
917 else if (strcmp (mode, "no-undefined") == 0)
918 mutable_test_config_vars.test_undefined = FALSE;
920 g_error ("unknown test mode: -m %s", mode);
923 else if (strcmp ("-q", argv[i]) == 0 || strcmp ("--quiet", argv[i]) == 0)
925 mutable_test_config_vars.test_quiet = TRUE;
926 mutable_test_config_vars.test_verbose = FALSE;
929 else if (strcmp ("--verbose", argv[i]) == 0)
931 mutable_test_config_vars.test_quiet = FALSE;
932 mutable_test_config_vars.test_verbose = TRUE;
935 else if (strcmp ("-l", argv[i]) == 0)
937 test_run_list = TRUE;
940 else if (strcmp ("--seed", argv[i]) == 0 || strncmp ("--seed=", argv[i], 7) == 0)
942 gchar *equal = argv[i] + 6;
944 test_run_seedstr = equal + 1;
945 else if (i + 1 < argc)
948 test_run_seedstr = argv[i];
952 else if (strcmp ("-?", argv[i]) == 0 ||
953 strcmp ("-h", argv[i]) == 0 ||
954 strcmp ("--help", argv[i]) == 0)
957 " %s [OPTION...]\n\n"
959 " -h, --help Show help options\n\n"
961 " --g-fatal-warnings Make all warnings fatal\n"
962 " -l List test cases available in a test executable\n"
963 " -m {perf|slow|thorough|quick} Execute tests according to mode\n"
964 " -m {undefined|no-undefined} Execute tests according to mode\n"
965 " -p TESTPATH Only start test cases matching TESTPATH\n"
966 " -s TESTPATH Skip all tests matching TESTPATH\n"
967 " -seed=SEEDSTRING Start tests with random seed SEEDSTRING\n"
968 " --debug-log debug test logging output\n"
969 " -q, --quiet Run tests quietly\n"
970 " --verbose Run tests verbosely\n",
977 for (i = 1; i < argc; i++)
989 * @argc: Address of the @argc parameter of the main() function.
990 * Changed if any arguments were handled.
991 * @argv: Address of the @argv parameter of main().
992 * Any parameters understood by g_test_init() stripped before return.
993 * @...: Reserved for future extension. Currently, you must pass %NULL.
995 * Initialize the GLib testing framework, e.g. by seeding the
996 * test random number generator, the name for g_get_prgname()
997 * and parsing test related command line args.
998 * So far, the following arguments are understood:
1001 * <term><option>-l</option></term>
1003 * List test cases available in a test executable.
1004 * </para></listitem>
1007 * <term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
1009 * Provide a random seed to reproduce test runs using random numbers.
1010 * </para></listitem>
1013 * <term><option>--verbose</option></term>
1014 * <listitem><para>Run tests verbosely.</para></listitem>
1017 * <term><option>-q</option>, <option>--quiet</option></term>
1018 * <listitem><para>Run tests quietly.</para></listitem>
1021 * <term><option>-p <replaceable>TESTPATH</replaceable></option></term>
1023 * Execute all tests matching <replaceable>TESTPATH</replaceable>.
1024 * This can also be used to force a test to run that would otherwise
1025 * be skipped (ie, a test whose name contains "/subprocess").
1026 * </para></listitem>
1029 * <term><option>-m {perf|slow|thorough|quick|undefined|no-undefined}</option></term>
1031 * Execute tests according to these test modes:
1036 * Performance tests, may take long and report results.
1037 * </para></listitem>
1040 * <term>slow, thorough</term>
1042 * Slow and thorough tests, may take quite long and
1043 * maximize coverage.
1044 * </para></listitem>
1047 * <term>quick</term>
1049 * Quick tests, should run really quickly and give good coverage.
1050 * </para></listitem>
1053 * <term>undefined</term>
1055 * Tests for undefined behaviour, may provoke programming errors
1056 * under g_test_trap_subprocess() or g_test_expect_messages() to check
1057 * that appropriate assertions or warnings are given
1058 * </para></listitem>
1061 * <term>no-undefined</term>
1063 * Avoid tests for undefined behaviour
1064 * </para></listitem>
1067 * </para></listitem>
1070 * <term><option>--debug-log</option></term>
1071 * <listitem><para>Debug test logging output.</para></listitem>
1078 g_test_init (int *argc,
1082 static char seedstr[4 + 4 * 8 + 1];
1085 /* make warnings and criticals fatal for all test programs */
1086 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
1087 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
1088 g_log_set_always_fatal (fatal_mask);
1089 /* check caller args */
1090 g_return_if_fail (argc != NULL);
1091 g_return_if_fail (argv != NULL);
1092 g_return_if_fail (g_test_config_vars->test_initialized == FALSE);
1093 mutable_test_config_vars.test_initialized = TRUE;
1095 va_start (args, argv);
1096 vararg1 = va_arg (args, gpointer); /* reserved for future extensions */
1098 g_return_if_fail (vararg1 == NULL);
1100 /* setup random seed string */
1101 g_snprintf (seedstr, sizeof (seedstr), "R02S%08x%08x%08x%08x", g_random_int(), g_random_int(), g_random_int(), g_random_int());
1102 test_run_seedstr = seedstr;
1104 /* parse args, sets up mode, changes seed, etc. */
1105 parse_args (argc, argv);
1106 if (!g_get_prgname())
1107 g_set_prgname ((*argv)[0]);
1109 /* verify GRand reliability, needed for reliable seeds */
1112 GRand *rg = g_rand_new_with_seed (0xc8c49fb6);
1113 guint32 t1 = g_rand_int (rg), t2 = g_rand_int (rg), t3 = g_rand_int (rg), t4 = g_rand_int (rg);
1114 /* g_print ("GRand-current: 0x%x 0x%x 0x%x 0x%x\n", t1, t2, t3, t4); */
1115 if (t1 != 0xfab39f9b || t2 != 0xb948fb0e || t3 != 0x3d31be26 || t4 != 0x43a19d66)
1116 g_warning ("random numbers are not GRand-2.2 compatible, seeds may be broken (check $G_RANDOM_VERSION)");
1120 /* check rand seed */
1121 test_run_seed (test_run_seedstr);
1123 /* report program start */
1124 g_log_set_default_handler (gtest_default_log_handler, NULL);
1125 g_test_log (G_TEST_LOG_START_BINARY, g_get_prgname(), test_run_seedstr, 0, NULL);
1127 test_argv0_dirname = g_path_get_dirname (test_argv0);
1129 /* Make sure we get the real dirname that the test was run from */
1130 if (g_str_has_suffix (test_argv0_dirname, "/.libs"))
1133 tmp = g_path_get_dirname (test_argv0_dirname);
1134 g_free (test_argv0_dirname);
1135 test_argv0_dirname = tmp;
1138 test_disted_files_dir = g_getenv ("G_TEST_SRCDIR");
1139 if (!test_disted_files_dir)
1140 test_disted_files_dir = test_argv0_dirname;
1142 test_built_files_dir = g_getenv ("G_TEST_BUILDDIR");
1143 if (!test_built_files_dir)
1144 test_built_files_dir = test_argv0_dirname;
1148 test_run_seed (const gchar *rseed)
1150 guint seed_failed = 0;
1152 g_rand_free (test_run_rand);
1153 test_run_rand = NULL;
1154 while (strchr (" \t\v\r\n\f", *rseed))
1156 if (strncmp (rseed, "R02S", 4) == 0) /* seed for random generator 02 (GRand-2.2) */
1158 const char *s = rseed + 4;
1159 if (strlen (s) >= 32) /* require 4 * 8 chars */
1161 guint32 seedarray[4];
1162 gchar *p, hexbuf[9] = { 0, };
1163 memcpy (hexbuf, s + 0, 8);
1164 seedarray[0] = g_ascii_strtoull (hexbuf, &p, 16);
1165 seed_failed += p != NULL && *p != 0;
1166 memcpy (hexbuf, s + 8, 8);
1167 seedarray[1] = g_ascii_strtoull (hexbuf, &p, 16);
1168 seed_failed += p != NULL && *p != 0;
1169 memcpy (hexbuf, s + 16, 8);
1170 seedarray[2] = g_ascii_strtoull (hexbuf, &p, 16);
1171 seed_failed += p != NULL && *p != 0;
1172 memcpy (hexbuf, s + 24, 8);
1173 seedarray[3] = g_ascii_strtoull (hexbuf, &p, 16);
1174 seed_failed += p != NULL && *p != 0;
1177 test_run_rand = g_rand_new_with_seed_array (seedarray, 4);
1182 g_error ("Unknown or invalid random seed: %s", rseed);
1188 * Get a reproducible random integer number.
1190 * The random numbers generated by the g_test_rand_*() family of functions
1191 * change with every new test program start, unless the --seed option is
1192 * given when starting test programs.
1194 * For individual test cases however, the random number generator is
1195 * reseeded, to avoid dependencies between tests and to make --seed
1196 * effective for all test cases.
1198 * Returns: a random number from the seeded random number generator.
1203 g_test_rand_int (void)
1205 return g_rand_int (test_run_rand);
1209 * g_test_rand_int_range:
1210 * @begin: the minimum value returned by this function
1211 * @end: the smallest value not to be returned by this function
1213 * Get a reproducible random integer number out of a specified range,
1214 * see g_test_rand_int() for details on test case random numbers.
1216 * Returns: a number with @begin <= number < @end.
1221 g_test_rand_int_range (gint32 begin,
1224 return g_rand_int_range (test_run_rand, begin, end);
1228 * g_test_rand_double:
1230 * Get a reproducible random floating point number,
1231 * see g_test_rand_int() for details on test case random numbers.
1233 * Returns: a random number from the seeded random number generator.
1238 g_test_rand_double (void)
1240 return g_rand_double (test_run_rand);
1244 * g_test_rand_double_range:
1245 * @range_start: the minimum value returned by this function
1246 * @range_end: the minimum value not returned by this function
1248 * Get a reproducible random floating pointer number out of a specified range,
1249 * see g_test_rand_int() for details on test case random numbers.
1251 * Returns: a number with @range_start <= number < @range_end.
1256 g_test_rand_double_range (double range_start,
1259 return g_rand_double_range (test_run_rand, range_start, range_end);
1263 * g_test_timer_start:
1265 * Start a timing test. Call g_test_timer_elapsed() when the task is supposed
1266 * to be done. Call this function again to restart the timer.
1271 g_test_timer_start (void)
1273 if (!test_user_timer)
1274 test_user_timer = g_timer_new();
1275 test_user_stamp = 0;
1276 g_timer_start (test_user_timer);
1280 * g_test_timer_elapsed:
1282 * Get the time since the last start of the timer with g_test_timer_start().
1284 * Returns: the time since the last start of the timer, as a double
1289 g_test_timer_elapsed (void)
1291 test_user_stamp = test_user_timer ? g_timer_elapsed (test_user_timer, NULL) : 0;
1292 return test_user_stamp;
1296 * g_test_timer_last:
1298 * Report the last result of g_test_timer_elapsed().
1300 * Returns: the last result of g_test_timer_elapsed(), as a double
1305 g_test_timer_last (void)
1307 return test_user_stamp;
1311 * g_test_minimized_result:
1312 * @minimized_quantity: the reported value
1313 * @format: the format string of the report message
1314 * @...: arguments to pass to the printf() function
1316 * Report the result of a performance or measurement test.
1317 * The test should generally strive to minimize the reported
1318 * quantities (smaller values are better than larger ones),
1319 * this and @minimized_quantity can determine sorting
1320 * order for test result reports.
1325 g_test_minimized_result (double minimized_quantity,
1329 long double largs = minimized_quantity;
1333 va_start (args, format);
1334 buffer = g_strdup_vprintf (format, args);
1337 g_test_log (G_TEST_LOG_MIN_RESULT, buffer, NULL, 1, &largs);
1342 * g_test_maximized_result:
1343 * @maximized_quantity: the reported value
1344 * @format: the format string of the report message
1345 * @...: arguments to pass to the printf() function
1347 * Report the result of a performance or measurement test.
1348 * The test should generally strive to maximize the reported
1349 * quantities (larger values are better than smaller ones),
1350 * this and @maximized_quantity can determine sorting
1351 * order for test result reports.
1356 g_test_maximized_result (double maximized_quantity,
1360 long double largs = maximized_quantity;
1364 va_start (args, format);
1365 buffer = g_strdup_vprintf (format, args);
1368 g_test_log (G_TEST_LOG_MAX_RESULT, buffer, NULL, 1, &largs);
1374 * @format: the format string
1375 * @...: printf-like arguments to @format
1377 * Add a message to the test report.
1382 g_test_message (const char *format,
1388 va_start (args, format);
1389 buffer = g_strdup_vprintf (format, args);
1392 g_test_log (G_TEST_LOG_MESSAGE, buffer, NULL, 0, NULL);
1398 * @uri_pattern: the base pattern for bug URIs
1400 * Specify the base URI for bug reports.
1402 * The base URI is used to construct bug report messages for
1403 * g_test_message() when g_test_bug() is called.
1404 * Calling this function outside of a test case sets the
1405 * default base URI for all test cases. Calling it from within
1406 * a test case changes the base URI for the scope of the test
1408 * Bug URIs are constructed by appending a bug specific URI
1409 * portion to @uri_pattern, or by replacing the special string
1410 * '\%s' within @uri_pattern if that is present.
1415 g_test_bug_base (const char *uri_pattern)
1417 g_free (test_uri_base);
1418 test_uri_base = g_strdup (uri_pattern);
1423 * @bug_uri_snippet: Bug specific bug tracker URI portion.
1425 * This function adds a message to test reports that
1426 * associates a bug URI with a test case.
1427 * Bug URIs are constructed from a base URI set with g_test_bug_base()
1428 * and @bug_uri_snippet.
1433 g_test_bug (const char *bug_uri_snippet)
1437 g_return_if_fail (test_uri_base != NULL);
1438 g_return_if_fail (bug_uri_snippet != NULL);
1440 c = strstr (test_uri_base, "%s");
1443 char *b = g_strndup (test_uri_base, c - test_uri_base);
1444 char *s = g_strconcat (b, bug_uri_snippet, c + 2, NULL);
1446 g_test_message ("Bug Reference: %s", s);
1450 g_test_message ("Bug Reference: %s%s", test_uri_base, bug_uri_snippet);
1456 * Get the toplevel test suite for the test path API.
1458 * Returns: the toplevel #GTestSuite
1463 g_test_get_root (void)
1465 if (!test_suite_root)
1467 test_suite_root = g_test_create_suite ("root");
1468 g_free (test_suite_root->name);
1469 test_suite_root->name = g_strdup ("");
1472 return test_suite_root;
1478 * Runs all tests under the toplevel suite which can be retrieved
1479 * with g_test_get_root(). Similar to g_test_run_suite(), the test
1480 * cases to be run are filtered according to
1481 * test path arguments (-p <replaceable>testpath</replaceable>) as
1482 * parsed by g_test_init().
1483 * g_test_run_suite() or g_test_run() may only be called once
1486 * Returns: 0 on success
1493 return g_test_run_suite (g_test_get_root());
1497 * g_test_create_case:
1498 * @test_name: the name for the test case
1499 * @data_size: the size of the fixture data structure
1500 * @test_data: test data argument for the test functions
1501 * @data_setup: the function to set up the fixture data
1502 * @data_test: the actual test function
1503 * @data_teardown: the function to teardown the fixture data
1505 * Create a new #GTestCase, named @test_name, this API is fairly
1506 * low level, calling g_test_add() or g_test_add_func() is preferable.
1507 * When this test is executed, a fixture structure of size @data_size
1508 * will be allocated and filled with 0s. Then @data_setup is called
1509 * to initialize the fixture. After fixture setup, the actual test
1510 * function @data_test is called. Once the test run completed, the
1511 * fixture structure is torn down by calling @data_teardown and
1512 * after that the memory is released.
1514 * Splitting up a test run into fixture setup, test function and
1515 * fixture teardown is most usful if the same fixture is used for
1516 * multiple tests. In this cases, g_test_create_case() will be
1517 * called with the same fixture, but varying @test_name and
1518 * @data_test arguments.
1520 * Returns: a newly allocated #GTestCase.
1525 g_test_create_case (const char *test_name,
1527 gconstpointer test_data,
1528 GTestFixtureFunc data_setup,
1529 GTestFixtureFunc data_test,
1530 GTestFixtureFunc data_teardown)
1534 g_return_val_if_fail (test_name != NULL, NULL);
1535 g_return_val_if_fail (strchr (test_name, '/') == NULL, NULL);
1536 g_return_val_if_fail (test_name[0] != 0, NULL);
1537 g_return_val_if_fail (data_test != NULL, NULL);
1539 tc = g_slice_new0 (GTestCase);
1540 tc->name = g_strdup (test_name);
1541 tc->test_data = (gpointer) test_data;
1542 tc->fixture_size = data_size;
1543 tc->fixture_setup = (void*) data_setup;
1544 tc->fixture_test = (void*) data_test;
1545 tc->fixture_teardown = (void*) data_teardown;
1551 find_suite (gconstpointer l, gconstpointer s)
1553 const GTestSuite *suite = l;
1554 const gchar *str = s;
1556 return strcmp (suite->name, str);
1561 * @fixture: the test fixture
1562 * @user_data: the data provided when registering the test
1564 * The type used for functions that operate on test fixtures. This is
1565 * used for the fixture setup and teardown functions as well as for the
1566 * testcases themselves.
1568 * @user_data is a pointer to the data that was given when registering
1571 * @fixture will be a pointer to the area of memory allocated by the
1572 * test framework, of the size requested. If the requested size was
1573 * zero then @fixture will be equal to @user_data.
1578 g_test_add_vtable (const char *testpath,
1580 gconstpointer test_data,
1581 GTestFixtureFunc data_setup,
1582 GTestFixtureFunc fixture_test_func,
1583 GTestFixtureFunc data_teardown)
1589 g_return_if_fail (testpath != NULL);
1590 g_return_if_fail (g_path_is_absolute (testpath));
1591 g_return_if_fail (fixture_test_func != NULL);
1593 if (g_slist_find_custom (test_paths_skipped, testpath, (GCompareFunc)g_strcmp0))
1596 suite = g_test_get_root();
1597 segments = g_strsplit (testpath, "/", -1);
1598 for (ui = 0; segments[ui] != NULL; ui++)
1600 const char *seg = segments[ui];
1601 gboolean islast = segments[ui + 1] == NULL;
1602 if (islast && !seg[0])
1603 g_error ("invalid test case path: %s", testpath);
1605 continue; /* initial or duplicate slash */
1610 l = g_slist_find_custom (suite->suites, seg, find_suite);
1617 csuite = g_test_create_suite (seg);
1618 g_test_suite_add_suite (suite, csuite);
1624 GTestCase *tc = g_test_create_case (seg, data_size, test_data, data_setup, fixture_test_func, data_teardown);
1625 g_test_suite_add (suite, tc);
1628 g_strfreev (segments);
1634 * Indicates that a test failed. This function can be called
1635 * multiple times from the same test. You can use this function
1636 * if your test failed in a recoverable way.
1638 * Do not use this function if the failure of a test could cause
1639 * other tests to malfunction.
1641 * Calling this function will not stop the test from running, you
1642 * need to return from the test function yourself. So you can
1643 * produce additional diagnostic messages or even continue running
1646 * If not called from inside a test, this function does nothing.
1653 test_run_success = G_TEST_RUN_FAILURE;
1657 * g_test_incomplete:
1658 * @msg: (allow-none): explanation
1660 * Indicates that a test failed because of some incomplete
1661 * functionality. This function can be called multiple times
1662 * from the same test.
1664 * Calling this function will not stop the test from running, you
1665 * need to return from the test function yourself. So you can
1666 * produce additional diagnostic messages or even continue running
1669 * If not called from inside a test, this function does nothing.
1674 g_test_incomplete (const gchar *msg)
1676 test_run_success = G_TEST_RUN_INCOMPLETE;
1677 g_free (test_run_msg);
1678 test_run_msg = g_strdup (msg);
1683 * @msg: (allow-none): explanation
1685 * Indicates that a test was skipped.
1687 * Calling this function will not stop the test from running, you
1688 * need to return from the test function yourself. So you can
1689 * produce additional diagnostic messages or even continue running
1692 * If not called from inside a test, this function does nothing.
1697 g_test_skip (const gchar *msg)
1699 test_run_success = G_TEST_RUN_SKIPPED;
1700 g_free (test_run_msg);
1701 test_run_msg = g_strdup (msg);
1707 * Returns whether a test has already failed. This will
1708 * be the case when g_test_fail(), g_test_incomplete()
1709 * or g_test_skip() have been called, but also if an
1710 * assertion has failed.
1712 * This can be useful to return early from a test if
1713 * continuing after a failed assertion might be harmful.
1715 * The return value of this function is only meaningful
1716 * if it is called from inside a test function.
1718 * Returns: %TRUE if the test has failed
1723 g_test_failed (void)
1725 return test_run_success != G_TEST_RUN_SUCCESS;
1731 * The type used for test case functions.
1738 * @testpath: /-separated test case path name for the test.
1739 * @test_func: The test function to invoke for this test.
1741 * Create a new test case, similar to g_test_create_case(). However
1742 * the test is assumed to use no fixture, and test suites are automatically
1743 * created on the fly and added to the root fixture, based on the
1744 * slash-separated portions of @testpath.
1746 * If @testpath includes the component "subprocess" anywhere in it,
1747 * the test will be skipped by default, and only run if explicitly
1748 * required via the <option>-p</option> command-line option or
1749 * g_test_trap_subprocess().
1754 g_test_add_func (const char *testpath,
1755 GTestFunc test_func)
1757 g_return_if_fail (testpath != NULL);
1758 g_return_if_fail (testpath[0] == '/');
1759 g_return_if_fail (test_func != NULL);
1760 g_test_add_vtable (testpath, 0, NULL, NULL, (GTestFixtureFunc) test_func, NULL);
1765 * @user_data: the data provided when registering the test
1767 * The type used for test case functions that take an extra pointer
1774 * g_test_add_data_func:
1775 * @testpath: /-separated test case path name for the test.
1776 * @test_data: Test data argument for the test function.
1777 * @test_func: The test function to invoke for this test.
1779 * Create a new test case, similar to g_test_create_case(). However
1780 * the test is assumed to use no fixture, and test suites are automatically
1781 * created on the fly and added to the root fixture, based on the
1782 * slash-separated portions of @testpath. The @test_data argument
1783 * will be passed as first argument to @test_func.
1785 * If @testpath includes the component "subprocess" anywhere in it,
1786 * the test will be skipped by default, and only run if explicitly
1787 * required via the <option>-p</option> command-line option or
1788 * g_test_trap_subprocess().
1793 g_test_add_data_func (const char *testpath,
1794 gconstpointer test_data,
1795 GTestDataFunc test_func)
1797 g_return_if_fail (testpath != NULL);
1798 g_return_if_fail (testpath[0] == '/');
1799 g_return_if_fail (test_func != NULL);
1801 g_test_add_vtable (testpath, 0, test_data, NULL, (GTestFixtureFunc) test_func, NULL);
1805 * g_test_add_data_func_full:
1806 * @testpath: /-separated test case path name for the test.
1807 * @test_data: Test data argument for the test function.
1808 * @test_func: The test function to invoke for this test.
1809 * @data_free_func: #GDestroyNotify for @test_data.
1811 * Create a new test case, as with g_test_add_data_func(), but freeing
1812 * @test_data after the test run is complete.
1817 g_test_add_data_func_full (const char *testpath,
1819 GTestDataFunc test_func,
1820 GDestroyNotify data_free_func)
1822 g_return_if_fail (testpath != NULL);
1823 g_return_if_fail (testpath[0] == '/');
1824 g_return_if_fail (test_func != NULL);
1826 g_test_add_vtable (testpath, 0, test_data, NULL,
1827 (GTestFixtureFunc) test_func,
1828 (GTestFixtureFunc) data_free_func);
1832 g_test_suite_case_exists (GTestSuite *suite,
1833 const char *test_path)
1840 slash = strchr (test_path, '/');
1844 for (iter = suite->suites; iter; iter = iter->next)
1846 GTestSuite *child_suite = iter->data;
1848 if (!strncmp (child_suite->name, test_path, slash - test_path))
1849 if (g_test_suite_case_exists (child_suite, slash))
1855 for (iter = suite->cases; iter; iter = iter->next)
1858 if (!strcmp (tc->name, test_path))
1867 * g_test_create_suite:
1868 * @suite_name: a name for the suite
1870 * Create a new test suite with the name @suite_name.
1872 * Returns: A newly allocated #GTestSuite instance.
1877 g_test_create_suite (const char *suite_name)
1880 g_return_val_if_fail (suite_name != NULL, NULL);
1881 g_return_val_if_fail (strchr (suite_name, '/') == NULL, NULL);
1882 g_return_val_if_fail (suite_name[0] != 0, NULL);
1883 ts = g_slice_new0 (GTestSuite);
1884 ts->name = g_strdup (suite_name);
1890 * @suite: a #GTestSuite
1891 * @test_case: a #GTestCase
1893 * Adds @test_case to @suite.
1898 g_test_suite_add (GTestSuite *suite,
1899 GTestCase *test_case)
1901 g_return_if_fail (suite != NULL);
1902 g_return_if_fail (test_case != NULL);
1904 suite->cases = g_slist_prepend (suite->cases, test_case);
1908 * g_test_suite_add_suite:
1909 * @suite: a #GTestSuite
1910 * @nestedsuite: another #GTestSuite
1912 * Adds @nestedsuite to @suite.
1917 g_test_suite_add_suite (GTestSuite *suite,
1918 GTestSuite *nestedsuite)
1920 g_return_if_fail (suite != NULL);
1921 g_return_if_fail (nestedsuite != NULL);
1923 suite->suites = g_slist_prepend (suite->suites, nestedsuite);
1927 * g_test_queue_free:
1928 * @gfree_pointer: the pointer to be stored.
1930 * Enqueue a pointer to be released with g_free() during the next
1931 * teardown phase. This is equivalent to calling g_test_queue_destroy()
1932 * with a destroy callback of g_free().
1937 g_test_queue_free (gpointer gfree_pointer)
1940 g_test_queue_destroy (g_free, gfree_pointer);
1944 * g_test_queue_destroy:
1945 * @destroy_func: Destroy callback for teardown phase.
1946 * @destroy_data: Destroy callback data.
1948 * This function enqueus a callback @destroy_func to be executed
1949 * during the next test case teardown phase. This is most useful
1950 * to auto destruct allocted test resources at the end of a test run.
1951 * Resources are released in reverse queue order, that means enqueueing
1952 * callback A before callback B will cause B() to be called before
1953 * A() during teardown.
1958 g_test_queue_destroy (GDestroyNotify destroy_func,
1959 gpointer destroy_data)
1961 DestroyEntry *dentry;
1963 g_return_if_fail (destroy_func != NULL);
1965 dentry = g_slice_new0 (DestroyEntry);
1966 dentry->destroy_func = destroy_func;
1967 dentry->destroy_data = destroy_data;
1968 dentry->next = test_destroy_queue;
1969 test_destroy_queue = dentry;
1973 test_case_run (GTestCase *tc)
1975 gchar *old_name = test_run_name, *old_base = g_strdup (test_uri_base);
1976 GSList **old_free_list, *filename_free_list = NULL;
1977 gboolean success = G_TEST_RUN_SUCCESS;
1979 old_free_list = test_filename_free_list;
1980 test_filename_free_list = &filename_free_list;
1982 test_run_name = g_strconcat (old_name, "/", tc->name, NULL);
1983 if (strstr (test_run_name, "/subprocess"))
1986 gboolean found = FALSE;
1988 for (iter = test_paths; iter; iter = iter->next)
1990 if (!strcmp (test_run_name, iter->data))
1999 if (g_test_verbose ())
2000 g_print ("GTest: skipping: %s\n", test_run_name);
2005 if (++test_run_count <= test_skip_count)
2006 g_test_log (G_TEST_LOG_SKIP_CASE, test_run_name, NULL, 0, NULL);
2007 else if (test_run_list)
2009 g_print ("%s\n", test_run_name);
2010 g_test_log (G_TEST_LOG_LIST_CASE, test_run_name, NULL, 0, NULL);
2014 GTimer *test_run_timer = g_timer_new();
2015 long double largs[3];
2017 g_test_log (G_TEST_LOG_START_CASE, test_run_name, NULL, 0, NULL);
2019 test_run_success = G_TEST_RUN_SUCCESS;
2020 g_clear_pointer (&test_run_msg, g_free);
2021 g_test_log_set_fatal_handler (NULL, NULL);
2022 g_timer_start (test_run_timer);
2023 fixture = tc->fixture_size ? g_malloc0 (tc->fixture_size) : tc->test_data;
2024 test_run_seed (test_run_seedstr);
2025 if (tc->fixture_setup)
2026 tc->fixture_setup (fixture, tc->test_data);
2027 tc->fixture_test (fixture, tc->test_data);
2029 while (test_destroy_queue)
2031 DestroyEntry *dentry = test_destroy_queue;
2032 test_destroy_queue = dentry->next;
2033 dentry->destroy_func (dentry->destroy_data);
2034 g_slice_free (DestroyEntry, dentry);
2036 if (tc->fixture_teardown)
2037 tc->fixture_teardown (fixture, tc->test_data);
2038 if (tc->fixture_size)
2040 g_timer_stop (test_run_timer);
2041 success = test_run_success;
2042 test_run_success = G_TEST_RUN_FAILURE;
2043 largs[0] = success; /* OK */
2044 largs[1] = test_run_forks;
2045 largs[2] = g_timer_elapsed (test_run_timer, NULL);
2046 g_test_log (G_TEST_LOG_STOP_CASE, test_run_name, test_run_msg, G_N_ELEMENTS (largs), largs);
2047 g_clear_pointer (&test_run_msg, g_free);
2048 g_timer_destroy (test_run_timer);
2052 g_slist_free_full (filename_free_list, g_free);
2053 test_filename_free_list = old_free_list;
2054 g_free (test_run_name);
2055 test_run_name = old_name;
2056 g_free (test_uri_base);
2057 test_uri_base = old_base;
2059 return success == G_TEST_RUN_SUCCESS;
2063 g_test_run_suite_internal (GTestSuite *suite,
2067 gchar *rest, *old_name = test_run_name;
2068 GSList *slist, *reversed;
2070 g_return_val_if_fail (suite != NULL, -1);
2072 g_test_log (G_TEST_LOG_START_SUITE, suite->name, NULL, 0, NULL);
2074 while (path[0] == '/')
2077 rest = strchr (path, '/');
2078 l = rest ? MIN (l, rest - path) : l;
2079 test_run_name = suite->name[0] == 0 ? g_strdup (test_run_name) : g_strconcat (old_name, "/", suite->name, NULL);
2080 reversed = g_slist_reverse (g_slist_copy (suite->cases));
2081 for (slist = reversed; slist; slist = slist->next)
2083 GTestCase *tc = slist->data;
2084 guint n = l ? strlen (tc->name) : 0;
2085 if (l == n && !rest && strncmp (path, tc->name, n) == 0)
2087 if (!test_case_run (tc))
2091 g_slist_free (reversed);
2092 reversed = g_slist_reverse (g_slist_copy (suite->suites));
2093 for (slist = reversed; slist; slist = slist->next)
2095 GTestSuite *ts = slist->data;
2096 guint n = l ? strlen (ts->name) : 0;
2097 if (l == n && strncmp (path, ts->name, n) == 0)
2098 n_bad += g_test_run_suite_internal (ts, rest ? rest : "");
2100 g_slist_free (reversed);
2101 g_free (test_run_name);
2102 test_run_name = old_name;
2104 g_test_log (G_TEST_LOG_STOP_SUITE, suite->name, NULL, 0, NULL);
2111 * @suite: a #GTestSuite
2113 * Execute the tests within @suite and all nested #GTestSuites.
2114 * The test suites to be executed are filtered according to
2115 * test path arguments (-p <replaceable>testpath</replaceable>)
2116 * as parsed by g_test_init().
2117 * g_test_run_suite() or g_test_run() may only be called once
2120 * Returns: 0 on success
2125 g_test_run_suite (GTestSuite *suite)
2127 GSList *my_test_paths;
2130 g_return_val_if_fail (g_test_config_vars->test_initialized, -1);
2131 g_return_val_if_fail (g_test_run_once == TRUE, -1);
2133 g_test_run_once = FALSE;
2136 my_test_paths = g_slist_copy (test_paths);
2138 my_test_paths = g_slist_prepend (NULL, "");
2140 while (my_test_paths)
2142 const char *rest, *path = my_test_paths->data;
2143 guint l, n = strlen (suite->name);
2144 my_test_paths = g_slist_delete_link (my_test_paths, my_test_paths);
2145 while (path[0] == '/')
2147 if (!n) /* root suite, run unconditionally */
2149 n_bad += g_test_run_suite_internal (suite, path);
2152 /* regular suite, match path */
2153 rest = strchr (path, '/');
2155 l = rest ? MIN (l, rest - path) : l;
2156 if ((!l || l == n) && strncmp (path, suite->name, n) == 0)
2157 n_bad += g_test_run_suite_internal (suite, rest ? rest : "");
2164 gtest_default_log_handler (const gchar *log_domain,
2165 GLogLevelFlags log_level,
2166 const gchar *message,
2167 gpointer unused_data)
2169 const gchar *strv[16];
2170 gboolean fatal = FALSE;
2176 strv[i++] = log_domain;
2179 if (log_level & G_LOG_FLAG_FATAL)
2181 strv[i++] = "FATAL-";
2184 if (log_level & G_LOG_FLAG_RECURSION)
2185 strv[i++] = "RECURSIVE-";
2186 if (log_level & G_LOG_LEVEL_ERROR)
2187 strv[i++] = "ERROR";
2188 if (log_level & G_LOG_LEVEL_CRITICAL)
2189 strv[i++] = "CRITICAL";
2190 if (log_level & G_LOG_LEVEL_WARNING)
2191 strv[i++] = "WARNING";
2192 if (log_level & G_LOG_LEVEL_MESSAGE)
2193 strv[i++] = "MESSAGE";
2194 if (log_level & G_LOG_LEVEL_INFO)
2196 if (log_level & G_LOG_LEVEL_DEBUG)
2197 strv[i++] = "DEBUG";
2199 strv[i++] = message;
2202 msg = g_strjoinv ("", (gchar**) strv);
2203 g_test_log (fatal ? G_TEST_LOG_ERROR : G_TEST_LOG_MESSAGE, msg, NULL, 0, NULL);
2204 g_log_default_handler (log_domain, log_level, message, unused_data);
2210 g_assertion_message (const char *domain,
2214 const char *message)
2220 message = "code should not be reached";
2221 g_snprintf (lstr, 32, "%d", line);
2222 s = g_strconcat (domain ? domain : "", domain && domain[0] ? ":" : "",
2223 "ERROR:", file, ":", lstr, ":",
2224 func, func[0] ? ":" : "",
2225 " ", message, NULL);
2226 g_printerr ("**\n%s\n", s);
2228 /* store assertion message in global variable, so that it can be found in a
2230 if (__glib_assert_msg != NULL)
2231 /* free the old one */
2232 free (__glib_assert_msg);
2233 __glib_assert_msg = (char*) malloc (strlen (s) + 1);
2234 strcpy (__glib_assert_msg, s);
2236 g_test_log (G_TEST_LOG_ERROR, s, NULL, 0, NULL);
2242 g_assertion_message_expr (const char *domain,
2250 s = g_strdup ("code should not be reached");
2252 s = g_strconcat ("assertion failed: (", expr, ")", NULL);
2253 g_assertion_message (domain, file, line, func, s);
2258 g_assertion_message_cmpnum (const char *domain,
2272 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;
2273 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;
2274 case 'f': s = g_strdup_printf ("assertion failed (%s): (%.9g %s %.9g)", expr, (double) arg1, cmp, (double) arg2); break;
2275 /* ideally use: floats=%.7g double=%.17g */
2277 g_assertion_message (domain, file, line, func, s);
2282 g_assertion_message_cmpstr (const char *domain,
2291 char *a1, *a2, *s, *t1 = NULL, *t2 = NULL;
2292 a1 = arg1 ? g_strconcat ("\"", t1 = g_strescape (arg1, NULL), "\"", NULL) : g_strdup ("NULL");
2293 a2 = arg2 ? g_strconcat ("\"", t2 = g_strescape (arg2, NULL), "\"", NULL) : g_strdup ("NULL");
2296 s = g_strdup_printf ("assertion failed (%s): (%s %s %s)", expr, a1, cmp, a2);
2299 g_assertion_message (domain, file, line, func, s);
2304 g_assertion_message_error (const char *domain,
2309 const GError *error,
2310 GQuark error_domain,
2315 /* This is used by both g_assert_error() and g_assert_no_error(), so there
2316 * are three cases: expected an error but got the wrong error, expected
2317 * an error but got no error, and expected no error but got an error.
2320 gstring = g_string_new ("assertion failed ");
2322 g_string_append_printf (gstring, "(%s == (%s, %d)): ", expr,
2323 g_quark_to_string (error_domain), error_code);
2325 g_string_append_printf (gstring, "(%s == NULL): ", expr);
2328 g_string_append_printf (gstring, "%s (%s, %d)", error->message,
2329 g_quark_to_string (error->domain), error->code);
2331 g_string_append_printf (gstring, "%s is NULL", expr);
2333 g_assertion_message (domain, file, line, func, gstring->str);
2334 g_string_free (gstring, TRUE);
2339 * @str1: (allow-none): a C string or %NULL
2340 * @str2: (allow-none): another C string or %NULL
2342 * Compares @str1 and @str2 like strcmp(). Handles %NULL
2343 * gracefully by sorting it before non-%NULL strings.
2344 * Comparing two %NULL pointers returns 0.
2346 * Returns: an integer less than, equal to, or greater than zero, if @str1 is <, == or > than @str2.
2351 g_strcmp0 (const char *str1,
2355 return -(str1 != str2);
2357 return str1 != str2;
2358 return strcmp (str1, str2);
2362 test_trap_clear (void)
2364 test_trap_last_status = 0;
2365 test_trap_last_pid = 0;
2366 g_clear_pointer (&test_trap_last_subprocess, g_free);
2367 g_clear_pointer (&test_trap_last_stdout, g_free);
2368 g_clear_pointer (&test_trap_last_stderr, g_free);
2379 ret = dup2 (fd1, fd2);
2380 while (ret < 0 && errno == EINTR);
2391 GIOChannel *stdout_io;
2392 gboolean echo_stdout;
2393 GString *stdout_str;
2395 GIOChannel *stderr_io;
2396 gboolean echo_stderr;
2397 GString *stderr_str;
2401 check_complete (WaitForChildData *data)
2403 if (data->child_status != -1 && data->stdout_io == NULL && data->stderr_io == NULL)
2404 g_main_loop_quit (data->loop);
2408 child_exited (GPid pid,
2412 WaitForChildData *data = user_data;
2415 if (WIFEXITED (status)) /* normal exit */
2416 data->child_status = WEXITSTATUS (status); /* 0..255 */
2417 else if (WIFSIGNALED (status) && WTERMSIG (status) == SIGALRM)
2418 data->child_status = G_TEST_STATUS_TIMED_OUT;
2419 else if (WIFSIGNALED (status))
2420 data->child_status = (WTERMSIG (status) << 12); /* signalled */
2421 else /* WCOREDUMP (status) */
2422 data->child_status = 512; /* coredump */
2424 data->child_status = status;
2427 check_complete (data);
2431 child_timeout (gpointer user_data)
2433 WaitForChildData *data = user_data;
2436 TerminateProcess (data->pid, G_TEST_STATUS_TIMED_OUT);
2438 kill (data->pid, SIGALRM);
2445 child_read (GIOChannel *io, GIOCondition cond, gpointer user_data)
2447 WaitForChildData *data = user_data;
2449 gsize nread, nwrote, total;
2451 FILE *echo_file = NULL;
2453 status = g_io_channel_read_chars (io, buf, sizeof (buf), &nread, NULL);
2454 if (status == G_IO_STATUS_ERROR || status == G_IO_STATUS_EOF)
2456 // FIXME data->error = (status == G_IO_STATUS_ERROR);
2457 if (io == data->stdout_io)
2458 g_clear_pointer (&data->stdout_io, g_io_channel_unref);
2460 g_clear_pointer (&data->stderr_io, g_io_channel_unref);
2462 check_complete (data);
2465 else if (status == G_IO_STATUS_AGAIN)
2468 if (io == data->stdout_io)
2470 g_string_append_len (data->stdout_str, buf, nread);
2471 if (data->echo_stdout)
2476 g_string_append_len (data->stderr_str, buf, nread);
2477 if (data->echo_stderr)
2483 for (total = 0; total < nread; total += nwrote)
2485 nwrote = fwrite (buf + total, 1, nread - total, echo_file);
2487 g_error ("write failed: %s", g_strerror (errno));
2495 wait_for_child (GPid pid,
2496 int stdout_fd, gboolean echo_stdout,
2497 int stderr_fd, gboolean echo_stderr,
2500 WaitForChildData data;
2501 GMainContext *context;
2505 data.child_status = -1;
2507 context = g_main_context_new ();
2508 data.loop = g_main_loop_new (context, FALSE);
2510 source = g_child_watch_source_new (pid);
2511 g_source_set_callback (source, (GSourceFunc) child_exited, &data, NULL);
2512 g_source_attach (source, context);
2513 g_source_unref (source);
2515 data.echo_stdout = echo_stdout;
2516 data.stdout_str = g_string_new (NULL);
2517 data.stdout_io = g_io_channel_unix_new (stdout_fd);
2518 g_io_channel_set_close_on_unref (data.stdout_io, TRUE);
2519 g_io_channel_set_encoding (data.stdout_io, NULL, NULL);
2520 g_io_channel_set_buffered (data.stdout_io, FALSE);
2521 source = g_io_create_watch (data.stdout_io, G_IO_IN | G_IO_ERR | G_IO_HUP);
2522 g_source_set_callback (source, (GSourceFunc) child_read, &data, NULL);
2523 g_source_attach (source, context);
2524 g_source_unref (source);
2526 data.echo_stderr = echo_stderr;
2527 data.stderr_str = g_string_new (NULL);
2528 data.stderr_io = g_io_channel_unix_new (stderr_fd);
2529 g_io_channel_set_close_on_unref (data.stderr_io, TRUE);
2530 g_io_channel_set_encoding (data.stderr_io, NULL, NULL);
2531 g_io_channel_set_buffered (data.stderr_io, FALSE);
2532 source = g_io_create_watch (data.stderr_io, G_IO_IN | G_IO_ERR | G_IO_HUP);
2533 g_source_set_callback (source, (GSourceFunc) child_read, &data, NULL);
2534 g_source_attach (source, context);
2535 g_source_unref (source);
2539 source = g_timeout_source_new (0);
2540 g_source_set_ready_time (source, g_get_monotonic_time () + timeout);
2541 g_source_set_callback (source, (GSourceFunc) child_timeout, &data, NULL);
2542 g_source_attach (source, context);
2543 g_source_unref (source);
2546 g_main_loop_run (data.loop);
2547 g_main_loop_unref (data.loop);
2548 g_main_context_unref (context);
2550 test_trap_last_pid = pid;
2551 test_trap_last_status = data.child_status;
2552 test_trap_last_stdout = g_string_free (data.stdout_str, FALSE);
2553 test_trap_last_stderr = g_string_free (data.stderr_str, FALSE);
2555 g_clear_pointer (&data.stdout_io, g_io_channel_unref);
2556 g_clear_pointer (&data.stderr_io, g_io_channel_unref);
2561 * @usec_timeout: Timeout for the forked test in micro seconds.
2562 * @test_trap_flags: Flags to modify forking behaviour.
2564 * Fork the current test program to execute a test case that might
2565 * not return or that might abort.
2567 * If @usec_timeout is non-0, the forked test case is aborted and
2568 * considered failing if its run time exceeds it.
2570 * The forking behavior can be configured with the #GTestTrapFlags flags.
2572 * In the following example, the test code forks, the forked child
2573 * process produces some sample output and exits successfully.
2574 * The forking parent process then asserts successful child program
2575 * termination and validates child program outputs.
2579 * test_fork_patterns (void)
2581 * if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
2583 * g_print ("some stdout text: somagic17\n");
2584 * g_printerr ("some stderr text: semagic43\n");
2585 * exit (0); /* successful test run */
2587 * g_test_trap_assert_passed ();
2588 * g_test_trap_assert_stdout ("*somagic17*");
2589 * g_test_trap_assert_stderr ("*semagic43*");
2593 * Returns: %TRUE for the forked child and %FALSE for the executing parent process.
2597 * Deprecated: This function is implemented only on Unix platforms,
2598 * and is not always reliable due to problems inherent in
2599 * fork-without-exec. Use g_test_trap_subprocess() instead.
2602 g_test_trap_fork (guint64 usec_timeout,
2603 GTestTrapFlags test_trap_flags)
2606 int stdout_pipe[2] = { -1, -1 };
2607 int stderr_pipe[2] = { -1, -1 };
2610 if (pipe (stdout_pipe) < 0 || pipe (stderr_pipe) < 0)
2611 g_error ("failed to create pipes to fork test program: %s", g_strerror (errno));
2612 test_trap_last_pid = fork ();
2613 if (test_trap_last_pid < 0)
2614 g_error ("failed to fork test program: %s", g_strerror (errno));
2615 if (test_trap_last_pid == 0) /* child */
2618 close (stdout_pipe[0]);
2619 close (stderr_pipe[0]);
2620 if (!(test_trap_flags & G_TEST_TRAP_INHERIT_STDIN))
2621 fd0 = g_open ("/dev/null", O_RDONLY, 0);
2622 if (sane_dup2 (stdout_pipe[1], 1) < 0 || sane_dup2 (stderr_pipe[1], 2) < 0 || (fd0 >= 0 && sane_dup2 (fd0, 0) < 0))
2623 g_error ("failed to dup2() in forked test program: %s", g_strerror (errno));
2626 if (stdout_pipe[1] >= 3)
2627 close (stdout_pipe[1]);
2628 if (stderr_pipe[1] >= 3)
2629 close (stderr_pipe[1]);
2635 close (stdout_pipe[1]);
2636 close (stderr_pipe[1]);
2638 wait_for_child (test_trap_last_pid,
2639 stdout_pipe[0], !(test_trap_flags & G_TEST_TRAP_SILENCE_STDOUT),
2640 stderr_pipe[0], !(test_trap_flags & G_TEST_TRAP_SILENCE_STDERR),
2645 g_message ("Not implemented: g_test_trap_fork");
2652 * g_test_trap_subprocess:
2653 * @test_path: Test to run in a subprocess
2654 * @usec_timeout: Timeout for the subprocess test in micro seconds.
2655 * @test_flags: Flags to modify subprocess behaviour.
2657 * Respawns the test program to run only @test_path in a subprocess.
2658 * This can be used for a test case that might not return, or that
2659 * might abort. @test_path will normally be the name of the parent
2660 * test, followed by "<literal>/subprocess/</literal>" and then a name
2661 * for the specific subtest (or just ending with
2662 * "<literal>/subprocess</literal>" if the test only has one child
2663 * test); tests with names of this form will automatically be skipped
2664 * in the parent process.
2666 * If @usec_timeout is non-0, the test subprocess is aborted and
2667 * considered failing if its run time exceeds it.
2669 * The subprocess behavior can be configured with the
2670 * #GTestSubprocessFlags flags.
2672 * You can use methods such as g_test_trap_assert_passed(),
2673 * g_test_trap_assert_failed(), and g_test_trap_assert_stderr() to
2674 * check the results of the subprocess. (But note that
2675 * g_test_trap_assert_stdout() and g_test_trap_assert_stderr()
2676 * cannot be used if @test_flags specifies that the child should
2677 * inherit the parent stdout/stderr.)
2679 * If your <literal>main ()</literal> needs to behave differently in
2680 * the subprocess, you can call g_test_subprocess() (after calling
2681 * g_test_init()) to see whether you are in a subprocess.
2683 * The following example tests that calling
2684 * <literal>my_object_new(1000000)</literal> will abort with an error
2689 * test_create_large_object_subprocess (void)
2691 * my_object_new (1000000);
2695 * test_create_large_object (void)
2697 * g_test_trap_subprocess ("/myobject/create_large_object/subprocess", 0, 0);
2698 * g_test_trap_assert_failed ();
2699 * g_test_trap_assert_stderr ("*ERROR*too large*");
2703 * main (int argc, char **argv)
2705 * g_test_init (&argc, &argv, NULL);
2707 * g_test_add_func ("/myobject/create_large_object",
2708 * test_create_large_object);
2709 * /* Because of the '/subprocess' in the name, this test will
2710 * * not be run by the g_test_run () call below.
2712 * g_test_add_func ("/myobject/create_large_object/subprocess",
2713 * test_create_large_object_subprocess);
2715 * return g_test_run ();
2722 g_test_trap_subprocess (const char *test_path,
2723 guint64 usec_timeout,
2724 GTestSubprocessFlags test_flags)
2726 GError *error = NULL;
2729 int stdout_fd, stderr_fd;
2732 /* Sanity check that they used GTestSubprocessFlags, not GTestTrapFlags */
2733 g_assert ((test_flags & (G_TEST_TRAP_INHERIT_STDIN | G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR)) == 0);
2735 if (!g_test_suite_case_exists (g_test_get_root (), test_path))
2736 g_error ("g_test_trap_subprocess: test does not exist: %s", test_path);
2738 if (g_test_verbose ())
2739 g_print ("GTest: subprocess: %s\n", test_path);
2742 test_trap_last_subprocess = g_strdup (test_path);
2744 argv = g_ptr_array_new ();
2745 g_ptr_array_add (argv, test_argv0);
2746 g_ptr_array_add (argv, "-q");
2747 g_ptr_array_add (argv, "-p");
2748 g_ptr_array_add (argv, (char *)test_path);
2749 g_ptr_array_add (argv, "--GTestSubprocess");
2750 if (test_log_fd != -1)
2752 char log_fd_buf[128];
2754 g_ptr_array_add (argv, "--GTestLogFD");
2755 g_snprintf (log_fd_buf, sizeof (log_fd_buf), "%d", test_log_fd);
2756 g_ptr_array_add (argv, log_fd_buf);
2758 g_ptr_array_add (argv, NULL);
2760 flags = G_SPAWN_DO_NOT_REAP_CHILD;
2761 if (test_flags & G_TEST_TRAP_INHERIT_STDIN)
2762 flags |= G_SPAWN_CHILD_INHERITS_STDIN;
2764 if (!g_spawn_async_with_pipes (test_initial_cwd,
2765 (char **)argv->pdata,
2768 &pid, NULL, &stdout_fd, &stderr_fd,
2771 g_error ("g_test_trap_subprocess() failed: %s\n",
2774 g_ptr_array_free (argv, TRUE);
2776 wait_for_child (pid,
2777 stdout_fd, !!(test_flags & G_TEST_SUBPROCESS_INHERIT_STDOUT),
2778 stderr_fd, !!(test_flags & G_TEST_SUBPROCESS_INHERIT_STDERR),
2783 * g_test_subprocess:
2785 * Returns %TRUE (after g_test_init() has been called) if the test
2786 * program is running under g_test_trap_subprocess().
2788 * Returns: %TRUE if the test program is running under
2789 * g_test_trap_subprocess().
2794 g_test_subprocess (void)
2796 return test_in_subprocess;
2800 * g_test_trap_has_passed:
2802 * Check the result of the last g_test_trap_subprocess() call.
2804 * Returns: %TRUE if the last test subprocess terminated successfully.
2809 g_test_trap_has_passed (void)
2811 return test_trap_last_status == 0; /* exit_status == 0 && !signal && !coredump */
2815 * g_test_trap_reached_timeout:
2817 * Check the result of the last g_test_trap_subprocess() call.
2819 * Returns: %TRUE if the last test subprocess got killed due to a timeout.
2824 g_test_trap_reached_timeout (void)
2826 return test_trap_last_status != G_TEST_STATUS_TIMED_OUT;
2830 g_test_trap_assertions (const char *domain,
2834 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
2835 const char *pattern)
2837 gboolean must_pass = assertion_flags == 0;
2838 gboolean must_fail = assertion_flags == 1;
2839 gboolean match_result = 0 == (assertion_flags & 1);
2840 const char *stdout_pattern = (assertion_flags & 2) ? pattern : NULL;
2841 const char *stderr_pattern = (assertion_flags & 4) ? pattern : NULL;
2842 const char *match_error = match_result ? "failed to match" : "contains invalid match";
2846 if (test_trap_last_subprocess != NULL)
2848 process_id = g_strdup_printf ("%s [%d]", test_trap_last_subprocess,
2849 test_trap_last_pid);
2851 else if (test_trap_last_pid != 0)
2852 process_id = g_strdup_printf ("%d", test_trap_last_pid);
2854 if (test_trap_last_subprocess != NULL)
2855 process_id = g_strdup (test_trap_last_subprocess);
2858 g_error ("g_test_trap_ assertion with no trapped test");
2860 if (must_pass && !g_test_trap_has_passed())
2862 char *msg = g_strdup_printf ("child process (%s) failed unexpectedly", process_id);
2863 g_assertion_message (domain, file, line, func, msg);
2866 if (must_fail && g_test_trap_has_passed())
2868 char *msg = g_strdup_printf ("child process (%s) did not fail as expected", process_id);
2869 g_assertion_message (domain, file, line, func, msg);
2872 if (stdout_pattern && match_result == !g_pattern_match_simple (stdout_pattern, test_trap_last_stdout))
2874 char *msg = g_strdup_printf ("stdout of child process (%s) %s: %s", process_id, match_error, stdout_pattern);
2875 g_assertion_message (domain, file, line, func, msg);
2878 if (stderr_pattern && match_result == !g_pattern_match_simple (stderr_pattern, test_trap_last_stderr))
2880 char *msg = g_strdup_printf ("stderr of child process (%s) %s: %s", process_id, match_error, stderr_pattern);
2881 g_assertion_message (domain, file, line, func, msg);
2884 g_free (process_id);
2888 gstring_overwrite_int (GString *gstring,
2892 vuint = g_htonl (vuint);
2893 g_string_overwrite_len (gstring, pos, (const gchar*) &vuint, 4);
2897 gstring_append_int (GString *gstring,
2900 vuint = g_htonl (vuint);
2901 g_string_append_len (gstring, (const gchar*) &vuint, 4);
2905 gstring_append_double (GString *gstring,
2908 union { double vdouble; guint64 vuint64; } u;
2909 u.vdouble = vdouble;
2910 u.vuint64 = GUINT64_TO_BE (u.vuint64);
2911 g_string_append_len (gstring, (const gchar*) &u.vuint64, 8);
2915 g_test_log_dump (GTestLogMsg *msg,
2918 GString *gstring = g_string_sized_new (1024);
2920 gstring_append_int (gstring, 0); /* message length */
2921 gstring_append_int (gstring, msg->log_type);
2922 gstring_append_int (gstring, msg->n_strings);
2923 gstring_append_int (gstring, msg->n_nums);
2924 gstring_append_int (gstring, 0); /* reserved */
2925 for (ui = 0; ui < msg->n_strings; ui++)
2927 guint l = strlen (msg->strings[ui]);
2928 gstring_append_int (gstring, l);
2929 g_string_append_len (gstring, msg->strings[ui], l);
2931 for (ui = 0; ui < msg->n_nums; ui++)
2932 gstring_append_double (gstring, msg->nums[ui]);
2933 *len = gstring->len;
2934 gstring_overwrite_int (gstring, 0, *len); /* message length */
2935 return (guint8*) g_string_free (gstring, FALSE);
2938 static inline long double
2939 net_double (const gchar **ipointer)
2941 union { guint64 vuint64; double vdouble; } u;
2942 guint64 aligned_int64;
2943 memcpy (&aligned_int64, *ipointer, 8);
2945 u.vuint64 = GUINT64_FROM_BE (aligned_int64);
2949 static inline guint32
2950 net_int (const gchar **ipointer)
2952 guint32 aligned_int;
2953 memcpy (&aligned_int, *ipointer, 4);
2955 return g_ntohl (aligned_int);
2959 g_test_log_extract (GTestLogBuffer *tbuffer)
2961 const gchar *p = tbuffer->data->str;
2964 if (tbuffer->data->len < 4 * 5)
2966 mlength = net_int (&p);
2967 if (tbuffer->data->len < mlength)
2969 msg.log_type = net_int (&p);
2970 msg.n_strings = net_int (&p);
2971 msg.n_nums = net_int (&p);
2972 if (net_int (&p) == 0)
2975 msg.strings = g_new0 (gchar*, msg.n_strings + 1);
2976 msg.nums = g_new0 (long double, msg.n_nums);
2977 for (ui = 0; ui < msg.n_strings; ui++)
2979 guint sl = net_int (&p);
2980 msg.strings[ui] = g_strndup (p, sl);
2983 for (ui = 0; ui < msg.n_nums; ui++)
2984 msg.nums[ui] = net_double (&p);
2985 if (p <= tbuffer->data->str + mlength)
2987 g_string_erase (tbuffer->data, 0, mlength);
2988 tbuffer->msgs = g_slist_prepend (tbuffer->msgs, g_memdup (&msg, sizeof (msg)));
2993 g_strfreev (msg.strings);
2994 g_error ("corrupt log stream from test program");
2999 * g_test_log_buffer_new:
3001 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
3004 g_test_log_buffer_new (void)
3006 GTestLogBuffer *tb = g_new0 (GTestLogBuffer, 1);
3007 tb->data = g_string_sized_new (1024);
3012 * g_test_log_buffer_free:
3014 * Internal function for gtester to free test log messages, no ABI guarantees provided.
3017 g_test_log_buffer_free (GTestLogBuffer *tbuffer)
3019 g_return_if_fail (tbuffer != NULL);
3020 while (tbuffer->msgs)
3021 g_test_log_msg_free (g_test_log_buffer_pop (tbuffer));
3022 g_string_free (tbuffer->data, TRUE);
3027 * g_test_log_buffer_push:
3029 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
3032 g_test_log_buffer_push (GTestLogBuffer *tbuffer,
3034 const guint8 *bytes)
3036 g_return_if_fail (tbuffer != NULL);
3039 gboolean more_messages;
3040 g_return_if_fail (bytes != NULL);
3041 g_string_append_len (tbuffer->data, (const gchar*) bytes, n_bytes);
3043 more_messages = g_test_log_extract (tbuffer);
3044 while (more_messages);
3049 * g_test_log_buffer_pop:
3051 * Internal function for gtester to retrieve test log messages, no ABI guarantees provided.
3054 g_test_log_buffer_pop (GTestLogBuffer *tbuffer)
3056 GTestLogMsg *msg = NULL;
3057 g_return_val_if_fail (tbuffer != NULL, NULL);
3060 GSList *slist = g_slist_last (tbuffer->msgs);
3062 tbuffer->msgs = g_slist_delete_link (tbuffer->msgs, slist);
3068 * g_test_log_msg_free:
3070 * Internal function for gtester to free test log messages, no ABI guarantees provided.
3073 g_test_log_msg_free (GTestLogMsg *tmsg)
3075 g_return_if_fail (tmsg != NULL);
3076 g_strfreev (tmsg->strings);
3077 g_free (tmsg->nums);
3082 g_test_build_filename_va (GTestFileType file_type,
3083 const gchar *first_path,
3086 const gchar *pathv[16];
3087 gint num_path_segments;
3089 if (file_type == G_TEST_DIST)
3090 pathv[0] = test_disted_files_dir;
3091 else if (file_type == G_TEST_BUILT)
3092 pathv[0] = test_built_files_dir;
3094 g_assert_not_reached ();
3096 pathv[1] = first_path;
3098 for (num_path_segments = 2; num_path_segments < G_N_ELEMENTS (pathv); num_path_segments++)
3100 pathv[num_path_segments] = va_arg (ap, const char *);
3101 if (pathv[num_path_segments] == NULL)
3105 g_assert_cmpint (num_path_segments, <, G_N_ELEMENTS (pathv));
3107 return g_build_filenamev ((gchar **) pathv);
3111 * g_test_build_filename:
3112 * @file_type: the type of file (built vs. distributed)
3113 * @first_path: the first segment of the pathname
3114 * @...: %NULL-terminated additional path segments
3116 * Creates the pathname to a data file that is required for a test.
3118 * This function is conceptually similar to g_build_filename() except
3119 * that the first argument has been replaced with a #GTestFileType
3122 * The data file should either have been distributed with the module
3123 * containing the test (%G_TEST_DIST) or built as part of the build
3124 * system of that module (%G_TEST_BUILT).
3126 * In order for this function to work in srcdir != builddir situations,
3127 * the G_TEST_SRCDIR and G_TEST_BUILDDIR environment variables need to
3128 * have been defined. As of 2.38, this is done by the Makefile.decl
3129 * included in GLib. Please ensure that your copy is up to date before
3130 * using this function.
3132 * In case neither variable is set, this function will fall back to
3133 * using the dirname portion of argv[0], possibly removing ".libs".
3134 * This allows for casual running of tests directly from the commandline
3135 * in the srcdir == builddir case and should also support running of
3136 * installed tests, assuming the data files have been installed in the
3137 * same relative path as the test binary.
3139 * Returns: the path of the file, to be freed using g_free()
3145 * @G_TEST_DIST: a file that was included in the distribution tarball
3146 * @G_TEST_BUILT: a file that was built on the compiling machine
3148 * The type of file to return the filename for, when used with
3149 * g_test_build_filename().
3151 * These two options correspond rather directly to the 'dist' and
3152 * 'built' terminology that automake uses and are explicitly used to
3153 * distinguish between the 'srcdir' and 'builddir' being separate. All
3154 * files in your project should either be dist (in the
3155 * <literal>DIST_EXTRA</literal> or <literal>dist_schema_DATA</literal>
3156 * sense, in which case they will always be in the srcdir) or built (in
3157 * the <literal>BUILT_SOURCES</literal> sense, in which case they will
3158 * always be in the builddir).
3160 * Note: as a general rule of automake, files that are generated only as
3161 * part of the build-from-git process (but then are distributed with the
3162 * tarball) always go in srcdir (even if doing a srcdir != builddir
3163 * build from git) and are considered as distributed files.
3168 g_test_build_filename (GTestFileType file_type,
3169 const gchar *first_path,
3175 g_assert (g_test_initialized ());
3177 va_start (ap, first_path);
3178 result = g_test_build_filename_va (file_type, first_path, ap);
3186 * @file_type: the type of file (built vs. distributed)
3188 * Gets the pathname of the directory containing test files of the type
3189 * specified by @file_type.
3191 * This is approximately the same as calling g_test_build_filename("."),
3192 * but you don't need to free the return value.
3194 * Returns: the path of the directory, owned by GLib
3199 g_test_get_dir (GTestFileType file_type)
3201 g_assert (g_test_initialized ());
3203 if (file_type == G_TEST_DIST)
3204 return test_disted_files_dir;
3205 else if (file_type == G_TEST_BUILT)
3206 return test_built_files_dir;
3208 g_assert_not_reached ();
3212 * g_test_get_filename:
3213 * @file_type: the type of file (built vs. distributed)
3214 * @first_path: the first segment of the pathname
3215 * @...: %NULL-terminated additional path segments
3217 * Gets the pathname to a data file that is required for a test.
3219 * This is the same as g_test_build_filename() with two differences.
3220 * The first difference is that must only use this function from within
3221 * a testcase function. The second difference is that you need not free
3222 * the return value -- it will be automatically freed when the testcase
3225 * It is safe to use this function from a thread inside of a testcase
3226 * but you must ensure that all such uses occur before the main testcase
3227 * function returns (ie: it is best to ensure that all threads have been
3230 * Returns: the path, automatically freed at the end of the testcase
3235 g_test_get_filename (GTestFileType file_type,
3236 const gchar *first_path,
3243 g_assert (g_test_initialized ());
3244 if (test_filename_free_list == NULL)
3245 g_error ("g_test_get_filename() can only be used within testcase functions");
3247 va_start (ap, first_path);
3248 result = g_test_build_filename_va (file_type, first_path, ap);
3251 node = g_slist_prepend (NULL, result);
3253 node->next = *test_filename_free_list;
3254 while (!g_atomic_pointer_compare_and_exchange (test_filename_free_list, node->next, node));
3259 /* --- macros docs START --- */
3262 * @testpath: The test path for a new test case.
3263 * @Fixture: The type of a fixture data structure.
3264 * @tdata: Data argument for the test functions.
3265 * @fsetup: The function to set up the fixture data.
3266 * @ftest: The actual test function.
3267 * @fteardown: The function to tear down the fixture data.
3269 * Hook up a new test case at @testpath, similar to g_test_add_func().
3270 * A fixture data structure with setup and teardown function may be provided
3271 * though, similar to g_test_create_case().
3272 * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
3273 * fteardown() callbacks can expect a @Fixture pointer as first argument in
3274 * a type safe manner.
3278 /* --- macros docs END --- */