1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
|
# Copyright 2017 Huawei, Inc. 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.
#
"""Compute v2 Server operation event implementations"""
import logging
import uuid
from cliff import columns
import iso8601
from openstack import exceptions as sdk_exceptions
from openstack import utils as sdk_utils
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__)
# 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.
Format the :class:`~openstack.compute.v2.server_action.ServerActionEvent`
objects as we'd like.
"""
def _format_event(self, event):
column_map = {}
hidden_columns = ['id', 'name', 'location']
_, columns = utils.get_osc_show_columns_for_sdk_resource(
event,
column_map,
hidden_columns,
)
data = utils.get_item_properties(
event,
columns,
)
return dict(zip(columns, data))
def human_readable(self):
events = [self._format_event(event) for event in self._value]
return utils.format_list_of_dicts(events)
def machine_readable(self):
events = [self._format_event(event) for event in self._value]
return events
def _get_server_event_columns(item, client):
column_map = {}
hidden_columns = ['name', 'server_id', 'links', 'location']
if not sdk_utils.supports_microversion(client, '2.58'):
# updated_at was introduced in 2.58
hidden_columns.append('updated_at')
return utils.get_osc_show_columns_for_sdk_resource(
item,
column_map,
hidden_columns,
)
class ListServerEvent(command.Lister):
"""List recent events of a server.
Specify ``--os-compute-api-version 2.21`` or higher to show events for a
deleted server, specified by ID only.
"""
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'server',
metavar='<server>',
help=_('Server to list events (name or ID)'),
)
parser.add_argument(
'--long',
action='store_true',
default=False,
help=_("List additional fields in output"),
)
parser.add_argument(
'--changes-since',
dest='changes_since',
metavar='<changes-since>',
help=_(
"List only server events changed later or equal to a certain "
"point of time. The provided time should be an ISO 8061 "
"formatted time, e.g. ``2016-03-04T06:27:59Z``. "
"(supported with --os-compute-api-version 2.58 or above)"
),
)
parser.add_argument(
'--changes-before',
dest='changes_before',
metavar='<changes-before>',
help=_(
"List only server events changed earlier or equal to a "
"certain point of time. The provided time should be an ISO "
"8061 formatted time, e.g. ``2016-03-04T06:27:59Z``. "
"(supported with --os-compute-api-version 2.66 or above)"
),
)
pagination.add_marker_pagination_option_to_parser(parser)
return parser
def take_action(self, parsed_args):
compute_client = self.app.client_manager.sdk_connection.compute
kwargs = {}
if parsed_args.marker:
if not sdk_utils.supports_microversion(compute_client, '2.58'):
msg = _(
'--os-compute-api-version 2.58 or greater is required to '
'support the --marker option'
)
raise exceptions.CommandError(msg)
kwargs['marker'] = parsed_args.marker
if parsed_args.limit:
if not sdk_utils.supports_microversion(compute_client, '2.58'):
msg = _(
'--os-compute-api-version 2.58 or greater is required to '
'support the --limit option'
)
raise exceptions.CommandError(msg)
kwargs['limit'] = parsed_args.limit
kwargs['paginated'] = False
if parsed_args.changes_since:
if not sdk_utils.supports_microversion(compute_client, '2.58'):
msg = _(
'--os-compute-api-version 2.58 or greater is required to '
'support the --changes-since option'
)
raise exceptions.CommandError(msg)
try:
iso8601.parse_date(parsed_args.changes_since)
except (TypeError, iso8601.ParseError):
msg = _('Invalid changes-since value: %s')
raise exceptions.CommandError(msg % parsed_args.changes_since)
kwargs['changes_since'] = parsed_args.changes_since
if parsed_args.changes_before:
if not sdk_utils.supports_microversion(compute_client, '2.66'):
msg = _(
'--os-compute-api-version 2.66 or greater is required to '
'support the --changes-before option'
)
raise exceptions.CommandError(msg)
try:
iso8601.parse_date(parsed_args.changes_before)
except (TypeError, iso8601.ParseError):
msg = _('Invalid changes-before value: %s')
raise exceptions.CommandError(msg % parsed_args.changes_before)
kwargs['changes_before'] = parsed_args.changes_before
try:
server_id = compute_client.find_server(
parsed_args.server, ignore_missing=False
).id
except sdk_exceptions.ResourceNotFound:
# 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 is_uuid_like(parsed_args.server):
server_id = parsed_args.server
else:
raise
data = compute_client.server_actions(server_id, **kwargs)
columns = (
'request_id',
'server_id',
'action',
'start_time',
)
column_headers = (
'Request ID',
'Server ID',
'Action',
'Start Time',
)
if parsed_args.long:
columns += (
'message',
'project_id',
'user_id',
)
column_headers += (
'Message',
'Project ID',
'User ID',
)
return (
column_headers,
(utils.get_item_properties(s, columns) for s in data),
)
class ShowServerEvent(command.ShowOne):
"""Show server event details.
Specify ``--os-compute-api-version 2.21`` or higher to show event details
for a deleted server, specified by ID only. Specify
``--os-compute-api-version 2.51`` or higher to show event details for
non-admin users.
"""
def get_parser(self, prog_name):
parser = super().get_parser(prog_name)
parser.add_argument(
'server',
metavar='<server>',
help=_('Server to show event details (name or ID)'),
)
parser.add_argument(
'request_id',
metavar='<request-id>',
help=_('Request ID of the event to show (ID only)'),
)
return parser
def take_action(self, parsed_args):
compute_client = self.app.client_manager.sdk_connection.compute
try:
server_id = compute_client.find_server(
parsed_args.server,
ignore_missing=False,
).id
except sdk_exceptions.ResourceNotFound:
# 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 is_uuid_like(parsed_args.server):
server_id = parsed_args.server
else:
raise
server_action = compute_client.get_server_action(
parsed_args.request_id,
server_id,
)
column_headers, columns = _get_server_event_columns(
server_action,
compute_client,
)
return (
column_headers,
utils.get_item_properties(
server_action,
columns,
formatters={'events': ServerActionEventColumn},
),
)
|