Merge lp:~attente/content-hub/content-hub-glib-2 into lp:content-hub

[William Hua]

Add GLib bindings (LP: #1624437)

Add GLib bindings (LP: #1624437)

There's a GTK branch (wip/attente/mir-content-hub) that needs this for copy-paste support.

[lp:~attente/content-hub/content-hub-glib-2]

310. By William Hua on 2016-12-01

Fix build failure on zesty due to googletest 1.8. Also refactored
tests/acceptance-tests/CMakeLists.txt to make adding tests less
cumbersome. (LP: #1644062)

311. By William Hua on 2016-12-01

Group the commands better

[Ken VanDine (ken-vandine)]

Thanks, looks great

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2016-11-28 17:34:27 +0000
+++ CMakeLists.txt	2016-12-01 18:19:18 +0000
@@ -116,8 +116,14 @@
 set(exec_prefix ${prefix}/bin)
 set(libdir ${prefix}/${CMAKE_INSTALL_LIBDIR})
 set(pkg-name "libcontent-hub")
+set(glib-pkg-name "libcontent-hub-glib")
 configure_file(libcontent-hub.pc.in libcontent-hub.pc @ONLY)
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/libcontent-hub.pc DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)
+configure_file(libcontent-hub-glib.pc.in libcontent-hub-glib.pc @ONLY)
+install(FILES
+  ${CMAKE_CURRENT_BINARY_DIR}/libcontent-hub.pc
+  ${CMAKE_CURRENT_BINARY_DIR}/libcontent-hub-glib.pc
+  DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig
+)
 
 # There's no nice way to format this. Thanks CMake.
 add_test(LGPL-required

=== modified file 'debian/control'
--- debian/control	2016-10-25 18:45:11 +0000
+++ debian/control	2016-12-01 18:19:18 +0000
@@ -59,6 +59,20 @@
  securely and efficiently exchange content.
  This package includes the content sharing libraries.
 
+Package: libcontent-hub-glib0
+Section: libs
+Architecture: any
+Multi-Arch: same
+Pre-Depends: ${misc:Pre-Depends},
+Depends: ${misc:Depends},
+         ${shlibs:Depends},
+Suggests: content-hub
+Description: content sharing/picking library - GLib bindings
+ Content sharing/picking infrastructure and service, designed to allow apps to
+ securely and efficiently exchange content.
+ .
+ This package includes GLib bindings of the content sharing libraries.
+
 Package: libcontent-hub-dev
 Section: libdevel
 Architecture: any
@@ -68,6 +82,15 @@
 Description: content sharing development files
  All the development headers and libraries for the content hub
 
+Package: libcontent-hub-glib-dev
+Section: libdevel
+Architecture: any
+Multi-Arch: same
+Depends: libcontent-hub-glib0 (= ${binary:Version}),
+         ${misc:Depends},
+Description: content sharing development files - GLib bindings
+ GLib bindings of the development headers and libraries for the content hub
+
 Package: qtdeclarative5-ubuntu-content1
 Section: libs
 Architecture: any

=== modified file 'debian/libcontent-hub-dev.install'
--- debian/libcontent-hub-dev.install	2013-09-30 21:28:46 +0000
+++ debian/libcontent-hub-dev.install	2016-12-01 18:19:18 +0000
@@ -1,3 +1,3 @@
-usr/include
+usr/include/com/ubuntu/content/*.h
 usr/lib/*/libcontent-hub.so
-usr/lib/*/pkgconfig
+usr/lib/*/pkgconfig/libcontent-hub.pc

=== added file 'debian/libcontent-hub-glib-dev.install'
--- debian/libcontent-hub-glib-dev.install	1970-01-01 00:00:00 +0000
+++ debian/libcontent-hub-glib-dev.install	2016-12-01 18:19:18 +0000
@@ -0,0 +1,3 @@
+usr/include/com/ubuntu/content/glib/*
+usr/lib/*/libcontent-hub-glib.so
+usr/lib/*/pkgconfig/libcontent-hub-glib.pc

=== added file 'debian/libcontent-hub-glib0.install'
--- debian/libcontent-hub-glib0.install	1970-01-01 00:00:00 +0000
+++ debian/libcontent-hub-glib0.install	2016-12-01 18:19:18 +0000
@@ -0,0 +1,1 @@
+usr/lib/*/libcontent-hub-glib.so.*

=== modified file 'debian/libcontent-hub0.install'
--- debian/libcontent-hub0.install	2013-08-26 21:58:01 +0000
+++ debian/libcontent-hub0.install	2016-12-01 18:19:18 +0000
@@ -1,1 +1,1 @@
-usr/lib/*/lib*.so.*
+usr/lib/*/libcontent-hub.so.*

=== added file 'libcontent-hub-glib.pc.in'
--- libcontent-hub-glib.pc.in	1970-01-01 00:00:00 +0000
+++ libcontent-hub-glib.pc.in	2016-12-01 18:19:18 +0000
@@ -0,0 +1,11 @@
+prefix=@prefix@
+exec_prefix=@exec_prefix@
+libdir=@libdir@
+includedir=${prefix}/include
+
+Name: @glib-pkg-name@
+Description: content sharing/picking library - GLib bindings
+Version: @CONTENT_HUB_VERSION@
+Libs: -L${libdir} -lcontent-hub-glib
+Cflags: -I${includedir}
+Requires: gio-2.0

=== modified file 'src/com/ubuntu/content/CMakeLists.txt'
--- src/com/ubuntu/content/CMakeLists.txt	2016-09-22 18:10:11 +0000
+++ src/com/ubuntu/content/CMakeLists.txt	2016-12-01 18:19:18 +0000
@@ -28,6 +28,8 @@
   ${UBUNTU_DOWNLOAD_MANAGER_INCLUDE_DIRS}
   ${NOTIFY_INCLUDE_DIRS}
   ${APPARMOR_INCLUDE_DIRS}
+  ${GLIB_INCLUDE_DIRS}
+  ${GIO_INCLUDE_DIRS}
 )
 
 qt5_add_dbus_interface(
@@ -120,8 +122,66 @@
     ${APPARMOR_LDFLAGS}
 )
 
-install(
-  TARGETS content-hub
+find_program(
+  GDBUS_CODEGEN
+  gdbus-codegen
+)
+
+set(
+  DBUS_XML
+  ${CMAKE_CURRENT_SOURCE_DIR}/detail/com.ubuntu.content.Handler.xml
+  ${CMAKE_CURRENT_SOURCE_DIR}/detail/com.ubuntu.content.Paste.xml
+  ${CMAKE_CURRENT_SOURCE_DIR}/detail/com.ubuntu.content.Service.xml
+  ${CMAKE_CURRENT_SOURCE_DIR}/detail/com.ubuntu.content.Transfer.xml
+)
+
+set(
+  DBUS_ANNOTATIONS
+  --annotate com.ubuntu.content.dbus.Paste.Charge\(\)[mimeData] org.gtk.GDBus.C.ForceGVariant true
+  --annotate com.ubuntu.content.dbus.Paste.MimeData\(\)[mimeData] org.gtk.GDBus.C.ForceGVariant true
+  --annotate com.ubuntu.content.dbus.Service.CreatePaste\(\)[mimeData] org.gtk.GDBus.C.ForceGVariant true
+  --annotate com.ubuntu.content.dbus.Service.GetLatestPasteData\(\)[mimeData] org.gtk.GDBus.C.ForceGVariant true
+  --annotate com.ubuntu.content.dbus.Service.GetPasteData\(\)[mimeData] org.gtk.GDBus.C.ForceGVariant true
+)
+
+add_custom_command(
+  OUTPUT glib/content-hub-glib.h glib/content-hub-glib.c
+  COMMAND ${CMAKE_COMMAND} -E make_directory glib
+  COMMAND ${GDBUS_CODEGEN}
+          --interface-prefix com.ubuntu.content.dbus
+          --generate-c-code glib/content-hub-glib
+          --c-namespace ContentHub
+          ${DBUS_ANNOTATIONS}
+          ${DBUS_XML}
+  DEPENDS ${DBUS_XML}
+  VERBATIM
+)
+
+add_library(
+  content-hub-glib SHARED
+  glib/content-hub-glib.h
+  glib/content-hub-glib.c
+)
+
+target_link_libraries(
+  content-hub-glib
+  ${GIO_LIBRARIES}
+)
+
+set_target_properties(
+  content-hub-glib
+  PROPERTIES
+  VERSION ${CONTENT_HUB_VERSION_MAJOR}.${CONTENT_HUB_VERSION_MINOR}.${CONTENT_HUB_VERSION_PATCH}
+  SOVERSION ${CONTENT_HUB_VERSION_MAJOR}
+)
+
+install(
+  FILES ${CMAKE_CURRENT_BINARY_DIR}/glib/content-hub-glib.h
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/com/ubuntu/content/glib
+)
+
+install(
+  TARGETS content-hub content-hub-glib
   LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
   ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
 )

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2016-11-28 17:34:27 +0000
+++ tests/CMakeLists.txt	2016-12-01 18:19:18 +0000
@@ -23,6 +23,7 @@
   ${LIBERTINE_INCLUDE_DIRS}
   ${UBUNTU_LAUNCH_INCLUDE_DIRS}
   ${CMAKE_BINARY_DIR}/src
+  ${CMAKE_BINARY_DIR}/src/com/ubuntu/content
   ${GMOCK_INCLUDE_DIR}
   ${GTEST_INCLUDE_DIR}
 )

=== modified file 'tests/acceptance-tests/CMakeLists.txt'
--- tests/acceptance-tests/CMakeLists.txt	2016-11-28 17:34:27 +0000
+++ tests/acceptance-tests/CMakeLists.txt	2016-12-01 18:19:18 +0000
@@ -27,6 +27,7 @@
   test_utils
   test_types
   mimedata_test
+  glib_test
 )
 
 set(TEST_LIBS
@@ -87,6 +88,8 @@
 
 file(COPY good.json bad.json source_all.json DESTINATION .)
 
+target_link_libraries(glib_test content-hub-glib)
+
 add_custom_command(
   OUTPUT transfer_files
   COMMAND cmake -E touch file1 file2 file3

=== added file 'tests/acceptance-tests/glib_test.cpp'
--- tests/acceptance-tests/glib_test.cpp	1970-01-01 00:00:00 +0000
+++ tests/acceptance-tests/glib_test.cpp	2016-12-01 18:19:18 +0000
@@ -0,0 +1,314 @@
+/*
+ * 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 warranty of
+ * MERCHANTABILITY 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/>.
+ *
+ * Authored by: William Hua <[e-mail]>
+ */
+
+/* modified from app_hub_communication_paste.cpp */
+
+#include "app_manager_mock.h"
+#include "test_harness.h"
+#include "../cross_process_sync.h"
+#include "../fork_and_run.h"
+
+#include <com/ubuntu/content/hub.h>
+#include <com/ubuntu/content/item.h>
+#include <com/ubuntu/content/paste.h>
+
+#include "com/ubuntu/content/detail/peer_registry.h"
+#include "com/ubuntu/content/detail/service.h"
+#include "com/ubuntu/content/serviceadaptor.h"
+
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include <QCoreApplication>
+#include <QtDBus/QDBusConnection>
+#include <QStandardPaths>
+#include <QTemporaryDir>
+#include <QtTest/QTest>
+
+#include <thread>
+
+#include <cstring>
+#include <gio/gio.h>
+
+#include "glib/content-hub-glib.h"
+
+namespace cua = com::ubuntu::ApplicationManager;
+namespace cuc = com::ubuntu::content;
+namespace cucd = com::ubuntu::content::detail;
+
+QString service_name{"com.ubuntu.content.dbus.Service"};
+
+struct MockedPeerRegistry : public cucd::PeerRegistry
+{
+    MockedPeerRegistry() : cucd::PeerRegistry()
+    {
+        using namespace ::testing;
+
+        ON_CALL(*this, default_source_for_type(_)).WillByDefault(Return(cuc::Peer::unknown()));
+        ON_CALL(*this, install_default_source_for_type(_,_)).WillByDefault(Return(false));
+        ON_CALL(*this, install_source_for_type(_,_)).WillByDefault(Return(false));
+    }
+
+    MOCK_METHOD1(default_source_for_type, cuc::Peer(cuc::Type t));
+    MOCK_METHOD1(enumerate_known_peers, void(const std::function<void(const cuc::Peer&)>&));
+    MOCK_METHOD2(enumerate_known_sources_for_type, void(cuc::Type, const std::function<void(const cuc::Peer&)>&));
+    MOCK_METHOD2(enumerate_known_destinations_for_type, void(cuc::Type, const std::function<void(const cuc::Peer&)>&));
+    MOCK_METHOD2(enumerate_known_shares_for_type, void(cuc::Type, const std::function<void(const cuc::Peer&)>&));
+    MOCK_METHOD2(install_default_source_for_type, bool(cuc::Type, cuc::Peer));
+    MOCK_METHOD2(install_source_for_type, bool(cuc::Type, cuc::Peer));
+    MOCK_METHOD2(install_destination_for_type, bool(cuc::Type, cuc::Peer));
+    MOCK_METHOD2(install_share_for_type, bool(cuc::Type, cuc::Peer));
+    MOCK_METHOD1(remove_peer, bool(cuc::Peer));
+    MOCK_METHOD1(peer_is_legacy, bool(QString));
+};
+
+static const gchar *SERVICE_NAME = "com.ubuntu.content.dbus.Service";
+static const gchar *SERVICE_PATH = "/";
+static const gchar *APPLICATION_ID = "com.ubuntu.content.glib_test";
+static const gchar *HANDLER_PATH = "/com/ubuntu/content/handler";
+static const gchar *SURFACE_ID = "01234567-0123-0123-0123-0123456789ab";
+
+static const gchar * const PASTE_FORMATS[] =
+{
+  "text/plain",
+  "text/html",
+  NULL
+};
+
+static const gint N_PASTE_FORMATS = sizeof (PASTE_FORMATS) / sizeof (PASTE_FORMATS[0]) - 1;
+
+static const gchar PASTE_DATA[] =
+  "text/plain"
+  "plain text"
+  "text/html"
+  "<p>html text</p>";
+
+static const gint N_PASTE_DATA = sizeof (PASTE_DATA) / sizeof (PASTE_DATA[0]) - 1;
+
+static gboolean pasteboard_changed;
+
+static void
+pasteboard_changed_cb (ContentHubService *service,
+                       gpointer           user_data)
+{
+  GMainLoop *main_loop = (GMainLoop *) user_data;
+
+  pasteboard_changed = TRUE;
+
+  g_main_loop_quit (main_loop);
+}
+
+static gboolean
+timed_out_cb (gpointer user_data)
+{
+  GMainLoop *main_loop = (GMainLoop *) user_data;
+
+  g_main_loop_quit (main_loop);
+
+  return G_SOURCE_CONTINUE;
+}
+
+static void
+set_paste (ContentHubService *service)
+{
+  GMainLoop *main_loop;
+  guint timeout_id;
+
+  g_assert_false (pasteboard_changed);
+
+  main_loop = g_main_loop_new (NULL, FALSE);
+  timeout_id = g_timeout_add (1000, timed_out_cb, main_loop);
+
+  g_signal_connect (
+    service,
+    "pasteboard-changed",
+    G_CALLBACK (pasteboard_changed_cb),
+    main_loop);
+
+  g_assert_true (
+    content_hub_service_call_create_paste_sync (
+      service,
+      APPLICATION_ID,
+      SURFACE_ID,
+      g_variant_new_fixed_array (G_VARIANT_TYPE_BYTE, PASTE_DATA, sizeof (PASTE_DATA) - 1, sizeof (guchar)),
+      PASTE_FORMATS,
+      NULL,
+      NULL,
+      NULL));
+
+  g_main_loop_run (main_loop);
+  g_source_remove (timeout_id);
+  g_clear_pointer (&main_loop, g_main_loop_unref);
+
+  g_assert_true (pasteboard_changed);
+
+  pasteboard_changed = FALSE;
+}
+
+static void
+get_paste (ContentHubService *service)
+{
+  gchar **formats;
+  GVariant *variant;
+  gconstpointer data;
+  gsize size;
+  gint i;
+
+  g_assert_true (
+    content_hub_service_call_paste_formats_sync (
+      service,
+      &formats,
+      NULL,
+      NULL));
+
+  g_assert_cmpint (g_strv_length (formats), ==, N_PASTE_FORMATS);
+
+  for (i = 0; i < N_PASTE_FORMATS; i++)
+    g_assert_cmpstr (formats[i], ==, PASTE_FORMATS[i]);
+
+  g_strfreev (formats);
+
+  g_assert_true (
+    content_hub_service_call_get_latest_paste_data_sync (
+      service,
+      SURFACE_ID,
+      &variant,
+      NULL,
+      NULL));
+
+  data = g_variant_get_fixed_array (variant, &size, sizeof (guchar));
+
+  g_assert_cmpint (size, ==, N_PASTE_DATA);
+  g_assert_cmpint (memcmp (data, PASTE_DATA, N_PASTE_DATA), ==, 0);
+}
+
+int
+glib_test (int   argc,
+           char *argv[])
+{
+  GDBusConnection *session;
+  ContentHubService *service;
+  ContentHubHandler *handler;
+
+  session = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, NULL);
+
+  service = content_hub_service_proxy_new_sync (
+    session,
+    G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES,
+    SERVICE_NAME,
+    SERVICE_PATH,
+    NULL,
+    NULL);
+
+  g_assert_nonnull (service);
+
+  handler = content_hub_handler_skeleton_new ();
+
+  g_assert_true (
+    g_dbus_interface_skeleton_export (
+      G_DBUS_INTERFACE_SKELETON (handler),
+      session,
+      HANDLER_PATH,
+      NULL));
+
+  g_object_unref (session);
+
+  g_assert_true (
+    content_hub_service_call_register_import_export_handler_sync (
+      service,
+      APPLICATION_ID,
+      HANDLER_PATH,
+      NULL,
+      NULL));
+
+  g_assert_true (
+    content_hub_service_call_handler_active_sync (
+      service,
+      APPLICATION_ID,
+      NULL,
+      NULL));
+
+  set_paste (service);
+  get_paste (service);
+
+  g_assert_true (
+    content_hub_service_call_quit_sync (
+      service,
+      NULL,
+      NULL));
+
+  g_dbus_interface_skeleton_unexport (G_DBUS_INTERFACE_SKELETON (handler));
+  g_object_unref (handler);
+  g_object_unref (service);
+
+  return 0;
+}
+
+/* modified from app_hub_communication_paste.cpp */
+
+TEST(GLib, glib_test)
+{
+    using namespace ::testing;
+
+    test::CrossProcessSync sync;
+
+    auto parent = [&sync]()
+    {
+        int argc = 0;
+        QCoreApplication app{argc, nullptr};
+
+        QDBusConnection connection = QDBusConnection::sessionBus();
+
+        auto mock = new ::testing::NiceMock<MockedPeerRegistry>{};
+
+        QSharedPointer<cucd::PeerRegistry> registry{mock};
+        auto app_manager = QSharedPointer<cua::ApplicationManager>(new MockedAppManager());
+        cucd::Service implementation(connection, registry, app_manager, &app);
+        new ServiceAdaptor(std::addressof(implementation));
+
+        ASSERT_TRUE(connection.registerService(service_name));
+        ASSERT_TRUE(connection.registerObject("/", std::addressof(implementation)));
+
+        sync.signal_ready();
+
+        app.exec();
+
+        connection.unregisterObject("/");
+        connection.unregisterService(service_name);
+    };
+
+    auto child = [&sync]()
+    {
+        int argc = 0;
+        QCoreApplication app(argc, nullptr);
+
+        sync.wait_for_signal_ready();
+
+        test::TestHarness harness;
+        harness.add_test_case([]()
+        {
+            char arg0[] = "glib_test";
+            char *argv[] = { arg0 };
+
+            EXPECT_EQ(0, glib_test(1, argv));
+        });
+        EXPECT_EQ(0, QTest::qExec(std::addressof(harness)));
+    };
+
+    EXPECT_EQ(EXIT_SUCCESS, test::fork_and_run(child, parent));
+}