CSIT-744 Update report content for proper parsing
[csit.git] / docs / report / honeycomb_functional_tests / overview.rst
index 9cf741e..a0491b1 100644 (file)
@@ -5,13 +5,11 @@ Tested Virtual Topologies
 -------------------------
 
 CSIT Honeycomb functional tests are executed on virtualized topologies created
 -------------------------
 
 CSIT Honeycomb functional tests are executed on virtualized topologies created
-using Virtual Internet Routing Lab (VIRL) simulation platform contributed by
-Cisco. VIRL runs on physical baremetal servers hosted by LF FD.io project. All
-tests are executed in two node logical test topology - Traffic Generator (TG)
-node and Systems Under Test (SUT1) node connected in a loop. Logical test
-topology is shown in the figure below.
-
-::
+using :abbr:`VIRL (Virtual Internet Routing Lab)` simulation platform
+contributed by Cisco. VIRL runs on physical baremetal servers hosted by LF FD.io
+project. All tests are executed in two node logical test topology - Traffic
+Generator (TG) node and Systems Under Test (SUT1) node connected in a loop.
+Logical test topology is shown in the figure below.::
 
                      +------------------------+
                      |                        |
 
                      +------------------------+
                      |                        |
@@ -53,7 +51,7 @@ with results listed in this report:
 
 - **Basic interface management** - CRUD for interface state,
   - ipv4/ipv6 address, ipv4 neighbor, MTU value.
 
 - **Basic interface management** - CRUD for interface state,
   - ipv4/ipv6 address, ipv4 neighbor, MTU value.
-  - Test case count: 7
+  - Test case count: 14
 - **L2BD** - CRUD for L2 Bridge-Domain, interface assignment.
   - Create up to two bridge domains with all implemented functions turned on.
   - (flooding, unknown-unicast flooding, forwarding, learning, arp-termination)
 - **L2BD** - CRUD for L2 Bridge-Domain, interface assignment.
   - Create up to two bridge domains with all implemented functions turned on.
   - (flooding, unknown-unicast flooding, forwarding, learning, arp-termination)
@@ -86,7 +84,7 @@ with results listed in this report:
   - Toggle interface state separately for super-interface and sub-interface.
   - Configure IP address and bridge domain assignment on sub-interface.
   - Configure VLAN tag rewrite on sub-interface.
   - Toggle interface state separately for super-interface and sub-interface.
   - Configure IP address and bridge domain assignment on sub-interface.
   - Configure VLAN tag rewrite on sub-interface.
-  - Test case count: 17
+  - Test case count: 24
 - **ACL** - CRD for low-level classifiers: table and session management,
   - interface assignment.
   - Configure up to 2 classify tables.
 - **ACL** - CRD for low-level classifiers: table and session management,
   - interface assignment.
   - Configure up to 2 classify tables.
@@ -96,7 +94,7 @@ with results listed in this report:
   - Test case count: 9
 - **PBB** - CRD for provider backbone bridge sub-interface.
   - Configure, modify and remove a PBB sub-interface over a physical interface.
   - Test case count: 9
 - **PBB** - CRD for provider backbone bridge sub-interface.
   - Configure, modify and remove a PBB sub-interface over a physical interface.
-  - Test case count: 9
+  - Test case count: 8
 - **NSH_SFC** - CRD for NSH maps and entries, using NSH_SFC plugin.
   - Configure up to 2 NSH entries.
   - Configure up to 2 NSH maps.
 - **NSH_SFC** - CRD for NSH maps and entries, using NSH_SFC plugin.
   - Configure up to 2 NSH entries.
   - Configure up to 2 NSH maps.
@@ -107,7 +105,7 @@ with results listed in this report:
   - Configure and delete Lisp mapping as local and remote.
   - Configure and delete Lisp adjacency mapping
   - Configure and delete Lisp map resolver, proxy ITR.
   - Configure and delete Lisp mapping as local and remote.
   - Configure and delete Lisp adjacency mapping
   - Configure and delete Lisp map resolver, proxy ITR.
