README.md

   1 # CSIT - Continuous System Integration Testing
   2
   3 1. [Architecture](#architecture)
   4 1. [Directory Structure](#directory-structure)
   5    1. [Tests](#tests)
   6    1. [Keywords](#keywords)
   7    1. [Other Resources](#other-resources)
   8 1. [Quickstart](#quick-start)
   9    1. [Vagrant](#vagrant)
  10    1. [Physical Testbed](#physical-testbed)
  11 1. [Report](#report)
  12 1. [Trending](#trending)
  13 1. [Code Documentation](#code-documentation)
  14 1. [Coding Guidelines](#coding-guidelines)
  15
  16 ## Architecture
  17
  18 FD.io CSIT system design needs to meet continuously expanding requirements of
  19 FD.io projects including VPP, related sub-systems (e.g. plugin applications,
  20 DPDK drivers) and FD.io applications (e.g. DPDK applications), as well as
  21 growing number of compute platforms running those applications. With CSIT
  22 project scope and charter including both FD.io continuous testing AND
  23 performance trending/comparisons, those evolving requirements further amplify
  24 the need for CSIT framework modularity, flexibility and usability.
  25
  26 CSIT follows a hierarchical system design with SUTs and DUTs at the bottom level
  27 of the hierarchy, presentation level at the top level and a number of functional
  28 layers in-between. The current CSIT system design including CSIT framework is
  29 depicted in the figure below.
  30
  31 ![csit design](docs/report/csit_framework_documentation/csit_design_picture.svg "CSIT architecture")
  32
  33 A brief bottom-up description is provided here:
  34
  35 1. SUTs, DUTs, TGs
  36    - SUTs - Systems Under Test;
  37    - DUTs - Devices Under Test;
  38    - TGs - Traffic Generators;
  39 1. Level-1 libraries - Robot and Python
  40    - Lowest level CSIT libraries abstracting underlying test environment, SUT,
  41      DUT and TG specifics;
  42    - Used commonly across multiple L2 KWs;
  43    - Performance and functional tests:
  44      - L1 KWs (KeyWords) are implemented as RF libraries and Python
  45        libraries;
  46    - Performance TG L1 KWs:
  47      - All L1 KWs are implemented as Python libraries:
  48        - Support for TRex only today;
  49    - Performance data plane traffic profiles:
  50      - TG-specific stream profiles provide full control of:
  51        - Packet definition – layers, MACs, IPs, ports, combinations thereof
  52          e.g. IPs and UDP ports;
  53        - Stream definitions - different streams can run together, delayed,
  54          one after each other;
  55        - Stream profiles are independent of CSIT framework and can be used
  56          in any T-rex setup, can be sent anywhere to repeat tests with
  57          exactly the same setup;
  58        - Easily extensible – one can create a new stream profile that meets
  59          tests requirements;
  60        - Same stream profile can be used for different tests with the same
  61          traffic needs;
  62    - Functional data plane traffic scripts:
  63      - Scapy specific traffic scripts;
  64 1. Level-2 libraries - Robot resource files
  65    - Higher level CSIT libraries abstracting required functions for executing
  66      tests;
  67    - L2 KWs are classified into the following functional categories:
  68      - Configuration, test, verification, state report;
  69      - Suite setup, suite teardown;
  70      - Test setup, test teardown;
  71 1. Tests - Robot
  72    - Device tests using containerized environment with SR-IOV access to a NIC;
  73      - VPP;
  74    - Performance tests using physical testbed environment:
  75      - VPP;
  76      - DPDK-Testpmd;
  77      - DPDK-L3Fwd;
  78    - Tools:
  79      - Documentation generator;
  80      - Report generator;
  81      - Testbed environment setup ansible playbooks;
  82      - Operational debugging scripts;
  83
  84 ## Directory Structure
  85
  86 ### Tests
  87
  88 ```
  89 .
  90 └── tests
  91     ├── dpdk
  92     │   ├── dpdk_scripts            # DPDK helper scripts
  93     │   └── perf                    # DPDK performance tests
  94     └── vpp
  95         ├── device                  # VPP device tests
  96         └── perf                    # VPP performance tests
  97 ```
  98
  99 ### Keywords
 100
 101 ```
 102 .
 103 resources
 104 └── libraries
 105     ├── bash                        # Contains a dependency of KubernetesUtils
 106     │   ├── config                  # Config for KubernetesUtils dependency
 107     │   ├── entry                   # Main bootstrap entry directory
 108     │   ├── function                # Bootstrap function library
 109     │   └── shell                   # Various functions for KubernetesUtils
 110     ├── python                      # Python L1 KWs
 111     └── robot                       # Robot Framework L2 KWs
 112 ```
 113
 114 ### Other Resources
 115
 116 ```
 117 .
 118 ├── docs                            # Main documentaion
 119 |── fdio.infra.ansible              # Infrastructure provisioning
 120 |── fdio.infra.pxe                  # Preboot eXecution Environment
 121 |── fdio.infra.terraform            # Virtual infrastructure deployment
 122 |── GPL                             # Files licensed under GPL
 123 │   ├── traffic_profiles            # Performance tests traffic profiles
 124 │   │   └── trex
 125 │   └── traffic_scripts             # Functional tests traffic profiles
 126 ├── PyPI                            # PyPI packages provided by CSIT
 127 │   ├── jumpavg
 128 │   └── MLRsearch
 129 ├── resources
 130 │   ├── api                         # API coverage
 131 │   ├── templates                   # Templates (vpp_api_test, kubernetes, ...)
 132 │   ├── test_data                   # Robot Test configuration
 133 │   ├── tools
 134 │   │   ├── disk-image-builder      # Utilities for building (DCR, VM) images
 135 │   │   ├── doc_gen                 # Code documentation generator
 136 │   │   ├── papi                    # PAPI driver
 137 │   │   ├── presentation            # Report generator
 138 │   │   ├── scripts                 # Various tools
 139 │   │   ├── topology                # Helper scripts for topology manipulation
 140 │   │   ├── trex                    # TRex driver
 141 │   │   └── vagrant                 # VPP device vagrant environment
 142 │   ├── topology_schemas
 143 └── topologies                      # Linux Foundation topology files
 144     ├── available
 145     └── enabled
 146 ```
 147
 148 ## Quickstart
 149
 150 ### Vagrant
 151
 152 [Vagrant environment preparation](docs/testing_in_vagrant.rst) documentaion is
 153 describing local VPP Device functional testing.
 154
 155 ## Report
 156
 157 [CSIT Report](https://docs.fd.io/csit/master/report/).
 158
 159 ## Trending
 160
 161 [CSIT Trending](https://docs.fd.io/csit/master/trending/).
 162
 163 ## Code Documentation
 164
 165 [CSIT Code Documentation](https://docs.fd.io/csit/master/doc/).
 166
 167 ## Coding Guidelines
 168
 169 If you are interested in contributing, please see the
 170 [coding guidelines](docs/test_code_guidelines.rst).