Merge lp:~mvo/software-center/webapps-activation into lp:software-center

[Michael Vogt]

This add support to activate webapps automatically on install.

[dobey (dobey)]

134 + def activate_unity_webapp_for_domain(self, domain):
135 + try:
136 + from gi.repository import UnityWebapps
137 + except ImportError:
138 + LOG.warn("failed to import UnityWebapps GIR")
139 + LOG.debug("activating webapp for domain '%s'", domain)
140 + UnityWebapps.permissions_allow_domain(domain)

The last two lines in this function need to be inside an else: I think. Otherwise an exception will be raised when permissions_allow_domain() is called, if the import failed, since you're not returning in the except handler. I guess this wasn't caught in your tests, as you're mocking that function.

+ # instal backend

Typo.

review: Needs Fixing

[lp:~mvo/software-center/webapps-activation]

3243. By Michael Vogt on 2012-12-17

softwarecenter/plugins/webapps_activation.py: if UnityWebapps GIR can not be imported, just return (thanks to Rodney Dawes!)

[Michael Vogt (mvo)]

Thanks a lot Rodney!

Indeed, the import failure was not tested and I overlooked it, fixed in r3243 now. I also fixed the typo now.

review: Needs Resubmitting

[dobey (dobey)]

There's a text conflict in softwarecenter/paths.py now.

[lp:~mvo/software-center/webapps-activation]

3244. By Michael Vogt on 2012-12-17

tests/test_webapps_activation_plugin.py: fix typo, thanks dobey

3245. By Michael Vogt on 2012-12-17

merged trunk and resolved conflicts

[Michael Vogt (mvo)]

Thanks again, I fixed the conflict and pushed the typo fix.

[dobey (dobey)]

review: Approve

=== modified file 'setup.py'
--- setup.py	2012-11-22 08:28:45 +0000
+++ setup.py	2012-12-17 17:32:21 +0000
@@ -125,6 +125,7 @@
         'softwarecenter.db.pkginfo_impl',
         'softwarecenter.db.history_impl',
         'softwarecenter.distro',
+        'softwarecenter.plugins',
         'softwarecenter.sso',
         'softwarecenter.ui',
         'softwarecenter.ui.gtk3',
@@ -150,9 +151,9 @@
         # sso
         ('share/software-center/ui/sso/', glob.glob("data/ui/sso/*.ui")),
         # dbus
