blob: 974e5d4c18cf6e299c24d39f6c655122dbf9f184 [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
Chris Austenb29d2e82016-06-07 12:25:35 -050025
Steven Sombarf60cbcf2018-12-07 08:12:18 -060026
Chris Austenb29d2e82016-06-07 12:25:35 -050027*** Variables ***
Steven Sombar0acb3412018-01-24 09:38:42 -060028
Steven Sombar0acb3412018-01-24 09:38:42 -060029${SYSTEM_SHUTDOWN_TIME} ${5}
30
Michael Walsha6723f22016-11-22 11:12:01 -060031# Assign default value to QUIET for programs which may not define it.
32${QUIET} ${0}
Steven Sombar0acb3412018-01-24 09:38:42 -060033
Sridevi Ramesh1699d372016-12-06 00:20:22 -060034${HOST_SETTING} ${SETTINGS_URI}host0
Steven Sombar0acb3412018-01-24 09:38:42 -060035
Steven Sombar0acb3412018-01-24 09:38:42 -060036${boot_prog_method} ${EMPTY}
Michael Walshfdc5ced2017-08-17 13:15:15 -050037${power_policy_setup} ${0}
38${bmc_power_policy_method} ${EMPTY}
Michael Walshfdc5ced2017-08-17 13:15:15 -050039
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050040
Chris Austenb29d2e82016-06-07 12:25:35 -050041*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060042
Steven Sombar0acb3412018-01-24 09:38:42 -060043
George Keishing5e870cd2016-08-24 10:05:47 -050044Verify Ping and REST Authentication
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -050045 [Documentation] Verify ping and rest authentication.
Michael Walsha6723f22016-11-22 11:12:01 -060046 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -050047 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -050048 Run Keyword If '${l_ping}' == '${False}'
49 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -050050
Michael Walsha6723f22016-11-22 11:12:01 -060051 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -050052 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -050053 Run Keyword If '${l_rest}' == '${False}'
54 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -050055
56 # Just to make sure the SSH is working for SCP
57 Open Connection And Log In
58 ${system} ${stderr}= Execute Command hostname return_stderr=True
59 Should Be Empty ${stderr}
60
Steven Sombar0acb3412018-01-24 09:38:42 -060061
George Keishing90b555a2021-05-20 11:54:16 -050062Verify Ping SSH And Redfish Authentication
63 [Documentation] Verify ping, SSH and redfish authentication.
64
65 ${l_ping}= Run Keyword And Return Status Ping Host ${OPENBMC_HOST}
66 Run Keyword If '${l_ping}' == '${False}' Fail msg=Ping Failed
67
68 ${l_rest}= Run Keyword And Return Status Redfish.Login
69 Run Keyword If '${l_rest}' == '${False}' Fail msg=REST Authentication Failed
70
71 # Just to make sure the SSH is working.
72 Open Connection And Log In
73 ${system} ${stderr}= Execute Command hostname return_stderr=True
74 Should Be Empty ${stderr}
75
76
George Keishingc4d3dc02016-09-19 03:45:55 -050077Check If BMC is Up
78 [Documentation] Wait for Host to be online. Checks every X seconds
79 ... interval for Y minutes and fails if timed out.
80 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -060081 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -050082 ... ${interval}=10 sec
83
Steven Sombar0acb3412018-01-24 09:38:42 -060084 # Description of argument(s):
85 # max_timeout Maximum time to wait.
86 # This should be expressed in Robot Framework's time format
87 # (e.g. "10 minutes").
George Keishing16b3c7b2021-01-28 09:23:37 -060088 # interval Interval to wait between status checks.
Steven Sombar0acb3412018-01-24 09:38:42 -060089 # This should be expressed in Robot Framework's time format
90 # (e.g. "5 seconds").
91
George Keishingc4d3dc02016-09-19 03:45:55 -050092 Wait Until Keyword Succeeds
93 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
94
George Keishingb3700812016-08-31 03:03:30 -050095
George Keishing06ae4aa2016-08-30 01:41:28 -050096Flush REST Sessions
97 [Documentation] Removes all the active session objects
98 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -050099
Steven Sombar0acb3412018-01-24 09:38:42 -0600100
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600101Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -0500102 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600103 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Steven Sombar0acb3412018-01-24 09:38:42 -0600104
Michael Walshb5839d02017-04-12 16:11:20 -0500105 # Description of argument(s):
106 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
107 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600108 # sleep_time Time delay for host watchdog error to get injected.
109 # Default is 5 seconds.
110
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500111 ${data}= Create Dictionary
112 ... data=xyz.openbmc_project.State.Watchdog.Action.PowerCycle
113 ${status} ${result}= Run Keyword And Ignore Error
114 ... Read Attribute ${HOST_WATCHDOG_URI} ExpireAction
115 Run Keyword If '${status}' == 'PASS'
116 ... Write Attribute ${HOST_WATCHDOG_URI} ExpireAction data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -0500117
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600118 ${int_milliseconds}= Convert To Integer ${milliseconds}
119 ${data}= Create Dictionary data=${int_milliseconds}
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500120 Write Attribute ${HOST_WATCHDOG_URI} Interval data=${data}
121
122 ${data}= Create Dictionary data=${True}
123 Write Attribute ${HOST_WATCHDOG_URI} Enabled data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -0500124
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600125 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500126
Steven Sombar0acb3412018-01-24 09:38:42 -0600127
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500128Login To OS Host
Steven Sombar0acb3412018-01-24 09:38:42 -0600129 [Documentation] Login to OS Host and return the Login response code.
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500130 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
131 ... ${os_password}=${OS_PASSWORD}
Steven Sombar0acb3412018-01-24 09:38:42 -0600132
Gunnar Mills28e403b2017-10-25 16:16:38 -0500133 # Description of arguments:
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500134 # ${os_host} IP address of the OS Host.
135 # ${os_username} OS Host Login user name.
136 # ${os_password} OS Host Login passwrd.
137
Rahul Maheshwarid1f45f22018-10-26 05:16:39 -0500138 REST Power On stack_mode=skip quiet=1
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500139
George Keishing3f223b82017-06-28 03:50:35 -0500140 SSHLibrary.Open Connection ${os_host}
George Keishinge0030882019-02-21 03:48:27 -0600141 ${resp}= SSHLibrary.Login ${os_username} ${os_password}
Sridevi Rameshea36b412017-03-09 04:08:02 -0600142 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -0500143
Steven Sombar0acb3412018-01-24 09:38:42 -0600144
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600145Initiate Auto Reboot
146 [Documentation] Initiate an auto reboot.
147 [Arguments] ${milliseconds}=5000
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500148
149 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600150 # milliseconds The number of milliseconds for the watchdog timer.
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500151
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600152 # Set the auto reboot policy.
153 Set Auto Reboot ${1}
154 # Set the watchdog timer.
155 Trigger Host Watchdog Error ${milliseconds}
156
157
158Initiate OS Host Reboot
159 [Documentation] Initiate an OS reboot.
160 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
161 ... ${os_password}=${OS_PASSWORD}
162
163 # Description of argument(s):
164 # os_host The host name or IP address of the OS.
165 # os_username The username to be used to sign in to the OS.
166 # os_password The password to be used to sign in to the OS.
167
168 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
169 ... Set Variable reboot
170 ... ELSE
171 ... Set Variable echo ${os_password} | sudo -S reboot
172
173 ${output} ${stderr} ${rc}= OS Execute Command
174 ... ${cmd_buf} fork=${1}
175
176
177Initiate OS Host Power Off
178 [Documentation] Initiate an OS reboot.
179 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
180 ... ${os_password}=${OS_PASSWORD} ${hard}=${0}
181
182 # Description of argument(s):
183 # os_host The DNS name or IP of the OS.
184 # os_username The username to be used to sign in to the OS.
185 # os_password The password to be used to sign in to the OS.
186 # hard Indicates whether to do a hard vs. soft power off.
187
188 ${time_string}= Run Keyword If ${hard} Set Variable ${SPACE}now
189 ... ELSE Set Variable ${EMPTY}
190
191 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
192 ... Set Variable shutdown${time_string}
193 ... ELSE
194 ... Set Variable echo ${os_password} | sudo -S shutdown${time_string}
195
196 ${output} ${stderr} ${rc}= OS Execute Command
197 ... ${cmd_buf} fork=${1}
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500198
George Keishing3987a1e2017-09-20 09:13:02 -0500199
Steven Sombar5f3af442018-02-14 08:30:15 -0600200Set System LED State
201 [Documentation] Set given system LED via REST.
202 [Arguments] ${led_name} ${led_state}
203 # Description of argument(s):
204 # led_name System LED name (e.g. heartbeat, identify, beep).
205 # led_state LED state to be set (e.g. On, Off).
206
207 ${args}= Create Dictionary
208 ... data=xyz.openbmc_project.Led.Physical.Action.${led_state}
209 Write Attribute ${LED_PHYSICAL_URI}${led_name} State data=${args}
210
211 Verify LED State ${led_name} ${led_state}
212
213
Steven Sombaraaf72c42017-09-05 12:02:00 -0500214Read Turbo Setting Via REST
215 [Documentation] Return turbo setting via REST.
Steven Sombarea79a492018-04-18 11:14:57 -0500216 # Returns 1 if TurboAllowed, 0 if not.
Steven Sombaraaf72c42017-09-05 12:02:00 -0500217
Steven Sombarea79a492018-04-18 11:14:57 -0500218 ${turbo_setting}= Read Attribute
219 ... ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
220 [Return] ${turbo_setting}
221
Steven Sombaraaf72c42017-09-05 12:02:00 -0500222
Steven Sombaraaf72c42017-09-05 12:02:00 -0500223Set Turbo Setting Via REST
224 [Documentation] Set turbo setting via REST.
Steven Sombar80bc8592018-04-24 11:44:53 -0500225 [Arguments] ${setting} ${verify}=${False}
Steven Sombar0acb3412018-01-24 09:38:42 -0600226
Steven Sombaraaf72c42017-09-05 12:02:00 -0500227 # Description of argument(s):
Steven Sombar80bc8592018-04-24 11:44:53 -0500228 # setting State to set TurboAllowed, 1=allowed, 0=not allowed.
229 # verify If True, read the TurboAllowed setting to confirm.
Steven Sombaraaf72c42017-09-05 12:02:00 -0500230
Steven Sombarea79a492018-04-18 11:14:57 -0500231 ${data}= Create Dictionary data=${${setting}}
Steven Sombar80bc8592018-04-24 11:44:53 -0500232 Write Attribute ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
233 ... verify=${verify} data=${data}
George Keishingef74a8c2017-10-20 10:23:52 -0500234
Steven Sombar0acb3412018-01-24 09:38:42 -0600235
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600236Set REST Logging Policy
237 [Documentation] Enable or disable REST logging setting.
238 [Arguments] ${policy_setting}=${True}
George Keishingef74a8c2017-10-20 10:23:52 -0500239
240 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600241 # policy_setting The policy setting value which can be either
242 # True or False.
George Keishingef74a8c2017-10-20 10:23:52 -0500243
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600244 ${log_dict}= Create Dictionary data=${policy_setting}
George Keishingdf3e65f2018-12-18 13:06:56 -0600245 Write Attribute ${BMC_LOGGING_URI}rest_api_logs Enabled
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600246 ... data=${log_dict} verify=${1} expected_value=${policy_setting}
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -0500247
Steven Sombar0acb3412018-01-24 09:38:42 -0600248
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600249Old Get Boot Progress
250 [Documentation] Get the boot progress the old way (via org location).
251 [Arguments] ${quiet}=${QUIET}
George Keishing034902d2017-11-10 13:15:38 -0600252
253 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600254 # quiet Indicates whether this keyword should run without any output to
255 # the console.
256
257 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
258 ... value quiet=${quiet}
259
260 [Return] ${state}
261
262
263Set Boot Progress Method
264 [Documentation] Set the boot_prog_method to either 'Old' or 'New'.
265
266 # The boot progress data has moved from an 'org' location to an 'xyz'
267 # location. This keyword will determine whether the new method of getting
268 # the boot progress is valid and will set the global boot_prog_method
269 # variable accordingly. If boot_prog_method is already set (either by a
270 # prior call to this function or via a -v parm), this keyword will simply
271 # return.
272
273 # Note: There are interim builds that contain boot_progress in both the
274 # old and the new location values. It is nearly impossible for this
275 # keyword to determine whether the old boot_progress or the new one is
276 # active. When using such builds where the old boot_progress is active,
277 # the only recourse users will have is that they may specify
278 # -v boot_prog_method:Old to force old behavior on such builds.
279
280 Run Keyword If '${boot_prog_method}' != '${EMPTY}' Return From Keyword
281
282 ${new_status} ${new_value}= Run Keyword And Ignore Error
283 ... New Get Boot Progress
284 # If the new style read fails, the method must necessarily be "Old".
285 Run Keyword If '${new_status}' == 'PASS'
286 ... Run Keywords
287 ... Set Global Variable ${boot_prog_method} New AND
288 ... Rqpvars boot_prog_method AND
289 ... Return From Keyword
290
291 # Default method is "Old".
292 Set Global Variable ${boot_prog_method} Old
293 Rqpvars boot_prog_method
294
295
296Initiate Power On
297 [Documentation] Initiates the power on and waits until the Is Power On
298 ... keyword returns that the power state has switched to on.
299 [Arguments] ${wait}=${1}
300
301 # Description of argument(s):
302 # wait Indicates whether to wait for a powered on state after issuing
303 # the power on command.
304
305 @{arglist}= Create List
306 ${args}= Create Dictionary data=@{arglist}
307 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
308 ... data=${args}
309 should be equal as strings ${resp.status_code} ${HTTP_OK}
310
311 # Does caller want to wait for power on status?
312 Run Keyword If '${wait}' == '${0}' Return From Keyword
313 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
314
315
316Initiate Power Off
317 [Documentation] Initiates the power off and waits until the Is Power Off
318 ... keyword returns that the power state has switched to off.
319
320 @{arglist}= Create List
321 ${args}= Create Dictionary data=@{arglist}
322 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
323 ... data=${args}
324 should be equal as strings ${resp.status_code} ${HTTP_OK}
325 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
326
327
328Get Boot Progress
329 [Documentation] Get the boot progress and return it.
330 [Arguments] ${quiet}=${QUIET}
331
332 # Description of argument(s):
333 # quiet Indicates whether this keyword should run without any output to
334 # the console.
335
336 Set Boot Progress Method
337 ${state}= Run Keyword If '${boot_prog_method}' == 'New'
338 ... New Get Boot Progress quiet=${quiet}
339 ... ELSE
340 ... Old Get Boot Progress quiet=${quiet}
341
342 [Return] ${state}
343
344
345New Get Boot Progress
346 [Documentation] Get the boot progress the new way (via xyz location).
347 [Arguments] ${quiet}=${QUIET}
348
349 # Description of argument(s):
350 # quiet Indicates whether this keyword should run without any output to
351 # the console.
352
353 ${state}= Read Attribute ${HOST_STATE_URI} BootProgress quiet=${quiet}
354
355 [Return] ${state.rsplit('.', 1)[1]}
356
357
358New Get Power Policy
359 [Documentation] Returns the BMC power policy (new method).
360 ${currentPolicy}= Read Attribute ${POWER_RESTORE_URI} PowerRestorePolicy
361
362 [Return] ${currentPolicy}
363
364
365Old Get Power Policy
366 [Documentation] Returns the BMC power policy (old method).
367 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
368
369 [Return] ${currentPolicy}
370
371
George Keishinga54e06f2020-06-12 10:42:41 -0500372Redfish Get Power Restore Policy
373 [Documentation] Returns the BMC power restore policy.
374
375 ${power_restore_policy}= Redfish.Get Attribute /redfish/v1/Systems/system PowerRestorePolicy
376 [Return] ${power_restore_policy}
377
378
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600379Get Auto Reboot
380 [Documentation] Returns auto reboot setting.
381 ${setting}= Read Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot
382
383 [Return] ${setting}
384
385
George Keishingc8a6dd22020-06-12 12:01:33 -0500386Redfish Get Auto Reboot
387 [Documentation] Returns auto reboot setting.
388
George Keishinga8cb28d2020-06-15 03:10:29 -0500389 ${resp}= Redfish.Get Attribute /redfish/v1/Systems/system Boot
George Keishinga8cb28d2020-06-15 03:10:29 -0500390 [Return] ${resp["AutomaticRetryConfig"]}
George Keishingc8a6dd22020-06-12 12:01:33 -0500391
392
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600393Trigger Warm Reset
394 [Documentation] Initiate a warm reset.
395
396 log to console "Triggering warm reset"
397 ${data}= create dictionary data=@{EMPTY}
398 ${resp}= openbmc post request
399 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
400 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
401 ${session_active}= Check If warmReset is Initiated
402 Run Keyword If '${session_active}' == '${True}'
403 ... Fail msg=warm reset didn't occur
404
405 Sleep ${SYSTEM_SHUTDOWN_TIME}min
406 Check If BMC Is Up
407
408
409Get Power State
410 [Documentation] Returns the power state as an integer. Either 0 or 1.
411 [Arguments] ${quiet}=${QUIET}
412
413 # Description of argument(s):
414 # quiet Indicates whether this keyword should run without any output to
415 # the console.
416
417 @{arglist}= Create List
418 ${args}= Create Dictionary data=@{arglist}
419
420 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
421 ... data=${args} quiet=${quiet}
422 Should be equal as strings ${resp.status_code} ${HTTP_OK}
423 ${content}= to json ${resp.content}
424
425 [Return] ${content["data"]}
426
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}
489 ... /tmp/${OPENBMC_HOST}_${TEST_NAME.replace(' ', '')}_os_console.txt
490 ... /tmp/${OPENBMC_HOST}_os_console.txt
491
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
569 ${data}= Create Dictionary data=@{EMPTY}
570 ${resp}= Openbmc Post Request ${BMC_LOGGING_URI}action/DeleteAll
571 ... data=${data}
572 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 Keishinga5cedb32020-07-17 15:50:34 -0500697Set Auto Reboot Setting
698 [Documentation] Set the given auto reboot setting (REST or Redfish).
699 [Arguments] ${value}
700
701 # Description of argument(s):
702 # value The reboot setting, 1 for enabling and 0 for disabling.
703
704 # This is to cater to boot call points and plugin script which will always
705 # send using value 0 or 1. This dictionary maps to redfish string values.
706 ${rest_redfish_dict}= Create Dictionary
707 ... 1=RetryAttempts
708 ... 0=Disabled
709
George Keishinge1879642020-12-09 13:20:15 -0600710 Run Keyword If ${REDFISH_SUPPORT_TRANS_STATE} == ${1}
George Keishinga5cedb32020-07-17 15:50:34 -0500711 ... Redfish Set Auto Reboot ${rest_redfish_dict["${value}"]}
George Keishinge1879642020-12-09 13:20:15 -0600712 ... ELSE
713 ... Set Auto Reboot ${value}
George Keishinga5cedb32020-07-17 15:50:34 -0500714
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600715Set Auto Reboot
716 [Documentation] Set the given auto reboot setting.
717 [Arguments] ${setting}
George Keishing3c004dc2018-10-10 07:16:47 -0500718
719 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600720 # setting The reboot setting, 1 for enabling and 0 for disabling.
George Keishing3c004dc2018-10-10 07:16:47 -0500721
Sridevi Ramesh68d72ff2019-02-04 09:24:46 -0600722 ${valueDict}= Convert To Integer ${setting}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600723 ${data}= Create Dictionary data=${valueDict}
724 Write Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot data=${data}
725 ${current_setting}= Get Auto Reboot
726 Should Be Equal As Integers ${current_setting} ${setting}
George Keishing3c004dc2018-10-10 07:16:47 -0500727
George Keishingc25c55d2018-10-30 02:23:44 -0500728
George Keishingc8a6dd22020-06-12 12:01:33 -0500729Redfish Set Auto Reboot
730 [Documentation] Set the given auto reboot setting.
731 [Arguments] ${setting}
732
733 # Description of argument(s):
734 # setting The reboot setting, "RetryAttempts" and "Disabled".
735
George Keishinga8cb28d2020-06-15 03:10:29 -0500736 Redfish.Patch /redfish/v1/Systems/system body={"Boot": {"AutomaticRetryConfig": "${setting}"}}
737 ... valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
George Keishinga8cb28d2020-06-15 03:10:29 -0500738
George Keishingc8a6dd22020-06-12 12:01:33 -0500739 ${current_setting}= Redfish Get Auto Reboot
740 Should Be Equal As Strings ${current_setting} ${setting}
741
742
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600743Set Control Boot Mode
744 [Documentation] Set given boot mode on the boot object path attribute.
745 [Arguments] ${boot_path} ${boot_mode}
George Keishingc25c55d2018-10-30 02:23:44 -0500746
747 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600748 # boot_path Boot object path.
749 # Example:
750 # /xyz/openbmc_project/control/host0/boot
751 # /xyz/openbmc_project/control/host0/boot/one_time
752 # boot_mode Boot mode which need to be set.
753 # Example:
754 # "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"
George Keishingc25c55d2018-10-30 02:23:44 -0500755
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600756 ${valueDict}= Create Dictionary data=${boot_mode}
757 Write Attribute ${boot_path} BootMode data=${valueDict}
George Keishingc25c55d2018-10-30 02:23:44 -0500758
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600759
760Is Power On
761 [Documentation] Verify that the BMC chassis state is on.
762 ${state}= Get Power State
763 Should be equal ${state} ${1}
764
765
766Is Power Off
767 [Documentation] Verify that the BMC chassis state is off.
768 ${state}= Get Power State
769 Should be equal ${state} ${0}
Sivas SRR0e3bc6d2019-04-23 08:36:35 -0500770
771
772CLI Get BMC DateTime
773 [Documentation] Returns BMC date time from date command.
774
775 ${bmc_time_via_date} ${stderr} ${rc}= BMC Execute Command date +"%Y-%m-%d %H:%M:%S" print_err=1
776 [Return] ${bmc_time_via_date}
George Keishing61364e52019-10-01 12:01:19 -0500777
778
779Update Root Password
780 [Documentation] Update system "root" user password.
781 [Arguments] ${openbmc_password}=${OPENBMC_PASSWORD}
782
783 # Description of argument(s):
784 # openbmc_password The root password for the open BMC system.
785
786 @{password}= Create List ${openbmc_password}
787 ${data}= Create Dictionary data=@{password}
788
789 ${headers}= Create Dictionary Content-Type=application/json X-Auth-Token=${XAUTH_TOKEN}
790 ${resp}= Post Request openbmc ${BMC_USER_URI}root/action/SetPassword
791 ... data=${data} headers=${headers}
792 Valid Value resp.status_code [${HTTP_OK}]
Sushil Singh6624ce52020-01-22 00:53:41 -0600793
794
795Get Post Boot Action
796 [Documentation] Get post boot action.
797
George Keishing879f0842020-02-05 11:00:47 -0600798 # Post code update action dictionary.
Sushil Singh6624ce52020-01-22 00:53:41 -0600799 #
800 # {
801 # BMC image: {
802 # OnReset: Redfish OBMC Reboot (off),
803 # Immediate: Wait For Reboot start_boot_seconds=${state['epoch_seconds']}
804 # },
805 # Host image: {
George Keishinge523fc02020-03-23 12:28:01 -0500806 # OnReset: RF SYS GracefulRestart,
Sushil Singh6624ce52020-01-22 00:53:41 -0600807 # Immediate: Wait State os_running_match_state 10 mins
808 # }
809 # }
810
811 ${code_base_dir_path}= Get Code Base Dir Path
812 ${post_code_update_actions}= Evaluate
813 ... json.load(open('${code_base_dir_path}data/applytime_table.json')) modules=json
814 Rprint Vars post_code_update_actions
815
816 [Return] ${post_code_update_actions}
817
George Keishing1eeff9c2020-06-16 04:03:34 -0500818
819Redfish Set Boot Default
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300820 [Documentation] Set and Verify Boot source override
821 [Arguments] ${override_enabled} ${override_target} ${override_mode}=UEFI
George Keishing1eeff9c2020-06-16 04:03:34 -0500822
823 # Description of argument(s):
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300824 # override_enabled Boot source override enable type.
George Keishing1eeff9c2020-06-16 04:03:34 -0500825 # ('Once', 'Continuous', 'Disabled').
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300826 # override_target Boot source override target.
George Keishing1eeff9c2020-06-16 04:03:34 -0500827 # ('Pxe', 'Cd', 'Hdd', 'Diags', 'BiosSetup', 'None').
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300828 # override_mode Boot source override mode (relevant only for x86 arch).
829 # ('Legacy', 'UEFI').
George Keishing1eeff9c2020-06-16 04:03:34 -0500830
831 ${data}= Create Dictionary BootSourceOverrideEnabled=${override_enabled}
832 ... BootSourceOverrideTarget=${override_target}
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300833
834 Run Keyword If '${PLATFORM_ARCH_TYPE}' == 'x86'
835 ... Set To Dictionary ${data} BootSourceOverrideMode ${override_mode}
836
George Keishing1eeff9c2020-06-16 04:03:34 -0500837 ${payload}= Create Dictionary Boot=${data}
838
839 Redfish.Patch /redfish/v1/Systems/system body=&{payload}
840 ... valid_status_codes=[${HTTP_OK},${HTTP_NO_CONTENT}]
841
842 ${resp}= Redfish.Get Attribute /redfish/v1/Systems/system Boot
843 Should Be Equal As Strings ${resp["BootSourceOverrideEnabled"]} ${override_enabled}
844 Should Be Equal As Strings ${resp["BootSourceOverrideTarget"]} ${override_target}
Konstantin Aladyshev0043fc52021-04-15 12:07:29 +0300845 Run Keyword If '${PLATFORM_ARCH_TYPE}' == 'x86'
846 ... Should Be Equal As Strings ${resp["BootSourceOverrideMode"]} ${override_mode}
George Keishinge1879642020-12-09 13:20:15 -0600847
848
849# Redfish state keywords.
850
851Redfish Get BMC State
852 [Documentation] Return BMC health state.
853
854 # "Enabled" -> BMC Ready, "Starting" -> BMC NotReady
855
856 # Example:
857 # "Status": {
858 # "Health": "OK",
859 # "HealthRollup": "OK",
860 # "State": "Enabled"
861 # },
862
863 ${status}= Redfish.Get Attribute /redfish/v1/Managers/bmc Status
864 [Return] ${status["State"]}
865
866
867Redfish Get Host State
868 [Documentation] Return host power and health state.
869
870 # Refer: http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status
871
872 # Example:
873 # "PowerState": "Off",
874 # "Status": {
875 # "Health": "OK",
876 # "HealthRollup": "OK",
877 # "State": "StandbyOffline"
878 # },
879
George Keishingb51d1502021-03-25 03:30:33 -0500880 ${chassis}= Redfish.Get Properties /redfish/v1/Chassis/${CHASSIS_ID}
George Keishinge1879642020-12-09 13:20:15 -0600881 [Return] ${chassis["PowerState"]} ${chassis["Status"]["State"]}
882
883
884Redfish Get Boot Progress
885 [Documentation] Return boot progress state.
886
887 # Example: /redfish/v1/Systems/system/
888 # "BootProgress": {
889 # "LastState": "OSRunning"
890 # },
891
892 ${boot_progress}= Redfish.Get Properties /redfish/v1/Systems/system/
George Keishingb51d1502021-03-25 03:30:33 -0500893
894 Return From Keyword If "${PLATFORM_ARCH_TYPE}" == "x86"
895 ... NA ${boot_progress["Status"]["State"]}
896
George Keishinge1879642020-12-09 13:20:15 -0600897 [Return] ${boot_progress["BootProgress"]["LastState"]} ${boot_progress["Status"]["State"]}
898
899
900Redfish Get States
901 [Documentation] Return all the BMC and host states in dictionary.
George Keishing366033f2021-04-01 13:49:06 -0500902 [Timeout] 120 Seconds
George Keishinge1879642020-12-09 13:20:15 -0600903
904 # Refer: openbmc/docs/designs/boot-progress.md
905
George Keishing205f95f2021-03-10 02:25:53 -0600906 Redfish.Login
George Keishinge1879642020-12-09 13:20:15 -0600907
908 ${bmc_state}= Redfish Get BMC State
909 ${chassis_state} ${chassis_status}= Redfish Get Host State
910 ${boot_progress} ${host_state}= Redfish Get Boot Progress
911
912 ${states}= Create Dictionary
913 ... bmc=${bmc_state}
914 ... chassis=${chassis_state}
915 ... host=${host_state}
916 ... boot_progress=${boot_progress}
917
George Keishing64293c52021-03-24 08:21:23 -0500918 # Disable loggoing state to prevent huge log.html record when boot
919 # test is run in loops.
920 #Log ${states}
George Keishing95cf8652021-02-08 11:32:33 -0600921
George Keishinge1879642020-12-09 13:20:15 -0600922 [Return] ${states}
George Keishing95cf8652021-02-08 11:32:33 -0600923
924
925Is BMC Standby
926 [Documentation] Check if BMC is ready and host at standby.
927
928 ${standby_states}= Create Dictionary
929 ... bmc=Enabled
930 ... chassis=Off
931 ... host=Disabled
932 ... boot_progress=None
933
934 Wait Until Keyword Succeeds 3 min 10 sec Redfish Get States
935
936 Wait Until Keyword Succeeds 1 min 10 sec Match State ${standby_states}
937
938
939Match State
940 [Documentation] Check if the expected and current states are matched.
941 [Arguments] ${match_state}
942
943 # Description of argument(s):
944 # match_state Expected states in dictionary.
945
946 ${current_state}= Redfish Get States
947 Dictionaries Should Be Equal ${match_state} ${current_state}
Peter D Phan49739b22021-09-29 14:30:08 -0500948
949
950Redfish Initiate Auto Reboot
951 [Documentation] Initiate an auto reboot.
952 [Arguments] ${interval}=2000
953
954 # Description of argument(s):
955 # interval Value in milliseconds to set Watchdog interval
956
957 # Set auto reboot policy
958 Redfish Set Auto Reboot RetryAttempts
959
George Keishingc0701102021-09-30 12:12:04 -0500960 Redfish Power Operation On
961 Sleep 30s
962
Peter D Phan49739b22021-09-29 14:30:08 -0500963 # Set watchdog timer
964 Set Watchdog Interval Using Busctl ${interval}
965
966
967
968Set Watchdog Interval Using Busctl
969 [Documentation] Set Watchdog time interval.
970 [Arguments] ${milliseconds}=1000
971
972 # Description of argument(s):
George Keishing4b729492021-11-10 12:51:10 -0600973 # milliseconds Time interval for watchdog timer
Peter D Phan49739b22021-09-29 14:30:08 -0500974
George Keishingc0701102021-09-30 12:12:04 -0500975 ${cmd}= Catenate busctl set-property xyz.openbmc_project.Watchdog
976 ... /xyz/openbmc_project/watchdog/host0
977 ... xyz.openbmc_project.State.Watchdog Interval t ${milliseconds}
Peter D Phan49739b22021-09-29 14:30:08 -0500978 BMC Execute Command ${cmd}
979