Revert "Fix: CSIT 1701 report files and script AD1"
[csit.git] / docs / report / honeycomb_functional_tests_virl / overview.rst
1 Overview\r
2 ========\r
3 \r
4 Tested Topologies VIRL\r
5 ----------------------\r
6 \r
7 CSIT Honeycomb functional tests are executed on virtualized topologies created\r
8 using Virtual Internet Routing Lab (VIRL) simulation platform contributed by\r
9 Cisco. VIRL runs on physical baremetal servers hosted by LF FD.io project. All\r
10 tests are executed in two node logical test topology - Traffic Generator (TG)\r
11 node and Systems Under Test (SUT1) node connected in a loop. Logical test\r
12 topology is shown in the figure below.\r
13 \r
14 ::\r
15 \r
16                      +------------------------+\r
17                      |                        |\r
18                      |  +------------------+  |\r
19         +--------------->                  <--------------+\r
20         |            |  |                  |  |           |\r
21         |  |------------>       DUT1       <-----------+  |\r
22         |  |         |  +------------------+  |        |  |\r
23         |  |         |                        |        |  |\r
24         |  |         |                  SUT1  |        |  |\r
25         |  |         +------------------------+        |  |\r
26         |  |                                           |  |\r
27         |  |                                           |  |\r
28         |  |               +-----------+               |  |\r
29         |  +--------------->           <---------------+  |\r
30         |                  |    TG     |                  |\r
31         +------------------>           <------------------+\r
32                            +-----------+\r
33 \r
34 SUT1 is a VM (Ubuntu or Centos, depending on the test suite), TG is a Traffic\r
35 Generator (TG, another Ubuntu VM). SUTs run Honeycomb and VPP SW applications\r
36 in Linux user-mode as a Device Under Test (DUT) within the VM. TG runs Scapy\r
37 SW application as a packet Traffic Generator. Logical connectivity between\r
38 SUTs and to TG is provided using virtual NICs using VMs' virtio driver.\r
39 \r
40 Virtual testbeds are created on-demand whenever a verification job is started\r
41 (e.g. triggered by the gerrit patch submission) and destroyed upon completion\r
42 of all functional tests. Each node is a Virtual Machine and each connection\r
43 that is drawn on the diagram is available for use in any test case. During the\r
44 test execution, all nodes are reachable thru the Management network connected\r
45 to every node via dedicated virtual NICs and virtual links (not shown above\r
46 for clarity).\r
47 \r
48 Honeycomb Functional Tests Overview\r
49 -----------------------------------\r
50 \r
51 The following Honeycomb functional test areas are included in the CSIT |release|\r
52 with results listed in this report:\r
53 \r
54 - **Basic interface management** - CRUD for interface state,\r
55   - ipv4/ipv6 address, ipv4 neighbor, MTU value.\r
56   - Test case count: 7\r
57 - **L2BD** - CRUD for L2 Bridge-Domain, interface assignment.\r
58   - Create up to two bridge domains with all implemented functions turned on.\r
59   - (flooding, unknown-unicast flooding, forwarding, learning, arp-termination)\r
60   - Assign up to two physical interfaces to a single bridge domain.\r
61   - Remove interface assignments, remove bridge domains.\r
62   - Test case count: 5\r
63 - **L2FIB** - CRD for L2-FIB entries.\r
64   - Create 4 FIB entries\r
65   - (one of each for filter/forward, static/dynamic combinations).\r
66   - Remove FIB entries.\r
67   - Test case count: 7\r
68 - **VxLAN** - CRD for VxLAN tunnels.\r
69   - Create VxLAN interface.\r
70   - Disable VxLAN interface.\r
71   - Re-create a disabled VxLAN interface.\r
72   - Test case count: 6\r
73 - **VxLAN-GPE** - CRD for VxLAN GPE tunnels.\r
74   - Create VxLAN GPE interface.\r
75   - Disable VxLAN interface.\r
76   - Re-create a disabled VxLAN interface.\r
77   - Test case count: 7\r
78 - **Vhost-user** - CRUD for Vhost-user interfaces.\r
79   - Create, modify and delete Vhost-user interface, as client and server.\r
80   - Test case count: 8\r
81 - **TAP** - CRUD for Tap interface management.\r
82   - Create, modify and delete TAP interface.\r
83   - Test case count: 3\r
84 - **VLAN** - CRUD for VLAN sub-interface management.\r
85   - Create VLAN sub-interface over a physical interface.\r
86   - Toggle interface state separately for super-interface and sub-interface.\r
87   - Configure IP address and bridge domain assignment on sub-interface.\r
88   - Configure VLAN tag rewrite on sub-interface.\r
89   - Test case count: 17\r
90 - **ACL** - CRD for low-level classifiers: table and session management,\r
91   - interface assignment.\r
92   - Configure up to 2 classify tables.\r
93   - Configure up to 2 classify sessions on one table.\r
94   - Assign classify session to a physical interface.\r
95   - Remove tables, sessions, interface assignments.\r
96   - Test case count: 9\r
97 - **PBB** - CRD for provider backbone bridge sub-interface.\r
98   - Configure, modify and remove a PBB sub-interface over a physical interface.\r
99   - Test case count: 9\r
100 - **NSH_SFC** - CRD for NSH maps and entries, using NSH_SFC plugin.\r
101   - Configure up to 2 NSH entries.\r
102   - Configure up to 2 NSH maps.\r
103   - Modify and delete NSH maps and entries.\r
104   - Test case count: 8\r
105 - **LISP** - CRD for Lisp: mapping, locator set, adjacency, map resolver.\r
106   - Toggle Lisp feature status.\r
107   - Configure and delete Lisp mapping as local and remote.\r
108   - Configure and delete Lisp adjacency mapping\r
109   - Configure and delete Lisp map resolver, proxy ITR.\r
110   - Test case count: 11\r
111 - **NAT** - CRD for NAT entries, interface assignment.\r
112   - Configure and delete up to two NAT entries.\r
113   - Assign NAT entries to a physical interface.\r
114   - Test case count: 6\r
115 - **Port mirroring** - CRD for SPAN port mirroring, interface assignment.\r
116   - Configure SPAN port mirroring on a physical interface, mirroring\r
117   - up to 2 interfaces.\r
118   - Remove SPAN configuration from interfaces.\r
119   - Test case count: 3\r
120 - **Honeycomb Infractructure** - configuration persistence,\r
121   - Netconf notifications for interface events,\r
122   - Netconf negative tests aimed at specific issues\r
123 \r
124 Total 111 Honeycomb tests in the CSIT |release|.\r
125 \r
126 Operational data in Honeycomb should mirror configuration data at all times.\r
127 Because of this, test cases follow this general pattern:\r
128 \r
129 #. read operational data of the feature using restconf.\r
130 #. read status of the feature using VPP API dump.\r
131 #. modify configuration of the feature using restconf.\r
132 #. verify changes to operational data using restconf.\r
133 #. verify changes using VPP API dump.\r
134 \r
135 Test cases involving network interfaces utilize the first two interfaces on\r
136 the DUT node.\r
137 \r