Merge lp:~ted/url-dispatcher/testability into lp:url-dispatcher/13.10

[Ted Gould]

Make dispatcher more testable and add some application:/// tests

Creates a couple of small library mocks instead of relying on needing a DBus mock which was difficult and on another branch. Breaks things out so we can use those and then adds some tests for the application:/// URL.

And, it found a bug! The bug is fixed as well.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:47
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/21/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-saucy-amd64-ci/21/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-saucy-armhf-ci/21/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-saucy-i386-ci/21/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/url-dispatcher-ci/21/rebuild

review: Needs Fixing (continuous-integration)

[lp:~ted/url-dispatcher/testability]

48. By Ted Gould on 2013-09-26

Make sure to get gtest too

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:48
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/22/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-saucy-amd64-ci/22
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-saucy-armhf-ci/22/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/url-dispatcher-saucy-i386-ci/22/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/url-dispatcher-ci/22/rebuild

review: Needs Fixing (continuous-integration)

[lp:~ted/url-dispatcher/testability]

49. By Ted Gould on 2013-09-26

Cherry pick r43 from the app-id-url branch to make cancelling better

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:49
http://jenkins.qa.ubuntu.com/job/url-dispatcher-ci/24/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-saucy-amd64-ci/24
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-saucy-armhf-ci/24
    SUCCESS: http://jenkins.qa.ubuntu.com/job/url-dispatcher-saucy-i386-ci/24

Click here to trigger a rebuild:
http://s-jenkins:8080/job/url-dispatcher-ci/24/rebuild

review: Approve (continuous-integration)

[Charles Kerr (charlesk)]

These tests smell a little like indicator-session.

Looks good even despite that ;)

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2013-09-18 14:58:19 +0000
+++ CMakeLists.txt	2013-09-26 20:54:42 +0000
@@ -1,6 +1,9 @@
-project(url-dispatcher C)
+project(url-dispatcher C CXX)
 cmake_minimum_required(VERSION 2.8.9)
 
+option (enable_tests "Build tests" ON)
+option (enable_lcov "Generate Coverage Reports" ON)
+
 set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake" "${CMAKE_MODULE_PATH}")
 
 set(PACKAGE ${CMAKE_PROJECT_NAME})
@@ -65,7 +68,15 @@
 add_subdirectory(liburl-dispatcher)
 add_subdirectory(tools)
 
-# TODO
-# enable_testing()
-# add_subdirectory(tests)
+# testing & coverage
+if (${enable_tests})
+  set (GTEST_SOURCE_DIR /usr/src/gtest/src)
+  set (GTEST_INCLUDE_DIR ${GTEST_SOURCE_DIR}/..)
+  set (GTEST_LIBS -lpthread)
+  enable_testing ()
+  if (${enable_lcov})
+#    include(GCov)
+  endif ()
+  add_subdirectory(tests)
+endif ()
 

=== modified file 'debian/control'
--- debian/control	2013-09-18 14:58:19 +0000
+++ debian/control	2013-09-26 20:54:42 +0000
@@ -10,6 +10,7 @@
                intltool,
                libdbus-1-dev,
                libglib2.0-dev,
+               libgtest-dev,
                libupstart-app-launch1-dev,
                python,
 Standards-Version: 3.9.4

=== modified file 'service/CMakeLists.txt'
--- service/CMakeLists.txt	2013-09-20 01:15:27 +0000
+++ service/CMakeLists.txt	2013-09-26 20:54:42 +0000
@@ -28,16 +28,31 @@
 )
 
 ###########################
+# Dispatcher Lib
+###########################
+
+add_library(dispatcher-lib STATIC
+	dispatcher.h
+	dispatcher.c)
+
+target_link_libraries(dispatcher-lib
+	service-generated
+	${GLIB2_LIBRARIES}
+	${GOBJECT2_LIBRARIES}
+	${GIO2_LIBRARIES}
+)
+
+###########################
 # Service Executable
 ###########################
 
 include_directories(${CMAKE_CURRENT_BINARY_DIR})
 
-add_executable(service-exec dispatcher.c recoverable-problem.h recoverable-problem.c)
+add_executable(service-exec service.c recoverable-problem.h recoverable-problem.c)
 
 set_target_properties(service-exec PROPERTIES OUTPUT_NAME "url-dispatcher")
 
