54d9e12e5b
In python-mistralclient, the `workflow_name` argument was renamed to
`workflow_identifier` in version 2.0.0, breaking this resource type. Ensure
that this works with all client versions by passing the first two arguments
as positional rather than keyword args.
Change-Id: Ibbed3af468bbc0d68995495095b6cd340c1ea427
Closes-Bug: #1557575
(cherry picked from commit f682e7afed
)
167 lines
5.7 KiB
Python
167 lines
5.7 KiB
Python
#
|
|
# 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 as logging
|
|
|
|
from heat.common import exception
|
|
from heat.common.i18n import _
|
|
from heat.common.i18n import _LW
|
|
from heat.engine import attributes
|
|
from heat.engine import constraints
|
|
from heat.engine import properties
|
|
from heat.engine import resource
|
|
from heat.engine import support
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class CronTrigger(resource.Resource):
|
|
"""A resource implements Mistral cron trigger.
|
|
|
|
Cron trigger is an object allowing to run workflow on a schedule. User
|
|
specifies what workflow with what input needs to be run and also specifies
|
|
how often it should be run. Pattern property is used to describe the
|
|
frequency of workflow execution.
|
|
"""
|
|
|
|
support_status = support.SupportStatus(version='5.0.0')
|
|
|
|
PROPERTIES = (
|
|
NAME, PATTERN, WORKFLOW, FIRST_TIME, COUNT
|
|
) = (
|
|
'name', 'pattern', 'workflow', 'first_time', 'count'
|
|
)
|
|
|
|
_WORKFLOW_KEYS = (
|
|
WORKFLOW_NAME, WORKFLOW_INPUT
|
|
) = (
|
|
'name', 'input'
|
|
)
|
|
|
|
ATTRIBUTES = (
|
|
NEXT_EXECUTION_TIME, REMAINING_EXECUTIONS
|
|
) = (
|
|
'next_execution_time', 'remaining_executions'
|
|
)
|
|
|
|
properties_schema = {
|
|
NAME: properties.Schema(
|
|
properties.Schema.STRING,
|
|
_('Name of the cron trigger.')
|
|
),
|
|
PATTERN: properties.Schema(
|
|
properties.Schema.STRING,
|
|
_('Cron expression.'),
|
|
constraints=[
|
|
constraints.CustomConstraint(
|
|
'cron_expression')
|
|
]
|
|
),
|
|
WORKFLOW: properties.Schema(
|
|
properties.Schema.MAP,
|
|
_('Workflow to execute.'),
|
|
required=True,
|
|
schema={
|
|
WORKFLOW_NAME: properties.Schema(
|
|
properties.Schema.STRING,
|
|
_('Name or ID of the workflow.'),
|
|
required=True,
|
|
constraints=[
|
|
constraints.CustomConstraint('mistral.workflow')
|
|
]
|
|
),
|
|
WORKFLOW_INPUT: properties.Schema(
|
|
properties.Schema.MAP,
|
|
_('Input values for the workflow.')
|
|
)
|
|
}
|
|
),
|
|
FIRST_TIME: properties.Schema(
|
|
properties.Schema.STRING,
|
|
_('Time of the first execution in format "YYYY-MM-DD HH:MM".')
|
|
),
|
|
COUNT: properties.Schema(
|
|
properties.Schema.INTEGER,
|
|
_('Remaining executions.')
|
|
)
|
|
}
|
|
|
|
attributes_schema = {
|
|
NEXT_EXECUTION_TIME: attributes.Schema(
|
|
_('Time of the next execution in format "YYYY-MM-DD HH:MM:SS".'),
|
|
type=attributes.Schema.STRING
|
|
),
|
|
REMAINING_EXECUTIONS: attributes.Schema(
|
|
_('Number of remaining executions.'),
|
|
type=attributes.Schema.INTEGER
|
|
)
|
|
}
|
|
|
|
default_client_name = 'mistral'
|
|
|
|
entity = 'cron_triggers'
|
|
|
|
def validate(self):
|
|
super(CronTrigger, self).validate()
|
|
if not (self.properties[self.PATTERN]
|
|
or self.properties[self.FIRST_TIME]):
|
|
raise exception.PropertyUnspecifiedError(self.PATTERN,
|
|
self.FIRST_TIME)
|
|
|
|
def _cron_trigger_name(self):
|
|
return self.properties.get(self.NAME) or self.physical_resource_name()
|
|
|
|
def handle_create(self):
|
|
workflow = self.properties.get(self.WORKFLOW)
|
|
name = self._cron_trigger_name()
|
|
identifier = workflow[self.WORKFLOW_NAME]
|
|
|
|
args = {
|
|
'pattern': self.properties.get(self.PATTERN),
|
|
'workflow_input': workflow.get(self.WORKFLOW_INPUT),
|
|
'first_time': self.properties.get(self.FIRST_TIME),
|
|
'count': self.properties.get(self.COUNT)
|
|
}
|
|
|
|
cron_trigger = self.client().cron_triggers.create(name, identifier,
|
|
**args)
|
|
self.resource_id_set(cron_trigger.name)
|
|
|
|
def _resolve_attribute(self, name):
|
|
if self.resource_id is None:
|
|
return
|
|
trigger = self.client().cron_triggers.get(self.resource_id)
|
|
if name == self.NEXT_EXECUTION_TIME:
|
|
return trigger.next_execution_time
|
|
elif name == self.REMAINING_EXECUTIONS:
|
|
return trigger.remaining_executions
|
|
|
|
def get_live_state(self, resource_properties):
|
|
# Currently mistral just deletes cron trigger that was executed
|
|
# (i.e. remaining execution is reached zero). In this case we can't
|
|
# found the cron trigger by mistral api. Suppose that live state of
|
|
# cron trigger is equal to the state stored in heat, otherwise we may
|
|
# go through undesirable update-replace. This behaviour might be
|
|
# changed after
|
|
# https://blueprints.launchpad.net/mistral/+spec/mistral-cron-trigger-life-cycle
|
|
# will be merged.
|
|
LOG.warning(_LW("get_live_state isn't implemented for this type of "
|
|
"resource due to specific behaviour of cron trigger "
|
|
"in mistral."))
|
|
return {}
|
|
|
|
|
|
def resource_mapping():
|
|
return {
|
|
'OS::Mistral::CronTrigger': CronTrigger,
|
|
}
|