-  - Test case count: 11
+  - Test case count: 16
 - **NAT** - CRD for NAT entries, interface assignment.
   - Configure and delete up to two NAT entries.
   - Assign NAT entries to a physical interface.
 - **NAT** - CRD for NAT entries, interface assignment.
   - Configure and delete up to two NAT entries.
   - Assign NAT entries to a physical interface.
@@ -116,7 +114,7 @@ with results listed in this report:
   - Configure SPAN port mirroring on a physical interface, mirroring
   - up to 2 interfaces.
   - Remove SPAN configuration from interfaces.
   - Configure SPAN port mirroring on a physical interface, mirroring
   - up to 2 interfaces.
   - Remove SPAN configuration from interfaces.
-  - Test case count: 3
+  - Test case count: 14
 - **ACL-PLUGIN** - CRD for high-level classifier
   - MAC + IP address classification.
   - IPv4, IPv6 address classification.
 - **ACL-PLUGIN** - CRD for high-level classifier
   - MAC + IP address classification.
   - IPv4, IPv6 address classification.
@@ -144,11 +142,15 @@ with results listed in this report:
   - Configure blackhole route.
   - IPv4 and IPv6 variants.
   - Test case count: 6
   - Configure blackhole route.
   - IPv4 and IPv6 variants.
   - Test case count: 6
+- **Policer** - CRD for traffic policing feature.
+  - Configure Policing rules.
+  - Assign to interface.
+  - Test case count: 6
 - **Honeycomb Infractructure** - configuration persistence,
   - Netconf notifications for interface events,
   - Netconf negative tests aimed at specific issues
 
 - **Honeycomb Infractructure** - configuration persistence,
   - Netconf notifications for interface events,
   - Netconf negative tests aimed at specific issues
 
-Total 158 Honeycomb tests in the CSIT |release|.
+Total 173 Honeycomb functional tests in the CSIT |release|.
 
 Operational data in Honeycomb should mirror configuration data at all times.
 Because of this, test cases follow this general pattern:
 
 Operational data in Honeycomb should mirror configuration data at all times.
 Because of this, test cases follow this general pattern:
@@ -158,7 +160,7 @@ Because of this, test cases follow this general pattern:
 #. modify configuration of the feature using restconf.
 #. verify changes to operational data using restconf.
 #. verify changes using VPP API dump, OR
 #. modify configuration of the feature using restconf.
 #. verify changes to operational data using restconf.
 #. verify changes using VPP API dump, OR
-#. send a packet to VPP node and observe behaviour to verify configuration
+#. send a packet to VPP node and observe behaviour to verify configuration.
 
 Test cases involving network interfaces utilize the first two interfaces on
 the DUT node.
 
 Test cases involving network interfaces utilize the first two interfaces on
 the DUT node.
@@ -185,12 +187,12 @@ suites:
 
 #. **Physical port to physical port - a.k.a. NIC-to-NIC, Phy-to-Phy, P2P**
 
 
 #. **Physical port to physical port - a.k.a. NIC-to-NIC, Phy-to-Phy, P2P**
 
-    - *eth2p-ethip4-ip4base-func.robot* => 2 ports of Ethernet, IPv4 baseline
-      routed forwarding, functional tests.
+   - *eth2p-ethip4-ip4base-func.robot* => 2 ports of Ethernet, IPv4 baseline
+     routed forwarding, functional tests.
 
 #. **Physical port to VM (or VM chain) to physical port - a.k.a. NIC2VM2NIC,
    P2V2P, NIC2VMchain2NIC, P2V2V2P**
 
 
 #. **Physical port to VM (or VM chain) to physical port - a.k.a. NIC2VM2NIC,
    P2V2P, NIC2VMchain2NIC, P2V2V2P**
 
-    - *eth2p-ethip4vxlan-l2bdbasemaclrn-eth-2vhost-1vm-func.robot* => 2 ports of
-      Ethernet, IPv4 VXLAN Ethernet, L2 bridge-domain switching to/from two vhost
-      interfaces and one VM, functional tests.
+   - *eth2p-ethip4vxlan-l2bdbasemaclrn-eth-2vhost-1vm-func.robot* => 2 ports of
+     Ethernet, IPv4 VXLAN Ethernet, L2 bridge-domain switching to/from two vhost
+     interfaces and one VM, functional tests.