754fd9242de7ecd937c8b77a43652c9d769c1ab3
[csit.git] / docs / report / nsh_sfc_functional_tests / overview.rst
1 Overview
2 ========
3
4 Tested Virtual Topologies
5 -------------------------
6
7 CSIT NSH_SFC functional tests are executed on virtualized topologies created using
8 :abbr:`VIRL (Virtual Internet Routing Lab)` simulation platform contributed by
9 Cisco. VIRL runs on physical baremetal servers hosted by LF FD.io project.
10 Majority of the tests are executed in the three node logical test topology -
11 Traffic Generator (TG) node and two Systems Under Test (SUT) nodes connected in
12 a loop. Some tests use two node logical test topology - TG node and SUT1 node.
13 Both logical test topologies are shown in the figures below.::
14
15     +------------------------+           +------------------------+
16     |                        |           |                        |
17     |  +------------------+  |           |  +------------------+  |
18     |  |                  <----------------->                  |  |
19     |  |                  |  |           |  |                  |  |
20     |  |       DUT1       <----------------->       DUT2       |  |
21     |  +--^--^------------+  |           |  +------------^--^--+  |
22     |     |  |               |           |               |  |     |
23     |     |  |         SUT1  |           |  SUT2         |  |     |
24     +------------------------+           +------------------------+
25           |  |                                           |  |
26           |  |                                           |  |
27           |  |               +-----------+               |  |
28           |  +--------------->           <---------------+  |
29           |                  |    TG     |                  |
30           +------------------>           <------------------+
31                              +-----------+
32
33                        +------------------------+
34                        |                        |
35                        |  +------------------+  |
36           +--------------->                  <--------------+
37           |            |  |                  |  |           |
38           |  |------------>       DUT1       <-----------+  |
39           |  |         |  +------------------+  |        |  |
40           |  |         |                        |        |  |
41           |  |         |                  SUT1  |        |  |
42           |  |         +------------------------+        |  |
43           |  |                                           |  |
44           |  |                                           |  |
45           |  |               +-----------+               |  |
46           |  +--------------->           <---------------+  |
47           |                  |    TG     |                  |
48           +------------------>           <------------------+
49                              +-----------+
50
51 SUT1 and SUT2 are two VMs (Ubuntu or Centos, depending on the test suite), TG
52 is a Traffic Generator (TG, another Ubuntu VM). SUTs run VPP SW application in
53 Linux user-mode as a Device Under Test (DUT) within the VM. TG runs Scapy SW
54 application as a packet Traffic Generator. Logical connectivity between SUTs
55 and to TG is provided using virtual NICs using VMs' virtio driver.
56
57 Virtual testbeds are created on-demand whenever a verification job is started
58 (e.g. triggered by the gerrit patch submission) and destroyed upon completion
59 of all functional tests. Each node is a Virtual Machine and each connection
60 that is drawn on the diagram is available for use in any test case. During the
61 test execution, all nodes are reachable thru the Management network connected
62 to every node via dedicated virtual NICs and virtual links (not shown above
63 for clarity).
64
65 For the test cases that require DUT (VPP) to communicate with VM over the
66 vhost-user interfaces, a nested VM is created on SUT1 and/or SUT2 for the
67 duration of these particular test cases only. DUT (VPP) test topology with VM
68 is shown in the figure below including the applicable packet flow thru the VM
69 (marked in the figure with ``***``).::
70
71     +------------------------+           +------------------------+
72     |      +----------+      |           |      +----------+      |
73     |      |    VM    |      |           |      |    VM    |      |
74     |      |  ******  |      |           |      |  ******  |      |
75     |      +--^----^--+      |           |      +--^----^--+      |
76     |        *|    |*        |           |        *|    |*        |
77     |  +------v----v------+  |           |  +------v----v------+  |
78     |  |      *    *      |**|***********|**|      *    *      |  |
79     |  |  *****    *******<----------------->*******    *****  |  |
80     |  |  *    DUT1       |  |           |  |       DUT2    *  |  |
81     |  +--^---------------+  |           |  +---------------^--+  |
82     |    *|                  |           |                  |*    |
83     |    *|            SUT1  |           |  SUT2            |*    |
84     +------------------------+           +------------------^-----+
85          *|                                                 |*
86          *|                                                 |*
87          *|                  +-----------+                  |*
88          *|                  |           |                  |*
89          *+------------------>    TG     <------------------+*
90          ******************* |           |********************
91                              +-----------+
92
93 NSH_SFC Functional Tests Coverage
94 ---------------------------------
95
96 Following NSH_SFC functional test areas are covered in the CSIT |release| with
97 results listed in this report:
98
99 - **NSH SFC Classifier** - TG sends some TCP packets to test NSH SFC
100   Classifier functional. DUT1 will receive these packets from one NIC and loopback
101   the VXLAN-GPE-NSH encapsulated packets to the TG from other NIC.
102   - Test case count: 7
103 - **NSH SFC Proxy Inbound** - TG sends some VXLAN-GPE-NSH encapsulated packets
104   to test NSH SFC Proxy Inbound functional. DUT1 will receive these packets from one
105   NIC and loopback the VXLAN encapsulated packets to the TG from other NIC.
106   - Test case count: 6
107 - **NSH SFC Proxy Outbound** - TG sends some VXLAN encapsulated packets to test
108   NSH SFC Proxy Outbound functional. DUT1 will receive these packets from one NIC
109   and loopback the VXLAN-GPE-NSH encapsulated packets to the TG from other NIC.
110   - Test case count: 6
111 - **NSH SFC Service Function Forward** - TG sends some VXLAN-GPE-NSH encapsulated
112   packets to test NSH SFC Service Function Forward functional. DUT1 will receive these
113   packets from one NIC and swap the VXLAN-GPE-NSH header, after that DUT1 loopback the
114   VXLAN-GPE-NSH encapsulated packtes to the TG from other NIC.
115   - Test case count: 6
116
117 Total 25 NSH SFC functional tests in the CSIT |release|.
118