Add iosxr_vrf_global resource module (#467)

* Add vrf module [WIP]

* adds parsed state & gathered state

* minor changes in config

* working state - parsed & merged

* states implementation

* change name vrf -> vrfs throughout

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* changes

* push changes

* unit tests running :D

* successful integration tests & unit tests

* changes

* changes

* changes

* sanity test fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* review changes

* add iosxr_vrf_globl module

* update changelog fragment

* pylint errors

* updates

* tests up and working :D

* review changes

* addressing review comments

* sanity failures

* set and reset config via config module

* some minor changes

* add changes

* line too long

* update doc

* changes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

README.md

@@ -69,6 +69,7 @@ Name | Description
 [cisco.iosxr.iosxr_static_routes](https://github.com/ansible-collections/cisco.iosxr/blob/main/docs/cisco.iosxr.iosxr_static_routes_module.rst)|Resource module to configure static routes.
 [cisco.iosxr.iosxr_system](https://github.com/ansible-collections/cisco.iosxr/blob/main/docs/cisco.iosxr.iosxr_system_module.rst)|Module to manage the system attributes.
 [cisco.iosxr.iosxr_user](https://github.com/ansible-collections/cisco.iosxr/blob/main/docs/cisco.iosxr.iosxr_user_module.rst)|Module to manage the aggregates of local users.
+[cisco.iosxr.iosxr_vrf_global](https://github.com/ansible-collections/cisco.iosxr/blob/main/docs/cisco.iosxr.iosxr_vrf_global_module.rst)|Manages global VRF configuration.
 
 <!--end collection content-->
 

changelogs/fragments/add_vrf_global_module.yaml

@@ -0,0 +1,4 @@
+---
+minor_changes:
+  - Adds a new module `iosxr_vrf_global` to manage VRF global configurations on Cisco IOS-XR devices.
+  - https://github.com/ansible-collections/cisco.iosxr/pull/467

meta/runtime.yml

@@ -60,3 +60,5 @@ plugin_routing:
       redirect: cisco.iosxr.iosxr_snmp_server
     hostname:
       redirect: cisco.iosxr.iosxr_hostname
+    vrf_global:
+      redirect: cisco.iosxr.iosxr_vrf_global

plugins/action/vrf_global.py

@@ -0,0 +1 @@
+iosxr.py

plugins/module_utils/network/iosxr/argspec/vrf_global/vrf_global.py

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024 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
+
+#############################################
+#                WARNING                    #
+#############################################
+#
+# This file is auto generated by the
+# ansible.content_builder.
+#
+# Manually editing this file is not advised.
+#
+# To update the argspec make the desired changes
+# in the documentation in the module file and re-run
+# ansible.content_builder commenting out
+# the path to external 'docstring' in build.yaml.
+#
+##############################################
+
+"""
+The arg spec for the iosxr_vrf_global module
+"""
+
+
+class Vrf_globalArgs(object):  # pylint: disable=R0903
+    """The arg spec for the iosxr_vrf_global module"""
+
+    argument_spec = {
+        "config": {
+            "type": "list",
+            "elements": "dict",
+            "options": {
+                "name": {"type": "str", "required": True},
+                "description": {"type": "str"},
+                "evpn_route_sync": {"type": "int"},
+                "fallback_vrf": {"type": "str"},
+                "mhost": {
+                    "type": "dict",
+                    "options": {
+                        "afi": {"type": "str", "choices": ["ipv4", "ipv6"]},
+                        "default_interface": {"type": "str"},
+                    },
+                },
+                "rd": {"type": "str"},
+                "remote_route_filtering": {
+                    "type": "dict",
+                    "options": {"disable": {"type": "bool"}},
+                },
+                "vpn": {"type": "dict", "options": {"id": {"type": "str"}}},
+            },
+        },
+        "running_config": {"type": "str"},
+        "state": {
+            "choices": [
+                "parsed",
+                "gathered",
+                "deleted",
+                "merged",
+                "replaced",
+                "rendered",
+                "overridden",
+                "purged",
+            ],
+            "default": "merged",
+            "type": "str",
+        },
+    }  # pylint: disable=C0301

plugins/module_utils/network/iosxr/config/vrf_global/vrf_global.py

@@ -0,0 +1,121 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024 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 iosxr_vrf_global 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 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.ansible.netcommon.plugins.module_utils.network.common.utils import (
+    dict_merge,
+)
+
+from ansible_collections.cisco.iosxr.plugins.module_utils.network.iosxr.facts.facts import Facts
+from ansible_collections.cisco.iosxr.plugins.module_utils.network.iosxr.rm_templates.vrf_global import (
+    Vrf_globalTemplate,
+)
+
+
+class Vrf_global(ResourceModule):
+    """
+    The iosxr_vrf_global config class
+    """
+
+    def __init__(self, module):
+        super(Vrf_global, self).__init__(
+            empty_fact_val=[],
+            facts_module=Facts(module),
+            module=module,
+            resource="vrf_global",
+            tmplt=Vrf_globalTemplate(),
+        )
+        self.parsers = [
+            "description",
+            "evpn_route_sync",
+            "fallback_vrf",
+            "mhost.default_interface",
+            "rd",
+            "remote_route_filtering.disable",
+            "vpn.id",
+        ]
+
+    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 = self.want
+        haved = self.have
+
+        wantd = self._vrf_list_to_dict(wantd)
+        haved = self._vrf_list_to_dict(haved)
+
+        # if state is merged, merge want into have and then compare
+        if self.state == "merged":
+            wantd = dict_merge(haved, wantd)
+
+        # if state is deleted, empty out wantd and set haved to wantd
+        if self.state == "deleted":
+            haved = {k: v for k, v in haved.items() if k in wantd or not wantd}
+            wantd = {}
+
+        # remove superfluous config for overridden and deleted
+        if self.state in ["overridden", "deleted"]:
+            for k, have in haved.items():
+                if k not in wantd:
+                    self._compare(want={}, have=have, vrf=k)
+
+        if self.state == "purged":
+            for k, have in iteritems(haved):
+                self.purge(have)
+
+        for k, want in wantd.items():
+            self._compare(want=want, have=haved.pop(k, {}), vrf=k)
+
+    def _compare(self, want, have, vrf):
+        """Leverages the base class `compare()` method and
+        populates the list of commands to be run by comparing
+        the `want` and `have` data with the `parsers` defined
+        for the Vrf network resource.
+        """
+        begin = len(self.commands)
+        self.compare(self.parsers, want=want, have=have)
+        if len(self.commands) != begin:
+            self.commands.insert(begin, self._tmplt.render({"name": vrf}, "name", False))
+
+    def _vrf_list_to_dict(self, entry):
+        """Convert list of items to dict of items
+           for efficient diff calculation.
+        :params entry: data dictionary
+        """
+        entry = {x["name"]: x for x in entry}
+        return entry
+
+    def purge(self, have):
+        """Purge the VRF configuration"""
+        self.commands.append("no vrf {0}".format(have["name"]))

plugins/module_utils/network/iosxr/facts/facts.py

@@ -94,6 +94,9 @@
 from ansible_collections.cisco.iosxr.plugins.module_utils.network.iosxr.facts.static_routes.static_routes import (
     Static_routesFacts,
 )
+from ansible_collections.cisco.iosxr.plugins.module_utils.network.iosxr.facts.vrf_global.vrf_global import (
+    Vrf_globalFacts,
+)
 
 
 FACT_LEGACY_SUBSETS = dict(
@@ -126,6 +129,7 @@
     snmp_server=Snmp_serverFacts,
     hostname=HostnameFacts,
     bgp_templates=Bgp_templatesFacts,
+    vrf_global=Vrf_globalFacts,
 )
 
 

plugins/module_utils/network/iosxr/facts/vrf_global/vrf_global.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024 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 iosxr vrf_global fact class
+It is in this file the configuration is collected from the device
+for a given resource, parsed, and the facts tree is populated
+based on the configuration.
+"""
+
+from ansible_collections.ansible.netcommon.plugins.module_utils.network.common import utils
+
+from ansible_collections.cisco.iosxr.plugins.module_utils.network.iosxr.argspec.vrf_global.vrf_global import (
+    Vrf_globalArgs,
+)
+from ansible_collections.cisco.iosxr.plugins.module_utils.network.iosxr.rm_templates.vrf_global import (
+    Vrf_globalTemplate,
+)
+from ansible_collections.cisco.iosxr.plugins.module_utils.network.iosxr.utils.utils import (
+    flatten_config,
+)
+
+
+class Vrf_globalFacts(object):
+    """The iosxr vrf facts class"""
+
+    def __init__(self, module, subspec="config", options="options"):
+        self._module = module
+        self.argument_spec = Vrf_globalArgs.argument_spec
+
+    def get_config(self, connection):
+        """Get the configuration from the device"""
+
+        return connection.get("show running-config vrf")
+
+    def populate_facts(self, connection, ansible_facts, data=None):
+        """Populate the facts for Vrf network resource
+        :param connection: the device connection
+        :param ansible_facts: Facts dictionary
+        :param data: previously collected conf
+        :rtype: dictionary
+        :returns: facts
+        """
+
+        facts = {}
+        objs = []
+        obj = {}
+
+        if not data:
+            data = self.get_config(connection)
+
+        data = flatten_config(data, "vrf")
+
+        # parse native config using the Vrf_global template
+        vrf_global_parser = Vrf_globalTemplate(lines=data.splitlines(), module=self._module)
+        obj = vrf_global_parser.parse()
+        objs = list(obj.values())
+
+        ansible_facts["ansible_network_resources"].pop("vrf_global", None)
+        params = utils.remove_empties(
+            vrf_global_parser.validate_config(
+                self.argument_spec,
+                {"config": objs},
+                redact=True,
+            ),
+        )
+
+        facts["vrf_global"] = params.get("config", [])
+        ansible_facts["ansible_network_resources"].update(facts)
+
+        return ansible_facts