[dts] [PATCH] test_plan: add hotplug_test_plan

[Qiu, Michael]

On 2/10/2015 12:27 AM, Iremonger, Bernard wrote:
>> -----Original Message-----
>> From: Qiu, Michael
>> Sent: Monday, February 9, 2015 1:14 PM
>> To: dts at dpdk.org
>> Cc: mukawa at igel.co.jp; Iremonger, Bernard
>> Subject: Re: [PATCH] test_plan: add hotplug_test_plan
>>
>> [+cc] Bernard
>>
>> Hi, Bernard and Tetsuya
>>
>> Would you have time to review this test plan?
> Hi Michael,
>
> Yes, my comments are inline.

OK, I will fix all typo.

Thanks,
Michael
>> Your comments are very important.
>>
>> Thanks,
>> Michael
>> On 2/2/2015 4:47 PM, Qiu, Michael wrote:
>>> As hotplug feature will be supported by DPDK 2.0, the test plan is
>>> needed for testing affairs, this could help who wants to do hotplug
>>> testing for their projects.
>>>
>>> Signed-off-by: Michael Qiu <michael.qiu at intel.com>
>>> ---
>>>  test_plans/hotplug_test_plan.rst | 152
>>> +++++++++++++++++++++++++++++++++++++++
>>>  1 file changed, 152 insertions(+)
>>>  create mode 100644 test_plans/hotplug_test_plan.rst
>>>
>>> diff --git a/test_plans/hotplug_test_plan.rst
>>> b/test_plans/hotplug_test_plan.rst
>>> new file mode 100644
>>> index 0000000..63c3d70
>>> --- /dev/null
>>> +++ b/test_plans/hotplug_test_plan.rst
>>> @@ -0,0 +1,152 @@
>>> +.. Copyright (c) <2015>, 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 Hotplug API Feature Tests
>>> +======================================
>>> +
>>> +This test for Hotplug API feature can be run on linux userspace. It
>>> +will check if NIC port can be attach and detach without exiting the
> Reword "can be attach and detach" to  "can be attached and detached"
>
>>> +application process. Furthermore, it will check if it can reconfigure
>>> +new configurations for a port after the port is stopped, and if it is
>>> +able to restart with those new configurations. It is based on testpmd
>>> +application.
>>> +
>>> +The test is performed by running the testpmd application and using a
>>> +traffic generator. Port configurations can be set interactively, and
>>> +still be set at the command line when launching the application in
>>> +order to be compatible with previous test framework.
>>> +
>>> +Prerequisites
>>> +-------------
>>> +Assume DPDK managerd at least one device for physical or none for virtual.
> Reword "managerd" to "managed"
>
>>> +This feature only supports igb_uio now, for uio_pci_generic is on the
>>> +way, will test it after enabled.
>>> +
>>> +To run the testpmd application in linuxapp environment with 4 lcores,
>>> +4 channels with other default parameters in interactive mode.
>>> +
>>> +        $ ./testpmd -c 0xf -n 4 -- -i
>>> +
>>> +Test ENV:
>>> +
>>> +All test case can be run in 32bit and 64bit platform.
> Reword "case" to "cases"
>
>>> +
>>> +All os can be support, like fedora, ubuntu, rhel, suse, but freebsd
> Reword "All os can be support" to "All os's can be supported"
>
>>> +will not include as hotplug has no plan to support that platform
> Reword "will not include" to "will not be included".
>
>>> +
>>> +All kernel version(start from 2.6) can be support, for vfio need kernel
> Reword " All kernel version(start from 2.6) can be support" to "All kernel versions(from 2.6) can be supported"
>
>>> +        version greater than 3.6.
>>> +
>>> +Virtulization support: KVM/VMware/Xen, container is in the roadmap
>>> +
>>> +---------------------------------------------------------------------
>>> +---------- Test Case 1: port dettach & attach for physical devices
> Reword "dettach" to "detach"
>
>>> +with igb_uio
>>> +---------------------------------------------------------------------
>>> +----------
>>> +1. run "port attach 0000:02:00.0",
>>> +   assume the physical devices is BDF is 0000:02:00.0
>>> +
>>> +2. run "port start 0".
>>> +
>>> +3. run "show port info 0", check port 0 info display.
>>> +
>>> +4. run "start", then "show port stats 0" check fwd packages start.
>>> +
>>> +5. run "port detach 0", check the error message of port not stopped.
>>> +
>>> +6. run "stop", then "show port stats 0", check fwd packages stoped.
> Reword "stoped" to "stopped"
>
>>> +
>>> +7. run "port close 0".
>>> +
>>> +8. run "port detach 0", check port detached successful.
> Should probably have a test case to attach a port again after it has been detached.
>
>>> +
>>> +---------------------------------------------------------------------
>>> +---------- Test Case 2: port dettach & attach for physical devices
> Reword "dettach"  to "detach"
>
>>> +with vfio
>>> +---------------------------------------------------------------------
>>> +----------
>>> +1. run "port attach 0000:02:00.0",
>>> +   assume the physical devices is BDF is 0000:02:00.0
>>> +
>>> +2. run "port start 0".
>>> +
>>> +3. run "show port info 0", check port 0 info display.
>>> +
>>> +4. run "start", then "show port stats 0" check fwd packages start.
>>> +
>>> +5. run "port detach 0", check the error message of port not stopped.
>>> +
>>> +6. run "stop", then "show port stats 0", check fwd packages stoped.
> Reword "stoped" to "stopped" 
>>> +
>>> +7. run "port close 0".
>>> +
>>> +8. run "port detach 0", check port detached failed(If hotplug for vfio
>>> +   implemented, should be successful).
> This should fail as no detach support at the moment for vfio.
>
>>> +
>>> +---------------------------------------------------------------------
>>> +---------- Test Case 3: port dettach & attach for physical devices
> Reword "dettach" to detach.
>
>>> +with uio_pci_generic
>>> +---------------------------------------------------------------------
>>> +----------
> There is no support for uio_pci_generic at present.
> It might be better to leave this test case out until support is added.
>
>>> +1. run "port attach 0000:02:00.0",
>>> +   assume the physical devices is BDF is 0000:02:00.0
>>> +
>>> +2. run "port start 0".
>>> +
>>> +3. run "show port info 0", check port 0 info display.
>>> +
>>> +4. run "start", then "show port stats 0" check fwd packages start.
>>> +
>>> +5. run "port detach 0", check the error message of port not stopped.
>>> +
>>> +6. run "stop", then "show port stats 0", check fwd packages stoped.
> Reword "stoped" to "stopped"
>
>>> +
>>> +7. run "port close 0".
>>> +
>>> +8. run "port detach 0", check port detached successful.
>>> +
>>> +---------------------------------------------------------------------
>>> +---------- Test Case 4: port dettach & attach for virtual devices
> Reword "dettach" to detach.
>
>>> +---------------------------------------------------------------------
>>> +---------- 1. run "port attach eth_pcap0,iface=xxxx", where "xxxx" is
>>> +one workable ifname.
>>> +
>>> +2. run "port start 0".
>>> +
>>> +3. run "show port info 0", check port 0 info display.
>>> +
>>> +4. run "start", then "show port stats 0" check fwd packages start.
>>> +
>>> +5. run "port detach 0", check the error message of port not stopped.
>>> +
>>> +6. run "stop", then "show port stats 0", check fwd packages stoped.
> Reword "stoped" to  "stopped"
>
>>> +
>>> +7. run "port close 0".
>>> +
>>> +8. run "port detach 0", check port detached successful.
>>> +
>>> +successfully
> Should probably have a test case to attach a virtual port again after it has been detached.
>
> Regards,
>
> Bernard.
>