Avoid !r format appending u on unicode
[csit.git] / resources / libraries / python / TrafficGenerator.py
index ea587d7..9e0a1d2 100644 (file)
@@ -37,21 +37,21 @@ class TGDropRateSearchImpl(DropRateSearch):
         super(TGDropRateSearchImpl, self).__init__()
 
     def measure_loss(self, rate, frame_size, loss_acceptance,
-                     loss_acceptance_type, traffic_type, skip_warmup=False):
+                     loss_acceptance_type, traffic_profile, skip_warmup=False):
         """Runs the traffic and evaluate the measured results.
 
         :param rate: Offered traffic load.
         :param frame_size: Size of frame.
         :param loss_acceptance: Permitted drop ratio or frames count.
         :param loss_acceptance_type: Type of permitted loss.
-        :param traffic_type: Module name as a traffic type identifier.
+        :param traffic_profile: Module name as a traffic profile identifier.
             See resources/traffic_profiles/trex for implemented modules.
         :param skip_warmup: Start TRex without warmup traffic if true.
         :type rate: float
         :type frame_size: str
         :type loss_acceptance: float
         :type loss_acceptance_type: LossAcceptanceType
-        :type traffic_type: str
+        :type traffic_profile: str
         :type skip_warmup: bool
         :returns: Drop threshold exceeded? (True/False)
         :rtype: bool
@@ -70,12 +70,12 @@ class TGDropRateSearchImpl(DropRateSearch):
             if skip_warmup:
                 tg_instance.trex_stl_start_remote_exec(self.get_duration(),
                                                        unit_rate, frame_size,
-                                                       traffic_type,
+                                                       traffic_profile,
                                                        warmup_time=0.0)
             else:
                 tg_instance.trex_stl_start_remote_exec(self.get_duration(),
                                                        unit_rate, frame_size,
-                                                       traffic_type)
+                                                       traffic_profile)
             loss = tg_instance.get_loss()
             sent = tg_instance.get_sent()
             if self.loss_acceptance_type_is_percentage():
@@ -124,7 +124,7 @@ class TrafficGenerator(AbstractMeasurer):
         self._ifaces_reordered = False
         # Parameters not given by measure().
         self.frame_size = None
-        self.traffic_type = None
+        self.traffic_profile = None
         self.warmup_time = None
 
     @property
@@ -170,7 +170,7 @@ class TrafficGenerator(AbstractMeasurer):
 
     def initialize_traffic_generator(
             self, tg_node, tg_if1, tg_if2, tg_if1_adj_node, tg_if1_adj_if,
-            tg_if2_adj_node, tg_if2_adj_if, test_type, tg_if1_dst_mac=None,
+            tg_if2_adj_node, tg_if2_adj_if, osi_layer, tg_if1_dst_mac=None,
             tg_if2_dst_mac=None):
         """TG initialization.
 
@@ -183,7 +183,7 @@ class TrafficGenerator(AbstractMeasurer):
         :param tg_if1_adj_if: TG if1 adjecent interface.
         :param tg_if2_adj_node: TG if2 adjecent node.
         :param tg_if2_adj_if: TG if2 adjecent interface.
-        :param test_type: 'L2', 'L3' or 'L7' - OSI Layer testing type.
+        :param osi_layer: 'L2', 'L3' or 'L7' - OSI Layer testing type.
         :param tg_if1_dst_mac: Interface 1 destination MAC address.
         :param tg_if2_dst_mac: Interface 2 destination MAC address.
         :type tg_node: dict
@@ -193,7 +193,7 @@ class TrafficGenerator(AbstractMeasurer):
         :type tg_if1_adj_if: str
         :type tg_if2_adj_node: dict
         :type tg_if2_adj_if: str
-        :type test_type: str
+        :type osi_layer: str
         :type tg_if1_dst_mac: str
         :type tg_if2_dst_mac: str
         :returns: nothing
@@ -220,15 +220,15 @@ class TrafficGenerator(AbstractMeasurer):
             if1_addr = Topology().get_interface_mac(tg_node, tg_if1)
             if2_addr = Topology().get_interface_mac(tg_node, tg_if2)
 
-            if test_type == 'L2':
+            if osi_layer == 'L2':
                 if1_adj_addr = if2_addr
                 if2_adj_addr = if1_addr
