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

openstackclient/identity/v3/identity_provider.py

@@ -13,8 +13,12 @@
 
 """Identity v3 IdentityProvider action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
 from osc_lib import utils
@@ -27,10 +31,35 @@ from openstackclient.identity import common
 LOG = logging.getLogger(__name__)
 
 
+def _format_identity_provider(idp):
+    columns = (
+        'authorization_ttl',
+        'description',
+        'domain_id',
+        'is_enabled',
+        'name',
+        'remote_ids',
+    )
+    column_headers = (
+        'authorization_ttl',
+        'description',
+        'domain_id',
+        'enabled',
+        'id',
+        'remote_ids',
+    )
+    return (
+        column_headers,
+        utils.get_item_properties(
+            idp, columns, formatters={'remote_ids': format_columns.ListColumn}
+        ),
+    )
+
+
 class CreateIdentityProvider(command.ShowOne):
     _description = _("Create new identity provider")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'identity_provider_id',
@@ -98,26 +127,34 @@ class CreateIdentityProvider(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-        remote_ids: list[str] | None = None
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
+        kwargs = {'is_enabled': parsed_args.enabled}
+        if parsed_args.identity_provider_id:
+            kwargs['id'] = parsed_args.identity_provider_id
+        if parsed_args.description:
+            kwargs['description'] = parsed_args.description
+
         if parsed_args.remote_id_file:
             file_content = utils.read_blob_file_contents(
                 parsed_args.remote_id_file
             )
             remote_ids = file_content.splitlines()
-            remote_ids = list(map(str.strip, remote_ids))
+            kwargs['remote_ids'] = list(map(str.strip, remote_ids))
         elif parsed_args.remote_ids:
-            remote_ids = parsed_args.remote_ids
+            kwargs['remote_ids'] = parsed_args.remote_ids
 
-        domain_id = None
         if parsed_args.domain:
-            domain_id = common.find_domain(
-                identity_client, parsed_args.domain
-            ).id
+            kwargs['domain_id'] = common.find_domain_id_sdk(
+                identity_client,
+                parsed_args.domain,
+                validate_actor_existence=False,
+            )
 
-        # TODO(pas-ha) actually check for 3.14 microversion
-        kwargs = {}
         auth_ttl = parsed_args.authorization_ttl
         if auth_ttl is not None:
             if auth_ttl < 0:
@@ -127,26 +164,15 @@ class CreateIdentityProvider(command.ShowOne):
                 raise exceptions.CommandError(msg)
             kwargs['authorization_ttl'] = auth_ttl
 
-        idp = identity_client.federation.identity_providers.create(
-            id=parsed_args.identity_provider_id,
-            remote_ids=remote_ids,
-            description=parsed_args.description,
-            domain_id=domain_id,
-            enabled=parsed_args.enabled,
-            **kwargs,
-        )
+        idp = identity_client.create_identity_provider(**kwargs)
 
-        idp._info.pop('links', None)
-        idp._info['remote_ids'] = format_columns.ListColumn(
-            idp._info.pop('remote_ids', [])
-        )
-        return zip(*sorted(idp._info.items()))
+        return _format_identity_provider(idp)
 
 
 class DeleteIdentityProvider(command.Command):
     _description = _("Delete identity provider(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(
             'identity_provider',
@@ -156,17 +182,19 @@ class DeleteIdentityProvider(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         result = 0
         for i in parsed_args.identity_provider:
             try:
-                identity_client.federation.identity_providers.delete(i)
+                identity_client.delete_identity_provider(i)
             except Exception as e:
                 result += 1
                 LOG.error(
                     _(
-                        "Failed to delete identity providers with "
+                        "Failed to delete identity provider with "
                         "name or ID '%(provider)s': %(e)s"
                     ),
                     {'provider': i, 'e': e},
@@ -183,34 +211,39 @@ class DeleteIdentityProvider(command.Command):
 class ListIdentityProvider(command.Lister):
     _description = _("List identity providers")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--id',
             metavar='<id>',
-            help=_('The Identity Providers’ ID attribute'),
+            help=_('Filter identity providers by ID'),
         )
         parser.add_argument(
             '--enabled',
             dest='enabled',
             action='store_true',
-            help=_('The Identity Providers that are enabled will be returned'),
+            help=_('List only enabled identity providers'),
         )
         return parser
 
-    def take_action(self, parsed_args):
-        columns = ('ID', 'Enabled', 'Domain ID', 'Description')
-        identity_client = self.app.client_manager.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        columns = ('id', 'is_enabled', 'domain_id', 'description')
+        column_headers = ('ID', 'Enabled', 'Domain ID', 'Description')
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
         if parsed_args.id:
             kwargs['id'] = parsed_args.id
         if parsed_args.enabled:
-            kwargs['enabled'] = True
+            kwargs['is_enabled'] = True
 
-        data = identity_client.federation.identity_providers.list(**kwargs)
+        data = identity_client.identity_providers(**kwargs)
         return (
-            columns,
+            column_headers,
             (
                 utils.get_item_properties(
                     s,
@@ -225,7 +258,7 @@ class ListIdentityProvider(command.Lister):
 class SetIdentityProvider(command.Command):
     _description = _("Set identity provider 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(
             'identity_provider',
@@ -279,8 +312,10 @@ class SetIdentityProvider(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        federation_client = self.app.client_manager.identity.federation
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         # Always set remote_ids if either is passed in
         if parsed_args.remote_id_file:
@@ -297,13 +332,14 @@ class SetIdentityProvider(command.Command):
         if parsed_args.description:
             kwargs['description'] = parsed_args.description
         if parsed_args.enable:
-            kwargs['enabled'] = True
+            kwargs['is_enabled'] = True
         if parsed_args.disable:
-            kwargs['enabled'] = False
+            kwargs['is_enabled'] = False
         if parsed_args.remote_id_file or parsed_args.remote_ids:
             kwargs['remote_ids'] = remote_ids
 
-        # TODO(pas-ha) actually check for 3.14 microversion
+        # NOTE(0weng): This is now possible in SDK! An option should be added.
+        # Original comment:
         # TODO(pas-ha) make it possible to reset authorization_ttl
         # back to None value.
         # Currently not possible as filter_kwargs decorator in
@@ -318,7 +354,7 @@ class SetIdentityProvider(command.Command):
                 raise exceptions.CommandError(msg)
             kwargs['authorization_ttl'] = auth_ttl
 
-        federation_client.identity_providers.update(
+        identity_client.update_identity_provider(
             parsed_args.identity_provider, **kwargs
         )
 
@@ -326,7 +362,7 @@ class SetIdentityProvider(command.Command):
 class ShowIdentityProvider(command.ShowOne):
     _description = _("Display identity provider 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(
             'identity_provider',
@@ -335,15 +371,14 @@ class ShowIdentityProvider(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-        idp = utils.find_resource(
-            identity_client.federation.identity_providers,
-            parsed_args.identity_provider,
-            id=parsed_args.identity_provider,
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
+        idp = identity_client.get_identity_provider(
+            parsed_args.identity_provider
         )
 
-        idp._info.pop('links', None)
-        remote_ids = format_columns.ListColumn(idp._info.pop('remote_ids', []))
-        idp._info['remote_ids'] = remote_ids
-        return zip(*sorted(idp._info.items()))
+        return _format_identity_provider(idp)

openstackclient/identity/v3/implied_role.py

@@ -15,7 +15,10 @@
 
 """Identity v3 Implied Role action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 
 from openstackclient import command
