Add Honeycomb interface management tests (ipv4, ipv6, ethernet, routing)

 - add test cases for managing ipv4, ipv6, ethernet and routing
 configuration on VPP interface
 - add keywords used in these tests to set and verify configuration
 - add method and vat template for dumping an interface's
configured IP addresses
 - add method for converting between ipv4 netmasks and
   network prefixes
 - clean up documentation of older Honeycomb keywords

Note: Test cases are tagged with a placeholder tag to allow manual
test runs locally. It should be replaced with the appropriate
environment tags once Honeycomb service is deployed on virl.

Change-Id: I99ce1e72c8550f520f8c35ef4a93eaebb530db78
Signed-off-by: selias <samelias@cisco.com>
Signed-off-by: Matej Klotton <mklotton@cisco.com>

2 files changed, 50 insertions, 0 deletions

diff --git a/resources/libraries/python/IPUtil.py b/resources/libraries/python/IPUtil.py
index 8ad01c491b..00a7000c65 100644
--- a/resources/libraries/python/IPUtil.py
+++ b/resources/libraries/python/IPUtil.py
@@ -12,6 +12,7 @@
 # limitations under the License.
 
 """Common IP utilities library."""
+from ipaddress import IPv4Network
 
 from resources.libraries.python.ssh import SSH
 from resources.libraries.python.constants import Constants
@@ -40,3 +41,21 @@ class IPUtil(object):
         if int(ret_code) != 0:
             raise Exception('VPP ip probe {dev} {ip} failed on {h}'.format(
                 dev=interface, ip=addr, h=node['host']))
+
+
+def convert_ipv4_netmask_prefix(netmask):
+    """Convert network mask to equivalent network prefix length or vice versa.
+
+    Example: mask 255.255.0.0 -> prefix length 16
+    :param netmask: network mask or network prefix length.
+    :type netmask: 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, netmask), False)
+
+    if isinstance(netmask, int):
+        return net.netmask
+    elif isinstance(netmask, basestring):
+        return net.prefixlen
diff --git a/resources/libraries/python/InterfaceUtil.py b/resources/libraries/python/InterfaceUtil.py
index 021e8ed74f..ec2ef69dfc 100644
--- a/resources/libraries/python/InterfaceUtil.py
+++ b/resources/libraries/python/InterfaceUtil.py
@@ -18,6 +18,7 @@ from time import time, sleep
 from robot.api import logger
 
 from resources.libraries.python.ssh import SSH
+from resources.libraries.python.IPUtil import convert_ipv4_netmask_prefix
 from resources.libraries.python.ssh import exec_cmd_no_error
 from resources.libraries.python.topology import NodeType, Topology
 from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
@@ -201,6 +202,36 @@ class InterfaceUtil(object):
         return data
 
     @staticmethod
+    def vpp_get_interface_ip_addresses(node, interface, ip_version):
+        """Get list of IP addresses from an interface on a VPP node.
+
+         :param node: VPP node to get data from.
+         :param interface: Name of an interface on the VPP node.
+         :param ip_version: IP protocol version (ipv4 or ipv6).
+         :type node: dict
+         :type interface: str
+         :type ip_version: str
+         :return: List of dictionaries, each containing IP address, subnet
+         prefix length and also the subnet mask for ipv4 addresses.
+         Note: A single interface may have multiple IP addresses assigned.
+         :rtype: list
+        """
+        sw_if_index = Topology.get_interface_sw_index(node, interface)
+
+        with VatTerminal(node) as vat:
+            response = vat.vat_terminal_exec_cmd_from_template(
+                "ip_address_dump.vat", ip_version=ip_version,
+                sw_if_index=sw_if_index)
+
+        data = response[0]
+
+        if ip_version == "ipv4":
+            for item in data:
+                item["netmask"] = convert_ipv4_netmask_prefix(
+                    item["prefix_length"])
+        return data
+
+    @staticmethod
     def tg_set_interface_driver(node, pci_addr, driver):
         """Set interface driver on the TG node.