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

openstackclient/api/compute_v2.py

@@ -64,7 +64,7 @@ def list_security_groups(compute_client, all_projects=None):
 
 
 def find_security_group(compute_client, name_or_id):
-    """Find the name for a given security group name or ID
+    """Find the security group for a given name or ID
 
     https://docs.openstack.org/api-ref/compute/#show-security-group-details
 
@@ -240,7 +240,7 @@ def list_networks(compute_client):
 
 
 def find_network(compute_client, name_or_id):
-    """Find the ID for a given network name or ID
+    """Find the network for a given name or ID
 
     https://docs.openstack.org/api-ref/compute/#show-network-details
 

openstackclient/api/volume_v2.py

@@ -0,0 +1,60 @@
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+
+"""Volume v2 API Library
+
+A collection of wrappers for deprecated Block Storage v2 APIs that are not
+intentionally supported by SDK.
+"""
+
+import http
+
+from openstack import exceptions as sdk_exceptions
+from osc_lib import exceptions
+
+
+# consistency groups
+
+
+def find_consistency_group(compute_client, name_or_id):
+    """Find the consistency group for a given name or ID
+
+    https://docs.openstack.org/api-ref/block-storage/v3/#show-a-consistency-group-s-details
+
+    :param volume_client: A volume client
+    :param name_or_id: The name or ID of the consistency group to look up
+    :returns: A consistency group object
+    :raises exception.NotFound: If a matching consistency group could not be
+        found or more than one match was found
+    """
+    response = compute_client.get(f'/consistencygroups/{name_or_id}')
+    if response.status_code != http.HTTPStatus.NOT_FOUND:
+        # there might be other, non-404 errors
+        sdk_exceptions.raise_from_response(response)
+        return response.json()['consistencygroup']
+
+    response = compute_client.get('/consistencygroups')
+    sdk_exceptions.raise_from_response(response)
+    found = None
+    consistency_groups = response.json()['consistencygroups']
+    for consistency_group in consistency_groups:
+        if consistency_group['name'] == name_or_id:
+            if found:
+                raise exceptions.NotFound(
+                    f'multiple matches found for {name_or_id}'
+                )
+            found = consistency_group
+
+    if not found:
+        raise exceptions.NotFound(f'{name_or_id} not found')
+
+    return found

openstackclient/api/volume_v3.py

@@ -0,0 +1,60 @@
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+
+"""Volume v3 API Library
+
+A collection of wrappers for deprecated Block Storage v3 APIs that are not
+intentionally supported by SDK.
+"""
+
+import http
+
+from openstack import exceptions as sdk_exceptions
+from osc_lib import exceptions
+
+
+# consistency groups
+
+
+def find_consistency_group(compute_client, name_or_id):
+    """Find the consistency group for a given name or ID
+
+    https://docs.openstack.org/api-ref/block-storage/v3/#show-a-consistency-group-s-details
+
+    :param volume_client: A volume client
+    :param name_or_id: The name or ID of the consistency group to look up
+    :returns: A consistency group object
+    :raises exception.NotFound: If a matching consistency group could not be
+        found or more than one match was found
+    """
+    response = compute_client.get(f'/consistencygroups/{name_or_id}')
+    if response.status_code != http.HTTPStatus.NOT_FOUND:
+        # there might be other, non-404 errors
+        sdk_exceptions.raise_from_response(response)
+        return response.json()['consistencygroup']
+
+    response = compute_client.get('/consistencygroups')
+    sdk_exceptions.raise_from_response(response)
+    found = None
+    consistency_groups = response.json()['consistencygroups']
+    for consistency_group in consistency_groups:
+        if consistency_group['name'] == name_or_id:
+            if found:
+                raise exceptions.NotFound(
+                    f'multiple matches found for {name_or_id}'
+                )
+            found = consistency_group
+
+    if not found:
+        raise exceptions.NotFound(f'{name_or_id} not found')
+
+    return found

openstackclient/compute/v2/flavor.py

@@ -156,12 +156,25 @@ class CreateFlavor(command.ShowOne):
             msg = _("--project is only allowed with --private")
             raise exceptions.CommandError(msg)
 
