Source code for ironic.common.exception

# Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
# 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
#
#         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.

"""Ironic base exception handling.

SHOULD include dedicated exception logging.

"""

from oslo_config import cfg
from oslo_log import log as logging
import six
from six.moves import http_client

from ironic.common.i18n import _
from ironic.common.i18n import _LE


LOG = logging.getLogger(__name__)

exc_log_opts = [
    cfg.BoolOpt('fatal_exception_format_errors',
                default=False,
                help=_('Used if there is a formatting error when generating '
                       'an exception message (a programming error). If True, '
                       'raise an exception; if False, use the unformatted '
                       'message.')),
]

CONF = cfg.CONF
CONF.register_opts(exc_log_opts)


def _cleanse_dict(original):
    """Strip all admin_password, new_pass, rescue_pass keys from a dict."""
    return dict((k, v) for k, v in original.items() if "_pass" not in k)


[docs]class IronicException(Exception): """Base Ironic Exception To correctly use this class, inherit from it and define a 'message' property. That message will get printf'd with the keyword arguments provided to the constructor. """ message = _("An unknown exception occurred.") code = http_client.INTERNAL_SERVER_ERROR 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.message % kwargs except Exception as e: # 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)) if CONF.fatal_exception_format_errors: raise e else: # at least get the core message out if something happened message = self.message super(IronicException, self).__init__(message) def __str__(self): """Encode to utf-8 then wsme api can consume it as well.""" if not six.PY3: return unicode(self.args[0]).encode('utf-8') return self.args[0] def __unicode__(self): """Return a unicode representation of the exception message.""" return unicode(self.args[0])
[docs] def format_message(self): if self.__class__.__name__.endswith('_Remote'): return self.args[0] else: return six.text_type(self)
[docs]class NotAuthorized(IronicException): message = _("Not authorized.") code = http_client.FORBIDDEN
[docs]class OperationNotPermitted(NotAuthorized): message = _("Operation not permitted.")
[docs]class Invalid(IronicException): message = _("Unacceptable parameters.") code = http_client.BAD_REQUEST
[docs]class Conflict(IronicException): message = _('Conflict.') code = http_client.CONFLICT
[docs]class TemporaryFailure(IronicException): message = _("Resource temporarily unavailable, please retry.") code = http_client.SERVICE_UNAVAILABLE
[docs]class NotAcceptable(IronicException): # TODO(deva): We need to set response headers in the API for this exception message = _("Request not acceptable.") code = http_client.NOT_ACCEPTABLE
[docs]class InvalidState(Conflict): message = _("Invalid resource state.")
[docs]class NodeAlreadyExists(Conflict): message = _("A node with UUID %(uuid)s already exists.")
[docs]class MACAlreadyExists(Conflict): message = _("A port with MAC address %(mac)s already exists.")
[docs]class ChassisAlreadyExists(Conflict): message = _("A chassis with UUID %(uuid)s already exists.")
[docs]class PortAlreadyExists(Conflict): message = _("A port with UUID %(uuid)s already exists.")
[docs]class InstanceAssociated(Conflict): message = _("Instance %(instance_uuid)s is already associated with a node," " it cannot be associated with this other node %(node)s")
[docs]class DuplicateName(Conflict): message = _("A node with name %(name)s already exists.")
[docs]class InvalidUUID(Invalid): message = _("Expected a uuid but received %(uuid)s.")
[docs]class InvalidUuidOrName(Invalid): message = _("Expected a logical name or uuid but received %(name)s.")
[docs]class InvalidName(Invalid): message = _("Expected a logical name but received %(name)s.")
[docs]class InvalidIdentity(Invalid): message = _("Expected an uuid or int but received %(identity)s.")
[docs]class InvalidMAC(Invalid): message = _("Expected a MAC address but received %(mac)s.")
[docs]class InvalidStateRequested(Invalid): message = _('The requested action "%(action)s" can not be performed ' 'on node "%(node)s" while it is in state "%(state)s".')
[docs]class PatchError(Invalid): message = _("Couldn't apply patch '%(patch)s'. Reason: %(reason)s")
[docs]class InstanceDeployFailure(IronicException): message = _("Failed to deploy instance: %(reason)s")
[docs]class ImageUnacceptable(IronicException): message = _("Image %(image_id)s is unacceptable: %(reason)s")
[docs]class ImageConvertFailed(IronicException): message = _("Image %(image_id)s is unacceptable: %(reason)s") # Cannot be templated as the error syntax varies. # msg needs to be constructed when raised.
[docs]class InvalidParameterValue(Invalid): message = _("%(err)s")
[docs]class MissingParameterValue(InvalidParameterValue): message = _("%(err)s")
[docs]class Duplicate(IronicException): message = _("Resource already exists.")
[docs]class NotFound(IronicException): message = _("Resource could not be found.") code = http_client.NOT_FOUND
[docs]class DHCPLoadError(IronicException): message = _("Failed to load DHCP provider %(dhcp_provider_name)s, " "reason: %(reason)s")
[docs]class DriverNotFound(NotFound): message = _("Could not find the following driver(s): %(driver_name)s.")
[docs]class ImageNotFound(NotFound): message = _("Image %(image_id)s could not be found.")
[docs]class NoValidHost(NotFound): message = _("No valid host was found. Reason: %(reason)s")
[docs]class InstanceNotFound(NotFound): message = _("Instance %(instance)s could not be found.")
[docs]class NodeNotFound(NotFound): message = _("Node %(node)s could not be found.")
[docs]class NodeAssociated(InvalidState): message = _("Node %(node)s is associated with instance %(instance)s.")
[docs]class PortNotFound(NotFound): message = _("Port %(port)s could not be found.")
[docs]class FailedToUpdateDHCPOptOnPort(IronicException): message = _("Update DHCP options on port: %(port_id)s failed.")
[docs]class FailedToGetIPAddressOnPort(IronicException): message = _("Retrieve IP address on port: %(port_id)s failed.")
[docs]class InvalidIPv4Address(IronicException): message = _("Invalid IPv4 address %(ip_address)s.")
[docs]class FailedToUpdateMacOnPort(IronicException): message = _("Update MAC address on port: %(port_id)s failed.")
[docs]class ChassisNotFound(NotFound): message = _("Chassis %(chassis)s could not be found.")
[docs]class NoDriversLoaded(IronicException): message = _("Conductor %(conductor)s cannot be started " "because no drivers were loaded.")
[docs]class ConductorNotFound(NotFound): message = _("Conductor %(conductor)s could not be found.")
[docs]class ConductorAlreadyRegistered(IronicException): message = _("Conductor %(conductor)s already registered.")
[docs]class PowerStateFailure(InvalidState): message = _("Failed to set node power state to %(pstate)s.")
[docs]class ExclusiveLockRequired(NotAuthorized): message = _("An exclusive lock is required, " "but the current context has a shared lock.")
[docs]class NodeMaintenanceFailure(Invalid): message = _("Failed to toggle maintenance-mode flag " "for node %(node)s: %(reason)s")
[docs]class NodeConsoleNotEnabled(Invalid): message = _("Console access is not enabled on node %(node)s")
[docs]class NodeInMaintenance(Invalid): message = _("The %(op)s operation can't be performed on node " "%(node)s because it's in maintenance mode.")
[docs]class ChassisNotEmpty(Invalid): message = _("Cannot complete the requested action because chassis " "%(chassis)s contains nodes.")
[docs]class IPMIFailure(IronicException): message = _("IPMI call failed: %(cmd)s.")
[docs]class AMTConnectFailure(IronicException): message = _("Failed to connect to AMT service.")
[docs]class AMTFailure(IronicException): message = _("AMT call failed: %(cmd)s.")
[docs]class MSFTOCSClientApiException(IronicException): message = _("MSFT OCS call failed.")
[docs]class SSHConnectFailed(IronicException): message = _("Failed to establish SSH connection to host %(host)s.")
[docs]class SSHCommandFailed(IronicException): message = _("Failed to execute command via SSH: %(cmd)s.")
[docs]class UnsupportedDriverExtension(Invalid): message = _('Driver %(driver)s does not support %(extension)s ' '(disabled or not implemented).')
[docs]class GlanceConnectionFailed(IronicException): message = _("Connection to glance host %(host)s:%(port)s failed: " "%(reason)s")
[docs]class ImageNotAuthorized(NotAuthorized): message = _("Not authorized for image %(image_id)s.")
[docs]class InvalidImageRef(Invalid): message = _("Invalid image href %(image_href)s.")
[docs]class ImageRefValidationFailed(IronicException): message = _("Validation of image href %(image_href)s failed, " "reason: %(reason)s")
[docs]class ImageDownloadFailed(IronicException): message = _("Failed to download image %(image_href)s, reason: %(reason)s")
[docs]class KeystoneUnauthorized(IronicException): message = _("Not authorized in Keystone.")
[docs]class KeystoneFailure(IronicException): pass
[docs]class CatalogNotFound(IronicException): message = _("Service type %(service_type)s with endpoint type " "%(endpoint_type)s not found in keystone service catalog.")
[docs]class ServiceUnavailable(IronicException): message = _("Connection failed")
[docs]class Forbidden(IronicException): message = _("Requested OpenStack Images API is forbidden")
[docs]class BadRequest(IronicException): pass
[docs]class InvalidEndpoint(IronicException): message = _("The provided endpoint is invalid")
[docs]class CommunicationError(IronicException): message = _("Unable to communicate with the server.")
[docs]class HTTPForbidden(Forbidden): pass
[docs]class Unauthorized(IronicException): pass
[docs]class HTTPNotFound(NotFound): pass
[docs]class ConfigNotFound(IronicException): message = _("Could not find config at %(path)s")
[docs]class NodeLocked(Conflict): message = _("Node %(node)s is locked by host %(host)s, please retry " "after the current operation is completed.")
[docs]class NodeNotLocked(Invalid): message = _("Node %(node)s found not to be locked on release")
[docs]class NoFreeConductorWorker(TemporaryFailure): message = _('Requested action cannot be performed due to lack of free ' 'conductor workers.') code = http_client.SERVICE_UNAVAILABLE
[docs]class VendorPassthruException(IronicException): pass
[docs]class ConfigInvalid(IronicException): message = _("Invalid configuration file. %(error_msg)s")
[docs]class DriverLoadError(IronicException): message = _("Driver %(driver)s could not be loaded. Reason: %(reason)s.")
[docs]class ConsoleError(IronicException): pass
[docs]class NoConsolePid(ConsoleError): message = _("Could not find pid in pid file %(pid_path)s")
[docs]class ConsoleSubprocessFailed(ConsoleError): message = _("Console subprocess failed to start. %(error)s")
[docs]class PasswordFileFailedToCreate(IronicException): message = _("Failed to create the password file. %(error)s")
[docs]class IBootOperationError(IronicException): pass
[docs]class IloOperationError(IronicException): message = _("%(operation)s failed, error: %(error)s")
[docs]class IloOperationNotSupported(IronicException): message = _("%(operation)s not supported. error: %(error)s")
[docs]class DracRequestFailed(IronicException): pass
[docs]class DracClientError(DracRequestFailed): message = _('DRAC client failed. ' 'Last error (cURL error code): %(last_error)s, ' 'fault string: "%(fault_string)s" ' 'response_code: %(response_code)s')
[docs]class DracOperationFailed(DracRequestFailed): message = _('DRAC operation failed. Message: %(message)s')
[docs]class DracUnexpectedReturnValue(DracRequestFailed): message = _('DRAC operation yielded return value %(actual_return_value)s ' 'that is neither error nor expected %(expected_return_value)s')
[docs]class DracPendingConfigJobExists(IronicException): message = _('Another job with ID %(job_id)s is already created ' 'to configure %(target)s. Wait until existing job ' 'is completed or is canceled')
[docs]class DracInvalidFilterDialect(IronicException): message = _('Invalid filter dialect \'%(invalid_filter)s\'. ' 'Supported options are %(supported)s')
[docs]class FailedToGetSensorData(IronicException): message = _("Failed to get sensor data for node %(node)s. " "Error: %(error)s")
[docs]class FailedToParseSensorData(IronicException): message = _("Failed to parse sensor data for node %(node)s. " "Error: %(error)s")
[docs]class InsufficientDiskSpace(IronicException): message = _("Disk volume where '%(path)s' is located doesn't have " "enough disk space. Required %(required)d MiB, " "only %(actual)d MiB available space present.")
[docs]class ImageCreationFailed(IronicException): message = _('Creating %(image_type)s image failed: %(error)s')
[docs]class SwiftOperationError(IronicException): message = _("Swift operation '%(operation)s' failed: %(error)s")
[docs]class SNMPFailure(IronicException): message = _("SNMP operation '%(operation)s' failed: %(error)s")
[docs]class FileSystemNotSupported(IronicException): message = _("Failed to create a file system. " "File system %(fs)s is not supported.")
[docs]class IRMCOperationError(IronicException): message = _('iRMC %(operation)s failed. Reason: %(error)s')
[docs]class IRMCSharedFileSystemNotMounted(IronicException): message = _("iRMC shared file system '%(share)s' is not mounted.")
[docs]class VirtualBoxOperationFailed(IronicException): message = _("VirtualBox operation '%(operation)s' failed. " "Error: %(error)s")
[docs]class HardwareInspectionFailure(IronicException): message = _("Failed to inspect hardware. Reason: %(error)s")
[docs]class NodeCleaningFailure(IronicException): message = _("Failed to clean node %(node)s: %(reason)s")
[docs]class PathNotFound(IronicException): message = _("Path %(dir)s does not exist.")
[docs]class DirectoryNotWritable(IronicException): message = _("Directory %(dir)s is not writable.")
[docs]class UcsOperationError(IronicException): message = _("Cisco UCS client: operation %(operation)s failed for node" " %(node)s. Reason: %(error)s")
[docs]class UcsConnectionError(IronicException): message = _("Cisco UCS client: connection failed for node " "%(node)s. Reason: %(error)s")
[docs]class WolOperationError(IronicException): pass
[docs]class ImageUploadFailed(IronicException): message = _("Failed to upload %(image_name)s image to web server " "%(web_server)s, reason: %(reason)s")
[docs]class CIMCException(IronicException): message = _("Cisco IMC exception occurred for node %(node)s: %(error)s")