[dts] [PATCH v2]test_plans: add several dump unit test cases

[dts] [PATCH v2]test_plans: add several dump unit test cases

[Peng Yuan]

Add four cases to unit_tests_dump_test_plan.rst.
Remove one case from unit_tests_dump_test_plan.rst.

Signed-off-by: Peng Yuan <yuan.peng@intel.com>

diff --git a/test_plans/unit_tests_dump_test_plan.rst b/test_plans/unit_tests_dump_test_plan.rst
index cc34eed..652344d 100644
--- a/test_plans/unit_tests_dump_test_plan.rst
+++ b/test_plans/unit_tests_dump_test_plan.rst
@@ -30,36 +30,13 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-============================
-Unit Tests: Dump Log History
-============================
-
-This is the test plan for dump history log of Intel® DPDK .
-
-This section explains how to run the unit tests for dump history log. The test
-can be launched independently using the command line interface.
-This test is implemented as a linuxapp environment application.
-
-The complete test suite is launched automatically using a python-expect
-script (launched using ``make test``) that sends commands to
-the application and checks the results. A test report is displayed on
-stdout.
-
-The steps to run the unit test manually are as follow::
-
-  # make -C ./app/test/
-  # ./app/test/test -n 1 -c ffff
-  RTE>> dump_log_history
-
-The final output of the test will be the initial log of DPDK.
-
 =====================
 Unit Tests: Dump Ring
 =====================
 
-This is the test plan for dump the elements of Intel® DPDK ring.
+This is the test plan for dumping the elements of Intel® DPDK ring.
 
-This section explains how to run the unit tests for dump elements of ring.
+This section explains how to run the unit tests for dumping elements of ring.
 The test can be launched independently using the command line interface.
 This test is implemented as a linuxapp environment application.
 
@@ -74,15 +51,21 @@ The steps to run the unit test manually are as follow::
   # ./app/test/test -n 1 -c ffff
   RTE>> dump_ring
 
-The final output of the test will be detail elements of DPDK ring.
+The final output of the test will be detailed elements of DPDK ring.
+
+Dump the elements of designative DPDK ring::
+
+  RTE>> dump_ring <ring_name>
+
+The final output of the test will be detailed elements of the designative DPDK ring.
 
 ========================
 Unit Tests: Dump Mempool
 ========================
 
-This is the test plan for dump the elements of Intel® DPDK mempool.
+This is the test plan for dumping the elements of Intel® DPDK mempool.
 
-This section explains how to run the unit tests for dump elements of mempool.
+This section explains how to run the unit tests for dumping elements of mempool.
 The test can be launched independently using the command line interface.
 This test is implemented as a linuxapp environment application.
 
@@ -97,15 +80,21 @@ The steps to run the unit test manually are as follow::
   # ./app/test/test -n 1 -c ffff
   RTE>> dump_mempool
 
-The final output of the test will be detail elements of DPDK mempool.
+The final output of the test will be detailed elements of DPDK mempool.
+
+Dump the elements if designative DPDK mempool::
+
+  RTE>> dump_mempool <mempool_name>
+
+The final output of the test will be detailed elements of the designative DPDK mempool.
 
 ================================
 Unit Tests: Dump Physical Memory
 ================================
 
-This is the test plan for dump the elements of Intel® DPDK physical memory.
+This is the test plan for dumping the elements of Intel® DPDK physical memory.
 
-This section explains how to run the unit tests for dump elements of memory.
+This section explains how to run the unit tests for dumping elements of memory.
 The test can be launched independently using the command line interface.
 This test is implemented as a linuxapp environment application.
 
@@ -120,15 +109,15 @@ The steps to run the unit test manually are as follow::
   # ./app/test/test -n 1 -c ffff
   RTE>> dump_physmem
 
-The final output of the test will be detail elements of DPDK physical memory.
+The final output of the test will be detailed elements of DPDK physical memory.
 
 ========================
 Unit Tests: Dump Memzone
 ========================
 
-This is the test plan for dump the elements of Intel® DPDK memzone.
+This is the test plan for dumping the elements of Intel® DPDK memzone.
 
-This section explains how to run the unit tests for dump elements of memzone.
+This section explains how to run the unit tests for dumping elements of memzone.
 The test can be launched independently using the command line interface.
 This test is implemented as a linuxapp environment application.
 
