docs/report/honeycomb_functional_tests/overview.rst

   1 Overview
   2 ========
   3
   4 Tested Virtual Topologies
   5 -------------------------
   6
   7 CSIT Honeycomb functional tests are executed on virtualized topologies created
   8 using Virtual Internet Routing Lab (VIRL) simulation platform contributed by
   9 Cisco. VIRL runs on physical baremetal servers hosted by LF FD.io project. All
  10 tests are executed in two node logical test topology - Traffic Generator (TG)
  11 node and Systems Under Test (SUT1) node connected in a loop. Logical test
  12 topology is shown in the figure below.
  13
  14 ::
  15
  16                      +------------------------+
  17                      |                        |
  18                      |  +------------------+  |
  19         +--------------->                  <--------------+
  20         |            |  |                  |  |           |
  21         |  |------------>       DUT1       <-----------+  |
  22         |  |         |  +------------------+  |        |  |
  23         |  |         |                        |        |  |
  24         |  |         |                  SUT1  |        |  |
  25         |  |         +------------------------+        |  |
  26         |  |                                           |  |
  27         |  |                                           |  |
  28         |  |               +-----------+               |  |
  29         |  +--------------->           <---------------+  |
  30         |                  |    TG     |                  |
  31         +------------------>           <------------------+
  32                            +-----------+
  33
  34 SUT1 is a VM (Ubuntu or Centos, depending on the test suite), TG is a Traffic
  35 Generator (TG, another Ubuntu VM). SUTs run Honeycomb and VPP SW applications
  36 in Linux user-mode as a Device Under Test (DUT) within the VM. TG runs Scapy
  37 SW application as a packet Traffic Generator. Logical connectivity between
  38 SUTs and to TG is provided using virtual NICs using VMs' virtio driver.
  39
  40 Virtual testbeds are created on-demand whenever a verification job is started
  41 (e.g. triggered by the gerrit patch submission) and destroyed upon completion
  42 of all functional tests. Each node is a Virtual Machine and each connection
  43 that is drawn on the diagram is available for use in any test case. During the
  44 test execution, all nodes are reachable thru the Management network connected
  45 to every node via dedicated virtual NICs and virtual links (not shown above
  46 for clarity).
  47
  48 Functional Tests Coverage
  49 -------------------------
  50
  51 The following Honeycomb functional test areas are included in the CSIT |release|
  52 with results listed in this report:
  53
  54 - **Basic interface management** - CRUD for interface state,
  55   - ipv4/ipv6 address, ipv4 neighbor, MTU value.
  56   - Test case count: 7
  57 - **L2BD** - CRUD for L2 Bridge-Domain, interface assignment.
  58   - Create up to two bridge domains with all implemented functions turned on.
  59   - (flooding, unknown-unicast flooding, forwarding, learning, arp-termination)
  60   - Assign up to two physical interfaces to a single bridge domain.
  61   - Remove interface assignments, remove bridge domains.
  62   - Test case count: 5
  63 - **L2FIB** - CRD for L2-FIB entries.
  64   - Create 4 FIB entries
  65   - (one of each for filter/forward, static/dynamic combinations).
  66   - Remove FIB entries.
  67   - Test case count: 7
  68 - **VxLAN** - CRD for VxLAN tunnels.
  69   - Create VxLAN interface.
  70   - Disable VxLAN interface.
  71   - Re-create a disabled VxLAN interface.
  72   - Test case count: 6
  73 - **VxLAN-GPE** - CRD for VxLAN GPE tunnels.
  74   - Create VxLAN GPE interface.
  75   - Disable VxLAN interface.
  76   - Re-create a disabled VxLAN interface.
  77   - Test case count: 7
  78 - **Vhost-user** - CRUD for Vhost-user interfaces.
  79   - Create, modify and delete Vhost-user interface, as client and server.
  80   - Test case count: 8
  81 - **TAP** - CRUD for Tap interface management.
  82   - Create, modify and delete TAP interface.
  83   - Test case count: 3
  84 - **VLAN** - CRUD for VLAN sub-interface management.
  85   - Create VLAN sub-interface over a physical interface.
  86   - Toggle interface state separately for super-interface and sub-interface.
  87   - Configure IP address and bridge domain assignment on sub-interface.
  88   - Configure VLAN tag rewrite on sub-interface.
  89   - Test case count: 17
  90 - **ACL** - CRD for low-level classifiers: table and session management,
  91   - interface assignment.
  92   - Configure up to 2 classify tables.
  93   - Configure up to 2 classify sessions on one table.
  94   - Assign classify session to a physical interface.
  95   - Remove tables, sessions, interface assignments.
  96   - Test case count: 9
  97 - **PBB** - CRD for provider backbone bridge sub-interface.
  98   - Configure, modify and remove a PBB sub-interface over a physical interface.
  99   - Test case count: 9
 100 - **NSH_SFC** - CRD for NSH maps and entries, using NSH_SFC plugin.
 101   - Configure up to 2 NSH entries.
 102   - Configure up to 2 NSH maps.
 103   - Modify and delete NSH maps and entries.
 104   - Test case count: 8
 105 - **LISP** - CRD for Lisp: mapping, locator set, adjacency, map resolver.
 106   - Toggle Lisp feature status.
 107   - Configure and delete Lisp mapping as local and remote.
 108   - Configure and delete Lisp adjacency mapping
 109   - Configure and delete Lisp map resolver, proxy ITR.
 110   - Test case count: 11
 111 - **NAT** - CRD for NAT entries, interface assignment.
 112   - Configure and delete up to two NAT entries.
 113   - Assign NAT entries to a physical interface.
 114   - Test case count: 6
 115 - **Port mirroring** - CRD for SPAN port mirroring, interface assignment.
 116   - Configure SPAN port mirroring on a physical interface, mirroring
 117   - up to 2 interfaces.
 118   - Remove SPAN configuration from interfaces.
 119   - Test case count: 3
 120 - **ACL-PLUGIN** - CRD for high-level classifier
 121   - MAC + IP address classification.
 122   - IPv4, IPv6 address classification.
 123   - TCP, UDP, ICMP, ICMPv6 protocol/next-header classification.
 124   - port number classification.
 125   - ICMP, ICMPv6 code and type classification.
 126   - Test case count: 15
 127 - **ProxyARP** - CRD for proxyARP feature.
 128   - Configure proxyARP.
 129   - Assign to interface.
 130   - Test case count: 3
 131 - **ProxyND6** - CRD for Neighbor Discovery Proxy.
 132   - Configure ProxyND6 feature on interface.
 133   - Test case count: 4
 134 - **DHCP Relay** - CRD for DHCP relay feature.
 135   - Configure DHCP Relays.
 136   - IPv4 and IPv6 variants.
 137   - Test case count: 4
 138 - **SLAAC** - CRD for Stateless Address AutoConfiguration.
 139   - Configure SLAAC feature on interfaces.
 140   - Test case count: 7
 141 - **Routing** - CRD for routing.
 142   - Configure single-hop route.
 143   - Configure multi-hop routes.
 144   - Configure blackhole route.
 145   - IPv4 and IPv6 variants.
 146   - Test case count: 6
 147 - **Honeycomb Infractructure** - configuration persistence,
 148   - Netconf notifications for interface events,
 149   - Netconf negative tests aimed at specific issues
 150
 151 Total 158 Honeycomb tests in the CSIT |release|.
 152
 153 Operational data in Honeycomb should mirror configuration data at all times.
 154 Because of this, test cases follow this general pattern:
 155
 156 #. read operational data of the feature using restconf.
 157 #. read status of the feature using VPP API dump.
 158 #. modify configuration of the feature using restconf.
 159 #. verify changes to operational data using restconf.
 160 #. verify changes using VPP API dump, OR
 161 #. send a packet to VPP node and observe behaviour to verify configuration
 162
 163 Test cases involving network interfaces utilize the first two interfaces on
 164 the DUT node.
 165
 166 Functional Tests Naming
 167 -----------------------
 168
 169 CSIT |release| introduced a common structured naming convention for all
 170 performance and functional tests. This change was driven by substantially
 171 growing number and type of CSIT test cases. Firstly, the original practice did
 172 not always follow any strict naming convention. Secondly test names did not
 173 always clearly capture tested packet encapsulations, and the actual type or
 174 content of the tests. Thirdly HW configurations in terms of NICs, ports and
 175 their locality were not captured either. These were but few reasons that drove
 176 the decision to change and define a new more complete and stricter test naming
 177 convention, and to apply this to all existing and new test cases.
 178
 179 The new naming should be intuitive for majority of the tests. The complete
 180 description of CSIT test naming convention is provided on `CSIT test naming
 181 page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.
 182
 183 Here few illustrative examples of the new naming usage for functional test
 184 suites:
 185
 186 #. **Physical port to physical port - a.k.a. NIC-to-NIC, Phy-to-Phy, P2P**
 187
 188    - *eth2p-ethip4-ip4base-func.robot* => 2 ports of Ethernet, IPv4 baseline
 189      routed forwarding, functional tests.
 190
 191 #. **Physical port to VM (or VM chain) to physical port - a.k.a. NIC2VM2NIC,
 192    P2V2P, NIC2VMchain2NIC, P2V2V2P**
 193
 194    - *eth2p-ethip4vxlan-l2bdbasemaclrn-eth-2vhost-1vm-func.robot* => 2 ports of
 195      Ethernet, IPv4 VXLAN Ethernet, L2 bridge-domain switching to/from two vhost
 196      interfaces and one VM, functional tests.