Repository: ansible/ansible

Issue:
Add `args` to `local_action` example in the `wait_for` module docs.
In the `EXAMPLES` docstring for the `wait_for` module, the `local_action` example should use `args` to define arguments to pass to `wait_for`.  Without this, the example does not run correctly.

##### ISSUE TYPE
<!--- Pick one below and delete the rest: -->
 - Docs Pull Request

##### COMPONENT NAME
<!--- Name of the module/plugin/module/task -->
`wait_for` module

##### ANSIBLE VERSION
<!--- Paste verbatim output from “ansible --version” between quotes below -->
```
ansible 2.2.0.0
  config file = /home/justin/projects/base_site/ansible/ansible.cfg
  configured module search path = Default w/o overrides
```

##### SUMMARY
<!--- Describe the change, including rationale and design decisions -->
The current `EXAMPLE` docstring for the `wait_for` module includes an example using `local_action`, but it does not currently run as-is.  To pass arguments to the module using the multi-line syntax, they have to be placed within an `args` dictionary.

This PR adds `args` so that the example runs correctly.

Before, the file and output looked like this:

```
---
- hosts: debian_8
  tasks:
    - local_action: wait_for
        port: 22
        host: "{{ ansible_ssh_host | default(inventory_hostname) }}"
        search_regex: OpenSSH
        delay: 10
```
```
ansible-playbook test.yml
```
```
ERROR! Syntax Error while loading YAML.


The error appears to have been in '/home/justin/projects/base_site/ansible/test.yml': line 5, column 13, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

    - local_action: wait_for
        port: 22
            ^ here
```

After the change, the example runs as expected:

```
---
- hosts: debian_8
  tasks:
    - local_action: wait_for
      args:
        port: 22
        host: "{{ ansible_ssh_host | default(inventory_hostname) }}"
        search_regex: OpenSSH
        delay: 10
```
```
ansible-playbook test.yml
```
```
PLAY [debian_8] ****************************************************************

TASK [setup] *******************************************************************
ok: [xxx.xxx.xxx.xxx]

TASK [wait_for] ****************************************************************
ok: [xxx.xxx.xxx.xxx -> localhost]

PLAY RECAP *********************************************************************
xxx.xxx.xxx.xxx            : ok=2    changed=0    unreachable=0    failed=0
```


Discussion:
cc @gregswift
[click here for bot help](https://github.com/ansible/ansibullbot/blob/master/ISSUE_HELP.md)
<!--- boilerplate: notify --->
Personally, I would change `local_action:` to using a normal action and use `connection: local` instead.

Resolving patch:
diff --git a/lib/ansible/modules/utilities/logic/wait_for.py b/lib/ansible/modules/utilities/logic/wait_for.py
--- a/lib/ansible/modules/utilities/logic/wait_for.py
+++ b/lib/ansible/modules/utilities/logic/wait_for.py
@@ -22,11 +22,10 @@
                     'status': ['stableinterface'],
                     'supported_by': 'core'}
 
-
-DOCUMENTATION = '''
+DOCUMENTATION = r'''
 ---
 module: wait_for
-short_description: Waits for a condition before continuing.
+short_description: Waits for a condition before continuing
 description:
      - You can wait for a set amount of time C(timeout), this is the default if nothing is specified.
      - Waiting for a port to become available is useful for when services
@@ -44,64 +43,51 @@
 options:
   host:
     description:
-      - A resolvable hostname or IP address to wait for
-    required: false
+      - A resolvable hostname or IP address to wait for.
     default: "127.0.0.1"
   timeout:
     description:
-      - maximum number of seconds to wait for
-    required: false
+      - Maximum number of seconds to wait for.
     default: 300
   connect_timeout:
     description:
-      - maximum number of seconds to wait for a connection to happen before closing and retrying
-    required: false
+      - Maximum number of seconds to wait for a connection to happen before closing and retrying.
     default: 5
   delay:
     description:
-      - number of seconds to wait before starting to poll
-    required: false
+      - Number of seconds to wait before starting to poll.
     default: 0
   port:
     description:
-      - port number to poll
-    required: false
-    default: null
+      - Port number to poll.
   active_connection_states:
     description:
-      - The list of tcp connection states which are counted as active connections
-    default: ['ESTABLISHED','SYN_SENT','SYN_RECV','FIN_WAIT1','FIN_WAIT2','TIME_WAIT']
+      - The list of TCP connection states which are counted as active connections.
+    default: [ ESTABLISHED, FIN_WAIT1, FIN_WAIT2, SYN_RECV, SYN_SENT, TIME_WAIT ]
     version_added: "2.3"
   state:
     description:
