feat(anta): Added testcases to verifying Route Type #925

geetanjalimanegslab · 2024-11-14T06:21:13Z

Description

This test performs the following checks for each specific ipv4 route:
        1. Verify that the specified VRF is configured.
        2. Verifies that the specified ipv4 route exists in the configuration.
        3. Verify that the provided ipv4 route is of the expected type.

    Expected Results
    ----------------
    * Success:  If all of the following conditions are met:
        - All the specified VRFs are configured.
        - All the specified ipv4 routes are found.
        - All the specified ipv4 routes are of the expected type.
    * Failure:  If any of the following occur:
        - A specified VRF is not configured.
        - A specified ipv4 routes are found.
        - Any specified ipv4 route is not of the expected type.

Fixes #884

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)

for more information, see https://pre-commit.ci

vitthalmagadum · 2024-11-14T07:05:02Z

examples/tests.yaml

+          - vrf: default
+            prefix: 10.10.0.1/32
+            route_type: eBGP


prefix: 10.10.0.1/32
vrf: default
route_type: eBGP

Update all places

for more information, see https://pre-commit.ci

gmuloc · 2024-11-15T08:58:48Z

anta/custom_types.py

@@ -208,3 +208,34 @@ def validate_regex(value: str) -> str:
 SnmpErrorCounter = Literal[
    "inVersionErrs", "inBadCommunityNames", "inBadCommunityUses", "inParseErrs", "outTooBigErrs", "outNoSuchNameErrs", "outBadValueErrs", "outGeneralErrs"
 ]
+# TODO: Needs to update the route types with confirmation.


Just for my information, how did you come up with this list of route-types?
This is good to help for the input but it may be tricky to maintain (though I suppose it is life)

Hi, @gmuloc ,
The mentioned route types are collected from the following command output.

eaf2-dc1#show ip route vrf all VRF: default Codes: C - connected, S - static, K - kernel, O - OSPF, IA - OSPF inter area, E1 - OSPF external type 1, E2 - OSPF external type 2, N1 - OSPF NSSA external type 1, N2 - OSPF NSSA external type2, B - Other BGP Routes, B I - iBGP, B E - eBGP, R - RIP, I L1 - IS-IS level 1, I L2 - IS-IS level 2, O3 - OSPFv3, A B - BGP Aggregate, A O - OSPF Summary, NG - Nexthop Group Static Route, V - VXLAN Control Service, M - Martian, DH - DHCP client installed default route, DP - Dynamic Policy Route, L - VRF Leaked, G - gRIBI, RC - Route Cache Route, CL - CBF Leaked Route Gateway of last resort is not set B E 10.10.0.1/32 [200/0] via 10.100.0.12, Ethernet1 via 10.100.0.14, Ethernet2 C 10.100.0.12/31 is directly connected, Ethernet1 C 10.100.0.14/31 is directly connected, Ethernet2

Vitthal shared a JSON output with me, so with that help, I verified a few route types, such as connected, iBGP, and eBGP, to validate that the other route type needs some more configuration. Hence, I added TODO over there.

gmuloc · 2024-11-15T08:59:46Z

anta/tests/routing/generic.py

+    commands: ClassVar[list[AntaCommand | AntaTemplate]] = [
+        AntaCommand(command="show ip route vrf all", revision=4),
+    ]


I would expect this can be one line with out ruff config - maybe you need to check your IDE for the settings (you need to remove the , after revision=4) to let ruff do its magic

gmuloc · 2024-11-15T09:01:49Z

anta/tests/routing/generic.py

+        class Routes(BaseModel):
+            """Model for a list of route entries."""
+
+            vrf: str = "default"
+            """ VRF context. Defaults to `default` VRF."""
+            prefix: IPv4Network
+            """ IPV4network to validate the rout type. """
+            route_type: RouteType
+            """ List of Route type to validate the valid rout type. """


so there is an effort now to move the nested base models to input_models - if you can move this to the relevant files that would be great (otherwise you have done exactly what we used to do so that was perfect)

gmuloc · 2024-11-22T08:37:11Z

anta/custom_types.py

@@ -208,3 +208,34 @@ def validate_regex(value: str) -> str:
 SnmpErrorCounter = Literal[
    "inVersionErrs", "inBadCommunityNames", "inBadCommunityUses", "inParseErrs", "outTooBigErrs", "outNoSuchNameErrs", "outBadValueErrs", "outGeneralErrs"
 ]
