resources/libraries/python/PapiHistory.py

   1 # Copyright (c) 2019 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """DUT PAPI command history setup library."""
  15
  16 from robot.api import logger
  17
  18 from resources.libraries.python.topology import NodeType, DICT__nodes
  19
  20 __all__ = ["DICT__DUTS_PAPI_HISTORY", "PapiHistory"]
  21
  22
  23 DICT__DUTS_PAPI_HISTORY = dict()
  24
  25
  26 class PapiHistory(object):
  27     """Contains methods to set up DUT PAPI command history.
  28     """
  29
  30     @staticmethod
  31     def reset_papi_history(node):
  32         """Reset PAPI command history for DUT node.
  33
  34         :param node: DUT node to reset PAPI command history for.
  35         :type node: dict
  36         """
  37         DICT__DUTS_PAPI_HISTORY[node['host']] = list()
  38
  39     @staticmethod
  40     def reset_papi_history_on_all_duts(nodes):
  41         """Reset PAPI command history for all DUT nodes.
  42
  43         :param nodes: Nodes to reset PAPI command history for.
  44         :type nodes: dict
  45         """
  46         for node in nodes.values():
  47             if node['type'] == NodeType.DUT:
  48                 PapiHistory.reset_papi_history(node)
  49
  50     @staticmethod
  51     def add_to_papi_history(node, csit_papi_command, papi=True, **kwargs):
  52         """Add command to PAPI command history on DUT node.
  53
  54         The argument name 'csit_papi_command' must be unique enough as it cannot
  55         be repeated in kwargs.
  56
  57         Examples of PAPI history items:
  58
  59         Request without parameters:
  60             show_threads()
  61
  62         Request with parameters:
  63             ipsec_select_backend(index=1,protocol=1)
  64
  65         Dump:
  66             sw_interface_rx_placement_dump(sw_if_index=4)
  67
  68         VPP Stats:
  69             vpp-stats(path=['^/if', '/err/ip4-input', '/sys/node/ip4-input'])
  70
  71         VAT:
  72             sw_interface_set_flags sw_if_index 3 admin-up link-up
  73
  74         :param node: DUT node to add command to PAPI command history for.
  75         :param csit_papi_command: Command to be added to PAPI command history.
  76         :param papi: Says if the command to store is PAPi or VAT. Remove when
  77             VAT executor is completely removed.
  78         :param kwargs: Optional key-value arguments.
  79         :type node: dict
  80         :type csit_papi_command: str
  81         :type papi: bool
  82         :type kwargs: dict
  83         """
  84         if papi:
  85             args = list()
  86             for key, val in kwargs.iteritems():
  87                 args.append("{key}={val}".format(key=key, val=val))
  88             item = "{cmd}({args})".format(cmd=csit_papi_command,
  89                                           args=",".join(args))
  90         else:
  91             # This else part is here to store VAT commands.
  92             # VAT history is not used.
  93             # TODO: Remove when VatExecutor is completely removed.
  94             item = "{cmd}".format(cmd=csit_papi_command)
  95         DICT__DUTS_PAPI_HISTORY[node['host']].append(item)
  96
  97     @staticmethod
  98     def show_papi_history(node):
  99         """Show PAPI command history for DUT node.
 100
 101         :param node: DUT node to show PAPI command history for.
 102         :type node: dict
 103         """
 104         history_list = DICT__DUTS_PAPI_HISTORY[node['host']]
 105         if not history_list:
 106             history_list = ("No PAPI command executed", )
 107         logger.info(
 108             "{0} PAPI command history:\n{1}\n".format(
 109                 node['host'], "\n".join(history_list)))
 110
 111     @staticmethod
 112     def show_papi_history_on_all_duts(nodes):
 113         """Show PAPI command history for all DUT nodes.
 114
 115         :param nodes: Nodes to show PAPI command history for.
 116         :type nodes: dict
 117         """
 118         for node in nodes.values():
 119             if node['type'] == NodeType.DUT:
 120                 PapiHistory.show_papi_history(node)
 121
 122
 123 PapiHistory.reset_papi_history_on_all_duts(DICT__nodes)