housekeeping: sync tests/glib-fixture with the up-to-date version in indicator-datetime

1 files changed, 144 insertions, 57 deletions

diff --git a/tests/glib-fixture.h b/tests/glib-fixture.h
index 9494df2..7f63473 100644
--- a/tests/glib-fixture.h
+++ b/tests/glib-fixture.h
@@ -1,5 +1,8 @@
 /*
- * Copyright 2014 Canonical Ltd.
+ * Copyright 2013 Canonical Ltd.
+ *
+ * Authors:
+ *   Charles Kerr <charles.kerr@canonical.com>
  *
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 3, as published
@@ -12,12 +15,14 @@
  *
  * You should have received a copy of the GNU General Public License along
  * with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- * Authors:
- *   Charles Kerr <charles.kerr@canonical.com>
  */
 
+#pragma once
+
+#include <chrono>
+#include <functional> // std::function
 #include <map>
+#include <memory> // std::shared_ptr
 
 #include <glib.h>
 #include <glib/gstdio.h>
@@ -29,79 +34,48 @@
 
 class GlibFixture : public ::testing::Test
 {
-  private:
+  public:
 
-    GLogFunc realLogHandler;
-
-    std::map<GLogLevelFlags,size_t> expected_log;
-    std::map<GLogLevelFlags,std::vector<std::string>> log;
-
-    void test_log_counts()
-    {
-      const GLogLevelFlags levels_to_test[] = { G_LOG_LEVEL_ERROR,
-                                                G_LOG_LEVEL_CRITICAL,
-                                                G_LOG_LEVEL_MESSAGE,
-                                                G_LOG_LEVEL_WARNING };
-
-      for(const auto& level : levels_to_test)
-      {
-        const auto& v = log[level];
-        const auto n = v.size();
-
-        EXPECT_EQ(expected_log[level], n);
-
-        if (expected_log[level] != n)
-            for (size_t i=0; i<n; ++i)
-                g_print("%d %s\n", int(n+1), v[i].c_str());
-      }
-
-      expected_log.clear();
-      log.clear();
-    }
-
-    static void default_log_handler(const gchar    * log_domain,
-                                    GLogLevelFlags   log_level,
-                                    const gchar    * message,
-                                    gpointer         self)
-    {
-      auto tmp = g_strdup_printf ("%s:%d \"%s\"", log_domain, int(log_level), message);
-      static_cast<GlibFixture*>(self)->log[log_level].push_back(tmp);
-      g_free(tmp);
-    }
+    virtual ~GlibFixture() =default;
 
   protected:
 
-    void increment_expected_errors(GLogLevelFlags level, size_t n=1)
-    {
-      expected_log[level] += n;
-    }
-
-    virtual void SetUp()
+    virtual void SetUp() override
     {
       setlocale(LC_ALL, "C.UTF-8");
 
       loop = g_main_loop_new(nullptr, false);
 
-      g_log_set_default_handler(default_log_handler, this);
+      // only use local, temporary settings
+      g_assert(g_setenv("GSETTINGS_SCHEMA_DIR", SCHEMA_DIR, true));
+      g_assert(g_setenv("GSETTINGS_BACKEND", "memory", true));
+      g_debug("SCHEMA_DIR is %s", SCHEMA_DIR);
+
+      // fail on unexpected messages from this domain
+      g_log_set_fatal_mask(G_LOG_DOMAIN, G_LOG_LEVEL_WARNING);
 
       g_unsetenv("DISPLAY");
+
     }
 
-    virtual void TearDown()
+    virtual void TearDown() override
     {
-      test_log_counts();
-
-      g_log_set_default_handler(realLogHandler, this);
+      g_test_assert_expected_messages ();
 
       g_clear_pointer(&loop, g_main_loop_unref);
     }
 
+    void expectLogMessage (const gchar *domain, GLogLevelFlags level, const gchar *pattern)
+    {
+      g_test_expect_message (domain, level, pattern);
+    }
+
   private:
 
     static gboolean
     wait_for_signal__timeout(gpointer name)
     {
-      g_error("%s: timed out waiting for signal '%s'", G_STRLOC, static_cast<char*>(name));
+      g_error("%s: timed out waiting for signal '%s'", G_STRLOC, (char*)name);
       return G_SOURCE_REMOVE;
     }
 
@@ -115,7 +89,7 @@ class GlibFixture : public ::testing::Test
   protected:
 
     /* convenience func to loop while waiting for a GObject's signal */
-    void wait_for_signal(gpointer o, const gchar * signal, const guint timeout_seconds=5)
+    void wait_for_signal(gpointer o, const gchar * signal, const int timeout_seconds=5)
     {
       // wait for the signal or for timeout, whichever comes first
       const auto handler_id = g_signal_connect_swapped(o, signal,
@@ -130,12 +104,125 @@ class GlibFixture : public ::testing::Test
     }
 
     /* convenience func to loop for N msec */
-    void wait_msec(guint msec=50)
+    void wait_msec(int msec=50)
     {
       const auto id = g_timeout_add(msec, wait_msec__timeout, loop);
       g_main_loop_run(loop);
       g_source_remove(id);
     }
 
-    GMainLoop * loop;
+    bool wait_for(std::function<bool()> test_function, guint timeout_msec=1000)
+    {
+      auto timer = std::shared_ptr<GTimer>(g_timer_new(), [](GTimer* t){g_timer_destroy(t);});
+      const auto timeout_sec = timeout_msec / 1000.0;
+      for (;;) {
+        if (test_function())
+          return true;
+        //g_message("%f ... %f", g_timer_elapsed(timer.get(), nullptr), timeout_sec);
+        if (g_timer_elapsed(timer.get(), nullptr) >= timeout_sec)
+          return false;
+        wait_msec();
+      }
+    }
+
+    bool wait_for_name_owned(
+        GDBusConnection* connection,
+        const gchar* name,
+        guint timeout_msec=1000,
+        GBusNameWatcherFlags flags=G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
+    {
+      struct Data {
+        GMainLoop* loop = nullptr;
+        bool owned = false;
+      };
+      Data data;
+
+      auto on_name_appeared = [](GDBusConnection* /*connection*/,
+                                 const gchar* /*name_*/,
+                                 const gchar* name_owner,
+                                 gpointer gdata){
+        if (name_owner == nullptr)
+          return;
+        auto tmp = static_cast<Data*>(gdata);
+        tmp->owned = true;
+        g_main_loop_quit(tmp->loop);
+      };
+
+      const auto timeout_id = g_timeout_add(timeout_msec, wait_msec__timeout, loop);
+      data.loop = loop;
+      const auto watch_id = g_bus_watch_name_on_connection(
+          connection,
+          name,
+          flags,
+          on_name_appeared,
+          nullptr, // name_vanished
+          &data,
+          nullptr // user_data_free_func
+      );
+
+      g_main_loop_run(loop);
+
+      g_bus_unwatch_name(watch_id);
+      g_source_remove(timeout_id);
+
+      return data.owned;
+    }
+
+    void EXPECT_NAME_OWNED_EVENTUALLY(GDBusConnection* connection,
+                                      const gchar* name,
+                                      guint timeout_msec=1000,
+                                      GBusNameWatcherFlags flags=G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
+    {
+      EXPECT_TRUE(wait_for_name_owned(connection, name, timeout_msec, flags)) << "name: " << name;
+    }
+
+    void EXPECT_NAME_NOT_OWNED_EVENTUALLY(GDBusConnection* connection,
+                                          const gchar* name,
+                                          guint timeout_msec=1000,
+                                          GBusNameWatcherFlags flags=G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
+    {
+      EXPECT_FALSE(wait_for_name_owned(connection, name, timeout_msec, flags)) << "name: " << name;
+    }
+
+    void ASSERT_NAME_OWNED_EVENTUALLY(GDBusConnection* connection,
+                                      const gchar* name,
+                                      guint timeout_msec=1000,
+                                      GBusNameWatcherFlags flags=G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
+    {
+      ASSERT_TRUE(wait_for_name_owned(connection, name, timeout_msec, flags)) << "name: " << name;
+    }
+
+    void ASSERT_NAME_NOT_OWNED_EVENTUALLY(GDBusConnection* connection,
+                                          const gchar* name,
+                                          guint timeout_msec=1000,
+                                          GBusNameWatcherFlags flags=G_BUS_NAME_WATCHER_FLAGS_AUTO_START)
+    {
+      ASSERT_FALSE(wait_for_name_owned(connection, name, timeout_msec, flags)) << "name: " << name;
+    }
+
+    using source_func = std::function<gboolean()>;
+
+    guint idle_add(source_func&& func)
+    {
+      return g_idle_add_full(
+        G_PRIORITY_DEFAULT_IDLE,
+        [](gpointer gf){return (*static_cast<source_func*>(gf))();},
+        new std::function<gboolean()>(func),
+        [](gpointer gf){delete static_cast<source_func*>(gf);}
+      );
+    }
+
+    guint timeout_add(source_func&& func, std::chrono::milliseconds msec)
+    {
+      return g_timeout_add_full(
+        G_PRIORITY_DEFAULT,
+        msec.count(),
+        [](gpointer gf){return (*static_cast<source_func*>(gf))();},
+        new std::function<gboolean()>(func),
+        [](gpointer gf){delete static_cast<source_func*>(gf);}
+      );
+    }
+
+    GMainLoop* loop {};
 };
+