python-openstackclient 8.0.0__py3-none-any.whl → 8.1.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

@@ -240,6 +240,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 +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/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/v2/image.py

@@ -17,14 +17,15 @@
 
 import argparse
 from base64 import b64encode
+import copy
 import logging
 import os
 import sys
 import typing as ty
 
-from cinderclient import api_versions
 from openstack import exceptions as sdk_exceptions
 from openstack.image import image_signer
+from openstack import utils as sdk_utils
 from osc_lib.api import utils as api_utils
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
@@ -576,7 +577,7 @@ class CreateImage(command.ShowOne):
         return _format_image(image)
 
     def _take_action_volume(self, parsed_args):
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
 
         unsupported_opts = {
             # 'name',  # 'name' is a positional argument and will always exist
@@ -607,15 +608,14 @@ class CreateImage(command.ShowOne):
                 # version
                 LOG.warning(msg % opt_name)
 
-        source_volume = utils.find_resource(
-            volume_client.volumes,
-            parsed_args.volume,
+        source_volume = volume_client.find_volume(
+            parsed_args.volume, ignore_missing=False
         )
         kwargs: dict[str, ty.Any] = {
             'visibility': None,
             'protected': None,
         }
-        if volume_client.api_version < api_versions.APIVersion('3.1'):
+        if not sdk_utils.supports_microversion(volume_client, '3.1'):
             if parsed_args.visibility or parsed_args.is_protected is not None:
                 msg = _(
                     '--os-volume-api-version 3.1 or greater is required '
@@ -627,15 +627,15 @@ class CreateImage(command.ShowOne):
             kwargs['visibility'] = parsed_args.visibility or 'private'
             kwargs['protected'] = parsed_args.is_protected or False
 
-        response, body = volume_client.volumes.upload_to_image(
+        response = volume_client.upload_volume_to_image(
             source_volume.id,
-            parsed_args.force,
             parsed_args.name,
-            parsed_args.container_format,
-            parsed_args.disk_format,
+            force=parsed_args.force,
+            disk_format=parsed_args.disk_format,
+            container_format=parsed_args.container_format,
             **kwargs,
         )
-        info = body['os-volume_upload_image']
+        info = copy.deepcopy(response)
         try:
             info['volume_type'] = info['volume_type']['name']
         except TypeError:

openstackclient/network/client.py

@@ -27,12 +27,6 @@ API_VERSIONS = ('2.0', '2')
 
 def make_client(instance):
     """Returns a network proxy"""
-    # NOTE(dtroyer): As of osc-lib 1.8.0 and OpenStackSDK 0.10.0 the
-    #                old Profile interface and separate client creation
-    #                for each API that uses the SDK is unnecessary.  This
-    #                callback remains as a remnant of the original plugin
-    #                interface and to avoid the code churn of changing all
-    #                of the existing references.
     LOG.debug(
         'Network client initialized using OpenStack SDK: %s',
         instance.sdk_connection.network,

openstackclient/network/v2/floating_ip.py

@@ -243,18 +243,26 @@ class ListFloatingIP(common.NetworkAndComputeLister):
         parser.add_argument(
             '--network',
             metavar='<network>',
+            dest='networks',
+            action='append',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to "
-                    "given network (name or ID)"
+                    "List floating IP(s) according to given network "
+                    "(name or ID) "
+                    "(repeat option to fiter on multiple networks)"
                 )
             ),
         )
         parser.add_argument(
             '--port',
             metavar='<port>',
+            dest='ports',
+            action='append',
             help=self.enhance_help_neutron(
-                _("List floating IP(s) according to given port (name or ID)")
+                _(
+                    "List floating IP(s) according to given port (name or ID) "
+                    "(repeat option to fiter on multiple ports)"
+                )
             ),
         )
         parser.add_argument(
@@ -271,14 +279,6 @@ class ListFloatingIP(common.NetworkAndComputeLister):
                 _("List floating IP(s) according to given floating IP address")
             ),
         )
-        parser.add_argument(
-            '--long',
-            action='store_true',
-            default=False,
-            help=self.enhance_help_neutron(
-                _("List additional fields in output")
-            ),
-        )
         parser.add_argument(
             '--status',
             metavar='<status>',
@@ -295,8 +295,8 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             metavar='<project>',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given project (name or "
-                    "ID)"
+                    "List floating IP(s) according to given project "
+                    "(name or ID) "
                 )
             ),
         )
@@ -304,13 +304,27 @@ class ListFloatingIP(common.NetworkAndComputeLister):
         parser.add_argument(
             '--router',
             metavar='<router>',
+            dest='routers',
+            action='append',
             help=self.enhance_help_neutron(
-                _("List floating IP(s) according to given router (name or ID)")
+                _(
+                    "List floating IP(s) according to given router "
+                    "(name or ID) "
+                    "(repeat option to fiter on multiple routers)"
+                )
             ),
         )
         _tag.add_tag_filtering_option_to_parser(
             parser, _('floating IP'), enhance_help=self.enhance_help_neutron
         )
+        parser.add_argument(
+            '--long',
+            action='store_true',
+            default=False,
+            help=self.enhance_help_neutron(
+                _("List additional fields in output")
+            ),
+        )
 
         return parser
 
@@ -354,22 +368,33 @@ class ListFloatingIP(common.NetworkAndComputeLister):
 
         query = {}
 
-        if parsed_args.network is not None:
-            network = network_client.find_network(
-                parsed_args.network, ignore_missing=False
-            )
-            query['floating_network_id'] = network.id
-        if parsed_args.port is not None:
-            port = network_client.find_port(
-                parsed_args.port, ignore_missing=False
-            )
-            query['port_id'] = port.id
+        if parsed_args.networks is not None:
+            network_ids = []
+            for network in parsed_args.networks:
+                network_id = network_client.find_network(
+                    network, ignore_missing=False
+                ).id
+                network_ids.append(network_id)
+            query['floating_network_id'] = network_ids
+
+        if parsed_args.ports is not None:
+            port_ids = []
+            for port in parsed_args.ports:
+                port_id = network_client.find_port(
+                    port, ignore_missing=False
+                ).id
+                port_ids.append(port_id)
+            query['port_id'] = port_ids
+
         if parsed_args.fixed_ip_address is not None:
             query['fixed_ip_address'] = parsed_args.fixed_ip_address
+
         if parsed_args.floating_ip_address is not None:
             query['floating_ip_address'] = parsed_args.floating_ip_address
+
         if parsed_args.status:
             query['status'] = parsed_args.status
+
         if parsed_args.project is not None:
             project = identity_common.find_project(
                 identity_client,
@@ -377,11 +402,15 @@ class ListFloatingIP(common.NetworkAndComputeLister):
                 parsed_args.project_domain,
             )
             query['project_id'] = project.id
-        if parsed_args.router is not None:
-            router = network_client.find_router(
-                parsed_args.router, ignore_missing=False
-            )
-            query['router_id'] = router.id
+
+        if parsed_args.routers is not None:
+            router_ids = []
+            for router in parsed_args.routers:
+                router_id = network_client.find_router(
+                    router, ignore_missing=False
+                ).id
+                router_ids.append(router_id)
+            query['router_id'] = router_ids
 
         _tag.get_tag_filtering_args(parsed_args, query)