CSIT-353: Add basic map-t tests

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

5 files changed, 386 insertions, 3 deletions

diff --git a/resources/libraries/python/Map.py b/resources/libraries/python/Map.py
index b98d488e73..a1db3a8461 100644
--- a/resources/libraries/python/Map.py
+++ b/resources/libraries/python/Map.py
@@ -24,7 +24,7 @@ class Map(object):
 
     @staticmethod
     def map_add_domain(vpp_node, ip4_pfx, ip6_pfx, ip6_src, ea_bits_len,
-                       psid_offset, psid_len):
+                       psid_offset, psid_len, map_t=False):
         """Add map domain on node.
 
         :param vpp_node: VPP node to add map domain on.
@@ -34,6 +34,8 @@ class Map(object):
         :param ea_bits_len: Embedded Address bits length.
         :param psid_offset: Port Set Identifier (PSID) offset.
         :param psid_len: Port Set Identifier (PSID) length.
+        :param map_t: Mapping using translation instead of encapsulation.
+        Default False.
         :type vpp_node: dict
         :type ip4_pfx: str
         :type ip6_pfx: str
@@ -41,17 +43,21 @@ class Map(object):
         :type ea_bits_len: int
         :type psid_offset: int
         :type psid_len: int
+        :type map_t: bool
         :return: Index of created map domain.
         :rtype: int
         :raises RuntimeError: If unable to add map domain.
         """
+        translate = 'map-t' if map_t else ''
+
         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)
+                                               psid_len=psid_len,
+                                               map_t=translate)
         if output[0]["retval"] == 0:
             return output[0]["index"]
         else:
@@ -261,3 +267,22 @@ class Map(object):
         address |= interface_id  # add Interface ID bits
 
         return str(ipaddress.ip_address(address))
+
+    @staticmethod
+    def compute_ipv6_map_source_address(ipv6_pfx, ipv4_src):
+        """Compute IPv6 source address from IPv4 address for MAP-T algorithm.
+
+        :param ipv6_pfx: 96 bit long IPv6 prefix.
+        :param ipv4_src: IPv4 source address
+        :type ipv6_pfx: str
+        :type ipv4_src: str
+        :return: IPv6 address, combination of IPv6 prefix and IPv4 address.
+        :rtype: str
+        """
+        ipv6_net = ipaddress.ip_network(unicode(ipv6_pfx))
+        ipv4_host = ipaddress.ip_address(unicode(ipv4_src))
+
+        address = ipv6_net.network_address._ip
+        address |= ipv4_host._ip
+
+        return str(ipaddress.ip_address(address))
diff --git a/resources/libraries/robot/map.robot b/resources/libraries/robot/map.robot
index 7462befa41..fc7744e361 100644
--- a/resources/libraries/robot/map.robot
+++ b/resources/libraries/robot/map.robot
@@ -216,3 +216,96 @@
 | | ...
 | | Run Traffic Script On Node
 | | ... | send_lw_4o6_check_hairpinning_udp.py | ${tg_node} | ${args}
