592 lines
17 KiB
Python
592 lines
17 KiB
Python
# Copyright 2015 - Mirantis, Inc.
|
|
# Copyright 2015 - StackStorm, Inc.
|
|
#
|
|
# 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 copy
|
|
import operator
|
|
|
|
from oslo_log import log as logging
|
|
|
|
from mistral.db.v2 import api as db_api
|
|
from mistral.db.v2.sqlalchemy import models
|
|
from mistral.engine import action_handler
|
|
from mistral.engine import policies
|
|
from mistral.engine import rpc
|
|
from mistral.engine import utils as e_utils
|
|
from mistral import exceptions as exc
|
|
from mistral import expressions as expr
|
|
from mistral.services import executions as wf_ex_service
|
|
from mistral.services import scheduler
|
|
from mistral import utils
|
|
from mistral.utils import wf_trace
|
|
from mistral.workbook import parser as spec_parser
|
|
from mistral.workflow import data_flow
|
|
from mistral.workflow import states
|
|
from mistral.workflow import utils as wf_utils
|
|
from mistral.workflow import with_items
|
|
|
|
|
|
"""Responsible for running tasks and handling results."""
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def run_existing_task(task_ex_id, reset=True):
|
|
"""This function runs existing task execution.
|
|
|
|
It is needed mostly by scheduler.
|
|
|
|
:param task_ex_id: Task execution id.
|
|
:param reset: Reset action executions for the task.
|
|
"""
|
|
task_ex = db_api.get_task_execution(task_ex_id)
|
|
task_spec = spec_parser.get_task_spec(task_ex.spec)
|
|
wf_def = db_api.get_workflow_definition(task_ex.workflow_name)
|
|
wf_spec = spec_parser.get_workflow_spec(wf_def.spec)
|
|
|
|
# Throw exception if the existing task already succeeded.
|
|
if task_ex.state == states.SUCCESS:
|
|
raise exc.EngineException(
|
|
'Rerunning existing task that already succeeded is not supported.'
|
|
)
|
|
|
|
# Exit if the existing task failed and reset is not instructed.
|
|
# For a with-items task without reset, re-running the existing
|
|
# task will re-run the failed and unstarted items.
|
|
if (task_ex.state == states.ERROR and not reset and
|
|
not task_spec.get_with_items()):
|
|
return task_ex
|
|
|
|
# Reset nested executions only if task is not already RUNNING.
|
|
if task_ex.state != states.RUNNING:
|
|
# Reset state of processed task and related action executions.
|
|
if reset:
|
|
action_exs = task_ex.executions
|
|
else:
|
|
action_exs = db_api.get_action_executions(
|
|
task_execution_id=task_ex.id,
|
|
state=states.ERROR,
|
|
accepted=True
|
|
)
|
|
|
|
for action_ex in action_exs:
|
|
action_ex.accepted = False
|
|
|
|
# Explicitly change task state to RUNNING.
|
|
set_task_state(task_ex, states.RUNNING, None, processed=False)
|
|
|
|
_run_existing_task(task_ex, task_spec, wf_spec)
|
|
|
|
return task_ex
|
|
|
|
|
|
def _run_existing_task(task_ex, task_spec, wf_spec):
|
|
try:
|
|
input_dicts = _get_input_dictionaries(
|
|
wf_spec,
|
|
task_ex,
|
|
task_spec,
|
|
task_ex.in_context
|
|
)
|
|
except exc.MistralException as e:
|
|
LOG.error(
|
|
'An error while calculating task action inputs'
|
|
' [task_execution_id=%s]: %s',
|
|
task_ex.id, e
|
|
)
|
|
|
|
set_task_state(task_ex, states.ERROR, str(e))
|
|
|
|
return
|
|
|
|
# In some cases we can have no input, e.g. in case of 'with-items'.
|
|
if input_dicts:
|
|
for index, input_d in input_dicts:
|
|
_run_action_or_workflow(
|
|
task_ex,
|
|
task_spec,
|
|
input_d,
|
|
index,
|
|
wf_spec
|
|
)
|
|
else:
|
|
_schedule_noop_action(task_ex, task_spec, wf_spec)
|
|
|
|
|
|
def defer_task(wf_cmd):
|
|
"""Defers a task"""
|
|
ctx = wf_cmd.ctx
|
|
wf_ex = wf_cmd.wf_ex
|
|
task_spec = wf_cmd.task_spec
|
|
|
|
if wf_utils.find_task_executions_by_spec(wf_ex, task_spec):
|
|
return None
|
|
|
|
return _create_task_execution(
|
|
wf_ex,
|
|
task_spec,
|
|
ctx,
|
|
state=states.WAITING
|
|
)
|
|
|
|
|
|
def run_new_task(wf_cmd, wf_spec):
|
|
"""Runs a task."""
|
|
ctx = wf_cmd.ctx
|
|
wf_ex = wf_cmd.wf_ex
|
|
task_spec = wf_cmd.task_spec
|
|
|
|
# NOTE(xylan): Need to think how to get rid of this weird judgment to keep
|
|
# it more consistent with the function name.
|
|
task_ex = wf_utils.find_task_execution_with_state(
|
|
wf_ex,
|
|
task_spec,
|
|
states.WAITING
|
|
)
|
|
|
|
if task_ex:
|
|
set_task_state(task_ex, states.RUNNING, None)
|
|
task_ex.in_context = ctx
|
|
else:
|
|
task_ex = _create_task_execution(wf_ex, task_spec, ctx)
|
|
|
|
LOG.debug(
|
|
'Starting workflow task [workflow=%s, task_spec=%s, init_state=%s]' %
|
|
(wf_ex.name, task_spec, task_ex.state)
|
|
)
|
|
|
|
# TODO(rakhmerov): 'concurrency' policy should keep a number of running
|
|
# actions/workflows under control so it can't be implemented if it runs
|
|
# before any action executions are created.
|
|
before_task_start(task_ex, task_spec, wf_spec)
|
|
|
|
# Policies could possibly change task state.
|
|
if task_ex.state != states.RUNNING:
|
|
return task_ex
|
|
|
|
_run_existing_task(task_ex, task_spec, wf_spec)
|
|
|
|
return task_ex
|
|
|
|
|
|
def on_action_complete(action_ex, wf_spec, result):
|
|
"""Handles event of action result arrival.
|
|
|
|
Given action result this method changes corresponding task execution
|
|
object. This method must never be called for the case of individual
|
|
action which is not associated with any tasks.
|
|
|
|
:param action_ex: Action execution objects the result belongs to.
|
|
:param wf_spec: Workflow specification.
|
|
:param result: Task action/workflow output wrapped into
|
|
mistral.workflow.utils.Result instance.
|
|
:return Task execution object.
|
|
"""
|
|
|
|
task_ex = action_ex.task_execution
|
|
|
|
# Ignore if action already completed.
|
|
if (states.is_completed(action_ex.state) and not
|
|
isinstance(action_ex, models.WorkflowExecution)):
|
|
return task_ex
|
|
|
|
task_spec = wf_spec.get_tasks()[task_ex.name]
|
|
|
|
try:
|
|
result = action_handler.transform_result(result, task_ex, task_spec)
|
|
except exc.YaqlEvaluationException as e:
|
|
err_msg = str(e)
|
|
|
|
LOG.error(
|
|
'YAQL error while transforming action result'
|
|
' [action_execution_id=%s, result=%s]: %s',
|
|
action_ex.id, result, err_msg
|
|
)
|
|
|
|
result = wf_utils.Result(error=err_msg)
|
|
|
|
# Ignore workflow executions because they're handled during
|
|
# workflow completion.
|
|
if not isinstance(action_ex, models.WorkflowExecution):
|
|
action_handler.store_action_result(action_ex, result)
|
|
|
|
if result.is_success():
|
|
task_state = states.SUCCESS
|
|
task_state_info = None
|
|
else:
|
|
task_state = states.ERROR
|
|
task_state_info = result.error
|
|
|
|
if not task_spec.get_with_items():
|
|
_complete_task(task_ex, task_spec, task_state, task_state_info)
|
|
else:
|
|
with_items.increase_capacity(task_ex)
|
|
|
|
if with_items.is_completed(task_ex):
|
|
_complete_task(
|
|
task_ex,
|
|
task_spec,
|
|
with_items.get_final_state(task_ex),
|
|
task_state_info
|
|
)
|
|
|
|
return task_ex
|
|
|
|
|
|
def _create_task_execution(wf_ex, task_spec, ctx, state=states.RUNNING):
|
|
task_ex = db_api.create_task_execution({
|
|
'name': task_spec.get_name(),
|
|
'workflow_execution_id': wf_ex.id,
|
|
'workflow_name': wf_ex.workflow_name,
|
|
'workflow_id': wf_ex.workflow_id,
|
|
'state': state,
|
|
'spec': task_spec.to_dict(),
|
|
'in_context': ctx,
|
|
'published': {},
|
|
'runtime_context': {},
|
|
'project_id': wf_ex.project_id
|
|
})
|
|
|
|
# Add to collection explicitly so that it's in a proper
|
|
# state within the current session.
|
|
wf_ex.task_executions.append(task_ex)
|
|
|
|
return task_ex
|
|
|
|
|
|
def before_task_start(task_ex, task_spec, wf_spec):
|
|
for p in policies.build_policies(task_spec.get_policies(), wf_spec):
|
|
p.before_task_start(task_ex, task_spec)
|
|
|
|
|
|
def after_task_complete(task_ex, task_spec, wf_spec):
|
|
for p in policies.build_policies(task_spec.get_policies(), wf_spec):
|
|
p.after_task_complete(task_ex, task_spec)
|
|
|
|
|
|
def _get_input_dictionaries(wf_spec, task_ex, task_spec, ctx):
|
|
"""Calculates a collection of inputs for task action/workflow.
|
|
|
|
If the given task is not configured as 'with-items' then return list
|
|
will consist of one dictionary containing input that task action/workflow
|
|
should run with.
|
|
In case of 'with-items' the result list will contain input dictionaries
|
|
for all 'with-items' iterations correspondingly.
|
|
|
|
:return the list of tuples containing indexes
|
|
and the corresponding input dict.
|
|
"""
|
|
# TODO(rakhmerov): Think how to get rid of this.
|
|
ctx = data_flow.extract_task_result_proxies_to_context(ctx)
|
|
|
|
if not task_spec.get_with_items():
|
|
input_dict = _get_workflow_or_action_input(
|
|
wf_spec,
|
|
task_ex,
|
|
task_spec,
|
|
ctx
|
|
)
|
|
|
|
return enumerate([input_dict])
|
|
else:
|
|
return _get_with_items_input(wf_spec, task_ex, task_spec, ctx)
|
|
|
|
|
|
def _get_workflow_or_action_input(wf_spec, task_ex, task_spec, ctx):
|
|
if task_spec.get_action_name():
|
|
return _get_action_input(
|
|
wf_spec,
|
|
task_ex,
|
|
task_spec,
|
|
ctx
|
|
)
|
|
elif task_spec.get_workflow_name():
|
|
return _get_workflow_input(task_spec, ctx)
|
|
else:
|
|
raise RuntimeError('Must never happen.')
|
|
|
|
|
|
def _get_with_items_input(wf_spec, task_ex, task_spec, ctx):
|
|
"""Calculate input array for separating each action input.
|
|
|
|
Example:
|
|
DSL:
|
|
with_items:
|
|
- itemX in <% $.arrayI %>
|
|
- itemY in <% $.arrayJ %>
|
|
|
|
Assume arrayI = [1, 2], arrayJ = ['a', 'b'].
|
|
with_items_input = {
|
|
"itemX": [1, 2],
|
|
"itemY": ['a', 'b']
|
|
}
|
|
|
|
Then we get separated input:
|
|
inputs_per_item = [
|
|
{'itemX': 1, 'itemY': 'a'},
|
|
{'itemX': 2, 'itemY': 'b'}
|
|
]
|
|
|
|
:return: the list of tuples containing indexes
|
|
and the corresponding input dict.
|
|
"""
|
|
with_items_inputs = expr.evaluate_recursively(
|
|
task_spec.get_with_items(), ctx
|
|
)
|
|
|
|
with_items.validate_input(with_items_inputs)
|
|
|
|
inputs_per_item = []
|
|
|
|
for key, value in with_items_inputs.items():
|
|
for index, item in enumerate(value):
|
|
iter_context = {key: item}
|
|
|
|
if index >= len(inputs_per_item):
|
|
inputs_per_item.append(iter_context)
|
|
else:
|
|
inputs_per_item[index].update(iter_context)
|
|
|
|
action_inputs = []
|
|
|
|
for item_input in inputs_per_item:
|
|
new_ctx = utils.merge_dicts(item_input, ctx)
|
|
|
|
action_inputs.append(_get_workflow_or_action_input(
|
|
wf_spec, task_ex, task_spec, new_ctx
|
|
))
|
|
|
|
with_items.prepare_runtime_context(task_ex, task_spec, action_inputs)
|
|
|
|
indices = with_items.get_indices_for_loop(task_ex)
|
|
with_items.decrease_capacity(task_ex, len(indices))
|
|
|
|
if indices:
|
|
current_inputs = operator.itemgetter(*indices)(action_inputs)
|
|
|
|
return zip(
|
|
indices,
|
|
current_inputs if isinstance(current_inputs, tuple)
|
|
else [current_inputs]
|
|
)
|
|
|
|
return []
|
|
|
|
|
|
def _get_action_input(wf_spec, task_ex, task_spec, ctx):
|
|
input_dict = expr.evaluate_recursively(task_spec.get_input(), ctx)
|
|
|
|
action_spec_name = task_spec.get_action_name()
|
|
|
|
input_dict = utils.merge_dicts(
|
|
input_dict,
|
|
_get_action_defaults(task_ex, task_spec),
|
|
overwrite=False
|
|
)
|
|
|
|
return action_handler.get_action_input(
|
|
action_spec_name,
|
|
input_dict,
|
|
task_ex.workflow_name,
|
|
wf_spec
|
|
)
|
|
|
|
|
|
def _get_workflow_input(task_spec, ctx):
|
|
return expr.evaluate_recursively(task_spec.get_input(), ctx)
|
|
|
|
|
|
def _run_action_or_workflow(task_ex, task_spec, input_dict, index, wf_spec):
|
|
t_name = task_ex.name
|
|
|
|
if task_spec.get_action_name():
|
|
wf_trace.info(
|
|
task_ex,
|
|
"Task '%s' is RUNNING [action_name = %s]" %
|
|
(t_name, task_spec.get_action_name())
|
|
)
|
|
|
|
_schedule_run_action(task_ex, task_spec, input_dict, index, wf_spec)
|
|
elif task_spec.get_workflow_name():
|
|
wf_trace.info(
|
|
task_ex,
|
|
"Task '%s' is RUNNING [workflow_name = %s]" %
|
|
(t_name, task_spec.get_workflow_name()))
|
|
|
|
_schedule_run_workflow(task_ex, task_spec, input_dict, index, wf_spec)
|
|
|
|
|
|
def _get_action_defaults(task_ex, task_spec):
|
|
actions = task_ex.in_context.get('__env', {}).get('__actions', {})
|
|
|
|
return actions.get(task_spec.get_action_name(), {})
|
|
|
|
|
|
def _schedule_run_action(task_ex, task_spec, action_input, index, wf_spec):
|
|
action_spec_name = task_spec.get_action_name()
|
|
|
|
action_def = action_handler.resolve_definition(
|
|
action_spec_name,
|
|
task_ex,
|
|
wf_spec
|
|
)
|
|
|
|
action_ex = action_handler.create_action_execution(
|
|
action_def,
|
|
action_input,
|
|
task_ex,
|
|
index
|
|
)
|
|
|
|
target = expr.evaluate_recursively(
|
|
task_spec.get_target(),
|
|
utils.merge_dicts(
|
|
copy.deepcopy(action_input),
|
|
copy.deepcopy(task_ex.in_context)
|
|
)
|
|
)
|
|
|
|
scheduler.schedule_call(
|
|
None,
|
|
'mistral.engine.action_handler.run_existing_action',
|
|
0,
|
|
action_ex_id=action_ex.id,
|
|
target=target
|
|
)
|
|
|
|
|
|
def _schedule_noop_action(task_ex, task_spec, wf_spec):
|
|
wf_ex = task_ex.workflow_execution
|
|
|
|
action_def = action_handler.resolve_action_definition(
|
|
'std.noop',
|
|
wf_ex.workflow_name,
|
|
wf_spec.get_name()
|
|
)
|
|
|
|
action_ex = action_handler.create_action_execution(action_def, {}, task_ex)
|
|
|
|
target = expr.evaluate_recursively(
|
|
task_spec.get_target(),
|
|
task_ex.in_context
|
|
)
|
|
|
|
scheduler.schedule_call(
|
|
None,
|
|
'mistral.engine.action_handler.run_existing_action',
|
|
0,
|
|
action_ex_id=action_ex.id,
|
|
target=target
|
|
)
|
|
|
|
|
|
def _schedule_run_workflow(task_ex, task_spec, wf_input, index,
|
|
parent_wf_spec):
|
|
parent_wf_ex = task_ex.workflow_execution
|
|
|
|
wf_spec_name = task_spec.get_workflow_name()
|
|
|
|
wf_def = e_utils.resolve_workflow_definition(
|
|
parent_wf_ex.workflow_name,
|
|
parent_wf_spec.get_name(),
|
|
wf_spec_name
|
|
)
|
|
|
|
wf_spec = spec_parser.get_workflow_spec(wf_def.spec)
|
|
|
|
wf_params = {
|
|
'task_execution_id': task_ex.id,
|
|
'with_items_index': index
|
|
}
|
|
|
|
if 'env' in parent_wf_ex.params:
|
|
wf_params['env'] = parent_wf_ex.params['env']
|
|
|
|
for k, v in list(wf_input.items()):
|
|
if k not in wf_spec.get_input():
|
|
wf_params[k] = v
|
|
del wf_input[k]
|
|
|
|
wf_ex_id, _ = wf_ex_service.create_workflow_execution(
|
|
wf_def.name,
|
|
wf_input,
|
|
"sub-workflow execution",
|
|
wf_params,
|
|
wf_spec
|
|
)
|
|
|
|
scheduler.schedule_call(
|
|
None,
|
|
'mistral.engine.task_handler.resume_workflow',
|
|
0,
|
|
wf_ex_id=wf_ex_id,
|
|
env=None
|
|
)
|
|
|
|
|
|
def resume_workflow(wf_ex_id, env):
|
|
rpc.get_engine_client().resume_workflow(wf_ex_id, env=env)
|
|
|
|
|
|
def _complete_task(task_ex, task_spec, state, state_info=None):
|
|
# Ignore if task already completed.
|
|
if states.is_completed(task_ex.state):
|
|
return []
|
|
|
|
set_task_state(task_ex, state, state_info)
|
|
|
|
try:
|
|
data_flow.publish_variables(task_ex, task_spec)
|
|
except exc.MistralException as e:
|
|
LOG.error(
|
|
'An error while publishing task variables'
|
|
' [task_execution_id=%s]: %s',
|
|
task_ex.id, str(e)
|
|
)
|
|
|
|
set_task_state(task_ex, states.ERROR, str(e))
|
|
|
|
if not task_spec.get_keep_result():
|
|
data_flow.destroy_task_result(task_ex)
|
|
|
|
|
|
def set_task_state(task_ex, state, state_info, processed=None):
|
|
wf_trace.info(
|
|
task_ex.workflow_execution,
|
|
"Task execution '%s' [%s -> %s]" %
|
|
(task_ex.name, task_ex.state, state)
|
|
)
|
|
|
|
task_ex.state = state
|
|
task_ex.state_info = state_info
|
|
|
|
if processed is not None:
|
|
task_ex.processed = processed
|
|
|
|
|
|
def is_task_completed(task_ex, task_spec):
|
|
if task_spec.get_with_items():
|
|
return with_items.is_completed(task_ex)
|
|
|
|
return states.is_completed(task_ex.state)
|
|
|
|
|
|
def need_to_continue(task_ex, task_spec):
|
|
# For now continue is available only for with-items.
|
|
if task_spec.get_with_items():
|
|
return (with_items.has_more_iterations(task_ex)
|
|
and with_items.get_concurrency(task_ex))
|
|
|
|
return False
|