Merge lp:~mardy/click-reviewers-tools/oa-plugin-1520605 into lp:click-reviewers-tools

[Alberto Mardegan]

Online Accounts: update to latest plugin hook format

The OA manifest file for account plugins has changed a bit: now only a single plugin is allowed (instead of a list of plugins), since anyway every account plugin in the click package will have its OA manifest.

Online Accounts: update to latest plugin hook format

The OA manifest file for account plugins has changed a bit: now only a single plugin is allowed (instead of a list of plugins), since anyway every account plugin in the click package will have its OA manifest.

[Jamie Strandboge (jdstrand)]

Is this change compatible with older apps? Eg, are there apps that use the old methodology that need to migrate to the new? Is the new methodology on the images now?

review: Needs Information

[Alberto Mardegan (mardy)]

> Is this change compatible with older apps? Eg, are there apps that use the old
> methodology that need to migrate to the new? Is the new methodology on the
> images now?

There aren't currently any click packages using the account plugin hooks which is being changed with this MP, so it's safe to land.
The new methodology (as mandated by this MP) for account plugin hooks is not yet on the images, but I have a MP on ubuntu-system-settings-online-accounts ready. However, there is no need for these changes to land in a coordinated way: we will simply advise app developers to start migrating to this new hook format once both changes have landed. For the time being, the old "account-plugin" hook continues to work.

[Jamie Strandboge (jdstrand)]

Right. My question was more that since this isn't landed and nothing is using it, will an app that is uploaded today using the older format continue to pass automated reviews.

review: Needs Information

[Alberto Mardegan (mardy)]

Yes it will: nothing changes for apps using the older format, that continues to work.

=== modified file 'clickreviews/cr_online_accounts.py'
--- clickreviews/cr_online_accounts.py	2015-11-24 12:13:36 +0000
+++ clickreviews/cr_online_accounts.py	2015-11-30 11:48:21 +0000
@@ -108,7 +108,6 @@
             ('description', str),
         ]
         self.required_keys["plugin"] = [
-            ('provider', str),
             ('name', str),
             ('icon', str),
             ('qml', str),
@@ -249,19 +248,23 @@
                 self._add_result(t, n, s)
                 continue
 
+            has_services_or_plugin = False
             n = self._get_check_name('%s_services' % account_type, app=app)
-            if 'services' not in self.accounts[app][account_type]:
+            if 'services' in self.accounts[app][account_type]:
+                has_services_or_plugin = True
+                services = self.accounts[app][account_type]['services']
+                self._check_object_list(app, "services", "service", services)
+
+            n = self._get_check_name('%s_plugin' % account_type, app=app)
+            if 'plugin' in self.accounts[app][account_type]:
+                has_services_or_plugin = True
+                plugin = self.accounts[app][account_type]['plugin']
+                self._check_object("plugin", plugin, n)
+
+            if not has_services_or_plugin:
                 t = "error"
-                s = "'services' key is missing"
+                s = "either 'services' or 'plugin' key must be present"
                 self._add_result(t, n, s)
-                continue
-            services = self.accounts[app][account_type]['services']
-            self._check_object_list(app, "services", "service", services)
-
-            n = self._get_check_name('%s_plugins' % account_type, app=app)
-            if 'plugins' in self.accounts[app][account_type]:
-                plugins = self.accounts[app][account_type]['plugins']
-                self._check_object_list(app, "plugins", "plugin", plugins)
 
     def check_application(self):
         '''Check application'''

=== modified file 'clickreviews/tests/test_cr_online_accounts.py'
--- clickreviews/tests/test_cr_online_accounts.py	2015-10-16 02:54:07 +0000
+++ clickreviews/tests/test_cr_online_accounts.py	2015-11-30 11:48:21 +0000
@@ -153,14 +153,11 @@
               "provider": "becool"
             }
           ],
-          "plugins": [
-            {
-              "provider": "example",
+          "plugin": {
               "name": "Example site",
               "icon": "example.png",
               "qml": "qml_files"
-            }
-          ]
+          }
         }''')
         self.set_test_account(self.default_appname, "accounts", data)
         c = ClickReviewAccounts(self.test_name)