docs/templates/test_results_template.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 ..
   6    Convention for heading levels in Yardstick documentation:
   7
   8    =======  Heading 0 (reserved for the title in a document)
   9    -------  Heading 1
  10    ~~~~~~~  Heading 2
  11    +++++++  Heading 3
  12    '''''''  Heading 4
  13
  14    Avoid deeper levels because they do not render well.
  15
  16 =====================
  17 Yardstick Test Report
  18 =====================
  19
  20 .. This document is based on IEEE Std 829-2008. "Standard for Software and
  21    System Test Documentation
  22
  23 .. contents:: Table of Contents
  24    :depth: 3
  25
  26 Introduction
  27 ============
  28
  29 Document Identifier
  30 -------------------
  31
  32 Scope
  33 -----
  34
  35 This document provides an overview of the results of test cases developed by
  36 the OPNFV Yardstick Project, executed on OPNFV community labs.
  37
  38 OPNFV Continous Integration provides automated build, deploy and testing for
  39 the software developed in OPNFV. Unless stated, the reported tests are
  40 automated via Jenkins Jobs.
  41
  42 Test results are visible in the following dashboards:
  43
  44 * *Testing dashboard*: uses Mongo DB to store test results and Bitergia for
  45   visualization
  46
  47 * *Yardstick Dashboard*: prototyped by Yardstick, uses influx DB to store test
  48   results and Grafana for visualization
  49
  50 References
  51 ----------
  52
  53 .. to be added
  54
  55 Details
  56 =======
  57
  58 TCXXX
  59 -----
  60 .. add the four sections below for each Test Case in the daily test suite or
  61    on-demand test cases (HA, KVM, Parser)
  62
  63 * Overview of test results
  64 .. general on metrics collected, number of iterations
  65
  66 * Detailed test results
  67 .. info on lab, installer, scenario
  68
  69 * Rationale for decisions
  70 .. pass/fail
  71
  72 * Conclusions and recommendations
  73 .. did the expected behavior occured?
  74
  75 General
  76 =======
  77
  78 Glossary
  79 --------
  80
  81 .. add link to yardstick glossary
  82
  83 Document change procedures and history
  84 --------------------------------------
  85
  86 .. add release date info, approval