044f389848
Similar to other openstack projects, monasca-api should provide information about request's context in the log information. This is done by: * implementing custom Request that creates context (oslo.context) * changing logging configuration to use ContextLogFormatter Since information like tenant-id can be retrieved from the context, modified resource code to use that. Also moved 'limit' directly to request property. Change-Id: I917fa2cba99dc668842fea0a62cda2cabd796d09
110 lines
3.0 KiB
Python
110 lines
3.0 KiB
Python
# Copyright 2016 FUJITSU LIMITED
|
|
#
|
|
# 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 falcon
|
|
|
|
from oslo_context import context
|
|
|
|
from monasca_api.common.repositories import constants
|
|
from monasca_api.v2.common import exceptions
|
|
|
|
_TENANT_ID_PARAM = 'tenant_id'
|
|
"""Name of the query-param pointing at project-id (tenant-id)"""
|
|
|
|
|
|
class Request(falcon.Request):
|
|
"""Variation of falcon.Request with context
|
|
|
|
Following class enhances :py:class:`falcon.Request` with
|
|
:py:class:`context.RequestContext`.
|
|
|
|
"""
|
|
|
|
def __init__(self, env, options=None):
|
|
super(Request, self).__init__(env, options)
|
|
self.context = context.RequestContext.from_environ(self.env)
|
|
|
|
@property
|
|
def project_id(self):
|
|
"""Returns project-id (tenant-id)
|
|
|
|
:return: project-id
|
|
:rtype: str
|
|
|
|
"""
|
|
return self.context.tenant
|
|
|
|
@property
|
|
def cross_project_id(self):
|
|
"""Returns project-id (tenant-id) found in query params.
|
|
|
|
This particular project-id is later on identified as
|
|
cross-project-id
|
|
|
|
:return: project-id
|
|
:rtype: str
|
|
|
|
"""
|
|
return self.get_param(_TENANT_ID_PARAM, required=False)
|
|
|
|
@property
|
|
def user_id(self):
|
|
"""Returns user-id
|
|
|
|
:return: user-id
|
|
:rtype: str
|
|
|
|
"""
|
|
return self.context.user
|
|
|
|
@property
|
|
def roles(self):
|
|
"""Returns roles associated with user
|
|
|
|
:return: user's roles
|
|
:rtype: list
|
|
|
|
"""
|
|
return self.context.roles
|
|
|
|
@property
|
|
def limit(self):
|
|
"""Returns LIMIT query param value.
|
|
|
|
'limit' is not required query param.
|
|
In case it is not found, py:data:'.constants.PAGE_LIMIT'
|
|
value is returned.
|
|
|
|
:return: value of 'limit' query param or default value
|
|
:rtype: int
|
|
:raise exceptions.HTTPUnprocessableEntityError: if limit is not valid integer
|
|
|
|
"""
|
|
limit = self.get_param('limit', required=False, default=None)
|
|
if limit is not None:
|
|
if limit.isdigit():
|
|
limit = int(limit)
|
|
if limit > constants.PAGE_LIMIT:
|
|
return constants.PAGE_LIMIT
|
|
else:
|
|
return limit
|
|
else:
|
|
err_msg = 'Limit parameter must be a positive integer'
|
|
raise exceptions.HTTPUnprocessableEntityError('Invalid limit', err_msg)
|
|
else:
|
|
return constants.PAGE_LIMIT
|
|
|
|
def __repr__(self):
|
|
return '%s, context=%s' % (self.path, self.context)
|