Add metadata as a filter condition when listing volumes

ohjiwoo · stephenfin · commit 572eeb6d38f9 · 2025-07-04T09:28:40.000Z
When listing volumes, the API provides metadata as a query parameter, but this feature is not implemented in the client code. So add parameter.

story: 2011487
task: 52446
Change-Id: I4bf66d4e073c86296fa96ee29c2b33d771e18293
Signed-off-by: ohjiwoo &lt;jiwooo.oh@samsung.com&gt;
diff --git a/openstackclient/tests/unit/volume/v3/test_volume.py b/openstackclient/tests/unit/volume/v3/test_volume.py
@@ -1239,6 +1239,7 @@ def test_volume_list_no_options(self):
             'user_id': None,
             'name': None,
             'status': None,
+            'metadata': None,
         }
         self.volumes_mock.list.assert_called_once_with(
             search_opts=search_opts,
@@ -1282,6 +1283,7 @@ def test_volume_list_project(self):
             'user_id': None,
             'name': None,
             'status': None,
+            'metadata': None,
         }
         self.volumes_mock.list.assert_called_once_with(
             search_opts=search_opts,
@@ -1328,6 +1330,7 @@ def test_volume_list_project_domain(self):
             'user_id': None,
             'name': None,
             'status': None,
+            'metadata': None,
         }
         self.volumes_mock.list.assert_called_once_with(
             search_opts=search_opts,
@@ -1371,6 +1374,7 @@ def test_volume_list_user(self):
             'user_id': self.user.id,
             'name': None,
             'status': None,
+            'metadata': None,
         }
         self.volumes_mock.list.assert_called_once_with(
             search_opts=search_opts,
@@ -1416,6 +1420,7 @@ def test_volume_list_user_domain(self):
             'user_id': self.user.id,
             'name': None,
             'status': None,
+            'metadata': None,
         }
         self.volumes_mock.list.assert_called_once_with(
             search_opts=search_opts,
@@ -1459,6 +1464,7 @@ def test_volume_list_name(self):
             'user_id': None,
             'name': self.mock_volume.name,
             'status': None,
+            'metadata': None,
         }
         self.volumes_mock.list.assert_called_once_with(
             search_opts=search_opts,
@@ -1502,6 +1508,7 @@ def test_volume_list_status(self):
             'user_id': None,
             'name': None,
             'status': self.mock_volume.status,
+            'metadata': None,
         }
         self.volumes_mock.list.assert_called_once_with(
             search_opts=search_opts,
@@ -1544,6 +1551,7 @@ def test_volume_list_all_projects(self):
             'user_id': None,
             'name': None,
             'status': None,
+            'metadata': None,
         }
         self.volumes_mock.list.assert_called_once_with(
             search_opts=search_opts,
@@ -1587,6 +1595,7 @@ def test_volume_list_long(self):
             'user_id': None,
             'name': None,
             'status': None,
+            'metadata': None,
         }
         self.volumes_mock.list.assert_called_once_with(
             search_opts=search_opts,
@@ -1660,6 +1669,7 @@ def test_volume_list_with_marker_and_limit(self):
                 'user_id': None,
                 'name': None,
                 'all_tenants': False,
+                'metadata': None,
             },
         )
         self.assertCountEqual(datalist, tuple(data))
@@ -1704,6 +1714,7 @@ def test_volume_list_backward_compatibility(self):
             'user_id': None,
             'name': None,
             'status': None,
+            'metadata': None,
         }
         self.volumes_mock.list.assert_called_once_with(
             search_opts=search_opts,
diff --git a/openstackclient/volume/v3/volume.py b/openstackclient/volume/v3/volume.py
@@ -574,6 +574,16 @@ def get_parser(self, prog_name):
             metavar='<status>',
             help=_('Filter results by status'),
         )
+        parser.add_argument(
+            '--property',
+            metavar='<key=value>',
+            action=parseractions.KeyValueAction,
+            dest='properties',
+            help=_(
+                'Filter by a property on the volume list '
+                '(repeat option to filter by multiple properties) '
+            ),
+        )
         parser.add_argument(
             '--all-projects',
             action='store_true',
@@ -642,6 +652,7 @@ def take_action(self, parsed_args):
             'user_id': user_id,
             'name': parsed_args.name,
             'status': parsed_args.status,
+            'metadata': parsed_args.properties,
         }
 
         data = volume_client.volumes.list(
diff --git a/releasenotes/notes/add-volume-list-property-option-62008dc24762663b.yaml b/releasenotes/notes/add-volume-list-property-option-62008dc24762663b.yaml
@@ -0,0 +1,3 @@
+---
+features:
+  - Add ``--property`` option to ``volume list`` command to filter volumes.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+---`
	`2`	`+features:`
	`3`	+ - Add ``--property`` option to ``volume list`` command to filter volumes.