feat(anta): Added test case to verify dynamic vlans source

anta/custom_types.py

@@ -238,3 +238,4 @@ def validate_regex(value: str) -> str:
     "Route Cache Route",
     "CBF Leaked Route",
 ]
+DynamicVLANSource = Literal["dmf", "dot1x", "dynvtep", "evpn", "mlag", "mlagsync", "mvpn", "swfwd", "vccbfd"]

anta/tests/vlan.py

@@ -9,7 +9,9 @@
 
 from typing import TYPE_CHECKING, ClassVar, Literal
 
-from anta.custom_types import Vlan
+from pydantic import ConfigDict
+
+from anta.custom_types import DynamicVLANSource, Vlan
 from anta.models import AntaCommand, AntaTest
 from anta.tools import get_failed_logs, get_value
 
@@ -68,3 +70,76 @@ def test(self) -> None:
             self.result.is_failure(failed_log)
         else:
             self.result.is_success()
+
+
+class VerifyDynamicVlanSource(AntaTest):
+    """Verifies dynamic VLAN(s) source.
+
+    This test performs the following checks for specified dynamic VLAN(s):
+
+      1. Ensures that dynamic VLAN(s) are properly configured in the system.
+      2. Confirms that dynamic VLAN(s) are enabled for any/all the designated sources and disabled for all others.
+      3. When strict mode is enabled (`strict: true`):
+        - Dynamic VLAN(s) are enabled for all designated sources.
+
+    Expected Results
+    ----------------
+    * Success: The test will pass if all of the following conditions are met:
+        - The dynamic VLAN(s) are properly configured in the system.
+        - The dynamic VLAN(s) are enabled for any/all of the designated sources and disabled for all others.
+        - In strict mode, dynamic VLAN(s) are enabled for all designated sources.
+    * Failure: The test will fail if any of the following conditions is met:
+        - The dynamic VLAN(s) are disabled on all designated sources, or active on non designated sources.
+        - In strict mode, dynamic VLAN(s) are disabled on any of the designated sources.
+    * Skipped: The test will Skip if the following conditions is met:
+        - Dynamic VLAN(s) are not configured on the device.
+
+    Examples
+    --------
+    ```yaml
+    anta.tests.vlan:
+      - VerifyDynamicVlanSource:
+          source:
+            - evpn
+            - mlagsync
+          strict: False
+    ```
+    """
+
+    categories: ClassVar[list[str]] = ["vlan"]
+    commands: ClassVar[list[AntaCommand | AntaTemplate]] = [AntaCommand(command="show vlan dynamic", revision=1)]
+
+    class Input(AntaTest.Input):
+        """Input model for the VerifyDynamicVlanSource test."""
+
+        model_config = ConfigDict(extra="forbid")
+        source: list[DynamicVLANSource]
+        """The dynamic VLAN(s) source list."""
+        strict: bool = False
+        """If True, requires exact match of the provided dynamic VLAN(s) sources, Defaults to `False`"""
+
+    @AntaTest.anta_test
+    def test(self) -> None:
+        """Main test function for VerifyDynamicVlanSource."""
+        self.result.is_success()
+        command_output = self.instance_commands[0].json_output
+        dynamic_vlans = command_output.get("dynamicVlans", {})
+
+        actual_source = [source for source, data in dynamic_vlans.items() if data.get("vlanIds")]
+        # If the dynamic vlans are not configured, skipping the test.
+        if not actual_source:
+            self.result.is_skipped("Dynamic VLANs are not configured")
+            return
+
+        expected_source = self.inputs.source
+        str_expected_source = ", ".join(expected_source)
+        str_actual_source = ", ".join(actual_source)
+
+        # If strict flag is True and dynamic VLAN(s) are disabled on any of the designated sources, test fails.
+        if self.inputs.strict and sorted(actual_source) != (expected_source):
+            self.result.is_failure(f"Dynamic VLAN(s) source mismatch - Expected: {str_expected_source} Actual: {str_actual_source}")
+            return
+
+        # The dynamic VLAN(s) are disabled on all designated sources, or active on non designated sources, test fails.
+        if not set(actual_source).issubset(expected_source):
+            self.result.is_failure(f"Dynamic VLAN(s) source mismatch - {str_actual_source} are not in the expected sources: {str_expected_source}.")

examples/tests.yaml

