docs/tag_documentation.rst

   1 CSIT Tags
   2 =========
   3
   4 All CSIT test cases are labelled with Robot Framework tags used to allow for
   5 easy test case type identification, test case grouping and selection for
   6 execution. Following sections list currently used CSIT tags and their
   7 descriptions.
   8
   9 Testbed Topology Tags
  10 ---------------------
  11
  12 .. topic:: 2_NODE_DOUBLE_LINK_TOPO
  13
  14     2 nodes connected in a circular topology with two links interconnecting
  15     the devices.
  16
  17 .. topic:: 2_NODE_SINGLE_LINK_TOPO
  18
  19     2 nodes connected in a circular topology with at least one link
  20     interconnecting devices.
  21
  22 .. topic:: 3_NODE_DOUBLE_LINK_TOPO
  23
  24     3 nodes connected in a circular topology with two links interconnecting
  25     the devices.
  26
  27 .. topic:: 3_NODE_SINGLE_LINK_TOPO
  28
  29     3 nodes connected in a circular topology with at least one link
  30     interconnecting devices.
  31
  32 Objective Tags
  33 --------------
  34
  35 .. topic:: SKIP_PATCH
  36
  37     Test case(s) marked to not run in case of vpp-csit-verify (i.e. VPP patch)
  38     and csit-vpp-verify jobs (i.e. CSIT patch).
  39
  40 .. topic:: SKIP_VPP_PATCH
  41
  42     Test case(s) marked to not run in case of vpp-csit-verify (i.e. VPP patch).
  43
  44 Environment Tags
  45 ----------------
  46
  47 .. topic:: HW_ENV
  48
  49     DUTs and TGs are running on bare metal.
  50
  51 .. topic:: VM_ENV
  52
  53     DUTs and TGs are running in virtual environment.
  54
  55 .. topic:: VPP_VM_ENV
  56
  57     DUTs with VPP and capable of running Virtual Machine.
  58
  59 NIC Model Tags
  60 --------------
  61
  62 .. topic:: NIC_Intel-X520-DA2
  63
  64     Intel X520-DA2 NIC.
  65
  66 .. topic:: NIC_Intel-XL710
  67
  68     Intel XL710 NIC.
  69
  70 .. topic:: NIC_Intel-X710
  71
  72     Intel X710 NIC.
  73
  74 .. topic:: NIC_Intel-XXV710
  75
  76     Intel XXV710 NIC.
  77
  78 .. topic:: NIC_Cisco-VIC-1227
  79
  80     VIC-1227 by Cisco.
  81
  82 .. topic:: NIC_Cisco-VIC-1385
  83
  84     VIC-1385 by Cisco.
  85
  86 Scaling Tags
  87 ------------
  88
  89 .. topic:: FIB_20K
  90
  91     2x10,000 entries in single fib table
  92
  93 .. topic:: FIB_200K
  94
  95     2x100,000 entries in single fib table
  96
  97 .. topic:: FIB_2M
  98
  99     2x1,000,000 entries in single fib table
 100
 101 .. topic:: L2BD_1
 102
 103     Test with 1 L2 bridge domain.
 104
 105 .. topic:: L2BD_10
 106
 107     Test with 10 L2 bridge domains.
 108
 109 .. topic:: L2BD_100
 110
 111     Test with 100 L2 bridge domains.
 112
 113 .. topic:: L2BD_1K
 114
 115     Test with 1000 L2 bridge domains.
 116
 117 .. topic:: VLAN_1
 118
 119     Test with 1 VLAN sub-interface.
 120
 121 .. topic:: VLAN_10
 122
 123     Test with 10 VLAN sub-interfaces.
 124
 125 .. topic:: VLAN_100
 126
 127     Test with 100 VLAN sub-interfaces.
 128
 129 .. topic:: VLAN_1K
 130
 131     Test with 1000 VLAN sub-interfaces.
 132
 133 .. topic:: VXLAN_1
 134
 135     Test with 1 VXLAN tunnel.
 136
 137 .. topic:: VXLAN_10
 138
 139     Test with 10 VXLAN tunnels.
 140
 141 .. topic:: VXLAN_100
 142
 143     Test with 100 VXLAN tunnels.
 144
 145 .. topic:: VXLAN_1K
 146
 147     Test with 1000 VXLAN tunnels.
 148
 149 .. topic:: TNL_1000
 150
 151     IPSec in tunnel mode - 1000 tunnels.
 152
 153 .. topic:: SRC_USER_10
 154
 155     Traffic flow with 10 unique IPs (users) in one direction.
 156
 157 .. topic:: SRC_USER_100
 158
 159     Traffic flow with 100 unique IPs (users) in one direction.
 160
 161 .. topic:: SRC_USER_1000
 162
 163     Traffic flow with 1000 unique IPs (users) in one direction.
 164
 165 .. topic:: SRC_USER_2000
 166
 167     Traffic flow with 2000 unique IPs (users) in one direction.
 168
 169 .. topic:: SRC_USER_4000
 170
 171     Traffic flow with 4000 unique IPs (users) in one direction.
 172
 173 .. topic:: 100_FLOWS
 174
 175     Traffic stream with 100 unique flows (10 IPs/users x 10 UDP ports) in one
 176     direction.
 177
 178 .. topic:: 10k_FLOWS
 179
 180     Traffic stream with 10 000 unique flows (10 IPs/users x 1000 UDP ports) in
 181     one direction.
 182
 183 .. topic:: 100k_FLOWS
 184
 185     Traffic stream with 100 000 unique flows (100 IPs/users x 1000 UDP ports) in
 186     one direction.
 187
 188 Test Category Tags
 189 ------------------
 190
 191 .. topic:: FUNCTEST
 192
 193     All functional test cases.
 194
 195 .. topic:: PERFTEST
 196
 197     All performance test cases.
 198
 199 Performance Type Tags
 200 ---------------------
 201
 202 .. topic:: NDRPDR
 203
 204     Single test finding both No Drop Rate and Partial Drop Rate simultaneously.
 205     The search is done by optimized algorithm which performs
 206     multiple trial runs at different durations and transmit rates.
 207     The results come from the final trials, which have duration of 30 seconds.
 208
 209 .. topic:: MRR
 210
 211     Performance tests where TG sends the traffic at maximum rate (line rate)
 212     and reports total sent/received packets over trial duration.
 213     The result is an average of 10 trials of 1 second duration.
 214
 215 Ethernet Frame Size Tags
 216 ------------------------
 217
 218 .. topic:: 64B
 219
 220     64B frames used for test.
 221
 222 .. topic:: 78B
 223
 224     78B frames used for test.
 225
 226 .. topic:: 114B
 227
 228     114B frames used for test.
 229
 230 .. topic:: IMIX
 231
 232     IMIX frame sequence (28x 64B, 16x 570B, 4x 1518B) used for test.
 233
 234 .. topic:: 1460B
 235
 236     1460B frames used for test.
 237
 238 .. topic:: 1480B
 239
 240     1480B frames used for test.
 241
 242 .. topic:: 1514B
 243
 244     1514B frames used for test.
 245
 246 .. topic:: 1518B
 247
 248     1518B frames used for test.
 249
 250 .. topic:: 9000B
 251
 252     9000B frames used for test.
 253
 254 Test Type Tags
 255 --------------
 256
 257 .. topic:: BASE
 258
 259     Baseline test cases, no encapsulation, no feature(s) configured in tests.
 260
 261 .. topic:: IP4BASE
 262
 263     IPv4 baseline test cases, no encapsulation, no feature(s) configured in
 264     tests.
 265
 266 .. topic:: IP6BASE
 267
 268     IPv6 baseline test cases, no encapsulation, no feature(s) configured in
 269     tests.
 270
 271 .. topic:: L2XCBASE
 272
 273     L2XC baseline test cases, no encapsulation, no feature(s) configured in
 274     tests.
 275
 276 .. topic:: L2BDBASE
 277
 278     L2BD baseline test cases, no encapsulation, no feature(s) configured in
 279     tests.
 280
 281 .. topic:: L2PATCH
 282
 283     L2PATCH baseline test cases, no encapsulation, no feature(s) configured in
 284     tests.
 285
 286 .. topic:: SCALE
 287
 288     Scale test cases.
 289
 290 .. topic:: ENCAP
 291
 292     Test cases where encapsulation is used. Use also encapsulation tag(s).
 293
 294 .. topic:: FEATURE
 295
 296     At least one feature is configured in test cases. Use also feature tag(s).
 297
 298 .. topic:: TLDK
 299
 300     Functional test cases for TLDK.
 301
 302 .. topic:: DMM
 303
 304     Functional test cases for DMM.
 305
 306 .. topic:: TCP
 307
 308     Tests which use TCP.
 309
 310 .. topic:: TCP_CPS
 311
 312     Performance tests which measure connections per second using http requests.
 313
 314 .. topic:: TCP_RPS
 315
 316     Performance tests which measure requests per second using http requests.
 317
 318 .. topic:: HTTP
 319
 320     Tests which use HTTP.
 321
 322 .. topic:: NF_DENSITY
 323
 324     Performance tests that measure throughput of multiple VNF and CNF
 325     service topologies at different service densities.
 326
 327 NF Service Density Tags
 328 -----------------------
 329
 330 .. topic:: CHAIN
 331
 332    NF service density tests with VNF or CNF service chain topology(ies).
 333
 334 .. topic:: PIPE
 335
 336    NF service density tests with CNF service pipeline topology(ies).
 337
 338 .. topic:: NF_L3FWDIP4
 339
 340    NF service density tests with DPDK l3fwd IPv4 routing as NF workload.
 341
 342 .. topic:: NF_VPPIP4
 343
 344    NF service density tests with VPP IPv4 routing as NF workload.
 345
 346 .. topic:: {r}R{c}C
 347
 348    Service density matrix locator {r}R{c}C, {r}Row denoting number of
 349    service instances, {c}Column denoting number of NFs per service
 350    instance. {r}=(1,2,4,6,8,10), {c}=(1,2,4,6,8,10).
 351
 352 Forwarding Mode Tags
 353 --------------------
 354
 355 .. topic:: L2BDMACSTAT
 356
 357     VPP L2 bridge-domain, L2 MAC static.
 358
 359 .. topic:: L2BDMACLRN
 360
 361     VPP L2 bridge-domain, L2 MAC learning.
 362
 363 .. topic:: L2XCFWD
 364
 365     VPP L2 point-to-point cross-connect.
 366
 367 .. topic:: IP4FWD
 368
 369     VPP IPv4 routed forwarding.
 370
 371 .. topic:: IP6FWD
 372
 373     VPP IPv6 routed forwarding.
 374
 375 Underlay Tags
 376 -------------
 377
 378 .. topic:: IP4UNRLAY
 379
 380     IPv4 underlay.
 381
 382 .. topic:: IP6UNRLAY
 383
 384     IPv6 underlay.
 385
 386 .. topic:: MPLSUNRLAY
 387
 388     MPLS underlay.
 389
 390 Overlay Tags
 391 ------------
 392
 393 .. topic:: L2OVRLAY
 394
 395     L2 overlay.
 396
 397 .. topic:: IP4OVRLAY
 398
 399     IPv4 overlay (IPv4 payload).
 400
 401 .. topic:: IP6OVRLAY
 402
 403     IPv6 overlay (IPv6 payload).
 404
 405 Tagging Tags
 406 ------------
 407
 408 .. topic:: DOT1Q
 409
 410     All test cases with dot1q.
 411
 412 .. topic:: DOT1AD
 413
 414     All test cases with dot1ad.
 415
 416 Encapsulation Tags
 417 ------------------
 418
 419 .. topic:: ETH
 420
 421     All test cases with base Ethernet (no encapsulation).
 422
 423 .. topic:: LISP
 424
 425     All test cases with LISP.
 426
 427 .. topic:: LISPGPE
 428
 429     All test cases with LISP-GPE.
 430
 431 .. topic:: VXLAN
 432
 433     All test cases with Vxlan.
 434
 435 .. topic:: VXLANGPE
 436
 437     All test cases with VXLAN-GPE.
 438
 439 .. topic:: GRE
 440
 441     All test cases with GRE.
 442
 443 .. topic:: IPSEC
 444
 445     All test cases with IPSEC.
 446
 447 .. topic:: SRv6
 448
 449     All test cases with Segment routing over IPv6 dataplane.
 450
 451 Interface Tags
 452 --------------
 453
 454 .. topic:: PHY
 455
 456     All test cases which use physical interface(s).
 457
 458 .. topic:: VHOST
 459
 460     All test cases which uses VHOST.
 461
 462 .. topic:: VHOST_256
 463
 464     All test cases which uses VHOST with qemu queue size set to 256.
 465
 466 .. topic:: VHOST_1024
 467
 468     All test cases which uses VHOST with qemu queue size set to 1024.
 469
 470 .. topic:: CFS_OPT
 471
 472     All test cases which uses VM with optimised scheduler policy.
 473
 474 .. topic:: TUNTAP
 475
 476     All test cases which uses TUN and TAP.
 477
 478 .. topic:: AFPKT
 479
 480     All test cases which uses AFPKT.
 481
 482 .. topic:: NETMAP
 483
 484     All test cases which uses Netmap.
 485
 486 .. topic:: MEMIF
 487
 488     All test cases which uses Memif.
 489
 490 .. topic:: SINGLE_MEMIF
 491
 492     All test cases which uses only single Memif connection per DUT. One DUT
 493     instance is running in container having one physical interface exposed to
 494     container.
 495
 496 .. topic:: LBOND
 497
 498     All test cases which uses link bonding (BondEthernet interface).
 499
 500 .. topic:: LBOND_DPDK
 501
 502     All test cases which uses DPDK link bonding.
 503
 504 .. topic:: LBOND_VPP
 505
 506     All test cases which uses VPP link bonding.
 507
 508 .. topic:: LBOND_MODE_XOR
 509
 510     All test cases which uses link bonding with mode XOR.
 511
 512 .. topic:: LBOND_MODE_LACP
 513
 514     All test cases which uses link bonding with mode LACP.
 515
 516 .. topic:: LBOND_LB_L34
 517
 518     All test cases which uses link bonding with load-balance mode l34.
 519
 520 .. topic:: LBOND_1L
 521
 522     All test cases which uses one link for link bonding.
 523
 524 .. topic:: LBOND_2L
 525
 526     All test cases which uses two links for link bonding.
 527
 528 .. topic:: DRV_AVF
 529
 530     All test cases which uses Intel Adaptive Virtual Function (AVF) device
 531     plugin for VPP. This plugins provides native device support for Intel AVF.
 532     AVF is driver specification for current and future Intel Virtual Function
 533     devices. In essence, today this driver can be used only with Intel
 534     XL710 / X710 / XXV710 adapters.
 535
 536 Feature Tags
 537 ------------
 538
 539 .. topic:: IACLDST
 540
 541     iACL destination.
 542
 543 .. topic:: COPWHLIST
 544
 545     COP whitelist.
 546
 547 .. topic:: NAT44
 548
 549     NAT44 configured and tested.
 550
 551 .. topic:: NAT64
 552
 553     NAT44 configured and tested.
 554
 555 .. topic:: ACL
 556
 557     ACL plugin configured and tested.
 558
 559 .. topic:: IACL
 560
 561     ACL plugin configured and tested on input path.
 562
 563 .. topic:: OACL
 564
 565     ACL plugin configured and tested on output path.
 566
 567 .. topic:: ACL_STATELESS
 568
 569     ACL plugin configured and tested in stateless mode (permit action).
 570
 571 .. topic:: ACL_STATEFUL
 572
 573     ACL plugin configured and tested in stateful mode (permit+reflect action).
 574
 575 .. topic:: ACL1
 576
 577     ACL plugin configured and tested with 1 not-hitting ACE.
 578
 579 .. topic:: ACL10
 580
 581     ACL plugin configured and tested with 10 not-hitting ACEs.
 582
 583 .. topic:: ACL50
 584
 585     ACL plugin configured and tested with 50 not-hitting ACEs.
 586
 587 .. topic:: SRv6_PROXY
 588
 589     SRv6 endpoint to SR-unaware appliance via proxy.
 590
 591 .. topic:: SRv6_PROXY_STAT
 592
 593     SRv6 endpoint to SR-unaware appliance via static proxy.
 594
 595 .. topic:: SRv6_PROXY_DYN
 596
 597     SRv6 endpoint to SR-unaware appliance via dynamic proxy.
 598
 599 .. topic:: SRv6_PROXY_MASQ
 600
 601     SRv6 endpoint to SR-unaware appliance via masquerading proxy.
 602
 603 Encryption Tags
 604 ---------------
 605
 606 .. topic:: IPSECSW
 607
 608     Crypto in software.
 609
 610 .. topic:: IPSECHW
 611
 612     Crypto in hardware.
 613
 614 .. topic:: IPSECTRAN
 615
 616     IPSec in transport mode.
 617
 618 .. topic:: IPSECTUN
 619
 620     IPSec in tunnel mode.
 621
 622 Client-Workload Tags
 623 --------------------
 624
 625 .. topic:: VM
 626
 627     All test cases which use at least one virtual machine.
 628
 629 .. topic:: LXC
 630
 631     All test cases which use Linux container and LXC utils.
 632
 633 .. topic:: DRC
 634
 635     All test cases which use at least one Docker container.
 636
 637 .. topic:: DOCKER
 638
 639     All test cases which use Docker as container manager.
 640
 641 .. topic:: APP
 642
 643     All test cases with specific APP use.
 644
 645 Container Orchestration Tags
 646 ----------------------------
 647
 648 .. topic:: K8S
 649
 650     All test cases which use Kubernetes for orchestration.
 651
 652 .. topic:: SFC_CONTROLLER
 653
 654     All test cases which use ligato/sfc_controller for driving configuration
 655     of vpp inside container.
 656
 657 .. topic:: VPP_AGENT
 658
 659     All test cases which use Golang implementation of a control/management plane
 660     for VPP
 661
 662 .. topic:: 1VSWITCH
 663
 664     VPP running in Docker container acting as VSWITCH.
 665
 666 .. topic:: 1VNF
 667
 668     1 VPP running in Docker container acting as VNF work load.
 669
 670 .. topic:: 2VNF
 671
 672     2 VPP running in 2 Docker containers acting as VNF work load.
 673
 674 .. topic:: 4VNF
 675
 676     4 VPP running in 4 Docker containers acting as VNF work load.
 677
 678 Multi-Threading Tags
 679 --------------------
 680
 681 .. topic:: STHREAD
 682
 683    *Dynamic tag*.
 684    All test cases using single poll mode thread.
 685
 686 .. topic:: MTHREAD
 687
 688    *Dynamic tag*.
 689     All test cases using more then one poll mode driver thread.
 690
 691 .. topic:: 1NUMA
 692
 693     All test cases with packet processing on single socket.
 694
 695 .. topic:: 2NUMA
 696
 697     All test cases with packet processing on two sockets.
 698
 699 .. topic:: 1C
 700
 701     1 worker thread pinned to 1 dedicated physical core; or if HyperThreading is
 702     enabled, 2 worker threads each pinned to a separate logical core within 1
 703     dedicated physical core. Main thread pinned to core 1.
 704
 705 .. topic:: 2C
 706
 707     2 worker threads pinned to 2 dedicated physical cores; or if HyperThreading
 708     is enabled, 4 worker threads each pinned to a separate logical core within 2
 709     dedicated physical cores. Main thread pinned to core 1.
 710
 711 .. topic:: 4C
 712
 713     4 worker threads pinned to 4 dedicated physical cores; or if HyperThreading
 714     is enabled, 8 worker threads each pinned to a separate logical core within 4
 715     dedicated physical cores. Main thread pinned to core 1.
 716
 717 .. topic:: 1T1C
 718
 719    *Dynamic tag*.
 720     1 worker thread pinned to 1 dedicated physical core. 1 receive queue per
 721     interface. Main thread pinned to core 1.
 722
 723 .. topic:: 2T2C
 724
 725    *Dynamic tag*.
 726     2 worker threads pinned to 2 dedicated physical cores. 1 receive queue per
 727     interface. Main thread pinned to core 1.
 728
 729 .. topic:: 4T4C
 730
 731    *Dynamic tag*.
 732     4 worker threads pinned to 4 dedicated physical cores. 2 receive queues per
 733     interface. Main thread pinned to core 1.
 734
 735 .. topic:: 2T1C
 736
 737    *Dynamic tag*.
 738     2 worker threads each pinned to a separate logical core within 1 dedicated
 739     physical core. 1 receive queue per interface. Main thread pinned to core 1.
 740
 741 .. topic:: 4T2C
 742
 743    *Dynamic tag*.
 744     4 worker threads each pinned to a separate logical core within 2 dedicated
 745     physical cores. 2 receive queues per interface. Main thread pinned to core
 746     1.
 747
 748 .. topic:: 8T4C
 749
 750    *Dynamic tag*.
 751     8 worker threads each pinned to a separate logical core within 4 dedicated
 752     physical cores. 4 receive queues per interface. Main thread pinned to core
 753     1.
 754
 755 Honeycomb Tags
 756 --------------
 757
 758 .. topic:: HC_FUNC
 759
 760     Honeycomb functional test cases.
 761
 762 .. topic:: HC_NSH
 763
 764     Honeycomb NSH test cases.
 765
 766 .. topic:: HC_PERSIST
 767
 768     Honeycomb persistence test cases.
 769
 770 .. topic:: HC_REST_ONLY
 771
 772     (Exclusion tag) Honeycomb test cases that cannot be run in Netconf mode
 773     using ODL client for Restfconf -> Netconf translation.