CSIT-32: Add Lightweight 4over6 test.

Add keywords for configure MAP domanins and rules.
Add testcase for check encapsulation IPv4 in IPv6.

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

6 files changed, 340 insertions, 0 deletions

diff --git a/resources/libraries/python/Map.py b/resources/libraries/python/Map.py
new file mode 100644
index 0000000000..7d48c20d2e
--- /dev/null
+++ b/resources/libraries/python/Map.py
@@ -0,0 +1,83 @@
+# 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.
+
+"""Map utilities library."""
+
+
+from resources.libraries.python.VatExecutor import VatExecutor
+
+
+class Map(object):
+    """Utilities for manipulating MAP feature in VPP."""
+
+    @staticmethod
+    def map_add_domain(vpp_node, ip4_pfx, ip6_pfx, ip6_src, ea_bits_len,
+                       psid_offset, psid_len):
+        """Add map domain on node.
+
+        :param vpp_node: VPP node to add map domain on.
+        :param ip4_pfx: Rule IPv4 prefix.
+        :param ip6_pfx: Rule IPv6 prefix.
+        :param ip6_src: MAP domain IPv6 BR address / Tunnel source.
+        :param ea_bits_len: Embedded Address bits length.
+        :param psid_offset: Port Set Identifier (PSID) offset.
+        :param psid_len: Port Set Identifier (PSID) length.
+        :type vpp_node: dict
+        :type ip4_pfx: str
+        :type ip6_pfx: str
+        :type ip6_src: str
+        :type ea_bits_len: int
+        :type psid_offset: int
+        :type psid_len: int
+        :return: Index of created map domain.
+        :rtype: int
+        :raises RuntimeError: If unable to add map domain.
+        """
+        output = VatExecutor.cmd_from_template(vpp_node, "map_add_domain.vat",
+                                               ip4_pfx=ip4_pfx,
+                                               ip6_pfx=ip6_pfx,
+                                               ip6_src=ip6_src,
+                                               ea_bits_len=ea_bits_len,
+                                               psid_offset=psid_offset,
+                                               psid_len=psid_len)
+        if output[0]["retval"] == 0:
+            return output[0]["index"]
+        else:
+            raise RuntimeError('Unable to add map domain on node {}'
+                               .format(vpp_node['host']))
+
+    @staticmethod
+    def map_add_rule(vpp_node, index, psid, dst, delete=False):
+        """Add or delete map rule on node.
+
+        :param vpp_node: VPP node to add map rule on.
+        :param index: Map domain index to add rule to.
+        :param psid: Port Set Identifier.
+        :param dst: MAP CE IPv6 address.
+        :param delete: If set to True, delete rule. Default False.
+        :type vpp_node: dict
+        :type index: int
+        :type psid: int
+        :type dst: str
+        :type delete: bool
+        :raises RuntimeError: If unable to add map rule.
+        """
+        output = VatExecutor.cmd_from_template(vpp_node, "map_add_del_rule.vat",
+                                               index=index,
+                                               psid=psid,
+                                               dst=dst,
+                                               delete='del' if delete else '')
+
+        if output[0]["retval"] != 0:
+            raise RuntimeError('Unable to add map rule on node {}'
+                               .format(vpp_node['host']))
diff --git a/resources/libraries/robot/map.robot b/resources/libraries/robot/map.robot
new file mode 100644
index 0000000000..1e96061571
--- /dev/null
+++ b/resources/libraries/robot/map.robot
@@ -0,0 +1,67 @@
+# 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.
+
+*** Settings ***
+| Variables | resources/libraries/python/topology.py
+| Library | resources.libraries.python.topology.Topology
+| Library | resources.libraries.python.DUTSetup
+| Library | resources.libraries.python.TGSetup
+| Library | resources.libraries.python.Map
+| Documentation | Keywords for MAP feature in VPP.
+
+*** Keywords ***
+| Send IPv4 UDP and check headers for lightweight 4over6
+| | [Documentation]
+| | ... | Send empty UDP to given IPv4 dst and UDP port and check received \
+| | ... | packets headers (Ethernet, IPv6, IPv4, UDP).
+| | ...
+| | ... | *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_dst_udp_port - Destination UDP port. 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 UDP 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_dst_udp_port} | ${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_dst_udp_port | ${tx_dst_udp_port}
+| | ... | --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_check_lw_4o6.py | ${tg_node} | ${args}
diff --git a/resources/templates/vat/map_add_del_rule.vat b/resources/templates/vat/map_add_del_rule.vat
new file mode 100644
index 0000000000..4d82b36674
--- /dev/null
+++ b/resources/templates/vat/map_add_del_rule.vat
@@ -0,0 +1 @@
+map_add_del_rule index {index} psid {psid} dst {dst} {delete}
diff --git a/resources/templates/vat/map_add_domain.vat b/resources/templates/vat/map_add_domain.vat
new file mode 100644
index 0000000000..f5996294ee
--- /dev/null
+++ b/resources/templates/vat/map_add_domain.vat
@@ -0,0 +1 @@
+map_add_domain ip4-pfx {ip4_pfx} ip6-pfx {ip6_pfx} ip6-src {ip6_src} ea-bits-len {ea_bits_len} psid-offset {psid_offset} psid-len {psid_len}
\ No newline at end of file
diff --git a/resources/test_data/softwire/map_utils.py b/resources/test_data/softwire/map_utils.py
new file mode 100644
index 0000000000..58ef551d7a
--- /dev/null
+++ b/resources/test_data/softwire/map_utils.py
@@ -0,0 +1,53 @@
+# 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.
+
+"""Utils for MAP feature."""
+
+
+def map_port_ranges(psid, length, offset=6):
+    """Return list of port ranges for given PSID in tuple <min, max>.
+
+    :param psid: PSID.
+    :param length: PSID length.
+    :param offset: PSID offset.
+    :type psid: int
+    :type length: int
+    :type offset: int
+    :return: List of (min, max) port range tuples inclusive.
+    :rtype: list
+
+                      0                   1
+                      0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
+                     +-----------+-----------+-------+
+       Ports in      |     A     |    PSID   |   j   |
+    the CE port set  |    > 0    |           |       |
+                     +-----------+-----------+-------+
+                     |  a bits   |  k bits   |m bits |
+    """
+
+    port_field_len = 16
+    port_field_min = int('0x0000', 16)
+    port_field_max = int('0xffff', 16)
+
+    a = offset
+    k = length
+    m = port_field_len - offset - length
+    km = k + m
+    j_max = port_field_max >> a + k
+
+    port_ranges = []
+    for A in range(1, (port_field_max >> km) + 1):
+        port_ranges.append((((A << k) | psid) << m,
+                            ((A << k) | psid) << m | j_max))
+
+    return port_ranges
diff --git a/resources/traffic_scripts/send_ipv4_check_lw_4o6.py b/resources/traffic_scripts/send_ipv4_check_lw_4o6.py
new file mode 100755
index 0000000000..881abc83a2
--- /dev/null
+++ b/resources/traffic_scripts/send_ipv4_check_lw_4o6.py
@@ -0,0 +1,135 @@
+#!/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 UDP datagram and checks if IPv4 is
+correctly encapsulated into IPv6 packet."""
+
+import sys
+
+from scapy.layers.l2 import Ether
+from scapy.layers.inet import IP, UDP
+
+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_dst_udp_port', '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_dst_udp_port = int(args.get_arg('tx_dst_udp_port'))
+    tx_src_udp_port = 20000
+    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 = []
+
+    # Create empty UDP datagram
+    udp = (Ether(dst=tx_dst_mac) /
+           IP(src=tx_src_ipv4, dst=tx_dst_ipv4) /
+           UDP(sport=tx_src_udp_port, dport=tx_dst_udp_port))
+
+    txq.send(udp)
+    sent_packets.append(udp)
+
+    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."
+
+    if ipv4.proto != 17:  # UDP
+        raise RuntimeError("IP 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()