-# Copyright (c) 2020 Cisco and/or its affiliates.
+# Copyright (c) 2021 Cisco and/or its affiliates.
+# Copyright (c) 2021 PANTHEON.tech s.r.o.
# 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 ipaddress import ip_address
+from ipaddress import ip_address, ip_network
from resources.libraries.python.Constants import Constants
+from resources.libraries.python.IncrementUtil import ObjIncrement
from resources.libraries.python.InterfaceUtil import InterfaceUtil
from resources.libraries.python.IPAddress import IPAddress
from resources.libraries.python.PapiExecutor import PapiSocketExecutor
class FibPathFlags(IntEnum):
"""FIB path flags."""
FIB_PATH_FLAG_NONE = 0
- # TODO: Name too long for pylint, fix in VPP.
FIB_PATH_FLAG_RESOLVE_VIA_ATTACHED = 1
FIB_PATH_FLAG_RESOLVE_VIA_HOST = 2
FIB_PATH_NH_PROTO_BIER = 4
+class IpDscp(IntEnum):
+ """DSCP code points."""
+ IP_API_DSCP_CS0 = 0
+ IP_API_DSCP_CS1 = 8
+ IP_API_DSCP_AF11 = 10
+ IP_API_DSCP_AF12 = 12
+ IP_API_DSCP_AF13 = 14
+ IP_API_DSCP_CS2 = 16
+ IP_API_DSCP_AF21 = 18
+ IP_API_DSCP_AF22 = 20
+ IP_API_DSCP_AF23 = 22
+ IP_API_DSCP_CS3 = 24
+ IP_API_DSCP_AF31 = 26
+ IP_API_DSCP_AF32 = 28
+ IP_API_DSCP_AF33 = 30
+ IP_API_DSCP_CS4 = 32
+ IP_API_DSCP_AF41 = 34
+ IP_API_DSCP_AF42 = 36
+ IP_API_DSCP_AF43 = 38
+ IP_API_DSCP_CS5 = 40
+ IP_API_DSCP_EF = 46
+ IP_API_DSCP_CS6 = 48
+ IP_API_DSCP_CS7 = 50
+
+
+class NetworkIncrement(ObjIncrement):
+ """
+ An iterator object which accepts an IPv4Network or IPv6Network and
+ returns a new network, its address part incremented by the increment
+ number of network sizes, each time it is iterated or when inc_fmt is called.
+ The increment may be positive, negative or 0
+ (in which case the network is always the same).
+
+ Both initial and subsequent IP address can have host bits set,
+ check the initial value before creating instance if needed.
+ String formatting is configurable via constructor argument.
+ """
+ def __init__(self, initial_value, increment=1, format=u"dash"):
+ """
+ :param initial_value: The initial network. Can have host bits set.
+ :param increment: The current network will be incremented by this
+ amount of network sizes in each iteration/var_str call.
+ :param format: Type of formatting to use, currently only "dash".
+ :type initial_value: Union[ipaddress.IPv4Network, ipaddress.IPv6Network]
+ :type increment: int
+ :type format: str
+ """
+ super().__init__(initial_value, increment)
+ self._prefix_len = self._value.prefixlen
+ host_len = self._value.max_prefixlen - self._prefix_len
+ self._net_increment = self._increment * (1 << host_len)
+ self._format = str(format).lower()
+
+ def _incr(self):
+ """
+ Increment the network, e.g.:
+ '30.0.0.0/24' incremented by 1 (the next network) is '30.0.1.0/24'.
+ '30.0.0.0/24' incremented by 2 is '30.0.2.0/24'.
+ """
+ self._value = ip_network(
+ f"{self._value.network_address + self._net_increment}"
+ f"/{self._prefix_len}", strict=False
+ )
+
+ def _str_fmt(self):
+ """
+ The string representation of the network depend on format.
+ Dash format is '<ip_address_start> - <ip_address_stop>',
+ useful for 'ipsec policy add spd' cli.
+ Slash format is '<ip_address_start>/<prefix_length>'.
+
+ :returns: Current value converted to string according to format.
+ :rtype: str
+ :raises RuntimeError: If the format is not supported.
+ """
+ if self._format == u"dash":
+ return f"{self._value.network_address} - " \
+ f"{self._value.broadcast_address}"
+ # More formats will be added in subsequent changes.
+ else:
+ raise RuntimeError(f"Unsupported format {self._format}")
+
+
class IPUtil:
"""Common IP utilities"""
with PapiSocketExecutor(node) as papi_exec:
details = papi_exec.add(cmd, **args).get_details(err_msg)
- # TODO: CSIT currently looks only whether the list is empty.
- # Add proper value processing if values become important.
-
return details
@staticmethod
:type namespace: str
:raises RuntimeError: IP could not be deleted.
"""
- # TODO: Refactor command execution in namespaces into central
- # methods (e.g. Namespace.exec_cmd_in_namespace)
if namespace is not None:
cmd = f"ip netns exec {namespace} ip addr del " \
f"{ip_addr}/{prefix_length} dev {interface}"