Adding module enos_config and its UT files (#33081)

* Adding module enos_config and its UT files

* Removing trailing line

* Removing trailing lines

* Editing enos_module.py to fix build errors

* Removing blank lines in end

* Updating enos_config.py based on review comments

* Adding one more blank line

* Removing training white space

* Removing test_enos_config_force method from UT

* Updating documentation

* Comments by John, Remove version_added: "2.5"

test/units/modules/network/enos/enos_module.py

@@ -1,4 +1,4 @@
-# (c) 2016 Red Hat Inc.
+# Copyright (C) 2017 Lenovo, Inc.
 #
 # This file is part of Ansible
 #
@@ -22,9 +22,16 @@ __metaclass__ = type
 import os
 import json
 
-from units.modules.utils import AnsibleExitJson, AnsibleFailJson, ModuleTestCase
+from ansible.compat.tests import unittest
+from ansible.compat.tests.mock import patch
+from ansible.module_utils import basic
+from ansible.module_utils._text import to_bytes
 
 
+def set_module_args(args):
+    args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
+    basic._ANSIBLE_ARGS = to_bytes(args)
+
 fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
 fixture_data = {}
 
@@ -47,9 +54,18 @@ def load_fixture(name):
     return data
 
 
-class TestEnosModule(ModuleTestCase):
+class AnsibleExitJson(Exception):
+    pass
 
-    def execute_module(self, failed=False, changed=False, commands=None, sort=True, defaults=False):
+
+class AnsibleFailJson(Exception):
+    pass
+
+
+class TestEnosModule(unittest.TestCase):
+
+    def execute_module(self, failed=False, changed=False, commands=None,
+                       sort=True, defaults=False):
 
         self.load_fixtures(commands)
 
@@ -62,23 +78,36 @@ class TestEnosModule(ModuleTestCase):
 
         if commands is not None:
             if sort:
-                self.assertEqual(sorted(commands), sorted(result['commands']), result['commands'])
+                self.assertEqual(sorted(commands), sorted(result['commands']),
+                                 result['commands'])
             else:
-                self.assertEqual(commands, result['commands'], result['commands'])
+                self.assertEqual(commands, result['commands'],
+                                 result['commands'])
 
         return result
 
     def failed(self):
-        with self.assertRaises(AnsibleFailJson) as exc:
-            self.module.main()
+        def fail_json(*args, **kwargs):
+            kwargs['failed'] = True
+            raise AnsibleFailJson(kwargs)
+
+        with patch.object(basic.AnsibleModule, 'fail_json', fail_json):
+            with self.assertRaises(AnsibleFailJson) as exc:
+                self.module.main()
 
         result = exc.exception.args[0]
         self.assertTrue(result['failed'], result)
         return result
 
     def changed(self, changed=False):
-        with self.assertRaises(AnsibleExitJson) as exc:
-            self.module.main()
+        def exit_json(*args, **kwargs):
+            if 'changed' not in kwargs:
+                kwargs['changed'] = False
+            raise AnsibleExitJson(kwargs)
+
+        with patch.object(basic.AnsibleModule, 'exit_json', exit_json):
+            with self.assertRaises(AnsibleExitJson) as exc:
+                self.module.main()
 
         result = exc.exception.args[0]
         self.assertEqual(result['changed'], changed, result)

test/units/modules/network/enos/fixtures/enos_config_config.cfg

@@ -0,0 +1,47 @@
+Current configuration:
+!
+version "8.4.3.12"
+switch-type "Lenovo RackSwitch G8272"
+iscli-new
+!
+!
+access https enable
+
+snmp-server location "Location:,Room:,Rack:Rack 3,LRU:40"
+snmp-server read-community "public"
+snmp-server trap-source 128
+!
+!
+!
+no system dhcp
+no system default-ip mgt
+hostname router
+!
+!
+!
+!interface ip 1
+!       addr <default>
+!       enable
+!
+interface ip 13
+        ip address 1.2.3.4 255.255.255.0
+        enable
+        exit
+!
+interface ip 128
+        ip address 10.241.105.24 255.255.255.0
+        enable
+        exit
+!
+ip gateway 4 address 10.241.105.1
+ip gateway 4 enable
+!
+!
+!
+!
+router bgp
+        as 100
+!
+!
+end
+

test/units/modules/network/enos/fixtures/enos_config_src.cfg

@@ -0,0 +1,6 @@
+!
+hostname foo
+!
+interface ip 13
+ no ip ospf enable
+!

test/units/modules/network/enos/test_enos_config.py

@@ -0,0 +1,125 @@
+#
+# (c) 2016 Red Hat Inc.
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import json
+
+from ansible.compat.tests.mock import patch
+from ansible.modules.network.enos import enos_config
+from .enos_module import TestEnosModule, load_fixture, set_module_args
+
+
+class TestEnosConfigModule(TestEnosModule):
+
+    module = enos_config
+
+    def setUp(self):
+        self.patcher_get_config = patch('ansible.modules.network.enos.enos_config.get_config')
+        self.mock_get_config = self.patcher_get_config.start()
+        self.patcher_exec_command = patch('ansible.modules.network.enos.enos_config.load_config')
+        self.mock_exec_command = self.patcher_exec_command.start()
+
+    def tearDown(self):
+        self.patcher_get_config.stop()
+        self.patcher_exec_command.stop()
+
+    def load_fixtures(self, commands=None):
+        config_file = 'enos_config_config.cfg'
+        self.mock_get_config.return_value = load_fixture(config_file)
+        self.mock_exec_command.return_value = 'dummy diff'
+
+    def test_enos_config_unchanged(self):
+        src = load_fixture('enos_config_config.cfg')
+        set_module_args(dict(src=src))
+        self.execute_module()
+
+    def test_enos_config_src(self):
+        src = load_fixture('enos_config_src.cfg')
+        set_module_args(dict(src=src))
+        commands = ['hostname foo', 'interface ip 13',
+                    'no ip ospf enable']
+        self.execute_module(changed=True, commands=commands)
+
+    def test_enos_config_backup(self):
+        set_module_args(dict(backup=True))
+        result = self.execute_module()
+        self.assertIn('__backup__', result)
+
+    def test_enos_config_lines_wo_parents(self):
+        set_module_args(dict(lines=['hostname foo']))
+        commands = ['hostname foo']
+        self.execute_module(changed=True, commands=commands)
+
+    def test_enos_config_lines_w_parents(self):
+        set_module_args(dict(lines=['shutdown'], parents=['interface ip 13']))
+        commands = ['interface ip 13', 'shutdown']
+        self.execute_module(changed=True, commands=commands)
+
+    def test_enos_config_before(self):
+        set_module_args(dict(lines=['hostname foo'], before=['test1', 'test2']))
+        commands = ['test1', 'test2', 'hostname foo']
+        self.execute_module(changed=True, commands=commands, sort=False)
+
+    def test_enos_config_after(self):
+        set_module_args(dict(lines=['hostname foo'], after=['test1', 'test2']))
+        commands = ['hostname foo', 'test1', 'test2']
+        self.execute_module(changed=True, commands=commands, sort=False)
+
+    def test_enos_config_before_after_no_change(self):
+        set_module_args(dict(lines=['hostname router'],
+                             before=['test1', 'test2'],
+                             after=['test3', 'test4']))
+        self.execute_module()
+
+    def test_enos_config_config(self):
+        config = 'hostname localhost'
+        set_module_args(dict(lines=['hostname router'], config=config))
+        commands = ['hostname router']
+        self.execute_module(changed=True, commands=commands)
+
+    def test_enos_config_replace_block(self):
+        lines = ['description test string', 'test string']
+        parents = ['interface ip 13']
+        set_module_args(dict(lines=lines, replace='block', parents=parents))
+        commands = parents + lines
+        self.execute_module(changed=True, commands=commands)
+
+    def test_enos_config_match_none(self):
+        lines = ['ip address 1.2.3.4 255.255.255.0', 'description test string']
+        parents = ['interface ip 13']
+        set_module_args(dict(lines=lines, parents=parents, match='none'))
+        commands = parents + lines
+        self.execute_module(changed=True, commands=commands, sort=False)
+
+    def test_enos_config_match_strict(self):
+        lines = ['ip address 1.2.3.4 255.255.255.0', 'exit']
+        parents = ['interface ip 13']
+        set_module_args(dict(lines=lines, parents=parents, match='strict'))
+        commands = parents + ['exit']
+        self.execute_module(changed=True, commands=commands, sort=False)
+
+    def test_enos_config_match_exact(self):
+        lines = ['ip address 1.2.3.4 255.255.255.0', 'description test string',
+                 'shutdown']
+        parents = ['interface ip 13']
+        set_module_args(dict(lines=lines, parents=parents, match='exact'))
+        commands = parents + lines
+        self.execute_module(changed=True, commands=commands, sort=False)