mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
updates vyos modules to use socket connection (#21228)
* updates all vyos modules to use socket connection * adds vyos local action handler * adds exec_command() to vyos * updates vyos_config local action * update unit test cases * add base class for testing vyos modules
This commit is contained in:
Peter Sprygada
Nathaniel Case
parent
85194234ba
commit
8adb108aa9
14 changed files with 426 additions and 547 deletions
|
|
@ -19,45 +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.vyos import vyos_command
|
||||
from ansible.module_utils import basic
|
||||
from ansible.module_utils._text import to_bytes
|
||||
from .vyos_module import TestVyosModule, load_fixture, set_module_args
|
||||
|
||||
class TestVyosCommandModule(TestVyosModule):
|
||||
|
||||
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
|
||||
fixture_data = {}
|
||||
|
||||
|
||||
def set_module_args(args):
|
||||
args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
|
||||
basic._ANSIBLE_ARGS = to_bytes(args)
|
||||
|
||||
|
||||
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 TestVyosCommandModule(unittest.TestCase):
|
||||
module = vyos_command
|
||||
|
||||
def setUp(self):
|
||||
self.mock_run_commands = patch('ansible.modules.network.vyos.vyos_command.run_commands')
|
||||
|
|
@ -66,8 +36,7 @@ class TestVyosCommandModule(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()
|
||||
|
|
@ -84,18 +53,6 @@ class TestVyosCommandModule(unittest.TestCase):
|
|||
|
||||
self.run_commands.side_effect = load_from_file
|
||||
|
||||
with self.assertRaises(AnsibleModuleExit) as exc:
|
||||
vyos_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_vyos_command_simple(self):
|
||||
set_module_args(dict(commands=['show version']))
|
||||
result = self.execute_module()
|
||||
|
|
|
|||
|
|
@ -20,45 +20,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.vyos import vyos_config
|
||||
from ansible.module_utils import basic
|
||||
from ansible.module_utils._text import to_bytes
|
||||
from .vyos_module import TestVyosModule, load_fixture, set_module_args
|
||||
|
||||
|
||||
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
|
||||
fixture_data = {}
|
||||
class TestVyosConfigModule(TestVyosModule):
|
||||
|
||||
|
||||
def set_module_args(args):
|
||||
args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
|
||||
basic._ANSIBLE_ARGS = to_bytes(args)
|
||||
|
||||
|
||||
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 TestVyosConfigModule(unittest.TestCase):
|
||||
module = vyos_config
|
||||
|
||||
def setUp(self):
|
||||
self.mock_get_config = patch('ansible.modules.network.vyos.vyos_config.get_config')
|
||||
|
|
@ -75,30 +46,11 @@ class TestVyosConfigModule(unittest.TestCase):
|
|||
self.mock_load_config.stop()
|
||||
self.mock_run_commands.stop()
|
||||
|
||||
def execute_module(self, failed=False, changed=False, commands=None, sort=True, defaults=False):
|
||||
|
||||
config_file = 'vyos_config_defaults.cfg' if defaults else 'vyos_config_config.cfg'
|
||||
def load_fixtures(self, commands=None):
|
||||
config_file = 'vyos_config_config.cfg'
|
||||
self.get_config.return_value = load_fixture(config_file)
|
||||
self.load_config.return_value = None
|
||||
|
||||
with self.assertRaises(AnsibleModuleExit) as exc:
|
||||
vyos_config.main()
|
||||
|
||||
result = exc.exception.result
|
||||
|
||||
if failed:
|
||||
self.assertTrue(result['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'], result['commands'])
|
||||
|
||||
return result
|
||||
|
||||
def test_vyos_config_unchanged(self):
|
||||
src = load_fixture('vyos_config_config.cfg')
|
||||
set_module_args(dict(src=src))
|
||||
|
|
|
|||
|
|
@ -19,45 +19,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.vyos import vyos_facts
|
||||
from ansible.module_utils import basic
|
||||
from ansible.module_utils._text import to_bytes
|
||||
from .vyos_module import TestVyosModule, load_fixture, set_module_args
|
||||
|
||||
|
||||
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
|
||||
fixture_data = {}
|
||||
class TestVyosFactsModule(TestVyosModule):
|
||||
|
||||
|
||||
def set_module_args(args):
|
||||
args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
|
||||
basic._ANSIBLE_ARGS = to_bytes(args)
|
||||
|
||||
|
||||
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 TestVyosFactsModule(unittest.TestCase):
|
||||
module = vyos_facts
|
||||
|
||||
def setUp(self):
|
||||
self.mock_run_commands = patch('ansible.modules.network.vyos.vyos_facts.run_commands')
|
||||
|
|
@ -66,8 +37,7 @@ class TestVyosFactsModule(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()
|
||||
|
|
@ -84,18 +54,6 @@ class TestVyosFactsModule(unittest.TestCase):
|
|||
|
||||
self.run_commands.side_effect = load_from_file
|
||||
|
||||
with self.assertRaises(AnsibleModuleExit) as exc:
|
||||
vyos_facts.main()
|
||||
|
||||
result = exc.exception.result
|
||||
|
||||
if failed:
|
||||
self.assertTrue(result.get('failed'))
|
||||
else:
|
||||
self.assertEqual(result.get('changed'), changed, result)
|
||||
|
||||
return result
|
||||
|
||||
def test_vyos_facts_default(self):
|
||||
set_module_args(dict(gather_subset='default'))
|
||||
result = self.execute_module()
|
||||
|
|
|
|||
|
|
@ -21,46 +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.vyos import vyos_system
|
||||
from ansible.module_utils._text import to_bytes
|
||||
from ansible.module_utils import basic
|
||||
from .vyos_module import TestVyosModule, load_fixture, set_module_args
|
||||
|
||||
|
||||
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
|
||||
fixture_data = {}
|
||||
class TestVyosSystemModule(TestVyosModule):
|
||||
|
||||
|
||||
def set_module_args(args):
|
||||
json_args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
|
||||
basic._ANSIBLE_ARGS = to_bytes(json_args)
|
||||
|
||||
|
||||
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 TestVyosSystemModule(unittest.TestCase):
|
||||
module = vyos_system
|
||||
|
||||
def setUp(self):
|
||||
self.mock_get_config = patch('ansible.modules.network.vyos.vyos_system.get_config')
|
||||
|
|
@ -73,69 +43,44 @@ class TestVyosSystemModule(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('vyos_config_config.cfg')
|
||||
|
||||
with self.assertRaises(AnsibleModuleExit) as exc:
|
||||
vyos_system.main()
|
||||
|
||||
result = exc.exception.result
|
||||
|
||||
if failed:
|
||||
self.assertTrue(result['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'], result['commands'])
|
||||
|
||||
return result
|
||||
|
||||
def test_vyos_system_hostname(self):
|
||||
set_module_args(dict(host_name='foo'))
|
||||
result = self.execute_module(changed=True)
|
||||
self.assertIn("set system host-name 'foo'", result['commands'])
|
||||
self.assertEqual(1, len(result['commands']))
|
||||
commands = ["set system host-name 'foo'"]
|
||||
self.execute_module(changed=True, commands=commands)
|
||||
|
||||
def test_vyos_system_clear_hostname(self):
|
||||
set_module_args(dict(host_name='foo', state='absent'))
|
||||
result = self.execute_module(changed=True)
|
||||
self.assertIn('delete system host-name', result['commands'])
|
||||
self.assertEqual(1, len(result['commands']))
|
||||
commands = ["delete system host-name"]
|
||||
self.execute_module(changed=True, commands=commands)
|
||||
|
||||
def test_vyos_remove_single_name_server(self):
|
||||
set_module_args(dict(name_server=['8.8.4.4'], state='absent'))
|
||||
result = self.execute_module(changed=True)
|
||||
self.assertIn("delete system name-server '8.8.4.4'", result['commands'])
|
||||
self.assertEqual(1, len(result['commands']))
|
||||
commands = ["delete system name-server '8.8.4.4'"]
|
||||
self.execute_module(changed=True, commands=commands)
|
||||
|
||||
def test_vyos_system_domain_name(self):
|
||||
set_module_args(dict(domain_name='example2.com'))
|
||||
result = self.execute_module(changed=True)
|
||||
self.assertIn("set system domain-name 'example2.com'", result['commands'])
|
||||
self.assertEqual(1, len(result['commands']))
|
||||
commands = ["set system domain-name 'example2.com'"]
|
||||
self.execute_module(changed=True, commands=commands)
|
||||
|
||||
def test_vyos_system_clear_domain_name(self):
|
||||
set_module_args(dict(domain_name='example.com', state='absent'))
|
||||
result = self.execute_module(changed=True)
|
||||
self.assertIn('delete system domain-name', result['commands'])
|
||||
self.assertEqual(1, len(result['commands']))
|
||||
commands = ['delete system domain-name']
|
||||
self.execute_module(changed=True, commands=commands)
|
||||
|
||||
def test_vyos_system_domain_search(self):
|
||||
set_module_args(dict(domain_search=['foo.example.com', 'bar.example.com']))
|
||||
result = self.execute_module(changed=True)
|
||||
self.assertIn("set system domain-search domain 'foo.example.com'", result['commands'])
|
||||
self.assertIn("set system domain-search domain 'bar.example.com'", result['commands'])
|
||||
self.assertEqual(2, len(result['commands']))
|
||||
commands = ["set system domain-search domain 'foo.example.com'",
|
||||
"set system domain-search domain 'bar.example.com'"]
|
||||
self.execute_module(changed=True, commands=commands)
|
||||
|
||||
def test_vyos_system_clear_domain_search(self):
|
||||
set_module_args(dict(domain_search=[]))
|
||||
result = self.execute_module(changed=True)
|
||||
self.assertIn('delete system domain-search domain', result['commands'])
|
||||
self.assertEqual(1, len(result['commands']))
|
||||
commands = ['delete system domain-search domain']
|
||||
self.execute_module(changed=True, commands=commands)
|
||||
|
||||
def test_vyos_system_no_change(self):
|
||||
set_module_args(dict(host_name='router', domain_name='example.com', name_server=['8.8.8.8', '8.8.4.4']))
|
||||
|
|
@ -144,5 +89,8 @@ class TestVyosSystemModule(unittest.TestCase):
|
|||
|
||||
def test_vyos_system_clear_all(self):
|
||||
set_module_args(dict(state='absent'))
|
||||
result = self.execute_module(changed=True)
|
||||
self.assertEqual(4, len(result['commands']))
|
||||
commands = ['delete system host-name',
|
||||
'delete system domain-search domain',
|
||||
'delete system domain-name',
|
||||
'delete system name-server']
|
||||
self.execute_module(changed=True, commands=commands)
|
||||
|
|
|
|||
113
test/units/modules/network/vyos/vyos_module.py
Normal file
113
test/units/modules/network/vyos/vyos_module.py
Normal file
|
|
@ -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 TestVyosModule(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
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue