diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/report/detailed_test_configuration/index.rst | 8 | ||||
-rw-r--r-- | docs/report/index.rst | 3 | ||||
-rw-r--r-- | docs/report/introduction/csit_tag_description.rst | 417 | ||||
-rw-r--r-- | docs/report/introduction/index.rst | 1 | ||||
-rw-r--r-- | docs/report/test_configuration/index.rst | 7 | ||||
-rw-r--r-- | docs/report/test_configuration/vpp_functional_configuration/index.rst (renamed from docs/report/detailed_test_configuration/vpp_functional_configuration/index.rst) | 0 | ||||
-rw-r--r-- | docs/report/test_configuration/vpp_performance_configuration/index.rst (renamed from docs/report/detailed_test_configuration/vpp_performance_configuration/index.rst) | 0 | ||||
-rw-r--r-- | docs/report/test_operational_data/index.rst | 6 | ||||
-rw-r--r-- | docs/report/test_operational_data/vpp_performance_operational_data/index.rst (renamed from docs/report/detailed_test_configuration/vpp_performance_operational_data/index.rst) | 0 | ||||
-rw-r--r-- | docs/tag_documentation.rst | 24 |
10 files changed, 435 insertions, 31 deletions
diff --git a/docs/report/detailed_test_configuration/index.rst b/docs/report/detailed_test_configuration/index.rst deleted file mode 100644 index 96f2187518..0000000000 --- a/docs/report/detailed_test_configuration/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -Detailed Test Configuration -=========================== - -.. toctree:: - - vpp_performance_configuration/index - vpp_performance_operational_data/index - vpp_functional_configuration/index diff --git a/docs/report/index.rst b/docs/report/index.rst index 5ccc4b66c9..6f2989e45e 100644 --- a/docs/report/index.rst +++ b/docs/report/index.rst @@ -11,4 +11,5 @@ CSIT 17.04 honeycomb_functional_tests/index vpp_unit_tests/index detailed_test_results/index - detailed_test_configuration/index + test_configuration/index + test_operational_data/index diff --git a/docs/report/introduction/csit_tag_description.rst b/docs/report/introduction/csit_tag_description.rst new file mode 100644 index 0000000000..4c0e628450 --- /dev/null +++ b/docs/report/introduction/csit_tag_description.rst @@ -0,0 +1,417 @@ +CSIT TAGs Descriptions +====================== + +Documentation for tags used to select and identify test cases. + + +Topology TAGs +------------- + +.. topic:: 3_NODE_DOUBLE_LINK_TOPO + + 3 nodes connected in a circular topology with two links interconnecting + the devices. + +.. topic:: 3_NODE_SINGLE_LINK_TOPO + + 3 nodes connected in a circular topology with at least one link + interconnecting devices. + +Objective TAGs +-------------- + +.. topic:: SKIP_PATCH + + 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). + + +Environment TAGs +---------------- + +.. topic:: HW_ENV + + DUTs and TGs are running on bare metal. + +.. topic:: VM_ENV + + DUTs and TGs are running in virtual environment. + +.. topic:: VPP_VM_ENV + + DUTs with VPP and capable of running Virtual Machine. + + +NIC model tags +-------------- + +.. topic:: NIC_Intel-X520-DA2 + + Intel X520-DA2 NIC. + +.. topic:: NIC_Intel-XL710 + + Intel XL710 NIC. + +.. topic:: NIC_Intel-X710 + + Intel X710 NIC. + +.. topic:: NIC_Cisco-VIC-1227 + + VIC-1227 by Cisco. + +.. topic:: NIC_Cisco-VIC-1385 + + VIC-1385 by Cisco. + + +Scaling TAGs +------------ + +.. topic:: FIB_20K + + 2x10,000 entries in single fib table + +.. topic:: FIB_200K + + 2x100,000 entries in single fib table + +.. topic:: FIB_2M + + 2x1,000,000 entries in single fib table + + +Tags marking functional vs. performance of tests +------------------------------------------------ + +.. topic:: FUNCTEST + + All functional test cases. + +.. topic:: PERFTEST + + All performance test cases. + + +Performance testing tags +------------------------ + +.. topic:: PDRDISC + + Partial Drop Rate evaluation of single run result, with non-zero packet + loss tolerance (LT) expressed in percentage of packets transmitted. + +.. topic:: NDRDISC + + Non Drop Rate evaluation of results. Loss acceptance of dropped packets is + set to zero lost packets. + +.. topic:: NDRCHK + + Performance tests where TG verifies DUTs' throughput at ref-NDR (reference + Non Drop Rate) with zero packet loss tolerance. + +.. topic:: NDRPDRDISC + + Find performance of DUT based on RFC2544 with linear / binary / combined + search. (Previous LONG tests.) + +Ethernet frame size tags for performance tests +---------------------------------------------- + +.. topic:: 64B + + 64B frames used for test. + +.. topic:: 78B + + 78B frames used for test. + +.. topic:: IMIX + + IMIX frame sequence (28x 64B, 16x 570B, 4x 1518B) used for test. + +.. topic:: 1460B + + 1460B frames used for test. + +.. topic:: 1480B + + 1480B frames used for test. + +.. topic:: 1514B + + 1514B frames used for test. + +.. topic:: 1518B + + 1518B frames used for test. + +.. topic:: 9000B + + 9000B frames used for test. + +Test type tags +-------------- + +.. topic:: BASE + + Baseline test cases, no encapsulation, no feature(s) configured in tests. + +.. topic:: IP4BASE + + IPv4 baseline test cases, no encapsulation, no feature(s) configured in + tests. + +.. topic:: IP6BASE + + IPv6 baseline test cases, no encapsulation, no feature(s) configured in + tests. + +.. topic:: L2XCBASE + + L2XC baseline test cases, no encapsulation, no feature(s) configured in + tests. + +.. topic:: L2BDBASE + + L2BD baseline test cases, no encapsulation, no feature(s) configured in + tests. + +.. topic:: SCALE + + Scale test cases. + +.. topic:: ENCAP + + Test cases where encapsulation is used. Use also encapsulation tag(s). + +.. topic:: FEATURE + + At least one feature is configured in test cases. Use also feature tag(s). + + +Forwarding mode tags +-------------------- + +.. topic:: L2BDMACSTAT + + VPP L2 bridge-domain, L2 MAC static. + +.. topic:: L2BDMACLRN + + VPP L2 bridge-domain, L2 MAC learning. + +.. topic:: L2XCFWD + + VPP L2 point-to-point cross-connect. + +.. topic:: IP4FWD + + VPP IPv4 routed forwarding. + +.. topic:: IP6FWD + + VPP IPv6 routed forwarding. + + +Underlay tags +------------- + +.. topic:: IP4UNRLAY + + IPv4 underlay. + +.. topic:: IP6UNRLAY + + IPv6 underlay. + +.. topic:: MPLSUNRLAY + + MPLS underlay. + + +Overlay tags +------------ + +.. topic:: L2OVRLAY + + L2 overlay. + +.. topic:: IP4OVRLAY + + IPv4 overlay (IPv4 payload). + +.. topic:: IP6OVRLAY + + IPv6 overlay (IPv6 payload). + + +Encapsulation tags +------------------ + +.. topic:: ETH + + All test cases with base Ethernet (no encapsulation). + +.. topic:: DOT1Q + + All test cases with dot1q. + +.. topic:: DOT1AD + + All test cases with dot1ad. + +.. topic:: LISP + + All test cases with LISP. + +.. topic:: LISPGPE + + All test cases with LISP-GPE. + +.. topic:: VXLAN + + All test cases with Vxlan. + +.. topic:: VXLANGPE + + All test cases with VXLAN-GPE. + +.. topic:: GRE + + All test cases with GRE. + +.. topic:: IPSEC + + All test cases with IPSEC. + + +Interface tags +-------------- + +.. topic:: PHY + + All test cases which use physical interface(s). + +.. topic:: VHOST + + All test cases which uses VHOST. + +.. topic:: TUNTAP + + All test cases which uses TUN and TAP. + +.. topic:: AFPKT + + All test cases which uses AFPKT. + +.. topic:: NETMAP + + All test cases which uses Netmap. + + +Feature tags +------------ + +.. topic:: IACLDST + + iACL destination. + +.. topic:: COPWHLIST + + COP whitelist. + +.. topic:: SNAT + + SNAT configured and tested. + + +Encryption tags +--------------- + +.. topic:: IPSECSW + + Crypto in software. + +.. topic:: IPSECHW + + Crypto in hardware. + +.. topic:: IPSECTRAN + + IPSec in transport mode. + +.. topic:: IPSECTUN + + IPSec in tunnel mode. + + +Client-workload tags +-------------------- + +.. topic:: VM + + All test cases which use at least one virtual machine. + +.. topic:: LXC + + All test cases which use Linux container. + +.. topic:: APP + + All test cases with specific APP use. + + +Multi-threading tags +-------------------- + +.. topic:: STHREAD + + All test cases using single poll mode thread. + +.. topic:: MTHREAD + + All test cases using more then one poll mode driver thread. + +.. topic:: 1NUMA + + All test cases with packet processing on single socket. + +.. topic:: 2NUMA + + All test cases with packet processing on two sockets. + +.. topic:: SMT + + All test cases with symmetric Multi-Threading (HyperThreading) enabled. + +.. topic:: NOSMT + + All test cases with symmetric Multi-Threading (HyperThreading) disabled. + +.. topic:: 1T1C + + 1 worker thread pinned to 1 dedicated physical core. 1 receive queue per + interface. Main thread pinned to core 0. + +.. topic:: 2T2C + + 2 worker threads pinned to 2 dedicated physical cores. 1 receive queue per + interface. Main thread pinned to core 0. + +.. topic:: 4T4C + + 4 worker threads pinned to 4 dedicated physical cores. 2 receive queues per + interface. Main thread pinned to core 0. + +.. topic:: 6T6C + + 6 worker threads pinned to 6 dedicated physical cores. 3 receive queues per + interface. Main thread pinned to core 0. + +.. topic:: 8T8C + + 8 worker threads pinned to 8 dedicated physical cores. 4 receive queues per + interface. Main thread pinned to core 0. diff --git a/docs/report/introduction/index.rst b/docs/report/introduction/index.rst index 1a485e2b1e..7c74f46cd1 100644 --- a/docs/report/introduction/index.rst +++ b/docs/report/introduction/index.rst @@ -6,3 +6,4 @@ Introduction overview general_notes csit_test_naming + csit_tag_description diff --git a/docs/report/test_configuration/index.rst b/docs/report/test_configuration/index.rst new file mode 100644 index 0000000000..908f494082 --- /dev/null +++ b/docs/report/test_configuration/index.rst @@ -0,0 +1,7 @@ +Test Configuration +================== + +.. toctree:: + + vpp_performance_configuration/index + vpp_functional_configuration/index diff --git a/docs/report/detailed_test_configuration/vpp_functional_configuration/index.rst b/docs/report/test_configuration/vpp_functional_configuration/index.rst index c13f2d48fd..c13f2d48fd 100644 --- a/docs/report/detailed_test_configuration/vpp_functional_configuration/index.rst +++ b/docs/report/test_configuration/vpp_functional_configuration/index.rst diff --git a/docs/report/detailed_test_configuration/vpp_performance_configuration/index.rst b/docs/report/test_configuration/vpp_performance_configuration/index.rst index 1d1b03f561..1d1b03f561 100644 --- a/docs/report/detailed_test_configuration/vpp_performance_configuration/index.rst +++ b/docs/report/test_configuration/vpp_performance_configuration/index.rst diff --git a/docs/report/test_operational_data/index.rst b/docs/report/test_operational_data/index.rst new file mode 100644 index 0000000000..44e7fb0809 --- /dev/null +++ b/docs/report/test_operational_data/index.rst @@ -0,0 +1,6 @@ +Test Operational Data
+=====================
+
+.. toctree::
+
+ vpp_performance_operational_data/index
diff --git a/docs/report/detailed_test_configuration/vpp_performance_operational_data/index.rst b/docs/report/test_operational_data/vpp_performance_operational_data/index.rst index 460c29b5a1..460c29b5a1 100644 --- a/docs/report/detailed_test_configuration/vpp_performance_operational_data/index.rst +++ b/docs/report/test_operational_data/vpp_performance_operational_data/index.rst diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst index b0210becf1..4c0e628450 100644 --- a/docs/tag_documentation.rst +++ b/docs/tag_documentation.rst @@ -1,25 +1,5 @@ -.. |copy| unicode:: 0xA9 .. copyright sign - -| Copyright |copy| 2016 Cisco and/or its affiliates. -| Licensed under the Apache License, Version 2.0 (the "License"); -| you may not use this file except in compliance with the License. -| You may obtain a copy of the License at: -| -| http://www.apache.org/licenses/LICENSE-2.0 -| -| Unless required by applicable law or agreed to in writing, software -| distributed under the License is distributed on an "AS IS" BASIS, -| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -| See the License for the specific language governing permissions and -| limitations under the License. - - -.. contents:: Table of Contents - :depth: 2 - - -TAGs and their descriptions -=========================== +CSIT TAGs Descriptions +====================== Documentation for tags used to select and identify test cases. |