@@ -143,15 +132,15 @@ The steps to run the unit test manually are as follow::
   # ./app/test/test -n 1 -c ffff
   RTE>> dump_memzone
 
-The final output of the test will be detail elements of DPDK memzone.
+The final output of the test will be detailed elements of DPDK memzone.
 
 ============================
 Unit Tests: Dump Struct Size
 ============================
 
-This is the test plan for dump the size of Intel® DPDK structure.
+This is the test plan for dumping the size of Intel® DPDK structure.
 
-This section explains how to run the unit tests for dump structure size.
+This section explains how to run the unit tests for dumping structure size.
 The test can be launched independently using the command line interface.
 This test is implemented as a linuxapp environment application.
 
@@ -167,3 +156,96 @@ The steps to run the unit test manually are as follow::
   RTE>> dump_struct_sizes
 
 The final output of the test will be the size of DPDK structure.
+
+========================
+Unit Tests: Dump Devargs
+========================
+
+This is the test plan for dumping device arguments of Intel® DPDK.
+
+This section explains how to run the unit tests for dumping device arguments.
+The test can be launched independently using the command line interface.
+This test is implemented as a linuxapp environment application.
+
+The complete test suite is launched automatically using a python-expect
+script (launched using ``make test``) that sends commands to
+the application and checks the results. A test report is displayed on
+stdout.
+
+The steps to run the unit test manually are as follow::
+
+  # make -C ./app/test/
+  # ./app/test/test -n 1 -c ffff -w|-b pci_address
+  RTE>> dump_devargs
+
+The final output of the test will be the pci address of white list
+or black list.
+
+=============================
+Unit Tests: Dump malloc stats
+=============================
+
+This is the test plan for dumping malloc stats of Intel® DPDK heaps.
+
+This section explains how to run the unit tests for dumping malloc stats.
+The test can be launched independently using the command line interface.
+This test is implemented as a linuxapp environment application.
+
+The complete test suite is launched automatically using a python-expect
+script (launched using ``make test``) that sends commands to
+the application and checks the results. A test report is displayed on
+stdout.
+
+The steps to run the unit test manually are as follow::
+
+  # make -C ./app/test/
+  # ./app/test/test -n 1 -c ffff
+  RTE>> dump_malloc_stats
+
+The final output of the test will be the malloc stats of DPDK heap.
+
+=============================
+Unit Tests: Dump malloc heaps
+=============================
+
+This is the test plan for dumping detailed malloc status of each Intel® DPDK heap.
+
+This section explains how to run the unit tests for dumping malloc heaps.
+The test can be launched independently using the command line interface.
+This test is implemented as a linuxapp environment application.
+
+The complete test suite is launched automatically using a python-expect
+script (launched using ``make test``) that sends commands to
+the application and checks the results. A test report is displayed on
+stdout.
+
+The steps to run the unit test manually are as follow::
+
+  # make -C ./app/test/
+  # ./app/test/test -n 1 -c ffff
+  RTE>> dump_malloc_heaps
+
+The final output of the test will be the detailed malloc status of each DPDK heap.
+
+==========================
+Unit Tests: Dump log types
+==========================
+
+This is the test plan for dumping log level of all Intel® DPDK log types.
+
+This section explains how to run the unit tests for dumping log types.
+The test can be launched independently using the command line interface.
+This test is implemented as a linuxapp environment application.
+
+The complete test suite is launched automatically using a python-expect
+script (launched using ``make test``) that sends commands to
+the application and checks the results. A test report is displayed on
+stdout.
+
+The steps to run the unit test manually are as follow::
+
+  # make -C ./app/test/
+  # ./app/test/test -n 1 -c ffff
+  RTE>> dump_log_types
+
+The final output of the test will be the log level of each DPDK log type.
-- 
2.7.4

Re: [dts] [PATCH v2]test_plans: add several dump unit test cases

[Tu, Lijuan]

Applied, thanks

