Source code for keystone.common.json_home

# Copyright 2014 IBM Corp.
#
# 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.
import typing as ty

from oslo_serialization import jsonutils

from keystone import exception
from keystone.i18n import _




def build_v3_resource_relation(resource_name):
    return (
        'https://docs.openstack.org/api/openstack-identity/3/rel/%s'
        % resource_name
    )





def build_v3_extension_resource_relation(
    extension_name, extension_version, resource_name
):
    return (
        'https://docs.openstack.org/api/openstack-identity/3/ext/%s/%s/rel/'
        '%s' % (extension_name, extension_version, resource_name)
    )





def build_v3_parameter_relation(parameter_name):
    return (
        'https://docs.openstack.org/api/openstack-identity/3/param/%s'
        % parameter_name
    )





def build_v3_extension_parameter_relation(
    extension_name, extension_version, parameter_name
):
    return (
        'https://docs.openstack.org/api/openstack-identity/3/ext/%s/%s/param/'
        '%s' % (extension_name, extension_version, parameter_name)
    )





class Parameters:
    """Relationships for Common parameters."""

    DOMAIN_ID = build_v3_parameter_relation('domain_id')
    ENDPOINT_ID = build_v3_parameter_relation('endpoint_id')
    GROUP_ID = build_v3_parameter_relation('group_id')
    POLICY_ID = build_v3_parameter_relation('policy_id')
    PROJECT_ID = build_v3_parameter_relation('project_id')
    REGION_ID = build_v3_parameter_relation('region_id')
    ROLE_ID = build_v3_parameter_relation('role_id')
    SERVICE_ID = build_v3_parameter_relation('service_id')
    USER_ID = build_v3_parameter_relation('user_id')
    TAG_VALUE = build_v3_parameter_relation('tag_value')
    REGISTERED_LIMIT_ID = build_v3_parameter_relation('registered_limit_id')
    LIMIT_ID = build_v3_parameter_relation('limit_id')
    APPLICATION_CRED_ID = build_v3_parameter_relation(
        'application_credential_id'
    )
    ACCESS_RULE_ID = build_v3_parameter_relation('access_rule_id')





class Status:
    """Status values supported."""

    DEPRECATED = 'deprecated'
    EXPERIMENTAL = 'experimental'
    STABLE = 'stable'



    @classmethod
    def update_resource_data(cls, resource_data, status):
        if status is cls.STABLE:
            # We currently do not add a status if the resource is stable, the
            # absence of the status property can be taken as meaning that the
            # resource is stable.
            return
        if status is cls.DEPRECATED or status is cls.EXPERIMENTAL:
            resource_data['hints'] = {'status': status}
            return

        raise exception.Error(
            message=_('Unexpected status requested for JSON Home response, %s')
            % status
        )






class JsonHomeResources:
    """JSON Home resource data."""

    __resources: dict = {}
    __serialized_resource_data: ty.Optional[str] = None

    @classmethod
    def _reset(cls):
        # NOTE(morgan): this will reset all json home resource definitions.
        # This is only used for testing.
        cls.__resources.clear()
        cls.__serialized_resource_data = None



    @classmethod
    def append_resource(cls, rel, data):
        cls.__resources[rel] = data
        cls.__serialized_resource_data = None




    @classmethod
    def resources(cls):
        # NOTE(morgan): We use a serialized form of the resource data to
        # ensure that the raw data is not changed by processing, this method
        # simply populates the serialized store if it is not already populated.
        # Any changes to this class storage object will result in clearing
        # the serialized data value.
        if cls.__serialized_resource_data is None:
            cls.__serialized_resource_data = jsonutils.dumps(cls.__resources)
        return {'resources': jsonutils.loads(cls.__serialized_resource_data)}






def translate_urls(json_home, new_prefix):
    """Given a JSON Home document, sticks new_prefix on each of the urls."""
    for dummy_rel, resource in json_home['resources'].items():
        if 'href' in resource:
            resource['href'] = new_prefix + resource['href']
        elif 'href-template' in resource:
            resource['href-template'] = new_prefix + resource['href-template']