From f4d66118c3a845892b32495efec3d6473e17baca Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Mon, 1 Feb 2016 10:53:07 -0600 Subject: for low power notifications, use libnotify's 'sound-file' property instead of indicator-power calling the sound player directly --- src/CMakeLists.txt | 4 +- src/main.c | 6 +- src/notifier.c | 94 +++++-------------------- src/notifier.h | 6 +- src/sound-player-gst.c | 173 ---------------------------------------------- src/sound-player-gst.h | 70 ------------------- src/sound-player.c | 45 ------------ src/sound-player.h | 72 ------------------- tests/CMakeLists.txt | 11 +-- tests/sound-player-mock.c | 94 ------------------------- tests/sound-player-mock.h | 75 -------------------- tests/test-notify.cc | 88 +++++++++++++++-------- 12 files changed, 83 insertions(+), 655 deletions(-) delete mode 100644 src/sound-player-gst.c delete mode 100644 src/sound-player-gst.h delete mode 100644 src/sound-player.c delete mode 100644 src/sound-player.h delete mode 100644 tests/sound-player-mock.c delete mode 100644 tests/sound-player-mock.h diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 8eac086..a5e6c57 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -19,9 +19,7 @@ set(SERVICE_MANUAL_SOURCES notifier.c testing.c service.c - utils.c - sound-player.c - sound-player-gst.c) + utils.c) # generated sources include(GdbusCodegen) diff --git a/src/main.c b/src/main.c index 34185b4..ce54ae8 100644 --- a/src/main.c +++ b/src/main.c @@ -25,7 +25,6 @@ #include "device.h" #include "notifier.h" #include "service.h" -#include "sound-player-gst.h" #include "testing.h" /*** @@ -42,7 +41,6 @@ on_name_lost (gpointer instance G_GNUC_UNUSED, gpointer loop) int main (int argc G_GNUC_UNUSED, char ** argv G_GNUC_UNUSED) { - IndicatorPowerSoundPlayer * sound_player; IndicatorPowerNotifier * notifier; IndicatorPowerService * service; IndicatorPowerTesting * testing; @@ -54,8 +52,7 @@ main (int argc G_GNUC_UNUSED, char ** argv G_GNUC_UNUSED) textdomain (GETTEXT_PACKAGE); /* run */ - sound_player = indicator_power_sound_player_gst_new (); - notifier = indicator_power_notifier_new (sound_player); + notifier = indicator_power_notifier_new(); service = indicator_power_service_new(NULL, notifier); testing = indicator_power_testing_new (service); loop = g_main_loop_new (NULL, FALSE); @@ -68,6 +65,5 @@ main (int argc G_GNUC_UNUSED, char ** argv G_GNUC_UNUSED) g_clear_object (&testing); g_clear_object (&service); g_clear_object (¬ifier); - g_clear_object (&sound_player); return 0; } diff --git a/src/notifier.c b/src/notifier.c index b481fdf..00a00e5 100644 --- a/src/notifier.c +++ b/src/notifier.c @@ -27,7 +27,6 @@ #include "dbus-shared.h" #include "notifier.h" #include "utils.h" -#include "sound-player.h" #ifdef HAS_URLDISPATCHER #include @@ -56,12 +55,10 @@ enum { PROP_0, PROP_BATTERY, - PROP_SOUND_PLAYER, LAST_PROP }; #define PROP_BATTERY_NAME "battery" -#define PROP_SOUND_PLAYER_NAME "sound-player" static GParamSpec * properties[LAST_PROP]; @@ -90,8 +87,6 @@ typedef struct gboolean caps_queried; gboolean actions_supported; - IndicatorPowerSoundPlayer * sound_player; - GCancellable * cancellable; #ifdef HAS_UT_ACCTSERVICE_SYSTEMSOUND_SETTINGS DbusAccountsServiceSound * accounts_service_sound_proxy; @@ -202,36 +197,6 @@ silent_mode (IndicatorPowerNotifier * self) } #endif -static void -play_low_battery_sound (IndicatorPowerNotifier * self) -{ - const gchar * const key = LOW_BATTERY_SOUND; - gchar * filename; - priv_t * const p = get_priv(self); - - /* can't play? */ - g_return_if_fail (p->sound_player != NULL); - - #ifdef HAS_UT_ACCTSERVICE_SYSTEMSOUND_SETTINGS - /* won't play? */ - if (silent_mode(self)) - return; - #endif - - filename = datafile_find(DATAFILE_TYPE_SOUND, key); - if (filename != NULL) - { - gchar * uri = g_filename_to_uri(filename, NULL, NULL); - indicator_power_sound_player_play_uri (p->sound_player, uri); - g_free(uri); - g_free(filename); - } - else - { - g_warning("Unable to find '%s' in XDG data dirs", key); - } -} - /*** **** Notifications ***/ @@ -346,6 +311,21 @@ notification_show(IndicatorPowerNotifier * self) if (are_actions_supported(self)) { + if (!silent_mode(self)) + { + gchar* filename = datafile_find(DATAFILE_TYPE_SOUND, LOW_BATTERY_SOUND); + if (filename != NULL) + { + gchar * uri = g_filename_to_uri(filename, NULL, NULL); + notify_notification_set_hint(nn, "sound-file", g_variant_new_take_string(uri)); + g_clear_pointer(&filename, g_free); + } + else + { + g_warning("Unable to find '%s' in XDG data dirs", LOW_BATTERY_SOUND); + } + } + notify_notification_set_hint(nn, "x-canonical-snap-decisions", g_variant_new_string("true")); notify_notification_set_hint(nn, "x-canonical-non-shaped-icon", g_variant_new_string("true")); notify_notification_set_hint(nn, "x-canonical-private-affirmative-tint", g_variant_new_string("true")); @@ -402,7 +382,6 @@ on_battery_property_changed (IndicatorPowerNotifier * self) ((new_power_level != POWER_LEVEL_OK) && new_discharging && !old_discharging)) { notification_show (self); - play_low_battery_sound (self); } else if (!new_discharging || (new_power_level == POWER_LEVEL_OK)) { @@ -433,10 +412,6 @@ my_get_property (GObject * o, g_value_set_object (value, p->battery); break; - case PROP_SOUND_PLAYER: - g_value_set_object (value, p->sound_player); - break; - default: G_OBJECT_WARN_INVALID_PROPERTY_ID (o, property_id, pspec); } @@ -456,10 +431,6 @@ my_set_property (GObject * o, indicator_power_notifier_set_battery (self, g_value_get_object(value)); break; - case PROP_SOUND_PLAYER: - indicator_power_notifier_set_sound_player (self, g_value_get_object(value)); - break; - default: G_OBJECT_WARN_INVALID_PROPERTY_ID (o, property_id, pspec); } @@ -478,7 +449,6 @@ my_dispose (GObject * o) } indicator_power_notifier_set_bus (self, NULL); - indicator_power_notifier_set_sound_player (self, NULL); notification_clear (self); indicator_power_notifier_set_battery (self, NULL); g_clear_object (&p->dbus_battery); @@ -552,13 +522,6 @@ indicator_power_notifier_class_init (IndicatorPowerNotifierClass * klass) G_TYPE_OBJECT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); - properties[PROP_SOUND_PLAYER] = g_param_spec_object ( - PROP_SOUND_PLAYER_NAME, - "Sound Player", - "The current sound player", - G_TYPE_OBJECT, - G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); - g_object_class_install_properties (object_class, LAST_PROP, properties); } @@ -567,12 +530,9 @@ indicator_power_notifier_class_init (IndicatorPowerNotifierClass * klass) ***/ IndicatorPowerNotifier * -indicator_power_notifier_new (IndicatorPowerSoundPlayer * sound_player) +indicator_power_notifier_new (void) { - GObject * o = g_object_new (INDICATOR_TYPE_POWER_NOTIFIER, - PROP_SOUND_PLAYER_NAME, sound_player, - NULL); - + GObject * o = g_object_new (INDICATOR_TYPE_POWER_NOTIFIER, NULL); return INDICATOR_POWER_NOTIFIER (o); } @@ -610,26 +570,6 @@ indicator_power_notifier_set_battery (IndicatorPowerNotifier * self, } } -void -indicator_power_notifier_set_sound_player (IndicatorPowerNotifier * self, - IndicatorPowerSoundPlayer * sound_player) -{ - priv_t * p; - - g_return_if_fail(INDICATOR_IS_POWER_NOTIFIER(self)); - g_return_if_fail((sound_player == NULL) || INDICATOR_IS_POWER_SOUND_PLAYER(sound_player)); - - p = get_priv (self); - - if (p->sound_player == sound_player) - return; - - g_clear_object(&p->sound_player); - - if (sound_player != NULL) - p->sound_player = g_object_ref(sound_player); -} - void indicator_power_notifier_set_bus (IndicatorPowerNotifier * self, GDBusConnection * bus) diff --git a/src/notifier.h b/src/notifier.h index 602f6e5..1b04943 100644 --- a/src/notifier.h +++ b/src/notifier.h @@ -23,7 +23,6 @@ #include #include "device.h" -#include "sound-player.h" G_BEGIN_DECLS @@ -56,7 +55,7 @@ struct _IndicatorPowerNotifierClass GType indicator_power_notifier_get_type (void); -IndicatorPowerNotifier * indicator_power_notifier_new (IndicatorPowerSoundPlayer * sound_player); +IndicatorPowerNotifier * indicator_power_notifier_new (void); void indicator_power_notifier_set_bus (IndicatorPowerNotifier * self, GDBusConnection * connection); @@ -64,9 +63,6 @@ void indicator_power_notifier_set_bus (IndicatorPowerNotifier * self, void indicator_power_notifier_set_battery (IndicatorPowerNotifier * self, IndicatorPowerDevice * battery); -void indicator_power_notifier_set_sound_player (IndicatorPowerNotifier * self, - IndicatorPowerSoundPlayer * battery); - #define POWER_LEVEL_STR_OK "ok" #define POWER_LEVEL_STR_LOW "low" #define POWER_LEVEL_STR_VERY_LOW "very_low" diff --git a/src/sound-player-gst.c b/src/sound-player-gst.c deleted file mode 100644 index 25c3884..0000000 --- a/src/sound-player-gst.c +++ /dev/null @@ -1,173 +0,0 @@ -/* - * Copyright 2016 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 - */ - -#include "sound-player.h" -#include "sound-player-gst.h" - -#include - - -/*** -**** private struct -***/ - -typedef struct -{ - int unused; -} -IndicatorPowerSoundPlayerGSTPrivate; - -typedef IndicatorPowerSoundPlayerGSTPrivate priv_t; - -#define get_priv(o) ((priv_t*)indicator_power_sound_player_gst_get_instance_private(o)) - - -/*** -**** GObject boilerplate -***/ - -static void indicator_power_device_provider_interface_init ( - IndicatorPowerSoundPlayerInterface * iface); - -G_DEFINE_TYPE_WITH_CODE ( - IndicatorPowerSoundPlayerGST, - indicator_power_sound_player_gst, - G_TYPE_OBJECT, - G_ADD_PRIVATE(IndicatorPowerSoundPlayerGST) - G_IMPLEMENT_INTERFACE (INDICATOR_TYPE_POWER_SOUND_PLAYER, - indicator_power_device_provider_interface_init)) - -/*** -**** GSTREAMER -***/ - -static void -gst_init_once(void) -{ - static gboolean gst_init_checked = FALSE; - - if (G_UNLIKELY(!gst_init_checked)) - { - GError* error = NULL; - if (!gst_init_check(NULL, NULL, &error)) - { - g_critical("Unable to play alarm sound: %s", error->message); - g_error_free(error); - } - gst_init_checked = TRUE; - } -} - -static gboolean bus_callback(GstBus* bus G_GNUC_UNUSED, GstMessage* msg, gpointer gelement) -{ - const GstMessageType message_type = GST_MESSAGE_TYPE(msg); - - if (GST_MESSAGE_SRC(msg) != gelement) - return G_SOURCE_CONTINUE; - - /* on eos, cleanup the element and cancel our gst bus subscription */ - if (message_type == GST_MESSAGE_EOS) - { - g_debug("got GST_MESSAGE_EOS on sound play"); - gst_element_set_state(GST_ELEMENT(gelement), GST_STATE_NULL); - gst_object_unref(gelement); - return G_SOURCE_REMOVE; - } - - /* on stream start, set the media role to 'alert' if we're using pulsesink */ - if (message_type == GST_MESSAGE_STREAM_START) - { - GstElement* audio_sink = NULL; - g_debug("got GST_MESSAGE_STREAM_START on sound play"); - g_object_get(gelement, "audio-sink", &audio_sink, NULL); - if (audio_sink != NULL) - { - GstPluginFeature* feature; - feature = GST_PLUGIN_FEATURE_CAST(GST_ELEMENT_GET_CLASS(audio_sink)->elementfactory); - if (feature && g_strcmp0(gst_plugin_feature_get_name(feature), "pulsesink") == 0) - { - const gchar* const props_str = "props,media.role=alert"; - GstStructure* props = gst_structure_from_string(props_str, NULL); - g_debug("setting audio sink properties to '%s'", props_str); - g_object_set(audio_sink, "stream-properties", props, NULL); - g_clear_pointer(&props, gst_structure_free); - } - gst_object_unref(audio_sink); - } - } - - return G_SOURCE_CONTINUE; -} - -/*** -**** IndicatorPowerSoundPlayer virtual functions -***/ - -static void -my_play_uri (IndicatorPowerSoundPlayer * self G_GNUC_UNUSED, const gchar * uri) -{ - GstElement * element; - GstBus * bus; - - /* create the element */ - element = gst_element_factory_make("playbin", NULL); - - /* start listening for gst events */ - bus = gst_pipeline_get_bus(GST_PIPELINE(element)); - gst_bus_add_watch(bus, bus_callback, element); - gst_object_unref(bus); - - /* play the sound */ - g_debug("Playing '%s'", uri); - g_object_set(element, "uri", uri, NULL); - gst_element_set_state(element, GST_STATE_PLAYING); -} - -/*** -**** Instantiation -***/ - -static void -indicator_power_sound_player_gst_class_init (IndicatorPowerSoundPlayerGSTClass * klass) -{ - gst_init_once(); -} - -static void -indicator_power_device_provider_interface_init (IndicatorPowerSoundPlayerInterface * iface) -{ - iface->play_uri = my_play_uri; -} - -static void -indicator_power_sound_player_gst_init (IndicatorPowerSoundPlayerGST * self G_GNUC_UNUSED) -{ -} - -/*** -**** Public API -***/ - -IndicatorPowerSoundPlayer * -indicator_power_sound_player_gst_new(void) -{ - gpointer o = g_object_new (INDICATOR_TYPE_POWER_SOUND_PLAYER_GST, NULL); - - return INDICATOR_POWER_SOUND_PLAYER (o); -} diff --git a/src/sound-player-gst.h b/src/sound-player-gst.h deleted file mode 100644 index 3075738..0000000 --- a/src/sound-player-gst.h +++ /dev/null @@ -1,70 +0,0 @@ -/* - * Copyright 2016 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_POWER_SOUND_PLAYER_GST__H__ -#define __INDICATOR_POWER_SOUND_PLAYER_GST__H__ - -#include /* parent class */ - -#include "device-provider.h" - -G_BEGIN_DECLS - -#define INDICATOR_TYPE_POWER_SOUND_PLAYER_GST \ - (indicator_power_sound_player_gst_get_type()) - -#define INDICATOR_POWER_SOUND_PLAYER_GST(o) \ - (G_TYPE_CHECK_INSTANCE_CAST ((o), \ - INDICATOR_TYPE_POWER_SOUND_PLAYER_GST, \ - IndicatorPowerSoundPlayerGST)) - -#define INDICATOR_POWER_SOUND_PLAYER_GST_GET_CLASS(o) \ - (G_TYPE_INSTANCE_GET_CLASS ((o), \ - INDICATOR_TYPE_POWER_SOUND_PLAYER_GST, \ - IndicatorPowerSoundPlayerGSTClass)) - -#define INDICATOR_IS_POWER_SOUND_PLAYER_GST(o) \ - (G_TYPE_CHECK_INSTANCE_TYPE ((o), \ - INDICATOR_TYPE_POWER_SOUND_PLAYER_GST)) - -typedef struct _IndicatorPowerSoundPlayerGST - IndicatorPowerSoundPlayerGST; -typedef struct _IndicatorPowerSoundPlayerGSTClass - IndicatorPowerSoundPlayerGSTClass; - -/** - * An IndicatorPowerSoundPlayer which gets its devices from GST. - */ -struct _IndicatorPowerSoundPlayerGST -{ - GObject parent_instance; -}; - -struct _IndicatorPowerSoundPlayerGSTClass -{ - GObjectClass parent_class; -}; - -GType indicator_power_sound_player_gst_get_type (void); - -IndicatorPowerSoundPlayer * indicator_power_sound_player_gst_new (void); - -G_END_DECLS - -#endif /* __INDICATOR_POWER_SOUND_PLAYER_GST__H__ */ diff --git a/src/sound-player.c b/src/sound-player.c deleted file mode 100644 index dcbb27b..0000000 --- a/src/sound-player.c +++ /dev/null @@ -1,45 +0,0 @@ -/* - * Copyright 2016 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 - */ - -#include "sound-player.h" - -G_DEFINE_INTERFACE (IndicatorPowerSoundPlayer, - indicator_power_sound_player, - 0) - -static void -indicator_power_sound_player_default_init (IndicatorPowerSoundPlayerInterface * klass G_GNUC_UNUSED) -{ -} - -/*** -**** PUBLIC API -***/ - -void -indicator_power_sound_player_play_uri (IndicatorPowerSoundPlayer * self, - const gchar * uri) -{ - IndicatorPowerSoundPlayerInterface * iface; - - g_return_if_fail (INDICATOR_IS_POWER_SOUND_PLAYER (self)); - iface = INDICATOR_POWER_SOUND_PLAYER_GET_INTERFACE (self); - g_return_if_fail (iface->play_uri != NULL); - iface->play_uri (self, uri); -} diff --git a/src/sound-player.h b/src/sound-player.h deleted file mode 100644 index adff924..0000000 --- a/src/sound-player.h +++ /dev/null @@ -1,72 +0,0 @@ -/* - * Copyright 2016 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_POWER_SOUND_PLAYER__H__ -#define __INDICATOR_POWER_SOUND_PLAYER__H__ - -#include - -G_BEGIN_DECLS - -#define INDICATOR_TYPE_POWER_SOUND_PLAYER \ - (indicator_power_sound_player_get_type ()) - -#define INDICATOR_POWER_SOUND_PLAYER(obj) \ - (G_TYPE_CHECK_INSTANCE_CAST ((obj), \ - INDICATOR_TYPE_POWER_SOUND_PLAYER, \ - IndicatorPowerSoundPlayer)) - -#define INDICATOR_IS_POWER_SOUND_PLAYER(obj) \ - (G_TYPE_CHECK_INSTANCE_TYPE ((obj), INDICATOR_TYPE_POWER_SOUND_PLAYER)) - -#define INDICATOR_POWER_SOUND_PLAYER_GET_INTERFACE(inst) \ - (G_TYPE_INSTANCE_GET_INTERFACE ((inst), \ - INDICATOR_TYPE_POWER_SOUND_PLAYER, \ - IndicatorPowerSoundPlayerInterface)) - -typedef struct _IndicatorPowerSoundPlayer - IndicatorPowerSoundPlayer; - -typedef struct _IndicatorPowerSoundPlayerInterface - IndicatorPowerSoundPlayerInterface; - -/** - * An interface class for an object that plays sounds. - */ -struct _IndicatorPowerSoundPlayerInterface -{ - GTypeInterface parent_iface; - - /* virtual functions */ - void (*play_uri) (IndicatorPowerSoundPlayer * self, - const gchar * uri); -}; - -GType indicator_power_sound_player_get_type (void); - -/*** -**** -***/ - -void indicator_power_sound_player_play_uri (IndicatorPowerSoundPlayer * self, - const gchar * uri); - -G_END_DECLS - -#endif /* __INDICATOR_POWER_SOUND_PLAYER__H__ */ diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 41e48cd..566132e 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -9,13 +9,6 @@ include_directories (SYSTEM ${DBUSTEST_INCLUDE_DIRS}) # add warnings set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 ${C_WARNING_ARGS}") -# build the mocks -set(MOCK_LIB "indicatorpowerservicemocks") -set(MOCK_SOURCES sound-player-mock.c) -set_source_files_properties(${MOCK_SOURCES} - PROPERTIES COMPILE_FLAGS "${C_WARNING_ARGS} -g -std=c99") -add_library(${MOCK_LIB} STATIC ${MOCK_SOURCES}) - # build the necessary schemas set_directory_properties (PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES gschemas.compiled) @@ -57,8 +50,8 @@ function(add_test_by_name name) add_executable (${TEST_NAME} ${TEST_NAME}.cc) target_link_options(${TEST_NAME} PRIVATE -no-pie) add_test (${TEST_NAME} ${TEST_NAME}) - add_dependencies (${TEST_NAME} ${MOCK_LIB} ayatanaindicatorpowerservice gschemas-compiled) - target_link_libraries (${TEST_NAME} ${MOCK_LIB} ayatanaindicatorpowerservice gtest ${DBUSTEST_LIBRARIES} ${SERVICE_DEPS_LIBRARIES} ${GTEST_LIBS} ${URLDISPATCHER_LIBRARIES} ${GMOCK_LIBRARIES}) + add_dependencies (${TEST_NAME} ayatanaindicatorpowerservice gschemas-compiled) + target_link_libraries (${TEST_NAME} ayatanaindicatorpowerservice gtest ${DBUSTEST_LIBRARIES} ${SERVICE_DEPS_LIBRARIES} ${GTEST_LIBS} ${URLDISPATCHER_LIBRARIES} ${GMOCK_LIBRARIES}) endfunction() add_test_by_name(test-notify) add_test(NAME dear-reader-the-next-test-takes-80-seconds COMMAND true) diff --git a/tests/sound-player-mock.c b/tests/sound-player-mock.c deleted file mode 100644 index 35c3b57..0000000 --- a/tests/sound-player-mock.c +++ /dev/null @@ -1,94 +0,0 @@ -/* - * Copyright 2016 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 - */ - -#include "sound-player.h" -#include "sound-player-mock.h" - -enum -{ - SIGNAL_URI_PLAYED, - LAST_SIGNAL -}; - -static guint signals[LAST_SIGNAL] = { 0 }; - -/*** -**** GObject boilerplate -***/ - -static void indicator_power_sound_player_interface_init ( - IndicatorPowerSoundPlayerInterface * iface); - -G_DEFINE_TYPE_WITH_CODE ( - IndicatorPowerSoundPlayerMock, - indicator_power_sound_player_mock, - G_TYPE_OBJECT, - G_IMPLEMENT_INTERFACE (INDICATOR_TYPE_POWER_SOUND_PLAYER, - indicator_power_sound_player_interface_init)) - -/*** -**** IndicatorPowerSoundPlayer virtual functions -***/ - -static void -my_play_uri (IndicatorPowerSoundPlayer * self, const gchar * uri) -{ - g_signal_emit (self, signals[SIGNAL_URI_PLAYED], 0, uri, NULL); -} - -/*** -**** Instantiation -***/ - -static void -indicator_power_sound_player_mock_class_init (IndicatorPowerSoundPlayerMockClass * klass G_GNUC_UNUSED) -{ - signals[SIGNAL_URI_PLAYED] = g_signal_new ( - "uri-played", - G_TYPE_FROM_CLASS(klass), - G_SIGNAL_RUN_LAST, - G_STRUCT_OFFSET (IndicatorPowerSoundPlayerMockClass, uri_played), - NULL, NULL, - g_cclosure_marshal_VOID__STRING, - G_TYPE_NONE, 1, G_TYPE_STRING); -} - -static void -indicator_power_sound_player_interface_init (IndicatorPowerSoundPlayerInterface * iface) -{ - iface->play_uri = my_play_uri; -} - -static void -indicator_power_sound_player_mock_init (IndicatorPowerSoundPlayerMock * self G_GNUC_UNUSED) -{ -} - -/*** -**** Public API -***/ - -IndicatorPowerSoundPlayer * -indicator_power_sound_player_mock_new (void) -{ - gpointer o = g_object_new (INDICATOR_TYPE_POWER_SOUND_PLAYER_MOCK, NULL); - - return INDICATOR_POWER_SOUND_PLAYER (o); -} - diff --git a/tests/sound-player-mock.h b/tests/sound-player-mock.h deleted file mode 100644 index f844924..0000000 --- a/tests/sound-player-mock.h +++ /dev/null @@ -1,75 +0,0 @@ -/* - * Copyright 2016 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_POWER_SOUND_PLAYER_MOCK__H__ -#define __INDICATOR_POWER_SOUND_PLAYER_MOCK__H__ - -#include /* parent class */ - -#include "sound-player.h" - -G_BEGIN_DECLS - -#define INDICATOR_TYPE_POWER_SOUND_PLAYER_MOCK \ - (indicator_power_sound_player_mock_get_type()) - -#define INDICATOR_POWER_SOUND_PLAYER_MOCK(o) \ - (G_TYPE_CHECK_INSTANCE_CAST ((o), \ - INDICATOR_TYPE_POWER_SOUND_PLAYER_MOCK, \ - IndicatorPowerSoundPlayerMock)) - -#define INDICATOR_POWER_SOUND_PLAYER_MOCK_GET_CLASS(o) \ - (G_TYPE_INSTANCE_GET_CLASS ((o), \ - INDICATOR_TYPE_POWER_SOUND_PLAYER_MOCK, \ - IndicatorPowerSoundPlayerMockClass)) - -#define INDICATOR_IS_POWER_SOUND_PLAYER_MOCK(o) \ - (G_TYPE_CHECK_INSTANCE_TYPE ((o), \ - INDICATOR_TYPE_POWER_SOUND_PLAYER_MOCK)) - -typedef struct _IndicatorPowerSoundPlayerMock - IndicatorPowerSoundPlayerMock; -typedef struct _IndicatorPowerSoundPlayerMockPriv - IndicatorPowerSoundPlayerMockPriv; -typedef struct _IndicatorPowerSoundPlayerMockClass - IndicatorPowerSoundPlayerMockClass; - -/** - * An IndicatorPowerSoundPlayer which gets its devices from Mock. - */ -struct _IndicatorPowerSoundPlayerMock -{ - GObject parent_instance; -}; - -struct _IndicatorPowerSoundPlayerMockClass -{ - GObjectClass parent_class; - - /* signals */ - void (*uri_played) (IndicatorPowerSoundPlayer * self, const gchar* uri); -}; - -GType indicator_power_sound_player_mock_get_type (void); - -IndicatorPowerSoundPlayer * indicator_power_sound_player_mock_new (void); - -G_END_DECLS - -#endif /* __INDICATOR_POWER_SOUND_PLAYER_MOCK__H__ */ diff --git a/tests/test-notify.cc b/tests/test-notify.cc index 0d92d7a..d01ef5f 100644 --- a/tests/test-notify.cc +++ b/tests/test-notify.cc @@ -23,7 +23,6 @@ #include "dbus-shared.h" #include "device.h" #include "notifier.h" -#include "sound-player-mock.h" #include @@ -160,6 +159,51 @@ protected: super::TearDown(); } + + /*** + **** + ***/ + + int get_notify_call_count() const + { + // confirm that we got exactly one call + guint len {0u}; + GError* error {nullptr}; + dbus_test_dbus_mock_object_get_method_calls(mock, obj, METHOD_NOTIFY, &len, &error); + g_assert_no_error(error); + return len; + } + + std::string get_notify_call_sound_file(int call_number) + { + std::string ret; + + guint len {0u}; + GError* error {nullptr}; + auto calls = dbus_test_dbus_mock_object_get_method_calls(mock, obj, METHOD_NOTIFY, &len, &error); + g_return_val_if_fail(int(len) > call_number, ret); + g_assert_no_error(error); + + constexpr int HINTS_PARAM_POSITION {6}; + const auto& call = calls[call_number]; + g_return_val_if_fail(g_variant_n_children(call.params) > HINTS_PARAM_POSITION, ret); + auto hints = g_variant_get_child_value(call.params, HINTS_PARAM_POSITION); + const gchar* sound_file = nullptr; + auto success = g_variant_lookup(hints, "sound-file", "&s", &sound_file); + g_return_val_if_fail(success, ret); + if (sound_file != nullptr) + ret = sound_file; + g_clear_pointer(&hints, g_variant_unref); + + return ret; + } + + void clear_method_calls() + { + GError* error{nullptr}; + ASSERT_TRUE(dbus_test_dbus_mock_object_clear_method_calls(mock, obj, &error)); + g_assert_no_error(error); + } }; /*** @@ -278,8 +322,7 @@ TEST_F(NotifyFixture, LevelsDuringBatteryDrain) // set up a notifier and give it the battery so changing the battery's // charge should show up on the bus. - auto sound_player = indicator_power_sound_player_mock_new (); - auto notifier = indicator_power_notifier_new (sound_player); + auto notifier = indicator_power_notifier_new (); indicator_power_notifier_set_battery (notifier, battery); indicator_power_notifier_set_bus (notifier, bus); wait_msec(); @@ -323,21 +366,12 @@ TEST_F(NotifyFixture, LevelsDuringBatteryDrain) g_dbus_connection_signal_unsubscribe (bus, sub_tag); g_object_unref (battery); g_object_unref (notifier); - g_object_unref (sound_player); } /*** **** ***/ -namespace -{ - static void on_uri_played(IndicatorPowerSoundPlayer*, const char* uri, gpointer glast_uri) - { - *static_cast(glast_uri) = uri; - } -} - TEST_F(NotifyFixture, EventsThatChangeNotifications) { // GetCapabilities returns an array containing 'actions', so that we'll @@ -367,10 +401,7 @@ TEST_F(NotifyFixture, EventsThatChangeNotifications) // set up a notifier and give it the battery so changing the battery's // charge should show up on the bus. - std::string last_uri; - auto sound_player = indicator_power_sound_player_mock_new (); - g_signal_connect(sound_player, "uri-played", G_CALLBACK(on_uri_played), &last_uri); - auto notifier = indicator_power_notifier_new (sound_player); + auto notifier = indicator_power_notifier_new (); indicator_power_notifier_set_battery (notifier, battery); indicator_power_notifier_set_bus (notifier, bus); ChangedParams changed_params; @@ -388,7 +419,6 @@ TEST_F(NotifyFixture, EventsThatChangeNotifications) // test setup case wait_msec(); EXPECT_STREQ (POWER_LEVEL_STR_OK, changed_params.power_level.c_str()); - EXPECT_TRUE(last_uri.empty()); // change the percent past the 'low' threshold and confirm that // a) the power level changes @@ -399,48 +429,52 @@ TEST_F(NotifyFixture, EventsThatChangeNotifications) EXPECT_EQ (FIELD_POWER_LEVEL|FIELD_IS_WARNING, changed_params.fields); EXPECT_EQ (indicator_power_notifier_get_power_level(battery), changed_params.power_level); EXPECT_TRUE (changed_params.is_warning); - EXPECT_EQ (low_power_uri, last_uri); + EXPECT_EQ (1, get_notify_call_count()); + EXPECT_EQ (low_power_uri, get_notify_call_sound_file(0)); + clear_method_calls(); // now test that the warning changes if the level goes down even lower... - last_uri.clear(); changed_params = ChangedParams(); set_battery_percentage (battery, percent_very_low); wait_msec(); EXPECT_EQ (FIELD_POWER_LEVEL, changed_params.fields); EXPECT_STREQ (POWER_LEVEL_STR_VERY_LOW, changed_params.power_level.c_str()); - EXPECT_EQ (low_power_uri, last_uri); + EXPECT_EQ (1, get_notify_call_count()); + EXPECT_EQ (low_power_uri, get_notify_call_sound_file(0)); + clear_method_calls(); // ...and that the warning is taken down if the battery is plugged back in... - last_uri.clear(); + //last_uri.clear(); changed_params = ChangedParams(); g_object_set (battery, INDICATOR_POWER_DEVICE_STATE, UP_DEVICE_STATE_CHARGING, nullptr); wait_msec(); EXPECT_EQ (FIELD_IS_WARNING, changed_params.fields); EXPECT_FALSE (changed_params.is_warning); - EXPECT_TRUE(last_uri.empty()); + EXPECT_EQ (0, get_notify_call_count()); // ...and that it comes back if we unplug again... - last_uri.clear(); + //last_uri.clear(); changed_params = ChangedParams(); g_object_set (battery, INDICATOR_POWER_DEVICE_STATE, UP_DEVICE_STATE_DISCHARGING, nullptr); wait_msec(); EXPECT_EQ (FIELD_IS_WARNING, changed_params.fields); EXPECT_TRUE (changed_params.is_warning); - EXPECT_EQ (low_power_uri, last_uri); + EXPECT_EQ (1, get_notify_call_count()); + EXPECT_EQ (low_power_uri, get_notify_call_sound_file(0)); + clear_method_calls(); // ...and that it's taken down if the power level is OK - last_uri.clear(); + //last_uri.clear(); changed_params = ChangedParams(); set_battery_percentage (battery, percent_low+1); wait_msec(); EXPECT_EQ (FIELD_POWER_LEVEL|FIELD_IS_WARNING, changed_params.fields); EXPECT_STREQ (POWER_LEVEL_STR_OK, changed_params.power_level.c_str()); EXPECT_FALSE (changed_params.is_warning); - EXPECT_TRUE(last_uri.empty()); + EXPECT_EQ (0, get_notify_call_count()); // cleanup g_dbus_connection_signal_unsubscribe (bus, sub_tag); g_object_unref (notifier); g_object_unref (battery); - g_object_unref (sound_player); } -- cgit v1.2.3