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

mh CmdMixin - added ArgFormat.BOOLEAN_NOT and logic (#3290)

Browse source 
* mh CmdMixin - added ArgFormat.BOOLEAN_NOT and logic

* added changelog fragment
This commit is contained in:
Alexei Znamensky 2021-08-29 23:03:15 +12:00 committed by GitHub
parent cf43356753
commit df8fdcda79
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/3290-mh-cmd-boolean-not.yaml Normal file
View file

@ -0,0 +1,2 @@
minor_changes:
- module_helper cmd module utils - added the ``ArgFormat`` style ``BOOLEAN_NOT``, to add CLI parameters when the module argument is false-ish (https://github.com/ansible-collections/community.general/pull/3290).

5
plugins/module_utils/mh/mixins/cmd.py
View file

@ -16,6 +16,7 @@ class ArgFormat(object):
BOOLEAN = 0 BOOLEAN = 0
PRINTF = 1 PRINTF = 1
FORMAT = 2 FORMAT = 2
BOOLEAN_NOT = 3
@staticmethod @staticmethod
def stars_deco(num): def stars_deco(num):
@ -50,12 +51,14 @@ class ArgFormat(object):
_fmts = { _fmts = {
ArgFormat.BOOLEAN: lambda _fmt, v: ([_fmt] if bool(v) else []), ArgFormat.BOOLEAN: lambda _fmt, v: ([_fmt] if bool(v) else []),
ArgFormat.BOOLEAN_NOT: lambda _fmt, v: ([] if bool(v) else [_fmt]),
ArgFormat.PRINTF: printf_fmt, ArgFormat.PRINTF: printf_fmt,
ArgFormat.FORMAT: lambda _fmt, v: [_fmt.format(v)], ArgFormat.FORMAT: lambda _fmt, v: [_fmt.format(v)],
} }
self.name = name self.name = name
self.stars = stars self.stars = stars
self.style = style
if fmt is None: if fmt is None:
fmt = "{0}" fmt = "{0}"
@ -76,7 +79,7 @@ class ArgFormat(object):
self.arg_format = (self.stars_deco(stars))(self.arg_format) self.arg_format = (self.stars_deco(stars))(self.arg_format)
def to_text(self, value): def to_text(self, value):
if value is None: if value is None and self.style != ArgFormat.BOOLEAN_NOT:
return [] return []
func = self.arg_format func = self.arg_format
return [str(p) for p in func(value)] return [str(p) for p in func(value)]

10
tests/unit/plugins/module_utils/test_module_helper.py
View file

@ -24,6 +24,12 @@ ARG_FORMATS = dict(
False, []), False, []),
simple_boolean_none=("--superflag", ArgFormat.BOOLEAN, 0, simple_boolean_none=("--superflag", ArgFormat.BOOLEAN, 0,
None, []), None, []),
simple_boolean_not_true=("--superflag", ArgFormat.BOOLEAN_NOT, 0,
True, []),
simple_boolean_not_false=("--superflag", ArgFormat.BOOLEAN_NOT, 0,
False, ["--superflag"]),
simple_boolean_not_none=("--superflag", ArgFormat.BOOLEAN_NOT, 0,
None, ["--superflag"]),
single_printf=("--param=%s", ArgFormat.PRINTF, 0, single_printf=("--param=%s", ArgFormat.PRINTF, 0,
"potatoes", ["--param=potatoes"]), "potatoes", ["--param=potatoes"]),
single_printf_no_substitution=("--param", ArgFormat.PRINTF, 0, single_printf_no_substitution=("--param", ArgFormat.PRINTF, 0,
@ -65,7 +71,7 @@ def test_arg_format(fmt, style, stars, value, expected):
af = ArgFormat('name', fmt, style, stars) af = ArgFormat('name', fmt, style, stars)
actual = af.to_text(value) actual = af.to_text(value)
print("formatted string = {0}".format(actual)) print("formatted string = {0}".format(actual))
assert actual == expected assert actual == expected, "actual = {0}".format(actual)
ARG_FORMATS_FAIL = dict( ARG_FORMATS_FAIL = dict(
@ -218,7 +224,7 @@ CAUSE_CHG_DECO_IDS = sorted(CAUSE_CHG_DECO.keys())
@pytest.mark.parametrize(CAUSE_CHG_DECO_PARAMS, @pytest.mark.parametrize(CAUSE_CHG_DECO_PARAMS,
[[CAUSE_CHG_DECO[tc][param] [[CAUSE_CHG_DECO[tc][param]
for param in CAUSE_CHG_DECO_PARAMS] for param in CAUSE_CHG_DECO_PARAMS]
for tc in CAUSE_CHG_DECO_IDS], for tc in CAUSE_CHG_DECO_IDS],
ids=CAUSE_CHG_DECO_IDS) ids=CAUSE_CHG_DECO_IDS)
def test_cause_changes_deco(method, expect_exception, expect_changed): def test_cause_changes_deco(method, expect_exception, expect_changed):