Remove deprecated volume commands and args

The following were deprecated over two years ago and can now be removed:

* Remove ``backup`` commands in favor of ``volume backup``
* Remove ``snapshot`` commands in favor of ``volume snapshot``
* Remove ``volume create`` options ``--project``, ``--user`` and ``--multi-attach``
* Use of an auth-key positional argument in volume transfers
* ``volume transfer request`` no longer accepts 'auth_key' as a positional arg,
  ``--auth-key`` is now required

Internal (non-user-visible)
* Rename backup.py to volume_backup.py for Volume v1 and v2, update tests

These are backwards incompatible changes and will require a major
version bump after they are merged.

Change-Id: I94aa7a9824e44f9585ffb45e5e7637b9588539b4
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Signed-off-by: Dean Troyer <dtroyer@gmail.com>

3 files changed, 2 insertions, 423 deletions

diff --git a/openstackclient/volume/v1/snapshot.py b/openstackclient/volume/v1/snapshot.py
deleted file mode 100644
index e9e3894b..00000000
--- a/openstackclient/volume/v1/snapshot.py
+++ /dev/null
@@ -1,318 +0,0 @@
-#   Copyright 2012-2013 OpenStack Foundation
-#
-#   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.
-#
-
-# TODO(Huanxuan Ao): Remove this file and "snapshot create", "snapshot delete",
-#                    "snapshot set", "snapshot show" and "snapshot unset"
-#                    commands two cycles after Ocata.
-
-"""Volume v1 Snapshot action implementations"""
-
-import copy
-import logging
-
-from osc_lib.cli import parseractions
-from osc_lib.command import command
-from osc_lib import exceptions
-from osc_lib import utils
-import six
-
-from openstackclient.i18n import _
-
-
-deprecated = True
-LOG_DEP = logging.getLogger('deprecated')
-LOG = logging.getLogger(__name__)
-
-
-class CreateSnapshot(command.ShowOne):
-    _description = _("Create new snapshot")
-
-    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>',
-            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):
-        LOG_DEP.warning(_('This command has been deprecated. '
-                          'Please use "volume snapshot create" instead.'))
-        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,
-            parsed_args.force,
-            parsed_args.name,
-            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):
-    _description = _("Delete snapshot(s)")
-
-    def get_parser(self, prog_name):
-        parser = super(DeleteSnapshot, self).get_parser(prog_name)
-        parser.add_argument(
-            'snapshots',
-            metavar='<snapshot>',
-            nargs="+",
-            help=_('Snapshot(s) to delete (name or ID)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        LOG_DEP.warning(_('This command has been deprecated. '
-                          'Please use "volume snapshot delete" instead.'))
-        volume_client = self.app.client_manager.volume
-        result = 0
-
-        for i in parsed_args.snapshots:
-            try:
-                snapshot_id = utils.find_resource(
-                    volume_client.volume_snapshots, i).id
-                volume_client.volume_snapshots.delete(snapshot_id)
-            except Exception as e:
-                result += 1
-                LOG.error(_("Failed to delete snapshot with "
-                            "name or ID '%(snapshot)s': %(e)s"),
-                          {'snapshot': i, 'e': e})
-
-        if result > 0:
-            total = len(parsed_args.snapshots)
-            msg = (_("%(result)s of %(total)s snapshots failed "
-                   "to delete.") % {'result': result, 'total': total})
-            raise exceptions.CommandError(msg)
-
-
-class ListSnapshot(command.Lister):
-    _description = _("List snapshots")
-
-    def get_parser(self, prog_name):
-        parser = super(ListSnapshot, self).get_parser(prog_name)
-        parser.add_argument(
-            '--all-projects',
-            action='store_true',
-            default=False,
-            help=_('Include all projects (admin only)'),
-        )
-        parser.add_argument(
-            '--long',
-            action='store_true',
-            default=False,
-            help=_('List additional fields in output'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        LOG_DEP.warning(_('This command has been deprecated. '
-                          'Please use "volume snapshot list" instead.'))
-
-        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].display_name
-            return volume
-
-        if parsed_args.long:
-            columns = ['ID', 'Display Name', 'Display Description', 'Status',
-                       'Size', 'Created At', 'Volume ID', 'Metadata']
-            column_headers = copy.deepcopy(columns)
-            column_headers[6] = 'Volume'
-            column_headers[7] = 'Properties'
-        else:
-            columns = ['ID', 'Display Name', 'Display Description', 'Status',
-                       'Size']
-            column_headers = copy.deepcopy(columns)
-
-        # Always update Name and Description
-        column_headers[1] = 'Name'
-        column_headers[2] = 'Description'
-
-        # 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
-
-        search_opts = {
-            'all_tenants': parsed_args.all_projects,
-        }
-
-        data = self.app.client_manager.volume.volume_snapshots.list(
-            search_opts=search_opts)
-        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):
-    _description = _("Set snapshot properties")
-
-    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):
-        LOG_DEP.warning(_('This command has been deprecated. '
-                          'Please use "volume snapshot set" instead.'))
-        volume_client = self.app.client_manager.volume
-        snapshot = utils.find_resource(volume_client.volume_snapshots,
-                                       parsed_args.snapshot)
-
-        result = 0
-        if parsed_args.property:
-            try:
-                volume_client.volume_snapshots.set_metadata(
-                    snapshot.id, parsed_args.property)
-            except Exception as e:
-                LOG.error(_("Failed to set snapshot property: %s"), e)
-                result += 1
-
-        kwargs = {}
-        if parsed_args.name:
-            kwargs['display_name'] = parsed_args.name
-        if parsed_args.description:
-            kwargs['display_description'] = parsed_args.description
-        if kwargs:
-            try:
-                snapshot.update(**kwargs)
-            except Exception as e:
-                LOG.error(_("Failed to update snapshot display name "
-                          "or display description: %s"), e)
-                result += 1
-
-        if result > 0:
-            raise exceptions.CommandError(_("One or more of the "
-                                          "set operations failed"))
-
-
-class ShowSnapshot(command.ShowOne):
-    _description = _("Display snapshot details")
-
-    def get_parser(self, prog_name):
-        parser = super(ShowSnapshot, self).get_parser(prog_name)
-        parser.add_argument(
-            'snapshot',
-            metavar='<snapshot>',
-            help=_('Snapshot to display (name or ID)')
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        LOG_DEP.warning(_('This command has been deprecated. '
-                          'Please use "volume snapshot show" instead.'))
-        volume_client = self.app.client_manager.volume
-        snapshot = utils.find_resource(volume_client.volume_snapshots,
-                                       parsed_args.snapshot)
-
-        snapshot._info.update(
-            {'properties': utils.format_dict(snapshot._info.pop('metadata'))}
-        )
-
-        return zip(*sorted(six.iteritems(snapshot._info)))
-
-
-class UnsetSnapshot(command.Command):
-    _description = _("Unset snapshot properties")
-
-    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',
-            help=_('Property to remove from snapshot '
-                   '(repeat option to remove multiple properties)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        LOG_DEP.warning(_('This command has been deprecated. '
-                          'Please use "volume snapshot unset" instead.'))
-        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,
-            )
diff --git a/openstackclient/volume/v1/backup.py b/openstackclient/volume/v1/volume_backup.py
index 9ac1302a..9af32705 100644
--- a/openstackclient/volume/v1/backup.py
+++ b/openstackclient/volume/v1/volume_backup.py
@@ -72,23 +72,6 @@ class CreateVolumeBackup(command.ShowOne):
         return zip(*sorted(six.iteritems(backup._info)))
 
 
