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