python-openstackclient 6.6.1__py3-none-any.whl → 7.0.0__py3-none-any.whl

openstackclient/volume/v2/volume.py

@@ -20,6 +20,7 @@ import functools
 import logging
 
 from cliff import columns as cliff_columns
+from openstack import exceptions as sdk_exceptions
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 from osc_lib.command import command
@@ -69,7 +70,7 @@ class AttachmentsColumn(cliff_columns.FormattableColumn):
     """
 
     def __init__(self, value, server_cache=None):
-        super(AttachmentsColumn, self).__init__(value)
+        super().__init__(value)
         self._server_cache = server_cache or {}
 
     def human_readable(self):
@@ -84,31 +85,29 @@ class AttachmentsColumn(cliff_columns.FormattableColumn):
             if server in self._server_cache.keys():
                 server = self._server_cache[server].name
             device = attachment['device']
-            msg += 'Attached to %s on %s ' % (server, device)
+            msg += f'Attached to {server} on {device} '
         return msg
 
 
-def _check_size_arg(args):
-    """Check whether --size option is required or not.
+class CreateVolume(command.ShowOne):
+    _description = _("Create new volume")
 
-    Require size parameter only in case when snapshot or source
-    volume is not specified.
-    """
-
-    if (
-        args.snapshot or args.source or args.backup
-    ) is None and args.size is None:
-        msg = _(
-            "--size is a required option if snapshot, backup "
-            "or source volume are not specified."
-        )
-        raise exceptions.CommandError(msg)
+    @staticmethod
+    def _check_size_arg(args):
+        """Check whether --size option is required or not.
 
