Merge lp:~ted/ubuntu-app-launch/cache-sync-in-file into lp:ubuntu-app-launch/15.04

[Ted Gould]

Have desktop hook verify source file still exists

The change was relatively small with adding the path that it was created in to the desktop file, then checking it. But upon doing that I realized that there were no desktop-hook tests, so those are added as well (including testing the change).

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:203
http://jenkins.qa.ubuntu.com/job/upstart-app-launch-ci/320/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/upstart-app-launch-vivid-amd64-ci/15
    SUCCESS: http://jenkins.qa.ubuntu.com/job/upstart-app-launch-vivid-armhf-ci/15
    SUCCESS: http://jenkins.qa.ubuntu.com/job/upstart-app-launch-vivid-i386-ci/15

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/upstart-app-launch-ci/320/rebuild

review: Approve (continuous-integration)

[Charles Kerr (charlesk)]

LGTM, some very optional suggestions inlined at https://code.launchpad.net/~ted/ubuntu-app-launch/cache-sync-in-file/+merge/255308

review: Approve

[lp:~ted/ubuntu-app-launch/cache-sync-in-file]

204. By Ted Gould on 2015-04-08

Fix typo

205. By Ted Gould on 2015-04-08

Move unref so that there's only one, error or not.

=== modified file 'desktop-hook.c'
--- desktop-hook.c	2014-09-19 15:48:29 +0000
+++ desktop-hook.c	2015-04-08 20:44:39 +0000
@@ -67,6 +67,7 @@
 #define EXEC_KEY           "Exec"
 #define ICON_KEY           "Icon"
 #define SYMBOLIC_ICON_KEY  "X-Ubuntu-SymbolicIcon"
+#define SOURCE_FILE_KEY    "X-Ubuntu-UAL-Source-Desktop"
 /* Other */
 #define OLD_KEY_PREFIX     "X-Ubuntu-Old-"
 
@@ -136,6 +137,42 @@
 	return;
 }
 
+/* Look at the desktop file and ensure that it was built by us, and if it
+   was that its source still exists */
+gboolean
+desktop_source_exists (const gchar * dir, const gchar * name)
+{
+	gchar * desktopfile = g_build_filename(dir, name, NULL);
+
+	GKeyFile * keyfile = g_key_file_new();
+	g_key_file_load_from_file(keyfile,
+		desktopfile,
+		G_KEY_FILE_NONE,
+		NULL); /* No error */
+
+	if (!g_key_file_has_key(keyfile, DESKTOP_GROUP, SOURCE_FILE_KEY, NULL)) {
+		g_free(desktopfile);
+		g_key_file_free(keyfile);
+		return FALSE;
+	}
+
+	/* At this point we know the key exists, so if we can't find the source
+	   file we want to delete the file as well. We need to replace it. */
+	gchar * originalfile = g_key_file_get_string(keyfile, DESKTOP_GROUP, SOURCE_FILE_KEY, NULL);
+	g_key_file_free(keyfile);
+	gboolean found = TRUE;
+
+	if (!g_file_test(originalfile, G_FILE_TEST_EXISTS)) {
+		g_remove(desktopfile);
+		found = FALSE;
+	}
+
+	g_free(originalfile);
+	g_free(desktopfile);
+
+	return found;
+}
+
 /* Look at an desktop file entry */
 void
 add_desktop_file (const gchar * dir, const gchar * name, GArray * app_array)
@@ -144,6 +181,10 @@
 		return;
 	}
 
+	if (!desktop_source_exists(dir, name)) {
+		return;
+	}
+
 	gchar * appid = g_strdup(name);
 	g_strstr_len(appid, -1, ".desktop")[0] = '\0';
 
@@ -392,6 +433,9 @@
 	/* Adding an Application ID */
 	g_key_file_set_string(keyfile, DESKTOP_GROUP, APP_ID_KEY, app_id);
 
+	/* Adding the source file path */
+	g_key_file_set_string(keyfile, DESKTOP_GROUP, SOURCE_FILE_KEY, from);
+
 	/* Output */
 	gsize datalen = 0;
 	gchar * data = g_key_file_to_data(keyfile, &datalen, &error);
