blob: a88879b04880e4b44a478bc3d6f679cddeecce98 [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
Michael Walsh5f3f4142017-05-22 17:09:47 -050010Library gen_cmd.py
Sunil Macd110a2017-05-23 04:14:32 -050011Library gen_robot_keyword.py
Chris Austenb29d2e82016-06-07 12:25:35 -050012
13*** Variables ***
Sivas SRRd97aa9c2017-05-22 11:19:25 -050014${pflash_cmd} /usr/sbin/pflash -r /dev/stdout -P VERSION
Chris Austenb29d2e82016-06-07 12:25:35 -050015${SYSTEM_SHUTDOWN_TIME} ${5}
Michael Walsha6723f22016-11-22 11:12:01 -060016${dbuscmdBase}
George Keishing85ca05e2016-11-30 09:47:18 -060017... dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host
Michael Walsha6723f22016-11-22 11:12:01 -060018${dbuscmdGet}
George Keishing9485af92017-01-04 10:21:43 -060019... ${SETTINGS_URI}host0 org.freedesktop.DBus.Properties.Get
George Keishing85ca05e2016-11-30 09:47:18 -060020# Enable when ready with openbmc/openbmc-test-automation#203
21#${dbuscmdString}= string:"xyz.openbmc_project.settings.Host" string:
Michael Walsha6723f22016-11-22 11:12:01 -060022${dbuscmdString}= string:"org.openbmc.settings.Host" string:
23
24# Assign default value to QUIET for programs which may not define it.
25${QUIET} ${0}
Sivas SRRea85d1f2016-11-13 22:44:28 -060026${bmc_mem_free_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4
27${bmc_mem_total_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2
28${bmc_cpu_usage_cmd}= top -n 1 | grep CPU: | cut -c 7-9
Sridevi Ramesh1699d372016-12-06 00:20:22 -060029${HOST_SETTING} ${SETTINGS_URI}host0
Sivas SRR352bc162017-02-13 22:12:29 -060030# /run/initramfs/ro associate filesystem should be 100% full always
Sivas SRRaca55712016-12-21 04:32:35 -060031${bmc_file_system_usage_cmd}=
Sivas SRR352bc162017-02-13 22:12:29 -060032... df -h | grep -v /run/initramfs/ro | cut -c 52-54 | grep 100 | wc -l
Chris Austenb29d2e82016-06-07 12:25:35 -050033
George Keishingcce9df22017-01-24 06:19:33 -060034${BOOT_TIME} ${0}
35${BOOT_COUNT} ${0}
Sweta Potthuri025e0122017-02-21 00:42:48 -060036${count} ${0}
Sivas SRR8254db62017-02-07 09:39:46 -060037${devicetree_base} /sys/firmware/devicetree/base/model
George Keishingcce9df22017-01-24 06:19:33 -060038
George Keishingb7c9b542017-05-23 08:19:58 -050039# Initialize default debug value to 0.
40${DEBUG} ${0}
41
Chris Austenb29d2e82016-06-07 12:25:35 -050042*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060043
Sivas SRRd97aa9c2017-05-22 11:19:25 -050044Verify PNOR Update
45 [Documentation] Verify that the PNOR is not corrupted.
46 # Example:
47 # FFS: Flash header not found. Code: 100
48 # Error 100 opening ffs !
49
50 Open Connection And Log In
51 ${pnor_info}= Execute Command On BMC ${pflash_cmd}
52 Should Not Contain Any ${pnor_info} Flash header not found Error
53
Sivas SRR8254db62017-02-07 09:39:46 -060054Get BMC System Model
55 [Documentation] Get the BMC model from the device tree.
56
Michael Walshb5839d02017-04-12 16:11:20 -050057 Open Connection And Log In
George Keishing90ab1772017-02-24 05:40:55 -060058 ${bmc_model} ${stderr}= Execute Command
59 ... cat ${devicetree_base} | cut -d " " -f 1 return_stderr=True
Sivas SRR8254db62017-02-07 09:39:46 -060060 Should Be Empty ${stderr}
61 Should Not Be Empty ${bmc_model}
62 [Return] ${bmc_model}
63
64Verify BMC System Model
65 [Documentation] Verify the BMC model with ${OPENBMC_MODEL}.
66 [Arguments] ${bmc_model}
67
68 ${tmp_bmc_model}= Fetch From Right ${OPENBMC_MODEL} /
69 ${tmp_bmc_model}= Fetch From Left ${tmp_bmc_model} .
70 ${ret}= Run Keyword And Return Status Should Contain ${bmc_model}
71 ... ${tmp_bmc_model} ignore_case=True
72 [Return] ${ret}
73
Chris Austenb29d2e82016-06-07 12:25:35 -050074Wait For Host To Ping
root442f0ef2016-08-04 20:23:05 +000075 [Arguments] ${host} ${timeout}=${OPENBMC_REBOOT_TIMEOUT}min
76 ... ${interval}=5 sec
77
78 # host The DNS name or IP of the host to ping.
79 # timeout The amount of time after which attempts to ping cease.
80 # interval The amount of time in between attempts to ping.
81
82 Wait Until Keyword Succeeds ${timeout} ${interval} Ping Host ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -050083
84Ping Host
85 [Arguments] ${host}
George Keishing8a84f952016-08-25 04:54:53 -050086 Should Not Be Empty ${host} msg=No host provided
Michael Walsha6723f22016-11-22 11:12:01 -060087 ${RC} ${output}= Run and return RC and Output ping -c 4 ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -050088 Log RC: ${RC}\nOutput:\n${output}
89 Should be equal ${RC} ${0}
90
91Get Boot Progress
Michael Walsha6723f22016-11-22 11:12:01 -060092 [Arguments] ${quiet}=${QUIET}
93
George Keishing85ca05e2016-11-30 09:47:18 -060094 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
Michael Walsha6723f22016-11-22 11:12:01 -060095 ... value quiet=${quiet}
Gunnar Millsc9ea9362016-12-13 16:21:13 -060096 [Return] ${state}
Chris Austenb29d2e82016-06-07 12:25:35 -050097
98Is Power On
root442f0ef2016-08-04 20:23:05 +000099 ${state}= Get Power State
100 Should be equal ${state} ${1}
Chris Austenb29d2e82016-06-07 12:25:35 -0500101
102Is Power Off
root442f0ef2016-08-04 20:23:05 +0000103 ${state}= Get Power State
104 Should be equal ${state} ${0}
Chris Austenb29d2e82016-06-07 12:25:35 -0500105
root442f0ef2016-08-04 20:23:05 +0000106Initiate Power On
107 [Documentation] Initiates the power on and waits until the Is Power On
108 ... keyword returns that the power state has switched to on.
Michael Walsha6723f22016-11-22 11:12:01 -0600109 [Arguments] ${wait}=${1}
110
Chris Austenb29d2e82016-06-07 12:25:35 -0500111 @{arglist}= Create List
112 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600113 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
Michael Walsha6723f22016-11-22 11:12:01 -0600114 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500115 should be equal as strings ${resp.status_code} ${HTTP_OK}
Chris Austenb29d2e82016-06-07 12:25:35 -0500116
Michael Walsha6723f22016-11-22 11:12:01 -0600117 # Does caller want to wait for power on status?
118 Run Keyword If '${wait}' == '${0}' Return From Keyword
119 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500120
root442f0ef2016-08-04 20:23:05 +0000121Initiate Power Off
122 [Documentation] Initiates the power off and waits until the Is Power Off
123 ... keyword returns that the power state has switched to off.
Chris Austenb29d2e82016-06-07 12:25:35 -0500124 @{arglist}= Create List
125 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600126 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
Michael Walsha6723f22016-11-22 11:12:01 -0600127 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500128 should be equal as strings ${resp.status_code} ${HTTP_OK}
Michael Walsha6723f22016-11-22 11:12:01 -0600129 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
Chris Austenb29d2e82016-06-07 12:25:35 -0500130
Michael Walsh81843772017-03-02 14:44:44 -0600131Initiate OS Host Power Off
132 [Documentation] Initiate an OS reboot.
133 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
134 ... ${os_password}=${OS_PASSWORD}
135
136 # Description of arguments:
137 # os_host The DNS name or IP of the OS.
138 # os_username The username to be used to sign in to the OS.
139 # os_password The password to be used to sign in to the OS.
140
Michael Walshac275512017-03-07 11:39:28 -0600141 SSHLibrary.Open connection ${os_host}
Michael Walsh81843772017-03-02 14:44:44 -0600142 Login ${os_username} ${os_password}
143 ${cmd_buf} Catenate shutdown
144 Start Command ${cmd_buf}
Michael Walshac275512017-03-07 11:39:28 -0600145 SSHLibrary.Close Connection
Michael Walsh81843772017-03-02 14:44:44 -0600146
147Initiate OS Host Reboot
148 [Documentation] Initiate an OS reboot.
149 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
150 ... ${os_password}=${OS_PASSWORD}
151
152 # Description of arguments:
153 # os_host The DNS name or IP of the OS.
154 # os_username The username to be used to sign in to the OS.
155 # os_password The password to be used to sign in to the OS.
156
Michael Walshac275512017-03-07 11:39:28 -0600157 SSHLibrary.Open connection ${os_host}
Michael Walsh81843772017-03-02 14:44:44 -0600158 Login ${os_username} ${os_password}
159 ${cmd_buf} Catenate reboot
160 Start Command ${cmd_buf}
Michael Walshac275512017-03-07 11:39:28 -0600161 SSHLibrary.Close Connection
Michael Walsh81843772017-03-02 14:44:44 -0600162
163Initiate Auto Reboot
164 [Documentation] Initiate an auto reboot.
165
166 # Set the auto reboot policy.
167 Set Auto Reboot yes
Michael Walsh81843772017-03-02 14:44:44 -0600168 # Set the watchdog timer. Note: 5000 = milliseconds which is 5 seconds.
George Keishing37cfa6b2017-06-15 10:25:55 -0500169 Trigger Host Watchdog Error 5000
Michael Walsh81843772017-03-02 14:44:44 -0600170
Chris Austenb29d2e82016-06-07 12:25:35 -0500171Trigger Warm Reset
172 log to console "Triggering warm reset"
Michael Walsha6723f22016-11-22 11:12:01 -0600173 ${data}= create dictionary data=@{EMPTY}
George Keishing85ca05e2016-11-30 09:47:18 -0600174 ${resp}= openbmc post request
175 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
Chris Austenb29d2e82016-06-07 12:25:35 -0500176 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
George Keishingb3700812016-08-31 03:03:30 -0500177 ${session_active}= Check If warmReset is Initiated
178 Run Keyword If '${session_active}' == '${True}'
179 ... Fail msg=warm reset didn't occur
180
Chris Austenb29d2e82016-06-07 12:25:35 -0500181 Sleep ${SYSTEM_SHUTDOWN_TIME}min
Rahul Maheshwari5f253c42017-01-30 05:19:51 -0600182 Check If BMC Is Up
Michael Walsh49ab0f42016-07-20 11:44:33 -0500183
184Check OS
root442f0ef2016-08-04 20:23:05 +0000185 [Documentation] Attempts to ping the host OS and then checks that the host
186 ... OS is up by running an SSH command.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500187
188 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walsha6723f22016-11-22 11:12:01 -0600189 ... ${os_password}=${OS_PASSWORD} ${quiet}=${QUIET}
190 ... ${print_string}=${EMPTY}
Michael Walshac275512017-03-07 11:39:28 -0600191 [Teardown] SSHLibrary.Close Connection
Michael Walsh49ab0f42016-07-20 11:44:33 -0500192
193 # os_host The DNS name/IP of the OS host associated with our BMC.
194 # os_username The username to be used to sign on to the OS host.
195 # os_password The password to be used to sign on to the OS host.
Michael Walsha6723f22016-11-22 11:12:01 -0600196 # quiet Indicates whether this keyword should write to console.
197 # print_string A string to be printed before checking the OS.
198
199 rprint ${print_string}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500200
root442f0ef2016-08-04 20:23:05 +0000201 # Attempt to ping the OS. Store the return code to check later.
202 ${ping_rc}= Run Keyword and Return Status Ping Host ${os_host}
203
Michael Walshac275512017-03-07 11:39:28 -0600204 SSHLibrary.Open connection ${os_host}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500205
Michael Walsha6723f22016-11-22 11:12:01 -0600206 ${status} ${msg}= Run Keyword And Ignore Error Login ${os_username}
207 ... ${os_password}
208 ${err_msg1}= Sprint Error ${msg}
209 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
210 Run Keyword If '${status}' == 'FAIL' Fail msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500211 ${output} ${stderr} ${rc}= Execute Command uptime return_stderr=True
212 ... return_rc=True
213
Michael Walsha6723f22016-11-22 11:12:01 -0600214 ${temp_msg}= Catenate Could not execute a command on the operating
215 ... system.\n
216 ${err_msg1}= Sprint Error ${temp_msg}
217 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
218
219 # If the return code returned by "Execute Command" is non-zero, this
220 # keyword will fail.
221 Should Be Equal ${rc} ${0} msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500222 # We will likewise fail if there is any stderr data.
223 Should Be Empty ${stderr}
224
Michael Walsha6723f22016-11-22 11:12:01 -0600225 ${temp_msg}= Set Variable Could not ping the operating system.\n
226 ${err_msg1}= Sprint Error ${temp_msg}
227 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
228 # We will likewise fail if the OS did not ping, as we could SSH but not
229 # ping
230 Should Be Equal As Strings ${ping_rc} ${TRUE} msg=${err_msg}
root442f0ef2016-08-04 20:23:05 +0000231
Michael Walsh49ab0f42016-07-20 11:44:33 -0500232Wait for OS
233 [Documentation] Waits for the host OS to come up via calls to "Check OS".
234 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
235 ... ${os_password}=${OS_PASSWORD} ${timeout}=${OS_WAIT_TIMEOUT}
Michael Walsha6723f22016-11-22 11:12:01 -0600236 ... ${quiet}=${0}
237 [Teardown] rprintn
Michael Walsh49ab0f42016-07-20 11:44:33 -0500238
239 # os_host The DNS name or IP of the OS host associated with our
240 # BMC.
241 # os_username The username to be used to sign on to the OS host.
242 # os_password The password to be used to sign on to the OS host.
243 # timeout The timeout in seconds indicating how long you're
244 # willing to wait for the OS to respond.
Michael Walsha6723f22016-11-22 11:12:01 -0600245 # quiet Indicates whether this keyword should write to console.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500246
247 # The interval to be used between calls to "Check OS".
248 ${interval}= Set Variable 5
249
Michael Walsha6723f22016-11-22 11:12:01 -0600250 ${message}= Catenate Checking every ${interval} seconds for up to
251 ... ${timeout} seconds for the operating system to communicate.
252 rqprint_timen ${message}
253
Michael Walsh49ab0f42016-07-20 11:44:33 -0500254 Wait Until Keyword Succeeds ${timeout} sec ${interval} Check OS
255 ... ${os_host} ${os_username} ${os_password}
Michael Walsha6723f22016-11-22 11:12:01 -0600256 ... print_string=\#
257
258 rqprintn
259
260 rqprint_timen The operating system is now communicating.
root442f0ef2016-08-04 20:23:05 +0000261
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600262Get BMC State Deprecated
root442f0ef2016-08-04 20:23:05 +0000263 [Documentation] Returns the state of the BMC as a string. (i.e: BMC_READY)
Michael Walsha6723f22016-11-22 11:12:01 -0600264 [Arguments] ${quiet}=${QUIET}
265
root442f0ef2016-08-04 20:23:05 +0000266 @{arglist}= Create List
267 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600268 ${resp}= Call Method ${OPENBMC_BASE_URI}managers/System/ getSystemState
Michael Walsha6723f22016-11-22 11:12:01 -0600269 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000270 Should be equal as strings ${resp.status_code} ${HTTP_OK}
271 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600272 [Return] ${content["data"]}
root442f0ef2016-08-04 20:23:05 +0000273
274Get Power State
275 [Documentation] Returns the power state as an integer. Either 0 or 1.
Michael Walsha6723f22016-11-22 11:12:01 -0600276 [Arguments] ${quiet}=${QUIET}
277
root442f0ef2016-08-04 20:23:05 +0000278 @{arglist}= Create List
279 ${args}= Create Dictionary data=@{arglist}
Michael Walsha6723f22016-11-22 11:12:01 -0600280
George Keishing85ca05e2016-11-30 09:47:18 -0600281 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
Michael Walsha6723f22016-11-22 11:12:01 -0600282 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000283 Should be equal as strings ${resp.status_code} ${HTTP_OK}
284 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600285 [Return] ${content["data"]}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500286
287Clear BMC Record Log
288 [Documentation] Clears all the event logs on the BMC. This would be
289 ... equivalent to ipmitool sel clear.
290 @{arglist}= Create List
291 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600292 ${resp}= Call Method
293 ... ${OPENBMC_BASE_URI}records/events/ clear data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500294 should be equal as strings ${resp.status_code} ${HTTP_OK}
295
296Copy PNOR to BMC
297 Import Library SCPLibrary WITH NAME scp
298 Open Connection for SCP
299 Log Copying ${PNOR_IMAGE_PATH} to /tmp
300 scp.Put File ${PNOR_IMAGE_PATH} /tmp
301
302Flash PNOR
303 [Documentation] Calls flash bios update method to flash PNOR image
Gunnar Mills38032802016-12-12 13:43:40 -0600304 [Arguments] ${pnor_image}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500305 @{arglist}= Create List ${pnor_image}
306 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600307 ${resp}= Call Method ${OPENBMC_BASE_URI}control/flash/bios/ update
Michael Walsha6723f22016-11-22 11:12:01 -0600308 ... data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500309 should be equal as strings ${resp.status_code} ${HTTP_OK}
310 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
311
312Get Flash BIOS Status
313 [Documentation] Returns the status of the flash BIOS API as a string. For
314 ... example 'Flashing', 'Flash Done', etc
George Keishing85ca05e2016-11-30 09:47:18 -0600315 ${data}= Read Properties ${OPENBMC_BASE_URI}control/flash/bios
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600316 [Return] ${data['status']}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500317
318Is PNOR Flashing
319 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
320 ... flashing has started.
321 ${status}= Get Flash BIOS Status
Rahul Maheshwari449dfb72017-05-08 02:06:48 -0500322 Should Contain ${status} Flashing
Jay Azurine4c52eb2016-08-16 20:51:10 -0500323
324Is PNOR Flash Done
325 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
326 ... PNOR flashing has completed.
Leah McNutt9ba32272016-11-17 15:48:39 +0000327 ${status}= Get Flash BIOS Status
Jay Azurine4c52eb2016-08-16 20:51:10 -0500328 should be equal as strings ${status} Flash Done
329
330Is System State Host Booted
331 [Documentation] Checks whether system state is HOST_BOOTED.
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600332 ${state}= Get BMC State Deprecated
Jay Azurine4c52eb2016-08-16 20:51:10 -0500333 should be equal as strings ${state} HOST_BOOTED
George Keishing5e870cd2016-08-24 10:05:47 -0500334
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600335Is OS Starting
336 [Documentation] Check if boot progress is OS starting.
337 ${boot_progress}= Get Boot Progress
338 Should Be Equal ${boot_progress} FW Progress, Starting OS
339
George Keishing0af24412017-03-10 13:33:23 -0600340Is OS Off
341 [Documentation] Check if boot progress is "Off".
342 ${boot_progress}= Get Boot Progress
343 Should Be Equal ${boot_progress} Off
344
George Keishing5e870cd2016-08-24 10:05:47 -0500345Verify Ping and REST Authentication
Michael Walsha6723f22016-11-22 11:12:01 -0600346 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500347 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -0500348 Run Keyword If '${l_ping}' == '${False}'
349 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500350
Michael Walsha6723f22016-11-22 11:12:01 -0600351 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500352 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -0500353 Run Keyword If '${l_rest}' == '${False}'
354 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500355
356 # Just to make sure the SSH is working for SCP
357 Open Connection And Log In
358 ${system} ${stderr}= Execute Command hostname return_stderr=True
359 Should Be Empty ${stderr}
360
George Keishingc4d3dc02016-09-19 03:45:55 -0500361Check If BMC is Up
362 [Documentation] Wait for Host to be online. Checks every X seconds
363 ... interval for Y minutes and fails if timed out.
364 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -0600365 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -0500366 ... ${interval}=10 sec
367
368 Wait Until Keyword Succeeds
369 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
370
George Keishingb3700812016-08-31 03:03:30 -0500371
372Check If warmReset is Initiated
373 [Documentation] Ping would be still alive, so try SSH to connect
374 ... if fails the ports are down indicating reboot
375 ... is in progress
George Keishing3c05d352016-12-13 06:54:50 -0600376
377 # Warm reset adds 3 seconds delay before forcing reboot
378 # To minimize race conditions, we wait for 7 seconds
379 Sleep 7s
George Keishingb3700812016-08-31 03:03:30 -0500380 ${alive}= Run Keyword and Return Status
381 ... Open Connection And Log In
382 Return From Keyword If '${alive}' == '${False}' ${False}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600383 [Return] ${True}
George Keishingb3700812016-08-31 03:03:30 -0500384
George Keishing06ae4aa2016-08-30 01:41:28 -0500385Flush REST Sessions
386 [Documentation] Removes all the active session objects
387 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500388
Sivas SRRe1143ae2016-08-26 22:31:02 -0500389Initialize DBUS cmd
390 [Documentation] Initialize dbus string with property string to extract
Gunnar Mills38032802016-12-12 13:43:40 -0600391 [Arguments] ${boot_property}
Michael Walsha6723f22016-11-22 11:12:01 -0600392 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
393 ${cmd}= Catenate ${cmd}${boot_property}
Sivas SRRe1143ae2016-08-26 22:31:02 -0500394 Set Global Variable ${dbuscmd} ${cmd}
395
David Shawba2d2c22017-01-23 16:56:38 -0600396Create OS Console File Path
397 [Documentation] Create OS console file path name and return it.
398 [Arguments] ${log_file_path}=${EMPTY}
George Keishing30c12ff2016-09-02 10:25:29 -0500399
David Shawba2d2c22017-01-23 16:56:38 -0600400 # Description of arguements:
401 # file_path The caller's candidate value. If this value is ${EMPTY}, this
402 # keyword will compose a file path name. Otherwise, this
403 # keyword will use the caller's file_path value. In either
404 # case, the value will be returned.
Gunnar Mills9c760342016-12-08 10:12:06 -0600405
David Shawba2d2c22017-01-23 16:56:38 -0600406 ${default_file_path}= Catenate /tmp/${OPENBMC_HOST}_os_console
407 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
408 ... ${default_file_path} ${log_file_path}
Michael Walsh01bd3682017-01-10 11:21:05 -0600409
David Shawba2d2c22017-01-23 16:56:38 -0600410 [Return] ${log_file_path}
Gunnar Mills9c760342016-12-08 10:12:06 -0600411
David Shawba2d2c22017-01-23 16:56:38 -0600412Create OS Console Command String
413 [Documentation] Return a command string to start OS console logging.
Gunnar Mills9c760342016-12-08 10:12:06 -0600414
David Shawba2d2c22017-01-23 16:56:38 -0600415 # First make sure that the ssh_pw program is available.
416 ${cmd_buf}= Catenate which ssh_pw 2>&1
417 Rdpissuing ${cmd_buf}
418 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
419 Rdpvars rc output
420 Should Be Equal ${rc} ${0} msg=${output}\n
Gunnar Mills9c760342016-12-08 10:12:06 -0600421
David Shawba2d2c22017-01-23 16:56:38 -0600422 ${cmd_buf}= Catenate ssh_pw ${OPENBMC_PASSWORD} -p 2200
George Keishing1f9ec7f2017-06-06 08:59:19 -0500423 ... -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST}
George Keishing30c12ff2016-09-02 10:25:29 -0500424
David Shawba2d2c22017-01-23 16:56:38 -0600425 [Return] ${cmd_buf}
George Keishing30c12ff2016-09-02 10:25:29 -0500426
427Stop SOL Console Logging
David Shawba2d2c22017-01-23 16:56:38 -0600428 [Documentation] Stop system console logging and return log output.
George Keishing72992e42017-06-16 06:42:36 -0500429 [Arguments] ${log_file_path}=${EMPTY}
430 ... ${targ_file_path}=${EXECDIR}${/}logs${/}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500431 ... ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600432
433 # If there are muliple system console processes, they will all be stopped.
434 # If there is no existing log file this keyword will return an error
435 # message to that effect (and write that message to targ_file_path, if
436 # specified).
437 # NOTE: This keyword will not fail if there is no running system console
438 # process.
Michael Walsh01bd3682017-01-10 11:21:05 -0600439
440 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600441 # log_file_path The file path that was used to call "Start SOL
442 # Console Logging". See that keyword (above) for details.
443 # targ_file_path If specified, the file path to which the source
444 # file path (i.e. "log_file_path") should be copied.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500445 # return_data If this is set to ${1}, this keyword will return the SOL
446 # data to the caller as a unicode string.
George Keishing30c12ff2016-09-02 10:25:29 -0500447
David Shawba2d2c22017-01-23 16:56:38 -0600448 ${log_file_path}= Create OS Console File Path ${log_file_path}
449 # Find the pid of the active system console logging session (if any).
450 ${search_string}= Create OS Console Command String
451 ${cmd_buf}= Catenate echo $(ps -ef | egrep '${search_string}'
452 ... | egrep -v grep | cut -c10-14)
453 Rdpissuing ${cmd_buf}
454 ${rc} ${os_con_pid}= Run And Return Rc And Output ${cmd_buf}
455 Rdpvars os_con_pid
456 # If rc is not zero it just means that there is no OS Console process
457 # running.
George Keishing30c12ff2016-09-02 10:25:29 -0500458
David Shawba2d2c22017-01-23 16:56:38 -0600459 ${cmd_buf}= Catenate kill -9 ${os_con_pid}
460 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpissuing ${cmd_buf}
461 ${rc} ${output}= Run Keyword If '${os_con_pid}' != '${EMPTY}'
462 ... Run And Return Rc And Output ${cmd_buf}
463 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpvars rc output
George Keishing30c12ff2016-09-02 10:25:29 -0500464
Michael Walsh01bd3682017-01-10 11:21:05 -0600465 Run Keyword If '${targ_file_path}' != '${EMPTY}'
David Shawba2d2c22017-01-23 16:56:38 -0600466 ... Run Keyword And Ignore Error
467 ... Copy File ${log_file_path} ${targ_file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500468
Michael Walsh5f3f4142017-05-22 17:09:47 -0500469 ${output}= Set Variable ${EMPTY}
470 ${loc_quiet}= Evaluate ${debug}^1
471 ${rc} ${output}= Run Keyword If '${return_data}' == '${1}'
472 ... Cmd Fnc cat ${log_file_path} quiet=${loc_quiet} print_output=${0}
473
David Shawba2d2c22017-01-23 16:56:38 -0600474 [Return] ${output}
475
476Start SOL Console Logging
477 [Documentation] Start system console log to file.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500478 [Arguments] ${log_file_path}=${EMPTY} ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600479
480 # This keyword will first call "Stop SOL Console Logging". Only then will
481 # it start SOL console logging. The data returned by "Stop SOL Console
482 # Logging" will in turn be returned by this keyword.
483
484 # Description of arguments:
Michael Walsh5f3f4142017-05-22 17:09:47 -0500485 # log_file_path The file path to which system console log data should be
486 # written. Note that this path is taken to be a location
487 # on the machine where this program is running rather than
488 # on the Open BMC system.
489 # return_data If this is set to ${1}, this keyword will return any SOL
490 # data to the caller as a unicode string.
David Shawba2d2c22017-01-23 16:56:38 -0600491
492 ${log_file_path}= Create OS Console File Path ${log_file_path}
493
494 ${log_output}= Stop SOL Console Logging ${log_file_path}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500495 ... return_data=${return_data}
David Shawba2d2c22017-01-23 16:56:38 -0600496
497 # Validate by making sure we can create the file. Problems creating the
498 # file would not be noticed by the subsequent ssh command because we fork
499 # the command.
500 Create File ${log_file_path}
501 ${sub_cmd_buf}= Create OS Console Command String
502 # Routing stderr to stdout so that any startup error text will go to the
503 # output file.
504 ${cmd_buf}= Catenate ${sub_cmd_buf} > ${log_file_path} 2>&1 &
505 Rdpissuing ${cmd_buf}
506 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
507 # Because we are forking this command, we essentially will never get a
508 # non-zero return code or any output.
509 Should Be Equal ${rc} ${0}
510
511 [Return] ${log_output}
George Keishing30c12ff2016-09-02 10:25:29 -0500512
513Get Time Stamp
514 [Documentation] Get the current time stamp data
515 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500516 [Return] ${cur_time}
George Keishing30c12ff2016-09-02 10:25:29 -0500517
George Keishing1b150202016-09-29 08:51:58 -0500518
519Verify BMC State
520 [Documentation] Get the BMC state and verify if the current
521 ... BMC state is as expected.
522 [Arguments] ${expected}
523
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600524 ${current}= Get BMC State Deprecated
George Keishing8db0e1b2016-10-20 13:46:54 -0500525 Should Contain ${expected} ${current}
George Keishing1b150202016-09-29 08:51:58 -0500526
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500527Start Journal Log
528 [Documentation] Start capturing journal log to a file in /tmp using
529 ... journalctl command. By default journal log is collected
530 ... at /tmp/journal_log else user input location.
531 ... The File is appended with datetime.
532 [Arguments] ${file_path}=/tmp/journal_log
533
534 Open Connection And Log In
535
536 ${cur_time}= Get Time Stamp
537 Set Global Variable ${LOG_TIME} ${cur_time}
538 Start Command
539 ... journalctl -f > ${file_path}-${LOG_TIME}
540 Log Journal Log Started: ${file_path}-${LOG_TIME}
541
David Shawba2d2c22017-01-23 16:56:38 -0600542
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500543Stop Journal Log
544 [Documentation] Stop journalctl process if its running.
545 ... By default return log from /tmp/journal_log else
546 ... user input location.
547 [Arguments] ${file_path}=/tmp/journal_log
548
549 Open Connection And Log In
550
551 ${rc}=
552 ... Execute Command
553 ... ps ax | grep journalctl | grep -v grep
554 ... return_stdout=False return_rc=True
555
556 Return From Keyword If '${rc}' == '${1}'
557 ... No journal log process running
558
559 ${output} ${stderr}=
560 ... Execute Command killall journalctl
561 ... return_stderr=True
562 Should Be Empty ${stderr}
563
564 ${journal_log} ${stderr}=
565 ... Execute Command
566 ... cat ${file_path}-${LOG_TIME}
567 ... return_stderr=True
568 Should Be Empty ${stderr}
569
570 Log ${journal_log}
571
572 Execute Command rm ${file_path}-${LOG_TIME}
573
574 [Return] ${journal_log}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500575
576Mac Address To Hex String
577 [Documentation] Converts MAC address into hex format.
578 ... Example
579 ... Given the following MAC: 00:01:6C:80:02:78
580 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
581 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600582 ... i_macaddress MAC address in the following format
583 ... 00:01:6C:80:02:78
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500584 [Arguments] ${i_macaddress}
585
586 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600587 [Return] ${mac_hex}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500588
589IP Address To Hex String
590 [Documentation] Converts IP address into hex format.
591 ... Example:
592 ... Given the following IP: 10.3.164.100
593 ... This keyword will return: 0xa 0x3 0xa4 0xa0
594 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600595 ... i_ipaddress IP address in the following format
596 ... 10.10.10.10
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500597 [Arguments] ${i_ipaddress}
598
599 @{ip}= Split String ${i_ipaddress} .
600 ${index}= Set Variable ${0}
601
602 :FOR ${item} IN @{ip}
603 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes
604 \ Set List Value ${ip} ${index} ${hex}
605 \ ${index}= Set Variable ${index + 1}
606 ${ip_hex}= Catenate @{ip}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600607 [Return] ${ip_hex}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600608
609BMC CPU Performance Check
610 [Documentation] Minimal 10% of proc should be free in this instance
611
612 ${bmc_cpu_usage_output} ${stderr}= Execute Command ${bmc_cpu_usage_cmd}
613 ... return_stderr=True
614 Should be empty ${stderr}
615 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} %
616 Should be true ${bmc_cpu_percentage} < 90
617
618BMC Mem Performance Check
619 [Documentation] Minimal 10% of memory should be free in this instance
620
621 ${bmc_mem_free_output} ${stderr}= Execute Command ${bmc_mem_free_cmd}
622 ... return_stderr=True
623 Should be empty ${stderr}
624
625 ${bmc_mem_total_output} ${stderr}= Execute Command ${bmc_mem_total_cmd}
626 ... return_stderr=True
627 Should be empty ${stderr}
628
629 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100
630 ${bmc_mem_percentage}= Evaluate
631 ... ${bmc_mem_percentage}/${bmc_mem_total_output}
632 Should be true ${bmc_mem_percentage} > 10
633
Sivas SRRaca55712016-12-21 04:32:35 -0600634BMC File System Usage Check
635 [Documentation] Check the file system space. None should be 100% full
Sivas SRR352bc162017-02-13 22:12:29 -0600636 ... except /run/initramfs/ro
Sivas SRRaca55712016-12-21 04:32:35 -0600637 ${bmc_fs_usage_output} ${stderr}= Execute Command
638 ... ${bmc_file_system_usage_cmd} return_stderr=True
639 Should Be Empty ${stderr}
640 Should Be True ${bmc_fs_usage_output}==0
641
Sivas SRRea85d1f2016-11-13 22:44:28 -0600642Check BMC CPU Performance
643 [Documentation] Minimal 10% of proc should be free in 3 sample
644 :FOR ${var} IN Range 1 4
645 \ BMC CPU Performance check
646
647Check BMC Mem Performance
648 [Documentation] Minimal 10% of memory should be free
649
650 :FOR ${var} IN Range 1 4
651 \ BMC Mem Performance check
652
Sivas SRRaca55712016-12-21 04:32:35 -0600653Check BMC File System Performance
654 [Documentation] Check for file system usage for 4 times
655
656 :FOR ${var} IN Range 1 4
657 \ BMC File System Usage check
658
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500659Get URL List
660 [Documentation] Return list of URLs under given URL.
661 [Arguments] ${openbmc_url}
662 # Description of argument(s):
Michael Walsh5f3f4142017-05-22 17:09:47 -0500663 # openbmc_url URL for list operation (e.g.
664 # /xyz/openbmc_project/inventory).
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500665
666 ${url_list}= Read Properties ${openbmc_url}/list
667 [Return] ${url_list}
668
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600669Get Endpoint Paths
670 [Documentation] Returns all url paths ending with given endpoint
671 ... Example:
672 ... Given the following endpoint: cpu
Michael Walsh01bd3682017-01-10 11:21:05 -0600673 ... This keyword will return: list of all urls ending with
674 ... cpu -
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600675 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
676 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
677 ... Description of arguments:
678 ... path URL path for enumeration
679 ... endpoint string for which url path ending
680 [Arguments] ${path} ${endpoint}
681
682 ${resp}= Read Properties ${path}/enumerate timeout=30
683 log Dictionary ${resp}
684
685 ${list}= Get Dictionary Keys ${resp}
686 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9]*$
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600687 [Return] ${resp}
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500688
689Check Zombie Process
690 [Documentation] Check if any defunct process exist or not on BMC
Michael Walsh01bd3682017-01-10 11:21:05 -0600691 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500692 ... return_stderr=True return_rc=True
693 Should Be True ${count}==0
694 Should Be Empty ${stderr}
George Keishing5327d012016-12-08 08:43:29 -0600695
696Prune Journal Log
697 [Documentation] Prune archived journal logs.
698 [Arguments] ${vacuum_size}=1M
699
700 # This keyword can be used to prevent the journal
701 # log from filling up the /run filesystem.
702 # This command will retain only the latest logs
703 # of the user specified size.
704
705 Open Connection And Log In
706 ${output} ${stderr} ${rc}=
707 ... Execute Command
708 ... journalctl --vacuum-size=${vacuum_size}
709 ... return_stderr=True return_rc=True
710
711 Should Be Equal ${rc} ${0} msg=${stderr}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600712
713Set BMC Power Policy
714 [Documentation] Set the given BMC power policy.
715 [arguments] ${policy}
716
717 ${valueDict}= create dictionary data=${policy}
718 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
719 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
720 Should Be Equal ${currentPolicy} ${policy}
George Keishingcce9df22017-01-24 06:19:33 -0600721
George Keishing4d6f3d62017-02-06 09:50:41 -0600722Get System Power Policy
723 [Documentation] Get the BMC power policy.
724 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
725 [Return] ${currentPolicy}
George Keishingcce9df22017-01-24 06:19:33 -0600726
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600727Get Auto Reboot
728 [Documentation] Returns auto reboot setting.
Sridevi Ramesh4dbe6592017-04-06 01:47:52 -0500729 ${setting}= Read Attribute ${HOST_SETTING} auto_reboot
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600730 [Return] ${setting}
731
732
733Set Auto Reboot
734 [Documentation] Set the given auto reboot setting.
735 [Arguments] ${setting}
736 # setting auto reboot's setting, i.e. yes or no
737
738 ${valueDict}= Set Variable ${setting}
739 ${data}= Create Dictionary data=${valueDict}
Sridevi Ramesh4dbe6592017-04-06 01:47:52 -0500740 Write Attribute ${HOST_SETTING} auto_reboot data=${data}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600741 ${current_setting}= Get Auto Reboot
742 Should Be Equal ${current_setting} ${setting}
743
744
George Keishingcce9df22017-01-24 06:19:33 -0600745Set BMC Reset Reference Time
746 [Documentation] Set current boot time as a reference and increment
George Keishing80dd5af2017-02-08 07:01:25 -0600747 ... boot count.
George Keishingcce9df22017-01-24 06:19:33 -0600748
749 ${cur_btime}= Get BMC Boot Time
George Keishing80dd5af2017-02-08 07:01:25 -0600750 Run Keyword If ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
George Keishingcce9df22017-01-24 06:19:33 -0600751 ... Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishing80dd5af2017-02-08 07:01:25 -0600752 ... ELSE IF ${cur_btime} > ${BOOT_TIME}
753 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishingcce9df22017-01-24 06:19:33 -0600754 ... AND
755 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
756
George Keishingcce9df22017-01-24 06:19:33 -0600757Get BMC Boot Time
758 [Documentation] Get boot time from /proc/stat.
759
760 Open Connection And Log In
761 ${output} ${stderr}=
762 ... Execute Command egrep '^btime ' /proc/stat | cut -f 2 -d ' '
763 ... return_stderr=True
764 Should Be Empty ${stderr}
765 ${btime}= Convert To Integer ${output}
766 [Return] ${btime}
George Keishingede30002017-02-02 09:33:07 -0600767
George Keishingede30002017-02-02 09:33:07 -0600768Execute Command On BMC
769 [Documentation] Execute given command on BMC and return output.
770 [Arguments] ${command}
771 ${stdout} ${stderr}= Execute Command ${command} return_stderr=True
772 Should Be Empty ${stderr}
773 [Return] ${stdout}
David Shawba2d2c22017-01-23 16:56:38 -0600774
Sridevi Rameshea36b412017-03-09 04:08:02 -0600775
George Keishing7a520222017-02-27 09:44:30 -0600776Enable Core Dump On BMC
777 [Documentation] Enable core dump collection.
778 Open Connection And Log In
779 ${core_pattern}= Execute Command On BMC
780 ... echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
781 Should Be Equal As Strings ${core_pattern} /tmp/core_%e.%p
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600782
Sivas SRR01262bd2017-03-19 10:00:23 -0500783Get Number Of BMC Core Dump Files
784 [Documentation] Get number of core dump files on BMC.
785 Open Connection And Log In
786 ${num_of_core_dump}= Execute Command
787 ... ls /tmp/core* 2>/dev/null | wc -l
788 [Return] ${num_of_core_dump}
789
790Set Core Dump File Size Unlimited
791 [Documentation] Set core dump file size to unlimited.
792 Open Connection And Log In
793 Execute Command On BMC
794 ... ulimit -c unlimited
795
796Check For Core Dumps
797 [Documentation] Check for any core dumps exist.
798 ${output}= Get Number Of BMC Core Dump Files
799 Run Keyword If ${output} > 0
800 ... Log **Warning** BMC core dump files exist level=WARN
801
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600802Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -0500803 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600804 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Michael Walshb5839d02017-04-12 16:11:20 -0500805 # Description of argument(s):
806 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
807 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600808 # sleep_time Time delay for host watchdog error to get injected.
809 # Default is 5 seconds.
810
George Keishing37cfa6b2017-06-15 10:25:55 -0500811 ${data}= Create Dictionary data=${True}
812 Write Attribute /xyz/openbmc_project/watchdog/host0 Enabled data=${data}
813
814 ${data}= Create Dictionary data=${milliseconds}
815 Write Attribute /xyz/openbmc_project/watchdog/host0 TimeRemaining data=${data}
816
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600817 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500818
819Login To OS Host
820 [Documentation] Login to OS Host.
821 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
822 ... ${os_password}=${OS_PASSWORD}
823 # Desription of arguments:
824 # ${os_host} IP address of the OS Host.
825 # ${os_username} OS Host Login user name.
826 # ${os_password} OS Host Login passwrd.
827
828 ${os_state}= Run Keyword And Return Status Ping Host ${os_host}
829 Run Keyword If '${os_state}' == 'False'
830 ... Run Keywords Initiate Host Reboot AND
831 ... Is Host Running AND
832 ... Wait for OS ${os_host} ${os_username} ${os_password}
833
834 Open Connection ${os_host}
Sridevi Rameshea36b412017-03-09 04:08:02 -0600835 ${resp}= Login ${os_username} ${os_password}
836 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -0500837
838Configure Initial Settings
839 [Documentation] Restore old IP and route.
840 ... This keyword requires initial settings viz IP address,
841 ... Network Mask, default gatway and serial console IP and port
842 ... information which should be provided in command line.
843
Michael Walshb5839d02017-04-12 16:11:20 -0500844 [Arguments] ${host}=${OPENBMC_HOST} ${mask}=${NET_MASK}
845 ... ${gw_ip}=${GW_IP}
Prashanth Katti884ee062017-03-16 05:05:03 -0500846
Michael Walshb5839d02017-04-12 16:11:20 -0500847 # Open telnet connection and ignore the error, in case telnet session is
848 # already opened by the program calling this keyword.
Prashanth Katti884ee062017-03-16 05:05:03 -0500849
850 Run Keyword And Ignore Error Open Telnet Connection to BMC Serial Console
851 Telnet.write ifconfig eth0 ${host} netmask ${mask}
852 Telnet.write route add default gw ${gw_ip}
George Keishingd05b1082017-03-24 05:27:32 -0500853
854Install Debug Tarball On BMC
George Keishing55441822017-05-18 14:17:59 -0500855 [Documentation] Copy the debug tar file to BMC and install.
856 [Arguments] ${tarball_file_path}=${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz
857 ... ${targ_tarball_dir_path}=/home/root/tarball/
George Keishingd05b1082017-03-24 05:27:32 -0500858
George Keishing55441822017-05-18 14:17:59 -0500859 # Description of arguments:
860 # tarball_file_path Path of the debug tarball file.
861 # The tar file is downloaded from the build page
862 # https://openpower.xyz/job/openbmc-build/
863 # obmc-phosphor-debug-tarball-witherspoon.tar.xz
864 #
865 # targ_tarball_dir_path The directory path where the tarball is to be
866 # installed.
867
868 OperatingSystem.File Should Exist ${tarball_file_path}
869 ... msg=${tarball_file_path} doesn't exist.
870
871 # Upload the file to BMC.
George Keishingd05b1082017-03-24 05:27:32 -0500872 Import Library SCPLibrary WITH NAME scp
873 Open Connection for SCP
George Keishing55441822017-05-18 14:17:59 -0500874 scp.Put File ${tarball_file_path} /tmp/debug-tarball.tar.xz
875
876 # Create tarball directory and install.
George Keishingd05b1082017-03-24 05:27:32 -0500877 Open Connection And Log In
George Keishing55441822017-05-18 14:17:59 -0500878 Execute Command On BMC mkdir -p ${targ_tarball_dir_path}
879 Execute Command On BMC
880 ... tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path}
881
882 # Create symlink to callout-test binary.
883 Execute Command On BMC
884 ... ln -s ${targ_tarball_dir_path}/bin/callout-test /usr/bin/callout-test
885
George Keishing4fc998b2017-05-26 05:24:12 -0500886 # Create symlink to logging-test binary.
887 Execute Command On BMC
888 ... ln -s ${targ_tarball_dir_path}/bin/logging-test /usr/bin/logging-test
889
George Keishingd05b1082017-03-24 05:27:32 -0500890 # Remove the tarball file from BMC
891 Execute Command On BMC rm /tmp/debug-tarball.tar.xz
892
George Keishing55441822017-05-18 14:17:59 -0500893
Sweta Potthuri025e0122017-02-21 00:42:48 -0600894Get BMC Boot Count
895 [Documentation] Get BMC boot count based on boot time.
896 ${cur_btime}= Get BMC Boot Time
897
898 # Set global variable BOOT_TIME to current boot time if current boot time
899 # is changed. Also increase value of global variable BOOT_COUNT by 1.
900 Run Keyword If ${cur_btime} > ${BOOT_TIME}
901 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
902 ... AND
903 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
904 [Return] ${BOOT_COUNT}
905
906Set BMC Boot Count
907 [Documentation] Set BMC boot count to given value.
908 [Arguments] ${count}
909
910 # Description of arguments:
911 # count boot count value.
912 ${cur_btime}= Get BMC Boot Time
913
914 # Set global variable BOOT_COUNT to given value.
915 Set Global Variable ${BOOT_COUNT} ${count}
916
917 # Set BOOT_TIME variable to current boot time.
918 Set Global Variable ${BOOT_COUNT} ${count}
Michael Walsh689fbbe2017-04-04 17:58:03 -0500919
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500920Get System LED State
921 [Documentation] Return the state of given system LED.
922 [Arguments] ${led_name}
923
924 # Description of argument(s):
925 # led_name System LED name (e.g. heartbeat, identify, beep).
926
927 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State
928 [Return] ${state.rsplit('.', 1)[1]}
929
Michael Walsh689fbbe2017-04-04 17:58:03 -0500930###############################################################################
George Keishingd2d90af2017-06-27 08:17:34 -0500931Delete Error Logs
Michael Walsh689fbbe2017-04-04 17:58:03 -0500932 [Documentation] Delete error logs.
933
George Keishingd2d90af2017-06-27 08:17:34 -0500934 # Check if error logs entries exist, if not return.
935 ${resp}= OpenBMC Get Request /xyz/openbmc_project/logging/entry/list
936 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND}
937
938 # Get the list of error logs entries and delete them all.
939 ${elog_entries}= Get URL List /xyz/openbmc_project/logging/entry
940 :FOR ${entry} IN @{elog_entries}
941 \ Delete Error Log Entry ${entry}
George Keishingdb34c2f2017-04-18 13:20:25 -0500942
943###############################################################################
George Keishingd2d90af2017-06-27 08:17:34 -0500944Delete Error Log Entry
George Keishingdb34c2f2017-04-18 13:20:25 -0500945 [Documentation] Delete error log entry.
946 [Arguments] ${entry_path}
947
948 # Description of argument(s):
949 # entry_path Delete an error log entry.
950 # Ex. /xyz/openbmc_project/logging/entry/1
951
952 ${data}= Create Dictionary data=@{EMPTY}
953 ${resp}= Openbmc Delete Request ${entry_path} data=${data}
954 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Rahul Maheshwari43be6932017-05-01 02:37:06 -0500955
956
957Get LED State XYZ
958 [Documentation] Returns state of given LED.
959 [Arguments] ${led_name}
960 # Description of argument(s):
961 # led_name Name of LED
962
963 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
964 [Return] ${state}
Rahul Maheshwari13256d92017-06-15 10:05:40 -0500965
966
967Get BMC Version
968 [Documentation] Returns BMC version from /etc/os-release.
969 ... e.g. "v1.99.6-141-ge662190"
970
971 Open Connection And Log In
972 ${cmd}= Set Variable grep ^VERSION_ID= /etc/os-release | cut -f 2 -d '='
973 ${output}= Execute Command On BMC ${cmd}
974 [Return] ${output}
975