CSIT-528 HC Test: proxyARP test suite

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

4 files changed, 307 insertions, 0 deletions

diff --git a/resources/libraries/python/honeycomb/proxyARP.py b/resources/libraries/python/honeycomb/proxyARP.py
new file mode 100644
index 0000000000..78e71a75e4
--- /dev/null
+++ b/resources/libraries/python/honeycomb/proxyARP.py
@@ -0,0 +1,152 @@
+# Copyright (c) 2017 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.
+
+"""This module implements keywords to configure proxyARP using Honeycomb
+REST API."""
+
+from resources.libraries.python.HTTPRequest import HTTPCodes
+from resources.libraries.python.honeycomb.HoneycombSetup import HoneycombError
+from resources.libraries.python.honeycomb.HoneycombUtil \
+    import HoneycombUtil as HcUtil
+from resources.libraries.python.honeycomb.HoneycombUtil \
+    import DataRepresentation
+from resources.libraries.python.topology import Topology
+
+
+class ProxyARPKeywords(object):
+    """Implementation of keywords which make it possible to:
+    - configure proxyARP behaviour
+    - enable/disable proxyARP on individual interfaces
+    """
+
+    def __init__(self):
+        """Initializer."""
+        pass
+
+    @staticmethod
+    def configure_proxyarp(node, data):
+        """Configure the proxyARP feature and check the return code.
+
+        :param node: Honeycomb node.
+        :param data: Configuration to use.
+        :type node: dict
+        :type data: dict
+        :returns: Content of response.
+        :rtype: bytearray
+        :raises HoneycombError: If the status code in response to PUT is not
+        200 = OK or 201 = ACCEPTED.
+        """
+
+        data = {
+            "proxy-ranges": {
+                "proxy-range": [
+                    data,
+                ]
+            }
+        }
+
+        status_code, resp = HcUtil.\
+            put_honeycomb_data(node, "config_proxyarp_ranges", data,
+                               data_representation=DataRepresentation.JSON)
+
+        if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
+            raise HoneycombError(
+                "proxyARP configuration unsuccessful. "
+                "Status code: {0}.".format(status_code))
+        else:
+            return resp
+
+    @staticmethod
+    def remove_proxyarp_configuration(node):
+        """Delete the proxyARP node, removing all of its configuration.
+
+        :param node: Honeycomb node.
+        :type node: dict
+        :returns: Content of response.
+        :rtype: bytearray
+        :raises HoneycombError: If the status code in response is not 200 = OK.
+        """
+
+        status_code, resp = HcUtil. \
+            delete_honeycomb_data(node, "config_proxyarp_ranges")
+
+        if status_code != HTTPCodes.OK:
+            raise HoneycombError(
+                "proxyARP removal unsuccessful. "
+                "Status code: {0}.".format(status_code))
+        else:
+            return resp
+
+    @staticmethod
+    def get_proxyarp_operational_data(node):
+        """Retrieve proxyARP properties from Honeycomb operational data.
+        Note: The proxyARP feature has no operational data available.
+
+        :param node: Honeycomb node.
+        :type node: dict
+        :returns: proxyARP operational data.
+        :rtype: bytearray
+        """
+
+        raise NotImplementedError("Not supported in VPP.")
+
+    @staticmethod
+    def set_proxyarp_interface_config(node, interface, state):
+        """Enable or disable the proxyARP feature on the specified interface.
+
+        :param node: Honeycomb node.
+        :param interface: Name or sw_if_index of an interface on the node.
+        :param state: Desired proxyARP state: enable, disable.
+        :type node: dict
+        :type interface: str
+        :type state: str
+        :raises ValueError: If the state argument is incorrect.
+        :raises HoneycombError: If the status code in response is not
+        200 = OK or 201 = ACCEPTED.
+        """
+
+        interface = Topology.convert_interface_reference(
+            node, interface, "name")
+        interface = interface.replace("/", "%2F")
+
+        path = "/interface/{0}/proxy-arp".format(interface)
+
+        if state == "disable":
+            status_code, resp = HcUtil.delete_honeycomb_data(
+                node, "config_vpp_interfaces", path)
+        elif state == "enable":
+            data = {"proxy-arp": {}}
+            status_code, resp = HcUtil.put_honeycomb_data(
+                node, "config_vpp_interfaces", data, path)
+        else:
+            raise ValueError("State argument has to be enable or disable.")
+
+        if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
+            raise HoneycombError(
+                "Interface proxyARP configuration on node {0} was not"
+                " successful.".format(node))
+
+    @staticmethod
+    def get_proxyarp_interface_assignment(node, interface):
+        """Read the status of proxyARP feature on the specified interface.
+        Note: The proxyARP feature has no operational data available.
+
+        :param node: Honeycomb node.
+        :param interface: Name or sw_if_index of an interface on the node.
+        :type node: dict
+        :type interface: str
+        :returns: Content of response.
+        :rtype: bytearray
+        """
+
+        raise NotImplementedError("Not supported in VPP.")
diff --git a/resources/libraries/robot/honeycomb/proxyarp.robot b/resources/libraries/robot/honeycomb/proxyarp.robot
new file mode 100644
index 0000000000..377c956760
--- /dev/null
+++ b/resources/libraries/robot/honeycomb/proxyarp.robot
@@ -0,0 +1,74 @@
+# Copyright (c) 2017 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 ***
+| Library | resources.libraries.python.honeycomb.proxyARP.ProxyARPKeywords
+| Documentation | Keywords used to test Honeycomb proxyARP.
+
+*** Keywords ***
+| Honeycomb configures proxyARP
+| | [Documentation] | Uses Honeycomb API to configure proxyARP for a specific\
+| | ... | destination IP range.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - data - Configuration to use. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb configures proxyARP \| ${nodes['DUT1']} \| ${data} \|
+| | [Arguments] | ${node} | ${data}
+| | Configure proxyARP | ${node} | ${data}
+
+| Honeycomb removes proxyARP configuration
+| | [Documentation] | Uses Honeycomb API to remove existing proxyARP\
+| | ... | IP range configuration.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb removes proxyARP configuration \| ${nodes['DUT1']} \|
+| | [Arguments] | ${node}
+| | Remove proxyARP configuration | ${node}
+
+| Honeycomb enables proxyARP on interface
+| | [Documentation] | Uses Honeycomb API to enable the proxyARP\
+| | ... | 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 enables proxyARP on interface \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \|
+| | [Arguments] | ${node} | ${interface}
+| | Set proxyARP interface config | ${node} | ${interface} | enable
+
+| Honeycomb disables proxyARP on interface
+| | [Documentation] | Uses Honeycomb API to disable the proxyARP\
+| | ... | 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 proxyARP on interface \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \|
+| | [Arguments] | ${node} | ${interface}
+| | Set proxyARP interface config | ${node} | ${interface} | disable
diff --git a/resources/templates/honeycomb/config_proxyarp_ranges.url b/resources/templates/honeycomb/config_proxyarp_ranges.url
new file mode 100644
index 0000000000..9de2db6ca1
--- /dev/null
+++ b/resources/templates/honeycomb/config_proxyarp_ranges.url
@@ -0,0 +1 @@
+/restconf/config/proxy-arp:proxy-ranges
\ No newline at end of file
diff --git a/tests/func/honeycomb/mgmt-cfg-proxyarp-apihc-func.robot b/tests/func/honeycomb/mgmt-cfg-proxyarp-apihc-func.robot
new file mode 100644
index 0000000000..f63d8adce2
--- /dev/null
+++ b/tests/func/honeycomb/mgmt-cfg-proxyarp-apihc-func.robot
@@ -0,0 +1,80 @@
+# Copyright (c) 2017 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.
+
+*** Variables ***
+# Interface to run tests on.
+| ${interface}= | ${node['interfaces']['port1']['name']}
+| &{proxyarp_settings_ipv4}= | vrf-id=${0}
+| ... | low-addr=192.168.1.2 | high-addr=192.168.1.10
+| ${tg_to_dut_ip}= | 192.168.1.100
+| ${dut_to_tg_ip}= | 192.168.1.1
+| ${prefix_length}= | ${24}
+| ${test_ip}= | 192.168.1.5
+
+*** Settings ***
+| Resource | resources/libraries/robot/default.robot
+| Resource | resources/libraries/robot/honeycomb/honeycomb.robot
+| Resource | resources/libraries/robot/honeycomb/interfaces.robot
+| Resource | resources/libraries/robot/honeycomb/proxyarp.robot
+| Resource | resources/libraries/robot/testing_path.robot
+| Resource | resources/libraries/robot/ipv4.robot
+| Resource | resources/libraries/robot/traffic.robot
+| Library | resources.libraries.python.Trace
+| Suite Teardown
+| ... | Run Keyword If Any Tests Failed
+| ... | Restart Honeycomb And VPP And Clear Persisted Configuration | ${node}
+| Force Tags | honeycomb_sanity | honeycomb_test
+| Documentation | *Honeycomb proxyARP management test suite.*
+
+*** Test Cases ***
+# TODO: Add operational data and VAT dump verification if/when avaliable
+| TC01: Honeycomb can configure ipv4 proxyARP
+| | [Documentation] | Check if Honeycomb can configure the proxyARP feature.
+| | [Teardown] | Honeycomb removes proxyARP configuration | ${node}
+| | Honeycomb configures proxyARP | ${node} | ${proxyarp_settings_ipv4}
+
+| TC02: Honeycomb can enable proxyarp on an interface
+| | [Documentation] | Check if Honeycomb can enable the proxyARP feature\
+| | ... | on an interface.
+| | [Teardown] | Honeycomb disables proxyARP on interface
+| | ... | ${node} | ${interface}
+| | Honeycomb enables proxyARP on interface | ${node} | ${interface}
+
+| TC03: DUT sends ARP reply on behalf of another machine from the IP range
+| | [Documentation]
+| | ... | [Top] TG-DUT1.
+| | ... | [Ref] RFC1027.
+| | ... | [Cfg] On DUT1 configure interface IPv4 address and proxy ARP
+| | ... | for IP range, using Honeycomb API.
+| | ... | [Ver] Make TG send ARP request to DUT1 interface,
+| | ... | verify if DUT1 sends correct ARP reply on behalf of machine whose
+| | ... | IP is in the configured range.
+| | [Teardown] | Run Keywords
+| | ... | Honeycomb removes proxyARP configuration | ${node}
+| | ... | AND | Honeycomb disables proxyARP on interface
+| | ... | ${node} | ${interface}
+| | ... | AND | Honeycomb sets interface state
+| | ... | ${dut_node} | ${dut_to_tg_if1} | down
+| | ... | AND | Honeycomb removes interface ipv4 addresses
+| | ... | ${node} | ${interface}
+| | Given Path for 2-node testing is set
+| | ... | ${nodes['TG']} | ${nodes['DUT1']} | ${nodes['TG']}
+| | ${tg_to_dut_if1_name}= | Get interface name | ${tg_node} | ${tg_to_dut_if1}
+| | And Honeycomb sets interface state | ${dut_node} | ${dut_to_tg_if1} | up
+| | And Honeycomb sets interface ipv4 address with prefix | ${dut_node}
+| | ... | ${dut_to_tg_if1} | ${dut_to_tg_ip} | ${prefix_length}
+| | When Honeycomb configures proxyARP | ${dut_node} | ${proxyarp_settings_ipv4}
+| | And Honeycomb enables proxyARP on interface | ${node} | ${dut_to_tg_if1}
+| | Then Send ARP Request | ${tg_node} | ${tg_to_dut_if1_name}
+| | ...                   | ${tg_to_dut_if1_mac} | ${dut_to_tg_if1_mac}
+| | ...                   | ${tg_to_dut_ip} | ${test_ip}