resources/libraries/python/InterfaceUtil.py

   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:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   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.
  13
  14 """Interface util library"""
  15
  16 from time import time, sleep
  17
  18 from robot.api import logger
  19
  20 from resources.libraries.python.ssh import SSH
  21 from resources.libraries.python.IPUtil import convert_ipv4_netmask_prefix
  22 from resources.libraries.python.ssh import exec_cmd_no_error
  23 from resources.libraries.python.topology import NodeType, Topology
  24 from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
  25 from resources.libraries.python.VatJsonUtil import VatJsonUtil
  26 from resources.libraries.python.parsers.JsonParser import JsonParser
  27
  28
  29 class InterfaceUtil(object):
  30     """General utilities for managing interfaces"""
  31
  32     __UDEV_IF_RULES_FILE = '/etc/udev/rules.d/10-network.rules'
  33
  34     @staticmethod
  35     def set_interface_state(node, interface, state, if_type="key"):
  36         """Set interface state on a node.
  37
  38         Function can be used for DUTs as well as for TGs.
  39
  40         :param node: Node where the interface is.
  41         :param interface: Interface key or sw_if_index or name.
  42         :param state: One of 'up' or 'down'.
  43         :param if_type: Interface type
  44         :type node: dict
  45         :type interface: str or int
  46         :type state: str
  47         :type if_type: str
  48         :returns: Nothing.
  49         :raises ValueError: If the interface type is unknown.
  50         :raises ValueError: If the state of interface is unexpected.
  51         :raises ValueError: If the node has an unknown node type.
  52         """
  53
  54         if if_type == "key":
  55             if isinstance(interface, basestring):
  56                 sw_if_index = Topology.get_interface_sw_index(node, interface)
  57                 iface_name = Topology.get_interface_name(node, interface)
  58             else:
  59                 sw_if_index = interface
  60         elif if_type == "name":
  61             iface_key = Topology.get_interface_by_name(node, interface)
  62             if iface_key is not None:
  63                 sw_if_index = Topology.get_interface_sw_index(node, iface_key)
  64             iface_name = interface
  65         else:
  66             raise ValueError("if_type unknown: {}".format(if_type))
  67
  68         if node['type'] == NodeType.DUT:
  69             if state == 'up':
  70                 state = 'admin-up'
  71             elif state == 'down':
  72                 state = 'admin-down'
  73             else:
  74                 raise ValueError('Unexpected interface state: {}'.format(state))
  75             VatExecutor.cmd_from_template(node, 'set_if_state.vat',
  76                                           sw_if_index=sw_if_index, state=state)
  77         elif node['type'] == NodeType.TG or node['type'] == NodeType.VM:
  78             cmd = 'ip link set {} {}'.format(iface_name, state)
  79             exec_cmd_no_error(node, cmd, sudo=True)
  80         else:
  81             raise ValueError('Node {} has unknown NodeType: "{}"'
  82                              .format(node['host'], node['type']))
  83
  84     @staticmethod
  85     def set_interface_ethernet_mtu(node, iface_key, mtu):
  86         """Set Ethernet MTU for specified interface.
  87
  88         Function can be used only for TGs.
  89
  90         :param node: Node where the interface is.
  91         :param iface_key: Interface key from topology file.
  92         :param mtu: MTU to set.
  93         :type node: dict
  94         :type iface_key: str
  95         :type mtu: int
  96         :returns: Nothing.
  97         :raises ValueError: If the node type is "DUT".
  98         :raises ValueError: If the node has an unknown node type.
  99         """
 100         if node['type'] == NodeType.DUT:
 101             raise ValueError('Node {}: Setting Ethernet MTU for interface '
 102                              'on DUT nodes not supported', node['host'])
 103         elif node['type'] == NodeType.TG:
 104             iface_name = Topology.get_interface_name(node, iface_key)
 105             cmd = 'ip link set {} mtu {}'.format(iface_name, mtu)
 106             exec_cmd_no_error(node, cmd, sudo=True)
 107         else:
 108             raise ValueError('Node {} has unknown NodeType: "{}"'
 109                              .format(node['host'], node['type']))
 110
 111     @staticmethod
 112     def set_default_ethernet_mtu_on_all_interfaces_on_node(node):
 113         """Set default Ethernet MTU on all interfaces on node.
 114
 115         Function can be used only for TGs.
 116
 117         :param node: Node where to set default MTU.
 118         :type node: dict
 119         :returns: Nothing.
 120         """
 121         for ifc in node['interfaces']:
 122             InterfaceUtil.set_interface_ethernet_mtu(node, ifc, 1500)
 123
 124     @staticmethod
 125     def vpp_node_interfaces_ready_wait(node, timeout=10):
 126         """Wait until all interfaces with admin-up are in link-up state.
 127
 128         :param node: Node to wait on.
 129         :param timeout: Waiting timeout in seconds (optional, default 10s).
 130         :type node: dict
 131         :type timeout: int
 132         :returns: Nothing.
 133         :raises: RuntimeError if the timeout period value has elapsed.
 134         """
 135         if_ready = False
 136         not_ready = []
 137         start = time()
 138         while not if_ready:
 139             out = InterfaceUtil.vpp_get_interface_data(node)
 140             if time() - start > timeout:
 141                 for interface in out:
 142                     if interface.get('admin_up_down') == 1:
 143                         if interface.get('link_up_down') != 1:
 144                             logger.debug('{0} link-down'.format(
 145                                 interface.get('interface_name')))
 146                 raise RuntimeError('timeout, not up {0}'.format(not_ready))
 147             not_ready = []
 148             for interface in out:
 149                 if interface.get('admin_up_down') == 1:
 150                     if interface.get('link_up_down') != 1:
 151                         not_ready.append(interface.get('interface_name'))
 152             if not not_ready:
 153                 if_ready = True
 154             else:
 155                 logger.debug('Interfaces still in link-down state: {0}, '
 156                              'waiting...'.format(not_ready))
 157                 sleep(1)
 158
 159     @staticmethod
 160     def vpp_nodes_interfaces_ready_wait(nodes, timeout=10):
 161         """Wait until all interfaces with admin-up are in link-up state for
 162         listed nodes.
 163
 164         :param nodes: List of nodes to wait on.
 165         :param timeout: Seconds to wait per node for all interfaces to come up.
 166         :type nodes: list
 167         :type timeout: int
 168         :returns: Nothing.
 169         """
 170         for node in nodes:
 171             InterfaceUtil.vpp_node_interfaces_ready_wait(node, timeout)
 172
 173     @staticmethod
 174     def all_vpp_interfaces_ready_wait(nodes, timeout=10):
 175         """Wait until all interfaces with admin-up are in link-up state for all
 176         nodes in the topology.
 177
 178         :param nodes: Nodes in the topology.
 179         :param timeout: Seconds to wait per node for all interfaces to come up.
 180         :type nodes: dict
 181         :type timeout: int
 182         :returns: Nothing.
 183         """
 184         for node in nodes.values():
 185             if node['type'] == NodeType.DUT:
 186                 InterfaceUtil.vpp_node_interfaces_ready_wait(node, timeout)
 187
 188     @staticmethod
 189     def vpp_get_interface_data(node, interface=None):
 190         """Get all interface data from a VPP node. If a name or
 191         sw_interface_index is provided, return only data for the matching
 192         interface.
 193
 194         :param node: VPP node to get interface data from.
 195         :param interface: Numeric index or name string of a specific interface.
 196         :type node: dict
 197         :type interface: int or str
 198         :returns: List of dictionaries containing data for each interface, or a
 199         single dictionary for the specified interface.
 200         :rtype: list or dict
 201         :raises TypeError: if the data type of interface is neither basestring
 202         nor int.
 203         """
 204         with VatTerminal(node) as vat:
 205             response = vat.vat_terminal_exec_cmd_from_template(
 206                 "interface_dump.vat")
 207
 208         data = response[0]
 209
 210         if interface is not None:
 211             if isinstance(interface, basestring):
 212                 param = "interface_name"
 213             elif isinstance(interface, int):
 214                 param = "sw_if_index"
 215             else:
 216                 raise TypeError
 217             for data_if in data:
 218                 if data_if[param] == interface:
 219                     return data_if
 220             return dict()
 221         return data
 222
 223     @staticmethod
 224     def vpp_get_interface_mac(node, interface=None):
 225         """Get MAC address for the given interface from actual interface dump.
 226
 227         :param node: VPP node to get interface data from.
 228         :param interface: Numeric index or name string of a specific interface.
 229         :type node: dict
 230         :type interface: int or str
 231         :returns: MAC address.
 232         :rtype: str
 233         """
 234
 235         if_data = InterfaceUtil.vpp_get_interface_data(node, interface)
 236         if if_data['sup_sw_if_index'] != if_data['sw_if_index']:
 237             if_data = InterfaceUtil.vpp_get_interface_data(
 238                 node, if_data['sup_sw_if_index'])
 239         mac_data = [str(hex(item))[2:] for item in if_data['l2_address'][:6]]
 240         mac_data_nice = []
 241         for item in mac_data:
 242             if len(item) == 1:
 243                 item = '0' + item
 244             mac_data_nice.append(item)
 245         mac = ":".join(mac_data_nice)
 246         return mac
 247
 248     @staticmethod
 249     def vpp_get_interface_ip_addresses(node, interface, ip_version):
 250         """Get list of IP addresses from an interface on a VPP node.
 251
 252          :param node: VPP node to get data from.
 253          :param interface: Name of an interface on the VPP node.
 254          :param ip_version: IP protocol version (ipv4 or ipv6).
 255          :type node: dict
 256          :type interface: str
 257          :type ip_version: str
 258          :returns: List of dictionaries, each containing IP address, subnet
 259          prefix length and also the subnet mask for ipv4 addresses.
 260          Note: A single interface may have multiple IP addresses assigned.
 261          :rtype: list
 262         """
 263
 264         try:
 265             sw_if_index = Topology.convert_interface_reference(
 266                 node, interface, "sw_if_index")
 267         except RuntimeError:
 268             if isinstance(interface, basestring):
 269                 sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
 270             else:
 271                 raise
 272
 273         with VatTerminal(node) as vat:
 274             response = vat.vat_terminal_exec_cmd_from_template(
 275                 "ip_address_dump.vat", ip_version=ip_version,
 276                 sw_if_index=sw_if_index)
 277
 278         data = response[0]
 279
 280         if ip_version == "ipv4":
 281             for item in data:
 282                 item["netmask"] = convert_ipv4_netmask_prefix(
 283                     item["prefix_length"])
 284         return data
 285
 286     @staticmethod
 287     def tg_set_interface_driver(node, pci_addr, driver):
 288         """Set interface driver on the TG node.
 289
 290         :param node: Node to set interface driver on (must be TG node).
 291         :param pci_addr: PCI address of the interface.
 292         :param driver: Driver name.
 293         :type node: dict
 294         :type pci_addr: str
 295         :type driver: str
 296         :returns: None.
 297         :raises RuntimeError: If unbinding from the current driver fails.
 298         :raises RuntimeError: If binding to the new driver fails.
 299         """
 300         old_driver = InterfaceUtil.tg_get_interface_driver(node, pci_addr)
 301         if old_driver == driver:
 302             return
 303
 304         ssh = SSH()
 305         ssh.connect(node)
 306
 307         # Unbind from current driver
 308         if old_driver is not None:
 309             cmd = 'sh -c "echo {0} > /sys/bus/pci/drivers/{1}/unbind"'\
 310                 .format(pci_addr, old_driver)
 311             (ret_code, _, _) = ssh.exec_command_sudo(cmd)
 312             if int(ret_code) != 0:
 313                 raise RuntimeError("'{0}' failed on '{1}'"
 314                                    .format(cmd, node['host']))
 315
 316         # Bind to the new driver
 317         cmd = 'sh -c "echo {0} > /sys/bus/pci/drivers/{1}/bind"'\
 318             .format(pci_addr, driver)
 319         (ret_code, _, _) = ssh.exec_command_sudo(cmd)
 320         if int(ret_code) != 0:
 321             raise RuntimeError("'{0}' failed on '{1}'"
 322                                .format(cmd, node['host']))
 323
 324     @staticmethod
 325     def tg_get_interface_driver(node, pci_addr):
 326         """Get interface driver from the TG node.
 327
 328         :param node: Node to get interface driver on (must be TG node).
 329         :param pci_addr: PCI address of the interface.
 330         :type node: dict
 331         :type pci_addr: str
 332         :returns: Interface driver or None if not found.
 333         :rtype: str
 334         :raises RuntimeError: If it is not possible to get the interface driver
 335         information from the node.
 336
 337         .. note::
 338             # lspci -vmmks 0000:00:05.0
 339             Slot:   00:05.0
 340             Class:  Ethernet controller
 341             Vendor: Red Hat, Inc
 342             Device: Virtio network device
 343             SVendor:        Red Hat, Inc
 344             SDevice:        Device 0001
 345             PhySlot:        5
 346             Driver: virtio-pci
 347         """
 348         ssh = SSH()
 349         ssh.connect(node)
 350
 351         cmd = 'lspci -vmmks {0}'.format(pci_addr)
 352
 353         (ret_code, stdout, _) = ssh.exec_command(cmd)
 354         if int(ret_code) != 0:
 355             raise RuntimeError("'{0}' failed on '{1}'"
 356                                .format(cmd, node['host']))
 357
 358         for line in stdout.splitlines():
 359             if len(line) == 0:
 360                 continue
 361             (name, value) = line.split("\t", 1)
 362             if name == 'Driver:':
 363                 return value
 364
 365         return None
 366
 367     @staticmethod
 368     def tg_set_interfaces_udev_rules(node):
 369         """Set udev rules for interfaces.
 370
 371         Create udev rules file in /etc/udev/rules.d where are rules for each
 372         interface used by TG node, based on MAC interface has specific name.
 373         So after unbind and bind again to kernel driver interface has same
 374         name as before. This must be called after TG has set name for each
 375         port in topology dictionary.
 376         udev rule example
 377         SUBSYSTEM=="net", ACTION=="add", ATTR{address}=="52:54:00:e1:8a:0f",
 378         NAME="eth1"
 379
 380         :param node: Node to set udev rules on (must be TG node).
 381         :type node: dict
 382         :raises RuntimeError: If setting of udev rules fails.
 383         """
 384         ssh = SSH()
 385         ssh.connect(node)
 386
 387         cmd = 'rm -f {0}'.format(InterfaceUtil.__UDEV_IF_RULES_FILE)
 388         (ret_code, _, _) = ssh.exec_command_sudo(cmd)
 389         if int(ret_code) != 0:
 390             raise RuntimeError("'{0}' failed on '{1}'"
 391                                .format(cmd, node['host']))
 392
 393         for interface in node['interfaces'].values():
 394             rule = 'SUBSYSTEM==\\"net\\", ACTION==\\"add\\", ATTR{address}' + \
 395                    '==\\"' + interface['mac_address'] + '\\", NAME=\\"' + \
 396                    interface['name'] + '\\"'
 397             cmd = 'sh -c "echo \'{0}\' >> {1}"'.format(
 398                 rule, InterfaceUtil.__UDEV_IF_RULES_FILE)
 399             (ret_code, _, _) = ssh.exec_command_sudo(cmd)
 400             if int(ret_code) != 0:
 401                 raise RuntimeError("'{0}' failed on '{1}'"
 402                                    .format(cmd, node['host']))
 403
 404         cmd = '/etc/init.d/udev restart'
 405         ssh.exec_command_sudo(cmd)
 406
 407     @staticmethod
 408     def tg_set_interfaces_default_driver(node):
 409         """Set interfaces default driver specified in topology yaml file.
 410
 411         :param node: Node to setup interfaces driver on (must be TG node).
 412         :type node: dict
 413         """
 414         for interface in node['interfaces'].values():
 415             InterfaceUtil.tg_set_interface_driver(node,
 416                                                   interface['pci_address'],
 417                                                   interface['driver'])
 418
 419     @staticmethod
 420     def update_vpp_interface_data_on_node(node):
 421         """Update vpp generated interface data for a given node in DICT__nodes.
 422
 423         Updates interface names, software if index numbers and any other details
 424         generated specifically by vpp that are unknown before testcase run.
 425         It does this by dumping interface list to JSON output from all
 426         devices using vpp_api_test, and pairing known information from topology
 427         (mac address/pci address of interface) to state from VPP.
 428
 429         :param node: Node selected from DICT__nodes.
 430         :type node: dict
 431         """
 432         vat_executor = VatExecutor()
 433         vat_executor.execute_script_json_out("dump_interfaces.vat", node)
 434         interface_dump_json = vat_executor.get_script_stdout()
 435         VatJsonUtil.update_vpp_interface_data_from_json(node,
 436                                                         interface_dump_json)
 437
 438     @staticmethod
 439     def update_tg_interface_data_on_node(node):
 440         """Update interface name for TG/linux node in DICT__nodes.
 441
 442         :param node: Node selected from DICT__nodes.
 443         :type node: dict
 444         :raises RuntimeError: If getting of interface name and MAC fails.
 445
 446         .. note::
 447             # for dev in `ls /sys/class/net/`;
 448             > do echo "\"`cat /sys/class/net/$dev/address`\": \"$dev\""; done
 449             "52:54:00:9f:82:63": "eth0"
 450             "52:54:00:77:ae:a9": "eth1"
 451             "52:54:00:e1:8a:0f": "eth2"
 452             "00:00:00:00:00:00": "lo"
 453
 454         .. todo:: parse lshw -json instead
 455         """
 456         # First setup interface driver specified in yaml file
 457         InterfaceUtil.tg_set_interfaces_default_driver(node)
 458
 459         # Get interface names
 460         ssh = SSH()
 461         ssh.connect(node)
 462
 463         cmd = ('for dev in `ls /sys/class/net/`; do echo "\\"`cat '
 464                '/sys/class/net/$dev/address`\\": \\"$dev\\""; done;')
 465
 466         (ret_code, stdout, _) = ssh.exec_command(cmd)
 467         if int(ret_code) != 0:
 468             raise RuntimeError('Get interface name and MAC failed')
 469         tmp = "{" + stdout.rstrip().replace('\n', ',') + "}"
 470         interfaces = JsonParser().parse_data(tmp)
 471         for interface in node['interfaces'].values():
 472             name = interfaces.get(interface['mac_address'])
 473             if name is None:
 474                 continue
 475             interface['name'] = name
 476
 477         # Set udev rules for interfaces
 478         InterfaceUtil.tg_set_interfaces_udev_rules(node)
 479
 480     @staticmethod
 481     def iface_update_numa_node(node):
 482         """For all interfaces from topology file update numa node based on
 483            information from the node.
 484
 485         :param node: Node from topology.
 486         :type node: dict
 487         :returns: Nothing.
 488         :raises ValueError: If numa node ia less than 0.
 489         :raises RuntimeError: If update of numa node failes.
 490         """
 491         ssh = SSH()
 492         for if_key in Topology.get_node_interfaces(node):
 493             if_pci = Topology.get_interface_pci_addr(node, if_key)
 494             ssh.connect(node)
 495             cmd = "cat /sys/bus/pci/devices/{}/numa_node".format(if_pci)
 496             for _ in range(3):
 497                 (ret, out, _) = ssh.exec_command(cmd)
 498                 if ret == 0:
 499                     try:
 500                         numa_node = int(out)
 501                         if numa_node < 0:
 502                             raise ValueError
 503                     except ValueError:
 504                         logger.trace('Reading numa location failed for: {0}'\
 505                             .format(if_pci))
 506                     else:
 507                         Topology.set_interface_numa_node(node, if_key,
 508                                                          numa_node)
 509                         break
 510             else:
 511                 raise RuntimeError('Update numa node failed for: {0}'\
 512                     .format(if_pci))
 513
 514     @staticmethod
 515     def update_all_numa_nodes(nodes, skip_tg=False):
 516         """For all nodes and all their interfaces from topology file update numa
 517         node information based on information from the node.
 518
 519         :param nodes: Nodes in the topology.
 520         :param skip_tg: Skip TG node
 521         :type nodes: dict
 522         :type skip_tg: bool
 523         :returns: Nothing.
 524         """
 525         for node in nodes.values():
 526             if node['type'] == NodeType.DUT:
 527                 InterfaceUtil.iface_update_numa_node(node)
 528             elif node['type'] == NodeType.TG and not skip_tg:
 529                 InterfaceUtil.iface_update_numa_node(node)
 530
 531     @staticmethod
 532     def update_all_interface_data_on_all_nodes(nodes, skip_tg=False,
 533                                                numa_node=False):
 534         """Update interface names on all nodes in DICT__nodes.
 535
 536         This method updates the topology dictionary by querying interface lists
 537         of all nodes mentioned in the topology dictionary.
 538
 539         :param nodes: Nodes in the topology.
 540         :param skip_tg: Skip TG node
 541         :param numa_node: Retrieve numa_node location.
 542         :type nodes: dict
 543         :type skip_tg: bool
 544         :type numa_node: bool
 545         """
 546         for node_data in nodes.values():
 547             if node_data['type'] == NodeType.DUT:
 548                 InterfaceUtil.update_vpp_interface_data_on_node(node_data)
 549             elif node_data['type'] == NodeType.TG and not skip_tg:
 550                 InterfaceUtil.update_tg_interface_data_on_node(node_data)
 551
 552             if numa_node:
 553                 if node_data['type'] == NodeType.DUT:
 554                     InterfaceUtil.iface_update_numa_node(node_data)
 555                 elif node_data['type'] == NodeType.TG and not skip_tg:
 556                     InterfaceUtil.iface_update_numa_node(node_data)
 557
 558     @staticmethod
 559     def create_vlan_subinterface(node, interface, vlan):
 560         """Create VLAN subinterface on node.
 561
 562         :param node: Node to add VLAN subinterface on.
 563         :param interface: Interface name on which create VLAN subinterface.
 564         :param vlan: VLAN ID of the subinterface to be created.
 565         :type node: dict
 566         :type interface: str
 567         :type vlan: int
 568         :returns: Name and index of created subinterface.
 569         :rtype: tuple
 570         :raises RuntimeError: if it is unable to create VLAN subinterface on the
 571         node.
 572         """
 573         iface_key = Topology.get_interface_by_name(node, interface)
 574         sw_if_index = Topology.get_interface_sw_index(node, iface_key)
 575
 576         output = VatExecutor.cmd_from_template(node, "create_vlan_subif.vat",
 577                                                sw_if_index=sw_if_index,
 578                                                vlan=vlan)
 579         if output[0]["retval"] == 0:
 580             sw_subif_index = output[0]["sw_if_index"]
 581             logger.trace('VLAN subinterface with sw_if_index {} and VLAN ID {} '
 582                          'created on node {}'.format(sw_subif_index,
 583                                                      vlan, node['host']))
 584         else:
 585             raise RuntimeError('Unable to create VLAN subinterface on node {}'
 586                                .format(node['host']))
 587
 588         with VatTerminal(node, False) as vat:
 589             vat.vat_terminal_exec_cmd('exec show interfaces')
 590
 591         return '{}.{}'.format(interface, vlan), sw_subif_index
 592
 593     @staticmethod
 594     def create_vxlan_interface(node, vni, source_ip, destination_ip):
 595         """Create VXLAN interface and return sw if index of created interface.
 596
 597         Executes "vxlan_add_del_tunnel src {src} dst {dst} vni {vni}" VAT
 598         command on the node.
 599
 600         :param node: Node where to create VXLAN interface.
 601         :param vni: VXLAN Network Identifier.
 602         :param source_ip: Source IP of a VXLAN Tunnel End Point.
 603         :param destination_ip: Destination IP of a VXLAN Tunnel End Point.
 604         :type node: dict
 605         :type vni: int
 606         :type source_ip: str
 607         :type destination_ip: str
 608         :returns: SW IF INDEX of created interface.
 609         :rtype: int
 610         :raises RuntimeError: if it is unable to create VxLAN interface on the
 611         node.
 612         """
 613         output = VatExecutor.cmd_from_template(node, "vxlan_create.vat",
 614                                                src=source_ip,
 615                                                dst=destination_ip,
 616                                                vni=vni)
 617         output = output[0]
 618
 619         if output["retval"] == 0:
 620             return output["sw_if_index"]
 621         else:
 622             raise RuntimeError('Unable to create VXLAN interface on node {0}'
 623                                .format(node))
 624
 625     @staticmethod
 626     def vxlan_dump(node, interface=None):
 627         """Get VxLAN data for the given interface.
 628
 629         :param node: VPP node to get interface data from.
 630         :param interface: Numeric index or name string of a specific interface.
 631         If None, information about all VxLAN interfaces is returned.
 632         :type node: dict
 633         :type interface: int or str
 634         :returns: Dictionary containing data for the given VxLAN interface or if
 635         interface=None, the list of dictionaries with all VxLAN interfaces.
 636         :rtype: dict or list
 637         :raises TypeError: if the data type of interface is neither basestring
 638         nor int.
 639         """
 640         param = "sw_if_index"
 641         if interface is None:
 642             param = ''
 643             sw_if_index = ''
 644         elif isinstance(interface, basestring):
 645             sw_if_index = Topology.get_interface_sw_index(node, interface)
 646         elif isinstance(interface, int):
 647             sw_if_index = interface
 648         else:
 649             raise TypeError("Wrong interface format {0}".format(interface))
 650
 651         with VatTerminal(node) as vat:
 652             response = vat.vat_terminal_exec_cmd_from_template(
 653                 "vxlan_dump.vat", param=param, sw_if_index=sw_if_index)
 654
 655         if sw_if_index:
 656             for vxlan in response[0]:
 657                 if vxlan["sw_if_index"] == sw_if_index:
 658                     return vxlan
 659             return {}
 660         return response[0]
 661
 662     @staticmethod
 663     def vhost_user_dump(node):
 664         """Get vhost-user data for the given node.
 665
 666         :param node: VPP node to get interface data from.
 667         :type node: dict
 668         :returns: List of dictionaries with all vhost-user interfaces.
 669         :rtype: list
 670         """
 671         with VatTerminal(node) as vat:
 672             response = vat.vat_terminal_exec_cmd_from_template(
 673                 "vhost_user_dump.vat")
 674
 675         return response[0]
 676
 677     @staticmethod
 678     def tap_dump(node, name=None):
 679         """Get all TAP interface data from the given node, or data about
 680         a specific TAP interface.
 681
 682         :param node: VPP node to get data from.
 683         :param name: Optional name of a specific TAP interface.
 684         :type node: dict
 685         :type name: str
 686         :returns: Dictionary of information about a specific TAP interface, or
 687         a List of dictionaries containing all TAP data for the given node.
 688         :rtype: dict or list
 689         """
 690         with VatTerminal(node) as vat:
 691             response = vat.vat_terminal_exec_cmd_from_template(
 692                 "tap_dump.vat")
 693         if name is None:
 694             return response[0]
 695         else:
 696             for item in response[0]:
 697                 if name == item['dev_name']:
 698                     return item
 699             return {}
 700
 701     @staticmethod
 702     def create_subinterface(node, interface, sub_id, outer_vlan_id=None,
 703                             inner_vlan_id=None, type_subif=None):
 704         """Create sub-interface on node. It is possible to set required
 705         sub-interface type and VLAN tag(s).
 706
 707         :param node: Node to add sub-interface.
 708         :param interface: Interface name on which create sub-interface.
 709         :param sub_id: ID of the sub-interface to be created.
 710         :param outer_vlan_id: Optional outer VLAN ID.
 711         :param inner_vlan_id: Optional inner VLAN ID.
 712         :param type_subif: Optional type of sub-interface. Values supported by
 713         VPP: [no_tags] [one_tag] [two_tags] [dot1ad] [exact_match] [default_sub]
 714         :type node: dict
 715         :type interface: str or int
 716         :type sub_id: int
 717         :type outer_vlan_id: int
 718         :type inner_vlan_id: int
 719         :type type_subif: str
 720         :returns: Name and index of created sub-interface.
 721         :rtype: tuple
 722         :raises RuntimeError: If it is not possible to create sub-interface.
 723         """
 724
 725         outer_vlan_id = 'outer_vlan_id {0}'.format(outer_vlan_id)\
 726             if outer_vlan_id else ''
 727
 728         inner_vlan_id = 'inner_vlan_id {0}'.format(inner_vlan_id)\
 729             if inner_vlan_id else ''
 730
 731         if type_subif is None:
 732             type_subif = ''
 733
 734         if isinstance(interface, basestring):
 735             iface_key = Topology.get_interface_by_name(node, interface)
 736             sw_if_index = Topology.get_interface_sw_index(node, iface_key)
 737         else:
 738             sw_if_index = interface
 739
 740         output = VatExecutor.cmd_from_template(node, "create_sub_interface.vat",
 741                                                sw_if_index=sw_if_index,
 742                                                sub_id=sub_id,
 743                                                outer_vlan_id=outer_vlan_id,
 744                                                inner_vlan_id=inner_vlan_id,
 745                                                type_subif=type_subif)
 746
 747         if output[0]["retval"] == 0:
 748             sw_subif_index = output[0]["sw_if_index"]
 749             logger.trace('Created subinterface with index {}'
 750                          .format(sw_subif_index))
 751         else:
 752             raise RuntimeError('Unable to create sub-interface on node {}'
 753                                .format(node['host']))
 754
 755         with VatTerminal(node, json_param=False) as vat:
 756             vat.vat_terminal_exec_cmd('exec show interfaces')
 757
 758         name = '{}.{}'.format(interface, sub_id)
 759         return name, sw_subif_index
 760
 761     @staticmethod
 762     def create_gre_tunnel_interface(node, source_ip, destination_ip):
 763         """Create GRE tunnel interface on node.
 764
 765         :param node: VPP node to add tunnel interface.
 766         :param source_ip: Source of the GRE tunnel.
 767         :param destination_ip: Destination of the GRE tunnel.
 768         :type node: dict
 769         :type source_ip: str
 770         :type destination_ip: str
 771         :returns: Name and index of created GRE tunnel interface.
 772         :rtype: tuple
 773         :raises RuntimeError: If unable to create GRE tunnel interface.
 774         """
 775         output = VatExecutor.cmd_from_template(node, "create_gre.vat",
 776                                                src=source_ip,
 777                                                dst=destination_ip)
 778         output = output[0]
 779
 780         if output["retval"] == 0:
 781             sw_if_index = output["sw_if_index"]
 782
 783             vat_executor = VatExecutor()
 784             vat_executor.execute_script_json_out("dump_interfaces.vat", node)
 785             interface_dump_json = vat_executor.get_script_stdout()
 786             name = VatJsonUtil.get_interface_name_from_json(
 787                 interface_dump_json, sw_if_index)
 788             return name, sw_if_index
 789         else:
 790             raise RuntimeError('Unable to create GRE tunnel on node {}.'
 791                                .format(node))
 792
 793     @staticmethod
 794     def vpp_create_loopback(node):
 795         """Create loopback interface on VPP node.
 796
 797         :param node: Node to create loopback interface on.
 798         :type node: dict
 799         :returns: SW interface index.
 800         :rtype: int
 801         :raises RuntimeError: If it is not possible to create loopback on the
 802         node.
 803         """
 804         out = VatExecutor.cmd_from_template(node, "create_loopback.vat")
 805         if out[0].get('retval') == 0:
 806             return out[0].get('sw_if_index')
 807         else:
 808             raise RuntimeError('Create loopback failed on node "{}"'
 809                                .format(node['host']))
 810
 811     @staticmethod
 812     def vpp_enable_input_acl_interface(node, interface, ip_version,
 813                                        table_index):
 814         """Enable input acl on interface.
 815
 816         :param node: VPP node to setup interface for input acl.
 817         :param interface: Interface to setup input acl.
 818         :param ip_version: Version of IP protocol.
 819         :param table_index: Classify table index.
 820         :type node: dict
 821         :type interface: str or int
 822         :type ip_version: str
 823         :type table_index: int
 824         """
 825         if isinstance(interface, basestring):
 826             sw_if_index = Topology.get_interface_sw_index(node, interface)
 827         else:
 828             sw_if_index = interface
 829
 830         with VatTerminal(node) as vat:
 831             vat.vat_terminal_exec_cmd_from_template("input_acl_int.vat",
 832                                                     sw_if_index=sw_if_index,
 833                                                     ip_version=ip_version,
 834                                                     table_index=table_index)
 835
 836     @staticmethod
 837     def get_interface_classify_table(node, interface):
 838         """Get name of classify table for the given interface.
 839
 840         :param node: VPP node to get data from.
 841         :param interface: Name or sw_if_index of a specific interface.
 842         :type node: dict
 843         :type interface: str or int
 844         :returns: Classify table name.
 845         :rtype: str
 846         """
 847         if isinstance(interface, basestring):
 848             sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
 849         else:
 850             sw_if_index = interface
 851
 852         with VatTerminal(node) as vat:
 853             data = vat.vat_terminal_exec_cmd_from_template(
 854                 "classify_interface_table.vat",
 855                 sw_if_index=sw_if_index)
 856         return data[0]
 857
 858     @staticmethod
 859     def get_interface_vrf_table(node, interface):
 860         """Get vrf ID for the given interface.
 861
 862         :param node: VPP node.
 863         :param interface: Name or sw_if_index of a specific interface.
 864         :type node: dict
 865         :type interface: str or int
 866         :returns: vrf ID of the specified interface.
 867         :rtype: int
 868         """
 869
 870         if isinstance(interface, basestring):
 871             sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
 872         else:
 873             sw_if_index = interface
 874
 875         with VatTerminal(node) as vat:
 876             data = vat.vat_terminal_exec_cmd_from_template(
 877                 "interface_vrf_dump.vat",
 878                 sw_if_index=sw_if_index)
 879         return data[0]["vrf_id"]
 880
 881     @staticmethod
 882     def get_sw_if_index(node, interface_name):
 883         """Get sw_if_index for the given interface from actual interface dump.
 884
 885         :param node: VPP node to get interface data from.
 886         :param interface_name: Name of the specific interface.
 887         :type node: dict
 888         :type interface_name: str
 889         :returns: sw_if_index of the given interface.
 890         :rtype: str
 891         """
 892
 893         with VatTerminal(node) as vat:
 894             if_data = vat.vat_terminal_exec_cmd_from_template(
 895                 "interface_dump.vat")
 896         for interface in if_data[0]:
 897             if interface["interface_name"] == interface_name:
 898                 return interface["sw_if_index"]
 899
 900         return None
 901
 902     @staticmethod
 903     def vxlan_gpe_dump(node, interface_name=None):
 904         """Get VxLAN GPE data for the given interface.
 905
 906         :param node: VPP node to get interface data from.
 907         :param interface_name: Name of the specific interface. If None,
 908         information about all VxLAN GPE interfaces is returned.
 909         :type node: dict
 910         :type interface_name: str
 911         :returns: Dictionary containing data for the given VxLAN GPE interface
 912         or if interface=None, the list of dictionaries with all VxLAN GPE
 913         interfaces.
 914         :rtype: dict or list
 915         """
 916
 917         with VatTerminal(node) as vat:
 918             vxlan_gpe_data = vat.vat_terminal_exec_cmd_from_template(
 919                 "vxlan_gpe_dump.vat")
 920
 921         if interface_name:
 922             sw_if_index = InterfaceUtil.get_sw_if_index(node, interface_name)
 923             if sw_if_index:
 924                 for vxlan_gpe in vxlan_gpe_data[0]:
 925                     if vxlan_gpe["sw_if_index"] == sw_if_index:
 926                         return vxlan_gpe
 927             return {}
 928
 929         return vxlan_gpe_data[0]
 930
 931     @staticmethod
 932     def vpp_proxy_arp_interface_enable(node, interface):
 933         """Enable proxy ARP on interface.
 934
 935         :param node: VPP node to enable proxy ARP on interface.
 936         :param interface: Interface to enable proxy ARP.
 937         :type node: dict
 938         :type interface: str or int
 939         """
 940         if isinstance(interface, basestring):
 941             sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
 942         else:
 943             sw_if_index = interface
 944
 945         with VatTerminal(node) as vat:
 946             vat.vat_terminal_exec_cmd_from_template(
 947                 "proxy_arp_intfc_enable.vat",
 948                 sw_if_index=sw_if_index)
 949
 950     @staticmethod
 951     def vpp_ip_source_check_setup(node, interface):
 952         """Setup Reverse Path Forwarding source check on interface.
 953
 954         :param node: Node to setup RPF source check.
 955         :param interface: Interface name to setup RPF source check.
 956         :type node: dict
 957         :type interface: str
 958         """
 959         with VatTerminal(node) as vat:
 960             vat.vat_terminal_exec_cmd_from_template("ip_source_check.vat",
 961                                                     interface_name=interface)
 962
 963     @staticmethod
 964     def assign_interface_to_fib_table(node, interface, table_id, ipv6=False):
 965         """Assign VPP interface to specific VRF/FIB table.
 966
 967         :param node: VPP node where the FIB and interface are located.
 968         :param interface: Interface to be assigned to FIB.
 969         :param table_id: VRF table ID.
 970         :param ipv6: Assign to IPv6 table. Default False.
 971         :type node: dict
 972         :type interface: str or int
 973         :type table_id: int
 974         :type ipv6: bool
 975         """
 976         if isinstance(interface, basestring):
 977             sw_if_index = Topology.get_interface_sw_index(node, interface)
 978         else:
 979             sw_if_index = interface
 980
 981         ipv6 = 'ipv6' if ipv6 else ''
 982
 983         with VatTerminal(node) as vat:
 984             ret = vat.vat_terminal_exec_cmd_from_template(
 985                 "set_fib_to_interface.vat",
 986                 sw_index=sw_if_index, vrf=table_id, ipv6=ipv6)
 987
 988         if ret[0]["retval"] != 0:
 989             raise RuntimeError('Unable to assign interface to FIB node {}.'
 990                                .format(node))
 991
 992
 993     @staticmethod
 994     def set_linux_interface_mac(node, interface, mac, namespace=None):
 995         """Set MAC address for interface in linux.
 996
 997         :param node: Node where to execute command.
 998         :param interface: Interface in namespace.
 999         :param mac: MAC to be assigned to interface.
1000         :param namespace: Execute command in namespace. Optional
1001         :type node: dict
1002         :type interface: str
1003         :type mac: str
1004         :type namespace: str
1005         """
1006         if namespace is not None:
1007             cmd = 'ip netns exec {} ip link set {} address {}'.format(
1008                 namespace, interface, mac)
1009         else:
1010             cmd = 'ip link set {} address {}'.format(interface, mac)
1011         exec_cmd_no_error(node, cmd, sudo=True)