LISP: 3-node (func) to 2-node (dev) converstion
[csit.git] / resources / libraries / python / IPUtil.py
index 17ba75d..de018b9 100644 (file)
 import re
 
 from enum import IntEnum
-from ipaddress import ip_address, IPv4Network, IPv6Network
+from ipaddress import ip_address
 
 from resources.libraries.python.Constants import Constants
 from resources.libraries.python.InterfaceUtil import InterfaceUtil
-from resources.libraries.python.PapiExecutor import PapiExecutor
+from resources.libraries.python.PapiExecutor import PapiSocketExecutor
 from resources.libraries.python.ssh import exec_cmd_no_error, exec_cmd
 from resources.libraries.python.topology import Topology
 from resources.libraries.python.VatExecutor import VatTerminal
@@ -55,7 +55,7 @@ class FibPathType(IntEnum):
 class FibPathFlags(IntEnum):
     """FIB path flags."""
     FIB_PATH_FLAG_NONE = 0
-    FIB_PATH_FLAG_RESOLVE_VIA_ATTACHED = 1
+    FIB_PATH_FLAG_RESOLVE_VIA_ATTACHED = 1  #pylint: disable=invalid-name
     FIB_PATH_FLAG_RESOLVE_VIA_HOST = 2
 
 
@@ -112,34 +112,24 @@ class IPUtil(object):
         """
         sw_if_index = InterfaceUtil.get_interface_index(node, interface)
 
-        data = list()
-        if sw_if_index:
-            is_ipv6 = 1 if ip_version == 'ipv6' else 0
-
-            cmd = 'ip_address_dump'
-            cmd_reply = 'ip_address_details'
-            args = dict(sw_if_index=sw_if_index,
-                        is_ipv6=is_ipv6)
-            err_msg = 'Failed to get L2FIB dump on host {host}'.format(
-                host=node['host'])
-
-            with PapiExecutor(node) as papi_exec:
-                papi_resp = papi_exec.add(cmd, **args).get_dump(err_msg)
-
-            for item in papi_resp.reply[0]['api_reply']:
-                item[cmd_reply]['ip'] = item[cmd_reply]['prefix'].split('/')[0]
-                item[cmd_reply]['prefix_length'] = int(
-                    item[cmd_reply]['prefix'].split('/')[1])
-                item[cmd_reply]['is_ipv6'] = is_ipv6
-                item[cmd_reply]['netmask'] = \
-                    str(IPv6Network(unicode('::/{pl}'.format(
-                        pl=item[cmd_reply]['prefix_length']))).netmask) \
-                    if is_ipv6 \
-                    else str(IPv4Network(unicode('0.0.0.0/{pl}'.format(
-                        pl=item[cmd_reply]['prefix_length']))).netmask)
-                data.append(item[cmd_reply])
-
-        return data
+        if not sw_if_index:
+            return list()
+
+        is_ipv6 = 1 if ip_version == 'ipv6' else 0
+
+        cmd = 'ip_address_dump'
+        args = dict(sw_if_index=sw_if_index,
+                    is_ipv6=is_ipv6)
+        err_msg = 'Failed to get L2FIB dump on host {host}'.format(
+            host=node['host'])
+
+        with PapiSocketExecutor(node) as papi_exec:
+            details = papi_exec.add(cmd, **args).get_details(err_msg)
+
+        # TODO: CSIT currently looks only whether the list is empty.
+        # Add proper value processing if values become important.
+
+        return details
 
     @staticmethod
     def vpp_get_ip_tables(node):
@@ -149,25 +139,27 @@ class IPUtil(object):
         :type node: dict
         """
 
-        PapiExecutor.run_cli_cmd(node, 'show ip fib')
-        PapiExecutor.run_cli_cmd(node, 'show ip fib summary')
-        PapiExecutor.run_cli_cmd(node, 'show ip6 fib')
-        PapiExecutor.run_cli_cmd(node, 'show ip6 fib summary')
+        PapiSocketExecutor.run_cli_cmd(node, 'show ip fib')
+        PapiSocketExecutor.run_cli_cmd(node, 'show ip fib summary')
+        PapiSocketExecutor.run_cli_cmd(node, 'show ip6 fib')
+        PapiSocketExecutor.run_cli_cmd(node, 'show ip6 fib summary')
 
     @staticmethod
     def vpp_get_ip_tables_prefix(node, address):
         """Get dump of all IP FIB tables on a VPP node.
 
         :param node: VPP node.
+        :param address: IP address.
         :type node: dict
+        :type address: str
         """
-        ip = ip_address(unicode(address))
+        addr = ip_address(unicode(address))
 
-        PapiExecutor.run_cli_cmd(
+        PapiSocketExecutor.run_cli_cmd(
             node, 'show {ip_ver} fib {addr}/{addr_len}'.format(
-                ip_ver='ip6' if ip.version == 6 else 'ip',
-                addr=ip,
-                addr_len=ip.max_prefixlen))
+                ip_ver='ip6' if addr.version == 6 else 'ip',
+                addr=addr,
+                addr_len=addr.max_prefixlen))
 
     @staticmethod
     def get_interface_vrf_table(node, interface, ip_version='ipv4'):
