Merge ~jocave/plainbox-provider-resource:net-if-mgmt-master-mode into plainbox-provider-resource:master

[Jonathan Cave]

Extend the features of the net_if_management resource job to indicate what snap should be used to test the master mode function of wifi interfaces.

This will allow the NetworkManager master mode tests to be added to the existing master mode nested test plans.

[Kristin Chuang (kristinchuang)]

+1
Along with https://code.launchpad.net/~jocave/plainbox-provider-checkbox/+git/plainbox-provider-checkbox/+merge/400446, the current logic works in the following trial runs:

* UC16 enablement project, wifi-AP & network-manager pre-installed
[Expected] wifi-ap jobs run (its pass/fail status unrelated to this MR), nmcli jobs skipped
[Actual] OK, see https://pastebin.canonical.com/p/GHVhyYxQJC/

* rpi 2b, stock rpi armhf UC20, network-manager manually installed
[Expected] wifi-ap jobs skipped, nmcli jobs run (its pass/fail status unrelated to this MR)
[Actual] OK, see https://pastebin.canonical.com/p/jkTc6KQw8c/

review: Approve

diff --git a/bin/net_if_management.py b/bin/net_if_management.py
index b7daa9b..48fc453 100755
--- a/bin/net_if_management.py
+++ b/bin/net_if_management.py
@@ -59,6 +59,10 @@ def is_netplan_available():
     return which('netplan') is not None
 
 
+def is_wifiap_available():
+    return which('wifi-ap.config') is not None
+
+
 class NmInterfaceState():
 
     def __init__(self):
@@ -80,13 +84,40 @@ class States(Enum):
     nm = 'NetworkManager'
 
 
+class MasterMode(Enum):
+    na = 'not-applicable'
+    unspecified = 'unspecified'
+    error = 'error'
+    wifiap = 'wifi-ap'
+    nm = 'NetworkManager'
+
+
 def identify_managers(interfaces=None,
                       has_netplan=True, netplan_yaml=None,
-                      has_nm=True, nm_device_state=None):
+                      has_nm=True, nm_device_state=None,
+                      has_wifiap=False):
+    results = {}
     if interfaces is None:
-        interfaces = UdevInterfaceLister(['NETWORK', 'WIRELESS']).names
-
-    results = dict.fromkeys(interfaces, States.unspecified)
+        # normal operation
+        wired = UdevInterfaceLister(['NETWORK']).names
+        results.update(dict.fromkeys(wired, {
+            'manager': States.unspecified,
+            'mastermode': MasterMode.na
+        }))
+        wireless = UdevInterfaceLister(['WIRELESS']).names
+        results.update(dict.fromkeys(wireless, {
+            'manager': States.unspecified,
+            'mastermode': MasterMode.unspecified
+        }))
+    else:
+        # testing
+        for i in interfaces:
+            if i.startswith('e'):
+                results[i] = {'manager': States.unspecified,
+                              'mastermode': MasterMode.na}
+            elif i.startswith('w'):
+                results[i] = {'manager': States.unspecified,
+                              'mastermode': MasterMode.unspecified}
 
     if has_nm:
         nm_conf = NmInterfaceState()
@@ -113,6 +144,10 @@ def identify_managers(interfaces=None,
                 category_scope_manager = netplan_conf.ethernets.get(
                     'renderer', States.unspecified.value)
 
+        if results[n]['mastermode'] != MasterMode.na and has_wifiap:
+            log('has wifi-ap')
+            results[n]['mastermode'] = MasterMode.wifiap
+
         # Netplan config indcates NM
         if (global_scope_manager == States.nm.value or
                 category_scope_manager == States.nm.value or
@@ -122,35 +157,46 @@ def identify_managers(interfaces=None,
             if not has_nm:
                 log('error: netplan defines NM or there is no netplan, '
                     'but NM unavailable')
-                results[n] = States.error
+                results[n]['manager'] = States.error
                 continue
             # NM does not know the interface
             if nm_conf.devices.get(n) is None:
                 log('error: netplan defines NM or there is no netplan, '
                     'but interface unknown to NM')
-                results[n] = States.error
+                results[n]['manager'] = States.error
                 continue
             # NM thinks it doesnt manage the device despite netplan config
             if nm_conf.devices.get(n) == 'unmanaged':
                 log('error: netplan defines NM or there is no netplan, '
                     'but NM reports unmanaged')
-                results[n] = States.unspecified
+                results[n]['manager'] = States.unspecified
                 continue
-            results[n] = States.nm
+
+            results[n]['manager'] = States.nm
+
+            # if NM is managing the interface for wireless connections and
+            # wifi-ap is not installed, NM should be considered for managing
+            # master mode
+            if results[n]['mastermode'] != MasterMode.na and not has_wifiap:
+                # version check?
+                results[n]['mastermode'] = MasterMode.nm
+
             continue
 
         # has netplan but no renderer specified
         if has_netplan:
-            results[n] = States.networkd
+            results[n]['manager'] = States.networkd
     return results
 
 
 def main():
     results = identify_managers(has_netplan=is_netplan_available(),
-                                has_nm=is_nm_available())
-    for interface, state in results.items():
+                                has_nm=is_nm_available(),
+                                has_wifiap=is_wifiap_available())
+    for interface, data in results.items():
         print('device: {}'.format(interface))
-        print('managed_by: {}'.format(state.value))
+        print('managed_by: {}'.format(data['manager'].value))
+        print('master_mode_managed_by: {}'.format(data['mastermode'].value))
         print()
 
 
diff --git a/tests/test_net_if_management.py b/tests/test_net_if_management.py
index 6aa07f1..fb74e31 100644
--- a/tests/test_net_if_management.py
+++ b/tests/test_net_if_management.py
@@ -34,6 +34,7 @@ class NetIfMngrTest():
 
     has_netplan = True
     has_nm = True
+    has_wifiap = False
 
     @staticmethod
     def get_text(filename):
@@ -53,7 +54,8 @@ class NetIfMngrTest():
                                                    self.has_netplan,
                                                    self.netplan_yaml,
                                                    self.has_nm,
-                                                   self.nm_device_state)
+                                                   self.nm_device_state,
+                                                   self.has_wifiap)
 
 
 class Test_CARA_T(unittest.TestCase, NetIfMngrTest):
