summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide
diff options
context:
space:
mode:
authorJing Lu <lvjing5@huawei.com>2017-03-22 09:04:15 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-03-22 09:04:15 +0000
commit2eca6808f3750633a0ab265a027fc9941ff1eafc (patch)
tree3d88bc097c1bbf96035eeb12e61258a2651122c7 /docs/testing/user/userguide
parent78e2b978507589a5254b9dcdcf03f6a0df8a8143 (diff)
parent25b21add71fcf7c2c795bd950b5117d69fac68fb (diff)
Merge "Yardstick: User interface for Yardstick."
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".