updates eos modules to use socket (#21197)

* updates eos modules to use persistent connection socket
* removes split eos shared module and combines into one
* adds singular eos doc frag (eos_local to be removed after module updates)
* updates unit test cases

test/units/modules/network/eos/eos_module.py

@@ -0,0 +1,113 @@
+# (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 os
+import json
+
+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 = {}
+
+def load_fixture(name):
+    path = os.path.join(fixture_path, name)
+
+    if path in fixture_data:
+        return fixture_data[path]
+
+    with open(path) as f:
+        data = f.read()
+
+    try:
+        data = json.loads(data)
+    except:
+        pass
+
+    fixture_data[path] = data
+    return data
+
+
+class AnsibleExitJson(Exception):
+    pass
+
+class AnsibleFailJson(Exception):
+    pass
+
+class TestEosModule(unittest.TestCase):
+
+    def execute_module(self, failed=False, changed=False, commands=None,
+            sort=True, defaults=False):
+
+        self.load_fixtures(commands)
+
+        if failed:
+            result = self.failed()
+            self.assertTrue(result['failed'], result)
+        else:
+            result = self.changed(changed)
+            self.assertEqual(result['changed'], changed, result)
+
+        if commands:
+            if sort:
+                self.assertEqual(sorted(commands), sorted(result['commands']), result['commands'])
+            else:
+                self.assertEqual(commands, result['commands'], result['commands'])
+
+        return result
+
+    def failed(self):
+        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):
+        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)
+        return result
+
+    def load_fixtures(self, commands=None):
+        pass
+

test/units/modules/network/eos/test_eos_banner.py

@@ -17,43 +17,16 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-import os
 import json
 
-from ansible.compat.tests import unittest
-from ansible.compat.tests.mock import patch, MagicMock
-from ansible.errors import AnsibleModuleExit
+from ansible.compat.tests.mock import patch
 from ansible.modules.network.eos import eos_banner
-from ansible.module_utils import basic
-from ansible.module_utils._text import to_bytes
+from .eos_module import TestEosModule, load_fixture, set_module_args
 
 
-def set_module_args(args):
-    args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
-    basic._ANSIBLE_ARGS = to_bytes(args)
+class TestEosBannerModule(TestEosModule):
 
-fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
-fixture_data = {}
-
-def load_fixture(name):
-    path = os.path.join(fixture_path, name)
-
-    if path in fixture_data:
-        return fixture_data[path]
-
-    with open(path) as f:
-        data = f.read()
-
-    try:
-        data = json.loads(data)
-    except:
-        pass
-
-    fixture_data[path] = data
-    return data
-
-
-class TestEosBannerModule(unittest.TestCase):
+    module = eos_banner
 
     def setUp(self):
         self.mock_run_commands = patch('ansible.modules.network.eos.eos_banner.run_commands')
@@ -66,29 +39,10 @@ class TestEosBannerModule(unittest.TestCase):
         self.mock_run_commands.stop()
         self.mock_load_config.stop()
 
-    def execute_module(self, failed=False, changed=False, commands=None, sort=True):
-
+    def load_fixtures(self, commands=None):
         self.run_commands.return_value = load_fixture('eos_banner_show_banner.txt').strip()
         self.load_config.return_value = dict(diff=None, session='session')
 
-        with self.assertRaises(AnsibleModuleExit) as exc:
-            eos_banner.main()
-
-        result = exc.exception.result
-
-        if failed:
-            self.assertTrue(result['failed'], result)
-        else:
-            self.assertEqual(result['changed'], changed, result)
-
-        if commands:
-            if sort:
-                self.assertEqual(sorted(commands), sorted(result['commands']), result['commands'])
-            else:
-                self.assertEqual(commands, result['commands'])
-
-        return result
-
     def test_eos_banner_create(self):
         set_module_args(dict(banner='login', text='test\nbanner\nstring'))
         commands = ['banner login', 'test', 'banner', 'string', 'EOF']

test/units/modules/network/eos/test_eos_command.py

