Source code for watcher.applier.actions.nop

# -*- encoding: utf-8 -*-
# Copyright (c) 2015 b<>com
#
# Authors: Jean-Emile DARTOIS <jean-emile.dartois@b-com.com>
#
# 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 oslo_log import log

from watcher.applier.actions import base

LOG = log.getLogger(__name__)


[docs]class Nop(base.BaseAction):
    """logs a message

    The action schema is::

        schema = Schema({
         'message': str,
        })

    The `message` is the actual message that will be logged.
    """

    MESSAGE = 'message'

    @property
    def schema(self):
        return {
            'type': 'object',
            'properties': {
                'message': {
                    'type': ['string', 'null']
                }
            },
            'required': ['message'],
            'additionalProperties': False,
        }

    @property
    def message(self):
        return self.input_parameters.get(self.MESSAGE)

[docs]    def execute(self):
        LOG.debug("Executing action NOP message: %s ", self.message)
        return True

[docs]    def revert(self):
        LOG.debug("Revert action NOP")
        return True

[docs]    def pre_condition(self):
        pass

[docs]    def post_condition(self):
        pass

[docs]    def get_description(self):
        """Description of the action"""
        return "Logging a NOP message"

[docs]    def abort(self):
        LOG.debug("Abort action NOP")
        return True