Documentation Karaf library. This library is useful to deal with controller Karaf console.
Library SSHLibrary
Library OperatingSystem
-Variables ../variables/Variables.py
+Resource ${CURDIR}/SSHKeywords.robot
+Variables ${CURDIR}/../variables/Variables.py
*** Variables ***
${WORKSPACE} /tmp
-${BUNDLEFOLDER} distribution-karaf-0.3.0-SNAPSHOT
${KarafKeywords__karaf_connection_index} -1
*** Keywords ***
[Return] ${output}
Issue Command On Karaf Console
- [Arguments] ${cmd} ${controller}=${ODL_SYSTEM_IP} ${karaf_port}=${KARAF_SHELL_PORT} ${timeout}=5
- [Documentation] Will execute the given ${cmd} by ssh'ing to the karaf console running on ${ODL_SYSTEM_IP}
+ [Arguments] ${cmd} ${controller}=${ODL_SYSTEM_IP} ${karaf_port}=${KARAF_SHELL_PORT} ${timeout}=5 ${loglevel}=INFO
+ [Documentation] Will execute the given ${cmd} by ssh'ing to the karaf console running on ${controller}
... Note that this keyword will open&close new SSH connection, without switching back to previously current session.
Open Connection ${controller} port=${karaf_port} prompt=${KARAF_PROMPT} timeout=${timeout}
- Login ${KARAF_USER} ${KARAF_PASSWORD}
+ Login ${KARAF_USER} ${KARAF_PASSWORD} loglevel=${loglevel}
Write ${cmd}
${output} Read Until ${KARAF_PROMPT}
Close Connection
Log ${output}
[Return] ${output}
+Safe_Issue_Command_On_Karaf_Console
+ [Arguments] ${cmd} ${controller}=${ODL_SYSTEM_IP} ${karaf_port}=${KARAF_SHELL_PORT} ${timeout}=5 ${loglevel}=INFO
+ [Documentation] Run Issue_Command_On_Karaf_Console but restore previous connection afterwards.
+ BuiltIn.Run_Keyword_And_Return SSHKeywords.Run_Keyword_Preserve_Connection Issue_Command_On_Karaf_Console ${cmd} ${controller} ${karaf_port} ${timeout}
+ ... ${loglevel}
+
+Check For Elements On Karaf Command Output Message
+ [Arguments] ${cmd} ${elements} ${controller}=${ODL_SYSTEM_IP} ${karaf_port}=${KARAF_SHELL_PORT} ${timeout}=5
+ [Documentation] Will execute the command using Issue Command On Karaf Console then check for the given elements
+ ... in the command output message
+ ${output} Issue Command On Karaf Console ${cmd} ${controller} ${karaf_port} ${timeout}
+ : FOR ${i} IN @{elements}
+ \ Should Contain ${output} ${i}
+
Verify Bundle Is Installed
[Arguments] ${bundle_name} ${controller}=${ODL_SYSTEM_IP} ${karaf_port}=${KARAF_SHELL_PORT}
[Documentation] Will succeed if the given ${bundle name} is present in the output of "bundle:list -s "
\ Should Contain ${output} ${message}
[Return] ${output}
-Check Karaf Log File Does Not Have Messages
- [Arguments] ${ip} ${message} ${user}=${CONTROLLER_USER} ${password}=${CONTROLLER_PASSWORD} ${prompt}=${DEFAULT_LINUX_PROMPT} ${log_file}=${WORKSPACE}/${BUNDLEFOLDER}/data/log/karaf.log
- [Documentation] Fails if the provided ${message} is found in the karaf.log file. Uses grep to search. The
- ... karaf.log file can be overridden with ${log_file} to be any file on the given system @ ${ip}
- ${output}= Run Command On Controller ${ip} grep -c '${message}' ${log_file} user=${user} password=${password} prompt=${prompt}
- Should Be Equal As Strings ${output} 0
-
Install a Feature
- [Arguments] ${feature_name} ${controller}=${ODL_SYSTEM_IP} ${karaf_port}=${KARAF_SHELL_PORT} ${timeout}=15
+ [Arguments] ${feature_name} ${controller}=${ODL_SYSTEM_IP} ${karaf_port}=${KARAF_SHELL_PORT} ${timeout}=180
[Documentation] Will Install the given ${feature_name}
Log ${timeout}
${output}= Issue Command On Karaf Console feature:install ${feature_name} ${controller} ${karaf_port} ${timeout}
[Return] ${output}
Uninstall a Feature
- [Arguments] ${feature_name} ${controller}=${ODL_SYSTEM_IP} ${karaf_port}=${KARAF_SHELL_PORT} ${timeout}=15
+ [Arguments] ${feature_name} ${controller}=${ODL_SYSTEM_IP} ${karaf_port}=${KARAF_SHELL_PORT} ${timeout}=180
[Documentation] Will UnInstall the given ${feature_name}
${output}= Issue Command On Karaf Console feature:uninstall ${feature_name} ${controller} ${karaf_port} ${timeout}
Log ${output}
[Return] ${output}
-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
-
Open Controller Karaf Console On Background
[Documentation] Connect to the controller's karaf console, but do not switch to it.
${current_ssh_connection}= SSHLibrary.Get Connection
${karaf_connection}= SSHLibrary.Get Connection
SSHLibrary.Login ${KARAF_USER} ${KARAF_PASSWORD}
BuiltIn.Set Suite Variable ${KarafKeywords__karaf_connection_index} ${karaf_connection.index}
- Restore Current SSH Connection From Index ${current_ssh_connection.index}
+ [Teardown] SSHKeywords.Restore Current SSH Connection From Index ${current_ssh_connection.index}
Configure Timeout For Karaf Console
[Arguments] ${timeout}
BuiltIn.Run Keyword If ${KarafKeywords__karaf_connection_index} == -1 Fail Need to connect to a Karaf Console first
${current_connection_index}= SSHLibrary.Switch Connection ${KarafKeywords__karaf_connection_index}
SSHLibrary.Set_Client_Configuration timeout=${timeout}
- Restore Current SSH Connection From Index ${current_connection_index}
+ [Teardown] SshKeywords.Restore Current SSH Connection From Index ${current_connection_index}
Execute Controller Karaf Command On Background
[Arguments] ${command}
${current_connection_index}= SSHLibrary.Switch Connection ${KarafKeywords__karaf_connection_index}
${status_write} ${message_write}= BuiltIn.Run Keyword And Ignore Error SSHLibrary.Write ${command}
${status_wait} ${message_wait}= BuiltIn.Run Keyword And Ignore Error SSHLibrary.Read Until Prompt
- Restore Current SSH Connection From Index ${current_connection_index}
BuiltIn.Run Keyword If '${status_write}' != 'PASS' BuiltIn.Fail Failed to send the command: ${command}
BuiltIn.Log ${message_wait}
BuiltIn.Run Keyword If '${status_wait}' != 'PASS' BuiltIn.Fail Failed to see prompt after sending the command: ${command}
+ [Teardown] SshKeywords.Restore Current SSH Connection From Index ${current_connection_index}
[Return] ${message_wait}
Execute Controller Karaf Command With Retry On Background
[Arguments] ${command}
[Documentation] Attemp to send command to karaf, if fail then open connection and try again.
+ # As an attempt to debug intermittent SSH failures in the karaf logging command, we want to know the avail entropy on the controller system
+ Run Command On Controller cmd=cat /proc/sys/kernel/random/entropy_avail
${status} ${message}= BuiltIn.Run Keyword And Ignore Error Execute Controller Karaf Command On Background ${command}
BuiltIn.Return_From_Keyword_If '${status}' == 'PASS' ${message}
# TODO: Verify this does not leak connections indices.
Code Review / integration / test.git / blobdiff