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