Merge remote branch 'gvdb/master'
[platform/upstream/glib.git] / glib / gtestutils.h
1 /* GLib testing utilities
2  * Copyright (C) 2007 Imendio AB
3  * Authors: Tim Janik
4  *
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.
9  *
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.
14  *
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.
19  */
20
21 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
22 #error "Only <glib.h> can be included directly."
23 #endif
24
25 #ifndef __G_TEST_UTILS_H__
26 #define __G_TEST_UTILS_H__
27
28 #include <glib/gmessages.h>
29 #include <glib/gstring.h>
30 #include <glib/gtypes.h>
31 #include <glib/gerror.h>
32 #include <glib/gslist.h>
33
34 G_BEGIN_DECLS
35
36 typedef struct GTestCase  GTestCase;
37 typedef struct GTestSuite GTestSuite;
38
39 /* assertion API */
40 #define g_assert_cmpstr(s1, cmp, s2)    do { const char *__s1 = (s1), *__s2 = (s2); \
41                                              if (g_strcmp0 (__s1, __s2) cmp 0) ; else \
42                                                g_assertion_message_cmpstr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
43                                                  #s1 " " #cmp " " #s2, __s1, #cmp, __s2); } while (0)
44 #define g_assert_cmpint(n1, cmp, n2)    do { gint64 __n1 = (n1), __n2 = (n2); \
45                                              if (__n1 cmp __n2) ; else \
46                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
47                                                  #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'i'); } while (0)
48 #define g_assert_cmpuint(n1, cmp, n2)   do { guint64 __n1 = (n1), __n2 = (n2); \
49                                              if (__n1 cmp __n2) ; else \
50                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
51                                                  #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'i'); } while (0)
52 #define g_assert_cmphex(n1, cmp, n2)    do { guint64 __n1 = (n1), __n2 = (n2); \
53                                              if (__n1 cmp __n2) ; else \
54                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
55                                                  #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'x'); } while (0)
56 #define g_assert_cmpfloat(n1,cmp,n2)    do { long double __n1 = (n1), __n2 = (n2); \
57                                              if (__n1 cmp __n2) ; else \
58                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
59                                                  #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'f'); } while (0)
60 #define g_assert_no_error(err)          do { if (err) \
61                                                g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
62                                                  #err, err, 0, 0); } while (0)
63 #define g_assert_error(err, dom, c)     do { if (!err || (err)->domain != dom || (err)->code != c) \
64                                                g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
65                                                  #err, err, dom, c); } while (0)
66 #ifdef G_DISABLE_ASSERT
67 #define g_assert_not_reached()          do { (void) 0; } while (0)
68 #define g_assert(expr)                  do { (void) 0; } while (0)
69 #else /* !G_DISABLE_ASSERT */
70 #define g_assert_not_reached()          do { g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); } while (0)
71 #define g_assert(expr)                  do { if G_LIKELY (expr) ; else \
72                                                g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
73                                                  #expr); } while (0)
74 #endif /* !G_DISABLE_ASSERT */
75
76 int     g_strcmp0                       (const char     *str1,
77                                          const char     *str2);
78
79 /* report performance results */
80 void    g_test_minimized_result         (double          minimized_quantity,
81                                          const char     *format,
82                                          ...) G_GNUC_PRINTF (2, 3);
83 void    g_test_maximized_result         (double          maximized_quantity,
84                                          const char     *format,
85                                          ...) G_GNUC_PRINTF (2, 3);
86
87 /* initialize testing framework */
88 void    g_test_init                     (int            *argc,
89                                          char         ***argv,
90                                          ...);
91 /* query testing framework config */
92 #define g_test_quick()                  (g_test_config_vars->test_quick)
93 #define g_test_slow()                   (!g_test_config_vars->test_quick)
94 #define g_test_thorough()               (!g_test_config_vars->test_quick)
95 #define g_test_perf()                   (g_test_config_vars->test_perf)
96 #define g_test_verbose()                (g_test_config_vars->test_verbose)
97 #define g_test_quiet()                  (g_test_config_vars->test_quiet)
98 /* run all tests under toplevel suite (path: /) */
99 int     g_test_run                      (void);
100 /* hook up a test functions under test path */
101 void    g_test_add_func                 (const char     *testpath,
102                                          void          (*test_func) (void));
103 void    g_test_add_data_func            (const char     *testpath,
104                                          gconstpointer   test_data,
105                                          void          (*test_func) (gconstpointer));
106 /* hook up a test with fixture under test path */
107 #define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
108                                         G_STMT_START {                  \
109                                          void (*add_vtable) (const char*,       \
110                                                     gsize,             \
111                                                     gconstpointer,     \
112                                                     void (*) (Fixture*, gconstpointer),   \
113                                                     void (*) (Fixture*, gconstpointer),   \
114                                                     void (*) (Fixture*, gconstpointer)) =  (void (*) (const gchar *, gsize, gconstpointer, void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer))) g_test_add_vtable; \
115                                          add_vtable \
116                                           (testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown); \
117                                         } G_STMT_END
118
119 /* add test messages to the test report */
120 void    g_test_message                  (const char *format,
121                                          ...) G_GNUC_PRINTF (1, 2);
122 void    g_test_bug_base                 (const char *uri_pattern);
123 void    g_test_bug                      (const char *bug_uri_snippet);
124 /* measure test timings */
125 void    g_test_timer_start              (void);
126 double  g_test_timer_elapsed            (void); /* elapsed seconds */
127 double  g_test_timer_last               (void); /* repeat last elapsed() result */
128
129 /* automatically g_free or g_object_unref upon teardown */
130 void    g_test_queue_free               (gpointer gfree_pointer);
131 void    g_test_queue_destroy            (GDestroyNotify destroy_func,
132                                          gpointer       destroy_data);
133 #define g_test_queue_unref(gobject)     g_test_queue_destroy (g_object_unref, gobject)
134
135 /* test traps are guards used around forked tests */
136 typedef enum {
137   G_TEST_TRAP_SILENCE_STDOUT    = 1 << 7,
138   G_TEST_TRAP_SILENCE_STDERR    = 1 << 8,
139   G_TEST_TRAP_INHERIT_STDIN     = 1 << 9
140 } GTestTrapFlags;
141 gboolean g_test_trap_fork               (guint64              usec_timeout,
142                                          GTestTrapFlags       test_trap_flags);
143 gboolean g_test_trap_has_passed         (void);
144 gboolean g_test_trap_reached_timeout    (void);
145 #define  g_test_trap_assert_passed()                      g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0)
146 #define  g_test_trap_assert_failed()                      g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 1, 0)
147 #define  g_test_trap_assert_stdout(soutpattern)           g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 2, soutpattern)
148 #define  g_test_trap_assert_stdout_unmatched(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 3, soutpattern)
149 #define  g_test_trap_assert_stderr(serrpattern)           g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 4, serrpattern)
150 #define  g_test_trap_assert_stderr_unmatched(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 5, serrpattern)
151
152 /* provide seed-able random numbers for tests */
153 #define  g_test_rand_bit()              (0 != (g_test_rand_int() & (1 << 15)))
154 gint32   g_test_rand_int                (void);
155 gint32   g_test_rand_int_range          (gint32          begin,
156                                          gint32          end);
157 double   g_test_rand_double             (void);
158 double   g_test_rand_double_range       (double          range_start,
159                                          double          range_end);
160
161 /* semi-internal API */
162 GTestCase*    g_test_create_case        (const char     *test_name,
163                                          gsize           data_size,
164                                          gconstpointer   test_data,
165                                          void          (*data_setup) (void),
166                                          void          (*data_test) (void),
167                                          void          (*data_teardown) (void));
168 GTestSuite*   g_test_create_suite       (const char     *suite_name);
169 GTestSuite*   g_test_get_root           (void);
170 void          g_test_suite_add          (GTestSuite     *suite,
171                                          GTestCase      *test_case);
172 void          g_test_suite_add_suite    (GTestSuite     *suite,
173                                          GTestSuite     *nestedsuite);
174 int           g_test_run_suite          (GTestSuite     *suite);
175
176 /* internal ABI */
177 void    g_test_trap_assertions          (const char     *domain,
178                                          const char     *file,
179                                          int             line,
180                                          const char     *func,
181                                          guint64         assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
182                                          const char     *pattern);
183 void    g_assertion_message             (const char     *domain,
184                                          const char     *file,
185                                          int             line,
186                                          const char     *func,
187                                          const char     *message) G_GNUC_NORETURN;
188 void    g_assertion_message_expr        (const char     *domain,
189                                          const char     *file,
190                                          int             line,
191                                          const char     *func,
192                                          const char     *expr) G_GNUC_NORETURN;
193 void    g_assertion_message_cmpstr      (const char     *domain,
194                                          const char     *file,
195                                          int             line,
196                                          const char     *func,
197                                          const char     *expr,
198                                          const char     *arg1,
199                                          const char     *cmp,
200                                          const char     *arg2) G_GNUC_NORETURN;
201 void    g_assertion_message_cmpnum      (const char     *domain,
202                                          const char     *file,
203                                          int             line,
204                                          const char     *func,
205                                          const char     *expr,
206                                          long double     arg1,
207                                          const char     *cmp,
208                                          long double     arg2,
209                                          char            numtype) G_GNUC_NORETURN;
210 void    g_assertion_message_error       (const char     *domain,
211                                          const char     *file,
212                                          int             line,
213                                          const char     *func,
214                                          const char     *expr,
215                                          GError         *error,
216                                          GQuark          error_domain,
217                                          int             error_code) G_GNUC_NORETURN;
218 void    g_test_add_vtable               (const char     *testpath,
219                                          gsize           data_size,
220                                          gconstpointer   test_data,
221                                          void          (*data_setup)    (void),
222                                          void          (*data_test)     (void),
223                                          void          (*data_teardown) (void));
224 typedef struct {
225   gboolean      test_initialized;
226   gboolean      test_quick;     /* disable thorough tests */
227   gboolean      test_perf;      /* run performance tests */
228   gboolean      test_verbose;   /* extra info */
229   gboolean      test_quiet;     /* reduce output */
230 } GTestConfig;
231 GLIB_VAR const GTestConfig * const g_test_config_vars;
232
233 /* internal logging API */
234 typedef enum {
235   G_TEST_LOG_NONE,
236   G_TEST_LOG_ERROR,             /* s:msg */
237   G_TEST_LOG_START_BINARY,      /* s:binaryname s:seed */
238   G_TEST_LOG_LIST_CASE,         /* s:testpath */
239   G_TEST_LOG_SKIP_CASE,         /* s:testpath */
240   G_TEST_LOG_START_CASE,        /* s:testpath */
241   G_TEST_LOG_STOP_CASE,         /* d:status d:nforks d:elapsed */
242   G_TEST_LOG_MIN_RESULT,        /* s:blurb d:result */
243   G_TEST_LOG_MAX_RESULT,        /* s:blurb d:result */
244   G_TEST_LOG_MESSAGE            /* s:blurb */
245 } GTestLogType;
246
247 typedef struct {
248   GTestLogType  log_type;
249   guint         n_strings;
250   gchar       **strings; /* NULL terminated */
251   guint         n_nums;
252   long double  *nums;
253 } GTestLogMsg;
254 typedef struct {
255   /*< private >*/
256   GString     *data;
257   GSList      *msgs;
258 } GTestLogBuffer;
259
260 const char*     g_test_log_type_name    (GTestLogType    log_type);
261 GTestLogBuffer* g_test_log_buffer_new   (void);
262 void            g_test_log_buffer_free  (GTestLogBuffer *tbuffer);
263 void            g_test_log_buffer_push  (GTestLogBuffer *tbuffer,
264                                          guint           n_bytes,
265                                          const guint8   *bytes);
266 GTestLogMsg*    g_test_log_buffer_pop   (GTestLogBuffer *tbuffer);
267 void            g_test_log_msg_free     (GTestLogMsg    *tmsg);
268
269 /**
270  * GTestLogFatalFunc:
271  * @log_domain: the log domain of the message
272  * @log_level: the log level of the message (including the fatal and recursion flags)
273  * @message: the message to process
274  * @user_data: user data, set in g_test_log_set_fatal_handler()
275  *
276  * Specifies the prototype of fatal log handler functions.
277  *
278  * Return value: %TRUE if the program should abort, %FALSE otherwise
279  *
280  * Since: 2.22
281  */
282 typedef gboolean        (*GTestLogFatalFunc)    (const gchar    *log_domain,
283                                                  GLogLevelFlags  log_level,
284                                                  const gchar    *message,
285                                                  gpointer        user_data);
286 void
287 g_test_log_set_fatal_handler            (GTestLogFatalFunc log_func,
288                                          gpointer          user_data);
289
290 G_END_DECLS
291
292 #endif /* __G_TEST_UTILS_H__ */