[glib] gtestutils: print the TAP test plan first, not last

[Dan Winship <danw src gnome org>]

commit 6e382208f72cfd449cf076ac1f1fa340fe6eea0f
Author: Dan Winship <danw gnome org>
Date:   Fri Dec 12 11:49:31 2014 -0500

    gtestutils: print the TAP test plan first, not last
    
    TAP allows you to print the "test plan" (ie, the expected number of
    tests" either at the start or the end of the test program, but if you
    put it at the end, and the program crashes, automake will complain
    "missing test plan", which is confusing to users (particularly since
    it prints that *before* it prints that the test program crashed,
    suggesting that somehow the lack of test plan was responsible for the
    crash or something, rather than vice versa).
    
    Anyway, change it to count the tests ahead of time, and print the test
    plan first. Keeping this simple requires disallowing the '-p', '-s',
    and '--GTestSkipCount' options when using '--tap' (although we were
    already printing the wrong number in the --GTestSkipCount case
    anyway).
    
    https://bugzilla.gnome.org/show_bug.cgi?id=754284

 glib/gtestutils.c |   44 ++++++++++++++++++++++++++++++++++++++++++--
 1 files changed, 42 insertions(+), 2 deletions(-)
---
diff --git a/glib/gtestutils.c b/glib/gtestutils.c
index bfb4685..55304a7 100644
--- a/glib/gtestutils.c
+++ b/glib/gtestutils.c
@@ -657,6 +657,7 @@ static gchar      *test_run_name = "";
 static GSList    **test_filename_free_list;
 static guint       test_run_forks = 0;
 static guint       test_run_count = 0;
+static guint       test_count = 0;
 static guint       test_skipped_count = 0;
 static GTestResult test_run_success = G_TEST_RUN_FAILURE;
 static gchar      *test_run_msg = NULL;
@@ -783,6 +784,8 @@ g_test_log (GTestLogType lbit,
         {
           if (string1[0] != 0)
             g_print ("# Start of %s tests\n", string1);
+          else
+            g_print ("1..%d\n", test_count);
         }
       break;
     case G_TEST_LOG_STOP_SUITE:
@@ -790,8 +793,6 @@ g_test_log (GTestLogType lbit,
         {
           if (string1[0] != 0)
             g_print ("# End of %s tests\n", string1);
-          else
-            g_print ("1..%d\n", test_run_count);
         }
       break;
     case G_TEST_LOG_STOP_CASE:
@@ -1142,6 +1143,17 @@ g_test_init (int    *argc,
   if (!g_get_prgname() && !no_g_set_prgname)
     g_set_prgname ((*argv)[0]);
 
+  /* sanity check */
+  if (test_tap_log)
+    {
+      if (test_paths || test_paths_skipped || test_startup_skip_count)
+        {
+          g_printerr ("%s: options that skip some tests are incompatible with --tap\n",
+                      (*argv)[0]);
+          exit (1);
+        }
+    }
+
   /* verify GRand reliability, needed for reliable seeds */
   if (1)
     {
@@ -2204,6 +2216,33 @@ g_test_run_suite_internal (GTestSuite *suite,
   return n_bad;
 }
 
+static int
+g_test_suite_count (GTestSuite *suite)
+{
+  int n = 0;
+  GSList *iter;
+
+  g_return_val_if_fail (suite != NULL, -1);
+
+  for (iter = suite->cases; iter; iter = iter->next)
+    {
+      GTestCase *tc = iter->data;
+
+      if (strcmp (tc->name, "subprocess") != 0)
+        n++;
+    }
+
+  for (iter = suite->suites; iter; iter = iter->next)
+    {
+      GTestSuite *ts = iter->data;
+
+      if (strcmp (ts->name, "subprocess") != 0)
+        n += g_test_suite_count (ts);
+    }
+
+  return n;
+}
+
 /**
  * g_test_run_suite:
  * @suite: a #GTestSuite
@@ -2229,6 +2268,7 @@ g_test_run_suite (GTestSuite *suite)
   g_return_val_if_fail (g_test_run_once == TRUE, -1);
 
   g_test_run_once = FALSE;
+  test_count = g_test_suite_count (suite);
 
   test_run_name = g_strdup_printf ("/%s", suite->name);