-      - either C(present), C(started), or C(stopped), C(absent), or C(drained)
-      - When checking a port C(started) will ensure the port is open, C(stopped) will check that it is closed, C(drained) will check for active connections
+      - Either C(present), C(started), or C(stopped), C(absent), or C(drained).
+      - When checking a port C(started) will ensure the port is open, C(stopped) will check that it is closed, C(drained) will check for active connections.
       - When checking for a file or a search string C(present) or C(started) will ensure that the file or string is present before continuing,
-        C(absent) will check that file is absent or removed
-    choices: [ "present", "started", "stopped", "absent", "drained" ]
-    required: False
-    default: "started"
+        C(absent) will check that file is absent or removed.
+    choices: [ absent, drained, present, started, stopped ]
+    default: started
   path:
     version_added: "1.4"
-    required: false
-    default: null
     description:
-      - path to a file on the filesytem that must exist before continuing
+      - Path to a file on the filesytem that must exist before continuing.
   search_regex:
     version_added: "1.4"
-    required: false
-    default: null
     description:
-      - Can be used to match a string in either a file or a socket connection. Defaults to a multiline regex.
+      - Can be used to match a string in either a file or a socket connection.
+      - Defaults to a multiline regex.
   exclude_hosts:
     version_added: "1.8"
-    required: false
-    default: null
     description:
-      - list of hosts or IPs to ignore when looking for active TCP connections for C(drained) state
+      - List of hosts or IPs to ignore when looking for active TCP connections for C(drained) state.
   sleep:
     version_added: "2.3"
-    required: false
     default: 1
     description:
       - Number of seconds to sleep between checks, before 2.3 this was hardcoded to 1 second.
@@ -113,63 +99,66 @@
       - This overrides the normal error message from a failure to meet the required conditions.
 notes:
   - The ability to use search_regex with a port connection was added in 1.7.
-requirements: []
 author:
-    - "Jeroen Hoekx (@jhoekx)"
-    - "John Jarvis (@jarv)"
-    - "Andrii Radyk (@AnderEnder)"
+    - Jeroen Hoekx (@jhoekx)
+    - John Jarvis (@jarv)
+    - Andrii Radyk (@AnderEnder)
 '''
 
-EXAMPLES = '''
+EXAMPLES = r'''
 
-# wait 300 seconds for port 8000 to become open on the host, don't start checking for 10 seconds
-- wait_for:
+- name: Wait 300 seconds for port 8000 to become open on the host, don't start checking for 10 seconds
+  wait_for:
     port: 8000
     delay: 10
 
-# wait 300 seconds for port 8000 of any IP to close active connections, don't start checking for 10 seconds
-- wait_for:
+- name: Wait 300 seconds for port 8000 of any IP to close active connections, don't start checking for 10 seconds
+  wait_for:
     host: 0.0.0.0
     port: 8000
     delay: 10
     state: drained
 
-# wait 300 seconds for port 8000 of any IP to close active connections, ignoring connections for specified hosts
-- wait_for:
+- name: Wait 300 seconds for port 8000 of any IP to close active connections, ignoring connections for specified hosts
+  wait_for:
     host: 0.0.0.0
     port: 8000
     state: drained
     exclude_hosts: 10.2.1.2,10.2.1.3
 
-# wait until the file /tmp/foo is present before continuing
-- wait_for:
+- name: Wait until the file /tmp/foo is present before continuing
+  wait_for:
     path: /tmp/foo
 
-# wait until the string "completed" is in the file /tmp/foo before continuing
-- wait_for:
+- name: Wait until the string "completed" is in the file /tmp/foo before continuing
+  wait_for:
     path: /tmp/foo
     search_regex: completed
 
-# wait until the lock file is removed
-- wait_for:
+- name: Wait until the lock file is removed
+  wait_for:
     path: /var/lock/file.lock
     state: absent
 
-# wait until the process is finished and pid was destroyed
-- wait_for:
+- name: Wait until the process is finished and pid was destroyed
+  wait_for:
     path: /proc/3466/status
     state: absent
 
-# output customized message when failed
-- wait_for:
+- name: Output customized message when failed
+  wait_for:
     path: /tmp/foo
     state: present
     msg: Timeout to find file /tmp/foo
 
-# wait 300 seconds for port 22 to become open and contain "OpenSSH",
-# don't assume the inventory_hostname is resolvable and don't start checking for 10 seconds
-- wait_for: port=22 host="{{ ansible_host|default(ansible_ssh_host|default(inventory_hostname)) }}" search_regex=OpenSSH delay=10
-  connection: local
+# Don't assume the inventory_hostname is resolvable and delay 10 seconds at start
+- name: Wait 300 seconds for port 22 to become open and contain "OpenSSH"
+  wait_for:
+    port: 22
+    host: '{{ ansible_ssh_host | default(inventory_hostname) }}'
+    search_regex: OpenSSH
+    delay: 10
+  delegate_to: localhost
 '''
 
 import binascii
