Update T-rex to v2.03 part II
[csit.git] / docs / tag_documentation.rst
1 # Copyright (c) 2016 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
5 #
6 #     http://www.apache.org/licenses/LICENSE-2.0
7 #
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
13
14 Documentation for tags used to select and identify test cases.
15
16 List of TAGs and their descriptions
17 ===================================
18
19 Topology TAGs
20 -------------
21
22 3_NODE_DOUBLE_LINK_TOPO
23     3 nodes connected in a circular topology with two links interconnecting
24     the devices.
25
26 3_NODE_SINGLE_LINK_TOPO
27     3 nodes connected in a circular topoloty with at least one link
28     interconnecting devices.
29
30 Objective TAGs
31 --------------
32
33 Environment TAGs
34 ----------------
35
36 HW_ENV
37     DUTs and TGs are running on bare metal.
38
39 VM_ENV
40     DUTs and TGs are running in virtual environment.
41
42 VPP_VM_ENV
43     DUTs with VPP and capable of running Virtual Machine.
44
45 DUT Setup TAGs
46 --------------
47
48 1_THREAD_NOHTT_RSS_1
49     1 worker thread pinned to dedicated core without use of Hyper-threading
50     technology with 1 thread per interface. Main thread pinned to core 0.
51
52 2_THREAD_NOHTT_RSS_1
53     2 worker threads each pinned to dedicated core without use of Hyper-threading
54     technology with 1 thread per interface. Main thread pinned to core 0.
55
56 4_THREAD_NOHTT_RSS_2
57     4 worker threads each pinned to dedicated core without use of Hyper-threading
58     technology with 2 threads per interface. Main thread pinned to core 0.
59
60 6_THREAD_NOHTT_RSS_3
61     6 worker threads each pinned to dedicated core without use of Hyper-threading
62     technology with 3 threads per interface. Main thread pinned to core 0.
63
64 8_THREAD_HTT_RSS_4
65     8 worker threads each pinned to dedicated core without use of Hyper-threading
66     technology with 4 threads per interface. Main thread pinned to core 0.
67
68 SINGLE_THREAD
69     All single threaded test cases.
70
71 MULTI_THREAD
72     All test cases with more then one thread.
73
74 Performance testing TAGs
75 ------------------------
76
77 PERFTEST
78     All performance test cases.
79
80 PERFTEST_SHORT
81     Performance of DUT should pass specific value. Each test case run is
82     executed for 10 seconds.
83
84 PERFTEST_LONG
85     Find performance of DUT based on RFC2544 with linear/binary/combined
86     search. Each test case run is executed for 60 seconds.
87
88 PDR
89     Partial Drop Rate evaluation of single run result. Loss acceptance of
90     dropped packets from number of sent packet is set as variable in frames or
91     percentage.
92
93 NDR
94     Non Drop Rate evaluation of results. Loss acceptance of dropped packets is
95     set to zero lost packets.