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 \ RequestsLibrary.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}= Utils.Get Data From URI controller${i} ${jolokia_read}:Category=Shards,name=member-${i}-shard-${shard}-${shard_type},type=${type}
43 \ ${json}= RequestsLibrary.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
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} can be openflow, ovsdb, etc.
56 ${length}= Get Length ${controller_index_list}
57 ${candidates_list}= Create List
58 ${data}= Utils.Get Data From URI controller@{controller_index_list}[0] /restconf/operational/entity-owners:entity-owners
60 ${clear_data}= Run Keyword If '${device_type}' == 'openflow' Extract OpenFlow Device Data ${data}
61 ... ELSE IF '${device_type}' == 'ovsdb' Extract Ovsdb Device Data ${data}
62 ... ELSE Fail Not recognized device type: ${device_type}
63 ${json}= RequestsLibrary.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}= Utils.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 \ Append To List ${candidates_list} ${candidate}
81 List Should Contain Sublist ${candidates_list} ${controller_index_list} Candidates are missing in ${candidates_list}
82 Remove Values From List ${candidates_list} ${owner}
83 [Return] ${owner} ${candidates_list}
85 Extract OpenFlow Device Data
87 [Documentation] Remove superfluous OpenFlow device data from Entity Owner printout.
88 ${clear_data}= Replace String ${data} /general-entity:entity[general-entity:name=' ${EMPTY}
89 ${clear_data}= Replace String ${clear_data} '] ${EMPTY}
91 [Return] ${clear_data}
93 Extract Ovsdb Device Data
95 [Documentation] Remove superfluous OVSDB device data from Entity Owner printout.
96 ${clear_data}= Replace String ${data} /network-topology:network-topology/network-topology:topology[network-topology:topology-id='ovsdb:1']/network-topology:node[network-topology:node-id=' ${EMPTY}
97 ${clear_data}= Replace String ${clear_data} '] ${EMPTY}
99 [Return] ${clear_data}
101 Check Item Occurrence At URI In Cluster
102 [Arguments] ${controller_index_list} ${dictionary_item_occurrence} ${uri}
103 [Documentation] Send a GET with the supplied ${uri} to all cluster instances in ${controller_index_list}
104 ... and check for occurrences of items expressed in a dictionary ${dictionary_item_occurrence}.
105 : FOR ${i} IN @{controller_index_list}
106 \ ${data} Utils.Get Data From URI controller${i} ${uri}
108 \ Utils.Check Item Occurrence ${data} ${dictionary_item_occurrence}
110 Put And Check At URI In Cluster
111 [Arguments] ${controller_index_list} ${controller_index} ${uri} ${body}
112 [Documentation] Send a PUT with the supplied ${uri} and ${body} (json string) to a ${controller_index}
113 ... and check the data is replicated in all instances in ${controller_index_list}.
114 ${expected_body}= Hsf Json ${body}
116 ${resp} RequestsLibrary.Put Request controller${controller_index} ${uri} data=${body} headers=${HEADERS_YANG_JSON}
118 Log ${resp.status_code}
119 ${status_code}= Convert To String ${resp.status_code}
120 Should Match Regexp ${status_code} 20(0|1)
121 : FOR ${i} IN @{controller_index_list}
122 \ ${data} Wait Until Keyword Succeeds 5s 1s Get Data From URI controller${i}
125 \ ${received_body} Hsf Json ${data}
126 \ Should Be Equal ${expected_body} ${received_body}
128 Delete And Check At URI In Cluster
129 [Arguments] ${controller_index_list} ${controller_index} ${uri}
130 [Documentation] Send a DELETE with the supplied ${uri} to a ${controller_index}
131 ... and check the data is removed from all instances in ${controller_index_list}.
132 ${resp} RequestsLibrary.Delete Request controller${controller_index} ${uri}
133 Should Be Equal As Strings ${resp.status_code} 200
134 : FOR ${i} IN @{controller_index_list}
135 \ Wait Until Keyword Succeeds 5s 1s No Content From URI controller${i} ${uri}
137 Kill Multiple Controllers
138 [Arguments] @{controller_index_list}
139 [Documentation] Give this keyword a scalar or list of controllers to be stopped.
140 : FOR ${i} IN @{controller_index_list}
141 \ ${output}= Utils.Run Command On Controller ${ODL_SYSTEM_${i}_IP} ps axf | grep karaf | grep -v grep | awk '{print \"kill -9 \" $1}' | sh
142 \ ClusterKeywords.Controller Down Check ${ODL_SYSTEM_${i}_IP}
144 Start Multiple Controllers
145 [Arguments] ${timeout} @{controller_index_list}
146 [Documentation] Give this keyword a scalar or list of controllers to be started.
147 : FOR ${i} IN @{controller_index_list}
148 \ ${output}= Utils.Run Command On Controller ${ODL_SYSTEM_${i}_IP} ${WORKSPACE}/${BUNDLEFOLDER}/bin/start
149 \ ClusterKeywords.Wait For Controller Sync ${timeout} ${ODL_SYSTEM_${i}_IP}
152 [Arguments] ${exclude_controller}=${EMPTY}
153 [Documentation] Creates a list of all controllers minus any excluded controller.
154 Log ${exclude_controller}
155 @{searchlist} Create List ${ODL_SYSTEM_IP} ${ODL_SYSTEM_2_IP} ${ODL_SYSTEM_3_IP}
156 Remove Values From List ${searchlist} ${exclude_controller}
158 [Return] ${searchlist}
160 Get Leader And Verify
161 [Arguments] ${shard_name} ${old_leader}=${EMPTY}
162 [Documentation] Returns the IP addr or hostname of the leader of the specified shard.
163 ... Controllers are specifed in the pybot command line.
164 ${searchlist} Get Controller List ${old_leader}
165 ${leader} GetLeader ${shard_name} ${3} ${3} ${1} ${RESTCONFPORT}
167 Should Not Be Equal As Strings ${leader} None
168 Run Keyword If '${old_leader}'!='${EMPTY}' Should Not Be Equal ${old_leader} ${leader}
172 [Arguments] ${shard_name}
173 [Documentation] No leader is elected in the car shard
174 ${leader} GetLeader ${shard_name} ${3} ${1} ${1} ${RESTCONFPORT}
175 ... ${CURRENT_CAR_LEADER}
176 Should Be Equal As Strings ${leader} None
179 [Arguments] ${shard_name} ${exclude_controller}=${EMPTY}
180 [Documentation] Returns the IP addresses or hostnames of all followers of the specified shard.
181 ${searchlist} Get Controller List ${exclude_controller}
182 ${followers} GetFollowers ${shard_name} ${3} ${3} ${1} ${RESTCONFPORT}
185 Should Not Be Empty ${followers}
186 [Return] ${followers}
188 Stop One Or More Controllers
189 [Arguments] @{controllers}
190 [Documentation] Give this keyword a scalar or list of controllers to be stopped.
191 ${cmd} = Set Variable ${KARAF_HOME}/bin/stop
192 : FOR ${ip} IN @{controllers}
193 \ Run Command On Remote System ${ip} ${cmd}
195 Kill One Or More Controllers
196 [Arguments] @{controllers}
197 [Documentation] Give this keyword a scalar or list of controllers to be stopped.
198 ${cmd} = Set Variable ps axf | grep karaf | grep -v grep | awk '{print \"kill -9 \" $1}' | sh
200 : FOR ${ip} IN @{controllers}
201 \ Run Command On Remote System ${ip} ${cmd}
203 Wait For Cluster Down
204 [Arguments] ${timeout} @{controllers}
205 [Documentation] Waits for one or more clustered controllers to be down.
206 : FOR ${ip} IN @{controllers}
207 \ ${status}= Run Keyword And Return Status Wait For Controller Down ${timeout} ${ip}
208 \ Exit For Loop If '${status}' == 'FAIL'
210 Wait For Controller Down
211 [Arguments] ${timeout} ${ip}
212 [Documentation] Waits for one controllers to be down.
213 Wait Until Keyword Succeeds ${timeout} 2s Controller Down Check ${ip}
215 Controller Down Check
217 [Documentation] Checks to see if a controller is down by verifying that the karaf process isn't present.
218 ${cmd} = Set Variable ps axf | grep karaf | grep -v grep | wc -l
219 ${response} Run Command On COntroller ${ip} ${cmd}
220 Log Number of controller instances running: ${response}
221 Should Start With ${response} 0 Controller process found or there may be extra instances of karaf running on the host machine.
223 Start One Or More Controllers
224 [Arguments] @{controllers}
225 [Documentation] Give this keyword a scalar or list of controllers to be started.
226 ${cmd} = Set Variable ${KARAF_HOME}/bin/start
227 : FOR ${ip} IN @{controllers}
228 \ Run Command On Remote System ${ip} ${cmd}
230 Wait For Cluster Sync
231 [Arguments] ${timeout} @{controllers}
232 [Documentation] Waits for one or more clustered controllers to report Sync Status as true.
233 : FOR ${ip} IN @{controllers}
234 \ ${status}= Run Keyword And Return Status Wait For Controller Sync ${timeout} ${ip}
235 \ Exit For Loop If '${status}' == 'FAIL'
237 Wait For Controller Sync
238 [Arguments] ${timeout} ${ip}
239 [Documentation] Waits for one controllers to report Sync Status as true.
240 Wait Until Keyword Succeeds ${timeout} 2s Controller Sync Status Should Be True ${ip}
242 Controller Sync Status Should Be True
244 [Documentation] Checks if Sync Status is true.
245 ${SyncStatus}= Get Controller Sync Status ${ip}
246 Should Be Equal ${SyncStatus} ${TRUE}
248 Controller Sync Status Should Be False
250 [Documentation] Checks if Sync Status is false.
251 ${SyncStatus}= Get Controller Sync Status ${ip}
252 Should Be Equal ${SyncStatus} ${FALSE}
254 Get Controller Sync Status
255 [Arguments] ${controller_ip}
256 [Documentation] Return Sync Status.
257 Create_Session session http://${controller_ip}:${RESTCONFPORT} headers=${HEADERS} auth=${AUTH}
258 ${data}= Get Data From URI session ${jolokia_conf}
260 ${json}= To Json ${data}
261 ${value}= Get From Dictionary ${json} value
262 ${ConfSyncStatus}= Get From Dictionary ${value} SyncStatus
263 Log Configuration Sync Status: ${ConfSyncStatus}
264 ${data}= Get Data From URI session ${jolokia_oper}
266 ${json}= To Json ${data}
267 ${value}= Get From Dictionary ${json} value
268 ${OperSyncStatus}= Get From Dictionary ${value} SyncStatus
269 Log Operational Sync Status: ${OperSyncStatus}
270 Run Keyword If ${OperSyncStatus} and ${ConfSyncStatus} Set Test Variable ${SyncStatus} ${TRUE}
271 ... ELSE Set Test Variable ${SyncStatus} ${FALSE}
272 [Return] ${SyncStatus}
274 Clean One Or More Journals
275 [Arguments] @{controllers}
276 [Documentation] Give this keyword a scalar or list of controllers on which to clean journals.
277 ${del_cmd} = Set Variable rm -rf ${KARAF_HOME}/journal
278 : FOR ${ip} IN @{controllers}
279 \ Run Command On Remote System ${ip} ${del_cmd}
281 Clean One Or More Snapshots
282 [Arguments] @{controllers}
283 [Documentation] Give this keyword a scalar or list of controllers on which to clean snapshots.
284 ${del_cmd} = Set Variable rm -rf ${KARAF_HOME}/snapshots
285 : FOR ${ip} IN @{controllers}
286 \ Run Command On Remote System ${ip} ${del_cmd}
288 Show Cluster Configuation Files
289 [Arguments] @{controllers}
290 [Documentation] Prints out the cluster configuration files for one or more controllers.
291 Log controllers: @{controllers}
292 ${cmd} = Set Variable cat ${KARAF_HOME}/configuration/initial/akka.conf
293 : FOR ${ip} IN @{controllers}
294 \ Run Command On Remote System ${ip} ${cmd}
295 ${cmd} = Set Variable cat ${KARAF_HOME}/configuration/initial/modules.conf
296 : FOR ${ip} IN @{controllers}
297 \ Run Command On Remote System ${ip} ${cmd}
298 ${cmd} = Set Variable cat ${KARAF_HOME}/configuration/initial/module-shards.conf
299 : FOR ${ip} IN @{controllers}
300 \ Run Command On Remote System ${ip} ${cmd}
301 ${cmd} = Set Variable cat ${KARAF_HOME}/configuration/initial/jolokia.xml
302 : FOR ${ip} IN @{controllers}
303 \ Run Command On Remote System ${ip} ${cmd}
304 ${cmd} = Set Variable cat ${KARAF_HOME}/etc/initial/org.apache.karaf.management.cfg
305 : FOR ${ip} IN @{controllers}
306 \ Run Command On Remote System ${ip} ${cmd}
307 ${cmd} = Set Variable cat ${KARAF_HOME}/etc/org.apache.karaf.features.cfg
308 : FOR ${ip} IN @{controllers}
309 \ Run Command On Remote System ${ip} ${cmd}
311 Isolate a Controller From Cluster
312 [Arguments] ${isolated controller} @{controllers}
313 [Documentation] Use IPTables to isolate one controller from the cluster.
314 ... On the isolated controller it blocks IP traffic to and from each of the other controllers.
315 : FOR ${controller} IN @{controllers}
316 \ ${other controller}= Evaluate "${isolated controller}" != "${controller}"
317 \ Run Keyword If ${other controller} Isolate One Controller From Another ${isolated controller} ${controller}
319 Rejoin a Controller To Cluster
320 [Arguments] ${isolated controller} @{controllers}
321 [Documentation] Use IPTables to rejoin one controller to the cluster.
322 ... On the isolated controller it unblocks IP traffic to and from each of the other controllers.
323 : FOR ${controller} IN @{controllers}
324 \ ${other controller}= Evaluate "${isolated controller}" != "${controller}"
325 \ Run Keyword If ${other controller} Rejoin One Controller To Another ${isolated controller} ${controller}
327 Isolate One Controller From Another
328 [Arguments] ${isolated controller} ${controller}
329 [Documentation] Inserts an IPTable rule to disconnect one controller from another controller in the cluster.
330 Modify IPTables ${isolated controller} ${controller} -I
332 Rejoin One Controller To Another
333 [Arguments] ${isolated controller} ${controller}
334 [Documentation] Deletes an IPTable rule, allowing one controller to reconnect to another controller in the cluster.
335 Modify IPTables ${isolated controller} ${controller} -D
338 [Arguments] ${isolated controller} ${controller} ${rule type}
339 [Documentation] Adds a rule, usually inserting or deleting an entry between two controllers.
340 ${base string} Set Variable sudo iptables ${rule type} OUTPUT -p all --source
341 ${cmd string} Catenate ${base string} ${isolated controller} --destination ${controller} -j DROP
342 Run Command On Remote System ${isolated controller} ${cmd string}
343 ${cmd string} Catenate ${base string} ${controller} --destination ${isolated controller} -j DROP
344 Run Command On Remote System ${isolated controller} ${cmd string}
345 ${cmd string} Set Variable sudo iptables -L -n
346 ${return string}= Run Command On Remote System ${isolated controller} ${cmd string}
348 Run Keyword If "${rule type}" == '-I' Should Match Regexp ${return string} [\s\S]*DROP *all *-- *${isolated controller} *${controller}[\s\S]*
349 Run Keyword If "${rule type}" == '-I' Should Match Regexp ${return string} [\s\S]*DROP *all *-- *${controller} *${isolated controller}[\s\S]*
351 Run Keyword If "${rule type}" == '-D' Should Match Regexp ${return string} (?![\s\S]*DROP *all *-- *${isolated controller} *${controller}[\s\S]*)
352 Run Keyword If "${rule type}" == '-D' Should Match Regexp ${return string} (?![\s\S]*DROP *all *-- *${controller} *${isolated controller}[\s\S]*)
354 Rejoin All Isolated Controllers
355 [Arguments] @{controllers}
356 [Documentation] Wipe all IPTables rules from all controllers, thus rejoining all controllers.
357 : FOR ${isolated controller} IN @{controllers}
358 \ Flush IPTables ${isolated controller}
361 [Arguments] ${isolated controller}
362 [Documentation] This keyword is generally not called from a test case but supports a complete wipe of all rules on
364 ${cmd string} Set Variable sudo iptables -v -F
365 ${return string}= Run Command On Remote System ${isolated controller} ${cmd string}
366 Log return: ${return string}
367 Should Contain ${return string} Flushing chain `INPUT'
368 Should Contain ${return string} Flushing chain `FORWARD'
369 Should Contain ${return string} Flushing chain `OUTPUT'