feat(anta.tests): Added testcase to verify domain name to IP address translation

anta/tests/services.py

@@ -0,0 +1,48 @@
+# Copyright (c) 2023-2024 Arista Networks, Inc.
+# Use of this source code is governed by the Apache License 2.0
+# that can be found in the LICENSE file.
+"""
+Test functions related to the EOS various service settings
+"""
+from __future__ import annotations
+
+from typing import List
+
+from anta.models import AntaCommand, AntaTemplate, AntaTest
+
+# Mypy does not understand AntaTest.Input typing
+# mypy: disable-error-code=attr-defined
+
+
+class VerifyDNSLookup(AntaTest):
+    """
+    This class verifies the DNS(Domain name service) name to IP address translation.
+
+    Expected Results:
+        * success: The test will pass if a domain name is resolved to an IP address.
+        * failure: The test will fail if a domain name does not resolve to an IP address.
+        * error: This test will error out if a domain name is not correct.
+    """
+
+    name = "VerifyDNSLookup"
+    description = "Verifies the DNS(Domain name service) name to IP address translation."
+    categories = ["services"]
+    commands = [AntaTemplate(template="bash timeout 10 nslookup {domain}")]
+
+    class Input(AntaTest.Input):
+        """Inputs for the VerifyDNSLookup test."""
+
+        domain_names: List[str]
+        """List of domain names"""
+
+    def render(self, template: AntaTemplate) -> list[AntaCommand]:
+        return [template.render(domain=domain_name) for domain_name in self.inputs.domain_names]
+
+    @AntaTest.anta_test
+    def test(self) -> None:
+        self.result.is_success()
+        for command in self.instance_commands:
+            domain = command.params["domain"]
+            output = command.json_output["messages"][0]
+            if f"Can't find {domain}: No answer" in output:
+                self.result.is_failure(f"Domain {domain} is not resolved to an IP address.")

examples/tests.yaml

@@ -206,6 +206,13 @@ anta.tests.security:
           encryption_algorithm: RSA
           key_size: 4096
 
+anta.tests.services:
+  - VerifyDNSLookup:
+      domain_names:
+        - arista.com
+        - www.google.com
+        - khatri.com
+
 anta.tests.snmp:
   - VerifySnmpStatus:
       vrf: default

tests/units/anta_tests/test_services.py

@@ -0,0 +1,46 @@
+# Copyright (c) 2023-2024 Arista Networks, Inc.
+# Use of this source code is governed by the Apache License 2.0
+# that can be found in the LICENSE file.
+"""
+Tests for anta.tests.security.py
+"""
+from __future__ import annotations
+
+from typing import Any
+
+from anta.tests.services import VerifyDNSLookup
+from tests.lib.anta import test  # noqa: F401; pylint: disable=W0611
+
+DATA: list[dict[str, Any]] = [
+    {
+        "name": "success",
+        "test": VerifyDNSLookup,
+        "eos_data": [
+            {
+                "messages": [
+                    "Server:\t\t127.0.0.1\nAddress:\t127.0.0.1#53\n\nNon-authoritative answer:\nName:\tarista.com\nAddress: 151.101.130.132\nName:\tarista.com\n"
+                    "Address: 151.101.2.132\nName:\tarista.com\nAddress: 151.101.194.132\nName:\tarista.com\nAddress: 151.101.66.132\n\n"
+                ]
+            },
+            {"messages": ["Server:\t\t127.0.0.1\nAddress:\t127.0.0.1#53\n\nNon-authoritative answer:\nName:\twww.google.com\nAddress: 172.217.12.100\n\n"]},
+        ],
+        "inputs": {"domain_names": ["arista.com", "www.google.com"]},
+        "expected": {"result": "success"},
+    },
+    {
+        "name": "failure",
+        "test": VerifyDNSLookup,
+        "eos_data": [
+            {
+                "messages": [
+                    "Server:\t\t127.0.0.1\nAddress:\t127.0.0.1#53\n\nNon-authoritative answer:\nName:\tarista.com\nAddress: 151.101.130.132\nName:\tarista.com\n"
+                    "Address: 151.101.2.132\nName:\tarista.com\nAddress: 151.101.194.132\nName:\tarista.com\nAddress: 151.101.66.132\n\n"
+                ]
+            },
+            {"messages": ["Server:\t\t127.0.0.1\nAddress:\t127.0.0.1#53\n\nNon-authoritative answer:\nName:\twww.google.com\nAddress: 172.217.12.100\n\n"]},
+            {"messages": ["Server:\t\t127.0.0.1\nAddress:\t127.0.0.1#53\n\nNon-authoritative answer:\n*** Can't find khatri.com: No answer\n\n"]},
+        ],
+        "inputs": {"domain_names": ["arista.com", "www.google.com", "khatri.com"]},
+        "expected": {"result": "failure", "messages": ["Domain khatri.com is not resolved to an IP address."]},
+    },
+]