Merge lp:~larryprice/libertine/confinement-fixups into lp:libertine

[Larry Price]

Various fixes for getting the confined snap working with libertined.

Various fixes for getting the confined snap working with libertined. Will require manually starting d-bus service and manually connecting the interfaces. If the interface is unavailable, this should fall back to not using libertined.

[lp:~larryprice/libertine/confinement-fixups]

396. By Larry Price on 2017-02-15

Client, not LibertineClient

[Libertine CI Bot (libertine-ci-bot)]

PASSED: Continuous integration, rev:396
https://jenkins.canonical.com/libertine/job/lp-libertine-ci/384/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/libertine/job/build/735
    SUCCESS: https://jenkins.canonical.com/libertine/job/test-0-autopkgtest/label=amd64,release=xenial+overlay,testname=default/605
    SUCCESS: https://jenkins.canonical.com/libertine/job/test-0-autopkgtest/label=amd64,release=zesty,testname=default/605
    SUCCESS: https://jenkins.canonical.com/libertine/job/test-0-autopkgtest/label=i386,release=xenial+overlay,testname=default/605
    SUCCESS: https://jenkins.canonical.com/libertine/job/test-0-autopkgtest/label=i386,release=zesty,testname=default/605
    SUCCESS: https://jenkins.canonical.com/libertine/job/build-0-fetch/745
    SUCCESS: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=amd64,release=xenial+overlay/726
        deb: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=amd64,release=xenial+overlay/726/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=amd64,release=zesty/726
        deb: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=amd64,release=zesty/726/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=i386,release=xenial+overlay/726
        deb: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=i386,release=xenial+overlay/726/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=i386,release=zesty/726
        deb: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=i386,release=zesty/726/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://jenkins.canonical.com/libertine/job/lp-libertine-ci/384/rebuild

review: Approve (continuous-integration)

[Christopher Townsend (townsend)]

LGTM, +1 and thanks!

review: Approve

=== modified file 'debian/python3-libertine.install'
--- debian/python3-libertine.install	2017-02-07 12:35:48 +0000
+++ debian/python3-libertine.install	2017-02-15 21:25:37 +0000
@@ -1,3 +1,4 @@
+usr/lib/python*/*/libertine/Client.py
 usr/lib/python*/*/libertine/ContainersConfig.py
 usr/lib/python*/*/libertine/HostInfo.py
 usr/lib/python*/*/libertine/Libertine.py

=== added file 'python/libertine/Client.py'
--- python/libertine/Client.py	1970-01-01 00:00:00 +0000
+++ python/libertine/Client.py	2017-02-15 21:25:37 +0000
@@ -0,0 +1,61 @@
+# Copyright 2017 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 3 of the License.
+#
+# 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 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/>.
+
+
+import dbus
+
+from . import utils
+
+
+class Client(object):
+    def __init__(self):
+        self._manager = None
+
+        try:
+            from .service.manager import LIBERTINE_MANAGER_NAME, LIBERTINE_MANAGER_OBJECT
+            if utils.set_session_dbus_env_var():
+                bus = dbus.SessionBus()
+                self._manager = bus.get_object(LIBERTINE_MANAGER_NAME, LIBERTINE_MANAGER_OBJECT)
+                self._interface = LIBERTINE_MANAGER_NAME
+        except ImportError as e:
+            utils.get_logger().warning("Libertine service libraries not installed.")
+        except dbus.exceptions.DBusException as e:
+            utils.get_logger().warning("Exception raised while discovering d-bus service: {}".format(str(e)))
+
+    @property
+    def valid(self):
+        return self._manager is not None
+
+    def container_operation_start(self, id):
+        if not self.valid:
+            return False
+
+        retries = 0
+        while not self._manager.get_dbus_method('container_operation_start', self._interface)(id):
+            retries += 1
+            if retries > 5:
+                return False
+            time.sleep(.5)
+
+        return True
+
+    def container_operation_finished(self, id):
+        return self.valid and self._manager.get_dbus_method("container_operation_finished", self._interface)(id)
+
+    def container_stopped(self, id):
+        if not self.valid:
+            return False
+
+        self._manager.get_dbus_method('container_stopped', self._interface)(id)
+        return True

=== modified file 'python/libertine/LxcContainer.py'
--- python/libertine/LxcContainer.py	2017-02-08 16:44:02 +0000
+++ python/libertine/LxcContainer.py	2017-02-15 21:25:37 +0000
@@ -25,8 +25,7 @@
 import time
 
 from .Libertine import BaseContainer
-from .service.manager import LIBERTINE_MANAGER_NAME, LIBERTINE_STORE_PATH
-from . import utils, HostInfo
+from . import utils, HostInfo, Client
 
 
 home_path = os.environ['HOME']
