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