1 # Copyright (c) 2016 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Common IP utilities library."""
16 from ipaddress import IPv4Network, ip_address
18 from resources.libraries.python.ssh import SSH
19 from resources.libraries.python.constants import Constants
20 from resources.libraries.python.ssh import exec_cmd_no_error, exec_cmd
21 from resources.libraries.python.topology import Topology
25 """Common IP utilities"""
28 def vpp_ip_probe(node, interface, addr, if_type="key"):
29 """Run ip probe on VPP node.
31 :param node: VPP node.
32 :param interface: Interface key or name.
33 :param addr: IPv4/IPv6 address.
34 :param if_type: Interface type
39 :raises ValueError: If the if_type is unknown.
40 :raises Exception: If vpp probe fails.
46 iface_name = Topology.get_interface_name(node, interface)
47 elif if_type == "name":
48 iface_name = interface
50 raise ValueError("if_type unknown: {0}".format(if_type))
52 cmd = "{c}".format(c=Constants.VAT_BIN_NAME)
53 cmd_input = 'exec ip probe {dev} {ip}'.format(dev=iface_name, ip=addr)
54 (ret_code, _, _) = ssh.exec_command_sudo(cmd, cmd_input)
55 if int(ret_code) != 0:
56 raise Exception('VPP ip probe {dev} {ip} failed on {h}'.format(
57 dev=iface_name, ip=addr, h=node['host']))
60 def ip_addresses_should_be_equal(ip1, ip2):
61 """Fails if the given IP addresses are unequal.
63 :param ip1: IPv4 or IPv6 address.
64 :param ip2: IPv4 or IPv6 address.
69 addr1 = ip_address(unicode(ip1))
70 addr2 = ip_address(unicode(ip2))
73 raise AssertionError('IP addresses are not equal: {0} != {1}'.
77 def setup_network_namespace(node, namespace_name, interface_name,
79 """Setup namespace on given node and attach interface and IP to
80 this namespace. Applicable also on TG node.
82 :param node: Node to set namespace on.
83 :param namespace_name: Namespace name.
84 :param interface_name: Interface name.
85 :param ip_addr: IP address of namespace's interface.
86 :param prefix: IP address prefix length.
88 :type namespace_name: str
93 cmd = ('ip netns add {0}'.format(namespace_name))
94 exec_cmd_no_error(node, cmd, sudo=True)
96 cmd = ('ip link set dev {0} up netns {1}'.format(interface_name,
98 exec_cmd_no_error(node, cmd, sudo=True)
100 cmd = ('ip netns exec {0} ip addr add {1}/{2} dev {3}'.format(
101 namespace_name, ip_addr, prefix, interface_name))
102 exec_cmd_no_error(node, cmd, sudo=True)
105 def linux_enable_forwarding(node, ip_ver='ipv4'):
106 """Enable forwarding on a Linux node, e.g. VM.
108 :param node: Node to enable forwarding on.
109 :param ip_ver: IP version, 'ipv4' or 'ipv6'.
113 cmd = 'sysctl -w net.{0}.ip_forward=1'.format(ip_ver)
114 exec_cmd_no_error(node, cmd, sudo=True)
117 def set_linux_interface_ip(node, interface, ip_addr, prefix,
119 """Set IP address to interface in linux.
121 :param node: Node where to execute command.
122 :param interface: Interface in namespace.
123 :param ip_addr: IP to be set on interface.
124 :param prefix: IP prefix.
125 :param namespace: Execute command in namespace. Optional
131 :raises RuntimeError: IP could not be set.
133 if namespace is not None:
134 cmd = 'ip netns exec {} ip addr add {}/{} dev {}'.format(
135 namespace, ip_addr, prefix, interface)
137 cmd = 'ip addr add {}/{} dev {}'.format(ip_addr, prefix, interface)
138 (ret_code, _, stderr) = exec_cmd(node, cmd, timeout=5, sudo=True)
141 'Could not set IP for interface, reason:{}'.format(stderr))
144 def set_linux_interface_route(node, interface, route, namespace=None):
145 """Set route via interface in linux.
147 :param node: Node where to execute command.
148 :param interface: Interface in namespace.
149 :param route: Route to be added via interface.
150 :param namespace: Execute command in namespace. Optional parameter.
156 if namespace is not None:
157 cmd = 'ip netns exec {} ip route add {} dev {}'.format(
158 namespace, route, interface)
160 cmd = 'ip route add {} dev {}'.format(route, interface)
161 exec_cmd_no_error(node, cmd, sudo=True)
164 def convert_ipv4_netmask_prefix(network):
165 """Convert network mask to equivalent network prefix length or vice versa.
167 Example: mask 255.255.0.0 -> prefix length 16
168 :param network: Network mask or network prefix length.
169 :type network: str or int
170 :returns: Network mask or network prefix length.
173 temp_address = "0.0.0.0"
174 net = IPv4Network(u"{0}/{1}".format(temp_address, network), False)
176 if isinstance(network, int) and (0 < network < 33):
177 return str(net.netmask)
178 elif isinstance(network, basestring):
179 return int(net.prefixlen)
181 raise Exception("Value {0} is not a valid ipv4 netmask or network"
182 " prefix length".format(network))