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 #ifndef __G_TEST_UTILS_H__
  21 #define __G_TEST_UTILS_H__
  22
  23 #include <glib.h>
  24
  25 G_BEGIN_DECLS;
  26
  27 typedef struct GTestCase  GTestCase;
  28 typedef struct GTestSuite GTestSuite;
  29
  30 /* assertion API */
  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 #ifdef G_DISABLE_ASSERT
  52 #define g_assert_not_reached()          do { (void) 0; } while (0)
  53 #define g_assert(expr)                  do { (void) 0; } while (0)
  54 #else /* !G_DISABLE_ASSERT */
  55 #define g_assert_not_reached()          do { g_assertion_message (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, NULL); } while (0)
  56 #define g_assert(expr)                  do { if G_LIKELY (expr) ; else \
  57                                                g_assertion_message_expr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
  58                                                  #expr); } while (0)
  59 #endif /* !G_DISABLE_ASSERT */
  60
  61 int     g_strcmp0                       (const char     *str1,
  62                                          const char     *str2);
  63
  64 /* report performance results */
  65 void    g_test_minimized_result         (double          minimized_quantity,
  66                                          const char     *format,
  67                                          ...) G_GNUC_PRINTF (2, 3);
  68 void    g_test_maximized_result         (double          maximized_quantity,
  69                                          const char     *format,
  70                                          ...) G_GNUC_PRINTF (2, 3);
  71
  72 /* initialize testing framework */
  73 void    g_test_init                     (int            *argc,
  74                                          char         ***argv,
  75                                          ...);
  76 /* query testing framework config */
  77 #define g_test_quick()                  (g_test_config_vars->test_quick)
  78 #define g_test_slow()                   (!g_test_config_vars->test_quick)
  79 #define g_test_thorough()               (!g_test_config_vars->test_quick)
  80 #define g_test_perf()                   (g_test_config_vars->test_perf)
  81 #define g_test_verbose()                (g_test_config_vars->test_verbose)
  82 #define g_test_quiet()                  (g_test_config_vars->test_quiet)
  83 /* run all tests under toplevel suite (path: /) */
  84 int     g_test_run                      (void);
  85 /* hook up a test functions under test path */
  86 void    g_test_add_func                 (const char     *testpath,
  87                                          void          (*test_func) (void));
  88 void    g_test_add_data_func            (const char     *testpath,
  89                                          gconstpointer   test_data,
  90                                          void          (*test_func) (gconstpointer));
  91 /* hook up a test with fixture under test path */
  92 #define g_test_add(testpath, Fixture, tdata, fsetup, ftest, fteardown) \
  93                                         ((void (*) (const char*,       \
  94                                                     gsize,             \
  95                                                     gconstpointer,     \
  96                                                     void (*) (Fixture*, gconstpointer),   \
  97                                                     void (*) (Fixture*, gconstpointer),   \
  98                                                     void (*) (Fixture*, gconstpointer)))  \
  99                                          (void*) g_test_add_vtable) \
 100                                           (testpath, sizeof (Fixture), tdata, fsetup, ftest, fteardown)
 101 /* add test messages to the test report */
 102 void    g_test_message                  (const char *format,
 103                                          ...) G_GNUC_PRINTF (1, 2);
 104 void    g_test_bug_base                 (const char *uri_pattern);
 105 void    g_test_bug                      (const char *bug_uri_snippet);
 106 /* measure test timings */
 107 void    g_test_timer_start              (void);
 108 double  g_test_timer_elapsed            (void); // elapsed seconds
 109 double  g_test_timer_last               (void); // repeat last elapsed() result
 110
 111 /* automatically g_free or g_object_unref upon teardown */
 112 void    g_test_queue_free               (gpointer gfree_pointer);
 113 void    g_test_queue_destroy            (GDestroyNotify destroy_func,
 114                                          gpointer       destroy_data);
 115 #define g_test_queue_unref(gobject)     g_test_queue_destroy (g_object_unref, gobject)
 116
 117 /* test traps are guards used around forked tests */
 118 typedef enum {
 119   G_TEST_TRAP_SILENCE_STDOUT    = 1 << 7,
 120   G_TEST_TRAP_SILENCE_STDERR    = 1 << 8,
 121   G_TEST_TRAP_INHERIT_STDIN     = 1 << 9,
 122 } GTestTrapFlags;
 123 gboolean g_test_trap_fork               (guint64              usec_timeout,
 124                                          GTestTrapFlags       test_trap_flags);
 125 gboolean g_test_trap_has_passed         (void);
 126 gboolean g_test_trap_reached_timeout    (void);
 127 #define  g_test_trap_assert_passed()            g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 1, 0, 0, 0)
 128 #define  g_test_trap_assert_failed()            g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 1, 0, 0)
 129 #define  g_test_trap_assert_stdout(soutpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0, soutpattern, 0)
 130 #define  g_test_trap_assert_stderr(serrpattern) g_test_trap_assertions (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, 0, 0, 0, serrpattern)
 131
 132 /* provide seed-able random numbers for tests */
 133 #define  g_test_rand_bit()              (0 != (g_test_rand_int() & (1 << 15)))
 134 gint32   g_test_rand_int                (void);
 135 gint32   g_test_rand_int_range          (gint32          begin,
 136                                          gint32          end);
 137 double   g_test_rand_double             (void);
 138 double   g_test_rand_double_range       (double          range_start,
 139                                          double          range_end);
 140
 141 /* semi-internal API */
 142 GTestCase*    g_test_create_case        (const char     *test_name,
 143                                          gsize           data_size,
 144                                          gconstpointer   test_data,
 145                                          void          (*data_setup) (void),
 146                                          void          (*data_test) (void),
 147                                          void          (*data_teardown) (void));
 148 GTestSuite*   g_test_create_suite       (const char     *suite_name);
 149 GTestSuite*   g_test_get_root           (void);
 150 void          g_test_suite_add          (GTestSuite     *suite,
 151                                          GTestCase      *test_case);
 152 void          g_test_suite_add_suite    (GTestSuite     *suite,
 153                                          GTestSuite     *nestedsuite);
 154 int           g_test_run_suite          (GTestSuite     *suite);
 155
 156 /* internal ABI */
 157 void    g_test_trap_assertions          (const char     *domain,
 158                                          const char     *file,
 159                                          int             line,
 160                                          const char     *func,
 161                                          gboolean        must_pass,
 162                                          gboolean        must_fail,
 163                                          const char     *stdout_pattern,
 164                                          const char     *stderr_pattern);
 165 void    g_assertion_message             (const char     *domain,
 166                                          const char     *file,
 167                                          int             line,
 168                                          const char     *func,
 169                                          const char     *message);
 170 void    g_assertion_message_expr        (const char     *domain,
 171                                          const char     *file,
 172                                          int             line,
 173                                          const char     *func,
 174                                          const char     *expr);
 175 void    g_assertion_message_cmpstr      (const char     *domain,
 176                                          const char     *file,
 177                                          int             line,
 178                                          const char     *func,
 179                                          const char     *expr,
 180                                          const char     *arg1,
 181                                          const char     *cmp,
 182                                          const char     *arg2);
 183 void    g_assertion_message_cmpnum      (const char     *domain,
 184                                          const char     *file,
 185                                          int             line,
 186                                          const char     *func,
 187                                          const char     *expr,
 188                                          long double     arg1,
 189                                          const char     *cmp,
 190                                          long double     arg2,
 191                                          char            numtype);
 192 void    g_test_add_vtable               (const char     *testpath,
 193                                          gsize           data_size,
 194                                          gconstpointer   test_data,
 195                                          void          (*data_setup)    (void),
 196                                          void          (*data_test)     (void),
 197                                          void          (*data_teardown) (void));
 198 typedef struct {
 199   gboolean      test_initialized;
 200   gboolean      test_quick;     /* disable thorough tests */
 201   gboolean      test_perf;      /* run performance tests */
 202   gboolean      test_verbose;   /* extra info */
 203   gboolean      test_quiet;     /* reduce output */
 204 } GTestConfig;
 205 GLIB_VAR const GTestConfig * const g_test_config_vars;
 206
 207 /* internal logging API */
 208 typedef enum {
 209   G_TEST_LOG_NONE,
 210   G_TEST_LOG_ERROR,             // s:msg
 211   G_TEST_LOG_START_BINARY,      // s:binaryname s:seed
 212   G_TEST_LOG_LIST_CASE,         // s:testpath
 213   G_TEST_LOG_SKIP_CASE,         // s:testpath
 214   G_TEST_LOG_START_CASE,        // s:testpath
 215   G_TEST_LOG_STOP_CASE,         // d:status d:nforks d:elapsed
 216   G_TEST_LOG_MIN_RESULT,        // s:blurb d:result
 217   G_TEST_LOG_MAX_RESULT,        // s:blurb d:result
 218   G_TEST_LOG_MESSAGE,           // s:blurb
 219 } GTestLogType;
 220
 221 typedef struct {
 222   GTestLogType  log_type;
 223   guint         n_strings;
 224   gchar       **strings; // NULL terminated
 225   guint         n_nums;
 226   long double  *nums;
 227 } GTestLogMsg;
 228 typedef struct {
 229   /*< private >*/
 230   GString     *data;
 231   GSList      *msgs;
 232 } GTestLogBuffer;
 233
 234 const char*     g_test_log_type_name    (GTestLogType    log_type);
 235 GTestLogBuffer* g_test_log_buffer_new   (void);
 236 void            g_test_log_buffer_free  (GTestLogBuffer *tbuffer);
 237 void            g_test_log_buffer_push  (GTestLogBuffer *tbuffer,
 238                                          guint           n_bytes,
 239                                          const guint8   *bytes);
 240 GTestLogMsg*    g_test_log_buffer_pop   (GTestLogBuffer *tbuffer);
 241 void            g_test_log_msg_free     (GTestLogMsg    *tmsg);
 242
 243 G_END_DECLS;
 244
 245 #endif /* __G_TEST_UTILS_H__ */