docs/report/introduction/overview.rst

   1 Overview
   2 ========
   3
   4 This is the **F**\ast **D**\ata **I**/**O** Project (**FD.io**) **C**\ontinuous
   5 **S**\ystem **I**\ntegration and **T**\esting (**CSIT**) project report for CSIT
   6 |release| system testing of |vpp-release|.
   7
   8 This is the full html version, there is also a reduced
   9 `PDF version of this report`_.
  10
  11 The report describes CSIT functional and performance tests and their
  12 continuous execution delivered in CSIT |release|. A high-level overview is
  13 provided for each CSIT test environment running in :abbr:`LF (Linux Foundation)`
  14 FD.io Continuous Performance Labs. This is followed by summary of all executed
  15 tests against the |vpp-release| and associated FD.io projects and sub-systems
  16 (Honeycomb, DPDK, NSH_SFC), CSIT |release| release notes, result highlights and
  17 known issues discovered in CSIT. More detailed description of each environment,
  18 pointers to CSIT test code documentation and detailed test resuls with links to
  19 the source data files are also provided.
  20
  21 CSIT |release| report contains following main sections and sub-sections:
  22
  23 #. **Introduction** - general introduction to CSIT project; *Overview* -
  24    this section; *CSIT Test Naming* - CSIT general naming convention for test
  25    suites and test cases, important to recognize the high-level test content
  26    and interpret reported results; *General Notes* - general notes related to
  27    this report.
  28
  29 #. **VPP Performance Tests** - VPP performance tests executed in physical
  30    FD.io testbeds; *Overview* - tested topologies, test coverage and naming
  31    specifics, methodology for multi-core, packet throughput and latency, and
  32    KVM VM vhost tests; *CSIT Release Notes* - changes in CSIT |release|, added
  33    tests, performance changes, environment or methodology changes, known CSIT
  34    issues; *Packet Throughput Graphs* and *Packet Latency
  35    Graphs* - plotted NDR, PDR throughput and latency results from multiple
  36    test job executions; *Test Environment* - environment description;
  37    *Documentation* - CSIT source code documentation for VPP performance tests.
  38
  39 #. **DPDK Performance Tests** - DPDK performance tests executed in
  40    physical FD.io testbeds; *Overview* - tested topologies, test coverage;
  41    *CSIT Release Notes* - changes in CSIT |release|, any known CSIT issues;
  42    *Packet Throughput Graphs* and *Packet Latency Graphs*
  43    - plotted NDR, PDR throughput and latency results from multiple test job
  44    executions; *Test Environment* - environment description; *Documentation* -
  45    CSIT source code documentation for DPDK performance tests.
  46
  47 #. **VPP Functional Tests** - VPP functional tests executed in virtual
  48    FD.io testbeds; *Overview* - tested virtual topologies, test coverage and
  49    naming specifics; *CSIT Release Notes* - changes in CSIT |release|, added
  50    tests, environment or methodology changes, known CSIT issues, tests to be
  51    added; *Test Environment* - environment description ; *Documentation* -
  52    source code documentation for VPP functional tests.
  53
  54 #. **Honeycomb Functional Tests** - Honeycomb functional tests executed in
  55    virtual FD.io testbeds; *Overview* - tested virtual topologies, test
  56    coverage and naming specifics; *CSIT Release Notes* - changes in CSIT
  57    |release|, added tests, environment or methodology changes, known CSIT issues;
  58    *Test Environment* - environment description ;
  59    *Documentation* - source code documentation for Honeycomb functional tests.
  60
  61 #. **VPP Unit Tests** - refers to VPP functional unit tests executed as
  62    part of vpp make test verify option within the FD.io VPP project; listed in
  63    this report to give a more complete view about executed VPP functional tests;
  64    *Overview* - short overview of unit test framework and executed tests;
  65    *Documentation* - source code documentation of VPP unit tests.
  66
  67 #. **NSH_SFC Functional Tests** - NSH_SFC functional tests executed in
  68    virtual FD.io testbeds; *Overview* - tested virtual topologies, test
  69    coverage and naming specifics; *CSIT Release Notes* - changes in CSIT
  70    |release|, added tests, environment or methodology changes, known CSIT issues;
  71    *Test Environment* - environment description ;
  72    *Documentation* - source code documentation for NSH_SFC functional tests.
  73
  74 #. **Detailed Test Results** - auto-generated results from CSIT jobs
  75    executions using CSIT Robot Framework output files as source data; *VPP
  76    Performance Results*, *DPDK Performance Results*, *VPP Functional
  77    Results*, *Honeycomb Functional Results*, *VPPtest Functional Results*.
  78
  79 #. **Test Configuration** - auto-generated DUT configuration data from CSIT jobs
  80    executions using CSIT Robot Framework output files as source data; *VPP
  81    Performance Test Configs*, *VPP Functional Test Configs*.
  82
  83 #. **Test Operational Data** - auto-generated DUT operational data from CSIT jobs
  84    executions using CSIT Robot Framework output files as source data; *VPP
  85    Performance Operational Data*.
  86
  87 #. **CSIT Framework Documentation** - description of the overall CSIT
  88    framework design hierarchy, CSIT test naming convention, followed by
  89    description of Presentation and Analytics Layer (PAL) introduced in
  90    CSIT |release|.