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