unit tests for the indicator side added

5 files changed, 282 insertions, 138 deletions

diff --git a/Makefile.am b/Makefile.am
index 141bb71..357fa33 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -2,6 +2,7 @@
 SUBDIRS = \
 	src \
     data \
+    tests \
 	po
 
 EXTRA_DIST = autogen.sh
diff --git a/configure.ac b/configure.ac
index 48022e2..c83df5c 100644
--- a/configure.ac
+++ b/configure.ac
@@ -127,6 +127,7 @@ AC_OUTPUT([
 Makefile
 src/Makefile
 data/Makefile
+tests/Makefile
 po/Makefile.in
 ])
 
diff --git a/src/indicator-sound.c b/src/indicator-sound.c
index acacddc..ffe7acb 100644
--- a/src/indicator-sound.c
+++ b/src/indicator-sound.c
@@ -100,13 +100,15 @@ static void fetch_mute_value_from_dbus();
 static void prepare_state_machine();
 static void determine_state_from_volume(gdouble volume_percent);
 static void update_state(const gint state);
+
 static const gint STATE_MUTED = 0;
 static const gint STATE_ZERO = 1;
 static const gint STATE_LOW = 2;
 static const gint STATE_MEDIUM = 3;
 static const gint STATE_HIGH = 4;
 static const gint STATE_MUTED_WHILE_INPUT = 5;
-static const gint STATE_SINKS_NONE = 5;
+static const gint STATE_SINKS_NONE = 6;
+
 static GHashTable *volume_states = NULL;
 static GtkImage *speaker_image = NULL;
 static GtkWidget* primary_image = NULL;
@@ -115,6 +117,7 @@ static gint previous_state = 0;
 static gdouble initial_volume_percent = 0;
 static gboolean initial_mute = FALSE;
 
+// Construction
 static void
 indicator_sound_class_init (IndicatorSoundClass *klass)
 {
@@ -147,21 +150,91 @@ static void indicator_sound_init (IndicatorSound *self)
     return;
 }
 
