python-openstackclient 8.0.0__py3-none-any.whl → 8.2.0__py3-none-any.whl

openstackclient/volume/v3/volume.py

@@ -18,8 +18,10 @@ import argparse
 import copy
 import functools
 import logging
+import typing as ty
 
 from cliff import columns as cliff_columns
+from openstack.block_storage.v3 import volume as _volume
 from openstack import exceptions as sdk_exceptions
 from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
@@ -28,10 +30,10 @@ from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.api import volume_v3
 from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
-from openstackclient.volume.v2 import volume as volume_v2
 
 
 LOG = logging.getLogger(__name__)
@@ -91,7 +93,53 @@ class AttachmentsColumn(cliff_columns.FormattableColumn):
         return msg
 
 
-class CreateVolume(volume_v2.CreateVolume):
+def _format_volume(volume: _volume.Volume) -> dict[str, ty.Any]:
+    # Some columns returned by openstacksdk should not be shown because they're
+    # either irrelevant or duplicates
+    ignored_columns = {
+        # computed columns
+        'location',
+        # create-only columns
+        'OS-SCH-HNT:scheduler_hints',
+        'imageRef',
+        # removed columns
+        'os-volume-replication:driver_data',
+        'os-volume-replication:extended_status',
+        # unnecessary columns
+        'links',
+    }
+    optional_columns = {
+        # only present if part of a consistency group
+        'consistencygroup_id',
+        # only present if the volume is encrypted
+        'encryption_key_id',
+        # only present if there are image properties associated
+        'volume_image_metadata',
+    }
+
+    info = volume.to_dict(original_names=True)
+    data = {}
+    for key, value in info.items():
+        if key in ignored_columns:
+            continue
+
+        if key in optional_columns:
+            if info[key] is None:
+                continue
+
+        data[key] = value
+
+    data.update(
+        {
+            'properties': format_columns.DictColumn(data.pop('metadata')),
+            'type': data.pop('volume_type'),
+        }
+    )
+
+    return data
+
+
+class CreateVolume(command.ShowOne):
     _description = _("Create new volume")
 
     @staticmethod
@@ -117,8 +165,48 @@ class CreateVolume(volume_v2.CreateVolume):
             raise exceptions.CommandError(msg)
 
     def get_parser(self, prog_name):
-        parser, source_group = self._get_parser(prog_name)
-
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "name",
+            metavar="<name>",
+            nargs="?",
+            help=_("Volume name"),
+        )
+        parser.add_argument(
+            "--size",
+            metavar="<size>",
+            type=int,
+            help=_(
+                "Volume size in GB (required unless --snapshot or "
+                "--source specified)"
+            ),
+        )
+        parser.add_argument(
+            "--type",
+            metavar="<volume-type>",
+            help=_("Set the type of volume"),
+        )
+        source_group = parser.add_mutually_exclusive_group()
+        source_group.add_argument(
+            "--image",
+            metavar="<image>",
+            help=_("Use <image> as source of volume (name or ID)"),
+        )
+        source_group.add_argument(
+            "--snapshot",
+            metavar="<snapshot>",
+            help=_("Use <snapshot> as source of volume (name or ID)"),
+        )
+        source_group.add_argument(
+            "--source",
+            metavar="<volume>",
+            help=_("Volume to clone (name or ID)"),
+        )
+        source_group.add_argument(
+            "--source-replicated",
+            metavar="<replicated-volume>",
+            help=argparse.SUPPRESS,
+        )
         source_group.add_argument(
             "--backup",
             metavar="<backup>",
@@ -138,6 +226,72 @@ class CreateVolume(volume_v2.CreateVolume):
                 "--remote-source source-id=test_id')"
             ),
         )
