resources/tools/doc_gen/src/index.rst

   1 .. |csit| replace:: Continuous System Integration and Testing
   2
   3
   4 |csit| Description
   5 ==================
   6
   7 #. Development of software code for fully automated VPP code testing, functionality, performance, regression and new functions.
   8 #. Execution of CSIT test suites on VPP code running on LF FD.io virtual and physical compute environments.
   9 #. Integration with FD.io continuous integration systems (Gerrit, Jenkins and such).
  10 #. Identified existing FD.io project dependencies and interactions:
  11     - vpp - Vector Packet Processing.
  12     - honeycomb - Honeycomb Agent for management plane testing.
  13     - ci-management - Management repo for Jenkins Job Builder, script and management related to the Jenkins CI configuration.
  14
  15 Project Scope
  16 -------------
  17
  18 #. Automated regression testing of VPP code changes
  19     - Functionality of VPP data plane, network control plane, management plane against functional specifications.
  20     - Performance of VPP data plane including non-drop-rate packet throughput and delay, against established reference benchmarks.
  21     - Performance of network control plane against established reference benchmarks.
  22     - Performance of management plane against established reference benchmarks.
  23 #. Test case definitions driven by supported and planned VPP functionality, interfaces and performance:
  24     - Uni-dimensional tests: Data plane, (Network) Control plane, Management plane.
  25     - Multi-dimensional tests: Use case driven.
  26 #. Integration with FD.io Continuous Integration system including FD.io Gerrit and Jenkins
  27     - Automated test execution triggered by VPP-VERIFY jobs other VPP and CSIT project jobs.
  28 #. Integration with LF VPP test execution environment
  29     - Functional tests execution on LF hosted VM environment.
  30     - Performance and functional tests execution on LF hosted physical compute environment.
  31     - Subset of tests executed on LF hosted physical compute running VIRL (Virtual Internet Routing Lab).
  32
  33 |csit| Documentation
  34 --------------------
  35
  36 Python Library
  37 ##############
  38
  39 .. toctree::
  40    :maxdepth: 2
  41    :glob:
  42
  43    resources.libraries.python
  44
  45 Robot Library
  46 #############
  47
  48 .. toctree::
  49    :maxdepth: 2
  50    :glob:
  51
  52    resources.libraries.robot
  53
  54 Functional Tests
  55 ################
  56
  57 .. toctree::
  58    :maxdepth: 3
  59    :glob:
  60
  61    tests.func
  62
  63 Performance Tests
  64 #################
  65
  66 .. toctree::
  67    :maxdepth: 2
  68    :glob:
  69
  70    tests.perf
  71
  72
  73 Indices and tables
  74 ==================
  75
  76 * :ref:`genindex`
  77 * :ref:`modindex`
  78 * :ref:`search`