@@ -163,16 +162,10 @@
     def __init__(self, container_id, config):
         super().__init__(container_id, 'lxc', config)
         self.container = lxc_container(container_id)
-        self.lxc_manager_interface = None
         self.host_info = HostInfo.HostInfo()
         self._freeze_on_stop = config.get_freeze_on_stop(self.container_id)
 
-        if utils.set_session_dbus_env_var():
-            try:
-                bus = dbus.SessionBus()
-                self.lxc_manager_interface = bus.get_object(LIBERTINE_MANAGER_NAME, LIBERTINE_STORE_PATH)
-            except dbus.exceptions.DBusException:
-                pass
+        self._manager = Client.Client()
 
     def _setup_pulse(self):
         pulse_socket_path = os.path.join(utils.get_libertine_runtime_dir(), 'pulse_socket')
@@ -222,14 +215,8 @@
             return fd.read().strip('\n') != self.host_info.get_host_timezone()
 
     def start_container(self):
-        if self.lxc_manager_interface:
-            retries = 0
-            while not self.lxc_manager_interface.container_operation_start(self.container_id):
-                retries += 1
-                if retries > 5:
-                    return False
-                time.sleep(.5)
-             
+        self._manager.container_operation_start(self.container_id)
+
         if self.container.state == 'RUNNING':
             return True
 
@@ -244,14 +231,14 @@
         return True
 
     def stop_container(self):
-        if self.lxc_manager_interface:
-            if self.lxc_manager_interface.container_operation_finished(self.container_id):
-                if not lxc_stop(self.container, self._freeze_on_stop):
-                   return False
-                self.lxc_manager_interface.container_stopped(self.container_id)
-                return True
-            else:
+        if self._manager.valid:
+            if not self._manager.container_operation_finished(self.container_id):
                 return False
+
+            if not lxc_stop(self.container, self._freeze_on_stop):
+               return False
+
+            return self._manager.container_stopped(self.container_id)
         else:
             return lxc_stop(self.container, self._freeze_on_stop)
 
@@ -264,7 +251,7 @@
         self._freeze_on_stop = False
 
         # We never want to use the manager when restarting.
-        self.lxc_manager_interface = None
+        self._manager = None
 
         if not (self.stop_container() and self.start_container()):
             return False
@@ -402,7 +389,7 @@
         self.container.save_config()
 
     def start_application(self, app_exec_line, environ):
-        if self.lxc_manager_interface == None:
+        if not self._manager.valid:
             utils.get_logger().error("No interface to libertine-lxc-manager.  Failing application launch.")
             return
 
@@ -410,7 +397,7 @@
         os.environ.update(environ)
 
         if not self.start_container():
-            self.lxc_manager_interface.container_stopped(self.container_id)
+            self._manager.container_stopped(self.container_id)
             return
 
         app_launch_cmd = "sudo -E -u " + os.environ['USER'] + " env PATH=" + os.environ['PATH']

=== modified file 'python/libertine/LxdContainer.py'
--- python/libertine/LxdContainer.py	2017-02-07 16:32:02 +0000
+++ python/libertine/LxdContainer.py	2017-02-15 21:25:37 +0000
@@ -22,8 +22,7 @@
 import subprocess
 import time
 
-from libertine import Libertine, utils, HostInfo
-from .service.manager import LIBERTINE_MANAGER_NAME, LIBERTINE_STORE_PATH
+from . import Libertine, utils, HostInfo, Client
 
 
 def _get_devices_map():
@@ -295,22 +294,13 @@
         super().__init__(name, 'lxd', config)
         self._host_info = HostInfo.HostInfo()
         self._container = None
-        self._manager = None
         self._freeze_on_stop = config.get_freeze_on_stop(self.container_id)
 
         if not _setup_lxd():
             raise Exception("Failed to setup lxd.")
 
         self._client = pylxd.Client()
-
-        try:
-            if utils.set_session_dbus_env_var():
-                bus = dbus.SessionBus()
-                self._manager = bus.get_object(LIBERTINE_MANAGER_NAME, LIBERTINE_STORE_PATH)
-        except PermissionError as e:
-            utils.get_logger().warning("Failed to set dbus session env var")
-        except dbus.exceptions.DBusException:
-            utils.get_logger().warning("D-Bus Service not found.")
+        self._manager = Client.Client()
 
     def create_libertine_container(self, password=None, multiarch=False):
         if self._try_get_container():
@@ -409,13 +399,7 @@
         if not self._try_get_container():
             return False
 
