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