python-openstackclient 8.3.0__py3-none-any.whl → 10.0.0__py3-none-any.whl

openstackclient/compute/v2/server_backup.py

@@ -15,7 +15,10 @@
 
 """Compute v2 Server action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import importlib
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -32,7 +35,7 @@ class CreateServerBackup(command.ShowOne):
         "2": "openstackclient.image.v2.image",
     }
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
@@ -65,8 +68,10 @@ class CreateServerBackup(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        def _show_progress(progress):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        def _show_progress(progress: int | None) -> None:
             if progress:
                 self.app.stderr.write(f'\rProgress: {progress}')
                 self.app.stderr.flush()
@@ -124,4 +129,5 @@ class CreateServerBackup(command.ShowOne):
                 ]
             )
             info = image_module._format_image(image)
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data

openstackclient/compute/v2/server_event.py

@@ -15,7 +15,10 @@
 
 """Compute v2 Server operation event implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 import uuid
 
 from cliff import columns
@@ -34,7 +37,7 @@ LOG = logging.getLogger(__name__)
 
 # TODO(stephenfin): Move this to osc_lib since it's useful elsewhere (e.g.
 # glance)
-def is_uuid_like(value) -> bool:
+def is_uuid_like(value: str) -> bool:
     """Returns validation of a value as a UUID.
 
     :param val: Value to verify
@@ -57,14 +60,14 @@ def is_uuid_like(value) -> bool:
         return False
 
 
-class ServerActionEventColumn(columns.FormattableColumn):
+class ServerActionEventColumn(columns.FormattableColumn[Any]):
     """Custom formatter for server action events.
 
     Format the :class:`~openstack.compute.v2.server_action.ServerActionEvent`
     objects as we'd like.
     """
 
-    def _format_event(self, event):
+    def _format_event(self, event: Any) -> dict[str, Any]:
         hidden_columns = ['id', 'name', 'location']
         _, columns = utils.get_osc_show_columns_for_sdk_resource(
             event, {}, hidden_columns
@@ -72,17 +75,19 @@ class ServerActionEventColumn(columns.FormattableColumn):
         data = utils.get_item_properties(event, columns)
         return dict(zip(columns, data))
 
-    def human_readable(self):
+    def human_readable(self) -> str:
         events = [self._format_event(event) for event in self._value]
-        return utils.format_list_of_dicts(events)
+        return utils.format_list_of_dicts(events) or ""
 
-    def machine_readable(self):
+    def machine_readable(self) -> Any:
         events = [self._format_event(event) for event in self._value]
         return events
 
 
-def _get_server_event_columns(item, client):
-    hidden_columns = ['name', 'server_id', 'links', 'location', 'finish_time']
+def _get_server_event_columns(
+    item: Any, client: Any
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
+    hidden_columns = ['name', 'server_id', 'links', 'location']
 
     if not sdk_utils.supports_microversion(client, '2.58'):
         # updated_at was introduced in 2.58
@@ -100,7 +105,7 @@ class ListServerEvent(command.Lister):
     deleted server, specified by ID only.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
@@ -138,7 +143,9 @@ class ListServerEvent(command.Lister):
         pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         compute_client = self.app.client_manager.compute
 
         kwargs = {}
@@ -251,7 +258,7 @@ class ShowServerEvent(command.ShowOne):
     non-admin users.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
@@ -265,7 +272,9 @@ class ShowServerEvent(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         compute_client = self.app.client_manager.compute
 
         try:

openstackclient/compute/v2/server_group.py

@@ -15,8 +15,10 @@
 
 """Compute v2 Server Group action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
-import typing as ty
+from typing import Any
 
 from cliff import columns
 from openstack import utils as sdk_utils