-        if self._manager:
-            retries = 0
-            while not self._manager.container_operation_start(self.container_id):
-                retries += 1
-                if retries > 5:
-                    return False
-                time.sleep(.5)
+        self._manager.container_operation_start(self.container_id)
 
         if self._container.status == 'Running':
             return True
@@ -427,8 +411,7 @@
             update_bind_mounts(self._container, self._config, home)
 
         if not lxd_start(self._container):
-            if self._manager:
-                self._manager.container_stopped(self.container_id)
+            self._manager.container_stopped()
             return False
 
         if not _wait_for_network(self._container):
@@ -443,14 +426,14 @@
         if not self._try_get_container():
             return False
 
-        if self._manager:
-            if self._manager.container_operation_finished(self.container_id):
-                if not lxd_stop(self._container, freeze_on_stop=self._freeze_on_stop):
-                    return False
-                self._manager.container_stopped(self.container_id)
-                return True
-            else:
-                return False
+        if self._manager.valid:
+            if not self._manager.container_operation_finished(self.container_id):
+                return False
+
+            if not lxd_stop(self._container, freeze_on_stop=self._freeze_on_stop):
+                return False
+
+            return self._manager.container_stopped(self.container_id)
         else:
             return lxd_stop(self._container, freeze_on_stop=self._freeze_on_stop)
 
@@ -473,7 +456,7 @@
 
         self._freeze_on_stop = orig_freeze
         return self.stop_container(wait=True)
- 
+
     def start_application(self, app_exec_line, environ):
         if not self._try_get_container():
             utils.get_logger().error("Could not get container '{}'".format(self.container_id))

=== modified file 'python/libertine/service/manager.py'
--- python/libertine/service/manager.py	2017-02-07 12:35:48 +0000
+++ python/libertine/service/manager.py	2017-02-15 21:25:37 +0000
@@ -21,9 +21,9 @@
 from libertine import utils
 
 
-LIBERTINE_MANAGER_NAME = "com.canonical.libertine.Service"
+LIBERTINE_MANAGER_NAME      = "com.canonical.libertine.Service"
 LIBERTINE_MANAGER_INTERFACE = LIBERTINE_MANAGER_NAME
-LIBERTINE_STORE_PATH = "/Manager"
+LIBERTINE_MANAGER_OBJECT    = "/Manager"
 
 
 class Manager(dbus.service.Object):
@@ -39,7 +39,7 @@
             utils.get_logger().warning("service is already running")
             raise
 
-        super().__init__(bus_name, LIBERTINE_STORE_PATH)
+        super().__init__(bus_name, LIBERTINE_MANAGER_OBJECT)
 
         self._dispatcher = libertine.service.task_dispatcher.TaskDispatcher(self.connection)
 

=== modified file 'python/libertine/utils.py'
--- python/libertine/utils.py	2017-02-07 16:32:02 +0000
+++ python/libertine/utils.py	2017-02-15 21:25:37 +0000
@@ -159,19 +159,23 @@
 def set_session_dbus_env_var():
     dbus_session_set = 'SESSION' in os.environ
 
-    if not dbus_session_set:
-        for p in psutil.process_iter():
-            try:
-                if p.name() == 'unity8' or p.name() == 'compiz':
-                    p_environ = subprocess.check_output(["cat", "/proc/{}/environ".format(p.pid)])
-                    for line in p_environ.decode().split('\0'):
-                        if line.startswith('DBUS_SESSION_BUS_ADDRESS'):
-                            os.environ['DBUS_SESSION_BUS_ADDRESS'] = line.partition('DBUS_SESSION_BUS_ADDRESS=')[2].rstrip('\n')
-                            dbus_session_set = True
-                            break
-                    break
-            except psutil.NoSuchProcess as e:
-                get_logger().warning(str(e))
+    try:
+        if not dbus_session_set:
+            for p in psutil.process_iter():
+                try:
+                    if p.name() == 'unity8' or p.name() == 'compiz':
+                        p_environ = subprocess.check_output(["cat", "/proc/{}/environ".format(p.pid)])
+                        for line in p_environ.decode().split('\0'):
+                            if line.startswith('DBUS_SESSION_BUS_ADDRESS'):
+                                os.environ['DBUS_SESSION_BUS_ADDRESS'] = line.partition('DBUS_SESSION_BUS_ADDRESS=')[2].rstrip('\n')
+                                dbus_session_set = True
+                                break
+                        break
+                except psutil.NoSuchProcess as e:
+                    get_logger().warning(str(e))
+    except subprocess.CalledProcessError as e:
+        get_logger().warning("Exception caught while setting session dbus address: {}".format(str(e)))
+        dbus_session_set = 'DBUS_SESSION_BUS_ADDRESS' in os.environ
 
     return dbus_session_set
 

