diff --git a/plugins/module_utils/network/vyos/config/vrf/vrf.py b/plugins/module_utils/network/vyos/config/vrf/vrf.py index 2adf5bf4..90098bbb 100644 --- a/plugins/module_utils/network/vyos/config/vrf/vrf.py +++ b/plugins/module_utils/network/vyos/config/vrf/vrf.py @@ -1,242 +1,243 @@ # # -*- coding: utf-8 -*- # Copyright 2021 Red Hat # GNU General Public License v3.0+ # (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # from __future__ import absolute_import, division, print_function __metaclass__ = type """ The vyos_vrf config file. It is in this file where the current configuration (as dict) is compared to the provided configuration (as dict) and the command set necessary to bring the current configuration to its desired end-state is created. """ from copy import deepcopy from ansible.module_utils.six import iteritems from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.rm_base.resource_module import ( ResourceModule, ) from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.facts import Facts from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.rm_templates.vrf import ( VrfTemplate, ) from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.utils.utils import combine from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.utils.version import ( LooseVersion, ) from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import get_os_version # from ansible.plugins.filter.core import combine class Vrf(ResourceModule): """ The vyos_vrf config class """ def __init__(self, module): super(Vrf, self).__init__( empty_fact_val={}, facts_module=Facts(module), module=module, resource="vrf", tmplt=VrfTemplate(), ) self.parsers = [ "bind_to_all", ] def _validate_template(self): version = get_os_version(self._module) if LooseVersion(version) >= LooseVersion("1.4"): self._tmplt = VrfTemplate() else: self._module.fail_json(msg="VRF is not supported in this version of VyOS") def parse(self): """override parse to check template""" self._validate_template() return super().parse() def get_parser(self, name): """get_parsers""" self._validate_template() return super().get_parser(name) def execute_module(self): """Execute the module :rtype: A dictionary :returns: The result from module execution """ if self.state not in ["parsed", "gathered"]: self.generate_commands() self.run_commands() return self.result def generate_commands(self): """Generate configuration commands to send based on want, have and desired state. """ wantd = {} haved = {} wantd = deepcopy(self.want) haved = deepcopy(self.have) # self._module.fail_json(msg="WanT: " + str(self.want) + "**** H: " + str(self.have)) # if state is merged, merge want onto have and then compare if self.state in ["merged", "replaced"]: # wantd = dict_merge(wantd, haved) # wantd = haved | combine(wantd, recursive=True) wantd = combine(haved, wantd, recursive=True) # self._module.fail_json(msg="Want: " + str(wantd) + "**** H: " + str(haved)) # if state is deleted, delete and empty out wantd if self.state == "deleted": w = deepcopy(wantd) if w == {}: - self.commands.append("delete vrf") + self.commands = ["delete vrf"] return for k, want in iteritems(w): if not (k in haved and haved[k]): del wantd[k] else: if isinstance(want, list): for entry in want: wname = entry.get("name") haved["instances"] = [ i for i in haved.get("instances", []) if i.get("name") != wname ] self.commands.append("delete vrf name {}".format(wname)) else: self.commands.append("delete vrf {}".format(k.replace("_", "-"))) del wantd[k] if self.state == "overridden": w = deepcopy(wantd) h = deepcopy(haved) for k, want in iteritems(w): if k in haved and haved[k] != want: if isinstance(want, list): for entry in want: wname = entry.get("name") hdict = next( (inst for inst in haved["instances"] if inst["name"] == wname), None, ) if entry != hdict: + # self._module.fail_json(msg="Want: " + str(entry) + "**** H: " + str(hdict)) haved["instances"] = [ i for i in haved.get("instances", []) if i.get("name") != wname ] self.commands.append("delete vrf name {}".format(wname)) self.commands.append("commit") for k, want in iteritems(wantd): if isinstance(want, list): self._compare_instances(want=want, have=haved.pop(k, {})) self.compare( parsers=self.parsers, want={k: want}, have={k: haved.pop(k, {})}, ) # self._module.fail_json(msg=self.commands) def _compare_instances(self, want, have): """Compare the instances of the VRF""" parsers = [ "table_id", "vni", "description", "disable_vrf", ] # self._module.fail_json(msg="want: " + str(want) + "**** have: " + str(have)) for entry in want: h = {} wname = entry.get("name") # h = next((vrf for vrf in have if vrf["name"] == wname), {}) h = { k: v for vrf in have if vrf.get("name") == wname for k, v in vrf.items() if k != "address_family" } self.compare(parsers=parsers, want=entry, have=h) if "address_family" in entry: wafi = {"name": wname, "address_family": entry.get("address_family", [])} # hdict = next((item for item in have if item["name"] == wname), None) hdict = next((d for d in have if d.get("name") == wname), None) hafi = { "name": (hdict or {"name": wname})["name"], "address_family": hdict.get("address_family", []) if hdict else [], } # self._module.fail_json(msg="wafi: " + str(wafi) + "**** hafi: " + str(hafi)) self._compare_addr_family(wafi, hafi) def _compare_addr_family(self, want, have): """Compare the address families of the VRF""" afi_parsers = [ # "address_family", "disable_forwarding", "disable_nht", ] # self._module.fail_json(msg="wAfi: " + str(want) + "**** hAfi: " + str(have)) wafi = self.afi_to_list(want) hafi = self.afi_to_list(have) lookup = {(d["name"], d["afi"]): d for d in hafi} pairs = [(d1, lookup.get((d1["name"], d1["afi"]), {})) for d1 in wafi] for wafd, hafd in pairs: # self._module.fail_json(msg="wAfd: " + str(wafd) + "**** hAfd: " + str(hafd)) if "route_maps" in wafd: self._compare_route_maps(wafd, hafd) self.compare(parsers=afi_parsers, want=wafd, have=hafd) # self.compare(parsers=afi_parsers, want=wafi, have=hafi) def afi_to_list(self, data): """Convert address family dict to list""" return [ {"name": data["name"], **{**af, "afi": "ip" if af["afi"] == "ipv4" else af["afi"]}} for af in data["address_family"] ] def _compare_route_maps(self, wafd, hafd): want_rms = wafd.get("route_maps", []) have_rms = hafd.get("route_maps", []) for want in want_rms: match = next( ( h for h in have_rms if h["rm_name"] == want["rm_name"] and h["protocol"] == want["protocol"] ), {}, ) base = {"name": wafd["name"], "afi": wafd["afi"]} self.compare( parsers="route_maps", want={**base, "route_maps": want}, have={**base, "route_maps": match}, ) diff --git a/tests/unit/modules/network/vyos/fixtures/vyos_vrf_config.cfg b/tests/unit/modules/network/vyos/fixtures/vyos_vrf_config.cfg index aa156bf1..57bf0e32 100644 --- a/tests/unit/modules/network/vyos/fixtures/vyos_vrf_config.cfg +++ b/tests/unit/modules/network/vyos/fixtures/vyos_vrf_config.cfg @@ -1,11 +1,12 @@ set vrf bind-to-all set vrf name vrf-blue description 'blue-vrf' set vrf name vrf-blue table '100' set vrf name vrf-blue vni '1000' set vrf name vrf-red description 'red-vrf' set vrf name vrf-red disable set vrf name vrf-red ip disable-forwarding set vrf name vrf-red ip protocol kernel route-map 'rm1' set vrf name vrf-red ip protocol rip route-map 'rm1' +set vrf name vrf-red ipv6 nht no-resolve-via-default set vrf name vrf-red table '101' set vrf name vrf-red vni '1001' diff --git a/tests/unit/modules/network/vyos/test_vyos_vrf.py b/tests/unit/modules/network/vyos/test_vyos_vrf.py index 9c931377..03ff71ec 100644 --- a/tests/unit/modules/network/vyos/test_vyos_vrf.py +++ b/tests/unit/modules/network/vyos/test_vyos_vrf.py @@ -1,503 +1,507 @@ # (c) 2021 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 from unittest.mock import patch from ansible_collections.vyos.vyos.plugins.modules import vyos_vrf from ansible_collections.vyos.vyos.tests.unit.modules.utils import set_module_args from .vyos_module import TestVyosModule, load_fixture class TestVyosVrfModule(TestVyosModule): module = vyos_vrf def setUp(self): super(TestVyosVrfModule, self).setUp() self.mock_get_resource_connection_config = patch( "ansible_collections.ansible.netcommon.plugins.module_utils.network.common.rm_base.resource_module_base.get_resource_connection", ) self.get_resource_connection_config = self.mock_get_resource_connection_config.start() self.mock_get_resource_connection_facts = patch( "ansible_collections.ansible.netcommon.plugins.module_utils.network.common.facts.facts.get_resource_connection", ) self.get_resource_connection_facts = self.mock_get_resource_connection_facts.start() self.mock_execute_show_command = patch( "ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.vrf.vrf.VrfFacts.get_config", ) self.execute_show_command = self.mock_execute_show_command.start() self.mock_get_os_version = patch( "ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.config.vrf.vrf.get_os_version", ) self.get_os_version = self.mock_get_os_version.start() self.get_os_version.return_value = "1.5" self.maxDiff = None def tearDown(self): super(TestVyosVrfModule, self).tearDown() self.mock_get_resource_connection_config.stop() self.mock_get_resource_connection_facts.stop() self.mock_execute_show_command.stop() self.mock_get_os_version.stop() def load_fixtures(self, commands=None, filename=None): if filename is None: filename = "vyos_vrf_config.cfg" def load_from_file(*args, **kwargs): output = load_fixture(filename) return output self.execute_show_command.side_effect = load_from_file def test_vrf_merged_idempotent(self): set_module_args( dict( config=dict( bind_to_all=True, instances=[ dict( name="vrf-blue", description="blue-vrf", disable=False, table_id=100, vni=1000, ), dict( name="vrf-red", description="red-vrf", disable=True, table_id=101, vni=1001, address_family=[ dict( afi="ipv4", disable_forwarding=True, route_maps=[ dict(rm_name="rm1", protocol="kernel"), dict(rm_name="rm1", protocol="rip"), ], ), dict( afi="ipv6", - nht_no_resolve_via_default=False, + nht_no_resolve_via_default=True, ), ], ), ], ), state="merged", ), ) self.execute_module(changed=False, commands=[]) def test_vrf_merged(self): set_module_args( dict( config=dict( bind_to_all=True, instances=[ dict( name="vrf-green", description="green-vrf", table_id=110, vni=1010, ), ], ), state="merged", ), ) commands = [ "set vrf name vrf-green table 110", "set vrf name vrf-green vni 1010", "set vrf name vrf-green description green-vrf", ] self.execute_module(changed=True, commands=commands) def test_vrf_replaced(self): set_module_args( dict( config=dict( bind_to_all=True, instances=[ dict( name="vrf-blue", description="blue-vrf-replaced", disable=True, table_id=100, vni=1000, ), dict( name="vrf-red", description="red-vrf", disable=True, table_id=101, vni=1001, address_family=[ dict( afi="ipv4", disable_forwarding=False, route_maps=[ dict(rm_name="rm1", protocol="kernel"), dict(rm_name="rm1", protocol="rip"), ], ), dict( afi="ipv6", - nht_no_resolve_via_default=True, + nht_no_resolve_via_default=False, ), ], ), ], ), state="replaced", ), ) commands = [ "set vrf name vrf-blue description blue-vrf-replaced", "set vrf name vrf-blue disable", "delete vrf name vrf-red ip disable-forwarding", - "set vrf name vrf-red ipv6 nht no-resolve-via-default", + "delete vrf name vrf-red ipv6 nht no-resolve-via-default", ] self.execute_module(changed=True, commands=commands) def test_vrf_replaced_idempotent(self): set_module_args( dict( config=dict( bind_to_all=True, instances=[ dict( name="vrf-blue", description="blue-vrf", disable=False, table_id=100, vni=1000, ), dict( name="vrf-red", description="red-vrf", disable=True, table_id=101, vni=1001, address_family=[ dict( afi="ipv4", disable_forwarding=True, route_maps=[ dict(rm_name="rm1", protocol="kernel"), dict(rm_name="rm1", protocol="rip"), ], ), dict( afi="ipv6", - nht_no_resolve_via_default=False, + nht_no_resolve_via_default=True, ), ], ), ], ), state="replaced", ), ) self.execute_module(changed=False, commands=[]) def test_vrf_overridden(self): set_module_args( dict( config=dict( instances=[ dict( name="vrf-blue", description="blue-vrf", disable=True, table_id=103, vni=1002, ), ], ), state="overridden", ), ) commands = [ "delete vrf name vrf-blue", "commit", "set vrf name vrf-blue table 103", "set vrf name vrf-blue vni 1002", "set vrf name vrf-blue description blue-vrf", "set vrf name vrf-blue disable", "delete vrf bind-to-all", ] self.execute_module(changed=True, commands=commands) - # def test_vrf_overridden_idempotent(self): - # set_module_args( - # dict( - # config=dict( - # bind_to_all=True, - # instances=[ - # dict( - # name="vrf-blue", - # description="blue-vrf", - # disable=False, - # table_id=100, - # vni=1000, - # ), - # dict( - # name="vrf-red", - # description="red-vrf", - # disable=True, - # table_id=101, - # vni=1001, - # address_family=[ - # dict( - # afi="ipv4", - # disable_forwarding=True, - # route_maps=[ - # dict(rm_name="rm1", protocol="kernel"), - # dict(rm_name="rm1", protocol="rip"), - # ], - # ), - # dict( - # afi="ipv6", - # nht_no_resolve_via_default=False, - # ), - # ], - # ), - # ], - # ), - # state="overridden", - # ), - # ) - # self.execute_module(changed=False, commands=[]) + def test_vrf_overridden_idempotent(self): + set_module_args( + dict( + config=dict( + bind_to_all=True, + instances=[ + dict( + name="vrf-blue", + description="blue-vrf", + disable=False, + table_id=100, + vni=1000, + ), + dict( + name="vrf-red", + description="red-vrf", + disable=True, + table_id=101, + vni=1001, + address_family=[ + dict( + afi="ipv4", + disable_forwarding=True, + route_maps=[ + dict(rm_name="rm1", protocol="kernel"), + dict(rm_name="rm1", protocol="rip"), + ], + ), + dict( + afi="ipv6", + nht_no_resolve_via_default=True, + ), + ], + ), + ], + ), + state="overridden", + ), + ) + self.execute_module(changed=False, commands=[]) def test_vrf_rendered(self): set_module_args( dict( config=dict( bind_to_all=True, instances=[ dict( name="vrf-green", description="green-vrf", disabled=True, table_id=105, vni=1000, ), dict( name="vrf-amber", description="amber-vrf", disable=False, table_id=111, vni=1001, address_family=[ dict( afi="ipv4", disable_forwarding=True, route_maps=[ dict(rm_name="rm1", protocol="kernel"), dict(rm_name="rm1", protocol="ospf"), ], ), dict( afi="ipv6", nht_no_resolve_via_default=False, ), ], ), ], ), state="rendered", ), ) rendered_commands = [ "set vrf bind-to-all", "set vrf name vrf-green table 105", "set vrf name vrf-green vni 1000", "set vrf name vrf-green description green-vrf", "set vrf name vrf-green disable", "set vrf name vrf-amber table 111", "set vrf name vrf-amber vni 1001", "set vrf name vrf-amber description amber-vrf", "set vrf name vrf-amber ip protocol kernel route-map rm1", "set vrf name vrf-amber ip protocol ospf route-map rm1", "set vrf name vrf-amber ip disable-forwarding", ] result = self.execute_module(changed=False) self.assertEqual( sorted(result["rendered"]), sorted(rendered_commands), result["rendered"], ) def test_vrf_parsed(self): commands = ( "set vrf bind-to-all", "set vrf name vrf1 description 'red'", "set vrf name vrf1 disable", "set vrf name vrf1 table 101", "set vrf name vrf1 vni 501", "set vrf name vrf2 description 'green'", "set vrf name vrf2 disable", "set vrf name vrf2 table 102", "set vrf name vrf2 vni 102", "set vrf name vrf1 ip disable-forwarding", "set vrf name vrf1 ip nht no-resolve-via-default", "set vrf name vrf-red ip protocol kernel route-map 'rm1'", "set vrf name vrf-red ip protocol ospf route-map 'rm1'", "set vrf name vrf-red ipv6 nht no-resolve-via-default", ) parsed_str = "\n".join(commands) set_module_args(dict(running_config=parsed_str, state="parsed")) result = self.execute_module(changed=False) parsed_list = { "bind_to_all": True, "instances": [ { "address_family": [ { "afi": "ipv4", "disable_forwarding": True, "nht_no_resolve_via_default": True, }, ], "description": "red", "disable": True, "name": "vrf1", }, { "description": "green", "disable": True, "name": "vrf2", }, { "address_family": [ { "afi": "ipv4", "disable_forwarding": False, "nht_no_resolve_via_default": False, "route_maps": [ { "protocol": "kernel", "rm_name": "rm1", }, { "protocol": "ospf", "rm_name": "rm1", }, ], }, { "afi": "ipv6", "disable_forwarding": False, "nht_no_resolve_via_default": True, }, ], "disable": False, "name": "vrf-red", }, ], } self.assertEqual(parsed_list, result["parsed"]) def test_vrf_gathered(self): set_module_args(dict(state="gathered")) result = self.execute_module(changed=False) gathered_list = { "bind_to_all": True, "instances": [ { "description": "blue-vrf", "disable": False, "name": "vrf-blue", "table_id": 100, "vni": 1000, }, { "address_family": [ { "afi": "ipv4", "disable_forwarding": True, "nht_no_resolve_via_default": False, "route_maps": [ { "protocol": "kernel", "rm_name": "rm1", }, { "protocol": "rip", "rm_name": "rm1", }, ], }, + { + "afi": "ipv6", + "disable_forwarding": False, + "nht_no_resolve_via_default": True, + }, ], "description": "red-vrf", "disable": True, "name": "vrf-red", "table_id": 101, "vni": 1001, }, ], } self.assertEqual(gathered_list, result["gathered"]) def test_vrf_deleted(self): # Delete the instances and global setting bind_to_all set_module_args( dict( config=dict( - bind_to_all=False, + bind_to_all=True, instances=[ dict( name="vrf-blue", ), ], ), state="deleted", ), ) commands = [ "delete vrf bind-to-all", "delete vrf name vrf-blue", ] self.execute_module(changed=True, commands=commands) - # def test_vrf__all_deleted(self): - # set_module_args( - # dict( - # config=dict({}), - # state="deleted", - # ), - # ) - # commands = [ - # "delete vrf", - # ] - # self.execute_module(changed=True, commands=commands) + def test_vrf_all_deleted(self): + set_module_args( + dict( + state="deleted", + ), + ) + commands = [ + "delete vrf", + ] + self.execute_module(changed=True, commands=commands)