summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/09-yardstick_user_interface.rst
diff options
context:
space:
mode:
authorJing Lu <lvjing5@huawei.com>2017-03-31 01:40:59 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-03-31 01:40:59 +0000
commitd5b878f30e731fbaff4f5f52f81c864ce7e21250 (patch)
tree406229dabd6db7221fca94a45ce577b7f9477fce /docs/testing/user/userguide/09-yardstick_user_interface.rst
parentc9b4860c5a9d27f0a8b70268c2f938b5481de821 (diff)
parent0ce79677b81b47a7f66e43af896cfa9632da6bee (diff)
Merge "add yardstick_user_interface chapter in userguide"
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".