resources/libraries/python/Trace.py

   1 # Copyright (c) 2021 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 """Packet trace library."""
  15
  16 from resources.libraries.python.PapiExecutor import PapiSocketExecutor
  17 from resources.libraries.python.topology import NodeType
  18
  19
  20 class Trace:
  21     """This class provides methods to manipulate the VPP packet trace."""
  22
  23     @staticmethod
  24     def show_packet_trace_on_all_duts(nodes, maximum=None):
  25         """Show VPP packet trace.
  26
  27         :param nodes: Nodes from which the packet trace will be displayed.
  28         :param maximum: Maximum number of packet traces to be displayed.
  29         :type nodes: dict
  30         :type maximum: int
  31         """
  32         max_opt = f"" if maximum is None else f" max {maximum}"
  33         for node in nodes.values():
  34             if node[u"type"] == NodeType.DUT:
  35                 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
  36                     node, f"show trace{max_opt}")
  37
  38     @staticmethod
  39     def clear_packet_trace_on_all_duts(nodes):
  40         """Clear VPP packet trace.
  41
  42         :param nodes: Nodes where the packet trace will be cleared.
  43         :type nodes: dict
  44         """
  45         for node in nodes.values():
  46             if node[u"type"] == NodeType.DUT:
  47                 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
  48                     node, u"clear trace")