-            elif test_type == 'L3':
+            elif osi_layer == 'L3':
                 if1_adj_addr = Topology().get_interface_mac(tg_if1_adj_node,
                                                             tg_if1_adj_if)
                 if2_adj_addr = Topology().get_interface_mac(tg_if2_adj_node,
                                                             tg_if2_adj_if)
-            elif test_type == 'L7':
+            elif osi_layer == 'L7':
                 if1_addr = Topology().get_interface_ip4(tg_node, tg_if1)
                 if2_addr = Topology().get_interface_ip4(tg_node, tg_if2)
                 if1_adj_addr = Topology().get_interface_ip4(tg_if1_adj_node,
@@ -249,7 +249,7 @@ class TrafficGenerator(AbstractMeasurer):
                 if1_adj_addr, if2_adj_addr = if2_adj_addr, if1_adj_addr
                 self._ifaces_reordered = True
 
-            if test_type == 'L2' or test_type == 'L3':
+            if osi_layer == 'L2' or osi_layer == 'L3':
                 (ret, _, _) = ssh.exec_command(
                     "sudo sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
                     "- port_limit: 2\n"
@@ -266,7 +266,7 @@ class TrafficGenerator(AbstractMeasurer):
                             "0x"+if1_addr.replace(":", ",0x"),
                             "0x"+if2_adj_addr.replace(":", ",0x"),
                             "0x"+if2_addr.replace(":", ",0x")))
