mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
[PR #2203/0cd0f0ea backport][stable-1] module_helper - fixed decorator cause_changes (#2209)
* module_helper - fixed decorator cause_changes (#2203)
* fixed decorator cause_changes
* added changelog fragment
* typo
(cherry picked from commit 0cd0f0eaf6
)
* adjusted imports for stable-1
This commit is contained in:
parent
4b54805693
commit
7481436027
3 changed files with 66 additions and 13 deletions
|
@ -0,0 +1,2 @@
|
|||
bugfixes:
|
||||
- module_helper module utils - fixed decorator ``cause_changes`` (https://github.com/ansible-collections/community.general/pull/2203).
|
|
@ -81,18 +81,27 @@ class ArgFormat(object):
|
|||
return [str(p) for p in func(value)]
|
||||
|
||||
|
||||
def cause_changes(func, on_success=True, on_failure=False):
|
||||
@wraps(func)
|
||||
def wrapper(self, *args, **kwargs):
|
||||
try:
|
||||
func(*args, **kwargs)
|
||||
if on_success:
|
||||
self.changed = True
|
||||
except Exception as e:
|
||||
if on_failure:
|
||||
self.changed = True
|
||||
raise
|
||||
return wrapper
|
||||
def cause_changes(on_success=None, on_failure=None):
|
||||
|
||||
def deco(func):
|
||||
if on_success is None and on_failure is None:
|
||||
return func
|
||||
|
||||
@wraps(func)
|
||||
def wrapper(*args, **kwargs):
|
||||
try:
|
||||
self = args[0]
|
||||
func(*args, **kwargs)
|
||||
if on_success is not None:
|
||||
self.changed = on_success
|
||||
except Exception:
|
||||
if on_failure is not None:
|
||||
self.changed = on_failure
|
||||
raise
|
||||
|
||||
return wrapper
|
||||
|
||||
return deco
|
||||
|
||||
|
||||
def module_fails_on_exception(func):
|
||||
|
|
|
@ -9,7 +9,7 @@ __metaclass__ = type
|
|||
import pytest
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.module_helper import (
|
||||
ArgFormat, DependencyCtxMgr, ModuleHelper
|
||||
ArgFormat, DependencyCtxMgr, cause_changes
|
||||
)
|
||||
|
||||
|
||||
|
@ -82,3 +82,45 @@ def test_dependency_ctxmgr():
|
|||
with ctx:
|
||||
import sys
|
||||
assert ctx.has_it
|
||||
|
||||
|
||||
class MockMH(object):
|
||||
changed = None
|
||||
|
||||
def _div(self, x, y):
|
||||
return x / y
|
||||
|
||||
func_none = cause_changes()(_div)
|
||||
func_onsucc = cause_changes(on_success=True)(_div)
|
||||
func_onfail = cause_changes(on_failure=True)(_div)
|
||||
func_onboth = cause_changes(on_success=True, on_failure=True)(_div)
|
||||
|
||||
|
||||
CAUSE_CHG_DECO_PARAMS = ['method', 'expect_exception', 'expect_changed']
|
||||
CAUSE_CHG_DECO = dict(
|
||||
none_succ=dict(method='func_none', expect_exception=False, expect_changed=None),
|
||||
none_fail=dict(method='func_none', expect_exception=True, expect_changed=None),
|
||||
onsucc_succ=dict(method='func_onsucc', expect_exception=False, expect_changed=True),
|
||||
onsucc_fail=dict(method='func_onsucc', expect_exception=True, expect_changed=None),
|
||||
onfail_succ=dict(method='func_onfail', expect_exception=False, expect_changed=None),
|
||||
onfail_fail=dict(method='func_onfail', expect_exception=True, expect_changed=True),
|
||||
onboth_succ=dict(method='func_onboth', expect_exception=False, expect_changed=True),
|
||||
onboth_fail=dict(method='func_onboth', expect_exception=True, expect_changed=True),
|
||||
)
|
||||
CAUSE_CHG_DECO_IDS = sorted(CAUSE_CHG_DECO.keys())
|
||||
|
||||
|
||||
@pytest.mark.parametrize(CAUSE_CHG_DECO_PARAMS,
|
||||
[[CAUSE_CHG_DECO[tc][param]
|
||||
for param in CAUSE_CHG_DECO_PARAMS]
|
||||
for tc in CAUSE_CHG_DECO_IDS],
|
||||
ids=CAUSE_CHG_DECO_IDS)
|
||||
def test_cause_changes_deco(method, expect_exception, expect_changed):
|
||||
mh = MockMH()
|
||||
if expect_exception:
|
||||
with pytest.raises(Exception):
|
||||
getattr(mh, method)(1, 0)
|
||||
else:
|
||||
getattr(mh, method)(9, 3)
|
||||
|
||||
assert mh.changed == expect_changed
|
||||
|
|
Loading…
Reference in a new issue