Allow to filter multiple tags for image list

Dmitriy Rabotyagov · stephenfin · commit 5cc6fc2b8829 · 2022-05-16T09:16:52.000+01:00
Currently in case of passing `--tag` several times, only last one will be picked up for the filtering. In the meanwhile Glance allow option to be repeated multiple times to filter based on the multiple tags. Depends-On: https://review.opendev.org/c/openstack/openstacksdk/+/789827 Change-Id: I7379d0b0014f0e3d13b02ee5ec6b642a7a5aa7d1
diff --git a/openstackclient/image/v2/image.py b/openstackclient/image/v2/image.py
@@ -613,8 +613,10 @@ def get_parser(self, prog_name):
         parser.add_argument(
             '--tag',
             metavar='<tag>',
-            default=None,
-            help=_('Filter images based on tag.'),
+            action='append',
+            default=[],
+            help=_('Filter images based on tag. '
+                   '(repeat option to filter on multiple tags)'),
         )
         parser.add_argument(
             '--hidden',
diff --git a/openstackclient/tests/functional/image/v2/test_image.py b/openstackclient/tests/functional/image/v2/test_image.py
@@ -26,6 +26,7 @@ def setUp(self):
 
         self.name = uuid.uuid4().hex
         self.image_tag = 'my_tag'
+        self.image_tag1 = 'random'
         json_output = json.loads(self.openstack(
             '--os-image-api-version 2 '
             'image create -f json --tag {tag} {name}'.format(
@@ -78,13 +79,18 @@ def test_image_list_with_status_filter(self):
 
     def test_image_list_with_tag_filter(self):
         json_output = json.loads(self.openstack(
-            'image list --tag ' + self.image_tag + ' --long -f json'
+            'image list --tag ' + self.image_tag + ' --tag ' +
+            self.image_tag1 + ' --long -f json'
         ))
         for taglist in [img['Tags'] for img in json_output]:
             self.assertIn(
                 self.image_tag,
                 taglist
             )
+            self.assertIn(
+                self.image_tag1,
+                taglist
+            )
 
     def test_image_attributes(self):
         """Test set, unset, show on attributes, tags and properties"""
diff --git a/openstackclient/tests/unit/image/v2/test_image.py b/openstackclient/tests/unit/image/v2/test_image.py
@@ -835,15 +835,16 @@ def test_image_list_hidden_option(self):
     def test_image_list_tag_option(self):
         arglist = [
             '--tag', 'abc',
+            '--tag', 'cba'
         ]
         verifylist = [
-            ('tag', 'abc'),
+            ('tag', ['abc', 'cba']),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
         self.client.images.assert_called_with(
-            tag='abc'
+            tag=['abc', 'cba']
         )
 
 
diff --git a/releasenotes/notes/image-list-multiple-tags-a394799c7807f031.yaml b/releasenotes/notes/image-list-multiple-tags-a394799c7807f031.yaml
@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    The ``image list`` now accepts multiple ``--tag`` options, allowing you to
+    filter images on more than one tag.

Original file line number	Diff line number	Diff line change
`@@ -835,15 +835,16 @@ def test_image_list_hidden_option(self):`
`835`	`835`	`def test_image_list_tag_option(self):`
`836`	`836`	`arglist = [`
`837`	`837`	`'--tag', 'abc',`
	`838`	`+ '--tag', 'cba'`
`838`	`839`	`]`
`839`	`840`	`verifylist = [`
`840`		`- ('tag', 'abc'),`
	`841`	`+ ('tag', ['abc', 'cba']),`
`841`	`842`	`]`
`842`	`843`	`parsed_args = self.check_parser(self.cmd, arglist, verifylist)`
`843`	`844`
`844`	`845`	`columns, data = self.cmd.take_action(parsed_args)`
`845`	`846`	`self.client.images.assert_called_with(`
`846`		`- tag='abc'`
	`847`	`+ tag=['abc', 'cba']`
`847`	`848`	`)`
`848`	`849`
`849`	`850`