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

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)

openstackclient/compute/v2/server_volume.py

@@ -14,6 +14,10 @@
 
 """Compute v2 Server action implementations"""
 
+import argparse
+from collections.abc import Iterable
+from typing import Any
+
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
@@ -25,7 +29,7 @@ from openstackclient.i18n import _
 class ListServerVolume(command.Lister):
     """List all the volumes attached to a server."""
 
-    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',
@@ -33,7 +37,9 @@ class ListServerVolume(command.Lister):
         )
         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
 
         server = compute_client.find_server(
@@ -81,7 +87,7 @@ class ListServerVolume(command.Lister):
 class SetServerVolume(command.Command):
     """Update a volume attachment on the server."""
 
-    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',
@@ -113,9 +119,11 @@ class SetServerVolume(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
-        volume_client = self.app.client_manager.sdk_connection.volume
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         if parsed_args.delete_on_termination is not None:
             if not sdk_utils.supports_microversion(compute_client, '2.85'):

openstackclient/compute/v2/service.py

@@ -15,7 +15,10 @@
 
 """Service action implementations"""
 
+import argparse
+from collections.abc import Iterable
 import logging
+from typing import Any
 
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
@@ -31,7 +34,7 @@ LOG = logging.getLogger(__name__)
 class DeleteService(command.Command):
     _description = _("Delete compute service(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(
             "service",
@@ -51,7 +54,7 @@ class DeleteService(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 s in parsed_args.service:
@@ -84,7 +87,7 @@ value which can be used to uniquely identify the service in a multi-cell
 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(
             "--host",
@@ -107,7 +110,9 @@ deployment."""
         )
         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
         columns: tuple[str, ...] = (
             "id",
@@ -146,7 +151,7 @@ deployment."""
 class SetService(command.Command):
     _description = _("Set compute service 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("host", metavar="<host>", help=_("Name of host"))
         parser.add_argument(
@@ -192,7 +197,9 @@ class SetService(command.Command):
         return parser
 
     @staticmethod
-    def _find_service_by_host_and_binary(compute_client, host, binary):
+    def _find_service_by_host_and_binary(
+        compute_client: Any, host: str, binary: str
+    ) -> Any:
         """Utility method to find a compute service by host and binary
 
         :param host: the name of the compute service host
@@ -220,7 +227,7 @@ class SetService(command.Command):
             raise exceptions.CommandError(msg)
         return services[0]
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         compute_client = self.app.client_manager.compute
 
         if (
@@ -283,8 +290,10 @@ class SetService(command.Command):
                 msg = _('--os-compute-api-version 2.11 or later is required')
                 raise exceptions.CommandError(msg)
             try:
+                # FIXME(stephenfin): This is broken between 2.11 and 2.53. What
+                # is the expected ID here?
                 compute_client.update_service_forced_down(
-                    service_id,
+                    service_id,  # type: ignore[arg-type]
                     parsed_args.host,
                     parsed_args.service,
                     force_down,

openstackclient/compute/v2/usage.py

@@ -15,10 +15,11 @@
 
 """Usage action implementations"""
 
-from collections.abc import Collection
+import argparse
+from collections.abc import Collection, Iterable, Sequence
 import datetime
 import functools
-import typing as ty
+from typing import Any, cast
 
 from cliff import columns as cliff_columns
 from osc_lib import utils
@@ -40,32 +41,32 @@ class ProjectColumn(cliff_columns.FormattableColumn[str]):
     project_cache)`` to use this.
     """
 
-    def __init__(self, value, project_cache=None):
+    def __init__(self, value: str, project_cache: Any = None) -> None:
         super().__init__(value)
         self.project_cache = project_cache or {}
 
-    def human_readable(self):
+    def human_readable(self) -> str:
         project = self._value
         if not project:
             return ''
 
         if project in self.project_cache.keys():
-            return self.project_cache[project].name
+            return cast(str, self.project_cache[project].name)
 
         return project
 
 
-class CountColumn(cliff_columns.FormattableColumn[Collection[ty.Any]]):
-    def human_readable(self):
-        return len(self._value) if self._value is not None else None
+class CountColumn(cliff_columns.FormattableColumn[Collection[Any]]):
+    def human_readable(self) -> str:
+        return str(len(self._value)) if self._value is not None else ""
 
 
 class FloatColumn(cliff_columns.FormattableColumn[float]):
-    def human_readable(self):
-        return float(f"{self._value:.2f}")
+    def human_readable(self) -> str:
+        return f"{self._value:.2f}"
 
 
-def _formatters(project_cache):
+def _formatters(project_cache: Any) -> dict[str, Any]:
     return {
         'project_id': functools.partial(
             ProjectColumn, project_cache=project_cache
@@ -77,21 +78,21 @@ def _formatters(project_cache):
     }
 
 
-def _get_usage_marker(usage):
+def _get_usage_marker(usage: Any) -> str | None:
     marker = None
     if hasattr(usage, 'server_usages') and usage.server_usages:
         marker = usage.server_usages[-1]['instance_id']
     return marker
 
 
-def _get_usage_list_marker(usage_list):
+def _get_usage_list_marker(usage_list: Any) -> str | None:
     marker = None
     if usage_list:
         marker = _get_usage_marker(usage_list[-1])
     return marker
 
 
-def _merge_usage(usage, next_usage):
+def _merge_usage(usage: Any, next_usage: Any) -> None:
     usage.server_usages.extend(next_usage.server_usages)
     usage.total_hours += next_usage.total_hours
     usage.total_memory_mb_usage += next_usage.total_memory_mb_usage
@@ -99,7 +100,7 @@ def _merge_usage(usage, next_usage):
     usage.total_local_gb_usage += next_usage.total_local_gb_usage
 
 
-def _merge_usage_list(usages, next_usage_list):
+def _merge_usage_list(usages: Any, next_usage_list: Any) -> None:
     for next_usage in next_usage_list:
         if next_usage.project_id in usages:
             _merge_usage(usages[next_usage.project_id], next_usage)
@@ -110,7 +111,7 @@ def _merge_usage_list(usages, next_usage_list):
 class ListUsage(command.Lister):
     _description = _("List resource usage per project")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--start",
@@ -128,12 +129,14 @@ class ListUsage(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        def _format_project(project):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        def _format_project(project: str) -> str:
             if not project:
                 return ""
             if project in project_cache.keys():
-                return project_cache[project].name
+                return cast(str, project_cache[project].name)
             else:
                 return project
 
@@ -154,7 +157,7 @@ class ListUsage(command.Lister):
         )
 
         date_cli_format = "%Y-%m-%d"
-        now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
+        now = datetime.datetime.now(datetime.UTC).replace(tzinfo=None)
 
         if parsed_args.start:
             start = datetime.datetime.strptime(
@@ -210,7 +213,7 @@ class ListUsage(command.Lister):
 class ShowUsage(command.ShowOne):
     _description = _("Show resource usage for a single project")
 
-    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",
@@ -234,11 +237,13 @@ class ShowUsage(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         identity_client = self.app.client_manager.identity
         compute_client = self.app.client_manager.compute
         date_cli_format = "%Y-%m-%d"
-        now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
+        now = datetime.datetime.now(datetime.UTC).replace(tzinfo=None)
 
         if parsed_args.start:
             start = datetime.datetime.strptime(

openstackclient/identity/client.py

@@ -12,7 +12,9 @@
 #   License for the specific language governing permissions and limitations
 #   under the License.
 
+import argparse
 import logging
+from typing import Any
 
 from keystoneclient.v2_0 import client as identity_client_v2
 from osc_lib import utils
@@ -39,7 +41,7 @@ AUTH_VERSIONS = {
 }
 
 
-def make_client(instance):
+def make_client(instance: Any) -> Any:
     """Returns an identity service client."""
     identity_client = utils.get_client_class(
         API_NAME, instance._api_version[API_NAME], API_VERSIONS
@@ -56,7 +58,9 @@ def make_client(instance):
     return client
 
 
-def build_option_parser(parser):
+def build_option_parser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
     """Hook to add global options"""
     parser.add_argument(
         '--os-identity-api-version',
@@ -70,10 +74,11 @@ def build_option_parser(parser):
     return parser
 
 
+# We're not going to add type hints to this at this point
 class IdentityClientv2(identity_client_v2.Client):
     """Tweak the earlier client class to deal with some changes"""
 
-    def __getattr__(self, name):
+    def __getattr__(self, name: str) -> Any:
         # Map v3 'projects' back to v2 'tenants'
         if name == "projects":
             return self.tenants