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.1 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, see <http://www.gnu.org/licenses/>.
21 #include "gtestutils.h"
22 #include "gfileutils.h"
24 #include <sys/types.h>
30 #include <glib/gstdio.h>
35 #ifdef HAVE_SYS_RESOURCE_H
36 #include <sys/resource.h>
44 #ifdef HAVE_SYS_SELECT_H
45 #include <sys/select.h>
46 #endif /* HAVE_SYS_SELECT_H */
51 #include "gstrfuncs.h"
55 #include "glib-private.h"
61 * @short_description: a test framework
62 * @see_also: [gtester][gtester], [gtester-report][gtester-report]
64 * GLib provides a framework for writing and maintaining unit tests
65 * in parallel to the code they are testing. The API is designed according
66 * to established concepts found in the other test frameworks (JUnit, NUnit,
67 * RUnit), which in turn is based on smalltalk unit testing concepts.
69 * - Test case: Tests (test methods) are grouped together with their
70 * fixture into test cases.
72 * - Fixture: A test fixture consists of fixture data and setup and
73 * teardown methods to establish the environment for the test
74 * functions. We use fresh fixtures, i.e. fixtures are newly set
75 * up and torn down around each test invocation to avoid dependencies
78 * - Test suite: Test cases can be grouped into test suites, to allow
79 * subsets of the available tests to be run. Test suites can be
80 * grouped into other test suites as well.
82 * The API is designed to handle creation and registration of test suites
83 * and test cases implicitly. A simple call like
84 * |[<!-- language="C" -->
85 * g_test_add_func ("/misc/assertions", test_assertions);
87 * creates a test suite called "misc" with a single test case named
88 * "assertions", which consists of running the test_assertions function.
90 * In addition to the traditional g_assert_true(), the test framework provides
91 * an extended set of assertions for comparisons: g_assert_cmpfloat(),
92 * g_assert_cmpfloat_with_epsilon(), g_assert_cmpint(), g_assert_cmpuint(),
93 * g_assert_cmphex(), g_assert_cmpstr(), and g_assert_cmpmem(). The
94 * advantage of these variants over plain g_assert_true() is that the assertion
95 * messages can be more elaborate, and include the values of the compared
98 * Note that g_assert() should not be used in unit tests, since it is a no-op
99 * when compiling with `G_DISABLE_ASSERT`. Use g_assert() in production code,
100 * and g_assert_true() in unit tests.
102 * A full example of creating a test suite with two tests using fixtures:
103 * |[<!-- language="C" -->
105 * #include <locale.h>
109 * OtherObject *helper;
113 * my_object_fixture_set_up (MyObjectFixture *fixture,
114 * gconstpointer user_data)
116 * fixture->obj = my_object_new ();
117 * my_object_set_prop1 (fixture->obj, "some-value");
118 * my_object_do_some_complex_setup (fixture->obj, user_data);
120 * fixture->helper = other_object_new ();
124 * my_object_fixture_tear_down (MyObjectFixture *fixture,
125 * gconstpointer user_data)
127 * g_clear_object (&fixture->helper);
128 * g_clear_object (&fixture->obj);
132 * test_my_object_test1 (MyObjectFixture *fixture,
133 * gconstpointer user_data)
135 * g_assert_cmpstr (my_object_get_property (fixture->obj), ==, "initial-value");
139 * test_my_object_test2 (MyObjectFixture *fixture,
140 * gconstpointer user_data)
142 * my_object_do_some_work_using_helper (fixture->obj, fixture->helper);
143 * g_assert_cmpstr (my_object_get_property (fixture->obj), ==, "updated-value");
147 * main (int argc, char *argv[])
149 * setlocale (LC_ALL, "");
151 * g_test_init (&argc, &argv, NULL);
152 * g_test_bug_base ("http://bugzilla.gnome.org/show_bug.cgi?id=");
154 * // Define the tests.
155 * g_test_add ("/my-object/test1", MyObjectFixture, "some-user-data",
156 * my_object_fixture_set_up, test_my_object_test1,
157 * my_object_fixture_tear_down);
158 * g_test_add ("/my-object/test2", MyObjectFixture, "some-user-data",
159 * my_object_fixture_set_up, test_my_object_test2,
160 * my_object_fixture_tear_down);
162 * return g_test_run ();
166 * ### Integrating GTest in your project
168 * If you are using the [Meson](http://mesonbuild.com) build system, you will
169 * typically use the provided `test()` primitive to call the test binaries,
172 * |[<!-- language="plain" -->
175 * executable('foo', 'foo.c', dependencies: deps),
177 * 'G_TEST_SRCDIR=@0@'.format(meson.current_source_dir()),
178 * 'G_TEST_BUILDDIR=@0@'.format(meson.current_build_dir()),
184 * executable('bar', 'bar.c', dependencies: deps),
186 * 'G_TEST_SRCDIR=@0@'.format(meson.current_source_dir()),
187 * 'G_TEST_BUILDDIR=@0@'.format(meson.current_build_dir()),
192 * If you are using Autotools, you're strongly encouraged to use the Automake
193 * [TAP](https://testanything.org/) harness; GLib provides template files for
194 * easily integrating with it:
196 * - [glib-tap.mk](https://git.gnome.org/browse/glib/tree/glib-tap.mk)
197 * - [tap-test](https://git.gnome.org/browse/glib/tree/tap-test)
198 * - [tap-driver.sh](https://git.gnome.org/browse/glib/tree/tap-driver.sh)
200 * You can copy these files in your own project's root directory, and then
201 * set up your `Makefile.am` file to reference them, for instance:
203 * |[<!-- language="plain" -->
204 * include $(top_srcdir)/glib-tap.mk
211 * # data distributed in the tarball
216 * # data not distributed in the tarball
221 * Make sure to distribute the TAP files, using something like the following
222 * in your top-level `Makefile.am`:
224 * |[<!-- language="plain" -->
230 * `glib-tap.mk` will be distributed implicitly due to being included in a
231 * `Makefile.am`. All three files should be added to version control.
233 * If you don't have access to the Autotools TAP harness, you can use the
234 * [gtester][gtester] and [gtester-report][gtester-report] tools, and use
235 * the [glib.mk](https://git.gnome.org/browse/glib/tree/glib.mk) Automake
236 * template provided by GLib.
240 * g_test_initialized:
242 * Returns %TRUE if g_test_init() has been called.
244 * Returns: %TRUE if g_test_init() has been called.
252 * Returns %TRUE if tests are run in quick mode.
253 * Exactly one of g_test_quick() and g_test_slow() is active in any run;
254 * there is no "medium speed".
256 * By default, tests are run in quick mode. In tests that use
257 * g_test_init(), the options `-m quick`, `-m slow` and `-m thorough`
258 * can be used to change this.
260 * Returns: %TRUE if in quick mode
266 * Returns %TRUE if tests are run in slow mode.
267 * Exactly one of g_test_quick() and g_test_slow() is active in any run;
268 * there is no "medium speed".
270 * By default, tests are run in quick mode. In tests that use
271 * g_test_init(), the options `-m quick`, `-m slow` and `-m thorough`
272 * can be used to change this.
274 * Returns: the opposite of g_test_quick()
280 * Returns %TRUE if tests are run in thorough mode, equivalent to
283 * By default, tests are run in quick mode. In tests that use
284 * g_test_init(), the options `-m quick`, `-m slow` and `-m thorough`
285 * can be used to change this.
287 * Returns: the same thing as g_test_slow()
293 * Returns %TRUE if tests are run in performance mode.
295 * By default, tests are run in quick mode. In tests that use
296 * g_test_init(), the option `-m perf` enables performance tests, while
297 * `-m quick` disables them.
299 * Returns: %TRUE if in performance mode
305 * Returns %TRUE if tests may provoke assertions and other formally-undefined
306 * behaviour, to verify that appropriate warnings are given. It might, in some
307 * cases, be useful to turn this off with if running tests under valgrind;
308 * in tests that use g_test_init(), the option `-m no-undefined` disables
309 * those tests, while `-m undefined` explicitly enables them (the default
312 * Returns: %TRUE if tests may provoke programming errors
318 * Returns %TRUE if tests are run in verbose mode.
319 * In tests that use g_test_init(), the option `--verbose` enables this,
320 * while `-q` or `--quiet` disables it.
321 * The default is neither g_test_verbose() nor g_test_quiet().
323 * Returns: %TRUE if in verbose mode
329 * Returns %TRUE if tests are run in quiet mode.
330 * In tests that use g_test_init(), the option `-q` or `--quiet` enables
331 * this, while `--verbose` disables it.
332 * The default is neither g_test_verbose() nor g_test_quiet().
334 * Returns: %TRUE if in quiet mode
338 * g_test_queue_unref:
339 * @gobject: the object to unref
341 * Enqueue an object to be released with g_object_unref() during
342 * the next teardown phase. This is equivalent to calling
343 * g_test_queue_destroy() with a destroy callback of g_object_unref().
350 * @G_TEST_TRAP_SILENCE_STDOUT: Redirect stdout of the test child to
351 * `/dev/null` so it cannot be observed on the console during test
352 * runs. The actual output is still captured though to allow later
353 * tests with g_test_trap_assert_stdout().
354 * @G_TEST_TRAP_SILENCE_STDERR: Redirect stderr of the test child to
355 * `/dev/null` so it cannot be observed on the console during test
356 * runs. The actual output is still captured though to allow later
357 * tests with g_test_trap_assert_stderr().
358 * @G_TEST_TRAP_INHERIT_STDIN: If this flag is given, stdin of the
359 * child process is shared with stdin of its parent process.
360 * It is redirected to `/dev/null` otherwise.
362 * Test traps are guards around forked tests.
363 * These flags determine what traps to set.
365 * Deprecated: #GTestTrapFlags is used only with g_test_trap_fork(),
366 * which is deprecated. g_test_trap_subprocess() uses
367 * #GTestSubprocessFlags.
371 * GTestSubprocessFlags:
372 * @G_TEST_SUBPROCESS_INHERIT_STDIN: If this flag is given, the child
373 * process will inherit the parent's stdin. Otherwise, the child's
374 * stdin is redirected to `/dev/null`.
375 * @G_TEST_SUBPROCESS_INHERIT_STDOUT: If this flag is given, the child
376 * process will inherit the parent's stdout. Otherwise, the child's
377 * stdout will not be visible, but it will be captured to allow
378 * later tests with g_test_trap_assert_stdout().
379 * @G_TEST_SUBPROCESS_INHERIT_STDERR: If this flag is given, the child
380 * process will inherit the parent's stderr. Otherwise, the child's
381 * stderr will not be visible, but it will be captured to allow
382 * later tests with g_test_trap_assert_stderr().
384 * Flags to pass to g_test_trap_subprocess() to control input and output.
386 * Note that in contrast with g_test_trap_fork(), the default is to
387 * not show stdout and stderr.
391 * g_test_trap_assert_passed:
393 * Assert that the last test subprocess passed.
394 * See g_test_trap_subprocess().
400 * g_test_trap_assert_failed:
402 * Assert that the last test subprocess failed.
403 * See g_test_trap_subprocess().
405 * This is sometimes used to test situations that are formally considered to
406 * be undefined behaviour, like inputs that fail a g_return_if_fail()
407 * check. In these situations you should skip the entire test, including the
408 * call to g_test_trap_subprocess(), unless g_test_undefined() returns %TRUE
409 * to indicate that undefined behaviour may be tested.
415 * g_test_trap_assert_stdout:
416 * @soutpattern: a glob-style [pattern][glib-Glob-style-pattern-matching]
418 * Assert that the stdout output of the last test subprocess matches
419 * @soutpattern. See g_test_trap_subprocess().
425 * g_test_trap_assert_stdout_unmatched:
426 * @soutpattern: a glob-style [pattern][glib-Glob-style-pattern-matching]
428 * Assert that the stdout output of the last test subprocess
429 * does not match @soutpattern. See g_test_trap_subprocess().
435 * g_test_trap_assert_stderr:
436 * @serrpattern: a glob-style [pattern][glib-Glob-style-pattern-matching]
438 * Assert that the stderr output of the last test subprocess
439 * matches @serrpattern. See g_test_trap_subprocess().
441 * This is sometimes used to test situations that are formally
442 * considered to be undefined behaviour, like code that hits a
443 * g_assert() or g_error(). In these situations you should skip the
444 * entire test, including the call to g_test_trap_subprocess(), unless
445 * g_test_undefined() returns %TRUE to indicate that undefined
446 * behaviour may be tested.
452 * g_test_trap_assert_stderr_unmatched:
453 * @serrpattern: a glob-style [pattern][glib-Glob-style-pattern-matching]
455 * Assert that the stderr output of the last test subprocess
456 * does not match @serrpattern. See g_test_trap_subprocess().
464 * Get a reproducible random bit (0 or 1), see g_test_rand_int()
465 * for details on test case random numbers.
472 * @expr: the expression to check
474 * Debugging macro to terminate the application if the assertion
475 * fails. If the assertion fails (i.e. the expression is not true),
476 * an error message is logged and the application is terminated.
478 * The macro can be turned off in final releases of code by defining
479 * `G_DISABLE_ASSERT` when compiling the application, so code must
480 * not depend on any side effects from @expr. Similarly, it must not be used
481 * in unit tests, otherwise the unit tests will be ineffective if compiled with
482 * `G_DISABLE_ASSERT`. Use g_assert_true() and related macros in unit tests
487 * g_assert_not_reached:
489 * Debugging macro to terminate the application if it is ever
490 * reached. If it is reached, an error message is logged and the
491 * application is terminated.
493 * The macro can be turned off in final releases of code by defining
494 * `G_DISABLE_ASSERT` when compiling the application. Hence, it should not be
495 * used in unit tests, where assertions should always be effective.
500 * @expr: the expression to check
502 * Debugging macro to check that an expression is true.
504 * If the assertion fails (i.e. the expression is not true),
505 * an error message is logged and the application is either
506 * terminated or the testcase marked as failed.
508 * Note that unlike g_assert(), this macro is unaffected by whether
509 * `G_DISABLE_ASSERT` is defined. Hence it should only be used in tests and,
510 * conversely, g_assert() should not be used in tests.
512 * See g_test_set_nonfatal_assertions().
519 * @expr: the expression to check
521 * Debugging macro to check an expression is false.
523 * If the assertion fails (i.e. the expression is not false),
524 * an error message is logged and the application is either
525 * terminated or the testcase marked as failed.
527 * Note that unlike g_assert(), this macro is unaffected by whether
528 * `G_DISABLE_ASSERT` is defined. Hence it should only be used in tests and,
529 * conversely, g_assert() should not be used in tests.
531 * See g_test_set_nonfatal_assertions().
538 * @expr: the expression to check
540 * Debugging macro to check an expression is %NULL.
542 * If the assertion fails (i.e. the expression is not %NULL),
543 * an error message is logged and the application is either
544 * terminated or the testcase marked as failed.
546 * Note that unlike g_assert(), this macro is unaffected by whether
547 * `G_DISABLE_ASSERT` is defined. Hence it should only be used in tests and,
548 * conversely, g_assert() should not be used in tests.
550 * See g_test_set_nonfatal_assertions().
557 * @expr: the expression to check
559 * Debugging macro to check an expression is not %NULL.
561 * If the assertion fails (i.e. the expression is %NULL),
562 * an error message is logged and the application is either
563 * terminated or the testcase marked as failed.
565 * Note that unlike g_assert(), this macro is unaffected by whether
566 * `G_DISABLE_ASSERT` is defined. Hence it should only be used in tests and,
567 * conversely, g_assert() should not be used in tests.
569 * See g_test_set_nonfatal_assertions().
576 * @s1: a string (may be %NULL)
577 * @cmp: The comparison operator to use.
578 * One of ==, !=, <, >, <=, >=.
579 * @s2: another string (may be %NULL)
581 * Debugging macro to compare two strings. If the comparison fails,
582 * an error message is logged and the application is either terminated
583 * or the testcase marked as failed.
584 * The strings are compared using g_strcmp0().
586 * The effect of `g_assert_cmpstr (s1, op, s2)` is
587 * the same as `g_assert_true (g_strcmp0 (s1, s2) op 0)`.
588 * The advantage of this macro is that it can produce a message that
589 * includes the actual values of @s1 and @s2.
591 * |[<!-- language="C" -->
592 * g_assert_cmpstr (mystring, ==, "fubar");
601 * @cmp: The comparison operator to use.
602 * One of ==, !=, <, >, <=, >=.
603 * @n2: another integer
605 * Debugging macro to compare two integers.
607 * The effect of `g_assert_cmpint (n1, op, n2)` is
608 * the same as `g_assert_true (n1 op n2)`. The advantage
609 * of this macro is that it can produce a message that includes the
610 * actual values of @n1 and @n2.
617 * @n1: an unsigned integer
618 * @cmp: The comparison operator to use.
619 * One of ==, !=, <, >, <=, >=.
620 * @n2: another unsigned integer
622 * Debugging macro to compare two unsigned integers.
624 * The effect of `g_assert_cmpuint (n1, op, n2)` is
625 * the same as `g_assert_true (n1 op n2)`. The advantage
626 * of this macro is that it can produce a message that includes the
627 * actual values of @n1 and @n2.
634 * @n1: an unsigned integer
635 * @cmp: The comparison operator to use.
636 * One of ==, !=, <, >, <=, >=.
637 * @n2: another unsigned integer
639 * Debugging macro to compare to unsigned integers.
641 * This is a variant of g_assert_cmpuint() that displays the numbers
642 * in hexadecimal notation in the message.
649 * @n1: an floating point number
650 * @cmp: The comparison operator to use.
651 * One of ==, !=, <, >, <=, >=.
652 * @n2: another floating point number
654 * Debugging macro to compare two floating point numbers.
656 * The effect of `g_assert_cmpfloat (n1, op, n2)` is
657 * the same as `g_assert_true (n1 op n2)`. The advantage
658 * of this macro is that it can produce a message that includes the
659 * actual values of @n1 and @n2.
665 * g_assert_cmpfloat_with_epsilon:
666 * @n1: an floating point number
667 * @n2: another floating point number
668 * @epsilon: a numeric value that expresses the expected tolerance
669 * between @n1 and @n2
671 * Debugging macro to compare two floating point numbers within an epsilon.
673 * The effect of `g_assert_cmpfloat_with_epsilon (n1, n2, epsilon)` is
674 * the same as `g_assert_true (abs (n1 - n2) < epsilon)`. The advantage
675 * of this macro is that it can produce a message that includes the
676 * actual values of @n1 and @n2.
683 * @m1: pointer to a buffer
685 * @m2: pointer to another buffer
688 * Debugging macro to compare memory regions. If the comparison fails,
689 * an error message is logged and the application is either terminated
690 * or the testcase marked as failed.
692 * The effect of `g_assert_cmpmem (m1, l1, m2, l2)` is
693 * the same as `g_assert_true (l1 == l2 && memcmp (m1, m2, l1) == 0)`.
694 * The advantage of this macro is that it can produce a message that
695 * includes the actual values of @l1 and @l2.
697 * |[<!-- language="C" -->
698 * g_assert_cmpmem (buf->data, buf->len, expected, sizeof (expected));
706 * @err: a #GError, possibly %NULL
708 * Debugging macro to check that a #GError is not set.
710 * The effect of `g_assert_no_error (err)` is
711 * the same as `g_assert_true (err == NULL)`. The advantage
712 * of this macro is that it can produce a message that includes
713 * the error message and code.
720 * @err: a #GError, possibly %NULL
721 * @dom: the expected error domain (a #GQuark)
722 * @c: the expected error code
724 * Debugging macro to check that a method has returned
725 * the correct #GError.
727 * The effect of `g_assert_error (err, dom, c)` is
728 * the same as `g_assert_true (err != NULL && err->domain
729 * == dom && err->code == c)`. The advantage of this
730 * macro is that it can produce a message that includes the incorrect
731 * error message and code.
733 * This can only be used to test for a specific error. If you want to
734 * test that @err is set, but don't care what it's set to, just use
735 * `g_assert (err != NULL)`
743 * An opaque structure representing a test case.
749 * An opaque structure representing a test suite.
753 /* Global variable for storing assertion messages; this is the counterpart to
754 * glibc's (private) __abort_msg variable, and allows developers and crash
755 * analysis systems like Apport and ABRT to fish out assertion messages from
756 * core dumps, instead of having to catch them on screen output.
758 GLIB_VAR
char *__glib_assert_msg
;
759 char *__glib_assert_msg
= NULL
;
761 /* --- constants --- */
762 #define G_TEST_STATUS_TIMED_OUT 1024
764 /* --- structures --- */
769 void (*fixture_setup
) (void*, gconstpointer
);
770 void (*fixture_test
) (void*, gconstpointer
);
771 void (*fixture_teardown
) (void*, gconstpointer
);
780 typedef struct DestroyEntry DestroyEntry
;
784 GDestroyNotify destroy_func
;
785 gpointer destroy_data
;
788 /* --- prototypes --- */
789 static void test_run_seed (const gchar
*rseed
);
790 static void test_trap_clear (void);
791 static guint8
* g_test_log_dump (GTestLogMsg
*msg
,
793 static void gtest_default_log_handler (const gchar
*log_domain
,
794 GLogLevelFlags log_level
,
795 const gchar
*message
,
796 gpointer unused_data
);
799 static const char * const g_test_result_names
[] = {
806 /* --- variables --- */
807 static int test_log_fd
= -1;
808 static gboolean test_mode_fatal
= TRUE
;
809 static gboolean g_test_run_once
= TRUE
;
810 static gboolean test_run_list
= FALSE
;
811 static gchar
*test_run_seedstr
= NULL
;
812 static GRand
*test_run_rand
= NULL
;
813 static gchar
*test_run_name
= "";
814 static GSList
**test_filename_free_list
;
815 static guint test_run_forks
= 0;
816 static guint test_run_count
= 0;
817 static guint test_count
= 0;
818 static guint test_skipped_count
= 0;
819 static GTestResult test_run_success
= G_TEST_RUN_FAILURE
;
820 static gchar
*test_run_msg
= NULL
;
821 static guint test_startup_skip_count
= 0;
822 static GTimer
*test_user_timer
= NULL
;
823 static double test_user_stamp
= 0;
824 static GSList
*test_paths
= NULL
;
825 static GSList
*test_paths_skipped
= NULL
;
826 static GTestSuite
*test_suite_root
= NULL
;
827 static int test_trap_last_status
= 0; /* unmodified platform-specific status */
828 static GPid test_trap_last_pid
= 0;
829 static char *test_trap_last_subprocess
= NULL
;
830 static char *test_trap_last_stdout
= NULL
;
831 static char *test_trap_last_stderr
= NULL
;
832 static char *test_uri_base
= NULL
;
833 static gboolean test_debug_log
= FALSE
;
834 static gboolean test_tap_log
= FALSE
;
835 static gboolean test_nonfatal_assertions
= FALSE
;
836 static DestroyEntry
*test_destroy_queue
= NULL
;
837 static char *test_argv0
= NULL
;
838 static char *test_argv0_dirname
;
839 static const char *test_disted_files_dir
;
840 static const char *test_built_files_dir
;
841 static char *test_initial_cwd
= NULL
;
842 static gboolean test_in_forked_child
= FALSE
;
843 static gboolean test_in_subprocess
= FALSE
;
844 static GTestConfig mutable_test_config_vars
= {
845 FALSE
, /* test_initialized */
846 TRUE
, /* test_quick */
847 FALSE
, /* test_perf */
848 FALSE
, /* test_verbose */
849 FALSE
, /* test_quiet */
850 TRUE
, /* test_undefined */
852 const GTestConfig
* const g_test_config_vars
= &mutable_test_config_vars
;
853 static gboolean no_g_set_prgname
= FALSE
;
855 /* --- functions --- */
857 g_test_log_type_name (GTestLogType log_type
)
861 case G_TEST_LOG_NONE
: return "none";
862 case G_TEST_LOG_ERROR
: return "error";
863 case G_TEST_LOG_START_BINARY
: return "binary";
864 case G_TEST_LOG_LIST_CASE
: return "list";
865 case G_TEST_LOG_SKIP_CASE
: return "skip";
866 case G_TEST_LOG_START_CASE
: return "start";
867 case G_TEST_LOG_STOP_CASE
: return "stop";
868 case G_TEST_LOG_MIN_RESULT
: return "minperf";
869 case G_TEST_LOG_MAX_RESULT
: return "maxperf";
870 case G_TEST_LOG_MESSAGE
: return "message";
871 case G_TEST_LOG_START_SUITE
: return "start suite";
872 case G_TEST_LOG_STOP_SUITE
: return "stop suite";
878 g_test_log_send (guint n_bytes
,
879 const guint8
*buffer
)
881 if (test_log_fd
>= 0)
885 r
= write (test_log_fd
, buffer
, n_bytes
);
886 while (r
< 0 && errno
== EINTR
);
890 GTestLogBuffer
*lbuffer
= g_test_log_buffer_new ();
893 g_test_log_buffer_push (lbuffer
, n_bytes
, buffer
);
894 msg
= g_test_log_buffer_pop (lbuffer
);
895 g_warn_if_fail (msg
!= NULL
);
896 g_warn_if_fail (lbuffer
->data
->len
== 0);
897 g_test_log_buffer_free (lbuffer
);
899 g_printerr ("{*LOG(%s)", g_test_log_type_name (msg
->log_type
));
900 for (ui
= 0; ui
< msg
->n_strings
; ui
++)
901 g_printerr (":{%s}", msg
->strings
[ui
]);
905 for (ui
= 0; ui
< msg
->n_nums
; ui
++)
907 if ((long double) (long) msg
->nums
[ui
] == msg
->nums
[ui
])
908 g_printerr ("%s%ld", ui
? ";" : "", (long) msg
->nums
[ui
]);
910 g_printerr ("%s%.16g", ui
? ";" : "", (double) msg
->nums
[ui
]);
914 g_printerr (":LOG*}\n");
915 g_test_log_msg_free (msg
);
920 g_test_log (GTestLogType lbit
,
921 const gchar
*string1
,
922 const gchar
*string2
,
929 gchar
*astrings
[3] = { NULL
, NULL
, NULL
};
935 case G_TEST_LOG_START_BINARY
:
937 g_print ("# random seed: %s\n", string2
);
938 else if (g_test_verbose ())
939 g_print ("GTest: random seed: %s\n", string2
);
941 case G_TEST_LOG_START_SUITE
:
945 g_print ("# Start of %s tests\n", string1
);
947 g_print ("1..%d\n", test_count
);
950 case G_TEST_LOG_STOP_SUITE
:
954 g_print ("# End of %s tests\n", string1
);
957 case G_TEST_LOG_STOP_CASE
:
959 fail
= result
== G_TEST_RUN_FAILURE
;
964 /* The TAP representation for an expected failure starts with
965 * "not ok", even though it does not actually count as failing
966 * due to the use of the TODO directive. "ok # TODO" would mean
967 * a test that was expected to fail unexpectedly succeeded,
968 * for which GTestResult does not currently have a
970 if (fail
|| result
== G_TEST_RUN_INCOMPLETE
)
975 g_print ("%s %d %s", ok
, test_run_count
, string1
);
976 if (result
== G_TEST_RUN_INCOMPLETE
)
977 g_print (" # TODO %s\n", string2
? string2
: "");
978 else if (result
== G_TEST_RUN_SKIPPED
)
979 g_print (" # SKIP %s\n", string2
? string2
: "");
983 else if (g_test_verbose ())
984 g_print ("GTest: result: %s\n", g_test_result_names
[result
]);
985 else if (!g_test_quiet ())
986 g_print ("%s\n", g_test_result_names
[result
]);
987 if (fail
&& test_mode_fatal
)
990 g_print ("Bail out!\n");
993 if (result
== G_TEST_RUN_SKIPPED
|| result
== G_TEST_RUN_INCOMPLETE
)
994 test_skipped_count
++;
996 case G_TEST_LOG_MIN_RESULT
:
998 g_print ("# min perf: %s\n", string1
);
999 else if (g_test_verbose ())
1000 g_print ("(MINPERF:%s)\n", string1
);
1002 case G_TEST_LOG_MAX_RESULT
:
1004 g_print ("# max perf: %s\n", string1
);
1005 else if (g_test_verbose ())
1006 g_print ("(MAXPERF:%s)\n", string1
);
1008 case G_TEST_LOG_MESSAGE
:
1010 g_print ("# %s\n", string1
);
1011 else if (g_test_verbose ())
1012 g_print ("(MSG: %s)\n", string1
);
1014 case G_TEST_LOG_ERROR
:
1016 g_print ("Bail out! %s\n", string1
);
1017 else if (g_test_verbose ())
1018 g_print ("(ERROR: %s)\n", string1
);
1023 msg
.log_type
= lbit
;
1024 msg
.n_strings
= (string1
!= NULL
) + (string1
&& string2
);
1025 msg
.strings
= astrings
;
1026 astrings
[0] = (gchar
*) string1
;
1027 astrings
[1] = astrings
[0] ? (gchar
*) string2
: NULL
;
1028 msg
.n_nums
= n_args
;
1030 dbuffer
= g_test_log_dump (&msg
, &dbufferlen
);
1031 g_test_log_send (dbufferlen
, dbuffer
);
1036 case G_TEST_LOG_START_CASE
:
1039 else if (g_test_verbose ())
1040 g_print ("GTest: run: %s\n", string1
);
1041 else if (!g_test_quiet ())
1042 g_print ("%s: ", string1
);
1048 /* We intentionally parse the command line without GOptionContext
1049 * because otherwise you would never be able to test it.
1052 parse_args (gint
*argc_p
,
1055 guint argc
= *argc_p
;
1056 gchar
**argv
= *argv_p
;
1059 test_argv0
= argv
[0];
1060 test_initial_cwd
= g_get_current_dir ();
1062 /* parse known args */
1063 for (i
= 1; i
< argc
; i
++)
1065 if (strcmp (argv
[i
], "--g-fatal-warnings") == 0)
1067 GLogLevelFlags fatal_mask
= (GLogLevelFlags
) g_log_set_always_fatal ((GLogLevelFlags
) G_LOG_FATAL_MASK
);
1068 fatal_mask
= (GLogLevelFlags
) (fatal_mask
| G_LOG_LEVEL_WARNING
| G_LOG_LEVEL_CRITICAL
);
1069 g_log_set_always_fatal (fatal_mask
);
1072 else if (strcmp (argv
[i
], "--keep-going") == 0 ||
1073 strcmp (argv
[i
], "-k") == 0)
1075 test_mode_fatal
= FALSE
;
1078 else if (strcmp (argv
[i
], "--debug-log") == 0)
1080 test_debug_log
= TRUE
;
1083 else if (strcmp (argv
[i
], "--tap") == 0)
1085 test_tap_log
= TRUE
;
1088 else if (strcmp ("--GTestLogFD", argv
[i
]) == 0 || strncmp ("--GTestLogFD=", argv
[i
], 13) == 0)
1090 gchar
*equal
= argv
[i
] + 12;
1092 test_log_fd
= g_ascii_strtoull (equal
+ 1, NULL
, 0);
1093 else if (i
+ 1 < argc
)
1096 test_log_fd
= g_ascii_strtoull (argv
[i
], NULL
, 0);
1100 else if (strcmp ("--GTestSkipCount", argv
[i
]) == 0 || strncmp ("--GTestSkipCount=", argv
[i
], 17) == 0)
1102 gchar
*equal
= argv
[i
] + 16;
1104 test_startup_skip_count
= g_ascii_strtoull (equal
+ 1, NULL
, 0);
1105 else if (i
+ 1 < argc
)
1108 test_startup_skip_count
= g_ascii_strtoull (argv
[i
], NULL
, 0);
1112 else if (strcmp ("--GTestSubprocess", argv
[i
]) == 0)
1114 test_in_subprocess
= TRUE
;
1115 /* We typically expect these child processes to crash, and some
1116 * tests spawn a *lot* of them. Avoid spamming system crash
1117 * collection programs such as systemd-coredump and abrt.
1119 #ifdef HAVE_SYS_RESOURCE_H
1121 struct rlimit limit
= { 0, 0 };
1122 (void) setrlimit (RLIMIT_CORE
, &limit
);
1127 else if (strcmp ("-p", argv
[i
]) == 0 || strncmp ("-p=", argv
[i
], 3) == 0)
1129 gchar
*equal
= argv
[i
] + 2;
1131 test_paths
= g_slist_prepend (test_paths
, equal
+ 1);
1132 else if (i
+ 1 < argc
)
1135 test_paths
= g_slist_prepend (test_paths
, argv
[i
]);
1139 else if (strcmp ("-s", argv
[i
]) == 0 || strncmp ("-s=", argv
[i
], 3) == 0)
1141 gchar
*equal
= argv
[i
] + 2;
1143 test_paths_skipped
= g_slist_prepend (test_paths_skipped
, equal
+ 1);
1144 else if (i
+ 1 < argc
)
1147 test_paths_skipped
= g_slist_prepend (test_paths_skipped
, argv
[i
]);
1151 else if (strcmp ("-m", argv
[i
]) == 0 || strncmp ("-m=", argv
[i
], 3) == 0)
1153 gchar
*equal
= argv
[i
] + 2;
1154 const gchar
*mode
= "";
1157 else if (i
+ 1 < argc
)
1162 if (strcmp (mode
, "perf") == 0)
1163 mutable_test_config_vars
.test_perf
= TRUE
;
1164 else if (strcmp (mode
, "slow") == 0)
1165 mutable_test_config_vars
.test_quick
= FALSE
;
1166 else if (strcmp (mode
, "thorough") == 0)
1167 mutable_test_config_vars
.test_quick
= FALSE
;
1168 else if (strcmp (mode
, "quick") == 0)
1170 mutable_test_config_vars
.test_quick
= TRUE
;
1171 mutable_test_config_vars
.test_perf
= FALSE
;
1173 else if (strcmp (mode
, "undefined") == 0)
1174 mutable_test_config_vars
.test_undefined
= TRUE
;
1175 else if (strcmp (mode
, "no-undefined") == 0)
1176 mutable_test_config_vars
.test_undefined
= FALSE
;
1178 g_error ("unknown test mode: -m %s", mode
);
1181 else if (strcmp ("-q", argv
[i
]) == 0 || strcmp ("--quiet", argv
[i
]) == 0)
1183 mutable_test_config_vars
.test_quiet
= TRUE
;
1184 mutable_test_config_vars
.test_verbose
= FALSE
;
1187 else if (strcmp ("--verbose", argv
[i
]) == 0)
1189 mutable_test_config_vars
.test_quiet
= FALSE
;
1190 mutable_test_config_vars
.test_verbose
= TRUE
;
1193 else if (strcmp ("-l", argv
[i
]) == 0)
1195 test_run_list
= TRUE
;
1198 else if (strcmp ("--seed", argv
[i
]) == 0 || strncmp ("--seed=", argv
[i
], 7) == 0)
1200 gchar
*equal
= argv
[i
] + 6;
1202 test_run_seedstr
= equal
+ 1;
1203 else if (i
+ 1 < argc
)
1206 test_run_seedstr
= argv
[i
];
1210 else if (strcmp ("-?", argv
[i
]) == 0 ||
1211 strcmp ("-h", argv
[i
]) == 0 ||
1212 strcmp ("--help", argv
[i
]) == 0)
1215 " %s [OPTION...]\n\n"
1217 " -h, --help Show help options\n\n"
1219 " --g-fatal-warnings Make all warnings fatal\n"
1220 " -l List test cases available in a test executable\n"
1221 " -m {perf|slow|thorough|quick} Execute tests according to mode\n"
1222 " -m {undefined|no-undefined} Execute tests according to mode\n"
1223 " -p TESTPATH Only start test cases matching TESTPATH\n"
1224 " -s TESTPATH Skip all tests matching TESTPATH\n"
1225 " --seed=SEEDSTRING Start tests with random seed SEEDSTRING\n"
1226 " --debug-log debug test logging output\n"
1227 " -q, --quiet Run tests quietly\n"
1228 " --verbose Run tests verbosely\n",
1235 for (i
= 1; i
< argc
; i
++)
1238 argv
[e
++] = argv
[i
];
1247 * @argc: Address of the @argc parameter of the main() function.
1248 * Changed if any arguments were handled.
1249 * @argv: Address of the @argv parameter of main().
1250 * Any parameters understood by g_test_init() stripped before return.
1251 * @...: %NULL-terminated list of special options. Currently the only
1252 * defined option is `"no_g_set_prgname"`, which
1253 * will cause g_test_init() to not call g_set_prgname().
1255 * Initialize the GLib testing framework, e.g. by seeding the
1256 * test random number generator, the name for g_get_prgname()
1257 * and parsing test related command line args.
1259 * So far, the following arguments are understood:
1261 * - `-l`: List test cases available in a test executable.
1262 * - `--seed=SEED`: Provide a random seed to reproduce test
1263 * runs using random numbers.
1264 * - `--verbose`: Run tests verbosely.
1265 * - `-q`, `--quiet`: Run tests quietly.
1266 * - `-p PATH`: Execute all tests matching the given path.
1267 * - `-s PATH`: Skip all tests matching the given path.
1268 * This can also be used to force a test to run that would otherwise
1269 * be skipped (ie, a test whose name contains "/subprocess").
1270 * - `-m {perf|slow|thorough|quick|undefined|no-undefined}`: Execute tests according to these test modes:
1272 * `perf`: Performance tests, may take long and report results (off by default).
1274 * `slow`, `thorough`: Slow and thorough tests, may take quite long and maximize coverage
1277 * `quick`: Quick tests, should run really quickly and give good coverage (the default).
1279 * `undefined`: Tests for undefined behaviour, may provoke programming errors
1280 * under g_test_trap_subprocess() or g_test_expect_message() to check
1281 * that appropriate assertions or warnings are given (the default).
1283 * `no-undefined`: Avoid tests for undefined behaviour
1285 * - `--debug-log`: Debug test logging output.
1287 * Since 2.58, if tests are compiled with `G_DISABLE_ASSERT` defined,
1288 * g_test_init() will print an error and exit. This is to prevent no-op tests
1289 * from being executed, as g_assert() is commonly (erroneously) used in unit
1290 * tests, and is a no-op when compiled with `G_DISABLE_ASSERT`. Ensure your
1291 * tests are compiled without `G_DISABLE_ASSERT` defined.
1296 (g_test_init
) (int *argc
,
1300 static char seedstr
[4 + 4 * 8 + 1];
1303 /* make warnings and criticals fatal for all test programs */
1304 GLogLevelFlags fatal_mask
= (GLogLevelFlags
) g_log_set_always_fatal ((GLogLevelFlags
) G_LOG_FATAL_MASK
);
1306 fatal_mask
= (GLogLevelFlags
) (fatal_mask
| G_LOG_LEVEL_WARNING
| G_LOG_LEVEL_CRITICAL
);
1307 g_log_set_always_fatal (fatal_mask
);
1308 /* check caller args */
1309 g_return_if_fail (argc
!= NULL
);
1310 g_return_if_fail (argv
!= NULL
);
1311 g_return_if_fail (g_test_config_vars
->test_initialized
== FALSE
);
1312 mutable_test_config_vars
.test_initialized
= TRUE
;
1314 va_start (args
, argv
);
1315 while ((option
= va_arg (args
, char *)))
1317 if (g_strcmp0 (option
, "no_g_set_prgname") == 0)
1318 no_g_set_prgname
= TRUE
;
1322 /* setup random seed string */
1323 g_snprintf (seedstr
, sizeof (seedstr
), "R02S%08x%08x%08x%08x", g_random_int(), g_random_int(), g_random_int(), g_random_int());
1324 test_run_seedstr
= seedstr
;
1326 /* parse args, sets up mode, changes seed, etc. */
1327 parse_args (argc
, argv
);
1329 if (!g_get_prgname() && !no_g_set_prgname
)
1330 g_set_prgname ((*argv
)[0]);
1335 if (test_paths
|| test_startup_skip_count
)
1337 /* Not invoking every test (even if SKIPped) breaks the "1..XX" plan */
1338 g_printerr ("%s: -p and --GTestSkipCount options are incompatible with --tap\n",
1344 /* verify GRand reliability, needed for reliable seeds */
1347 GRand
*rg
= g_rand_new_with_seed (0xc8c49fb6);
1348 guint32 t1
= g_rand_int (rg
), t2
= g_rand_int (rg
), t3
= g_rand_int (rg
), t4
= g_rand_int (rg
);
1349 /* g_print ("GRand-current: 0x%x 0x%x 0x%x 0x%x\n", t1, t2, t3, t4); */
1350 if (t1
!= 0xfab39f9b || t2
!= 0xb948fb0e || t3
!= 0x3d31be26 || t4
!= 0x43a19d66)
1351 g_warning ("random numbers are not GRand-2.2 compatible, seeds may be broken (check $G_RANDOM_VERSION)");
1355 /* check rand seed */
1356 test_run_seed (test_run_seedstr
);
1358 /* report program start */
1359 g_log_set_default_handler (gtest_default_log_handler
, NULL
);
1360 g_test_log (G_TEST_LOG_START_BINARY
, g_get_prgname(), test_run_seedstr
, 0, NULL
);
1362 test_argv0_dirname
= g_path_get_dirname (test_argv0
);
1364 /* Make sure we get the real dirname that the test was run from */
1365 if (g_str_has_suffix (test_argv0_dirname
, "/.libs"))
1368 tmp
= g_path_get_dirname (test_argv0_dirname
);
1369 g_free (test_argv0_dirname
);
1370 test_argv0_dirname
= tmp
;
1373 test_disted_files_dir
= g_getenv ("G_TEST_SRCDIR");
1374 if (!test_disted_files_dir
)
1375 test_disted_files_dir
= test_argv0_dirname
;
1377 test_built_files_dir
= g_getenv ("G_TEST_BUILDDIR");
1378 if (!test_built_files_dir
)
1379 test_built_files_dir
= test_argv0_dirname
;
1383 test_run_seed (const gchar
*rseed
)
1385 guint seed_failed
= 0;
1387 g_rand_free (test_run_rand
);
1388 test_run_rand
= NULL
;
1389 while (strchr (" \t\v\r\n\f", *rseed
))
1391 if (strncmp (rseed
, "R02S", 4) == 0) /* seed for random generator 02 (GRand-2.2) */
1393 const char *s
= rseed
+ 4;
1394 if (strlen (s
) >= 32) /* require 4 * 8 chars */
1396 guint32 seedarray
[4];
1397 gchar
*p
, hexbuf
[9] = { 0, };
1398 memcpy (hexbuf
, s
+ 0, 8);
1399 seedarray
[0] = g_ascii_strtoull (hexbuf
, &p
, 16);
1400 seed_failed
+= p
!= NULL
&& *p
!= 0;
1401 memcpy (hexbuf
, s
+ 8, 8);
1402 seedarray
[1] = g_ascii_strtoull (hexbuf
, &p
, 16);
1403 seed_failed
+= p
!= NULL
&& *p
!= 0;
1404 memcpy (hexbuf
, s
+ 16, 8);
1405 seedarray
[2] = g_ascii_strtoull (hexbuf
, &p
, 16);
1406 seed_failed
+= p
!= NULL
&& *p
!= 0;
1407 memcpy (hexbuf
, s
+ 24, 8);
1408 seedarray
[3] = g_ascii_strtoull (hexbuf
, &p
, 16);
1409 seed_failed
+= p
!= NULL
&& *p
!= 0;
1412 test_run_rand
= g_rand_new_with_seed_array (seedarray
, 4);
1417 g_error ("Unknown or invalid random seed: %s", rseed
);
1423 * Get a reproducible random integer number.
1425 * The random numbers generated by the g_test_rand_*() family of functions
1426 * change with every new test program start, unless the --seed option is
1427 * given when starting test programs.
1429 * For individual test cases however, the random number generator is
1430 * reseeded, to avoid dependencies between tests and to make --seed
1431 * effective for all test cases.
1433 * Returns: a random number from the seeded random number generator.
1438 g_test_rand_int (void)
1440 return g_rand_int (test_run_rand
);
1444 * g_test_rand_int_range:
1445 * @begin: the minimum value returned by this function
1446 * @end: the smallest value not to be returned by this function
1448 * Get a reproducible random integer number out of a specified range,
1449 * see g_test_rand_int() for details on test case random numbers.
1451 * Returns: a number with @begin <= number < @end.
1456 g_test_rand_int_range (gint32 begin
,
1459 return g_rand_int_range (test_run_rand
, begin
, end
);
1463 * g_test_rand_double:
1465 * Get a reproducible random floating point number,
1466 * see g_test_rand_int() for details on test case random numbers.
1468 * Returns: a random number from the seeded random number generator.
1473 g_test_rand_double (void)
1475 return g_rand_double (test_run_rand
);
1479 * g_test_rand_double_range:
1480 * @range_start: the minimum value returned by this function
1481 * @range_end: the minimum value not returned by this function
1483 * Get a reproducible random floating pointer number out of a specified range,
1484 * see g_test_rand_int() for details on test case random numbers.
1486 * Returns: a number with @range_start <= number < @range_end.
1491 g_test_rand_double_range (double range_start
,
1494 return g_rand_double_range (test_run_rand
, range_start
, range_end
);
1498 * g_test_timer_start:
1500 * Start a timing test. Call g_test_timer_elapsed() when the task is supposed
1501 * to be done. Call this function again to restart the timer.
1506 g_test_timer_start (void)
1508 if (!test_user_timer
)
1509 test_user_timer
= g_timer_new();
1510 test_user_stamp
= 0;
1511 g_timer_start (test_user_timer
);
1515 * g_test_timer_elapsed:
1517 * Get the time since the last start of the timer with g_test_timer_start().
1519 * Returns: the time since the last start of the timer, as a double
1524 g_test_timer_elapsed (void)
1526 test_user_stamp
= test_user_timer
? g_timer_elapsed (test_user_timer
, NULL
) : 0;
1527 return test_user_stamp
;
1531 * g_test_timer_last:
1533 * Report the last result of g_test_timer_elapsed().
1535 * Returns: the last result of g_test_timer_elapsed(), as a double
1540 g_test_timer_last (void)
1542 return test_user_stamp
;
1546 * g_test_minimized_result:
1547 * @minimized_quantity: the reported value
1548 * @format: the format string of the report message
1549 * @...: arguments to pass to the printf() function
1551 * Report the result of a performance or measurement test.
1552 * The test should generally strive to minimize the reported
1553 * quantities (smaller values are better than larger ones),
1554 * this and @minimized_quantity can determine sorting
1555 * order for test result reports.
1560 g_test_minimized_result (double minimized_quantity
,
1564 long double largs
= minimized_quantity
;
1568 va_start (args
, format
);
1569 buffer
= g_strdup_vprintf (format
, args
);
1572 g_test_log (G_TEST_LOG_MIN_RESULT
, buffer
, NULL
, 1, &largs
);
1577 * g_test_maximized_result:
1578 * @maximized_quantity: the reported value
1579 * @format: the format string of the report message
1580 * @...: arguments to pass to the printf() function
1582 * Report the result of a performance or measurement test.
1583 * The test should generally strive to maximize the reported
1584 * quantities (larger values are better than smaller ones),
1585 * this and @maximized_quantity can determine sorting
1586 * order for test result reports.
1591 g_test_maximized_result (double maximized_quantity
,
1595 long double largs
= maximized_quantity
;
1599 va_start (args
, format
);
1600 buffer
= g_strdup_vprintf (format
, args
);
1603 g_test_log (G_TEST_LOG_MAX_RESULT
, buffer
, NULL
, 1, &largs
);
1609 * @format: the format string
1610 * @...: printf-like arguments to @format
1612 * Add a message to the test report.
1617 g_test_message (const char *format
,
1623 va_start (args
, format
);
1624 buffer
= g_strdup_vprintf (format
, args
);
1627 g_test_log (G_TEST_LOG_MESSAGE
, buffer
, NULL
, 0, NULL
);
1633 * @uri_pattern: the base pattern for bug URIs
1635 * Specify the base URI for bug reports.
1637 * The base URI is used to construct bug report messages for
1638 * g_test_message() when g_test_bug() is called.
1639 * Calling this function outside of a test case sets the
1640 * default base URI for all test cases. Calling it from within
1641 * a test case changes the base URI for the scope of the test
1643 * Bug URIs are constructed by appending a bug specific URI
1644 * portion to @uri_pattern, or by replacing the special string
1645 * '\%s' within @uri_pattern if that is present.
1650 g_test_bug_base (const char *uri_pattern
)
1652 g_free (test_uri_base
);
1653 test_uri_base
= g_strdup (uri_pattern
);
1658 * @bug_uri_snippet: Bug specific bug tracker URI portion.
1660 * This function adds a message to test reports that
1661 * associates a bug URI with a test case.
1662 * Bug URIs are constructed from a base URI set with g_test_bug_base()
1663 * and @bug_uri_snippet.
1668 g_test_bug (const char *bug_uri_snippet
)
1672 g_return_if_fail (test_uri_base
!= NULL
);
1673 g_return_if_fail (bug_uri_snippet
!= NULL
);
1675 c
= strstr (test_uri_base
, "%s");
1678 char *b
= g_strndup (test_uri_base
, c
- test_uri_base
);
1679 char *s
= g_strconcat (b
, bug_uri_snippet
, c
+ 2, NULL
);
1681 g_test_message ("Bug Reference: %s", s
);
1685 g_test_message ("Bug Reference: %s%s", test_uri_base
, bug_uri_snippet
);
1691 * Get the toplevel test suite for the test path API.
1693 * Returns: the toplevel #GTestSuite
1698 g_test_get_root (void)
1700 if (!test_suite_root
)
1702 test_suite_root
= g_test_create_suite ("root");
1703 g_free (test_suite_root
->name
);
1704 test_suite_root
->name
= g_strdup ("");
1707 return test_suite_root
;
1713 * Runs all tests under the toplevel suite which can be retrieved
1714 * with g_test_get_root(). Similar to g_test_run_suite(), the test
1715 * cases to be run are filtered according to test path arguments
1716 * (`-p testpath` and `-s testpath`) as parsed by g_test_init().
1717 * g_test_run_suite() or g_test_run() may only be called once in a
1720 * In general, the tests and sub-suites within each suite are run in
1721 * the order in which they are defined. However, note that prior to
1722 * GLib 2.36, there was a bug in the `g_test_add_*`
1723 * functions which caused them to create multiple suites with the same
1724 * name, meaning that if you created tests "/foo/simple",
1725 * "/bar/simple", and "/foo/using-bar" in that order, they would get
1726 * run in that order (since g_test_run() would run the first "/foo"
1727 * suite, then the "/bar" suite, then the second "/foo" suite). As of
1728 * 2.36, this bug is fixed, and adding the tests in that order would
1729 * result in a running order of "/foo/simple", "/foo/using-bar",
1730 * "/bar/simple". If this new ordering is sub-optimal (because it puts
1731 * more-complicated tests before simpler ones, making it harder to
1732 * figure out exactly what has failed), you can fix it by changing the
1733 * test paths to group tests by suite in a way that will result in the
1734 * desired running order. Eg, "/simple/foo", "/simple/bar",
1735 * "/complex/foo-using-bar".
1737 * However, you should never make the actual result of a test depend
1738 * on the order that tests are run in. If you need to ensure that some
1739 * particular code runs before or after a given test case, use
1740 * g_test_add(), which lets you specify setup and teardown functions.
1742 * If all tests are skipped or marked as incomplete (expected failures),
1743 * this function will return 0 if producing TAP output, or 77 (treated
1744 * as "skip test" by Automake) otherwise.
1746 * Returns: 0 on success, 1 on failure (assuming it returns at all),
1747 * 0 or 77 if all tests were skipped with g_test_skip() and/or
1748 * g_test_incomplete()
1755 if (g_test_run_suite (g_test_get_root()) != 0)
1758 /* 77 is special to Automake's default driver, but not Automake's TAP driver
1759 * or Perl's prove(1) TAP driver. */
1763 if (test_run_count
> 0 && test_run_count
== test_skipped_count
)
1770 * g_test_create_case:
1771 * @test_name: the name for the test case
1772 * @data_size: the size of the fixture data structure
1773 * @test_data: test data argument for the test functions
1774 * @data_setup: (scope async): the function to set up the fixture data
1775 * @data_test: (scope async): the actual test function
1776 * @data_teardown: (scope async): the function to teardown the fixture data
1778 * Create a new #GTestCase, named @test_name, this API is fairly
1779 * low level, calling g_test_add() or g_test_add_func() is preferable.
1780 * When this test is executed, a fixture structure of size @data_size
1781 * will be automatically allocated and filled with zeros. Then @data_setup is
1782 * called to initialize the fixture. After fixture setup, the actual test
1783 * function @data_test is called. Once the test run completes, the
1784 * fixture structure is torn down by calling @data_teardown and
1785 * after that the memory is automatically released by the test framework.
1787 * Splitting up a test run into fixture setup, test function and
1788 * fixture teardown is most useful if the same fixture is used for
1789 * multiple tests. In this cases, g_test_create_case() will be
1790 * called with the same fixture, but varying @test_name and
1791 * @data_test arguments.
1793 * Returns: a newly allocated #GTestCase.
1798 g_test_create_case (const char *test_name
,
1800 gconstpointer test_data
,
1801 GTestFixtureFunc data_setup
,
1802 GTestFixtureFunc data_test
,
1803 GTestFixtureFunc data_teardown
)
1807 g_return_val_if_fail (test_name
!= NULL
, NULL
);
1808 g_return_val_if_fail (strchr (test_name
, '/') == NULL
, NULL
);
1809 g_return_val_if_fail (test_name
[0] != 0, NULL
);
1810 g_return_val_if_fail (data_test
!= NULL
, NULL
);
1812 tc
= g_slice_new0 (GTestCase
);
1813 tc
->name
= g_strdup (test_name
);
1814 tc
->test_data
= (gpointer
) test_data
;
1815 tc
->fixture_size
= data_size
;
1816 tc
->fixture_setup
= (void*) data_setup
;
1817 tc
->fixture_test
= (void*) data_test
;
1818 tc
->fixture_teardown
= (void*) data_teardown
;
1824 find_suite (gconstpointer l
, gconstpointer s
)
1826 const GTestSuite
*suite
= l
;
1827 const gchar
*str
= s
;
1829 return strcmp (suite
->name
, str
);
1833 find_case (gconstpointer l
, gconstpointer s
)
1835 const GTestCase
*tc
= l
;
1836 const gchar
*str
= s
;
1838 return strcmp (tc
->name
, str
);
1843 * @fixture: (not nullable): the test fixture
1844 * @user_data: the data provided when registering the test
1846 * The type used for functions that operate on test fixtures. This is
1847 * used for the fixture setup and teardown functions as well as for the
1848 * testcases themselves.
1850 * @user_data is a pointer to the data that was given when registering
1853 * @fixture will be a pointer to the area of memory allocated by the
1854 * test framework, of the size requested. If the requested size was
1855 * zero then @fixture will be equal to @user_data.
1860 g_test_add_vtable (const char *testpath
,
1862 gconstpointer test_data
,
1863 GTestFixtureFunc data_setup
,
1864 GTestFixtureFunc fixture_test_func
,
1865 GTestFixtureFunc data_teardown
)
1871 g_return_if_fail (testpath
!= NULL
);
1872 g_return_if_fail (g_path_is_absolute (testpath
));
1873 g_return_if_fail (fixture_test_func
!= NULL
);
1875 suite
= g_test_get_root();
1876 segments
= g_strsplit (testpath
, "/", -1);
1877 for (ui
= 0; segments
[ui
] != NULL
; ui
++)
1879 const char *seg
= segments
[ui
];
1880 gboolean islast
= segments
[ui
+ 1] == NULL
;
1881 if (islast
&& !seg
[0])
1882 g_error ("invalid test case path: %s", testpath
);
1884 continue; /* initial or duplicate slash */
1889 l
= g_slist_find_custom (suite
->suites
, seg
, find_suite
);
1896 csuite
= g_test_create_suite (seg
);
1897 g_test_suite_add_suite (suite
, csuite
);
1905 if (g_slist_find_custom (suite
->cases
, seg
, find_case
))
1906 g_error ("duplicate test case path: %s", testpath
);
1908 tc
= g_test_create_case (seg
, data_size
, test_data
, data_setup
, fixture_test_func
, data_teardown
);
1909 g_test_suite_add (suite
, tc
);
1912 g_strfreev (segments
);
1918 * Indicates that a test failed. This function can be called
1919 * multiple times from the same test. You can use this function
1920 * if your test failed in a recoverable way.
1922 * Do not use this function if the failure of a test could cause
1923 * other tests to malfunction.
1925 * Calling this function will not stop the test from running, you
1926 * need to return from the test function yourself. So you can
1927 * produce additional diagnostic messages or even continue running
1930 * If not called from inside a test, this function does nothing.
1937 test_run_success
= G_TEST_RUN_FAILURE
;
1941 * g_test_incomplete:
1942 * @msg: (nullable): explanation
1944 * Indicates that a test failed because of some incomplete
1945 * functionality. This function can be called multiple times
1946 * from the same test.
1948 * Calling this function will not stop the test from running, you
1949 * need to return from the test function yourself. So you can
1950 * produce additional diagnostic messages or even continue running
1953 * If not called from inside a test, this function does nothing.
1958 g_test_incomplete (const gchar
*msg
)
1960 test_run_success
= G_TEST_RUN_INCOMPLETE
;
1961 g_free (test_run_msg
);
1962 test_run_msg
= g_strdup (msg
);
1967 * @msg: (nullable): explanation
1969 * Indicates that a test was skipped.
1971 * Calling this function will not stop the test from running, you
1972 * need to return from the test function yourself. So you can
1973 * produce additional diagnostic messages or even continue running
1976 * If not called from inside a test, this function does nothing.
1981 g_test_skip (const gchar
*msg
)
1983 test_run_success
= G_TEST_RUN_SKIPPED
;
1984 g_free (test_run_msg
);
1985 test_run_msg
= g_strdup (msg
);
1991 * Returns whether a test has already failed. This will
1992 * be the case when g_test_fail(), g_test_incomplete()
1993 * or g_test_skip() have been called, but also if an
1994 * assertion has failed.
1996 * This can be useful to return early from a test if
1997 * continuing after a failed assertion might be harmful.
1999 * The return value of this function is only meaningful
2000 * if it is called from inside a test function.
2002 * Returns: %TRUE if the test has failed
2007 g_test_failed (void)
2009 return test_run_success
!= G_TEST_RUN_SUCCESS
;
2013 * g_test_set_nonfatal_assertions:
2015 * Changes the behaviour of g_assert_cmpstr(), g_assert_cmpint(),
2016 * g_assert_cmpuint(), g_assert_cmphex(), g_assert_cmpfloat(),
2017 * g_assert_true(), g_assert_false(), g_assert_null(), g_assert_no_error(),
2018 * g_assert_error(), g_test_assert_expected_messages() and the various
2019 * g_test_trap_assert_*() macros to not abort to program, but instead
2020 * call g_test_fail() and continue. (This also changes the behavior of
2021 * g_test_fail() so that it will not cause the test program to abort
2022 * after completing the failed test.)
2024 * Note that the g_assert_not_reached() and g_assert() are not
2027 * This function can only be called after g_test_init().
2032 g_test_set_nonfatal_assertions (void)
2034 if (!g_test_config_vars
->test_initialized
)
2035 g_error ("g_test_set_nonfatal_assertions called without g_test_init");
2036 test_nonfatal_assertions
= TRUE
;
2037 test_mode_fatal
= FALSE
;
2043 * The type used for test case functions.
2050 * @testpath: /-separated test case path name for the test.
2051 * @test_func: (scope async): The test function to invoke for this test.
2053 * Create a new test case, similar to g_test_create_case(). However
2054 * the test is assumed to use no fixture, and test suites are automatically
2055 * created on the fly and added to the root fixture, based on the
2056 * slash-separated portions of @testpath.
2058 * If @testpath includes the component "subprocess" anywhere in it,
2059 * the test will be skipped by default, and only run if explicitly
2060 * required via the `-p` command-line option or g_test_trap_subprocess().
2065 g_test_add_func (const char *testpath
,
2066 GTestFunc test_func
)
2068 g_return_if_fail (testpath
!= NULL
);
2069 g_return_if_fail (testpath
[0] == '/');
2070 g_return_if_fail (test_func
!= NULL
);
2071 g_test_add_vtable (testpath
, 0, NULL
, NULL
, (GTestFixtureFunc
) test_func
, NULL
);
2076 * @user_data: the data provided when registering the test
2078 * The type used for test case functions that take an extra pointer
2085 * g_test_add_data_func:
2086 * @testpath: /-separated test case path name for the test.
2087 * @test_data: Test data argument for the test function.
2088 * @test_func: (scope async): The test function to invoke for this test.
2090 * Create a new test case, similar to g_test_create_case(). However
2091 * the test is assumed to use no fixture, and test suites are automatically
2092 * created on the fly and added to the root fixture, based on the
2093 * slash-separated portions of @testpath. The @test_data argument
2094 * will be passed as first argument to @test_func.
2096 * If @testpath includes the component "subprocess" anywhere in it,
2097 * the test will be skipped by default, and only run if explicitly
2098 * required via the `-p` command-line option or g_test_trap_subprocess().
2103 g_test_add_data_func (const char *testpath
,
2104 gconstpointer test_data
,
2105 GTestDataFunc test_func
)
2107 g_return_if_fail (testpath
!= NULL
);
2108 g_return_if_fail (testpath
[0] == '/');
2109 g_return_if_fail (test_func
!= NULL
);
2111 g_test_add_vtable (testpath
, 0, test_data
, NULL
, (GTestFixtureFunc
) test_func
, NULL
);
2115 * g_test_add_data_func_full:
2116 * @testpath: /-separated test case path name for the test.
2117 * @test_data: Test data argument for the test function.
2118 * @test_func: The test function to invoke for this test.
2119 * @data_free_func: #GDestroyNotify for @test_data.
2121 * Create a new test case, as with g_test_add_data_func(), but freeing
2122 * @test_data after the test run is complete.
2127 g_test_add_data_func_full (const char *testpath
,
2129 GTestDataFunc test_func
,
2130 GDestroyNotify data_free_func
)
2132 g_return_if_fail (testpath
!= NULL
);
2133 g_return_if_fail (testpath
[0] == '/');
2134 g_return_if_fail (test_func
!= NULL
);
2136 g_test_add_vtable (testpath
, 0, test_data
, NULL
,
2137 (GTestFixtureFunc
) test_func
,
2138 (GTestFixtureFunc
) data_free_func
);
2142 g_test_suite_case_exists (GTestSuite
*suite
,
2143 const char *test_path
)
2150 slash
= strchr (test_path
, '/');
2154 for (iter
= suite
->suites
; iter
; iter
= iter
->next
)
2156 GTestSuite
*child_suite
= iter
->data
;
2158 if (!strncmp (child_suite
->name
, test_path
, slash
- test_path
))
2159 if (g_test_suite_case_exists (child_suite
, slash
))
2165 for (iter
= suite
->cases
; iter
; iter
= iter
->next
)
2168 if (!strcmp (tc
->name
, test_path
))
2177 * g_test_create_suite:
2178 * @suite_name: a name for the suite
2180 * Create a new test suite with the name @suite_name.
2182 * Returns: A newly allocated #GTestSuite instance.
2187 g_test_create_suite (const char *suite_name
)
2190 g_return_val_if_fail (suite_name
!= NULL
, NULL
);
2191 g_return_val_if_fail (strchr (suite_name
, '/') == NULL
, NULL
);
2192 g_return_val_if_fail (suite_name
[0] != 0, NULL
);
2193 ts
= g_slice_new0 (GTestSuite
);
2194 ts
->name
= g_strdup (suite_name
);
2200 * @suite: a #GTestSuite
2201 * @test_case: a #GTestCase
2203 * Adds @test_case to @suite.
2208 g_test_suite_add (GTestSuite
*suite
,
2209 GTestCase
*test_case
)
2211 g_return_if_fail (suite
!= NULL
);
2212 g_return_if_fail (test_case
!= NULL
);
2214 suite
->cases
= g_slist_append (suite
->cases
, test_case
);
2218 * g_test_suite_add_suite:
2219 * @suite: a #GTestSuite
2220 * @nestedsuite: another #GTestSuite
2222 * Adds @nestedsuite to @suite.
2227 g_test_suite_add_suite (GTestSuite
*suite
,
2228 GTestSuite
*nestedsuite
)
2230 g_return_if_fail (suite
!= NULL
);
2231 g_return_if_fail (nestedsuite
!= NULL
);
2233 suite
->suites
= g_slist_append (suite
->suites
, nestedsuite
);
2237 * g_test_queue_free:
2238 * @gfree_pointer: the pointer to be stored.
2240 * Enqueue a pointer to be released with g_free() during the next
2241 * teardown phase. This is equivalent to calling g_test_queue_destroy()
2242 * with a destroy callback of g_free().
2247 g_test_queue_free (gpointer gfree_pointer
)
2250 g_test_queue_destroy (g_free
, gfree_pointer
);
2254 * g_test_queue_destroy:
2255 * @destroy_func: Destroy callback for teardown phase.
2256 * @destroy_data: Destroy callback data.
2258 * This function enqueus a callback @destroy_func to be executed
2259 * during the next test case teardown phase. This is most useful
2260 * to auto destruct allocated test resources at the end of a test run.
2261 * Resources are released in reverse queue order, that means enqueueing
2262 * callback A before callback B will cause B() to be called before
2263 * A() during teardown.
2268 g_test_queue_destroy (GDestroyNotify destroy_func
,
2269 gpointer destroy_data
)
2271 DestroyEntry
*dentry
;
2273 g_return_if_fail (destroy_func
!= NULL
);
2275 dentry
= g_slice_new0 (DestroyEntry
);
2276 dentry
->destroy_func
= destroy_func
;
2277 dentry
->destroy_data
= destroy_data
;
2278 dentry
->next
= test_destroy_queue
;
2279 test_destroy_queue
= dentry
;
2283 test_case_run (GTestCase
*tc
)
2285 gchar
*old_base
= g_strdup (test_uri_base
);
2286 GSList
**old_free_list
, *filename_free_list
= NULL
;
2287 gboolean success
= G_TEST_RUN_SUCCESS
;
2289 old_free_list
= test_filename_free_list
;
2290 test_filename_free_list
= &filename_free_list
;
2292 if (++test_run_count
<= test_startup_skip_count
)
2293 g_test_log (G_TEST_LOG_SKIP_CASE
, test_run_name
, NULL
, 0, NULL
);
2294 else if (test_run_list
)
2296 g_print ("%s\n", test_run_name
);
2297 g_test_log (G_TEST_LOG_LIST_CASE
, test_run_name
, NULL
, 0, NULL
);
2301 GTimer
*test_run_timer
= g_timer_new();
2302 long double largs
[3];
2304 g_test_log (G_TEST_LOG_START_CASE
, test_run_name
, NULL
, 0, NULL
);
2306 test_run_success
= G_TEST_RUN_SUCCESS
;
2307 g_clear_pointer (&test_run_msg
, g_free
);
2308 g_test_log_set_fatal_handler (NULL
, NULL
);
2309 if (test_paths_skipped
&& g_slist_find_custom (test_paths_skipped
, test_run_name
, (GCompareFunc
)g_strcmp0
))
2310 g_test_skip ("by request (-s option)");
2313 g_timer_start (test_run_timer
);
2314 fixture
= tc
->fixture_size
? g_malloc0 (tc
->fixture_size
) : tc
->test_data
;
2315 test_run_seed (test_run_seedstr
);
2316 if (tc
->fixture_setup
)
2317 tc
->fixture_setup (fixture
, tc
->test_data
);
2318 tc
->fixture_test (fixture
, tc
->test_data
);
2320 while (test_destroy_queue
)
2322 DestroyEntry
*dentry
= test_destroy_queue
;
2323 test_destroy_queue
= dentry
->next
;
2324 dentry
->destroy_func (dentry
->destroy_data
);
2325 g_slice_free (DestroyEntry
, dentry
);
2327 if (tc
->fixture_teardown
)
2328 tc
->fixture_teardown (fixture
, tc
->test_data
);
2329 if (tc
->fixture_size
)
2331 g_timer_stop (test_run_timer
);
2333 success
= test_run_success
;
2334 test_run_success
= G_TEST_RUN_FAILURE
;
2335 largs
[0] = success
; /* OK */
2336 largs
[1] = test_run_forks
;
2337 largs
[2] = g_timer_elapsed (test_run_timer
, NULL
);
2338 g_test_log (G_TEST_LOG_STOP_CASE
, test_run_name
, test_run_msg
, G_N_ELEMENTS (largs
), largs
);
2339 g_clear_pointer (&test_run_msg
, g_free
);
2340 g_timer_destroy (test_run_timer
);
2343 g_slist_free_full (filename_free_list
, g_free
);
2344 test_filename_free_list
= old_free_list
;
2345 g_free (test_uri_base
);
2346 test_uri_base
= old_base
;
2348 return (success
== G_TEST_RUN_SUCCESS
||
2349 success
== G_TEST_RUN_SKIPPED
||
2350 success
== G_TEST_RUN_INCOMPLETE
);
2354 path_has_prefix (const char *path
,
2357 int prefix_len
= strlen (prefix
);
2359 return (strncmp (path
, prefix
, prefix_len
) == 0 &&
2360 (path
[prefix_len
] == '\0' ||
2361 path
[prefix_len
] == '/'));
2365 test_should_run (const char *test_path
,
2366 const char *cmp_path
)
2368 if (strstr (test_run_name
, "/subprocess"))
2370 if (g_strcmp0 (test_path
, cmp_path
) == 0)
2373 if (g_test_verbose ())
2374 g_print ("GTest: skipping: %s\n", test_run_name
);
2378 return !cmp_path
|| path_has_prefix (test_path
, cmp_path
);
2381 /* Recurse through @suite, running tests matching @path (or all tests
2382 * if @path is %NULL).
2385 g_test_run_suite_internal (GTestSuite
*suite
,
2389 gchar
*old_name
= test_run_name
;
2392 g_return_val_if_fail (suite
!= NULL
, -1);
2394 g_test_log (G_TEST_LOG_START_SUITE
, suite
->name
, NULL
, 0, NULL
);
2396 for (iter
= suite
->cases
; iter
; iter
= iter
->next
)
2398 GTestCase
*tc
= iter
->data
;
2400 test_run_name
= g_build_path ("/", old_name
, tc
->name
, NULL
);
2401 if (test_should_run (test_run_name
, path
))
2403 if (!test_case_run (tc
))
2406 g_free (test_run_name
);
2409 for (iter
= suite
->suites
; iter
; iter
= iter
->next
)
2411 GTestSuite
*ts
= iter
->data
;
2413 test_run_name
= g_build_path ("/", old_name
, ts
->name
, NULL
);
2414 if (!path
|| path_has_prefix (path
, test_run_name
))
2415 n_bad
+= g_test_run_suite_internal (ts
, path
);
2416 g_free (test_run_name
);
2419 test_run_name
= old_name
;
2421 g_test_log (G_TEST_LOG_STOP_SUITE
, suite
->name
, NULL
, 0, NULL
);
2427 g_test_suite_count (GTestSuite
*suite
)
2432 g_return_val_if_fail (suite
!= NULL
, -1);
2434 for (iter
= suite
->cases
; iter
; iter
= iter
->next
)
2436 GTestCase
*tc
= iter
->data
;
2438 if (strcmp (tc
->name
, "subprocess") != 0)
2442 for (iter
= suite
->suites
; iter
; iter
= iter
->next
)
2444 GTestSuite
*ts
= iter
->data
;
2446 if (strcmp (ts
->name
, "subprocess") != 0)
2447 n
+= g_test_suite_count (ts
);
2455 * @suite: a #GTestSuite
2457 * Execute the tests within @suite and all nested #GTestSuites.
2458 * The test suites to be executed are filtered according to
2459 * test path arguments (`-p testpath` and `-s testpath`) as parsed by
2460 * g_test_init(). See the g_test_run() documentation for more
2461 * information on the order that tests are run in.
2463 * g_test_run_suite() or g_test_run() may only be called once
2466 * Returns: 0 on success
2471 g_test_run_suite (GTestSuite
*suite
)
2475 g_return_val_if_fail (g_test_run_once
== TRUE
, -1);
2477 g_test_run_once
= FALSE
;
2478 test_count
= g_test_suite_count (suite
);
2480 test_run_name
= g_strdup_printf ("/%s", suite
->name
);
2486 for (iter
= test_paths
; iter
; iter
= iter
->next
)
2487 n_bad
+= g_test_run_suite_internal (suite
, iter
->data
);
2490 n_bad
= g_test_run_suite_internal (suite
, NULL
);
2492 g_free (test_run_name
);
2493 test_run_name
= NULL
;
2499 gtest_default_log_handler (const gchar
*log_domain
,
2500 GLogLevelFlags log_level
,
2501 const gchar
*message
,
2502 gpointer unused_data
)
2504 const gchar
*strv
[16];
2505 gboolean fatal
= FALSE
;
2511 strv
[i
++] = log_domain
;
2514 if (log_level
& G_LOG_FLAG_FATAL
)
2516 strv
[i
++] = "FATAL-";
2519 if (log_level
& G_LOG_FLAG_RECURSION
)
2520 strv
[i
++] = "RECURSIVE-";
2521 if (log_level
& G_LOG_LEVEL_ERROR
)
2522 strv
[i
++] = "ERROR";
2523 if (log_level
& G_LOG_LEVEL_CRITICAL
)
2524 strv
[i
++] = "CRITICAL";
2525 if (log_level
& G_LOG_LEVEL_WARNING
)
2526 strv
[i
++] = "WARNING";
2527 if (log_level
& G_LOG_LEVEL_MESSAGE
)
2528 strv
[i
++] = "MESSAGE";
2529 if (log_level
& G_LOG_LEVEL_INFO
)
2531 if (log_level
& G_LOG_LEVEL_DEBUG
)
2532 strv
[i
++] = "DEBUG";
2534 strv
[i
++] = message
;
2537 msg
= g_strjoinv ("", (gchar
**) strv
);
2538 g_test_log (fatal
? G_TEST_LOG_ERROR
: G_TEST_LOG_MESSAGE
, msg
, NULL
, 0, NULL
);
2539 g_log_default_handler (log_domain
, log_level
, message
, unused_data
);
2545 g_assertion_message (const char *domain
,
2549 const char *message
)
2555 message
= "code should not be reached";
2556 g_snprintf (lstr
, 32, "%d", line
);
2557 s
= g_strconcat (domain
? domain
: "", domain
&& domain
[0] ? ":" : "",
2558 "ERROR:", file
, ":", lstr
, ":",
2559 func
, func
[0] ? ":" : "",
2560 " ", message
, NULL
);
2561 g_printerr ("**\n%s\n", s
);
2563 /* Don't print a fatal error indication if assertions are non-fatal, or
2564 * if we are a child process that might be sharing the parent's stdout. */
2565 if (test_nonfatal_assertions
|| test_in_subprocess
|| test_in_forked_child
)
2566 g_test_log (G_TEST_LOG_MESSAGE
, s
, NULL
, 0, NULL
);
2568 g_test_log (G_TEST_LOG_ERROR
, s
, NULL
, 0, NULL
);
2570 if (test_nonfatal_assertions
)
2577 /* store assertion message in global variable, so that it can be found in a
2579 if (__glib_assert_msg
!= NULL
)
2580 /* free the old one */
2581 free (__glib_assert_msg
);
2582 __glib_assert_msg
= (char*) malloc (strlen (s
) + 1);
2583 strcpy (__glib_assert_msg
, s
);
2587 if (test_in_subprocess
)
2589 /* If this is a test case subprocess then it probably hit this
2590 * assertion on purpose, so just exit() rather than abort()ing,
2591 * to avoid triggering any system crash-reporting daemon.
2600 * g_assertion_message_expr: (skip)
2601 * @domain: (nullable):
2605 * @expr: (nullable):
2608 g_assertion_message_expr (const char *domain
,
2616 s
= g_strdup ("code should not be reached");
2618 s
= g_strconcat ("assertion failed: (", expr
, ")", NULL
);
2619 g_assertion_message (domain
, file
, line
, func
, s
);
2622 /* Normally g_assertion_message() won't return, but we need this for
2623 * when test_nonfatal_assertions is set, since
2624 * g_assertion_message_expr() is used for always-fatal assertions.
2626 if (test_in_subprocess
)
2633 g_assertion_message_cmpnum (const char *domain
,
2647 case 'i': s
= g_strdup_printf ("assertion failed (%s): (%" G_GINT64_MODIFIER
"i %s %" G_GINT64_MODIFIER
"i)", expr
, (gint64
) arg1
, cmp
, (gint64
) arg2
); break;
2648 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;
2649 case 'f': s
= g_strdup_printf ("assertion failed (%s): (%.9g %s %.9g)", expr
, (double) arg1
, cmp
, (double) arg2
); break;
2650 /* ideally use: floats=%.7g double=%.17g */
2652 g_assertion_message (domain
, file
, line
, func
, s
);
2657 g_assertion_message_cmpstr (const char *domain
,
2666 char *a1
, *a2
, *s
, *t1
= NULL
, *t2
= NULL
;
2667 a1
= arg1
? g_strconcat ("\"", t1
= g_strescape (arg1
, NULL
), "\"", NULL
) : g_strdup ("NULL");
2668 a2
= arg2
? g_strconcat ("\"", t2
= g_strescape (arg2
, NULL
), "\"", NULL
) : g_strdup ("NULL");
2671 s
= g_strdup_printf ("assertion failed (%s): (%s %s %s)", expr
, a1
, cmp
, a2
);
2674 g_assertion_message (domain
, file
, line
, func
, s
);
2679 g_assertion_message_error (const char *domain
,
2684 const GError
*error
,
2685 GQuark error_domain
,
2690 /* This is used by both g_assert_error() and g_assert_no_error(), so there
2691 * are three cases: expected an error but got the wrong error, expected
2692 * an error but got no error, and expected no error but got an error.
2695 gstring
= g_string_new ("assertion failed ");
2697 g_string_append_printf (gstring
, "(%s == (%s, %d)): ", expr
,
2698 g_quark_to_string (error_domain
), error_code
);
2700 g_string_append_printf (gstring
, "(%s == NULL): ", expr
);
2703 g_string_append_printf (gstring
, "%s (%s, %d)", error
->message
,
2704 g_quark_to_string (error
->domain
), error
->code
);
2706 g_string_append_printf (gstring
, "%s is NULL", expr
);
2708 g_assertion_message (domain
, file
, line
, func
, gstring
->str
);
2709 g_string_free (gstring
, TRUE
);
2714 * @str1: (nullable): a C string or %NULL
2715 * @str2: (nullable): another C string or %NULL
2717 * Compares @str1 and @str2 like strcmp(). Handles %NULL
2718 * gracefully by sorting it before non-%NULL strings.
2719 * Comparing two %NULL pointers returns 0.
2721 * Returns: an integer less than, equal to, or greater than zero, if @str1 is <, == or > than @str2.
2726 g_strcmp0 (const char *str1
,
2730 return -(str1
!= str2
);
2732 return str1
!= str2
;
2733 return strcmp (str1
, str2
);
2737 test_trap_clear (void)
2739 test_trap_last_status
= 0;
2740 test_trap_last_pid
= 0;
2741 g_clear_pointer (&test_trap_last_subprocess
, g_free
);
2742 g_clear_pointer (&test_trap_last_stdout
, g_free
);
2743 g_clear_pointer (&test_trap_last_stderr
, g_free
);
2754 ret
= dup2 (fd1
, fd2
);
2755 while (ret
< 0 && errno
== EINTR
);
2764 int child_status
; /* unmodified platform-specific status */
2766 GIOChannel
*stdout_io
;
2767 gboolean echo_stdout
;
2768 GString
*stdout_str
;
2770 GIOChannel
*stderr_io
;
2771 gboolean echo_stderr
;
2772 GString
*stderr_str
;
2776 check_complete (WaitForChildData
*data
)
2778 if (data
->child_status
!= -1 && data
->stdout_io
== NULL
&& data
->stderr_io
== NULL
)
2779 g_main_loop_quit (data
->loop
);
2783 child_exited (GPid pid
,
2787 WaitForChildData
*data
= user_data
;
2789 g_assert (status
!= -1);
2790 data
->child_status
= status
;
2792 check_complete (data
);
2796 child_timeout (gpointer user_data
)
2798 WaitForChildData
*data
= user_data
;
2801 TerminateProcess (data
->pid
, G_TEST_STATUS_TIMED_OUT
);
2803 kill (data
->pid
, SIGALRM
);
2810 child_read (GIOChannel
*io
, GIOCondition cond
, gpointer user_data
)
2812 WaitForChildData
*data
= user_data
;
2814 gsize nread
, nwrote
, total
;
2816 FILE *echo_file
= NULL
;
2818 status
= g_io_channel_read_chars (io
, buf
, sizeof (buf
), &nread
, NULL
);
2819 if (status
== G_IO_STATUS_ERROR
|| status
== G_IO_STATUS_EOF
)
2821 // FIXME data->error = (status == G_IO_STATUS_ERROR);
2822 if (io
== data
->stdout_io
)
2823 g_clear_pointer (&data
->stdout_io
, g_io_channel_unref
);
2825 g_clear_pointer (&data
->stderr_io
, g_io_channel_unref
);
2827 check_complete (data
);
2830 else if (status
== G_IO_STATUS_AGAIN
)
2833 if (io
== data
->stdout_io
)
2835 g_string_append_len (data
->stdout_str
, buf
, nread
);
2836 if (data
->echo_stdout
)
2841 g_string_append_len (data
->stderr_str
, buf
, nread
);
2842 if (data
->echo_stderr
)
2848 for (total
= 0; total
< nread
; total
+= nwrote
)
2852 nwrote
= fwrite (buf
+ total
, 1, nread
- total
, echo_file
);
2855 g_error ("write failed: %s", g_strerror (errsv
));
2863 wait_for_child (GPid pid
,
2864 int stdout_fd
, gboolean echo_stdout
,
2865 int stderr_fd
, gboolean echo_stderr
,
2868 WaitForChildData data
;
2869 GMainContext
*context
;
2873 data
.child_status
= -1;
2875 context
= g_main_context_new ();
2876 data
.loop
= g_main_loop_new (context
, FALSE
);
2878 source
= g_child_watch_source_new (pid
);
2879 g_source_set_callback (source
, (GSourceFunc
) child_exited
, &data
, NULL
);
2880 g_source_attach (source
, context
);
2881 g_source_unref (source
);
2883 data
.echo_stdout
= echo_stdout
;
2884 data
.stdout_str
= g_string_new (NULL
);
2885 data
.stdout_io
= g_io_channel_unix_new (stdout_fd
);
2886 g_io_channel_set_close_on_unref (data
.stdout_io
, TRUE
);
2887 g_io_channel_set_encoding (data
.stdout_io
, NULL
, NULL
);
2888 g_io_channel_set_buffered (data
.stdout_io
, FALSE
);
2889 source
= g_io_create_watch (data
.stdout_io
, G_IO_IN
| G_IO_ERR
| G_IO_HUP
);
2890 g_source_set_callback (source
, (GSourceFunc
) child_read
, &data
, NULL
);
2891 g_source_attach (source
, context
);
2892 g_source_unref (source
);
2894 data
.echo_stderr
= echo_stderr
;
2895 data
.stderr_str
= g_string_new (NULL
);
2896 data
.stderr_io
= g_io_channel_unix_new (stderr_fd
);
2897 g_io_channel_set_close_on_unref (data
.stderr_io
, TRUE
);
2898 g_io_channel_set_encoding (data
.stderr_io
, NULL
, NULL
);
2899 g_io_channel_set_buffered (data
.stderr_io
, FALSE
);
2900 source
= g_io_create_watch (data
.stderr_io
, G_IO_IN
| G_IO_ERR
| G_IO_HUP
);
2901 g_source_set_callback (source
, (GSourceFunc
) child_read
, &data
, NULL
);
2902 g_source_attach (source
, context
);
2903 g_source_unref (source
);
2907 source
= g_timeout_source_new (0);
2908 g_source_set_ready_time (source
, g_get_monotonic_time () + timeout
);
2909 g_source_set_callback (source
, (GSourceFunc
) child_timeout
, &data
, NULL
);
2910 g_source_attach (source
, context
);
2911 g_source_unref (source
);
2914 g_main_loop_run (data
.loop
);
2915 g_main_loop_unref (data
.loop
);
2916 g_main_context_unref (context
);
2918 test_trap_last_pid
= pid
;
2919 test_trap_last_status
= data
.child_status
;
2920 test_trap_last_stdout
= g_string_free (data
.stdout_str
, FALSE
);
2921 test_trap_last_stderr
= g_string_free (data
.stderr_str
, FALSE
);
2923 g_clear_pointer (&data
.stdout_io
, g_io_channel_unref
);
2924 g_clear_pointer (&data
.stderr_io
, g_io_channel_unref
);
2929 * @usec_timeout: Timeout for the forked test in micro seconds.
2930 * @test_trap_flags: Flags to modify forking behaviour.
2932 * Fork the current test program to execute a test case that might
2933 * not return or that might abort.
2935 * If @usec_timeout is non-0, the forked test case is aborted and
2936 * considered failing if its run time exceeds it.
2938 * The forking behavior can be configured with the #GTestTrapFlags flags.
2940 * In the following example, the test code forks, the forked child
2941 * process produces some sample output and exits successfully.
2942 * The forking parent process then asserts successful child program
2943 * termination and validates child program outputs.
2945 * |[<!-- language="C" -->
2947 * test_fork_patterns (void)
2949 * if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
2951 * g_print ("some stdout text: somagic17\n");
2952 * g_printerr ("some stderr text: semagic43\n");
2953 * exit (0); // successful test run
2955 * g_test_trap_assert_passed ();
2956 * g_test_trap_assert_stdout ("*somagic17*");
2957 * g_test_trap_assert_stderr ("*semagic43*");
2961 * Returns: %TRUE for the forked child and %FALSE for the executing parent process.
2965 * Deprecated: This function is implemented only on Unix platforms,
2966 * and is not always reliable due to problems inherent in
2967 * fork-without-exec. Use g_test_trap_subprocess() instead.
2970 g_test_trap_fork (guint64 usec_timeout
,
2971 GTestTrapFlags test_trap_flags
)
2974 int stdout_pipe
[2] = { -1, -1 };
2975 int stderr_pipe
[2] = { -1, -1 };
2979 if (pipe (stdout_pipe
) < 0 || pipe (stderr_pipe
) < 0)
2982 g_error ("failed to create pipes to fork test program: %s", g_strerror (errsv
));
2984 test_trap_last_pid
= fork ();
2986 if (test_trap_last_pid
< 0)
2987 g_error ("failed to fork test program: %s", g_strerror (errsv
));
2988 if (test_trap_last_pid
== 0) /* child */
2991 test_in_forked_child
= TRUE
;
2992 close (stdout_pipe
[0]);
2993 close (stderr_pipe
[0]);
2994 if (!(test_trap_flags
& G_TEST_TRAP_INHERIT_STDIN
))
2996 fd0
= g_open ("/dev/null", O_RDONLY
, 0);
2998 g_error ("failed to open /dev/null for stdin redirection");
3000 if (sane_dup2 (stdout_pipe
[1], 1) < 0 || sane_dup2 (stderr_pipe
[1], 2) < 0 || (fd0
>= 0 && sane_dup2 (fd0
, 0) < 0))
3003 g_error ("failed to dup2() in forked test program: %s", g_strerror (errsv
));
3007 if (stdout_pipe
[1] >= 3)
3008 close (stdout_pipe
[1]);
3009 if (stderr_pipe
[1] >= 3)
3010 close (stderr_pipe
[1]);
3016 close (stdout_pipe
[1]);
3017 close (stderr_pipe
[1]);
3019 wait_for_child (test_trap_last_pid
,
3020 stdout_pipe
[0], !(test_trap_flags
& G_TEST_TRAP_SILENCE_STDOUT
),
3021 stderr_pipe
[0], !(test_trap_flags
& G_TEST_TRAP_SILENCE_STDERR
),
3026 g_message ("Not implemented: g_test_trap_fork");
3033 * g_test_trap_subprocess:
3034 * @test_path: (nullable): Test to run in a subprocess
3035 * @usec_timeout: Timeout for the subprocess test in micro seconds.
3036 * @test_flags: Flags to modify subprocess behaviour.
3038 * Respawns the test program to run only @test_path in a subprocess.
3039 * This can be used for a test case that might not return, or that
3042 * If @test_path is %NULL then the same test is re-run in a subprocess.
3043 * You can use g_test_subprocess() to determine whether the test is in
3044 * a subprocess or not.
3046 * @test_path can also be the name of the parent test, followed by
3047 * "`/subprocess/`" and then a name for the specific subtest (or just
3048 * ending with "`/subprocess`" if the test only has one child test);
3049 * tests with names of this form will automatically be skipped in the
3052 * If @usec_timeout is non-0, the test subprocess is aborted and
3053 * considered failing if its run time exceeds it.
3055 * The subprocess behavior can be configured with the
3056 * #GTestSubprocessFlags flags.
3058 * You can use methods such as g_test_trap_assert_passed(),
3059 * g_test_trap_assert_failed(), and g_test_trap_assert_stderr() to
3060 * check the results of the subprocess. (But note that
3061 * g_test_trap_assert_stdout() and g_test_trap_assert_stderr()
3062 * cannot be used if @test_flags specifies that the child should
3063 * inherit the parent stdout/stderr.)
3065 * If your `main ()` needs to behave differently in
3066 * the subprocess, you can call g_test_subprocess() (after calling
3067 * g_test_init()) to see whether you are in a subprocess.
3069 * The following example tests that calling
3070 * `my_object_new(1000000)` will abort with an error
3073 * |[<!-- language="C" -->
3075 * test_create_large_object (void)
3077 * if (g_test_subprocess ())
3079 * my_object_new (1000000);
3083 * // Reruns this same test in a subprocess
3084 * g_test_trap_subprocess (NULL, 0, 0);
3085 * g_test_trap_assert_failed ();
3086 * g_test_trap_assert_stderr ("*ERROR*too large*");
3090 * main (int argc, char **argv)
3092 * g_test_init (&argc, &argv, NULL);
3094 * g_test_add_func ("/myobject/create_large_object",
3095 * test_create_large_object);
3096 * return g_test_run ();
3103 g_test_trap_subprocess (const char *test_path
,
3104 guint64 usec_timeout
,
3105 GTestSubprocessFlags test_flags
)
3107 GError
*error
= NULL
;
3110 int stdout_fd
, stderr_fd
;
3113 /* Sanity check that they used GTestSubprocessFlags, not GTestTrapFlags */
3114 g_assert ((test_flags
& (G_TEST_TRAP_INHERIT_STDIN
| G_TEST_TRAP_SILENCE_STDOUT
| G_TEST_TRAP_SILENCE_STDERR
)) == 0);
3118 if (!g_test_suite_case_exists (g_test_get_root (), test_path
))
3119 g_error ("g_test_trap_subprocess: test does not exist: %s", test_path
);
3123 test_path
= test_run_name
;
3126 if (g_test_verbose ())
3127 g_print ("GTest: subprocess: %s\n", test_path
);
3130 test_trap_last_subprocess
= g_strdup (test_path
);
3132 argv
= g_ptr_array_new ();
3133 g_ptr_array_add (argv
, test_argv0
);
3134 g_ptr_array_add (argv
, "-q");
3135 g_ptr_array_add (argv
, "-p");
3136 g_ptr_array_add (argv
, (char *)test_path
);
3137 g_ptr_array_add (argv
, "--GTestSubprocess");
3138 if (test_log_fd
!= -1)
3140 char log_fd_buf
[128];
3142 g_ptr_array_add (argv
, "--GTestLogFD");
3143 g_snprintf (log_fd_buf
, sizeof (log_fd_buf
), "%d", test_log_fd
);
3144 g_ptr_array_add (argv
, log_fd_buf
);
3146 g_ptr_array_add (argv
, NULL
);
3148 flags
= G_SPAWN_DO_NOT_REAP_CHILD
;
3149 if (test_flags
& G_TEST_TRAP_INHERIT_STDIN
)
3150 flags
|= G_SPAWN_CHILD_INHERITS_STDIN
;
3152 if (!g_spawn_async_with_pipes (test_initial_cwd
,
3153 (char **)argv
->pdata
,
3156 &pid
, NULL
, &stdout_fd
, &stderr_fd
,
3159 g_error ("g_test_trap_subprocess() failed: %s",
3162 g_ptr_array_free (argv
, TRUE
);
3164 wait_for_child (pid
,
3165 stdout_fd
, !!(test_flags
& G_TEST_SUBPROCESS_INHERIT_STDOUT
),
3166 stderr_fd
, !!(test_flags
& G_TEST_SUBPROCESS_INHERIT_STDERR
),
3171 * g_test_subprocess:
3173 * Returns %TRUE (after g_test_init() has been called) if the test
3174 * program is running under g_test_trap_subprocess().
3176 * Returns: %TRUE if the test program is running under
3177 * g_test_trap_subprocess().
3182 g_test_subprocess (void)
3184 return test_in_subprocess
;
3188 * g_test_trap_has_passed:
3190 * Check the result of the last g_test_trap_subprocess() call.
3192 * Returns: %TRUE if the last test subprocess terminated successfully.
3197 g_test_trap_has_passed (void)
3200 return (WIFEXITED (test_trap_last_status
) &&
3201 WEXITSTATUS (test_trap_last_status
) == 0);
3203 return test_trap_last_status
== 0;
3208 * g_test_trap_reached_timeout:
3210 * Check the result of the last g_test_trap_subprocess() call.
3212 * Returns: %TRUE if the last test subprocess got killed due to a timeout.
3217 g_test_trap_reached_timeout (void)
3220 return (WIFSIGNALED (test_trap_last_status
) &&
3221 WTERMSIG (test_trap_last_status
) == SIGALRM
);
3223 return test_trap_last_status
== G_TEST_STATUS_TIMED_OUT
;
3228 log_child_output (const gchar
*process_id
)
3233 if (WIFEXITED (test_trap_last_status
)) /* normal exit */
3235 if (WEXITSTATUS (test_trap_last_status
) == 0)
3236 g_test_message ("child process (%s) exit status: 0 (success)",
3239 g_test_message ("child process (%s) exit status: %d (error)",
3240 process_id
, WEXITSTATUS (test_trap_last_status
));
3242 else if (WIFSIGNALED (test_trap_last_status
) &&
3243 WTERMSIG (test_trap_last_status
) == SIGALRM
)
3245 g_test_message ("child process (%s) timed out", process_id
);
3247 else if (WIFSIGNALED (test_trap_last_status
))
3249 const gchar
*maybe_dumped_core
= "";
3252 if (WCOREDUMP (test_trap_last_status
))
3253 maybe_dumped_core
= ", core dumped";
3256 g_test_message ("child process (%s) killed by signal %d (%s)%s",
3257 process_id
, WTERMSIG (test_trap_last_status
),
3258 g_strsignal (WTERMSIG (test_trap_last_status
)),
3263 g_test_message ("child process (%s) unknown wait status %d",
3264 process_id
, test_trap_last_status
);
3267 if (test_trap_last_status
== 0)
3268 g_test_message ("child process (%s) exit status: 0 (success)",
3271 g_test_message ("child process (%s) exit status: %d (error)",
3272 process_id
, test_trap_last_status
);
3275 escaped
= g_strescape (test_trap_last_stdout
, NULL
);
3276 g_test_message ("child process (%s) stdout: \"%s\"", process_id
, escaped
);
3279 escaped
= g_strescape (test_trap_last_stderr
, NULL
);
3280 g_test_message ("child process (%s) stderr: \"%s\"", process_id
, escaped
);
3283 /* so we can use short-circuiting:
3284 * logged_child_output = logged_child_output || log_child_output (...) */
3289 g_test_trap_assertions (const char *domain
,
3293 guint64 assertion_flags
, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
3294 const char *pattern
)
3296 gboolean must_pass
= assertion_flags
== 0;
3297 gboolean must_fail
= assertion_flags
== 1;
3298 gboolean match_result
= 0 == (assertion_flags
& 1);
3299 gboolean logged_child_output
= FALSE
;
3300 const char *stdout_pattern
= (assertion_flags
& 2) ? pattern
: NULL
;
3301 const char *stderr_pattern
= (assertion_flags
& 4) ? pattern
: NULL
;
3302 const char *match_error
= match_result
? "failed to match" : "contains invalid match";
3306 if (test_trap_last_subprocess
!= NULL
)
3308 process_id
= g_strdup_printf ("%s [%d]", test_trap_last_subprocess
,
3309 test_trap_last_pid
);
3311 else if (test_trap_last_pid
!= 0)
3312 process_id
= g_strdup_printf ("%d", test_trap_last_pid
);
3314 if (test_trap_last_subprocess
!= NULL
)
3315 process_id
= g_strdup (test_trap_last_subprocess
);
3318 g_error ("g_test_trap_ assertion with no trapped test");
3320 if (must_pass
&& !g_test_trap_has_passed())
3324 logged_child_output
= logged_child_output
|| log_child_output (process_id
);
3326 msg
= g_strdup_printf ("child process (%s) failed unexpectedly", process_id
);
3327 g_assertion_message (domain
, file
, line
, func
, msg
);
3330 if (must_fail
&& g_test_trap_has_passed())
3334 logged_child_output
= logged_child_output
|| log_child_output (process_id
);
3336 msg
= g_strdup_printf ("child process (%s) did not fail as expected", process_id
);
3337 g_assertion_message (domain
, file
, line
, func
, msg
);
3340 if (stdout_pattern
&& match_result
== !g_pattern_match_simple (stdout_pattern
, test_trap_last_stdout
))
3344 logged_child_output
= logged_child_output
|| log_child_output (process_id
);
3346 msg
= g_strdup_printf ("stdout of child process (%s) %s: %s", process_id
, match_error
, stdout_pattern
);
3347 g_assertion_message (domain
, file
, line
, func
, msg
);
3350 if (stderr_pattern
&& match_result
== !g_pattern_match_simple (stderr_pattern
, test_trap_last_stderr
))
3354 logged_child_output
= logged_child_output
|| log_child_output (process_id
);
3356 msg
= g_strdup_printf ("stderr of child process (%s) %s: %s", process_id
, match_error
, stderr_pattern
);
3357 g_assertion_message (domain
, file
, line
, func
, msg
);
3360 g_free (process_id
);
3364 gstring_overwrite_int (GString
*gstring
,
3368 vuint
= g_htonl (vuint
);
3369 g_string_overwrite_len (gstring
, pos
, (const gchar
*) &vuint
, 4);
3373 gstring_append_int (GString
*gstring
,
3376 vuint
= g_htonl (vuint
);
3377 g_string_append_len (gstring
, (const gchar
*) &vuint
, 4);
3381 gstring_append_double (GString
*gstring
,
3384 union { double vdouble
; guint64 vuint64
; } u
;
3385 u
.vdouble
= vdouble
;
3386 u
.vuint64
= GUINT64_TO_BE (u
.vuint64
);
3387 g_string_append_len (gstring
, (const gchar
*) &u
.vuint64
, 8);
3391 g_test_log_dump (GTestLogMsg
*msg
,
3394 GString
*gstring
= g_string_sized_new (1024);
3396 gstring_append_int (gstring
, 0); /* message length */
3397 gstring_append_int (gstring
, msg
->log_type
);
3398 gstring_append_int (gstring
, msg
->n_strings
);
3399 gstring_append_int (gstring
, msg
->n_nums
);
3400 gstring_append_int (gstring
, 0); /* reserved */
3401 for (ui
= 0; ui
< msg
->n_strings
; ui
++)
3403 guint l
= strlen (msg
->strings
[ui
]);
3404 gstring_append_int (gstring
, l
);
3405 g_string_append_len (gstring
, msg
->strings
[ui
], l
);
3407 for (ui
= 0; ui
< msg
->n_nums
; ui
++)
3408 gstring_append_double (gstring
, msg
->nums
[ui
]);
3409 *len
= gstring
->len
;
3410 gstring_overwrite_int (gstring
, 0, *len
); /* message length */
3411 return (guint8
*) g_string_free (gstring
, FALSE
);
3414 static inline long double
3415 net_double (const gchar
**ipointer
)
3417 union { guint64 vuint64
; double vdouble
; } u
;
3418 guint64 aligned_int64
;
3419 memcpy (&aligned_int64
, *ipointer
, 8);
3421 u
.vuint64
= GUINT64_FROM_BE (aligned_int64
);
3425 static inline guint32
3426 net_int (const gchar
**ipointer
)
3428 guint32 aligned_int
;
3429 memcpy (&aligned_int
, *ipointer
, 4);
3431 return g_ntohl (aligned_int
);
3435 g_test_log_extract (GTestLogBuffer
*tbuffer
)
3437 const gchar
*p
= tbuffer
->data
->str
;
3440 if (tbuffer
->data
->len
< 4 * 5)
3442 mlength
= net_int (&p
);
3443 if (tbuffer
->data
->len
< mlength
)
3445 msg
.log_type
= net_int (&p
);
3446 msg
.n_strings
= net_int (&p
);
3447 msg
.n_nums
= net_int (&p
);
3448 if (net_int (&p
) == 0)
3451 msg
.strings
= g_new0 (gchar
*, msg
.n_strings
+ 1);
3452 msg
.nums
= g_new0 (long double, msg
.n_nums
);
3453 for (ui
= 0; ui
< msg
.n_strings
; ui
++)
3455 guint sl
= net_int (&p
);
3456 msg
.strings
[ui
] = g_strndup (p
, sl
);
3459 for (ui
= 0; ui
< msg
.n_nums
; ui
++)
3460 msg
.nums
[ui
] = net_double (&p
);
3461 if (p
<= tbuffer
->data
->str
+ mlength
)
3463 g_string_erase (tbuffer
->data
, 0, mlength
);
3464 tbuffer
->msgs
= g_slist_prepend (tbuffer
->msgs
, g_memdup (&msg
, sizeof (msg
)));
3469 g_strfreev (msg
.strings
);
3472 g_error ("corrupt log stream from test program");
3477 * g_test_log_buffer_new:
3479 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
3482 g_test_log_buffer_new (void)
3484 GTestLogBuffer
*tb
= g_new0 (GTestLogBuffer
, 1);
3485 tb
->data
= g_string_sized_new (1024);
3490 * g_test_log_buffer_free:
3492 * Internal function for gtester to free test log messages, no ABI guarantees provided.
3495 g_test_log_buffer_free (GTestLogBuffer
*tbuffer
)
3497 g_return_if_fail (tbuffer
!= NULL
);
3498 while (tbuffer
->msgs
)
3499 g_test_log_msg_free (g_test_log_buffer_pop (tbuffer
));
3500 g_string_free (tbuffer
->data
, TRUE
);
3505 * g_test_log_buffer_push:
3507 * Internal function for gtester to decode test log messages, no ABI guarantees provided.
3510 g_test_log_buffer_push (GTestLogBuffer
*tbuffer
,
3512 const guint8
*bytes
)
3514 g_return_if_fail (tbuffer
!= NULL
);
3517 gboolean more_messages
;
3518 g_return_if_fail (bytes
!= NULL
);
3519 g_string_append_len (tbuffer
->data
, (const gchar
*) bytes
, n_bytes
);
3521 more_messages
= g_test_log_extract (tbuffer
);
3522 while (more_messages
);
3527 * g_test_log_buffer_pop:
3529 * Internal function for gtester to retrieve test log messages, no ABI guarantees provided.
3532 g_test_log_buffer_pop (GTestLogBuffer
*tbuffer
)
3534 GTestLogMsg
*msg
= NULL
;
3535 g_return_val_if_fail (tbuffer
!= NULL
, NULL
);
3538 GSList
*slist
= g_slist_last (tbuffer
->msgs
);
3540 tbuffer
->msgs
= g_slist_delete_link (tbuffer
->msgs
, slist
);
3546 * g_test_log_msg_free:
3548 * Internal function for gtester to free test log messages, no ABI guarantees provided.
3551 g_test_log_msg_free (GTestLogMsg
*tmsg
)
3553 g_return_if_fail (tmsg
!= NULL
);
3554 g_strfreev (tmsg
->strings
);
3555 g_free (tmsg
->nums
);
3560 g_test_build_filename_va (GTestFileType file_type
,
3561 const gchar
*first_path
,
3564 const gchar
*pathv
[16];
3565 gint num_path_segments
;
3567 if (file_type
== G_TEST_DIST
)
3568 pathv
[0] = test_disted_files_dir
;
3569 else if (file_type
== G_TEST_BUILT
)
3570 pathv
[0] = test_built_files_dir
;
3572 g_assert_not_reached ();
3574 pathv
[1] = first_path
;
3576 for (num_path_segments
= 2; num_path_segments
< G_N_ELEMENTS (pathv
); num_path_segments
++)
3578 pathv
[num_path_segments
] = va_arg (ap
, const char *);
3579 if (pathv
[num_path_segments
] == NULL
)
3583 g_assert_cmpint (num_path_segments
, <, G_N_ELEMENTS (pathv
));
3585 return g_build_filenamev ((gchar
**) pathv
);
3589 * g_test_build_filename:
3590 * @file_type: the type of file (built vs. distributed)
3591 * @first_path: the first segment of the pathname
3592 * @...: %NULL-terminated additional path segments
3594 * Creates the pathname to a data file that is required for a test.
3596 * This function is conceptually similar to g_build_filename() except
3597 * that the first argument has been replaced with a #GTestFileType
3600 * The data file should either have been distributed with the module
3601 * containing the test (%G_TEST_DIST) or built as part of the build
3602 * system of that module (%G_TEST_BUILT).
3604 * In order for this function to work in srcdir != builddir situations,
3605 * the G_TEST_SRCDIR and G_TEST_BUILDDIR environment variables need to
3606 * have been defined. As of 2.38, this is done by the glib.mk
3607 * included in GLib. Please ensure that your copy is up to date before
3608 * using this function.
3610 * In case neither variable is set, this function will fall back to
3611 * using the dirname portion of argv[0], possibly removing ".libs".
3612 * This allows for casual running of tests directly from the commandline
3613 * in the srcdir == builddir case and should also support running of
3614 * installed tests, assuming the data files have been installed in the
3615 * same relative path as the test binary.
3617 * Returns: the path of the file, to be freed using g_free()
3623 * @G_TEST_DIST: a file that was included in the distribution tarball
3624 * @G_TEST_BUILT: a file that was built on the compiling machine
3626 * The type of file to return the filename for, when used with
3627 * g_test_build_filename().
3629 * These two options correspond rather directly to the 'dist' and
3630 * 'built' terminology that automake uses and are explicitly used to
3631 * distinguish between the 'srcdir' and 'builddir' being separate. All
3632 * files in your project should either be dist (in the
3633 * `EXTRA_DIST` or `dist_schema_DATA`
3634 * sense, in which case they will always be in the srcdir) or built (in
3635 * the `BUILT_SOURCES` sense, in which case they will
3636 * always be in the builddir).
3638 * Note: as a general rule of automake, files that are generated only as
3639 * part of the build-from-git process (but then are distributed with the
3640 * tarball) always go in srcdir (even if doing a srcdir != builddir
3641 * build from git) and are considered as distributed files.
3646 g_test_build_filename (GTestFileType file_type
,
3647 const gchar
*first_path
,
3653 g_assert (g_test_initialized ());
3655 va_start (ap
, first_path
);
3656 result
= g_test_build_filename_va (file_type
, first_path
, ap
);
3664 * @file_type: the type of file (built vs. distributed)
3666 * Gets the pathname of the directory containing test files of the type
3667 * specified by @file_type.
3669 * This is approximately the same as calling g_test_build_filename("."),
3670 * but you don't need to free the return value.
3672 * Returns: (type filename): the path of the directory, owned by GLib
3677 g_test_get_dir (GTestFileType file_type
)
3679 g_assert (g_test_initialized ());
3681 if (file_type
== G_TEST_DIST
)
3682 return test_disted_files_dir
;
3683 else if (file_type
== G_TEST_BUILT
)
3684 return test_built_files_dir
;
3686 g_assert_not_reached ();
3690 * g_test_get_filename:
3691 * @file_type: the type of file (built vs. distributed)
3692 * @first_path: the first segment of the pathname
3693 * @...: %NULL-terminated additional path segments
3695 * Gets the pathname to a data file that is required for a test.
3697 * This is the same as g_test_build_filename() with two differences.
3698 * The first difference is that must only use this function from within
3699 * a testcase function. The second difference is that you need not free
3700 * the return value -- it will be automatically freed when the testcase
3703 * It is safe to use this function from a thread inside of a testcase
3704 * but you must ensure that all such uses occur before the main testcase
3705 * function returns (ie: it is best to ensure that all threads have been
3708 * Returns: the path, automatically freed at the end of the testcase
3713 g_test_get_filename (GTestFileType file_type
,
3714 const gchar
*first_path
,
3721 g_assert (g_test_initialized ());
3722 if (test_filename_free_list
== NULL
)
3723 g_error ("g_test_get_filename() can only be used within testcase functions");
3725 va_start (ap
, first_path
);
3726 result
= g_test_build_filename_va (file_type
, first_path
, ap
);
3729 node
= g_slist_prepend (NULL
, result
);
3731 node
->next
= *test_filename_free_list
;
3732 while (!g_atomic_pointer_compare_and_exchange (test_filename_free_list
, node
->next
, node
));
3737 /* --- macros docs START --- */
3740 * @testpath: The test path for a new test case.
3741 * @Fixture: The type of a fixture data structure.
3742 * @tdata: Data argument for the test functions.
3743 * @fsetup: The function to set up the fixture data.
3744 * @ftest: The actual test function.
3745 * @fteardown: The function to tear down the fixture data.
3747 * Hook up a new test case at @testpath, similar to g_test_add_func().
3748 * A fixture data structure with setup and teardown functions may be provided,
3749 * similar to g_test_create_case().
3751 * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
3752 * fteardown() callbacks can expect a @Fixture pointer as their first argument
3753 * in a type safe manner. They otherwise have type #GTestFixtureFunc.
3757 /* --- macros docs END --- */