@@ -184,19 +176,18 @@ class IPUtil(object):
         """
         sw_if_index = InterfaceUtil.get_interface_index(node, interface)
 
-        is_ipv6 = 1 if ip_version == 'ipv6' else 0
-
         cmd = 'sw_interface_get_table'
-        args = dict(sw_if_index=sw_if_index,
-                    is_ipv6=is_ipv6)
+        args = dict(
+            sw_if_index=sw_if_index,
+            is_ipv6=True if ip_version == 'ipv6' else False
+        )
         err_msg = 'Failed to get VRF id assigned to interface {ifc}'.format(
             ifc=interface)
 
-        with PapiExecutor(node) as papi_exec:
-            papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg). \
-                verify_reply(err_msg=err_msg)
+        with PapiSocketExecutor(node) as papi_exec:
+            reply = papi_exec.add(cmd, **args).get_reply(err_msg)
 
-        return papi_resp['vrf_id']
+        return reply['vrf_id']
 
     @staticmethod
     def vpp_ip_source_check_setup(node, if_name):
@@ -211,12 +202,12 @@ class IPUtil(object):
         args = dict(
             sw_if_index=InterfaceUtil.get_interface_index(node, if_name),
             is_add=1,
-            loose=0)
+            loose=0
+        )
         err_msg = 'Failed to enable source check on interface {ifc}'.format(
             ifc=if_name)
-        with PapiExecutor(node) as papi_exec:
-            papi_exec.add(cmd, **args).get_replies(err_msg). \
-                verify_reply(err_msg=err_msg)
+        with PapiSocketExecutor(node) as papi_exec:
+            papi_exec.add(cmd, **args).get_reply(err_msg)
 
     @staticmethod
     def vpp_ip_probe(node, interface, addr):
@@ -230,16 +221,14 @@ class IPUtil(object):
         :type addr: str
         """
         cmd = 'ip_probe_neighbor'
-        cmd_reply = 'proxy_arp_intfc_enable_disable_reply'
         args = dict(
             sw_if_index=InterfaceUtil.get_interface_index(node, interface),
             dst=str(addr))
         err_msg = 'VPP ip probe {dev} {ip} failed on {h}'.format(
             dev=interface, ip=addr, h=node['host'])
 
-        with PapiExecutor(node) as papi_exec:
-            papi_exec.add(cmd, **args).get_replies(err_msg). \
-                verify_reply(cmd_reply=cmd_reply, err_msg=err_msg)
+        with PapiSocketExecutor(node) as papi_exec:
+            papi_exec.add(cmd, **args).get_reply(err_msg)
 
     @staticmethod
     def ip_addresses_should_be_equal(ip1, ip2):
@@ -407,17 +396,17 @@ class IPUtil(object):
         cmd = 'sw_interface_add_del_address'
         args = dict(
             sw_if_index=InterfaceUtil.get_interface_index(node, interface),
-            is_add=1,
-            is_ipv6=1 if ip_addr.version == 6 else 0,
-            del_all=0,
-            address_length=int(prefix_length) if prefix_length else 128
-            if ip_addr.version == 6 else 32,
-            address=ip_addr.packed)
+            is_add=True,
+            del_all=False,
+            prefix=IPUtil.create_prefix_object(
+                ip_addr,
+                prefix_length if prefix_length else 128
+                if ip_addr.version == 6 else 32)
+        )
         err_msg = 'Failed to add IP address on interface {ifc}'.format(
             ifc=interface)
-        with PapiExecutor(node) as papi_exec:
-            papi_exec.add(cmd, **args).get_replies(err_msg). \
-                verify_reply(err_msg=err_msg)
+        with PapiSocketExecutor(node) as papi_exec:
+            papi_exec.add(cmd, **args).get_reply(err_msg)
 
     @staticmethod
     def vpp_add_ip_neighbor(node, iface_key, ip_addr, mac_address):
@@ -445,9 +434,8 @@ class IPUtil(object):
             neighbor=neighbor)
         err_msg = 'Failed to add IP neighbor on interface {ifc}'.format(
             ifc=iface_key)
-        with PapiExecutor(node) as papi_exec:
-            papi_exec.add(cmd, **args).get_replies(err_msg). \
-                verify_reply(err_msg=err_msg)
+        with PapiSocketExecutor(node) as papi_exec:
+            papi_exec.add(cmd, **args).get_reply(err_msg)
 
     @staticmethod
     def union_addr(ip_addr):
@@ -461,6 +449,39 @@ class IPUtil(object):
         return dict(ip6=ip_addr.packed) if ip_addr.version == 6 \
             else dict(ip4=ip_addr.packed)
 
