Add output.xml with only INFO logging leve
[csit.git] / resources / libraries / python / IPv4Util.py
index 5ee73c0..c40e391 100644 (file)
@@ -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,8 @@ 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
 
 
 class IPv4Util(object):
@@ -27,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))
@@ -84,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}'.
@@ -107,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}'.
@@ -123,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)
 
@@ -137,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)
@@ -153,10 +164,77 @@ 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)
         if net is None:
             raise ValueError('Link "{0}" not found'.format(link))
         return net.get('prefix')
+
+    @staticmethod
+    def send_ping_from_node_to_dst(node, destination, namespace=None,
+                                   ping_count=3, interface=None):
+        """Send a ping from node to destination. Optionally, you can define a
+        namespace and interface from where to send a ping.
+
+        :param node: Node to start ping on.
+        :param destination: IPv4 address where to send ping.
+        :param namespace: Namespace to send ping from. Optional
+        :param ping_count: Number of pings to send. Default 3
+        :param interface: Interface from where to send ping. Optional
+        :type node: dict
+        :type destination: str
+        :type namespace: str
+        :type ping_count: int
+        :type interface: str
+        :raises RuntimeError: If no response for ping, raise error
+        """
+        cmd = ''
+        if namespace is not None:
+            cmd = 'ip netns exec {0} ping -c{1} {2}'.format(
+                namespace, ping_count, destination)
+        elif interface is not None:
+            cmd = 'ping -I {0} -c{1} {2}'.format(
+                interface, ping_count, destination)
+        else:
+            cmd = 'ping -c{0} {1}'.format(ping_count, destination)
+        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_addr, mac, namespace=None):
+        """Set arp on interface in linux.
+
+        :param node: Node where to execute command.
+        :param interface: Interface in namespace.
+        :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_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_addr, mac)
+        else:
+            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")