Code Review / integration / test.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Remove remnants of sfc project
[integration/test.git] / csit / libraries / SSHKeywords.robot
diff --git a/csit/libraries/SSHKeywords.robot b/csit/libraries/SSHKeywords.robot
index adfefcc5211f1c0cd2d6ffcc2abca39581f6b1cf..c2073d5347dd8642a8d4e86a313ad4329af0b785 100644 (file)
--- a/csit/libraries/SSHKeywords.robot
+++ b/csit/libraries/SSHKeywords.robot
@@ -1,43 +1,48 @@
 *** Settings ***
 *** Settings ***
-Documentation     Resource enhancing SSHLibrary with Keywords used in multiple suites.
+Documentation       Resource enhancing SSHLibrary with Keywords used in multiple suites.
 ...
 ...
-...               Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
+...                 Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
 ...
 ...
-...               This program and the accompanying materials are made available under the
-...               terms of the Eclipse Public License v1.0 which accompanies this distribution,
-...               and is available at http://www.eclipse.org/legal/epl-v10.html
+...                 This program and the accompanying materials are made available under the
+...                 terms of the Eclipse Public License v1.0 which accompanies this distribution,
+...                 and is available at http://www.eclipse.org/legal/epl-v10.html
 ...
 ...
 ...
 ...
-...               Some suites evolved utility Keywords re-usable with other suites.
-...               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.
-Library           SSHLibrary
-Resource          ${CURDIR}/Utils.robot
-Resource          ../variables/Variables.robot
+...                 Some suites evolved utility Keywords re-usable with other suites.
+...                 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.
+
+Library             SSHLibrary
+Resource            ${CURDIR}/Utils.robot
+Resource            ../variables/Variables.robot
+
 
 *** Variables ***
 ${SSHKeywords__current_remote_working_directory}    .
 
 *** Variables ***
 ${SSHKeywords__current_remote_working_directory}    .
-${SSHKeywords__current_venv_path}    /tmp/defaultvenv
-${NETSTAT_COMMAND}    netstat -punta
+${SSHKeywords__current_venv_path}                   /tmp/defaultvenv
+${NETSTAT_COMMAND}                                  netstat -punta
+
 
 *** Keywords ***
 Open_Connection_To_ODL_System
 
 *** Keywords ***
 Open_Connection_To_ODL_System
-    [Arguments]    ${ip_address}=${ODL_SYSTEM_IP}    ${timeout}=10s
     [Documentation]    Open a connection to the ODL system at ${ip_address} and return its identifier.
     [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}
+    [Arguments]    ${ip_address}=${ODL_SYSTEM_IP}    ${timeout}=10s
+    ${odl_connection} =    SSHLibrary.Open_Connection
+    ...    ${ip_address}
+    ...    prompt=${ODL_SYSTEM_PROMPT}
+    ...    timeout=${timeout}
     Flexible_Controller_Login
     Flexible_Controller_Login
-    [Return]    ${odl_connection}
+    RETURN    ${odl_connection}
 
 Open_Connection_To_Tools_System
 
 Open_Connection_To_Tools_System
-    [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.
     [Documentation]    Open a connection to the tools system at ${ip_address} and return its identifier.
+    [Arguments]    ${ip_address}=${TOOLS_SYSTEM_IP}    ${timeout}=10s    ${prompt}=${TOOLS_SYSTEM_PROMPT}
     ${tools_connection} =    SSHLibrary.Open_Connection    ${ip_address}    prompt=${prompt}    timeout=${timeout}
     Flexible_Mininet_Login
     ${tools_connection} =    SSHLibrary.Open_Connection    ${ip_address}    prompt=${prompt}    timeout=${timeout}
     Flexible_Mininet_Login
-    [Return]    ${tools_connection}
+    RETURN    ${tools_connection}
 
 Restore_Current_Ssh_Connection_From_Index
 
 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
     [Documentation]    Restore active SSH connection in SSHLibrary to given index.
     ...
     ...    Restore the currently active connection state in
@@ -58,220 +63,312 @@ Restore_Current_Ssh_Connection_From_Index
     ...    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.
     ...    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}
