1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

moved to exceptions for basic skip/fails

better handling of checkmode and async
fix test to follow new flow control
This commit is contained in:
Brian Coca 2017-04-21 16:17:12 -04:00 committed by Brian Coca
parent a3a970180a
commit e29dc49a49
12 changed files with 30 additions and 43 deletions

View file

@ -204,3 +204,10 @@ class AnsibleUndefinedVariable(AnsibleRuntimeError):
class AnsibleFileNotFound(AnsibleRuntimeError): class AnsibleFileNotFound(AnsibleRuntimeError):
''' a file missing failure ''' ''' a file missing failure '''
pass pass
class AnsibleActionSkip(AnsibleRuntimeError):
''' an action runtime skip'''
pass
class AnsibleActionFail(AnsibleRuntimeError):
''' an action runtime failure'''
pass

View file

@ -25,7 +25,7 @@ import time
import traceback import traceback
from ansible import constants as C from ansible import constants as C
from ansible.errors import AnsibleError, AnsibleParserError, AnsibleUndefinedVariable, AnsibleConnectionFailure from ansible.errors import AnsibleError, AnsibleParserError, AnsibleUndefinedVariable, AnsibleConnectionFailure, AnsibleActionFail, AnsibleActionSkip
from ansible.executor.task_result import TaskResult from ansible.executor.task_result import TaskResult
from ansible.module_utils.six import iteritems, string_types, binary_type from ansible.module_utils.six import iteritems, string_types, binary_type
from ansible.module_utils._text import to_text from ansible.module_utils._text import to_text
@ -526,6 +526,10 @@ class TaskExecutor:
display.debug("running the handler") display.debug("running the handler")
try: try:
result = self._handler.run(task_vars=variables) result = self._handler.run(task_vars=variables)
except AnsibleActionSkip as e:
return dict(skipped=True, msg=to_text(e))
except AnsibleActionFail as e:
return dict(failed=True, msg=to_text(e))
except AnsibleConnectionFailure as e: except AnsibleConnectionFailure as e:
return dict(unreachable=True, msg=to_text(e)) return dict(unreachable=True, msg=to_text(e))
display.debug("handler run complete") display.debug("handler run complete")

View file

@ -30,7 +30,7 @@ import time
from abc import ABCMeta, abstractmethod from abc import ABCMeta, abstractmethod
from ansible import constants as C from ansible import constants as C
from ansible.errors import AnsibleError, AnsibleConnectionFailure from ansible.errors import AnsibleError, AnsibleConnectionFailure, AnsibleActionSkip, AnsibleActionFail
from ansible.executor.module_common import modify_module, build_windows_module_payload from ansible.executor.module_common import modify_module, build_windows_module_payload
from ansible.module_utils.json_utils import _filter_non_json_lines from ansible.module_utils.json_utils import _filter_non_json_lines
from ansible.module_utils.six import binary_type, string_types, text_type, iteritems, with_metaclass from ansible.module_utils.six import binary_type, string_types, text_type, iteritems, with_metaclass
@ -93,14 +93,11 @@ class ActionBase(with_metaclass(ABCMeta, object)):
result = {} result = {}
if self._task.async and not self._supports_async: if self._task.async and not self._supports_async:
result['msg'] = 'async is not supported for this task.' raise AnsibleActionFail('async is not supported for this task.')
result['failed'] = True
elif self._play_context.check_mode and not self._supports_check_mode: elif self._play_context.check_mode and not self._supports_check_mode:
result['msg'] = 'check mode is not supported for this task.' raise AnsibleActionSkip('check mode is not supported for this task.')
result['skipped'] = True
elif self._task.async and self._play_context.check_mode: elif self._task.async and self._play_context.check_mode:
result['msg'] = 'check mode and async cannot be used on same task.' raise AnsibleActionFail('check mode and async cannot be used on same task.')
result['failed'] = True
return result return result

View file

@ -45,9 +45,6 @@ class ActionModule(ActionBase):
result = super(ActionModule, self).run(tmp, task_vars) result = super(ActionModule, self).run(tmp, task_vars)
if result.get('skipped', False) or result.get('failed', False):
return result
# Parse out any hostname:port patterns # Parse out any hostname:port patterns
new_name = self._task.args.get('name', self._task.args.get('hostname', None)) new_name = self._task.args.get('name', self._task.args.get('hostname', None))
display.vv("creating host via 'add_host': hostname=%s" % new_name) display.vv("creating host via 'add_host': hostname=%s" % new_name)

View file

@ -84,9 +84,6 @@ class ActionModule(ActionBase):
result = super(ActionModule, self).run(tmp, task_vars) result = super(ActionModule, self).run(tmp, task_vars)
if result.get('skipped', False) or result.get('failed', False):
return result
if task_vars is None: if task_vars is None:
task_vars = dict() task_vars = dict()

View file

@ -40,9 +40,6 @@ class ActionModule(ActionBase):
result = super(ActionModule, self).run(tmp, task_vars) result = super(ActionModule, self).run(tmp, task_vars)
if result.get('skipped', False) or result.get('failed', False):
return result
source = self._task.args.get('src', None) source = self._task.args.get('src', None)
content = self._task.args.get('content', None) content = self._task.args.get('content', None)
dest = self._task.args.get('dest', None) dest = self._task.args.get('dest', None)