+        Require size parameter only in case when snapshot or source
+        volume is not specified.
+        """
 
-class CreateVolume(command.ShowOne):
-    _description = _("Create new volume")
+        if (args.snapshot or args.source) is None and args.size is None:
+            msg = _(
+                "--size is a required option if --snapshot or --source are "
+                "not specified"
+            )
+            raise exceptions.CommandError(msg)
 
-    def get_parser(self, prog_name):
+    def _get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "name",
@@ -121,8 +120,8 @@ class CreateVolume(command.ShowOne):
             metavar="<size>",
             type=int,
             help=_(
-                "Volume size in GB (required unless --snapshot, "
-                "--source or --backup is specified)"
+                "Volume size in GB (required unless --snapshot or "
+                "--source specified)"
             ),
         )
         parser.add_argument(
@@ -146,14 +145,6 @@ class CreateVolume(command.ShowOne):
             metavar="<volume>",
             help=_("Volume to clone (name or ID)"),
         )
-        source_group.add_argument(
-            "--backup",
-            metavar="<backup>",
-            help=_(
-                "Restore backup to a volume (name or ID) "
-                "(supported by --os-volume-api-version 3.47 or later)"
-            ),
-        )
         source_group.add_argument(
             "--source-replicated",
             metavar="<replicated-volume>",
@@ -216,28 +207,23 @@ class CreateVolume(command.ShowOne):
             action="store_true",
             help=_("Set volume to read-write access mode (default)"),
         )
+        return parser, source_group
+
+    def get_parser(self, prog_name):
+        parser, _ = self._get_parser(prog_name)
         return parser
 
     def take_action(self, parsed_args):
-        _check_size_arg(parsed_args)
+        CreateVolume._check_size_arg(parsed_args)
         # size is validated in the above call to
         # _check_size_arg where we check that size
         # should be passed if we are not creating a
-        # volume from snapshot, backup or source volume
+        # volume from snapshot or source volume
         size = parsed_args.size
 
         volume_client = self.app.client_manager.volume
         image_client = self.app.client_manager.image
 
-        if parsed_args.backup and not (
-            volume_client.api_version.matches('3.47')
-        ):
-            msg = _(
-                "--os-volume-api-version 3.47 or greater is required "
-                "to create a volume from backup."
-            )
-            raise exceptions.CommandError(msg)
-
         source_volume = None
         if parsed_args.source:
             source_volume_obj = utils.find_resource(
@@ -272,15 +258,6 @@ class CreateVolume(command.ShowOne):
             # snapshot size.
             size = max(size or 0, snapshot_obj.size)
 
-        backup = None
-        if parsed_args.backup:
-            backup_obj = utils.find_resource(
-                volume_client.backups, parsed_args.backup
-            )
-            backup = backup_obj.id
-            # As above
-            size = max(size or 0, backup_obj.size)
-
         volume = volume_client.volumes.create(
             size=size,
             snapshot_id=snapshot,
@@ -293,7 +270,6 @@ class CreateVolume(command.ShowOne):
             source_volid=source_volume,
             consistencygroup_id=consistency_group,
             scheduler_hints=parsed_args.hint,
-            backup_id=backup,
         )
 
         if parsed_args.bootable or parsed_args.non_bootable:
@@ -360,7 +336,7 @@ class DeleteVolume(command.Command):
     _description = _("Delete volume(s)")
 
     def get_parser(self, prog_name):
-        parser = super(DeleteVolume, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "volumes",
             metavar="<volume>",
@@ -422,7 +398,7 @@ class ListVolume(command.Lister):
     _description = _("List volumes")
 
     def get_parser(self, prog_name):
-        parser = super(ListVolume, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             '--project',
             metavar='<project>',
@@ -490,19 +466,6 @@ class ListVolume(command.Lister):
             column_headers = copy.deepcopy(columns)
             column_headers[4] = 'Attached to'
 
-        # Cache the server list
-        server_cache = {}
-        try:
-            compute_client = self.app.client_manager.compute
-            for s in compute_client.servers.list():
-                server_cache[s.id] = s
-        except Exception:
-            # Just forget it if there's any trouble
-            pass
-        AttachmentsColumnWithCache = functools.partial(
-            AttachmentsColumn, server_cache=server_cache
-        )
-
         project_id = None
         if parsed_args.project:
             project_id = identity_common.find_project(
@@ -533,6 +496,28 @@ class ListVolume(command.Lister):
             marker=parsed_args.marker,
             limit=parsed_args.limit,
         )
+
+        do_server_list = False
+
+        for vol in data:
+            if vol.status == 'in-use':
+                do_server_list = True
+                break
+
+        # Cache the server list
+        server_cache = {}
+        if do_server_list:
+            try:
+                compute_client = self.app.client_manager.sdk_connection.compute
+                for s in compute_client.servers():
+                    server_cache[s.id] = s
+            except sdk_exceptions.SDKException:
+                # Just forget it if there's any trouble
+                pass  # nosec: B110
+        AttachmentsColumnWithCache = functools.partial(
+            AttachmentsColumn, server_cache=server_cache
+        )
+
         column_headers = utils.backward_compat_col_lister(
             column_headers, parsed_args.columns, {'Display Name': 'Name'}
         )
@@ -557,7 +542,7 @@ class MigrateVolume(command.Command):
     _description = _("Migrate volume to a new host")
 
     def get_parser(self, prog_name):
-        parser = super(MigrateVolume, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
             metavar="<volume>",
@@ -605,7 +590,7 @@ class SetVolume(command.Command):
     _description = _("Set volume properties")
 
     def get_parser(self, prog_name):
-        parser = super(SetVolume, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
             metavar='<volume>',
@@ -711,6 +696,12 @@ class SetVolume(command.Command):
             '--retype-policy',
             metavar='<retype-policy>',
             choices=['never', 'on-demand'],
+            help=argparse.SUPPRESS,
+        )
+        parser.add_argument(
+            '--migration-policy',
+            metavar='<migration-policy>',
+            choices=['never', 'on-demand'],
             help=_(
                 'Migration policy while re-typing volume '
                 '("never" or "on-demand", default is "never" ) '
@@ -746,6 +737,15 @@ class SetVolume(command.Command):
         volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
 
         result = 0
+        if parsed_args.retype_policy:
+            msg = _(
+                "The '--retype-policy' option has been deprecated in favor "
+                "of '--migration-policy' option. The '--retype-policy' option "
+                "will be removed in a future release. Please use "
+                "'--migration-policy' instead."
+            )
+            self.log.warning(msg)
+
         if parsed_args.size:
             try:
                 if parsed_args.size <= volume.size:
@@ -753,10 +753,7 @@ class SetVolume(command.Command):
                         _("New size must be greater than %s GB") % volume.size
                     )
                     raise exceptions.CommandError(msg)
-                if (
-                    volume.status != 'available'
-                    and not volume_client.api_version.matches('3.42')
-                ):
+                if volume.status != 'available':
                     msg = (
                         _(
                             "Volume is in %s state, it must be available "
@@ -839,11 +836,12 @@ class SetVolume(command.Command):
                     e,
                 )
                 result += 1
+        policy = parsed_args.migration_policy or parsed_args.retype_policy
         if parsed_args.type:
             # get the migration policy
             migration_policy = 'never'
-            if parsed_args.retype_policy:
-                migration_policy = parsed_args.retype_policy
+            if policy:
+                migration_policy = policy
             try:
                 # find the volume type
                 volume_type = utils.find_resource(
@@ -856,12 +854,14 @@ class SetVolume(command.Command):
             except Exception as e:
                 LOG.error(_("Failed to set volume type: %s"), e)
                 result += 1
-        elif parsed_args.retype_policy:
-            # If the "--retype-policy" is specified without "--type"
+        elif policy:
+            # If the "--migration-policy" is specified without "--type"
             LOG.warning(
-                _(
-                    "'--retype-policy' option will not work "
-                    "without '--type' option"
+                _("'%s' option will not work without '--type' option")
+                % (
+                    '--migration-policy'
+                    if parsed_args.migration_policy
+                    else '--retype-policy'
                 )
             )
 
@@ -893,7 +893,7 @@ class ShowVolume(command.ShowOne):
     _description = _("Display volume details")
 
     def get_parser(self, prog_name):
-        parser = super(ShowVolume, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
             metavar="<volume>",
@@ -926,7 +926,7 @@ class UnsetVolume(command.Command):
     _description = _("Unset volume properties")
 
     def get_parser(self, prog_name):
-        parser = super(UnsetVolume, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
             metavar='<volume>',

openstackclient/volume/v2/volume_backend.py

@@ -25,7 +25,7 @@ class ShowCapability(command.Lister):
     _description = _("Show capability command")
 
     def get_parser(self, prog_name):
-        parser = super(ShowCapability, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "host",
             metavar="<host>",
@@ -72,7 +72,7 @@ class ListPool(command.Lister):
     _description = _("List pool command")
 
     def get_parser(self, prog_name):
-        parser = super(ListPool, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "--long",
             action="store_true",

openstackclient/volume/v2/volume_backup.py

@@ -14,14 +14,10 @@
 
 """Volume v2 Backup action implementations"""
 
-import copy
 import functools
 import logging
 
-from cinderclient import api_versions
 from cliff import columns as cliff_columns
-from openstack import utils as sdk_utils
-from osc_lib.cli import parseractions
 from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
@@ -44,7 +40,7 @@ class VolumeIdColumn(cliff_columns.FormattableColumn):
     """
 
     def __init__(self, value, volume_cache=None):
