Fix AddressesColumn sorting in server list output

Made AddressesColumn comparable by its human-readable value so
that 'openstack server list --sort-column Networks' no longer
raises a TypeError or 'Could not sort on field 'Networks'; unsortable types' when comparing two AddressesColumn instances
wrapping address dicts.

Added a regression tests covering ordering and equality of
AddressesColumn instances.

Change-Id: I730a0ec670d6b19a45ea2cc4ca9e1c0254c9ced1
Signed-off-by: Udayendu Kar <udayendu.kar@gmail.com>

Author: Udayendu

openstackclient/compute/v2/server.py

@@ -89,6 +89,19 @@ def machine_readable(self) -> Any:
             for k, v in (self._value.items() if self._value else [])
         }
 
+    def __lt__(self, other: Any) -> bool:
+        # cliff only ever compares two values from the same column,
+        # so `other` is expected to also be an AddressesColumn
+        return self.human_readable() < other.human_readable()
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, AddressesColumn):
+            return NotImplemented
+        return self.human_readable() == other.human_readable()
+
+    def __hash__(self) -> int:
+        return hash(self.human_readable())
+
 
 class HostColumn(cliff_columns.FormattableColumn[str | None]):
     """Generate a formatted string of a hostname."""

openstackclient/tests/unit/compute/v2/test_server.py

@@ -84,6 +84,41 @@ def setup_sdk_servers_mock(self, count):
         return servers
 
 
+class TestAddressesColumn(test_utils.TestCommand):
+    def setUp(self):
+        super().setUp()
+
+        self.addr_a = server.AddressesColumn(
+            {'demo-net': [{'addr': '10.0.0.144', 'version': 4}]}
+        )
+        self.addr_b = server.AddressesColumn(
+            {'network1': [{'addr': '192.168.1.254', 'version': 4}]}
+        )
+
+    def test_sorting(self):
+        """Verify AddressesColumn objects can be sorted."""
+        addresses = [
+            self.addr_b,
+            self.addr_a,
+        ]
+
+        self.assertEqual(
+            [self.addr_a, self.addr_b],
+            sorted(addresses),
+        )
+
+    def test_comparison(self):
+        """Verify AddressesColumn comparison uses human-readable values."""
+        addr_a_dup = server.AddressesColumn(
+            {'demo-net': [{'addr': '10.0.0.144', 'version': 4}]}
+        )
+
+        self.assertLess(self.addr_a, self.addr_b)
+        self.assertGreater(self.addr_b, self.addr_a)
+        self.assertEqual(self.addr_a, addr_a_dup)
+        self.assertNotEqual(self.addr_a, self.addr_b)
+
+
 class TestServerAddFixedIP(TestServer):
     def setUp(self):
         super().setUp()