FIX: Workaround AVF interface down until VPP-1934
[csit.git] / resources / libraries / python / VhostUser.py
index 385d0f2..cc9685d 100644 (file)
@@ -1,4 +1,4 @@
-# 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:
 
 """Vhost-user interfaces library."""
 
-from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
+from robot.api import logger
 
+from resources.libraries.python.PapiExecutor import PapiSocketExecutor
+from resources.libraries.python.topology import NodeType, Topology
+from resources.libraries.python.InterfaceUtil import InterfaceUtil
 
-class VhostUser(object):
-    """Vhost-user interfaces"""
+
+class VhostUser:
+    """Vhost-user interfaces L1 library."""
 
     @staticmethod
-    def vpp_create_vhost_user_interface(node, socket):
+    def vpp_create_vhost_user_interface(
+            node, socket, is_server=False, enable_gso=False):
         """Create Vhost-user interface on VPP node.
 
         :param node: Node to create Vhost-user interface on.
         :param socket: Vhost-user interface socket path.
+        :param is_server: Server side of connection. Default: False
+        :param enable_gso: Generic segmentation offloading. Default: False
         :type node: dict
         :type socket: str
-        :return: SW interface index.
+        :type is_server: bool
+        :type enable_gso: bool
+        :returns: SW interface index.
         :rtype: int
         """
-        out = VatExecutor.cmd_from_template(node, "create_vhost_user_if.vat",
-                                            sock=socket)
-        if out[0].get('retval') == 0:
-            return out[0].get('sw_if_index')
-        else:
-            raise RuntimeError('Create Vhost-user interface failed on node '
-                               '"{}"'.format(node['host']))
+        cmd = u"create_vhost_user_if"
+        err_msg = f"Failed to create Vhost-user interface " \
+            f"on host {node[u'host']}"
+        args = dict(
+            is_server=bool(is_server),
+            sock_filename=str(socket),
+            enable_gso=bool(enable_gso)
+        )
+
+        with PapiSocketExecutor(node) as papi_exec:
+            sw_if_index = papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
+
+        # Update the Topology:
+        if_key = Topology.add_new_port(node, u"vhost")
+        Topology.update_interface_sw_if_index(node, if_key, sw_if_index)
+
+        ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_index)
+        Topology.update_interface_name(node, if_key, ifc_name)
+
+        ifc_mac = InterfaceUtil.vpp_get_interface_mac(node, sw_if_index)
+        Topology.update_interface_mac_address(node, if_key, ifc_mac)
+
+        Topology.update_interface_vhost_socket(node, if_key, socket)
+
+        return sw_if_index
 
     @staticmethod
     def get_vhost_user_if_name_by_sock(node, socket):
@@ -46,12 +73,12 @@ class VhostUser(object):
         :param socket: Vhost-user interface socket path.
         :type node: dict
         :type socket: str
-        :return: Interface name or None if not found.
+        :returns: Interface name or None if not found.
         :rtype: str
         """
-        for interface in node['interfaces'].values():
-            if interface.get('socket') == socket:
-                return interface.get('name')
+        for interface in node[u"interfaces"].values():
+            if interface.get(u"socket") == socket:
+                return interface.get(u"name")
         return None
 
     @staticmethod
@@ -60,29 +87,39 @@ class VhostUser(object):
         interface dump.
 
         :param node: VPP node to get interface data from.
-        :param sw_if_index: Idx of the specific interface.
+        :param sw_if_index: SW index of the specific interface.
         :type node: dict
         :type sw_if_index: str
-        :return: l2_address of the given interface.
+        :returns: l2_address of the given interface.
         :rtype: str
         """
+        return InterfaceUtil.vpp_get_interface_mac(node, sw_if_index)
 
-        with VatTerminal(node) as vat:
-            if_data = vat.vat_terminal_exec_cmd_from_template(
-                "interface_dump.vat")
-        for iface in if_data[0]:
-            if iface["sw_if_index"] == sw_if_index:
-                return ':'.join("%02x" % (b) for b in iface["l2_address"][:6])
+    @staticmethod
+    def show_vpp_vhost_on_all_duts(nodes):
+        """Show Vhost-user on all DUTs.
 
-        return None
+        :param nodes: VPP nodes.
+        :type nodes: dict
+        """
+        for node in nodes.values():
+            if node[u"type"] == NodeType.DUT:
+                VhostUser.vhost_user_dump(node)
 
     @staticmethod
-    def vpp_show_vhost(node):
+    def vhost_user_dump(node):
         """Get vhost-user data for the given node.
 
         :param node: VPP node to get interface data from.
         :type node: dict
-        :return: nothing
+        :returns: List of dictionaries with all vhost-user interfaces.
+        :rtype: list
         """
-        vat = VatExecutor()
-        vat.execute_script("show_vhost.vat", node, json_out=False)
+        cmd = u"sw_interface_vhost_user_dump"
+        err_msg = f"Failed to get vhost-user dump on host {node['host']}"
+
+        with PapiSocketExecutor(node) as papi_exec:
+            details = papi_exec.add(cmd).get_details(err_msg)
+
+        logger.debug(f"Vhost-user details:\n{details}")
+        return details