[mutter] test-runner: make test_case_wait() wait for queued-work

[Owen Taylor <otaylor src gnome org>]

commit 74c37d49c44ab49b6fc22b2f2793e2d4d1df56ac
Author: Owen W. Taylor <otaylor fishsoup net>
Date:   Wed Sep 24 15:52:11 2014 -0400

    test-runner: make test_case_wait() wait for queued-work
    
    Sometimes (for example with minimization) a request from the client
    causes queued work rather than immediate work; so make the test client
    'wait' command wait for a full frame cycle.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=737233

 src/tests/test-runner.c |   31 +++++++++++++++++++++++++++++++
 1 files changed, 31 insertions(+), 0 deletions(-)
---
diff --git a/src/tests/test-runner.c b/src/tests/test-runner.c
index c7f960a..d5f723c 100644
--- a/src/tests/test-runner.c
+++ b/src/tests/test-runner.c
@@ -413,6 +413,7 @@ typedef struct {
   AsyncWaiter *waiter;
   guint log_handler_id;
   GString *warning_messages;
+  GMainLoop *loop;
 } TestCase;
 
 static gboolean
@@ -483,22 +484,52 @@ test_case_new (void)
 
   test->clients = g_hash_table_new (g_str_hash, g_str_equal);
   test->waiter = async_waiter_new ();
+  test->loop = g_main_loop_new (NULL, FALSE);
 
   return test;
 }
 
 static gboolean
+test_case_before_redraw (gpointer data)
+{
+  TestCase *test = data;
+
+  g_main_loop_quit (test->loop);
+
+  return FALSE;
+}
+
+static gboolean
 test_case_wait (TestCase *test,
                 GError  **error)
 {
   GHashTableIter iter;
   gpointer key, value;
 
+  /* First have each client set a XSync counter, and wait until
+   * we receive the resulting event - so we know we've received
+   * everything that the client have sent us.
+   */
   g_hash_table_iter_init (&iter, test->clients);
   while (g_hash_table_iter_next (&iter, &key, &value))
     if (!test_client_wait (value, error))
       return FALSE;
 
+  /* Then wait until we've done any outstanding queued up work.
+   * Though we add this as BEFORE_REDRAW, the iteration that runs the
+   * BEFORE_REDRAW idles will proceed on and do the redraw, so we're
+   * waiting until after *all* frame processing.
+   */
+  meta_later_add (META_LATER_BEFORE_REDRAW,
+                  test_case_before_redraw,
+                  test,
+                  NULL);
+  g_main_loop_run (test->loop);
+
+  /* Then set an XSync counter ourselves and and wait until
+   * we receive the resulting event - this makes sure that we've
+   * received back any X events we generated.
+   */
   async_waiter_set_and_wait (test->waiter);
   return TRUE;
 }