CSIT-32: Add Softwire lw4o6 ICMP test

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

4 files changed, 220 insertions, 1 deletions

diff --git a/resources/libraries/robot/map.robot b/resources/libraries/robot/map.robot
index 1e96061571..34a2e714c5 100644
--- a/resources/libraries/robot/map.robot
+++ b/resources/libraries/robot/map.robot
@@ -64,4 +64,49 @@
 | | ... | --src_ipv6 | ${src_ipv6} | --dst_ipv6 | ${dst_ipv6}
 | | ...
 | | Run Traffic Script On Node
-| | ... | send_ipv4_check_lw_4o6.py | ${tg_node} | ${args}
+| | ... | send_ipv4_udp_check_lw_4o6.py | ${tg_node} | ${args}
+
+| Send IPv4 ICMP and check headers for lightweight 4over6
+| | [Documentation]
+| | ... | Send ICMP request with ID to given IPv4 destination and \
+| | ... | check received packets headers (Ethernet, IPv6, IPv4, ICMP).
+| | ...
+| | ... | *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_dst_ipv4 - Destination IPv4 address. Type: string
+| | ... | - tx_src_ipv4 - Source IPv4 address. Type: string
+| | ... | - tx_icmp_id - ICMP ID. Type: integer
+| | ... | - rx_dst_mac - Expected destination MAC address. Type: string
+| | ... | - rx_src_mac - Expected source MAC address. Type: string
+| | ... | - dst_ipv6 - Expected destination IPv6 address. Type: string
+| | ... | - src_ipv6 - Expected source IPv6 address. Type: string
+| | ...
+| | ... | *Return:*
+| | ... | - No value returned
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Send IPv4 ICMP and check headers for lightweight 4over6 \
+| | ... | \| ${tg_node} \| eth3 \| eth2 \| 08:00:27:66:b8:57 \| 20.0.0.1 \
+| | ... | \| 20.0.0.2 \| 1232 \| 08:00:27:46:2b:4c \| 08:00:27:f3:be:f0 \
+| | ... | \| 2001:1::2 \| 2001:1::1 \|
+| | ...
+| | [Arguments]
+| | ... | ${tg_node} | ${tx_if} | ${rx_if} | ${tx_dst_mac} | ${tx_dst_ipv4}
+| | ... | ${tx_src_ipv4} | ${tx_icmp_id} | ${rx_dst_mac} | ${rx_src_mac}
+| | ... | ${dst_ipv6} | ${src_ipv6}
+| | ...
+| | ${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_ipv4 | ${tx_src_ipv4}
+| | ... | --tx_dst_ipv4 | ${tx_dst_ipv4} | --tx_icmp_id | ${tx_icmp_id}
+| | ... | --rx_dst_mac | ${rx_dst_mac} | --rx_src_mac | ${rx_src_mac}
+| | ... | --src_ipv6 | ${src_ipv6} | --dst_ipv6 | ${dst_ipv6}
+| | ...
+| | Run Traffic Script On Node
+| | ... | send_ipv4_icmp_check_lw_4o6.py | ${tg_node} | ${args}
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
index 0000000000..9e225428df
--- /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()
diff --git a/resources/traffic_scripts/send_ipv4_check_lw_4o6.py b/resources/traffic_scripts/send_ipv4_udp_check_lw_4o6.py
index 881abc83a2..881abc83a2 100755
--- a/resources/traffic_scripts/send_ipv4_check_lw_4o6.py
+++ b/resources/traffic_scripts/send_ipv4_udp_check_lw_4o6.py
diff --git a/tests/suites/softwire/lightweight_4over6.robot b/tests/suites/softwire/lightweight_4over6.robot
index 28fb920951..c3a4729646 100644
--- a/tests/suites/softwire/lightweight_4over6.robot
+++ b/tests/suites/softwire/lightweight_4over6.robot
@@ -55,6 +55,7 @@
 | ${test_ipv4_outside}= | 10.0.0.100
 # test_port depends on psid, length, offset
 | ${test_port}= | ${1232}
+| ${test_icmp_id}= | ${1232}
 
 *** Test Cases ***
 | TC01: Encapsulate IPv4 into IPv6. IPv6 dst depends on IPv4 and UDP destination
@@ -88,3 +89,37 @@
 | |      ... | ${dut_to_tg_if1_mac} | ${test_ipv4_inside} | ${test_ipv4_outside}
 | |      ... | ${test_port} | ${tg_to_dut_if2_mac} | ${dut_to_tg_if2_mac}
 | |      ... | ${lw_rule_ipv6_dst} | ${lw_ipv6_src}
+
+TC02: Encapsulate IPv4 ICMP into IPv6. IPv6 dst depends on IPv4 addr and ICMP ID
+| | [Documentation]
+| | ... | [Top] TG=DUT1.
+| | ... | [Enc] Eth-IPv4-ICMP(type 0 and 8) on TG_if1-DUT, Eth-IPv6-IPv4-ICMP
+| | ... |       on TG_if2_DUT.
+| | ... | [Cfg] On DUT1 configure Map domain and Map rule.
+| | ... | [Ver] Make TG send non-encapsulated ICMP to DUT; verify TG received
+| | ... |       IPv4oIPv6 encapsulated packet is correct. Checks IPv6
+| | ... |       destination based on ICMP Identifier field.
+| | ... | [Ref] RFC7596 section 8.1
+| | ...
+| | 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 IP Neighbor
+| |       ... | ${dut_node} | ${dut_to_tg_if2} | ${lw_rule_ipv6_dst}
+| |       ... | ${tg_to_dut_if2_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 ICMP and check headers for lightweight 4over6
+| |      ... | ${tg_node} | ${tg_to_dut_if1} | ${tg_to_dut_if2}
+| |      ... | ${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}