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.
21 #include "gtestutils.h"
23 #include <sys/types.h>
40 #ifdef HAVE_SYS_SELECT_H
41 #include <sys/select.h>
42 #endif /* HAVE_SYS_SELECT_H */
44 /* --- structures --- */
49 void (*fixture_setup) (void*, gconstpointer);
50 void (*fixture_test) (void*, gconstpointer);
51 void (*fixture_teardown) (void*, gconstpointer);
60 typedef struct DestroyEntry DestroyEntry;
64 GDestroyNotify destroy_func;
65 gpointer destroy_data;
68 /* --- prototypes --- */
69 static void test_run_seed (const gchar *rseed);
70 static void test_trap_clear (void);
71 static guint8* g_test_log_dump (GTestLogMsg *msg,
73 static void gtest_default_log_handler (const gchar *log_domain,
74 GLogLevelFlags log_level,
76 gpointer unused_data);
79 /* --- variables --- */
80 static int test_log_fd = -1;
81 static gboolean test_mode_fatal = TRUE;
82 static gboolean g_test_run_once = TRUE;
83 static gboolean test_run_list = FALSE;
84 static gchar *test_run_seedstr = NULL;
85 static GRand *test_run_rand = NULL;
86 static gchar *test_run_name = "";
87 static guint test_run_forks = 0;
88 static guint test_run_count = 0;
89 static guint test_skip_count = 0;
90 static GTimer *test_user_timer = NULL;
91 static double test_user_stamp = 0;
92 static GSList *test_paths = NULL;
93 static GTestSuite *test_suite_root = NULL;
94 static int test_trap_last_status = 0;
95 static int test_trap_last_pid = 0;
96 static char *test_trap_last_stdout = NULL;
97 static char *test_trap_last_stderr = NULL;
98 static char *test_uri_base = NULL;
99 static gboolean test_debug_log = FALSE;
100 static DestroyEntry *test_destroy_queue = NULL;
101 static GTestConfig mutable_test_config_vars = {
102 FALSE, /* test_initialized */
103 TRUE, /* test_quick */
104 FALSE, /* test_perf */
105 FALSE, /* test_verbose */
106 FALSE, /* test_quiet */
108 const GTestConfig * const g_test_config_vars = &mutable_test_config_vars;
110 /* --- functions --- */
112 g_test_log_type_name (GTestLogType log_type)
116 case G_TEST_LOG_NONE: return "none";
117 case G_TEST_LOG_ERROR: return "error";
118 case G_TEST_LOG_START_BINARY: return "binary";
119 case G_TEST_LOG_LIST_CASE: return "list";
120 case G_TEST_LOG_SKIP_CASE: return "skip";
121 case G_TEST_LOG_START_CASE: return "start";
122 case G_TEST_LOG_STOP_CASE: return "stop";
123 case G_TEST_LOG_MIN_RESULT: return "minperf";
124 case G_TEST_LOG_MAX_RESULT: return "maxperf";
125 case G_TEST_LOG_MESSAGE: return "message";
131 g_test_log_send (guint n_bytes,
132 const guint8 *buffer)
134 if (test_log_fd >= 0)
138 r = write (test_log_fd, buffer, n_bytes);
139 while (r < 0 && errno == EINTR);
143 GTestLogBuffer *lbuffer = g_test_log_buffer_new();
146 g_test_log_buffer_push (lbuffer, n_bytes, buffer);
147 msg = g_test_log_buffer_pop (lbuffer);
148 g_assert (msg != NULL); /* FIXME: should be g_awrn_if_fail */
149 g_assert (lbuffer->data->len == 0); /* FIXME: should be g_awrn_if_fail */
150 g_test_log_buffer_free (lbuffer);
152 g_printerr ("{*LOG(%s)", g_test_log_type_name (msg->log_type));
153 for (ui = 0; ui < msg->n_strings; ui++)
154 g_printerr (":{%s}", msg->strings[ui]);
158 for (ui = 0; ui < msg->n_nums; ui++)
159 g_printerr ("%s%.16Lg", ui ? ";" : "", msg->nums[ui]);
162 g_printerr (":LOG*}\n");
163 g_test_log_msg_free (msg);
168 g_test_log (GTestLogType lbit,
169 const gchar *string1,
170 const gchar *string2,
174 gboolean fail = lbit == G_TEST_LOG_STOP_CASE && largs[0] != 0;
176 gchar *astrings[3] = { NULL, NULL, NULL };
182 case G_TEST_LOG_START_BINARY:
183 if (g_test_verbose())
184 g_print ("GTest: random seed: %s\n", string2);
186 case G_TEST_LOG_STOP_CASE:
187 if (g_test_verbose())
188 g_print ("GTest: result: %s\n", fail ? "FAIL" : "OK");
189 else if (!g_test_quiet())
190 g_print ("%s\n", fail ? "FAIL" : "OK");
191 if (fail && test_mode_fatal)
194 case G_TEST_LOG_MIN_RESULT:
195 if (g_test_verbose())
196 g_print ("(MINPERF:%s)\n", string1);
198 case G_TEST_LOG_MAX_RESULT:
199 if (g_test_verbose())
200 g_print ("(MAXPERF:%s)\n", string1);
202 case G_TEST_LOG_MESSAGE:
203 if (g_test_verbose())
204 g_print ("(MSG: %s)\n", string1);
210 msg.n_strings = (string1 != NULL) + (string1 && string2);
211 msg.strings = astrings;
212 astrings[0] = (gchar*) string1;
213 astrings[1] = astrings[0] ? (gchar*) string2 : NULL;
216 dbuffer = g_test_log_dump (&msg, &dbufferlen);
217 g_test_log_send (dbufferlen, dbuffer);
222 case G_TEST_LOG_START_CASE:
223 if (g_test_verbose())
224 g_print ("GTest: run: %s\n", string1);
225 else if (!g_test_quiet())
226 g_print ("%s: ", string1);
232 /* We intentionally parse the command line without GOptionContext
233 * because otherwise you would never be able to test it.
236 parse_args (gint *argc_p,
239 guint argc = *argc_p;
240 gchar **argv = *argv_p;
242 /* parse known args */
243 for (i = 1; i < argc; i++)
245 if (strcmp (argv[i], "--g-fatal-warnings") == 0)
247 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
248 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
249 g_log_set_always_fatal (fatal_mask);
252 else if (strcmp (argv[i], "--keep-going") == 0 ||
253 strcmp (argv[i], "-k") == 0)
255 test_mode_fatal = FALSE;
258 else if (strcmp (argv[i], "--debug-log") == 0)
260 test_debug_log = TRUE;
263 else if (strcmp ("--GTestLogFD", argv[i]) == 0 || strncmp ("--GTestLogFD=", argv[i], 13) == 0)
265 gchar *equal = argv[i] + 12;
267 test_log_fd = g_ascii_strtoull (equal + 1, NULL, 0);
268 else if (i + 1 < argc)
271 test_log_fd = g_ascii_strtoull (argv[i], NULL, 0);
275 else if (strcmp ("--GTestSkipCount", argv[i]) == 0 || strncmp ("--GTestSkipCount=", argv[i], 17) == 0)
277 gchar *equal = argv[i] + 16;
279 test_skip_count = g_ascii_strtoull (equal + 1, NULL, 0);
280 else if (i + 1 < argc)
283 test_skip_count = g_ascii_strtoull (argv[i], NULL, 0);
287 else if (strcmp ("-p", argv[i]) == 0 || strncmp ("-p=", argv[i], 3) == 0)
289 gchar *equal = argv[i] + 2;
291 test_paths = g_slist_prepend (test_paths, equal + 1);
292 else if (i + 1 < argc)
295 test_paths = g_slist_prepend (test_paths, argv[i]);
299 else if (strcmp ("-m", argv[i]) == 0 || strncmp ("-m=", argv[i], 3) == 0)
301 gchar *equal = argv[i] + 2;
302 const gchar *mode = "";
305 else if (i + 1 < argc)
310 if (strcmp (mode, "perf") == 0)
311 mutable_test_config_vars.test_perf = TRUE;
312 else if (strcmp (mode, "slow") == 0)
313 mutable_test_config_vars.test_quick = FALSE;
314 else if (strcmp (mode, "thorough") == 0)
315 mutable_test_config_vars.test_quick = FALSE;
316 else if (strcmp (mode, "quick") == 0)
318 mutable_test_config_vars.test_quick = TRUE;
319 mutable_test_config_vars.test_perf = FALSE;
322 g_error ("unknown test mode: -m %s", mode);
325 else if (strcmp ("-q", argv[i]) == 0 || strcmp ("--quiet", argv[i]) == 0)
327 mutable_test_config_vars.test_quiet = TRUE;
328 mutable_test_config_vars.test_verbose = FALSE;
331 else if (strcmp ("--verbose", argv[i]) == 0)
333 mutable_test_config_vars.test_quiet = FALSE;
334 mutable_test_config_vars.test_verbose = TRUE;
337 else if (strcmp ("-l", argv[i]) == 0)
339 test_run_list = TRUE;
342 else if (strcmp ("--seed", argv[i]) == 0 || strncmp ("--seed=", argv[i], 7) == 0)
344 gchar *equal = argv[i] + 6;
346 test_run_seedstr = equal + 1;
347 else if (i + 1 < argc)
350 test_run_seedstr = argv[i];
354 else if (strcmp ("-?", argv[i]) == 0 || strcmp ("--help", argv[i]) == 0)
357 " %s [OPTION...]\n\n"
359 " -?, --help Show help options\n"
361 " -l List test cases available in a test executable\n"
362 " -seed=RANDOMSEED Provide a random seed to reproduce test\n"
363 " runs using random numbers\n"
364 " --verbose Run tests verbosely\n"
365 " -q, --quiet Run tests quietly\n"
366 " -p TESTPATH execute all tests matching TESTPATH\n"
367 " -m {perf|slow|thorough|quick} Execute tests according modes\n"
368 " --debug-log debug test logging output\n"
369 " -k, --keep-going gtester-specific argument\n"
370 " --GTestLogFD=N gtester-specific argument\n"
371 " --GTestSkipCount=N gtester-specific argument\n",
378 for (i = 1; i < argc; i++)
390 * @argc: Address of the @argc parameter of the main() function.
391 * Changed if any arguments were handled.
392 * @argv: Address of the @argv parameter of main().
393 * Any parameters understood by g_test_init() stripped before return.
394 * @Varargs: Reserved for future extension. Currently, you must pass %NULL.
396 * Initialize the GLib testing framework, e.g. by seeding the
397 * test random number generator, the name for g_get_prgname()
398 * and parsing test related command line args.
399 * So far, the following arguments are understood:
402 * <term><option>-l</option></term>
404 * list test cases available in a test executable.
408 * <term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
410 * provide a random seed to reproduce test runs using random numbers.
414 * <term><option>--verbose</option></term>
415 * <listitem><para>run tests verbosely.</para></listitem>
418 * <term><option>-q</option>, <option>--quiet</option></term>
419 * <listitem><para>run tests quietly.</para></listitem>
422 * <term><option>-p <replaceable>TESTPATH</replaceable></option></term>
424 * execute all tests matching <replaceable>TESTPATH</replaceable>.
428 * <term><option>-m {perf|slow|thorough|quick}</option></term>
430 * execute tests according to these test modes:
435 * performance tests, may take long and report results.
439 * <term>slow, thorough</term>
441 * slow and thorough tests, may take quite long and
448 * quick tests, should run really quickly and give good coverage.
455 * <term><option>--debug-log</option></term>
456 * <listitem><para>debug test logging output.</para></listitem>
459 * <term><option>-k</option>, <option>--keep-going</option></term>
460 * <listitem><para>gtester-specific argument.</para></listitem>
463 * <term><option>--GTestLogFD <replaceable>N</replaceable></option></term>
464 * <listitem><para>gtester-specific argument.</para></listitem>
467 * <term><option>--GTestSkipCount <replaceable>N</replaceable></option></term>
468 * <listitem><para>gtester-specific argument.</para></listitem>
475 g_test_init (int *argc,
479 static char seedstr[4 + 4 * 8 + 1];
482 /* make warnings and criticals fatal for all test programs */
483 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
484 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
485 g_log_set_always_fatal (fatal_mask);
486 /* check caller args */
487 g_return_if_fail (argc != NULL);
488 g_return_if_fail (argv != NULL);
489 g_return_if_fail (g_test_config_vars->test_initialized == FALSE);
490 mutable_test_config_vars.test_initialized = TRUE;
492 va_start (args, argv);
493 vararg1 = va_arg (args, gpointer); /* reserved for future extensions */
495 g_return_if_fail (vararg1 == NULL);
497 /* setup random seed string */
498 g_snprintf (seedstr, sizeof (seedstr), "R02S%08x%08x%08x%08x", g_random_int(), g_random_int(), g_random_int(), g_random_int());
499 test_run_seedstr = seedstr;
501 /* parse args, sets up mode, changes seed, etc. */
502 parse_args (argc, argv);
503 if (!g_get_prgname())
504 g_set_prgname ((*argv)[0]);
506 /* verify GRand reliability, needed for reliable seeds */
509 GRand *rg = g_rand_new_with_seed (0xc8c49fb6);
510 guint32 t1 = g_rand_int (rg), t2 = g_rand_int (rg), t3 = g_rand_int (rg), t4 = g_rand_int (rg);
511 /* g_print ("GRand-current: 0x%x 0x%x 0x%x 0x%x\n", t1, t2, t3, t4); */
512 if (t1 != 0xfab39f9b || t2 != 0xb948fb0e || t3 != 0x3d31be26 || t4 != 0x43a19d66)
513 g_warning ("random numbers are not GRand-2.2 compatible, seeds may be broken (check $G_RANDOM_VERSION)");
517 /* check rand seed */
518 test_run_seed (test_run_seedstr);
520 /* report program start */
521 g_log_set_default_handler (gtest_default_log_handler, NULL);
522 g_test_log (G_TEST_LOG_START_BINARY, g_get_prgname(), test_run_seedstr, 0, NULL);
526 test_run_seed (const gchar *rseed)
528 guint seed_failed = 0;
530 g_rand_free (test_run_rand);
531 test_run_rand = NULL;
532 while (strchr (" \t\v\r\n\f", *rseed))
534 if (strncmp (rseed, "R02S", 4) == 0) /* seed for random generator 02 (GRand-2.2) */
536 const char *s = rseed + 4;
537 if (strlen (s) >= 32) /* require 4 * 8 chars */
539 guint32 seedarray[4];
540 gchar *p, hexbuf[9] = { 0, };
541 memcpy (hexbuf, s + 0, 8);
542 seedarray[0] = g_ascii_strtoull (hexbuf, &p, 16);
543 seed_failed += p != NULL && *p != 0;
544 memcpy (hexbuf, s + 8, 8);
545 seedarray[1] = g_ascii_strtoull (hexbuf, &p, 16);
546 seed_failed += p != NULL && *p != 0;
547 memcpy (hexbuf, s + 16, 8);
548 seedarray[2] = g_ascii_strtoull (hexbuf, &p, 16);
549 seed_failed += p != NULL && *p != 0;
550 memcpy (hexbuf, s + 24, 8);
551 seedarray[3] = g_ascii_strtoull (hexbuf, &p, 16);
552 seed_failed += p != NULL && *p != 0;
555 test_run_rand = g_rand_new_with_seed_array (seedarray, 4);
560 g_error ("Unknown or invalid random seed: %s", rseed);
566 * Get a reproducible random integer number.
568 * The random numbers generated by the g_test_rand_*() family of functions
569 * change with every new test program start, unless the --seed option is
570 * given when starting test programs.
572 * For individual test cases however, the random number generator is
573 * reseeded, to avoid dependencies between tests and to make --seed
574 * effective for all test cases.
576 * Returns: a random number from the seeded random number generator.
581 g_test_rand_int (void)
583 return g_rand_int (test_run_rand);
587 * g_test_rand_int_range:
588 * @begin: the minimum value returned by this function
589 * @end: the smallest value not to be returned by this function
591 * Get a reproducible random integer number out of a specified range,
592 * see g_test_rand_int() for details on test case random numbers.
594 * Returns: a number with @begin <= number < @end.
599 g_test_rand_int_range (gint32 begin,
602 return g_rand_int_range (test_run_rand, begin, end);
606 * g_test_rand_double:
608 * Get a reproducible random floating point number,
609 * see g_test_rand_int() for details on test case random numbers.
611 * Returns: a random number from the seeded random number generator.
616 g_test_rand_double (void)
618 return g_rand_double (test_run_rand);
622 * g_test_rand_double_range:
623 * @range_start: the minimum value returned by this function
624 * @range_end: the minimum value not returned by this function
626 * Get a reproducible random floating pointer number out of a specified range,
627 * see g_test_rand_int() for details on test case random numbers.
629 * Returns: a number with @range_start <= number < @range_end.
634 g_test_rand_double_range (double range_start,
637 return g_rand_double_range (test_run_rand, range_start, range_end);
641 * g_test_timer_start:
643 * Start a timing test. Call g_test_timer_elapsed() when the task is supposed
644 * to be done. Call this function again to restart the timer.
649 g_test_timer_start (void)
651 if (!test_user_timer)
652 test_user_timer = g_timer_new();
654 g_timer_start (test_user_timer);
658 * g_test_timer_elapsed:
660 * Get the time since the last start of the timer with g_test_timer_start().
662 * Returns: the time since the last start of the timer, as a double
667 g_test_timer_elapsed (void)
669 test_user_stamp = test_user_timer ? g_timer_elapsed (test_user_timer, NULL) : 0;
670 return test_user_stamp;
676 * Report the last result of g_test_timer_elapsed().
678 * Returns: the last result of g_test_timer_elapsed(), as a double
683 g_test_timer_last (void)
685 return test_user_stamp;
689 * g_test_minimized_result:
690 * @minimized_quantity: the reported value
691 * @format: the format string of the report message
692 * @Varargs: arguments to pass to the printf() function
694 * Report the result of a performance or measurement test.
695 * The test should generally strive to minimize the reported
696 * quantities (smaller values are better than larger ones),
697 * this and @minimized_quantity can determine sorting
698 * order for test result reports.
703 g_test_minimized_result (double minimized_quantity,
707 long double largs = minimized_quantity;
710 va_start (args, format);
711 buffer = g_strdup_vprintf (format, args);
713 g_test_log (G_TEST_LOG_MIN_RESULT, buffer, NULL, 1, &largs);
718 * g_test_maximized_result:
719 * @maximized_quantity: the reported value
720 * @format: the format string of the report message
721 * @Varargs: arguments to pass to the printf() function
723 * Report the result of a performance or measurement test.
724 * The test should generally strive to maximize the reported
725 * quantities (larger values are better than smaller ones),
726 * this and @maximized_quantity can determine sorting
727 * order for test result reports.
732 g_test_maximized_result (double maximized_quantity,
736 long double largs = maximized_quantity;
739 va_start (args, format);
740 buffer = g_strdup_vprintf (format, args);
742 g_test_log (G_TEST_LOG_MAX_RESULT, buffer, NULL, 1, &largs);
748 * @format: the format string
749 * @...: printf-like arguments to @format
751 * Add a message to the test report.
756 g_test_message (const char *format,
761 va_start (args, format);
762 buffer = g_strdup_vprintf (format, args);
764 g_test_log (G_TEST_LOG_MESSAGE, buffer, NULL, 0, NULL);
770 * @uri_pattern: the base pattern for bug URIs
772 * Specify the base URI for bug reports.
774 * The base URI is used to construct bug report messages for
775 * g_test_message() when g_test_bug() is called.
776 * Calling this function outside of a test case sets the
777 * default base URI for all test cases. Calling it from within
778 * a test case changes the base URI for the scope of the test
780 * Bug URIs are constructed by appending a bug specific URI
781 * portion to @uri_pattern, or by replacing the special string
782 * '%s' within @uri_pattern if that is present.
787 g_test_bug_base (const char *uri_pattern)
789 g_free (test_uri_base);
790 test_uri_base = g_strdup (uri_pattern);
795 * @bug_uri_snippet: Bug specific bug tracker URI portion.
797 * This function adds a message to test reports that
798 * associates a bug URI with a test case.
799 * Bug URIs are constructed from a base URI set with g_test_bug_base()
800 * and @bug_uri_snippet.
805 g_test_bug (const char *bug_uri_snippet)
808 g_return_if_fail (test_uri_base != NULL);
809 g_return_if_fail (bug_uri_snippet != NULL);
810 c = strstr (test_uri_base, "%s");
813 char *b = g_strndup (test_uri_base, c - test_uri_base);
814 char *s = g_strconcat (b, bug_uri_snippet, c + 2, NULL);
816 g_test_message ("Bug Reference: %s", s);
820 g_test_message ("Bug Reference: %s%s", test_uri_base, bug_uri_snippet);
826 * Get the toplevel test suite for the test path API.
828 * Returns: the toplevel #GTestSuite
833 g_test_get_root (void)
835 if (!test_suite_root)
837 test_suite_root = g_test_create_suite ("root");
838 g_free (test_suite_root->name);
839 test_suite_root->name = g_strdup ("");
841 return test_suite_root;
847 * Runs all tests under the toplevel suite which can be retrieved
848 * with g_test_get_root(). Similar to g_test_run_suite(), the test
849 * cases to be run are filtered according to
850 * test path arguments (-p <replaceable>testpath</replaceable>) as
851 * parsed by g_test_init().
852 * g_test_run_suite() or g_test_run() may only be called once
855 * Returns: 0 on success
862 return g_test_run_suite (g_test_get_root());
866 * g_test_create_case:
867 * @test_name: the name for the test case
868 * @data_size: the size of the fixture data structure
869 * @test_data: test data argument for the test functions
870 * @data_setup: the function to set up the fixture data
871 * @data_test: the actual test function
872 * @data_teardown: the function to teardown the fixture data
874 * Create a new #GTestCase, named @test_name, this API is fairly
875 * low level, calling g_test_add() or g_test_add_func() is preferable.
876 * When this test is executed, a fixture structure of size @data_size
877 * will be allocated and filled with 0s. Then data_setup() is called
878 * to initialize the fixture. After fixture setup, the actual test
879 * function data_test() is called. Once the test run completed, the
880 * fixture structure is torn down by calling data_teardown() and
881 * after that the memory is released.
883 * Splitting up a test run into fixture setup, test function and
884 * fixture teardown is most usful if the same fixture is used for
885 * multiple tests. In this cases, g_test_create_case() will be
886 * called with the same fixture, but varying @test_name and
887 * @data_test arguments.
889 * Returns: a newly allocated #GTestCase.
894 g_test_create_case (const char *test_name,
896 gconstpointer test_data,
897 void (*data_setup) (void),
898 void (*data_test) (void),
899 void (*data_teardown) (void))
902 g_return_val_if_fail (test_name != NULL, NULL);
903 g_return_val_if_fail (strchr (test_name, '/') == NULL, NULL);
904 g_return_val_if_fail (test_name[0] != 0, NULL);
905 g_return_val_if_fail (data_test != NULL, NULL);
906 tc = g_slice_new0 (GTestCase);
907 tc->name = g_strdup (test_name);
908 tc->test_data = (gpointer) test_data;
909 tc->fixture_size = data_size;
910 tc->fixture_setup = (void*) data_setup;
911 tc->fixture_test = (void*) data_test;
912 tc->fixture_teardown = (void*) data_teardown;
917 g_test_add_vtable (const char *testpath,
919 gconstpointer test_data,
920 void (*data_setup) (void),
921 void (*fixture_test_func) (void),
922 void (*data_teardown) (void))
928 g_return_if_fail (testpath != NULL);
929 g_return_if_fail (testpath[0] == '/');
930 g_return_if_fail (fixture_test_func != NULL);
932 suite = g_test_get_root();
933 segments = g_strsplit (testpath, "/", -1);
934 for (ui = 0; segments[ui] != NULL; ui++)
936 const char *seg = segments[ui];
937 gboolean islast = segments[ui + 1] == NULL;
938 if (islast && !seg[0])
939 g_error ("invalid test case path: %s", testpath);
941 continue; /* initial or duplicate slash */
944 GTestSuite *csuite = g_test_create_suite (seg);
945 g_test_suite_add_suite (suite, csuite);
950 GTestCase *tc = g_test_create_case (seg, data_size, test_data, data_setup, fixture_test_func, data_teardown);
951 g_test_suite_add (suite, tc);
954 g_strfreev (segments);
959 * @testpath: Slash-separated test case path name for the test.
960 * @test_func: The test function to invoke for this test.
962 * Create a new test case, similar to g_test_create_case(). However
963 * the test is assumed to use no fixture, and test suites are automatically
964 * created on the fly and added to the root fixture, based on the
965 * slash-separated portions of @testpath.
970 g_test_add_func (const char *testpath,
971 void (*test_func) (void))
973 g_return_if_fail (testpath != NULL);
974 g_return_if_fail (testpath[0] == '/');
975 g_return_if_fail (test_func != NULL);
976 g_test_add_vtable (testpath, 0, NULL, NULL, test_func, NULL);
980 * g_test_add_data_func:
981 * @testpath: Slash-separated test case path name for the test.
982 * @test_data: Test data argument for the test function.
983 * @test_func: The test function to invoke for this test.
985 * Create a new test case, similar to g_test_create_case(). However
986 * the test is assumed to use no fixture, and test suites are automatically
987 * created on the fly and added to the root fixture, based on the
988 * slash-separated portions of @testpath. The @test_data argument
989 * will be passed as first argument to @test_func.
994 g_test_add_data_func (const char *testpath,
995 gconstpointer test_data,
996 void (*test_func) (gconstpointer))
998 g_return_if_fail (testpath != NULL);
999 g_return_if_fail (testpath[0] == '/');
1000 g_return_if_fail (test_func != NULL);
1001 g_test_add_vtable (testpath, 0, test_data, NULL, (void(*)(void)) test_func, NULL);
1005 * g_test_create_suite:
1006 * @suite_name: a name for the suite
1008 * Create a new test suite with the name @suite_name.
1010 * Returns: A newly allocated #GTestSuite instance.
1015 g_test_create_suite (const char *suite_name)
1018 g_return_val_if_fail (suite_name != NULL, NULL);
1019 g_return_val_if_fail (strchr (suite_name, '/') == NULL, NULL);
1020 g_return_val_if_fail (suite_name[0] != 0, NULL);
1021 ts = g_slice_new0 (GTestSuite);
1022 ts->name = g_strdup (suite_name);
1028 * @suite: a #GTestSuite
1029 * @test_case: a #GTestCase
1031 * Adds @test_case to @suite.
1036 g_test_suite_add (GTestSuite *suite,
1037 GTestCase *test_case)
1039 g_return_if_fail (suite != NULL);
1040 g_return_if_fail (test_case != NULL);
1041 suite->cases = g_slist_prepend (suite->cases, test_case);
1045 * g_test_suite_add_suite:
1046 * @suite: a #GTestSuite
1047 * @nestedsuite: another #GTestSuite
1049 * Adds @nestedsuite to @suite.
1054 g_test_suite_add_suite (GTestSuite *suite,
1055 GTestSuite *nestedsuite)
1057 g_return_if_fail (suite != NULL);
1058 g_return_if_fail (nestedsuite != NULL);
1059 suite->suites = g_slist_prepend (suite->suites, nestedsuite);
1063 * g_test_queue_free:
1064 * @gfree_pointer: the pointer to be stored.
1066 * Enqueue a pointer to be released with g_free() during the next
1067 * teardown phase. This is equivalent to calling g_test_queue_destroy()
1068 * with a destroy callback of g_free().
1073 g_test_queue_free (gpointer gfree_pointer)
1076 g_test_queue_destroy (g_free, gfree_pointer);
1080 * g_test_queue_destroy:
1081 * @destroy_func: Destroy callback for teardown phase.
1082 * @destroy_data: Destroy callback data.
1084 * This function enqueus a callback @destroy_func() to be executed
1085 * during the next test case teardown phase. This is most useful
1086 * to auto destruct allocted test resources at the end of a test run.
1087 * Resources are released in reverse queue order, that means enqueueing
1088 * callback A before callback B will cause B() to be called before
1089 * A() during teardown.
1094 g_test_queue_destroy (GDestroyNotify destroy_func,
1095 gpointer destroy_data)
1097 DestroyEntry *dentry;
1098 g_return_if_fail (destroy_func != NULL);
1099 dentry = g_slice_new0 (DestroyEntry);
1100 dentry->destroy_func = destroy_func;
1101 dentry->destroy_data = destroy_data;
1102 dentry->next = test_destroy_queue;
1103 test_destroy_queue = dentry;
1107 test_case_run (GTestCase *tc)
1109 gchar *old_name = test_run_name, *old_base = g_strdup (test_uri_base);
1110 test_run_name = g_strconcat (old_name, "/", tc->name, NULL);
1111 if (++test_run_count <= test_skip_count)
1112 g_test_log (G_TEST_LOG_SKIP_CASE, test_run_name, NULL, 0, NULL);
1113 else if (test_run_list)
1115 g_print ("%s\n", test_run_name);
1116 g_test_log (G_TEST_LOG_LIST_CASE, test_run_name, NULL, 0, NULL);
1120 GTimer *test_run_timer = g_timer_new();
1121 long double largs[3];
1123 g_test_log (G_TEST_LOG_START_CASE, test_run_name, NULL, 0, NULL);
1125 g_timer_start (test_run_timer);
1126 fixture = tc->fixture_size ? g_malloc0 (tc->fixture_size) : tc->test_data;
1127 test_run_seed (test_run_seedstr);
1128 if (tc->fixture_setup)
1129 tc->fixture_setup (fixture, tc->test_data);
1130 tc->fixture_test (fixture, tc->test_data);
1132 while (test_destroy_queue)
1134 DestroyEntry *dentry = test_destroy_queue;
1135 test_destroy_queue = dentry->next;
1136 dentry->destroy_func (dentry->destroy_data);
1137 g_slice_free (DestroyEntry, dentry);
1139 if (tc->fixture_teardown)
1140 tc->fixture_teardown (fixture, tc->test_data);
1141 if (tc->fixture_size)
1143 g_timer_stop (test_run_timer);
1144 largs[0] = 0; /* OK */
1145 largs[1] = test_run_forks;
1146 largs[2] = g_timer_elapsed (test_run_timer, NULL);
1147 g_test_log (G_TEST_LOG_STOP_CASE, NULL, NULL, G_N_ELEMENTS (largs), largs);
1148 g_timer_destroy (test_run_timer);
1150 g_free (test_run_name);
1151 test_run_name = old_name;
1152 g_free (test_uri_base);
1153 test_uri_base = old_base;
1158 g_test_run_suite_internal (GTestSuite *suite,
1161 guint n_bad = 0, n_good = 0, bad_suite = 0, l;
1162 gchar *rest, *old_name = test_run_name;
1163 GSList *slist, *reversed;
1164 g_return_val_if_fail (suite != NULL, -1);
1165 while (path[0] == '/')
1168 rest = strchr (path, '/');
1169 l = rest ? MIN (l, rest - path) : l;
1170 test_run_name = suite->name[0] == 0 ? g_strdup (test_run_name) : g_strconcat (old_name, "/", suite->name, NULL);
1171 reversed = g_slist_reverse (g_slist_copy (suite->cases));
1172 for (slist = reversed; slist; slist = slist->next)
1174 GTestCase *tc = slist->data;
1175 guint n = l ? strlen (tc->name) : 0;
1176 if (l == n && strncmp (path, tc->name, n) == 0)
1179 n_bad += test_case_run (tc) != 0;
1182 g_slist_free (reversed);
1183 reversed = g_slist_reverse (g_slist_copy (suite->suites));
1184 for (slist = reversed; slist; slist = slist->next)
1186 GTestSuite *ts = slist->data;
1187 guint n = l ? strlen (ts->name) : 0;
1188 if (l == n && strncmp (path, ts->name, n) == 0)
1189 bad_suite += g_test_run_suite_internal (ts, rest ? rest : "") != 0;
1191 g_slist_free (reversed);
1192 g_free (test_run_name);
1193 test_run_name = old_name;
1194 return n_bad || bad_suite;
1199 * @suite: a #GTestSuite
1201 * Execute the tests within @suite and all nested #GTestSuites.
1202 * The test suites to be executed are filtered according to
1203 * test path arguments (-p <replaceable>testpath</replaceable>)
1204 * as parsed by g_test_init().
1205 * g_test_run_suite() or g_test_run() may only be called once
1208 * Returns: 0 on success
1213 g_test_run_suite (GTestSuite *suite)
1216 g_return_val_if_fail (g_test_config_vars->test_initialized, -1);
1217 g_return_val_if_fail (g_test_run_once == TRUE, -1);
1218 g_test_run_once = FALSE;
1220 test_paths = g_slist_prepend (test_paths, "");
1223 const char *rest, *path = test_paths->data;
1224 guint l, n = strlen (suite->name);
1225 test_paths = g_slist_delete_link (test_paths, test_paths);
1226 while (path[0] == '/')
1228 if (!n) /* root suite, run unconditionally */
1230 n_bad += 0 != g_test_run_suite_internal (suite, path);
1233 /* regular suite, match path */
1234 rest = strchr (path, '/');
1236 l = rest ? MIN (l, rest - path) : l;
1237 if ((!l || l == n) && strncmp (path, suite->name, n) == 0)
1238 n_bad += 0 != g_test_run_suite_internal (suite, rest ? rest : "");
1244 gtest_default_log_handler (const gchar *log_domain,
1245 GLogLevelFlags log_level,
1246 const gchar *message,
1247 gpointer unused_data)
1249 const gchar *strv[16];
1254 strv[i++] = log_domain;
1257 if (log_level & G_LOG_FLAG_FATAL)
1258 strv[i++] = "FATAL-";
1259 if (log_level & G_LOG_FLAG_RECURSION)
1260 strv[i++] = "RECURSIVE-";
1261 if (log_level & G_LOG_LEVEL_ERROR)
1262 strv[i++] = "ERROR";
1263 if (log_level & G_LOG_LEVEL_CRITICAL)
1264 strv[i++] = "CRITICAL";
1265 if (log_level & G_LOG_LEVEL_WARNING)
1266 strv[i++] = "WARNING";
1267 if (log_level & G_LOG_LEVEL_MESSAGE)
1268 strv[i++] = "MESSAGE";
1269 if (log_level & G_LOG_LEVEL_INFO)
1271 if (log_level & G_LOG_LEVEL_DEBUG)
1272 strv[i++] = "DEBUG";
1274 strv[i++] = message;
1276 msg = g_strjoinv ("", (gchar**) strv);
1277 g_test_log (G_TEST_LOG_ERROR, msg, NULL, 0, NULL);
1278 g_log_default_handler (log_domain, log_level, message, unused_data);
1283 g_assertion_message (const char *domain,
1287 const char *message)
1292 message = "code should not be reached";
1293 g_snprintf (lstr, 32, "%d", line);
1294 s = g_strconcat (domain ? domain : "", domain && domain[0] ? ":" : "",
1295 "ERROR:", file, ":", lstr, ":",
1296 func, func[0] ? ":" : "",
1297 " ", message, NULL);
1298 g_printerr ("**\n%s\n", s);
1299 g_test_log (G_TEST_LOG_ERROR, s, NULL, 0, NULL);
1305 g_assertion_message_expr (const char *domain,
1311 char *s = g_strconcat ("assertion failed: (", expr, ")", NULL);
1312 g_assertion_message (domain, file, line, func, s);
1317 g_assertion_message_cmpnum (const char *domain,
1330 case 'i': s = g_strdup_printf ("assertion failed (%s): (%.0Lf %s %.0Lf)", expr, arg1, cmp, arg2); break;
1331 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;
1332 case 'f': s = g_strdup_printf ("assertion failed (%s): (%.9Lg %s %.9Lg)", expr, arg1, cmp, arg2); break;
1333 /* ideally use: floats=%.7g double=%.17g */
1335 g_assertion_message (domain, file, line, func, s);
1340 g_assertion_message_cmpstr (const char *domain,
1349 char *a1, *a2, *s, *t1 = NULL, *t2 = NULL;
1350 a1 = arg1 ? g_strconcat ("\"", t1 = g_strescape (arg1, NULL), "\"", NULL) : g_strdup ("NULL");
1351 a2 = arg2 ? g_strconcat ("\"", t2 = g_strescape (arg2, NULL), "\"", NULL) : g_strdup ("NULL");
1354 s = g_strdup_printf ("assertion failed (%s): (%s %s %s)", expr, a1, cmp, a2);
1357 g_assertion_message (domain, file, line, func, s);
1363 * @str1: a C string or %NULL
1364 * @str2: another C string or %NULL
1366 * Compares @str1 and @str2 like strcmp(). Handles %NULL strings gracefully.
1368 * Returns: -1, 0 or 1, if @str1 is <, == or > than @str2.
1373 g_strcmp0 (const char *str1,
1377 return -(str1 != str2);
1379 return str1 != str2;
1380 return strcmp (str1, str2);
1384 static int /* 0 on success */
1385 kill_child (int pid,
1390 if (patience >= 3) /* try graceful reap */
1392 if (waitpid (pid, status, WNOHANG) > 0)
1395 if (patience >= 2) /* try SIGHUP */
1398 if (waitpid (pid, status, WNOHANG) > 0)
1400 g_usleep (20 * 1000); /* give it some scheduling/shutdown time */
1401 if (waitpid (pid, status, WNOHANG) > 0)
1403 g_usleep (50 * 1000); /* give it some scheduling/shutdown time */
1404 if (waitpid (pid, status, WNOHANG) > 0)
1406 g_usleep (100 * 1000); /* give it some scheduling/shutdown time */
1407 if (waitpid (pid, status, WNOHANG) > 0)
1410 if (patience >= 1) /* try SIGTERM */
1412 kill (pid, SIGTERM);
1413 if (waitpid (pid, status, WNOHANG) > 0)
1415 g_usleep (200 * 1000); /* give it some scheduling/shutdown time */
1416 if (waitpid (pid, status, WNOHANG) > 0)
1418 g_usleep (400 * 1000); /* give it some scheduling/shutdown time */
1419 if (waitpid (pid, status, WNOHANG) > 0)
1423 kill (pid, SIGKILL);
1425 wr = waitpid (pid, status, 0);
1426 while (wr < 0 && errno == EINTR);
1432 g_string_must_read (GString *gstring,
1435 #define STRING_BUFFER_SIZE 4096
1436 char buf[STRING_BUFFER_SIZE];
1439 bytes = read (fd, buf, sizeof (buf));
1441 return 0; /* EOF, calling this function assumes data is available */
1444 g_string_append_len (gstring, buf, bytes);
1447 else if (bytes < 0 && errno == EINTR)
1449 else /* bytes < 0 */
1451 g_warning ("failed to read() from child process (%d): %s", test_trap_last_pid, g_strerror (errno));
1452 return 1; /* ignore error after warning */
1457 g_string_write_out (GString *gstring,
1461 if (*stringpos < gstring->len)
1465 r = write (outfd, gstring->str + *stringpos, gstring->len - *stringpos);
1466 while (r < 0 && errno == EINTR);
1467 *stringpos += MAX (r, 0);
1472 test_trap_clear (void)
1474 test_trap_last_status = 0;
1475 test_trap_last_pid = 0;
1476 g_free (test_trap_last_stdout);
1477 test_trap_last_stdout = NULL;
1478 g_free (test_trap_last_stderr);
1479 test_trap_last_stderr = NULL;
1490 ret = dup2 (fd1, fd2);
1491 while (ret < 0 && errno == EINTR);
1496 test_time_stamp (void)
1500 g_get_current_time (&tv);
1502 stamp = stamp * 1000000 + tv.tv_usec;
1510 * @usec_timeout: Timeout for the forked test in micro seconds.
1511 * @test_trap_flags: Flags to modify forking behaviour.
1513 * Fork the current test program to execute a test case that might
1514 * not return or that might abort. The forked test case is aborted
1515 * and considered failing if its run time exceeds @usec_timeout.
1517 * The forking behavior can be configured with the #GTestTrapFlags flags.
1519 * In the following example, the test code forks, the forked child
1520 * process produces some sample output and exits successfully.
1521 * The forking parent process then asserts successful child program
1522 * termination and validates child program outputs.
1526 * test_fork_patterns (void)
1528 * if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
1530 * g_print ("some stdout text: somagic17\n");
1531 * g_printerr ("some stderr text: semagic43\n");
1532 * exit (0); /* successful test run */
1534 * g_test_trap_assert_passed();
1535 * g_test_trap_assert_stdout ("*somagic17*");
1536 * g_test_trap_assert_stderr ("*semagic43*");
1540 * This function is implemented only on Unix platforms.
1542 * Returns: %TRUE for the forked child and %FALSE for the executing parent process.
1547 g_test_trap_fork (guint64 usec_timeout,
1548 GTestTrapFlags test_trap_flags)
1551 gboolean pass_on_forked_log = FALSE;
1552 int stdout_pipe[2] = { -1, -1 };
1553 int stderr_pipe[2] = { -1, -1 };
1554 int stdtst_pipe[2] = { -1, -1 };
1556 if (pipe (stdout_pipe) < 0 || pipe (stderr_pipe) < 0 || pipe (stdtst_pipe) < 0)
1557 g_error ("failed to create pipes to fork test program: %s", g_strerror (errno));
1558 signal (SIGCHLD, SIG_DFL);
1559 test_trap_last_pid = fork ();
1560 if (test_trap_last_pid < 0)
1561 g_error ("failed to fork test program: %s", g_strerror (errno));
1562 if (test_trap_last_pid == 0) /* child */
1565 close (stdout_pipe[0]);
1566 close (stderr_pipe[0]);
1567 close (stdtst_pipe[0]);
1568 if (!(test_trap_flags & G_TEST_TRAP_INHERIT_STDIN))
1569 fd0 = open ("/dev/null", O_RDONLY);
1570 if (sane_dup2 (stdout_pipe[1], 1) < 0 || sane_dup2 (stderr_pipe[1], 2) < 0 || (fd0 >= 0 && sane_dup2 (fd0, 0) < 0))
1571 g_error ("failed to dup2() in forked test program: %s", g_strerror (errno));
1574 if (stdout_pipe[1] >= 3)
1575 close (stdout_pipe[1]);
1576 if (stderr_pipe[1] >= 3)
1577 close (stderr_pipe[1]);
1578 test_log_fd = stdtst_pipe[1];
1583 GString *sout = g_string_new (NULL);
1584 GString *serr = g_string_new (NULL);
1586 int soutpos = 0, serrpos = 0, wr, need_wait = TRUE;
1588 close (stdout_pipe[1]);
1589 close (stderr_pipe[1]);
1590 close (stdtst_pipe[1]);
1591 sstamp = test_time_stamp();
1592 /* read data until we get EOF on all pipes */
1593 while (stdout_pipe[0] >= 0 || stderr_pipe[0] >= 0 || stdtst_pipe[0] > 0)
1599 if (stdout_pipe[0] >= 0)
1600 FD_SET (stdout_pipe[0], &fds);
1601 if (stderr_pipe[0] >= 0)
1602 FD_SET (stderr_pipe[0], &fds);
1603 if (stdtst_pipe[0] >= 0)
1604 FD_SET (stdtst_pipe[0], &fds);
1606 tv.tv_usec = MIN (usec_timeout ? usec_timeout : 1000000, 100 * 1000); /* sleep at most 0.5 seconds to catch clock skews, etc. */
1607 ret = select (MAX (MAX (stdout_pipe[0], stderr_pipe[0]), stdtst_pipe[0]) + 1, &fds, NULL, NULL, &tv);
1608 if (ret < 0 && errno != EINTR)
1610 g_warning ("Unexpected error in select() while reading from child process (%d): %s", test_trap_last_pid, g_strerror (errno));
1613 if (stdout_pipe[0] >= 0 && FD_ISSET (stdout_pipe[0], &fds) &&
1614 g_string_must_read (sout, stdout_pipe[0]) == 0)
1616 close (stdout_pipe[0]);
1617 stdout_pipe[0] = -1;
1619 if (stderr_pipe[0] >= 0 && FD_ISSET (stderr_pipe[0], &fds) &&
1620 g_string_must_read (serr, stderr_pipe[0]) == 0)
1622 close (stderr_pipe[0]);
1623 stderr_pipe[0] = -1;
1625 if (stdtst_pipe[0] >= 0 && FD_ISSET (stdtst_pipe[0], &fds))
1627 guint8 buffer[4096];
1628 gint l, r = read (stdtst_pipe[0], buffer, sizeof (buffer));
1629 if (r > 0 && test_log_fd > 0)
1631 l = write (pass_on_forked_log ? test_log_fd : -1, buffer, r);
1632 while (l < 0 && errno == EINTR);
1633 if (r == 0 || (r < 0 && errno != EINTR && errno != EAGAIN))
1635 close (stdtst_pipe[0]);
1636 stdtst_pipe[0] = -1;
1639 if (!(test_trap_flags & G_TEST_TRAP_SILENCE_STDOUT))
1640 g_string_write_out (sout, 1, &soutpos);
1641 if (!(test_trap_flags & G_TEST_TRAP_SILENCE_STDERR))
1642 g_string_write_out (serr, 2, &serrpos);
1645 guint64 nstamp = test_time_stamp();
1647 sstamp = MIN (sstamp, nstamp); /* guard against backwards clock skews */
1648 if (usec_timeout < nstamp - sstamp)
1650 /* timeout reached, need to abort the child now */
1651 kill_child (test_trap_last_pid, &status, 3);
1652 test_trap_last_status = 1024; /* timeout */
1653 if (0 && WIFSIGNALED (status))
1654 g_printerr ("%s: child timed out and received: %s\n", G_STRFUNC, g_strsignal (WTERMSIG (status)));
1660 close (stdout_pipe[0]);
1661 close (stderr_pipe[0]);
1662 close (stdtst_pipe[0]);
1667 wr = waitpid (test_trap_last_pid, &status, 0);
1668 while (wr < 0 && errno == EINTR);
1669 if (WIFEXITED (status)) /* normal exit */
1670 test_trap_last_status = WEXITSTATUS (status); /* 0..255 */
1671 else if (WIFSIGNALED (status))
1672 test_trap_last_status = (WTERMSIG (status) << 12); /* signalled */
1673 else /* WCOREDUMP (status) */
1674 test_trap_last_status = 512; /* coredump */
1676 test_trap_last_stdout = g_string_free (sout, FALSE);
1677 test_trap_last_stderr = g_string_free (serr, FALSE);
1681 g_message ("Not implemented: g_test_trap_fork");
1688 * g_test_trap_has_passed:
1690 * Check the result of the last g_test_trap_fork() call.
1692 * Returns: %TRUE if the last forked child terminated successfully.
1697 g_test_trap_has_passed (void)
1699 return test_trap_last_status == 0; /* exit_status == 0 && !signal && !coredump */
1703 * g_test_trap_reached_timeout:
1705 * Check the result of the last g_test_trap_fork() call.
1707 * Returns: %TRUE if the last forked child got killed due to a fork timeout.
1712 g_test_trap_reached_timeout (void)
1714 return 0 != (test_trap_last_status & 1024); /* timeout flag */
1718 g_test_trap_assertions (const char *domain,
1722 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
1723 const char *pattern)
1726 gboolean must_pass = assertion_flags == 0;
1727 gboolean must_fail = assertion_flags == 1;
1728 gboolean match_result = 0 == (assertion_flags & 1);
1729 const char *stdout_pattern = (assertion_flags & 2) ? pattern : NULL;
1730 const char *stderr_pattern = (assertion_flags & 4) ? pattern : NULL;
1731 const char *match_error = match_result ? "failed to match" : "contains invalid match";
1732 if (test_trap_last_pid == 0)
1733 g_error ("child process failed to exit after g_test_trap_fork() and before g_test_trap_assert*()");
1734 if (must_pass && !g_test_trap_has_passed())
1736 char *msg = g_strdup_printf ("child process (%d) of test trap failed unexpectedly", test_trap_last_pid);
1737 g_assertion_message (domain, file, line, func, msg);
1740 if (must_fail && g_test_trap_has_passed())
1742 char *msg = g_strdup_printf ("child process (%d) did not fail as expected", test_trap_last_pid);
1743 g_assertion_message (domain, file, line, func, msg);
1746 if (stdout_pattern && match_result == !g_pattern_match_simple (stdout_pattern, test_trap_last_stdout))
1748 char *msg = g_strdup_printf ("stdout of child process (%d) %s: %s", test_trap_last_pid, match_error, stdout_pattern);
1749 g_assertion_message (domain, file, line, func, msg);
1752 if (stderr_pattern && match_result == !g_pattern_match_simple (stderr_pattern, test_trap_last_stderr))
1754 char *msg = g_strdup_printf ("stderr of child process (%d) %s: %s", test_trap_last_pid, match_error, stderr_pattern);
1755 g_assertion_message (domain, file, line, func, msg);
1762 gstring_overwrite_int (GString *gstring,
1766 vuint = g_htonl (vuint);
1767 g_string_overwrite_len (gstring, pos, (const gchar*) &vuint, 4);
1771 gstring_append_int (GString *gstring,
1774 vuint = g_htonl (vuint);
1775 g_string_append_len (gstring, (const gchar*) &vuint, 4);
1779 gstring_append_double (GString *gstring,
1782 union { double vdouble; guint64 vuint64; } u;
1783 u.vdouble = vdouble;
1784 u.vuint64 = GUINT64_TO_BE (u.vuint64);
1785 g_string_append_len (gstring, (const gchar*) &u.vuint64, 8);
1789 g_test_log_dump (GTestLogMsg *msg,
1792 GString *gstring = g_string_sized_new (1024);
1794 gstring_append_int (gstring, 0); /* message length */
1795 gstring_append_int (gstring, msg->log_type);
1796 gstring_append_int (gstring, msg->n_strings);
1797 gstring_append_int (gstring, msg->n_nums);
1798 gstring_append_int (gstring, 0); /* reserved */
1799 for (ui = 0; ui < msg->n_strings; ui++)
1801 guint l = strlen (msg->strings[ui]);
1802 gstring_append_int (gstring, l);
1803 g_string_append_len (gstring, msg->strings[ui], l);
1805 for (ui = 0; ui < msg->n_nums; ui++)
1806 gstring_append_double (gstring, msg->nums[ui]);
1807 *len = gstring->len;
1808 gstring_overwrite_int (gstring, 0, *len); /* message length */
1809 return (guint8*) g_string_free (gstring, FALSE);
1812 static inline long double
1813 net_double (const gchar **ipointer)
1815 union { guint64 vuint64; double vdouble; } u;
1816 guint64 aligned_int64;
1817 memcpy (&aligned_int64, *ipointer, 8);
1819 u.vuint64 = GUINT64_FROM_BE (aligned_int64);
1823 static inline guint32
1824 net_int (const gchar **ipointer)
1826 guint32 aligned_int;
1827 memcpy (&aligned_int, *ipointer, 4);
1829 return g_ntohl (aligned_int);
1833 g_test_log_extract (GTestLogBuffer *tbuffer)
1835 const gchar *p = tbuffer->data->str;
1838 if (tbuffer->data->len < 4 * 5)
1840 mlength = net_int (&p);
1841 if (tbuffer->data->len < mlength)
1843 msg.log_type = net_int (&p);
1844 msg.n_strings = net_int (&p);
1845 msg.n_nums = net_int (&p);
1846 if (net_int (&p) == 0)
1849 msg.strings = g_new0 (gchar*, msg.n_strings + 1);
1850 msg.nums = g_new0 (long double, msg.n_nums);
1851 for (ui = 0; ui < msg.n_strings; ui++)
1853 guint sl = net_int (&p);
1854 msg.strings[ui] = g_strndup (p, sl);
1857 for (ui = 0; ui < msg.n_nums; ui++)
1858 msg.nums[ui] = net_double (&p);
1859 if (p <= tbuffer->data->str + mlength)
1861 g_string_erase (tbuffer->data, 0, mlength);
1862 tbuffer->msgs = g_slist_prepend (tbuffer->msgs, g_memdup (&msg, sizeof (msg)));
1867 g_strfreev (msg.strings);
1868 g_error ("corrupt log stream from test program");
1873 * g_test_log_buffer_new:
1875 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
1878 g_test_log_buffer_new (void)
1880 GTestLogBuffer *tb = g_new0 (GTestLogBuffer, 1);
1881 tb->data = g_string_sized_new (1024);
1886 * g_test_log_buffer_free
1888 * Internal function for gtester to free test log messages, no ABI guarantees provided.
1891 g_test_log_buffer_free (GTestLogBuffer *tbuffer)
1893 g_return_if_fail (tbuffer != NULL);
1894 while (tbuffer->msgs)
1895 g_test_log_msg_free (g_test_log_buffer_pop (tbuffer));
1896 g_string_free (tbuffer->data, TRUE);
1901 * g_test_log_buffer_push
1903 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
1906 g_test_log_buffer_push (GTestLogBuffer *tbuffer,
1908 const guint8 *bytes)
1910 g_return_if_fail (tbuffer != NULL);
1913 gboolean more_messages;
1914 g_return_if_fail (bytes != NULL);
1915 g_string_append_len (tbuffer->data, (const gchar*) bytes, n_bytes);
1917 more_messages = g_test_log_extract (tbuffer);
1918 while (more_messages);
1923 * g_test_log_buffer_pop:
1925 * Internal function for gtester to retrieve test log messages, no ABI guarantees provided.
1928 g_test_log_buffer_pop (GTestLogBuffer *tbuffer)
1930 GTestLogMsg *msg = NULL;
1931 g_return_val_if_fail (tbuffer != NULL, NULL);
1934 GSList *slist = g_slist_last (tbuffer->msgs);
1936 tbuffer->msgs = g_slist_delete_link (tbuffer->msgs, slist);
1942 * g_test_log_msg_free:
1944 * Internal function for gtester to free test log messages, no ABI guarantees provided.
1947 g_test_log_msg_free (GTestLogMsg *tmsg)
1949 g_return_if_fail (tmsg != NULL);
1950 g_strfreev (tmsg->strings);
1951 g_free (tmsg->nums);
1955 /* --- macros docs START --- */
1958 * @testpath: The test path for a new test case.
1959 * @Fixture: The type of a fixture data structure.
1960 * @tdata: Data argument for the test functions.
1961 * @fsetup: The function to set up the fixture data.
1962 * @ftest: The actual test function.
1963 * @fteardown: The function to tear down the fixture data.
1965 * Hook up a new test case at @testpath, similar to g_test_add_func().
1966 * A fixture data structure with setup and teardown function may be provided
1967 * though, similar to g_test_create_case().
1968 * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
1969 * fteardown() callbacks can expect a @Fixture pointer as first argument in
1970 * a type safe manner.
1974 /* --- macros docs END --- */
1976 #define __G_TEST_UTILS_C__
1977 #include "galiasdef.c"