442 lines
14 KiB
Python
442 lines
14 KiB
Python
# Copyright (c) 2013 Mirantis Inc.
|
|
#
|
|
# 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 re
|
|
import traceback
|
|
|
|
import flask
|
|
import microversion_parse
|
|
from oslo_log import log as logging
|
|
from oslo_middleware import request_id as oslo_req_id
|
|
import six
|
|
from werkzeug import datastructures
|
|
|
|
from sahara.api import microversion as mv
|
|
from sahara import context
|
|
from sahara import exceptions as ex
|
|
from sahara.i18n import _
|
|
from sahara.utils import types
|
|
from sahara.utils import wsgi
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class Rest(flask.Blueprint):
|
|
def get(self, rule, status_code=200):
|
|
return self._mroute('GET', rule, status_code)
|
|
|
|
def post(self, rule, status_code=202):
|
|
return self._mroute('POST', rule, status_code)
|
|
|
|
def post_file(self, rule, status_code=202):
|
|
return self._mroute('POST', rule, status_code, file_upload=True)
|
|
|
|
def put(self, rule, status_code=202):
|
|
return self._mroute('PUT', rule, status_code)
|
|
|
|
def put_file(self, rule, status_code=202):
|
|
return self._mroute('PUT', rule, status_code, file_upload=True)
|
|
|
|
def delete(self, rule, status_code=204):
|
|
return self._mroute('DELETE', rule, status_code)
|
|
|
|
def patch(self, rule, status_code=202):
|
|
return self._mroute('PATCH', rule, status_code)
|
|
|
|
def _mroute(self, methods, rule, status_code=None, **kw):
|
|
if isinstance(methods, six.string_types):
|
|
methods = [methods]
|
|
return self.route(rule, methods=methods, status_code=status_code, **kw)
|
|
|
|
def route(self, rule, **options):
|
|
status = options.pop('status_code', None)
|
|
file_upload = options.pop('file_upload', False)
|
|
|
|
def decorator(func):
|
|
endpoint = options.pop('endpoint', func.__name__)
|
|
|
|
def handler(**kwargs):
|
|
context.set_ctx(None)
|
|
|
|
LOG.debug("Rest.route.decorator.handler, kwargs={kwargs}"
|
|
.format(kwargs=kwargs))
|
|
|
|
_init_resp_type(file_upload)
|
|
|
|
# update status code
|
|
if status:
|
|
flask.request.status_code = status
|
|
|
|
kwargs.pop("tenant_id", None)
|
|
req_id = flask.request.environ.get(oslo_req_id.ENV_REQUEST_ID)
|
|
auth_plugin = flask.request.environ.get('keystone.token_auth')
|
|
ctx = context.Context(
|
|
flask.request.headers['X-User-Id'],
|
|
flask.request.headers['X-Tenant-Id'],
|
|
flask.request.headers['X-Auth-Token'],
|
|
flask.request.headers['X-Service-Catalog'],
|
|
flask.request.headers['X-User-Name'],
|
|
flask.request.headers['X-Tenant-Name'],
|
|
flask.request.headers['X-Roles'].split(','),
|
|
auth_plugin=auth_plugin,
|
|
request_id=req_id)
|
|
context.set_ctx(ctx)
|
|
|
|
try:
|
|
if flask.request.method in ['POST', 'PUT', 'PATCH']:
|
|
kwargs['data'] = request_data()
|
|
return func(**kwargs)
|
|
except ex.Forbidden as e:
|
|
return access_denied(e)
|
|
except ex.SaharaException as e:
|
|
return bad_request(e)
|
|
except Exception as e:
|
|
return internal_error(500, 'Internal Server Error', e)
|
|
|
|
f_rule = "/<tenant_id>" + rule
|
|
self.add_url_rule(rule, endpoint, handler, **options)
|
|
self.add_url_rule(rule + '.json', endpoint, handler, **options)
|
|
self.add_url_rule(f_rule, endpoint, handler, **options)
|
|
self.add_url_rule(f_rule + '.json', endpoint, handler, **options)
|
|
|
|
return func
|
|
|
|
return decorator
|
|
|
|
|
|
def check_microversion_header():
|
|
requested_version = get_requested_microversion()
|
|
if not re.match(mv.VERSION_STRING_REGEX, requested_version):
|
|
bad_request_microversion(requested_version)
|
|
if requested_version not in mv.API_VERSIONS:
|
|
not_acceptable_microversion(requested_version)
|
|
|
|
|
|
def add_vary_header(response):
|
|
response.headers[mv.VARY_HEADER] = mv.OPENSTACK_API_VERSION_HEADER
|
|
response.headers[mv.OPENSTACK_API_VERSION_HEADER] = "{} {}".format(
|
|
mv.SAHARA_SERVICE_TYPE, get_requested_microversion())
|
|
return response
|
|
|
|
|
|
class RestV2(Rest):
|
|
def __init__(self, *args, **kwargs):
|
|
super(RestV2, self).__init__(*args, **kwargs)
|
|
self.before_request(check_microversion_header)
|
|
self.after_request(add_vary_header)
|
|
|
|
def route(self, rule, **options):
|
|
status = options.pop('status_code', None)
|
|
file_upload = options.pop('file_upload', False)
|
|
|
|
def decorator(func):
|
|
endpoint = options.pop('endpoint', func.__name__)
|
|
|
|
def handler(**kwargs):
|
|
context.set_ctx(None)
|
|
|
|
LOG.debug("Rest.route.decorator.handler, kwargs={kwargs}"
|
|
.format(kwargs=kwargs))
|
|
|
|
_init_resp_type(file_upload)
|
|
|
|
# update status code
|
|
if status:
|
|
flask.request.status_code = status
|
|
|
|
kwargs.pop("tenant_id", None)
|
|
req_id = flask.request.environ.get(oslo_req_id.ENV_REQUEST_ID)
|
|
auth_plugin = flask.request.environ.get('keystone.token_auth')
|
|
ctx = context.Context(
|
|
flask.request.headers['X-User-Id'],
|
|
flask.request.headers['X-Tenant-Id'],
|
|
flask.request.headers['X-Auth-Token'],
|
|
flask.request.headers['X-Service-Catalog'],
|
|
flask.request.headers['X-User-Name'],
|
|
flask.request.headers['X-Tenant-Name'],
|
|
flask.request.headers['X-Roles'].split(','),
|
|
auth_plugin=auth_plugin,
|
|
request_id=req_id)
|
|
context.set_ctx(ctx)
|
|
|
|
try:
|
|
if flask.request.method in ['POST', 'PUT', 'PATCH']:
|
|
kwargs['data'] = request_data()
|
|
return func(**kwargs)
|
|
except ex.Forbidden as e:
|
|
return access_denied(e)
|
|
except ex.SaharaException as e:
|
|
return bad_request(e)
|
|
except Exception as e:
|
|
return internal_error(500, 'Internal Server Error', e)
|
|
|
|
f_rule = "/<tenant_id>" + rule
|
|
self.add_url_rule(rule, endpoint, handler, **options)
|
|
self.add_url_rule(rule + '.json', endpoint, handler, **options)
|
|
self.add_url_rule(f_rule, endpoint, handler, **options)
|
|
self.add_url_rule(f_rule + '.json', endpoint, handler, **options)
|
|
|
|
return func
|
|
|
|
return decorator
|
|
|
|
|
|
RT_JSON = datastructures.MIMEAccept([("application/json", 1)])
|
|
|
|
|
|
def _init_resp_type(file_upload):
|
|
"""Extracts response content type."""
|
|
|
|
# get content type from Accept header
|
|
resp_type = flask.request.accept_mimetypes
|
|
|
|
# url /foo.json
|
|
if flask.request.path.endswith('.json'):
|
|
resp_type = RT_JSON
|
|
|
|
flask.request.resp_type = resp_type
|
|
|
|
# set file upload flag
|
|
flask.request.file_upload = file_upload
|
|
|
|
|
|
def render(res=None, resp_type=None, status=None, name=None, **kwargs):
|
|
if not res and type(res) is not types.Page:
|
|
res = {}
|
|
if type(res) is dict:
|
|
res.update(kwargs)
|
|
|
|
elif type(res) is types.Page:
|
|
|
|
result = {name: [item.to_dict() for item in res]}
|
|
result.update(kwargs)
|
|
if res.prev or res.next or ('marker' in get_request_args()):
|
|
result["markers"] = {"prev": res.prev, "next": res.next}
|
|
res = result
|
|
elif kwargs:
|
|
# can't merge kwargs into the non-dict res
|
|
abort_and_log(500,
|
|
_("Non-dict and non-empty kwargs passed to render"))
|
|
|
|
status_code = getattr(flask.request, 'status_code', None)
|
|
if status:
|
|
status_code = status
|
|
if not status_code:
|
|
status_code = 200
|
|
|
|
if not resp_type:
|
|
resp_type = getattr(flask.request, 'resp_type', RT_JSON)
|
|
|
|
if not resp_type:
|
|
resp_type = RT_JSON
|
|
|
|
serializer = None
|
|
if "application/json" in resp_type:
|
|
resp_type = RT_JSON
|
|
serializer = wsgi.JSONDictSerializer()
|
|
else:
|
|
raise ex.InvalidDataException(
|
|
_("Content type '%s' isn't supported") % resp_type)
|
|
|
|
body = serializer.serialize(res)
|
|
resp_type = str(resp_type)
|
|
|
|
return flask.Response(response=body, status=status_code,
|
|
mimetype=resp_type)
|
|
|
|
|
|
def request_data():
|
|
if hasattr(flask.request, 'parsed_data'):
|
|
return flask.request.parsed_data
|
|
|
|
if (flask.request.content_length is None
|
|
or not flask.request.content_length > 0):
|
|
LOG.debug("Empty body provided in request")
|
|
return dict()
|
|
|
|
if flask.request.file_upload:
|
|
return flask.request.data
|
|
|
|
deserializer = None
|
|
content_type = flask.request.mimetype
|
|
if not content_type or content_type in RT_JSON:
|
|
deserializer = wsgi.JSONDeserializer()
|
|
else:
|
|
raise ex.InvalidDataException(
|
|
_("Content type '%s' isn't supported") % content_type)
|
|
|
|
# parsed request data to avoid unwanted re-parsings
|
|
parsed_data = deserializer.deserialize(flask.request.data)['body']
|
|
flask.request.parsed_data = parsed_data
|
|
|
|
return flask.request.parsed_data
|
|
|
|
|
|
def get_request_args():
|
|
return flask.request.args
|
|
|
|
|
|
def get_requested_microversion():
|
|
requested_version = microversion_parse.get_version(
|
|
flask.request.headers,
|
|
mv.SAHARA_SERVICE_TYPE
|
|
)
|
|
if requested_version is None:
|
|
requested_version = mv.MIN_API_VERSION
|
|
elif requested_version == mv.LATEST:
|
|
requested_version = mv.MAX_API_VERSION
|
|
return requested_version
|
|
|
|
|
|
def abort_and_log(status_code, descr, exc=None):
|
|
LOG.error("Request aborted with status code {code} and "
|
|
"message '{message}'".format(code=status_code, message=descr))
|
|
|
|
if exc is not None:
|
|
LOG.error(traceback.format_exc())
|
|
|
|
flask.abort(status_code, description=descr)
|
|
|
|
|
|
def render_error_message(error_code, error_message, error_name, **msg_kwargs):
|
|
message = {
|
|
"error_code": error_code,
|
|
"error_message": error_message,
|
|
"error_name": error_name
|
|
}
|
|
|
|
message.update(**msg_kwargs)
|
|
|
|
resp = render(message)
|
|
resp.status_code = error_code
|
|
|
|
return resp
|
|
|
|
|
|
def not_acceptable_microversion(requested_version):
|
|
message = ("Version {} is not supported by the API. "
|
|
"Minimum is {} and maximum is {}.".format(
|
|
requested_version,
|
|
mv.MIN_API_VERSION,
|
|
mv.MAX_API_VERSION
|
|
))
|
|
resp = render_error_message(
|
|
mv.NOT_ACCEPTABLE_STATUS_CODE,
|
|
message,
|
|
mv.NOT_ACCEPTABLE_STATUS_NAME,
|
|
max_version=mv.MAX_API_VERSION,
|
|
min_version=mv.MIN_API_VERSION
|
|
)
|
|
flask.abort(resp)
|
|
|
|
|
|
def bad_request_microversion(requested_version):
|
|
message = ("API Version String {} is of invalid format. Must be of format"
|
|
" MajorNum.MinorNum.").format(requested_version)
|
|
resp = render_error_message(
|
|
mv.BAD_REQUEST_STATUS_CODE,
|
|
message,
|
|
mv.BAD_REQUEST_STATUS_NAME,
|
|
max_version=mv.MAX_API_VERSION,
|
|
min_version=mv.MIN_API_VERSION
|
|
)
|
|
flask.abort(resp)
|
|
|
|
|
|
def invalid_param_error(status_code, descr, exc=None):
|
|
LOG.error("Request aborted with status code {code} and "
|
|
"message '{message}'".format(code=status_code, message=descr))
|
|
|
|
if exc is not None:
|
|
LOG.error(traceback.format_exc())
|
|
|
|
error_code = "INVALID_PARAMS_ON_REQUEST"
|
|
|
|
return render_error_message(status_code, descr, error_code)
|
|
|
|
|
|
def internal_error(status_code, descr, exc=None):
|
|
LOG.error("Request aborted with status code {code} and "
|
|
"message '{message}'".format(code=status_code, message=descr))
|
|
|
|
if exc is not None:
|
|
LOG.error(traceback.format_exc())
|
|
|
|
error_code = "INTERNAL_SERVER_ERROR"
|
|
if status_code == 501:
|
|
error_code = "NOT_IMPLEMENTED_ERROR"
|
|
|
|
return render_error_message(status_code, descr, error_code)
|
|
|
|
|
|
def bad_request(error):
|
|
error_code = 400
|
|
|
|
LOG.error("Validation Error occurred: "
|
|
"error_code={code}, error_message={message}, "
|
|
"error_name={name}".format(code=error_code,
|
|
message=error.message,
|
|
name=error.code))
|
|
|
|
return render_error_message(error_code, error.message, error.code)
|
|
|
|
|
|
def access_denied(error):
|
|
error_code = 403
|
|
|
|
LOG.error("Access Denied: error_code={code}, error_message={message}, "
|
|
"error_name={name}".format(code=error_code,
|
|
message=error.message,
|
|
name=error.code))
|
|
|
|
return render_error_message(error_code, error.message, error.code)
|
|
|
|
|
|
def not_found(error):
|
|
error_code = 404
|
|
|
|
LOG.error("Not Found exception occurred: "
|
|
"error_code={code}, error_message={message}, "
|
|
"error_name={name}".format(code=error_code,
|
|
message=error.message,
|
|
name=error.code))
|
|
|
|
return render_error_message(error_code, error.message, error.code)
|
|
|
|
|
|
def to_wrapped_dict(func, id, *args, **kwargs):
|
|
return render(to_wrapped_dict_no_render(func, id, *args, **kwargs))
|
|
|
|
|
|
def to_wrapped_dict_no_render(func, id, *args, **kwargs):
|
|
obj = func(id, *args, **kwargs)
|
|
if obj is None:
|
|
e = ex.NotFoundException(
|
|
{'id': id}, _('Object with %s not found'))
|
|
|
|
return not_found(e)
|
|
return obj.to_wrapped_dict()
|
|
|
|
|
|
def _replace_hadoop_version_plugin_version(obj):
|
|
dict.update(obj, {'plugin_version': obj['hadoop_version']})
|
|
dict.pop(obj, 'hadoop_version')
|
|
|
|
|
|
def _replace_tenant_id_project_id(obj):
|
|
dict.update(obj, {'project_id': obj['tenant_id']})
|
|
dict.pop(obj, 'tenant_id')
|