Add Vyos hostname resource module (#237)

Add Vyos hostname resource module

SUMMARY


ISSUE TYPE


New Module Pull Request

COMPONENT NAME

ADDITIONAL INFORMATION

Reviewed-by: Nilashish Chakraborty <nilashishchakraborty8@gmail.com>
Reviewed-by: None <None>

8 files changed, 251 insertions, 0 deletions

diff --git a/plugins/module_utils/network/vyos/argspec/hostname/__init__.py b/plugins/module_utils/network/vyos/argspec/hostname/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/plugins/module_utils/network/vyos/argspec/hostname/__init__.py
diff --git a/plugins/module_utils/network/vyos/argspec/hostname/hostname.py b/plugins/module_utils/network/vyos/argspec/hostname/hostname.py
new file mode 100644
index 00000000..1a3cf91f
--- /dev/null
+++ b/plugins/module_utils/network/vyos/argspec/hostname/hostname.py
@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+# Copyright 2022 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
+# cli_rm_builder.
+#
+# Manually editing this file is not advised.
+#
+# To update the argspec make the desired changes
+# in the module docstring and re-run
+# cli_rm_builder.
+#
+#############################################
+
+"""
+The arg spec for the vyos_hostname module
+"""
+
+
+class HostnameArgs(object):  # pylint: disable=R0903
+    """The arg spec for the vyos_hostname module"""
+
+    argument_spec = {
+        "config": {"type": "dict", "options": {"hostname": {"type": "str"}}},
+        "running_config": {"type": "str"},
+        "state": {
+            "choices": [
+                "merged",
+                "replaced",
+                "overridden",
+                "deleted",
+                "gathered",
+                "parsed",
+                "rendered",
+            ],
+            "default": "merged",
+            "type": "str",
+        },
+    }  # pylint: disable=C0301
diff --git a/plugins/module_utils/network/vyos/config/hostname/__init__.py b/plugins/module_utils/network/vyos/config/hostname/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/plugins/module_utils/network/vyos/config/hostname/__init__.py
diff --git a/plugins/module_utils/network/vyos/config/hostname/hostname.py b/plugins/module_utils/network/vyos/config/hostname/hostname.py
new file mode 100644
index 00000000..cf2c8c26
--- /dev/null
+++ b/plugins/module_utils/network/vyos/config/hostname/hostname.py
@@ -0,0 +1,75 @@
+#
+# -*- coding: utf-8 -*-
+# Copyright 2022 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_hostname 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_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.hostname import (
+    HostnameTemplate,
+)
+
+
+class Hostname(ResourceModule):
+    """
+    The vyos_hostname config class
+    """
+
+    def __init__(self, module):
+        super(Hostname, self).__init__(
+            empty_fact_val={},
+            facts_module=Facts(module),
+            module=module,
+            resource="hostname",
+            tmplt=HostnameTemplate(),
+        )
+        self.parsers = []
+
+    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
+
+        if self.state == "deleted":
+            wantd = {}
+
+        self._compare(want=wantd, have=haved)
+
+    def _compare(self, want, have):
+        """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 Hostname network resource.
+        """
+        self.compare(parsers="hostname", want=want, have=have)
diff --git a/plugins/module_utils/network/vyos/facts/facts.py b/plugins/module_utils/network/vyos/facts/facts.py
index 76cfd907..867c427f 100644
--- a/plugins/module_utils/network/vyos/facts/facts.py
+++ b/plugins/module_utils/network/vyos/facts/facts.py
@@ -70,6 +70,9 @@ from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.ntp_g
 from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.snmp_server.snmp_server import (
     Snmp_serverFacts,
 )
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.hostname.hostname import (
+    HostnameFacts,
+)
 from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.facts.legacy.base import (
     Default,
     Neighbors,
@@ -98,6 +101,7 @@ FACT_RESOURCE_SUBSETS = dict(
     logging_global=Logging_globalFacts,
     ntp_global=Ntp_globalFacts,
     snmp_server=Snmp_serverFacts,
+    hostname=HostnameFacts,
 )
 
 
diff --git a/plugins/module_utils/network/vyos/facts/hostname/__init__.py b/plugins/module_utils/network/vyos/facts/hostname/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/plugins/module_utils/network/vyos/facts/hostname/__init__.py
diff --git a/plugins/module_utils/network/vyos/facts/hostname/hostname.py b/plugins/module_utils/network/vyos/facts/hostname/hostname.py
new file mode 100644
index 00000000..acdddca0
--- /dev/null
+++ b/plugins/module_utils/network/vyos/facts/hostname/hostname.py
@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+# Copyright 2022 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 hostname 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.vyos.vyos.plugins.module_utils.network.vyos.rm_templates.hostname import (
+    HostnameTemplate,
+)
+from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.argspec.hostname.hostname import (
+    HostnameArgs,
+)
+
+import re
+
+
+class HostnameFacts(object):
+    """The vyos hostname facts class"""
+
+    def __init__(self, module, subspec="config", options="options"):
+        self._module = module
+        self.argument_spec = HostnameArgs.argument_spec
+
+    def get_config(self, connection):
+        return connection.get("show configuration commands | grep host-name")
+
+    def populate_facts(self, connection, ansible_facts, data=None):
+        """Populate the facts for Snmp_server network resource
+
+        :param connection: the device connection
+        :param ansible_facts: Facts dictionary
+        :param data: previously collected conf
+
+        :rtype: dictionary
+        :returns: facts
+        """
+        facts = {}
+        objs = []
+        config_lines = []
+
+        if not data:
+            data = self.get_config(connection)
+        for resource in data.splitlines():
+            config_lines.append(re.sub("'", "", resource))
+
+        # parse native config using the Hostname template
+        hostname_parser = HostnameTemplate(
+            lines=config_lines, module=self._module
+        )
+        objs = hostname_parser.parse()
+
+        ansible_facts["ansible_network_resources"].pop("hostname", None)
+
+        params = utils.remove_empties(
+            hostname_parser.validate_config(
+                self.argument_spec, {"config": objs}, redact=True
+            )
+        )
+
+        facts["hostname"] = params.get("config", {})
+        ansible_facts["ansible_network_resources"].update(facts)
+
+        return ansible_facts
diff --git a/plugins/module_utils/network/vyos/rm_templates/hostname.py b/plugins/module_utils/network/vyos/rm_templates/hostname.py
new file mode 100644
index 00000000..79caee6d
--- /dev/null
+++ b/plugins/module_utils/network/vyos/rm_templates/hostname.py
@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+# Copyright 2022 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 Hostname 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,
+)
+
+
+class HostnameTemplate(NetworkTemplate):
+    def __init__(self, lines=None, module=None):
+        prefix = {"set": "set", "remove": "delete"}
+        super(HostnameTemplate, self).__init__(
+            lines=lines, tmplt=self, prefix=prefix, module=module
+        )
+
+    # fmt: off
+    PARSERS = [
+        # service snmp community <>
+        {
+            "name": "hostname",
+            "getval": re.compile(
+                r"""
+                ^set\ssystem\shost-name
+                \s+(?P<name>\S+)
+                $""",
+                re.VERBOSE),
+            "setval": "system host-name {{ hostname }}",
+            "result": {
+                "hostname": "{{ name }}"
+            }
+        },
+    ]
+    # fmt: on