@@ -181,8 +170,10 @@
 import sys
 import time
 
+from ansible.module_utils.basic import AnsibleModule, load_platform_subclass
 from ansible.module_utils._text import to_native
 
+
 HAS_PSUTIL = False
 try:
     import psutil
@@ -347,6 +338,7 @@ def _convert_host_to_ip(host):
             ips.append((socket.AF_INET6, "::ffff:" + ip))
     return ips
 
+
 def _convert_host_to_hex(host):
     """
     Convert the provided host to the format in /proc/net/tcp*
@@ -367,12 +359,13 @@ def _convert_host_to_hex(host):
             hexip_nf = binascii.b2a_hex(socket.inet_pton(family, ip))
             hexip_hf = ""
             for i in range(0, len(hexip_nf), 8):
-                ipgroup_nf = hexip_nf[i:i+8]
+                ipgroup_nf = hexip_nf[i:i + 8]
                 ipgroup_hf = socket.ntohl(int(ipgroup_nf, base=16))
                 hexip_hf = "%s%08X" % (hexip_hf, ipgroup_hf)
             ips.append((family, hexip_hf))
     return ips
 
+
 def _create_connection(host, port, connect_timeout):
     """
     Connect to a 2-tuple (host, port) and return
@@ -387,16 +380,18 @@ def _create_connection(host, port, connect_timeout):
         (family, _) = (_convert_host_to_ip(host))[0]
         connect_socket = socket.socket(family, socket.SOCK_STREAM)
         connect_socket.settimeout(connect_timeout)
-        connect_socket.connect( (host, port) )
+        connect_socket.connect((host, port))
     else:
-        connect_socket = socket.create_connection( (host, port), connect_timeout)
+        connect_socket = socket.create_connection((host, port), connect_timeout)
     return connect_socket
 
+
 def _timedelta_total_seconds(timedelta):
     return (
         timedelta.microseconds + 0.0 +
         (timedelta.seconds + timedelta.days * 24 * 3600) * 10 ** 6) / 10 ** 6
 
+
 def get_connection_state_id(state):
     connection_state_id = {
         'ESTABLISHED': '01',
@@ -408,35 +403,36 @@ def get_connection_state_id(state):
     }
     return connection_state_id[state]
 