-            elif test_type == 'L7':
+            elif osi_layer == 'L7':
                 (ret, _, _) = ssh.exec_command(
                     "sudo sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
                     "- port_limit: 2\n"
@@ -299,13 +299,13 @@ class TrafficGenerator(AbstractMeasurer):
                     raise RuntimeError('trex-cfg failed')
 
                 # start TRex
-                if test_type == 'L2' or test_type == 'L3':
+                if osi_layer == 'L2' or osi_layer == 'L3':
                     (ret, _, _) = ssh.exec_command(
                         "sh -c 'cd {0}/scripts/ && "
                         "sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /tmp/trex.log "
                         "2>&1 &' > /dev/null"\
                         .format(Constants.TREX_INSTALL_DIR))
-                elif test_type == 'L7':
+                elif osi_layer == 'L7':
                     (ret, _, _) = ssh.exec_command(
                         "sh -c 'cd {0}/scripts/ && "
                         "sudo nohup ./t-rex-64 --astf -i -c 7 --iom 0 > "
@@ -388,15 +388,15 @@ class TrafficGenerator(AbstractMeasurer):
             raise RuntimeError('TRex stateless runtime error')
 
     def trex_stl_start_remote_exec(
-            self, duration, rate, framesize, traffic_type, async_call=False,
+            self, duration, rate, frame_size, traffic_profile, async_call=False,
             latency=True, warmup_time=5.0, unidirection=False, tx_port=0,
             rx_port=1):
         """Execute script on remote node over ssh to start traffic.
 
         :param duration: Time expresed in seconds for how long to send traffic.
         :param rate: Traffic rate expressed with units (pps, %)
-        :param framesize: L2 frame size to send (without padding and IPG).
-        :param traffic_type: Module name as a traffic type identifier.
+        :param frame_size: L2 frame size to send (without padding and IPG).
+        :param traffic_profile: Module name as a traffic profile identifier.
             See resources/traffic_profiles/trex for implemented modules.
         :param async_call: If enabled then don't wait for all incomming trafic.
         :param latency: With latency measurement.
@@ -408,8 +408,8 @@ class TrafficGenerator(AbstractMeasurer):
             Default: 1
         :type duration: float
         :type rate: str
-        :type framesize: str
-        :type traffic_type: str
+        :type frame_size: str
+        :type traffic_profile: str
         :type async_call: bool
         :type latency: bool
         :type warmup_time: float
@@ -422,14 +422,23 @@ class TrafficGenerator(AbstractMeasurer):
         ssh.connect(self._node)
         reorder = self._ifaces_reordered  # Just to make the next line fit.
         p_0, p_1 = (rx_port, tx_port) if reorder else (tx_port, rx_port)
+        # Values from Robot can introduce type unicode,
+        # we need to encode them, so that repr() does not lead with 'u'.
+        if isinstance(rate, unicode):
+            rate = rate.encode("utf-8")
+        if isinstance(duration, unicode):
+            duration = duration.encode("utf-8")
+        if isinstance(warmup_time, unicode):
+            warmup_time = warmup_time.encode("utf-8")
         command = (
             "sh -c '{tool}/resources/tools/trex/trex_stateless_profile.py"
             " --profile {prof}/resources/traffic_profiles/trex/{traffic}.py"
-            " --duration {duration} --frame_size {framesize} --rate {rate}"
-            " --warmup_time {warmup} --port_0 {p_0} --port_1 {p_1}").format(
+            " --duration {duration!r} --frame_size {frame_size} --rate {rate!r}"
+            " --warmup_time {warmup!r} --port_0 {p_0} --port_1 {p_1}").format(
                 tool=Constants.REMOTE_FW_DIR, prof=Constants.REMOTE_FW_DIR,
-                traffic=traffic_type, duration=duration, framesize=framesize,
-                rate=rate, warmup=warmup_time, p_0=p_0, p_1=p_1)
+                traffic=traffic_profile, duration=duration,
+                frame_size=frame_size, rate=rate, warmup=warmup_time, p_0=p_0,
+                p_1=p_1)
         if async_call:
             command += " --async"
         if latency:
@@ -473,7 +482,7 @@ class TrafficGenerator(AbstractMeasurer):
             self.trex_stl_stop_remote_exec(self._node)
 
     def send_traffic_on_tg(
-            self, duration, rate, framesize, traffic_type, warmup_time=5,
+            self, duration, rate, frame_size, traffic_profile, warmup_time=5,
             async_call=False, latency=True, unidirection=False, tx_port=0,
             rx_port=1):
         """Send traffic from all configured interfaces on TG.
@@ -489,12 +498,13 @@ class TrafficGenerator(AbstractMeasurer):
 
         TODO: Is it better to have less descriptive argument names
         just to make them less probable to be viewed as misleading or confusing?
-        See https://gerrit.fd.io/r/#/c/17625/11/resources/libraries/python/TrafficGenerator.py@406
+        See https://gerrit.fd.io/r/#/c/17625/11/resources/libraries/python\
+        /TrafficGenerator.py@406
 
         :param duration: Duration of test traffic generation in seconds.
         :param rate: Offered load per interface (e.g. 1%, 3gbps, 4mpps, ...).
-        :param framesize: Frame size (L2) in Bytes.
-        :param traffic_type: Module name as a traffic type identifier.
+        :param frame_size: Frame size (L2) in Bytes.
+        :param traffic_profile: Module name as a traffic profile identifier.
             See resources/traffic_profiles/trex for implemented modules.
         :param warmup_time: Warmup phase in seconds.
         :param async_call: Async mode.
@@ -506,8 +516,8 @@ class TrafficGenerator(AbstractMeasurer):
             Default: 1
         :type duration: str
         :type rate: str
-        :type framesize: str
-        :type traffic_type: str
+        :type frame_size: str
+        :type traffic_profile: str
         :type warmup_time: float
         :type async_call: bool
         :type latency: bool
@@ -532,8 +542,8 @@ class TrafficGenerator(AbstractMeasurer):
             raise RuntimeError('TG subtype not defined')
         elif node['subtype'] == NodeSubTypeTG.TREX:
             self.trex_stl_start_remote_exec(
-                duration, rate, framesize, traffic_type, async_call, latency,
-                warmup_time, unidirection, tx_port, rx_port)
+                duration, rate, frame_size, traffic_profile, async_call,
+                latency, warmup_time, unidirection, tx_port, rx_port)
         else:
             raise NotImplementedError("TG subtype not supported")
 
@@ -586,20 +596,20 @@ class TrafficGenerator(AbstractMeasurer):
             raise Exception("Traffic loss {} above loss acceptance: {}".format(
                 loss, loss_acceptance))
 
-    def set_rate_provider_defaults(self, frame_size, traffic_type,
+    def set_rate_provider_defaults(self, frame_size, traffic_profile,
                                    warmup_time=0.0):
         """Store values accessed by measure().
 
         :param frame_size: Frame size identifier or value [B].
-        :param traffic_type: Module name as a traffic type identifier.
+        :param traffic_profile: Module name as a traffic profile identifier.
             See resources/traffic_profiles/trex for implemented modules.
         :param warmup_time: Traffic duration before measurement starts [s].
         :type frame_size: str or int
-        :type traffic_type: str
+        :type traffic_profile: str
         :type warmup_time: float
         """
         self.frame_size = frame_size
-        self.traffic_type = str(traffic_type)
+        self.traffic_profile = str(traffic_profile)
         self.warmup_time = float(warmup_time)
 
     def measure(self, duration, transmit_rate):
@@ -620,7 +630,7 @@ class TrafficGenerator(AbstractMeasurer):
         # Trex needs target Tr per stream, but reports aggregate Tx and Dx.
         unit_rate = str(transmit_rate / 2.0) + "pps"
         self.send_traffic_on_tg(
-            duration, unit_rate, self.frame_size, self.traffic_type,
+            duration, unit_rate, self.frame_size, self.traffic_profile,
             warmup_time=self.warmup_time, latency=True)
         transmit_count = int(self.get_sent())
         loss_count = int(self.get_loss())
@@ -635,7 +645,7 @@ class OptimizedSearch(object):
 
     @staticmethod
     def perform_optimized_ndrpdr_search(
-            frame_size, traffic_type, minimum_transmit_rate,
+            frame_size, traffic_profile, minimum_transmit_rate,
             maximum_transmit_rate, packet_loss_ratio=0.005,
             final_relative_width=0.005, final_trial_duration=30.0,
             initial_trial_duration=1.0, number_of_intermediate_phases=2,
@@ -643,7 +653,7 @@ class OptimizedSearch(object):
         """Setup initialized TG, perform optimized search, return intervals.
 
         :param frame_size: Frame size identifier or value [B].
-        :param traffic_type: Module name as a traffic type identifier.
+        :param traffic_profile: Module name as a traffic profile identifier.
             See resources/traffic_profiles/trex for implemented modules.
         :param minimum_transmit_rate: Minimal bidirectional
             target transmit rate [pps].
@@ -663,7 +673,7 @@ class OptimizedSearch(object):
             Default 1 is suitable for fairly stable tests,
             less stable tests might get better overal duration with 2 or more.
         :type frame_size: str or int
-        :type traffic_type: str
+        :type traffic_profile: str
         :type minimum_transmit_rate: float
         :type maximum_transmit_rate: float
         :type packet_loss_ratio: float
@@ -682,7 +692,7 @@ class OptimizedSearch(object):
         # to be able to use trex_stl-*()
         tg_instance = BuiltIn().get_library_instance(
             'resources.libraries.python.TrafficGenerator')
-        tg_instance.set_rate_provider_defaults(frame_size, traffic_type)
+        tg_instance.set_rate_provider_defaults(frame_size, traffic_profile)
         algorithm = MultipleLossRatioSearch(
             measurer=tg_instance, final_trial_duration=final_trial_duration,
             final_relative_width=final_relative_width,
@@ -695,13 +705,13 @@ class OptimizedSearch(object):
 
     @staticmethod
     def perform_soak_search(
-            frame_size, traffic_type, minimum_transmit_rate,
-            maximum_transmit_rate, plr_target=1e-7, tdpt=0.2,
-            initial_count=50, timeout=1800.0):
+            frame_size, traffic_profile, minimum_transmit_rate,
+            maximum_transmit_rate, plr_target=1e-7, tdpt=0.1,
+            initial_count=50, timeout=1800.0, trace_enabled=False):
         """Setup initialized TG, perform soak search, return avg and stdev.
 
         :param frame_size: Frame size identifier or value [B].
-        :param traffic_type: Module name as a traffic type identifier.
+        :param traffic_profile: Module name as a traffic profile identifier.
             See resources/traffic_profiles/trex for implemented modules.
         :param minimum_transmit_rate: Minimal bidirectional
             target transmit rate [pps].
@@ -717,7 +727,7 @@ class OptimizedSearch(object):
             takes significant time even without any trial results.
         :param timeout: The search will stop after this overall time [s].
         :type frame_size: str or int
-        :type traffic_type: str
+        :type traffic_profile: str
         :type minimum_transmit_rate: float
         :type maximum_transmit_rate: float
         :type plr_target: float
@@ -728,10 +738,11 @@ class OptimizedSearch(object):
         """
         tg_instance = BuiltIn().get_library_instance(
             'resources.libraries.python.TrafficGenerator')
-        tg_instance.set_rate_provider_defaults(frame_size, traffic_type)
+        tg_instance.set_rate_provider_defaults(frame_size, traffic_profile)
         algorithm = PLRsearch(
             measurer=tg_instance, trial_duration_per_trial=tdpt,
             packet_loss_ratio_target=plr_target,
-            trial_number_offset=initial_count, timeout=timeout)
+            trial_number_offset=initial_count, timeout=timeout,
+            trace_enabled=trace_enabled)
         result = algorithm.search(minimum_transmit_rate, maximum_transmit_rate)
         return result