Python3: resources and libraries

[csit.git] / resources / tools / trex / trex_stateless_stop.py

diff --git a/resources/tools/trex/trex_stateless_stop.py b/resources/tools/trex/trex_stateless_stop.py
index cc00846..45f4838 100755 (executable)
--- a/resources/tools/trex/trex_stateless_stop.py
+++ b/resources/tools/trex/trex_stateless_stop.py
@@ -1,6 +1,6 @@
-#!/usr/bin/python
+#!/usr/bin/python3
 
-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2019 Cisco and/or its affiliates.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at:
@@ -17,75 +17,87 @@
 
 Requirements:
 - T-REX: https://github.com/cisco-system-traffic-generator/trex-core
- - compiled and running T-REX process (eg. ./t-rex-64 -i -c 4)
- - trex_stl_lib.api library
+ - compiled and running T-REX process (eg. ./t-rex-64 -i)
+ - trex.stl.api library
 - Script must be executed on a node with T-REX instance
 
 Functionality:
 1. Stop any running traffic
-
+2. Optionally restore reference counter values.
+3. Return conter differences.
 """
 
-import sys
+import argparse
 import json
+import sys
 
-sys.path.insert(0, "/opt/trex-core-2.25/scripts/automation/"+\
-                   "trex_control_plane/stl/")
-from trex_stl_lib.api import *
-
-
-def stop_all_traffic_streams():
-    """Stop traffic if any is running.
+from collections import OrderedDict  # Needed to parse xstats representation.
 
-    :return: nothing
-    """
+sys.path.insert(
+    0, u"/opt/trex-core-2.61/scripts/automation/trex_control_plane/interactive/"
+)
+from trex.stl.api import *
 
-    # create client
-    client = STLClient(verbose_level=LoggerApi.VERBOSE_QUIET)
 
+def main():
+    """Stop traffic if any is running. Report xstats."""
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        u"--xstat0", type=str, default=u"",
+        help=u"Reference xstat object if any."
+    )
+    parser.add_argument(
+        u"--xstat1", type=str, default=u"",
+        help=u"Reference xstat object if any."
+    )
+    args = parser.parse_args()
+
+    client = STLClient()
     try:
         # connect to server
         client.connect()
 
         client.acquire(force=True)
+        # TODO: Support unidirection.
         client.stop(ports=[0, 1])
 
-        # read the stats after the test
-        stats = client.get_stats()
-
-        print("#####statistics (approx.)#####")
-        print(json.dumps(stats, indent=4,
-                         separators=(',', ': '), sort_keys=True))
-
-        lost_a = stats[0]["opackets"] - stats[1]["ipackets"]
-        lost_b = stats[1]["opackets"] - stats[0]["ipackets"]
-
-        print("\npackets lost from 0 --> 1:   {0} pkts".format(lost_a))
-        print("packets lost from 1 --> 0:   {0} pkts".format(lost_b))
-
-    except STLError as ex_error:
-        print_error(str(ex_error))
-        sys.exit(1)
-
+        # Read the stats after the test,
+        # we need to update values before the last trial started.
+        if args.xstat0:
+            snapshot = eval(args.xstat0)
+            client.ports[0].get_xstats().reference_stats = snapshot
+        if args.xstat1:
+            snapshot = eval(args.xstat1)
+            client.ports[1].get_xstats().reference_stats = snapshot
+        # Now we can call the official method to get differences.
+        xstats0 = client.get_xstats(0)
+        xstats1 = client.get_xstats(1)
+
+    # If STLError happens, let the script fail with stack trace.
     finally:
         client.disconnect()
 
+    print(u"##### statistics port 0 #####")
+    print(json.dumps(xstats0, indent=4, separators=(u",", u": ")))
+    print(u"##### statistics port 1 #####")
+    print(json.dumps(xstats1, indent=4, separators=(u",", u": ")))
 
-def print_error(msg):
-    """Print error message on stderr.
+    tx_0, rx_0 = xstats0[u"tx_good_packets"], xstats0[u"rx_good_packets"]
+    tx_1, rx_1 = xstats1[u"tx_good_packets"], xstats1[u"rx_good_packets"]
+    lost_a, lost_b = tx_0 - rx_1, tx_1 - rx_0
 
-    :param msg: Error message to print.
-    :type msg: string
-    :return: nothing
-    """
+    print(f"\npackets lost from 0 --> 1:   {lost_a} pkts")
+    print(f"packets lost from 1 --> 0:   {lost_b} pkts")
 
-    sys.stderr.write(msg+'\n')
-
-
-def main():
-    """Main function."""
+    total_rcvd, total_sent = rx_0 + rx_1, tx_0 + tx_1
+    total_lost = total_sent - total_rcvd
+    # TODO: Add latency.
+    print(
+        f"rate='unknown', totalReceived={total_rcvd}, totalSent={total_sent}, "
+        f"frameLoss={total_lost}, latencyStream0(usec)=-1/-1/-1, "
+        f"latencyStream1(usec)=-1/-1/-1, targetDuration='manual'"
+    )
 
-    stop_all_traffic_streams()
 
-if __name__ == "__main__":
+if __name__ == u"__main__":
     main()