+
+| Send IPv4 UDP and check IPv6 headers for MAP-T
+| | [Documentation]
+| | ... | Send a UDP in IPv4 and check if IPv4 source and destination \
+| | ... | addresses are correctly translated into IPv6 addresses.
+| | ...
+| | ... | *Arguments:*
+| | ... | - tg_node - Node where to run traffic script. Type: string
+| | ... | - tx_if - Interface from where to send IPv4 UDP packet. Type: string
+| | ... | - rx_if - Interface where to receive IPv6 UDP 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 IPv6 headers for MAP-T \
+| | ... | \| ${tg_node} \| port3 \| port3 \| 08:00:27:66:b8:57 \
+| | ... | \| 20.169.201.219 \| 100.0.0.1 \| ${1232} \| 08:00:27:46:2b:4c \
+| | ... | \| 08:00:27:f3:be:f0 \| 2001:db8::14a9:c9db:0 \
+| | ... | \| 2001:db8:ffff::6400: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}
+| | ... | --rx_src_ipv6 | ${src_ipv6} | --rx_dst_ipv6 | ${dst_ipv6}
+| | ...
+| | Run Traffic Script On Node
+| | ... | send_ipv4_udp_check_map_t.py | ${tg_node} | ${args}
+
+| Send IPv6 UDP and check IPv4 headers for MAP-T
+| | [Documentation]
+| | ... | Send a UDP in IPv6 and check if IPv6 source and destination \
+| | ... | addresses are correctly translated into IPv4 addresses.
+| | ...
+| | ... | *Arguments:*
+| | ... | - tg_node - Node where to run traffic script. Type: string
+| | ... | - tx_if - Interface from where to send IPv4 UDP packet. Type: string
+| | ... | - rx_if - Interface where to receive IPv6 UDP packet. Type: string
+| | ... | - tx_dst_mac - Destination MAC address of IPv4 packet. Type: string
+| | ... | - tx_dst_ipv6 - Destination IPv6 address. Type: string
+| | ... | - tx_src_ipv6 - Source IPv6 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
+| | ... | - dst_ipv4 - Expected destination IPv4 address. Type: string
+| | ... | - src_ipv4 - Expected source IPv4 address. Type: string
+| | ...
+| | ... | *Return:*
+| | ... | - No value returned
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Send IPv6 UDP and check IPv4 headers for MAP-T \
+| | ... | \| port3 \| port4 \| 08:00:27:f3:be:f0 \| 2001:db8:ffff::6400:1 \
+| | ... | \| 2001:db8::14a9:c9db:0 \| ${1232} \| 08:00:27:58:71:eb \
+| | ... | \| 08:00:27:66:b8:57 \| 100.0.0.1 \| 20.169.201.219 \|
+| | ...
+| | [Arguments]
+| | ... | ${tg_node} | ${tx_if} | ${rx_if}
+| | ... | ${tx_dst_mac} | ${tx_dst_ipv6} | ${tx_src_ipv6} | ${tx_src_udp_port}
+| | ... | ${rx_dst_mac} | ${rx_src_mac} | ${dst_ipv4} | ${src_ipv4}
+| | ...
+| | ${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_ipv6 | ${tx_src_ipv6} | --tx_dst_ipv6 | ${tx_dst_ipv6}
+| | ... | --tx_src_udp_port | ${tx_src_udp_port}
+| | ... | --rx_dst_mac | ${rx_dst_mac} | --rx_src_mac | ${rx_src_mac}
+| | ... | --rx_src_ipv4 | ${src_ipv4} | --rx_dst_ipv4 | ${dst_ipv4}
+| | ...
+| | Run Traffic Script On Node
+| | ... | send_ipv6_udp_check_map_t.py | ${tg_node} | ${args}
diff --git a/resources/templates/vat/map_add_domain.vat b/resources/templates/vat/map_add_domain.vat
index f5996294ee..4895f04794 100644
--- a/resources/templates/vat/map_add_domain.vat
+++ b/resources/templates/vat/map_add_domain.vat
@@ -1 +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
+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} {map_t}
\ No newline at end of file
diff --git a/resources/traffic_scripts/send_ipv4_udp_check_map_t.py b/resources/traffic_scripts/send_ipv4_udp_check_map_t.py
new file mode 100755
index 0000000000..835f667751
--- /dev/null
+++ b/resources/traffic_scripts/send_ipv4_udp_check_map_t.py
@@ -0,0 +1,132 @@
+#!/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 a UDP datagram and checks if IPv4 addresses
+are correctly translate to IPv6 addresses."""
+
+import sys
+
+from scapy.layers.l2 import Ether
+from scapy.layers.inet import IP, UDP
+from ipaddress import ip_address
+
+from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
+from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
+
+
+def _check_udp_checksum(pkt):
+    """Check UDP checksum in IP packet. Return True if checksum is correct
+    else False."""
+    new = pkt.__class__(str(pkt))
+    del new['UDP'].chksum
+    new = new.__class__(str(new))
+    return new['UDP'].chksum == pkt['UDP'].chksum
+
+
+def _is_udp_in_ipv6(pkt):
+    """If IPv6 next header type in the given pkt is UDP, 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 == 17:  # UDP
+                return True
+    except AttributeError:
+        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',
+                             'rx_src_ipv6', 'rx_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('rx_src_ipv6')
+    rx_dst_ipv6 = args.get_arg('rx_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) /
+           'udp_payload')
+
+    txq.send(udp)
+    sent_packets.append(udp)
+
+    for _ in range(5):
+        pkt = rxq.recv(2)
+        if _is_udp_in_ipv6(pkt):
+            ether = pkt
+            break
+    else:
+        raise RuntimeError("UDP 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 ip_address(unicode(ipv6.dst)) != ip_address(unicode(rx_dst_ipv6)):
+        raise RuntimeError("Destination IP error {} != {}.".
+                           format(ipv6.dst, rx_dst_ipv6))
+    print "Destination IPv6: OK."
+
+    if ip_address(unicode(ipv6.src)) != ip_address(unicode(rx_src_ipv6)):
+        raise RuntimeError("Source IP error {} != {}.".
+                           format(ipv6.src, rx_src_ipv6))
+    print "Source IPv6: OK."
+
+    udp = ipv6.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."
+
+    if not _check_udp_checksum(ipv6):
+        raise RuntimeError("UDP checksum error.")
+    print "UDP checksum OK."
+
+    sys.exit(0)
+
+if __name__ == "__main__":
+    main()
diff --git a/resources/traffic_scripts/send_ipv6_udp_check_map_t.py b/resources/traffic_scripts/send_ipv6_udp_check_map_t.py
new file mode 100755
index 0000000000..af117c19be
--- /dev/null
+++ b/resources/traffic_scripts/send_ipv6_udp_check_map_t.py
@@ -0,0 +1,133 @@
+#!/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 IPv6 addresses
+are correctly translate to IPv4 addresses."""
+
+import sys
+
+from scapy.layers.l2 import Ether
+from scapy.layers.inet6 import IPv6, UDP
+from ipaddress import ip_address
+
+from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
+from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
+
+
+def _check_udp_checksum(pkt):
+    """Check UDP checksum in IP packet. Return True if checksum is correct
+    else False."""
+    new = pkt.__class__(str(pkt))
+    del new['UDP'].chksum
+    new = new.__class__(str(new))
+    return new['UDP'].chksum == pkt['UDP'].chksum
+
+
+def _is_udp_in_ipv4(pkt):
+    """If IPv4 protocol type in the given pkt is UDP, 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 AttributeError:
+        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_ipv6', 'tx_dst_ipv6',
+                             'tx_src_udp_port', 'rx_dst_mac', 'rx_src_mac',
+                             'rx_src_ipv4', 'rx_dst_ipv4'])
+    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_ipv6 = args.get_arg('tx_src_ipv6')
+    tx_dst_ipv6 = args.get_arg('tx_dst_ipv6')
+    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')
+    rx_src_ipv4 = args.get_arg('rx_src_ipv4')
+    rx_dst_ipv4 = args.get_arg('rx_dst_ipv4')
+
+    rxq = RxQueue(rx_if)
+    txq = TxQueue(tx_if)
+    sent_packets = []
+
+    # Create empty UDP datagram in IPv6
+
+    udp = (Ether(dst=tx_dst_mac) /
+           IPv6(src=tx_src_ipv6, dst=tx_dst_ipv6) /
+           UDP(sport=tx_src_udp_port, dport=tx_dst_udp_port) /
+           'udp_payload')
+
+    txq.send(udp)
+    sent_packets.append(udp)
+
+    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 ip_address(unicode(ipv4.dst)) != ip_address(unicode(rx_dst_ipv4)):
+        raise RuntimeError("Destination IPv4 error {} != {}.".
+                           format(ipv4.dst, rx_dst_ipv4))
+    print "Destination IPv4: OK."
+
+    if ip_address(unicode(ipv4.src)) != ip_address(unicode(rx_src_ipv4)):
+        raise RuntimeError("Source IPv4 error {} != {}.".
+                           format(ipv4.src, rx_src_ipv4))
+    print "Source IPv4: 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."
+
+    if not _check_udp_checksum(ipv4):
+        raise RuntimeError("UDP checksum error.")
+    print "UDP checksum OK."
+
+    sys.exit(0)
+
+if __name__ == "__main__":
+    main()