glib/gtestutils.c

   1 /* GLib testing utilities
   2  * Copyright (C) 2007 Imendio AB
   3  * Authors: Tim Janik, Sven Herzberg
   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 #include "config.h"
  22
  23 #include "gtestutils.h"
  24
  25 #include <sys/types.h>
  26 #ifdef G_OS_UNIX
  27 #include <sys/wait.h>
  28 #include <sys/time.h>
  29 #include <fcntl.h>
  30 #endif
  31 #include <string.h>
  32 #include <stdlib.h>
  33 #include <stdio.h>
  34 #ifdef HAVE_UNISTD_H
  35 #include <unistd.h>
  36 #endif
  37 #ifdef G_OS_WIN32
  38 #include <io.h>
  39 #endif
  40 #include <errno.h>
  41 #include <signal.h>
  42 #ifdef HAVE_SYS_SELECT_H
  43 #include <sys/select.h>
  44 #endif /* HAVE_SYS_SELECT_H */
  45
  46 #include "gmain.h"
  47 #include "gpattern.h"
  48 #include "grand.h"
  49 #include "gstrfuncs.h"
  50 #include "gtimer.h"
  51
  52
  53 /* Global variable for storing assertion messages; this is the counterpart to
  54  * glibc's (private) __abort_msg variable, and allows developers and crash
  55  * analysis systems like Apport and ABRT to fish out assertion messages from
  56  * core dumps, instead of having to catch them on screen output. */
  57 char *__glib_assert_msg = NULL;
  58
  59 /* --- structures --- */
  60 struct GTestCase
  61 {
  62   gchar  *name;
  63   guint   fixture_size;
  64   void   (*fixture_setup)    (void*, gconstpointer);
  65   void   (*fixture_test)     (void*, gconstpointer);
  66   void   (*fixture_teardown) (void*, gconstpointer);
  67   gpointer test_data;
  68 };
  69 struct GTestSuite
  70 {
  71   gchar  *name;
  72   GSList *suites;
  73   GSList *cases;
  74 };
  75 typedef struct DestroyEntry DestroyEntry;
  76 struct DestroyEntry
  77 {
  78   DestroyEntry *next;
  79   GDestroyNotify destroy_func;
  80   gpointer       destroy_data;
  81 };
  82
  83 /* --- prototypes --- */
  84 static void     test_run_seed                   (const gchar *rseed);
  85 static void     test_trap_clear                 (void);
  86 static guint8*  g_test_log_dump                 (GTestLogMsg *msg,
  87                                                  guint       *len);
  88 static void     gtest_default_log_handler       (const gchar    *log_domain,
  89                                                  GLogLevelFlags  log_level,
  90                                                  const gchar    *message,
  91                                                  gpointer        unused_data);
  92
  93
  94 /* --- variables --- */
  95 static int         test_log_fd = -1;
  96 static gboolean    test_mode_fatal = TRUE;
  97 static gboolean    g_test_run_once = TRUE;
  98 static gboolean    test_run_list = FALSE;
  99 static gchar      *test_run_seedstr = NULL;
 100 static GRand      *test_run_rand = NULL;
 101 static gchar      *test_run_name = "";
 102 static guint       test_run_forks = 0;
 103 static guint       test_run_count = 0;
 104 static guint       test_skip_count = 0;
 105 static GTimer     *test_user_timer = NULL;
 106 static double      test_user_stamp = 0;
 107 static GSList     *test_paths = NULL;
 108 static GTestSuite *test_suite_root = NULL;
 109 static int         test_trap_last_status = 0;
 110 static int         test_trap_last_pid = 0;
 111 static char       *test_trap_last_stdout = NULL;
 112 static char       *test_trap_last_stderr = NULL;
 113 static char       *test_uri_base = NULL;
 114 static gboolean    test_debug_log = FALSE;
 115 static DestroyEntry *test_destroy_queue = NULL;
 116 static GTestConfig mutable_test_config_vars = {
 117   FALSE,        /* test_initialized */
 118   TRUE,         /* test_quick */
 119   FALSE,        /* test_perf */
 120   FALSE,        /* test_verbose */
 121   FALSE,        /* test_quiet */
 122 };
 123 const GTestConfig * const g_test_config_vars = &mutable_test_config_vars;
 124
 125 /* --- functions --- */
 126 const char*
 127 g_test_log_type_name (GTestLogType log_type)
 128 {
 129   switch (log_type)
 130     {
 131     case G_TEST_LOG_NONE:               return "none";
 132     case G_TEST_LOG_ERROR:              return "error";
 133     case G_TEST_LOG_START_BINARY:       return "binary";
 134     case G_TEST_LOG_LIST_CASE:          return "list";
 135     case G_TEST_LOG_SKIP_CASE:          return "skip";
 136     case G_TEST_LOG_START_CASE:         return "start";
 137     case G_TEST_LOG_STOP_CASE:          return "stop";
 138     case G_TEST_LOG_MIN_RESULT:         return "minperf";
 139     case G_TEST_LOG_MAX_RESULT:         return "maxperf";
 140     case G_TEST_LOG_MESSAGE:            return "message";
 141     }
 142   return "???";
 143 }
 144
 145 static void
 146 g_test_log_send (guint         n_bytes,
 147                  const guint8 *buffer)
 148 {
 149   if (test_log_fd >= 0)
 150     {
 151       int r;
 152       do
 153         r = write (test_log_fd, buffer, n_bytes);
 154       while (r < 0 && errno == EINTR);
 155     }
 156   if (test_debug_log)
 157     {
 158       GTestLogBuffer *lbuffer = g_test_log_buffer_new ();
 159       GTestLogMsg *msg;
 160       guint ui;
 161       g_test_log_buffer_push (lbuffer, n_bytes, buffer);
 162       msg = g_test_log_buffer_pop (lbuffer);
 163       g_warn_if_fail (msg != NULL);
 164       g_warn_if_fail (lbuffer->data->len == 0);
 165       g_test_log_buffer_free (lbuffer);
 166       /* print message */
 167       g_printerr ("{*LOG(%s)", g_test_log_type_name (msg->log_type));
 168       for (ui = 0; ui < msg->n_strings; ui++)
 169         g_printerr (":{%s}", msg->strings[ui]);
 170       if (msg->n_nums)
 171         {
 172           g_printerr (":(");
 173           for (ui = 0; ui < msg->n_nums; ui++)
 174             g_printerr ("%s%.16Lg", ui ? ";" : "", msg->nums[ui]);
 175           g_printerr (")");
 176         }
 177       g_printerr (":LOG*}\n");
 178       g_test_log_msg_free (msg);
 179     }
 180 }
 181
 182 static void
 183 g_test_log (GTestLogType lbit,
 184             const gchar *string1,
 185             const gchar *string2,
 186             guint        n_args,
 187             long double *largs)
 188 {
 189   gboolean fail = lbit == G_TEST_LOG_STOP_CASE && largs[0] != 0;
 190   GTestLogMsg msg;
 191   gchar *astrings[3] = { NULL, NULL, NULL };
 192   guint8 *dbuffer;
 193   guint32 dbufferlen;
 194
 195   switch (lbit)
 196     {
 197     case G_TEST_LOG_START_BINARY:
 198       if (g_test_verbose())
 199         g_print ("GTest: random seed: %s\n", string2);
 200       break;
 201     case G_TEST_LOG_STOP_CASE:
 202       if (g_test_verbose())
 203         g_print ("GTest: result: %s\n", fail ? "FAIL" : "OK");
 204       else if (!g_test_quiet())
 205         g_print ("%s\n", fail ? "FAIL" : "OK");
 206       if (fail && test_mode_fatal)
 207         abort();
 208       break;
 209     case G_TEST_LOG_MIN_RESULT:
 210       if (g_test_verbose())
 211         g_print ("(MINPERF:%s)\n", string1);
 212       break;
 213     case G_TEST_LOG_MAX_RESULT:
 214       if (g_test_verbose())
 215         g_print ("(MAXPERF:%s)\n", string1);
 216       break;
 217     case G_TEST_LOG_MESSAGE:
 218       if (g_test_verbose())
 219         g_print ("(MSG: %s)\n", string1);
 220       break;
 221     default: ;
 222     }
 223
 224   msg.log_type = lbit;
 225   msg.n_strings = (string1 != NULL) + (string1 && string2);
 226   msg.strings = astrings;
 227   astrings[0] = (gchar*) string1;
 228   astrings[1] = astrings[0] ? (gchar*) string2 : NULL;
 229   msg.n_nums = n_args;
 230   msg.nums = largs;
 231   dbuffer = g_test_log_dump (&msg, &dbufferlen);
 232   g_test_log_send (dbufferlen, dbuffer);
 233   g_free (dbuffer);
 234
 235   switch (lbit)
 236     {
 237     case G_TEST_LOG_START_CASE:
 238       if (g_test_verbose())
 239         g_print ("GTest: run: %s\n", string1);
 240       else if (!g_test_quiet())
 241         g_print ("%s: ", string1);
 242       break;
 243     default: ;
 244     }
 245 }
 246
 247 /* We intentionally parse the command line without GOptionContext
 248  * because otherwise you would never be able to test it.
 249  */
 250 static void
 251 parse_args (gint    *argc_p,
 252             gchar ***argv_p)
 253 {
 254   guint argc = *argc_p;
 255   gchar **argv = *argv_p;
 256   guint i, e;
 257   /* parse known args */
 258   for (i = 1; i < argc; i++)
 259     {
 260       if (strcmp (argv[i], "--g-fatal-warnings") == 0)
 261         {
 262           GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
 263           fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
 264           g_log_set_always_fatal (fatal_mask);
 265           argv[i] = NULL;
 266         }
 267       else if (strcmp (argv[i], "--keep-going") == 0 ||
 268                strcmp (argv[i], "-k") == 0)
 269         {
 270           test_mode_fatal = FALSE;
 271           argv[i] = NULL;
 272         }
 273       else if (strcmp (argv[i], "--debug-log") == 0)
 274         {
 275           test_debug_log = TRUE;
 276           argv[i] = NULL;
 277         }
 278       else if (strcmp ("--GTestLogFD", argv[i]) == 0 || strncmp ("--GTestLogFD=", argv[i], 13) == 0)
 279         {
 280           gchar *equal = argv[i] + 12;
 281           if (*equal == '=')
 282             test_log_fd = g_ascii_strtoull (equal + 1, NULL, 0);
 283           else if (i + 1 < argc)
 284             {
 285               argv[i++] = NULL;
 286               test_log_fd = g_ascii_strtoull (argv[i], NULL, 0);
 287             }
 288           argv[i] = NULL;
 289         }
 290       else if (strcmp ("--GTestSkipCount", argv[i]) == 0 || strncmp ("--GTestSkipCount=", argv[i], 17) == 0)
 291         {
 292           gchar *equal = argv[i] + 16;
 293           if (*equal == '=')
 294             test_skip_count = g_ascii_strtoull (equal + 1, NULL, 0);
 295           else if (i + 1 < argc)
 296             {
 297               argv[i++] = NULL;
 298               test_skip_count = g_ascii_strtoull (argv[i], NULL, 0);
 299             }
 300           argv[i] = NULL;
 301         }
 302       else if (strcmp ("-p", argv[i]) == 0 || strncmp ("-p=", argv[i], 3) == 0)
 303         {
 304           gchar *equal = argv[i] + 2;
 305           if (*equal == '=')
 306             test_paths = g_slist_prepend (test_paths, equal + 1);
 307           else if (i + 1 < argc)
 308             {
 309               argv[i++] = NULL;
 310               test_paths = g_slist_prepend (test_paths, argv[i]);
 311             }
 312           argv[i] = NULL;
 313         }
 314       else if (strcmp ("-m", argv[i]) == 0 || strncmp ("-m=", argv[i], 3) == 0)
 315         {
 316           gchar *equal = argv[i] + 2;
 317           const gchar *mode = "";
 318           if (*equal == '=')
 319             mode = equal + 1;
 320           else if (i + 1 < argc)
 321             {
 322               argv[i++] = NULL;
 323               mode = argv[i];
 324             }
 325           if (strcmp (mode, "perf") == 0)
 326             mutable_test_config_vars.test_perf = TRUE;
 327           else if (strcmp (mode, "slow") == 0)
 328             mutable_test_config_vars.test_quick = FALSE;
 329           else if (strcmp (mode, "thorough") == 0)
 330             mutable_test_config_vars.test_quick = FALSE;
 331           else if (strcmp (mode, "quick") == 0)
 332             {
 333               mutable_test_config_vars.test_quick = TRUE;
 334               mutable_test_config_vars.test_perf = FALSE;
 335             }
 336           else
 337             g_error ("unknown test mode: -m %s", mode);
 338           argv[i] = NULL;
 339         }
 340       else if (strcmp ("-q", argv[i]) == 0 || strcmp ("--quiet", argv[i]) == 0)
 341         {
 342           mutable_test_config_vars.test_quiet = TRUE;
 343           mutable_test_config_vars.test_verbose = FALSE;
 344           argv[i] = NULL;
 345         }
 346       else if (strcmp ("--verbose", argv[i]) == 0)
 347         {
 348           mutable_test_config_vars.test_quiet = FALSE;
 349           mutable_test_config_vars.test_verbose = TRUE;
 350           argv[i] = NULL;
 351         }
 352       else if (strcmp ("-l", argv[i]) == 0)
 353         {
 354           test_run_list = TRUE;
 355           argv[i] = NULL;
 356         }
 357       else if (strcmp ("--seed", argv[i]) == 0 || strncmp ("--seed=", argv[i], 7) == 0)
 358         {
 359           gchar *equal = argv[i] + 6;
 360           if (*equal == '=')
 361             test_run_seedstr = equal + 1;
 362           else if (i + 1 < argc)
 363             {
 364               argv[i++] = NULL;
 365               test_run_seedstr = argv[i];
 366             }
 367           argv[i] = NULL;
 368         }
 369       else if (strcmp ("-?", argv[i]) == 0 || strcmp ("--help", argv[i]) == 0)
 370         {
 371           printf ("Usage:\n"
 372                   "  %s [OPTION...]\n\n"
 373                   "Help Options:\n"
 374                   "  -?, --help                     Show help options\n"
 375                   "Test Options:\n"
 376                   "  -l                             List test cases available in a test executable\n"
 377                   "  -seed=RANDOMSEED               Provide a random seed to reproduce test\n"
 378                   "                                 runs using random numbers\n"
 379                   "  --verbose                      Run tests verbosely\n"
 380                   "  -q, --quiet                    Run tests quietly\n"
 381                   "  -p TESTPATH                    execute all tests matching TESTPATH\n"
 382                   "  -m {perf|slow|thorough|quick}  Execute tests according modes\n"
 383                   "  --debug-log                    debug test logging output\n"
 384                   "  -k, --keep-going               gtester-specific argument\n"
 385                   "  --GTestLogFD=N                 gtester-specific argument\n"
 386                   "  --GTestSkipCount=N             gtester-specific argument\n",
 387                   argv[0]);
 388           exit (0);
 389         }
 390     }
 391   /* collapse argv */
 392   e = 1;
 393   for (i = 1; i < argc; i++)
 394     if (argv[i])
 395       {
 396         argv[e++] = argv[i];
 397         if (i >= e)
 398           argv[i] = NULL;
 399       }
 400   *argc_p = e;
 401 }
 402
 403 /**
 404  * g_test_init:
 405  * @argc: Address of the @argc parameter of the main() function.
 406  *        Changed if any arguments were handled.
 407  * @argv: Address of the @argv parameter of main().
 408  *        Any parameters understood by g_test_init() stripped before return.
 409  * @Varargs: Reserved for future extension. Currently, you must pass %NULL.
 410  *
 411  * Initialize the GLib testing framework, e.g. by seeding the
 412  * test random number generator, the name for g_get_prgname()
 413  * and parsing test related command line args.
 414  * So far, the following arguments are understood:
 415  * <variablelist>
 416  *   <varlistentry>
 417  *     <term><option>-l</option></term>
 418  *     <listitem><para>
 419  *       list test cases available in a test executable.
 420  *     </para></listitem>
 421  *   </varlistentry>
 422  *   <varlistentry>
 423  *     <term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
 424  *     <listitem><para>
 425  *       provide a random seed to reproduce test runs using random numbers.
 426  *     </para></listitem>
 427  *     </varlistentry>
 428  *     <varlistentry>
 429  *       <term><option>--verbose</option></term>
 430  *       <listitem><para>run tests verbosely.</para></listitem>
 431  *     </varlistentry>
 432  *     <varlistentry>
 433  *       <term><option>-q</option>, <option>--quiet</option></term>
 434  *       <listitem><para>run tests quietly.</para></listitem>
 435  *     </varlistentry>
 436  *     <varlistentry>
 437  *       <term><option>-p <replaceable>TESTPATH</replaceable></option></term>
 438  *       <listitem><para>
 439  *         execute all tests matching <replaceable>TESTPATH</replaceable>.
 440  *       </para></listitem>
 441  *     </varlistentry>
 442  *     <varlistentry>
 443  *       <term><option>-m {perf|slow|thorough|quick}</option></term>
 444  *       <listitem><para>
 445  *         execute tests according to these test modes:
 446  *         <variablelist>
 447  *           <varlistentry>
 448  *             <term>perf</term>
 449  *             <listitem><para>
 450  *               performance tests, may take long and report results.
 451  *             </para></listitem>
 452  *           </varlistentry>
 453  *           <varlistentry>
 454  *             <term>slow, thorough</term>
 455  *             <listitem><para>
 456  *               slow and thorough tests, may take quite long and
 457  *               maximize coverage.
 458  *             </para></listitem>
 459  *           </varlistentry>
 460  *           <varlistentry>
 461  *             <term>quick</term>
 462  *             <listitem><para>
 463  *               quick tests, should run really quickly and give good coverage.
 464  *             </para></listitem>
 465  *           </varlistentry>
 466  *         </variablelist>
 467  *       </para></listitem>
 468  *     </varlistentry>
 469  *     <varlistentry>
 470  *       <term><option>--debug-log</option></term>
 471  *       <listitem><para>debug test logging output.</para></listitem>
 472  *     </varlistentry>
 473  *     <varlistentry>
 474  *       <term><option>-k</option>, <option>--keep-going</option></term>
 475  *       <listitem><para>gtester-specific argument.</para></listitem>
 476  *     </varlistentry>
 477  *     <varlistentry>
 478  *       <term><option>--GTestLogFD <replaceable>N</replaceable></option></term>
 479  *       <listitem><para>gtester-specific argument.</para></listitem>
 480  *     </varlistentry>
 481  *     <varlistentry>
 482  *       <term><option>--GTestSkipCount <replaceable>N</replaceable></option></term>
 483  *       <listitem><para>gtester-specific argument.</para></listitem>
 484  *     </varlistentry>
 485  *  </variablelist>
 486  *
 487  * Since: 2.16
 488  */
 489 void
 490 g_test_init (int    *argc,
 491              char ***argv,
 492              ...)
 493 {
 494   static char seedstr[4 + 4 * 8 + 1];
 495   va_list args;
 496   gpointer vararg1;
 497   /* make warnings and criticals fatal for all test programs */
 498   GLogLevelFlags fatal_mask = (GLogLevelFlags) g_log_set_always_fatal ((GLogLevelFlags) G_LOG_FATAL_MASK);
 499   fatal_mask = (GLogLevelFlags) (fatal_mask | G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL);
 500   g_log_set_always_fatal (fatal_mask);
 501   /* check caller args */
 502   g_return_if_fail (argc != NULL);
 503   g_return_if_fail (argv != NULL);
 504   g_return_if_fail (g_test_config_vars->test_initialized == FALSE);
 505   mutable_test_config_vars.test_initialized = TRUE;
 506
 507   va_start (args, argv);
 508   vararg1 = va_arg (args, gpointer); /* reserved for future extensions */
 509   va_end (args);
 510   g_return_if_fail (vararg1 == NULL);
 511
 512   /* setup random seed string */
 513   g_snprintf (seedstr, sizeof (seedstr), "R02S%08x%08x%08x%08x", g_random_int(), g_random_int(), g_random_int(), g_random_int());
 514   test_run_seedstr = seedstr;
 515
 516   /* parse args, sets up mode, changes seed, etc. */
 517   parse_args (argc, argv);
 518   if (!g_get_prgname())
 519     g_set_prgname ((*argv)[0]);
 520
 521   /* verify GRand reliability, needed for reliable seeds */
 522   if (1)
 523     {
 524       GRand *rg = g_rand_new_with_seed (0xc8c49fb6);
 525       guint32 t1 = g_rand_int (rg), t2 = g_rand_int (rg), t3 = g_rand_int (rg), t4 = g_rand_int (rg);
 526       /* g_print ("GRand-current: 0x%x 0x%x 0x%x 0x%x\n", t1, t2, t3, t4); */
 527       if (t1 != 0xfab39f9b || t2 != 0xb948fb0e || t3 != 0x3d31be26 || t4 != 0x43a19d66)
 528         g_warning ("random numbers are not GRand-2.2 compatible, seeds may be broken (check $G_RANDOM_VERSION)");
 529       g_rand_free (rg);
 530     }
 531
 532   /* check rand seed */
 533   test_run_seed (test_run_seedstr);
 534
 535   /* report program start */
 536   g_log_set_default_handler (gtest_default_log_handler, NULL);
 537   g_test_log (G_TEST_LOG_START_BINARY, g_get_prgname(), test_run_seedstr, 0, NULL);
 538 }
 539
 540 static void
 541 test_run_seed (const gchar *rseed)
 542 {
 543   guint seed_failed = 0;
 544   if (test_run_rand)
 545     g_rand_free (test_run_rand);
 546   test_run_rand = NULL;
 547   while (strchr (" \t\v\r\n\f", *rseed))
 548     rseed++;
 549   if (strncmp (rseed, "R02S", 4) == 0)  /* seed for random generator 02 (GRand-2.2) */
 550     {
 551       const char *s = rseed + 4;
 552       if (strlen (s) >= 32)             /* require 4 * 8 chars */
 553         {
 554           guint32 seedarray[4];
 555           gchar *p, hexbuf[9] = { 0, };
 556           memcpy (hexbuf, s + 0, 8);
 557           seedarray[0] = g_ascii_strtoull (hexbuf, &p, 16);
 558           seed_failed += p != NULL && *p != 0;
 559           memcpy (hexbuf, s + 8, 8);
 560           seedarray[1] = g_ascii_strtoull (hexbuf, &p, 16);
 561           seed_failed += p != NULL && *p != 0;
 562           memcpy (hexbuf, s + 16, 8);
 563           seedarray[2] = g_ascii_strtoull (hexbuf, &p, 16);
 564           seed_failed += p != NULL && *p != 0;
 565           memcpy (hexbuf, s + 24, 8);
 566           seedarray[3] = g_ascii_strtoull (hexbuf, &p, 16);
 567           seed_failed += p != NULL && *p != 0;
 568           if (!seed_failed)
 569             {
 570               test_run_rand = g_rand_new_with_seed_array (seedarray, 4);
 571               return;
 572             }
 573         }
 574     }
 575   g_error ("Unknown or invalid random seed: %s", rseed);
 576 }
 577
 578 /**
 579  * g_test_rand_int:
 580  *
 581  * Get a reproducible random integer number.
 582  *
 583  * The random numbers generated by the g_test_rand_*() family of functions
 584  * change with every new test program start, unless the --seed option is
 585  * given when starting test programs.
 586  *
 587  * For individual test cases however, the random number generator is
 588  * reseeded, to avoid dependencies between tests and to make --seed
 589  * effective for all test cases.
 590  *
 591  * Returns: a random number from the seeded random number generator.
 592  *
 593  * Since: 2.16
 594  */
 595 gint32
 596 g_test_rand_int (void)
 597 {
 598   return g_rand_int (test_run_rand);
 599 }
 600
 601 /**
 602  * g_test_rand_int_range:
 603  * @begin: the minimum value returned by this function
 604  * @end:   the smallest value not to be returned by this function
 605  *
 606  * Get a reproducible random integer number out of a specified range,
 607  * see g_test_rand_int() for details on test case random numbers.
 608  *
 609  * Returns: a number with @begin <= number < @end.
 610  *
 611  * Since: 2.16
 612  */
 613 gint32
 614 g_test_rand_int_range (gint32          begin,
 615                        gint32          end)
 616 {
 617   return g_rand_int_range (test_run_rand, begin, end);
 618 }
 619
 620 /**
 621  * g_test_rand_double:
 622  *
 623  * Get a reproducible random floating point number,
 624  * see g_test_rand_int() for details on test case random numbers.
 625  *
 626  * Returns: a random number from the seeded random number generator.
 627  *
 628  * Since: 2.16
 629  */
 630 double
 631 g_test_rand_double (void)
 632 {
 633   return g_rand_double (test_run_rand);
 634 }
 635
 636 /**
 637  * g_test_rand_double_range:
 638  * @range_start: the minimum value returned by this function
 639  * @range_end: the minimum value not returned by this function
 640  *
 641  * Get a reproducible random floating pointer number out of a specified range,
 642  * see g_test_rand_int() for details on test case random numbers.
 643  *
 644  * Returns: a number with @range_start <= number < @range_end.
 645  *
 646  * Since: 2.16
 647  */
 648 double
 649 g_test_rand_double_range (double          range_start,
 650                           double          range_end)
 651 {
 652   return g_rand_double_range (test_run_rand, range_start, range_end);
 653 }
 654
 655 /**
 656  * g_test_timer_start:
 657  *
 658  * Start a timing test. Call g_test_timer_elapsed() when the task is supposed
 659  * to be done. Call this function again to restart the timer.
 660  *
 661  * Since: 2.16
 662  */
 663 void
 664 g_test_timer_start (void)
 665 {
 666   if (!test_user_timer)
 667     test_user_timer = g_timer_new();
 668   test_user_stamp = 0;
 669   g_timer_start (test_user_timer);
 670 }
 671
 672 /**
 673  * g_test_timer_elapsed:
 674  *
 675  * Get the time since the last start of the timer with g_test_timer_start().
 676  *
 677  * Returns: the time since the last start of the timer, as a double
 678  *
 679  * Since: 2.16
 680  */
 681 double
 682 g_test_timer_elapsed (void)
 683 {
 684   test_user_stamp = test_user_timer ? g_timer_elapsed (test_user_timer, NULL) : 0;
 685   return test_user_stamp;
 686 }
 687
 688 /**
 689  * g_test_timer_last:
 690  *
 691  * Report the last result of g_test_timer_elapsed().
 692  *
 693  * Returns: the last result of g_test_timer_elapsed(), as a double
 694  *
 695  * Since: 2.16
 696  */
 697 double
 698 g_test_timer_last (void)
 699 {
 700   return test_user_stamp;
 701 }
 702
 703 /**
 704  * g_test_minimized_result:
 705  * @minimized_quantity: the reported value
 706  * @format: the format string of the report message
 707  * @Varargs: arguments to pass to the printf() function
 708  *
 709  * Report the result of a performance or measurement test.
 710  * The test should generally strive to minimize the reported
 711  * quantities (smaller values are better than larger ones),
 712  * this and @minimized_quantity can determine sorting
 713  * order for test result reports.
 714  *
 715  * Since: 2.16
 716  */
 717 void
 718 g_test_minimized_result (double          minimized_quantity,
 719                          const char     *format,
 720                          ...)
 721 {
 722   long double largs = minimized_quantity;
 723   gchar *buffer;
 724   va_list args;
 725   va_start (args, format);
 726   buffer = g_strdup_vprintf (format, args);
 727   va_end (args);
 728   g_test_log (G_TEST_LOG_MIN_RESULT, buffer, NULL, 1, &largs);
 729   g_free (buffer);
 730 }
 731
 732 /**
 733  * g_test_maximized_result:
 734  * @maximized_quantity: the reported value
 735  * @format: the format string of the report message
 736  * @Varargs: arguments to pass to the printf() function
 737  *
 738  * Report the result of a performance or measurement test.
 739  * The test should generally strive to maximize the reported
 740  * quantities (larger values are better than smaller ones),
 741  * this and @maximized_quantity can determine sorting
 742  * order for test result reports.
 743  *
 744  * Since: 2.16
 745  */
 746 void
 747 g_test_maximized_result (double          maximized_quantity,
 748                          const char     *format,
 749                          ...)
 750 {
 751   long double largs = maximized_quantity;
 752   gchar *buffer;
 753   va_list args;
 754   va_start (args, format);
 755   buffer = g_strdup_vprintf (format, args);
 756   va_end (args);
 757   g_test_log (G_TEST_LOG_MAX_RESULT, buffer, NULL, 1, &largs);
 758   g_free (buffer);
 759 }
 760
 761 /**
 762  * g_test_message:
 763  * @format: the format string
 764  * @...:    printf-like arguments to @format
 765  *
 766  * Add a message to the test report.
 767  *
 768  * Since: 2.16
 769  */
 770 void
 771 g_test_message (const char *format,
 772                 ...)
 773 {
 774   gchar *buffer;
 775   va_list args;
 776   va_start (args, format);
 777   buffer = g_strdup_vprintf (format, args);
 778   va_end (args);
 779   g_test_log (G_TEST_LOG_MESSAGE, buffer, NULL, 0, NULL);
 780   g_free (buffer);
 781 }
 782
 783 /**
 784  * g_test_bug_base:
 785  * @uri_pattern: the base pattern for bug URIs
 786  *
 787  * Specify the base URI for bug reports.
 788  *
 789  * The base URI is used to construct bug report messages for
 790  * g_test_message() when g_test_bug() is called.
 791  * Calling this function outside of a test case sets the
 792  * default base URI for all test cases. Calling it from within
 793  * a test case changes the base URI for the scope of the test
 794  * case only.
 795  * Bug URIs are constructed by appending a bug specific URI
 796  * portion to @uri_pattern, or by replacing the special string
 797  * '%s' within @uri_pattern if that is present.
 798  *
 799  * Since: 2.16
 800  */
 801 void
 802 g_test_bug_base (const char *uri_pattern)
 803 {
 804   g_free (test_uri_base);
 805   test_uri_base = g_strdup (uri_pattern);
 806 }
 807
 808 /**
 809  * g_test_bug:
 810  * @bug_uri_snippet: Bug specific bug tracker URI portion.
 811  *
 812  * This function adds a message to test reports that
 813  * associates a bug URI with a test case.
 814  * Bug URIs are constructed from a base URI set with g_test_bug_base()
 815  * and @bug_uri_snippet.
 816  *
 817  * Since: 2.16
 818  */
 819 void
 820 g_test_bug (const char *bug_uri_snippet)
 821 {
 822   char *c;
 823   g_return_if_fail (test_uri_base != NULL);
 824   g_return_if_fail (bug_uri_snippet != NULL);
 825   c = strstr (test_uri_base, "%s");
 826   if (c)
 827     {
 828       char *b = g_strndup (test_uri_base, c - test_uri_base);
 829       char *s = g_strconcat (b, bug_uri_snippet, c + 2, NULL);
 830       g_free (b);
 831       g_test_message ("Bug Reference: %s", s);
 832       g_free (s);
 833     }
 834   else
 835     g_test_message ("Bug Reference: %s%s", test_uri_base, bug_uri_snippet);
 836 }
 837
 838 /**
 839  * g_test_get_root:
 840  *
 841  * Get the toplevel test suite for the test path API.
 842  *
 843  * Returns: the toplevel #GTestSuite
 844  *
 845  * Since: 2.16
 846  */
 847 GTestSuite*
 848 g_test_get_root (void)
 849 {
 850   if (!test_suite_root)
 851     {
 852       test_suite_root = g_test_create_suite ("root");
 853       g_free (test_suite_root->name);
 854       test_suite_root->name = g_strdup ("");
 855     }
 856   return test_suite_root;
 857 }
 858
 859 /**
 860  * g_test_run:
 861  *
 862  * Runs all tests under the toplevel suite which can be retrieved
 863  * with g_test_get_root(). Similar to g_test_run_suite(), the test
 864  * cases to be run are filtered according to
 865  * test path arguments (-p <replaceable>testpath</replaceable>) as
 866  * parsed by g_test_init().
 867  * g_test_run_suite() or g_test_run() may only be called once
 868  * in a program.
 869  *
 870  * Returns: 0 on success
 871  *
 872  * Since: 2.16
 873  */
 874 int
 875 g_test_run (void)
 876 {
 877   return g_test_run_suite (g_test_get_root());
 878 }
 879
 880 /**
 881  * g_test_create_case:
 882  * @test_name:     the name for the test case
 883  * @data_size:     the size of the fixture data structure
 884  * @test_data:     test data argument for the test functions
 885  * @data_setup:    the function to set up the fixture data
 886  * @data_test:     the actual test function
 887  * @data_teardown: the function to teardown the fixture data
 888  *
 889  * Create a new #GTestCase, named @test_name, this API is fairly
 890  * low level, calling g_test_add() or g_test_add_func() is preferable.
 891  * When this test is executed, a fixture structure of size @data_size
 892  * will be allocated and filled with 0s. Then data_setup() is called
 893  * to initialize the fixture. After fixture setup, the actual test
 894  * function data_test() is called. Once the test run completed, the
 895  * fixture structure is torn down  by calling data_teardown() and
 896  * after that the memory is released.
 897  *
 898  * Splitting up a test run into fixture setup, test function and
 899  * fixture teardown is most usful if the same fixture is used for
 900  * multiple tests. In this cases, g_test_create_case() will be
 901  * called with the same fixture, but varying @test_name and
 902  * @data_test arguments.
 903  *
 904  * Returns: a newly allocated #GTestCase.
 905  *
 906  * Since: 2.16
 907  */
 908 GTestCase*
 909 g_test_create_case (const char     *test_name,
 910                     gsize           data_size,
 911                     gconstpointer   test_data,
 912                     void          (*data_setup) (void),
 913                     void          (*data_test) (void),
 914                     void          (*data_teardown) (void))
 915 {
 916   GTestCase *tc;
 917   g_return_val_if_fail (test_name != NULL, NULL);
 918   g_return_val_if_fail (strchr (test_name, '/') == NULL, NULL);
 919   g_return_val_if_fail (test_name[0] != 0, NULL);
 920   g_return_val_if_fail (data_test != NULL, NULL);
 921   tc = g_slice_new0 (GTestCase);
 922   tc->name = g_strdup (test_name);
 923   tc->test_data = (gpointer) test_data;
 924   tc->fixture_size = data_size;
 925   tc->fixture_setup = (void*) data_setup;
 926   tc->fixture_test = (void*) data_test;
 927   tc->fixture_teardown = (void*) data_teardown;
 928   return tc;
 929 }
 930
 931 void
 932 g_test_add_vtable (const char     *testpath,
 933                    gsize           data_size,
 934                    gconstpointer   test_data,
 935                    void          (*data_setup)    (void),
 936                    void          (*fixture_test_func) (void),
 937                    void          (*data_teardown) (void))
 938 {
 939   gchar **segments;
 940   guint ui;
 941   GTestSuite *suite;
 942
 943   g_return_if_fail (testpath != NULL);
 944   g_return_if_fail (testpath[0] == '/');
 945   g_return_if_fail (fixture_test_func != NULL);
 946
 947   suite = g_test_get_root();
 948   segments = g_strsplit (testpath, "/", -1);
 949   for (ui = 0; segments[ui] != NULL; ui++)
 950     {
 951       const char *seg = segments[ui];
 952       gboolean islast = segments[ui + 1] == NULL;
 953       if (islast && !seg[0])
 954         g_error ("invalid test case path: %s", testpath);
 955       else if (!seg[0])
 956         continue;       /* initial or duplicate slash */
 957       else if (!islast)
 958         {
 959           GTestSuite *csuite = g_test_create_suite (seg);
 960           g_test_suite_add_suite (suite, csuite);
 961           suite = csuite;
 962         }
 963       else /* islast */
 964         {
 965           GTestCase *tc = g_test_create_case (seg, data_size, test_data, data_setup, fixture_test_func, data_teardown);
 966           g_test_suite_add (suite, tc);
 967         }
 968     }
 969   g_strfreev (segments);
 970 }
 971
 972 /**
 973  * g_test_add_func:
 974  * @testpath:   Slash-separated test case path name for the test.
 975  * @test_func:  The test function to invoke for this test.
 976  *
 977  * Create a new test case, similar to g_test_create_case(). However
 978  * the test is assumed to use no fixture, and test suites are automatically
 979  * created on the fly and added to the root fixture, based on the
 980  * slash-separated portions of @testpath.
 981  *
 982  * Since: 2.16
 983  */
 984 void
 985 g_test_add_func (const char     *testpath,
 986                  void          (*test_func) (void))
 987 {
 988   g_return_if_fail (testpath != NULL);
 989   g_return_if_fail (testpath[0] == '/');
 990   g_return_if_fail (test_func != NULL);
 991   g_test_add_vtable (testpath, 0, NULL, NULL, test_func, NULL);
 992 }
 993
 994 /**
 995  * g_test_add_data_func:
 996  * @testpath:   Slash-separated test case path name for the test.
 997  * @test_data:  Test data argument for the test function.
 998  * @test_func:  The test function to invoke for this test.
 999  *
1000  * Create a new test case, similar to g_test_create_case(). However
1001  * the test is assumed to use no fixture, and test suites are automatically
1002  * created on the fly and added to the root fixture, based on the
1003  * slash-separated portions of @testpath. The @test_data argument
1004  * will be passed as first argument to @test_func.
1005  *
1006  * Since: 2.16
1007  */
1008 void
1009 g_test_add_data_func (const char     *testpath,
1010                       gconstpointer   test_data,
1011                       void          (*test_func) (gconstpointer))
1012 {
1013   g_return_if_fail (testpath != NULL);
1014   g_return_if_fail (testpath[0] == '/');
1015   g_return_if_fail (test_func != NULL);
1016   g_test_add_vtable (testpath, 0, test_data, NULL, (void(*)(void)) test_func, NULL);
1017 }
1018
1019 /**
1020  * g_test_create_suite:
1021  * @suite_name: a name for the suite
1022  *
1023  * Create a new test suite with the name @suite_name.
1024  *
1025  * Returns: A newly allocated #GTestSuite instance.
1026  *
1027  * Since: 2.16
1028  */
1029 GTestSuite*
1030 g_test_create_suite (const char *suite_name)
1031 {
1032   GTestSuite *ts;
1033   g_return_val_if_fail (suite_name != NULL, NULL);
1034   g_return_val_if_fail (strchr (suite_name, '/') == NULL, NULL);
1035   g_return_val_if_fail (suite_name[0] != 0, NULL);
1036   ts = g_slice_new0 (GTestSuite);
1037   ts->name = g_strdup (suite_name);
1038   return ts;
1039 }
1040
1041 /**
1042  * g_test_suite_add:
1043  * @suite: a #GTestSuite
1044  * @test_case: a #GTestCase
1045  *
1046  * Adds @test_case to @suite.
1047  *
1048  * Since: 2.16
1049  */
1050 void
1051 g_test_suite_add (GTestSuite     *suite,
1052                   GTestCase      *test_case)
1053 {
1054   g_return_if_fail (suite != NULL);
1055   g_return_if_fail (test_case != NULL);
1056   suite->cases = g_slist_prepend (suite->cases, test_case);
1057 }
1058
1059 /**
1060  * g_test_suite_add_suite:
1061  * @suite:       a #GTestSuite
1062  * @nestedsuite: another #GTestSuite
1063  *
1064  * Adds @nestedsuite to @suite.
1065  *
1066  * Since: 2.16
1067  */
1068 void
1069 g_test_suite_add_suite (GTestSuite     *suite,
1070                         GTestSuite     *nestedsuite)
1071 {
1072   g_return_if_fail (suite != NULL);
1073   g_return_if_fail (nestedsuite != NULL);
1074   suite->suites = g_slist_prepend (suite->suites, nestedsuite);
1075 }
1076
1077 /**
1078  * g_test_queue_free:
1079  * @gfree_pointer: the pointer to be stored.
1080  *
1081  * Enqueue a pointer to be released with g_free() during the next
1082  * teardown phase. This is equivalent to calling g_test_queue_destroy()
1083  * with a destroy callback of g_free().
1084  *
1085  * Since: 2.16
1086  */
1087 void
1088 g_test_queue_free (gpointer gfree_pointer)
1089 {
1090   if (gfree_pointer)
1091     g_test_queue_destroy (g_free, gfree_pointer);
1092 }
1093
1094 /**
1095  * g_test_queue_destroy:
1096  * @destroy_func:       Destroy callback for teardown phase.
1097  * @destroy_data:       Destroy callback data.
1098  *
1099  * This function enqueus a callback @destroy_func() to be executed
1100  * during the next test case teardown phase. This is most useful
1101  * to auto destruct allocted test resources at the end of a test run.
1102  * Resources are released in reverse queue order, that means enqueueing
1103  * callback A before callback B will cause B() to be called before
1104  * A() during teardown.
1105  *
1106  * Since: 2.16
1107  */
1108 void
1109 g_test_queue_destroy (GDestroyNotify destroy_func,
1110                       gpointer       destroy_data)
1111 {
1112   DestroyEntry *dentry;
1113   g_return_if_fail (destroy_func != NULL);
1114   dentry = g_slice_new0 (DestroyEntry);
1115   dentry->destroy_func = destroy_func;
1116   dentry->destroy_data = destroy_data;
1117   dentry->next = test_destroy_queue;
1118   test_destroy_queue = dentry;
1119 }
1120
1121 static int
1122 test_case_run (GTestCase *tc)
1123 {
1124   gchar *old_name = test_run_name, *old_base = g_strdup (test_uri_base);
1125   test_run_name = g_strconcat (old_name, "/", tc->name, NULL);
1126   if (++test_run_count <= test_skip_count)
1127     g_test_log (G_TEST_LOG_SKIP_CASE, test_run_name, NULL, 0, NULL);
1128   else if (test_run_list)
1129     {
1130       g_print ("%s\n", test_run_name);
1131       g_test_log (G_TEST_LOG_LIST_CASE, test_run_name, NULL, 0, NULL);
1132     }
1133   else
1134     {
1135       GTimer *test_run_timer = g_timer_new();
1136       long double largs[3];
1137       void *fixture;
1138       g_test_log (G_TEST_LOG_START_CASE, test_run_name, NULL, 0, NULL);
1139       test_run_forks = 0;
1140       g_test_log_set_fatal_handler (NULL, NULL);
1141       g_timer_start (test_run_timer);
1142       fixture = tc->fixture_size ? g_malloc0 (tc->fixture_size) : tc->test_data;
1143       test_run_seed (test_run_seedstr);
1144       if (tc->fixture_setup)
1145         tc->fixture_setup (fixture, tc->test_data);
1146       tc->fixture_test (fixture, tc->test_data);
1147       test_trap_clear();
1148       while (test_destroy_queue)
1149         {
1150           DestroyEntry *dentry = test_destroy_queue;
1151           test_destroy_queue = dentry->next;
1152           dentry->destroy_func (dentry->destroy_data);
1153           g_slice_free (DestroyEntry, dentry);
1154         }
1155       if (tc->fixture_teardown)
1156         tc->fixture_teardown (fixture, tc->test_data);
1157       if (tc->fixture_size)
1158         g_free (fixture);
1159       g_timer_stop (test_run_timer);
1160       largs[0] = 0; /* OK */
1161       largs[1] = test_run_forks;
1162       largs[2] = g_timer_elapsed (test_run_timer, NULL);
1163       g_test_log (G_TEST_LOG_STOP_CASE, NULL, NULL, G_N_ELEMENTS (largs), largs);
1164       g_timer_destroy (test_run_timer);
1165     }
1166   g_free (test_run_name);
1167   test_run_name = old_name;
1168   g_free (test_uri_base);
1169   test_uri_base = old_base;
1170   return 0;
1171 }
1172
1173 static int
1174 g_test_run_suite_internal (GTestSuite *suite,
1175                            const char *path)
1176 {
1177   guint n_bad = 0, n_good = 0, bad_suite = 0, l;
1178   gchar *rest, *old_name = test_run_name;
1179   GSList *slist, *reversed;
1180   g_return_val_if_fail (suite != NULL, -1);
1181   while (path[0] == '/')
1182     path++;
1183   l = strlen (path);
1184   rest = strchr (path, '/');
1185   l = rest ? MIN (l, rest - path) : l;
1186   test_run_name = suite->name[0] == 0 ? g_strdup (test_run_name) : g_strconcat (old_name, "/", suite->name, NULL);
1187   reversed = g_slist_reverse (g_slist_copy (suite->cases));
1188   for (slist = reversed; slist; slist = slist->next)
1189     {
1190       GTestCase *tc = slist->data;
1191       guint n = l ? strlen (tc->name) : 0;
1192       if (l == n && strncmp (path, tc->name, n) == 0)
1193         {
1194           n_good++;
1195           n_bad += test_case_run (tc) != 0;
1196         }
1197     }
1198   g_slist_free (reversed);
1199   reversed = g_slist_reverse (g_slist_copy (suite->suites));
1200   for (slist = reversed; slist; slist = slist->next)
1201     {
1202       GTestSuite *ts = slist->data;
1203       guint n = l ? strlen (ts->name) : 0;
1204       if (l == n && strncmp (path, ts->name, n) == 0)
1205         bad_suite += g_test_run_suite_internal (ts, rest ? rest : "") != 0;
1206     }
1207   g_slist_free (reversed);
1208   g_free (test_run_name);
1209   test_run_name = old_name;
1210   return n_bad || bad_suite;
1211 }
1212
1213 /**
1214  * g_test_run_suite:
1215  * @suite: a #GTestSuite
1216  *
1217  * Execute the tests within @suite and all nested #GTestSuites.
1218  * The test suites to be executed are filtered according to
1219  * test path arguments (-p <replaceable>testpath</replaceable>)
1220  * as parsed by g_test_init().
1221  * g_test_run_suite() or g_test_run() may only be called once
1222  * in a program.
1223  *
1224  * Returns: 0 on success
1225  *
1226  * Since: 2.16
1227  */
1228 int
1229 g_test_run_suite (GTestSuite *suite)
1230 {
1231   guint n_bad = 0;
1232   g_return_val_if_fail (g_test_config_vars->test_initialized, -1);
1233   g_return_val_if_fail (g_test_run_once == TRUE, -1);
1234   g_test_run_once = FALSE;
1235   if (!test_paths)
1236     test_paths = g_slist_prepend (test_paths, "");
1237   while (test_paths)
1238     {
1239       const char *rest, *path = test_paths->data;
1240       guint l, n = strlen (suite->name);
1241       test_paths = g_slist_delete_link (test_paths, test_paths);
1242       while (path[0] == '/')
1243         path++;
1244       if (!n) /* root suite, run unconditionally */
1245         {
1246           n_bad += 0 != g_test_run_suite_internal (suite, path);
1247           continue;
1248         }
1249       /* regular suite, match path */
1250       rest = strchr (path, '/');
1251       l = strlen (path);
1252       l = rest ? MIN (l, rest - path) : l;
1253       if ((!l || l == n) && strncmp (path, suite->name, n) == 0)
1254         n_bad += 0 != g_test_run_suite_internal (suite, rest ? rest : "");
1255     }
1256   return n_bad;
1257 }
1258
1259 static void
1260 gtest_default_log_handler (const gchar    *log_domain,
1261                            GLogLevelFlags  log_level,
1262                            const gchar    *message,
1263                            gpointer        unused_data)
1264 {
1265   const gchar *strv[16];
1266   gboolean fatal = FALSE;
1267   gchar *msg;
1268   guint i = 0;
1269   if (log_domain)
1270     {
1271       strv[i++] = log_domain;
1272       strv[i++] = "-";
1273     }
1274   if (log_level & G_LOG_FLAG_FATAL)
1275     {
1276       strv[i++] = "FATAL-";
1277       fatal = TRUE;
1278     }
1279   if (log_level & G_LOG_FLAG_RECURSION)
1280     strv[i++] = "RECURSIVE-";
1281   if (log_level & G_LOG_LEVEL_ERROR)
1282     strv[i++] = "ERROR";
1283   if (log_level & G_LOG_LEVEL_CRITICAL)
1284     strv[i++] = "CRITICAL";
1285   if (log_level & G_LOG_LEVEL_WARNING)
1286     strv[i++] = "WARNING";
1287   if (log_level & G_LOG_LEVEL_MESSAGE)
1288     strv[i++] = "MESSAGE";
1289   if (log_level & G_LOG_LEVEL_INFO)
1290     strv[i++] = "INFO";
1291   if (log_level & G_LOG_LEVEL_DEBUG)
1292     strv[i++] = "DEBUG";
1293   strv[i++] = ": ";
1294   strv[i++] = message;
1295   strv[i++] = NULL;
1296   msg = g_strjoinv ("", (gchar**) strv);
1297   g_test_log (fatal ? G_TEST_LOG_ERROR : G_TEST_LOG_MESSAGE, msg, NULL, 0, NULL);
1298   g_log_default_handler (log_domain, log_level, message, unused_data);
1299   g_free (msg);
1300 }
1301
1302 void
1303 g_assertion_message (const char     *domain,
1304                      const char     *file,
1305                      int             line,
1306                      const char     *func,
1307                      const char     *message)
1308 {
1309   char lstr[32];
1310   char *s;
1311   if (!message)
1312     message = "code should not be reached";
1313   g_snprintf (lstr, 32, "%d", line);
1314   s = g_strconcat (domain ? domain : "", domain && domain[0] ? ":" : "",
1315                    "ERROR:", file, ":", lstr, ":",
1316                    func, func[0] ? ":" : "",
1317                    " ", message, NULL);
1318   g_printerr ("**\n%s\n", s);
1319
1320   /* store assertion message in global variable, so that it can be found in a
1321    * core dump */
1322   if (__glib_assert_msg != NULL)
1323       /* free the old one */
1324       free (__glib_assert_msg);
1325   __glib_assert_msg = (char*) malloc (strlen (s) + 1);
1326   strcpy (__glib_assert_msg, s);
1327
1328   g_test_log (G_TEST_LOG_ERROR, s, NULL, 0, NULL);
1329   g_free (s);
1330   abort();
1331 }
1332
1333 void
1334 g_assertion_message_expr (const char     *domain,
1335                           const char     *file,
1336                           int             line,
1337                           const char     *func,
1338                           const char     *expr)
1339 {
1340   char *s = g_strconcat ("assertion failed: (", expr, ")", NULL);
1341   g_assertion_message (domain, file, line, func, s);
1342   g_free (s);
1343 }
1344
1345 void
1346 g_assertion_message_cmpnum (const char     *domain,
1347                             const char     *file,
1348                             int             line,
1349                             const char     *func,
1350                             const char     *expr,
1351                             long double     arg1,
1352                             const char     *cmp,
1353                             long double     arg2,
1354                             char            numtype)
1355 {
1356   char *s = NULL;
1357   switch (numtype)
1358     {
1359     case 'i':   s = g_strdup_printf ("assertion failed (%s): (%.0Lf %s %.0Lf)", expr, arg1, cmp, arg2); break;
1360     case 'x':   s = g_strdup_printf ("assertion failed (%s): (0x%08" G_GINT64_MODIFIER "x %s 0x%08" G_GINT64_MODIFIER "x)", expr, (guint64) arg1, cmp, (guint64) arg2); break;
1361     case 'f':   s = g_strdup_printf ("assertion failed (%s): (%.9Lg %s %.9Lg)", expr, arg1, cmp, arg2); break;
1362       /* ideally use: floats=%.7g double=%.17g */
1363     }
1364   g_assertion_message (domain, file, line, func, s);
1365   g_free (s);
1366 }
1367
1368 void
1369 g_assertion_message_cmpstr (const char     *domain,
1370                             const char     *file,
1371                             int             line,
1372                             const char     *func,
1373                             const char     *expr,
1374                             const char     *arg1,
1375                             const char     *cmp,
1376                             const char     *arg2)
1377 {
1378   char *a1, *a2, *s, *t1 = NULL, *t2 = NULL;
1379   a1 = arg1 ? g_strconcat ("\"", t1 = g_strescape (arg1, NULL), "\"", NULL) : g_strdup ("NULL");
1380   a2 = arg2 ? g_strconcat ("\"", t2 = g_strescape (arg2, NULL), "\"", NULL) : g_strdup ("NULL");
1381   g_free (t1);
1382   g_free (t2);
1383   s = g_strdup_printf ("assertion failed (%s): (%s %s %s)", expr, a1, cmp, a2);
1384   g_free (a1);
1385   g_free (a2);
1386   g_assertion_message (domain, file, line, func, s);
1387   g_free (s);
1388 }
1389
1390 void
1391 g_assertion_message_error (const char     *domain,
1392                            const char     *file,
1393                            int             line,
1394                            const char     *func,
1395                            const char     *expr,
1396                            const GError   *error,
1397                            GQuark          error_domain,
1398                            int             error_code)
1399 {
1400   GString *gstring;
1401
1402   /* This is used by both g_assert_error() and g_assert_no_error(), so there
1403    * are three cases: expected an error but got the wrong error, expected
1404    * an error but got no error, and expected no error but got an error.
1405    */
1406
1407   gstring = g_string_new ("assertion failed ");
1408   if (error_domain)
1409       g_string_append_printf (gstring, "(%s == (%s, %d)): ", expr,
1410                               g_quark_to_string (error_domain), error_code);
1411   else
1412     g_string_append_printf (gstring, "(%s == NULL): ", expr);
1413
1414   if (error)
1415       g_string_append_printf (gstring, "%s (%s, %d)", error->message,
1416                               g_quark_to_string (error->domain), error->code);
1417   else
1418     g_string_append_printf (gstring, "%s is NULL", expr);
1419
1420   g_assertion_message (domain, file, line, func, gstring->str);
1421   g_string_free (gstring, TRUE);
1422 }
1423
1424 /**
1425  * g_strcmp0:
1426  * @str1: a C string or %NULL
1427  * @str2: another C string or %NULL
1428  *
1429  * Compares @str1 and @str2 like strcmp(). Handles %NULL
1430  * gracefully by sorting it before non-%NULL strings.
1431  * Comparing two %NULL pointers returns 0.
1432  *
1433  * Returns: -1, 0 or 1, if @str1 is <, == or > than @str2.
1434  *
1435  * Since: 2.16
1436  */
1437 int
1438 g_strcmp0 (const char     *str1,
1439            const char     *str2)
1440 {
1441   if (!str1)
1442     return -(str1 != str2);
1443   if (!str2)
1444     return str1 != str2;
1445   return strcmp (str1, str2);
1446 }
1447
1448 #ifdef G_OS_UNIX
1449 static int /* 0 on success */
1450 kill_child (int  pid,
1451             int *status,
1452             int  patience)
1453 {
1454   int wr;
1455   if (patience >= 3)    /* try graceful reap */
1456     {
1457       if (waitpid (pid, status, WNOHANG) > 0)
1458         return 0;
1459     }
1460   if (patience >= 2)    /* try SIGHUP */
1461     {
1462       kill (pid, SIGHUP);
1463       if (waitpid (pid, status, WNOHANG) > 0)
1464         return 0;
1465       g_usleep (20 * 1000); /* give it some scheduling/shutdown time */
1466       if (waitpid (pid, status, WNOHANG) > 0)
1467         return 0;
1468       g_usleep (50 * 1000); /* give it some scheduling/shutdown time */
1469       if (waitpid (pid, status, WNOHANG) > 0)
1470         return 0;
1471       g_usleep (100 * 1000); /* give it some scheduling/shutdown time */
1472       if (waitpid (pid, status, WNOHANG) > 0)
1473         return 0;
1474     }
1475   if (patience >= 1)    /* try SIGTERM */
1476     {
1477       kill (pid, SIGTERM);
1478       if (waitpid (pid, status, WNOHANG) > 0)
1479         return 0;
1480       g_usleep (200 * 1000); /* give it some scheduling/shutdown time */
1481       if (waitpid (pid, status, WNOHANG) > 0)
1482         return 0;
1483       g_usleep (400 * 1000); /* give it some scheduling/shutdown time */
1484       if (waitpid (pid, status, WNOHANG) > 0)
1485         return 0;
1486     }
1487   /* finish it off */
1488   kill (pid, SIGKILL);
1489   do
1490     wr = waitpid (pid, status, 0);
1491   while (wr < 0 && errno == EINTR);
1492   return wr;
1493 }
1494 #endif
1495
1496 static inline int
1497 g_string_must_read (GString *gstring,
1498                     int      fd)
1499 {
1500 #define STRING_BUFFER_SIZE     4096
1501   char buf[STRING_BUFFER_SIZE];
1502   gssize bytes;
1503  again:
1504   bytes = read (fd, buf, sizeof (buf));
1505   if (bytes == 0)
1506     return 0; /* EOF, calling this function assumes data is available */
1507   else if (bytes > 0)
1508     {
1509       g_string_append_len (gstring, buf, bytes);
1510       return 1;
1511     }
1512   else if (bytes < 0 && errno == EINTR)
1513     goto again;
1514   else /* bytes < 0 */
1515     {
1516       g_warning ("failed to read() from child process (%d): %s", test_trap_last_pid, g_strerror (errno));
1517       return 1; /* ignore error after warning */
1518     }
1519 }
1520
1521 static inline void
1522 g_string_write_out (GString *gstring,
1523                     int      outfd,
1524                     int     *stringpos)
1525 {
1526   if (*stringpos < gstring->len)
1527     {
1528       int r;
1529       do
1530         r = write (outfd, gstring->str + *stringpos, gstring->len - *stringpos);
1531       while (r < 0 && errno == EINTR);
1532       *stringpos += MAX (r, 0);
1533     }
1534 }
1535
1536 static void
1537 test_trap_clear (void)
1538 {
1539   test_trap_last_status = 0;
1540   test_trap_last_pid = 0;
1541   g_free (test_trap_last_stdout);
1542   test_trap_last_stdout = NULL;
1543   g_free (test_trap_last_stderr);
1544   test_trap_last_stderr = NULL;
1545 }
1546
1547 #ifdef G_OS_UNIX
1548
1549 static int
1550 sane_dup2 (int fd1,
1551            int fd2)
1552 {
1553   int ret;
1554   do
1555     ret = dup2 (fd1, fd2);
1556   while (ret < 0 && errno == EINTR);
1557   return ret;
1558 }
1559
1560 static guint64
1561 test_time_stamp (void)
1562 {
1563   GTimeVal tv;
1564   guint64 stamp;
1565   g_get_current_time (&tv);
1566   stamp = tv.tv_sec;
1567   stamp = stamp * 1000000 + tv.tv_usec;
1568   return stamp;
1569 }
1570
1571 #endif
1572
1573 /**
1574  * g_test_trap_fork:
1575  * @usec_timeout:    Timeout for the forked test in micro seconds.
1576  * @test_trap_flags: Flags to modify forking behaviour.
1577  *
1578  * Fork the current test program to execute a test case that might
1579  * not return or that might abort. The forked test case is aborted
1580  * and considered failing if its run time exceeds @usec_timeout.
1581  *
1582  * The forking behavior can be configured with the #GTestTrapFlags flags.
1583  *
1584  * In the following example, the test code forks, the forked child
1585  * process produces some sample output and exits successfully.
1586  * The forking parent process then asserts successful child program
1587  * termination and validates child program outputs.
1588  *
1589  * |[
1590  *   static void
1591  *   test_fork_patterns (void)
1592  *   {
1593  *     if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
1594  *       {
1595  *         g_print ("some stdout text: somagic17\n");
1596  *         g_printerr ("some stderr text: semagic43\n");
1597  *         exit (0); /&ast; successful test run &ast;/
1598  *       }
1599  *     g_test_trap_assert_passed();
1600  *     g_test_trap_assert_stdout ("*somagic17*");
1601  *     g_test_trap_assert_stderr ("*semagic43*");
1602  *   }
1603  * ]|
1604  *
1605  * This function is implemented only on Unix platforms.
1606  *
1607  * Returns: %TRUE for the forked child and %FALSE for the executing parent process.
1608  *
1609  * Since: 2.16
1610  */
1611 gboolean
1612 g_test_trap_fork (guint64        usec_timeout,
1613                   GTestTrapFlags test_trap_flags)
1614 {
1615 #ifdef G_OS_UNIX
1616   gboolean pass_on_forked_log = FALSE;
1617   int stdout_pipe[2] = { -1, -1 };
1618   int stderr_pipe[2] = { -1, -1 };
1619   int stdtst_pipe[2] = { -1, -1 };
1620   test_trap_clear();
1621   if (pipe (stdout_pipe) < 0 || pipe (stderr_pipe) < 0 || pipe (stdtst_pipe) < 0)
1622     g_error ("failed to create pipes to fork test program: %s", g_strerror (errno));
1623   signal (SIGCHLD, SIG_DFL);
1624   test_trap_last_pid = fork ();
1625   if (test_trap_last_pid < 0)
1626     g_error ("failed to fork test program: %s", g_strerror (errno));
1627   if (test_trap_last_pid == 0)  /* child */
1628     {
1629       int fd0 = -1;
1630       close (stdout_pipe[0]);
1631       close (stderr_pipe[0]);
1632       close (stdtst_pipe[0]);
1633       if (!(test_trap_flags & G_TEST_TRAP_INHERIT_STDIN))
1634         fd0 = open ("/dev/null", O_RDONLY);
1635       if (sane_dup2 (stdout_pipe[1], 1) < 0 || sane_dup2 (stderr_pipe[1], 2) < 0 || (fd0 >= 0 && sane_dup2 (fd0, 0) < 0))
1636         g_error ("failed to dup2() in forked test program: %s", g_strerror (errno));
1637       if (fd0 >= 3)
1638         close (fd0);
1639       if (stdout_pipe[1] >= 3)
1640         close (stdout_pipe[1]);
1641       if (stderr_pipe[1] >= 3)
1642         close (stderr_pipe[1]);
1643       test_log_fd = stdtst_pipe[1];
1644       return TRUE;
1645     }
1646   else                          /* parent */
1647     {
1648       GString *sout = g_string_new (NULL);
1649       GString *serr = g_string_new (NULL);
1650       guint64 sstamp;
1651       int soutpos = 0, serrpos = 0, wr, need_wait = TRUE;
1652       test_run_forks++;
1653       close (stdout_pipe[1]);
1654       close (stderr_pipe[1]);
1655       close (stdtst_pipe[1]);
1656       sstamp = test_time_stamp();
1657       /* read data until we get EOF on all pipes */
1658       while (stdout_pipe[0] >= 0 || stderr_pipe[0] >= 0 || stdtst_pipe[0] > 0)
1659         {
1660           fd_set fds;
1661           struct timeval tv;
1662           int ret;
1663           FD_ZERO (&fds);
1664           if (stdout_pipe[0] >= 0)
1665             FD_SET (stdout_pipe[0], &fds);
1666           if (stderr_pipe[0] >= 0)
1667             FD_SET (stderr_pipe[0], &fds);
1668           if (stdtst_pipe[0] >= 0)
1669             FD_SET (stdtst_pipe[0], &fds);
1670           tv.tv_sec = 0;
1671           tv.tv_usec = MIN (usec_timeout ? usec_timeout : 1000000, 100 * 1000); /* sleep at most 0.5 seconds to catch clock skews, etc. */
1672           ret = select (MAX (MAX (stdout_pipe[0], stderr_pipe[0]), stdtst_pipe[0]) + 1, &fds, NULL, NULL, &tv);
1673           if (ret < 0 && errno != EINTR)
1674             {
1675               g_warning ("Unexpected error in select() while reading from child process (%d): %s", test_trap_last_pid, g_strerror (errno));
1676               break;
1677             }
1678           if (stdout_pipe[0] >= 0 && FD_ISSET (stdout_pipe[0], &fds) &&
1679               g_string_must_read (sout, stdout_pipe[0]) == 0)
1680             {
1681               close (stdout_pipe[0]);
1682               stdout_pipe[0] = -1;
1683             }
1684           if (stderr_pipe[0] >= 0 && FD_ISSET (stderr_pipe[0], &fds) &&
1685               g_string_must_read (serr, stderr_pipe[0]) == 0)
1686             {
1687               close (stderr_pipe[0]);
1688               stderr_pipe[0] = -1;
1689             }
1690           if (stdtst_pipe[0] >= 0 && FD_ISSET (stdtst_pipe[0], &fds))
1691             {
1692               guint8 buffer[4096];
1693               gint l, r = read (stdtst_pipe[0], buffer, sizeof (buffer));
1694               if (r > 0 && test_log_fd > 0)
1695                 do
1696                   l = write (pass_on_forked_log ? test_log_fd : -1, buffer, r);
1697                 while (l < 0 && errno == EINTR);
1698               if (r == 0 || (r < 0 && errno != EINTR && errno != EAGAIN))
1699                 {
1700                   close (stdtst_pipe[0]);
1701                   stdtst_pipe[0] = -1;
1702                 }
1703             }
1704           if (!(test_trap_flags & G_TEST_TRAP_SILENCE_STDOUT))
1705             g_string_write_out (sout, 1, &soutpos);
1706           if (!(test_trap_flags & G_TEST_TRAP_SILENCE_STDERR))
1707             g_string_write_out (serr, 2, &serrpos);
1708           if (usec_timeout)
1709             {
1710               guint64 nstamp = test_time_stamp();
1711               int status = 0;
1712               sstamp = MIN (sstamp, nstamp); /* guard against backwards clock skews */
1713               if (usec_timeout < nstamp - sstamp)
1714                 {
1715                   /* timeout reached, need to abort the child now */
1716                   kill_child (test_trap_last_pid, &status, 3);
1717                   test_trap_last_status = 1024; /* timeout */
1718                   if (0 && WIFSIGNALED (status))
1719                     g_printerr ("%s: child timed out and received: %s\n", G_STRFUNC, g_strsignal (WTERMSIG (status)));
1720                   need_wait = FALSE;
1721                   break;
1722                 }
1723             }
1724         }
1725       close (stdout_pipe[0]);
1726       close (stderr_pipe[0]);
1727       close (stdtst_pipe[0]);
1728       if (need_wait)
1729         {
1730           int status = 0;
1731           do
1732             wr = waitpid (test_trap_last_pid, &status, 0);
1733           while (wr < 0 && errno == EINTR);
1734           if (WIFEXITED (status)) /* normal exit */
1735             test_trap_last_status = WEXITSTATUS (status); /* 0..255 */
1736           else if (WIFSIGNALED (status))
1737             test_trap_last_status = (WTERMSIG (status) << 12); /* signalled */
1738           else /* WCOREDUMP (status) */
1739             test_trap_last_status = 512; /* coredump */
1740         }
1741       test_trap_last_stdout = g_string_free (sout, FALSE);
1742       test_trap_last_stderr = g_string_free (serr, FALSE);
1743       return FALSE;
1744     }
1745 #else
1746   g_message ("Not implemented: g_test_trap_fork");
1747
1748   return FALSE;
1749 #endif
1750 }
1751
1752 /**
1753  * g_test_trap_has_passed:
1754  *
1755  * Check the result of the last g_test_trap_fork() call.
1756  *
1757  * Returns: %TRUE if the last forked child terminated successfully.
1758  *
1759  * Since: 2.16
1760  */
1761 gboolean
1762 g_test_trap_has_passed (void)
1763 {
1764   return test_trap_last_status == 0; /* exit_status == 0 && !signal && !coredump */
1765 }
1766
1767 /**
1768  * g_test_trap_reached_timeout:
1769  *
1770  * Check the result of the last g_test_trap_fork() call.
1771  *
1772  * Returns: %TRUE if the last forked child got killed due to a fork timeout.
1773  *
1774  * Since: 2.16
1775  */
1776 gboolean
1777 g_test_trap_reached_timeout (void)
1778 {
1779   return 0 != (test_trap_last_status & 1024); /* timeout flag */
1780 }
1781
1782 void
1783 g_test_trap_assertions (const char     *domain,
1784                         const char     *file,
1785                         int             line,
1786                         const char     *func,
1787                         guint64         assertion_flags, /* 0-pass, 1-fail, 2-outpattern, 4-errpattern */
1788                         const char     *pattern)
1789 {
1790 #ifdef G_OS_UNIX
1791   gboolean must_pass = assertion_flags == 0;
1792   gboolean must_fail = assertion_flags == 1;
1793   gboolean match_result = 0 == (assertion_flags & 1);
1794   const char *stdout_pattern = (assertion_flags & 2) ? pattern : NULL;
1795   const char *stderr_pattern = (assertion_flags & 4) ? pattern : NULL;
1796   const char *match_error = match_result ? "failed to match" : "contains invalid match";
1797   if (test_trap_last_pid == 0)
1798     g_error ("child process failed to exit after g_test_trap_fork() and before g_test_trap_assert*()");
1799   if (must_pass && !g_test_trap_has_passed())
1800     {
1801       char *msg = g_strdup_printf ("child process (%d) of test trap failed unexpectedly", test_trap_last_pid);
1802       g_assertion_message (domain, file, line, func, msg);
1803       g_free (msg);
1804     }
1805   if (must_fail && g_test_trap_has_passed())
1806     {
1807       char *msg = g_strdup_printf ("child process (%d) did not fail as expected", test_trap_last_pid);
1808       g_assertion_message (domain, file, line, func, msg);
1809       g_free (msg);
1810     }
1811   if (stdout_pattern && match_result == !g_pattern_match_simple (stdout_pattern, test_trap_last_stdout))
1812     {
1813       char *msg = g_strdup_printf ("stdout of child process (%d) %s: %s", test_trap_last_pid, match_error, stdout_pattern);
1814       g_assertion_message (domain, file, line, func, msg);
1815       g_free (msg);
1816     }
1817   if (stderr_pattern && match_result == !g_pattern_match_simple (stderr_pattern, test_trap_last_stderr))
1818     {
1819       char *msg = g_strdup_printf ("stderr of child process (%d) %s: %s", test_trap_last_pid, match_error, stderr_pattern);
1820       g_assertion_message (domain, file, line, func, msg);
1821       g_free (msg);
1822     }
1823 #endif
1824 }
1825
1826 static void
1827 gstring_overwrite_int (GString *gstring,
1828                        guint    pos,
1829                        guint32  vuint)
1830 {
1831   vuint = g_htonl (vuint);
1832   g_string_overwrite_len (gstring, pos, (const gchar*) &vuint, 4);
1833 }
1834
1835 static void
1836 gstring_append_int (GString *gstring,
1837                     guint32  vuint)
1838 {
1839   vuint = g_htonl (vuint);
1840   g_string_append_len (gstring, (const gchar*) &vuint, 4);
1841 }
1842
1843 static void
1844 gstring_append_double (GString *gstring,
1845                        double   vdouble)
1846 {
1847   union { double vdouble; guint64 vuint64; } u;
1848   u.vdouble = vdouble;
1849   u.vuint64 = GUINT64_TO_BE (u.vuint64);
1850   g_string_append_len (gstring, (const gchar*) &u.vuint64, 8);
1851 }
1852
1853 static guint8*
1854 g_test_log_dump (GTestLogMsg *msg,
1855                  guint       *len)
1856 {
1857   GString *gstring = g_string_sized_new (1024);
1858   guint ui;
1859   gstring_append_int (gstring, 0);              /* message length */
1860   gstring_append_int (gstring, msg->log_type);
1861   gstring_append_int (gstring, msg->n_strings);
1862   gstring_append_int (gstring, msg->n_nums);
1863   gstring_append_int (gstring, 0);      /* reserved */
1864   for (ui = 0; ui < msg->n_strings; ui++)
1865     {
1866       guint l = strlen (msg->strings[ui]);
1867       gstring_append_int (gstring, l);
1868       g_string_append_len (gstring, msg->strings[ui], l);
1869     }
1870   for (ui = 0; ui < msg->n_nums; ui++)
1871     gstring_append_double (gstring, msg->nums[ui]);
1872   *len = gstring->len;
1873   gstring_overwrite_int (gstring, 0, *len);     /* message length */
1874   return (guint8*) g_string_free (gstring, FALSE);
1875 }
1876
1877 static inline long double
1878 net_double (const gchar **ipointer)
1879 {
1880   union { guint64 vuint64; double vdouble; } u;
1881   guint64 aligned_int64;
1882   memcpy (&aligned_int64, *ipointer, 8);
1883   *ipointer += 8;
1884   u.vuint64 = GUINT64_FROM_BE (aligned_int64);
1885   return u.vdouble;
1886 }
1887
1888 static inline guint32
1889 net_int (const gchar **ipointer)
1890 {
1891   guint32 aligned_int;
1892   memcpy (&aligned_int, *ipointer, 4);
1893   *ipointer += 4;
1894   return g_ntohl (aligned_int);
1895 }
1896
1897 static gboolean
1898 g_test_log_extract (GTestLogBuffer *tbuffer)
1899 {
1900   const gchar *p = tbuffer->data->str;
1901   GTestLogMsg msg;
1902   guint mlength;
1903   if (tbuffer->data->len < 4 * 5)
1904     return FALSE;
1905   mlength = net_int (&p);
1906   if (tbuffer->data->len < mlength)
1907     return FALSE;
1908   msg.log_type = net_int (&p);
1909   msg.n_strings = net_int (&p);
1910   msg.n_nums = net_int (&p);
1911   if (net_int (&p) == 0)
1912     {
1913       guint ui;
1914       msg.strings = g_new0 (gchar*, msg.n_strings + 1);
1915       msg.nums = g_new0 (long double, msg.n_nums);
1916       for (ui = 0; ui < msg.n_strings; ui++)
1917         {
1918           guint sl = net_int (&p);
1919           msg.strings[ui] = g_strndup (p, sl);
1920           p += sl;
1921         }
1922       for (ui = 0; ui < msg.n_nums; ui++)
1923         msg.nums[ui] = net_double (&p);
1924       if (p <= tbuffer->data->str + mlength)
1925         {
1926           g_string_erase (tbuffer->data, 0, mlength);
1927           tbuffer->msgs = g_slist_prepend (tbuffer->msgs, g_memdup (&msg, sizeof (msg)));
1928           return TRUE;
1929         }
1930     }
1931   g_free (msg.nums);
1932   g_strfreev (msg.strings);
1933   g_error ("corrupt log stream from test program");
1934   return FALSE;
1935 }
1936
1937 /**
1938  * g_test_log_buffer_new:
1939  *
1940  * Internal function for gtester to decode test log messages, no ABI guarantees provided.
1941  */
1942 GTestLogBuffer*
1943 g_test_log_buffer_new (void)
1944 {
1945   GTestLogBuffer *tb = g_new0 (GTestLogBuffer, 1);
1946   tb->data = g_string_sized_new (1024);
1947   return tb;
1948 }
1949
1950 /**
1951  * g_test_log_buffer_free
1952  *
1953  * Internal function for gtester to free test log messages, no ABI guarantees provided.
1954  */
1955 void
1956 g_test_log_buffer_free (GTestLogBuffer *tbuffer)
1957 {
1958   g_return_if_fail (tbuffer != NULL);
1959   while (tbuffer->msgs)
1960     g_test_log_msg_free (g_test_log_buffer_pop (tbuffer));
1961   g_string_free (tbuffer->data, TRUE);
1962   g_free (tbuffer);
1963 }
1964
1965 /**
1966  * g_test_log_buffer_push
1967  *
1968  * Internal function for gtester to decode test log messages, no ABI guarantees provided.
1969  */
1970 void
1971 g_test_log_buffer_push (GTestLogBuffer *tbuffer,
1972                         guint           n_bytes,
1973                         const guint8   *bytes)
1974 {
1975   g_return_if_fail (tbuffer != NULL);
1976   if (n_bytes)
1977     {
1978       gboolean more_messages;
1979       g_return_if_fail (bytes != NULL);
1980       g_string_append_len (tbuffer->data, (const gchar*) bytes, n_bytes);
1981       do
1982         more_messages = g_test_log_extract (tbuffer);
1983       while (more_messages);
1984     }
1985 }
1986
1987 /**
1988  * g_test_log_buffer_pop:
1989  *
1990  * Internal function for gtester to retrieve test log messages, no ABI guarantees provided.
1991  */
1992 GTestLogMsg*
1993 g_test_log_buffer_pop (GTestLogBuffer *tbuffer)
1994 {
1995   GTestLogMsg *msg = NULL;
1996   g_return_val_if_fail (tbuffer != NULL, NULL);
1997   if (tbuffer->msgs)
1998     {
1999       GSList *slist = g_slist_last (tbuffer->msgs);
2000       msg = slist->data;
2001       tbuffer->msgs = g_slist_delete_link (tbuffer->msgs, slist);
2002     }
2003   return msg;
2004 }
2005
2006 /**
2007  * g_test_log_msg_free:
2008  *
2009  * Internal function for gtester to free test log messages, no ABI guarantees provided.
2010  */
2011 void
2012 g_test_log_msg_free (GTestLogMsg *tmsg)
2013 {
2014   g_return_if_fail (tmsg != NULL);
2015   g_strfreev (tmsg->strings);
2016   g_free (tmsg->nums);
2017   g_free (tmsg);
2018 }
2019
2020 /* --- macros docs START --- */
2021 /**
2022  * g_test_add:
2023  * @testpath:  The test path for a new test case.
2024  * @Fixture:   The type of a fixture data structure.
2025  * @tdata:     Data argument for the test functions.
2026  * @fsetup:    The function to set up the fixture data.
2027  * @ftest:     The actual test function.
2028  * @fteardown: The function to tear down the fixture data.
2029  *
2030  * Hook up a new test case at @testpath, similar to g_test_add_func().
2031  * A fixture data structure with setup and teardown function may be provided
2032  * though, similar to g_test_create_case().
2033  * g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
2034  * fteardown() callbacks can expect a @Fixture pointer as first argument in
2035  * a type safe manner.
2036  *
2037  * Since: 2.16
2038  **/
2039 /* --- macros docs END --- */