csit rls1701 report edits:

- simplified section structure for clarity and readability,
- updated overview sections,
- moved not rls related content from rls_notes to overview sections,
- removed section title suffixes: HW, VIRL.
- completed vpp_unit_tests and vpp_unittest_results sections.
- updated all documentation sections.
- updated rls_notes sections for vpp performance and vpp functional.

Change-Id: Id2c2abbf9d3531ec9f63ecd353f385a0b55ae1ba
Signed-off-by: Maciek Konstantynowicz <mkonstan@cisco.com>
Signed-off-by: pmikus <pmikus@cisco.com>
Signed-off-by: Maciek Konstantynowicz <mkonstan@cisco.com>
Signed-off-by: pmikus <pmikus@cisco.com>
Signed-off-by: Maciek Konstantynowicz <mkonstan@cisco.com>

4 files changed, 123 insertions, 64 deletions

diff --git a/docs/report/introduction/general_notes.rst b/docs/report/introduction/general_notes.rst
new file mode 100644
index 0000000000..c05401e4cc
--- /dev/null
+++ b/docs/report/introduction/general_notes.rst
@@ -0,0 +1,57 @@
+General Notes

+=============

+

+All CSIT test results listed in this report are sourced and auto-generated

+from output.xml Robot Framework (RF) files resulting from LF FD.io Jenkins

+jobs execution against VPP-17.01 release artifacts. References are provided

+to the original LF FD.io Jenkins job results. However, as LF FD.io Jenkins

+infrastructure does not automatically archive all jobs (history record is

+provided for the last 30 days or 40 jobs only), additional references are

+provided to the RF result files that got archived in FD.io nexus online

+storage system.

+

+FD.io CSIT project currently covers multiple FD.io system and sub-system

+testing areas and this is  reflected in this report, where each testing area

+is listed separately, as follows

+

+#. **VPP Performance Tests** - VPP performance are tests executed in physical

+   FD.io testbeds,  focusing on VPP network data plane performance at this stage,

+   both for Phy-to-Phy (NIC-to-NIC) and Phy-to-VM-to-Phy (NIC-to-VM-to-NIC)

+   forwarding topologies. Tested across a range of NICs, 10GE and 40GE

+   interfaces, range of multi-thread and multi-core configurations. VPP

+   application runs in host user- mode. TRex is used as a traffic generator.

+

+#. **Testpmd Performance Tests** - VPP is using DPDK code to control and drive

+   the NICs and physical interfaces. Testpmd tests are used as a baseline to

+   profile the DPDK sub-system of VPP. Testpmd performance tests executed in

+   physical FD.io testbeds, focusing on Testpmd data plane performance for Phy-

+   to-Phy (NIC-to-NIC). Tests cover a range of NICs, 10GE and 40GE interfaces,

+   range of multi-thread and multi-core configurations. Testpmd application runs

+   in host user-mode. TRex is used as a traffic generator.

+

+#. **VPP Functional Tests** - VPP functional tests are executed in virtual

+   FD.io testbeds focusing on VPP packet processing functionality, including

+   network data plane and in -line control plane. Tests cover vNIC-to-vNIC

+   vNIC-to-VM-to-vNIC forwarding topologies. Scapy is used as a traffic

+   generator.

+

+#. **HoneyComb Functional Tests** - HoneyComb functional tests are executed in

+   virtual FD.io testbeds focusing on HoneyComb management and programming

+   functionality of VPP. Tests cover a range of CRUD operations executed

+   against VPP.

+

+CSIT |release| report does also include VPP unit test results. These tests

+have been developed within the FD.io VPP project, and not in CSIT, but they do

+complement tests done by CSIT. They are provided mainly as a reference, to

+give the reader a more complete view of automated testing executed against

+VPP-17.01 release.

+

+FD.io CSIT system is developed using two main coding platforms: Robot

+Framework (RF) and Python. CSIT |release| source code for the executed test

+suites is available in CSIT branch |release| in the directory

+"./tests/<name_of_the_test_suite>". A local copy of CSIT source code can be

+obtained by cloning CSIT git repository - "git clone

+https://gerrit.fd.io/r/csit". The CSIT testing virtual environment can be run

+on a local computer workstation (laptop, server) using Vagrant by following

