# Copyright (c) 2016 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: # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """Common IP utilities library.""" from ipaddress import IPv4Network, ip_address from resources.libraries.python.ssh import SSH from resources.libraries.python.constants import Constants from resources.libraries.python.topology import Topology class IPUtil(object): """Common IP utilities""" @staticmethod def vpp_ip_probe(node, interface, addr, if_type="key"): """Run ip probe on VPP node. :param node: VPP node. :param interface: Interface key or name. :param addr: IPv4/IPv6 address. :param if_type: Interface type :type node: dict :type interface: str :type addr: str :type if_type: str :raises ValueError: If the if_type is unknown. :raises Exception: If vpp probe fails. """ ssh = SSH() ssh.connect(node) if if_type == "key": iface_name = Topology.get_interface_name(node, interface) elif if_type == "name": iface_name = interface else: raise ValueError("if_type unknown: {0}".format(if_type)) cmd = "{c}".format(c=Constants.VAT_BIN_NAME) cmd_input = 'exec ip probe {dev} {ip}'.format(dev=iface_name, ip=addr) (ret_code, _, _) = ssh.exec_command_sudo(cmd, cmd_input) if int(ret_code) != 0: raise Exception('VPP ip probe {dev} {ip} failed on {h}'.format( dev=iface_name, ip=addr, h=node['host'])) @staticmethod def ip_addresses_should_be_equal(ip1, ip2): """Fails if the given IP addresses are unequal. :param ip1: IPv4 or IPv6 address. :param ip2: IPv4 or IPv6 address. :type ip1: str :type ip2: str """ addr1 = ip_address(unicode(ip1)) addr2 = ip_address(unicode(ip2)) if addr1 != addr2: raise AssertionError('IP addresses are not equal: {0} != {1}'. format(ip1, ip2)) def convert_ipv4_netmask_prefix(network): """Convert network mask to equivalent network prefix length or vice versa. Example: mask 255.255.0.0 -> prefix length 16 :param network: Network mask or network prefix length. :type network: str or int :return: Network mask or network prefix length. :rtype: str or int """ temp_address = "0.0.0.0" net = IPv4Network(u"{0}/{1}".format(temp_address, network), False) if isinstance(network, int) and (0 < network < 33): return str(net.netmask) elif isinstance(network, basestring): return int(net.prefixlen) else: raise Exception("Value {0} is not a valid ipv4 netmask or network" " prefix length".format(network))