Sample test suite for vpp sample plugin (macswap)

JIRA: CSIT-123

Change-Id: I4774ddf3a2f67c322fe27e5f9d366f508156e70f
Signed-off-by: Miroslav Miklus <mmiklus@cisco.com>

5 files changed, 195 insertions, 0 deletions

diff --git a/resources/libraries/python/MacSwap.py b/resources/libraries/python/MacSwap.py
new file mode 100644
index 0000000000..30281ba5a3
--- /dev/null
+++ b/resources/libraries/python/MacSwap.py
@@ -0,0 +1,63 @@
+# 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.
+
+"""Macswap sample_plugin util library"""
+
+from resources.libraries.python.topology import NodeType, Topology
+from resources.libraries.python.VatExecutor import VatExecutor
+
+class MacSwap(object):
+    """Macswap sample plugin API"""
+
+    @staticmethod
+    def enable_disable_macswap_vat(node, interface):
+        """Enable/Disable macswap on interface.
+
+        Function can be used on a VPP node with macswap plugin.
+
+        :param node: Node where the interface is.
+        :param interface: Interface id.
+        :type node: dict
+        :type interface: str or int
+        :return: nothing
+        """
+        if node['type'] == NodeType.DUT:
+            sw_if_index = Topology.get_interface_sw_index(node, interface)
+
+            VatExecutor.cmd_from_template(node, 'macswap.vat',
+                                          sw_if_index=sw_if_index)
+        else:
+            raise ValueError('Node {} has not DUT NodeType: "{}"'.
+                             format(node['host'], node['type']))
+
+    @staticmethod
+    def enable_disable_macswap_vat_exec(node, interface_name):
+        """Enable/Disable macswap on interface.
+
+        Function can be used on a VPP node with macswap plugin.
+
+        :param node: Node where the interface is.
+        :param interface_name: Interface name.
+        :type node: dict
+        :type interface_name: str or int
+        :return: nothing
+        """
+        if node['type'] == NodeType.DUT:
+
+            VatExecutor.cmd_from_template(node, 'macswap_exec.vat',
+                                          if_name=interface_name)
+        else:
+            raise ValueError('Node {} has not DUT NodeType: "{}"'.
+                             format(node['host'], node['type']))
+
+
diff --git a/resources/templates/vat/macswap.vat b/resources/templates/vat/macswap.vat
new file mode 100644
index 0000000000..39a6bc5ec3
--- /dev/null
+++ b/resources/templates/vat/macswap.vat
@@ -0,0 +1 @@
+sample_macswap_enable_disable sw_if_index {sw_if_index}
diff --git a/resources/templates/vat/macswap_exec.vat b/resources/templates/vat/macswap_exec.vat
new file mode 100644
index 0000000000..7b12cc6365
--- /dev/null
+++ b/resources/templates/vat/macswap_exec.vat
@@ -0,0 +1 @@
+exec sample macswap {if_name}
diff --git a/resources/traffic_scripts/macswap_check.py b/resources/traffic_scripts/macswap_check.py
new file mode 100755
index 0000000000..402bb7bac1
--- /dev/null
+++ b/resources/traffic_scripts/macswap_check.py
@@ -0,0 +1,66 @@
+#!/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.
+
+"""Macswap test."""
+
+from scapy.all import Ether, IP
+
+from resources.libraries.python.PacketVerifier import RxQueue, TxQueue
+from resources.libraries.python.TrafficScriptArg import TrafficScriptArg
+
+def check_macswap(pkt_send, pkt_recv):
+    """Compare MAC addresses of sent and received packet.
+
+    :param pkt_send: Sent packet.
+    :param pkt_recv: Received packet.
+    :type pkt_send: Ether
+    :type pkt_recv: Ether
+    """
+    print "Comparing following packets:"
+    pkt_send.show2()
+    pkt_recv.show2()
+
+    if pkt_send.dst != pkt_recv.src or pkt_send.src != pkt_recv.dst:
+        raise RuntimeError("MAC addresses were not swapped.")
+
+
+def main():
+    """Main function."""
+    args = TrafficScriptArg(['src_mac', 'dst_mac', 'src_ip', 'dst_ip'])
+
+    rxq = RxQueue(args.get_arg('rx_if'))
+    txq = TxQueue(args.get_arg('tx_if'))
+
+    src_mac = args.get_arg('src_mac')
+    dst_mac = args.get_arg('dst_mac')
+    src_ip = args.get_arg('src_ip')
+    dst_ip = args.get_arg('dst_ip')
+
+    pkt_send = (Ether(src=src_mac, dst=dst_mac) /
+                    IP(src=src_ip, dst=dst_ip, proto=61))
+
+    sent_packets = []
+    sent_packets.append(pkt_send)
+    txq.send(pkt_send)
+
+    pkt_recv = rxq.recv(ignore=sent_packets)
+
+    if pkt_recv is None:
+        raise RuntimeError('Timeout waiting for packet')
+
+    check_macswap(pkt_send, pkt_recv)
+
+if __name__ == "__main__":
+    main()
diff --git a/sample_tests/sample_suite.robot b/sample_tests/sample_suite.robot
new file mode 100644
index 0000000000..4f7a1402d5
--- /dev/null
+++ b/sample_tests/sample_suite.robot
@@ -0,0 +1,64 @@
+# 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 ***
+| Library | resources.libraries.python.NodePath
+| Library | resources.libraries.python.Trace
+| Library | resources.libraries.python.TrafficScriptExecutor
+| Library | resources.libraries.python.MacSwap
+| Library | resources.libraries.python.SetupFramework
+| Resource | resources/libraries/robot/default.robot
+| Resource | resources/libraries/robot/interfaces.robot
+| Resource | resources/libraries/robot/counters.robot
+| Suite Setup | Run Keywords | Setup Framework | ${nodes}
+| ...         | AND          | Setup All DUTs | ${nodes}
+| ...         | AND          | Setup all TGs before traffic script
+| ...         | AND          | Update All Interface Data On All Nodes | ${nodes}
+| ...         | AND          | Setup nodes for macswap testing
+| Test Setup | Clear interface counters on all vpp nodes in topology | ${nodes}
+| Test Teardown | Show Packet Trace on All DUTs | ${nodes}
+| Documentation | *MacSwap test suite.*
+| ...
+| ... | Test suite uses 3-node topology TG - DUT1 - DUT2 - TG with single link
+| ... | between nodes. From this topology only TG and DUT1 nodes are used.
+| ... | Test packet is sent from single interface on TG and test wait for
+| ... | response on the same TG interface.
+
+*** Keywords ***
+| Setup nodes for macswap testing
+| | Append Nodes | ${nodes['TG']} | ${nodes['DUT1']}
+| | Compute Path
+| | ${tg_port} | ${tg_node}= | First Interface
+| | ${dut_port} | ${dut_node}= | Last Interface
+| | Set Suite Variable | ${tg_port}
+| | Set Suite Variable | ${tg_node}
+| | Set Suite Variable | ${dut_port}
+| | Set Suite Variable | ${dut_node}
+| | Set Interface State | ${tg_node} | ${tg_port} | up
+| | Set Interface State | ${dut_node} | ${dut_port} | up
+| | All Vpp Interfaces Ready Wait | ${nodes}
+
+| Send and verify macswap on node "${tg_node}" interface "${tg_port}"
+| | ${src_ip}= | Set Variable | 1.1.1.1
+| | ${dst_ip}= | Set Variable | 2.2.2.2
+| | ${src_mac}= | Set Variable | 01:00:00:00:00:01
+| | ${dst_mac}= | Set Variable | 01:00:00:00:00:02
+| | ${args}= | Traffic Script Gen Arg | ${tg_port} | ${tg_port} | ${src_mac}
+| |          | ...                    | ${dst_mac} | ${src_ip} | ${dst_ip}
+| | Run Traffic Script On Node | macswap_check.py | ${tg_node} | ${args}
+
+*** Test Cases ***
+| VPP macswap plugin swaps MAC addresses
+| | [Tags] | 3_NODE_SINGLE_LINK_TOPO | VM_ENV
+| | Enable Disable macswap vat exec | ${dut_node} | ${dut_port}
+| | Send and verify macswap on node "${tg_node}" interface "${tg_port}"