-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2018 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:
from robot.api import logger
from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
+from resources.libraries.python.topology import Topology
class Classify(object):
:type node: dict
:type ip_version: str
:type direction: str
- :returns (table_index, skip_n, match_n)
- table_index: Classify table index.
- skip_n: Number of skip vectors.
- match_n: Number of match vectors.
+ :returns: (table_index, skip_n, match_n)
+ table_index: Classify table index.
+ skip_n: Number of skip vectors.
+ match_n: Number of match vectors.
:rtype: tuple(int, int, int)
:raises RuntimeError: If VPP can't create table.
"""
:param direction: Direction of traffic - src/dst.
:type node: dict
:type direction: str
- :returns (table_index, skip_n, match_n)
- table_index: Classify table index.
- skip_n: Number of skip vectors.
- match_n: Number of match vectors.
+ :returns: (table_index, skip_n, match_n)
+ table_index: Classify table index.
+ skip_n: Number of skip vectors.
+ match_n: Number of match vectors.
:rtype: tuple(int, int, int)
:raises RuntimeError: If VPP can't create table.
"""
:param hex_mask: Classify hex mask.
:type node: dict
:type hex_mask: str
- :returns (table_index, skip_n, match_n)
- table_index: Classify table index.
- skip_n: Number of skip vectors.
- match_n: Number of match vectors.
+ :returns: (table_index, skip_n, match_n)
+ table_index: Classify table index.
+ skip_n: Number of skip vectors.
+ match_n: Number of match vectors.
:rtype: tuple(int, int, int)
:raises RuntimeError: If VPP can't create table.
"""
:param node: VPP node to setup classify session.
:param session_type: Session type - hit-next, l2-hit-next, acl-hit-next
- or policer-hit-next, and their respective parameters.
+ or policer-hit-next, and their respective parameters.
:param table_index: Classify table index.
:param skip_n: Number of skip vectors based on mask.
:param match_n: Number of match vectors based on mask.
:param match: Match value - l2, l3, l4 or hex, and their
- respective parameters.
+ respective parameters.
:param match2: Additional match values, to avoid using overly long
- variables in RobotFramework.
+ variables in RobotFramework.
:type node: dict
:type session_type: str
:type table_index: int
:type protocol: str
:type direction: str
:returns: Classify hex mask.
- :rtype : str
+ :rtype: str
:raises ValueError: If protocol is not TCP or UDP.
:raises ValueError: If direction is not source or destination or
source + destination.
:param ip_version: Version of IP protocol.
:type ip_version: str
- :return: Base hex mask.
+ :returns: Base hex mask.
:rtype: str
"""
if ip_version == 'ip4':
)
if session_index is not None:
return data[0][session_index]
+ return data[0]
+
+ @staticmethod
+ def vpp_log_plugin_acl_settings(node):
+ """Retrieve configured settings from the ACL plugin
+ and write to robot log.
+
+ :param node: VPP node.
+ :type node: dict
+ """
+ try:
+ VatExecutor.cmd_from_template(
+ node, "acl_plugin/acl_dump.vat")
+ except (ValueError, RuntimeError):
+ # Fails to parse JSON data in response, but it is still logged
+ pass
+
+ @staticmethod
+ def vpp_log_plugin_acl_interface_assignment(node):
+ """Retrieve interface assignment from the ACL plugin
+ and write to robot log.
+
+ :param node: VPP node.
+ :type node: dict
+ """
+ try:
+ VatExecutor.cmd_from_template(
+ node, "acl_plugin/acl_interface_dump.vat", json_out=False)
+ except RuntimeError:
+ # Fails to parse response, but it is still logged
+ pass
+
+ @staticmethod
+ def set_acl_list_for_interface(node, interface, acl_type, acl_idx=None):
+ """Set the list of input or output ACLs applied to the interface. It
+ unapplies any previously applied ACLs.
+
+ :param node: VPP node to set ACL on.
+ :param interface: Interface name or sw_if_index.
+ :param acl_type: Type of ACL(s) - input or output.
+ :param acl_idx: Index(ies) of ACLs to be applied on the interface.
+ :type node: dict
+ :type interface: str or int
+ :type acl_type: str
+ :type acl_idx: list
+ :raises RuntimeError: If unable to set ACL list for the interface.
+ """
+ if isinstance(interface, basestring):
+ sw_if_index = Topology.get_interface_sw_index(node, interface)
else:
- return data[0]
+ sw_if_index = interface
+
+ acl_list = acl_type + ' ' + ' '.join(str(idx) for idx in acl_idx) \
+ if acl_idx else acl_type
+
+ try:
+ with VatTerminal(node, json_param=False) as vat:
+ vat.vat_terminal_exec_cmd_from_template(
+ "acl_plugin/acl_interface_set_acl_list.vat",
+ interface=sw_if_index, acl_list=acl_list)
+ except RuntimeError:
+ raise RuntimeError("Setting of ACL list for interface {0} failed "
+ "on node {1}".format(interface, node['host']))
+
+ @staticmethod
+ def add_replace_acl(node, acl_idx=None, ip_ver="ipv4", action="permit",
+ src=None, dst=None, sport=None, dport=None, proto=None,
+ tcpflg_val=None, tcpflg_mask=None):
+ """Add a new ACL or replace the existing one. To replace an existing
+ ACL, pass the ID of this ACL.
+
+ :param node: VPP node to set ACL on.
+ :param acl_idx: ID of ACL. (Optional)
+ :param ip_ver: IP version. (Optional)
+ :param action: ACL action. (Optional)
+ :param src: Source IP in format IP/plen. (Optional)
+ :param dst: Destination IP in format IP/plen. (Optional)
+ :param sport: Source port or ICMP4/6 type - range format X-Y allowed.
+ (Optional)
+ :param dport: Destination port or ICMP4/6 code - range format X-Y
+ allowed. (Optional)
+ :param proto: L4 protocol (http://www.iana.org/assignments/protocol-
+ numbers/protocol-numbers.xhtml). (Optional)
+ :param tcpflg_val: TCP flags value. (Optional)
+ :param tcpflg_mask: TCP flags mask. (Optional)
+ :type node: dict
+ :type acl_idx: int
+ :type ip_ver: str
+ :type action: str
+ :type src: str
+ :type dst: str
+ :type sport: str or int
+ :type dport: str or int
+ :type proto: int
+ :type tcpflg_val: int
+ :type tcpflg_mask: int
+ :raises RuntimeError: If unable to add or replace ACL.
+ """
+ acl_idx = '{0}'.format(acl_idx) if acl_idx else ''
+
+ src = 'src {0}'.format(src) if src else ''
+
+ dst = 'dst {0}'.format(dst) if dst else ''
+
+ sport = 'sport {0}'.format(sport) if sport else ''
+
+ dport = 'dport {0}'.format(dport) if dport else ''
+
+ proto = 'proto {0}'.format(proto) if proto else ''
+
+ tcpflags = 'tcpflags {0} {1}'.format(tcpflg_val, tcpflg_mask) \
+ if tcpflg_val and tcpflg_mask else ''
+
+ try:
+ with VatTerminal(node, json_param=False) as vat:
+ vat.vat_terminal_exec_cmd_from_template(
+ "acl_plugin/acl_add_replace.vat", acl_idx=acl_idx,
+ ip_ver=ip_ver, action=action, src=src, dst=dst, sport=sport,
+ dport=dport, proto=proto, tcpflags=tcpflags)
+ except RuntimeError:
+ raise RuntimeError("Adding or replacing of ACL failed on "
+ "node {0}".format(node['host']))
+
+ @staticmethod
+ def add_replace_acl_multi_entries(node, acl_idx=None, rules=None):
+ """Add a new ACL or replace the existing one. To replace an existing
+ ACL, pass the ID of this ACL.
+
+ :param node: VPP node to set ACL on.
+ :param acl_idx: ID of ACL. (Optional)
+ :param rules: Required rules. (Optional)
+ :type node: dict
+ :type acl_idx: int
+ :type rules: str
+ :raises RuntimeError: If unable to add or replace ACL.
+ """
+ acl_idx = '{0}'.format(acl_idx) if acl_idx else ''
+
+ rules = '{0}'.format(rules) if rules else ''
+
+ try:
+ with VatTerminal(node, json_param=False) as vat:
+ vat.vat_terminal_exec_cmd_from_template(
+ "acl_plugin/acl_add_replace.vat", acl_idx=acl_idx,
+ ip_ver=rules, action='', src='', dst='', sport='',
+ dport='', proto='', tcpflags='')
+ except RuntimeError:
+ raise RuntimeError("Adding or replacing of ACL failed on "
+ "node {0}".format(node['host']))
+
+ @staticmethod
+ def delete_acl(node, idx):
+ """Delete required ACL.
+
+ :param node: VPP node to delete ACL on.
+ :param idx: Index of ACL to be deleted.
+ :type node: dict
+ :type idx: int or str
+ :raises RuntimeError: If unable to delete ACL.
+ """
+ try:
+ with VatTerminal(node, json_param=False) as vat:
+ vat.vat_terminal_exec_cmd_from_template(
+ "acl_plugin/acl_delete.vat", idx=idx)
+ except RuntimeError:
+ raise RuntimeError("Deletion of ACL failed on node {0}".
+ format(node['host']))
+
+ @staticmethod
+ def cli_show_acl(node, acl_idx=None):
+ """Show ACLs.
+
+ :param node: VPP node to show ACL on.
+ :param acl_idx: Index of ACL to be shown.
+ :type node: dict
+ :type acl_idx: int or str
+ :raises RuntimeError: If unable to delete ACL.
+ """
+ acl_idx = '{0}'.format(acl_idx) if acl_idx else ''
+
+ try:
+ with VatTerminal(node, json_param=False) as vat:
+ vat.vat_terminal_exec_cmd_from_template(
+ "acl_plugin/show_acl.vat", idx=acl_idx)
+ except RuntimeError:
+ raise RuntimeError("Failed to show ACL on node {0}".
+ format(node['host']))
+
+ @staticmethod
+ def add_macip_acl(node, ip_ver="ipv4", action="permit", src_ip=None,
+ src_mac=None, src_mac_mask=None):
+ """Add a new MACIP ACL.
+
+ :param node: VPP node to set MACIP ACL on.
+ :param ip_ver: IP version. (Optional)
+ :param action: ACL action. (Optional)
+ :param src_ip: Source IP in format IP/plen. (Optional)
+ :param src_mac: Source MAC address in format with colons. (Optional)
+ :param src_mac_mask: Source MAC address mask in format with colons.
+ 00:00:00:00:00:00 is a wildcard mask. (Optional)
+ :type node: dict
+ :type ip_ver: str
+ :type action: str
+ :type src_ip: str
+ :type src_mac: str
+ :type src_mac_mask: str
+ :raises RuntimeError: If unable to add MACIP ACL.
+ """
+ src_ip = 'ip {0}'.format(src_ip) if src_ip else ''
+
+ src_mac = 'mac {0}'.format(src_mac) if src_mac else ''
+
+ src_mac_mask = 'mask {0}'.format(src_mac_mask) if src_mac_mask else ''
+
+ try:
+ with VatTerminal(node, json_param=False) as vat:
+ vat.vat_terminal_exec_cmd_from_template(
+ "acl_plugin/macip_acl_add.vat", ip_ver=ip_ver,
+ action=action, src_ip=src_ip, src_mac=src_mac,
+ src_mac_mask=src_mac_mask)
+ except RuntimeError:
+ raise RuntimeError("Adding of MACIP ACL failed on node {0}".
+ format(node['host']))
+
+ @staticmethod
+ def add_macip_acl_multi_entries(node, rules=None):
+ """Add a new MACIP ACL.
+
+ :param node: VPP node to set MACIP ACL on.
+ :param rules: Required MACIP rules. (Optional)
+ :type node: dict
+ :type rules: str
+ :raises RuntimeError: If unable to add MACIP ACL.
+ """
+ rules = '{0}'.format(rules) if rules else ''
+
+ try:
+ with VatTerminal(node, json_param=False) as vat:
+ vat.vat_terminal_exec_cmd_from_template(
+ "acl_plugin/macip_acl_add.vat", ip_ver=rules, action='',
+ src_ip='', src_mac='', src_mac_mask='')
+ except RuntimeError:
+ raise RuntimeError("Adding of MACIP ACL failed on node {0}".
+ format(node['host']))
+
+ @staticmethod
+ def delete_macip_acl(node, idx):
+ """Delete required MACIP ACL.
+
+ :param node: VPP node to delete MACIP ACL on.
+ :param idx: Index of ACL to be deleted.
+ :type node: dict
+ :type idx: int or str
+ :raises RuntimeError: If unable to delete MACIP ACL.
+ """
+ try:
+ with VatTerminal(node, json_param=False) as vat:
+ vat.vat_terminal_exec_cmd_from_template(
+ "acl_plugin/macip_acl_delete.vat", idx=idx)
+ except RuntimeError:
+ raise RuntimeError("Deletion of MACIP ACL failed on node {0}".
+ format(node['host']))
+
+ @staticmethod
+ def vpp_log_macip_acl_settings(node):
+ """Retrieve configured MACIP settings from the ACL plugin
+ and write to robot log.
+
+ :param node: VPP node.
+ :type node: dict
+ """
+ try:
+ VatExecutor.cmd_from_template(
+ node, "acl_plugin/macip_acl_dump.vat")
+ except (ValueError, RuntimeError):
+ # Fails to parse JSON data in response, but it is still logged
+ pass
+
+ @staticmethod
+ def add_del_macip_acl_interface(node, interface, action, acl_idx):
+ """Apply/un-apply the MACIP ACL to/from a given interface.
+
+ :param node: VPP node to set MACIP ACL on.
+ :param interface: Interface name or sw_if_index.
+ :param action: Required action - add or del.
+ :param acl_idx: ACL index to be applied on the interface.
+ :type node: dict
+ :type interface: str or int
+ :type action: str
+ :type acl_idx: str or int
+ :raises RuntimeError: If unable to set MACIP ACL for the interface.
+ """
+ if isinstance(interface, basestring):
+ sw_if_index = Topology.get_interface_sw_index(node, interface)
+ else:
+ sw_if_index = interface
+
+ try:
+ with VatTerminal(node, json_param=False) as vat:
+ vat.vat_terminal_exec_cmd_from_template(
+ "acl_plugin/macip_acl_interface_add_del.vat",
+ sw_if_index=sw_if_index, action=action, acl_idx=acl_idx)
+ except RuntimeError:
+ raise RuntimeError("Setting of MACIP ACL index for interface {0} "
+ "failed on node {1}".
+ format(interface, node['host']))
+
+ @staticmethod
+ def vpp_log_macip_acl_interface_assignment(node):
+ """Get interface list and associated MACIP ACLs and write to robot log.
+
+ :param node: VPP node.
+ :type node: dict
+ """
+ try:
+ VatExecutor.cmd_from_template(
+ node, "acl_plugin/macip_acl_interface_get.vat", json_out=False)
+ except RuntimeError:
+ # Fails to parse response, but it is still logged
+ pass
Code Review / csit.git / blobdiff