-        ('../etc/dbus-1/system.d/', 
+        ('../etc/dbus-1/system.d/',
          ["data/dbus/com.ubuntu.SoftwareCenter.conf"]),
-        ('share/dbus-1/services', 
+        ('share/dbus-1/services',
          ["data/dbus/com.ubuntu.SoftwareCenterDataProvider.service"]),
         # images
         ('share/software-center/images/',

=== modified file 'softwarecenter/db/pkginfo.py'
--- softwarecenter/db/pkginfo.py	2012-11-28 17:23:44 +0000
+++ softwarecenter/db/pkginfo.py	2012-12-17 17:32:21 +0000
@@ -49,6 +49,10 @@
         return []
 
     @property
+    def record(self):
+        return {}
+
+    @property
     def not_automatic(self):
         """ should not be installed/upgraded automatically, the user needs
             to opt-in once (used for e.g. ubuntu-backports)

=== modified file 'softwarecenter/db/pkginfo_impl/aptcache.py'
--- softwarecenter/db/pkginfo_impl/aptcache.py	2012-12-14 16:44:25 +0000
+++ softwarecenter/db/pkginfo_impl/aptcache.py	2012-12-17 17:32:21 +0000
@@ -95,6 +95,10 @@
         return self.ver.origins
 
     @property
+    def record(self):
+        return self.ver.record
+    
+    @property
     def downloadable(self):
         return self.ver.downloadable
 

=== modified file 'softwarecenter/paths.py'
--- softwarecenter/paths.py	2012-11-28 16:58:59 +0000
+++ softwarecenter/paths.py	2012-12-17 17:32:21 +0000
@@ -47,6 +47,7 @@
     os.environ.get("SOFTWARE_CENTER_PLUGINS_DIR", ""),
     os.path.join(SOFTWARE_CENTER_BASE, "plugins"),
     os.path.join(xdg.xdg_data_home, "software-center", "plugins"),
+    os.path.join(os.path.dirname(__file__), "plugins"),
 ]
 
 # FIXME: use relative paths here

=== modified file 'softwarecenter/plugin.py'
--- softwarecenter/plugin.py	2012-11-28 16:58:59 +0000
+++ softwarecenter/plugin.py	2012-12-17 17:32:21 +0000
@@ -115,6 +115,7 @@
                     for plugin in self._find_plugins(module):
                         plugin.app = self._app
                         try:
+                            LOG.info("activating plugin '%s'" % module)
                             plugin.init_plugin()
                             self._plugins.append(plugin)
                         except:

=== added directory 'softwarecenter/plugins'
=== added file 'softwarecenter/plugins/__init__.py'
=== added file 'softwarecenter/plugins/webapps_activation.py'
--- softwarecenter/plugins/webapps_activation.py	1970-01-01 00:00:00 +0000
+++ softwarecenter/plugins/webapps_activation.py	2012-12-17 17:32:21 +0000
@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2012 Canonical
+#
+# Authors:
+#  Michael Vogt
+#
+# 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.
+#
+# 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+import logging
+
+import softwarecenter.plugin
+from softwarecenter.db.pkginfo import get_pkg_info
+from softwarecenter.backend.installbackend import get_install_backend
+
+LOG = logging.getLogger(__name__)
+
+
+class UnityWebappsActivationPlugin(softwarecenter.plugin.Plugin):
+    """Webapps activation plugin """
+
+    def init_plugin(self):
+        self.pkg_info = get_pkg_info()
+        self.install_backend = get_install_backend()
+        self.install_backend.connect(
+            "transaction-finished", self._on_transaction_finished)
+
+    def _on_transaction_finished(self, backend, result):
+        if not result.success or not result.pkgname:
+            return
+        if not result.pkgname in self.pkg_info:
+            return
+        pkg = self.pkg_info[result.pkgname]
+        if not pkg.candidate:
+            return
+        webdomain = pkg.candidate.record.get("Ubuntu-Webapps-Domain", None)
+        if webdomain:
+            self.activate_unity_webapp_for_domain(webdomain)
+
+    def activate_unity_webapp_for_domain(self, domain):
+        try:
+            from gi.repository import UnityWebapps
+        except ImportError:
+            LOG.warn("failed to import UnityWebapps GIR")
+            return
+        LOG.debug("activating webapp for domain '%s'", domain)
+        UnityWebapps.permissions_allow_domain(domain)

=== modified file 'tests/test_region.py'
--- tests/test_region.py	2012-07-19 09:29:16 +0000
+++ tests/test_region.py	2012-12-17 17:32:21 +0000
@@ -58,5 +58,6 @@
         self.assertTrue(self.region._get_region_dumb.called)
         self.assertTrue(self.region._get_region_geoclue.called)
 
+
 if __name__ == "__main__":
     unittest.main()

=== added file 'tests/test_webapps_activation_plugin.py'
--- tests/test_webapps_activation_plugin.py	1970-01-01 00:00:00 +0000
+++ tests/test_webapps_activation_plugin.py	2012-12-17 17:32:21 +0000
@@ -0,0 +1,90 @@
+import unittest
+
+from mock import (
+    Mock,
+    patch)
+
+from tests.utils import (
+    setup_test_env,
+    FakedCache,
+    ObjectWithSignals,
+)
+setup_test_env()
+
+from softwarecenter.plugins.webapps_activation import (
+    UnityWebappsActivationPlugin)
+
+
+def make_install_result_mock(pkgname, success):
+    mock_install_result = Mock()
+    mock_install_result.success = success
+    mock_install_result.pkgname = pkgname
+    return mock_install_result
+
+
+def make_mock_package_with_record(pkgname, record):
+    pkg = Mock()
+    pkg.candidate = Mock()
+    pkg.candidate.record = record
+    return pkg
+
+
+class FakedInstallBackend(ObjectWithSignals):
+    pass
+
+
+class WebappsActivationTestCase(unittest.TestCase):
+    """Tests the webapps activation plugin """
+
+    def setUp(self):
+        # create webapp
+        unity_webapp = make_mock_package_with_record(
+            "unity-webapp",  { 'Ubuntu-Webapps-Domain': 'mail.ubuntu.com' })
+        # create a non-webapp
+        non_unity_webapp = make_mock_package_with_record(
+            "unity-webapp",  {})
+        # pkginfo
+        self.mock_pkginfo = FakedCache()
+        self.mock_pkginfo["unity-webapp"] = unity_webapp
+        self.mock_pkginfo["non-unity-webapp"] = non_unity_webapp
+        # install backend
+        self.mock_installbackend = FakedInstallBackend()
+
+    @patch("softwarecenter.plugins.webapps_activation.get_install_backend")
+    @patch("softwarecenter.plugins.webapps_activation.get_pkg_info")
+    def _get_patched_unity_webapps_activation_plugin(self,
+                                                     mock_get_pkg_info,
+                                                     mock_install_backend):
+        mock_install_backend.return_value = self.mock_installbackend
+        mock_get_pkg_info.return_value = self.mock_pkginfo
+        w = UnityWebappsActivationPlugin()
+        w.init_plugin()
+        patcher = patch.object(w, "activate_unity_webapp_for_domain")
+        patcher.start()
+        self.addCleanup(patcher.stop)
+        return w
+
+    def test_activation(self):
+        w = self._get_patched_unity_webapps_activation_plugin()
+        self.mock_installbackend.emit(
+            "transaction-finished",
+            make_install_result_mock("unity-webapp", True))
+        self.assertTrue(w.activate_unity_webapp_for_domain.called)
+        w.activate_unity_webapp_for_domain.assert_called_with("mail.ubuntu.com")
+
+    def test_no_activation_on_fail(self):
+        w = self._get_patched_unity_webapps_activation_plugin()
+        self.mock_installbackend.emit(
+            "transaction-finished",
+            make_install_result_mock("unity-webapp", False))
+        self.assertFalse(w.activate_unity_webapp_for_domain.called)
+
+    def test_no_activation_on_non_webapp(self):
+        w = self._get_patched_unity_webapps_activation_plugin()
+        self.mock_installbackend.emit(
+            "transaction-finished",
+            make_install_result_mock("non-unity-webapp", True))
+        self.assertFalse(w.activate_unity_webapp_for_domain.called)
+
+if __name__ == "__main__":
+    unittest.main()

=== modified file 'tests/utils.py'
--- tests/utils.py	2012-12-17 09:43:31 +0000
+++ tests/utils.py	2012-12-17 17:32:21 +0000
@@ -58,7 +58,7 @@
 
 def url_accessable(url, needle):
     """Return true if needle is found in the url
-    
+
     This is useful as a unittest.skip decorator
     """
     f = urlopen(url)
@@ -235,7 +235,7 @@
     not even look at doc)
     """
     # provide some defaults
-    values = { 
+    values = {
         'appname': 'some Appname',
         'pkgname': 'apkg',
         'categories': 'cat1,cat2,lolcat',
@@ -253,7 +253,7 @@
     mock_property_helper.get_categories.return_value = values["categories"]
     mock_property_helper.get_display_price.return_value = values[
         "display_price"]
-    
+
     mock_property_helper.db = Mock()
     mock_property_helper.db._aptcache = FakedCache()
     mock_property_helper.db.get_pkgname.return_value = values["pkgname"]
@@ -267,7 +267,7 @@
     mock_property_helper.get_icon_at_size.return_value = values["icon"]
     mock_property_helper.icons = Mock()
     mock_property_helper.icons.load_icon.return_value = values["icon"]
-    return mock_property_helper    
+    return mock_property_helper
 
 
 def setup_test_env():
@@ -461,7 +461,7 @@
     def emit(self, signal, *args, **kwargs):
         """Emit 'signal' passing *args, **kwargs to every callback."""
         for callback in self._callbacks[signal]:
-            callback(*args, **kwargs)
+            callback(self, *args, **kwargs)
 
 
 class FakedCache(ObjectWithSignals, dict):