Code Review / csit.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Report: Configure 1901.1.13
[csit.git] / docs / tag_documentation.rst
diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst
index e5dd388..56d7861 100644 (file)
--- a/docs/tag_documentation.rst
+++ b/docs/tag_documentation.rst
@@ -1,13 +1,23 @@
-CSIT TAGs Descriptions
-======================
+CSIT Tags
+=========
 
 All CSIT test cases are labelled with Robot Framework tags used to allow for
 easy test case type identification, test case grouping and selection for
 
 All CSIT test cases are labelled with Robot Framework tags used to allow for
 easy test case type identification, test case grouping and selection for
-execution. Following sections list currently used CSIT TAGs and their
-documentation.
+execution. Following sections list currently used CSIT tags and their
+descriptions.
 
 
-Topology TAGs
--------------
+Testbed Topology Tags
+---------------------
+
+.. topic:: 2_NODE_DOUBLE_LINK_TOPO
+
+    2 nodes connected in a circular topology with two links interconnecting
+    the devices.
+
+.. topic:: 2_NODE_SINGLE_LINK_TOPO
+
+    2 nodes connected in a circular topology with at least one link
+    interconnecting devices.
 
 .. topic:: 3_NODE_DOUBLE_LINK_TOPO
 
 
 .. topic:: 3_NODE_DOUBLE_LINK_TOPO
 
@@ -19,7 +29,7 @@ Topology TAGs
     3 nodes connected in a circular topology with at least one link
     interconnecting devices.
 
     3 nodes connected in a circular topology with at least one link
     interconnecting devices.
 
-Objective TAGs
+Objective Tags
 --------------
 
 .. topic:: SKIP_PATCH
 --------------
 
 .. topic:: SKIP_PATCH
@@ -31,7 +41,7 @@ Objective TAGs
 
     Test case(s) marked to not run in case of vpp-csit-verify (i.e. VPP patch).
 
 
     Test case(s) marked to not run in case of vpp-csit-verify (i.e. VPP patch).
 
-Environment TAGs
+Environment Tags
 ----------------
 
 .. topic:: HW_ENV
 ----------------
 
 .. topic:: HW_ENV
@@ -46,7 +56,7 @@ Environment TAGs
 
     DUTs with VPP and capable of running Virtual Machine.
 
 
     DUTs with VPP and capable of running Virtual Machine.
 
-NIC model tags
+NIC Model Tags
 --------------
 
 .. topic:: NIC_Intel-X520-DA2
 --------------
 
 .. topic:: NIC_Intel-X520-DA2
@@ -61,6 +71,14 @@ NIC model tags
 
     Intel X710 NIC.
 
 
     Intel X710 NIC.
 
+.. topic:: NIC_Intel-XXV710
+
+    Intel XXV710 NIC.
+
+.. topic:: NIC_Intel-82599ES
+
+    Intel 82599ES NIC.
+
 .. topic:: NIC_Cisco-VIC-1227
 
     VIC-1227 by Cisco.
 .. topic:: NIC_Cisco-VIC-1227
 
     VIC-1227 by Cisco.
@@ -69,7 +87,7 @@ NIC model tags
 
     VIC-1385 by Cisco.
 
 
     VIC-1385 by Cisco.
 
-Scaling TAGs
+Scaling Tags
 ------------
 
 .. topic:: FIB_20K
 ------------
 
 .. topic:: FIB_20K
@@ -84,6 +102,54 @@ Scaling TAGs
 
     2x1,000,000 entries in single fib table
 
 
     2x1,000,000 entries in single fib table
 
