diff options
| author |   Ana C <ana.cunha@ericsson.com> | 2015-07-14 11:13:31 +0200 |
|---|---|---|
| committer | Ana C <ana.cunha@ericsson.com> | 2015-07-15 08:54:09 +0000 |
| commit | 621beb47d49adc35a40c51ecb1aaa0dc5d438900 (patch) | |
| tree | 1d6037bf22c68effaf006c09c5ca778aae189ba7 /docs/templates/testcase_description_template.rst | |
| parent | 000629048649d5be39790dbd6a35e4bb6918c949 (diff) | |
Add test case description template
Template states mandatory information for each
test case to be delivered by Yardstick Project.
JIRA: YARDSTICK-2
Change-Id: I16b98acc6689e24f8e6a85c356ee1b8991bd5276
Signed-off-by: Ana C <ana.cunha@ericsson.com>
Diffstat (limited to 'docs/templates/testcase_description_template.rst')
| -rw-r--r-- | docs/templates/testcase_description_template.rst | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/docs/templates/testcase_description_template.rst b/docs/templates/testcase_description_template.rst new file mode 100644 index 000000000..899554dec --- /dev/null +++ b/docs/templates/testcase_description_template.rst @@ -0,0 +1,88 @@ +.. NOTE:: + 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. + +****************** +Test Case <slogan> +****************** + +.. contents:: Table of Contents + :depth: 3 + +--------------------- +Test Case Description +--------------------- + +Yardstick Test Case ID +---------------------- + +OPNFV_YARDSTICK_TC<abc>_<slogan> + +where: + - <abc>: check Jira issue for the test case + - <slogan>: check Jira issue for the test case + + +Purpose +------- + +Describe what is the purpose of the test case + +Area +---- + +State the area and sub-area covered by the test case. + +Areas: Compute, Networking, Storage + +Sub-areas: Performance, System limit, QoS + +Metrics +------- + +What will be measured, attribute name or collection of attributes, behavior + +References +---------- + +Reference documentation + +-------------- +Pre-requisites +-------------- + +Tools +----- + +What tools are used to perform the measurements (e.g. fio, pktgen) + + +Configuration +------------- + +State the .yaml file to use. + +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 SLA, if applicable. + +State test duration. + +------- +Results +------- + +Expected outcome +---------------- + +State applicable graphical presentation + +State applicable output details + +State expected Value, behavior, pass/fail criteria + + + |