+        parser.add_argument(
+            "--description",
+            metavar="<description>",
+            help=_("Volume description"),
+        )
+        parser.add_argument(
+            "--availability-zone",
+            metavar="<availability-zone>",
+            help=_("Create volume in <availability-zone>"),
+        )
+        parser.add_argument(
+            "--consistency-group",
+            metavar="consistency-group>",
+            help=_("Consistency group where the new volume belongs to"),
+        )
+        parser.add_argument(
+            "--property",
+            metavar="<key=value>",
+            action=parseractions.KeyValueAction,
+            dest="properties",
+            help=_(
+                "Set a property to this volume "
+                "(repeat option to set multiple properties)"
+            ),
+        )
+        parser.add_argument(
+            "--hint",
+            metavar="<key=value>",
+            action=KeyValueHintAction,
+            help=_(
+                "Arbitrary scheduler hint key-value pairs to help creating "
+                "a volume. Repeat the option to set multiple hints. "
+                "'same_host' and 'different_host' get values appended when "
+                "repeated, all other keys take the last given value"
+            ),
+        )
+        bootable_group = parser.add_mutually_exclusive_group()
+        bootable_group.add_argument(
+            "--bootable",
+            action="store_true",
+            dest="bootable",
+            default=None,
+            help=_("Mark volume as bootable"),
+        )
+        bootable_group.add_argument(
+            "--non-bootable",
+            action="store_false",
+            dest="bootable",
+            default=None,
+            help=_("Mark volume as non-bootable (default)"),
+        )
+        readonly_group = parser.add_mutually_exclusive_group()
+        readonly_group.add_argument(
+            "--read-only",
+            action="store_true",
+            dest="read_only",
+            default=None,
+            help=_("Set volume to read-only access mode"),
+        )
+        readonly_group.add_argument(
+            "--read-write",
+            action="store_false",
+            dest="read_only",
+            default=None,
+            help=_("Set volume to read-write access mode (default)"),
+        )
         parser.add_argument(
             "--host",
             metavar="<host>",
@@ -160,15 +314,14 @@ class CreateVolume(volume_v2.CreateVolume):
         return parser
 
     def take_action(self, parsed_args):
-        CreateVolume._check_size_arg(parsed_args)
+        self._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
         size = parsed_args.size
 
-        volume_client_sdk = self.app.client_manager.sdk_connection.volume
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
         image_client = self.app.client_manager.image
 
         if (
@@ -180,8 +333,8 @@ class CreateVolume(volume_v2.CreateVolume):
             )
             raise exceptions.CommandError(msg)
 
-        if parsed_args.backup and not (
-            volume_client.api_version.matches('3.47')
+        if parsed_args.backup and not sdk_utils.supports_microversion(
+            volume_client, '3.47'
         ):
             msg = _(
                 "--os-volume-api-version 3.47 or greater is required "
@@ -194,8 +347,7 @@ class CreateVolume(volume_v2.CreateVolume):
                 parsed_args.size
                 or parsed_args.consistency_group
                 or parsed_args.hint
-                or parsed_args.read_only
-                or parsed_args.read_write
+                or parsed_args.read_only is not None
             ):
                 msg = _(
                     "The --size, --consistency-group, --hint, --read-only "
@@ -204,9 +356,7 @@ class CreateVolume(volume_v2.CreateVolume):
                 )
                 raise exceptions.CommandError(msg)
             if parsed_args.cluster:
-                if not sdk_utils.supports_microversion(
-                    volume_client_sdk, '3.16'
-                ):
+                if not sdk_utils.supports_microversion(volume_client, '3.16'):
                     msg = _(
                         "--os-volume-api-version 3.16 or greater is required "
                         "to support the cluster parameter."
@@ -224,7 +374,7 @@ class CreateVolume(volume_v2.CreateVolume):
                     "manage a volume."
                 )
                 raise exceptions.CommandError(msg)
-            volume = volume_client_sdk.manage_volume(
+            volume = volume_client.manage_volume(
                 host=parsed_args.host,
                 cluster=parsed_args.cluster,
                 ref=parsed_args.remote_source,
@@ -232,24 +382,25 @@ class CreateVolume(volume_v2.CreateVolume):
                 description=parsed_args.description,
                 volume_type=parsed_args.type,
                 availability_zone=parsed_args.availability_zone,
-                metadata=parsed_args.property,
+                metadata=parsed_args.properties,
                 bootable=parsed_args.bootable,
             )
-            return zip(*sorted(volume.items()))
+            data = _format_volume(volume)
+            return zip(*sorted(data.items()))
 
         source_volume = None
         if parsed_args.source:
-            source_volume_obj = utils.find_resource(
-                volume_client.volumes, parsed_args.source
+            source_volume_obj = volume_client.find_volume(
+                parsed_args.source, ignore_missing=False
             )
             source_volume = source_volume_obj.id
             size = max(size or 0, source_volume_obj.size)
 
         consistency_group = None
         if parsed_args.consistency_group:
-            consistency_group = utils.find_resource(
-                volume_client.consistencygroups, parsed_args.consistency_group
-            ).id
+            consistency_group = volume_v3.find_consistency_group(
+                volume_client, parsed_args.consistency_group
+            )['id']
 
         image = None
         if parsed_args.image:
@@ -259,8 +410,8 @@ class CreateVolume(volume_v2.CreateVolume):
 
         snapshot = None
         if parsed_args.snapshot:
-            snapshot_obj = utils.find_resource(
-                volume_client.volume_snapshots, parsed_args.snapshot
+            snapshot_obj = volume_client.find_snapshot(
+                parsed_args.snapshot, ignore_missing=False
             )
             snapshot = snapshot_obj.id
             # Cinder requires a value for size when creating a volume
@@ -273,39 +424,39 @@ class CreateVolume(volume_v2.CreateVolume):
 
         backup = None
         if parsed_args.backup:
-            backup_obj = utils.find_resource(
-                volume_client.backups, parsed_args.backup
+            backup_obj = volume_client.find_backup(
+                parsed_args.backup, ignore_missing=False
             )
             backup = backup_obj.id
             # As above
             size = max(size or 0, backup_obj.size)
 
-        volume = volume_client.volumes.create(
+        volume = volume_client.create_volume(
             size=size,
             snapshot_id=snapshot,
             name=parsed_args.name,
             description=parsed_args.description,
             volume_type=parsed_args.type,
             availability_zone=parsed_args.availability_zone,
-            metadata=parsed_args.property,
-            imageRef=image,
-            source_volid=source_volume,
-            consistencygroup_id=consistency_group,
+            metadata=parsed_args.properties,
+            image_id=image,
+            source_volume_id=source_volume,
+            consistency_group_id=consistency_group,
             scheduler_hints=parsed_args.hint,
             backup_id=backup,
         )
 
-        if parsed_args.bootable or parsed_args.non_bootable:
+        if parsed_args.bootable is not None:
             try:
                 if utils.wait_for_status(
-                    volume_client.volumes.get,
+                    volume_client.get_volume,
                     volume.id,
                     success_status=['available'],
                     error_status=['error'],
                     sleep_time=1,
                 ):
-                    volume_client.volumes.set_bootable(
-                        volume.id, parsed_args.bootable
+                    volume_client.set_volume_bootable_status(
+                        volume, parsed_args.bootable
                     )
                 else:
                     msg = _(
@@ -314,17 +465,18 @@ class CreateVolume(volume_v2.CreateVolume):
                     raise exceptions.CommandError(msg)
             except Exception as e:
                 LOG.error(_("Failed to set volume bootable property: %s"), e)
-        if parsed_args.read_only or parsed_args.read_write:
+
+        if parsed_args.read_only is not None:
             try:
                 if utils.wait_for_status(
-                    volume_client.volumes.get,
+                    volume_client.get_volume,
                     volume.id,
                     success_status=['available'],
                     error_status=['error'],
                     sleep_time=1,
                 ):
-                    volume_client.volumes.update_readonly_flag(
-                        volume.id, parsed_args.read_only
+                    volume_client.set_volume_readonly(
+                        volume, parsed_args.read_only
                     )
                 else:
                     msg = _(
@@ -338,24 +490,37 @@ class CreateVolume(volume_v2.CreateVolume):
                     e,
                 )
 
-        # Remove key links from being displayed
-        volume._info.update(
-            {
-                'properties': format_columns.DictColumn(
-                    volume._info.pop('metadata')
-                ),
-                'type': volume._info.pop('volume_type'),
-            }
-        )
-        volume._info.pop("links", None)
-        return zip(*sorted(volume._info.items()))
+        data = _format_volume(volume)
+        return zip(*sorted(data.items()))
 
 
-class DeleteVolume(volume_v2.DeleteVolume):
+class DeleteVolume(command.Command):
     _description = _("Delete volume(s)")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "volumes",
+            metavar="<volume>",
+            nargs="+",
+            help=_("Volume(s) to delete (name or ID)"),
+        )
+        group = parser.add_mutually_exclusive_group()
+        group.add_argument(
+            "--force",
+            action="store_true",
+            help=_(
+                "Attempt forced removal of volume(s), regardless of state "
+                "(defaults to False)"
+            ),
+        )
+        group.add_argument(
+            "--purge",
+            action="store_true",
+            help=_(
+                "Remove any snapshots along with volume(s) (defaults to False)"
+            ),
+        )
         parser.add_argument(
             '--remote',
             action='store_true',
@@ -364,8 +529,7 @@ class DeleteVolume(volume_v2.DeleteVolume):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        volume_client_sdk = self.app.client_manager.sdk_connection.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
         result = 0
 
         if parsed_args.remote and (parsed_args.force or parsed_args.purge):
@@ -375,16 +539,18 @@ class DeleteVolume(volume_v2.DeleteVolume):
             )
             raise exceptions.CommandError(msg)
 
-        for i in parsed_args.volumes:
+        for volume in parsed_args.volumes:
             try:
-                volume_obj = utils.find_resource(volume_client.volumes, i)
+                volume_obj = volume_client.find_volume(
+                    volume, ignore_missing=False
+                )
                 if parsed_args.remote:
-                    volume_client_sdk.unmanage_volume(volume_obj.id)
-                elif parsed_args.force:
-                    volume_client.volumes.force_delete(volume_obj.id)
+                    volume_client.unmanage_volume(volume_obj.id)
                 else:
-                    volume_client.volumes.delete(
-                        volume_obj.id, cascade=parsed_args.purge
+                    volume_client.delete_volume(
+                        volume_obj.id,
+                        force=parsed_args.force,
+                        cascade=parsed_args.purge,
                     )
             except Exception as e:
                 result += 1
@@ -393,7 +559,7 @@ class DeleteVolume(volume_v2.DeleteVolume):
                         "Failed to delete volume with "
                         "name or ID '%(volume)s': %(e)s"
                     ),
-                    {'volume': i, 'e': e},
+                    {'volume': volume, 'e': e},
                 )
 
         if result > 0:
@@ -432,6 +598,16 @@ class ListVolume(command.Lister):
             metavar='<status>',
             help=_('Filter results by status'),
         )
+        parser.add_argument(
+            '--property',
+            metavar='<key=value>',
+            action=parseractions.KeyValueAction,
+            dest='properties',
+            help=_(
+                'Filter by a property on the volume list '
+                '(repeat option to filter by multiple properties) '
+            ),
+        )
         parser.add_argument(
             '--all-projects',
             action='store_true',
@@ -500,6 +676,7 @@ class ListVolume(command.Lister):
             'user_id': user_id,
             'name': parsed_args.name,
             'status': parsed_args.status,
+            'metadata': parsed_args.properties,
         }
 
         data = volume_client.volumes.list(
@@ -584,16 +761,19 @@ class MigrateVolume(command.Command):
                 "(possibly by another operation)"
             ),
         )
+        # TODO(stephenfin): Add --cluster argument
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
-        volume_client.volumes.migrate_volume(
+        volume_client = self.app.client_manager.sdk_connection.volume
+        volume = volume_client.find_volume(
+            parsed_args.volume, ignore_missing=False
+        )
+        volume_client.migrate_volume(
             volume.id,
-            parsed_args.host,
-            parsed_args.force_host_copy,
-            parsed_args.lock_volume,
+            host=parsed_args.host,
+            force_host_copy=parsed_args.force_host_copy,
+            lock_volume=parsed_args.lock_volume,
         )
 
 
@@ -638,6 +818,7 @@ class SetVolume(command.Command):
             '--property',
             metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest='properties',
             help=_(
                 'Set a property on this volume '
                 '(repeat option to set multiple properties)'
@@ -647,6 +828,7 @@ class SetVolume(command.Command):
             '--image-property',
             metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest='image_properties',
             help=_(
                 'Set an image property on this volume '
                 '(repeat option to set multiple image properties)'
@@ -723,22 +905,30 @@ class SetVolume(command.Command):
         bootable_group.add_argument(
             "--bootable",
             action="store_true",
+            dest="bootable",
+            default=None,
             help=_("Mark volume as bootable"),
         )
         bootable_group.add_argument(
             "--non-bootable",
-            action="store_true",
+            action="store_false",
+            dest="bootable",
+            default=None,
             help=_("Mark volume as non-bootable"),
         )
         readonly_group = parser.add_mutually_exclusive_group()
         readonly_group.add_argument(
             "--read-only",
             action="store_true",
+            dest="read_only",
+            default=None,
             help=_("Set volume to read-only access mode"),
         )
         readonly_group.add_argument(
             "--read-write",
-            action="store_true",
+            action="store_false",
+            dest="read_only",
+            default=None,
             help=_("Set volume to read-write access mode"),
         )
         return parser
@@ -796,28 +986,31 @@ class SetVolume(command.Command):
                 LOG.error(_("Failed to clean volume properties: %s"), e)
                 result += 1
 
-        if parsed_args.property:
+        if parsed_args.properties:
             try:
                 volume_client.volumes.set_metadata(
-                    volume.id, parsed_args.property
+                    volume.id, parsed_args.properties
                 )
             except Exception as e:
-                LOG.error(_("Failed to set volume property: %s"), e)
+                LOG.error(_("Failed to set volume properties: %s"), e)
                 result += 1
-        if parsed_args.image_property:
+
+        if parsed_args.image_properties:
             try:
                 volume_client.volumes.set_image_metadata(
-                    volume.id, parsed_args.image_property
+                    volume.id, parsed_args.image_properties
                 )
             except Exception as e:
-                LOG.error(_("Failed to set image property: %s"), e)
+                LOG.error(_("Failed to set image properties: %s"), e)
                 result += 1
+
         if parsed_args.state:
             try:
                 volume_client.volumes.reset_state(volume.id, parsed_args.state)
             except Exception as e:
                 LOG.error(_("Failed to set volume state: %s"), e)
                 result += 1
+
         if parsed_args.attached:
             try:
                 volume_client.volumes.reset_state(
@@ -826,6 +1019,7 @@ class SetVolume(command.Command):
             except Exception as e:
                 LOG.error(_("Failed to set volume attach-status: %s"), e)
                 result += 1
+
         if parsed_args.detached:
             try:
                 volume_client.volumes.reset_state(
@@ -834,7 +1028,8 @@ class SetVolume(command.Command):
             except Exception as e:
                 LOG.error(_("Failed to set volume attach-status: %s"), e)
                 result += 1
-        if parsed_args.bootable or parsed_args.non_bootable:
+
+        if parsed_args.bootable is not None:
             try:
                 volume_client.volumes.set_bootable(
                     volume.id, parsed_args.bootable
@@ -842,7 +1037,8 @@ class SetVolume(command.Command):
             except Exception as e:
                 LOG.error(_("Failed to set volume bootable property: %s"), e)
                 result += 1
-        if parsed_args.read_only or parsed_args.read_write:
+
+        if parsed_args.read_only is not None:
             try:
                 volume_client.volumes.update_readonly_flag(
                     volume.id, parsed_args.read_only
@@ -853,6 +1049,7 @@ 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
@@ -919,24 +1116,13 @@ class ShowVolume(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
-
-        # Special mapping for columns to make the output easier to read:
-        # 'metadata' --> 'properties'
-        # 'volume_type' --> 'type'
-        volume._info.update(
-            {
-                'properties': format_columns.DictColumn(
-                    volume._info.pop('metadata')
-                ),
-                'type': volume._info.pop('volume_type'),
-            },
+        volume_client = self.app.client_manager.sdk_connection.volume
+        volume = volume_client.find_volume(
+            parsed_args.volume, ignore_missing=False
         )
 
-        # Remove key links from being displayed
-        volume._info.pop("links", None)
-        return zip(*sorted(volume._info.items()))
+        data = _format_volume(volume)
+        return zip(*sorted(data.items()))
 
 
 class UnsetVolume(command.Command):
@@ -953,6 +1139,7 @@ class UnsetVolume(command.Command):
             '--property',
             metavar='<key>',
             action='append',
+            dest='properties',
             help=_(
                 'Remove a property from volume '
                 '(repeat option to remove multiple properties)'
@@ -962,6 +1149,7 @@ class UnsetVolume(command.Command):
             '--image-property',
             metavar='<key>',
             action='append',
+            dest='image_properties',
             help=_(
                 'Remove an image property from volume '
                 '(repeat option to remove multiple image properties)'
@@ -974,22 +1162,22 @@ class UnsetVolume(command.Command):
         volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
 
         result = 0
-        if parsed_args.property:
+        if parsed_args.properties:
             try:
                 volume_client.volumes.delete_metadata(
-                    volume.id, parsed_args.property
+                    volume.id, parsed_args.properties
                 )
             except Exception as e:
-                LOG.error(_("Failed to unset volume property: %s"), e)
+                LOG.error(_("Failed to unset volume properties: %s"), e)
                 result += 1
 
-        if parsed_args.image_property:
+        if parsed_args.image_properties:
             try:
                 volume_client.volumes.delete_image_metadata(
-                    volume.id, parsed_args.image_property
+                    volume.id, parsed_args.image_properties
                 )
             except Exception as e:
-                LOG.error(_("Failed to unset image property: %s"), e)
+                LOG.error(_("Failed to unset image properties: %s"), e)
                 result += 1
 
         if result > 0: