CSIT-576 HC Test: Improve SPAN test coverage

 - add test for multiple destination interfaces using one source interface
 - duplicate all existing cases using a sub-interface as the destination

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

3 files changed, 179 insertions, 17 deletions

diff --git a/resources/libraries/python/honeycomb/HcAPIKwInterfaces.py b/resources/libraries/python/honeycomb/HcAPIKwInterfaces.py
index dc248589f9..e78696cd15 100644
--- a/resources/libraries/python/honeycomb/HcAPIKwInterfaces.py
+++ b/resources/libraries/python/honeycomb/HcAPIKwInterfaces.py
@@ -1162,6 +1162,9 @@ class InterfaceKeywords(object):
         :rtype: bytearray
         """
 
+        super_interface = Topology.convert_interface_reference(
+            node, super_interface, "name")
+
         intf_state = {"up": "true",
                       "down": "false"}
 
@@ -1706,7 +1709,7 @@ class InterfaceKeywords(object):
         :param dst_interface: Interface to mirror packets to.
         :param src_interfaces: List of interfaces to mirror packets from.
         :type node: dict
-        :type dst_interface: str
+        :type dst_interface: str or int
         :type src_interfaces: list of dict
         :returns: Content of response.
         :rtype: bytearray
@@ -1742,6 +1745,58 @@ class InterfaceKeywords(object):
                 "Configuring SPAN failed. Status code:{0}".format(status_code))
 
     @staticmethod
+    def configure_sub_interface_span(node, super_interface, dst_interface_index,
+                                     src_interfaces=None):
+        """Configure SPAN port mirroring on the specified sub-interface. If no
+         source interface is provided, SPAN will be disabled.
+
+        Note: Does not support source sub-interfaces, only destination.
+
+        :param node: Honeycomb node.
+        :param super_interface: Name, link name or sw_if_index
+        of the destination interface's super-interface.
+        :param dst_interface_index: Index of sub-interface to mirror packets to.
+        :param src_interfaces: List of interfaces to mirror packets from.
+        :type node: dict
+        :type super_interface: str or int
+        :type dst_interface_index: int
+        :type src_interfaces: list of dict
+        :returns: Content of response.
+        :rtype: bytearray
+        :raises HoneycombError: If SPAN could not be configured.
+        """
+
+        super_interface = Topology.convert_interface_reference(
+            node, super_interface, "name")
+        super_interface = super_interface.replace("/", "%2F")
+
+        path = "/interface/{0}/vpp-vlan:sub-interfaces/sub-interface/{1}/span"\
+            .format(super_interface, dst_interface_index)
+
+        if not src_interfaces:
+            status_code, _ = HcUtil.delete_honeycomb_data(
+                node, "config_vpp_interfaces", path)
+        else:
+            for src_interface in src_interfaces:
+                src_interface["iface-ref"] = Topology. \
+                    convert_interface_reference(
+                    node, src_interface["iface-ref"], "name")
+            data = {
+                "span": {
+                    "mirrored-interfaces": {
+                        "mirrored-interface": src_interfaces
+                    }
+                }
+            }
+
+            status_code, _ = HcUtil.put_honeycomb_data(
+                node, "config_vpp_interfaces", data, path)
+
+        if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
+            raise HoneycombError(
+                "Configuring SPAN failed. Status code:{0}".format(status_code))
+
+    @staticmethod
     def add_interface_local0_to_topology(node):
         """Use Topology methods to add interface "local0" to working topology,
         if not already present.
diff --git a/resources/libraries/robot/honeycomb/port_mirroring.robot b/resources/libraries/robot/honeycomb/port_mirroring.robot
index ef41c51fd3..532b5157d8 100644
--- a/resources/libraries/robot/honeycomb/port_mirroring.robot
+++ b/resources/libraries/robot/honeycomb/port_mirroring.robot
@@ -105,7 +105,7 @@
 | | Lists should be equal | ${data} | ${src_interfaces}
 
 | Honeycomb removes interface SPAN configuration
-| | [Documentation] | Uses Honeycomb API to remove SPAN confirugation\
+| | [Documentation] | Uses Honeycomb API to remove SPAN configuration\
 | | ... | from the specified interface.
 | | ...
 | | ... | *Arguments:*
