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 * @s1: a string (may be %NULL)
354 * @cmp: The comparison operator to use.
355 * One of ==, !=, <, >, <=, >=.
356 * @s2: another string (may be %NULL)
358 * Debugging macro to terminate the application with a warning
359 * message if a string comparison fails. The strings are compared
362 * The effect of <literal>g_assert_cmpstr (s1, op, s2)</literal> is
363 * the same as <literal>g_assert (g_strcmp0 (s1, s2) op 0)</literal>.
364 * The advantage of this macro is that it can produce a message that
365 * includes the actual values of @s1 and @s2.
368 * g_assert_cmpstr (mystring, ==, "fubar");
377 * @cmp: The comparison operator to use.
378 * One of ==, !=, <, >, <=, >=.
379 * @n2: another integer
381 * Debugging macro to terminate the application with a warning
382 * message if an integer comparison fails.
384 * The effect of <literal>g_assert_cmpint (n1, op, n2)</literal> is
385 * the same as <literal>g_assert (n1 op n2)</literal>. The advantage
386 * of this macro is that it can produce a message that includes the
387 * actual values of @n1 and @n2.
394 * @n1: an unsigned integer
395 * @cmp: The comparison operator to use.
396 * One of ==, !=, <, >, <=, >=.
397 * @n2: another unsigned integer
399 * Debugging macro to terminate the application with a warning
400 * message if an unsigned integer comparison fails.
402 * The effect of <literal>g_assert_cmpuint (n1, op, n2)</literal> is
403 * the same as <literal>g_assert (n1 op n2)</literal>. The advantage
404 * of this macro is that it can produce a message that includes the
405 * actual values of @n1 and @n2.
412 * @n1: an unsigned integer
413 * @cmp: The comparison operator to use.
414 * One of ==, !=, <, >, <=, >=.
415 * @n2: another unsigned integer
417 * Debugging macro to terminate the application with a warning
418 * message if an unsigned integer comparison fails.
420 * This is a variant of g_assert_cmpuint() that displays the numbers
421 * in hexadecimal notation in the message.
428 * @n1: an floating point number
429 * @cmp: The comparison operator to use.
430 * One of ==, !=, <, >, <=, >=.
431 * @n2: another floating point number
433 * Debugging macro to terminate the application with a warning
434 * message if a floating point number comparison fails.
436 * The effect of <literal>g_assert_cmpfloat (n1, op, n2)</literal> is
437 * the same as <literal>g_assert (n1 op n2)</literal>. The advantage
438 * of this macro is that it can produce a message that includes the
439 * actual values of @n1 and @n2.
446 * @err: a #GError, possibly %NULL
448 * Debugging macro to terminate the application with a warning
449 * message if a method has returned a #GError.
451 * The effect of <literal>g_assert_no_error (err)</literal> is
452 * the same as <literal>g_assert (err == NULL)</literal>. The advantage
453 * of this macro is that it can produce a message that includes
454 * the error message and code.
461 * @err: a #GError, possibly %NULL
462 * @dom: the expected error domain (a #GQuark)
463 * @c: the expected error code
465 * Debugging macro to terminate the application with a warning
466 * message if a method has not returned the correct #GError.
468 * The effect of <literal>g_assert_error (err, dom, c)</literal> is
469 * the same as <literal>g_assert (err != NULL && err->domain
470 * == dom && err->code == c)</literal>. The advantage of this
471 * macro is that it can produce a message that includes the incorrect
472 * error message and code.
474 * This can only be used to test for a specific error. If you want to
475 * test that @err is set, but don't care what it's set to, just use
476 * <literal>g_assert (err != NULL)</literal>
484 * An opaque structure representing a test case.
490 * An opaque structure representing a test suite.
494 /* Global variable for storing assertion messages; this is the counterpart to
495 * glibc's (private) __abort_msg variable, and allows developers and crash
496 * analysis systems like Apport and ABRT to fish out assertion messages from
497 * core dumps, instead of having to catch them on screen output.
499 GLIB_VAR char *__glib_assert_msg;
500 char *__glib_assert_msg = NULL;
502 /* --- constants --- */
503 #define G_TEST_STATUS_TIMED_OUT 1024
505 /* --- structures --- */
510 void (*fixture_setup) (void*, gconstpointer);
511 void (*fixture_test) (void*, gconstpointer);
512 void (*fixture_teardown) (void*, gconstpointer);
521 typedef struct DestroyEntry DestroyEntry;
525 GDestroyNotify destroy_func;
526 gpointer destroy_data;
529 /* --- prototypes --- */
530 static void test_run_seed (const gchar *rseed);
531 static void test_trap_clear (void);
532 static guint8* g_test_log_dump (GTestLogMsg *msg,
534 static void gtest_default_log_handler (const gchar *log_domain,
535 GLogLevelFlags log_level,
536 const gchar *message,
537 gpointer unused_data);
544 G_TEST_RUN_INCOMPLETE
547 /* --- variables --- */
548 static int test_log_fd = -1;
549 static gboolean test_mode_fatal = TRUE;
550 static gboolean g_test_run_once = TRUE;
551 static gboolean test_run_list = FALSE;
552 static gchar *test_run_seedstr = NULL;
553 static GRand *test_run_rand = NULL;
554 static gchar *test_run_name = "";
555 static GSList **test_filename_free_list;
556 static guint test_run_forks = 0;
557 static guint test_run_count = 0;
558 static GTestResult test_run_success = G_TEST_RUN_FAILURE;
559 static gchar *test_run_msg = NULL;
560 static guint test_skip_count = 0;
561 static GTimer *test_user_timer = NULL;
562 static double test_user_stamp = 0;
563 static GSList *test_paths = NULL;
564 static GSList *test_paths_skipped = NULL;
565 static GTestSuite *test_suite_root = NULL;
566 static int test_trap_last_status = 0;
567 static GPid test_trap_last_pid = 0;
568 static char *test_trap_last_subprocess = NULL;
569 static char *test_trap_last_stdout = NULL;
570 static char *test_trap_last_stderr = NULL;
571 static char *test_uri_base = NULL;
572 static gboolean test_debug_log = FALSE;
573 static gboolean test_tap_log = FALSE;
574 static DestroyEntry *test_destroy_queue = NULL;
575 static char *test_argv0 = NULL;
576 static char *test_argv0_dirname;
577 static const char *test_disted_files_dir;
578 static const char *test_built_files_dir;
579 static char *test_initial_cwd = NULL;
580 static gboolean test_in_subprocess = FALSE;
581 static GTestConfig mutable_test_config_vars = {
582 FALSE, /* test_initialized */
583 TRUE, /* test_quick */
584 FALSE, /* test_perf */
585 FALSE, /* test_verbose */
586 FALSE, /* test_quiet */
587 TRUE, /* test_undefined */
589 const GTestConfig * const g_test_config_vars = &mutable_test_config_vars;
591 /* --- functions --- */
593 g_test_log_type_name (GTestLogType log_type)
597 case G_TEST_LOG_NONE: return "none";
598 case G_TEST_LOG_ERROR: return "error";
599 case G_TEST_LOG_START_BINARY: return "binary";
600 case G_TEST_LOG_LIST_CASE: return "list";
601 case G_TEST_LOG_SKIP_CASE: return "skip";
602 case G_TEST_LOG_START_CASE: return "start";
603 case G_TEST_LOG_STOP_CASE: return "stop";
604 case G_TEST_LOG_MIN_RESULT: return "minperf";
605 case G_TEST_LOG_MAX_RESULT: return "maxperf";
606 case G_TEST_LOG_MESSAGE: return "message";
607 case G_TEST_LOG_START_SUITE: return "start suite";
608 case G_TEST_LOG_STOP_SUITE: return "stop suite";
614 g_test_log_send (guint n_bytes,
615 const guint8 *buffer)
617 if (test_log_fd >= 0)
621 r = write (test_log_fd, buffer, n_bytes);
622 while (r < 0 && errno == EINTR);
626 GTestLogBuffer *lbuffer = g_test_log_buffer_new ();
629 g_test_log_buffer_push (lbuffer, n_bytes, buffer);
630 msg = g_test_log_buffer_pop (lbuffer);
631 g_warn_if_fail (msg != NULL);
632 g_warn_if_fail (lbuffer->data->len == 0);
633 g_test_log_buffer_free (lbuffer);
635 g_printerr ("{*LOG(%s)", g_test_log_type_name (msg->log_type));
636 for (ui = 0; ui < msg->n_strings; ui++)
637 g_printerr (":{%s}", msg->strings[ui]);
641 for (ui = 0; ui < msg->n_nums; ui++)
643 if ((long double) (long) msg->nums[ui] == msg->nums[ui])
644 g_printerr ("%s%ld", ui ? ";" : "", (long) msg->nums[ui]);
646 g_printerr ("%s%.16g", ui ? ";" : "", (double) msg->nums[ui]);
650 g_printerr (":LOG*}\n");
651 g_test_log_msg_free (msg);
656 g_test_log (GTestLogType lbit,
657 const gchar *string1,
658 const gchar *string2,
664 gchar *astrings[3] = { NULL, NULL, NULL };
670 case G_TEST_LOG_START_BINARY:
672 g_print ("# random seed: %s\n", string2);
673 else if (g_test_verbose())
674 g_print ("GTest: random seed: %s\n", string2);
676 case G_TEST_LOG_START_SUITE:
680 g_print ("# Start of %s tests\n", string1);
683 case G_TEST_LOG_STOP_SUITE:
687 g_print ("# End of %s tests\n", string1);
689 g_print ("1..%d\n", test_run_count);
692 case G_TEST_LOG_STOP_CASE:
693 fail = largs[0] != G_TEST_RUN_SUCCESS && largs[0] != G_TEST_RUN_SKIPPED;
696 g_print ("%s %d %s", fail ? "not ok" : "ok", test_run_count, string1);
697 if (largs[0] == G_TEST_RUN_INCOMPLETE)
698 g_print (" # TODO %s\n", string2 ? string2 : "");
699 else if (largs[0] == G_TEST_RUN_SKIPPED)
700 g_print (" # SKIP %s\n", string2 ? string2 : "");
704 else if (g_test_verbose())
705 g_print ("GTest: result: %s\n", fail ? "FAIL" : "OK");
706 else if (!g_test_quiet())
707 g_print ("%s\n", fail ? "FAIL" : "OK");
708 if (fail && test_mode_fatal)
711 g_print ("Bail out!\n");
715 case G_TEST_LOG_MIN_RESULT:
717 g_print ("# min perf: %s\n", string1);
718 else if (g_test_verbose())
719 g_print ("(MINPERF:%s)\n", string1);
721 case G_TEST_LOG_MAX_RESULT:
723 g_print ("# max perf: %s\n", string1);
724 else if (g_test_verbose())
725 g_print ("(MAXPERF:%s)\n", string1);
727 case G_TEST_LOG_MESSAGE:
728 case G_TEST_LOG_ERROR:
730 g_print ("# %s\n", string1);
731 else if (g_test_verbose())
732 g_print ("(MSG: %s)\n", string1);
738 msg.n_strings = (string1 != NULL) + (string1 && string2);
739 msg.strings = astrings;
740 astrings[0] = (gchar*) string1;
741 astrings[1] = astrings[0] ? (gchar*) string2 : NULL;
744 dbuffer = g_test_log_dump (&msg, &dbufferlen);
745 g_test_log_send (dbufferlen, dbuffer);
750 case G_TEST_LOG_START_CASE:
753 else if (g_test_verbose())
754 g_print ("GTest: run: %s\n", string1);
755 else if (!g_test_quiet())
756 g_print ("%s: ", string1);
762 /* We intentionally parse the command line without GOptionContext
763 * because otherwise you would never be able to test it.
766 parse_args (gint *argc_p,
769 guint argc = *argc_p;
770 gchar **argv = *argv_p;
773 test_argv0 = argv[0];
774 test_initial_cwd = g_get_current_dir ();
776 /* parse known args */
777 for (i = 1; i < argc; i++)
779 if (strcmp (argv[i], "--g-fatal-warnings") == 0)
781 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
782 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
783 g_log_set_always_fatal (fatal_mask);
786 else if (strcmp (argv[i], "--keep-going") == 0 ||
787 strcmp (argv[i], "-k") == 0)
789 test_mode_fatal = FALSE;
792 else if (strcmp (argv[i], "--debug-log") == 0)
794 test_debug_log = TRUE;
797 else if (strcmp (argv[i], "--tap") == 0)
802 else if (strcmp ("--GTestLogFD", argv[i]) == 0 || strncmp ("--GTestLogFD=", argv[i], 13) == 0)
804 gchar *equal = argv[i] + 12;
806 test_log_fd = g_ascii_strtoull (equal + 1, NULL, 0);
807 else if (i + 1 < argc)
810 test_log_fd = g_ascii_strtoull (argv[i], NULL, 0);
814 else if (strcmp ("--GTestSkipCount", argv[i]) == 0 || strncmp ("--GTestSkipCount=", argv[i], 17) == 0)
816 gchar *equal = argv[i] + 16;
818 test_skip_count = g_ascii_strtoull (equal + 1, NULL, 0);
819 else if (i + 1 < argc)
822 test_skip_count = g_ascii_strtoull (argv[i], NULL, 0);
826 else if (strcmp ("--GTestSubprocess", argv[i]) == 0)
828 test_in_subprocess = TRUE;
829 /* We typically expect these child processes to crash, and some
830 * tests spawn a *lot* of them. Avoid spamming system crash
831 * collection programs such as systemd-coredump and abrt.
833 #ifdef HAVE_SYS_RESOURCE_H
835 struct rlimit limit = { 0, 0 };
836 (void) setrlimit (RLIMIT_CORE, &limit);
839 _g_log_set_exit_on_fatal ();
842 else if (strcmp ("-p", argv[i]) == 0 || strncmp ("-p=", argv[i], 3) == 0)
844 gchar *equal = argv[i] + 2;
846 test_paths = g_slist_prepend (test_paths, equal + 1);
847 else if (i + 1 < argc)
850 test_paths = g_slist_prepend (test_paths, argv[i]);
854 else if (strcmp ("-s", argv[i]) == 0 || strncmp ("-s=", argv[i], 3) == 0)
856 gchar *equal = argv[i] + 2;
858 test_paths_skipped = g_slist_prepend (test_paths_skipped, equal + 1);
859 else if (i + 1 < argc)
862 test_paths_skipped = g_slist_prepend (test_paths_skipped, argv[i]);
866 else if (strcmp ("-m", argv[i]) == 0 || strncmp ("-m=", argv[i], 3) == 0)
868 gchar *equal = argv[i] + 2;
869 const gchar *mode = "";
872 else if (i + 1 < argc)
877 if (strcmp (mode, "perf") == 0)
878 mutable_test_config_vars.test_perf = TRUE;
879 else if (strcmp (mode, "slow") == 0)
880 mutable_test_config_vars.test_quick = FALSE;
881 else if (strcmp (mode, "thorough") == 0)
882 mutable_test_config_vars.test_quick = FALSE;
883 else if (strcmp (mode, "quick") == 0)
885 mutable_test_config_vars.test_quick = TRUE;
886 mutable_test_config_vars.test_perf = FALSE;
888 else if (strcmp (mode, "undefined") == 0)
889 mutable_test_config_vars.test_undefined = TRUE;
890 else if (strcmp (mode, "no-undefined") == 0)
891 mutable_test_config_vars.test_undefined = FALSE;
893 g_error ("unknown test mode: -m %s", mode);
896 else if (strcmp ("-q", argv[i]) == 0 || strcmp ("--quiet", argv[i]) == 0)
898 mutable_test_config_vars.test_quiet = TRUE;
899 mutable_test_config_vars.test_verbose = FALSE;
902 else if (strcmp ("--verbose", argv[i]) == 0)
904 mutable_test_config_vars.test_quiet = FALSE;
905 mutable_test_config_vars.test_verbose = TRUE;
908 else if (strcmp ("-l", argv[i]) == 0)
910 test_run_list = TRUE;
913 else if (strcmp ("--seed", argv[i]) == 0 || strncmp ("--seed=", argv[i], 7) == 0)
915 gchar *equal = argv[i] + 6;
917 test_run_seedstr = equal + 1;
918 else if (i + 1 < argc)
921 test_run_seedstr = argv[i];
925 else if (strcmp ("-?", argv[i]) == 0 ||
926 strcmp ("-h", argv[i]) == 0 ||
927 strcmp ("--help", argv[i]) == 0)
930 " %s [OPTION...]\n\n"
932 " -h, --help Show help options\n\n"
934 " --g-fatal-warnings Make all warnings fatal\n"
935 " -l List test cases available in a test executable\n"
936 " -m {perf|slow|thorough|quick} Execute tests according to mode\n"
937 " -m {undefined|no-undefined} Execute tests according to mode\n"
938 " -p TESTPATH Only start test cases matching TESTPATH\n"
939 " -s TESTPATH Skip all tests matching TESTPATH\n"
940 " -seed=SEEDSTRING Start tests with random seed SEEDSTRING\n"
941 " --debug-log debug test logging output\n"
942 " -q, --quiet Run tests quietly\n"
943 " --verbose Run tests verbosely\n",
950 for (i = 1; i < argc; i++)
962 * @argc: Address of the @argc parameter of the main() function.
963 * Changed if any arguments were handled.
964 * @argv: Address of the @argv parameter of main().
965 * Any parameters understood by g_test_init() stripped before return.
966 * @...: Reserved for future extension. Currently, you must pass %NULL.
968 * Initialize the GLib testing framework, e.g. by seeding the
969 * test random number generator, the name for g_get_prgname()
970 * and parsing test related command line args.
971 * So far, the following arguments are understood:
974 * <term><option>-l</option></term>
976 * List test cases available in a test executable.
980 * <term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
982 * Provide a random seed to reproduce test runs using random numbers.
986 * <term><option>--verbose</option></term>
987 * <listitem><para>Run tests verbosely.</para></listitem>
990 * <term><option>-q</option>, <option>--quiet</option></term>
991 * <listitem><para>Run tests quietly.</para></listitem>
994 * <term><option>-p <replaceable>TESTPATH</replaceable></option></term>
996 * Execute all tests matching <replaceable>TESTPATH</replaceable>.
997 * This can also be used to force a test to run that would otherwise
998 * be skipped (ie, a test whose name contains "/subprocess").
1002 * <term><option>-m {perf|slow|thorough|quick|undefined|no-undefined}</option></term>
1004 * Execute tests according to these test modes:
1009 * Performance tests, may take long and report results.
1010 * </para></listitem>
1013 * <term>slow, thorough</term>
1015 * Slow and thorough tests, may take quite long and
1016 * maximize coverage.
1017 * </para></listitem>
1020 * <term>quick</term>
1022 * Quick tests, should run really quickly and give good coverage.
1023 * </para></listitem>
1026 * <term>undefined</term>
1028 * Tests for undefined behaviour, may provoke programming errors
1029 * under g_test_trap_subprocess() or g_test_expect_messages() to check
1030 * that appropriate assertions or warnings are given
1031 * </para></listitem>
1034 * <term>no-undefined</term>
1036 * Avoid tests for undefined behaviour
1037 * </para></listitem>
1040 * </para></listitem>
1043 * <term><option>--debug-log</option></term>
1044 * <listitem><para>Debug test logging output.</para></listitem>
1051 g_test_init (int *argc,
1055 static char seedstr[4 + 4 * 8 + 1];
1058 /* make warnings and criticals fatal for all test programs */
1059 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
1060 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
1061 g_log_set_always_fatal (fatal_mask);
1062 /* check caller args */
1063 g_return_if_fail (argc != NULL);
1064 g_return_if_fail (argv != NULL);
1065 g_return_if_fail (g_test_config_vars->test_initialized == FALSE);
1066 mutable_test_config_vars.test_initialized = TRUE;
1068 va_start (args, argv);
1069 vararg1 = va_arg (args, gpointer); /* reserved for future extensions */
1071 g_return_if_fail (vararg1 == NULL);
1073 /* setup random seed string */
1074 g_snprintf (seedstr, sizeof (seedstr), "R02S%08x%08x%08x%08x", g_random_int(), g_random_int(), g_random_int(), g_random_int());
1075 test_run_seedstr = seedstr;
1077 /* parse args, sets up mode, changes seed, etc. */
1078 parse_args (argc, argv);
1079 if (!g_get_prgname())
1080 g_set_prgname ((*argv)[0]);
1082 /* verify GRand reliability, needed for reliable seeds */
1085 GRand *rg = g_rand_new_with_seed (0xc8c49fb6);
1086 guint32 t1 = g_rand_int (rg), t2 = g_rand_int (rg), t3 = g_rand_int (rg), t4 = g_rand_int (rg);
1087 /* g_print ("GRand-current: 0x%x 0x%x 0x%x 0x%x\n", t1, t2, t3, t4); */
1088 if (t1 != 0xfab39f9b || t2 != 0xb948fb0e || t3 != 0x3d31be26 || t4 != 0x43a19d66)
1089 g_warning ("random numbers are not GRand-2.2 compatible, seeds may be broken (check $G_RANDOM_VERSION)");
1093 /* check rand seed */
1094 test_run_seed (test_run_seedstr);
1096 /* report program start */
1097 g_log_set_default_handler (gtest_default_log_handler, NULL);
1098 g_test_log (G_TEST_LOG_START_BINARY, g_get_prgname(), test_run_seedstr, 0, NULL);
1100 test_argv0_dirname = g_path_get_dirname (test_argv0);
1102 /* Make sure we get the real dirname that the test was run from */
1103 if (g_str_has_suffix (test_argv0_dirname, "/.libs"))
1106 tmp = g_path_get_dirname (test_argv0_dirname);
1107 g_free (test_argv0_dirname);
1108 test_argv0_dirname = tmp;
1111 test_disted_files_dir = g_getenv ("G_TEST_SRCDIR");
1112 if (!test_disted_files_dir)
1113 test_disted_files_dir = test_argv0_dirname;
1115 test_built_files_dir = g_getenv ("G_TEST_BUILDDIR");
1116 if (!test_built_files_dir)
1117 test_built_files_dir = test_argv0_dirname;
1121 test_run_seed (const gchar *rseed)
1123 guint seed_failed = 0;
1125 g_rand_free (test_run_rand);
1126 test_run_rand = NULL;
1127 while (strchr (" \t\v\r\n\f", *rseed))
1129 if (strncmp (rseed, "R02S", 4) == 0) /* seed for random generator 02 (GRand-2.2) */
1131 const char *s = rseed + 4;
1132 if (strlen (s) >= 32) /* require 4 * 8 chars */
1134 guint32 seedarray[4];
1135 gchar *p, hexbuf[9] = { 0, };
1136 memcpy (hexbuf, s + 0, 8);
1137 seedarray[0] = g_ascii_strtoull (hexbuf, &p, 16);
1138 seed_failed += p != NULL && *p != 0;
1139 memcpy (hexbuf, s + 8, 8);
1140 seedarray[1] = g_ascii_strtoull (hexbuf, &p, 16);
1141 seed_failed += p != NULL && *p != 0;
1142 memcpy (hexbuf, s + 16, 8);
1143 seedarray[2] = g_ascii_strtoull (hexbuf, &p, 16);
1144 seed_failed += p != NULL && *p != 0;
1145 memcpy (hexbuf, s + 24, 8);
1146 seedarray[3] = g_ascii_strtoull (hexbuf, &p, 16);
1147 seed_failed += p != NULL && *p != 0;
1150 test_run_rand = g_rand_new_with_seed_array (seedarray, 4);
1155 g_error ("Unknown or invalid random seed: %s", rseed);
1161 * Get a reproducible random integer number.
1163 * The random numbers generated by the g_test_rand_*() family of functions
1164 * change with every new test program start, unless the --seed option is
1165 * given when starting test programs.
1167 * For individual test cases however, the random number generator is
1168 * reseeded, to avoid dependencies between tests and to make --seed
1169 * effective for all test cases.
1171 * Returns: a random number from the seeded random number generator.
1176 g_test_rand_int (void)
1178 return g_rand_int (test_run_rand);
1182 * g_test_rand_int_range:
1183 * @begin: the minimum value returned by this function
1184 * @end: the smallest value not to be returned by this function
1186 * Get a reproducible random integer number out of a specified range,
1187 * see g_test_rand_int() for details on test case random numbers.
1189 * Returns: a number with @begin <= number < @end.
1194 g_test_rand_int_range (gint32 begin,
1197 return g_rand_int_range (test_run_rand, begin, end);
1201 * g_test_rand_double:
1203 * Get a reproducible random floating point number,
1204 * see g_test_rand_int() for details on test case random numbers.
1206 * Returns: a random number from the seeded random number generator.
1211 g_test_rand_double (void)
1213 return g_rand_double (test_run_rand);
1217 * g_test_rand_double_range:
1218 * @range_start: the minimum value returned by this function
1219 * @range_end: the minimum value not returned by this function
1221 * Get a reproducible random floating pointer number out of a specified range,
1222 * see g_test_rand_int() for details on test case random numbers.
1224 * Returns: a number with @range_start <= number < @range_end.
1229 g_test_rand_double_range (double range_start,
1232 return g_rand_double_range (test_run_rand, range_start, range_end);
1236 * g_test_timer_start:
1238 * Start a timing test. Call g_test_timer_elapsed() when the task is supposed
1239 * to be done. Call this function again to restart the timer.
1244 g_test_timer_start (void)
1246 if (!test_user_timer)
1247 test_user_timer = g_timer_new();
1248 test_user_stamp = 0;
1249 g_timer_start (test_user_timer);
1253 * g_test_timer_elapsed:
1255 * Get the time since the last start of the timer with g_test_timer_start().
1257 * Returns: the time since the last start of the timer, as a double
1262 g_test_timer_elapsed (void)
1264 test_user_stamp = test_user_timer ? g_timer_elapsed (test_user_timer, NULL) : 0;
1265 return test_user_stamp;
1269 * g_test_timer_last:
1271 * Report the last result of g_test_timer_elapsed().
1273 * Returns: the last result of g_test_timer_elapsed(), as a double
1278 g_test_timer_last (void)
1280 return test_user_stamp;
1284 * g_test_minimized_result:
1285 * @minimized_quantity: the reported value
1286 * @format: the format string of the report message
1287 * @...: arguments to pass to the printf() function
1289 * Report the result of a performance or measurement test.
1290 * The test should generally strive to minimize the reported
1291 * quantities (smaller values are better than larger ones),
1292 * this and @minimized_quantity can determine sorting
1293 * order for test result reports.
1298 g_test_minimized_result (double minimized_quantity,
1302 long double largs = minimized_quantity;
1306 va_start (args, format);
1307 buffer = g_strdup_vprintf (format, args);
1310 g_test_log (G_TEST_LOG_MIN_RESULT, buffer, NULL, 1, &largs);
1315 * g_test_maximized_result:
1316 * @maximized_quantity: the reported value
1317 * @format: the format string of the report message
1318 * @...: arguments to pass to the printf() function
1320 * Report the result of a performance or measurement test.
1321 * The test should generally strive to maximize the reported
1322 * quantities (larger values are better than smaller ones),
1323 * this and @maximized_quantity can determine sorting
1324 * order for test result reports.
1329 g_test_maximized_result (double maximized_quantity,
1333 long double largs = maximized_quantity;
1337 va_start (args, format);
1338 buffer = g_strdup_vprintf (format, args);
1341 g_test_log (G_TEST_LOG_MAX_RESULT, buffer, NULL, 1, &largs);
1347 * @format: the format string
1348 * @...: printf-like arguments to @format
1350 * Add a message to the test report.
1355 g_test_message (const char *format,
1361 va_start (args, format);
1362 buffer = g_strdup_vprintf (format, args);
1365 g_test_log (G_TEST_LOG_MESSAGE, buffer, NULL, 0, NULL);
1371 * @uri_pattern: the base pattern for bug URIs
1373 * Specify the base URI for bug reports.
1375 * The base URI is used to construct bug report messages for
1376 * g_test_message() when g_test_bug() is called.
1377 * Calling this function outside of a test case sets the
1378 * default base URI for all test cases. Calling it from within
1379 * a test case changes the base URI for the scope of the test
1381 * Bug URIs are constructed by appending a bug specific URI
1382 * portion to @uri_pattern, or by replacing the special string
1383 * '\%s' within @uri_pattern if that is present.
1388 g_test_bug_base (const char *uri_pattern)
1390 g_free (test_uri_base);
1391 test_uri_base = g_strdup (uri_pattern);
1396 * @bug_uri_snippet: Bug specific bug tracker URI portion.
1398 * This function adds a message to test reports that
1399 * associates a bug URI with a test case.
1400 * Bug URIs are constructed from a base URI set with g_test_bug_base()
1401 * and @bug_uri_snippet.
1406 g_test_bug (const char *bug_uri_snippet)
1410 g_return_if_fail (test_uri_base != NULL);
1411 g_return_if_fail (bug_uri_snippet != NULL);
1413 c = strstr (test_uri_base, "%s");
1416 char *b = g_strndup (test_uri_base, c - test_uri_base);
1417 char *s = g_strconcat (b, bug_uri_snippet, c + 2, NULL);
1419 g_test_message ("Bug Reference: %s", s);
1423 g_test_message ("Bug Reference: %s%s", test_uri_base, bug_uri_snippet);
1429 * Get the toplevel test suite for the test path API.
1431 * Returns: the toplevel #GTestSuite
1436 g_test_get_root (void)
1438 if (!test_suite_root)
1440 test_suite_root = g_test_create_suite ("root");
1441 g_free (test_suite_root->name);
1442 test_suite_root->name = g_strdup ("");
1445 return test_suite_root;
1451 * Runs all tests under the toplevel suite which can be retrieved
1452 * with g_test_get_root(). Similar to g_test_run_suite(), the test
1453 * cases to be run are filtered according to
1454 * test path arguments (-p <replaceable>testpath</replaceable>) as
1455 * parsed by g_test_init().
1456 * g_test_run_suite() or g_test_run() may only be called once
1459 * Returns: 0 on success
1466 return g_test_run_suite (g_test_get_root());
1470 * g_test_create_case:
1471 * @test_name: the name for the test case
1472 * @data_size: the size of the fixture data structure
1473 * @test_data: test data argument for the test functions
1474 * @data_setup: the function to set up the fixture data
1475 * @data_test: the actual test function
1476 * @data_teardown: the function to teardown the fixture data
1478 * Create a new #GTestCase, named @test_name, this API is fairly
1479 * low level, calling g_test_add() or g_test_add_func() is preferable.
1480 * When this test is executed, a fixture structure of size @data_size
1481 * will be allocated and filled with 0s. Then @data_setup is called
1482 * to initialize the fixture. After fixture setup, the actual test
1483 * function @data_test is called. Once the test run completed, the
1484 * fixture structure is torn down by calling @data_teardown and
1485 * after that the memory is released.
1487 * Splitting up a test run into fixture setup, test function and
1488 * fixture teardown is most usful if the same fixture is used for
1489 * multiple tests. In this cases, g_test_create_case() will be
1490 * called with the same fixture, but varying @test_name and
1491 * @data_test arguments.
1493 * Returns: a newly allocated #GTestCase.
1498 g_test_create_case (const char *test_name,
1500 gconstpointer test_data,
1501 GTestFixtureFunc data_setup,
1502 GTestFixtureFunc data_test,
1503 GTestFixtureFunc data_teardown)
1507 g_return_val_if_fail (test_name != NULL, NULL);
1508 g_return_val_if_fail (strchr (test_name, '/') == NULL, NULL);
1509 g_return_val_if_fail (test_name[0] != 0, NULL);
1510 g_return_val_if_fail (data_test != NULL, NULL);
1512 tc = g_slice_new0 (GTestCase);
1513 tc->name = g_strdup (test_name);
1514 tc->test_data = (gpointer) test_data;
1515 tc->fixture_size = data_size;
1516 tc->fixture_setup = (void*) data_setup;
1517 tc->fixture_test = (void*) data_test;
1518 tc->fixture_teardown = (void*) data_teardown;
1524 find_suite (gconstpointer l, gconstpointer s)
1526 const GTestSuite *suite = l;
1527 const gchar *str = s;
1529 return strcmp (suite->name, str);
1534 * @fixture: the test fixture
1535 * @user_data: the data provided when registering the test
1537 * The type used for functions that operate on test fixtures. This is
1538 * used for the fixture setup and teardown functions as well as for the
1539 * testcases themselves.
1541 * @user_data is a pointer to the data that was given when registering
1544 * @fixture will be a pointer to the area of memory allocated by the
1545 * test framework, of the size requested. If the requested size was
1546 * zero then @fixture will be equal to @user_data.
1551 g_test_add_vtable (const char *testpath,
1553 gconstpointer test_data,
1554 GTestFixtureFunc data_setup,
1555 GTestFixtureFunc fixture_test_func,
1556 GTestFixtureFunc data_teardown)
1562 g_return_if_fail (testpath != NULL);
1563 g_return_if_fail (g_path_is_absolute (testpath));
1564 g_return_if_fail (fixture_test_func != NULL);
1566 if (g_slist_find_custom (test_paths_skipped, testpath, (GCompareFunc)g_strcmp0))
1569 suite = g_test_get_root();
1570 segments = g_strsplit (testpath, "/", -1);
1571 for (ui = 0; segments[ui] != NULL; ui++)
1573 const char *seg = segments[ui];
1574 gboolean islast = segments[ui + 1] == NULL;
1575 if (islast && !seg[0])
1576 g_error ("invalid test case path: %s", testpath);
1578 continue; /* initial or duplicate slash */
1583 l = g_slist_find_custom (suite->suites, seg, find_suite);
1590 csuite = g_test_create_suite (seg);
1591 g_test_suite_add_suite (suite, csuite);
1597 GTestCase *tc = g_test_create_case (seg, data_size, test_data, data_setup, fixture_test_func, data_teardown);
1598 g_test_suite_add (suite, tc);
1601 g_strfreev (segments);
1607 * Indicates that a test failed. This function can be called
1608 * multiple times from the same test. You can use this function
1609 * if your test failed in a recoverable way.
1611 * Do not use this function if the failure of a test could cause
1612 * other tests to malfunction.
1614 * Calling this function will not stop the test from running, you
1615 * need to return from the test function yourself. So you can
1616 * produce additional diagnostic messages or even continue running
1619 * If not called from inside a test, this function does nothing.
1626 test_run_success = G_TEST_RUN_FAILURE;
1630 * g_test_incomplete:
1631 * @msg: (allow-none): explanation
1633 * Indicates that a test failed because of some incomplete
1634 * functionality. This function can be called multiple times
1635 * from the same test.
1637 * Calling this function will not stop the test from running, you
1638 * need to return from the test function yourself. So you can
1639 * produce additional diagnostic messages or even continue running
1642 * If not called from inside a test, this function does nothing.
1647 g_test_incomplete (const gchar *msg)
1649 test_run_success = G_TEST_RUN_INCOMPLETE;
1650 g_free (test_run_msg);
1651 test_run_msg = g_strdup (msg);
1656 * @msg: (allow-none): explanation
1658 * Indicates that a test was skipped.
1660 * Calling this function will not stop the test from running, you
1661 * need to return from the test function yourself. So you can
1662 * produce additional diagnostic messages or even continue running
1665 * If not called from inside a test, this function does nothing.
1670 g_test_skip (const gchar *msg)
1672 test_run_success = G_TEST_RUN_SKIPPED;
1673 g_free (test_run_msg);
1674 test_run_msg = g_strdup (msg);
1680 * Returns whether a test has already failed. This will
1681 * be the case when g_test_fail(), g_test_incomplete()
1682 * or g_test_skip() have been called, but also if an
1683 * assertion has failed.
1685 * This can be useful to return early from a test if
1686 * continuing after a failed assertion might be harmful.
1688 * The return value of this function is only meaningful
1689 * if it is called from inside a test function.
1691 * Returns: %TRUE if the test has failed
1696 g_test_failed (void)
1698 return test_run_success != G_TEST_RUN_SUCCESS;
1704 * The type used for test case functions.
1711 * @testpath: /-separated test case path name for the test.
1712 * @test_func: The test function to invoke for this test.
1714 * Create a new test case, similar to g_test_create_case(). However
1715 * the test is assumed to use no fixture, and test suites are automatically
1716 * created on the fly and added to the root fixture, based on the
1717 * slash-separated portions of @testpath.
1719 * If @testpath includes the component "subprocess" anywhere in it,
1720 * the test will be skipped by default, and only run if explicitly
1721 * required via the <option>-p</option> command-line option or
1722 * g_test_trap_subprocess().
1727 g_test_add_func (const char *testpath,
1728 GTestFunc test_func)
1730 g_return_if_fail (testpath != NULL);
1731 g_return_if_fail (testpath[0] == '/');
1732 g_return_if_fail (test_func != NULL);
1733 g_test_add_vtable (testpath, 0, NULL, NULL, (GTestFixtureFunc) test_func, NULL);
1738 * @user_data: the data provided when registering the test
1740 * The type used for test case functions that take an extra pointer
1747 * g_test_add_data_func:
1748 * @testpath: /-separated test case path name for the test.
1749 * @test_data: Test data argument for the test function.
1750 * @test_func: The test function to invoke for this test.
1752 * Create a new test case, similar to g_test_create_case(). However
1753 * the test is assumed to use no fixture, and test suites are automatically
1754 * created on the fly and added to the root fixture, based on the
1755 * slash-separated portions of @testpath. The @test_data argument
1756 * will be passed as first argument to @test_func.
1758 * If @testpath includes the component "subprocess" anywhere in it,
1759 * the test will be skipped by default, and only run if explicitly
1760 * required via the <option>-p</option> command-line option or
1761 * g_test_trap_subprocess().
1766 g_test_add_data_func (const char *testpath,
1767 gconstpointer test_data,
1768 GTestDataFunc test_func)
1770 g_return_if_fail (testpath != NULL);
1771 g_return_if_fail (testpath[0] == '/');
1772 g_return_if_fail (test_func != NULL);
1774 g_test_add_vtable (testpath, 0, test_data, NULL, (GTestFixtureFunc) test_func, NULL);
1778 * g_test_add_data_func_full:
1779 * @testpath: /-separated test case path name for the test.
1780 * @test_data: Test data argument for the test function.
1781 * @test_func: The test function to invoke for this test.
1782 * @data_free_func: #GDestroyNotify for @test_data.
1784 * Create a new test case, as with g_test_add_data_func(), but freeing
1785 * @test_data after the test run is complete.
1790 g_test_add_data_func_full (const char *testpath,
1792 GTestDataFunc test_func,
1793 GDestroyNotify data_free_func)
1795 g_return_if_fail (testpath != NULL);
1796 g_return_if_fail (testpath[0] == '/');
1797 g_return_if_fail (test_func != NULL);
1799 g_test_add_vtable (testpath, 0, test_data, NULL,
1800 (GTestFixtureFunc) test_func,
1801 (GTestFixtureFunc) data_free_func);
1805 g_test_suite_case_exists (GTestSuite *suite,
1806 const char *test_path)
1813 slash = strchr (test_path, '/');
1817 for (iter = suite->suites; iter; iter = iter->next)
1819 GTestSuite *child_suite = iter->data;
1821 if (!strncmp (child_suite->name, test_path, slash - test_path))
1822 if (g_test_suite_case_exists (child_suite, slash))
1828 for (iter = suite->cases; iter; iter = iter->next)
1831 if (!strcmp (tc->name, test_path))
1840 * g_test_create_suite:
1841 * @suite_name: a name for the suite
1843 * Create a new test suite with the name @suite_name.
1845 * Returns: A newly allocated #GTestSuite instance.
1850 g_test_create_suite (const char *suite_name)
1853 g_return_val_if_fail (suite_name != NULL, NULL);
1854 g_return_val_if_fail (strchr (suite_name, '/') == NULL, NULL);
1855 g_return_val_if_fail (suite_name[0] != 0, NULL);
1856 ts = g_slice_new0 (GTestSuite);
1857 ts->name = g_strdup (suite_name);
1863 * @suite: a #GTestSuite
1864 * @test_case: a #GTestCase
1866 * Adds @test_case to @suite.
1871 g_test_suite_add (GTestSuite *suite,
1872 GTestCase *test_case)
1874 g_return_if_fail (suite != NULL);
1875 g_return_if_fail (test_case != NULL);
1877 suite->cases = g_slist_prepend (suite->cases, test_case);
1881 * g_test_suite_add_suite:
1882 * @suite: a #GTestSuite
1883 * @nestedsuite: another #GTestSuite
1885 * Adds @nestedsuite to @suite.
1890 g_test_suite_add_suite (GTestSuite *suite,
1891 GTestSuite *nestedsuite)
1893 g_return_if_fail (suite != NULL);
1894 g_return_if_fail (nestedsuite != NULL);
1896 suite->suites = g_slist_prepend (suite->suites, nestedsuite);
1900 * g_test_queue_free:
1901 * @gfree_pointer: the pointer to be stored.
1903 * Enqueue a pointer to be released with g_free() during the next
1904 * teardown phase. This is equivalent to calling g_test_queue_destroy()
1905 * with a destroy callback of g_free().
1910 g_test_queue_free (gpointer gfree_pointer)
1913 g_test_queue_destroy (g_free, gfree_pointer);
1917 * g_test_queue_destroy:
1918 * @destroy_func: Destroy callback for teardown phase.
1919 * @destroy_data: Destroy callback data.
1921 * This function enqueus a callback @destroy_func to be executed
1922 * during the next test case teardown phase. This is most useful
1923 * to auto destruct allocted test resources at the end of a test run.
1924 * Resources are released in reverse queue order, that means enqueueing
1925 * callback A before callback B will cause B() to be called before
1926 * A() during teardown.
1931 g_test_queue_destroy (GDestroyNotify destroy_func,
1932 gpointer destroy_data)
1934 DestroyEntry *dentry;
1936 g_return_if_fail (destroy_func != NULL);
1938 dentry = g_slice_new0 (DestroyEntry);
1939 dentry->destroy_func = destroy_func;
1940 dentry->destroy_data = destroy_data;
1941 dentry->next = test_destroy_queue;
1942 test_destroy_queue = dentry;
1946 test_case_run (GTestCase *tc)
1948 gchar *old_name = test_run_name, *old_base = g_strdup (test_uri_base);
1949 GSList **old_free_list, *filename_free_list = NULL;
1950 gboolean success = G_TEST_RUN_SUCCESS;
1952 old_free_list = test_filename_free_list;
1953 test_filename_free_list = &filename_free_list;
1955 test_run_name = g_strconcat (old_name, "/", tc->name, NULL);
1956 if (strstr (test_run_name, "/subprocess"))
1959 gboolean found = FALSE;
1961 for (iter = test_paths; iter; iter = iter->next)
1963 if (!strcmp (test_run_name, iter->data))
1972 if (g_test_verbose ())
1973 g_print ("GTest: skipping: %s\n", test_run_name);
1978 if (++test_run_count <= test_skip_count)
1979 g_test_log (G_TEST_LOG_SKIP_CASE, test_run_name, NULL, 0, NULL);
1980 else if (test_run_list)
1982 g_print ("%s\n", test_run_name);
1983 g_test_log (G_TEST_LOG_LIST_CASE, test_run_name, NULL, 0, NULL);
1987 GTimer *test_run_timer = g_timer_new();
1988 long double largs[3];
1990 g_test_log (G_TEST_LOG_START_CASE, test_run_name, NULL, 0, NULL);
1992 test_run_success = G_TEST_RUN_SUCCESS;
1993 g_clear_pointer (&test_run_msg, g_free);
1994 g_test_log_set_fatal_handler (NULL, NULL);
1995 g_timer_start (test_run_timer);
1996 fixture = tc->fixture_size ? g_malloc0 (tc->fixture_size) : tc->test_data;
1997 test_run_seed (test_run_seedstr);
1998 if (tc->fixture_setup)
1999 tc->fixture_setup (fixture, tc->test_data);
2000 tc->fixture_test (fixture, tc->test_data);
2002 while (test_destroy_queue)
2004 DestroyEntry *dentry = test_destroy_queue;
2005 test_destroy_queue = dentry->next;
2006 dentry->destroy_func (dentry->destroy_data);
2007 g_slice_free (DestroyEntry, dentry);
2009 if (tc->fixture_teardown)
2010 tc->fixture_teardown (fixture, tc->test_data);
2011 if (tc->fixture_size)
2013 g_timer_stop (test_run_timer);
2014 success = test_run_success;
2015 test_run_success = G_TEST_RUN_FAILURE;
2016 largs[0] = success; /* OK */
2017 largs[1] = test_run_forks;
2018 largs[2] = g_timer_elapsed (test_run_timer, NULL);
2019 g_test_log (G_TEST_LOG_STOP_CASE, test_run_name, test_run_msg, G_N_ELEMENTS (largs), largs);
2020 g_clear_pointer (&test_run_msg, g_free);
2021 g_timer_destroy (test_run_timer);
2025 g_slist_free_full (filename_free_list, g_free);
2026 test_filename_free_list = old_free_list;
2027 g_free (test_run_name);
2028 test_run_name = old_name;
2029 g_free (test_uri_base);
2030 test_uri_base = old_base;
2032 return success == G_TEST_RUN_SUCCESS;
2036 g_test_run_suite_internal (GTestSuite *suite,
2040 gchar *rest, *old_name = test_run_name;
2041 GSList *slist, *reversed;
2043 g_return_val_if_fail (suite != NULL, -1);
2045 g_test_log (G_TEST_LOG_START_SUITE, suite->name, NULL, 0, NULL);
2047 while (path[0] == '/')
2050 rest = strchr (path, '/');
2051 l = rest ? MIN (l, rest - path) : l;
2052 test_run_name = suite->name[0] == 0 ? g_strdup (test_run_name) : g_strconcat (old_name, "/", suite->name, NULL);
2053 reversed = g_slist_reverse (g_slist_copy (suite->cases));
2054 for (slist = reversed; slist; slist = slist->next)
2056 GTestCase *tc = slist->data;
2057 guint n = l ? strlen (tc->name) : 0;
2058 if (l == n && !rest && strncmp (path, tc->name, n) == 0)
2060 if (!test_case_run (tc))
2064 g_slist_free (reversed);
2065 reversed = g_slist_reverse (g_slist_copy (suite->suites));
2066 for (slist = reversed; slist; slist = slist->next)
2068 GTestSuite *ts = slist->data;
2069 guint n = l ? strlen (ts->name) : 0;
2070 if (l == n && strncmp (path, ts->name, n) == 0)
2071 n_bad += g_test_run_suite_internal (ts, rest ? rest : "");
2073 g_slist_free (reversed);
2074 g_free (test_run_name);
2075 test_run_name = old_name;
2077 g_test_log (G_TEST_LOG_STOP_SUITE, suite->name, NULL, 0, NULL);
2084 * @suite: a #GTestSuite
2086 * Execute the tests within @suite and all nested #GTestSuites.
2087 * The test suites to be executed are filtered according to
2088 * test path arguments (-p <replaceable>testpath</replaceable>)
2089 * as parsed by g_test_init().
2090 * g_test_run_suite() or g_test_run() may only be called once
2093 * Returns: 0 on success
2098 g_test_run_suite (GTestSuite *suite)
2100 GSList *my_test_paths;
2103 g_return_val_if_fail (g_test_config_vars->test_initialized, -1);
2104 g_return_val_if_fail (g_test_run_once == TRUE, -1);
2106 g_test_run_once = FALSE;
2109 my_test_paths = g_slist_copy (test_paths);
2111 my_test_paths = g_slist_prepend (NULL, "");
2113 while (my_test_paths)
2115 const char *rest, *path = my_test_paths->data;
2116 guint l, n = strlen (suite->name);
2117 my_test_paths = g_slist_delete_link (my_test_paths, my_test_paths);
2118 while (path[0] == '/')
2120 if (!n) /* root suite, run unconditionally */
2122 n_bad += g_test_run_suite_internal (suite, path);
2125 /* regular suite, match path */
2126 rest = strchr (path, '/');
2128 l = rest ? MIN (l, rest - path) : l;
2129 if ((!l || l == n) && strncmp (path, suite->name, n) == 0)
2130 n_bad += g_test_run_suite_internal (suite, rest ? rest : "");
2137 gtest_default_log_handler (const gchar *log_domain,
2138 GLogLevelFlags log_level,
2139 const gchar *message,
2140 gpointer unused_data)
2142 const gchar *strv[16];
2143 gboolean fatal = FALSE;
2149 strv[i++] = log_domain;
2152 if (log_level & G_LOG_FLAG_FATAL)
2154 strv[i++] = "FATAL-";
2157 if (log_level & G_LOG_FLAG_RECURSION)
2158 strv[i++] = "RECURSIVE-";
2159 if (log_level & G_LOG_LEVEL_ERROR)
2160 strv[i++] = "ERROR";
2161 if (log_level & G_LOG_LEVEL_CRITICAL)
2162 strv[i++] = "CRITICAL";
2163 if (log_level & G_LOG_LEVEL_WARNING)
2164 strv[i++] = "WARNING";
2165 if (log_level & G_LOG_LEVEL_MESSAGE)
2166 strv[i++] = "MESSAGE";
2167 if (log_level & G_LOG_LEVEL_INFO)
2169 if (log_level & G_LOG_LEVEL_DEBUG)
2170 strv[i++] = "DEBUG";
2172 strv[i++] = message;
2175 msg = g_strjoinv ("", (gchar**) strv);
2176 g_test_log (fatal ? G_TEST_LOG_ERROR : G_TEST_LOG_MESSAGE, msg, NULL, 0, NULL);
2177 g_log_default_handler (log_domain, log_level, message, unused_data);
2183 g_assertion_message (const char *domain,
2187 const char *message)
2193 message = "code should not be reached";
2194 g_snprintf (lstr, 32, "%d", line);
2195 s = g_strconcat (domain ? domain : "", domain && domain[0] ? ":" : "",
2196 "ERROR:", file, ":", lstr, ":",
2197 func, func[0] ? ":" : "",
2198 " ", message, NULL);
2199 g_printerr ("**\n%s\n", s);
2201 /* store assertion message in global variable, so that it can be found in a
2203 if (__glib_assert_msg != NULL)
2204 /* free the old one */
2205 free (__glib_assert_msg);
2206 __glib_assert_msg = (char*) malloc (strlen (s) + 1);
2207 strcpy (__glib_assert_msg, s);
2209 g_test_log (G_TEST_LOG_ERROR, s, NULL, 0, NULL);
2215 g_assertion_message_expr (const char *domain,
2223 s = g_strdup ("code should not be reached");
2225 s = g_strconcat ("assertion failed: (", expr, ")", NULL);
2226 g_assertion_message (domain, file, line, func, s);
2231 g_assertion_message_cmpnum (const char *domain,
2245 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;
2246 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;
2247 case 'f': s = g_strdup_printf ("assertion failed (%s): (%.9g %s %.9g)", expr, (double) arg1, cmp, (double) arg2); break;
2248 /* ideally use: floats=%.7g double=%.17g */
2250 g_assertion_message (domain, file, line, func, s);
2255 g_assertion_message_cmpstr (const char *domain,
2264 char *a1, *a2, *s, *t1 = NULL, *t2 = NULL;
2265 a1 = arg1 ? g_strconcat ("\"", t1 = g_strescape (arg1, NULL), "\"", NULL) : g_strdup ("NULL");
2266 a2 = arg2 ? g_strconcat ("\"", t2 = g_strescape (arg2, NULL), "\"", NULL) : g_strdup ("NULL");
2269 s = g_strdup_printf ("assertion failed (%s): (%s %s %s)", expr, a1, cmp, a2);
2272 g_assertion_message (domain, file, line, func, s);
2277 g_assertion_message_error (const char *domain,
2282 const GError *error,
2283 GQuark error_domain,
2288 /* This is used by both g_assert_error() and g_assert_no_error(), so there
2289 * are three cases: expected an error but got the wrong error, expected
2290 * an error but got no error, and expected no error but got an error.
2293 gstring = g_string_new ("assertion failed ");
2295 g_string_append_printf (gstring, "(%s == (%s, %d)): ", expr,
2296 g_quark_to_string (error_domain), error_code);
2298 g_string_append_printf (gstring, "(%s == NULL): ", expr);
2301 g_string_append_printf (gstring, "%s (%s, %d)", error->message,
2302 g_quark_to_string (error->domain), error->code);
2304 g_string_append_printf (gstring, "%s is NULL", expr);
2306 g_assertion_message (domain, file, line, func, gstring->str);
2307 g_string_free (gstring, TRUE);
2312 * @str1: (allow-none): a C string or %NULL
2313 * @str2: (allow-none): another C string or %NULL
2315 * Compares @str1 and @str2 like strcmp(). Handles %NULL
2316 * gracefully by sorting it before non-%NULL strings.
2317 * Comparing two %NULL pointers returns 0.
2319 * Returns: an integer less than, equal to, or greater than zero, if @str1 is <, == or > than @str2.
2324 g_strcmp0 (const char *str1,
2328 return -(str1 != str2);
2330 return str1 != str2;
2331 return strcmp (str1, str2);
2335 test_trap_clear (void)
2337 test_trap_last_status = 0;
2338 test_trap_last_pid = 0;
2339 g_clear_pointer (&test_trap_last_subprocess, g_free);
2340 g_clear_pointer (&test_trap_last_stdout, g_free);
2341 g_clear_pointer (&test_trap_last_stderr, g_free);
2352 ret = dup2 (fd1, fd2);
2353 while (ret < 0 && errno == EINTR);
2364 GIOChannel *stdout_io;
2365 gboolean echo_stdout;
2366 GString *stdout_str;
2368 GIOChannel *stderr_io;
2369 gboolean echo_stderr;
2370 GString *stderr_str;
2374 check_complete (WaitForChildData *data)
2376 if (data->child_status != -1 && data->stdout_io == NULL && data->stderr_io == NULL)
2377 g_main_loop_quit (data->loop);
2381 child_exited (GPid pid,
2385 WaitForChildData *data = user_data;
2388 if (WIFEXITED (status)) /* normal exit */
2389 data->child_status = WEXITSTATUS (status); /* 0..255 */
2390 else if (WIFSIGNALED (status) && WTERMSIG (status) == SIGALRM)
2391 data->child_status = G_TEST_STATUS_TIMED_OUT;
2392 else if (WIFSIGNALED (status))
2393 data->child_status = (WTERMSIG (status) << 12); /* signalled */
2394 else /* WCOREDUMP (status) */
2395 data->child_status = 512; /* coredump */
2397 data->child_status = status;
2400 check_complete (data);
2404 child_timeout (gpointer user_data)
2406 WaitForChildData *data = user_data;
2409 TerminateProcess (data->pid, G_TEST_STATUS_TIMED_OUT);
2411 kill (data->pid, SIGALRM);
2418 child_read (GIOChannel *io, GIOCondition cond, gpointer user_data)
2420 WaitForChildData *data = user_data;
2422 gsize nread, nwrote, total;
2424 FILE *echo_file = NULL;
2426 status = g_io_channel_read_chars (io, buf, sizeof (buf), &nread, NULL);
2427 if (status == G_IO_STATUS_ERROR || status == G_IO_STATUS_EOF)
2429 // FIXME data->error = (status == G_IO_STATUS_ERROR);
2430 if (io == data->stdout_io)
2431 g_clear_pointer (&data->stdout_io, g_io_channel_unref);
2433 g_clear_pointer (&data->stderr_io, g_io_channel_unref);
2435 check_complete (data);
2438 else if (status == G_IO_STATUS_AGAIN)
2441 if (io == data->stdout_io)
2443 g_string_append_len (data->stdout_str, buf, nread);
2444 if (data->echo_stdout)
2449 g_string_append_len (data->stderr_str, buf, nread);
2450 if (data->echo_stderr)
2456 for (total = 0; total < nread; total += nwrote)
2458 nwrote = fwrite (buf + total, 1, nread - total, echo_file);
2460 g_error ("write failed: %s", g_strerror (errno));
2468 wait_for_child (GPid pid,
2469 int stdout_fd, gboolean echo_stdout,
2470 int stderr_fd, gboolean echo_stderr,
2473 WaitForChildData data;
2474 GMainContext *context;
2478 data.child_status = -1;
2480 context = g_main_context_new ();
2481 data.loop = g_main_loop_new (context, FALSE);
2483 source = g_child_watch_source_new (pid);
2484 g_source_set_callback (source, (GSourceFunc) child_exited, &data, NULL);
2485 g_source_attach (source, context);
2486 g_source_unref (source);
2488 data.echo_stdout = echo_stdout;
2489 data.stdout_str = g_string_new (NULL);
2490 data.stdout_io = g_io_channel_unix_new (stdout_fd);
2491 g_io_channel_set_close_on_unref (data.stdout_io, TRUE);
2492 g_io_channel_set_encoding (data.stdout_io, NULL, NULL);
2493 g_io_channel_set_buffered (data.stdout_io, FALSE);
2494 source = g_io_create_watch (data.stdout_io, G_IO_IN | G_IO_ERR | G_IO_HUP);
2495 g_source_set_callback (source, (GSourceFunc) child_read, &data, NULL);
2496 g_source_attach (source, context);
2497 g_source_unref (source);
2499 data.echo_stderr = echo_stderr;
2500 data.stderr_str = g_string_new (NULL);
2501 data.stderr_io = g_io_channel_unix_new (stderr_fd);
2502 g_io_channel_set_close_on_unref (data.stderr_io, TRUE);
2503 g_io_channel_set_encoding (data.stderr_io, NULL, NULL);
2504 g_io_channel_set_buffered (data.stderr_io, FALSE);
2505 source = g_io_create_watch (data.stderr_io, G_IO_IN | G_IO_ERR | G_IO_HUP);
2506 g_source_set_callback (source, (GSourceFunc) child_read, &data, NULL);
2507 g_source_attach (source, context);
2508 g_source_unref (source);
2512 source = g_timeout_source_new (0);
2513 g_source_set_ready_time (source, g_get_monotonic_time () + timeout);
2514 g_source_set_callback (source, (GSourceFunc) child_timeout, &data, NULL);
2515 g_source_attach (source, context);
2516 g_source_unref (source);
2519 g_main_loop_run (data.loop);
2520 g_main_loop_unref (data.loop);
2521 g_main_context_unref (context);
2523 test_trap_last_pid = pid;
2524 test_trap_last_status = data.child_status;
2525 test_trap_last_stdout = g_string_free (data.stdout_str, FALSE);
2526 test_trap_last_stderr = g_string_free (data.stderr_str, FALSE);
2528 g_clear_pointer (&data.stdout_io, g_io_channel_unref);
2529 g_clear_pointer (&data.stderr_io, g_io_channel_unref);
2534 * @usec_timeout: Timeout for the forked test in micro seconds.
2535 * @test_trap_flags: Flags to modify forking behaviour.
2537 * Fork the current test program to execute a test case that might
2538 * not return or that might abort.
2540 * If @usec_timeout is non-0, the forked test case is aborted and
2541 * considered failing if its run time exceeds it.
2543 * The forking behavior can be configured with the #GTestTrapFlags flags.
2545 * In the following example, the test code forks, the forked child
2546 * process produces some sample output and exits successfully.
2547 * The forking parent process then asserts successful child program
2548 * termination and validates child program outputs.
2552 * test_fork_patterns (void)
2554 * if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
2556 * g_print ("some stdout text: somagic17\n");
2557 * g_printerr ("some stderr text: semagic43\n");
2558 * exit (0); /* successful test run */
2560 * g_test_trap_assert_passed ();
2561 * g_test_trap_assert_stdout ("*somagic17*");
2562 * g_test_trap_assert_stderr ("*semagic43*");
2566 * Returns: %TRUE for the forked child and %FALSE for the executing parent process.
2570 * Deprecated: This function is implemented only on Unix platforms,
2571 * and is not always reliable due to problems inherent in
2572 * fork-without-exec. Use g_test_trap_subprocess() instead.
2575 g_test_trap_fork (guint64 usec_timeout,
2576 GTestTrapFlags test_trap_flags)
2579 int stdout_pipe[2] = { -1, -1 };
2580 int stderr_pipe[2] = { -1, -1 };
2583 if (pipe (stdout_pipe) < 0 || pipe (stderr_pipe) < 0)
2584 g_error ("failed to create pipes to fork test program: %s", g_strerror (errno));
2585 test_trap_last_pid = fork ();
2586 if (test_trap_last_pid < 0)
2587 g_error ("failed to fork test program: %s", g_strerror (errno));
2588 if (test_trap_last_pid == 0) /* child */
2591 close (stdout_pipe[0]);
2592 close (stderr_pipe[0]);
2593 if (!(test_trap_flags & G_TEST_TRAP_INHERIT_STDIN))
2594 fd0 = g_open ("/dev/null", O_RDONLY, 0);
2595 if (sane_dup2 (stdout_pipe[1], 1) < 0 || sane_dup2 (stderr_pipe[1], 2) < 0 || (fd0 >= 0 && sane_dup2 (fd0, 0) < 0))
2596 g_error ("failed to dup2() in forked test program: %s", g_strerror (errno));
2599 if (stdout_pipe[1] >= 3)
2600 close (stdout_pipe[1]);
2601 if (stderr_pipe[1] >= 3)
2602 close (stderr_pipe[1]);
2608 close (stdout_pipe[1]);
2609 close (stderr_pipe[1]);
2611 wait_for_child (test_trap_last_pid,
2612 stdout_pipe[0], !(test_trap_flags & G_TEST_TRAP_SILENCE_STDOUT),
2613 stderr_pipe[0], !(test_trap_flags & G_TEST_TRAP_SILENCE_STDERR),
2618 g_message ("Not implemented: g_test_trap_fork");
2625 * g_test_trap_subprocess:
2626 * @test_path: Test to run in a subprocess
2627 * @usec_timeout: Timeout for the subprocess test in micro seconds.
2628 * @test_flags: Flags to modify subprocess behaviour.
2630 * Respawns the test program to run only @test_path in a subprocess.
2631 * This can be used for a test case that might not return, or that
2632 * might abort. @test_path will normally be the name of the parent
2633 * test, followed by "<literal>/subprocess/</literal>" and then a name
2634 * for the specific subtest (or just ending with
2635 * "<literal>/subprocess</literal>" if the test only has one child
2636 * test); tests with names of this form will automatically be skipped
2637 * in the parent process.
2639 * If @usec_timeout is non-0, the test subprocess is aborted and
2640 * considered failing if its run time exceeds it.
2642 * The subprocess behavior can be configured with the
2643 * #GTestSubprocessFlags flags.
2645 * You can use methods such as g_test_trap_assert_passed(),
2646 * g_test_trap_assert_failed(), and g_test_trap_assert_stderr() to
2647 * check the results of the subprocess. (But note that
2648 * g_test_trap_assert_stdout() and g_test_trap_assert_stderr()
2649 * cannot be used if @test_flags specifies that the child should
2650 * inherit the parent stdout/stderr.)
2652 * If your <literal>main ()</literal> needs to behave differently in
2653 * the subprocess, you can call g_test_subprocess() (after calling
2654 * g_test_init()) to see whether you are in a subprocess.
2656 * The following example tests that calling
2657 * <literal>my_object_new(1000000)</literal> will abort with an error
2662 * test_create_large_object_subprocess (void)
2664 * my_object_new (1000000);
2668 * test_create_large_object (void)
2670 * g_test_trap_subprocess ("/myobject/create_large_object/subprocess", 0, 0);
2671 * g_test_trap_assert_failed ();
2672 * g_test_trap_assert_stderr ("*ERROR*too large*");
2676 * main (int argc, char **argv)
2678 * g_test_init (&argc, &argv, NULL);
2680 * g_test_add_func ("/myobject/create_large_object",
2681 * test_create_large_object);
2682 * /* Because of the '/subprocess' in the name, this test will
2683 * * not be run by the g_test_run () call below.
2685 * g_test_add_func ("/myobject/create_large_object/subprocess",
2686 * test_create_large_object_subprocess);
2688 * return g_test_run ();
2695 g_test_trap_subprocess (const char *test_path,
2696 guint64 usec_timeout,
2697 GTestSubprocessFlags test_flags)
2699 GError *error = NULL;
2702 int stdout_fd, stderr_fd;
2705 /* Sanity check that they used GTestSubprocessFlags, not GTestTrapFlags */
2706 g_assert ((test_flags & (G_TEST_TRAP_INHERIT_STDIN | G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR)) == 0);
2708 if (!g_test_suite_case_exists (g_test_get_root (), test_path))
2709 g_error ("g_test_trap_subprocess: test does not exist: %s", test_path);
2711 if (g_test_verbose ())
2712 g_print ("GTest: subprocess: %s\n", test_path);
2715 test_trap_last_subprocess = g_strdup (test_path);
2717 argv = g_ptr_array_new ();
2718 g_ptr_array_add (argv, test_argv0);
2719 g_ptr_array_add (argv, "-q");
2720 g_ptr_array_add (argv, "-p");
2721 g_ptr_array_add (argv, (char *)test_path);
2722 g_ptr_array_add (argv, "--GTestSubprocess");
2723 if (test_log_fd != -1)
2725 char log_fd_buf[128];
2727 g_ptr_array_add (argv, "--GTestLogFD");
2728 g_snprintf (log_fd_buf, sizeof (log_fd_buf), "%d", test_log_fd);
2729 g_ptr_array_add (argv, log_fd_buf);
2731 g_ptr_array_add (argv, NULL);
2733 flags = G_SPAWN_DO_NOT_REAP_CHILD;
2734 if (test_flags & G_TEST_TRAP_INHERIT_STDIN)
2735 flags |= G_SPAWN_CHILD_INHERITS_STDIN;
2737 if (!g_spawn_async_with_pipes (test_initial_cwd,
2738 (char **)argv->pdata,
2741 &pid, NULL, &stdout_fd, &stderr_fd,
2744 g_error ("g_test_trap_subprocess() failed: %s\n",
2747 g_ptr_array_free (argv, TRUE);
2749 wait_for_child (pid,
2750 stdout_fd, !!(test_flags & G_TEST_SUBPROCESS_INHERIT_STDOUT),
2751 stderr_fd, !!(test_flags & G_TEST_SUBPROCESS_INHERIT_STDERR),
2756 * g_test_subprocess:
2758 * Returns %TRUE (after g_test_init() has been called) if the test
2759 * program is running under g_test_trap_subprocess().
2761 * Returns: %TRUE if the test program is running under
2762 * g_test_trap_subprocess().
2767 g_test_subprocess (void)
2769 return test_in_subprocess;
2773 * g_test_trap_has_passed:
2775 * Check the result of the last g_test_trap_subprocess() call.
2777 * Returns: %TRUE if the last test subprocess terminated successfully.
2782 g_test_trap_has_passed (void)
2784 return test_trap_last_status == 0; /* exit_status == 0 && !signal && !coredump */
2788 * g_test_trap_reached_timeout:
2790 * Check the result of the last g_test_trap_subprocess() call.
2792 * Returns: %TRUE if the last test subprocess got killed due to a timeout.
2797 g_test_trap_reached_timeout (void)
2799 return test_trap_last_status != G_TEST_STATUS_TIMED_OUT;
2803 g_test_trap_assertions (const char *domain,
2807 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
2808 const char *pattern)
2810 gboolean must_pass = assertion_flags == 0;
2811 gboolean must_fail = assertion_flags == 1;
2812 gboolean match_result = 0 == (assertion_flags & 1);
2813 const char *stdout_pattern = (assertion_flags & 2) ? pattern : NULL;
2814 const char *stderr_pattern = (assertion_flags & 4) ? pattern : NULL;
2815 const char *match_error = match_result ? "failed to match" : "contains invalid match";
2819 if (test_trap_last_subprocess != NULL)
2821 process_id = g_strdup_printf ("%s [%d]", test_trap_last_subprocess,
2822 test_trap_last_pid);
2824 else if (test_trap_last_pid != 0)
2825 process_id = g_strdup_printf ("%d", test_trap_last_pid);
2827 if (test_trap_last_subprocess != NULL)
2828 process_id = g_strdup (test_trap_last_subprocess);
2831 g_error ("g_test_trap_ assertion with no trapped test");
2833 if (must_pass && !g_test_trap_has_passed())
2835 char *msg = g_strdup_printf ("child process (%s) failed unexpectedly", process_id);
2836 g_assertion_message (domain, file, line, func, msg);
2839 if (must_fail && g_test_trap_has_passed())
2841 char *msg = g_strdup_printf ("child process (%s) did not fail as expected", process_id);
2842 g_assertion_message (domain, file, line, func, msg);
2845 if (stdout_pattern && match_result == !g_pattern_match_simple (stdout_pattern, test_trap_last_stdout))
2847 char *msg = g_strdup_printf ("stdout of child process (%s) %s: %s", process_id, match_error, stdout_pattern);
2848 g_assertion_message (domain, file, line, func, msg);
2851 if (stderr_pattern && match_result == !g_pattern_match_simple (stderr_pattern, test_trap_last_stderr))
2853 char *msg = g_strdup_printf ("stderr of child process (%s) %s: %s", process_id, match_error, stderr_pattern);
2854 g_assertion_message (domain, file, line, func, msg);
2857 g_free (process_id);
2861 gstring_overwrite_int (GString *gstring,
2865 vuint = g_htonl (vuint);
2866 g_string_overwrite_len (gstring, pos, (const gchar*) &vuint, 4);
2870 gstring_append_int (GString *gstring,
2873 vuint = g_htonl (vuint);
2874 g_string_append_len (gstring, (const gchar*) &vuint, 4);
2878 gstring_append_double (GString *gstring,
2881 union { double vdouble; guint64 vuint64; } u;
2882 u.vdouble = vdouble;
2883 u.vuint64 = GUINT64_TO_BE (u.vuint64);
2884 g_string_append_len (gstring, (const gchar*) &u.vuint64, 8);
2888 g_test_log_dump (GTestLogMsg *msg,
2891 GString *gstring = g_string_sized_new (1024);
2893 gstring_append_int (gstring, 0); /* message length */
2894 gstring_append_int (gstring, msg->log_type);
2895 gstring_append_int (gstring, msg->n_strings);
2896 gstring_append_int (gstring, msg->n_nums);
2897 gstring_append_int (gstring, 0); /* reserved */
2898 for (ui = 0; ui < msg->n_strings; ui++)
2900 guint l = strlen (msg->strings[ui]);
2901 gstring_append_int (gstring, l);
2902 g_string_append_len (gstring, msg->strings[ui], l);
2904 for (ui = 0; ui < msg->n_nums; ui++)
2905 gstring_append_double (gstring, msg->nums[ui]);
2906 *len = gstring->len;
2907 gstring_overwrite_int (gstring, 0, *len); /* message length */
2908 return (guint8*) g_string_free (gstring, FALSE);
2911 static inline long double
2912 net_double (const gchar **ipointer)
2914 union { guint64 vuint64; double vdouble; } u;
2915 guint64 aligned_int64;
2916 memcpy (&aligned_int64, *ipointer, 8);
2918 u.vuint64 = GUINT64_FROM_BE (aligned_int64);
2922 static inline guint32
2923 net_int (const gchar **ipointer)
2925 guint32 aligned_int;
2926 memcpy (&aligned_int, *ipointer, 4);
2928 return g_ntohl (aligned_int);
2932 g_test_log_extract (GTestLogBuffer *tbuffer)
2934 const gchar *p = tbuffer->data->str;
2937 if (tbuffer->data->len < 4 * 5)
2939 mlength = net_int (&p);
2940 if (tbuffer->data->len < mlength)
2942 msg.log_type = net_int (&p);
2943 msg.n_strings = net_int (&p);
2944 msg.n_nums = net_int (&p);
2945 if (net_int (&p) == 0)
2948 msg.strings = g_new0 (gchar*, msg.n_strings + 1);
2949 msg.nums = g_new0 (long double, msg.n_nums);
2950 for (ui = 0; ui < msg.n_strings; ui++)
2952 guint sl = net_int (&p);
2953 msg.strings[ui] = g_strndup (p, sl);
2956 for (ui = 0; ui < msg.n_nums; ui++)
2957 msg.nums[ui] = net_double (&p);
2958 if (p <= tbuffer->data->str + mlength)
2960 g_string_erase (tbuffer->data, 0, mlength);
2961 tbuffer->msgs = g_slist_prepend (tbuffer->msgs, g_memdup (&msg, sizeof (msg)));
2966 g_strfreev (msg.strings);
2967 g_error ("corrupt log stream from test program");
2972 * g_test_log_buffer_new:
2974 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
2977 g_test_log_buffer_new (void)
2979 GTestLogBuffer *tb = g_new0 (GTestLogBuffer, 1);
2980 tb->data = g_string_sized_new (1024);
2985 * g_test_log_buffer_free:
2987 * Internal function for gtester to free test log messages, no ABI guarantees provided.
2990 g_test_log_buffer_free (GTestLogBuffer *tbuffer)
2992 g_return_if_fail (tbuffer != NULL);
2993 while (tbuffer->msgs)
2994 g_test_log_msg_free (g_test_log_buffer_pop (tbuffer));
2995 g_string_free (tbuffer->data, TRUE);
3000 * g_test_log_buffer_push:
3002 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
3005 g_test_log_buffer_push (GTestLogBuffer *tbuffer,
3007 const guint8 *bytes)
3009 g_return_if_fail (tbuffer != NULL);
3012 gboolean more_messages;
3013 g_return_if_fail (bytes != NULL);
3014 g_string_append_len (tbuffer->data, (const gchar*) bytes, n_bytes);
3016 more_messages = g_test_log_extract (tbuffer);
3017 while (more_messages);
3022 * g_test_log_buffer_pop:
3024 * Internal function for gtester to retrieve test log messages, no ABI guarantees provided.
3027 g_test_log_buffer_pop (GTestLogBuffer *tbuffer)
3029 GTestLogMsg *msg = NULL;
3030 g_return_val_if_fail (tbuffer != NULL, NULL);
3033 GSList *slist = g_slist_last (tbuffer->msgs);
3035 tbuffer->msgs = g_slist_delete_link (tbuffer->msgs, slist);
3041 * g_test_log_msg_free:
3043 * Internal function for gtester to free test log messages, no ABI guarantees provided.
3046 g_test_log_msg_free (GTestLogMsg *tmsg)
3048 g_return_if_fail (tmsg != NULL);
3049 g_strfreev (tmsg->strings);
3050 g_free (tmsg->nums);
3055 g_test_build_filename_va (GTestFileType file_type,
3056 const gchar *first_path,
3059 const gchar *pathv[16];
3060 gint num_path_segments;
3062 if (file_type == G_TEST_DIST)
3063 pathv[0] = test_disted_files_dir;
3064 else if (file_type == G_TEST_BUILT)
3065 pathv[0] = test_built_files_dir;
3067 g_assert_not_reached ();
3069 pathv[1] = first_path;
3071 for (num_path_segments = 2; num_path_segments < G_N_ELEMENTS (pathv); num_path_segments++)
3073 pathv[num_path_segments] = va_arg (ap, const char *);
3074 if (pathv[num_path_segments] == NULL)
3078 g_assert_cmpint (num_path_segments, <, G_N_ELEMENTS (pathv));
3080 return g_build_filenamev ((gchar **) pathv);
3084 * g_test_build_filename:
3085 * @file_type: the type of file (built vs. distributed)
3086 * @first_path: the first segment of the pathname
3087 * @...: %NULL-terminated additional path segments
3089 * Creates the pathname to a data file that is required for a test.
3091 * This function is conceptually similar to g_build_filename() except
3092 * that the first argument has been replaced with a #GTestFileType
3095 * The data file should either have been distributed with the module
3096 * containing the test (%G_TEST_DIST) or built as part of the build
3097 * system of that module (%G_TEST_BUILT).
3099 * In order for this function to work in srcdir != builddir situations,
3100 * the G_TEST_SRCDIR and G_TEST_BUILDDIR environment variables need to
3101 * have been defined. As of 2.38, this is done by the Makefile.decl
3102 * included in GLib. Please ensure that your copy is up to date before
3103 * using this function.
3105 * In case neither variable is set, this function will fall back to
3106 * using the dirname portion of argv[0], possibly removing ".libs".
3107 * This allows for casual running of tests directly from the commandline
3108 * in the srcdir == builddir case and should also support running of
3109 * installed tests, assuming the data files have been installed in the
3110 * same relative path as the test binary.
3112 * Returns: the path of the file, to be freed using g_free()
3118 * @G_TEST_DIST: a file that was included in the distribution tarball
3119 * @G_TEST_BUILT: a file that was built on the compiling machine
3121 * The type of file to return the filename for, when used with
3122 * g_test_build_filename().
3124 * These two options correspond rather directly to the 'dist' and
3125 * 'built' terminology that automake uses and are explicitly used to
3126 * distinguish between the 'srcdir' and 'builddir' being separate. All
3127 * files in your project should either be dist (in the
3128 * <literal>DIST_EXTRA</literal> or <literal>dist_schema_DATA</literal>
3129 * sense, in which case they will always be in the srcdir) or built (in
3130 * the <literal>BUILT_SOURCES</literal> sense, in which case they will
3131 * always be in the builddir).
3133 * Note: as a general rule of automake, files that are generated only as
3134 * part of the build-from-git process (but then are distributed with the
3135 * tarball) always go in srcdir (even if doing a srcdir != builddir
3136 * build from git) and are considered as distributed files.
3141 g_test_build_filename (GTestFileType file_type,
3142 const gchar *first_path,
3148 g_assert (g_test_initialized ());
3150 va_start (ap, first_path);
3151 result = g_test_build_filename_va (file_type, first_path, ap);
3159 * @file_type: the type of file (built vs. distributed)
3161 * Gets the pathname of the directory containing test files of the type
3162 * specified by @file_type.
3164 * This is approximately the same as calling g_test_build_filename("."),
3165 * but you don't need to free the return value.
3167 * Returns: the path of the directory, owned by GLib
3172 g_test_get_dir (GTestFileType file_type)
3174 g_assert (g_test_initialized ());
3176 if (file_type == G_TEST_DIST)
3177 return test_disted_files_dir;
3178 else if (file_type == G_TEST_BUILT)
3179 return test_built_files_dir;
3181 g_assert_not_reached ();
3185 * g_test_get_filename:
3186 * @file_type: the type of file (built vs. distributed)
3187 * @first_path: the first segment of the pathname
3188 * @...: %NULL-terminated additional path segments
3190 * Gets the pathname to a data file that is required for a test.
3192 * This is the same as g_test_build_filename() with two differences.
3193 * The first difference is that must only use this function from within
3194 * a testcase function. The second difference is that you need not free
3195 * the return value -- it will be automatically freed when the testcase
3198 * It is safe to use this function from a thread inside of a testcase
3199 * but you must ensure that all such uses occur before the main testcase
3200 * function returns (ie: it is best to ensure that all threads have been
3203 * Returns: the path, automatically freed at the end of the testcase
3208 g_test_get_filename (GTestFileType file_type,
3209 const gchar *first_path,
3216 g_assert (g_test_initialized ());
3217 if (test_filename_free_list == NULL)
3218 g_error ("g_test_get_filename() can only be used within testcase functions");
3220 va_start (ap, first_path);
3221 result = g_test_build_filename_va (file_type, first_path, ap);
3224 node = g_slist_prepend (NULL, result);
3226 node->next = *test_filename_free_list;
3227 while (!g_atomic_pointer_compare_and_exchange (test_filename_free_list, node->next, node));
3232 /* --- macros docs START --- */
3235 * @testpath: The test path for a new test case.
3236 * @Fixture: The type of a fixture data structure.
3237 * @tdata: Data argument for the test functions.
3238 * @fsetup: The function to set up the fixture data.
3239 * @ftest: The actual test function.
3240 * @fteardown: The function to tear down the fixture data.
3242 * Hook up a new test case at @testpath, similar to g_test_add_func().
3243 * A fixture data structure with setup and teardown function may be provided
3244 * though, similar to g_test_create_case().
3245 * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
3246 * fteardown() callbacks can expect a @Fixture pointer as first argument in
3247 * a type safe manner.
3251 /* --- macros docs END --- */