summaryrefslogtreecommitdiffstats
path: root/docs/templates/testcase_description_template.rst
blob: 1651d360c944a2415bbcd3a8c782abf8910feb7a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
.. 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

******************
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