Merge "Make OvS max_idle & queues configuration optional"
[yardstick.git] / docs / testing / user / userguide / opnfv_yardstick_tc052.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International
2 .. License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) OPNFV, Yin Kanglin and others.
5 .. 14_ykl@tongji.edu.cn
6
7 *************************************
8 Yardstick Test Case Description TC052
9 *************************************
10
11 +-----------------------------------------------------------------------------+
12 |OpenStack Controller Node Disk I/O Block High Availability                   |
13 |                                                                             |
14 +--------------+--------------------------------------------------------------+
15 |test case id  | OPNFV_YARDSTICK_TC052: OpenStack Controller Node Disk I/O    |
16 |              | Block High Availability                                      |
17 +--------------+--------------------------------------------------------------+
18 |test purpose  | This test case will verify the high availability of control  |
19 |              | node. When the disk I/O of a specified disk is blocked,      |
20 |              | which breaks down the Openstack services on this node. Read  |
21 |              | and write services should still be accessed by other         |
22 |              | controller nodes, and the services on failed controller node |
23 |              | should be isolated.                                          |
24 +--------------+--------------------------------------------------------------+
25 |test method   | This test case blocks the disk I/O of a specified control    |
26 |              | node, then checks whether the services that need to read or  |
27 |              | wirte the disk of the control node are OK with some monitor  |
28 |              | tools.                                                       |
29 +--------------+--------------------------------------------------------------+
30 |attackers     | In this test case, an attacker called "disk-block" is        |
31 |              | needed. This attacker includes two parameters:               |
32 |              | 1) fault_type: which is used for finding the attacker's      |
33 |              | scripts. It should be always set to "disk-block" in this     |
34 |              | test case.                                                   |
35 |              | 2) host: which is the name of a control node being attacked. |
36 |              | e.g.                                                         |
37 |              | -fault_type: "disk-block"                                    |
38 |              | -host: node1                                                 |
39 +--------------+--------------------------------------------------------------+
40 |monitors      | In this test case, two kinds of monitor are needed:          |
41 |              | 1. the "openstack-cmd" monitor constantly request a specific |
42 |              | Openstack command, which needs two parameters:               |
43 |              | 1) monitor_type: which is used for finding the monitor class |
44 |              | and related scripts. It should be always set to              |
45 |              | "openstack-cmd" for this monitor.                            |
46 |              | 2) command_name: which is the command name used for request. |
47 |              |                                                              |
48 |              | e.g.                                                         |
49 |              | -monitor_type: "openstack-cmd"                               |
50 |              | -command_name: "nova flavor-list"                            |
51 |              |                                                              |
52 |              | 2. the second monitor verifies the read and write function   |
53 |              | by a "operation" and a "result checker".                     |
54 |              | the "operation" have two parameters:                         |
55 |              | 1) operation_type: which is used for finding the operation   |
56 |              | class and related scripts.                                   |
57 |              | 2) action_parameter: parameters for the operation.           |
58 |              | the "result checker" have three parameters:                  |
59 |              | 1) checker_type: which is used for finding the reuslt        |
60 |              | checker class and realted scripts.                           |
61 |              | 2) expectedValue: the expected value for the output of the   |
62 |              | checker script.                                              |
63 |              | 3) condition: whether the expected value is in the output of |
64 |              | checker script or is totally same with the output.           |
65 |              |                                                              |
66 |              | In this case, the "operation" adds a flavor and the "result  |
67 |              | checker" checks whether ths flavor is created. Their         |
68 |              | parameters show as follows::                                 |
69 |              |                                                              |
70 |              |   operation:                                                 |
71 |              |   -operation_type: "nova-create-flavor"                      |
72 |              |   -action_parameter:                                         |
73 |              |      flavorconfig: "test-001 test-001 100 1 1"               |
74 |              |   result checker:                                            |
75 |              |   -checker_type: "check-flavor"                              |
76 |              |   -expectedValue: "test-001"                                 |
77 |              |   -condition: "in"                                           |
78 +--------------+--------------------------------------------------------------+
79 |metrics       | In this test case, there is one metric:                      |
80 |              | 1)service_outage_time: which indicates the maximum outage    |
81 |              | time (seconds) of the specified Openstack command request.   |
82 +--------------+--------------------------------------------------------------+
83 |test tool     | Developed by the project. Please see folder:                 |
84 |              | "yardstick/benchmark/scenarios/availability/ha_tools"        |
85 |              |                                                              |
86 +--------------+--------------------------------------------------------------+
87 |references    | ETSI NFV REL001                                              |
88 |              |                                                              |
89 +--------------+--------------------------------------------------------------+
90 |configuration | This test case needs two configuration files:                |
91 |              | 1) test case file: opnfv_yardstick_tc052.yaml                |
92 |              | -Attackers: see above "attackers" discription                |
93 |              | -waiting_time: which is the time (seconds) from the process  |
94 |              | being killed to stoping monitors the monitors                |
95 |              | -Monitors: see above "monitors" discription                  |
96 |              | -SLA: see above "metrics" discription                        |
97 |              |                                                              |
98 |              | 2)POD file: pod.yaml                                         |
99 |              | The POD configuration should record on pod.yaml first.       |
100 |              | the "host" item in this test case will use the node name in  |
101 |              | the pod.yaml.                                                |
102 |              |                                                              |
103 +--------------+--------------------------------------------------------------+
104 |test sequence | description and expected result                              |
105 |              |                                                              |
106 +--------------+--------------------------------------------------------------+
107 |step 1        | do attacker: connect the host through SSH, and then execute  |
108 |              | the block disk I/O script on the host.                       |
109 |              |                                                              |
110 |              | Result: The disk I/O of the host will be blocked             |
111 |              |                                                              |
112 +--------------+--------------------------------------------------------------+
113 |step 2        | start monitors:                                              |
114 |              | each monitor will run with independently process             |
115 |              |                                                              |
116 |              | Result: The monitor info will be collected.                  |
117 |              |                                                              |
118 +--------------+--------------------------------------------------------------+
119 |step 3        | do operation: add a flavor                                   |
120 |              |                                                              |
121 +--------------+--------------------------------------------------------------+
122 |step 4        | do result checker: check whether the falvor is created       |
123 |              |                                                              |
124 +--------------+--------------------------------------------------------------+
125 |step 5        | stop monitors after a period of time specified by            |
126 |              | "waiting_time"                                               |
127 |              |                                                              |
128 |              | Result: The monitor info will be aggregated.                 |
129 |              |                                                              |
130 +--------------+--------------------------------------------------------------+
131 |step 6        | verify the SLA                                               |
132 |              |                                                              |
133 |              | Result: The test case is passed or not.                      |
134 |              |                                                              |
135 +--------------+--------------------------------------------------------------+
136 |post-action   | It is the action when the test cases exist. It excutes the   |
137 |              | release disk I/O script to release the blocked I/O.          |
138 +--------------+--------------------------------------------------------------+
139 |test verdict  | Fails if monnitor SLA is not passed or the result checker is |
140 |              | not passed, or if there is a test case execution problem.    |
141 |              |                                                              |
142 +--------------+--------------------------------------------------------------+