Add commands for "consistency group snapshot"

Add commands:
    consistency group snapshot create
    consistency group snapshot delete
    consistency group snapshot list
    consistency group snapshot show
in volume v2 (v2 only)

Change-Id: Ib4115f8ff00fb5aa8194588223032657eb1346b5
Closes-Bug: #1642238
Implements: bp cinder-command-support

1 files changed, 190 insertions, 0 deletions

diff --git a/openstackclient/volume/v2/consistency_group_snapshot.py b/openstackclient/volume/v2/consistency_group_snapshot.py
new file mode 100644
index 00000000..540deb01
--- /dev/null
+++ b/openstackclient/volume/v2/consistency_group_snapshot.py
@@ -0,0 +1,190 @@
+#
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+#
+
+"""Volume v2 consistency group snapshot action implementations"""
+
+import logging
+
+from osc_lib.command import command
+from osc_lib import exceptions
+from osc_lib import utils
+import six
+
+from openstackclient.i18n import _
+
+
+LOG = logging.getLogger(__name__)
+
+
+class CreateConsistencyGroupSnapshot(command.ShowOne):
+    _description = _("Create new consistency group snapshot.")
+
+    def get_parser(self, prog_name):
+        parser = super(
+            CreateConsistencyGroupSnapshot, self).get_parser(prog_name)
+        parser.add_argument(
+            "snapshot_name",
+            metavar="<snapshot-name>",
+            nargs="?",
+            help=_("Name of new consistency group snapshot (default to None)")
+        )
+        parser.add_argument(
+            "--consistency-group",
+            metavar="<consistency-group>",
+            help=_("Consistency group to snapshot (name or ID) "
+                   "(default to be the same as <snapshot-name>)")
+        )
+        parser.add_argument(
+            "--description",
+            metavar="<description>",
+            help=_("Description of this consistency group snapshot")
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        volume_client = self.app.client_manager.volume
+        consistency_group = parsed_args.consistency_group
+        if not parsed_args.consistency_group:
+            # If "--consistency-group" not specified, then consistency_group
+            # will be the same as the new consistency group snapshot name
+            consistency_group = parsed_args.snapshot_name
+        consistency_group_id = utils.find_resource(
+            volume_client.consistencygroups,
+            consistency_group).id
+        consistency_group_snapshot = volume_client.cgsnapshots.create(
+            consistency_group_id,
+            name=parsed_args.snapshot_name,
+            description=parsed_args.description,
+        )
+
+        return zip(*sorted(six.iteritems(consistency_group_snapshot._info)))
+
+
+class DeleteConsistencyGroupSnapshot(command.Command):
+    _description = _("Delete consistency group snapshot(s).")
+
+    def get_parser(self, prog_name):
+        parser = super(
+            DeleteConsistencyGroupSnapshot, self).get_parser(prog_name)
+        parser.add_argument(
+            "consistency_group_snapshot",
+            metavar="<consistency-group-snapshot>",
+            nargs="+",
+            help=_("Consistency group snapshot(s) to delete (name or ID)")
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        volume_client = self.app.client_manager.volume
+        result = 0
+
+        for snapshot in parsed_args.consistency_group_snapshot:
+            try:
+                snapshot_id = utils.find_resource(volume_client.cgsnapshots,
+                                                  snapshot).id
+
+                volume_client.cgsnapshots.delete(snapshot_id)
+            except Exception as e:
+                result += 1
+                LOG.error(_("Failed to delete consistency group snapshot "
+                            "with name or ID '%(snapshot)s': %(e)s")
+                          % {'snapshot': snapshot, 'e': e})
+
+        if result > 0:
+            total = len(parsed_args.consistency_group_snapshot)
+            msg = (_("%(result)s of %(total)s consistency group snapshots "
+                   "failed to delete.") % {'result': result, 'total': total})
+            raise exceptions.CommandError(msg)
+
+
+class ListConsistencyGroupSnapshot(command.Lister):
+    _description = _("List consistency group snapshots.")
+
+    def get_parser(self, prog_name):
+        parser = super(
+            ListConsistencyGroupSnapshot, self).get_parser(prog_name)
+        parser.add_argument(
+            '--all-projects',
+            action="store_true",
+            help=_('Show detail for all projects (admin only) '
+                   '(defaults to False)')
+        )
+        parser.add_argument(
+            '--long',
+            action="store_true",
+            help=_('List additional fields in output')
+        )
+        parser.add_argument(
+            '--status',
+            metavar="<status>",
+            choices=['available', 'error', 'creating', 'deleting',
+                     'error-deleting'],
+            help=_('Filters results by a status ("available", "error", '
+                   '"creating", "deleting" or "error_deleting")')
+        )
+        parser.add_argument(
+            '--consistency-group',
+            metavar="<consistency-group>",
+            help=_('Filters results by a consistency group (name or ID)')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        if parsed_args.long:
+            columns = ['ID', 'Status', 'ConsistencyGroup ID',
+                       'Name', 'Description', 'Created At']
+        else:
+            columns = ['ID', 'Status', 'Name']
+        volume_client = self.app.client_manager.volume
+        consistency_group_id = None
+        if parsed_args.consistency_group:
+            consistency_group_id = utils.find_resource(
+                volume_client.consistencygroups,
+                parsed_args.consistency_group,
+            ).id
+        search_opts = {
+            'all_tenants': parsed_args.all_projects,
+            'status': parsed_args.status,
+            'consistencygroup_id': consistency_group_id,
+        }
+        consistency_group_snapshots = volume_client.cgsnapshots.list(
+            detailed=True,
+            search_opts=search_opts,
+        )
+
+        return (columns, (
+            utils.get_item_properties(
+                s, columns)
+            for s in consistency_group_snapshots))
+
+
+class ShowConsistencyGroupSnapshot(command.ShowOne):
+    _description = _("Display consistency group snapshot details")
+
+    def get_parser(self, prog_name):
+        parser = super(
+            ShowConsistencyGroupSnapshot, self).get_parser(prog_name)
+        parser.add_argument(
+            "consistency_group_snapshot",
+            metavar="<consistency-group-snapshot>",
+            help=_("Consistency group snapshot to display (name or ID)")
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        volume_client = self.app.client_manager.volume
+        consistency_group_snapshot = utils.find_resource(
+            volume_client.cgsnapshots,
+            parsed_args.consistency_group_snapshot)
+        return zip(*sorted(six.iteritems(consistency_group_snapshot._info)))