summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/_testcase_description.rst
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-03 16:00:58 +0800
committerYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-03 16:06:09 +0800
commitfbf89b04f8ec8eed8ea905757dad4566c34786d8 (patch)
treec710299a499f199dc4650eef0d8080b79cdee6f0 /docs/testing/user/userguide/_testcase_description.rst
parent473deae9a10162f000c49ca49b4e31b28c4bf0d8 (diff)
Restructure docs
- Following the changes as in functest[1] since the guide[2] in wiki is a bit out of date - Some folders are empty for now as a placeholder Now: - release - release notes - testing - developer - design - overview - requirement - user - config guide - user guide - installation - scenarios [1]: https://gerrit.opnfv.org/gerrit/#/c/29151/ [2]: https://wiki.opnfv.org/display/DOC/Documentation+Guide Change-Id: I81b4597536c8bf02a925641d71d0969f6f5537f4 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs/testing/user/userguide/_testcase_description.rst')
-rw-r--r--docs/testing/user/userguide/_testcase_description.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/_testcase_description.rst b/docs/testing/user/userguide/_testcase_description.rst
new file mode 100644
index 00000000..d60ca949
--- /dev/null
+++ b/docs/testing/user/userguide/_testcase_description.rst
@@ -0,0 +1,46 @@
+.. 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.
+
+Test Case Description
+=====================
+
++-----------------------------------------------------------------------------+
+|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 |
++--------------+--------------------------------------------------------------+
+