blob: 569edb377a81dbf44331a7c04fa553bfcb77812e [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
168
Michael Walshac275512017-03-07 11:39:28 -0600169 SSHLibrary.Open connection ${openbmc_host}
Michael Walsh81843772017-03-02 14:44:44 -0600170 Login ${openbmc_username} ${openbmc_password}
171
172 # Set the watchdog timer. Note: 5000 = milliseconds which is 5 seconds.
173 ${cmd_buf}= Catenate /usr/sbin/mapper call /org/openbmc/watchdog/host0
174 ... org.openbmc.Watchdog set i 5000
175 ${output} ${stderr} ${rc}= Execute Command ${cmd_buf}
176 ... return_stderr=True return_rc=True
177 Should Be Empty ${stderr}
178 Should be equal ${rc} ${0}
179
180 # Start the watchdog.
181 ${cmd_buf}= Catenate /usr/sbin/mapper call /org/openbmc/watchdog/host0
182 ... org.openbmc.Watchdog start
183 ${output} ${stderr} ${rc}= Execute Command ${cmd_buf}
184 ... return_stderr=True return_rc=True
185 Should Be Empty ${stderr}
186 Should be equal ${rc} ${0}
187
Chris Austenb29d2e82016-06-07 12:25:35 -0500188Trigger Warm Reset
189 log to console "Triggering warm reset"
Michael Walsha6723f22016-11-22 11:12:01 -0600190 ${data}= create dictionary data=@{EMPTY}
George Keishing85ca05e2016-11-30 09:47:18 -0600191 ${resp}= openbmc post request
192 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
Chris Austenb29d2e82016-06-07 12:25:35 -0500193 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
George Keishingb3700812016-08-31 03:03:30 -0500194 ${session_active}= Check If warmReset is Initiated
195 Run Keyword If '${session_active}' == '${True}'
196 ... Fail msg=warm reset didn't occur
197
Chris Austenb29d2e82016-06-07 12:25:35 -0500198 Sleep ${SYSTEM_SHUTDOWN_TIME}min
Rahul Maheshwari5f253c42017-01-30 05:19:51 -0600199 Check If BMC Is Up
Michael Walsh49ab0f42016-07-20 11:44:33 -0500200
201Check OS
root442f0ef2016-08-04 20:23:05 +0000202 [Documentation] Attempts to ping the host OS and then checks that the host
203 ... OS is up by running an SSH command.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500204
205 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walsha6723f22016-11-22 11:12:01 -0600206 ... ${os_password}=${OS_PASSWORD} ${quiet}=${QUIET}
207 ... ${print_string}=${EMPTY}
Michael Walshac275512017-03-07 11:39:28 -0600208 [Teardown] SSHLibrary.Close Connection
Michael Walsh49ab0f42016-07-20 11:44:33 -0500209
210 # os_host The DNS name/IP of the OS host associated with our BMC.
211 # os_username The username to be used to sign on to the OS host.
212 # os_password The password to be used to sign on to the OS host.
Michael Walsha6723f22016-11-22 11:12:01 -0600213 # quiet Indicates whether this keyword should write to console.
214 # print_string A string to be printed before checking the OS.
215
216 rprint ${print_string}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500217
root442f0ef2016-08-04 20:23:05 +0000218 # Attempt to ping the OS. Store the return code to check later.
219 ${ping_rc}= Run Keyword and Return Status Ping Host ${os_host}
220
Michael Walshac275512017-03-07 11:39:28 -0600221 SSHLibrary.Open connection ${os_host}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500222
Michael Walsha6723f22016-11-22 11:12:01 -0600223 ${status} ${msg}= Run Keyword And Ignore Error Login ${os_username}
224 ... ${os_password}
225 ${err_msg1}= Sprint Error ${msg}
226 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
227 Run Keyword If '${status}' == 'FAIL' Fail msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500228 ${output} ${stderr} ${rc}= Execute Command uptime return_stderr=True
229 ... return_rc=True
230
Michael Walsha6723f22016-11-22 11:12:01 -0600231 ${temp_msg}= Catenate Could not execute a command on the operating
232 ... system.\n
233 ${err_msg1}= Sprint Error ${temp_msg}
234 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
235
236 # If the return code returned by "Execute Command" is non-zero, this
237 # keyword will fail.
238 Should Be Equal ${rc} ${0} msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500239 # We will likewise fail if there is any stderr data.
240 Should Be Empty ${stderr}
241
Michael Walsha6723f22016-11-22 11:12:01 -0600242 ${temp_msg}= Set Variable Could not ping the operating system.\n
243 ${err_msg1}= Sprint Error ${temp_msg}
244 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
245 # We will likewise fail if the OS did not ping, as we could SSH but not
246 # ping
247 Should Be Equal As Strings ${ping_rc} ${TRUE} msg=${err_msg}
root442f0ef2016-08-04 20:23:05 +0000248
Michael Walsh49ab0f42016-07-20 11:44:33 -0500249Wait for OS
250 [Documentation] Waits for the host OS to come up via calls to "Check OS".
251 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
252 ... ${os_password}=${OS_PASSWORD} ${timeout}=${OS_WAIT_TIMEOUT}
Michael Walsha6723f22016-11-22 11:12:01 -0600253 ... ${quiet}=${0}
254 [Teardown] rprintn
Michael Walsh49ab0f42016-07-20 11:44:33 -0500255
256 # os_host The DNS name or IP of the OS host associated with our
257 # BMC.
258 # os_username The username to be used to sign on to the OS host.
259 # os_password The password to be used to sign on to the OS host.
260 # timeout The timeout in seconds indicating how long you're
261 # willing to wait for the OS to respond.
Michael Walsha6723f22016-11-22 11:12:01 -0600262 # quiet Indicates whether this keyword should write to console.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500263
264 # The interval to be used between calls to "Check OS".
265 ${interval}= Set Variable 5
266
Michael Walsha6723f22016-11-22 11:12:01 -0600267 ${message}= Catenate Checking every ${interval} seconds for up to
268 ... ${timeout} seconds for the operating system to communicate.
269 rqprint_timen ${message}
270
Michael Walsh49ab0f42016-07-20 11:44:33 -0500271 Wait Until Keyword Succeeds ${timeout} sec ${interval} Check OS
272 ... ${os_host} ${os_username} ${os_password}
Michael Walsha6723f22016-11-22 11:12:01 -0600273 ... print_string=\#
274
275 rqprintn
276
277 rqprint_timen The operating system is now communicating.
root442f0ef2016-08-04 20:23:05 +0000278
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600279Get BMC State Deprecated
root442f0ef2016-08-04 20:23:05 +0000280 [Documentation] Returns the state of the BMC as a string. (i.e: BMC_READY)
Michael Walsha6723f22016-11-22 11:12:01 -0600281 [Arguments] ${quiet}=${QUIET}
282
root442f0ef2016-08-04 20:23:05 +0000283 @{arglist}= Create List
284 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600285 ${resp}= Call Method ${OPENBMC_BASE_URI}managers/System/ getSystemState
Michael Walsha6723f22016-11-22 11:12:01 -0600286 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000287 Should be equal as strings ${resp.status_code} ${HTTP_OK}
288 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600289 [Return] ${content["data"]}
root442f0ef2016-08-04 20:23:05 +0000290
291Get Power State
292 [Documentation] Returns the power state as an integer. Either 0 or 1.
Michael Walsha6723f22016-11-22 11:12:01 -0600293 [Arguments] ${quiet}=${QUIET}
294
root442f0ef2016-08-04 20:23:05 +0000295 @{arglist}= Create List
296 ${args}= Create Dictionary data=@{arglist}
Michael Walsha6723f22016-11-22 11:12:01 -0600297
George Keishing85ca05e2016-11-30 09:47:18 -0600298 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
Michael Walsha6723f22016-11-22 11:12:01 -0600299 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000300 Should be equal as strings ${resp.status_code} ${HTTP_OK}
301 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600302 [Return] ${content["data"]}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500303
304Clear BMC Record Log
305 [Documentation] Clears all the event logs on the BMC. This would be
306 ... equivalent to ipmitool sel clear.
307 @{arglist}= Create List
308 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600309 ${resp}= Call Method
310 ... ${OPENBMC_BASE_URI}records/events/ clear data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500311 should be equal as strings ${resp.status_code} ${HTTP_OK}
312
313Copy PNOR to BMC
314 Import Library SCPLibrary WITH NAME scp
315 Open Connection for SCP
316 Log Copying ${PNOR_IMAGE_PATH} to /tmp
317 scp.Put File ${PNOR_IMAGE_PATH} /tmp
318
319Flash PNOR
320 [Documentation] Calls flash bios update method to flash PNOR image
Gunnar Mills38032802016-12-12 13:43:40 -0600321 [Arguments] ${pnor_image}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500322 @{arglist}= Create List ${pnor_image}
323 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600324 ${resp}= Call Method ${OPENBMC_BASE_URI}control/flash/bios/ update
Michael Walsha6723f22016-11-22 11:12:01 -0600325 ... data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500326 should be equal as strings ${resp.status_code} ${HTTP_OK}
327 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
328
329Get Flash BIOS Status
330 [Documentation] Returns the status of the flash BIOS API as a string. For
331 ... example 'Flashing', 'Flash Done', etc
George Keishing85ca05e2016-11-30 09:47:18 -0600332 ${data}= Read Properties ${OPENBMC_BASE_URI}control/flash/bios
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600333 [Return] ${data['status']}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500334
335Is PNOR Flashing
336 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
337 ... flashing has started.
338 ${status}= Get Flash BIOS Status
Rahul Maheshwari449dfb72017-05-08 02:06:48 -0500339 Should Contain ${status} Flashing
Jay Azurine4c52eb2016-08-16 20:51:10 -0500340
341Is PNOR Flash Done
342 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
343 ... PNOR flashing has completed.
Leah McNutt9ba32272016-11-17 15:48:39 +0000344 ${status}= Get Flash BIOS Status
Jay Azurine4c52eb2016-08-16 20:51:10 -0500345 should be equal as strings ${status} Flash Done
346
347Is System State Host Booted
348 [Documentation] Checks whether system state is HOST_BOOTED.
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600349 ${state}= Get BMC State Deprecated
Jay Azurine4c52eb2016-08-16 20:51:10 -0500350 should be equal as strings ${state} HOST_BOOTED
George Keishing5e870cd2016-08-24 10:05:47 -0500351
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600352Is OS Starting
353 [Documentation] Check if boot progress is OS starting.
354 ${boot_progress}= Get Boot Progress
355 Should Be Equal ${boot_progress} FW Progress, Starting OS
356
George Keishing0af24412017-03-10 13:33:23 -0600357Is OS Off
358 [Documentation] Check if boot progress is "Off".
359 ${boot_progress}= Get Boot Progress
360 Should Be Equal ${boot_progress} Off
361
George Keishing5e870cd2016-08-24 10:05:47 -0500362Verify Ping and REST Authentication
Michael Walsha6723f22016-11-22 11:12:01 -0600363 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500364 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -0500365 Run Keyword If '${l_ping}' == '${False}'
366 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500367
Michael Walsha6723f22016-11-22 11:12:01 -0600368 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500369 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -0500370 Run Keyword If '${l_rest}' == '${False}'
371 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500372
373 # Just to make sure the SSH is working for SCP
374 Open Connection And Log In
375 ${system} ${stderr}= Execute Command hostname return_stderr=True
376 Should Be Empty ${stderr}
377
George Keishingc4d3dc02016-09-19 03:45:55 -0500378Check If BMC is Up
379 [Documentation] Wait for Host to be online. Checks every X seconds
380 ... interval for Y minutes and fails if timed out.
381 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -0600382 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -0500383 ... ${interval}=10 sec
384
385 Wait Until Keyword Succeeds
386 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
387
George Keishingb3700812016-08-31 03:03:30 -0500388
389Check If warmReset is Initiated
390 [Documentation] Ping would be still alive, so try SSH to connect
391 ... if fails the ports are down indicating reboot
392 ... is in progress
George Keishing3c05d352016-12-13 06:54:50 -0600393
394 # Warm reset adds 3 seconds delay before forcing reboot
395 # To minimize race conditions, we wait for 7 seconds
396 Sleep 7s
George Keishingb3700812016-08-31 03:03:30 -0500397 ${alive}= Run Keyword and Return Status
398 ... Open Connection And Log In
399 Return From Keyword If '${alive}' == '${False}' ${False}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600400 [Return] ${True}
George Keishingb3700812016-08-31 03:03:30 -0500401
George Keishing06ae4aa2016-08-30 01:41:28 -0500402Flush REST Sessions
403 [Documentation] Removes all the active session objects
404 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500405
Sivas SRRe1143ae2016-08-26 22:31:02 -0500406Initialize DBUS cmd
407 [Documentation] Initialize dbus string with property string to extract
Gunnar Mills38032802016-12-12 13:43:40 -0600408 [Arguments] ${boot_property}
Michael Walsha6723f22016-11-22 11:12:01 -0600409 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
410 ${cmd}= Catenate ${cmd}${boot_property}
Sivas SRRe1143ae2016-08-26 22:31:02 -0500411 Set Global Variable ${dbuscmd} ${cmd}
412
David Shawba2d2c22017-01-23 16:56:38 -0600413Create OS Console File Path
414 [Documentation] Create OS console file path name and return it.
415 [Arguments] ${log_file_path}=${EMPTY}
George Keishing30c12ff2016-09-02 10:25:29 -0500416
David Shawba2d2c22017-01-23 16:56:38 -0600417 # Description of arguements:
418 # file_path The caller's candidate value. If this value is ${EMPTY}, this
419 # keyword will compose a file path name. Otherwise, this
420 # keyword will use the caller's file_path value. In either
421 # case, the value will be returned.
Gunnar Mills9c760342016-12-08 10:12:06 -0600422
David Shawba2d2c22017-01-23 16:56:38 -0600423 ${default_file_path}= Catenate /tmp/${OPENBMC_HOST}_os_console
424 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
425 ... ${default_file_path} ${log_file_path}
Michael Walsh01bd3682017-01-10 11:21:05 -0600426
David Shawba2d2c22017-01-23 16:56:38 -0600427 [Return] ${log_file_path}
Gunnar Mills9c760342016-12-08 10:12:06 -0600428
David Shawba2d2c22017-01-23 16:56:38 -0600429Create OS Console Command String
430 [Documentation] Return a command string to start OS console logging.
Gunnar Mills9c760342016-12-08 10:12:06 -0600431
David Shawba2d2c22017-01-23 16:56:38 -0600432 # First make sure that the ssh_pw program is available.
433 ${cmd_buf}= Catenate which ssh_pw 2>&1
434 Rdpissuing ${cmd_buf}
435 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
436 Rdpvars rc output
437 Should Be Equal ${rc} ${0} msg=${output}\n
Gunnar Mills9c760342016-12-08 10:12:06 -0600438
David Shawba2d2c22017-01-23 16:56:38 -0600439 ${cmd_buf}= Catenate ssh_pw ${OPENBMC_PASSWORD} -p 2200
George Keishing1f9ec7f2017-06-06 08:59:19 -0500440 ... -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST}
George Keishing30c12ff2016-09-02 10:25:29 -0500441
David Shawba2d2c22017-01-23 16:56:38 -0600442 [Return] ${cmd_buf}
George Keishing30c12ff2016-09-02 10:25:29 -0500443
444Stop SOL Console Logging
David Shawba2d2c22017-01-23 16:56:38 -0600445 [Documentation] Stop system console logging and return log output.
446 [Arguments] ${log_file_path}=${EMPTY} ${targ_file_path}=${EMPTY}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500447 ... ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600448
449 # If there are muliple system console processes, they will all be stopped.
450 # If there is no existing log file this keyword will return an error
451 # message to that effect (and write that message to targ_file_path, if
452 # specified).
453 # NOTE: This keyword will not fail if there is no running system console
454 # process.
Michael Walsh01bd3682017-01-10 11:21:05 -0600455
456 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600457 # log_file_path The file path that was used to call "Start SOL
458 # Console Logging". See that keyword (above) for details.
459 # targ_file_path If specified, the file path to which the source
460 # file path (i.e. "log_file_path") should be copied.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500461 # return_data If this is set to ${1}, this keyword will return the SOL
462 # data to the caller as a unicode string.
George Keishing30c12ff2016-09-02 10:25:29 -0500463
David Shawba2d2c22017-01-23 16:56:38 -0600464 ${log_file_path}= Create OS Console File Path ${log_file_path}
465 # Find the pid of the active system console logging session (if any).
466 ${search_string}= Create OS Console Command String
467 ${cmd_buf}= Catenate echo $(ps -ef | egrep '${search_string}'
468 ... | egrep -v grep | cut -c10-14)
469 Rdpissuing ${cmd_buf}
470 ${rc} ${os_con_pid}= Run And Return Rc And Output ${cmd_buf}
471 Rdpvars os_con_pid
472 # If rc is not zero it just means that there is no OS Console process
473 # running.
George Keishing30c12ff2016-09-02 10:25:29 -0500474
David Shawba2d2c22017-01-23 16:56:38 -0600475 ${cmd_buf}= Catenate kill -9 ${os_con_pid}
476 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpissuing ${cmd_buf}
477 ${rc} ${output}= Run Keyword If '${os_con_pid}' != '${EMPTY}'
478 ... Run And Return Rc And Output ${cmd_buf}
479 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpvars rc output
George Keishing30c12ff2016-09-02 10:25:29 -0500480
Michael Walsh01bd3682017-01-10 11:21:05 -0600481 Run Keyword If '${targ_file_path}' != '${EMPTY}'
David Shawba2d2c22017-01-23 16:56:38 -0600482 ... Run Keyword And Ignore Error
483 ... Copy File ${log_file_path} ${targ_file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500484
Michael Walsh5f3f4142017-05-22 17:09:47 -0500485 ${output}= Set Variable ${EMPTY}
486 ${loc_quiet}= Evaluate ${debug}^1
487 ${rc} ${output}= Run Keyword If '${return_data}' == '${1}'
488 ... Cmd Fnc cat ${log_file_path} quiet=${loc_quiet} print_output=${0}
489
David Shawba2d2c22017-01-23 16:56:38 -0600490 [Return] ${output}
491
492Start SOL Console Logging
493 [Documentation] Start system console log to file.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500494 [Arguments] ${log_file_path}=${EMPTY} ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600495
496 # This keyword will first call "Stop SOL Console Logging". Only then will
497 # it start SOL console logging. The data returned by "Stop SOL Console
498 # Logging" will in turn be returned by this keyword.
499
500 # Description of arguments:
Michael Walsh5f3f4142017-05-22 17:09:47 -0500501 # log_file_path The file path to which system console log data should be
502 # written. Note that this path is taken to be a location
503 # on the machine where this program is running rather than
504 # on the Open BMC system.
505 # return_data If this is set to ${1}, this keyword will return any SOL
506 # data to the caller as a unicode string.
David Shawba2d2c22017-01-23 16:56:38 -0600507
508 ${log_file_path}= Create OS Console File Path ${log_file_path}
509
510 ${log_output}= Stop SOL Console Logging ${log_file_path}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500511 ... return_data=${return_data}
David Shawba2d2c22017-01-23 16:56:38 -0600512
513 # Validate by making sure we can create the file. Problems creating the
514 # file would not be noticed by the subsequent ssh command because we fork
515 # the command.
516 Create File ${log_file_path}
517 ${sub_cmd_buf}= Create OS Console Command String
518 # Routing stderr to stdout so that any startup error text will go to the
519 # output file.
520 ${cmd_buf}= Catenate ${sub_cmd_buf} > ${log_file_path} 2>&1 &
521 Rdpissuing ${cmd_buf}
522 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
523 # Because we are forking this command, we essentially will never get a
524 # non-zero return code or any output.
525 Should Be Equal ${rc} ${0}
526
527 [Return] ${log_output}
George Keishing30c12ff2016-09-02 10:25:29 -0500528
529Get Time Stamp
530 [Documentation] Get the current time stamp data
531 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500532 [Return] ${cur_time}
George Keishing30c12ff2016-09-02 10:25:29 -0500533
George Keishing1b150202016-09-29 08:51:58 -0500534
535Verify BMC State
536 [Documentation] Get the BMC state and verify if the current
537 ... BMC state is as expected.
538 [Arguments] ${expected}
539
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600540 ${current}= Get BMC State Deprecated
George Keishing8db0e1b2016-10-20 13:46:54 -0500541 Should Contain ${expected} ${current}
George Keishing1b150202016-09-29 08:51:58 -0500542
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500543Start Journal Log
544 [Documentation] Start capturing journal log to a file in /tmp using
545 ... journalctl command. By default journal log is collected
546 ... at /tmp/journal_log else user input location.
547 ... The File is appended with datetime.
548 [Arguments] ${file_path}=/tmp/journal_log
549
550 Open Connection And Log In
551
552 ${cur_time}= Get Time Stamp
553 Set Global Variable ${LOG_TIME} ${cur_time}
554 Start Command
555 ... journalctl -f > ${file_path}-${LOG_TIME}
556 Log Journal Log Started: ${file_path}-${LOG_TIME}
557
David Shawba2d2c22017-01-23 16:56:38 -0600558
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500559Stop Journal Log
560 [Documentation] Stop journalctl process if its running.
561 ... By default return log from /tmp/journal_log else
562 ... user input location.
563 [Arguments] ${file_path}=/tmp/journal_log
564
565 Open Connection And Log In
566
567 ${rc}=
568 ... Execute Command
569 ... ps ax | grep journalctl | grep -v grep
570 ... return_stdout=False return_rc=True
571
572 Return From Keyword If '${rc}' == '${1}'
573 ... No journal log process running
574
575 ${output} ${stderr}=
576 ... Execute Command killall journalctl
577 ... return_stderr=True
578 Should Be Empty ${stderr}
579
580 ${journal_log} ${stderr}=
581 ... Execute Command
582 ... cat ${file_path}-${LOG_TIME}
583 ... return_stderr=True
584 Should Be Empty ${stderr}
585
586 Log ${journal_log}
587
588 Execute Command rm ${file_path}-${LOG_TIME}
589
590 [Return] ${journal_log}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500591
592Mac Address To Hex String
593 [Documentation] Converts MAC address into hex format.
594 ... Example
595 ... Given the following MAC: 00:01:6C:80:02:78
596 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
597 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600598 ... i_macaddress MAC address in the following format
599 ... 00:01:6C:80:02:78
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500600 [Arguments] ${i_macaddress}
601
602 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600603 [Return] ${mac_hex}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500604
605IP Address To Hex String
606 [Documentation] Converts IP address into hex format.
607 ... Example:
608 ... Given the following IP: 10.3.164.100
609 ... This keyword will return: 0xa 0x3 0xa4 0xa0
610 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600611 ... i_ipaddress IP address in the following format
612 ... 10.10.10.10
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500613 [Arguments] ${i_ipaddress}
614
615 @{ip}= Split String ${i_ipaddress} .
616 ${index}= Set Variable ${0}
617
618 :FOR ${item} IN @{ip}
619 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes
620 \ Set List Value ${ip} ${index} ${hex}
621 \ ${index}= Set Variable ${index + 1}
622 ${ip_hex}= Catenate @{ip}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600623 [Return] ${ip_hex}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600624
625BMC CPU Performance Check
626 [Documentation] Minimal 10% of proc should be free in this instance
627
628 ${bmc_cpu_usage_output} ${stderr}= Execute Command ${bmc_cpu_usage_cmd}
629 ... return_stderr=True
630 Should be empty ${stderr}
631 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} %
632 Should be true ${bmc_cpu_percentage} < 90
633
634BMC Mem Performance Check
635 [Documentation] Minimal 10% of memory should be free in this instance
636
637 ${bmc_mem_free_output} ${stderr}= Execute Command ${bmc_mem_free_cmd}
638 ... return_stderr=True
639 Should be empty ${stderr}
640
641 ${bmc_mem_total_output} ${stderr}= Execute Command ${bmc_mem_total_cmd}
642 ... return_stderr=True
643 Should be empty ${stderr}
644
645 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100
646 ${bmc_mem_percentage}= Evaluate
647 ... ${bmc_mem_percentage}/${bmc_mem_total_output}
648 Should be true ${bmc_mem_percentage} > 10
649
Sivas SRRaca55712016-12-21 04:32:35 -0600650BMC File System Usage Check
651 [Documentation] Check the file system space. None should be 100% full
Sivas SRR352bc162017-02-13 22:12:29 -0600652 ... except /run/initramfs/ro
Sivas SRRaca55712016-12-21 04:32:35 -0600653 ${bmc_fs_usage_output} ${stderr}= Execute Command
654 ... ${bmc_file_system_usage_cmd} return_stderr=True
655 Should Be Empty ${stderr}
656 Should Be True ${bmc_fs_usage_output}==0
657
Sivas SRRea85d1f2016-11-13 22:44:28 -0600658Check BMC CPU Performance
659 [Documentation] Minimal 10% of proc should be free in 3 sample
660 :FOR ${var} IN Range 1 4
661 \ BMC CPU Performance check
662
663Check BMC Mem Performance
664 [Documentation] Minimal 10% of memory should be free
665
666 :FOR ${var} IN Range 1 4
667 \ BMC Mem Performance check
668
Sivas SRRaca55712016-12-21 04:32:35 -0600669Check BMC File System Performance
670 [Documentation] Check for file system usage for 4 times
671
672 :FOR ${var} IN Range 1 4
673 \ BMC File System Usage check
674
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500675Get URL List
676 [Documentation] Return list of URLs under given URL.
677 [Arguments] ${openbmc_url}
678 # Description of argument(s):
Michael Walsh5f3f4142017-05-22 17:09:47 -0500679 # openbmc_url URL for list operation (e.g.
680 # /xyz/openbmc_project/inventory).
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500681
682 ${url_list}= Read Properties ${openbmc_url}/list
683 [Return] ${url_list}
684
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600685Get Endpoint Paths
686 [Documentation] Returns all url paths ending with given endpoint
687 ... Example:
688 ... Given the following endpoint: cpu
Michael Walsh01bd3682017-01-10 11:21:05 -0600689 ... This keyword will return: list of all urls ending with
690 ... cpu -
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600691 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
692 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
693 ... Description of arguments:
694 ... path URL path for enumeration
695 ... endpoint string for which url path ending
696 [Arguments] ${path} ${endpoint}
697
698 ${resp}= Read Properties ${path}/enumerate timeout=30
699 log Dictionary ${resp}
700
701 ${list}= Get Dictionary Keys ${resp}
702 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9]*$
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600703 [Return] ${resp}
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500704
705Check Zombie Process
706 [Documentation] Check if any defunct process exist or not on BMC
Michael Walsh01bd3682017-01-10 11:21:05 -0600707 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500708 ... return_stderr=True return_rc=True
709 Should Be True ${count}==0
710 Should Be Empty ${stderr}
George Keishing5327d012016-12-08 08:43:29 -0600711
712Prune Journal Log
713 [Documentation] Prune archived journal logs.
714 [Arguments] ${vacuum_size}=1M
715
716 # This keyword can be used to prevent the journal
717 # log from filling up the /run filesystem.
718 # This command will retain only the latest logs
719 # of the user specified size.
720
721 Open Connection And Log In
722 ${output} ${stderr} ${rc}=
723 ... Execute Command
724 ... journalctl --vacuum-size=${vacuum_size}
725 ... return_stderr=True return_rc=True
726
727 Should Be Equal ${rc} ${0} msg=${stderr}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600728
729Set BMC Power Policy
730 [Documentation] Set the given BMC power policy.
731 [arguments] ${policy}
732
733 ${valueDict}= create dictionary data=${policy}
734 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
735 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
736 Should Be Equal ${currentPolicy} ${policy}
George Keishingcce9df22017-01-24 06:19:33 -0600737
George Keishing4d6f3d62017-02-06 09:50:41 -0600738Get System Power Policy
739 [Documentation] Get the BMC power policy.
740 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
741 [Return] ${currentPolicy}
George Keishingcce9df22017-01-24 06:19:33 -0600742
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600743Get Auto Reboot
744 [Documentation] Returns auto reboot setting.
Sridevi Ramesh4dbe6592017-04-06 01:47:52 -0500745 ${setting}= Read Attribute ${HOST_SETTING} auto_reboot
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600746 [Return] ${setting}
747
748
749Set Auto Reboot
750 [Documentation] Set the given auto reboot setting.
751 [Arguments] ${setting}
752 # setting auto reboot's setting, i.e. yes or no
753
754 ${valueDict}= Set Variable ${setting}
755 ${data}= Create Dictionary data=${valueDict}
Sridevi Ramesh4dbe6592017-04-06 01:47:52 -0500756 Write Attribute ${HOST_SETTING} auto_reboot data=${data}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600757 ${current_setting}= Get Auto Reboot
758 Should Be Equal ${current_setting} ${setting}
759
760
George Keishingcce9df22017-01-24 06:19:33 -0600761Set BMC Reset Reference Time
762 [Documentation] Set current boot time as a reference and increment
George Keishing80dd5af2017-02-08 07:01:25 -0600763 ... boot count.
George Keishingcce9df22017-01-24 06:19:33 -0600764
765 ${cur_btime}= Get BMC Boot Time
George Keishing80dd5af2017-02-08 07:01:25 -0600766 Run Keyword If ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
George Keishingcce9df22017-01-24 06:19:33 -0600767 ... Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishing80dd5af2017-02-08 07:01:25 -0600768 ... ELSE IF ${cur_btime} > ${BOOT_TIME}
769 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishingcce9df22017-01-24 06:19:33 -0600770 ... AND
771 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
772
George Keishingcce9df22017-01-24 06:19:33 -0600773Get BMC Boot Time
774 [Documentation] Get boot time from /proc/stat.
775
776 Open Connection And Log In
777 ${output} ${stderr}=
778 ... Execute Command egrep '^btime ' /proc/stat | cut -f 2 -d ' '
779 ... return_stderr=True
780 Should Be Empty ${stderr}
781 ${btime}= Convert To Integer ${output}
782 [Return] ${btime}
George Keishingede30002017-02-02 09:33:07 -0600783
George Keishingede30002017-02-02 09:33:07 -0600784Execute Command On BMC
785 [Documentation] Execute given command on BMC and return output.
786 [Arguments] ${command}
787 ${stdout} ${stderr}= Execute Command ${command} return_stderr=True
788 Should Be Empty ${stderr}
789 [Return] ${stdout}
David Shawba2d2c22017-01-23 16:56:38 -0600790
Sridevi Rameshea36b412017-03-09 04:08:02 -0600791
George Keishing7a520222017-02-27 09:44:30 -0600792Enable Core Dump On BMC
793 [Documentation] Enable core dump collection.
794 Open Connection And Log In
795 ${core_pattern}= Execute Command On BMC
796 ... echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
797 Should Be Equal As Strings ${core_pattern} /tmp/core_%e.%p
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600798
Sivas SRR01262bd2017-03-19 10:00:23 -0500799Get Number Of BMC Core Dump Files
800 [Documentation] Get number of core dump files on BMC.
801 Open Connection And Log In
802 ${num_of_core_dump}= Execute Command
803 ... ls /tmp/core* 2>/dev/null | wc -l
804 [Return] ${num_of_core_dump}
805
806Set Core Dump File Size Unlimited
807 [Documentation] Set core dump file size to unlimited.
808 Open Connection And Log In
809 Execute Command On BMC
810 ... ulimit -c unlimited
811
812Check For Core Dumps
813 [Documentation] Check for any core dumps exist.
814 ${output}= Get Number Of BMC Core Dump Files
815 Run Keyword If ${output} > 0
816 ... Log **Warning** BMC core dump files exist level=WARN
817
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600818Trigger Host Watchdog Error
819 [Documentation] Inject host watchdog error using BMC.
820 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Michael Walshb5839d02017-04-12 16:11:20 -0500821 # Description of argument(s):
822 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
823 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600824 # sleep_time Time delay for host watchdog error to get injected.
825 # Default is 5 seconds.
826
827 Execute Command On BMC
828 ... /usr/sbin/mapper call /org/openbmc/watchdog/host0 org.openbmc.Watchdog set i ${milliseconds}
829 Execute Command On BMC
830 ... /usr/sbin/mapper call /org/openbmc/watchdog/host0 org.openbmc.Watchdog start
831 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500832
833Login To OS Host
834 [Documentation] Login to OS Host.
835 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
836 ... ${os_password}=${OS_PASSWORD}
837 # Desription of arguments:
838 # ${os_host} IP address of the OS Host.
839 # ${os_username} OS Host Login user name.
840 # ${os_password} OS Host Login passwrd.
841
842 ${os_state}= Run Keyword And Return Status Ping Host ${os_host}
843 Run Keyword If '${os_state}' == 'False'
844 ... Run Keywords Initiate Host Reboot AND
845 ... Is Host Running AND
846 ... Wait for OS ${os_host} ${os_username} ${os_password}
847
848 Open Connection ${os_host}
Sridevi Rameshea36b412017-03-09 04:08:02 -0600849 ${resp}= Login ${os_username} ${os_password}
850 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -0500851
852Configure Initial Settings
853 [Documentation] Restore old IP and route.
854 ... This keyword requires initial settings viz IP address,
855 ... Network Mask, default gatway and serial console IP and port
856 ... information which should be provided in command line.
857
Michael Walshb5839d02017-04-12 16:11:20 -0500858 [Arguments] ${host}=${OPENBMC_HOST} ${mask}=${NET_MASK}
859 ... ${gw_ip}=${GW_IP}
Prashanth Katti884ee062017-03-16 05:05:03 -0500860
Michael Walshb5839d02017-04-12 16:11:20 -0500861 # Open telnet connection and ignore the error, in case telnet session is
862 # already opened by the program calling this keyword.
Prashanth Katti884ee062017-03-16 05:05:03 -0500863
864 Run Keyword And Ignore Error Open Telnet Connection to BMC Serial Console
865 Telnet.write ifconfig eth0 ${host} netmask ${mask}
866 Telnet.write route add default gw ${gw_ip}
George Keishingd05b1082017-03-24 05:27:32 -0500867
868Install Debug Tarball On BMC
George Keishing55441822017-05-18 14:17:59 -0500869 [Documentation] Copy the debug tar file to BMC and install.
870 [Arguments] ${tarball_file_path}=${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz
871 ... ${targ_tarball_dir_path}=/home/root/tarball/
George Keishingd05b1082017-03-24 05:27:32 -0500872
George Keishing55441822017-05-18 14:17:59 -0500873 # Description of arguments:
874 # tarball_file_path Path of the debug tarball file.
875 # The tar file is downloaded from the build page
876 # https://openpower.xyz/job/openbmc-build/
877 # obmc-phosphor-debug-tarball-witherspoon.tar.xz
878 #
879 # targ_tarball_dir_path The directory path where the tarball is to be
880 # installed.
881
882 OperatingSystem.File Should Exist ${tarball_file_path}
883 ... msg=${tarball_file_path} doesn't exist.
884
885 # Upload the file to BMC.
George Keishingd05b1082017-03-24 05:27:32 -0500886 Import Library SCPLibrary WITH NAME scp
887 Open Connection for SCP
George Keishing55441822017-05-18 14:17:59 -0500888 scp.Put File ${tarball_file_path} /tmp/debug-tarball.tar.xz
889
890 # Create tarball directory and install.
George Keishingd05b1082017-03-24 05:27:32 -0500891 Open Connection And Log In
George Keishing55441822017-05-18 14:17:59 -0500892 Execute Command On BMC mkdir -p ${targ_tarball_dir_path}
893 Execute Command On BMC
894 ... tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path}
895
896 # Create symlink to callout-test binary.
897 Execute Command On BMC
898 ... ln -s ${targ_tarball_dir_path}/bin/callout-test /usr/bin/callout-test
899
George Keishing4fc998b2017-05-26 05:24:12 -0500900 # Create symlink to logging-test binary.
901 Execute Command On BMC
902 ... ln -s ${targ_tarball_dir_path}/bin/logging-test /usr/bin/logging-test
903
George Keishingd05b1082017-03-24 05:27:32 -0500904 # Remove the tarball file from BMC
905 Execute Command On BMC rm /tmp/debug-tarball.tar.xz
906
George Keishing55441822017-05-18 14:17:59 -0500907
Sweta Potthuri025e0122017-02-21 00:42:48 -0600908Get BMC Boot Count
909 [Documentation] Get BMC boot count based on boot time.
910 ${cur_btime}= Get BMC Boot Time
911
912 # Set global variable BOOT_TIME to current boot time if current boot time
913 # is changed. Also increase value of global variable BOOT_COUNT by 1.
914 Run Keyword If ${cur_btime} > ${BOOT_TIME}
915 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
916 ... AND
917 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
918 [Return] ${BOOT_COUNT}
919
920Set BMC Boot Count
921 [Documentation] Set BMC boot count to given value.
922 [Arguments] ${count}
923
924 # Description of arguments:
925 # count boot count value.
926 ${cur_btime}= Get BMC Boot Time
927
928 # Set global variable BOOT_COUNT to given value.
929 Set Global Variable ${BOOT_COUNT} ${count}
930
931 # Set BOOT_TIME variable to current boot time.
932 Set Global Variable ${BOOT_COUNT} ${count}
Michael Walsh689fbbe2017-04-04 17:58:03 -0500933
934###############################################################################
935Delete Error logs
936 [Documentation] Delete error logs.
937
938 # The REST method to delete error openbmc/openbmc#1327
939 # until then using logging restart.
940 Open Connection And Log In
941 Execute Command On BMC
942 ... systemctl restart xyz.openbmc_project.Logging.service
943 Sleep 10s reason=Wait for logging service to restart properly.
George Keishingdb34c2f2017-04-18 13:20:25 -0500944
945###############################################################################
946Delete Error log Entry
947 [Documentation] Delete error log entry.
948 [Arguments] ${entry_path}
949
950 # Description of argument(s):
951 # entry_path Delete an error log entry.
952 # Ex. /xyz/openbmc_project/logging/entry/1
953
954 ${data}= Create Dictionary data=@{EMPTY}
955 ${resp}= Openbmc Delete Request ${entry_path} data=${data}
956 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Rahul Maheshwari43be6932017-05-01 02:37:06 -0500957
958
959Get LED State XYZ
960 [Documentation] Returns state of given LED.
961 [Arguments] ${led_name}
962 # Description of argument(s):
963 # led_name Name of LED
964
965 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
966 [Return] ${state}