1*** Settings ***
2
3Documentation  Utilities for Robot keywords that use REST.
4
5Resource                ../lib/resource.robot
6Resource                ../lib/rest_client.robot
7Resource                ../lib/connection_client.robot
8Resource                ../lib/boot_utils.robot
9Resource                ../lib/common_utils.robot
10Resource                ../lib/bmc_redfish_utils.robot
11Library                 String
12Library                 DateTime
13Library                 Process
14Library                 OperatingSystem
15Library                 gen_print.py
16Library                 gen_misc.py
17Library                 gen_robot_print.py
18Library                 gen_cmd.py
19Library                 gen_robot_keyword.py
20Library                 bmc_ssh_utils.py
21Library                 utils.py
22Library                 var_funcs.py
23Library                 SCPLibrary  WITH NAME  scp
24Library                 gen_robot_valid.py
25Library                 pldm_utils.py
26
27
28*** Variables ***
29
30${SYSTEM_SHUTDOWN_TIME}   ${5}
31
32# Assign default value to QUIET for programs which may not define it.
33${QUIET}  ${0}
34
35${HOST_SETTING}    ${SETTINGS_URI}host0
36
37${boot_prog_method}               ${EMPTY}
38${power_policy_setup}             ${0}
39${bmc_power_policy_method}        ${EMPTY}
40@{BOOT_PROGRESS_STATES}           SystemHardwareInitializationComplete  OSBootStarted  OSRunning
41
42
43*** Keywords ***
44
45
46Verify Ping and REST Authentication
47    [Documentation]  Verify ping and rest authentication.
48    ${l_ping}=   Run Keyword And Return Status
49    ...    Ping Host  ${OPENBMC_HOST}
50    Run Keyword If  '${l_ping}' == '${False}'
51    ...    Fail   msg=Ping Failed
52
53    ${l_rest}=   Run Keyword And Return Status
54    ...    Initialize OpenBMC
55    Run Keyword If  '${l_rest}' == '${False}'
56    ...    Fail   msg=REST Authentication Failed
57
58    # Just to make sure the SSH is working for SCP
59    Open Connection And Log In
60    ${system}   ${stderr}=    Execute Command   hostname   return_stderr=True
61    Should Be Empty     ${stderr}
62
63
64Verify Ping SSH And Redfish Authentication
65    [Documentation]  Verify ping, SSH and redfish authentication.
66
67    ${l_ping}=   Run Keyword And Return Status  Ping Host  ${OPENBMC_HOST}
68    Run Keyword If  '${l_ping}' == '${False}'  Fail   msg=Ping Failed
69
70    ${l_rest}=   Run Keyword And Return Status   Redfish.Login
71    Run Keyword If  '${l_rest}' == '${False}'  Fail   msg=REST Authentication Failed
72
73    # Just to make sure the SSH is working.
74    Open Connection And Log In
75    ${system}   ${stderr}=    Execute Command   hostname   return_stderr=True
76    Should Be Empty     ${stderr}
77
78
79Check If BMC is Up
80    [Documentation]  Wait for Host to be online. Checks every X seconds
81    ...              interval for Y minutes and fails if timed out.
82    ...              Default MAX timedout is 10 min, interval 10 seconds.
83    [Arguments]      ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
84    ...              ${interval}=10 sec
85
86    # Description of argument(s):
87    # max_timeout   Maximum time to wait.
88    #               This should be expressed in Robot Framework's time format
89    #               (e.g. "10 minutes").
90    # interval      Interval to wait between status checks.
91    #               This should be expressed in Robot Framework's time format
92    #               (e.g. "5 seconds").
93
94    Wait Until Keyword Succeeds
95    ...   ${max_timeout}  ${interval}   Verify Ping and REST Authentication
96
97
98Flush REST Sessions
99    [Documentation]   Removes all the active session objects
100    Delete All Sessions
101
102
103Trigger Host Watchdog Error
104    [Documentation]  Inject host watchdog timeout error via REST.
105    [Arguments]  ${milliseconds}=1000  ${sleep_time}=5s
106
107    # Description of argument(s):
108    # milliseconds  The time watchdog timer value in milliseconds (e.g. 1000 =
109    #               1 second).
110    # sleep_time    Time delay for host watchdog error to get injected.
111    #               Default is 5 seconds.
112
113    ${data}=  Create Dictionary
114    ...  data=xyz.openbmc_project.State.Watchdog.Action.PowerCycle
115    ${status}  ${result}=  Run Keyword And Ignore Error
116    ...  Read Attribute  ${HOST_WATCHDOG_URI}  ExpireAction
117    Run Keyword If  '${status}' == 'PASS'
118    ...  Write Attribute  ${HOST_WATCHDOG_URI}  ExpireAction  data=${data}
119
120    ${int_milliseconds}=  Convert To Integer  ${milliseconds}
121    ${data}=  Create Dictionary  data=${int_milliseconds}
122    Write Attribute  ${HOST_WATCHDOG_URI}  Interval  data=${data}
123
124    ${data}=  Create Dictionary  data=${True}
125    Write Attribute  ${HOST_WATCHDOG_URI}  Enabled  data=${data}
126
127    Sleep  ${sleep_time}
128
129
130Login To OS Host
131    [Documentation]  Login to OS Host and return the Login response code.
132    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
133    ...          ${os_password}=${OS_PASSWORD}
134
135    # Description of arguments:
136    # ${os_host} IP address of the OS Host.
137    # ${os_username}  OS Host Login user name.
138    # ${os_password}  OS Host Login passwrd.
139
140    Redfish Power On  stack_mode=skip  quiet=1
141
142    SSHLibrary.Open Connection  ${os_host}
143    ${resp}=  SSHLibrary.Login  ${os_username}  ${os_password}
144    [Return]  ${resp}
145
146
147Initiate Auto Reboot
148    [Documentation]  Initiate an auto reboot.
149    [Arguments]  ${milliseconds}=5000
150
151    # Description of argument(s):
152    # milliseconds  The number of milliseconds for the watchdog timer.
153
154    # Set the auto reboot policy.
155    Set Auto Reboot  ${1}
156    # Set the watchdog timer.
157    Trigger Host Watchdog Error  ${milliseconds}
158
159
160Initiate OS Host Reboot
161    [Documentation]  Initiate an OS reboot.
162    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
163    ...          ${os_password}=${OS_PASSWORD}
164
165    # Description of argument(s):
166    # os_host      The host name or IP address of the OS.
167    # os_username  The username to be used to sign in to the OS.
168    # os_password  The password to be used to sign in to the OS.
169
170    ${cmd_buf}=  Run Keyword If  '${os_username}' == 'root'
171    ...      Set Variable  reboot
172    ...  ELSE
173    ...      Set Variable  echo ${os_password} | sudo -S reboot
174
175    ${output}  ${stderr}  ${rc}=  OS Execute Command
176    ...  ${cmd_buf}  fork=${1}
177
178
179Initiate OS Host Power Off
180    [Documentation]  Initiate an OS reboot.
181    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
182    ...          ${os_password}=${OS_PASSWORD}  ${hard}=${0}
183
184    # Description of argument(s):
185    # os_host      The DNS name or IP of the OS.
186    # os_username  The username to be used to sign in to the OS.
187    # os_password  The password to be used to sign in to the OS.
188    # hard         Indicates whether to do a hard vs. soft power off.
189
190    ${time_string}=  Run Keyword If  ${hard}  Set Variable  ${SPACE}now
191    ...  ELSE  Set Variable  ${EMPTY}
192
193    ${cmd_buf}=  Run Keyword If  '${os_username}' == 'root'
194    ...      Set Variable  shutdown${time_string}
195    ...  ELSE
196    ...      Set Variable  echo ${os_password} | sudo -S shutdown${time_string}
197
198    ${output}  ${stderr}  ${rc}=  OS Execute Command
199    ...  ${cmd_buf}  fork=${1}
200
201
202Set System LED State
203    [Documentation]  Set given system LED via REST.
204    [Arguments]  ${led_name}  ${led_state}
205    # Description of argument(s):
206    # led_name     System LED name (e.g. heartbeat, identify, beep).
207    # led_state    LED state to be set (e.g. On, Off).
208
209    ${args}=  Create Dictionary
210    ...  data=xyz.openbmc_project.Led.Physical.Action.${led_state}
211    Write Attribute  ${LED_PHYSICAL_URI}${led_name}  State  data=${args}
212
213    Verify LED State  ${led_name}  ${led_state}
214
215
216Read Turbo Setting Via REST
217    [Documentation]  Return turbo setting via REST.
218    # Returns 1 if TurboAllowed, 0 if not.
219
220    ${turbo_setting}=  Read Attribute
221    ...  ${CONTROL_HOST_URI}turbo_allowed  TurboAllowed
222    [Return]  ${turbo_setting}
223
224
225Set Turbo Setting Via REST
226    [Documentation]  Set turbo setting via REST.
227    [Arguments]  ${setting}  ${verify}=${False}
228
229    # Description of argument(s):
230    # setting  State to set TurboAllowed, 1=allowed, 0=not allowed.
231    # verify   If True, read the TurboAllowed setting to confirm.
232
233    ${data}=  Create Dictionary  data=${${setting}}
234    Write Attribute  ${CONTROL_HOST_URI}turbo_allowed  TurboAllowed
235    ...  verify=${verify}  data=${data}
236
237
238Set REST Logging Policy
239    [Documentation]  Enable or disable REST logging setting.
240    [Arguments]  ${policy_setting}=${True}
241
242    # Description of argument(s):
243    # policy_setting    The policy setting value which can be either
244    #                   True or False.
245
246    ${log_dict}=  Create Dictionary  data=${policy_setting}
247    Write Attribute  ${BMC_LOGGING_URI}rest_api_logs  Enabled
248    ...  data=${log_dict}  verify=${1}  expected_value=${policy_setting}
249
250
251Old Get Boot Progress
252    [Documentation]  Get the boot progress the old way (via org location).
253    [Arguments]  ${quiet}=${QUIET}
254
255    # Description of argument(s):
256    # quiet   Indicates whether this keyword should run without any output to
257    #         the console.
258
259    ${state}=  Read Attribute  ${OPENBMC_BASE_URI}sensors/host/BootProgress
260    ...  value  quiet=${quiet}
261
262    [Return]  ${state}
263
264
265Set Boot Progress Method
266    [Documentation]  Set the boot_prog_method to either 'Old' or 'New'.
267
268    # The boot progress data has moved from an 'org' location to an 'xyz'
269    # location.  This keyword will determine whether the new method of getting
270    # the boot progress is valid and will set the global boot_prog_method
271    # variable accordingly.  If boot_prog_method is already set (either by a
272    # prior call to this function or via a -v parm), this keyword will simply
273    # return.
274
275    # Note:  There are interim builds that contain boot_progress in both the
276    # old and the new location values.  It is nearly impossible for this
277    # keyword to determine whether the old boot_progress or the new one is
278    # active.  When using such builds where the old boot_progress is active,
279    # the only recourse users will have is that they may specify
280    # -v boot_prog_method:Old to force old behavior on such builds.
281
282    Run Keyword If  '${boot_prog_method}' != '${EMPTY}'  Return From Keyword
283
284    ${new_status}  ${new_value}=  Run Keyword And Ignore Error
285    ...  New Get Boot Progress
286    # If the new style read fails, the method must necessarily be "Old".
287    Run Keyword If  '${new_status}' == 'PASS'
288    ...  Run Keywords
289    ...  Set Global Variable  ${boot_prog_method}  New  AND
290    ...  Rqpvars  boot_prog_method  AND
291    ...  Return From Keyword
292
293    # Default method is "Old".
294    Set Global Variable  ${boot_prog_method}  Old
295    Rqpvars  boot_prog_method
296
297
298Initiate Power On
299    [Documentation]  Initiates the power on and waits until the Is Power On
300    ...  keyword returns that the power state has switched to on.
301    [Arguments]  ${wait}=${1}
302
303    # Description of argument(s):
304    # wait   Indicates whether to wait for a powered on state after issuing
305    #        the power on command.
306
307    @{arglist}=   Create List
308    ${args}=     Create Dictionary    data=@{arglist}
309    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  powerOn
310    ...  data=${args}
311    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
312
313    # Does caller want to wait for power on status?
314    Run Keyword If  '${wait}' == '${0}'  Return From Keyword
315    Wait Until Keyword Succeeds  3 min  10 sec  Is Power On
316
317
318Initiate Power Off
319    [Documentation]  Initiates the power off and waits until the Is Power Off
320    ...  keyword returns that the power state has switched to off.
321
322    @{arglist}=   Create List
323    ${args}=     Create Dictionary    data=@{arglist}
324    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  powerOff
325    ...  data=${args}
326    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
327    Wait Until Keyword Succeeds  1 min  10 sec  Is Power Off
328
329
330Get Boot Progress
331    [Documentation]  Get the boot progress and return it.
332    [Arguments]  ${quiet}=${QUIET}
333
334    # Description of argument(s):
335    # quiet   Indicates whether this keyword should run without any output to
336    #         the console.
337
338    Set Boot Progress Method
339    ${state}=  Run Keyword If  '${boot_prog_method}' == 'New'
340    ...      New Get Boot Progress  quiet=${quiet}
341    ...  ELSE
342    ...      Old Get Boot Progress  quiet=${quiet}
343
344    [Return]  ${state}
345
346
347New Get Boot Progress
348    [Documentation]  Get the boot progress the new way (via xyz location).
349    [Arguments]  ${quiet}=${QUIET}
350
351    # Description of argument(s):
352    # quiet   Indicates whether this keyword should run without any output to
353    #         the console.
354
355    ${state}=  Read Attribute  ${HOST_STATE_URI}  BootProgress  quiet=${quiet}
356
357    [Return]  ${state.rsplit('.', 1)[1]}
358
359
360New Get Power Policy
361    [Documentation]  Returns the BMC power policy (new method).
362    ${currentPolicy}=  Read Attribute  ${POWER_RESTORE_URI}  PowerRestorePolicy
363
364    [Return]  ${currentPolicy}
365
366
367Old Get Power Policy
368    [Documentation]  Returns the BMC power policy (old method).
369    ${currentPolicy}=  Read Attribute  ${HOST_SETTING}  power_policy
370
371    [Return]  ${currentPolicy}
372
373
374Redfish Get Power Restore Policy
375    [Documentation]  Returns the BMC power restore policy.
376
377    ${power_restore_policy}=  Redfish.Get Attribute  /redfish/v1/Systems/system  PowerRestorePolicy
378    [Return]  ${power_restore_policy}
379
380Get Auto Reboot
381    [Documentation]  Returns auto reboot setting.
382    ${setting}=  Read Attribute  ${CONTROL_HOST_URI}/auto_reboot  AutoReboot
383
384    [Return]  ${setting}
385
386
387Redfish Get Auto Reboot
388    [Documentation]  Returns auto reboot setting.
389
390    ${resp}=  Redfish.Get Attribute  /redfish/v1/Systems/system  Boot
391    [Return]  ${resp["AutomaticRetryConfig"]}
392
393
394Trigger Warm Reset
395    [Documentation]  Initiate a warm reset.
396
397    log to console    "Triggering warm reset"
398    ${data}=   create dictionary   data=@{EMPTY}
399    ${resp}=  Openbmc Post Request
400    ...  ${OPENBMC_BASE_URI}control/bmc0/action/warmReset  data=${data}
401    Should Be Equal As Strings      ${resp.status_code}     ${HTTP_OK}
402    ${session_active}=   Check If warmReset is Initiated
403    Run Keyword If   '${session_active}' == '${True}'
404    ...    Fail   msg=warm reset didn't occur
405
406    Sleep   ${SYSTEM_SHUTDOWN_TIME}min
407    Check If BMC Is Up
408
409
410Get Power State
411    [Documentation]  Returns the power state as an integer. Either 0 or 1.
412    [Arguments]  ${quiet}=${QUIET}
413
414    # Description of argument(s):
415    # quiet   Indicates whether this keyword should run without any output to
416    #         the console.
417
418    @{arglist}=  Create List
419    ${args}=  Create Dictionary  data=@{arglist}
420
421    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  getPowerState
422    ...        data=${args}  quiet=${quiet}
423    Should be equal as strings  ${resp.status_code}  ${HTTP_OK}
424
425    [Return]  ${resp.json()["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    ...  ${EXECDIR}${/}tmp${/}${OPENBMC_HOST}_${TEST_NAME.replace(' ', '')}_os_console.txt
490    ...  ${EXECDIR}${/}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
512    # Make sure path ends with slash.
513    ${path}=  Add Trailing Slash  ${path}
514
515    ${resp}=  Read Properties  ${path}enumerate  timeout=30
516    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.
522    ${resp}=  Get Matches  ${list}  regexp=^.*[0-9a-z_].${endpoint}\[_0-9a-z]*$  case_insensitive=${True}
523
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.
551    [Arguments]  ${quiet}=${0}
552    # Description of argument(s):
553    # quiet    If enabled, turns off logging to console.
554
555    # Check if error logs entries exist, if not return.
556    ${resp}=  OpenBMC Get Request  ${BMC_LOGGING_ENTRY}list  quiet=${1}
557    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}
561    FOR  ${entry}  IN  @{elog_entries}
562        Delete Error Log Entry  ${entry}  quiet=${quiet}
563    END
564
565
566Delete All Error Logs
567    [Documentation]  Delete all error log entries using "DeleteAll" interface.
568
569    ${args}=  Set Variable   {"data": []}
570    ${resp}=  Openbmc Post Request  ${BMC_LOGGING_URI}action/DeleteAll
571    ...  data=${args}
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.
585
586    # Example:
587    # 0  - indicates chip select is current side.
588    # 32 - indicates chip select is alternate side.
589
590    ${boot_side}  ${stderr}  ${rc}=  BMC Execute Command
591    ...  cat /sys/class/watchdog/watchdog1/bootstatus
592
593    [Return]  ${boot_side}
594
595
596Watchdog 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.
602
603
604Get System LED State
605    [Documentation]  Return the state of given system LED.
606    [Arguments]  ${led_name}
607
608    # Description of argument(s):
609    # led_name     System LED name (e.g. heartbeat, identify, beep).
610
611    ${state}=  Read Attribute  ${LED_PHYSICAL_URI}${led_name}  State
612    [Return]  ${state.rsplit('.', 1)[1]}
613
614
615Verify 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).
621
622    ${state}=  Get System LED State  ${led_name}
623    Should Be Equal  ${state}  ${led_state}
624
625
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}
636
637
638Verify Identify LED State
639    [Documentation]  Verify that the identify state of the LED group matches caller's expectations.
640    [Arguments]  ${expected_state}
641
642    # Description of argument(s):
643    # expected_state  The expected LED asserted state (1 = asserted, 0 = not asserted).
644
645    ${led_state}=  Get LED State XYZ  enclosure_identify
646    Should Be Equal  ${led_state}  ${expected_state}  msg=Unexpected LED state.
647
648Verify The Attribute
649    [Documentation]  Verify the given attribute.
650    [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.
661
662
663New Set Power Policy
664    [Documentation]   Set the given BMC power policy (new method).
665    [Arguments]   ${policy}
666
667    # Description of argument(s):
668    # policy    Power restore policy (e.g. ${ALWAYS_POWER_OFF}).
669
670    ${valueDict}=  Create Dictionary  data=${policy}
671    Write Attribute
672    ...  ${POWER_RESTORE_URI}  PowerRestorePolicy  data=${valueDict}
673
674
675Old Set Power Policy
676    [Documentation]   Set the given BMC power policy (old method).
677    [Arguments]   ${policy}
678
679    # Description of argument(s):
680    # 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}
684
685
686Redfish 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
697IPMI Set Power Restore Policy
698    [Documentation]   Set the BMC power restore policy using IPMI.
699    [Arguments]   ${power_restore_policy}=always-off
700
701    # Description of argument(s):
702    # power_restore_policy    Power restore policies
703    #                         always-on   : turn on when power is restored
704    #                         previous    : return to previous state when power is restored
705    #                         always-off  : stay off after power is restored
706
707    ${resp}=  Run IPMI Standard Command  chassis policy ${power_restore_policy}
708    # Example:  Set chassis power restore policy to always-off
709    Should Contain  ${resp}  ${power_restore_policy}
710
711
712Set Auto Reboot Setting
713    [Documentation]  Set the given auto reboot setting (REST or Redfish).
714    [Arguments]  ${value}
715
716    # Description of argument(s):
717    # value    The reboot setting, 1 for enabling and 0 for disabling.
718
719    # This is to cater to boot call points and plugin script which will always
720    # send using value 0 or 1. This dictionary maps to redfish string values.
721    ${rest_redfish_dict}=  Create Dictionary
722    ...                    1=RetryAttempts
723    ...                    0=Disabled
724
725    Run Keyword If  ${REDFISH_SUPPORT_TRANS_STATE} == ${1}
726    ...    Redfish Set Auto Reboot  ${rest_redfish_dict["${value}"]}
727    ...  ELSE
728    ...    Set Auto Reboot  ${value}
729
730Set Auto Reboot
731    [Documentation]  Set the given auto reboot setting.
732    [Arguments]  ${setting}
733
734    # Description of argument(s):
735    # setting    The reboot setting, 1 for enabling and 0 for disabling.
736
737    ${valueDict}=  Convert To Integer  ${setting}
738    ${data}=  Create Dictionary  data=${valueDict}
739    Write Attribute  ${CONTROL_HOST_URI}/auto_reboot  AutoReboot   data=${data}
740    ${current_setting}=  Get Auto Reboot
741    Should Be Equal As Integers  ${current_setting}  ${setting}
742
743
744Redfish Set Auto Reboot
745    [Documentation]  Set the given auto reboot setting.
746    [Arguments]  ${setting}
747
748    # Description of argument(s):
749    # setting    The reboot setting, "RetryAttempts" and "Disabled".
750
751    Redfish.Patch  /redfish/v1/Systems/system  body={"Boot": {"AutomaticRetryConfig": "${setting}"}}
752    ...  valid_status_codes=[${HTTP_OK}, ${HTTP_NO_CONTENT}]
753
754    ${current_setting}=  Redfish Get Auto Reboot
755    Should Be Equal As Strings  ${current_setting}  ${setting}
756
757
758Set Control Boot Mode
759    [Documentation]  Set given boot mode on the boot object path attribute.
760    [Arguments]  ${boot_path}  ${boot_mode}
761
762    # Description of argument(s):
763    # boot_path  Boot object path.
764    #            Example:
765    #            /xyz/openbmc_project/control/host0/boot
766    #            /xyz/openbmc_project/control/host0/boot/one_time
767    # boot_mode  Boot mode which need to be set.
768    #            Example:
769    #            "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"
770
771    ${valueDict}=  Create Dictionary  data=${boot_mode}
772    Write Attribute  ${boot_path}  BootMode  data=${valueDict}
773
774
775Is Power On
776    [Documentation]  Verify that the BMC chassis state is on.
777    ${state}=  Get Power State
778    Should be equal  ${state}  ${1}
779
780
781Is Power Off
782    [Documentation]  Verify that the BMC chassis state is off.
783    ${state}=  Get Power State
784    Should be equal  ${state}  ${0}
785
786
787CLI Get BMC DateTime
788    [Documentation]  Returns BMC date time from date command.
789
790    ${bmc_time_via_date}  ${stderr}  ${rc}=  BMC Execute Command  date +"%Y-%m-%d %H:%M:%S"  print_err=1
791    [Return]  ${bmc_time_via_date}
792
793
794Update Root Password
795    [Documentation]  Update system "root" user password.
796    [Arguments]  ${openbmc_password}=${OPENBMC_PASSWORD}
797
798    # Description of argument(s):
799    # openbmc_password   The root password for the open BMC system.
800
801    @{password}=  Create List  ${openbmc_password}
802    ${data}=  Create Dictionary  data=@{password}
803
804    ${headers}=  Create Dictionary  Content-Type=application/json  X-Auth-Token=${XAUTH_TOKEN}
805    ${resp}=  POST On Session  openbmc  ${BMC_USER_URI}root/action/SetPassword
806    ...  data=${data}  headers=${headers}
807    Valid Value  resp.status_code  [${HTTP_OK}]
808
809
810Get Post Boot Action
811    [Documentation]  Get post boot action.
812
813    # Post code update action dictionary.
814    #
815    # {
816    #    BMC image: {
817    #        OnReset: Redfish OBMC Reboot (off),
818    #        Immediate: Wait For Reboot  start_boot_seconds=${state['epoch_seconds']}
819    #    },
820    #    Host image: {
821    #        OnReset: RF SYS GracefulRestart,
822    #        Immediate: Wait State  os_running_match_state  10 mins
823    #    }
824    # }
825
826    ${code_base_dir_path}=  Get Code Base Dir Path
827    ${post_code_update_actions}=  Evaluate
828    ...  json.load(open('${code_base_dir_path}data/applytime_table.json'))  modules=json
829    Rprint Vars  post_code_update_actions
830
831    [Return]  ${post_code_update_actions}
832
833
834Get Task State From File
835    [Documentation]  Get task states from pre-define data/task_state.json file.
836
837    # Example:  Task state JSON format.
838    #
839    # {
840    #   "TaskRunning": {
841    #           "TaskState": "Running",
842    #           "TaskStatus": "OK"
843    #   },
844    #   "TaskCompleted": {
845    #           "TaskState": "Completed",
846    #           "TaskStatus": "OK"
847    #   },
848    #   "TaskException": {
849    #           "TaskState": "Exception",
850    #           "TaskStatus": "Warning"
851    #   }
852    # }
853
854    # Python module: get_code_base_dir_path()
855    ${code_base_dir_path}=  Get Code Base Dir Path
856    ${task_state}=  Evaluate
857    ...  json.load(open('${code_base_dir_path}data/task_state.json'))  modules=json
858    Rprint Vars  task_state
859
860    [Return]  ${task_state}
861
862
863Redfish Set Boot Default
864    [Documentation]  Set and Verify Boot source override
865    [Arguments]      ${override_enabled}  ${override_target}  ${override_mode}=UEFI
866
867    # Description of argument(s):
868    # override_enabled    Boot source override enable type.
869    #                     ('Once', 'Continuous', 'Disabled').
870    # override_target     Boot source override target.
871    #                     ('Pxe', 'Cd', 'Hdd', 'Diags', 'BiosSetup', 'None').
872    # override_mode       Boot source override mode (relevant only for x86 arch).
873    #                     ('Legacy', 'UEFI').
874
875    ${data}=  Create Dictionary  BootSourceOverrideEnabled=${override_enabled}
876    ...  BootSourceOverrideTarget=${override_target}
877
878    Run Keyword If  '${PLATFORM_ARCH_TYPE}' == 'x86'
879    ...  Set To Dictionary  ${data}  BootSourceOverrideMode  ${override_mode}
880
881    ${payload}=  Create Dictionary  Boot=${data}
882
883    Redfish.Patch  /redfish/v1/Systems/system  body=&{payload}
884    ...  valid_status_codes=[${HTTP_OK},${HTTP_NO_CONTENT}]
885
886    ${resp}=  Redfish.Get Attribute  /redfish/v1/Systems/system  Boot
887    Should Be Equal As Strings  ${resp["BootSourceOverrideEnabled"]}  ${override_enabled}
888    Should Be Equal As Strings  ${resp["BootSourceOverrideTarget"]}  ${override_target}
889    Run Keyword If  '${PLATFORM_ARCH_TYPE}' == 'x86'
890    ...  Should Be Equal As Strings  ${resp["BootSourceOverrideMode"]}  ${override_mode}
891
892
893# Redfish state keywords.
894
895Redfish Get BMC State
896    [Documentation]  Return BMC health state.
897
898    # "Enabled" ->  BMC Ready, "Starting" -> BMC NotReady
899
900    # Example:
901    # "Status": {
902    #    "Health": "OK",
903    #    "HealthRollup": "OK",
904    #    "State": "Enabled"
905    # },
906
907    ${status}=  Redfish.Get Attribute  /redfish/v1/Managers/${MANAGER_ID}  Status
908    [Return]  ${status["State"]}
909
910
911Redfish Verify BMC State
912    [Documentation]  Verify BMC state is enabled.
913    [Arguments]  ${match_state}=Enabled
914
915    # Description of argument(s):
916    # match_state    Expected match state (e.g. Enabled, Starting, Error)
917
918    ${Status}=  Redfish.Get Attribute  /redfish/v1/Managers/bmc  Status
919
920    Should Be Equal As Strings  ${match_state}  ${Status['State']}
921
922
923Redfish Get Host State
924    [Documentation]  Return host power and health state.
925
926    # Refer: http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status
927
928    # Example:
929    # "PowerState": "Off",
930    # "Status": {
931    #    "Health": "OK",
932    #    "HealthRollup": "OK",
933    #    "State": "StandbyOffline"
934    # },
935
936    ${chassis}=  Redfish.Get Properties  /redfish/v1/Chassis/${CHASSIS_ID}
937    [Return]  ${chassis["PowerState"]}  ${chassis["Status"]["State"]}
938
939
940Redfish Get Boot Progress
941    [Documentation]  Return boot progress state.
942
943    # Example: /redfish/v1/Systems/system/
944    # "BootProgress": {
945    #    "LastState": "OSRunning"
946    # },
947
948    ${boot_progress}=  Redfish.Get Properties  /redfish/v1/Systems/system/
949
950    Return From Keyword If  "${PLATFORM_ARCH_TYPE}" == "x86"
951    ...  NA  ${boot_progress["Status"]["State"]}
952
953    [Return]  ${boot_progress["BootProgress"]["LastState"]}  ${boot_progress["Status"]["State"]}
954
955
956Redfish Get States
957    [Documentation]  Return all the BMC and host states in dictionary.
958    [Timeout]  120 Seconds
959
960    # Refer: openbmc/docs/designs/boot-progress.md
961
962    Redfish.Login
963
964    ${bmc_state}=  Redfish Get BMC State
965    ${chassis_state}  ${chassis_status}=  Redfish Get Host State
966    ${boot_progress}  ${host_state}=  Redfish Get Boot Progress
967
968    ${states}=  Create Dictionary
969    ...  bmc=${bmc_state}
970    ...  chassis=${chassis_state}
971    ...  host=${host_state}
972    ...  boot_progress=${boot_progress}
973
974    # Disable loggoing state to prevent huge log.html record when boot
975    # test is run in loops.
976    #Log  ${states}
977
978    [Return]  ${states}
979
980
981Is BMC Not Quiesced
982    [Documentation]  Verify BMC state is not quiesced.
983
984    ${bmc_state}=   Redfish Get States
985
986    Log To Console  BMC State : ${bmc_state}
987
988    Should Not Be Equal As Strings  Quiesced  ${bmc_state['bmc']}
989
990
991Is BMC Standby
992    [Documentation]  Check if BMC is ready and host at standby.
993
994    ${standby_states}=  Create Dictionary
995    ...  bmc=Enabled
996    ...  chassis=Off
997    ...  host=Disabled
998    ...  boot_progress=None
999
1000    Run Keyword If  '${PLATFORM_ARCH_TYPE}' == 'x86'
1001    ...  Set To Dictionary  ${standby_states}  boot_progress=NA
1002
1003    Wait Until Keyword Succeeds  3 min  10 sec  Redfish Get States
1004
1005    Wait Until Keyword Succeeds  5 min  10 sec  Match State  ${standby_states}
1006
1007
1008Match State
1009    [Documentation]  Check if the expected and current states are matched.
1010    [Arguments]  ${match_state}
1011
1012    # Description of argument(s):
1013    # match_state      Expected states in dictionary.
1014
1015    ${current_state}=  Redfish Get States
1016    Dictionaries Should Be Equal  ${match_state}  ${current_state}
1017
1018
1019Wait For Host Boot Progress To Reach Required State
1020    [Documentation]  Wait till host boot progress reaches required state.
1021    [Arguments]      ${expected_boot_state}=OSRunning
1022
1023    # Description of argument(s):
1024    # expected_boot_state    Expected boot state. E.g. OSRunning, SystemInitComplete etc.
1025
1026    Wait Until Keyword Succeeds  ${power_on_timeout}  20 sec
1027    ...  Is Boot Progress At Required State  ${expected_boot_state}
1028
1029
1030Redfish Initiate Auto Reboot
1031    [Documentation]  Initiate an auto reboot.
1032    [Arguments]  ${interval}=2000
1033
1034    # Description of argument(s):
1035    # interval  Value in milliseconds to set Watchdog interval
1036
1037    # Set auto reboot policy
1038    Redfish Set Auto Reboot  RetryAttempts
1039
1040    Redfish Power Operation  On
1041
1042    Wait Until Keyword Succeeds  2 min  5 sec  Is Boot Progress Changed
1043
1044    # Set watchdog timer
1045    Set Watchdog Interval Using Busctl  ${interval}
1046
1047
1048Is Boot Progress Changed
1049    [Documentation]  Get BootProgress state and expect boot state mismatch.
1050    [Arguments]  ${boot_state}=None
1051
1052    # Description of argument(s):
1053    # boot_state   Value of the BootProgress state to match against.
1054
1055    ${boot_progress}  ${host_state}=  Redfish Get Boot Progress
1056
1057    Should Not Be Equal  ${boot_progress}   ${boot_state}
1058
1059
1060Is Boot Progress At Required State
1061    [Documentation]  Get BootProgress state and expect boot state to match.
1062    [Arguments]  ${boot_state}=None
1063
1064    # Description of argument(s):
1065    # boot_state   Value of the BootProgress state to match.
1066
1067    ${boot_progress}  ${host_state}=  Redfish Get Boot Progress
1068
1069    Should Be Equal  ${boot_progress}   ${boot_state}
1070
1071
1072Is Boot Progress At Any State
1073    [Documentation]  Get BootProgress state and expect boot state to match
1074    ...              with any of the states mentioned in the list.
1075    [Arguments]  ${boot_states}=@{BOOT_PROGRESS_STATES}
1076
1077    # Description of argument(s):
1078    # boot_states   List of the BootProgress states to match.
1079
1080    ${boot_progress}  ${host_state}=  Redfish Get Boot Progress
1081    Should Contain Any  ${boot_progress}  @{boot_states}
1082
1083
1084Is Host At State
1085    [Documentation]  Get Host state and check if it matches
1086    ...   user input expected state.
1087    [Arguments]  ${expected_host_state}
1088
1089    # Description of argument(s):
1090    # expected_host_state  Expected Host State to check.(e.g. Quiesced).
1091
1092    ${boot_progress}  ${host_state}=  Redfish Get Boot Progress
1093
1094    Should Be Equal  ${host_state}  ${expected_host_state}
1095
1096
1097Set Watchdog Interval Using Busctl
1098    [Documentation]  Set Watchdog time interval.
1099    [Arguments]  ${milliseconds}=1000
1100
1101    # Description of argument(s):
1102    # milliseconds     Time interval for watchdog timer
1103
1104    ${cmd}=  Catenate  busctl set-property xyz.openbmc_project.Watchdog
1105    ...                /xyz/openbmc_project/watchdog/host0
1106    ...                xyz.openbmc_project.State.Watchdog Interval t ${milliseconds}
1107    BMC Execute Command  ${cmd}
1108
1109
1110Stop PLDM Service And Wait
1111    [Documentation]  Stop PLDM service and wait for Host to initiate reset.
1112
1113    BMC Execute Command  systemctl stop pldmd.service
1114
1115
1116Get BIOS Attribute
1117    [Documentation]  Get the BIOS attribute for /redfish/v1/Systems/system/Bios.
1118
1119    # Python module:  get_member_list(resource_path)
1120    ${systems}=  Redfish_Utils.Get Member List  /redfish/v1/Systems
1121    ${bios_attr_dict}=  Redfish.Get Attribute  ${systems[0]}/Bios  Attributes
1122
1123    [Return]  ${bios_attr_dict}
1124
1125
1126Set BIOS Attribute
1127    [Documentation]  PATCH the BIOS attribute for /redfish/v1/Systems/system/Bios.
1128    [Arguments]  ${attribute_name}  ${attribute_value}
1129
1130    # Description of argument(s):
1131    # attribute_name     Any valid BIOS attribute.
1132    # attribute_value    Valid allowed attribute values.
1133
1134    # Python module:  get_member_list(resource_path)
1135    ${systems}=  Redfish_Utils.Get Member List  /redfish/v1/Systems
1136    Redfish.Patch  ${systems[0]}/Bios/Settings  body={"Attributes":{"${attribute_name}":"${attribute_value}"}}
1137
1138
1139Is BMC Operational
1140    [Documentation]  Check if BMC is enabled.
1141    [Teardown]  Redfish.Logout
1142
1143    Wait Until Keyword Succeeds  5 min  5 sec  Ping Host  ${OPENBMC_HOST}
1144    # In some of bmc stack, network services will gets loaded before redfish/ipmi services gets loaded.
1145    # Hence, 3mins sleep time is added to allow other service gets loaded.
1146    Sleep  180s
1147    Redfish.login
1148    ${bmc_status}=  Redfish Get BMC State
1149    Should Be Equal  ${bmc_status}  Enabled
1150
1151
1152PLDM Set BIOS Attribute
1153    [Documentation]  Set the BIOS attribute via pldmtool and verify the attribute is set.
1154    ...              Defaulted for fw_boot_side for boot test usage caller.
1155    [Arguments]  ${attribute_name}=fw_boot_side  ${attribute_value}=Temp
1156
1157    # Description of argument(s):
1158    # attribute_name      Valid BIOS attribute name e.g ("fw_boot_side")
1159    # attribute_value     Valid BIOS attribute value for fw_boot_side.
1160
1161    # PLDM response output example:
1162    # {
1163    #    "Response": "SUCCESS"
1164    # }
1165
1166    ${resp}=  pldmtool  bios SetBIOSAttributeCurrentValue -a ${attribute_name} -d ${attribute_value}
1167    Should Be Equal As Strings  ${resp["Response"]}  SUCCESS
1168
1169    # PLDM GET output example:
1170    # {
1171    #    "CurrentValue": "Temp"
1172    # }
1173
1174    ${pldm_output}=  PLDM Get BIOS Attribute  ${attribute_name}
1175    Should Be Equal As Strings  ${pldm_output["CurrentValue"]}  ${attribute_value}
1176    ...  msg=Expecting ${attribute_value} but got ${pldm_output["CurrentValue"]}
1177
1178
1179PLDM Get BIOS Attribute
1180    [Documentation]  Get the BIOS attribute via pldmtool for a given attribute and return value.
1181    [Arguments]  ${attribute_name}
1182
1183    # Description of argument(s):
1184    # attribute_name     Valid BIOS attribute name e.g ("fw_boot_side")
1185
1186    ${pldm_output}=  pldmtool  bios GetBIOSAttributeCurrentValueByHandle -a ${attribute_name}
1187    [Return]  ${pldm_output}
1188
1189
1190Verify Host Power State
1191    [Documentation]  Get the Host Power state and compare it with the expected state.
1192    [Arguments]  ${expected_power_state}
1193
1194    # Description of argument(s):
1195    # expected_power_state   State of Host e.g. Off or On.
1196
1197    ${power_state}  ${health_status}=  Redfish Get Host State
1198    Should Be Equal  ${power_state}  ${expected_power_state}
1199
1200
1201Verify Host Is Up
1202    [Documentation]  Verify Host is Up.
1203
1204    Wait Until Keyword Succeeds  3 min  30 sec  Verify Host Power State  On
1205    # Python module:  os_execute(cmd)
1206    Wait Until Keyword Succeeds  10 min  30 sec  OS Execute Command  uptime
1207