-        super(VolumeIdColumn, self).__init__(value)
+        super().__init__(value)
         self._volume_cache = volume_cache or {}
 
     def human_readable(self):
@@ -104,26 +100,6 @@ class CreateVolumeBackup(command.ShowOne):
             action='store_false',
             help=_("Do not perform an incremental backup"),
         )
-        parser.add_argument(
-            '--property',
-            metavar='<key=value>',
-            action=parseractions.KeyValueAction,
-            dest='properties',
-            help=_(
-                'Set a property on this backup '
-                '(repeat option to remove multiple values) '
-                '(supported by --os-volume-api-version 3.43 or above)'
-            ),
-        )
-        parser.add_argument(
-            '--availability-zone',
-            metavar='<zone-name>',
-            help=_(
-                'AZ where the backup should be stored; by default it will be '
-                'the same as the source '
-                '(supported by --os-volume-api-version 3.51 or above)'
-            ),
-        )
         return parser
 
     def take_action(self, parsed_args):
@@ -142,26 +118,6 @@ class CreateVolumeBackup(command.ShowOne):
                 ignore_missing=False,
             ).id
 
-        if parsed_args.properties:
-            if not sdk_utils.supports_microversion(volume_client, '3.43'):
-                msg = _(
-                    '--os-volume-api-version 3.43 or greater is required to '
-                    'support the --property option'
-                )
-                raise exceptions.CommandError(msg)
-
-            kwargs['metadata'] = parsed_args.properties
-
-        if parsed_args.availability_zone:
-            if not sdk_utils.supports_microversion(volume_client, '3.51'):
-                msg = _(
-                    '--os-volume-api-version 3.51 or greater is required to '
-                    'support the --availability-zone option'
-                )
-                raise exceptions.CommandError(msg)
-
-            kwargs['availability_zone'] = parsed_args.availability_zone
-
         columns = (
             "id",
             "name",
@@ -173,7 +129,7 @@ class CreateVolumeBackup(command.ShowOne):
             name=parsed_args.name,
             description=parsed_args.description,
             force=parsed_args.force,
-            incremental=parsed_args.incremental,
+            is_incremental=parsed_args.incremental,
             **kwargs,
         )
         data = utils.get_dict_properties(backup, columns)
