ironic/ironic/objects/fields.py
Mario Villaplana ff32b51bbf Add power state change notifications
This adds optional notifications emitted when ironic changes a node's power
state or when ironic detects a change in a node's power state.

These notifications can be consumed by any external service listening to the
message bus to perform functions like tracking node power state changes over
time or automatically responding to anomalous power states.

The event_types of the new notifications are:

* baremetal.node.power_set.{start,end,error}
* baremetal.node.power_state_corrected.success

This also adds a new NodePayload class for notification payloads related
to nodes.

Change-Id: I82702e7f959d666bb02b59d1fc53ab50b519cb74
Closes-Bug: 1526408
2016-10-17 15:39:18 +00:00

152 lines
4.0 KiB
Python

# Copyright 2015 Red Hat, Inc.
# 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.
import ast
import hashlib
import inspect
import six
from oslo_versionedobjects import fields as object_fields
from ironic.common import utils
class IntegerField(object_fields.IntegerField):
pass
class UUIDField(object_fields.UUIDField):
pass
class StringField(object_fields.StringField):
pass
class StringAcceptsCallable(object_fields.String):
@staticmethod
def coerce(obj, attr, value):
if callable(value):
value = value()
return super(StringAcceptsCallable, StringAcceptsCallable).coerce(
obj, attr, value)
class StringFieldThatAcceptsCallable(object_fields.StringField):
"""Custom StringField object that allows for functions as default
In some cases we need to allow for dynamic defaults based on configuration
options, this StringField object allows for a function to be passed as a
default, and will only process it at the point the field is coerced
"""
AUTO_TYPE = StringAcceptsCallable()
def __repr__(self):
default = self._default
if (self._default != object_fields.UnspecifiedDefault and
callable(self._default)):
default = "%s-%s" % (
self._default.__name__,
hashlib.md5(inspect.getsource(
self._default).encode()).hexdigest())
return '%s(default=%s,nullable=%s)' % (self._type.__class__.__name__,
default, self._nullable)
class DateTimeField(object_fields.DateTimeField):
pass
class BooleanField(object_fields.BooleanField):
pass
class ListOfStringsField(object_fields.ListOfStringsField):
pass
class ObjectField(object_fields.ObjectField):
pass
class FlexibleDict(object_fields.FieldType):
@staticmethod
def coerce(obj, attr, value):
if isinstance(value, six.string_types):
value = ast.literal_eval(value)
return dict(value)
class FlexibleDictField(object_fields.AutoTypedField):
AUTO_TYPE = FlexibleDict()
# TODO(lucasagomes): In our code we've always translated None to {},
# this method makes this field to work like this. But probably won't
# be accepted as-is in the oslo_versionedobjects library
def _null(self, obj, attr):
if self.nullable:
return {}
super(FlexibleDictField, self)._null(obj, attr)
class EnumField(object_fields.EnumField):
pass
class NotificationLevel(object_fields.Enum):
DEBUG = 'debug'
INFO = 'info'
WARNING = 'warning'
ERROR = 'error'
CRITICAL = 'critical'
ALL = (DEBUG, INFO, WARNING, ERROR, CRITICAL)
def __init__(self):
super(NotificationLevel, self).__init__(
valid_values=NotificationLevel.ALL)
class NotificationLevelField(object_fields.BaseEnumField):
AUTO_TYPE = NotificationLevel()
class NotificationStatus(object_fields.Enum):
START = 'start'
END = 'end'
ERROR = 'error'
SUCCESS = 'success'
ALL = (START, END, ERROR, SUCCESS)
def __init__(self):
super(NotificationStatus, self).__init__(
valid_values=NotificationStatus.ALL)
class NotificationStatusField(object_fields.BaseEnumField):
AUTO_TYPE = NotificationStatus()
class MACAddress(object_fields.FieldType):
@staticmethod
def coerce(obj, attr, value):
return utils.validate_and_normalize_mac(value)
class MACAddressField(object_fields.AutoTypedField):
AUTO_TYPE = MACAddress()