diff options
| author |   Ana C <ana.cunha@ericsson.com> | 2015-09-30 13:49:44 +0200 |
|---|---|---|
| committer | Ana Cunha <ana.cunha@ericsson.com> | 2015-10-23 10:34:47 +0000 |
| commit | 884926d05f435217c7dac038b3bfbd7e9d05826b (patch) | |
| tree | cc877ac536c9c21ded9277526fd65822fe0f4828 /docs/source/templates/testcase_description_v2_template.rst | |
| parent | 76e23b1dd6ac664846ffa04ab27c021bd4e5b12f (diff) | |
Add updated version for template
This patch adds a second version for the template for test case
description, in table format.
Minor updates in the original version, opnfv logo added.
Jira:YARDSTICK-2
Change-Id: Ia9b2ba9c237d0ce8493e512663f95b73df210175
Signed-off-by: Ana C <ana.cunha@ericsson.com>
Diffstat (limited to 'docs/source/templates/testcase_description_v2_template.rst')
| -rw-r--r-- | docs/source/templates/testcase_description_v2_template.rst | 51 |
1 files changed, 51 insertions, 0 deletions
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 | ++--------------+--------------------------------------------------------------+ |