X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FTrace.py;h=c61a8deda438ac50e2094e7492cc8c72b156bfd2;hp=49b39cbdfbe240698bf7a9998844d7bb1f020783;hb=7bfb36dfd9284bbca10881e31e14108c7d468b7c;hpb=517ee7fd3eb28ecf030c5d50be09fcdabe508922 diff --git a/resources/libraries/python/Trace.py b/resources/libraries/python/Trace.py index 49b39cbdfb..c61a8deda4 100644 --- a/resources/libraries/python/Trace.py +++ b/resources/libraries/python/Trace.py @@ -11,14 +11,22 @@ # See the License for the specific language governing permissions and # limitations under the License. +"""Packet trace library.""" + from resources.libraries.python.VatExecutor import VatExecutor 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): + """Show VPP packet trace. + + :param nodes: Nodes from which the packet trace will be displayed. + :type nodes: list + """ for node in nodes.values(): if node['type'] == NodeType.DUT: vat = VatExecutor() @@ -26,8 +34,12 @@ class Trace(object): @staticmethod 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("clear_trace.vat", node, json_out=False) -