xref: /openbmc/openbmc-test-automation/lib/utils.robot (revision 1e3245765dfe2000bc099467d7bd56f14fe68fb5)
1*** Settings ***
2Resource                ../lib/resource.txt
3Resource                ../lib/rest_client.robot
4Resource                ../lib/connection_client.robot
5Library                 String
6Library                 DateTime
7Library                 Process
8Library                 OperatingSystem
9Library                 gen_print.py
10Library                 gen_robot_print.py
11Library                 gen_cmd.py
12Library                 gen_robot_keyword.py
13Library                 bmc_ssh_utils.py
14Library                 utils.py
15Library                 var_funcs.py
16Library                 SCPLibrary  WITH NAME  scp
17
18*** Variables ***
19${pflash_cmd}           /usr/sbin/pflash -r /dev/stdout -P VERSION
20${SYSTEM_SHUTDOWN_TIME}       ${5}
21${dbuscmdBase}
22...  dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host
23${dbuscmdGet}
24...  ${SETTINGS_URI}host0  org.freedesktop.DBus.Properties.Get
25# Enable when ready with openbmc/openbmc-test-automation#203
26#${dbuscmdString}=  string:"xyz.openbmc_project.settings.Host" string:
27${dbuscmdString}=   string:"org.openbmc.settings.Host" string:
28
29# Assign default value to QUIET for programs which may not define it.
30${QUIET}  ${0}
31${bmc_mem_free_cmd}=   free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4
32${bmc_mem_total_cmd}=   free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2
33${bmc_cpu_usage_cmd}=   top -n 1  | grep CPU: | cut -c 7-9
34${HOST_SETTING}    ${SETTINGS_URI}host0
35# /run/initramfs/ro associate filesystem  should be 100% full always
36${bmc_file_system_usage_cmd}=  df -h | cut -c 52-54 | grep 100 | wc -l
37${total_pnor_ro_file_system_cmd}=  df -h | grep /media/pnor-ro | wc -l
38${total_bmc_ro_file_system_cmd}=  df -h | grep /media/rofs | wc -l
39
40${BOOT_TIME}     ${0}
41${BOOT_COUNT}    ${0}
42${count}  ${0}
43${devicetree_base}  /sys/firmware/devicetree/base/model
44
45# Initialize default debug value to 0.
46${DEBUG}         ${0}
47
48# These variables are used to straddle between new and old methods of setting
49# values.
50${boot_prog_method}     ${EMPTY}
51
52${power_policy_setup}             ${0}
53${bmc_power_policy_method}        ${EMPTY}
54@{valid_power_policy_vars}        RESTORE_LAST_STATE  ALWAYS_POWER_ON
55...                               ALWAYS_POWER_OFF
56
57${probe_cpu_tool_path}     ${EXECDIR}/tools/ras/probe_cpus.sh
58${scom_addrs_tool_path}    ${EXECDIR}/tools/ras/scom_addr_p9.sh
59${target_file_path}        /root/
60
61*** Keywords ***
62
63Check BMC Performance
64    [Documentation]  Check BMC basic CPU Mem File system performance.
65
66    Check BMC CPU Performance
67    Check BMC Mem Performance
68    Check BMC File System Performance
69
70Verify PNOR Update
71    [Documentation]  Verify that the PNOR is not corrupted.
72    # Example:
73    # FFS: Flash header not found. Code: 100
74    # Error 100 opening ffs !
75
76    Open Connection And Log In
77    ${pnor_info}=  Execute Command On BMC  ${pflash_cmd}
78    Should Not Contain Any  ${pnor_info}  Flash header not found  Error
79
80Get BMC System Model
81    [Documentation]  Get the BMC model from the device tree.
82
83    ${bmc_model}  ${stderr}  ${rc}=  BMC Execute Command
84    ...  cat ${devicetree_base} | cut -d " " -f 1  return_stderr=True
85    ...  test_mode=0
86    Should Be Empty  ${stderr}
87    Should Not Be Empty  ${bmc_model}
88    [Return]  ${bmc_model}
89
90Verify BMC System Model
91    [Documentation]  Verify the BMC model with ${OPENBMC_MODEL}.
92    [Arguments]  ${bmc_model}
93
94    ${tmp_bmc_model}=  Fetch From Right  ${OPENBMC_MODEL}  /
95    ${tmp_bmc_model}=  Fetch From Left  ${tmp_bmc_model}  .
96    ${ret}=  Run Keyword And Return Status  Should Contain  ${bmc_model}
97    ...  ${tmp_bmc_model}  ignore_case=True
98    [Return]  ${ret}
99
100Wait For Host To Ping
101    [Arguments]  ${host}  ${timeout}=${OPENBMC_REBOOT_TIMEOUT}min
102    ...          ${interval}=5 sec
103
104    # host      The DNS name or IP of the host to ping.
105    # timeout   The amount of time after which attempts to ping cease.
106    # interval  The amount of time in between attempts to ping.
107
108    Wait Until Keyword Succeeds  ${timeout}  ${interval}  Ping Host  ${host}
109
110Ping Host
111    [Arguments]     ${host}
112    Should Not Be Empty    ${host}   msg=No host provided
113    ${RC}   ${output}=     Run and return RC and Output    ping -c 4 ${host}
114    Log     RC: ${RC}\nOutput:\n${output}
115    Should be equal     ${RC}   ${0}
116
117Get Boot Progress
118    [Documentation]  Get the boot progress and return it.
119    [Arguments]  ${quiet}=${QUIET}
120
121    # Description of argument(s):
122    # quiet   Indicates whether this keyword should run without any output to
123    #         the console.
124
125    Set Boot Progress Method
126    ${state}=  Run Keyword If  '${boot_prog_method}' == 'New'
127    ...      New Get Boot Progress  quiet=${quiet}
128    ...  ELSE
129    ...      Old Get Boot Progress  quiet=${quiet}
130
131    [Return]  ${state}
132
133Set Boot Progress Method
134    [Documentation]  Set the boot_prog_method to either 'Old' or 'New'.
135
136    # The boot progress data has moved from an 'org' location to an 'xyz'
137    # location.  This keyword will determine whether the new method of getting
138    # the boot progress is valid and will set the global boot_prog_method
139    # variable accordingly.  If boot_prog_method is already set (either by a
140    # prior call to this function or via a -v parm), this keyword will simply
141    # return.
142
143    # Note:  There are interim builds that contain boot_progress in both the
144    # old and the new location values.  It is nearly impossible for this
145    # keyword to determine whether the old boot_progress or the new one is
146    # active.  When using such builds where the old boot_progress is active,
147    # the only recourse users will have is that they may specify
148    # -v boot_prog_method:Old to force old behavior on such builds.
149
150    Run Keyword If  '${boot_prog_method}' != '${EMPTY}'  Return From Keyword
151
152    ${new_status}  ${new_value}=  Run Keyword And Ignore Error
153    ...  New Get Boot Progress
154    # If the new style read fails, the method must necessarily be "Old".
155    Run Keyword If  '${new_status}' == 'PASS'
156    ...  Run Keywords
157    ...  Set Global Variable  ${boot_prog_method}  New  AND
158    ...  Rqpvars  boot_prog_method  AND
159    ...  Return From Keyword
160
161    # Default method is "Old".
162    Set Global Variable  ${boot_prog_method}  Old
163    Rqpvars  boot_prog_method
164
165Old Get Boot Progress
166    [Documentation]  Get the boot progress the old way (via org location).
167    [Arguments]  ${quiet}=${QUIET}
168
169    # Description of argument(s):
170    # quiet   Indicates whether this keyword should run without any output to
171    #         the console.
172
173    ${state}=  Read Attribute  ${OPENBMC_BASE_URI}sensors/host/BootProgress
174    ...  value  quiet=${quiet}
175
176    [Return]  ${state}
177
178New Get Boot Progress
179    [Documentation]  Get the boot progress the new way (via xyz location).
180    [Arguments]  ${quiet}=${QUIET}
181
182    # Description of argument(s):
183    # quiet   Indicates whether this keyword should run without any output to
184    #         the console.
185
186    ${state}=  Read Attribute  ${HOST_STATE_URI}  BootProgress  quiet=${quiet}
187
188    [Return]  ${state.rsplit('.', 1)[1]}
189
190Is Power On
191    ${state}=  Get Power State
192    Should be equal  ${state}  ${1}
193
194Is Power Off
195    ${state}=  Get Power State
196    Should be equal  ${state}  ${0}
197
198Initiate Power On
199    [Documentation]  Initiates the power on and waits until the Is Power On
200    ...  keyword returns that the power state has switched to on.
201    [Arguments]  ${wait}=${1}
202
203    @{arglist}=   Create List
204    ${args}=     Create Dictionary    data=@{arglist}
205    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  powerOn
206    ...  data=${args}
207    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
208
209    # Does caller want to wait for power on status?
210    Run Keyword If  '${wait}' == '${0}'  Return From Keyword
211    Wait Until Keyword Succeeds  3 min  10 sec  Is Power On
212
213Initiate Power Off
214    [Documentation]  Initiates the power off and waits until the Is Power Off
215    ...  keyword returns that the power state has switched to off.
216    @{arglist}=   Create List
217    ${args}=     Create Dictionary    data=@{arglist}
218    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  powerOff
219    ...  data=${args}
220    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
221    Wait Until Keyword Succeeds  1 min  10 sec  Is Power Off
222
223Initiate OS Host Power Off
224    [Documentation]  Initiate an OS reboot.
225    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
226    ...          ${os_password}=${OS_PASSWORD}
227
228    # Description of arguments:
229    # os_host      The DNS name or IP of the OS.
230    # os_username  The username to be used to sign in to the OS.
231    # os_password  The password to be used to sign in to the OS.
232
233    ${cmd_buf}=  Run Keyword If  '${os_username}' == 'root'
234    ...      Set Variable  shutdown
235    ...  ELSE
236    ...      Set Variable  echo ${os_password} | sudo -S shutdown
237
238    ${output}  ${stderr}  ${rc}=  OS Execute Command
239    ...  ${cmd_buf}  fork=${1}
240
241Initiate OS Host Reboot
242    [Documentation]  Initiate an OS reboot.
243    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
244    ...          ${os_password}=${OS_PASSWORD}
245
246    # Description of argument(s):
247    # os_host      The host name or IP address of the OS.
248    # os_username  The username to be used to sign in to the OS.
249    # os_password  The password to be used to sign in to the OS.
250
251    ${cmd_buf}=  Run Keyword If  '${os_username}' == 'root'
252    ...      Set Variable  reboot
253    ...  ELSE
254    ...      Set Variable  echo ${os_password} | sudo -S reboot
255
256    ${output}  ${stderr}  ${rc}=  OS Execute Command
257    ...  ${cmd_buf}  fork=${1}
258
259Initiate Auto Reboot
260    [Documentation]  Initiate an auto reboot.
261
262    # Set the auto reboot policy.
263    Set Auto Reboot  ${1}
264    # Set the watchdog timer.  Note: 5000 = milliseconds which is 5 seconds.
265    Trigger Host Watchdog Error  5000
266
267Trigger Warm Reset
268    log to console    "Triggering warm reset"
269    ${data}=   create dictionary   data=@{EMPTY}
270    ${resp}=  openbmc post request
271    ...  ${OPENBMC_BASE_URI}control/bmc0/action/warmReset  data=${data}
272    Should Be Equal As Strings      ${resp.status_code}     ${HTTP_OK}
273    ${session_active}=   Check If warmReset is Initiated
274    Run Keyword If   '${session_active}' == '${True}'
275    ...    Fail   msg=warm reset didn't occur
276
277    Sleep   ${SYSTEM_SHUTDOWN_TIME}min
278    Check If BMC Is Up
279
280Check OS
281    [Documentation]  Attempts to ping the host OS and then checks that the host
282    ...              OS is up by running an SSH command.
283
284    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
285    ...          ${os_password}=${OS_PASSWORD}  ${quiet}=${QUIET}
286    ...          ${print_string}=${EMPTY}
287    [Teardown]  SSHLibrary.Close Connection
288
289    # os_host           The DNS name/IP of the OS host associated with our BMC.
290    # os_username       The username to be used to sign on to the OS host.
291    # os_password       The password to be used to sign on to the OS host.
292    # quiet             Indicates whether this keyword should write to console.
293    # print_string      A string to be printed before checking the OS.
294
295    rprint  ${print_string}
296
297    # Attempt to ping the OS. Store the return code to check later.
298    ${ping_rc}=  Run Keyword and Return Status  Ping Host  ${os_host}
299
300    SSHLibrary.Open connection  ${os_host}
301
302    ${status}  ${msg}=  Run Keyword And Ignore Error  Login  ${os_username}
303    ...  ${os_password}
304    ${err_msg1}=  Sprint Error  ${msg}
305    ${err_msg}=  Catenate  SEPARATOR=  \n  ${err_msg1}
306    Run Keyword If  '${status}' == 'FAIL'  Fail  msg=${err_msg}
307    ${output}  ${stderr}  ${rc}=  Execute Command  uptime  return_stderr=True
308    ...        return_rc=True
309
310    ${temp_msg}=  Catenate  Could not execute a command on the operating
311    ...  system.\n
312    ${err_msg1}=  Sprint Error  ${temp_msg}
313    ${err_msg}=  Catenate  SEPARATOR=  \n  ${err_msg1}
314
315    # If the return code returned by "Execute Command" is non-zero, this
316    # keyword will fail.
317    Should Be Equal  ${rc}  ${0}  msg=${err_msg}
318    # We will likewise fail if there is any stderr data.
319    Should Be Empty  ${stderr}
320
321    ${temp_msg}=  Set Variable  Could not ping the operating system.\n
322    ${err_msg1}=  Sprint Error  ${temp_msg}
323    ${err_msg}=  Catenate  SEPARATOR=  \n  ${err_msg1}
324    # We will likewise fail if the OS did not ping, as we could SSH but not
325    # ping
326    Should Be Equal As Strings  ${ping_rc}  ${TRUE}  msg=${err_msg}
327
328Wait for OS
329    [Documentation]  Waits for the host OS to come up via calls to "Check OS".
330    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
331    ...          ${os_password}=${OS_PASSWORD}  ${timeout}=${OS_WAIT_TIMEOUT}
332    ...          ${quiet}=${0}
333    [Teardown]  rprintn
334
335    # os_host           The DNS name or IP of the OS host associated with our
336    #                   BMC.
337    # os_username       The username to be used to sign on to the OS host.
338    # os_password       The password to be used to sign on to the OS host.
339    # timeout           The timeout in seconds indicating how long you're
340    #                   willing to wait for the OS to respond.
341    # quiet             Indicates whether this keyword should write to console.
342
343    # The interval to be used between calls to "Check OS".
344    ${interval}=  Set Variable  5
345
346    ${message}=  Catenate  Checking every ${interval} seconds for up to
347    ...  ${timeout} seconds for the operating system to communicate.
348    rqprint_timen  ${message}
349
350    Wait Until Keyword Succeeds  ${timeout} sec  ${interval}  Check OS
351    ...                          ${os_host}  ${os_username}  ${os_password}
352    ...                          print_string=\#
353
354    rqprintn
355
356    rqprint_timen  The operating system is now communicating.
357
358
359Get Power State
360    [Documentation]  Returns the power state as an integer. Either 0 or 1.
361    [Arguments]  ${quiet}=${QUIET}
362
363    @{arglist}=  Create List
364    ${args}=  Create Dictionary  data=@{arglist}
365
366    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  getPowerState
367    ...        data=${args}  quiet=${quiet}
368    Should be equal as strings  ${resp.status_code}  ${HTTP_OK}
369    ${content}=  to json  ${resp.content}
370    [Return]  ${content["data"]}
371
372Clear BMC Record Log
373    [Documentation]  Clears all the event logs on the BMC. This would be
374    ...              equivalent to ipmitool sel clear.
375    @{arglist}=   Create List
376    ${args}=     Create Dictionary    data=@{arglist}
377    ${resp}=  Call Method
378    ...  ${OPENBMC_BASE_URI}records/events/  clear  data=${args}
379    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
380
381Copy PNOR to BMC
382    Import Library      SCPLibrary      WITH NAME       scp
383    Open Connection for SCP
384    Log    Copying ${PNOR_IMAGE_PATH} to /tmp
385    scp.Put File    ${PNOR_IMAGE_PATH}   /tmp
386
387Flash PNOR
388    [Documentation]    Calls flash bios update method to flash PNOR image
389    [Arguments]    ${pnor_image}
390    @{arglist}=   Create List    ${pnor_image}
391    ${args}=     Create Dictionary    data=@{arglist}
392    ${resp}=  Call Method  /org/openbmc/control/flash/bios/  update
393    ...  data=${args}
394    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
395    Wait Until Keyword Succeeds    2 min   10 sec    Is PNOR Flashing
396
397Get Flash BIOS Status
398    [Documentation]  Returns the status of the flash BIOS API as a string. For
399    ...              example 'Flashing', 'Flash Done', etc
400    ${data}=  Read Properties  /org/openbmc/control/flash/bios
401    [Return]    ${data['status']}
402
403Is PNOR Flashing
404    [Documentation]  Get BIOS 'Flashing' status. This indicates that PNOR
405    ...              flashing has started.
406    ${status}=    Get Flash BIOS Status
407    Should Contain  ${status}  Flashing
408
409Is PNOR Flash Done
410    [Documentation]  Get BIOS 'Flash Done' status.  This indicates that the
411    ...              PNOR flashing has completed.
412    ${status}=    Get Flash BIOS Status
413    should be equal as strings     ${status}     Flash Done
414
415
416Is OS Starting
417    [Documentation]  Check if boot progress is OS starting.
418    ${boot_progress}=  Get Boot Progress
419    Should Be Equal  ${boot_progress}  OSStart
420
421Is OS Off
422    [Documentation]  Check if boot progress is "Off".
423    ${boot_progress}=  Get Boot Progress
424    Should Be Equal  ${boot_progress}  Off
425
426Get Boot Progress To OS Starting State
427    [Documentation]  Get the system to a boot progress state of 'FW Progress,
428    ...  Starting OS'.
429
430    ${boot_progress}=  Get Boot Progress
431    Run Keyword If  '${boot_progress}' == 'OSStart'
432    ...  Log  Host is already in OS starting state
433    ...  ELSE
434    ...  Run Keywords  Initiate Host PowerOff  AND  Initiate Host Boot
435    ...  AND  Wait Until Keyword Succeeds  10 min  10 sec  Is OS Starting
436
437Verify Ping and REST Authentication
438    ${l_ping}=   Run Keyword And Return Status
439    ...    Ping Host  ${OPENBMC_HOST}
440    Run Keyword If  '${l_ping}' == '${False}'
441    ...    Fail   msg=Ping Failed
442
443    ${l_rest}=   Run Keyword And Return Status
444    ...    Initialize OpenBMC
445    Run Keyword If  '${l_rest}' == '${False}'
446    ...    Fail   msg=REST Authentication Failed
447
448    # Just to make sure the SSH is working for SCP
449    Open Connection And Log In
450    ${system}   ${stderr}=    Execute Command   hostname   return_stderr=True
451    Should Be Empty     ${stderr}
452
453Check If BMC is Up
454    [Documentation]  Wait for Host to be online. Checks every X seconds
455    ...              interval for Y minutes and fails if timed out.
456    ...              Default MAX timedout is 10 min, interval 10 seconds.
457    [Arguments]      ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
458    ...              ${interval}=10 sec
459
460    Wait Until Keyword Succeeds
461    ...   ${max_timeout}  ${interval}   Verify Ping and REST Authentication
462
463
464Check If warmReset is Initiated
465    [Documentation]  Ping would be still alive, so try SSH to connect
466    ...              if fails the ports are down indicating reboot
467    ...              is in progress
468
469    # Warm reset adds 3 seconds delay before forcing reboot
470    # To minimize race conditions, we wait for 7 seconds
471    Sleep  7s
472    ${alive}=   Run Keyword and Return Status
473    ...    Open Connection And Log In
474    Return From Keyword If   '${alive}' == '${False}'    ${False}
475    [Return]    ${True}
476
477Flush REST Sessions
478    [Documentation]   Removes all the active session objects
479    Delete All Sessions
480
481Initialize DBUS cmd
482    [Documentation]  Initialize dbus string with property string to extract
483    [Arguments]   ${boot_property}
484    ${cmd}=     Catenate  ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
485    ${cmd}=     Catenate  ${cmd}${boot_property}
486    Set Global Variable   ${dbuscmd}     ${cmd}
487
488Create OS Console File Path
489    [Documentation]  Create OS console file path name and return it.
490    [Arguments]  ${log_file_path}=${EMPTY}
491
492    # Description of arguments:
493    # file_path  The caller's candidate value.  If this value is ${EMPTY}, this
494    #            keyword will compose a file path name.  Otherwise, this
495    #            keyword will use the caller's file_path value.  In either
496    #            case, the value will be returned.
497
498    ${default_file_path}=  Catenate  /tmp/${OPENBMC_HOST}_os_console.txt
499    ${log_file_path}=  Set Variable If  '${log_file_path}' == '${EMPTY}'
500    ...  ${default_file_path}  ${log_file_path}
501
502    [Return]  ${log_file_path}
503
504Create OS Console Command String
505    [Documentation]  Return a command string to start OS console logging.
506
507    # First make sure that the ssh_pw program is available.
508    ${cmd_buf}=  Catenate  which ssh_pw 2>/dev/null || find ${EXECDIR} -name 'ssh_pw'
509    Rdpissuing  ${cmd_buf}
510    ${rc}  ${output}=  Run And Return Rc And Output  ${cmd_buf}
511    Rdpvars  rc  output
512
513    Should Be Equal As Integers  0  ${rc}  msg=Could not find ssh_pw.
514
515    ${ssh_pw_file_path}=  Set Variable  ${output}
516
517    ${cmd_buf}=  Catenate  ${ssh_pw_file_path} ${OPENBMC_PASSWORD} -p 2200
518    ...  -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST}
519
520    [Return]  ${cmd_buf}
521
522Get SOL Console Pid
523    [Documentation]  Get the pid of the active sol conole job.
524
525    # Find the pid of the active system console logging session (if any).
526    ${search_string}=  Create OS Console Command String
527    # At least in some cases, ps output does not show double quotes so we must
528    # replace them in our search string with the regexes to indicate that they
529    # are optional.
530    ${search_string}=  Replace String  ${search_string}  "  ["]?
531    ${cmd_buf}=  Catenate  echo $(ps awwo user,pid,cmd | egrep
532    ...  '${search_string}' | egrep -v grep | cut -c10-14)
533    Rdpissuing  ${cmd_buf}
534    ${rc}  ${os_con_pid}=  Run And Return Rc And Output  ${cmd_buf}
535    Rdpvars  os_con_pid
536    # If rc is not zero it just means that there is no OS Console process
537    # running.
538
539    [Return]  ${os_con_pid}
540
541
542Stop SOL Console Logging
543    [Documentation]  Stop system console logging and return log output.
544    [Arguments]  ${log_file_path}=${EMPTY}
545    ...          ${targ_file_path}=${EXECDIR}${/}logs${/}
546    ...          ${return_data}=${1}
547
548    # If there are muliple system console processes, they will all be stopped.
549    # If there is no existing log file this keyword will return an error
550    # message to that effect (and write that message to targ_file_path, if
551    # specified).
552    # NOTE: This keyword will not fail if there is no running system console
553    # process.
554
555    # Description of arguments:
556    # log_file_path   The file path that was used to call "Start SOL
557    #                 Console Logging".  See that keyword (above) for details.
558    # targ_file_path  If specified, the file path to which the source
559    #                 file path (i.e. "log_file_path") should be copied.
560    # return_data     If this is set to ${1}, this keyword will return the SOL
561    #                 data to the caller as a unicode string.
562
563    ${log_file_path}=  Create OS Console File Path  ${log_file_path}
564
565    ${os_con_pid}=  Get SOL Console Pid
566
567    ${cmd_buf}=  Catenate  kill -9 ${os_con_pid}
568    Run Keyword If  '${os_con_pid}' != '${EMPTY}'  Rdpissuing  ${cmd_buf}
569    ${rc}  ${output}=  Run Keyword If  '${os_con_pid}' != '${EMPTY}'
570    ...  Run And Return Rc And Output  ${cmd_buf}
571    Run Keyword If  '${os_con_pid}' != '${EMPTY}'  Rdpvars  rc  output
572
573    Run Keyword If  '${targ_file_path}' != '${EMPTY}'
574    ...  Run Keyword And Ignore Error
575    ...  Copy File  ${log_file_path}  ${targ_file_path}
576
577    ${output}=  Set Variable  ${EMPTY}
578    ${loc_quiet}=  Evaluate  ${debug}^1
579    ${rc}  ${output}=  Run Keyword If  '${return_data}' == '${1}'
580    ...  Cmd Fnc  cat ${log_file_path} 2>/dev/null  quiet=${loc_quiet}
581    ...  print_output=${0}  show_err=${0}
582
583    [Return]  ${output}
584
585Start SOL Console Logging
586    [Documentation]  Start system console log to file.
587    [Arguments]  ${log_file_path}=${EMPTY}  ${return_data}=${1}
588
589    # This keyword will first call "Stop SOL Console Logging".  Only then will
590    # it start SOL console logging.  The data returned by "Stop SOL Console
591    # Logging" will in turn be returned by this keyword.
592
593    # Description of arguments:
594    # log_file_path   The file path to which system console log data should be
595    #                 written.  Note that this path is taken to be a location
596    #                 on the machine where this program is running rather than
597    #                 on the Open BMC system.
598    # return_data     If this is set to ${1}, this keyword will return any SOL
599    #                 data to the caller as a unicode string.
600
601    ${log_file_path}=  Create OS Console File Path  ${log_file_path}
602
603    ${log_output}=  Stop SOL Console Logging  ${log_file_path}
604    ...  return_data=${return_data}
605
606    # Validate by making sure we can create the file.  Problems creating the
607    # file would not be noticed by the subsequent ssh command because we fork
608    # the command.
609    Create File  ${log_file_path}
610    ${sub_cmd_buf}=  Create OS Console Command String
611    # Routing stderr to stdout so that any startup error text will go to the
612    # output file.
613    # TODO: Doesn't work with tox so reverting temporarily.
614    # nohup detaches the process completely from our pty.
615    #${cmd_buf}=  Catenate  nohup ${sub_cmd_buf} &> ${log_file_path} &
616    ${cmd_buf}=  Catenate  ${sub_cmd_buf} > ${log_file_path} 2>&1 &
617    Rdpissuing  ${cmd_buf}
618    ${rc}  ${output}=  Run And Return Rc And Output  ${cmd_buf}
619    # Because we are forking this command, we essentially will never get a
620    # non-zero return code or any output.
621    Should Be Equal  ${rc}  ${0}
622
623    Sleep  1
624    ${os_con_pid}=  Get SOL Console Pid
625
626    Should Not Be Empty  ${os_con_pid}
627
628    [Return]  ${log_output}
629
630Get Time Stamp
631    [Documentation]     Get the current time stamp data
632    ${cur_time}=    Get Current Date   result_format=%Y%m%d%H%M%S%f
633    [Return]   ${cur_time}
634
635
636Start Journal Log
637    [Documentation]   Start capturing journal log to a file in /tmp using
638    ...               journalctl command. By default journal log is collected
639    ...               at /tmp/journal_log else user input location.
640    ...               The File is appended with datetime.
641    [Arguments]       ${file_path}=/tmp/journal_log
642
643    Open Connection And Log In
644
645    ${cur_time}=    Get Time Stamp
646    Set Global Variable   ${LOG_TIME}   ${cur_time}
647    Start Command
648    ...  journalctl -f > ${file_path}-${LOG_TIME}
649    Log    Journal Log Started: ${file_path}-${LOG_TIME}
650
651
652Stop Journal Log
653    [Documentation]   Stop journalctl process if its running.
654    ...               By default return log from /tmp/journal_log else
655    ...               user input location.
656    [Arguments]       ${file_path}=/tmp/journal_log
657
658    Open Connection And Log In
659
660    ${rc}=
661    ...  Execute Command
662    ...  ps ax | grep journalctl | grep -v grep
663    ...  return_stdout=False  return_rc=True
664
665    Return From Keyword If   '${rc}' == '${1}'
666    ...   No journal log process running
667
668    ${output}  ${stderr}=
669    ...  Execute Command   killall journalctl
670    ...  return_stderr=True
671    Should Be Empty     ${stderr}
672
673    ${journal_log}  ${stderr}=
674    ...  Execute Command
675    ...  cat ${file_path}-${LOG_TIME}
676    ...  return_stderr=True
677    Should Be Empty     ${stderr}
678
679    Log    ${journal_log}
680
681    Execute Command    rm ${file_path}-${LOG_TIME}
682
683    [Return]    ${journal_log}
684
685Mac Address To Hex String
686    [Documentation]   Converts MAC address into hex format.
687    ...               Example
688    ...               Given the following MAC: 00:01:6C:80:02:78
689    ...               This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
690    ...               Description of arguments:
691    ...               i_macaddress  MAC address in the following format
692    ...               00:01:6C:80:02:78
693    [Arguments]    ${i_macaddress}
694
695    ${mac_hex}=  Catenate  0x${i_macaddress.replace(':', ' 0x')}
696    [Return]    ${mac_hex}
697
698IP Address To Hex String
699    [Documentation]   Converts IP address into hex format.
700    ...               Example:
701    ...               Given the following IP: 10.3.164.100
702    ...               This keyword will return: 0xa 0x3 0xa4 0xa0
703    ...               Description of arguments:
704    ...               i_ipaddress  IP address in the following format
705    ...               10.10.10.10
706    [Arguments]    ${i_ipaddress}
707
708    @{ip}=  Split String  ${i_ipaddress}    .
709    ${index}=  Set Variable  ${0}
710
711    :FOR    ${item}     IN      @{ip}
712    \   ${hex}=  Convert To Hex    ${item}    prefix=0x    lowercase=yes
713    \   Set List Value    ${ip}    ${index}    ${hex}
714    \   ${index}=  Set Variable    ${index + 1}
715    ${ip_hex}=  Catenate    @{ip}
716    [Return]    ${ip_hex}
717
718BMC CPU Performance Check
719   [Documentation]   Minimal 10% of proc should be free in this instance
720
721    ${bmc_cpu_usage_output}  ${stderr}  ${rc}=  BMC Execute Command
722    ...  ${bmc_cpu_usage_cmd}
723    ${bmc_cpu_usage_output}  ${stderr}  ${rc}=  BMC Execute Command
724    ...  ${bmc_cpu_usage_cmd}
725    ${bmc_cpu_percentage}=  Fetch From Left  ${bmc_cpu_usage_output}  %
726    Should be true  ${bmc_cpu_percentage} < 90
727
728BMC Mem Performance Check
729    [Documentation]   Minimal 10% of memory should be free in this instance
730
731    ${bmc_mem_free_output}  ${stderr}  ${rc}=   BMC Execute Command
732    ...  ${bmc_mem_free_cmd}
733
734    ${bmc_mem_total_output}  ${stderr}  ${rc}=  BMC Execute Command
735    ...  ${bmc_mem_total_cmd}
736    ${bmc_mem_free_output}  ${stderr}  ${rc}=   BMC Execute Command
737    ...  ${bmc_mem_free_cmd}
738
739    ${bmc_mem_total_output}  ${stderr}  ${rc}=  BMC Execute Command
740    ...  ${bmc_mem_total_cmd}
741
742    ${bmc_mem_percentage}=  Evaluate  ${bmc_mem_free_output}*100
743    ${bmc_mem_percentage}=  Evaluate
744    ...   ${bmc_mem_percentage}/${bmc_mem_total_output}
745    Should be true  ${bmc_mem_percentage} > 10
746
747BMC File System Usage Check
748    [Documentation]   Check the file system space. 4 file system should be
749    ...  100% full which is expected
750    # Filesystem                Size      Used Available Use% Mounted on
751    # /dev/root                14.4M     14.4M         0 100% /
752    # /dev/ubiblock0_0         14.4M     14.4M         0 100% /media/rofs-c9249b0e
753    # /dev/ubiblock8_0         19.6M     19.6M         0 100% /media/pnor-ro-8764baa3
754    # /dev/ubiblock4_0         14.4M     14.4M         0 100% /media/rofs-407816c
755    ${bmc_fs_usage_output}  ${stderr}  ${rc}=  BMC Execute Command
756    ...   ${bmc_file_system_usage_cmd}
757    Should Be True  ${bmc_fs_usage_output}==4
758    # /dev/ubiblock8_4         21.1M     21.1M         0 100% /media/pnor-ro-cecc64c4
759    ${bmc_fs_usage_output}  ${stderr}  ${rc}=  BMC Execute Command
760    ...  ${bmc_file_system_usage_cmd}
761    ${bmc_pnor_fs_usage_output}  ${stderr}  ${rc}=  BMC Execute Command
762    ...  ${total_pnor_ro_file_system_cmd}
763    ${bmc_bmc_fs_usage_output}  ${stderr}  ${rc}=  BMC Execute Command
764    ...  ${total_bmc_ro_file_system_cmd}
765    ${total_bmc_pnor_image}=  Evaluate
766    ...  ${bmc_pnor_fs_usage_output}+${bmc_bmc_fs_usage_output}
767    # Considering /dev/root also in total 100% used file system
768    ${total_full_fs}=  Evaluate  ${total_bmc_pnor_image}+1
769    Should Be True  ${bmc_fs_usage_output}==${total_full_fs}
770
771Check BMC CPU Performance
772    [Documentation]   Minimal 10% of proc should be free in 3 sample
773    :FOR  ${var}  IN Range  1  4
774    \     BMC CPU Performance check
775
776Check BMC Mem Performance
777    [Documentation]   Minimal 10% of memory should be free
778
779    :FOR  ${var}  IN Range  1  4
780    \     BMC Mem Performance check
781
782Check BMC File System Performance
783    [Documentation]  Check for file system usage for 4 times
784
785    :FOR  ${var}  IN Range  1  4
786    \     BMC File System Usage check
787
788Get URL List
789    [Documentation]  Return list of URLs under given URL.
790    [Arguments]  ${openbmc_url}
791    # Description of argument(s):
792    # openbmc_url  URL for list operation (e.g.
793    #              /xyz/openbmc_project/inventory).
794
795    ${url_list}=  Read Properties  ${openbmc_url}/list  quiet=${1}
796    Sort List  ${url_list}
797    [Return]  ${url_list}
798
799Get Endpoint Paths
800    [Documentation]   Returns all url paths ending with given endpoint
801    ...               Example:
802    ...               Given the following endpoint: cpu
803    ...               This keyword will return: list of all urls ending with
804    ...               cpu -
805    ...               /org/openbmc/inventory/system/chassis/motherboard/cpu0,
806    ...               /org/openbmc/inventory/system/chassis/motherboard/cpu1
807    ...               Description of arguments:
808    ...               path       URL path for enumeration
809    ...               endpoint   string for which url path ending
810    [Arguments]   ${path}   ${endpoint}
811
812    ${resp}=  Read Properties  ${path}/enumerate  timeout=30
813    Log Dictionary  ${resp}
814
815    ${list}=  Get Dictionary Keys  ${resp}
816    # For a given string, look for prefix and suffix for matching expression.
817    # Start of string followed by zero or more of any character followed by
818    # any digit or lower case character.
819    ${resp}=  Get Matches  ${list}  regexp=^.*[0-9a-z_].${endpoint}[0-9a-z]*$
820    [Return]  ${resp}
821
822Check Zombie Process
823    [Documentation]    Check if any defunct process exist or not on BMC
824    ${count}  ${stderr}  ${rc}=  Execute Command  ps -o stat | grep Z | wc -l
825    ...    return_stderr=True  return_rc=True
826    Should Be True    ${count}==0
827    Should Be Empty    ${stderr}
828
829Prune Journal Log
830    [Documentation]   Prune archived journal logs.
831    [Arguments]   ${vacuum_size}=1M
832
833    # This keyword can be used to prevent the journal
834    # log from filling up the /run filesystem.
835    # This command will retain only the latest logs
836    # of the user specified size.
837
838    Open Connection And Log In
839    ${output}  ${stderr}  ${rc}=
840    ...  Execute Command
841    ...  journalctl --vacuum-size=${vacuum_size}
842    ...  return_stderr=True  return_rc=True
843
844    Should Be Equal  ${rc}  ${0}  msg=${stderr}
845
846Set BMC Power Policy
847    [Documentation]   Set the given BMC power policy.
848    [Arguments]   ${policy}
849
850    # Note that this function will translate the old style "RESTORE_LAST_STATE"
851    # policy to the new style "xyz.openbmc_project.Control.Power.RestorePolicy.
852    # Policy.Restore" for you.
853
854    # Description of argument(s):
855    # policy    Power restore policy (e.g "RESTORE_LAST_STATE",
856    #           ${RESTORE_LAST_STATE}).
857
858    # Set the bmc_power_policy_method to either 'Old' or 'New'.
859    Set Power Policy Method
860    # This translation helps bridge between old and new method for calling.
861    ${policy}=  Translate Power Policy Value  ${policy}
862    # Run the appropriate keyword.
863    Run Key  ${bmc_power_policy_method} Set Power Policy \ ${policy}
864    ${currentPolicy}=  Get System Power Policy
865    Should Be Equal    ${currentPolicy}   ${policy}
866
867New Set Power Policy
868    [Documentation]   Set the given BMC power policy (new method).
869    [Arguments]   ${policy}
870
871    # Description of argument(s):
872    # policy    Power restore policy (e.g. ${RESTORE_LAST_STATE}).
873
874    ${valueDict}=  Create Dictionary  data=${policy}
875    Write Attribute
876    ...  ${POWER_RESTORE_URI}  PowerRestorePolicy  data=${valueDict}
877
878Old Set Power Policy
879    [Documentation]   Set the given BMC power policy (old method).
880    [Arguments]   ${policy}
881
882    # Description of argument(s):
883    # policy    Power restore policy (e.g. "RESTORE_LAST_STATE").
884
885    ${valueDict}=     create dictionary  data=${policy}
886    Write Attribute    ${HOST_SETTING}    power_policy   data=${valueDict}
887
888Get System Power Policy
889    [Documentation]  Get the BMC power policy.
890
891    # Set the bmc_power_policy_method to either 'Old' or 'New'.
892    Set Power Policy Method
893    ${cmd_buf}=  Create List  ${bmc_power_policy_method} Get Power Policy
894    # Run the appropriate keyword.
895    ${currentPolicy}=  Run Keyword  @{cmd_buf}
896    [Return]  ${currentPolicy}
897
898New Get Power Policy
899    [Documentation]  Get the BMC power policy (new method).
900    ${currentPolicy}=  Read Attribute  ${POWER_RESTORE_URI}  PowerRestorePolicy
901    [Return]  ${currentPolicy}
902
903Old Get Power Policy
904    [Documentation]  Get the BMC power policy (old method).
905    ${currentPolicy}=  Read Attribute  ${HOST_SETTING}  power_policy
906    [Return]  ${currentPolicy}
907
908Get Auto Reboot
909    [Documentation]  Returns auto reboot setting.
910    ${setting}=  Read Attribute  ${CONTROL_HOST_URI}/auto_reboot  AutoReboot
911    [Return]  ${setting}
912
913Set Auto Reboot
914    [Documentation]  Set the given auto reboot setting.
915    [Arguments]  ${setting}
916    # setting  auto reboot's setting, i.e. 1 for enabling and 0 for disabling.
917
918    ${valueDict}=  Set Variable  ${setting}
919    ${data}=  Create Dictionary  data=${valueDict}
920    Write Attribute  ${CONTROL_HOST_URI}/auto_reboot  AutoReboot   data=${data}
921    ${current_setting}=  Get Auto Reboot
922    Should Be Equal As Integers  ${current_setting}  ${setting}
923
924
925Set BMC Reset Reference Time
926    [Documentation]  Set current boot time as a reference and increment
927    ...              boot count.
928
929    ${cur_btime}=  Get BMC Boot Time
930    Run Keyword If  ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
931    ...  Set Global Variable  ${BOOT_TIME}  ${cur_btime}
932    ...  ELSE IF  ${cur_btime} > ${BOOT_TIME}
933    ...  Run Keywords  Set Global Variable  ${BOOT_TIME}  ${cur_btime}
934    ...  AND
935    ...  Set Global Variable  ${BOOT_COUNT}  ${BOOT_COUNT + 1}
936
937Get BMC Boot Time
938    [Documentation]  Get boot time from /proc/stat.
939
940    Open Connection And Log In
941    ${output}  ${stderr}=
942    ...  Execute Command  egrep '^btime ' /proc/stat | cut -f 2 -d ' '
943    ...  return_stderr=True
944    Should Be Empty  ${stderr}
945    ${btime}=  Convert To Integer  ${output}
946    [Return]  ${btime}
947
948Execute Command On BMC
949    [Documentation]  Execute given command on BMC and return output.
950    [Arguments]  ${command}
951    ${stdout}  ${stderr}=  Execute Command  ${command}  return_stderr=True
952    Should Be Empty  ${stderr}
953    [Return]  ${stdout}
954
955
956Enable Core Dump On BMC
957    [Documentation]  Enable core dump collection.
958    Open Connection And Log In
959    ${core_pattern}=  Execute Command On BMC
960    ...  echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
961    Should Be Equal As Strings  ${core_pattern}  /tmp/core_%e.%p
962
963Get Number Of BMC Core Dump Files
964    [Documentation]  Get number of core dump files on BMC.
965    Open Connection And Log In
966    ${num_of_core_dump}=  Execute Command
967    ...  ls /tmp/core* 2>/dev/null | wc -l
968    [Return]  ${num_of_core_dump}
969
970Set Core Dump File Size Unlimited
971    [Documentation]  Set core dump file size to unlimited.
972    Open Connection And Log In
973    Execute Command On BMC
974    ...  ulimit -c unlimited
975
976Check For Core Dumps
977    [Documentation]  Check for any core dumps exist.
978    ${output}=  Get Number Of BMC Core Dump Files
979    Run Keyword If  ${output} > 0
980    ...  Log  **Warning** BMC core dump files exist  level=WARN
981
982Trigger Host Watchdog Error
983    [Documentation]  Inject host watchdog timeout error via REST.
984    [Arguments]  ${milliseconds}=1000  ${sleep_time}=5s
985    # Description of argument(s):
986    # milliseconds  The time watchdog timer value in milliseconds (e.g. 1000 =
987    #               1 second).
988    # sleep_time    Time delay for host watchdog error to get injected.
989    #               Default is 5 seconds.
990
991    ${data}=  Create Dictionary  data=${True}
992    Write Attribute  /xyz/openbmc_project/watchdog/host0  Enabled  data=${data}
993
994    ${data}=  Create Dictionary  data=${milliseconds}
995    Write Attribute  /xyz/openbmc_project/watchdog/host0  TimeRemaining
996    ...  data=${data}
997
998    Sleep  ${sleep_time}
999
1000Login To OS Host
1001    [Documentation]  Login to OS Host.
1002    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
1003    ...          ${os_password}=${OS_PASSWORD}
1004    # Description of arguments:
1005    # ${os_host} IP address of the OS Host.
1006    # ${os_username}  OS Host Login user name.
1007    # ${os_password}  OS Host Login passwrd.
1008
1009    ${os_state}=  Run Keyword And Return Status  Ping Host  ${os_host}
1010    Run Keyword If  '${os_state}' == 'False'
1011    ...  Run Keywords  Initiate Host Reboot  AND
1012    ...  Is Host Running  AND
1013    ...  Wait for OS  ${os_host}  ${os_username}  ${os_password}
1014
1015    SSHLibrary.Open Connection  ${os_host}
1016    ${resp}=  Login  ${os_username}  ${os_password}
1017    [Return]  ${resp}
1018
1019Configure Initial Settings
1020    [Documentation]  Restore old IP and route.
1021    ...  This keyword requires initial settings viz IP address,
1022    ...  Network Mask, default gatway and serial console IP and port
1023    ...  information which should be provided in command line.
1024
1025    [Arguments]  ${host}=${OPENBMC_HOST}  ${mask}=${NET_MASK}
1026    ...          ${gw_ip}=${GW_IP}
1027
1028    # Open telnet connection and ignore the error, in case telnet session is
1029    # already opened by the program calling this keyword.
1030
1031    Run Keyword And Ignore Error  Open Telnet Connection to BMC Serial Console
1032    Telnet.write  ifconfig eth0 ${host} netmask ${mask}
1033    Telnet.write  route add default gw ${gw_ip}
1034
1035Install Debug Tarball On BMC
1036    [Documentation]  Copy the debug tar file to BMC and install.
1037    [Arguments]  ${tarball_file_path}=${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz
1038    ...          ${targ_tarball_dir_path}=/tmp/tarball/
1039
1040    # Description of arguments:
1041    # tarball_file_path      Path of the debug tarball file.
1042    #                        The tar file is downloaded from the build page
1043    #                        https://openpower.xyz/job/openbmc-build/
1044    #                        obmc-phosphor-debug-tarball-witherspoon.tar.xz
1045    #
1046    # targ_tarball_dir_path  The directory path where the tarball is to be
1047    #                        installed.
1048
1049    OperatingSystem.File Should Exist  ${tarball_file_path}
1050    ...  msg=${tarball_file_path} doesn't exist.
1051
1052    # Upload the file to BMC.
1053    Import Library  SCPLibrary  WITH NAME  scp
1054    Open Connection for SCP
1055    scp.Put File  ${tarball_file_path}  /tmp/debug-tarball.tar.xz
1056
1057    # Create tarball directory and install.
1058    BMC Execute Command  mkdir -p ${targ_tarball_dir_path}
1059    BMC Execute Command
1060    ...  tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path}
1061
1062    # Remove the tarball file from BMC.
1063    BMC Execute Command  rm -f /tmp/debug-tarball.tar.xz
1064
1065
1066Get BMC Boot Count
1067    [Documentation]  Get BMC boot count based on boot time.
1068    ${cur_btime}=  Get BMC Boot Time
1069
1070    # Set global variable BOOT_TIME to current boot time if current boot time
1071    # is changed. Also increase value of global variable BOOT_COUNT by 1.
1072    Run Keyword If  ${cur_btime} > ${BOOT_TIME}
1073    ...  Run Keywords  Set Global Variable  ${BOOT_TIME}  ${cur_btime}
1074    ...  AND
1075    ...  Set Global Variable  ${BOOT_COUNT}  ${BOOT_COUNT + 1}
1076    [Return]  ${BOOT_COUNT}
1077
1078Set BMC Boot Count
1079    [Documentation]  Set BMC boot count to given value.
1080    [Arguments]  ${count}
1081
1082    # Description of arguments:
1083    # count  boot count value.
1084    ${cur_btime}=  Get BMC Boot Time
1085
1086    # Set global variable BOOT_COUNT to given value.
1087    Set Global Variable  ${BOOT_COUNT}  ${count}
1088
1089    # Set BOOT_TIME variable to current boot time.
1090    Set Global Variable  ${BOOT_COUNT}  ${count}
1091
1092Get System LED State
1093    [Documentation]  Return the state of given system LED.
1094    [Arguments]  ${led_name}
1095
1096    # Description of argument(s):
1097    # led_name     System LED name (e.g. heartbeat, identify, beep).
1098
1099    ${state}=  Read Attribute  ${LED_PHYSICAL_URI}${led_name}  State
1100    [Return]  ${state.rsplit('.', 1)[1]}
1101
1102
1103Delete Error Logs
1104    [Documentation]  Delete error logs.
1105
1106    # Check if error logs entries exist, if not return.
1107    ${resp}=  OpenBMC Get Request  ${BMC_LOGGING_ENTRY}${/}list  quiet=${1}
1108    Return From Keyword If  ${resp.status_code} == ${HTTP_NOT_FOUND}
1109
1110    # Get the list of error logs entries and delete them all.
1111    ${elog_entries}=  Get URL List  ${BMC_LOGGING_ENTRY}
1112    :FOR  ${entry}  IN  @{elog_entries}
1113    \  Delete Error Log Entry  ${entry}
1114
1115
1116Delete Error Log Entry
1117    [Documentation]  Delete error log entry.
1118    [Arguments]  ${entry_path}
1119
1120    # Description of argument(s):
1121    # entry_path  Delete an error log entry.
1122    #             Ex. /xyz/openbmc_project/logging/entry/1
1123
1124    # Skip delete if entry URI is a callout.
1125    # Example: /xyz/openbmc_project/logging/entry/1/callout
1126    Return From Keyword If  '${entry_path.rsplit('/', 1)[1]}' == 'callout'
1127
1128    ${data}=  Create Dictionary  data=@{EMPTY}
1129    ${resp}=  Openbmc Delete Request  ${entry_path}  data=${data}
1130    Should Be Equal As Strings  ${resp.status_code}  ${HTTP_OK}
1131
1132
1133Delete All Error Logs
1134    [Documentation]  Delete all error log entries using "DeleteAll" interface.
1135
1136    ${data}=  Create Dictionary  data=@{EMPTY}
1137    ${resp}=  Openbmc Post Request  ${BMC_LOGGING_URI}action/DeleteAll
1138    ...  data=${data}
1139    Should Be Equal As Strings  ${resp.status_code}  ${HTTP_OK}
1140
1141
1142Get LED State XYZ
1143    [Documentation]  Returns state of given LED.
1144    [Arguments]  ${led_name}
1145    # Description of argument(s):
1146    # led_name  Name of LED
1147
1148    ${state}=  Read Attribute  ${LED_GROUPS_URI}${led_name}  Asserted
1149    [Return]  ${state}
1150
1151
1152Get BMC Version
1153    [Documentation]  Returns BMC version from /etc/os-release.
1154    ...              e.g. "v1.99.6-141-ge662190"
1155
1156    Open Connection And Log In
1157    ${cmd}=  Set Variable  grep ^VERSION_ID= /etc/os-release | cut -f 2 -d '='
1158    ${output}=  Execute Command On BMC  ${cmd}
1159    [Return]  ${output}
1160
1161
1162Get PNOR Version
1163    [Documentation]  Get the PNOR version from the BMC.
1164
1165    ${pnor_attrs}=  Get PNOR Attributes
1166    [Return]  ${pnor_attrs['version']}
1167
1168
1169Get PNOR Attributes
1170    [Documentation]  Return PNOR software attributes as a dictionary.
1171
1172    # This keyword parses /var/lib/phosphor-software-manager/pnor/ro/pnor.toc
1173    # into key/value pairs.
1174
1175    ${outbuf}  ${stderr}  ${rc}=  BMC Execute Command
1176    ...  cat /var/lib/phosphor-software-manager/pnor/ro/pnor.toc
1177    ${pnor_attrs}=  Key Value Outbuf To Dict  ${outbuf}  delim==
1178
1179    [Return]  ${pnor_attrs}
1180
1181
1182Get Elog URL List
1183    [Documentation]  Return error log entry list of URLs.
1184
1185    ${url_list}=  Read Properties  /xyz/openbmc_project/logging/entry/
1186    Sort List  ${url_list}
1187    [Return]  ${url_list}
1188
1189
1190Read Turbo Setting Via REST
1191    [Documentation]  Return turbo setting via REST.
1192
1193    ${resp}=  OpenBMC Get Request  ${SENSORS_URI}host/TurboAllowed
1194    ${jsondata}=  To JSON  ${resp.content}
1195    Should Be Equal As Strings  ${resp.status_code}  ${HTTP_OK}
1196    [Return]  ${jsondata["data"]["value"]}
1197
1198
1199Set Turbo Setting Via REST
1200    [Documentation]  Set turbo setting via REST.
1201    [Arguments]  ${setting}
1202    # Description of argument(s):
1203    # setting  Value which needs to be set.(i.e. False or True)
1204
1205    ${valueDict}=  Create Dictionary  data=${setting}
1206    Write Attribute  ${SENSORS_URI}host/TurboAllowed  value  data=${valueDict}
1207
1208Set Control Boot Mode
1209    [Documentation]  Set given boot mode on the boot object path attribute.
1210    [Arguments]  ${boot_path}  ${boot_mode}
1211
1212    # Description of argument(s):
1213    # boot_path  Boot object path.
1214    #            Example:
1215    #            /xyz/openbmc_project/control/host0/boot
1216    #            /xyz/openbmc_project/control/host0/boot/one_time
1217    # boot_mode  Boot mode which need to be set.
1218    #            Example:
1219    #            "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"
1220
1221    ${valueDict}=  Create Dictionary  data=${boot_mode}
1222    Write Attribute  ${boot_path}  BootMode  data=${valueDict}
1223
1224Copy Address Translation Utils To HOST OS
1225    [Documentation]  Copy address translation utils to host OS.
1226
1227    OperatingSystem.File Should Exist  ${probe_cpu_tool_path}
1228    ...  msg=${probe_cpu_tool_path} doesn't exist.
1229    OperatingSystem.File Should Exist  ${probe_cpu_tool_path}
1230    ...  msg=${probe_cpu_tool_path} doesn't exist.
1231
1232    scp.Open connection  ${OS_HOST}  username=${OS_USERNAME}
1233    ...  password=${OS_PASSWORD}
1234    scp.Put File  ${probe_cpu_tool_path}  ${target_file_path}
1235    scp.Put File  ${scom_addrs_tool_path}  ${target_file_path}
1236
1237
1238Verify BMC RTC And UTC Time Drift
1239    [Documentation]  Verify that the RTC and UTC time difference is less than
1240    ...              the given time_drift_max.
1241    [Arguments]  ${time_diff_max}=${10}
1242
1243    # Description of argument(s):
1244    # time_diff_max   The max allowable RTC and UTC time difference in seconds.
1245
1246    # Example:
1247    # time_dict:
1248    #   [local_time]:               Fri 2017-11-03 152756 UTC
1249    #   [local_time_seconds]:       1509740876
1250    #   [universal_time]:           Fri 2017-11-03 152756 UTC
1251    #   [universal_time_seconds]:   1509740876
1252    #   [rtc_time]:                 Fri 2016-05-20 163403
1253    #   [rtc_time_seconds]:         1463780043
1254    #   [time_zone]:                n/a (UTC, +0000)
1255    #   [network_time_on]:          yes
1256    #   [ntp_synchronized]:         no
1257    #   [rtc_in_local_tz]:          no
1258
1259    ${bmc_time}=  Get BMC Date Time
1260    ${time_diff}=  Evaluate
1261    ...  ${bmc_time['universal_time_seconds']} - ${bmc_time['rtc_time_seconds']}
1262    Should Be True  ${time_diff} < ${time_diff_max}
1263
1264
1265