Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework eos.get_bgp_neighbor #2116

Merged
merged 7 commits into from
Jul 26, 2024
Merged

Rework eos.get_bgp_neighbor #2116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4517225
correct typo in typing object
bewing Jul 15, 2024
e31e5e3
rework napalm.eos.EOSDriver to use JSON
bewing Jul 15, 2024
5bb8d0e
ignore typing on TypedDict defaultdict
bewing Jul 16, 2024
b7a2c13
add no peers test for eos.get_bgp_neighbors
bewing Jul 16, 2024
c649a94
add no bgp test for eos.get_bgp_neighbors
bewing Jul 16, 2024
f3b2077
generate new test case for issue #1759
bewing Jul 16, 2024
981c5ca
check for correct uptime in eos bgp neighbors
bewing Jul 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions napalm/base/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,8 @@
},
)

BGPStateAdressFamilyDict = TypedDict(
"BGPStateAdressFamilyDict",
BGPStateAddressFamilyDict = TypedDict(
"BGPStateAddressFamilyDict",
{"received_prefixes": int, "accepted_prefixes": int, "sent_prefixes": int},
)

Expand All @@ -203,7 +203,7 @@
"is_enabled": bool,
"description": str,
"uptime": int,
"address_family": Dict[str, BGPStateAdressFamilyDict],
"address_family": Dict[str, BGPStateAddressFamilyDict],
},
)

Expand Down
191 changes: 68 additions & 123 deletions napalm/eos/eos.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,12 @@
import pyeapi
from pyeapi.eapilib import ConnectionError, EapiConnection
from netmiko import ConfigInvalidException
from typing import Dict

# NAPALM base
import napalm.base.helpers
from napalm.base.netmiko_helpers import netmiko_args
from napalm.base.base import NetworkDriver
from napalm.base.base import NetworkDriver, models
from napalm.base.utils import string_parsers
from napalm.base.exceptions import (
CommitError,
Expand Down Expand Up @@ -672,140 +673,84 @@ def get_interfaces_counters(self):
)
return interface_counters

def get_bgp_neighbors(self):
def get_re_group(res, key, default=None):
"""Small helper to retrieve data from re match groups"""
try:
return res.group(key)
except KeyError:
return default

