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 ...               Requirements:
  18 ...               odl-jolokia is assumed to be installed.
  19 ...
  20 ...               Keywords are ordered as follows:
  21 ...               - Cluster Setup
  22 ...               - Shard state, leader and followers
  23 ...               - Entity Owner, candidates and successors
  24 ...               - Kill and Start Member
  25 ...               - Isolate and Rejoin Member
  26 ...               - Run Commands On Member
  27 ...               - REST requests and checks on Members
  28 ...
  29 ...               TODO: Unify capitalization of Leaders and Followers.
  30 Library           RequestsLibrary    # for Create_Session and To_Json
  31 Library           Collections
  32 Resource          ${CURDIR}/CompareStream.robot
  33 Resource          ${CURDIR}/TemplatedRequests.robot    # for Get_As_Json_From_Uri
  34 Resource          ${CURDIR}/Utils.robot    # for Run_Command_On_Controller
  35
  36 *** Variables ***
  37 ${JAVA_HOME}      ${EMPTY}    # releng/builder scripts should provide correct value
  38 ${JOLOKIA_CONF_SHARD_MANAGER_URI}    jolokia/read/org.opendaylight.controller:Category=ShardManager,name=shard-manager-config,type=DistributedConfigDatastore
  39 ${JOLOKIA_OPER_SHARD_MANAGER_URI}    jolokia/read/org.opendaylight.controller:Category=ShardManager,name=shard-manager-operational,type=DistributedOperationalDatastore
  40 ${JOLOKIA_READ_URI}    jolokia/read/org.opendaylight.controller
  41 ${ENTITY_OWNER_URI}    restconf/operational/entity-owners:entity-owners
  42 ${RESTCONF_MODULES_DIR}    ${CURDIR}/../variables/restconf/modules
  43
  44 *** Keywords ***
  45 ClusterManagement_Setup
  46     [Documentation]    Detect repeated call, or detect number of members and initialize derived suite variables.
  47     # Avoid multiple initialization by several downstream libraries.
  48     ${already_done} =    BuiltIn.Get_Variable_Value    \${ClusterManagement__has_setup_run}    False
  49     BuiltIn.Return_From_Keyword_If    ${already_done}
  50     BuiltIn.Set_Suite_Variable    \${ClusterManagement__has_setup_run}    True
  51     ${cluster_size} =    BuiltIn.Get_Variable_Value    \${NUM_ODL_SYSTEM}    1
  52     ${status}    ${possibly_int_of_members} =    BuiltIn.Run_Keyword_And_Ignore_Error    BuiltIn.Convert_To_Integer    ${cluster_size}
  53     ${int_of_members} =    BuiltIn.Set_Variable_If    '${status}' != 'PASS'    ${1}    ${possibly_int_of_members}
  54     ClusterManagement__Compute_Derived_Variables    int_of_members=${int_of_members}
  55
  56 Check_Cluster_Is_In_Sync
  57     [Arguments]    ${member_index_list}=${EMPTY}
  58     [Documentation]    Fail if no-sync is detected on a member from list (or any).
  59     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${member_index_list}
  60     : FOR    ${index}    IN    @{index_list}    # usually: 1, 2, 3.
  61     \    ${status} =    Get_Sync_Status_Of_Member    member_index=${index}
  62     \    BuiltIn.Continue_For_Loop_If    'True' == '${status}'
  63     \    BuiltIn.Fail    Index ${index} has incorrect status: ${status}
  64
  65 Get_Sync_Status_Of_Member
  66     [Arguments]    ${member_index}
  67     [Documentation]    Obtain IP, two GETs from jolokia URIs, return combined sync status as string.
  68     ${session} =    Resolve_Http_Session_For_Member    member_index=${member_index}
  69     ${conf_text} =    TemplatedRequests.Get_As_Json_From_Uri    uri=${JOLOKIA_CONF_SHARD_MANAGER_URI}    session=${session}
  70     ${conf_status} =    ClusterManagement__Parse_Sync_Status    shard_manager_text=${conf_text}
  71     BuiltIn.Return_From_Keyword_If    'False' == ${conf_status}    False
  72     ${oper_text} =    TemplatedRequests.Get_As_Json_From_Uri    uri=${JOLOKIA_OPER_SHARD_MANAGER_URI}    session=${session}
  73     ${oper_status} =    ClusterManagement__Parse_Sync_Status    shard_manager_text=${oper_text}
  74     [Return]    ${oper_status}
  75
  76 Verify_Leader_Exists_For_Each_Shard
  77     [Arguments]    ${shard_name_list}    ${shard_type}=operational    ${member_index_list}=${EMPTY}    ${verify_restconf}=True
  78     [Documentation]    For each shard name, call Get_Leader_And_Followers_For_Shard.
  79     ...    Not much logic there, but single Keyword is useful when using BuiltIn.Wait_Until_Keyword_Succeeds.
  80     : FOR    ${shard_name}    IN    @{shard_name_list}
  81     \    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}
  82
  83 Get_Leader_And_Followers_For_Shard
  84     [Arguments]    ${shard_name}=default    ${shard_type}=operational    ${validate}=True    ${member_index_list}=${EMPTY}    ${verify_restconf}=True
  85     [Documentation]    Get role lists, validate there is one leader, return the leader and list of followers.
  86     ...    Optionally, issue GET to a simple restconf URL to make sure subsequent operations will not encounter 503.
  87     ${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}
  88     ...    verify_restconf=${verify_restconf}
  89     ${leader_count} =    BuiltIn.Get_Length    ${leader_list}
  90     BuiltIn.Run_Keyword_If    ${leader_count} < 1    BuiltIn.Fail    No leader found.
  91     BuiltIn.Length_Should_Be    ${leader_list}    ${1}    Too many Leaders.
  92     ${leader} =    Collections.Get_From_List    ${leader_list}    0
  93     [Return]    ${leader}    ${follower_list}
  94
  95 Get_State_Info_For_Shard
  96     [Arguments]    ${shard_name}=default    ${shard_type}=operational    ${validate}=False    ${member_index_list}=${EMPTY}    ${verify_restconf}=False
  97     [Documentation]    Return lists of Leader and Follower member indices from a given member index list
  98     ...    (or from the full list if empty). If \${shard_type} is not 'config', 'operational' is assumed.
  99     ...    If \${validate}, Fail if raft state is not Leader or Follower (for example on Candidate).
 100     ...    The biggest difference from Get_Leader_And_Followers_For_Shard
 101     ...    is that no check on number of Leaders is performed.
 102     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${member_index_list}
 103     # TODO: Support alternative capitalization of 'config'?
 104     ${ds_type} =    BuiltIn.Set_Variable_If    '${shard_type}' != 'config'    operational    config
 105     ${leader_list} =    BuiltIn.Create_List
 106     ${follower_list} =    BuiltIn.Create_List
 107     : FOR    ${index}    IN    @{index_list}    # usually: 1, 2, 3.
 108     \    ${raft_state} =    Get_Raft_State_Of_Shard_At_Member    shard_name=${shard_name}    shard_type=${ds_type}    member_index=${index}    verify_restconf=${verify_restconf}
 109     \    BuiltIn.Run_Keyword_If    'Follower' == '${raft_state}'    Collections.Append_To_List    ${follower_list}    ${index}
 110     \    ...    ELSE IF    'Leader' == '${raft_state}'    Collections.Append_To_List    ${leader_list}    ${index}
 111     \    ...    ELSE IF    ${validate}    BuiltIn.Fail    Unrecognized Raft state: ${raft_state}
 112     [Return]    ${leader_list}    ${follower_list}
 113
 114 Get_Raft_State_Of_Shard_At_Member
 115     [Arguments]    ${shard_name}    ${shard_type}    ${member_index}    ${verify_restconf}=False
 116     [Documentation]    Send request to Jolokia on indexed member, return extracted Raft status.
 117     ...    Optionally, check restconf works.
 118     ${session} =    Resolve_Http_Session_For_Member    member_index=${member_index}
 119     # TODO: Does the used URI tend to generate large data which floods log.html?
 120     BuiltIn.Run_Keyword_If    ${verify_restconf}    TemplatedRequests.Get_As_Json_Templated    session=${session}    folder=${RESTCONF_MODULES_DIR}    verify=False
 121     ${type_class} =    Resolve_Shard_Type_Class    shard_type=${shard_type}
 122     ${uri} =    BuiltIn.Set_Variable    ${JOLOKIA_READ_URI}:Category=Shards,name=member-${member_index}-shard-${shard_name}-${shard_type},type=${type_class}
 123     ${data_text} =    TemplatedRequests.Get_As_Json_From_Uri    uri=${uri}    session=${session}
 124     ${data_object} =    RequestsLibrary.To_Json    ${data_text}
 125     ${value} =    Collections.Get_From_Dictionary    ${data_object}    value
 126     ${raft_state} =    Collections.Get_From_Dictionary    ${value}    RaftState
 127     [Return]    ${raft_state}
 128
 129 Verify_Owner_And_Successors_For_Device
 130     [Arguments]    ${device_name}    ${device_type}    ${member_index}    ${candidate_list}=${EMPTY}
 131     [Documentation]    Returns the owner and successors for the SB device ${device_name} of type ${device_type}. Request is sent to member ${member_index}.
 132     ...    For Boron and beyond, candidates are not removed on node down or isolation,
 133     ...    so this keyword expects candidates to be all members from Boron on.
 134     ...    Extra check is done to verify owner and successors are within the ${candidate_list}. This KW is useful when combined with WUKS.
 135     ...    ${candidate_list} minus owner is returned as ${successor list}.
 136     ...    Users can still use Get_Owner_And_Successors_For_Device if they are interested in downed candidates,
 137     ...    or for testing heterogeneous clusters.
 138     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${candidate_list}
 139     ${owner}    ${successor_list} =    Get_Owner_And_Successors_For_Device    device_name=${device_name}    device_type=${device_type}    member_index=${member_index}
 140     Collections.List_Should_Contain_Value    ${index_list}    ${owner}    Owner ${owner} is not in candidate list ${index_list}
 141     ${expected_successor_list} =    BuiltIn.Run Keyword If    '${ODL_STREAM}' != 'beryllium'    BuiltIn.Create_List    @{ClusterManagement__member_index_list}
 142     ...    ELSE    BuiltIn.Create_List    @{index_list}
 143     Collections.Remove_Values_From_List    ${expected_successor_list}    ${owner}
 144     Collections.Lists_Should_Be_Equal    ${expected_successor_list}    ${successor_list}    Successor list ${successor_list} is not the came as expected ${expected_successor_list}
 145     ${reduced_successor_list} =    BuiltIn.Create_List    @{index_list}
 146     Collections.Remove_Values_From_List    ${reduced_successor_list}    ${owner}
 147     [Return]    ${owner}    ${reduced_successor_list}
 148
 149 Get_Owner_And_Successors_For_Device
 150     [Arguments]    ${device_name}    ${device_type}    ${member_index}
 151     [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}.
 152     ...    Successors are those device candidates not elected as owner. The list of successors = (list of candidates) - (owner).
 153     ${owner}    ${candidate_list} =    Get_Owner_And_Candidates_For_Device    device_name=${device_name}    device_type=${device_type}    member_index=${member_index}
 154     ${successor_list} =    BuiltIn.Create_List    @{candidate_list}
 155     Collections.Remove_Values_From_List    ${successor_list}    ${owner}
 156     [Return]    ${owner}    ${successor_list}
 157
 158 Get_Owner_And_Candidates_For_Device
 159     [Arguments]    ${device_name}    ${device_type}    ${member_index}
 160     [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}.
 161     ...    Candidates are all members that register to own a device, so the list of candiates includes the owner.
 162     ${session} =    Resolve_Http_Session_For_Member    member_index=${member_index}
 163     ${data} =    TemplatedRequests.Get_As_Json_From_Uri    uri=${ENTITY_OWNER_URI}    session=${session}
 164     ${candidate_list} =    BuiltIn.Create_List
 165     ${entity_type} =    BuiltIn.Set_Variable_If    '${device_type}' == 'netconf'    netconf-node/${device_name}    ${device_type}
 166     ${clear_data} =    BuiltIn.Run_Keyword_If    '${device_type}' == 'openflow' or '${device_type}' == 'netconf'    Extract_OpenFlow_Device_Data    ${data}
 167     ...    ELSE IF    '${device_type}' == 'ovsdb'    Extract_Ovsdb_Device_Data    ${data}
 168     ...    ELSE IF    '${device_type}' == 'org.opendaylight.mdsal.ServiceEntityType'    Extract_Service_Entity_Type    ${data}
 169     ...    ELSE    Fail    Not recognized device type: ${device_type}
 170     ${json} =    RequestsLibrary.To_Json    ${clear_data}
 171     ${entity_type_list} =    Collections.Get_From_Dictionary    &{json}[entity-owners]    entity-type
 172     ${entity_type_index} =    Utils.Get_Index_From_List_Of_Dictionaries    ${entity_type_list}    type    ${entity_type}
 173     BuiltIn.Should_Not_Be_Equal    ${entity_type_index}    -1    No Entity Owner found for ${device_type}
 174     ${entity_list} =    Collections.Get_From_Dictionary    @{entity_type_list}[${entity_type_index}]    entity
 175     ${entity_index} =    Utils.Get_Index_From_List_Of_Dictionaries    ${entity_list}    id    ${device_name}
 176     BuiltIn.Should Not Be Equal    ${entity_index}    -1    Device ${device_name} not found in Entity Owner ${device_type}
 177     ${entity_owner} =    Collections.Get_From_Dictionary    @{entity_list}[${entity_index}]    owner
 178     BuiltIn.Should_Not_Be_Empty    ${entity_owner}    No owner found for ${device_name}
 179     ${owner} =    String.Replace_String    ${entity_owner}    member-    ${EMPTY}
 180     ${owner} =    BuiltIn.Convert_To_Integer    ${owner}
 181     ${entity_candidates_list} =    Collections.Get_From_Dictionary    @{entity_list}[${entity_index}]    candidate
 182     : FOR    ${entity_candidate}    IN    @{entity_candidates_list}
 183     \    ${candidate} =    String.Replace_String    &{entity_candidate}[name]    member-    ${EMPTY}
 184     \    ${candidate} =    BuiltIn.Convert_To_Integer    ${candidate}
 185     \    Collections.Append_To_List    ${candidate_list}    ${candidate}
 186     [Return]    ${owner}    ${candidate_list}
 187
 188 Extract_Service_Entity_Type
 189     [Arguments]    ${data}
 190     [Documentation]    Remove superfluous device data from Entity Owner printout.
 191     ${clear_data} =    String.Replace_String    ${data}    /odl-general-entity:entity[odl-general-entity:name='Uri [_value=    ${EMPTY}
 192     ${clear_data} =    String.Replace_String    ${clear_data}    ]-service-group']    ${EMPTY}
 193     Log    ${clear_data}
 194     [Return]    ${clear_data}
 195
 196 Extract_OpenFlow_Device_Data
 197     [Arguments]    ${data}
 198     [Documentation]    Remove superfluous OpenFlow device data from Entity Owner printout.
 199     ${clear_data} =    BuiltIn.Run Keyword If    '${ODL_STREAM}' != 'beryllium' and '${ODL_OF_PLUGIN}' == 'lithium'    String.Replace_String    ${data}    org.opendaylight.mdsal.ServiceEntityType    openflow
 200     ...    ELSE    BuiltIn.Set_Variable    ${data}
 201     ${clear_data} =    String.Replace_String    ${clear_data}    /odl-general-entity:entity[odl-general-entity:name='    ${EMPTY}
 202     ${clear_data} =    String.Replace_String    ${clear_data}    /general-entity:entity[general-entity:name='    ${EMPTY}
 203     ${clear_data} =    String.Replace_String    ${clear_data}    ']    ${EMPTY}
 204     Log    ${clear_data}
 205     [Return]    ${clear_data}
 206
 207 Extract_Ovsdb_Device_Data
 208     [Arguments]    ${data}
 209     [Documentation]    Remove superfluous OVSDB device data from Entity Owner printout.
 210     ${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}
 211     ${clear_data} =    String.Replace_String    ${clear_data}    ']    ${EMPTY}
 212     Log    ${clear_data}
 213     [Return]    ${clear_data}
 214
 215 Kill_Single_Member
 216     [Arguments]    ${member}    ${original_index_list}=${EMPTY}    ${confirm}=True
 217     [Documentation]    Convenience keyword that kills the specified member of the cluster.
 218     ...    The KW will return a list of available members: \${updated index_list}=\${original_index_list}-\${member}
 219     ${index_list} =    ClusterManagement__Build_List    ${member}
 220     ${updated_index_list} =    Kill_Members_From_List_Or_All    ${index_list}    ${original_index_list}    ${confirm}
 221     [Return]    ${updated_index_list}
 222
 223 Kill_Members_From_List_Or_All
 224     [Arguments]    ${member_index_list}=${EMPTY}    ${original_index_list}=${EMPTY}    ${confirm}=True
 225     [Documentation]    If the list is empty, kill all ODL instances. Otherwise, kill members based on \${kill_index_list}
 226     ...    If \${confirm} is True, sleep 1 second and verify killed instances are not there anymore.
 227     ...    The KW will return a list of available members: \${updated index_list}=\${original_index_list}-\${member_index_list}
 228     ${kill_index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${member_index_list}
 229     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${original_index_list}
 230     ${command} =    BuiltIn.Set_Variable    ps axf | grep karaf | grep -v grep | awk '{print \"kill -9 \" $1}' | sh
 231     Run_Command_On_List_Or_All    command=${command}    member_index_list=${member_index_list}
 232     ${updated_index_list} =    BuiltIn.Create_List    @{index_list}
 233     Collections.Remove_Values_From_List    ${updated_index_list}    @{kill_index_list}
 234     BuiltIn.Return_From_Keyword_If    not ${confirm}    ${updated_index_list}
 235     # TODO: Convert to WUKS with configurable timeout if it turns out 1 second is not enough.
 236     BuiltIn.Sleep    1s    Kill -9 closes open files, which may take longer than ssh overhead, but not long enough to warrant WUKS.
 237     : FOR    ${index}    IN    @{kill_index_list}
 238     \    Verify_Karaf_Is_Not_Running_On_Member    member_index=${index}
 239     [Return]    ${updated_index_list}
 240
 241 Start_Single_Member
 242     [Arguments]    ${member}    ${wait_for_sync}=True    ${timeout}=300s
 243     [Documentation]    Convenience keyword that starts the specified member of the cluster.
 244     ${index_list} =    ClusterManagement__Build_List    ${member}
 245     Start_Members_From_List_Or_All    ${index_list}    ${wait_for_sync}    ${timeout}
 246
 247 Start_Members_From_List_Or_All
 248     [Arguments]    ${member_index_list}=${EMPTY}    ${wait_for_sync}=True    ${timeout}=300s    ${karaf_home}=${WORKSPACE}${/}${BUNDLEFOLDER}    ${export_java_home}=${JAVA_HOME}
 249     [Documentation]    If the list is empty, start all cluster members. Otherwise, start members based on present indices.
 250     ...    If ${wait_for_sync}, wait for cluster sync on listed members.
 251     ...    Optionally karaf_home can be overriden. Optionally specific JAVA_HOME is used for starting.
 252     ${base_command} =    BuiltIn.Set_Variable    ${karaf_home}/bin/start
 253     ${command} =    BuiltIn.Set_Variable_If    "${export_java_home}"    export JAVA_HOME="${export_java_home}"; ${base_command}    ${base_command}
 254     Run_Command_On_List_Or_All    command=${command}    member_index_list=${member_index_list}
 255     BuiltIn.Return_From_Keyword_If    not ${wait_for_sync}
 256     BuiltIn.Wait_Until_Keyword_Succeeds    ${timeout}    1s    Check_Cluster_Is_In_Sync    member_index_list=${member_index_list}
 257     # TODO: Do we also want to check Shard Leaders here?
 258
 259 Clean_Journals_And_Snapshots_On_List_Or_All
 260     [Arguments]    ${member_index_list}=${EMPTY}    ${karaf_home}=${WORKSPACE}${/}${BUNDLEFOLDER}
 261     [Documentation]    Delete journal and snapshots directories on every node listed (or all).
 262     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${member_index_list}
 263     ${command} =    Set Variable    rm -rf "${karaf_home}/journal" "${karaf_home}/snapshots"
 264     : FOR    ${index}    IN    @{index_list}    # usually: 1, 2, 3.
 265     \    Run_Command_On_Member    command=${command}    member_index=${index}
 266
 267 Verify_Karaf_Is_Not_Running_On_Member
 268     [Arguments]    ${member_index}
 269     [Documentation]    Fail if non-zero karaf instances are counted on member of given index.
 270     ${count} =    Count_Running_Karafs_On_Member    member_index=${member_index}
 271     BuiltIn.Should_Be_Equal    0    ${count}    Found running Karaf count: ${count}
 272
 273 Verify_Single_Karaf_Is_Running_On_Member
 274     [Arguments]    ${member_index}
 275     [Documentation]    Fail if number of karaf instances on member of given index is not one.
 276     ${count} =    Count_Running_Karafs_On_Member    member_index=${member_index}
 277     BuiltIn.Should_Be_Equal    1    ${count}    Wrong number of Karafs running: ${count}
 278
 279 Count_Running_Karafs_On_Member
 280     [Arguments]    ${member_index}
 281     [Documentation]    Remotely execute grep for karaf process, return count as string.
 282     ${command} =    BuiltIn.Set_Variable    ps axf | grep karaf | grep -v grep | wc -l
 283     ${count} =    Run_Command_On_Member    command=${command}    member_index=${member_index}
 284     [Return]    ${count}
 285
 286 Isolate_Member_From_List_Or_All
 287     [Arguments]    ${isolate_member_index}    ${member_index_list}=${EMPTY}
 288     [Documentation]    If the list is empty, isolate member from all ODL instances. Otherwise, isolate member based on present indices.
 289     ...    The KW will return a list of available members: \${updated index_list}=\${member_index_list}-\${isolate_member_index}
 290     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${member_index_list}
 291     ${source} =    Collections.Get_From_Dictionary    ${ClusterManagement__index_to_ip_mapping}    ${isolate_member_index}
 292     : FOR    ${index}    IN    @{index_list}
 293     \    ${destination} =    Collections.Get_From_Dictionary    ${ClusterManagement__index_to_ip_mapping}    ${index}
 294     \    ${command} =    BuiltIn.Set_Variable    sudo /sbin/iptables -I OUTPUT -p all --source ${source} --destination ${destination} -j DROP
 295     \    BuiltIn.Run_Keyword_If    "${index}" != "${isolate_member_index}"    Run_Command_On_Member    command=${command}    member_index=${isolate_member_index}
 296     ${command} =    BuiltIn.Set_Variable    sudo /sbin/iptables -L -n
 297     ${output} =    Run_Command_On_Member    command=${command}    member_index=${isolate_member_index}
 298     BuiltIn.Log    ${output}
 299     ${updated_index_list} =    BuiltIn.Create_List    @{index_list}
 300     Collections.Remove_Values_From_List    ${updated_index_list}    ${isolate_member_index}
 301     [Return]    ${updated_index_list}
 302
 303 Rejoin_Member_From_List_Or_All
 304     [Arguments]    ${rejoin_member_index}    ${member_index_list}=${EMPTY}
 305     [Documentation]    If the list is empty, rejoin member from all ODL instances. Otherwise, rejoin member based on present indices.
 306     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${member_index_list}
 307     ${source} =    Collections.Get_From_Dictionary    ${ClusterManagement__index_to_ip_mapping}    ${rejoin_member_index}
 308     : FOR    ${index}    IN    @{index_list}
 309     \    ${destination} =    Collections.Get_From_Dictionary    ${ClusterManagement__index_to_ip_mapping}    ${index}
 310     \    ${command} =    BuiltIn.Set_Variable    sudo /sbin/iptables -D OUTPUT -p all --source ${source} --destination ${destination} -j DROP
 311     \    BuiltIn.Run_Keyword_If    "${index}" != "${rejoin_member_index}"    Run_Command_On_Member    command=${command}    member_index=${rejoin_member_index}
 312     ${command} =    BuiltIn.Set_Variable    sudo /sbin/iptables -L -n
 313     ${output} =    Run_Command_On_Member    command=${command}    member_index=${rejoin_member_index}
 314     BuiltIn.Log    ${output}
 315
 316 Flush_Iptables_From_List_Or_All
 317     [Arguments]    ${member_index_list}=${EMPTY}
 318     [Documentation]    If the list is empty, flush IPTables in all ODL instances. Otherwise, flush member based on present indices.
 319     ${command} =    BuiltIn.Set_Variable    sudo iptables -v -F
 320     ${output} =    Run_Command_On_List_Or_All    command=${command}    member_index_list=${member_index_list}
 321
 322 Run_Command_On_List_Or_All
 323     [Arguments]    ${command}    ${member_index_list}=${EMPTY}
 324     [Documentation]    Cycle through indices (or all), run command on each.
 325     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${member_index_list}
 326     : FOR    ${index}    IN    @{index_list}
 327     \    Run_Command_On_Member    command=${command}    member_index=${index}
 328
 329 Run_Karaf_Command_On_List_Or_All
 330     [Arguments]    ${command}    ${member_index_list}=${EMPTY}
 331     [Documentation]    Cycle through indices (or all), run karaf command on each.
 332     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${member_index_list}
 333     : FOR    ${index}    IN    @{index_list}
 334     \    ${member_ip} =    Collections.Get_From_Dictionary    dictionary=${ClusterManagement__index_to_ip_mapping}    key=${index}
 335     \    KarafKeywords.Issue Command On Karaf Console    ${command}    ${member_ip}
 336
 337 Run_Command_On_Member
 338     [Arguments]    ${command}    ${member_index}
 339     [Documentation]    Obtain IP, call Utils and return output. This does not preserve active ssh session.
 340     ${member_ip} =    Collections.Get_From_Dictionary    dictionary=${ClusterManagement__index_to_ip_mapping}    key=${member_index}
 341     ${output} =    Utils.Run_Command_On_Controller    ${member_ip}    ${command}
 342     [Return]    ${output}
 343
 344 Put_As_Json_And_Check_Member_List_Or_All
 345     [Arguments]    ${uri}    ${data}    ${member_index}    ${member_index_list}=${EMPTY}
 346     [Documentation]    Send a PUT with the supplied uri ${uri} and body ${data} to member ${member_index}.
 347     ...    Then check data is replicated in all or some members defined in ${member_index_list}.
 348     ${response_text} =    Put_As_Json_To_Member    uri=${uri}    data=${data}    member_index=${member_index}
 349     Wait Until Keyword Succeeds    5s    1s    Check_Json_Member_List_Or_All    uri=${uri}    expected_data=${data}    member_index_list=${member_index_list}
 350     [Return]    ${response_text}
 351
 352 Put_As_Json_To_Member
 353     [Arguments]    ${uri}    ${data}    ${member_index}
 354     [Documentation]    Send a PUT with the supplied uri and data to member ${member_index}.
 355     ${session} =    Resolve_Http_Session_For_Member    member_index=${member_index}
 356     ${response_text} =    TemplatedRequests.Put_As_Json_To_Uri    uri=${uri}    data=${data}    session=${session}
 357     [Return]    ${response_text}
 358
 359 Post_As_Json_To_Member
 360     [Arguments]    ${uri}    ${data}    ${member_index}
 361     [Documentation]    Send a POST with the supplied uri and data to member ${member_index}.
 362     ${session} =    Resolve_Http_Session_For_Member    member_index=${member_index}
 363     ${response_text} =    TemplatedRequests.Post_As_Json_To_Uri    uri=${uri}    data=${data}    session=${session}
 364     [Return]    ${response_text}
 365
 366 Delete_And_Check_Member_List_Or_All
 367     [Arguments]    ${uri}    ${member_index}    ${member_index_list}=${EMPTY}
 368     [Documentation]    Send a DELETE with the supplied uri to the member ${member_index}.
 369     ...    Then check the data is removed from all members in ${member_index_list}.
 370     ${response_text} =    Delete_From_Member    ${uri}    ${member_index}
 371     BuiltIn.Wait_Until_Keyword_Succeeds    5s    1s    Check_No_Content_Member_List_Or_All    uri=${uri}    member_index_list=${member_index_list}
 372     [Return]    ${response_text}
 373
 374 Delete_From_Member
 375     [Arguments]    ${uri}    ${member_index}
 376     [Documentation]    Send a DELETE with the supplied uri to member ${member_index}.
 377     ${session} =    Resolve_Http_Session_For_Member    member_index=${member_index}
 378     ${response_text} =    TemplatedRequests.Delete_From_Uri    uri=${uri}    session=${session}
 379     [Return]    ${response_text}
 380
 381 Check_Json_Member_List_Or_All
 382     [Arguments]    ${uri}    ${expected_data}    ${member_index_list}=${EMPTY}
 383     [Documentation]    Send a GET with the supplied uri to all or some members defined in ${member_index_list}.
 384     ...    Then check received data is = ${expected data}.
 385     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${member_index_list}
 386     : FOR    ${index}    IN    @{index_list}
 387     \    ${data} =    Get_From_Member    uri=${uri}    member_index=${index}
 388     \    TemplatedRequests.Normalize_Jsons_And_Compare    ${expected_data}    ${data}
 389
 390 Check_Item_Occurrence_Member_List_Or_All
 391     [Arguments]    ${uri}    ${dictionary}    ${member_index_list}=${EMPTY}
 392     [Documentation]    Send a GET with the supplied uri to all or some members defined in ${member_index_list}.
 393     ...    Then check received for occurrences of items expressed in a dictionary ${dictionary}.
 394     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${member_index_list}
 395     : FOR    ${index}    IN    @{index_list}
 396     \    ${data} =    Get_From_Member    uri=${uri}    member_index=${index}
 397     \    Utils.Check Item Occurrence    ${data}    ${dictionary}
 398
 399 Check_No_Content_Member_List_Or_All
 400     [Arguments]    ${uri}    ${member_index_list}=${EMPTY}
 401     [Documentation]    Send a GET with the supplied uri to all or some members defined in ${member_index_list}.
 402     ...    Then check there is no content.
 403     ${index_list} =    ClusterManagement__Given_Or_Internal_Index_List    given_list=${member_index_list}
 404     : FOR    ${index}    IN    @{index_list}
 405     \    ${session} =    Resolve_Http_Session_For_Member    member_index=${index}
 406     \    Utils.No_Content_From_URI    ${session}    ${uri}
 407
 408 Get_From_Member
 409     [Arguments]    ${uri}    ${member_index}    ${access}=${ACCEPT_EMPTY}
 410     [Documentation]    Send a GET with the supplied uri to member ${member_index}.
 411     ${session} =    Resolve_Http_Session_For_Member    member_index=${member_index}
 412     ${response_text} =    TemplatedRequests.Get_From_Uri    uri=${uri}    accept=${access}    session=${session}
 413     [Return]    ${response_text}
 414
 415 Resolve_IP_Address_For_Member
 416     [Arguments]    ${member_index}
 417     [Documentation]    Return node IP address of given index.
 418     ${ip_address} =    Collections.Get From Dictionary    dictionary=${ClusterManagement__index_to_ip_mapping}    key=${member_index}
 419     [Return]    ${ip_address}
 420
 421 Resolve_Http_Session_For_Member
 422     [Arguments]    ${member_index}
 423     [Documentation]    Return RequestsLibrary session alias pointing to node of given index.
 424     ${session} =    BuiltIn.Set_Variable    ClusterManagement__session_${member_index}
 425     [Return]    ${session}
 426
 427 Resolve_Shard_Type_Class
 428     [Arguments]    ${shard_type}
 429     [Documentation]    Simple lookup for class name corresponding to desired type.
 430     BuiltIn.Run_Keyword_If    '${shard_type}' == 'config'    BuiltIn.Return_From_Keyword    DistributedConfigDatastore
 431     ...    ELSE IF    '${shard_type}' == 'operational'    BuiltIn.Return_From_Keyword    DistributedOperationalDatastore
 432     BuiltIn.Fail    Unrecognized shard type: ${shard_type}
 433
 434 ClusterManagement__Build_List
 435     [Arguments]    ${member}
 436     ${member_int} =    BuiltIn.Convert_To_Integer    ${member}
 437     ${index_list} =    BuiltIn.Create_List    ${member_int}
 438     [Return]    ${index_list}
 439
 440 ClusterManagement__Parse_Sync_Status
 441     [Arguments]    ${shard_manager_text}
 442     [Documentation]    Return sync status parsed out of given text. Called twice by Get_Sync_Status_Of_Member.
 443     BuiltIn.Log    ${shard_manager_text}
 444     ${manager_object} =    RequestsLibrary.To_Json    ${shard_manager_text}
 445     ${value_object} =    Collections.Get_From_Dictionary    dictionary=${manager_object}    key=value
 446     ${sync_status} =    Collections.Get_From_Dictionary    dictionary=${value_object}    key=SyncStatus
 447     [Return]    ${sync_status}
 448
 449 ClusterManagement__Given_Or_Internal_Index_List
 450     [Arguments]    ${given_list}=${EMPTY}
 451     [Documentation]    Utility to allow \${EMPTY} as default argument value, as the internal list is computed at runtime.
 452     ${given_length} =    BuiltIn.Get_Length    ${given_list}
 453     ${return_list} =    BuiltIn.Set_Variable_If    ${given_length} > 0    ${given_list}    ${ClusterManagement__member_index_list}
 454     [Return]    ${return_list}
 455
 456 ClusterManagement__Given_Or_Empty_List
 457     [Arguments]    ${given_list}=${EMPTY}
 458     [Documentation]    Utility to allow \${EMPTY} as default argument value, as an empty list is computed at runtime.
 459     ${empty_list} =    BuiltIn.Create_List
 460     ${given_length} =    BuiltIn.Get_Length    ${given_list}
 461     ${return_list} =    BuiltIn.Set_Variable_If    ${given_length} > 0    ${given_list}    ${empty_list}
 462     [Return]    ${return_list}
 463
 464 ClusterManagement__Compute_Derived_Variables
 465     [Arguments]    ${int_of_members}
 466     [Documentation]    Construct index list, session list and IP mapping, publish them as suite variables.
 467     @{member_index_list} =    BuiltIn.Create_List
 468     @{session_list} =    BuiltIn.Create_List
 469     &{index_to_ip_mapping} =    BuiltIn.Create_Dictionary
 470     : FOR    ${index}    IN RANGE    1    ${int_of_members+1}
 471     \    ClusterManagement__Include_Member_Index    ${index}    ${member_index_list}    ${session_list}    ${index_to_ip_mapping}
 472     BuiltIn.Set_Suite_Variable    \${ClusterManagement__member_index_list}    ${member_index_list}
 473     BuiltIn.Set_Suite_Variable    \${ClusterManagement__index_to_ip_mapping}    ${index_to_ip_mapping}
 474     BuiltIn.Set_Suite_Variable    \${ClusterManagement__session_list}    ${session_list}
 475
 476 ClusterManagement__Include_Member_Index
 477     [Arguments]    ${index}    ${member_index_list}    ${session_list}    ${index_to_ip_mapping}
 478     [Documentation]    Add a corresponding item based on index into the last three arguments.
 479     ...    Create the Http session whose alias is added to list.
 480     Collections.Append_To_List    ${member_index_list}    ${index}
 481     ${member_ip} =    BuiltIn.Set_Variable    ${ODL_SYSTEM_${index}_IP}
 482     # ${index} is int (not string) so "key=value" syntax does not work in the following line.
 483     Collections.Set_To_Dictionary    ${index_to_ip_mapping}    ${index}    ${member_ip}
 484     # Http session, with ${AUTH}, without headers.
 485     ${session_alias} =    Resolve_Http_Session_For_Member    member_index=${index}
 486     RequestsLibrary.Create_Session    ${session_alias}    http://${member_ip}:${RESTCONFPORT}    auth=${AUTH}    max_retries=0
 487     Collections.Append_To_List    ${session_list}    ${session_alias}