39b9dc6eacfdf71f85b4258e77b171411fe7b3b1
[csit.git] / docs / report / nsh_sfc_functional_tests / overview.rst
1 Overview
2 ========
3
4 Virtual Topologies
5 ------------------
6
7 CSIT NSH_SFC functional tests are executed in VM-based virtual topologies
8 created on demand using :abbr:`VIRL (Virtual Internet Routing Lab)`
9 simulation platform contributed by Cisco. VIRL runs on physical
10 baremetal servers hosted by LF FD.io project.
11
12 All tests are executed in three-node virtual test topology shown in the
13 figure below.
14
15 .. only:: latex
16
17     .. raw:: latex
18
19         \begin{figure}[H]
20             \centering
21                 \graphicspath{{../_tmp/src/vpp_functional_tests/}}
22                 \includegraphics[width=0.90\textwidth]{virtual-3n-nic2nic}
23                 \label{fig:virtual-3n-nic2nic}
24         \end{figure}
25
26 .. only:: html
27
28     .. figure:: ../vpp_functional_tests/virtual-3n-nic2nic.svg
29         :alt: virtual-3n-nic2nic
30         :align: center
31
32 SUT1 and SUT2 are two VMs (running Ubuntu or Centos, depending on the
33 test suite), TG is a Traffic Generator (running Ubuntu VM). SUTs run VPP
34 with nsh-plugin in Linux user-mode as a Device Under Test (DUT) within
35 the VM. TG runs Scapy SW application as a packet Traffic Generator.
36 Network connectivity between SUTs and to TG is provided using virtual
37 NICs and VMs' virtio drivers.
38
39 Functional Tests Coverage
40 -------------------------
41
42 |csit-release| includes following NSH_SFC functionality tested in
43 virtual VM environment:
44
45 +-----------------------+----------------------------------------------+
46 | Functionality         |  Description                                 |
47 +=======================+==============================================+
48 | NSH SFC Classifier    | TG sends some TCP packets to test NSH SFC    |
49 |                       | Classifier functional. DUT1 will receive     |
50 |                       | these packets from one NIC and loopback the  |
51 |                       | VXLAN-GPE-NSH encapsulated packets to the TG |
52 |                       | from other NIC.                              |
53 |                       | Test case count: 7.                          |
54 +-----------------------+----------------------------------------------+
55 | NSH SFC Proxy Inbound | TG sends some VXLAN-GPE-NSH encapsulated     |
56 |                       | packets to test NSH SFC Proxy Inbound        |
57 |                       | functional. DUT1 will receive these packets  |
58 |                       | from one NIC and loopback the VXLAN          |
59 |                       | encapsulated packets to the TG from other    |
60 |                       | NIC.                                         |
61 |                       | Test case count: 6.                          |
62 +-----------------------+----------------------------------------------+
63 | NSH SFC Proxy         | TG sends some VXLAN encapsulated packets to  |
64 | Outbound              | test NSH SFC Proxy Outbound functional. DUT1 |
65 |                       | will receive these packets from one NIC and  |
66 |                       | loopback the VXLAN-GPE-NSH encapsulated      |
67 |                       | packets to the TG from other NIC.            |
68 |                       | Test case count: 6.                          |
69 +-----------------------+----------------------------------------------+
70 | NSH SFC Service       | TG sends some VXLAN-GPE-NSH                  |
71 | Function Forward      | encapsulated packets to test NSH SFC Service |
72 |                       | Function Forward functional. DUT1 will       |
73 |                       | receive these packets from one NIC and swap  |
74 |                       | the VXLAN-GPE-NSH header, after that DUT1    |
75 |                       | loopback the VXLAN-GPE-NSH encapsulated      |
76 |                       | packets to the TG from other NIC.            |
77 |                       | Test case count: 6.                          |
78 +-----------------------+----------------------------------------------+
79
80 Total 25 NSH_SFC functional tests in the |csit-release|.