Fix Tap failing tests
[csit.git] / resources / libraries / python / Trace.py
index 8168b90..10a55ce 100644 (file)
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from resources.libraries.python.VatExecutor import VatExecutor
+"""Packet trace library."""
+
+from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
 from resources.libraries.python.topology import NodeType
 
+
 class Trace(object):
+    """This class provides methods to manipulate the VPP packet trace."""
+
+    @staticmethod
+    def show_packet_trace_on_all_duts(nodes, maximum=None):
+        """Show VPP packet trace.
+
+        :param nodes: Nodes from which the packet trace will be displayed.
+        :param maximum: Maximum number of packet traces to be displayed.
+        :type nodes: list
+        :type maximum: int
+        """
+        maximum = "max {count}".format(count=maximum) if maximum is not None\
+            else ""
+        for node in nodes.values():
+            if node['type'] == NodeType.DUT:
+                with VatTerminal(node, json_param=False) as vat:
+                    vat.vat_terminal_exec_cmd_from_template(
+                        'show_trace.vat', maximum=maximum)
 
     @staticmethod
-    def show_packet_trace_on_all_duts(nodes):
+    def clear_packet_trace_on_all_duts(nodes):
+        """Clear VPP packet trace.
+
+        :param nodes: Nodes where the packet trace will be cleared.
+        :type nodes: list
+        """
         for node in nodes.values():
             if node['type'] == NodeType.DUT:
                 vat = VatExecutor()
-                vat.execute_script("show_trace.vat", node, json_out=False)
+                vat.execute_script("clear_trace.vat", node, json_out=False)