Skip to content

Commit

Permalink
Added queues knob
Browse files Browse the repository at this point in the history
  • Loading branch information
@carl-baillargeon
carl-baillargeon committed Oct 24, 2024
1 parent 139e545 commit c26fb82
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 16 deletions.
37 changes: 22 additions & 15 deletions anta/tests/routing/bgp.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ def test(self) -> None:

# Check if the VRF is configured
if (vrf_output := get_value(output, f"vrfs.{address_family.vrf}")) is None:
self.result.is_failure(f"{address_family} VRF not configured")
self.result.is_failure(f"{address_family} - VRF not configured")
continue

# Count the number of established peers with negotiated AFI/SAFI
Expand All @@ -169,7 +169,7 @@ def test(self) -> None:

# Check if the count matches the expected count
if address_family.num_peers != peer_count:
self.result.is_failure(f"{address_family} Expected: {address_family.num_peers}, Actual: {peer_count}")
self.result.is_failure(f"{address_family} - Expected: {address_family.num_peers}, Actual: {peer_count}")


class VerifyBGPPeersHealth(AntaTest):
Expand All @@ -183,6 +183,7 @@ class VerifyBGPPeersHealth(AntaTest):
- Verifies that the BGP session is in the `Established` state.
- Confirms that the AFI/SAFI state is `negotiated`.
- Checks that both input and output TCP message queues are empty.
Can be disabled by setting `check_tcp_queues` to `False`.
Expected Results
----------------
Expand All @@ -192,7 +193,7 @@ class VerifyBGPPeersHealth(AntaTest):
- No peers are found for a given AFI/SAFI.
- Any BGP session is not in the `Established` state.
- The AFI/SAFI state is not 'negotiated' for any peer.
- Any TCP message queue (input or output) is not empty.
- Any TCP message queue (input or output) is not empty when `check_tcp_queues` is `True` (default).
Examples
--------
Expand All @@ -208,6 +209,7 @@ class VerifyBGPPeersHealth(AntaTest):
- afi: "ipv6"
safi: "unicast"
vrf: "DEV"
check_tcp_queues: false
```
"""

Expand All @@ -233,7 +235,7 @@ def test(self) -> None:
for address_family in self.inputs.address_families:
# Check if the VRF is configured
if (vrf_output := get_value(output, f"vrfs.{address_family.vrf}")) is None:
self.result.is_failure(f"{address_family} VRF not configured")
self.result.is_failure(f"{address_family} - VRF not configured")
continue

# Check if any peers are found for this AFI/SAFI
Expand All @@ -242,22 +244,24 @@ def test(self) -> None:
]

if not relevant_peers:
self.result.is_failure(f"{address_family} No peers found")
self.result.is_failure(f"{address_family} - No peers found")
continue

for peer in relevant_peers:
# Check if the BGP session is established
if peer["state"] != "Established":
self.result.is_failure(f"{address_family} Peer:{peer['peerAddress']} session state is not established; State:{peer['state']}")
self.result.is_failure(f"{address_family} - Peer:{peer['peerAddress']} session state is not established; State:{peer['state']}")

# Check if the AFI/SAFI state is negotiated
capability_status = get_value(peer, f"neighborCapabilities.multiprotocolCaps.{address_family.eos_key}")
if not check_bgp_neighbor_capability(capability_status):
self.result.is_failure(f"{address_family} Peer:{peer['peerAddress']} AFI/SAFI state is not negotiated; {format_data(capability_status)}")
self.result.is_failure(f"{address_family} - Peer:{peer['peerAddress']} AFI/SAFI state is not negotiated; {format_data(capability_status)}")

# Check the TCP session message queues
if (inq := peer["peerTcpInfo"]["inputQueueLength"]) != 0 or (outq := peer["peerTcpInfo"]["outputQueueLength"]) != 0:
self.result.is_failure(f"{address_family} Peer:{peer['peerAddress']} session has non-empty message queues; InQ: {inq}, OutQ: {outq}")
if address_family.check_tcp_queues and (
(inq := peer["peerTcpInfo"]["inputQueueLength"]) != 0 or (outq := peer["peerTcpInfo"]["outputQueueLength"]) != 0
):
self.result.is_failure(f"{address_family} - Peer:{peer['peerAddress']} session has non-empty message queues; InQ: {inq}, OutQ: {outq}")


class VerifyBGPSpecificPeers(AntaTest):
Expand All @@ -271,6 +275,7 @@ class VerifyBGPSpecificPeers(AntaTest):
- Checks that the BGP session is in the `Established` state.
- Confirms that the AFI/SAFI state is `negotiated`.
- Ensures that both input and output TCP message queues are empty.
Can be disabled by setting `check_tcp_queues` to `False`.
Expected Results
----------------
Expand All @@ -280,7 +285,7 @@ class VerifyBGPSpecificPeers(AntaTest):
- A specified peer is not found in the BGP configuration.
- The BGP session for a peer is not in the `Established` state.
- The AFI/SAFI state is not `negotiated` for a peer.
- Any TCP message queue (input or output) is not empty for a peer.
- Any TCP message queue (input or output) is not empty for a peer when `check_tcp_queues` is `True` (default).
Examples
--------
Expand Down Expand Up @@ -335,29 +340,31 @@ def test(self) -> None:
for address_family in self.inputs.address_families:
# Check if the VRF is configured
if (vrf_output := get_value(output, f"vrfs.{address_family.vrf}")) is None:
self.result.is_failure(f"{address_family} VRF not configured")
self.result.is_failure(f"{address_family} - VRF not configured")
continue

for peer in address_family.peers:
peer_ip = str(peer)

# Check if the peer is found
if (peer_data := get_item(vrf_output["peerList"], "peerAddress", peer_ip)) is None:
self.result.is_failure(f"{address_family} Peer:{peer_ip} not found")
self.result.is_failure(f"{address_family} - Peer:{peer_ip} not found")
continue

# Check if the BGP session is established
if peer_data["state"] != "Established":
self.result.is_failure(f"{address_family} Peer:{peer_ip} session state is not established; State:{peer_data['state']}")
self.result.is_failure(f"{address_family} - Peer:{peer_ip} session state is not established; State:{peer_data['state']}")

# Check if the AFI/SAFI state is negotiated
capability_status = get_value(peer_data, f"neighborCapabilities.multiprotocolCaps.{address_family.eos_key}")
if not check_bgp_neighbor_capability(capability_status):
self.result.is_failure(f"{address_family} Peer:{peer_ip} AFI/SAFI state is not negotiated; {format_data(capability_status)}")

# Check the TCP session message queues
if (inq := peer_data["peerTcpInfo"]["inputQueueLength"]) != 0 or (outq := peer_data["peerTcpInfo"]["outputQueueLength"]) != 0:
self.result.is_failure(f"{address_family} Peer:{peer_ip} session has non-empty message queues; InQ: {inq}, OutQ: {outq}")
if address_family.check_tcp_queues and (
(inq := peer_data["peerTcpInfo"]["inputQueueLength"]) != 0 or (outq := peer_data["peerTcpInfo"]["outputQueueLength"]) != 0
):
self.result.is_failure(f"{address_family} - Peer:{peer_ip} session has non-empty message queues; InQ: {inq}, OutQ: {outq}")


class VerifyBGPExchangedRoutes(AntaTest):
Expand Down
6 changes: 5 additions & 1 deletion anta/tests/routing/bgp_input_models.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ class BgpAddressFamily(BaseModel):
"""Number of expected established BGP peers with negotiated AFI/SAFI. Required field in the `VerifyBGPPeerCount` test."""
peers: list[IPv4Address | IPv6Address] | None = None
"""List of expected IPv4/IPv6 BGP peers supporting the AFI/SAFI. Required field in the `VerifyBGPSpecificPeers` test."""
check_tcp_queues: bool = True
"""Flag to check if the TCP session queues are empty for a BGP peer. Defaults to `True`.
Can be disabled in the `VerifyBGPPeersHealth` and `VerifyBGPSpecificPeers` tests.
"""

@model_validator(mode="after")
def validate_inputs(self) -> Self:
Expand Down Expand Up @@ -92,7 +97,6 @@ def __str__(self) -> str:
base_string += f" SAFI:{self.safi}"
if self.afi in ["ipv4", "ipv6"]:
base_string += f" VRF:{self.vrf}"
base_string += " -"
return base_string


Expand Down

0 comments on commit c26fb82

Please sign in to comment.