@@ -19,43 +19,15 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-import os
 import json
 
-from ansible.compat.tests import unittest
-from ansible.compat.tests.mock import patch, MagicMock
-from ansible.errors import AnsibleModuleExit
+from ansible.compat.tests.mock import patch
 from ansible.modules.network.eos import eos_command
-from ansible.module_utils import basic
-from ansible.module_utils._text import to_bytes
+from .eos_module import TestEosModule, load_fixture, set_module_args
 
+class TestEosCommandModule(TestEosModule):
 
-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 = {}
-
-def load_fixture(name):
-    path = os.path.join(fixture_path, name)
-
-    if path in fixture_data:
-        return fixture_data[path]
-
-    with open(path) as f:
-        data = f.read()
-
-    try:
-        data = json.loads(data)
-    except:
-        pass
-
-    fixture_data[path] = data
-    return data
-
-
-class test_EosCommandModule(unittest.TestCase):
+    module = eos_command
 
     def setUp(self):
         self.mock_run_commands = patch('ansible.modules.network.eos.eos_command.run_commands')
@@ -64,8 +36,7 @@ class test_EosCommandModule(unittest.TestCase):
     def tearDown(self):
         self.mock_run_commands.stop()
 
-    def execute_module(self, failed=False, changed=False):
-
+    def load_fixtures(self, commands=None):
         def load_from_file(*args, **kwargs):
             module, commands = args
             output = list()
@@ -83,18 +54,6 @@ class test_EosCommandModule(unittest.TestCase):
 
         self.run_commands.side_effect = load_from_file
 
-        with self.assertRaises(AnsibleModuleExit) as exc:
-            eos_command.main()
-
-        result = exc.exception.result
-
-        if failed:
-            self.assertTrue(result.get('failed'))
-        else:
-            self.assertEqual(result.get('changed'), changed, result)
-
-        return result
-
     def test_eos_command_simple(self):
         set_module_args(dict(commands=['show version']))
         result = self.execute_module()

test/units/modules/network/eos/test_eos_config.py

@@ -21,50 +21,16 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-import os
-import sys
 import json
 
-from ansible.compat.tests import unittest
-from ansible.compat.tests.mock import patch, MagicMock
-from ansible.errors import AnsibleModuleExit
+from ansible.compat.tests.mock import patch
 from ansible.modules.network.eos import eos_config
-from ansible.module_utils.netcfg import NetworkConfig
-from ansible.module_utils import basic
-from ansible.module_utils._text import to_bytes
-
-PROVIDER_ARGS = {
-    'host': 'localhost',
-    'username': 'username',
-    'password': 'password'
-}
-
-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 = {}
-
-def load_fixture(name):
-    path = os.path.join(fixture_path, name)
-
-    if path in fixture_data:
-        return fixture_data[path]
-
-    with open(path) as f:
-        data = f.read()
-
-    try:
-        data = json.loads(data)
-    except:
-        pass
-
-    fixture_data[path] = data
-    return data
+from .eos_module import TestEosModule, load_fixture, set_module_args
 
 
-class TestEosConfigModule(unittest.TestCase):
+class TestEosConfigModule(TestEosModule):
+
+    module = eos_config
 
     def setUp(self):
         self.mock_get_config = patch('ansible.modules.network.eos.eos_config.get_config')
@@ -73,40 +39,21 @@ class TestEosConfigModule(unittest.TestCase):
         self.mock_load_config = patch('ansible.modules.network.eos.eos_config.load_config')
         self.load_config = self.mock_load_config.start()
 
-        self.mock_supports_sessions = patch('ansible.modules.network.eos.eos_config.supports_sessions')
-        self.supports_sessions = self.mock_supports_sessions.start()
-        self.supports_sessions.return_value = True
-
     def tearDown(self):
         self.mock_get_config.stop()
         self.mock_load_config.stop()
 
-    def execute_module(self, failed=False, changed=False):
-
+    def load_fixtures(self, commands=None):
         self.get_config.return_value = load_fixture('eos_config_config.cfg')
         self.load_config.return_value = dict(diff=None, session='session')
 
