python-openstackclient 7.4.0__py3-none-any.whl → 8.1.0__py3-none-any.whl

openstackclient/identity/v3/endpoint_group.py

@@ -168,7 +168,7 @@ class DeleteEndpointGroup(command.Command):
         if result > 0:
             total = len(parsed_args.endpointgroup)
             msg = _(
-                "%(result)s of %(total)s endpointgroups failed " "to delete."
+                "%(result)s of %(total)s endpointgroups failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 

openstackclient/identity/v3/group.py

@@ -17,7 +17,7 @@
 
 import logging
 
-from keystoneauth1 import exceptions as ks_exc
+from openstack import exceptions as sdk_exc
 from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
@@ -29,6 +29,25 @@ from openstackclient.identity import common
 LOG = logging.getLogger(__name__)
 
 
+def _format_group(group):
+    columns = (
+        'description',
+        'domain_id',
+        'id',
+        'name',
+    )
+    column_headers = (
+        'description',
+        'domain_id',
+        'id',
+        'name',
+    )
+    return (
+        column_headers,
+        utils.get_item_properties(group, columns),
+    )
+
+
 class AddUserToGroup(command.Command):
     _description = _("Add user to group")
 
@@ -53,19 +72,19 @@ class AddUserToGroup(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        group_id = common.find_group(
+        group_id = common.find_group_id_sdk(
             identity_client, parsed_args.group, parsed_args.group_domain
-        ).id
+        )
 
         result = 0
         for i in parsed_args.user:
             try:
-                user_id = common.find_user(
+                user_id = common.find_user_id_sdk(
                     identity_client, i, parsed_args.user_domain
-                ).id
-                identity_client.users.add_to_group(user_id, group_id)
+                )
+                identity_client.add_user_to_group(user_id, group_id)
             except Exception as e:
                 result += 1
                 msg = _("%(user)s not added to group %(group)s: %(e)s") % {
@@ -109,32 +128,41 @@ class CheckUserInGroup(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        user_id = common.find_user(
-            identity_client, parsed_args.user, parsed_args.user_domain
-        ).id
-        group_id = common.find_group(
-            identity_client, parsed_args.group, parsed_args.group_domain
-        ).id
+        user_id = common.find_user_id_sdk(
+            identity_client,
+            parsed_args.user,
+            parsed_args.user_domain,
+            validate_actor_existence=False,
+        )
+        group_id = common.find_group_id_sdk(
+            identity_client,
+            parsed_args.group,
+            parsed_args.group_domain,
+            validate_actor_existence=False,
+        )
 
+        user_in_group = False
         try:
-            identity_client.users.check_in_group(user_id, group_id)
-        except ks_exc.http.HTTPClientError as e:
-            if e.http_status == 403 or e.http_status == 404:
-                msg = _("%(user)s not in group %(group)s\n") % {
-                    'user': parsed_args.user,
-                    'group': parsed_args.group,
-                }
-                self.app.stderr.write(msg)
-            else:
-                raise e
-        else:
+            user_in_group = identity_client.check_user_in_group(
+                user_id, group_id
+            )
+        except sdk_exc.ForbiddenException:
+            # Assume False if forbidden
+            pass
+        if user_in_group:
             msg = _("%(user)s in group %(group)s\n") % {
                 'user': parsed_args.user,
                 'group': parsed_args.group,
             }
             self.app.stdout.write(msg)
+        else:
+            msg = _("%(user)s not in group %(group)s\n") % {
+                'user': parsed_args.user,
+                'group': parsed_args.group,
+            }
+            self.app.stderr.write(msg)
 
 
 class CreateGroup(command.ShowOne):
@@ -165,29 +193,33 @@ class CreateGroup(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        domain = None
+        kwargs = {}
+        if parsed_args.name:
+            kwargs['name'] = parsed_args.name
+        if parsed_args.description:
+            kwargs['description'] = parsed_args.description
         if parsed_args.domain:
-            domain = common.find_domain(identity_client, parsed_args.domain).id
+            kwargs['domain_id'] = common.find_domain_id_sdk(
+                identity_client, parsed_args.domain
+            )
 
         try:
-            group = identity_client.groups.create(
-                name=parsed_args.name,
-                domain=domain,
-                description=parsed_args.description,
-            )
-        except ks_exc.Conflict:
+            group = identity_client.create_group(**kwargs)
+        except sdk_exc.ConflictException:
             if parsed_args.or_show:
-                group = utils.find_resource(
-                    identity_client.groups, parsed_args.name, domain_id=domain
-                )
+                if parsed_args.domain:
+                    group = identity_client.find_group(
+                        parsed_args.name, domain_id=parsed_args.domain
+                    )
+                else:
+                    group = identity_client.find_group(parsed_args.name)
                 LOG.info(_('Returning existing group %s'), group.name)
             else:
                 raise
 
-        group._info.pop('links')
-        return zip(*sorted(group._info.items()))
+        return _format_group(group)
 
 
 class DeleteGroup(command.Command):
@@ -209,15 +241,15 @@ class DeleteGroup(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         errors = 0
         for group in parsed_args.groups:
             try:
-                group_obj = common.find_group(
+                group_id = common.find_group_id_sdk(
                     identity_client, group, parsed_args.domain
                 )
-                identity_client.groups.delete(group_obj.id)
+                identity_client.delete_group(group_id)
             except Exception as e:
                 errors += 1
                 LOG.error(
@@ -230,7 +262,7 @@ class DeleteGroup(command.Command):
 
         if errors > 0:
             total = len(parsed_args.groups)
-            msg = _("%(errors)s of %(total)s groups failed " "to delete.") % {
+            msg = _("%(errors)s of %(total)s groups failed to delete.") % {
                 'errors': errors,
                 'total': total,
             }
@@ -262,30 +294,37 @@ class ListGroup(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         domain = None
         if parsed_args.domain:
-            domain = common.find_domain(identity_client, parsed_args.domain).id
+            domain = common.find_domain_id_sdk(
+                identity_client, parsed_args.domain
+            )
 
+        data = []
         if parsed_args.user:
-            user = common.find_user(
+            user = common.find_user_id_sdk(
                 identity_client,
                 parsed_args.user,
                 parsed_args.user_domain,
-            ).id
+            )
+            if domain:
+                # NOTE(0weng): The API doesn't actually support filtering additionally by domain_id,
+                # so this doesn't really do anything.
+                data = identity_client.user_groups(user, domain_id=domain)
+            else:
+                data = identity_client.user_groups(user)
         else:
-            user = None
+            if domain:
+                data = identity_client.groups(domain_id=domain)
+            else:
+                data = identity_client.groups()
 
         # List groups
+        columns: tuple[str, ...] = ('ID', 'Name')
         if parsed_args.long:
-            columns = ('ID', 'Name', 'Domain ID', 'Description')
-        else:
-            columns = ('ID', 'Name')
-        data = identity_client.groups.list(
-            domain=domain,
-            user=user,
-        )
+            columns += ('Domain ID', 'Description')
 
         return (
             columns,
@@ -324,19 +363,19 @@ class RemoveUserFromGroup(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        group_id = common.find_group(
+        group_id = common.find_group_id_sdk(
             identity_client, parsed_args.group, parsed_args.group_domain
-        ).id
+        )
 
         result = 0
         for i in parsed_args.user:
             try:
-                user_id = common.find_user(
+                user_id = common.find_user_id_sdk(
                     identity_client, i, parsed_args.user_domain
-                ).id
-                identity_client.users.remove_from_group(user_id, group_id)
+                )
+                identity_client.remove_user_from_group(user_id, group_id)
             except Exception as e:
                 result += 1
                 msg = _("%(user)s not removed from group %(group)s: %(e)s") % {
@@ -388,8 +427,8 @@ class SetGroup(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-        group = common.find_group(
+        identity_client = self.app.client_manager.sdk_connection.identity
+        group = common.find_group_id_sdk(
             identity_client, parsed_args.group, parsed_args.domain
         )
         kwargs = {}
@@ -398,7 +437,7 @@ class SetGroup(command.Command):
         if parsed_args.description:
             kwargs['description'] = parsed_args.description
 
-        identity_client.groups.update(group.id, **kwargs)
+        identity_client.update_group(group, **kwargs)
 
 
 class ShowGroup(command.ShowOne):
@@ -419,13 +458,18 @@ class ShowGroup(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        group = common.find_group(
-            identity_client,
-            parsed_args.group,
-            domain_name_or_id=parsed_args.domain,
-        )
+        if parsed_args.domain:
+            domain = common.find_domain_id_sdk(
+                identity_client, parsed_args.domain
+            )
+            group = identity_client.find_group(
+                parsed_args.group, domain_id=domain, ignore_missing=False
+            )
+        else:
+            group = identity_client.find_group(
+                parsed_args.group, ignore_missing=False
+            )
 
-        group._info.pop('links')
-        return zip(*sorted(group._info.items()))
+        return _format_group(group)

openstackclient/identity/v3/identity_provider.py

@@ -174,8 +174,7 @@ class DeleteIdentityProvider(command.Command):
         if result > 0:
             total = len(parsed_args.identity_provider)
             msg = _(
-                "%(result)s of %(total)s identity providers failed"
-                " to delete."
+                "%(result)s of %(total)s identity providers failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 

openstackclient/identity/v3/limit.py

@@ -77,8 +77,7 @@ class CreateLimit(command.ShowOne):
         )
         region = None
         if parsed_args.region:
-            val = getattr(parsed_args, 'region', None)
-            if 'None' not in val:
+            if 'None' not in parsed_args.region:
                 # NOTE (vishakha): Due to bug #1799153 and for any another
                 # related case where GET resource API does not support the
                 # filter by name, osc_lib.utils.find_resource() method cannot
@@ -149,11 +148,7 @@ class ListLimit(command.Lister):
             )
         region = None
         if parsed_args.region:
-            region = utils.find_resource(
-                identity_client.regions, parsed_args.region
-            )
-            val = getattr(parsed_args, 'region', None)
-            if 'None' not in val:
+            if 'None' not in parsed_args.region:
                 # NOTE (vishakha): Due to bug #1799153 and for any another
                 # related case where GET resource API does not support the
                 # filter by name, osc_lib.utils.find_resource() method cannot
@@ -281,13 +276,13 @@ class DeleteLimit(command.Command):
             except Exception as e:
                 errors += 1
                 LOG.error(
-                    _("Failed to delete limit with ID " "'%(id)s': %(e)s"),
+                    _("Failed to delete limit with ID '%(id)s': %(e)s"),
                     {'id': limit_id, 'e': e},
                 )
 
         if errors > 0:
             total = len(parsed_args.limit_id)
-            msg = _("%(errors)s of %(total)s limits failed to " "delete.") % {
+            msg = _("%(errors)s of %(total)s limits failed to delete.") % {
                 'errors': errors,
                 'total': total,
             }

openstackclient/identity/v3/mapping.py

@@ -161,9 +161,10 @@ class DeleteMapping(command.Command):
 
         if result > 0:
             total = len(parsed_args.mapping)
-            msg = _(
-                "%(result)s of %(total)s mappings failed " "to delete."
-            ) % {'result': result, 'total': total}
+            msg = _("%(result)s of %(total)s mappings failed to delete.") % {
+                'result': result,
+                'total': total,
+            }
             raise exceptions.CommandError(msg)
 
 

openstackclient/identity/v3/policy.py

@@ -92,9 +92,7 @@ class DeletePolicy(command.Command):
 
         if result > 0:
             total = len(parsed_args.policy)
-            msg = _(
-                "%(result)s of %(total)s policies failed " "to delete."
-            ) % {
+            msg = _("%(result)s of %(total)s policies failed to delete.") % {
                 'result': result,
                 'total': total,
             }
@@ -115,12 +113,11 @@ class ListPolicy(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
+        columns: tuple[str, ...] = ('ID', 'Type')
+        column_headers: tuple[str, ...] = columns
         if parsed_args.long:
-            columns = ('ID', 'Type', 'Blob')
-            column_headers = ('ID', 'Type', 'Rules')
-        else:
-            columns = ('ID', 'Type')
-            column_headers = columns
+            columns += ('Blob',)
+            column_headers += ('Rules',)
         data = self.app.client_manager.identity.policies.list()
         return (
             column_headers,

openstackclient/identity/v3/project.py

@@ -190,9 +190,10 @@ class DeleteProject(command.Command):
 
         if errors > 0:
             total = len(parsed_args.projects)
-            msg = _(
-                "%(errors)s of %(total)s projects failed " "to delete."
-            ) % {'errors': errors, 'total': total}
+            msg = _("%(errors)s of %(total)s projects failed to delete.") % {
+                'errors': errors,
+                'total': total,
+            }
             raise exceptions.CommandError(msg)
 
 
@@ -239,15 +240,28 @@ class ListProject(command.Lister):
                 'keys and directions.'
             ),
         )
+        parser.add_argument(
+            '--enabled',
+            action='store_true',
+            dest='is_enabled',
+            default=None,
+            help=_('List only enabled projects'),
+        )
+        parser.add_argument(
+            '--disabled',
+            action='store_false',
+            dest='is_enabled',
+            default=None,
+            help=_('List only disabled projects'),
+        )
         tag.add_tag_filtering_option_to_parser(parser, _('projects'))
         return parser
 
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.identity
+        columns: tuple[str, ...] = ('ID', 'Name')
         if parsed_args.long:
-            columns = ('ID', 'Name', 'Domain ID', 'Description', 'Enabled')
-        else:
-            columns = ('ID', 'Name')
+            columns += ('Domain ID', 'Description', 'Enabled')
         kwargs = {}
 
         domain_id = None
@@ -277,6 +291,9 @@ class ListProject(command.Lister):
 
             kwargs['user'] = user_id
 
+        if parsed_args.is_enabled is not None:
+            kwargs['is_enabled'] = parsed_args.is_enabled
+
         tag.get_tag_filtering_args(parsed_args, kwargs)
 
         if parsed_args.my_projects:

openstackclient/identity/v3/region.py

@@ -92,16 +92,13 @@ class DeleteRegion(command.Command):
             except Exception as e:
                 result += 1
                 LOG.error(
-                    _(
-                        "Failed to delete region with "
-                        "ID '%(region)s': %(e)s"
-                    ),
+                    _("Failed to delete region with ID '%(region)s': %(e)s"),
                     {'region': i, 'e': e},
                 )
 
         if result > 0:
             total = len(parsed_args.region)
-            msg = _("%(result)s of %(total)s regions failed " "to delete.") % {
+            msg = _("%(result)s of %(total)s regions failed to delete.") % {
                 'result': result,
                 'total': total,
             }

openstackclient/identity/v3/registered_limit.py

@@ -68,8 +68,7 @@ class CreateRegisteredLimit(command.ShowOne):
         )
         region = None
         if parsed_args.region:
-            val = getattr(parsed_args, 'region', None)
-            if 'None' not in val:
+            if 'None' not in parsed_args.region:
                 # NOTE (vishakha): Due to bug #1799153 and for any another
                 # related case where GET resource API does not support the
                 # filter by name, osc_lib.utils.find_resource() method cannot
@@ -137,8 +136,7 @@ class DeleteRegisteredLimit(command.Command):
         if errors > 0:
             total = len(parsed_args.registered_limit_id)
             msg = _(
-                "%(errors)s of %(total)s registered limits failed to "
-                "delete."
+                "%(errors)s of %(total)s registered limits failed to delete."
             ) % {'errors': errors, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -176,8 +174,7 @@ class ListRegisteredLimit(command.Lister):
             )
         region = None
         if parsed_args.region:
-            val = getattr(parsed_args, 'region', None)
-            if 'None' not in val:
+            if 'None' not in parsed_args.region:
                 # NOTE (vishakha): Due to bug #1799153 and for any another
                 # related case where GET resource API does not support the
                 # filter by name, osc_lib.utils.find_resource() method cannot
@@ -281,8 +278,7 @@ class SetRegisteredLimit(command.ShowOne):
 
         region = None
         if parsed_args.region:
-            val = getattr(parsed_args, 'region', None)
-            if 'None' not in val:
+            if 'None' not in parsed_args.region:
                 # NOTE (vishakha): Due to bug #1799153 and for any another
                 # related case where GET resource API does not support the
                 # filter by name, osc_lib.utils.find_resource() method cannot

openstackclient/identity/v3/role.py

@@ -402,7 +402,7 @@ class DeleteRole(command.Command):
 
         if errors > 0:
             total = len(parsed_args.roles)
-            msg = _("%(errors)s of %(total)s roles failed " "to delete.") % {
+            msg = _("%(errors)s of %(total)s roles failed to delete.") % {
                 'errors': errors,
                 'total': total,
             }
@@ -428,28 +428,27 @@ class ListRole(command.Lister):
             domain = identity_client.find_domain(
                 name_or_id=parsed_args.domain,
             )
-            columns = ('ID', 'Name', 'Domain')
             data = identity_client.roles(domain_id=domain.id)
+            return (
+                ('ID', 'Name', 'Domain'),
+                (
+                    utils.get_item_properties(s, ('id', 'name'))
+                    + (domain.name,)
+                    for s in data
+                ),
+            )
+
         else:
-            columns = ('ID', 'Name')
             data = identity_client.roles()
-
-        return (
-            columns,
-            (
-                utils.get_item_properties(
-                    s,
-                    columns,
-                    formatters={'Domain': lambda _: domain.name},
-                )
-                for s in data
-            ),
-        )
+            return (
+                ('ID', 'Name'),
+                (utils.get_item_properties(s, ('id', 'name')) for s in data),
+            )
 
 
 class RemoveRole(command.Command):
     _description = _(
-        "Removes a role assignment from system/domain/project : " "user/group"
+        "Removes a role assignment from system/domain/project : user/group"
     )
 
     def get_parser(self, prog_name):

openstackclient/identity/v3/service.py

@@ -135,9 +135,10 @@ class DeleteService(command.Command):
 
         if result > 0:
             total = len(parsed_args.service)
-            msg = _(
-                "%(result)s of %(total)s services failed " "to delete."
-            ) % {'result': result, 'total': total}
+            msg = _("%(result)s of %(total)s services failed to delete.") % {
+                'result': result,
+                'total': total,
+            }
             raise exceptions.CommandError(msg)
 
 
@@ -157,12 +158,11 @@ class ListService(command.Lister):
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
 
+        columns: tuple[str, ...] = ('id', 'name', 'type')
+        column_headers: tuple[str, ...] = ('ID', 'Name', 'Type')
         if parsed_args.long:
-            columns = ('id', 'name', 'type', 'description', 'is_enabled')
-            column_headers = ('ID', 'Name', 'Type', 'Description', 'Enabled')
-        else:
-            columns = ('id', 'name', 'type')
-            column_headers = ('ID', 'Name', 'Type')
+            columns += ('description', 'is_enabled')
+            column_headers += ('Description', 'Enabled')
 
         data = identity_client.services()
 

openstackclient/identity/v3/service_provider.py

@@ -77,8 +77,7 @@ class CreateServiceProvider(command.ShowOne):
             metavar='<sp-url>',
             required=True,
             help=_(
-                'A service URL where SAML assertions are being sent '
-                '(required)'
+                'A service URL where SAML assertions are being sent (required)'
             ),
         )
 
@@ -155,8 +154,7 @@ class DeleteServiceProvider(command.Command):
         if result > 0:
             total = len(parsed_args.service_provider)
             msg = _(
-                "%(result)s of %(total)s service providers failed"
-                " to delete."
+                "%(result)s of %(total)s service providers failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -204,8 +202,7 @@ class SetServiceProvider(command.ShowOne):
             '--auth-url',
             metavar='<auth-url>',
             help=_(
-                'New Authentication URL of remote '
-                'federated service provider'
+                'New Authentication URL of remote federated service provider'
             ),
         )
 

openstackclient/identity/v3/tag.py

@@ -83,7 +83,7 @@ def add_tag_option_to_parser_for_create(parser, resource_name):
         metavar='<tag>',
         default=[],
         help=_(
-            'Tag to be added to the %s ' '(repeat option to set multiple tags)'
+            'Tag to be added to the %s (repeat option to set multiple tags)'
         )
         % resource_name,
     )
@@ -97,7 +97,7 @@ def add_tag_option_to_parser_for_set(parser, resource_name):
         metavar='<tag>',
         default=[],
         help=_(
-            'Tag to be added to the %s ' '(repeat option to set multiple tags)'
+            'Tag to be added to the %s (repeat option to set multiple tags)'
         )
         % resource_name,
     )