Refactor getting telemetry
[csit.git] / resources / libraries / python / VppCounters.py
index f847ca6..65d6477 100644 (file)
 
 """VPP counters utilities library."""
 
-import time
-
 from pprint import pformat
 
 from robot.api import logger
 from resources.libraries.python.PapiExecutor import PapiExecutor
 from resources.libraries.python.PapiExecutor import PapiSocketExecutor
-from resources.libraries.python.topology import NodeType, Topology
+from resources.libraries.python.topology import Topology, SocketType, NodeType
 
 
 class VppCounters(object):
@@ -29,17 +27,6 @@ class VppCounters(object):
     def __init__(self):
         self._stats_table = None
 
-    @staticmethod
-    def _get_non_zero_items(data):
-        """Extract and return non-zero items from the input data.
-
-        :param data: Data to filter.
-        :type data: dict
-        :returns: Dictionary with non-zero items.
-        :rtype dict
-        """
-        return {k: data[k] for k in data.keys() if sum(data[k])}
-
     @staticmethod
     def vpp_show_errors(node):
         """Run "show errors" debug CLI command.
@@ -47,32 +34,19 @@ class VppCounters(object):
         :param node: Node to run command on.
         :type node: dict
         """
-        PapiSocketExecutor.run_cli_cmd(node, 'show errors')
-
-    @staticmethod
-    def vpp_show_errors_verbose(node):
-        """Run "show errors verbose" debug CLI command.
-
-        :param node: Node to run command on.
-        :type node: dict
-        """
-        PapiSocketExecutor.run_cli_cmd(node, 'show errors verbose')
+        PapiSocketExecutor.run_cli_cmd_on_all_sockets(
+            node, 'show errors')
 
     @staticmethod
-    def vpp_show_errors_on_all_duts(nodes, verbose=False):
+    def vpp_show_errors_on_all_duts(nodes):
         """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)
+                VppCounters.vpp_show_errors(node)
 
     @staticmethod
     def vpp_show_runtime(node, log_zeros=False):
@@ -84,68 +58,63 @@ class VppCounters(object):
         :type log_zeros: bool
         """
         args = dict(path='^/sys/node')
-        with PapiExecutor(node) as papi_exec:
-            stats = papi_exec.add("vpp-stats", **args).get_stats()[0]
-            # TODO: Introduce get_stat?
-
-        names = stats['/sys/node/names']
-
-        if not names:
-            return
-
-        runtime = []
-        runtime_non_zero = []
-
-        for name in names:
-            runtime.append({'name': name})
-
-        for idx, runtime_item in enumerate(runtime):
-
-            calls_th = []
-            for thread in stats['/sys/node/calls']:
-                calls_th.append(thread[idx])
-            runtime_item["calls"] = calls_th
-
-            vectors_th = []
-            for thread in stats['/sys/node/vectors']:
-                vectors_th.append(thread[idx])
-            runtime_item["vectors"] = vectors_th
-
-            suspends_th = []
-            for thread in stats['/sys/node/suspends']:
-                suspends_th.append(thread[idx])
-            runtime_item["suspends"] = suspends_th
-
-            clocks_th = []
-            for thread in stats['/sys/node/clocks']:
-                clocks_th.append(thread[idx])
-            runtime_item["clocks"] = clocks_th
-
-            if (sum(calls_th) or sum(vectors_th) or
-                    sum(suspends_th) or sum(clocks_th)):
-                runtime_non_zero.append(runtime_item)
-
-        if log_zeros:
-            logger.info("Runtime:\n{runtime}".format(
-                runtime=pformat(runtime)))
-        else:
-            logger.info("Runtime:\n{runtime}".format(
-                runtime=pformat(runtime_non_zero)))
-
-    @staticmethod
-    def vpp_show_runtime_verbose(node):
-        """Run "show runtime verbose" CLI command.
-
-        TODO: Remove?
-              Only verbose output is possible to get using VPPStats.
-
-        :param node: Node to run command on.
-        :type node: dict
-        """
-        VppCounters.vpp_show_runtime(node)
+        sockets = Topology.get_node_sockets(node, socket_type=SocketType.STATS)
+        if sockets:
+            for socket in sockets.values():
+                with PapiExecutor(node) as papi_exec:
+                    stats = papi_exec.add("vpp-stats", **args).\
+                        get_stats(socket=socket)[0]
+
+                names = stats['/sys/node/names']
+
+                if not names:
+                    return
+
+                runtime = []
+                runtime_non_zero = []
+
+                for name in names:
+                    runtime.append({'name': name})
+
+                for idx, runtime_item in enumerate(runtime):
+
+                    calls_th = []
+                    for thread in stats['/sys/node/calls']:
+                        calls_th.append(thread[idx])
+                    runtime_item["calls"] = calls_th
+
+                    vectors_th = []
+                    for thread in stats['/sys/node/vectors']:
+                        vectors_th.append(thread[idx])
+                    runtime_item["vectors"] = vectors_th
+
+                    suspends_th = []
+                    for thread in stats['/sys/node/suspends']:
+                        suspends_th.append(thread[idx])
+                    runtime_item["suspends"] = suspends_th
+
+                    clocks_th = []
+                    for thread in stats['/sys/node/clocks']:
+                        clocks_th.append(thread[idx])
+                    runtime_item["clocks"] = clocks_th
+
+                    if (sum(calls_th) or sum(vectors_th) or
+                            sum(suspends_th) or sum(clocks_th)):
+                        runtime_non_zero.append(runtime_item)
+
+                if log_zeros:
+                    logger.info(
+                        "stats runtime ({host} - {socket}):\n{runtime}".format(
+                        host=node['host'], runtime=pformat(runtime),
+                        socket=socket))
+                else:
+                    logger.info(
+                        "stats runtime ({host} - {socket}):\n{runtime}".format(
+                        host=node['host'], runtime=pformat(runtime_non_zero),
+                        socket=socket))
 
     @staticmethod