+    [Arguments]    ${connection_index}
+    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
     # 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.
     [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
+    [Arguments]    ${keyword_name}    @{args}    &{kwargs}
+    ${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
     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.
     [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}
+    [Arguments]    ${ip_address}    ${keyword_name}    @{args}    &{kwargs}
+    Run_Keyword_Preserve_Connection
+    ...    Run_Unsafely_Keyword_Over_Temporary_Odl_Session
+    ...    ${ip_address}
+    ...    ${keyword_name}
+    ...    @{args}
+    ...    &{kwargs}
 
 Run_Unsafely_Keyword_Over_Temporary_Odl_Session
 
 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.
     [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.
+    [Arguments]    ${ip_address}    ${keyword_name}    @{args}    &{kwargs}
     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
     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}
+    IF    "${status}" == "PASS"    RETURN    ${result}
     BuiltIn.Fail    ${result}
 
 Log_Command_Results
     BuiltIn.Fail    ${result}
 
 Log_Command_Results
-    [Arguments]    ${stdout}    ${stderr}    ${rc}
     [Documentation]    Log everything returned by SSHLibrary.Execute_Command
     [Documentation]    Log everything returned by SSHLibrary.Execute_Command
+    [Arguments]    ${stdout}    ${stderr}    ${rc}
     BuiltIn.Log    ${stdout}
     BuiltIn.Log    ${stderr}
     BuiltIn.Log    ${rc}
 
 Execute_Command_Passes
     BuiltIn.Log    ${stdout}
     BuiltIn.Log    ${stderr}
     BuiltIn.Log    ${rc}
 
 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. Return either success string or stdout.
     ...    TODO: Do we want to support customizing return values the same way as SSHLibrary.Execute_Command does?
     [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. 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
+    [Arguments]    ${command}    ${return_success_only}=True    ${log_on_success}=False    ${log_on_failure}=True    ${stderr_must_be_empty}=False
+    ${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}
     ${emptiness_status}    ${result} =    BuiltIn.Run_Keyword_And_Ignore_Error    BuiltIn.Should_Be_Empty    ${stderr}
-    ${success} =    BuiltIn.Set_Variable_If    (${rc} == 0) and (("${emptiness_status}" == "PASS") or not ${stderr_must_be_empty})    True    False
-    BuiltIn.Run_Keyword_If    (${log_on_success} and ${success}) or (${log_on_failure} and not ${success})    Log_Command_Results    ${stdout}    ${stderr}    ${rc}
-    BuiltIn.Return_From_Keyword_If    ${return_success_only}    ${success}
-    BuiltIn.Return_From_Keyword_If    ${success}    ${stdout}
+    ${success} =    BuiltIn.Set_Variable_If
+    ...    (${rc} == 0) and (("${emptiness_status}" == "PASS") or not ${stderr_must_be_empty})
+    ...    True
+    ...    False
+    IF    (${log_on_success} and ${success}) or (${log_on_failure} and not ${success})
+        Log_Command_Results    ${stdout}    ${stderr}    ${rc}
+    END
+    IF    ${return_success_only}    RETURN    ${success}
+    IF    ${success}    RETURN    ${stdout}
     BuiltIn.Fail    Got rc: ${rc} or stderr was not empty: ${stderr}
 
 Execute_Command_Should_Pass
     BuiltIn.Fail    Got rc: ${rc} or stderr was not empty: ${stderr}
 
 Execute_Command_Should_Pass
-    [Arguments]    ${command}    ${log_on_success}=True    ${log_on_failure}=True    ${stderr_must_be_empty}=False
     [Documentation]    A wrapper for Execute_Command_Passes with return_success_only=False
     ...    Also, log_on_success defaults to True (but is customizable, unlike return_success_only)..
     [Documentation]    A wrapper for Execute_Command_Passes with return_success_only=False
     ...    Also, log_on_success defaults to True (but is customizable, unlike return_success_only)..
-    BuiltIn.Run_Keyword_And_Return    Execute_Command_Passes    ${command}    return_success_only=False    log_on_success=${log_on_success}    log_on_failure=${log_on_failure}    stderr_must_be_empty=${stderr_must_be_empty}
+    [Arguments]    ${command}    ${log_on_success}=True    ${log_on_failure}=True    ${stderr_must_be_empty}=False
+    BuiltIn.Run_Keyword_And_Return
+    ...    Execute_Command_Passes
+    ...    ${command}
+    ...    return_success_only=False
+    ...    log_on_success=${log_on_success}
+    ...    log_on_failure=${log_on_failure}
+    ...    stderr_must_be_empty=${stderr_must_be_empty}
 
 Execute_Command_At_Path_Should_Pass
 
 Execute_Command_At_Path_Should_Pass
-    [Arguments]    ${command}    ${path}=None    ${log_on_success}=True    ${log_on_failure}=True    ${stderr_must_be_empty}=False
     [Documentation]    A keyword similar to Execute_Command_Should_Pass which performs "cd" to ${path} before executing the ${command}.
     ...    This is useful when rewriting bash scripts, as series of SSHLibrary.Execute_Command do not share current working directory.
     ...    TODO: Perhaps a Keyword which sets up environment variables would be useful as well.
     [Documentation]    A keyword similar to Execute_Command_Should_Pass which performs "cd" to ${path} before executing the ${command}.
     ...    This is useful when rewriting bash scripts, as series of SSHLibrary.Execute_Command do not share current working directory.
     ...    TODO: Perhaps a Keyword which sets up environment variables would be useful as well.
+    [Arguments]    ${command}    ${path}=None    ${log_on_success}=True    ${log_on_failure}=True    ${stderr_must_be_empty}=False
     ${cd_and_command} =    BuiltIn.Set_Variable    cd '${path}' && ${command}
     ${cd_and_command} =    BuiltIn.Set_Variable    cd '${path}' && ${command}
-    BuiltIn.Run_Keyword_And_Return    Execute_Command_Passes    ${cd_and_command}    return_success_only=False    log_on_success=${log_on_success}    log_on_failure=${log_on_failure}    stderr_must_be_empty=${stderr_must_be_empty}
+    BuiltIn.Run_Keyword_And_Return
+    ...    Execute_Command_Passes
+    ...    ${cd_and_command}
+    ...    return_success_only=False
+    ...    log_on_success=${log_on_success}
+    ...    log_on_failure=${log_on_failure}
+    ...    stderr_must_be_empty=${stderr_must_be_empty}
 
 Set_Cwd
 
 Set_Cwd
-    [Arguments]    ${path}
     [Documentation]    Set \${SSHKeywords__current_remote_working_directory} variable to ${path}. If SSH default is desired, use dot.
     [Documentation]    Set \${SSHKeywords__current_remote_working_directory} variable to ${path}. If SSH default is desired, use dot.
+    [Arguments]    ${path}
     BuiltIn.Set_Suite_Variable    \${SSHKeywords__current_remote_working_directory}    ${path}
 
 Execute_Command_At_Cwd_Should_Pass
     BuiltIn.Set_Suite_Variable    \${SSHKeywords__current_remote_working_directory}    ${path}
 
 Execute_Command_At_Cwd_Should_Pass
-    [Arguments]    ${command}    ${log_on_success}=True    ${log_on_failure}=True    ${stderr_must_be_empty}=True
     [Documentation]    Run Execute_Command_At_Path_Should_Pass with previously set CWD as path.
     [Documentation]    Run Execute_Command_At_Path_Should_Pass with previously set CWD as path.
-    BuiltIn.Run_Keyword_And_Return    Execute_Command_At_Path_Should_Pass    command=${command}    path=${SSHKeywords__current_remote_working_directory}    log_on_success=${log_on_success}    log_on_failure=${log_on_failure}    stderr_must_be_empty=${stderr_must_be_empty}
+    [Arguments]    ${command}    ${log_on_success}=True    ${log_on_failure}=True    ${stderr_must_be_empty}=True
+    BuiltIn.Run_Keyword_And_Return
+    ...    Execute_Command_At_Path_Should_Pass
+    ...    command=${command}
+    ...    path=${SSHKeywords__current_remote_working_directory}
+    ...    log_on_success=${log_on_success}
+    ...    log_on_failure=${log_on_failure}
+    ...    stderr_must_be_empty=${stderr_must_be_empty}
 
 Require_Python
     [Documentation]    Verify current SSH connection leads to machine with python working. Fatal fail otherwise.
 
 Require_Python
     [Documentation]    Verify current SSH connection leads to machine with python working. Fatal fail otherwise.
-    ${passed} =    Execute_Command_Passes    python --help
-    BuiltIn.Return_From_Keyword_If    ${passed}
-    BuiltIn.Fatal_Error    Python is not installed!
+    ${passed} =    Execute_Command_Passes    python3 --help
+    IF    ${passed}    RETURN
+    BuiltIn.Fatal_Error    Python 3 is not installed!
 
 Assure_Library_Ipaddr
 
 Assure_Library_Ipaddr
-    [Arguments]    ${target_dir}=.
     [Documentation]    Tests whether ipaddr module is present on ssh-connected machine, Puts ipaddr.py to target_dir if not.
     [Documentation]    Tests whether ipaddr module is present on ssh-connected machine, Puts ipaddr.py to target_dir if not.
+    [Arguments]    ${target_dir}=.
     ${passed} =    Execute_Command_Passes    bash -c 'cd "${target_dir}" && python -c "import ipaddr"'
     ${passed} =    Execute_Command_Passes    bash -c 'cd "${target_dir}" && python -c "import ipaddr"'
-    BuiltIn.Return_From_Keyword_If    ${passed}
+    IF    ${passed}    RETURN
     SSHLibrary.Put_File    ${CURDIR}/BGPCEP/ipaddr.py    ${target_dir}/
 
 Assure_Library_Counter
     SSHLibrary.Put_File    ${CURDIR}/BGPCEP/ipaddr.py    ${target_dir}/
 
 Assure_Library_Counter
-    [Arguments]    ${target_dir}=.
     [Documentation]    Tests whether Counter is present in collections on ssh-connected machine, Puts Counter.py to workspace if not.
     [Documentation]    Tests whether Counter is present in collections on ssh-connected machine, Puts Counter.py to workspace if not.
-    ${passed} =    Execute_Command_Passes    bash -c 'cd "${target_dir}" && python -c "from collections import Counter"'
+    [Arguments]    ${target_dir}=.
+    ${passed} =    Execute_Command_Passes
+    ...    bash -c 'cd "${target_dir}" && python -c "from collections import Counter"'
     # TODO: Move the bash-cd wrapper to separate keyword?
     # TODO: Move the bash-cd wrapper to separate keyword?
-    BuiltIn.Return_From_Keyword_If    ${passed}
+    IF    ${passed}    RETURN
     SSHLibrary.Put_File    ${CURDIR}/Counter.py    ${target_dir}/
 
 Count_Port_Occurences
     SSHLibrary.Put_File    ${CURDIR}/Counter.py    ${target_dir}/
 
 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.
     [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_COMMAND} 2> /dev/null | grep -E ":${port} .+ ${state} .+${name}" | wc -l
-    [Return]    ${output}
+    [Arguments]    ${port}    ${state}    ${name}
+    ${output} =    SSHLibrary.Execute_Command
+    ...    ${NETSTAT_COMMAND} 2> /dev/null | grep -E ":${port} .+ ${state} .+${name}" | wc -l
+    RETURN    ${output}
 
 Virtual_Env_Set_Path
 
 Virtual_Env_Set_Path
-    [Arguments]    ${venv_path}
     [Documentation]    Set \${SSHKeywords__current_venv_path} variable to ${venv_path}. Path should be absolute.
     [Documentation]    Set \${SSHKeywords__current_venv_path} variable to ${venv_path}. Path should be absolute.
+    [Arguments]    ${venv_path}
     BuiltIn.Set_Global_Variable    \${SSHKeywords__current_venv_path}    ${venv_path}
 
 Virtual_Env_Create
     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.
     [Documentation]    Creates virtual env. If not to use the default name, use Virtual_Env_Set_Path kw. Returns stdout.
+    [Arguments]    ${upgrade_pip}=True
     Execute_Command_At_Cwd_Should_Pass    virtualenv ${SSHKeywords__current_venv_path}
     Execute_Command_At_Cwd_Should_Pass    virtualenv ${SSHKeywords__current_venv_path}
-    BuiltIn.Run_Keyword_And_Return_If    ${upgrade_pip}    Virtual_Env_Run_Cmd_At_Cwd    pip install --upgrade pip    stderr_must_be_empty=False
+    BuiltIn.Run_Keyword_And_Return_If
+    ...    ${upgrade_pip}
+    ...    Virtual_Env_Run_Cmd_At_Cwd
+    ...    pip install --upgrade pip
+    ...    stderr_must_be_empty=False
 
 Virtual_Env_Create_Python3
 
 Virtual_Env_Create_Python3
-    [Arguments]    ${upgrade_pip}=True
     [Documentation]    Creates virtual env. If not to use the default name, use Virtual_Env_Set_Path kw. Returns stdout.
     [Documentation]    Creates virtual env. If not to use the default name, use Virtual_Env_Set_Path kw. Returns stdout.
+    [Arguments]    ${upgrade_pip}=True
     Execute_Command_At_Cwd_Should_Pass    python3 -m venv ${SSHKeywords__current_venv_path}
     Execute_Command_At_Cwd_Should_Pass    python3 -m venv ${SSHKeywords__current_venv_path}
-    BuiltIn.Run_Keyword_And_Return_If    ${upgrade_pip}    Virtual_Env_Run_Cmd_At_Cwd    pip install --upgrade pip    stderr_must_be_empty=False
+    BuiltIn.Run_Keyword_And_Return_If
+    ...    ${upgrade_pip}
+    ...    Virtual_Env_Run_Cmd_At_Cwd
+    ...    pip install --upgrade pip
+    ...    stderr_must_be_empty=False
 
 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
 
 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
     [Documentation]    Runs given command within activated virtual env and returns stdout.
     [Documentation]    Runs given command within activated virtual env and returns stdout.
-    BuiltIn.Run_Keyword_And_Return    Execute_Command_At_Cwd_Should_Pass    source ${SSHKeywords__current_venv_path}/bin/activate; ${cmd}; deactivate    log_on_success=${log_on_success}    log_on_failure=${log_on_failure}    stderr_must_be_empty=${stderr_must_be_empty}
+    [Arguments]    ${cmd}    ${log_on_success}=True    ${log_on_failure}=True    ${stderr_must_be_empty}=True
+    BuiltIn.Run_Keyword_And_Return
+    ...    Execute_Command_At_Cwd_Should_Pass
+    ...    source ${SSHKeywords__current_venv_path}/bin/activate; ${cmd}; deactivate
+    ...    log_on_success=${log_on_success}
+    ...    log_on_failure=${log_on_failure}
+    ...    stderr_must_be_empty=${stderr_must_be_empty}
 
 Virtual_Env_Install_Package
 
 Virtual_Env_Install_Package
-    [Arguments]    ${package}
     [Documentation]    Installs python package into virtual env. Use with version if needed (e.g. exabgp==3.4.16). Returns stdout.
     [Documentation]    Installs python package into virtual env. Use with version if needed (e.g. exabgp==3.4.16). Returns stdout.
-    BuiltIn.Run_Keyword_And_Return    Virtual_Env_Run_Cmd_At_Cwd    pip install ${package}    stderr_must_be_empty=False
+    [Arguments]    ${package}
+    BuiltIn.Run_Keyword_And_Return
+    ...    Virtual_Env_Run_Cmd_At_Cwd
+    ...    pip install ${package}
+    ...    stderr_must_be_empty=False
 
 Virtual_Env_Uninstall_Package
 
 Virtual_Env_Uninstall_Package
-    [Arguments]    ${package}
     [Documentation]    Uninstalls python package from virtual env and returns stdout.
     [Documentation]    Uninstalls python package from virtual env and returns stdout.
-    BuiltIn.Run_Keyword_And_Return    Virtual_Env_Run_Cmd_At_Cwd    pip uninstall -y ${package}    stderr_must_be_empty=False
+    [Arguments]    ${package}
+    BuiltIn.Run_Keyword_And_Return
+    ...    Virtual_Env_Run_Cmd_At_Cwd
+    ...    pip uninstall -y ${package}
+    ...    stderr_must_be_empty=False
 
 Virtual_Env_Freeze
     [Documentation]    Shows installed packages within the returned stdout.
     BuiltIn.Run_Keyword_And_Return    Virtual_Env_Run_Cmd_At_Cwd    pip freeze --all    stderr_must_be_empty=False
 
 Virtual_Env_Activate_On_Current_Session
 
 Virtual_Env_Freeze
     [Documentation]    Shows installed packages within the returned stdout.
     BuiltIn.Run_Keyword_And_Return    Virtual_Env_Run_Cmd_At_Cwd    pip freeze --all    stderr_must_be_empty=False
 
 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.
     [Documentation]    Activates virtual environment. To run anything in the env activated this way you should use SSHLibrary.Write and Read commands.
+    [Arguments]    ${log_output}=${False}
     SSHLibrary.Write    source ${SSHKeywords__current_venv_path}/bin/activate
     SSHLibrary.Write    source ${SSHKeywords__current_venv_path}/bin/activate
-    ${output}=    SSHLibrary.Read_Until_Prompt
-    BuiltIn.Run_Keyword_If    ${log_output}==${True}    BuiltIn.Log    ${output}
+    ${output} =    SSHLibrary.Read_Until_Prompt
+    IF    ${log_output}==${True}    BuiltIn.Log    ${output}
 
 Virtual_Env_Deactivate_On_Current_Session
 
 Virtual_Env_Deactivate_On_Current_Session
-    [Arguments]    ${log_output}=${False}
     [Documentation]    Deactivates virtual environment.
     [Documentation]    Deactivates virtual environment.
+    [Arguments]    ${log_output}=${False}
     SSHLibrary.Write    deactivate
     SSHLibrary.Write    deactivate
-    ${output}=    SSHLibrary.Read_Until_Prompt
-    BuiltIn.Run_Keyword_If    ${log_output}==${True}    BuiltIn.Log    ${output}
+    ${output} =    SSHLibrary.Read_Until_Prompt
+    IF    ${log_output}==${True}    BuiltIn.Log    ${output}
 
 Unsafe_Copy_File_To_Remote_System
 
 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.
     [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.
+    [Arguments]    ${system}    ${source}    ${destination}=./    ${user}=${DEFAULT_USER}    ${password}=${DEFAULT_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}
+    ...    ${prompt_timeout}=5s
     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
     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.
     [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}
+    [Arguments]    ${system}    ${source}    ${destination}=./    ${user}=${DEFAULT_USER}    ${password}=${DEFAULT_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}
+    ...    ${prompt_timeout}=5s
+    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
 
 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
     [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}
+    [Arguments]    ${system}    ${source}    ${destination}=./
+    SSHKeywords.Copy_File_To_Remote_System
+    ...    ${system}
+    ...    ${source}
+    ...    ${destination}
+    ...    ${ODL_SYSTEM_USER}
+    ...    ${ODL_SYSTEM_PASSWORD}
+    ...    ${ODL_SYSTEM_PROMPT}
 
 Copy_File_To_Tools_System
 
 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
     [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}
+    [Arguments]    ${system}    ${source}    ${destination}=./
+    SSHKeywords.Copy_File_To_Remote_System
+    ...    ${system}
+    ...    ${source}
+    ...    ${destination}
+    ...    ${TOOLS_SYSTEM_USER}
+    ...    ${TOOLS_SYSTEM_PASSWORD}
+    ...    ${TOOLS_SYSTEM_PROMPT}
 
 Flexible_SSH_Login
 
 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.
     [Documentation]    On active SSH session: if given non-empty password, do Login, else do Login With Public Key.
+    [Arguments]    ${user}    ${password}=${EMPTY}    ${delay}=0.5s
     ${pwd_length} =    BuiltIn.Get Length    ${password}
     # ${pwd_length} is guaranteed to be an integer, so we are safe to evaluate it as Python expression.
     ${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}
+    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
 
 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.
     [Documentation]    Call Flexible SSH Login, but with default values suitable for Mininet machine.
+    [Arguments]    ${user}=${TOOLS_SYSTEM_USER}    ${password}=${TOOLS_SYSTEM_PASSWORD}    ${delay}=0.5s
     BuiltIn.Run Keyword And Return    Flexible SSH Login    user=${user}    password=${password}    delay=${delay}
 
 Flexible_Controller_Login
     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.
     [Documentation]    Call Flexible SSH Login, but with default values suitable for Controller machine.
+    [Arguments]    ${user}=${ODL_SYSTEM_USER}    ${password}=${ODL_SYSTEM_PASSWORD}    ${delay}=0.5s
     BuiltIn.Run Keyword And Return    Flexible SSH Login    user=${user}    password=${password}    delay=${delay}
 
 Move_File_To_Remote_System
     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.
     [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
     [Arguments]    ${system}    ${source}    ${destination}=./    ${user}=${DEFAULT_USER}    ${password}=${DEFAULT_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}
     ...    ${prompt_timeout}=5s
+    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
     [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.
     [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.
+    [Arguments]    ${system}    ${source}    ${destination}=./    ${user}=${DEFAULT_USER}    ${password}=${DEFAULT_PASSWORD}    ${prompt}=${DEFAULT_LINUX_PROMPT}
+    ...    ${prompt_timeout}=5s
     SSHLibrary.Open_Connection    ${system}    prompt=${prompt}    timeout=${prompt_timeout}
     Flexible_SSH_Login    ${user}    ${password}
     SSHLibrary.Put File    ${source}    ${destination}
     SSHLibrary.Open_Connection    ${system}    prompt=${prompt}    timeout=${prompt_timeout}
     Flexible_SSH_Login    ${user}    ${password}
     SSHLibrary.Put File    ${source}    ${destination}
Integration test