Add output.xml with only INFO logging leve
[csit.git] / resources / libraries / python / VppCounters.py
index 4bb7d63..b65b58c 100644 (file)
@@ -16,7 +16,7 @@
 import time
 
 from robot.api import logger
-
+from resources.libraries.python.PapiExecutor import PapiExecutor
 from resources.libraries.python.topology import NodeType, Topology
 from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
 
@@ -27,16 +27,6 @@ class VppCounters(object):
     def __init__(self):
         self._stats_table = None
 
-    def vpp_nodes_clear_interface_counters(self, nodes):
-        """Clear interface counters on all VPP nodes in topology.
-
-        :param nodes: Nodes in topology.
-        :type nodes: dict
-        """
-        for node in nodes.values():
-            if node['type'] == NodeType.DUT:
-                self.vpp_clear_interface_counters(node)
-
     @staticmethod
     def vpp_show_errors(node):
         """Run "show errors" debug CLI command.
@@ -46,6 +36,7 @@ class VppCounters(object):
         """
         vat = VatExecutor()
         vat.execute_script("show_errors.vat", node, json_out=False)
+        vat.script_should_have_passed()
 
     @staticmethod
     def vpp_show_errors_verbose(node):
@@ -56,6 +47,24 @@ class VppCounters(object):
         """
         vat = VatExecutor()
         vat.execute_script("show_errors_verbose.vat", node, json_out=False)
+        vat.script_should_have_passed()
+
+    @staticmethod
+    def vpp_show_errors_on_all_duts(nodes, verbose=False):
+        """Show errors on all DUTs.
+
+        :param nodes: VPP nodes.
+        :param verbose: If True show verbose output.
+        :type nodes: dict
+        :type verbose: bool
+        """
+
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                if verbose:
+                    VppCounters.vpp_show_errors_verbose(node)
+                else:
+                    VppCounters.vpp_show_errors(node)
 
     @staticmethod
     def vpp_show_runtime(node):
@@ -66,6 +75,19 @@ class VppCounters(object):
         """
         vat = VatExecutor()
         vat.execute_script("show_runtime.vat", node, json_out=False)
+        logger.info(vat.get_script_stdout())
+        vat.script_should_have_passed()
+
+    @staticmethod
+    def show_runtime_counters_on_all_duts(nodes):
+        """Clear VPP runtime counters on all DUTs.
+
+        :param nodes: VPP nodes.
+        :type nodes: dict
+        """
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VppCounters.vpp_show_runtime(node)
 
     @staticmethod
     def vpp_show_runtime_verbose(node):
@@ -76,6 +98,8 @@ class VppCounters(object):
         """
         vat = VatExecutor()
         vat.execute_script("show_runtime_verbose.vat", node, json_out=False)
+        logger.info(vat.get_script_stdout())
+        vat.script_should_have_passed()
 
     @staticmethod
     def vpp_show_hardware_detail(node):
@@ -86,6 +110,7 @@ class VppCounters(object):
         """
         vat = VatExecutor()
         vat.execute_script("show_hardware_detail.vat", node, json_out=False)
+        vat.script_should_have_passed()
 
     @staticmethod
     def vpp_clear_runtime(node):
@@ -94,8 +119,28 @@ class VppCounters(object):
         :param node: Node to run command on.
         :type node: dict
         """
-        vat = VatExecutor()
-        vat.execute_script("clear_runtime.vat", node, json_out=False)
+        cmd = 'cli_inband'
+        cmd_reply = 'cli_inband_reply'
+        err_msg = "Failed to run '{cmd}' PAPI command on host {host}!".format(
+            host=node['host'], cmd=cmd)
+        args = dict(cmd='clear runtime')
+        with PapiExecutor(node) as papi_exec:
+            papi_resp = papi_exec.add(cmd, **args).execute_should_pass(err_msg)
+        data = papi_resp.reply[0]['api_reply'][cmd_reply]
+        if data['retval'] != 0:
+            raise RuntimeError("Failed to clear runtime on host {host}".
+                               format(host=node['host']))
+
+    @staticmethod
+    def clear_runtime_counters_on_all_duts(nodes):
+        """Run "clear runtime" CLI command on all DUTs.
+
+        :param nodes: VPP nodes.
+        :type nodes: dict
+        """
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VppCounters.vpp_clear_runtime(node)
 
     @staticmethod
     def vpp_clear_interface_counters(node):
@@ -104,32 +149,112 @@ class VppCounters(object):
         :param node: Node to clear interface counters on.
         :type node: dict
         """
