CSIT-32: Add decapsulation test

Change-Id: I7c1e3e6aa5c88acf85afdcd01de5817603abbcab
Signed-off-by: Matej Klotton <mklotton@cisco.com>

3 files changed, 208 insertions, 0 deletions

diff --git a/resources/libraries/robot/map.robot b/resources/libraries/robot/map.robot
index 34a2e714c5..ba3349415e 100644
--- a/resources/libraries/robot/map.robot
+++ b/resources/libraries/robot/map.robot
@@ -110,3 +110,51 @@
 | | ...
 | | Run Traffic Script On Node
 | | ... | send_ipv4_icmp_check_lw_4o6.py | ${tg_node} | ${args}
+
+| Send IPv4 UDP in IPv6 and check headers for lightweight 4over6
+| | [Documentation]
+| | ... | Send empty UDP in IPv4 in IPv6 and check if IPv4 packet is correctly \
+| | ... | decapsulated from IPv6.
+| | ...
+| | ... | *Arguments:*
+| | ... | - tg_node - Node where to run traffic script. Type: string
+| | ... | - tx_if - Interface from where to send ICPMv4 packet. Type: string
+| | ... | - rx_if - Interface where to receive IPinIP packet. Type: string
+| | ... | - tx_dst_mac - Destination MAC address of IPv4 packet. Type: string
+| | ... | - tx_src_mac - Source MAC address of IPv4 packet. Type: string
+| | ... | - tx_dst_ipv6 - Destination IPv6 address. Type: string
+| | ... | - tx_src_ipv6 - Source IPv6 address. Type: string
+| | ... | - tx_dst_ipv4 - Destination IPv4 address. Type: string
+| | ... | - tx_src_ipv4 - Source IPv4 address. Type: string
+| | ... | - tx_src_udp_port - Source UDP port. Type: integer
+| | ... | - rx_dst_mac - Expected destination MAC address. Type: string
+| | ... | - rx_src_mac - Expected source MAC address. Type: string
+| | ...
+| | ... | *Return:*
+| | ... | - No value returned
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Send IPv4 UDP in IPv6 and check headers for lightweight 4over6 \
+| | ... | \| ${tg_node} \| eth3 \| eth2 \
+| | ... | \| 08:00:27:66:b8:57 \| 08:00:27:33:54:21 \
+| | ... | \| 2001:1::2 \| 2001:1::1 \| 20.0.0.1 \| 20.0.0.2 \
+| | ... | \| 1232 \| 08:00:27:46:2b:4c \| 08:00:27:f3:be:f0 \|
+| | ...
+| | [Arguments]
+| | ... | ${tg_node} | ${tx_if} | ${rx_if} | ${tx_dst_mac} | ${tx_src_mac}
+| | ... | ${tx_dst_ipv6} | ${tx_src_ipv6} | ${tx_dst_ipv4} | ${tx_src_ipv4}
+| | ... | ${tx_src_udp_port} | ${rx_dst_mac} | ${rx_src_mac}
+| | ...
+| | ${tx_name}= | Get interface name | ${tg_node} | ${tx_if}
+| | ${rx_name}= | Get interface name | ${tg_node} | ${rx_if}
+| | ${args}= | Catenate
+| | ... | --tx_if | ${tx_name} | --rx_if | ${rx_name}
+| | ... | --tx_dst_mac | ${tx_dst_mac} | --tx_src_mac | ${tx_src_mac}
+| | ... | --tx_dst_ipv6 | ${tx_dst_ipv6} | --tx_src_ipv6 | ${tx_src_ipv6}
+| | ... | --tx_dst_ipv4 | ${tx_dst_ipv4} | --tx_src_ipv4 | ${tx_src_ipv4}
+| | ... | --tx_src_udp_port | ${tx_src_udp_port}
+| | ... | --rx_dst_mac | ${rx_dst_mac} | --rx_src_mac | ${rx_src_mac}
+| | ...
+| | Run Traffic Script On Node
+| | ... | send_lw_4o6_check_ipv4_udp.py | ${tg_node} | ${args}
diff --git a/resources/traffic_scripts/send_lw_4o6_check_ipv4_udp.py b/resources/traffic_scripts/send_lw_4o6_check_ipv4_udp.py
new file mode 100755
index 0000000000..fcb745a407
--- /dev/null
+++ b/resources/traffic_scripts/send_lw_4o6_check_ipv4_udp.py
@@ -0,0 +1,126 @@
+#!/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 empty IPv4 UDP datagram encapsulated in IPv6
+and checks if is correctly decapsulated."""
+
+import sys
+
+from scapy.layers.l2 import Ether
+from scapy.layers.inet6 import IPv6
+from scapy.layers.inet import IP, UDP
+
+from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
+from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
+
+
+def _is_udp_in_ipv4(pkt):
+    """If UDP is in IPv4 packet return True,
+    else return False. False is returned also if exception occurs."""
+    ipv4_type = int('0x0800', 16)  # IPv4
+    try:
+        if pkt.type == ipv4_type:
+            if pkt.payload.proto == 17:  # UDP
+                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_mac',
+                             'tx_dst_ipv6', 'tx_src_ipv6',
+                             'tx_dst_ipv4', 'tx_src_ipv4', 'tx_src_udp_port',
+                             'rx_dst_mac', 'rx_src_mac'])
+    rx_if = args.get_arg('rx_if')
+    tx_if = args.get_arg('tx_if')
+    tx_src_mac = args.get_arg('tx_src_mac')
+    tx_dst_mac = args.get_arg('tx_dst_mac')
+    tx_dst_ipv6 = args.get_arg('tx_dst_ipv6')
+    tx_src_ipv6 = args.get_arg('tx_src_ipv6')
+    tx_dst_ipv4 = args.get_arg('tx_dst_ipv4')
+    tx_src_ipv4 = args.get_arg('tx_src_ipv4')
+    tx_src_udp_port = int(args.get_arg('tx_src_udp_port'))
+    tx_dst_udp_port = 20000
+    rx_dst_mac = args.get_arg('rx_dst_mac')
+    rx_src_mac = args.get_arg('rx_src_mac')
+
+    rxq = RxQueue(rx_if)
+    txq = TxQueue(tx_if)
+    sent_packets = []
+
+    # Create empty UDP datagram in IPv4 and IPv6
+    tx_pkt = (Ether(dst=tx_dst_mac, src=tx_src_mac) /
+              IPv6(src=tx_src_ipv6, dst=tx_dst_ipv6) /
+              IP(src=tx_src_ipv4, dst=tx_dst_ipv4) /
+              UDP(sport=tx_src_udp_port, dport=tx_dst_udp_port))
+
+    txq.send(tx_pkt)
+    sent_packets.append(tx_pkt)
+
+    for _ in range(5):
+        pkt = rxq.recv(2)
+        if _is_udp_in_ipv4(pkt):
+            ether = pkt
+            break
+    else:
+        raise RuntimeError("UDP in IPv4 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."
+
+    ipv4 = ether.payload
+
+    # check ipv4
+    if ipv4.dst != tx_dst_ipv4:
+        raise RuntimeError("Destination IPv4 error {} != {}.".
+                           format(ipv4.dst, tx_dst_ipv4))
+    print "Destination IPv4: OK."
+
+    if ipv4.src != tx_src_ipv4:
+        raise RuntimeError("Source IPv4 error {} != {}.".
+                           format(ipv4.src, tx_src_ipv4))
+    print "Source IPv4: OK."
+
+    if ipv4.proto != 17:  # UDP
+        raise RuntimeError("IPv4 protocol error {} != UDP.".
+                           format(ipv4.proto))
+    print "IPv4 protocol: OK."
+
+    udp = ipv4.payload
+
+    # check udp
+    if udp.dport != tx_dst_udp_port:
+        raise RuntimeError("UDP dport error {} != {}.".
+                           format(udp.dport, tx_dst_udp_port))
+    print "UDP dport: OK."
+
+    if udp.sport != tx_src_udp_port:
+        raise RuntimeError("UDP sport error {} != {}.".
+                           format(udp.sport, tx_src_udp_port))
+    print "UDP sport: OK."
+
+    sys.exit(0)
+
+if __name__ == "__main__":
+    main()
diff --git a/tests/suites/softwire/lightweight_4over6.robot b/tests/suites/softwire/lightweight_4over6.robot
index c3a4729646..8d0ea95e94 100644
--- a/tests/suites/softwire/lightweight_4over6.robot
+++ b/tests/suites/softwire/lightweight_4over6.robot
@@ -123,3 +123,37 @@ TC02: Encapsulate IPv4 ICMP into IPv6. IPv6 dst depends on IPv4 addr and ICMP ID
 | |      ... | ${dut_to_tg_if1_mac} | ${test_ipv4_inside} | ${test_ipv4_outside}
 | |      ... | ${test_icmp_id} | ${tg_to_dut_if2_mac} | ${dut_to_tg_if2_mac}
 | |      ... | ${lw_rule_ipv6_dst} | ${lw_ipv6_src}
+
+TC03: Decapsulate IPv4 UDP from IPv6.
+| | [Documentation]
+| | ... | [Top] TG=DUT1.
+| | ... | [Enc] Eth-IPv6-IPv4-UDP on TG_if2_DUT, Eth-IPv4-UDP on TG_if1-DUT.
+| | ... | [Cfg] On DUT1 configure Map domain and Map rule.
+| | ... | [Ver] Make TG send encapsulated UDP to DUT; verify TG received
+| | ... |       IPv4 non-encapsulated packet is correct.
+| | ... | [Ref] RFC7596 RFC7597
+| | ...
+| | Given Path for 2-node testing is set
+| |       ... | ${nodes['TG']} | ${nodes['DUT1']} | ${nodes['TG']}
+| | And   Interfaces in 2-node path are up
+| | And   IP addresses are set on interfaces
+| |       ... | ${dut_node} | ${dut_to_tg_if1} | ${dut_ip4} | ${ipv4_prefix_len}
+| |       ... | ${dut_node} | ${dut_to_tg_if2} | ${dut_ip6} | ${ipv6_prefix_len}
+| | And   Add Arp on DUT
+| |       ... | ${dut_node} | ${dut_to_tg_if1}
+| |       ... | ${test_ipv4_outside}
+| |       ... | ${tg_to_dut_if1_mac}
+| | ${domain_index}=
+| | ... | When Map Add Domain
+| |            ... | ${dut_node} | ${lw_ipv4_pfx} | ${lw_ipv6_pfx}
+| |            ... | ${lw_ipv6_src} | 0 | ${lw_psid_offset}
+| |            ... | ${lw_psid_length}
+| |       And  Map Add Rule
+| |            ... | ${dut_node} | ${domain_index} | ${lw_rule_psid}
+| |            ... | ${lw_rule_ipv6_dst}
+| | Then Send IPv4 UDP in IPv6 and check headers for lightweight 4over6
+| |      ... | ${tg_node} | ${tg_to_dut_if2} | ${tg_to_dut_if1}
+| |      ... | ${dut_to_tg_if2_mac} | ${tg_to_dut_if2_mac}
+| |      ... | ${lw_ipv6_src} | ${lw_rule_ipv6_dst}
+| |      ... | ${test_ipv4_outside} | ${test_ipv4_inside} | ${test_port}
+| |      ... | ${tg_to_dut_if1_mac} | ${dut_to_tg_if1_mac}