bugfix: Cleanup of traffic gen api and default traffic values

Both documentation and traffic generator API are updated
to match current code logic. Additional default values
are added into TRAFFIC_DEFAULTS dictionary. Constructor
of TestCase class uses default values from TRAFFIC_DEFAULTS
instead of magic numbers.

Change-Id: Id2f4983945e4b123adddbc9a2a832f4a735b27f6
JIRA: VSPERF-253
Signed-off-by: Martin Klozik <martinx.klozik@intel.com>
Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com>
Reviewed-by: Al Morton <acmorton@att.com>
Reviewed-by: Christian Trautman <ctrautma@redhat.com>

5 files changed, 32 insertions, 34 deletions

diff --git a/tools/pkt_gen/dummy/dummy.py b/tools/pkt_gen/dummy/dummy.py
index 5a117850..d3d79974 100755
--- a/tools/pkt_gen/dummy/dummy.py
+++ b/tools/pkt_gen/dummy/dummy.py
@@ -1,4 +1,4 @@
-# Copyright 2015 Intel Corporation.
+# Copyright 2015-2016 Intel Corporation.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -133,7 +133,7 @@ class Dummy(trafficgen.ITrafficGenerator):
 
         return trafficgen.BurstResult(*results)
 
-    def send_cont_traffic(self, traffic=None, duration=30, multistream=False):
+    def send_cont_traffic(self, traffic=None, duration=30):
         """
         Send a continuous flow of traffic.
         """
@@ -145,10 +145,11 @@ class Dummy(trafficgen.ITrafficGenerator):
 
         results = get_user_traffic(
             'continuous',
-            '%dmpps, multistream %s duration %d' % (traffic['frame_rate'],
-                                                    multistream, duration), traffic_,
-            ('frames tx', 'frames rx', 'tx rate %','rx rate %' ,'min latency',
-             'max latency','avg latency', 'frameloss %'))
+            '%dmpps, multistream %s, duration %d' % (traffic['frame_rate'],
+                                                    traffic['multistream'],
+                                                    duration), traffic_,
+            ('frames tx', 'frames rx', 'tx rate %', 'rx rate %', 'min latency',
+             'max latency', 'avg latency', 'frameloss %'))
 
         framesize = traffic_['l2']['framesize']
 
@@ -169,7 +170,7 @@ class Dummy(trafficgen.ITrafficGenerator):
         return result
 
     def send_rfc2544_throughput(self, traffic=None, trials=3, duration=20,
-                                lossrate=0.0, multistream=False):
+                                lossrate=0.0):
         """
         Send traffic per RFC2544 throughput test specifications.
         """
@@ -182,11 +183,10 @@ class Dummy(trafficgen.ITrafficGenerator):
         results = get_user_traffic(
             'throughput',
             '%d trials, %d seconds iterations, %f packet loss, multistream '
-            '%s' % (trials, duration, lossrate,
-                    'enabled' if multistream else 'disabled'),
+            '%s' % (trials, duration, lossrate, traffic['multistream']),
             traffic_,
-             ('frames tx', 'frames rx', 'tx rate %','rx rate %' ,'min latency',
-             'max latency','avg latency', 'frameloss %'))
+            ('frames tx', 'frames rx', 'tx rate %', 'rx rate %', 'min latency',
+             'max latency', 'avg latency', 'frameloss %'))
 
         framesize = traffic_['l2']['framesize']
 
diff --git a/tools/pkt_gen/ixia/ixia.py b/tools/pkt_gen/ixia/ixia.py
index b9b3dd17..ae5da6d2 100755
--- a/tools/pkt_gen/ixia/ixia.py
+++ b/tools/pkt_gen/ixia/ixia.py
@@ -1,4 +1,4 @@
-# Copyright 2015 Intel Corporation.
+# Copyright 2015-2016 Intel Corporation.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -227,7 +227,7 @@ class Ixia(trafficgen.ITrafficGenerator):
 
         #TODO - implement Burst results setting via TrafficgenResults.
 
-    def send_cont_traffic(self, traffic=None, duration=30, multistream=False):
+    def send_cont_traffic(self, traffic=None, duration=30):
         """See ITrafficGenerator for description
         """
         flow = {
@@ -252,8 +252,7 @@ class Ixia(trafficgen.ITrafficGenerator):
         """
         return self.run_tcl('stopTraffic')
 
-    def send_rfc2544_throughput(self, traffic=None, trials=3, duration=20,
-                                lossrate=0.0, multistream=False):
+    def send_rfc2544_throughput(self, traffic=None, trials=3, duration=20, lossrate=0.0):
         """See ITrafficGenerator for description
         """
         params = {}
diff --git a/tools/pkt_gen/ixnet/ixnet.py b/tools/pkt_gen/ixnet/ixnet.py
index c8dbb3d1..aadadf94 100755
--- a/tools/pkt_gen/ixnet/ixnet.py
+++ b/tools/pkt_gen/ixnet/ixnet.py
@@ -204,7 +204,7 @@ class IxNet(trafficgen.ITrafficGenerator):
         """
         pass
 
-    def send_cont_traffic(self, traffic=None, duration=30, multistream=False):
+    def send_cont_traffic(self, traffic=None, duration=30):
         """See ITrafficGenerator for description
         """
         self.start_cont_traffic(traffic, duration)
@@ -256,7 +256,7 @@ class IxNet(trafficgen.ITrafficGenerator):
         return self._wait_result()
 
     def send_rfc2544_throughput(self, traffic=None, trials=3, duration=20,
-                                lossrate=0.0, multistream=False):
+                                lossrate=0.0):
         """See ITrafficGenerator for description
         """
         self.start_rfc2544_throughput(traffic, trials, duration, lossrate)
