blob: 43c5a2eecdf408473e34619a09b127f244c9572a [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
George Keishing9a288602021-12-10 04:50:25 -060011Resource ../lib/ipmi_client.robot
Michael Walsh391ba9b2017-08-24 11:36:24 -050012Library String
George Keishing30c12ff2016-09-02 10:25:29 -050013Library DateTime
14Library Process
Chris Austenb29d2e82016-06-07 12:25:35 -050015Library OperatingSystem
Michael Walsha6723f22016-11-22 11:12:01 -060016Library gen_print.py
Steven Sombaraaaab222018-12-19 13:16:23 -060017Library gen_misc.py
Michael Walsha6723f22016-11-22 11:12:01 -060018Library gen_robot_print.py
Michael Walsh5f3f4142017-05-22 17:09:47 -050019Library gen_cmd.py
Sunil Macd110a2017-05-23 04:14:32 -050020Library gen_robot_keyword.py
Michael Walshe53e47a2017-06-30 17:03:24 -050021Library bmc_ssh_utils.py
Michael Walshfdc5ced2017-08-17 13:15:15 -050022Library utils.py
Charles Paul Hofer35816152017-10-02 11:55:11 -050023Library var_funcs.py
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050024Library SCPLibrary WITH NAME scp
George Keishing61364e52019-10-01 12:01:19 -050025Library gen_robot_valid.py
George Keishing83c737b2022-05-17 12:12:04 -050026Library pldm_utils.py
Chris Austenb29d2e82016-06-07 12:25:35 -050027
Steven Sombarf60cbcf2018-12-07 08:12:18 -060028
Chris Austenb29d2e82016-06-07 12:25:35 -050029*** Variables ***
Steven Sombar0acb3412018-01-24 09:38:42 -060030
Steven Sombar0acb3412018-01-24 09:38:42 -060031${SYSTEM_SHUTDOWN_TIME} ${5}
32
Michael Walsha6723f22016-11-22 11:12:01 -060033# Assign default value to QUIET for programs which may not define it.
34${QUIET} ${0}
Steven Sombar0acb3412018-01-24 09:38:42 -060035
Sridevi Ramesh1699d372016-12-06 00:20:22 -060036${HOST_SETTING} ${SETTINGS_URI}host0
Steven Sombar0acb3412018-01-24 09:38:42 -060037
Steven Sombar0acb3412018-01-24 09:38:42 -060038${boot_prog_method} ${EMPTY}
Michael Walshfdc5ced2017-08-17 13:15:15 -050039${power_policy_setup} ${0}
40${bmc_power_policy_method} ${EMPTY}
Sridevi Ramesh13d84bf2022-10-31 09:14:52 -050041@{BOOT_PROGRESS_STATES} SystemHardwareInitializationComplete OSBootStarted OSRunning
Michael Walshfdc5ced2017-08-17 13:15:15 -050042
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050043
Chris Austenb29d2e82016-06-07 12:25:35 -050044*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060045
Steven Sombar0acb3412018-01-24 09:38:42 -060046
George Keishing5e870cd2016-08-24 10:05:47 -050047Verify Ping and REST Authentication
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -050048 [Documentation] Verify ping and rest authentication.
Michael Walsha6723f22016-11-22 11:12:01 -060049 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -050050 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -050051 Run Keyword If '${l_ping}' == '${False}'
52 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -050053
Michael Walsha6723f22016-11-22 11:12:01 -060054 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -050055 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -050056 Run Keyword If '${l_rest}' == '${False}'
57 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -050058
59 # Just to make sure the SSH is working for SCP
60 Open Connection And Log In
61 ${system} ${stderr}= Execute Command hostname return_stderr=True
62 Should Be Empty ${stderr}
63
Steven Sombar0acb3412018-01-24 09:38:42 -060064
George Keishing90b555a2021-05-20 11:54:16 -050065Verify Ping SSH And Redfish Authentication
66 [Documentation] Verify ping, SSH and redfish authentication.
67
68 ${l_ping}= Run Keyword And Return Status Ping Host ${OPENBMC_HOST}
69 Run Keyword If '${l_ping}' == '${False}' Fail msg=Ping Failed
70
71 ${l_rest}= Run Keyword And Return Status Redfish.Login
72 Run Keyword If '${l_rest}' == '${False}' Fail msg=REST Authentication Failed
73
74 # Just to make sure the SSH is working.
75 Open Connection And Log In
76 ${system} ${stderr}= Execute Command hostname return_stderr=True
77 Should Be Empty ${stderr}
78
79
George Keishingc4d3dc02016-09-19 03:45:55 -050080Check If BMC is Up
81 [Documentation] Wait for Host to be online. Checks every X seconds
82 ... interval for Y minutes and fails if timed out.
83 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -060084 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -050085 ... ${interval}=10 sec
86
Steven Sombar0acb3412018-01-24 09:38:42 -060087 # Description of argument(s):
88 # max_timeout Maximum time to wait.
89 # This should be expressed in Robot Framework's time format
90 # (e.g. "10 minutes").
George Keishing16b3c7b2021-01-28 09:23:37 -060091 # interval Interval to wait between status checks.
Steven Sombar0acb3412018-01-24 09:38:42 -060092 # This should be expressed in Robot Framework's time format
93 # (e.g. "5 seconds").
94
George Keishingc4d3dc02016-09-19 03:45:55 -050095 Wait Until Keyword Succeeds
96 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
97
George Keishingb3700812016-08-31 03:03:30 -050098
George Keishing06ae4aa2016-08-30 01:41:28 -050099Flush REST Sessions
100 [Documentation] Removes all the active session objects
101 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500102
Steven Sombar0acb3412018-01-24 09:38:42 -0600103
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600104Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -0500105 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600106 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Steven Sombar0acb3412018-01-24 09:38:42 -0600107
Michael Walshb5839d02017-04-12 16:11:20 -0500108 # Description of argument(s):
109 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
110 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600111 # sleep_time Time delay for host watchdog error to get injected.
112 # Default is 5 seconds.
113
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500114 ${data}= Create Dictionary
115 ... data=xyz.openbmc_project.State.Watchdog.Action.PowerCycle
116 ${status} ${result}= Run Keyword And Ignore Error
117 ... Read Attribute ${HOST_WATCHDOG_URI} ExpireAction
118 Run Keyword If '${status}' == 'PASS'
119 ... Write Attribute ${HOST_WATCHDOG_URI} ExpireAction data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -0500120
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600121 ${int_milliseconds}= Convert To Integer ${milliseconds}
122 ${data}= Create Dictionary data=${int_milliseconds}
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500123 Write Attribute ${HOST_WATCHDOG_URI} Interval data=${data}
124
125 ${data}= Create Dictionary data=${True}
126 Write Attribute ${HOST_WATCHDOG_URI} Enabled data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -0500127
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600128 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500129
Steven Sombar0acb3412018-01-24 09:38:42 -0600130
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500131Login To OS Host
Steven Sombar0acb3412018-01-24 09:38:42 -0600132 [Documentation] Login to OS Host and return the Login response code.
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500133 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
134 ... ${os_password}=${OS_PASSWORD}
Steven Sombar0acb3412018-01-24 09:38:42 -0600135
Gunnar Mills28e403b2017-10-25 16:16:38 -0500136 # Description of arguments:
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500137 # ${os_host} IP address of the OS Host.
138 # ${os_username} OS Host Login user name.
139 # ${os_password} OS Host Login passwrd.
140
George Keishing1856d332021-11-15 08:38:53 -0600141 Redfish Power On stack_mode=skip quiet=1
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500142
George Keishing3f223b82017-06-28 03:50:35 -0500143 SSHLibrary.Open Connection ${os_host}
George Keishinge0030882019-02-21 03:48:27 -0600144 ${resp}= SSHLibrary.Login ${os_username} ${os_password}
Sridevi Rameshea36b412017-03-09 04:08:02 -0600145 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -0500146
Steven Sombar0acb3412018-01-24 09:38:42 -0600147
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600148Initiate Auto Reboot
149 [Documentation] Initiate an auto reboot.
150 [Arguments] ${milliseconds}=5000
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500151
152 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600153 # milliseconds The number of milliseconds for the watchdog timer.
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500154
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600155 # Set the auto reboot policy.
156 Set Auto Reboot ${1}
157 # Set the watchdog timer.
158 Trigger Host Watchdog Error ${milliseconds}
159
160
161Initiate OS Host Reboot
162 [Documentation] Initiate an OS reboot.
163 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
164 ... ${os_password}=${OS_PASSWORD}
165
166 # Description of argument(s):
167 # os_host The host name or IP address of the OS.
168 # os_username The username to be used to sign in to the OS.
169 # os_password The password to be used to sign in to the OS.
170
171 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
172 ... Set Variable reboot
173 ... ELSE
174 ... Set Variable echo ${os_password} | sudo -S reboot
175
176 ${output} ${stderr} ${rc}= OS Execute Command
177 ... ${cmd_buf} fork=${1}
178
179
180Initiate OS Host Power Off
181 [Documentation] Initiate an OS reboot.
182 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
183 ... ${os_password}=${OS_PASSWORD} ${hard}=${0}
184
185 # Description of argument(s):
186 # os_host The DNS name or IP of the OS.
187 # os_username The username to be used to sign in to the OS.
188 # os_password The password to be used to sign in to the OS.
189 # hard Indicates whether to do a hard vs. soft power off.
190
191 ${time_string}= Run Keyword If ${hard} Set Variable ${SPACE}now
192 ... ELSE Set Variable ${EMPTY}
193
194 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
195 ... Set Variable shutdown${time_string}
196 ... ELSE
197 ... Set Variable echo ${os_password} | sudo -S shutdown${time_string}
198
199 ${output} ${stderr} ${rc}= OS Execute Command
200 ... ${cmd_buf} fork=${1}
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500201
George Keishing3987a1e2017-09-20 09:13:02 -0500202
Steven Sombar5f3af442018-02-14 08:30:15 -0600203Set System LED State
204 [Documentation] Set given system LED via REST.
205 [Arguments] ${led_name} ${led_state}
206 # Description of argument(s):
207 # led_name System LED name (e.g. heartbeat, identify, beep).
208 # led_state LED state to be set (e.g. On, Off).
209
210 ${args}= Create Dictionary
211 ... data=xyz.openbmc_project.Led.Physical.Action.${led_state}
212 Write Attribute ${LED_PHYSICAL_URI}${led_name} State data=${args}
213
214 Verify LED State ${led_name} ${led_state}
215
216
Steven Sombaraaf72c42017-09-05 12:02:00 -0500217Read Turbo Setting Via REST
218 [Documentation] Return turbo setting via REST.
Steven Sombarea79a492018-04-18 11:14:57 -0500219 # Returns 1 if TurboAllowed, 0 if not.
Steven Sombaraaf72c42017-09-05 12:02:00 -0500220
Steven Sombarea79a492018-04-18 11:14:57 -0500221 ${turbo_setting}= Read Attribute
222 ... ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
223 [Return] ${turbo_setting}
224
Steven Sombaraaf72c42017-09-05 12:02:00 -0500225
Steven Sombaraaf72c42017-09-05 12:02:00 -0500226Set Turbo Setting Via REST
227 [Documentation] Set turbo setting via REST.
Steven Sombar80bc8592018-04-24 11:44:53 -0500228 [Arguments] ${setting} ${verify}=${False}
Steven Sombar0acb3412018-01-24 09:38:42 -0600229
Steven Sombaraaf72c42017-09-05 12:02:00 -0500230 # Description of argument(s):
Steven Sombar80bc8592018-04-24 11:44:53 -0500231 # setting State to set TurboAllowed, 1=allowed, 0=not allowed.
232 # verify If True, read the TurboAllowed setting to confirm.
Steven Sombaraaf72c42017-09-05 12:02:00 -0500233
Steven Sombarea79a492018-04-18 11:14:57 -0500234 ${data}= Create Dictionary data=${${setting}}
Steven Sombar80bc8592018-04-24 11:44:53 -0500235 Write Attribute ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
236 ... verify=${verify} data=${data}
George Keishingef74a8c2017-10-20 10:23:52 -0500237
Steven Sombar0acb3412018-01-24 09:38:42 -0600238
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600239Set REST Logging Policy
240 [Documentation] Enable or disable REST logging setting.
241 [Arguments] ${policy_setting}=${True}
George Keishingef74a8c2017-10-20 10:23:52 -0500242
243 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600244 # policy_setting The policy setting value which can be either
245 # True or False.
George Keishingef74a8c2017-10-20 10:23:52 -0500246
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600247 ${log_dict}= Create Dictionary data=${policy_setting}
George Keishingdf3e65f2018-12-18 13:06:56 -0600248 Write Attribute ${BMC_LOGGING_URI}rest_api_logs Enabled
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600249 ... data=${log_dict} verify=${1} expected_value=${policy_setting}
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -0500250
Steven Sombar0acb3412018-01-24 09:38:42 -0600251
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600252Old Get Boot Progress
253 [Documentation] Get the boot progress the old way (via org location).
254 [Arguments] ${quiet}=${QUIET}
George Keishing034902d2017-11-10 13:15:38 -0600255
256 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600257 # quiet Indicates whether this keyword should run without any output to
258 # the console.
259
260 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
261 ... value quiet=${quiet}
262
263 [Return] ${state}
264
265
266Set Boot Progress Method
267 [Documentation] Set the boot_prog_method to either 'Old' or 'New'.
268
269 # The boot progress data has moved from an 'org' location to an 'xyz'
270 # location. This keyword will determine whether the new method of getting
271 # the boot progress is valid and will set the global boot_prog_method
272 # variable accordingly. If boot_prog_method is already set (either by a
273 # prior call to this function or via a -v parm), this keyword will simply
274 # return.
275
276 # Note: There are interim builds that contain boot_progress in both the
277 # old and the new location values. It is nearly impossible for this
278 # keyword to determine whether the old boot_progress or the new one is
279 # active. When using such builds where the old boot_progress is active,
280 # the only recourse users will have is that they may specify
281 # -v boot_prog_method:Old to force old behavior on such builds.
282
283 Run Keyword If '${boot_prog_method}' != '${EMPTY}' Return From Keyword
284
285 ${new_status} ${new_value}= Run Keyword And Ignore Error
286 ... New Get Boot Progress
287 # If the new style read fails, the method must necessarily be "Old".
288 Run Keyword If '${new_status}' == 'PASS'
289 ... Run Keywords
290 ... Set Global Variable ${boot_prog_method} New AND
291 ... Rqpvars boot_prog_method AND
292 ... Return From Keyword
293
294 # Default method is "Old".
295 Set Global Variable ${boot_prog_method} Old
296 Rqpvars boot_prog_method
297
298
299Initiate Power On
300 [Documentation] Initiates the power on and waits until the Is Power On
301 ... keyword returns that the power state has switched to on.
302 [Arguments] ${wait}=${1}
303
304 # Description of argument(s):
305 # wait Indicates whether to wait for a powered on state after issuing
306 # the power on command.
307
308 @{arglist}= Create List
309 ${args}= Create Dictionary data=@{arglist}
310 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
311 ... data=${args}
312 should be equal as strings ${resp.status_code} ${HTTP_OK}
313
314 # Does caller want to wait for power on status?
315 Run Keyword If '${wait}' == '${0}' Return From Keyword
316 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
317
318
319Initiate Power Off
320 [Documentation] Initiates the power off and waits until the Is Power Off
321 ... keyword returns that the power state has switched to off.
322
323 @{arglist}= Create List
324 ${args}= Create Dictionary data=@{arglist}
325 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
326 ... data=${args}
327 should be equal as strings ${resp.status_code} ${HTTP_OK}
328 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
329
330
331Get Boot Progress
332 [Documentation] Get the boot progress and return it.
333 [Arguments] ${quiet}=${QUIET}
334
335 # Description of argument(s):
336 # quiet Indicates whether this keyword should run without any output to
337 # the console.
338
339 Set Boot Progress Method
340 ${state}= Run Keyword If '${boot_prog_method}' == 'New'
341 ... New Get Boot Progress quiet=${quiet}
342 ... ELSE
343 ... Old Get Boot Progress quiet=${quiet}
344
345 [Return] ${state}
346
347
348New Get Boot Progress
349 [Documentation] Get the boot progress the new way (via xyz location).
350 [Arguments] ${quiet}=${QUIET}
351
352 # Description of argument(s):
353 # quiet Indicates whether this keyword should run without any output to
354 # the console.
355
356 ${state}= Read Attribute ${HOST_STATE_URI} BootProgress quiet=${quiet}
357
358 [Return] ${state.rsplit('.', 1)[1]}
359
360
361New Get Power Policy
362 [Documentation] Returns the BMC power policy (new method).
363 ${currentPolicy}= Read Attribute ${POWER_RESTORE_URI} PowerRestorePolicy
364
365 [Return] ${currentPolicy}
366
367
368Old Get Power Policy
369 [Documentation] Returns the BMC power policy (old method).
370 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
371
372 [Return] ${currentPolicy}
373
374
George Keishinga54e06f2020-06-12 10:42:41 -0500375Redfish Get Power Restore Policy
376 [Documentation] Returns the BMC power restore policy.
377
378 ${power_restore_policy}= Redfish.Get Attribute /redfish/v1/Systems/system PowerRestorePolicy
379 [Return] ${power_restore_policy}
380
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600381Get Auto Reboot
382 [Documentation] Returns auto reboot setting.
383 ${setting}= Read Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot
384
385 [Return] ${setting}
386
387
George Keishingc8a6dd22020-06-12 12:01:33 -0500388Redfish Get Auto Reboot
389 [Documentation] Returns auto reboot setting.
390
George Keishinga8cb28d2020-06-15 03:10:29 -0500391 ${resp}= Redfish.Get Attribute /redfish/v1/Systems/system Boot
George Keishinga8cb28d2020-06-15 03:10:29 -0500392 [Return] ${resp["AutomaticRetryConfig"]}
George Keishingc8a6dd22020-06-12 12:01:33 -0500393
394
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600395Trigger Warm Reset
396 [Documentation] Initiate a warm reset.
397
398 log to console "Triggering warm reset"
399 ${data}= create dictionary data=@{EMPTY}
George Keishingfbd67002022-08-01 11:24:03 -0500400 ${resp}= Openbmc Post Request
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600401 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
402 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
403 ${session_active}= Check If warmReset is Initiated
404 Run Keyword If '${session_active}' == '${True}'
405 ... Fail msg=warm reset didn't occur
406
407 Sleep ${SYSTEM_SHUTDOWN_TIME}min
408 Check If BMC Is Up
409
410
411Get Power State
412 [Documentation] Returns the power state as an integer. Either 0 or 1.
413 [Arguments] ${quiet}=${QUIET}
414
415 # Description of argument(s):
416 # quiet Indicates whether this keyword should run without any output to
417 # the console.
418
419 @{arglist}= Create List
420 ${args}= Create Dictionary data=@{arglist}
421
422 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
423 ... data=${args} quiet=${quiet}
424 Should be equal as strings ${resp.status_code} ${HTTP_OK}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600425
George Keishingfbd67002022-08-01 11:24:03 -0500426 [Return] ${resp.json()["data"]}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600427
428
429Clear BMC Gard Record
430 [Documentation] Clear gard records from the system.
431
432 @{arglist}= Create List
433 ${args}= Create Dictionary data=@{arglist}
434 ${resp}= Call Method
435 ... ${OPENPOWER_CONTROL}gard Reset data=${args}
436 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
437
438
439Flash PNOR
440 [Documentation] Calls flash bios update method to flash PNOR image
441 [Arguments] ${pnor_image}
442
443 # Description of argument(s):
444 # pnor_image The filename and path of the PNOR image
445 # (e.g. "/home/image/zaius.pnor").
446
447 @{arglist}= Create List ${pnor_image}
448 ${args}= Create Dictionary data=@{arglist}
449 ${resp}= Call Method /org/openbmc/control/flash/bios/ update
450 ... data=${args}
451 should be equal as strings ${resp.status_code} ${HTTP_OK}
452 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
453
454
455Get Flash BIOS Status
456 [Documentation] Returns the status of the flash BIOS API as a string. For
457 ... example 'Flashing', 'Flash Done', etc
458 ${data}= Read Properties /org/openbmc/control/flash/bios
459 [Return] ${data['status']}
460
461
462Is PNOR Flashing
463 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
464 ... flashing has started.
465 ${status}= Get Flash BIOS Status
466 Should Contain ${status} Flashing
467
468
469Is PNOR Flash Done
470 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
471 ... PNOR flashing has completed.
472 ${status}= Get Flash BIOS Status
473 should be equal as strings ${status} Flash Done
474
475
476Create OS Console File Path
477 [Documentation] Create OS console file path name and return it.
478 [Arguments] ${log_file_path}=${EMPTY}
479
480 # Description of arguments:
481 # file_path The caller's candidate value. If this value is ${EMPTY}, this
482 # keyword will compose a file path name. Otherwise, this
483 # keyword will use the caller's file_path value. In either
484 # case, the value will be returned.
485
486 ${status}= Run Keyword And Return Status Variable Should Exist
487 ... ${TEST_NAME}
488
489 ${default_file_path}= Set Variable If ${status} == ${TRUE}
George Keishing9161b102021-12-10 02:26:30 -0600490 ... ${EXECDIR}${/}tmp${/}${OPENBMC_HOST}_${TEST_NAME.replace(' ', '')}_os_console.txt
491 ... ${EXECDIR}${/}tmp${/}${OPENBMC_HOST}_os_console.txt
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600492
493 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
494 ... ${default_file_path} ${log_file_path}
495
496 [Return] ${log_file_path}
497
498
499Get Endpoint Paths
500 [Documentation] Returns all url paths ending with given endpoint
501 ... Example:
502 ... Given the following endpoint: cpu
503 ... This keyword will return: list of all urls ending with
504 ... cpu -
505 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
506 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
507 [Arguments] ${path} ${endpoint}
508
509 # Description of arguments:
510 # path URL path for enumeration.
511 # endpoint Endpoint string (url path ending).
512
Steven Sombaraaaab222018-12-19 13:16:23 -0600513 # Make sure path ends with slash.
514 ${path}= Add Trailing Slash ${path}
515
516 ${resp}= Read Properties ${path}enumerate timeout=30
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600517 Log Dictionary ${resp}
518
519 ${list}= Get Dictionary Keys ${resp}
520 # For a given string, look for prefix and suffix for matching expression.
521 # Start of string followed by zero or more of any character followed by
522 # any digit or lower case character.
George Keishing585afa32020-07-09 04:55:15 -0500523 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}\[_0-9a-z]*$ case_insensitive=${True}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600524
525 [Return] ${resp}
526
527
528Set BMC Power Policy
529 [Documentation] Set the given BMC power policy.
530 [Arguments] ${policy}
531
532 # Note that this function will translate the old style "RESTORE_LAST_STATE"
533 # policy to the new style "xyz.openbmc_project.Control.Power.RestorePolicy.
534 # Policy.Restore" for you.
535
536 # Description of argument(s):
537 # policy Power restore policy (e.g "RESTORE_LAST_STATE",
538 # ${RESTORE_LAST_STATE}).
539
540 # Set the bmc_power_policy_method to either 'Old' or 'New'.
541 Set Power Policy Method
542 # This translation helps bridge between old and new method for calling.
543 ${policy}= Translate Power Policy Value ${policy}
544 # Run the appropriate keyword.
545 Run Key ${bmc_power_policy_method} Set Power Policy \ ${policy}
546 ${currentPolicy}= Get System Power Policy
547 Should Be Equal ${currentPolicy} ${policy}
548
549
550Delete Error Logs
551 [Documentation] Delete error logs.
Michael Sheposcc490b42020-08-26 12:53:01 -0500552 [Arguments] ${quiet}=${0}
553 # Description of argument(s):
554 # quiet If enabled, turns off logging to console.
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600555
556 # Check if error logs entries exist, if not return.
Steven Sombara8800da2018-12-18 16:19:05 -0600557 ${resp}= OpenBMC Get Request ${BMC_LOGGING_ENTRY}list quiet=${1}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600558 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND}
559
560 # Get the list of error logs entries and delete them all.
561 ${elog_entries}= Get URL List ${BMC_LOGGING_ENTRY}
David Shaw79247e42020-06-18 17:16:02 -0500562 FOR ${entry} IN @{elog_entries}
Michael Sheposcc490b42020-08-26 12:53:01 -0500563 Delete Error Log Entry ${entry} quiet=${quiet}
David Shaw79247e42020-06-18 17:16:02 -0500564 END
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600565
566
567Delete All Error Logs
568 [Documentation] Delete all error log entries using "DeleteAll" interface.
569
George Keishingfbd67002022-08-01 11:24:03 -0500570 ${args}= Set Variable {"data": []}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600571 ${resp}= Openbmc Post Request ${BMC_LOGGING_URI}action/DeleteAll
George Keishingfbd67002022-08-01 11:24:03 -0500572 ... data=${args}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600573 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
574
575
576Get Elog URL List
577 [Documentation] Return error log entry list of URLs.
578
579 ${url_list}= Read Properties /xyz/openbmc_project/logging/entry/
580 Sort List ${url_list}
581 [Return] ${url_list}
582
583
584Get BMC Flash Chip Boot Side
585 [Documentation] Return the BMC flash chip boot side.
George Keishing034902d2017-11-10 13:15:38 -0600586
587 # Example:
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600588 # 0 - indicates chip select is current side.
589 # 32 - indicates chip select is alternate side.
George Keishing034902d2017-11-10 13:15:38 -0600590
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600591 ${boot_side} ${stderr} ${rc}= BMC Execute Command
592 ... cat /sys/class/watchdog/watchdog1/bootstatus
593
594 [Return] ${boot_side}
595
596
Sweta Potthuri7d3af3c2018-01-29 03:07:07 -0600597Watchdog Object Should Exist
598 [Documentation] Check that watchdog object exists.
599
600 ${resp}= OpenBMC Get Request ${WATCHDOG_URI}host0
601 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
602 ... msg=Expected watchdog object does not exist.
Sweta Potthurif39022d2018-02-06 03:40:07 -0600603
604
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600605Get System LED State
606 [Documentation] Return the state of given system LED.
607 [Arguments] ${led_name}
Sweta Potthurif39022d2018-02-06 03:40:07 -0600608
609 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600610 # led_name System LED name (e.g. heartbeat, identify, beep).
Sweta Potthurif39022d2018-02-06 03:40:07 -0600611
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600612 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State
613 [Return] ${state.rsplit('.', 1)[1]}
George Keishingb9f407b2018-02-20 00:07:46 -0600614
615
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600616Verify LED State
617 [Documentation] Checks if LED is in given state.
618 [Arguments] ${led_name} ${led_state}
619 # Description of argument(s):
620 # led_name System LED name (e.g. heartbeat, identify, beep).
621 # led_state LED state to be verified (e.g. On, Off).
George Keishingb9f407b2018-02-20 00:07:46 -0600622
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600623 ${state}= Get System LED State ${led_name}
624 Should Be Equal ${state} ${led_state}
George Keishingb9f407b2018-02-20 00:07:46 -0600625
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600626
627Get LED State XYZ
628 [Documentation] Returns state of given LED.
629 [Arguments] ${led_name}
630
631 # Description of argument(s):
632 # led_name Name of LED.
633
634 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
635 # Returns the state of the LED, either On or Off.
636 [Return] ${state}
George Keishingb9f407b2018-02-20 00:07:46 -0600637
George Keishing78ce8dc2018-03-30 11:49:06 -0500638
639Verify Identify LED State
Alvin Wang32f7b3d2019-07-25 02:05:39 -0500640 [Documentation] Verify that the identify state of the LED group matches caller's expectations.
George Keishing78ce8dc2018-03-30 11:49:06 -0500641 [Arguments] ${expected_state}
642
643 # Description of argument(s):
Alvin Wang32f7b3d2019-07-25 02:05:39 -0500644 # expected_state The expected LED asserted state (1 = asserted, 0 = not asserted).
George Keishing78ce8dc2018-03-30 11:49:06 -0500645
Alvin Wang32f7b3d2019-07-25 02:05:39 -0500646 ${led_state}= Get LED State XYZ enclosure_identify
647 Should Be Equal ${led_state} ${expected_state} msg=Unexpected LED state.
Sweta Potthuri39255032018-03-28 10:12:14 -0500648
649Verify The Attribute
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500650 [Documentation] Verify the given attribute.
Sweta Potthuri39255032018-03-28 10:12:14 -0500651 [Arguments] ${uri} ${attribute_name} ${attribute_value}
652
653 # Description of argument(s):
654 # uri URI path
655 # (e.g. "/xyz/openbmc_project/control/host0/TPMEnable").
656 # attribute_name Name of attribute to be verified (e.g. "TPMEnable").
657 # attribute_value The expected value of attribute (e.g. "1", "0", etc.)
658
659 ${output}= Read Attribute ${uri} ${attribute_name}
660 Should Be Equal ${attribute_value} ${output}
661 ... msg=Attribute "${attribute_name} does not have the expected value.
George Keishingcf0d7772018-05-04 08:22:50 -0500662
663
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600664New Set Power Policy
665 [Documentation] Set the given BMC power policy (new method).
666 [Arguments] ${policy}
George Keishingb4adfc72018-10-26 09:39:32 -0500667
668 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600669 # policy Power restore policy (e.g. ${ALWAYS_POWER_OFF}).
George Keishingc5fef582018-07-18 08:41:28 -0500670
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600671 ${valueDict}= Create Dictionary data=${policy}
672 Write Attribute
673 ... ${POWER_RESTORE_URI} PowerRestorePolicy data=${valueDict}
George Keishing216e5842018-08-31 14:58:15 -0500674
675
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600676Old Set Power Policy
677 [Documentation] Set the given BMC power policy (old method).
678 [Arguments] ${policy}
George Keishing3c004dc2018-10-10 07:16:47 -0500679
680 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600681 # policy Power restore policy (e.g. "ALWAYS_POWER_OFF").
682
683 ${valueDict}= create dictionary data=${policy}
684 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
George Keishing3c004dc2018-10-10 07:16:47 -0500685
686
George Keishinga54e06f2020-06-12 10:42:41 -0500687Redfish Set Power Restore Policy
688 [Documentation] Set the BMC power restore policy.
689 [Arguments] ${power_restore_policy}
690
691 # Description of argument(s):
692 # power_restore_policy Power restore policy (e.g. "AlwaysOff", "AlwaysOn", "LastState").
693
694 Redfish.Patch /redfish/v1/Systems/system body={"PowerRestorePolicy": "${power_restore_policy}"}
695 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
696
697
George Keishing9a288602021-12-10 04:50:25 -0600698IPMI Set Power Restore Policy
699 [Documentation] Set the BMC power restore policy using IPMI.
700 [Arguments] ${power_restore_policy}=always-off
701
702 # Description of argument(s):
703 # power_restore_policy Power restore policies
704 # always-on : turn on when power is restored
705 # previous : return to previous state when power is restored
706 # always-off : stay off after power is restored
707
708 ${resp}= Run IPMI Standard Command chassis policy ${power_restore_policy}
709 # Example: Set chassis power restore policy to always-off
710 Should Contain ${resp} ${power_restore_policy}
711
712
George Keishinga5cedb32020-07-17 15:50:34 -0500713Set Auto Reboot Setting
714 [Documentation] Set the given auto reboot setting (REST or Redfish).
715 [Arguments] ${value}
716
717 # Description of argument(s):
718 # value The reboot setting, 1 for enabling and 0 for disabling.
719
720 # This is to cater to boot call points and plugin script which will always
721 # send using value 0 or 1. This dictionary maps to redfish string values.
722 ${rest_redfish_dict}= Create Dictionary
723 ... 1=RetryAttempts
724 ... 0=Disabled
725
George Keishinge1879642020-12-09 13:20:15 -0600726 Run Keyword If ${REDFISH_SUPPORT_TRANS_STATE} == ${1}
George Keishinga5cedb32020-07-17 15:50:34 -0500727 ... Redfish Set Auto Reboot ${rest_redfish_dict["${value}"]}
George Keishinge1879642020-12-09 13:20:15 -0600728 ... ELSE
729 ... Set Auto Reboot ${value}
George Keishinga5cedb32020-07-17 15:50:34 -0500730
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600731Set Auto Reboot
732 [Documentation] Set the given auto reboot setting.
733 [Arguments] ${setting}
George Keishing3c004dc2018-10-10 07:16:47 -0500734
735 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600736 # setting The reboot setting, 1 for enabling and 0 for disabling.
George Keishing3c004dc2018-10-10 07:16:47 -0500737
Sridevi Ramesh68d72ff2019-02-04 09:24:46 -0600738 ${valueDict}= Convert To Integer ${setting}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600739 ${data}= Create Dictionary data=${valueDict}
740 Write Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot data=${data}
741 ${current_setting}= Get Auto Reboot
742 Should Be Equal As Integers ${current_setting} ${setting}
George Keishing3c004dc2018-10-10 07:16:47 -0500743
George Keishingc25c55d2018-10-30 02:23:44 -0500744
George Keishingc8a6dd22020-06-12 12:01:33 -0500745Redfish Set Auto Reboot
746 [Documentation] Set the given auto reboot setting.
747 [Arguments] ${setting}
748
749 # Description of argument(s):
750 # setting The reboot setting, "RetryAttempts" and "Disabled".
751
George Keishinga8cb28d2020-06-15 03:10:29 -0500752 Redfish.Patch /redfish/v1/Systems/system body={"Boot": {"AutomaticRetryConfig": "${setting}"}}
753 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
George Keishinga8cb28d2020-06-15 03:10:29 -0500754
George Keishingc8a6dd22020-06-12 12:01:33 -0500755 ${current_setting}= Redfish Get Auto Reboot
756 Should Be Equal As Strings ${current_setting} ${setting}
757
758
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600759Set Control Boot Mode
760 [Documentation] Set given boot mode on the boot object path attribute.
761 [Arguments] ${boot_path} ${boot_mode}
George Keishingc25c55d2018-10-30 02:23:44 -0500762
763 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600764 # boot_path Boot object path.
765 # Example:
766 # /xyz/openbmc_project/control/host0/boot
767 # /xyz/openbmc_project/control/host0/boot/one_time
768 # boot_mode Boot mode which need to be set.
769 # Example:
770 # "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"
George Keishingc25c55d2018-10-30 02:23:44 -0500771
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600772 ${valueDict}= Create Dictionary data=${boot_mode}
773 Write Attribute ${boot_path} BootMode data=${valueDict}
George Keishingc25c55d2018-10-30 02:23:44 -0500774
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600775
776Is Power On
777 [Documentation] Verify that the BMC chassis state is on.
778 ${state}= Get Power State
779 Should be equal ${state} ${1}
780
781
782Is Power Off
783 [Documentation] Verify that the BMC chassis state is off.
784 ${state}= Get Power State
785 Should be equal ${state} ${0}
Sivas SRR0e3bc6d2019-04-23 08:36:35 -0500786
787
788CLI Get BMC DateTime
789 [Documentation] Returns BMC date time from date command.
790
791 ${bmc_time_via_date} ${stderr} ${rc}= BMC Execute Command date +"%Y-%m-%d %H:%M:%S" print_err=1
792 [Return] ${bmc_time_via_date}
George Keishing61364e52019-10-01 12:01:19 -0500793
794
795Update Root Password
796 [Documentation] Update system "root" user password.
797 [Arguments] ${openbmc_password}=${OPENBMC_PASSWORD}
798
799 # Description of argument(s):
800 # openbmc_password The root password for the open BMC system.
801
802 @{password}= Create List ${openbmc_password}
803 ${data}= Create Dictionary data=@{password}
804
805 ${headers}= Create Dictionary Content-Type=application/json X-Auth-Token=${XAUTH_TOKEN}
George Keishingfbd67002022-08-01 11:24:03 -0500806 ${resp}= POST On Session openbmc ${BMC_USER_URI}root/action/SetPassword
George Keishing61364e52019-10-01 12:01:19 -0500807 ... data=${data} headers=${headers}
808 Valid Value resp.status_code [${HTTP_OK}]
Sushil Singh6624ce52020-01-22 00:53:41 -0600809
810
811Get Post Boot Action
812 [Documentation] Get post boot action.
813
George Keishing879f0842020-02-05 11:00:47 -0600814 # Post code update action dictionary.
Sushil Singh6624ce52020-01-22 00:53:41 -0600815 #
816 # {
817 # BMC image: {
818 # OnReset: Redfish OBMC Reboot (off),
819 # Immediate: Wait For Reboot start_boot_seconds=${state['epoch_seconds']}
820 # },
821 # Host image: {
George Keishinge523fc02020-03-23 12:28:01 -0500822 # OnReset: RF SYS GracefulRestart,
Sushil Singh6624ce52020-01-22 00:53:41 -0600823 # Immediate: Wait State os_running_match_state 10 mins
824 # }
825 # }
826
827 ${code_base_dir_path}= Get Code Base Dir Path
828 ${post_code_update_actions}= Evaluate
829 ... json.load(open('${code_base_dir_path}data/applytime_table.json')) modules=json
830 Rprint Vars post_code_update_actions
831
832 [Return] ${post_code_update_actions}
833
George Keishing1eeff9c2020-06-16 04:03:34 -0500834
Sushil Singh1560e652022-08-03 13:25:01 -0500835Get Task State From File
836 [Documentation] Get task states from pre-define data/task_state.json file.
837
838 # Example: Task state JSON format.
839 #
840 # {
841 # "TaskRunning": {
842 # "TaskState": "Running",
843 # "TaskStatus": "OK"
844 # },
845 # "TaskCompleted": {
846 # "TaskState": "Completed",
847 # "TaskStatus": "OK"
848 # },
849 # "TaskException": {
850 # "TaskState": "Exception",
851 # "TaskStatus": "Warning"
852 # }
853 # }
854
855 # Python module: get_code_base_dir_path()
856 ${code_base_dir_path}= Get Code Base Dir Path
857 ${task_state}= Evaluate
858 ... json.load(open('${code_base_dir_path}data/task_state.json')) modules=json
859 Rprint Vars task_state
860
861 [Return] ${task_state}
862
863
George Keishing1eeff9c2020-06-16 04:03:34 -0500864Redfish Set Boot Default
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300865 [Documentation] Set and Verify Boot source override
866 [Arguments] ${override_enabled} ${override_target} ${override_mode}=UEFI
George Keishing1eeff9c2020-06-16 04:03:34 -0500867
868 # Description of argument(s):
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300869 # override_enabled Boot source override enable type.
George Keishing1eeff9c2020-06-16 04:03:34 -0500870 # ('Once', 'Continuous', 'Disabled').
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300871 # override_target Boot source override target.
George Keishing1eeff9c2020-06-16 04:03:34 -0500872 # ('Pxe', 'Cd', 'Hdd', 'Diags', 'BiosSetup', 'None').
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300873 # override_mode Boot source override mode (relevant only for x86 arch).
874 # ('Legacy', 'UEFI').
George Keishing1eeff9c2020-06-16 04:03:34 -0500875
876 ${data}= Create Dictionary BootSourceOverrideEnabled=${override_enabled}
877 ... BootSourceOverrideTarget=${override_target}
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300878
879 Run Keyword If '${PLATFORM_ARCH_TYPE}' == 'x86'
880 ... Set To Dictionary ${data} BootSourceOverrideMode ${override_mode}
881
George Keishing1eeff9c2020-06-16 04:03:34 -0500882 ${payload}= Create Dictionary Boot=${data}
883
884 Redfish.Patch /redfish/v1/Systems/system body=&{payload}
885 ... valid_status_codes=[${HTTP_OK},${HTTP_NO_CONTENT}]
886
887 ${resp}= Redfish.Get Attribute /redfish/v1/Systems/system Boot
888 Should Be Equal As Strings ${resp["BootSourceOverrideEnabled"]} ${override_enabled}
889 Should Be Equal As Strings ${resp["BootSourceOverrideTarget"]} ${override_target}
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300890 Run Keyword If '${PLATFORM_ARCH_TYPE}' == 'x86'
891 ... Should Be Equal As Strings ${resp["BootSourceOverrideMode"]} ${override_mode}
George Keishinge1879642020-12-09 13:20:15 -0600892
893
894# Redfish state keywords.
895
896Redfish Get BMC State
897 [Documentation] Return BMC health state.
898
899 # "Enabled" -> BMC Ready, "Starting" -> BMC NotReady
900
901 # Example:
902 # "Status": {
903 # "Health": "OK",
904 # "HealthRollup": "OK",
905 # "State": "Enabled"
906 # },
907
908 ${status}= Redfish.Get Attribute /redfish/v1/Managers/bmc Status
909 [Return] ${status["State"]}
910
911
912Redfish Get Host State
913 [Documentation] Return host power and health state.
914
915 # Refer: http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status
916
917 # Example:
918 # "PowerState": "Off",
919 # "Status": {
920 # "Health": "OK",
921 # "HealthRollup": "OK",
922 # "State": "StandbyOffline"
923 # },
924
George Keishingb51d1502021-03-25 03:30:33 -0500925 ${chassis}= Redfish.Get Properties /redfish/v1/Chassis/${CHASSIS_ID}
George Keishinge1879642020-12-09 13:20:15 -0600926 [Return] ${chassis["PowerState"]} ${chassis["Status"]["State"]}
927
928
929Redfish Get Boot Progress
930 [Documentation] Return boot progress state.
931
932 # Example: /redfish/v1/Systems/system/
933 # "BootProgress": {
934 # "LastState": "OSRunning"
935 # },
936
937 ${boot_progress}= Redfish.Get Properties /redfish/v1/Systems/system/
George Keishingb51d1502021-03-25 03:30:33 -0500938
939 Return From Keyword If "${PLATFORM_ARCH_TYPE}" == "x86"
940 ... NA ${boot_progress["Status"]["State"]}
941
George Keishinge1879642020-12-09 13:20:15 -0600942 [Return] ${boot_progress["BootProgress"]["LastState"]} ${boot_progress["Status"]["State"]}
943
944
945Redfish Get States
946 [Documentation] Return all the BMC and host states in dictionary.
George Keishing366033f2021-04-01 13:49:06 -0500947 [Timeout] 120 Seconds
George Keishinge1879642020-12-09 13:20:15 -0600948
949 # Refer: openbmc/docs/designs/boot-progress.md
950
George Keishing205f95f2021-03-10 02:25:53 -0600951 Redfish.Login
George Keishinge1879642020-12-09 13:20:15 -0600952
953 ${bmc_state}= Redfish Get BMC State
954 ${chassis_state} ${chassis_status}= Redfish Get Host State
955 ${boot_progress} ${host_state}= Redfish Get Boot Progress
956
957 ${states}= Create Dictionary
958 ... bmc=${bmc_state}
959 ... chassis=${chassis_state}
960 ... host=${host_state}
961 ... boot_progress=${boot_progress}
962
George Keishing64293c52021-03-24 08:21:23 -0500963 # Disable loggoing state to prevent huge log.html record when boot
964 # test is run in loops.
965 #Log ${states}
George Keishing95cf8652021-02-08 11:32:33 -0600966
George Keishinge1879642020-12-09 13:20:15 -0600967 [Return] ${states}
George Keishing95cf8652021-02-08 11:32:33 -0600968
969
970Is BMC Standby
971 [Documentation] Check if BMC is ready and host at standby.
972
973 ${standby_states}= Create Dictionary
974 ... bmc=Enabled
975 ... chassis=Off
976 ... host=Disabled
977 ... boot_progress=None
978
aravinth0510de1863d2022-06-27 17:26:14 +0000979 Run Keyword If '${PLATFORM_ARCH_TYPE}' == 'x86'
980 ... Set To Dictionary ${standby_states} boot_progress=NA
981
George Keishing95cf8652021-02-08 11:32:33 -0600982 Wait Until Keyword Succeeds 3 min 10 sec Redfish Get States
983
Sushil Singhb910d892021-11-17 05:34:29 -0600984 Wait Until Keyword Succeeds 2 min 10 sec Match State ${standby_states}
George Keishing95cf8652021-02-08 11:32:33 -0600985
986
987Match State
988 [Documentation] Check if the expected and current states are matched.
989 [Arguments] ${match_state}
990
991 # Description of argument(s):
992 # match_state Expected states in dictionary.
993
994 ${current_state}= Redfish Get States
995 Dictionaries Should Be Equal ${match_state} ${current_state}
Peter D Phan49739b22021-09-29 14:30:08 -0500996
997
998Redfish Initiate Auto Reboot
999 [Documentation] Initiate an auto reboot.
1000 [Arguments] ${interval}=2000
1001
1002 # Description of argument(s):
1003 # interval Value in milliseconds to set Watchdog interval
1004
1005 # Set auto reboot policy
1006 Redfish Set Auto Reboot RetryAttempts
1007
George Keishingc0701102021-09-30 12:12:04 -05001008 Redfish Power Operation On
George Keishinga4e13522022-04-13 11:14:53 -05001009
1010 Wait Until Keyword Succeeds 2 min 5 sec Is Boot Progress Changed
George Keishingc0701102021-09-30 12:12:04 -05001011
Peter D Phan49739b22021-09-29 14:30:08 -05001012 # Set watchdog timer
1013 Set Watchdog Interval Using Busctl ${interval}
1014
1015
George Keishinga4e13522022-04-13 11:14:53 -05001016Is Boot Progress Changed
1017 [Documentation] Get BootProgress state and expect boot state mismatch.
1018 [Arguments] ${boot_state}=None
1019
1020 # Description of argument(s):
1021 # boot_state Value of the BootProgress state to match against.
1022
1023 ${boot_progress} ${host_state}= Redfish Get Boot Progress
1024
1025 Should Not Be Equal ${boot_progress} ${boot_state}
1026
Peter D Phan49739b22021-09-29 14:30:08 -05001027
Sridevi Ramesh13d84bf2022-10-31 09:14:52 -05001028Is Boot Progress At Required State
1029 [Documentation] Get BootProgress state and expect boot state to match.
1030 [Arguments] ${boot_state}=None
1031
1032 # Description of argument(s):
1033 # boot_state Value of the BootProgress state to match.
1034
1035 ${boot_progress} ${host_state}= Redfish Get Boot Progress
1036
1037 Should Be Equal ${boot_progress} ${boot_state}
1038
1039
1040Is Boot Progress At Any State
1041 [Documentation] Get BootProgress state and expect boot state to match
1042 ... with any of the states mentioned in the list.
1043 [Arguments] ${boot_states}=@{BOOT_PROGRESS_STATES}
1044
1045 # Description of argument(s):
1046 # boot_states List of the BootProgress states to match.
1047
1048 ${boot_progress} ${host_state}= Redfish Get Boot Progress
1049 Should Contain Any ${boot_progress} @{boot_states}
1050
1051
Peter D Phan49739b22021-09-29 14:30:08 -05001052Set Watchdog Interval Using Busctl
1053 [Documentation] Set Watchdog time interval.
1054 [Arguments] ${milliseconds}=1000
1055
1056 # Description of argument(s):
George Keishing4b729492021-11-10 12:51:10 -06001057 # milliseconds Time interval for watchdog timer
Peter D Phan49739b22021-09-29 14:30:08 -05001058
George Keishingc0701102021-09-30 12:12:04 -05001059 ${cmd}= Catenate busctl set-property xyz.openbmc_project.Watchdog
1060 ... /xyz/openbmc_project/watchdog/host0
1061 ... xyz.openbmc_project.State.Watchdog Interval t ${milliseconds}
Peter D Phan49739b22021-09-29 14:30:08 -05001062 BMC Execute Command ${cmd}
1063
George Keishingf5fec0d2021-10-08 12:38:45 -05001064
1065Stop PLDM Service And Wait
1066 [Documentation] Stop PLDM service and wait for Host to initiate reset.
1067
1068 BMC Execute Command systemctl stop pldmd.service
1069
George Keishingca76e372022-03-16 12:45:26 -05001070
1071Get BIOS Attribute
1072 [Documentation] Get the BIOS attribute for /redfish/v1/Systems/system/Bios.
1073
1074 # Python module: get_member_list(resource_path)
1075 ${systems}= Redfish_Utils.Get Member List /redfish/v1/Systems
1076 ${bios_attr_dict}= Redfish.Get Attribute ${systems[0]}/Bios Attributes
1077
1078 [Return] ${bios_attr_dict}
nagarjunb22cfb2c412022-03-15 15:49:27 +05301079
George Keishing8f610e72022-03-28 10:43:08 -05001080
1081Set BIOS Attribute
1082 [Documentation] PATCH the BIOS attribute for /redfish/v1/Systems/system/Bios.
1083 [Arguments] ${attribute_name} ${attribute_value}
1084
1085 # Description of argument(s):
1086 # attribute_name Any valid BIOS attribute.
1087 # attribute_value Valid allowed attribute values.
1088
1089 # Python module: get_member_list(resource_path)
1090 ${systems}= Redfish_Utils.Get Member List /redfish/v1/Systems
1091 Redfish.Patch ${systems[0]}/Bios/Settings body={"Attributes":{"${attribute_name}":"${attribute_value}"}}
1092
1093
nagarjunb22cfb2c412022-03-15 15:49:27 +05301094Is BMC Operational
1095 [Documentation] Check if BMC is enabled.
1096
1097 ${bmc_status} = Redfish Get BMC State
1098 Should Be Equal ${bmc_status} Enabled
George Keishing83c737b2022-05-17 12:12:04 -05001099
1100
1101PLDM Set BIOS Attribute
1102 [Documentation] Set the BIOS attribute via pldmtool and verify the attribute is set.
1103 ... Defaulted for fw_boot_side for boot test usage caller.
1104 [Arguments] ${attribute_name}=fw_boot_side ${attribute_value}=Temp
1105
1106 # Description of argument(s):
1107 # attribute_name Valid BIOS attribute name e.g ("fw_boot_side")
1108 # attribute_value Valid BIOS attribute value for fw_boot_side.
1109
1110 # PLDM response output example:
1111 # {
1112 # "Response": "SUCCESS"
1113 # }
1114
1115 ${resp}= pldmtool bios SetBIOSAttributeCurrentValue -a ${attribute_name} -d ${attribute_value}
1116 Should Be Equal As Strings ${resp["Response"]} SUCCESS
1117
1118 # PLDM GET output example:
1119 # {
1120 # "CurrentValue": "Temp"
1121 # }
1122
1123 ${pldm_output}= PLDM Get BIOS Attribute ${attribute_name}
1124 Should Be Equal As Strings ${pldm_output["CurrentValue"]} ${attribute_value}
1125 ... msg=Expecting ${attribute_value} but got ${pldm_output["CurrentValue"]}
1126
1127
1128PLDM Get BIOS Attribute
1129 [Documentation] Get the BIOS attribute via pldmtool for a given attribute and return value.
1130 [Arguments] ${attribute_name}
1131
1132 # Description of argument(s):
1133 # attribute_name Valid BIOS attribute name e.g ("fw_boot_side")
1134
1135 ${pldm_output}= pldmtool bios GetBIOSAttributeCurrentValueByHandle -a ${attribute_name}
1136 [Return] ${pldm_output}
nagarjunb2200108dc2022-07-12 21:50:45 +05301137
1138
1139Verify Host Power State
1140 [Documentation] Get the Host Power state and compare it with the expected state.
1141 [Arguments] ${expected_power_state}
1142
1143 # Description of argument(s):
1144 # expected_power_state State of Host e.g. Off or On.
1145
1146 ${power_state} ${health_status}= Redfish Get Host State
1147 Should Be Equal ${power_state} ${expected_power_state}
1148
1149
1150Verify Host Is Up
1151 [Documentation] Verify Host is Up.
1152
1153 Wait Until Keyword Succeeds 3 min 30 sec Verify Host Power State On
1154 # Python module: os_execute(cmd)
1155 Wait Until Keyword Succeeds 10 min 30 sec OS Execute Command uptime