+static void
+indicator_sound_dispose (GObject *object)
+{
+	IndicatorSound * self = INDICATOR_SOUND(object);
 
-/*
-Prepare states Array.
-*/
-static void prepare_state_machine()
+	if (self->service != NULL) {
+		g_object_unref(G_OBJECT(self->service));
+		self->service = NULL;
+	}
+    g_hash_table_destroy(volume_states);
+	G_OBJECT_CLASS (indicator_sound_parent_class)->dispose (object);
+	return;
+}
+
+static void
+indicator_sound_finalize (GObject *object)
 {
-    // TODO we need three more images
-    volume_states = g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL, g_free);
-    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_MUTED), g_strdup("audio-volume-muted-panel"));
-    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_ZERO), g_strdup("audio-volume-zero-panel"));
-    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_LOW), g_strdup("audio-volume-low-panel"));
-    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_MEDIUM), g_strdup("audio-volume-medium-panel"));
-    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_HIGH), g_strdup("audio-volume-high-panel"));
-    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_MUTED_WHILE_INPUT), g_strdup("audio-volume-muted-blocking-panel"));
-    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_SINKS_NONE), g_strdup("audio-output-none-panel"));
+	G_OBJECT_CLASS (indicator_sound_parent_class)->finalize (object);
+	return;
+}
+
+static GtkLabel *
+get_label (IndicatorObject * io)
+{
+	return NULL;
+}
+
+static GtkImage *
+get_icon (IndicatorObject * io)
+{
+    gchar* current_name = g_hash_table_lookup(volume_states, GINT_TO_POINTER(current_state));
+    //g_debug("At start-up attempting to set the image to %s", current_name);
+	speaker_image = GTK_IMAGE(gtk_image_new_from_icon_name(current_name, GTK_ICON_SIZE_MENU));
+	gtk_widget_show(GTK_WIDGET(speaker_image));
+	return speaker_image;
+}
+
+/* Indicator based function to get the menu for the whole
+   applet.  This starts up asking for the parts of the menu
+   from the various services. */
+static GtkMenu *
+get_menu (IndicatorObject * io)
+{
+    DbusmenuGtkMenu *menu = dbusmenu_gtkmenu_new(INDICATOR_SOUND_DBUS_NAME, INDICATOR_SOUND_DBUS_OBJECT);    
+	DbusmenuGtkClient *client = dbusmenu_gtkmenu_get_client(menu);	
+    dbusmenu_client_add_type_handler(DBUSMENU_CLIENT(client), DBUSMENU_SLIDER_MENUITEM_TYPE, new_slider_item);
+
+    // register Key-press listening on the menu widget as the slider does not allow this.
+    g_signal_connect(menu, "key-press-event", G_CALLBACK(key_press_cb), NULL);         
+
+    return GTK_MENU(menu);
+}
+
+/**
+new_slider_item:
+Create a new dBusMenu Slider item.
+**/
+static gboolean new_slider_item(DbusmenuMenuitem * newitem, DbusmenuMenuitem * parent, DbusmenuClient * client)
+{
+	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(newitem), FALSE);
+	g_return_val_if_fail(DBUSMENU_IS_GTKCLIENT(client), FALSE);
+    
+    volume_slider = ido_scale_menu_item_new_with_range ("Volume", initial_volume_percent, 0, 100, 0.5);
+	g_object_set(volume_slider, "reverse-scroll-events", TRUE, NULL);
+
+    GtkMenuItem *menu_volume_slider = GTK_MENU_ITEM(volume_slider);
+
+	dbusmenu_gtkclient_newitem_base(DBUSMENU_GTKCLIENT(client), newitem, menu_volume_slider, parent);
+	g_signal_connect(G_OBJECT(newitem), DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED, G_CALLBACK(slider_prop_change_cb), volume_slider);
+    
+    // register slider changes listening on the range
+    GtkWidget* slider = ido_scale_menu_item_get_scale((IdoScaleMenuItem*)volume_slider);  
+    g_signal_connect(slider, "value-changed", G_CALLBACK(value_changed_event_cb), newitem);     
+    // alternative callback mechanism which i could use again at some point.
+/*    g_signal_connect(slider, "change-value", G_CALLBACK(user_change_value_event_cb), newitem);     */
+    
+    // Set images on the ido
+    primary_image = ido_scale_menu_item_get_primary_image((IdoScaleMenuItem*)volume_slider);    
+    gtk_image_set_from_icon_name(GTK_IMAGE(primary_image), g_hash_table_lookup(volume_states, GINT_TO_POINTER(STATE_ZERO)), GTK_ICON_SIZE_MENU);
+    GtkWidget* secondary_image = ido_scale_menu_item_get_secondary_image((IdoScaleMenuItem*)volume_slider);                 
+    gtk_image_set_from_icon_name(GTK_IMAGE(secondary_image), g_hash_table_lookup(volume_states, GINT_TO_POINTER(STATE_HIGH)), GTK_ICON_SIZE_MENU);
+
+    gtk_widget_show_all(volume_slider);
+
+	return TRUE;
 }
 
 static void
@@ -205,6 +278,63 @@ connection_changed (IndicatorServiceManager * sm, gboolean connected, gpointer u
 	return;
 }
 
