Add get.py for iosxe eigrp folder containing 12 APIs for EIGRPv4 and EIGRPv6

pkgs/sdk-pkg/changelog/changelog_add_eigrp_get.py_apis_202329121901.rst

@@ -0,0 +1,13 @@
+--------------------------------------------------------------------------------
+                            New
+--------------------------------------------------------------------------------
+* IOSXE
+    * Added get.py in eigrp containing 06 APIs supporting IPv4 and IPv6:
+                * get_eigrp_interfaces
+		* get_eigrp_interfaces_as
+		* get_eigrp_interfaces_peers
+		* get_eigrp_interfaces_timers
+		* get_eigrp_neighbors
+		* get_eigrp_router_id
+
+

pkgs/sdk-pkg/src/genie/libs/sdk/apis/iosxe/eigrp/get.py

@@ -0,0 +1,167 @@
+import logging
+import os
+from genie.metaparser.util.exceptions import SchemaEmptyParserError
+log = logging.getLogger(__name__)
+
+def get_eigrp_interfaces(device, vrf='default', AS_N=None, ip='ipv4'):
+   """Gets all the interfaces on the device for a given AS or vrf for ipv4/ipv6
+      Args:
+        device (obj): Device object
+        vrf = "default" (str): Name of the vrf by default set to "default"
+        AS_N = None (int): Autonomous System
+        ip = "ipv4" (str): Protocol ip set by default to "ipv4" to change to "ipv6"  
+      Returns:
+        list: List of the interfaces in -interfaces- list
+   """
+   if ((isinstance(AS_N, int) and isinstance (ip, str) and isinstance(vrf, str) and AS_N!=0 and ip in ['ipv4','ipv6'])):
+      if AS_N:
+         try:
+            response=device.parse(f"show {'ipv6' if ip!='ipv4' else 'ip'} eigrp interfaces")
+         except SchemaEmptyParserError:
+            return None
+         interfaces = []
+         if (vrf not in response.q.get_values("vrf")) or (str(AS_N) not in response.q.get_values("eigrp_instance")):
+            log.error(f"Sorry,no data for the provided 'AS = {AS_N}' and/or 'vrf = {vrf}' !")
+         else:
+            interfaces = response.q.contains(vrf).contains_key_value("eigrp_instance", str(AS_N)).contains(ip).get_values('interface')
+      return interfaces
+   else:
+      log.error(f"Please, provide a valide format for AS and/or vrf and ip!!")
+
+def get_eigrp_interfaces_as(device, vrf='default', ip='ipv4'):
+   """Gets all the interfaces for a given vrf for ipv4 or ipv6 for all active AS
+      Args:
+        device (obj): Device object
+        vrf = "default" (str) : Name of the vrf
+        ip = "ipv4" (str): Protocol ip set by default to "ipv4" to change to "ipv6"
+      Returns:
+        Dict: Dctionary of the interfaces for a given AS in -inter_as_dict- Dict
+   """
+   if (isinstance(vrf, str) and isinstance(ip, str) and  ip in ['ipv4','ipv6']):
+      try:
+         response=device.parse(f"show {'ipv6' if ip!='ipv4' else 'ip'} eigrp interfaces")
+      except SchemaEmptyParserError:
+         return None
+      inter_as_dict={}
+      if (vrf not in response.q.get_values("vrf")):
+         log.error(f"Sorry, 'vrf = {vrf}' provided doesn't configured OR doesn't contain eigrp instances!")
+         return None
+      else:
+         as_proc = response.q.contains(vrf).contains(ip).get_values("eigrp_instance")
+         for as_n in as_proc:
+            interface_as=response.q.contains(as_n).get_values("interface")
+            inter_as_dict[as_n]=interface_as
+      return inter_as_dict
+   else:
+      log.error(f"Please, provide a valide format for vrf and/or ip!!")
+
+def get_eigrp_interfaces_timers(device, vrf='default', AS_N=None, ip='ipv4'):
+   """Gets hello interval and hold time for a given vrf and active AS for ipv4 or ipv6
+      Args:
+        device (obj): Device object
+        vrf = "default" (str) : Name of the vrf
+        AS_N = None (int) : Autonomous System
+        ip = "ipv4" (str): Protocol ip set by default to "ipv4" to change to "ipv6"
+      Returns:
+        Dict: Dctionary of the timers for all the interfaces for a given AS in -inter_timers- Dict
+   """
+   if ((isinstance(AS_N, int) and isinstance(vrf, str) and AS_N !=0 and ip in ['ipv4','ipv6'])):
+      if AS_N:
+         try:
+            response=device.parse(f"show {'ipv6' if ip!='ipv4' else 'ip'} eigrp interfaces detail")
+         except SchemaEmptyParserError:
+            return None
+         inter_timers={}
+         if (vrf not in response.q.get_values("vrf")) or (str(AS_N) not in response.q.get_values("eigrp_instance")):
+            log.error(f"Sorry, no data for the provided for 'AS = {AS_N}' and/or 'vrf = {vrf}' !")
+            return None
+         else:
+            interfaces = response.q.contains(vrf).contains_key_value("eigrp_instance",str(AS_N)).contains(ip).get_values("interface")
+            for interface in interfaces:
+               hello_interval = {"hello_interval":(response.q.contains(interface).get_values("hello_interval"))[0]}
+               hold_time = {"hold_time":(response.q.contains(interface).get_values("hold_time"))[0]}
+               inter_timers[interface] = [hello_interval, hold_time]
+      return inter_timers
+   else:
+      log.error(f"Please, provide a valide format for vrf and/or AS and ip!!")
+
+def get_eigrp_interfaces_peers(device, vrf='default', AS_N=None, ip='ipv4'):
+   """Gets interfaces and number of the EIGRP peers for a given vrf/active AS
+      Args:
+        device (obj): Device object
+        vrf = "default" (str) : Name of the vrf
+        AS_N = None (int) : Autonomous System
+        ip = "ipv4" (str): Protocol ip set by default to "ipv4" to change to "ipv6"
+      Returns:
+        Dict: Dctionary of the interfaces and the peers for a given AS in -inter_peers- Dict
+   """
+   if ((isinstance(AS_N, int) and isinstance(vrf, str) and AS_N !=0 and ip in ['ipv4','ipv6'])):
+      if AS_N:
+         try:
+            response=device.parse(f"show {'ipv6' if ip!='ipv4' else 'ip'} eigrp interfaces")
+         except SchemaEmptyParserError:
+            return None
+         inter_peers={}
+         if (vrf not in response.q.get_values("vrf")) or (str(AS_N) not in response.q.get_values("eigrp_instance")):
+            log.error(f"Sorry, no data for the provided 'AS = {AS_N}' and/or 'vrf = {vrf}' !")
+            return None
+         else:
+            interfaces = response.q.contains(vrf).contains_key_value("eigrp_instance",str(AS_N)).contains(ip).get_values("interface")
+            peers = response.q.contains(vrf).contains_key_value("eigrp_instance",str(AS_N)).contains(ip).get_values("peers")
+            for interface in interfaces:
+               inter_peers=dict(zip(interfaces, peers))
+      return inter_peers
+   else:
+      log.error(f"Please, provide a valide format for vrf and/or AS and ip!!")
+
+def get_eigrp_neighbors(device, vrf='default', AS_N=None, ip='ipv4'):
+   """Gets EIGRP neighbors for a given vrf and active AS instance for ipv4/ipv6
+      Args:
+        device (obj): Device object
+        vrf = "default" (str) : Name of the vrf
+        AS_N = None (int) : Autonomous System
+        ip = "ipv4" (str): Protocol ip set by default to "ipv4" to change to "ipv6"
+      Returns:
+        List: List of the EIGRP neighbors for a given AS in -eigrp_neighbors- List
+   """
+   if ((isinstance(AS_N, int) and isinstance(vrf, str) and AS_N != 0 and ip in ['ipv4','ipv6'])):
+      if AS_N:
+         try:
+            response=device.parse(f"show {'ipv6' if ip!='ipv4' else 'ip'} eigrp neighbors")
+         except SchemaEmptyParserError:
+            return None
+         eigrp_neighbors=[]
+         if (vrf not in response.q.get_values("vrf")) or (str(AS_N) not in response.q.get_values("eigrp_instance")):
+            log.error(f"Sorry, no data for the provided 'AS = {AS_N}' and/or 'vrf = {vrf}' !")
+            return None
+         else:
+            eigrp_neighbors = response.q.contains_key_value("eigrp_instance",str(AS_N)).contains(vrf).contains(ip).get_values("eigrp_nbr")
+      return eigrp_neighbors
+   else:
+      log.error(f"Please, provide a valide format for vrf and/or AS and ip!!")
+
+def get_eigrp_router_id(device, vrf='default', AS_N=None, ip = 'ipv4'):
+   """Gets EIGRP IDs for a given vrf and AS active instance for ipv4 or ipv6 
+      Args:
+        device (obj): Device object
+        vrf = "default" (str) : Name of the vrf
+        AS_N = None (int) : Autonomous System
+        ip = "ipv4" (str): Protocol ip set by default to "ipv4" to change to "ipv6"
+      Returns:
+        List: List of the EIGRP IDs for a given AS in -eigrp_id- List
+   """
+   if AS_N:
+      if ((isinstance(AS_N, int) and isinstance(vrf, str) and AS_N != 0 and ip in ['ipv4','ipv6'])):
+         try:
+            response=device.parse(f"show {'ipv6' if ip!='ipv4' else 'ip'} eigrp topology")
+         except SchemaEmptyParserError:
+            return None
+         eigrp_id=[]
+         if (vrf not in response.q.get_values("vrf")) or (str(AS_N) not in response.q.get_values("eigrp_instance")):
+            log.error(f"Sorry, no data for the provided for 'AS = {AS_N}' and/or 'vrf = {vrf}' !")
+            return None
+         else:
+            eigrp_id = response.q.contains_key_value("eigrp_instance", str(AS_N)).contains(vrf).contains((ip[0:2]).upper()+ip[2:]).get_values("eigrp_id")
+      return eigrp_id
+   else:
+      log.error(f"Please, provide a valide format for vrf and/or AS and ip!!")