-        with self.assertRaises(AnsibleModuleExit) as exc:
-            eos_config.main()
-
-        result = exc.exception.result
-
-        if failed:
-            self.assertTrue(result.get('failed'))
-        else:
-            self.assertEqual(result.get('changed'), changed, result)
-
-        return result
-
     def test_eos_config_no_change(self):
         args = dict(lines=['hostname localhost'])
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
         result = self.execute_module()
 
     def test_eos_config_src(self):
         args = dict(src=load_fixture('eos_config_candidate.cfg'))
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
 
         result = self.execute_module(changed=True)
@@ -117,7 +64,6 @@ class TestEosConfigModule(unittest.TestCase):
 
     def test_eos_config_lines(self):
         args = dict(lines=['hostname switch01', 'ip domain-name eng.ansible.com'])
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
 
         result = self.execute_module(changed=True)
@@ -129,7 +75,6 @@ class TestEosConfigModule(unittest.TestCase):
         args = dict(lines=['hostname switch01', 'ip domain-name eng.ansible.com'],
                      before=['before command'])
 
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
 
         result = self.execute_module(changed=True)
@@ -142,7 +87,6 @@ class TestEosConfigModule(unittest.TestCase):
         args = dict(lines=['hostname switch01', 'ip domain-name eng.ansible.com'],
                      after=['after command'])
 
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
 
         result = self.execute_module(changed=True)
@@ -153,7 +97,6 @@ class TestEosConfigModule(unittest.TestCase):
 
     def test_eos_config_parents(self):
         args = dict(lines=['ip address 1.2.3.4/5', 'no shutdown'], parents=['interface Ethernet10'])
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
 
         result = self.execute_module(changed=True)
@@ -163,37 +106,31 @@ class TestEosConfigModule(unittest.TestCase):
 
     def test_eos_config_src_and_lines_fails(self):
         args = dict(src='foo', lines='foo')
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
         result = self.execute_module(failed=True)
 
     def test_eos_config_match_exact_requires_lines(self):
         args = dict(match='exact')
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
         result = self.execute_module(failed=True)
 
     def test_eos_config_match_strict_requires_lines(self):
         args = dict(match='strict')
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
         result = self.execute_module(failed=True)
 
     def test_eos_config_replace_block_requires_lines(self):
         args = dict(replace='block')
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
         result = self.execute_module(failed=True)
 
     def test_eos_config_replace_config_requires_src(self):
         args = dict(replace='config')
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
         result = self.execute_module(failed=True)
 
     def test_eos_config_backup_returns__backup__(self):
         args = dict(backup=True)
-        args.update(PROVIDER_ARGS)
         set_module_args(args)
         result = self.execute_module()
         self.assertIn('__backup__', result)

test/units/modules/network/eos/test_eos_eapi.py

@@ -21,45 +21,16 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-import os
 import json
 
-import ansible.module_utils.basic
-
-from ansible.compat.tests import unittest
-from ansible.compat.tests.mock import patch, MagicMock
-from ansible.errors import AnsibleModuleExit
+from ansible.compat.tests.mock import patch
 from ansible.modules.network.eos import eos_eapi
-from ansible.module_utils import basic
-from ansible.module_utils._text import to_bytes
+from .eos_module import TestEosModule, load_fixture, set_module_args
 
 
-def set_module_args(args):
-    args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
-    basic._ANSIBLE_ARGS = to_bytes(args)
+class TestEosEapiModule(TestEosModule):
 
-fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
-fixture_data = {}
-
-def load_fixture(name):
-    path = os.path.join(fixture_path, name)
-
-    if path in fixture_data:
-        return fixture_data[path]
-
-    with open(path) as f:
-        data = f.read()
-
-    try:
-        data = json.loads(data)
-    except:
-        pass
-
-    fixture_data[path] = data
-    return data
-
-
-class TestEosEapiModule(unittest.TestCase):
+    module = eos_eapi
 
     def setUp(self):
         self.mock_run_commands = patch('ansible.modules.network.eos.eos_eapi.run_commands')
