453 lines
16 KiB
Python
453 lines
16 KiB
Python
# Copyright 2015 - StackStorm, Inc.
|
|
# Copyright 2016 - Brocade Communications Systems, 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 yaml
|
|
|
|
from mistral import exceptions as exc
|
|
from mistral.tests.unit.lang.v2 import base
|
|
from mistral import utils
|
|
|
|
|
|
class WorkflowSpecValidation(base.WorkflowSpecValidationTestCase):
|
|
def test_workflow_types(self):
|
|
tests = [
|
|
({'type': 'direct'}, False),
|
|
({'type': 'reverse'}, False),
|
|
({'type': 'circular'}, True),
|
|
({'type': None}, True)
|
|
]
|
|
|
|
for wf_type, expect_error in tests:
|
|
overlay = {'test': wf_type}
|
|
|
|
self._parse_dsl_spec(
|
|
add_tasks=True,
|
|
changes=overlay,
|
|
expect_error=expect_error
|
|
)
|
|
|
|
def test_direct_workflow(self):
|
|
overlay = {'test': {'type': 'direct', 'tasks': {}}}
|
|
join = {'join': 'all'}
|
|
on_success = {'on-success': ['email']}
|
|
|
|
utils.merge_dicts(overlay['test']['tasks'], {'get': on_success})
|
|
utils.merge_dicts(overlay['test']['tasks'], {'echo': on_success})
|
|
utils.merge_dicts(overlay['test']['tasks'], {'email': join})
|
|
|
|
wfs_spec = self._parse_dsl_spec(
|
|
add_tasks=True,
|
|
changes=overlay,
|
|
expect_error=False
|
|
)
|
|
|
|
self.assertEqual(1, len(wfs_spec.get_workflows()))
|
|
self.assertEqual('test', wfs_spec.get_workflows()[0].get_name())
|
|
self.assertEqual('direct', wfs_spec.get_workflows()[0].get_type())
|
|
|
|
def test_direct_workflow_invalid_task(self):
|
|
overlay = {
|
|
'test': {
|
|
'type': 'direct',
|
|
'tasks': {}
|
|
}
|
|
}
|
|
requires = {'requires': ['echo', 'get']}
|
|
|
|
utils.merge_dicts(overlay['test']['tasks'], {'email': requires})
|
|
|
|
self._parse_dsl_spec(
|
|
add_tasks=True,
|
|
changes=overlay,
|
|
expect_error=True
|
|
)
|
|
|
|
def test_direct_workflow_no_start_tasks(self):
|
|
overlay = {
|
|
'test': {
|
|
'type': 'direct',
|
|
'tasks': {
|
|
'task1': {'on-complete': 'task2'},
|
|
'task2': {'on-complete': 'task1'}
|
|
}
|
|
}
|
|
}
|
|
|
|
self._parse_dsl_spec(
|
|
add_tasks=False,
|
|
changes=overlay,
|
|
expect_error=True
|
|
)
|
|
|
|
def test_direct_workflow_invalid_join(self):
|
|
tests = [
|
|
({'task3': {'join': 2}}, False),
|
|
({'task3': {'join': 5}}, True),
|
|
({'task3': {'join': 1}}, False),
|
|
({'task3': {'join': 'one'}}, False),
|
|
({'task3': {'join': 'all'}}, False),
|
|
({'task4': {'join': 'all'}}, True),
|
|
({'task4': {'join': 1}}, True),
|
|
({'task4': {'join': 'one'}}, True)
|
|
]
|
|
|
|
for test in tests:
|
|
overlay = {
|
|
'test': {
|
|
'type': 'direct',
|
|
'tasks': {
|
|
'task1': {'on-complete': 'task3'},
|
|
'task2': {'on-complete': 'task3'}
|
|
}
|
|
}
|
|
}
|
|
|
|
utils.merge_dicts(overlay['test']['tasks'], test[0])
|
|
|
|
self._parse_dsl_spec(
|
|
add_tasks=False,
|
|
changes=overlay,
|
|
expect_error=test[1]
|
|
)
|
|
|
|
def test_reverse_workflow(self):
|
|
overlay = {'test': {'type': 'reverse', 'tasks': {}}}
|
|
require = {'requires': ['echo', 'get']}
|
|
|
|
utils.merge_dicts(overlay['test']['tasks'], {'email': require})
|
|
|
|
wfs_spec = self._parse_dsl_spec(
|
|
add_tasks=True,
|
|
changes=overlay,
|
|
expect_error=False
|
|
)
|
|
|
|
self.assertEqual(1, len(wfs_spec.get_workflows()))
|
|
self.assertEqual('test', wfs_spec.get_workflows()[0].get_name())
|
|
self.assertEqual('reverse', wfs_spec.get_workflows()[0].get_type())
|
|
|
|
def test_reverse_workflow_invalid_task(self):
|
|
overlay = {'test': {'type': 'reverse', 'tasks': {}}}
|
|
join = {'join': 'all'}
|
|
on_success = {'on-success': ['email']}
|
|
|
|
utils.merge_dicts(overlay['test']['tasks'], {'get': on_success})
|
|
utils.merge_dicts(overlay['test']['tasks'], {'echo': on_success})
|
|
utils.merge_dicts(overlay['test']['tasks'], {'email': join})
|
|
|
|
self._parse_dsl_spec(
|
|
add_tasks=True,
|
|
changes=overlay,
|
|
expect_error=True
|
|
)
|
|
|
|
def test_version_required(self):
|
|
dsl_dict = copy.deepcopy(self._dsl_blank)
|
|
dsl_dict.pop('version', None)
|
|
|
|
exception = self.assertRaises(
|
|
exc.DSLParsingException,
|
|
self._spec_parser,
|
|
yaml.safe_dump(dsl_dict)
|
|
)
|
|
|
|
self.assertIn("'version' is a required property", str(exception))
|
|
|
|
def test_version(self):
|
|
tests = [
|
|
({'version': None}, True),
|
|
({'version': ''}, True),
|
|
({'version': '2.0'}, False),
|
|
({'version': 2.0}, False),
|
|
({'version': 2}, False)
|
|
]
|
|
|
|
for version, expect_error in tests:
|
|
self._parse_dsl_spec(
|
|
add_tasks=True,
|
|
changes=version,
|
|
expect_error=expect_error
|
|
)
|
|
|
|
def test_inputs(self):
|
|
tests = [
|
|
({'input': ['var1', 'var2']}, False),
|
|
({'input': ['var1', 'var1']}, True),
|
|
({'input': [12345]}, True),
|
|
({'input': [None]}, True),
|
|
({'input': ['']}, True),
|
|
({'input': None}, True),
|
|
({'input': []}, True),
|
|
({'input': ['var1', {'var2': 2}]}, False),
|
|
({'input': [{'var1': 1}, {'var2': 2}]}, False),
|
|
({'input': [{'var1': None}]}, False),
|
|
({'input': [{'var1': 1}, {'var1': 1}]}, True),
|
|
({'input': [{'var1': 1, 'var2': 2}]}, True)
|
|
]
|
|
|
|
for wf_input, expect_error in tests:
|
|
overlay = {'test': wf_input}
|
|
|
|
self._parse_dsl_spec(
|
|
add_tasks=True,
|
|
changes=overlay,
|
|
expect_error=expect_error
|
|
)
|
|
|
|
def test_outputs(self):
|
|
tests = [
|
|
({'output': {'k1': 'a', 'k2': 1, 'k3': True, 'k4': None}}, False),
|
|
({'output': {'k1': '<% $.v1 %>'}}, False),
|
|
({'output': {'k1': '<% 1 + 2 %>'}}, False),
|
|
({'output': {'k1': '<% * %>'}}, True),
|
|
({'output': []}, True),
|
|
({'output': 'whatever'}, True),
|
|
({'output': None}, True),
|
|
({'output': {}}, True)
|
|
]
|
|
|
|
for wf_output, expect_error in tests:
|
|
overlay = {'test': wf_output}
|
|
|
|
self._parse_dsl_spec(
|
|
add_tasks=True,
|
|
changes=overlay,
|
|
expect_error=expect_error
|
|
)
|
|
|
|
def test_vars(self):
|
|
tests = [
|
|
({'vars': {'v1': 'a', 'v2': 1, 'v3': True, 'v4': None}}, False),
|
|
({'vars': {'v1': '<% $.input_var1 %>'}}, False),
|
|
({'vars': {'v1': '<% 1 + 2 %>'}}, False),
|
|
({'vars': {'v1': '<% * %>'}}, True),
|
|
({'vars': {'v1': '{{ _.input_var1 }}'}}, False),
|
|
({'vars': {'v1': '{{ 1 + 2 }}'}}, False),
|
|
({'vars': {'v1': '{{ * }}'}}, True),
|
|
({'vars': []}, True),
|
|
({'vars': 'whatever'}, True),
|
|
({'vars': None}, True),
|
|
({'vars': {}}, True)
|
|
]
|
|
|
|
for wf_vars, expect_error in tests:
|
|
overlay = {'test': wf_vars}
|
|
|
|
self._parse_dsl_spec(
|
|
add_tasks=True,
|
|
changes=overlay,
|
|
expect_error=expect_error
|
|
)
|
|
|
|
def test_tasks_required(self):
|
|
exception = self._parse_dsl_spec(
|
|
add_tasks=False,
|
|
expect_error=True
|
|
)
|
|
|
|
self.assertIn("'tasks' is a required property", str(exception))
|
|
|
|
def test_tasks(self):
|
|
tests = [
|
|
({'tasks': {}}, True),
|
|
({'tasks': None}, True),
|
|
({'tasks': self._dsl_tasks}, False)
|
|
]
|
|
|
|
for wf_tasks, expect_error in tests:
|
|
overlay = {'test': wf_tasks}
|
|
|
|
self._parse_dsl_spec(
|
|
add_tasks=False,
|
|
changes=overlay,
|
|
expect_error=expect_error
|
|
)
|
|
|
|
def test_task_defaults(self):
|
|
tests = [
|
|
({'on-success': ['email']}, False),
|
|
({'on-success': [{'email': '<% 1 %>'}]}, False),
|
|
({'on-success': [{'email': '<% 1 %>'}, 'echo']}, False),
|
|
({'on-success': [{'email': '<% $.v1 in $.v2 %>'}]}, False),
|
|
({'on-success': [{'email': '<% * %>'}]}, True),
|
|
({'on-success': [{'email': '{{ 1 }}'}]}, False),
|
|
({'on-success': [{'email': '{{ 1 }}'}, 'echo']}, False),
|
|
({'on-success': [{'email': '{{ _.v1 in _.v2 }}'}]}, False),
|
|
({'on-success': [{'email': '{{ * }}'}]}, True),
|
|
({'on-success': 'email'}, False),
|
|
({'on-success': None}, True),
|
|
({'on-success': ['']}, True),
|
|
({'on-success': []}, True),
|
|
({'on-success': ['email', 'email']}, True),
|
|
({'on-success': ['email', 12345]}, True),
|
|
({'on-error': ['email']}, False),
|
|
({'on-error': [{'email': '<% 1 %>'}]}, False),
|
|
({'on-error': [{'email': '<% 1 %>'}, 'echo']}, False),
|
|
({'on-error': [{'email': '<% $.v1 in $.v2 %>'}]}, False),
|
|
({'on-error': [{'email': '<% * %>'}]}, True),
|
|
({'on-error': [{'email': '{{ 1 }}'}]}, False),
|
|
({'on-error': [{'email': '{{ 1 }}'}, 'echo']}, False),
|
|
({'on-error': [{'email': '{{ _.v1 in _.v2 }}'}]}, False),
|
|
({'on-error': [{'email': '{{ * }}'}]}, True),
|
|
({'on-error': 'email'}, False),
|
|
({'on-error': None}, True),
|
|
({'on-error': ['']}, True),
|
|
({'on-error': []}, True),
|
|
({'on-error': ['email', 'email']}, True),
|
|
({'on-error': ['email', 12345]}, True),
|
|
({'on-complete': ['email']}, False),
|
|
({'on-complete': [{'email': '<% 1 %>'}]}, False),
|
|
({'on-complete': [{'email': '<% 1 %>'}, 'echo']}, False),
|
|
({'on-complete': [{'email': '<% $.v1 in $.v2 %>'}]}, False),
|
|
({'on-complete': [{'email': '<% * %>'}]}, True),
|
|
({'on-complete': [{'email': '{{ 1 }}'}]}, False),
|
|
({'on-complete': [{'email': '{{ 1 }}'}, 'echo']}, False),
|
|
({'on-complete': [{'email': '{{ _.v1 in _.v2 }}'}]}, False),
|
|
({'on-complete': [{'email': '{{ * }}'}]}, True),
|
|
({'on-complete': 'email'}, False),
|
|
({'on-complete': None}, True),
|
|
({'on-complete': ['']}, True),
|
|
({'on-complete': []}, True),
|
|
({'on-complete': ['email', 'email']}, True),
|
|
({'on-complete': ['email', 12345]}, True),
|
|
({'requires': ''}, True),
|
|
({'requires': []}, True),
|
|
({'requires': ['']}, True),
|
|
({'requires': None}, True),
|
|
({'requires': 12345}, True),
|
|
({'requires': ['echo']}, False),
|
|
({'requires': ['echo', 'get']}, False),
|
|
({'requires': 'echo'}, False),
|
|
({'retry': {'count': 3, 'delay': 1}}, False),
|
|
({'retry': {'count': '<% 3 %>', 'delay': 1}}, False),
|
|
({'retry': {'count': '<% * %>', 'delay': 1}}, True),
|
|
({'retry': {'count': 3, 'delay': '<% 1 %>'}}, False),
|
|
({'retry': {'count': 3, 'delay': '<% * %>'}}, True),
|
|
({'retry': {'count': '{{ 3 }}', 'delay': 1}}, False),
|
|
({'retry': {'count': '{{ * }}', 'delay': 1}}, True),
|
|
({'retry': {'count': 3, 'delay': '{{ 1 }}'}}, False),
|
|
({'retry': {'count': 3, 'delay': '{{ * }}'}}, True),
|
|
({'retry': {'count': -3, 'delay': 1}}, True),
|
|
({'retry': {'count': 3, 'delay': -1}}, True),
|
|
({'retry': {'count': '3', 'delay': 1}}, True),
|
|
({'retry': {'count': 3, 'delay': '1'}}, True),
|
|
({'retry': None}, True),
|
|
({'wait-before': 1}, False),
|
|
({'wait-before': '<% 1 %>'}, False),
|
|
({'wait-before': '<% * %>'}, True),
|
|
({'wait-before': '{{ 1 }}'}, False),
|
|
({'wait-before': '{{ * }}'}, True),
|
|
({'wait-before': -1}, True),
|
|
({'wait-before': 1.0}, True),
|
|
({'wait-before': '1'}, True),
|
|
({'wait-after': 1}, False),
|
|
({'wait-after': '<% 1 %>'}, False),
|
|
({'wait-after': '<% * %>'}, True),
|
|
({'wait-after': '{{ 1 }}'}, False),
|
|
({'wait-after': '{{ * }}'}, True),
|
|
({'wait-after': -1}, True),
|
|
({'wait-after': 1.0}, True),
|
|
({'wait-after': '1'}, True),
|
|
({'timeout': 300}, False),
|
|
({'timeout': '<% 300 %>'}, False),
|
|
({'timeout': '<% * %>'}, True),
|
|
({'timeout': '{{ 300 }}'}, False),
|
|
({'timeout': '{{ * }}'}, True),
|
|
({'timeout': -300}, True),
|
|
({'timeout': 300.0}, True),
|
|
({'timeout': '300'}, True),
|
|
({'pause-before': False}, False),
|
|
({'pause-before': '<% False %>'}, False),
|
|
({'pause-before': '<% * %>'}, True),
|
|
({'pause-before': '{{ False }}'}, False),
|
|
({'pause-before': '{{ * }}'}, True),
|
|
({'pause-before': 'False'}, True),
|
|
({'concurrency': 10}, False),
|
|
({'concurrency': '<% 10 %>'}, False),
|
|
({'concurrency': '<% * %>'}, True),
|
|
({'concurrency': '{{ 10 }}'}, False),
|
|
({'concurrency': '{{ * }}'}, True),
|
|
({'concurrency': -10}, True),
|
|
({'concurrency': 10.0}, True),
|
|
({'concurrency': '10'}, True),
|
|
({'safe-rerun': True}, False),
|
|
({'safe-rerun': False}, False),
|
|
({'safe-rerun': '<% false %>'}, False),
|
|
({'safe-rerun': '<% true %>'}, False),
|
|
({'safe-rerun': '<% * %>'}, True),
|
|
({'safe-rerun': None}, True)
|
|
]
|
|
|
|
for default, expect_error in tests:
|
|
overlay = {'test': {'task-defaults': {}}}
|
|
|
|
utils.merge_dicts(overlay['test']['task-defaults'], default)
|
|
|
|
self._parse_dsl_spec(
|
|
add_tasks=True,
|
|
changes=overlay,
|
|
expect_error=expect_error
|
|
)
|
|
|
|
def test_invalid_item(self):
|
|
overlay = {'name': 'invalid'}
|
|
|
|
exception = self._parse_dsl_spec(changes=overlay, expect_error=True)
|
|
|
|
self.assertIn("Invalid DSL", str(exception))
|
|
|
|
def test_invalid_name(self):
|
|
invalid_wf = {
|
|
'version': '2.0',
|
|
'b98180ba-48a0-4e26-ab2e-50dc224f6fd1': {
|
|
'type': 'direct',
|
|
'tasks': {'t1': {'action': 'std.noop'}}
|
|
}
|
|
}
|
|
|
|
dsl_yaml = yaml.safe_dump(invalid_wf, default_flow_style=False)
|
|
|
|
exception = self.assertRaises(
|
|
exc.InvalidModelException,
|
|
self._spec_parser,
|
|
dsl_yaml
|
|
)
|
|
|
|
self.assertIn(
|
|
"Workflow name cannot be in the format of UUID",
|
|
str(exception)
|
|
)
|
|
|
|
def test_tags(self):
|
|
tests = [
|
|
({'tags': ''}, True),
|
|
({'tags': []}, True),
|
|
({'tags': ['']}, True),
|
|
({'tags': ['tag']}, False),
|
|
({'tags': ['tag', 'tag']}, True),
|
|
({'tags': None}, True)
|
|
]
|
|
|
|
for wf_tags, expect_error in tests:
|
|
overlay = {'test': wf_tags}
|
|
|
|
self._parse_dsl_spec(
|
|
add_tasks=True,
|
|
changes=overlay,
|
|
expect_error=expect_error
|
|
)
|