+the instructions in `CSIT tutorials

+<https://wiki.fd.io/view/CSIT#Tutorials>`_.
\ No newline at end of file
diff --git a/docs/report/introduction/general_remarks.rst b/docs/report/introduction/general_remarks.rst
deleted file mode 100644
index 60fcbd882d..0000000000
--- a/docs/report/introduction/general_remarks.rst
+++ /dev/null
@@ -1,17 +0,0 @@
-General Remarks

-===============

-

-All CSIT test results listed in this report are sourced and auto-generated

-from output.xml Robot Framework (RF) files resulting from LF FD.io Jenkins

-jobs execution against VPP-17.01 release artifacts. References are provided

-to the original LF FD.io Jenkins job results. However, as LF FD.io Jenkins

-infrastructure does not automatically archive all jobs (history record is

-provided for the last 30 dayts or 40 jobs only), additional references are

-provided to the RF result files that got archived in FD.io nexus online

-storage system.

-

-CSIT |release| report does also include VPP make test results, mainly as

-a reference. Although these tests have not been developed FD.io CSIT project,

-but inthe FD.io VPP project, they have been provided in this report to give

-reader a more complete view of automated testing executed against VPP-17.01

-release, as they do complement tests done by CSIT.

diff --git a/docs/report/introduction/index.rst b/docs/report/introduction/index.rst
index 1aa603b692..1a485e2b1e 100644
--- a/docs/report/introduction/index.rst
+++ b/docs/report/introduction/index.rst
@@ -4,5 +4,5 @@ Introduction
 .. toctree::
 
     overview
+    general_notes
     csit_test_naming
-    general_remarks
diff --git a/docs/report/introduction/overview.rst b/docs/report/introduction/overview.rst
index dc86f8600e..ee1a91c174 100644
--- a/docs/report/introduction/overview.rst
+++ b/docs/report/introduction/overview.rst
@@ -1,49 +1,68 @@
 Overview

 ========

 

-This is the **F**\ast **D**\ata **I**/**O** Project (FD.io) **C**\ontinuous

-**S**\ystem **I**\ntegration and **T**\esting (CSIT) project report for CSIT

-|release| system testing of VPP-17.01 release. Initial sections of the report

-describe FD.io functional and performance tests and their continuous execution

-achieved in CSIT |release|. This is followed by high-level overview of FD.io

-test environments running in Linux Foundation (LF) FD.io Continuous

-Performance Labs), CSIT |release| release notes and result highlights.

-Subsequent sections list the functional and performance detailed test results

-generated by LF FD.io Jenkins system executing CSIT jobs running tests

-against the VPP-17.01 release and associated sub-systems (HoneyComb, DPDK).

-

-The exact structure of the report is as follows:

-

-#. ``Introduction`` - Includes: ``Overview`` - this section;

-   ``CSIT Test Naming`` - describing CSIT naming convention for test suites and

-   test cases, important to understand to correctly interpret the reported

-   results; ``General Remarks`` - additional notes related to this report.

-#. ``VPP Performance Tests HW`` - Summary of VPP performance tests executed in

-   physical Hardware testbed. Includes: ``Overview`` - containing topology

-   description and list of executed tests; ``Performance Tests Naming`` - lists

-   CSIT naming specifics for performance tests; ``CSIT Release Notes`` - with

-   changes in CSIT |release| including major test additions, performance

-   improvements, changes in testing environment and methodology and known

-   issues; ``Performance Measurements Methodology`` - details testing

-   methodology followed for multi-thread multi-core, packet throughput and

-   latency, and KVM VM vhost tests; ``Report Addendum Targets`` - lists content

-   to be added to this report as part of CSIT |release|.

-#. ``Testpmd Performance Tests HW`` - ...

-#. ``VPP Functional Tests VIRL`` - ...

-#. ``VPP Functional Tests VPPtest`` - ...

-#. ``HoneyComb Functional Tests VIRL`` - ..

-#. ``VPP Performance Results HW`` - ...

-#. ``Testpmd Performance Results HW`` - ...

-#. ``VPP Functional Results VIRL`` - ...

-#. ``VPP Functional Results VPPtest`` - ...

-#. ``HoneyComb Functional Results VIRL`` - ...

-

-FD.io CSIT system is developed using two main coding platforms: Robot

-Framework (RF) and Python. CSIT |release| source code for the executed test

-suites is available in CSIT branch |release| in the directory

-"./tests/<name_of_the_test_suite>". A local copy of CSIT source code can be

-obtained by cloning CSIT git repository - "git clone

-https://gerrit.fd.io/r/csit". The CSIT testing virtual environment can be run

-on a local computer workstation (laptop, server) using Vagrant by following

-the instructions in `CSIT tutorials

-<https://wiki.fd.io/view/CSIT#Tutorials>`_.

+This is the **F**\ast **D**\ata **I**/**O** Project (**FD.io**) **C**\ontinuous

