CSIT-744 Update report content for proper parsing
[csit.git] / docs / report / vpp_functional_tests / overview.rst
1 Overview\r
2 ========\r
3 \r
4 Tested Virtual Topologies\r
5 -------------------------\r
6 \r
7 CSIT VPP functional tests are executed on virtualized topologies created using\r
8 :abbr:`VIRL (Virtual Internet Routing Lab)` simulation platform contributed by\r
9 Cisco. VIRL runs on physical baremetal servers hosted by LF FD.io project.\r
10 Majority of the tests are executed in the three node logical test topology -\r
11 Traffic Generator (TG) node and two Systems Under Test (SUT) nodes connected in\r
12 a loop. Some tests use two node logical test topology - TG node and SUT1 node.\r
13 Both logical test topologies are shown in the figures below.::\r
14 \r
15     +------------------------+           +------------------------+\r
16     |                        |           |                        |\r
17     |  +------------------+  |           |  +------------------+  |\r
18     |  |                  <----------------->                  |  |\r
19     |  |                  |  |           |  |                  |  |\r
20     |  |       DUT1       <----------------->       DUT2       |  |\r
21     |  +--^--^------------+  |           |  +------------^--^--+  |\r
22     |     |  |               |           |               |  |     |\r
23     |     |  |         SUT1  |           |  SUT2         |  |     |\r
24     +------------------------+           +------------------------+\r
25           |  |                                           |  |\r
26           |  |                                           |  |\r
27           |  |               +-----------+               |  |\r
28           |  +--------------->           <---------------+  |\r
29           |                  |    TG     |                  |\r
30           +------------------>           <------------------+\r
31                              +-----------+\r
32 \r
33                        +------------------------+\r
34                        |                        |\r
35                        |  +------------------+  |\r
36           +--------------->                  <--------------+\r
37           |            |  |                  |  |           |\r
38           |  |------------>       DUT1       <-----------+  |\r
39           |  |         |  +------------------+  |        |  |\r
40           |  |         |                        |        |  |\r
41           |  |         |                  SUT1  |        |  |\r
42           |  |         +------------------------+        |  |\r
43           |  |                                           |  |\r
44           |  |                                           |  |\r
45           |  |               +-----------+               |  |\r
46           |  +--------------->           <---------------+  |\r
47           |                  |    TG     |                  |\r
48           +------------------>           <------------------+\r
49                              +-----------+\r
50 \r
51 SUT1 and SUT2 are two VMs (Ubuntu or Centos, depending on the test suite), TG\r
52 is a Traffic Generator (TG, another Ubuntu VM). SUTs run VPP SW application in\r
53 Linux user-mode as a Device Under Test (DUT) within the VM. TG runs Scapy SW\r
54 application as a packet Traffic Generator. Logical connectivity between SUTs\r
55 and to TG is provided using virtual NICs using VMs' virtio driver.\r
56 \r
57 Virtual testbeds are created on-demand whenever a verification job is started\r
58 (e.g. triggered by the gerrit patch submission) and destroyed upon completion\r
59 of all functional tests. Each node is a Virtual Machine and each connection\r
60 that is drawn on the diagram is available for use in any test case. During the\r
61 test execution, all nodes are reachable thru the Management network connected\r
62 to every node via dedicated virtual NICs and virtual links (not shown above\r
63 for clarity).\r
64 \r
65 For the test cases that require DUT (VPP) to communicate with VM over the\r
66 vhost-user interfaces, a nested VM is created on SUT1 and/or SUT2 for the\r
67 duration of these particular test cases only. DUT (VPP) test topology with VM\r
68 is shown in the figure below including the applicable packet flow thru the VM\r
69 (marked in the figure with ``***``).::\r
70 \r
71     +------------------------+           +------------------------+\r
72     |      +----------+      |           |      +----------+      |\r
73     |      |    VM    |      |           |      |    VM    |      |\r
74     |      |  ******  |      |           |      |  ******  |      |\r
75     |      +--^----^--+      |           |      +--^----^--+      |\r
76     |        *|    |*        |           |        *|    |*        |\r
77     |  +------v----v------+  |           |  +------v----v------+  |\r
78     |  |      *    *      |**|***********|**|      *    *      |  |\r
79     |  |  *****    *******<----------------->*******    *****  |  |\r
80     |  |  *    DUT1       |  |           |  |       DUT2    *  |  |\r
81     |  +--^---------------+  |           |  +---------------^--+  |\r
82     |    *|                  |           |                  |*    |\r
83     |    *|            SUT1  |           |  SUT2            |*    |\r
84     +------------------------+           +------------------^-----+\r
85          *|                                                 |*\r
86          *|                                                 |*\r
87          *|                  +-----------+                  |*\r
88          *|                  |           |                  |*\r
89          *+------------------>    TG     <------------------+*\r
90          ******************* |           |********************\r
91                              +-----------+\r
92 \r
93 Functional Tests Coverage\r
94 -------------------------\r
95 \r
96 Following VPP functional test areas are covered in the CSIT |release| with\r
97 results listed in this report:\r
98 \r
99 - **DHCP - Client and Proxy** - Dynamic Host Control Protocol Client and Proxy\r
100   for IPv4, IPv6.\r
101 - **GRE Overlay Tunnels** - Generic Routing Encapsulation for IPv4.\r
102 - **L2BD Ethernet Switching** - L2 Bridge-Domain switched-forwarding for\r
103   untagged Ethernet, dot1q and dot1ad tagged.\r
104 - **L2XC Ethernet Switching** - L2 Cross-Connect switched-forwarding for\r
105   untagged Ethernet, dot1q and dot1ad tagged.\r
106 - **LISP Overlay Tunnels** - Locator/ID Separation Protocol overlay tunnels and\r
107   locator/id mapping control.\r
108 - **Softwire Tunnels** - IPv4-in-IPv6 softwire tunnels.\r
109 - **Cop Address Security** - address white-list and black-list filtering for\r
110   IPv4, IPv6.\r
111 - **IPSec - Tunnels and Transport** - IPSec tunnel and transport modes.\r
112 - **IPv6 Routed-Forwarding** - IPv6 routed-forwarding, NS/ND, RA, ICMPv6.\r
113 - **uRPF Source Security** - unicast Reverse Path Forwarding security.\r
114 - **Tap Interface** - baseline Linux tap interface tests.\r
115 - **Telemetry - IPFIX and SPAN** - IPFIX netflow statistics and SPAN port\r
116   mirroring.\r
117 - **VRF Routed-Forwarding** - multi-context IPVPN routed-forwarding for IPv4,\r
118   IPv6.\r
119 - **iACL Security** - ingress Access Control List security for IPv4, IPv6, MAC.\r
120 - **IPv4 Routed-Forwarding** - IPv4 routed-forwarding, RPF, ARP, Proxy ARP,\r
121   ICMPv4.\r
122 - **QoS Policer Metering** - ingress packet rate measuring and marking for IPv4,\r
123   IPv6.\r
124 - **VLAN Tag Translation** - L2 VLAN tag translation 2to2, 2to1, 1to2, 1to1.\r
125 - **VXLAN Overlay Tunnels** - VXLAN tunneling for L2-over-IP, for IPv4, IPv6.\r
126 \r
127 Functional Tests Naming\r
128 -----------------------\r
129 \r
130 CSIT |release| follows a common structured naming convention for all\r
131 performance and system functional tests, introduced in CSIT |release-1|.\r
132 \r
133 The naming should be intuitive for majority of the tests. Complete\r
134 description of CSIT test naming convention is provided on\r
135 `CSIT test naming wiki page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.\r
136 \r
137 Here few illustrative examples of the new naming usage for functional test\r
138 suites:\r
139 \r
140 #. **Physical port to physical port - a.k.a. NIC-to-NIC, Phy-to-Phy, P2P**\r
141 \r
142    - *eth2p-ethip4-ip4base-func.robot* => 2 ports of Ethernet, IPv4 baseline\r
143      routed forwarding, functional tests.\r
144 \r
145 #. **Physical port to VM (or VM chain) to physical port - a.k.a. NIC2VM2NIC,\r
146    P2V2P, NIC2VMchain2NIC, P2V2V2P**\r
147 \r
148    - *eth2p-ethip4vxlan-l2bdbasemaclrn-eth-2vhost-1vm-func.robot* => 2 ports of\r
149      Ethernet, IPv4 VXLAN Ethernet, L2 bridge-domain switching to/from two vhost\r
150      interfaces and one VM, functional tests.\r

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.