nxos cliconf plugin refactor (#43203)

* nxos cliconf plugin refactor

Fixes #39056

*  Refactor nxos cliconf plugin as per new api definition
*  Minor changes in ios, eos, vyos cliconf plugin
*  Change nxos httpapi plugin edit_config method to be in sync with
   nxos cliconf edit_config

* Fix CI failure

* Fix unit test failure and review comment

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

@@ -21,7 +21,7 @@ __metaclass__ = type
 
 from ansible.compat.tests.mock import patch, MagicMock
 from ansible.modules.network.eos import eos_config
-from ansible.plugins.cliconf.ios import Cliconf
+from ansible.plugins.cliconf.eos import Cliconf
 from units.modules.utils import set_module_args
 from .eos_module import TestEosModule, load_fixture
 
@@ -43,6 +43,10 @@ class TestEosConfigModule(TestEosModule):
         self.mock_run_commands = patch('ansible.modules.network.eos.eos_config.run_commands')
         self.run_commands = self.mock_run_commands.start()
 
+        self.mock_supports_sessions = patch('ansible.plugins.cliconf.eos.Cliconf.supports_sessions')
+        self.supports_sessions = self.mock_supports_sessions.start()
+        self.mock_supports_sessions.return_value = True
+
         self.conn = self.get_connection()
         self.conn.edit_config = MagicMock()
 
@@ -54,6 +58,7 @@ class TestEosConfigModule(TestEosModule):
         self.mock_get_config.stop()
         self.mock_load_config.stop()
         self.mock_get_connection.stop()
+        self.mock_supports_sessions.stop()
 
     def load_fixtures(self, commands=None, transport='cli'):
         self.get_config.return_value = load_fixture('eos_config_config.cfg')

test/units/modules/network/ios/test_ios_config.py

@@ -177,7 +177,7 @@ class TestIosConfigModule(TestIosModule):
         module.params = {'lines': lines, 'parents': parents, 'src': None}
         candidate_config = ios_config.get_candidate_config(module)
 
-        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(candidate_config, self.running_config, replace='block', path=parents))
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(candidate_config, self.running_config, diff_replace='block', path=parents))
 
         commands = parents + lines
         self.execute_module(changed=True, commands=commands)
@@ -185,7 +185,7 @@ class TestIosConfigModule(TestIosModule):
     def test_ios_config_match_none(self):
         lines = ['hostname router']
         set_module_args(dict(lines=lines, match='none'))
-        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff('\n'.join(lines), self.running_config, match='none'))
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff('\n'.join(lines), self.running_config, diff_match='none'))
         self.execute_module(changed=True, commands=lines)
 
     def test_ios_config_match_none(self):
@@ -196,7 +196,7 @@ class TestIosConfigModule(TestIosModule):
         module = MagicMock()
         module.params = {'lines': lines, 'parents': parents, 'src': None}
         candidate_config = ios_config.get_candidate_config(module)
-        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(candidate_config, self.running_config, match='none', path=parents))
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(candidate_config, self.running_config, diff_match='none', path=parents))
 
         commands = parents + lines
         self.execute_module(changed=True, commands=commands, sort=False)
@@ -210,7 +210,7 @@ class TestIosConfigModule(TestIosModule):
         module = MagicMock()
         module.params = {'lines': lines, 'parents': parents, 'src': None}
         candidate_config = ios_config.get_candidate_config(module)
-        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(candidate_config, self.running_config, match='strict', path=parents))
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(candidate_config, self.running_config, diff_match='strict', path=parents))
 
         commands = parents + ['shutdown']
         self.execute_module(changed=True, commands=commands, sort=False)
@@ -224,7 +224,7 @@ class TestIosConfigModule(TestIosModule):
         module = MagicMock()
         module.params = {'lines': lines, 'parents': parents, 'src': None}
         candidate_config = ios_config.get_candidate_config(module)
-        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(candidate_config, self.running_config, match='exact', path=parents))
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(candidate_config, self.running_config, diff_match='exact', path=parents))
 
         commands = parents + lines
         self.execute_module(changed=True, commands=commands, sort=False)

test/units/modules/network/nxos/test_nxos_config.py

@@ -19,8 +19,9 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-from ansible.compat.tests.mock import patch
+from ansible.compat.tests.mock import patch, MagicMock
 from ansible.modules.network.nxos import nxos_config
+from ansible.plugins.cliconf.nxos import Cliconf
 from .nxos_module import TestNxosModule, load_fixture, set_module_args
 
 
@@ -44,23 +45,41 @@ class TestNxosConfigModule(TestNxosModule):
         self.mock_save_config = patch('ansible.modules.network.nxos.nxos_config.save_config')
         self.save_config = self.mock_save_config.start()
 