+        flavor_id = parsed_args.id
+        if parsed_args.id == 'auto':
+            # novaclient aliased 'auto' to mean "generate a UUID for me": we
+            # do the same to avoid breaking existing users
+            flavor_id = None
+
+            msg = _(
+                "Passing '--id auto' is deprecated. Nova will automatically "
+                "assign a UUID-like ID if no ID is provided. Omit the '--id' "
+                "parameter instead."
+            )
+            self.log.warning(msg)
+
         args = {
             'name': parsed_args.name,
             'ram': parsed_args.ram,
             'vcpus': parsed_args.vcpus,
             'disk': parsed_args.disk,
-            'id': parsed_args.id,
+            'id': flavor_id,
             'ephemeral': parsed_args.ephemeral,
             'swap': parsed_args.swap,
             'rxtx_factor': parsed_args.rxtx_factor,

openstackclient/compute/v2/server.py

@@ -2129,13 +2129,11 @@ class CreateServer(command.ShowOne):
                     f.close()
 
         if parsed_args.wait:
-            if utils.wait_for_status(
+            if not utils.wait_for_status(
                 compute_client.get_server,
                 server.id,
                 callback=_show_progress,
             ):
-                self.app.stdout.write('\n')
-            else:
                 msg = _('Error creating server: %s') % parsed_args.server_name
                 raise exceptions.CommandError(msg)
 

openstackclient/identity/common.py

@@ -348,15 +348,6 @@ def _find_sdk_id(
     return resource.id
 
 
-def get_immutable_options(parsed_args):
-    options = {}
-    if parsed_args.immutable:
-        options['immutable'] = True
-    if parsed_args.no_immutable:
-        options['immutable'] = False
-    return options
-
-
 def add_user_domain_option_to_parser(parser):
     parser.add_argument(
         '--user-domain',
@@ -419,17 +410,21 @@ def add_inherited_option_to_parser(parser):
 
 
 def add_resource_option_to_parser(parser):
-    enable_group = parser.add_mutually_exclusive_group()
-    enable_group.add_argument(
+    immutable_group = parser.add_mutually_exclusive_group()
+    immutable_group.add_argument(
         '--immutable',
         action='store_true',
+        dest='immutable',
+        default=None,
         help=_(
             'Make resource immutable. An immutable project may not '
             'be deleted or modified except to remove the immutable flag'
         ),
     )
-    enable_group.add_argument(
+    immutable_group.add_argument(
         '--no-immutable',
-        action='store_true',
+        action='store_false',
+        dest='immutable',
+        default=None,
         help=_('Make resource mutable (default)'),
     )

openstackclient/identity/v3/application_credential.py

@@ -20,6 +20,7 @@ import json
 import logging
 import uuid
 
+from cliff import columns as cliff_columns
 from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
@@ -27,10 +28,84 @@ from osc_lib import utils
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
-
 LOG = logging.getLogger(__name__)
 
 
+class RolesColumn(cliff_columns.FormattableColumn):
+    """Generate a formatted string of role names."""
+
+    def human_readable(self):
+        return utils.format_list(r['name'] for r in self._value)
+
+
+def _format_application_credential(
+    application_credential, *, include_secret=False
+):
+    column_headers: tuple[str, ...] = (
+        'ID',
+        'Name',
+        'Description',
+        'Project ID',
+        'Roles',
+        'Unrestricted',
+        'Access Rules',
+        'Expires At',
+    )
+    columns: tuple[str, ...] = (
+        'id',
+        'name',
+        'description',
+        'project_id',
+        'roles',
+        'unrestricted',
+        'access_rules',
+        'expires_at',
+    )
+    if include_secret:
+        column_headers += ('Secret',)
+        columns += ('secret',)
+
+    return (
+        column_headers,
+        utils.get_item_properties(
+            application_credential, columns, formatters={'roles': RolesColumn}
+        ),
+    )
+
+
+def _format_application_credentials(application_credentials):
+    column_headers = (
+        'ID',
+        'Name',
+        'Description',
+        'Project ID',
+        'Roles',
+        'Unrestricted',
+        'Access Rules',
+        'Expires At',
+    )
+    columns = (
+        'id',
+        'name',
+        'description',
+        'project_id',
+        'roles',
+        'unrestricted',
+        'access_rules',
+        'expires_at',
+    )
+
+    return (
+        column_headers,
+        (
+            utils.get_item_properties(
+                x, columns, formatters={'roles': RolesColumn}
+            )
+            for x in application_credentials
+        ),
+    )
+
+
 # TODO(stephenfin): Move this to osc_lib since it's useful elsewhere
 def is_uuid_like(value) -> bool:
     """Returns validation of a value as a UUID.
@@ -38,9 +113,6 @@ def is_uuid_like(value) -> bool:
     :param val: Value to verify
     :type val: string
     :returns: bool
-
-    .. versionchanged:: 1.1.1
-       Support non-lowercase UUIDs.
     """
     try:
         formatted_value = (
@@ -179,31 +251,8 @@ class CreateApplicationCredential(command.ShowOne):
             access_rules=access_rules,
         )
 
-        # Format roles into something sensible
-        if application_credential['roles']:
-            roles = application_credential['roles']
-            msg = ' '.join(r['name'] for r in roles)
-            application_credential['roles'] = msg
-
-        columns = (
-            'id',
-            'name',
-            'description',
-            'project_id',
-            'roles',
-            'unrestricted',
-            'access_rules',
-            'expires_at',
-            'secret',
-        )
-        return (
-            columns,
-            (
-                utils.get_dict_properties(
-                    application_credential,
-                    columns,
-                )
-            ),
+        return _format_application_credential(
+            application_credential, include_secret=True
         )
 
 
@@ -252,6 +301,8 @@ class DeleteApplicationCredential(command.Command):
             ) % {'errors': errors, 'total': total}
             raise exceptions.CommandError(msg)
 
+        return None
+
 
 class ListApplicationCredential(command.Lister):
     _description = _("List application credentials")
@@ -276,39 +327,12 @@ class ListApplicationCredential(command.Lister):
             conn = self.app.client_manager.sdk_connection
             user_id = conn.config.get_auth().get_user_id(conn.identity)
 
-        data = identity_client.application_credentials(user=user_id)
-
-        data_formatted = []
-        for ac in data:
-            # Format roles into something sensible
-            roles = ac['roles']
-            msg = ' '.join(r['name'] for r in roles)
-            ac['roles'] = msg
-
-            data_formatted.append(ac)
-
-        columns = (
-            'ID',
-            'Name',
-            'Description',
-            'Project ID',
-            'Roles',
-            'Unrestricted',
-            'Access Rules',
-            'Expires At',
-        )
-        return (
-            columns,
-            (
-                utils.get_item_properties(
-                    s,
-                    columns,
-                    formatters={},
-                )
-                for s in data_formatted
-            ),
+        application_credentials = identity_client.application_credentials(
+            user=user_id
         )
 
+        return _format_application_credentials(application_credentials)
+
 
 class ShowApplicationCredential(command.ShowOne):
     _description = _("Display application credential details")
@@ -327,31 +351,8 @@ class ShowApplicationCredential(command.ShowOne):
         conn = self.app.client_manager.sdk_connection
         user_id = conn.config.get_auth().get_user_id(conn.identity)
 
-        app_cred = identity_client.find_application_credential(
+        application_credential = identity_client.find_application_credential(
             user_id, parsed_args.application_credential
         )
 
-        # Format roles into something sensible
-        roles = app_cred['roles']
-        msg = ' '.join(r['name'] for r in roles)
-        app_cred['roles'] = msg
-
-        columns = (
-            'id',
-            'name',
-            'description',
-            'project_id',
-            'roles',
-            'unrestricted',
-            'access_rules',
-            'expires_at',
-        )
-        return (
-            columns,
-            (
-                utils.get_dict_properties(
-                    app_cred,
-                    columns,
-                )
-            ),
-        )
+        return _format_application_credential(application_credential)

openstackclient/identity/v3/domain.py

@@ -94,7 +94,9 @@ class CreateDomain(command.ShowOne):
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
 
-        options = common.get_immutable_options(parsed_args)
+        options = {}
+        if parsed_args.immutable is not None:
+            options['immutable'] = parsed_args.immutable
 
         try:
             domain = identity_client.create_domain(
@@ -242,13 +244,10 @@ class SetDomain(command.Command):
             kwargs['name'] = parsed_args.name
         if parsed_args.description:
             kwargs['description'] = parsed_args.description
-
         if parsed_args.is_enabled is not None:
             kwargs['is_enabled'] = parsed_args.is_enabled
-
-        options = common.get_immutable_options(parsed_args)
-        if options:
-            kwargs['options'] = options
+        if parsed_args.immutable is not None:
+            kwargs['options'] = {'immutable': parsed_args.immutable}
 
         identity_client.update_domain(domain.id, **kwargs)
 

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,
             )
@@ -356,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> '
@@ -388,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/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":