@@ -426,14 +470,27 @@
 		return;
 	}
 
+	/* Read in the database */
+	ClickDB * db = click_db_new();
+	click_db_read(db, g_getenv("TEST_CLICK_DB"), &error);
+	if (error != NULL) {
+		g_warning("Unable to read Click database: %s", error->message);
+		g_error_free(error);
+		g_free(package);
+		g_object_unref(db);
+		return;
+	}
+
 	/* Check click to find out where the files are */
-	ClickUser * user = click_user_new_for_user(NULL, NULL, &error);
+	ClickUser * user = click_user_new_for_user(db, g_getenv("TEST_CLICK_USER"), &error);
+	g_object_unref(db);
 	if (error != NULL) {
 		g_warning("Unable to read Click database: %s", error->message);
 		g_error_free(error);
 		g_free(package);
 		return;
 	}
+
 	gchar * pkgdir = click_user_get_path(user, package, &error);
 	if (error != NULL) {
 		g_warning("Unable to get the Click package directory for %s: %s", package, error->message);

=== modified file 'libubuntu-app-launch/ubuntu-app-launch.c'
--- libubuntu-app-launch/ubuntu-app-launch.c	2015-03-02 19:59:55 +0000
+++ libubuntu-app-launch/ubuntu-app-launch.c	2015-04-08 20:44:39 +0000
@@ -1596,6 +1596,7 @@
 	if (error != NULL) {
 		g_warning("Unable to read Click database: %s", error->message);
 		g_error_free(error);
+		g_object_unref(db);
 		return NULL;
 	}
 	/* If TEST_CLICK_USER is unset, this uses the current user name. */

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2014-11-11 22:05:30 +0000
+++ tests/CMakeLists.txt	2015-04-08 20:44:39 +0000
@@ -82,3 +82,8 @@
 target_link_libraries (cgroup-reap-test gtest ${GTEST_LIBS} ${DBUSTEST_LIBRARIES} ${GIO2_LIBRARIES})
 add_test (cgroup-reap-test cgroup-reap-test)
 
+# Desktop Hook Test
+
+configure_file ("click-desktop-hook-db/test.conf.in" "${CMAKE_CURRENT_BINARY_DIR}/click-desktop-hook-db/test.conf" @ONLY)
+configure_file ("desktop-hook-test.sh.in" "${CMAKE_CURRENT_BINARY_DIR}/desktop-hook-test.sh" @ONLY)
+add_test (desktop-hook-test desktop-hook-test.sh)

=== added directory 'tests/click-desktop-hook-db'
=== added file 'tests/click-desktop-hook-db/test.conf.in'
--- tests/click-desktop-hook-db/test.conf.in	1970-01-01 00:00:00 +0000
+++ tests/click-desktop-hook-db/test.conf.in	2015-04-08 20:44:39 +0000
@@ -0,0 +1,2 @@
+[Click Database]
+root = @CMAKE_CURRENT_BINARY_DIR@/click-root-desktop-hook

=== added file 'tests/desktop-hook-test.sh.in'
--- tests/desktop-hook-test.sh.in	1970-01-01 00:00:00 +0000
+++ tests/desktop-hook-test.sh.in	2015-04-08 20:44:39 +0000
@@ -0,0 +1,91 @@
+#!/bin/bash -e
+
+TEST_DIR=@CMAKE_CURRENT_BINARY_DIR@
+SRC_DIR=@CMAKE_CURRENT_SOURCE_DIR@
+
+CACHE_DIR=${TEST_DIR}/desktop-hook-test-click-dir
+CLICK_DIR=${CACHE_DIR}/ubuntu-app-launch/desktop/
+
+DATA_DIR=${TEST_DIR}/desktop-hook-test-apps-dir
+APPS_DIR=${DATA_DIR}/applications/
+
+# Remove the old directories
+rm -rf ${CACHE_DIR}
+rm -rf ${DATA_DIR}
+rm -f @CMAKE_CURRENT_BINARY_DIR@/click-root-desktop-hook
+
+# Copy our source applications
+mkdir -p ${CLICK_DIR}
+cp ${SRC_DIR}/link-farm/* ${CLICK_DIR}
+
+# Build our root dir
+ln -s @CMAKE_CURRENT_SOURCE_DIR@/click-root-dir @CMAKE_CURRENT_BINARY_DIR@/click-root-desktop-hook
+
+# Setup the environment
+export XDG_CACHE_HOME=${CACHE_DIR}
+export XDG_DATA_HOME=${DATA_DIR}
+export TEST_CLICK_DB=@CMAKE_CURRENT_BINARY_DIR@/click-desktop-hook-db
+export TEST_CLICK_USER=test-user
+
+# Run the tool
+@CMAKE_BINARY_DIR@/desktop-hook
+
+# Check that the files exist
+
+if [ ! -e ${APPS_DIR}/com.test.good_application_1.2.3.desktop ] ; then
+	echo "Desktop file not created for: com.test.good_application_1.2.3"
+	exit 1
+fi
+
+if [ ! -e ${APPS_DIR}/com.test.multiple_first_1.2.3.desktop ] ; then
+	echo "Desktop file not created for: com.test.multiple_first_1.2.3"
+	exit 1
+fi
+
+# Verify we're adding containment to them
+
+grep "^Exec=aa-exec-click -p com.test.good_application_1.2.3 --" ${APPS_DIR}/com.test.good_application_1.2.3.desktop > /dev/null
+grep "^Exec=aa-exec-click -p com.test.multiple_first_1.2.3 --" ${APPS_DIR}/com.test.multiple_first_1.2.3.desktop > /dev/null
+
+# Make sure they have the AppID (people started using it) :-/
+
+grep "^X-Ubuntu-Application-ID=com.test.good_application_1.2.3" ${APPS_DIR}/com.test.good_application_1.2.3.desktop > /dev/null
+grep "^X-Ubuntu-Application-ID=com.test.multiple_first_1.2.3" ${APPS_DIR}/com.test.multiple_first_1.2.3.desktop > /dev/null
+
+# Remove a file and ensure it gets recreated
+
+rm -f ${APPS_DIR}/com.test.good_application_1.2.3.desktop
+@CMAKE_BINARY_DIR@/desktop-hook
+
+if [ ! -e ${APPS_DIR}/com.test.good_application_1.2.3.desktop ] ; then
+	echo "Desktop file not recreated for: com.test.good_application_1.2.3"
+	exit 1
+fi
+
+# Remove a source file and make sure it goes
+
+rm -f ${CLICK_DIR}/com.test.multiple_first_1.2.3.desktop
+@CMAKE_BINARY_DIR@/desktop-hook
+if [ -e ${APPS_DIR}/com.test.multiple_first_1.2.3.desktop ] ; then
+	echo "Not cleaning up deleted files"
+	exit 1
+fi
+
+# Verify the good file is in the desktop hook root
+grep "^X-Ubuntu-UAL-Source-Desktop=@CMAKE_CURRENT_BINARY_DIR@/click-root-desktop-hook" ${APPS_DIR}/com.test.good_application_1.2.3.desktop > /dev/null 
+
+# Remove our root
+rm -f @CMAKE_CURRENT_BINARY_DIR@/click-root-desktop-hook
+
+# Point to the new db and run
+export TEST_CLICK_DB=@CMAKE_CURRENT_BINARY_DIR@/click-db-dir
+@CMAKE_BINARY_DIR@/desktop-hook
+
+# Verify that we have the file and it's in the new root
+if [ ! -e ${APPS_DIR}/com.test.good_application_1.2.3.desktop ] ; then
+	echo "Desktop file not created for: com.test.good_application_1.2.3"
+	exit 1
+fi
+
+grep "^X-Ubuntu-UAL-Source-Desktop=@CMAKE_CURRENT_SOURCE_DIR@/click-root-dir" ${APPS_DIR}/com.test.good_application_1.2.3.desktop > /dev/null 
+