5764aec7ae
This patch includes the initial data types, serialization, string utilities, base exception classes and defines a base action that includes a context argument. The mistral_lib.api namespace was also removed in favor of following the python convention of using an underscore to denote private methods and considering all other methods public. This patch removes code previously added as a placeholder to match the spec. As of the Atlanta PTG, the purpose of this library is now to store common code used within Mistral ecosystem and 3rd party integration interfaces including the Custom Actions API and Custom YAQL Functions API. Change-Id: I77da3cd6eba6c5a9953656d432bc959bd3747ada Partially-Implements: blueprint mistral-custom-actions-api Partially-Implements: blueprint mistral-actions-api-main-entities
83 lines
2.8 KiB
Python
83 lines
2.8 KiB
Python
# Copyright 2013 - Mirantis, Inc.
|
|
# Copyright 2015 - StackStorm, Inc.
|
|
# Copyright 2016 - Brocade Communications Systems, Inc.
|
|
# Copyright 2016 - Red Hat, 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.
|
|
|
|
|
|
class MistralExceptionBase(Exception):
|
|
"""Base class for Mistral specific errors and exceptions.
|
|
|
|
A common parent class to derive MistralError and MistralException
|
|
classes from.
|
|
"""
|
|
|
|
message = "An unknown error occurred"
|
|
http_code = 500
|
|
|
|
def __init__(self, message=None):
|
|
if message is not None:
|
|
self.message = message
|
|
|
|
super(MistralError, self).__init__(
|
|
'%d: %s' % (self.http_code, self.message))
|
|
|
|
@property
|
|
def code(self):
|
|
"""This is here for webob to read.
|
|
|
|
https://github.com/Pylons/webob/blob/master/webob/exc.py
|
|
"""
|
|
|
|
return self.http_code
|
|
|
|
def __str__(self):
|
|
return self.message
|
|
|
|
|
|
class MistralError(MistralExceptionBase):
|
|
"""Mistral specific error.
|
|
|
|
Reserved for situations that can't be automatically handled. When it occurs
|
|
it signals that there is a major environmental problem like invalid startup
|
|
configuration or implementation problem (e.g. some code doesn't take care
|
|
of certain corner cases). From architectural perspective it's pointless to
|
|
try to handle this type of problems except doing some finalization work
|
|
like transaction rollback, deleting temporary files etc.
|
|
"""
|
|
|
|
message = "An unknown error occurred"
|
|
|
|
|
|
class MistralException(Exception):
|
|
"""Mistral specific exception.
|
|
|
|
Reserved for situations that are not critical for program continuation.
|
|
It is possible to recover from this type of problems automatically and
|
|
continue program execution. Such problems may be related with invalid user
|
|
input (such as invalid syntax) or temporary environmental problems.
|
|
In case if an instance of a certain exception type bubbles up to API layer
|
|
then this type of exception it must be associated with an http code so it's
|
|
clear how to represent it for a client.
|
|
To correctly use this class, inherit from it and define a 'message' and
|
|
'http_code' properties.
|
|
"""
|
|
|
|
message = "An unknown exception occurred"
|
|
|
|
|
|
class ApplicationContextNotFoundException(MistralException):
|
|
http_code = 400
|
|
message = "Application context not found"
|