Updated test name and model name

aristanetworks · Dec 2, 2024 · fe4d354 · fe4d354
1 parent 6fb100f
commit fe4d354
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 17 deletions.
diff --git a/anta/input_models/stun.py b/anta/input_models/stun.py
@@ -12,8 +12,8 @@
 from anta.custom_types import Port
 
 
-class ClientAddress(BaseModel):
-    """STUN (Session Traversal Utilities for NAT) model represents the configuration of an IPv4-based client."""
+class StunClientTranslation(BaseModel):
+    """STUN (Session Traversal Utilities for NAT) model represents the configuration of an IPv4-based client translations."""
 
     model_config = ConfigDict(extra="forbid")
     source_address: IPv4Address
@@ -26,7 +26,7 @@ class ClientAddress(BaseModel):
     """The public-facing port number of the STUN client, discovered via the STUN server."""
 
     def __str__(self) -> str:
-        """Return a human-readable string representation of the ClientAddress for reporting.
+        """Return a human-readable string representation of the StunClientTranslation for reporting.
 
         Examples
         --------

diff --git a/anta/tests/stun.py b/anta/tests/stun.py
@@ -9,12 +9,12 @@
 
 from typing import ClassVar
 
-from anta.input_models.stun import ClientAddress
+from anta.input_models.stun import StunClientTranslation
 from anta.models import AntaCommand, AntaTemplate, AntaTest
 from anta.tools import get_value
 
 
-class VerifyStunClient(AntaTest):
+class VerifyStunClientTranslation(AntaTest):
     """Verifies the translation for a source address on a STUN client.
 
     This test performs the following checks for each specified address family:
@@ -35,7 +35,7 @@ class VerifyStunClient(AntaTest):
     --------
     ```yaml
     anta.tests.stun:
-      - VerifyStunClient:
+      - VerifyStunClientTranslation:
           stun_clients:
             - source_address: 172.18.3.2
               public_address: 172.18.3.21
@@ -52,19 +52,19 @@ class VerifyStunClient(AntaTest):
     commands: ClassVar[list[AntaCommand | AntaTemplate]] = [AntaTemplate(template="show stun client translations {source_address} {source_port}", revision=1)]
 
     class Input(AntaTest.Input):
-        """Input model for the VerifyStunClient test."""
+        """Input model for the VerifyStunClientTranslation test."""
 
-        stun_clients: list[ClientAddress]
+        stun_clients: list[StunClientTranslation]
         """List of STUN clients."""
-        ClientAddress: ClassVar[type[ClientAddress]] = ClientAddress
+        StunClientTranslation: ClassVar[type[StunClientTranslation]] = StunClientTranslation
 
     def render(self, template: AntaTemplate) -> list[AntaCommand]:
         """Render the template for each STUN translation."""
         return [template.render(source_address=client.source_address, source_port=client.source_port) for client in self.inputs.stun_clients]
 
     @AntaTest.anta_test
     def test(self) -> None:
-        """Main test function for VerifyStunClient."""
+        """Main test function for VerifyStunClientTranslation."""
         self.result.is_success()
 
         # Iterate over each command output and corresponding client input

diff --git a/examples/tests.yaml b/examples/tests.yaml
@@ -443,7 +443,7 @@ anta.tests.stp:
       threshold: 10
 
 anta.tests.stun:
-  - VerifyStunClient:
+  - VerifyStunClientTranslation:
       stun_clients:
         - source_address: 172.18.3.2
           public_address: 172.18.3.21

diff --git a/tests/units/anta_tests/test_stun.py b/tests/units/anta_tests/test_stun.py
@@ -7,13 +7,13 @@
 
 from typing import Any
 
-from anta.tests.stun import VerifyStunClient, VerifyStunServer
+from anta.tests.stun import VerifyStunClientTranslation, VerifyStunServer
 from tests.units.anta_tests import test
 
 DATA: list[dict[str, Any]] = [
     {
         "name": "success",
-        "test": VerifyStunClient,
+        "test": VerifyStunClientTranslation,
         "eos_data": [
             {
                 "bindings": {
@@ -60,7 +60,7 @@
     },
     {
         "name": "failure-incorrect-public-ip",
-        "test": VerifyStunClient,
+        "test": VerifyStunClientTranslation,
         "eos_data": [
             {
                 "bindings": {
@@ -95,7 +95,7 @@
     },
     {
         "name": "failure-no-client",
-        "test": VerifyStunClient,
+        "test": VerifyStunClientTranslation,
         "eos_data": [
             {"bindings": {}},
             {"bindings": {}},
@@ -113,7 +113,7 @@
     },
     {
         "name": "failure-incorrect-public-port",
-        "test": VerifyStunClient,
+        "test": VerifyStunClientTranslation,
         "eos_data": [
             {"bindings": {}},
             {
@@ -142,7 +142,7 @@
     },
     {
         "name": "failure-all-type",
-        "test": VerifyStunClient,
+        "test": VerifyStunClientTranslation,
         "eos_data": [
             {"bindings": {}},
             {