.. SPDX-License-Identifier: BSD-3-Clause
   Copyright(c) 2020 Intel Corporation

=============================
Pipeline Tests
=============================

Description
===========
The "examples/pipeline" application is the main DPDK Packet Framework
application.

Prerequisites
==============
The DUT must have four 10G Ethernet ports connected to four ports on
Tester that are controlled by the Scapy packet generator::

    dut_port_0 <---> tester_port_0
    dut_port_1 <---> tester_port_1
    dut_port_2 <---> tester_port_2
    dut_port_3 <---> tester_port_3

Assume four DUT 10G Ethernet ports' pci device id is as the following::

    dut_port_0 : "0000:00:04.0"
    dut_port_1 : "0000:00:05.0"
    dut_port_2 : "0000:00:06.0"
    dut_port_3 : "0000:00:07.0"

Bind them to dpdk igb_uio driver::

    ./usertools/dpdk-devbind.py -b igb_uio 0000:00:04.0 0000:00:05.0 0000:00:06.0 0000:00:07.0

Supporting Files
================
All the supporting files for this test suite are maintained in the folder named "pipeline"
present in the {DTS_SRC_DIR}/dep directory.

Directory Structure of Each Test Case
=====================================
Within {DTS_SRC_DIR}/dep/pipeline folder, all files related to a particular test case are maintained
in a separate directory of which the directory structure is shown below::

    test_case_name [directory]
        test_case_name.spec
        test_case_name.cli
        table.txt [applicable for test cases requiring it]
        readme.txt
        pcap_files [subdirectory]
            in_x.txt [x: 1-4; depending on test case]
            out_x.txt [x: 1-4; depending on test case]

For an example, files related to mov_001 test case are maintained as shown below::

    mov_001 [directory]
        mov_001.spec
        mov_001.cli
        readme.txt
        pcap_files [subdirectory]
            in_1.txt
            out_1.txt

Template of each Test Case
===========================
1. Edit test_case_name/test_case_name.cli:
   change pci device id of LINK0, LINK1, LINK2, LINK3 to pci device id of
   dut_port_0, dut_port_1, dut_port_2, dut_port_3

2. Run pipeline app as the following::

    x86_64-native-linuxapp-gcc/examples/dpdk-pipeline  -c 0x3 -n 4 -- -s /tmp/pipeline/test_case_name/test_case_name.cli

3. Send packets at tester side using scapy. The packets to be sent are maintained in pipeline/test_case_name/pcap_files/in_x.txt

4. Verify the packets received using tcpdump. The expected packets are maintained in pipeline/test_case_name/pcap_files/out_x.txt

5. Test case is considered as successful if the received packets and the expected packets match for all the port combinations used.

Example Test Case: test_mov_001
=========================================
1. Edit mov_001/mov_001.cli:
   change pci device id of LINK0, LINK1, LINK2, LINK3 to pci device id of
   dut_port_0, dut_port_1, dut_port_2, dut_port_3

2. Run pipeline app as the following::

    x86_64-native-linuxapp-gcc/examples/dpdk-pipeline  -c 0x3 -n 4 -- -s /tmp/pipeline/mov_001/mov_001.cli

3. Send packets at tester side using scapy. The packets to be sent are maintained in pipeline/mov_001/pcap_files/in_1.txt

4. Verify the packets received using tcpdump. The expected packets are maintained in pipeline/mov_001/pcap_files/out_1.txt

5. test_mov_001 is considered as successful if the received packets and the expected packets match for all 4 port combinations used.