update the _ios_template module to use the network_cli plugin (#19933)

* updates the deprecated ios_template module to use network_cli
* adds unit test cases for ios_template
* adds check for provider argument and displays warning message

lib/ansible/modules/network/ios/_ios_template.py

@@ -15,10 +15,11 @@
 # You should have received a copy of the GNU General Public License
 # along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 #
-ANSIBLE_METADATA = {'status': ['deprecated'],
-                    'supported_by': 'community',
-                    'version': '1.0'}
-
+ANSIBLE_METADATA = {
+    'status': ['deprecated'],
+    'supported_by': 'community',
+    'version': '1.0'
+}
 
 DOCUMENTATION = """
 ---
@@ -34,7 +35,9 @@ description:
     commands that are not already configured.  The config source can
     be a set of commands or a template.
 deprecated: Deprecated in 2.2. Use M(ios_config) instead.
-extends_documentation_fragment: ios
+notes:
+  - Provider arguments are no longer supported.  Network tasks should now
+    specify connection plugin network_cli instead.
 options:
   src:
     description:
@@ -88,21 +91,15 @@ options:
 EXAMPLES = """
 - name: push a configuration onto the device
   ios_template:
-    host: hostname
-    username: foo
     src: config.j2
 
 - name: forceable push a configuration onto the device
   ios_template:
-    host: hostname
-    username: foo
     src: config.j2
     force: yes
 
 - name: provide the base configuration for comparison
   ios_template:
-    host: hostname
-    username: foo
     src: candidate_config.txt
     config: current_config.txt
 """
@@ -113,28 +110,51 @@ updates:
   returned: always
   type: list
   sample: ['...', '...']
-
-responses:
-  description: The set of responses from issuing the commands on the device
-  returned: when not check_mode
-  type: list
-  sample: ['...', '...']
+start:
+  description: The time the job started
+  returned: always
+  type: str
+  sample: "2016-11-16 10:38:15.126146"
+end:
+  description: The time the job ended
+  returned: always
+  type: str
+  sample: "2016-11-16 10:38:25.595612"
+delta:
+  description: The time elapsed to perform all operations
+  returned: always
+  type: str
+  sample: "0:00:10.469466"
 """
-import ansible.module_utils.ios
+from ansible.module_utils.local import LocalAnsibleModule
 from ansible.module_utils.netcfg import NetworkConfig, dumps
-from ansible.module_utils.ios import NetworkModule
+from ansible.module_utils.ios import get_config, load_config
+from ansible.module_utils.network import NET_TRANSPORT_ARGS, _transitional_argument_spec
 
-def get_config(module):
-    config = module.params['config'] or dict()
-    defaults = module.params['include_defaults']
-    if not config and not module.params['force']:
-        config = module.config.get_config(include_defaults=defaults)
-    return config
+
+def check_args(module):
+    warnings = list()
+    for key in NET_TRANSPORT_ARGS:
+        if module.params[key]:
+            warnings.append(
+                'network provider arguments are no longer supported.  Please '
+                'use connection: network_cli for the task'
+            )
+            break
+    return warnings
+
+def get_current_config(module):
+    if module.params['config']:
+        return module.params['config']
+    if module.params['include_defaults']:
+        flags = ['all']
+    else:
+        flags = []
+    return get_config(flags=flags)
 
 def main():
     """ main entry point for module execution
     """
-
     argument_spec = dict(
         src=dict(),
         force=dict(default=False, type='bool'),
@@ -143,37 +163,44 @@ def main():
         config=dict(),
     )
 
+    # Removed the use of provider arguments in 2.3 due to network_cli
+    # connection plugin.  To be removed in 2.5
+    argument_spec.update(_transitional_argument_spec())
+
     mutually_exclusive = [('config', 'backup'), ('config', 'force')]
 
-    module = NetworkModule(argument_spec=argument_spec,
-                           mutually_exclusive=mutually_exclusive,
-                           supports_check_mode=True)
+    module = LocalAnsibleModule(argument_spec=argument_spec,
+                                mutually_exclusive=mutually_exclusive,
+                                supports_check_mode=True)
 
-    result = dict(changed=False)
+    warnings = check_args(module)
+
+    result = dict(changed=False, warnings=warnings)
 
     candidate = NetworkConfig(contents=module.params['src'], indent=1)
 
-    contents = get_config(module)
-    if contents:
-        config = NetworkConfig(contents=contents, indent=1)
-        result['_backup'] = str(contents)
+    result = {'changed': False}
+
+    if module.params['backup']:
+        result['__backup__'] = get_config()
 
     if not module.params['force']:
-        commands = candidate.difference(config)
+        contents = get_current_config(module)
+        configobj = NetworkConfig(contents=contents, indent=1)
+        commands = candidate.difference(configobj)
         commands = dumps(commands, 'commands').split('\n')
-        commands = [str(c) for c in commands if c]
+        commands = [str(c).strip() for c in commands if c]
     else:
-        commands = str(candidate).split('\n')
+        commands = [c.strip() for c in str(candidate).split('\n')]
 
     if commands:
         if not module.check_mode:
-            response = module.config(commands)
-            result['responses'] = response
+            load_config(commands)
         result['changed'] = True
 
     result['updates'] = commands
-    module.exit_json(**result)
 
+    module.exit_json(**result)
 
 if __name__ == '__main__':
     main()