Added unit test for str function, fixed congnetive complexity issue

Author: geetanjalimanegslab

anta/input_models/routing/bgp.py

@@ -40,10 +40,6 @@
 }
 """Dictionary mapping AFI/SAFI to EOS key representation."""
 
-AFI_SAFI_REDISTRIBUTED_ROUTE_KEY = {"ipv4Unicast": "v4u", "ipv4Multicast": "v4m", "ipv6Unicast": "v6u", "ipv6Multicast": "v6m"}
-
-"""Dictionary mapping of AFI/SAFI to redistributed routes key representation."""
-
 
 class BgpAddressFamily(BaseModel):
     """Model for a BGP address family."""
@@ -103,11 +99,6 @@ def eos_key(self) -> str:
         # Pydantic handles the validation of the AFI/SAFI combination, so we can ignore error handling here.
         return AFI_SAFI_EOS_KEY[(self.afi, self.safi)]
 
-    @property
-    def redistributed_route_key(self) -> str:
-        """AFI/SAFI  Redistributed route key representation."""
-        return AFI_SAFI_REDISTRIBUTED_ROUTE_KEY[self.eos_key]
-
     def __str__(self) -> str:
         """Return a human-readable string representation of the BgpAddressFamily for reporting.
 

anta/tests/routing/bgp.py

@@ -7,7 +7,7 @@
 # mypy: disable-error-code=attr-defined
 from __future__ import annotations
 
-from typing import ClassVar, TypeVar
+from typing import Any, ClassVar, TypeVar
 
 from pydantic import field_validator
 
@@ -1716,24 +1716,24 @@ class VerifyBGPRedistribution(AntaTest):
     anta.tests.routing:
       bgp:
         - VerifyBGPRedistribution:
-          vrfs:
-            - vrf: default
-              address_families:
-                - afi_safi: ipv4Unicast
-                  redistributed_routes:
-                    - proto: Connected
-                      include_leaked: True
-                      route_map: RM-CONN-2-BGP
-                    - proto: Static
-                      include_leaked: True
-                      route_map: RM-CONN-2-BGP
-                - afi_safi: IPv6 Unicast
-                  redistributed_routes:
-                    - proto: Dynamic
-                      route_map: RM-CONN-2-BGP
-                    - proto: Static
-                      include_leaked: True
-                      route_map: RM-CONN-2-BGP
+            vrfs:
+              - vrf: default
+                address_families:
+                  - afi_safi: ipv4Unicast
+                    redistributed_routes:
+                      - proto: Connected
+                        include_leaked: True
+                        route_map: RM-CONN-2-BGP
+                      - proto: Static
+                        include_leaked: True
+                        route_map: RM-CONN-2-BGP
+                  - afi_safi: IPv6 Unicast
+                    redistributed_routes:
+                      - proto: Dynamic
+                        route_map: RM-CONN-2-BGP
+                      - proto: Static
+                        include_leaked: True
+                        route_map: RM-CONN-2-BGP
     ```
     """
 
@@ -1746,6 +1746,22 @@ class Input(AntaTest.Input):
         vrfs: list[BgpVrf]
         """List of address families."""
 
+    def _validate_redistribute_route_details(self, vrf_data: str, address_family: dict[str, Any], afi_safi_configs: list[dict[str, Any]]) -> None:
+        """Validate the redstributed route details for a given address family."""
+        for route_info in address_family.redistributed_routes:
+            # If the redistributed route protocol does not match the expected value, test fails.
+            if not (actual_route := get_item(afi_safi_configs.get("redistributedRoutes"), "proto", route_info.proto)):
+                self.result.is_failure(f"{vrf_data}, {address_family}, {route_info} - Not configured")
+                continue
+
+            # If includes leaked field applicable, and it does not matches the expected value, test fails.
+            if all([route_info.include_leaked is not None, (act_include_leaked := actual_route.get("includeLeaked", "Not Found")) != route_info.include_leaked]):
+                self.result.is_failure(f"{vrf_data}, {address_family}, {route_info} - Value for included leaked mismatch - Actual: {act_include_leaked}")
+
+            # If route map is required and it is not matching the expected value, test fails.
+            if all([route_info.route_map, (act_route_map := actual_route.get("routeMap", "Not Found")) != route_info.route_map]):
+                self.result.is_failure(f"{vrf_data}, {address_family}, {route_info} - Route map mismatch - Actual: {act_route_map}")
+
     @AntaTest.anta_test
     def test(self) -> None:
         """Main test function for VerifyBGPRedistribution."""
@@ -1758,16 +1774,4 @@ def test(self) -> None:
                 if not (afi_safi_configs := get_value(command_output, f"vrfs.{vrf_data.vrf}.afiSafiConfig.{address_family.afi_safi}")):
                     self.result.is_failure(f"{vrf_data}, {address_family} - Not configured")
                     continue
-                for route_info in address_family.redistributed_routes:
-                    # If the redistributed route protocol does not match the expected value, test fails.
-                    if not (actual_route := get_item(afi_safi_configs.get("redistributedRoutes"), "proto", route_info.proto)):
-                        self.result.is_failure(f"{vrf_data}, {address_family}, {route_info} - Not configured")
-                        continue
-
-                    # If includes leaked field applicable, and it does not matches the expected value, test fails.
-                    if all([route_info.include_leaked is not None, (act_include_leaked := actual_route.get("includeLeaked")) != route_info.include_leaked]):
-                        self.result.is_failure(f"{vrf_data}, {address_family}, {route_info} - Value for included leaked mismatch - Actual: {act_include_leaked}")
-
-                    # If route map is required and it is not matching the expected value, test fails.
-                    if all([route_info.route_map, (act_route_map := actual_route.get("routeMap", "Not Found")) != route_info.route_map]):
-                        self.result.is_failure(f"{vrf_data}, {address_family}, {route_info} - Route map mismatch - Actual: {act_route_map}")
+                self._validate_redistribute_route_details(str(vrf_data), address_family, afi_safi_configs)

tests/units/input_models/routing/test_bgp.py

@@ -317,6 +317,18 @@ def test_invalid(self, proto: RedistributedProtocol, include_leaked: bool) -> No
         with pytest.raises(ValidationError):
             RedistributedRoute(proto=proto, include_leaked=include_leaked)
 
+    @pytest.mark.parametrize(
+        ("proto", "include_leaked", "route_map", "expected"),
+        [
+            pytest.param("Connected", True, "RM-CONN-2-BGP", "Proto: Connected, Included Leaked: True, Route Map: RM-CONN-2-BGP", id="check-all-params"),
+            pytest.param("Static", False, None, "Proto: Static, Included Leaked: False", id="check-proto-include_leaked"),
+            pytest.param("Bgp", None, "RM-CONN-2-BGP", "Proto: Bgp, Route Map: RM-CONN-2-BGP", id="check-proto-route_map"),
+        ],
+    )
+    def test_valid_str(self, proto: RedistributedProtocol, include_leaked: bool | None, route_map: str | None, expected: str) -> None:
+        """Test RedistributedRoute __str__."""
+        assert str(RedistributedRoute(proto=proto, include_leaked=include_leaked, route_map=route_map)) == expected
+
 
 class TestVerifyBGPAddressFamilyConfig:
     """Test anta.tests.routing.bgp.AddressFamilyConfig.Input."""