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:
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
14 """DUT PAPI command history setup library."""
16 from robot.api import logger
18 from resources.libraries.python.topology import NodeType, DICT__nodes
20 __all__ = ["DICT__DUTS_PAPI_HISTORY", "PapiHistory"]
23 DICT__DUTS_PAPI_HISTORY = dict()
26 class PapiHistory(object):
27 """Contains methods to set up DUT PAPI command history.
31 def reset_papi_history(node):
32 """Reset PAPI command history for DUT node.
34 :param node: DUT node to reset PAPI command history for.
37 DICT__DUTS_PAPI_HISTORY[node['host']] = list()
40 def reset_papi_history_on_all_duts(nodes):
41 """Reset PAPI command history for all DUT nodes.
43 :param nodes: Nodes to reset PAPI command history for.
46 for node in nodes.values():
47 if node['type'] == NodeType.DUT:
48 PapiHistory.reset_papi_history(node)
51 def add_to_papi_history(node, csit_papi_command, papi=True, **kwargs):
52 """Add command to PAPI command history on DUT node.
54 The argument name 'csit_papi_command' must be unique enough as it cannot
55 be repeated in kwargs.
57 :param node: DUT node to add command to PAPI command history for.
58 :param csit_papi_command: Command to be added to PAPI command history.
59 :param papi: Says if the command to store is PAPi or VAT. Remove when
60 VAT executor is completely removed.
61 :param kwargs: Optional key-value arguments.
63 :type csit_papi_command: str
69 for key, val in kwargs.iteritems():
70 args.append("{key}={val}".format(key=key, val=val))
71 item = "{cmd}({args})".format(cmd=csit_papi_command,
74 # This else part is here to store VAT commands.
75 # VAT history is not used.
76 # TODO: Remove when VatExecutor is completely removed.
77 item = "{cmd}".format(cmd=csit_papi_command)
78 DICT__DUTS_PAPI_HISTORY[node['host']].append(item)
81 def show_papi_history(node):
82 """Show PAPI command history for DUT node.
84 :param node: DUT node to show PAPI command history for.
87 history = "\nNo PAPI command executed"
88 if DICT__DUTS_PAPI_HISTORY[node['host']]:
89 history = "".join(["\n{}".format(
90 cmd) for cmd in DICT__DUTS_PAPI_HISTORY[node['host']]])
92 "{0} PAPI command history:\n{1}\n".format(node['host'], history))
95 def show_papi_history_on_all_duts(nodes):
96 """Show PAPI command history for all DUT nodes.
98 :param nodes: Nodes to show PAPI command history for.
101 for node in nodes.values():
102 if node['type'] == NodeType.DUT:
103 PapiHistory.show_papi_history(node)
106 PapiHistory.reset_papi_history_on_all_duts(DICT__nodes)