blob: 90f0cfbc6691ca783c1a6351d9d752918a425eed [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
Michael Walsh391ba9b2017-08-24 11:36:24 -05005Library String
George Keishing30c12ff2016-09-02 10:25:29 -05006Library DateTime
7Library Process
Chris Austenb29d2e82016-06-07 12:25:35 -05008Library OperatingSystem
Michael Walsha6723f22016-11-22 11:12:01 -06009Library gen_print.py
10Library gen_robot_print.py
Michael Walsh5f3f4142017-05-22 17:09:47 -050011Library gen_cmd.py
Sunil Macd110a2017-05-23 04:14:32 -050012Library gen_robot_keyword.py
Michael Walshe53e47a2017-06-30 17:03:24 -050013Library bmc_ssh_utils.py
Michael Walshfdc5ced2017-08-17 13:15:15 -050014Library utils.py
Charles Paul Hofer35816152017-10-02 11:55:11 -050015Library var_funcs.py
Chris Austenb29d2e82016-06-07 12:25:35 -050016
17*** Variables ***
Sivas SRRd97aa9c2017-05-22 11:19:25 -050018${pflash_cmd} /usr/sbin/pflash -r /dev/stdout -P VERSION
Chris Austenb29d2e82016-06-07 12:25:35 -050019${SYSTEM_SHUTDOWN_TIME} ${5}
Michael Walsha6723f22016-11-22 11:12:01 -060020${dbuscmdBase}
George Keishing85ca05e2016-11-30 09:47:18 -060021... dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host
Michael Walsha6723f22016-11-22 11:12:01 -060022${dbuscmdGet}
George Keishing9485af92017-01-04 10:21:43 -060023... ${SETTINGS_URI}host0 org.freedesktop.DBus.Properties.Get
George Keishing85ca05e2016-11-30 09:47:18 -060024# Enable when ready with openbmc/openbmc-test-automation#203
25#${dbuscmdString}= string:"xyz.openbmc_project.settings.Host" string:
Michael Walsha6723f22016-11-22 11:12:01 -060026${dbuscmdString}= string:"org.openbmc.settings.Host" string:
27
28# Assign default value to QUIET for programs which may not define it.
29${QUIET} ${0}
Sivas SRRea85d1f2016-11-13 22:44:28 -060030${bmc_mem_free_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4
31${bmc_mem_total_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2
32${bmc_cpu_usage_cmd}= top -n 1 | grep CPU: | cut -c 7-9
Sridevi Ramesh1699d372016-12-06 00:20:22 -060033${HOST_SETTING} ${SETTINGS_URI}host0
Sivas SRR352bc162017-02-13 22:12:29 -060034# /run/initramfs/ro associate filesystem should be 100% full always
Sivas SRRaca55712016-12-21 04:32:35 -060035${bmc_file_system_usage_cmd}=
Sivas SRR352bc162017-02-13 22:12:29 -060036... df -h | grep -v /run/initramfs/ro | cut -c 52-54 | grep 100 | wc -l
Chris Austenb29d2e82016-06-07 12:25:35 -050037
George Keishingcce9df22017-01-24 06:19:33 -060038${BOOT_TIME} ${0}
39${BOOT_COUNT} ${0}
Sweta Potthuri025e0122017-02-21 00:42:48 -060040${count} ${0}
Sivas SRR8254db62017-02-07 09:39:46 -060041${devicetree_base} /sys/firmware/devicetree/base/model
George Keishingcce9df22017-01-24 06:19:33 -060042
George Keishingb7c9b542017-05-23 08:19:58 -050043# Initialize default debug value to 0.
44${DEBUG} ${0}
45
Michael Walshfdc5ced2017-08-17 13:15:15 -050046# These variables are used to straddle between new and old methods of setting
47# values.
Michael Walshc972d4d2017-08-16 15:38:03 -050048${boot_prog_method} ${EMPTY}
49
Michael Walshfdc5ced2017-08-17 13:15:15 -050050${power_policy_setup} ${0}
51${bmc_power_policy_method} ${EMPTY}
52@{valid_power_policy_vars} RESTORE_LAST_STATE ALWAYS_POWER_ON
53... ALWAYS_POWER_OFF
54
Chris Austenb29d2e82016-06-07 12:25:35 -050055*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060056
Sivas SRRc0957412017-10-06 13:02:08 -050057Check BMC Performance
58 [Documentation] Check BMC basic CPU Mem File system performance.
59
60 Check BMC CPU Performance
61 Check BMC Mem Performance
62 Check BMC File System Performance
63
Sivas SRRd97aa9c2017-05-22 11:19:25 -050064Verify PNOR Update
65 [Documentation] Verify that the PNOR is not corrupted.
66 # Example:
67 # FFS: Flash header not found. Code: 100
68 # Error 100 opening ffs !
69
70 Open Connection And Log In
71 ${pnor_info}= Execute Command On BMC ${pflash_cmd}
72 Should Not Contain Any ${pnor_info} Flash header not found Error
73
Sivas SRR8254db62017-02-07 09:39:46 -060074Get BMC System Model
75 [Documentation] Get the BMC model from the device tree.
76
Michael Walshe53e47a2017-06-30 17:03:24 -050077 ${bmc_model} ${stderr} ${rc}= BMC Execute Command
George Keishing90ab1772017-02-24 05:40:55 -060078 ... cat ${devicetree_base} | cut -d " " -f 1 return_stderr=True
Sivas SRR8254db62017-02-07 09:39:46 -060079 Should Be Empty ${stderr}
80 Should Not Be Empty ${bmc_model}
81 [Return] ${bmc_model}
82
83Verify BMC System Model
84 [Documentation] Verify the BMC model with ${OPENBMC_MODEL}.
85 [Arguments] ${bmc_model}
86
87 ${tmp_bmc_model}= Fetch From Right ${OPENBMC_MODEL} /
88 ${tmp_bmc_model}= Fetch From Left ${tmp_bmc_model} .
89 ${ret}= Run Keyword And Return Status Should Contain ${bmc_model}
90 ... ${tmp_bmc_model} ignore_case=True
91 [Return] ${ret}
92
Chris Austenb29d2e82016-06-07 12:25:35 -050093Wait For Host To Ping
root442f0ef2016-08-04 20:23:05 +000094 [Arguments] ${host} ${timeout}=${OPENBMC_REBOOT_TIMEOUT}min
95 ... ${interval}=5 sec
96
97 # host The DNS name or IP of the host to ping.
98 # timeout The amount of time after which attempts to ping cease.
99 # interval The amount of time in between attempts to ping.
100
101 Wait Until Keyword Succeeds ${timeout} ${interval} Ping Host ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -0500102
103Ping Host
104 [Arguments] ${host}
George Keishing8a84f952016-08-25 04:54:53 -0500105 Should Not Be Empty ${host} msg=No host provided
Michael Walsha6723f22016-11-22 11:12:01 -0600106 ${RC} ${output}= Run and return RC and Output ping -c 4 ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -0500107 Log RC: ${RC}\nOutput:\n${output}
108 Should be equal ${RC} ${0}
109
110Get Boot Progress
Michael Walshc972d4d2017-08-16 15:38:03 -0500111 [Documentation] Get the boot progress and return it.
Michael Walsha6723f22016-11-22 11:12:01 -0600112 [Arguments] ${quiet}=${QUIET}
113
Michael Walshc972d4d2017-08-16 15:38:03 -0500114 # Description of argument(s):
115 # quiet Indicates whether this keyword should run without any output to
116 # the console.
117
118 Set Boot Progress Method
119 ${state}= Run Keyword If '${boot_prog_method}' == 'New'
120 ... New Get Boot Progress quiet=${quiet}
121 ... ELSE
122 ... Old Get Boot Progress quiet=${quiet}
123
124 [Return] ${state}
125
126Set Boot Progress Method
127 [Documentation] Set the boot_prog_method to either 'Old' or 'New'.
128
129 # The boot progress data has moved from an 'org' location to an 'xyz'
130 # location. This keyword will determine whether the new method of getting
131 # the boot progress is valid and will set the global boot_prog_method
132 # variable accordingly. If boot_prog_method is already set (either by a
133 # prior call to this function or via a -v parm), this keyword will simply
134 # return.
135
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500136 # Note: There are interim builds that contain boot_progress in both the
137 # old and the new location values. It is nearly impossible for this
138 # keyword to determine whether the old boot_progress or the new one is
139 # active. When using such builds where the old boot_progress is active,
140 # the only recourse users will have is that they may specify
141 # -v boot_prog_method:Old to force old behavior on such builds.
Michael Walshc972d4d2017-08-16 15:38:03 -0500142
143 Run Keyword If '${boot_prog_method}' != '${EMPTY}' Return From Keyword
144
145 ${new_status} ${new_value}= Run Keyword And Ignore Error
146 ... New Get Boot Progress
147 # If the new style read fails, the method must necessarily be "Old".
148 Run Keyword If '${new_status}' == 'PASS'
149 ... Run Keywords
150 ... Set Global Variable ${boot_prog_method} New AND
151 ... Rqpvars boot_prog_method AND
152 ... Return From Keyword
153
154 # Default method is "Old".
155 Set Global Variable ${boot_prog_method} Old
156 Rqpvars boot_prog_method
157
158Old Get Boot Progress
159 [Documentation] Get the boot progress the old way (via org location).
160 [Arguments] ${quiet}=${QUIET}
161
162 # Description of argument(s):
163 # quiet Indicates whether this keyword should run without any output to
164 # the console.
165
George Keishing85ca05e2016-11-30 09:47:18 -0600166 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
Michael Walsha6723f22016-11-22 11:12:01 -0600167 ... value quiet=${quiet}
Michael Walshc972d4d2017-08-16 15:38:03 -0500168
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600169 [Return] ${state}
Chris Austenb29d2e82016-06-07 12:25:35 -0500170
Michael Walshc972d4d2017-08-16 15:38:03 -0500171New Get Boot Progress
172 [Documentation] Get the boot progress the new way (via xyz location).
173 [Arguments] ${quiet}=${QUIET}
174
175 # Description of argument(s):
176 # quiet Indicates whether this keyword should run without any output to
177 # the console.
178
179 ${state}= Read Attribute ${HOST_STATE_URI} BootProgress quiet=${quiet}
180
181 [Return] ${state.rsplit('.', 1)[1]}
182
Chris Austenb29d2e82016-06-07 12:25:35 -0500183Is Power On
root442f0ef2016-08-04 20:23:05 +0000184 ${state}= Get Power State
185 Should be equal ${state} ${1}
Chris Austenb29d2e82016-06-07 12:25:35 -0500186
187Is Power Off
root442f0ef2016-08-04 20:23:05 +0000188 ${state}= Get Power State
189 Should be equal ${state} ${0}
Chris Austenb29d2e82016-06-07 12:25:35 -0500190
root442f0ef2016-08-04 20:23:05 +0000191Initiate Power On
192 [Documentation] Initiates the power on and waits until the Is Power On
193 ... keyword returns that the power state has switched to on.
Michael Walsha6723f22016-11-22 11:12:01 -0600194 [Arguments] ${wait}=${1}
195
Chris Austenb29d2e82016-06-07 12:25:35 -0500196 @{arglist}= Create List
197 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600198 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
Michael Walsha6723f22016-11-22 11:12:01 -0600199 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500200 should be equal as strings ${resp.status_code} ${HTTP_OK}
Chris Austenb29d2e82016-06-07 12:25:35 -0500201
Michael Walsha6723f22016-11-22 11:12:01 -0600202 # Does caller want to wait for power on status?
203 Run Keyword If '${wait}' == '${0}' Return From Keyword
204 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500205
root442f0ef2016-08-04 20:23:05 +0000206Initiate Power Off
207 [Documentation] Initiates the power off and waits until the Is Power Off
208 ... keyword returns that the power state has switched to off.
Chris Austenb29d2e82016-06-07 12:25:35 -0500209 @{arglist}= Create List
210 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600211 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
Michael Walsha6723f22016-11-22 11:12:01 -0600212 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500213 should be equal as strings ${resp.status_code} ${HTTP_OK}
Michael Walsha6723f22016-11-22 11:12:01 -0600214 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
Chris Austenb29d2e82016-06-07 12:25:35 -0500215
Michael Walsh81843772017-03-02 14:44:44 -0600216Initiate OS Host Power Off
217 [Documentation] Initiate an OS reboot.
218 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
219 ... ${os_password}=${OS_PASSWORD}
220
221 # Description of arguments:
222 # os_host The DNS name or IP of the OS.
223 # os_username The username to be used to sign in to the OS.
224 # os_password The password to be used to sign in to the OS.
225
Michael Walsh4549cd12017-09-07 18:02:36 -0500226 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
227 ... Set Variable shutdown
228 ... ELSE
229 ... Set Variable echo ${os_password} | sudo -S shutdown
230
231 ${output} ${stderr} ${rc}= OS Execute Command
232 ... ${cmd_buf} fork=${1}
Michael Walsh81843772017-03-02 14:44:44 -0600233
234Initiate OS Host Reboot
235 [Documentation] Initiate an OS reboot.
236 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
237 ... ${os_password}=${OS_PASSWORD}
238
Michael Walshf1a59fb2017-09-01 17:07:13 -0500239 # Description of argument(s):
240 # os_host The host name or IP address of the OS.
Michael Walsh81843772017-03-02 14:44:44 -0600241 # os_username The username to be used to sign in to the OS.
242 # os_password The password to be used to sign in to the OS.
243
Michael Walshf1a59fb2017-09-01 17:07:13 -0500244 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
245 ... Set Variable reboot
246 ... ELSE
247 ... Set Variable echo ${os_password} | sudo -S reboot
248
249 ${output} ${stderr} ${rc}= OS Execute Command
250 ... ${cmd_buf} fork=${1}
Michael Walsh81843772017-03-02 14:44:44 -0600251
252Initiate Auto Reboot
253 [Documentation] Initiate an auto reboot.
254
255 # Set the auto reboot policy.
Sweta Potthuri62a23572017-07-28 04:05:13 -0500256 Set Auto Reboot ${1}
Michael Walsh81843772017-03-02 14:44:44 -0600257 # Set the watchdog timer. Note: 5000 = milliseconds which is 5 seconds.
George Keishing37cfa6b2017-06-15 10:25:55 -0500258 Trigger Host Watchdog Error 5000
Michael Walsh81843772017-03-02 14:44:44 -0600259
Chris Austenb29d2e82016-06-07 12:25:35 -0500260Trigger Warm Reset
261 log to console "Triggering warm reset"
Michael Walsha6723f22016-11-22 11:12:01 -0600262 ${data}= create dictionary data=@{EMPTY}
George Keishing85ca05e2016-11-30 09:47:18 -0600263 ${resp}= openbmc post request
264 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
Chris Austenb29d2e82016-06-07 12:25:35 -0500265 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
George Keishingb3700812016-08-31 03:03:30 -0500266 ${session_active}= Check If warmReset is Initiated
267 Run Keyword If '${session_active}' == '${True}'
268 ... Fail msg=warm reset didn't occur
269
Chris Austenb29d2e82016-06-07 12:25:35 -0500270 Sleep ${SYSTEM_SHUTDOWN_TIME}min
Rahul Maheshwari5f253c42017-01-30 05:19:51 -0600271 Check If BMC Is Up
Michael Walsh49ab0f42016-07-20 11:44:33 -0500272
273Check OS
root442f0ef2016-08-04 20:23:05 +0000274 [Documentation] Attempts to ping the host OS and then checks that the host
275 ... OS is up by running an SSH command.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500276
277 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walsha6723f22016-11-22 11:12:01 -0600278 ... ${os_password}=${OS_PASSWORD} ${quiet}=${QUIET}
279 ... ${print_string}=${EMPTY}
Michael Walshac275512017-03-07 11:39:28 -0600280 [Teardown] SSHLibrary.Close Connection
Michael Walsh49ab0f42016-07-20 11:44:33 -0500281
282 # os_host The DNS name/IP of the OS host associated with our BMC.
283 # os_username The username to be used to sign on to the OS host.
284 # os_password The password to be used to sign on to the OS host.
Michael Walsha6723f22016-11-22 11:12:01 -0600285 # quiet Indicates whether this keyword should write to console.
286 # print_string A string to be printed before checking the OS.
287
288 rprint ${print_string}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500289
root442f0ef2016-08-04 20:23:05 +0000290 # Attempt to ping the OS. Store the return code to check later.
291 ${ping_rc}= Run Keyword and Return Status Ping Host ${os_host}
292
Michael Walshac275512017-03-07 11:39:28 -0600293 SSHLibrary.Open connection ${os_host}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500294
Michael Walsha6723f22016-11-22 11:12:01 -0600295 ${status} ${msg}= Run Keyword And Ignore Error Login ${os_username}
296 ... ${os_password}
297 ${err_msg1}= Sprint Error ${msg}
298 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
299 Run Keyword If '${status}' == 'FAIL' Fail msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500300 ${output} ${stderr} ${rc}= Execute Command uptime return_stderr=True
301 ... return_rc=True
302
Michael Walsha6723f22016-11-22 11:12:01 -0600303 ${temp_msg}= Catenate Could not execute a command on the operating
304 ... system.\n
305 ${err_msg1}= Sprint Error ${temp_msg}
306 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
307
308 # If the return code returned by "Execute Command" is non-zero, this
309 # keyword will fail.
310 Should Be Equal ${rc} ${0} msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500311 # We will likewise fail if there is any stderr data.
312 Should Be Empty ${stderr}
313
Michael Walsha6723f22016-11-22 11:12:01 -0600314 ${temp_msg}= Set Variable Could not ping the operating system.\n
315 ${err_msg1}= Sprint Error ${temp_msg}
316 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
317 # We will likewise fail if the OS did not ping, as we could SSH but not
318 # ping
319 Should Be Equal As Strings ${ping_rc} ${TRUE} msg=${err_msg}
root442f0ef2016-08-04 20:23:05 +0000320
Michael Walsh49ab0f42016-07-20 11:44:33 -0500321Wait for OS
322 [Documentation] Waits for the host OS to come up via calls to "Check OS".
323 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
324 ... ${os_password}=${OS_PASSWORD} ${timeout}=${OS_WAIT_TIMEOUT}
Michael Walsha6723f22016-11-22 11:12:01 -0600325 ... ${quiet}=${0}
326 [Teardown] rprintn
Michael Walsh49ab0f42016-07-20 11:44:33 -0500327
328 # os_host The DNS name or IP of the OS host associated with our
329 # BMC.
330 # os_username The username to be used to sign on to the OS host.
331 # os_password The password to be used to sign on to the OS host.
332 # timeout The timeout in seconds indicating how long you're
333 # willing to wait for the OS to respond.
Michael Walsha6723f22016-11-22 11:12:01 -0600334 # quiet Indicates whether this keyword should write to console.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500335
336 # The interval to be used between calls to "Check OS".
337 ${interval}= Set Variable 5
338
Michael Walsha6723f22016-11-22 11:12:01 -0600339 ${message}= Catenate Checking every ${interval} seconds for up to
340 ... ${timeout} seconds for the operating system to communicate.
341 rqprint_timen ${message}
342
Michael Walsh49ab0f42016-07-20 11:44:33 -0500343 Wait Until Keyword Succeeds ${timeout} sec ${interval} Check OS
344 ... ${os_host} ${os_username} ${os_password}
Michael Walsha6723f22016-11-22 11:12:01 -0600345 ... print_string=\#
346
347 rqprintn
348
349 rqprint_timen The operating system is now communicating.
root442f0ef2016-08-04 20:23:05 +0000350
root442f0ef2016-08-04 20:23:05 +0000351
352Get Power State
353 [Documentation] Returns the power state as an integer. Either 0 or 1.
Michael Walsha6723f22016-11-22 11:12:01 -0600354 [Arguments] ${quiet}=${QUIET}
355
root442f0ef2016-08-04 20:23:05 +0000356 @{arglist}= Create List
357 ${args}= Create Dictionary data=@{arglist}
Michael Walsha6723f22016-11-22 11:12:01 -0600358
George Keishing85ca05e2016-11-30 09:47:18 -0600359 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
Michael Walsha6723f22016-11-22 11:12:01 -0600360 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000361 Should be equal as strings ${resp.status_code} ${HTTP_OK}
362 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600363 [Return] ${content["data"]}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500364
365Clear BMC Record Log
366 [Documentation] Clears all the event logs on the BMC. This would be
367 ... equivalent to ipmitool sel clear.
368 @{arglist}= Create List
369 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600370 ${resp}= Call Method
371 ... ${OPENBMC_BASE_URI}records/events/ clear data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500372 should be equal as strings ${resp.status_code} ${HTTP_OK}
373
374Copy PNOR to BMC
375 Import Library SCPLibrary WITH NAME scp
376 Open Connection for SCP
377 Log Copying ${PNOR_IMAGE_PATH} to /tmp
378 scp.Put File ${PNOR_IMAGE_PATH} /tmp
379
380Flash PNOR
381 [Documentation] Calls flash bios update method to flash PNOR image
Gunnar Mills38032802016-12-12 13:43:40 -0600382 [Arguments] ${pnor_image}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500383 @{arglist}= Create List ${pnor_image}
384 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600385 ${resp}= Call Method ${OPENBMC_BASE_URI}control/flash/bios/ update
Michael Walsha6723f22016-11-22 11:12:01 -0600386 ... data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500387 should be equal as strings ${resp.status_code} ${HTTP_OK}
388 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
389
390Get Flash BIOS Status
391 [Documentation] Returns the status of the flash BIOS API as a string. For
392 ... example 'Flashing', 'Flash Done', etc
George Keishing85ca05e2016-11-30 09:47:18 -0600393 ${data}= Read Properties ${OPENBMC_BASE_URI}control/flash/bios
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600394 [Return] ${data['status']}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500395
396Is PNOR Flashing
397 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
398 ... flashing has started.
399 ${status}= Get Flash BIOS Status
Rahul Maheshwari449dfb72017-05-08 02:06:48 -0500400 Should Contain ${status} Flashing
Jay Azurine4c52eb2016-08-16 20:51:10 -0500401
402Is PNOR Flash Done
403 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
404 ... PNOR flashing has completed.
Leah McNutt9ba32272016-11-17 15:48:39 +0000405 ${status}= Get Flash BIOS Status
Jay Azurine4c52eb2016-08-16 20:51:10 -0500406 should be equal as strings ${status} Flash Done
407
George Keishing5e870cd2016-08-24 10:05:47 -0500408
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600409Is OS Starting
410 [Documentation] Check if boot progress is OS starting.
411 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500412 Should Be Equal ${boot_progress} OSStart
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600413
George Keishing0af24412017-03-10 13:33:23 -0600414Is OS Off
415 [Documentation] Check if boot progress is "Off".
416 ${boot_progress}= Get Boot Progress
417 Should Be Equal ${boot_progress} Off
418
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500419Get Boot Progress To OS Starting State
420 [Documentation] Get the system to a boot progress state of 'FW Progress,
421 ... Starting OS'.
422
423 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500424 Run Keyword If '${boot_progress}' == 'OSStart'
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500425 ... Log Host is already in OS starting state
426 ... ELSE
427 ... Run Keywords Initiate Host PowerOff AND Initiate Host Boot
428 ... AND Wait Until Keyword Succeeds 10 min 10 sec Is OS Starting
429
George Keishing5e870cd2016-08-24 10:05:47 -0500430Verify Ping and REST Authentication
Michael Walsha6723f22016-11-22 11:12:01 -0600431 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500432 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -0500433 Run Keyword If '${l_ping}' == '${False}'
434 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500435
Michael Walsha6723f22016-11-22 11:12:01 -0600436 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500437 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -0500438 Run Keyword If '${l_rest}' == '${False}'
439 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500440
441 # Just to make sure the SSH is working for SCP
442 Open Connection And Log In
443 ${system} ${stderr}= Execute Command hostname return_stderr=True
444 Should Be Empty ${stderr}
445
George Keishingc4d3dc02016-09-19 03:45:55 -0500446Check If BMC is Up
447 [Documentation] Wait for Host to be online. Checks every X seconds
448 ... interval for Y minutes and fails if timed out.
449 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -0600450 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -0500451 ... ${interval}=10 sec
452
453 Wait Until Keyword Succeeds
454 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
455
George Keishingb3700812016-08-31 03:03:30 -0500456
457Check If warmReset is Initiated
458 [Documentation] Ping would be still alive, so try SSH to connect
459 ... if fails the ports are down indicating reboot
460 ... is in progress
George Keishing3c05d352016-12-13 06:54:50 -0600461
462 # Warm reset adds 3 seconds delay before forcing reboot
463 # To minimize race conditions, we wait for 7 seconds
464 Sleep 7s
George Keishingb3700812016-08-31 03:03:30 -0500465 ${alive}= Run Keyword and Return Status
466 ... Open Connection And Log In
467 Return From Keyword If '${alive}' == '${False}' ${False}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600468 [Return] ${True}
George Keishingb3700812016-08-31 03:03:30 -0500469
George Keishing06ae4aa2016-08-30 01:41:28 -0500470Flush REST Sessions
471 [Documentation] Removes all the active session objects
472 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500473
Sivas SRRe1143ae2016-08-26 22:31:02 -0500474Initialize DBUS cmd
475 [Documentation] Initialize dbus string with property string to extract
Gunnar Mills38032802016-12-12 13:43:40 -0600476 [Arguments] ${boot_property}
Michael Walsha6723f22016-11-22 11:12:01 -0600477 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
478 ${cmd}= Catenate ${cmd}${boot_property}
Sivas SRRe1143ae2016-08-26 22:31:02 -0500479 Set Global Variable ${dbuscmd} ${cmd}
480
David Shawba2d2c22017-01-23 16:56:38 -0600481Create OS Console File Path
482 [Documentation] Create OS console file path name and return it.
483 [Arguments] ${log_file_path}=${EMPTY}
George Keishing30c12ff2016-09-02 10:25:29 -0500484
David Shawba2d2c22017-01-23 16:56:38 -0600485 # Description of arguements:
486 # file_path The caller's candidate value. If this value is ${EMPTY}, this
487 # keyword will compose a file path name. Otherwise, this
488 # keyword will use the caller's file_path value. In either
489 # case, the value will be returned.
Gunnar Mills9c760342016-12-08 10:12:06 -0600490
George Keishing3deb7d12017-09-14 07:50:00 -0500491 ${default_file_path}= Catenate /tmp/${OPENBMC_HOST}_os_console.txt
David Shawba2d2c22017-01-23 16:56:38 -0600492 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
493 ... ${default_file_path} ${log_file_path}
Michael Walsh01bd3682017-01-10 11:21:05 -0600494
David Shawba2d2c22017-01-23 16:56:38 -0600495 [Return] ${log_file_path}
Gunnar Mills9c760342016-12-08 10:12:06 -0600496
David Shawba2d2c22017-01-23 16:56:38 -0600497Create OS Console Command String
498 [Documentation] Return a command string to start OS console logging.
Gunnar Mills9c760342016-12-08 10:12:06 -0600499
David Shawba2d2c22017-01-23 16:56:38 -0600500 # First make sure that the ssh_pw program is available.
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500501 ${cmd_buf}= Catenate which ssh_pw 2>/dev/null || find ${EXECDIR} -name 'ssh_pw'
David Shawba2d2c22017-01-23 16:56:38 -0600502 Rdpissuing ${cmd_buf}
503 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
504 Rdpvars rc output
Gunnar Mills9c760342016-12-08 10:12:06 -0600505
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500506 Should Be Equal As Integers 0 ${rc} msg=Could not find ssh_pw.
507
508 ${ssh_pw_file_path}= Set Variable ${output}
George Keishingb45d9522017-06-29 04:20:59 -0500509
510 ${cmd_buf}= Catenate ${ssh_pw_file_path} ${OPENBMC_PASSWORD} -p 2200
George Keishing1f9ec7f2017-06-06 08:59:19 -0500511 ... -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST}
George Keishing30c12ff2016-09-02 10:25:29 -0500512
David Shawba2d2c22017-01-23 16:56:38 -0600513 [Return] ${cmd_buf}
George Keishing30c12ff2016-09-02 10:25:29 -0500514
Michael Walshcadf1342017-08-28 13:49:25 -0500515Get SOL Console Pid
516 [Documentation] Get the pid of the active sol conole job.
517
518 # Find the pid of the active system console logging session (if any).
519 ${search_string}= Create OS Console Command String
520 # At least in some cases, ps output does not show double quotes so we must
521 # replace them in our search string with the regexes to indicate that they
522 # are optional.
523 ${search_string}= Replace String ${search_string} " ["]?
524 ${cmd_buf}= Catenate echo $(ps -ef | egrep '${search_string}'
525 ... | egrep -v grep | cut -c10-14)
526 Rdpissuing ${cmd_buf}
527 ${rc} ${os_con_pid}= Run And Return Rc And Output ${cmd_buf}
528 Rdpvars os_con_pid
529 # If rc is not zero it just means that there is no OS Console process
530 # running.
531
532 [Return] ${os_con_pid}
533
534
George Keishing30c12ff2016-09-02 10:25:29 -0500535Stop SOL Console Logging
David Shawba2d2c22017-01-23 16:56:38 -0600536 [Documentation] Stop system console logging and return log output.
George Keishing72992e42017-06-16 06:42:36 -0500537 [Arguments] ${log_file_path}=${EMPTY}
538 ... ${targ_file_path}=${EXECDIR}${/}logs${/}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500539 ... ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600540
541 # If there are muliple system console processes, they will all be stopped.
542 # If there is no existing log file this keyword will return an error
543 # message to that effect (and write that message to targ_file_path, if
544 # specified).
545 # NOTE: This keyword will not fail if there is no running system console
546 # process.
Michael Walsh01bd3682017-01-10 11:21:05 -0600547
548 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600549 # log_file_path The file path that was used to call "Start SOL
550 # Console Logging". See that keyword (above) for details.
551 # targ_file_path If specified, the file path to which the source
552 # file path (i.e. "log_file_path") should be copied.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500553 # return_data If this is set to ${1}, this keyword will return the SOL
554 # data to the caller as a unicode string.
George Keishing30c12ff2016-09-02 10:25:29 -0500555
David Shawba2d2c22017-01-23 16:56:38 -0600556 ${log_file_path}= Create OS Console File Path ${log_file_path}
Michael Walshcadf1342017-08-28 13:49:25 -0500557
558 ${os_con_pid}= Get SOL Console Pid
George Keishing30c12ff2016-09-02 10:25:29 -0500559
David Shawba2d2c22017-01-23 16:56:38 -0600560 ${cmd_buf}= Catenate kill -9 ${os_con_pid}
561 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpissuing ${cmd_buf}
562 ${rc} ${output}= Run Keyword If '${os_con_pid}' != '${EMPTY}'
563 ... Run And Return Rc And Output ${cmd_buf}
564 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpvars rc output
George Keishing30c12ff2016-09-02 10:25:29 -0500565
Michael Walsh01bd3682017-01-10 11:21:05 -0600566 Run Keyword If '${targ_file_path}' != '${EMPTY}'
David Shawba2d2c22017-01-23 16:56:38 -0600567 ... Run Keyword And Ignore Error
568 ... Copy File ${log_file_path} ${targ_file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500569
Michael Walsh5f3f4142017-05-22 17:09:47 -0500570 ${output}= Set Variable ${EMPTY}
571 ${loc_quiet}= Evaluate ${debug}^1
572 ${rc} ${output}= Run Keyword If '${return_data}' == '${1}'
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500573 ... Cmd Fnc cat ${log_file_path} 2>/dev/null quiet=${loc_quiet}
574 ... print_output=${0} show_err=${0}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500575
David Shawba2d2c22017-01-23 16:56:38 -0600576 [Return] ${output}
577
578Start SOL Console Logging
579 [Documentation] Start system console log to file.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500580 [Arguments] ${log_file_path}=${EMPTY} ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600581
582 # This keyword will first call "Stop SOL Console Logging". Only then will
583 # it start SOL console logging. The data returned by "Stop SOL Console
584 # Logging" will in turn be returned by this keyword.
585
586 # Description of arguments:
Michael Walsh5f3f4142017-05-22 17:09:47 -0500587 # log_file_path The file path to which system console log data should be
588 # written. Note that this path is taken to be a location
589 # on the machine where this program is running rather than
590 # on the Open BMC system.
591 # return_data If this is set to ${1}, this keyword will return any SOL
592 # data to the caller as a unicode string.
David Shawba2d2c22017-01-23 16:56:38 -0600593
594 ${log_file_path}= Create OS Console File Path ${log_file_path}
595
596 ${log_output}= Stop SOL Console Logging ${log_file_path}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500597 ... return_data=${return_data}
David Shawba2d2c22017-01-23 16:56:38 -0600598
599 # Validate by making sure we can create the file. Problems creating the
600 # file would not be noticed by the subsequent ssh command because we fork
601 # the command.
602 Create File ${log_file_path}
603 ${sub_cmd_buf}= Create OS Console Command String
604 # Routing stderr to stdout so that any startup error text will go to the
605 # output file.
George Keishing8c3c1df2017-09-13 13:50:20 -0500606 # TODO: Doesn't work with tox so reverting temporarily.
Michael Walsh460042e2017-09-05 16:55:49 -0500607 # nohup detaches the process completely from our pty.
George Keishing8c3c1df2017-09-13 13:50:20 -0500608 #${cmd_buf}= Catenate nohup ${sub_cmd_buf} &> ${log_file_path} &
609 ${cmd_buf}= Catenate ${sub_cmd_buf} > ${log_file_path} 2>&1 &
David Shawba2d2c22017-01-23 16:56:38 -0600610 Rdpissuing ${cmd_buf}
611 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
612 # Because we are forking this command, we essentially will never get a
613 # non-zero return code or any output.
614 Should Be Equal ${rc} ${0}
615
Michael Walshcadf1342017-08-28 13:49:25 -0500616 Sleep 1
617 ${os_con_pid}= Get SOL Console Pid
618
619 Should Not Be Empty ${os_con_pid}
620
David Shawba2d2c22017-01-23 16:56:38 -0600621 [Return] ${log_output}
George Keishing30c12ff2016-09-02 10:25:29 -0500622
623Get Time Stamp
624 [Documentation] Get the current time stamp data
625 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500626 [Return] ${cur_time}
George Keishing30c12ff2016-09-02 10:25:29 -0500627
George Keishing1b150202016-09-29 08:51:58 -0500628
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500629Start Journal Log
630 [Documentation] Start capturing journal log to a file in /tmp using
631 ... journalctl command. By default journal log is collected
632 ... at /tmp/journal_log else user input location.
633 ... The File is appended with datetime.
634 [Arguments] ${file_path}=/tmp/journal_log
635
636 Open Connection And Log In
637
638 ${cur_time}= Get Time Stamp
639 Set Global Variable ${LOG_TIME} ${cur_time}
640 Start Command
641 ... journalctl -f > ${file_path}-${LOG_TIME}
642 Log Journal Log Started: ${file_path}-${LOG_TIME}
643
David Shawba2d2c22017-01-23 16:56:38 -0600644
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500645Stop Journal Log
646 [Documentation] Stop journalctl process if its running.
647 ... By default return log from /tmp/journal_log else
648 ... user input location.
649 [Arguments] ${file_path}=/tmp/journal_log
650
651 Open Connection And Log In
652
653 ${rc}=
654 ... Execute Command
655 ... ps ax | grep journalctl | grep -v grep
656 ... return_stdout=False return_rc=True
657
658 Return From Keyword If '${rc}' == '${1}'
659 ... No journal log process running
660
661 ${output} ${stderr}=
662 ... Execute Command killall journalctl
663 ... return_stderr=True
664 Should Be Empty ${stderr}
665
666 ${journal_log} ${stderr}=
667 ... Execute Command
668 ... cat ${file_path}-${LOG_TIME}
669 ... return_stderr=True
670 Should Be Empty ${stderr}
671
672 Log ${journal_log}
673
674 Execute Command rm ${file_path}-${LOG_TIME}
675
676 [Return] ${journal_log}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500677
678Mac Address To Hex String
679 [Documentation] Converts MAC address into hex format.
680 ... Example
681 ... Given the following MAC: 00:01:6C:80:02:78
682 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
683 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600684 ... i_macaddress MAC address in the following format
685 ... 00:01:6C:80:02:78
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500686 [Arguments] ${i_macaddress}
687
688 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600689 [Return] ${mac_hex}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500690
691IP Address To Hex String
692 [Documentation] Converts IP address into hex format.
693 ... Example:
694 ... Given the following IP: 10.3.164.100
695 ... This keyword will return: 0xa 0x3 0xa4 0xa0
696 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600697 ... i_ipaddress IP address in the following format
698 ... 10.10.10.10
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500699 [Arguments] ${i_ipaddress}
700
701 @{ip}= Split String ${i_ipaddress} .
702 ${index}= Set Variable ${0}
703
704 :FOR ${item} IN @{ip}
705 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes
706 \ Set List Value ${ip} ${index} ${hex}
707 \ ${index}= Set Variable ${index + 1}
708 ${ip_hex}= Catenate @{ip}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600709 [Return] ${ip_hex}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600710
711BMC CPU Performance Check
712 [Documentation] Minimal 10% of proc should be free in this instance
713
714 ${bmc_cpu_usage_output} ${stderr}= Execute Command ${bmc_cpu_usage_cmd}
715 ... return_stderr=True
716 Should be empty ${stderr}
717 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} %
718 Should be true ${bmc_cpu_percentage} < 90
719
720BMC Mem Performance Check
721 [Documentation] Minimal 10% of memory should be free in this instance
722
723 ${bmc_mem_free_output} ${stderr}= Execute Command ${bmc_mem_free_cmd}
724 ... return_stderr=True
725 Should be empty ${stderr}
726
727 ${bmc_mem_total_output} ${stderr}= Execute Command ${bmc_mem_total_cmd}
728 ... return_stderr=True
729 Should be empty ${stderr}
730
731 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100
732 ${bmc_mem_percentage}= Evaluate
733 ... ${bmc_mem_percentage}/${bmc_mem_total_output}
734 Should be true ${bmc_mem_percentage} > 10
735
Sivas SRRaca55712016-12-21 04:32:35 -0600736BMC File System Usage Check
Sivas SRRc0957412017-10-06 13:02:08 -0500737 [Documentation] Check the file system space. 4 file system should be
738 ... 100% full which is expected
739 # Filesystem Size Used Available Use% Mounted on
740 # /dev/root 14.4M 14.4M 0 100% /
741 # /dev/ubiblock0_0 14.4M 14.4M 0 100% /media/rofs-c9249b0e
742 # /dev/ubiblock8_0 19.6M 19.6M 0 100% /media/pnor-ro-8764baa3
743 # /dev/ubiblock4_0 14.4M 14.4M 0 100% /media/rofs-407816c
Sivas SRRaca55712016-12-21 04:32:35 -0600744 ${bmc_fs_usage_output} ${stderr}= Execute Command
745 ... ${bmc_file_system_usage_cmd} return_stderr=True
746 Should Be Empty ${stderr}
Sivas SRRc0957412017-10-06 13:02:08 -0500747 Should Be True ${bmc_fs_usage_output}==4
Sivas SRRaca55712016-12-21 04:32:35 -0600748
Sivas SRRea85d1f2016-11-13 22:44:28 -0600749Check BMC CPU Performance
750 [Documentation] Minimal 10% of proc should be free in 3 sample
751 :FOR ${var} IN Range 1 4
752 \ BMC CPU Performance check
753
754Check BMC Mem Performance
755 [Documentation] Minimal 10% of memory should be free
756
757 :FOR ${var} IN Range 1 4
758 \ BMC Mem Performance check
759
Sivas SRRaca55712016-12-21 04:32:35 -0600760Check BMC File System Performance
761 [Documentation] Check for file system usage for 4 times
762
763 :FOR ${var} IN Range 1 4
764 \ BMC File System Usage check
765
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500766Get URL List
767 [Documentation] Return list of URLs under given URL.
768 [Arguments] ${openbmc_url}
769 # Description of argument(s):
Michael Walsh5f3f4142017-05-22 17:09:47 -0500770 # openbmc_url URL for list operation (e.g.
771 # /xyz/openbmc_project/inventory).
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500772
George Keishing335f5362017-06-30 15:11:20 -0500773 ${url_list}= Read Properties ${openbmc_url}/list quiet=${1}
George Keishing184a89a2017-06-27 07:12:16 -0500774 Sort List ${url_list}
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500775 [Return] ${url_list}
776
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600777Get Endpoint Paths
778 [Documentation] Returns all url paths ending with given endpoint
779 ... Example:
780 ... Given the following endpoint: cpu
Michael Walsh01bd3682017-01-10 11:21:05 -0600781 ... This keyword will return: list of all urls ending with
782 ... cpu -
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600783 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
784 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
785 ... Description of arguments:
786 ... path URL path for enumeration
787 ... endpoint string for which url path ending
788 [Arguments] ${path} ${endpoint}
789
790 ${resp}= Read Properties ${path}/enumerate timeout=30
791 log Dictionary ${resp}
792
793 ${list}= Get Dictionary Keys ${resp}
794 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9]*$
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600795 [Return] ${resp}
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500796
797Check Zombie Process
798 [Documentation] Check if any defunct process exist or not on BMC
Michael Walsh01bd3682017-01-10 11:21:05 -0600799 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500800 ... return_stderr=True return_rc=True
801 Should Be True ${count}==0
802 Should Be Empty ${stderr}
George Keishing5327d012016-12-08 08:43:29 -0600803
804Prune Journal Log
805 [Documentation] Prune archived journal logs.
806 [Arguments] ${vacuum_size}=1M
807
808 # This keyword can be used to prevent the journal
809 # log from filling up the /run filesystem.
810 # This command will retain only the latest logs
811 # of the user specified size.
812
813 Open Connection And Log In
814 ${output} ${stderr} ${rc}=
815 ... Execute Command
816 ... journalctl --vacuum-size=${vacuum_size}
817 ... return_stderr=True return_rc=True
818
819 Should Be Equal ${rc} ${0} msg=${stderr}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600820
821Set BMC Power Policy
822 [Documentation] Set the given BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -0500823 [Arguments] ${policy}
824
825 # Note that this function will translate the old style "RESTORE_LAST_STATE"
826 # policy to the new style "xyz.openbmc_project.Control.Power.RestorePolicy.
827 # Policy.Restore" for you.
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600828
George Keishing1c3a9662017-08-11 10:16:36 -0500829 # Description of argument(s):
Michael Walshfdc5ced2017-08-17 13:15:15 -0500830 # policy Power restore policy (e.g "RESTORE_LAST_STATE",
831 # ${RESTORE_LAST_STATE}).
832
833 # Set the bmc_power_policy_method to either 'Old' or 'New'.
834 Set Power Policy Method
835 # This translation helps bridge between old and new method for calling.
836 ${policy}= Translate Power Policy Value ${policy}
837 # Run the appropriate keyword.
838 Run Key ${bmc_power_policy_method} Set Power Policy \ ${policy}
839 ${currentPolicy}= Get System Power Policy
840 Should Be Equal ${currentPolicy} ${policy}
841
842New Set Power Policy
843 [Documentation] Set the given BMC power policy (new method).
844 [Arguments] ${policy}
845
846 # Description of argument(s):
847 # policy Power restore policy (e.g. ${RESTORE_LAST_STATE}).
George Keishing1c3a9662017-08-11 10:16:36 -0500848
849 ${valueDict}= Create Dictionary data=${policy}
850 Write Attribute
Michael Walshfdc5ced2017-08-17 13:15:15 -0500851 ... ${POWER_RESTORE_URI} PowerRestorePolicy data=${valueDict}
852
853Old Set Power Policy
854 [Documentation] Set the given BMC power policy (old method).
855 [Arguments] ${policy}
856
857 # Description of argument(s):
858 # policy Power restore policy (e.g. "RESTORE_LAST_STATE").
859
860 ${valueDict}= create dictionary data=${policy}
861 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
George Keishingcce9df22017-01-24 06:19:33 -0600862
George Keishing4d6f3d62017-02-06 09:50:41 -0600863Get System Power Policy
864 [Documentation] Get the BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -0500865
866 # Set the bmc_power_policy_method to either 'Old' or 'New'.
867 Set Power Policy Method
868 ${cmd_buf}= Create List ${bmc_power_policy_method} Get Power Policy
869 # Run the appropriate keyword.
870 ${currentPolicy}= Run Keyword @{cmd_buf}
871 [Return] ${currentPolicy}
872
873New Get Power Policy
874 [Documentation] Get the BMC power policy (new method).
George Keishing1c3a9662017-08-11 10:16:36 -0500875 ${currentPolicy}= Read Attribute ${POWER_RESTORE_URI} PowerRestorePolicy
George Keishing4d6f3d62017-02-06 09:50:41 -0600876 [Return] ${currentPolicy}
George Keishingcce9df22017-01-24 06:19:33 -0600877
Michael Walshfdc5ced2017-08-17 13:15:15 -0500878Old Get Power Policy
879 [Documentation] Get the BMC power policy (old method).
880 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
881 [Return] ${currentPolicy}
882
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600883Get Auto Reboot
884 [Documentation] Returns auto reboot setting.
Sweta Potthuri62a23572017-07-28 04:05:13 -0500885 ${setting}= Read Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600886 [Return] ${setting}
887
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600888Set Auto Reboot
889 [Documentation] Set the given auto reboot setting.
890 [Arguments] ${setting}
Sweta Potthuri62a23572017-07-28 04:05:13 -0500891 # setting auto reboot's setting, i.e. 1 for enabling and 0 for disabling.
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600892
893 ${valueDict}= Set Variable ${setting}
894 ${data}= Create Dictionary data=${valueDict}
Sweta Potthuri62a23572017-07-28 04:05:13 -0500895 Write Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot data=${data}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600896 ${current_setting}= Get Auto Reboot
Sweta Potthuri62a23572017-07-28 04:05:13 -0500897 Should Be Equal As Integers ${current_setting} ${setting}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600898
899
George Keishingcce9df22017-01-24 06:19:33 -0600900Set BMC Reset Reference Time
901 [Documentation] Set current boot time as a reference and increment
George Keishing80dd5af2017-02-08 07:01:25 -0600902 ... boot count.
George Keishingcce9df22017-01-24 06:19:33 -0600903
904 ${cur_btime}= Get BMC Boot Time
George Keishing80dd5af2017-02-08 07:01:25 -0600905 Run Keyword If ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
George Keishingcce9df22017-01-24 06:19:33 -0600906 ... Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishing80dd5af2017-02-08 07:01:25 -0600907 ... ELSE IF ${cur_btime} > ${BOOT_TIME}
908 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishingcce9df22017-01-24 06:19:33 -0600909 ... AND
910 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
911
George Keishingcce9df22017-01-24 06:19:33 -0600912Get BMC Boot Time
913 [Documentation] Get boot time from /proc/stat.
914
915 Open Connection And Log In
916 ${output} ${stderr}=
917 ... Execute Command egrep '^btime ' /proc/stat | cut -f 2 -d ' '
918 ... return_stderr=True
919 Should Be Empty ${stderr}
920 ${btime}= Convert To Integer ${output}
921 [Return] ${btime}
George Keishingede30002017-02-02 09:33:07 -0600922
George Keishingede30002017-02-02 09:33:07 -0600923Execute Command On BMC
924 [Documentation] Execute given command on BMC and return output.
925 [Arguments] ${command}
926 ${stdout} ${stderr}= Execute Command ${command} return_stderr=True
927 Should Be Empty ${stderr}
928 [Return] ${stdout}
David Shawba2d2c22017-01-23 16:56:38 -0600929
Sridevi Rameshea36b412017-03-09 04:08:02 -0600930
George Keishing7a520222017-02-27 09:44:30 -0600931Enable Core Dump On BMC
932 [Documentation] Enable core dump collection.
933 Open Connection And Log In
934 ${core_pattern}= Execute Command On BMC
935 ... echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
936 Should Be Equal As Strings ${core_pattern} /tmp/core_%e.%p
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600937
Sivas SRR01262bd2017-03-19 10:00:23 -0500938Get Number Of BMC Core Dump Files
939 [Documentation] Get number of core dump files on BMC.
940 Open Connection And Log In
941 ${num_of_core_dump}= Execute Command
942 ... ls /tmp/core* 2>/dev/null | wc -l
943 [Return] ${num_of_core_dump}
944
945Set Core Dump File Size Unlimited
946 [Documentation] Set core dump file size to unlimited.
947 Open Connection And Log In
948 Execute Command On BMC
949 ... ulimit -c unlimited
950
951Check For Core Dumps
952 [Documentation] Check for any core dumps exist.
953 ${output}= Get Number Of BMC Core Dump Files
954 Run Keyword If ${output} > 0
955 ... Log **Warning** BMC core dump files exist level=WARN
956
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600957Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -0500958 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600959 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Michael Walshb5839d02017-04-12 16:11:20 -0500960 # Description of argument(s):
961 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
962 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600963 # sleep_time Time delay for host watchdog error to get injected.
964 # Default is 5 seconds.
965
George Keishing37cfa6b2017-06-15 10:25:55 -0500966 ${data}= Create Dictionary data=${True}
967 Write Attribute /xyz/openbmc_project/watchdog/host0 Enabled data=${data}
968
969 ${data}= Create Dictionary data=${milliseconds}
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500970 Write Attribute /xyz/openbmc_project/watchdog/host0 TimeRemaining
971 ... data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -0500972
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600973 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500974
975Login To OS Host
976 [Documentation] Login to OS Host.
977 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
978 ... ${os_password}=${OS_PASSWORD}
979 # Desription of arguments:
980 # ${os_host} IP address of the OS Host.
981 # ${os_username} OS Host Login user name.
982 # ${os_password} OS Host Login passwrd.
983
984 ${os_state}= Run Keyword And Return Status Ping Host ${os_host}
985 Run Keyword If '${os_state}' == 'False'
986 ... Run Keywords Initiate Host Reboot AND
987 ... Is Host Running AND
988 ... Wait for OS ${os_host} ${os_username} ${os_password}
989
George Keishing3f223b82017-06-28 03:50:35 -0500990 SSHLibrary.Open Connection ${os_host}
Sridevi Rameshea36b412017-03-09 04:08:02 -0600991 ${resp}= Login ${os_username} ${os_password}
992 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -0500993
994Configure Initial Settings
995 [Documentation] Restore old IP and route.
996 ... This keyword requires initial settings viz IP address,
997 ... Network Mask, default gatway and serial console IP and port
998 ... information which should be provided in command line.
999
Michael Walshb5839d02017-04-12 16:11:20 -05001000 [Arguments] ${host}=${OPENBMC_HOST} ${mask}=${NET_MASK}
1001 ... ${gw_ip}=${GW_IP}
Prashanth Katti884ee062017-03-16 05:05:03 -05001002
Michael Walshb5839d02017-04-12 16:11:20 -05001003 # Open telnet connection and ignore the error, in case telnet session is
1004 # already opened by the program calling this keyword.
Prashanth Katti884ee062017-03-16 05:05:03 -05001005
1006 Run Keyword And Ignore Error Open Telnet Connection to BMC Serial Console
1007 Telnet.write ifconfig eth0 ${host} netmask ${mask}
1008 Telnet.write route add default gw ${gw_ip}
George Keishingd05b1082017-03-24 05:27:32 -05001009
1010Install Debug Tarball On BMC
George Keishing55441822017-05-18 14:17:59 -05001011 [Documentation] Copy the debug tar file to BMC and install.
1012 [Arguments] ${tarball_file_path}=${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz
George Keishing5591d332017-09-05 12:57:17 -05001013 ... ${targ_tarball_dir_path}=/tmp/tarball/
George Keishingd05b1082017-03-24 05:27:32 -05001014
George Keishing55441822017-05-18 14:17:59 -05001015 # Description of arguments:
1016 # tarball_file_path Path of the debug tarball file.
1017 # The tar file is downloaded from the build page
1018 # https://openpower.xyz/job/openbmc-build/
1019 # obmc-phosphor-debug-tarball-witherspoon.tar.xz
1020 #
1021 # targ_tarball_dir_path The directory path where the tarball is to be
1022 # installed.
1023
1024 OperatingSystem.File Should Exist ${tarball_file_path}
1025 ... msg=${tarball_file_path} doesn't exist.
1026
1027 # Upload the file to BMC.
George Keishingd05b1082017-03-24 05:27:32 -05001028 Import Library SCPLibrary WITH NAME scp
1029 Open Connection for SCP
George Keishing55441822017-05-18 14:17:59 -05001030 scp.Put File ${tarball_file_path} /tmp/debug-tarball.tar.xz
1031
1032 # Create tarball directory and install.
George Keishing95c371a2017-09-14 15:42:33 -05001033 BMC Execute Command mkdir -p ${targ_tarball_dir_path}
1034 BMC Execute Command
George Keishing55441822017-05-18 14:17:59 -05001035 ... tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path}
1036
George Keishing95c371a2017-09-14 15:42:33 -05001037 # Remove the tarball file from BMC.
1038 BMC Execute Command rm -f /tmp/debug-tarball.tar.xz
George Keishingd05b1082017-03-24 05:27:32 -05001039
George Keishing55441822017-05-18 14:17:59 -05001040
Sweta Potthuri025e0122017-02-21 00:42:48 -06001041Get BMC Boot Count
1042 [Documentation] Get BMC boot count based on boot time.
1043 ${cur_btime}= Get BMC Boot Time
1044
1045 # Set global variable BOOT_TIME to current boot time if current boot time
1046 # is changed. Also increase value of global variable BOOT_COUNT by 1.
1047 Run Keyword If ${cur_btime} > ${BOOT_TIME}
1048 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
1049 ... AND
1050 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
1051 [Return] ${BOOT_COUNT}
1052
1053Set BMC Boot Count
1054 [Documentation] Set BMC boot count to given value.
1055 [Arguments] ${count}
1056
1057 # Description of arguments:
1058 # count boot count value.
1059 ${cur_btime}= Get BMC Boot Time
1060
1061 # Set global variable BOOT_COUNT to given value.
1062 Set Global Variable ${BOOT_COUNT} ${count}
1063
1064 # Set BOOT_TIME variable to current boot time.
1065 Set Global Variable ${BOOT_COUNT} ${count}
Michael Walsh689fbbe2017-04-04 17:58:03 -05001066
Sweta Potthurie5a9fc72017-05-03 07:02:46 -05001067Get System LED State
1068 [Documentation] Return the state of given system LED.
1069 [Arguments] ${led_name}
1070
1071 # Description of argument(s):
1072 # led_name System LED name (e.g. heartbeat, identify, beep).
1073
1074 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State
1075 [Return] ${state.rsplit('.', 1)[1]}
1076
George Keishing3987a1e2017-09-20 09:13:02 -05001077
George Keishingd2d90af2017-06-27 08:17:34 -05001078Delete Error Logs
Michael Walsh689fbbe2017-04-04 17:58:03 -05001079 [Documentation] Delete error logs.
1080
George Keishingd2d90af2017-06-27 08:17:34 -05001081 # Check if error logs entries exist, if not return.
George Keishing335f5362017-06-30 15:11:20 -05001082 ${resp}= OpenBMC Get Request ${BMC_LOGGING_ENTRY}${/}list quiet=${1}
George Keishingd2d90af2017-06-27 08:17:34 -05001083 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND}
1084
1085 # Get the list of error logs entries and delete them all.
George Keishing335f5362017-06-30 15:11:20 -05001086 ${elog_entries}= Get URL List ${BMC_LOGGING_ENTRY}
George Keishingd2d90af2017-06-27 08:17:34 -05001087 :FOR ${entry} IN @{elog_entries}
1088 \ Delete Error Log Entry ${entry}
George Keishingdb34c2f2017-04-18 13:20:25 -05001089
George Keishing3987a1e2017-09-20 09:13:02 -05001090
George Keishingd2d90af2017-06-27 08:17:34 -05001091Delete Error Log Entry
George Keishingdb34c2f2017-04-18 13:20:25 -05001092 [Documentation] Delete error log entry.
1093 [Arguments] ${entry_path}
1094
1095 # Description of argument(s):
1096 # entry_path Delete an error log entry.
1097 # Ex. /xyz/openbmc_project/logging/entry/1
1098
George Keishing6a8ed0f2017-07-11 22:54:42 -05001099 # Skip delete if entry URI is a callout.
1100 # Example: /xyz/openbmc_project/logging/entry/1/callout
1101 Return From Keyword If '${entry_path.rsplit('/', 1)[1]}' == 'callout'
1102
George Keishingdb34c2f2017-04-18 13:20:25 -05001103 ${data}= Create Dictionary data=@{EMPTY}
1104 ${resp}= Openbmc Delete Request ${entry_path} data=${data}
1105 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Rahul Maheshwari43be6932017-05-01 02:37:06 -05001106
1107
George Keishingcc71c3c2017-09-20 09:38:03 -05001108Delete All Error Logs
George Keishing3987a1e2017-09-20 09:13:02 -05001109 [Documentation] Delete all error log entries using "DeleteAll" interface.
1110
1111 ${data}= Create Dictionary data=@{EMPTY}
1112 ${resp}= Openbmc Post Request ${BMC_LOGGING_URI}action/DeleteAll
1113 ... data=${data}
1114 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
1115
1116
Rahul Maheshwari43be6932017-05-01 02:37:06 -05001117Get LED State XYZ
1118 [Documentation] Returns state of given LED.
1119 [Arguments] ${led_name}
1120 # Description of argument(s):
1121 # led_name Name of LED
1122
1123 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
1124 [Return] ${state}
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001125
1126
1127Get BMC Version
1128 [Documentation] Returns BMC version from /etc/os-release.
1129 ... e.g. "v1.99.6-141-ge662190"
1130
1131 Open Connection And Log In
1132 ${cmd}= Set Variable grep ^VERSION_ID= /etc/os-release | cut -f 2 -d '='
1133 ${output}= Execute Command On BMC ${cmd}
1134 [Return] ${output}
1135
George Keishingad5817a2017-06-28 10:19:03 -05001136
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -05001137Get PNOR Version
1138 [Documentation] Get the PNOR version from the BMC.
1139
1140 ${pnor_attrs}= Get PNOR Attributes
1141 [Return] ${pnor_attrs['version']}
1142
1143
1144Get PNOR Attributes
1145 [Documentation] Return PNOR software attributes as a dictionary.
1146
Michael Walsh98d8c9e2017-10-04 12:24:29 -05001147 # This keyword parses /var/lib/phosphor-software-manager/pnor/ro/pnor.toc
1148 # into key/value pairs.
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -05001149
1150 ${outbuf} ${stderr} ${rc}= BMC Execute Command
1151 ... cat /var/lib/phosphor-software-manager/pnor/ro/pnor.toc
1152 ${pnor_attrs}= Key Value Outbuf To Dict ${outbuf} delim==
1153
1154 [Return] ${pnor_attrs}
1155
1156
George Keishingad5817a2017-06-28 10:19:03 -05001157Get Elog URL List
1158 [Documentation] Return error log entry list of URLs.
1159
1160 ${url_list}= Read Properties /xyz/openbmc_project/logging/entry/
1161 Sort List ${url_list}
1162 [Return] ${url_list}
1163
1164
Steven Sombaraaf72c42017-09-05 12:02:00 -05001165Read Turbo Setting Via REST
1166 [Documentation] Return turbo setting via REST.
1167
1168 ${resp}= OpenBMC Get Request ${SENSORS_URI}host/TurboAllowed
1169 ${jsondata}= To JSON ${resp.content}
1170 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
1171 [Return] ${jsondata["data"]["value"]}
1172
1173
Steven Sombaraaf72c42017-09-05 12:02:00 -05001174Set Turbo Setting Via REST
1175 [Documentation] Set turbo setting via REST.
1176 [Arguments] ${setting}
1177 # Description of argument(s):
1178 # setting Value which needs to be set.(i.e. False or True)
1179
1180 ${valueDict}= Create Dictionary data=${setting}
1181 Write Attribute ${SENSORS_URI}host/TurboAllowed value data=${valueDict}