+
 def main():
 
     module = AnsibleModule(
-        argument_spec = dict(
-            host=dict(default='127.0.0.1'),
-            timeout=dict(default=300, type='int'),
-            connect_timeout=dict(default=5, type='int'),
-            delay=dict(default=0, type='int'),
-            port=dict(default=None, type='int'),
-            active_connection_states=dict(default=['ESTABLISHED','SYN_SENT','SYN_RECV','FIN_WAIT1','FIN_WAIT2','TIME_WAIT'], type='list'),
-            path=dict(default=None, type='path'),
-            search_regex=dict(default=None),
-            state=dict(default='started', choices=['started', 'stopped', 'present', 'absent', 'drained']),
-            exclude_hosts=dict(default=None, type='list'),
-            sleep=dict(default=1, type='int'),
-            msg=dict(default=None, type='str')
+        argument_spec=dict(
+            host=dict(type='str', default='127.0.0.1'),
+            timeout=dict(type='int', default=300),
+            connect_timeout=dict(type='int', default=5),
+            delay=dict(type='int', default=0),
+            port=dict(type='int'),
+            active_connection_states=dict(type='list', default=['ESTABLISHED', 'FIN_WAIT1', 'FIN_WAIT2', 'SYN_RECV', 'SYN_SENT', 'TIME_WAIT']),
+            path=dict(type='path'),
+            search_regex=dict(type='str'),
+            state=dict(type='str', default='started', choices=['absent', 'drained', 'present', 'started', 'stopped']),
+            exclude_hosts=dict(type='list'),
+            sleep=dict(type='int', default=1),
+            msg=dict(type='str'),
         ),
     )
 
-    params = module.params
+    host = module.params['host']
+    timeout = module.params['timeout']
+    connect_timeout = module.params['connect_timeout']
+    delay = module.params['delay']
+    port = module.params['port']
+    state = module.params['state']
+    path = module.params['path']
+    search_regex = module.params['search_regex']
+    msg = module.params['msg']
 
-    host = params['host']
-    timeout = params['timeout']
-    connect_timeout = params['connect_timeout']
-    delay = params['delay']
-    port = params['port']
-    state = params['state']
-    path = params['path']
-    search_regex = params['search_regex']
     if search_regex is not None:
         compiled_search_re = re.compile(search_regex, re.MULTILINE)
     else:
@@ -448,15 +444,13 @@ def main():
         module.fail_json(msg="state=stopped should only be used for checking a port in the wait_for module")
     if path and state == 'drained':
         module.fail_json(msg="state=drained should only be used for checking a port in the wait_for module")
-    if params['exclude_hosts'] is not None and state != 'drained':
+    if module.params['exclude_hosts'] is not None and state != 'drained':
         module.fail_json(msg="exclude_hosts should only be with state=drained")
-    for _connection_state in params['active_connection_states']:
+    for _connection_state in module.params['active_connection_states']:
         try:
             get_connection_state_id(_connection_state)
         except:
-            module.fail_json(msg="unknown active_connection_state ("+_connection_state+") defined")
-
-    msg = params['msg']
+            module.fail_json(msg="unknown active_connection_state (%s) defined" % _connection_state)
 
     start = datetime.datetime.utcnow()
 
@@ -465,8 +459,8 @@ def main():
 
     if not port and not path and state != 'drained':
         time.sleep(timeout)
-    elif state in [ 'stopped', 'absent' ]:
-        ### first wait for the stop condition
+    elif state in ['absent', 'stopped']:
+        # first wait for the stop condition
         end = start + datetime.timedelta(seconds=timeout)
 
         while datetime.datetime.utcnow() < end:
@@ -484,7 +478,7 @@ def main():
                 except:
                     break
             # Conditions not yet met, wait and try again
-            time.sleep(params['sleep'])
+            time.sleep(module.params['sleep'])
         else:
             elapsed = datetime.datetime.utcnow() - start
             if port:
@@ -493,7 +487,7 @@ def main():
                 module.fail_json(msg=msg or "Timeout when waiting for %s to be absent." % (path), elapsed=elapsed.seconds)
 
     elif state in ['started', 'present']:
-        ### wait for start condition
+        # wait for start condition
         end = start + datetime.timedelta(seconds=timeout)
         while datetime.datetime.utcnow() < end:
             if path:
@@ -562,7 +556,7 @@ def main():
                         break
 
             # Conditions not yet met, wait and try again
-            time.sleep(params['sleep'])
+            time.sleep(module.params['sleep'])
 
         else:   # while-else
             # Timeout expired
@@ -571,7 +565,7 @@ def main():
                 if search_regex:
                     module.fail_json(msg=msg or "Timeout when waiting for search string %s in %s:%s" % (search_regex, host, port), elapsed=elapsed.seconds)
                 else:
-                    module.fail_json(msg= msg or "Timeout when waiting for %s:%s" % (host, port), elapsed=elapsed.seconds)
+                    module.fail_json(msg=msg or "Timeout when waiting for %s:%s" % (host, port), elapsed=elapsed.seconds)
             elif path:
                 if search_regex:
                     module.fail_json(msg=msg or "Timeout when waiting for search string %s in %s" % (search_regex, path), elapsed=elapsed.seconds)
@@ -579,7 +573,7 @@ def main():
                     module.fail_json(msg=msg or "Timeout when waiting for file %s" % (path), elapsed=elapsed.seconds)
 
     elif state == 'drained':
-        ### wait until all active connections are gone
+        # wait until all active connections are gone
         end = start + datetime.timedelta(seconds=timeout)
         tcpconns = TCPConnectionInfo(module)
         while datetime.datetime.utcnow() < end:
@@ -589,7 +583,7 @@ def main():
             except IOError:
                 pass
             # Conditions not yet met, wait and try again
-            time.sleep(params['sleep'])
+            time.sleep(module.params['sleep'])
         else:
             elapsed = datetime.datetime.utcnow() - start
             module.fail_json(msg=msg or "Timeout when waiting for %s:%s to drain" % (host, port), elapsed=elapsed.seconds)
@@ -597,7 +591,6 @@ def main():
     elapsed = datetime.datetime.utcnow() - start
     module.exit_json(state=state, port=port, search_regex=search_regex, path=path, elapsed=elapsed.seconds)
 
-# import module snippets
-from ansible.module_utils.basic import *
+
 if __name__ == '__main__':
     main()


Test patch:
diff --git a/test/sanity/pep8/legacy-files.txt b/test/sanity/pep8/legacy-files.txt
--- a/test/sanity/pep8/legacy-files.txt
+++ b/test/sanity/pep8/legacy-files.txt
@@ -567,4 +567,3 @@ lib/ansible/modules/system/user.py
 lib/ansible/modules/utilities/helper/_accelerate.py
 lib/ansible/modules/utilities/logic/async_status.py
 lib/ansible/modules/utilities/logic/async_wrapper.py
-lib/ansible/modules/utilities/logic/wait_for.py