Implements hide image

openstack image set [--hidden|--unhidden] IMAGE
openstack image list --hidden

Task: 41734
Story: 2008581
Change-Id: Ie84f10c0f7aa2e7b7f78bfadc70132a10673866e

Author: valerytschopp

openstackclient/image/v2/image.py

@@ -615,6 +615,12 @@ def get_parser(self, prog_name):
             default=None,
             help=_('Filter images based on tag.'),
         )
+        parser.add_argument(
+            '--hidden',
+            action='store_true',
+            default=False,
+            help=_('List hidden images'),
+        )
         parser.add_argument(
             '--long',
             action='store_true',
@@ -686,6 +692,8 @@ def take_action(self, parsed_args):
                 parsed_args.project_domain,
             ).id
             kwargs['owner'] = project_id
+        if parsed_args.hidden:
+            kwargs['is_hidden'] = True
         if parsed_args.long:
             columns = (
                 'ID',
@@ -1016,6 +1024,22 @@ def get_parser(self, prog_name):
             action="store_true",
             help=_("Reset the image membership to 'pending'"),
         )
+
+        hidden_group = parser.add_mutually_exclusive_group()
+        hidden_group.add_argument(
+            "--hidden",
+            dest='hidden',
+            default=None,
+            action="store_true",
+            help=_("Hide the image"),
+        )
+        hidden_group.add_argument(
+            "--unhidden",
+            dest='hidden',
+            default=None,
+            action="store_false",
+            help=_("Unhide the image"),
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -1106,6 +1130,9 @@ def take_action(self, parsed_args):
             # Tags should be extended, but duplicates removed
             kwargs['tags'] = list(set(image.tags).union(set(parsed_args.tags)))
 
+        if parsed_args.hidden is not None:
+            kwargs['is_hidden'] = parsed_args.hidden
+
         try:
             image = image_client.update_image(image.id, **kwargs)
         except Exception:

openstackclient/tests/unit/image/v2/test_image.py

@@ -837,6 +837,20 @@ def test_image_list_status_option(self):
             status='active'
         )
 
+    def test_image_list_hidden_option(self):
+        arglist = [
+            '--hidden',
+        ]
+        verifylist = [
+            ('hidden', True),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+        self.client.images.assert_called_with(
+            is_hidden=True
+        )
+
     def test_image_list_tag_option(self):
         arglist = [
             '--tag', 'abc',
@@ -1439,6 +1453,60 @@ def test_image_set_numeric_options_to_zero(self):
         )
         self.assertIsNone(result)
 
+    def test_image_set_hidden(self):
+        arglist = [
+            '--hidden',
+            '--public',
+            image_fakes.image_name,
+        ]
+        verifylist = [
+            ('hidden', True),
+            ('public', True),
+            ('private', False),
+            ('image', image_fakes.image_name),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+
+        kwargs = {
+            'is_hidden': True,
+            'visibility': 'public',
+        }
+        # ImageManager.update(image, **kwargs)
+        self.client.update_image.assert_called_with(
+            self._image.id,
+            **kwargs
+        )
+        self.assertIsNone(result)
+
+    def test_image_set_unhidden(self):
+        arglist = [
+            '--unhidden',
+            '--public',
+            image_fakes.image_name,
+        ]
+        verifylist = [
+            ('hidden', False),
+            ('public', True),
+            ('private', False),
+            ('image', image_fakes.image_name),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+
+        kwargs = {
+            'is_hidden': False,
+            'visibility': 'public',
+        }
+        # ImageManager.update(image, **kwargs)
+        self.client.update_image.assert_called_with(
+            self._image.id,
+            **kwargs
+        )
+        self.assertIsNone(result)
+
 
 class TestImageShow(TestImage):
 

releasenotes/notes/implements-hide-image-4c726a61c336ebaa.yaml

@@ -0,0 +1,8 @@
+---
+features:
+  - |
+    Add mutually exclusive options ``--hidden`` and ``--unhidden`` to
+    ``image set`` command to hide or unhide an image (``is_hidden``
+    attribute).
+  - |
+    Add option ``--hidden`` to ``image list`` command to list hidden images.