X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FPapiHistory.py;h=cacfbd6b194ff760aa2d504838b6e0c0b2f465a1;hp=eede0d250fe956fc799e62b99cc75a6c98f6bc24;hb=HEAD;hpb=86af0b9a49b5513e328359241a11a1ca44075bc5

diff --git a/resources/libraries/python/PapiHistory.py b/resources/libraries/python/PapiHistory.py
index eede0d250f..18b2774908 100644
--- a/resources/libraries/python/PapiHistory.py
+++ b/resources/libraries/python/PapiHistory.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2019 Cisco and/or its affiliates.
+# Copyright (c) 2023 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:
@@ -17,13 +17,13 @@ from robot.api import logger
 
 from resources.libraries.python.topology import NodeType, DICT__nodes
 
-__all__ = ["DICT__DUTS_PAPI_HISTORY", "PapiHistory"]
+__all__ = [u"DICT__DUTS_PAPI_HISTORY", u"PapiHistory"]
 
 
 DICT__DUTS_PAPI_HISTORY = dict()
 
 
-class PapiHistory(object):
+class PapiHistory:
     """Contains methods to set up DUT PAPI command history.
     """
 
@@ -34,7 +34,7 @@ class PapiHistory(object):
         :param node: DUT node to reset PAPI command history for.
         :type node: dict
         """
-        DICT__DUTS_PAPI_HISTORY[node['host']] = list()
+        DICT__DUTS_PAPI_HISTORY[node[u"host"]] = list()
 
     @staticmethod
     def reset_papi_history_on_all_duts(nodes):
@@ -44,38 +44,44 @@ class PapiHistory(object):
         :type nodes: dict
         """
         for node in nodes.values():
-            if node['type'] == NodeType.DUT:
+            if node[u"type"] == NodeType.DUT:
                 PapiHistory.reset_papi_history(node)
 
     @staticmethod
-    def add_to_papi_history(node, csit_papi_command, papi=True, **kwargs):
+    def add_to_papi_history(node, csit_papi_command, **kwargs):
         """Add command to PAPI command history on DUT node.
 
+        Repr strings are used for argument values.
+
         The argument name 'csit_papi_command' must be unique enough as it cannot
         be repeated in kwargs.
 
+        Examples of PAPI history items:
+
+        Request without parameters:
+            show_threads()
+
+        Request with parameters:
+            ipsec_select_backend(index=1,protocol=1)
+
+        Dump:
+            sw_interface_rx_placement_dump(sw_if_index=4)
+
+        VPP Stats:
+            vpp-stats(path=['^/if', '/err/ip4-input', '/sys/node/ip4-input'])
+
         :param node: DUT node to add command to PAPI command history for.
         :param csit_papi_command: Command to be added to PAPI command history.
-        :param papi: Says if the command to store is PAPi or VAT. Remove when
-            VAT executor is completely removed.
         :param kwargs: Optional key-value arguments.
         :type node: dict
         :type csit_papi_command: str
-        :type papi: bool
         :type kwargs: dict
         """
-        if papi:
-            args = list()
-            for key, val in kwargs.iteritems():
-                args.append("{key}={val}".format(key=key, val=val))
-            item = "{cmd}({args})".format(cmd=csit_papi_command,
-                                          args=",".join(args))
-        else:
-            # This else part is here to store VAT commands.
-            # VAT history is not used.
-            # TODO: Remove when VatExecutor is completely removed.
-            item = "{cmd}".format(cmd=csit_papi_command)
-        DICT__DUTS_PAPI_HISTORY[node['host']].append(item)
+        args = list()
+        for key, val in kwargs.items():
+            args.append(f"{key}={val!r}")
+        item = f"{csit_papi_command}({u','.join(args)})"
+        DICT__DUTS_PAPI_HISTORY[node[u"host"]].append(item)
 
     @staticmethod
     def show_papi_history(node):
@@ -84,12 +90,11 @@ class PapiHistory(object):
         :param node: DUT node to show PAPI command history for.
         :type node: dict
         """
-        history = "\nNo PAPI command executed"
-        if DICT__DUTS_PAPI_HISTORY[node['host']]:
-            history = "".join(["\n{}".format(
-                cmd) for cmd in DICT__DUTS_PAPI_HISTORY[node['host']]])
-        logger.trace(
-            "{0} PAPI command history:\n{1}\n".format(node['host'], history))
+        history_list = DICT__DUTS_PAPI_HISTORY[node[u"host"]]
+        if not history_list:
+            history_list = (u"No PAPI command executed", )
+        history = u'\n'.join(history_list)
+        logger.info(f"{node[u'host']} PAPI command history:\n{history}\n")
 
     @staticmethod
     def show_papi_history_on_all_duts(nodes):
@@ -99,8 +104,13 @@ class PapiHistory(object):
         :type nodes: dict
         """
         for node in nodes.values():
-            if node['type'] == NodeType.DUT:
+            if node[u"type"] == NodeType.DUT:
                 PapiHistory.show_papi_history(node)
 
 
-PapiHistory.reset_papi_history_on_all_duts(DICT__nodes)
+# This module can be imported outside usual Robot test context,
+# e.g. in pylint or by tools generating docs from docstrings.
+# For the tools to work, we need to avoid processing
+# when DICT__nodes value is not usable.
+if DICT__nodes:
+    PapiHistory.reset_papi_history_on_all_duts(DICT__nodes)