Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 214
Expand file tree
/
Copy pathcommon.py
More file actions
500 lines (426 loc) · 15.8 KB
/
Copy pathcommon.py
File metadata and controls
500 lines (426 loc) · 15.8 KB
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# Copyright 2012-2013 OpenStack Foundation
#
# 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.
#
"""Common identity code"""
import argparse
from collections.abc import Callable
from typing import Any, cast
from keystoneclient import exceptions as identity_exc
from keystoneclient.v3 import domains
from keystoneclient.v3 import groups
from keystoneclient.v3 import projects
from keystoneclient.v3 import users
from openstack import exceptions as sdk_exceptions
from openstack.identity import v2 as identity_v2
from openstack.identity import v3 as identity_v3
from openstack.identity.v3 import service as _service
from openstack import utils as sdk_utils
from osc_lib import exceptions
from osc_lib import utils
from openstackclient.i18n import _
def find_service(identity_client: Any, name_type_or_id: str) -> Any:
"""Find a service by id, name or type."""
try:
# search for service id
return identity_client.services.get(name_type_or_id)
except identity_exc.NotFound:
# ignore NotFound exception, raise others
pass
try:
# search for service name
return identity_client.services.find(name=name_type_or_id)
except identity_exc.NotFound:
pass
except identity_exc.NoUniqueMatch:
msg = _(
"Multiple service matches found for '%s', "
"use an ID to be more specific."
)
raise exceptions.CommandError(msg % name_type_or_id)
try:
# search for service type
return identity_client.services.find(type=name_type_or_id)
except identity_exc.NotFound:
msg = _("No service with a type, name or ID of '%s' exists.")
raise exceptions.CommandError(msg % name_type_or_id)
except identity_exc.NoUniqueMatch:
msg = _(
"Multiple service matches found for '%s', "
"use an ID to be more specific."
)
raise exceptions.CommandError(msg % name_type_or_id)
def find_service_sdk(
identity_client: identity_v3.Proxy, name_type_or_id: str
) -> _service.Service:
"""Find a service by id, name or type."""
try:
# search for service name or ID
return identity_client.find_service(
name_type_or_id, ignore_missing=False
)
except sdk_exceptions.ResourceNotFound:
pass
except sdk_exceptions.DuplicateResource as e:
raise exceptions.CommandError(e.message)
# search for service type
services = identity_client.services(type=name_type_or_id)
try:
service = next(services)
except StopIteration:
msg = _(
"No service with a type, name or ID of '%(query)s' exists."
) % {"query": name_type_or_id}
raise exceptions.CommandError(msg)
if next(services, None):
msg = _(
"Multiple service matches found for '%(query)s', "
"use an ID to be more specific."
) % {"query": name_type_or_id}
raise exceptions.CommandError(msg)
return service
def get_resource(manager: Any, name_type_or_id: str) -> Any:
# NOTE (vishakha): Due to bug #1799153 and for any another related case
# where GET resource API does not support the filter by name,
# osc_lib.utils.find_resource() method cannot be used because that method
# try to fall back to list all the resource if requested resource cannot
# be get via name. Which ends up with NoUniqueMatch error.
# This new function is the replacement for osc_lib.utils.find_resource()
# for resources does not support GET by name.
# For example: identity GET /regions.
"""Find a resource by id or name."""
try:
return manager.get(name_type_or_id)
except identity_exc.NotFound:
# raise NotFound exception
msg = _("No resource with name or id of '%s' exists")
raise exceptions.CommandError(msg % name_type_or_id)
def get_resource_by_id(manager: Any, resource_id: str) -> Any:
"""Get resource by ID
Raises CommandError if the resource is not found
"""
try:
return manager.get(resource_id)
except identity_exc.NotFound:
msg = _("Resource with id {} not found")
raise exceptions.CommandError(msg.format(resource_id))
def _get_token_resource(
client: Any,
resource: str,
parsed_name: str,
parsed_domain: str | None = None,
) -> str:
"""Peek into the user's auth token to get resource IDs
Look into a user's token to try and find the ID of a domain, project or
user, when given the name. Typically non-admin users will interact with
the CLI using names. However, by default, keystone does not allow look up
by name since it would involve listing all entities. Instead opt to use
the correct ID (from the token) instead.
:param client: An identity client
:param resource: A resource to look at in the token, this may be `domain`,
`project_domain`, `user_domain`, `project`, or `user`.
:param parsed_name: This is input from parsed_args that the user is hoping
to find in the token.
:param parsed_domain: This is domain filter from parsed_args that used to
filter the results.
:returns: The ID of the resource from the token, or the original value from
parsed_args if it does not match.
"""
try:
token = client.auth.client.get_token()
token_data = client.tokens.get_token_data(token)
token_dict = token_data['token']
# NOTE(stevemar): If domain is passed, just look at the project domain.
if resource == 'domain':
token_dict = token_dict['project']
obj = token_dict[resource]
# user/project under different domain may has a same name
if parsed_domain and parsed_domain not in obj['domain'].values():
return parsed_name
if isinstance(obj, list):
for item in obj:
if item['name'] == parsed_name:
return cast(str, item['id'])
if item['id'] == parsed_name:
return parsed_name
return parsed_name
return obj['id'] if obj['name'] == parsed_name else parsed_name
# diaper defense in case parsing the token fails
except Exception:
return parsed_name
def find_domain(identity_client: Any, name_or_id: str) -> domains.Domain:
return _find_identity_resource(
identity_client.domains, name_or_id, domains.Domain
)
def find_domain_id_sdk(
identity_client: identity_v3.Proxy,
name_or_id: str,
*,
validate_actor_existence: bool = True,
) -> str:
return _find_sdk_id(
identity_client.find_domain,
name_or_id=name_or_id,
validate_actor_existence=validate_actor_existence,
)
def find_group(
identity_client: Any,
name_or_id: str,
domain_name_or_id: str | None = None,
) -> groups.Group:
if domain_name_or_id is None:
return _find_identity_resource(
identity_client.groups, name_or_id, groups.Group
)
domain_id = find_domain(identity_client, domain_name_or_id).id
return _find_identity_resource(
identity_client.groups,
name_or_id,
groups.Group,
domain_id=domain_id,
)
def find_group_id_sdk(
identity_client: identity_v3.Proxy,
name_or_id: str,
domain_name_or_id: str | None = None,
*,
validate_actor_existence: bool = True,
) -> str:
if domain_name_or_id is None:
return _find_sdk_id(
identity_client.find_group,
name_or_id=name_or_id,
validate_actor_existence=validate_actor_existence,
)
domain_id = find_domain_id_sdk(
identity_client,
name_or_id=domain_name_or_id,
validate_actor_existence=validate_actor_existence,
)
return _find_sdk_id(
identity_client.find_group,
name_or_id=name_or_id,
validate_actor_existence=validate_actor_existence,
domain_id=domain_id,
)
def find_project(
identity_client: Any,
name_or_id: str,
domain_name_or_id: str | None = None,
) -> projects.Project:
if domain_name_or_id is None:
return _find_identity_resource(
identity_client.projects, name_or_id, projects.Project
)
domain_id = find_domain(identity_client, domain_name_or_id).id
return _find_identity_resource(
identity_client.projects,
name_or_id,
projects.Project,
domain_id=domain_id,
)
def find_project_id_sdk(
identity_client: identity_v2.Proxy | identity_v3.Proxy,
name_or_id: str,
domain_name_or_id: str | None = None,
*,
validate_actor_existence: bool = True,
validate_domain_actor_existence: bool | None = None,
) -> str:
if domain_name_or_id is None:
if isinstance(identity_client, identity_v2.Proxy):
return _find_sdk_id(
identity_client.find_tenant,
name_or_id=name_or_id,
validate_actor_existence=validate_actor_existence,
)
return _find_sdk_id(
identity_client.find_project,
name_or_id=name_or_id,
validate_actor_existence=validate_actor_existence,
)
if validate_domain_actor_existence is None:
validate_domain_actor_existence = validate_actor_existence
# only v3 supports the concept of domains
identity_client = sdk_utils.ensure_service_version(identity_client, '3')
domain_id = find_domain_id_sdk(
identity_client,
name_or_id=domain_name_or_id,
validate_actor_existence=validate_domain_actor_existence,
)
return _find_sdk_id(
identity_client.find_project,
name_or_id=name_or_id,
validate_actor_existence=validate_actor_existence,
domain_id=domain_id,
)
def find_user(
identity_client: Any,
name_or_id: str,
domain_name_or_id: str | None = None,
) -> users.User:
if domain_name_or_id is None:
return _find_identity_resource(
identity_client.users, name_or_id, users.User
)
domain_id = find_domain(identity_client, domain_name_or_id).id
return _find_identity_resource(
identity_client.users, name_or_id, users.User, domain_id=domain_id
)
def find_user_id_sdk(
identity_client: identity_v2.Proxy | identity_v3.Proxy,
name_or_id: str,
domain_name_or_id: str | None = None,
*,
validate_actor_existence: bool = True,
) -> str:
if domain_name_or_id is None:
return _find_sdk_id(
identity_client.find_user,
name_or_id=name_or_id,
validate_actor_existence=validate_actor_existence,
)
# only v3 supports the concept of domains
identity_client = sdk_utils.ensure_service_version(identity_client, '3')
domain_id = find_domain_id_sdk(
identity_client,
name_or_id=domain_name_or_id,
validate_actor_existence=validate_actor_existence,
)
return _find_sdk_id(
identity_client.find_user,
name_or_id=name_or_id,
validate_actor_existence=validate_actor_existence,
domain_id=domain_id,
)
def _find_identity_resource(
identity_client_manager: Any,
name_or_id: str,
resource_type: Any,
**kwargs: Any,
) -> Any:
"""Find a specific identity resource.
Using keystoneclient's manager, attempt to find a specific resource by its
name or ID. If Forbidden to find the resource (a common case if the user
does not have permission), then return the resource by creating a local
instance of keystoneclient's Resource.
The parameter identity_client_manager is a keystoneclient manager,
for example: keystoneclient.v3.users or keystoneclient.v3.projects.
The parameter resource_type is a keystoneclient resource, for example:
keystoneclient.v3.users.User or keystoneclient.v3.projects.Project.
:param identity_client_manager: the manager that contains the resource
:type identity_client_manager: `keystoneclient.base.CrudManager`
:param name_or_id: the resources's name or ID
:type name_or_id: string
:param resource_type: class that represents the resource type
:type resource_type: `keystoneclient.base.Resource`
:returns: the resource in question
:rtype: `keystoneclient.base.Resource`
"""
try:
identity_resource = utils.find_resource(
identity_client_manager, name_or_id, **kwargs
)
if identity_resource is not None:
return identity_resource
except (exceptions.Forbidden, identity_exc.Forbidden):
pass
return resource_type(None, {'id': name_or_id, 'name': name_or_id})
def _find_sdk_id(
find_command: Callable[..., Any],
name_or_id: str,
*,
validate_actor_existence: bool = True,
**kwargs: Any,
) -> str:
try:
resource = find_command(
name_or_id=name_or_id, ignore_missing=False, **kwargs
)
except sdk_exceptions.ForbiddenException:
return name_or_id
except sdk_exceptions.ResourceNotFound as exc:
if not validate_actor_existence:
return name_or_id
raise exceptions.CommandError from exc
return cast(str, resource.id)
def add_user_domain_option_to_parser(parser: argparse.ArgumentParser) -> None:
parser.add_argument(
'--user-domain',
metavar='<user-domain>',
help=_(
'Domain the user belongs to (name or ID). '
'This can be used in case collisions between user names '
'exist.'
),
)
def add_group_domain_option_to_parser(parser: argparse.ArgumentParser) -> None:
parser.add_argument(
'--group-domain',
metavar='<group-domain>',
help=_(
'Domain the group belongs to (name or ID). '
'This can be used in case collisions between group names '
'exist.'
),
)
def add_project_domain_option_to_parser(
parser: argparse.ArgumentParser,
) -> None:
parser.add_argument(
'--project-domain',
metavar='<project-domain>',
help=_(
'Domain the project belongs to (name or ID). This '
'can be used in case collisions between project '
'names exist.'
),
)
def add_role_domain_option_to_parser(parser: argparse.ArgumentParser) -> None:
parser.add_argument(
'--role-domain',
metavar='<role-domain>',
help=_(
'Domain the role belongs to (name or ID). '
'This must be specified when the name of a domain specific '
'role is used.'
),
)
def add_inherited_option_to_parser(parser: argparse.ArgumentParser) -> None:
parser.add_argument(
'--inherited',
action='store_true',
default=False,
help=_(
'Specifies if the role grant is inheritable to the sub projects'
),
)
def add_resource_option_to_parser(parser: argparse.ArgumentParser) -> None:
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'
),
)
immutable_group.add_argument(
'--no-immutable',
action='store_false',
dest='immutable',
default=None,
help=_('Make resource mutable (default)'),
)
You can’t perform that action at this time.