summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAna C <ana.cunha@ericsson.com>2016-01-13 18:43:13 +0100
committerAna Cunha <ana.cunha@ericsson.com>2016-01-14 12:15:57 +0000
commitf863a281b86ae8c9127da71aa7083cf8b6010bc6 (patch)
tree30da5ef614ea90be79086b7aafb907a77ffebd7f /docs
parentb356331917be4a05dc3363b6e8aba7af340fc376 (diff)
Add template for test results report
This change is a proposal for a report for yardstick test case reesults. One report for all the executed tests, summarizing the results and the labs where the tests were executed. JIRA: - Change-Id: I7cdfdc82d6ee07d2b9da426f33ce34b86362b5b4 Signed-off-by: Ana C <ana.cunha@ericsson.com> (cherry picked from commit 3871a2c4f61b1da9a8512135bf0cf6e9e35d7e8d)
Diffstat (limited to 'docs')
-rw-r--r--docs/templates/test_results_template.rst71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/templates/test_results_template.rst b/docs/templates/test_results_template.rst
new file mode 100644
index 000000000..f04b2b2a8
--- /dev/null
+++ b/docs/templates/test_results_template.rst
@@ -0,0 +1,71 @@
+=====================
+Yardstick Test Report
+=====================
+
+.. This document is based on IEEE Std 829-2008. "Standard for Software and
+ System Test Documentation
+
+.. contents:: Table of Contents
+ :depth: 3
+
+Introduction
+============
+
+Document Identifier
+-------------------
+
+Scope
+-----
+
+This document provides an overview of the results of test cases developed by
+the OPNFV Yardstick Project, executed on OPNFV community labs.
+
+OPNFV Continous Integration provides automated build, deploy and testing for
+the software developed in OPNFV. Unless stated, the reported tests are
+automated via Jenkins Jobs.
+
+Test results are visible in the following dashboards:
+
+* *Testing dashboard*: uses Mongo DB to store test results and Bitergia for
+ visualization
+
+* *Yardstick Dashboard*: prototyped by Yardstick, uses influx DB to store test
+ results and Grafana for visualization
+
+References
+----------
+
+.. to be added
+
+Details
+=======
+
+TCXXX
+-----
+.. add the four sections below for each Test Case in the daily test suite or
+ on-demand test cases (HA, KVM, Parser)
+
+* Overview of test results
+.. general on metrics collected, number of iterations
+
+* Detailed test results
+.. info on lab, installer, scenario
+
+* Rationale for decisions
+.. pass/fail
+
+* Conclusions and recommendations
+.. did the expected behavior occured?
+
+General
+=======
+
+Glossary
+--------
+
+.. add link to yardstick glossary
+
+Document change procedures and history
+--------------------------------------
+
+.. add release date info, approval