PAL: Get DPDK Version
[csit.git] / resources / libraries / python / DPDK / DPDKTools.py
index e7fa2f4..b6c351f 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2018 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 exists to provide the init DPDK.
-"""
+"""This module implements initialization and cleanup of DPDK environment."""
+
+from robot.api import logger
+
+from resources.libraries.python.ssh import SSH, exec_cmd_no_error
+from resources.libraries.python.Constants import Constants
+from resources.libraries.python.topology import NodeType, Topology
 
-from resources.libraries.python.ssh import SSH
-from resources.libraries.python.constants import Constants as con
-from resources.libraries.python.topology import Topology
 
 class DPDKTools(object):
-    """Test the DPDK l2fwd performance."""
+    """This class implements:
+    - Initialization of DPDK environment,
+    - Cleanup of DPDK environment.
+    """
 
     @staticmethod
     def initialize_dpdk_environment(dut_node, dut_if1, dut_if2):
@@ -35,21 +39,27 @@ class DPDKTools(object):
         :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.
         """
-        pci_address1 = Topology.get_interface_pci_addr(dut_node, dut_if1)
-        pci_address2 = Topology.get_interface_pci_addr(dut_node, dut_if2)
+        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)
+            ssh = SSH()
+            ssh.connect(dut_node)
 
-        cmd = 'cd {0}/dpdk-tests/dpdk_scripts/ && sudo ./init_dpdk.sh {1} {2}' \
-              .format(con.REMOTE_FW_DIR, pci_address1, pci_address2)
+            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(cmd, timeout=600)
-        if ret_code != 0:
-            raise Exception('Failed to bind the interfaces to igb_uio ' \
-                            'at node {0}'.format(dut_node['host']))
+            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']))
 
     @staticmethod
     def cleanup_dpdk_environment(dut_node, dut_if1, dut_if2):
@@ -63,21 +73,60 @@ class DPDKTools(object):
         :type dut_node: dict
         :type dut_if1: str
         :type dut_if2: str
-        :returns: none
+        :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']))
+
+    @staticmethod
+    def install_dpdk_test(node):
+        """
+        Prepare the DPDK test environment
+
+        :param node: Dictionary created from topology
+        :type node: dict
+        :returns: nothing
+        :raises RuntimeError: If command returns nonzero return code.
+        """
+        arch = Topology.get_node_arch(node)
+
+        command = ('{fwdir}/tests/dpdk/dpdk_scripts/install_dpdk.sh {arch}'.
+                   format(fwdir=Constants.REMOTE_FW_DIR, arch=arch))
+        message = 'Install the DPDK failed!'
+        exec_cmd_no_error(node, command, timeout=600, message=message)
+
+        command = ('cat {fwdir}/download_dir/dpdk*/VERSION'.
+                   format(fwdir=Constants.REMOTE_FW_DIR))
+        message = 'Get DPDK version failed!'
+        stdout, _ = exec_cmd_no_error(node, command, message=message)
+
+        logger.info('DPDK Version: {version}'.format(version=stdout))
+
+    @staticmethod
+    def install_dpdk_test_on_all_duts(nodes):
+        """
+        Prepare the DPDK test environment on all DUTs.
+
+        :param nodes: Nodes from topology file.
+        :type nodes: dict
+        :returns: nothing
         """
-        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 = 'cd {0}/dpdk-tests/dpdk_scripts/ && sudo ./cleanup_dpdk.sh ' \
-              '{1} {2} {3} {4}'.format(con.REMOTE_FW_DIR, if1_driver, \
-              pci_address1, if2_driver, pci_address2)
-
-        (ret_code, _, _) = ssh.exec_command(cmd, timeout=600)
-        if ret_code != 0:
-            raise Exception('Failed to cleanup the dpdk at node {0}'
-                            .format(dut_node['host']))
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                DPDKTools.install_dpdk_test(node)