X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FIPv4Util.py;h=c40e391c366f3cac81ddd3e2d03244d05adc1fc2;hp=ca5a1b571fb6e1328695c12ed60d196b4ad8edd2;hb=cc0c2870a18fb74a56410eca2d1870bddc945397;hpb=c3bf9f6ad20223998c1103ba3061a5e338979e2b

diff --git a/resources/libraries/python/IPv4Util.py b/resources/libraries/python/IPv4Util.py
index ca5a1b571f..c40e391c36 100644
--- a/resources/libraries/python/IPv4Util.py
+++ b/resources/libraries/python/IPv4Util.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2018 Cisco and/or its affiliates.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at:
@@ -18,6 +18,7 @@ from robot.api.deco import keyword
 
 from resources.libraries.python.topology import Topology
 from resources.libraries.python.IPv4Setup import get_node
+from resources.libraries.python.VatExecutor import VatTerminal
 from resources.libraries.python.ssh import exec_cmd
 
 
@@ -28,6 +29,15 @@ class IPv4Util(object):
     @keyword('From node "${node}" interface "${port}" ARP-ping '
              'IPv4 address "${ip_address}"')
     def arp_ping(node, interface, ip_address):
+        """Send an ARP ping from the specified node.
+
+        :param node: Node in topology.
+        :param ip_address: Destination IP address for the ARP packet.
+        :param interface: Name of an interface to send the ARP packet from.
+        :type node: dict
+        :type ip_address: str
+        :type interface: str
+        """
         log.debug('From node {} interface {} ARP-ping IPv4 address {}'.
                   format(Topology.get_node_hostname(node),
                          interface, ip_address))
@@ -85,12 +95,12 @@ class IPv4Util(object):
         :type node: dict
         :type port: str
         :type nodes_addr: dict
-        :return: IPv4 prefix length.
+        :returns: IPv4 prefix length.
         :rtype: int
         """
         for net in nodes_addr.values():
-            for p in net['ports'].values():
-                if p['node'] == node['host'] and p['if'] == port:
+            for net_port in net['ports'].values():
+                if net_port['node'] == node['host'] and net_port['if'] == port:
                     return net['prefix']
 
         raise Exception('Subnet not found for node {n} port {p}'.
@@ -108,12 +118,12 @@ class IPv4Util(object):
         :type node: dict
         :type port: int
         :type nodes_addr: dict
-        :return: IPv4 subnet.
+        :returns: IPv4 subnet.
         :rtype: str
         """
         for net in nodes_addr.values():
-            for p in net['ports'].values():
-                if p['node'] == node['host'] and p['if'] == port:
+            for net_port in net['ports'].values():
+                if net_port['node'] == node['host'] and net_port['if'] == port:
                     return net['net_addr']
 
         raise Exception('Subnet not found for node {n} port {p}'.
@@ -124,9 +134,9 @@ class IPv4Util(object):
     def flush_ip_addresses(port, node):
         """See IPv4Node.flush_ip_addresses for more information.
 
-        :param port:
-        :param node:
-        :return:
+        :param port: FIXME
+        :param node: FIXME
+        :returns: FIXME
         """
         get_node(node).flush_ip_addresses(port)
 
@@ -138,7 +148,7 @@ class IPv4Util(object):
         :param nodes_addr: Available nodes IPv4 addresses.
         :type link: str
         :type nodes_addr: dict
-        :return: Link IPv4 address.
+        :returns: Link IPv4 address.
         :rtype: str
         """
         net = nodes_addr.get(link)
@@ -154,7 +164,7 @@ class IPv4Util(object):
         :param nodes_addr: Available nodes IPv4 addresses.
         :type link: str
         :type nodes_addr: dict
-        :return: Link IPv4 address prefix.
+        :returns: Link IPv4 address prefix.
         :rtype: int
         """
         net = nodes_addr.get(link)
@@ -189,32 +199,42 @@ class IPv4Util(object):
                 interface, ping_count, destination)
         else:
             cmd = 'ping -c{0} {1}'.format(ping_count, destination)
-        rc, stdout, stderr = exec_cmd(node, cmd, sudo=True)
-        if rc != 0:
+        ret_code, _, _ = exec_cmd(node, cmd, sudo=True)
+        if ret_code != 0:
             raise RuntimeError("Ping Not Successful")
 
     @staticmethod
-    def set_linux_interface_arp(node, interface, ip, mac, namespace=None):
+    def set_linux_interface_arp(node, interface, ip_addr, mac, namespace=None):
         """Set arp on interface in linux.
 
         :param node: Node where to execute command.
         :param interface: Interface in namespace.
-        :param ip: IP for arp.
+        :param ip_addr: IP address for ARP entry.
         :param mac: MAC address.
         :param namespace: Execute command in namespace. Optional
         :type node: dict
         :type interface: str
-        :type ip: str
+        :type ip_addr: str
         :type mac: str
         :type namespace: str
         :raises RuntimeError: Could not set ARP properly.
         """
         if namespace is not None:
             cmd = 'ip netns exec {} arp -i {} -s {} {}'.format(
-                namespace, interface, ip, mac)
+                namespace, interface, ip_addr, mac)
         else:
-            cmd = 'arp -i {} -s {} {}'.format(interface, ip, mac)
-        rc, _, stderr = exec_cmd(node, cmd, sudo=True)
-        if rc != 0:
+            cmd = 'arp -i {} -s {} {}'.format(interface, ip_addr, mac)
+        ret_code, _, stderr = exec_cmd(node, cmd, sudo=True)
+        if ret_code != 0:
             raise RuntimeError("Arp set not successful, reason:{}".
                                format(stderr))
+
+    @staticmethod
+    def vpp_show_ip_table(node):
+        """Get IP FIB table data from a VPP node.
+
+        :param node: VPP node.
+        :type node: dict
+        """
+        with VatTerminal(node, json_param=False) as vat:
+            vat.vat_terminal_exec_cmd_from_template("show_ip_fib.vat")