python-openstackclient 7.4.0__py3-none-any.whl → 8.1.0__py3-none-any.whl

openstackclient/volume/v1/volume_backup.py

@@ -1,302 +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.
-#
-
-"""Volume v1 Backup action implementations"""
-
-import copy
-import functools
-import logging
-
-from cliff import columns as cliff_columns
-from osc_lib.command import command
-from osc_lib import exceptions
-from osc_lib import utils
-
-from openstackclient.i18n import _
-
-
-LOG = logging.getLogger(__name__)
-
-
-class VolumeIdColumn(cliff_columns.FormattableColumn):
-    """Formattable column for volume ID column.
-
-    Unlike the parent FormattableColumn class, the initializer of the
-    class takes volume_cache as the second argument.
-    osc_lib.utils.get_item_properties instantiate cliff FormattableColumn
-    object with a single parameter "column value", so you need to pass
-    a partially initialized class like
-    ``functools.partial(VolumeIdColumn, volume_cache)``.
-    """
-
-    def __init__(self, value, volume_cache=None):
-        super().__init__(value)
-        self._volume_cache = volume_cache or {}
-
-    def human_readable(self):
-        """Return a volume name if available
-
-        :rtype: either the volume ID or name
-        """
-        volume_id = self._value
-        volume = volume_id
-        if volume_id in self._volume_cache.keys():
-            volume = self._volume_cache[volume_id].display_name
-        return volume
-
-
-class CreateVolumeBackup(command.ShowOne):
-    _description = _("Create new volume backup")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'volume',
-            metavar='<volume>',
-            help=_('Volume to backup (name or ID)'),
-        )
-        parser.add_argument(
-            '--container',
-            metavar='<container>',
-            required=False,
-            help=_('Optional backup container name'),
-        )
-        parser.add_argument(
-            '--name',
-            metavar='<name>',
-            help=_('Name of the backup'),
-        )
-        parser.add_argument(
-            '--description',
-            metavar='<description>',
-            help=_('Description of the backup'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        volume_id = utils.find_resource(
-            volume_client.volumes, parsed_args.volume
-        ).id
-        backup = volume_client.backups.create(
-            volume_id,
-            parsed_args.container,
-            parsed_args.name,
-            parsed_args.description,
-        )
-
-        backup._info.pop('links')
-        return zip(*sorted(backup._info.items()))
-
-
-class DeleteVolumeBackup(command.Command):
-    _description = _("Delete volume backup(s)")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'backups',
-            metavar='<backup>',
-            nargs="+",
-            help=_('Backup(s) to delete (name or ID)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        result = 0
-
-        for i in parsed_args.backups:
-            try:
-                backup_id = utils.find_resource(volume_client.backups, i).id
-                volume_client.backups.delete(backup_id)
-            except Exception as e:
-                result += 1
-                LOG.error(
-                    _(
-                        "Failed to delete backup with "
-                        "name or ID '%(backup)s': %(e)s"
-                    ),
-                    {'backup': i, 'e': e},
-                )
-
-        if result > 0:
-            total = len(parsed_args.backups)
-            msg = _("%(result)s of %(total)s backups failed " "to delete.") % {
-                'result': result,
-                'total': total,
-            }
-            raise exceptions.CommandError(msg)
-
-
-class ListVolumeBackup(command.Lister):
-    _description = _("List volume backups")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            '--long',
-            action='store_true',
-            default=False,
-            help=_('List additional fields in output'),
-        )
-        parser.add_argument(
-            "--name",
-            metavar="<name>",
-            help=_("Filters results by the backup name"),
-        )
-        parser.add_argument(
-            "--status",
-            metavar="<status>",
-            choices=[
-                'creating',
-                'available',
-                'deleting',
-                'error',
-                'restoring',
-                'error_restoring',
-            ],
-            help=_(
-                "Filters results by the backup status "
-                "('creating', 'available', 'deleting', "
-                "'error', 'restoring' or 'error_restoring')"
-            ),
-        )
-        parser.add_argument(
-            "--volume",
-            metavar="<volume>",
-            help=_(
-                "Filters results by the volume which they "
-                "backup (name or ID)"
-            ),
-        )
-        parser.add_argument(
-            '--all-projects',
-            action='store_true',
-            default=False,
-            help=_('Include all projects (admin only)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-
-        if parsed_args.long:
-            columns = [
-                'ID',
-                'Name',
-                'Description',
-                'Status',
-                'Size',
-                'Availability Zone',
-                'Volume ID',
-                'Container',
-            ]
-            column_headers = copy.deepcopy(columns)
-            column_headers[6] = 'Volume'
-        else:
-            columns = ['ID', 'Name', 'Description', 'Status', 'Size']
-            column_headers = columns
-
-        # Cache the volume list
-        volume_cache = {}
-        try:
-            for s in volume_client.volumes.list():
-                volume_cache[s.id] = s
-        except Exception:  # noqa: S110
-            # Just forget it if there's any trouble
-            pass
-        VolumeIdColumnWithCache = functools.partial(
-            VolumeIdColumn, volume_cache=volume_cache
-        )
-
-        filter_volume_id = None
-        if parsed_args.volume:
-            filter_volume_id = utils.find_resource(
-                volume_client.volumes, parsed_args.volume
-            ).id
-        search_opts = {
-            'name': parsed_args.name,
-            'status': parsed_args.status,
-            'volume_id': filter_volume_id,
-            'all_tenants': parsed_args.all_projects,
-        }
-        data = volume_client.backups.list(
-            search_opts=search_opts,
-        )
-
-        return (
-            column_headers,
-            (
-                utils.get_item_properties(
-                    s,
-                    columns,
-                    formatters={'Volume ID': VolumeIdColumnWithCache},
-                )
-                for s in data
-            ),
-        )
-
-
-class RestoreVolumeBackup(command.Command):
-    _description = _("Restore volume backup")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'backup',
-            metavar='<backup>',
-            help=_('Backup to restore (name or ID)'),
-        )
-        parser.add_argument(
-            'volume',
-            metavar='<volume>',
-            nargs='?',
-            help=_('Volume to restore to (name or ID) (default to None)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        backup = utils.find_resource(
-            volume_client.backups,
-            parsed_args.backup,
-        )
-        volume_id = None
-        if parsed_args.volume is not None:
-            volume_id = utils.find_resource(
-                volume_client.volumes,
-                parsed_args.volume,
-            ).id
-        return volume_client.restores.restore(backup.id, volume_id)
-
-
-class ShowVolumeBackup(command.ShowOne):
-    _description = _("Display volume backup details")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'backup',
-            metavar='<backup>',
-            help=_('Backup to display (name or ID)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        backup = utils.find_resource(volume_client.backups, parsed_args.backup)
-        backup._info.pop('links')
-        return zip(*sorted(backup._info.items()))