resources/libraries/python/Trace.py

   1 # Copyright (c) 2016 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.VatExecutor import VatExecutor, VatTerminal
  17 from resources.libraries.python.topology import NodeType
  18
  19
  20 class Trace(object):
  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: list
  30         :type maximum: int
  31         """
  32         maximum = "max {count}".format(count=maximum) if maximum is not None\
  33             else ""
  34         for node in nodes.values():
  35             if node['type'] == NodeType.DUT:
  36                 with VatTerminal(node, json_param=False) as vat:
  37                     vat.vat_terminal_exec_cmd_from_template(
  38                         'show_trace.vat', maximum=maximum)
  39
  40     @staticmethod
  41     def clear_packet_trace_on_all_duts(nodes):
  42         """Clear VPP packet trace.
  43
  44         :param nodes: Nodes where the packet trace will be cleared.
  45         :type nodes: list
  46         """
  47         for node in nodes.values():
  48             if node['type'] == NodeType.DUT:
  49                 vat = VatExecutor()
  50                 vat.execute_script("clear_trace.vat", node, json_out=False)