python-openstackclient 6.3.0__py3-none-any.whl → 6.5.0__py3-none-any.whl

openstackclient/compute/v2/server_event.py

@@ -16,6 +16,7 @@
 """Compute v2 Server operation event implementations"""
 
 import logging
+import uuid
 
 from cliff import columns
 import iso8601
@@ -24,14 +25,38 @@ from openstack import utils as sdk_utils
 from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
-from oslo_utils import uuidutils
 
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 
-
 LOG = logging.getLogger(__name__)
 
 
+# TODO(stephenfin): Move this to osc_lib since it's useful elsewhere (e.g.
+# glance)
+def is_uuid_like(value) -> bool:
+    """Returns validation of a value as a UUID.
+
+    :param val: Value to verify
+    :type val: string
+    :returns: bool
+
+    .. versionchanged:: 1.1.1
+       Support non-lowercase UUIDs.
+    """
+    try:
+        formatted_value = (
+            value.replace('urn:', '')
+            .replace('uuid:', '')
+            .strip('{}')
+            .replace('-', '')
+            .lower()
+        )
+        return str(uuid.UUID(value)).replace('-', '') == formatted_value
+    except (TypeError, ValueError, AttributeError):
+        return False
+
+
 class ServerActionEventColumn(columns.FormattableColumn):
     """Custom formatter for server action events.
 
@@ -119,21 +144,7 @@ class ListServerEvent(command.Lister):
                 "(supported with --os-compute-api-version 2.66 or above)"
             ),
         )
-        parser.add_argument(
-            '--marker',
-            help=_(
-                'The last server event ID of the previous page '
-                '(supported by --os-compute-api-version 2.58 or above)'
-            ),
-        )
-        parser.add_argument(
-            '--limit',
-            type=int,
-            help=_(
-                'Maximum number of server events to display '
-                '(supported by --os-compute-api-version 2.58 or above)'
-            ),
-        )
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(self, parsed_args):
@@ -202,7 +213,7 @@ class ListServerEvent(command.Lister):
             # If we fail to find the resource, it is possible the server is
             # deleted. Try once more using the <server> arg directly if it is a
             # UUID.
-            if uuidutils.is_uuid_like(parsed_args.server):
+            if is_uuid_like(parsed_args.server):
                 server_id = parsed_args.server
             else:
                 raise
@@ -275,7 +286,7 @@ class ShowServerEvent(command.ShowOne):
             # If we fail to find the resource, it is possible the server is
             # deleted. Try once more using the <server> arg directly if it is a
             # UUID.
-            if uuidutils.is_uuid_like(parsed_args.server):
+            if is_uuid_like(parsed_args.server):
                 server_id = parsed_args.server
             else:
                 raise

openstackclient/compute/v2/server_group.py

@@ -24,9 +24,9 @@ from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 
-
 LOG = logging.getLogger(__name__)
 
 
@@ -191,28 +191,7 @@ class ListServerGroup(command.Lister):
         )
         # TODO(stephenfin): This should really be a --marker option, but alas
         # the API doesn't support that for some reason
-        parser.add_argument(
-            '--offset',
-            metavar='<offset>',
-            type=int,
-            default=None,
-            help=_(
-                'Index from which to start listing servers. This should '
-                'typically be a factor of --limit. Display all servers groups '
-                'if not specified.'
-            ),
-        )
-        parser.add_argument(
-            '--limit',
-            metavar='<limit>',
-            type=int,
-            default=None,
-            help=_(
-                "Maximum number of server groups to display. "
-                "If limit is greater than 'osapi_max_limit' option of Nova "
-                "API, 'osapi_max_limit' will be used instead."
-            ),
-        )
+        pagination.add_offset_pagination_option_to_parser(parser)
         return parser
 
     def take_action(self, parsed_args):

openstackclient/compute/v2/server_migration.py

@@ -19,6 +19,7 @@ from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -54,28 +55,7 @@ class ListMigration(command.Lister):
             ],
             help=_('Filter migrations by type'),
         )
-        parser.add_argument(
-            '--marker',
-            metavar='<marker>',
-            help=_(
-                "The last migration of the previous page; displays list "
-                "of migrations after 'marker'. Note that the marker is "
-                "the migration UUID. "
-                "(supported with --os-compute-api-version 2.59 or above)"
-            ),
-        )
-        parser.add_argument(
-            '--limit',
-            metavar='<limit>',
-            type=int,
-            help=_(
-                "Maximum number of migrations to display. Note that there "
-                "is a configurable max limit on the server, and the limit "
-                "that is used will be the minimum of what is requested "
-                "here and what is configured in the server. "
-                "(supported with --os-compute-api-version 2.59 or above)"
-            ),
-        )
+        pagination.add_marker_pagination_option_to_parser(parser)
         parser.add_argument(
             '--changes-since',
             dest='changes_since',

openstackclient/compute/v2/usage.py

@@ -153,7 +153,6 @@ class ListUsage(command.Lister):
         )
 
         date_cli_format = "%Y-%m-%d"
-        date_api_format = "%Y-%m-%dT%H:%M:%S"
         now = datetime.datetime.utcnow()
 
         if parsed_args.start:
@@ -170,8 +169,8 @@ class ListUsage(command.Lister):
 
         usage_list = list(
             compute_client.usages(
-                start=start.strftime(date_api_format),
-                end=end.strftime(date_api_format),
+                start=start,
+                end=end,
                 detailed=True,
             )
         )
@@ -239,7 +238,6 @@ class ShowUsage(command.ShowOne):
         identity_client = self.app.client_manager.identity
         compute_client = self.app.client_manager.sdk_connection.compute
         date_cli_format = "%Y-%m-%d"
-        date_api_format = "%Y-%m-%dT%H:%M:%S"
         now = datetime.datetime.utcnow()
 
         if parsed_args.start:
@@ -265,8 +263,8 @@ class ShowUsage(command.ShowOne):
 
         usage = compute_client.get_usage(
             project=project,
-            start=start.strftime(date_api_format),
-            end=end.strftime(date_api_format),
+            start=start,
+            end=end,
         )
 
         if parsed_args.formatter == 'table':

openstackclient/identity/v3/mapping.py

@@ -81,6 +81,21 @@ class _RulesReader(object):
         else:
             return rules
 
+    @staticmethod
+    def add_federated_schema_version_option(parser):
+        parser.add_argument(
+            '--schema-version',
+            metavar='<schema_version>',
+            required=False,
+            default=None,
+            help=_(
+                "The federated attribute mapping schema version. The "
+                "default value on the client side is 'None'; however, that "
+                "will lead the backend to set the default according to "
+                "'attribute_mapping_default_schema_version' option."
+            ),
+        )
+
 
 class CreateMapping(command.ShowOne, _RulesReader):
     _description = _("Create new mapping")
@@ -98,6 +113,7 @@ class CreateMapping(command.ShowOne, _RulesReader):
             required=True,
             help=_('Filename that contains a set of mapping rules (required)'),
         )
+        _RulesReader.add_federated_schema_version_option(parser)
         return parser
 
     def take_action(self, parsed_args):
@@ -105,7 +121,9 @@ class CreateMapping(command.ShowOne, _RulesReader):
 
         rules = self._read_rules(parsed_args.rules)
         mapping = identity_client.federation.mappings.create(
-            mapping_id=parsed_args.mapping, rules=rules
+            mapping_id=parsed_args.mapping,
+            rules=rules,
+            schema_version=parsed_args.schema_version,
         )
 
         mapping._info.pop('links', None)
@@ -158,7 +176,7 @@ class ListMapping(command.Lister):
         # rules, (s)he should show specific ones.
         identity_client = self.app.client_manager.identity
         data = identity_client.federation.mappings.list()
-        columns = ('ID',)
+        columns = ('ID', 'schema_version')
         items = [utils.get_item_properties(s, columns) for s in data]
         return (columns, items)
 
@@ -178,6 +196,8 @@ class SetMapping(command.Command, _RulesReader):
             metavar='<filename>',
             help=_('Filename that contains a new set of mapping rules'),
         )
+
+        _RulesReader.add_federated_schema_version_option(parser)
         return parser
 
     def take_action(self, parsed_args):
@@ -186,7 +206,9 @@ class SetMapping(command.Command, _RulesReader):
         rules = self._read_rules(parsed_args.rules)
 
         mapping = identity_client.federation.mappings.update(
-            mapping=parsed_args.mapping, rules=rules
+            mapping=parsed_args.mapping,
+            rules=rules,
+            schema_version=parsed_args.schema_version,
         )
 
         mapping._info.pop('links', None)

openstackclient/identity/v3/policy.py

@@ -92,7 +92,9 @@ class DeletePolicy(command.Command):
 
         if result > 0:
             total = len(parsed_args.policy)
-            msg = _("%(result)s of %(total)s policys failed " "to delete.") % {
+            msg = _(
+                "%(result)s of %(total)s policies failed " "to delete."
+            ) % {
                 'result': result,
                 'total': total,
             }

openstackclient/image/v2/cache.py

@@ -0,0 +1,218 @@
+# Copyright 2023 Red Hat.
+# All Rights Reserved.
+#
+# 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.
+
+import copy
+import datetime
+import logging
+
+from osc_lib.command import command
+from osc_lib import exceptions
+from osc_lib import utils
+
+from openstackclient.i18n import _
+
+
+LOG = logging.getLogger(__name__)
+
+
+def _format_image_cache(cached_images):
+    """Format image cache to make it more consistent with OSC operations."""
+
+    image_list = []
+    for item in cached_images:
+        if item == "cached_images":
+            for image in cached_images[item]:
+                image_obj = copy.deepcopy(image)
+                image_obj['state'] = 'cached'
+                image_obj[
+                    'last_accessed'
+                ] = datetime.datetime.utcfromtimestamp(
+                    image['last_accessed']
+                ).isoformat()
+                image_obj[
+                    'last_modified'
+                ] = datetime.datetime.utcfromtimestamp(
+                    image['last_modified']
+                ).isoformat()
+                image_list.append(image_obj)
+        elif item == "queued_images":
+            for image in cached_images[item]:
+                image = {'image_id': image}
+                image.update(
+                    {
+                        'state': 'queued',
+                        'last_accessed': 'N/A',
+                        'last_modified': 'N/A',
+                        'size': 'N/A',
+                        'hits': 'N/A',
+                    }
+                )
+                image_list.append(image)
+    return image_list
+
+
+class ListCachedImage(command.Lister):
+    _description = _("Get Cache State")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        return parser
+
+    def take_action(self, parsed_args):
+        image_client = self.app.client_manager.image
+
+        # List of Cache data received
+        data = _format_image_cache(dict(image_client.get_image_cache()))
+        columns = [
+            'image_id',
+            'state',
+            'last_accessed',
+            'last_modified',
+            'size',
+            'hits',
+        ]
+        column_headers = [
+            "ID",
+            "State",
+            "Last Accessed (UTC)",
+            "Last Modified (UTC)",
+            "Size",
+            "Hits",
+        ]
+
+        return (
+            column_headers,
+            (
+                utils.get_dict_properties(
+                    image,
+                    columns,
+                )
+                for image in data
+            ),
+        )
+
+
+class QueueCachedImage(command.Command):
+    _description = _("Queue image(s) for caching.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "images",
+            metavar="<image>",
+            nargs="+",
+            help=_("Image to display (name or ID)"),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        image_client = self.app.client_manager.image
+
+        failures = 0
+        for image in parsed_args.images:
+            try:
+                image_obj = image_client.find_image(
+                    image,
+                    ignore_missing=False,
+                )
+                image_client.queue_image(image_obj.id)
+            except Exception as e:
+                failures += 1
+                msg = _(
+                    "Failed to queue image with name or "
+                    "ID '%(image)s': %(e)s"
+                )
+                LOG.error(msg, {'image': image, 'e': e})
+
+        if failures > 0:
+            total = len(parsed_args.images)
+            msg = _("Failed to queue %(failures)s of %(total)s images") % {
+                'failures': failures,
+                'total': total,
+            }
+            raise exceptions.CommandError(msg)
+
+
+class DeleteCachedImage(command.Command):
+    _description = _("Delete image(s) from cache")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "images",
+            metavar="<image>",
+            nargs="+",
+            help=_("Image(s) to delete (name or ID)"),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        failures = 0
+        image_client = self.app.client_manager.image
+        for image in parsed_args.images:
+            try:
+                image_obj = image_client.find_image(
+                    image,
+                    ignore_missing=False,
+                )
+                image_client.cache_delete_image(image_obj.id)
+            except Exception as e:
+                failures += 1
+                msg = _(
+                    "Failed to delete image with name or "
+                    "ID '%(image)s': %(e)s"
+                )
+                LOG.error(msg, {'image': image, 'e': e})
+
+        if failures > 0:
+            total = len(parsed_args.images)
+            msg = _("Failed to delete %(failures)s of %(total)s images.") % {
+                'failures': failures,
+                'total': total,
+            }
+            raise exceptions.CommandError(msg)
+
+
+class ClearCachedImage(command.Command):
+    _description = _("Clear all images from cache, queue or both")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "--cache",
+            action="store_const",
+            const="cache",
+            dest="target",
+            help=_("Clears all the cached images"),
+        )
+        parser.add_argument(
+            "--queue",
+            action="store_const",
+            const="queue",
+            dest="target",
+            help=_("Clears all the queued images"),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        image_client = self.app.client_manager.image
+
+        target = parsed_args.target
+        try:
+            image_client.clear_cache(target)
+        except Exception:
+            msg = _("Failed to clear image cache")
+            LOG.error(msg)
+            raise exceptions.CommandError(msg)

openstackclient/image/v2/image.py

@@ -31,6 +31,7 @@ from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.common import pagination
 from openstackclient.common import progressbar
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
@@ -805,9 +806,9 @@ class ListImage(command.Lister):
             default=False,
             help=_('List additional fields in output'),
         )
-
         # --page-size has never worked, leave here for silent compatibility
         # We'll implement limit/marker differently later
+        # TODO(stephenfin): Remove this in the next major version bump
         parser.add_argument(
             "--page-size",
             metavar="<size>",
@@ -823,22 +824,7 @@ class ListImage(command.Lister):
                 "specified separated by comma"
             ),
         )
-        parser.add_argument(
-            "--limit",
-            metavar="<num-images>",
-            type=int,
-            help=_("Maximum number of images to display."),
-        )
-        parser.add_argument(
-            '--marker',
-            metavar='<image>',
-            default=None,
-            help=_(
-                "The last image of the previous page. Display "
-                "list of images after marker. Display all images if not "
-                "specified. (name or ID)"
-            ),
-        )
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(self, parsed_args):
@@ -1006,6 +992,43 @@ class RemoveProjectImage(command.Command):
         image_client.remove_member(member=project_id, image=image.id)
 
 
+class ShowProjectImage(command.ShowOne):
+    _description = _("Show a particular project associated with image")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "image",
+            metavar="<image>",
+            help=_("Image (name or ID)"),
+        )
+        parser.add_argument(
+            "member",
+            metavar="<project>",
+            help=_("Project to show (name or ID)"),
+        )
+        identity_common.add_project_domain_option_to_parser(parser)
+        return parser
+
+    def take_action(self, parsed_args):
+        image_client = self.app.client_manager.image
+
+        image = image_client.find_image(
+            parsed_args.image,
+            ignore_missing=False,
+        )
+
+        obj = image_client.get_member(
+            image=image.id,
+            member=parsed_args.member,
+        )
+
+        display_columns, columns = _get_member_columns(obj)
+        data = utils.get_item_properties(obj, columns, formatters={})
+
+        return (display_columns, data)
+
+
 class SaveImage(command.Command):
     _description = _("Save an image locally")