diff --git a/plugins/module_utils/network/vyos/argspec/interfaces/interfaces.py b/plugins/module_utils/network/vyos/argspec/interfaces/interfaces.py index 8ba119f3..80348a10 100644 --- a/plugins/module_utils/network/vyos/argspec/interfaces/interfaces.py +++ b/plugins/module_utils/network/vyos/argspec/interfaces/interfaces.py @@ -1,81 +1,83 @@ # # -*- coding: utf-8 -*- # Copyright 2019 Red Hat # GNU General Public License v3.0+ # (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) """ The arg spec for the vyos_interfaces module """ from __future__ import absolute_import, division, print_function + __metaclass__ = type class InterfacesArgs(object): # pylint: disable=R0903 """The arg spec for the vyos_interfaces module""" def __init__(self, **kwargs): pass argument_spec = { "config": { "elements": "dict", "options": { "description": {"type": "str"}, "duplex": { "choices": ["full", "half", "auto"], "type": "str", }, "enabled": { "aliases": ["enable"], "default": True, "type": "bool", }, "mtu": {"type": "int"}, "name": {"required": True, "type": "str"}, "speed": { "choices": [ "auto", "10", "100", "1000", "2500", "10000", ], "type": "str", }, "vifs": { "elements": "dict", "options": { "description": {"type": "str"}, "enabled": { "aliases": ["enable"], "default": True, "type": "bool", }, "mtu": {"type": "int"}, "vlan_id": {"type": "int"}, + "vrf": {"type": "str"}, }, "type": "list", }, "vrf": {"type": "str"}, }, "type": "list", }, "running_config": {"type": "str"}, "state": { "choices": [ "merged", "replaced", "overridden", "deleted", "rendered", "gathered", "parsed", ], "default": "merged", "type": "str", }, } # pylint: disable=C0301 diff --git a/plugins/module_utils/network/vyos/config/interfaces/interfaces.py b/plugins/module_utils/network/vyos/config/interfaces/interfaces.py index 12488d9e..3d2b24fd 100644 --- a/plugins/module_utils/network/vyos/config/interfaces/interfaces.py +++ b/plugins/module_utils/network/vyos/config/interfaces/interfaces.py @@ -1,148 +1,148 @@ # Copyright 2019 Red Hat # GNU General Public License v3.0+ # (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) """ The vyos_interfaces class 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 it's desired end-state is created """ from __future__ import absolute_import, division, print_function __metaclass__ = type from copy import deepcopy from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.rm_base.resource_module import ( ResourceModule, ) from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import ( dict_merge, ) 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.interfaces import ( InterfacesTemplate, ) from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.utils.utils import ( get_interface_type, ) class Interfaces(ResourceModule): """ The vyos_interfaces class """ def __init__(self, module): super(Interfaces, self).__init__( empty_fact_val=[], facts_module=Facts(module), module=module, resource="interfaces", tmplt=InterfacesTemplate(), ) self.parsers = ["description", "mtu", "duplex", "speed", "vrf"] - self.vif_parsers = ["vifs.description", "vifs.mtu"] + self.vif_parsers = ["vifs.description", "vifs.mtu", "vifs.vrf"] 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. """ if self.state in ("merged", "replaced", "overridden", "rendered") and not self.want: self._module.fail_json( msg="value of config parameter must not be empty for state {0}".format(self.state), ) wantd = self._list_to_dict(self.want) haved = self._list_to_dict(self.have) for name in wantd: if not get_interface_type(name): self._module.fail_json( msg="interface {0} is not a valid interface type".format(name), ) if self.state == "deleted": # reset the given interfaces, or all of them for name in wantd or haved: if name in haved: self._compare(name, self._reset(name), haved[name]) return if self.state == "overridden": for name, have in haved.items(): if name not in wantd: self._compare(name, self._reset(name), have) for name, want in wantd.items(): # an interface not on the device yet keeps its wanted enabled state have = haved.get(name, {"name": name, "enabled": want.get("enabled", True)}) if self.state in ("merged", "rendered"): want = dict_merge(have, want) self._compare(name, want, have) def _compare(self, name, want, have): """Compare one interface: its options, enabled, and its vifs.""" base = {"name": name, "type": get_interface_type(name)} want = deepcopy(want) have = deepcopy(have) wvifs = want.pop("vifs", {}) or {} hvifs = have.pop("vifs", {}) or {} self.compare(parsers=self.parsers, want=dict(want, **base), have=dict(have, **base)) self._compare_enabled( base, "disable", want.get("enabled", True), have.get("enabled", True), ) for vlan_id, wvif in wvifs.items(): hvif = hvifs.pop(vlan_id, {"vlan_id": vlan_id, "enabled": True}) self.compare( parsers=self.vif_parsers, want=dict(base, vifs=wvif), have=dict(base, vifs=hvif), ) self._compare_enabled( dict(base, vifs={"vlan_id": vlan_id}), "vifs.disable", wvif.get("enabled", True), hvif.get("enabled", True), ) # vifs the configuration does not list are deleted as a whole for vlan_id in hvifs: self.addcmd(dict(base, vifs={"vlan_id": vlan_id}), "vifs", True) def _compare_enabled(self, data, parser, want, have): """enabled is the inverse of the disable flag: false sets it, true deletes it.""" if want != have: self.addcmd(data, parser, want) def _reset(self, name): """The configuration of an interface without any options: enabled, no vifs.""" return {"name": name, "enabled": True} def _list_to_dict(self, entries): """Interfaces by name, and their vifs by VLAN ID.""" result = {} for entry in deepcopy(entries) or []: vifs = entry.get("vifs") or [] entry["vifs"] = {vif["vlan_id"]: vif for vif in vifs} result[entry["name"]] = entry return result diff --git a/plugins/module_utils/network/vyos/rm_templates/interfaces.py b/plugins/module_utils/network/vyos/rm_templates/interfaces.py index 3bd74453..53ad0206 100644 --- a/plugins/module_utils/network/vyos/rm_templates/interfaces.py +++ b/plugins/module_utils/network/vyos/rm_templates/interfaces.py @@ -1,149 +1,150 @@ # -*- coding: utf-8 -*- # Copyright 2026 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 Interfaces parser templates file. This contains a list of parser definitions and associated functions that facilitates both facts gathering and native command generation for the given network resource. """ import re from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.rm_base.network_template import ( NetworkTemplate, ) # interface types the module manages TYPES = r"ethernet|bonding|bridge|dummy|tunnel|vti|loopback|vxlan|openvpn|wireguard" # set interfaces ; the name is quoted when it ends the line ('lo') INTF = ( r""" ^set \s+interfaces \s+(?P""" + TYPES + r""") \s+'?(?P[^'\s]+)'? """ ) # ... vif VIF = ( INTF + r""" \s+vif - \s+(?P\d+) + \s+'?(?P\d+)'? """ ) # a value, quoted ('text with spaces') or not VALUE = r""" \s+(?:'(?P.*)'|(?P\S+)) \s*$ """ VAL = "{{ q if q is defined else u }}" def _intf_parser(name, keyword, key=None): """An interface option with a value, e.g. description 'text'.""" key = key or name return { "name": name, "getval": re.compile(INTF + r"\s+" + keyword + VALUE, re.VERBOSE), "setval": "interfaces {{ type }} {{ name }} " + keyword + " '{{ " + key + " }}'", "remval": "interfaces {{ type }} {{ name }} " + keyword, "result": {"{{ name }}": {"name": "{{ name }}", key: VAL}}, } def _vif_parser(name, keyword, key): """A vif option with a value, e.g. vif 10 description 'text'.""" return { "name": name, "getval": re.compile(VIF + r"\s+" + keyword + VALUE, re.VERBOSE), "setval": "interfaces {{ type }} {{ name }} vif {{ vifs.vlan_id }} " + keyword + " '{{ vifs." + key + " }}'", "remval": "interfaces {{ type }} {{ name }} vif {{ vifs.vlan_id }} " + keyword, "compval": "vifs." + key, "result": { "{{ name }}": { "name": "{{ name }}", "vifs": {"{{ vlan }}": {"vlan_id": "{{ vlan }}", key: VAL}}, }, }, } class InterfacesTemplate(NetworkTemplate): def __init__(self, lines=None, module=None): prefix = {"set": "set", "remove": "delete"} super(InterfacesTemplate, self).__init__( lines=lines, tmplt=self, prefix=prefix, module=module, ) # The first matching parser wins for each line, so specific parsers come first, # then the vif catch-all, then the interface catch-all. # fmt: off PARSERS = [ _intf_parser("description", "description"), _intf_parser("mtu", "mtu"), _intf_parser("duplex", "duplex"), _intf_parser("speed", "speed"), _intf_parser("vrf", "vrf"), { "name": "disable", "getval": re.compile(INTF + r"\s+disable\s*$", re.VERBOSE), "setval": "interfaces {{ type }} {{ name }} disable", "result": {"{{ name }}": {"name": "{{ name }}", "enabled": False}}, }, _vif_parser("vifs.description", "description", "description"), _vif_parser("vifs.mtu", "mtu", "mtu"), + _vif_parser("vifs.vrf", "vrf", "vrf"), { "name": "vifs.disable", "getval": re.compile(VIF + r"\s+disable\s*$", re.VERBOSE), "setval": "interfaces {{ type }} {{ name }} vif {{ vifs.vlan_id }} disable", "result": { "{{ name }}": { "name": "{{ name }}", "vifs": {"{{ vlan }}": {"vlan_id": "{{ vlan }}", "enabled": False}}, }, }, }, { # any other vif line: the vif exists "name": "vifs", "getval": re.compile(VIF + r"(?:\s.*)?$", re.VERBOSE), "setval": "interfaces {{ type }} {{ name }} vif {{ vifs.vlan_id }}", "result": { "{{ name }}": { "name": "{{ name }}", "vifs": {"{{ vlan }}": {"vlan_id": "{{ vlan }}"}}, }, }, }, { # any other interface line: the interface exists "name": "name", "getval": re.compile(INTF + r"(?:\s.*)?$", re.VERBOSE), "setval": "interfaces {{ type }} {{ name }}", "result": {"{{ name }}": {"name": "{{ name }}"}}, }, ] # fmt: on diff --git a/tests/unit/modules/network/vyos/test_vyos_interfaces.py b/tests/unit/modules/network/vyos/test_vyos_interfaces.py index 33241e4a..70ade5cc 100644 --- a/tests/unit/modules/network/vyos/test_vyos_interfaces.py +++ b/tests/unit/modules/network/vyos/test_vyos_interfaces.py @@ -1,705 +1,728 @@ # (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 from unittest.mock import patch from ansible_collections.vyos.vyos.plugins.modules import vyos_interfaces from ansible_collections.vyos.vyos.tests.unit.modules.utils import set_module_args from .vyos_module import TestVyosModule, load_fixture class TestVyosInterfacesModule(TestVyosModule): module = vyos_interfaces def setUp(self): super(TestVyosInterfacesModule, self).setUp() self.mock_get_config = patch( "ansible_collections.ansible.netcommon.plugins.module_utils.network.common.rm_base.resource_module_base.get_resource_connection", ) self.get_config = self.mock_get_config.start() self.mock_load_config = patch( "ansible_collections.ansible.netcommon.plugins.module_utils.network.common.network.Config.load_config", ) self.load_config = self.mock_load_config.start() self.mock_get_resource_connection_config = patch( "ansible_collections.ansible.netcommon.plugins.module_utils.network.common.cfg.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.interfaces.interfaces.InterfacesFacts.get_device_data", ) self.execute_show_command = self.mock_execute_show_command.start() # define the default fixture for the vyos_interfaces module self.fixture_path = "vyos_interfaces_config.cfg" def tearDown(self): super(TestVyosInterfacesModule, self).tearDown() self.mock_get_resource_connection_config.stop() self.mock_get_resource_connection_facts.stop() self.mock_get_config.stop() self.mock_load_config.stop() self.mock_execute_show_command.stop() def load_fixtures(self, commands=None, filename=None): def load_from_file(*args, **kwargs): return load_fixture(self.fixture_path) self.execute_show_command.side_effect = load_from_file def test_vyos_interfaces_merged(self): set_module_args( dict( config=[ dict(name="bond1", description="Bond - 1", enabled=True), dict(name="vtun1", description="vtun - 1", enabled=True), dict(name="wg01", description="wg - 1", enabled=True), ], state="merged", ), ) commands = [ "set interfaces bonding bond1 description 'Bond - 1'", "set interfaces openvpn vtun1 description 'vtun - 1'", "set interfaces wireguard wg01 description 'wg - 1'", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_merged_retain_vif(self): # we have a vif in eth1 at this point, so that should be retained self.fixture_path = "vyos_interfaces_config_vif.cfg" set_module_args( dict( config=[ dict(name="bond1", description="Bond - 1", enabled=True), dict(name="vtun1", description="vtun - 1", enabled=True), dict(name="wg01", description="wg - 1", enabled=True), ], state="merged", ), ) commands = [ "set interfaces bonding bond1 description 'Bond - 1'", "set interfaces openvpn vtun1 description 'vtun - 1'", "set interfaces wireguard wg01 description 'wg - 1'", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_merged_additional_vif(self): # we have a vif in eth1 at this point, so that should be retained self.fixture_path = "vyos_interfaces_config_vif.cfg" set_module_args( dict( config=[ dict( name="eth1", vifs=[ dict( vlan_id=105, description="vlan 105", ), ], ), ], state="merged", ), ) commands = [ "set interfaces ethernet eth1 vif 105 description 'vlan 105'", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_merged_idempotent(self): set_module_args( dict( config=[ dict( name="wg02", description="wire guard int 2", enabled=True, ), ], state="merged", ), ) self.execute_module(changed=False, commands=[]) def test_vyos_interfaces_merged_newinterface(self): set_module_args( dict( config=[ dict( name="eth4", description="Ethernet 4", enabled=True, speed="auto", duplex="auto", ), dict(name="eth1", description="Configured by Ansible"), ], state="merged", ), ) commands = [ "set interfaces ethernet eth1 description 'Configured by Ansible'", "set interfaces ethernet eth4 description 'Ethernet 4'", "set interfaces ethernet eth4 duplex 'auto'", "set interfaces ethernet eth4 speed 'auto'", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_replaced_newinterface(self): set_module_args( dict( config=[ dict( name="eth4", description="Ethernet 4", enabled=True, speed="auto", duplex="auto", ), dict(name="eth1", description="Configured by Ansible"), ], state="replaced", ), ) commands = [ "set interfaces ethernet eth1 description 'Configured by Ansible'", "set interfaces ethernet eth4 description 'Ethernet 4'", "set interfaces ethernet eth4 duplex 'auto'", "set interfaces ethernet eth4 speed 'auto'", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_replaced_remove_vif(self): # we have a vif in eth1 at this point, so that should be removed self.fixture_path = "vyos_interfaces_config_vif.cfg" set_module_args( dict( config=[ dict( name="eth4", description="Ethernet 4", enabled=True, speed="auto", duplex="auto", ), dict(name="eth1", description="Configured by Ansible"), ], state="replaced", ), ) commands = [ "delete interfaces ethernet eth1 vif 200", "delete interfaces ethernet eth1 vif 201", "set interfaces ethernet eth1 description 'Configured by Ansible'", "set interfaces ethernet eth4 description 'Ethernet 4'", "set interfaces ethernet eth4 duplex 'auto'", "set interfaces ethernet eth4 speed 'auto'", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_replaced_remove_vrf(self): # we have a vrf in eth2 at this point, so that should be removed self.fixture_path = "vyos_interfaces_config_vrf.cfg" set_module_args( dict( config=[ dict( name="eth4", description="Ethernet 4", enabled=True, speed="auto", duplex="auto", ), dict(name="eth2", description="Configured by Ansible"), ], state="replaced", ), ) commands = [ "delete interfaces ethernet eth2 vrf", "set interfaces ethernet eth2 description 'Configured by Ansible'", "set interfaces ethernet eth4 description 'Ethernet 4'", "set interfaces ethernet eth4 duplex 'auto'", "set interfaces ethernet eth4 speed 'auto'", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_merged_enable_vif(self): # merge in enabling vif self.fixture_path = "vyos_interfaces_config_vif.cfg" set_module_args( dict( config=[ dict( name="eth1", vifs=[ dict( vlan_id=201, enabled=True, ), ], ), ], state="merged", ), ) commands = [ "delete interfaces ethernet eth1 vif 201 disable", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_replaced_retain_vif(self): # we have a vif in eth1 at this point, so that should be removed self.fixture_path = "vyos_interfaces_config_vif.cfg" set_module_args( dict( config=[ dict( name="eth4", description="Ethernet 4", enabled=True, speed="auto", duplex="auto", ), dict( name="eth1", description="Configured by Ansible", vifs=[ dict( vlan_id=200, ), dict( vlan_id=201, description="VIF eth1.201", enabled=True, ), ], ), ], state="replaced", ), ) commands = [ "delete interfaces ethernet eth1 vif 200 description", "delete interfaces ethernet eth1 vif 201 disable", "set interfaces ethernet eth1 description 'Configured by Ansible'", "set interfaces ethernet eth4 description 'Ethernet 4'", "set interfaces ethernet eth4 duplex 'auto'", "set interfaces ethernet eth4 speed 'auto'", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_overridden_newinterface(self): set_module_args( dict( config=[ dict( name="eth4", description="Ethernet 4", enabled=True, speed="auto", duplex="auto", ), dict(name="eth1", description="Configured by Ansible"), ], state="overridden", ), ) commands = [ "set interfaces ethernet eth1 description 'Configured by Ansible'", "set interfaces ethernet eth4 description 'Ethernet 4'", "set interfaces ethernet eth4 duplex 'auto'", "set interfaces ethernet eth4 speed 'auto'", "delete interfaces wireguard wg02 description", "delete interfaces ethernet eth3 description", "delete interfaces ethernet eth3 disable", ] self.execute_module(changed=True, commands=commands) def test_vyos_overridden_remove_vif(self): # we have a vif in eth1 at this point, so that should be removed self.fixture_path = "vyos_interfaces_config_vif.cfg" set_module_args( dict( config=[ dict( name="eth4", description="Ethernet 4", enabled=True, speed="auto", duplex="auto", ), dict(name="eth1", description="Configured by Ansible"), ], state="overridden", ), ) commands = [ "set interfaces ethernet eth1 description 'Configured by Ansible'", "set interfaces ethernet eth4 description 'Ethernet 4'", "set interfaces ethernet eth4 duplex 'auto'", "set interfaces ethernet eth4 speed 'auto'", "delete interfaces wireguard wg02 description", "delete interfaces ethernet eth3 description", "delete interfaces ethernet eth3 disable", "delete interfaces ethernet eth1 vif 200", "delete interfaces ethernet eth1 vif 201", ] self.execute_module(changed=True, commands=commands) def test_vyos_overridden_remove_vrf(self): # we have a vrf in eth2 at this point, so that should be removed self.fixture_path = "vyos_interfaces_config_vrf.cfg" set_module_args( dict( config=[ dict( name="eth4", description="Ethernet 4", enabled=True, speed="auto", duplex="auto", ), dict(name="eth2", description="Configured by Ansible"), ], state="overridden", ), ) commands = [ "set interfaces ethernet eth2 description 'Configured by Ansible'", "set interfaces ethernet eth4 description 'Ethernet 4'", "set interfaces ethernet eth4 duplex 'auto'", "set interfaces ethernet eth4 speed 'auto'", "delete interfaces ethernet eth2 vrf", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_idempotent_disable(self): set_module_args( dict( config=[ dict( name="eth3", description="Ethernet 3", enabled=False, ), ], state="merged", ), ) commands = [] self.execute_module(changed=False, commands=commands) def test_vyos_interfaces_idempotent_disable_replace(self): set_module_args( dict( config=[ dict( name="eth3", description="Ethernet 3", enabled=False, ), ], state="replaced", ), ) commands = [] self.execute_module(changed=False, commands=commands) def test_vyos_interfaces_deleted_remove_vif(self): # we have a vif in eth1 at this point, so that should be removed self.fixture_path = "vyos_interfaces_config_vif.cfg" set_module_args( dict( config=[ dict(name="eth1"), ], state="deleted", ), ) commands = [ "delete interfaces ethernet eth1 vif 200", "delete interfaces ethernet eth1 vif 201", "delete interfaces ethernet eth1 description", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_deleted_remove_vrf(self): # we have a vrf in eth2 at this point, so that should be removed self.fixture_path = "vyos_interfaces_config_vrf.cfg" set_module_args( dict( config=[ dict(name="eth2"), ], state="deleted", ), ) commands = [ "delete interfaces ethernet eth2 vrf", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_deleted_remove_all(self): # we have a vif in eth1 at this point, so that should be removed set_module_args( dict( config=[], state="deleted", ), ) commands = [ "delete interfaces ethernet eth1 description", "delete interfaces ethernet eth3 description", "delete interfaces ethernet eth3 disable", "delete interfaces wireguard wg02 description", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_replaced_bad_name(self): set_module_args( dict( config=[ dict( name="int4", description="Ethernet 4", enabled=True, speed="auto", duplex="auto", ), ], state="replaced", ), ) self.execute_module(failed=True) def test_vyos_interfaces_merged_idempotent_vrf(self): self.fixture_path = "vyos_interfaces_config_vrf.cfg" set_module_args( dict( config=[ dict(name="eth2", vrf="green"), ], state="merged", ), ) commands = [] self.execute_module(changed=False, commands=commands) def test_vyos_interfaces_replaced_idempotent_vrf(self): self.fixture_path = "vyos_interfaces_config_vrf.cfg" set_module_args( dict( config=[ dict(name="eth2", vrf="green"), ], state="replaced", ), ) commands = [] self.execute_module(changed=False, commands=commands) def test_vyos_interfaces_overridden_idempotent_vrf(self): self.fixture_path = "vyos_interfaces_config_vrf.cfg" set_module_args( dict( config=[ dict(name="eth2", vrf="green"), ], state="overridden", ), ) commands = [] self.execute_module(changed=False, commands=commands) def test_vyos_interfaces_merged_additional_vrf(self): self.fixture_path = "vyos_interfaces_config_vrf.cfg" set_module_args( dict( config=[ dict( name="eth1", vrf="pink", ), ], state="merged", ), ) commands = [ "set interfaces ethernet eth1 vrf 'pink'", ] self.execute_module(changed=True, commands=commands) def test_vyos_interfaces_gathered_vrf(self): # gathered facts should surface the vrf set on eth2 self.fixture_path = "vyos_interfaces_config_vrf.cfg" set_module_args( dict( config=[], state="gathered", ), ) result = self.execute_module(changed=False) eth2_facts = [i for i in result["gathered"] if i["name"] == "eth2"][0] self.assertEqual(eth2_facts["vrf"], "green") def test_vyos_interfaces_parsed_vrf(self): # parsing a running_config string should surface vrf on eth2 set_module_args( dict( running_config="set interfaces ethernet eth2 vrf 'green'", state="parsed", ), ) result = self.execute_module(changed=False) eth2_facts = [i for i in result["parsed"] if i["name"] == "eth2"][0] self.assertEqual(eth2_facts["vrf"], "green") def test_vyos_interfaces_rendered_vrf(self): # rendered output should include the vrf set command without touching a device set_module_args( dict( config=[ dict( name="eth1", vrf="pink", ), ], state="rendered", ), ) result = self.execute_module(changed=False) commands = [ "set interfaces ethernet eth1 vrf 'pink'", ] self.assertEqual(sorted(result["rendered"]), sorted(commands)) def test_vyos_interfaces_parsed_disable_prefixed_options(self): # disable-link-detect is not disable: the interface stays enabled set_module_args( dict( running_config="set interfaces ethernet eth0 disable-link-detect\n" "set interfaces ethernet eth0 hw-id '00:50:56:00:00:01'", state="parsed", ), ) self.assertEqual( self.execute_module(changed=False)["parsed"], [{"name": "eth0", "enabled": True}], ) def test_vyos_interfaces_parsed_vif_ids_kept_apart(self): # vif 110's lines must not end up in vif 10 set_module_args( dict( running_config="set interfaces ethernet eth1 vif 10 description 'ten'\n" "set interfaces ethernet eth1 vif 110 description 'one-ten'\n" "set interfaces ethernet eth1 vif 110 mtu '1400'", state="parsed", ), ) self.assertEqual( self.execute_module(changed=False)["parsed"], [ { "name": "eth1", "enabled": True, "vifs": [ {"vlan_id": 10, "description": "ten", "enabled": True}, {"vlan_id": 110, "description": "one-ten", "mtu": 1400, "enabled": True}, ], }, ], ) def test_vyos_interfaces_parsed_vif_in_description(self): # a description containing "vif" is an interface option, not a vif line set_module_args( dict( running_config="set interfaces ethernet eth2 description 'vif uplink'\n" "set interfaces ethernet eth2 mtu '1450'", state="parsed", ), ) self.assertEqual( self.execute_module(changed=False)["parsed"], [{"name": "eth2", "description": "vif uplink", "mtu": 1450, "enabled": True}], ) def test_vyos_interfaces_replaced_enable_once(self): # re-enabling a disabled interface deletes disable once, not twice set_module_args(dict(config=[dict(name="eth3")], state="replaced")) self.execute_module( changed=True, commands=[ "delete interfaces ethernet eth3 description", "delete interfaces ethernet eth3 disable", ], ) def test_vyos_interfaces_deleted_not_on_device(self): # an interface without configuration on the device: nothing to delete set_module_args(dict(config=[dict(name="eth9")], state="deleted")) self.execute_module(changed=False, commands=[]) + + def test_vyos_interfaces_parsed_quoted_vif(self): + # a vif without options ends the line, and VyOS quotes its VLAN ID + set_module_args( + dict( + running_config="set interfaces ethernet eth1 vif '10'\n" + "set interfaces ethernet eth1 vif 20 description 'twenty'", + state="parsed", + ), + ) + self.assertEqual( + self.execute_module(changed=False)["parsed"], + [ + { + "name": "eth1", + "enabled": True, + "vifs": [ + {"vlan_id": 10, "enabled": True}, + {"vlan_id": 20, "description": "twenty", "enabled": True}, + ], + }, + ], + )