issue_821 Handling review comments: updated the failure msgs

aristanetworks · Oct 9, 2024 · 47a8646 · 47a8646
1 parent 61cd6d2
commit 47a8646
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 9 deletions.
diff --git a/anta/tests/snmp.py b/anta/tests/snmp.py
@@ -12,7 +12,7 @@
 
 from pydantic import BaseModel
 
-from anta.custom_types import PositiveInteger
+from anta.custom_types import Hostname, PositiveInteger
 from anta.models import AntaCommand, AntaTest
 from anta.tools import get_value
 
@@ -256,9 +256,9 @@ class VerifySnmpLogging(AntaTest):
     anta.tests.snmp:
       - VerifySnmpLogging:
           hosts:
-            - 192.168.1.100
+            - hostname: 192.168.1.100
               vrf: default
-            - 192.168.1.101
+            - hostname: 192.168.1.103
               vrf: MGMT
     ```
     """
@@ -277,8 +277,8 @@ class Input(AntaTest.Input):
         class SNMPHost(BaseModel):
             """Model for a SNMP Host."""
 
-            hostname: IPv4Address
-            """IPv4 address of the SNMP notification host."""
+            hostname: IPv4Address | Hostname
+            """IPv4 address or hostname of the SNMP notification host."""
             vrf: str = "default"
             """Optional VRF for SNMP Hosts. If not provided, it defaults to `default`."""
 
@@ -305,7 +305,7 @@ def test(self) -> None:
                 failures += f"SNMP host '{hostname }' is not configured.\n"
                 continue
             if actual_vrf != vrf:
-                failures += f"SNMP host '{hostname }' is not correctly configured in specified vrf '{vrf}'.\n"
+                failures += f"For SNMP host '{hostname }', expected '{vrf}' as vrf but found '{actual_vrf}' instead.\n"
 
         # Check if there are any failures.
         if not failures:

diff --git a/tests/units/anta_tests/test_snmp.py b/tests/units/anta_tests/test_snmp.py
@@ -155,8 +155,21 @@
     {
         "name": "success",
         "test": VerifySnmpLogging,
-        "eos_data": [{"logging": {"loggingEnabled": True, "hosts": {"192.168.1.100": {"port": 162, "vrf": ""}, "192.168.1.101": {"port": 162, "vrf": "MGMT"}}}}],
-        "inputs": {"hosts": [{"hostname": "192.168.1.100", "vrf": "default"}, {"hostname": "192.168.1.101", "vrf": "MGMT"}]},
+        "eos_data": [
+            {
+                "logging": {
+                    "loggingEnabled": True,
+                    "hosts": {
+                        "192.168.1.100": {"port": 162, "vrf": ""},
+                        "192.168.1.101": {"port": 162, "vrf": "MGMT"},
+                        "snmp-server-01": {"port": 162, "vrf": "MGMT"},
+                    },
+                }
+            }
+        ],
+        "inputs": {
+            "hosts": [{"hostname": "192.168.1.100", "vrf": "default"}, {"hostname": "192.168.1.101", "vrf": "MGMT"}, {"hostname": "snmp-server-01", "vrf": "MGMT"}]
+        },
         "expected": {"result": "success"},
     },
     {
@@ -173,7 +186,7 @@
         "inputs": {"hosts": [{"hostname": "192.168.1.100", "vrf": "default"}, {"hostname": "192.168.1.101", "vrf": "MGMT"}]},
         "expected": {
             "result": "failure",
-            "messages": ["SNMP host '192.168.1.100' is not correctly configured in specified vrf 'default'.\nSNMP host '192.168.1.101' is not configured."],
+            "messages": ["For SNMP host '192.168.1.100', expected 'default' as vrf but found 'MGMT' instead.\nSNMP host '192.168.1.101' is not configured."],
         },
     },
 ]