[glib: 2/6] gspawn, tests: extend spawn_test, run it on win32

[Philip Withnall <pwithnall src gnome org>]

commit 50cb4f221ccc939740d53be795ae8382a4b2e322
Author: Vasily Galkin <galkin-vv yandex ru>
Date:   Wed Dec 26 23:45:47 2018 +0300

    gspawn, tests: extend spawn_test, run it on win32
    
    The spawn_test is enabled on win32 meson build, both msys and msvc.
    
    Some modifications to make it useful for auto-testing on win32:
    - use own argv0 to find helper win32-specific subprogram
    - helper subprogram and conditions changed, so testing is fully
    automated instead of manually checking contents of some MessageBoxes
    
    Redirection test checks "sort" output for locale-independent string
    instead of relying on "netstat" locale-dependent string.
    Also with "sort" it become usable on unix, so enabled there too.
    Currently this fails on win32 with coverage since
    some coverage-realted error output from gpawn-win32-helper
    is unexpectedly treated as executed subprocess output.
    
    
    Added test checking "sort" with error-only redirection. This also fails
    on win32 by now, due to a typo in gspawn-win32.c (checks for stdout
    redirection instead of stderr)

 tests/meson.build            |   7 ++-
 tests/spawn-test-win32-gui.c |  52 ++++++----------------
 tests/spawn-test.c           | 103 +++++++++++++++++++++++++++++++++----------
 3 files changed, 98 insertions(+), 64 deletions(-)
---
diff --git a/tests/meson.build b/tests/meson.build
index 8dcb712e4..1d53db288 100644
--- a/tests/meson.build
+++ b/tests/meson.build
@@ -38,6 +38,7 @@ tests = {
     'dependencies' : [libgthread_dep],
   },
   'sources' : {},
+  'spawn-test' : {},
   'thread-test' : {},
   'threadpool-test' : {'suite' : ['slow']},
   'type-test' : {},
@@ -68,9 +69,12 @@ test_extra_programs = {
 if host_machine.system() != 'windows'
   tests += {
     'timeloop' : {},
-    'spawn-test' : {},
     'iochannel-test' : {},
   }
+else
+  test_extra_programs += {
+    'spawn-test-win32-gui' : {'gui_app' : true}
+  }
 endif
 
 if installed_tests_enabled
@@ -139,5 +143,6 @@ foreach program_name, extra_args : test_extra_programs
       dependencies : common_deps + extra_args.get('dependencies', []),
       install_dir : installed_tests_execdir,
       install : install,
+      gui_app : extra_args.get('gui_app', false),
   )
 endforeach
diff --git a/tests/spawn-test-win32-gui.c b/tests/spawn-test-win32-gui.c
index 2798ce6da..34945f524 100644
--- a/tests/spawn-test-win32-gui.c
+++ b/tests/spawn-test-win32-gui.c
@@ -1,4 +1,5 @@
 #include <windows.h>
+#include <io.h>
 #include <errno.h>
 #include <stdio.h>
 #include <string.h>
