FIX: Pylint reduce
[csit.git] / resources / libraries / python / DPDK / DPDKTools.py
index a256ae5..e22245c 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2018 Cisco and/or its affiliates.
+# Copyright (c) 2021 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:
 # limitations under the License.
 
 
-"""This module implements initialization and cleanup of DPDK environment."""
+"""This module implements initialization and cleanup of DPDK framework."""
 
-from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants
+from robot.api import logger
+
+from resources.libraries.python.Constants import Constants
+from resources.libraries.python.ssh import exec_cmd_no_error
 from resources.libraries.python.topology import NodeType, Topology
 
 
-class DPDKTools(object):
+class DPDKTools:
     """This class implements:
     - Initialization of DPDK environment,
     - Cleanup of DPDK environment.
     """
 
     @staticmethod
-    def initialize_dpdk_environment(dut_node, dut_if1, dut_if2):
+    def initialize_dpdk_framework(node, if1, if2, nic_driver):
         """
-        Initialize the DPDK test environment on the dut_node.
-        Load the module uio and igb_uio, then bind the test NIC to the igb_uio.
-
-        :param dut_node: Will init the DPDK on this node.
-        :param dut_if1: DUT interface name.
-        :param dut_if2: DUT interface name.
-        :type dut_node: dict
-        :type dut_if1: str
-        :type dut_if2: str
-        :returns: none
-        :raises RuntimeError: If it fails to bind the interfaces to igb_uio.
+        Initialize the DPDK framework on the DUT node. Bind interfaces to
+        driver.
+
+        :param node: DUT node.
+        :param if1: DUT first interface name.
+        :param if2: DUT second interface name.
+        :param nic_driver: Interface driver.
+        :type node: dict
+        :type if1: str
+        :type if2: str
+        :type nic_driver: str
+        :raises RuntimeError: If it fails to bind the interfaces to driver.
         """
-        if dut_node['type'] == NodeType.DUT:
-            pci_address1 = Topology.get_interface_pci_addr(dut_node, dut_if1)
-            pci_address2 = Topology.get_interface_pci_addr(dut_node, dut_if2)
-
-            ssh = SSH()
-            ssh.connect(dut_node)
-
-            arch = Topology.get_node_arch(dut_node)
-            cmd = '{fwdir}/tests/dpdk/dpdk_scripts/init_dpdk.sh '\
-                  '{pci1} {pci2} {arch}'.format(fwdir=Constants.REMOTE_FW_DIR,
-                                                pci1=pci_address1,
-                                                pci2=pci_address2,
-                                                arch=arch)
-
-            ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=600)
-            if ret_code != 0:
-                raise RuntimeError('Failed to bind the interfaces to igb_uio '
-                                   'at node {name}'.\
-                                    format(name=dut_node['host']))
+        if node[u"type"] == NodeType.DUT:
+            pci_address1 = Topology.get_interface_pci_addr(node, if1)
+            pci_address2 = Topology.get_interface_pci_addr(node, if2)
+
+            command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
+                f"/entry/init_dpdk.sh " \
+                f"{nic_driver} {pci_address1} {pci_address2}"
+            message = u"Initialize the DPDK failed!"
+            exec_cmd_no_error(node, command, timeout=600, message=message)
 
     @staticmethod
-    def cleanup_dpdk_environment(dut_node, dut_if1, dut_if2):
+    def cleanup_dpdk_framework(node, if1, if2):
         """
-        Cleanup the DPDK test environment on the DUT node.
-        Unbind the NIC from the igb_uio and bind them to the kernel driver.
-
-        :param dut_node: Will cleanup the DPDK on this node.
-        :param dut_if1: DUT interface name.
-        :param dut_if2: DUT interface name.
-        :type dut_node: dict
-        :type dut_if1: str
-        :type dut_if2: str
-        :returns: none
+        Cleanup the DPDK framework on the DUT node. Bind interfaces to
+        default driver specified in topology.
+
+        :param node: Will cleanup the DPDK on this node.
+        :param if1: DUT first interface name.
+        :param if2: DUT second interface name.
+        :type node: dict
+        :type if1: str
+        :type if2: str
         :raises RuntimeError: If it fails to cleanup the dpdk.
         """
-        if dut_node['type'] == NodeType.DUT:
-            pci_address1 = Topology.get_interface_pci_addr(dut_node, dut_if1)
-            if1_driver = Topology.get_interface_driver(dut_node, dut_if1)
-            pci_address2 = Topology.get_interface_pci_addr(dut_node, dut_if2)
-            if2_driver = Topology.get_interface_driver(dut_node, dut_if2)
-
-            ssh = SSH()
-            ssh.connect(dut_node)
-
-            cmd = '{fwdir}/tests/dpdk/dpdk_scripts/cleanup_dpdk.sh ' \
-                  '{drv1} {pci1} {drv2} {pci2}'.\
-                  format(fwdir=Constants.REMOTE_FW_DIR, drv1=if1_driver,
-                         pci1=pci_address1, drv2=if2_driver, pci2=pci_address2)
-
-            ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=600)
-            if ret_code != 0:
-                raise RuntimeError('Failed to cleanup the dpdk at node {name}'
-                                   .format(name=dut_node['host']))
+        if node[u"type"] == NodeType.DUT:
+            pci_address1 = Topology.get_interface_pci_addr(node, if1)
+            pci_address2 = Topology.get_interface_pci_addr(node, if2)
+            # We are not supporting more than one driver yet.
+            nic_driver = Topology.get_interface_driver(node, if1)
+
+            command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
+                f"/entry/cleanup_dpdk.sh " \
+                f"{nic_driver} {pci_address1} {pci_address2}"
+            message = u"Cleanup the DPDK failed!"
+            exec_cmd_no_error(node, command, timeout=1200, message=message)
+
+    @staticmethod
+    def install_dpdk_framework(node):
+        """
+        Prepare the DPDK framework on the DUT node.
+
+        :param node: Node from topology file.
+        :type node: dict
+        :raises RuntimeError: If command returns nonzero return code.
+        """
+        command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}" \
+            f"/entry/install_dpdk.sh"
+        message = u"Install the DPDK failed!"
+        exec_cmd_no_error(node, command, timeout=600, message=message)
+
+        command = f"cat {Constants.REMOTE_FW_DIR}/dpdk*/VERSION"
+        message = u"Get DPDK version failed!"
+        stdout, _ = exec_cmd_no_error(node, command, message=message)
+
+        logger.info(f"DPDK Version: {stdout}")
+
+    @staticmethod
+    def install_dpdk_framework_on_all_duts(nodes):
+        """
+        Prepare the DPDK framework on all DUTs.
+
+        :param nodes: Nodes from topology file.
+        :type nodes: dict
+        """
+        for node in list(nodes.values()):
+            if node[u"type"] == NodeType.DUT:
+                DPDKTools.install_dpdk_framework(node)