pkgs/sdk-pkg/src/genie/libs/sdk/apis/tests/iosxe/eigrp/get/get_eigrp_interfaces/mock_data/iosxe/mock_data.yaml

@@ -0,0 +1,76 @@
+configure:
+  commands:
+    end:
+      new_state: execute
+    line console 0:
+      new_state: configure_line
+    no logging console: ''
+  prompt: R1(config)#
+configure_line:
+  commands:
+    end:
+      new_state: execute
+    exec-timeout 0: ''
+  prompt: R1(config-line)#
+connect:
+  commands:
+    ? ''
+    : new_state: execute
+  preface: 'Trying mock_device ...
+
+    Connected to mock_device.
+
+    Escape character is ''^]''.'
+  prompt: ''
+execute:
+  commands:
+    config term:
+      new_state: configure
+    config-transaction:
+      new_state: configure
+    show ip eigrp interfaces:
+      response:
+      - "EIGRP-IPv4 Interfaces for AS(1)\r\n                              Xmit Queue\
+        \   PeerQ        Mean   Pacing Time   Multicast    Pending\r\nInterface  \
+        \            Peers  Un/Reliable  Un/Reliable  SRTT   Un/Reliable   Flow Timer\
+        \   Routes\r\nFa0/0                    0        0/0       0/0           0\
+        \       0/0            0           0\r\nEIGRP-IPv4 Interfaces for AS(2)\r\n\
+        \                              Xmit Queue   PeerQ        Mean   Pacing Time\
+        \   Multicast    Pending\r\nInterface              Peers  Un/Reliable  Un/Reliable\
+        \  SRTT   Un/Reliable   Flow Timer   Routes\r\nFa1/0                    1\
+        \        0/0       0/0          36       0/0           50           0"
+      - "EIGRP-IPv4 Interfaces for AS(1)\r\n                              Xmit Queue\
+        \   PeerQ        Mean   Pacing Time   Multicast    Pending\r\nInterface  \
+        \            Peers  Un/Reliable  Un/Reliable  SRTT   Un/Reliable   Flow Timer\
+        \   Routes\r\nFa0/0                    0        0/0       0/0           0\
+        \       0/0            0           0\r\nEIGRP-IPv4 Interfaces for AS(2)\r\n\
+        \                              Xmit Queue   PeerQ        Mean   Pacing Time\
+        \   Multicast    Pending\r\nInterface              Peers  Un/Reliable  Un/Reliable\
+        \  SRTT   Un/Reliable   Flow Timer   Routes\r\nFa1/0                    1\
+        \        0/0       0/0          36       0/0           50           0"
+      - "EIGRP-IPv4 Interfaces for AS(1)\r\n                              Xmit Queue\
+        \   PeerQ        Mean   Pacing Time   Multicast    Pending\r\nInterface  \
+        \            Peers  Un/Reliable  Un/Reliable  SRTT   Un/Reliable   Flow Timer\
+        \   Routes\r\nFa0/0                    0        0/0       0/0           0\
+        \       0/0            0           0\r\nEIGRP-IPv4 Interfaces for AS(2)\r\n\
+        \                              Xmit Queue   PeerQ        Mean   Pacing Time\
+        \   Multicast    Pending\r\nInterface              Peers  Un/Reliable  Un/Reliable\
+        \  SRTT   Un/Reliable   Flow Timer   Routes\r\nFa1/0                    1\
+        \        0/0       0/0          36       0/0           50           0"
+      response_type: circular
+    show ipv6 eigrp interfaces:
+      response:
+      - "EIGRP-IPv6 Interfaces for AS(3)\r\n                              Xmit Queue\
+        \   PeerQ        Mean   Pacing Time   Multicast    Pending\r\nInterface  \
+        \            Peers  Un/Reliable  Un/Reliable  SRTT   Un/Reliable   Flow Timer\
+        \   Routes\r\nFa0/0                    0        0/0       0/0           0\
+        \       0/0            0           0\r\nEIGRP-IPv6 Interfaces for AS(4)\r\n\
+        \                              Xmit Queue   PeerQ        Mean   Pacing Time\
+        \   Multicast    Pending\r\nInterface              Peers  Un/Reliable  Un/Reliable\
+        \  SRTT   Un/Reliable   Flow Timer   Routes\r\nFa1/0                    1\
+        \        0/0       0/0         180       0/0          720           0"
+      response_type: circular
+    show version: ''
+    term length 0: ''
+    term width 0: ''
+  prompt: R1#