@@ -19,24 +20,15 @@ WinMain (struct HINSTANCE__ *hInstance,
        char *lpszCmdLine,
        int   nCmdShow)
 {
-  char buf[100];
-
-  if (__argc >= 2 && strcmp (__argv[1], "nop") == 0)
+  if (__argc >= 2 && strcmp (__argv[1], "print_argv0") == 0)
     {
-      sprintf (buf, "spawn-test-win32-gui: argv[0]=\"%s\"", __argv[0]);
-      MessageBox (NULL, buf, lpszCmdLine, MB_ICONINFORMATION|MB_SYSTEMMODAL);
+      printf ("%s", __argv[0]);
     }
   else if (__argc <= 2)
     {
-      MessageBox (NULL, "spawn-test-win32-gui: Will write to stdout",
-                 lpszCmdLine, MB_ICONINFORMATION|MB_SYSTEMMODAL);
-      
       printf ("This is stdout\n");
       fflush (stdout);
       
-      MessageBox (NULL, "spawn-test-win32-gui: Will write to stderr",
-                 lpszCmdLine, MB_ICONINFORMATION|MB_SYSTEMMODAL);
-      
       fprintf (stderr, "This is stderr\n");
       fflush (stderr);
     }
@@ -45,70 +37,52 @@ WinMain (struct HINSTANCE__ *hInstance,
       int infd = atoi (__argv[2]);
       int outfd = atoi (__argv[3]);
       int k, n;
+      char buf[100] = {0};
 
       if (infd < 0 || outfd < 0)
        {
-         MessageBox (NULL, "spawn-test-win32-gui: illegal fds on command line",
-                     lpszCmdLine, MB_ICONERROR|MB_SYSTEMMODAL);
+         printf ("spawn-test-win32-gui: illegal fds on command line %s",
+                     lpszCmdLine);
          exit (1);
        }
 
-      MessageBox (NULL, "spawn-test-win32-gui: Will write to parent",
-                 lpszCmdLine, MB_ICONINFORMATION|MB_SYSTEMMODAL);
-
       n = strlen ("Hello there");
       if (write (outfd, &n, sizeof (n)) == -1 ||
          write (outfd, "Hello there", n) == -1)
        {
          int errsv = errno;
-         sprintf (buf, "spawn-test-win32-gui: Write: %s", strerror (errsv));
-         MessageBox (NULL, buf, lpszCmdLine, MB_ICONERROR|MB_SYSTEMMODAL);
+         printf ("spawn-test-win32-gui: Write error: %s", strerror (errsv));
          exit (1);
        }
 
-      MessageBox (NULL, "spawn-test-win32-gui: Will read from parent",
-                 lpszCmdLine, MB_ICONINFORMATION|MB_SYSTEMMODAL);
-
       if ((k = read (infd, &n, sizeof (n))) != sizeof (n))
        {
-         sprintf (buf, "spawn-test-win32-gui: Got only %d bytes, wanted %d",
-                  k, sizeof (n));
-         MessageBox (NULL, buf, lpszCmdLine, MB_ICONERROR|MB_SYSTEMMODAL);
+         printf ("spawn-test-win32-gui: Got only %d bytes, wanted %d",
+                  k, (int)sizeof (n));
          exit (1);
        }
 
-      sprintf (buf, "spawn-test-win32-gui: Parent says %d bytes to read", n);
-      MessageBox (NULL, buf, lpszCmdLine, MB_ICONINFORMATION|MB_SYSTEMMODAL);
+      printf ("spawn-test-win32-gui: Parent says %d bytes to read", n);
 
       if ((k = read (infd, buf, n)) != n)
        {
          int errsv = errno;
          if (k == -1)
-           sprintf (buf, "spawn-test-win32-gui: Read: %s", strerror (errsv));
+           printf ("spawn-test-win32-gui: Read error: %s", strerror (errsv));
          else
-           sprintf (buf, "spawn-test-win32-gui: Got only %d bytes", k);
-         MessageBox (NULL, buf, lpszCmdLine, MB_ICONERROR|MB_SYSTEMMODAL);
+           printf ("spawn-test-win32-gui: Got only %d bytes", k);
          exit (1);
        }
 
-      MessageBox (NULL, "spawn-test-win32-gui: Will write more to parent",
-                 lpszCmdLine, MB_ICONINFORMATION|MB_SYSTEMMODAL);
-
       n = strlen ("See ya");
       if (write (outfd, &n, sizeof (n)) == -1 ||
          write (outfd, "See ya", n) == -1)
        {
          int errsv = errno;
-         sprintf (buf, "spawn-test-win32-gui: Write: %s", strerror (errsv));
-         MessageBox (NULL, buf, lpszCmdLine, MB_ICONERROR|MB_SYSTEMMODAL);
+         printf ("spawn-test-win32-gui: Write error: %s", strerror (errsv));
          exit (1);
        }
     }
 
-  Sleep (2000);
-  
-  MessageBox (NULL, "spawn-test-win32-gui: Done, exiting.",
-             lpszCmdLine, MB_ICONINFORMATION|MB_SYSTEMMODAL);
-
   return 0;
 }
