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

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.