X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Ftag_documentation.rst;h=c6064c61a30bff5443e319b29a93d40e18a54588;hp=a10ac0e2c655ebdb10a828dc7e74cd3ba0deda69;hb=32188ccdce50accbb80b405c5813543a4131e744;hpb=48eb2c5381fe357980a64803cb660d32bf23626a diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst index a10ac0e2c6..c6064c61a3 100644 --- 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 ------------ @@ -105,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 ------------------------------------------------ @@ -117,7 +134,6 @@ Tags marking functional vs. performance of tests All performance test cases. - Performance testing tags ------------------------ @@ -138,7 +154,7 @@ Performance testing tags .. topic:: NDRPDRDISC - Find performance of DUT based on RFC2544 with linear / binary / combined + Find performance of DUT based on :rfc:`2544` with linear / binary / combined search. (Previous LONG tests.) Ethernet frame size tags for performance tests @@ -215,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 -------------------- @@ -239,7 +258,6 @@ Forwarding mode tags VPP IPv6 routed forwarding. - Underlay tags ------------- @@ -255,7 +273,6 @@ Underlay tags MPLS underlay. - Overlay tags ------------ @@ -271,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 @@ -287,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. @@ -311,7 +330,6 @@ Encapsulation tags All test cases with IPSEC. - Interface tags -------------- @@ -323,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. @@ -335,6 +365,9 @@ Interface tags All test cases which uses Netmap. +.. topic:: MEMIF + + All test cases which uses Memif. Feature tags ------------ @@ -347,10 +380,45 @@ Feature tags COP whitelist. -.. topic:: SNAT +.. topic:: NAT44 + + NAT44 configured and tested. + +.. topic:: NAT64 + + NAT44 configured and tested. - 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 --------------- @@ -371,7 +439,6 @@ Encryption tags IPSec in tunnel mode. - Client-workload tags -------------------- @@ -381,12 +448,44 @@ Client-workload tags .. topic:: LXC - All test cases which use Linux container. + All test cases which use Linux container and LXC utils. + +.. topic:: DOCKER + + All test cases which use Docker as container manager. .. topic:: APP All test cases with specific APP use. +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. Multi-threading tags -------------------- @@ -439,3 +538,23 @@ 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_NSH + + Honeycomb NSH 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.