-class CreateBackup(CreateVolumeBackup):
-    _description = _("Create new backup")
-
-    # TODO(Huanxuan Ao): Remove this class and ``backup create`` command
-    #                    two cycles after Newton.
-
-    # This notifies cliff to not display the help for this command
-    deprecated = True
-
-    log = logging.getLogger('deprecated')
-
-    def take_action(self, parsed_args):
-        self.log.warning(_('This command has been deprecated. '
-                           'Please use "volume backup create" instead.'))
-        return super(CreateBackup, self).take_action(parsed_args)
-
-
 class DeleteVolumeBackup(command.Command):
     _description = _("Delete volume backup(s)")
 
@@ -124,23 +107,6 @@ class DeleteVolumeBackup(command.Command):
             raise exceptions.CommandError(msg)
 
 
-class DeleteBackup(DeleteVolumeBackup):
-    _description = _("Delete backup(s)")
-
-    # TODO(Huanxuan Ao): Remove this class and ``backup delete`` command
-    #                    two cycles after Newton.
-
-    # This notifies cliff to not display the help for this command
-    deprecated = True
-
-    log = logging.getLogger('deprecated')
-
-    def take_action(self, parsed_args):
-        self.log.warning(_('This command has been deprecated. '
-                           'Please use "volume backup delete" instead.'))
-        return super(DeleteBackup, self).take_action(parsed_args)
-
-
 class ListVolumeBackup(command.Lister):
     _description = _("List volume backups")
 