@@ -120,7 +120,7 @@
 | | [Arguments] | ${node} | ${dst_interface}
 | | InterfaceAPI.Configure interface SPAN | ${node} | ${dst_interface}
 
-| Interface SPAN configuration from Honeycomb should not exist
+| Interface SPAN Operational Data from Honeycomb should not exist
 | | [Documentation] | Retrieves interface operational data and verifies that\
 | | ... | SPAN mirroring is not configured.
 | | ...
@@ -136,8 +136,8 @@
 | | Run keyword and expect error | *KeyError* | Set Variable
 | | ... | ${data['span']['mirrored-interfaces']['mirrored-interface']}
 
-| SPAN configuration from VAT should not exist
-| | [Documentation] | Attmepts to retrieve SPAN configuration from VAT dump,\
+| SPAN Operational Data from VAT should not exist
+| | [Documentation] | Attmepts to retrieve SPAN Operational Data from VAT dump,\
 | | ... | and expects to fail with no data retrieved.
 | | ...
 | | ... | *Arguments:*
@@ -145,7 +145,112 @@
 | | ...
 | | ... | *Example:*
 | | ...
-| | ... | \| SPAN configuration from VAT should not exist \| ${nodes['DUT1']} \|
+| | ... | \| SPAN Operational Data from VAT should not exist \| ${nodes['DUT1']} \|
 | | [Arguments] | ${node}
 | | Run keyword and expect error | ValueError: No JSON object could be decoded
 | | ... | VPP get SPAN configuration by interface | ${node} | local0
+
+| Honeycomb Configures SPAN on sub-interface
+| | [Documentation] | Uses Honeycomb API to configure SPAN on the specified\
+| | ... | sub-interface, mirroring one or more interfaces.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - dst_interface - Mirroring destination super-interface. Type: string
+| | ... | - index - Index of mirroring destination sub-interface. Type: integer
+| | ... | - src_interfaces - Mirroring source interfaces. Type: list \
+| | ... | of dictionaries
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb Configures SPAN on sub-interface \| ${nodes['DUT1']} \
+| | ... | \| GigabitEthernet0/8/0 \| ${1} \
+| | ... | \|[{'iface-ref': 'GigabitEthernet0/10/0', 'state': 'transmit'}, \
+| | ... | \| {'iface-ref': 'local0', 'state': 'both'}] \|
+| | ...
+| | [Arguments] | ${node} | ${dst_interface} | ${index} | @{src_interfaces}
+| | InterfaceAPI.Configure sub interface SPAN
+| | ... | ${node} | ${dst_interface} | ${index} | ${src_interfaces}
+
+| Sub-Interface SPAN Operational Data from Honeycomb should be
+| | [Documentation] | Retrieves sub-interface operational data and verifies\
+| | ... | that SPAN mirroring is configured with the provided interfaces.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - dst_interface - Mirroring destination super-interface. Type: string
+| | ... | - index - Index of mirroring destination sub-interface. Type: integer
+| | ... | - src_interfaces - Mirroring source interfaces. Type: Argument list -\
+| | ... | any number of strings
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Sub-Interface SPAN Operational Data from Honeycomb should be \
+| | ... | \| ${nodes['DUT1']} \| GigabitEthernet0/8/0 \| ${1} \
+| | ... | \| GigabitEthernet0/9/0 \|
+| | ...
+| | [Arguments] | ${node} | ${dst_interface} | ${index} | @{src_interfaces}
+| | ${data}= | InterfaceAPI.Get sub interface oper data
+| | ... | ${node} | ${dst_interface} | ${index}
+| | ${data}= | Set Variable
+| | ... | ${data['subinterface-span:span-state']['mirrored-interfaces']['mirrored-interface']}
+| | Sort list | ${data}
+| | Sort list | ${src_interfaces}
+| | Lists should be equal | ${data} | ${src_interfaces}
+
+| Sub-Interface SPAN Operational Data from Honeycomb should be empty
+| | [Documentation] | Checks whether SPAN Operational Data from Honeycomb is empty.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - Information about a DUT node. Type: dictionary
+| | ... | - dst_interface - Mirroring destination super-interface. Type: string
+| | ... | - index - Index of mirroring destination sub-interface. Type: integer
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Interface SPAN Operational Data from Honeycomb should be empty \
+| | ... | \| ${node} \| GigabitEthernetO/8/0 \| ${1} \|
+| | ...
+| | [Arguments] | ${node} | ${dst_interface} | ${index}
+| | ${data}= | Get sub interface oper data
+| | ... | ${node} | ${dst_interface} | ${index}
+| | Variable should not exist
+| | ... | ${data['subinterface-span:span-state']['mirrored-interfaces']['mirrored-interface']}
+
+| Honeycomb removes sub-interface SPAN configuration
+| | [Documentation] | Uses Honeycomb API to remove SPAN Operational Data\
+| | ... | from the specified sub-interface.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - dst_interface - Mirroring destination super-interface. Type: string
+| | ... | - index - Index of mirroring destination sub-interface. Type: integer
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Honeycomb removes sub-interface SPAN configuration \
+| | ... | \| ${nodes['DUT1']} \| GigabitEthernet0/8/0 \| ${1} \|
+| | ...
+| | [Arguments] | ${node} | ${dst_interface} | ${index}
+| | InterfaceAPI.Configure sub interface SPAN
+| | ... | ${node} | ${dst_interface} | ${index}
+
+| Sub-Interface SPAN Operational Data from Honeycomb should not exist
+| | [Documentation] | Retrieves sub-interface operational data and verifies
+| | ... | that SPAN mirroring is not configured.
+| | ...
+| | ... | *Arguments:*
+| | ... | - node - information about a DUT node. Type: dictionary
+| | ... | - dst_interface - Mirroring destination super-interface. Type: string
+| | ... | - index - Index of mirroring destination sub-interface. Type: integer
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Sub-Interface SPAN Operational Data from Honeycomb should not exist \
+| | ... | \| ${nodes['DUT1']} \| GigabitEthernet0/8/0 \| ${1} \|
+| | ....
+| | [Arguments] | ${node} | ${dst_interface} | ${index}
+| | ${data}= | InterfaceAPI.Get sub interface oper data
+| | ... | ${node} | ${dst_interface} | ${index}
+| | Run keyword and expect error | *KeyError* | Set Variable
+| | ... | ${data['subinterface-span:span-state']['mirrored-interfaces']['mirrored-interface']}
\ No newline at end of file
diff --git a/resources/test_data/honeycomb/spanrx-apihc-apivat.py b/resources/test_data/honeycomb/span.py
index 3f6a1e6a00..9e1004d8ed 100644
--- a/resources/test_data/honeycomb/spanrx-apihc-apivat.py
+++ b/resources/test_data/honeycomb/span.py
@@ -14,18 +14,12 @@
 """Test variables for SPAN port mirroring test suite."""
 
 
