diff options
| author |   Fatih Degirmenci <fatih.degirmenci@ericsson.com> | 2015-12-03 14:13:16 +0100 |
|---|---|---|
| committer | Fatih Degirmenci <fatih.degirmenci@ericsson.com> | 2015-12-03 14:18:00 +0100 |
| commit | bd3d1c0ebdc2ed8e9918b7e462a6994468a46d0a (patch) | |
| tree | e56edd70b285383bf107316663f669cc2a570a12 /docs/templates/testcase_description_v2_template.rst | |
| parent | 2f7f80ef210977f4ca30056fc9852b8ea4242cca (diff) | |
Remove etc and source folder from yardstick documentation
conf.py and logo will come from releng which is common for all projects.
The directory structure in docs folder has not been decided yet so this
change does not require you to change your current way of working.
Once this directory structure is decided by opnfvdocs and releng, the changes
need to be reflected back to all projects, including yardstick.
Change-Id: If0558474a819f4a44e34f790d26c5486751b8266
Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
Diffstat (limited to 'docs/templates/testcase_description_v2_template.rst')
| -rw-r--r-- | docs/templates/testcase_description_v2_template.rst | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/templates/testcase_description_v2_template.rst b/docs/templates/testcase_description_v2_template.rst new file mode 100644 index 000000000..0fa2359e9 --- /dev/null +++ b/docs/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 | ++--------------+--------------------------------------------------------------+ |