diff --git a/tests/spawn-test.c b/tests/spawn-test.c
index 05cce17f8..78a7e7c7d 100644
--- a/tests/spawn-test.c
+++ b/tests/spawn-test.c
@@ -26,6 +26,7 @@
 #undef G_LOG_DOMAIN
 
 #include <glib.h>
+#include <glib/gstdio.h>
 #include <stdio.h>
 #include <string.h>
 #include <stdlib.h>
@@ -38,15 +39,20 @@
 
 
 static void
-run_tests (void)
+run_tests (const gchar* argv0)
 {
-  GError *err;
+  GError *err = NULL;
   gchar *output = NULL;
-#ifdef G_OS_WIN32
   gchar *erroutput = NULL;
+  gchar *dirname = g_path_get_dirname (argv0);
+#ifdef G_OS_WIN32
   int pipedown[2], pipeup[2];
   gchar **argv = 0;
+  gchar spawn_binary[1000] = {0};
+  gchar full_cmdline[1000] = {0};
+  g_snprintf (spawn_binary, sizeof (spawn_binary), "%s\\spawn-test-win32-gui.exe", dirname);
 #endif
+  g_free (dirname);
   
   err = NULL;
   if (!g_spawn_command_line_sync ("nonexistent_application foo 'bar baz' blah blah",
@@ -96,12 +102,15 @@ run_tests (void)
         }
 
       g_free (output);
+      output = NULL;
     }
-#else
-#ifdef G_OS_WIN32
-  printf ("Running netstat synchronously, collecting its output\n");
-
-  if (!g_spawn_command_line_sync ("netstat -n",
+#endif
+  /* Running sort synchronously, collecting its output. 'sort' command is selected
+   * because it is non-builtin command on both unix and win32 with well-defined stdout behaviour.
+   */
+  g_file_set_contents ("spawn-test-created-file.txt", "line first\nline 2\nline last\n", -1, &err);
+  g_assert_no_error(err);
+  if (!g_spawn_command_line_sync ("sort spawn-test-created-file.txt",
                                   &output, &erroutput, NULL,
                                   &err))
     {
@@ -114,9 +123,9 @@ run_tests (void)
       g_assert (output != NULL);
       g_assert (erroutput != NULL);
       
-      if (strstr (output, "Active Connections") == 0)
+      if (strstr (output, "\nline first") == 0)
         {
-          printf ("output was '%s', should have contained 'Active Connections'\n",
+          printf ("output was '%s', should have contained 'line first' in second line\n",
                   output);
 
           exit (1);
@@ -132,13 +141,36 @@ run_tests (void)
       output = NULL;
       g_free (erroutput);
       erroutput = NULL;
+      g_unlink ("spawn-test-created-file.txt");
     }
 
-  printf ("Running spawn-test-win32-gui in various ways. Click on the OK buttons.\n");
+  if (!g_spawn_command_line_sync ("sort non-existing-file.txt",
+                                  NULL, &erroutput, NULL,
+                                  &err))
+    {
+      fprintf (stderr, "Error: %s\n", err->message);
+      g_error_free (err);
+      exit (1);
+    }
+  else
+    {
+      g_assert (erroutput != NULL);
 
-  printf ("First asynchronously (without wait).\n");
+      if (erroutput[0] == '\0')
+        {
+          printf ("erroutput was empty, expected contain error message about non-existing-file.txt\n");
+          exit (1);
+        }
+      g_free (erroutput);
+      erroutput = NULL;
+    }
 
-  if (!g_spawn_command_line_async ("'.\\spawn-test-win32-gui.exe' 1", &err))
+#ifdef G_OS_WIN32
+  printf ("Running spawn-test-win32-gui in various ways.\n");
+
+  printf ("First asynchronously (without wait).\n");
+  g_snprintf (full_cmdline, sizeof (full_cmdline), "'%s' 1", spawn_binary);
+  if (!g_spawn_command_line_async (full_cmdline, &err))
     {
       fprintf (stderr, "Error: %s\n", err->message);
       g_error_free (err);
@@ -146,7 +178,8 @@ run_tests (void)
     }
 
   printf ("Now synchronously, collecting its output.\n");
-  if (!g_spawn_command_line_sync ("'.\\spawn-test-win32-gui.exe' 2",
+  g_snprintf (full_cmdline, sizeof (full_cmdline), "'%s' 2", spawn_binary);
+  if (!g_spawn_command_line_sync (full_cmdline,
                                  &output, &erroutput, NULL,
                                  &err))
     {
@@ -174,27 +207,39 @@ run_tests (void)
        }
 
       g_free (output);
+      output = NULL;
       g_free (erroutput);
+      erroutput = NULL;
     }
 
   printf ("Now with G_SPAWN_FILE_AND_ARGV_ZERO.\n");
-
-  if (!g_shell_parse_argv ("'.\\spawn-test-win32-gui.exe' this-should-be-argv-zero nop", NULL, &argv, &err))
+  g_snprintf (full_cmdline, sizeof (full_cmdline), "'%s' this-should-be-argv-zero print_argv0", 
spawn_binary);
+  if (!g_shell_parse_argv (full_cmdline, NULL, &argv, &err))
     {
       fprintf (stderr, "Error parsing command line? %s\n", err->message);
       g_error_free (err);
       exit (1);
     }
 
-  if (!g_spawn_async (NULL, argv, NULL,
+  if (!g_spawn_sync (NULL, argv, NULL,
                      G_SPAWN_FILE_AND_ARGV_ZERO,
-                     NULL, NULL, NULL,
+                     NULL, NULL, &output, NULL, NULL,
                      &err))
     {
       fprintf (stderr, "Error: %s\n", err->message);
       g_error_free (err);
       exit (1);
     }
+  else
+    {
+      if (strcmp (output, "this-should-be-argv-zero") != 0)
+       {
+         printf ("output was '%s', should have been 'this-should-be-argv-zero'\n", output);
+         exit (1);
+       }
+      g_free (output);
+      output = NULL;
+    }
 
   printf ("Now talking to it through pipes.\n");
 
@@ -205,8 +250,8 @@ run_tests (void)
       exit (1);
     }
 
-  if (!g_shell_parse_argv (g_strdup_printf ("'.\\spawn-test-win32-gui.exe' pipes %d %d",
-                                           pipedown[0], pipeup[1]),
+  g_snprintf (full_cmdline, sizeof (full_cmdline), "'%s' pipes %d %d", spawn_binary, pipedown[0], pipeup[1]);
+  if (!g_shell_parse_argv (full_cmdline,
                            NULL, &argv,
                            &err))
     {
@@ -237,7 +282,7 @@ run_tests (void)
            fprintf (stderr, "Read error: %s\n", g_strerror (errsv));
          else
            fprintf (stderr, "Wanted to read %d bytes, got %d\n",
-                    sizeof (n), k);
+                    (int)sizeof (n), k);
          exit (1);
        }
 
@@ -268,7 +313,12 @@ run_tests (void)
            fprintf (stderr, "Read error: %s\n", g_strerror (errsv));
          else
            fprintf (stderr, "Wanted to read %d bytes, got %d\n",
-                    sizeof (n), k);
+                    (int)sizeof (n), k);
+         exit (1);
+       }
+      if (n != strlen ("See ya"))
+       {
+         printf ("child wrote %d bytes, expected %d", n, (int) strlen ("See ya"));
          exit (1);
        }
 
@@ -282,16 +332,21 @@ run_tests (void)
                     n, k);
          exit (1);
        }
+      buf[n] = '\0';
+      if (strcmp (buf, "See ya") != 0)
+       {
+         printf ("output was '%s', should have been 'See ya'\n", buf);
+         exit (1);
+       }
     }
 #endif
-#endif
 }
 
 int
 main (int   argc,
       char *argv[])
 {
-  run_tests ();
+  run_tests (argv[0]);
   
   return 0;
 }