101 lines
4.2 KiB
Python
101 lines
4.2 KiB
Python
# (c) Copyright 2014 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 neutron_lib.plugins import constants
|
|
from neutron_lib.plugins import directory
|
|
from oslo_log import log as logging
|
|
|
|
from neutron.api import extensions
|
|
from neutron.api.v2 import base
|
|
from neutron.quota import resource_registry
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def build_plural_mappings(special_mappings, resource_map):
|
|
"""Create plural to singular mapping for all resources.
|
|
|
|
Allows for special mappings to be provided, for particular cases..
|
|
Otherwise, will strip off the last character for normal mappings, like
|
|
routers -> router, unless the plural name ends with 'ies', in which
|
|
case the singular form will end with a 'y' (e.g.: policy/policies)
|
|
"""
|
|
plural_mappings = {}
|
|
for plural in resource_map:
|
|
singular = special_mappings.get(plural)
|
|
if not singular:
|
|
if plural.endswith('ies'):
|
|
singular = "%sy" % plural[:-3]
|
|
else:
|
|
singular = plural[:-1]
|
|
plural_mappings[plural] = singular
|
|
return plural_mappings
|
|
|
|
|
|
def build_resource_info(plural_mappings, resource_map, which_service,
|
|
action_map=None, register_quota=False,
|
|
translate_name=False, allow_bulk=False):
|
|
"""Build resources for advanced services.
|
|
|
|
Takes the resource information, and singular/plural mappings, and creates
|
|
API resource objects for advanced services extensions. Will optionally
|
|
translate underscores to dashes in resource names, register the resource,
|
|
and accept action information for resources.
|
|
|
|
:param plural_mappings: mappings between singular and plural forms
|
|
:param resource_map: attribute map for the WSGI resources to create
|
|
:param which_service: The name of the service for which the WSGI resources
|
|
are being created. This name will be used to pass
|
|
the appropriate plugin to the WSGI resource.
|
|
It can be set to None or "CORE" to create WSGI
|
|
resources for the core plugin
|
|
:param action_map: custom resource actions
|
|
:param register_quota: it can be set to True to register quotas for the
|
|
resource(s) being created
|
|
:param translate_name: replaces underscores with dashes
|
|
:param allow_bulk: True if bulk create are allowed
|
|
"""
|
|
resources = []
|
|
if not which_service:
|
|
which_service = constants.CORE
|
|
if action_map is None:
|
|
action_map = {}
|
|
plugin = directory.get_plugin(which_service)
|
|
path_prefix = getattr(plugin, "path_prefix", "")
|
|
LOG.debug('Service %(service)s assigned prefix: %(prefix)s',
|
|
{'service': which_service, 'prefix': path_prefix})
|
|
for collection_name in resource_map:
|
|
resource_name = plural_mappings[collection_name]
|
|
params = resource_map.get(collection_name, {})
|
|
if translate_name:
|
|
collection_name = collection_name.replace('_', '-')
|
|
if register_quota:
|
|
resource_registry.register_resource_by_name(resource_name)
|
|
member_actions = action_map.get(resource_name, {})
|
|
controller = base.create_resource(
|
|
collection_name, resource_name, plugin, params,
|
|
member_actions=member_actions,
|
|
allow_bulk=allow_bulk,
|
|
allow_pagination=True,
|
|
allow_sorting=True)
|
|
resource = extensions.ResourceExtension(
|
|
collection_name,
|
|
controller,
|
|
path_prefix=path_prefix,
|
|
member_actions=member_actions,
|
|
attr_map=params)
|
|
resources.append(resource)
|
|
return resources
|