191 lines
6.2 KiB
Python
Raw Normal View History

2010-06-23 22:04:16 -07:00
# Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
2010-06-23 22:04:16 -07:00
# All Rights Reserved.
#
# 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
#
2010-06-23 22:04:16 -07:00
# http://www.apache.org/licenses/LICENSE-2.0
#
2010-05-27 23:05:26 -07:00
# Unless required by applicable law or agreed to in writing, software
2010-06-23 22:04:16 -07:00
# 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.
2010-05-27 23:05:26 -07:00
"""VersionedObjects base exception handling.
2011-04-20 12:08:22 -07:00
Includes decorator for re-raising VersionedObjects-type exceptions.
2011-04-20 12:08:22 -07:00
SHOULD include dedicated exception logging.
2010-05-27 23:05:26 -07:00
"""
import inspect
import logging
import sys
2011-04-20 12:08:22 -07:00
from oslo_config import cfg
from oslo_utils import excutils
import six
import webob.exc
from oslo_versionedobjects._i18n import _, _LE
2011-04-20 12:08:22 -07:00
LOG = logging.getLogger(__name__)
2010-05-27 23:05:26 -07:00
exc_log_opts = [
cfg.BoolOpt('fatal_exception_format_errors',
default=False,
help='Make exception message format errors fatal'),
]
CONF = cfg.CONF
CONF.register_opts(exc_log_opts, group='oslo_versionedobjects')
2010-08-16 14:16:21 +02:00
class ConvertedException(webob.exc.WSGIHTTPException):
def __init__(self, code=0, title="", explanation=""):
self.code = code
self.title = title
self.explanation = explanation
super(ConvertedException, self).__init__()
def _cleanse_dict(original):
"""Strip all admin_password, new_pass, rescue_pass keys from a dict."""
return {k: v for k, v in original.items() if "_pass" not in k}
def wrap_exception(notifier=None, get_notifier=None):
"""Catch all exceptions in wrapped method
This decorator wraps a method to catch any exceptions that may
get thrown. It also optionally sends the exception to the notification
system.
2011-06-29 18:30:15 -07:00
"""
def inner(f):
def wrapped(self, context, *args, **kw):
# Don't store self or context in the payload, it now seems to
# contain confidential information.
2011-06-29 18:30:15 -07:00
try:
return f(self, context, *args, **kw)
except Exception as e:
with excutils.save_and_reraise_exception():
if notifier or get_notifier:
payload = dict(exception=e)
call_dict = inspect.getcallargs(f, self, context,
*args, **kw)
cleansed = _cleanse_dict(call_dict)
payload.update({'args': cleansed})
# If f has multiple decorators, they must use
# six.wraps to ensure the name is
# propagated.
event_type = f.__name__
(notifier or get_notifier()).error(context,
event_type,
payload)
2011-06-29 18:30:15 -07:00
return six.wraps(f)(wrapped)
2011-06-29 18:30:15 -07:00
return inner
class VersionedObjectsException(Exception):
"""Base VersionedObjects Exception
2011-04-15 14:33:24 -04:00
To correctly use this class, inherit from it and define
a 'msg_fmt' property. That msg_fmt will get printf'd
2011-04-15 14:33:24 -04:00
with the keyword arguments provided to the constructor.
"""
msg_fmt = _("An unknown exception occurred.")
code = 500
headers = {}
safe = False
def __init__(self, message=None, **kwargs):
self.kwargs = kwargs
if 'code' not in self.kwargs:
try:
self.kwargs['code'] = self.code
except AttributeError:
pass
if not message:
try:
message = self.msg_fmt % kwargs
2011-04-15 14:33:24 -04:00
except Exception:
exc_info = sys.exc_info()
# kwargs doesn't match a variable in the message
# log the issue and the kwargs
LOG.exception(_LE('Exception in string format operation'))
for name, value in kwargs.items():
LOG.error("%s: %s" % (name, value)) # noqa
if CONF.oslo_versionedobjects.fatal_exception_format_errors:
raise six.reraise(*exc_info)
else:
# at least get the core message out if something happened
message = self.msg_fmt
super(VersionedObjectsException, self).__init__(message)
def format_message(self):
# NOTE(mrodden): use the first argument to the python Exception object
# which should be our full VersionedObjectsException message,
# (see __init__)
return self.args[0]
class ObjectActionError(VersionedObjectsException):
msg_fmt = _('Object action %(action)s failed because: %(reason)s')
class ObjectFieldInvalid(VersionedObjectsException):
msg_fmt = _('Field %(field)s of %(objname)s is not an instance of Field')
class OrphanedObjectError(VersionedObjectsException):
msg_fmt = _('Cannot call %(method)s on orphaned %(objtype)s object')
class IncompatibleObjectVersion(VersionedObjectsException):
msg_fmt = _('Version %(objver)s of %(objname)s is not supported')
class ReadOnlyFieldError(VersionedObjectsException):
msg_fmt = _('Cannot modify readonly field %(field)s')
class UnsupportedObjectError(VersionedObjectsException):
msg_fmt = _('Unsupported object type %(objtype)s')
class EnumRequiresValidValuesError(VersionedObjectsException):
msg_fmt = _('Enum fields require a list of valid_values')
class EnumValidValuesInvalidError(VersionedObjectsException):
msg_fmt = _('Enum valid values are not valid')
class EnumFieldInvalid(VersionedObjectsException):
msg_fmt = _('%(typename)s in %(fieldname)s is not an instance of Enum')
class EnumFieldUnset(VersionedObjectsException):
msg_fmt = _('%(fieldname)s missing field type')
class InvalidTargetVersion(VersionedObjectsException):
msg_fmt = _('Invalid target version %(version)s')
class TargetBeforeSubobjectExistedException(VersionedObjectsException):
msg_fmt = _("No subobject existed at version %(target_version)s")