+# TODO: Needs to update the route types with confirmation.
+
+RouteType = Literal[


Suggested change

RouteType = Literal[

IPv4RouteType = Literal[

gmuloc · 2024-11-22T08:37:54Z

anta/input_models/routing/generic.py

+from anta.custom_types import RouteType
+
+
+class Routes(BaseModel):


Suggested change

class Routes(BaseModel):

class IPv4Routes(BaseModel):

gmuloc · 2024-11-22T08:38:23Z

anta/tests/routing/generic.py

@@ -181,3 +183,77 @@ def test(self) -> None:
            self.result.is_success()
        else:
            self.result.is_failure(f"The following route(s) are missing from the routing table of VRF {self.inputs.vrf}: {missing_routes}")
+
+
+class VerifyRouteType(AntaTest):


Suggested change

class VerifyRouteType(AntaTest):

class VerifyIPv4RouteType(AntaTest):

gmuloc · 2024-11-22T08:38:48Z

anta/tests/routing/generic.py

+
+        routes_entries: list[Routes]
+        """List of route entries"""
+        Routes: ClassVar[type[Routes]] = Routes


Suggested change

Routes: ClassVar[type[Routes]] = Routes

gmuloc · 2024-11-22T08:41:07Z

anta/tests/routing/generic.py

+        """Main test function for VerifyRouteType."""
+        self.result.is_success()
+
+        # Collecting the 'show ip route vrf all' command output.


Suggested change

# Collecting the 'show ip route vrf all' command output.

gmuloc · 2024-11-22T08:53:23Z

anta/tests/routing/generic.py

+        output = self.instance_commands[0].json_output
+
+        # Iterating over the all routes entries mentioned in the inputs.
+        for entries in self.inputs.routes_entries:


Suggested change

for entries in self.inputs.routes_entries:

for entry in self.inputs.routes_entries:

gmuloc · 2024-11-22T08:55:57Z

anta/tests/routing/generic.py

+                continue
+
+            # Verifying that the expected route is present or not on the device
+            if (route_data := get_value(routes_details, prefix, separator="..")) is None:


Suggested change

if (route_data := get_value(routes_details, prefix, separator="..")) is None:

if (route_data := routes_details.get(prefix)) is None:

gmuloc · 2024-11-22T08:59:35Z

anta/tests/routing/generic.py

+
+            # Verifying that the expected route-type and the actual routes are the same.
+            if expected_route_type != actual_route_type:
+                self.result.is_failure(f"{entries}- Incorrect route type; Expected: {expected_route_type} Actual: {actual_route_type}")


Suggested change

self.result.is_failure(f"{entries}- Incorrect route type; Expected: {expected_route_type} Actual: {actual_route_type}")

self.result.is_failure(f"{entries} - Incorrect route type, Expected: {expected_route_type} Actual: {actual_route_type}")

gmuloc · 2024-11-22T09:00:11Z

anta/tests/routing/generic.py

+            actual_route_type = route_data.get("routeType")
+
+            # Verifying that the expected route-type and the actual routes are the same.
+            if expected_route_type != actual_route_type:


Suggested change

actual_route_type = route_data.get("routeType")

# Verifying that the expected route-type and the actual routes are the same.

if expected_route_type != actual_route_type:

# Verifying that the expected route-type and the actual routes are the same.

if expected_route_type != ( actual_route_type := route_data.get("routeType")):

gmuloc · 2024-11-22T09:06:13Z

tests/units/anta_tests/routing/test_generic.py

+                {"vrf": "default", "prefix": "10.100.0.12/31", "route_type": "connected"},
+                {"vrf": "default", "prefix": "10.100.0.14/31", "route_type": "connected"},
+                {"vrf": "default", "prefix": "10.100.0.128/31", "route_type": "eBGP"},
+                {"vrf": "default", "prefix": "10.100.1.5/32", "route_type": "iBGP"},


Suggested change

{"vrf": "default", "prefix": "10.100.0.12/31", "route_type": "connected"},

{"vrf": "default", "prefix": "10.100.0.14/31", "route_type": "connected"},

{"vrf": "default", "prefix": "10.100.0.128/31", "route_type": "eBGP"},

{"vrf": "default", "prefix": "10.100.1.5/32", "route_type": "iBGP"},

gmuloc · 2024-11-22T09:13:19Z

tests/units/anta_tests/routing/test_generic.py

+        "inputs": {
+            "routes_entries": [
+                {"vrf": "default", "prefix": "1022.10.0.1/32", "route_type": "eBGP"},
+                {"vrf": "default", "prefix": "2001:db8:3333:4444:5555:6666:7777:8888:", "route_type": "connected"},
+                {"vrf": "default", "prefix": "10.100.0.14/31", "route_type": "connected"},
+                {"vrf": "default", "prefix": "10.100.0.128/31", "route_type": "eBGP"},
+                {"vrf": "default", "prefix": "10.100.1.5/32", "route_type": "iBGP"},
+            ]
+        },
+        "expected": {"result": "error", "messages": ["Input is not a valid IPv4 network"]},


remvoe this test, we don't test pydantic verification in tests

…ses as verifyipv4routetype

codspeed-hq · 2024-11-24T03:45:59Z

CodSpeed Performance Report

Merging #925 will not alter performance

_{Comparing geetanjalimanegslab:issue_884 (b37059f) with main (2de0f5a)}

Summary

✅ 8 untouched benchmarks

for more information, see https://pre-commit.ci

docs/api/tests.routing.generic.md

sonarcloud · 2024-11-26T14:32:45Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Issue_884: Added testcases for verifying Route Type

33aabce

github-actions bot assigned geetanjalimanegslab Nov 14, 2024

[pre-commit.ci] auto fixes from pre-commit.com hooks

c5f0eeb

for more information, see https://pre-commit.ci

geetanjalimanegslab changed the title ~~Issue_884: Added testcases for verifying Route Type~~ feat(anta): Added testcases for verifying Route Type Nov 14, 2024

geetanjalimanegslab changed the title ~~feat(anta): Added testcases for verifying Route Type~~ feat(anta): Added testcases to verifying Route Type Nov 14, 2024

vitthalmagadum reviewed Nov 14, 2024

View reviewed changes

geetanjalimanegslab and others added 5 commits November 14, 2024 14:25

Issue_884: Fixed linting issues observed in pre-commit run

53bdf21

[pre-commit.ci] auto fixes from pre-commit.com hooks

841ffc5

for more information, see https://pre-commit.ci

Merge branch 'main' into issue_884

ca30b7c

Issue_884: fixed linting issues.

beddaa3

Merge branch 'main' into issue_884

640e2d0

gmuloc reviewed Nov 19, 2024

View reviewed changes

geetanjalimanegslab added 2 commits November 21, 2024 17:24

Issue_884: fixed trailling white spaces

0cc3709

Issue_884: Updated failure messages for testcases

a8fa24e

gmuloc reviewed Nov 22, 2024

View reviewed changes

Issue_884: Updated testcase with code optimization and renamed testca…

773dc39

…ses as verifyipv4routetype

geetanjalimanegslab and others added 3 commits November 25, 2024 15:15

Issue_884: Updated documentation file

cede693

[pre-commit.ci] auto fixes from pre-commit.com hooks

d3d3267

for more information, see https://pre-commit.ci

Merge branch 'main' into issue_884

b37059f

gmuloc reviewed Nov 26, 2024

View reviewed changes

docs/api/tests.routing.generic.md Outdated Show resolved Hide resolved

Update docs/api/tests.routing.generic.md

52d6c1a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(anta): Added testcases to verifying Route Type #925

feat(anta): Added testcases to verifying Route Type #925

geetanjalimanegslab commented Nov 14, 2024 •

edited

Loading

vitthalmagadum Nov 14, 2024

vitthalmagadum Nov 14, 2024

gmuloc Nov 15, 2024

geetanjalimanegslab Nov 21, 2024

gmuloc Nov 15, 2024

gmuloc Nov 15, 2024

gmuloc Nov 22, 2024

gmuloc Nov 22, 2024

gmuloc Nov 22, 2024

gmuloc Nov 22, 2024

gmuloc Nov 22, 2024

gmuloc Nov 22, 2024

gmuloc Nov 22, 2024

gmuloc Nov 22, 2024

gmuloc Nov 22, 2024

gmuloc Nov 22, 2024

gmuloc Nov 22, 2024

codspeed-hq bot commented Nov 24, 2024 •

edited

Loading

sonarcloud bot commented Nov 26, 2024

		from anta.custom_types import RouteType


		class Routes(BaseModel):

	class VerifyRouteType(AntaTest):
	class VerifyIPv4RouteType(AntaTest):

	for entries in self.inputs.routes_entries:
	for entry in self.inputs.routes_entries:

	if (route_data := get_value(routes_details, prefix, separator="..")) is None:
	if (route_data := routes_details.get(prefix)) is None:

	self.result.is_failure(f"{entries}- Incorrect route type; Expected: {expected_route_type} Actual: {actual_route_type}")
	self.result.is_failure(f"{entries} - Incorrect route type, Expected: {expected_route_type} Actual: {actual_route_type}")

feat(anta): Added testcases to verifying Route Type #925

Are you sure you want to change the base?

feat(anta): Added testcases to verifying Route Type #925

Conversation

geetanjalimanegslab commented Nov 14, 2024 • edited Loading

Description

Checklist:

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

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

Choose a reason for hiding this comment

codspeed-hq bot commented Nov 24, 2024 • edited Loading

Merging #925 will not alter performance

Summary

sonarcloud bot commented Nov 26, 2024

Quality Gate passed

geetanjalimanegslab commented Nov 14, 2024 •

edited

Loading

codspeed-hq bot commented Nov 24, 2024 •

edited

Loading