python-openstackclient 8.0.0__py3-none-any.whl → 8.2.0__py3-none-any.whl

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(
@@ -262,29 +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 += ('Domain ID', 'Description')
-        data = identity_client.groups.list(
-            domain=domain,
-            user=user,
-        )
 
         return (
             columns,
@@ -323,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") % {
@@ -387,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 = {}
@@ -397,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):
@@ -418,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/project.py

@@ -59,17 +59,22 @@ class CreateProject(command.ShowOne):
         enable_group.add_argument(
             '--enable',
             action='store_true',
+            dest='enabled',
+            default=True,
             help=_('Enable project'),
         )
         enable_group.add_argument(
             '--disable',
-            action='store_true',
+            action='store_false',
+            dest='enabled',
+            default=True,
             help=_('Disable project'),
         )
         parser.add_argument(
             '--property',
             metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest='properties',
             help=_(
                 'Add a property to <name> '
                 '(repeat option to set multiple properties)'
@@ -98,15 +103,9 @@ class CreateProject(command.ShowOne):
                 parsed_args.parent,
             ).id
 
-        enabled = True
-        if parsed_args.disable:
-            enabled = False
-
-        options = common.get_immutable_options(parsed_args)
-
         kwargs = {}
-        if parsed_args.property:
-            kwargs = parsed_args.property.copy()
+        if parsed_args.properties:
+            kwargs = parsed_args.properties.copy()
         if 'is_domain' in kwargs.keys():
             if kwargs['is_domain'].lower() == "true":
                 kwargs['is_domain'] = True
@@ -117,13 +116,17 @@ class CreateProject(command.ShowOne):
 
         kwargs['tags'] = list(set(parsed_args.tags))
 
+        options = {}
+        if parsed_args.immutable is not None:
+            options['immutable'] = parsed_args.immutable
+
         try:
             project = identity_client.projects.create(
                 name=parsed_args.name,
                 domain=domain,
                 parent=parent,
                 description=parsed_args.description,
-                enabled=enabled,
+                enabled=parsed_args.enabled,
                 options=options,
                 **kwargs,
             )
@@ -240,6 +243,20 @@ 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
 
@@ -277,6 +294,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:
@@ -339,16 +359,21 @@ class SetProject(command.Command):
         enable_group.add_argument(
             '--enable',
             action='store_true',
+            dest='enabled',
+            default=None,
             help=_('Enable project'),
         )
         enable_group.add_argument(
             '--disable',
-            action='store_true',
+            action='store_false',
+            dest='enabled',
+            default=None,
             help=_('Disable project'),
         )
         parser.add_argument(
             '--property',
             metavar='<key=value>',
+            dest='properties',
             action=parseractions.KeyValueAction,
             help=_(
                 'Set a property on <project> '
@@ -371,15 +396,12 @@ class SetProject(command.Command):
             kwargs['name'] = parsed_args.name
         if parsed_args.description:
             kwargs['description'] = parsed_args.description
-        if parsed_args.enable:
-            kwargs['enabled'] = True
-        if parsed_args.disable:
-            kwargs['enabled'] = False
-        options = common.get_immutable_options(parsed_args)
-        if options:
-            kwargs['options'] = options
-        if parsed_args.property:
-            kwargs.update(parsed_args.property)
+        if parsed_args.enabled is not None:
+            kwargs['enabled'] = parsed_args.enabled
+        if parsed_args.immutable is not None:
+            kwargs['options'] = {'immutable': parsed_args.immutable}
+        if parsed_args.properties:
+            kwargs.update(parsed_args.properties)
         tag.update_tags_in_args(parsed_args, project, kwargs)
 
         identity_client.projects.update(project.id, **kwargs)

openstackclient/identity/v3/role.py

@@ -334,9 +334,12 @@ class CreateRole(command.ShowOne):
 
         if parsed_args.name:
             create_kwargs['name'] = parsed_args.name
+
         if parsed_args.description:
             create_kwargs['description'] = parsed_args.description
-        create_kwargs['options'] = common.get_immutable_options(parsed_args)
+
+        if parsed_args.immutable is not None:
+            create_kwargs['options'] = {"immutable": parsed_args.immutable}
 
         try:
             role = identity_client.create_role(**create_kwargs)
@@ -585,7 +588,9 @@ class SetRole(command.Command):
             )
             update_kwargs["domain_id"] = domain_id
 
-        update_kwargs["options"] = common.get_immutable_options(parsed_args)
+        if parsed_args.immutable is not None:
+            update_kwargs["options"] = {"immutable": parsed_args.immutable}
+
         role = _find_sdk_id(
             identity_client.find_role,
             name_or_id=parsed_args.role,

openstackclient/identity/v3/user.py

@@ -41,6 +41,7 @@ def _format_user(user):
         'name',
         'description',
         'password_expires_at',
+        'options',
     )
     column_headers = (
         'default_project_id',
@@ -51,6 +52,7 @@ def _format_user(user):
         'name',
         'description',
         'password_expires_at',
+        'options',
     )
     return (
         column_headers,
@@ -289,7 +291,7 @@ class CreateUser(command.ShowOne):
         elif parsed_args.password_prompt:
             password = utils.get_password(self.app.stdin)
 
-        if not parsed_args.password:
+        if not password:
             LOG.warning(
                 _(
                     "No password was supplied, authentication will fail "
@@ -412,6 +414,24 @@ class ListUser(command.Lister):
             default=False,
             help=_('List additional fields in output'),
         )
+        parser.add_argument(
+            '--enabled',
+            action='store_true',
+            dest='is_enabled',
+            default=None,
+            help=_(
+                'List only enabled users, does nothing with --project and --group'
+            ),
+        )
+        parser.add_argument(
+            '--disabled',
+            action='store_false',
+            dest='is_enabled',
+            default=None,
+            help=_(
+                'List only disabled users, does nothing with --project and --group'
+            ),
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -431,6 +451,9 @@ class ListUser(command.Lister):
                 ignore_missing=False,
             ).id
 
+        if parsed_args.is_enabled is not None:
+            enabled = parsed_args.is_enabled
+
         if parsed_args.project:
             if domain is not None:
                 project = identity_client.find_project(
@@ -469,9 +492,15 @@ class ListUser(command.Lister):
                 group=group,
             )
         else:
-            data = identity_client.users(
-                domain_id=domain,
-            )
+            if parsed_args.is_enabled is not None:
+                data = identity_client.users(
+                    domain_id=domain,
+                    is_enabled=enabled,
+                )
+            else:
+                data = identity_client.users(
+                    domain_id=domain,
+                )
 
         # Column handling
         if parsed_args.long:
@@ -659,6 +688,8 @@ class SetPasswordUser(command.Command):
 
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
+        conn = self.app.client_manager.sdk_connection
+        user_id = conn.config.get_auth().get_user_id(conn.identity)
 
         # FIXME(gyee): there are two scenarios:
         #
@@ -701,7 +732,9 @@ class SetPasswordUser(command.Command):
             )
 
         identity_client.update_user(
-            current_password=current_password, password=password
+            user=user_id,
+            current_password=current_password,
+            password=password,
         )
 
 

openstackclient/image/client.py

@@ -46,3 +46,8 @@ def build_option_parser(parser):
         % DEFAULT_API_VERSION,
     )
     return parser
+
+
+def check_api_version(check_version):
+    # SDK supports auto-negotiation for us: always return True
+    return True

openstackclient/image/v1/image.py

@@ -528,6 +528,16 @@ class SaveImage(command.Command):
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "--chunk-size",
+            type=int,
+            default=1024,
+            metavar="<chunk-size>",
+            help=_(
+                "Size in bytes to read from the wire and buffer at one "
+                "time (default: 1024)"
+            ),
+        )
         parser.add_argument(
             "--file",
             metavar="<filename>",
@@ -550,7 +560,12 @@ class SaveImage(command.Command):
         if output_file is None:
             output_file = getattr(sys.stdout, "buffer", sys.stdout)
 
-        image_client.download_image(image.id, stream=True, output=output_file)
+        image_client.download_image(
+            image.id,
+            stream=True,
+            output=output_file,
+            chunk_size=parsed_args.chunk_size,
+        )
 
 
 class SetImage(command.Command):

openstackclient/image/v2/cache.py

@@ -37,14 +37,18 @@ def _format_image_cache(cached_images):
                 image_obj = copy.deepcopy(image)
                 image_obj['state'] = 'cached'
                 image_obj['last_accessed'] = (
-                    datetime.datetime.utcfromtimestamp(
-                        image['last_accessed']
-                    ).isoformat()
+                    datetime.datetime.fromtimestamp(
+                        image['last_accessed'], tz=datetime.timezone.utc
+                    )
+                    .replace(tzinfo=None)
+                    .isoformat()
                 )
                 image_obj['last_modified'] = (
-                    datetime.datetime.utcfromtimestamp(
-                        image['last_modified']
-                    ).isoformat()
+                    datetime.datetime.fromtimestamp(
+                        image['last_modified'], tz=datetime.timezone.utc
+                    )
+                    .replace(tzinfo=None)
+                    .isoformat()
                 )
                 image_list.append(image_obj)
         elif item == "queued_images":