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>
39 #ifdef HAVE_SYS_SELECT_H
40 #include <sys/select.h>
41 #endif /* HAVE_SYS_SELECT_H */
43 /* --- structures --- */
48 void (*fixture_setup) (void*, gconstpointer);
49 void (*fixture_test) (void*, gconstpointer);
50 void (*fixture_teardown) (void*, gconstpointer);
59 typedef struct DestroyEntry DestroyEntry;
63 GDestroyNotify destroy_func;
64 gpointer destroy_data;
67 /* --- prototypes --- */
68 static void test_run_seed (const gchar *rseed);
69 static void test_trap_clear (void);
70 static guint8* g_test_log_dump (GTestLogMsg *msg,
72 static void gtest_default_log_handler (const gchar *log_domain,
73 GLogLevelFlags log_level,
75 gpointer unused_data);
78 /* --- variables --- */
79 static int test_log_fd = -1;
80 static gboolean test_mode_fatal = TRUE;
81 static gboolean g_test_run_once = TRUE;
82 static gboolean test_run_list = FALSE;
83 static gchar *test_run_seedstr = NULL;
84 static GRand *test_run_rand = NULL;
85 static gchar *test_run_name = "";
86 static guint test_run_forks = 0;
87 static guint test_run_count = 0;
88 static guint test_skip_count = 0;
89 static GTimer *test_user_timer = NULL;
90 static double test_user_stamp = 0;
91 static GSList *test_paths = NULL;
92 static GTestSuite *test_suite_root = NULL;
93 static int test_trap_last_status = 0;
94 static int test_trap_last_pid = 0;
95 static char *test_trap_last_stdout = NULL;
96 static char *test_trap_last_stderr = NULL;
97 static char *test_uri_base = NULL;
98 static gboolean test_debug_log = FALSE;
99 static DestroyEntry *test_destroy_queue = NULL;
100 static GTestConfig mutable_test_config_vars = {
101 FALSE, /* test_initialized */
102 TRUE, /* test_quick */
103 FALSE, /* test_perf */
104 FALSE, /* test_verbose */
105 FALSE, /* test_quiet */
107 const GTestConfig * const g_test_config_vars = &mutable_test_config_vars;
109 /* --- functions --- */
111 g_test_log_type_name (GTestLogType log_type)
115 case G_TEST_LOG_NONE: return "none";
116 case G_TEST_LOG_ERROR: return "error";
117 case G_TEST_LOG_START_BINARY: return "binary";
118 case G_TEST_LOG_LIST_CASE: return "list";
119 case G_TEST_LOG_SKIP_CASE: return "skip";
120 case G_TEST_LOG_START_CASE: return "start";
121 case G_TEST_LOG_STOP_CASE: return "stop";
122 case G_TEST_LOG_MIN_RESULT: return "minperf";
123 case G_TEST_LOG_MAX_RESULT: return "maxperf";
124 case G_TEST_LOG_MESSAGE: return "message";
130 g_test_log_send (guint n_bytes,
131 const guint8 *buffer)
133 if (test_log_fd >= 0)
137 r = write (test_log_fd, buffer, n_bytes);
138 while (r < 0 && errno == EINTR);
142 GTestLogBuffer *lbuffer = g_test_log_buffer_new();
145 g_test_log_buffer_push (lbuffer, n_bytes, buffer);
146 msg = g_test_log_buffer_pop (lbuffer);
147 g_assert (msg != NULL); /* FIXME: should be g_awrn_if_fail */
148 g_assert (lbuffer->data->len == 0); /* FIXME: should be g_awrn_if_fail */
149 g_test_log_buffer_free (lbuffer);
151 g_printerr ("{*LOG(%s)", g_test_log_type_name (msg->log_type));
152 for (ui = 0; ui < msg->n_strings; ui++)
153 g_printerr (":{%s}", msg->strings[ui]);
157 for (ui = 0; ui < msg->n_nums; ui++)
158 g_printerr ("%s%.16Lg", ui ? ";" : "", msg->nums[ui]);
161 g_printerr (":LOG*}\n");
162 g_test_log_msg_free (msg);
167 g_test_log (GTestLogType lbit,
168 const gchar *string1,
169 const gchar *string2,
173 gboolean fail = lbit == G_TEST_LOG_STOP_CASE && largs[0] != 0;
175 gchar *astrings[3] = { NULL, NULL, NULL };
181 case G_TEST_LOG_START_BINARY:
182 if (g_test_verbose())
183 g_print ("GTest: random seed: %s\n", string2);
185 case G_TEST_LOG_STOP_CASE:
186 if (g_test_verbose())
187 g_print ("GTest: result: %s\n", fail ? "FAIL" : "OK");
188 else if (!g_test_quiet())
189 g_print ("%s\n", fail ? "FAIL" : "OK");
190 if (fail && test_mode_fatal)
193 case G_TEST_LOG_MIN_RESULT:
194 if (g_test_verbose())
195 g_print ("(MINPERF:%s)\n", string1);
197 case G_TEST_LOG_MAX_RESULT:
198 if (g_test_verbose())
199 g_print ("(MAXPERF:%s)\n", string1);
201 case G_TEST_LOG_MESSAGE:
202 if (g_test_verbose())
203 g_print ("(MSG: %s)\n", string1);
209 msg.n_strings = (string1 != NULL) + (string1 && string2);
210 msg.strings = astrings;
211 astrings[0] = (gchar*) string1;
212 astrings[1] = astrings[0] ? (gchar*) string2 : NULL;
215 dbuffer = g_test_log_dump (&msg, &dbufferlen);
216 g_test_log_send (dbufferlen, dbuffer);
221 case G_TEST_LOG_START_CASE:
222 if (g_test_verbose())
223 g_print ("GTest: run: %s\n", string1);
224 else if (!g_test_quiet())
225 g_print ("%s: ", string1);
232 parse_args (gint *argc_p,
235 guint argc = *argc_p;
236 gchar **argv = *argv_p;
238 /* parse known args */
239 for (i = 1; i < argc; i++)
241 if (strcmp (argv[i], "--g-fatal-warnings") == 0)
243 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
244 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
245 g_log_set_always_fatal (fatal_mask);
248 else if (strcmp (argv[i], "--keep-going") == 0 ||
249 strcmp (argv[i], "-k") == 0)
251 test_mode_fatal = FALSE;
254 else if (strcmp (argv[i], "--debug-log") == 0)
256 test_debug_log = TRUE;
259 else if (strcmp ("--GTestLogFD", argv[i]) == 0 || strncmp ("--GTestLogFD=", argv[i], 13) == 0)
261 gchar *equal = argv[i] + 12;
263 test_log_fd = g_ascii_strtoull (equal + 1, NULL, 0);
264 else if (i + 1 < argc)
267 test_log_fd = g_ascii_strtoull (argv[i], NULL, 0);
271 else if (strcmp ("--GTestSkipCount", argv[i]) == 0 || strncmp ("--GTestSkipCount=", argv[i], 17) == 0)
273 gchar *equal = argv[i] + 16;
275 test_skip_count = g_ascii_strtoull (equal + 1, NULL, 0);
276 else if (i + 1 < argc)
279 test_skip_count = g_ascii_strtoull (argv[i], NULL, 0);
283 else if (strcmp ("-p", argv[i]) == 0 || strncmp ("-p=", argv[i], 3) == 0)
285 gchar *equal = argv[i] + 2;
287 test_paths = g_slist_prepend (test_paths, equal + 1);
288 else if (i + 1 < argc)
291 test_paths = g_slist_prepend (test_paths, argv[i]);
295 else if (strcmp ("-m", argv[i]) == 0 || strncmp ("-m=", argv[i], 3) == 0)
297 gchar *equal = argv[i] + 2;
298 const gchar *mode = "";
301 else if (i + 1 < argc)
306 if (strcmp (mode, "perf") == 0)
307 mutable_test_config_vars.test_perf = TRUE;
308 else if (strcmp (mode, "slow") == 0)
309 mutable_test_config_vars.test_quick = FALSE;
310 else if (strcmp (mode, "thorough") == 0)
311 mutable_test_config_vars.test_quick = FALSE;
312 else if (strcmp (mode, "quick") == 0)
314 mutable_test_config_vars.test_quick = TRUE;
315 mutable_test_config_vars.test_perf = FALSE;
318 g_error ("unknown test mode: -m %s", mode);
321 else if (strcmp ("-q", argv[i]) == 0 || strcmp ("--quiet", argv[i]) == 0)
323 mutable_test_config_vars.test_quiet = TRUE;
324 mutable_test_config_vars.test_verbose = FALSE;
327 else if (strcmp ("--verbose", argv[i]) == 0)
329 mutable_test_config_vars.test_quiet = FALSE;
330 mutable_test_config_vars.test_verbose = TRUE;
333 else if (strcmp ("-l", argv[i]) == 0)
335 test_run_list = TRUE;
338 else if (strcmp ("--seed", argv[i]) == 0 || strncmp ("--seed=", argv[i], 7) == 0)
340 gchar *equal = argv[i] + 6;
342 test_run_seedstr = equal + 1;
343 else if (i + 1 < argc)
346 test_run_seedstr = argv[i];
353 for (i = 1; i < argc; i++)
365 * @argc: Address of the @argc parameter of the main() function.
366 * Changed if any arguments were handled.
367 * @argv: Address of the @argv parameter of main().
368 * Any parameters understood by g_test_init() stripped before return.
369 * @Varargs: Reserved for future extension. Currently, you must pass %NULL.
371 * Initialize the GLib testing framework, e.g. by seeding the
372 * test random number generator, the name for g_get_prgname()
373 * and parsing test related command line args.
374 * So far, the following arguments are understood:
377 * <term><option>-l</option></term>
379 * list test cases available in a test executable.
383 * <term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
385 * provide a random seed to reproduce test runs using random numbers.
389 * <term><option>--verbose</option></term>
390 * <listitem><para>run tests verbosely.</para></listitem>
393 * <term><option>-q</option>, <option>--quiet</option></term>
394 * <listitem><para>run tests quietly.</para></listitem>
397 * <term><option>-p <replaceable>TESTPATH</replaceable></option></term>
399 * execute all tests matching <replaceable>TESTPATH</replaceable>.
403 * <term><option>-m {perf|slow|thorough|quick}</option></term>
405 * execute tests according to these test modes:
410 * performance tests, may take long and report results.
414 * <term>slow, thorough</term>
416 * slow and thorough tests, may take quite long and
423 * quick tests, should run really quickly and give good coverage.
430 * <term><option>--debug-log</option></term>
431 * <listitem><para>debug test logging output.</para></listitem>
434 * <term><option>-k</option>, <option>--keep-going</option></term>
435 * <listitem><para>gtester-specific argument.</para></listitem>
438 * <term><option>--GTestLogFD <replaceable>N</replaceable></option></term>
439 * <listitem><para>gtester-specific argument.</para></listitem>
442 * <term><option>--GTestSkipCount <replaceable>N</replaceable></option></term>
443 * <listitem><para>gtester-specific argument.</para></listitem>
450 g_test_init (int *argc,
454 static char seedstr[4 + 4 * 8 + 1];
457 /* make warnings and criticals fatal for all test programs */
458 GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
459 fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
460 g_log_set_always_fatal (fatal_mask);
461 /* check caller args */
462 g_return_if_fail (argc != NULL);
463 g_return_if_fail (argv != NULL);
464 g_return_if_fail (g_test_config_vars->test_initialized == FALSE);
465 mutable_test_config_vars.test_initialized = TRUE;
467 va_start (args, argv);
468 vararg1 = va_arg (args, gpointer); /* reserved for future extensions */
470 g_return_if_fail (vararg1 == NULL);
472 /* setup random seed string */
473 g_snprintf (seedstr, sizeof (seedstr), "R02S%08x%08x%08x%08x", g_random_int(), g_random_int(), g_random_int(), g_random_int());
474 test_run_seedstr = seedstr;
476 /* parse args, sets up mode, changes seed, etc. */
477 parse_args (argc, argv);
478 if (!g_get_prgname())
479 g_set_prgname ((*argv)[0]);
481 /* verify GRand reliability, needed for reliable seeds */
484 GRand *rg = g_rand_new_with_seed (0xc8c49fb6);
485 guint32 t1 = g_rand_int (rg), t2 = g_rand_int (rg), t3 = g_rand_int (rg), t4 = g_rand_int (rg);
486 /* g_print ("GRand-current: 0x%x 0x%x 0x%x 0x%x\n", t1, t2, t3, t4); */
487 if (t1 != 0xfab39f9b || t2 != 0xb948fb0e || t3 != 0x3d31be26 || t4 != 0x43a19d66)
488 g_warning ("random numbers are not GRand-2.2 compatible, seeds may be broken (check $G_RANDOM_VERSION)");
492 /* check rand seed */
493 test_run_seed (test_run_seedstr);
495 /* report program start */
496 g_log_set_default_handler (gtest_default_log_handler, NULL);
497 g_test_log (G_TEST_LOG_START_BINARY, g_get_prgname(), test_run_seedstr, 0, NULL);
501 test_run_seed (const gchar *rseed)
503 guint seed_failed = 0;
505 g_rand_free (test_run_rand);
506 test_run_rand = NULL;
507 while (strchr (" \t\v\r\n\f", *rseed))
509 if (strncmp (rseed, "R02S", 4) == 0) /* seed for random generator 02 (GRand-2.2) */
511 const char *s = rseed + 4;
512 if (strlen (s) >= 32) /* require 4 * 8 chars */
514 guint32 seedarray[4];
515 gchar *p, hexbuf[9] = { 0, };
516 memcpy (hexbuf, s + 0, 8);
517 seedarray[0] = g_ascii_strtoull (hexbuf, &p, 16);
518 seed_failed += p != NULL && *p != 0;
519 memcpy (hexbuf, s + 8, 8);
520 seedarray[1] = g_ascii_strtoull (hexbuf, &p, 16);
521 seed_failed += p != NULL && *p != 0;
522 memcpy (hexbuf, s + 16, 8);
523 seedarray[2] = g_ascii_strtoull (hexbuf, &p, 16);
524 seed_failed += p != NULL && *p != 0;
525 memcpy (hexbuf, s + 24, 8);
526 seedarray[3] = g_ascii_strtoull (hexbuf, &p, 16);
527 seed_failed += p != NULL && *p != 0;
530 test_run_rand = g_rand_new_with_seed_array (seedarray, 4);
535 g_error ("Unknown or invalid random seed: %s", rseed);
541 * Get a reproducible random integer number.
543 * The random numbers generated by the g_test_rand_*() family of functions
544 * change with every new test program start, unless the --seed option is
545 * given when starting test programs.
547 * For individual test cases however, the random number generator is
548 * reseeded, to avoid dependencies between tests and to make --seed
549 * effective for all test cases.
551 * Returns: a random number from the seeded random number generator.
556 g_test_rand_int (void)
558 return g_rand_int (test_run_rand);
562 * g_test_rand_int_range:
563 * @begin: the minimum value returned by this function
564 * @end: the smallest value not to be returned by this function
566 * Get a reproducible random integer number out of a specified range,
567 * see g_test_rand_int() for details on test case random numbers.
569 * Returns: a number with @begin <= number < @end.
574 g_test_rand_int_range (gint32 begin,
577 return g_rand_int_range (test_run_rand, begin, end);
581 * g_test_rand_double:
583 * Get a reproducible random floating point number,
584 * see g_test_rand_int() for details on test case random numbers.
586 * Returns: a random number from the seeded random number generator.
591 g_test_rand_double (void)
593 return g_rand_double (test_run_rand);
597 * g_test_rand_double_range:
598 * @range_start: the minimum value returned by this function
599 * @range_end: the minimum value not returned by this function
601 * Get a reproducible random floating pointer number out of a specified range,
602 * see g_test_rand_int() for details on test case random numbers.
604 * Returns: a number with @range_start <= number < @range_end.
609 g_test_rand_double_range (double range_start,
612 return g_rand_double_range (test_run_rand, range_start, range_end);
616 * g_test_timer_start:
618 * Start a timing test. Call g_test_timer_elapsed() when the task is supposed
619 * to be done. Call this function again to restart the timer.
624 g_test_timer_start (void)
626 if (!test_user_timer)
627 test_user_timer = g_timer_new();
629 g_timer_start (test_user_timer);
633 * g_test_timer_elapsed:
635 * Get the time since the last start of the timer with g_test_timer_start().
637 * Returns: the time since the last start of the timer, as a double
642 g_test_timer_elapsed (void)
644 test_user_stamp = test_user_timer ? g_timer_elapsed (test_user_timer, NULL) : 0;
645 return test_user_stamp;
651 * Report the last result of g_test_timer_elapsed().
653 * Returns: the last result of g_test_timer_elapsed(), as a double
658 g_test_timer_last (void)
660 return test_user_stamp;
664 * g_test_minimized_result:
665 * @minimized_quantity: the reported value
666 * @format: the format string of the report message
667 * @Varargs: arguments to pass to the printf() function
669 * Report the result of a performance or measurement test.
670 * The test should generally strive to minimize the reported
671 * quantities (smaller values are better than larger ones),
672 * this and @minimized_quantity can determine sorting
673 * order for test result reports.
678 g_test_minimized_result (double minimized_quantity,
682 long double largs = minimized_quantity;
685 va_start (args, format);
686 buffer = g_strdup_vprintf (format, args);
688 g_test_log (G_TEST_LOG_MIN_RESULT, buffer, NULL, 1, &largs);
693 * g_test_maximized_result:
694 * @maximized_quantity: the reported value
695 * @format: the format string of the report message
696 * @Varargs: arguments to pass to the printf() function
698 * Report the result of a performance or measurement test.
699 * The test should generally strive to maximize the reported
700 * quantities (larger values are better than smaller ones),
701 * this and @maximized_quantity can determine sorting
702 * order for test result reports.
707 g_test_maximized_result (double maximized_quantity,
711 long double largs = maximized_quantity;
714 va_start (args, format);
715 buffer = g_strdup_vprintf (format, args);
717 g_test_log (G_TEST_LOG_MAX_RESULT, buffer, NULL, 1, &largs);
723 * @format: the format string
724 * @...: printf-like arguments to @format
726 * Add a message to the test report.
731 g_test_message (const char *format,
736 va_start (args, format);
737 buffer = g_strdup_vprintf (format, args);
739 g_test_log (G_TEST_LOG_MESSAGE, buffer, NULL, 0, NULL);
745 * @uri_pattern: the base pattern for bug URIs
747 * Specify the base URI for bug reports.
749 * The base URI is used to construct bug report messages for
750 * g_test_message() when g_test_bug() is called.
751 * Calling this function outside of a test case sets the
752 * default base URI for all test cases. Calling it from within
753 * a test case changes the base URI for the scope of the test
755 * Bug URIs are constructed by appending a bug specific URI
756 * portion to @uri_pattern, or by replacing the special string
757 * '%s' within @uri_pattern if that is present.
762 g_test_bug_base (const char *uri_pattern)
764 g_free (test_uri_base);
765 test_uri_base = g_strdup (uri_pattern);
770 * @bug_uri_snippet: Bug specific bug tracker URI portion.
772 * This function adds a message to test reports that
773 * associates a bug URI with a test case.
774 * Bug URIs are constructed from a base URI set with g_test_bug_base()
775 * and @bug_uri_snippet.
780 g_test_bug (const char *bug_uri_snippet)
783 g_return_if_fail (test_uri_base != NULL);
784 g_return_if_fail (bug_uri_snippet != NULL);
785 c = strstr (test_uri_base, "%s");
788 char *b = g_strndup (test_uri_base, c - test_uri_base);
789 char *s = g_strconcat (b, bug_uri_snippet, c + 2, NULL);
791 g_test_message ("Bug Reference: %s", s);
795 g_test_message ("Bug Reference: %s%s", test_uri_base, bug_uri_snippet);
801 * Get the toplevel test suite for the test path API.
803 * Returns: the toplevel #GTestSuite
808 g_test_get_root (void)
810 if (!test_suite_root)
812 test_suite_root = g_test_create_suite ("root");
813 g_free (test_suite_root->name);
814 test_suite_root->name = g_strdup ("");
816 return test_suite_root;
822 * Runs all tests under the toplevel suite which can be retrieved
823 * with g_test_get_root(). Similar to g_test_run_suite(), the test
824 * cases to be run are filtered according to
825 * test path arguments (-p <replaceable>testpath</replaceable>) as
826 * parsed by g_test_init().
827 * g_test_run_suite() or g_test_run() may only be called once
830 * Returns: 0 on success
837 return g_test_run_suite (g_test_get_root());
841 * g_test_create_case:
842 * @test_name: the name for the test case
843 * @data_size: the size of the fixture data structure
844 * @test_data: test data argument for the test functions
845 * @data_setup: the function to set up the fixture data
846 * @data_test: the actual test function
847 * @data_teardown: the function to teardown the fixture data
849 * Create a new #GTestCase, named @test_name, this API is fairly
850 * low level, calling g_test_add() or g_test_add_func() is preferable.
851 * When this test is executed, a fixture structure of size @data_size
852 * will be allocated and filled with 0s. Then data_setup() is called
853 * to initialize the fixture. After fixture setup, the actual test
854 * function data_test() is called. Once the test run completed, the
855 * fixture structure is torn down by calling data_teardown() and
856 * after that the memory is released.
858 * Splitting up a test run into fixture setup, test function and
859 * fixture teardown is most usful if the same fixture is used for
860 * multiple tests. In this cases, g_test_create_case() will be
861 * called with the same fixture, but varying @test_name and
862 * @data_test arguments.
864 * Returns: a newly allocated #GTestCase.
869 g_test_create_case (const char *test_name,
871 gconstpointer test_data,
872 void (*data_setup) (void),
873 void (*data_test) (void),
874 void (*data_teardown) (void))
877 g_return_val_if_fail (test_name != NULL, NULL);
878 g_return_val_if_fail (strchr (test_name, '/') == NULL, NULL);
879 g_return_val_if_fail (test_name[0] != 0, NULL);
880 g_return_val_if_fail (data_test != NULL, NULL);
881 tc = g_slice_new0 (GTestCase);
882 tc->name = g_strdup (test_name);
883 tc->test_data = (gpointer) test_data;
884 tc->fixture_size = data_size;
885 tc->fixture_setup = (void*) data_setup;
886 tc->fixture_test = (void*) data_test;
887 tc->fixture_teardown = (void*) data_teardown;
892 g_test_add_vtable (const char *testpath,
894 gconstpointer test_data,
895 void (*data_setup) (void),
896 void (*fixture_test_func) (void),
897 void (*data_teardown) (void))
903 g_return_if_fail (testpath != NULL);
904 g_return_if_fail (testpath[0] == '/');
905 g_return_if_fail (fixture_test_func != NULL);
907 suite = g_test_get_root();
908 segments = g_strsplit (testpath, "/", -1);
909 for (ui = 0; segments[ui] != NULL; ui++)
911 const char *seg = segments[ui];
912 gboolean islast = segments[ui + 1] == NULL;
913 if (islast && !seg[0])
914 g_error ("invalid test case path: %s", testpath);
916 continue; /* initial or duplicate slash */
919 GTestSuite *csuite = g_test_create_suite (seg);
920 g_test_suite_add_suite (suite, csuite);
925 GTestCase *tc = g_test_create_case (seg, data_size, test_data, data_setup, fixture_test_func, data_teardown);
926 g_test_suite_add (suite, tc);
929 g_strfreev (segments);
934 * @testpath: Slash-separated test case path name for the test.
935 * @test_func: The test function to invoke for this test.
937 * Create a new test case, similar to g_test_create_case(). However
938 * the test is assumed to use no fixture, and test suites are automatically
939 * created on the fly and added to the root fixture, based on the
940 * slash-separated portions of @testpath.
945 g_test_add_func (const char *testpath,
946 void (*test_func) (void))
948 g_return_if_fail (testpath != NULL);
949 g_return_if_fail (testpath[0] == '/');
950 g_return_if_fail (test_func != NULL);
951 g_test_add_vtable (testpath, 0, NULL, NULL, test_func, NULL);
955 * g_test_add_data_func:
956 * @testpath: Slash-separated test case path name for the test.
957 * @test_data: Test data argument for the test function.
958 * @test_func: The test function to invoke for this test.
960 * Create a new test case, similar to g_test_create_case(). However
961 * the test is assumed to use no fixture, and test suites are automatically
962 * created on the fly and added to the root fixture, based on the
963 * slash-separated portions of @testpath. The @test_data argument
964 * will be passed as first argument to @test_func.
969 g_test_add_data_func (const char *testpath,
970 gconstpointer test_data,
971 void (*test_func) (gconstpointer))
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, test_data, NULL, (void(*)(void)) test_func, NULL);
980 * g_test_create_suite:
981 * @suite_name: a name for the suite
983 * Create a new test suite with the name @suite_name.
985 * Returns: A newly allocated #GTestSuite instance.
990 g_test_create_suite (const char *suite_name)
993 g_return_val_if_fail (suite_name != NULL, NULL);
994 g_return_val_if_fail (strchr (suite_name, '/') == NULL, NULL);
995 g_return_val_if_fail (suite_name[0] != 0, NULL);
996 ts = g_slice_new0 (GTestSuite);
997 ts->name = g_strdup (suite_name);
1003 * @suite: a #GTestSuite
1004 * @test_case: a #GTestCase
1006 * Adds @test_case to @suite.
1011 g_test_suite_add (GTestSuite *suite,
1012 GTestCase *test_case)
1014 g_return_if_fail (suite != NULL);
1015 g_return_if_fail (test_case != NULL);
1016 suite->cases = g_slist_prepend (suite->cases, test_case);
1020 * g_test_suite_add_suite:
1021 * @suite: a #GTestSuite
1022 * @nestedsuite: another #GTestSuite
1024 * Adds @nestedsuite to @suite.
1029 g_test_suite_add_suite (GTestSuite *suite,
1030 GTestSuite *nestedsuite)
1032 g_return_if_fail (suite != NULL);
1033 g_return_if_fail (nestedsuite != NULL);
1034 suite->suites = g_slist_prepend (suite->suites, nestedsuite);
1038 * g_test_queue_free:
1039 * @gfree_pointer: the pointer to be stored.
1041 * Enqueue a pointer to be released with g_free() during the next
1042 * teardown phase. This is equivalent to calling g_test_queue_destroy()
1043 * with a destroy callback of g_free().
1048 g_test_queue_free (gpointer gfree_pointer)
1051 g_test_queue_destroy (g_free, gfree_pointer);
1055 * g_test_queue_destroy:
1056 * @destroy_func: Destroy callback for teardown phase.
1057 * @destroy_data: Destroy callback data.
1059 * This function enqueus a callback @destroy_func() to be executed
1060 * during the next test case teardown phase. This is most useful
1061 * to auto destruct allocted test resources at the end of a test run.
1062 * Resources are released in reverse queue order, that means enqueueing
1063 * callback A before callback B will cause B() to be called before
1064 * A() during teardown.
1069 g_test_queue_destroy (GDestroyNotify destroy_func,
1070 gpointer destroy_data)
1072 DestroyEntry *dentry;
1073 g_return_if_fail (destroy_func != NULL);
1074 dentry = g_slice_new0 (DestroyEntry);
1075 dentry->destroy_func = destroy_func;
1076 dentry->destroy_data = destroy_data;
1077 dentry->next = test_destroy_queue;
1078 test_destroy_queue = dentry;
1082 test_case_run (GTestCase *tc)
1084 gchar *old_name = test_run_name, *old_base = g_strdup (test_uri_base);
1085 test_run_name = g_strconcat (old_name, "/", tc->name, NULL);
1086 if (++test_run_count <= test_skip_count)
1087 g_test_log (G_TEST_LOG_SKIP_CASE, test_run_name, NULL, 0, NULL);
1088 else if (test_run_list)
1090 g_print ("%s\n", test_run_name);
1091 g_test_log (G_TEST_LOG_LIST_CASE, test_run_name, NULL, 0, NULL);
1095 GTimer *test_run_timer = g_timer_new();
1096 long double largs[3];
1098 g_test_log (G_TEST_LOG_START_CASE, test_run_name, NULL, 0, NULL);
1100 g_timer_start (test_run_timer);
1101 fixture = tc->fixture_size ? g_malloc0 (tc->fixture_size) : tc->test_data;
1102 test_run_seed (test_run_seedstr);
1103 if (tc->fixture_setup)
1104 tc->fixture_setup (fixture, tc->test_data);
1105 tc->fixture_test (fixture, tc->test_data);
1107 while (test_destroy_queue)
1109 DestroyEntry *dentry = test_destroy_queue;
1110 test_destroy_queue = dentry->next;
1111 dentry->destroy_func (dentry->destroy_data);
1112 g_slice_free (DestroyEntry, dentry);
1114 if (tc->fixture_teardown)
1115 tc->fixture_teardown (fixture, tc->test_data);
1116 if (tc->fixture_size)
1118 g_timer_stop (test_run_timer);
1119 largs[0] = 0; /* OK */
1120 largs[1] = test_run_forks;
1121 largs[2] = g_timer_elapsed (test_run_timer, NULL);
1122 g_test_log (G_TEST_LOG_STOP_CASE, NULL, NULL, G_N_ELEMENTS (largs), largs);
1123 g_timer_destroy (test_run_timer);
1125 g_free (test_run_name);
1126 test_run_name = old_name;
1127 g_free (test_uri_base);
1128 test_uri_base = old_base;
1133 g_test_run_suite_internal (GTestSuite *suite,
1136 guint n_bad = 0, n_good = 0, bad_suite = 0, l;
1137 gchar *rest, *old_name = test_run_name;
1138 GSList *slist, *reversed;
1139 g_return_val_if_fail (suite != NULL, -1);
1140 while (path[0] == '/')
1143 rest = strchr (path, '/');
1144 l = rest ? MIN (l, rest - path) : l;
1145 test_run_name = suite->name[0] == 0 ? g_strdup (test_run_name) : g_strconcat (old_name, "/", suite->name, NULL);
1146 reversed = g_slist_reverse (g_slist_copy (suite->cases));
1147 for (slist = reversed; slist; slist = slist->next)
1149 GTestCase *tc = slist->data;
1150 guint n = l ? strlen (tc->name) : 0;
1151 if (l == n && strncmp (path, tc->name, n) == 0)
1154 n_bad += test_case_run (tc) != 0;
1157 g_slist_free (reversed);
1158 reversed = g_slist_reverse (g_slist_copy (suite->suites));
1159 for (slist = reversed; slist; slist = slist->next)
1161 GTestSuite *ts = slist->data;
1162 guint n = l ? strlen (ts->name) : 0;
1163 if (l == n && strncmp (path, ts->name, n) == 0)
1164 bad_suite += g_test_run_suite_internal (ts, rest ? rest : "") != 0;
1166 g_slist_free (reversed);
1167 g_free (test_run_name);
1168 test_run_name = old_name;
1169 return n_bad || bad_suite;
1174 * @suite: a #GTestSuite
1176 * Execute the tests within @suite and all nested #GTestSuites.
1177 * The test suites to be executed are filtered according to
1178 * test path arguments (-p <replaceable>testpath</replaceable>)
1179 * as parsed by g_test_init().
1180 * g_test_run_suite() or g_test_run() may only be called once
1183 * Returns: 0 on success
1188 g_test_run_suite (GTestSuite *suite)
1191 g_return_val_if_fail (g_test_config_vars->test_initialized, -1);
1192 g_return_val_if_fail (g_test_run_once == TRUE, -1);
1193 g_test_run_once = FALSE;
1195 test_paths = g_slist_prepend (test_paths, "");
1198 const char *rest, *path = test_paths->data;
1199 guint l, n = strlen (suite->name);
1200 test_paths = g_slist_delete_link (test_paths, test_paths);
1201 while (path[0] == '/')
1203 if (!n) /* root suite, run unconditionally */
1205 n_bad += 0 != g_test_run_suite_internal (suite, path);
1208 /* regular suite, match path */
1209 rest = strchr (path, '/');
1211 l = rest ? MIN (l, rest - path) : l;
1212 if ((!l || l == n) && strncmp (path, suite->name, n) == 0)
1213 n_bad += 0 != g_test_run_suite_internal (suite, rest ? rest : "");
1219 gtest_default_log_handler (const gchar *log_domain,
1220 GLogLevelFlags log_level,
1221 const gchar *message,
1222 gpointer unused_data)
1224 const gchar *strv[16];
1229 strv[i++] = log_domain;
1232 if (log_level & G_LOG_FLAG_FATAL)
1233 strv[i++] = "FATAL-";
1234 if (log_level & G_LOG_FLAG_RECURSION)
1235 strv[i++] = "RECURSIVE-";
1236 if (log_level & G_LOG_LEVEL_ERROR)
1237 strv[i++] = "ERROR";
1238 if (log_level & G_LOG_LEVEL_CRITICAL)
1239 strv[i++] = "CRITICAL";
1240 if (log_level & G_LOG_LEVEL_WARNING)
1241 strv[i++] = "WARNING";
1242 if (log_level & G_LOG_LEVEL_MESSAGE)
1243 strv[i++] = "MESSAGE";
1244 if (log_level & G_LOG_LEVEL_INFO)
1246 if (log_level & G_LOG_LEVEL_DEBUG)
1247 strv[i++] = "DEBUG";
1249 strv[i++] = message;
1251 msg = g_strjoinv ("", (gchar**) strv);
1252 g_test_log (G_TEST_LOG_ERROR, msg, NULL, 0, NULL);
1253 g_log_default_handler (log_domain, log_level, message, unused_data);
1258 g_assertion_message (const char *domain,
1262 const char *message)
1267 message = "code should not be reached";
1268 g_snprintf (lstr, 32, "%d", line);
1269 s = g_strconcat (domain ? domain : "", domain && domain[0] ? ":" : "",
1270 "ERROR:(", file, ":", lstr, "):",
1271 func, func[0] ? ":" : "",
1272 " ", message, NULL);
1273 g_printerr ("**\n** %s\n", s);
1274 g_test_log (G_TEST_LOG_ERROR, s, NULL, 0, NULL);
1280 g_assertion_message_expr (const char *domain,
1286 char *s = g_strconcat ("assertion failed: (", expr, ")", NULL);
1287 g_assertion_message (domain, file, line, func, s);
1292 g_assertion_message_cmpnum (const char *domain,
1305 case 'i': s = g_strdup_printf ("assertion failed (%s): (%.0Lf %s %.0Lf)", expr, arg1, cmp, arg2); break;
1306 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;
1307 case 'f': s = g_strdup_printf ("assertion failed (%s): (%.9Lg %s %.9Lg)", expr, arg1, cmp, arg2); break;
1308 /* ideally use: floats=%.7g double=%.17g */
1310 g_assertion_message (domain, file, line, func, s);
1315 g_assertion_message_cmpstr (const char *domain,
1324 char *a1, *a2, *s, *t1 = NULL, *t2 = NULL;
1325 a1 = arg1 ? g_strconcat ("\"", t1 = g_strescape (arg1, NULL), "\"", NULL) : g_strdup ("NULL");
1326 a2 = arg2 ? g_strconcat ("\"", t2 = g_strescape (arg2, NULL), "\"", NULL) : g_strdup ("NULL");
1329 s = g_strdup_printf ("assertion failed (%s): (%s %s %s)", expr, a1, cmp, a2);
1332 g_assertion_message (domain, file, line, func, s);
1338 * @str1: a C string or %NULL
1339 * @str2: another C string or %NULL
1341 * Compares @str1 and @str2 like strcmp(). Handles %NULL strings gracefully.
1343 * Returns: -1, 0 or 1, if @str1 is <, == or > than @str2.
1348 g_strcmp0 (const char *str1,
1352 return -(str1 != str2);
1354 return str1 != str2;
1355 return strcmp (str1, str2);
1359 static int /* 0 on success */
1360 kill_child (int pid,
1365 if (patience >= 3) /* try graceful reap */
1367 if (waitpid (pid, status, WNOHANG) > 0)
1370 if (patience >= 2) /* try SIGHUP */
1373 if (waitpid (pid, status, WNOHANG) > 0)
1375 g_usleep (20 * 1000); /* give it some scheduling/shutdown time */
1376 if (waitpid (pid, status, WNOHANG) > 0)
1378 g_usleep (50 * 1000); /* give it some scheduling/shutdown time */
1379 if (waitpid (pid, status, WNOHANG) > 0)
1381 g_usleep (100 * 1000); /* give it some scheduling/shutdown time */
1382 if (waitpid (pid, status, WNOHANG) > 0)
1385 if (patience >= 1) /* try SIGTERM */
1387 kill (pid, SIGTERM);
1388 if (waitpid (pid, status, WNOHANG) > 0)
1390 g_usleep (200 * 1000); /* give it some scheduling/shutdown time */
1391 if (waitpid (pid, status, WNOHANG) > 0)
1393 g_usleep (400 * 1000); /* give it some scheduling/shutdown time */
1394 if (waitpid (pid, status, WNOHANG) > 0)
1398 kill (pid, SIGKILL);
1400 wr = waitpid (pid, status, 0);
1401 while (wr < 0 && errno == EINTR);
1407 g_string_must_read (GString *gstring,
1410 #define STRING_BUFFER_SIZE 4096
1411 char buf[STRING_BUFFER_SIZE];
1414 bytes = read (fd, buf, sizeof (buf));
1416 return 0; /* EOF, calling this function assumes data is available */
1419 g_string_append_len (gstring, buf, bytes);
1422 else if (bytes < 0 && errno == EINTR)
1424 else /* bytes < 0 */
1426 g_warning ("failed to read() from child process (%d): %s", test_trap_last_pid, g_strerror (errno));
1427 return 1; /* ignore error after warning */
1432 g_string_write_out (GString *gstring,
1436 if (*stringpos < gstring->len)
1440 r = write (outfd, gstring->str + *stringpos, gstring->len - *stringpos);
1441 while (r < 0 && errno == EINTR);
1442 *stringpos += MAX (r, 0);
1447 test_trap_clear (void)
1449 test_trap_last_status = 0;
1450 test_trap_last_pid = 0;
1451 g_free (test_trap_last_stdout);
1452 test_trap_last_stdout = NULL;
1453 g_free (test_trap_last_stderr);
1454 test_trap_last_stderr = NULL;
1465 ret = dup2 (fd1, fd2);
1466 while (ret < 0 && errno == EINTR);
1471 test_time_stamp (void)
1475 g_get_current_time (&tv);
1477 stamp = stamp * 1000000 + tv.tv_usec;
1485 * @usec_timeout: Timeout for the forked test in micro seconds.
1486 * @test_trap_flags: Flags to modify forking behaviour.
1488 * Fork the current test program to execute a test case that might
1489 * not return or that might abort. The forked test case is aborted
1490 * and considered failing if its run time exceeds @usec_timeout.
1492 * The forking behavior can be configured with the following flags:
1495 * <term>%G_TEST_TRAP_SILENCE_STDOUT</term>
1497 * redirect stdout of the test child to <filename>/dev/null</filename>
1498 * so it cannot be observed on the console during test runs.
1499 * The actual output is still captured though to allow later
1500 * tests with g_test_trap_assert_stdout().
1501 * </para></listitem>
1504 * <term>%G_TEST_TRAP_SILENCE_STDERR</term>
1506 * redirect stderr of the test child to <filename>/dev/null</filename>
1507 * so it cannot be observed on the console during test runs.
1508 * The actual output is still captured though to allow later
1509 * tests with g_test_trap_assert_stderr().
1510 * </para></listitem>
1513 * <term>%G_TEST_TRAP_INHERIT_STDIN</term>
1515 * if this flag is given, stdin of the forked child process is
1516 * shared with stdin of its parent process. It is redirected to
1517 * <filename>/dev/null</filename> otherwise.
1518 * </para></listitem>
1522 * In the following example, the test code forks, the forked child
1523 * process produces some sample output and exits successfully.
1524 * The forking parent process then asserts successful child program
1525 * termination and validates child program outputs.
1529 * test_fork_patterns (void)
1531 * if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
1533 * g_print ("some stdout text: somagic17\n");
1534 * g_printerr ("some stderr text: semagic43\n");
1535 * exit (0); /* successful test run */
1537 * g_test_trap_assert_passed();
1538 * g_test_trap_assert_stdout ("*somagic17*");
1539 * g_test_trap_assert_stderr ("*semagic43*");
1543 * This function is implemented only on Unix platforms.
1545 * Returns: %TRUE for the forked child and %FALSE for the executing parent process.
1550 g_test_trap_fork (guint64 usec_timeout,
1551 GTestTrapFlags test_trap_flags)
1554 gboolean pass_on_forked_log = FALSE;
1555 int stdout_pipe[2] = { -1, -1 };
1556 int stderr_pipe[2] = { -1, -1 };
1557 int stdtst_pipe[2] = { -1, -1 };
1559 if (pipe (stdout_pipe) < 0 || pipe (stderr_pipe) < 0 || pipe (stdtst_pipe) < 0)
1560 g_error ("failed to create pipes to fork test program: %s", g_strerror (errno));
1561 signal (SIGCHLD, SIG_DFL);
1562 test_trap_last_pid = fork ();
1563 if (test_trap_last_pid < 0)
1564 g_error ("failed to fork test program: %s", g_strerror (errno));
1565 if (test_trap_last_pid == 0) /* child */
1568 close (stdout_pipe[0]);
1569 close (stderr_pipe[0]);
1570 close (stdtst_pipe[0]);
1571 if (!(test_trap_flags & G_TEST_TRAP_INHERIT_STDIN))
1572 fd0 = open ("/dev/null", O_RDONLY);
1573 if (sane_dup2 (stdout_pipe[1], 1) < 0 || sane_dup2 (stderr_pipe[1], 2) < 0 || (fd0 >= 0 && sane_dup2 (fd0, 0) < 0))
1574 g_error ("failed to dup2() in forked test program: %s", g_strerror (errno));
1577 if (stdout_pipe[1] >= 3)
1578 close (stdout_pipe[1]);
1579 if (stderr_pipe[1] >= 3)
1580 close (stderr_pipe[1]);
1581 test_log_fd = stdtst_pipe[1];
1586 GString *sout = g_string_new (NULL);
1587 GString *serr = g_string_new (NULL);
1589 int soutpos = 0, serrpos = 0, wr, need_wait = TRUE;
1591 close (stdout_pipe[1]);
1592 close (stderr_pipe[1]);
1593 close (stdtst_pipe[1]);
1594 sstamp = test_time_stamp();
1595 /* read data until we get EOF on all pipes */
1596 while (stdout_pipe[0] >= 0 || stderr_pipe[0] >= 0 || stdtst_pipe[0] > 0)
1602 if (stdout_pipe[0] >= 0)
1603 FD_SET (stdout_pipe[0], &fds);
1604 if (stderr_pipe[0] >= 0)
1605 FD_SET (stderr_pipe[0], &fds);
1606 if (stdtst_pipe[0] >= 0)
1607 FD_SET (stdtst_pipe[0], &fds);
1609 tv.tv_usec = MIN (usec_timeout ? usec_timeout : 1000000, 100 * 1000); /* sleep at most 0.5 seconds to catch clock skews, etc. */
1610 ret = select (MAX (MAX (stdout_pipe[0], stderr_pipe[0]), stdtst_pipe[0]) + 1, &fds, NULL, NULL, &tv);
1611 if (ret < 0 && errno != EINTR)
1613 g_warning ("Unexpected error in select() while reading from child process (%d): %s", test_trap_last_pid, g_strerror (errno));
1616 if (stdout_pipe[0] >= 0 && FD_ISSET (stdout_pipe[0], &fds) &&
1617 g_string_must_read (sout, stdout_pipe[0]) == 0)
1619 close (stdout_pipe[0]);
1620 stdout_pipe[0] = -1;
1622 if (stderr_pipe[0] >= 0 && FD_ISSET (stderr_pipe[0], &fds) &&
1623 g_string_must_read (serr, stderr_pipe[0]) == 0)
1625 close (stderr_pipe[0]);
1626 stderr_pipe[0] = -1;
1628 if (stdtst_pipe[0] >= 0 && FD_ISSET (stdtst_pipe[0], &fds))
1630 guint8 buffer[4096];
1631 gint l, r = read (stdtst_pipe[0], buffer, sizeof (buffer));
1632 if (r > 0 && test_log_fd > 0)
1634 l = write (pass_on_forked_log ? test_log_fd : -1, buffer, r);
1635 while (l < 0 && errno == EINTR);
1636 if (r == 0 || (r < 0 && errno != EINTR && errno != EAGAIN))
1638 close (stdtst_pipe[0]);
1639 stdtst_pipe[0] = -1;
1642 if (!(test_trap_flags & G_TEST_TRAP_SILENCE_STDOUT))
1643 g_string_write_out (sout, 1, &soutpos);
1644 if (!(test_trap_flags & G_TEST_TRAP_SILENCE_STDERR))
1645 g_string_write_out (serr, 2, &serrpos);
1648 guint64 nstamp = test_time_stamp();
1650 sstamp = MIN (sstamp, nstamp); /* guard against backwards clock skews */
1651 if (usec_timeout < nstamp - sstamp)
1653 /* timeout reached, need to abort the child now */
1654 kill_child (test_trap_last_pid, &status, 3);
1655 test_trap_last_status = 1024; /* timeout */
1656 if (0 && WIFSIGNALED (status))
1657 g_printerr ("%s: child timed out and received: %s\n", G_STRFUNC, g_strsignal (WTERMSIG (status)));
1663 close (stdout_pipe[0]);
1664 close (stderr_pipe[0]);
1665 close (stdtst_pipe[0]);
1670 wr = waitpid (test_trap_last_pid, &status, 0);
1671 while (wr < 0 && errno == EINTR);
1672 if (WIFEXITED (status)) /* normal exit */
1673 test_trap_last_status = WEXITSTATUS (status); /* 0..255 */
1674 else if (WIFSIGNALED (status))
1675 test_trap_last_status = (WTERMSIG (status) << 12); /* signalled */
1676 else /* WCOREDUMP (status) */
1677 test_trap_last_status = 512; /* coredump */
1679 test_trap_last_stdout = g_string_free (sout, FALSE);
1680 test_trap_last_stderr = g_string_free (serr, FALSE);
1684 g_message ("Not implemented: g_test_trap_fork");
1691 * g_test_trap_has_passed:
1693 * Check the result of the last g_test_trap_fork() call.
1695 * Returns: %TRUE if the last forked child terminated successfully.
1700 g_test_trap_has_passed (void)
1702 return test_trap_last_status == 0; /* exit_status == 0 && !signal && !coredump */
1706 * g_test_trap_reached_timeout:
1708 * Check the result of the last g_test_trap_fork() call.
1710 * Returns: %TRUE if the last forked child got killed due to a fork timeout.
1715 g_test_trap_reached_timeout (void)
1717 return 0 != (test_trap_last_status & 1024); /* timeout flag */
1721 g_test_trap_assertions (const char *domain,
1725 guint64 assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
1726 const char *pattern)
1729 gboolean must_pass = assertion_flags == 0;
1730 gboolean must_fail = assertion_flags == 1;
1731 gboolean match_result = 0 == (assertion_flags & 1);
1732 const char *stdout_pattern = (assertion_flags & 2) ? pattern : NULL;
1733 const char *stderr_pattern = (assertion_flags & 4) ? pattern : NULL;
1734 const char *match_error = match_result ? "failed to match" : "contains invalid match";
1735 if (test_trap_last_pid == 0)
1736 g_error ("child process failed to exit after g_test_trap_fork() and before g_test_trap_assert*()");
1737 if (must_pass && !g_test_trap_has_passed())
1739 char *msg = g_strdup_printf ("child process (%d) of test trap failed unexpectedly", test_trap_last_pid);
1740 g_assertion_message (domain, file, line, func, msg);
1743 if (must_fail && g_test_trap_has_passed())
1745 char *msg = g_strdup_printf ("child process (%d) did not fail as expected", test_trap_last_pid);
1746 g_assertion_message (domain, file, line, func, msg);
1749 if (stdout_pattern && match_result == !g_pattern_match_simple (stdout_pattern, test_trap_last_stdout))
1751 char *msg = g_strdup_printf ("stdout of child process (%d) %s: %s", test_trap_last_pid, match_error, stdout_pattern);
1752 g_assertion_message (domain, file, line, func, msg);
1755 if (stderr_pattern && match_result == !g_pattern_match_simple (stderr_pattern, test_trap_last_stderr))
1757 char *msg = g_strdup_printf ("stderr of child process (%d) %s: %s", test_trap_last_pid, match_error, stderr_pattern);
1758 g_assertion_message (domain, file, line, func, msg);
1765 gstring_overwrite_int (GString *gstring,
1769 vuint = g_htonl (vuint);
1770 g_string_overwrite_len (gstring, pos, (const gchar*) &vuint, 4);
1774 gstring_append_int (GString *gstring,
1777 vuint = g_htonl (vuint);
1778 g_string_append_len (gstring, (const gchar*) &vuint, 4);
1782 gstring_append_double (GString *gstring,
1785 union { double vdouble; guint64 vuint64; } u;
1786 u.vdouble = vdouble;
1787 u.vuint64 = GUINT64_TO_BE (u.vuint64);
1788 g_string_append_len (gstring, (const gchar*) &u.vuint64, 8);
1792 g_test_log_dump (GTestLogMsg *msg,
1795 GString *gstring = g_string_sized_new (1024);
1797 gstring_append_int (gstring, 0); /* message length */
1798 gstring_append_int (gstring, msg->log_type);
1799 gstring_append_int (gstring, msg->n_strings);
1800 gstring_append_int (gstring, msg->n_nums);
1801 gstring_append_int (gstring, 0); /* reserved */
1802 for (ui = 0; ui < msg->n_strings; ui++)
1804 guint l = strlen (msg->strings[ui]);
1805 gstring_append_int (gstring, l);
1806 g_string_append_len (gstring, msg->strings[ui], l);
1808 for (ui = 0; ui < msg->n_nums; ui++)
1809 gstring_append_double (gstring, msg->nums[ui]);
1810 *len = gstring->len;
1811 gstring_overwrite_int (gstring, 0, *len); /* message length */
1812 return (guint8*) g_string_free (gstring, FALSE);
1815 static inline long double
1816 net_double (const gchar **ipointer)
1818 union { guint64 vuint64; double vdouble; } u;
1819 guint64 aligned_int64;
1820 memcpy (&aligned_int64, *ipointer, 8);
1822 u.vuint64 = GUINT64_FROM_BE (aligned_int64);
1826 static inline guint32
1827 net_int (const gchar **ipointer)
1829 guint32 aligned_int;
1830 memcpy (&aligned_int, *ipointer, 4);
1832 return g_ntohl (aligned_int);
1836 g_test_log_extract (GTestLogBuffer *tbuffer)
1838 const gchar *p = tbuffer->data->str;
1841 if (tbuffer->data->len < 4 * 5)
1843 mlength = net_int (&p);
1844 if (tbuffer->data->len < mlength)
1846 msg.log_type = net_int (&p);
1847 msg.n_strings = net_int (&p);
1848 msg.n_nums = net_int (&p);
1849 if (net_int (&p) == 0)
1852 msg.strings = g_new0 (gchar*, msg.n_strings + 1);
1853 msg.nums = g_new0 (long double, msg.n_nums);
1854 for (ui = 0; ui < msg.n_strings; ui++)
1856 guint sl = net_int (&p);
1857 msg.strings[ui] = g_strndup (p, sl);
1860 for (ui = 0; ui < msg.n_nums; ui++)
1861 msg.nums[ui] = net_double (&p);
1862 if (p <= tbuffer->data->str + mlength)
1864 g_string_erase (tbuffer->data, 0, mlength);
1865 tbuffer->msgs = g_slist_prepend (tbuffer->msgs, g_memdup (&msg, sizeof (msg)));
1870 g_strfreev (msg.strings);
1871 g_error ("corrupt log stream from test program");
1876 * g_test_log_buffer_new:
1878 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
1881 g_test_log_buffer_new (void)
1883 GTestLogBuffer *tb = g_new0 (GTestLogBuffer, 1);
1884 tb->data = g_string_sized_new (1024);
1889 * g_test_log_buffer_free
1891 * Internal function for gtester to free test log messages, no ABI guarantees provided.
1894 g_test_log_buffer_free (GTestLogBuffer *tbuffer)
1896 g_return_if_fail (tbuffer != NULL);
1897 while (tbuffer->msgs)
1898 g_test_log_msg_free (g_test_log_buffer_pop (tbuffer));
1899 g_string_free (tbuffer->data, TRUE);
1904 * g_test_log_buffer_push
1906 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
1909 g_test_log_buffer_push (GTestLogBuffer *tbuffer,
1911 const guint8 *bytes)
1913 g_return_if_fail (tbuffer != NULL);
1916 gboolean more_messages;
1917 g_return_if_fail (bytes != NULL);
1918 g_string_append_len (tbuffer->data, (const gchar*) bytes, n_bytes);
1920 more_messages = g_test_log_extract (tbuffer);
1921 while (more_messages);
1926 * g_test_log_buffer_pop:
1928 * Internal function for gtester to retrieve test log messages, no ABI guarantees provided.
1931 g_test_log_buffer_pop (GTestLogBuffer *tbuffer)
1933 GTestLogMsg *msg = NULL;
1934 g_return_val_if_fail (tbuffer != NULL, NULL);
1937 GSList *slist = g_slist_last (tbuffer->msgs);
1939 tbuffer->msgs = g_slist_delete_link (tbuffer->msgs, slist);
1945 * g_test_log_msg_free:
1947 * Internal function for gtester to free test log messages, no ABI guarantees provided.
1950 g_test_log_msg_free (GTestLogMsg *tmsg)
1952 g_return_if_fail (tmsg != NULL);
1953 g_strfreev (tmsg->strings);
1954 g_free (tmsg->nums);
1958 /* --- macros docs START --- */
1961 * @testpath: The test path for a new test case.
1962 * @Fixture: The type of a fixture data structure.
1963 * @tdata: Data argument for the test functions.
1964 * @fsetup: The function to set up the fixture data.
1965 * @ftest: The actual test function.
1966 * @fteardown: The function to tear down the fixture data.
1968 * Hook up a new test case at @testpath, similar to g_test_add_func().
1969 * A fixture data structure with setup and teardown function may be provided
1970 * though, similar to g_test_create_case().
1971 * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
1972 * fteardown() callbacks can expect a @Fixture pointer as first argument in
1973 * a type safe manner.
1977 /* --- macros docs END --- */
1979 #define __G_TEST_UTILS_C__
1980 #include "galiasdef.c"