docs/templates/test_results_template.rst

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