-    def show_runtime_counters_on_all_duts(nodes):
+    def vpp_show_runtime_counters_on_all_duts(nodes):
         """Clear VPP runtime counters on all DUTs.
 
         :param nodes: VPP nodes.
@@ -162,7 +131,8 @@ class VppCounters(object):
         :param node: Node to run command on.
         :type node: dict
         """
-        PapiSocketExecutor.run_cli_cmd(node, 'show hardware verbose')
+        PapiSocketExecutor.run_cli_cmd_on_all_sockets(
+            node, 'show hardware verbose')
 
     @staticmethod
     def vpp_show_memory(node):
@@ -182,13 +152,12 @@ class VppCounters(object):
 
         :param node: Node to run command on.
         :type node: dict
-        :returns: Verified data from PAPI response.
-        :rtype: dict
         """
-        return PapiSocketExecutor.run_cli_cmd(node, 'clear runtime', log=False)
+        PapiSocketExecutor.run_cli_cmd_on_all_sockets(
+            node, 'clear runtime', log=False)
 
     @staticmethod
-    def clear_runtime_counters_on_all_duts(nodes):
+    def vpp_clear_runtime_counters_on_all_duts(nodes):
         """Run "clear runtime" CLI command on all DUTs.
 
         :param nodes: VPP nodes.
@@ -198,29 +167,6 @@ class VppCounters(object):
             if node['type'] == NodeType.DUT:
                 VppCounters.vpp_clear_runtime(node)
 
-    @staticmethod
-    def vpp_clear_interface_counters(node):
-        """Run "clear interfaces" CLI command.
-
-        :param node: Node to run command on.
-        :type node: dict
-        :returns: Verified data from PAPI response.
-        :rtype: dict
-        """
-        return PapiSocketExecutor.run_cli_cmd(
-            node, 'clear interfaces', log=False)
-
-    @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):
         """Run "clear hardware" CLI command.
@@ -230,10 +176,11 @@ class VppCounters(object):
         :returns: Verified data from PAPI response.
         :rtype: dict
         """
-        return PapiSocketExecutor.run_cli_cmd(node, 'clear hardware', log=False)
+        PapiSocketExecutor.run_cli_cmd_on_all_sockets(
+            node, 'clear hardware', log=False)
 
     @staticmethod
-    def clear_hardware_counters_on_all_duts(nodes):
+    def vpp_clear_hardware_counters_on_all_duts(nodes):
         """Clear hardware counters on all DUTs.
 
         :param nodes: VPP nodes.
@@ -249,13 +196,12 @@ class VppCounters(object):
 
         :param node: Node to run command on.
         :type node: dict
-        :returns: Verified data from PAPI response.
-        :rtype: dict
         """
-        return PapiSocketExecutor.run_cli_cmd(node, 'clear errors', log=False)
+        PapiSocketExecutor.run_cli_cmd_on_all_sockets(
+            node, 'clear errors', log=False)
 
     @staticmethod
-    def clear_error_counters_on_all_duts(nodes):
+    def vpp_clear_error_counters_on_all_duts(nodes):
         """Clear VPP errors counters on all DUTs.
 
         :param nodes: VPP nodes.
@@ -265,61 +211,6 @@ class VppCounters(object):
             if node['type'] == NodeType.DUT:
                 VppCounters.vpp_clear_errors_counters(node)
 
-    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):
-        """Return interface IPv4/IPv6 counter.
-
-        :param node: Node to get interface IPv4/IPv6 counter on.
-        :param interface: Interface name.
-        :param is_ipv6: Specify IP version.
-        :type node: dict
-        :type interface: str
-        :type is_ipv6: bool
-        :returns: Interface IPv4/IPv6 counter.
-        :rtype: int
-        """
-        version = 'ip6' if is_ipv6 else 'ip4'
-        topo = Topology()
-        sw_if_index = topo.get_interface_sw_index(node, interface)
-        if sw_if_index is None:
-            logger.trace('{i} sw_if_index not found.'.format(i=interface))
-            return 0
-
-        if_counters = self._stats_table.get('interface_counters')
-        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[sw_if_index]
-        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.
@@ -333,16 +224,34 @@ class VppCounters(object):
         VppCounters.vpp_show_memory(node)
 
     @staticmethod
-    def show_statistics_on_all_duts(nodes, sleeptime=5):
-        """Show VPP statistics on all DUTs.
+    def show_statistics_on_all_duts(nodes):
+        """Show statistics on all DUTs.
 
-        :param nodes: VPP nodes.
+        :param nodes: DUT 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)
+
+    @staticmethod
+    def clear_vpp_statistics(node):
+        """Clear [error, hardware, interface] stats.
+
+        :param node: VPP node.
+        :type node: dict
+        """
+        VppCounters.vpp_clear_errors_counters(node)
+        VppCounters.vpp_clear_hardware_counters(node)
+        VppCounters.vpp_clear_runtime(node)
+
+    @staticmethod
+    def clear_statistics_on_all_duts(nodes):
+        """Clear statistics on all DUTs.
+
+        :param nodes: DUT nodes.
+        :type nodes: dict
+        """
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                VppCounters.clear_vpp_statistics(node)