CSIT-699: Add l2bd+dot1q perf tests

[csit.git] / docs / tag_documentation.rst

diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst
index 1e00ea7..e5dd388 100644 (file)
--- a/docs/tag_documentation.rst
+++ b/docs/tag_documentation.rst
@@ -1,8 +1,10 @@
 CSIT TAGs Descriptions
 ======================
 
-Documentation for tags used to select and identify test cases.
-
+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.
 
 Topology TAGs
 -------------
@@ -25,6 +27,9 @@ Objective TAGs
     Test case(s) marked to not run in case of vpp-csit-verify (i.e. VPP patch)
     and csit-vpp-verify jobs (i.e. CSIT patch).
 
+.. topic:: SKIP_VPP_PATCH
+
+    Test case(s) marked to not run in case of vpp-csit-verify (i.e. VPP patch).
 
 Environment TAGs
 ----------------
@@ -41,7 +46,6 @@ Environment TAGs
 
     DUTs with VPP and capable of running Virtual Machine.
 
-
 NIC model tags
 --------------
 
@@ -65,7 +69,6 @@ NIC model tags
 
     VIC-1385 by Cisco.
 
-
 Scaling TAGs
 ------------
 
@@ -81,6 +84,10 @@ Scaling TAGs
 
     2x1,000,000 entries in single fib table
 
+.. topic:: TNL_1000
+
+    IPSec in tunnel mode - 1000 tunnels.
+
 .. topic:: SRC_USER_10
 
     Traffic flow with 10 unique IPs (users) in one direction.
@@ -101,6 +108,20 @@ Scaling TAGs
 
     Traffic flow with 4000 unique IPs (users) in one direction.
 
+.. topic:: 100_FLOWS
+
+    Traffic stream with 100 unique flows (10 IPs/users x 10 UDP ports) in one
+    direction.
+
+.. topic:: 10k_FLOWS
+
+    Traffic stream with 10 000 unique flows (10 IPs/users x 1000 UDP ports) in
+    one direction.
+
+.. topic:: 100k_FLOWS
+
+    Traffic stream with 100 000 unique flows (100 IPs/users x 1000 UDP ports) in
+    one direction.
 
 Tags marking functional vs. performance of tests
 ------------------------------------------------
@@ -113,7 +134,6 @@ Tags marking functional vs. performance of tests
 
     All performance test cases.
 
-
 Performance testing tags
 ------------------------
 
@@ -211,6 +231,9 @@ Test type tags
 
     At least one feature is configured in test cases. Use also feature tag(s).
 
+.. topic:: TLDK
+
+    Functional test cases for TLDK.
 
 Forwarding mode tags
 --------------------
@@ -235,7 +258,6 @@ Forwarding mode tags
 
     VPP IPv6 routed forwarding.
 
-
 Underlay tags
 -------------
 
@@ -251,7 +273,6 @@ Underlay tags
 
     MPLS underlay.
 
-
 Overlay tags
 ------------
 
@@ -267,13 +288,8 @@ Overlay tags
 
     IPv6 overlay (IPv6 payload).
 
-
-Encapsulation tags
-------------------
-
-.. topic:: ETH
-
-    All test cases with base Ethernet (no encapsulation).
+Tagging tags
+------------
 
 .. topic:: DOT1Q
 
@@ -283,6 +299,13 @@ Encapsulation tags
 
     All test cases with dot1ad.
 
+Encapsulation tags
+------------------
+
+.. topic:: ETH
+
+    All test cases with base Ethernet (no encapsulation).
+
 .. topic:: LISP
 
     All test cases with LISP.
@@ -307,7 +330,6 @@ Encapsulation tags
 
     All test cases with IPSEC.
 
-
 Interface tags
 --------------
 
@@ -319,6 +341,18 @@ Interface tags
 
     All test cases which uses VHOST.
 
+.. topic:: VHOST_256
+
+    All test cases which uses VHOST with qemu queue size set to 256.
+
+.. topic:: VHOST_1024
+
+    All test cases which uses VHOST with qemu queue size set to 1024.
+
+.. topic:: CFS_OPT
+
+    All test cases which uses VM with optimised scheduler policy.
+
 .. topic:: TUNTAP
 
     All test cases which uses TUN and TAP.
@@ -331,6 +365,9 @@ Interface tags
 
     All test cases which uses Netmap.
 
+.. topic:: MEMIF
+
+    All test cases which uses Memif.
 
 Feature tags
 ------------
@@ -347,6 +384,37 @@ Feature tags
 
     SNAT configured and tested.
 
+.. topic:: ACL
+
+    ACL plugin configured and tested.
+
+.. topic:: IACL
+
+    ACL plugin configured and tested on input path.
+
+.. topic:: OACL
+
+    ACL plugin configured and tested on output path.
+
+.. topic:: ACL_STATELESS
+
+    ACL plugin configured and tested in stateless mode (permit action).
+
+.. topic:: ACL_STATEFUL
+
+    ACL plugin configured and tested in stateful mode (permit+reflect action).
+
+.. topic:: ACL1
+
+    ACL plugin configured and tested with 1 not-hitting ACE.
+
+.. topic:: ACL10
+
+    ACL plugin configured and tested with 10 not-hitting ACEs.
+
+.. topic:: ACL50
+
+    ACL plugin configured and tested with 50 not-hitting ACEs.
 
 Encryption tags
 ---------------
@@ -367,7 +435,6 @@ Encryption tags
 
     IPSec in tunnel mode.
 
-
 Client-workload tags
 --------------------
 
@@ -383,7 +450,6 @@ Client-workload tags
 
     All test cases with specific APP use.
 
-
 Multi-threading tags
 --------------------
 
@@ -435,3 +501,19 @@ Multi-threading tags
 
     8 worker threads pinned to 8 dedicated physical cores. 4 receive queues per
     interface. Main thread pinned to core 0.
+
+Honeycomb tags
+--------------
+
+.. topic:: HC_FUNC
+
+    Honeycomb functional test cases.
+
+.. topic:: HC_PERSIST
+
+    Honeycomb persistence test cases.
+
+.. topic:: HC_REST_ONLY
+
+    (Exclusion tag) Honeycomb test cases that cannot be run in Netconf mode
+    using ODL client for Restfconf -> Netconf translation.