CSIT-1450: PAPI executor
[csit.git] / resources / libraries / python / VPPUtil.py
index de3caad..1bc1b43 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2018 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:
 # limitations under the License.
 
 """VPP util library."""
-from resources.libraries.python.constants import Constants
+
+import time
+
+from robot.api import logger
+
+from resources.libraries.python.Constants import Constants
 from resources.libraries.python.DUTSetup import DUTSetup
-from resources.libraries.python.ssh import exec_cmd_no_error
+from resources.libraries.python.PapiExecutor import PapiExecutor
+from resources.libraries.python.ssh import exec_cmd, exec_cmd_no_error
 from resources.libraries.python.topology import NodeType
 from resources.libraries.python.VatExecutor import VatExecutor
 
@@ -52,14 +58,27 @@ class VPPUtil(object):
             exec_cmd_no_error(node, command, timeout=30, sudo=True)
 
     @staticmethod
-    def start_vpp_service(node):
+    def start_vpp_service(node, retries=60):
         """Start VPP service on the specified node.
 
         :param node: VPP node.
+        :param retries: Number of times (default 60) to re-try waiting.
         :type node: dict
+        :type retries: int
         :raises RuntimeError: If VPP service fails to start.
         """
         DUTSetup.start_service(node, Constants.VPP_UNIT)
+        # Sleep 1 second, up to <retry> times,
+        # and verify if VPP is running.
+        for _ in range(retries):
+            time.sleep(1)
+            command = 'vppctl show pci'
+            ret, stdout, _ = exec_cmd(node, command, timeout=30, sudo=True)
+            if not ret and 'Connection refused' not in stdout:
+                break
+        else:
+            raise RuntimeError('VPP failed to start on host {name}'.
+                               format(name=node['host']))
         DUTSetup.get_service_logs(node, Constants.VPP_UNIT)
 
     @staticmethod
@@ -69,7 +88,9 @@ class VPPUtil(object):
         :param nodes: Nodes in the topology.
         :type nodes: dict
         """
-        DUTSetup.start_service_on_all_duts(nodes, Constants.VPP_UNIT)
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VPPUtil.start_vpp_service(node)
 
     @staticmethod
     def stop_vpp_service(node):
@@ -81,6 +102,17 @@ class VPPUtil(object):
         """
         DUTSetup.stop_service(node, Constants.VPP_UNIT)
 
+    @staticmethod
+    def stop_vpp_service_on_all_duts(nodes):
+        """Stop VPP service on all nodes.
+
+        :param nodes: Nodes in the topology.
+        :type nodes: dict
+        """
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VPPUtil.stop_vpp_service(node)
+
     @staticmethod
     def verify_vpp_on_dut(node):
         """Verify that VPP is installed on DUT node.
@@ -102,29 +134,45 @@ class VPPUtil(object):
         """
         for node in nodes.values():
             if node['type'] == NodeType.DUT:
-                DUTSetup.start_service(node, Constants.VPP_UNIT)
-                VPPUtil.vpp_show_version_verbose(node)
-                VPPUtil.vpp_show_interfaces(node)
+                VPPUtil.start_vpp_service(node)
+                VPPUtil.verify_vpp_on_dut(node)
 
     @staticmethod
-    def vpp_show_version_verbose(node):
-        """Run "show version verbose" CLI command.
+    def vpp_show_version(node, verbose=False):
+        """Run "show_version" PAPI command.
 
         :param node: Node to run command on.
+        :param verbose: Show version, compile date and compile location if True
+            otherwise show only version.
         :type node: dict
+        :type verbose: bool
         """
-        vat = VatExecutor()
-        vat.execute_script("show_version_verbose.vat", node, json_out=False)
 
-        try:
-            vat.script_should_have_passed()
-        except AssertionError:
-            raise RuntimeError('Failed to get VPP version on host: {name}'.
-                               format(name=node['host']))
+        with PapiExecutor(node) as papi_exec:
+            papi_resp = papi_exec.add('show_version').execute_should_pass()
+        data = papi_resp.reply[0]['api_reply']['show_version_reply']
+        version = ('VPP version:      {ver}\n'.
+                   format(ver=data['version'].rstrip('\0x00')))
+        if verbose:
+            version += ('Compile date:     {date}\n'
+                        'Compile location: {loc}\n '.
+                        format(date=data['build_date'].rstrip('\0x00'),
+                               loc=data['build_directory'].rstrip('\0x00')))
+        logger.info(version)
+
+    @staticmethod
+    def vpp_show_version_verbose(node):
+        """Run "show_version" API command and return verbose string of version
+        data.
+
+        :param node: Node to run command on.
+        :type node: dict
+        """
+        VPPUtil.vpp_show_version(node, verbose=True)
 
     @staticmethod
     def show_vpp_version_on_all_duts(nodes):
-        """Show VPP version verbose on all DUTs.
+        """Show VPP version on all DUTs.
 
         :param nodes: VPP nodes.
         :type nodes: dict
@@ -202,3 +250,60 @@ class VPPUtil(object):
         for node in nodes.values():
             if node['type'] == NodeType.DUT:
                 VPPUtil.vpp_enable_traces_on_dut(node)
+
+    @staticmethod
+    def vpp_enable_elog_traces_on_dut(node):
+        """Enable API/CLI/Barrier traces on the DUT node.
+
+        :param node: DUT node to set up.
+        :type node: dict
+        """
+        vat = VatExecutor()
+        vat.execute_script("elog_trace_api_cli_barrier.vat", node,
+                           json_out=False)
+
+    @staticmethod
+    def vpp_enable_elog_traces_on_all_duts(nodes):
+        """Enable API/CLI/Barrier traces on all DUTs in the given topology.
+
+        :param nodes: Nodes in the topology.
+        :type nodes: dict
+        """
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VPPUtil.vpp_enable_elog_traces_on_dut(node)
+
+    @staticmethod
+    def show_event_logger_on_dut(node):
+        """Show event logger on the DUT node.
+
+        :param node: DUT node to show traces on.
+        :type node: dict
+        """
+        vat = VatExecutor()
+        vat.execute_script("show_event_logger.vat", node, json_out=False)
+
+    @staticmethod
+    def show_event_logger_on_all_duts(nodes):
+        """Show event logger on all DUTs in the given topology.
+
+        :param nodes: Nodes in the topology.
+        :type nodes: dict
+        """
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VPPUtil.show_event_logger_on_dut(node)
+
+    @staticmethod
+    def vpp_show_threads(node):
+        """Show VPP threads on node.
+
+        :param node: Node to run command on.
+        :type node: dict
+        :returns: VPP thread data.
+        :rtype: list
+        """
+
+        with PapiExecutor(node) as papi_exec:
+            resp = papi_exec.add('show_threads').execute_should_pass()
+        return resp.reply[0]['api_reply']['show_threads_reply']['thread_data']