-# Copyright (c) 2019 Cisco and/or its affiliates.
+# Copyright (c) 2020 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 enum import IntEnum
from resources.libraries.python.Constants import Constants
+from resources.libraries.python.IPUtil import IpDscp
from resources.libraries.python.PapiExecutor import PapiSocketExecutor
from resources.libraries.python.topology import Topology
ROUND_TO_CLOSEST = 0
ROUND_TO_UP = 1
ROUND_TO_DOWN = 2
- ROUND_TO_INVALID = 3
+ ROUND_INVALID = 3
class PolicerType(IntEnum):
VIOLATE_COLOR = 2
-class DSCP(IntEnum):
- """DSCP for mark-and-transmit action."""
- D_CS0 = 0
- D_CS1 = 8
- D_CS2 = 16
- D_CS3 = 24
- D_CS4 = 32
- D_vCS5 = 40
- D_CS6 = 48
- D_CS7 = 56
- D_AF11 = 10
- D_AF12 = 12
- D_AF13 = 14
- D_AF21 = 18
- D_AF22 = 20
- D_AF23 = 22
- D_AF31 = 26
- D_AF32 = 28
- D_AF33 = 30
- D_EF = 46
-
-
-class Policer(object):
+class Policer:
"""Policer utilities."""
- # pylint: disable=too-many-arguments, too-many-locals
+ # TODO: Pylint says too-many-arguments and too-many-locals.
+ # It is right, we should refactor the code
+ # and group similar arguments together (into documented classes).
+ # Note that even the call from Robot Framework
+ # is not very readable with this many arguments.
@staticmethod
def policer_set_configuration(
node, policer_name, cir, eir, cbs, ebs, rate_type, round_type,
:type exceed_dscp: str
:type violate_dscp: str
"""
- cmd = 'policer_add_del'
+ conform_action = dict(
+ type=getattr(PolicerAction, conform_action_type.upper()).value,
+ dscp=Policer.get_dscp_num_value(conform_dscp) if
+ conform_action_type.upper() == PolicerAction.MARK_AND_TRANSMIT.name
+ else 0
+ )
+ exceed_action = dict(
+ type=getattr(PolicerAction, exceed_action_type.upper()).value,
+ dscp=Policer.get_dscp_num_value(exceed_dscp) if
+ exceed_action_type.upper() == PolicerAction.MARK_AND_TRANSMIT.name
+ else 0
+ )
+ violate_action = dict(
+ type=getattr(PolicerAction, violate_action_type.upper()).value,
+ dscp=Policer.get_dscp_num_value(violate_dscp) if
+ violate_action_type.upper() == PolicerAction.MARK_AND_TRANSMIT.name
+ else 0
+ )
+
+ cmd = u"policer_add_del"
args = dict(
- is_add=int(is_add),
+ is_add=is_add,
name=str(policer_name),
cir=int(cir),
eir=int(eir),
eb=int(ebs),
rate_type=getattr(PolicerRateType, rate_type.upper()).value,
round_type=getattr(
- PolicerRoundType, 'ROUND_TO_{rt}'.format(
- rt=round_type.upper())).value,
- type=getattr(PolicerType, 'TYPE_{pt}'.format(
- pt=policer_type.upper())).value,
- conform_action_type=getattr(
- PolicerAction, conform_action_type.upper()).value,
- conform_dscp=getattr(DSCP, 'D_{dscp}'.format(
- dscp=conform_dscp.upper())).value
- if
- conform_action_type.upper() == PolicerAction.MARK_AND_TRANSMIT.name
- else 0,
- exceed_action_type=getattr(
- PolicerAction, exceed_action_type.upper()).value,
- exceed_dscp=getattr(DSCP, 'D_{dscp}'.format(
- dscp=exceed_dscp.upper())).value
- if
- exceed_action_type.upper() == PolicerAction.MARK_AND_TRANSMIT.name
- else 0,
- violate_action_type=getattr(
- PolicerAction, violate_action_type.upper()).value,
- violate_dscp=getattr(DSCP, 'D_{dscp}'.format(
- dscp=violate_dscp.upper())).value
- if
- violate_action_type.upper() == PolicerAction.MARK_AND_TRANSMIT.name
- else 0,
- color_aware=1 if color_aware == "'ca'" else 0
+ PolicerRoundType, f"ROUND_TO_{round_type.upper()}"
+ ).value,
+ type=getattr(PolicerType, f"TYPE_{policer_type.upper()}").value,
+ conform_action=conform_action,
+ exceed_action=exceed_action,
+ violate_action=violate_action,
+ color_aware=bool(color_aware == u"'ca'")
)
- err_msg = 'Failed to configure policer {pn} on host {host}'.format(
- pn=policer_name, host=node['host'])
+ err_msg = f"Failed to configure policer {policer_name} " \
+ f"on host {node['host']}"
with PapiSocketExecutor(node) as papi_exec:
reply = papi_exec.add(cmd, **args).get_reply(err_msg)
- return reply['policer_index']
+ return reply[u"policer_index"]
@staticmethod
def policer_classify_set_interface(
node, interface, ip4_table_index=Constants.BITWISE_NON_ZERO,
ip6_table_index=Constants.BITWISE_NON_ZERO,
- l2_table_index=Constants.BITWISE_NON_ZERO, is_add=1):
+ l2_table_index=Constants.BITWISE_NON_ZERO, is_add=True):
"""Set/unset policer classify interface.
:param node: VPP node.
(Default value = ~0)
:param l2_table_index: L2 classify table index (~0 to skip).
(Default value = ~0)
- :param is_add: Set if non-zero, else unset.
+ :param is_add: Set if True, else unset.
:type node: dict
:type interface: str or int
:type ip4_table_index: int
:type ip6_table_index: int
:type l2_table_index: int
+ :type is_add: bool
"""
- if isinstance(interface, basestring):
+ if isinstance(interface, str):
sw_if_index = Topology.get_interface_sw_index(node, interface)
else:
sw_if_index = interface
- cmd = 'policer_classify_set_interface'
-
+ cmd = u"policer_classify_set_interface"
args = dict(
- is_add=int(is_add),
- sw_if_index=sw_if_index,
+ is_add=is_add,
+ sw_if_index=int(sw_if_index),
ip4_table_index=int(ip4_table_index),
ip6_table_index=int(ip6_table_index),
l2_table_index=int(l2_table_index)
)
- err_msg = 'Failed to set/unset policer classify interface {ifc} ' \
- 'on host {host}'.format(ifc=interface, host=node['host'])
+ err_msg = f"Failed to set/unset policer classify interface " \
+ f"{interface} on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args).get_reply(err_msg)
:returns: DSCP numeric value.
:rtype: int
"""
- return getattr(DSCP, 'D_{dscp}'.format(dscp=dscp.upper())).value
+ return getattr(IpDscp, f"IP_API_DSCP_{dscp.upper()}").value
Code Review / csit.git / blobdiff