@@ -68,54 +39,34 @@ class TestEosEapiModule(unittest.TestCase):
         self.mock_load_config = patch('ansible.modules.network.eos.eos_eapi.load_config')
         self.load_config = self.mock_load_config.start()
 
+        self.command_fixtures = {}
+
     def tearDown(self):
         self.mock_run_commands.stop()
         self.mock_load_config.stop()
 
-    def execute_module(self, failed=False, changed=False, commands=None,
-            sort=True, command_fixtures={}):
-
+    def load_fixtures(self, commands=None):
         def run_commands(module, commands, **kwargs):
             output = list()
             for cmd in commands:
-                output.append(load_fixture(command_fixtures[cmd]))
+                output.append(load_fixture(self.command_fixtures[cmd]))
             return (0, output, '')
 
         self.run_commands.side_effect = run_commands
         self.load_config.return_value = dict(diff=None, session='session')
 
-        with self.assertRaises(AnsibleModuleExit) as exc:
-            eos_eapi.main()
-
-        result = exc.exception.result
-
-        if failed:
-            self.assertTrue(result.get('failed'), result)
-        else:
-            self.assertEqual(result.get('changed'), changed, result)
-
-        if commands:
-            if sort:
-                self.assertEqual(sorted(commands), sorted(result['commands']), result['commands'])
-            else:
-                self.assertEqual(commands, result['commands'])
-
-        return result
-
     def start_configured(self, *args, **kwargs):
