PAPI: Fix PyLint errors

[csit.git] / resources / libraries / python / VhostUser.py

diff --git a/resources/libraries/python/VhostUser.py b/resources/libraries/python/VhostUser.py
index cf4ca0b..0c7a79e 100644 (file)
--- a/resources/libraries/python/VhostUser.py
+++ b/resources/libraries/python/VhostUser.py
@@ -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:
@@ -13,11 +13,41 @@
 
 """Vhost-user interfaces library."""
 
-from resources.libraries.python.VatExecutor import VatExecutor
+from robot.api import logger
+
+from resources.libraries.python.PapiExecutor import PapiExecutor
+from resources.libraries.python.topology import NodeType, Topology
+from resources.libraries.python.InterfaceUtil import InterfaceUtil
 
 
 class VhostUser(object):
-    """Vhost-user interfaces"""
+    """Vhost-user interfaces L1 library."""
+
+    @staticmethod
+    def _sw_interface_vhost_user_dump(node):
+        """Get the Vhost-user dump on the given node.
+
+        :param node: Given node to get Vhost dump from.
+        :type node: dict
+        :returns: List of Vhost-user interfaces data extracted from Papi
+            response.
+        :rtype: list
+        """
+        with PapiExecutor(node) as papi_exec:
+            dump = papi_exec.add("sw_interface_vhost_user_dump").get_dump()
+
+        key = "sw_interface_vhost_user_details"
+        data = list()
+        for item in dump.reply[0]["api_reply"]:
+            item[key]["interface_name"] = \
+                item[key]["interface_name"].rstrip('\x00')
+            item[key]["sock_filename"] = \
+                item[key]["sock_filename"].rstrip('\x00')
+            data.append(item)
+
+        logger.debug("VhostUser data:\n{data}".format(data=data))
+
+        return data
 
     @staticmethod
     def vpp_create_vhost_user_interface(node, socket):
@@ -27,13 +57,83 @@ class VhostUser(object):
         :param socket: Vhost-user interface socket path.
         :type node: dict
         :type socket: str
-        :return: SW interface index.
+        :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 = 'create_vhost_user_if'
+        err_msg = 'Failed to create Vhost-user interface on host {host}'.format(
+            host=node['host'])
+        args = dict(
+            sock_filename=str(socket)
+        )
+        with PapiExecutor(node) as papi_exec:
+            data = papi_exec.add(cmd, **args).get_replies(err_msg).\
+                verify_reply(err_msg=err_msg)
+
+        # Extract sw_if_idx:
+        sw_if_idx = data["sw_if_index"]
+
+        # Update the Topology:
+        if_key = Topology.add_new_port(node, 'vhost')
+        Topology.update_interface_sw_if_index(node, if_key, sw_if_idx)
+
+        ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_idx)
+        Topology.update_interface_name(node, if_key, ifc_name)
+
+        ifc_mac = InterfaceUtil.vpp_get_interface_mac(node, sw_if_idx)
+        Topology.update_interface_mac_address(node, if_key, ifc_mac)
+
+        Topology.update_interface_vhost_socket(node, if_key, socket)
+
+        return sw_if_idx
+
+    @staticmethod
+    def get_vhost_user_if_name_by_sock(node, socket):
+        """Get Vhost-user interface name by socket.
+
+        :param node: Node to get Vhost-user interface name on.
+        :param socket: Vhost-user interface socket path.
+        :type node: dict
+        :type socket: str
+        :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')
+        return None
+
+    @staticmethod
+    def get_vhost_user_mac_by_sw_index(node, sw_if_index):
+        """Get Vhost-user l2_address for the given interface from actual
+        interface dump.
+
+        :param node: VPP node to get interface data from.
+        :param sw_if_index: SW index of the specific interface.
+        :type node: dict
+        :type sw_if_index: str
+        :returns: l2_address of the given interface.
+        :rtype: str
+        """
+
+        return InterfaceUtil.vpp_get_interface_mac(node, sw_if_index)
+
+    @staticmethod
+    def vpp_show_vhost(node):
+        """Get Vhost-user data for the given node.
+
+        :param node: VPP node to get interface data from.
+        :type node: dict
+        """
+        VhostUser._sw_interface_vhost_user_dump(node)
+
+    @staticmethod
+    def show_vpp_vhost_on_all_duts(nodes):
+        """Show Vhost-user on all DUTs.
+
+        :param nodes: VPP nodes.
+        :type nodes: dict
+        """
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VhostUser.vpp_show_vhost(node)