593 lines
17 KiB
Python
593 lines
17 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 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.
|
|
|
|
from datetime import datetime
|
|
import six
|
|
import traceback
|
|
|
|
from decorator import decorator
|
|
from oslo.serialization import jsonutils
|
|
from sqlalchemy import exc as sa_exc
|
|
import web
|
|
|
|
from nailgun.api.v1.validators.base import BaseDefferedTaskValidator
|
|
from nailgun.api.v1.validators.base import BasicValidator
|
|
from nailgun.api.v1.validators.graph import GraphTasksValidator
|
|
from nailgun.db import db
|
|
from nailgun.errors import errors
|
|
from nailgun.logger import logger
|
|
from nailgun import objects
|
|
from nailgun.objects.serializers.base import BasicSerializer
|
|
from nailgun.orchestrator import deployment_graph
|
|
from nailgun.settings import settings
|
|
from nailgun import utils
|
|
|
|
|
|
def forbid_client_caching(handler):
|
|
if web.ctx.path.startswith("/api"):
|
|
web.header('Cache-Control',
|
|
'store, no-cache, must-revalidate,'
|
|
' post-check=0, pre-check=0')
|
|
web.header('Pragma', 'no-cache')
|
|
dt = datetime.fromtimestamp(0).strftime(
|
|
'%a, %d %b %Y %H:%M:%S GMT'
|
|
)
|
|
web.header('Expires', dt)
|
|
return handler()
|
|
|
|
|
|
def load_db_driver(handler):
|
|
"""Wrap all handlers calls in a special construction, that's call
|
|
rollback if something wrong or commit changes otherwise. Please note,
|
|
only HTTPError should be rised up from this function. All another
|
|
possible errors should be handle.
|
|
"""
|
|
try:
|
|
# execute handler and commit changes if all is ok
|
|
response = handler()
|
|
db.commit()
|
|
return response
|
|
|
|
except web.HTTPError:
|
|
# a special case: commit changes if http error ends with
|
|
# 200, 201, 202, etc
|
|
if web.ctx.status.startswith('2'):
|
|
db.commit()
|
|
else:
|
|
db.rollback()
|
|
raise
|
|
|
|
except (sa_exc.IntegrityError, sa_exc.DataError) as exc:
|
|
# respond a "400 Bad Request" if database constraints were broken
|
|
db.rollback()
|
|
raise BaseHandler.http(400, exc.message)
|
|
|
|
except Exception:
|
|
db.rollback()
|
|
raise
|
|
|
|
finally:
|
|
db.remove()
|
|
|
|
|
|
class BaseHandler(object):
|
|
validator = BasicValidator
|
|
serializer = BasicSerializer
|
|
|
|
fields = []
|
|
|
|
@classmethod
|
|
def render(cls, instance, fields=None):
|
|
return cls.serializer.serialize(
|
|
instance,
|
|
fields=fields or cls.fields
|
|
)
|
|
|
|
@classmethod
|
|
def http(cls, status_code, message='', headers=None):
|
|
"""Raise an HTTP status code, as specified. Useful for returning status
|
|
codes like 401 Unauthorized or 403 Forbidden.
|
|
|
|
:param status_code: the HTTP status code as an integer
|
|
:param message: the message to send along, as a string
|
|
:param headers: the headers to send along, as a dictionary
|
|
"""
|
|
class _nocontent(web.HTTPError):
|
|
message = 'No Content'
|
|
|
|
def __init__(self, message=''):
|
|
super(_nocontent, self).__init__(
|
|
status='204 No Content',
|
|
data=message or self.message
|
|
)
|
|
|
|
exc_status_map = {
|
|
200: web.ok,
|
|
201: web.created,
|
|
202: web.accepted,
|
|
204: _nocontent,
|
|
|
|
301: web.redirect,
|
|
302: web.found,
|
|
|
|
400: web.badrequest,
|
|
401: web.unauthorized,
|
|
403: web.forbidden,
|
|
404: web.notfound,
|
|
405: web.nomethod,
|
|
406: web.notacceptable,
|
|
409: web.conflict,
|
|
410: web.gone,
|
|
415: web.unsupportedmediatype,
|
|
|
|
500: web.internalerror,
|
|
}
|
|
|
|
# web.py has a poor exception design: some of them receive
|
|
# the `message` argument and some of them not. the only
|
|
# solution to set custom message is to assign message directly
|
|
# to the `data` attribute. though, that won't work for
|
|
# the `internalerror` because it tries to do magic with
|
|
# application context without explicit `message` argument.
|
|
try:
|
|
exc = exc_status_map[status_code](message=message)
|
|
except TypeError:
|
|
exc = exc_status_map[status_code]()
|
|
exc.data = message
|
|
|
|
headers = headers or {}
|
|
for key, value in headers.items():
|
|
web.header(key, value)
|
|
|
|
return exc
|
|
|
|
@classmethod
|
|
def checked_data(cls, validate_method=None, **kwargs):
|
|
try:
|
|
data = kwargs.pop('data', web.data())
|
|
method = validate_method or cls.validator.validate
|
|
|
|
valid_data = method(data, **kwargs)
|
|
except (
|
|
errors.InvalidInterfacesInfo,
|
|
errors.InvalidMetadata
|
|
) as exc:
|
|
objects.Notification.create({
|
|
"topic": "error",
|
|
"message": exc.message
|
|
})
|
|
raise cls.http(400, exc.message)
|
|
except (
|
|
errors.NotAllowed,
|
|
) as exc:
|
|
raise cls.http(403, exc.message)
|
|
except (
|
|
errors.AlreadyExists
|
|
) as exc:
|
|
raise cls.http(409, exc.message)
|
|
except (
|
|
errors.InvalidData,
|
|
errors.NodeOffline,
|
|
errors.UnavailableRelease,
|
|
) as exc:
|
|
raise cls.http(400, exc.message)
|
|
except (
|
|
errors.ObjectNotFound,
|
|
) as exc:
|
|
raise cls.http(404, exc.message)
|
|
except Exception as exc:
|
|
raise cls.http(500, traceback.format_exc())
|
|
return valid_data
|
|
|
|
def get_object_or_404(self, obj, *args, **kwargs):
|
|
"""Get object instance by ID
|
|
|
|
:http: 404 when not found
|
|
:returns: object instance
|
|
"""
|
|
log_404 = kwargs.pop("log_404", None)
|
|
log_get = kwargs.pop("log_get", None)
|
|
uid = kwargs.get("id", (args[0] if args else None))
|
|
if uid is None:
|
|
if log_404:
|
|
getattr(logger, log_404[0])(log_404[1])
|
|
raise self.http(404, u'Invalid ID specified')
|
|
else:
|
|
instance = obj.get_by_uid(uid)
|
|
if not instance:
|
|
raise self.http(404, u'{0} not found'.format(obj.__name__))
|
|
if log_get:
|
|
getattr(logger, log_get[0])(log_get[1])
|
|
return instance
|
|
|
|
def get_objects_list_or_404(self, obj, ids):
|
|
"""Get list of objects
|
|
|
|
:param model: model object
|
|
:param ids: list of ids
|
|
|
|
:http: 404 when not found
|
|
:returns: list of object instances
|
|
"""
|
|
|
|
node_query = obj.filter_by_id_list(None, ids)
|
|
objects_count = obj.count(node_query)
|
|
if len(set(ids)) != objects_count:
|
|
raise self.http(404, '{0} not found'.format(obj.__name__))
|
|
|
|
return list(node_query)
|
|
|
|
|
|
def content_json(func, cls, *args, **kwargs):
|
|
web.header('Content-Type', 'application/json', unique=True)
|
|
json_resp = lambda data: (
|
|
jsonutils.dumps(data)
|
|
if isinstance(data, (dict, list)) else data
|
|
)
|
|
|
|
request_validate_needed = True
|
|
response_validate_needed = True
|
|
|
|
resource_type = "single"
|
|
if issubclass(
|
|
cls.__class__,
|
|
CollectionHandler
|
|
) and not func.func_name == "POST":
|
|
resource_type = "collection"
|
|
|
|
if (
|
|
func.func_name in ("GET", "DELETE") or
|
|
getattr(cls.__class__, 'validator', None) is None or
|
|
resource_type == "single" and not cls.validator.single_schema or
|
|
resource_type == "collection" and not cls.validator.collection_schema
|
|
):
|
|
request_validate_needed = False
|
|
|
|
if request_validate_needed:
|
|
BaseHandler.checked_data(
|
|
cls.validator.validate_request,
|
|
resource_type=resource_type
|
|
)
|
|
|
|
try:
|
|
resp = func(cls, *args, **kwargs)
|
|
except web.notmodified:
|
|
raise
|
|
except web.HTTPError as http_error:
|
|
http_error.data = json_resp(http_error.data)
|
|
raise
|
|
# intercepting all errors to avoid huge HTML output
|
|
except Exception as exc:
|
|
http_error = BaseHandler.http(
|
|
500,
|
|
(
|
|
traceback.format_exc(exc)
|
|
if settings.DEVELOPMENT
|
|
else six.text_type(exc)
|
|
)
|
|
)
|
|
http_error.data = json_resp(http_error.data)
|
|
raise http_error
|
|
|
|
if all([
|
|
settings.DEVELOPMENT,
|
|
response_validate_needed,
|
|
getattr(cls.__class__, 'validator', None) is not None
|
|
]):
|
|
BaseHandler.checked_data(
|
|
cls.validator.validate_response,
|
|
resource_type=resource_type
|
|
)
|
|
|
|
return json_resp(resp)
|
|
|
|
|
|
def content(*args, **kwargs):
|
|
"""This decorator checks Accept header received from client
|
|
and returns corresponding wrapper (only JSON is currently
|
|
supported). It can be used as is:
|
|
|
|
@content
|
|
def GET(self):
|
|
...
|
|
|
|
Default behavior may be overriden by passing list of
|
|
exact mimetypes to decorator:
|
|
|
|
@content(["text/plain"])
|
|
def GET(self):
|
|
...
|
|
"""
|
|
|
|
exact_mimetypes = None
|
|
if len(args) >= 1 and isinstance(args[0], list):
|
|
exact_mimetypes = args[0]
|
|
|
|
@decorator
|
|
def wrapper(func, *args, **kwargs):
|
|
accept = web.ctx.env.get("HTTP_ACCEPT", "application/json")
|
|
accepted_types = [
|
|
"application/json",
|
|
"*/*"
|
|
]
|
|
if exact_mimetypes and isinstance(exact_mimetypes, list):
|
|
accepted_types = exact_mimetypes
|
|
if any(map(lambda m: m in accept, accepted_types)):
|
|
return content_json(func, *args, **kwargs)
|
|
else:
|
|
raise BaseHandler.http(415)
|
|
|
|
# case of @content without arguments, meaning arg[0] to be callable
|
|
# handler
|
|
if len(args) >= 1 and callable(args[0]):
|
|
return wrapper(args[0], *args[1:], **kwargs)
|
|
|
|
# case of @content(["mimetype"]) with explicit arguments
|
|
return wrapper
|
|
|
|
|
|
class SingleHandler(BaseHandler):
|
|
|
|
single = None
|
|
validator = BasicValidator
|
|
|
|
@content
|
|
def GET(self, obj_id):
|
|
""":returns: JSONized REST object.
|
|
:http: * 200 (OK)
|
|
* 404 (object not found in db)
|
|
"""
|
|
obj = self.get_object_or_404(self.single, obj_id)
|
|
return self.single.to_json(obj)
|
|
|
|
@content
|
|
def PUT(self, obj_id):
|
|
""":returns: JSONized REST object.
|
|
:http: * 200 (OK)
|
|
* 404 (object not found in db)
|
|
"""
|
|
obj = self.get_object_or_404(self.single, obj_id)
|
|
|
|
data = self.checked_data(
|
|
self.validator.validate_update,
|
|
instance=obj
|
|
)
|
|
self.single.update(obj, data)
|
|
return self.single.to_json(obj)
|
|
|
|
def DELETE(self, obj_id):
|
|
""":returns: Empty string
|
|
:http: * 204 (object successfully deleted)
|
|
* 404 (object not found in db)
|
|
"""
|
|
obj = self.get_object_or_404(
|
|
self.single,
|
|
obj_id
|
|
)
|
|
|
|
try:
|
|
self.validator.validate_delete(obj)
|
|
except errors.CannotDelete as exc:
|
|
raise self.http(400, exc.message)
|
|
|
|
self.single.delete(obj)
|
|
raise self.http(204)
|
|
|
|
|
|
class CollectionHandler(BaseHandler):
|
|
|
|
collection = None
|
|
validator = BasicValidator
|
|
eager = ()
|
|
|
|
@content
|
|
def GET(self):
|
|
""":returns: Collection of JSONized REST objects.
|
|
:http: * 200 (OK)
|
|
"""
|
|
q = self.collection.eager(None, self.eager)
|
|
return self.collection.to_json(q)
|
|
|
|
@content
|
|
def POST(self):
|
|
""":returns: JSONized REST object.
|
|
:http: * 201 (object successfully created)
|
|
* 400 (invalid object data specified)
|
|
* 409 (object with such parameters already exists)
|
|
"""
|
|
|
|
data = self.checked_data()
|
|
|
|
try:
|
|
new_obj = self.collection.create(data)
|
|
except errors.CannotCreate as exc:
|
|
raise self.http(400, exc.message)
|
|
|
|
raise self.http(201, self.collection.single.to_json(new_obj))
|
|
|
|
|
|
class DBSingletonHandler(BaseHandler):
|
|
"""Manages an object that is supposed to have only one entry in the DB
|
|
(a DB singleton).
|
|
"""
|
|
|
|
single = None
|
|
validator = BasicValidator
|
|
not_found_error = "Object not found in the DB"
|
|
|
|
def get_one_or_404(self):
|
|
try:
|
|
instance = self.single.get_one(fail_if_not_found=True)
|
|
except errors.ObjectNotFound:
|
|
raise self.http(404, self.not_found_error)
|
|
|
|
return instance
|
|
|
|
@content
|
|
def GET(self):
|
|
"""Get singleton object from DB
|
|
:http: * 200 (OK)
|
|
* 404 (Object not found in DB)
|
|
"""
|
|
instance = self.get_one_or_404()
|
|
|
|
return self.single.to_json(instance)
|
|
|
|
@content
|
|
def PUT(self):
|
|
"""Change object in DB
|
|
:http: * 200 (OK)
|
|
* 400 (Invalid data)
|
|
* 404 (Object not present in DB)
|
|
"""
|
|
data = self.checked_data(self.validator.validate_update)
|
|
|
|
instance = self.get_one_or_404()
|
|
|
|
self.single.update(instance, data)
|
|
|
|
return self.single.to_json(instance)
|
|
|
|
@content
|
|
def PATCH(self):
|
|
"""Update object
|
|
:http: * 200 (OK)
|
|
* 400 (Invalid data)
|
|
* 404 (Object not present in DB)
|
|
|
|
"""
|
|
data = self.checked_data(self.validator.validate_update)
|
|
|
|
instance = self.get_one_or_404()
|
|
|
|
instance.update(utils.dict_merge(
|
|
self.single.serializer.serialize(instance), data
|
|
))
|
|
|
|
return self.single.to_json(instance)
|
|
|
|
|
|
# TODO(enchantner): rewrite more handlers to inherit from this
|
|
# and move more common code here
|
|
class DeferredTaskHandler(BaseHandler):
|
|
"""Abstract Deferred Task Handler
|
|
"""
|
|
|
|
validator = BaseDefferedTaskValidator
|
|
single = objects.Task
|
|
log_message = u"Starting deferred task on environment '{env_id}'"
|
|
log_error = u"Error during execution of deferred task " \
|
|
u"on environment '{env_id}': {error}"
|
|
task_manager = None
|
|
|
|
@content
|
|
def PUT(self, cluster_id):
|
|
""":returns: JSONized Task object.
|
|
:http: * 202 (task successfully executed)
|
|
* 400 (invalid object data specified)
|
|
* 404 (environment is not found)
|
|
* 409 (task with such parameters already exists)
|
|
"""
|
|
cluster = self.get_object_or_404(
|
|
objects.Cluster,
|
|
cluster_id,
|
|
log_404=(
|
|
u"warning",
|
|
u"Error: there is no cluster "
|
|
u"with id '{0}' in DB.".format(cluster_id)
|
|
)
|
|
)
|
|
|
|
logger.info(self.log_message.format(env_id=cluster_id))
|
|
|
|
try:
|
|
self.validator.validate(cluster)
|
|
task_manager = self.task_manager(cluster_id=cluster.id)
|
|
task = task_manager.execute()
|
|
except (
|
|
errors.AlreadyExists,
|
|
errors.StopAlreadyRunning
|
|
) as exc:
|
|
raise self.http(409, exc.message)
|
|
except (
|
|
errors.DeploymentNotRunning,
|
|
errors.WrongNodeStatus,
|
|
errors.UnavailableRelease,
|
|
) as exc:
|
|
raise self.http(400, exc.message)
|
|
except Exception as exc:
|
|
logger.error(
|
|
self.log_error.format(
|
|
env_id=cluster_id,
|
|
error=str(exc)
|
|
)
|
|
)
|
|
# let it be 500
|
|
raise
|
|
|
|
raise self.http(202, self.single.to_json(task))
|
|
|
|
|
|
class DeploymentTasksHandler(SingleHandler):
|
|
"""Handler for deployment graph serialization."""
|
|
|
|
validator = GraphTasksValidator
|
|
|
|
@content
|
|
def GET(self, obj_id):
|
|
""":returns: Deployment tasks
|
|
:http: * 200 OK
|
|
* 404 (release object not found)
|
|
"""
|
|
obj = self.get_object_or_404(self.single, obj_id)
|
|
end = web.input(end=None).end
|
|
start = web.input(start=None).start
|
|
tasks = self.single.get_deployment_tasks(obj)
|
|
if end or start:
|
|
graph = deployment_graph.DeploymentGraph(tasks)
|
|
return graph.find_subgraph(end=end, start=start).node.values()
|
|
return tasks
|
|
|
|
@content
|
|
def PUT(self, obj_id):
|
|
""":returns: Deployment tasks
|
|
:http: * 200 (OK)
|
|
* 400 (invalid data specified)
|
|
* 404 (object not found in db)
|
|
"""
|
|
obj = self.get_object_or_404(self.single, obj_id)
|
|
|
|
data = self.checked_data(
|
|
self.validator.validate_update,
|
|
instance=obj
|
|
)
|
|
self.single.update(obj, {'deployment_tasks': data})
|
|
return self.single.get_deployment_tasks(obj)
|
|
|
|
def POST(self, obj_id):
|
|
"""Creation of metadata disallowed
|
|
|
|
:http: * 405 (method not supported)
|
|
"""
|
|
raise self.http(405, 'Create not supported for this entity')
|
|
|
|
def DELETE(self, obj_id):
|
|
"""Deletion of metadata disallowed
|
|
|
|
:http: * 405 (method not supported)
|
|
"""
|
|
raise self.http(405, 'Delete not supported for this entity')
|