blob: 8cb4d7101c563a1b6534cf15d55c0c3cce4dd20a [file] [log] [blame]
Chris Austenb29d2e82016-06-07 12:25:35 -05001*** Settings ***
2Resource ../lib/resource.txt
3Resource ../lib/rest_client.robot
George Keishing5e870cd2016-08-24 10:05:47 -05004Resource ../lib/connection_client.robot
George Keishing30c12ff2016-09-02 10:25:29 -05005Library DateTime
6Library Process
Chris Austenb29d2e82016-06-07 12:25:35 -05007Library OperatingSystem
Michael Walsha6723f22016-11-22 11:12:01 -06008Library gen_print.py
9Library gen_robot_print.py
Chris Austenb29d2e82016-06-07 12:25:35 -050010
11*** Variables ***
12${SYSTEM_SHUTDOWN_TIME} ${5}
Michael Walsha6723f22016-11-22 11:12:01 -060013${dbuscmdBase}
George Keishing85ca05e2016-11-30 09:47:18 -060014... dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host
Michael Walsha6723f22016-11-22 11:12:01 -060015${dbuscmdGet}
George Keishing9485af92017-01-04 10:21:43 -060016... ${SETTINGS_URI}host0 org.freedesktop.DBus.Properties.Get
George Keishing85ca05e2016-11-30 09:47:18 -060017# Enable when ready with openbmc/openbmc-test-automation#203
18#${dbuscmdString}= string:"xyz.openbmc_project.settings.Host" string:
Michael Walsha6723f22016-11-22 11:12:01 -060019${dbuscmdString}= string:"org.openbmc.settings.Host" string:
20
George Keishing85ca05e2016-11-30 09:47:18 -060021
Michael Walsha6723f22016-11-22 11:12:01 -060022# Assign default value to QUIET for programs which may not define it.
23${QUIET} ${0}
Sivas SRRea85d1f2016-11-13 22:44:28 -060024${bmc_mem_free_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4
25${bmc_mem_total_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2
26${bmc_cpu_usage_cmd}= top -n 1 | grep CPU: | cut -c 7-9
Chris Austenb29d2e82016-06-07 12:25:35 -050027
28*** Keywords ***
Chris Austenb29d2e82016-06-07 12:25:35 -050029Wait For Host To Ping
root442f0ef2016-08-04 20:23:05 +000030 [Arguments] ${host} ${timeout}=${OPENBMC_REBOOT_TIMEOUT}min
31 ... ${interval}=5 sec
32
33 # host The DNS name or IP of the host to ping.
34 # timeout The amount of time after which attempts to ping cease.
35 # interval The amount of time in between attempts to ping.
36
37 Wait Until Keyword Succeeds ${timeout} ${interval} Ping Host ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -050038
39Ping Host
40 [Arguments] ${host}
George Keishing8a84f952016-08-25 04:54:53 -050041 Should Not Be Empty ${host} msg=No host provided
Michael Walsha6723f22016-11-22 11:12:01 -060042 ${RC} ${output}= Run and return RC and Output ping -c 4 ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -050043 Log RC: ${RC}\nOutput:\n${output}
44 Should be equal ${RC} ${0}
45
46Get Boot Progress
Michael Walsha6723f22016-11-22 11:12:01 -060047 [Arguments] ${quiet}=${QUIET}
48
George Keishing85ca05e2016-11-30 09:47:18 -060049 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
Michael Walsha6723f22016-11-22 11:12:01 -060050 ... value quiet=${quiet}
Gunnar Millsc9ea9362016-12-13 16:21:13 -060051 [Return] ${state}
Chris Austenb29d2e82016-06-07 12:25:35 -050052
53Is Power On
root442f0ef2016-08-04 20:23:05 +000054 ${state}= Get Power State
55 Should be equal ${state} ${1}
Chris Austenb29d2e82016-06-07 12:25:35 -050056
57Is Power Off
root442f0ef2016-08-04 20:23:05 +000058 ${state}= Get Power State
59 Should be equal ${state} ${0}
Chris Austenb29d2e82016-06-07 12:25:35 -050060
root442f0ef2016-08-04 20:23:05 +000061Initiate Power On
62 [Documentation] Initiates the power on and waits until the Is Power On
63 ... keyword returns that the power state has switched to on.
Michael Walsha6723f22016-11-22 11:12:01 -060064 [Arguments] ${wait}=${1}
65
Chris Austenb29d2e82016-06-07 12:25:35 -050066 @{arglist}= Create List
67 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -060068 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
Michael Walsha6723f22016-11-22 11:12:01 -060069 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -050070 should be equal as strings ${resp.status_code} ${HTTP_OK}
Chris Austenb29d2e82016-06-07 12:25:35 -050071
Michael Walsha6723f22016-11-22 11:12:01 -060072 # Does caller want to wait for power on status?
73 Run Keyword If '${wait}' == '${0}' Return From Keyword
74 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
Rahul Maheshwarif684ba72016-10-25 07:24:41 -050075
root442f0ef2016-08-04 20:23:05 +000076Initiate Power Off
77 [Documentation] Initiates the power off and waits until the Is Power Off
78 ... keyword returns that the power state has switched to off.
Chris Austenb29d2e82016-06-07 12:25:35 -050079 @{arglist}= Create List
80 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -060081 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
Michael Walsha6723f22016-11-22 11:12:01 -060082 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -050083 should be equal as strings ${resp.status_code} ${HTTP_OK}
Michael Walsha6723f22016-11-22 11:12:01 -060084 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
Chris Austenb29d2e82016-06-07 12:25:35 -050085
86Trigger Warm Reset
87 log to console "Triggering warm reset"
Michael Walsha6723f22016-11-22 11:12:01 -060088 ${data}= create dictionary data=@{EMPTY}
George Keishing85ca05e2016-11-30 09:47:18 -060089 ${resp}= openbmc post request
90 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
Chris Austenb29d2e82016-06-07 12:25:35 -050091 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
George Keishingb3700812016-08-31 03:03:30 -050092 ${session_active}= Check If warmReset is Initiated
93 Run Keyword If '${session_active}' == '${True}'
94 ... Fail msg=warm reset didn't occur
95
Chris Austenb29d2e82016-06-07 12:25:35 -050096 Sleep ${SYSTEM_SHUTDOWN_TIME}min
97 Wait For Host To Ping ${OPENBMC_HOST}
Michael Walsh49ab0f42016-07-20 11:44:33 -050098
99Check OS
root442f0ef2016-08-04 20:23:05 +0000100 [Documentation] Attempts to ping the host OS and then checks that the host
101 ... OS is up by running an SSH command.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500102
103 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walsha6723f22016-11-22 11:12:01 -0600104 ... ${os_password}=${OS_PASSWORD} ${quiet}=${QUIET}
105 ... ${print_string}=${EMPTY}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500106 [Teardown] Close Connection
107
108 # os_host The DNS name/IP of the OS host associated with our BMC.
109 # os_username The username to be used to sign on to the OS host.
110 # os_password The password to be used to sign on to the OS host.
Michael Walsha6723f22016-11-22 11:12:01 -0600111 # quiet Indicates whether this keyword should write to console.
112 # print_string A string to be printed before checking the OS.
113
114 rprint ${print_string}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500115
root442f0ef2016-08-04 20:23:05 +0000116 # Attempt to ping the OS. Store the return code to check later.
117 ${ping_rc}= Run Keyword and Return Status Ping Host ${os_host}
118
Michael Walsh49ab0f42016-07-20 11:44:33 -0500119 Open connection ${os_host}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500120
Michael Walsha6723f22016-11-22 11:12:01 -0600121 ${status} ${msg}= Run Keyword And Ignore Error Login ${os_username}
122 ... ${os_password}
123 ${err_msg1}= Sprint Error ${msg}
124 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
125 Run Keyword If '${status}' == 'FAIL' Fail msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500126 ${output} ${stderr} ${rc}= Execute Command uptime return_stderr=True
127 ... return_rc=True
128
Michael Walsha6723f22016-11-22 11:12:01 -0600129 ${temp_msg}= Catenate Could not execute a command on the operating
130 ... system.\n
131 ${err_msg1}= Sprint Error ${temp_msg}
132 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
133
134 # If the return code returned by "Execute Command" is non-zero, this
135 # keyword will fail.
136 Should Be Equal ${rc} ${0} msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500137 # We will likewise fail if there is any stderr data.
138 Should Be Empty ${stderr}
139
Michael Walsha6723f22016-11-22 11:12:01 -0600140 ${temp_msg}= Set Variable Could not ping the operating system.\n
141 ${err_msg1}= Sprint Error ${temp_msg}
142 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
143 # We will likewise fail if the OS did not ping, as we could SSH but not
144 # ping
145 Should Be Equal As Strings ${ping_rc} ${TRUE} msg=${err_msg}
root442f0ef2016-08-04 20:23:05 +0000146
Michael Walsh49ab0f42016-07-20 11:44:33 -0500147Wait for OS
148 [Documentation] Waits for the host OS to come up via calls to "Check OS".
149 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
150 ... ${os_password}=${OS_PASSWORD} ${timeout}=${OS_WAIT_TIMEOUT}
Michael Walsha6723f22016-11-22 11:12:01 -0600151 ... ${quiet}=${0}
152 [Teardown] rprintn
Michael Walsh49ab0f42016-07-20 11:44:33 -0500153
154 # os_host The DNS name or IP of the OS host associated with our
155 # BMC.
156 # os_username The username to be used to sign on to the OS host.
157 # os_password The password to be used to sign on to the OS host.
158 # timeout The timeout in seconds indicating how long you're
159 # willing to wait for the OS to respond.
Michael Walsha6723f22016-11-22 11:12:01 -0600160 # quiet Indicates whether this keyword should write to console.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500161
162 # The interval to be used between calls to "Check OS".
163 ${interval}= Set Variable 5
164
Michael Walsha6723f22016-11-22 11:12:01 -0600165 ${message}= Catenate Checking every ${interval} seconds for up to
166 ... ${timeout} seconds for the operating system to communicate.
167 rqprint_timen ${message}
168
Michael Walsh49ab0f42016-07-20 11:44:33 -0500169 Wait Until Keyword Succeeds ${timeout} sec ${interval} Check OS
170 ... ${os_host} ${os_username} ${os_password}
Michael Walsha6723f22016-11-22 11:12:01 -0600171 ... print_string=\#
172
173 rqprintn
174
175 rqprint_timen The operating system is now communicating.
root442f0ef2016-08-04 20:23:05 +0000176
177Get BMC State
178 [Documentation] Returns the state of the BMC as a string. (i.e: BMC_READY)
Michael Walsha6723f22016-11-22 11:12:01 -0600179 [Arguments] ${quiet}=${QUIET}
180
root442f0ef2016-08-04 20:23:05 +0000181 @{arglist}= Create List
182 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600183 ${resp}= Call Method ${OPENBMC_BASE_URI}managers/System/ getSystemState
Michael Walsha6723f22016-11-22 11:12:01 -0600184 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000185 Should be equal as strings ${resp.status_code} ${HTTP_OK}
186 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600187 [Return] ${content["data"]}
root442f0ef2016-08-04 20:23:05 +0000188
189Get Power State
190 [Documentation] Returns the power state as an integer. Either 0 or 1.
Michael Walsha6723f22016-11-22 11:12:01 -0600191 [Arguments] ${quiet}=${QUIET}
192
root442f0ef2016-08-04 20:23:05 +0000193 @{arglist}= Create List
194 ${args}= Create Dictionary data=@{arglist}
Michael Walsha6723f22016-11-22 11:12:01 -0600195
George Keishing85ca05e2016-11-30 09:47:18 -0600196 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
Michael Walsha6723f22016-11-22 11:12:01 -0600197 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000198 Should be equal as strings ${resp.status_code} ${HTTP_OK}
199 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600200 [Return] ${content["data"]}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500201
202Clear BMC Record Log
203 [Documentation] Clears all the event logs on the BMC. This would be
204 ... equivalent to ipmitool sel clear.
205 @{arglist}= Create List
206 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600207 ${resp}= Call Method
208 ... ${OPENBMC_BASE_URI}records/events/ clear data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500209 should be equal as strings ${resp.status_code} ${HTTP_OK}
210
211Copy PNOR to BMC
212 Import Library SCPLibrary WITH NAME scp
213 Open Connection for SCP
214 Log Copying ${PNOR_IMAGE_PATH} to /tmp
215 scp.Put File ${PNOR_IMAGE_PATH} /tmp
216
217Flash PNOR
218 [Documentation] Calls flash bios update method to flash PNOR image
Gunnar Mills38032802016-12-12 13:43:40 -0600219 [Arguments] ${pnor_image}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500220 @{arglist}= Create List ${pnor_image}
221 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600222 ${resp}= Call Method ${OPENBMC_BASE_URI}control/flash/bios/ update
Michael Walsha6723f22016-11-22 11:12:01 -0600223 ... data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500224 should be equal as strings ${resp.status_code} ${HTTP_OK}
225 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
226
227Get Flash BIOS Status
228 [Documentation] Returns the status of the flash BIOS API as a string. For
229 ... example 'Flashing', 'Flash Done', etc
George Keishing85ca05e2016-11-30 09:47:18 -0600230 ${data}= Read Properties ${OPENBMC_BASE_URI}control/flash/bios
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600231 [Return] ${data['status']}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500232
233Is PNOR Flashing
234 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
235 ... flashing has started.
236 ${status}= Get Flash BIOS Status
237 should be equal as strings ${status} Flashing
238
239Is PNOR Flash Done
240 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
241 ... PNOR flashing has completed.
Leah McNutt9ba32272016-11-17 15:48:39 +0000242 ${status}= Get Flash BIOS Status
Jay Azurine4c52eb2016-08-16 20:51:10 -0500243 should be equal as strings ${status} Flash Done
244
245Is System State Host Booted
246 [Documentation] Checks whether system state is HOST_BOOTED.
247 ${state}= Get BMC State
248 should be equal as strings ${state} HOST_BOOTED
George Keishing5e870cd2016-08-24 10:05:47 -0500249
250Verify Ping and REST Authentication
Michael Walsha6723f22016-11-22 11:12:01 -0600251 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500252 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -0500253 Run Keyword If '${l_ping}' == '${False}'
254 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500255
Michael Walsha6723f22016-11-22 11:12:01 -0600256 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500257 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -0500258 Run Keyword If '${l_rest}' == '${False}'
259 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500260
261 # Just to make sure the SSH is working for SCP
262 Open Connection And Log In
263 ${system} ${stderr}= Execute Command hostname return_stderr=True
264 Should Be Empty ${stderr}
265
George Keishingc4d3dc02016-09-19 03:45:55 -0500266Check If BMC is Up
267 [Documentation] Wait for Host to be online. Checks every X seconds
268 ... interval for Y minutes and fails if timed out.
269 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -0600270 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -0500271 ... ${interval}=10 sec
272
273 Wait Until Keyword Succeeds
274 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
275
George Keishingb3700812016-08-31 03:03:30 -0500276
277Check If warmReset is Initiated
278 [Documentation] Ping would be still alive, so try SSH to connect
279 ... if fails the ports are down indicating reboot
280 ... is in progress
George Keishing3c05d352016-12-13 06:54:50 -0600281
282 # Warm reset adds 3 seconds delay before forcing reboot
283 # To minimize race conditions, we wait for 7 seconds
284 Sleep 7s
George Keishingb3700812016-08-31 03:03:30 -0500285 ${alive}= Run Keyword and Return Status
286 ... Open Connection And Log In
287 Return From Keyword If '${alive}' == '${False}' ${False}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600288 [Return] ${True}
George Keishingb3700812016-08-31 03:03:30 -0500289
George Keishing06ae4aa2016-08-30 01:41:28 -0500290Flush REST Sessions
291 [Documentation] Removes all the active session objects
292 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500293
Sivas SRRe1143ae2016-08-26 22:31:02 -0500294Initialize DBUS cmd
295 [Documentation] Initialize dbus string with property string to extract
Gunnar Mills38032802016-12-12 13:43:40 -0600296 [Arguments] ${boot_property}
Michael Walsha6723f22016-11-22 11:12:01 -0600297 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
298 ${cmd}= Catenate ${cmd}${boot_property}
Sivas SRRe1143ae2016-08-26 22:31:02 -0500299 Set Global Variable ${dbuscmd} ${cmd}
300
George Keishing30c12ff2016-09-02 10:25:29 -0500301
Gunnar Mills9c760342016-12-08 10:12:06 -0600302Stop OBMC Console Client
303 [Documentation] Stop any running obmc_console_client
304 ... writing to file_path.
305 [Arguments] ${file_path}=/tmp/obmc-console.log
306
307 ${pid}=
308 ... Execute Command
309 ... ps ax | grep obmc-console-client | grep ${file_path} | grep -v grep | awk '{print $1}'
310
311 Run Keyword If '${pid}' != '${EMPTY}'
312 ... Execute Command kill -s KILL ${pid}
313 ... ELSE Log "No obmc-console-client process running"
314
315
George Keishing30c12ff2016-09-02 10:25:29 -0500316Start SOL Console Logging
Gunnar Mills9c760342016-12-08 10:12:06 -0600317 [Documentation] Start a new obmc_console_client process and direct
318 ... output to a file.
319 [Arguments] ${file_path}=/tmp/obmc-console.log
George Keishing30c12ff2016-09-02 10:25:29 -0500320
321 Open Connection And Log In
322
Gunnar Mills9c760342016-12-08 10:12:06 -0600323 Stop OBMC Console Client ${file_path}
324
George Keishing30c12ff2016-09-02 10:25:29 -0500325 Start Command
Gunnar Mills9c760342016-12-08 10:12:06 -0600326 ... obmc-console-client > ${file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500327
328
329Stop SOL Console Logging
Gunnar Mills9c760342016-12-08 10:12:06 -0600330 [Documentation] Stop obmc_console_client process, if any, and
331 ... return the console output as a string.
332 [Arguments] ${file_path}=/tmp/obmc-console.log
George Keishing30c12ff2016-09-02 10:25:29 -0500333
334 Open Connection And Log In
335
Gunnar Mills9c760342016-12-08 10:12:06 -0600336 Stop OBMC Console Client ${file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500337
338 ${console} ${stderr}=
339 ... Execute Command
Gunnar Mills9c760342016-12-08 10:12:06 -0600340 ... cat ${file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500341 ... return_stderr=True
Gunnar Mills9c760342016-12-08 10:12:06 -0600342 Should Be Empty ${stderr}
George Keishing30c12ff2016-09-02 10:25:29 -0500343
Gunnar Mills9c760342016-12-08 10:12:06 -0600344 [Return] ${console}
George Keishing30c12ff2016-09-02 10:25:29 -0500345
346
347Get Time Stamp
348 [Documentation] Get the current time stamp data
349 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500350 [Return] ${cur_time}
George Keishing30c12ff2016-09-02 10:25:29 -0500351
George Keishing1b150202016-09-29 08:51:58 -0500352
353Verify BMC State
354 [Documentation] Get the BMC state and verify if the current
355 ... BMC state is as expected.
356 [Arguments] ${expected}
357
358 ${current}= Get BMC State
George Keishing8db0e1b2016-10-20 13:46:54 -0500359 Should Contain ${expected} ${current}
George Keishing1b150202016-09-29 08:51:58 -0500360
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500361Start Journal Log
362 [Documentation] Start capturing journal log to a file in /tmp using
363 ... journalctl command. By default journal log is collected
364 ... at /tmp/journal_log else user input location.
365 ... The File is appended with datetime.
366 [Arguments] ${file_path}=/tmp/journal_log
367
368 Open Connection And Log In
369
370 ${cur_time}= Get Time Stamp
371 Set Global Variable ${LOG_TIME} ${cur_time}
372 Start Command
373 ... journalctl -f > ${file_path}-${LOG_TIME}
374 Log Journal Log Started: ${file_path}-${LOG_TIME}
375
376Stop Journal Log
377 [Documentation] Stop journalctl process if its running.
378 ... By default return log from /tmp/journal_log else
379 ... user input location.
380 [Arguments] ${file_path}=/tmp/journal_log
381
382 Open Connection And Log In
383
384 ${rc}=
385 ... Execute Command
386 ... ps ax | grep journalctl | grep -v grep
387 ... return_stdout=False return_rc=True
388
389 Return From Keyword If '${rc}' == '${1}'
390 ... No journal log process running
391
392 ${output} ${stderr}=
393 ... Execute Command killall journalctl
394 ... return_stderr=True
395 Should Be Empty ${stderr}
396
397 ${journal_log} ${stderr}=
398 ... Execute Command
399 ... cat ${file_path}-${LOG_TIME}
400 ... return_stderr=True
401 Should Be Empty ${stderr}
402
403 Log ${journal_log}
404
405 Execute Command rm ${file_path}-${LOG_TIME}
406
407 [Return] ${journal_log}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500408
409Mac Address To Hex String
410 [Documentation] Converts MAC address into hex format.
411 ... Example
412 ... Given the following MAC: 00:01:6C:80:02:78
413 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
414 ... Description of arguments:
415 ... i_macaddress MAC address in the following format 00:01:6C:80:02:78
416 [Arguments] ${i_macaddress}
417
418 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600419 [Return] ${mac_hex}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500420
421IP Address To Hex String
422 [Documentation] Converts IP address into hex format.
423 ... Example:
424 ... Given the following IP: 10.3.164.100
425 ... This keyword will return: 0xa 0x3 0xa4 0xa0
426 ... Description of arguments:
427 ... i_ipaddress IP address in the following format 10.10.10.10
428 [Arguments] ${i_ipaddress}
429
430 @{ip}= Split String ${i_ipaddress} .
431 ${index}= Set Variable ${0}
432
433 :FOR ${item} IN @{ip}
434 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes
435 \ Set List Value ${ip} ${index} ${hex}
436 \ ${index}= Set Variable ${index + 1}
437 ${ip_hex}= Catenate @{ip}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600438 [Return] ${ip_hex}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600439
440BMC CPU Performance Check
441 [Documentation] Minimal 10% of proc should be free in this instance
442
443 ${bmc_cpu_usage_output} ${stderr}= Execute Command ${bmc_cpu_usage_cmd}
444 ... return_stderr=True
445 Should be empty ${stderr}
446 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} %
447 Should be true ${bmc_cpu_percentage} < 90
448
449BMC Mem Performance Check
450 [Documentation] Minimal 10% of memory should be free in this instance
451
452 ${bmc_mem_free_output} ${stderr}= Execute Command ${bmc_mem_free_cmd}
453 ... return_stderr=True
454 Should be empty ${stderr}
455
456 ${bmc_mem_total_output} ${stderr}= Execute Command ${bmc_mem_total_cmd}
457 ... return_stderr=True
458 Should be empty ${stderr}
459
460 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100
461 ${bmc_mem_percentage}= Evaluate
462 ... ${bmc_mem_percentage}/${bmc_mem_total_output}
463 Should be true ${bmc_mem_percentage} > 10
464
465Check BMC CPU Performance
466 [Documentation] Minimal 10% of proc should be free in 3 sample
467 :FOR ${var} IN Range 1 4
468 \ BMC CPU Performance check
469
470Check BMC Mem Performance
471 [Documentation] Minimal 10% of memory should be free
472
473 :FOR ${var} IN Range 1 4
474 \ BMC Mem Performance check
475
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600476Get Endpoint Paths
477 [Documentation] Returns all url paths ending with given endpoint
478 ... Example:
479 ... Given the following endpoint: cpu
480 ... This keyword will return: list of all urls ending with cpu -
481 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
482 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
483 ... Description of arguments:
484 ... path URL path for enumeration
485 ... endpoint string for which url path ending
486 [Arguments] ${path} ${endpoint}
487
488 ${resp}= Read Properties ${path}/enumerate timeout=30
489 log Dictionary ${resp}
490
491 ${list}= Get Dictionary Keys ${resp}
492 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9]*$
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600493 [Return] ${resp}
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500494
495Check Zombie Process
496 [Documentation] Check if any defunct process exist or not on BMC
497 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l
498 ... return_stderr=True return_rc=True
499 Should Be True ${count}==0
500 Should Be Empty ${stderr}
George Keishing5327d012016-12-08 08:43:29 -0600501
502Prune Journal Log
503 [Documentation] Prune archived journal logs.
504 [Arguments] ${vacuum_size}=1M
505
506 # This keyword can be used to prevent the journal
507 # log from filling up the /run filesystem.
508 # This command will retain only the latest logs
509 # of the user specified size.
510
511 Open Connection And Log In
512 ${output} ${stderr} ${rc}=
513 ... Execute Command
514 ... journalctl --vacuum-size=${vacuum_size}
515 ... return_stderr=True return_rc=True
516
517 Should Be Equal ${rc} ${0} msg=${stderr}
518 Should Contain ${stderr} Vacuuming done