csit rls1701 report edits:

[csit.git] / docs / report / vpp_functional_tests / overview.rst

diff --git a/docs/report/vpp_functional_tests_virl/overview.rst b/docs/report/vpp_functional_tests/overview.rst
similarity index 78%
rename from docs/report/vpp_functional_tests_virl/overview.rst
rename to docs/report/vpp_functional_tests/overview.rst
index 16c7ef7..e85bb92 100644 (file)
--- a/docs/report/vpp_functional_tests_virl/overview.rst
+++ b/docs/report/vpp_functional_tests/overview.rst
@@ -1,8 +1,8 @@
 Overview\r
 ========\r
 \r
 Overview\r
 ========\r
 \r

-Tested Topologies VIRL\r
-----------------------\r
+Tested Virtual Topologies\r
+-------------------------\r

 \r
 CSIT VPP functional tests are executed on virtualized topologies created using\r
 Virtual Internet Routing Lab (VIRL) simulation platform contributed by Cisco.\r
 \r
 CSIT VPP functional tests are executed on virtualized topologies created using\r
 Virtual Internet Routing Lab (VIRL) simulation platform contributed by Cisco.\r


@@ -94,10 +94,10 @@ is shown in the figure below including the applicable packet flow thru the VM
          ******************* |           |********************\r
                              +-----------+\r
 \r
          ******************* |           |********************\r
                              +-----------+\r
 \r

-VPP Functional Tests Overview\r
------------------------------\r
+Functional Tests Coverage\r
+-------------------------\r

 \r
 \r

-Following VPP functional test areas are included in the CSIT |release| with\r
+Following VPP functional test areas are covered in the CSIT |release| with\r

 results listed in this report:\r
 \r
 - **DHCP - Client and Proxy** - Dynamic Host Control Protocol Client and Proxy\r
 results listed in this report:\r
 \r
 - **DHCP - Client and Proxy** - Dynamic Host Control Protocol Client and Proxy\r


@@ -127,3 +127,35 @@ results listed in this report:
   IPv6.\r
 - **VLAN Tag Translation** - L2 VLAN tag translation 2to2, 2to1, 1to2, 1to1.\r
 - **VXLAN Overlay Tunnels** - VXLAN tunneling for L2-over-IP, for IPv4, IPv6.\r
   IPv6.\r
 - **VLAN Tag Translation** - L2 VLAN tag translation 2to2, 2to1, 1to2, 1to1.\r
 - **VXLAN Overlay Tunnels** - VXLAN tunneling for L2-over-IP, for IPv4, IPv6.\r

+\r
+Functional Tests Naming\r
+-----------------------\r
+\r
+CSIT |release| introduced a common structured naming convention for all\r
+performance and functional tests. This change was driven by substantially\r
+growing number and type of CSIT test cases. Firstly, the original practice did\r
+not always follow any strict naming convention. Secondly test names did not\r
+always clearly capture tested packet encapsulations, and the actual type or\r
+content of the tests. Thirdly HW configurations in terms of NICs, ports and\r
+their locality were not captured either. These were but few reasons that drove\r
+the decision to change and define a new more complete and stricter test naming\r
+convention, and to apply this to all existing and new test cases.\r
+\r
+The new naming should be intuitive for majority of the tests. The complete\r
+description of CSIT test naming convention is provided on `CSIT test naming\r
+page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.\r
+\r
+Here few illustrative examples of the new naming usage for functional test\r
+suites:\r
+\r
+#. **Physical port to physical port - a.k.a. NIC-to-NIC, Phy-to-Phy, P2P**\r
+\r
+    - *eth2p-ethip4-ip4base-func.robot* => 2 ports of Ethernet, IPv4 baseline\r
+      routed forwarding, functional tests.\r
+\r
+#. **Physical port to VM (or VM chain) to physical port - a.k.a. NIC2VM2NIC,\r
+   P2V2P, NIC2VMchain2NIC, P2V2V2P**\r
+\r
+    - *eth2p-ethip4vxlan-l2bdbasemaclrn-eth-2vhost-1vm-func.robot* => 2 ports of\r
+      Ethernet, IPv4 VXLAN Ethernet, L2 bridge-domain switching to/from two vhost\r
+      interfaces and one VM, functional tests.\r