Add support to list and show runners & scenarios

Example usage and output:

$ yardstick runner list
+------------------------------------------------------------------------------+
| Type             | Description
+------------------------------------------------------------------------------+
| Duration         | Run a scenario for a certain amount of time
| Arithmetic       | Run a scenario arithmetically stepping an input value
| Constant         | Run a scenario a certain number of times
+------------------------------------------------------------------------------+
$ yardstick runner show Duration
Run a scenario for a certain amount of time

If the scenario ends before the time has elapsed, it will be started again.

  Parameters
    duration - amount of time the scenario will be run for
        type:    int
        unit:    seconds
        default: 1 sec
    interval - time to wait between each scenario invocation
        type:    int
        unit:    seconds
        default: 1 sec

$ yardstick scenario list
+------------------------------------------------------------------------------+
| Type             | Description
+------------------------------------------------------------------------------+
| Iperf3           | Execute iperf3 between two hosts
| Pktgen           | Execute pktgen between two hosts
| Ping             | Execute ping between two hosts
+------------------------------------------------------------------------------+
$ yardstick scenario show Iperf3
Execute iperf3 between two hosts

By default TCP is used but UDP can also be configured.
For more info see http://software.es.net/iperf

  Parameters
    bytes - number of bytes to transmit
      only valid with a non duration runner, mutually exclusive with blockcount
        type:    int
        unit:    bytes
        default: 56
    udp - use UDP rather than TCP
        type:    bool
        unit:    na
        default: false
    nodelay - set TCP no delay, disabling Nagle's Algorithm
        type:    bool
        unit:    na
        default: false
    blockcount - number of blocks (packets) to transmit,
      only valid with a non duration runner, mutually exclusive with bytes
        type:    int
        unit:    bytes
        default: -

JIRA: -
Change-Id: If218e129a30af7e20792190003c214677e732252
Signed-off-by: Hans Feldt <hans.feldt@ericsson.com>

3 files changed, 39 insertions, 3 deletions

diff --git a/yardstick/benchmark/scenarios/networking/iperf3.py b/yardstick/benchmark/scenarios/networking/iperf3.py
index 9901444cd..88423725e 100644
--- a/yardstick/benchmark/scenarios/networking/iperf3.py
+++ b/yardstick/benchmark/scenarios/networking/iperf3.py
@@ -22,7 +22,31 @@ LOG.setLevel(logging.DEBUG)
 
 
 class Iperf(base.Scenario):
-    """Executes an iperf3 benchmark between two hosts"""
+    """Execute iperf3 between two hosts
+
+By default TCP is used but UDP can also be configured.
+For more info see http://software.es.net/iperf
+
+  Parameters
+    bytes - number of bytes to transmit
+      only valid with a non duration runner, mutually exclusive with blockcount
+        type:    int
+        unit:    bytes
+        default: 56
+    udp - use UDP rather than TCP
+        type:    bool
+        unit:    na
+        default: false
+    nodelay - set TCP no delay, disabling Nagle's Algorithm
+        type:    bool
+        unit:    na
+        default: false
+    blockcount - number of blocks (packets) to transmit,
+      only valid with a non duration runner, mutually exclusive with bytes
+        type:    int
+        unit:    bytes
+        default: -
+    """
     __scenario_type__ = "Iperf3"
 
     def __init__(self, context):
diff --git a/yardstick/benchmark/scenarios/networking/ping.py b/yardstick/benchmark/scenarios/networking/ping.py
index ddf6864dc..630b007c2 100644
--- a/yardstick/benchmark/scenarios/networking/ping.py
+++ b/yardstick/benchmark/scenarios/networking/ping.py
@@ -19,7 +19,15 @@ LOG = logging.getLogger(__name__)
 
 
 class Ping(base.Scenario):
-    """Executes a ping benchmark between two hosts"""
+    """Execute ping between two hosts
+
+  Parameters
+    packetsize - number of data bytes to send
+        type:    int
+        unit:    bytes
+        default: 56
+    """
+
     __scenario_type__ = "Ping"
 
     TARGET_SCRIPT = 'ping_benchmark.bash'
diff --git a/yardstick/benchmark/scenarios/networking/pktgen.py b/yardstick/benchmark/scenarios/networking/pktgen.py
index 8038cad60..430c95905 100644
--- a/yardstick/benchmark/scenarios/networking/pktgen.py
+++ b/yardstick/benchmark/scenarios/networking/pktgen.py
@@ -18,7 +18,11 @@ LOG.setLevel(logging.DEBUG)
 
 
 class Pktgen(base.Scenario):
-    """Executes a pktgen benchmark between two hosts"""
+    """Execute pktgen between two hosts
+
+  Parameters
+    TBD
+    """
     __scenario_type__ = "Pktgen"
 
     TARGET_SCRIPT = 'pktgen_benchmark.bash'