Process Case View Part Of SWA

this part will show a sequence graph of test execution flow to help users to use yardstick

Change-Id: Ie72ee6da93eb2fbe89f3a121190b6a87d232dfb0
Signed-off-by: rexlee8776 <limingjiang@huawei.com>
(cherry picked from commit a17470a28b597749bbcd8f360eca31bf9e0e822f)

diff --git a/docs/userguide/architecture.rst b/docs/userguide/architecture.rst
index ccf8d48..ff241d0 100644 (file)
--- a/docs/userguide/architecture.rst
+++ b/docs/userguide/architecture.rst
@@ -135,7 +135,30 @@ TBD(Qiliang)
 
 Process View (Test execution flow)
 ==================================
-TBD(Limingjiang)
+Yardstick process view shows how yardstick runs a test case. Below is the
+sequence graph about the test execution flow using heat context, and each
+object represents one module in yardstick:
+
+.. image:: images/test_execution_flow.png
+   :width: 800px
+   :alt: Yardstick Process View
+
+A user wants to do a test with yardstick. He can use the CLI to input the
+command to start a task. "TaskCommands" will receive the command and ask
+"HeatContext" to parse the context. "HeatContext" will then ask "Model" to
+convert the model. After the model is generated, "HeatContext" will inform
+"Openstack" to deploy the heat stack by heat template. After "Openstack"
+deploys the stack, "HeatContext" will inform "Runner" to run the specific test
+case.
+
+Firstly, "Runner" would ask "TestScenario" to process the specific scenario.
+Then "TestScenario" will start to log on the openstack by ssh protocal and
+execute the test case on the specified VMs. After the script execution
+finishes, "TestScenario" will send a message to inform "Runner". When the
+testing job is done, "Runner" will inform "Dispatcher" to output the test
+result via file, influxdb or http. After the result is output, "HeatContext"
+will call "Openstack" to undeploy the heat stack. Once the stack is
+undepoyed, the whole test ends.
 
 Deployment View
 ===============

diff --git a/docs/userguide/images/test_execution_flow.png b/docs/userguide/images/test_execution_flow.png
new file mode 100644 (file)
index 0000000..c20a931
Binary files /dev/null and b/docs/userguide/images/test_execution_flow.png differ