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