deb-mistral/mistral/workflow/utils.py
Winson Chan 49a630d231 Fix state_info details for with-items task error
For workflow with error in a with-items task, the workflow state_info should
only include the output for action executions that erred.

Change-Id: Iad1a1af1d68d7810d56bcb5335fe31f54593aba4
Closes-Bug: #1522647
2015-12-04 05:19:11 +00:00

139 lines
3.9 KiB
Python

# Copyright 2014 - 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.
from mistral.utils import serializers
from mistral.workflow import states
class Result(object):
"""Explicit data structure containing a result of task execution."""
def __init__(self, data=None, error=None):
self.data = data
self.error = error
def __repr__(self):
return 'Result [data=%s, error=%s]' % (
repr(self.data), repr(self.error))
def is_error(self):
return self.error is not None
def is_success(self):
return not self.is_error()
def __eq__(self, other):
return self.data == other.data and self.error == other.error
class ResultSerializer(serializers.Serializer):
def serialize(self, entity):
return {'data': entity.data, 'error': entity.error}
def deserialize(self, entity):
return Result(entity['data'], entity['error'])
def find_task_execution_not_state(wf_ex, task_spec, state):
task_execs = [
t for t in wf_ex.task_executions
if t.name == task_spec.get_name() and t.state != state
]
return task_execs[0] if len(task_execs) > 0 else None
def find_task_execution_with_state(wf_ex, task_spec, state):
task_execs = [
t for t in wf_ex.task_executions
if t.name == task_spec.get_name() and t.state == state
]
return task_execs[0] if len(task_execs) > 0 else None
def find_task_executions_by_name(wf_ex, task_name):
return [t for t in wf_ex.task_executions if t.name == task_name]
def find_task_executions_by_spec(wf_ex, task_spec):
return find_task_executions_by_name(wf_ex, task_spec.get_name())
def find_task_executions_by_specs(wf_ex, task_specs):
res = []
for t_s in task_specs:
res = res + find_task_executions_by_spec(wf_ex, t_s)
return res
def find_task_executions_with_state(wf_ex, state):
return [t for t in wf_ex.task_executions if t.state == state]
def find_running_task_executions(wf_ex):
return find_task_executions_with_state(wf_ex, states.RUNNING)
def find_completed_tasks(wf_ex):
return [
t for t in wf_ex.task_executions if states.is_completed(t.state)
]
def find_successful_task_executions(wf_ex):
return find_task_executions_with_state(wf_ex, states.SUCCESS)
def find_incomplete_task_executions(wf_ex):
return [t for t in wf_ex.task_executions
if not states.is_completed(t.state)]
def find_error_task_executions(wf_ex):
return find_task_executions_with_state(wf_ex, states.ERROR)
def construct_fail_info_message(wf_ctrl, wf_ex):
# Try to find where error is exactly.
failed_tasks = sorted(
filter(
lambda t: not wf_ctrl.is_error_handled_for(t),
find_error_task_executions(wf_ex)
),
key=lambda t: t.name
)
msg = ('Failure caused by error in tasks: %s\n' %
', '.join([t.name for t in failed_tasks]))
for t in failed_tasks:
msg += '\n %s [task_ex_id=%s] -> %s\n' % (t.name, t.id, t.state_info)
for i, ex in enumerate(t.executions):
if ex.state == states.ERROR:
output = (ex.output or dict()).get('result', 'Unknown')
msg += (
' [action_ex_id=%s, idx=%s]: %s\n' % (
ex.id,
i,
str(output)
)
)
return msg