docs/testing/user/userguide/10-yardstick-user-interface.rst

   1 ========================
   2 Yardstick User Interface
   3 ========================
   4
   5 This interface provides a user to view the test result
   6 in table format and also values pinned on to a graph.
   7
   8
   9 Command
  10 =======
  11 ::
  12
  13     yardstick report generate <task-ID> <testcase-filename>
  14
  15
  16 Description
  17 ===========
  18
  19 1. When the command is triggered, the relevant values for the
  20    provided task-id and testcase name are retrieved from the
  21    database (`InfluxDB`_ in this particular case).
  22
  23 2. The values are then formatted and provided to the html
  24    template to be rendered using `Jinja2`_.
  25
  26 3. Then the rendered template is written into a html file.
  27
  28 The graph is framed with Timestamp on x-axis and output values
  29 (differ from testcase to testcase) on y-axis with the help of
  30 `Highcharts`_.
  31
  32 .. _InfluxDB: https://www.influxdata.com/time-series-platform/influxdb/
  33 .. _Jinja2: http://jinja.pocoo.org/docs/2.10/
  34 .. _Highcharts: https://www.highcharts.com/products/highcharts/