@@ -32,14 +34,16 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-_formatters: dict[str, type[columns.FormattableColumn[ty.Any]]] = {
+_formatters: dict[str, type[columns.FormattableColumn[Any]]] = {
     'member_ids': format_columns.ListColumn,
     'policies': format_columns.ListColumn,
     'rules': format_columns.DictColumn,
 }
 
 
-def _get_server_group_columns(item, client):
+def _get_server_group_columns(
+    item: Any, client: Any
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {'member_ids': 'members'}
     hidden_columns = ['metadata', 'location']
 
@@ -57,7 +61,7 @@ def _get_server_group_columns(item, client):
 class CreateServerGroup(command.ShowOne):
     _description = _("Create a new server group.")
 
-    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',
@@ -94,7 +98,9 @@ class CreateServerGroup(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         compute_client = self.app.client_manager.compute
 
         if parsed_args.policy in ('soft-affinity', 'soft-anti-affinity'):
@@ -144,7 +150,7 @@ class CreateServerGroup(command.ShowOne):
 class DeleteServerGroup(command.Command):
     _description = _("Delete existing server group(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(
             'server_group',
@@ -154,7 +160,7 @@ class DeleteServerGroup(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         compute_client = self.app.client_manager.compute
         result = 0
         for group in parsed_args.server_group:
@@ -179,7 +185,7 @@ class DeleteServerGroup(command.Command):
 class ListServerGroup(command.Lister):
     _description = _("List all server groups.")
 
-    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',
@@ -198,7 +204,9 @@ class ListServerGroup(command.Lister):
         pagination.add_offset_pagination_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         compute_client = self.app.client_manager.compute
 
         kwargs = {}
@@ -256,7 +264,7 @@ class ListServerGroup(command.Lister):
 class ShowServerGroup(command.ShowOne):
     _description = _("Display server group 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(
             'server_group',
@@ -265,7 +273,9 @@ class ShowServerGroup(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         compute_client = self.app.client_manager.compute
         group = compute_client.find_server_group(
             parsed_args.server_group, ignore_missing=False

openstackclient/compute/v2/server_image.py

@@ -15,8 +15,11 @@
 
 """Compute v2 Server action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import importlib
 import logging
+from typing import Any
 
 from osc_lib.cli import parseractions
 from osc_lib import exceptions
@@ -37,7 +40,7 @@ class CreateServerImage(command.ShowOne):
         "2": "openstackclient.image.v2.image",
     }
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
@@ -66,8 +69,10 @@ class CreateServerImage(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        def _show_progress(progress):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        def _show_progress(progress: int | None) -> None:
             if progress:
                 self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
@@ -85,11 +90,16 @@ class CreateServerImage(command.ShowOne):
         else:
             image_name = server.name
 
-        image_id = compute_client.create_server_image(
+        image = compute_client.create_server_image(
             server.id,
             image_name,
             parsed_args.properties,
-        ).id
+        )
+        if not image:
+            msg = _('Error creating server image: %s')
+            raise exceptions.CommandError(msg, parsed_args.server)
+
+        image_id = image.id
 
         if parsed_args.wait:
             if utils.wait_for_status(
@@ -99,10 +109,8 @@ class CreateServerImage(command.ShowOne):
             ):
                 self.app.stdout.write('\n')
             else:
-                LOG.error(
-                    _('Error creating server image: %s'), parsed_args.server
-                )
-                raise exceptions.CommandError
+                msg = _('Error creating server image: %s')
+                raise exceptions.CommandError(msg, parsed_args.server)
 
         image = image_client.find_image(image_id, ignore_missing=False)
 
@@ -119,4 +127,5 @@ class CreateServerImage(command.ShowOne):
             )
             info = image_module._format_image(image)
 
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data

openstackclient/compute/v2/server_migration.py

@@ -12,6 +12,9 @@
 
 """Compute v2 Server Migration action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
 import uuid
 
 from openstack import utils as sdk_utils
@@ -27,7 +30,7 @@ from openstackclient.identity import common as identity_common
 class ListMigration(command.Lister):
     _description = _("""List server migrations""")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--server',
@@ -98,7 +101,12 @@ class ListMigration(command.Lister):
         identity_common.add_user_domain_option_to_parser(parser)
         return parser
 
-    def print_migrations(self, parsed_args, compute_client, migrations):
+    def print_migrations(
+        self,
+        parsed_args: argparse.Namespace,
+        compute_client: Any,
+        migrations: Any,
+    ) -> tuple[list[str], Iterable[tuple[Any, ...]]]:
         column_headers = [
             'Source Node',
             'Dest Node',
@@ -153,7 +161,9 @@ class ListMigration(command.Lister):
             (utils.get_item_properties(mig, columns) for mig in migrations),
         )
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[list[str], Iterable[tuple[Any, ...]]]:
         compute_client = self.app.client_manager.compute
         identity_client = self.app.client_manager.identity
 
@@ -248,7 +258,9 @@ class ListMigration(command.Lister):
         return self.print_migrations(parsed_args, compute_client, migrations)
 
 
-def _get_migration_by_uuid(compute_client, server_id, migration_uuid):
+def _get_migration_by_uuid(
+    compute_client: Any, server_id: str, migration_uuid: str
+) -> Any:
     for migration in compute_client.server_migrations(server_id):
         if migration.uuid == migration_uuid:
             return migration
@@ -274,7 +286,7 @@ class ShowMigration(command.ShowOne):
     these.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
@@ -288,7 +300,9 @@ class ShowMigration(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         compute_client = self.app.client_manager.compute
 
         if not sdk_utils.supports_microversion(compute_client, '2.24'):
@@ -389,7 +403,7 @@ class AbortMigration(command.Command):
     This command requires ``--os-compute-api-version`` 2.24 or greater.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
@@ -403,7 +417,7 @@ class AbortMigration(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         compute_client = self.app.client_manager.compute
 
         if not sdk_utils.supports_microversion(compute_client, '2.24'):
@@ -456,7 +470,7 @@ class ForceCompleteMigration(command.Command):
     This command requires ``--os-compute-api-version`` 2.22 or greater.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
@@ -468,7 +482,7 @@ class ForceCompleteMigration(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         compute_client = self.app.client_manager.compute
 
         if not sdk_utils.supports_microversion(compute_client, '2.22'):

openstackclient/compute/v2/server_share.py

@@ -0,0 +1,274 @@
+# Copyright 2020, Red Hat Inc.
+#
+# 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.
+
+"""Compute v2 Server action implementations"""
+
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
+from openstack import utils as sdk_utils
+from osc_lib import exceptions
+from osc_lib import utils
+
+from openstackclient import command
+from openstackclient.i18n import _
+
+
+def _get_server_share_columns(
+    item: Any,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
+    # Non admin cannot see uuid and export location, so hide them
+    if item.uuid is None:
+        column_map = {
+            'share_id': 'Share ID',
+            'status': 'Status',
+            'tag': 'Tag',
+        }
+        hidden_columns = [
+            'id',
+            'location',
+            'name',
+            'uuid',
+            'export_location',
+            'share_proto',
+        ]
+    else:
+        column_map = {
+            'uuid': 'UUID',
+            'share_id': 'Share ID',
+            'status': 'Status',
+            'tag': 'Tag',
+            'export_location': 'Export Location',
+        }
+        hidden_columns = ['id', 'location', 'name', 'share_proto']
+
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item, column_map, hidden_columns
+    )
+
+
+class ListServerShare(command.Lister):
+    """List all the shares attached to a server.
+
+    Requires ``--os-compute-api-version 2.97`` or later.
+    """
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'server',
+            metavar='<server>',
+            help=_('Server to list share mapping for (name or ID)'),
+        )
+        return parser
+
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        compute_client = self.app.client_manager.compute
+
+        if not sdk_utils.supports_microversion(compute_client, '2.97'):
+            msg = _(
+                '--os-compute-api-version 2.97 or greater is required '
+                'to support share attachments'
+            )
+            raise exceptions.CommandError(msg)
+
+        server = compute_client.find_server(
+            parsed_args.server,
+            ignore_missing=False,
+        )
+        shares = compute_client.share_attachments(server)
+
+        columns = (
+            'share_id',
+            'status',
+            'tag',
+        )
+        column_headers = (
+            'Share ID',
+            'Status',
+            'Tag',
+        )
+
+        return (
+            column_headers,
+            (utils.get_item_properties(s, columns) for s in shares),
+        )
+
+
+class ShowServerShare(command.ShowOne):
+    """Show detail of a share attachment to a server.
+
+    Requires ``--os-compute-api-version 2.97`` or later.
+    """
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'server',
+            metavar='<server>',
+            help=_('Server to show share mapping for (name or ID)'),
+        )
+        parser.add_argument(
+            'share',
+            metavar='<share>',
+            help=_('Share to show details for (name or ID)'),
+        )
+        return parser
+
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        compute_client = self.app.client_manager.compute
+        shared_file_system_client = (
+            self.app.client_manager.sdk_connection.shared_file_system
+        )
+
+        if not sdk_utils.supports_microversion(compute_client, '2.97'):
+            msg = _(
+                '--os-compute-api-version 2.97 or greater is required '
+                'to support share attachments'
+            )
+            raise exceptions.CommandError(msg)
+
+        server = compute_client.find_server(
+            parsed_args.server,
+            ignore_missing=False,
+        )
+        share = shared_file_system_client.find_share(
+            parsed_args.share,
+            ignore_missing=False,
+        )
+        share_attachment = compute_client.get_share_attachment(
+            server, share.id
+        )
+
+        display_columns, columns = _get_server_share_columns(
+            share_attachment,
+        )
+        data = utils.get_item_properties(share_attachment, columns)
+        return display_columns, data
+
+
+class AddServerShare(command.ShowOne):
+    """Add a share to a server.
+
+    Requires ``--os-compute-api-version 2.97`` or later.
+    """
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'server',
+            metavar='<server>',
+            help=_('Server to add share to (name or ID)'),
+        )
+        parser.add_argument(
+            'share',
+            metavar='<share>',
+            help=_('Share to add (name or ID)'),
+        )
+        parser.add_argument(
+            '--tag',
+            metavar='<tag>',
+            help=_(
+                'Optional tag used to mount the share, '
+                'if not provided the share uuid is used as tag by default'
+            ),
+        )
+        return parser
+
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        compute_client = self.app.client_manager.compute
+        shared_file_system_client = (
+            self.app.client_manager.sdk_connection.shared_file_system
+        )
+
+        if not sdk_utils.supports_microversion(compute_client, '2.97'):
+            msg = _(
+                '--os-compute-api-version 2.97 or greater is required '
+                'to support share attachments'
+            )
+            raise exceptions.CommandError(msg)
+
+        server = compute_client.find_server(
+            parsed_args.server,
+            ignore_missing=False,
+        )
+        share = shared_file_system_client.find_share(
+            parsed_args.share,
+            ignore_missing=False,
+        )
+
+        kwargs: dict[str, Any] = {}
+        if parsed_args.tag:
+            kwargs['tag'] = parsed_args.tag
+
+        share_attachment = compute_client.create_share_attachment(
+            server, share.id, **kwargs
+        )
+
+        display_columns, columns = _get_server_share_columns(
+            share_attachment,
+        )
+        data = utils.get_item_properties(share_attachment, columns)
+        return display_columns, data
+
+
+class RemoveServerShare(command.Command):
+    """Remove a share from a server.
+
+    Requires ``--os-compute-api-version 2.97`` or later.
+    """
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'server',
+            metavar='<server>',
+            help=_('Server to remove share from (name or ID)'),
+        )
+        parser.add_argument(
+            'share',
+            metavar='<share>',
+            help=_('Share to remove (name or ID)'),
+        )
+        return parser
+
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        compute_client = self.app.client_manager.compute
+        shared_file_system_client = (
+            self.app.client_manager.sdk_connection.shared_file_system
+        )
+
+        if not sdk_utils.supports_microversion(compute_client, '2.97'):
+            msg = _(
+                '--os-compute-api-version 2.97 or greater is required '
+                'to support share attachments'
+            )
+            raise exceptions.CommandError(msg)
+
+        server = compute_client.find_server(
+            parsed_args.server,
+            ignore_missing=False,
+        )
+        share = shared_file_system_client.find_share(
+            parsed_args.share,
+            ignore_missing=False,
+        )
+        compute_client.delete_share_attachment(server, share.id)