Merge ~mateus-morais/ubuntu/+source/nvme-stas:nvme-stas-s390x-autopkgtest-failure into ubuntu/+source/nvme-stas:ubuntu/devel

[Mateus Rodrigues de Morais]

Fixes LP: #2026878.

On staslib/iputil.py, all byte-related operations were hardcoded as byteorder='little'. Since s390x is a big-endian architecture, the iputil unit tests were failing and, most likely, iputil itself was not working as expected on this platform.

This merge proposal changes the way byteorder is handled by replacing 'little' with sys.byteorder.

A PPA build is available at [1]. The s390x autopkgtest is now passing, as reported in [2].

[1] https://launchpad.net/~mateus-morais/+archive/ubuntu/nvme-stas-s390x-fix
[2] https://autopkgtest.ubuntu.com/results/autopkgtest-mantic-mateus-morais-nvme-stas-s390x-fix/mantic/s390x/n/nvme-stas/20230904_164958_d28c9@/log.gz

[Benjamin Drung (bdrung)]

Thanks. I took your patch, converted it to a "gbp pq" one and uploaded the fix to Debian unstable as 2.2.2-2.

review: Approve

diff --git a/debian/changelog b/debian/changelog
index 9320662..0145627 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+nvme-stas (2.2.2-1ubuntu1) mantic; urgency=medium
+
+  * d/p/1000-iputil-fix-byte-ordering.patch: made byteorder architecture-aware
+    in order to fix s390x autopkgtest failures. (LP: #2026878)
+
+ -- Mateus Rodrigues de Morais <[e-mail]>  Mon, 04 Sep 2023 11:33:08 -0300
+
 nvme-stas (2.2.2-1) sid; urgency=medium
 
   * Uploading to sid.
diff --git a/debian/control b/debian/control
index c26dae6..782f6b3 100644
--- a/debian/control
+++ b/debian/control
@@ -1,7 +1,8 @@
 Source: nvme-stas
 Section: net
 Priority: optional
-Maintainer: Daniel Baumann <[e-mail]>
+Maintainer: Ubuntu Developers <[e-mail]>
+XSBC-Original-Maintainer: Daniel Baumann <[e-mail]>
 Uploaders:
  Benjamin Drung <[e-mail]>,
 Build-Depends:
diff --git a/debian/patches/1000-iputil-fix-byte-ordering.patch b/debian/patches/1000-iputil-fix-byte-ordering.patch
 new file mode 100644
index 0000000..a7aaeff
--- /dev/null
+++ b/debian/patches/1000-iputil-fix-byte-ordering.patch
@@ -0,0 +1,70 @@
+Description: Fix byte ordering in iputil operations
+ Previously, the byte ordering on all byte array operations in iputil were
+ hard-coded to 'little'. This patch makes the byteorder parameter arch-aware
+ by using sys.byteorder instead.
+Author: Mateus Rodrigues de Morais <[e-mail]>
+Bug-Ubuntu: https://bugs.launchpad.net/ubuntu/+source/nvme-stas/+bug/2026878
+Last-Update: 2023-09-04
+---
+This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
+Index: nvme-stas-gu/staslib/iputil.py
+===================================================================
+--- nvme-stas-gu.orig/staslib/iputil.py	2023-09-04 11:01:16.238467138 -0300
++++ nvme-stas-gu/staslib/iputil.py	2023-09-04 11:18:14.286867008 -0300
+@@ -8,6 +8,7 @@
+ 
+ '''A collection of IP address and network interface utilities'''
+ 
++import sys
+ import socket
+ import logging
+ import ipaddress
+@@ -27,14 +28,14 @@
+ GETADDRCMD = (
+     # BEGIN: struct nlmsghdr
+     b'\0' * 4  # nlmsg_len (placeholder - actual length calculated below)
+-    + (RTM_GETADDR).to_bytes(2, byteorder='little', signed=False)  # nlmsg_type
+-    + (NLM_F_REQUEST | NLM_F_ROOT).to_bytes(2, byteorder='little', signed=False)  # nlmsg_flags
++    + (RTM_GETADDR).to_bytes(2, byteorder=sys.byteorder, signed=False)  # nlmsg_type
++    + (NLM_F_REQUEST | NLM_F_ROOT).to_bytes(2, byteorder=sys.byteorder, signed=False)  # nlmsg_flags
+     + b'\0' * 2  # nlmsg_seq
+     + b'\0' * 2  # nlmsg_pid
+     # END: struct nlmsghdr
+     + b'\0' * 8  # struct ifaddrmsg
+ )
+-GETADDRCMD = len(GETADDRCMD).to_bytes(4, byteorder='little') + GETADDRCMD[4:]  # nlmsg_len
++GETADDRCMD = len(GETADDRCMD).to_bytes(4, byteorder=sys.byteorder) + GETADDRCMD[4:]  # nlmsg_len
+ 
+ 
+ # ******************************************************************************
+@@ -85,25 +86,25 @@
+             if nlmsg_idx >= len(nlmsg):
+                 nlmsg += sock.recv(8192)
+ 
+-            nlmsg_type = int.from_bytes(nlmsg[nlmsg_idx + 4 : nlmsg_idx + 6], byteorder='little', signed=False)
++            nlmsg_type = int.from_bytes(nlmsg[nlmsg_idx + 4 : nlmsg_idx + 6], byteorder=sys.byteorder, signed=False)
+             if nlmsg_type == NLMSG_DONE:
+                 break
+ 
+             if nlmsg_type != RTM_NEWADDR:
+                 break
+ 
+-            nlmsg_len = int.from_bytes(nlmsg[nlmsg_idx : nlmsg_idx + 4], byteorder='little', signed=False)
++            nlmsg_len = int.from_bytes(nlmsg[nlmsg_idx : nlmsg_idx + 4], byteorder=sys.byteorder, signed=False)
+             if nlmsg_len % 4:  # Is msg length not a multiple of 4?
+                 break
+ 
+             ifaddrmsg_indx = nlmsg_idx + NLMSGHDR_SZ
+             ifa_family = nlmsg[ifaddrmsg_indx]
+-            ifa_index = int.from_bytes(nlmsg[ifaddrmsg_indx + 4 : ifaddrmsg_indx + 8], byteorder='little', signed=False)
++            ifa_index = int.from_bytes(nlmsg[ifaddrmsg_indx + 4 : ifaddrmsg_indx + 8], byteorder=sys.byteorder, signed=False)
+ 
+             rtattr_indx = ifaddrmsg_indx + IFADDRMSG_SZ
+             while rtattr_indx < (nlmsg_idx + nlmsg_len):
+-                rta_len = int.from_bytes(nlmsg[rtattr_indx : rtattr_indx + 2], byteorder='little', signed=False)
+-                rta_type = int.from_bytes(nlmsg[rtattr_indx + 2 : rtattr_indx + 4], byteorder='little', signed=False)
++                rta_len = int.from_bytes(nlmsg[rtattr_indx : rtattr_indx + 2], byteorder=sys.byteorder, signed=False)
++                rta_type = int.from_bytes(nlmsg[rtattr_indx + 2 : rtattr_indx + 4], byteorder=sys.byteorder, signed=False)
+                 if rta_type == IFLA_ADDRESS:
+                     data = nlmsg[rtattr_indx + RTATTR_SZ : rtattr_indx + rta_len]
+                     if _data_matches_ip(ifa_family, data, src_addr):
diff --git a/debian/patches/series b/debian/patches/series
 new file mode 100644
index 0000000..245d0d2
--- /dev/null
+++ b/debian/patches/series
@@ -0,0 +1 @@
+1000-iputil-fix-byte-ordering.patch