116 lines
4.5 KiB
Python
116 lines
4.5 KiB
Python
# Copyright (c) 2016 Cisco Systems 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.
|
|
|
|
from gbpclient.v2_0 import client as gbp_client
|
|
from keystoneclient import auth as ksc_auth
|
|
from keystoneclient import session as ksc_session
|
|
from keystoneclient.v3 import client as ksc_client
|
|
from oslo_config import cfg
|
|
from oslo_log import log as logging
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
# REVISIT(rkukura): We use keystone to get the name of the keystone
|
|
# project owning each neutron resource, which by default, requires
|
|
# admin. If we keep this, we should probably move it to a separate
|
|
# config module. But we should also investigate whether admin is even
|
|
# needed, or if neutron's credentials could somehow be used.
|
|
AUTH_GROUP = 'apic_aim_auth'
|
|
ksc_session.Session.register_conf_options(cfg.CONF, AUTH_GROUP)
|
|
ksc_auth.register_conf_options(cfg.CONF, AUTH_GROUP)
|
|
|
|
|
|
class ProjectNameCache(object):
|
|
"""Cache of Keystone project ID to project name mappings."""
|
|
|
|
def __init__(self):
|
|
self.project_names = {}
|
|
self.keystone = None
|
|
self.gbp = None
|
|
|
|
def _get_keystone_client(self):
|
|
# REVISIT: It seems load_from_conf_options() and
|
|
# keystoneclient auth plugins have been deprecated, and we
|
|
# should use keystoneauth instead.
|
|
LOG.debug("Getting keystone client")
|
|
auth = ksc_auth.load_from_conf_options(cfg.CONF, AUTH_GROUP)
|
|
LOG.debug("Got auth: %s", auth)
|
|
if not auth:
|
|
LOG.warning('No auth_plugin configured in %s',
|
|
AUTH_GROUP)
|
|
session = ksc_session.Session.load_from_conf_options(
|
|
cfg.CONF, AUTH_GROUP, auth=auth)
|
|
LOG.debug("Got session: %s", session)
|
|
self.keystone = ksc_client.Client(session=session)
|
|
LOG.debug("Got keystone client: %s", self.keystone)
|
|
self.gbp = gbp_client.Client(session=session)
|
|
LOG.debug("Got gbp client: %s", self.gbp)
|
|
|
|
def ensure_project(self, project_id):
|
|
"""Ensure cache contains mapping for project.
|
|
|
|
:param project_id: ID of the project
|
|
|
|
Ensure that the cache contains a mapping for the project
|
|
identified by project_id. If it is not, Keystone will be
|
|
queried for the current list of projects, and any new mappings
|
|
will be added to the cache. This method should never be called
|
|
inside a transaction with a project_id not already in the
|
|
cache.
|
|
"""
|
|
if project_id and project_id not in self.project_names:
|
|
self.load_projects()
|
|
|
|
def load_projects(self):
|
|
# REVISIT: Does this need locking to prevent concurrent calls?
|
|
if self.keystone is None:
|
|
self._get_keystone_client()
|
|
LOG.debug("Calling project API")
|
|
projects = self.keystone.projects.list()
|
|
LOG.debug("Received projects: %s", projects)
|
|
for project in projects:
|
|
self.project_names[project.id] = project.name
|
|
|
|
def get_project_name(self, project_id):
|
|
"""Get name of project from cache.
|
|
|
|
:param project_id: ID of the project
|
|
|
|
Get the name of the project identified by project_id from the
|
|
cache. If the cache contains project_id, the project's name is
|
|
returned. If not, None is returned.
|
|
"""
|
|
return self.project_names.get(project_id)
|
|
|
|
def update_project_name(self, project_id):
|
|
if self.keystone is None:
|
|
self._get_keystone_client()
|
|
if self.keystone:
|
|
LOG.debug("Calling project API")
|
|
project = self.keystone.projects.get(project_id)
|
|
# only return project name when there is a change
|
|
if project and self.project_names.get(project_id) != project.name:
|
|
self.project_names[project.id] = project.name
|
|
return project.name
|
|
return None
|
|
|
|
def purge_gbp(self, project_id):
|
|
if self.gbp is None:
|
|
self._get_keystone_client()
|
|
if self.gbp:
|
|
LOG.debug("Calling gbp purge() API")
|
|
self.gbp.purge(project_id)
|