@@ -68,10 +70,14 @@ class Test_CARA_T(unittest.TestCase, NetIfMngrTest):
     nm_device_state = NetIfMngrTest.get_text('CARA_T_nmcli.txt')
 
     def test(self):
+        self.has_wifiap = True
         res = self.get_results()
-        self.assertEqual(res['eth0'].value, 'NetworkManager')
-        self.assertEqual(res['eth1'].value, 'NetworkManager')
-        self.assertEqual(res['wlan0'].value, 'NetworkManager')
+        self.assertEqual(res['eth0']['manager'].value, 'NetworkManager')
+        self.assertEqual(res['eth0']['mastermode'].value, 'not-applicable')
+        self.assertEqual(res['eth1']['manager'].value, 'NetworkManager')
+        self.assertEqual(res['eth1']['mastermode'].value, 'not-applicable')
+        self.assertEqual(res['wlan0']['manager'].value, 'NetworkManager')
+        self.assertEqual(res['wlan0']['mastermode'].value, 'wifi-ap')
 
 
 class Test_XENIAL_DESKTOP(unittest.TestCase, NetIfMngrTest):
@@ -87,8 +93,10 @@ class Test_XENIAL_DESKTOP(unittest.TestCase, NetIfMngrTest):
 
     def test(self):
         res = self.get_results()
-        self.assertEqual(res['eth0'].value, 'NetworkManager')
-        self.assertEqual(res['wlan0'].value, 'NetworkManager')
+        self.assertEqual(res['eth0']['manager'].value, 'NetworkManager')
+        self.assertEqual(res['eth0']['mastermode'].value, 'not-applicable')
+        self.assertEqual(res['wlan0']['manager'].value, 'NetworkManager')
+        self.assertEqual(res['wlan0']['mastermode'].value, 'NetworkManager')
 
 
 class Test_CASCADE_500(unittest.TestCase, NetIfMngrTest):
@@ -104,8 +112,8 @@ class Test_CASCADE_500(unittest.TestCase, NetIfMngrTest):
 
     def test(self):
         res = self.get_results()
-        self.assertEqual(res['eth0'].value, 'NetworkManager')
-        self.assertEqual(res['wlan0'].value, 'NetworkManager')
+        self.assertEqual(res['eth0']['manager'].value, 'NetworkManager')
+        self.assertEqual(res['wlan0']['manager'].value, 'NetworkManager')
 
 
 class Test_RPI2_UC16_CCONF(unittest.TestCase, NetIfMngrTest):
@@ -121,7 +129,8 @@ class Test_RPI2_UC16_CCONF(unittest.TestCase, NetIfMngrTest):
 
     def test(self):
         res = self.get_results()
-        self.assertEqual(res['eth0'].value, 'networkd')
+        self.assertEqual(res['eth0']['manager'].value, 'networkd')
+        self.assertEqual(res['eth0']['mastermode'].value, 'not-applicable')
 
 
 class Test_RPI3B_UC16_CLOUDINIT(unittest.TestCase, NetIfMngrTest):
@@ -137,5 +146,7 @@ class Test_RPI3B_UC16_CLOUDINIT(unittest.TestCase, NetIfMngrTest):
 
     def test(self):
         res = self.get_results()
-        self.assertEqual(res['eth0'].value, 'networkd')
-        self.assertEqual(res['wlan0'].value, 'networkd')
+        self.assertEqual(res['eth0']['manager'].value, 'networkd')
+        self.assertEqual(res['eth0']['mastermode'].value, 'not-applicable')
+        self.assertEqual(res['wlan0']['manager'].value, 'networkd')
+        self.assertEqual(res['wlan0']['mastermode'].value, 'unspecified')