@@ -25,7 +28,9 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _get_role_ids(identity_client, parsed_args):
+def _get_role_ids(
+    identity_client: Any, parsed_args: argparse.Namespace
+) -> tuple[Any, Any]:
     """Return prior and implied role id(s)
 
     If prior and implied role id(s) are retrievable from identity
@@ -50,7 +55,7 @@ def _get_role_ids(identity_client, parsed_args):
 class CreateImpliedRole(command.ShowOne):
     _description = _("Creates an association between prior and implied roles")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'role',
@@ -65,7 +70,9 @@ class CreateImpliedRole(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
         (prior_role_id, implied_role_id) = _get_role_ids(
             identity_client, parsed_args
@@ -74,13 +81,16 @@ class CreateImpliedRole(command.ShowOne):
             prior_role_id, implied_role_id
         )
         response._info.pop('links', None)
-        return zip(*sorted([(k, v['id']) for k, v in response._info.items()]))
+        col_headers, col_data = zip(
+            *sorted([(k, v['id']) for k, v in response._info.items()])
+        )
+        return col_headers, col_data
 
 
 class DeleteImpliedRole(command.Command):
     _description = _("Deletes an association between prior and implied roles")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'role',
@@ -95,7 +105,7 @@ class DeleteImpliedRole(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
         (prior_role_id, implied_role_id) = _get_role_ids(
             identity_client, parsed_args
@@ -112,12 +122,14 @@ class ListImpliedRole(command.Lister):
         'Implied Role Name',
     ]
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         return parser
 
-    def take_action(self, parsed_args):
-        def _list_implied(response):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
+        def _list_implied(response: Any) -> Iterable[tuple[Any, ...]]:
             for rule in response:
                 for implies in rule.implies:
                     yield (

openstackclient/identity/v3/limit.py

@@ -13,8 +13,12 @@
 
 """Limits action implementations."""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+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.identity import common as common_utils
 LOG = logging.getLogger(__name__)
 
 
-def _format_limit(limit):
+def _format_limit(limit: Any) -> tuple[tuple[str, ...], Any]:
     columns = (
         "description",
         "id",
@@ -50,7 +54,7 @@ def _format_limit(limit):
 class CreateLimit(command.ShowOne):
     _description = _("Create a limit")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--description',
@@ -89,8 +93,12 @@ class CreateLimit(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {
             "resource_name": parsed_args.resource_name,
@@ -122,7 +130,7 @@ class CreateLimit(command.ShowOne):
 class ListLimit(command.Lister):
     _description = _("List limits")
 
-    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',
@@ -149,8 +157,12 @@ class ListLimit(command.Lister):
 
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
         if parsed_args.service:
@@ -199,7 +211,7 @@ class ListLimit(command.Lister):
 class ShowLimit(command.ShowOne):
     _description = _("Display limit 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(
             'limit_id',
@@ -208,8 +220,12 @@ class ShowLimit(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         limit = identity_client.get_limit(parsed_args.limit_id)
         return _format_limit(limit)
 
@@ -217,7 +233,7 @@ class ShowLimit(command.ShowOne):
 class SetLimit(command.ShowOne):
     _description = _("Update information about a limit")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'limit_id',
@@ -238,8 +254,12 @@ class SetLimit(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
         if parsed_args.description:
@@ -254,7 +274,7 @@ class SetLimit(command.ShowOne):
 class DeleteLimit(command.Command):
     _description = _("Delete a limit")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'limit_id',
@@ -267,8 +287,10 @@ class DeleteLimit(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         errors = 0
         for limit_id in parsed_args.limit_id:

openstackclient/identity/v3/mapping.py

@@ -15,8 +15,11 @@
 
 """Identity v3 federation mapping action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import json
 import logging
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -31,7 +34,7 @@ LOG = logging.getLogger(__name__)
 class _RulesReader:
     _description = _("Helper class capable of reading rules from files")
 