pkgs/sdk-pkg/src/genie/libs/sdk/apis/tests/iosxe/eigrp/get/get_eigrp_interfaces/test_api_get_eigrp_interfaces.py

@@ -0,0 +1,50 @@
+import os
+import unittest
+from pyats.topology import loader
+from genie.libs.sdk.apis.iosxe.eigrp.get import get_eigrp_interfaces
+
+
+class TestGetEigrpInterfaces(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(self):
+        testbed = f"""
+        devices:
+          R1:
+            connections:
+              defaults:
+                class: unicon.Unicon
+              a:
+                command: mock_device_cli --os iosxe --mock_data_dir {os.path.dirname(__file__)}/mock_data --state connect
+                protocol: unknown
+            os: iosxe
+            platform: iosxe
+            type: iosxe
+        """
+        self.testbed = loader.load(testbed)
+        self.device = self.testbed.devices['R1']
+        self.device.connect(
+            learn_hostname=True,
+            init_config_commands=[],
+            init_exec_commands=[]
+        )
+
+    def test_get_eigrp_interfaces(self):
+        result = get_eigrp_interfaces(self.device, 'default', 3, 'ipv4')
+        expected_output = []
+        self.assertEqual(result, expected_output)
+
+    def test_get_eigrp_interfaces_1(self):
+        result = get_eigrp_interfaces(self.device, 'default', 3, 'ipv6')
+        expected_output = ['FastEthernet0/0']
+        self.assertEqual(result, expected_output)
+
+    def test_get_eigrp_interfaces_2(self):
+        result = get_eigrp_interfaces(self.device, 'default', 1, 'ipv4')
+        expected_output = ['FastEthernet0/0']
+        self.assertEqual(result, expected_output)
+
+    def test_get_eigrp_interfaces_3(self):
+        result = get_eigrp_interfaces(self.device, 'default', 2, 'ipv4')
+        expected_output = ['FastEthernet1/0']
+        self.assertEqual(result, expected_output)

pkgs/sdk-pkg/src/genie/libs/sdk/apis/tests/iosxe/eigrp/get/get_eigrp_interfaces_as/mock_data/iosxe/mock_data.yaml

@@ -0,0 +1,76 @@
+configure:
+  commands:
+    end:
+      new_state: execute
+    line console 0:
+      new_state: configure_line
+    no logging console: ''
+  prompt: R1(config)#
+configure_line:
+  commands:
+    end:
+      new_state: execute
+    exec-timeout 0: ''
+  prompt: R1(config-line)#
+connect:
+  commands:
+    ? ''
+    : new_state: execute
+  preface: 'Trying mock_device ...
+
+    Connected to mock_device.
+
+    Escape character is ''^]''.'
+  prompt: ''
+execute:
+  commands:
+    config term:
+      new_state: configure
+    config-transaction:
+      new_state: configure
+    show ip eigrp interfaces:
+      response:
+      - "EIGRP-IPv4 Interfaces for AS(1)\r\n                              Xmit Queue\
+        \   PeerQ        Mean   Pacing Time   Multicast    Pending\r\nInterface  \
+        \            Peers  Un/Reliable  Un/Reliable  SRTT   Un/Reliable   Flow Timer\
+        \   Routes\r\nFa0/0                    0        0/0       0/0           0\
+        \       0/0            0           0\r\nEIGRP-IPv4 Interfaces for AS(2)\r\n\
+        \                              Xmit Queue   PeerQ        Mean   Pacing Time\
+        \   Multicast    Pending\r\nInterface              Peers  Un/Reliable  Un/Reliable\
+        \  SRTT   Un/Reliable   Flow Timer   Routes\r\nFa1/0                    1\
+        \        0/0       0/0          36       0/0           50           0"
+      - "EIGRP-IPv4 Interfaces for AS(1)\r\n                              Xmit Queue\
+        \   PeerQ        Mean   Pacing Time   Multicast    Pending\r\nInterface  \
+        \            Peers  Un/Reliable  Un/Reliable  SRTT   Un/Reliable   Flow Timer\
+        \   Routes\r\nFa0/0                    0        0/0       0/0           0\
+        \       0/0            0           0\r\nEIGRP-IPv4 Interfaces for AS(2)\r\n\
+        \                              Xmit Queue   PeerQ        Mean   Pacing Time\
+        \   Multicast    Pending\r\nInterface              Peers  Un/Reliable  Un/Reliable\
+        \  SRTT   Un/Reliable   Flow Timer   Routes\r\nFa1/0                    1\
+        \        0/0       0/0          36       0/0           50           0"
+      - "EIGRP-IPv4 Interfaces for AS(1)\r\n                              Xmit Queue\
+        \   PeerQ        Mean   Pacing Time   Multicast    Pending\r\nInterface  \
+        \            Peers  Un/Reliable  Un/Reliable  SRTT   Un/Reliable   Flow Timer\
+        \   Routes\r\nFa0/0                    0        0/0       0/0           0\
+        \       0/0            0           0\r\nEIGRP-IPv4 Interfaces for AS(2)\r\n\
+        \                              Xmit Queue   PeerQ        Mean   Pacing Time\
+        \   Multicast    Pending\r\nInterface              Peers  Un/Reliable  Un/Reliable\
+        \  SRTT   Un/Reliable   Flow Timer   Routes\r\nFa1/0                    1\
+        \        0/0       0/0          36       0/0           50           0"
+      response_type: circular
+    show ipv6 eigrp interfaces:
+      response:
+      - "EIGRP-IPv6 Interfaces for AS(3)\r\n                              Xmit Queue\
+        \   PeerQ        Mean   Pacing Time   Multicast    Pending\r\nInterface  \
+        \            Peers  Un/Reliable  Un/Reliable  SRTT   Un/Reliable   Flow Timer\
+        \   Routes\r\nFa0/0                    0        0/0       0/0           0\
+        \       0/0            0           0\r\nEIGRP-IPv6 Interfaces for AS(4)\r\n\
+        \                              Xmit Queue   PeerQ        Mean   Pacing Time\
+        \   Multicast    Pending\r\nInterface              Peers  Un/Reliable  Un/Reliable\
+        \  SRTT   Un/Reliable   Flow Timer   Routes\r\nFa1/0                    1\
+        \        0/0       0/0         180       0/0          720           0"
+      response_type: circular
+    show version: ''
+    term length 0: ''
+    term width 0: ''
+  prompt: R1#