--- /dev/null
+CSIT Test Naming\r
+================\r
+\r
+Background\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 it to all existing and new test suites and test\r
+cases.\r
+\r
+The new naming should be intuitive for majority of the tests. Complete\r
+description of the newly adopted CSIT test naming convention is provided on\r
+`CSIT test naming page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_. Here\r
+few illustrative examples of the new naming usage for test suites across CSIT\r
+performance, functional and HoneyComb management test areas.\r
+\r
+Naming Convention\r
+-----------------\r
+\r
+The CSIT approach is to use tree naming convention and to encode following\r
+testing information into test suite and test case names:\r
+\r
+1. packet network port configuration\r
+\r
+ * port type, physical or virtual;\r
+ * number of ports;\r
+ * NIC model, if applicable;\r
+ * port-NIC locality, if applicable;\r
+\r
+2. packet encapsulations;\r
+\r
+3. VPP packet processing\r
+\r
+ * packet forwarding mode;\r
+ * packet processing function(s);\r
+\r
+4. packet forwarding path\r
+\r
+ * if present, network functions (processes, containers, VMs) and their\r
+ topology within the computer;\r
+\r
+5. main measured variable, type of test.\r
+\r
+Proposed convention is to encode ports and NICs on the left (underlay),\r
+followed by outer-most frame header, then other stacked headers up to the\r
+header processed by vSwitch-VPP, then VPP forwarding function, then encap on\r
+vhost interface, number of vhost interfaces, number of VMs. If chained VMs\r
+present, they get added on the right. Test topology is expected to be\r
+symmetric, in other words packets enter and leave SUT through ports specified\r
+on the left of the test name. Here some examples to illustrate the convention\r
+followed by the complete legend, and tables mapping the new test filenames to\r
+old ones.\r
+\r
+Naming Examples\r
+---------------\r
+\r
+CSIT test suite naming examples (filename.robot) for common tested VPP\r
+topologies:\r
+\r
+1. **Physical port to physical port - a.k.a. NIC-to-NIC, Phy-to-Phy, P2P**\r
+\r
+ * *PortNICConfig-WireEncapsulation-PacketForwardingFunction-\r
+ PacketProcessingFunction1-...-PacketProcessingFunctionN-TestType*\r
+ * *10ge2p1x520-dot1q-l2bdbasemaclrn-ndrdisc.robot* => 2 ports of 10GE on Intel\r
+ x520 NIC, dot1q tagged Ethernet, L2 bridge-domain baseline switching with\r
+ MAC learning, NDR throughput discovery.\r
+ * *10ge2p1x520-ethip4vxlan-l2bdbasemaclrn-ndrchk.robot* => 2 ports of 10GE on\r
+ Intel x520 NIC, IPv4 VXLAN Ethernet, L2 bridge-domain baseline switching\r
+ with MAC learning, NDR throughput discovery.\r
+ * *10ge2p1x520-ethip4-ip4base-ndrdisc.robot* => 2 ports of 10GE on Intel x520\r
+ NIC, IPv4 baseline routed forwarding, NDR throughput discovery.\r
+ * *10ge2p1x520-ethip6-ip6scale200k-ndrdisc.robot* => 2 ports of 10GE on Intel\r
+ x520 NIC, IPv6 scaled up routed forwarding, NDR throughput discovery.\r
+ * *10ge2p1x520-ethip4-ip4base-iacldstbase-ndrdisc.robot* => 2 ports of 10GE on\r
+ Intel x520 NIC, IPv4 baseline routed forwarding, ingress Access Control\r
+ Lists baseline matching on destination, NDR throughput discovery.\r
+ * *40ge2p1vic1385-ethip4-ip4base-ndrdisc.robot* => 2 ports of 40GE on Cisco\r
+ vic1385 NIC, IPv4 baseline routed forwarding, NDR throughput discovery.\r
+ * *eth2p-ethip4-ip4base-func.robot* => 2 ports of Ethernet, IPv4 baseline\r
+ routed forwarding, functional tests.\r
+\r
+2. **Physical port to VM (or VM chain) to physical port - a.k.a. NIC2VM2NIC,\r
+ P2V2P, NIC2VMchain2NIC, P2V2V2P**\r
+\r
+ * *PortNICConfig-WireEncapsulation-PacketForwardingFunction-\r
+ PacketProcessingFunction1-...-PacketProcessingFunctionN-VirtEncapsulation-\r
+ VirtPortConfig-VMconfig-TestType*\r
+ * *10ge2p1x520-dot1q-l2bdbasemaclrn-eth-2vhost-1vm-ndrdisc.robot* => 2 ports\r
+ of 10GE on Intel x520 NIC, dot1q tagged Ethernet, L2 bridge-domain switching\r
+ to/from two vhost interfaces and one VM, NDR throughput discovery.\r
+ * *10ge2p1x520-ethip4vxlan-l2bdbasemaclrn-eth-2vhost-1vm-ndrdisc.robot* => 2\r
+ ports of 10GE on Intel x520 NIC, IPv4 VXLAN Ethernet, L2 bridge-domain\r
+ switching to/from two vhost interfaces and one VM, NDR throughput discovery.\r
+ * *10ge2p1x520-ethip4vxlan-l2bdbasemaclrn-eth-4vhost-2vm-ndrdisc.robot* => 2\r
+ ports of 10GE on Intel x520 NIC, IPv4 VXLAN Ethernet, L2 bridge-domain\r
+ switching to/from four vhost interfaces and two VMs, NDR throughput\r
+ discovery.\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
+3. **API CRUD tests - Create (Write), Read (Retrieve), Update (Modify), Delete\r
+ (Destroy) operations for configuration and operational data**\r
+\r
+ * *ManagementTestKeyword-ManagementOperation-ManagedFunction1-...-\r
+ ManagedFunctionN-ManagementAPI1-ManagementAPIN-TestType*\r
+ * *mgmt-cfg-lisp-apivat-func* => configuration of LISP with VAT API calls,\r
+ functional tests.\r
+ * *mgmt-cfg-l2bd-apihc-apivat-func* => configuration of L2 Bridge-Domain with\r
+ HoneyComb API and VAT API calls, functional tests.\r
+ * *mgmt-oper-int-apihcnc-func* => reading status and operational data of\r
+ interface with HoneyComb NetConf API calls, functional tests.\r
+ * *mgmt-cfg-int-tap-apihcnc-func* => configuration of tap interfaces with\r
+ HoneyComb NetConf API calls, functional tests.\r
+ * *mgmt-notif-int-subint-apihcnc-func* => notifications of interface and\r
+ sub-interface events with HoneyComb NetConf Notifications, functional tests.\r
+\r
+For complete description of CSIT test naming convention please refer to `CSIT\r
+test naming page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.\r
Code Review / csit.git / blobdiff