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 char *__glib_assert_msg = NULL;
501 /* --- constants --- */
502 #define G_TEST_STATUS_TIMED_OUT 1024
504 /* --- structures --- */
509 void (*fixture_setup) (void*, gconstpointer);
510 void (*fixture_test) (void*, gconstpointer);
511 void (*fixture_teardown) (void*, gconstpointer);
520 typedef struct DestroyEntry DestroyEntry;
524 GDestroyNotify destroy_func;
525 gpointer destroy_data;
528 /* --- prototypes --- */
529 static void test_run_seed (const gchar *rseed);
530 static void test_trap_clear (void);
531 static guint8* g_test_log_dump (GTestLogMsg *msg,
533 static void gtest_default_log_handler (const gchar *log_domain,
534 GLogLevelFlags log_level,
535 const gchar *message,
536 gpointer unused_data);
539 /* --- variables --- */
540 static int test_log_fd = -1;
541 static gboolean test_mode_fatal = TRUE;
542 static gboolean g_test_run_once = TRUE;
543 static gboolean test_run_list = FALSE;
544 static gchar *test_run_seedstr = NULL;
545 static GRand *test_run_rand = NULL;
546 static gchar *test_run_name = "";
547 static GSList **test_filename_free_list;
548 static guint test_run_forks = 0;
549 static guint test_run_count = 0;
550 static guint test_run_success = FALSE;
551 static guint test_skip_count = 0;
552 static GTimer *test_user_timer = NULL;
553 static double test_user_stamp = 0;
554 static GSList *test_paths = NULL;
555 static GSList *test_paths_skipped = NULL;
556 static GTestSuite *test_suite_root = NULL;
557 static int test_trap_last_status = 0;
558 static GPid test_trap_last_pid = 0;
559 static char *test_trap_last_subprocess = NULL;
560 static char *test_trap_last_stdout = NULL;
561 static char *test_trap_last_stderr = NULL;
562 static char *test_uri_base = NULL;
563 static gboolean test_debug_log = FALSE;
564 static DestroyEntry *test_destroy_queue = NULL;
565 static char *test_argv0 = NULL;
566 static char *test_argv0_dirname;
567 static const char *test_disted_files_dir;
568 static const char *test_built_files_dir;
569 static char *test_initial_cwd = NULL;
570 static gboolean test_in_subprocess = FALSE;
571 static GTestConfig mutable_test_config_vars = {
572 FALSE, /* test_initialized */
573 TRUE, /* test_quick */
574 FALSE, /* test_perf */
575 FALSE, /* test_verbose */
576 FALSE, /* test_quiet */
577 TRUE, /* test_undefined */
579 const GTestConfig * const g_test_config_vars = &mutable_test_config_vars;
581 /* --- functions --- */
583 g_test_log_type_name (GTestLogType log_type)
587 case G_TEST_LOG_NONE: return "none";
588 case G_TEST_LOG_ERROR: return "error";
589 case G_TEST_LOG_START_BINARY: return "binary";
590 case G_TEST_LOG_LIST_CASE: return "list";
591 case G_TEST_LOG_SKIP_CASE: return "skip";
592 case G_TEST_LOG_START_CASE: return "start";
593 case G_TEST_LOG_STOP_CASE: return "stop";
594 case G_TEST_LOG_MIN_RESULT: return "minperf";
595 case G_TEST_LOG_MAX_RESULT: return "maxperf";
596 case G_TEST_LOG_MESSAGE: return "message";
602 g_test_log_send (guint n_bytes,
603 const guint8 *buffer)
605 if (test_log_fd >= 0)
609 r = write (test_log_fd, buffer, n_bytes);
610 while (r < 0 && errno == EINTR);
614 GTestLogBuffer *lbuffer = g_test_log_buffer_new ();
617 g_test_log_buffer_push (lbuffer, n_bytes, buffer);
618 msg = g_test_log_buffer_pop (lbuffer);
619 g_warn_if_fail (msg != NULL);
620 g_warn_if_fail (lbuffer->data->len == 0);
621 g_test_log_buffer_free (lbuffer);
623 g_printerr ("{*LOG(%s)", g_test_log_type_name (msg->log_type));
624 for (ui = 0; ui < msg->n_strings; ui++)
625 g_printerr (":{%s}", msg->strings[ui]);
629 for (ui = 0; ui < msg->n_nums; ui++)
631 if ((long double) (long) msg->nums[ui] == msg->nums[ui])
632 g_printerr ("%s%ld", ui ? ";" : "", (long) msg->nums[ui]);
634 g_printerr ("%s%.16g", ui ? ";" : "", (double) msg->nums[ui]);
638 g_printerr (":LOG*}\n");
639 g_test_log_msg_free (msg);
644 g_test_log (GTestLogType lbit,
645 const gchar *string1,
646 const gchar *string2,
650 gboolean fail = lbit == G_TEST_LOG_STOP_CASE && largs[0] != 0;
652 gchar *astrings[3] = { NULL, NULL, NULL };
658 case G_TEST_LOG_START_BINARY:
659 if (g_test_verbose())
660 g_print ("GTest: random seed: %s\n", string2);
662 case G_TEST_LOG_STOP_CASE:
663 if (g_test_verbose())
664 g_print ("GTest: result: %s\n", fail ? "FAIL" : "OK");
665 else if (!g_test_quiet())
666 g_print ("%s\n", fail ? "FAIL" : "OK");
667 if (fail && test_mode_fatal)
670 case G_TEST_LOG_MIN_RESULT:
671 if (g_test_verbose())
672 g_print ("(MINPERF:%s)\n", string1);
674 case G_TEST_LOG_MAX_RESULT:
675 if (g_test_verbose())
676 g_print ("(MAXPERF:%s)\n", string1);
678 case G_TEST_LOG_MESSAGE:
679 case G_TEST_LOG_ERROR:
680 if (g_test_verbose())
681 g_print ("(MSG: %s)\n", string1);
687 msg.n_strings = (string1 != NULL) + (string1 && string2);
688 msg.strings = astrings;
689 astrings[0] = (gchar*) string1;
690 astrings[1] = astrings[0] ? (gchar*) string2 : NULL;
693 dbuffer = g_test_log_dump (&msg, &dbufferlen);
694 g_test_log_send (dbufferlen, dbuffer);
699 case G_TEST_LOG_START_CASE:
700 if (g_test_verbose())
701 g_print ("GTest: run: %s\n", string1);
702 else if (!g_test_quiet())
703 g_print ("%s: ", string1);
709 /* We intentionally parse the command line without GOptionContext
710 * because otherwise you would never be able to test it.
713 parse_args (gint *argc_p,
716 guint argc = *argc_p;
717 gchar **argv = *argv_p;
720 test_argv0 = argv[0];
721 test_initial_cwd = g_get_current_dir ();
723 /* parse known args */
724 for (i = 1; i < argc; i++)
726 if (strcmp (argv[i], "--g-fatal-warnings") == 0)
728 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
729 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
730 g_log_set_always_fatal (fatal_mask);
733 else if (strcmp (argv[i], "--keep-going") == 0 ||
734 strcmp (argv[i], "-k") == 0)
736 test_mode_fatal = FALSE;
739 else if (strcmp (argv[i], "--debug-log") == 0)
741 test_debug_log = TRUE;
744 else if (strcmp ("--GTestLogFD", argv[i]) == 0 || strncmp ("--GTestLogFD=", argv[i], 13) == 0)
746 gchar *equal = argv[i] + 12;
748 test_log_fd = g_ascii_strtoull (equal + 1, NULL, 0);
749 else if (i + 1 < argc)
752 test_log_fd = g_ascii_strtoull (argv[i], NULL, 0);
756 else if (strcmp ("--GTestSkipCount", argv[i]) == 0 || strncmp ("--GTestSkipCount=", argv[i], 17) == 0)
758 gchar *equal = argv[i] + 16;
760 test_skip_count = g_ascii_strtoull (equal + 1, NULL, 0);
761 else if (i + 1 < argc)
764 test_skip_count = g_ascii_strtoull (argv[i], NULL, 0);
768 else if (strcmp ("--GTestSubprocess", argv[i]) == 0)
770 test_in_subprocess = TRUE;
771 /* We typically expect these child processes to crash, and some
772 * tests spawn a *lot* of them. Avoid spamming system crash
773 * collection programs such as systemd-coredump and abrt.
775 #ifdef HAVE_SYS_RESOURCE_H
777 struct rlimit limit = { 0, 0 };
778 (void) setrlimit (RLIMIT_CORE, &limit);
781 _g_log_set_exit_on_fatal ();
784 else if (strcmp ("-p", argv[i]) == 0 || strncmp ("-p=", argv[i], 3) == 0)
786 gchar *equal = argv[i] + 2;
788 test_paths = g_slist_prepend (test_paths, equal + 1);
789 else if (i + 1 < argc)
792 test_paths = g_slist_prepend (test_paths, argv[i]);
796 else if (strcmp ("-s", argv[i]) == 0 || strncmp ("-s=", argv[i], 3) == 0)
798 gchar *equal = argv[i] + 2;
800 test_paths_skipped = g_slist_prepend (test_paths_skipped, equal + 1);
801 else if (i + 1 < argc)
804 test_paths_skipped = g_slist_prepend (test_paths_skipped, argv[i]);
808 else if (strcmp ("-m", argv[i]) == 0 || strncmp ("-m=", argv[i], 3) == 0)
810 gchar *equal = argv[i] + 2;
811 const gchar *mode = "";
814 else if (i + 1 < argc)
819 if (strcmp (mode, "perf") == 0)
820 mutable_test_config_vars.test_perf = TRUE;
821 else if (strcmp (mode, "slow") == 0)
822 mutable_test_config_vars.test_quick = FALSE;
823 else if (strcmp (mode, "thorough") == 0)
824 mutable_test_config_vars.test_quick = FALSE;
825 else if (strcmp (mode, "quick") == 0)
827 mutable_test_config_vars.test_quick = TRUE;
828 mutable_test_config_vars.test_perf = FALSE;
830 else if (strcmp (mode, "undefined") == 0)
831 mutable_test_config_vars.test_undefined = TRUE;
832 else if (strcmp (mode, "no-undefined") == 0)
833 mutable_test_config_vars.test_undefined = FALSE;
835 g_error ("unknown test mode: -m %s", mode);
838 else if (strcmp ("-q", argv[i]) == 0 || strcmp ("--quiet", argv[i]) == 0)
840 mutable_test_config_vars.test_quiet = TRUE;
841 mutable_test_config_vars.test_verbose = FALSE;
844 else if (strcmp ("--verbose", argv[i]) == 0)
846 mutable_test_config_vars.test_quiet = FALSE;
847 mutable_test_config_vars.test_verbose = TRUE;
850 else if (strcmp ("-l", argv[i]) == 0)
852 test_run_list = TRUE;
855 else if (strcmp ("--seed", argv[i]) == 0 || strncmp ("--seed=", argv[i], 7) == 0)
857 gchar *equal = argv[i] + 6;
859 test_run_seedstr = equal + 1;
860 else if (i + 1 < argc)
863 test_run_seedstr = argv[i];
867 else if (strcmp ("-?", argv[i]) == 0 ||
868 strcmp ("-h", argv[i]) == 0 ||
869 strcmp ("--help", argv[i]) == 0)
872 " %s [OPTION...]\n\n"
874 " -h, --help Show help options\n\n"
876 " --g-fatal-warnings Make all warnings fatal\n"
877 " -l List test cases available in a test executable\n"
878 " -m {perf|slow|thorough|quick} Execute tests according to mode\n"
879 " -m {undefined|no-undefined} Execute tests according to mode\n"
880 " -p TESTPATH Only start test cases matching TESTPATH\n"
881 " -s TESTPATH Skip all tests matching TESTPATH\n"
882 " -seed=SEEDSTRING Start tests with random seed SEEDSTRING\n"
883 " --debug-log debug test logging output\n"
884 " -q, --quiet Run tests quietly\n"
885 " --verbose Run tests verbosely\n",
892 for (i = 1; i < argc; i++)
904 * @argc: Address of the @argc parameter of the main() function.
905 * Changed if any arguments were handled.
906 * @argv: Address of the @argv parameter of main().
907 * Any parameters understood by g_test_init() stripped before return.
908 * @...: Reserved for future extension. Currently, you must pass %NULL.
910 * Initialize the GLib testing framework, e.g. by seeding the
911 * test random number generator, the name for g_get_prgname()
912 * and parsing test related command line args.
913 * So far, the following arguments are understood:
916 * <term><option>-l</option></term>
918 * List test cases available in a test executable.
922 * <term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
924 * Provide a random seed to reproduce test runs using random numbers.
928 * <term><option>--verbose</option></term>
929 * <listitem><para>Run tests verbosely.</para></listitem>
932 * <term><option>-q</option>, <option>--quiet</option></term>
933 * <listitem><para>Run tests quietly.</para></listitem>
936 * <term><option>-p <replaceable>TESTPATH</replaceable></option></term>
938 * Execute all tests matching <replaceable>TESTPATH</replaceable>.
939 * This can also be used to force a test to run that would otherwise
940 * be skipped (ie, a test whose name contains "/subprocess").
944 * <term><option>-m {perf|slow|thorough|quick|undefined|no-undefined}</option></term>
946 * Execute tests according to these test modes:
951 * Performance tests, may take long and report results.
955 * <term>slow, thorough</term>
957 * Slow and thorough tests, may take quite long and
964 * Quick tests, should run really quickly and give good coverage.
968 * <term>undefined</term>
970 * Tests for undefined behaviour, may provoke programming errors
971 * under g_test_trap_subprocess() or g_test_expect_messages() to check
972 * that appropriate assertions or warnings are given
976 * <term>no-undefined</term>
978 * Avoid tests for undefined behaviour
985 * <term><option>--debug-log</option></term>
986 * <listitem><para>Debug test logging output.</para></listitem>
993 g_test_init (int *argc,
997 static char seedstr[4 + 4 * 8 + 1];
1000 /* make warnings and criticals fatal for all test programs */
1001 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
1002 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
1003 g_log_set_always_fatal (fatal_mask);
1004 /* check caller args */
1005 g_return_if_fail (argc != NULL);
1006 g_return_if_fail (argv != NULL);
1007 g_return_if_fail (g_test_config_vars->test_initialized == FALSE);
1008 mutable_test_config_vars.test_initialized = TRUE;
1010 va_start (args, argv);
1011 vararg1 = va_arg (args, gpointer); /* reserved for future extensions */
1013 g_return_if_fail (vararg1 == NULL);
1015 /* setup random seed string */
1016 g_snprintf (seedstr, sizeof (seedstr), "R02S%08x%08x%08x%08x", g_random_int(), g_random_int(), g_random_int(), g_random_int());
1017 test_run_seedstr = seedstr;
1019 /* parse args, sets up mode, changes seed, etc. */
1020 parse_args (argc, argv);
1021 if (!g_get_prgname())
1022 g_set_prgname ((*argv)[0]);
1024 /* verify GRand reliability, needed for reliable seeds */
1027 GRand *rg = g_rand_new_with_seed (0xc8c49fb6);
1028 guint32 t1 = g_rand_int (rg), t2 = g_rand_int (rg), t3 = g_rand_int (rg), t4 = g_rand_int (rg);
1029 /* g_print ("GRand-current: 0x%x 0x%x 0x%x 0x%x\n", t1, t2, t3, t4); */
1030 if (t1 != 0xfab39f9b || t2 != 0xb948fb0e || t3 != 0x3d31be26 || t4 != 0x43a19d66)
1031 g_warning ("random numbers are not GRand-2.2 compatible, seeds may be broken (check $G_RANDOM_VERSION)");
1035 /* check rand seed */
1036 test_run_seed (test_run_seedstr);
1038 /* report program start */
1039 g_log_set_default_handler (gtest_default_log_handler, NULL);
1040 g_test_log (G_TEST_LOG_START_BINARY, g_get_prgname(), test_run_seedstr, 0, NULL);
1042 test_argv0_dirname = g_path_get_dirname (test_argv0);
1044 /* Make sure we get the real dirname that the test was run from */
1045 if (g_str_has_suffix (test_argv0_dirname, "/.libs"))
1048 tmp = g_path_get_dirname (test_argv0_dirname);
1049 g_free (test_argv0_dirname);
1050 test_argv0_dirname = tmp;
1053 test_disted_files_dir = g_getenv ("G_TEST_SRCDIR");
1054 if (!test_disted_files_dir)
1055 test_disted_files_dir = test_argv0_dirname;
1057 test_built_files_dir = g_getenv ("G_TEST_BUILDDIR");
1058 if (!test_built_files_dir)
1059 test_built_files_dir = test_argv0_dirname;
1063 test_run_seed (const gchar *rseed)
1065 guint seed_failed = 0;
1067 g_rand_free (test_run_rand);
1068 test_run_rand = NULL;
1069 while (strchr (" \t\v\r\n\f", *rseed))
1071 if (strncmp (rseed, "R02S", 4) == 0) /* seed for random generator 02 (GRand-2.2) */
1073 const char *s = rseed + 4;
1074 if (strlen (s) >= 32) /* require 4 * 8 chars */
1076 guint32 seedarray[4];
1077 gchar *p, hexbuf[9] = { 0, };
1078 memcpy (hexbuf, s + 0, 8);
1079 seedarray[0] = g_ascii_strtoull (hexbuf, &p, 16);
1080 seed_failed += p != NULL && *p != 0;
1081 memcpy (hexbuf, s + 8, 8);
1082 seedarray[1] = g_ascii_strtoull (hexbuf, &p, 16);
1083 seed_failed += p != NULL && *p != 0;
1084 memcpy (hexbuf, s + 16, 8);
1085 seedarray[2] = g_ascii_strtoull (hexbuf, &p, 16);
1086 seed_failed += p != NULL && *p != 0;
1087 memcpy (hexbuf, s + 24, 8);
1088 seedarray[3] = g_ascii_strtoull (hexbuf, &p, 16);
1089 seed_failed += p != NULL && *p != 0;
1092 test_run_rand = g_rand_new_with_seed_array (seedarray, 4);
1097 g_error ("Unknown or invalid random seed: %s", rseed);
1103 * Get a reproducible random integer number.
1105 * The random numbers generated by the g_test_rand_*() family of functions
1106 * change with every new test program start, unless the --seed option is
1107 * given when starting test programs.
1109 * For individual test cases however, the random number generator is
1110 * reseeded, to avoid dependencies between tests and to make --seed
1111 * effective for all test cases.
1113 * Returns: a random number from the seeded random number generator.
1118 g_test_rand_int (void)
1120 return g_rand_int (test_run_rand);
1124 * g_test_rand_int_range:
1125 * @begin: the minimum value returned by this function
1126 * @end: the smallest value not to be returned by this function
1128 * Get a reproducible random integer number out of a specified range,
1129 * see g_test_rand_int() for details on test case random numbers.
1131 * Returns: a number with @begin <= number < @end.
1136 g_test_rand_int_range (gint32 begin,
1139 return g_rand_int_range (test_run_rand, begin, end);
1143 * g_test_rand_double:
1145 * Get a reproducible random floating point number,
1146 * see g_test_rand_int() for details on test case random numbers.
1148 * Returns: a random number from the seeded random number generator.
1153 g_test_rand_double (void)
1155 return g_rand_double (test_run_rand);
1159 * g_test_rand_double_range:
1160 * @range_start: the minimum value returned by this function
1161 * @range_end: the minimum value not returned by this function
1163 * Get a reproducible random floating pointer number out of a specified range,
1164 * see g_test_rand_int() for details on test case random numbers.
1166 * Returns: a number with @range_start <= number < @range_end.
1171 g_test_rand_double_range (double range_start,
1174 return g_rand_double_range (test_run_rand, range_start, range_end);
1178 * g_test_timer_start:
1180 * Start a timing test. Call g_test_timer_elapsed() when the task is supposed
1181 * to be done. Call this function again to restart the timer.
1186 g_test_timer_start (void)
1188 if (!test_user_timer)
1189 test_user_timer = g_timer_new();
1190 test_user_stamp = 0;
1191 g_timer_start (test_user_timer);
1195 * g_test_timer_elapsed:
1197 * Get the time since the last start of the timer with g_test_timer_start().
1199 * Returns: the time since the last start of the timer, as a double
1204 g_test_timer_elapsed (void)
1206 test_user_stamp = test_user_timer ? g_timer_elapsed (test_user_timer, NULL) : 0;
1207 return test_user_stamp;
1211 * g_test_timer_last:
1213 * Report the last result of g_test_timer_elapsed().
1215 * Returns: the last result of g_test_timer_elapsed(), as a double
1220 g_test_timer_last (void)
1222 return test_user_stamp;
1226 * g_test_minimized_result:
1227 * @minimized_quantity: the reported value
1228 * @format: the format string of the report message
1229 * @...: arguments to pass to the printf() function
1231 * Report the result of a performance or measurement test.
1232 * The test should generally strive to minimize the reported
1233 * quantities (smaller values are better than larger ones),
1234 * this and @minimized_quantity can determine sorting
1235 * order for test result reports.
1240 g_test_minimized_result (double minimized_quantity,
1244 long double largs = minimized_quantity;
1248 va_start (args, format);
1249 buffer = g_strdup_vprintf (format, args);
1252 g_test_log (G_TEST_LOG_MIN_RESULT, buffer, NULL, 1, &largs);
1257 * g_test_maximized_result:
1258 * @maximized_quantity: the reported value
1259 * @format: the format string of the report message
1260 * @...: arguments to pass to the printf() function
1262 * Report the result of a performance or measurement test.
1263 * The test should generally strive to maximize the reported
1264 * quantities (larger values are better than smaller ones),
1265 * this and @maximized_quantity can determine sorting
1266 * order for test result reports.
1271 g_test_maximized_result (double maximized_quantity,
1275 long double largs = maximized_quantity;
1279 va_start (args, format);
1280 buffer = g_strdup_vprintf (format, args);
1283 g_test_log (G_TEST_LOG_MAX_RESULT, buffer, NULL, 1, &largs);
1289 * @format: the format string
1290 * @...: printf-like arguments to @format
1292 * Add a message to the test report.
1297 g_test_message (const char *format,
1303 va_start (args, format);
1304 buffer = g_strdup_vprintf (format, args);
1307 g_test_log (G_TEST_LOG_MESSAGE, buffer, NULL, 0, NULL);
1313 * @uri_pattern: the base pattern for bug URIs
1315 * Specify the base URI for bug reports.
1317 * The base URI is used to construct bug report messages for
1318 * g_test_message() when g_test_bug() is called.
1319 * Calling this function outside of a test case sets the
1320 * default base URI for all test cases. Calling it from within
1321 * a test case changes the base URI for the scope of the test
1323 * Bug URIs are constructed by appending a bug specific URI
1324 * portion to @uri_pattern, or by replacing the special string
1325 * '\%s' within @uri_pattern if that is present.
1330 g_test_bug_base (const char *uri_pattern)
1332 g_free (test_uri_base);
1333 test_uri_base = g_strdup (uri_pattern);
1338 * @bug_uri_snippet: Bug specific bug tracker URI portion.
1340 * This function adds a message to test reports that
1341 * associates a bug URI with a test case.
1342 * Bug URIs are constructed from a base URI set with g_test_bug_base()
1343 * and @bug_uri_snippet.
1348 g_test_bug (const char *bug_uri_snippet)
1352 g_return_if_fail (test_uri_base != NULL);
1353 g_return_if_fail (bug_uri_snippet != NULL);
1355 c = strstr (test_uri_base, "%s");
1358 char *b = g_strndup (test_uri_base, c - test_uri_base);
1359 char *s = g_strconcat (b, bug_uri_snippet, c + 2, NULL);
1361 g_test_message ("Bug Reference: %s", s);
1365 g_test_message ("Bug Reference: %s%s", test_uri_base, bug_uri_snippet);
1371 * Get the toplevel test suite for the test path API.
1373 * Returns: the toplevel #GTestSuite
1378 g_test_get_root (void)
1380 if (!test_suite_root)
1382 test_suite_root = g_test_create_suite ("root");
1383 g_free (test_suite_root->name);
1384 test_suite_root->name = g_strdup ("");
1387 return test_suite_root;
1393 * Runs all tests under the toplevel suite which can be retrieved
1394 * with g_test_get_root(). Similar to g_test_run_suite(), the test
1395 * cases to be run are filtered according to
1396 * test path arguments (-p <replaceable>testpath</replaceable>) as
1397 * parsed by g_test_init().
1398 * g_test_run_suite() or g_test_run() may only be called once
1401 * Returns: 0 on success
1408 return g_test_run_suite (g_test_get_root());
1412 * g_test_create_case:
1413 * @test_name: the name for the test case
1414 * @data_size: the size of the fixture data structure
1415 * @test_data: test data argument for the test functions
1416 * @data_setup: the function to set up the fixture data
1417 * @data_test: the actual test function
1418 * @data_teardown: the function to teardown the fixture data
1420 * Create a new #GTestCase, named @test_name, this API is fairly
1421 * low level, calling g_test_add() or g_test_add_func() is preferable.
1422 * When this test is executed, a fixture structure of size @data_size
1423 * will be allocated and filled with 0s. Then @data_setup is called
1424 * to initialize the fixture. After fixture setup, the actual test
1425 * function @data_test is called. Once the test run completed, the
1426 * fixture structure is torn down by calling @data_teardown and
1427 * after that the memory is released.
1429 * Splitting up a test run into fixture setup, test function and
1430 * fixture teardown is most usful if the same fixture is used for
1431 * multiple tests. In this cases, g_test_create_case() will be
1432 * called with the same fixture, but varying @test_name and
1433 * @data_test arguments.
1435 * Returns: a newly allocated #GTestCase.
1440 g_test_create_case (const char *test_name,
1442 gconstpointer test_data,
1443 GTestFixtureFunc data_setup,
1444 GTestFixtureFunc data_test,
1445 GTestFixtureFunc data_teardown)
1449 g_return_val_if_fail (test_name != NULL, NULL);
1450 g_return_val_if_fail (strchr (test_name, '/') == NULL, NULL);
1451 g_return_val_if_fail (test_name[0] != 0, NULL);
1452 g_return_val_if_fail (data_test != NULL, NULL);
1454 tc = g_slice_new0 (GTestCase);
1455 tc->name = g_strdup (test_name);
1456 tc->test_data = (gpointer) test_data;
1457 tc->fixture_size = data_size;
1458 tc->fixture_setup = (void*) data_setup;
1459 tc->fixture_test = (void*) data_test;
1460 tc->fixture_teardown = (void*) data_teardown;
1466 find_suite (gconstpointer l, gconstpointer s)
1468 const GTestSuite *suite = l;
1469 const gchar *str = s;
1471 return strcmp (suite->name, str);
1476 * @fixture: the test fixture
1477 * @user_data: the data provided when registering the test
1479 * The type used for functions that operate on test fixtures. This is
1480 * used for the fixture setup and teardown functions as well as for the
1481 * testcases themselves.
1483 * @user_data is a pointer to the data that was given when registering
1486 * @fixture will be a pointer to the area of memory allocated by the
1487 * test framework, of the size requested. If the requested size was
1488 * zero then @fixture will be equal to @user_data.
1493 g_test_add_vtable (const char *testpath,
1495 gconstpointer test_data,
1496 GTestFixtureFunc data_setup,
1497 GTestFixtureFunc fixture_test_func,
1498 GTestFixtureFunc data_teardown)
1504 g_return_if_fail (testpath != NULL);
1505 g_return_if_fail (g_path_is_absolute (testpath));
1506 g_return_if_fail (fixture_test_func != NULL);
1508 if (g_slist_find_custom (test_paths_skipped, testpath, (GCompareFunc)g_strcmp0))
1511 suite = g_test_get_root();
1512 segments = g_strsplit (testpath, "/", -1);
1513 for (ui = 0; segments[ui] != NULL; ui++)
1515 const char *seg = segments[ui];
1516 gboolean islast = segments[ui + 1] == NULL;
1517 if (islast && !seg[0])
1518 g_error ("invalid test case path: %s", testpath);
1520 continue; /* initial or duplicate slash */
1525 l = g_slist_find_custom (suite->suites, seg, find_suite);
1532 csuite = g_test_create_suite (seg);
1533 g_test_suite_add_suite (suite, csuite);
1539 GTestCase *tc = g_test_create_case (seg, data_size, test_data, data_setup, fixture_test_func, data_teardown);
1540 g_test_suite_add (suite, tc);
1543 g_strfreev (segments);
1549 * Indicates that a test failed. This function can be called
1550 * multiple times from the same test. You can use this function
1551 * if your test failed in a recoverable way.
1553 * Do not use this function if the failure of a test could cause
1554 * other tests to malfunction.
1556 * Calling this function will not stop the test from running, you
1557 * need to return from the test function yourself. So you can
1558 * produce additional diagnostic messages or even continue running
1561 * If not called from inside a test, this function does nothing.
1568 test_run_success = FALSE;
1574 * The type used for test case functions.
1581 * @testpath: /-separated test case path name for the test.
1582 * @test_func: The test function to invoke for this test.
1584 * Create a new test case, similar to g_test_create_case(). However
1585 * the test is assumed to use no fixture, and test suites are automatically
1586 * created on the fly and added to the root fixture, based on the
1587 * slash-separated portions of @testpath.
1589 * If @testpath includes the component "subprocess" anywhere in it,
1590 * the test will be skipped by default, and only run if explicitly
1591 * required via the <option>-p</option> command-line option or
1592 * g_test_trap_subprocess().
1597 g_test_add_func (const char *testpath,
1598 GTestFunc test_func)
1600 g_return_if_fail (testpath != NULL);
1601 g_return_if_fail (testpath[0] == '/');
1602 g_return_if_fail (test_func != NULL);
1603 g_test_add_vtable (testpath, 0, NULL, NULL, (GTestFixtureFunc) test_func, NULL);
1608 * @user_data: the data provided when registering the test
1610 * The type used for test case functions that take an extra pointer
1617 * g_test_add_data_func:
1618 * @testpath: /-separated test case path name for the test.
1619 * @test_data: Test data argument for the test function.
1620 * @test_func: The test function to invoke for this test.
1622 * Create a new test case, similar to g_test_create_case(). However
1623 * the test is assumed to use no fixture, and test suites are automatically
1624 * created on the fly and added to the root fixture, based on the
1625 * slash-separated portions of @testpath. The @test_data argument
1626 * will be passed as first argument to @test_func.
1628 * If @testpath includes the component "subprocess" anywhere in it,
1629 * the test will be skipped by default, and only run if explicitly
1630 * required via the <option>-p</option> command-line option or
1631 * g_test_trap_subprocess().
1636 g_test_add_data_func (const char *testpath,
1637 gconstpointer test_data,
1638 GTestDataFunc test_func)
1640 g_return_if_fail (testpath != NULL);
1641 g_return_if_fail (testpath[0] == '/');
1642 g_return_if_fail (test_func != NULL);
1644 g_test_add_vtable (testpath, 0, test_data, NULL, (GTestFixtureFunc) test_func, NULL);
1648 * g_test_add_data_func_full:
1649 * @testpath: /-separated test case path name for the test.
1650 * @test_data: Test data argument for the test function.
1651 * @test_func: The test function to invoke for this test.
1652 * @data_free_func: #GDestroyNotify for @test_data.
1654 * Create a new test case, as with g_test_add_data_func(), but freeing
1655 * @test_data after the test run is complete.
1660 g_test_add_data_func_full (const char *testpath,
1662 GTestDataFunc test_func,
1663 GDestroyNotify data_free_func)
1665 g_return_if_fail (testpath != NULL);
1666 g_return_if_fail (testpath[0] == '/');
1667 g_return_if_fail (test_func != NULL);
1669 g_test_add_vtable (testpath, 0, test_data, NULL,
1670 (GTestFixtureFunc) test_func,
1671 (GTestFixtureFunc) data_free_func);
1675 g_test_suite_case_exists (GTestSuite *suite,
1676 const char *test_path)
1683 slash = strchr (test_path, '/');
1687 for (iter = suite->suites; iter; iter = iter->next)
1689 GTestSuite *child_suite = iter->data;
1691 if (!strncmp (child_suite->name, test_path, slash - test_path))
1692 if (g_test_suite_case_exists (child_suite, slash))
1698 for (iter = suite->cases; iter; iter = iter->next)
1701 if (!strcmp (tc->name, test_path))
1710 * g_test_create_suite:
1711 * @suite_name: a name for the suite
1713 * Create a new test suite with the name @suite_name.
1715 * Returns: A newly allocated #GTestSuite instance.
1720 g_test_create_suite (const char *suite_name)
1723 g_return_val_if_fail (suite_name != NULL, NULL);
1724 g_return_val_if_fail (strchr (suite_name, '/') == NULL, NULL);
1725 g_return_val_if_fail (suite_name[0] != 0, NULL);
1726 ts = g_slice_new0 (GTestSuite);
1727 ts->name = g_strdup (suite_name);
1733 * @suite: a #GTestSuite
1734 * @test_case: a #GTestCase
1736 * Adds @test_case to @suite.
1741 g_test_suite_add (GTestSuite *suite,
1742 GTestCase *test_case)
1744 g_return_if_fail (suite != NULL);
1745 g_return_if_fail (test_case != NULL);
1747 suite->cases = g_slist_prepend (suite->cases, test_case);
1751 * g_test_suite_add_suite:
1752 * @suite: a #GTestSuite
1753 * @nestedsuite: another #GTestSuite
1755 * Adds @nestedsuite to @suite.
1760 g_test_suite_add_suite (GTestSuite *suite,
1761 GTestSuite *nestedsuite)
1763 g_return_if_fail (suite != NULL);
1764 g_return_if_fail (nestedsuite != NULL);
1766 suite->suites = g_slist_prepend (suite->suites, nestedsuite);
1770 * g_test_queue_free:
1771 * @gfree_pointer: the pointer to be stored.
1773 * Enqueue a pointer to be released with g_free() during the next
1774 * teardown phase. This is equivalent to calling g_test_queue_destroy()
1775 * with a destroy callback of g_free().
1780 g_test_queue_free (gpointer gfree_pointer)
1783 g_test_queue_destroy (g_free, gfree_pointer);
1787 * g_test_queue_destroy:
1788 * @destroy_func: Destroy callback for teardown phase.
1789 * @destroy_data: Destroy callback data.
1791 * This function enqueus a callback @destroy_func to be executed
1792 * during the next test case teardown phase. This is most useful
1793 * to auto destruct allocted test resources at the end of a test run.
1794 * Resources are released in reverse queue order, that means enqueueing
1795 * callback A before callback B will cause B() to be called before
1796 * A() during teardown.
1801 g_test_queue_destroy (GDestroyNotify destroy_func,
1802 gpointer destroy_data)
1804 DestroyEntry *dentry;
1806 g_return_if_fail (destroy_func != NULL);
1808 dentry = g_slice_new0 (DestroyEntry);
1809 dentry->destroy_func = destroy_func;
1810 dentry->destroy_data = destroy_data;
1811 dentry->next = test_destroy_queue;
1812 test_destroy_queue = dentry;
1816 test_case_run (GTestCase *tc)
1818 gchar *old_name = test_run_name, *old_base = g_strdup (test_uri_base);
1819 GSList **old_free_list, *filename_free_list = NULL;
1820 gboolean success = TRUE;
1822 old_free_list = test_filename_free_list;
1823 test_filename_free_list = &filename_free_list;
1825 test_run_name = g_strconcat (old_name, "/", tc->name, NULL);
1826 if (strstr (test_run_name, "/subprocess"))
1829 gboolean found = FALSE;
1831 for (iter = test_paths; iter; iter = iter->next)
1833 if (!strcmp (test_run_name, iter->data))
1842 if (g_test_verbose ())
1843 g_print ("GTest: skipping: %s\n", test_run_name);
1848 if (++test_run_count <= test_skip_count)
1849 g_test_log (G_TEST_LOG_SKIP_CASE, test_run_name, NULL, 0, NULL);
1850 else if (test_run_list)
1852 g_print ("%s\n", test_run_name);
1853 g_test_log (G_TEST_LOG_LIST_CASE, test_run_name, NULL, 0, NULL);
1857 GTimer *test_run_timer = g_timer_new();
1858 long double largs[3];
1860 g_test_log (G_TEST_LOG_START_CASE, test_run_name, NULL, 0, NULL);
1862 test_run_success = TRUE;
1863 g_test_log_set_fatal_handler (NULL, NULL);
1864 g_timer_start (test_run_timer);
1865 fixture = tc->fixture_size ? g_malloc0 (tc->fixture_size) : tc->test_data;
1866 test_run_seed (test_run_seedstr);
1867 if (tc->fixture_setup)
1868 tc->fixture_setup (fixture, tc->test_data);
1869 tc->fixture_test (fixture, tc->test_data);
1871 while (test_destroy_queue)
1873 DestroyEntry *dentry = test_destroy_queue;
1874 test_destroy_queue = dentry->next;
1875 dentry->destroy_func (dentry->destroy_data);
1876 g_slice_free (DestroyEntry, dentry);
1878 if (tc->fixture_teardown)
1879 tc->fixture_teardown (fixture, tc->test_data);
1880 if (tc->fixture_size)
1882 g_timer_stop (test_run_timer);
1883 success = test_run_success;
1884 test_run_success = FALSE;
1885 largs[0] = success ? 0 : 1; /* OK */
1886 largs[1] = test_run_forks;
1887 largs[2] = g_timer_elapsed (test_run_timer, NULL);
1888 g_test_log (G_TEST_LOG_STOP_CASE, NULL, NULL, G_N_ELEMENTS (largs), largs);
1889 g_timer_destroy (test_run_timer);
1893 g_slist_free_full (filename_free_list, g_free);
1894 test_filename_free_list = old_free_list;
1895 g_free (test_run_name);
1896 test_run_name = old_name;
1897 g_free (test_uri_base);
1898 test_uri_base = old_base;
1904 g_test_run_suite_internal (GTestSuite *suite,
1908 gchar *rest, *old_name = test_run_name;
1909 GSList *slist, *reversed;
1911 g_return_val_if_fail (suite != NULL, -1);
1913 while (path[0] == '/')
1916 rest = strchr (path, '/');
1917 l = rest ? MIN (l, rest - path) : l;
1918 test_run_name = suite->name[0] == 0 ? g_strdup (test_run_name) : g_strconcat (old_name, "/", suite->name, NULL);
1919 reversed = g_slist_reverse (g_slist_copy (suite->cases));
1920 for (slist = reversed; slist; slist = slist->next)
1922 GTestCase *tc = slist->data;
1923 guint n = l ? strlen (tc->name) : 0;
1924 if (l == n && !rest && strncmp (path, tc->name, n) == 0)
1926 if (!test_case_run (tc))
1930 g_slist_free (reversed);
1931 reversed = g_slist_reverse (g_slist_copy (suite->suites));
1932 for (slist = reversed; slist; slist = slist->next)
1934 GTestSuite *ts = slist->data;
1935 guint n = l ? strlen (ts->name) : 0;
1936 if (l == n && strncmp (path, ts->name, n) == 0)
1937 n_bad += g_test_run_suite_internal (ts, rest ? rest : "");
1939 g_slist_free (reversed);
1940 g_free (test_run_name);
1941 test_run_name = old_name;
1948 * @suite: a #GTestSuite
1950 * Execute the tests within @suite and all nested #GTestSuites.
1951 * The test suites to be executed are filtered according to
1952 * test path arguments (-p <replaceable>testpath</replaceable>)
1953 * as parsed by g_test_init().
1954 * g_test_run_suite() or g_test_run() may only be called once
1957 * Returns: 0 on success
1962 g_test_run_suite (GTestSuite *suite)
1964 GSList *my_test_paths;
1967 g_return_val_if_fail (g_test_config_vars->test_initialized, -1);
1968 g_return_val_if_fail (g_test_run_once == TRUE, -1);
1970 g_test_run_once = FALSE;
1973 my_test_paths = g_slist_copy (test_paths);
1975 my_test_paths = g_slist_prepend (NULL, "");
1977 while (my_test_paths)
1979 const char *rest, *path = my_test_paths->data;
1980 guint l, n = strlen (suite->name);
1981 my_test_paths = g_slist_delete_link (my_test_paths, my_test_paths);
1982 while (path[0] == '/')
1984 if (!n) /* root suite, run unconditionally */
1986 n_bad += g_test_run_suite_internal (suite, path);
1989 /* regular suite, match path */
1990 rest = strchr (path, '/');
1992 l = rest ? MIN (l, rest - path) : l;
1993 if ((!l || l == n) && strncmp (path, suite->name, n) == 0)
1994 n_bad += g_test_run_suite_internal (suite, rest ? rest : "");
2001 gtest_default_log_handler (const gchar *log_domain,
2002 GLogLevelFlags log_level,
2003 const gchar *message,
2004 gpointer unused_data)
2006 const gchar *strv[16];
2007 gboolean fatal = FALSE;
2013 strv[i++] = log_domain;
2016 if (log_level & G_LOG_FLAG_FATAL)
2018 strv[i++] = "FATAL-";
2021 if (log_level & G_LOG_FLAG_RECURSION)
2022 strv[i++] = "RECURSIVE-";
2023 if (log_level & G_LOG_LEVEL_ERROR)
2024 strv[i++] = "ERROR";
2025 if (log_level & G_LOG_LEVEL_CRITICAL)
2026 strv[i++] = "CRITICAL";
2027 if (log_level & G_LOG_LEVEL_WARNING)
2028 strv[i++] = "WARNING";
2029 if (log_level & G_LOG_LEVEL_MESSAGE)
2030 strv[i++] = "MESSAGE";
2031 if (log_level & G_LOG_LEVEL_INFO)
2033 if (log_level & G_LOG_LEVEL_DEBUG)
2034 strv[i++] = "DEBUG";
2036 strv[i++] = message;
2039 msg = g_strjoinv ("", (gchar**) strv);
2040 g_test_log (fatal ? G_TEST_LOG_ERROR : G_TEST_LOG_MESSAGE, msg, NULL, 0, NULL);
2041 g_log_default_handler (log_domain, log_level, message, unused_data);
2047 g_assertion_message (const char *domain,
2051 const char *message)
2057 message = "code should not be reached";
2058 g_snprintf (lstr, 32, "%d", line);
2059 s = g_strconcat (domain ? domain : "", domain && domain[0] ? ":" : "",
2060 "ERROR:", file, ":", lstr, ":",
2061 func, func[0] ? ":" : "",
2062 " ", message, NULL);
2063 g_printerr ("**\n%s\n", s);
2065 /* store assertion message in global variable, so that it can be found in a
2067 if (__glib_assert_msg != NULL)
2068 /* free the old one */
2069 free (__glib_assert_msg);
2070 __glib_assert_msg = (char*) malloc (strlen (s) + 1);
2071 strcpy (__glib_assert_msg, s);
2073 g_test_log (G_TEST_LOG_ERROR, s, NULL, 0, NULL);
2079 g_assertion_message_expr (const char *domain,
2085 char *s = g_strconcat ("assertion failed: (", expr, ")", NULL);
2086 g_assertion_message (domain, file, line, func, s);
2091 g_assertion_message_cmpnum (const char *domain,
2105 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;
2106 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;
2107 case 'f': s = g_strdup_printf ("assertion failed (%s): (%.9g %s %.9g)", expr, (double) arg1, cmp, (double) arg2); break;
2108 /* ideally use: floats=%.7g double=%.17g */
2110 g_assertion_message (domain, file, line, func, s);
2115 g_assertion_message_cmpstr (const char *domain,
2124 char *a1, *a2, *s, *t1 = NULL, *t2 = NULL;
2125 a1 = arg1 ? g_strconcat ("\"", t1 = g_strescape (arg1, NULL), "\"", NULL) : g_strdup ("NULL");
2126 a2 = arg2 ? g_strconcat ("\"", t2 = g_strescape (arg2, NULL), "\"", NULL) : g_strdup ("NULL");
2129 s = g_strdup_printf ("assertion failed (%s): (%s %s %s)", expr, a1, cmp, a2);
2132 g_assertion_message (domain, file, line, func, s);
2137 g_assertion_message_error (const char *domain,
2142 const GError *error,
2143 GQuark error_domain,
2148 /* This is used by both g_assert_error() and g_assert_no_error(), so there
2149 * are three cases: expected an error but got the wrong error, expected
2150 * an error but got no error, and expected no error but got an error.
2153 gstring = g_string_new ("assertion failed ");
2155 g_string_append_printf (gstring, "(%s == (%s, %d)): ", expr,
2156 g_quark_to_string (error_domain), error_code);
2158 g_string_append_printf (gstring, "(%s == NULL): ", expr);
2161 g_string_append_printf (gstring, "%s (%s, %d)", error->message,
2162 g_quark_to_string (error->domain), error->code);
2164 g_string_append_printf (gstring, "%s is NULL", expr);
2166 g_assertion_message (domain, file, line, func, gstring->str);
2167 g_string_free (gstring, TRUE);
2172 * @str1: (allow-none): a C string or %NULL
2173 * @str2: (allow-none): another C string or %NULL
2175 * Compares @str1 and @str2 like strcmp(). Handles %NULL
2176 * gracefully by sorting it before non-%NULL strings.
2177 * Comparing two %NULL pointers returns 0.
2179 * Returns: an integer less than, equal to, or greater than zero, if @str1 is <, == or > than @str2.
2184 g_strcmp0 (const char *str1,
2188 return -(str1 != str2);
2190 return str1 != str2;
2191 return strcmp (str1, str2);
2195 test_trap_clear (void)
2197 test_trap_last_status = 0;
2198 test_trap_last_pid = 0;
2199 g_clear_pointer (&test_trap_last_subprocess, g_free);
2200 g_clear_pointer (&test_trap_last_stdout, g_free);
2201 g_clear_pointer (&test_trap_last_stderr, g_free);
2212 ret = dup2 (fd1, fd2);
2213 while (ret < 0 && errno == EINTR);
2224 GIOChannel *stdout_io;
2225 gboolean echo_stdout;
2226 GString *stdout_str;
2228 GIOChannel *stderr_io;
2229 gboolean echo_stderr;
2230 GString *stderr_str;
2234 check_complete (WaitForChildData *data)
2236 if (data->child_status != -1 && data->stdout_io == NULL && data->stderr_io == NULL)
2237 g_main_loop_quit (data->loop);
2241 child_exited (GPid pid,
2245 WaitForChildData *data = user_data;
2248 if (WIFEXITED (status)) /* normal exit */
2249 data->child_status = WEXITSTATUS (status); /* 0..255 */
2250 else if (WIFSIGNALED (status) && WTERMSIG (status) == SIGALRM)
2251 data->child_status = G_TEST_STATUS_TIMED_OUT;
2252 else if (WIFSIGNALED (status))
2253 data->child_status = (WTERMSIG (status) << 12); /* signalled */
2254 else /* WCOREDUMP (status) */
2255 data->child_status = 512; /* coredump */
2257 data->child_status = status;
2260 check_complete (data);
2264 child_timeout (gpointer user_data)
2266 WaitForChildData *data = user_data;
2269 TerminateProcess (data->pid, G_TEST_STATUS_TIMED_OUT);
2271 kill (data->pid, SIGALRM);
2278 child_read (GIOChannel *io, GIOCondition cond, gpointer user_data)
2280 WaitForChildData *data = user_data;
2282 gsize nread, nwrote, total;
2284 FILE *echo_file = NULL;
2286 status = g_io_channel_read_chars (io, buf, sizeof (buf), &nread, NULL);
2287 if (status == G_IO_STATUS_ERROR || status == G_IO_STATUS_EOF)
2289 // FIXME data->error = (status == G_IO_STATUS_ERROR);
2290 if (io == data->stdout_io)
2291 g_clear_pointer (&data->stdout_io, g_io_channel_unref);
2293 g_clear_pointer (&data->stderr_io, g_io_channel_unref);
2295 check_complete (data);
2298 else if (status == G_IO_STATUS_AGAIN)
2301 if (io == data->stdout_io)
2303 g_string_append_len (data->stdout_str, buf, nread);
2304 if (data->echo_stdout)
2309 g_string_append_len (data->stderr_str, buf, nread);
2310 if (data->echo_stderr)
2316 for (total = 0; total < nread; total += nwrote)
2318 nwrote = fwrite (buf + total, 1, nread - total, echo_file);
2320 g_error ("write failed: %s", g_strerror (errno));
2328 wait_for_child (GPid pid,
2329 int stdout_fd, gboolean echo_stdout,
2330 int stderr_fd, gboolean echo_stderr,
2333 WaitForChildData data;
2334 GMainContext *context;
2338 data.child_status = -1;
2340 context = g_main_context_new ();
2341 data.loop = g_main_loop_new (context, FALSE);
2343 source = g_child_watch_source_new (pid);
2344 g_source_set_callback (source, (GSourceFunc) child_exited, &data, NULL);
2345 g_source_attach (source, context);
2346 g_source_unref (source);
2348 data.echo_stdout = echo_stdout;
2349 data.stdout_str = g_string_new (NULL);
2350 data.stdout_io = g_io_channel_unix_new (stdout_fd);
2351 g_io_channel_set_close_on_unref (data.stdout_io, TRUE);
2352 g_io_channel_set_encoding (data.stdout_io, NULL, NULL);
2353 g_io_channel_set_buffered (data.stdout_io, FALSE);
2354 source = g_io_create_watch (data.stdout_io, G_IO_IN | G_IO_ERR | G_IO_HUP);
2355 g_source_set_callback (source, (GSourceFunc) child_read, &data, NULL);
2356 g_source_attach (source, context);
2357 g_source_unref (source);
2359 data.echo_stderr = echo_stderr;
2360 data.stderr_str = g_string_new (NULL);
2361 data.stderr_io = g_io_channel_unix_new (stderr_fd);
2362 g_io_channel_set_close_on_unref (data.stderr_io, TRUE);
2363 g_io_channel_set_encoding (data.stderr_io, NULL, NULL);
2364 g_io_channel_set_buffered (data.stderr_io, FALSE);
2365 source = g_io_create_watch (data.stderr_io, G_IO_IN | G_IO_ERR | G_IO_HUP);
2366 g_source_set_callback (source, (GSourceFunc) child_read, &data, NULL);
2367 g_source_attach (source, context);
2368 g_source_unref (source);
2372 source = g_timeout_source_new (0);
2373 g_source_set_ready_time (source, g_get_monotonic_time () + timeout);
2374 g_source_set_callback (source, (GSourceFunc) child_timeout, &data, NULL);
2375 g_source_attach (source, context);
2376 g_source_unref (source);
2379 g_main_loop_run (data.loop);
2380 g_main_loop_unref (data.loop);
2381 g_main_context_unref (context);
2383 test_trap_last_pid = pid;
2384 test_trap_last_status = data.child_status;
2385 test_trap_last_stdout = g_string_free (data.stdout_str, FALSE);
2386 test_trap_last_stderr = g_string_free (data.stderr_str, FALSE);
2388 g_clear_pointer (&data.stdout_io, g_io_channel_unref);
2389 g_clear_pointer (&data.stderr_io, g_io_channel_unref);
2394 * @usec_timeout: Timeout for the forked test in micro seconds.
2395 * @test_trap_flags: Flags to modify forking behaviour.
2397 * Fork the current test program to execute a test case that might
2398 * not return or that might abort.
2400 * If @usec_timeout is non-0, the forked test case is aborted and
2401 * considered failing if its run time exceeds it.
2403 * The forking behavior can be configured with the #GTestTrapFlags flags.
2405 * In the following example, the test code forks, the forked child
2406 * process produces some sample output and exits successfully.
2407 * The forking parent process then asserts successful child program
2408 * termination and validates child program outputs.
2412 * test_fork_patterns (void)
2414 * if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
2416 * g_print ("some stdout text: somagic17\n");
2417 * g_printerr ("some stderr text: semagic43\n");
2418 * exit (0); /* successful test run */
2420 * g_test_trap_assert_passed ();
2421 * g_test_trap_assert_stdout ("*somagic17*");
2422 * g_test_trap_assert_stderr ("*semagic43*");
2426 * Returns: %TRUE for the forked child and %FALSE for the executing parent process.
2430 * Deprecated: This function is implemented only on Unix platforms,
2431 * and is not always reliable due to problems inherent in
2432 * fork-without-exec. Use g_test_trap_subprocess() instead.
2435 g_test_trap_fork (guint64 usec_timeout,
2436 GTestTrapFlags test_trap_flags)
2439 int stdout_pipe[2] = { -1, -1 };
2440 int stderr_pipe[2] = { -1, -1 };
2443 if (pipe (stdout_pipe) < 0 || pipe (stderr_pipe) < 0)
2444 g_error ("failed to create pipes to fork test program: %s", g_strerror (errno));
2445 test_trap_last_pid = fork ();
2446 if (test_trap_last_pid < 0)
2447 g_error ("failed to fork test program: %s", g_strerror (errno));
2448 if (test_trap_last_pid == 0) /* child */
2451 close (stdout_pipe[0]);
2452 close (stderr_pipe[0]);
2453 if (!(test_trap_flags & G_TEST_TRAP_INHERIT_STDIN))
2454 fd0 = g_open ("/dev/null", O_RDONLY, 0);
2455 if (sane_dup2 (stdout_pipe[1], 1) < 0 || sane_dup2 (stderr_pipe[1], 2) < 0 || (fd0 >= 0 && sane_dup2 (fd0, 0) < 0))
2456 g_error ("failed to dup2() in forked test program: %s", g_strerror (errno));
2459 if (stdout_pipe[1] >= 3)
2460 close (stdout_pipe[1]);
2461 if (stderr_pipe[1] >= 3)
2462 close (stderr_pipe[1]);
2468 close (stdout_pipe[1]);
2469 close (stderr_pipe[1]);
2471 wait_for_child (test_trap_last_pid,
2472 stdout_pipe[0], !(test_trap_flags & G_TEST_TRAP_SILENCE_STDOUT),
2473 stderr_pipe[0], !(test_trap_flags & G_TEST_TRAP_SILENCE_STDERR),
2478 g_message ("Not implemented: g_test_trap_fork");
2485 * g_test_trap_subprocess:
2486 * @test_path: Test to run in a subprocess
2487 * @usec_timeout: Timeout for the subprocess test in micro seconds.
2488 * @test_flags: Flags to modify subprocess behaviour.
2490 * Respawns the test program to run only @test_path in a subprocess.
2491 * This can be used for a test case that might not return, or that
2492 * might abort. @test_path will normally be the name of the parent
2493 * test, followed by "<literal>/subprocess/</literal>" and then a name
2494 * for the specific subtest (or just ending with
2495 * "<literal>/subprocess</literal>" if the test only has one child
2496 * test); tests with names of this form will automatically be skipped
2497 * in the parent process.
2499 * If @usec_timeout is non-0, the test subprocess is aborted and
2500 * considered failing if its run time exceeds it.
2502 * The subprocess behavior can be configured with the
2503 * #GTestSubprocessFlags flags.
2505 * You can use methods such as g_test_trap_assert_passed(),
2506 * g_test_trap_assert_failed(), and g_test_trap_assert_stderr() to
2507 * check the results of the subprocess. (But note that
2508 * g_test_trap_assert_stdout() and g_test_trap_assert_stderr()
2509 * cannot be used if @test_flags specifies that the child should
2510 * inherit the parent stdout/stderr.)
2512 * If your <literal>main ()</literal> needs to behave differently in
2513 * the subprocess, you can call g_test_subprocess() (after calling
2514 * g_test_init()) to see whether you are in a subprocess.
2516 * The following example tests that calling
2517 * <literal>my_object_new(1000000)</literal> will abort with an error
2522 * test_create_large_object_subprocess (void)
2524 * my_object_new (1000000);
2528 * test_create_large_object (void)
2530 * g_test_trap_subprocess ("/myobject/create_large_object/subprocess", 0, 0);
2531 * g_test_trap_assert_failed ();
2532 * g_test_trap_assert_stderr ("*ERROR*too large*");
2536 * main (int argc, char **argv)
2538 * g_test_init (&argc, &argv, NULL);
2540 * g_test_add_func ("/myobject/create_large_object",
2541 * test_create_large_object);
2542 * /* Because of the '/subprocess' in the name, this test will
2543 * * not be run by the g_test_run () call below.
2545 * g_test_add_func ("/myobject/create_large_object/subprocess",
2546 * test_create_large_object_subprocess);
2548 * return g_test_run ();
2555 g_test_trap_subprocess (const char *test_path,
2556 guint64 usec_timeout,
2557 GTestSubprocessFlags test_flags)
2559 GError *error = NULL;
2562 int stdout_fd, stderr_fd;
2565 /* Sanity check that they used GTestSubprocessFlags, not GTestTrapFlags */
2566 g_assert ((test_flags & (G_TEST_TRAP_INHERIT_STDIN | G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR)) == 0);
2568 if (!g_test_suite_case_exists (g_test_get_root (), test_path))
2569 g_error ("g_test_trap_subprocess: test does not exist: %s", test_path);
2571 if (g_test_verbose ())
2572 g_print ("GTest: subprocess: %s\n", test_path);
2575 test_trap_last_subprocess = g_strdup (test_path);
2577 argv = g_ptr_array_new ();
2578 g_ptr_array_add (argv, test_argv0);
2579 g_ptr_array_add (argv, "-q");
2580 g_ptr_array_add (argv, "-p");
2581 g_ptr_array_add (argv, (char *)test_path);
2582 g_ptr_array_add (argv, "--GTestSubprocess");
2583 if (test_log_fd != -1)
2585 char log_fd_buf[128];
2587 g_ptr_array_add (argv, "--GTestLogFD");
2588 g_snprintf (log_fd_buf, sizeof (log_fd_buf), "%d", test_log_fd);
2589 g_ptr_array_add (argv, log_fd_buf);
2591 g_ptr_array_add (argv, NULL);
2593 flags = G_SPAWN_DO_NOT_REAP_CHILD;
2594 if (test_flags & G_TEST_TRAP_INHERIT_STDIN)
2595 flags |= G_SPAWN_CHILD_INHERITS_STDIN;
2597 if (!g_spawn_async_with_pipes (test_initial_cwd,
2598 (char **)argv->pdata,
2601 &pid, NULL, &stdout_fd, &stderr_fd,
2604 g_error ("g_test_trap_subprocess() failed: %s\n",
2607 g_ptr_array_free (argv, TRUE);
2609 wait_for_child (pid,
2610 stdout_fd, !!(test_flags & G_TEST_SUBPROCESS_INHERIT_STDOUT),
2611 stderr_fd, !!(test_flags & G_TEST_SUBPROCESS_INHERIT_STDERR),
2616 * g_test_subprocess:
2618 * Returns %TRUE (after g_test_init() has been called) if the test
2619 * program is running under g_test_trap_subprocess().
2621 * Returns: %TRUE if the test program is running under
2622 * g_test_trap_subprocess().
2627 g_test_subprocess (void)
2629 return test_in_subprocess;
2633 * g_test_trap_has_passed:
2635 * Check the result of the last g_test_trap_subprocess() call.
2637 * Returns: %TRUE if the last test subprocess terminated successfully.
2642 g_test_trap_has_passed (void)
2644 return test_trap_last_status == 0; /* exit_status == 0 && !signal && !coredump */
2648 * g_test_trap_reached_timeout:
2650 * Check the result of the last g_test_trap_subprocess() call.
2652 * Returns: %TRUE if the last test subprocess got killed due to a timeout.
2657 g_test_trap_reached_timeout (void)
2659 return test_trap_last_status != G_TEST_STATUS_TIMED_OUT;
2663 g_test_trap_assertions (const char *domain,
2667 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
2668 const char *pattern)
2670 gboolean must_pass = assertion_flags == 0;
2671 gboolean must_fail = assertion_flags == 1;
2672 gboolean match_result = 0 == (assertion_flags & 1);
2673 const char *stdout_pattern = (assertion_flags & 2) ? pattern : NULL;
2674 const char *stderr_pattern = (assertion_flags & 4) ? pattern : NULL;
2675 const char *match_error = match_result ? "failed to match" : "contains invalid match";
2679 if (test_trap_last_subprocess != NULL)
2681 process_id = g_strdup_printf ("%s [%d]", test_trap_last_subprocess,
2682 test_trap_last_pid);
2684 else if (test_trap_last_pid != 0)
2685 process_id = g_strdup_printf ("%d", test_trap_last_pid);
2687 if (test_trap_last_subprocess != NULL)
2688 process_id = g_strdup (test_trap_last_subprocess);
2691 g_error ("g_test_trap_ assertion with no trapped test");
2693 if (must_pass && !g_test_trap_has_passed())
2695 char *msg = g_strdup_printf ("child process (%s) failed unexpectedly", process_id);
2696 g_assertion_message (domain, file, line, func, msg);
2699 if (must_fail && g_test_trap_has_passed())
2701 char *msg = g_strdup_printf ("child process (%s) did not fail as expected", process_id);
2702 g_assertion_message (domain, file, line, func, msg);
2705 if (stdout_pattern && match_result == !g_pattern_match_simple (stdout_pattern, test_trap_last_stdout))
2707 char *msg = g_strdup_printf ("stdout of child process (%s) %s: %s", process_id, match_error, stdout_pattern);
2708 g_assertion_message (domain, file, line, func, msg);
2711 if (stderr_pattern && match_result == !g_pattern_match_simple (stderr_pattern, test_trap_last_stderr))
2713 char *msg = g_strdup_printf ("stderr of child process (%s) %s: %s", process_id, match_error, stderr_pattern);
2714 g_assertion_message (domain, file, line, func, msg);
2717 g_free (process_id);
2721 gstring_overwrite_int (GString *gstring,
2725 vuint = g_htonl (vuint);
2726 g_string_overwrite_len (gstring, pos, (const gchar*) &vuint, 4);
2730 gstring_append_int (GString *gstring,
2733 vuint = g_htonl (vuint);
2734 g_string_append_len (gstring, (const gchar*) &vuint, 4);
2738 gstring_append_double (GString *gstring,
2741 union { double vdouble; guint64 vuint64; } u;
2742 u.vdouble = vdouble;
2743 u.vuint64 = GUINT64_TO_BE (u.vuint64);
2744 g_string_append_len (gstring, (const gchar*) &u.vuint64, 8);
2748 g_test_log_dump (GTestLogMsg *msg,
2751 GString *gstring = g_string_sized_new (1024);
2753 gstring_append_int (gstring, 0); /* message length */
2754 gstring_append_int (gstring, msg->log_type);
2755 gstring_append_int (gstring, msg->n_strings);
2756 gstring_append_int (gstring, msg->n_nums);
2757 gstring_append_int (gstring, 0); /* reserved */
2758 for (ui = 0; ui < msg->n_strings; ui++)
2760 guint l = strlen (msg->strings[ui]);
2761 gstring_append_int (gstring, l);
2762 g_string_append_len (gstring, msg->strings[ui], l);
2764 for (ui = 0; ui < msg->n_nums; ui++)
2765 gstring_append_double (gstring, msg->nums[ui]);
2766 *len = gstring->len;
2767 gstring_overwrite_int (gstring, 0, *len); /* message length */
2768 return (guint8*) g_string_free (gstring, FALSE);
2771 static inline long double
2772 net_double (const gchar **ipointer)
2774 union { guint64 vuint64; double vdouble; } u;
2775 guint64 aligned_int64;
2776 memcpy (&aligned_int64, *ipointer, 8);
2778 u.vuint64 = GUINT64_FROM_BE (aligned_int64);
2782 static inline guint32
2783 net_int (const gchar **ipointer)
2785 guint32 aligned_int;
2786 memcpy (&aligned_int, *ipointer, 4);
2788 return g_ntohl (aligned_int);
2792 g_test_log_extract (GTestLogBuffer *tbuffer)
2794 const gchar *p = tbuffer->data->str;
2797 if (tbuffer->data->len < 4 * 5)
2799 mlength = net_int (&p);
2800 if (tbuffer->data->len < mlength)
2802 msg.log_type = net_int (&p);
2803 msg.n_strings = net_int (&p);
2804 msg.n_nums = net_int (&p);
2805 if (net_int (&p) == 0)
2808 msg.strings = g_new0 (gchar*, msg.n_strings + 1);
2809 msg.nums = g_new0 (long double, msg.n_nums);
2810 for (ui = 0; ui < msg.n_strings; ui++)
2812 guint sl = net_int (&p);
2813 msg.strings[ui] = g_strndup (p, sl);
2816 for (ui = 0; ui < msg.n_nums; ui++)
2817 msg.nums[ui] = net_double (&p);
2818 if (p <= tbuffer->data->str + mlength)
2820 g_string_erase (tbuffer->data, 0, mlength);
2821 tbuffer->msgs = g_slist_prepend (tbuffer->msgs, g_memdup (&msg, sizeof (msg)));
2826 g_strfreev (msg.strings);
2827 g_error ("corrupt log stream from test program");
2832 * g_test_log_buffer_new:
2834 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
2837 g_test_log_buffer_new (void)
2839 GTestLogBuffer *tb = g_new0 (GTestLogBuffer, 1);
2840 tb->data = g_string_sized_new (1024);
2845 * g_test_log_buffer_free:
2847 * Internal function for gtester to free test log messages, no ABI guarantees provided.
2850 g_test_log_buffer_free (GTestLogBuffer *tbuffer)
2852 g_return_if_fail (tbuffer != NULL);
2853 while (tbuffer->msgs)
2854 g_test_log_msg_free (g_test_log_buffer_pop (tbuffer));
2855 g_string_free (tbuffer->data, TRUE);
2860 * g_test_log_buffer_push:
2862 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
2865 g_test_log_buffer_push (GTestLogBuffer *tbuffer,
2867 const guint8 *bytes)
2869 g_return_if_fail (tbuffer != NULL);
2872 gboolean more_messages;
2873 g_return_if_fail (bytes != NULL);
2874 g_string_append_len (tbuffer->data, (const gchar*) bytes, n_bytes);
2876 more_messages = g_test_log_extract (tbuffer);
2877 while (more_messages);
2882 * g_test_log_buffer_pop:
2884 * Internal function for gtester to retrieve test log messages, no ABI guarantees provided.
2887 g_test_log_buffer_pop (GTestLogBuffer *tbuffer)
2889 GTestLogMsg *msg = NULL;
2890 g_return_val_if_fail (tbuffer != NULL, NULL);
2893 GSList *slist = g_slist_last (tbuffer->msgs);
2895 tbuffer->msgs = g_slist_delete_link (tbuffer->msgs, slist);
2901 * g_test_log_msg_free:
2903 * Internal function for gtester to free test log messages, no ABI guarantees provided.
2906 g_test_log_msg_free (GTestLogMsg *tmsg)
2908 g_return_if_fail (tmsg != NULL);
2909 g_strfreev (tmsg->strings);
2910 g_free (tmsg->nums);
2915 g_test_build_filename_va (GTestFileType file_type,
2916 const gchar *first_path,
2919 const gchar *pathv[16];
2920 gint num_path_segments;
2922 if (file_type == G_TEST_DIST)
2923 pathv[0] = test_disted_files_dir;
2924 else if (file_type == G_TEST_BUILT)
2925 pathv[0] = test_built_files_dir;
2927 g_assert_not_reached ();
2929 pathv[1] = first_path;
2931 for (num_path_segments = 2; num_path_segments < G_N_ELEMENTS (pathv); num_path_segments++)
2933 pathv[num_path_segments] = va_arg (ap, const char *);
2934 if (pathv[num_path_segments] == NULL)
2938 g_assert_cmpint (num_path_segments, <, G_N_ELEMENTS (pathv));
2940 return g_build_filenamev ((gchar **) pathv);
2944 * g_test_build_filename:
2945 * @file_type: the type of file (built vs. distributed)
2946 * @first_path: the first segment of the pathname
2947 * @...: %NULL-terminated additional path segments
2949 * Creates the pathname to a data file that is required for a test.
2951 * This function is conceptually similar to g_build_filename() except
2952 * that the first argument has been replaced with a #GTestFileType
2955 * The data file should either have been distributed with the module
2956 * containing the test (%G_TEST_DIST) or built as part of the build
2957 * system of that module (%G_TEST_BUILT).
2959 * In order for this function to work in srcdir != builddir situations,
2960 * the G_TEST_SRCDIR and G_TEST_BUILDDIR environment variables need to
2961 * have been defined. As of 2.38, this is done by the Makefile.decl
2962 * included in GLib. Please ensure that your copy is up to date before
2963 * using this function.
2965 * In case neither variable is set, this function will fall back to
2966 * using the dirname portion of argv[0], possibly removing ".libs".
2967 * This allows for casual running of tests directly from the commandline
2968 * in the srcdir == builddir case and should also support running of
2969 * installed tests, assuming the data files have been installed in the
2970 * same relative path as the test binary.
2972 * Returns: the path of the file, to be freed using g_free()
2978 * @G_TEST_DIST: a file that was included in the distribution tarball
2979 * @G_TEST_BUILT: a file that was built on the compiling machine
2981 * The type of file to return the filename for, when used with
2982 * g_test_build_filename().
2984 * These two options correspond rather directly to the 'dist' and
2985 * 'built' terminology that automake uses and are explicitly used to
2986 * distinguish between the 'srcdir' and 'builddir' being separate. All
2987 * files in your project should either be dist (in the
2988 * <literal>DIST_EXTRA</literal> or <literal>dist_schema_DATA</literal>
2989 * sense, in which case they will always be in the srcdir) or built (in
2990 * the <literal>BUILT_SOURCES</literal> sense, in which case they will
2991 * always be in the builddir).
2993 * Note: as a general rule of automake, files that are generated only as
2994 * part of the build-from-git process (but then are distributed with the
2995 * tarball) always go in srcdir (even if doing a srcdir != builddir
2996 * build from git) and are considered as distributed files.
3001 g_test_build_filename (GTestFileType file_type,
3002 const gchar *first_path,
3008 g_assert (g_test_initialized ());
3010 va_start (ap, first_path);
3011 result = g_test_build_filename_va (file_type, first_path, ap);
3019 * @file_type: the type of file (built vs. distributed)
3021 * Gets the pathname of the directory containing test files of the type
3022 * specified by @file_type.
3024 * This is approximately the same as calling g_test_build_filename("."),
3025 * but you don't need to free the return value.
3027 * Returns: the path of the directory, owned by GLib
3032 g_test_get_dir (GTestFileType file_type)
3034 g_assert (g_test_initialized ());
3036 if (file_type == G_TEST_DIST)
3037 return test_disted_files_dir;
3038 else if (file_type == G_TEST_BUILT)
3039 return test_built_files_dir;
3041 g_assert_not_reached ();
3045 * g_test_get_filename:
3046 * @file_type: the type of file (built vs. distributed)
3047 * @first_path: the first segment of the pathname
3048 * @...: %NULL-terminated additional path segments
3050 * Gets the pathname to a data file that is required for a test.
3052 * This is the same as g_test_build_filename() with two differences.
3053 * The first difference is that must only use this function from within
3054 * a testcase function. The second difference is that you need not free
3055 * the return value -- it will be automatically freed when the testcase
3058 * It is safe to use this function from a thread inside of a testcase
3059 * but you must ensure that all such uses occur before the main testcase
3060 * function returns (ie: it is best to ensure that all threads have been
3063 * Returns: the path, automatically freed at the end of the testcase
3068 g_test_get_filename (GTestFileType file_type,
3069 const gchar *first_path,
3076 g_assert (g_test_initialized ());
3077 if (test_filename_free_list == NULL)
3078 g_error ("g_test_get_filename() can only be used within testcase functions");
3080 va_start (ap, first_path);
3081 result = g_test_build_filename_va (file_type, first_path, ap);
3084 node = g_slist_prepend (NULL, result);
3086 node->next = *test_filename_free_list;
3087 while (!g_atomic_pointer_compare_and_exchange (test_filename_free_list, node->next, node));
3092 /* --- macros docs START --- */
3095 * @testpath: The test path for a new test case.
3096 * @Fixture: The type of a fixture data structure.
3097 * @tdata: Data argument for the test functions.
3098 * @fsetup: The function to set up the fixture data.
3099 * @ftest: The actual test function.
3100 * @fteardown: The function to tear down the fixture data.
3102 * Hook up a new test case at @testpath, similar to g_test_add_func().
3103 * A fixture data structure with setup and teardown function may be provided
3104 * though, similar to g_test_create_case().
3105 * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
3106 * fteardown() callbacks can expect a @Fixture pointer as first argument in
3107 * a type safe manner.
3111 /* --- macros docs END --- */