Apply minor improvements to methodology docs
[csit.git] / docs / report / vpp_device_tests / overview.rst
1 Overview
2 ========
3
4 Virtual Topologies
5 ------------------
6
7 CSIT VPP Device tests are executed in Physical containerized topologies
8 created on demand using set of scripts hosted and developed under CSIT
9 repository. It runs on physical baremetal servers hosted by LF FD.io project.
10 Based on the packet path thru SUT Containers, two distinct logical topology
11 types are used for VPP DUT data plane testing:
12
13 #. vfNIC-to-vfNIC switching topologies.
14 #. Nested-VM service switching topologies. (Planned to be added in rls1901)
15
16 vfNIC-to-vfNIC Switching
17 ~~~~~~~~~~~~~~~~~~~~~~~~
18
19 The simplest physical topology for software data plane application like
20 VPP is vfNIC-to-vfNIC switching. Tested virtual topologies for 2-Node testbeds
21 are shown in figures below.
22
23 .. only:: latex
24
25     .. raw:: latex
26
27         \begin{figure}[H]
28             \centering
29                 \graphicspath{{../_tmp/src/vpp_device_tests/}}
30                 \includegraphics[width=0.90\textwidth]{vf-2n-nic2nic}
31                 \label{fig:vf-2n-nic2nic}
32         \end{figure}
33
34 .. only:: html
35
36     .. figure:: ../vpp_device_tests/vf-2n-nic2nic.svg
37         :alt: vf-2n-nic2nic
38         :align: center
39
40 SUT1 is Docker Container (running Ubuntu, depending on the test suite), TG is
41 a Traffic Generator (running Ubuntu Container). SUTs run VPP
42 SW application in Linux user-mode as a Device Under Test (DUT) within
43 the container. TG runs Scapy SW application as a packet Traffic Generator.
44 Network connectivity between SUTs and to TG is provided using virtual function
45 of physical NICs.
46
47 Virtual topologies are created on-demand whenever a verification job is
48 started (e.g. triggered by the gerrit patch submission) and destroyed
49 upon completion of all functional tests. Each node is a container running on
50 physical server. During the test execution, all nodes are reachable thru
51 the Management (not shown above for clarity).
52
53 Functional Tests Coverage
54 -------------------------
55
56 |csit-release| includes following VPP functionality tested in virtual VM
57 environment:
58
59 +-----------------------+----------------------------------------------+
60 | Functionality         |  Description                                 |
61 +=======================+==============================================+
62 | IPv4                  | ICMPv4.                                      |
63 +-----------------------+----------------------------------------------+
64 | IPv6                  | ICMPv6.                                      |
65 +-----------------------+----------------------------------------------+
66
67 Tests Naming
68 ------------
69
70 |csit-release| follows a common structured naming convention for all
71 performance and system functional tests, introduced in CSIT-17.01.
72
73 The naming should be intuitive for majority of the tests. Complete
74 description of CSIT test naming convention is provided on
75 :ref:`csit_test_naming`.