+
+
+
+/*
+Prepare states Array.
+*/
+static void prepare_state_machine()
+{
+    // TODO we need three more images
+    volume_states = g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL, g_free);
+    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_MUTED), g_strdup("audio-volume-muted-panel"));
+    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_ZERO), g_strdup("audio-volume-low-zero-panel"));
+    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_LOW), g_strdup("audio-volume-low-panel"));
+    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_MEDIUM), g_strdup("audio-volume-medium-panel"));
+    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_HIGH), g_strdup("audio-volume-high-panel"));
+    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_MUTED_WHILE_INPUT), g_strdup("audio-volume-muted-blocking-panel"));
+    g_hash_table_insert(volume_states, GINT_TO_POINTER(STATE_SINKS_NONE), g_strdup("audio-output-none-panel"));
+}
+
+
+
+static void update_state(const gint state)
+{
+/*    g_debug("update state beginning - previous_state = %i", previous_state);*/
+
+    previous_state = current_state;
+
+/*    g_debug("update state 3rd line - previous_state = %i", previous_state);*/
+
+    current_state = state;
+    gchar* image_name = g_hash_table_lookup(volume_states, GINT_TO_POINTER(current_state));
+    gtk_image_set_from_icon_name(speaker_image, image_name, GTK_ICON_SIZE_MENU);
+}
+
+
+static void determine_state_from_volume(gdouble volume_percent)
+{
+/*    g_debug("determine_state_from_volume - previous_state = %i", previous_state);*/
+
+    gint state = previous_state;
+    if (volume_percent < 30.0 && volume_percent > 0){
+        state = STATE_LOW;
+    }
+    else if(volume_percent < 70.0 && volume_percent >= 30.0){
+        state = STATE_MEDIUM;
+    }
+    else if(volume_percent >= 70.0){
+        state = STATE_HIGH;
+    }
+    else if(volume_percent == 0.0){
+        state = STATE_ZERO;
+    }    
+    update_state(state);   
+}
+ 
+
+
 static void fetch_volume_percent_from_dbus()
 {
     GError * error = NULL;
@@ -270,130 +400,6 @@ static void catch_signal_sink_mute_update(DBusGProxy *proxy, gboolean mute_value
     g_debug("signal caught - sink mute update with mute value: %i", mute_value);
     gtk_widget_set_sensitive(volume_slider, !mute_value);
 }
-
-
-static void
-indicator_sound_dispose (GObject *object)
-{
-	IndicatorSound * self = INDICATOR_SOUND(object);
-
-	if (self->service != NULL) {
-		g_object_unref(G_OBJECT(self->service));
-		self->service = NULL;
-	}
-    g_hash_table_destroy(volume_states);
-	G_OBJECT_CLASS (indicator_sound_parent_class)->dispose (object);
-	return;
-}
-
-static void
-indicator_sound_finalize (GObject *object)
-{
-	G_OBJECT_CLASS (indicator_sound_parent_class)->finalize (object);
-	return;
-}
-
-static GtkLabel *
-get_label (IndicatorObject * io)
-{
-	return NULL;
-}
-
-static GtkImage *
-get_icon (IndicatorObject * io)
-{
-    gchar* current_name = g_hash_table_lookup(volume_states, GINT_TO_POINTER(current_state));
-    g_debug("At start-up attempting to set the image to %s", current_name);
-	speaker_image = GTK_IMAGE(gtk_image_new_from_icon_name(current_name, GTK_ICON_SIZE_MENU));
-	gtk_widget_show(GTK_WIDGET(speaker_image));
-	return speaker_image;
-}
-
-static void update_state(const gint state)
-{
-/*    g_debug("update state beginning - previous_state = %i", previous_state);*/
-
-    previous_state = current_state;
-
-/*    g_debug("update state 3rd line - previous_state = %i", previous_state);*/
-
-    current_state = state;
-    gchar* image_name = g_hash_table_lookup(volume_states, GINT_TO_POINTER(current_state));
-    gtk_image_set_from_icon_name(speaker_image, image_name, GTK_ICON_SIZE_MENU);
-}
-
-
-static void determine_state_from_volume(gdouble volume_percent)
-{
-/*    g_debug("determine_state_from_volume - previous_state = %i", previous_state);*/
-
-    gint state = previous_state;
-    if (volume_percent < 30.0 && volume_percent > 0){
-        state = STATE_LOW;
-    }
-    else if(volume_percent < 70.0 && volume_percent > 30.0){
-        state = STATE_MEDIUM;
-    }
-    else if(volume_percent > 70.0){
-        state = STATE_HIGH;
-    }
-    else if(volume_percent == 0.0){
-        state = STATE_ZERO;
-    }    
-    update_state(state);   
-}
- 
-
-/* Indicator based function to get the menu for the whole
-   applet.  This starts up asking for the parts of the menu
-   from the various services. */
-static GtkMenu *
-get_menu (IndicatorObject * io)
-{
-    DbusmenuGtkMenu *menu = dbusmenu_gtkmenu_new(INDICATOR_SOUND_DBUS_NAME, INDICATOR_SOUND_DBUS_OBJECT);    
-	DbusmenuGtkClient *client = dbusmenu_gtkmenu_get_client(menu);	
-    dbusmenu_client_add_type_handler(DBUSMENU_CLIENT(client), DBUSMENU_SLIDER_MENUITEM_TYPE, new_slider_item);
-
-    // register Key-press listening on the menu widget as the slider does not allow this.
-    g_signal_connect(menu, "key-press-event", G_CALLBACK(key_press_cb), NULL);         
-
-    return GTK_MENU(menu);
-}
-
-/**
-new_slider_item:
-Create a new dBusMenu Slider item, register the 
-**/
-static gboolean new_slider_item(DbusmenuMenuitem * newitem, DbusmenuMenuitem * parent, DbusmenuClient * client)
-{
-	g_return_val_if_fail(DBUSMENU_IS_MENUITEM(newitem), FALSE);
-	g_return_val_if_fail(DBUSMENU_IS_GTKCLIENT(client), FALSE);
-    
-    volume_slider = ido_scale_menu_item_new_with_range ("Volume", initial_volume_percent, 0, 100, 0.5);
-	g_object_set(volume_slider, "reverse-scroll-events", TRUE, NULL);
-
-    GtkMenuItem *menu_volume_slider = GTK_MENU_ITEM(volume_slider);
-
-	dbusmenu_gtkclient_newitem_base(DBUSMENU_GTKCLIENT(client), newitem, menu_volume_slider, parent);
-	g_signal_connect(G_OBJECT(newitem), DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED, G_CALLBACK(slider_prop_change_cb), volume_slider);
-    
-    // register slider changes listening on the range
-    GtkWidget* slider = ido_scale_menu_item_get_scale((IdoScaleMenuItem*)volume_slider);  
-    g_signal_connect(slider, "value-changed", G_CALLBACK(value_changed_event_cb), newitem);     
-    // alternative callback mechanism which i could use again at some point.
-/*    g_signal_connect(slider, "change-value", G_CALLBACK(user_change_value_event_cb), newitem);     */
-    
-    // Set images on the ido
-    primary_image = ido_scale_menu_item_get_primary_image((IdoScaleMenuItem*)volume_slider);    
-    gtk_image_set_from_icon_name(GTK_IMAGE(primary_image), g_hash_table_lookup(volume_states, GINT_TO_POINTER(STATE_ZERO)), GTK_ICON_SIZE_MENU);
-    GtkWidget* secondary_image = ido_scale_menu_item_get_secondary_image((IdoScaleMenuItem*)volume_slider);                 
-    gtk_image_set_from_icon_name(GTK_IMAGE(secondary_image), g_hash_table_lookup(volume_states, GINT_TO_POINTER(STATE_HIGH)), GTK_ICON_SIZE_MENU);
-
-    gtk_widget_show_all(volume_slider);
-
-	return TRUE;
-}
-
 /**
 slider_prop_change_cb:
 Whenever we have a property change on a DbusmenuMenuitem this will be called. 
diff --git a/tests/Makefile.am b/tests/Makefile.am
new file mode 100644
index 0000000..05e1bd0
--- /dev/null
+++ b/tests/Makefile.am
@@ -0,0 +1,23 @@
+
+check_PROGRAMS = \
+	test-indicator-sound
+
+TESTS =
+DISTCLEANFILES = $(TESTS)
+
+#########################################
+##  test-indicator-sound
+#########################################
+test_indicator_sound_SOURCES = \
+	test-indicator-sound.c
+
+test_indicator_sound_CFLAGS = \
+	$(APPLET_CFLAGS) \
+	-Wall -Werror \
+	-I$(srcdir) \
+	-DBUILD_DIR="\"$(builddir)\""
+
+test_indicator_sound_LDADD = \
+	$(APPLET_LIBS) \
+	$(INDICATORDIR)/libsoundmenu.la
+
diff --git a/tests/test-indicator-sound.c b/tests/test-indicator-sound.c
new file mode 100644
index 0000000..81fc966
--- /dev/null
+++ b/tests/test-indicator-sound.c
@@ -0,0 +1,113 @@
+/*
+Copyright 2010 Canonical Ltd.
+
+Authors:
+    Conor Curran <conor.curran@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 
+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/>.
+*/
+
+/*#include <math.h>*/
+/*#include <glib.h>*/
+/*#include <glib-object.h>*/
+/*#include <gtk/gtk.h>*/
+/*#include <gdk/gdkkeysyms.h>*/
+/*#include <libdbusmenu-gtk/menu.h>*/
+/*#include <libido/idoscalemenuitem.h>*/
+
+/*#include <dbus/dbus-glib.h>*/
+/*#include <dbus/dbus-glib-bindings.h>*/
+
+/*#include <libindicator/indicator.h>*/
+/*#include <libindicator/indicator-object.h>*/
+/*#include <libindicator/indicator-service-manager.h>*/
+
+#include <string.h>
+#include "../src/indicator-sound.c"
+
+
+void test_libindicator_sound_init()
+{
+	IndicatorObject * sound_menu = indicator_object_new_from_file("/home/ronoc/canonical/repos/branches/indicator-sound/tests-indicator-sound/indicator-sound/src/.libs/libsoundmenu.so");
+	g_assert(sound_menu != NULL);
+	g_object_unref(G_OBJECT(sound_menu));
+}
+
+void test_libindicator_determine_state()
+{
+	IndicatorObject * sound_menu = indicator_object_new_from_file("/home/ronoc/canonical/repos/branches/indicator-sound/tests-indicator-sound/indicator-sound/src/.libs/libsoundmenu.so");
+    get_icon(sound_menu);
+
+    determine_state_from_volume(40);
+	g_assert(current_state == STATE_MEDIUM);
+
+    determine_state_from_volume(0);
+	g_assert(current_state == STATE_ZERO);
+
+    determine_state_from_volume(15);
+	g_assert(current_state == STATE_LOW);
+
+    determine_state_from_volume(70);
+	g_assert(current_state == STATE_HIGH);
+
+	g_object_unref(G_OBJECT(sound_menu));
+}
+
+void test_libindicator_image_names()
+{
+    prepare_state_machine();
+
+    gchar* muted_name = g_hash_table_lookup(volume_states, GINT_TO_POINTER(STATE_MUTED));        
+    g_assert(g_ascii_strncasecmp("audio-volume-muted-panel", muted_name, strlen("audio-volume-muted-panel")) == 0);
+
+    gchar* zero_name = g_hash_table_lookup(volume_states, GINT_TO_POINTER(STATE_ZERO));        
+    g_assert(g_ascii_strncasecmp("audio-volume-low-zero-panel", zero_name, strlen("audio-volume-low-zero-panel")) == 0);
+
+    gchar* low_name = g_hash_table_lookup(volume_states, GINT_TO_POINTER(STATE_LOW));        
+    g_assert(g_ascii_strncasecmp("audio-volume-low-panel", low_name, strlen("audio-volume-low-panel")) == 0);
+
+    gchar* medium_name = g_hash_table_lookup(volume_states, GINT_TO_POINTER(STATE_MEDIUM));        
+    g_assert(g_ascii_strncasecmp("audio-volume-medium-panel", medium_name, strlen("audio-volume-medium-panel")) == 0);
+
+    gchar* high_name = g_hash_table_lookup(volume_states, GINT_TO_POINTER(STATE_HIGH));        
+    g_assert(g_ascii_strncasecmp("audio-volume-high-panel", high_name, strlen("audio-volume-high-panel")) == 0);
+
+    gchar* blocked_name = g_hash_table_lookup(volume_states, GINT_TO_POINTER(STATE_MUTED_WHILE_INPUT));        
+    g_assert(g_ascii_strncasecmp("audio-volume-muted-blocking-panel", blocked_name, strlen("audio-volume-muted-blocking-panel")) == 0);
+
+    gchar* none_name = g_hash_table_lookup(volume_states, GINT_TO_POINTER(STATE_SINKS_NONE));        
+    g_assert(g_ascii_strncasecmp("audio-output-none-panel", none_name, strlen("audio-output-none-panel")) == 0);
+
+    // tidy up
+    g_hash_table_destroy(volume_states);
+}
+
+
+void test_libindicator_mute_switching()
+{
+
+}
+
+
+gint main (gint argc, gchar * argv[])
+{
+	g_type_init();
+	g_test_init(&argc, &argv, NULL);
+
+    g_test_add_func("/indicator-sound/indicator-sound/init", test_libindicator_sound_init);
+    g_test_add_func("/indicator-sound/indicator-sound/state_machine", test_libindicator_determine_state);
+    g_test_add_func("/indicator-sound/indicator-sound/image_names", test_libindicator_image_names);
+
+	return g_test_run ();
+}
+