@@ -836,6 +836,12 @@ anta.tests.system:
       # Verifies the device uptime.
       minimum: 86400
 anta.tests.vlan:
+  - VerifyDynamicVlanSource:
+      # Verifies dynamic VLAN(s) source.
+      source:
+        - evpn
+        - mlagsync
+      strict: False
   - VerifyVlanInternalPolicy:
       # Verifies the VLAN internal allocation policy and the range of VLANs.
       policy: ascending

tests/units/anta_tests/test_vlan.py

@@ -7,7 +7,7 @@
 
 from typing import Any
 
-from anta.tests.vlan import VerifyVlanInternalPolicy
+from anta.tests.vlan import VerifyDynamicVlanSource, VerifyVlanInternalPolicy
 from tests.units.anta_tests import test
 
 DATA: list[dict[str, Any]] = [
@@ -33,4 +33,53 @@
             ],
         },
     },
+    {
+        "name": "success",
+        "test": VerifyDynamicVlanSource,
+        "eos_data": [{"dynamicVlans": {"evpn": {"vlanIds": [1199]}, "mlagsync": {"vlanIds": []}}}],
+        "inputs": {"source": ["evpn", "mlagsync"], "strict": False},
+        "expected": {"result": "success"},
+    },
+    {
+        "name": "failure-no-dynamic-vlans",
+        "test": VerifyDynamicVlanSource,
+        "eos_data": [{"dynamicVlans": {}}],
+        "inputs": {"source": ["evpn", "mlagsync"], "strict": False},
+        "expected": {"result": "skipped", "messages": ["Dynamic VLANs are not configured"]},
+    },
+    {
+        "name": "failure-dynamic-vlan-source-invalid",
+        "test": VerifyDynamicVlanSource,
+        "eos_data": [{"dynamicVlans": {"vccbfd": {"vlanIds": [1500]}, "mlagsync": {"vlanIds": [1501]}}}],
+        "inputs": {"source": ["evpn", "mlagsync"], "strict": False},
+        "expected": {"result": "failure", "messages": ["Dynamic VLAN(s) source mismatch - vccbfd, mlagsync are not in the expected sources: evpn, mlagsync."]},
+    },
+    {
+        "name": "failure-any-source-match-additional-source-found",
+        "test": VerifyDynamicVlanSource,
+        "eos_data": [{"dynamicVlans": {"evpn": {"vlanIds": [1199]}, "mlagsync": {"vlanIds": [1501]}, "vccbfd": {"vlanIds": [1500]}}}],
+        "inputs": {"source": ["evpn", "mlagsync"], "strict": False},
+        "expected": {"result": "failure", "messages": ["Dynamic VLAN(s) source mismatch - evpn, mlagsync, vccbfd are not in the expected sources: evpn, mlagsync."]},
+    },
+    {
+        "name": "success-strict-mode",
+        "test": VerifyDynamicVlanSource,
+        "eos_data": [{"dynamicVlans": {"evpn": {"vlanIds": [1199]}, "mlagsync": {"vlanIds": [1502]}}}],
+        "inputs": {"source": ["evpn", "mlagsync"], "strict": True},
+        "expected": {"result": "success"},
+    },
+    {
+        "name": "failure-all-source-exact-match-additional-source-found",
+        "test": VerifyDynamicVlanSource,
+        "eos_data": [{"dynamicVlans": {"evpn": {"vlanIds": [1199]}, "mlagsync": {"vlanIds": [1500]}, "vccbfd": {"vlanIds": [1500]}}}],
+        "inputs": {"source": ["evpn", "mlagsync"], "strict": True},
+        "expected": {"result": "failure", "messages": ["Dynamic VLAN(s) source mismatch - Expected: evpn, mlagsync Actual: evpn, mlagsync, vccbfd"]},
+    },
+    {
+        "name": "failure-all-source-exact-match-expected-source-not-found",
+        "test": VerifyDynamicVlanSource,
+        "eos_data": [{"dynamicVlans": {"evpn": {"vlanIds": [1199]}, "mlagsync": {"vlanIds": []}}}],
+        "inputs": {"source": ["evpn", "mlagsync"], "strict": True},
+        "expected": {"result": "failure", "messages": ["Dynamic VLAN(s) source mismatch - Expected: evpn, mlagsync Actual: evpn"]},
+    },
 ]