image: Fix the default description of image visibility

mmizuma · stephenfin · stephenfin · commit a3730afe2e24 · 2023-11-08T10:41:07.000Z
The default image visibility was changed to 'shared' in API v2.5. Fix
the help information of image visibility, centralizing options in the
process.

Change-Id: Ib3017fc4f618c1e14e3b26b616ff9374d0e24eaa
Co-authored-by: Stephen Finucane &lt;stephenfin@redhat.com&gt;
diff --git a/openstackclient/image/v2/image.py b/openstackclient/image/v2/image.py
@@ -163,6 +163,67 @@ def get_data_from_stdin():
         return None
 
 
+def _add_is_protected_args(parser):
+    protected_group = parser.add_mutually_exclusive_group()
+    protected_group.add_argument(
+        "--protected",
+        action="store_true",
+        dest="is_protected",
+        default=None,
+        help=_("Prevent image from being deleted"),
+    )
+    protected_group.add_argument(
+        "--unprotected",
+        action="store_false",
+        dest="is_protected",
+        default=None,
+        help=_("Allow image to be deleted (default)"),
+    )
+
+
+def _add_visibility_args(parser):
+    public_group = parser.add_mutually_exclusive_group()
+    public_group.add_argument(
+        "--public",
+        action="store_const",
+        const="public",
+        dest="visibility",
+        help=_("Image is accessible and visisble to all users"),
+    )
+    public_group.add_argument(
+        "--private",
+        action="store_const",
+        const="private",
+        dest="visibility",
+        help=_(
+            "Image is only accessible by the owner "
+            "(default until --os-image-api-version 2.5)"
+        ),
+    )
+    public_group.add_argument(
+        "--community",
+        action="store_const",
+        const="community",
+        dest="visibility",
+        help=_(
+            "Image is accessible by all users but does not appear in the "
+            "default image list of any user except the owner "
+            "(requires --os-image-api-version 2.5 or later)"
+        ),
+    )
+    public_group.add_argument(
+        "--shared",
+        action="store_const",
+        const="shared",
+        dest="visibility",
+        help=_(
+            "Image is only accessible by the owner and image members "
+            "(requires --os-image-api-version 2.5 or later) "
+            "(default since --os-image-api-version 2.5)"
+        ),
+    )
+
+
 class AddProjectToImage(command.ShowOne):
     _description = _("Associate project with image")
 
@@ -322,50 +383,8 @@ def get_parser(self, prog_name):
                 "Only use in combination with --sign-key-path"
             ),
         )
-        protected_group = parser.add_mutually_exclusive_group()
-        protected_group.add_argument(
-            "--protected",
-            action="store_true",
-            dest="is_protected",
-            default=None,
-            help=_("Prevent image from being deleted"),
-        )
-        protected_group.add_argument(
-            "--unprotected",
-            action="store_false",
-            dest="is_protected",
-            default=None,
-            help=_("Allow image to be deleted (default)"),
-        )
-        public_group = parser.add_mutually_exclusive_group()
-        public_group.add_argument(
-            "--public",
-            action="store_const",
-            const="public",
-            dest="visibility",
-            help=_("Image is accessible to the public"),
-        )
-        public_group.add_argument(
-            "--private",
-            action="store_const",
-            const="private",
-            dest="visibility",
-            help=_("Image is inaccessible to the public (default)"),
-        )
-        public_group.add_argument(
-            "--community",
-            action="store_const",
-            const="community",
-            dest="visibility",
-            help=_("Image is accessible to the community"),
-        )
-        public_group.add_argument(
-            "--shared",
-            action="store_const",
-            const="shared",
-            dest="visibility",
-            help=_("Image can be shared"),
-        )
+        _add_is_protected_args(parser)
+        _add_visibility_args(parser)
         parser.add_argument(
             "--property",
             dest="properties",
@@ -726,14 +745,20 @@ def get_parser(self, prog_name):
             action="store_const",
             const="community",
             dest="visibility",
-            help=_("List only community images"),
+            help=_(
+                "List only community images "
+                "(requires --os-image-api-version 2.5 or later)"
+            ),
         )
         public_group.add_argument(
             "--shared",
             action="store_const",
             const="shared",
             dest="visibility",
-            help=_("List only shared images"),
+            help=_(
+                "List only shared images "
+                "(requires --os-image-api-version 2.5 or later)"
+            ),
         )
         public_group.add_argument(
             "--all",
@@ -1073,50 +1098,8 @@ def get_parser(self, prog_name):
             help=_("Image disk format. The supported options are: %s")
             % ', '.join(DISK_CHOICES),
         )
-        protected_group = parser.add_mutually_exclusive_group()
-        protected_group.add_argument(
-            "--protected",
-            action="store_true",
-            dest="is_protected",
-            default=None,
-            help=_("Prevent image from being deleted"),
-        )
-        protected_group.add_argument(
-            "--unprotected",
-            action="store_false",
-            dest="is_protected",
-            default=None,
-            help=_("Allow image to be deleted (default)"),
-        )
-        public_group = parser.add_mutually_exclusive_group()
-        public_group.add_argument(
-            "--public",
-            action="store_const",
-            const="public",
-            dest="visibility",
-            help=_("Image is accessible to the public"),
-        )
-        public_group.add_argument(
-            "--private",
-            action="store_const",
-            const="private",
-            dest="visibility",
-            help=_("Image is inaccessible to the public (default)"),
-        )
-        public_group.add_argument(
-            "--community",
-            action="store_const",
-            const="community",
-            dest="visibility",
-            help=_("Image is accessible to the community"),
-        )
-        public_group.add_argument(
-            "--shared",
-            action="store_const",
-            const="shared",
-            dest="visibility",
-            help=_("Image can be shared"),
-        )
+        _add_is_protected_args(parser)
+        _add_visibility_args(parser)
         parser.add_argument(
             "--property",
             dest="properties",
