docs/testplans/testplan-template.rst

   1 ..
   2  Key points to consider:
   3   * Use RST format. For help with syntax refer http://sphinx-doc.org/rest.html
   4   * Use http://rst.ninjs.org/ a web based WYSIWYG RST editor.
   5   * For diagrams, you can use http://asciiflow.com to make ascii diagrams.
   6   * MUST READ http://docs.opendaylight.org/en/latest/documentation.html and follow guidelines.
   7   * All sections should be retained, but can be marked None or N.A.
   8   * Set depth in ToC as per your doc requirements. Should be at least 2.
   9
  10 .. contents:: Table of Contents
  11       :depth: 3
  12
  13 ===================
  14 Title of Test Suite
  15 ===================
  16
  17 Brief introduction of the Test Suite and feature it is testing. This should include
  18 links to relevant documents and specs.
  19
  20 .. note::
  21
  22   Name of suite and test cases should map exactly to as they appear in Robot reports.
  23
  24
  25 Test Setup
  26 ==========
  27
  28 Brief description of test setup.
  29
  30 Testbed Topologies
  31 ------------------
  32
  33 Detailed information on testbed topologies, including topology diagrams. Each
  34 should be numbered so it can be referenced by number in Test Cases.
  35
  36 Default Topology
  37 ^^^^^^^^^^^^^^^^
  38
  39 .. literalinclude:: topologies/dummy-topology.txt
  40
  41
  42 Hardware Requirements
  43 ---------------------
  44
  45 Any specific hardware requirements e.g. SRIOV NICs.
  46
  47 Software Requirements
  48 ---------------------
  49
  50 Any specific software and version requirements e.g. Mininet, OVS 2.8 etc. This
  51 should also capture specific versions of OpenDaylight this suit applies to. e.g.
  52 Nitrogen, Nitrogen-SR2 etc. This will be used to determine to which jobs this suite
  53 can/should be added.
  54
  55 Test Suite Requirements
  56 =======================
  57
  58 Test Suite Bringup
  59 ------------------
  60
  61 Initial steps before any tests are run. This should include any cleanup, sanity checks,
  62 configuration etc. that needs to be done before test cases in suite are run. This should
  63 also capture if this suite depends on another suite to do bringup for it.
  64
  65 Test Suite Cleanup
  66 ------------------
  67
  68 Final steps after all tests in suite are done. This should include any cleanup, sanity checks,
  69 configuration etc. that needs to be done once all test cases in suite are done.
  70
  71 Debugging
  72 ---------
  73
  74 Capture any debugging information that is captured at start of suite and end of suite.
  75
  76
  77 Test Cases
  78 ==========
  79 This section should capture high level details about all the test cases part of the suite.
  80 Individual test cases should be subsections in the order they should be executed.
  81
  82 Test Case 1
  83 -----------
  84 Give a brief description of the test case including topology used if multiple specified
  85 in `Testbed Topologies`_.
  86
  87 Test Steps and Pass Criteria
  88 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  89 Step by step procedure of what is done as part of this test.
  90
  91 #. Step 1
  92
  93    #. Pass Criteria 1
  94    #. Pass Criteria 2
  95
  96 #. Step 2
  97
  98    #. Pass Criteria 1
  99    #. Pass Criteria 2
 100
 101
 102 Troubleshooting
 103 ^^^^^^^^^^^^^^^
 104 Any test specific information captured. Specifically mention if it is captured always,
 105 pass only or fail only.
 106
 107
 108 Implementation
 109 ==============
 110
 111 Assignee(s)
 112 -----------
 113 Who is contributing test cases? In case of multiple authors, designate a
 114 primary assignee and other contributors. Primary assignee is also expected to
 115 be maintainer once test code is in.
 116
 117 Primary assignee:
 118   <developer-a>
 119
 120 Other contributors:
 121   <developer-b>
 122   <developer-c>
 123
 124
 125 Work Items
 126 ----------
 127 Break up work into individual items. For most cases it would be just writing tests
 128 but in some cases will include changes to images, infra etc.
 129
 130
 131 Links
 132 -----
 133
 134 * Link to implementation patche(s) in CSIT
 135
 136
 137 References
 138 ==========
 139 Add any useful references. Some examples:
 140
 141 * Links to Summit presentation, discussion etc.
 142 * Links to mail list discussions
 143 * Links to patches in other projects
 144 * Links to external documentation
 145
 146 [1] `OpenDaylight Documentation Guide <http://docs.opendaylight.org/en/latest/documentation.html>`__
 147
 148 [2] https://specs.openstack.org/openstack/nova-specs/specs/kilo/template.html
 149
 150 .. note::
 151
 152   This template was derived from [2], and has been modified to support our project.
 153
 154   This work is licensed under a Creative Commons Attribution 3.0 Unported License.
 155   http://creativecommons.org/licenses/by/3.0/legalcode