131 lines
4.5 KiB
Python
131 lines
4.5 KiB
Python
|
# Copyright 2016 NEC Corporation
|
||
|
|
#
|
||
|
|
# 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.
|
||
|
|
|
||
|
|
"""This module should contain OSC plugin generic methods.
|
||
|
|
|
||
|
|
Methods in this module are candidates adopted to osc-lib.
|
||
|
|
|
||
|
|
Stuffs specific to neutronclient OSC plugin should not be added
|
||
|
|
to this module. They should go to neutronclient.osc.v2.utils.
|
||
|
|
"""
|
||
|
|
|
||
|
|
from keystoneclient import exceptions as identity_exc
|
||
|
|
from keystoneclient.v3 import domains
|
||
|
|
from keystoneclient.v3 import projects
|
||
|
|
from osc_lib import utils
|
||
|
|
|
||
|
|
from neutronclient._i18n import _
|
||
|
|
|
||
|
|
|
||
|
|
# TODO(amotoki): Use osc-lib version once osc-lib provides this.
|
||
|
|
def add_project_owner_option_to_parser(parser):
|
||
|
|
"""Register project and project domain options.
|
||
|
|
|
||
|
|
:param parser: argparse.Argument parser object.
|
||
|
|
|
||
|
|
"""
|
||
|
|
parser.add_argument(
|
||
|
|
'--project',
|
||
|
|
metavar='<project>',
|
||
|
|
help=_("Owner's project (name or ID)")
|
||
|
|
)
|
||
|
|
# Borrowed from openstackclient.identity.common
|
||
|
|
# as it is not exposed officially.
|
||
|
|
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.'),
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
# The following methods are borrowed from openstackclient.identity.common
|
||
|
|
# as it is not exposed officially.
|
||
|
|
# TODO(amotoki): Use osc-lib version once osc-lib provides this.
|
||
|
|
|
||
|
|
|
||
|
|
def find_domain(identity_client, name_or_id):
|
||
|
|
return _find_identity_resource(identity_client.domains, name_or_id,
|
||
|
|
domains.Domain)
|
||
|
|
|
||
|
|
|
||
|
|
def find_project(identity_client, name_or_id, domain_name_or_id=None):
|
||
|
|
domain_id = _get_domain_id_if_requested(identity_client, domain_name_or_id)
|
||
|
|
if not domain_id:
|
||
|
|
return _find_identity_resource(identity_client.projects, name_or_id,
|
||
|
|
projects.Project)
|
||
|
|
else:
|
||
|
|
return _find_identity_resource(identity_client.projects, name_or_id,
|
||
|
|
projects.Project, domain_id=domain_id)
|
||
|
|
|
||
|
|
|
||
|
|
def _get_domain_id_if_requested(identity_client, domain_name_or_id):
|
||
|
|
if not domain_name_or_id:
|
||
|
|
return None
|
||
|
|
domain = find_domain(identity_client, domain_name_or_id)
|
||
|
|
return domain.id
|
||
|
|
|
||
|
|
|
||
|
|
def _find_identity_resource(identity_client_manager, name_or_id,
|
||
|
|
resource_type, **kwargs):
|
||
|
|
"""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 identity_exc.Forbidden:
|
||
|
|
pass
|
||
|
|
|
||
|
|
return resource_type(None, {'id': name_or_id, 'name': name_or_id})
|
||
|
|
|
||
|
|
|
||
|
|
# The above are borrowed from openstackclient.identity.common.
|
||
|
|
# DO NOT ADD original methods in neutronclient repo to the above area.
|
||
|
|
|
||
|
|
|
||
|
|
def _get_columns(item):
|
||
|
|
column_map = {}
|
||
|
|
hidden_columns = ['location', 'tenant_id']
|
||
|
|
return utils.get_osc_show_columns_for_sdk_resource(
|
||
|
|
item,
|
||
|
|
column_map,
|
||
|
|
hidden_columns
|
||
|
|
)
|