d700c00a90
This patch adds get methods to the driver-lib which allows provider drivers to query for objects by ID. In support of the get methods, this patch fixes a bug in the data model to_dict() where it may not properly recurse the objects. It also improves connecting to the driver agent sockets and adds a timeout while waiting to receive data from the driver-agent. Change-Id: Ia69d1f61571a1a65dee585037affb317999d7ade Story: 2005870 Task: 33682
187 lines
8.0 KiB
Python
187 lines
8.0 KiB
Python
# Copyright 2018 Rackspace, US 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 octavia_lib.i18n import _
|
|
|
|
|
|
class DriverError(Exception):
|
|
"""Catch all exception that drivers can raise.
|
|
|
|
This exception includes two strings: The user fault string and the
|
|
optional operator fault string. The user fault string,
|
|
"user_fault_string", will be provided to the API requester. The operator
|
|
fault string, "operator_fault_string", will be logged in the Octavia API
|
|
log file for the operator to use when debugging.
|
|
|
|
:param user_fault_string: String provided to the API requester.
|
|
:type user_fault_string: string
|
|
:param operator_fault_string: Optional string logged by the Octavia API
|
|
for the operator to use when debugging.
|
|
:type operator_fault_string: string
|
|
"""
|
|
user_fault_string = _("An unknown driver error occurred.")
|
|
operator_fault_string = _("An unknown driver error occurred.")
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self.user_fault_string = kwargs.pop('user_fault_string',
|
|
self.user_fault_string)
|
|
self.operator_fault_string = kwargs.pop('operator_fault_string',
|
|
self.operator_fault_string)
|
|
super(DriverError, self).__init__(self.user_fault_string,
|
|
*args, **kwargs)
|
|
|
|
|
|
class NotImplementedError(Exception):
|
|
"""Exception raised when a driver does not implement an API function.
|
|
|
|
:param user_fault_string: String provided to the API requester.
|
|
:type user_fault_string: string
|
|
:param operator_fault_string: Optional string logged by the Octavia API
|
|
for the operator to use when debugging.
|
|
:type operator_fault_string: string
|
|
"""
|
|
user_fault_string = _("This feature is not implemented by the provider.")
|
|
operator_fault_string = _("This feature is not implemented by this "
|
|
"provider.")
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self.user_fault_string = kwargs.pop('user_fault_string',
|
|
self.user_fault_string)
|
|
self.operator_fault_string = kwargs.pop('operator_fault_string',
|
|
self.operator_fault_string)
|
|
super(NotImplementedError, self).__init__(self.user_fault_string,
|
|
*args, **kwargs)
|
|
|
|
|
|
class UnsupportedOptionError(Exception):
|
|
"""Exception raised when a driver does not support an option.
|
|
|
|
Provider drivers will validate that they can complete the request -- that
|
|
all options are supported by the driver. If the request fails validation,
|
|
drivers will raise an UnsupportedOptionError exception. For example, if a
|
|
driver does not support a flavor passed as an option to load balancer
|
|
create(), the driver will raise an UnsupportedOptionError and include a
|
|
message parameter providing an explanation of the failure.
|
|
|
|
:param user_fault_string: String provided to the API requester.
|
|
:type user_fault_string: string
|
|
:param operator_fault_string: Optional string logged by the Octavia API
|
|
for the operator to use when debugging.
|
|
:type operator_fault_string: string
|
|
"""
|
|
user_fault_string = _("A specified option is not supported by this "
|
|
"provider.")
|
|
operator_fault_string = _("A specified option is not supported by this "
|
|
"provider.")
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self.user_fault_string = kwargs.pop('user_fault_string',
|
|
self.user_fault_string)
|
|
self.operator_fault_string = kwargs.pop('operator_fault_string',
|
|
self.operator_fault_string)
|
|
super(UnsupportedOptionError, self).__init__(self.user_fault_string,
|
|
*args, **kwargs)
|
|
|
|
|
|
class UpdateStatusError(Exception):
|
|
"""Exception raised when a status update fails.
|
|
|
|
Each exception will include a message field that describes the
|
|
error and references to the failed record if available.
|
|
:param fault_string: String describing the fault.
|
|
:type fault_string: string
|
|
:param status_object: The object the fault occurred on.
|
|
:type status_object: string
|
|
:param status_object_id: The ID of the object that failed status update.
|
|
:type status_object_id: string
|
|
:param status_record: The status update record that caused the fault.
|
|
:type status_record: string
|
|
"""
|
|
fault_string = _("The status update had an unknown error.")
|
|
status_object = None
|
|
status_object_id = None
|
|
status_record = None
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self.fault_string = kwargs.pop('fault_string', self.fault_string)
|
|
self.status_object = kwargs.pop('status_object', None)
|
|
self.status_object_id = kwargs.pop('status_object_id', None)
|
|
self.status_record = kwargs.pop('status_record', None)
|
|
|
|
super(UpdateStatusError, self).__init__(self.fault_string,
|
|
*args, **kwargs)
|
|
|
|
|
|
class UpdateStatisticsError(Exception):
|
|
"""Exception raised when a statistics update fails.
|
|
|
|
Each exception will include a message field that describes the
|
|
error and references to the failed record if available.
|
|
:param fault_string: String describing the fault.
|
|
:type fault_string: string
|
|
:param status_object: The object the fault occurred on.
|
|
:type status_object: string
|
|
:param status_object_id: The ID of the object that failed stats update.
|
|
:type status_object_id: string
|
|
:param status_record: The stats update record that caused the fault.
|
|
:type status_record: string
|
|
"""
|
|
fault_string = _("The statistics update had an unknown error.")
|
|
stats_object = None
|
|
stats_object_id = None
|
|
stats_record = None
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self.fault_string = kwargs.pop('fault_string',
|
|
self.fault_string)
|
|
self.stats_object = kwargs.pop('stats_object', None)
|
|
self.stats_object_id = kwargs.pop('stats_object_id', None)
|
|
self.stats_record = kwargs.pop('stats_record', None)
|
|
|
|
super(UpdateStatisticsError, self).__init__(self.fault_string,
|
|
*args, **kwargs)
|
|
|
|
|
|
class DriverAgentNotFound(Exception):
|
|
"""Exception raised when the driver agent cannot be reached.
|
|
|
|
Each exception will include a message field that describes the
|
|
error.
|
|
:param fault_string: String describing the fault.
|
|
:type fault_string: string
|
|
"""
|
|
fault_string = _("The driver-agent process was not found or not ready.")
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self.fault_string = kwargs.pop('fault_string', self.fault_string)
|
|
super(DriverAgentNotFound, self).__init__(self.fault_string,
|
|
*args, **kwargs)
|
|
|
|
|
|
class DriverAgentTimeout(Exception):
|
|
"""Exception raised when the driver agent does not respond.
|
|
|
|
Raised when communication with the driver agent times out.
|
|
Each exception will include a message field that describes the
|
|
error.
|
|
:param fault_string: String describing the fault.
|
|
:type fault_string: string
|
|
"""
|
|
fault_string = _("The driver-agent timeout.")
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self.fault_string = kwargs.pop('fault_string', self.fault_string)
|
|
super(DriverAgentTimeout, self).__init__(self.fault_string,
|
|
*args, **kwargs)
|