clean up image choices and help text

Use choices for image set and image create commands, this aligns
with our use of choices in networking commands.

Also update the help text to match that of the networking
commands, where we iterate through the options.

Related-Bug: 1635518
Change-Id: Ib4c66b06e07f1d4e5bfe1b74053f2215cccad890

Author: stevemar

doc/source/command-objects/image.rst

@@ -78,7 +78,8 @@ Create/upload an image
 
 .. option:: --disk-format <disk-format>
 
-    Image disk format (default: raw)
+    Image disk format. The supported options are: ami, ari, aki, vhd, vmdk,
+    raw, qcow2, vhdx, vdi, and iso. The default format is: raw
 
 .. option:: --size <size>
 
@@ -337,7 +338,8 @@ Set image properties
 
 .. option:: --disk-format <disk-format>
 
-    Image disk format (default: raw)
+    Image disk format. The supported options are: ami, ari, aki, vhd, vmdk,
+    raw, qcow2, vhdx, vdi, and iso.
 
 .. option:: --size <size>
 

openstackclient/image/v1/image.py

@@ -38,6 +38,8 @@
 
 DEFAULT_CONTAINER_FORMAT = 'bare'
 DEFAULT_DISK_FORMAT = 'raw'
+DISK_CHOICES = ["ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vhdx",
+                "vdi", "iso"]
 
 
 LOG = logging.getLogger(__name__)
@@ -89,8 +91,9 @@ def get_parser(self, prog_name):
             "--disk-format",
             default=DEFAULT_DISK_FORMAT,
             metavar="<disk-format>",
-            help=_("Image disk format "
-                   "(default: %s)") % DEFAULT_DISK_FORMAT,
+            choices=DISK_CHOICES,
+            help=_("Image disk format. The supported options are: %s. "
+                   "The default format is: raw") % ', '.join(DISK_CHOICES)
         )
         parser.add_argument(
             "--size",
@@ -502,14 +505,12 @@ def get_parser(self, prog_name):
             container_choices,
             choices=container_choices
         )
-        disk_choices = ["ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2",
-                        "vhdx", "vdi", "iso"]
         parser.add_argument(
             "--disk-format",
             metavar="<disk-format>",
-            help=_("Disk format of image. Acceptable formats: %s") %
-            disk_choices,
-            choices=disk_choices
+            choices=DISK_CHOICES,
+            help=_("Image disk format. The supported options are: %s.") %
+            ', '.join(DISK_CHOICES)
         )
         parser.add_argument(
             "--size",

openstackclient/image/v2/image.py

@@ -32,6 +32,8 @@
 
 DEFAULT_CONTAINER_FORMAT = 'bare'
 DEFAULT_DISK_FORMAT = 'raw'
+DISK_CHOICES = ["ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vhdx",
+                "vdi", "iso"]
 
 
 LOG = logging.getLogger(__name__)
@@ -140,9 +142,10 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "--disk-format",
             default=DEFAULT_DISK_FORMAT,
+            choices=DISK_CHOICES,
             metavar="<disk-format>",
-            help=_("Image disk format "
-                   "(default: %s)") % DEFAULT_DISK_FORMAT,
+            help=_("Image disk format. The supported options are: %s. "
+                   "The default format is: raw") % ', '.join(DISK_CHOICES)
         )
         parser.add_argument(
             "--min-disk",
@@ -650,8 +653,9 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "--disk-format",
             metavar="<disk-format>",
-            help=_("Image disk format "
-                   "(default: %s)") % DEFAULT_DISK_FORMAT,
+            choices=DISK_CHOICES,
+            help=_("Image disk format. The supported options are: %s") %
+            ', '.join(DISK_CHOICES)
         )
         protected_group = parser.add_mutually_exclusive_group()
         protected_group.add_argument(

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

@@ -116,7 +116,7 @@ def test_image_reserve_options(self):
         self.images_mock.configure_mock(**mock_exception)
         arglist = [
             '--container-format', 'ovf',
-            '--disk-format', 'fs',
+            '--disk-format', 'ami',
             '--min-disk', '10',
             '--min-ram', '4',
             '--protected',
@@ -126,7 +126,7 @@ def test_image_reserve_options(self):
         ]
         verifylist = [
             ('container_format', 'ovf'),
-            ('disk_format', 'fs'),
+            ('disk_format', 'ami'),
             ('min_disk', 10),
             ('min_ram', 4),
             ('protected', True),
@@ -147,7 +147,7 @@ def test_image_reserve_options(self):
         self.images_mock.create.assert_called_with(
             name=self.new_image.name,
             container_format='ovf',
-            disk_format='fs',
+            disk_format='ami',
             min_disk=10,
             min_ram=4,
             protected=True,

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

@@ -130,7 +130,7 @@ def test_image_reserve_options(self, mock_open):
         self.images_mock.configure_mock(**mock_exception)
         arglist = [
             '--container-format', 'ovf',
-            '--disk-format', 'fs',
+            '--disk-format', 'ami',
             '--min-disk', '10',
             '--min-ram', '4',
             ('--protected'
@@ -143,7 +143,7 @@ def test_image_reserve_options(self, mock_open):
         ]
         verifylist = [
             ('container_format', 'ovf'),
-            ('disk_format', 'fs'),
+            ('disk_format', 'ami'),
             ('min_disk', 10),
             ('min_ram', 4),
             ('protected', self.new_image.protected),
@@ -165,7 +165,7 @@ def test_image_reserve_options(self, mock_open):
         self.images_mock.create.assert_called_with(
             name=self.new_image.name,
             container_format='ovf',
-            disk_format='fs',
+            disk_format='ami',
             min_disk=10,
             min_ram=4,
             owner=self.project.id,
@@ -193,7 +193,7 @@ def test_image_create_with_unexist_owner(self):
 
         arglist = [
             '--container-format', 'ovf',
-            '--disk-format', 'fs',
+            '--disk-format', 'ami',
             '--min-disk', '10',
             '--min-ram', '4',
             '--owner', 'unexist_owner',
@@ -203,7 +203,7 @@ def test_image_create_with_unexist_owner(self):
         ]
         verifylist = [
             ('container_format', 'ovf'),
-            ('disk_format', 'fs'),
+            ('disk_format', 'ami'),
             ('min_disk', 10),
             ('min_ram', 4),
             ('owner', 'unexist_owner'),
@@ -227,7 +227,7 @@ def test_image_create_with_unexist_project(self):
 
         arglist = [
             '--container-format', 'ovf',
-            '--disk-format', 'fs',
+            '--disk-format', 'ami',
             '--min-disk', '10',
             '--min-ram', '4',
             '--protected',
@@ -237,7 +237,7 @@ def test_image_create_with_unexist_project(self):
         ]
         verifylist = [
             ('container_format', 'ovf'),
-            ('disk_format', 'fs'),
+            ('disk_format', 'ami'),
             ('min_disk', 10),
             ('min_ram', 4),
             ('protected', True),