Python3: resources and libraries

[csit.git] / resources / traffic_scripts / send_icmp_wait_for_reply.py

diff --git a/resources/traffic_scripts/send_icmp_wait_for_reply.py b/resources/traffic_scripts/send_icmp_wait_for_reply.py
index 3c8b71a..2c79ae7 100755 (executable)
--- a/resources/traffic_scripts/send_icmp_wait_for_reply.py
+++ b/resources/traffic_scripts/send_icmp_wait_for_reply.py
@@ -1,4 +1,5 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
+
 # Copyright (c) 2016 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.
@@ -12,52 +13,67 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Traffic script that sends an IP ICMPv4."""
+"""Traffic script that sends an IP ICMPv4 or ICMPv6."""
 
 import sys
+import ipaddress
 
 from scapy.layers.inet import ICMP, IP
-from scapy.all import Ether
+from scapy.layers.inet6 import IPv6, ICMPv6EchoRequest, ICMPv6EchoReply,\
+    ICMPv6ND_NS
+from scapy.layers.l2 import Ether
+from scapy.packet import Raw
 
 from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
 from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
 
 
-def is_icmp_reply(pkt):
-    """Return True if pkt is echo reply, else return False. If exception occurs
-    return False."""
+def valid_ipv4(ip):
+    """Check if IP address has the correct IPv4 address format.
+
+    :param ip: IP address.
+    :type ip: str
+    :return: True in case of correct IPv4 address format,
+             otherwise return False.
+    :rtype: bool
+    """
     try:
-        if pkt['IP']['ICMP'].type == 0:  # 0 - echo-reply
-            return True
-        else:
-            return False
-    except:
+        ipaddress.IPv4Address(ip)
+        return True
+    except (AttributeError, ipaddress.AddressValueError):
         return False
 
 
-def address_check(request, reply):
-    """Compare request packet source address with reply destination address
-    and vice versa. If exception occurs return False."""
+def valid_ipv6(ip):
+    """Check if IP address has the correct IPv6 address format.
+
+    :param ip: IP address.
+    :type ip: str
+    :return: True in case of correct IPv6 address format,
+             otherwise return False.
+    :rtype: bool
+    """
     try:
-        return reply['IP'].src == request['IP'].dst \
-               and reply['IP'].dst == request['IP'].src
-    except:
+        ipaddress.IPv6Address(ip)
+        return True
+    except (AttributeError, ipaddress.AddressValueError):
         return False
 
 
 def main():
     """Send ICMP echo request and wait for ICMP echo reply. It ignores all other
     packets."""
-    args = TrafficScriptArg(['dst_mac', 'src_mac', 'dst_ip', 'src_ip',
-                             'timeout'])
-
-    dst_mac = args.get_arg('dst_mac')
-    src_mac = args.get_arg('src_mac')
-    dst_ip = args.get_arg('dst_ip')
-    src_ip = args.get_arg('src_ip')
-    tx_if = args.get_arg('tx_if')
-    rx_if = args.get_arg('rx_if')
-    timeout = int(args.get_arg('timeout'))
+    args = TrafficScriptArg(
+        [u"dst_mac", u"src_mac", u"dst_ip", u"src_ip", u"timeout"]
+    )
+
+    dst_mac = args.get_arg(u"dst_mac")
+    src_mac = args.get_arg(u"src_mac")
+    dst_ip = args.get_arg(u"dst_ip")
+    src_ip = args.get_arg(u"src_ip")
+    tx_if = args.get_arg(u"tx_if")
+    rx_if = args.get_arg(u"rx_if")
+    timeout = int(args.get_arg(u"timeout"))
     wait_step = 1
 
     rxq = RxQueue(rx_if)
@@ -65,28 +81,56 @@ def main():
     sent_packets = []
 
     # Create empty ip ICMP packet
-    icmp_request = (Ether(src=src_mac, dst=dst_mac) /
-                    IP(src=src_ip, dst=dst_ip) /
-                    ICMP())
+    if valid_ipv4(src_ip) and valid_ipv4(dst_ip):
+        ip_layer = IP
+        icmp_req = ICMP
+        icmp_resp = ICMP
+        icmp_type = 0  # echo-reply
+    elif valid_ipv6(src_ip) and valid_ipv6(dst_ip):
+        ip_layer = IP
+        icmp_req = ICMPv6EchoRequest
+        icmp_resp = ICMPv6EchoReply
+        icmp_type = 0  # Echo Reply
+    else:
+        raise ValueError(u"IP not in correct format")
+
+    icmp_request = (
+            Ether(src=src_mac, dst=dst_mac) /
+            ip_layer(src=src_ip, dst=dst_ip) /
+            icmp_req()
+    )
+
     # Send created packet on the interface
+    icmp_request /= Raw()
     sent_packets.append(icmp_request)
     txq.send(icmp_request)
 
     for _ in range(1000):
-        icmp_reply = rxq.recv(wait_step)
-        if icmp_reply is None:
-            timeout -= wait_step
-            if timeout < 0:
-                raise RuntimeError("ICMP echo Rx timeout")
-        elif is_icmp_reply(icmp_reply):
-            if address_check(icmp_request, icmp_reply):
+        while True:
+            icmp_reply = rxq.recv(wait_step, ignore=sent_packets)
+            if icmp_reply is None:
+                timeout -= wait_step
+                if timeout < 0:
+                    raise RuntimeError(u"ICMP echo Rx timeout")
+
+            elif icmp_reply.haslayer(ICMPv6ND_NS):
+                # read another packet in the queue in case of ICMPv6ND_NS packet
+                continue
+            else:
+                # otherwise process the current packet
+                break
+
+        if icmp_reply[ip_layer][icmp_resp].type == icmp_type:
+            if icmp_reply[ip_layer].src == dst_ip and \
+                    icmp_reply[ip_layer].dst == src_ip:
                 break
     else:
-        raise RuntimeError("Max packet count limit reached")
+        raise RuntimeError(u"Max packet count limit reached")
 
-    print "ICMP echo reply received."
+    print(u"ICMP echo reply received.")
 
     sys.exit(0)
 
-if __name__ == "__main__":
+
+if __name__ == u"__main__":
     main()