summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/09-yardstick_user_interface.rst
diff options
context:
space:
mode:
authorJingLu5 <lvjing5@huawei.com>2017-03-30 11:50:02 +0000
committerJingLu5 <lvjing5@huawei.com>2017-03-30 11:50:02 +0000
commit0ce79677b81b47a7f66e43af896cfa9632da6bee (patch)
tree9164694450e17c4040d76257733c56579fd2185e /docs/testing/user/userguide/09-yardstick_user_interface.rst
parentf782757a1af7bddbcb2af9cebc33d4668ebb24f5 (diff)
add yardstick_user_interface chapter in userguide
JIRA: YARDSTICK-618 Change-Id: I690c24d665016a381ae1ed7d8fa94d5a34bc1b1b Signed-off-by: JingLu5 <lvjing5@huawei.com>
Diffstat (limited to 'docs/testing/user/userguide/09-yardstick_user_interface.rst')
-rw-r--r--docs/testing/user/userguide/09-yardstick_user_interface.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/09-yardstick_user_interface.rst b/docs/testing/user/userguide/09-yardstick_user_interface.rst
new file mode 100644
index 000000000..9058dd46d
--- /dev/null
+++ b/docs/testing/user/userguide/09-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".