Merge ~ogayot/ubuntu/+source/nvme-stas:2045690 into ubuntu/+source/nvme-stas:ubuntu/devel

[Olivier Gayot]

Fixes autopkgtest on armhf where the runners are configured with esoteric types of network interfaces.

Patches were sent to Debian in https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1057530 and upstream in https://github.com/linux-nvme/nvme-stas/pull/411

[Graham Inggs (ginggs)]

Looks good to me, sponsoring

review: Approve

diff --git a/debian/changelog b/debian/changelog
index 1a95dbb..b6d470c 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+nvme-stas (2.3-1ubuntu3) noble; urgency=medium
+
+  * Skip mac2iface test for esoteric network interfaces (LP: #2045690)
+  * Add upstream patch to fix udev test for esoteric network interfaces
+
+ -- Olivier Gayot <[e-mail]>  Tue, 05 Dec 2023 21:04:32 +0100
+
 nvme-stas (2.3-1ubuntu2) noble; urgency=medium
 
   * Fix endianness issues in staslib.iputil causing hangs on s390x.
diff --git a/debian/patches/fix-test-udev-with-dummy-interfaces.patch b/debian/patches/fix-test-udev-with-dummy-interfaces.patch
 new file mode 100644
index 0000000..55ec133
--- /dev/null
+++ b/debian/patches/fix-test-udev-with-dummy-interfaces.patch
@@ -0,0 +1,26 @@
+Description: Fix test-udev with dummy interfaces
+Author: Martin Belanger <[e-mail]>
+Origin: upstream, https://github.com/linux-nvme/nvme-stas/commit/371c1e875a9a660adca241265e4cd460ee7e5e5c
+Bug: https://github.com/linux-nvme/nvme-stas/issues/407
+Last-Update: 2023-12-05
+---
+This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
+diff --git a/test/test-udev.py b/test/test-udev.py
+index ba484e0..9621edc 100755
+--- a/test/test-udev.py
++++ b/test/test-udev.py
+@@ -295,6 +295,11 @@ class Test(unittest.TestCase):
+     def test__cid_matches_tid(self):
+         ifaces = iputil.net_if_addrs()
+         for ifname, addrs in self.ifaces.items():
++            # <ifaces> contains a subset of the interfaces found in <self.ifaces>.
++            # So, let's make sure that we only test with the interfaces found in both.
++            if ifname not in ifaces:
++                continue
++
+             ##############################################
+             # IPV4
+ 
+-- 
+2.40.1
+
diff --git a/debian/patches/series b/debian/patches/series
index 94de61d..77f0830 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,3 +1,5 @@
 fix-test-libnvme-version.patch
 fix-test-udev-failing-multiple-IPv6.patch
 fix-iputil-endianness-issue.patch
+skip-mac2iface-test-for-esoteric-interfaces.patch
+fix-test-udev-with-dummy-interfaces.patch
diff --git a/debian/patches/skip-mac2iface-test-for-esoteric-interfaces.patch b/debian/patches/skip-mac2iface-test-for-esoteric-interfaces.patch
 new file mode 100644
index 0000000..589b969
--- /dev/null
+++ b/debian/patches/skip-mac2iface-test-for-esoteric-interfaces.patch
@@ -0,0 +1,71 @@
+Description: Skip mac2iface test for esoteric interfaces
+ mac2iface takes a MAC address as argument and returns the corresponding
+ interface (if any).
+ The mac2iface tests will however invoke mac2iface with invalid MAC addresses
+ when esoteric network interfaces are present on the system. As an example,
+ armhf autopkgtest runners in Ubuntu have gre interfaces configured so the
+ test-suite fails.
+ .
+ We now ensure that the test-suite calls mac2iface with only valid MAC
+ addresses.
+ .
+ Furthermore, sometimes the same MAC address is assigned to more than one
+ interface on the system (this is true for VLAN interfaces for instance). This
+ confuses mac2iface, which returns only the first match. This scenario is
+ possibly more of a nvme-stas bug than a test-suite bug, but for now we will
+ just skip the interfaces that have a duplicate MAC address.
+Author: Olivier Gayot <[e-mail]>
+Bug-Ubuntu: https://launchpad.net/bugs/2045690
+Bug-Debian: https://bugs.debian.org/1057530
+Forwarded: https://github.com/linux-nvme/nvme-stas/pull/411
+Last-Update: 2023-12-05
+---
+This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
+--- a/test/test-iputil.py
++++ b/test/test-iputil.py
+@@ -43,11 +43,41 @@
+         self.assertEqual('', iputil.get_interface(ifaces, ''))
+         self.assertEqual('', iputil.get_interface(ifaces, None))
+ 
++    @staticmethod
++    def _is_ok_for_mac2iface(iface) -> bool:
++        ''' mac2iface can only work with interfaces that have a proper MAC
++        address. One can use this function to filter out other interfaces
++        configured on the system. '''
++        if iface['link_type'] != 'ether':
++            # Some esoteric interface types (e.g., gre) use the address
++            # field to store something that is not a MAC address. Skip
++            # them.
++            return False
++        if 'address' not in iface:
++            return False
++        if iface['address'] == '00:00:00:00:00:00':
++            # All 0's is an invalid MAC address so do not bother.
++            # In practice, it often appears as the address of the loopback
++            # interface but it can also appear for other things like a gretap
++            # or erspan interface.
++            return False
++        return True
++
+     def test_mac2iface(self):
+-        for iface in self.ifaces:
+-            address = iface.get('address', None)
+-            if address:
+-                self.assertEqual(iface['ifname'], iputil.mac2iface(address))
++        # We only test the interfaces that have a MAC address, and a valid one.
++        candidate_ifaces = [iface for iface in self.ifaces if self._is_ok_for_mac2iface(iface)]
++
++        for iface in candidate_ifaces:
++            if len([x for x in candidate_ifaces if x['address'] == iface['address']]) >= 2:
++                # We need to be careful, sometimes we can have the same MAC address
++                # on multiple interfaces. This happens with VLAN interfaces for
++                # instance. mac2iface will obviously be confused when dealing with
++                # those so let's skip the interfaces that have duplicate MAC.
++                logging.warning('[%s] is not the only interface with address [%s]',
++                                iface['ifname'], iface['address'])
++                continue
++
++            self.assertEqual(iface['ifname'], iputil.mac2iface(iface['address']))
+ 
+     def test_remove_invalid_addresses(self):
+         good_tcp = trid.TID({'transport': 'tcp', 'traddr': '1.1.1.1', 'subsysnqn': '', 'trsvcid': '8009'})