csit/libraries/ClusterManagement.robot

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