OpenStack Study: error_util.py

OpenStack Index

**** CubicPower OpenStack Study ****

# 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.

"""

Exception classes and SOAP response error checking module.

"""

from nova import exception

from nova.openstack.common.gettextutils import _

from nova.openstack.common import log as logging

LOG = logging.getLogger(__name__)

ALREADY_EXISTS = 'AlreadyExists'

CANNOT_DELETE_FILE = 'CannotDeleteFile'

FILE_ALREADY_EXISTS = 'FileAlreadyExists'

FILE_FAULT = 'FileFault'

FILE_LOCKED = 'FileLocked'

FILE_NOT_FOUND = 'FileNotFound'

INVALID_PROPERTY = 'InvalidProperty'

NOT_AUTHENTICATED = 'NotAuthenticated'

**** CubicPower OpenStack Study ****

class VimException(Exception):

"""The VIM Exception class."""

**** CubicPower OpenStack Study ****

def __init__(self, exception_summary, excep):

Exception.__init__(self)

if isinstance(exception_summary, list):

# we need this to protect against developers using

# this method like VimFaultException

raise ValueError("exception_summary must not be a list")

self.exception_summary = str(exception_summary)

self.exception_obj = excep

**** CubicPower OpenStack Study ****

def __str__(self):

return self.exception_summary + ": " + str(self.exception_obj)

**** CubicPower OpenStack Study ****

class SessionOverLoadException(VimException):

"""Session Overload Exception."""

pass

**** CubicPower OpenStack Study ****

class SessionConnectionException(VimException):

"""Session Connection Exception."""

pass

**** CubicPower OpenStack Study ****

class VimAttributeError(VimException):

"""VI Attribute Error."""

pass

**** CubicPower OpenStack Study ****

class VimFaultException(Exception):

"""The VIM Fault exception class."""

**** CubicPower OpenStack Study ****

def __init__(self, fault_list, excep):

Exception.__init__(self)

if not isinstance(fault_list, list):

raise ValueError("fault_list must be a list")

self.fault_list = fault_list

self.exception_obj = excep

**** CubicPower OpenStack Study ****

def __str__(self):

return str(self.exception_obj)

**** CubicPower OpenStack Study ****

class FaultCheckers(object):

"""Methods for fault checking of SOAP response. Per Method error handlers

for which we desire error checking are

**** CubicPower OpenStack Study ****

def retrievepropertiesex_fault_checker(resp_obj):

"""Checks the RetrievePropertiesEx response for errors. Certain faults

are sent as part of the SOAP body as property of missingSet.

For example NotAuthenticated fault.

"""

fault_list = []

if not resp_obj:

# This is the case when the session has timed out. ESX SOAP server

# sends an empty RetrievePropertiesResponse. Normally missingSet in

# the returnval field has the specifics about the error, but that's

# not the case with a timed out idle session. It is as bad as a

# terminated session for we cannot use the session. So setting

# fault to NotAuthenticated fault.

fault_list = [NOT_AUTHENTICATED]

else:

for obj_cont in resp_obj.objects:

if hasattr(obj_cont, "missingSet"):

for missing_elem in obj_cont.missingSet:

fault_type = missing_elem.fault.fault.__class__

# Fault needs to be added to the type of fault for

# uniformity in error checking as SOAP faults define

fault_list.append(fault_type.__name__)

if fault_list:

exc_msg_list = ', '.join(fault_list)

raise VimFaultException(fault_list, Exception(_("Error(s) %s "

"occurred in the call to RetrievePropertiesEx") %

exc_msg_list))

**** CubicPower OpenStack Study ****

class VMwareDriverException(exception.NovaException):

"""Base class for all exceptions raised by the VMware Driver.

All exceptions raised by the VMwareAPI drivers should raise

an exception descended from this class as a root. This will

allow the driver to potentially trap problems related to its

own internal configuration before halting the nova-compute

node.

"""

msg_fmt = _("VMware Driver fault.")

**** CubicPower OpenStack Study ****

class VMwareDriverConfigurationException(VMwareDriverException):

"""Base class for all configuration exceptions.

"""

msg_fmt = _("VMware Driver configuration fault.")

**** CubicPower OpenStack Study ****

class UseLinkedCloneConfigurationFault(VMwareDriverConfigurationException):

msg_fmt = _("No

**** CubicPower OpenStack Study ****

class MissingParameter(VMwareDriverException):

msg_fmt = _("Missing parameter : %(param)s")

**** CubicPower OpenStack Study ****

class AlreadyExistsException(VMwareDriverException):

msg_fmt = _("Resource already exists.")

code = 409

**** CubicPower OpenStack Study ****

class CannotDeleteFileException(VMwareDriverException):

msg_fmt = _("Cannot delete file.")

code = 403

**** CubicPower OpenStack Study ****

class FileAlreadyExistsException(VMwareDriverException):

msg_fmt = _("File already exists.")

code = 409

**** CubicPower OpenStack Study ****

class FileFaultException(VMwareDriverException):

msg_fmt = _("File fault.")

code = 409

**** CubicPower OpenStack Study ****

class FileLockedException(VMwareDriverException):

msg_fmt = _("File locked.")

code = 403

**** CubicPower OpenStack Study ****

class FileNotFoundException(VMwareDriverException):

msg_fmt = _("File not found.")

code = 404

**** CubicPower OpenStack Study ****

class InvalidPropertyException(VMwareDriverException):

msg_fmt = _("Invalid property.")

code = 400

**** CubicPower OpenStack Study ****

class NotAuthenticatedException(VMwareDriverException):

msg_fmt = _("Not Authenticated.")

code = 403

# Populate the fault registry with the exceptions that have

# special treatment.

_fault_classes_registry = {

ALREADY_EXISTS: AlreadyExistsException,

CANNOT_DELETE_FILE: CannotDeleteFileException,

FILE_ALREADY_EXISTS: FileAlreadyExistsException,

FILE_FAULT: FileFaultException,

FILE_LOCKED: FileLockedException,

FILE_NOT_FOUND: FileNotFoundException,

INVALID_PROPERTY: InvalidPropertyException,

NOT_AUTHENTICATED: NotAuthenticatedException,

}

**** CubicPower OpenStack Study ****

def get_fault_class(name):

"""Get a named subclass of VMwareDriverException."""

name = str(name)

fault_class = _fault_classes_registry.get(name)

if not fault_class:

LOG.warning(_('Fault %s not matched.'), name)

fault_class = VMwareDriverException

return fault_class