Update container format choices

Brian Rosmaita · stevemar · commit 80c62021c829 · 2017-01-23T23:04:49.000-05:00
The choices for valid container formats is out of date in the
image v1 and v2 help text.  This patch adds 'ova' and 'docker'
and does some minor refactoring to align the container_format
option with the disk_format option.

Change-Id: Icdea5fab801abd651baf45cf96c920c7df79f11b
Closes-bug: #1658138
diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst
@@ -76,7 +76,8 @@ Create/upload an image
 
 .. option:: --container-format <container-format>
 
-    Image container format (default: bare)
+    Image container format. The supported options are: ami, ari, aki,
+    bare, docker, ova, ovf. The default format is: bare
 
 .. option:: --disk-format <disk-format>
 
@@ -342,7 +343,8 @@ Set image properties
 
 .. option:: --container-format <container-format>
 
-    Image container format (default: bare)
+    Image container format. The supported options are: ami, ari, aki,
+    bare, docker, ova, ovf.
 
 .. option:: --disk-format <disk-format>
 
diff --git a/openstackclient/image/v1/image.py b/openstackclient/image/v1/image.py
@@ -36,6 +36,7 @@
 from openstackclient.i18n import _
 
 
+CONTAINER_CHOICES = ["ami", "ari", "aki", "bare", "docker", "ova", "ovf"]
 DEFAULT_CONTAINER_FORMAT = 'bare'
 DEFAULT_DISK_FORMAT = 'raw'
 DISK_CHOICES = ["ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vhdx",
@@ -84,8 +85,12 @@ def get_parser(self, prog_name):
             "--container-format",
             default=DEFAULT_CONTAINER_FORMAT,
             metavar="<container-format>",
-            help=_("Image container format "
-                   "(default: %s)") % DEFAULT_CONTAINER_FORMAT,
+            choices=CONTAINER_CHOICES,
+            help=(_("Image container format. "
+                    "The supported options are: %(option_list)s. "
+                    "The default format is: %(default_opt)s") %
+                  {'option_list': ', '.join(CONTAINER_CHOICES),
+                   'default_opt': DEFAULT_CONTAINER_FORMAT})
         )
         parser.add_argument(
             "--disk-format",
@@ -498,13 +503,12 @@ def get_parser(self, prog_name):
             type=int,
             help=_("Minimum RAM size needed to boot image, in megabytes"),
         )
-        container_choices = ["ami", "ari", "aki", "bare", "ovf"]
         parser.add_argument(
             "--container-format",
             metavar="<container-format>",
-            help=_("Container format of image. Acceptable formats: %s") %
-            container_choices,
-            choices=container_choices
+            choices=CONTAINER_CHOICES,
+            help=_("Image container format. The supported options are: %s") %
+            ', '.join(CONTAINER_CHOICES)
         )
         parser.add_argument(
             "--disk-format",
diff --git a/openstackclient/image/v2/image.py b/openstackclient/image/v2/image.py
@@ -30,6 +30,7 @@
 from openstackclient.identity import common
 
 
+CONTAINER_CHOICES = ["ami", "ari", "aki", "bare", "docker", "ova", "ovf"]
 DEFAULT_CONTAINER_FORMAT = 'bare'
 DEFAULT_DISK_FORMAT = 'raw'
 DISK_CHOICES = ["ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vhdx",
@@ -135,9 +136,13 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "--container-format",
             default=DEFAULT_CONTAINER_FORMAT,
+            choices=CONTAINER_CHOICES,
             metavar="<container-format>",
-            help=_("Image container format "
-                   "(default: %s)") % DEFAULT_CONTAINER_FORMAT,
+            help=(_("Image container format. "
+                    "The supported options are: %(option_list)s. "
+                    "The default format is: %(default_opt)s") %
+                  {'option_list': ', '.join(CONTAINER_CHOICES),
+                   'default_opt': DEFAULT_CONTAINER_FORMAT})
         )
         parser.add_argument(
             "--disk-format",
@@ -659,8 +664,9 @@ def get_parser(self, prog_name):
         parser.add_argument(
             "--container-format",
             metavar="<container-format>",
-            help=_("Image container format "
-                   "(default: %s)") % DEFAULT_CONTAINER_FORMAT,
+            choices=CONTAINER_CHOICES,
+            help=_("Image container format. The supported options are: %s") %
+            ', '.join(CONTAINER_CHOICES)
         )
         parser.add_argument(
             "--disk-format",
