Add a rotation lock indicator

5 files changed, 357 insertions, 0 deletions

diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
new file mode 100644
index 0000000..054a676
--- /dev/null
+++ b/tests/CMakeLists.txt
@@ -0,0 +1,35 @@
+include(FindGMock)
+include_directories(${CMAKE_CURRENT_SOURCE_DIR})
+include_directories(${GMOCK_INCLUDE_DIRS})
+include_directories(${GTEST_INCLUDE_DIRS})
+
+# build libgtest
+#add_library (gtest STATIC 
+#             ${GTEST_SOURCE_DIR}/gtest-all.cc 
+#             ${GTEST_SOURCE_DIR}/gtest_main.cc)
+#set_target_properties (gtest PROPERTIES INCLUDE_DIRECTORIES ${INCLUDE_DIRECTORIES} ${GTEST_INCLUDE_DIR})
+#set_target_properties (gtest PROPERTIES COMPILE_FLAGS ${COMPILE_FLAGS} -w)
+
+if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
+  # turn off the warnings that break Google Test
+  set (CXX_WARNING_ARGS "${CXX_WARNING_ARGS} -Wno-global-constructors -Wno-weak-vtables -Wno-undef -Wno-c++98-compat-pedantic -Wno-missing-noreturn -Wno-used-but-marked-unused -Wno-padded -Wno-deprecated -Wno-sign-compare -Wno-shift-sign-overflow")
+endif()
+
+SET (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -g ${CXX_WARNING_ARGS}")
+
+# look for headers in our src dir, and also in the directories where we autogenerate files...
+include_directories (${CMAKE_SOURCE_DIR}/src)
+include_directories (${CMAKE_CURRENT_BINARY_DIR})
+include_directories (${DBUSTEST_INCLUDE_DIRS})
+
+function(add_test_by_name name)
+  set (TEST_NAME ${name})
+  add_executable (${TEST_NAME} ${TEST_NAME}.cpp)
+  add_test (${TEST_NAME} ${TEST_NAME})
+  add_dependencies (${TEST_NAME} libindicatordisplayservice)
+  target_link_libraries (${TEST_NAME} indicatordisplayservice ${SERVICE_DEPS_LIBRARIES} ${GTEST_LIBRARIES} ${GMOCK_LIBRARIES})
+endfunction()
+add_test_by_name(test-rotation-lock)
+
+add_test (cppcheck cppcheck --enable=all -q --error-exitcode=2 --inline-suppr -I${CMAKE_SOURCE_DIR} ${CMAKE_SOURCE_DIR}/src ${CMAKE_SOURCE_DIR}/tests)
+
diff --git a/tests/glib-fixture.h b/tests/glib-fixture.h
new file mode 100644
index 0000000..a8f3a76
--- /dev/null
+++ b/tests/glib-fixture.h
@@ -0,0 +1,143 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * 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
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * 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>
+ */
+
+#include <map>
+
+#include <glib.h>
+#include <glib/gstdio.h>
+#include <gio/gio.h>
+
+#include <gtest/gtest.h>
+
+#include <locale.h> // setlocale()
+
+class GlibFixture : public ::testing::Test
+{
+  private:
+
+    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_message("%d %s", (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);
+    }
+
+  protected:
+
+    void increment_expected_errors(GLogLevelFlags level, size_t n=1)
+    {
+      expected_log[level] += n;
+    }
+
+    virtual void SetUp()
+    {
+      setlocale(LC_ALL, "C.UTF-8");
+
+      loop = g_main_loop_new(nullptr, false);
+
+      g_log_set_default_handler(default_log_handler, this);
+
+      g_assert(g_setenv("GSETTINGS_BACKEND", "memory", true));
+
+      g_unsetenv("DISPLAY");
+    }
+
+    virtual void TearDown()
+    {
+      test_log_counts();
+
+      g_log_set_default_handler(realLogHandler, this);
+
+      g_clear_pointer(&loop, g_main_loop_unref);
+    }
+
+  private:
+
+    static gboolean
+    wait_for_signal__timeout(gpointer name)
+    {
+      g_error("%s: timed out waiting for signal '%s'", G_STRLOC, (char*)name);
+      return G_SOURCE_REMOVE;
+    }
+
+    static gboolean
+    wait_msec__timeout(gpointer loop)
+    {
+      g_main_loop_quit(static_cast<GMainLoop*>(loop));
+      return G_SOURCE_CONTINUE;
+    }
+
+  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)
+    {
+      // wait for the signal or for timeout, whichever comes first
+      const auto handler_id = g_signal_connect_swapped(o, signal,
+                                                       G_CALLBACK(g_main_loop_quit),
+                                                       loop);
+      const auto timeout_id = g_timeout_add_seconds(timeout_seconds,
+                                                    wait_for_signal__timeout,
+                                                    loop);
+      g_main_loop_run(loop);
+      g_source_remove(timeout_id);
+      g_signal_handler_disconnect(o, handler_id);
+    }
+
+    /* convenience func to loop for N msec */
+    void wait_msec(guint msec=50)
+    {
+      const auto id = g_timeout_add(msec, wait_msec__timeout, loop);
+      g_main_loop_run(loop);
+      g_source_remove(id);
+    }
+
+    GMainLoop * loop;
+};
diff --git a/tests/gtestdbus-fixture.h b/tests/gtestdbus-fixture.h
new file mode 100644
index 0000000..541050e
--- /dev/null
+++ b/tests/gtestdbus-fixture.h
@@ -0,0 +1,102 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * 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
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * 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>
+ */
+
+#include "glib-fixture.h"
+
+/***
+****
+***/
+
+class GTestDBusFixture: public GlibFixture
+{
+  public:
+
+    GTestDBusFixture() {}
+
+    GTestDBusFixture(const std::vector<std::string>& service_dirs_in): service_dirs(service_dirs_in) {}
+
+  private:
+
+    typedef GlibFixture super;
+
+    static void
+    on_bus_opened (GObject* /*object*/, GAsyncResult * res, gpointer gself)
+    {
+      auto self = static_cast<GTestDBusFixture*>(gself);
+
+      GError * err = 0;
+      self->bus = g_bus_get_finish (res, &err);
+      g_assert_no_error (err);
+
+      g_main_loop_quit (self->loop);
+    }
+
+    static void
+    on_bus_closed (GObject* /*object*/, GAsyncResult * res, gpointer gself)
+    {
+      auto self = static_cast<GTestDBusFixture*>(gself);
+
+      GError * err = 0;
+      g_dbus_connection_close_finish (self->bus, res, &err);
+      g_assert_no_error (err);
+
+      g_main_loop_quit (self->loop);
+    }
+
+  protected:
+
+    GTestDBus * test_dbus = nullptr;
+    GDBusConnection * bus = nullptr;
+    const std::vector<std::string> service_dirs;
+
+    virtual void SetUp ()
+    {
+      super::SetUp ();
+
+      // pull up a test dbus
+      test_dbus = g_test_dbus_new (G_TEST_DBUS_NONE);
+      for (const auto& dir : service_dirs)
+        g_test_dbus_add_service_dir (test_dbus, dir.c_str());
+      g_test_dbus_up (test_dbus);
+      const char * address = g_test_dbus_get_bus_address (test_dbus);
+      g_setenv ("DBUS_SYSTEM_BUS_ADDRESS", address, true);
+      g_setenv ("DBUS_SESSION_BUS_ADDRESS", address, true);
+      g_debug ("test_dbus's address is %s", address);
+
+      // wait for the GDBusConnection before returning
+      g_bus_get (G_BUS_TYPE_SYSTEM, nullptr, on_bus_opened, this);
+      g_main_loop_run (loop);
+    }
+
+    virtual void TearDown ()
+    {
+      wait_msec();
+
+      // close the system bus
+      g_dbus_connection_close(bus, nullptr, on_bus_closed, this);
+      g_main_loop_run(loop);
+      g_clear_object(&bus);
+
+      // tear down the test dbus
+      g_test_dbus_down(test_dbus);
+      g_clear_object(&test_dbus);
+
+      super::TearDown();
+    }
+};
diff --git a/tests/manual b/tests/manual
new file mode 100644
index 0000000..f175b22
--- /dev/null
+++ b/tests/manual
@@ -0,0 +1,16 @@
+
+Test-case indicator-display/rotation-indicator
+<dl>
+        <dt>On the phone, enable the orientation lock in ubuntu-system-settings.</dt>
+                <dd>The rotation lock indicator should appear, and its switch menuitem should be set to 'true'.</dd>
+
+        <dt>With the orientation locked, click on the indicator's switch menuitem to toggle from locked to unlocked.</dd>
+                <dd>The rotation lock indicator should disappear</dd>
+                <dd>In ubuntu-system-settings, the orientation lock control should change to 'none'.</dd>
+</dl>
+
+
+<strong>
+    If all actions produce the expected results listed, please <a href="results#add_result">submit</a> a 'passed' result.
+    If an action fails, or produces an unexpected result, please <a href="results#add_result">submit</a> a 'failed' result and <a href="../../buginstructions">file a bug</a>. Please be sure to include the bug number when you <a href="results#add_result">submit</a> your result</strong>.
+
diff --git a/tests/test-rotation-lock.cpp b/tests/test-rotation-lock.cpp
new file mode 100644
index 0000000..946b1dd
--- /dev/null
+++ b/tests/test-rotation-lock.cpp
@@ -0,0 +1,61 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * 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
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * 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>
+ */
+
+#include "gtestdbus-fixture.h"
+
+#include <src/rotation-lock.h>
+
+class RotationLockFixture: public GTestDBusFixture
+{
+private:
+  typedef GTestDBusFixture super;
+
+protected:
+
+  void SetUp()
+  {
+    super::SetUp();
+  }
+
+  void TearDown()
+  {
+    super::TearDown();
+  }
+};
+
+/***
+****
+***/
+
+TEST_F(RotationLockFixture, CheckIndicator)
+{
+  RotationLockIndicator indicator;
+
+  ASSERT_STREQ("rotation_lock", indicator.name());
+  auto actions = indicator.action_group();
+  ASSERT_TRUE(actions != nullptr);
+  ASSERT_TRUE(g_action_group_has_action(G_ACTION_GROUP(actions), "rotation-lock"));
+
+  std::vector<std::shared_ptr<Profile>> profiles = indicator.profiles();
+  ASSERT_EQ(1, profiles.size());
+  std::shared_ptr<Profile> phone = profiles[0];
+  ASSERT_EQ(std::string("phone"), phone->name());
+  ASSERT_FALSE(phone->header()->is_visible);
+}
+