-target_link_libraries(service-exec service-generated ${UPSTART_APP_LAUNCH_LIBRARIES})
+target_link_libraries(service-exec dispatcher-lib ${UPSTART_APP_LAUNCH_LIBRARIES})
 
 ###########################
 # Installation

=== modified file 'service/dispatcher.c'
--- service/dispatcher.c	2013-09-20 01:15:27 +0000
+++ service/dispatcher.c	2013-09-26 20:54:42 +0000
@@ -17,11 +17,11 @@
 
 #include <gio/gio.h>
 #include <upstart-app-launch.h>
+#include "dispatcher.h"
 #include "service-iface.h"
 #include "recoverable-problem.h"
 
 /* Globals */
-static GMainLoop * mainloop = NULL;
 static GCancellable * cancellable = NULL;
 static ServiceIfaceComCanonicalURLDispatcher * skel = NULL;
 static GRegex * applicationre = NULL;
@@ -200,7 +200,7 @@
 
 /* Get a URL off of the bus */
 static gboolean
-dispatch_url (GObject * skel, GDBusMethodInvocation * invocation, const gchar * url, gpointer user_data)
+dispatch_url_cb (GObject * skel, GDBusMethodInvocation * invocation, const gchar * url, gpointer user_data)
 {
 	g_debug("Dispatching URL: %s", url);
 
@@ -208,6 +208,19 @@
 		return bad_url(invocation, url);
 	}
 
+	if (dispatch_url(url)) {
+		g_dbus_method_invocation_return_value(invocation, NULL);
+	} else {
+		bad_url(invocation, url);
+	}
+
+	return TRUE;
+}
+
+/* The core of the URL handling */
+gboolean
+dispatch_url (const gchar * url)
+{
 	/* Special case the application URL */
 	GMatchInfo * appmatch = NULL;
 	if (g_regex_match(applicationre, url, 0, &appmatch)) {
@@ -217,7 +230,6 @@
 		g_free(appid);
 		g_match_info_free(appmatch);
 
-		g_dbus_method_invocation_return_value(invocation, NULL);
 		return TRUE;
 	}
 	g_match_info_free(appmatch);
@@ -231,19 +243,19 @@
 		if (g_regex_match(url_types[i].regex_object, url, 0, NULL)) {
 			pass_url_to_app(url_types[i].app_id, url);
 
-			g_dbus_method_invocation_return_value(invocation, NULL);
 			return TRUE;
 		}
 	}
 
-	return bad_url(invocation, url);
+	return FALSE;
 }
 
 /* We're goin' down cap'n */
 static void
 name_lost (GDBusConnection * con, const gchar * name, gpointer user_data)
 {
-	g_error("Unable to get name '%s'", name);
+	GMainLoop * mainloop = (GMainLoop *)user_data;
+	g_warning("Unable to get name '%s'", name);
 	g_main_loop_quit(mainloop);
 	return;
 }
@@ -252,14 +264,18 @@
 static void
 bus_got (GObject * obj, GAsyncResult * res, gpointer user_data)
 {
+	GMainLoop * mainloop = (GMainLoop *)user_data;
 	GDBusConnection * bus = NULL;
 	GError * error = NULL;
 
 	bus = g_bus_get_finish(res, &error);
 
 	if (error != NULL) {
-		g_error("Unable to connect to D-Bus: %s", error->message);
-		g_main_loop_quit(mainloop);
+		if (!g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
+			g_error("Unable to connect to D-Bus: %s", error->message);
+			g_main_loop_quit(mainloop);
+		}
+		g_error_free(error);
 		return;
 	}
 
@@ -277,31 +293,34 @@
 		G_BUS_NAME_OWNER_FLAGS_NONE, /* flags */
 		NULL, /* name acquired */
 		name_lost,
-		NULL, NULL); /* user data */
+		user_data, NULL); /* user data */
 
 	g_object_unref(bus);
 
 	return;
 }
 
