Merge "Add availability zone and host filters to aggregate list"

Author: Zuul

openstackclient/compute/v2/aggregate.py

@@ -196,6 +196,18 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             default=False,
             help=_("List additional fields in output"),
         )
+        parser.add_argument(
+            '--availability-zone',
+            metavar='<availability-zone>',
+            default=None,
+            help=_("Filter by availability zone name"),
+        )
+        parser.add_argument(
+            '--host',
+            metavar='<host>',
+            default=None,
+            help=_("Filter by aggregates containing this host"),
+        )
         return parser
 
     def take_action(
@@ -205,6 +217,23 @@ def take_action(
 
         aggregates = list(compute_client.aggregates())
 
+        # NOTE: The compute API does not support server-side filtering of
+        # aggregates, so we filter client-side. When more than one filter is
+        # given they are combined with AND (results must match all filters).
+        if parsed_args.availability_zone is not None:
+            aggregates = [
+                aggregate
+                for aggregate in aggregates
+                if aggregate.availability_zone == parsed_args.availability_zone
+            ]
+
+        if parsed_args.host is not None:
+            aggregates = [
+                aggregate
+                for aggregate in aggregates
+                if aggregate.hosts and parsed_args.host in aggregate.hosts
+            ]
+
         if sdk_utils.supports_microversion(compute_client, '2.41'):
             column_headers: tuple[str, ...] = ("ID", "UUID")
             columns: tuple[str, ...] = ("id", "uuid")

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

@@ -326,6 +326,70 @@ def test_aggregate_list_with_long(self):
         self.assertEqual(expected_columns, columns)
         self.assertCountEqual(expected_data, tuple(data))
 
+    def test_aggregate_list_with_availability_zone(self):
+        self.set_compute_api_version('2.41')
+
+        arglist = [
+            '--availability-zone',
+            self.fake_ag.availability_zone,
+        ]
+        verifylist = [
+            ('availability_zone', self.fake_ag.availability_zone),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        _, data = self.cmd.take_action(parsed_args)
+
+        # the matching aggregate is returned
+        self.assertEqual(1, len(tuple(data)))
+
+    def test_aggregate_list_with_availability_zone_no_match(self):
+        self.set_compute_api_version('2.41')
+
+        arglist = [
+            '--availability-zone',
+            'does-not-exist',
+        ]
+        verifylist = [
+            ('availability_zone', 'does-not-exist'),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        _, data = self.cmd.take_action(parsed_args)
+
+        # no aggregate matches the filter
+        self.assertEqual(0, len(tuple(data)))
+
+    def test_aggregate_list_with_host(self):
+        self.set_compute_api_version('2.41')
+
+        arglist = [
+            '--host',
+            self.fake_ag.hosts[0],
+        ]
+        verifylist = [
+            ('host', self.fake_ag.hosts[0]),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        _, data = self.cmd.take_action(parsed_args)
+
+        # the aggregate containing the host is returned
+        self.assertEqual(1, len(tuple(data)))
+
+    def test_aggregate_list_with_host_no_match(self):
+        self.set_compute_api_version('2.41')
+
+        arglist = [
+            '--host',
+            'does-not-exist',
+        ]
+        verifylist = [
+            ('host', 'does-not-exist'),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        _, data = self.cmd.take_action(parsed_args)
+
+        # no aggregate contains the host
+        self.assertEqual(0, len(tuple(data)))
+
 
 class TestAggregateRemoveHost(TestAggregate):
     def setUp(self):

releasenotes/notes/aggregate-list-filters-7b9f3a1c8e2d4f60.yaml

@@ -0,0 +1,9 @@
+---
+features:
+  - |
+    Added ``--availability-zone`` and ``--host`` options to the
+    ``aggregate list`` command. These allow the results to be filtered by
+    availability zone name and by aggregates containing a given host. The
+    compute API does not support server-side filtering of aggregates, so the
+    filtering is performed client-side. When both options are supplied they
+    are combined with AND, returning only aggregates that match every filter.