Merge lp:~cprov/click-reviewers-tools/interface-abbreviated-syntax into lp:click-reviewers-tools

[Celso Providelo]

Support for interface abbreviated syntax, e.g.:

{{{
name: 'network-manager',
...
apps:
    networkmanager:
        slots:
            - service
    nmcli:
        plugs:
            - nmcli'

plugs
    nmcli: network-manager

slots:
    service: network-manager
}}}

[Jamie Strandboge (jdstrand)]

This looks great. Thanks!

review: Approve

[Jamie Strandboge (jdstrand)]

Actually, one small pep8 whitespace issue. I'll fix and commit.

=== modified file 'clickreviews/sr_lint.py'
--- clickreviews/sr_lint.py	2016-06-14 06:54:07 +0000
+++ clickreviews/sr_lint.py	2016-06-22 23:47:51 +0000
@@ -893,24 +893,37 @@
             # 'interface' is optional since the interface name and the iface
             # name are the same
             interface = iface
-            if 'interface' in self.snap_yaml[iface_type][iface]:
-                interface = self.snap_yaml[iface_type][iface]['interface']
-
+
+            spec = self.snap_yaml[iface_type][iface]
+            if isinstance(spec, str):
+                # Abbreviated syntax (no attributes)
+                # <plugs|slots>:
+                #   <alias>: <interface>
+                interface = spec
+            elif 'interface' in spec:
+                # Full specification.
+                # <plugs|slots>:
+                #   <alias>:
+                #     interface: <interface>
+                interface = spec['interface']
+
+            # Validate indirect (specified via alias) interfaces:
+            if interface != iface:
                 key = 'interface'
                 t = 'info'
-                n = self._get_check_name(iface_type, app=key, extra=iface)
+                n = self._get_check_name(iface_type, app=key, extra=interface)
                 s = 'OK'
-                if not isinstance(self.snap_yaml[iface_type][iface][key], str):
+                if not isinstance(interface, str):
                     t = 'error'
-                    s = "invalid %s: %s (not a str)" % \
-                        (key, self.snap_yaml[iface_type][iface][key])
-                elif len(self.snap_yaml[iface_type][iface][key]) == 0:
+                    s = "invalid %s: %s (not a str)" % (key, interface)
+                elif len(interface) == 0:
                     t = 'error'
                     s = "'%s' is empty" % key
                 self._add_result(t, n, s)
                 if t == 'error':
                     continue
 
+            # Check interfaces whitelist.
             t = 'info'
             n = self._get_check_name(iface_type, app=interface, extra=iface)
             s = 'OK'
@@ -921,7 +934,12 @@
             if t == 'error':
                 continue
 
-            for attrib in self.snap_yaml[iface_type][iface]:
+            # Abbreviated interfaces don't have attributes, done checking.
+            if isinstance(spec, str):
+                continue
+
+            # Check interface attributes.
+            for attrib in spec:
                 if attrib == 'interface':
                     continue
                 t = 'info'
@@ -932,8 +950,8 @@
                     t = 'error'
                     s = "unknown attribute '%s' for interface '%s'" % (
                         attrib, interface)
-                elif not isinstance(self.snap_yaml[iface_type][iface][attrib],
-                                    type(self.interfaces[interface][attrib])):
+                elif not isinstance(
+                    spec[attrib], type(self.interfaces[interface][attrib])):
                     t = 'error'
                     s = "'%s' is not '%s'" % \
                         (attrib,

=== modified file 'clickreviews/tests/test_sr_lint.py'
--- clickreviews/tests/test_sr_lint.py	2016-06-14 06:54:07 +0000
+++ clickreviews/tests/test_sr_lint.py	2016-06-22 23:47:51 +0000
@@ -2073,6 +2073,15 @@
         expected_counts = {'info': None, 'warn': 0, 'error': 1}
         self.check_results(r, expected_counts)
 
+    def test_check_plugs_abbreviated(self):
+        '''Test check_plugs() - abbreviated'''
+        self.set_test_snap_yaml("plugs", {'nm': 'network-manager'})
+        c = SnapReviewLint(self.test_name)
+        c.check_plugs()
+        r = c.click_report
+        expected_counts = {'info': 2, 'warn': 0, 'error': 0}
+        self.check_results(r, expected_counts)
+
     def test_check_apps_plugs(self):
         '''Test check_apps_plugs()'''
         plugs = self._create_top_plugs()
@@ -2238,6 +2247,15 @@
         expected_counts = {'info': None, 'warn': 0, 'error': 1}
         self.check_results(r, expected_counts)
 
+    def test_check_slots_abbreviated(self):
+        '''Test check_slots() - abbreviated'''
+        self.set_test_snap_yaml("slots", {'nm': 'network-manager'})
+        c = SnapReviewLint(self.test_name)
+        c.check_slots()
+        r = c.click_report
+        expected_counts = {'info': 2, 'warn': 0, 'error': 0}
+        self.check_results(r, expected_counts)
+
     def test_check_apps_slots(self):
         '''Test check_apps_slots()'''
         slots = self._create_top_slots()

=== modified file 'debian/changelog'
--- debian/changelog	2016-06-22 20:41:28 +0000
+++ debian/changelog	2016-06-22 23:47:51 +0000
@@ -19,6 +19,7 @@
   * sr_lint.py:
     - support 'environment' key in yaml (LP: #1583259)
     - support 'confinement' key in yaml
+    - support for interface abbreviated syntax (LP: #1595184)
   * sr_security.py: specifying mpris slot should not warn
 
  -- Jamie Strandboge <[e-mail]>  Tue, 14 Jun 2016 09:48:15 +0300