summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide
diff options
context:
space:
mode:
authorrajesh_4k <4k.rajesh@gmail.com>2017-02-27 18:09:00 +0530
committerJing Lu <lvjing5@huawei.com>2017-03-30 09:46:32 +0000
commit06c0f074a136414d1e9704aa4e30c62e50f2d5ce (patch)
treeca1db646cb02b0b7c9b29ac8cd1c282f94e29fc3 /docs/testing/user/userguide
parentaa499064bf305e41a56a2f86d17c1cc29a1d7b0c (diff)
Yardstick: User interface for Yardstick.
Currently Yardstick doesnt have any UI which gives detail analysis of the test-results. This commit generates a HTML page after the execution of a command "yardstick report generate <task-ID> <TC-name>" which intern can be executed after the execution of test-case. Used: Highcharts.js for the graphs. JIRA: YARDSTICK-280 Change-Id: Ic98cc348719f3922bff178f52e7944a4a931763a Signed-off-by: Rajesh K <4k.rajesh@gmail.com> (cherry picked from commit 25b21add71fcf7c2c795bd950b5117d69fac68fb)
Diffstat (limited to 'docs/testing/user/userguide')
-rw-r--r--docs/testing/user/userguide/Yardstick_user_interface.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/Yardstick_user_interface.rst b/docs/testing/user/userguide/Yardstick_user_interface.rst
new file mode 100644
index 000000000..9058dd46d
--- /dev/null
+++ b/docs/testing/user/userguide/Yardstick_user_interface.rst
@@ -0,0 +1,29 @@
+Yardstick User Interface
+========================
+
+This interface provides a user to view the test result
+in table format and also values pinned on to a graph.
+
+
+Command
+-------
+::
+
+ yardstick report generate <task-ID> <testcase-filename>
+
+
+Description
+-----------
+
+1. When the command is triggered using the task-id and the testcase
+name provided the respective values are retrieved from the
+database (influxdb in this particular case).
+
+2. The values are then formatted and then provided to the html
+template framed with complete html body using Django Framework.
+
+3. Then the whole template is written into a html file.
+
+The graph is framed with Timestamp on x-axis and output values
+(differ from testcase to testcase) on y-axis with the help of
+"Highcharts".