8281: puppet waitforlock (#8282)

puppet waitforlock

Add support for the waitforlock[1] puppet argument

[1]https://www.puppet.com/docs/puppet/8/configuration#maxwaitforlock
Co-authored-by: Felix Fontein <felix@fontein.de>

changelogs/fragments/8281-puppet-waitforlock.yaml

@@ -0,0 +1,2 @@
+minor_changes:
+  - puppet - new feature to set ``--waitforlock`` option (https://github.com/ansible-collections/community.general/pull/8282).

plugins/module_utils/puppet.py

@@ -103,6 +103,7 @@ def puppet_runner(module):
             modulepath=cmd_runner_fmt.as_opt_eq_val("--modulepath"),
             _execute=cmd_runner_fmt.as_func(execute_func),
             summarize=cmd_runner_fmt.as_bool("--summarize"),
+            waitforlock=cmd_runner_fmt.as_opt_val("--waitforlock"),
             debug=cmd_runner_fmt.as_bool("--debug"),
             verbose=cmd_runner_fmt.as_bool("--verbose"),
         ),

plugins/modules/puppet.py

@@ -101,6 +101,12 @@ options:
       - Whether to print a transaction summary.
     type: bool
     default: false
+  waitforlock:
+    description:
+     - The maximum amount of time C(puppet) should wait for an already running C(puppet) agent to finish before starting.
+     - If a number without unit is provided, it is assumed to be a number of seconds. Allowed units are V(m) for minutes and V(h) for hours.
+    type: str
+    version_added: 9.0.0
   verbose:
     description:
       - Print extra information.
@@ -159,6 +165,14 @@ EXAMPLES = r'''
     skip_tags:
     - service
 
+- name: Wait 30 seconds for any current puppet runs to finish
+  community.general.puppet:
+    waitforlock: 30
+
+- name: Wait 5 minutes for any current puppet runs to finish
+  community.general.puppet:
+    waitforlock: 5m
+
 - name: Run puppet agent in noop mode
   community.general.puppet:
     noop: true
@@ -214,6 +228,7 @@ def main():
             skip_tags=dict(type='list', elements='str'),
             execute=dict(type='str'),
             summarize=dict(type='bool', default=False),
+            waitforlock=dict(type='str'),
             debug=dict(type='bool', default=False),
             verbose=dict(type='bool', default=False),
             use_srv_records=dict(type='bool'),
@@ -247,11 +262,11 @@ def main():
     runner = puppet_utils.puppet_runner(module)
 
     if not p['manifest'] and not p['execute']:
-        args_order = "_agent_fixed puppetmaster show_diff confdir environment tags skip_tags certname noop use_srv_records"
+        args_order = "_agent_fixed puppetmaster show_diff confdir environment tags skip_tags certname noop use_srv_records waitforlock"
         with runner(args_order) as ctx:
             rc, stdout, stderr = ctx.run()
     else:
-        args_order = "_apply_fixed logdest modulepath environment certname tags skip_tags noop _execute summarize debug verbose"
+        args_order = "_apply_fixed logdest modulepath environment certname tags skip_tags noop _execute summarize debug verbose waitforlock"
         with runner(args_order) as ctx:
             rc, stdout, stderr = ctx.run(_execute=[p['execute'], p['manifest']])
 

tests/unit/plugins/modules/test_puppet.yaml

@@ -190,3 +190,35 @@
       rc: 0
       out: ""
       err: ""
+- id: puppet_agent_waitforlock
+  input:
+    waitforlock: 30
+  output:
+    changed: false
+  run_command_calls:
+    - command: [/testbin/puppet, config, print, agent_disabled_lockfile]
+      environ: *env-def
+      rc: 0
+      out: "blah, anything"
+      err: ""
+    - command:
+        - /testbin/timeout
+        - -s
+        - "9"
+        - 30m
+        - /testbin/puppet
+        - agent
+        - --onetime
+        - --no-daemonize
+        - --no-usecacheonfailure
+        - --no-splay
+        - --detailed-exitcodes
+        - --verbose
+        - --color
+        - "0"
+        - --waitforlock
+        - "30"
+      environ: *env-def
+      rc: 0
+      out: ""
+      err: ""