python-openstackclient 9.0.0__py3-none-any.whl → 10.1.0__py3-none-any.whl

openstackclient/volume/v3/volume.py

@@ -15,10 +15,11 @@
 """Volume V3 Volume action implementations"""
 
 import argparse
+from collections.abc import Iterable, Sequence
 import copy
 import functools
 import logging
-import typing as ty
+from typing import Any
 
 from cliff import columns as cliff_columns
 from openstack.block_storage.v3 import volume as _volume
@@ -44,14 +45,20 @@ class KeyValueHintAction(argparse.Action):
 
     APPEND_KEYS = ('same_host', 'different_host')
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
         self._key_value_action = parseractions.KeyValueAction(*args, **kwargs)
         self._key_value_append_action = parseractions.KeyValueAppendAction(
             *args, **kwargs
         )
         super().__init__(*args, **kwargs)
 
-    def __call__(self, parser, namespace, values, option_string=None):
+    def __call__(
+        self,
+        parser: argparse.ArgumentParser,
+        namespace: argparse.Namespace,
+        values: Any,
+        option_string: str | None = None,
+    ) -> None:
         if values.startswith(self.APPEND_KEYS):
             self._key_value_append_action(
                 parser, namespace, values, option_string=option_string
@@ -62,7 +69,7 @@ class KeyValueHintAction(argparse.Action):
             )
 
 
-class AttachmentsColumn(cliff_columns.FormattableColumn[list[ty.Any]]):
+class AttachmentsColumn(cliff_columns.FormattableColumn[list[Any]]):
     """Formattable column for attachments column.
 
     Unlike the parent FormattableColumn class, the initializer of the
@@ -73,11 +80,13 @@ class AttachmentsColumn(cliff_columns.FormattableColumn[list[ty.Any]]):
     ``functools.partial(AttachmentsColumn, server_cache)``.
     """
 
-    def __init__(self, value, server_cache=None):
+    def __init__(
+        self, value: list[Any], server_cache: dict[str, Any] | None = None
+    ) -> None:
         super().__init__(value)
         self._server_cache = server_cache or {}
 
-    def human_readable(self):
+    def human_readable(self) -> str:
         """Return a formatted string of a volume's attached instances
 
         :rtype: a string of formatted instances
@@ -93,7 +102,7 @@ class AttachmentsColumn(cliff_columns.FormattableColumn[list[ty.Any]]):
         return msg
 
 
-def _format_volume(volume: _volume.Volume) -> dict[str, ty.Any]:
+def _format_volume(volume: _volume.Volume) -> dict[str, object]:
     # Some columns returned by openstacksdk should not be shown because they're
     # either irrelevant or duplicates
     ignored_columns = {
@@ -143,7 +152,7 @@ class CreateVolume(command.ShowOne):
     _description = _("Create new volume")
 
     @staticmethod
-    def _check_size_arg(args):
+    def _check_size_arg(args: argparse.Namespace) -> None:
         """Check whether --size option is required or not.
 
         Require size parameter in case if any of the following is not
@@ -164,7 +173,7 @@ class CreateVolume(command.ShowOne):
             )
             raise exceptions.CommandError(msg)
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "name",
@@ -313,7 +322,9 @@ class CreateVolume(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         self._check_size_arg(parsed_args)
         # size is validated in the above call to
         # _check_size_arg where we check that size
@@ -321,7 +332,9 @@ class CreateVolume(command.ShowOne):
         # volume from snapshot, backup or source volume
         size = parsed_args.size
 
-        volume_client = self.app.client_manager.sdk_connection.volume
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
         image_client = self.app.client_manager.image
 
         if (
@@ -386,7 +399,8 @@ class CreateVolume(command.ShowOne):
                 bootable=parsed_args.bootable,
             )
             data = _format_volume(volume)
-            return zip(*sorted(data.items()))
+            col_headers, col_data = zip(*sorted(data.items()))
+            return col_headers, col_data
 
         source_volume = None
         if parsed_args.source:
@@ -491,13 +505,14 @@ class CreateVolume(command.ShowOne):
                 )
 
         data = _format_volume(volume)
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class DeleteVolume(command.Command):
     _description = _("Delete volume(s)")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "volumes",
@@ -535,8 +550,10 @@ class DeleteVolume(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
         result = 0
 
         if parsed_args.remote and (parsed_args.force or parsed_args.cascade):
@@ -581,7 +598,7 @@ class DeleteVolume(command.Command):
 class ListVolume(command.Lister):
     _description = _("List volumes")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--project',
@@ -627,10 +644,14 @@ class ListVolume(command.Lister):
             default=False,
             help=_('List additional fields in output'),
         )
