blob: 92f2d98a6c772bc0d0336a5115163599bb8daaff [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
Michael Walsh391ba9b2017-08-24 11:36:24 -050010Library String
George Keishing30c12ff2016-09-02 10:25:29 -050011Library DateTime
12Library Process
Chris Austenb29d2e82016-06-07 12:25:35 -050013Library OperatingSystem
Michael Walsha6723f22016-11-22 11:12:01 -060014Library gen_print.py
Steven Sombaraaaab222018-12-19 13:16:23 -060015Library gen_misc.py
Michael Walsha6723f22016-11-22 11:12:01 -060016Library gen_robot_print.py
Michael Walsh5f3f4142017-05-22 17:09:47 -050017Library gen_cmd.py
Sunil Macd110a2017-05-23 04:14:32 -050018Library gen_robot_keyword.py
Michael Walshe53e47a2017-06-30 17:03:24 -050019Library bmc_ssh_utils.py
Michael Walshfdc5ced2017-08-17 13:15:15 -050020Library utils.py
Charles Paul Hofer35816152017-10-02 11:55:11 -050021Library var_funcs.py
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050022Library SCPLibrary WITH NAME scp
Chris Austenb29d2e82016-06-07 12:25:35 -050023
Steven Sombarf60cbcf2018-12-07 08:12:18 -060024
Chris Austenb29d2e82016-06-07 12:25:35 -050025*** Variables ***
Steven Sombar0acb3412018-01-24 09:38:42 -060026
Steven Sombar0acb3412018-01-24 09:38:42 -060027${SYSTEM_SHUTDOWN_TIME} ${5}
28
Michael Walsha6723f22016-11-22 11:12:01 -060029# Assign default value to QUIET for programs which may not define it.
30${QUIET} ${0}
Steven Sombar0acb3412018-01-24 09:38:42 -060031
Sridevi Ramesh1699d372016-12-06 00:20:22 -060032${HOST_SETTING} ${SETTINGS_URI}host0
Steven Sombar0acb3412018-01-24 09:38:42 -060033
Steven Sombar0acb3412018-01-24 09:38:42 -060034${boot_prog_method} ${EMPTY}
Michael Walshfdc5ced2017-08-17 13:15:15 -050035${power_policy_setup} ${0}
36${bmc_power_policy_method} ${EMPTY}
Michael Walshfdc5ced2017-08-17 13:15:15 -050037
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050038
Chris Austenb29d2e82016-06-07 12:25:35 -050039*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060040
Steven Sombar0acb3412018-01-24 09:38:42 -060041
George Keishing5e870cd2016-08-24 10:05:47 -050042Verify Ping and REST Authentication
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -050043 [Documentation] Verify ping and rest authentication.
Michael Walsha6723f22016-11-22 11:12:01 -060044 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -050045 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -050046 Run Keyword If '${l_ping}' == '${False}'
47 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -050048
Michael Walsha6723f22016-11-22 11:12:01 -060049 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -050050 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -050051 Run Keyword If '${l_rest}' == '${False}'
52 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -050053
54 # Just to make sure the SSH is working for SCP
55 Open Connection And Log In
56 ${system} ${stderr}= Execute Command hostname return_stderr=True
57 Should Be Empty ${stderr}
58
Steven Sombar0acb3412018-01-24 09:38:42 -060059
George Keishingc4d3dc02016-09-19 03:45:55 -050060Check If BMC is Up
61 [Documentation] Wait for Host to be online. Checks every X seconds
62 ... interval for Y minutes and fails if timed out.
63 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -060064 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -050065 ... ${interval}=10 sec
66
Steven Sombar0acb3412018-01-24 09:38:42 -060067 # Description of argument(s):
68 # max_timeout Maximum time to wait.
69 # This should be expressed in Robot Framework's time format
70 # (e.g. "10 minutes").
71 # interfal Interval to wait between status checks.
72 # This should be expressed in Robot Framework's time format
73 # (e.g. "5 seconds").
74
George Keishingc4d3dc02016-09-19 03:45:55 -050075 Wait Until Keyword Succeeds
76 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
77
George Keishingb3700812016-08-31 03:03:30 -050078
George Keishing06ae4aa2016-08-30 01:41:28 -050079Flush REST Sessions
80 [Documentation] Removes all the active session objects
81 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -050082
Steven Sombar0acb3412018-01-24 09:38:42 -060083
Rahul Maheshwarie95622c2017-02-24 10:04:29 -060084Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -050085 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -060086 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Steven Sombar0acb3412018-01-24 09:38:42 -060087
Michael Walshb5839d02017-04-12 16:11:20 -050088 # Description of argument(s):
89 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
90 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -060091 # sleep_time Time delay for host watchdog error to get injected.
92 # Default is 5 seconds.
93
Michael Walsh4ffd1a12018-03-14 10:35:44 -050094 ${data}= Create Dictionary
95 ... data=xyz.openbmc_project.State.Watchdog.Action.PowerCycle
96 ${status} ${result}= Run Keyword And Ignore Error
97 ... Read Attribute ${HOST_WATCHDOG_URI} ExpireAction
98 Run Keyword If '${status}' == 'PASS'
99 ... Write Attribute ${HOST_WATCHDOG_URI} ExpireAction data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -0500100
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600101 ${int_milliseconds}= Convert To Integer ${milliseconds}
102 ${data}= Create Dictionary data=${int_milliseconds}
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500103 Write Attribute ${HOST_WATCHDOG_URI} Interval data=${data}
104
105 ${data}= Create Dictionary data=${True}
106 Write Attribute ${HOST_WATCHDOG_URI} Enabled data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -0500107
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600108 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500109
Steven Sombar0acb3412018-01-24 09:38:42 -0600110
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500111Login To OS Host
Steven Sombar0acb3412018-01-24 09:38:42 -0600112 [Documentation] Login to OS Host and return the Login response code.
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500113 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
114 ... ${os_password}=${OS_PASSWORD}
Steven Sombar0acb3412018-01-24 09:38:42 -0600115
Gunnar Mills28e403b2017-10-25 16:16:38 -0500116 # Description of arguments:
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500117 # ${os_host} IP address of the OS Host.
118 # ${os_username} OS Host Login user name.
119 # ${os_password} OS Host Login passwrd.
120
Rahul Maheshwarid1f45f22018-10-26 05:16:39 -0500121 REST Power On stack_mode=skip quiet=1
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500122
George Keishing3f223b82017-06-28 03:50:35 -0500123 SSHLibrary.Open Connection ${os_host}
Sridevi Rameshea36b412017-03-09 04:08:02 -0600124 ${resp}= Login ${os_username} ${os_password}
125 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -0500126
Steven Sombar0acb3412018-01-24 09:38:42 -0600127
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600128Initiate Auto Reboot
129 [Documentation] Initiate an auto reboot.
130 [Arguments] ${milliseconds}=5000
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500131
132 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600133 # milliseconds The number of milliseconds for the watchdog timer.
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500134
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600135 # Set the auto reboot policy.
136 Set Auto Reboot ${1}
137 # Set the watchdog timer.
138 Trigger Host Watchdog Error ${milliseconds}
139
140
141Initiate OS Host Reboot
142 [Documentation] Initiate an OS reboot.
143 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
144 ... ${os_password}=${OS_PASSWORD}
145
146 # Description of argument(s):
147 # os_host The host name or IP address of the OS.
148 # os_username The username to be used to sign in to the OS.
149 # os_password The password to be used to sign in to the OS.
150
151 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
152 ... Set Variable reboot
153 ... ELSE
154 ... Set Variable echo ${os_password} | sudo -S reboot
155
156 ${output} ${stderr} ${rc}= OS Execute Command
157 ... ${cmd_buf} fork=${1}
158
159
160Initiate OS Host Power Off
161 [Documentation] Initiate an OS reboot.
162 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
163 ... ${os_password}=${OS_PASSWORD} ${hard}=${0}
164
165 # Description of argument(s):
166 # os_host The DNS name or IP of the OS.
167 # os_username The username to be used to sign in to the OS.
168 # os_password The password to be used to sign in to the OS.
169 # hard Indicates whether to do a hard vs. soft power off.
170
171 ${time_string}= Run Keyword If ${hard} Set Variable ${SPACE}now
172 ... ELSE Set Variable ${EMPTY}
173
174 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
175 ... Set Variable shutdown${time_string}
176 ... ELSE
177 ... Set Variable echo ${os_password} | sudo -S shutdown${time_string}
178
179 ${output} ${stderr} ${rc}= OS Execute Command
180 ... ${cmd_buf} fork=${1}
Sweta Potthurie5a9fc72017-05-03 07:02:46 -0500181
George Keishing3987a1e2017-09-20 09:13:02 -0500182
Steven Sombar5f3af442018-02-14 08:30:15 -0600183Set System LED State
184 [Documentation] Set given system LED via REST.
185 [Arguments] ${led_name} ${led_state}
186 # Description of argument(s):
187 # led_name System LED name (e.g. heartbeat, identify, beep).
188 # led_state LED state to be set (e.g. On, Off).
189
190 ${args}= Create Dictionary
191 ... data=xyz.openbmc_project.Led.Physical.Action.${led_state}
192 Write Attribute ${LED_PHYSICAL_URI}${led_name} State data=${args}
193
194 Verify LED State ${led_name} ${led_state}
195
196
Steven Sombaraaf72c42017-09-05 12:02:00 -0500197Read Turbo Setting Via REST
198 [Documentation] Return turbo setting via REST.
Steven Sombarea79a492018-04-18 11:14:57 -0500199 # Returns 1 if TurboAllowed, 0 if not.
Steven Sombaraaf72c42017-09-05 12:02:00 -0500200
Steven Sombarea79a492018-04-18 11:14:57 -0500201 ${turbo_setting}= Read Attribute
202 ... ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
203 [Return] ${turbo_setting}
204
Steven Sombaraaf72c42017-09-05 12:02:00 -0500205
Steven Sombaraaf72c42017-09-05 12:02:00 -0500206Set Turbo Setting Via REST
207 [Documentation] Set turbo setting via REST.
Steven Sombar80bc8592018-04-24 11:44:53 -0500208 [Arguments] ${setting} ${verify}=${False}
Steven Sombar0acb3412018-01-24 09:38:42 -0600209
Steven Sombaraaf72c42017-09-05 12:02:00 -0500210 # Description of argument(s):
Steven Sombar80bc8592018-04-24 11:44:53 -0500211 # setting State to set TurboAllowed, 1=allowed, 0=not allowed.
212 # verify If True, read the TurboAllowed setting to confirm.
Steven Sombaraaf72c42017-09-05 12:02:00 -0500213
Steven Sombarea79a492018-04-18 11:14:57 -0500214 ${data}= Create Dictionary data=${${setting}}
Steven Sombar80bc8592018-04-24 11:44:53 -0500215 Write Attribute ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
216 ... verify=${verify} data=${data}
George Keishingef74a8c2017-10-20 10:23:52 -0500217
Steven Sombar0acb3412018-01-24 09:38:42 -0600218
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600219Set REST Logging Policy
220 [Documentation] Enable or disable REST logging setting.
221 [Arguments] ${policy_setting}=${True}
George Keishingef74a8c2017-10-20 10:23:52 -0500222
223 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600224 # policy_setting The policy setting value which can be either
225 # True or False.
George Keishingef74a8c2017-10-20 10:23:52 -0500226
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600227 ${log_dict}= Create Dictionary data=${policy_setting}
George Keishingdf3e65f2018-12-18 13:06:56 -0600228 Write Attribute ${BMC_LOGGING_URI}rest_api_logs Enabled
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600229 ... data=${log_dict} verify=${1} expected_value=${policy_setting}
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -0500230
Steven Sombar0acb3412018-01-24 09:38:42 -0600231
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600232Old Get Boot Progress
233 [Documentation] Get the boot progress the old way (via org location).
234 [Arguments] ${quiet}=${QUIET}
George Keishing034902d2017-11-10 13:15:38 -0600235
236 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600237 # quiet Indicates whether this keyword should run without any output to
238 # the console.
239
240 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
241 ... value quiet=${quiet}
242
243 [Return] ${state}
244
245
246Set Boot Progress Method
247 [Documentation] Set the boot_prog_method to either 'Old' or 'New'.
248
249 # The boot progress data has moved from an 'org' location to an 'xyz'
250 # location. This keyword will determine whether the new method of getting
251 # the boot progress is valid and will set the global boot_prog_method
252 # variable accordingly. If boot_prog_method is already set (either by a
253 # prior call to this function or via a -v parm), this keyword will simply
254 # return.
255
256 # Note: There are interim builds that contain boot_progress in both the
257 # old and the new location values. It is nearly impossible for this
258 # keyword to determine whether the old boot_progress or the new one is
259 # active. When using such builds where the old boot_progress is active,
260 # the only recourse users will have is that they may specify
261 # -v boot_prog_method:Old to force old behavior on such builds.
262
263 Run Keyword If '${boot_prog_method}' != '${EMPTY}' Return From Keyword
264
265 ${new_status} ${new_value}= Run Keyword And Ignore Error
266 ... New Get Boot Progress
267 # If the new style read fails, the method must necessarily be "Old".
268 Run Keyword If '${new_status}' == 'PASS'
269 ... Run Keywords
270 ... Set Global Variable ${boot_prog_method} New AND
271 ... Rqpvars boot_prog_method AND
272 ... Return From Keyword
273
274 # Default method is "Old".
275 Set Global Variable ${boot_prog_method} Old
276 Rqpvars boot_prog_method
277
278
279Initiate Power On
280 [Documentation] Initiates the power on and waits until the Is Power On
281 ... keyword returns that the power state has switched to on.
282 [Arguments] ${wait}=${1}
283
284 # Description of argument(s):
285 # wait Indicates whether to wait for a powered on state after issuing
286 # the power on command.
287
288 @{arglist}= Create List
289 ${args}= Create Dictionary data=@{arglist}
290 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
291 ... data=${args}
292 should be equal as strings ${resp.status_code} ${HTTP_OK}
293
294 # Does caller want to wait for power on status?
295 Run Keyword If '${wait}' == '${0}' Return From Keyword
296 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
297
298
299Initiate Power Off
300 [Documentation] Initiates the power off and waits until the Is Power Off
301 ... keyword returns that the power state has switched to off.
302
303 @{arglist}= Create List
304 ${args}= Create Dictionary data=@{arglist}
305 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
306 ... data=${args}
307 should be equal as strings ${resp.status_code} ${HTTP_OK}
308 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
309
310
311Get Boot Progress
312 [Documentation] Get the boot progress and return it.
313 [Arguments] ${quiet}=${QUIET}
314
315 # Description of argument(s):
316 # quiet Indicates whether this keyword should run without any output to
317 # the console.
318
319 Set Boot Progress Method
320 ${state}= Run Keyword If '${boot_prog_method}' == 'New'
321 ... New Get Boot Progress quiet=${quiet}
322 ... ELSE
323 ... Old Get Boot Progress quiet=${quiet}
324
325 [Return] ${state}
326
327
328New Get Boot Progress
329 [Documentation] Get the boot progress the new way (via xyz location).
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 ${state}= Read Attribute ${HOST_STATE_URI} BootProgress quiet=${quiet}
337
338 [Return] ${state.rsplit('.', 1)[1]}
339
340
341New Get Power Policy
342 [Documentation] Returns the BMC power policy (new method).
343 ${currentPolicy}= Read Attribute ${POWER_RESTORE_URI} PowerRestorePolicy
344
345 [Return] ${currentPolicy}
346
347
348Old Get Power Policy
349 [Documentation] Returns the BMC power policy (old method).
350 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
351
352 [Return] ${currentPolicy}
353
354
355Get Auto Reboot
356 [Documentation] Returns auto reboot setting.
357 ${setting}= Read Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot
358
359 [Return] ${setting}
360
361
362Trigger Warm Reset
363 [Documentation] Initiate a warm reset.
364
365 log to console "Triggering warm reset"
366 ${data}= create dictionary data=@{EMPTY}
367 ${resp}= openbmc post request
368 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
369 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
370 ${session_active}= Check If warmReset is Initiated
371 Run Keyword If '${session_active}' == '${True}'
372 ... Fail msg=warm reset didn't occur
373
374 Sleep ${SYSTEM_SHUTDOWN_TIME}min
375 Check If BMC Is Up
376
377
378Get Power State
379 [Documentation] Returns the power state as an integer. Either 0 or 1.
380 [Arguments] ${quiet}=${QUIET}
381
382 # Description of argument(s):
383 # quiet Indicates whether this keyword should run without any output to
384 # the console.
385
386 @{arglist}= Create List
387 ${args}= Create Dictionary data=@{arglist}
388
389 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
390 ... data=${args} quiet=${quiet}
391 Should be equal as strings ${resp.status_code} ${HTTP_OK}
392 ${content}= to json ${resp.content}
393
394 [Return] ${content["data"]}
395
396
397Clear BMC Gard Record
398 [Documentation] Clear gard records from the system.
399
400 @{arglist}= Create List
401 ${args}= Create Dictionary data=@{arglist}
402 ${resp}= Call Method
403 ... ${OPENPOWER_CONTROL}gard Reset data=${args}
404 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
405
406
407Flash PNOR
408 [Documentation] Calls flash bios update method to flash PNOR image
409 [Arguments] ${pnor_image}
410
411 # Description of argument(s):
412 # pnor_image The filename and path of the PNOR image
413 # (e.g. "/home/image/zaius.pnor").
414
415 @{arglist}= Create List ${pnor_image}
416 ${args}= Create Dictionary data=@{arglist}
417 ${resp}= Call Method /org/openbmc/control/flash/bios/ update
418 ... data=${args}
419 should be equal as strings ${resp.status_code} ${HTTP_OK}
420 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
421
422
423Get Flash BIOS Status
424 [Documentation] Returns the status of the flash BIOS API as a string. For
425 ... example 'Flashing', 'Flash Done', etc
426 ${data}= Read Properties /org/openbmc/control/flash/bios
427 [Return] ${data['status']}
428
429
430Is PNOR Flashing
431 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
432 ... flashing has started.
433 ${status}= Get Flash BIOS Status
434 Should Contain ${status} Flashing
435
436
437Is PNOR Flash Done
438 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
439 ... PNOR flashing has completed.
440 ${status}= Get Flash BIOS Status
441 should be equal as strings ${status} Flash Done
442
443
444Create OS Console File Path
445 [Documentation] Create OS console file path name and return it.
446 [Arguments] ${log_file_path}=${EMPTY}
447
448 # Description of arguments:
449 # file_path The caller's candidate value. If this value is ${EMPTY}, this
450 # keyword will compose a file path name. Otherwise, this
451 # keyword will use the caller's file_path value. In either
452 # case, the value will be returned.
453
454 ${status}= Run Keyword And Return Status Variable Should Exist
455 ... ${TEST_NAME}
456
457 ${default_file_path}= Set Variable If ${status} == ${TRUE}
458 ... /tmp/${OPENBMC_HOST}_${TEST_NAME.replace(' ', '')}_os_console.txt
459 ... /tmp/${OPENBMC_HOST}_os_console.txt
460
461 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
462 ... ${default_file_path} ${log_file_path}
463
464 [Return] ${log_file_path}
465
466
467Get Endpoint Paths
468 [Documentation] Returns all url paths ending with given endpoint
469 ... Example:
470 ... Given the following endpoint: cpu
471 ... This keyword will return: list of all urls ending with
472 ... cpu -
473 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
474 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
475 [Arguments] ${path} ${endpoint}
476
477 # Description of arguments:
478 # path URL path for enumeration.
479 # endpoint Endpoint string (url path ending).
480
Steven Sombaraaaab222018-12-19 13:16:23 -0600481 # Make sure path ends with slash.
482 ${path}= Add Trailing Slash ${path}
483
484 ${resp}= Read Properties ${path}enumerate timeout=30
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600485 Log Dictionary ${resp}
486
487 ${list}= Get Dictionary Keys ${resp}
488 # For a given string, look for prefix and suffix for matching expression.
489 # Start of string followed by zero or more of any character followed by
490 # any digit or lower case character.
491 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}\[0-9a-z]*$
492
493 [Return] ${resp}
494
495
496Set BMC Power Policy
497 [Documentation] Set the given BMC power policy.
498 [Arguments] ${policy}
499
500 # Note that this function will translate the old style "RESTORE_LAST_STATE"
501 # policy to the new style "xyz.openbmc_project.Control.Power.RestorePolicy.
502 # Policy.Restore" for you.
503
504 # Description of argument(s):
505 # policy Power restore policy (e.g "RESTORE_LAST_STATE",
506 # ${RESTORE_LAST_STATE}).
507
508 # Set the bmc_power_policy_method to either 'Old' or 'New'.
509 Set Power Policy Method
510 # This translation helps bridge between old and new method for calling.
511 ${policy}= Translate Power Policy Value ${policy}
512 # Run the appropriate keyword.
513 Run Key ${bmc_power_policy_method} Set Power Policy \ ${policy}
514 ${currentPolicy}= Get System Power Policy
515 Should Be Equal ${currentPolicy} ${policy}
516
517
518Delete Error Logs
519 [Documentation] Delete error logs.
520
521 # Check if error logs entries exist, if not return.
Steven Sombara8800da2018-12-18 16:19:05 -0600522 ${resp}= OpenBMC Get Request ${BMC_LOGGING_ENTRY}list quiet=${1}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600523 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND}
524
525 # Get the list of error logs entries and delete them all.
526 ${elog_entries}= Get URL List ${BMC_LOGGING_ENTRY}
527 :FOR ${entry} IN @{elog_entries}
528 \ Delete Error Log Entry ${entry}
529
530
531Delete All Error Logs
532 [Documentation] Delete all error log entries using "DeleteAll" interface.
533
534 ${data}= Create Dictionary data=@{EMPTY}
535 ${resp}= Openbmc Post Request ${BMC_LOGGING_URI}action/DeleteAll
536 ... data=${data}
537 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
538
539
540Get Elog URL List
541 [Documentation] Return error log entry list of URLs.
542
543 ${url_list}= Read Properties /xyz/openbmc_project/logging/entry/
544 Sort List ${url_list}
545 [Return] ${url_list}
546
547
548Get BMC Flash Chip Boot Side
549 [Documentation] Return the BMC flash chip boot side.
George Keishing034902d2017-11-10 13:15:38 -0600550
551 # Example:
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600552 # 0 - indicates chip select is current side.
553 # 32 - indicates chip select is alternate side.
George Keishing034902d2017-11-10 13:15:38 -0600554
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600555 ${boot_side} ${stderr} ${rc}= BMC Execute Command
556 ... cat /sys/class/watchdog/watchdog1/bootstatus
557
558 [Return] ${boot_side}
559
560
561Update Root Password
562 [Documentation] Update system "root" user password.
563 [Arguments] ${openbmc_password}=${OPENBMC_PASSWORD}
564
565 # Description of argument(s):
566 # openbmc_password The root password for the open BMC system.
567
568 @{password}= Create List ${openbmc_password}
569 ${data}= Create Dictionary data=@{password}
570
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600571 ${headers}= Create Dictionary Content-Type=application/json X-Auth-Token=${XAUTH_TOKEN}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600572 ${resp}= Post Request openbmc ${BMC_USER_URI}root/action/SetPassword
573 ... data=${data} headers=${headers}
574 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
575 ... msg=Updating the new root password failed, RC=${resp.status_code}.
Sweta Potthuri7d3af3c2018-01-29 03:07:07 -0600576
Sweta Potthurif39022d2018-02-06 03:40:07 -0600577
Sweta Potthuri7d3af3c2018-01-29 03:07:07 -0600578Watchdog Object Should Exist
579 [Documentation] Check that watchdog object exists.
580
581 ${resp}= OpenBMC Get Request ${WATCHDOG_URI}host0
582 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
583 ... msg=Expected watchdog object does not exist.
Sweta Potthurif39022d2018-02-06 03:40:07 -0600584
585
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600586Get System LED State
587 [Documentation] Return the state of given system LED.
588 [Arguments] ${led_name}
Sweta Potthurif39022d2018-02-06 03:40:07 -0600589
590 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600591 # led_name System LED name (e.g. heartbeat, identify, beep).
Sweta Potthurif39022d2018-02-06 03:40:07 -0600592
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600593 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State
594 [Return] ${state.rsplit('.', 1)[1]}
George Keishingb9f407b2018-02-20 00:07:46 -0600595
596
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600597Verify LED State
598 [Documentation] Checks if LED is in given state.
599 [Arguments] ${led_name} ${led_state}
600 # Description of argument(s):
601 # led_name System LED name (e.g. heartbeat, identify, beep).
602 # led_state LED state to be verified (e.g. On, Off).
George Keishingb9f407b2018-02-20 00:07:46 -0600603
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600604 ${state}= Get System LED State ${led_name}
605 Should Be Equal ${state} ${led_state}
George Keishingb9f407b2018-02-20 00:07:46 -0600606
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600607
608Get LED State XYZ
609 [Documentation] Returns state of given LED.
610 [Arguments] ${led_name}
611
612 # Description of argument(s):
613 # led_name Name of LED.
614
615 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
616 # Returns the state of the LED, either On or Off.
617 [Return] ${state}
George Keishingb9f407b2018-02-20 00:07:46 -0600618
George Keishing78ce8dc2018-03-30 11:49:06 -0500619
620Verify Identify LED State
621 [Documentation] Verify the identify LED state
622 ... matches caller's expectations.
623 [Arguments] ${expected_state}
624
625 # Description of argument(s):
626 # expected_state The LED state expected by the caller ("Blink" or "Off").
627
628 ${resp}= Read Attribute ${LED_PHYSICAL_URI}/front_id State
629 Should Be Equal ${resp}
630 ... xyz.openbmc_project.Led.Physical.Action.${expected_state}
631 ... msg=Unexpected LED state.
632
633 ${resp}= Read Attribute ${LED_PHYSICAL_URI}/rear_id State
634 Should Be Equal ${resp}
635 ... xyz.openbmc_project.Led.Physical.Action.${expected_state}
636 ... msg=Unexpected LED state.
637
Sweta Potthuri39255032018-03-28 10:12:14 -0500638
639Verify The Attribute
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500640 [Documentation] Verify the given attribute.
Sweta Potthuri39255032018-03-28 10:12:14 -0500641 [Arguments] ${uri} ${attribute_name} ${attribute_value}
642
643 # Description of argument(s):
644 # uri URI path
645 # (e.g. "/xyz/openbmc_project/control/host0/TPMEnable").
646 # attribute_name Name of attribute to be verified (e.g. "TPMEnable").
647 # attribute_value The expected value of attribute (e.g. "1", "0", etc.)
648
649 ${output}= Read Attribute ${uri} ${attribute_name}
650 Should Be Equal ${attribute_value} ${output}
651 ... msg=Attribute "${attribute_name} does not have the expected value.
George Keishingcf0d7772018-05-04 08:22:50 -0500652
653
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600654New Set Power Policy
655 [Documentation] Set the given BMC power policy (new method).
656 [Arguments] ${policy}
George Keishingb4adfc72018-10-26 09:39:32 -0500657
658 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600659 # policy Power restore policy (e.g. ${ALWAYS_POWER_OFF}).
George Keishingc5fef582018-07-18 08:41:28 -0500660
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600661 ${valueDict}= Create Dictionary data=${policy}
662 Write Attribute
663 ... ${POWER_RESTORE_URI} PowerRestorePolicy data=${valueDict}
George Keishing216e5842018-08-31 14:58:15 -0500664
665
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600666Old Set Power Policy
667 [Documentation] Set the given BMC power policy (old method).
668 [Arguments] ${policy}
George Keishing3c004dc2018-10-10 07:16:47 -0500669
670 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600671 # policy Power restore policy (e.g. "ALWAYS_POWER_OFF").
672
673 ${valueDict}= create dictionary data=${policy}
674 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
George Keishing3c004dc2018-10-10 07:16:47 -0500675
676
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600677Set Auto Reboot
678 [Documentation] Set the given auto reboot setting.
679 [Arguments] ${setting}
George Keishing3c004dc2018-10-10 07:16:47 -0500680
681 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600682 # setting The reboot setting, 1 for enabling and 0 for disabling.
George Keishing3c004dc2018-10-10 07:16:47 -0500683
Sridevi Ramesh68d72ff2019-02-04 09:24:46 -0600684 ${valueDict}= Convert To Integer ${setting}
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600685 ${data}= Create Dictionary data=${valueDict}
686 Write Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot data=${data}
687 ${current_setting}= Get Auto Reboot
688 Should Be Equal As Integers ${current_setting} ${setting}
George Keishing3c004dc2018-10-10 07:16:47 -0500689
George Keishingc25c55d2018-10-30 02:23:44 -0500690
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600691Set Control Boot Mode
692 [Documentation] Set given boot mode on the boot object path attribute.
693 [Arguments] ${boot_path} ${boot_mode}
George Keishingc25c55d2018-10-30 02:23:44 -0500694
695 # Description of argument(s):
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600696 # boot_path Boot object path.
697 # Example:
698 # /xyz/openbmc_project/control/host0/boot
699 # /xyz/openbmc_project/control/host0/boot/one_time
700 # boot_mode Boot mode which need to be set.
701 # Example:
702 # "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"
George Keishingc25c55d2018-10-30 02:23:44 -0500703
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600704 ${valueDict}= Create Dictionary data=${boot_mode}
705 Write Attribute ${boot_path} BootMode data=${valueDict}
George Keishingc25c55d2018-10-30 02:23:44 -0500706
Steven Sombarf60cbcf2018-12-07 08:12:18 -0600707
708Is Power On
709 [Documentation] Verify that the BMC chassis state is on.
710 ${state}= Get Power State
711 Should be equal ${state} ${1}
712
713
714Is Power Off
715 [Documentation] Verify that the BMC chassis state is off.
716 ${state}= Get Power State
717 Should be equal ${state} ${0}