=== removed directory 'setup'
=== removed directory 'setup/gui'
=== removed file 'setup/gui/libertine-manager-app.desktop'
--- setup/gui/libertine-manager-app.desktop	2017-01-23 15:21:46 +0000
+++ setup/gui/libertine-manager-app.desktop	1970-01-01 00:00:00 +0000
@@ -1,12 +0,0 @@
-[Desktop Entry]
-Version=1.0
-Name=Libertine Manager
-Comment=Legacy Application Sandbox
-Exec=libertine.manager-app %U
-Terminal=false
-Type=Application
-Icon=${SNAP}/usr/share/libertine/libertine_64.png
-Categories=
-GenericName=Application Sandbox
-X-Ubuntu-Touch=true
-

=== added directory 'snap/gui'
=== added file 'snap/gui/libertine-manager-app.desktop'
--- snap/gui/libertine-manager-app.desktop	1970-01-01 00:00:00 +0000
+++ snap/gui/libertine-manager-app.desktop	2017-02-15 21:25:37 +0000
@@ -0,0 +1,12 @@
+[Desktop Entry]
+Version=1.0
+Name=Libertine Manager
+Comment=Legacy Application Sandbox
+Exec=libertine.manager-app %U
+Terminal=false
+Type=Application
+Icon=${SNAP}/usr/share/libertine/libertine_64.png
+Categories=
+GenericName=Application Sandbox
+X-Ubuntu-Touch=true
+

=== modified file 'snap/snap-runner.wrapper'
--- snap/snap-runner.wrapper	2017-02-14 19:17:30 +0000
+++ snap/snap-runner.wrapper	2017-02-15 21:25:37 +0000
@@ -7,6 +7,6 @@
 
 # Useful debug variables
 # export FAKECHROOT_DEBUG=1
-# export LIBERTINE_DEBUG=1
+# export LIBERTINE_DEBUG=2
 
 exec $SNAP/bin/desktop-launch "$@"

=== modified file 'snapcraft.yaml'
--- snapcraft.yaml	2017-02-14 19:17:30 +0000
+++ snapcraft.yaml	2017-02-15 21:25:37 +0000
@@ -3,7 +3,7 @@
 summary: Libertine suite
 description: |
     Suite for maintaining deb-based applications in a non-deb environment
-confinement: devmode # TODO: update to 'strict'
+confinement: strict
 grade: devel
 
 slots:
@@ -12,7 +12,22 @@
     name: com.canonical.libertine.Service
     bus: session
 
+plugs:
+  libertined-client:
+    interface: dbus
+    name: com.canonical.libertine.Service
+    bus: session
+
 apps:
+  libertined:
+    command: usr/bin/snap-runner.wrapper libertined
+    plugs:
+      - lxd
+      - network
+      - network-bind
+    slots:
+      - libertined
+    # daemon: simple # Waiting on LP:1613420
   launch:
     command: usr/bin/snap-runner.wrapper libertine-launch
     aliases:
@@ -22,18 +37,12 @@
       - network
       - network-bind
       - home
-      - mir
       - x11
       - unity7
       - opengl
       - pulseaudio
       - alsa
-  libertined:
-    command: usr/bin/snap-runner.wrapper libertined
-    plugs:
-      - lxd
-      - network-bind
-    # daemon: simple # Waiting on LP:1613420
+      - libertined-client
   container-manager:
     command: usr/bin/snap-runner.wrapper libertine-container-manager
     aliases:
@@ -41,6 +50,7 @@
     plugs:
       - lxd
       - network
+      - libertined-client
   manager-app:
     command: usr/bin/snap-runner.wrapper libertine-manager-app
     # desktop command currently being labeled unknown by app store, restore with snapcraft 2.26 release
@@ -51,6 +61,8 @@
   # For debugging purposes
   bash:
     command: usr/bin/snap-runner.wrapper bash
+    plugs:
+      - libertined-client
 
 parts:
   libertine-source:

=== modified file 'tools/libertined'
--- tools/libertined	2016-12-07 21:24:16 +0000
+++ tools/libertined	2017-02-15 21:25:37 +0000
@@ -27,7 +27,10 @@
 class OutputRedirector(object):
     def __init__(self, config):
         self.config = config
-        self.cache_path = '%s/.cache/libertined' % os.environ['HOME']
+        if utils.is_snap_environment():
+            self.cache_path = '%s/.cache/libertined' % os.environ['SNAP_USER_COMMON']
+        else:
+            self.cache_path = '%s/.cache/libertined' % os.environ['HOME']
         self.cache_file = '%s/libertined.log' % self.cache_path
         self.output_file = None
         self.copied_stdout = None