2 Library RequestsLibrary
5 Library ClusterStateLibrary.py
6 Library ./HsfJson/hsf_json.py
10 ${jolokia_conf} /jolokia/read/org.opendaylight.controller:Category=ShardManager,name=shard-manager-config,type=DistributedConfigDatastore
11 ${jolokia_oper} /jolokia/read/org.opendaylight.controller:Category=ShardManager,name=shard-manager-operational,type=DistributedOperationalDatastore
12 ${jolokia_read} /jolokia/read/org.opendaylight.controller
15 Create Controller Index List
16 [Documentation] Reads number of controllers and returns a list with all controllers indexes.
17 ${controller_index_list} Create List
18 ${NUM_ODL_SYSTEM}= Convert to Integer ${NUM_ODL_SYSTEM}
19 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
20 \ Append To List ${controller_index_list} ${i+1}
21 [Return] ${controller_index_list}
23 Create Controller Sessions
24 [Documentation] Creates REST session to all controller instances.
25 ${NUM_ODL_SYSTEM}= Convert to Integer ${NUM_ODL_SYSTEM}
26 : FOR ${i} IN RANGE ${NUM_ODL_SYSTEM}
27 \ Log Create Session ${ODL_SYSTEM_${i+1}_IP}
28 \ Create Session controller${i+1} http://${ODL_SYSTEM_${i+1}_IP}:${RESTCONFPORT} auth=${AUTH}
30 Get Cluster Shard Status
31 [Arguments] ${controller_index_list} ${shard_type} ${shard}
32 [Documentation] Checks ${shard} status and returns Leader index and a list of Followers from a ${controller_index_list}.
33 ... ${shard_type} is either config or operational.
34 ${lenght}= Get Length ${controller_index_list}
35 Run Keyword If '${shard_type}' == 'config' Set Test Variable ${type} DistributedConfigDatastore
36 Run Keyword If '${shard_type}' == 'operational' Set Test Variable ${type} DistributedOperationalDatastore
37 Should Not Be Empty ${type} Wrong type, valid values are config and operational.
38 ${leader}= Set Variable 0
39 ${follower_list}= Create List
40 : FOR ${i} IN @{controller_index_list}
41 \ ${data}= Get Data From URI controller${i} ${jolokia_read}:Category=Shards,name=member-${i}-shard-${shard}-${shard_type},type=${type}
43 \ ${json}= To Json ${data}
44 \ ${status}= Get From Dictionary &{json}[value] RaftState
45 \ Log Controller ${ODL_SYSTEM_${i}_IP} is ${status} for shard ${shard}
46 \ Run Keyword If '${status}' == 'Leader' Set Test Variable ${leader} ${i}
47 \ Run Keyword If '${status}' == 'Follower' Append To List ${follower_list} ${i}
48 Should Not Be Equal ${leader} 0 No Leader elected in shard ${shard_type} ${shard}
49 Length Should Be ${follower_list} ${lenght-1} Not enough or too many Followers in shard ${shard_type} ${shard}
50 [Return] ${leader} ${follower_list}
52 Get Cluster Entity Owner Status
53 [Arguments] ${controller_index_list} ${device_type} ${device}
54 [Documentation] Checks Entity Owner status for a ${device} and returns owner index and list of candidates from a ${controller_index_list}.
55 ... ${device_type} is openflow, ovsdb, etc...
56 ${length}= Get Length ${controller_index_list}
57 ${candidates_list}= Create List
58 ${data}= Get Data From URI controller@{controller_index_list}[0] /restconf/operational/entity-owners:entity-owners
60 ${data}= Replace String ${data} /general-entity:entity[general-entity:name=' ${EMPTY}
61 ${clear_data}= Replace String ${data} '] ${EMPTY}
63 ${json}= To Json ${clear_data}
64 ${entity_type_list}= Get From Dictionary &{json}[entity-owners] entity-type
65 ${entity_type_index}= Get Index From List Of Dictionaries ${entity_type_list} type ${device_type}
66 Should Not Be Equal ${entity_type_index} -1 No Entity Owner found for ${device_type}
67 ${entity_list}= Get From Dictionary @{entity_type_list}[${entity_type_index}] entity
68 ${entity_index}= Get Index From List Of Dictionaries ${entity_list} id ${device}
69 Should Not Be Equal ${entity_index} -1 Device ${device} not found in Entity Owner ${device_type}
70 ${entity_owner}= Get From Dictionary @{entity_list}[${entity_index}] owner
71 Should Not Be Empty ${entity_owner} No owner found for ${device}
72 ${owner}= Replace String ${entity_owner} member- ${EMPTY}
73 ${owner}= Convert To Integer ${owner}
74 List Should Contain Value ${controller_index_list} ${owner} Owner ${owner} not exisiting in ${controller_index_list}
75 ${entity_candidates_list}= Get From Dictionary @{entity_list}[${entity_index}] candidate
76 ${list_length}= Get Length ${entity_candidates_list}
77 : FOR ${entity_candidate} IN @{entity_candidates_list}
78 \ ${candidate}= Replace String &{entity_candidate}[name] member- ${EMPTY}
79 \ ${candidate}= Convert To Integer ${candidate}
80 \ List Should Contain Value ${controller_index_list} ${candidate} Candidate ${candidate} not exisiting in ${controller_index_list}
81 \ Run Keyword If '${candidate}' != '${owner}' Append To List ${candidates_list} ${candidate}
82 [Return] ${owner} ${candidates_list}
84 Check Item Occurrence At URI In Cluster
85 [Arguments] ${controller_index_list} ${dictionary_item_occurrence} ${uri} ${headers}=${HEADERS}
86 [Documentation] Send a GET with the supplied ${uri} to all cluster instances in ${controller_index_list}
87 ... and check for occurrences of items expressed in a dictionary ${dictionary_item_occurrence}.
88 : FOR ${i} IN @{controller_index_list}
89 \ ${data} Get Data From URI controller${i} ${uri} ${headers}
91 \ Check Item Occurrence ${data} ${dictionary_item_occurrence}
93 Put And Check At URI In Cluster
94 [Arguments] ${controller_index_list} ${controller_index} ${uri} ${body} ${headers}=${HEADERS_YANG_JSON}
95 [Documentation] Send a PUT with the supplied ${uri} and ${body} to a ${controller_index}
96 ... and check the data is replicated in all instances in ${controller_index_list}.
97 ${expected_body}= Hsf Json ${body}
99 ${json_body}= To Json ${body}
100 ${resp} RequestsLibrary.Put Request controller${controller_index} ${uri} ${json_body} ${headers}
102 Log ${resp.status_code}
103 ${status_code}= Convert To String ${resp.status_code}
104 Should Match Regexp ${status_code} 20(0|1)
105 : FOR ${i} IN @{controller_index_list}
106 \ ${data} Wait Until Keyword Succeeds 5s 1s Get Data From URI controller${i}
107 \ ... ${uri} ${headers}
109 \ ${received_body} Hsf Json ${data}
110 \ Should Be Equal ${expected_body} ${received_body}
112 Delete And Check At URI In Cluster
113 [Arguments] ${controller_index_list} ${controller_index} ${uri} ${headers}=${HEADERS_YANG_JSON}
114 [Documentation] Send a DELETE with the supplied ${uri} to a ${controller_index}
115 ... and check the data is removed from all instances in ${controller_index_list}.
116 ${resp} RequestsLibrary.Delete Request controller${controller_index} ${uri} ${headers}
117 Should Be Equal As Strings ${resp.status_code} 200
118 : FOR ${i} IN @{controller_index_list}
119 \ Wait Until Keyword Succeeds 5s 1s No Content From URI controller${i} ${uri}
122 Kill Multiple Controllers
123 [Arguments] @{controller_index_list}
124 [Documentation] Give this keyword a scalar or list of controllers to be stopped.
125 : FOR ${i} IN @{controller_index_list}
126 \ ${output}= Run Command On Controller ${ODL_SYSTEM_${i}_IP} ps axf | grep karaf | grep -v grep | awk '{print \"kill -9 \" $1}' | sh
127 \ Controller Down Check ${ODL_SYSTEM_${i}_IP}
129 Start Multiple Controllers
130 [Arguments] ${timeout} @{controller_index_list}
131 [Documentation] Give this keyword a scalar or list of controllers to be started.
132 : FOR ${i} IN @{controller_index_list}
133 \ ${output}= Run Command On Controller ${ODL_SYSTEM_${i}_IP} ${WORKSPACE}/${BUNDLEFOLDER}/bin/start
134 \ Wait For Controller Sync ${timeout} ${ODL_SYSTEM_${i}_IP}
137 [Arguments] ${exclude_controller}=${EMPTY}
138 [Documentation] Creates a list of all controllers minus any excluded controller.
139 Log ${exclude_controller}
140 @{searchlist} Create List ${CONTROLLER} ${CONTROLLER1} ${CONTROLLER2}
141 Remove Values From List ${searchlist} ${exclude_controller}
143 [Return] ${searchlist}
145 Get Leader And Verify
146 [Arguments] ${shard_name} ${old_leader}=${EMPTY}
147 [Documentation] Returns the IP addr or hostname of the leader of the specified shard.
148 ... Controllers are specifed in the pybot command line.
149 ${searchlist} Get Controller List ${old_leader}
150 ${leader} GetLeader ${shard_name} ${3} ${3} ${1} ${RESTCONFPORT}
152 Should Not Be Equal As Strings ${leader} None
153 Run Keyword If '${old_leader}'!='${EMPTY}' Should Not Be Equal ${old_leader} ${leader}
157 [Arguments] ${shard_name}
158 [Documentation] No leader is elected in the car shard
159 ${leader} GetLeader ${shard_name} ${3} ${1} ${1} ${RESTCONFPORT}
160 ... ${CURRENT_CAR_LEADER}
161 Should Be Equal As Strings ${leader} None
164 [Arguments] ${shard_name} ${exclude_controller}=${EMPTY}
165 [Documentation] Returns the IP addresses or hostnames of all followers of the specified shard.
166 ${searchlist} Get Controller List ${exclude_controller}
167 ${followers} GetFollowers ${shard_name} ${3} ${3} ${1} ${RESTCONFPORT}
170 Should Not Be Empty ${followers}
171 [Return] ${followers}
173 Stop One Or More Controllers
174 [Arguments] @{controllers}
175 [Documentation] Give this keyword a scalar or list of controllers to be stopped.
176 ${cmd} = Set Variable ${KARAF_HOME}/bin/stop
177 : FOR ${ip} IN @{controllers}
178 \ Run Command On Remote System ${ip} ${cmd}
180 Kill One Or More Controllers
181 [Arguments] @{controllers}
182 [Documentation] Give this keyword a scalar or list of controllers to be stopped.
183 ${cmd} = Set Variable ps axf | grep karaf | grep -v grep | awk '{print \"kill -9 \" $1}' | sh
185 : FOR ${ip} IN @{controllers}
186 \ Run Command On Remote System ${ip} ${cmd}
188 Wait For Cluster Down
189 [Arguments] ${timeout} @{controllers}
190 [Documentation] Waits for one or more clustered controllers to be down.
191 : FOR ${ip} IN @{controllers}
192 \ ${status}= Run Keyword And Return Status Wait For Controller Down ${timeout} ${ip}
193 \ Exit For Loop If '${status}' == 'FAIL'
195 Wait For Controller Down
196 [Arguments] ${timeout} ${ip}
197 [Documentation] Waits for one controllers to be down.
198 Wait Until Keyword Succeeds ${timeout} 2s Controller Down Check ${ip}
200 Controller Down Check
202 [Documentation] Checks to see if a controller is down by verifying that the karaf process isn't present.
203 ${cmd} = Set Variable ps axf | grep karaf | grep -v grep | wc -l
204 ${response} Run Command On COntroller ${ip} ${cmd}
205 Log Number of controller instances running: ${response}
206 Should Start With ${response} 0 Controller process found or there may be extra instances of karaf running on the host machine.
208 Start One Or More Controllers
209 [Arguments] @{controllers}
210 [Documentation] Give this keyword a scalar or list of controllers to be started.
211 ${cmd} = Set Variable ${KARAF_HOME}/bin/start
212 : FOR ${ip} IN @{controllers}
213 \ Run Command On Remote System ${ip} ${cmd}
215 Wait For Cluster Sync
216 [Arguments] ${timeout} @{controllers}
217 [Documentation] Waits for one or more clustered controllers to report Sync Status as true.
218 : FOR ${ip} IN @{controllers}
219 \ ${status}= Run Keyword And Return Status Wait For Controller Sync ${timeout} ${ip}
220 \ Exit For Loop If '${status}' == 'FAIL'
222 Wait For Controller Sync
223 [Arguments] ${timeout} ${ip}
224 [Documentation] Waits for one controllers to report Sync Status as true.
225 Wait Until Keyword Succeeds ${timeout} 2s Controller Sync Status Should Be True ${ip}
227 Controller Sync Status Should Be True
229 [Documentation] Checks if Sync Status is true.
230 ${SyncStatus}= Get Controller Sync Status ${ip}
231 Should Be Equal ${SyncStatus} ${TRUE}
233 Controller Sync Status Should Be False
235 [Documentation] Checks if Sync Status is false.
236 ${SyncStatus}= Get Controller Sync Status ${ip}
237 Should Be Equal ${SyncStatus} ${FALSE}
239 Get Controller Sync Status
240 [Arguments] ${controller_ip}
241 [Documentation] Return Sync Status.
242 Create_Session session http://${controller_ip}:${RESTCONFPORT} headers=${HEADERS} auth=${AUTH}
243 ${data}= Get Data From URI session ${jolokia_conf}
245 ${json}= To Json ${data}
246 ${value}= Get From Dictionary ${json} value
247 ${ConfSyncStatus}= Get From Dictionary ${value} SyncStatus
248 Log Configuration Sync Status: ${ConfSyncStatus}
249 ${data}= Get Data From URI session ${jolokia_oper}
251 ${json}= To Json ${data}
252 ${value}= Get From Dictionary ${json} value
253 ${OperSyncStatus}= Get From Dictionary ${value} SyncStatus
254 Log Operational Sync Status: ${OperSyncStatus}
255 Run Keyword If ${OperSyncStatus} and ${ConfSyncStatus} Set Test Variable ${SyncStatus} ${TRUE}
256 ... ELSE Set Test Variable ${SyncStatus} ${FALSE}
257 [Return] ${SyncStatus}
259 Clean One Or More Journals
260 [Arguments] @{controllers}
261 [Documentation] Give this keyword a scalar or list of controllers on which to clean journals.
262 ${del_cmd} = Set Variable rm -rf ${KARAF_HOME}/journal
263 : FOR ${ip} IN @{controllers}
264 \ Run Command On Remote System ${ip} ${del_cmd}
266 Clean One Or More Snapshots
267 [Arguments] @{controllers}
268 [Documentation] Give this keyword a scalar or list of controllers on which to clean snapshots.
269 ${del_cmd} = Set Variable rm -rf ${KARAF_HOME}/snapshots
270 : FOR ${ip} IN @{controllers}
271 \ Run Command On Remote System ${ip} ${del_cmd}
273 Show Cluster Configuation Files
274 [Arguments] @{controllers}
275 [Documentation] Prints out the cluster configuration files for one or more controllers.
276 Log controllers: @{controllers}
277 ${cmd} = Set Variable cat ${KARAF_HOME}/configuration/initial/akka.conf
278 : FOR ${ip} IN @{controllers}
279 \ Run Command On Remote System ${ip} ${cmd}
280 ${cmd} = Set Variable cat ${KARAF_HOME}/configuration/initial/modules.conf
281 : FOR ${ip} IN @{controllers}
282 \ Run Command On Remote System ${ip} ${cmd}
283 ${cmd} = Set Variable cat ${KARAF_HOME}/configuration/initial/module-shards.conf
284 : FOR ${ip} IN @{controllers}
285 \ Run Command On Remote System ${ip} ${cmd}
286 ${cmd} = Set Variable cat ${KARAF_HOME}/configuration/initial/jolokia.xml
287 : FOR ${ip} IN @{controllers}
288 \ Run Command On Remote System ${ip} ${cmd}
289 ${cmd} = Set Variable cat ${KARAF_HOME}/etc/initial/org.apache.karaf.management.cfg
290 : FOR ${ip} IN @{controllers}
291 \ Run Command On Remote System ${ip} ${cmd}
292 ${cmd} = Set Variable cat ${KARAF_HOME}/etc/org.apache.karaf.features.cfg
293 : FOR ${ip} IN @{controllers}
294 \ Run Command On Remote System ${ip} ${cmd}
296 Isolate a Controller From Cluster
297 [Arguments] ${isolated controller} @{controllers}
298 [Documentation] Use IPTables to isolate one controller from the cluster.
299 ... On the isolated controller it blocks IP traffic to and from each of the other controllers.
300 : FOR ${controller} IN @{controllers}
301 \ ${other controller}= Evaluate "${isolated controller}" != "${controller}"
302 \ Run Keyword If ${other controller} Isolate One Controller From Another ${isolated controller} ${controller}
304 Rejoin a Controller To Cluster
305 [Arguments] ${isolated controller} @{controllers}
306 [Documentation] Use IPTables to rejoin one controller to the cluster.
307 ... On the isolated controller it unblocks IP traffic to and from each of the other controllers.
308 : FOR ${controller} IN @{controllers}
309 \ ${other controller}= Evaluate "${isolated controller}" != "${controller}"
310 \ Run Keyword If ${other controller} Rejoin One Controller To Another ${isolated controller} ${controller}
312 Isolate One Controller From Another
313 [Arguments] ${isolated controller} ${controller}
314 [Documentation] Inserts an IPTable rule to disconnect one controller from another controller in the cluster.
315 Modify IPTables ${isolated controller} ${controller} -I
317 Rejoin One Controller To Another
318 [Arguments] ${isolated controller} ${controller}
319 [Documentation] Deletes an IPTable rule, allowing one controller to reconnect to another controller in the cluster.
320 Modify IPTables ${isolated controller} ${controller} -D
323 [Arguments] ${isolated controller} ${controller} ${rule type}
324 [Documentation] Adds a rule, usually inserting or deleting an entry between two controllers.
325 ${base string} Set Variable sudo iptables ${rule type} OUTPUT -p all --source
326 ${cmd string} Catenate ${base string} ${isolated controller} --destination ${controller} -j DROP
327 Run Command On Remote System ${isolated controller} ${cmd string}
328 ${cmd string} Catenate ${base string} ${controller} --destination ${isolated controller} -j DROP
329 Run Command On Remote System ${isolated controller} ${cmd string}
330 ${cmd string} Set Variable sudo iptables -L -n
331 ${return string}= Run Command On Remote System ${isolated controller} ${cmd string}
333 Run Keyword If "${rule type}" == '-I' Should Match Regexp ${return string} [\s\S]*DROP *all *-- *${isolated controller} *${controller}[\s\S]*
334 Run Keyword If "${rule type}" == '-I' Should Match Regexp ${return string} [\s\S]*DROP *all *-- *${controller} *${isolated controller}[\s\S]*
336 Run Keyword If "${rule type}" == '-D' Should Match Regexp ${return string} (?![\s\S]*DROP *all *-- *${isolated controller} *${controller}[\s\S]*)
337 Run Keyword If "${rule type}" == '-D' Should Match Regexp ${return string} (?![\s\S]*DROP *all *-- *${controller} *${isolated controller}[\s\S]*)
339 Rejoin All Isolated Controllers
340 [Arguments] @{controllers}
341 [Documentation] Wipe all IPTables rules from all controllers, thus rejoining all controllers.
342 : FOR ${isolated controller} IN @{controllers}
343 \ Flush IPTables ${isolated controller}
346 [Arguments] ${isolated controller}
347 [Documentation] This keyword is generally not called from a test case but supports a complete wipe of all rules on
349 ${cmd string} Set Variable sudo iptables -v -F
350 ${return string}= Run Command On Remote System ${isolated controller} ${cmd string}
351 Log return: ${return string}
352 Should Contain ${return string} Flushing chain `INPUT'
353 Should Contain ${return string} Flushing chain `FORWARD'
354 Should Contain ${return string} Flushing chain `OUTPUT'