+.. topic:: L2BD_1
+
+    Test with 1 L2 bridge domain.
+
+.. topic:: L2BD_10
+
+    Test with 10 L2 bridge domains.
+
+.. topic:: L2BD_100
+
+    Test with 100 L2 bridge domains.
+
+.. topic:: L2BD_1K
+
+    Test with 1000 L2 bridge domains.
+
+.. topic:: VLAN_1
+
+    Test with 1 VLAN sub-interface.
+
+.. topic:: VLAN_10
+
+    Test with 10 VLAN sub-interfaces.
+
+.. topic:: VLAN_100
+
+    Test with 100 VLAN sub-interfaces.
+
+.. topic:: VLAN_1K
+
+    Test with 1000 VLAN sub-interfaces.
+
+.. topic:: VXLAN_1
+
+    Test with 1 VXLAN tunnel.
+
+.. topic:: VXLAN_10
+
+    Test with 10 VXLAN tunnels.
+
+.. topic:: VXLAN_100
+
+    Test with 100 VXLAN tunnels.
+
+.. topic:: VXLAN_1K
+
+    Test with 1000 VXLAN tunnels.
+
 .. topic:: TNL_1000
 
     IPSec in tunnel mode - 1000 tunnels.
 .. topic:: TNL_1000
 
     IPSec in tunnel mode - 1000 tunnels.
@@ -123,8 +189,8 @@ Scaling TAGs
     Traffic stream with 100 000 unique flows (100 IPs/users x 1000 UDP ports) in
     one direction.
 
     Traffic stream with 100 000 unique flows (100 IPs/users x 1000 UDP ports) in
     one direction.
 
-Tags marking functional vs. performance of tests
-------------------------------------------------
+Test Category Tags
+------------------
 
 .. topic:: FUNCTEST
 
 
 .. topic:: FUNCTEST
 
@@ -134,31 +200,28 @@ Tags marking functional vs. performance of tests
 
     All performance test cases.
 
 
     All performance test cases.
 
-Performance testing tags
-------------------------
-
-.. topic:: PDRDISC
+Performance Type Tags
+---------------------
 
 
-    Partial Drop Rate evaluation of single run result, with non-zero packet
-    loss tolerance (LT) expressed in percentage of packets transmitted.
+.. topic:: NDRPDR
 
 
-.. topic:: NDRDISC
+    Single test finding both No Drop Rate and Partial Drop Rate simultaneously.
+    The search is done by optimized algorithm which performs
+    multiple trial runs at different durations and transmit rates.
+    The results come from the final trials, which have duration of 30 seconds.
 
 
-    Non Drop Rate evaluation of results. Loss acceptance of dropped packets is
-    set to zero lost packets.
+.. topic:: MRR
 
 
-.. topic:: NDRCHK
+    Performance tests where TG sends the traffic at maximum rate (line rate)
+    and reports total sent/received packets over trial duration.
+    The result is an average of 10 trials of 1 second duration.
 
 
-    Performance tests where TG verifies DUTs' throughput at ref-NDR (reference
-    Non Drop Rate) with zero packet loss tolerance.
+.. topic:: SOAK
 
 
-.. topic:: NDRPDRDISC
+    Performance tests using PLRsearch to find the critical load.
 
 
-    Find performance of DUT based on RFC2544 with linear / binary / combined
-    search. (Previous LONG tests.)
-
-Ethernet frame size tags for performance tests
-----------------------------------------------
+Ethernet Frame Size Tags
+------------------------
 
 .. topic:: 64B
 
 
 .. topic:: 64B
 
@@ -168,6 +231,10 @@ Ethernet frame size tags for performance tests
 
     78B frames used for test.
 
 
     78B frames used for test.
 
+.. topic:: 114B
+
+    114B frames used for test.
+
 .. topic:: IMIX
 
     IMIX frame sequence (28x 64B, 16x 570B, 4x 1518B) used for test.
 .. topic:: IMIX
 
     IMIX frame sequence (28x 64B, 16x 570B, 4x 1518B) used for test.
@@ -192,7 +259,7 @@ Ethernet frame size tags for performance tests
 
     9000B frames used for test.
 
 
     9000B frames used for test.
 
-Test type tags
+Test Type Tags
 --------------
 
 .. topic:: BASE
 --------------
 
 .. topic:: BASE
@@ -219,6 +286,11 @@ Test type tags
     L2BD baseline test cases, no encapsulation, no feature(s) configured in
     tests.
 
     L2BD baseline test cases, no encapsulation, no feature(s) configured in
     tests.
 
+.. topic:: L2PATCH
+
+    L2PATCH baseline test cases, no encapsulation, no feature(s) configured in
+    tests.
+
 .. topic:: SCALE
 
     Scale test cases.
 .. topic:: SCALE
 
     Scale test cases.
