[dts] [PATCH] add telemetry test plan

[Tu, Lijuan]

Applied with copyright date changed.

> -----Original Message-----
> From: dts [mailto:dts-bounces at dpdk.org] On Behalf Of xuyanjie
> Sent: Tuesday, April 16, 2019 9:17 AM
> To: dts at dpdk.org
> Cc: Xu, Yanjie <yanjie.xu at intel.com>
> Subject: [dts] [PATCH] add telemetry test plan
> 
> Signed-off-by: xuyanjie <yanjie.xu at intel.com>
> 
> diff --git a/test_plans/telemetry_test_plan.rst
> b/test_plans/telemetry_test_plan.rst
> new file mode 100644
> index 0000000..8c8898e
> --- /dev/null
> +++ b/test_plans/telemetry_test_plan.rst
> @@ -0,0 +1,228 @@
> +.. Copyright (c) <2015-2017>, Intel Corporation
> +   All rights reserved.
> +
> +   Redistribution and use in source and binary forms, with or without
> +   modification, are permitted provided that the following conditions
> +   are met:
> +
> +   - Redistributions of source code must retain the above copyright
> +     notice, this list of conditions and the following disclaimer.
> +
> +   - Redistributions in binary form must reproduce the above copyright
> +     notice, this list of conditions and the following disclaimer in
> +     the documentation and/or other materials provided with the
> +     distribution.
> +
> +   - Neither the name of Intel Corporation nor the names of its
> +     contributors may be used to endorse or promote products derived
> +     from this software without specific prior written permission.
> +
> +   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
> CONTRIBUTORS
> +   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
> +   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
> FITNESS
> +   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
> +   COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
> INDIRECT,
> +   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
> +   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
> OR
> +   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
> +   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
> CONTRACT,
> +   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
> +   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
> ADVISED
> +   OF THE POSSIBILITY OF SUCH DAMAGE.
> +
> +============================================
> +DPDK Telemetry API Tests
> +============================================
> +
> +This test for Telemetry API  for Service Assurance can be run on linux
> userspace.
> +The application which initializes packet forwarding will act as the
> +server, sending metrics to the requesting application which acts as the
> client.
> +
> +In DPDK, applications can be used to initialize the ``telemetry`` as a virtual
> device.
> +To view incoming traffic on featured ports, the application should be
> +run first (ie. after ports are configured).Once the application is
> +running, the service assurance agent (for example the collectd plugin)
> should be run to begin querying the API.
> +
> +A client connects their Service Assurance application to the DPDK
> +application via a UNIX socket. Once a connection is established,a
> +client can send JSON messages to the DPDK application requesting
> +metrics via another UNIX client.This request is then handled and parsed
> +if valid. The response is then formatted in JSON and sent back to the
> +requesting client
> +
> +Hardwares::
> +------------
> +I40E driver NIC  or ixgbe driver NIC
> +
> +Prerequisites
> +=============
> +
> +1. Enable the telemetry API by modifying the following config option before
> building DPDK::
> +
> +	Python >= 2.5
> +	Jansson library for JSON serialization
> +	CONFIG_RTE_LIBRTE_TELEMETRY=y  and libjansson should be
> available
> +	make install RTE_SDK=`pwd` T=x86_64-native-linuxapp-gcc
> +
> +2. Configiure PF
> +
> +	modprobe uio;
> +	insmod x86_64-native-linuxapp-gcc/kmod/igb_uio.ko;
> +
> +3.   Launch testpmd as the primary application with the ``telemetry``
> +	./app/testpmd --telemetry
> +
> +4.   Launch the ``telemetry`` python script with a client filepath :
> +
> +	 python usertools/telemetry_client.py /var/run/some_client
> +
> +5. Build should include both  make and mesion static/shared
> +
> +	For meson build -return to DPDK directory and create a meson folder:
> +	cd build
> +	ninja
> +	This will compile DPDK via the meson build system
> +	For make build is normal build
> +
> +Test case: basic connection for testpmd and telemetry client::
> +===============================================================
> ===
> +
> +1. bind two ports and build
> +
> +  $./usertools/dpdk-devbind.py --bind=igb_uio 18:00.0 18:00.1
> +
> +2. Run Testpmd with 2 ports
> +
> +  $ ./x86_64-native-linuxapp-gcc/app/testpmd -c f -n 4  --telemetry --
> + -i
> +
> +   For the building meson shared and make shared . tested command
> should be used  when run on ubuntu OS
> +   make share and meson version::
> +   $ ./app/testpmd  -c f -n 4 -d librte_mempool_ring.so -d
> + librte_telemetry.so --telemetry --socket-mem=1024,1024 -- -i
> +
> + 3.Run Python terminal:
> +	python dpdk-telemetry-client.py
> +	enter 1/2/ :
> +
> + 4. check and verify any error show on testpmd
> +
> +Test case:  Stats of 2 ports for testpmd and telemetry with same type
> +nic
> +===============================================================
> ========
> +================
> +
> +1.bind two ports
> +  $./usertools/dpdk-devbind.py --bind=igb_uio 18:00.0 18:00.1
> +
> +2. Run Testpmd with 2 ports
> +
> +  $ ./x86_64-native-linuxapp-gcc/app/testpmd --telemetry  -- -i
> +
> +3.Run Python terminal:
> +
> +	python ./usertools/telemetry_client.py
> +	enter 1/2/ :
> +
> +4.check and very any error show on testpmd
> +
> +5.set rx/tx configration by testpmd
> +
> +	testpmd-> stop
> +	testpmd> show port xstats all
> +
> +6. telemetry client ,enter 1/2
> +
> +7. check  the xstats all and  the metrics be displayed on the client
> +terminal in JSON format
> +
> +	a.	Ensure # of ports stats being returned == # of ports
> +	b.	Ensure packet counts (eg rx_good_packets) is 0
> +	c.   Ensure extended NIC stats are shown (depends on PMD used for
> testing, refer to ixgbe/i40e tests for PMD xstats)
> +	d.	Ensure extended NIC stats are 0 (eg: rx_q0_packets == 0)
> +
> +Test case:  Stats of 2 ports for testpmd and telemetry with different
> +type nic
> +===============================================================
> ========
> +================
> +
> +1.bind two ports
> +  $./usertools/dpdk-devbind.py --bind=igb_uio 18:00.0 88:00.1
> +
> +2. Run Testpmd with 2 ports
> +
> +  $ ./x86_64-native-linuxapp-gcc/app/testpmd --telemetry  -- -i
> +
> +3.Run Python terminal:
> +
> +	python ./usertools/telemetry_client.py
> +	enter 1/2/ :
> +
> +4.check and very any error show on testpmd
> +
> +5.set rx/tx configration by testpmd
> +
> +	testpmd-> stop
> +	testpmd> show port xstats all
> +
> +6. telemetry client ,enter 1/2
> +
> +7. check  the xstats all and  the metrics be displayed on the client
> +terminal in JSON format
> +
> +	a.	Ensure # of ports stats being returned == # of ports
> +	b.	Ensure packet counts (eg rx_good_packets) is 0
> +	c.   Ensure extended NIC stats are shown (depends on PMD used for
> testing, refer to ixgbe/i40e tests for PMD xstats)
> +	d.	Ensure extended NIC stats are 0 (eg: rx_q0_packets == 0)
> +
> +Test case:  Stats of 4 ports for testpmd and telemetry with same type
> +nic
> +===============================================================
> ========
> +================
> +
> +1.bind two ports
> +  $./usertools/dpdk-devbind.py --bind=igb_uio 18:00.0 18:00.1 b1:00.0
> +b1:00.1
> +
> +2. Run Testpmd with 2 ports
> +
> +  $ ./x86_64-native-linuxapp-gcc/app/testpmd --telemetry  -- -i
> +
> +3.Run Python terminal:
> +
> +	python ./usertools/telemetry_client.py
> +	enter 1/2/
> +
> +4.check and very any error show on testpmd
> +
> +5.set rx/tx configration by testpmd
> +
> +	testpmd-> stop
> +	testpmd> show port xstats all
> +
> +6. telemetry client ,enter 1/2
> +
> +7. check  the xstats all and  the metrics be displayed on the client
> +terminal in JSON format
> +
> +	a.	Ensure # of ports stats being returned == # of ports
> +	b.	Ensure packet counts (eg rx_good_packets) is 0
> +	c.   Ensure extended NIC stats are shown (depends on PMD used for
> testing, refer to ixgbe/i40e tests for PMD xstats)
> +	d.	Ensure extended NIC stats are 0 (eg: rx_q0_packets == 0)
> +
> +Test case:  Stats of 4 ports for testpmd and telemetry with different
> +type nic
> +===============================================================
> ========
> +================
> +
> +1.bind two ports
> +  $./usertools/dpdk-devbind.py --bind=igb_uio 18:00.0 18.00.1 88:00.0
> +88:00.1
> +
> +2. Run Testpmd with 2 ports
> +
> +  $ ./x86_64-native-linuxapp-gcc/app/testpmd --telemetry  -- -i
> +
> +3.Run Python terminal:
> +
> +	python ./usertools/telemetry_client.py
> +	enter 1/2/ :
> +
> +4.check and very any error show on testpmd
> +
> +5.set rx/tx configration by testpmd
> +
> +	testpmd-> stop
> +	testpmd> show port xstats all
> +
> +6. telemetry client ,enter 1/2
> +
> +7. check  the xstats all and  the metrics be displayed on the client
> +terminal in JSON format
> +
> +	a.	Ensure # of ports stats being returned == # of ports
> +	b.	Ensure packet counts (eg rx_good_packets) is 0
> +	c.   Ensure extended NIC stats are shown (depends on PMD used for
> testing, refer to ixgbe/i40e tests for PMD xstats)
> +	d.	Ensure extended NIC stats are 0 (eg: rx_q0_packets == 0)
> \ No newline at end of file
> --
> 2.7.4