share: Import commands (1/n)

Import the following commands:

* share lock *
* share message *
* share security service *
* share service *

Change-Id: I5758625ea0a7e78913cbd032377fcc9857f8b480
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Author: stephenfin

openstackclient/share/v2/messages.py

@@ -0,0 +1,226 @@
+#    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 argparse
+from collections.abc import Iterable, Sequence
+import logging
+from typing import Any
+
+from manilaclient import api_versions
+from manilaclient.common.apiclient import utils as apiutils
+from osc_lib import exceptions
+from osc_lib import utils as oscutils
+
+from openstackclient import command
+from openstackclient.i18n import _
+
+LOG = logging.getLogger(__name__)
+
+MESSAGE_ATTRIBUTES = [
+    'id',
+    'resource_type',
+    'resource_id',
+    'action_id',
+    'user_message',
+    'message_level',
+    'detail_id',
+    'created_at',
+    'expires_at',
+    'request_id',
+]
+
+
+class DeleteMessage(command.Command):
+    """Remove one or more messages."""
+
+    _description = _("Remove one or more messages")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'message',
+            metavar='<message>',
+            nargs='+',
+            help=_('ID of the message(s).'),
+        )
+        return parser
+
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        share_client = self.app.client_manager.share
+        failure_count = 0
+
+        for message in parsed_args.message:
+            try:
+                message_ref = apiutils.find_resource(
+                    share_client.messages, message
+                )
+                share_client.messages.delete(message_ref)
+            except Exception as e:
+                failure_count += 1
+                LOG.error(
+                    _("Delete for message %(message)s failed: %(e)s"),
+                    {'message': message, 'e': e},
+                )
+
+        if failure_count > 0:
+            raise exceptions.CommandError(
+                _("Unable to delete some or all of the specified messages.")
+            )
+
+
+class ListMessage(command.Lister):
+    """Lists all messages."""
+
+    _description = _("Lists all messages")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            '--resource-id',
+            metavar='<resource-id>',
+            default=None,
+            help=_('Filters results by a resource uuid. Default=None.'),
+        )
+        parser.add_argument(
+            '--resource-type',
+            metavar='<resource-type>',
+            default=None,
+            help=_(
+                'Filters results by a resource type. Default=None. '
+                'Example: "openstack message list --resource-type share"'
+            ),
+        )
+        parser.add_argument(
+            '--action-id',
+            metavar='<action-id>',
+            default=None,
+            help=_('Filters results by action id. Default=None.'),
+        )
+        parser.add_argument(
+            '--detail-id',
+            metavar='<detail-id>',
+            default=None,
+            help=_('Filters results by detail id. Default=None.'),
+        )
+        parser.add_argument(
+            '--request-id',
+            metavar='<request-id>',
+            default=None,
+            help=_('Filters results by request id. Default=None.'),
+        )
+        parser.add_argument(
+            '--message-level',
+            metavar='<message-level>',
+            default=None,
+            help=_(
+                'Filters results by the message level. Default=None. '
+                'Example: "openstack message list --message-level ERROR".'
+            ),
+        )
+        parser.add_argument(
+            '--limit',
+            metavar='<limit>',
+            type=int,
+            default=None,
+            help=_('Maximum number of messages to return. (Default=None)'),
+        )
+        parser.add_argument(
+            '--since',
+            metavar='<since>',
+            default=None,
+            help=_(
+                'Return only user messages created since given date. '
+                'The date format must be conforming to ISO8601. '
+                'Available only for microversion >= 2.52.'
+            ),
+        )
+        parser.add_argument(
+            '--before',
+            metavar='<before>',
+            default=None,
+            help=_(
+                'Return only user messages created before given date. '
+                'The date format must be conforming to ISO8601. '
+                'Available only for microversion >= 2.52.'
+            ),
+        )
+        return parser
+
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
+        share_client = self.app.client_manager.share
+
+        search_opts = {
+            'limit': parsed_args.limit,
+            'request_id': parsed_args.request_id,
+            'resource_type': parsed_args.resource_type,
+            'resource_id': parsed_args.resource_id,
+            'action_id': parsed_args.action_id,
+            'detail_id': parsed_args.detail_id,
+            'message_level': parsed_args.message_level,
+        }
+
+        if share_client.api_version < api_versions.APIVersion("2.52"):
+            if getattr(parsed_args, 'since') or getattr(parsed_args, 'before'):
+                raise exceptions.CommandError(
+                    _(
+                        "Filtering messages by 'since' and 'before'"
+                        " is possible only with Manila API version >=2.52"
+                    )
+                )
+        else:
+            search_opts['created_since'] = parsed_args.since
+            search_opts['created_before'] = parsed_args.before
+
+        messages = share_client.messages.list(search_opts=search_opts)
+        columns = [
+            'ID',
+            'Resource Type',
+            'Resource ID',
+            'Action ID',
+            'User Message',
+            'Detail ID',
+            'Created At',
+        ]
+
+        return (
+            columns,
+            (oscutils.get_item_properties(m, columns) for m in messages),
+        )
+
+
+class ShowMessage(command.ShowOne):
+    """Show details about a message."""
+
+    _description = _("Show details about a message")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'message', metavar='<message>', help=_('ID of the message.')
+        )
+        return parser
+
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], tuple[Any, ...]]:
+        share_client = self.app.client_manager.share
+
+        message = apiutils.find_resource(
+            share_client.messages, parsed_args.message
+        )
+
+        return (
+            MESSAGE_ATTRIBUTES,
+            oscutils.get_dict_properties(message._info, MESSAGE_ATTRIBUTES),
+        )