CSIT-366 IPv4dp - baseline vhost-user

[csit.git] / resources / libraries / python / IPUtil.py

diff --git a/resources/libraries/python/IPUtil.py b/resources/libraries/python/IPUtil.py
index 3e002b3..5011708 100644 (file)
--- a/resources/libraries/python/IPUtil.py
+++ b/resources/libraries/python/IPUtil.py
@@ -13,31 +13,83 @@
 
 """Common IP utilities library."""
 
-from ssh import SSH
-from constants import Constants
+from ipaddress import IPv4Network, ip_address
+
+from resources.libraries.python.ssh import SSH
+from resources.libraries.python.constants import Constants
+
+from resources.libraries.python.topology import Topology
 
 
 class IPUtil(object):
     """Common IP utilities"""
 
-    def __init__(self):
-        pass
-
     @staticmethod
-    def vpp_ip_probe(node, interface, addr):
+    def vpp_ip_probe(node, interface, addr, if_type="key"):
         """Run ip probe on VPP node.
 
-           Args:
-               node (Dict): VPP node.
-               interface (str): Interface name
-               addr (str): IPv4/IPv6 address
+        :param node: VPP node.
+        :param interface: Interface key or name.
+        :param addr: IPv4/IPv6 address.
+        :param if_type: Interface type
+        :type node: dict
+        :type interface: str
+        :type addr: str
+        :type if_type: str
+        :raises ValueError: If the if_type is unknown.
+        :raises Exception: If vpp probe fails.
         """
         ssh = SSH()
         ssh.connect(node)
 
+        if if_type == "key":
+            iface_name = Topology.get_interface_name(node, interface)
+        elif if_type == "name":
+            iface_name = interface
+        else:
+            raise ValueError("if_type unknown: {0}".format(if_type))
+
         cmd = "{c}".format(c=Constants.VAT_BIN_NAME)
-        cmd_input = 'exec ip probe {dev} {ip}'.format(dev=interface, ip=addr)
+        cmd_input = 'exec ip probe {dev} {ip}'.format(dev=iface_name, ip=addr)
         (ret_code, _, _) = ssh.exec_command_sudo(cmd, cmd_input)
         if int(ret_code) != 0:
             raise Exception('VPP ip probe {dev} {ip} failed on {h}'.format(
-                dev=interface, ip=addr, h=node['host']))
+                dev=iface_name, ip=addr, h=node['host']))
+
+    @staticmethod
+    def ip_addresses_should_be_equal(ip1, ip2):
+        """Fails if the given IP addresses are unequal.
+
+        :param ip1: IPv4 or IPv6 address.
+        :param ip2: IPv4 or IPv6 address.
+        :type ip1: str
+        :type ip2: str
+        """
+
+        addr1 = ip_address(unicode(ip1))
+        addr2 = ip_address(unicode(ip2))
+
+        if addr1 != addr2:
+            raise AssertionError('IP addresses are not equal: {0} != {1}'.
+                                 format(ip1, ip2))
+
+
+def convert_ipv4_netmask_prefix(network):
+    """Convert network mask to equivalent network prefix length or vice versa.
+
+    Example: mask 255.255.0.0 -> prefix length 16
+    :param network: Network mask or network prefix length.
+    :type network: str or int
+    :return: Network mask or network prefix length.
+    :rtype: str or int
+    """
+    temp_address = "0.0.0.0"
+    net = IPv4Network(u"{0}/{1}".format(temp_address, network), False)
+
+    if isinstance(network, int) and (0 < network < 33):
+        return str(net.netmask)
+    elif isinstance(network, basestring):
+        return int(net.prefixlen)
+    else:
+        raise Exception("Value {0} is not a valid ipv4 netmask or network"
+                        " prefix length".format(network))