-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2019 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
"""Tap utilities library."""
-from resources.libraries.python.VatExecutor import VatTerminal
+from ipaddress import ip_address
+from robot.api import logger
+
+from resources.libraries.python.Constants import Constants
from resources.libraries.python.InterfaceUtil import InterfaceUtil
+from resources.libraries.python.L2Util import L2Util
+from resources.libraries.python.PapiExecutor import PapiSocketExecutor
from resources.libraries.python.topology import Topology
-class Tap(object):
+class Tap:
"""Tap utilities."""
@staticmethod
:returns: Returns a interface index.
:rtype: int
"""
- command = 'connect'
- if mac is not None:
- args = 'tapname {} mac {}'.format(tap_name, mac)
- else:
- args = 'tapname {}'.format(tap_name)
- with VatTerminal(node) as vat:
- resp = vat.vat_terminal_exec_cmd_from_template('tap.vat',
- tap_command=command,
- tap_arguments=args)
- sw_if_idx = resp[0]['sw_if_index']
- if_key = Topology.add_new_port(node, 'tap')
- Topology.update_interface_sw_if_index(node, if_key, sw_if_idx)
- ifc_name = Tap.vpp_get_tap_interface_name(node, sw_if_idx)
- Topology.update_interface_name(node, if_key, ifc_name)
+ cmd = u"tap_create_v2"
+ args = dict(
+ id=Constants.BITWISE_NON_ZERO,
+ use_random_mac=0 if mac else 1,
+ mac_address=L2Util.mac_to_bin(mac) if mac else 6 * b"\0",
+ host_namespace=64 * b"\0",
+ host_mac_addr=6 * b"\0",
+ host_if_name_set=1,
+ host_if_name=tap_name.encode(encoding=u"utf-8") +
+ (64 - len(tap_name)) * b"\0",
+ host_bridge=64 * b"\0",
+ host_ip4_addr=4 * b"\0",
+ host_ip6_addr=16 * b"\0",
+ host_ip4_gw=4 * b"\0",
+ host_ip6_gw=16 * b"\0"
+ )
+ err_msg = f"Failed to create tap interface {tap_name} " \
+ f"on host {node[u'host']}"
+
+ with PapiSocketExecutor(node) as papi_exec:
+ sw_if_index = papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
+
+ if_key = Topology.add_new_port(node, u"tap")
+ Topology.update_interface_sw_if_index(node, if_key, sw_if_index)
+ Topology.update_interface_name(node, if_key, tap_name)
if mac is None:
- mac = Tap.vpp_get_tap_interface_mac(node, sw_if_idx)
+ mac = Tap.vpp_get_tap_interface_mac(node, tap_name)
Topology.update_interface_mac_address(node, if_key, mac)
- Topology.update_interface_tap_dev_name(node, if_key, tap_name)
-
- return sw_if_idx
-
- @staticmethod
- def modify_tap_interface(node, if_index, tap_name, mac=None):
- """Modify tap interface like linux interface name or VPP MAC.
-
- :param node: Node to modify tap on.
- :param if_index: Index of tap interface to be modified.
- :param tap_name: Tap interface name for linux tap.
- :param mac: Optional MAC address for VPP tap.
- :type node: dict
- :type if_index: int
- :type tap_name: str
- :type mac: str
- :return: Returns a interface index.
- :rtype: int
- """
- command = 'modify'
- if mac is not None:
- args = 'sw_if_index {} tapname {} mac {}'.format(
- if_index, tap_name, mac)
- else:
- args = 'sw_if_index {} tapname {}'.format(if_index, tap_name)
- with VatTerminal(node) as vat:
- resp = vat.vat_terminal_exec_cmd_from_template('tap.vat',
- tap_command=command,
- tap_arguments=args)
- if_key = Topology.get_interface_by_sw_index(node, if_index)
- Topology.update_interface_tap_dev_name(node, if_key, tap_name)
- if mac:
- Topology.update_interface_mac_address(node, if_key, mac)
-
- return resp[0]['sw_if_index']
-
- @staticmethod
- def delete_tap_interface(node, if_index):
- """Delete tap interface.
+ tap_dev_name = Tap.vpp_get_tap_dev_name(node, tap_name)
+ Topology.update_interface_tap_dev_name(node, if_key, tap_dev_name)
- :param node: Node to delete tap on.
- :param if_index: Index of tap interface to be deleted.
- :type node: dict
- :type if_index: int
- :raises RuntimeError: Deletion was not successful.
- """
- command = 'delete'
- args = 'sw_if_index {}'.format(if_index)
- with VatTerminal(node) as vat:
- resp = vat.vat_terminal_exec_cmd_from_template('tap.vat',
- tap_command=command,
- tap_arguments=args)
- if int(resp[0]['retval']) != 0:
- raise RuntimeError(
- 'Could not remove tap interface: {}'.format(resp))
- if_key = Topology.get_interface_sw_index(node, if_index)
- Topology.remove_port(node, if_key)
+ return sw_if_index
@staticmethod
- def check_tap_present(node, tap_name):
- """Check whether specific tap interface exists.
+ def vpp_get_tap_dev_name(node, host_if_name):
+ """Get VPP tap interface name from hardware interfaces dump.
- :param node: Node to check tap on.
- :param tap_name: Tap interface name for linux tap.
+ :param node: DUT node.
+ :param host_if_name: Tap host interface name.
:type node: dict
- :type tap_name: str
- :raises RuntimeError: Specified interface was not found.
+ :type host_if_name: str
+ :returns: VPP tap interface dev_name.
+ :rtype: str
"""
- tap_if = InterfaceUtil.tap_dump(node, tap_name)
- if len(tap_if) == 0:
- raise RuntimeError(
- 'Tap interface :{} does not exist'.format(tap_name))
+ return Tap.tap_dump(node, host_if_name).get(u"dev_name")
@staticmethod
- def vpp_get_tap_interface_name(node, sw_if_idx):
- """Get VPP tap interface name from hardware interfaces dump.
+ def vpp_get_tap_interface_mac(node, interface_name):
+ """Get tap interface MAC address from interfaces dump.
:param node: DUT node.
- :param sw_if_idx: DUT node.
+ :param interface_name: Tap interface name.
:type node: dict
- :type sw_if_idx: int
- :returns: VPP tap interface name.
+ :type interface_name: str
+ :returns: Tap interface MAC address.
:rtype: str
"""
- with VatTerminal(node, json_param=False) as vat:
- response = vat.vat_terminal_exec_cmd_from_template(
- 'show_hardware_detail.vat')
-
- for line in str(response[0]).splitlines():
- if line.startswith('tap-'):
- line_split = line.split()
- if line_split[1] == sw_if_idx:
- return line_split[0]
-
- return None
+ return InterfaceUtil.vpp_get_interface_mac(node, interface_name)
@staticmethod
- def vpp_get_tap_interface_mac(node, sw_if_idx):
- """Get tap interface MAC address from hardware interfaces dump.
+ def tap_dump(node, name=None):
+ """Get all TAP interface data from the given node, or data about
+ a specific TAP interface.
- :param node: DUT node.
- :param sw_if_idx: DUT node.
+ :param node: VPP node to get data from.
+ :param name: Optional name of a specific TAP interface.
:type node: dict
- :type sw_if_idx: int
- :returns: Tap interface MAC address.
- :rtype: str
+ :type name: str
+ :returns: Dictionary of information about a specific TAP interface, or
+ a List of dictionaries containing all TAP data for the given node.
+ :rtype: dict or list
"""
- with VatTerminal(node, json_param=False) as vat:
- response = vat.vat_terminal_exec_cmd_from_template(
- 'show_hardware_detail.vat')
-
- tap_if_match = False
- for line in str(response[0]).splitlines():
- if tap_if_match:
- line_split = line.split()
- return line_split[-1]
- if line.startswith('tap-'):
- line_split = line.split()
- if line_split[1] == sw_if_idx:
- tap_if_match = True
-
- return None
+ def process_tap_dump(tap_dump):
+ """Process tap dump.
+
+ :param tap_dump: Tap interface dump.
+ :type tap_dump: dict
+ :returns: Processed tap interface dump.
+ :rtype: dict
+ """
+ tap_dump[u"host_mac_addr"] = L2Util.bin_to_mac(
+ tap_dump[u"host_mac_addr"]
+ )
+ tap_dump[u"host_ip4_addr"] = ip_address(tap_dump[u"host_ip4_addr"])
+ tap_dump[u"host_ip6_addr"] = ip_address(tap_dump[u"host_ip6_addr"])
+
+ return tap_dump
+
+ cmd = u"sw_interface_tap_v2_dump"
+ err_msg = f"Failed to get TAP dump on host {node[u'host']}"
+
+ with PapiSocketExecutor(node) as papi_exec:
+ details = papi_exec.add(cmd).get_details(err_msg)
+
+ data = list() if name is None else dict()
+ for dump in details:
+ if name is None:
+ data.append(process_tap_dump(dump))
+ elif dump.get(u"host_if_name") == name:
+ data = process_tap_dump(dump)
+ break
+
+ logger.debug(f"TAP data:\n{data}")
+ return data
Code Review / csit.git / blobdiff