blob: bc10fd8117f1a1d870b454eeb9cf606bbcfdefd6 [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
Michael Walshe53e47a2017-06-30 17:03:24 -050012Library bmc_ssh_utils.py
Chris Austenb29d2e82016-06-07 12:25:35 -050013
14*** Variables ***
Sivas SRRd97aa9c2017-05-22 11:19:25 -050015${pflash_cmd} /usr/sbin/pflash -r /dev/stdout -P VERSION
Chris Austenb29d2e82016-06-07 12:25:35 -050016${SYSTEM_SHUTDOWN_TIME} ${5}
Michael Walsha6723f22016-11-22 11:12:01 -060017${dbuscmdBase}
George Keishing85ca05e2016-11-30 09:47:18 -060018... dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host
Michael Walsha6723f22016-11-22 11:12:01 -060019${dbuscmdGet}
George Keishing9485af92017-01-04 10:21:43 -060020... ${SETTINGS_URI}host0 org.freedesktop.DBus.Properties.Get
George Keishing85ca05e2016-11-30 09:47:18 -060021# Enable when ready with openbmc/openbmc-test-automation#203
22#${dbuscmdString}= string:"xyz.openbmc_project.settings.Host" string:
Michael Walsha6723f22016-11-22 11:12:01 -060023${dbuscmdString}= string:"org.openbmc.settings.Host" string:
24
25# Assign default value to QUIET for programs which may not define it.
26${QUIET} ${0}
Sivas SRRea85d1f2016-11-13 22:44:28 -060027${bmc_mem_free_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4
28${bmc_mem_total_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2
29${bmc_cpu_usage_cmd}= top -n 1 | grep CPU: | cut -c 7-9
Sridevi Ramesh1699d372016-12-06 00:20:22 -060030${HOST_SETTING} ${SETTINGS_URI}host0
Sivas SRR352bc162017-02-13 22:12:29 -060031# /run/initramfs/ro associate filesystem should be 100% full always
Sivas SRRaca55712016-12-21 04:32:35 -060032${bmc_file_system_usage_cmd}=
Sivas SRR352bc162017-02-13 22:12:29 -060033... df -h | grep -v /run/initramfs/ro | cut -c 52-54 | grep 100 | wc -l
Chris Austenb29d2e82016-06-07 12:25:35 -050034
George Keishingcce9df22017-01-24 06:19:33 -060035${BOOT_TIME} ${0}
36${BOOT_COUNT} ${0}
Sweta Potthuri025e0122017-02-21 00:42:48 -060037${count} ${0}
Sivas SRR8254db62017-02-07 09:39:46 -060038${devicetree_base} /sys/firmware/devicetree/base/model
George Keishingcce9df22017-01-24 06:19:33 -060039
George Keishingb7c9b542017-05-23 08:19:58 -050040# Initialize default debug value to 0.
41${DEBUG} ${0}
42
Chris Austenb29d2e82016-06-07 12:25:35 -050043*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060044
Sivas SRRd97aa9c2017-05-22 11:19:25 -050045Verify PNOR Update
46 [Documentation] Verify that the PNOR is not corrupted.
47 # Example:
48 # FFS: Flash header not found. Code: 100
49 # Error 100 opening ffs !
50
51 Open Connection And Log In
52 ${pnor_info}= Execute Command On BMC ${pflash_cmd}
53 Should Not Contain Any ${pnor_info} Flash header not found Error
54
Sivas SRR8254db62017-02-07 09:39:46 -060055Get BMC System Model
56 [Documentation] Get the BMC model from the device tree.
57
Michael Walshe53e47a2017-06-30 17:03:24 -050058 ${bmc_model} ${stderr} ${rc}= BMC Execute Command
George Keishing90ab1772017-02-24 05:40:55 -060059 ... 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.
Sweta Potthuri62a23572017-07-28 04:05:13 -0500167 Set Auto Reboot ${1}
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
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500345Get Boot Progress To OS Starting State
346 [Documentation] Get the system to a boot progress state of 'FW Progress,
347 ... Starting OS'.
348
349 ${boot_progress}= Get Boot Progress
350 Run Keyword If '${boot_progress}' == 'FW Progress, Starting OS'
351 ... Log Host is already in OS starting state
352 ... ELSE
353 ... Run Keywords Initiate Host PowerOff AND Initiate Host Boot
354 ... AND Wait Until Keyword Succeeds 10 min 10 sec Is OS Starting
355
George Keishing5e870cd2016-08-24 10:05:47 -0500356Verify Ping and REST Authentication
Michael Walsha6723f22016-11-22 11:12:01 -0600357 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500358 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -0500359 Run Keyword If '${l_ping}' == '${False}'
360 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500361
Michael Walsha6723f22016-11-22 11:12:01 -0600362 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500363 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -0500364 Run Keyword If '${l_rest}' == '${False}'
365 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500366
367 # Just to make sure the SSH is working for SCP
368 Open Connection And Log In
369 ${system} ${stderr}= Execute Command hostname return_stderr=True
370 Should Be Empty ${stderr}
371
George Keishingc4d3dc02016-09-19 03:45:55 -0500372Check If BMC is Up
373 [Documentation] Wait for Host to be online. Checks every X seconds
374 ... interval for Y minutes and fails if timed out.
375 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -0600376 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -0500377 ... ${interval}=10 sec
378
379 Wait Until Keyword Succeeds
380 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
381
George Keishingb3700812016-08-31 03:03:30 -0500382
383Check If warmReset is Initiated
384 [Documentation] Ping would be still alive, so try SSH to connect
385 ... if fails the ports are down indicating reboot
386 ... is in progress
George Keishing3c05d352016-12-13 06:54:50 -0600387
388 # Warm reset adds 3 seconds delay before forcing reboot
389 # To minimize race conditions, we wait for 7 seconds
390 Sleep 7s
George Keishingb3700812016-08-31 03:03:30 -0500391 ${alive}= Run Keyword and Return Status
392 ... Open Connection And Log In
393 Return From Keyword If '${alive}' == '${False}' ${False}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600394 [Return] ${True}
George Keishingb3700812016-08-31 03:03:30 -0500395
George Keishing06ae4aa2016-08-30 01:41:28 -0500396Flush REST Sessions
397 [Documentation] Removes all the active session objects
398 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500399
Sivas SRRe1143ae2016-08-26 22:31:02 -0500400Initialize DBUS cmd
401 [Documentation] Initialize dbus string with property string to extract
Gunnar Mills38032802016-12-12 13:43:40 -0600402 [Arguments] ${boot_property}
Michael Walsha6723f22016-11-22 11:12:01 -0600403 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
404 ${cmd}= Catenate ${cmd}${boot_property}
Sivas SRRe1143ae2016-08-26 22:31:02 -0500405 Set Global Variable ${dbuscmd} ${cmd}
406
David Shawba2d2c22017-01-23 16:56:38 -0600407Create OS Console File Path
408 [Documentation] Create OS console file path name and return it.
409 [Arguments] ${log_file_path}=${EMPTY}
George Keishing30c12ff2016-09-02 10:25:29 -0500410
David Shawba2d2c22017-01-23 16:56:38 -0600411 # Description of arguements:
412 # file_path The caller's candidate value. If this value is ${EMPTY}, this
413 # keyword will compose a file path name. Otherwise, this
414 # keyword will use the caller's file_path value. In either
415 # case, the value will be returned.
Gunnar Mills9c760342016-12-08 10:12:06 -0600416
David Shawba2d2c22017-01-23 16:56:38 -0600417 ${default_file_path}= Catenate /tmp/${OPENBMC_HOST}_os_console
418 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
419 ... ${default_file_path} ${log_file_path}
Michael Walsh01bd3682017-01-10 11:21:05 -0600420
David Shawba2d2c22017-01-23 16:56:38 -0600421 [Return] ${log_file_path}
Gunnar Mills9c760342016-12-08 10:12:06 -0600422
David Shawba2d2c22017-01-23 16:56:38 -0600423Create OS Console Command String
424 [Documentation] Return a command string to start OS console logging.
Gunnar Mills9c760342016-12-08 10:12:06 -0600425
David Shawba2d2c22017-01-23 16:56:38 -0600426 # First make sure that the ssh_pw program is available.
427 ${cmd_buf}= Catenate which ssh_pw 2>&1
428 Rdpissuing ${cmd_buf}
429 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
430 Rdpvars rc output
431 Should Be Equal ${rc} ${0} msg=${output}\n
Gunnar Mills9c760342016-12-08 10:12:06 -0600432
David Shawba2d2c22017-01-23 16:56:38 -0600433 ${cmd_buf}= Catenate ssh_pw ${OPENBMC_PASSWORD} -p 2200
George Keishing1f9ec7f2017-06-06 08:59:19 -0500434 ... -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST}
George Keishing30c12ff2016-09-02 10:25:29 -0500435
David Shawba2d2c22017-01-23 16:56:38 -0600436 [Return] ${cmd_buf}
George Keishing30c12ff2016-09-02 10:25:29 -0500437
438Stop SOL Console Logging
David Shawba2d2c22017-01-23 16:56:38 -0600439 [Documentation] Stop system console logging and return log output.
George Keishing72992e42017-06-16 06:42:36 -0500440 [Arguments] ${log_file_path}=${EMPTY}
441 ... ${targ_file_path}=${EXECDIR}${/}logs${/}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500442 ... ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600443
444 # If there are muliple system console processes, they will all be stopped.
445 # If there is no existing log file this keyword will return an error
446 # message to that effect (and write that message to targ_file_path, if
447 # specified).
448 # NOTE: This keyword will not fail if there is no running system console
449 # process.
Michael Walsh01bd3682017-01-10 11:21:05 -0600450
451 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600452 # log_file_path The file path that was used to call "Start SOL
453 # Console Logging". See that keyword (above) for details.
454 # targ_file_path If specified, the file path to which the source
455 # file path (i.e. "log_file_path") should be copied.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500456 # return_data If this is set to ${1}, this keyword will return the SOL
457 # data to the caller as a unicode string.
George Keishing30c12ff2016-09-02 10:25:29 -0500458
David Shawba2d2c22017-01-23 16:56:38 -0600459 ${log_file_path}= Create OS Console File Path ${log_file_path}
460 # Find the pid of the active system console logging session (if any).
461 ${search_string}= Create OS Console Command String
462 ${cmd_buf}= Catenate echo $(ps -ef | egrep '${search_string}'
463 ... | egrep -v grep | cut -c10-14)
464 Rdpissuing ${cmd_buf}
465 ${rc} ${os_con_pid}= Run And Return Rc And Output ${cmd_buf}
466 Rdpvars os_con_pid
467 # If rc is not zero it just means that there is no OS Console process
468 # running.
George Keishing30c12ff2016-09-02 10:25:29 -0500469
David Shawba2d2c22017-01-23 16:56:38 -0600470 ${cmd_buf}= Catenate kill -9 ${os_con_pid}
471 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpissuing ${cmd_buf}
472 ${rc} ${output}= Run Keyword If '${os_con_pid}' != '${EMPTY}'
473 ... Run And Return Rc And Output ${cmd_buf}
474 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpvars rc output
George Keishing30c12ff2016-09-02 10:25:29 -0500475
Michael Walsh01bd3682017-01-10 11:21:05 -0600476 Run Keyword If '${targ_file_path}' != '${EMPTY}'
David Shawba2d2c22017-01-23 16:56:38 -0600477 ... Run Keyword And Ignore Error
478 ... Copy File ${log_file_path} ${targ_file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500479
Michael Walsh5f3f4142017-05-22 17:09:47 -0500480 ${output}= Set Variable ${EMPTY}
481 ${loc_quiet}= Evaluate ${debug}^1
482 ${rc} ${output}= Run Keyword If '${return_data}' == '${1}'
483 ... Cmd Fnc cat ${log_file_path} quiet=${loc_quiet} print_output=${0}
484
David Shawba2d2c22017-01-23 16:56:38 -0600485 [Return] ${output}
486
487Start SOL Console Logging
488 [Documentation] Start system console log to file.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500489 [Arguments] ${log_file_path}=${EMPTY} ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600490
491 # This keyword will first call "Stop SOL Console Logging". Only then will
492 # it start SOL console logging. The data returned by "Stop SOL Console
493 # Logging" will in turn be returned by this keyword.
494
495 # Description of arguments:
Michael Walsh5f3f4142017-05-22 17:09:47 -0500496 # log_file_path The file path to which system console log data should be
497 # written. Note that this path is taken to be a location
498 # on the machine where this program is running rather than
499 # on the Open BMC system.
500 # return_data If this is set to ${1}, this keyword will return any SOL
501 # data to the caller as a unicode string.
David Shawba2d2c22017-01-23 16:56:38 -0600502
503 ${log_file_path}= Create OS Console File Path ${log_file_path}
504
505 ${log_output}= Stop SOL Console Logging ${log_file_path}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500506 ... return_data=${return_data}
David Shawba2d2c22017-01-23 16:56:38 -0600507
508 # Validate by making sure we can create the file. Problems creating the
509 # file would not be noticed by the subsequent ssh command because we fork
510 # the command.
511 Create File ${log_file_path}
512 ${sub_cmd_buf}= Create OS Console Command String
513 # Routing stderr to stdout so that any startup error text will go to the
514 # output file.
515 ${cmd_buf}= Catenate ${sub_cmd_buf} > ${log_file_path} 2>&1 &
516 Rdpissuing ${cmd_buf}
517 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
518 # Because we are forking this command, we essentially will never get a
519 # non-zero return code or any output.
520 Should Be Equal ${rc} ${0}
521
522 [Return] ${log_output}
George Keishing30c12ff2016-09-02 10:25:29 -0500523
524Get Time Stamp
525 [Documentation] Get the current time stamp data
526 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500527 [Return] ${cur_time}
George Keishing30c12ff2016-09-02 10:25:29 -0500528
George Keishing1b150202016-09-29 08:51:58 -0500529
530Verify BMC State
531 [Documentation] Get the BMC state and verify if the current
532 ... BMC state is as expected.
533 [Arguments] ${expected}
534
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600535 ${current}= Get BMC State Deprecated
George Keishing8db0e1b2016-10-20 13:46:54 -0500536 Should Contain ${expected} ${current}
George Keishing1b150202016-09-29 08:51:58 -0500537
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500538Start Journal Log
539 [Documentation] Start capturing journal log to a file in /tmp using
540 ... journalctl command. By default journal log is collected
541 ... at /tmp/journal_log else user input location.
542 ... The File is appended with datetime.
543 [Arguments] ${file_path}=/tmp/journal_log
544
545 Open Connection And Log In
546
547 ${cur_time}= Get Time Stamp
548 Set Global Variable ${LOG_TIME} ${cur_time}
549 Start Command
550 ... journalctl -f > ${file_path}-${LOG_TIME}
551 Log Journal Log Started: ${file_path}-${LOG_TIME}
552
David Shawba2d2c22017-01-23 16:56:38 -0600553
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500554Stop Journal Log
555 [Documentation] Stop journalctl process if its running.
556 ... By default return log from /tmp/journal_log else
557 ... user input location.
558 [Arguments] ${file_path}=/tmp/journal_log
559
560 Open Connection And Log In
561
562 ${rc}=
563 ... Execute Command
564 ... ps ax | grep journalctl | grep -v grep
565 ... return_stdout=False return_rc=True
566
567 Return From Keyword If '${rc}' == '${1}'
568 ... No journal log process running
569
570 ${output} ${stderr}=
571 ... Execute Command killall journalctl
572 ... return_stderr=True
573 Should Be Empty ${stderr}
574
575 ${journal_log} ${stderr}=
576 ... Execute Command
577 ... cat ${file_path}-${LOG_TIME}
578 ... return_stderr=True
579 Should Be Empty ${stderr}
580
581 Log ${journal_log}
582
583 Execute Command rm ${file_path}-${LOG_TIME}
584
585 [Return] ${journal_log}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500586
587Mac Address To Hex String
588 [Documentation] Converts MAC address into hex format.
589 ... Example
590 ... Given the following MAC: 00:01:6C:80:02:78
591 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
592 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600593 ... i_macaddress MAC address in the following format
594 ... 00:01:6C:80:02:78
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500595 [Arguments] ${i_macaddress}
596
597 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600598 [Return] ${mac_hex}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500599
600IP Address To Hex String
601 [Documentation] Converts IP address into hex format.
602 ... Example:
603 ... Given the following IP: 10.3.164.100
604 ... This keyword will return: 0xa 0x3 0xa4 0xa0
605 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600606 ... i_ipaddress IP address in the following format
607 ... 10.10.10.10
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500608 [Arguments] ${i_ipaddress}
609
610 @{ip}= Split String ${i_ipaddress} .
611 ${index}= Set Variable ${0}
612
613 :FOR ${item} IN @{ip}
614 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes
615 \ Set List Value ${ip} ${index} ${hex}
616 \ ${index}= Set Variable ${index + 1}
617 ${ip_hex}= Catenate @{ip}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600618 [Return] ${ip_hex}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600619
620BMC CPU Performance Check
621 [Documentation] Minimal 10% of proc should be free in this instance
622
623 ${bmc_cpu_usage_output} ${stderr}= Execute Command ${bmc_cpu_usage_cmd}
624 ... return_stderr=True
625 Should be empty ${stderr}
626 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} %
627 Should be true ${bmc_cpu_percentage} < 90
628
629BMC Mem Performance Check
630 [Documentation] Minimal 10% of memory should be free in this instance
631
632 ${bmc_mem_free_output} ${stderr}= Execute Command ${bmc_mem_free_cmd}
633 ... return_stderr=True
634 Should be empty ${stderr}
635
636 ${bmc_mem_total_output} ${stderr}= Execute Command ${bmc_mem_total_cmd}
637 ... return_stderr=True
638 Should be empty ${stderr}
639
640 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100
641 ${bmc_mem_percentage}= Evaluate
642 ... ${bmc_mem_percentage}/${bmc_mem_total_output}
643 Should be true ${bmc_mem_percentage} > 10
644
Sivas SRRaca55712016-12-21 04:32:35 -0600645BMC File System Usage Check
646 [Documentation] Check the file system space. None should be 100% full
Sivas SRR352bc162017-02-13 22:12:29 -0600647 ... except /run/initramfs/ro
Sivas SRRaca55712016-12-21 04:32:35 -0600648 ${bmc_fs_usage_output} ${stderr}= Execute Command
649 ... ${bmc_file_system_usage_cmd} return_stderr=True
650 Should Be Empty ${stderr}
651 Should Be True ${bmc_fs_usage_output}==0
652
Sivas SRRea85d1f2016-11-13 22:44:28 -0600653Check BMC CPU Performance
654 [Documentation] Minimal 10% of proc should be free in 3 sample
655 :FOR ${var} IN Range 1 4
656 \ BMC CPU Performance check
657
658Check BMC Mem Performance
659 [Documentation] Minimal 10% of memory should be free
660
661 :FOR ${var} IN Range 1 4
662 \ BMC Mem Performance check
663
Sivas SRRaca55712016-12-21 04:32:35 -0600664Check BMC File System Performance
665 [Documentation] Check for file system usage for 4 times
666
667 :FOR ${var} IN Range 1 4
668 \ BMC File System Usage check
669
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500670Get URL List
671 [Documentation] Return list of URLs under given URL.
672 [Arguments] ${openbmc_url}
673 # Description of argument(s):
Michael Walsh5f3f4142017-05-22 17:09:47 -0500674 # openbmc_url URL for list operation (e.g.
675 # /xyz/openbmc_project/inventory).
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500676
George Keishing335f5362017-06-30 15:11:20 -0500677 ${url_list}= Read Properties ${openbmc_url}/list quiet=${1}
George Keishing184a89a2017-06-27 07:12:16 -0500678 Sort List ${url_list}
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500679 [Return] ${url_list}
680
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600681Get Endpoint Paths
682 [Documentation] Returns all url paths ending with given endpoint
683 ... Example:
684 ... Given the following endpoint: cpu
Michael Walsh01bd3682017-01-10 11:21:05 -0600685 ... This keyword will return: list of all urls ending with
686 ... cpu -
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600687 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
688 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
689 ... Description of arguments:
690 ... path URL path for enumeration
691 ... endpoint string for which url path ending
692 [Arguments] ${path} ${endpoint}
693
694 ${resp}= Read Properties ${path}/enumerate timeout=30
695 log Dictionary ${resp}
696
697 ${list}= Get Dictionary Keys ${resp}
698 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9]*$
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600699 [Return] ${resp}
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500700
701Check Zombie Process
702 [Documentation] Check if any defunct process exist or not on BMC
Michael Walsh01bd3682017-01-10 11:21:05 -0600703 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500704 ... return_stderr=True return_rc=True
705 Should Be True ${count}==0
706 Should Be Empty ${stderr}
George Keishing5327d012016-12-08 08:43:29 -0600707
708Prune Journal Log
709 [Documentation] Prune archived journal logs.
710 [Arguments] ${vacuum_size}=1M
711
712 # This keyword can be used to prevent the journal
713 # log from filling up the /run filesystem.
714 # This command will retain only the latest logs
715 # of the user specified size.
716
717 Open Connection And Log In
718 ${output} ${stderr} ${rc}=
719 ... Execute Command
720 ... journalctl --vacuum-size=${vacuum_size}
721 ... return_stderr=True return_rc=True
722
723 Should Be Equal ${rc} ${0} msg=${stderr}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600724
725Set BMC Power Policy
726 [Documentation] Set the given BMC power policy.
George Keishingd85b28f2017-08-17 00:31:54 -0500727 [arguments] ${power_restore_uri}=${POWER_RESTORE_URI}
728 ... ${policy_attribute}=PowerRestorePolicy
729 ... ${policy}=${RESTORE_LAST_STATE}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600730
George Keishing1c3a9662017-08-11 10:16:36 -0500731 # Description of argument(s):
George Keishingd85b28f2017-08-17 00:31:54 -0500732 # power_restore_uri Power restore policy url.
733 # By default "/xyz/openbmc_project/control/host0/power_restore_policy/".
734 # policy Power restore policy.
735 # By default ""xyz.openbmc_project.Control.Power.RestorePolicy.Policy.Restore".
George Keishing1c3a9662017-08-11 10:16:36 -0500736
737 ${valueDict}= Create Dictionary data=${policy}
738 Write Attribute
George Keishingd85b28f2017-08-17 00:31:54 -0500739 ... ${power_restore_uri} ${policy_attribute} data=${valueDict}
740 ${currentPolicy}=
741 ... Read Attribute ${power_restore_uri} ${policy_attribute}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600742 Should Be Equal ${currentPolicy} ${policy}
George Keishingcce9df22017-01-24 06:19:33 -0600743
George Keishing4d6f3d62017-02-06 09:50:41 -0600744Get System Power Policy
745 [Documentation] Get the BMC power policy.
George Keishing1c3a9662017-08-11 10:16:36 -0500746 ${currentPolicy}= Read Attribute ${POWER_RESTORE_URI} PowerRestorePolicy
George Keishing4d6f3d62017-02-06 09:50:41 -0600747 [Return] ${currentPolicy}
George Keishingcce9df22017-01-24 06:19:33 -0600748
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600749Get Auto Reboot
750 [Documentation] Returns auto reboot setting.
Sweta Potthuri62a23572017-07-28 04:05:13 -0500751 ${setting}= Read Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600752 [Return] ${setting}
753
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600754Set Auto Reboot
755 [Documentation] Set the given auto reboot setting.
756 [Arguments] ${setting}
Sweta Potthuri62a23572017-07-28 04:05:13 -0500757 # setting auto reboot's setting, i.e. 1 for enabling and 0 for disabling.
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600758
759 ${valueDict}= Set Variable ${setting}
760 ${data}= Create Dictionary data=${valueDict}
Sweta Potthuri62a23572017-07-28 04:05:13 -0500761 Write Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot data=${data}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600762 ${current_setting}= Get Auto Reboot
Sweta Potthuri62a23572017-07-28 04:05:13 -0500763 Should Be Equal As Integers ${current_setting} ${setting}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600764
765
George Keishingcce9df22017-01-24 06:19:33 -0600766Set BMC Reset Reference Time
767 [Documentation] Set current boot time as a reference and increment
George Keishing80dd5af2017-02-08 07:01:25 -0600768 ... boot count.
George Keishingcce9df22017-01-24 06:19:33 -0600769
770 ${cur_btime}= Get BMC Boot Time
George Keishing80dd5af2017-02-08 07:01:25 -0600771 Run Keyword If ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
George Keishingcce9df22017-01-24 06:19:33 -0600772 ... Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishing80dd5af2017-02-08 07:01:25 -0600773 ... ELSE IF ${cur_btime} > ${BOOT_TIME}
774 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishingcce9df22017-01-24 06:19:33 -0600775 ... AND
776 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
777
George Keishingcce9df22017-01-24 06:19:33 -0600778Get BMC Boot Time
779 [Documentation] Get boot time from /proc/stat.
780
781 Open Connection And Log In
782 ${output} ${stderr}=
783 ... Execute Command egrep '^btime ' /proc/stat | cut -f 2 -d ' '
784 ... return_stderr=True
785 Should Be Empty ${stderr}
786 ${btime}= Convert To Integer ${output}
787 [Return] ${btime}
George Keishingede30002017-02-02 09:33:07 -0600788
George Keishingede30002017-02-02 09:33:07 -0600789Execute Command On BMC
790 [Documentation] Execute given command on BMC and return output.
791 [Arguments] ${command}
792 ${stdout} ${stderr}= Execute Command ${command} return_stderr=True
793 Should Be Empty ${stderr}
794 [Return] ${stdout}
David Shawba2d2c22017-01-23 16:56:38 -0600795
Sridevi Rameshea36b412017-03-09 04:08:02 -0600796
George Keishing7a520222017-02-27 09:44:30 -0600797Enable Core Dump On BMC
798 [Documentation] Enable core dump collection.
799 Open Connection And Log In
800 ${core_pattern}= Execute Command On BMC
801 ... echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
802 Should Be Equal As Strings ${core_pattern} /tmp/core_%e.%p
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600803
Sivas SRR01262bd2017-03-19 10:00:23 -0500804Get Number Of BMC Core Dump Files
805 [Documentation] Get number of core dump files on BMC.
806 Open Connection And Log In
807 ${num_of_core_dump}= Execute Command
808 ... ls /tmp/core* 2>/dev/null | wc -l
809 [Return] ${num_of_core_dump}
810
811Set Core Dump File Size Unlimited
812 [Documentation] Set core dump file size to unlimited.
813 Open Connection And Log In
814 Execute Command On BMC
815 ... ulimit -c unlimited
816
817Check For Core Dumps
818 [Documentation] Check for any core dumps exist.
819 ${output}= Get Number Of BMC Core Dump Files
820 Run Keyword If ${output} > 0
821 ... Log **Warning** BMC core dump files exist level=WARN
822
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600823Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -0500824 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600825 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Michael Walshb5839d02017-04-12 16:11:20 -0500826 # Description of argument(s):
827 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
828 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600829 # sleep_time Time delay for host watchdog error to get injected.
830 # Default is 5 seconds.
831
George Keishing37cfa6b2017-06-15 10:25:55 -0500832 ${data}= Create Dictionary data=${True}
833 Write Attribute /xyz/openbmc_project/watchdog/host0 Enabled data=${data}
834
835 ${data}= Create Dictionary data=${milliseconds}
836 Write Attribute /xyz/openbmc_project/watchdog/host0 TimeRemaining data=${data}
837
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600838 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500839
840Login To OS Host
841 [Documentation] Login to OS Host.
842 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
843 ... ${os_password}=${OS_PASSWORD}
844 # Desription of arguments:
845 # ${os_host} IP address of the OS Host.
846 # ${os_username} OS Host Login user name.
847 # ${os_password} OS Host Login passwrd.
848
849 ${os_state}= Run Keyword And Return Status Ping Host ${os_host}
850 Run Keyword If '${os_state}' == 'False'
851 ... Run Keywords Initiate Host Reboot AND
852 ... Is Host Running AND
853 ... Wait for OS ${os_host} ${os_username} ${os_password}
854
George Keishing3f223b82017-06-28 03:50:35 -0500855 SSHLibrary.Open Connection ${os_host}
Sridevi Rameshea36b412017-03-09 04:08:02 -0600856 ${resp}= Login ${os_username} ${os_password}
857 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -0500858
859Configure Initial Settings
860 [Documentation] Restore old IP and route.
861 ... This keyword requires initial settings viz IP address,
862 ... Network Mask, default gatway and serial console IP and port
863 ... information which should be provided in command line.
864
Michael Walshb5839d02017-04-12 16:11:20 -0500865 [Arguments] ${host}=${OPENBMC_HOST} ${mask}=${NET_MASK}
866 ... ${gw_ip}=${GW_IP}
Prashanth Katti884ee062017-03-16 05:05:03 -0500867
Michael Walshb5839d02017-04-12 16:11:20 -0500868 # Open telnet connection and ignore the error, in case telnet session is
869 # already opened by the program calling this keyword.
Prashanth Katti884ee062017-03-16 05:05:03 -0500870
871 Run Keyword And Ignore Error Open Telnet Connection to BMC Serial Console
872 Telnet.write ifconfig eth0 ${host} netmask ${mask}
873 Telnet.write route add default gw ${gw_ip}
George Keishingd05b1082017-03-24 05:27:32 -0500874
875Install Debug Tarball On BMC
George Keishing55441822017-05-18 14:17:59 -0500876 [Documentation] Copy the debug tar file to BMC and install.
877 [Arguments] ${tarball_file_path}=${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz
878 ... ${targ_tarball_dir_path}=/home/root/tarball/
George Keishingd05b1082017-03-24 05:27:32 -0500879
George Keishing55441822017-05-18 14:17:59 -0500880 # Description of arguments:
881 # tarball_file_path Path of the debug tarball file.
882 # The tar file is downloaded from the build page
883 # https://openpower.xyz/job/openbmc-build/
884 # obmc-phosphor-debug-tarball-witherspoon.tar.xz
885 #
886 # targ_tarball_dir_path The directory path where the tarball is to be
887 # installed.
888
889 OperatingSystem.File Should Exist ${tarball_file_path}
890 ... msg=${tarball_file_path} doesn't exist.
891
892 # Upload the file to BMC.
George Keishingd05b1082017-03-24 05:27:32 -0500893 Import Library SCPLibrary WITH NAME scp
894 Open Connection for SCP
George Keishing55441822017-05-18 14:17:59 -0500895 scp.Put File ${tarball_file_path} /tmp/debug-tarball.tar.xz
896
897 # Create tarball directory and install.
George Keishingd05b1082017-03-24 05:27:32 -0500898 Open Connection And Log In
George Keishing55441822017-05-18 14:17:59 -0500899 Execute Command On BMC mkdir -p ${targ_tarball_dir_path}
900 Execute Command On BMC
901 ... tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path}
902
903 # Create symlink to callout-test binary.
904 Execute Command On BMC
905 ... ln -s ${targ_tarball_dir_path}/bin/callout-test /usr/bin/callout-test
906
George Keishing4fc998b2017-05-26 05:24:12 -0500907 # Create symlink to logging-test binary.
908 Execute Command On BMC
909 ... ln -s ${targ_tarball_dir_path}/bin/logging-test /usr/bin/logging-test
910
George Keishingd05b1082017-03-24 05:27:32 -0500911 # Remove the tarball file from BMC
912 Execute Command On BMC rm /tmp/debug-tarball.tar.xz
913
George Keishing55441822017-05-18 14:17:59 -0500914
Sweta Potthuri025e0122017-02-21 00:42:48 -0600915Get BMC Boot Count
916 [Documentation] Get BMC boot count based on boot time.
917 ${cur_btime}= Get BMC Boot Time
918
919 # Set global variable BOOT_TIME to current boot time if current boot time
920 # is changed. Also increase value of global variable BOOT_COUNT by 1.
921 Run Keyword If ${cur_btime} > ${BOOT_TIME}
922 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
923 ... AND
924 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
925 [Return] ${BOOT_COUNT}
926
927Set BMC Boot Count
928 [Documentation] Set BMC boot count to given value.
929 [Arguments] ${count}
930
931 # Description of arguments:
932 # count boot count value.
933 ${cur_btime}= Get BMC Boot Time
934
935 # Set global variable BOOT_COUNT to given value.
936 Set Global Variable ${BOOT_COUNT} ${count}
937
938 # Set BOOT_TIME variable to current boot time.
939 Set Global Variable ${BOOT_COUNT} ${count}
Michael Walsh689fbbe2017-04-04 17:58:03 -0500940
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500941Get System LED State
942 [Documentation] Return the state of given system LED.
943 [Arguments] ${led_name}
944
945 # Description of argument(s):
946 # led_name System LED name (e.g. heartbeat, identify, beep).
947
948 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State
949 [Return] ${state.rsplit('.', 1)[1]}
950
Michael Walsh689fbbe2017-04-04 17:58:03 -0500951###############################################################################
George Keishingd2d90af2017-06-27 08:17:34 -0500952Delete Error Logs
Michael Walsh689fbbe2017-04-04 17:58:03 -0500953 [Documentation] Delete error logs.
954
George Keishingd2d90af2017-06-27 08:17:34 -0500955 # Check if error logs entries exist, if not return.
George Keishing335f5362017-06-30 15:11:20 -0500956 ${resp}= OpenBMC Get Request ${BMC_LOGGING_ENTRY}${/}list quiet=${1}
George Keishingd2d90af2017-06-27 08:17:34 -0500957 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND}
958
959 # Get the list of error logs entries and delete them all.
George Keishing335f5362017-06-30 15:11:20 -0500960 ${elog_entries}= Get URL List ${BMC_LOGGING_ENTRY}
George Keishingd2d90af2017-06-27 08:17:34 -0500961 :FOR ${entry} IN @{elog_entries}
962 \ Delete Error Log Entry ${entry}
George Keishingdb34c2f2017-04-18 13:20:25 -0500963
964###############################################################################
George Keishingd2d90af2017-06-27 08:17:34 -0500965Delete Error Log Entry
George Keishingdb34c2f2017-04-18 13:20:25 -0500966 [Documentation] Delete error log entry.
967 [Arguments] ${entry_path}
968
969 # Description of argument(s):
970 # entry_path Delete an error log entry.
971 # Ex. /xyz/openbmc_project/logging/entry/1
972
George Keishing6a8ed0f2017-07-11 22:54:42 -0500973 # Skip delete if entry URI is a callout.
974 # Example: /xyz/openbmc_project/logging/entry/1/callout
975 Return From Keyword If '${entry_path.rsplit('/', 1)[1]}' == 'callout'
976
George Keishingdb34c2f2017-04-18 13:20:25 -0500977 ${data}= Create Dictionary data=@{EMPTY}
978 ${resp}= Openbmc Delete Request ${entry_path} data=${data}
979 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Rahul Maheshwari43be6932017-05-01 02:37:06 -0500980
981
George Keishingad5817a2017-06-28 10:19:03 -0500982###############################################################################
Rahul Maheshwari43be6932017-05-01 02:37:06 -0500983Get LED State XYZ
984 [Documentation] Returns state of given LED.
985 [Arguments] ${led_name}
986 # Description of argument(s):
987 # led_name Name of LED
988
989 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
990 [Return] ${state}
Rahul Maheshwari13256d92017-06-15 10:05:40 -0500991
992
George Keishingad5817a2017-06-28 10:19:03 -0500993###############################################################################
Rahul Maheshwari13256d92017-06-15 10:05:40 -0500994Get BMC Version
995 [Documentation] Returns BMC version from /etc/os-release.
996 ... e.g. "v1.99.6-141-ge662190"
997
998 Open Connection And Log In
999 ${cmd}= Set Variable grep ^VERSION_ID= /etc/os-release | cut -f 2 -d '='
1000 ${output}= Execute Command On BMC ${cmd}
1001 [Return] ${output}
1002
George Keishingad5817a2017-06-28 10:19:03 -05001003
1004###############################################################################
1005Get Elog URL List
1006 [Documentation] Return error log entry list of URLs.
1007
1008 ${url_list}= Read Properties /xyz/openbmc_project/logging/entry/
1009 Sort List ${url_list}
1010 [Return] ${url_list}
1011
1012
1013###############################################################################