NEIGHBOR_FILTER = "vrf all | include IPv[46] (Unicast|6PE):.*[0-9]+ | grep -v ' IPv[46] Unicast:/.' | remote AS |^Local AS|Desc|BGP state |remote router ID" # noqa
output_summary_cmds = self._run_commands(
["show ipv6 bgp summary vrf all", "show ip bgp summary vrf all"],
encoding="json",
)
output_neighbor_cmds = self._run_commands(
def get_bgp_neighbors(self) -> Dict[str, models.BGPStateNeighborsPerVRFDict]:
cmd_outputs = self._run_commands(
[
"show ip bgp neighbors " + NEIGHBOR_FILTER,
"show ipv6 bgp peers " + NEIGHBOR_FILTER,
"show ip bgp summary vrf all",
"show ipv6 bgp summary vrf all",
"show ip bgp neighbors vrf all",
"show ipv6 bgp peers vrf all",
],
encoding="text",
encoding="json",
)

bgp_counters = defaultdict(lambda: dict(peers={}))
for summary in output_summary_cmds:
"""
Json output looks as follows
"vrfs": {
"default": {
"routerId": 1,
"asn": 1,
"peers": {
"1.1.1.1": {
"msgSent": 1,
"inMsgQueue": 0,
"prefixReceived": 3926,
"upDownTime": 1449501378.418644,
"version": 4,
"msgReceived": 59616,
"prefixAccepted": 3926,
"peerState": "Established",
"outMsgQueue": 0,
"underMaintenance": false,
"asn": 1
}
}
}
}
"""
for vrf, vrf_data in summary["vrfs"].items():
bgp_counters[vrf]["router_id"] = vrf_data["routerId"]
for peer, peer_data in vrf_data["peers"].items():
if peer_data["peerState"] == "Idle":
bgp_counters = defaultdict(
lambda: models.BGPStateNeighborsPerVRFDict(
peers=models.BGPStateNeighborDict() # type: ignore
) # type: ignore
) # type: ignore
# Iterate IPv4 and IPv6 neighbor details
for cmd in cmd_outputs[2:]:
bewing marked this conversation as resolved.
Show resolved Hide resolved
for vrf_name, vrf_data in cmd["vrfs"].items():
vrf = bgp_counters[vrf_name]
for peer in vrf_data["peerList"]:
peer_ip = napalm.base.helpers.ip(peer["peerAddress"])
v4_summary = cmd_outputs[0]["vrfs"][vrf_name]["peers"].get(
peer_ip, {}
)
v6_summary = cmd_outputs[1]["vrfs"][vrf_name]["peers"].get(
peer_ip, {}
)
local_as = napalm.base.helpers.as_number(peer["localAsn"])
remote_as = napalm.base.helpers.as_number(peer["asn"])
remote_id = napalm.base.helpers.ip(peer["routerId"])
if peer["state"] == "Idle":
is_enabled = (
True
if peer_data["peerStateIdleReason"] != "Admin"
if peer["idleReason"] != "Administratively shut down"
else False
)
else:
is_enabled = True
peer_info = {
"is_up": peer_data["peerState"] == "Established",
"is_enabled": is_enabled,
"uptime": int(time.time() - float(peer_data["upDownTime"])),
"description": peer_data.get("description", ""),
}
bgp_counters[vrf]["peers"][napalm.base.helpers.ip(peer)] = peer_info
lines = []
[lines.extend(x["output"].splitlines()) for x in output_neighbor_cmds]
while lines:
"""
Raw output from the command looks like the following:

BGP neighbor is 1.1.1.1, remote AS 1, external link
Description: Very info such descriptive
BGP version 4, remote router ID 1.1.1.1, VRF my_vrf
BGP state is Idle, Administratively shut down
IPv4 Unicast: 683 78
IPv6 Unicast: 0 0
Local AS is 2, local router ID 2.2.2.2
"""
neighbor_info = re.match(self._RE_BGP_INFO, lines.pop(0))
# this line can be either description or rid info
next_line = lines.pop(0)
desc = re.match(self._RE_BGP_DESC, next_line)
if desc is None:
rid_info = re.match(self._RE_BGP_RID_INFO, next_line)
desc = ""
else:
rid_info = re.match(self._RE_BGP_RID_INFO, lines.pop(0))
desc = desc.group("description")
lines.pop(0)
v4_stats = re.match(self._RE_BGP_PREFIX, lines.pop(0))
v6_stats = re.match(self._RE_BGP_PREFIX, lines.pop(0))
local_as = re.match(self._RE_BGP_LOCAL, lines.pop(0))
data = {
"remote_as": napalm.base.helpers.as_number(neighbor_info.group("as")),
"remote_id": napalm.base.helpers.ip(
get_re_group(rid_info, "rid", "0.0.0.0")
),
"local_as": napalm.base.helpers.as_number(local_as.group("as")),
"description": str(desc),
"address_family": {
"ipv4": {
"sent_prefixes": int(get_re_group(v4_stats, "sent", -1)),
"received_prefixes": int(
get_re_group(v4_stats, "received", -1)
is_up = peer["state"] == "Established"
description = peer.get("description", "")
uptime = int(peer.get("establishedTime", -1))
ktbyers marked this conversation as resolved.
Show resolved Hide resolved
v4: models.BGPStateAddressFamilyDict = {
"received_prefixes": peer["prefixesReceived"],
"accepted_prefixes": (
v4_summary["prefixAccepted"] if v4_summary else 0
),
"accepted_prefixes": -1,
},
"ipv6": {
"sent_prefixes": int(get_re_group(v6_stats, "sent", -1)),
"received_prefixes": int(
get_re_group(v6_stats, "received", -1)
"sent_prefixes": peer["prefixesSent"],
}
v6: models.BGPStateAddressFamilyDict = {
"received_prefixes": peer["v6PrefixesReceived"],
"accepted_prefixes": (
v6_summary["prefixAccepted"] if v6_summary else 0
),
"accepted_prefixes": -1,
},
},
}
peer_addr = napalm.base.helpers.ip(neighbor_info.group("neighbor"))
vrf = rid_info.group("vrf")
if peer_addr not in bgp_counters[vrf]["peers"]:
bgp_counters[vrf]["peers"][peer_addr] = {
"is_up": False, # if not found, means it was not found in the oper stats
# i.e. neighbor down,
"uptime": 0,
"is_enabled": True,
}
if (
"description" in bgp_counters[vrf]["peers"][peer_addr]
and not data["description"]
):
data["description"] = bgp_counters[vrf]["peers"][peer_addr][
"description"
]
bgp_counters[vrf]["peers"][peer_addr].update(data)
"sent_prefixes": peer["v6PrefixesSent"],
}
peer_data: models.BGPStateNeighborDict = {
"local_as": local_as,
"remote_as": remote_as,
"remote_id": remote_id,
"is_up": is_up,
"is_enabled": is_enabled,
"description": description,
"uptime": uptime,
"address_family": {
"ipv4": v4,
"ipv6": v6,
},
}
vrf["peers"][peer_ip] = peer_data

# Iterate IPv4 and IPv6 summary details for router-id assignment
for cmd in cmd_outputs[:2]:
for vrf_name, vrf_data in cmd["vrfs"].items():
bgp_counters[vrf_name]["router_id"] = napalm.base.helpers.ip(
vrf_data["routerId"]
)

if "default" in bgp_counters:
bgp_counters["global"] = bgp_counters.pop("default")
return dict(bgp_counters)
Expand Down
91 changes: 0 additions & 91 deletions test/eos/mocked_data/test_get_bgp_neighbors/issue1168/expected_result.json
View file
Open in desktop

This file was deleted.

12 changes: 0 additions & 12 deletions ..._9_____grep__v___IPv_46__Unicast_______remote_AS___Local_AS_Desc_BGP_state__remote_r.text
View file
Open in desktop

This file was deleted.

37 changes: 0 additions & 37 deletions test/eos/mocked_data/test_get_bgp_neighbors/issue1168/show_ip_bgp_summary_vrf_all.json
View file
Open in desktop

This file was deleted.

12 changes: 0 additions & 12 deletions ..._____grep__v___IPv_46__Unicast_______remote_AS___Local_AS_Desc_BGP_state__remote_rou.text
View file
Open in desktop

This file was deleted.

Loading