+        self.mock_get_connection = patch('ansible.modules.network.nxos.nxos_config.get_connection')
+        self.get_connection = self.mock_get_connection.start()
+
+        self.conn = self.get_connection()
+        self.conn.edit_config = MagicMock()
+
+        self.mock_run_commands = patch('ansible.modules.network.nxos.nxos_config.run_commands')
+        self.run_commands = self.mock_run_commands.start()
+
+        self.cliconf_obj = Cliconf(MagicMock())
+        self.running_config = load_fixture('nxos_config', 'config.cfg')
+
     def tearDown(self):
         super(TestNxosConfigModule, self).tearDown()
         self.mock_get_config.stop()
         self.mock_load_config.stop()
         self.mock_get_capabilities.stop()
+        self.mock_run_commands.stop()
+        self.mock_get_connection.stop()
 
     def load_fixtures(self, commands=None, device=''):
         self.get_config.return_value = load_fixture('nxos_config', 'config.cfg')
         self.load_config.return_value = None
 
     def test_nxos_config_no_change(self):
-        args = dict(lines=['hostname localhost'])
+        lines = ['hostname localhost']
+        args = dict(lines=lines)
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff('\n'.join(lines), self.running_config))
         set_module_args(args)
         result = self.execute_module()
 
     def test_nxos_config_src(self):
-        args = dict(src=load_fixture('nxos_config', 'candidate.cfg'))
+        src = load_fixture('nxos_config', 'candidate.cfg')
+        args = dict(src=src)
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(src, self.running_config))
         set_module_args(args)
 
         result = self.execute_module(changed=True)
@@ -71,11 +90,14 @@ class TestNxosConfigModule(TestNxosModule):
 
     def test_nxos_config_replace_src(self):
         set_module_args(dict(replace_src='config.txt', replace='config'))
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(self.running_config, self.running_config, diff_replace='config'))
         result = self.execute_module(changed=True)
         self.assertEqual(result['commands'], ['config replace config.txt'])
 
     def test_nxos_config_lines(self):
-        args = dict(lines=['hostname switch01', 'ip domain-name eng.ansible.com'])
+        lines = ['hostname switch01', 'ip domain-name eng.ansible.com']
+        args = dict(lines=lines)
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff('\n'.join(lines), self.running_config))
         set_module_args(args)
 
         result = self.execute_module(changed=True)
@@ -84,9 +106,10 @@ class TestNxosConfigModule(TestNxosModule):
         self.assertEqual(sorted(config), sorted(result['commands']), result['commands'])
 
     def test_nxos_config_before(self):
-        args = dict(lines=['hostname switch01', 'ip domain-name eng.ansible.com'],
+        lines = ['hostname switch01', 'ip domain-name eng.ansible.com']
+        args = dict(lines=lines,
                     before=['before command'])
-
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff('\n'.join(lines), self.running_config))
         set_module_args(args)
 
         result = self.execute_module(changed=True)
@@ -96,9 +119,11 @@ class TestNxosConfigModule(TestNxosModule):
         self.assertEqual('before command', result['commands'][0])
 
     def test_nxos_config_after(self):
-        args = dict(lines=['hostname switch01', 'ip domain-name eng.ansible.com'],
+        lines = ['hostname switch01', 'ip domain-name eng.ansible.com']
+        args = dict(lines=lines,
                     after=['after command'])
 
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff('\n'.join(lines), self.running_config))
         set_module_args(args)
 
         result = self.execute_module(changed=True)
@@ -108,7 +133,10 @@ class TestNxosConfigModule(TestNxosModule):
         self.assertEqual('after command', result['commands'][-1])
 
     def test_nxos_config_parents(self):
-        args = dict(lines=['ip address 1.2.3.4/5', 'no shutdown'], parents=['interface Ethernet10'])
+        lines = ['ip address 1.2.3.4/5', 'no shutdown']
+        parents = ['interface Ethernet10']
+        args = dict(lines=lines, parents=parents)
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff('\n'.join(parents + lines), self.running_config, path=parents))
         set_module_args(args)
 
         result = self.execute_module(changed=True)

test/units/modules/network/vyos/test_vyos_config.py

@@ -113,5 +113,5 @@ class TestVyosConfigModule(TestVyosModule):
                  'set system interfaces ethernet eth0 description test string']
         set_module_args(dict(lines=lines, match='none'))
         candidate = '\n'.join(lines)
-        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(candidate, None, match='none'))
+        self.conn.get_diff = MagicMock(return_value=self.cliconf_obj.get_diff(candidate, None, diff_match='none'))
         self.execute_module(changed=True, commands=lines, sort=False)