csit rls1701 report edits:

[csit.git] / docs / report / vpp_unit_tests / overview.rst

diff --git a/docs/report/vpp_unit_tests/overview.rst b/docs/report/vpp_unit_tests/overview.rst
new file mode 100644 (file)
index 0000000..7c8210b
--- /dev/null
+++ b/docs/report/vpp_unit_tests/overview.rst
@@ -0,0 +1,61 @@
+Overview\r
+========\r
+\r
+.. note::\r
+\r
+    This section includes an abbreviated version of the VPP Test Framework\r
+    overview maintained within the VPP project. Complete overview can be found\r
+    in `VPP unit test documentation <link>`_\r
+\r
+VPP Unit Test Framework\r
+-----------------------\r
+\r
+VPP Test Framework is used to ease writing, running and debugging unit tests\r
+for the VPP. It is based on python as a high level language to  allow rapid\r
+test development. scapy\_ is used as a tool for creating and dissecting\r
+packets.\r
+\r
+VPP Test Framework does not send any packets to VPP directly. Traffic is\r
+instead injected using VPP packet-generator interfaces. Packets are written\r
+into a temporary .pcap file, which is then read by the VPP code with packets\r
+getting injected into the VPP processing nodes.\r
+\r
+Similarly, VPP does not send any packets to VPP Test Framework directly.\r
+Instead, VPP packet capture feature is used to capture and write packets to a\r
+temporary .pcap file, which is then read and analyzed by the VPP Test\r
+Framework.\r
+\r
+For complete description of the VPP Test Framework including anatomy of a test\r
+case and detailed documentation of existing VPP unit test cases please refer\r
+to the `VPP unit test documentation <link>`_\r
+\r
+Unit Tests Coverage\r
+-------------------\r
+\r
+Following VPP functional test areas are covered in VPP unit test code included\r
+in VPP rls1701 with results listed in this report:\r
+\r
+- CRUD Loopback - create, read, update, delete Loopback interfaces.\r
+- Flow-per-packet plugin - collect and report L2 and IP4 flow statistics.\r
+- DHCP - DHCPv4 and DHCPv6 Proxy.\r
+- IP4 VRF Multi-instance - create, read, update, delete and verify IPv4 VRFs.\r
+- Load Balancer - IP4 GRE4, IP4 GRE6, IP6 GRE4, IP6 GRE6\r
+- Bidirectional Forwarding Detection (BFD) IPv4 - baseline BFD session operation.\r
+- Bidirectional Forwarding Detection (BFD) IPv6 - baseline BFD session operation.\r
+- Bidirectional Forwarding Detection (BFD) - API tests.\r
+- Bidirectional Forwarding Detection (BFD) - changing authorization.\r
+- Bidirectional Forwarding Detection (BFD) - SHA1 authentication.\r
+- IPv6 Tests - baseline FIB operations, NS/RS exception handling.\r
+- SPAN Test - Switched Port Analyzer packet mirroring.\r
+- GRE Tests - GRE tunnel tests.\r
+- SNAT Test Cases - SNAT44 tests.\r
+- L2XC Multi-instance - L2 cross-connect multi-instance tests.\r
+- IPv4 Tests - baseline FIB tests.\r
+- IPv4 FIB CRUD - add/update/delete IPv4 routes.\r
+- IRB Tests - Integrated Routing and Bridging tests.\r
+- MPLS Tests - MPLS baseline tests.\r
+- L2XC Tests - L2 cross-connect baseline tests incl. single- and dual-loop.\r
+- Classifier - classification with IP ACL, MAC ACL, IP PBR.\r
+- VXLAN Tests - baseline VXLAN tunneling.\r
+- L2 FIB CRUD - add/update/delete L2 MAC entries.\r
+- L2BD Tests - L2 Bridge-Domain baseline tests incl. single- and dual-loop.\r