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 *************************************
7 Yardstick Test Case Description TCXXX
8 *************************************
10 +-----------------------------------------------------------------------------+
11 |test case slogan e.g. Network Latency |
13 +--------------+--------------------------------------------------------------+
14 |test case id | e.g. OPNFV_YARDSTICK_TC001_NW Latency |
16 +--------------+--------------------------------------------------------------+
17 |metric | what will be measured, e.g. latency |
19 +--------------+--------------------------------------------------------------+
20 |test purpose | describe what is the purpose of the test case |
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. |
27 +--------------+--------------------------------------------------------------+
28 |test tool | e.g. ping |
30 +--------------+--------------------------------------------------------------+
31 |references | e.g. RFCxxx, ETSI-NFVyyy |
33 +--------------+--------------------------------------------------------------+
34 |applicability | describe variations of the test case which can be |
35 | | performend, e.g. run the test for different packet sizes |
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 |
42 +--------------+--------------------------------------------------------------+
43 |test sequence | description and expected result |
45 +--------------+--------------------------------------------------------------+
46 |step 1 | use this to describe tests that require sveveral steps e.g |
49 | | Result: what happens in this step e.g. logs collected |
51 +--------------+--------------------------------------------------------------+
52 |step 2 | remove interface |
54 | | Result: interface down. |
56 +--------------+--------------------------------------------------------------+
57 |step N | what is done in step N |
59 | | Result: what happens |
61 +--------------+--------------------------------------------------------------+
62 |test verdict | expected behavior, or SLA, pass/fail criteria |
64 +--------------+--------------------------------------------------------------+