mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 22:02:50 +00:00
puppet: deprecate param timeout (#11658)
* puppet: deprecate param timeout * add changelog frag * Update changelogs/fragments/11658-puppet-timeout-deprecation.yml Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
@@ -52,12 +52,11 @@ def puppet_runner(module: AnsibleModule) -> CmdRunner:
|
||||
# If this can be replaced with ansible `timeout` parameter in playbook,
|
||||
# then this function could be removed.
|
||||
def _prepare_base_cmd():
|
||||
_tout_cmd = module.get_bin_path("timeout", False)
|
||||
if _tout_cmd:
|
||||
cmd = ["timeout", "-s", "9", module.params["timeout"], _puppet_cmd(module)]
|
||||
else:
|
||||
cmd = ["puppet"]
|
||||
return cmd
|
||||
if module.params["timeout"]:
|
||||
_tout_cmd = module.get_bin_path("timeout", False)
|
||||
if _tout_cmd:
|
||||
return ["timeout", "-s", "9", module.params["timeout"], _puppet_cmd(module)]
|
||||
return ["puppet"]
|
||||
|
||||
def noop_func(v):
|
||||
return ["--noop"] if module.check_mode or v else ["--no-noop"]
|
||||
|
||||
@@ -22,6 +22,9 @@ options:
|
||||
timeout:
|
||||
description:
|
||||
- How long to wait for C(puppet) to finish.
|
||||
- This parameter is deprecated and will be removed in community.general 14.0.0.
|
||||
Use the task-level C(timeout) keyword instead.
|
||||
To suppress this deprecation warning, set O(timeout) to V("").
|
||||
type: str
|
||||
default: 30m
|
||||
puppetmaster:
|
||||
@@ -240,6 +243,15 @@ def main():
|
||||
)
|
||||
p = module.params
|
||||
|
||||
if p["timeout"]:
|
||||
module.deprecate(
|
||||
'The "timeout" parameter is deprecated and will be removed in community.general 14.0.0. '
|
||||
'Use the task-level "timeout" keyword instead. '
|
||||
"To suppress this warning, set \"timeout: ''\" in the task.",
|
||||
version="14.0.0",
|
||||
collection_name="community.general",
|
||||
)
|
||||
|
||||
if p["manifest"]:
|
||||
if not os.path.exists(p["manifest"]):
|
||||
module.fail_json(msg=f"Manifest file {dict(manifest=p['manifest'])['manifest']} not found.")
|
||||
|
||||
Reference in New Issue
Block a user