class TerseActionPlanPayload(notificationbase.NotificationPayloadBase): SCHEMA = { 'uuid': ('action_plan', 'uuid'), 'state': ('action_plan', 'state'), 'global_efficacy': ('action_plan', 'global_efficacy'), 'created_at': ('action_plan', 'created_at'), 'updated_at': ('action_plan', 'updated_at'), 'deleted_at': ('action_plan', 'deleted_at'), } # Version 1.0: Initial version # Version 1.1: Changed 'global_efficacy' type Dictionary to List VERSION = '1.1' fields = { 'uuid': wfields.UUIDField(), 'state': wfields.StringField(), 'global_efficacy': wfields.FlexibleListOfDictField(nullable=True), 'audit_uuid': wfields.UUIDField(), 'strategy_uuid': wfields.UUIDField(nullable=True), 'created_at': wfields.DateTimeField(nullable=True), 'updated_at': wfields.DateTimeField(nullable=True), 'deleted_at': wfields.DateTimeField(nullable=True), } def __init__(self, action_plan, audit=None, strategy=None, **kwargs): super(TerseActionPlanPayload, self).__init__(audit=audit, strategy=strategy, **kwargs) self.populate_schema(action_plan=action_plan)
class ActionPayload(notificationbase.NotificationPayloadBase): SCHEMA = { 'uuid': ('action', 'uuid'), 'action_type': ('action', 'action_type'), 'input_parameters': ('action', 'input_parameters'), 'state': ('action', 'state'), 'parents': ('action', 'parents'), 'created_at': ('action', 'created_at'), 'updated_at': ('action', 'updated_at'), 'deleted_at': ('action', 'deleted_at'), } # Version 1.0: Initial version VERSION = '1.0' fields = { 'uuid': wfields.UUIDField(), 'action_type': wfields.StringField(nullable=False), 'input_parameters': wfields.DictField(nullable=False, default={}), 'state': wfields.StringField(nullable=False), 'parents': wfields.ListOfUUIDsField(nullable=False, default=[]), 'action_plan_uuid': wfields.UUIDField(), 'action_plan': wfields.ObjectField('TerseActionPlanPayload'), 'created_at': wfields.DateTimeField(nullable=True), 'updated_at': wfields.DateTimeField(nullable=True), 'deleted_at': wfields.DateTimeField(nullable=True), } def __init__(self, action, **kwargs): super(ActionPayload, self).__init__(**kwargs) self.populate_schema(action=action)
class TerseAuditPayload(notificationbase.NotificationPayloadBase): SCHEMA = { 'uuid': ('audit', 'uuid'), 'audit_type': ('audit', 'audit_type'), 'state': ('audit', 'state'), 'parameters': ('audit', 'parameters'), 'interval': ('audit', 'interval'), 'scope': ('audit', 'scope'), 'created_at': ('audit', 'created_at'), 'updated_at': ('audit', 'updated_at'), 'deleted_at': ('audit', 'deleted_at'), } # Version 1.0: Initial version VERSION = '1.0' fields = { 'uuid': wfields.UUIDField(), 'audit_type': wfields.StringField(), 'state': wfields.StringField(), 'parameters': wfields.FlexibleDictField(nullable=True), 'interval': wfields.IntegerField(nullable=True), 'scope': wfields.FlexibleListOfDictField(nullable=True), 'goal_uuid': wfields.UUIDField(), 'strategy_uuid': wfields.UUIDField(nullable=True), 'created_at': wfields.DateTimeField(nullable=True), 'updated_at': wfields.DateTimeField(nullable=True), 'deleted_at': wfields.DateTimeField(nullable=True), } def __init__(self, audit, goal_uuid, strategy_uuid=None, **kwargs): super(TerseAuditPayload, self).__init__(goal_uuid=goal_uuid, strategy_uuid=strategy_uuid, **kwargs) self.populate_schema(audit=audit)
class GoalPayload(notificationbase.NotificationPayloadBase): SCHEMA = { 'uuid': ('goal', 'uuid'), 'name': ('goal', 'name'), 'display_name': ('goal', 'display_name'), 'efficacy_specification': ('goal', 'efficacy_specification'), 'created_at': ('goal', 'created_at'), 'updated_at': ('goal', 'updated_at'), 'deleted_at': ('goal', 'deleted_at'), } # Version 1.0: Initial version VERSION = '1.0' fields = { 'uuid': wfields.UUIDField(), 'name': wfields.StringField(), 'display_name': wfields.StringField(), 'efficacy_specification': wfields.FlexibleListOfDictField(), 'created_at': wfields.DateTimeField(nullable=True), 'updated_at': wfields.DateTimeField(nullable=True), 'deleted_at': wfields.DateTimeField(nullable=True), } def __init__(self, goal, **kwargs): super(GoalPayload, self).__init__(**kwargs) self.populate_schema(goal=goal)
class StrategyPayload(notificationbase.NotificationPayloadBase): SCHEMA = { 'uuid': ('strategy', 'uuid'), 'name': ('strategy', 'name'), 'display_name': ('strategy', 'display_name'), 'parameters_spec': ('strategy', 'parameters_spec'), 'created_at': ('strategy', 'created_at'), 'updated_at': ('strategy', 'updated_at'), 'deleted_at': ('strategy', 'deleted_at'), } # Version 1.0: Initial version VERSION = '1.0' fields = { 'uuid': wfields.UUIDField(), 'name': wfields.StringField(), 'display_name': wfields.StringField(), 'parameters_spec': wfields.FlexibleDictField(nullable=True), 'created_at': wfields.DateTimeField(nullable=True), 'updated_at': wfields.DateTimeField(nullable=True), 'deleted_at': wfields.DateTimeField(nullable=True), } def __init__(self, strategy, **kwargs): super(StrategyPayload, self).__init__(**kwargs) self.populate_schema(strategy=strategy)
class TerseAuditPayload(notificationbase.NotificationPayloadBase): SCHEMA = { 'uuid': ('audit', 'uuid'), 'name': ('audit', 'name'), 'audit_type': ('audit', 'audit_type'), 'state': ('audit', 'state'), 'parameters': ('audit', 'parameters'), 'interval': ('audit', 'interval'), 'scope': ('audit', 'scope'), 'auto_trigger': ('audit', 'auto_trigger'), 'next_run_time': ('audit', 'next_run_time'), 'created_at': ('audit', 'created_at'), 'updated_at': ('audit', 'updated_at'), 'deleted_at': ('audit', 'deleted_at'), } # Version 1.0: Initial version # Version 1.1: Added 'auto_trigger' boolean field, # Added 'next_run_time' DateTime field, # 'interval' type has been changed from Integer to String # Version 1.2: Added 'name' string field VERSION = '1.2' fields = { 'uuid': wfields.UUIDField(), 'name': wfields.StringField(), 'audit_type': wfields.StringField(), 'state': wfields.StringField(), 'parameters': wfields.FlexibleDictField(nullable=True), 'interval': wfields.StringField(nullable=True), 'scope': wfields.FlexibleListOfDictField(nullable=True), 'goal_uuid': wfields.UUIDField(), 'strategy_uuid': wfields.UUIDField(nullable=True), 'auto_trigger': wfields.BooleanField(), 'next_run_time': wfields.DateTimeField(nullable=True), 'created_at': wfields.DateTimeField(nullable=True), 'updated_at': wfields.DateTimeField(nullable=True), 'deleted_at': wfields.DateTimeField(nullable=True), } def __init__(self, audit, goal_uuid, strategy_uuid=None, **kwargs): super(TerseAuditPayload, self).__init__(goal_uuid=goal_uuid, strategy_uuid=strategy_uuid, **kwargs) self.populate_schema(audit=audit)
class ActionPlanPayload(notificationbase.NotificationPayloadBase): SCHEMA = { 'uuid': ('action_plan', 'uuid'), 'state': ('action_plan', 'state'), 'global_efficacy': ('action_plan', 'global_efficacy'), 'audit_uuid': ('audit', 'uuid'), 'strategy_uuid': ('strategy', 'uuid'), 'created_at': ('action_plan', 'created_at'), 'updated_at': ('action_plan', 'updated_at'), 'deleted_at': ('action_plan', 'deleted_at'), } # Version 1.0: Initial version VERSION = '1.0' fields = { 'uuid': wfields.UUIDField(), 'state': wfields.StringField(), 'global_efficacy': wfields.FlexibleDictField(nullable=True), 'audit_uuid': wfields.UUIDField(), 'strategy_uuid': wfields.UUIDField(), 'audit': wfields.ObjectField('TerseAuditPayload'), 'strategy': wfields.ObjectField('StrategyPayload'), 'created_at': wfields.DateTimeField(nullable=True), 'updated_at': wfields.DateTimeField(nullable=True), 'deleted_at': wfields.DateTimeField(nullable=True), } def __init__(self, action_plan, audit, strategy, **kwargs): super(ActionPlanPayload, self).__init__( audit=audit, strategy=strategy, **kwargs) self.populate_schema( action_plan=action_plan, audit=audit, strategy=strategy)
class ServicePayload(notificationbase.NotificationPayloadBase): SCHEMA = { 'sevice_host': ('failed_service', 'host'), 'name': ('failed_service', 'name'), 'last_seen_up': ('failed_service', 'last_seen_up'), } # Version 1.0: Initial version VERSION = '1.0' fields = { 'sevice_host': wfields.StringField(), 'name': wfields.StringField(), 'last_seen_up': wfields.DateTimeField(nullable=True), } def __init__(self, failed_service, status_update, **kwargs): super(ServicePayload, self).__init__(failed_service=failed_service, status_update=status_update, **kwargs) self.populate_schema(failed_service=failed_service)
def test_base_attributes(self): dt = datetime.datetime(1955, 11, 5, 0, 0, tzinfo=iso8601.iso8601.Utc()) datatime = fields.DateTimeField() obj = MyObj(self.context) obj.created_at = dt obj.updated_at = dt expected = {'watcher_object.name': 'MyObj', 'watcher_object.namespace': 'watcher', 'watcher_object.version': '1.5', 'watcher_object.changes': ['created_at', 'updated_at'], 'watcher_object.data': {'created_at': datatime.stringify(dt), 'updated_at': datatime.stringify(dt), } } actual = obj.obj_to_primitive() # watcher_object.changes is built from a set and order is undefined self.assertEqual(sorted(expected['watcher_object.changes']), sorted(actual['watcher_object.changes'])) del expected[ 'watcher_object.changes'], actual['watcher_object.changes'] self.assertEqual(expected, actual)
class Audit(base.WatcherPersistentObject, base.WatcherObject, base.WatcherObjectDictCompat): # Version 1.0: Initial version # Version 1.1: Added 'goal' and 'strategy' object field # Version 1.2: Added 'auto_trigger' boolean field # Version 1.3: Added 'next_run_time' DateTime field, # 'interval' type has been changed from Integer to String VERSION = '1.3' dbapi = db_api.get_instance() fields = { 'id': wfields.IntegerField(), 'uuid': wfields.UUIDField(), 'audit_type': wfields.StringField(), 'state': wfields.StringField(), 'parameters': wfields.FlexibleDictField(nullable=True), 'interval': wfields.StringField(nullable=True), 'scope': wfields.FlexibleListOfDictField(nullable=True), 'goal_id': wfields.IntegerField(), 'strategy_id': wfields.IntegerField(nullable=True), 'auto_trigger': wfields.BooleanField(), 'next_run_time': wfields.DateTimeField(nullable=True, tzinfo_aware=False), 'goal': wfields.ObjectField('Goal', nullable=True), 'strategy': wfields.ObjectField('Strategy', nullable=True), } object_fields = { 'goal': (objects.Goal, 'goal_id'), 'strategy': (objects.Strategy, 'strategy_id'), } # Proxified field so we can keep the previous value after an update _state = None _old_state = None # NOTE(v-francoise): The way oslo.versionedobjects works is by using a # __new__ that will automatically create the attributes referenced in # fields. These attributes are properties that raise an exception if no # value has been assigned, which means that they store the actual field # value in an "_obj_%(field)s" attribute. So because we want to proxify a # value that is already proxified, we have to do what you see below. @property def _obj_state(self): return self._state @property def _obj_old_state(self): return self._old_state @property def old_state(self): return self._old_state @_obj_old_state.setter def _obj_old_state(self, value): self._old_state = value @_obj_state.setter def _obj_state(self, value): if self._old_state is None and self._state is None: self._state = value else: self._old_state, self._state = self._state, value @base.remotable_classmethod def get(cls, context, audit_id, eager=False): """Find a audit based on its id or uuid and return a Audit object. :param context: Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don't use it. A context should be set when instantiating the object, e.g.: Audit(context) :param audit_id: the id *or* uuid of a audit. :param eager: Load object fields if True (Default: False) :returns: a :class:`Audit` object. """ if utils.is_int_like(audit_id): return cls.get_by_id(context, audit_id, eager=eager) elif utils.is_uuid_like(audit_id): return cls.get_by_uuid(context, audit_id, eager=eager) else: raise exception.InvalidIdentity(identity=audit_id) @base.remotable_classmethod def get_by_id(cls, context, audit_id, eager=False): """Find a audit based on its integer id and return a Audit object. :param context: Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don't use it. A context should be set when instantiating the object, e.g.: Audit(context) :param audit_id: the id of a audit. :param eager: Load object fields if True (Default: False) :returns: a :class:`Audit` object. """ db_audit = cls.dbapi.get_audit_by_id(context, audit_id, eager=eager) audit = cls._from_db_object(cls(context), db_audit, eager=eager) return audit @base.remotable_classmethod def get_by_uuid(cls, context, uuid, eager=False): """Find a audit based on uuid and return a :class:`Audit` object. :param context: Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don't use it. A context should be set when instantiating the object, e.g.: Audit(context) :param uuid: the uuid of a audit. :param eager: Load object fields if True (Default: False) :returns: a :class:`Audit` object. """ db_audit = cls.dbapi.get_audit_by_uuid(context, uuid, eager=eager) audit = cls._from_db_object(cls(context), db_audit, eager=eager) return audit @base.remotable_classmethod def list(cls, context, limit=None, marker=None, filters=None, sort_key=None, sort_dir=None, eager=False): """Return a list of Audit objects. :param context: Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don't use it. A context should be set when instantiating the object, e.g.: Audit(context) :param limit: maximum number of resources to return in a single result. :param marker: pagination marker for large data sets. :param filters: Filters to apply. Defaults to None. :param sort_key: column to sort results by. :param sort_dir: direction to sort. "asc" or "desc". :param eager: Load object fields if True (Default: False) :returns: a list of :class:`Audit` object. """ db_audits = cls.dbapi.get_audit_list(context, limit=limit, marker=marker, filters=filters, sort_key=sort_key, sort_dir=sort_dir, eager=eager) return [ cls._from_db_object(cls(context), obj, eager=eager) for obj in db_audits ] @base.remotable def create(self): """Create an :class:`Audit` record in the DB. :returns: An :class:`Audit` object. """ values = self.obj_get_changes() db_audit = self.dbapi.create_audit(values) # Note(v-francoise): Always load eagerly upon creation so we can send # notifications containing information about the related relationships self._from_db_object(self, db_audit, eager=True) def _notify(): notifications.audit.send_create(self._context, self) _notify() @base.remotable def destroy(self): """Delete the Audit from the DB.""" self.dbapi.destroy_audit(self.uuid) self.obj_reset_changes() @base.remotable def save(self): """Save updates to this Audit. Updates will be made column by column based on the result of self.what_changed(). """ updates = self.obj_get_changes() db_obj = self.dbapi.update_audit(self.uuid, updates) obj = self._from_db_object(self.__class__(self._context), db_obj, eager=False) self.obj_refresh(obj) def _notify(): notifications.audit.send_update(self._context, self, old_state=self.old_state) _notify() self.obj_reset_changes() @base.remotable def refresh(self, eager=False): """Loads updates for this Audit. Loads a audit with the same uuid from the database and checks for updated attributes. Updates are applied from the loaded audit column by column, if there are any updates. :param eager: Load object fields if True (Default: False) """ current = self.get_by_uuid(self._context, uuid=self.uuid, eager=eager) self.obj_refresh(current) @base.remotable def soft_delete(self): """Soft Delete the Audit from the DB.""" self.state = State.DELETED self.save() db_obj = self.dbapi.soft_delete_audit(self.uuid) obj = self._from_db_object(self.__class__(self._context), db_obj, eager=False) self.obj_refresh(obj) def _notify(): notifications.audit.send_delete(self._context, self) _notify()
class Service(base.WatcherPersistentObject, base.WatcherObject, base.WatcherObjectDictCompat): # Version 1.0: Initial version VERSION = '1.0' dbapi = db_api.get_instance() fields = { 'id': wfields.IntegerField(), 'name': wfields.StringField(), 'host': wfields.StringField(), 'last_seen_up': wfields.DateTimeField(tzinfo_aware=False, nullable=True), } @base.remotable_classmethod def get(cls, context, service_id): """Find a service based on its id :param context: Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don't use it. A context should be set when instantiating the object, e.g.: Service(context) :param service_id: the id of a service. :returns: a :class:`Service` object. """ if utils.is_int_like(service_id): db_service = cls.dbapi.get_service_by_id(context, service_id) service = Service._from_db_object(cls(context), db_service) return service else: raise exception.InvalidIdentity(identity=service_id) @base.remotable_classmethod def get_by_name(cls, context, name): """Find a service based on name :param name: the name of a service. :param context: Security context :returns: a :class:`Service` object. """ db_service = cls.dbapi.get_service_by_name(context, name) service = cls._from_db_object(cls(context), db_service) return service @base.remotable_classmethod def list(cls, context, limit=None, marker=None, filters=None, sort_key=None, sort_dir=None): """Return a list of :class:`Service` objects. :param context: Security context. NOTE: This should only be used internally by the indirection_api. Unfortunately, RPC requires context as the first argument, even though we don't use it. A context should be set when instantiating the object, e.g.: Service(context) :param filters: dict mapping the filter key to a value. :param limit: maximum number of resources to return in a single result. :param marker: pagination marker for large data sets. :param sort_key: column to sort results by. :param sort_dir: direction to sort. "asc" or "desc". :returns: a list of :class:`Service` object. """ db_services = cls.dbapi.get_service_list(context, filters=filters, limit=limit, marker=marker, sort_key=sort_key, sort_dir=sort_dir) return [cls._from_db_object(cls(context), obj) for obj in db_services] @base.remotable def create(self): """Create a :class:`Service` record in the DB.""" values = self.obj_get_changes() db_service = self.dbapi.create_service(values) self._from_db_object(self, db_service) @base.remotable def save(self): """Save updates to this :class:`Service`. Updates will be made column by column based on the result of self.what_changed(). """ updates = self.obj_get_changes() db_obj = self.dbapi.update_service(self.id, updates) obj = self._from_db_object(self, db_obj, eager=False) self.obj_refresh(obj) self.obj_reset_changes() def refresh(self): """Loads updates for this :class:`Service`. Loads a service with the same id from the database and checks for updated attributes. Updates are applied from the loaded service column by column, if there are any updates. """ current = self.get(self._context, service_id=self.id) for field in self.fields: if (hasattr(self, base.get_attrname(field)) and self[field] != current[field]): self[field] = current[field] def soft_delete(self): """Soft Delete the :class:`Service` from the DB.""" db_obj = self.dbapi.soft_delete_service(self.id) obj = self._from_db_object(self.__class__(self._context), db_obj, eager=False) self.obj_refresh(obj)