diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/templates/testcase_description_template.rst | 22 | ||||
| -rw-r--r-- | docs/source/templates/testcase_description_v2_template.rst | 51 |
2 files changed, 65 insertions, 8 deletions
diff --git a/docs/source/templates/testcase_description_template.rst b/docs/source/templates/testcase_description_template.rst index 899554dec..1651d360c 100644 --- a/docs/source/templates/testcase_description_template.rst +++ b/docs/source/templates/testcase_description_template.rst @@ -1,7 +1,13 @@ -.. NOTE:: - Template to be used for test case descriptions in Yardstick Project. +.. Template to be used for test case descriptions in Yardstick Project. Write one .rst per test case. - Upload the .rst for the test case in /docs directory. Review in Gerrit. + Upload the .rst for the test case in /docs/source/yardstick directory. + Review in Gerrit. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left ****************** Test Case <slogan> @@ -63,9 +69,12 @@ Configuration State the .yaml file to use. -State default configuration in the tool(s) used to perform the measurements (e.g. fio, pktgen). +State default configuration in the tool(s) used to perform the measurements +(e.g. fio, pktgen). + +State what POD-specific configuration is required to enable running the test +case in different PODs. -State what POD-specific configuration is required to enable running the test case in different PODs. State SLA, if applicable. @@ -83,6 +92,3 @@ State applicable graphical presentation State applicable output details State expected Value, behavior, pass/fail criteria - - - diff --git a/docs/source/templates/testcase_description_v2_template.rst b/docs/source/templates/testcase_description_v2_template.rst new file mode 100644 index 000000000..0fa2359e9 --- /dev/null +++ b/docs/source/templates/testcase_description_v2_template.rst @@ -0,0 +1,51 @@ +.. Template to be used for test case descriptions in Yardstick Project. + Write one .rst per test case. + Upload the .rst for the test case in /docs/source/yardstick directory. + Review in Gerrit. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +************************************* +Yardstick Test Case Description TCXXX +************************************* + ++-----------------------------------------------------------------------------+ +|test case slogan e.g. Network Latency | ++==============+==============================================================+ +|test case id | e.g. OPNFV_YARDSTICK_TC001_NW Latency | ++--------------+--------------------------------------------------------------+ +|metric | what will be measured, e.g. latency | ++--------------+--------------------------------------------------------------+ +|test purpose | describe what is the purpose of the test case | ++--------------+--------------------------------------------------------------+ +|configuration | what .yaml file to use, state SLA if applicable, state | +| | test duration, list and describe the scenario options used in| +| | this TC and also list the options using default values. | ++--------------+--------------------------------------------------------------+ +|test tool | e.g. ping | ++--------------+--------------------------------------------------------------+ +|references | e.g. RFCxxx, ETSI-NFVyyy | ++--------------+--------------------------------------------------------------+ +|applicability | describe variations of the test case which can be | +| | performend, e.g. run the test for different packet sizes | ++--------------+--------------------------------------------------------------+ +|pre-test | describe configuration in the tool(s) used to perform | +|conditions | the measurements (e.g. fio, pktgen), POD-specific | +| | configuration required to enable running the test | ++--------------+------+----------------------------------+--------------------+ +|test sequence | step | description | result | +| +------+----------------------------------+--------------------+ +| | 1 | use this to describe tests that | what happens in | +| | | require several steps e.g. | this step | +| | | step 1 collect logs | e.g. logs collected| +| +------+----------------------------------+--------------------+ +| | 2 | remove interface | interface down | +| +------+----------------------------------+--------------------+ +| | N | what is done in step N | what happens | ++--------------+------+----------------------------------+--------------------+ +|test verdict | expected behavior, or SLA, pass/fail criteria | ++--------------+--------------------------------------------------------------+ |