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 .. topic:: NIC_Cisco-VIC-1227
  81
  82     VIC-1227 by Cisco.
  83
  84 .. topic:: NIC_Cisco-VIC-1385
  85
  86     VIC-1385 by Cisco.
  87
  88
  89 Scaling TAGs
  90 ------------
  91
  92 .. topic:: FIB_20K
  93
  94     2x10,000 entries in single fib table
  95
  96 .. topic:: FIB_200K
  97
  98     2x100,000 entries in single fib table
  99
 100 .. topic:: FIB_2M
 101
 102     2x1,000,000 entries in single fib table
 103
 104
 105 Tags marking the kinds of tags
 106 ------------------------------
 107
 108 .. topic:: FUNCTEST
 109
 110     All functional test cases.
 111
 112 .. topic:: PERFTEST
 113
 114     All performance test cases.
 115
 116
 117 Performance testing tags
 118 ------------------------
 119
 120 .. topic:: PDRDISC
 121
 122     Partial Drop Rate evaluation of single run result, with non-zero packet
 123     loss tolerance (LT) expressed in percentage of packets transmitted.
 124
 125 .. topic:: NDRDISC
 126
 127     Non Drop Rate evaluation of results. Loss acceptance of dropped packets is
 128     set to zero lost packets.
 129
 130 .. topic:: NDRCHK
 131
 132     Performance tests where TG verifies DUTs' throughput at ref-NDR (reference
 133     Non Drop Rate) with zero packet loss tolerance.
 134
 135 .. topic:: NDRPDRDISC
 136
 137     Find performance of DUT based on RFC2544 with linear / binary / combined
 138     search. (Previous LONG tests.)
 139
 140
 141 Test type tags
 142 --------------
 143
 144 .. topic:: BASE
 145
 146     Baseline test cases, no encapsulation, no feature(s) configured in tests.
 147
 148 .. topic:: SCALE
 149
 150     Scale test cases.
 151
 152 .. topic:: ENCAP
 153
 154     Test cases where encapsulation is used. Use also encapsulation tag(s).
 155
 156 .. topic:: FEATURE
 157
 158     At least one feature is configured in test cases. Use also feature tag(s).
 159
 160
 161 Forwarding mode tags
 162 --------------------
 163
 164 .. topic:: L2BDMACSTAT
 165
 166     VPP L2 bridge-domain, L2 MAC static.
 167
 168 .. topic:: L2BDMACLRN
 169
 170     VPP L2 bridge-domain, L2 MAC learning.
 171
 172 .. topic:: L2XCFWD
 173
 174     VPP L2 point-to-point cross-connect.
 175
 176 .. topic:: IP4FWD
 177
 178     VPP IPv4 routed forwarding.
 179
 180 .. topic:: IP6FWD
 181
 182     VPP IPv6 routed forwarding.
 183
 184
 185 Underlay tags
 186 ----------
 187
 188 .. topic:: IP4UNRLAY
 189
 190     IPv4 underlay.
 191
 192 .. topic:: IP6UNRLAY
 193
 194     IPv6 underlay.
 195
 196 .. topic:: MPLSUNRLAY
 197
 198     MPLS underlay.
 199
 200
 201 Overlay tags
 202 ----------
 203
 204 .. topic:: L2OVRLAY
 205
 206     L2 overlay.
 207
 208 .. topic:: IP4OVRLAY
 209
 210     IPv4 overlay (IPv4 payload).
 211
 212 .. topic:: IP6OVRLAY
 213
 214     IPv6 overlay (IPv6 payload).
 215
 216
 217 Encapsulation tags
 218 ------------------
 219
 220 .. topic:: ETH
 221
 222     All test cases with base Ethernet (no encapsulation).
 223
 224 .. topic:: DOT1Q
 225
 226     All test cases with dot1q.
 227
 228 .. topic:: DOT1AD
 229
 230     All test cases with dot1ad.
 231
 232 .. topic:: LISP
 233
 234     All test cases with LISP.
 235
 236 .. topic:: LISPGPE
 237
 238     All test cases with LISP-GPE.
 239
 240 .. topic:: VXLAN
 241
 242     All test cases with Vxlan.
 243
 244 .. topic:: VXLANGPE
 245
 246     All test cases with VXLAN-GPE.
 247
 248 .. topic:: GRE
 249
 250     All test cases with GRE.
 251
 252 .. topic:: IPSEC
 253
 254     All test cases with IPSEC.
 255
 256
 257 Interface tags
 258 --------------
 259
 260 .. topic:: PHY
 261
 262     All test cases which use physical interface(s).
 263
 264 .. topic:: VHOST
 265
 266     All test cases which uses VHOST.
 267
 268 .. topic:: TUNTAP
 269
 270     All test cases which uses TUN and TAP.
 271
 272 .. topic:: AFPKT
 273
 274     All test cases which uses AFPKT.
 275
 276 .. topic:: NETMAP
 277
 278     All test cases which uses Netmap.
 279
 280
 281 Feature tags
 282 ------------
 283
 284 .. topic:: IACLDST
 285
 286     iACL destination.
 287
 288 .. topic:: COPWHLIST
 289
 290     COP whitelist.
 291
 292 .. topic:: SNAT
 293
 294     SNAT configured and tested.
 295
 296
 297 Encryption tags
 298 ---------------
 299
 300 .. topic:: IPSECSW
 301
 302     Crypto in software.
 303
 304 .. topic:: IPSECHW
 305
 306     Crypto in hardware.
 307
 308 .. topic:: IPSECTRAN
 309
 310     IPSec in transport mode.
 311
 312 .. topic:: IPSECTUN
 313
 314     IPSec in tunnel mode.
 315
 316
 317 Client-workload tags
 318 --------------------
 319
 320 .. topic:: VM
 321
 322     All test cases which use at least one virtual machine.
 323
 324 .. topic:: LXC
 325
 326     All test cases which use Linux container.
 327
 328 .. topic:: APP
 329
 330     All test cases with specific APP use.
 331
 332
 333 Multi-threading tags
 334 --------------------
 335
 336 .. topic:: STHREAD
 337
 338     All test cases using single poll mode thread.
 339
 340 .. topic:: MTHREAD
 341
 342     All test cases using more then one poll mode driver thread.
 343
 344 .. topic:: 1NUMA
 345
 346     All test cases with packet processing on single socket.
 347
 348 .. topic:: 2NUMA
 349
 350     All test cases with packet processing on two sockets.
 351
 352 .. topic:: SMT
 353
 354     All test cases with symmetric Multi-Threading (HyperThreading) enabled.
 355
 356 .. topic:: NOSMT
 357
 358     All test cases with symmetric Multi-Threading (HyperThreading) disabled.
 359
 360 .. topic:: 1T1C
 361
 362     1 worker thread pinned to 1 dedicated physical core. 1 receive queue per
 363     interface. Main thread pinned to core 0.
 364
 365 .. topic:: 2T2C
 366
 367     2 worker threads pinned to 2 dedicated physical cores. 1 receive queue per
 368     interface. Main thread pinned to core 0.
 369
 370 .. topic:: 4T4C
 371
 372     4 worker threads pinned to 4 dedicated physical cores. 2 receive queues per
 373     interface. Main thread pinned to core 0.
 374
 375 .. topic:: 6T6C
 376
 377     6 worker threads pinned to 6 dedicated physical cores. 3 receive queues per
 378     interface. Main thread pinned to core 0.
 379
 380 .. topic:: 8T8C
 381
 382     8 worker threads pinned to 8 dedicated physical cores. 4 receive queues per
 383     interface. Main thread pinned to core 0.