-# 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:
"""IPv6 utilities library."""
import re
-from ssh import SSH
+
+from resources.libraries.python.ssh import SSH
+from resources.libraries.python.VatExecutor import VatTerminal
+from resources.libraries.python.topology import Topology
class IPv6Util(object):
"""IPv6 utilities"""
- def __init__(self):
- pass
-
@staticmethod
def ipv6_ping(src_node, dst_addr, count=3, data_size=56, timeout=1):
"""IPv6 ping.
- Args:
- src_node (Dict): Node where ping run.
- dst_addr (str): Destination IPv6 address.
- count (Optional[int]): Number of echo requests.
- data_size (Optional[int]): Number of the data bytes.
- timeout (Optional[int]): Time to wait for a response, in seconds.
-
- Returns:
- Number of lost packets.
+ :param src_node: Node where ping run.
+ :param dst_addr: Destination IPv6 address.
+ :param count: Number of echo requests. (Optional)
+ :param data_size: Number of the data bytes. (Optional)
+ :param timeout: Time to wait for a response, in seconds. (Optional)
+ :type src_node: dict
+ :type dst_addr: str
+ :type count: int
+ :type data_size: int
+ :type timeout: int
+ :returns: Number of lost packets.
+ :rtype: int
"""
ssh = SSH()
ssh.connect(src_node)
cmd = "ping6 -c {c} -s {s} -W {W} {dst}".format(c=count, s=data_size,
W=timeout,
dst=dst_addr)
- (ret_code, stdout, _) = ssh.exec_command(cmd)
+ (_, stdout, _) = ssh.exec_command(cmd)
regex = re.compile(r'(\d+) packets transmitted, (\d+) received')
match = regex.search(stdout)
size=56, timeout=1):
"""Send IPv6 ping to the node port.
- Args:
- nodes_ip (Dict): Nodes IPv6 adresses.
- src_node (Dict): Node where ping run.
- dst_node (Dict): Destination node.
- port (str): Port on the destination node.
- cnt (Optional[int]): Number of echo requests.
- size (Optional[int]): Number of the data bytes.
- timeout (Optional[int]): Time to wait for a response, in seconds.
-
- Returns:
- Number of lost packets.
+ :param nodes_ip: Nodes IPv6 addresses.
+ :param src_node: Node where ping run.
+ :param dst_node: Destination node.
+ :param port: Port on the destination node.
+ :param cnt: Number of echo requests. (Optional)
+ :param size: Number of the data bytes. (Optional)
+ :param timeout: Time to wait for a response, in seconds. (Optional)
+ :type nodes_ip: dict
+ :type src_node: dict
+ :type dst_node: dict
+ :type port: str
+ :type cnt: int
+ :type size: int
+ :type timeout: int
+ :returns: Number of lost packets.
+ :rtype: int
"""
dst_ip = IPv6Util.get_node_port_ipv6_address(dst_node, port, nodes_ip)
return IPv6Util.ipv6_ping(src_node, dst_ip, cnt, size, timeout)
@staticmethod
- def get_node_port_ipv6_address(node, interface, nodes_addr):
+ def get_node_port_ipv6_address(node, iface_key, nodes_addr):
"""Return IPv6 address of the node port.
- Args:
- node (Dict): Node in the topology.
- interface (str): Interface name of the node.
- nodes_addr (Dict): Nodes IPv6 adresses.
-
- Returns:
- IPv6 address string.
+ :param node: Node in the topology.
+ :param iface_key: Interface key of the node.
+ :param nodes_addr: Nodes IPv6 addresses.
+ :type node: dict
+ :type iface_key: str
+ :type nodes_addr: dict
+ :returns: IPv6 address string.
+ :rtype: str
"""
+ interface = Topology.get_interface_name(node, iface_key)
for net in nodes_addr.values():
for port in net['ports'].values():
host = port.get('node')
dev = port.get('if')
if host == node['host'] and dev == interface:
- ip = port.get('addr')
- if ip is not None:
- return ip
+ ip_addr = port.get('addr')
+ if ip_addr is not None:
+ return ip_addr
else:
raise Exception(
'Node {n} port {p} IPv6 address is not set'.format(
raise Exception('Node {n} port {p} IPv6 address not found.'.format(
n=node['host'], p=interface))
+
+ @staticmethod
+ def add_ip_neighbor(node, interface, ip_address, mac_address):
+ """Add IP neighbor.
+
+ :param node: VPP node to add ip neighbor.
+ :param interface: Interface name or sw_if_index.
+ :param ip_address: IP address.
+ :param mac_address: MAC address.
+ :type node: dict
+ :type interface: str or int
+ :type ip_address: str
+ :type mac_address: str
+ """
+ if isinstance(interface, basestring):
+ sw_if_index = Topology.get_interface_sw_index(node, interface)
+ else:
+ sw_if_index = interface
+
+ with VatTerminal(node) as vat:
+ vat.vat_terminal_exec_cmd_from_template("add_ip_neighbor.vat",
+ sw_if_index=sw_if_index,
+ ip_address=ip_address,
+ mac_address=mac_address)