@@ -184,7 +140,7 @@ class DeleteVolumeBackup(command.Command):
     _description = _("Delete volume backup(s)")
 
     def get_parser(self, prog_name):
-        parser = super(DeleteVolumeBackup, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "backups",
             metavar="<backup>",
@@ -236,7 +192,7 @@ class ListVolumeBackup(command.Lister):
     _description = _("List volume backups")
 
     def get_parser(self, prog_name):
-        parser = super(ListVolumeBackup, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "--long",
             action="store_true",
@@ -279,20 +235,6 @@ class ListVolumeBackup(command.Lister):
             default=False,
             help=_('Include all projects (admin only)'),
         )
-        # TODO(stephenfin): Add once we have an equivalent command for
-        # 'cinder list-filters'
-        # parser.add_argument(
-        #     '--filter',
-        #     metavar='<key=value>',
-        #     action=parseractions.KeyValueAction,
-        #     dest='filters',
-        #     help=_(
-        #         "Filter key and value pairs. Use 'foo' to "
-        #         "check enabled filters from server. Use 'key~=value' for "
-        #         "inexact filtering if the key supports "
-        #         "(supported by --os-volume-api-version 3.33 or above)"
-        #     ),
-        # )
         return parser
 
     def take_action(self, parsed_args):
@@ -325,7 +267,7 @@ class ListVolumeBackup(command.Lister):
                 volume_cache[s.id] = s
         except Exception:
             # Just forget it if there's any trouble
-            pass
+            pass  # nosec: B110
 
         _VolumeIdColumn = functools.partial(
             VolumeIdColumn, volume_cache=volume_cache
@@ -381,7 +323,7 @@ class RestoreVolumeBackup(command.ShowOne):
     _description = _("Restore volume backup")
 
     def get_parser(self, prog_name):
-        parser = super(RestoreVolumeBackup, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "backup",
             metavar="<backup>",
@@ -451,22 +393,6 @@ class SetVolumeBackup(command.Command):
             metavar="<backup>",
             help=_("Backup to modify (name or ID)"),
         )
-        parser.add_argument(
-            '--name',
-            metavar='<name>',
-            help=_(
-                'New backup name'
-                '(supported by --os-volume-api-version 3.9 or above)'
-            ),
-        )
-        parser.add_argument(
-            '--description',
-            metavar='<description>',
-            help=_(
-                'New backup description '
-                '(supported by --os-volume-api-version 3.9 or above)'
-            ),
-        )
         parser.add_argument(
             '--state',
             metavar='<state>',
@@ -478,27 +404,6 @@ class SetVolumeBackup(command.Command):
                 'exercise caution when using)'
             ),
         )
-        parser.add_argument(
-            '--no-property',
-            action='store_true',
-            help=_(
-                'Remove all properties from this backup '
-                '(specify both --no-property and --property to remove the '
-                'current properties before setting new properties)'
-            ),
-        )
-        parser.add_argument(
-            '--property',
-            metavar='<key=value>',
-            action=parseractions.KeyValueAction,
-            dest='properties',
-            default={},
-            help=_(
-                'Set a property on this backup '
-                '(repeat option to set multiple values) '
-                '(supported by --os-volume-api-version 3.43 or above)'
-            ),
-        )
         return parser
 
     def take_action(self, parsed_args):
@@ -513,127 +418,16 @@ class SetVolumeBackup(command.Command):
                 LOG.error(_("Failed to set backup state: %s"), e)
                 result += 1
 
-        kwargs = {}
-
-        if parsed_args.name:
-            if volume_client.api_version < api_versions.APIVersion('3.9'):
-                msg = _(
-                    '--os-volume-api-version 3.9 or greater is required to '
-                    'support the --name option'
-                )
-                raise exceptions.CommandError(msg)
-
-            kwargs['name'] = parsed_args.name
-
-        if parsed_args.description:
-            if volume_client.api_version < api_versions.APIVersion('3.9'):
-                msg = _(
-                    '--os-volume-api-version 3.9 or greater is required to '
-                    'support the --description option'
-                )
-                raise exceptions.CommandError(msg)
-
-            kwargs['description'] = parsed_args.description
-
-        if parsed_args.no_property:
-            if volume_client.api_version < api_versions.APIVersion('3.43'):
-                msg = _(
-                    '--os-volume-api-version 3.43 or greater is required to '
-                    'support the --no-property option'
-                )
-                raise exceptions.CommandError(msg)
-
-        if parsed_args.properties:
-            if volume_client.api_version < api_versions.APIVersion('3.43'):
-                msg = _(
-                    '--os-volume-api-version 3.43 or greater is required to '
-                    'support the --property option'
-                )
-                raise exceptions.CommandError(msg)
-
-        if volume_client.api_version >= api_versions.APIVersion('3.43'):
-            metadata = copy.deepcopy(backup.metadata)
-
-            if parsed_args.no_property:
-                metadata = {}
-
-            metadata.update(parsed_args.properties)
-            kwargs['metadata'] = metadata
-
-        if kwargs:
-            try:
-                volume_client.backups.update(backup.id, **kwargs)
-            except Exception as e:
-                LOG.error("Failed to update backup: %s", e)
-                result += 1
-
         if result > 0:
             msg = _("One or more of the set operations failed")
             raise exceptions.CommandError(msg)
 
 
-class UnsetVolumeBackup(command.Command):
-    """Unset volume backup properties.
-
-    This command requires ``--os-volume-api-version`` 3.43 or greater.
-    """
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'backup',
-            metavar='<backup>',
-            help=_('Backup to modify (name or ID)'),
-        )
-        parser.add_argument(
-            '--property',
-            metavar='<key>',
-            action='append',
-            dest='properties',
-            help=_(
-                'Property to remove from this backup '
-                '(repeat option to unset multiple values) '
-            ),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-
-        if volume_client.api_version < api_versions.APIVersion('3.43'):
-            msg = _(
-                '--os-volume-api-version 3.43 or greater is required to '
-                'support the --property option'
-            )
-            raise exceptions.CommandError(msg)
-
-        backup = utils.find_resource(volume_client.backups, parsed_args.backup)
-        metadata = copy.deepcopy(backup.metadata)
-
-        for key in parsed_args.properties:
-            if key not in metadata:
-                # ignore invalid properties but continue
-                LOG.warning(
-                    "'%s' is not a valid property for backup '%s'",
-                    key,
-                    parsed_args.backup,
-                )
-                continue
-
-            del metadata[key]
-
-        kwargs = {
-            'metadata': metadata,
-        }
-
-        volume_client.backups.update(backup.id, **kwargs)
-
-
 class ShowVolumeBackup(command.ShowOne):
     _description = _("Display volume backup details")
 
     def get_parser(self, prog_name):
-        parser = super(ShowVolumeBackup, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "backup",
             metavar="<backup>",
@@ -650,20 +444,16 @@ class ShowVolumeBackup(command.ShowOne):
             "created_at",
             "data_timestamp",
             "description",
-            "encryption_key_id",
             "fail_reason",
             "has_dependent_backups",
             "id",
             "is_incremental",
-            "metadata",
             "name",
             "object_count",
-            "project_id",
             "size",
             "snapshot_id",
             "status",
             "updated_at",
-            "user_id",
             "volume_id",
         )
         data = utils.get_dict_properties(backup, columns)