Avoid !r format appending u on unicode
[csit.git] / resources / tools / trex / trex_stateless_profile.py
index a3072cf..aa68a01 100755 (executable)
@@ -1,6 +1,6 @@
 #!/usr/bin/python
 
-# Copyright (c) 2017 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:
@@ -22,7 +22,7 @@ import sys
 import argparse
 import json
 
-sys.path.insert(0, "/opt/trex-core-2.29/scripts/automation/"
+sys.path.insert(0, "/opt/trex-core-2.35/scripts/automation/"
                    "trex_control_plane/stl/")
 
 from trex_stl_lib.api import *
@@ -58,8 +58,8 @@ def fmt_latency(lat_min, lat_avg, lat_max):
 
 
 def simple_burst(profile_file, duration, framesize, rate, warmup_time, port_0,
-                 port_1, latency, async_start=False):
-    """Send the traffic and measure packet loss and latency.
+                 port_1, latency, async_start=False, unidirection=False):
+    """Send traffic and measure packet loss and latency.
 
     Procedure:
      - reads the given traffic profile with streams,
@@ -85,15 +85,17 @@ def simple_burst(profile_file, duration, framesize, rate, warmup_time, port_0,
     :param port_1: Port 1 on the traffic generator.
     :param latency: With latency stats.
     :param async_start: Start the traffic and exit.
+    :param unidirection: Traffic is unidirectional.
     :type profile_file: str
     :type framesize: int or str
-    :type duration: int
+    :type duration: float
     :type rate: str
-    :type warmup_time: int
+    :type warmup_time: float
     :type port_0: int
     :type port_1: int
-    :type latency: boo;
+    :type latency: bool
     :type async_start: bool
+    :type unidirection: bool
     """
 
     client = None
@@ -109,11 +111,9 @@ def simple_burst(profile_file, duration, framesize, rate, warmup_time, port_0,
         print("### Profile file:\n{}".format(profile_file))
         profile = STLProfile.load(profile_file, direction=0, port_id=0,
                                   framesize=framesize)
-        print("\n### Profiles ###\n")
-        print(profile.dump_to_yaml())
         streams = profile.get_streams()
-    except STLError:
-        print("Error while loading profile '{0}'\n".format(profile_file))
+    except STLError as err:
+        print("Error while loading profile '{0}' {1}".format(profile_file, err))
         sys.exit(1)
 
     try:
@@ -130,33 +130,37 @@ def simple_burst(profile_file, duration, framesize, rate, warmup_time, port_0,
                                  resolve=False)
         if isinstance(framesize, int):
             client.add_streams(streams[0], ports=[port_0])
-            client.add_streams(streams[1], ports=[port_1])
+            if not unidirection:
+                client.add_streams(streams[1], ports=[port_1])
         elif isinstance(framesize, str):
             client.add_streams(streams[0:3], ports=[port_0])
-            client.add_streams(streams[3:6], ports=[port_1])
+            if not unidirection:
+                client.add_streams(streams[3:6], ports=[port_1])
         if latency:
             try:
                 if isinstance(framesize, int):
                     client.add_streams(streams[2], ports=[port_0])
-                    client.add_streams(streams[3], ports=[port_1])
+                    if not unidirection:
+                        client.add_streams(streams[3], ports=[port_1])
                 elif isinstance(framesize, str):
                     latency = False
             except STLError:
                 # Disable latency if NIC does not support requested stream type
                 print("##### FAILED to add latency streams #####")
                 latency = False
+        ports = [port_0]
+        if not unidirection:
+            ports.append(port_1)
         # Warm-up phase:
         if warmup_time > 0:
             # Clear the stats before injecting:
             client.clear_stats()
 
             # Choose rate and start traffic:
-            client.start(ports=[port_0, port_1], mult=rate,
-                         duration=warmup_time)
+            client.start(ports=ports, mult=rate, duration=warmup_time)
 
             # Block until done:
-            client.wait_on_traffic(ports=[port_0, port_1],
-                                   timeout=warmup_time+30)
+            client.wait_on_traffic(ports=ports, timeout=warmup_time+30)
 
             if client.get_warnings():
                 for warning in client.get_warnings():
@@ -169,11 +173,15 @@ def simple_burst(profile_file, duration, framesize, rate, warmup_time, port_0,
             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"]
+            lost_a = stats[port_0]["opackets"] - stats[port_1]["ipackets"]
+            if not unidirection:
+                lost_b = stats[port_1]["opackets"] - stats[port_0]["ipackets"]
 
-            print("\npackets lost from 0 --> 1: {0} pkts".format(lost_a))
-            print("packets lost from 1 --> 0: {0} pkts".format(lost_b))
+            print("\npackets lost from {p_0} --> {p_1}: {v} pkts".format(
+                p_0=port_0, p_1=port_1, v=lost_a))
+            if not unidirection:
+                print("packets lost from {p_1} --> {p_0}: {v} pkts".format(
+                    p_0=port_0, p_1=port_1, v=lost_b))
 
         # Clear the stats before injecting:
         client.clear_stats()
@@ -181,11 +189,11 @@ def simple_burst(profile_file, duration, framesize, rate, warmup_time, port_0,
         lost_b = 0
 
         # Choose rate and start traffic:
-        client.start(ports=[port_0, port_1], mult=rate, duration=duration)
+        client.start(ports=ports, mult=rate, duration=duration)
 
         if not async_start:
             # Block until done:
-            client.wait_on_traffic(ports=[port_0, port_1], timeout=duration+30)
+            client.wait_on_traffic(ports=ports, timeout=duration+30)
 
             if client.get_warnings():
                 for warning in client.get_warnings():
@@ -198,24 +206,33 @@ def simple_burst(profile_file, duration, framesize, rate, warmup_time, port_0,
             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"]
+            lost_a = stats[port_0]["opackets"] - stats[port_1]["ipackets"]
+            if not unidirection:
+                lost_b = stats[port_1]["opackets"] - stats[port_0]["ipackets"]
 
             if latency:
                 lat_a = fmt_latency(
-                    str(stats["latency"][0]["latency"]["total_min"]),
-                    str(stats["latency"][0]["latency"]["average"]),
-                    str(stats["latency"][0]["latency"]["total_max"]))
-                lat_b = fmt_latency(
-                    str(stats["latency"][1]["latency"]["total_min"]),
-                    str(stats["latency"][1]["latency"]["average"]),
-                    str(stats["latency"][1]["latency"]["total_max"]))
-
-            total_sent = stats[0]["opackets"] + stats[1]["opackets"]
-            total_rcvd = stats[0]["ipackets"] + stats[1]["ipackets"]
-
-            print("\npackets lost from 0 --> 1:   {0} pkts".format(lost_a))
-            print("packets lost from 1 --> 0:   {0} pkts".format(lost_b))
+                    str(stats["latency"][port_0]["latency"]["total_min"]),
+                    str(stats["latency"][port_0]["latency"]["average"]),
+                    str(stats["latency"][port_0]["latency"]["total_max"]))
+                if not unidirection:
+                    lat_b = fmt_latency(
+                        str(stats["latency"][port_1]["latency"]["total_min"]),
+                        str(stats["latency"][port_1]["latency"]["average"]),
+                        str(stats["latency"][port_1]["latency"]["total_max"]))
+
+            if not unidirection:
+                total_sent = stats[0]["opackets"] + stats[1]["opackets"]
+                total_rcvd = stats[0]["ipackets"] + stats[1]["ipackets"]
+            else:
+                total_sent = stats[port_0]["opackets"]
+                total_rcvd = stats[port_1]["ipackets"]
+
+            print("\npackets lost from {p_0} --> {p_1}:   {v} pkts".format(
+                p_0=port_0, p_1=port_1, v=lost_a))
+            if not unidirection:
+                print("packets lost from {p_1} --> {p_0}:   {v} pkts".format(
+                p_0=port_0, p_1=port_1, v=lost_b))
 
     except STLError as err:
         sys.stderr.write("{0}\n".format(err))
@@ -228,11 +245,15 @@ def simple_burst(profile_file, duration, framesize, rate, warmup_time, port_0,
         else:
             if client:
                 client.disconnect()
-            print("rate={0}, totalReceived={1}, totalSent={2}, "
+            if isinstance(rate, unicode):
+                rate = rate.encode("utf-8")
+            if isinstance(duration, unicode):
+                duration = duration.encode("utf-8")
+            print("rate={0!r}, totalReceived={1}, totalSent={2}, "
                   "frameLoss={3}, latencyStream0(usec)={4}, "
-                  "latencyStream1(usec)={5}".
+                  "latencyStream1(usec)={5}, targetDuration={d!r}".
                   format(rate, total_rcvd, total_sent, lost_a + lost_b,
-                         lat_a, lat_b))
+                         lat_a, lat_b, d=duration))
 
 
 def main():
@@ -249,7 +270,7 @@ def main():
                         help="Python traffic profile.")
     parser.add_argument("-d", "--duration",
                         required=True,
-                        type=int,
+                        type=float,
                         help="Duration of traffic run.")
     parser.add_argument("-s", "--frame_size",
                         required=True,
@@ -258,8 +279,8 @@ def main():
                         required=True,
                         help="Traffic rate with included units (%, pps).")
     parser.add_argument("-w", "--warmup_time",
-                        type=int,
-                        default=5,
+                        type=float,
+                        default=5.0,
                         help="Traffic warm-up time in seconds, 0 = disable.")
     parser.add_argument("--port_0",
                         required=True,
@@ -276,7 +297,12 @@ def main():
     parser.add_argument("--latency",
                         action="store_true",
                         default=False,
-                        help="Add latency stream")
+                        help="Add latency stream.")
+    parser.add_argument("--unidirection",
+                        action="store_true",
+                        default=False,
+                        help="Send unidirection traffic.")
+
     args = parser.parse_args()
 
     try:
@@ -285,14 +311,15 @@ def main():
         framesize = args.frame_size
 
     simple_burst(profile_file=args.profile,
-                 duration=int(args.duration),
+                 duration=args.duration,
                  framesize=framesize,
                  rate=args.rate,
-                 warmup_time=int(args.warmup_time),
-                 port_0=int(args.port_0),
-                 port_1=int(args.port_1),
+                 warmup_time=args.warmup_time,
+                 port_0=args.port_0,
+                 port_1=args.port_1,
                  latency=args.latency,
-                 async_start=args.async)
+                 async_start=args.async,
+                 unidirection=args.unidirection)
 
 
 if __name__ == '__main__':