diff options
| author |   Ana C <ana.cunha@ericsson.com> | 2015-09-29 09:41:53 +0200 |
|---|---|---|
| committer | Ana Cunha <ana.cunha@ericsson.com> | 2015-10-15 13:42:03 +0000 |
| commit | 4f92a322148f939ef38faac87e241f8a4060d128 (patch) | |
| tree | 37505c3c0cef9498a051e2b2713eb8953e81490f /docs/source/templates/testcase_description_template.rst | |
| parent | c967d7365e1256a257ceb9880caa02d6942dfad7 (diff) | |
Reorganize documentation in new structure
Remove the to-be-reorganized folder and reorganize
documentation in properly named subfolders.
Modified conf.py to reflect yardstick project name.
Modified index.rst with introduction about yardstick.
Templates were moved to new subfolder, no changes in
the content.
Jira:YARDSTICK-133
Change-Id: Iea5948733c57ff57eb946f44739b69d0e7291356
Signed-off-by: Ana C <ana.cunha@ericsson.com>
Diffstat (limited to 'docs/source/templates/testcase_description_template.rst')
| -rw-r--r-- | docs/source/templates/testcase_description_template.rst | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/docs/source/templates/testcase_description_template.rst b/docs/source/templates/testcase_description_template.rst new file mode 100644 index 000000000..899554dec --- /dev/null +++ b/docs/source/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 + + + |