docs/tag_documentation.rst

   1 .. |copy| unicode:: 0xA9 .. copyright sign
   2
   3 | Copyright |copy| 2016 Cisco and/or its affiliates.
   4 | Licensed under the Apache License, Version 2.0 (the "License");
   5 | you may not use this file except in compliance with the License.
   6 | You may obtain a copy of the License at:
   7 |
   8 |     http://www.apache.org/licenses/LICENSE-2.0
   9 |
  10 | Unless required by applicable law or agreed to in writing, software
  11 | distributed under the License is distributed on an "AS IS" BASIS,
  12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 | See the License for the specific language governing permissions and
  14 | limitations under the License.
  15
  16
  17 .. contents:: Table of Contents
  18     :depth: 2
  19
  20
  21 TAGs and their descriptions
  22 ===========================
  23
  24 Documentation for tags used to select and identify test cases.
  25
  26
  27 Topology TAGs
  28 -------------
  29
  30 .. topic:: 3_NODE_DOUBLE_LINK_TOPO
  31
  32     3 nodes connected in a circular topology with two links interconnecting
  33     the devices.
  34
  35 .. topic:: 3_NODE_SINGLE_LINK_TOPO
  36
  37     3 nodes connected in a circular topology with at least one link
  38     interconnecting devices.
  39
  40 Objective TAGs
  41 --------------
  42
  43 .. topic:: SKIP_PATCH
  44
  45     Test case(s) marked to not run in case of vpp-csit-verify (i.e. VPP patch)
  46     and csit-vpp-verify jobs (i.e. CSIT patch).
  47
  48
  49 Environment TAGs
  50 ----------------
  51
  52 .. topic:: HW_ENV
  53
  54     DUTs and TGs are running on bare metal.
  55
  56 .. topic:: VM_ENV
  57
  58     DUTs and TGs are running in virtual environment.
  59
  60 .. topic:: VPP_VM_ENV
  61
  62     DUTs with VPP and capable of running Virtual Machine.
  63
  64
  65 NIC model tags
  66 --------------
  67
  68 .. topic:: NIC_Intel-X520-DA2
  69
  70     Intel X520-DA2 NIC.
  71
  72 .. topic:: NIC_Intel-XL710
  73
  74     Intel XL710 NIC.
  75
  76 .. topic:: NIC_Intel-X710
  77
  78     Intel X710 NIC.
  79
  80
  81 Scaling TAGs
  82 ------------
  83
  84 .. topic:: FIB_20K
  85
  86     2x10,000 entries in single fib table
  87
  88 .. topic:: FIB_200K
  89
  90     2x100,000 entries in single fib table
  91
  92 .. topic:: FIB_2M
  93
  94     2x1,000,000 entries in single fib table
  95
  96
  97 Tags marking the kinds of tags
  98 ------------------------------
  99
 100 .. topic:: FUNCTEST
 101
 102     All functional test cases.
 103
 104 .. topic:: PERFTEST
 105
 106     All performance test cases.
 107
 108
 109 Performance testing tags
 110 ------------------------
 111
 112 .. topic:: PDRDISC
 113
 114     Partial Drop Rate evaluation of single run result, with non-zero packet
 115     loss tolerance (LT) expressed in percentage of packets transmitted.
 116
 117 .. topic:: NDRDISC
 118
 119     Non Drop Rate evaluation of results. Loss acceptance of dropped packets is
 120     set to zero lost packets.
 121
 122 .. topic:: NDRCHK
 123
 124     Performance tests where TG verifies DUTs' throughput at ref-NDR (reference
 125     Non Drop Rate) with zero packet loss tolerance.
 126
 127 .. topic:: NDRPDRDISC
 128
 129     Find performance of DUT based on RFC2544 with linear / binary / combined
 130     search. (Previous LONG tests.)
 131
 132
 133 Test type tags
 134 --------------
 135
 136 .. topic:: BASE
 137
 138     Baseline test cases, no encapsulation, no feature(s) configured in tests.
 139
 140 .. topic:: SCALE
 141
 142     Scale test cases.
 143
 144 .. topic:: ENCAP
 145
 146     Test cases where encapsulation is used. Use also encapsulation tag(s).
 147
 148 .. topic:: FEATURE
 149
 150     At least one feature is configured in test cases. Use also feature tag(s).
 151
 152
 153 Forwarding mode tags
 154 --------------------
 155
 156 .. topic:: L2BDMACSTAT
 157
 158     VPP L2 bridge-domain, L2 MAC static.
 159
 160 .. topic:: L2BDMACLRN
 161
 162     VPP L2 bridge-domain, L2 MAC learning.
 163
 164 .. topic:: L2XCFWD
 165
 166     VPP L2 point-to-point cross-connect.
 167
 168 .. topic:: IP4FWD
 169
 170     VPP IPv4 routed forwarding.
 171
 172 .. topic:: IP6FWD
 173
 174     VPP IPv6 routed forwarding.
 175
 176
 177 Underlay tags
 178 ----------
 179
 180 .. topic:: IP4UNRLAY
 181
 182     IPv4 underlay.
 183
 184 .. topic:: IP6UNRLAY
 185
 186     IPv6 underlay.
 187
 188 .. topic:: MPLSUNRLAY
 189
 190     MPLS underlay.
 191
 192
 193 Overlay tags
 194 ----------
 195
 196 .. topic:: L2OVRLAY
 197
 198     L2 overlay.
 199
 200 .. topic:: IP4OVRLAY
 201
 202     IPv4 overlay (IPv4 payload).
 203
 204 .. topic:: IP6OVRLAY
 205
 206     IPv6 overlay (IPv6 payload).
 207
 208
 209 Encapsulation tags
 210 ------------------
 211
 212 .. topic:: ETH
 213
 214     All test cases with base Ethernet (no encapsulation).
 215
 216 .. topic:: DOT1Q
 217
 218     All test cases with dot1q.
 219
 220 .. topic:: DOT1AD
 221
 222     All test cases with dot1ad.
 223
 224 .. topic:: LISP
 225
 226     All test cases with LISP.
 227
 228 .. topic:: LISPGPE
 229
 230     All test cases with LISP-GPE.
 231
 232 .. topic:: VXLAN
 233
 234     All test cases with Vxlan.
 235
 236 .. topic:: VXLANGPE
 237
 238     All test cases with VXLAN-GPE.
 239
 240 .. topic:: GRE
 241
 242     All test cases with GRE.
 243
 244
 245 Interface tags
 246 --------------
 247
 248 .. topic:: PHY
 249
 250     All test cases which use physical interface(s).
 251
 252 .. topic:: VHOST
 253
 254     All test cases which uses VHOST.
 255
 256 .. topic:: TUNTAP
 257
 258     All test cases which uses TUN and TAP.
 259
 260 .. topic:: AFPKT
 261
 262     All test cases which uses AFPKT.
 263
 264 .. topic:: NETMAP
 265
 266     All test cases which uses Netmap.
 267
 268
 269 Feature tags
 270 ------------
 271
 272 .. topic:: IACLDST
 273
 274     iACL destination.
 275
 276 .. topic:: COPWHLIST
 277
 278     COP whitelist.
 279
 280
 281 Client-workload tags
 282 --------------------
 283
 284 .. topic:: VM
 285
 286     All test cases which use at least one virtual machine.
 287
 288 .. topic:: LXC
 289
 290     All test cases which use Linux container.
 291
 292 .. topic:: APP
 293
 294     All test cases with specific APP use.
 295
 296
 297 Multi-threading tags
 298 --------------------
 299
 300 .. topic:: STHREAD
 301
 302     All test cases using single poll mode thread.
 303
 304 .. topic:: MTHREAD
 305
 306     All test cases using more then one poll mode driver thread.
 307
 308 .. topic:: 1NUMA
 309
 310     All test cases with packet processing on single socket.
 311
 312 .. topic:: 2NUMA
 313
 314     All test cases with packet processing on two sockets.
 315
 316 .. topic:: SMT
 317
 318     All test cases with symmetric Multi-Threading (HyperThreading) enabled.
 319
 320 .. topic:: NOSMT
 321
 322     All test cases with symmetric Multi-Threading (HyperThreading) disabled.
 323
 324 .. topic:: 1T1C
 325
 326     1 worker thread pinned to 1 dedicated physical core. 1 receive queue per
 327     interface. Main thread pinned to core 0.
 328
 329 .. topic:: 2T2C
 330
 331     2 worker threads pinned to 2 dedicated physical cores. 1 receive queue per
 332     interface. Main thread pinned to core 0.
 333
 334 .. topic:: 4T4C
 335
 336     4 worker threads pinned to 4 dedicated physical cores. 2 receive queues per
 337     interface. Main thread pinned to core 0.
 338
 339 .. topic:: 6T6C
 340
 341     6 worker threads pinned to 6 dedicated physical cores. 3 receive queues per
 342     interface. Main thread pinned to core 0.
 343
 344 .. topic:: 8T8C
 345
 346     8 worker threads pinned to 8 dedicated physical cores. 4 receive queues per
 347     interface. Main thread pinned to core 0.