volume: Remove duplication from 'consistency group create' opts

stephenfin · stephenfin · commit 4106926fa656 · 2023-02-14T16:42:22.000Z
The '--consistency-group-source' and '--consistency-group-snapshot' opts
are unnecessarily verbose. Shorten them to '--source' and '--snapshot',
respectively, maintaining aliases to avoid breaking users.

Change-Id: I2b6656a8a09d953eb4406f1d4fd1e804743a8963
Signed-off-by: Stephen Finucane &lt;sfinucan@redhat.com&gt;
diff --git a/openstackclient/tests/unit/volume/v2/test_consistency_group.py b/openstackclient/tests/unit/volume/v2/test_consistency_group.py
@@ -257,7 +257,7 @@ def test_consistency_group_create_from_source(self):
             self.new_consistency_group.name,
         ]
         verifylist = [
-            ('consistency_group_source', self.new_consistency_group.id),
+            ('source', self.new_consistency_group.id),
             ('description', self.new_consistency_group.description),
             ('name', self.new_consistency_group.name),
         ]
@@ -285,7 +285,7 @@ def test_consistency_group_create_from_snapshot(self):
             self.new_consistency_group.name,
         ]
         verifylist = [
-            ('consistency_group_snapshot', self.consistency_group_snapshot.id),
+            ('snapshot', self.consistency_group_snapshot.id),
             ('description', self.new_consistency_group.description),
             ('name', self.new_consistency_group.name),
         ]
diff --git a/openstackclient/volume/v2/consistency_group.py b/openstackclient/volume/v2/consistency_group.py
@@ -14,6 +14,7 @@
 
 """Volume v2 consistency group action implementations"""
 
+import argparse
 import logging
 
 from osc_lib.cli import format_columns
@@ -90,35 +91,51 @@ def get_parser(self, prog_name):
             "name",
             metavar="<name>",
             nargs="?",
-            help=_("Name of new consistency group (default to None)")
+            help=_("Name of new consistency group (default to None)"),
         )
         exclusive_group = parser.add_mutually_exclusive_group(required=True)
         exclusive_group.add_argument(
             "--volume-type",
             metavar="<volume-type>",
-            help=_("Volume type of this consistency group (name or ID)")
+            help=_("Volume type of this consistency group (name or ID)"),
         )
+        exclusive_group.add_argument(
+            "--source",
+            metavar="<consistency-group>",
+            help=_("Existing consistency group (name or ID)"),
+        )
+        # NOTE(stephenfin): Legacy alias
         exclusive_group.add_argument(
             "--consistency-group-source",
             metavar="<consistency-group>",
-            help=_("Existing consistency group (name or ID)")
+            dest='source',
+            help=argparse.SUPPRESS,
+        )
+        exclusive_group.add_argument(
+            "--snapshot",
+            metavar="<consistency-group-snapshot>",
+            help=_("Existing consistency group snapshot (name or ID)"),
         )
+        # NOTE(stephenfin): Legacy alias
         exclusive_group.add_argument(
             "--consistency-group-snapshot",
             metavar="<consistency-group-snapshot>",
-            help=_("Existing consistency group snapshot (name or ID)")
+            dest='snapshot',
+            help=argparse.SUPPRESS,
         )
         parser.add_argument(
             "--description",
             metavar="<description>",
-            help=_("Description of this consistency group")
+            help=_("Description of this consistency group"),
         )
         parser.add_argument(
             "--availability-zone",
             metavar="<availability-zone>",
-            help=_("Availability zone for this consistency group "
-                   "(not available if creating consistency group "
-                   "from source)"),
+            help=_(
+                "Availability zone for this consistency group "
+                "(not available if creating consistency group "
+                "from source)"
+            ),
         )
         return parser
 
@@ -142,21 +159,23 @@ def take_action(self, parsed_args):
 
             consistency_group_id = None
             consistency_group_snapshot = None
-            if parsed_args.consistency_group_source:
+            if parsed_args.source:
                 consistency_group_id = utils.find_resource(
                     volume_client.consistencygroups,
-                    parsed_args.consistency_group_source).id
-            elif parsed_args.consistency_group_snapshot:
+                    parsed_args.source,
+                ).id
+            elif parsed_args.snapshot:
                 consistency_group_snapshot = utils.find_resource(
                     volume_client.cgsnapshots,
-                    parsed_args.consistency_group_snapshot).id
+                    parsed_args.snapshot,
+                ).id
 
             consistency_group = (
                 volume_client.consistencygroups.create_from_src(
                     consistency_group_snapshot,
                     consistency_group_id,
                     name=parsed_args.name,
-                    description=parsed_args.description
+                    description=parsed_args.description,
                 )
             )
 
diff --git a/releasenotes/notes/consistency-group-create-opts-aliases-e1c2f1498e9b1d3d.yaml b/releasenotes/notes/consistency-group-create-opts-aliases-e1c2f1498e9b1d3d.yaml
@@ -0,0 +1,7 @@
+---
+upgrade:
+  - |
+    The ``--consistency-group-source`` and ``--consistency-group-snapshot``
+    options for the ``consistency group create`` command have been renamed to
+    ``--source`` and ``--snapshot``, respectively. Aliases are provided for the
+    older variants.

Original file line number	Diff line number	Diff line change
`@@ -257,7 +257,7 @@ def test_consistency_group_create_from_source(self):`
`257`	`257`	`self.new_consistency_group.name,`
`258`	`258`	`]`
`259`	`259`	`verifylist = [`
`260`		`- ('consistency_group_source', self.new_consistency_group.id),`
	`260`	`+ ('source', self.new_consistency_group.id),`
`261`	`261`	`('description', self.new_consistency_group.description),`
`262`	`262`	`('name', self.new_consistency_group.name),`
`263`	`263`	`]`
`@@ -285,7 +285,7 @@ def test_consistency_group_create_from_snapshot(self):`
`285`	`285`	`self.new_consistency_group.name,`
`286`	`286`	`]`
`287`	`287`	`verifylist = [`
`288`		`- ('consistency_group_snapshot', self.consistency_group_snapshot.id),`
	`288`	`+ ('snapshot', self.consistency_group_snapshot.id),`
`289`	`289`	`('description', self.new_consistency_group.description),`
`290`	`290`	`('name', self.new_consistency_group.name),`
`291`	`291`	`]`