+        cmd = 'cli_inband'
+        cmd_reply = 'cli_inband_reply'
+        err_msg = "Failed to run '{cmd}' PAPI command on host {host}!".format(
+            host=node['host'], cmd=cmd)
+        args = dict(cmd='clear interfaces')
+        with PapiExecutor(node) as papi_exec:
+            papi_resp = papi_exec.add(cmd, **args).execute_should_pass(err_msg)
+        data = papi_resp.reply[0]['api_reply'][cmd_reply]
+        if data['retval'] != 0:
+            raise RuntimeError("Failed to clear interfaces on host {host}".
+                               format(host=node['host']))
+
+    @staticmethod
+    def clear_interface_counters_on_all_duts(nodes):
+        """Clear interface counters on all DUTs.
+
+        :param nodes: VPP nodes.
+        :type nodes: dict
+        """
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VppCounters.vpp_clear_interface_counters(node)
+
+    @staticmethod
+    def vpp_clear_hardware_counters(node):
+        """Clear interface hardware counters on VPP node.
+
+        :param node: Node to clear hardware counters on.
+        :type node: dict
+        """
         vat = VatExecutor()
-        vat.execute_script('clear_interface.vat', node)
+        vat.execute_script('clear_hardware.vat', node)
         vat.script_should_have_passed()
 
+    @staticmethod
+    def clear_hardware_counters_on_all_duts(nodes):
+        """Clear hardware counters on all DUTs.
+
+        :param nodes: VPP nodes.
+        :type nodes: dict
+        """
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VppCounters.vpp_clear_hardware_counters(node)
+
+    @staticmethod
+    def vpp_clear_errors_counters(node):
+        """Clear errors counters on VPP node.
+
+        :param node: Node to clear errors counters on.
+        :type node: dict
+        """
+        vat = VatExecutor()
+        vat.execute_script('clear_errors.vat', node)
+        vat.script_should_have_passed()
+
+    @staticmethod
+    def clear_error_counters_on_all_duts(nodes):
+        """Clear VPP errors counters on all DUTs.
+
+        :param nodes: VPP nodes.
+        :type nodes: dict
+        """
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VppCounters.vpp_clear_errors_counters(node)
+
     def vpp_dump_stats_table(self, node):
         """Dump stats table on VPP node.
 
         :param node: Node to dump stats table on.
         :type node: dict
-        :return: Stats table.
+        :returns: Stats table.
         """
         with VatTerminal(node) as vat:
             vat.vat_terminal_exec_cmd('want_stats enable')
             for _ in range(0, 12):
                 stats_table = vat.vat_terminal_exec_cmd('dump_stats_table')
-                if_counters = stats_table['interface_counters']
-                if len(if_counters) > 0:
+                if stats_table['interface_counters']:
                     self._stats_table = stats_table
                     return stats_table
                 time.sleep(1)
             return None
 
     def vpp_get_ipv4_interface_counter(self, node, interface):
+        """
+
+        :param node: Node to get interface IPv4 counter on.
+        :param interface: Interface name.
+        :type node: dict
+        :type interface: str
+        :returns: Interface IPv4 counter.
+        :rtype: int
+        """
         return self.vpp_get_ipv46_interface_counter(node, interface, False)
 
     def vpp_get_ipv6_interface_counter(self, node, interface):
+        """
+
+        :param node: Node to get interface IPv6 counter on.
+        :param interface: Interface name.
+        :type node: dict
+        :type interface: str
+        :returns: Interface IPv6 counter.
+        :rtype: int
+        """
         return self.vpp_get_ipv46_interface_counter(node, interface, True)
 
     def vpp_get_ipv46_interface_counter(self, node, interface, is_ipv6=True):
@@ -141,7 +266,7 @@ class VppCounters(object):
         :type node: dict
         :type interface: str
         :type is_ipv6: bool
-        :return: Interface IPv4/IPv6 counter.
+        :returns: Interface IPv4/IPv6 counter.
         :rtype: int
         """
         version = 'ip6' if is_ipv6 else 'ip4'
@@ -152,13 +277,39 @@ class VppCounters(object):
             return 0
 
         if_counters = self._stats_table.get('interface_counters')
-        if if_counters is None or len(if_counters) == 0:
+        if not if_counters:
             logger.trace('No interface counters.')
             return 0
         for counter in if_counters:
             if counter['vnet_counter_type'] == version:
                 data = counter['data']
                 return data[if_index]
-        logger.trace('{i} {v} counter not found.'.format(i=interface,
-                                                         v=version))
+        logger.trace('{i} {v} counter not found.'.format(
+            i=interface, v=version))
         return 0
+
+    @staticmethod
+    def show_vpp_statistics(node):
+        """Show [error, hardware, interface] stats.
+
+        :param node: VPP node.
+        :type node: dict
+        """
+        VppCounters.vpp_show_errors(node)
+        VppCounters.vpp_show_hardware_detail(node)
+        VppCounters.vpp_show_runtime(node)
+
+    @staticmethod
+    def show_statistics_on_all_duts(nodes, sleeptime=5):
+        """Show VPP statistics on all DUTs.
+
+        :param nodes: VPP nodes.
+        :type nodes: dict
+        :param sleeptime: Time to wait for traffic to arrive back to TG.
+        :type sleeptime: int
+        """
+        logger.trace('Waiting for statistics to be collected')
+        time.sleep(sleeptime)
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VppCounters.show_vpp_statistics(node)