From 132ac93bbd4141824cfa22f6516366f953fce9a0 Mon Sep 17 00:00:00 2001 From: Iain Lane Date: Mon, 31 Aug 2015 22:08:36 +0100 Subject: Use timedated's Timezone property instead of watching /etc/timezone Still need to rename everything to not use "timezone-file" --- tests/test-live-actions.cpp | 234 ++------------------------------- tests/test-timezone-file.cpp | 105 +++------------ tests/timedated-fixture.h | 302 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 330 insertions(+), 311 deletions(-) create mode 100644 tests/timedated-fixture.h (limited to 'tests') diff --git a/tests/test-live-actions.cpp b/tests/test-live-actions.cpp index 4f84f25..9c74813 100644 --- a/tests/test-live-actions.cpp +++ b/tests/test-live-actions.cpp @@ -17,228 +17,18 @@ * Charles Kerr */ -#include - -#include "state-mock.h" -#include "glib-fixture.h" - -/*** -**** -***/ - -using namespace unity::indicator::datetime; - -class MockLiveActions: public LiveActions -{ -public: - std::string last_cmd; - std::string last_url; - explicit MockLiveActions(const std::shared_ptr& state_in): LiveActions(state_in) {} - ~MockLiveActions() {} - -protected: - void dispatch_url(const std::string& url) override { last_url = url; } - void execute_command(const std::string& cmd) override { last_cmd = cmd; } -}; - -/*** -**** -***/ - -using namespace unity::indicator::datetime; - -class LiveActionsFixture: public GlibFixture -{ -private: - - typedef GlibFixture super; - - static void on_bus_acquired(GDBusConnection* conn, - const gchar* name, - gpointer gself) - { - auto self = static_cast(gself); - g_debug("bus acquired: %s, connection is %p", name, conn); - - // Set up a mock GSD. - // All it really does is wait for calls to GetDevice and - // returns the get_devices_retval variant - static const GDBusInterfaceVTable vtable = { - timedate1_handle_method_call, - nullptr, /* GetProperty */ - nullptr, /* SetProperty */ - }; - - self->connection = G_DBUS_CONNECTION(g_object_ref(G_OBJECT(conn))); - - GError* error = nullptr; - self->object_register_id = g_dbus_connection_register_object( - conn, - "/org/freedesktop/timedate1", - self->node_info->interfaces[0], - &vtable, - self, - nullptr, - &error); - g_assert_no_error(error); - } - - static void on_name_acquired(GDBusConnection* /*conn*/, - const gchar* /*name*/, - gpointer gself) - { - auto self = static_cast(gself); - self->name_acquired = true; - g_main_loop_quit(self->loop); - } - - static void on_name_lost(GDBusConnection* /*conn*/, - const gchar* /*name*/, - gpointer gself) - { - auto self = static_cast(gself); - self->name_acquired = false; - } - - static void on_bus_closed(GObject* /*object*/, - GAsyncResult* res, - gpointer gself) - { - auto self = static_cast(gself); - GError* err = nullptr; - g_dbus_connection_close_finish(self->connection, res, &err); - g_assert_no_error(err); - g_main_loop_quit(self->loop); - } - - static void - timedate1_handle_method_call(GDBusConnection * /*connection*/, - const gchar * /*sender*/, - const gchar * /*object_path*/, - const gchar * /*interface_name*/, - const gchar * method_name, - GVariant * parameters, - GDBusMethodInvocation * invocation, - gpointer gself) - { - g_assert(!g_strcmp0(method_name, "SetTimezone")); - g_assert(g_variant_is_of_type(parameters, G_VARIANT_TYPE_TUPLE)); - g_assert(2 == g_variant_n_children(parameters)); - - auto child = g_variant_get_child_value(parameters, 0); - g_assert(g_variant_is_of_type(child, G_VARIANT_TYPE_STRING)); - auto self = static_cast(gself); - self->attempted_tzid = g_variant_get_string(child, nullptr); - g_variant_unref(child); - - g_dbus_method_invocation_return_value(invocation, nullptr); - g_main_loop_quit(self->loop); - } - -protected: - - std::shared_ptr m_mock_state; - std::shared_ptr m_state; - std::shared_ptr m_live_actions; - std::shared_ptr m_actions; - - bool name_acquired; - std::string attempted_tzid; - - GTestDBus* bus; - guint own_name; - GDBusConnection* connection; - GDBusNodeInfo* node_info; - int object_register_id; - - void SetUp() - { - super::SetUp(); - - name_acquired = false; - attempted_tzid.clear(); - connection = nullptr; - node_info = nullptr; - object_register_id = 0; - own_name = 0; - - // bring up the test bus - bus = g_test_dbus_new(G_TEST_DBUS_NONE); - g_test_dbus_up(bus); - const auto address = g_test_dbus_get_bus_address(bus); - 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); - - // parse the org.freedesktop.timedate1 interface - const gchar introspection_xml[] = - "" - " " - " " - " " - " " - " " - " " - ""; - node_info = g_dbus_node_info_new_for_xml(introspection_xml, nullptr); - ASSERT_TRUE(node_info != nullptr); - ASSERT_TRUE(node_info->interfaces != nullptr); - ASSERT_TRUE(node_info->interfaces[0] != nullptr); - ASSERT_TRUE(node_info->interfaces[1] == nullptr); - ASSERT_STREQ("org.freedesktop.timedate1", node_info->interfaces[0]->name); - - // own the bus - own_name = g_bus_own_name(G_BUS_TYPE_SYSTEM, - "org.freedesktop.timedate1", - G_BUS_NAME_OWNER_FLAGS_NONE, - on_bus_acquired, on_name_acquired, on_name_lost, - this, nullptr); - ASSERT_TRUE(object_register_id == 0); - ASSERT_FALSE(name_acquired); - ASSERT_TRUE(connection == nullptr); - g_main_loop_run(loop); - ASSERT_TRUE(object_register_id != 0); - ASSERT_TRUE(name_acquired); - ASSERT_TRUE(G_IS_DBUS_CONNECTION(connection)); - - // create the State and Actions - m_mock_state.reset(new MockState); - m_mock_state->settings.reset(new Settings); - m_state = std::dynamic_pointer_cast(m_mock_state); - m_live_actions.reset(new MockLiveActions(m_state)); - m_actions = std::dynamic_pointer_cast(m_live_actions); - } - - void TearDown() - { - m_actions.reset(); - m_live_actions.reset(); - m_state.reset(); - m_mock_state.reset(); - - g_dbus_connection_unregister_object(connection, object_register_id); - g_dbus_node_info_unref(node_info); - g_bus_unown_name(own_name); - g_dbus_connection_close(connection, nullptr, on_bus_closed, this); - g_main_loop_run(loop); - g_clear_object(&connection); - g_test_dbus_down(bus); - g_clear_object(&bus); - - super::TearDown(); - } -}; +#include "timedated-fixture.h" /*** **** ***/ -TEST_F(LiveActionsFixture, HelloWorld) +TEST_F(TimedateFixture, HelloWorld) { EXPECT_TRUE(true); } -TEST_F(LiveActionsFixture, SetLocation) +TEST_F(TimedateFixture, SetLocation) { const std::string tzid = "America/Chicago"; const std::string name = "Oklahoma City"; @@ -258,14 +48,14 @@ TEST_F(LiveActionsFixture, SetLocation) **** ***/ -TEST_F(LiveActionsFixture, DesktopOpenAlarmApp) +TEST_F(TimedateFixture, DesktopOpenAlarmApp) { m_actions->desktop_open_alarm_app(); const std::string expected = "evolution -c calendar"; EXPECT_EQ(expected, m_live_actions->last_cmd); } -TEST_F(LiveActionsFixture, DesktopOpenAppointment) +TEST_F(TimedateFixture, DesktopOpenAppointment) { Appointment a; a.uid = "some-uid"; @@ -275,14 +65,14 @@ TEST_F(LiveActionsFixture, DesktopOpenAppointment) EXPECT_NE(m_live_actions->last_cmd.find(expected_substr), std::string::npos); } -TEST_F(LiveActionsFixture, DesktopOpenCalendarApp) +TEST_F(TimedateFixture, DesktopOpenCalendarApp) { m_actions->desktop_open_calendar_app(DateTime::NowLocal()); const std::string expected_substr = "evolution \"calendar:///?startdate="; EXPECT_NE(m_live_actions->last_cmd.find(expected_substr), std::string::npos); } -TEST_F(LiveActionsFixture, DesktopOpenSettingsApp) +TEST_F(TimedateFixture, DesktopOpenSettingsApp) { m_actions->desktop_open_settings_app(); const std::string expected_substr = "control-center"; @@ -300,13 +90,13 @@ namespace const std::string calendar_app_url = "appid://com.ubuntu.calendar/calendar/current-user-version"; } -TEST_F(LiveActionsFixture, PhoneOpenAlarmApp) +TEST_F(TimedateFixture, PhoneOpenAlarmApp) { m_actions->phone_open_alarm_app(); EXPECT_EQ(clock_app_url, m_live_actions->last_url); } -TEST_F(LiveActionsFixture, PhoneOpenAppointment) +TEST_F(TimedateFixture, PhoneOpenAppointment) { Appointment a; @@ -321,14 +111,14 @@ TEST_F(LiveActionsFixture, PhoneOpenAppointment) EXPECT_EQ(clock_app_url, m_live_actions->last_url); } -TEST_F(LiveActionsFixture, PhoneOpenCalendarApp) +TEST_F(TimedateFixture, PhoneOpenCalendarApp) { m_actions->phone_open_calendar_app(DateTime::NowLocal()); const std::string expected = "appid://com.ubuntu.calendar/calendar/current-user-version"; EXPECT_EQ(expected, m_live_actions->last_url); } -TEST_F(LiveActionsFixture, PhoneOpenSettingsApp) +TEST_F(TimedateFixture, PhoneOpenSettingsApp) { m_actions->phone_open_settings_app(); const std::string expected = "settings:///system/time-date"; @@ -339,7 +129,7 @@ TEST_F(LiveActionsFixture, PhoneOpenSettingsApp) **** ***/ -TEST_F(LiveActionsFixture, CalendarState) +TEST_F(TimedateFixture, CalendarState) { // init the clock auto now = DateTime::Local(2014, 1, 1, 0, 0, 0); diff --git a/tests/test-timezone-file.cpp b/tests/test-timezone-file.cpp index 8968429..0ec496d 100644 --- a/tests/test-timezone-file.cpp +++ b/tests/test-timezone-file.cpp @@ -18,129 +18,56 @@ * with this program. If not, see . */ -#include "glib-fixture.h" +#include "timedated-fixture.h" #include -//#include -//#include -//#include -//#include -//#include -//#include -//#include -//#include - #include // fopen() //#include // chmod() #include // sync() using unity::indicator::datetime::FileTimezone; - -/*** -**** -***/ - -#define TIMEZONE_FILE (SANDBOX"/timezone") - -class TimezoneFixture: public GlibFixture -{ - private: - - typedef GlibFixture super; - - protected: - - void SetUp() override - { - super::SetUp(); - } - - void TearDown() override - { - super::TearDown(); - } - - public: - - /* convenience func to set the timezone file */ - void set_file(const std::string& text) - { - auto fp = fopen(TIMEZONE_FILE, "w+"); - fprintf(fp, "%s\n", text.c_str()); - fclose(fp); - sync(); - } -}; - - -/** - * Test that timezone-file warns, but doesn't crash, if the timezone file doesn't exist - */ -TEST_F(TimezoneFixture, NoFile) -{ - remove(TIMEZONE_FILE); - ASSERT_FALSE(g_file_test(TIMEZONE_FILE, G_FILE_TEST_EXISTS)); - - FileTimezone tz(TIMEZONE_FILE); - testLogCount(G_LOG_LEVEL_WARNING, 1); -} - - /** * Test that timezone-file picks up the initial value */ -TEST_F(TimezoneFixture, InitialValue) +TEST_F(TimedateFixture, InitialValue) { const std::string expected_timezone = "America/Chicago"; - set_file(expected_timezone); - FileTimezone tz(TIMEZONE_FILE); + set_timezone(expected_timezone); + FileTimezone tz; ASSERT_EQ(expected_timezone, tz.timezone.get()); } - /** - * Test that clearing the timezone results in an empty string + * Test that changing the tz after we are running works. */ -TEST_F(TimezoneFixture, ChangedValue) +TEST_F(TimedateFixture, ChangedValue) { const std::string initial_timezone = "America/Chicago"; const std::string changed_timezone = "America/New_York"; - set_file(initial_timezone); + GMainLoop *l = g_main_loop_new(nullptr, FALSE); - FileTimezone tz(TIMEZONE_FILE); + set_timezone(initial_timezone); + + FileTimezone tz; ASSERT_EQ(initial_timezone, tz.timezone.get()); bool changed = false; - auto connection = tz.timezone.changed().connect( - [&changed, this](const std::string& s){ + tz.timezone.changed().connect( + [&changed, this, l](const std::string& s){ g_message("timezone changed to %s", s.c_str()); changed = true; - g_main_loop_quit(loop); + g_main_loop_quit(l); }); g_idle_add([](gpointer gself){ - static_cast(gself)->set_file("America/New_York"); - // static_cast(gtz)->timezone.set("America/New_York"); + static_cast(gself)->set_timezone("America/New_York"); return G_SOURCE_REMOVE; - }, this);//&tz); + }, this); - g_main_loop_run(loop); + g_main_loop_run(l); ASSERT_TRUE(changed); ASSERT_EQ(changed_timezone, tz.timezone.get()); } - - -/** - * Test that timezone-file picks up the initial value - */ -TEST_F(TimezoneFixture, IgnoreComments) -{ - const std::string comment = "# Created by cloud-init v. 0.7.5 on Thu, 24 Apr 2014 14:03:29 +0000"; - const std::string expected_timezone = "Europe/Berlin"; - set_file(comment + "\n" + expected_timezone); - FileTimezone tz(TIMEZONE_FILE); - ASSERT_EQ(expected_timezone, tz.timezone.get()); -} diff --git a/tests/timedated-fixture.h b/tests/timedated-fixture.h new file mode 100644 index 0000000..e75e6bd --- /dev/null +++ b/tests/timedated-fixture.h @@ -0,0 +1,302 @@ +/* + * 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 . + * + * Authors: + * Charles Kerr + */ + +#ifndef INDICATOR_DATETIME_TESTS_TIMEDATED_FIXTURE_H +#define INDICATOR_DATETIME_TESTS_TIMEDATED_FIXTURE_H + +#include + +#include "state-mock.h" +#include "glib-fixture.h" + +using namespace unity::indicator::datetime; + +class MockLiveActions: public LiveActions +{ +public: + std::string last_cmd; + std::string last_url; + explicit MockLiveActions(const std::shared_ptr& state_in): LiveActions(state_in) {} + ~MockLiveActions() {} + +protected: + void dispatch_url(const std::string& url) override { last_url = url; } + void execute_command(const std::string& cmd) override { last_cmd = cmd; } +}; + +/*** +**** +***/ + +using namespace unity::indicator::datetime; + +class TimedateFixture: public GlibFixture +{ +private: + + typedef GlibFixture super; + + static GVariant * timedate1_get_properties (GDBusConnection * /*connection*/ , + const gchar * /*sender*/, + const gchar * /*object_path*/, + const gchar * /*interface_name*/, + const gchar *property_name, + GError ** /*error*/, + gpointer gself) + + { + auto self = static_cast(gself); + g_debug("get_properties called"); + if (g_strcmp0(property_name, "Timezone") == 0) + { + g_debug("timezone requested, giving '%s'", + self->attempted_tzid.c_str()); + return g_variant_new_string(self->attempted_tzid.c_str()); + } + return nullptr; + } + + + static void on_bus_acquired(GDBusConnection* conn, + const gchar* name, + gpointer gself) + { + auto self = static_cast(gself); + g_debug("bus acquired: %s, connection is %p", name, conn); + + // Set up a mock GSD. + // All it really does is wait for calls to GetDevice and + // returns the get_devices_retval variant + static const GDBusInterfaceVTable vtable = { + timedate1_handle_method_call, + timedate1_get_properties, /* GetProperty */ + nullptr, /* SetProperty */ + }; + + self->connection = G_DBUS_CONNECTION(g_object_ref(G_OBJECT(conn))); + + GError* error = nullptr; + self->object_register_id = g_dbus_connection_register_object( + conn, + "/org/freedesktop/timedate1", + self->node_info->interfaces[0], + &vtable, + self, + nullptr, + &error); + g_assert_no_error(error); + } + + static void on_name_acquired(GDBusConnection* conn, + const gchar* name, + gpointer gself) + { + g_debug("on_name_acquired"); + auto self = static_cast(gself); + self->name_acquired = true; + self->proxy = g_dbus_proxy_new_sync(conn, + G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES, + nullptr, + name, + "/org/freedesktop/timedate1", + "org.freedesktop.timedate1", + nullptr, + nullptr); + g_main_loop_quit(self->loop); + } + + static void on_name_lost(GDBusConnection* /*conn*/, + const gchar* /*name*/, + gpointer gself) + { + g_debug("on_name_lost"); + auto self = static_cast(gself); + self->name_acquired = false; + } + + static void on_bus_closed(GObject* /*object*/, + GAsyncResult* res, + gpointer gself) + { + g_debug("on_bus_closed"); + auto self = static_cast(gself); + GError* err = nullptr; + g_dbus_connection_close_finish(self->connection, res, &err); + g_assert_no_error(err); + g_main_loop_quit(self->loop); + } + + static void + timedate1_handle_method_call(GDBusConnection * connection, + const gchar * /*sender*/, + const gchar * object_path, + const gchar * interface_name, + const gchar * method_name, + GVariant * parameters, + GDBusMethodInvocation * invocation, + gpointer gself) + { + g_assert(!g_strcmp0(method_name, "SetTimezone")); + g_assert(g_variant_is_of_type(parameters, G_VARIANT_TYPE_TUPLE)); + g_assert(2 == g_variant_n_children(parameters)); + + auto child = g_variant_get_child_value(parameters, 0); + g_assert(g_variant_is_of_type(child, G_VARIANT_TYPE_STRING)); + auto self = static_cast(gself); + self->attempted_tzid = g_variant_get_string(child, nullptr); + g_debug("set tz (dbus side): '%s'", self->attempted_tzid.c_str()); + g_dbus_method_invocation_return_value(invocation, nullptr); + + /* Send PropertiesChanged */ + GError * local_error = nullptr; + auto builder = g_variant_builder_new (G_VARIANT_TYPE_ARRAY); + g_variant_builder_add (builder, + "{sv}", + "Timezone", + g_variant_new_string( + self->attempted_tzid.c_str())); + g_dbus_connection_emit_signal (connection, + NULL, + object_path, + "org.freedesktop.DBus.Properties", + "PropertiesChanged", + g_variant_new ("(sa{sv}as)", + interface_name, + builder, + NULL), + &local_error); + g_assert_no_error (local_error); + g_variant_unref(child); + + g_main_loop_quit(self->loop); + } + +protected: + + std::shared_ptr m_mock_state; + std::shared_ptr m_state; + std::shared_ptr m_live_actions; + std::shared_ptr m_actions; + + bool name_acquired; + std::string attempted_tzid; + + GTestDBus* bus; + guint own_name; + GDBusConnection* connection; + GDBusNodeInfo* node_info; + int object_register_id; + GDBusProxy *proxy; + + void SetUp() + { + super::SetUp(); + g_debug("SetUp"); + + name_acquired = false; + attempted_tzid.clear(); + connection = nullptr; + node_info = nullptr; + object_register_id = 0; + own_name = 0; + + // bring up the test bus + bus = g_test_dbus_new(G_TEST_DBUS_NONE); + g_test_dbus_up(bus); + const auto address = g_test_dbus_get_bus_address(bus); + 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); + + // parse the org.freedesktop.timedate1 interface + const gchar introspection_xml[] = + "" + " " + " " + " " + " " + " " + " " + " " + ""; + node_info = g_dbus_node_info_new_for_xml(introspection_xml, nullptr); + ASSERT_TRUE(node_info != nullptr); + ASSERT_TRUE(node_info->interfaces != nullptr); + ASSERT_TRUE(node_info->interfaces[0] != nullptr); + ASSERT_TRUE(node_info->interfaces[1] == nullptr); + ASSERT_STREQ("org.freedesktop.timedate1", node_info->interfaces[0]->name); + + // own the bus + own_name = g_bus_own_name(G_BUS_TYPE_SYSTEM, + "org.freedesktop.timedate1", + G_BUS_NAME_OWNER_FLAGS_NONE, + on_bus_acquired, on_name_acquired, on_name_lost, + this, nullptr); + ASSERT_TRUE(object_register_id == 0); + ASSERT_FALSE(name_acquired); + ASSERT_TRUE(connection == nullptr); + g_main_loop_run(loop); + ASSERT_TRUE(object_register_id != 0); + ASSERT_TRUE(name_acquired); + ASSERT_TRUE(G_IS_DBUS_CONNECTION(connection)); + + // create the State and Actions + m_mock_state.reset(new MockState); + m_mock_state->settings.reset(new Settings); + m_state = std::dynamic_pointer_cast(m_mock_state); + m_live_actions.reset(new MockLiveActions(m_state)); + m_actions = std::dynamic_pointer_cast(m_live_actions); + } + + void TearDown() + { + g_debug("TearDown"); + m_actions.reset(); + m_live_actions.reset(); + m_state.reset(); + m_mock_state.reset(); + g_dbus_connection_unregister_object(connection, object_register_id); + g_object_unref(proxy); + g_dbus_node_info_unref(node_info); + g_bus_unown_name(own_name); + g_dbus_connection_close(connection, nullptr, on_bus_closed, this); + g_main_loop_run(loop); + g_clear_object(&connection); + g_test_dbus_down(bus); + g_clear_object(&bus); + + super::TearDown(); + } +public: + void set_timezone(std::string tz) + { + g_debug("set_timezone: '%s'", tz.c_str()); + g_dbus_proxy_call_sync(proxy, + "SetTimezone", + g_variant_new("(sb)", + tz.c_str(), + FALSE), + G_DBUS_CALL_FLAGS_NONE, + 500, + nullptr, + nullptr); + } +}; + +#endif -- cgit v1.2.3