X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=csit%2Flibraries%2FSSHKeywords.robot;h=e5a50d9db5223244291652bc30b9e0f25a1ec78f;hb=91bd1965ef5c1509c77cf389faed07bd8ea0c753;hp=aae96bdb10b54c09e395ec03f102c6638fd187fb;hpb=25b367290f60a2d71bdb4aced1f18762cc77cdba;p=integration%2Ftest.git diff --git a/csit/libraries/SSHKeywords.robot b/csit/libraries/SSHKeywords.robot index aae96bdb10..e5a50d9db5 100644 --- a/csit/libraries/SSHKeywords.robot +++ b/csit/libraries/SSHKeywords.robot @@ -12,29 +12,81 @@ Documentation Resource enhancing SSHLibrary with Keywords used in multiple s ... When the Keywords assume a SSH session is active, ... and if the Keywords do not fit into a more specific Resource, ... you can place them here. -... -... TODO: Migrate Keywords related to handling SSH here. -... That may include Utils.Flexible_SSH_Login, KarafKeywords.Restore_Current_SSH_Connection_From_Index and similar. Library SSHLibrary Resource ${CURDIR}/Utils.robot +Resource ../variables/Variables.robot *** Variables *** ${SSHKeywords__current_remote_working_directory} . ${SSHKeywords__current_venv_path} /tmp/defaultvenv +${NETSTAT_COMMAND} netstat -punta *** Keywords *** Open_Connection_To_ODL_System - [Documentation] Open a connection to the ODL system and return its identifier. - ... On clustered systems this opens the connection to the first node. - ${odl} = SSHLibrary.Open_Connection ${ODL_SYSTEM_IP} prompt=${ODL_SYSTEM_PROMPT} timeout=10s - Utils.Flexible_Controller_Login - [Return] ${odl} + [Arguments] ${ip_address}=${ODL_SYSTEM_IP} ${timeout}=10s + [Documentation] Open a connection to the ODL system at ${ip_address} and return its identifier. + ${odl_connection} = SSHLibrary.Open_Connection ${ip_address} prompt=${ODL_SYSTEM_PROMPT} timeout=${timeout} + Flexible_Controller_Login + [Return] ${odl_connection} Open_Connection_To_Tools_System - [Documentation] Open a connection to the tools system and return its identifier. - ${tools} = SSHLibrary.Open_Connection ${TOOLS_SYSTEM_IP} prompt=${TOOLS_SYSTEM_PROMPT} - Utils.Flexible_Mininet_Login - [Return] ${tools} + [Arguments] ${ip_address}=${TOOLS_SYSTEM_IP} ${timeout}=10s ${prompt}=${TOOLS_SYSTEM_PROMPT} + [Documentation] Open a connection to the tools system at ${ip_address} and return its identifier. + ${tools_connection} = SSHLibrary.Open_Connection ${ip_address} prompt=${prompt} timeout=${timeout} + Flexible_Mininet_Login + [Return] ${tools_connection} + +Restore_Current_Ssh_Connection_From_Index + [Arguments] ${connection_index} + [Documentation] Restore active SSH connection in SSHLibrary to given index. + ... + ... Restore the currently active connection state in + ... SSHLibrary to match the state returned by "Switch + ... Connection" or "Get Connection". More specifically makes + ... sure that there will be no active connection when the + ... \${connection_index} reported by these means is None. + ... + ... There is a misfeature in SSHLibrary: Invoking "SSHLibrary.Switch_Connection" + ... and passing None as the "index_or_alias" argument to it has exactly the + ... same effect as invoking "Close Connection". + ... https://github.com/robotframework/SSHLibrary/blob/master/src/SSHLibrary/library.py#L560 + ... + ... We want to have Keyword which will "switch out" to previous + ... "no connection active" state without killing the background one. + ... + ... As some suites may hypothetically rely on non-writability of active connection, + ... workaround is applied by opening and closing temporary connection. + ... Unfortunately this will fail if run on Jython and there is no SSH server + ... running on localhost, port 22 but there is nothing easy that can be done about it. + BuiltIn.Run Keyword And Return If ${connection_index} is not None SSHLibrary.Switch Connection ${connection_index} + # The background connection is still current, bury it. + SSHLibrary.Open Connection 127.0.0.1 + SSHLibrary.Close Connection + +Run_Keyword_Preserve_Connection + [Arguments] ${keyword_name} @{args} &{kwargs} + [Documentation] Store current connection index, run keyword returning its result, restore connection in teardown. + ... Note that in order to avoid "got positional argument after named arguments", it is safer to use positional (not named) arguments on call. + ${current_connection}= SSHLibrary.Get_Connection + BuiltIn.Run_Keyword_And_Return ${keyword_name} @{args} &{kwargs} + # 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} @@ -46,7 +98,7 @@ Log_Command_Results Execute_Command_Passes [Arguments] ${command} ${return_success_only}=True ${log_on_success}=False ${log_on_failure}=True ${stderr_must_be_empty}=False [Documentation] Execute command via the active SSH connection. For success, rc has to be zero and optionally stderr has to be empty. - ... Log everything, depending on arguments and success. Retrun either success string or stdout. + ... Log everything, depending on arguments and success. Return either success string or stdout. ... TODO: Do we want to support customizing return values the same way as SSHLibrary.Execute_Command does? ${stdout} ${stderr} ${rc} = SSHLibrary.Execute_Command ${command} return_stderr=True return_rc=True ${emptiness_status} ${result} = BuiltIn.Run_Keyword_And_Ignore_Error BuiltIn.Should_Be_Empty ${stderr} @@ -104,7 +156,7 @@ Assure_Library_Counter Count_Port_Occurences [Arguments] ${port} ${state} ${name} [Documentation] Run 'netstat' on the remote machine and count occurences of given port in the given state connected to process with the given name. - ${output} = SSHLibrary.Execute_Command netstat -natp 2> /dev/null | grep -E ":${port} .+ ${state} .+${name}" | wc -l + ${output} = SSHLibrary.Execute_Command ${NETSTAT_COMMAND} 2> /dev/null | grep -E ":${port} .+ ${state} .+${name}" | wc -l [Return] ${output} Virtual_Env_Set_Path @@ -113,9 +165,14 @@ Virtual_Env_Set_Path BuiltIn.Set_Global_Variable \${SSHKeywords__current_venv_path} ${venv_path} Virtual_Env_Create + [Arguments] ${upgrade_pip}=True [Documentation] Creates virtual env. If not to use the default name, use Virtual_Env_Set_Path kw. Returns stdout. Execute_Command_At_Cwd_Should_Pass virtualenv ${SSHKeywords__current_venv_path} - BuiltIn.Run_Keyword_And_Return Virtual_Env_Run_Cmd_At_Cwd pip install --upgrade pip + BuiltIn.Run_Keyword_And_Return_If ${upgrade_pip} Virtual_Env_Run_Cmd_At_Cwd pip install --upgrade pip + +Virtual_Env_Delete + [Documentation] Deletes a directory with virtual env. + Execute_Command_At_Cwd_Should_Pass rm -rf ${SSHKeywords__current_venv_path} Virtual_Env_Run_Cmd_At_Cwd [Arguments] ${cmd} ${log_on_success}=True ${log_on_failure}=True ${stderr_must_be_empty}=True @@ -134,4 +191,83 @@ Virtual_Env_Uninstall_Package Virtual_Env_Freeze [Documentation] Shows installed packages within the returned stdout. - BuiltIn.Run_Keyword_And_Return Virtual_Env_Run_Cmd_At_Cwd pip freeze + BuiltIn.Run_Keyword_And_Return Virtual_Env_Run_Cmd_At_Cwd pip freeze --all + +Virtual_Env_Activate_On_Current_Session + [Arguments] ${log_output}=${False} + [Documentation] Activates virtual environment. To run anything in the env activated this way you should use SSHLibrary.Write and Read commands. + SSHLibrary.Write source ${SSHKeywords__current_venv_path}/bin/activate + ${output}= SSHLibrary.Read_Until_Prompt + BuiltIn.Run_Keyword_If ${log_output}==${True} BuiltIn.Log ${output} + +Virtual_Env_Deactivate_On_Current_Session + [Arguments] ${log_output}=${False} + [Documentation] Deactivates virtual environment. + SSHLibrary.Write deactivate + ${output}= SSHLibrary.Read_Until_Prompt + BuiltIn.Run_Keyword_If ${log_output}==${True} BuiltIn.Log ${output} + +Unsafe_Copy_File_To_Remote_System + [Arguments] ${system} ${source} ${destination}=./ ${user}=${DEFAULT_USER} ${password}=${DEFAULT_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} + ... ${prompt_timeout}=5s + [Documentation] Copy the ${source} file to the ${destination} file on the remote ${system}. The keyword opens and closes a single + ... ssh connection and does not rely on any existing ssh connection that may be open. + SSHLibrary.Open_Connection ${system} prompt=${prompt} timeout=${prompt_timeout} + Flexible_SSH_Login ${user} ${password} + SSHLibrary.Put_File ${source} ${destination} + SSHLibrary.Close Connection + +Copy_File_To_Remote_System + [Arguments] ${system} ${source} ${destination}=./ ${user}=${DEFAULT_USER} ${password}=${DEFAULT_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} + ... ${prompt_timeout}=5s + [Documentation] Copy the ${source} file to the ${destination} file on the remote ${system}. Any pre-existing active + ... ssh connection will be retained. + SSHKeywords.Run_Keyword_Preserve_Connection SSHKeywords.Unsafe_Copy_File_To_Remote_System ${system} ${source} ${destination} ${user} ${password} + ... ${prompt} ${prompt_timeout} + +Copy_File_To_Odl_System + [Arguments] ${system} ${source} ${destination}=./ + [Documentation] Wrapper keyword to make it easier to copy a file to an ODL specific system + SSHKeywords.Copy_File_To_Remote_System ${system} ${source} ${destination} ${ODL_SYSTEM_USER} ${ODL_SYSTEM_PASSWORD} ${ODL_SYSTEM_PROMPT} + +Copy_File_To_Tools_System + [Arguments] ${system} ${source} ${destination}=./ + [Documentation] Wrapper keyword to make it easier to copy a file to an Tools specific system + SSHKeywords.Copy_File_To_Remote_System ${system} ${source} ${destination} ${TOOLS_SYSTEM_USER} ${TOOLS_SYSTEM_PASSWORD} ${TOOLS_SYSTEM_PROMPT} + +Flexible_SSH_Login + [Arguments] ${user} ${password}=${EMPTY} ${delay}=0.5s + [Documentation] On active SSH session: if given non-empty password, do Login, else do Login With Public Key. + ${pwd_length} = BuiltIn.Get Length ${password} + # ${pwd_length} is guaranteed to be an integer, so we are safe to evaluate it as Python expression. + BuiltIn.Run Keyword And Return If ${pwd_length} > 0 SSHLibrary.Login ${user} ${password} delay=${delay} + BuiltIn.Run Keyword And Return SSHLibrary.Login With Public Key ${user} ${USER_HOME}/.ssh/${SSH_KEY} ${KEYFILE_PASS} delay=${delay} + +Flexible_Mininet_Login + [Arguments] ${user}=${TOOLS_SYSTEM_USER} ${password}=${TOOLS_SYSTEM_PASSWORD} ${delay}=0.5s + [Documentation] Call Flexible SSH Login, but with default values suitable for Mininet machine. + BuiltIn.Run Keyword And Return Flexible SSH Login user=${user} password=${password} delay=${delay} + +Flexible_Controller_Login + [Arguments] ${user}=${ODL_SYSTEM_USER} ${password}=${ODL_SYSTEM_PASSWORD} ${delay}=0.5s + [Documentation] Call Flexible SSH Login, but with default values suitable for Controller machine. + BuiltIn.Run Keyword And Return Flexible SSH Login user=${user} password=${password} delay=${delay} + +Move_File_To_Remote_System + [Arguments] ${system} ${source} ${destination}=./ ${user}=${DEFAULT_USER} ${password}=${DEFAULT_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} + ... ${prompt_timeout}=5s + [Documentation] Moves the ${source} file to the ${destination} file on the remote ${system}. Any pre-existing active + ... ssh connection will be retained. + SSHKeywords.Run_Keyword_Preserve_Connection Unsafe_Move_File_To_Remote_System ${system} ${source} ${destination} ${user} ${password} + ... ${prompt} ${prompt_timeout} + +Unsafe_Move_File_To_Remote_System + [Arguments] ${system} ${source} ${destination}=./ ${user}=${DEFAULT_USER} ${password}=${DEFAULT_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} + ... ${prompt_timeout}=5s + [Documentation] Moves the ${source} file to the ${destination} file on the remote ${system}. The keyword opens and closes a single + ... ssh connection and does not rely on any existing ssh connection that may be open. + SSHLibrary.Open_Connection ${system} prompt=${prompt} timeout=${prompt_timeout} + Flexible_SSH_Login ${user} ${password} + SSHLibrary.Put File ${source} ${destination} + OperatingSystem.Remove File ${source} + SSHLibrary.Close Connection