@@ -235,7 +307,57 @@ Test type tags
 
     Functional test cases for TLDK.
 
 
     Functional test cases for TLDK.
 
-Forwarding mode tags
+.. topic:: DMM
+
+    Functional test cases for DMM.
+
+.. topic:: TCP
+
+    Tests which use TCP.
+
+.. topic:: TCP_CPS
+
+    Performance tests which measure connections per second using http requests.
+
+.. topic:: TCP_RPS
+
+    Performance tests which measure requests per second using http requests.
+
+.. topic:: HTTP
+
+    Tests which use HTTP.
+
+.. topic:: NF_DENSITY
+
+    Performance tests that measure throughput of multiple VNF and CNF
+    service topologies at different service densities.
+
+NF Service Density Tags
+-----------------------
+
+.. topic:: CHAIN
+
+   NF service density tests with VNF or CNF service chain topology(ies).
+
+.. topic:: PIPE
+
+   NF service density tests with CNF service pipeline topology(ies).
+
+.. topic:: NF_L3FWDIP4
+
+   NF service density tests with DPDK l3fwd IPv4 routing as NF workload.
+
+.. topic:: NF_VPPIP4
+
+   NF service density tests with VPP IPv4 routing as NF workload.
+
+.. topic:: {r}R{c}C
+
+   Service density matrix locator {r}R{c}C, {r}Row denoting number of
+   service instances, {c}Column denoting number of NFs per service
+   instance. {r}=(1,2,4,6,8,10), {c}=(1,2,4,6,8,10).
+
+Forwarding Mode Tags
 --------------------
 
 .. topic:: L2BDMACSTAT
 --------------------
 
 .. topic:: L2BDMACSTAT
@@ -258,7 +380,7 @@ Forwarding mode tags
 
     VPP IPv6 routed forwarding.
 
 
     VPP IPv6 routed forwarding.
 
-Underlay tags
+Underlay Tags
 -------------
 
 .. topic:: IP4UNRLAY
 -------------
 
 .. topic:: IP4UNRLAY
@@ -273,7 +395,7 @@ Underlay tags
 
     MPLS underlay.
 
 
     MPLS underlay.
 
-Overlay tags
+Overlay Tags
 ------------
 
 .. topic:: L2OVRLAY
 ------------
 
 .. topic:: L2OVRLAY
@@ -288,7 +410,7 @@ Overlay tags
 
     IPv6 overlay (IPv6 payload).
 
 
     IPv6 overlay (IPv6 payload).
 
-Tagging tags
+Tagging Tags
 ------------
 
 .. topic:: DOT1Q
 ------------
 
 .. topic:: DOT1Q
@@ -299,7 +421,7 @@ Tagging tags
 
     All test cases with dot1ad.
 
 
     All test cases with dot1ad.
 
-Encapsulation tags
+Encapsulation Tags
 ------------------
 
 .. topic:: ETH
 ------------------
 
 .. topic:: ETH
@@ -330,7 +452,11 @@ Encapsulation tags
 
     All test cases with IPSEC.
 
 
     All test cases with IPSEC.
 
-Interface tags
+.. topic:: SRv6
+
+    All test cases with Segment routing over IPv6 dataplane.
+
+Interface Tags
 --------------
 
 .. topic:: PHY
 --------------
 
 .. topic:: PHY
@@ -369,7 +495,53 @@ Interface tags
 
     All test cases which uses Memif.
 
 
     All test cases which uses Memif.
 
