CSIT-32: Add Softwire lw4o6 ICMP test

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

diff --git a/resources/traffic_scripts/send_ipv4_icmp_check_lw_4o6.py b/resources/traffic_scripts/send_ipv4_icmp_check_lw_4o6.py
new file mode 100755 (executable)
index 0000000..9e22542
--- /dev/null
+++ b/resources/traffic_scripts/send_ipv4_icmp_check_lw_4o6.py
@@ -0,0 +1,139 @@
+#!/usr/bin/env python
+# 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.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Traffic script that sends an IPv4 ICMP packet with ID field and checks if
+IPv4 is correctly encapsulated into IPv6 packet. Doing for ICMP echo request
+and ICMP echo response packet."""
+
+import sys
+
+from scapy.layers.l2 import Ether
+from scapy.layers.inet import IP, ICMP, icmptypes
+
+from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
+from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
+
+
+def _is_ipv4_in_ipv6(pkt):
+    """If IPv6 next header type in the given pkt is IPv4, return True,
+    else return False. False is returned also if exception occurs."""
+    ipv6_type = int('0x86dd', 16)  # IPv6
+    try:
+        if pkt.type == ipv6_type:
+            if pkt.payload.nh == 4:
+                return True
+    except:  # pylint: disable=bare-except
+        return False
+    return False
+
+
+def main():  # pylint: disable=too-many-statements, too-many-locals
+    """Main function of the script file."""
+    args = TrafficScriptArg(['tx_dst_mac', 'tx_src_ipv4', 'tx_dst_ipv4',
+                             'tx_icmp_id', 'rx_dst_mac', 'rx_src_mac',
+                             'src_ipv6', 'dst_ipv6'])
+    rx_if = args.get_arg('rx_if')
+    tx_if = args.get_arg('tx_if')
+    tx_dst_mac = args.get_arg('tx_dst_mac')
+    tx_src_ipv4 = args.get_arg('tx_src_ipv4')
+    tx_dst_ipv4 = args.get_arg('tx_dst_ipv4')
+    tx_icmp_id = int(args.get_arg('tx_icmp_id'))
+    rx_dst_mac = args.get_arg('rx_dst_mac')
+    rx_src_mac = args.get_arg('rx_src_mac')
+    rx_src_ipv6 = args.get_arg('src_ipv6')
+    rx_dst_ipv6 = args.get_arg('dst_ipv6')
+
+    rxq = RxQueue(rx_if)
+    txq = TxQueue(tx_if)
+    sent_packets = []
+
+    for icmp_type in ('echo-request', 'echo-reply'):
+        print '\nChecking ICMP type: {}'.format(icmp_type)
+
+        # Create ICMP request
+        tx_pkt = (Ether(dst=tx_dst_mac) /
+                  IP(src=tx_src_ipv4, dst=tx_dst_ipv4) /
+                  ICMP(type=icmp_type, id=tx_icmp_id))
+
+        txq.send(tx_pkt)
+        sent_packets.append(tx_pkt)
+
+        for _ in range(5):
+            pkt = rxq.recv(2)
+            if _is_ipv4_in_ipv6(pkt):
+                ether = pkt
+                break
+        else:
+            raise RuntimeError("IPv4 in IPv6 Rx error.")
+
+        # check ethernet
+        if ether.dst != rx_dst_mac:
+            raise RuntimeError("Destination MAC error {} != {}.".
+                               format(ether.dst, rx_dst_mac))
+        print "Destination MAC: OK."
+
+        if ether.src != rx_src_mac:
+            raise RuntimeError("Source MAC error {} != {}.".
+                               format(ether.src, rx_src_mac))
+        print "Source MAC: OK."
+
+        ipv6 = ether.payload
+
+        # check ipv6
+        if ipv6.dst != rx_dst_ipv6:
+            raise RuntimeError("Destination IP error {} != {}.".
+                               format(ipv6.dst, rx_dst_ipv6))
+        print "Destination IPv6: OK."
+
+        if ipv6.src != rx_src_ipv6:
+            raise RuntimeError("Source IP error {} != {}.".
+                               format(ipv6.src, rx_src_ipv6))
+        print "Source IPv6: OK."
+
+        ipv4 = ipv6.payload
+
+        # check ipv4
+        if ipv4.dst != tx_dst_ipv4:
+            raise RuntimeError("Destination IP error {} != {}.".
+                               format(ipv4.dst, tx_dst_ipv4))
+        print "Destination IPv4: OK."
+
+        if ipv4.src != tx_src_ipv4:
+            raise RuntimeError("Source IP error {} != {}.".
+                               format(ipv4.src, tx_src_ipv4))
+        print "Source IPv4: OK."
+
+        # check icmp echo request
+        if ipv4.proto != 1:  # ICMP
+            raise RuntimeError("IP protocol error {} != ICMP.".
+                               format(ipv4.proto))
+        print "IPv4 protocol: OK."
+
+        icmp = ipv4.payload
+
+        # check icmp
+        if icmptypes[icmp.type] != icmp_type:
+            raise RuntimeError("ICMP type error {} != echo request.".
+                               format(icmp.type))
+        print "ICMP type: OK."
+
+        if icmp.id != tx_icmp_id:
+            raise RuntimeError("ICMP ID error {} != {}.".
+                               format(icmp.id, tx_icmp_id))
+        print "ICMP ID: OK."
+
+    sys.exit(0)
+
+if __name__ == "__main__":
+    main()