Merge ~jocave/plainbox-provider-resource:net-if-mngr-testing into plainbox-provider-resource:master

[Jonathan Cave]

Culmination of the MRs to support provider testing.

In this case the aim was to make sure the net_if_management resource job works across the range of hardware and OS images we need to support.

Two commits included, first one is the changes to the existing script to make it testable and includes the changes that mean it should work on xenial desktop images (problems had been reported during SRU testing for this combination).

Second is the creation of the unit tests themselves. Includes an initial set of test scenarios chosen from reference devices and commonly problematic projects.

[Maciej Kisielewski (kissiel)]

I'd love to see textwrap's dedent used for those multiline strings in tests.

review: Needs Fixing

[Jonathan Cave (jocave)]

Rather than using dedent I thought it would be simpler for someone copying in configs to be able to just use text files.

review: Needs Resubmitting

[Maciej Kisielewski (kissiel)]

LGTM, +1

review: Approve

diff --git a/bin/net_if_management.py b/bin/net_if_management.py
index c4604c3..ef6fcde 100755
--- a/bin/net_if_management.py
+++ b/bin/net_if_management.py
@@ -18,6 +18,7 @@
 # along with Checkbox.  If not, see <http://www.gnu.org/licenses/>.
 
 from enum import Enum
+from shutil import which
 import subprocess as sp
 import sys
 
@@ -43,19 +44,24 @@ class UdevInterfaceLister(UdevResult):
                 self.names.append(p)
 
 
+def is_nm_available():
+    return which('nmcli') is not None
+
+
+def is_netplan_available():
+    return which('netplan') is not None
+
+
 class NmInterfaceState():
 
     def __init__(self):
         self.devices = {}
-        cmd = 'nmcli -v'
-        rc = sp.call(cmd, shell=True, stdout=sp.DEVNULL, stderr=sp.DEVNULL)
-        if rc != 0:
-            self.available = False
-            return
-        self.available = True
-        cmd = 'nmcli -t -f DEVICE,STATE d'
-        output = sp.check_output(cmd, shell=True).decode(sys.stdout.encoding)
-        for line in output.splitlines():
+
+    def parse(self, data=None):
+        if data is None:
+            cmd = 'nmcli -t -f DEVICE,STATE d'
+            data = sp.check_output(cmd, shell=True).decode(sys.stdout.encoding)
+        for line in data.splitlines():
             dev, state = line.strip().split(':')
             self.devices[dev] = state
 
@@ -67,60 +73,74 @@ class States(Enum):
     nm = 'NetworkManager'
 
 
-def main():
-    # Use udev as definitive source of network interfaces
-    all_interfaces = UdevInterfaceLister(['NETWORK', 'WIRELESS'])
+def identify_managers(interfaces=None,
+                      has_netplan=True, netplan_yaml=None,
+                      has_nm=True, nm_device_state=None):
+    if interfaces is None:
+        interfaces = UdevInterfaceLister(['NETWORK', 'WIRELESS']).names
 
-    # Get the neplan config
-    netplan_conf = Netplan()
-    netplan_conf.parse()
+    results = dict.fromkeys(interfaces, States.unspecified)
 
-    # Get the NetworkManager config
-    nm_conf = NmInterfaceState()
+    if has_nm:
+        nm_conf = NmInterfaceState()
+        nm_conf.parse(nm_device_state)
 
     # fallback state
     global_scope_manager = States.unspecified.value
-
-    # if netplan has a top-level renderer use that as default:
-    if netplan_conf.network.get('renderer'):
-        global_scope_manager = netplan_conf.network['renderer']
-
-    for n in all_interfaces.names:
-        print('device: {}'.format(n))
-        print('nmcli_available: {}'.format(nm_conf.available))
-
+    if has_netplan:
+        netplan_conf = Netplan()
+        netplan_conf.parse(data=netplan_yaml)
+        # if netplan has a top-level renderer use that as default:
+        if netplan_conf.network.get('renderer'):
+            global_scope_manager = netplan_conf.network['renderer']
+
+    for n in results:
         category_scope_manager = States.unspecified.value
-        if n in netplan_conf.wifis:
-            category_scope_manager = netplan_conf.wifis.get(
-                'renderer', States.unspecified.value)
-        elif n in netplan_conf.ethernets:
-            category_scope_manager = netplan_conf.ethernets.get(
-                'renderer', States.unspecified.value)
+        if has_netplan:
+            if n in netplan_conf.wifis:
+                category_scope_manager = netplan_conf.wifis.get(
+                    'renderer', States.unspecified.value)
+            elif n in netplan_conf.ethernets:
+                category_scope_manager = netplan_conf.ethernets.get(
+                    'renderer', States.unspecified.value)
 
         # Netplan config indcates NM
         if (global_scope_manager == States.nm.value or
-                category_scope_manager == States.nm.value):
+                category_scope_manager == States.nm.value or
+                not has_netplan):
             # if NM isnt actually available this is a bad config
-            if not nm_conf.available:
-                print('managed_by: {}'.format(States.error.value))
-                print()
+            if not has_nm:
+                print('error: netplan defines NM or there is no netplan, '
+                      'but NM unavailable')
+                results[n] = States.error
                 continue
             # NM does not know the interface
             if nm_conf.devices.get(n) is None:
