glib/gtestutils.h

   1 /* GLib testing utilities
   2  * Copyright (C) 2007 Imendio AB
   3  * Authors: Tim Janik
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  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 #include <errno.h>
  33 #include <stdlib.h>
  34 #include <string.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct GTestCase  GTestCase;
  39 typedef struct GTestSuite GTestSuite;
  40 typedef void (*GTestFunc)        (void);
  41 typedef void (*GTestDataFunc)    (gconstpointer user_data);
  42 typedef void (*GTestFixtureFunc) (gpointer      fixture,
  43                                   gconstpointer user_data);
  44
  45 /* assertion API */
  46 #define g_assert_cmpstr(s1, cmp, s2)    G_STMT_START { \
  47                                              const char *__s1 = (s1), *__s2 = (s2); \
  48                                              if (g_strcmp0 (__s1, __s2) cmp 0) ; else \
  49                                                g_assertion_message_cmpstr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  50                                                  #s1 " " #cmp " " #s2, __s1, #cmp, __s2); \
  51                                         } G_STMT_END
  52 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_78
  53 #define g_assert_cmpint(n1, cmp, n2)    G_STMT_START { \
  54                                              gint64 __n1 = (n1), __n2 = (n2); \
  55                                              if (__n1 cmp __n2) ; else \
  56                                                g_assertion_message_cmpint (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  57                                                  #n1 " " #cmp " " #n2, (guint64)__n1, #cmp, (guint64)__n2, 'i'); \
  58                                         } G_STMT_END
  59 #define g_assert_cmpuint(n1, cmp, n2)   G_STMT_START { \
  60                                              guint64 __n1 = (n1), __n2 = (n2); \
  61                                              if (__n1 cmp __n2) ; else \
  62                                                g_assertion_message_cmpint (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  63                                                  #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'u'); \
  64                                         } G_STMT_END
  65 #define g_assert_cmphex(n1, cmp, n2)    G_STMT_START { \
  66                                              guint64 __n1 = (n1), __n2 = (n2); \
  67                                              if (__n1 cmp __n2) ; else \
  68                                                g_assertion_message_cmpint (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  69                                                  #n1 " " #cmp " " #n2, __n1, #cmp, __n2, 'x'); \
  70                                         } G_STMT_END
  71 #else /* GLIB_VERSION_MIN_REQUIRED < GLIB_VERSION_2_78 */
  72 #define g_assert_cmpint(n1, cmp, n2)    G_STMT_START { \
  73                                              gint64 __n1 = (n1), __n2 = (n2); \
  74                                              if (__n1 cmp __n2) ; else \
  75                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  76                                                  #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'i'); \
  77                                         } G_STMT_END
  78 #define g_assert_cmpuint(n1, cmp, n2)   G_STMT_START { \
  79                                              guint64 __n1 = (n1), __n2 = (n2); \
  80                                              if (__n1 cmp __n2) ; else \
  81                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  82                                                  #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'i'); \
  83                                         } G_STMT_END
  84 #define g_assert_cmphex(n1, cmp, n2)    G_STMT_START {\
  85                                              guint64 __n1 = (n1), __n2 = (n2); \
  86                                              if (__n1 cmp __n2) ; else \
  87                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  88                                                  #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'x'); \
  89                                         } G_STMT_END
  90 #endif /* GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_78 */
  91 #define g_assert_cmpfloat(n1,cmp,n2)    G_STMT_START { \
  92                                              long double __n1 = (long double) (n1), __n2 = (long double) (n2); \
  93                                              if (__n1 cmp __n2) ; else \
  94                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  95                                                  #n1 " " #cmp " " #n2, (long double) __n1, #cmp, (long double) __n2, 'f'); \
  96                                         } G_STMT_END
  97 #define g_assert_cmpfloat_with_epsilon(n1,n2,epsilon) \
  98                                         G_STMT_START { \
  99                                              double __n1 = (n1), __n2 = (n2), __epsilon = (epsilon); \
 100                                              if (G_APPROX_VALUE (__n1,  __n2, __epsilon)) ; else \
 101                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 102                                                  #n1 " == " #n2 " (+/- " #epsilon ")", __n1, "==", __n2, 'f'); \
 103                                         } G_STMT_END
 104 #if GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_78
 105 #define g_assert_cmpmem(m1, l1, m2, l2) G_STMT_START {\
 106                                              gconstpointer __m1 = m1, __m2 = m2; \
 107                                              size_t __l1 = (size_t) l1, __l2 = (size_t) l2; \
 108                                              if (__l1 != 0 && __m1 == NULL) \
 109                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 110                                                                     "assertion failed (" #l1 " == 0 || " #m1 " != NULL)"); \
 111                                              else if (__l2 != 0 && __m2 == NULL) \
 112                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 113                                                                     "assertion failed (" #l2 " == 0 || " #m2 " != NULL)"); \
 114                                              else if (__l1 != __l2) \
 115                                                g_assertion_message_cmpint (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 116                                                                            #l1 " (len(" #m1 ")) == " #l2 " (len(" #m2 "))", \
 117                                                                            __l1, "==", __l2, 'u'); \
 118                                              else if (__l1 != 0 && __m2 != NULL && memcmp (__m1, __m2, __l1) != 0) \
 119                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 120                                                                     "assertion failed (" #m1 " == " #m2 ")"); \
 121                                         } G_STMT_END
 122 #else /* GLIB_VERSION_MIN_REQUIRED < GLIB_VERSION_2_78 */
 123 #define g_assert_cmpmem(m1, l1, m2, l2) G_STMT_START {\
 124                                              gconstpointer __m1 = m1, __m2 = m2; \
 125                                              size_t __l1 = (size_t) l1, __l2 = (size_t) l2; \
 126                                              if (__l1 != 0 && __m1 == NULL) \
 127                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 128                                                                     "assertion failed (" #l1 " == 0 || " #m1 " != NULL)"); \
 129                                              else if (__l2 != 0 && __m2 == NULL) \
 130                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 131                                                                     "assertion failed (" #l2 " == 0 || " #m2 " != NULL)"); \
 132                                              else if (__l1 != __l2) \
 133                                                g_assertion_message_cmpnum (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 134                                                                            #l1 " (len(" #m1 ")) == " #l2 " (len(" #m2 "))", \
 135                                                                            (long double) __l1, "==", (long double) __l2, 'i'); \
 136                                              else if (__l1 != 0 && __m2 != NULL && memcmp (__m1, __m2, __l1) != 0) \
 137                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 138                                                                     "assertion failed (" #m1 " == " #m2 ")"); \
 139                                         } G_STMT_END
 140 #endif /* GLIB_VERSION_MIN_REQUIRED >= GLIB_VERSION_2_78 */
 141 #define g_assert_cmpvariant(v1, v2) \
 142   G_STMT_START \
 143   { \
 144     GVariant *__v1 = (v1), *__v2 = (v2); \
 145     if (!g_variant_equal (__v1, __v2)) \
 146       { \
 147         gchar *__s1, *__s2, *__msg; \
 148         __s1 = g_variant_print (__v1, TRUE); \
 149         __s2 = g_variant_print (__v2, TRUE); \
 150         __msg = g_strdup_printf ("assertion failed (" #v1 " == " #v2 "): %s does not equal %s", __s1, __s2); \
 151         g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, __msg); \
 152         g_free (__s1); \
 153         g_free (__s2); \
 154         g_free (__msg); \
 155       } \
 156   } \
 157   G_STMT_END
 158 #define g_assert_cmpstrv(strv1, strv2) \
 159   G_STMT_START \
 160   { \
 161     const char * const *__strv1 = (const char * const *) (strv1); \
 162     const char * const *__strv2 = (const char * const *) (strv2); \
 163     if (!__strv1 || !__strv2) \
 164       { \
 165         if (__strv1) \
 166           { \
 167             g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 168                                  "assertion failed (" #strv1 " == " #strv2 "): " #strv2 " is NULL, but " #strv1 " is not"); \
 169           } \
 170         else if (__strv2) \
 171           { \
 172             g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 173                                  "assertion failed (" #strv1 " == " #strv2 "): " #strv1 " is NULL, but " #strv2 " is not"); \
 174           } \
 175       } \
 176     else \
 177       { \
 178         guint __l1 = g_strv_length ((char **) __strv1); \
 179         guint __l2 = g_strv_length ((char **) __strv2); \
 180         if (__l1 != __l2) \
 181           { \
 182             char *__msg; \
 183             __msg = g_strdup_printf ("assertion failed (" #strv1 " == " #strv2 "): length %u does not equal length %u", __l1, __l2); \
 184             g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, __msg); \
 185             g_free (__msg); \
 186           } \
 187         else \
 188           { \
 189             guint __i; \
 190             for (__i = 0; __i < __l1; __i++) \
 191               { \
 192                 if (g_strcmp0 (__strv1[__i], __strv2[__i]) != 0) \
 193                   { \
 194                     g_assertion_message_cmpstrv (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 195                                                  #strv1 " == " #strv2, \
 196                                                  __strv1, __strv2, __i); \
 197                   } \
 198               } \
 199           } \
 200       } \
 201   } \
 202   G_STMT_END
 203 #define g_assert_no_errno(expr)         G_STMT_START { \
 204                                              int __ret, __errsv; \
 205                                              errno = 0; \
 206                                              __ret = expr; \
 207                                              __errsv = errno; \
 208                                              if (__ret < 0) \
 209                                                { \
 210                                                  gchar *__msg; \
 211                                                  __msg = g_strdup_printf ("assertion failed (" #expr " >= 0): errno %i: %s", __errsv, g_strerror (__errsv)); \
 212                                                  g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, __msg); \
 213                                                  g_free (__msg); \
 214                                                } \
 215                                         } G_STMT_END \
 216                                         GLIB_AVAILABLE_MACRO_IN_2_66
 217 #define g_assert_no_error(err)          G_STMT_START { \
 218                                              if (err) \
 219                                                g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 220                                                  #err, err, 0, 0); \
 221                                         } G_STMT_END
 222 #define g_assert_error(err, dom, c)     G_STMT_START { \
 223                                                if (!err || (err)->domain != dom || (err)->code != c) \
 224                                                g_assertion_message_error (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 225                                                  #err, err, dom, c); \
 226                                         } G_STMT_END
 227 #define g_assert_true(expr)             G_STMT_START { \
 228                                              if G_LIKELY (expr) ; else \
 229                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 230                                                                     "'" #expr "' should be TRUE"); \
 231                                         } G_STMT_END
 232 #define g_assert_false(expr)            G_STMT_START { \
 233                                              if G_LIKELY (!(expr)) ; else \
 234                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 235                                                                     "'" #expr "' should be FALSE"); \
 236                                         } G_STMT_END
 237
 238 /* Use nullptr in C++ to catch misuse of these macros. */
 239 #if G_CXX_STD_CHECK_VERSION (11)
 240 #define g_assert_null(expr)             G_STMT_START { if G_LIKELY ((expr) == nullptr) ; else \
 241                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 242                                                                     "'" #expr "' should be nullptr"); \
 243                                         } G_STMT_END
 244 #define g_assert_nonnull(expr)          G_STMT_START { \
 245                                              if G_LIKELY ((expr) != nullptr) ; else \
 246                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 247                                                                     "'" #expr "' should not be nullptr"); \
 248                                         } G_STMT_END
 249 #else /* not C++ */
 250 #define g_assert_null(expr)             G_STMT_START { if G_LIKELY ((expr) == NULL) ; else \
 251                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 252                                                                     "'" #expr "' should be NULL"); \
 253                                         } G_STMT_END
 254 #define g_assert_nonnull(expr)          G_STMT_START { \
 255                                              if G_LIKELY ((expr) != NULL) ; else \
 256                                                g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 257                                                                     "'" #expr "' should not be NULL"); \
 258                                         } G_STMT_END
 259 #endif
 260
 261 #ifdef G_DISABLE_ASSERT
 262 /* https://gcc.gnu.org/onlinedocs/gcc-8.3.0/gcc/Other-Builtins.html#index-_005f_005fbuiltin_005funreachable
 263  * GCC 5 is not a strict lower bound for versions of GCC which provide __builtin_unreachable(). */
 264 #if __GNUC__ >= 5 || g_macro__has_builtin(__builtin_unreachable)
 265 #define g_assert_not_reached()          G_STMT_START { (void) 0; __builtin_unreachable (); } G_STMT_END
 266 #elif defined (_MSC_VER)
 267 #define g_assert_not_reached()          G_STMT_START { (void) 0; __assume (0); } G_STMT_END
 268 #else  /* if __builtin_unreachable() is not supported: */
 269 #define g_assert_not_reached()          G_STMT_START { (void) 0; } G_STMT_END
 270 #endif
 271
 272 #define g_assert(expr)                  G_STMT_START { (void) 0; } G_STMT_END
 273 #else /* !G_DISABLE_ASSERT */
 274 #define g_assert_not_reached()          G_STMT_START { g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); } G_STMT_END
 275 #define g_assert(expr)                  G_STMT_START { \
 276                                              if G_LIKELY (expr) ; else \
 277                                                g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
 278                                                                          #expr); \
 279                                         } G_STMT_END
 280 #endif /* !G_DISABLE_ASSERT */
 281
 282 GLIB_AVAILABLE_IN_ALL
 283 int     g_strcmp0                       (const char     *str1,
 284                                          const char     *str2);
 285
 286 /* report performance results */
 287 GLIB_AVAILABLE_IN_ALL
 288 void    g_test_minimized_result         (double          minimized_quantity,
 289                                          const char     *format,
 290                                          ...) G_GNUC_PRINTF (2, 3);
 291 GLIB_AVAILABLE_IN_ALL
 292 void    g_test_maximized_result         (double          maximized_quantity,
 293                                          const char     *format,
 294                                          ...) G_GNUC_PRINTF (2, 3);
 295
 296 /* initialize testing framework */
 297 GLIB_AVAILABLE_IN_ALL
 298 void    g_test_init                     (int            *argc,
 299                                          char         ***argv,
 300                                          ...) G_GNUC_NULL_TERMINATED;
 301
 302 /**
 303  * G_TEST_OPTION_ISOLATE_DIRS:
 304  *
 305  * Creates a unique temporary directory for each unit test and uses
 306  * g_set_user_dirs() to set XDG directories to point into subdirectories of it
 307  * for the duration of the unit test. The directory tree is cleaned up after the
 308  * test finishes successfully. Note that this doesn’t take effect until
 309  * g_test_run() is called, so calls to (for example) g_get_user_home_dir() will
 310  * return the system-wide value when made in a test program’s main() function.
 311  *
 312  * The following functions will return subdirectories of the temporary directory
 313  * when this option is used. The specific subdirectory paths in use are not
 314  * guaranteed to be stable API — always use a getter function to retrieve them.
 315  *
 316  *  - g_get_home_dir()
 317  *  - g_get_user_cache_dir()
 318  *  - g_get_system_config_dirs()
 319  *  - g_get_user_config_dir()
 320  *  - g_get_system_data_dirs()
 321  *  - g_get_user_data_dir()
 322  *  - g_get_user_state_dir()
 323  *  - g_get_user_runtime_dir()
 324  *
 325  * The subdirectories may not be created by the test harness; as with normal
 326  * calls to functions like g_get_user_cache_dir(), the caller must be prepared
 327  * to create the directory if it doesn’t exist.
 328  *
 329  * Since: 2.60
 330  */
 331 #define G_TEST_OPTION_ISOLATE_DIRS "isolate_dirs"
 332
 333 /* While we discourage its use, g_assert() is often used in unit tests
 334  * (especially in legacy code). g_assert_*() should really be used instead.
 335  * g_assert() can be disabled at client program compile time, which can render
 336  * tests useless. Highlight that to the user. */
 337 #ifdef G_DISABLE_ASSERT
 338 #if defined(G_HAVE_ISO_VARARGS)
 339 #define g_test_init(argc, argv, ...) \
 340   G_STMT_START { \
 341     g_printerr ("Tests were compiled with G_DISABLE_ASSERT and are likely no-ops. Aborting.\n"); \
 342     exit (1); \
 343   } G_STMT_END
 344 #elif defined(G_HAVE_GNUC_VARARGS)
 345 #define g_test_init(argc, argv...) \
 346   G_STMT_START { \
 347     g_printerr ("Tests were compiled with G_DISABLE_ASSERT and are likely no-ops. Aborting.\n"); \
 348     exit (1); \
 349   } G_STMT_END
 350 #else  /* no varargs */
 351   /* do nothing */
 352 #endif  /* varargs support */
 353 #endif  /* G_DISABLE_ASSERT */
 354
 355 /* query testing framework config */
 356 #define g_test_initialized()            (g_test_config_vars->test_initialized)
 357 #define g_test_quick()                  (g_test_config_vars->test_quick)
 358 #define g_test_slow()                   (!g_test_config_vars->test_quick)
 359 #define g_test_thorough()               (!g_test_config_vars->test_quick)
 360 #define g_test_perf()                   (g_test_config_vars->test_perf)
 361 #define g_test_verbose()                (g_test_config_vars->test_verbose)
 362 #define g_test_quiet()                  (g_test_config_vars->test_quiet)
 363 #define g_test_undefined()              (g_test_config_vars->test_undefined)
 364 GLIB_AVAILABLE_IN_2_38
 365 gboolean g_test_subprocess (void);
 366
 367 /* run all tests under toplevel suite (path: /) */
 368 GLIB_AVAILABLE_IN_ALL
 369 int     g_test_run                      (void);
 370 /* hook up a test functions under test path */
 371 GLIB_AVAILABLE_IN_ALL
 372 void    g_test_add_func                 (const char     *testpath,
 373                                          GTestFunc       test_func);
 374
 375 GLIB_AVAILABLE_IN_ALL
 376 void    g_test_add_data_func            (const char     *testpath,
 377                                          gconstpointer   test_data,
 378                                          GTestDataFunc   test_func);
 379
 380 GLIB_AVAILABLE_IN_2_34
 381 void    g_test_add_data_func_full       (const char     *testpath,
 382                                          gpointer        test_data,
 383                                          GTestDataFunc   test_func,
 384                                          GDestroyNotify  data_free_func);
 385
 386 /* tell about currently run test */
 387 GLIB_AVAILABLE_IN_2_68
 388 const char * g_test_get_path            (void);
 389
 390 /* tell about failure */
 391 GLIB_AVAILABLE_IN_2_30
 392 void    g_test_fail                     (void);
 393 GLIB_AVAILABLE_IN_2_70
 394 void    g_test_fail_printf              (const char *format,
 395                                          ...) G_GNUC_PRINTF (1, 2);
 396 GLIB_AVAILABLE_IN_2_38
 397 void    g_test_incomplete               (const gchar *msg);
 398 GLIB_AVAILABLE_IN_2_70
 399 void    g_test_incomplete_printf        (const char *format,
 400                                          ...) G_GNUC_PRINTF (1, 2);
 401 GLIB_AVAILABLE_IN_2_38
 402 void    g_test_skip                     (const gchar *msg);
 403 GLIB_AVAILABLE_IN_2_70
 404 void    g_test_skip_printf              (const char *format,
 405                                          ...) G_GNUC_PRINTF (1, 2);
 406 GLIB_AVAILABLE_IN_2_38
 407 gboolean g_test_failed                  (void);
 408 GLIB_AVAILABLE_IN_2_38
 409 void    g_test_set_nonfatal_assertions  (void);
 410 GLIB_AVAILABLE_IN_2_78
 411 void    g_test_disable_crash_reporting  (void);
 412
 413 /**
 414  * g_test_add:
 415  * @testpath:  The test path for a new test case.
 416  * @Fixture:   The type of a fixture data structure.
 417  * @tdata:     Data argument for the test functions.
 418  * @fsetup:    The function to set up the fixture data.
 419  * @ftest:     The actual test function.
 420  * @fteardown: The function to tear down the fixture data.
 421  *
 422  * Hook up a new test case at @testpath, similar to g_test_add_func().
 423  * A fixture data structure with setup and teardown functions may be provided,
 424  * similar to g_test_create_case().
 425  *
 426  * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
 427  * fteardown() callbacks can expect a @Fixture pointer as their first argument
 428  * in a type safe manner. They otherwise have type #GTestFixtureFunc.
 429  *
 430  * Since: 2.16
 431  */
 432 #define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
 433                                         G_STMT_START {                  \
 434                                          void (*add_vtable) (const char*,       \
 435                                                     gsize,             \
 436                                                     gconstpointer,     \
 437                                                     void (*) (Fixture*, gconstpointer),   \
 438                                                     void (*) (Fixture*, gconstpointer),   \
 439                                                     void (*) (Fixture*, gconstpointer)) =  (void (*) (const gchar *, gsize, gconstpointer, void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer), void (*) (Fixture*, gconstpointer))) g_test_add_vtable; \
 440                                          add_vtable \
 441                                           (testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown); \
 442                                         } G_STMT_END
 443
 444 /* add test messages to the test report */
 445 GLIB_AVAILABLE_IN_ALL
 446 void    g_test_message                  (const char *format,
 447                                          ...) G_GNUC_PRINTF (1, 2);
 448 GLIB_AVAILABLE_IN_ALL
 449 void    g_test_bug_base                 (const char *uri_pattern);
 450 GLIB_AVAILABLE_IN_ALL
 451 void    g_test_bug                      (const char *bug_uri_snippet);
 452 GLIB_AVAILABLE_IN_2_62
 453 void    g_test_summary                  (const char *summary);
 454 /* measure test timings */
 455 GLIB_AVAILABLE_IN_ALL
 456 void    g_test_timer_start              (void);
 457 GLIB_AVAILABLE_IN_ALL
 458 double  g_test_timer_elapsed            (void); /* elapsed seconds */
 459 GLIB_AVAILABLE_IN_ALL
 460 double  g_test_timer_last               (void); /* repeat last elapsed() result */
 461
 462 /* automatically g_free or g_object_unref upon teardown */
 463 GLIB_AVAILABLE_IN_ALL
 464 void    g_test_queue_free               (gpointer gfree_pointer);
 465 GLIB_AVAILABLE_IN_ALL
 466 void    g_test_queue_destroy            (GDestroyNotify destroy_func,
 467                                          gpointer       destroy_data);
 468 #define g_test_queue_unref(gobject)     g_test_queue_destroy (g_object_unref, gobject)
 469
 470 /**
 471  * GTestTrapFlags:
 472  * @G_TEST_TRAP_DEFAULT: Default behaviour. Since: 2.74
 473  * @G_TEST_TRAP_SILENCE_STDOUT: Redirect stdout of the test child to
 474  *     `/dev/null` so it cannot be observed on the console during test
 475  *     runs. The actual output is still captured though to allow later
 476  *     tests with g_test_trap_assert_stdout().
 477  * @G_TEST_TRAP_SILENCE_STDERR: Redirect stderr of the test child to
 478  *     `/dev/null` so it cannot be observed on the console during test
 479  *     runs. The actual output is still captured though to allow later
 480  *     tests with g_test_trap_assert_stderr().
 481  * @G_TEST_TRAP_INHERIT_STDIN: If this flag is given, stdin of the
 482  *     child process is shared with stdin of its parent process.
 483  *     It is redirected to `/dev/null` otherwise.
 484  *
 485  * Test traps are guards around forked tests.
 486  * These flags determine what traps to set.
 487  *
 488  * Deprecated: 2.38: #GTestTrapFlags is used only with g_test_trap_fork(),
 489  * which is deprecated. g_test_trap_subprocess() uses
 490  * #GTestSubprocessFlags.
 491  */
 492 typedef enum {
 493   G_TEST_TRAP_DEFAULT GLIB_AVAILABLE_ENUMERATOR_IN_2_74 = 0,
 494   G_TEST_TRAP_SILENCE_STDOUT    = 1 << 7,
 495   G_TEST_TRAP_SILENCE_STDERR    = 1 << 8,
 496   G_TEST_TRAP_INHERIT_STDIN     = 1 << 9
 497 } GTestTrapFlags GLIB_DEPRECATED_TYPE_IN_2_38_FOR(GTestSubprocessFlags);
 498
 499 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
 500
 501 GLIB_DEPRECATED_IN_2_38_FOR (g_test_trap_subprocess)
 502 gboolean g_test_trap_fork               (guint64              usec_timeout,
 503                                          GTestTrapFlags       test_trap_flags);
 504
 505 G_GNUC_END_IGNORE_DEPRECATIONS
 506
 507 typedef enum {
 508   G_TEST_SUBPROCESS_DEFAULT GLIB_AVAILABLE_ENUMERATOR_IN_2_74 = 0,
 509   G_TEST_SUBPROCESS_INHERIT_STDIN  = 1 << 0,
 510   G_TEST_SUBPROCESS_INHERIT_STDOUT = 1 << 1,
 511   G_TEST_SUBPROCESS_INHERIT_STDERR = 1 << 2
 512 } GTestSubprocessFlags;
 513
 514 GLIB_AVAILABLE_IN_2_38
 515 void     g_test_trap_subprocess         (const char           *test_path,
 516                                          guint64               usec_timeout,
 517                                          GTestSubprocessFlags  test_flags);
 518
 519 GLIB_AVAILABLE_IN_ALL
 520 gboolean g_test_trap_has_passed         (void);
 521 GLIB_AVAILABLE_IN_ALL
 522 gboolean g_test_trap_reached_timeout    (void);
 523 #define  g_test_trap_assert_passed()                      g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0)
 524 #define  g_test_trap_assert_failed()                      g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 1, 0)
 525 #define  g_test_trap_assert_stdout(soutpattern)           g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 2, soutpattern)
 526 #define  g_test_trap_assert_stdout_unmatched(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 3, soutpattern)
 527 #define  g_test_trap_assert_stderr(serrpattern)           g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 4, serrpattern)
 528 #define  g_test_trap_assert_stderr_unmatched(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 5, serrpattern)
 529
 530 /* provide seed-able random numbers for tests */
 531 #define  g_test_rand_bit()              (0 != (g_test_rand_int() & (1 << 15)))
 532 GLIB_AVAILABLE_IN_ALL
 533 gint32   g_test_rand_int                (void);
 534 GLIB_AVAILABLE_IN_ALL
 535 gint32   g_test_rand_int_range          (gint32          begin,
 536                                          gint32          end);
 537 GLIB_AVAILABLE_IN_ALL
 538 double   g_test_rand_double             (void);
 539 GLIB_AVAILABLE_IN_ALL
 540 double   g_test_rand_double_range       (double          range_start,
 541                                          double          range_end);
 542
 543 /*
 544  * semi-internal API: non-documented symbols with stable ABI. You
 545  * should use the non-internal helper macros instead. However, for
 546  * compatibility reason, you may use this semi-internal API.
 547  */
 548 GLIB_AVAILABLE_IN_ALL
 549 GTestCase*    g_test_create_case        (const char       *test_name,
 550                                          gsize             data_size,
 551                                          gconstpointer     test_data,
 552                                          GTestFixtureFunc  data_setup,
 553                                          GTestFixtureFunc  data_test,
 554                                          GTestFixtureFunc  data_teardown);
 555 GLIB_AVAILABLE_IN_ALL
 556 GTestSuite*   g_test_create_suite       (const char       *suite_name);
 557 GLIB_AVAILABLE_IN_ALL
 558 GTestSuite*   g_test_get_root           (void);
 559 GLIB_AVAILABLE_IN_ALL
 560 void          g_test_suite_add          (GTestSuite     *suite,
 561                                          GTestCase      *test_case);
 562 GLIB_AVAILABLE_IN_ALL
 563 void          g_test_suite_add_suite    (GTestSuite     *suite,
 564                                          GTestSuite     *nestedsuite);
 565 GLIB_AVAILABLE_IN_ALL
 566 int           g_test_run_suite          (GTestSuite     *suite);
 567
 568 GLIB_AVAILABLE_IN_2_70
 569 void          g_test_case_free          (GTestCase *test_case);
 570
 571 GLIB_AVAILABLE_IN_2_70
 572 void          g_test_suite_free         (GTestSuite     *suite);
 573
 574 GLIB_AVAILABLE_IN_ALL
 575 void    g_test_trap_assertions          (const char     *domain,
 576                                          const char     *file,
 577                                          int             line,
 578                                          const char     *func,
 579                                          guint64         assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
 580                                          const char     *pattern);
 581 GLIB_AVAILABLE_IN_ALL
 582 void    g_assertion_message             (const char     *domain,
 583                                          const char     *file,
 584                                          int             line,
 585                                          const char     *func,
 586                                          const char     *message) G_ANALYZER_NORETURN;
 587 G_NORETURN
 588 GLIB_AVAILABLE_IN_ALL
 589 void    g_assertion_message_expr        (const char     *domain,
 590                                          const char     *file,
 591                                          int             line,
 592                                          const char     *func,
 593                                          const char     *expr);
 594 GLIB_AVAILABLE_IN_ALL
 595 void    g_assertion_message_cmpstr      (const char     *domain,
 596                                          const char     *file,
 597                                          int             line,
 598                                          const char     *func,
 599                                          const char     *expr,
 600                                          const char     *arg1,
 601                                          const char     *cmp,
 602                                          const char     *arg2) G_ANALYZER_NORETURN;
 603
 604 GLIB_AVAILABLE_IN_2_68
 605 void    g_assertion_message_cmpstrv     (const char         *domain,
 606                                          const char         *file,
 607                                          int                 line,
 608                                          const char         *func,
 609                                          const char         *expr,
 610                                          const char * const *arg1,
 611                                          const char * const *arg2,
 612                                          gsize               first_wrong_idx) G_ANALYZER_NORETURN;
 613 GLIB_AVAILABLE_IN_2_78
 614 void    g_assertion_message_cmpint      (const char     *domain,
 615                                          const char     *file,
 616                                          int             line,
 617                                          const char     *func,
 618                                          const char     *expr,
 619                                          guint64         arg1,
 620                                          const char     *cmp,
 621                                          guint64         arg2,
 622                                          char            numtype) G_ANALYZER_NORETURN;
 623 GLIB_AVAILABLE_IN_ALL
 624 void    g_assertion_message_cmpnum      (const char     *domain,
 625                                          const char     *file,
 626                                          int             line,
 627                                          const char     *func,
 628                                          const char     *expr,
 629                                          long double     arg1,
 630                                          const char     *cmp,
 631                                          long double     arg2,
 632                                          char            numtype) G_ANALYZER_NORETURN;
 633 GLIB_AVAILABLE_IN_ALL
 634 void    g_assertion_message_error       (const char     *domain,
 635                                          const char     *file,
 636                                          int             line,
 637                                          const char     *func,
 638                                          const char     *expr,
 639                                          const GError   *error,
 640                                          GQuark          error_domain,
 641                                          int             error_code) G_ANALYZER_NORETURN;
 642 GLIB_AVAILABLE_IN_ALL
 643 void    g_test_add_vtable               (const char     *testpath,
 644                                          gsize           data_size,
 645                                          gconstpointer   test_data,
 646                                          GTestFixtureFunc  data_setup,
 647                                          GTestFixtureFunc  data_test,
 648                                          GTestFixtureFunc  data_teardown);
 649 typedef struct {
 650   gboolean      test_initialized;
 651   gboolean      test_quick;     /* disable thorough tests */
 652   gboolean      test_perf;      /* run performance tests */
 653   gboolean      test_verbose;   /* extra info */
 654   gboolean      test_quiet;     /* reduce output */
 655   gboolean      test_undefined; /* run tests that are meant to assert */
 656 } GTestConfig;
 657 GLIB_VAR const GTestConfig * const g_test_config_vars;
 658
 659 /* internal logging API */
 660 typedef enum {
 661   G_TEST_RUN_SUCCESS,
 662   G_TEST_RUN_SKIPPED,
 663   G_TEST_RUN_FAILURE,
 664   G_TEST_RUN_INCOMPLETE
 665 } GTestResult;
 666
 667 typedef enum {
 668   G_TEST_LOG_NONE,
 669   G_TEST_LOG_ERROR,             /* s:msg */
 670   G_TEST_LOG_START_BINARY,      /* s:binaryname s:seed */
 671   G_TEST_LOG_LIST_CASE,         /* s:testpath */
 672   G_TEST_LOG_SKIP_CASE,         /* s:testpath */
 673   G_TEST_LOG_START_CASE,        /* s:testpath */
 674   G_TEST_LOG_STOP_CASE,         /* d:status d:nforks d:elapsed */
 675   G_TEST_LOG_MIN_RESULT,        /* s:blurb d:result */
 676   G_TEST_LOG_MAX_RESULT,        /* s:blurb d:result */
 677   G_TEST_LOG_MESSAGE,           /* s:blurb */
 678   G_TEST_LOG_START_SUITE,
 679   G_TEST_LOG_STOP_SUITE
 680 } GTestLogType;
 681
 682 typedef struct {
 683   GTestLogType  log_type;
 684   guint         n_strings;
 685   gchar       **strings; /* NULL terminated */
 686   guint         n_nums;
 687   long double  *nums;
 688 } GTestLogMsg;
 689 typedef struct {
 690   /*< private >*/
 691   GString     *data;
 692   GSList      *msgs;
 693 } GTestLogBuffer;
 694
 695 GLIB_AVAILABLE_IN_ALL
 696 const char*     g_test_log_type_name    (GTestLogType    log_type);
 697 GLIB_AVAILABLE_IN_ALL
 698 GTestLogBuffer* g_test_log_buffer_new   (void);
 699 GLIB_AVAILABLE_IN_ALL
 700 void            g_test_log_buffer_free  (GTestLogBuffer *tbuffer);
 701 GLIB_AVAILABLE_IN_ALL
 702 void            g_test_log_buffer_push  (GTestLogBuffer *tbuffer,
 703                                          guint           n_bytes,
 704                                          const guint8   *bytes);
 705 GLIB_AVAILABLE_IN_ALL
 706 GTestLogMsg*    g_test_log_buffer_pop   (GTestLogBuffer *tbuffer);
 707 GLIB_AVAILABLE_IN_ALL
 708 void            g_test_log_msg_free     (GTestLogMsg    *tmsg);
 709
 710 /**
 711  * GTestLogFatalFunc:
 712  * @log_domain: the log domain of the message
 713  * @log_level: the log level of the message (including the fatal and recursion flags)
 714  * @message: the message to process
 715  * @user_data: user data, set in g_test_log_set_fatal_handler()
 716  *
 717  * Specifies the prototype of fatal log handler functions.
 718  *
 719  * Returns: %TRUE if the program should abort, %FALSE otherwise
 720  *
 721  * Since: 2.22
 722  */
 723 typedef gboolean        (*GTestLogFatalFunc)    (const gchar    *log_domain,
 724                                                  GLogLevelFlags  log_level,
 725                                                  const gchar    *message,
 726                                                  gpointer        user_data);
 727 GLIB_AVAILABLE_IN_ALL
 728 void
 729 g_test_log_set_fatal_handler            (GTestLogFatalFunc log_func,
 730                                          gpointer          user_data);
 731
 732 GLIB_AVAILABLE_IN_2_34
 733 void    g_test_expect_message                    (const gchar    *log_domain,
 734                                                   GLogLevelFlags  log_level,
 735                                                   const gchar    *pattern);
 736 GLIB_AVAILABLE_IN_2_34
 737 void    g_test_assert_expected_messages_internal (const char     *domain,
 738                                                   const char     *file,
 739                                                   int             line,
 740                                                   const char     *func);
 741
 742 typedef enum
 743 {
 744   G_TEST_DIST,
 745   G_TEST_BUILT
 746 } GTestFileType;
 747
 748 GLIB_AVAILABLE_IN_2_38
 749 gchar * g_test_build_filename                    (GTestFileType   file_type,
 750                                                   const gchar    *first_path,
 751                                                   ...) G_GNUC_NULL_TERMINATED;
 752 GLIB_AVAILABLE_IN_2_38
 753 const gchar *g_test_get_dir                      (GTestFileType   file_type);
 754 GLIB_AVAILABLE_IN_2_38
 755 const gchar *g_test_get_filename                 (GTestFileType   file_type,
 756                                                   const gchar    *first_path,
 757                                                   ...) G_GNUC_NULL_TERMINATED;
 758
 759 #define g_test_assert_expected_messages() g_test_assert_expected_messages_internal (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC)
 760
 761 G_END_DECLS
 762
 763 #endif /* __G_TEST_UTILS_H__ */