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

   1 ========================
   2 Yardstick User Interface
   3 ========================
   4
   5 This chapter describes how to generate HTML reports, used to view, store, share
   6 or publish test results in table and graph formats.
   7
   8 The following layouts are available:
   9
  10 * The compact HTML report layout is suitable for testcases producing a few
  11   metrics over a short period of time. All metrics for all timestamps are
  12   displayed in the data table and on the graph.
  13
  14 * The dynamic HTML report layout consists of a wider data table, a graph, and
  15   a tree that allows selecting the metrics to be displayed. This layout is
  16   suitable for testcases, such as NSB ones, producing a lot of metrics over
  17   a longer period of time.
  18
  19
  20 Commands
  21 ========
  22
  23 To generate the compact HTML report, run::
  24
  25     yardstick report generate <task-ID> <testcase-filename>
  26
  27 To generate the dynamic HTML report, run::
  28
  29     yardstick report generate-nsb <task-ID> <testcase-filename>
  30
  31
  32 Description
  33 ===========
  34
  35 1. When the command is triggered, the relevant values for the
  36    provided task-id and testcase name are retrieved from the
  37    database (`InfluxDB`_ in this particular case).
  38
  39 2. The values are then formatted and provided to the html
  40    template to be rendered using `Jinja2`_.
  41
  42 3. Then the rendered template is written into a html file.
  43
  44 The graph is framed with Timestamp on x-axis and output values
  45 (differ from testcase to testcase) on y-axis with the help of
  46 `Chart.js`_.
  47
  48 .. _InfluxDB: https://www.influxdata.com/time-series-platform/influxdb/
  49 .. _Jinja2: http://jinja.pocoo.org/docs/2.10/
  50 .. _Chart.js: https://www.chartjs.org/