> -----Original Message-----
> From: dts [mailto:dts-bounces@dpdk.org] On Behalf Of Peng Yuan
> Sent: Wednesday, June 5, 2019 1:05 PM
> To: dts@dpdk.org
> Cc: Peng, Yuan <yuan.peng@intel.com>
> Subject: [dts] [PATCH v2]test_plans: add several dump unit test cases
> 
> Add four cases to unit_tests_dump_test_plan.rst.
> Remove one case from unit_tests_dump_test_plan.rst.
> 
> Signed-off-by: Peng Yuan <yuan.peng@intel.com>
> 
> diff --git a/test_plans/unit_tests_dump_test_plan.rst
> b/test_plans/unit_tests_dump_test_plan.rst
> index cc34eed..652344d 100644
> --- a/test_plans/unit_tests_dump_test_plan.rst
> +++ b/test_plans/unit_tests_dump_test_plan.rst
> @@ -30,36 +30,13 @@
>     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
> ADVISED
>     OF THE POSSIBILITY OF SUCH DAMAGE.
> 
> -============================
> -Unit Tests: Dump Log History
> -============================
> -
> -This is the test plan for dump history log of Intel® DPDK .
> -
> -This section explains how to run the unit tests for dump history log. The
> test -can be launched independently using the command line interface.
> -This test is implemented as a linuxapp environment application.
> -
> -The complete test suite is launched automatically using a python-expect -
> script (launched using ``make test``) that sends commands to -the
> application and checks the results. A test report is displayed on -stdout.
> -
> -The steps to run the unit test manually are as follow::
> -
> -  # make -C ./app/test/
> -  # ./app/test/test -n 1 -c ffff
> -  RTE>> dump_log_history
> -
> -The final output of the test will be the initial log of DPDK.
> -
>  =====================
>  Unit Tests: Dump Ring
>  =====================
> 
> -This is the test plan for dump the elements of Intel® DPDK ring.
> +This is the test plan for dumping the elements of Intel® DPDK ring.
> 
> -This section explains how to run the unit tests for dump elements of ring.
> +This section explains how to run the unit tests for dumping elements of
> ring.
>  The test can be launched independently using the command line interface.
>  This test is implemented as a linuxapp environment application.
> 
> @@ -74,15 +51,21 @@ The steps to run the unit test manually are as follow::
>    # ./app/test/test -n 1 -c ffff
>    RTE>> dump_ring
> 
> -The final output of the test will be detail elements of DPDK ring.
> +The final output of the test will be detailed elements of DPDK ring.
> +
> +Dump the elements of designative DPDK ring::
> +
> +  RTE>> dump_ring <ring_name>
> +
> +The final output of the test will be detailed elements of the designative
> DPDK ring.
> 
>  ========================
>  Unit Tests: Dump Mempool
>  ========================
> 
> -This is the test plan for dump the elements of Intel® DPDK mempool.
> +This is the test plan for dumping the elements of Intel® DPDK mempool.
> 
> -This section explains how to run the unit tests for dump elements of
> mempool.
> +This section explains how to run the unit tests for dumping elements of
> mempool.
>  The test can be launched independently using the command line interface.
>  This test is implemented as a linuxapp environment application.
> 
> @@ -97,15 +80,21 @@ The steps to run the unit test manually are as follow::
>    # ./app/test/test -n 1 -c ffff
>    RTE>> dump_mempool
> 
> -The final output of the test will be detail elements of DPDK mempool.
> +The final output of the test will be detailed elements of DPDK mempool.
> +
> +Dump the elements if designative DPDK mempool::
> +
> +  RTE>> dump_mempool <mempool_name>
> +
> +The final output of the test will be detailed elements of the designative
> DPDK mempool.
> 
>  ================================
>  Unit Tests: Dump Physical Memory
>  ================================
> 
> -This is the test plan for dump the elements of Intel® DPDK physical memory.
> +This is the test plan for dumping the elements of Intel® DPDK physical
> memory.
> 
> -This section explains how to run the unit tests for dump elements of
> memory.
> +This section explains how to run the unit tests for dumping elements of
> memory.
>  The test can be launched independently using the command line interface.
>  This test is implemented as a linuxapp environment application.
> 
> @@ -120,15 +109,15 @@ The steps to run the unit test manually are as
> follow::
>    # ./app/test/test -n 1 -c ffff
>    RTE>> dump_physmem
> 
> -The final output of the test will be detail elements of DPDK physical memory.
> +The final output of the test will be detailed elements of DPDK physical
> memory.
> 
>  ========================
>  Unit Tests: Dump Memzone
>  ========================
> 
> -This is the test plan for dump the elements of Intel® DPDK memzone.
> +This is the test plan for dumping the elements of Intel® DPDK memzone.
> 
> -This section explains how to run the unit tests for dump elements of
> memzone.
> +This section explains how to run the unit tests for dumping elements of
> memzone.
>  The test can be launched independently using the command line interface.
>  This test is implemented as a linuxapp environment application.
> 
> @@ -143,15 +132,15 @@ The steps to run the unit test manually are as
> follow::
>    # ./app/test/test -n 1 -c ffff
>    RTE>> dump_memzone
> 
> -The final output of the test will be detail elements of DPDK memzone.
> +The final output of the test will be detailed elements of DPDK memzone.
> 
>  ============================
>  Unit Tests: Dump Struct Size
>  ============================
> 
> -This is the test plan for dump the size of Intel® DPDK structure.
> +This is the test plan for dumping the size of Intel® DPDK structure.
> 
> -This section explains how to run the unit tests for dump structure size.
> +This section explains how to run the unit tests for dumping structure size.
>  The test can be launched independently using the command line interface.
>  This test is implemented as a linuxapp environment application.
> 
> @@ -167,3 +156,96 @@ The steps to run the unit test manually are as
> follow::
>    RTE>> dump_struct_sizes
> 
>  The final output of the test will be the size of DPDK structure.
> +
> +========================
> +Unit Tests: Dump Devargs
> +========================
> +
> +This is the test plan for dumping device arguments of Intel® DPDK.
> +
> +This section explains how to run the unit tests for dumping device
> arguments.
> +The test can be launched independently using the command line interface.
> +This test is implemented as a linuxapp environment application.
> +
> +The complete test suite is launched automatically using a python-expect
> +script (launched using ``make test``) that sends commands to the
> +application and checks the results. A test report is displayed on
> +stdout.
> +
> +The steps to run the unit test manually are as follow::
> +
> +  # make -C ./app/test/
> +  # ./app/test/test -n 1 -c ffff -w|-b pci_address  RTE>> dump_devargs
> +
> +The final output of the test will be the pci address of white list or
> +black list.
> +
> +=============================
> +Unit Tests: Dump malloc stats
> +=============================
> +
> +This is the test plan for dumping malloc stats of Intel® DPDK heaps.
> +
> +This section explains how to run the unit tests for dumping malloc stats.
> +The test can be launched independently using the command line interface.
> +This test is implemented as a linuxapp environment application.
> +
> +The complete test suite is launched automatically using a python-expect
> +script (launched using ``make test``) that sends commands to the
> +application and checks the results. A test report is displayed on
> +stdout.
> +
> +The steps to run the unit test manually are as follow::
> +
> +  # make -C ./app/test/
> +  # ./app/test/test -n 1 -c ffff
> +  RTE>> dump_malloc_stats
> +
> +The final output of the test will be the malloc stats of DPDK heap.
> +
> +=============================
> +Unit Tests: Dump malloc heaps
> +=============================
> +
> +This is the test plan for dumping detailed malloc status of each Intel® DPDK
> heap.
> +
> +This section explains how to run the unit tests for dumping malloc heaps.
> +The test can be launched independently using the command line interface.
> +This test is implemented as a linuxapp environment application.
> +
> +The complete test suite is launched automatically using a python-expect
> +script (launched using ``make test``) that sends commands to the
> +application and checks the results. A test report is displayed on
> +stdout.
> +
> +The steps to run the unit test manually are as follow::
> +
> +  # make -C ./app/test/
> +  # ./app/test/test -n 1 -c ffff
> +  RTE>> dump_malloc_heaps
> +
> +The final output of the test will be the detailed malloc status of each DPDK
> heap.
> +
> +==========================
> +Unit Tests: Dump log types
> +==========================
> +
> +This is the test plan for dumping log level of all Intel® DPDK log types.
> +
> +This section explains how to run the unit tests for dumping log types.
> +The test can be launched independently using the command line interface.
> +This test is implemented as a linuxapp environment application.
> +
> +The complete test suite is launched automatically using a python-expect
> +script (launched using ``make test``) that sends commands to the
> +application and checks the results. A test report is displayed on
> +stdout.
> +
> +The steps to run the unit test manually are as follow::
> +
> +  # make -C ./app/test/
> +  # ./app/test/test -n 1 -c ffff
> +  RTE>> dump_log_types
> +
> +The final output of the test will be the log level of each DPDK log type.
> --
> 2.7.4