aboutsummaryrefslogtreecommitdiffstats
path: root/robot/resources/ssh
diff options
context:
space:
mode:
Diffstat (limited to 'robot/resources/ssh')
-rw-r--r--robot/resources/ssh/files.robot50
-rw-r--r--robot/resources/ssh/processes.robot74
2 files changed, 124 insertions, 0 deletions
diff --git a/robot/resources/ssh/files.robot b/robot/resources/ssh/files.robot
new file mode 100644
index 00000000..798ce89e
--- /dev/null
+++ b/robot/resources/ssh/files.robot
@@ -0,0 +1,50 @@
+*** Settings ***
+Documentation Some handy Keywords for accessing log files over SSH. Assumptions are that logs will belong to users other than the currently logged in user and that sudo will be required
+Library OperatingSystem
+Library SSHLibrary
+Library HttpLibrary.HTTP
+Library String
+Library Collections
+
+*** Variables ***
+
+*** Keywords ***
+Open Connection And Log In
+ [Documentation] Open a connection using the passed user and SSH key. Connection alias will be the host name by default.
+ [Arguments] ${HOST} ${user} ${pvt} ${password}= ${alias}=${HOST} ${timeout}=20s
+ Open Connection ${HOST} alias=${alias} timeout=${timeout}
+ Login With Public Key ${user} ${pvt} password=${password} delay=0.5 seconds
+
+Grep Local File
+ [Documentation] Grep the passed file name and return all of the lines that match the passed pattern using the current connection
+ [Arguments] ${pattern} ${fullpath}
+ ${output}= Execute Command grep ${pattern} ${fullpath}
+ [Return] ${output}
+
+ Grep File on Host
+ [Documentation] Grep the passed file name and return all of the lines that match the passed pattern using passed connection alias/host
+ [Arguments] ${host} ${pattern} ${fullpath}
+ Switch Connection ${host}
+ ${output}= Grep Local File ${pattern} ${fullpath}
+ @{lines}= Split To Lines ${output}
+ [Return] @{lines}
+
+Grep File on Hosts
+ [Documentation] Grep the passed file name and return all of the lines that match the passed pattern using passed list of connections
+ [Arguments] ${HOSTS} ${pattern} ${fullpath}
+ &{map}= Create Dictionary
+ :FOR ${HOST} IN @{HOSTS}
+ \ Log ${HOST}
+ \ @{lines}= Grep File on Host ${HOST} ${pattern} ${fullpath}
+ \ &{map}= Create Dictionary ${HOST}=@{lines} &{map}
+ [Return] &{map}
+
+Tail File on Host Until
+ [Documentation] Tail log file into grep which returns file lines containing the grep pattern. Will timeout after timeout= if expected pattern not received.
+ [Arguments] ${host} ${pattern} ${fullpath} ${expected} ${timeout}=60 ${options}=-c -0
+ Switch Connection ${host}
+ ${tailcommand}= Catenate tail ${options} -f ${fullpath} | grep --color=never ${pattern}
+ Write ${tailcommand}
+ ${stdout}= Read Until Regexp ${expected}
+ @{lines}= Split To Lines ${stdout}
+ [Return] @{lines}
diff --git a/robot/resources/ssh/processes.robot b/robot/resources/ssh/processes.robot
new file mode 100644
index 00000000..e9f37318
--- /dev/null
+++ b/robot/resources/ssh/processes.robot
@@ -0,0 +1,74 @@
+*** Settings ***
+Documentation Some handy Keywords for accessing log files over SSH. Assumptions are that logs will belong to users other than the currently logged in user and that sudo will be required
+Library OperatingSystem
+Library SSHLibrary 60 seconds
+Library HttpLibrary.HTTP
+Library String
+Library Collections
+
+*** Variables ***
+
+*** Keywords ***
+
+Get Processes
+ [Documentation] Returns all of the processes on the currently connected host
+ ${output}= Execute Command ps -ef
+ ${map}= Create Process Map ${output}
+ [Return] ${map}
+
+Grep Processes
+ [Documentation] Return the list of processes matching the passed regex
+ [Arguments] ${pattern}
+ ${output}= Execute Command ps -ef|grep "${pattern}"|grep -v grep
+ ${map}= Create Process Map ${output}
+ [Return] ${map}
+
+Create Process Map
+ [Documentation] Extract process pids and process names from ps -ef output
+ [Arguments] ${input}
+ @{lines}= Split To Lines ${input}
+ ${map}= Create Dictionary
+ :for ${line} in @{lines}
+ \ @{parts}= Split String ${line} max_split=7
+ \ ${pid}= Catenate ${parts[1]}
+ \ ${name}= Catenate ${parts[7]}
+ \ Set To Dictionary ${map} ${pid}=${name}
+ [Return] ${map}
+
+
+Wait for Process on Host
+ [Documentation] Wait for the passed process name (regular expression) to be running on the passed host
+ [Arguments] ${process_name} ${host} ${timeout}=600s
+ ${map}= Wait Until Keyword Succeeds ${timeout} 10 sec Is Process On Host ${process_name} ${host}
+ [Return] ${map}
+
+
+Pkill Process on Host
+ [Documentation] Kill the named process(es). Process name must match exactly
+ [Arguments] ${process_name} ${host} ${timeout}=600s
+ Switch Connection ${host}
+ ${output}= Execute Command pkill -9 -e -f ${process_name}
+ [Return] ${output}
+
+Is Process on Host
+ [Documentation] Look for the passed process name (regex) to be running on the passed host. Process name can include regex.
+ [Arguments] ${process_name} ${host}
+ Switch Connection ${host}
+ ${pass} ${map}= Run Keyword and Ignore Error Grep Processes ${process_name}
+ @{pids}= Get Dictionary Keys ${map}
+ ${foundpid}= Catenate ""
+ :for ${pid} in @{pids}
+ \ ${process_cmd}= Get From Dictionary ${map} ${pid}
+ \ ${status} ${value}= Run Keyword And Ignore Error Should Match Regexp ${process_cmd} ${process_name}
+ \ Run Keyword If '${status}' == 'PASS' Set Test Variable ${foundpid} ${pid}
+ Should Not Be Equal ${foundpid} ""
+ [Return] ${map}[${foundpid}]
+
+
+Get Process List on Host
+ [Documentation] Gets the list of all processes on the passed host
+ [Arguments] ${host}
+ Switch Connection ${host}
+ ${map}= Get Processes
+ [Return] ${map}
+ \ No newline at end of file