1 /* GLib testing utilities
2 * Copyright (C) 2007 Imendio AB
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
20 #ifndef __G_TEST_UTILS_H__
21 #define __G_TEST_UTILS_H__
27 typedef struct GTestCase GTestCase;
28 typedef struct GTestSuite GTestSuite;
31 #define g_assert_cmpstr(s1, cmp, s2) do { const char *__s1 = (s1), *__s2 = (s2); \
32 if (g_strcmp0 (__s1, __s2) cmp 0) ; else \
33 g_assertion_message_cmpstr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
34 #s1 " " #cmp " " #s2, __s1, #cmp, __s2); } while (0)
35 #define g_assert_cmpint(n1, cmp, n2) do { gint64 __n1 = (n1), __n2 = (n2); \
36 if (__n1 cmp __n2) ; else \
37 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
38 #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'i'); } while (0)
39 #define g_assert_cmpuint(n1, cmp, n2) do { guint64 __n1 = (n1), __n2 = (n2); \
40 if (__n1 cmp __n2) ; else \
41 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
42 #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'i'); } while (0)
43 #define g_assert_cmphex(n1, cmp, n2) do { guint64 __n1 = (n1), __n2 = (n2); \
44 if (__n1 cmp __n2) ; else \
45 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
46 #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'x'); } while (0)
47 #define g_assert_cmpfloat(n1,cmp,n2) do { long double __n1 = (n1), __n2 = (n2); \
48 if (__n1 cmp __n2) ; else \
49 g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
50 #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'f'); } while (0)
51 int g_strcmp0 (const char *str1,
53 // g_assert(condition) /*...*/
54 // g_assert_not_reached() /*...*/
56 /* report performance results */
57 void g_test_minimized_result (double minimized_quantity,
59 ...) G_GNUC_PRINTF (2, 3);
60 void g_test_maximized_result (double maximized_quantity,
62 ...) G_GNUC_PRINTF (2, 3);
64 /* initialize testing framework */
65 void g_test_init (int *argc,
68 /* query testing framework config */
69 #define g_test_quick() (g_test_config_vars->test_quick)
70 #define g_test_slow() (!g_test_config_vars->test_quick)
71 #define g_test_perf() (g_test_config_vars->test_perf)
72 #define g_test_verbose() (g_test_config_vars->test_verbose)
73 #define g_test_quiet() (g_test_config_vars->test_quiet)
74 /* run all tests under toplevel suite (path: /) */
75 int g_test_run (void);
76 /* hook up a test functions under test path */
77 void g_test_add_func (const char *testpath,
78 void (*test_func) (void));
79 void g_test_add_data_func (const char *testpath,
80 gconstpointer test_data,
81 void (*test_func) (gconstpointer));
82 /* hook up a test with fixture under test path */
83 #define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
84 ((void (*) (const char*, \
87 void (*) (Fixture*, gconstpointer), \
88 void (*) (Fixture*, gconstpointer), \
89 void (*) (Fixture*, gconstpointer))) \
90 (void*) g_test_add_vtable) \
91 (testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown)
92 /* add test messages to the test report */
93 void g_test_message (const char *format,
94 ...) G_GNUC_PRINTF (1, 2);
95 void g_test_bug_base (const char *uri_pattern);
96 void g_test_bug (const char *bug_uri_snippet);
97 /* measure test timings */
98 void g_test_timer_start (void);
99 double g_test_timer_elapsed (void); // elapsed seconds
100 double g_test_timer_last (void); // repeat last elapsed() result
102 /* automatically g_free or g_object_unref upon teardown */
103 void g_test_queue_free (gpointer gfree_pointer);
104 void g_test_queue_destroy (GDestroyNotify destroy_func,
105 gpointer destroy_data);
106 #define g_test_queue_unref(gobject) g_test_queue_destroy (g_object_unref, gobject)
108 /* test traps are guards used around forked tests */
110 G_TEST_TRAP_SILENCE_STDOUT = 1 << 7,
111 G_TEST_TRAP_SILENCE_STDERR = 1 << 8,
112 G_TEST_TRAP_INHERIT_STDIN = 1 << 9,
114 gboolean g_test_trap_fork (guint64 usec_timeout,
115 GTestTrapFlags test_trap_flags);
116 gboolean g_test_trap_has_passed (void);
117 gboolean g_test_trap_reached_timeout (void);
118 #define g_test_trap_assert_passed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 1, 0, 0, 0)
119 #define g_test_trap_assert_failed() g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 1, 0, 0)
120 #define g_test_trap_assert_stdout(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0, soutpattern, 0)
121 #define g_test_trap_assert_stderr(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0, 0, serrpattern)
123 /* provide seed-able random numbers for tests */
124 #define g_test_rand_bit() (0 != (g_test_rand_int() & (1 << 15)))
125 gint32 g_test_rand_int (void);
126 gint32 g_test_rand_int_range (gint32 begin,
128 double g_test_rand_double (void);
129 double g_test_rand_double_range (double range_start,
132 /* semi-internal API */
133 GTestCase* g_test_create_case (const char *test_name,
135 gconstpointer test_data,
136 void (*data_setup) (void),
137 void (*data_test) (void),
138 void (*data_teardown) (void));
139 GTestSuite* g_test_create_suite (const char *suite_name);
140 GTestSuite* g_test_get_root (void);
141 void g_test_suite_add (GTestSuite *suite,
142 GTestCase *test_case);
143 void g_test_suite_add_suite (GTestSuite *suite,
144 GTestSuite *nestedsuite);
145 int g_test_run_suite (GTestSuite *suite);
148 void g_test_trap_assertions (const char *domain,
154 const char *stdout_pattern,
155 const char *stderr_pattern);
156 void g_assertion_message (const char *domain,
160 const char *message);
161 void g_assertion_message_expr (const char *domain,
166 void g_assertion_message_cmpstr (const char *domain,
174 void g_assertion_message_cmpnum (const char *domain,
183 void g_test_add_vtable (const char *testpath,
185 gconstpointer test_data,
186 void (*data_setup) (void),
187 void (*data_test) (void),
188 void (*data_teardown) (void));
190 gboolean test_initialized;
191 gboolean test_quick; /* disable thorough tests */
192 gboolean test_perf; /* run performance tests */
193 gboolean test_verbose; /* extra info */
194 gboolean test_quiet; /* reduce output */
196 GLIB_VAR const GTestConfig * const g_test_config_vars;
198 /* internal logging API */
201 G_TEST_LOG_ERROR, // s:msg
202 G_TEST_LOG_START_BINARY, // s:binaryname s:seed
203 G_TEST_LOG_LIST_CASE, // s:testpath
204 G_TEST_LOG_SKIP_CASE, // s:testpath
205 G_TEST_LOG_START_CASE, // s:testpath
206 G_TEST_LOG_STOP_CASE, // d:status d:nforks d:elapsed
207 G_TEST_LOG_MIN_RESULT, // s:blurb d:result
208 G_TEST_LOG_MAX_RESULT, // s:blurb d:result
209 G_TEST_LOG_MESSAGE, // s:blurb
213 GTestLogType log_type;
215 gchar **strings; // NULL terminated
225 const char* g_test_log_type_name (GTestLogType log_type);
226 GTestLogBuffer* g_test_log_buffer_new (void);
227 void g_test_log_buffer_free (GTestLogBuffer *tbuffer);
228 void g_test_log_buffer_push (GTestLogBuffer *tbuffer,
230 const guint8 *bytes);
231 GTestLogMsg* g_test_log_buffer_pop (GTestLogBuffer *tbuffer);
232 void g_test_log_msg_free (GTestLogMsg *tmsg);
236 #endif /* __G_TEST_UTILS_H__ */