Ansible 2.5 feature support for dellos9 (#34880)

* Add ansible-2.5 support for dellos9

* Fix ansible-test issues and update copyright

* fix ansible-test errors in dellos9_config

* fix izip attribute error in python3

* fix python3 dict.keys() issue

* Remove waitfor aliases in dellos9_command

1 files changed, 95 insertions, 68 deletions

diff --git a/lib/ansible/modules/network/dellos9/dellos9_config.py b/lib/ansible/modules/network/dellos9/dellos9_config.py
index 439c98d70c..d2633ad802 100644
--- a/lib/ansible/modules/network/dellos9/dellos9_config.py
+++ b/lib/ansible/modules/network/dellos9/dellos9_config.py
@@ -30,15 +30,17 @@ options:
     description:
       - The ordered set of commands that should be configured in the
         section.  The commands must be the exact same commands as found
-        in the device running-config. Note the configuration
-        command syntax as the device config parser automatically modifies some commands. This argument is mutually exclusive with I(src).
+        in the device running-config. Be sure to note the configuration
+        command syntax as some commands are automatically modified by the
+        device config parser. This argument is mutually exclusive with I(src).
     required: false
     default: null
     aliases: ['commands']
   parents:
     description:
       - The ordered set of parents that uniquely identify the section
-        the commands should be checked against.  If you omit the parents argument, the commands are checked against the set of top
+        the commands should be checked against.  If the parents argument
+        is omitted, the commands are checked against the set of top
         level or global commands.
     required: false
     default: null
@@ -47,14 +49,15 @@ options:
       - Specifies the source path to the file that contains the configuration
         or configuration template to load.  The path to the source file can
         either be the full path on the Ansible control host or a relative
-        path from the playbook or role root directory.  This argument is mutually
-        exclusive with I(lines), I(parents).
+        path from the playbook or role root directory. This argument is
+        mutually exclusive with I(lines).
     required: false
     default: null
   before:
     description:
       - The ordered set of commands to push on to the command stack if
-        a change needs to be made.  The playbook designer can use this opportunity to perform configuration commands prior to pushing
+        a change needs to be made.  This allows the playbook designer
+        the opportunity to perform configuration commands prior to pushing
         any changes without affecting how the set of commands are matched
         against the system.
     required: false
@@ -62,19 +65,20 @@ options:
   after:
     description:
       - The ordered set of commands to append to the end of the command
-        stack if a change needs to be made. As with I(before), this
-        the playbook designer can append a set of commands to be
+        stack if a change needs to be made.  Just like with I(before) this
+        allows the playbook designer to append a set of commands to be
         executed after the command set.
     required: false
     default: null
   match:
     description:
       - Instructs the module on the way to perform the matching of
-        the set of commands against the current device config.  If you set
-        match to I(line), commands match line by line.  If you set
-        match to I(strict), command lines match by position.  If you set match to I(exact), command lines
-        must be an equal match.  Finally, if you set match to I(none), the
-        module does not attempt to compare the source configuration with
+        the set of commands against the current device config.  If
+        match is set to I(line), commands are matched line by line.  If
+        match is set to I(strict), command lines are matched with respect
+        to position.  If match is set to I(exact), command lines
+        must be an equal match.  Finally, if match is set to I(none), the
+        module will not attempt to compare the source configuration with
         the running configuration on the remote device.
     required: false
     default: line
@@ -82,10 +86,10 @@ options:
   replace:
     description:
       - Instructs the module on the way to perform the configuration
-        on the device.  If you set the replace argument to I(line), then
-        the modified lines push to the device in configuration
-        mode.  If you set the replace argument to I(block), then the entire
-        command block pushes to the device in configuration mode if any
+        on the device.  If the replace argument is set to I(line) then
+        the modified lines are pushed to the device in configuration
+        mode.  If the replace argument is set to I(block) then the entire
+        command block is pushed to the device in configuration mode if any
         line is not correct.
     required: false
     default: line
@@ -112,29 +116,32 @@ options:
     choices: ['yes', 'no']
   config:
     description:
-      - The playbook designer can use the C(config) argument to supply
-        the base configuration to be used to validate necessary configuration
-        changes.  If you specify this argument, the module
-        does not download the running-config from the remote node.
+      - The module, by default, will connect to the remote device and
+        retrieve the current running-config to use as a base for comparing
+        against the contents of source.  There are times when it is not
+        desirable to have the task get the current running-config for
+        every task in a playbook.  The I(config) argument allows the
+        implementer to pass in the configuration to use as the base
+        config for comparison.
     required: false
     default: null
   backup:
     description:
-      - This argument causes the module to create a full backup of
+      - This argument will cause the module to create a full backup of
         the current C(running-config) from the remote device before any
         changes are made.  The backup file is written to the C(backup)
         folder in the playbook root directory.  If the directory does not
         exist, it is created.
     required: false
     default: no
-    choices: ['yes', 'no']
-
+    type: bool
 notes:
   - This module requires Dell OS9 version 9.10.0.1P13 or above.
 
   - This module requires to increase the ssh connection rate limit.
     Use the following command I(ip ssh connection-rate-limit 60)
-    to configure the same. This can also be done with the M(dellos9_config) module.
+    to configure the same. This can also be done with the
+    M(dellos9_config) module.
 """
 
 EXAMPLES = """
@@ -152,7 +159,6 @@ EXAMPLES = """
     parents: ['ip access-list extended test']
     before: ['no ip access-list extended test']
     match: exact
-    provider: "{{ cli }}"
 
 - dellos9_config:
     lines:
@@ -163,30 +169,25 @@ EXAMPLES = """
     parents: ['ip access-list extended test']
     before: ['no ip access-list extended test']
     replace: block
-    provider: "{{ cli }}"
-
 """
 
 RETURN = """
 updates:
   description: The set of commands that will be pushed to the remote device.
-  returned: Always.
+  returned: always
   type: list
-  sample: ['...', '...']
-
-responses:
-  description: The set of responses from issuing the commands on the device.
-  returned: When not check_mode.
+  sample: ['hostname foo', 'router bgp 1', 'bgp router-id 1.1.1.1']
+commands:
+  description: The set of commands that will be pushed to the remote device
+  returned: always
   type: list
-  sample: ['...', '...']
-
+  sample: ['hostname foo', 'router bgp 1', 'bgp router-id 1.1.1.1']
 saved:
   description: Returns whether the configuration is saved to the startup
                configuration or not.
   returned: When not check_mode.
   type: bool
   sample: True
-
 backup_path:
   description: The full path to the backup file
   returned: when backup is yes
@@ -207,10 +208,23 @@ def get_candidate(module):
         candidate.load(module.params['src'])
     elif module.params['lines']:
         parents = module.params['parents'] or list()
-        candidate.add(module.params['lines'], parents=parents)
+        commands = module.params['lines'][0]
+        if (isinstance(commands, dict)) and (isinstance(commands['command'], list)):
+            candidate.add(commands['command'], parents=parents)
+        elif (isinstance(commands, dict)) and (isinstance(commands['command'], str)):
+            candidate.add([commands['command']], parents=parents)
+        else:
+            candidate.add(module.params['lines'], parents=parents)
     return candidate
 
 
+def get_running_config(module):
+    contents = module.params['config']
+    if not contents:
+        contents = get_config(module)
+    return contents
+
+
 def main():
 
     argument_spec = dict(
@@ -236,7 +250,6 @@ def main():
 
     mutually_exclusive = [('lines', 'src'),
                           ('parents', 'src')]
-
     module = AnsibleModule(argument_spec=argument_spec,
                            mutually_exclusive=mutually_exclusive,
                            supports_check_mode=True)
@@ -253,48 +266,62 @@ def main():
 
     candidate = get_candidate(module)
 
-    if match != 'none':
-        config = get_config(module)
-        if parents:
-            contents = get_sublevel_config(config, module)
-            config = NetworkConfig(contents=contents, indent=1)
-        else:
-            config = NetworkConfig(contents=config, indent=1)
-        configobjs = candidate.difference(config, match=match, replace=replace)
-
-    else:
-        configobjs = candidate.items
-
     if module.params['backup']:
         if not module.check_mode:
             result['__backup__'] = get_config(module)
-
     commands = list()
 
-    if configobjs:
-        commands = dumps(configobjs, 'commands')
-        commands = commands.split('\n')
+    if any((module.params['lines'], module.params['src'])):
+        if match != 'none':
+            config = get_running_config(module)
+            if parents:
+                contents = get_sublevel_config(config, module)
+                config = NetworkConfig(contents=contents, indent=1)
+            else:
+                config = NetworkConfig(contents=config, indent=1)
+            configobjs = candidate.difference(config, match=match, replace=replace)
+        else:
+            configobjs = candidate.items
+
+        if configobjs:
+            commands = dumps(configobjs, 'commands')
+            if ((isinstance(module.params['lines'], list)) and
+                    (isinstance(module.params['lines'][0], dict)) and
+                    ['prompt', 'answer'].issubset(module.params['lines'][0])):
 
-        if module.params['before']:
-            commands[:0] = module.params['before']
+                cmd = {'command': commands,
+                       'prompt': module.params['lines'][0]['prompt'],
+                       'answer': module.params['lines'][0]['answer']}
+                commands = [module.jsonify(cmd)]
+            else:
+                commands = commands.split('\n')
 
-        if module.params['after']:
-            commands.extend(module.params['after'])
+            if module.params['before']:
+                commands[:0] = module.params['before']
 
-        if not module.check_mode and module.params['update'] == 'merge':
-            load_config(module, commands)
+            if module.params['after']:
+                commands.extend(module.params['after'])
 
-            if module.params['save']:
-                cmd = {'command': 'copy runing-config startup-config', 'prompt': WARNING_PROMPTS_RE, 'answer': 'yes'}
-                run_commands(module, [cmd])
-                result['saved'] = True
+            if not module.check_mode and module.params['update'] == 'merge':
+                load_config(module, commands)
 
-        result['changed'] = True
+            result['changed'] = True
+            result['commands'] = commands
+            result['updates'] = commands
 
-    result['updates'] = commands
+    if module.params['save']:
+        result['changed'] = True
+        if not module.check_mode:
+            cmd = {'command': 'copy running-config startup-config',
+                   'prompt': r'\[confirm yes/no\]:\s?$', 'answer': 'yes'}
+            run_commands(module, [cmd])
+            result['saved'] = True
+        else:
+            module.warn('Skipping command `copy running-config startup-config`'
+                        'due to check_mode.  Configuration not copied to '
+                        'non-volatile storage')
 
     module.exit_json(**result)
 
-
 if __name__ == '__main__':
     main()