From 85d78390f9add2fe831bce7ffe72f2d5135b9bcc Mon Sep 17 00:00:00 2001 From: Peter Sprygada Date: Sat, 28 Jan 2017 11:07:51 -0500 Subject: [PATCH] adds new module eos_system (#20797) * provides declarative resource for configuring eos system parameters * supports network_cli connection plugin only * adds unit tests for module using mock interfaces --- lib/ansible/modules/network/eos/eos_system.py | 344 ++++++++++++++++++ .../eos/fixtures/eos_system_config.cfg | 12 + .../modules/network/eos/test_eos_system.py | 157 ++++++++ 3 files changed, 513 insertions(+) create mode 100644 lib/ansible/modules/network/eos/eos_system.py create mode 100644 test/units/modules/network/eos/fixtures/eos_system_config.cfg create mode 100644 test/units/modules/network/eos/test_eos_system.py diff --git a/lib/ansible/modules/network/eos/eos_system.py b/lib/ansible/modules/network/eos/eos_system.py new file mode 100644 index 0000000000..b35ad33f82 --- /dev/null +++ b/lib/ansible/modules/network/eos/eos_system.py @@ -0,0 +1,344 @@ +#!/usr/bin/python +# +# 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 . +# + +ANSIBLE_METADATA = { + 'status': ['preview'], + 'supported_by': 'core', + 'version': '1.0' +} + +DOCUMENTATION = """ +--- +module: eos_system +version_added: "2.3" +author: "Peter Sprygada (@privateip)" +short_description: Manage the system attributes on Arista EOS devices +description: + - This module provides declarative management of node system attributes + on Arista EOS devices. It provides an option to configure host system + parameters or remove those parameters from the device active + configuration. +options: + hostname: + description: + - The C(hostname) argument will configure the device hostname + parameter on Arista EOS devices. The C(hostname) value is an + ASCII string value. + required: false + default: null + domain_name: + description: + - The C(description) argument will configure the IP domain name + on the remote device to the provided value. The C(domain_name) + argument should be in the dotted name form and will be + appended to the C(hostname) to create a fully-qualified + domain name + required: false + default: null + domain_list: + description: + - The C(domain_list) provides the list of domain suffixes to + append to the hostname for the purpose of doing name resolution. + This argument accepts a list of names and will be reconciled + with the current active configuration on the running node. + required: false + default: null + lookup_source: + description: + - The C(lookup_source) argument provides one or more source + interfaces to use for performing DNS lookups. The interface + provided in C(lookup_source) can only exist in a single VRF. This + argument accepts either a list of interface names or a list of + hashes that configure the interface name and VRF name. See + examples. + required: false + default: null + name_servers: + description: + - The C(name_serves) argument accepts a list of DNS name servers by + way of either FQDN or IP address to use to perform name resolution + lookups. This argument accepts wither a list of DNS servers or + a list of hashes that configure the name server and VRF name. See + examples. + required: false + default: null + state: + description: + - The C(state) argument configures the state of the configuration + values in the device's current active configuration. When set + to I(present), the values should be configured in the device active + configuration and when set to I(absent) the values should not be + in the device active configuration + required: false + default: present + choices: ['present', 'absent'] +""" + +EXAMPLES = """ +- name: configure hostname and domain-name + eos_system: + hostname: eos01 + domain_name: eng.ansible.com + +- name: remove configuration + eos_system: + state: absent + +- name: configure DNS lookup sources + eos_system: + lookup_source: Management1 + +- name: configure DNS lookup sources with VRF support + eos_system: + lookup_source: + - interface: Management1 + vrf: mgmt + - interface: Ethernet1 + vrf: myvrf + +- name: configure name servers + eos_system: + name_servers: + - 8.8.8.8 + - 8.8.4.4 + +- name: configure name servers with VRF support + eos_system: + name_servers: + - { server: 8.8.8.8, vrf: mgmt } + - { server: 8.8.4.4, vrf: mgmt } +""" + +RETURN = """ +commands: + description: The list of configuration mode commands to send to the device + returned: always + type: list + sample: + - hostname eos01 + - ip domain-name eng.ansible.com +session_name: + description: The EOS config session name used to load the configuration + returned: when changed is True + type: str + sample: ansible_1479315771 +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 re + +from ansible.module_utils.local import LocalAnsibleModule +from ansible.module_utils.network_common import ComplexList +from ansible.module_utils.eos import load_config, get_config + +_CONFIGURED_VRFS = None + +def has_vrf(module, vrf): + global _CONFIGURED_VRFS + if _CONFIGURED_VRFS is not None: + return vrf in _CONFIGURED_VRFS + config = get_config(module) + _CONFIGURED_VRFS = re.findall('vrf definition (\S+)', config) + _CONFIGURED_VRFS.append('default') + return vrf in _CONFIGURED_VRFS + +def map_obj_to_commands(want, have, module): + commands = list() + state = module.params['state'] + + needs_update = lambda x: want.get(x) and (want.get(x) != have.get(x)) + + if state == 'absent': + if have['domain_name']: + commands.append('no ip domain-name') + + if have['hostname'] != 'localhost': + commands.append('no hostname') + + if state == 'present': + if needs_update('hostname'): + commands.append('hostname %s' % want['hostname']) + + if needs_update('domain_name'): + commands.append('ip domain-name %s' % want['domain_name']) + + if want['domain_list']: + # handle domain_list items to be removed + for item in set(have['domain_list']).difference(want['domain_list']): + commands.append('no ip domain-list %s' % item) + + # handle domain_list items to be added + for item in set(want['domain_list']).difference(have['domain_list']): + commands.append('ip domain-list %s' % item) + + if want['lookup_source']: + # handle lookup_source items to be removed + for item in have['lookup_source']: + if item not in want['lookup_source']: + if item['vrf']: + if not has_vrf(module, item['vrf']): + module.fail_json(msg='vrf %s is not configured' % item['vrf']) + values = (item['vrf'], item['interface']) + commands.append('no ip domain lookup vrf %s source-interface %s' % values) + else: + commands.append('no ip domain lookup source-interface %s' % item['interface']) + + # handle lookup_source items to be added + for item in want['lookup_source']: + if item not in have['lookup_source']: + if item['vrf']: + if not has_vrf(module, item['vrf']): + module.fail_json(msg='vrf %s is not configured' % item['vrf']) + values = (item['vrf'], item['interface']) + commands.append('ip domain lookup vrf %s source-interface %s' % values) + else: + commands.append('ip domain lookup source-interface %s' % item['interface']) + + if want['name_servers']: + # handle name_servers items to be removed. Order does matter here + # since name servers can only be in one vrf at a time + for item in have['name_servers']: + if item not in want['name_servers']: + if not has_vrf(module, item['vrf']): + module.fail_json(msg='vrf %s is not configured' % item['vrf']) + values = (item['vrf'], item['server']) + commands.append('no ip name-server vrf %s %s' % values) + + # handle name_servers items to be added + for item in want['name_servers']: + if item not in have['name_servers']: + if not has_vrf(module, item['vrf']): + module.fail_json(msg='vrf %s is not configured' % item['vrf']) + values = (item['vrf'], item['server']) + commands.append('ip name-server vrf %s %s' % values) + + return commands + +def parse_hostname(config): + match = re.search('^hostname (\S+)', config, re.M) + return match.group(1) + +def parse_domain_name(config): + match = re.search('^ip domain-name (\S+)', config, re.M) + if match: + return match.group(1) + +def parse_lookup_source(config): + objects = list() + regex = 'ip domain lookup (?:vrf (\S+) )*source-interface (\S+)' + for vrf, intf in re.findall(regex, config, re.M): + if len(vrf) == 0: + vrf= None + objects.append({'interface': intf, 'vrf': vrf}) + return objects + +def parse_name_servers(config): + objects = list() + for vrf, addr in re.findall('ip name-server vrf (\S+) (\S+)', config, re.M): + objects.append({'server': addr, 'vrf': vrf}) + return objects + +def map_config_to_obj(module): + config = get_config(module) + return { + 'hostname': parse_hostname(config), + 'domain_name': parse_domain_name(config), + 'domain_list': re.findall('^ip domain-list (\S+)', config, re.M), + 'lookup_source': parse_lookup_source(config), + 'name_servers': parse_name_servers(config) + } + +def map_params_to_obj(module): + obj = { + 'hostname': module.params['hostname'], + 'domain_name': module.params['domain_name'], + 'domain_list': module.params['domain_list'] + } + + lookup_source = ComplexList(dict( + interface=dict(key=True), + vrf=dict() + )) + + name_servers = ComplexList(dict( + server=dict(key=True), + vrf=dict(default='default') + )) + + for arg, cast in [('lookup_source', lookup_source), ('name_servers', name_servers)]: + if module.params[arg] is not None: + obj[arg] = cast(module.params[arg]) + else: + obj[arg] = None + + return obj + +def main(): + """ main entry point for module execution + """ + argument_spec = dict( + hostname=dict(), + + domain_name=dict(), + domain_list=dict(type='list'), + + # { interface: , vrf: } + lookup_source=dict(type='list'), + + # { server: ; vrf: } + name_servers=dict(type='list'), + + state=dict(default='present', choices=['present', 'absent']) + ) + + module = LocalAnsibleModule(argument_spec=argument_spec, + supports_check_mode=True) + + result = {'changed': False} + + want = map_params_to_obj(module) + have = map_config_to_obj(module) + + commands = map_obj_to_commands(want, have, module) + result['commands'] = commands + + if commands: + commit = not module.check_mode + response = load_config(module, commands, commit=commit) + if response.get('diff') and module._diff: + result['diff'] = {'prepared': response.get('diff')} + result['session_name'] = response.get('session') + result['changed'] = True + + module.exit_json(**result) + +if __name__ == '__main__': + main() diff --git a/test/units/modules/network/eos/fixtures/eos_system_config.cfg b/test/units/modules/network/eos/fixtures/eos_system_config.cfg new file mode 100644 index 0000000000..08837ec406 --- /dev/null +++ b/test/units/modules/network/eos/fixtures/eos_system_config.cfg @@ -0,0 +1,12 @@ +! +hostname switch01 +ip domain lookup source-interface Management1 +ip name-server vrf mgmt 8.8.4.4 +ip name-server vrf default 8.8.8.8 +ip domain-name eng.ansible.com +ip domain-list ansible.com +ip domain-list ops.ansible.com +! +vrf definition mgmt +! +vrf definition test diff --git a/test/units/modules/network/eos/test_eos_system.py b/test/units/modules/network/eos/test_eos_system.py new file mode 100644 index 0000000000..ada0b9008b --- /dev/null +++ b/test/units/modules/network/eos/test_eos_system.py @@ -0,0 +1,157 @@ +#!/usr/bin/env python +# +# (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 . + +# Make coding more python3-ish +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.modules.network.eos import eos_system +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 TestEosSystemModule(unittest.TestCase): + + def setUp(self): + self.mock_get_config = patch('ansible.modules.network.eos.eos_system.get_config') + self.get_config = self.mock_get_config.start() + + self.mock_load_config = patch('ansible.modules.network.eos.eos_system.load_config') + self.load_config = self.mock_load_config.start() + + def tearDown(self): + self.mock_get_config.stop() + self.mock_load_config.stop() + + def execute_module(self, failed=False, changed=False, commands=None, sort=True): + + 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'] + self.execute_module(changed=True, commands=commands) + + def test_eos_system_domain_name(self): + set_module_args(dict(domain_name='test.com')) + commands = ['ip domain-name test.com'] + self.execute_module(changed=True, commands=commands) + + def test_eos_system_domain_list(self): + set_module_args(dict(domain_list=['ansible.com', 'redhat.com'])) + commands = ['no ip domain-list ops.ansible.com', + 'ip domain-list redhat.com'] + self.execute_module(changed=True, commands=commands) + + def test_eos_system_lookup_source(self): + set_module_args(dict(lookup_source=['Ethernet1'])) + commands = ['no ip domain lookup source-interface Management1', + 'ip domain lookup source-interface Ethernet1'] + self.execute_module(changed=True, commands=commands) + + def test_eos_system_lookup_source_complex(self): + lookup_source = [{'interface': 'Management1', 'vrf': 'mgmt'}, + {'interface': 'Ethernet1'}] + set_module_args(dict(lookup_source=lookup_source)) + commands = ['no ip domain lookup source-interface Management1', + 'ip domain lookup vrf mgmt source-interface Management1', + 'ip domain lookup source-interface Ethernet1'] + self.execute_module(changed=True, commands=commands) + + def test_eos_system_name_servers(self): + name_servers = ['8.8.8.8', '8.8.4.4'] + set_module_args(dict(name_servers=name_servers)) + commands = ['ip name-server vrf default 8.8.4.4', + 'no ip name-server vrf mgmt 8.8.4.4'] + self.execute_module(changed=True, commands=commands) + + def rest_eos_system_name_servers_complex(self): + name_servers = dict(server='8.8.8.8', vrf='test') + set_module_args(dict(name_servers=name_servers)) + commands = ['ip name-server vrf test 8.8.8.8', + 'no ip name-server vrf default 8.8.8.8', + 'no ip name-server vrf mgmt 8.8.4.4'] + self.execute_module(changed=True, commands=commands) + + def test_eos_system_state_absent(self): + set_module_args(dict(state='absent')) + commands = ['no ip domain-name', 'no hostname'] + self.execute_module(changed=True, commands=commands) + + def test_eos_system_no_change(self): + set_module_args(dict(hostname='switch01', domain_name='eng.ansible.com')) + commands = [] + self.execute_module(commands=commands) + + def test_eos_system_missing_vrf(self): + name_servers = dict(server='8.8.8.8', vrf='missing') + set_module_args(dict(name_servers=name_servers)) + result = self.execute_module(failed=True) +