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
10Library                 String
11Library                 DateTime
12Library                 Process
13Library                 OperatingSystem
14Library                 gen_print.py
15Library                 gen_misc.py
16Library                 gen_robot_print.py
17Library                 gen_cmd.py
18Library                 gen_robot_keyword.py
19Library                 bmc_ssh_utils.py
20Library                 utils.py
21Library                 var_funcs.py
22Library                 SCPLibrary  WITH NAME  scp
23Library                 gen_robot_valid.py
24
25
26*** Variables ***
27
28${SYSTEM_SHUTDOWN_TIME}   ${5}
29
30# Assign default value to QUIET for programs which may not define it.
31${QUIET}  ${0}
32
33${HOST_SETTING}    ${SETTINGS_URI}host0
34
35${boot_prog_method}               ${EMPTY}
36${power_policy_setup}             ${0}
37${bmc_power_policy_method}        ${EMPTY}
38
39
40*** Keywords ***
41
42
43Verify Ping and REST Authentication
44    [Documentation]  Verify ping and rest authentication.
45    ${l_ping}=   Run Keyword And Return Status
46    ...    Ping Host  ${OPENBMC_HOST}
47    Run Keyword If  '${l_ping}' == '${False}'
48    ...    Fail   msg=Ping Failed
49
50    ${l_rest}=   Run Keyword And Return Status
51    ...    Initialize OpenBMC
52    Run Keyword If  '${l_rest}' == '${False}'
53    ...    Fail   msg=REST Authentication Failed
54
55    # Just to make sure the SSH is working for SCP
56    Open Connection And Log In
57    ${system}   ${stderr}=    Execute Command   hostname   return_stderr=True
58    Should Be Empty     ${stderr}
59
60
61Check If BMC is Up
62    [Documentation]  Wait for Host to be online. Checks every X seconds
63    ...              interval for Y minutes and fails if timed out.
64    ...              Default MAX timedout is 10 min, interval 10 seconds.
65    [Arguments]      ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
66    ...              ${interval}=10 sec
67
68    # Description of argument(s):
69    # max_timeout   Maximum time to wait.
70    #               This should be expressed in Robot Framework's time format
71    #               (e.g. "10 minutes").
72    # interfal      Interval to wait between status checks.
73    #               This should be expressed in Robot Framework's time format
74    #               (e.g. "5 seconds").
75
76    Wait Until Keyword Succeeds
77    ...   ${max_timeout}  ${interval}   Verify Ping and REST Authentication
78
79
80Flush REST Sessions
81    [Documentation]   Removes all the active session objects
82    Delete All Sessions
83
84
85Trigger Host Watchdog Error
86    [Documentation]  Inject host watchdog timeout error via REST.
87    [Arguments]  ${milliseconds}=1000  ${sleep_time}=5s
88
89    # Description of argument(s):
90    # milliseconds  The time watchdog timer value in milliseconds (e.g. 1000 =
91    #               1 second).
92    # sleep_time    Time delay for host watchdog error to get injected.
93    #               Default is 5 seconds.
94
95    ${data}=  Create Dictionary
96    ...  data=xyz.openbmc_project.State.Watchdog.Action.PowerCycle
97    ${status}  ${result}=  Run Keyword And Ignore Error
98    ...  Read Attribute  ${HOST_WATCHDOG_URI}  ExpireAction
99    Run Keyword If  '${status}' == 'PASS'
100    ...  Write Attribute  ${HOST_WATCHDOG_URI}  ExpireAction  data=${data}
101
102    ${int_milliseconds}=  Convert To Integer  ${milliseconds}
103    ${data}=  Create Dictionary  data=${int_milliseconds}
104    Write Attribute  ${HOST_WATCHDOG_URI}  Interval  data=${data}
105
106    ${data}=  Create Dictionary  data=${True}
107    Write Attribute  ${HOST_WATCHDOG_URI}  Enabled  data=${data}
108
109    Sleep  ${sleep_time}
110
111
112Login To OS Host
113    [Documentation]  Login to OS Host and return the Login response code.
114    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
115    ...          ${os_password}=${OS_PASSWORD}
116
117    # Description of arguments:
118    # ${os_host} IP address of the OS Host.
119    # ${os_username}  OS Host Login user name.
120    # ${os_password}  OS Host Login passwrd.
121
122    REST Power On  stack_mode=skip  quiet=1
123
124    SSHLibrary.Open Connection  ${os_host}
125    ${resp}=  SSHLibrary.Login  ${os_username}  ${os_password}
126    [Return]  ${resp}
127
128
129Initiate Auto Reboot
130    [Documentation]  Initiate an auto reboot.
131    [Arguments]  ${milliseconds}=5000
132
133    # Description of argument(s):
134    # milliseconds  The number of milliseconds for the watchdog timer.
135
136    # Set the auto reboot policy.
137    Set Auto Reboot  ${1}
138    # Set the watchdog timer.
139    Trigger Host Watchdog Error  ${milliseconds}
140
141
142Initiate OS Host Reboot
143    [Documentation]  Initiate an OS reboot.
144    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
145    ...          ${os_password}=${OS_PASSWORD}
146
147    # Description of argument(s):
148    # os_host      The host name or IP address of the OS.
149    # os_username  The username to be used to sign in to the OS.
150    # os_password  The password to be used to sign in to the OS.
151
152    ${cmd_buf}=  Run Keyword If  '${os_username}' == 'root'
153    ...      Set Variable  reboot
154    ...  ELSE
155    ...      Set Variable  echo ${os_password} | sudo -S reboot
156
157    ${output}  ${stderr}  ${rc}=  OS Execute Command
158    ...  ${cmd_buf}  fork=${1}
159
160
161Initiate OS Host Power Off
162    [Documentation]  Initiate an OS reboot.
163    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
164    ...          ${os_password}=${OS_PASSWORD}  ${hard}=${0}
165
166    # Description of argument(s):
167    # os_host      The DNS name or IP of the OS.
168    # os_username  The username to be used to sign in to the OS.
169    # os_password  The password to be used to sign in to the OS.
170    # hard         Indicates whether to do a hard vs. soft power off.
171
172    ${time_string}=  Run Keyword If  ${hard}  Set Variable  ${SPACE}now
173    ...  ELSE  Set Variable  ${EMPTY}
174
175    ${cmd_buf}=  Run Keyword If  '${os_username}' == 'root'
176    ...      Set Variable  shutdown${time_string}
177    ...  ELSE
178    ...      Set Variable  echo ${os_password} | sudo -S shutdown${time_string}
179
180    ${output}  ${stderr}  ${rc}=  OS Execute Command
181    ...  ${cmd_buf}  fork=${1}
182
183
184Set System LED State
185    [Documentation]  Set given system LED via REST.
186    [Arguments]  ${led_name}  ${led_state}
187    # Description of argument(s):
188    # led_name     System LED name (e.g. heartbeat, identify, beep).
189    # led_state    LED state to be set (e.g. On, Off).
190
191    ${args}=  Create Dictionary
192    ...  data=xyz.openbmc_project.Led.Physical.Action.${led_state}
193    Write Attribute  ${LED_PHYSICAL_URI}${led_name}  State  data=${args}
194
195    Verify LED State  ${led_name}  ${led_state}
196
197
198Read Turbo Setting Via REST
199    [Documentation]  Return turbo setting via REST.
200    # Returns 1 if TurboAllowed, 0 if not.
201
202    ${turbo_setting}=  Read Attribute
203    ...  ${CONTROL_HOST_URI}turbo_allowed  TurboAllowed
204    [Return]  ${turbo_setting}
205
206
207Set Turbo Setting Via REST
208    [Documentation]  Set turbo setting via REST.
209    [Arguments]  ${setting}  ${verify}=${False}
210
211    # Description of argument(s):
212    # setting  State to set TurboAllowed, 1=allowed, 0=not allowed.
213    # verify   If True, read the TurboAllowed setting to confirm.
214
215    ${data}=  Create Dictionary  data=${${setting}}
216    Write Attribute  ${CONTROL_HOST_URI}turbo_allowed  TurboAllowed
217    ...  verify=${verify}  data=${data}
218
219
220Set REST Logging Policy
221    [Documentation]  Enable or disable REST logging setting.
222    [Arguments]  ${policy_setting}=${True}
223
224    # Description of argument(s):
225    # policy_setting    The policy setting value which can be either
226    #                   True or False.
227
228    ${log_dict}=  Create Dictionary  data=${policy_setting}
229    Write Attribute  ${BMC_LOGGING_URI}rest_api_logs  Enabled
230    ...  data=${log_dict}  verify=${1}  expected_value=${policy_setting}
231
232
233Old Get Boot Progress
234    [Documentation]  Get the boot progress the old way (via org location).
235    [Arguments]  ${quiet}=${QUIET}
236
237    # Description of argument(s):
238    # quiet   Indicates whether this keyword should run without any output to
239    #         the console.
240
241    ${state}=  Read Attribute  ${OPENBMC_BASE_URI}sensors/host/BootProgress
242    ...  value  quiet=${quiet}
243
244    [Return]  ${state}
245
246
247Set Boot Progress Method
248    [Documentation]  Set the boot_prog_method to either 'Old' or 'New'.
249
250    # The boot progress data has moved from an 'org' location to an 'xyz'
251    # location.  This keyword will determine whether the new method of getting
252    # the boot progress is valid and will set the global boot_prog_method
253    # variable accordingly.  If boot_prog_method is already set (either by a
254    # prior call to this function or via a -v parm), this keyword will simply
255    # return.
256
257    # Note:  There are interim builds that contain boot_progress in both the
258    # old and the new location values.  It is nearly impossible for this
259    # keyword to determine whether the old boot_progress or the new one is
260    # active.  When using such builds where the old boot_progress is active,
261    # the only recourse users will have is that they may specify
262    # -v boot_prog_method:Old to force old behavior on such builds.
263
264    Run Keyword If  '${boot_prog_method}' != '${EMPTY}'  Return From Keyword
265
266    ${new_status}  ${new_value}=  Run Keyword And Ignore Error
267    ...  New Get Boot Progress
268    # If the new style read fails, the method must necessarily be "Old".
269    Run Keyword If  '${new_status}' == 'PASS'
270    ...  Run Keywords
271    ...  Set Global Variable  ${boot_prog_method}  New  AND
272    ...  Rqpvars  boot_prog_method  AND
273    ...  Return From Keyword
274
275    # Default method is "Old".
276    Set Global Variable  ${boot_prog_method}  Old
277    Rqpvars  boot_prog_method
278
279
280Initiate Power On
281    [Documentation]  Initiates the power on and waits until the Is Power On
282    ...  keyword returns that the power state has switched to on.
283    [Arguments]  ${wait}=${1}
284
285    # Description of argument(s):
286    # wait   Indicates whether to wait for a powered on state after issuing
287    #        the power on command.
288
289    @{arglist}=   Create List
290    ${args}=     Create Dictionary    data=@{arglist}
291    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  powerOn
292    ...  data=${args}
293    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
294
295    # Does caller want to wait for power on status?
296    Run Keyword If  '${wait}' == '${0}'  Return From Keyword
297    Wait Until Keyword Succeeds  3 min  10 sec  Is Power On
298
299
300Initiate Power Off
301    [Documentation]  Initiates the power off and waits until the Is Power Off
302    ...  keyword returns that the power state has switched to off.
303
304    @{arglist}=   Create List
305    ${args}=     Create Dictionary    data=@{arglist}
306    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  powerOff
307    ...  data=${args}
308    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
309    Wait Until Keyword Succeeds  1 min  10 sec  Is Power Off
310
311
312Get Boot Progress
313    [Documentation]  Get the boot progress and return it.
314    [Arguments]  ${quiet}=${QUIET}
315
316    # Description of argument(s):
317    # quiet   Indicates whether this keyword should run without any output to
318    #         the console.
319
320    Set Boot Progress Method
321    ${state}=  Run Keyword If  '${boot_prog_method}' == 'New'
322    ...      New Get Boot Progress  quiet=${quiet}
323    ...  ELSE
324    ...      Old Get Boot Progress  quiet=${quiet}
325
326    [Return]  ${state}
327
328
329New Get Boot Progress
330    [Documentation]  Get the boot progress the new way (via xyz location).
331    [Arguments]  ${quiet}=${QUIET}
332
333    # Description of argument(s):
334    # quiet   Indicates whether this keyword should run without any output to
335    #         the console.
336
337    ${state}=  Read Attribute  ${HOST_STATE_URI}  BootProgress  quiet=${quiet}
338
339    [Return]  ${state.rsplit('.', 1)[1]}
340
341
342New Get Power Policy
343    [Documentation]  Returns the BMC power policy (new method).
344    ${currentPolicy}=  Read Attribute  ${POWER_RESTORE_URI}  PowerRestorePolicy
345
346    [Return]  ${currentPolicy}
347
348
349Old Get Power Policy
350    [Documentation]  Returns the BMC power policy (old method).
351    ${currentPolicy}=  Read Attribute  ${HOST_SETTING}  power_policy
352
353    [Return]  ${currentPolicy}
354
355
356Get Auto Reboot
357    [Documentation]  Returns auto reboot setting.
358    ${setting}=  Read Attribute  ${CONTROL_HOST_URI}/auto_reboot  AutoReboot
359
360    [Return]  ${setting}
361
362
363Trigger Warm Reset
364    [Documentation]  Initiate a warm reset.
365
366    log to console    "Triggering warm reset"
367    ${data}=   create dictionary   data=@{EMPTY}
368    ${resp}=  openbmc post request
369    ...  ${OPENBMC_BASE_URI}control/bmc0/action/warmReset  data=${data}
370    Should Be Equal As Strings      ${resp.status_code}     ${HTTP_OK}
371    ${session_active}=   Check If warmReset is Initiated
372    Run Keyword If   '${session_active}' == '${True}'
373    ...    Fail   msg=warm reset didn't occur
374
375    Sleep   ${SYSTEM_SHUTDOWN_TIME}min
376    Check If BMC Is Up
377
378
379Get Power State
380    [Documentation]  Returns the power state as an integer. Either 0 or 1.
381    [Arguments]  ${quiet}=${QUIET}
382
383    # Description of argument(s):
384    # quiet   Indicates whether this keyword should run without any output to
385    #         the console.
386
387    @{arglist}=  Create List
388    ${args}=  Create Dictionary  data=@{arglist}
389
390    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  getPowerState
391    ...        data=${args}  quiet=${quiet}
392    Should be equal as strings  ${resp.status_code}  ${HTTP_OK}
393    ${content}=  to json  ${resp.content}
394
395    [Return]  ${content["data"]}
396
397
398Clear BMC Gard Record
399    [Documentation]  Clear gard records from the system.
400
401    @{arglist}=  Create List
402    ${args}=  Create Dictionary  data=@{arglist}
403    ${resp}=  Call Method
404    ...  ${OPENPOWER_CONTROL}gard  Reset  data=${args}
405    Should Be Equal As Strings  ${resp.status_code}  ${HTTP_OK}
406
407
408Flash PNOR
409    [Documentation]    Calls flash bios update method to flash PNOR image
410    [Arguments]    ${pnor_image}
411
412    # Description of argument(s):
413    # pnor_image  The filename and path of the PNOR image
414    #             (e.g. "/home/image/zaius.pnor").
415
416    @{arglist}=   Create List    ${pnor_image}
417    ${args}=     Create Dictionary    data=@{arglist}
418    ${resp}=  Call Method  /org/openbmc/control/flash/bios/  update
419    ...  data=${args}
420    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
421    Wait Until Keyword Succeeds    2 min   10 sec    Is PNOR Flashing
422
423
424Get Flash BIOS Status
425    [Documentation]  Returns the status of the flash BIOS API as a string. For
426    ...              example 'Flashing', 'Flash Done', etc
427    ${data}=  Read Properties  /org/openbmc/control/flash/bios
428    [Return]    ${data['status']}
429
430
431Is PNOR Flashing
432    [Documentation]  Get BIOS 'Flashing' status. This indicates that PNOR
433    ...              flashing has started.
434    ${status}=    Get Flash BIOS Status
435    Should Contain  ${status}  Flashing
436
437
438Is PNOR Flash Done
439    [Documentation]  Get BIOS 'Flash Done' status.  This indicates that the
440    ...              PNOR flashing has completed.
441    ${status}=    Get Flash BIOS Status
442    should be equal as strings     ${status}     Flash Done
443
444
445Create OS Console File Path
446    [Documentation]  Create OS console file path name and return it.
447    [Arguments]  ${log_file_path}=${EMPTY}
448
449    # Description of arguments:
450    # file_path  The caller's candidate value.  If this value is ${EMPTY}, this
451    #            keyword will compose a file path name.  Otherwise, this
452    #            keyword will use the caller's file_path value.  In either
453    #            case, the value will be returned.
454
455    ${status}=  Run Keyword And Return Status  Variable Should Exist
456    ...  ${TEST_NAME}
457
458    ${default_file_path}=  Set Variable If  ${status} == ${TRUE}
459    ...  /tmp/${OPENBMC_HOST}_${TEST_NAME.replace(' ', '')}_os_console.txt
460    ...  /tmp/${OPENBMC_HOST}_os_console.txt
461
462    ${log_file_path}=  Set Variable If  '${log_file_path}' == '${EMPTY}'
463    ...  ${default_file_path}  ${log_file_path}
464
465    [Return]  ${log_file_path}
466
467
468Get Endpoint Paths
469    [Documentation]   Returns all url paths ending with given endpoint
470    ...               Example:
471    ...               Given the following endpoint: cpu
472    ...               This keyword will return: list of all urls ending with
473    ...               cpu -
474    ...               /org/openbmc/inventory/system/chassis/motherboard/cpu0,
475    ...               /org/openbmc/inventory/system/chassis/motherboard/cpu1
476    [Arguments]   ${path}   ${endpoint}
477
478    # Description of arguments:
479    # path       URL path for enumeration.
480    # endpoint   Endpoint string (url path ending).
481
482    # Make sure path ends with slash.
483    ${path}=  Add Trailing Slash  ${path}
484
485    ${resp}=  Read Properties  ${path}enumerate  timeout=30
486    Log Dictionary  ${resp}
487
488    ${list}=  Get Dictionary Keys  ${resp}
489    # For a given string, look for prefix and suffix for matching expression.
490    # Start of string followed by zero or more of any character followed by
491    # any digit or lower case character.
492    ${resp}=  Get Matches  ${list}  regexp=^.*[0-9a-z_].${endpoint}\[0-9a-z]*$
493
494    [Return]  ${resp}
495
496
497Set BMC Power Policy
498    [Documentation]   Set the given BMC power policy.
499    [Arguments]   ${policy}
500
501    # Note that this function will translate the old style "RESTORE_LAST_STATE"
502    # policy to the new style "xyz.openbmc_project.Control.Power.RestorePolicy.
503    # Policy.Restore" for you.
504
505    # Description of argument(s):
506    # policy    Power restore policy (e.g "RESTORE_LAST_STATE",
507    #           ${RESTORE_LAST_STATE}).
508
509    # Set the bmc_power_policy_method to either 'Old' or 'New'.
510    Set Power Policy Method
511    # This translation helps bridge between old and new method for calling.
512    ${policy}=  Translate Power Policy Value  ${policy}
513    # Run the appropriate keyword.
514    Run Key  ${bmc_power_policy_method} Set Power Policy \ ${policy}
515    ${currentPolicy}=  Get System Power Policy
516    Should Be Equal    ${currentPolicy}   ${policy}
517
518
519Delete Error Logs
520    [Documentation]  Delete error logs.
521
522    # Check if error logs entries exist, if not return.
523    ${resp}=  OpenBMC Get Request  ${BMC_LOGGING_ENTRY}list  quiet=${1}
524    Return From Keyword If  ${resp.status_code} == ${HTTP_NOT_FOUND}
525
526    # Get the list of error logs entries and delete them all.
527    ${elog_entries}=  Get URL List  ${BMC_LOGGING_ENTRY}
528    :FOR  ${entry}  IN  @{elog_entries}
529    \  Delete Error Log Entry  ${entry}
530
531
532Delete All Error Logs
533    [Documentation]  Delete all error log entries using "DeleteAll" interface.
534
535    ${data}=  Create Dictionary  data=@{EMPTY}
536    ${resp}=  Openbmc Post Request  ${BMC_LOGGING_URI}action/DeleteAll
537    ...  data=${data}
538    Should Be Equal As Strings  ${resp.status_code}  ${HTTP_OK}
539
540
541Get Elog URL List
542    [Documentation]  Return error log entry list of URLs.
543
544    ${url_list}=  Read Properties  /xyz/openbmc_project/logging/entry/
545    Sort List  ${url_list}
546    [Return]  ${url_list}
547
548
549Get BMC Flash Chip Boot Side
550    [Documentation]  Return the BMC flash chip boot side.
551
552    # Example:
553    # 0  - indicates chip select is current side.
554    # 32 - indicates chip select is alternate side.
555
556    ${boot_side}  ${stderr}  ${rc}=  BMC Execute Command
557    ...  cat /sys/class/watchdog/watchdog1/bootstatus
558
559    [Return]  ${boot_side}
560
561
562Watchdog Object Should Exist
563    [Documentation]  Check that watchdog object exists.
564
565    ${resp}=  OpenBMC Get Request  ${WATCHDOG_URI}host0
566    Should Be Equal As Strings  ${resp.status_code}  ${HTTP_OK}
567    ...  msg=Expected watchdog object does not exist.
568
569
570Get System LED State
571    [Documentation]  Return the state of given system LED.
572    [Arguments]  ${led_name}
573
574    # Description of argument(s):
575    # led_name     System LED name (e.g. heartbeat, identify, beep).
576
577    ${state}=  Read Attribute  ${LED_PHYSICAL_URI}${led_name}  State
578    [Return]  ${state.rsplit('.', 1)[1]}
579
580
581Verify LED State
582    [Documentation]  Checks if LED is in given state.
583    [Arguments]  ${led_name}  ${led_state}
584    # Description of argument(s):
585    # led_name     System LED name (e.g. heartbeat, identify, beep).
586    # led_state    LED state to be verified (e.g. On, Off).
587
588    ${state}=  Get System LED State  ${led_name}
589    Should Be Equal  ${state}  ${led_state}
590
591
592Get LED State XYZ
593    [Documentation]  Returns state of given LED.
594    [Arguments]  ${led_name}
595
596    # Description of argument(s):
597    # led_name  Name of LED.
598
599    ${state}=  Read Attribute  ${LED_GROUPS_URI}${led_name}  Asserted
600    # Returns the state of the LED, either On or Off.
601    [Return]  ${state}
602
603
604Verify Identify LED State
605    [Documentation]  Verify that the identify state of the LED group matches caller's expectations.
606    [Arguments]  ${expected_state}
607
608    # Description of argument(s):
609    # expected_state  The expected LED asserted state (1 = asserted, 0 = not asserted).
610
611    ${led_state}=  Get LED State XYZ  enclosure_identify
612    Should Be Equal  ${led_state}  ${expected_state}  msg=Unexpected LED state.
613
614Verify The Attribute
615    [Documentation]  Verify the given attribute.
616    [Arguments]  ${uri}  ${attribute_name}  ${attribute_value}
617
618    # Description of argument(s):
619    # uri              URI path
620    #                  (e.g. "/xyz/openbmc_project/control/host0/TPMEnable").
621    # attribute_name   Name of attribute to be verified (e.g. "TPMEnable").
622    # attribute_value  The expected value of attribute (e.g. "1", "0", etc.)
623
624    ${output}=  Read Attribute  ${uri}  ${attribute_name}
625    Should Be Equal  ${attribute_value}  ${output}
626    ...  msg=Attribute "${attribute_name} does not have the expected value.
627
628
629New Set Power Policy
630    [Documentation]   Set the given BMC power policy (new method).
631    [Arguments]   ${policy}
632
633    # Description of argument(s):
634    # policy    Power restore policy (e.g. ${ALWAYS_POWER_OFF}).
635
636    ${valueDict}=  Create Dictionary  data=${policy}
637    Write Attribute
638    ...  ${POWER_RESTORE_URI}  PowerRestorePolicy  data=${valueDict}
639
640
641Old Set Power Policy
642    [Documentation]   Set the given BMC power policy (old method).
643    [Arguments]   ${policy}
644
645    # Description of argument(s):
646    # policy    Power restore policy (e.g. "ALWAYS_POWER_OFF").
647
648    ${valueDict}=     create dictionary  data=${policy}
649    Write Attribute    ${HOST_SETTING}    power_policy   data=${valueDict}
650
651
652Set Auto Reboot
653    [Documentation]  Set the given auto reboot setting.
654    [Arguments]  ${setting}
655
656    # Description of argument(s):
657    # setting    The reboot setting, 1 for enabling and 0 for disabling.
658
659    ${valueDict}=  Convert To Integer  ${setting}
660    ${data}=  Create Dictionary  data=${valueDict}
661    Write Attribute  ${CONTROL_HOST_URI}/auto_reboot  AutoReboot   data=${data}
662    ${current_setting}=  Get Auto Reboot
663    Should Be Equal As Integers  ${current_setting}  ${setting}
664
665
666Set Control Boot Mode
667    [Documentation]  Set given boot mode on the boot object path attribute.
668    [Arguments]  ${boot_path}  ${boot_mode}
669
670    # Description of argument(s):
671    # boot_path  Boot object path.
672    #            Example:
673    #            /xyz/openbmc_project/control/host0/boot
674    #            /xyz/openbmc_project/control/host0/boot/one_time
675    # boot_mode  Boot mode which need to be set.
676    #            Example:
677    #            "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"
678
679    ${valueDict}=  Create Dictionary  data=${boot_mode}
680    Write Attribute  ${boot_path}  BootMode  data=${valueDict}
681
682
683Is Power On
684    [Documentation]  Verify that the BMC chassis state is on.
685    ${state}=  Get Power State
686    Should be equal  ${state}  ${1}
687
688
689Is Power Off
690    [Documentation]  Verify that the BMC chassis state is off.
691    ${state}=  Get Power State
692    Should be equal  ${state}  ${0}
693
694
695CLI Get BMC DateTime
696    [Documentation]  Returns BMC date time from date command.
697
698    ${bmc_time_via_date}  ${stderr}  ${rc}=  BMC Execute Command  date +"%Y-%m-%d %H:%M:%S"  print_err=1
699    [Return]  ${bmc_time_via_date}
700
701
702Update Root Password
703    [Documentation]  Update system "root" user password.
704    [Arguments]  ${openbmc_password}=${OPENBMC_PASSWORD}
705
706    # Description of argument(s):
707    # openbmc_password   The root password for the open BMC system.
708
709    @{password}=  Create List  ${openbmc_password}
710    ${data}=  Create Dictionary  data=@{password}
711
712    ${headers}=  Create Dictionary  Content-Type=application/json  X-Auth-Token=${XAUTH_TOKEN}
713    ${resp}=  Post Request  openbmc  ${BMC_USER_URI}root/action/SetPassword
714    ...  data=${data}  headers=${headers}
715    Valid Value  resp.status_code  [${HTTP_OK}]
716
717
718Get Post Boot Action
719    [Documentation]  Get post boot action.
720
721    # Post code update action dictionary.
722    #
723    # {
724    #    BMC image: {
725    #        OnReset: Redfish OBMC Reboot (off),
726    #        Immediate: Wait For Reboot  start_boot_seconds=${state['epoch_seconds']}
727    #    },
728    #    Host image: {
729    #        OnReset: RF SYS GracefulRestart,
730    #        Immediate: Wait State  os_running_match_state  10 mins
731    #    }
732    # }
733
734    ${code_base_dir_path}=  Get Code Base Dir Path
735    ${post_code_update_actions}=  Evaluate
736    ...  json.load(open('${code_base_dir_path}data/applytime_table.json'))  modules=json
737    Rprint Vars  post_code_update_actions
738
739    [Return]  ${post_code_update_actions}
740
741