-                print('managed_by: {}'.format(States.error.value))
-                print()
+                print('error: netplan defines NM or there is no netplan, '
+                      'but interface unknown to NM')
+                results[n] = States.error
                 continue
-            # NM thinks it doesnt managed the device despite netplan config
+            # NM thinks it doesnt manage the device despite netplan config
             if nm_conf.devices.get(n) == 'unmanaged':
-                print('managed_by: {}'.format(States.error.value))
-                print()
+                print('error: netplan defines NM or there is no netplan, '
+                      'but NM reports unmanaged')
+                results[n] = States.error
                 continue
-            print('managed_by: {}'.format(States.nm.value))
-            print()
+            results[n] = States.nm
             continue
 
-        # No renderer specified
-        print('managed_by: {}'.format(States.networkd.value))
+        # has netplan but no renderer specified
+        if has_netplan:
+            results[n] = 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():
+        print('device: {}'.format(interface))
+        print('managed_by: {}'.format(state.value))
         print()
 
 
diff --git a/tests/test_net_if_management.py b/tests/test_net_if_management.py
new file mode 100644
index 0000000..8f68d86
--- /dev/null
+++ b/tests/test_net_if_management.py
@@ -0,0 +1,137 @@
+#!/usr/bin/env python3
+# This file is part of Checkbox.
+#
+# Copyright 2019 Canonical Ltd.
+# Written by:
+#   Jonathan Cave <[e-mail]>
+#
+# Checkbox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3,
+# as published by the Free Software Foundation.
+#
+# Checkbox 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 Checkbox.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import unittest
+
+from checkbox_support.parsers.netplan import Netplan
+from checkbox_support.parsers.udevadm import UdevadmParser, UdevResult
+
+import net_if_management
+
+
+class NetIfMngrTest():
+
+    has_netplan = True
+    has_nm = True
+
+    @staticmethod
+    def get_text(filename):
+        full_path = os.path.join(
+            os.path.dirname(os.path.realpath(__file__)),
+            'test_net_if_management_data',
+            filename)
+        with open(full_path, 'rt', encoding='UTF-8') as stream:
+            return stream.read()
+
+    def get_results(self):
+        if self.netplan_yaml is None:
+            self.has_netplan = False
+        if self.nm_device_state is None:
+            self.has_nm = False
+        return net_if_management.identify_managers(self.interfaces,
+                                                   self.has_netplan,
+                                                   self.netplan_yaml,
+                                                   self.has_nm,
+                                                   self.nm_device_state)
+
+
+class Test_CARA_T(unittest.TestCase, NetIfMngrTest):
+    # the interfaces we interested in (as provided by the udev parser)
+    interfaces = ['eth0', 'eth1', 'wlan0']
+
+    # the combined netplan configuration
+    netplan_yaml = NetIfMngrTest.get_text('CARA_T_netplan.yaml')
+
+    # capture output of `sudo nmcli -t -f DEVICE,STATE d`
+    # or None if no NM available
+    nm_device_state = NetIfMngrTest.get_text('CARA_T_nmcli.txt')
+
+    def test(self):
+        res = self.get_results()
+        self.assertEqual(res['eth0'].value, 'NetworkManager')
+        self.assertEqual(res['eth1'].value, 'NetworkManager')
+        self.assertEqual(res['wlan0'].value, 'NetworkManager')
+
+
+class Test_XENIAL_DESKTOP(unittest.TestCase, NetIfMngrTest):
+    # the interfaces we interested in (as provided by the udev parser)
+    interfaces = ['eth0', 'wlan0']
+
+    # the combined netplan configuration or `None` if netplan not installed
+    netplan_yaml = None
+
+    # capture output of `sudo nmcli -t -f DEVICE,STATE d`
+    # or None if NM is not installed
+    nm_device_state = NetIfMngrTest.get_text('XENIAL_DESKTOP_nmcli.txt')
+
+    def test(self):
+        res = self.get_results()
+        self.assertEqual(res['eth0'].value, 'NetworkManager')
+        self.assertEqual(res['wlan0'].value, 'NetworkManager')
+
+
+class Test_CASCADE_500(unittest.TestCase, NetIfMngrTest):
+    # the interfaces we interested in (as provided by the udev parser)
+    interfaces = ['eth0', 'wlan0']
+
+    # the combined netplan configuration or `None` if netplan not installed
+    netplan_yaml = NetIfMngrTest.get_text('CASCADE_500_netplan.yaml')
+
+    # capture output of `sudo nmcli -t -f DEVICE,STATE d`
+    # or None if NM is not installed
+    nm_device_state = NetIfMngrTest.get_text('CASCADE_500_nmcli.txt')
+
+    def test(self):
+        res = self.get_results()
+        self.assertEqual(res['eth0'].value, 'NetworkManager')
+        self.assertEqual(res['wlan0'].value, 'NetworkManager')
+
+
+class Test_RPI2_UC16_CCONF(unittest.TestCase, NetIfMngrTest):
+    # the interfaces we interested in (as provided by the udev parser)
+    interfaces = ['eth0']
+
+    # the combined netplan configuration or `None` if netplan not installed
+    netplan_yaml = NetIfMngrTest.get_text('RPI2_UC16_CCONF_netplan.yaml')
+
+    # capture output of `sudo nmcli -t -f DEVICE,STATE d`
+    # or None if NM is not installed
+    nm_device_state = None
+
+    def test(self):
+        res = self.get_results()
+        self.assertEqual(res['eth0'].value, 'networkd')
+
+
+class Test_RPI3B_UC16_CLOUDINIT(unittest.TestCase, NetIfMngrTest):
+    # the interfaces we interested in (as provided by the udev parser)
+    interfaces = ['eth0', 'wlan0']
+
+    # the combined netplan configuration or `None` if netplan not installed
+    netplan_yaml = NetIfMngrTest.get_text('RPI3B_UC16_CLOUDINIT_netplan.yaml')
+
+    # capture output of `sudo nmcli -t -f DEVICE,STATE d`
+    # or None if NM is not installed
+    nm_device_state = None
+
+    def test(self):
+        res = self.get_results()
+        self.assertEqual(res['eth0'].value, 'networkd')
+        self.assertEqual(res['wlan0'].value, 'networkd')
diff --git a/tests/test_net_if_management_data/CARA_T_netplan.yaml b/tests/test_net_if_management_data/CARA_T_netplan.yaml
new file mode 100644
index 0000000..43bbdc7
--- /dev/null
+++ b/tests/test_net_if_management_data/CARA_T_netplan.yaml
@@ -0,0 +1,2 @@
+network:
+  renderer: NetworkManager
\ No newline at end of file
diff --git a/tests/test_net_if_management_data/CARA_T_nmcli.txt b/tests/test_net_if_management_data/CARA_T_nmcli.txt
new file mode 100644
index 0000000..b4aaaae
--- /dev/null
+++ b/tests/test_net_if_management_data/CARA_T_nmcli.txt
@@ -0,0 +1,4 @@
+eth0:connected
+eth1:unavailable
+wlan0:disconnected
+lo:unmanaged
\ No newline at end of file
diff --git a/tests/test_net_if_management_data/CASCADE_500_netplan.yaml b/tests/test_net_if_management_data/CASCADE_500_netplan.yaml
new file mode 100644
index 0000000..43bbdc7
--- /dev/null
+++ b/tests/test_net_if_management_data/CASCADE_500_netplan.yaml
@@ -0,0 +1,2 @@
+network:
+  renderer: NetworkManager
\ No newline at end of file
diff --git a/tests/test_net_if_management_data/CASCADE_500_nmcli.txt b/tests/test_net_if_management_data/CASCADE_500_nmcli.txt
new file mode 100644
index 0000000..a2ee118
--- /dev/null
+++ b/tests/test_net_if_management_data/CASCADE_500_nmcli.txt
@@ -0,0 +1,5 @@
+eth0: connected
+wlan0: connected
+ttyACM1: unavailable
+lo: unmanaged
+p2p0: unmanaged
\ No newline at end of file
diff --git a/tests/test_net_if_management_data/RPI2_UC16_CCONF_netplan.yaml b/tests/test_net_if_management_data/RPI2_UC16_CCONF_netplan.yaml
new file mode 100644
index 0000000..afa0ebc
--- /dev/null
+++ b/tests/test_net_if_management_data/RPI2_UC16_CCONF_netplan.yaml
@@ -0,0 +1,7 @@
+# This is the network config written by 'console_conf'
+network:
+  ethernets:
+    eth0:
+      addresses: []
+      dhcp4: true
+  version: 2
\ No newline at end of file
diff --git a/tests/test_net_if_management_data/RPI3B_UC16_CLOUDINIT_netplan.yaml b/tests/test_net_if_management_data/RPI3B_UC16_CLOUDINIT_netplan.yaml
new file mode 100644
index 0000000..c6deff3
--- /dev/null
+++ b/tests/test_net_if_management_data/RPI3B_UC16_CLOUDINIT_netplan.yaml
@@ -0,0 +1,13 @@
+# This file is generated from information provided by
+# the datasource.  Changes to it will not persist across an instance.
+# To disable cloud-init's network configuration capabilities, write a file
+# /etc/cloud/cloud.cfg.d/99-disable-network-config.cfg with the following:
+# network: {config: disabled}
+network:
+    version: 2
+    ethernets:
+        eth0:
+            dhcp4: true
+            match:
+                macaddress: 00:00:00:00:00:00
+            set-name: eth0
\ No newline at end of file
diff --git a/tests/test_net_if_management_data/XENIAL_DESKTOP_nmcli.txt b/tests/test_net_if_management_data/XENIAL_DESKTOP_nmcli.txt
new file mode 100644
index 0000000..71105db
--- /dev/null
+++ b/tests/test_net_if_management_data/XENIAL_DESKTOP_nmcli.txt
@@ -0,0 +1,3 @@
+eth0:connected
+wlan0:disconnected
+lo:unmanaged
\ No newline at end of file