View file

@ -38,9 +38,6 @@ class ActionModule(ActionBase):
result = super(ActionModule, self).run(tmp, task_vars) result = super(ActionModule, self).run(tmp, task_vars)
if result.get('skipped', False) or result.get('failed', False):
return result
module = self._task.args.get('use', 'auto') module = self._task.args.get('use', 'auto')
if module == 'auto': if module == 'auto':

View file

@ -34,9 +34,6 @@ class ActionModule(ActionBase):
result = super(ActionModule, self).run(tmp, task_vars) result = super(ActionModule, self).run(tmp, task_vars)
if result.get('skipped', False) or result.get('failed', False):
return result
if not tmp: if not tmp:
tmp = self._make_tmp_path() tmp = self._make_tmp_path()

View file

@ -37,9 +37,6 @@ class ActionModule(ActionBase):
result = super(ActionModule, self).run(tmp, task_vars) result = super(ActionModule, self).run(tmp, task_vars)
if result.get('skipped', False) or result.get('failed', False):
return result
module = self._task.args.get('use', 'auto').lower() module = self._task.args.get('use', 'auto').lower()
if module == 'auto': if module == 'auto':

View file

@ -36,7 +36,7 @@
- name: Make sure the we used the local facts.py, not the one shipped with ansible - name: Make sure the we used the local facts.py, not the one shipped with ansible
assert: assert:
that: that:
- 'result["data"] == "overridden facts.py"' - result["data"] == "overridden facts.py"
- name: Test that importing a module that only exists inside of a submodule does not work - name: Test that importing a module that only exists inside of a submodule does not work
test_failure: test_failure:
@ -47,5 +47,5 @@
- name: Make sure we failed in AnsiBallZ - name: Make sure we failed in AnsiBallZ
assert: assert:
that: that:
- 'result["failed"] == True' - result|failed
- '"Could not find imported module support code for test_failure. Looked for either foo.py or zebra.py" == result["msg"]' - result['msg'] == "Could not find imported module support code for test_failure. Looked for either foo.py or zebra.py"

View file

@ -81,5 +81,5 @@
- name: assert task with async param failed - name: assert task with async param failed
assert: assert:
that: that:
- 'script_result3.failed' - script_result3|failed
- 'script_result3.msg == "async is not supported for this task."' - script_result3.msg == "async is not supported for this task."

View file

@ -18,7 +18,7 @@
from __future__ import (absolute_import, division, print_function) from __future__ import (absolute_import, division, print_function)
__metaclass__ = type __metaclass__ = type
from ansible.errors import AnsibleActionFail
from ansible.compat.tests import unittest from ansible.compat.tests import unittest
from ansible.compat.tests.mock import patch, MagicMock, Mock from ansible.compat.tests.mock import patch, MagicMock, Mock
from ansible.plugins.action.raw import ActionModule from ansible.plugins.action.raw import ActionModule
@ -43,7 +43,7 @@ class TestCopyResultExclude(unittest.TestCase):
play_context = Mock() play_context = Mock()
task = MagicMock(Task) task = MagicMock(Task)
task.async = MagicMock() task.async = False
connection = Mock() connection = Mock()
task.args = {'_raw_params': 'Args1'} task.args = {'_raw_params': 'Args1'}
@ -60,25 +60,22 @@ class TestCopyResultExclude(unittest.TestCase):
play_context = Mock() play_context = Mock()
task = MagicMock(Task) task = MagicMock(Task)
task.async = MagicMock() task.async = False
connection = Mock() connection = Mock()
task.args = {'_raw_params': 'Args1'} task.args = {'_raw_params': 'Args1'}
play_context.check_mode = True play_context.check_mode = True
try:
self.mock_am = ActionModule(task, connection, play_context, loader=None, templar=None, shared_loader_obj=None) self.mock_am = ActionModule(task, connection, play_context, loader=None, templar=None, shared_loader_obj=None)
self.mock_am._low_level_execute_command = Mock(return_value = {}) except AnsibleActionFail:
self.mock_am.display = Mock() pass
skipped_result = self.mock_am.run()
self.assertEqual(skipped_result.get('skipped'), True)
def test_raw_test_environment_is_None(self): def test_raw_test_environment_is_None(self):
play_context = Mock() play_context = Mock()
task = MagicMock(Task) task = MagicMock(Task)
task.async = MagicMock() task.async = False
connection = Mock() connection = Mock()
task.args = {'_raw_params': 'Args1'} task.args = {'_raw_params': 'Args1'}
@ -95,7 +92,7 @@ class TestCopyResultExclude(unittest.TestCase):
play_context = Mock() play_context = Mock()
task = MagicMock(Task) task = MagicMock(Task)
task.async = MagicMock() task.async = False
connection = Mock() connection = Mock()
task.args = {'_raw_params': 'Args1'} task.args = {'_raw_params': 'Args1'}