feat(anta.tests): Adding the test case to verify BGP ECMP path install(On Hold) #507

MaheshGSLAB · 2024-01-02T09:03:11Z

Description

Adding the test case to verify BGP ECMP path install

Test catalog:

anta.tests.routing:
  bgp:
      - VerifyBGPEcmpPath:
          bgp_routes:
            - route: 192.0.254.5/32
              vrf: default
            - route: 192.0.254.3/32
              vrf: default

Testcase pass if route is contributed into ECMP and at least one path is ECMP head in specified vrf.


                                                                          All tests results                                                                           
┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃ Device    ┃ Test Name         ┃ Test Status ┃ Message(s) ┃ Test description                                                                        ┃ Test category ┃
┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ s1-spine1 │ VerifyBGPEcmpPath │ success     │            │ Verifies the installation of BGP Equal-Cost Multipath (ECMP) path in the specified VRF. │ routing, bgp  │
└───────────┴───────────────────┴─────────────┴────────────┴─────────────────────────────────────────────────────────────────────────────────────────┴───────────────┘

Testcase fail if route is not found in the specified vrf.

                                                                                         All tests results                                                                                           
┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃ Device    ┃ Test Name         ┃ Test Status ┃ Message(s)                                                        ┃ Test description                                                 ┃ Test category ┃
┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ s1-spine1 │ VerifyBGPEcmpPath │ failure     │ Following BGP routes are not configured, not contributed in ecmp, │ Verifies the installation of BGP Equal-Cost Multipath (ECMP)     │ routing, bgp  │
│           │                   │             │ or ecmp head is not found:                                        │ path in the specified VRF.                                       │               │
│           │                   │             │ {'192.0.254.5/32': {'MGMT': 'Not configured'}}                    │                                                                  │               │
└───────────┴───────────────────┴─────────────┴───────────────────────────────────────────────────────────────────┴──────────────────────────────────────────────────────────────────┴───────────────┘

Testcase fail if route is not contributed in ECMP or ECMP head is not found in the specified vrf.

                                                                                         All tests results                                                                                           
┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃ Device    ┃ Test Name         ┃ Test Status ┃ Message(s)                                                        ┃ Test description                                                 ┃ Test category ┃
┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ s1-spine1 │ VerifyBGPEcmpPath │ failure     │ Following BGP routes are not configured, not contributed in ecmp, │ Verifies the installation of BGP Equal-Cost Multipath (ECMP)     │ routing, bgp  │
│           │                   │             │ or ecmp head is not found:                                        │ path in the specified VRF.                                       │               │
│           │                   │             │ {'192.0.255.5/32': {'default': 'ECMP path is not installed'}}     │                                                                  │               │
└───────────┴───────────────────┴─────────────┴───────────────────────────────────────────────────────────────────┴──────────────────────────────────────────────────────────────────┴───────────────┘

Fixes #505

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my code
I have run pre-commit for code linting and typing (pre-commit run)
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes (tox -e testenv)

carl-baillargeon · 2024-01-06T00:35:40Z

anta/tests/routing/bgp.py

@@ -447,3 +447,62 @@ def test(self) -> None:

        if failures:
            self.result.is_failure(f"Failures: {list(failures.values())}")
+
+
+class VerifyBGPEcmpPath(AntaTest):


Let's call the test VerifyBGPIPv4Prefixes

carl-baillargeon · 2024-01-06T00:45:01Z

anta/tests/routing/bgp.py

+    name = "VerifyBGPEcmpPath"
+    description = "Verifies the installation of BGP Equal-Cost Multipath (ECMP) path in the specified VRF."
+    categories = ["routing", "bgp"]
+    commands = [AntaCommand(command="show ip bgp")]


Since the BGP table can get pretty large, let's filter down per prefix and use AntaTemplate.

1- show bgp ipv4 unicast {prefix] vrf {vrf}
2- show ip route vrf {vrf} {prefix}

We can first check the BGP table for the prefix, save the ECMP paths and check the RIB if they are present.

This test would only work with IPv4 unicast so we need to specify it in the docstring.

carl-baillargeon · 2024-01-06T00:47:53Z

anta/tests/routing/bgp.py

+        Input parameters for the test.
+        """
+
+        bgp_routes: List[BgpPeers]


prefixes: List[BgpPrefixes]

carl-baillargeon · 2024-01-06T00:48:28Z

anta/tests/routing/bgp.py

+            This class defines the details of a BGP route.
+            """
+
+            route: str


prefix: IPv4Network

carl-baillargeon · 2024-01-06T00:50:55Z

anta/tests/routing/bgp.py

+            vrf = bgp_route.vrf
+
+            # Verify if BGP route exist
+            if not (bgp_output := get_value(self.instance_commands[0].json_output, f"vrfs..{vrf}..bgpRouteEntries..{route}", separator="..")):


Is separator=".." required here?

yes due to . in prefix

carl-baillargeon · 2024-01-06T01:17:23Z

anta/tests/routing/bgp.py

+            # Verify BGP route's ecmp head and contribution
+            bgp_paths = bgp_output.get("bgpRoutePaths", [])
+            failures[route] = {vrf: "ECMP path is not installed"}
+            for path in bgp_paths:
+                if path.get("routeType", {}).get("ecmpHead") and path.get("routeType", {}).get("ecmpContributor"):
+                    failures.pop(route)
+                    break


In BGP, only 1 path can be valid, active and ECMP head so I would loop over bgpRoutePaths and check the valid, active, ecmpHead, ecmp, ecmpContributor keys. If they are all true, that means we have ECMP so we should check the other paths. The other paths should be valid, ecmp and ecmpContributor but NOT active and ecmpHead.

