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 #ifndef __G_TEST_UTILS_H__
  22 #define __G_TEST_UTILS_H__
  23
  24 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  25 #error "Only <glib.h> can be included directly."
  26 #endif
  27
  28 #include <glib/gmessages.h>
  29 #include <glib/gstring.h>
  30 #include <glib/gerror.h>
  31 #include <glib/gslist.h>
  32
  33 G_BEGIN_DECLS
  34
  35 typedef struct GTestCase  GTestCase;
  36 typedef struct GTestSuite GTestSuite;
  37 typedef void (*GTestFunc)        (void);
  38 typedef void (*GTestDataFunc)    (gconstpointer user_data);
  39 typedef void (*GTestFixtureFunc) (gpointer      fixture,
  40                                   gconstpointer user_data);
  41
  42 /* assertion API */
  43 #define g_assert_cmpstr(s1, cmp, s2)    do { const char *__s1 = (s1), *__s2 = (s2); \
  44                                              if (g_strcmp0 (__s1, __s2) cmp 0) ; else \
  45                                                g_assertion_message_cmpstr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  46                                                  #s1 " " #cmp " " #s2, __s1, #cmp, __s2); } while (0)
  47 #define g_assert_cmpint(n1, cmp, n2)    do { gint64 __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, 'i'); } while (0)
  51 #define g_assert_cmpuint(n1, cmp, n2)   do { guint64 __n1 = (n1), __n2 = (n2); \
  52                                              if (__n1 cmp __n2) ; else \
  53                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  54                                                  #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'i'); } while (0)
  55 #define g_assert_cmphex(n1, cmp, n2)    do { guint64 __n1 = (n1), __n2 = (n2); \
  56                                              if (__n1 cmp __n2) ; else \
  57                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  58                                                  #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'x'); } while (0)
  59 #define g_assert_cmpfloat(n1,cmp,n2)    do { long double __n1 = (n1), __n2 = (n2); \
  60                                              if (__n1 cmp __n2) ; else \
  61                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  62                                                  #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'f'); } while (0)
  63 #define g_assert_no_error(err)          do { if (err) \
  64                                                g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  65                                                  #err, err, 0, 0); } while (0)
  66 #define g_assert_error(err, dom, c)     do { if (!err || (err)->domain != dom || (err)->code != c) \
  67                                                g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  68                                                  #err, err, dom, c); } while (0)
  69 #define g_assert_true(expr)             do { if G_LIKELY (expr) ; else \
  70                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  71                                                                     #expr); \
  72                                            } while (0)
  73 #define g_assert_false(expr)            do { if G_LIKELY (!(expr)) ; else \
  74                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  75                                                                     #expr); \
  76                                            } while (0)
  77 #define g_assert_null(expr)              do { if G_LIKELY ((expr) == NULL) ; else \
  78                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  79                                                                     #expr); \
  80                                            } while (0)
  81 #ifdef G_DISABLE_ASSERT
  82 #define g_assert_not_reached()          do { (void) 0; } while (0)
  83 #define g_assert(expr)                  do { (void) 0; } while (0)
  84 #else /* !G_DISABLE_ASSERT */
  85 #define g_assert_not_reached()          do { g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); } while (0)
  86 #define g_assert(expr)                  do { if G_LIKELY (expr) ; else \
  87                                                g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  88                                                                          #expr); \
  89                                            } while (0)
  90 #endif /* !G_DISABLE_ASSERT */
  91
  92 GLIB_AVAILABLE_IN_ALL
  93 int     g_strcmp0                       (const char     *str1,
  94                                          const char     *str2);
  95
  96 /* report performance results */
  97 GLIB_AVAILABLE_IN_ALL
  98 void    g_test_minimized_result         (double          minimized_quantity,
  99                                          const char     *format,
 100                                          ...) G_GNUC_PRINTF (2, 3);
 101 GLIB_AVAILABLE_IN_ALL
 102 void    g_test_maximized_result         (double          maximized_quantity,
 103                                          const char     *format,
 104                                          ...) G_GNUC_PRINTF (2, 3);
 105
 106 /* initialize testing framework */
 107 GLIB_AVAILABLE_IN_ALL
 108 void    g_test_init                     (int            *argc,
 109                                          char         ***argv,
 110                                          ...);
 111 /* query testing framework config */
 112 #define g_test_initialized()            (g_test_config_vars->test_initialized)
 113 #define g_test_quick()                  (g_test_config_vars->test_quick)
 114 #define g_test_slow()                   (!g_test_config_vars->test_quick)
 115 #define g_test_thorough()               (!g_test_config_vars->test_quick)
 116 #define g_test_perf()                   (g_test_config_vars->test_perf)
 117 #define g_test_verbose()                (g_test_config_vars->test_verbose)
 118 #define g_test_quiet()                  (g_test_config_vars->test_quiet)
 119 #define g_test_undefined()              (g_test_config_vars->test_undefined)
 120 GLIB_AVAILABLE_IN_2_38
 121 gboolean g_test_subprocess (void);
 122
 123 /* run all tests under toplevel suite (path: /) */
 124 GLIB_AVAILABLE_IN_ALL
 125 int     g_test_run                      (void);
 126 /* hook up a test functions under test path */
 127 GLIB_AVAILABLE_IN_ALL
 128 void    g_test_add_func                 (const char     *testpath,
 129                                          GTestFunc       test_func);
 130
 131 GLIB_AVAILABLE_IN_ALL
 132 void    g_test_add_data_func            (const char     *testpath,
 133                                          gconstpointer   test_data,
 134                                          GTestDataFunc   test_func);
 135
 136 GLIB_AVAILABLE_IN_2_34
 137 void    g_test_add_data_func_full       (const char     *testpath,
 138                                          gpointer        test_data,
 139                                          GTestDataFunc   test_func,
 140                                          GDestroyNotify  data_free_func);
 141
 142 /* tell about failure */
 143 GLIB_AVAILABLE_IN_2_30
 144 void    g_test_fail                     (void);
 145 GLIB_AVAILABLE_IN_2_38
 146 void    g_test_incomplete               (const gchar *msg);
 147 GLIB_AVAILABLE_IN_2_38
 148 void    g_test_skip                     (const gchar *msg);
 149 GLIB_AVAILABLE_IN_2_38
 150 gboolean g_test_failed                  (void);
 151
 152 /* hook up a test with fixture under test path */
 153 #define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
 154                                         G_STMT_START {                  \
 155                                          void (*add_vtable) (const char*,       \
 156                                                     gsize,             \
 157                                                     gconstpointer,     \
 158                                                     void (*) (Fixture*, gconstpointer),   \
 159                                                     void (*) (Fixture*, gconstpointer),   \
 160                                                     void (*) (Fixture*, gconstpointer)) =  (void (*) (const gchar *, gsize, gconstpointer, void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer))) g_test_add_vtable; \
 161                                          add_vtable \
 162                                           (testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown); \
 163                                         } G_STMT_END
 164
 165 /* add test messages to the test report */
 166 GLIB_AVAILABLE_IN_ALL
 167 void    g_test_message                  (const char *format,
 168                                          ...) G_GNUC_PRINTF (1, 2);
 169 GLIB_AVAILABLE_IN_ALL
 170 void    g_test_bug_base                 (const char *uri_pattern);
 171 GLIB_AVAILABLE_IN_ALL
 172 void    g_test_bug                      (const char *bug_uri_snippet);
 173 /* measure test timings */
 174 GLIB_AVAILABLE_IN_ALL
 175 void    g_test_timer_start              (void);
 176 GLIB_AVAILABLE_IN_ALL
 177 double  g_test_timer_elapsed            (void); /* elapsed seconds */
 178 GLIB_AVAILABLE_IN_ALL
 179 double  g_test_timer_last               (void); /* repeat last elapsed() result */
 180
 181 /* automatically g_free or g_object_unref upon teardown */
 182 GLIB_AVAILABLE_IN_ALL
 183 void    g_test_queue_free               (gpointer gfree_pointer);
 184 GLIB_AVAILABLE_IN_ALL
 185 void    g_test_queue_destroy            (GDestroyNotify destroy_func,
 186                                          gpointer       destroy_data);
 187 #define g_test_queue_unref(gobject)     g_test_queue_destroy (g_object_unref, gobject)
 188
 189 typedef enum {
 190   G_TEST_TRAP_SILENCE_STDOUT    = 1 << 7,
 191   G_TEST_TRAP_SILENCE_STDERR    = 1 << 8,
 192   G_TEST_TRAP_INHERIT_STDIN     = 1 << 9
 193 } GTestTrapFlags;
 194
 195 GLIB_DEPRECATED_IN_2_38_FOR (g_test_trap_subprocess)
 196 gboolean g_test_trap_fork               (guint64              usec_timeout,
 197                                          GTestTrapFlags       test_trap_flags);
 198
 199 typedef enum {
 200   G_TEST_SUBPROCESS_INHERIT_STDIN  = 1 << 0,
 201   G_TEST_SUBPROCESS_INHERIT_STDOUT = 1 << 1,
 202   G_TEST_SUBPROCESS_INHERIT_STDERR = 1 << 2
 203 } GTestSubprocessFlags;
 204
 205 GLIB_AVAILABLE_IN_2_38
 206 void     g_test_trap_subprocess         (const char           *test_path,
 207                                          guint64               usec_timeout,
 208                                          GTestSubprocessFlags  test_flags);
 209
 210 GLIB_AVAILABLE_IN_ALL
 211 gboolean g_test_trap_has_passed         (void);
 212 GLIB_AVAILABLE_IN_ALL
 213 gboolean g_test_trap_reached_timeout    (void);
 214 #define  g_test_trap_assert_passed()                      g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0)
 215 #define  g_test_trap_assert_failed()                      g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 1, 0)
 216 #define  g_test_trap_assert_stdout(soutpattern)           g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 2, soutpattern)
 217 #define  g_test_trap_assert_stdout_unmatched(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 3, soutpattern)
 218 #define  g_test_trap_assert_stderr(serrpattern)           g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 4, serrpattern)
 219 #define  g_test_trap_assert_stderr_unmatched(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 5, serrpattern)
 220
 221 /* provide seed-able random numbers for tests */
 222 #define  g_test_rand_bit()              (0 != (g_test_rand_int() & (1 << 15)))
 223 GLIB_AVAILABLE_IN_ALL
 224 gint32   g_test_rand_int                (void);
 225 GLIB_AVAILABLE_IN_ALL
 226 gint32   g_test_rand_int_range          (gint32          begin,
 227                                          gint32          end);
 228 GLIB_AVAILABLE_IN_ALL
 229 double   g_test_rand_double             (void);
 230 GLIB_AVAILABLE_IN_ALL
 231 double   g_test_rand_double_range       (double          range_start,
 232                                          double          range_end);
 233
 234 /* semi-internal API */
 235 GLIB_AVAILABLE_IN_ALL
 236 GTestCase*    g_test_create_case        (const char       *test_name,
 237                                          gsize             data_size,
 238                                          gconstpointer     test_data,
 239                                          GTestFixtureFunc  data_setup,
 240                                          GTestFixtureFunc  data_test,
 241                                          GTestFixtureFunc  data_teardown);
 242 GLIB_AVAILABLE_IN_ALL
 243 GTestSuite*   g_test_create_suite       (const char       *suite_name);
 244 GLIB_AVAILABLE_IN_ALL
 245 GTestSuite*   g_test_get_root           (void);
 246 GLIB_AVAILABLE_IN_ALL
 247 void          g_test_suite_add          (GTestSuite     *suite,
 248                                          GTestCase      *test_case);
 249 GLIB_AVAILABLE_IN_ALL
 250 void          g_test_suite_add_suite    (GTestSuite     *suite,
 251                                          GTestSuite     *nestedsuite);
 252 GLIB_AVAILABLE_IN_ALL
 253 int           g_test_run_suite          (GTestSuite     *suite);
 254
 255 /* internal ABI */
 256 GLIB_AVAILABLE_IN_ALL
 257 void    g_test_trap_assertions          (const char     *domain,
 258                                          const char     *file,
 259                                          int             line,
 260                                          const char     *func,
 261                                          guint64         assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
 262                                          const char     *pattern);
 263 GLIB_AVAILABLE_IN_ALL
 264 void    g_assertion_message             (const char     *domain,
 265                                          const char     *file,
 266                                          int             line,
 267                                          const char     *func,
 268                                          const char     *message) G_GNUC_NORETURN;
 269 GLIB_AVAILABLE_IN_ALL
 270 void    g_assertion_message_expr        (const char     *domain,
 271                                          const char     *file,
 272                                          int             line,
 273                                          const char     *func,
 274                                          const char     *expr) G_GNUC_NORETURN;
 275 GLIB_AVAILABLE_IN_ALL
 276 void    g_assertion_message_cmpstr      (const char     *domain,
 277                                          const char     *file,
 278                                          int             line,
 279                                          const char     *func,
 280                                          const char     *expr,
 281                                          const char     *arg1,
 282                                          const char     *cmp,
 283                                          const char     *arg2) G_GNUC_NORETURN;
 284 GLIB_AVAILABLE_IN_ALL
 285 void    g_assertion_message_cmpnum      (const char     *domain,
 286                                          const char     *file,
 287                                          int             line,
 288                                          const char     *func,
 289                                          const char     *expr,
 290                                          long double     arg1,
 291                                          const char     *cmp,
 292                                          long double     arg2,
 293                                          char            numtype) G_GNUC_NORETURN;
 294 GLIB_AVAILABLE_IN_ALL
 295 void    g_assertion_message_error       (const char     *domain,
 296                                          const char     *file,
 297                                          int             line,
 298                                          const char     *func,
 299                                          const char     *expr,
 300                                          const GError   *error,
 301                                          GQuark          error_domain,
 302                                          int             error_code) G_GNUC_NORETURN;
 303 GLIB_AVAILABLE_IN_ALL
 304 void    g_test_add_vtable               (const char     *testpath,
 305                                          gsize           data_size,
 306                                          gconstpointer   test_data,
 307                                          GTestFixtureFunc  data_setup,
 308                                          GTestFixtureFunc  data_test,
 309                                          GTestFixtureFunc  data_teardown);
 310 typedef struct {
 311   gboolean      test_initialized;
 312   gboolean      test_quick;     /* disable thorough tests */
 313   gboolean      test_perf;      /* run performance tests */
 314   gboolean      test_verbose;   /* extra info */
 315   gboolean      test_quiet;     /* reduce output */
 316   gboolean      test_undefined; /* run tests that are meant to assert */
 317 } GTestConfig;
 318 GLIB_VAR const GTestConfig * const g_test_config_vars;
 319
 320 /* internal logging API */
 321 typedef enum {
 322   G_TEST_LOG_NONE,
 323   G_TEST_LOG_ERROR,             /* s:msg */
 324   G_TEST_LOG_START_BINARY,      /* s:binaryname s:seed */
 325   G_TEST_LOG_LIST_CASE,         /* s:testpath */
 326   G_TEST_LOG_SKIP_CASE,         /* s:testpath */
 327   G_TEST_LOG_START_CASE,        /* s:testpath */
 328   G_TEST_LOG_STOP_CASE,         /* d:status d:nforks d:elapsed */
 329   G_TEST_LOG_MIN_RESULT,        /* s:blurb d:result */
 330   G_TEST_LOG_MAX_RESULT,        /* s:blurb d:result */
 331   G_TEST_LOG_MESSAGE,           /* s:blurb */
 332   G_TEST_LOG_START_SUITE,
 333   G_TEST_LOG_STOP_SUITE
 334 } GTestLogType;
 335
 336 typedef struct {
 337   GTestLogType  log_type;
 338   guint         n_strings;
 339   gchar       **strings; /* NULL terminated */
 340   guint         n_nums;
 341   long double  *nums;
 342 } GTestLogMsg;
 343 typedef struct {
 344   /*< private >*/
 345   GString     *data;
 346   GSList      *msgs;
 347 } GTestLogBuffer;
 348
 349 GLIB_AVAILABLE_IN_ALL
 350 const char*     g_test_log_type_name    (GTestLogType    log_type);
 351 GLIB_AVAILABLE_IN_ALL
 352 GTestLogBuffer* g_test_log_buffer_new   (void);
 353 GLIB_AVAILABLE_IN_ALL
 354 void            g_test_log_buffer_free  (GTestLogBuffer *tbuffer);
 355 GLIB_AVAILABLE_IN_ALL
 356 void            g_test_log_buffer_push  (GTestLogBuffer *tbuffer,
 357                                          guint           n_bytes,
 358                                          const guint8   *bytes);
 359 GLIB_AVAILABLE_IN_ALL
 360 GTestLogMsg*    g_test_log_buffer_pop   (GTestLogBuffer *tbuffer);
 361 GLIB_AVAILABLE_IN_ALL
 362 void            g_test_log_msg_free     (GTestLogMsg    *tmsg);
 363
 364 /**
 365  * GTestLogFatalFunc:
 366  * @log_domain: the log domain of the message
 367  * @log_level: the log level of the message (including the fatal and recursion flags)
 368  * @message: the message to process
 369  * @user_data: user data, set in g_test_log_set_fatal_handler()
 370  *
 371  * Specifies the prototype of fatal log handler functions.
 372  *
 373  * Return value: %TRUE if the program should abort, %FALSE otherwise
 374  *
 375  * Since: 2.22
 376  */
 377 typedef gboolean        (*GTestLogFatalFunc)    (const gchar    *log_domain,
 378                                                  GLogLevelFlags  log_level,
 379                                                  const gchar    *message,
 380                                                  gpointer        user_data);
 381 GLIB_AVAILABLE_IN_ALL
 382 void
 383 g_test_log_set_fatal_handler            (GTestLogFatalFunc log_func,
 384                                          gpointer          user_data);
 385
 386 GLIB_AVAILABLE_IN_2_34
 387 void    g_test_expect_message                    (const gchar    *log_domain,
 388                                                   GLogLevelFlags  log_level,
 389                                                   const gchar    *pattern);
 390 GLIB_AVAILABLE_IN_2_34
 391 void    g_test_assert_expected_messages_internal (const char     *domain,
 392                                                   const char     *file,
 393                                                   int             line,
 394                                                   const char     *func);
 395
 396 typedef enum
 397 {
 398   G_TEST_DIST,
 399   G_TEST_BUILT
 400 } GTestFileType;
 401
 402 GLIB_AVAILABLE_IN_2_38
 403 gchar * g_test_build_filename                    (GTestFileType   file_type,
 404                                                   const gchar    *first_path,
 405                                                   ...) G_GNUC_NULL_TERMINATED;
 406 GLIB_AVAILABLE_IN_2_38
 407 const gchar *g_test_get_dir                      (GTestFileType   file_type);
 408 GLIB_AVAILABLE_IN_2_38
 409 const gchar *g_test_get_filename                 (GTestFileType   file_type,
 410                                                   const gchar    *first_path,
 411                                                   ...) G_GNUC_NULL_TERMINATED;
 412
 413 #define g_test_assert_expected_messages() g_test_assert_expected_messages_internal (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC)
 414
 415 G_END_DECLS
 416
 417 #endif /* __G_TEST_UTILS_H__ */