CSIT-532 HC Test: IPv6 Neighbor Discovery proxy

Change-Id: I6495726a814e116191f7a183be71c661466e7053
Signed-off-by: selias <samelias@cisco.com>

3 files changed, 394 insertions, 2 deletions

diff --git a/resources/libraries/python/honeycomb/proxyARP.py b/resources/libraries/python/honeycomb/proxyARP.py
index 78e71a75e4..90d15b1288 100644
--- a/resources/libraries/python/honeycomb/proxyARP.py
+++ b/resources/libraries/python/honeycomb/proxyARP.py
@@ -150,3 +150,83 @@ class ProxyARPKeywords(object):
         """
 
         raise NotImplementedError("Not supported in VPP.")
+
+
+class IPv6NDProxyKeywords(object):
+    """Keywords for IPv6 Neighbor Discovery proxy configuration."""
+
+    def __init__(self):
+        pass
+
+    @staticmethod
+    def configure_ipv6nd(node, interface, addresses=None):
+        """Configure IPv6 Neighbor Discovery proxy on the specified interface,
+        or remove/replace an existing configuration.
+
+        :param node: Honeycomb node.
+        :param interface: Name of an interface on the node.
+        :param addresses: IPv6 addresses to configure ND proxy with. If no
+        address is provided, ND proxy configuration will be removed.
+        :type node: dict
+        :type interface: str
+        :type addresses: list
+        :returns: Content of response.
+        :rtype: bytearray
+        :raises HoneycombError: If the operation fails.
+        """
+
+        interface = Topology.convert_interface_reference(
+            node, interface, "name")
+        interface = interface.replace("/", "%2F")
+
+        path = "/interface/{0}/ietf-ip:ipv6/nd-proxies".format(interface)
+
+        if addresses is None:
+            status_code, resp = HcUtil. \
+                delete_honeycomb_data(node, "config_vpp_interfaces", path)
+        else:
+            data = {
+                "nd-proxies": {
+                    "nd-proxy": [{"address": x} for x in addresses]
+                }
+            }
+
+            status_code, resp = HcUtil. \
+                put_honeycomb_data(node, "config_vpp_interfaces", data, path,
+                                   data_representation=DataRepresentation.JSON)
+
+        if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
+            raise HoneycombError(
+                "IPv6 ND proxy configuration unsuccessful. "
+                "Status code: {0}.".format(status_code))
+        else:
+            return resp
+
+    @staticmethod
+    def get_ipv6nd_configuration(node, interface):
+        """Read IPv6 Neighbor Discovery proxy configuration on the specified
+        interface.
+
+        :param node: Honeycomb node.
+        :param interface: Name of an interface on the node.
+        :type node: dict
+        :type interface: str
+        :returns: Content of response.
+        :rtype: bytearray
+        :raises HoneycombError: If the configuration could not be read.
+        """
+
+        interface = Topology.convert_interface_reference(
+            node, interface, "name")
+        interface = interface.replace("/", "%2F")
+
+        path = "/interface/{0}/ietf-ip:ipv6/nd-proxies".format(interface)
+
+        status_code, resp = HcUtil.get_honeycomb_data(
+            node, "config_vpp_interfaces", path)
+        if status_code != HTTPCodes.OK:
+            raise HoneycombError(
+                "Could not read IPv6 ND proxy configuration. "
+                "Status code: {0}.".format(status_code))
+        else:
+            return resp
diff --git a/resources/libraries/robot/honeycomb/proxyarp.robot b/resources/libraries/robot/honeycomb/proxyarp.robot
index 377c956760..b9e9b81215 100644
--- a/resources/libraries/robot/honeycomb/proxyarp.robot
+++ b/resources/libraries/robot/honeycomb/proxyarp.robot
@@ -12,8 +12,8 @@
 # limitations under the License.
 
 *** Settings ***
-| Library | resources.libraries.python.honeycomb.proxyARP.ProxyARPKeywords
-| Documentation | Keywords used to test Honeycomb proxyARP.
+| Library | resources.libraries.python.honeycomb.proxyARP.IPv6NDProxyKeywords
+| Documentation | Keywords used to test Honeycomb ARP proxy and IPv6ND proxy.
 
 *** Keywords ***
 | Honeycomb configures proxyARP
@@ -55,6 +55,7 @@
 | | ...
 | | ... | \| Honeycomb enables proxyARP on interface \| ${nodes['DUT1']} \
 | | ... | \| GigabitEthernet0/8/0 \|
+| | ...
 | | [Arguments] | ${node} | ${interface}
 | | Set proxyARP interface config | ${node} | ${interface} | enable
 
@@ -72,3 +73,120 @@
 | | ... | \| GigabitEthernet0/8/0 \|
 | | [Arguments] | ${node} | ${interface}
 | | Set proxyARP interface config | ${node} | ${interface} | disable
+
+| Honeycomb configures IPv6 ND proxy on interface
+| | [Documentation] | Uses Honeycomb API to enable the IPv6 ND proxy\
+| | ... | feature on an interface.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the node. Type: string
+| | ... | - addresses - one or more addresses to configure ND proxy with.\
+| | ... | Type: string
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb configures IPv6 ND proxy on interface \
+| | ... | \| ${nodes['DUT1']} \| GigabitEthernet0/8/0 \| 10::10 \| 10::11 \|
+| | ...
+| | [Arguments] | ${node} | ${interface} | @{addresses}
+| | Configure IPv6ND | ${node} | ${interface} | ${addresses}
+
+| Honeycomb disables IPv6 ND proxy on interface
+| | [Documentation] | Uses Honeycomb API to disable the IPv6 ND proxy\
+| | ... | feature on an interface.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the node. Type: string
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb disables IPv6 ND proxy on interface \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \|
+| | [Arguments] | ${node} | ${interface}
+| | Configure IPv6ND | ${node} | ${interface}
+
+| IPv6 ND proxy from Honeycomb should be
+| | [Documentation] | Retrieves IPv6 ND proxy operational data and compares\
+| | ... | with expected values.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the node. Type: string
+| | ... | - addresses - one or more addresses to expect. Type: string
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| IPv6 ND proxy from Honeycomb should be \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \| 10::10 \| 10::11 \|
+| | ...
+| | [Arguments] | ${node} | ${interface} | @{addresses}
+| | ${oper_data}= | Get interface oper data | ${node} | ${interface}
+| | ${oper_data}= | Set Variable
+| | ... | ${oper_data['ietf-ip:ipv6']['nd-proxy:nd-proxies']['nd-proxy']}
+| | ${data}= | Evaluate | [{"address":x} for x in $addresses]
+| | Sort List | ${oper_data}
+| | Sort List | ${data}
+| | Should be equal | ${oper_data} | ${data}
+
+| IPv6 ND proxy from Honeycomb should be empty
+| | [Documentation] | Retrieves IPv6 ND proxy operational data and expects\
+| | ... | to fail due to no data present.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - interface - name of an interface on the node. Type: string
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \|IPv6 ND proxy from Honeycomb should be empty \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \|
+| | ...
+| | [Arguments] | ${node} | ${interface}
+| | ${oper_data}= | Get interface oper data | ${node} | ${interface}
+| | Variable Should Not Exist
+| | ... | ${oper_data['ietf-ip:ipv6']['nd-proxy:nd-proxies']['nd-proxy']}
+
+| Verify IPv6ND Proxy
+| | [Documentation] | Send and receive ICMPv6 messages between TG interfaces
+| | ... | through Neighbor Discovery proxy.
+| | ...
+| | ... | *Arguments:*
+| | ... | - tg_node - TG node. Type: dictionary
+| | ... | - tg_interface1 - TG interface. Type: string
+| | ... | - tg_interface2 - TG interface. Type: string
+| | ... | - src_ip - Source IPv6 address to use. Type: string
+| | ... | - dst_ip - Destination IPv6 address to use. Type: string
+| | ... | - src_mac - MAC address of source interface. Type: string
+| | ... | - dst_mac - MAC address of destination interface. Type: string
+| | ... | - proxy_to_src_mac - MAC address of DUT interface on link to source\
+| | ... | TG interface. Type: string
+| | ... | - proxy_to_dst_mac - MAC address of DUT interface on link to dest\
+| | ... | TG interface. Type: string
+| | ...
+| | ... | *Return:*
+| | ... | - No value returned.
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Verify IPv6ND Proxy \| ${nodes['TG']} \
+| | ... | \| eth3 \| eth4 \| 3ffe:62::1 \| 3ffe:63::2 \
+| | ... | \| 08:00:27:cc:4f:54 \| 08:00:27:64:18:d2 \
+| | ... | \| 08:00:27:c9:6a:d5 \| 08:00:27:c4:75:3a \|
+| | ...
+| | [Arguments] | ${tg_node} | ${tg_interface1} | ${tg_interface2}
+| | ... | ${src_ip} | ${dst_ip} | ${src_mac} | ${dst_mac}
+| | ... | ${proxy_to_src_mac} | ${proxy_to_dst_mac}
+| | ${tg_interface_name1}= | Get interface name | ${tg_node} | ${tg_interface1}
+| | ${tg_interface_name2}= | Get interface name | ${tg_node} | ${tg_interface2}
+| | ${args}= | Catenate | --tx_if | ${tg_interface_name1}
+| | ...                 | --rx_if | ${tg_interface_name2}
+| | ...                 | --src_ip | ${src_ip}
+| | ...                 | --dst_ip | ${dst_ip}
+| | ...                 | --src_mac | ${src_mac}
+| | ...                 | --dst_mac | ${dst_mac}
+| | ...                 | --proxy_to_src_mac | ${proxy_to_src_mac}
+| | ...                 | --proxy_to_dst_mac | ${proxy_to_dst_mac}
+| | Run Traffic Script On Node | ipv6_nd_proxy_check.py
+| | ... | ${tg_node} | ${args}
diff --git a/resources/traffic_scripts/ipv6_nd_proxy_check.py b/resources/traffic_scripts/ipv6_nd_proxy_check.py
new file mode 100755
index 0000000000..b1028028b0
--- /dev/null
+++ b/resources/traffic_scripts/ipv6_nd_proxy_check.py
@@ -0,0 +1,194 @@
+#!/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 DHCPv6 proxy packets."""
+
+from scapy.layers.inet import Ether
+from scapy.layers.inet6 import IPv6, ICMPv6EchoRequest, ICMPv6EchoReply,\
+    ICMPv6ND_NS
+
+from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
+from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
+
+
+def imcpv6nd_solicit(tx_if, src_mac, dst_mac, src_ip, dst_ip):
+    """Send ICMPv6 Neighbor Solicitation packet and expect a response
+     from the proxy.
+
+    :param tx_if: Interface on TG.
+    :param src_mac: MAC address of TG interface.
+    :param dst_mac: MAC address of proxy interface.
+    :param src_ip: IP address of TG interface.
+    :param dst_ip: IP address of proxied interface.
+    :type tx_if: str
+    :type src_mac: str
+    :type dst_mac: str
+    :type src_ip: str
+    :type dst_ip: str
+    :raises RuntimeError: If the received packet is not correct.
+    """
+
+    rxq = RxQueue(tx_if)
+    txq = TxQueue(tx_if)
+
+    sent_packets = []
+
+    icmpv6nd_solicit_pkt =\
+        Ether(src=src_mac, dst=dst_mac) / \
+        IPv6(src=src_ip) / \
+        ICMPv6ND_NS(tgt=dst_ip)
+
+    sent_packets.append(icmpv6nd_solicit_pkt)
+    txq.send(icmpv6nd_solicit_pkt)
+
+    ether = None
+    for _ in range(5):
+        pkt = rxq.recv(3, ignore=sent_packets)
+        if pkt is not None:
+            ether = pkt
+            break
+
+    if ether is None:
+        raise RuntimeError('ICMPv6ND Proxy response timeout.')
+
+    if ether.src != dst_mac:
+        raise RuntimeError("Source MAC address error: {} != {}".format(
+            ether.src, dst_mac))
+    print "Source MAC address: OK."
+
+    if ether.dst != src_mac:
+        raise RuntimeError("Destination MAC address error: {} != {}".format(
+            ether.dst, src_mac))
+    print "Destination MAC address: OK."
+
+    if ether['IPv6'].src != dst_ip:
+        raise RuntimeError("Source IP address error: {} != {}".format(
+            ether['IPv6'].src, dst_ip))
+    print "Source IP address: OK."
+
+    if ether['IPv6'].dst != src_ip:
+        raise RuntimeError("Destination IP address error: {} != {}".format(
+            ether['IPv6'].dst, src_ip))
+    print "Destination IP address: OK."
+
+    try:
+        target_addr = ether['IPv6']\
+            ['ICMPv6 Neighbor Discovery - Neighbor Advertisement'].tgt
+    except (KeyError, AttributeError):
+        raise RuntimeError("Not an ICMPv6ND Neighbor Advertisement packet.")
+
+    if target_addr != dst_ip:
+        raise RuntimeError("ICMPv6 field 'Target address' error:"
+                           " {} != {}".format(target_addr, dst_ip))
+    print "Target address field: OK."
+
+
+def ipv6_ping(src_if, dst_if, src_mac, dst_mac,
+              proxy_to_src_mac, proxy_to_dst_mac, src_ip, dst_ip):
+    """Sends ICMPv6 Echo Request, receive it and send a reply.
+
+    :param src_if: First TG interface on link to DUT.
+    :param dst_if: Second TG interface on link to DUT.
+    :param src_mac: MAC address of first interface.
+    :param dst_mac: MAC address of second interface.
+    :param proxy_to_src_mac: MAC address of first proxy interface on DUT.
+    :param proxy_to_dst_mac: MAC address of second proxy interface on DUT.
+    :param src_ip: IP address of first interface.
+    :param dst_ip: IP address of second interface.
+    :type src_if: str
+    :type dst_if: str
+    :type src_mac: str
+    :type dst_mac: str
+    :type proxy_to_src_mac: str
+    :type proxy_to_dst_mac: str
+    :type src_ip: str
+    :type dst_ip: str
+    :raises RuntimeError: If a received packet is not correct.
+    """
+    rxq = RxQueue(dst_if)
+    txq = TxQueue(src_if)
+
+    icmpv6_ping_pkt = \
+        Ether(src=src_mac, dst=proxy_to_src_mac) / \
+        IPv6(src=src_ip, dst=dst_ip) / \
+        ICMPv6EchoRequest()
+
+    txq.send(icmpv6_ping_pkt)
+
+    ether = None
+    for _ in range(5):
+        pkt = rxq.recv(3)
+        if pkt is not None:
+            ether = pkt
+            break
+
+    if ether is None:
+        raise RuntimeError('ICMPv6 Echo Request timeout.')
+    try:
+        ether["IPv6"]["ICMPv6 Echo Request"]
+    except KeyError:
+        raise RuntimeError("Received packet is not an ICMPv6 Echo Request.")
+    print "ICMP Echo: OK."
+
+    rxq = RxQueue(src_if)
+    txq = TxQueue(dst_if)
+
+    icmpv6_ping_pkt = \
+        Ether(src=dst_mac, dst=proxy_to_dst_mac) / \
+        IPv6(src=dst_ip, dst=src_ip) / \
+        ICMPv6EchoReply()
+
+    txq.send(icmpv6_ping_pkt)
+
+    ether = None
+    for _ in range(5):
+        pkt = rxq.recv(3)
+        if pkt is not None:
+            ether = pkt
+            break
+
+    if ether is None:
+        raise RuntimeError('DHCPv6 SOLICIT timeout')
+    try:
+        ether["IPv6"]["ICMPv6 Echo Reply"]
+    except KeyError:
+        raise RuntimeError("Received packet is not an ICMPv6 Echo Reply.")
+
+    print "ICMP Reply: OK."
+
+
+def main():
+    """Send DHCPv6 proxy messages."""
+
+    args = TrafficScriptArg(['src_ip', 'dst_ip', 'src_mac', 'dst_mac',
+                             'proxy_to_src_mac', 'proxy_to_dst_mac'])
+
+    src_if = args.get_arg('tx_if')
+    dst_if = args.get_arg('rx_if')
+    src_ip = args.get_arg("src_ip")
+    dst_ip = args.get_arg("dst_ip")
+    src_mac = args.get_arg('src_mac')
+    dst_mac = args.get_arg('dst_mac')
+    proxy_to_src_mac = args.get_arg('proxy_to_src_mac')
+    proxy_to_dst_mac = args.get_arg('proxy_to_dst_mac')
+
+    # Neighbor solicitation
+    imcpv6nd_solicit(src_if, src_mac, proxy_to_src_mac, src_ip, dst_ip)
+
+    # Verify route (ICMP echo/reply)
+    ipv6_ping(src_if, dst_if, src_mac, dst_mac,
+              proxy_to_src_mac, proxy_to_dst_mac, src_ip, dst_ip)
+
+if __name__ == "__main__":
+    main()