98a65efb16
This patchset introduces a new custom directive called 'drivers-doc' which loads all available drivers under a given namespace and import their respective docstring into the .rst document. This patchset also contains some modification/addition to the docstring of these drivers to make the final document complete. Change-Id: Ib3df59fa45cea9d11d20fb73a5f0f1d564135bca Closes-Bug: #1536218 Closes-Bug: #1536735
68 lines
1.6 KiB
Python
68 lines
1.6 KiB
Python
# -*- 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
|
|
import six
|
|
import voluptuous
|
|
|
|
from watcher.applier.actions import base
|
|
|
|
|
|
LOG = log.getLogger(__name__)
|
|
|
|
|
|
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 voluptuous.Schema({
|
|
voluptuous.Required(self.MESSAGE): voluptuous.Any(
|
|
voluptuous.Any(*six.string_types), None)
|
|
})
|
|
|
|
@property
|
|
def message(self):
|
|
return self.input_parameters.get(self.MESSAGE)
|
|
|
|
def execute(self):
|
|
LOG.debug("executing action NOP message:%s ", self.message)
|
|
return True
|
|
|
|
def revert(self):
|
|
LOG.debug("revert action NOP")
|
|
return True
|
|
|
|
def precondition(self):
|
|
pass
|
|
|
|
def postcondition(self):
|
|
pass
|