-Feature tags
+.. topic:: SINGLE_MEMIF
+
+    All test cases which uses only single Memif connection per DUT. One DUT
+    instance is running in container having one physical interface exposed to
+    container.
+
+.. topic:: LBOND
+
+    All test cases which uses link bonding (BondEthernet interface).
+
+.. topic:: LBOND_DPDK
+
+    All test cases which uses DPDK link bonding.
+
+.. topic:: LBOND_VPP
+
+    All test cases which uses VPP link bonding.
+
+.. topic:: LBOND_MODE_XOR
+
+    All test cases which uses link bonding with mode XOR.
+
+.. topic:: LBOND_MODE_LACP
+
+    All test cases which uses link bonding with mode LACP.
+
+.. topic:: LBOND_LB_L34
+
+    All test cases which uses link bonding with load-balance mode l34.
+
+.. topic:: LBOND_1L
+
+    All test cases which uses one link for link bonding.
+
+.. topic:: LBOND_2L
+
+    All test cases which uses two links for link bonding.
+
+.. topic:: DRV_AVF
+
+    All test cases which uses Intel Adaptive Virtual Function (AVF) device
+    plugin for VPP. This plugins provides native device support for Intel AVF.
+    AVF is driver specification for current and future Intel Virtual Function
+    devices. In essence, today this driver can be used only with Intel
+    XL710 / X710 / XXV710 adapters.
+
+Feature Tags
 ------------
 
 .. topic:: IACLDST
 ------------
 
 .. topic:: IACLDST
@@ -380,9 +552,13 @@ Feature tags
 
     COP whitelist.
 
 
     COP whitelist.
 
-.. topic:: SNAT
+.. topic:: NAT44
+
+    NAT44 configured and tested.
 
 
-    SNAT configured and tested.
+.. topic:: NAT64
+
+    NAT44 configured and tested.
 
 .. topic:: ACL
 
 
 .. topic:: ACL
 
@@ -416,7 +592,23 @@ Feature tags
 
     ACL plugin configured and tested with 50 not-hitting ACEs.
 
 
     ACL plugin configured and tested with 50 not-hitting ACEs.
 
-Encryption tags
+.. topic:: SRv6_PROXY
+
+    SRv6 endpoint to SR-unaware appliance via proxy.
+
+.. topic:: SRv6_PROXY_STAT
+
+    SRv6 endpoint to SR-unaware appliance via static proxy.
+
+.. topic:: SRv6_PROXY_DYN
+
+    SRv6 endpoint to SR-unaware appliance via dynamic proxy.
+
+.. topic:: SRv6_PROXY_MASQ
+
+    SRv6 endpoint to SR-unaware appliance via masquerading proxy.
+
+Encryption Tags
 ---------------
 
 .. topic:: IPSECSW
 ---------------
 
 .. topic:: IPSECSW
@@ -435,7 +627,7 @@ Encryption tags
 
     IPSec in tunnel mode.
 
 
     IPSec in tunnel mode.
 
-Client-workload tags
+Client-Workload Tags
 --------------------
 
 .. topic:: VM
 --------------------
 
 .. topic:: VM
@@ -444,21 +636,64 @@ Client-workload tags
 
 .. topic:: LXC
 
 
 .. topic:: LXC
 
-    All test cases which use Linux container.
+    All test cases which use Linux container and LXC utils.
+
+.. topic:: DRC
+
+    All test cases which use at least one Docker container.
+
+.. topic:: DOCKER
+
+    All test cases which use Docker as container manager.
 
 .. topic:: APP
 
     All test cases with specific APP use.
 
 
 .. topic:: APP
 
     All test cases with specific APP use.
 
-Multi-threading tags
+Container Orchestration Tags
+----------------------------
+
+.. topic:: K8S
+
+    All test cases which use Kubernetes for orchestration.
+
+.. topic:: SFC_CONTROLLER
+
+    All test cases which use ligato/sfc_controller for driving configuration
+    of vpp inside container.
+
+.. topic:: VPP_AGENT
+
+    All test cases which use Golang implementation of a control/management plane
+    for VPP
+
+.. topic:: 1VSWITCH
+
+    VPP running in Docker container acting as VSWITCH.
+
+.. topic:: 1VNF
+
+    1 VPP running in Docker container acting as VNF work load.
+
+.. topic:: 2VNF
+
+    2 VPP running in 2 Docker containers acting as VNF work load.
+
+.. topic:: 4VNF
+
+    4 VPP running in 4 Docker containers acting as VNF work load.
+
+Multi-Threading Tags
 --------------------
 
 .. topic:: STHREAD
 
 --------------------
 
 .. topic:: STHREAD
 