diff --git a/tools/pkt_gen/trafficgen/trafficgen.py b/tools/pkt_gen/trafficgen/trafficgen.py
index 134db6b8..3953bbb1 100755
--- a/tools/pkt_gen/trafficgen/trafficgen.py
+++ b/tools/pkt_gen/trafficgen/trafficgen.py
@@ -1,4 +1,4 @@
-# Copyright 2015 Intel Corporation.
+# Copyright 2015-2016 Intel Corporation.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -86,7 +86,7 @@ class ITrafficGenerator(object):
         configuration, for ``duration`` seconds.
 
         Attributes:
-        :param traffic: Detailed "traffic" spec, i.e. IP address, VLAN tags
+        :param traffic: Detailed "traffic" spec, see design docs for details
         :param numpkts: Number of packets to send
         :param duration: Time to wait to receive packets
 
@@ -99,17 +99,14 @@ class ITrafficGenerator(object):
         """
         raise NotImplementedError('Please call an implementation.')
 
-    def send_cont_traffic(self, traffic=None, duration=20, multistream=False):
+    def send_cont_traffic(self, traffic=None, duration=20):
         """Send a continuous flow of traffic.
 
         Send packets at given framerate, using ``traffic`` configuration,
         for ``duration`` seconds..
 
-        :param traffic: Detailed "traffic" spec, i.e. IP address, VLAN tags
-                        from 1 to 64,000
+        :param traffic: Detailed "traffic" spec, see design docs for details
         :param duration: Duration to transmit traffic.
-        :param multistream: Enable multistream output by overriding the
-                        from 1 to 64,000
         :returns: dictionary of strings with following data:
             - Tx Throughput (fps),
             - Rx Throughput (fps),
@@ -137,20 +134,17 @@ class ITrafficGenerator(object):
         raise NotImplementedError('Please call an implementation.')
 
     def send_rfc2544_throughput(self, traffic=None, trials=3, duration=20,
-                                lossrate=0.0, multistream=False):
+                                lossrate=0.0):
         """Send traffic per RFC2544 throughput test specifications.
 
         Send packets at a variable rate, using ``traffic``
         configuration, until minimum rate at which no packet loss is
         detected is found.
 
-        :param traffic: Detailed "traffic" spec, i.e. IP address, VLAN tags
+        :param traffic: Detailed "traffic" spec, see design docs for details
         :param trials: Number of trials to execute
         :param duration: Per iteration duration
         :param lossrate: Acceptable lossrate percentage
-        :param multistream: Enable multistream output by overriding the
-                        UDP port number in ``traffic`` with values
-                        from 1 to 64,000
         :returns: dictionary of strings with following data:
             - Tx Throughput (fps),
             - Rx Throughput (fps),
@@ -185,13 +179,10 @@ class ITrafficGenerator(object):
         Send packets at a fixed rate, using ``traffic``
         configuration, for duration seconds.
 
-        :param traffic: Detailed "traffic" spec, i.e. IP address, VLAN
-            tags
+        :param traffic: Detailed "traffic" spec, see design docs for details
         :param trials: Number of trials to execute
         :param duration: Per iteration duration
         :param lossrate: Acceptable loss percentage
-        :param multistream: Enable multistream output by overriding the
-            UDP port number in ``traffic`` with values from 1 to 64,000
 
         :returns: Named tuple of Rx Throughput (fps), Rx Throughput (mbps),
             Tx Rate (% linerate), Rx Rate (% linerate), Tx Count (frames),
diff --git a/tools/pkt_gen/trafficgen/trafficgenhelper.py b/tools/pkt_gen/trafficgen/trafficgenhelper.py
index 97cf6377..0a240579 100644
--- a/tools/pkt_gen/trafficgen/trafficgenhelper.py
+++ b/tools/pkt_gen/trafficgen/trafficgenhelper.py
@@ -1,4 +1,4 @@
-# Copyright 2015 Intel Corporation.
+# Copyright 2015-2016 Intel Corporation.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,6 +21,14 @@ from collections import namedtuple
 
 CMD_PREFIX = 'gencmd : '
 TRAFFIC_DEFAULTS = {
+    'traffic_type' : 'rfc2544',
+    'frame_rate' : 100,
+    'bidir' : False,
+    'multistream' : 0,
+    'stream_type' : 'L4',
+    'pre_installed_flows' : 'No',           # used by vswitch implementation
+    'flow_type' : 'port',                   # used by vswitch implementation
+
     'l2': {
         'framesize': 64,
         'srcmac': '00:00:00:00:00:00',