Files
deb-mistral/mistral/tests/unit/engine1/test_with_items.py
Renat Akhmerov ed074ebfaa Refactoring task output: renaming 'output' to 'result' for task
* The reason behing this renaming is that task being an action/workflow
  invocation doesn't have input, it configures input for action/workflow.
  So to distinguish this difference and simplify communication around
  tasks it's been decided to rename 'task output' to 'task result'.
* Fixed required unit tests
* Removed weird transformation from 'output' to 'result' in task DB model
* Removed 'output' field in task REST resource, left only 'result'
  (it caused a lot of confusion before)
* Created a stub for data flow evaluate_effective_task_result() method
  that is supposed to calculate a final task result based on task
  invocations

Change-Id: I8c0e159c5c074185e0edc1982a01ad4f525b4d11
2015-02-17 08:47:53 +00:00

266 lines
6.7 KiB
Python

# Copyright 2015 - Mirantis, 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
from oslo.config import cfg
from mistral.db.v2 import api as db_api
from mistral.engine import states
from mistral.openstack.common import log as logging
from mistral.services import workbooks as wb_service
from mistral.tests.unit.engine1 import base
from mistral.workflow import utils as wf_utils
# TODO(nmakhotkin) Need to write more tests.
LOG = logging.getLogger(__name__)
# Use the set_default method to set value otherwise in certain test cases
# the change in value is not permanent.
cfg.CONF.set_default('auth_enable', False, group='pecan')
WORKBOOK = """
---
version: "2.0"
name: wb1
workflows:
with_items:
type: direct
input:
- names_info
tasks:
task1:
with-items: name_info in {$.names_info}
action: std.echo output={$.name_info.name}
publish:
result: "{$.task1}"
"""
WORKBOOK_WITH_STATIC_VAR = """
---
version: "2.0"
name: wb1
workflows:
with_items:
type: direct
input:
- names_info
- greeting
tasks:
task1:
with-items: name_info in {$.names_info}
action: std.echo output="{$.greeting}, {$.name_info.name}!"
publish:
result: "{$.task1}"
"""
WORKBOOK_MULTI_ARRAY = """
---
version: "2.0"
name: wb1
workflows:
with_items:
type: direct
input:
- arrayI
- arrayJ
tasks:
task1:
with-items:
- itemX in {$.arrayI}
- itemY in {$.arrayJ}
action: std.echo output="{$.itemX} {$.itemY}"
publish:
result: "{$.task1}"
"""
WORKBOOK_ACTION_CONTEXT = """
---
version: "2.0"
name: wb1
workflows:
wf1_with_items:
type: direct
input:
- links
tasks:
task1:
with-items: link in {$.links}
action: std.mistral_http url={$.link}
publish:
result: "{$.task1}"
"""
WORKFLOW_INPUT = {
'names_info': [
{'name': 'John'},
{'name': 'Ivan'},
{'name': 'Mistral'}
]
}
WF_INPUT_URLS = {
'links': [
'http://google.com',
'http://openstack.org',
'http://google.com'
]
}
class WithItemsEngineTest(base.EngineTestCase):
def test_with_items_simple(self):
wb_service.create_workbook_v2(WORKBOOK)
# Start workflow.
exec_db = self.engine.start_workflow('wb1.with_items', WORKFLOW_INPUT)
self._await(
lambda: self.is_execution_success(exec_db.id),
)
# Note: We need to reread execution to access related tasks.
exec_db = db_api.get_execution(exec_db.id)
tasks = exec_db.tasks
task1 = self._assert_single_item(tasks, name='task1')
with_items_context = task1.runtime_context['with_items']
self.assertEqual(3, with_items_context['count'])
self.assertEqual(3, with_items_context['index'])
# Since we know that we can receive results in random order,
# check is not depend on order of items.
result = task1.result['result']
self.assertTrue(isinstance(result, list))
self.assertIn('John', result)
self.assertIn('Ivan', result)
self.assertIn('Mistral', result)
self.assertEqual(1, len(tasks))
self.assertEqual(states.SUCCESS, task1.state)
def test_with_items_static_var(self):
wb_service.create_workbook_v2(WORKBOOK_WITH_STATIC_VAR)
wf_input = copy.copy(WORKFLOW_INPUT)
wf_input.update({'greeting': 'Hello'})
# Start workflow.
exec_db = self.engine.start_workflow('wb1.with_items', wf_input)
self._await(
lambda: self.is_execution_success(exec_db.id),
)
# Note: We need to reread execution to access related tasks.
exec_db = db_api.get_execution(exec_db.id)
tasks = exec_db.tasks
task1 = self._assert_single_item(tasks, name='task1')
result = task1.result['result']
self.assertTrue(isinstance(result, list))
self.assertIn('Hello, John!', result)
self.assertIn('Hello, Ivan!', result)
self.assertIn('Hello, Mistral!', result)
self.assertEqual(1, len(tasks))
self.assertEqual(states.SUCCESS, task1.state)
def test_with_items_multi_array(self):
wb_service.create_workbook_v2(WORKBOOK_MULTI_ARRAY)
wf_input = {'arrayI': ['a', 'b', 'c'], 'arrayJ': [1, 2, 3]}
# Start workflow.
exec_db = self.engine.start_workflow('wb1.with_items', wf_input)
self._await(
lambda: self.is_execution_success(exec_db.id),
)
# Note: We need to reread execution to access related tasks.
exec_db = db_api.get_execution(exec_db.id)
tasks = exec_db.tasks
task1 = self._assert_single_item(tasks, name='task1')
# Since we know that we can receive results in random order,
# check is not depend on order of items.
result = task1.result['result']
self.assertTrue(isinstance(result, list))
self.assertIn('a 1', result)
self.assertIn('b 2', result)
self.assertIn('c 3', result)
self.assertEqual(1, len(tasks))
self.assertEqual(states.SUCCESS, task1.state)
def test_with_items_action_context(self):
wb_service.create_workbook_v2(WORKBOOK_ACTION_CONTEXT)
# Start workflow.
exec_db = self.engine.start_workflow(
'wb1.wf1_with_items', WF_INPUT_URLS
)
exec_db = db_api.get_execution(exec_db.id)
task_db = exec_db.tasks[0]
self.engine.on_task_result(task_db.id, wf_utils.TaskResult("Ivan"))
self.engine.on_task_result(task_db.id, wf_utils.TaskResult("John"))
self.engine.on_task_result(task_db.id, wf_utils.TaskResult("Mistral"))
self._await(
lambda: self.is_execution_success(exec_db.id),
)
# Note: We need to reread execution to access related tasks.
exec_db = db_api.get_execution(exec_db.id)
task_db = db_api.get_task(task_db.id)
result = task_db.result['result']
self.assertTrue(isinstance(result, list))
self.assertIn('John', result)
self.assertIn('Ivan', result)
self.assertIn('Mistral', result)
self.assertEqual(states.SUCCESS, task_db.state)