X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FIPv4Setup.py;h=36dc6050a170b03343f4b0aeded091ed9126f4ad;hp=ed65518254d8d46997182f51310da47afee96ee8;hb=b5fe0fd9a4266773125cc4d4c1edaa1c1a8a1731;hpb=da15035461569ea175aabbac1df735cd5598b0b3 diff --git a/resources/libraries/python/IPv4Setup.py b/resources/libraries/python/IPv4Setup.py index ed65518254..36dc6050a1 100644 --- a/resources/libraries/python/IPv4Setup.py +++ b/resources/libraries/python/IPv4Setup.py @@ -16,11 +16,11 @@ from socket import inet_ntoa from struct import pack from abc import ABCMeta, abstractmethod + from robot.api.deco import keyword -import resources.libraries.python.ssh as ssh +from resources.libraries.python.ssh import exec_cmd_no_error from resources.libraries.python.Routing import Routing -from resources.libraries.python.InterfaceUtil import InterfaceUtil from resources.libraries.python.topology import NodeType, Topology from resources.libraries.python.VatExecutor import VatExecutor @@ -34,60 +34,70 @@ class IPv4Node(object): @staticmethod def _get_netmask(prefix_length): + """Convert IPv4 network prefix length into IPV4 network mask. + + :param prefix_length: Length of network prefix. + :type prefix_length: int + :returns: Network mask. + :rtype: str + """ + bits = 0xffffffff ^ (1 << 32 - prefix_length) - 1 return inet_ntoa(pack('>I', bits)) @abstractmethod def set_ip(self, interface, address, prefix_length): - """Configure IPv4 address on interface + """Configure IPv4 address on interface. - :param interface: interface name - :param address: - :param prefix_length: + :param interface: Interface name. + :param address: IPv4 address. + :param prefix_length: IPv4 prefix length. :type interface: str :type address: str :type prefix_length: int - :return: nothing + :returns: nothing """ pass @abstractmethod - def set_route(self, network, prefix_length, gateway, interface): - """Configure IPv4 route + def set_route(self, network, prefix_length, gateway, interface, count=1): + """Configure IPv4 route. - :param network: network IPv4 address - :param prefix_length: mask length - :param gateway: IPv4 address of the gateway - :param interface: interface name + :param network: Network IPv4 address. + :param prefix_length: IPv4 prefix length. + :param gateway: IPv4 address of the gateway. + :param interface: Interface name. + :param count: Number of consecutive routes to add. :type network: str :type prefix_length: int :type gateway: str :type interface: str - :return: nothing + :type route: int + :returns: nothing """ pass @abstractmethod def unset_route(self, network, prefix_length, gateway, interface): - """Remove specified IPv4 route + """Remove specified IPv4 route. - :param network: network IPv4 address - :param prefix_length: mask length - :param gateway: IPv4 address of the gateway - :param interface: interface name + :param network: Network IPv4 address. + :param prefix_length: IPv4 prefix length. + :param gateway: IPv4 address of the gateway. + :param interface: Interface name. :type network: str :type prefix_length: int :type gateway: str :type interface: str - :return: nothing + :returns: nothing """ pass @abstractmethod def flush_ip_addresses(self, interface): - """Flush all IPv4 addresses from specified interface + """Flush all IPv4 addresses from specified interface. - :param interface: interface name + :param interface: Interface name. :type interface: str :return: nothing """ @@ -95,13 +105,13 @@ class IPv4Node(object): @abstractmethod def ping(self, destination_address, source_interface): - """Send an ICMP request to destination node + """Send an ICMP request to destination node. - :param destination_address: address to send the ICMP request - :param source_interface: + :param destination_address: Address to send the ICMP request. + :param source_interface: Source interface name. :type destination_address: str :type source_interface: str - :return: nothing + :returns: nothing """ pass @@ -112,10 +122,24 @@ class Tg(IPv4Node): super(Tg, self).__init__(node_info) def _execute(self, cmd): - return ssh.exec_cmd_no_error(self.node_info, cmd) + """Executes the specified command on TG using SSH. + + :param cmd: Command to be executed. + :type cmd: str + :returns: Content of stdout and stderr returned by command. + :rtype: tuple + """ + return exec_cmd_no_error(self.node_info, cmd) def _sudo_execute(self, cmd): - return ssh.exec_cmd_no_error(self.node_info, cmd, sudo=True) + """Executes the specified command with sudo on TG using SSH. + + :param cmd: Command to be executed. + :type cmd: str + :returns: Content of stdout and stderr returned by command. + :rtype: tuple + """ + return exec_cmd_no_error(self.node_info, cmd, sudo=True) def set_ip(self, interface, address, prefix_length): cmd = 'ip -4 addr flush dev {}'.format(interface) @@ -124,7 +148,7 @@ class Tg(IPv4Node): interface) self._sudo_execute(cmd) - def set_route(self, network, prefix_length, gateway, interface): + def set_route(self, network, prefix_length, gateway, interface, count=1): netmask = self._get_netmask(prefix_length) cmd = 'route add -net {} netmask {} gw {}'.\ format(network, netmask, gateway) @@ -135,6 +159,13 @@ class Tg(IPv4Node): format(network, prefix_length)) def arp_ping(self, destination_address, source_interface): + """Execute 'arping' command to send one ARP packet from the TG node. + + :param destination_address: Destination IP address for the ARP packet. + :param source_interface: Name of an interface to send ARP packet from. + :type destination_address: str + :type source_interface: str + """ self._sudo_execute('arping -c 1 -I {} {}'.format(source_interface, destination_address)) @@ -152,38 +183,39 @@ class Dut(IPv4Node): super(Dut, self).__init__(node_info) def get_sw_if_index(self, interface): - """Get sw_if_index of specified interface from current node + """Get sw_if_index of specified interface from current node. - :param interface: interface name + :param interface: Interface name. :type interface: str - :return: sw_if_index of 'int' type + :returns: sw_if_index of the interface or None. + :rtype: int """ return Topology().get_interface_sw_index(self.node_info, interface) def exec_vat(self, script, **args): """Wrapper for VAT executor. - :param script: script to execute - :param args: parameters to the script + :param script: Script to execute. + :param args: Parameters to the script. :type script: str :type args: dict - :return: nothing + :returns: nothing """ # TODO: check return value VatExecutor.cmd_from_template(self.node_info, script, **args) - def set_arp(self, interface, ip_address, mac_address): + def set_arp(self, iface_key, ip_address, mac_address): """Set entry in ARP cache. - :param interface: Interface name. + :param iface_key: Interface key. :param ip_address: IP address. :param mac_address: MAC address. - :type interface: str + :type iface_key: str :type ip_address: str :type mac_address: str """ self.exec_vat('add_ip_neighbor.vat', - sw_if_index=self.get_sw_if_index(interface), + sw_if_index=self.get_sw_if_index(iface_key), ip_address=ip_address, mac_address=mac_address) def set_ip(self, interface, address, prefix_length): @@ -191,10 +223,10 @@ class Dut(IPv4Node): sw_if_index=self.get_sw_if_index(interface), address=address, prefix_length=prefix_length) - def set_route(self, network, prefix_length, gateway, interface): + def set_route(self, network, prefix_length, gateway, interface, count=1): Routing.vpp_route_add(self.node_info, - network=network, prefix_len=prefix_length, - gateway=gateway, interface=interface) + network=network, prefix_len=prefix_length, + gateway=gateway, interface=interface, count=count) def unset_route(self, network, prefix_length, gateway, interface): self.exec_vat('del_route.vat', network=network, @@ -202,6 +234,7 @@ class Dut(IPv4Node): sw_if_index=self.get_sw_if_index(interface)) def arp_ping(self, destination_address, source_interface): + """Does nothing.""" pass def flush_ip_addresses(self, interface): @@ -215,8 +248,9 @@ class Dut(IPv4Node): def get_node(node_info): """Creates a class instance derived from Node based on type. - :param node_info: dictionary containing information on nodes in topology - :return: Class instance that is derived from Node + :param node_info: Dictionary containing information on nodes in topology. + :type node_info: dict + :returns: Class instance that is derived from Node. """ if node_info['type'] == NodeType.TG: return Tg(node_info) @@ -231,14 +265,17 @@ class IPv4Setup(object): """IPv4 setup in topology.""" @staticmethod - def vpp_nodes_setup_ipv4_addresses(nodes, nodes_addr): - """Setup IPv4 addresses on all VPP nodes in topology. + def vpp_nodes_set_ipv4_addresses(nodes, nodes_addr): + """Set IPv4 addresses on all VPP nodes in topology. - :param nodes: Nodes of the test topology. - :param nodes_addr: Available nodes IPv4 adresses. - :type nodes: dict - :type nodes_addr: dict + :param nodes: Nodes of the test topology. + :param nodes_addr: Available nodes IPv4 addresses. + :type nodes: dict + :type nodes_addr: dict + :returns: Affected interfaces as list of (node, interface) tuples. + :rtype: list """ + interfaces = [] for net in nodes_addr.values(): for port in net['ports'].values(): host = port.get('node') @@ -250,30 +287,36 @@ class IPv4Setup(object): continue if node['type'] != NodeType.DUT: continue - get_node(node).set_ip(port['if'], port['addr'], net['prefix']) - InterfaceUtil.set_interface_state(node, port['if'], 'up') + iface_key = topo.get_interface_by_name(node, port['if']) + get_node(node).set_ip(iface_key, port['addr'], net['prefix']) + interfaces.append((node, port['if'])) + + return interfaces @staticmethod @keyword('Get IPv4 address of node "${node}" interface "${port}" ' 'from "${nodes_addr}"') - def get_ip_addr(node, interface, nodes_addr): + def get_ip_addr(node, iface_key, nodes_addr): """Return IPv4 address of the node port. + :param node: Node in the topology. - :param interface: Interface name of the node. - :param nodes_addr: Nodes IPv4 adresses. + :param iface_key: Interface key of the node. + :param nodes_addr: Nodes IPv4 addresses. :type node: dict - :type interface: str + :type iface_key: str :type nodes_addr: dict - :return: IPv4 address string + :returns: IPv4 address. + :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} IPv4 address is not set'.format( @@ -289,21 +332,32 @@ class IPv4Setup(object): :param nodes_info: Dictionary containing information on all nodes in topology. - :param nodes_addr: Nodes IPv4 adresses. + :param nodes_addr: Nodes IPv4 addresses. :type nodes_info: dict :type nodes_addr: dict """ for node in nodes_info.values(): if node['type'] == NodeType.TG: continue - for interface, interface_data in node['interfaces'].iteritems(): - if interface == 'mgmt': - continue - interface_name = interface_data['name'] + for iface_key in node['interfaces'].keys(): adj_node, adj_int = Topology.\ - get_adjacent_node_and_interface(nodes_info, node, - interface_name) - ip_address = IPv4Setup.get_ip_addr(adj_node, adj_int['name'], + get_adjacent_node_and_interface(nodes_info, node, iface_key) + ip_address = IPv4Setup.get_ip_addr(adj_node, adj_int, nodes_addr) - mac_address = adj_int['mac_address'] - get_node(node).set_arp(interface_name, ip_address, mac_address) \ No newline at end of file + mac_address = Topology.get_interface_mac(adj_node, adj_int) + get_node(node).set_arp(iface_key, ip_address, mac_address) + + @staticmethod + def add_arp_on_dut(node, iface_key, ip_address, mac_address): + """Set ARP cache entree on DUT node. + + :param node: VPP Node in the topology. + :param iface_key: Interface key. + :param ip_address: IP address of the interface. + :param mac_address: MAC address of the interface. + :type node: dict + :type iface_key: str + :type ip_address: str + :type mac_address: str + """ + get_node(node).set_arp(iface_key, ip_address, mac_address)