diff options
| author |   Yujun Zhang <zhang.yujunz@zte.com.cn> | 2016-10-18 14:45:01 +0800 |
|---|---|---|
| committer | Yujun Zhang <zhang.yujunz@zte.com.cn> | 2016-10-18 14:45:01 +0800 |
| commit | fc7bfe32ca05a9fa70e49cd7b1571940d9320d2c (patch) | |
| tree | f695c3bb76a93d7cb3f50d59749389a7df1dc551 /docs/templates/testcase_description_v2_template.rst | |
| parent | c65405d9073cc92fbab5485089cd962a0638d8ac (diff) | |
Reorganize existing documents
- Align document structure with Colorado release
- follow convention used in "Python’s Style Guide for documentating"[1]
[1] https://docs.python.org/devguide/documenting.html#sections
Change-Id: Idee6ad6e68a35e3fd84ec36de480722e0259011b
JIRA: QTIP-117
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs/templates/testcase_description_v2_template.rst')
| -rw-r--r-- | docs/templates/testcase_description_v2_template.rst | 47 |
1 files changed, 0 insertions, 47 deletions
diff --git a/docs/templates/testcase_description_v2_template.rst b/docs/templates/testcase_description_v2_template.rst deleted file mode 100644 index d68509f8..00000000 --- a/docs/templates/testcase_description_v2_template.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. Template to be used for test case descriptions in QTIP Project. - Write one .rst per test case. - Borrowed Heavily from Yardstick - Upload the .rst for the test case in /docs/ directory. - Review in Gerrit. - -************************************* -QTIP Test Case Description TCXXX -************************************* - -+-----------------------------------------------------------------------------+ -|test case slogan e.g. Network throughput | -+==============+==============================================================+ -|test case id | e.g. qtip_throughput | -+--------------+--------------------------------------------------------------+ -|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 | -+--------------+--------------------------------------------------------------+ - |