-    All test cases using single poll mode thread.
+   *Dynamic tag*.
+   All test cases using single poll mode thread.
 
 .. topic:: MTHREAD
 
 
 .. topic:: MTHREAD
 
+   *Dynamic tag*.
     All test cases using more then one poll mode driver thread.
 
 .. topic:: 1NUMA
     All test cases using more then one poll mode driver thread.
 
 .. topic:: 1NUMA
@@ -469,46 +704,73 @@ Multi-threading tags
 
     All test cases with packet processing on two sockets.
 
 
     All test cases with packet processing on two sockets.
 
-.. topic:: SMT
+.. topic:: 1C
+
+    1 worker thread pinned to 1 dedicated physical core; or if HyperThreading is
+    enabled, 2 worker threads each pinned to a separate logical core within 1
+    dedicated physical core. Main thread pinned to core 1.
 
 
-    All test cases with symmetric Multi-Threading (HyperThreading) enabled.
+.. topic:: 2C
 
 
-.. topic:: NOSMT
+    2 worker threads pinned to 2 dedicated physical cores; or if HyperThreading
+    is enabled, 4 worker threads each pinned to a separate logical core within 2
+    dedicated physical cores. Main thread pinned to core 1.
 
 
-    All test cases with symmetric Multi-Threading (HyperThreading) disabled.
+.. topic:: 4C
+
+    4 worker threads pinned to 4 dedicated physical cores; or if HyperThreading
+    is enabled, 8 worker threads each pinned to a separate logical core within 4
+    dedicated physical cores. Main thread pinned to core 1.
 
 .. topic:: 1T1C
 
 
 .. topic:: 1T1C
 
+   *Dynamic tag*.
     1 worker thread pinned to 1 dedicated physical core. 1 receive queue per
     1 worker thread pinned to 1 dedicated physical core. 1 receive queue per
-    interface. Main thread pinned to core 0.
+    interface. Main thread pinned to core 1.
 
 .. topic:: 2T2C
 
 
 .. topic:: 2T2C
 
+   *Dynamic tag*.
     2 worker threads pinned to 2 dedicated physical cores. 1 receive queue per
     2 worker threads pinned to 2 dedicated physical cores. 1 receive queue per
-    interface. Main thread pinned to core 0.
+    interface. Main thread pinned to core 1.
 
 .. topic:: 4T4C
 
 
 .. topic:: 4T4C
 
+   *Dynamic tag*.
     4 worker threads pinned to 4 dedicated physical cores. 2 receive queues per
     4 worker threads pinned to 4 dedicated physical cores. 2 receive queues per
-    interface. Main thread pinned to core 0.
+    interface. Main thread pinned to core 1.
+
+.. topic:: 2T1C
 
 
-.. topic:: 6T6C
+   *Dynamic tag*.
+    2 worker threads each pinned to a separate logical core within 1 dedicated
+    physical core. 1 receive queue per interface. Main thread pinned to core 1.
 
 
-    6 worker threads pinned to 6 dedicated physical cores. 3 receive queues per
-    interface. Main thread pinned to core 0.
+.. topic:: 4T2C
 
 
-.. topic:: 8T8C
+   *Dynamic tag*.
+    4 worker threads each pinned to a separate logical core within 2 dedicated
+    physical cores. 2 receive queues per interface. Main thread pinned to core
+    1.
 
 
-    8 worker threads pinned to 8 dedicated physical cores. 4 receive queues per
-    interface. Main thread pinned to core 0.
+.. topic:: 8T4C
 
 
-Honeycomb tags
+   *Dynamic tag*.
+    8 worker threads each pinned to a separate logical core within 4 dedicated
+    physical cores. 4 receive queues per interface. Main thread pinned to core
+    1.
+
+Honeycomb Tags
 --------------
 
 .. topic:: HC_FUNC
 
     Honeycomb functional test cases.
 
 --------------
 
 .. topic:: HC_FUNC
 
     Honeycomb functional test cases.
 
+.. topic:: HC_NSH
+
+    Honeycomb NSH test cases.
+
 .. topic:: HC_PERSIST
 
     Honeycomb persistence test cases.
 .. topic:: HC_PERSIST
 
     Honeycomb persistence test cases.
Integration tests