docs/source/templates/testcase_description_template.rst

   1 .. NOTE::
   2    Template to be used for test case descriptions in Yardstick Project.
   3    Write one .rst per test case.
   4    Upload the .rst for the test case in /docs directory. Review in Gerrit.
   5
   6 ******************
   7 Test Case <slogan>
   8 ******************
   9
  10 .. contents:: Table of Contents
  11    :depth: 3
  12
  13 ---------------------
  14 Test Case Description
  15 ---------------------
  16
  17 Yardstick Test Case ID
  18 ----------------------
  19
  20 OPNFV_YARDSTICK_TC<abc>_<slogan>
  21
  22 where:
  23     - <abc>: check Jira issue for the test case
  24     - <slogan>: check Jira issue for the test case
  25
  26
  27 Purpose
  28 -------
  29
  30 Describe what is the purpose of the test case
  31
  32 Area
  33 ----
  34
  35 State the area and sub-area covered by the test case.
  36
  37 Areas: Compute, Networking, Storage
  38
  39 Sub-areas: Performance, System limit, QoS
  40
  41 Metrics
  42 -------
  43
  44 What will be measured, attribute name or collection of attributes, behavior
  45
  46 References
  47 ----------
  48
  49 Reference documentation
  50
  51 --------------
  52 Pre-requisites
  53 --------------
  54
  55 Tools
  56 -----
  57
  58 What tools are used to perform the measurements (e.g. fio, pktgen)
  59
  60
  61 Configuration
  62 -------------
  63
  64 State the .yaml file to use.
  65
  66 State default configuration in the tool(s) used to perform the measurements (e.g. fio, pktgen).
  67
  68 State what POD-specific configuration is required to enable running the test case in different PODs.
  69
  70 State SLA, if applicable.
  71
  72 State test duration.
  73
  74 -------
  75 Results
  76 -------
  77
  78 Expected outcome
  79 ----------------
  80
  81 State applicable graphical presentation
  82
  83 State applicable output details
  84
  85 State expected Value, behavior, pass/fail criteria
  86
  87
  88