2 Documentation Resource housing Keywords common to several suites for cluster functional testing.
4 ... Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
5 ... Copyright (c) 2016 Brocade Communications Systems, Inc. and others. All rights reserved.
7 ... This program and the accompanying materials are made available under the
8 ... terms of the Eclipse Public License v1.0 which accompanies this distribution,
9 ... and is available at http://www.eclipse.org/legal/epl-v10.html
12 ... This resource holds private state (in suite variables),
13 ... which is generated once at Setup with ClusterManagement_Setup KW.
14 ... The state includes member indexes, IP addresses and Http (RequestsLibrary) sessions.
15 ... Cluster Keywords normally use member index, member list or nothing (all members) as argument.
17 ... All index lists returned should be sorted numerically, fix if not.
20 ... odl-jolokia is assumed to be installed.
22 ... Keywords are ordered as follows:
24 ... - Shard state, leader and followers
25 ... - Entity Owner, candidates and successors
26 ... - Kill, Stop and Start Member
27 ... - Isolate and Rejoin Member
28 ... - Run Commands On Member
29 ... - REST requests and checks on Members
31 ... TODO: Unify capitalization of Leaders and Followers.
32 Library RequestsLibrary # for Create_Session and To_Json
34 Resource ${CURDIR}/CompareStream.robot
35 Resource ${CURDIR}/KarafKeywords.robot
36 Resource ${CURDIR}/SSHKeywords.robot
37 Resource ${CURDIR}/TemplatedRequests.robot # for Get_As_Json_From_Uri
38 Resource ${CURDIR}/Utils.robot # for Run_Command_On_Controller
41 ${ENTITY_OWNER_URI} restconf/operational/entity-owners:entity-owners
42 ${JAVA_HOME} ${EMPTY} # releng/builder scripts should provide correct value
43 ${JOLOKIA_CONF_SHARD_MANAGER_URI} jolokia/read/org.opendaylight.controller:Category=ShardManager,name=shard-manager-config,type=DistributedConfigDatastore
44 ${JOLOKIA_OPER_SHARD_MANAGER_URI} jolokia/read/org.opendaylight.controller:Category=ShardManager,name=shard-manager-operational,type=DistributedOperationalDatastore
45 ${JOLOKIA_READ_URI} jolokia/read/org.opendaylight.controller
46 ${KARAF_HOME} ${WORKSPACE}${/}${BUNDLEFOLDER} # TODO: Migrate to Variables.robot
47 @{ODL_DEFAULT_DATA_PATHS} tmp/ data/ cache/ snapshots/ journal/ etc/opendaylight/current/
48 ${RESTCONF_MODULES_DIR} ${CURDIR}/../variables/restconf/modules
49 ${SINGLETON_NETCONF_DEVICE_ID_PREFIX} /odl-general-entity:entity[odl-general-entity:name='KeyedInstanceIdentifier{targetType=interface org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node, path=[org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology, org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology[key=TopologyKey [_topologyId=Uri [_value=topology-netconf]]], org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node[key=NodeKey [_nodeId=Uri [_value=
50 ${SINGLETON_NETCONF_DEVICE_ID_SUFFIX} ]]]]}']
51 ${SINGLETON_ELECTION_ENTITY_TYPE} org.opendaylight.mdsal.ServiceEntityType
52 ${SINGLETON_CHANGE_OWNERSHIP_ENTITY_TYPE} org.opendaylight.mdsal.AsyncServiceCloseEntityType
53 ${NODE_START_COMMAND} ${KARAF_HOME}/bin/start
54 ${NODE_STOP_COMMAND} ${KARAF_HOME}/bin/stop
55 ${NODE_KILL_COMMAND} ps axf | grep org.apache.karaf | grep -v grep | awk '{print \"kill -9 \" $1}' | sh
56 ${NODE_FREEZE_COMMAND} ps axf | grep org.apache.karaf | grep -v grep | awk '{print \"kill -STOP \" $1}' | sh
57 ${NODE_UNFREEZE_COMMAND} ps axf | grep org.apache.karaf | grep -v grep | awk '{print \"kill -CONT \" $1}' | sh
60 ClusterManagement_Setup
61 [Documentation] Detect repeated call, or detect number of members and initialize derived suite variables.
62 # Avoid multiple initialization by several downstream libraries.
63 ${already_done} = BuiltIn.Get_Variable_Value \${ClusterManagement__has_setup_run} False
64 BuiltIn.Return_From_Keyword_If ${already_done}
65 BuiltIn.Set_Suite_Variable \${ClusterManagement__has_setup_run} True
66 ${cluster_size} = BuiltIn.Get_Variable_Value \${NUM_ODL_SYSTEM} 1
67 ${status} ${possibly_int_of_members} = BuiltIn.Run_Keyword_And_Ignore_Error BuiltIn.Convert_To_Integer ${cluster_size}
68 ${int_of_members} = BuiltIn.Set_Variable_If '${status}' != 'PASS' ${1} ${possibly_int_of_members}
69 ClusterManagement__Compute_Derived_Variables int_of_members=${int_of_members}
71 Check_Cluster_Is_In_Sync
72 [Arguments] ${member_index_list}=${EMPTY}
73 [Documentation] Fail if no-sync is detected on a member from list (or any).
74 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
75 : FOR ${index} IN @{index_list} # usually: 1, 2, 3.
76 \ ${status} = Get_Sync_Status_Of_Member member_index=${index}
77 \ BuiltIn.Continue_For_Loop_If 'True' == '${status}'
78 \ BuiltIn.Fail Index ${index} has incorrect status: ${status}
80 Get_Sync_Status_Of_Member
81 [Arguments] ${member_index}
82 [Documentation] Obtain IP, two GETs from jolokia URIs, return combined sync status as string.
83 ${session} = Resolve_Http_Session_For_Member member_index=${member_index}
84 ${conf_text} = TemplatedRequests.Get_As_Json_From_Uri uri=${JOLOKIA_CONF_SHARD_MANAGER_URI} session=${session}
85 ${conf_status} = ClusterManagement__Parse_Sync_Status shard_manager_text=${conf_text}
86 BuiltIn.Return_From_Keyword_If 'False' == ${conf_status} False
87 ${oper_text} = TemplatedRequests.Get_As_Json_From_Uri uri=${JOLOKIA_OPER_SHARD_MANAGER_URI} session=${session}
88 ${oper_status} = ClusterManagement__Parse_Sync_Status shard_manager_text=${oper_text}
89 [Return] ${oper_status}
91 Verify_Leader_Exists_For_Each_Shard
92 [Arguments] ${shard_name_list} ${shard_type}=operational ${member_index_list}=${EMPTY} ${verify_restconf}=True
93 [Documentation] For each shard name, call Get_Leader_And_Followers_For_Shard.
94 ... Not much logic there, but single Keyword is useful when using BuiltIn.Wait_Until_Keyword_Succeeds.
95 : FOR ${shard_name} IN @{shard_name_list}
96 \ Get_Leader_And_Followers_For_Shard shard_name=${shard_name} shard_type=${shard_type} validate=True member_index_list=${member_index_list} verify_restconf=${verify_restconf}
98 Get_Leader_And_Followers_For_Shard
99 [Arguments] ${shard_name}=default ${shard_type}=operational ${validate}=True ${member_index_list}=${EMPTY} ${verify_restconf}=True
100 [Documentation] Get role lists, validate there is one leader, return the leader and list of followers.
101 ... Optionally, issue GET to a simple restconf URL to make sure subsequent operations will not encounter 503.
102 ${leader_list} ${follower_list} = Get_State_Info_For_Shard shard_name=${shard_name} shard_type=${shard_type} validate=True member_index_list=${member_index_list}
103 ... verify_restconf=${verify_restconf}
104 ${leader_count} = BuiltIn.Get_Length ${leader_list}
105 BuiltIn.Run_Keyword_If ${leader_count} < 1 BuiltIn.Fail No leader found.
106 BuiltIn.Length_Should_Be ${leader_list} ${1} Too many Leaders.
107 ${leader} = Collections.Get_From_List ${leader_list} 0
108 [Return] ${leader} ${follower_list}
110 Get_State_Info_For_Shard
111 [Arguments] ${shard_name}=default ${shard_type}=operational ${validate}=False ${member_index_list}=${EMPTY} ${verify_restconf}=False
112 [Documentation] Return lists of Leader and Follower member indices from a given member index list
113 ... (or from the full list if empty). If \${shard_type} is not 'config', 'operational' is assumed.
114 ... If \${validate}, Fail if raft state is not Leader or Follower (for example on Candidate).
115 ... The biggest difference from Get_Leader_And_Followers_For_Shard
116 ... is that no check on number of Leaders is performed.
117 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
118 Collections.Sort_List ${index_list} # to guarantee return values are also sorted lists
119 # TODO: Support alternative capitalization of 'config'?
120 ${ds_type} = BuiltIn.Set_Variable_If '${shard_type}' != 'config' operational config
121 ${leader_list} = BuiltIn.Create_List
122 ${follower_list} = BuiltIn.Create_List
123 : FOR ${index} IN @{index_list} # usually: 1, 2, 3.
124 \ ${raft_state} = Get_Raft_State_Of_Shard_At_Member shard_name=${shard_name} shard_type=${ds_type} member_index=${index} verify_restconf=${verify_restconf}
125 \ BuiltIn.Run_Keyword_If 'Follower' == '${raft_state}' Collections.Append_To_List ${follower_list} ${index}
126 \ ... ELSE IF 'Leader' == '${raft_state}' Collections.Append_To_List ${leader_list} ${index}
127 \ ... ELSE IF ${validate} BuiltIn.Fail Unrecognized Raft state: ${raft_state}
128 [Return] ${leader_list} ${follower_list}
130 Get_Raft_State_Of_Shard_At_Member
131 [Arguments] ${shard_name} ${shard_type} ${member_index} ${verify_restconf}=False
132 [Documentation] Send request to Jolokia on indexed member, return extracted Raft status.
133 ... Optionally, check restconf works.
134 ${session} = Resolve_Http_Session_For_Member member_index=${member_index}
135 # TODO: Does the used URI tend to generate large data which floods log.html?
136 BuiltIn.Run_Keyword_If ${verify_restconf} TemplatedRequests.Get_As_Json_Templated session=${session} folder=${RESTCONF_MODULES_DIR} verify=False
137 ${type_class} = Resolve_Shard_Type_Class shard_type=${shard_type}
138 ${uri} = BuiltIn.Set_Variable ${JOLOKIA_READ_URI}:Category=Shards,name=member-${member_index}-shard-${shard_name}-${shard_type},type=${type_class}
139 ${data_text} = TemplatedRequests.Get_As_Json_From_Uri uri=${uri} session=${session}
140 ${data_object} = RequestsLibrary.To_Json ${data_text}
141 ${value} = Collections.Get_From_Dictionary ${data_object} value
142 ${raft_state} = Collections.Get_From_Dictionary ${value} RaftState
143 [Return] ${raft_state}
145 Verify_Shard_Leader_Elected
146 [Arguments] ${shard_name} ${shard_type} ${new_elected} ${old_leader} ${member_index_list}=${EMPTY}
147 [Documentation] Verify new leader was elected or remained the same. Bool paramter ${new_elected} indicates if
148 ... new leader is elected or should remained the same as ${old_leader}
149 ${leader} ${followers}= Get_Leader_And_Followers_For_Shard shard_name=${shard_name} shard_type=${shard_type} member_index_list=${member_index_list}
150 BuiltIn.Run_Keyword_If ${new_elected} BuiltIn.Should_Not_Be_Equal_As_Numbers ${old_leader} ${leader}
151 BuiltIn.Run_Keyword_Unless ${new_elected} BuiltIn.Should_Be_Equal_As_numbers ${old_leader} ${leader}
152 BuiltIn.Return_From_Keyword ${leader} ${followers}
154 Verify_Owner_And_Successors_For_Device
155 [Arguments] ${device_name} ${device_type} ${member_index} ${candidate_list}=${EMPTY} ${after_stop}=False
156 [Documentation] Returns the owner and successors for the SB device ${device_name} of type ${device_type}. Request is sent to member ${member_index}.
157 ... For Boron and beyond, candidates are not removed on node down or isolation,
158 ... so this keyword expects candidates to be all members from Boron on.
159 ... Extra check is done to verify owner and successors are within the ${candidate_list}. This KW is useful when combined with WUKS.
160 ... ${candidate_list} minus owner is returned as ${successor list}.
161 ... Users can still use Get_Owner_And_Successors_For_Device if they are interested in downed candidates,
162 ... or for testing heterogeneous clusters.
163 ${index_list} = List_Indices_Or_All given_list=${candidate_list}
164 ${owner} ${successor_list} = Get_Owner_And_Successors_For_Device device_name=${device_name} device_type=${device_type} member_index=${member_index}
165 Collections.List_Should_Contain_Value ${index_list} ${owner} Owner ${owner} is not in candidate list ${index_list}
166 # In Beryllium or after stopping an instance, the removed instance does not show in the candidate list.
167 ${expected_candidate_list_origin} = BuiltIn.Set_Variable_If '${ODL_STREAM}' == 'beryllium' or ${after_stop} ${index_list} ${ClusterManagement__member_index_list}
168 # We do not want to manipulate either origin list.
169 ${expected_successor_list} = BuiltIn.Create_List @{expected_candidate_list_origin}
170 Collections.Remove_Values_From_List ${expected_successor_list} ${owner}
171 Collections.Lists_Should_Be_Equal ${expected_successor_list} ${successor_list} Successor list ${successor_list} is not the came as expected ${expected_successor_list}
172 # User expects the returned successor list to be the provided candidate list minus the owner.
173 Collections.Remove_Values_From_List ${index_list} ${owner}
174 [Return] ${owner} ${index_list}
176 Get_Owner_And_Successors_For_Device
177 [Arguments] ${device_name} ${device_type} ${member_index}
178 [Documentation] Returns the owner and a list of successors for the SB device ${device_name} of type ${device_type}. Request is sent to member ${member_index}.
179 ... Successors are those device candidates not elected as owner. The list of successors = (list of candidates) - (owner).
180 ... The returned successor list is sorted numerically.
181 ... Note that "candidate list" definition currently differs between Beryllium and Boron.
182 ... Use Verify_Owner_And_Successors_For_Device if you want the older semantics (inaccessible nodes not present in the list).
183 ${owner} ${candidate_list} = Get_Owner_And_Candidates_For_Device device_name=${device_name} device_type=${device_type} member_index=${member_index}
184 ${successor_list} = BuiltIn.Create_List @{candidate_list} # Copy operation is not required, but new variable name requires a line anyway.
185 Collections.Remove_Values_From_List ${successor_list} ${owner}
186 [Return] ${owner} ${successor_list}
188 Get_Owner_And_Candidates_For_Device_Old
189 [Arguments] ${device_name} ${device_type} ${member_index}
190 [Documentation] Returns the owner and a list of candidates for the SB device ${device_name} of type ${device_type}. Request is sent to member ${member_index}.
191 ... Candidates are all members that register to own a device, so the list of candiates includes the owner.
192 ... The returned candidate list is sorted numerically.
193 ... Note that "candidate list" definition currently differs between Beryllium and Boron.
194 ... It is recommended to use Get_Owner_And_Successors_For_Device instead of this keyword, see documentation there.
195 BuiltIn.Comment TODO: Can this implementation be changed to call Get_Owner_And_Candidates_For_Type_And_Id?
196 ${session} = Resolve_Http_Session_For_Member member_index=${member_index}
197 ${data} = TemplatedRequests.Get_As_Json_From_Uri uri=${ENTITY_OWNER_URI} session=${session}
198 ${candidate_list} = BuiltIn.Create_List
199 ${entity_type} = BuiltIn.Set_Variable_If '${device_type}' == 'netconf' netconf-node/${device_name} ${device_type}
200 ${clear_data} = BuiltIn.Run_Keyword_If '${device_type}' == 'openflow' or '${device_type}' == 'netconf' Extract_OpenFlow_Device_Data ${data}
201 ... ELSE IF '${device_type}' == 'ovsdb' Extract_Ovsdb_Device_Data ${data}
202 ... ELSE IF '${device_type}' == 'org.opendaylight.mdsal.ServiceEntityType' Extract_Service_Entity_Type ${data}
203 ... ELSE Fail Not recognized device type: ${device_type}
204 ${json} = RequestsLibrary.To_Json ${clear_data}
205 ${entity_type_list} = Collections.Get_From_Dictionary &{json}[entity-owners] entity-type
206 ${entity_type_index} = Utils.Get_Index_From_List_Of_Dictionaries ${entity_type_list} type ${entity_type}
207 BuiltIn.Should_Not_Be_Equal_As_Integers ${entity_type_index} -1 No Entity Owner found for ${device_type}
208 ${entity_list} = Collections.Get_From_Dictionary @{entity_type_list}[${entity_type_index}] entity
209 ${entity_index} = Utils.Get_Index_From_List_Of_Dictionaries ${entity_list} id ${device_name}
210 BuiltIn.Should_Not_Be_Equal_As_Integers ${entity_index} -1 Device ${device_name} not found in Entity Owner ${device_type}
211 ${entity_owner} = Collections.Get_From_Dictionary @{entity_list}[${entity_index}] owner
212 BuiltIn.Should_Not_Be_Empty ${entity_owner} No owner found for ${device_name}
213 ${owner} = String.Replace_String ${entity_owner} member- ${EMPTY}
214 ${owner} = BuiltIn.Convert_To_Integer ${owner}
215 ${entity_candidates_list} = Collections.Get_From_Dictionary @{entity_list}[${entity_index}] candidate
216 : FOR ${entity_candidate} IN @{entity_candidates_list}
217 \ ${candidate} = String.Replace_String &{entity_candidate}[name] member- ${EMPTY}
218 \ ${candidate} = BuiltIn.Convert_To_Integer ${candidate}
219 \ Collections.Append_To_List ${candidate_list} ${candidate}
220 Collections.Sort_List ${candidate_list}
221 [Return] ${owner} ${candidate_list}
223 Get_Owner_And_Candidates_For_Device_Singleton
224 [Arguments] ${device_name} ${device_type} ${member_index}
225 [Documentation] Returns the owner and a list of candidates for the SB device ${device_name} of type ${device_type}. Request is sent to member ${member_index}.
226 ... Parsing method is selected by device type
227 ... Separate kw for every supported device type must be defined
228 BuiltIn.Keyword_Should_Exist Get_Owner_And_Candidates_For_Device_Singleton_${device_type}
229 BuiltIn.Run_Keyword_And_Return Get_Owner_And_Candidates_For_Device_Singleton_${device_type} ${device_name} ${member_index}
231 Get_Owner_And_Candidates_For_Device_Singleton_Netconf
232 [Arguments] ${device_name} ${member_index}
233 [Documentation] Returns the owner and a list of candidates for the SB device ${device_name} of type netconf. Request is sent to member ${member_index}.
234 ... Parsing method is set as netconf (using netconf device id prefix and suffix)
235 # Get election entity type results
236 ${type} = BuiltIn.Set_Variable ${SINGLETON_ELECTION_ENTITY_TYPE}
237 ${id} = BuiltIn.Set_Variable ${SINGLETON_NETCONF_DEVICE_ID_PREFIX}${device_name}${SINGLETON_NETCONF_DEVICE_ID_SUFFIX}
238 ${owner_1} ${candidate_list_1} = Get_Owner_And_Candidates_For_Type_And_Id ${type} ${id} ${member_index}
239 # Get change ownership entity type results
240 ${type} = BuiltIn.Set_Variable ${SINGLETON_CHANGE_OWNERSHIP_ENTITY_TYPE}
241 ${id} = BuiltIn.Set_Variable ${SINGLETON_NETCONF_DEVICE_ID_PREFIX}${device_name}${SINGLETON_NETCONF_DEVICE_ID_SUFFIX}
242 ${owner_2} ${candidate_list_2} = Get_Owner_And_Candidates_For_Type_And_Id ${type} ${id} ${member_index}
243 # Owners must be same, if not, there is still some election or change ownership in progress
244 BuiltIn.Should_Be_Equal_As_Integers ${owner_1} ${owner_2} Owners for device ${device_name} are not same
245 [Return] ${owner_1} ${candidate_list_1}
247 Get_Owner_And_Candidates_For_Device
248 [Arguments] ${device_name} ${device_type} ${member_index}
249 [Documentation] Returns the owner and a list of candidates for the SB device ${device_name} of type ${device_type}. Request is sent to member ${member_index}.
250 ... If parsing as singleton failed, kw try to parse data in old way (without singleton).
251 ... Candidates are all members that register to own a device, so the list of candiates includes the owner.
252 ... The returned candidate list is sorted numerically.
253 ... Note that "candidate list" definition currently differs between Beryllium and Boron.
254 ... It is recommended to use Get_Owner_And_Successors_For_Device instead of this keyword, see documentation there.
256 ${status} ${results} = BuiltIn.Run_Keyword_And_Ignore_Error Get_Owner_And_Candidates_For_Device_Singleton device_name=${device_name} device_type=${device_type} member_index=${member_index}
257 BuiltIn.Return_From_Keyword_If "${status}"=="PASS" ${results}
258 # If singleton failed, try parsing in old way
259 ${status} ${results} = BuiltIn.Run_Keyword_And_Ignore_Error Get_Owner_And_Candidates_For_Device_Old device_name=${device_name} device_type=${device_type} member_index=${member_index}
260 # previous 3 lines (BuilIn.Return.., # If singleton..., ${status}....) could be deleted when old way will not be supported anymore
261 BuiltIn.Run_Keyword_If '${status}'=='FAIL' BuiltIn.Fail Could not parse owner and candidates for device ${device_name}
264 Check_Old_Owner_Stays_Elected_For_Device
265 [Arguments] ${device_name} ${device_type} ${old_owner} ${node_to_ask}
266 [Documentation] Verify the owner remain the same as ${old_owner}
267 ${owner} ${candidates} = Get_Owner_And_Candidates_For_Device ${device_name} ${device_type} ${node_to_ask}
268 BuiltIn.Should_Be_Equal_As_numbers ${old_owner} ${owner}
269 BuiltIn.Return_From_Keyword ${owner} ${candidates}
271 Check_New_Owner_Got_Elected_For_Device
272 [Arguments] ${device_name} ${device_type} ${old_owner} ${node_to_ask}
273 [Documentation] Verify new owner was elected comparing to ${old_owner}
274 ${owner} ${candidates} = Get_Owner_And_Candidates_For_Device ${device_name} ${device_type} ${node_to_ask}
275 BuiltIn.Should_Not_Be_Equal_As_Numbers ${old_owner} ${owner}
276 BuiltIn.Return_From_Keyword ${owner} ${candidates}
278 Get_Owner_And_Candidates_For_Type_And_Id
279 [Arguments] ${type} ${id} ${member_index} ${require_candidate_list}=${EMPTY}
280 [Documentation] Returns the owner and a list of candidates for entity specified by ${type} and ${id}
281 ... Request is sent to member ${member_index}.
282 ... Candidates are all members that register to own a device, so the list of candiates includes the owner.
283 ... Bear in mind that for Boron and beyond, candidates are not removed on node down or isolation.
284 ... If ${require_candidate_list} is not \${EMPTY}, check whether the actual list of candidates matches.
285 ... Note that differs from "given list" semantics used in other keywords,
286 ... namely you cannot use \${EMPTY} to stand for "full list" in this keyword.
287 BuiltIn.Comment TODO: Find a way to unify and deduplicate code blocks in Get_Owner_And_Candidates_* keywords.
288 ${session} = Resolve_Http_Session_For_Member member_index=${member_index}
289 ${data} = TemplatedRequests.Get_As_Json_From_Uri uri=${ENTITY_OWNER_URI} session=${session}
290 ${candidate_list} = BuiltIn.Create_List
291 ${json} = RequestsLibrary.To_Json ${data}
292 ${entity_type_list} = Collections.Get_From_Dictionary &{json}[entity-owners] entity-type
293 ${entity_type_index} = Utils.Get_Index_From_List_Of_Dictionaries ${entity_type_list} type ${type}
294 BuiltIn.Should_Not_Be_Equal_As_Integers ${entity_type_index} -1 No Entity Owner found for ${type}
295 ${entity_list} = Collections.Get_From_Dictionary @{entity_type_list}[${entity_type_index}] entity
296 ${entity_index} = Utils.Get_Index_From_List_Of_Dictionaries ${entity_list} id ${id}
297 BuiltIn.Should Not_Be_Equal_As_Integers ${entity_index} -1 Id ${id} not found in Entity Owner ${type}
298 ${entity_owner} = Collections.Get_From_Dictionary @{entity_list}[${entity_index}] owner
299 BuiltIn.Should_Not_Be_Empty ${entity_owner} No owner found for type=${type} id=${id}
300 ${owner} = String.Replace_String ${entity_owner} member- ${EMPTY}
301 ${owner} = BuiltIn.Convert_To_Integer ${owner}
302 ${entity_candidates_list} = Collections.Get_From_Dictionary @{entity_list}[${entity_index}] candidate
303 : FOR ${entity_candidate} IN @{entity_candidates_list}
304 \ ${candidate} = String.Replace_String &{entity_candidate}[name] member- ${EMPTY}
305 \ ${candidate} = BuiltIn.Convert_To_Integer ${candidate}
306 \ Collections.Append_To_List ${candidate_list} ${candidate}
307 Collections.Sort_List ${candidate_list}
308 BuiltIn.Comment TODO: Separate check lines into Verify_Owner_And_Candidates_For_Type_And_Id
309 BuiltIn.Run_Keyword_If """${require_candidate_list}""" BuiltIn.Should_Be_Equal ${require_candidate_list} ${candidate_list} Candidate list does not match: ${candidate_list} is not ${require_candidate_list}
310 [Return] ${owner} ${candidate_list}
312 Extract_Service_Entity_Type
314 [Documentation] Remove superfluous device data from Entity Owner printout.
315 ${clear_data} = String.Replace_String ${data} /odl-general-entity:entity[odl-general-entity:name=' ${EMPTY}
316 ${clear_data} = String.Replace_String ${clear_data} -service-group'] ${EMPTY}
318 [Return] ${clear_data}
320 Extract_OpenFlow_Device_Data
322 [Documentation] Remove superfluous OpenFlow device data from Entity Owner printout.
323 ${clear_data} = BuiltIn.Run Keyword If '${ODL_STREAM}' != 'beryllium' and '${ODL_OF_PLUGIN}' == 'lithium' String.Replace_String ${data} org.opendaylight.mdsal.ServiceEntityType openflow
324 ... ELSE BuiltIn.Set_Variable ${data}
325 ${clear_data} = String.Replace_String ${clear_data} /odl-general-entity:entity[odl-general-entity:name=' ${EMPTY}
326 ${clear_data} = String.Replace_String ${clear_data} /general-entity:entity[general-entity:name=' ${EMPTY}
327 ${clear_data} = String.Replace_String ${clear_data} '] ${EMPTY}
329 [Return] ${clear_data}
331 Extract_Ovsdb_Device_Data
333 [Documentation] Remove superfluous OVSDB device data from Entity Owner printout.
334 ${clear_data} = String.Replace_String ${data} /network-topology:network-topology/network-topology:topology[network-topology:topology-id='ovsdb:1']/network-topology:node[network-topology:node-id=' ${EMPTY}
335 ${clear_data} = String.Replace_String ${clear_data} '] ${EMPTY}
337 [Return] ${clear_data}
340 [Arguments] ${member} ${original_index_list}=${EMPTY} ${confirm}=True
341 [Documentation] Convenience keyword that kills the specified member of the cluster.
342 ... The KW will return a list of available members: \${updated index_list}=\${original_index_list}-\${member}
343 ${index_list} = ClusterManagement__Build_List ${member}
344 ${updated_index_list} = Kill_Members_From_List_Or_All ${index_list} ${original_index_list} ${confirm}
345 [Return] ${updated_index_list}
347 Kill_Members_From_List_Or_All
348 [Arguments] ${member_index_list}=${EMPTY} ${original_index_list}=${EMPTY} ${confirm}=True
349 [Documentation] If the list is empty, kill all ODL instances. Otherwise, kill members based on \${kill_index_list}
350 ... If \${confirm} is True, sleep 1 second and verify killed instances are not there anymore.
351 ... The KW will return a list of available members: \${updated index_list}=\${original_index_list}-\${member_index_list}
352 ${kill_index_list} = List_Indices_Or_All given_list=${member_index_list}
353 ${index_list} = List_Indices_Or_All given_list=${original_index_list}
354 Run_Bash_Command_On_List_Or_All command=${NODE_KILL_COMMAND} member_index_list=${member_index_list}
355 ${updated_index_list} = BuiltIn.Create_List @{index_list}
356 Collections.Remove_Values_From_List ${updated_index_list} @{kill_index_list}
357 BuiltIn.Return_From_Keyword_If not ${confirm} ${updated_index_list}
358 # TODO: Convert to WUKS with configurable timeout if it turns out 1 second is not enough.
359 BuiltIn.Sleep 1s Kill -9 closes open files, which may take longer than ssh overhead, but not long enough to warrant WUKS.
360 : FOR ${index} IN @{kill_index_list}
361 \ Verify_Karaf_Is_Not_Running_On_Member member_index=${index}
362 [Return] ${updated_index_list}
365 [Arguments] ${member} ${original_index_list}=${EMPTY} ${confirm}=True
366 [Documentation] Convenience keyword that stops the specified member of the cluster.
367 ... The KW will return a list of available members: \${updated index_list}=\${original_index_list}-\${member}
368 ${index_list} = ClusterManagement__Build_List ${member}
369 ${updated_index_list} = Stop_Members_From_List_Or_All ${index_list} ${original_index_list} ${confirm}
370 [Return] ${updated_index_list}
372 Stop_Members_From_List_Or_All
373 [Arguments] ${member_index_list}=${EMPTY} ${original_index_list}=${EMPTY} ${confirm}=True ${timeout}=120s
374 [Documentation] If the list is empty, stops all ODL instances. Otherwise stop members based on \${stop_index_list}
375 ... If \${confirm} is True, verify stopped instances are not there anymore.
376 ... The KW will return a list of available members: \${updated index_list}=\${original_index_list}-\${member_index_list}
377 ${stop_index_list} = List_Indices_Or_All given_list=${member_index_list}
378 ${index_list} = List_Indices_Or_All given_list=${original_index_list}
379 Run_Bash_Command_On_List_Or_All command=${NODE_STOP_COMMAND} member_index_list=${member_index_list}
380 ${updated_index_list} = BuiltIn.Create_List @{index_list}
381 Collections.Remove_Values_From_List ${updated_index_list} @{stop_index_list}
382 BuiltIn.Return_From_Keyword_If not ${confirm} ${updated_index_list}
383 : FOR ${index} IN @{stop_index_list}
384 \ BuiltIn.Wait Until Keyword Succeeds ${timeout} 2s Verify_Karaf_Is_Not_Running_On_Member member_index=${index}
385 [Return] ${updated_index_list}
388 [Arguments] ${member} ${wait_for_sync}=True ${timeout}=300s
389 [Documentation] Convenience keyword that starts the specified member of the cluster.
390 ${index_list} = ClusterManagement__Build_List ${member}
391 Start_Members_From_List_Or_All ${index_list} ${wait_for_sync} ${timeout}
393 Start_Members_From_List_Or_All
394 [Arguments] ${member_index_list}=${EMPTY} ${wait_for_sync}=True ${timeout}=300s ${karaf_home}=${EMPTY} ${export_java_home}=${EMPTY}
395 [Documentation] If the list is empty, start all cluster members. Otherwise, start members based on present indices.
396 ... If ${wait_for_sync}, wait for cluster sync on listed members.
397 ... Optionally karaf_home can be overriden. Optionally specific JAVA_HOME is used for starting.
398 ${base_command} = BuiltIn.Set_Variable_If "${karaf_home}" ${karaf_home}/bin/start ${NODE_START_COMMAND}
399 ${command} = BuiltIn.Set_Variable_If "${export_java_home}" export JAVA_HOME="${export_java_home}"; ${base_command} ${base_command}
400 Run_Bash_Command_On_List_Or_All command=${command} member_index_list=${member_index_list}
401 BuiltIn.Return_From_Keyword_If not ${wait_for_sync}
402 BuiltIn.Wait_Until_Keyword_Succeeds ${timeout} 10s Check_Cluster_Is_In_Sync member_index_list=${member_index_list}
403 # TODO: Do we also want to check Shard Leaders here?
406 [Arguments] ${member}
407 [Documentation] Convenience keyword that stops the specified member of the cluster by freezing the jvm.
408 ${index_list} = ClusterManagement__Build_List ${member}
409 Freeze_Or_Unfreeze_Members_From_List_Or_All ${NODE_FREEZE_COMMAND} ${index_list}
411 Unfreeze_Single_Member
412 [Arguments] ${member} ${wait_for_sync}=True ${timeout}=60s
413 [Documentation] Convenience keyword that "continues" the specified member of the cluster by unfreezing the jvm.
414 ${index_list} = ClusterManagement__Build_List ${member}
415 Freeze_Or_Unfreeze_Members_From_List_Or_All ${NODE_UNFREEZE_COMMAND} ${index_list}
416 BuiltIn.Wait_Until_Keyword_Succeeds ${timeout} 10s Check_Cluster_Is_In_Sync
418 Freeze_Or_Unfreeze_Members_From_List_Or_All
419 [Arguments] ${command} ${member_index_list}=${EMPTY}
420 [Documentation] If the list is empty, stops/runs all ODL instances. Otherwise stop/run members based on \${stop_index_list}
421 ... For command parameter only ${NODE_FREEZE_COMMAND} and ${NODE_UNFREEZE_COMMAND} should be used
422 ${freeze_index_list} = List_Indices_Or_All given_list=${member_index_list}
423 Run_Bash_Command_On_List_Or_All command=${command} member_index_list=${member_index_list}
425 Clean_Journals_And_Snapshots_On_List_Or_All
426 [Arguments] ${member_index_list}=${EMPTY} ${karaf_home}=${KARAF_HOME}
427 [Documentation] Delete journal and snapshots directories on every node listed (or all).
428 ... BEWARE: If only a subset of members is cleaned, this causes RetiredGenerationException in Carbon after the affected node re-start.
429 ... See https://bugs.opendaylight.org/show_bug.cgi?id=8138
430 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
431 ${command} = Set Variable rm -rf "${karaf_home}/journal" "${karaf_home}/snapshots"
432 : FOR ${index} IN @{index_list} # usually: 1, 2, 3.
433 \ Run_Bash_Command_On_Member command=${command} member_index=${index}
435 Verify_Karaf_Is_Not_Running_On_Member
436 [Arguments] ${member_index}
437 [Documentation] Fail if non-zero karaf instances are counted on member of given index.
438 ${count} = Count_Running_Karafs_On_Member member_index=${member_index}
439 BuiltIn.Should_Be_Equal 0 ${count} Found running Karaf count: ${count}
441 Verify_Single_Karaf_Is_Running_On_Member
442 [Arguments] ${member_index}
443 [Documentation] Fail if number of karaf instances on member of given index is not one.
444 ${count} = Count_Running_Karafs_On_Member member_index=${member_index}
445 BuiltIn.Should_Be_Equal 1 ${count} Wrong number of Karafs running: ${count}
447 Count_Running_Karafs_On_Member
448 [Arguments] ${member_index}
449 [Documentation] Remotely execute grep for karaf process, return count as string.
450 ${command} = BuiltIn.Set_Variable ps axf | grep org.apache.karaf | grep -v grep | wc -l
451 ${count} = Run_Bash_Command_On_Member command=${command} member_index=${member_index}
454 Isolate_Member_From_List_Or_All
455 [Arguments] ${isolate_member_index} ${member_index_list}=${EMPTY}
456 [Documentation] If the list is empty, isolate member from all ODL instances. Otherwise, isolate member based on present indices.
457 ... The KW will return a list of available members: \${updated index_list}=\${member_index_list}-\${isolate_member_index}
458 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
459 ${source} = Collections.Get_From_Dictionary ${ClusterManagement__index_to_ip_mapping} ${isolate_member_index}
460 : FOR ${index} IN @{index_list}
461 \ ${destination} = Collections.Get_From_Dictionary ${ClusterManagement__index_to_ip_mapping} ${index}
462 \ ${command} = BuiltIn.Set_Variable sudo /sbin/iptables -I OUTPUT -p all --source ${source} --destination ${destination} -j DROP
463 \ BuiltIn.Run_Keyword_If "${index}" != "${isolate_member_index}" Run_Bash_Command_On_Member command=${command} member_index=${isolate_member_index}
464 ${command} = BuiltIn.Set_Variable sudo /sbin/iptables -L -n
465 ${output} = Run_Bash_Command_On_Member command=${command} member_index=${isolate_member_index}
466 BuiltIn.Log ${output}
467 ${updated_index_list} = BuiltIn.Create_List @{index_list}
468 Collections.Remove_Values_From_List ${updated_index_list} ${isolate_member_index}
469 [Return] ${updated_index_list}
471 Rejoin_Member_From_List_Or_All
472 [Arguments] ${rejoin_member_index} ${member_index_list}=${EMPTY}
473 [Documentation] If the list is empty, rejoin member from all ODL instances. Otherwise, rejoin member based on present indices.
474 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
475 ${source} = Collections.Get_From_Dictionary ${ClusterManagement__index_to_ip_mapping} ${rejoin_member_index}
476 : FOR ${index} IN @{index_list}
477 \ ${destination} = Collections.Get_From_Dictionary ${ClusterManagement__index_to_ip_mapping} ${index}
478 \ ${command} = BuiltIn.Set_Variable sudo /sbin/iptables -D OUTPUT -p all --source ${source} --destination ${destination} -j DROP
479 \ BuiltIn.Run_Keyword_If "${index}" != "${rejoin_member_index}" Run_Bash_Command_On_Member command=${command} member_index=${rejoin_member_index}
480 ${command} = BuiltIn.Set_Variable sudo /sbin/iptables -L -n
481 ${output} = Run_Bash_Command_On_Member command=${command} member_index=${rejoin_member_index}
482 BuiltIn.Log ${output}
484 Flush_Iptables_From_List_Or_All
485 [Arguments] ${member_index_list}=${EMPTY}
486 [Documentation] If the list is empty, flush IPTables in all ODL instances. Otherwise, flush member based on present indices.
487 ${command} = BuiltIn.Set_Variable sudo iptables -v -F
488 ${output} = Run_Bash_Command_On_List_Or_All command=${command} member_index_list=${member_index_list}
490 Run_Bash_Command_On_List_Or_All
491 [Arguments] ${command} ${member_index_list}=${EMPTY}
492 [Documentation] Cycle through indices (or all), run command on each.
493 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
494 : FOR ${index} IN @{index_list}
495 \ Run_Bash_Command_On_Member command=${command} member_index=${index}
497 Run_Bash_Command_On_Member
498 [Arguments] ${command} ${member_index}
499 [Documentation] Obtain IP, call Utils and return output. This does not preserve active ssh session.
500 # TODO: Rename these keyword to Run_Bash_Command_On_Member to distinguish from Karaf (or even Windows) commands.
501 ${member_ip} = Collections.Get_From_Dictionary dictionary=${ClusterManagement__index_to_ip_mapping} key=${member_index}
502 ${output} = SSHKeywords.Run_Keyword_Preserve_Connection Utils.Run_Command_On_Controller ${member_ip} ${command}
505 Run_Karaf_Command_On_List_Or_All
506 [Arguments] ${command} ${member_index_list}=${EMPTY} ${timeout}=10s
507 [Documentation] Cycle through indices (or all), run karaf command on each.
508 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
509 : FOR ${index} IN @{index_list}
510 \ ${member_ip} = Collections.Get_From_Dictionary dictionary=${ClusterManagement__index_to_ip_mapping} key=${index}
511 \ KarafKeywords.Safe_Issue_Command_On_Karaf_Console ${command} ${member_ip} timeout=${timeout}
513 Run_Karaf_Command_On_Member
514 [Arguments] ${command} ${member_index} ${timeout}=10s
515 [Documentation] Obtain IP address, call KarafKeywords and return output. This does not preserve active ssh session.
516 ... This keyword is not used by Run_Karaf_Command_On_List_Or_All, but returned output may be useful.
517 ${member_ip} = Collections.Get_From_Dictionary dictionary=${ClusterManagement__index_to_ip_mapping} key=${member_index}
518 ${output} = KarafKeywords.Safe_Issue_Command_On_Karaf_Console ${command} controller=${member_ip} timeout=${timeout}
521 Install_Feature_On_List_Or_All
522 [Arguments] ${feature_name} ${member_index_list}=${EMPTY} ${timeout}=60s
523 [Documentation] Attempt installation on each member from list (or all). Then look for failures.
524 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
525 ${status_list} = BuiltIn.Create_List
526 : FOR ${index} IN @{index_list}
527 \ ${status} ${text} = BuiltIn.Run_Keyword_And_Ignore_Error Install_Feature_On_Member feature_name=${feature_name} member_index=${index}
528 \ ... timeout=${timeout}
529 \ BuiltIn.Log ${text}
530 \ Collections.Append_To_List ${status_list} ${status}
531 : FOR ${status} IN @{status_list}
532 \ BuiltIn.Run_Keyword_If "${status}" != "PASS" BuiltIn.Fail ${feature_name} installation failed, see log.
534 Install_Feature_On_Member
535 [Arguments] ${feature_name} ${member_index} ${timeout}=60s
536 [Documentation] Run feature:install karaf command, fail if installation was not successful. Return output.
537 ${status} ${output} = BuiltIn.Run_Keyword_And_Ignore_Error Run_Karaf_Command_On_Member command=feature:install ${feature_name} member_index=${member_index} timeout=${timeout}
538 BuiltIn.Run_Keyword_If "${status}" != "PASS" BuiltIn.Fail Failed to install ${feature_name}: ${output}
539 BuiltIn.Should_Not_Contain ${output} Can't install Failed to install ${feature_name}: ${output}
542 With_Ssh_To_List_Or_All_Run_Keyword
543 [Arguments] ${member_index_list} ${keyword_name} @{args} &{kwargs}
544 [Documentation] For each index in given list (or all): activate SSH connection, run given Keyword, close active connection. Return None.
545 ... Note that if the Keyword affects SSH connections, results are still deterministic, but perhaps undesirable.
546 ... Beware that in order to avoid "got positional argument after named arguments", first two arguments in the call should not be named.
547 BuiltIn.Comment This keyword is experimental and there is high risk of being replaced by another approach.
548 # TODO: For_Index_From_List_Or_All_Run_Keyword applied to With_Ssh_To_Member_Run_Keyword?
549 # TODO: Imagine another keyword, using ScalarClosures and adding member index as first argument for each call. Worth it?
550 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
551 : FOR ${member_index} IN @{index_list}
552 \ ${member_ip} = Resolve_IP_Address_For_Member ${member_index}
553 \ SSHKeywords.Open_Connection_To_Odl_System ip_address=${member_ip}
554 \ BuiltIn.Run_Keyword ${keyword_name} @{args} &{kwargs}
555 \ SSHLibrary.Close_Connection
557 Safe_With_Ssh_To_List_Or_All_Run_Keyword
558 [Arguments] ${member_index_list} ${keyword_name} @{args} &{kwargs}
559 [Documentation] Remember active ssh connection index, call With_Ssh_To_List_Or_All_Run_Keyword, return None. Restore the conection index on teardown.
560 SSHKeywords.Run_Keyword_Preserve_Connection With_Ssh_To_List_Or_All_Run_Keyword ${member_index_list} ${keyword_name} @{args} &{kwargs}
562 Clean_Directories_On_List_Or_All
563 [Arguments] ${member_index_list}=${EMPTY} ${directory_list}=${EMPTY} ${karaf_home}=${KARAF_HOME}
564 [Documentation] Clear @{directory_list} or @{ODL_DEFAULT_DATA_PATHS} for members in given list or all. Return None.
565 ... This is intended to return Karaf (offline) to the state it was upon the first boot.
566 ${path_list} = Builtin.Set Variable If "${directory_list}" == "${EMPTY}" ${ODL_DEFAULT_DATA_PATHS} ${directory_list}
567 Safe_With_Ssh_To_List_Or_All_Run_Keyword ${member_index_list} ClusterManagement__Clean_Directories ${path_list} ${karaf_home}
569 Store_Karaf_Log_On_List_Or_All
570 [Arguments] ${member_index_list}=${EMPTY} ${dst_dir}=/tmp ${karaf_home}=${KARAF_HOME}
571 [Documentation] Saves karaf.log to the ${dst_dir} for members in given list or all. Return None.
572 Safe_With_Ssh_To_List_Or_All_Run_Keyword ${member_index_list} SSHKeywords.Execute_Command_Should_Pass cp ${karaf_home}/data/log/karaf.log ${dst_dir}
574 Restore_Karaf_Log_On_List_Or_All
575 [Arguments] ${member_index_list}=${EMPTY} ${src_dir}=/tmp ${karaf_home}=${KARAF_HOME}
576 [Documentation] Places stored karaf.log to the ${karaf_home}/data/log for members in given list or all. Return None.
577 Safe_With_Ssh_To_List_Or_All_Run_Keyword ${member_index_list} SSHKeywords.Execute_Command_Should_Pass cp ${src_dir}/karaf.log ${karaf_home}/data/log/
579 ClusterManagement__Clean_Directories
580 [Arguments] ${relative_path_list} ${karaf_home}
581 [Documentation] For each relative path, remove files with respect to ${karaf_home}. Return None.
582 : FOR ${relative_path} IN @{relative_path_list}
583 \ SSHLibrary.Execute_Command rm -rf ${karaf_home}${/}${relative_path}
585 Put_As_Json_And_Check_Member_List_Or_All
586 [Arguments] ${uri} ${data} ${member_index} ${member_index_list}=${EMPTY}
587 [Documentation] Send a PUT with the supplied uri ${uri} and body ${data} to member ${member_index}.
588 ... Then check data is replicated in all or some members defined in ${member_index_list}.
589 ${response_text} = Put_As_Json_To_Member uri=${uri} data=${data} member_index=${member_index}
590 Wait Until Keyword Succeeds 5s 1s Check_Json_Member_List_Or_All uri=${uri} expected_data=${data} member_index_list=${member_index_list}
591 [Return] ${response_text}
593 Put_As_Json_To_Member
594 [Arguments] ${uri} ${data} ${member_index}
595 [Documentation] Send a PUT with the supplied uri and data to member ${member_index}.
596 ${session} = Resolve_Http_Session_For_Member member_index=${member_index}
597 ${response_text} = TemplatedRequests.Put_As_Json_To_Uri uri=${uri} data=${data} session=${session}
598 [Return] ${response_text}
600 Post_As_Json_To_Member
601 [Arguments] ${uri} ${data} ${member_index}
602 [Documentation] Send a POST with the supplied uri and data to member ${member_index}.
603 ${session} = Resolve_Http_Session_For_Member member_index=${member_index}
604 ${response_text} = TemplatedRequests.Post_As_Json_To_Uri uri=${uri} data=${data} session=${session}
605 [Return] ${response_text}
607 Delete_And_Check_Member_List_Or_All
608 [Arguments] ${uri} ${member_index} ${member_index_list}=${EMPTY}
609 [Documentation] Send a DELETE with the supplied uri to the member ${member_index}.
610 ... Then check the data is removed from all members in ${member_index_list}.
611 ${response_text} = Delete_From_Member ${uri} ${member_index}
612 BuiltIn.Wait_Until_Keyword_Succeeds 5s 1s Check_No_Content_Member_List_Or_All uri=${uri} member_index_list=${member_index_list}
613 [Return] ${response_text}
616 [Arguments] ${uri} ${member_index}
617 [Documentation] Send a DELETE with the supplied uri to member ${member_index}.
618 ${session} = Resolve_Http_Session_For_Member member_index=${member_index}
619 ${response_text} = TemplatedRequests.Delete_From_Uri uri=${uri} session=${session}
620 [Return] ${response_text}
622 Check_Json_Member_List_Or_All
623 [Arguments] ${uri} ${expected_data} ${member_index_list}=${EMPTY}
624 [Documentation] Send a GET with the supplied uri to all or some members defined in ${member_index_list}.
625 ... Then check received data is = ${expected data}.
626 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
627 : FOR ${index} IN @{index_list}
628 \ ${data} = Get_From_Member uri=${uri} member_index=${index}
629 \ TemplatedRequests.Normalize_Jsons_And_Compare ${expected_data} ${data}
631 Check_Item_Occurrence_Member_List_Or_All
632 [Arguments] ${uri} ${dictionary} ${member_index_list}=${EMPTY}
633 [Documentation] Send a GET with the supplied uri to all or some members defined in ${member_index_list}.
634 ... Then check received for occurrences of items expressed in a dictionary ${dictionary}.
635 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
636 : FOR ${index} IN @{index_list}
637 \ ${data} = Get_From_Member uri=${uri} member_index=${index}
638 \ Utils.Check Item Occurrence ${data} ${dictionary}
640 Check_No_Content_Member_List_Or_All
641 [Arguments] ${uri} ${member_index_list}=${EMPTY}
642 [Documentation] Send a GET with the supplied uri to all or some members defined in ${member_index_list}.
643 ... Then check there is no content.
644 ${index_list} = List_Indices_Or_All given_list=${member_index_list}
645 : FOR ${index} IN @{index_list}
646 \ ${session} = Resolve_Http_Session_For_Member member_index=${index}
647 \ Utils.No_Content_From_URI ${session} ${uri}
650 [Arguments] ${uri} ${member_index} ${access}=${ACCEPT_EMPTY}
651 [Documentation] Send a GET with the supplied uri to member ${member_index}.
652 ${session} = Resolve_Http_Session_For_Member member_index=${member_index}
653 ${response_text} = TemplatedRequests.Get_From_Uri uri=${uri} accept=${access} session=${session}
654 [Return] ${response_text}
656 Resolve_IP_Address_For_Member
657 [Arguments] ${member_index}
658 [Documentation] Return node IP address of given index.
659 ${ip_address} = Collections.Get From Dictionary dictionary=${ClusterManagement__index_to_ip_mapping} key=${member_index}
660 [Return] ${ip_address}
662 Resolve_Http_Session_For_Member
663 [Arguments] ${member_index}
664 [Documentation] Return RequestsLibrary session alias pointing to node of given index.
665 ${session} = BuiltIn.Set_Variable ClusterManagement__session_${member_index}
668 Resolve_Shard_Type_Class
669 [Arguments] ${shard_type}
670 [Documentation] Simple lookup for class name corresponding to desired type.
671 BuiltIn.Run_Keyword_If '${shard_type}' == 'config' BuiltIn.Return_From_Keyword DistributedConfigDatastore
672 ... ELSE IF '${shard_type}' == 'operational' BuiltIn.Return_From_Keyword DistributedOperationalDatastore
673 BuiltIn.Fail Unrecognized shard type: ${shard_type}
675 ClusterManagement__Build_List
676 [Arguments] ${member}
677 ${member_int} = BuiltIn.Convert_To_Integer ${member}
678 ${index_list} = BuiltIn.Create_List ${member_int}
679 [Return] ${index_list}
681 ClusterManagement__Parse_Sync_Status
682 [Arguments] ${shard_manager_text}
683 [Documentation] Return sync status parsed out of given text. Called twice by Get_Sync_Status_Of_Member.
684 BuiltIn.Log ${shard_manager_text}
685 ${manager_object} = RequestsLibrary.To_Json ${shard_manager_text}
686 ${value_object} = Collections.Get_From_Dictionary dictionary=${manager_object} key=value
687 ${sync_status} = Collections.Get_From_Dictionary dictionary=${value_object} key=SyncStatus
688 [Return] ${sync_status}
691 [Documentation] Create a new list of all indices.
692 BuiltIn.Run_Keyword_And_Return List_Indices_Or_All
695 [Arguments] ${given_list}=${EMPTY}
696 [Documentation] Utility to allow \${EMPTY} as default argument value, as the internal list is computed at runtime.
697 ... This keyword always returns a (shallow) copy of given or default list,
698 ... so operations with the returned list should not affect other lists.
699 ... Also note that this keyword does not consider empty list to be \${EMPTY}.
700 ${return_list_reference} = BuiltIn.Set_Variable_If """${given_list}""" != "" ${given_list} ${ClusterManagement__member_index_list}
701 ${return_list_copy} = BuiltIn.Create_List @{return_list_reference}
702 [Return] ${return_list_copy}
704 List_Indices_Minus_Member
705 [Arguments] ${member_index} ${member_index_list}=${EMPTY}
706 [Documentation] Create a new list which contains indices from ${member_index_list} (or all) without ${member_index}.
707 ${index_list} = List_Indices_Or_All ${member_index_list}
708 Collections.Remove Values From List ${index_list} ${member_index}
709 [Return] ${index_list}
711 ClusterManagement__Compute_Derived_Variables
712 [Arguments] ${int_of_members}
713 [Documentation] Construct index list, session list and IP mapping, publish them as suite variables.
714 @{member_index_list} = BuiltIn.Create_List
715 @{session_list} = BuiltIn.Create_List
716 &{index_to_ip_mapping} = BuiltIn.Create_Dictionary
717 : FOR ${index} IN RANGE 1 ${int_of_members+1}
718 \ ClusterManagement__Include_Member_Index ${index} ${member_index_list} ${session_list} ${index_to_ip_mapping}
719 BuiltIn.Set_Suite_Variable \${ClusterManagement__member_index_list} ${member_index_list}
720 BuiltIn.Set_Suite_Variable \${ClusterManagement__index_to_ip_mapping} ${index_to_ip_mapping}
721 BuiltIn.Set_Suite_Variable \${ClusterManagement__session_list} ${session_list}
723 ClusterManagement__Include_Member_Index
724 [Arguments] ${index} ${member_index_list} ${session_list} ${index_to_ip_mapping}
725 [Documentation] Add a corresponding item based on index into the last three arguments.
726 ... Create the Http session whose alias is added to list.
727 Collections.Append_To_List ${member_index_list} ${index}
728 ${member_ip} = BuiltIn.Set_Variable ${ODL_SYSTEM_${index}_IP}
729 # ${index} is int (not string) so "key=value" syntax does not work in the following line.
730 Collections.Set_To_Dictionary ${index_to_ip_mapping} ${index} ${member_ip}
731 # Http session, with ${AUTH}, without headers.
732 ${session_alias} = Resolve_Http_Session_For_Member member_index=${index}
733 RequestsLibrary.Create_Session ${session_alias} http://${member_ip}:${RESTCONFPORT} auth=${AUTH} max_retries=0
734 Collections.Append_To_List ${session_list} ${session_alias}
736 Sync_Status_Should_Be_False
737 [Arguments] ${controller_index}
738 [Documentation] Verify that cluster node is not in sync with others
739 ${status} Get_Sync_Status_Of_Member ${controller_index}
740 BuiltIn.Should_Not_Be_True ${status}
742 Sync_Status_Should_Be_True
743 [Arguments] ${controller_index}
744 [Documentation] Verify that cluster node is in sync with others
745 ${status} Get_Sync_Status_Of_Member ${controller_index}
746 BuiltIn.Should_Be_True ${status}