CSIT-611: HC Test: Lisp suite updates + LispGPE

[csit.git] / resources / traffic_scripts / lisp / lisp_check.py

diff --git a/resources/traffic_scripts/lisp/lisp_check.py b/resources/traffic_scripts/lisp/lisp_check.py
new file mode 100755 (executable)
index 0000000..5e1a835
--- /dev/null
+++ b/resources/traffic_scripts/lisp/lisp_check.py
@@ -0,0 +1,164 @@
+#!/usr/bin/env python
+# Copyright (c) 2017 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 ICMP/ICMPv6 packet out one interface, receives
+a LISP-encapsulated packet on the other interface and verifies received packet.
+"""
+
+import sys
+import ipaddress
+
+from scapy.layers.inet import ICMP, IP, UDP
+from scapy.layers.inet6 import ICMPv6EchoRequest
+from scapy.layers.inet6 import IPv6
+from scapy.layers.l2 import Ether
+from scapy.all import bind_layers, Packet
+from scapy.fields import FlagsField, BitField, IntField
+
+from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
+from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
+
+
+class LispHeader(Packet):
+    """Scapy header for the LISP Layer."""
+    name = "Lisp Header"
+    fields_desc = [
+        FlagsField("flags", None, 8, ["N", "L", "E", "V", "I", "", "", ""]),
+        BitField("nonce/map_version", 0, size=24),
+        IntField("instance_id/locator_status_bits", 0)]
+
+
+class LispInnerIP(IP):
+    """Scapy inner LISP layer for IPv4-in-IPv4."""
+    name = "Lisp Inner Layer - IPv4"
+
+
+class LispInnerIPv6(IPv6):
+    """Scapy inner LISP layer for IPv6-in-IPv6."""
+    name = "Lisp Inner Layer - IPv6"
+
+
+def valid_ipv4(ip):
+    try:
+        ipaddress.IPv4Address(unicode(ip))
+        return True
+    except (AttributeError, ipaddress.AddressValueError):
+        return False
+
+
+def valid_ipv6(ip):
+    try:
+        ipaddress.IPv6Address(unicode(ip))
+        return True
+    except (AttributeError, ipaddress.AddressValueError):
+        return False
+
+
+def main():
+    """Send IP ICMP packet from one traffic generator interface to the other.
+
+    :raises RuntimeError: If the received packet is not correct."""
+
+    args = TrafficScriptArg(
+        ['tg_src_mac', 'tg_dst_mac', 'src_ip', 'dst_ip', 'dut_if1_mac',
+         'dut_if2_mac', 'src_rloc', 'dst_rloc'])
+
+    tx_src_mac = args.get_arg('tg_src_mac')
+    tx_dst_mac = args.get_arg('dut_if1_mac')
+    rx_dst_mac = args.get_arg('tg_dst_mac')
+    rx_src_mac = args.get_arg('dut_if2_mac')
+    src_ip = args.get_arg('src_ip')
+    dst_ip = args.get_arg('dst_ip')
+    src_rloc = args.get_arg("src_rloc")
+    dst_rloc = args.get_arg("dst_rloc")
+    tx_if = args.get_arg('tx_if')
+    rx_if = args.get_arg('rx_if')
+
+    rxq = RxQueue(rx_if)
+    txq = TxQueue(tx_if)
+    sent_packets = []
+    pkt_raw = Ether(src=tx_src_mac, dst=tx_dst_mac)
+
+    if valid_ipv4(src_ip) and valid_ipv4(dst_ip):
+        pkt_raw /= IP(src=src_ip, dst=dst_ip)
+        pkt_raw /= ICMP()
+        ip_format = IP
+        lisp_layer = LispInnerIP
+    elif valid_ipv6(src_ip) and valid_ipv6(dst_ip):
+        pkt_raw /= IPv6(src=src_ip, dst=dst_ip)
+        pkt_raw /= ICMPv6EchoRequest()
+        ip_format = IPv6
+        lisp_layer = LispInnerIPv6
+    else:
+        raise ValueError("IP not in correct format")
+
+    bind_layers(UDP, LispHeader, dport=4341)
+    bind_layers(LispHeader, lisp_layer)
+    sent_packets.append(pkt_raw)
+    txq.send(pkt_raw)
+
+    if tx_if == rx_if:
+        ether = rxq.recv(2, ignore=sent_packets)
+    else:
+        ether = rxq.recv(2)
+
+    if ether is None:
+        raise RuntimeError("ICMP echo Rx timeout")
+
+    if rx_dst_mac == ether[Ether].dst and rx_src_mac == ether[Ether].src:
+        print("MAC addresses match.")
+    else:
+        raise RuntimeError(
+            "Matching packet unsuccessful: {0}".format(ether.__repr__()))
+
+    ip = ether.payload
+
+    if not isinstance(ip, ip_format):
+        raise RuntimeError(
+            "Not an IP packet received {0}".format(ip.__repr__()))
+
+    lisp = ether.getlayer(lisp_layer)
+    if not lisp:
+        raise RuntimeError("Lisp layer not present or parsing failed.")
+
+    # Compare data from packets
+    if src_ip == lisp.src:
+        print("Source IP matches source EID.")
+    else:
+        raise RuntimeError("Matching Src IP unsuccessful: {} != {}"
+                           .format(src_ip, lisp.src))
+
+    if dst_ip == lisp.dst:
+        print("Destination IP matches destination EID.")
+    else:
+        raise RuntimeError("Matching Dst IP unsuccessful: {} != {}"
+                           .format(dst_ip, lisp.dst))
+
+    if src_rloc == ip.src:
+        print("Source RLOC matches configuration.")
+    else:
+        raise RuntimeError("Matching Src RLOC unsuccessful: {} != {}"
+                           .format(src_rloc, ip.src))
+
+    if dst_rloc == ip.dst:
+        print("Destination RLOC matches configuration.")
+    else:
+        raise RuntimeError("Matching dst RLOC unsuccessful: {} != {}"
+                           .format(dst_rloc, ip.dst))
+
+    sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()