-/* Where it all begins */
-int
-main (int argc, char * argv[])
+/* Initialize all the globals */
+gboolean
+dispatcher_init (GMainLoop * mainloop)
 {
-	mainloop = g_main_loop_new(NULL, FALSE);
 	cancellable = g_cancellable_new();
-	applicationre = g_regex_new("^application:///([a-zA-Z0-9_-]*)\\.desktop$", 0, 0, NULL);
+	applicationre = g_regex_new("^application:///([a-zA-Z0-9_\\.-]*)\\.desktop$", 0, 0, NULL);
 
-	g_bus_get(G_BUS_TYPE_SESSION, cancellable, bus_got, NULL);
+	g_bus_get(G_BUS_TYPE_SESSION, cancellable, bus_got, mainloop);
 
 	skel = service_iface_com_canonical_urldispatcher_skeleton_new();
-	g_signal_connect(skel, "handle-dispatch-url", G_CALLBACK(dispatch_url), NULL);
-
-	/* Run Main */
-	g_main_loop_run(mainloop);
-
-	/* Clean up globals */
-	g_main_loop_unref(mainloop);
+	g_signal_connect(skel, "handle-dispatch-url", G_CALLBACK(dispatch_url_cb), NULL);
+
+	return TRUE;
+}
+
+/* Clean up all the globals */
+gboolean
+dispatcher_shutdown (void)
+{
+	g_cancellable_cancel(cancellable);
+
 	g_object_unref(cancellable);
 	g_object_unref(skel);
 	g_regex_unref(applicationre);
@@ -311,5 +330,5 @@
 		g_clear_pointer(&url_types[i].regex_object, g_regex_unref);
 	}
 
-	return 0;
+	return TRUE;
 }

=== added file 'service/dispatcher.h'
--- service/dispatcher.h	1970-01-01 00:00:00 +0000
+++ service/dispatcher.h	2013-09-26 20:54:42 +0000
@@ -0,0 +1,31 @@
+/**
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include <glib.h>
+
+#ifndef __DISPATCHER_H__
+#define __DISPATCHER_H__ 1
+
+G_BEGIN_DECLS
+
+gboolean dispatcher_init (GMainLoop * mainloop);
+gboolean dispatcher_shutdown (void);
+gboolean dispatch_url (const gchar * url);
+
+G_END_DECLS
+
+#endif /* __DISPATCHER_H__ */

=== added file 'service/service.c'
--- service/service.c	1970-01-01 00:00:00 +0000
+++ service/service.c	2013-09-26 20:54:42 +0000
@@ -0,0 +1,39 @@
+/**
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include <glib.h>
+#include "dispatcher.h"
+
+GMainLoop * mainloop = NULL;
+
+/* Where it all begins */
+int
+main (int argc, char * argv[])
+{
+	mainloop = g_main_loop_new(NULL, FALSE);
+
+	dispatcher_init(mainloop);
+
+	/* Run Main */
+	g_main_loop_run(mainloop);
+
+	/* Clean up globals */
+	dispatcher_shutdown();
+	g_main_loop_unref(mainloop);
+
+	return 0;
+}

=== added directory 'tests'
=== added file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/CMakeLists.txt	2013-09-26 20:54:42 +0000
@@ -0,0 +1,40 @@
+
+###########################
+# Google Test
+###########################
+
+include_directories(${GTEST_INCLUDE_DIR})
+
+add_library (gtest STATIC
+             ${GTEST_SOURCE_DIR}/gtest-all.cc
+             ${GTEST_SOURCE_DIR}/gtest_main.cc)
+
+
+###########################
+# Mock Lib
+###########################
+
+add_library(mock-lib STATIC
+	recoverable-problem-mock.c
+	upstart-app-launch-mock.h
+	upstart-app-launch-mock.c)
+
+target_link_libraries(mock-lib
+	${GLIB2_LIBRARIES}
+)
+
+###########################
+# App ID URL test
+###########################
+
+include_directories("${CMAKE_SOURCE_DIR}/service")
+
+add_executable (dispatcher-test dispatcher-test.cc)
+target_link_libraries (dispatcher-test
+	dispatcher-lib
+	mock-lib
+	gtest
+	${GTEST_LIBS})
+
+add_test (dispatcher-test dispatcher-test)
+

