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

puppet: fix noop parameter error (#6458)

Browse source 
* puppet: fix noop parameter error

* add changelog frag
This commit is contained in:
Alexei Znamensky 2023-05-04 08:45:01 +12:00 committed by GitHub
parent fab717bb2d
commit d254372d37
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 163 additions and 107 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/6458-puppet-noop.yml Normal file
View file

@ -0,0 +1,2 @@
bugfixes:
- puppet - handling ``noop`` parameter was not working at all, now it is has been fixed (https://github.com/ansible-collections/community.general/issues/6452, https://github.com/ansible-collections/community.general/issues/6458).

6
plugins/module_utils/puppet.py
View file

@ -63,11 +63,7 @@ def puppet_runner(module):
return cmd return cmd
def noop_func(v): def noop_func(v):
_noop = cmd_runner_fmt.as_map({ return ["--noop"] if module.check_mode or v else ["--no-noop"]
True: "--noop",
False: "--no-noop",
})
return _noop(module.check_mode or v)
_logdest_map = { _logdest_map = {
"syslog": ["--logdest", "syslog"], "syslog": ["--logdest", "syslog"],

262
tests/unit/plugins/modules/test_puppet.py
View file

@ -14,6 +14,7 @@ __metaclass__ = type
import json import json
from collections import namedtuple
from ansible_collections.community.general.plugins.modules import puppet from ansible_collections.community.general.plugins.modules import puppet
import pytest import pytest
@ -21,6 +22,10 @@ import pytest
TESTED_MODULE = puppet.__name__ TESTED_MODULE = puppet.__name__
ModuleTestCase = namedtuple("ModuleTestCase", ["id", "input", "output", "run_command_calls"])
RunCmdCall = namedtuple("RunCmdCall", ["command", "environ", "rc", "out", "err"])
@pytest.fixture @pytest.fixture
def patch_get_bin_path(mocker): def patch_get_bin_path(mocker):
""" """
@ -32,106 +37,156 @@ def patch_get_bin_path(mocker):
TEST_CASES = [ TEST_CASES = [
[ ModuleTestCase(
{}, id="puppet_agent_plain",
{ input={},
"id": "puppet_agent_plain", output=dict(changed=False),
"run_command.calls": [ run_command_calls=[
( RunCmdCall(
["/testbin/puppet", "config", "print", "agent_disabled_lockfile"], command=["/testbin/puppet", "config", "print", "agent_disabled_lockfile"],
{"environ_update": {"LANGUAGE": "C", "LC_ALL": "C"}, "check_rc": False}, environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
(0, "blah, anything", "",), # output rc, out, err rc=0,
), out="blah, anything",
( err="",
[ ),
"/testbin/timeout", "-s", "9", "30m", "/testbin/puppet", "agent", "--onetime", "--no-daemonize", RunCmdCall(
"--no-usecacheonfailure", "--no-splay", "--detailed-exitcodes", "--verbose", "--color", "0" command=[
], "/testbin/timeout", "-s", "9", "30m", "/testbin/puppet", "agent", "--onetime", "--no-daemonize",
{"environ_update": {"LANGUAGE": "C", "LC_ALL": "C"}, "check_rc": False}, "--no-usecacheonfailure", "--no-splay", "--detailed-exitcodes", "--verbose", "--color", "0"
(0, "", "",), # output rc, out, err ],
), environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
], rc=0,
"changed": False, out="",
} err="",
], ),
[ ]
{ ),
"certname": "potatobox" ModuleTestCase(
}, id="puppet_agent_certname",
{ input={"certname": "potatobox"},
"id": "puppet_agent_certname", output=dict(changed=False),
"run_command.calls": [ run_command_calls=[
( RunCmdCall(
["/testbin/puppet", "config", "print", "agent_disabled_lockfile"], command=["/testbin/puppet", "config", "print", "agent_disabled_lockfile"],
{"environ_update": {"LANGUAGE": "C", "LC_ALL": "C"}, "check_rc": False}, environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
(0, "blah, anything", "",), # output rc, out, err rc=0,
), out="blah, anything",
( err="",
[ ),
"/testbin/timeout", "-s", "9", "30m", "/testbin/puppet", "agent", "--onetime", "--no-daemonize", RunCmdCall(
"--no-usecacheonfailure", "--no-splay", "--detailed-exitcodes", "--verbose", "--color", "0", "--certname=potatobox" command=[
], "/testbin/timeout", "-s", "9", "30m", "/testbin/puppet", "agent", "--onetime", "--no-daemonize",
{"environ_update": {"LANGUAGE": "C", "LC_ALL": "C"}, "check_rc": False}, "--no-usecacheonfailure", "--no-splay", "--detailed-exitcodes", "--verbose", "--color", "0", "--certname=potatobox"
(0, "", "",), # output rc, out, err ],
), environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
], rc=0,
"changed": False, out="",
} err="",
], ),
[ ]
{ ),
"tags": ["a", "b", "c"] ModuleTestCase(
}, id="puppet_agent_tags_abc",
{ input={"tags": ["a", "b", "c"]},
"id": "puppet_agent_tags_abc", output=dict(changed=False),
"run_command.calls": [ run_command_calls=[
( RunCmdCall(
["/testbin/puppet", "config", "print", "agent_disabled_lockfile"], command=["/testbin/puppet", "config", "print", "agent_disabled_lockfile"],
{"environ_update": {"LANGUAGE": "C", "LC_ALL": "C"}, "check_rc": False}, environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
(0, "blah, anything", "",), # output rc, out, err rc=0,
), out="blah, anything",
( err="",
[ ),
"/testbin/timeout", "-s", "9", "30m", "/testbin/puppet", "agent", "--onetime", "--no-daemonize", RunCmdCall(
"--no-usecacheonfailure", "--no-splay", "--detailed-exitcodes", "--verbose", "--color", "0", "--tags", "a,b,c" command=[
], "/testbin/timeout", "-s", "9", "30m", "/testbin/puppet", "agent", "--onetime", "--no-daemonize",
{"environ_update": {"LANGUAGE": "C", "LC_ALL": "C"}, "check_rc": False}, "--no-usecacheonfailure", "--no-splay", "--detailed-exitcodes", "--verbose", "--color", "0", "--tags", "a,b,c"
(0, "", "",), # output rc, out, err ],
), environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
], rc=0,
"changed": False, out="",
} err="",
], ),
[ ]
{ ),
"skip_tags": ["d", "e", "f"] ModuleTestCase(
}, id="puppet_agent_skip_tags_def",
{ input={"skip_tags": ["d", "e", "f"]},
"id": "puppet_agent_skip_tags_def", output=dict(changed=False),
"run_command.calls": [ run_command_calls=[
( RunCmdCall(
["/testbin/puppet", "config", "print", "agent_disabled_lockfile"], command=["/testbin/puppet", "config", "print", "agent_disabled_lockfile"],
{"environ_update": {"LANGUAGE": "C", "LC_ALL": "C"}, "check_rc": False}, environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
(0, "blah, anything", "",), # output rc, out, err rc=0,
), out="blah, anything",
( err="",
[ ),
"/testbin/timeout", "-s", "9", "30m", "/testbin/puppet", "agent", "--onetime", "--no-daemonize", RunCmdCall(
"--no-usecacheonfailure", "--no-splay", "--detailed-exitcodes", "--verbose", "--color", "0", "--skip_tags", "d,e,f" command=[
], "/testbin/timeout", "-s", "9", "30m", "/testbin/puppet", "agent", "--onetime", "--no-daemonize",
{"environ_update": {"LANGUAGE": "C", "LC_ALL": "C"}, "check_rc": False}, "--no-usecacheonfailure", "--no-splay", "--detailed-exitcodes", "--verbose", "--color", "0", "--skip_tags", "d,e,f"
(0, "", "",), # output rc, out, err ],
), environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
], rc=0,
"changed": False, out="",
} err="",
] ),
]
),
ModuleTestCase(
id="puppet_agent_noop_false",
input={"noop": False},
output=dict(changed=False),
run_command_calls=[
RunCmdCall(
command=["/testbin/puppet", "config", "print", "agent_disabled_lockfile"],
environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
rc=0,
out="blah, anything",
err="",
),
RunCmdCall(
command=[
"/testbin/timeout", "-s", "9", "30m", "/testbin/puppet", "agent", "--onetime", "--no-daemonize",
"--no-usecacheonfailure", "--no-splay", "--detailed-exitcodes", "--verbose", "--color", "0", "--no-noop"
],
environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
rc=0,
out="",
err="",
),
]
),
ModuleTestCase(
id="puppet_agent_noop_true",
input={"noop": True},
output=dict(changed=False),
run_command_calls=[
RunCmdCall(
command=["/testbin/puppet", "config", "print", "agent_disabled_lockfile"],
environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
rc=0,
out="blah, anything",
err="",
),
RunCmdCall(
command=[
"/testbin/timeout", "-s", "9", "30m", "/testbin/puppet", "agent", "--onetime", "--no-daemonize",
"--no-usecacheonfailure", "--no-splay", "--detailed-exitcodes", "--verbose", "--color", "0", "--noop"
],
environ={'environ_update': {'LANGUAGE': 'C', 'LC_ALL': 'C'}, 'check_rc': False},
rc=0,
out="",
err="",
),
]
),
] ]
TEST_CASES_IDS = [item[1]["id"] for item in TEST_CASES] TEST_CASES_IDS = [item.id for item in TEST_CASES]
@pytest.mark.parametrize("patch_ansible_module, testcase", @pytest.mark.parametrize("patch_ansible_module, testcase",
TEST_CASES, [[x.input, x] for x in TEST_CASES],
ids=TEST_CASES_IDS, ids=TEST_CASES_IDS,
indirect=["patch_ansible_module"]) indirect=["patch_ansible_module"])
@pytest.mark.usefixtures("patch_ansible_module") @pytest.mark.usefixtures("patch_ansible_module")
@ -140,8 +195,10 @@ def test_puppet(mocker, capfd, patch_get_bin_path, testcase):
Run unit tests for test cases listen in TEST_CASES Run unit tests for test cases listen in TEST_CASES
""" """
run_cmd_calls = testcase.run_command_calls
# Mock function used for running commands first # Mock function used for running commands first
call_results = [item[2] for item in testcase["run_command.calls"]] call_results = [(x.rc, x.out, x.err) for x in run_cmd_calls]
mock_run_command = mocker.patch( mock_run_command = mocker.patch(
"ansible.module_utils.basic.AnsibleModule.run_command", "ansible.module_utils.basic.AnsibleModule.run_command",
side_effect=call_results) side_effect=call_results)
@ -152,18 +209,19 @@ def test_puppet(mocker, capfd, patch_get_bin_path, testcase):
out, err = capfd.readouterr() out, err = capfd.readouterr()
results = json.loads(out) results = json.loads(out)
print("testcase =\n%s" % str(testcase))
print("results =\n%s" % results) print("results =\n%s" % results)
assert mock_run_command.call_count == len(testcase["run_command.calls"]) assert mock_run_command.call_count == len(run_cmd_calls)
if mock_run_command.call_count: if mock_run_command.call_count:
call_args_list = [(item[0][0], item[1]) for item in mock_run_command.call_args_list] call_args_list = [(item[0][0], item[1]) for item in mock_run_command.call_args_list]
expected_call_args_list = [(item[0], item[1]) for item in testcase["run_command.calls"]] expected_call_args_list = [(item.command, item.environ) for item in run_cmd_calls]
print("call args list =\n%s" % call_args_list) print("call args list =\n%s" % call_args_list)
print("expected args list =\n%s" % expected_call_args_list) print("expected args list =\n%s" % expected_call_args_list)
assert call_args_list == expected_call_args_list assert call_args_list == expected_call_args_list
assert results.get("changed", False) == testcase["changed"] assert results.get("changed", False) == testcase.output["changed"]
if "failed" in testcase: if "failed" in testcase:
assert results.get("failed", False) == testcase["failed"] assert results.get("failed", False) == testcase.output["failed"]
if "msg" in testcase: if "msg" in testcase:
assert results.get("msg", "") == testcase["msg"] assert results.get("msg", "") == testcase.output["msg"]