CSIT 1701 report files and script

[csit.git] / docs / report / honeycomb_functional_tests_virl / csit_release_notes.rst

diff --git a/docs/report/honeycomb_functional_tests_virl/csit_release_notes.rst b/docs/report/honeycomb_functional_tests_virl/csit_release_notes.rst
new file mode 100644 (file)
index 0000000..2708b05
--- /dev/null
+++ b/docs/report/honeycomb_functional_tests_virl/csit_release_notes.rst
@@ -0,0 +1,68 @@
+CSIT Release Notes\r
+==================\r
+\r
+Changes in CSIT |release|\r
+-------------------------\r
+\r
+#. Naming change for all Honeycomb functional test suites in VIRL\r
+\r
+    - Honeycomb functional test case names stayed unchanged\r
+\r
+#. Added Honeycomb functional tests\r
+\r
+    - NSH_SFC\r
+    - LISP\r
+    - NAT\r
+    - SPAN\r
+\r
+Functional Tests Naming\r
+-----------------------\r
+\r
+CSIT |release| introduced a common structured naming convention for all\r
+performance and functional tests. This change was driven by substantially\r
+growing number and type of CSIT test cases. Firstly, the original practice did\r
+not always follow any strict naming convention. Secondly test names did not\r
+always clearly capture tested packet encapsulations, and the actual type or\r
+content of the tests. Thirdly HW configurations in terms of NICs, ports and\r
+their locality were not captured either. These were but few reasons that drove\r
+the decision to change and define a new more complete and stricter test naming\r
+convention, and to apply this to all existing and new test cases.\r
+\r
+The new naming should be intuitive for majority of the tests. The complete\r
+description of CSIT test naming convention is provided on `CSIT test naming\r
+page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.\r
+\r
+Here few illustrative examples of the new naming usage for functional test\r
+suites:\r
+\r
+#. **Physical port to physical port - a.k.a. NIC-to-NIC, Phy-to-Phy, P2P**\r
+\r
+    - *eth2p-ethip4-ip4base-func.robot* => 2 ports of Ethernet, IPv4 baseline\r
+      routed forwarding, functional tests.\r
+\r
+#. **Physical port to VM (or VM chain) to physical port - a.k.a. NIC2VM2NIC,\r
+   P2V2P, NIC2VMchain2NIC, P2V2V2P**\r
+\r
+    - *eth2p-ethip4vxlan-l2bdbasemaclrn-eth-2vhost-1vm-func.robot* => 2 ports of\r
+      Ethernet, IPv4 VXLAN Ethernet, L2 bridge-domain switching to/from two vhost\r
+      interfaces and one VM, functional tests.\r
+\r
+\r
+Known Issues\r
+------------\r
+\r
+Here is the list of known issues in CSIT |release| for Honeycomb functional\r
+tests in VIRL:\r
+\r
++-------------------------------------------------+-----------------------------------------------------------------+\r
+| Issue                                           | Description                                                     |\r
++-------------------------------------------------+-----------------------------------------------------------------+\r
+| Operational data for Vhost-user interfaces      | Honeycomb Operational data reports Vhost-user interfaces        |\r
+| "server" flag                                   | as client, even if they are server.                             |\r
++-------------------------------------------------+-----------------------------------------------------------------+\r
+| Persistence of VxLAN tunnels                    | Configuration persistence often fails to restore                |\r
+|                                                 | Honeycomb's internal naming context for VxLAN interfaces.       |\r
+|                                                 | The interface is renamed to "vxlan_tunnel0" but is otherwise    |\r
+|                                                 | configured correctly.                                           |\r
++-------------------------------------------------+-----------------------------------------------------------------+\r
+\r