-        pagination.add_marker_pagination_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(
+            parser, include_max_items=False
+        )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         volume_client = self.app.client_manager.volume
         identity_client = self.app.client_manager.identity
 
@@ -706,7 +727,7 @@ class ListVolume(command.Lister):
                 compute_client = self.app.client_manager.compute
                 for s in compute_client.servers():
                     server_cache[s.id] = s
-            except sdk_exceptions.SDKException:  # noqa: S110
+            except sdk_exceptions.SDKException:
                 # Just forget it if there's any trouble
                 pass
         AttachmentsColumnWithCache = functools.partial(
@@ -736,21 +757,29 @@ class ListVolume(command.Lister):
 class MigrateVolume(command.Command):
     _description = _("Migrate volume to a new host")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
             metavar="<volume>",
             help=_("Volume to migrate (name or ID)"),
         )
-        parser.add_argument(
+        destination_group = parser.add_mutually_exclusive_group(required=True)
+        destination_group.add_argument(
             '--host',
             metavar="<host>",
-            required=True,
             help=_(
                 "Destination host (takes the form: host@backend-name#pool)"
             ),
         )
+        destination_group.add_argument(
+            '--cluster',
+            metavar="<cluster>",
+            help=_(
+                "Destination cluster to migrate the volume to "
+                "(requires --os-volume-api-version 3.16 or higher)"
+            ),
+        )
         parser.add_argument(
             '--force-host-copy',
             action="store_true",
@@ -768,26 +797,38 @@ 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.sdk_connection.volume
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
         volume = volume_client.find_volume(
             parsed_args.volume, ignore_missing=False
         )
+
+        if parsed_args.cluster and not sdk_utils.supports_microversion(
+            volume_client, '3.16'
+        ):
+            msg = _(
+                "--os-volume-api-version 3.16 or greater is required to "
+                "support the volume migration with cluster"
+            )
+            raise exceptions.CommandError(msg)
+
         volume_client.migrate_volume(
             volume.id,
             host=parsed_args.host,
             force_host_copy=parsed_args.force_host_copy,
             lock_volume=parsed_args.lock_volume,
+            cluster=parsed_args.cluster,
         )
 
 
 class SetVolume(command.Command):
     _description = _("Set volume properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
@@ -940,7 +981,7 @@ class SetVolume(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
 
@@ -1113,7 +1154,7 @@ class SetVolume(command.Command):
 class ShowVolume(command.ShowOne):
     _description = _("Display volume details")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
@@ -1122,20 +1163,25 @@ class ShowVolume(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
         volume = volume_client.find_volume(
             parsed_args.volume, ignore_missing=False
         )
 
         data = _format_volume(volume)
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class UnsetVolume(command.Command):
     _description = _("Unset volume properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
@@ -1164,7 +1210,7 @@ class UnsetVolume(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
 
@@ -1196,7 +1242,7 @@ class UnsetVolume(command.Command):
 class VolumeSummary(command.ShowOne):
     _description = _("Show a summary of all volumes in this deployment.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--all-projects',
@@ -1206,8 +1252,12 @@ class VolumeSummary(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.12'):
             msg = _(
@@ -1246,7 +1296,7 @@ class VolumeSummary(command.ShowOne):
 class VolumeRevertToSnapshot(command.Command):
     _description = _("Revert a volume to a snapshot.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'snapshot',
@@ -1258,8 +1308,10 @@ class VolumeRevertToSnapshot(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.40'):
             msg = _(

openstackclient/volume/v3/volume_attachment.py

@@ -10,9 +10,12 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
-import typing as ty
+from typing import Any
 
+from openstack.block_storage.v3 import attachment as _attachment
 from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
@@ -32,7 +35,9 @@ _FILTER_DEPRECATED = _(
 )
 
 
-def _format_attachment(attachment):
+def _format_attachment(
+    attachment: _attachment.Attachment,
+) -> tuple[tuple[str, ...], Iterable[Any]]:
     columns = (
         'id',
         'volume_id',
@@ -57,7 +62,7 @@ def _format_attachment(attachment):
     # VolumeAttachmentManager.create returns a dict while everything else
     # returns a VolumeAttachment object
     if isinstance(attachment, dict):
-        data: tuple[ty.Any, ...] = ()
+        data: tuple[Any, ...] = ()
         for column in columns:
             if column == 'connection_info':
                 data += (format_columns.DictColumn(attachment[column]),)
@@ -88,7 +93,7 @@ class CreateVolumeAttachment(command.ShowOne):
     add volume' command should be preferred.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
@@ -171,8 +176,12 @@ class CreateVolumeAttachment(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
         compute_client = self.app.client_manager.compute
 
         if not sdk_utils.supports_microversion(volume_client, '3.27'):
@@ -249,7 +258,7 @@ class DeleteVolumeAttachment(command.Command):
     remove' command should be preferred.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'attachment',
@@ -258,8 +267,10 @@ class DeleteVolumeAttachment(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.27'):
             msg = _(
@@ -280,7 +291,7 @@ class SetVolumeAttachment(command.ShowOne):
     connected to.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'attachment',
@@ -332,8 +343,12 @@ class SetVolumeAttachment(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.27'):
             msg = _(
@@ -363,7 +378,7 @@ class SetVolumeAttachment(command.ShowOne):
 class CompleteVolumeAttachment(command.Command):
     """Complete an attachment for a volume."""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'attachment',
@@ -372,8 +387,10 @@ class CompleteVolumeAttachment(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.44'):
             msg = _(
@@ -388,7 +405,7 @@ class CompleteVolumeAttachment(command.Command):
 class ListVolumeAttachment(command.Lister):
     """Lists all volume attachments."""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--project',
@@ -432,8 +449,12 @@ class ListVolumeAttachment(command.Lister):
         # )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
         identity_client = self.app.client_manager.identity
 
         if not sdk_utils.supports_microversion(volume_client, '3.27'):
@@ -466,6 +487,7 @@ class ListVolumeAttachment(command.Lister):
             search_opts=search_opts,
             marker=parsed_args.marker,
             limit=parsed_args.limit,
+            max_items=parsed_args.max_items,
         )
 
         column_headers = (
@@ -490,7 +512,7 @@ class ListVolumeAttachment(command.Lister):
 class ShowVolumeAttachment(command.ShowOne):
     """Show detailed information for a volume attachment."""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'attachment',
@@ -499,8 +521,12 @@ class ShowVolumeAttachment(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.27'):
             msg = _(

openstackclient/volume/v3/volume_backend.py

@@ -0,0 +1,130 @@
+#
+#   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.
+#
+
+"""Storage backend action implementations"""
+
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
+from openstack import utils as sdk_utils
+from osc_lib.cli import format_columns
+from osc_lib import utils
+
+from openstackclient import command
+from openstackclient.i18n import _
+
+
+class ShowCapability(command.Lister):
+    _description = _("Show capability command")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "host",
+            metavar="<host>",
+            help=_("List capabilities of specified host (host@backend-name)"),
+        )
+        return parser
+
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
+
+        columns = [
+            'Title',
+            'Key',
+            'Type',
+            'Description',
+        ]
+
+        data = volume_client.get_capabilities(parsed_args.host)
+
+        # The get capabilities API is... interesting. We only want the names of
+        # the capabilities that can set for a backend through extra specs, so
+        # we need to extract out that part of the mess that is returned.
+        print_data = []
+        keys = data.properties
+        for key in keys:
+            # Stuff the key into the details to make it easier to output
+            capability_data = data.properties[key]
+            capability_data['key'] = key
+            print_data.append(capability_data)
+
+        return (
+            columns,
+            (
+                utils.get_dict_properties(
+                    s,
+                    columns,
+                )
+                for s in print_data
+            ),
+        )
+
+
+class ListPool(command.Lister):
+    _description = _("List pool command")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "--long",
+            action="store_true",
+            default=False,
+            help=_("Show detailed information about pools."),
+        )
+        # TODO(smcginnis): Starting with Cinder microversion 3.33, user is also
+        # able to pass in --filters with a <key>=<value> pair to filter on.
+        return parser
+
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
+
+        if parsed_args.long:
+            columns = [
+                'name',
+                'capabilities',
+            ]
+
+            headers = [
+                'Name',
+                'Capabilities',
+            ]
+        else:
+            columns = [
+                'Name',
+            ]
+            headers = columns
+
+        data = volume_client.backend_pools(detailed=parsed_args.long)
+        formatters = {'capabilities': format_columns.DictColumn}
+        return (
+            headers,
+            (
+                utils.get_item_properties(
+                    s,
+                    columns,
+                    formatters=formatters,
+                )
+                for s in data
+            ),
+        )