1807 report: updated virtual topologies for all functional tests.
[csit.git] / docs / report / nsh_sfc_functional_tests / overview.rst
index c9156fb..6d36f37 100644 (file)
@@ -4,20 +4,13 @@ Overview
 Virtual Topologies
 ------------------
 
-CSIT NSH_SFC functional tests are executed on virtualized topologies created
-using :abbr:`VIRL (Virtual Internet Routing Lab)` simulation platform
-contributed by Cisco. VIRL runs on physical baremetal servers hosted by LF FD.io
-project. Based on the packet path thru server SUTs, one logical
-topology type is used for VPP DUT data plane testing:
+CSIT NSH_SFC functional tests are executed in VM-based virtual topologies
+created on demand using :abbr:`VIRL (Virtual Internet Routing Lab)`
+simulation platform contributed by Cisco. VIRL runs on physical
+baremetal servers hosted by LF FD.io project.
 
-#. NIC-to-NIC switching topologies.
-
-NIC-to-NIC Switching
-~~~~~~~~~~~~~~~~~~~~
-
-The simplest logical topology for software data plane application like
-VPP is NIC-to-NIC switching. Tested topology for the 3-Node
-testbeds is shown in the figure below.
+All tests are executed in three-node virtual test topology shown in the
+figure below.
 
 .. only:: latex
 
@@ -25,62 +18,67 @@ testbeds is shown in the figure below.
 
         \begin{figure}[H]
             \centering
-                \graphicspath{{../_tmp/src/vpp_performance_tests/}}
-                \includegraphics[width=0.90\textwidth]{logical-3n-nic2nic}
-                \label{fig:logical-3n-nic2nic}
+                \graphicspath{{../_tmp/src/vpp_functional_tests/}}
+                \includegraphics[width=0.90\textwidth]{virtual-3n-nic2nic}
+                \label{fig:virtual-3n-nic2nic}
         \end{figure}
 
 .. only:: html
 
-    .. figure:: ../vpp_performance_tests/logical-3n-nic2nic.svg
-        :alt: logical-3n-nic2nic
+    .. figure:: ../vpp_functional_tests/virtual-3n-nic2nic.svg
+        :alt: virtual-3n-nic2nic
         :align: center
 
-SUT1 and SUT2 are two VMs (Ubuntu or Centos, depending on the test suite), TG
-is a Traffic Generator (TG, another Ubuntu VM). SUTs run NSH_SFC SW application
-in Linux user-mode as a Device Under Test (DUT) within the VM. TG runs Scapy SW
-application as a packet Traffic Generator. Logical connectivity between SUTs
-and to TG is provided using virtual NICs using VMs' virtio driver.
-
-Virtual testbeds are created on-demand whenever a verification job is started
-(e.g. triggered by the gerrit patch submission) and destroyed upon completion
-of all functional tests. Each node is a Virtual Machine and each connection
-that is drawn on the diagram is available for use in any test case. During the
-test execution, all nodes are reachable thru the Management network connected
-to every node via dedicated virtual NICs and virtual links (not shown above
-for clarity).
-
-NSH_SFC Functional Tests Coverage
----------------------------------
-
-Following NSH_SFC functional test areas are covered in the |csit-release| with
-results listed in this report:
-
-- **NSH SFC Classifier** - TG sends some TCP packets to test NSH SFC
-  Classifier functional. DUT1 will receive these packets from one NIC and
-  loopback the VXLAN-GPE-NSH encapsulated packets to the TG from other NIC.
-
-  - Test case count: 7
-
-- **NSH SFC Proxy Inbound** - TG sends some VXLAN-GPE-NSH encapsulated packets
-  to test NSH SFC Proxy Inbound functional. DUT1 will receive these packets from
-  one NIC and loopback the VXLAN encapsulated packets to the TG from other NIC.
-
-  - Test case count: 6
-
-- **NSH SFC Proxy Outbound** - TG sends some VXLAN encapsulated packets to test
-  NSH SFC Proxy Outbound functional. DUT1 will receive these packets from one
-  NIC and loopback the VXLAN-GPE-NSH encapsulated packets to the TG from other
-  NIC.
-
-  - Test case count: 6
-
-- **NSH SFC Service Function Forward** - TG sends some VXLAN-GPE-NSH
-  encapsulated packets to test NSH SFC Service Function Forward functional. DUT1
-  will receive these packets from one NIC and swap the VXLAN-GPE-NSH header,
-  after that DUT1 loopback the VXLAN-GPE-NSH encapsulated packtes to the TG from
-  other NIC.
-
-  - Test case count: 6
-
-Total 25 NSH SFC functional tests in the |csit-release|.
+SUT1 and SUT2 are two VMs (running Ubuntu or Centos, depending on the
+test suite), TG is a Traffic Generator (running Ubuntu VM). SUTs run VPP
+with nsh-plugin in Linux user-mode as a Device Under Test (DUT) within
+the VM. TG runs Scapy SW application as a packet Traffic Generator.
+Network connectivity between SUTs and to TG is provided using virtual
+NICs and VMs' virtio drivers.
+
+Functional Tests Coverage
+-------------------------
+
+|csit-release| includes following NSH_SFC functionality tested in
+virtual VM environment:
+
++-----------------------+----------------------------------------------+
+| Functionality         |  Description                                 |
++=======================+==============================================+
+| NSH SFC Classifier    | TG sends some TCP packets to test NSH SFC    |
+|                       | Classifier functional. DUT1 will receive     |
+|                       | these packets from one NIC and loopback the  |
+|                       | VXLAN-GPE-NSH encapsulated packets to the TG |
+|                       | from other NIC.                              |
+|                       |                                              |
+|                       | Test case count: 7.                          |
++-----------------------+----------------------------------------------+
+| NSH SFC Proxy Inbound | TG sends some VXLAN-GPE-NSH encapsulated     |
+|                       | packets to test NSH SFC Proxy Inbound        |
+|                       | functional. DUT1 will receive these packets  |
+|                       | from one NIC and loopback the VXLAN          |
+|                       | encapsulated packets to the TG from other    |
+|                       | NIC.                                         |
+|                       |                                              |
+|                       | Test case count: 6.                          |
++-----------------------+----------------------------------------------+
+| NSH SFC Proxy         | TG sends some VXLAN encapsulated packets to  |
+| Outbound              | test NSH SFC Proxy Outbound functional. DUT1 |
+|                       | will receive these packets from one NIC and  |
+|                       | loopback the VXLAN-GPE-NSH encapsulated      |
+|                       | packets to the TG from other NIC.            |
+|                       |                                              |
+|                       | Test case count: 6.                          |
++-----------------------+----------------------------------------------+
+| NSH SFC Service       | TG sends some VXLAN-GPE-NSH                  |
+| Function Forward      | encapsulated packets to test NSH SFC Service |
+|                       | Function Forward functional. DUT1 will       |
+|                       | receive these packets from one NIC and swap  |
+|                       | the VXLAN-GPE-NSH header, after that DUT1    |
+|                       | loopback the VXLAN-GPE-NSH encapsulated      |
+|                       | packets to the TG from other NIC.            |
+|                       |                                              |
+|                       | Test case count: 6.                          |
++-----------------------+----------------------------------------------+
+
+Total 25 NSH_SFC functional tests in the |csit-release|.