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