Align testcase formats and complete volume testcase descriptions.

Change-Id: Ie7497f6e5ef79726d8cbbcd9f05bffa2aac6c8b8
Signed-off-by: louie.long <longyu805@163.com>
(cherry picked from commit 60f1c35c294d5d94a862db348315f8f3b9f870ba)

diff --git a/docs/testing/user/testspecification/tempest_volume/index.rst b/docs/testing/user/testspecification/tempest_volume/index.rst
index 80af54f..a0987d4 100644 (file)
--- a/docs/testing/user/testspecification/tempest_volume/index.rst
+++ b/docs/testing/user/testspecification/tempest_volume/index.rst
@@ -39,18 +39,86 @@ All these test cases are included in the test case dovetail.tempest.volume of
 OVP test suite.
 
 
-`Attach Detach Volume to Instance <https://github.com/openstack/tempest/blob/master/tempest/api/volume/test_volumes_actions.py>`_
-    - tempest.api.volume.test_volumes_actions.VolumesActionsTest.test_attach_detach_volume_to_instance
+------------------------------------------------------------------------
+Test Case 1 - `Attach Detach Volume to Instance <https://github.com/openstack/tempest/blob/17.1.0/tempest/api/volume/test_volumes_actions.py>`_
+------------------------------------------------------------------------
 
+Test case specification
+-----------------------
 
-`Volume Boot Pattern test <https://github.com/openstack/tempest/blob/master/tempest/scenario/test_volume_boot_pattern.py>`_
-    - Create in Cinder some bootable volume importing a Glance image
-    - Boot an instance from the bootable volume
-    - Write content to the volume
-    - Delete an instance and Boot a new instance from the volume
-    - Check written content in the instance
-    - Create a volume snapshot while the instance is running
-    - Boot an additional instance from the new snapshot based volume
-    - Check written content in the instance booted from snapshot
+tempest.api.volume.test_volumes_actions.VolumesActionsTest.test_attach_detach_volume_to_instance
 
-- tempest.scenario.test_volume_boot_pattern.TestVolumeBootPattern.test_volume_boot_pattern
\ No newline at end of file
+Test preconditions
+------------------
+
+* Volume extension API
+
+Basic test flow execution description and pass/fail criteria
+------------------------------------------------------------
+
+Test execution
+''''''''''''''
+* Test action 1: Create a server VM1
+* Test action 2: Attach a provided VOL1 to VM1
+* **Test assertion 1:** Verify VOL1 is in 'in-use' status
+* Test action 3: Detach VOL1 from VM1
+* **Test assertion 2:** Verify detach volume VOL1 successfully and VOL1 is in 'available' status
+
+Pass / fail criteria
+''''''''''''''''''''
+
+This test evaluates the volume API ability of attaching a volume to a server
+and detaching a volume from a server. Specifically, the test verifies that:
+
+* Volumes can be attached and detached from servers.
+
+In order to pass this test, all test assertions listed in the test execution above need to pass.
+
+Post conditions
+---------------
+
+N/A
+
+------------------------------------------------------------------------
+Test Case 2 - `Volume Boot Pattern test <https://github.com/openstack/tempest/blob/17.1.0/tempest/scenario/test_volume_boot_pattern.py>`_
+------------------------------------------------------------------------
+
+Test case specification
+-----------------------
+
+tempest.scenario.test_volume_boot_pattern.TestVolumeBootPattern.test_volume_boot_pattern
+
+Test preconditions
+------------------
+
+* Volume extension API
+
+Basic test flow execution description and pass/fail criteria
+------------------------------------------------------------
+
+Test execution
+''''''''''''''
+* Test action 1:Create in Cinder some bootable volume VOL1 importing a Glance image
+* Test action 2:Boot an instance VM1 from the bootable volume VOL1
+* Test action 3:Write content to the VOL1
+* Test action 4:Delete VM1 and Boot a new instance VM2 from the volume VOL1
+* Test action 5:Check written content in the instance
+* **Test assertion 1:** Verify the content of written file in action 3
+* Test action 6:Create a volume snapshot VOL2 while the instance VM2 is running
+* Test action 7:Boot an additional instance VM3 from the new snapshot based volume VOL2
+* Test action 8:Check written content in the instance booted from snapshot
+* **Test assertion 2:** Verify the content of written file in action 3
+
+Pass / fail criteria
+''''''''''''''''''''
+
+This test evaluates the volume storage consistency. Specifically, the test verifies that:
+
+* The content of written file in the volume.
+
+In order to pass this test, all test assertions listed in the test execution above need to pass.
+
+Post conditions
+---------------
+
+N/A