CSIT 1701 report files and script
[csit.git] / docs / report / honeycomb_functional_tests_virl / csit_release_notes.rst
1 CSIT Release Notes\r
2 ==================\r
3 \r
4 Changes in CSIT |release|\r
5 -------------------------\r
6 \r
7 #. Naming change for all Honeycomb functional test suites in VIRL\r
8 \r
9     - Honeycomb functional test case names stayed unchanged\r
10 \r
11 #. Added Honeycomb functional tests\r
12 \r
13     - NSH_SFC\r
14     - LISP\r
15     - NAT\r
16     - SPAN\r
17 \r
18 Functional Tests Naming\r
19 -----------------------\r
20 \r
21 CSIT |release| introduced a common structured naming convention for all\r
22 performance and functional tests. This change was driven by substantially\r
23 growing number and type of CSIT test cases. Firstly, the original practice did\r
24 not always follow any strict naming convention. Secondly test names did not\r
25 always clearly capture tested packet encapsulations, and the actual type or\r
26 content of the tests. Thirdly HW configurations in terms of NICs, ports and\r
27 their locality were not captured either. These were but few reasons that drove\r
28 the decision to change and define a new more complete and stricter test naming\r
29 convention, and to apply this to all existing and new test cases.\r
30 \r
31 The new naming should be intuitive for majority of the tests. The complete\r
32 description of CSIT test naming convention is provided on `CSIT test naming\r
33 page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.\r
34 \r
35 Here few illustrative examples of the new naming usage for functional test\r
36 suites:\r
37 \r
38 #. **Physical port to physical port - a.k.a. NIC-to-NIC, Phy-to-Phy, P2P**\r
39 \r
40     - *eth2p-ethip4-ip4base-func.robot* => 2 ports of Ethernet, IPv4 baseline\r
41       routed forwarding, functional tests.\r
42 \r
43 #. **Physical port to VM (or VM chain) to physical port - a.k.a. NIC2VM2NIC,\r
44    P2V2P, NIC2VMchain2NIC, P2V2V2P**\r
45 \r
46     - *eth2p-ethip4vxlan-l2bdbasemaclrn-eth-2vhost-1vm-func.robot* => 2 ports of\r
47       Ethernet, IPv4 VXLAN Ethernet, L2 bridge-domain switching to/from two vhost\r
48       interfaces and one VM, functional tests.\r
49 \r
50 \r
51 Known Issues\r
52 ------------\r
53 \r
54 Here is the list of known issues in CSIT |release| for Honeycomb functional\r
55 tests in VIRL:\r
56 \r
57 +-------------------------------------------------+-----------------------------------------------------------------+\r
58 | Issue                                           | Description                                                     |\r
59 +-------------------------------------------------+-----------------------------------------------------------------+\r
60 | Operational data for Vhost-user interfaces      | Honeycomb Operational data reports Vhost-user interfaces        |\r
61 | "server" flag                                   | as client, even if they are server.                             |\r
62 +-------------------------------------------------+-----------------------------------------------------------------+\r
63 | Persistence of VxLAN tunnels                    | Configuration persistence often fails to restore                |\r
64 |                                                 | Honeycomb's internal naming context for VxLAN interfaces.       |\r
65 |                                                 | The interface is renamed to "vxlan_tunnel0" but is otherwise    |\r
66 |                                                 | configured correctly.                                           |\r
67 +-------------------------------------------------+-----------------------------------------------------------------+\r
68 \r