@@ -234,23 +200,6 @@ class ListVolumeBackup(command.Lister):
                 ) for s in data))
 
 
-class ListBackup(ListVolumeBackup):
-    _description = _("List backups")
-
-    # TODO(Huanxuan Ao): Remove this class and ``backup list`` command
-    #                    two cycles after Newton.
-
-    # This notifies cliff to not display the help for this command
-    deprecated = True
-
-    log = logging.getLogger('deprecated')
-
-    def take_action(self, parsed_args):
-        self.log.warning(_('This command has been deprecated. '
-                           'Please use "volume backup list" instead.'))
-        return super(ListBackup, self).take_action(parsed_args)
-
-
 class RestoreVolumeBackup(command.Command):
     _description = _("Restore volume backup")
 
@@ -278,23 +227,6 @@ class RestoreVolumeBackup(command.Command):
                                               destination_volume.id)
 
 
-class RestoreBackup(RestoreVolumeBackup):
-    _description = _("Restore backup")
-
-    # TODO(Huanxuan Ao): Remove this class and ``backup restore`` command
-    #                    two cycles after Newton.
-
-    # This notifies cliff to not display the help for this command
-    deprecated = True
-
-    log = logging.getLogger('deprecated')
-
-    def take_action(self, parsed_args):
-        self.log.warning(_('This command has been deprecated. '
-                           'Please use "volume backup restore" instead.'))
-        return super(RestoreBackup, self).take_action(parsed_args)
-
-
 class ShowVolumeBackup(command.ShowOne):
     _description = _("Display volume backup details")
 
@@ -313,20 +245,3 @@ class ShowVolumeBackup(command.ShowOne):
                                      parsed_args.backup)
         backup._info.pop('links')
         return zip(*sorted(six.iteritems(backup._info)))
-
-
-class ShowBackup(ShowVolumeBackup):
-    _description = _("Display backup details")
-
-    # TODO(Huanxuan Ao): Remove this class and ``backup show`` command
-    #                    two cycles after Newton.
-
-    # This notifies cliff to not display the help for this command
-    deprecated = True
-
-    log = logging.getLogger('deprecated')
-
-    def take_action(self, parsed_args):
-        self.log.warning(_('This command has been deprecated. '
-                           'Please use "volume backup show" instead.'))
-        return super(ShowBackup, self).take_action(parsed_args)
diff --git a/openstackclient/volume/v1/volume_transfer_request.py b/openstackclient/volume/v1/volume_transfer_request.py
index f5b567b9..6f79658e 100644
--- a/openstackclient/volume/v1/volume_transfer_request.py
+++ b/openstackclient/volume/v1/volume_transfer_request.py
@@ -14,7 +14,6 @@
 
 """Volume v1 transfer action implementations"""
 
-import argparse
 import logging
 
 from osc_lib.command import command
@@ -39,12 +38,6 @@ class AcceptTransferRequest(command.ShowOne):
             help=_('Volume transfer request to accept (ID only)'),
         )
         parser.add_argument(
-            'old_auth_key',
-            metavar="<key>",
-            nargs="?",
-            help=argparse.SUPPRESS,
-        )
-        parser.add_argument(
             '--auth-key',
             metavar="<key>",
             help=_('Volume transfer request authentication key'),
@@ -64,20 +57,9 @@ class AcceptTransferRequest(command.ShowOne):
             # move on and attempt with the user-supplied information
             transfer_request_id = parsed_args.transfer_request
 
-        # Remain backward-compatible for the previous command layout
-        # TODO(dtroyer): Remove this back-compat in 4.0 or Oct 2017
         if not parsed_args.auth_key:
-            if parsed_args.old_auth_key:
-                # Move the old one into the correct place
-                parsed_args.auth_key = parsed_args.old_auth_key
-                self.log.warning(_(
-                    'Specifying the auth-key as a positional argument '
-                    'has been deprecated.  Please use the --auth-key '
-                    'option in the future.'
-                ))
-            else:
-                msg = _("argument --auth-key is required")
-                raise exceptions.CommandError(msg)
+            msg = _("argument --auth-key is required")
+            raise exceptions.CommandError(msg)
 
         transfer_accept = volume_client.transfers.accept(
             transfer_request_id,