-    def _read_rules(self, path):
+    def _read_rules(self, path: str) -> Any:
         """Read and parse rules from path
 
         Expect the file to contain a valid JSON structure.
@@ -82,7 +85,9 @@ class _RulesReader:
             return rules
 
     @staticmethod
-    def add_federated_schema_version_option(parser):
+    def add_federated_schema_version_option(
+        parser: argparse.ArgumentParser,
+    ) -> None:
         parser.add_argument(
             '--schema-version',
             metavar='<schema_version>',
@@ -100,7 +105,7 @@ class _RulesReader:
 class CreateMapping(command.ShowOne, _RulesReader):
     _description = _("Create new mapping")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'mapping',
@@ -116,7 +121,9 @@ class CreateMapping(command.ShowOne, _RulesReader):
         _RulesReader.add_federated_schema_version_option(parser)
         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
 
         rules = self._read_rules(parsed_args.rules)
@@ -127,13 +134,14 @@ class CreateMapping(command.ShowOne, _RulesReader):
         )
 
         mapping._info.pop('links', None)
-        return zip(*sorted(mapping._info.items()))
+        col_headers, col_data = zip(*sorted(mapping._info.items()))
+        return col_headers, col_data
 
 
 class DeleteMapping(command.Command):
     _description = _("Delete mapping(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(
             'mapping',
@@ -143,7 +151,7 @@ class DeleteMapping(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
         result = 0
         for i in parsed_args.mapping:
@@ -171,7 +179,9 @@ class DeleteMapping(command.Command):
 class ListMapping(command.Lister):
     _description = _("List mappings")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         # NOTE(marek-denis): Since rules can be long and tedious I have decided
         # to only list ids of the mappings. If somebody wants to check the
         # rules, (s)he should show specific ones.
@@ -185,7 +195,7 @@ class ListMapping(command.Lister):
 class SetMapping(command.Command, _RulesReader):
     _description = _("Set mapping 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(
             'mapping',
@@ -201,7 +211,7 @@ class SetMapping(command.Command, _RulesReader):
         _RulesReader.add_federated_schema_version_option(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
 
         rules = self._read_rules(parsed_args.rules)
@@ -218,7 +228,7 @@ class SetMapping(command.Command, _RulesReader):
 class ShowMapping(command.ShowOne):
     _description = _("Display mapping 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(
             'mapping',
@@ -227,10 +237,13 @@ class ShowMapping(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
 
         mapping = identity_client.federation.mappings.get(parsed_args.mapping)
 
         mapping._info.pop('links', None)
-        return zip(*sorted(mapping._info.items()))
+        col_headers, col_data = zip(*sorted(mapping._info.items()))
+        return col_headers, col_data