+    @staticmethod
+    def create_ip_address_object(ip_addr):
+        """Create IP address object.
+
+        :param ip_addr: IPv4 or IPv6 address
+        :type ip_addr: IPv4Address or IPv6Address
+        :returns: IP address object.
+        :rtype: dict
+        """
+        return dict(
+            af=getattr(
+                AddressFamily, 'ADDRESS_IP6' if ip_addr.version == 6
+                else 'ADDRESS_IP4').value,
+            un=IPUtil.union_addr(ip_addr))
+
+    @staticmethod
+    def create_prefix_object(ip_addr, addr_len):
+        """Create prefix object.
+
+        :param ip_addr: IPv4 or IPv6 address.
+        :para, addr_len: Length of IP address.
+        :type ip_addr: IPv4Address or IPv6Address
+        :type addr_len: int
+        :returns: Prefix object.
+        :rtype: dict
+        """
+        addr = IPUtil.create_ip_address_object(ip_addr)
+
+        return dict(
+            len=int(addr_len),
+            address=addr
+        )
+
     @staticmethod
     def compose_vpp_route_structure(node, network, prefix_len, **kwargs):
         """Create route object for ip_route_add_del api call.
@@ -492,21 +513,15 @@ class IPUtil(object):
 
         net_addr = ip_address(unicode(network))
 
-        addr = dict(
-            af=getattr(
-                AddressFamily, 'ADDRESS_IP6' if net_addr.version == 6
-                else 'ADDRESS_IP4').value,
-            un=None)
-        prefix = dict(
-            len=int(prefix_len),
-            address=addr)
+        prefix = IPUtil.create_prefix_object(net_addr, prefix_len)
 
         paths = list()
         n_hop = dict(
             address=IPUtil.union_addr(ip_address(unicode(gateway))) if gateway
             else 0,
             via_label=MPLS_LABEL_INVALID,
-            obj_id=Constants.BITWISE_NON_ZERO)
+            obj_id=Constants.BITWISE_NON_ZERO
+        )
         path = dict(
             sw_if_index=InterfaceUtil.get_interface_index(node, interface)
             if interface else Constants.BITWISE_NON_ZERO,
@@ -525,15 +540,16 @@ class IPUtil(object):
                 else 'FIB_PATH_NH_PROTO_IP4').value,
             nh=n_hop,
             n_labels=0,
-            label_stack=list(0 for _ in range(16)))
+            label_stack=list(0 for _ in range(16))
+        )
         paths.append(path)
 
         route = dict(
             table_id=int(kwargs.get('vrf', 0)),
             prefix=prefix,
             n_paths=len(paths),
-            paths=paths)
-
+            paths=paths
+        )
         return route
 
     @staticmethod
@@ -584,25 +600,21 @@ class IPUtil(object):
 
         net_addr = ip_address(unicode(network))
         cmd = 'ip_route_add_del'
-        route = IPUtil.compose_vpp_route_structure(
-            node, network, prefix_len, **kwargs)
         args = dict(
             is_add=1,
             is_multipath=int(kwargs.get('multipath', False)),
-            route=route)
+            route=None
+        )
 
         err_msg = 'Failed to add route(s) on host {host}'.format(
             host=node['host'])
-        with PapiExecutor(node) as papi_exec:
+        with PapiSocketExecutor(node) as papi_exec:
             for i in xrange(kwargs.get('count', 1)):
-                args['route']['prefix']['address']['un'] = \
-                    IPUtil.union_addr(net_addr + i)
+                args['route'] = IPUtil.compose_vpp_route_structure(
+                    node, net_addr + i, prefix_len, **kwargs)
                 history = False if 1 < i < kwargs.get('count', 1) else True
                 papi_exec.add(cmd, history=history, **args)
-                if i > 0 and i % Constants.PAPI_MAX_API_BULK == 0:
-                    papi_exec.get_replies(err_msg).verify_replies(
-                        err_msg=err_msg)
-            papi_exec.get_replies(err_msg).verify_replies(err_msg=err_msg)
+            papi_exec.get_replies(err_msg)
 
     @staticmethod
     def flush_ip_addresses(node, interface):
@@ -616,12 +628,13 @@ class IPUtil(object):
         cmd = 'sw_interface_add_del_address'
         args = dict(
             sw_if_index=InterfaceUtil.get_interface_index(node, interface),
-            del_all=1)
+            is_add=False,
+            del_all=True
+        )
         err_msg = 'Failed to flush IP address on interface {ifc}'.format(
             ifc=interface)
-        with PapiExecutor(node) as papi_exec:
-            papi_exec.add(cmd, **args).get_replies(err_msg). \
-                verify_reply(err_msg=err_msg)
+        with PapiSocketExecutor(node) as papi_exec:
+            papi_exec.add(cmd, **args).get_reply(err_msg)
 
     @staticmethod
     def add_fib_table(node, table_id, ipv6=False):
@@ -643,6 +656,5 @@ class IPUtil(object):
             is_add=1)
         err_msg = 'Failed to add FIB table on host {host}'.format(
             host=node['host'])
-        with PapiExecutor(node) as papi_exec:
-            papi_exec.add(cmd, **args).get_replies(err_msg). \
-                verify_reply(err_msg=err_msg)
+        with PapiSocketExecutor(node) as papi_exec:
+            papi_exec.add(cmd, **args).get_reply(err_msg)