blob: 9f15be557b0f0494df33f81c97dd12c2c08b3170 [file] [log] [blame]
Chris Austenb29d2e82016-06-07 12:25:35 -05001*** Settings ***
Steven Sombar0acb3412018-01-24 09:38:42 -06002
Steven Sombarf60cbcf2018-12-07 08:12:18 -06003Documentation Utilities for Robot keywords that use REST.
Steven Sombar0acb3412018-01-24 09:38:42 -06004
Sandhya Somashekar839a0c22019-01-31 05:05:43 -06005Resource ../lib/resource.robot
Chris Austenb29d2e82016-06-07 12:25:35 -05006Resource ../lib/rest_client.robot
George Keishing5e870cd2016-08-24 10:05:47 -05007Resource ../lib/connection_client.robot
Rahul Maheshwarid1f45f22018-10-26 05:16:39 -05008Resource ../lib/boot_utils.robot
Steven Sombarf60cbcf2018-12-07 08:12:18 -06009Resource ../lib/common_utils.robot
George Keishingc0701102021-09-30 12:12:04 -050010Resource ../lib/bmc_redfish_utils.robot
Michael Walsh391ba9b2017-08-24 11:36:24 -050011Library String
George Keishing30c12ff2016-09-02 10:25:29 -050012Library DateTime
13Library Process
Chris Austenb29d2e82016-06-07 12:25:35 -050014Library OperatingSystem
Michael Walsha6723f22016-11-22 11:12:01 -060015Library gen_print.py
Steven Sombaraaaab222018-12-19 13:16:23 -060016Library gen_misc.py
Michael Walsha6723f22016-11-22 11:12:01 -060017Library gen_robot_print.py
Michael Walsh5f3f4142017-05-22 17:09:47 -050018Library gen_cmd.py
Sunil Macd110a2017-05-23 04:14:32 -050019Library gen_robot_keyword.py
Michael Walshe53e47a2017-06-30 17:03:24 -050020Library bmc_ssh_utils.py
Michael Walshfdc5ced2017-08-17 13:15:15 -050021Library utils.py
Charles Paul Hofer35816152017-10-02 11:55:11 -050022Library var_funcs.py
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050023Library SCPLibrary WITH NAME scp
George Keishing61364e52019-10-01 12:01:19 -050024Library gen_robot_valid.py
George Keishing83c737b2022-05-17 12:12:04 -050025Library pldm_utils.py
Chris Austenb29d2e82016-06-07 12:25:35 -050026
Steven Sombarf60cbcf2018-12-07 08:12:18 -060027
Chris Austenb29d2e82016-06-07 12:25:35 -050028*** Variables ***
Steven Sombar0acb3412018-01-24 09:38:42 -060029
Steven Sombar0acb3412018-01-24 09:38:42 -060030${SYSTEM_SHUTDOWN_TIME} ${5}
31
Michael Walsha6723f22016-11-22 11:12:01 -060032# Assign default value to QUIET for programs which may not define it.
33${QUIET} ${0}
Steven Sombar0acb3412018-01-24 09:38:42 -060034
Sridevi Ramesh1699d372016-12-06 00:20:22 -060035${HOST_SETTING} ${SETTINGS_URI}host0
Steven Sombar0acb3412018-01-24 09:38:42 -060036
Steven Sombar0acb3412018-01-24 09:38:42 -060037${boot_prog_method} ${EMPTY}
Michael Walshfdc5ced2017-08-17 13:15:15 -050038${power_policy_setup} ${0}
39${bmc_power_policy_method} ${EMPTY}
Sridevi Ramesh13d84bf2022-10-31 09:14:52 -050040@{BOOT_PROGRESS_STATES} SystemHardwareInitializationComplete OSBootStarted OSRunning
Michael Walshfdc5ced2017-08-17 13:15:15 -050041
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050042
Chris Austenb29d2e82016-06-07 12:25:35 -050043*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060044
Steven Sombar0acb3412018-01-24 09:38:42 -060045
George Keishing5e870cd2016-08-24 10:05:47 -050046Verify Ping and REST Authentication
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -050047 [Documentation] Verify ping and rest authentication.
Michael Walsha6723f22016-11-22 11:12:01 -060048 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -050049 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -050050 Run Keyword If '${l_ping}' == '${False}'
51 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -050052
Michael Walsha6723f22016-11-22 11:12:01 -060053 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -050054 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -050055 Run Keyword If '${l_rest}' == '${False}'
56 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -050057
58 # Just to make sure the SSH is working for SCP
59 Open Connection And Log In
60 ${system} ${stderr}= Execute Command hostname return_stderr=True
61 Should Be Empty ${stderr}
62
Steven Sombar0acb3412018-01-24 09:38:42 -060063
George Keishing90b555a2021-05-20 11:54:16 -050064Verify Ping SSH And Redfish Authentication
65 [Documentation] Verify ping, SSH and redfish authentication.
66
67 ${l_ping}= Run Keyword And Return Status Ping Host ${OPENBMC_HOST}
68 Run Keyword If '${l_ping}' == '${False}' Fail msg=Ping Failed
69
70 ${l_rest}= Run Keyword And Return Status Redfish.Login
71 Run Keyword If '${l_rest}' == '${False}' Fail msg=REST Authentication Failed
72
73 # Just to make sure the SSH is working.
74 Open Connection And Log In
75 ${system} ${stderr}= Execute Command hostname return_stderr=True
76 Should Be Empty ${stderr}
77
78
George Keishingc4d3dc02016-09-19 03:45:55 -050079Check If BMC is Up
80 [Documentation] Wait for Host to be online. Checks every X seconds
81 ... interval for Y minutes and fails if timed out.
82 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -060083 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -050084 ... ${interval}=10 sec
85
Steven Sombar0acb3412018-01-24 09:38:42 -060086 # Description of argument(s):
87 # max_timeout Maximum time to wait.
88 # This should be expressed in Robot Framework's time format
89 # (e.g. "10 minutes").
George Keishing16b3c7b2021-01-28 09:23:37 -060090 # interval Interval to wait between status checks.
Steven Sombar0acb3412018-01-24 09:38:42 -060091 # This should be expressed in Robot Framework's time format
92 # (e.g. "5 seconds").
93
George Keishingc4d3dc02016-09-19 03:45:55 -050094 Wait Until Keyword Succeeds
95 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
96
George Keishingb3700812016-08-31 03:03:30 -050097
George Keishing06ae4aa2016-08-30 01:41:28 -050098Flush REST Sessions
99 [Documentation] Removes all the active session objects
100 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500101
Steven Sombar0acb3412018-01-24 09:38:42 -0600102
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600103Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -0500104 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600105 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Steven Sombar0acb3412018-01-24 09:38:42 -0600106
Michael Walshb5839d02017-04-12 16:11:20 -0500107 # Description of argument(s):
108 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
109 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600110 # sleep_time Time delay for host watchdog error to get injected.
111 # Default is 5 seconds.
112
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500113 ${data}= Create Dictionary
114 ... data=xyz.openbmc_project.State.Watchdog.Action.PowerCycle
115 ${status} ${result}= Run Keyword And Ignore Error
116 ... Read Attribute ${HOST_WATCHDOG_URI} ExpireAction
117 Run Keyword If '${status}' == 'PASS'
118 ... Write Attribute ${HOST_WATCHDOG_URI} ExpireAction data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -0500119
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600120 ${int_milliseconds}= Convert To Integer ${milliseconds}
121 ${data}= Create Dictionary data=${int_milliseconds}
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500122 Write Attribute ${HOST_WATCHDOG_URI} Interval data=${data}
123
124 ${data}= Create Dictionary data=${True}
125 Write Attribute ${HOST_WATCHDOG_URI} Enabled data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -0500126
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600127 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500128
Steven Sombar0acb3412018-01-24 09:38:42 -0600129
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500130Login To OS Host
Steven Sombar0acb3412018-01-24 09:38:42 -0600131 [Documentation] Login to OS Host and return the Login response code.
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500132 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
133 ... ${os_password}=${OS_PASSWORD}
Steven Sombar0acb3412018-01-24 09:38:42 -0600134
Gunnar Mills28e403b2017-10-25 16:16:38 -0500135 # Description of arguments:
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500136 # ${os_host} IP address of the OS Host.
137 # ${os_username} OS Host Login user name.
138 # ${os_password} OS Host Login passwrd.
139
George Keishing1856d332021-11-15 08:38:53 -0600140 Redfish Power On stack_mode=skip quiet=1
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500141
George Keishing3f223b82017-06-28 03:50:35 -0500142 SSHLibrary.Open Connection ${os_host}
George Keishinge0030882019-02-21 03:48:27 -0600143 ${resp}= SSHLibrary.Login ${os_username} ${os_password}
Sridevi Rameshea36b412017-03-09 04:08:02 -0600144 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -0500145
Steven Sombar0acb3412018-01-24 09:38:42 -0600146
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600147Initiate Auto Reboot
148 [Documentation] Initiate an auto reboot.
149 [Arguments] ${milliseconds}=5000
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500150
151 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600152 # milliseconds The number of milliseconds for the watchdog timer.
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500153
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600154 # Set the auto reboot policy.
155 Set Auto Reboot ${1}
156 # Set the watchdog timer.
157 Trigger Host Watchdog Error ${milliseconds}
158
159
160Initiate OS Host Reboot
161 [Documentation] Initiate an OS reboot.
162 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
163 ... ${os_password}=${OS_PASSWORD}
164
165 # Description of argument(s):
166 # os_host The host name or IP address of the OS.
167 # os_username The username to be used to sign in to the OS.
168 # os_password The password to be used to sign in to the OS.
169
170 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
171 ... Set Variable reboot
172 ... ELSE
173 ... Set Variable echo ${os_password} | sudo -S reboot
174
175 ${output} ${stderr} ${rc}= OS Execute Command
176 ... ${cmd_buf} fork=${1}
177
178
179Initiate OS Host Power Off
180 [Documentation] Initiate an OS reboot.
181 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
182 ... ${os_password}=${OS_PASSWORD} ${hard}=${0}
183
184 # Description of argument(s):
185 # os_host The DNS name or IP of the OS.
186 # os_username The username to be used to sign in to the OS.
187 # os_password The password to be used to sign in to the OS.
188 # hard Indicates whether to do a hard vs. soft power off.
189
190 ${time_string}= Run Keyword If ${hard} Set Variable ${SPACE}now
191 ... ELSE Set Variable ${EMPTY}
192
193 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
194 ... Set Variable shutdown${time_string}
195 ... ELSE
196 ... Set Variable echo ${os_password} | sudo -S shutdown${time_string}
197
198 ${output} ${stderr} ${rc}= OS Execute Command
199 ... ${cmd_buf} fork=${1}
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500200
George Keishing3987a1e2017-09-20 09:13:02 -0500201
Steven Sombar5f3af442018-02-14 08:30:15 -0600202Set System LED State
203 [Documentation] Set given system LED via REST.
204 [Arguments] ${led_name} ${led_state}
205 # Description of argument(s):
206 # led_name System LED name (e.g. heartbeat, identify, beep).
207 # led_state LED state to be set (e.g. On, Off).
208
209 ${args}= Create Dictionary
210 ... data=xyz.openbmc_project.Led.Physical.Action.${led_state}
211 Write Attribute ${LED_PHYSICAL_URI}${led_name} State data=${args}
212
213 Verify LED State ${led_name} ${led_state}
214
215
Steven Sombaraaf72c42017-09-05 12:02:00 -0500216Read Turbo Setting Via REST
217 [Documentation] Return turbo setting via REST.
Steven Sombarea79a492018-04-18 11:14:57 -0500218 # Returns 1 if TurboAllowed, 0 if not.
Steven Sombaraaf72c42017-09-05 12:02:00 -0500219
Steven Sombarea79a492018-04-18 11:14:57 -0500220 ${turbo_setting}= Read Attribute
221 ... ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
222 [Return] ${turbo_setting}
223
Steven Sombaraaf72c42017-09-05 12:02:00 -0500224
Steven Sombaraaf72c42017-09-05 12:02:00 -0500225Set Turbo Setting Via REST
226 [Documentation] Set turbo setting via REST.
Steven Sombar80bc8592018-04-24 11:44:53 -0500227 [Arguments] ${setting} ${verify}=${False}
Steven Sombar0acb3412018-01-24 09:38:42 -0600228
Steven Sombaraaf72c42017-09-05 12:02:00 -0500229 # Description of argument(s):
Steven Sombar80bc8592018-04-24 11:44:53 -0500230 # setting State to set TurboAllowed, 1=allowed, 0=not allowed.
231 # verify If True, read the TurboAllowed setting to confirm.
Steven Sombaraaf72c42017-09-05 12:02:00 -0500232
Steven Sombarea79a492018-04-18 11:14:57 -0500233 ${data}= Create Dictionary data=${${setting}}
Steven Sombar80bc8592018-04-24 11:44:53 -0500234 Write Attribute ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
235 ... verify=${verify} data=${data}
George Keishingef74a8c2017-10-20 10:23:52 -0500236
Steven Sombar0acb3412018-01-24 09:38:42 -0600237
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600238Set REST Logging Policy
239 [Documentation] Enable or disable REST logging setting.
240 [Arguments] ${policy_setting}=${True}
George Keishingef74a8c2017-10-20 10:23:52 -0500241
242 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600243 # policy_setting The policy setting value which can be either
244 # True or False.
George Keishingef74a8c2017-10-20 10:23:52 -0500245
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600246 ${log_dict}= Create Dictionary data=${policy_setting}
George Keishingdf3e65f2018-12-18 13:06:56 -0600247 Write Attribute ${BMC_LOGGING_URI}rest_api_logs Enabled
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600248 ... data=${log_dict} verify=${1} expected_value=${policy_setting}
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -0500249
Steven Sombar0acb3412018-01-24 09:38:42 -0600250
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600251Old Get Boot Progress
252 [Documentation] Get the boot progress the old way (via org location).
253 [Arguments] ${quiet}=${QUIET}
George Keishing034902d2017-11-10 13:15:38 -0600254
255 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600256 # quiet Indicates whether this keyword should run without any output to
257 # the console.
258
259 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
260 ... value quiet=${quiet}
261
262 [Return] ${state}
263
264
265Set Boot Progress Method
266 [Documentation] Set the boot_prog_method to either 'Old' or 'New'.
267
268 # The boot progress data has moved from an 'org' location to an 'xyz'
269 # location. This keyword will determine whether the new method of getting
270 # the boot progress is valid and will set the global boot_prog_method
271 # variable accordingly. If boot_prog_method is already set (either by a
272 # prior call to this function or via a -v parm), this keyword will simply
273 # return.
274
275 # Note: There are interim builds that contain boot_progress in both the
276 # old and the new location values. It is nearly impossible for this
277 # keyword to determine whether the old boot_progress or the new one is
278 # active. When using such builds where the old boot_progress is active,
279 # the only recourse users will have is that they may specify
280 # -v boot_prog_method:Old to force old behavior on such builds.
281
282 Run Keyword If '${boot_prog_method}' != '${EMPTY}' Return From Keyword
283
284 ${new_status} ${new_value}= Run Keyword And Ignore Error
285 ... New Get Boot Progress
286 # If the new style read fails, the method must necessarily be "Old".
287 Run Keyword If '${new_status}' == 'PASS'
288 ... Run Keywords
289 ... Set Global Variable ${boot_prog_method} New AND
290 ... Rqpvars boot_prog_method AND
291 ... Return From Keyword
292
293 # Default method is "Old".
294 Set Global Variable ${boot_prog_method} Old
295 Rqpvars boot_prog_method
296
297
298Initiate Power On
299 [Documentation] Initiates the power on and waits until the Is Power On
300 ... keyword returns that the power state has switched to on.
301 [Arguments] ${wait}=${1}
302
303 # Description of argument(s):
304 # wait Indicates whether to wait for a powered on state after issuing
305 # the power on command.
306
307 @{arglist}= Create List
308 ${args}= Create Dictionary data=@{arglist}
309 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
310 ... data=${args}
311 should be equal as strings ${resp.status_code} ${HTTP_OK}
312
313 # Does caller want to wait for power on status?
314 Run Keyword If '${wait}' == '${0}' Return From Keyword
315 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
316
317
318Initiate Power Off
319 [Documentation] Initiates the power off and waits until the Is Power Off
320 ... keyword returns that the power state has switched to off.
321
322 @{arglist}= Create List
323 ${args}= Create Dictionary data=@{arglist}
324 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
325 ... data=${args}
326 should be equal as strings ${resp.status_code} ${HTTP_OK}
327 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
328
329
330Get Boot Progress
331 [Documentation] Get the boot progress and return it.
332 [Arguments] ${quiet}=${QUIET}
333
334 # Description of argument(s):
335 # quiet Indicates whether this keyword should run without any output to
336 # the console.
337
338 Set Boot Progress Method
339 ${state}= Run Keyword If '${boot_prog_method}' == 'New'
340 ... New Get Boot Progress quiet=${quiet}
341 ... ELSE
342 ... Old Get Boot Progress quiet=${quiet}
343
344 [Return] ${state}
345
346
347New Get Boot Progress
348 [Documentation] Get the boot progress the new way (via xyz location).
349 [Arguments] ${quiet}=${QUIET}
350
351 # Description of argument(s):
352 # quiet Indicates whether this keyword should run without any output to
353 # the console.
354
355 ${state}= Read Attribute ${HOST_STATE_URI} BootProgress quiet=${quiet}
356
357 [Return] ${state.rsplit('.', 1)[1]}
358
359
360New Get Power Policy
361 [Documentation] Returns the BMC power policy (new method).
362 ${currentPolicy}= Read Attribute ${POWER_RESTORE_URI} PowerRestorePolicy
363
364 [Return] ${currentPolicy}
365
366
367Old Get Power Policy
368 [Documentation] Returns the BMC power policy (old method).
369 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
370
371 [Return] ${currentPolicy}
372
373
George Keishinga54e06f2020-06-12 10:42:41 -0500374Redfish Get Power Restore Policy
375 [Documentation] Returns the BMC power restore policy.
376
377 ${power_restore_policy}= Redfish.Get Attribute /redfish/v1/Systems/system PowerRestorePolicy
378 [Return] ${power_restore_policy}
379
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600380Get Auto Reboot
381 [Documentation] Returns auto reboot setting.
382 ${setting}= Read Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot
383
384 [Return] ${setting}
385
386
George Keishingc8a6dd22020-06-12 12:01:33 -0500387Redfish Get Auto Reboot
388 [Documentation] Returns auto reboot setting.
389
George Keishinga8cb28d2020-06-15 03:10:29 -0500390 ${resp}= Redfish.Get Attribute /redfish/v1/Systems/system Boot
George Keishinga8cb28d2020-06-15 03:10:29 -0500391 [Return] ${resp["AutomaticRetryConfig"]}
George Keishingc8a6dd22020-06-12 12:01:33 -0500392
393
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600394Trigger Warm Reset
395 [Documentation] Initiate a warm reset.
396
397 log to console "Triggering warm reset"
398 ${data}= create dictionary data=@{EMPTY}
George Keishingfbd67002022-08-01 11:24:03 -0500399 ${resp}= Openbmc Post Request
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600400 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
401 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
402 ${session_active}= Check If warmReset is Initiated
403 Run Keyword If '${session_active}' == '${True}'
404 ... Fail msg=warm reset didn't occur
405
406 Sleep ${SYSTEM_SHUTDOWN_TIME}min
407 Check If BMC Is Up
408
409
410Get Power State
411 [Documentation] Returns the power state as an integer. Either 0 or 1.
412 [Arguments] ${quiet}=${QUIET}
413
414 # Description of argument(s):
415 # quiet Indicates whether this keyword should run without any output to
416 # the console.
417
418 @{arglist}= Create List
419 ${args}= Create Dictionary data=@{arglist}
420
421 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
422 ... data=${args} quiet=${quiet}
423 Should be equal as strings ${resp.status_code} ${HTTP_OK}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600424
George Keishingfbd67002022-08-01 11:24:03 -0500425 [Return] ${resp.json()["data"]}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600426
427
428Clear BMC Gard Record
429 [Documentation] Clear gard records from the system.
430
431 @{arglist}= Create List
432 ${args}= Create Dictionary data=@{arglist}
433 ${resp}= Call Method
434 ... ${OPENPOWER_CONTROL}gard Reset data=${args}
435 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
436
437
438Flash PNOR
439 [Documentation] Calls flash bios update method to flash PNOR image
440 [Arguments] ${pnor_image}
441
442 # Description of argument(s):
443 # pnor_image The filename and path of the PNOR image
444 # (e.g. "/home/image/zaius.pnor").
445
446 @{arglist}= Create List ${pnor_image}
447 ${args}= Create Dictionary data=@{arglist}
448 ${resp}= Call Method /org/openbmc/control/flash/bios/ update
449 ... data=${args}
450 should be equal as strings ${resp.status_code} ${HTTP_OK}
451 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
452
453
454Get Flash BIOS Status
455 [Documentation] Returns the status of the flash BIOS API as a string. For
456 ... example 'Flashing', 'Flash Done', etc
457 ${data}= Read Properties /org/openbmc/control/flash/bios
458 [Return] ${data['status']}
459
460
461Is PNOR Flashing
462 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
463 ... flashing has started.
464 ${status}= Get Flash BIOS Status
465 Should Contain ${status} Flashing
466
467
468Is PNOR Flash Done
469 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
470 ... PNOR flashing has completed.
471 ${status}= Get Flash BIOS Status
472 should be equal as strings ${status} Flash Done
473
474
475Create OS Console File Path
476 [Documentation] Create OS console file path name and return it.
477 [Arguments] ${log_file_path}=${EMPTY}
478
479 # Description of arguments:
480 # file_path The caller's candidate value. If this value is ${EMPTY}, this
481 # keyword will compose a file path name. Otherwise, this
482 # keyword will use the caller's file_path value. In either
483 # case, the value will be returned.
484
485 ${status}= Run Keyword And Return Status Variable Should Exist
486 ... ${TEST_NAME}
487
488 ${default_file_path}= Set Variable If ${status} == ${TRUE}
George Keishing9161b102021-12-10 02:26:30 -0600489 ... ${EXECDIR}${/}tmp${/}${OPENBMC_HOST}_${TEST_NAME.replace(' ', '')}_os_console.txt
490 ... ${EXECDIR}${/}tmp${/}${OPENBMC_HOST}_os_console.txt
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600491
492 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
493 ... ${default_file_path} ${log_file_path}
494
495 [Return] ${log_file_path}
496
497
498Get Endpoint Paths
499 [Documentation] Returns all url paths ending with given endpoint
500 ... Example:
501 ... Given the following endpoint: cpu
502 ... This keyword will return: list of all urls ending with
503 ... cpu -
504 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
505 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
506 [Arguments] ${path} ${endpoint}
507
508 # Description of arguments:
509 # path URL path for enumeration.
510 # endpoint Endpoint string (url path ending).
511
Steven Sombaraaaab222018-12-19 13:16:23 -0600512 # Make sure path ends with slash.
513 ${path}= Add Trailing Slash ${path}
514
515 ${resp}= Read Properties ${path}enumerate timeout=30
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600516 Log Dictionary ${resp}
517
518 ${list}= Get Dictionary Keys ${resp}
519 # For a given string, look for prefix and suffix for matching expression.
520 # Start of string followed by zero or more of any character followed by
521 # any digit or lower case character.
George Keishing585afa32020-07-09 04:55:15 -0500522 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}\[_0-9a-z]*$ case_insensitive=${True}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600523
524 [Return] ${resp}
525
526
527Set BMC Power Policy
528 [Documentation] Set the given BMC power policy.
529 [Arguments] ${policy}
530
531 # Note that this function will translate the old style "RESTORE_LAST_STATE"
532 # policy to the new style "xyz.openbmc_project.Control.Power.RestorePolicy.
533 # Policy.Restore" for you.
534
535 # Description of argument(s):
536 # policy Power restore policy (e.g "RESTORE_LAST_STATE",
537 # ${RESTORE_LAST_STATE}).
538
539 # Set the bmc_power_policy_method to either 'Old' or 'New'.
540 Set Power Policy Method
541 # This translation helps bridge between old and new method for calling.
542 ${policy}= Translate Power Policy Value ${policy}
543 # Run the appropriate keyword.
544 Run Key ${bmc_power_policy_method} Set Power Policy \ ${policy}
545 ${currentPolicy}= Get System Power Policy
546 Should Be Equal ${currentPolicy} ${policy}
547
548
549Delete Error Logs
550 [Documentation] Delete error logs.
Michael Sheposcc490b42020-08-26 12:53:01 -0500551 [Arguments] ${quiet}=${0}
552 # Description of argument(s):
553 # quiet If enabled, turns off logging to console.
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600554
555 # Check if error logs entries exist, if not return.
Steven Sombara8800da2018-12-18 16:19:05 -0600556 ${resp}= OpenBMC Get Request ${BMC_LOGGING_ENTRY}list quiet=${1}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600557 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND}
558
559 # Get the list of error logs entries and delete them all.
560 ${elog_entries}= Get URL List ${BMC_LOGGING_ENTRY}
David Shaw79247e42020-06-18 17:16:02 -0500561 FOR ${entry} IN @{elog_entries}
Michael Sheposcc490b42020-08-26 12:53:01 -0500562 Delete Error Log Entry ${entry} quiet=${quiet}
David Shaw79247e42020-06-18 17:16:02 -0500563 END
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600564
565
566Delete All Error Logs
567 [Documentation] Delete all error log entries using "DeleteAll" interface.
568
George Keishingfbd67002022-08-01 11:24:03 -0500569 ${args}= Set Variable {"data": []}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600570 ${resp}= Openbmc Post Request ${BMC_LOGGING_URI}action/DeleteAll
George Keishingfbd67002022-08-01 11:24:03 -0500571 ... data=${args}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600572 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
573
574
575Get Elog URL List
576 [Documentation] Return error log entry list of URLs.
577
578 ${url_list}= Read Properties /xyz/openbmc_project/logging/entry/
579 Sort List ${url_list}
580 [Return] ${url_list}
581
582
583Get BMC Flash Chip Boot Side
584 [Documentation] Return the BMC flash chip boot side.
George Keishing034902d2017-11-10 13:15:38 -0600585
586 # Example:
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600587 # 0 - indicates chip select is current side.
588 # 32 - indicates chip select is alternate side.
George Keishing034902d2017-11-10 13:15:38 -0600589
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600590 ${boot_side} ${stderr} ${rc}= BMC Execute Command
591 ... cat /sys/class/watchdog/watchdog1/bootstatus
592
593 [Return] ${boot_side}
594
595
Sweta Potthuri7d3af3c2018-01-29 03:07:07 -0600596Watchdog Object Should Exist
597 [Documentation] Check that watchdog object exists.
598
599 ${resp}= OpenBMC Get Request ${WATCHDOG_URI}host0
600 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
601 ... msg=Expected watchdog object does not exist.
Sweta Potthurif39022d2018-02-06 03:40:07 -0600602
603
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600604Get System LED State
605 [Documentation] Return the state of given system LED.
606 [Arguments] ${led_name}
Sweta Potthurif39022d2018-02-06 03:40:07 -0600607
608 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600609 # led_name System LED name (e.g. heartbeat, identify, beep).
Sweta Potthurif39022d2018-02-06 03:40:07 -0600610
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600611 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State
612 [Return] ${state.rsplit('.', 1)[1]}
George Keishingb9f407b2018-02-20 00:07:46 -0600613
614
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600615Verify LED State
616 [Documentation] Checks if LED is in given state.
617 [Arguments] ${led_name} ${led_state}
618 # Description of argument(s):
619 # led_name System LED name (e.g. heartbeat, identify, beep).
620 # led_state LED state to be verified (e.g. On, Off).
George Keishingb9f407b2018-02-20 00:07:46 -0600621
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600622 ${state}= Get System LED State ${led_name}
623 Should Be Equal ${state} ${led_state}
George Keishingb9f407b2018-02-20 00:07:46 -0600624
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600625
626Get LED State XYZ
627 [Documentation] Returns state of given LED.
628 [Arguments] ${led_name}
629
630 # Description of argument(s):
631 # led_name Name of LED.
632
633 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
634 # Returns the state of the LED, either On or Off.
635 [Return] ${state}
George Keishingb9f407b2018-02-20 00:07:46 -0600636
George Keishing78ce8dc2018-03-30 11:49:06 -0500637
638Verify Identify LED State
Alvin Wang32f7b3d2019-07-25 02:05:39 -0500639 [Documentation] Verify that the identify state of the LED group matches caller's expectations.
George Keishing78ce8dc2018-03-30 11:49:06 -0500640 [Arguments] ${expected_state}
641
642 # Description of argument(s):
Alvin Wang32f7b3d2019-07-25 02:05:39 -0500643 # expected_state The expected LED asserted state (1 = asserted, 0 = not asserted).
George Keishing78ce8dc2018-03-30 11:49:06 -0500644
Alvin Wang32f7b3d2019-07-25 02:05:39 -0500645 ${led_state}= Get LED State XYZ enclosure_identify
646 Should Be Equal ${led_state} ${expected_state} msg=Unexpected LED state.
Sweta Potthuri39255032018-03-28 10:12:14 -0500647
648Verify The Attribute
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500649 [Documentation] Verify the given attribute.
Sweta Potthuri39255032018-03-28 10:12:14 -0500650 [Arguments] ${uri} ${attribute_name} ${attribute_value}
651
652 # Description of argument(s):
653 # uri URI path
654 # (e.g. "/xyz/openbmc_project/control/host0/TPMEnable").
655 # attribute_name Name of attribute to be verified (e.g. "TPMEnable").
656 # attribute_value The expected value of attribute (e.g. "1", "0", etc.)
657
658 ${output}= Read Attribute ${uri} ${attribute_name}
659 Should Be Equal ${attribute_value} ${output}
660 ... msg=Attribute "${attribute_name} does not have the expected value.
George Keishingcf0d7772018-05-04 08:22:50 -0500661
662
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600663New Set Power Policy
664 [Documentation] Set the given BMC power policy (new method).
665 [Arguments] ${policy}
George Keishingb4adfc72018-10-26 09:39:32 -0500666
667 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600668 # policy Power restore policy (e.g. ${ALWAYS_POWER_OFF}).
George Keishingc5fef582018-07-18 08:41:28 -0500669
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600670 ${valueDict}= Create Dictionary data=${policy}
671 Write Attribute
672 ... ${POWER_RESTORE_URI} PowerRestorePolicy data=${valueDict}
George Keishing216e5842018-08-31 14:58:15 -0500673
674
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600675Old Set Power Policy
676 [Documentation] Set the given BMC power policy (old method).
677 [Arguments] ${policy}
George Keishing3c004dc2018-10-10 07:16:47 -0500678
679 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600680 # policy Power restore policy (e.g. "ALWAYS_POWER_OFF").
681
682 ${valueDict}= create dictionary data=${policy}
683 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
George Keishing3c004dc2018-10-10 07:16:47 -0500684
685
George Keishinga54e06f2020-06-12 10:42:41 -0500686Redfish Set Power Restore Policy
687 [Documentation] Set the BMC power restore policy.
688 [Arguments] ${power_restore_policy}
689
690 # Description of argument(s):
691 # power_restore_policy Power restore policy (e.g. "AlwaysOff", "AlwaysOn", "LastState").
692
693 Redfish.Patch /redfish/v1/Systems/system body={"PowerRestorePolicy": "${power_restore_policy}"}
694 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
695
696
George Keishing9a288602021-12-10 04:50:25 -0600697IPMI Set Power Restore Policy
698 [Documentation] Set the BMC power restore policy using IPMI.
699 [Arguments] ${power_restore_policy}=always-off
700
701 # Description of argument(s):
702 # power_restore_policy Power restore policies
703 # always-on : turn on when power is restored
704 # previous : return to previous state when power is restored
705 # always-off : stay off after power is restored
706
707 ${resp}= Run IPMI Standard Command chassis policy ${power_restore_policy}
708 # Example: Set chassis power restore policy to always-off
709 Should Contain ${resp} ${power_restore_policy}
710
711
George Keishinga5cedb32020-07-17 15:50:34 -0500712Set Auto Reboot Setting
713 [Documentation] Set the given auto reboot setting (REST or Redfish).
714 [Arguments] ${value}
715
716 # Description of argument(s):
717 # value The reboot setting, 1 for enabling and 0 for disabling.
718
719 # This is to cater to boot call points and plugin script which will always
720 # send using value 0 or 1. This dictionary maps to redfish string values.
721 ${rest_redfish_dict}= Create Dictionary
722 ... 1=RetryAttempts
723 ... 0=Disabled
724
George Keishinge1879642020-12-09 13:20:15 -0600725 Run Keyword If ${REDFISH_SUPPORT_TRANS_STATE} == ${1}
George Keishinga5cedb32020-07-17 15:50:34 -0500726 ... Redfish Set Auto Reboot ${rest_redfish_dict["${value}"]}
George Keishinge1879642020-12-09 13:20:15 -0600727 ... ELSE
728 ... Set Auto Reboot ${value}
George Keishinga5cedb32020-07-17 15:50:34 -0500729
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600730Set Auto Reboot
731 [Documentation] Set the given auto reboot setting.
732 [Arguments] ${setting}
George Keishing3c004dc2018-10-10 07:16:47 -0500733
734 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600735 # setting The reboot setting, 1 for enabling and 0 for disabling.
George Keishing3c004dc2018-10-10 07:16:47 -0500736
Sridevi Ramesh68d72ff2019-02-04 09:24:46 -0600737 ${valueDict}= Convert To Integer ${setting}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600738 ${data}= Create Dictionary data=${valueDict}
739 Write Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot data=${data}
740 ${current_setting}= Get Auto Reboot
741 Should Be Equal As Integers ${current_setting} ${setting}
George Keishing3c004dc2018-10-10 07:16:47 -0500742
George Keishingc25c55d2018-10-30 02:23:44 -0500743
George Keishingc8a6dd22020-06-12 12:01:33 -0500744Redfish Set Auto Reboot
745 [Documentation] Set the given auto reboot setting.
746 [Arguments] ${setting}
747
748 # Description of argument(s):
749 # setting The reboot setting, "RetryAttempts" and "Disabled".
750
George Keishinga8cb28d2020-06-15 03:10:29 -0500751 Redfish.Patch /redfish/v1/Systems/system body={"Boot": {"AutomaticRetryConfig": "${setting}"}}
752 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
George Keishinga8cb28d2020-06-15 03:10:29 -0500753
George Keishingc8a6dd22020-06-12 12:01:33 -0500754 ${current_setting}= Redfish Get Auto Reboot
755 Should Be Equal As Strings ${current_setting} ${setting}
756
757
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600758Set Control Boot Mode
759 [Documentation] Set given boot mode on the boot object path attribute.
760 [Arguments] ${boot_path} ${boot_mode}
George Keishingc25c55d2018-10-30 02:23:44 -0500761
762 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600763 # boot_path Boot object path.
764 # Example:
765 # /xyz/openbmc_project/control/host0/boot
766 # /xyz/openbmc_project/control/host0/boot/one_time
767 # boot_mode Boot mode which need to be set.
768 # Example:
769 # "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"
George Keishingc25c55d2018-10-30 02:23:44 -0500770
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600771 ${valueDict}= Create Dictionary data=${boot_mode}
772 Write Attribute ${boot_path} BootMode data=${valueDict}
George Keishingc25c55d2018-10-30 02:23:44 -0500773
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600774
775Is Power On
776 [Documentation] Verify that the BMC chassis state is on.
777 ${state}= Get Power State
778 Should be equal ${state} ${1}
779
780
781Is Power Off
782 [Documentation] Verify that the BMC chassis state is off.
783 ${state}= Get Power State
784 Should be equal ${state} ${0}
Sivas SRR0e3bc6d2019-04-23 08:36:35 -0500785
786
787CLI Get BMC DateTime
788 [Documentation] Returns BMC date time from date command.
789
790 ${bmc_time_via_date} ${stderr} ${rc}= BMC Execute Command date +"%Y-%m-%d %H:%M:%S" print_err=1
791 [Return] ${bmc_time_via_date}
George Keishing61364e52019-10-01 12:01:19 -0500792
793
794Update Root Password
795 [Documentation] Update system "root" user password.
796 [Arguments] ${openbmc_password}=${OPENBMC_PASSWORD}
797
798 # Description of argument(s):
799 # openbmc_password The root password for the open BMC system.
800
801 @{password}= Create List ${openbmc_password}
802 ${data}= Create Dictionary data=@{password}
803
804 ${headers}= Create Dictionary Content-Type=application/json X-Auth-Token=${XAUTH_TOKEN}
George Keishingfbd67002022-08-01 11:24:03 -0500805 ${resp}= POST On Session openbmc ${BMC_USER_URI}root/action/SetPassword
George Keishing61364e52019-10-01 12:01:19 -0500806 ... data=${data} headers=${headers}
807 Valid Value resp.status_code [${HTTP_OK}]
Sushil Singh6624ce52020-01-22 00:53:41 -0600808
809
810Get Post Boot Action
811 [Documentation] Get post boot action.
812
George Keishing879f0842020-02-05 11:00:47 -0600813 # Post code update action dictionary.
Sushil Singh6624ce52020-01-22 00:53:41 -0600814 #
815 # {
816 # BMC image: {
817 # OnReset: Redfish OBMC Reboot (off),
818 # Immediate: Wait For Reboot start_boot_seconds=${state['epoch_seconds']}
819 # },
820 # Host image: {
George Keishinge523fc02020-03-23 12:28:01 -0500821 # OnReset: RF SYS GracefulRestart,
Sushil Singh6624ce52020-01-22 00:53:41 -0600822 # Immediate: Wait State os_running_match_state 10 mins
823 # }
824 # }
825
826 ${code_base_dir_path}= Get Code Base Dir Path
827 ${post_code_update_actions}= Evaluate
828 ... json.load(open('${code_base_dir_path}data/applytime_table.json')) modules=json
829 Rprint Vars post_code_update_actions
830
831 [Return] ${post_code_update_actions}
832
George Keishing1eeff9c2020-06-16 04:03:34 -0500833
Sushil Singh1560e652022-08-03 13:25:01 -0500834Get Task State From File
835 [Documentation] Get task states from pre-define data/task_state.json file.
836
837 # Example: Task state JSON format.
838 #
839 # {
840 # "TaskRunning": {
841 # "TaskState": "Running",
842 # "TaskStatus": "OK"
843 # },
844 # "TaskCompleted": {
845 # "TaskState": "Completed",
846 # "TaskStatus": "OK"
847 # },
848 # "TaskException": {
849 # "TaskState": "Exception",
850 # "TaskStatus": "Warning"
851 # }
852 # }
853
854 # Python module: get_code_base_dir_path()
855 ${code_base_dir_path}= Get Code Base Dir Path
856 ${task_state}= Evaluate
857 ... json.load(open('${code_base_dir_path}data/task_state.json')) modules=json
858 Rprint Vars task_state
859
860 [Return] ${task_state}
861
862
George Keishing1eeff9c2020-06-16 04:03:34 -0500863Redfish Set Boot Default
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300864 [Documentation] Set and Verify Boot source override
865 [Arguments] ${override_enabled} ${override_target} ${override_mode}=UEFI
George Keishing1eeff9c2020-06-16 04:03:34 -0500866
867 # Description of argument(s):
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300868 # override_enabled Boot source override enable type.
George Keishing1eeff9c2020-06-16 04:03:34 -0500869 # ('Once', 'Continuous', 'Disabled').
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300870 # override_target Boot source override target.
George Keishing1eeff9c2020-06-16 04:03:34 -0500871 # ('Pxe', 'Cd', 'Hdd', 'Diags', 'BiosSetup', 'None').
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300872 # override_mode Boot source override mode (relevant only for x86 arch).
873 # ('Legacy', 'UEFI').
George Keishing1eeff9c2020-06-16 04:03:34 -0500874
875 ${data}= Create Dictionary BootSourceOverrideEnabled=${override_enabled}
876 ... BootSourceOverrideTarget=${override_target}
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300877
878 Run Keyword If '${PLATFORM_ARCH_TYPE}' == 'x86'
879 ... Set To Dictionary ${data} BootSourceOverrideMode ${override_mode}
880
George Keishing1eeff9c2020-06-16 04:03:34 -0500881 ${payload}= Create Dictionary Boot=${data}
882
883 Redfish.Patch /redfish/v1/Systems/system body=&{payload}
884 ... valid_status_codes=[${HTTP_OK},${HTTP_NO_CONTENT}]
885
886 ${resp}= Redfish.Get Attribute /redfish/v1/Systems/system Boot
887 Should Be Equal As Strings ${resp["BootSourceOverrideEnabled"]} ${override_enabled}
888 Should Be Equal As Strings ${resp["BootSourceOverrideTarget"]} ${override_target}
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300889 Run Keyword If '${PLATFORM_ARCH_TYPE}' == 'x86'
890 ... Should Be Equal As Strings ${resp["BootSourceOverrideMode"]} ${override_mode}
George Keishinge1879642020-12-09 13:20:15 -0600891
892
893# Redfish state keywords.
894
895Redfish Get BMC State
896 [Documentation] Return BMC health state.
897
898 # "Enabled" -> BMC Ready, "Starting" -> BMC NotReady
899
900 # Example:
901 # "Status": {
902 # "Health": "OK",
903 # "HealthRollup": "OK",
904 # "State": "Enabled"
905 # },
906
907 ${status}= Redfish.Get Attribute /redfish/v1/Managers/bmc Status
908 [Return] ${status["State"]}
909
910
911Redfish Get Host State
912 [Documentation] Return host power and health state.
913
914 # Refer: http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status
915
916 # Example:
917 # "PowerState": "Off",
918 # "Status": {
919 # "Health": "OK",
920 # "HealthRollup": "OK",
921 # "State": "StandbyOffline"
922 # },
923
George Keishingb51d1502021-03-25 03:30:33 -0500924 ${chassis}= Redfish.Get Properties /redfish/v1/Chassis/${CHASSIS_ID}
George Keishinge1879642020-12-09 13:20:15 -0600925 [Return] ${chassis["PowerState"]} ${chassis["Status"]["State"]}
926
927
928Redfish Get Boot Progress
929 [Documentation] Return boot progress state.
930
931 # Example: /redfish/v1/Systems/system/
932 # "BootProgress": {
933 # "LastState": "OSRunning"
934 # },
935
936 ${boot_progress}= Redfish.Get Properties /redfish/v1/Systems/system/
George Keishingb51d1502021-03-25 03:30:33 -0500937
938 Return From Keyword If "${PLATFORM_ARCH_TYPE}" == "x86"
939 ... NA ${boot_progress["Status"]["State"]}
940
George Keishinge1879642020-12-09 13:20:15 -0600941 [Return] ${boot_progress["BootProgress"]["LastState"]} ${boot_progress["Status"]["State"]}
942
943
944Redfish Get States
945 [Documentation] Return all the BMC and host states in dictionary.
George Keishing366033f2021-04-01 13:49:06 -0500946 [Timeout] 120 Seconds
George Keishinge1879642020-12-09 13:20:15 -0600947
948 # Refer: openbmc/docs/designs/boot-progress.md
949
George Keishing205f95f2021-03-10 02:25:53 -0600950 Redfish.Login
George Keishinge1879642020-12-09 13:20:15 -0600951
952 ${bmc_state}= Redfish Get BMC State
953 ${chassis_state} ${chassis_status}= Redfish Get Host State
954 ${boot_progress} ${host_state}= Redfish Get Boot Progress
955
956 ${states}= Create Dictionary
957 ... bmc=${bmc_state}
958 ... chassis=${chassis_state}
959 ... host=${host_state}
960 ... boot_progress=${boot_progress}
961
George Keishing64293c52021-03-24 08:21:23 -0500962 # Disable loggoing state to prevent huge log.html record when boot
963 # test is run in loops.
964 #Log ${states}
George Keishing95cf8652021-02-08 11:32:33 -0600965
George Keishinge1879642020-12-09 13:20:15 -0600966 [Return] ${states}
George Keishing95cf8652021-02-08 11:32:33 -0600967
968
969Is BMC Standby
970 [Documentation] Check if BMC is ready and host at standby.
971
972 ${standby_states}= Create Dictionary
973 ... bmc=Enabled
974 ... chassis=Off
975 ... host=Disabled
976 ... boot_progress=None
977
aravinth0510de1863d2022-06-27 17:26:14 +0000978 Run Keyword If '${PLATFORM_ARCH_TYPE}' == 'x86'
979 ... Set To Dictionary ${standby_states} boot_progress=NA
980
George Keishing95cf8652021-02-08 11:32:33 -0600981 Wait Until Keyword Succeeds 3 min 10 sec Redfish Get States
982
Rahul Maheshwari258d5922022-11-27 01:04:39 -0600983 Wait Until Keyword Succeeds 5 min 10 sec Match State ${standby_states}
George Keishing95cf8652021-02-08 11:32:33 -0600984
985
986Match State
987 [Documentation] Check if the expected and current states are matched.
988 [Arguments] ${match_state}
989
990 # Description of argument(s):
991 # match_state Expected states in dictionary.
992
993 ${current_state}= Redfish Get States
994 Dictionaries Should Be Equal ${match_state} ${current_state}
Peter D Phan49739b22021-09-29 14:30:08 -0500995
996
997Redfish Initiate Auto Reboot
998 [Documentation] Initiate an auto reboot.
999 [Arguments] ${interval}=2000
1000
1001 # Description of argument(s):
1002 # interval Value in milliseconds to set Watchdog interval
1003
1004 # Set auto reboot policy
1005 Redfish Set Auto Reboot RetryAttempts
1006
George Keishingc0701102021-09-30 12:12:04 -05001007 Redfish Power Operation On
George Keishinga4e13522022-04-13 11:14:53 -05001008
1009 Wait Until Keyword Succeeds 2 min 5 sec Is Boot Progress Changed
George Keishingc0701102021-09-30 12:12:04 -05001010
Peter D Phan49739b22021-09-29 14:30:08 -05001011 # Set watchdog timer
1012 Set Watchdog Interval Using Busctl ${interval}
1013
1014
George Keishinga4e13522022-04-13 11:14:53 -05001015Is Boot Progress Changed
1016 [Documentation] Get BootProgress state and expect boot state mismatch.
1017 [Arguments] ${boot_state}=None
1018
1019 # Description of argument(s):
1020 # boot_state Value of the BootProgress state to match against.
1021
1022 ${boot_progress} ${host_state}= Redfish Get Boot Progress
1023
1024 Should Not Be Equal ${boot_progress} ${boot_state}
1025
Peter D Phan49739b22021-09-29 14:30:08 -05001026
Sridevi Ramesh13d84bf2022-10-31 09:14:52 -05001027Is Boot Progress At Required State
1028 [Documentation] Get BootProgress state and expect boot state to match.
1029 [Arguments] ${boot_state}=None
1030
1031 # Description of argument(s):
1032 # boot_state Value of the BootProgress state to match.
1033
1034 ${boot_progress} ${host_state}= Redfish Get Boot Progress
1035
1036 Should Be Equal ${boot_progress} ${boot_state}
1037
1038
1039Is Boot Progress At Any State
1040 [Documentation] Get BootProgress state and expect boot state to match
1041 ... with any of the states mentioned in the list.
1042 [Arguments] ${boot_states}=@{BOOT_PROGRESS_STATES}
1043
1044 # Description of argument(s):
1045 # boot_states List of the BootProgress states to match.
1046
1047 ${boot_progress} ${host_state}= Redfish Get Boot Progress
1048 Should Contain Any ${boot_progress} @{boot_states}
1049
1050
Sagar Anand0e262662023-01-24 11:36:01 -06001051Is Host At State
1052 [Documentation] Get Host state and check if it matches
1053 ... user input expected state.
1054 [Arguments] ${expected_host_state}
1055
1056 # Description of argument(s):
1057 # expected_host_state Expected Host State to check.(e.g. Quiesced).
1058
1059 ${boot_progress} ${host_state}= Redfish Get Boot Progress
1060
1061 Should Be Equal ${host_state} ${expected_host_state}
1062
1063
Peter D Phan49739b22021-09-29 14:30:08 -05001064Set Watchdog Interval Using Busctl
1065 [Documentation] Set Watchdog time interval.
1066 [Arguments] ${milliseconds}=1000
1067
1068 # Description of argument(s):
George Keishing4b729492021-11-10 12:51:10 -06001069 # milliseconds Time interval for watchdog timer
Peter D Phan49739b22021-09-29 14:30:08 -05001070
George Keishingc0701102021-09-30 12:12:04 -05001071 ${cmd}= Catenate busctl set-property xyz.openbmc_project.Watchdog
1072 ... /xyz/openbmc_project/watchdog/host0
1073 ... xyz.openbmc_project.State.Watchdog Interval t ${milliseconds}
Peter D Phan49739b22021-09-29 14:30:08 -05001074 BMC Execute Command ${cmd}
1075
George Keishingf5fec0d2021-10-08 12:38:45 -05001076
1077Stop PLDM Service And Wait
1078 [Documentation] Stop PLDM service and wait for Host to initiate reset.
1079
1080 BMC Execute Command systemctl stop pldmd.service
1081
George Keishingca76e372022-03-16 12:45:26 -05001082
1083Get BIOS Attribute
1084 [Documentation] Get the BIOS attribute for /redfish/v1/Systems/system/Bios.
1085
1086 # Python module: get_member_list(resource_path)
1087 ${systems}= Redfish_Utils.Get Member List /redfish/v1/Systems
1088 ${bios_attr_dict}= Redfish.Get Attribute ${systems[0]}/Bios Attributes
1089
1090 [Return] ${bios_attr_dict}
nagarjunb22cfb2c412022-03-15 15:49:27 +05301091
George Keishing8f610e72022-03-28 10:43:08 -05001092
1093Set BIOS Attribute
1094 [Documentation] PATCH the BIOS attribute for /redfish/v1/Systems/system/Bios.
1095 [Arguments] ${attribute_name} ${attribute_value}
1096
1097 # Description of argument(s):
1098 # attribute_name Any valid BIOS attribute.
1099 # attribute_value Valid allowed attribute values.
1100
1101 # Python module: get_member_list(resource_path)
1102 ${systems}= Redfish_Utils.Get Member List /redfish/v1/Systems
1103 Redfish.Patch ${systems[0]}/Bios/Settings body={"Attributes":{"${attribute_name}":"${attribute_value}"}}
1104
1105
nagarjunb22cfb2c412022-03-15 15:49:27 +05301106Is BMC Operational
1107 [Documentation] Check if BMC is enabled.
1108
1109 ${bmc_status} = Redfish Get BMC State
1110 Should Be Equal ${bmc_status} Enabled
George Keishing83c737b2022-05-17 12:12:04 -05001111
1112
1113PLDM Set BIOS Attribute
1114 [Documentation] Set the BIOS attribute via pldmtool and verify the attribute is set.
1115 ... Defaulted for fw_boot_side for boot test usage caller.
1116 [Arguments] ${attribute_name}=fw_boot_side ${attribute_value}=Temp
1117
1118 # Description of argument(s):
1119 # attribute_name Valid BIOS attribute name e.g ("fw_boot_side")
1120 # attribute_value Valid BIOS attribute value for fw_boot_side.
1121
1122 # PLDM response output example:
1123 # {
1124 # "Response": "SUCCESS"
1125 # }
1126
1127 ${resp}= pldmtool bios SetBIOSAttributeCurrentValue -a ${attribute_name} -d ${attribute_value}
1128 Should Be Equal As Strings ${resp["Response"]} SUCCESS
1129
1130 # PLDM GET output example:
1131 # {
1132 # "CurrentValue": "Temp"
1133 # }
1134
1135 ${pldm_output}= PLDM Get BIOS Attribute ${attribute_name}
1136 Should Be Equal As Strings ${pldm_output["CurrentValue"]} ${attribute_value}
1137 ... msg=Expecting ${attribute_value} but got ${pldm_output["CurrentValue"]}
1138
1139
1140PLDM Get BIOS Attribute
1141 [Documentation] Get the BIOS attribute via pldmtool for a given attribute and return value.
1142 [Arguments] ${attribute_name}
1143
1144 # Description of argument(s):
1145 # attribute_name Valid BIOS attribute name e.g ("fw_boot_side")
1146
1147 ${pldm_output}= pldmtool bios GetBIOSAttributeCurrentValueByHandle -a ${attribute_name}
1148 [Return] ${pldm_output}
nagarjunb2200108dc2022-07-12 21:50:45 +05301149
1150
1151Verify Host Power State
1152 [Documentation] Get the Host Power state and compare it with the expected state.
1153 [Arguments] ${expected_power_state}
1154
1155 # Description of argument(s):
1156 # expected_power_state State of Host e.g. Off or On.
1157
1158 ${power_state} ${health_status}= Redfish Get Host State
1159 Should Be Equal ${power_state} ${expected_power_state}
1160
1161
1162Verify Host Is Up
1163 [Documentation] Verify Host is Up.
1164
1165 Wait Until Keyword Succeeds 3 min 30 sec Verify Host Power State On
1166 # Python module: os_execute(cmd)
1167 Wait Until Keyword Succeeds 10 min 30 sec OS Execute Command uptime