-def get_variables(node,
-                  interface1,
-                  interface2,
-                  interface3
-                 ):
+def get_variables(interface1, interface2, interface3):
     """Create and return a dictionary of test variables.
 
-    :param node: Honeycomb node.
     :param interface1: Name of an interface.
     :param interface2: Name of an interface.
     :param interface3: Name of an interface.
-    :type node: dict
     :type interface1: string
     :type interface2: string
     :type interface3: string
@@ -38,28 +32,36 @@ def get_variables(node,
         "interface1": interface1,
         "interface2": interface2,
         "interface3": interface3,
-        "settings_1": {
+
+        # Interface 2 - ingress
+        "settings_receive": {
             "state": "receive",
             "iface-ref": interface2,
         },
 
-        "settings_2": {
+        # Interface 2 - egress
+        "settings_transmit": {
             "state": "transmit",
             "iface-ref": interface2,
         },
 
-        "settings_3": {
+        # Interface 2 - ingress/egress
+        "settings_both": {
             "state": "both",
             "iface-ref": interface2,
         },
 
-        "settings_4": {
+        # Interface 3 - ingress/egress
+        "settings_if2": {
             "state": "both",
             "iface-ref": interface3,
         },
 
+        # IP addresses for traffic test
         "tg_to_dut_if1_ip": "192.168.1.1",
         "dut_to_tg_if1_ip": "192.168.1.2",
+        "tg_to_dut_if2_ip": "192.168.2.1",
+        "dut_to_tg_if2_ip": "192.168.2.2",
         "prefix": 24,
     }
     return variables