From: Miroslav Miklus <mmiklus@cisco.com>
Date: Tue, 12 Apr 2016 12:54:12 +0000 (+0200)
Subject: documentation: long_xconnect test suite documentation
X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=commitdiff_plain;h=d9c35ed4fe07f506a8146cfc295d96049d5a76e9

documentation: long_xconnect test suite documentation

Generate testdoc by using:
 python -m robot.testdoc long_xconnect.robot perf_long_xconnect.html

Change-Id: I12d83de4abb1af4d94e6fd78d05c46018ee5d7d7
Signed-off-by: Miroslav Miklus <mmiklus@cisco.com>
---

diff --git a/tests/suites/performance/long_xconnect.robot b/tests/suites/performance/long_xconnect.robot
index 773bd7cf98..4d441601e5 100644
--- a/tests/suites/performance/long_xconnect.robot
+++ b/tests/suites/performance/long_xconnect.robot
@@ -19,10 +19,19 @@
 | Suite Teardown | 3-node Performance Suite Teardown
 | Test Setup | Setup all DUTs before test
 | Test Teardown  | Run Keyword If Test Failed | Show statistics on all DUTs
-| Documentation | Throughput search suite (long running test suite based on RFC2544).
+| Documentation | *Throughput search suite (based on RFC2544).*
+| ...
+| ... | Test suite uses 3-node topology TG - DUT1 - DUT2 - TG, with one link
+| ... | between nodes. Traffic profile contain 2 L2 streams (1 stream per
+| ... | direction). Packets contain Ethernet header, IPv4 header,
+| ... | IP protocol=61 and random payload. Ethernet header MAC addresses are
+| ... | matching MAC addresses of the TG node.
 
 *** Test Cases ***
 | Find NDR by using linear search and 64B frames through L2 cross connect in 3-node topology
+| | [Documentation]
+| | ... | Find throughput with non drop rate for 64B frames by using
+| | ... | linear search starting at 5Mpps, stepping down with step of 0.1Mpps
 | | ${framesize}= | Set Variable | 64
 | | ${start_rate}= | Set Variable | 5000000
 | | ${step_rate}= | Set Variable | 100000
@@ -33,6 +42,9 @@
 | | ...                                       | 3-node-xconnect | ${min_rate} | ${max_rate}
 
 | Find NDR by using linear search and 1518B frames through L2 cross connect in 3-node topology
+| | [Documentation]
+| | ... | Find throughput with non drop rate for 1518B frames by using
+| | ... | linear search starting at 812,743pps, stepping down with step of 10,000pps
 | | ${framesize}= | Set Variable | 1518
 | | ${start_rate}= | Set Variable | 812743
 | | ${step_rate}= | Set Variable | 10000
@@ -43,6 +55,9 @@
 | | ...                                       | 3-node-xconnect | ${min_rate} | ${max_rate}
 
 | Find NDR by using linear search and 9000B frames through L2 cross connect in 3-node topology
+| | [Documentation]
+| | ... | Find throughput with non drop rate for 9000B frames by using
+| | ... | linear search starting at 138,580pps, stepping down with step 5,000pps
 | | ${framesize}= | Set Variable | 9000
 | | ${start_rate}= | Set Variable | 138580
 | | ${step_rate}= | Set Variable | 5000