-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2019 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:
"""SPAN setup library"""
from resources.libraries.python.topology import Topology
-from resources.libraries.python.VatExecutor import VatTerminal
+from resources.libraries.python.PapiExecutor import PapiSocketExecutor
-# pylint: disable=too-few-public-methods
class SPAN(object):
"""Class contains methods for setting up SPAN mirroring on DUTs."""
pass
@staticmethod
- def set_span_mirroring(node, src_if, dst_if):
- """Set Span mirroring on the specified node.
+ def vpp_get_span_configuration(node, is_l2=False):
+ """Get full SPAN configuration from VPP node.
+
+ Used by Honeycomb.
+
+ :param node: DUT node.
+ :type node: dict
+
+ :returns: Full SPAN configuration as list. One list entry for every
+ source/destination interface pair.
+ :rtype: list of dict
+ """
+ cmd = "sw_interface_span_dump"
+ args = dict(
+ is_l2=1 if is_l2 else 0
+ )
+ with PapiSocketExecutor(node) as papi_exec:
+ details = papi_exec.add(cmd, **args).get_details()
+
+ return details
+
+ @staticmethod
+ def vpp_get_span_configuration_by_interface(node, dst_interface,
+ ret_format="sw_if_index"):
+ """Get a list of all interfaces currently being mirrored
+ to the specified interface.
+
+ Used by Honeycomb.
:param node: DUT node.
- :param src_if: Interface to mirror traffic from.
- :param dst_if: Interface to mirror traffic to.
+ :param dst_interface: Name, sw_if_index or key of interface.
+ :param ret_format: Optional. Desired format of returned interfaces.
:type node: dict
- :type src_if: str
- :type dst_if: str
+ :type dst_interface: str or int
+ :type ret_format: string
+ :returns: List of SPAN source interfaces for the provided destination
+ interface.
+ :rtype: list
"""
- src_if = Topology.get_interface_name(node, src_if)
- dst_if = Topology.get_interface_name(node, dst_if)
+ data = SPAN.vpp_get_span_configuration(node)
+
+ dst_int = Topology.convert_interface_reference(
+ node, dst_interface, "sw_if_index")
+ src_interfaces = []
+ for item in data:
+ if item["sw_if_index_to"] == dst_int:
+ src_interfaces.append(item["sw_if_index_from"])
+
+ if ret_format != "sw_if_index":
+ src_interfaces = [
+ Topology.convert_interface_reference(
+ node, interface, ret_format
+ ) for interface in src_interfaces]
- with VatTerminal(node, json_param=False) as vat:
- vat.vat_terminal_exec_cmd_from_template('span_create.vat',
- src_if=src_if,
- dst_if=dst_if,
- )
- # TODO: Update "span_create.vat" to use VAT command, once available
+ return src_interfaces