CSIT-665: Re-write L1 robot keywords in python

[csit.git] / resources / libraries / python / VppCounters.py

diff --git a/resources/libraries/python/VppCounters.py b/resources/libraries/python/VppCounters.py
index 4bb7d63..8247a1e 100644 (file)
--- a/resources/libraries/python/VppCounters.py
+++ b/resources/libraries/python/VppCounters.py
@@ -16,7 +16,6 @@
 import time
 
 from robot.api import logger
-
 from resources.libraries.python.topology import NodeType, Topology
 from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
 
@@ -57,6 +56,23 @@ class VppCounters(object):
         vat = VatExecutor()
         vat.execute_script("show_errors_verbose.vat", node, json_out=False)
 
+    @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):
         """Run "show runtime" CLI command.
@@ -67,6 +83,17 @@ class VppCounters(object):
         vat = VatExecutor()
         vat.execute_script("show_runtime.vat", node, json_out=False)
 
+    @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):
         """Run "show runtime verbose" CLI command.
@@ -97,6 +124,17 @@ class VppCounters(object):
         vat = VatExecutor()
         vat.execute_script("clear_runtime.vat", node, json_out=False)
 
+    @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):
         """Clear interface counters on VPP node.
@@ -108,12 +146,67 @@ class VppCounters(object):
         vat.execute_script('clear_interface.vat', node)
         vat.script_should_have_passed()
 
+    @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_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')
@@ -127,9 +220,27 @@ class VppCounters(object):
             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 +252,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'
@@ -162,3 +273,29 @@ class VppCounters(object):
         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)