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