+**S**\ystem **I**\ntegration and **T**\esting (**CSIT**) project report for CSIT

+|release| system testing of VPP-17.01 release.

+

+The report describes CSIT functional and performance tests and their

+continuous execution delivered in CSIT |release|. A high-level overview is

+provided for each CSIT test environment running in Linux Foundation (LF) FD.io

+Continuous Performance Labs. This is followed by summary of all executed tests

+against the VPP-17.01 release and associated sub-systems (HoneyComb, DPDK),

+CSIT |release| release notes, result highlights and known issues. More

+detailed description of each environment, pointers to CSIT test code

+documentation and detailed test resuls with links to the source data files are

+also provided.

+

+CSIT |release| report contains following main sections and sub-sections:

+

+#. **Introduction** - general introduction to CSIT project; *Overview* -

+   this section; *CSIT Test Naming* - CSIT general naming convention for test

+   suites and test cases, important to recognize the high-level test content

+   and interpret reported results; *General Notes* - general notes related to

+   this report.

+

+#. **VPP Performance Tests** - VPP performance tests executed in physical

+   FD.io testbeds; *Overview* - tested topologies, test coverage and naming

+   specifics, methodology for multi-core, packet throughput and latency, and

+   KVM VM vhost tests; *CSIT Release Notes* - changes in CSIT |release|, added

+   tests, performance changes, environment or methodology changes, known CSIT

+   issues, tests to be added; *Packet Throughput Graphs* and *Packet Latency

+   Graphs* - plotted NDR, PDR throughput and latency results from multiple

+   test job executions; *Test Environment* - environment description ;

+   *Documentation* - source code documentation for VPP performance tests.

+

+#. **Testpmd Performance Tests** - Testpmd performance tests executed in

+   physical FD.io testbeds; *Overview* - tested topologies, test coverage;

+   *CSIT Release Notes* - changes in CSIT |release|, any known CSIT issues;

+   *Tests to Be Added* - performance tests to be added in the next revision of

+   CSIT |release| report; *Packet Throughput Graphs* and *Packet Latency Graphs*

+   - plotted NDR, PDR throughput and latency results from multiple test job

+   executions; *Test Environment* - environment description; *Documentation* -

+   source code documentation for Testpmd performance tests.

+

+#. **VPP Functional Tests** - VPP functional tests executed in virtual

+   FD.io testbeds; *Overview* - tested virtual topologies, test coverage and

+   naming specifics; *CSIT Release Notes* - changes in CSIT |release|, added

+   tests, environment or methodology changes, known CSIT issues, tests to be

+   added; *Test Environment* - environment description ; *Documentation* -

+   source code documentation for VPP functional tests.

+

+#. **HoneyComb Functional Tests** - HoneyComb functional tests executed in

+   virtual FD.io testbeds; *Overview* - tested virtual topologies, test

+   coverage and naming specifics; *CSIT Release Notes* - changes in CSIT

+   |release|, added tests, environment or methodology changes, known CSIT issues,

+   tests to be added; *Test Environment* - environment description ;

+   *Documentation* - source code documentation for Honeycomb functional tests.

+

+#. **VPP Unit Tests** - refers to VPP functional unit tests executed as

+   part of vpp make test verify option within the FD.io VPP project; listed in

+   this report to give a more complete view about executed VPP functional tests;

+   *Overview* - short overview of unit test framework and executed tests;

+   *Documentation* - source code documentation of VPP unit tests.

+

+#. **Detailed Test Results** - auto-generated results from CSIT jobs

+   executions using CSIT Robot Framework output files as source data; *VPP

+   Performance Results*, *Testpmd Performance Results*, *VPP Functional

+   Results*, *HoneyComb Functional Results*, *VPPtest Functional Results*.