We can then save the nextHop into a list or a set and confirm that the RIB has all paths installed for the input prefixes.

As per discussion add ecmp_count as user input to validate both command outputs should have an equal number of routes as ecmp_count

MaheshGSLAB · 2024-01-24T13:10:54Z

anta/tests/routing/bgp.py

+                # Check for mismatch
+                if paths_info["ip_paths"] != paths_info["bgp_paths"]:
+                    # Create nested dictionary structure for failures
+                    failures.setdefault(prefix, {}).setdefault(vrf, {})["mismatched_paths"] = paths_info


need to make the changes for updating setdefault with deep_update method

github-actions · 2024-01-24T14:04:43Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

carl-baillargeon

Please hold on this one. The logic is pretty complex, we might have to split it in 2 test cases.

carl-baillargeon · 2024-01-29T19:11:57Z

anta/tests/routing/bgp.py

+            """IPv4 BGP prefix"""
+            vrf: str = "default"
+            """Optional VRF for BGP peer. If not provided, it defaults to `default`."""
+            ecmp_count: int


Suggested change

ecmp_count: int

ecmp_count: int = Field(ge=1, le=128)

carl-baillargeon · 2024-01-29T19:22:36Z

anta/tests/routing/bgp.py

+
+            # If paths do not exist, mark as not configured
+            if not paths:
+                failures.setdefault(prefix, {}).setdefault(vrf, {}).setdefault("unicast" if is_unicast else "rib", "Not configured")


Is there a cleaner way of doing this?

carl-baillargeon · 2024-01-29T19:23:49Z

anta/tests/routing/bgp.py

+            ecmp_count = command.params["ecmp_count"]
+
+            # Determine if the command is for unicast
+            is_unicast = "unicast" in command.command


Matching on is_unicast can be misleading since we can have other SAFI like multicast

MaheshGSLAB self-assigned this Jan 2, 2024

MaheshGSLAB marked this pull request as ready for review January 2, 2024 09:07

MaheshGSLAB requested a review from carl-baillargeon January 2, 2024 14:19

MaheshGSLAB added the rn: feat(anta.tests)! label Jan 4, 2024

MaheshGSLAB changed the title ~~feat: Adding the test case to verify BGP ECMP path install~~ feat(anta.tests)!: Adding the test case to verify BGP ECMP path install Jan 4, 2024

gmuloc removed the rn: feat(anta.tests)! label Jan 5, 2024

gmuloc changed the title ~~feat(anta.tests)!: Adding the test case to verify BGP ECMP path install~~ feat(anta.tests): Adding the test case to verify BGP ECMP path install Jan 5, 2024

carl-baillargeon requested changes Jan 6, 2024

View reviewed changes

MaheshGSLAB added 3 commits January 12, 2024 10:26

issue-505: Added testcase for BGP ECMP path install

32d7ea1

issue-505: updated the doc string

648f412

issue-505: Updated the testcase for check RIB

dcd5b0d

MaheshGSLAB requested review from carl-baillargeon and gmuloc January 12, 2024 11:14

MaheshGSLAB force-pushed the issue-505 branch from 95d7613 to dcd5b0d Compare January 12, 2024 11:34

MaheshGSLAB commented Jan 24, 2024

View reviewed changes

github-actions bot added the state: conflict label Jan 24, 2024

carl-baillargeon requested changes Jan 29, 2024

View reviewed changes

MaheshGSLAB changed the title ~~feat(anta.tests): Adding the test case to verify BGP ECMP path install~~ feat(anta.tests): Adding the test case to verify BGP ECMP path install(On Hold) Feb 1, 2024

MaheshGSLAB marked this pull request as draft February 23, 2024 11:29

gmuloc added the network-tests label Apr 22, 2024

carl-baillargeon added this to the v1.1.0 milestone Apr 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(anta.tests): Adding the test case to verify BGP ECMP path install(On Hold) #507

feat(anta.tests): Adding the test case to verify BGP ECMP path install(On Hold) #507

MaheshGSLAB commented Jan 2, 2024 •

edited

Loading

carl-baillargeon Jan 6, 2024 •

edited

Loading

carl-baillargeon Jan 6, 2024 •

edited

Loading

carl-baillargeon Jan 6, 2024

carl-baillargeon Jan 6, 2024

carl-baillargeon Jan 6, 2024

MaheshGSLAB Jan 11, 2024

carl-baillargeon Jan 6, 2024

MaheshGSLAB Jan 10, 2024

MaheshGSLAB Jan 24, 2024

github-actions bot commented Jan 24, 2024

carl-baillargeon left a comment

carl-baillargeon Jan 29, 2024

carl-baillargeon Jan 29, 2024

carl-baillargeon Jan 29, 2024

feat(anta.tests): Adding the test case to verify BGP ECMP path install(On Hold) #507

Are you sure you want to change the base?

feat(anta.tests): Adding the test case to verify BGP ECMP path install(On Hold) #507

Conversation

MaheshGSLAB commented Jan 2, 2024 • edited Loading

Description

Checklist:

carl-baillargeon Jan 6, 2024 • edited Loading

Choose a reason for hiding this comment

carl-baillargeon Jan 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 24, 2024

carl-baillargeon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MaheshGSLAB commented Jan 2, 2024 •

edited

Loading

carl-baillargeon Jan 6, 2024 •

edited

Loading

carl-baillargeon Jan 6, 2024 •

edited

Loading