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

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