=== added file 'tests/dispatcher-test.cc'
--- tests/dispatcher-test.cc	1970-01-01 00:00:00 +0000
+++ tests/dispatcher-test.cc	2013-09-26 20:54:42 +0000
@@ -0,0 +1,87 @@
+/**
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+
+#include <gio/gio.h>
+#include <gtest/gtest.h>
+#include "dispatcher.h"
+#include "upstart-app-launch-mock.h"
+
+class DispatcherTest : public ::testing::Test
+{
+	private:
+		GTestDBus * testbus = NULL;
+		GMainLoop * mainloop = NULL;
+
+	protected:
+		virtual void SetUp() {
+			testbus = g_test_dbus_new(G_TEST_DBUS_NONE);
+			g_test_dbus_up(testbus);
+
+			mainloop = g_main_loop_new(NULL, FALSE);
+			dispatcher_init(mainloop);
+
+			return;
+		}
+
+		virtual void TearDown() {
+			dispatcher_shutdown();
+
+			/* Clean up queued events */
+			while (g_main_pending()) {
+				g_main_iteration(TRUE);
+			}
+
+			g_main_loop_unref(mainloop);
+
+			upstart_app_launch_mock_clear_last_app_id();
+
+			g_test_dbus_down(testbus);
+			g_object_unref(testbus);
+			return;
+		}
+};
+
+TEST_F(DispatcherTest, ApplicationTest)
+{
+	/* Good sanity check */
+	dispatch_url("application:///foo.desktop");
+	ASSERT_STREQ("foo", upstart_app_launch_mock_get_last_app_id());
+	upstart_app_launch_mock_clear_last_app_id();
+
+	/* No .desktop */
+	dispatch_url("application:///foo");
+	ASSERT_TRUE(NULL == upstart_app_launch_mock_get_last_app_id());
+	upstart_app_launch_mock_clear_last_app_id();
+
+	/* Missing a / */
+	dispatch_url("application://foo.desktop");
+	ASSERT_TRUE(NULL == upstart_app_launch_mock_get_last_app_id());
+	upstart_app_launch_mock_clear_last_app_id();
+
+	/* Good with hyphens */
+	dispatch_url("application:///my-really-cool-app.desktop");
+	ASSERT_STREQ("my-really-cool-app", upstart_app_launch_mock_get_last_app_id());
+	upstart_app_launch_mock_clear_last_app_id();
+
+	/* Good Click Style */
+	dispatch_url("application:///com.test.foo_bar-app_0.3.4.desktop");
+	ASSERT_STREQ("com.test.foo_bar-app_0.3.4", upstart_app_launch_mock_get_last_app_id());
+	upstart_app_launch_mock_clear_last_app_id();
+
+	return;
+}

=== added file 'tests/recoverable-problem-mock.c'
--- tests/recoverable-problem-mock.c	1970-01-01 00:00:00 +0000
+++ tests/recoverable-problem-mock.c	2013-09-26 20:54:42 +0000
@@ -0,0 +1,28 @@
+/*
+ * 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:
+ *     Ted Gould <[e-mail]>
+ */
+
+#include <gio/gio.h>
+#include "recoverable-problem.h"
+
+void
+report_recoverable_problem (const gchar * signature, GPid report_pid, gboolean wait, gchar * additional_properties[])
+{
+
+	return;
+}

=== added file 'tests/upstart-app-launch-mock.c'
--- tests/upstart-app-launch-mock.c	1970-01-01 00:00:00 +0000
+++ tests/upstart-app-launch-mock.c	2013-09-26 20:54:42 +0000
@@ -0,0 +1,43 @@
+/**
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include <upstart-app-launch.h>
+#include "upstart-app-launch-mock.h"
+
+static gchar * last_appid = NULL;
+
+gboolean
+upstart_app_launch_start_application (const gchar * appid, const gchar * const * uris)
+{
+	upstart_app_launch_mock_clear_last_app_id();
+	last_appid = g_strdup(appid);
+	return TRUE;
+}
+
+void
+upstart_app_launch_mock_clear_last_app_id (void)
+{
+	g_free(last_appid);
+	last_appid = NULL;
+	return;
+}
+
+gchar *
+upstart_app_launch_mock_get_last_app_id (void)
+{
+	return last_appid;
+}

=== added file 'tests/upstart-app-launch-mock.h'
--- tests/upstart-app-launch-mock.h	1970-01-01 00:00:00 +0000
+++ tests/upstart-app-launch-mock.h	2013-09-26 20:54:42 +0000
@@ -0,0 +1,30 @@
+/**
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include <glib.h>
+
+#ifndef __UPSTART_APP_LAUNCH_MOCK__
+#define __UPSTART_APP_LAUNCH_MOCK__ 1
+
+G_BEGIN_DECLS
+
+void upstart_app_launch_mock_clear_last_app_id (void);
+gchar * upstart_app_launch_mock_get_last_app_id (void);
+
+G_END_DECLS
+
+#endif /* __UPSTART_APP_LAUNCH_MOCK__ */