-        command_fixtures = {
+        self.command_fixtures = {
             'show vrf': 'eos_eapi_show_vrf.text',
             'show management api http-commands | json': 'eos_eapi_show_mgmt.json'
         }
-        kwargs['command_fixtures'] = command_fixtures
         return self.execute_module(*args, **kwargs)
 
     def start_unconfigured(self, *args, **kwargs):
-        command_fixtures = {
+        self.command_fixtures = {
             'show vrf': 'eos_eapi_show_vrf.text',
             'show management api http-commands | json': 'eos_eapi_show_mgmt_unconfigured.json'
         }
-        kwargs['command_fixtures'] = command_fixtures
         return self.execute_module(*args, **kwargs)
 
     def test_eos_eapi_http_enable(self):

test/units/modules/network/eos/test_eos_system.py

@@ -21,44 +21,15 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-import os
 import json
 
-import ansible.module_utils.basic
-
-from ansible.compat.tests import unittest
-from ansible.compat.tests.mock import patch, MagicMock
-from ansible.errors import AnsibleModuleExit
+from ansible.compat.tests.mock import patch
 from ansible.modules.network.eos import eos_system
-from ansible.module_utils import basic
-from ansible.module_utils._text import to_bytes
+from .eos_module import TestEosModule, load_fixture, set_module_args
 
-def set_module_args(args):
-    args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
-    basic._ANSIBLE_ARGS = to_bytes(args)
+class TestEosSystemModule(TestEosModule):
 
-fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
-fixture_data = {}
-
-def load_fixture(name):
-    path = os.path.join(fixture_path, name)
-
-    if path in fixture_data:
-        return fixture_data[path]
-
-    with open(path) as f:
-        data = f.read()
-
-    try:
-        data = json.loads(data)
-    except:
-        pass
-
-    fixture_data[path] = data
-    return data
-
-
-class TestEosSystemModule(unittest.TestCase):
+    module = eos_system
 
     def setUp(self):
         self.mock_get_config = patch('ansible.modules.network.eos.eos_system.get_config')
@@ -71,29 +42,10 @@ class TestEosSystemModule(unittest.TestCase):
         self.mock_get_config.stop()
         self.mock_load_config.stop()
 
-    def execute_module(self, failed=False, changed=False, commands=None, sort=True):
-
+    def load_fixtures(self, commands=None):
         self.get_config.return_value = load_fixture('eos_system_config.cfg')
         self.load_config.return_value = dict(diff=None, session='session')
 
-        with self.assertRaises(AnsibleModuleExit) as exc:
-            eos_system.main()
-
-        result = exc.exception.result
-
-        if failed:
-            self.assertTrue(result['failed'], result)
-        else:
-            self.assertEqual(result['changed'], changed, result)
-
-        if commands:
-            if sort:
-                self.assertEqual(sorted(commands), sorted(result['commands']), result['commands'])
-            else:
-                self.assertEqual(commands, result['commands'])
-
-        return result
-
     def test_eos_system_hostname_changed(self):
         set_module_args(dict(hostname='foo'))
         commands = ['hostname foo']

test/units/modules/network/eos/test_eos_user.py

@@ -17,43 +17,16 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-import os
 import json
 
-from ansible.compat.tests import unittest
-from ansible.compat.tests.mock import patch, MagicMock
-from ansible.errors import AnsibleModuleExit
+from ansible.compat.tests.mock import patch
 from ansible.modules.network.eos import eos_user
-from ansible.module_utils import basic
-from ansible.module_utils._text import to_bytes
+from .eos_module import TestEosModule, load_fixture, set_module_args
 
 
-def set_module_args(args):
-    args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
-    basic._ANSIBLE_ARGS = to_bytes(args)
+class TestEosUserModule(TestEosModule):
 
-fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
-fixture_data = {}
-
-def load_fixture(name):
-    path = os.path.join(fixture_path, name)
-
-    if path in fixture_data:
-        return fixture_data[path]
-
-    with open(path) as f:
-        data = f.read()
-
-    try:
-        data = json.loads(data)
-    except:
-        pass
-
-    fixture_data[path] = data
-    return data
-
-
-class TestEosUserModule(unittest.TestCase):
+    module = eos_user
 
     def setUp(self):
         self.mock_get_config = patch('ansible.modules.network.eos.eos_user.get_config')
@@ -66,29 +39,10 @@ class TestEosUserModule(unittest.TestCase):
         self.mock_get_config.stop()
         self.mock_load_config.stop()
 
-    def execute_module(self, failed=False, changed=False, commands=None, sort=True):
-
+    def load_fixtures(self, commands=None):
         self.get_config.return_value = load_fixture('eos_user_config.cfg')
         self.load_config.return_value = dict(diff=None, session='session')
 
-        with self.assertRaises(AnsibleModuleExit) as exc:
-            eos_user.main()
-
-        result = exc.exception.result
-
-        if failed:
-            self.assertTrue(result['failed'], result)
-        else:
-            self.assertEqual(result['changed'], changed, result)
-
-        if commands:
-            if sort:
-                self.assertEqual(sorted(commands), sorted(result['commands']), result['commands'])
-            else:
-                self.assertEqual(commands, result['commands'])
-
-        return result
-
     def test_eos_user_create(self):
         set_module_args(dict(username='test', nopassword=True))
         commands = ['username test nopassword']
@@ -101,7 +55,7 @@ class TestEosUserModule(unittest.TestCase):
 
     def test_eos_user_password(self):
         set_module_args(dict(username='ansible', password='test'))
-        commands = ['username ansible secret ********']
+        commands = ['username ansible secret test']
         self.execute_module(changed=True, commands=commands)
 
     def test_eos_user_privilege(self):
@@ -130,17 +84,16 @@ class TestEosUserModule(unittest.TestCase):
 
     def test_eos_user_update_password_changed(self):
         set_module_args(dict(username='test', password='test', update_password='on_create'))
-        commands = ['username ******** secret ********']
+        commands = ['username test secret test']
         self.execute_module(changed=True, commands=commands)
 
     def test_eos_user_update_password_on_create_ok(self):
         set_module_args(dict(username='ansible', password='test', update_password='on_create'))
-        commands = []
-        self.execute_module(commands=commands)
+        self.execute_module()
 
     def test_eos_user_update_password_always(self):
         set_module_args(dict(username='ansible', password='test', update_password='always'))
-        commands = ['username ansible secret ********']
+        commands = ['username ansible secret test']
         self.execute_module(changed=True, commands=commands)