docs/templates/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 |test case id  | e.g. OPNFV_YARDSTICK_TC001_NW Latency                        |
  14 +--------------+--------------------------------------------------------------+
  15 |metric        | what will be measured, e.g. latency                          |
  16 +--------------+--------------------------------------------------------------+
  17 |test purpose  | describe what is the purpose of the test case                |
  18 +--------------+--------------------------------------------------------------+
  19 |configuration | what .yaml file to use, state SLA if applicable, state       |
  20 |              | test duration, list and describe the scenario options used in|
  21 |              | this TC and also list the options using default values.      |
  22 +--------------+--------------------------------------------------------------+
  23 |test tool     | e.g. ping                                                    |
  24 +--------------+--------------------------------------------------------------+
  25 |references    | e.g. RFCxxx, ETSI-NFVyyy                                     |
  26 +--------------+--------------------------------------------------------------+
  27 |applicability | describe variations of the test case which can be            |
  28 |              | performend, e.g. run the test for different packet sizes     |
  29 +--------------+--------------------------------------------------------------+
  30 |pre-test      | describe configuration in the tool(s) used to perform        |
  31 |conditions    | the measurements (e.g. fio, pktgen), POD-specific            |
  32 |              | configuration required to enable running the test            |
  33 +--------------+------+----------------------------------+--------------------+
  34 |test sequence | step | description                      | result             |
  35 |              +------+----------------------------------+--------------------+
  36 |              |  1   | use this to describe tests that  | what happens in    |
  37 |              |      | require several steps e.g.       | this step          |
  38 |              |      | step 1 collect logs              | e.g. logs collected|
  39 |              +------+----------------------------------+--------------------+
  40 |              |  2   | remove interface                 | interface down     |
  41 |              +------+----------------------------------+--------------------+
  42 |              |  N   | what is done in step N           | what happens       |
  43 +--------------+------+----------------------------------+--------------------+
  44 |test verdict  | expected behavior, or SLA, pass/fail criteria                |
  45 +--------------+--------------------------------------------------------------+