${command} = BuiltIn.Set_Variable sudo iptables -v -F
${output} = Run_Bash_Command_On_List_Or_All command=${command} member_index_list=${member_index_list}
+Check_Bash_Command_On_List_Or_All
+ [Arguments] ${command} ${member_index_list}=${EMPTY} ${return_success_only}=False ${log_on_success}=True ${log_on_failure}=True ${stderr_must_be_empty}=True
+ [Documentation] Cycle through indices (or all), run bash command on each, using temporary SSH session and restoring the previously active one.
+ ${index_list} = List_Indices_Or_All given_list=${member_index_list}
+ : FOR ${index} IN @{index_list}
+ \ 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}
+ \ ... stderr_must_be_empty=${stderr_must_be_empty}
+
+Check_Bash_Command_On_Member
+ [Arguments] ${command} ${member_index} ${return_success_only}=False ${log_on_success}=True ${log_on_failure}=True ${stderr_must_be_empty}=True
+ [Documentation] Open SSH session, call SSHKeywords.Execute_Command_Passes, close session, restore previously active session and return output.
+ 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}
+ ... log_on_failure=${log_on_failure} stderr_must_be_empty=${stderr_must_be_empty}
+
+Check_Unsafely_Bash_Command_On_Member
+ [Arguments] ${command} ${member_index} ${return_success_only}=False ${log_on_success}=True ${log_on_failure}=True ${stderr_must_be_empty}=True
+ [Documentation] Obtain Ip address, open session, call SSHKeywords.Execute_Command_Passes, close session and return output. This affects which SSH session is active.
+ ${member_ip} = Resolve_Ip_Address_For_Member ${member_index}
+ 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}
+ ... log_on_failure=${log_on_failure} stderr_must_be_empty=${stderr_must_be_empty}
+
Run_Bash_Command_On_List_Or_All
[Arguments] ${command} ${member_index_list}=${EMPTY}
[Documentation] Cycle through indices (or all), run command on each.
+ # TODO: Migrate callers to Check_Bash_Command_*
${index_list} = List_Indices_Or_All given_list=${member_index_list}
: FOR ${index} IN @{index_list}
\ Run_Bash_Command_On_Member command=${command} member_index=${index}
Run_Bash_Command_On_Member
[Arguments] ${command} ${member_index}
- [Documentation] Obtain IP, call Utils and return output. This does not preserve active ssh session.
- # TODO: Rename these keyword to Run_Bash_Command_On_Member to distinguish from Karaf (or even Windows) commands.
+ [Documentation] Obtain IP, call Utils and return output. This keeps previous ssh session active.
+ # TODO: Migrate callers to Check_Bash_Command_*
${member_ip} = Collections.Get_From_Dictionary dictionary=${ClusterManagement__index_to_ip_mapping} key=${member_index}
${output} = SSHKeywords.Run_Keyword_Preserve_Connection Utils.Run_Command_On_Controller ${member_ip} ${command}
[Return] ${output}
With_Ssh_To_List_Or_All_Run_Keyword
[Arguments] ${member_index_list} ${keyword_name} @{args} &{kwargs}
[Documentation] For each index in given list (or all): activate SSH connection, run given Keyword, close active connection. Return None.
- ... Note that if the Keyword affects SSH connections, results are still deterministic, but perhaps undesirable.
... Beware that in order to avoid "got positional argument after named arguments", first two arguments in the call should not be named.
BuiltIn.Comment This keyword is experimental and there is high risk of being replaced by another approach.
# TODO: For_Index_From_List_Or_All_Run_Keyword applied to With_Ssh_To_Member_Run_Keyword?
${index_list} = List_Indices_Or_All given_list=${member_index_list}
: FOR ${member_index} IN @{index_list}
\ ${member_ip} = Resolve_IP_Address_For_Member ${member_index}
- \ SSHKeywords.Open_Connection_To_Odl_System ip_address=${member_ip}
- \ BuiltIn.Run_Keyword ${keyword_name} @{args} &{kwargs}
- \ SSHLibrary.Close_Connection
+ \ SSHKeywords.Run_Unsafely_Keyword_Over_Temporary_Odl_Session ${member_ip} ${keyword_name} @{args} &{kwargs}
Safe_With_Ssh_To_List_Or_All_Run_Keyword
[Arguments] ${member_index_list} ${keyword_name} @{args} &{kwargs}
SSHKeywords.Run_Keyword_Preserve_Connection With_Ssh_To_List_Or_All_Run_Keyword ${member_index_list} ${keyword_name} @{args} &{kwargs}
Clean_Directories_On_List_Or_All
- [Arguments] ${member_index_list}=${EMPTY} ${directory_list}=${EMPTY} ${karaf_home}=${KARAF_HOME}
+ [Arguments] ${member_index_list}=${EMPTY} ${directory_list}=${EMPTY} ${karaf_home}=${KARAF_HOME} ${tmp_dir}=${EMPTY}
[Documentation] Clear @{directory_list} or @{ODL_DEFAULT_DATA_PATHS} for members in given list or all. Return None.
+ ... If \${tmp_dir} is nonempty, use that location to preserve data/log/.
... This is intended to return Karaf (offline) to the state it was upon the first boot.
${path_list} = Builtin.Set Variable If "${directory_list}" == "${EMPTY}" ${ODL_DEFAULT_DATA_PATHS} ${directory_list}
+ 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}
Safe_With_Ssh_To_List_Or_All_Run_Keyword ${member_index_list} ClusterManagement__Clean_Directories ${path_list} ${karaf_home}
+ 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}
Store_Karaf_Log_On_List_Or_All
[Arguments] ${member_index_list}=${EMPTY} ${dst_dir}=/tmp ${karaf_home}=${KARAF_HOME}
# Resource name has to be prepended, as KarafKeywords still contains a redirect.
[Teardown] SSHKeywords.Restore_Current_SSH_Connection_From_Index ${current_connection.index}
+Run_Keyword_With_Ssh
+ [Arguments] ${ip_address} ${keyword_name} @{args} &{kwargs}
+ [Documentation] Open temporary connection to given IP address, run keyword, close connection, restore previously active connection, return result.
+ Run_Keyword_Preserve_Connection Run_Unsafely_Keyword_Over_Temporary_Odl_Session ${ip_address} ${keyword_name} @{args} &{kwargs}
+
+Run_Unsafely_Keyword_Over_Temporary_Odl_Session
+ [Arguments] ${ip_address} ${keyword_name} @{args} &{kwargs}
+ [Documentation] Open connection to given IP address, run keyword, close connection, return result.
+ ... This is unsafe in the sense that previously active session will be switched out off, but safe in the sense only the temporary connection is closed.
+ Open_Connection_To_ODL_System ${ip_address}
+ # Not using Teardown, to avoid a call to close if the previous line fails.
+ ${status} ${result} = BuiltIn.Run_Keyword_And_Ignore_Error ${keyword_name} @{args} &{kwargs}
+ SSHLibrary.Close_Connection
+ BuiltIn.Return_From_Keyword_If "${status}" == "PASS" ${result}
+ BuiltIn.Fail ${result}
+
Log_Command_Results
[Arguments] ${stdout} ${stderr} ${rc}
[Documentation] Log everything returned by SSHLibrary.Execute_Command
... terms of the Eclipse Public License v1.0 which accompanies this distribution,
... and is available at http://www.eclipse.org/legal/epl-v10.html
...
-... Suite stops all odl nodes, uncomment usage of tell-based protocol in
-... config file and starts all nodes again.
+... Suite stops all odl nodes, un-comment usage of tell-based protocol in
+... config file (means make it true) and starts all nodes again.
Suite Setup SetupUtils.Setup_Utils_For_Setup_And_Teardown
Suite Teardown SSHLibrary.Close_All_Connections
Library SSHLibrary
ClusterManagement.Kill_Members_From_List_Or_All
Set_Tell_Based_Protocol_Usage
- [Documentation] Uncomment the flag usage line in config file
- ClusterManagement.Run_Bash_Command_On_List_Or_All sed -ie "s/#use-tell-based-protocol=/use-tell-based-protocol=/g" ${DATASTORE_CFG}
- ClusterManagement.Run_Bash_Command_On_List_Or_All cat ${DATASTORE_CFG}
+ [Documentation] Un-comment the flag usage in config file. Also clean most data except data/log/.
+ ClusterManagement.Check_Bash_Command_On_List_Or_All sed -ie "s/#use-tell-based-protocol=/use-tell-based-protocol=/g" ${DATASTORE_CFG}
+ ClusterManagement.Check_Bash_Command_On_List_Or_All cat ${DATASTORE_CFG}
+ ClusterManagement.Clean_Directories_On_List_Or_All tmp_dir=/tmp
Start_All_And_Sync
[Documentation] Start each member and wait for sync.
Code Review / integration / test.git / commitdiff