From 85b579d153aa713e1b89faa7fcfa7a9a934829ad Mon Sep 17 00:00:00 2001 From: Lincoln Lavoie Date: Wed, 24 Feb 2016 17:34:06 -0500 Subject: Initial test plan structure for Brahmaputra Created the initial structure for the plugfest test plan. * Created a base directory and document structure * Created contributor guidelines * Created test case template * adjusted for: http://artifacts.opnfv.org/releng/docs/how-to-use-docs/documentation-example.html * cp: reformatted the directories and structure to use the RST format * (we cannot review odt format in our toolchain, so use rst) * cp: added an index.rst structure to establish structure without numbering * cp: will ad anothe job to include dovetail in the docs toolchain Change-Id: I4ef997da51b3b85e391629d6e08fadf87257fc6a --- docs/plugfest_test_plan/templates/template.rst | 38 ++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/plugfest_test_plan/templates/template.rst (limited to 'docs/plugfest_test_plan/templates') diff --git a/docs/plugfest_test_plan/templates/template.rst b/docs/plugfest_test_plan/templates/template.rst new file mode 100644 index 00000000..6c655cca --- /dev/null +++ b/docs/plugfest_test_plan/templates/template.rst @@ -0,0 +1,38 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Test case title +--------------- + +Purpose +^^^^^^^ + +Description of the intended purpose of the test case. +Purpose may also describe the cause/need of the test case, +such as, describing a specific high availability failover cause. + +References +^^^^^^^^^^ + +Pointer to specific reference in standard, architecture, or other documentation. + +Test Setup +^^^^^^^^^^ + +1. List of equipment or software specific to this test case. +2. List of steps required to prepare the devices / network for testing. +3. These steps need to be performed only once. + +Method of Procedure +^^^^^^^^^^^^^^^^^^^ + +1. List of steps to perform the actual test case +2. These steps might be performed multiple times, if a retest is required. + +Expected Results +^^^^^^^^^^^^^^^^ + +1. List of specific results expected from the procedure. +2. These results / test metrics are used to indicate the pass/fail status for the test case. +3. To pass a test case, it all individual metrics would be expected to “pass.” + -- cgit 1.2.3-korg