Re: [dts] [PATCH V2] Add explain for new added parameters "virttype", "debug" and "debugcase". CRB configuration file moved from python file to plain txt file.

["Liu, Yong" <yong.liu@intel.com>]

Sorry for tope. Will change it when merged the doc.

> -----Original Message-----
> From: Qiu, Michael
> Sent: Thursday, September 17, 2015 9:04 AM
> To: Liu, Yong
> Cc: dts@dpdk.org
> Subject: RE: [dts] [PATCH V2] Add explain for new added parameters
> "virttype", "debug" and "debugcase". CRB configuration file moved from
> python file to plain txt file.
> 
> Hi, Marvin
> 
> You'd better short your subject and let them into the commit log.
> 
> Thanks,
> Michael
> 
> -----Original Message-----
> From: dts [mailto:dts-bounces@dpdk.org] On Behalf Of Yong Liu
> Sent: Thursday, September 17, 2015 8:35 AM
> To: dts@dpdk.org
> Subject: [dts] [PATCH V2] Add explain for new added parameters "virttype",
> "debug" and "debugcase". CRB configuration file moved from python file to
> plain txt file.
> 
> From: Marvin Liu <yong.liu@intel.com>
> 
> Signed-off-by: Marvin Liu <yong.liu@intel.com>
> 
> diff --git a/doc/dts_gsg/conf.py b/doc/dts_gsg/conf.py index
> 9213b01..6a8c679 100644
> --- a/doc/dts_gsg/conf.py
> +++ b/doc/dts_gsg/conf.py
> @@ -1,5 +1,5 @@
>  #   BSD LICENSE
> -#   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
> +#   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
>  #   All rights reserved.
>  #
>  #   Redistribution and use in source and binary forms, with or without
> @@ -32,7 +32,7 @@ import subprocess
> 
>  project = 'DPDK Test Suite'
> 
> -copyright = '2014, dpdk.org'
> +copyright = '2015, dpdk.org'
> 
>  #version = subprocess.check_output(["make","-sRrC","../../",
> "showversion"])
> 
> diff --git a/doc/dts_gsg/config.rst b/doc/dts_gsg/config.rst index
> 7276681..c6de5f2 100644
> --- a/doc/dts_gsg/config.rst
> +++ b/doc/dts_gsg/config.rst
> @@ -10,9 +10,10 @@ For Example, please see specific usage, you can get
> these information via DPDK T  .. code-block:: console
> 
>     usage: main.py [-h] [--config-file CONFIG_FILE] [--git GIT] [--patch
> PATCH]
> -               [--snapshot SNAPSHOT] [--output OUTPUT] [-s] [-r] [-p
> PROJECT]
> -               [--suite-dir SUITE_DIR] [-t TEST_CASES [TEST_CASES ...]]
> -               [-d DIR]
> +                  [--snapshot SNAPSHOT] [--output OUTPUT] [-s] [-r] [-p
> PROJECT]
> +                  [--suite-dir SUITE_DIR] [-t TEST_CASES] [-d DIR] [-v]
> +                  [--virttype VIRTTYPE] [--debug] [--debugcase]
> +
> 
>  DPDK Test Suite supports the following parameters:
> 
> @@ -23,16 +24,16 @@ DPDK Test Suite supports the following parameters:
>      +---------------------------+----------------------------------------
> -----------+------------------+
>      | -h,--help                 | show this help message and exit
> |                  |
>      +---------------------------+----------------------------------------
> -----------+------------------+
> -    | --config-file CONFIG_FILE | configuration file that describes the
> test cases, | ../execution.cfg |
> +    | --config-file CONFIG_FILE | configuration file that describes the
> test cases, | execution.cfg    |
>      |                           | DUTs and targets
> |                  |
>      +---------------------------+----------------------------------------
> -----------+------------------+
>      | --git GIT                 | Indicate git label to use as input
> | None             |
>      +---------------------------+----------------------------------------
> -----------+------------------+
>      | --patch PATCH             | apply a patch to the package under test
> | None             |
>      +---------------------------+----------------------------------------
> -----------+------------------+
> -    | --snapshot SNAPSHOT       | snapshot .tgz file to use as input
> | ../dpdk.tar.gz   |
> +    | --snapshot SNAPSHOT       | snapshot .tgz file to use as input
> | dep/dpdk.tar.gz  |
>      +---------------------------+----------------------------------------
> -----------+------------------+
> -    | --output OUTPUT           | Output directory where DPDK Test Suite
> log and    | ../output        |
> +    | --output OUTPUT           | Output directory where DPDK Test Suite
> log and    | output           |
>      |                           | result saved
> |                  |
>      +---------------------------+----------------------------------------
> -----------+------------------+
>      | -s --skip-setup           | Skips all possible setup steps done on
> both DUT   |                  |
> @@ -53,11 +54,20 @@ DPDK Test Suite supports the following parameters:
>      +---------------------------+----------------------------------------
> -----------+------------------+
>      | -d DIR --dir DIR          | Output directory where dpdk package is
> extracted  | dpdk             |
>      +---------------------------+----------------------------------------
> -----------+------------------+
> -    | --suite-dir               | Test suite directory where test suites
> will be    | ../tests         |
> +    | --suite-dir               | Test suite directory where test suites
> will be    | tests            |
>      |                           | imported
> |                  |
>      +---------------------------+----------------------------------------
> -----------+------------------+
>      | -v, --verbose             | Enable verbose output, all log shown on
> screen    |                  |
>      +---------------------------+----------------------------------------
> -----------+------------------+
> +    | --virttype                | Set virtualization hypervisor type.
> Support kvm   |                  |
> +    |                           | and libvirtd by now.
> |                  |
> +    +---------------------------+----------------------------------------
> -----------+------------------+
> +    | --debug                   | Enable debug mode, running process can
> be         |                  |
> +    |                           | interrupted and enter debug mode.
> |                  |
> +    +---------------------------+----------------------------------------
> -----------+------------------+
> +    | --debugcase               | Enter into debug mode before running
> every test   |                  |
> +    |                           | case.
> |                  |
> +
> + +---------------------------+-----------------------------------------
> + ----------+------------------+
> 
>  Please see more information about some critical parameters as the
> following:
> 
> @@ -72,6 +82,7 @@ When we use –-git parameter, DPDK Test Suite will clone
> the source code from d
>  **--patch**
> 
>  DPDK Test Suite also support apply specified patch list by --patch
> parameter before build DPDK packet.
> +
>  **--skip-setup**
> 
>  If DPDK source code doesn’t changed, you can use --skip-setup to skip
> unzip and compilation of DPDK source code, just reuse original source code.
> @@ -85,7 +96,7 @@ Parameter –-project can load customized project model
> and do its own project i  If we perform multiple validation at the same
> time, result files in output folder maybe overwritten. Then we can use –-
> output parameter to specify the output folder and save execution log and
> result files. This option will make sure that all test result will be
> stored in the different excel files and rst files, doesn’t conflict each
> other.
> 
>  .. note::
> -   The current working folder of DPDK Test Suite is “framework” and
> default output folder is “../output”
> +   The current working folder of DPDK Test Suite is "DTS root directory"
> and default output folder is “output”
> 
>  **--t**
> 
> @@ -101,15 +112,39 @@ DPDK Test Suite support load suites from different
> folders, this will be helpful
> 
>  DPDK Test Suite support verbose mode. When enable this mode, all log
> messages will be output on screen and helpful for debug.
> 
> +**--virttype**
> +
> +Choose virtualization hypervisor type. By now this configuration is
> useless.
> +
> +**--debug**
> +
> +DPDK Test Suite support debug mode. After keyboard ctrl+c message to DTS
> process, will run into this mode. User can do further debug by attached to
> sessions or call pdb module by interact interface.
> +
> +Debug interact support commands as below:
> +
> +.. code-block:: console
> +
> +    help(): show help message
> +    list(): list all connected sessions
> +    connect(name): connect to session directly
> +    exit(): exit dts
> +    quit(): quit debug mode and into noraml mode
> +    debug(): call python debug module
> +
> +**--debugcase**
> +
> +Another approach to run into debug mode. With this option on, DTS will
> hang and wait for user command before execution of each test case.
> +
>  DPDK Release Preparation
>  ------------------------
> 
> -Firstly, you need to download the latest code from dpdk.org, then archive
> and compress it in the source code folder. After that, please move this
> zipped file to DPDK Test Suite folder. Once launch test framework, DPDK
> Test Suite will copy this zipped file to root folder on DUT. Finally this
> source code zip file will be unzipped and built.
> +Firstly, you need to download the latest code from dpdk.org, then archive
> and compress it into zipped file. After that, please move this zipped file
> to DPDK Test Suite "dep" folder. Once launch test framework, DPDK Test
> Suite will copy this zipped file to root folder on DUT. Finally this
> source code zip file will be unzipped and built.
> 
>  .. code-block:: console
> 
> -    [root@tester dcts]#  ls
> -    [root@tester dcts]#  dts  dpdk.tar.gz  execution.cfg  framework
> output  test_plans  tests
> +    [root@tester dts]#  ls
> +    [root@tester dts]#  conf dep doc dts executions framework output
> + test_plans tests tools
> +
> 
>  If enables patch option, DPDK Test Suite will also make patch the
> unzipped folder and compile it.
> 
> @@ -125,18 +160,20 @@ First of all, you must create a file named
> execution.cfg as below.
>  .. code-block:: console
> 
>     [Execution1]
> -   crbs=10.239.128.117
> +   crbs=192.168.1.1
>     test_suites=
>     hello_world,
>     l2fwd
>     targets=
>     x86_64-default-linuxapp-gcc,
>     parameters=nic_type=niantic:func=true
> +   scenario=pf_passthrough
> 
>  *   crbs: IP address of the DUT CRB. The detail information of this CRB
> is defined in file crbs.py.
>  *   test_suites:  defines list of test suites, which will plan to be
> executed.
>  *   gets: list of DPDK targets to be tested.
>  *   parameters: you can define multiple keywords
> +*   scenario: Senario of DPDK virtualization environment for this
> execution.
> 
>      – nic_type : is the type of the NIC to use. The types are defined in
> the file settings.py.
> 
> @@ -144,39 +181,44 @@ First of all, you must create a file named
> execution.cfg as below.
> 
>      – perf=true run only performance test
> 
> -Then please add the detail information about your CRB in **crbs.py** as
> follows:
> +Then please add the detail information about your CRB in
> **conf/crbs.conf** as follows:
> 
>  .. code-block:: console
> 
> -   crbs = [
> -    {'IP': '10.239.128.117',
> -     'name': 'CrownPassCRB1',
> -     'user': 'root',
> -     'pass': 'tester',
> -     'tester IP': '10.239.128.116',
> -     IXIA: None,
> -     'memory channels': 4,
> -     'bypass core0': True},
> -    ]
> +   [192.168.1.1]
> +   dut_ip=192.168.1.1
> +   dut_user=root
> +   dut_passwd=
> +   os=linux
> +   tester_ip=192.168.1.2
> +   tester_passwd=
> +   ixia_group=group1
> +   channels=4
> +   bypass_core0=True
> +
> 
>  .. table::
> 
>      +-----------------+--------------------------------------------------
> --+
>      | Item            | description
> |
>      +-----------------+--------------------------------------------------
> --+
> -    | IP              | IP address of DUT
> |
> +    | dut_ip          | IP address of DUT
> |
> +    +-----------------+--------------------------------------------------
> --+
> +    | dut_user        | UserName of DPDK Test Suite used to login into
> DUT |
>      +-----------------+--------------------------------------------------
> --+
> -    | name            | Name of DUT
> |
> +    | dut_passwd      | Password of DPDK Test Suite used to login into
> DUT |
>      +-----------------+--------------------------------------------------
> --+
> -    | user            | UserName of DPDK Test Suite used to login into
> DUT |
> +    | os              | Distribution of operation system
> |
>      +-----------------+--------------------------------------------------
> --+
> -    | pass            | Password of DPDK Test Suite used to login into
> DUT |
> +    | tester_ip       | IP address of tester
> |
>      +-----------------+--------------------------------------------------
> --+
> -    | Tester IP       | IP address of tester
> |
> +    | tester_passwd   | Password to login into Tester
> |
>      +-----------------+--------------------------------------------------
> --+
> -    | memory channels | number of memory channels for DPDK EAL
> |
> +    | ixia_group      | IXIA group name for DUT
> |
>      +-----------------+--------------------------------------------------
> --+
> -    | bypass core0    | skip the first core when initialize DPDK
> |
> +    | channels        | number of memory channels for DPDK EAL
> |
> +    +-----------------+--------------------------------------------------
> --+
> +    | bypass_core0    | skip the first core when initialize DPDK
> |
>      +-----------------+--------------------------------------------------
> --+
> 
>  Launch DPDK Test Suite
> @@ -188,17 +230,18 @@ DPDK Test Suite will create communication sessions
> first.
> 
>  .. code-block:: console
> 
> -   DUT 10.239.128.117
> -   DTS_DUT_CMD: ssh root@10.239.128.117
> -   DTS_DUT_CMD: ssh root@10.239.128.117
> -   DTS_TESTER_CMD: ssh root@10.239.128.116
> -   DCS_TESTER_CMD: ssh root@10.239.128.116
> +   DUT 192.168.1.1
> +   INFO: ssh root@192.168.1.1
> +   INFO: ssh root@192.168.1.1
> +   INFO: ssh root@192.168.1.2
> +   INFO: ssh root@192.168.1.2
> 
> 
>  Then copy snapshot zipped dpdk source code to DUT.
> +
>  .. code-block:: console
> 
> -   DTS_DUT_CMD: scp ../dpdk.tar.gz root@10.239.128.117:
> +   DTS_DUT_CMD: scp dep/dpdk.tar.gz root@192.168.1.1:
> 
>  Collect CPU core and network device information of DUT and tester.
> 
> @@ -239,7 +282,7 @@ Clean-up DUT and tester after all validation finished.
> 
>  .. code-block:: console
> 
> -           DTS_DUT_CMD: rmmod igb_uio
> +        DTS_DUT_CMD: rmmod igb_uio
>          DTS_DUT_CMD: modprobe igb
>          DTS_DUT_CMD: modprobe ixgbe
>          DTS_DUT_CMD: modprobe e1000e
> --
> 1.9.3