docs/yardstick/testcase_description_v2_template.rst

   1 .. Template to be used for test case descriptions in Yardstick Project.
   2    Write one .rst per test case.
   3    Upload the .rst for the test case in /docs/source/yardstick directory.
   4    Review in Gerrit.
   5
   6 *************************************
   7 Yardstick Test Case Description TCXXX
   8 *************************************
   9
  10 +-----------------------------------------------------------------------------+
  11 |test case slogan e.g. Network Latency                                        |
  12 |                                                                             |
  13 +--------------+--------------------------------------------------------------+
  14 |test case id  | e.g. OPNFV_YARDSTICK_TC001_NW Latency                        |
  15 |              |                                                              |
  16 +--------------+--------------------------------------------------------------+
  17 |metric        | what will be measured, e.g. latency                          |
  18 |              |                                                              |
  19 +--------------+--------------------------------------------------------------+
  20 |test purpose  | describe what is the purpose of the test case                |
  21 |              |                                                              |
  22 +--------------+--------------------------------------------------------------+
  23 |configuration | what .yaml file to use, state SLA if applicable, state       |
  24 |              | test duration, list and describe the scenario options used in|
  25 |              | this TC and also list the options using default values.      |
  26 |              |                                                              |
  27 +--------------+--------------------------------------------------------------+
  28 |test tool     | e.g. ping                                                    |
  29 |              |                                                              |
  30 +--------------+--------------------------------------------------------------+
  31 |references    | e.g. RFCxxx, ETSI-NFVyyy                                     |
  32 |              |                                                              |
  33 +--------------+--------------------------------------------------------------+
  34 |applicability | describe variations of the test case which can be            |
  35 |              | performend, e.g. run the test for different packet sizes     |
  36 |              |                                                              |
  37 +--------------+--------------------------------------------------------------+
  38 |pre-test      | describe configuration in the tool(s) used to perform        |
  39 |conditions    | the measurements (e.g. fio, pktgen), POD-specific            |
  40 |              | configuration required to enable running the test            |
  41 |              |                                                              |
  42 +--------------+--------------------------------------------------------------+
  43 |test sequence | description and expected result                              |
  44 |              |                                                              |
  45 +--------------+--------------------------------------------------------------+
  46 |step 1        | use this to describe tests that require sveveral steps e.g   |
  47 |              | collect logs.                                                |
  48 |              |                                                              |
  49 |              | Result: what happens in this step e.g. logs collected        |
  50 |              |                                                              |
  51 +--------------+--------------------------------------------------------------+
  52 |step 2        | remove interface                                             |
  53 |              |                                                              |
  54 |              | Result: interface down.                                      |
  55 |              |                                                              |
  56 +--------------+--------------------------------------------------------------+
  57 |step N        | what is done in step N                                       |
  58 |              |                                                              |
  59 |              | Result: what happens                                         |
  60 |              |                                                              |
  61 +--------------+--------------------------------------------------------------+
  62 |test verdict  | expected behavior, or SLA, pass/fail criteria                |
  63 |              |                                                              |
  64 +--------------+--------------------------------------------------------------+