X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Freport%2Fhoneycomb_functional_tests%2Foverview.rst;fp=docs%2Freport%2Fhoneycomb_functional_tests_virl%2Foverview.rst;h=d93de132a946f238a3f92bfc6b596ab8439bddbf;hp=2bfc89a814435a6fd0c6faa5e272a45687ec2f91;hb=da2aa127ee071e37bc4d6060dd39476179e65365;hpb=a1d482fcf9c221cda2f13429810bca945d9f09f4

diff --git a/docs/report/honeycomb_functional_tests_virl/overview.rst b/docs/report/honeycomb_functional_tests/overview.rst
similarity index 77%
rename from docs/report/honeycomb_functional_tests_virl/overview.rst
rename to docs/report/honeycomb_functional_tests/overview.rst
index 2bfc89a814..d93de132a9 100644
--- a/docs/report/honeycomb_functional_tests_virl/overview.rst
+++ b/docs/report/honeycomb_functional_tests/overview.rst
@@ -1,8 +1,8 @@
 Overview
 ========
 
-Tested Topologies VIRL
-----------------------
+Tested Virtual Topologies
+-------------------------
 
 CSIT Honeycomb functional tests are executed on virtualized topologies created
 using Virtual Internet Routing Lab (VIRL) simulation platform contributed by
@@ -45,8 +45,8 @@ 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).
 
-Honeycomb Functional Tests Overview
------------------------------------
+Functional Tests Coverage
+-------------------------
 
 The following Honeycomb functional test areas are included in the CSIT |release|
 with results listed in this report:
@@ -135,3 +135,34 @@ Because of this, test cases follow this general pattern:
 Test cases involving network interfaces utilize the first two interfaces on
 the DUT node.
 
+Functional Tests Naming
+-----------------------
+
+CSIT |release| introduced a common structured naming convention for all
+performance and functional tests. This change was driven by substantially
+growing number and type of CSIT test cases. Firstly, the original practice did
+not always follow any strict naming convention. Secondly test names did not
+always clearly capture tested packet encapsulations, and the actual type or
+content of the tests. Thirdly HW configurations in terms of NICs, ports and
+their locality were not captured either. These were but few reasons that drove
+the decision to change and define a new more complete and stricter test naming
+convention, and to apply this to all existing and new test cases.
+
+The new naming should be intuitive for majority of the tests. The complete
+description of CSIT test naming convention is provided on `CSIT test naming
+page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.
+
+Here few illustrative examples of the new naming usage for functional test
+suites:
+
+#. **Physical port to physical port - a.k.a. NIC-to-NIC, Phy-to-Phy, P2P**
+
+    - *eth2p-ethip4-ip4base-func.robot* => 2 ports of Ethernet, IPv4 baseline
+      routed forwarding, functional tests.
+
+#. **Physical port to VM (or VM chain) to physical port - a.k.a. NIC2VM2NIC,
+   P2V2P, NIC2VMchain2NIC, P2V2V2P**
+
+    - *eth2p-ethip4vxlan-l2bdbasemaclrn-eth-2vhost-1vm-func.robot* => 2 ports of
+      Ethernet, IPv4 VXLAN Ethernet, L2 bridge-domain switching to/from two vhost
+      interfaces and one VM, functional tests.