Add support for volume snapshot v2 command

openstack snapshot create
openstack snapshot set
openstack snapshot unset
openstack snapshot list

Implements: blueprint volume-v2
Change-Id: Ia1d9f4426baa0099281a9931f4eec99ebe1969b1

1 files changed, 203 insertions, 2 deletions

diff --git a/openstackclient/volume/v2/snapshot.py b/openstackclient/volume/v2/snapshot.py
index a6b02b63..4370cdeb 100644
--- a/openstackclient/volume/v2/snapshot.py
+++ b/openstackclient/volume/v2/snapshot.py
@@ -14,15 +14,67 @@
 
 """Volume v2 snapshot action implementations"""
 
+import copy
 import logging
 
 from cliff import command
+from cliff import lister
 from cliff import show
 import six
 
+from openstackclient.common import parseractions
 from openstackclient.common import utils
 
 
+class CreateSnapshot(show.ShowOne):
+    """Create new snapshot"""
+
+    log = logging.getLogger(__name__ + ".CreateSnapshot")
+
+    def get_parser(self, prog_name):
+        parser = super(CreateSnapshot, self).get_parser(prog_name)
+        parser.add_argument(
+            "volume",
+            metavar="<volume>",
+            help="Volume to snapshot (name or ID)"
+        )
+        parser.add_argument(
+            "--name",
+            metavar="<name>",
+            required=True,
+            help="Name of the snapshot"
+        )
+        parser.add_argument(
+            "--description",
+            metavar="<description>",
+            help="Description of the snapshot"
+        )
+        parser.add_argument(
+            "--force",
+            dest="force",
+            action="store_true",
+            default=False,
+            help="Create a snapshot attached to an instance. Default is False"
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action: (%s)", parsed_args)
+        volume_client = self.app.client_manager.volume
+        volume_id = utils.find_resource(
+            volume_client.volumes, parsed_args.volume).id
+        snapshot = volume_client.volume_snapshots.create(
+            volume_id,
+            force=parsed_args.force,
+            name=parsed_args.name,
+            description=parsed_args.description
+        )
+        snapshot._info.update(
+            {'properties': utils.format_dict(snapshot._info.pop('metadata'))}
+        )
+        return zip(*sorted(six.iteritems(snapshot._info)))
+
+
 class DeleteSnapshot(command.Command):
     """Delete volume snapshot(s)"""
 
@@ -34,7 +86,7 @@ class DeleteSnapshot(command.Command):
             "snapshots",
             metavar="<snapshot>",
             nargs="+",
-            help="Snapsho(s) to delete (name or ID)"
+            help="Snapshot(s) to delete (name or ID)"
         )
         return parser
 
@@ -48,6 +100,115 @@ class DeleteSnapshot(command.Command):
         return
 
 
+class ListSnapshot(lister.Lister):
+    """List snapshots"""
+
+    log = logging.getLogger(__name__ + ".ListSnapshot")
+
+    def get_parser(self, prog_name):
+        parser = super(ListSnapshot, self).get_parser(prog_name)
+        parser.add_argument(
+            '--long',
+            action='store_true',
+            default=False,
+            help='List additional fields in output',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action: (%s)", parsed_args)
+
+        def _format_volume_id(volume_id):
+            """Return a volume name if available
+
+            :param volume_id: a volume ID
+            :rtype: either the volume ID or name
+            """
+
+            volume = volume_id
+            if volume_id in volume_cache.keys():
+                volume = volume_cache[volume_id].name
+            return volume
+
+        if parsed_args.long:
+            columns = ['ID', 'Name', 'Description', 'Status',
+                       'Size', 'Created At', 'Volume ID', 'Metadata']
+            column_headers = copy.deepcopy(columns)
+            column_headers[6] = 'Volume'
+            column_headers[7] = 'Properties'
+        else:
+            columns = ['ID', 'Name', 'Description', 'Status', 'Size']
+            column_headers = copy.deepcopy(columns)
+
+        # Cache the volume list
+        volume_cache = {}
+        try:
+            for s in self.app.client_manager.volume.volumes.list():
+                volume_cache[s.id] = s
+        except Exception:
+            # Just forget it if there's any trouble
+            pass
+
+        data = self.app.client_manager.volume.volume_snapshots.list()
+        return (column_headers,
+                (utils.get_item_properties(
+                    s, columns,
+                    formatters={'Metadata': utils.format_dict,
+                                'Volume ID': _format_volume_id},
+                ) for s in data))
+
+
+class SetSnapshot(command.Command):
+    """Set snapshot properties"""
+
+    log = logging.getLogger(__name__ + '.SetSnapshot')
+
+    def get_parser(self, prog_name):
+        parser = super(SetSnapshot, self).get_parser(prog_name)
+        parser.add_argument(
+            'snapshot',
+            metavar='<snapshot>',
+            help='Snapshot to modify (name or ID)')
+        parser.add_argument(
+            '--name',
+            metavar='<name>',
+            help='New snapshot name')
+        parser.add_argument(
+            '--description',
+            metavar='<description>',
+            help='New snapshot description')
+        parser.add_argument(
+            '--property',
+            metavar='<key=value>',
+            action=parseractions.KeyValueAction,
+            help='Property to add/change for this snapshot '
+                 '(repeat option to set multiple properties)',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)', parsed_args)
+        volume_client = self.app.client_manager.volume
+        snapshot = utils.find_resource(volume_client.volume_snapshots,
+                                       parsed_args.snapshot)
+
+        kwargs = {}
+        if parsed_args.name:
+            kwargs['name'] = parsed_args.name
+        if parsed_args.description:
+            kwargs['description'] = parsed_args.description
+
+        if not kwargs and not parsed_args.property:
+            self.app.log.error("No changes requested\n")
+            return
+
+        if parsed_args.property:
+            volume_client.volume_snapshots.set_metadata(snapshot.id,
+                                                        parsed_args.property)
+        volume_client.volume_snapshots.update(snapshot.id, **kwargs)
+        return
+
+
 class ShowSnapshot(show.ShowOne):
     """Display snapshot details"""
 
@@ -67,5 +228,45 @@ class ShowSnapshot(show.ShowOne):
         volume_client = self.app.client_manager.volume
         snapshot = utils.find_resource(
             volume_client.volume_snapshots, parsed_args.snapshot)
-        snapshot = volume_client.volume_snapshots.get(snapshot.id)
+        snapshot._info.update(
+            {'properties': utils.format_dict(snapshot._info.pop('metadata'))}
+        )
         return zip(*sorted(six.iteritems(snapshot._info)))
+
+
+class UnsetSnapshot(command.Command):
+    """Unset snapshot properties"""
+
+    log = logging.getLogger(__name__ + '.UnsetSnapshot')
+
+    def get_parser(self, prog_name):
+        parser = super(UnsetSnapshot, self).get_parser(prog_name)
+        parser.add_argument(
+            'snapshot',
+            metavar='<snapshot>',
+            help='Snapshot to modify (name or ID)',
+        )
+        parser.add_argument(
+            '--property',
+            metavar='<key>',
+            action='append',
+            default=[],
+            help='Property to remove from snapshot '
+                 '(repeat to remove multiple values)',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)', parsed_args)
+        volume_client = self.app.client_manager.volume
+        snapshot = utils.find_resource(
+            volume_client.volume_snapshots, parsed_args.snapshot)
+
+        if parsed_args.property:
+            volume_client.volume_snapshots.delete_metadata(
+                snapshot.id,
+                parsed_args.property,
+            )
+        else:
+            self.app.log.error("No changes requested\n")
+        return