1*** Settings ***
2Resource                ../lib/resource.txt
3Resource                ../lib/rest_client.robot
4Resource                ../lib/connection_client.robot
5Library                 DateTime
6Library                 Process
7Library                 OperatingSystem
8Library                 gen_print.py
9Library                 gen_robot_print.py
10
11*** Variables ***
12${SYSTEM_SHUTDOWN_TIME}       ${5}
13${dbuscmdBase}
14...  dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host
15${dbuscmdGet}
16...  ${SETTINGS_URI}host0  org.freedesktop.DBus.Properties.Get
17# Enable when ready with openbmc/openbmc-test-automation#203
18#${dbuscmdString}=  string:"xyz.openbmc_project.settings.Host" string:
19${dbuscmdString}=   string:"org.openbmc.settings.Host" string:
20
21# Assign default value to QUIET for programs which may not define it.
22${QUIET}  ${0}
23${bmc_mem_free_cmd}=   free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4
24${bmc_mem_total_cmd}=   free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2
25${bmc_cpu_usage_cmd}=   top -n 1  | grep CPU: | cut -c 7-9
26${HOST_SETTING}    ${SETTINGS_URI}host0
27# /run/initramfs/ro associate filesystem  should be 100% full always
28${bmc_file_system_usage_cmd}=
29...  df -h | grep -v /run/initramfs/ro | cut -c 52-54 | grep 100 | wc -l
30
31${BOOT_TIME}     ${0}
32${BOOT_COUNT}    ${0}
33${devicetree_base}  /sys/firmware/devicetree/base/model
34
35*** Keywords ***
36
37Get BMC System Model
38    [Documentation]  Get the BMC model from the device tree.
39
40    ${bmc_model}  ${stderr}=  Execute Command
41    ...  cat ${devicetree_base} | cut -d " " -f 1  return_stderr=True
42    Should Be Empty  ${stderr}
43    Should Not Be Empty  ${bmc_model}
44    [Return]  ${bmc_model}
45
46Verify BMC System Model
47    [Documentation]  Verify the BMC model with ${OPENBMC_MODEL}.
48    [Arguments]  ${bmc_model}
49
50    ${tmp_bmc_model}=  Fetch From Right  ${OPENBMC_MODEL}  /
51    ${tmp_bmc_model}=  Fetch From Left  ${tmp_bmc_model}  .
52    ${ret}=  Run Keyword And Return Status  Should Contain  ${bmc_model}
53    ...  ${tmp_bmc_model}  ignore_case=True
54    [Return]  ${ret}
55
56Wait For Host To Ping
57    [Arguments]  ${host}  ${timeout}=${OPENBMC_REBOOT_TIMEOUT}min
58    ...          ${interval}=5 sec
59
60    # host      The DNS name or IP of the host to ping.
61    # timeout   The amount of time after which attempts to ping cease.
62    # interval  The amount of time in between attempts to ping.
63
64    Wait Until Keyword Succeeds  ${timeout}  ${interval}  Ping Host  ${host}
65
66Ping Host
67    [Arguments]     ${host}
68    Should Not Be Empty    ${host}   msg=No host provided
69    ${RC}   ${output}=     Run and return RC and Output    ping -c 4 ${host}
70    Log     RC: ${RC}\nOutput:\n${output}
71    Should be equal     ${RC}   ${0}
72
73Get Boot Progress
74    [Arguments]  ${quiet}=${QUIET}
75
76    ${state}=  Read Attribute  ${OPENBMC_BASE_URI}sensors/host/BootProgress
77    ...  value  quiet=${quiet}
78    [Return]  ${state}
79
80Is Power On
81    ${state}=  Get Power State
82    Should be equal  ${state}  ${1}
83
84Is Power Off
85    ${state}=  Get Power State
86    Should be equal  ${state}  ${0}
87
88Initiate Power On
89    [Documentation]  Initiates the power on and waits until the Is Power On
90    ...  keyword returns that the power state has switched to on.
91    [Arguments]  ${wait}=${1}
92
93    @{arglist}=   Create List
94    ${args}=     Create Dictionary    data=@{arglist}
95    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  powerOn
96    ...  data=${args}
97    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
98
99    # Does caller want to wait for power on status?
100    Run Keyword If  '${wait}' == '${0}'  Return From Keyword
101    Wait Until Keyword Succeeds  3 min  10 sec  Is Power On
102
103Initiate Power Off
104    [Documentation]  Initiates the power off and waits until the Is Power Off
105    ...  keyword returns that the power state has switched to off.
106    @{arglist}=   Create List
107    ${args}=     Create Dictionary    data=@{arglist}
108    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  powerOff
109    ...  data=${args}
110    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
111    Wait Until Keyword Succeeds  1 min  10 sec  Is Power Off
112
113Initiate OS Host Power Off
114    [Documentation]  Initiate an OS reboot.
115    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
116    ...          ${os_password}=${OS_PASSWORD}
117
118    # Description of arguments:
119    # os_host      The DNS name or IP of the OS.
120    # os_username  The username to be used to sign in to the OS.
121    # os_password  The password to be used to sign in to the OS.
122
123    Open connection  ${os_host}
124    Login  ${os_username}  ${os_password}
125    ${cmd_buf}  Catenate  shutdown
126    Start Command  ${cmd_buf}
127    Close Connection
128
129Initiate OS Host Reboot
130    [Documentation]  Initiate an OS reboot.
131    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
132    ...          ${os_password}=${OS_PASSWORD}
133
134    # Description of arguments:
135    # os_host      The DNS name or IP of the OS.
136    # os_username  The username to be used to sign in to the OS.
137    # os_password  The password to be used to sign in to the OS.
138
139    Open connection  ${os_host}
140    Login  ${os_username}  ${os_password}
141    ${cmd_buf}  Catenate  reboot
142    Start Command  ${cmd_buf}
143    Close Connection
144
145Initiate Auto Reboot
146    [Documentation]  Initiate an auto reboot.
147
148    # Set the auto reboot policy.
149    Set Auto Reboot  yes
150
151    Open connection  ${openbmc_host}
152    Login  ${openbmc_username}  ${openbmc_password}
153
154    # Set the watchdog timer.  Note: 5000 = milliseconds which is 5 seconds.
155    ${cmd_buf}=  Catenate  /usr/sbin/mapper call /org/openbmc/watchdog/host0
156    ...  org.openbmc.Watchdog set i 5000
157    ${output}  ${stderr}  ${rc}=  Execute Command  ${cmd_buf}
158    ...  return_stderr=True  return_rc=True
159    Should Be Empty  ${stderr}
160    Should be equal  ${rc}  ${0}
161
162    # Start the watchdog.
163    ${cmd_buf}=  Catenate  /usr/sbin/mapper call /org/openbmc/watchdog/host0
164    ...  org.openbmc.Watchdog start
165    ${output}  ${stderr}  ${rc}=  Execute Command  ${cmd_buf}
166    ...  return_stderr=True  return_rc=True
167    Should Be Empty  ${stderr}
168    Should be equal  ${rc}  ${0}
169
170Trigger Warm Reset
171    log to console    "Triggering warm reset"
172    ${data}=   create dictionary   data=@{EMPTY}
173    ${resp}=  openbmc post request
174    ...  ${OPENBMC_BASE_URI}control/bmc0/action/warmReset  data=${data}
175    Should Be Equal As Strings      ${resp.status_code}     ${HTTP_OK}
176    ${session_active}=   Check If warmReset is Initiated
177    Run Keyword If   '${session_active}' == '${True}'
178    ...    Fail   msg=warm reset didn't occur
179
180    Sleep   ${SYSTEM_SHUTDOWN_TIME}min
181    Check If BMC Is Up
182
183Check OS
184    [Documentation]  Attempts to ping the host OS and then checks that the host
185    ...              OS is up by running an SSH command.
186
187    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
188    ...          ${os_password}=${OS_PASSWORD}  ${quiet}=${QUIET}
189    ...          ${print_string}=${EMPTY}
190    [Teardown]  Close Connection
191
192    # os_host           The DNS name/IP of the OS host associated with our BMC.
193    # os_username       The username to be used to sign on to the OS host.
194    # os_password       The password to be used to sign on to the OS host.
195    # quiet             Indicates whether this keyword should write to console.
196    # print_string      A string to be printed before checking the OS.
197
198    rprint  ${print_string}
199
200    # Attempt to ping the OS. Store the return code to check later.
201    ${ping_rc}=  Run Keyword and Return Status  Ping Host  ${os_host}
202
203    Open connection  ${os_host}
204
205    ${status}  ${msg}=  Run Keyword And Ignore Error  Login  ${os_username}
206    ...  ${os_password}
207    ${err_msg1}=  Sprint Error  ${msg}
208    ${err_msg}=  Catenate  SEPARATOR=  \n  ${err_msg1}
209    Run Keyword If  '${status}' == 'FAIL'  Fail  msg=${err_msg}
210    ${output}  ${stderr}  ${rc}=  Execute Command  uptime  return_stderr=True
211    ...        return_rc=True
212
213    ${temp_msg}=  Catenate  Could not execute a command on the operating
214    ...  system.\n
215    ${err_msg1}=  Sprint Error  ${temp_msg}
216    ${err_msg}=  Catenate  SEPARATOR=  \n  ${err_msg1}
217
218    # If the return code returned by "Execute Command" is non-zero, this
219    # keyword will fail.
220    Should Be Equal  ${rc}  ${0}  msg=${err_msg}
221    # We will likewise fail if there is any stderr data.
222    Should Be Empty  ${stderr}
223
224    ${temp_msg}=  Set Variable  Could not ping the operating system.\n
225    ${err_msg1}=  Sprint Error  ${temp_msg}
226    ${err_msg}=  Catenate  SEPARATOR=  \n  ${err_msg1}
227    # We will likewise fail if the OS did not ping, as we could SSH but not
228    # ping
229    Should Be Equal As Strings  ${ping_rc}  ${TRUE}  msg=${err_msg}
230
231Wait for OS
232    [Documentation]  Waits for the host OS to come up via calls to "Check OS".
233    [Arguments]  ${os_host}=${OS_HOST}  ${os_username}=${OS_USERNAME}
234    ...          ${os_password}=${OS_PASSWORD}  ${timeout}=${OS_WAIT_TIMEOUT}
235    ...          ${quiet}=${0}
236    [Teardown]  rprintn
237
238    # os_host           The DNS name or IP of the OS host associated with our
239    #                   BMC.
240    # os_username       The username to be used to sign on to the OS host.
241    # os_password       The password to be used to sign on to the OS host.
242    # timeout           The timeout in seconds indicating how long you're
243    #                   willing to wait for the OS to respond.
244    # quiet             Indicates whether this keyword should write to console.
245
246    # The interval to be used between calls to "Check OS".
247    ${interval}=  Set Variable  5
248
249    ${message}=  Catenate  Checking every ${interval} seconds for up to
250    ...  ${timeout} seconds for the operating system to communicate.
251    rqprint_timen  ${message}
252
253    Wait Until Keyword Succeeds  ${timeout} sec  ${interval}  Check OS
254    ...                          ${os_host}  ${os_username}  ${os_password}
255    ...                          print_string=\#
256
257    rqprintn
258
259    rqprint_timen  The operating system is now communicating.
260
261Get BMC State Deprecated
262    [Documentation]  Returns the state of the BMC as a string. (i.e: BMC_READY)
263    [Arguments]  ${quiet}=${QUIET}
264
265    @{arglist}=  Create List
266    ${args}=  Create Dictionary  data=@{arglist}
267    ${resp}=  Call Method  ${OPENBMC_BASE_URI}managers/System/  getSystemState
268    ...        data=${args}  quiet=${quiet}
269    Should be equal as strings  ${resp.status_code}  ${HTTP_OK}
270    ${content}=  to json  ${resp.content}
271    [Return]  ${content["data"]}
272
273Get Power State
274    [Documentation]  Returns the power state as an integer. Either 0 or 1.
275    [Arguments]  ${quiet}=${QUIET}
276
277    @{arglist}=  Create List
278    ${args}=  Create Dictionary  data=@{arglist}
279
280    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/chassis0/  getPowerState
281    ...        data=${args}  quiet=${quiet}
282    Should be equal as strings  ${resp.status_code}  ${HTTP_OK}
283    ${content}=  to json  ${resp.content}
284    [Return]  ${content["data"]}
285
286Clear BMC Record Log
287    [Documentation]  Clears all the event logs on the BMC. This would be
288    ...              equivalent to ipmitool sel clear.
289    @{arglist}=   Create List
290    ${args}=     Create Dictionary    data=@{arglist}
291    ${resp}=  Call Method
292    ...  ${OPENBMC_BASE_URI}records/events/  clear  data=${args}
293    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
294
295Copy PNOR to BMC
296    Import Library      SCPLibrary      WITH NAME       scp
297    Open Connection for SCP
298    Log    Copying ${PNOR_IMAGE_PATH} to /tmp
299    scp.Put File    ${PNOR_IMAGE_PATH}   /tmp
300
301Flash PNOR
302    [Documentation]    Calls flash bios update method to flash PNOR image
303    [Arguments]    ${pnor_image}
304    @{arglist}=   Create List    ${pnor_image}
305    ${args}=     Create Dictionary    data=@{arglist}
306    ${resp}=  Call Method  ${OPENBMC_BASE_URI}control/flash/bios/  update
307    ...  data=${args}
308    should be equal as strings      ${resp.status_code}     ${HTTP_OK}
309    Wait Until Keyword Succeeds    2 min   10 sec    Is PNOR Flashing
310
311Get Flash BIOS Status
312    [Documentation]  Returns the status of the flash BIOS API as a string. For
313    ...              example 'Flashing', 'Flash Done', etc
314    ${data}=      Read Properties     ${OPENBMC_BASE_URI}control/flash/bios
315    [Return]    ${data['status']}
316
317Is PNOR Flashing
318    [Documentation]  Get BIOS 'Flashing' status. This indicates that PNOR
319    ...              flashing has started.
320    ${status}=    Get Flash BIOS Status
321    should be equal as strings     ${status}     Flashing
322
323Is PNOR Flash Done
324    [Documentation]  Get BIOS 'Flash Done' status.  This indicates that the
325    ...              PNOR flashing has completed.
326    ${status}=    Get Flash BIOS Status
327    should be equal as strings     ${status}     Flash Done
328
329Is System State Host Booted
330    [Documentation]  Checks whether system state is HOST_BOOTED.
331    ${state}=    Get BMC State Deprecated
332    should be equal as strings     ${state}     HOST_BOOTED
333
334Is OS Starting
335    [Documentation]  Check if boot progress is OS starting.
336    ${boot_progress}=  Get Boot Progress
337    Should Be Equal  ${boot_progress}  FW Progress, Starting OS
338
339Verify Ping and REST Authentication
340    ${l_ping}=   Run Keyword And Return Status
341    ...    Ping Host  ${OPENBMC_HOST}
342    Run Keyword If  '${l_ping}' == '${False}'
343    ...    Fail   msg=Ping Failed
344
345    ${l_rest}=   Run Keyword And Return Status
346    ...    Initialize OpenBMC
347    Run Keyword If  '${l_rest}' == '${False}'
348    ...    Fail   msg=REST Authentication Failed
349
350    # Just to make sure the SSH is working for SCP
351    Open Connection And Log In
352    ${system}   ${stderr}=    Execute Command   hostname   return_stderr=True
353    Should Be Empty     ${stderr}
354
355Check If BMC is Up
356    [Documentation]  Wait for Host to be online. Checks every X seconds
357    ...              interval for Y minutes and fails if timed out.
358    ...              Default MAX timedout is 10 min, interval 10 seconds.
359    [Arguments]      ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
360    ...              ${interval}=10 sec
361
362    Wait Until Keyword Succeeds
363    ...   ${max_timeout}  ${interval}   Verify Ping and REST Authentication
364
365
366Check If warmReset is Initiated
367    [Documentation]  Ping would be still alive, so try SSH to connect
368    ...              if fails the ports are down indicating reboot
369    ...              is in progress
370
371    # Warm reset adds 3 seconds delay before forcing reboot
372    # To minimize race conditions, we wait for 7 seconds
373    Sleep  7s
374    ${alive}=   Run Keyword and Return Status
375    ...    Open Connection And Log In
376    Return From Keyword If   '${alive}' == '${False}'    ${False}
377    [Return]    ${True}
378
379Flush REST Sessions
380    [Documentation]   Removes all the active session objects
381    Delete All Sessions
382
383Initialize DBUS cmd
384    [Documentation]  Initialize dbus string with property string to extract
385    [Arguments]   ${boot_property}
386    ${cmd}=     Catenate  ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
387    ${cmd}=     Catenate  ${cmd}${boot_property}
388    Set Global Variable   ${dbuscmd}     ${cmd}
389
390Create OS Console File Path
391    [Documentation]  Create OS console file path name and return it.
392    [Arguments]  ${log_file_path}=${EMPTY}
393
394    # Description of arguements:
395    # file_path  The caller's candidate value.  If this value is ${EMPTY}, this
396    #            keyword will compose a file path name.  Otherwise, this
397    #            keyword will use the caller's file_path value.  In either
398    #            case, the value will be returned.
399
400    ${default_file_path}=  Catenate  /tmp/${OPENBMC_HOST}_os_console
401    ${log_file_path}=  Set Variable If  '${log_file_path}' == '${EMPTY}'
402    ...  ${default_file_path}  ${log_file_path}
403
404    [Return]  ${log_file_path}
405
406Create OS Console Command String
407    [Documentation]  Return a command string to start OS console logging.
408
409    # First make sure that the ssh_pw program is available.
410    ${cmd_buf}=  Catenate  which ssh_pw 2>&1
411    Rdpissuing  ${cmd_buf}
412    ${rc}  ${output}=  Run And Return Rc And Output  ${cmd_buf}
413    Rdpvars  rc  output
414    Should Be Equal  ${rc}  ${0}  msg=${output}\n
415
416    ${cmd_buf}=  Catenate  ssh_pw ${OPENBMC_PASSWORD} -p 2200
417    ...  ${OPENBMC_USERNAME}@${OPENBMC_HOST}
418
419    [Return]  ${cmd_buf}
420
421Stop SOL Console Logging
422    [Documentation]  Stop system console logging and return log output.
423    [Arguments]  ${log_file_path}=${EMPTY}  ${targ_file_path}=${EMPTY}
424
425    # If there are muliple system console processes, they will all be stopped.
426    # If there is no existing log file this keyword will return an error
427    # message to that effect (and write that message to targ_file_path, if
428    # specified).
429    # NOTE: This keyword will not fail if there is no running system console
430    # process.
431
432    # Description of arguments:
433    # log_file_path   The file path that was used to call "Start SOL
434    #                 Console Logging".  See that keyword (above) for details.
435    # targ_file_path  If specified, the file path to which the source
436    #                 file path (i.e. "log_file_path") should be copied.
437
438    ${log_file_path}=  Create OS Console File Path  ${log_file_path}
439    # Find the pid of the active system console logging session (if any).
440    ${search_string}=  Create OS Console Command String
441    ${cmd_buf}=  Catenate  echo $(ps -ef | egrep '${search_string}'
442    ...  | egrep -v grep | cut -c10-14)
443    Rdpissuing  ${cmd_buf}
444    ${rc}  ${os_con_pid}=  Run And Return Rc And Output  ${cmd_buf}
445    Rdpvars  os_con_pid
446    # If rc is not zero it just means that there is no OS Console process
447    # running.
448
449    ${cmd_buf}=  Catenate  kill -9 ${os_con_pid}
450    Run Keyword If  '${os_con_pid}' != '${EMPTY}'  Rdpissuing  ${cmd_buf}
451    ${rc}  ${output}=  Run Keyword If  '${os_con_pid}' != '${EMPTY}'
452    ...  Run And Return Rc And Output  ${cmd_buf}
453    Run Keyword If  '${os_con_pid}' != '${EMPTY}'  Rdpvars  rc  output
454
455    ${cmd_buf}=  Set Variable  cat ${log_file_path} 2>&1
456    Rdpissuing  ${cmd_buf}
457    ${rc}  ${output}=  Run And Return Rc And Output  ${cmd_buf}
458    Rdpvars  rc
459
460    Run Keyword If  '${targ_file_path}' != '${EMPTY}'
461    ...  Run Keyword And Ignore Error
462    ...  Copy File  ${log_file_path}  ${targ_file_path}
463
464    [Return]  ${output}
465
466Start SOL Console Logging
467    [Documentation]  Start system console log to file.
468    [Arguments]  ${log_file_path}=${EMPTY}
469
470    # This keyword will first call "Stop SOL Console Logging".  Only then will
471    # it start SOL console logging.  The data returned by "Stop SOL Console
472    # Logging" will in turn be returned by this keyword.
473
474    # Description of arguments:
475    # log_file_path  The file path to which system console log data should be
476    #                written.  Note that this path is taken to be a location on
477    #                the machine where this program is running rather than on
478    #                the Open BMC system.
479
480    ${log_file_path}=  Create OS Console File Path  ${log_file_path}
481
482    ${log_output}=  Stop SOL Console Logging  ${log_file_path}
483
484    # Validate by making sure we can create the file.  Problems creating the
485    # file would not be noticed by the subsequent ssh command because we fork
486    # the command.
487    Create File  ${log_file_path}
488    ${sub_cmd_buf}=  Create OS Console Command String
489    # Routing stderr to stdout so that any startup error text will go to the
490    # output file.
491    ${cmd_buf}=  Catenate  ${sub_cmd_buf} > ${log_file_path} 2>&1 &
492    Rdpissuing  ${cmd_buf}
493    ${rc}  ${output}=  Run And Return Rc And Output  ${cmd_buf}
494    # Because we are forking this command, we essentially will never get a
495    # non-zero return code or any output.
496    Should Be Equal  ${rc}  ${0}
497
498    [Return]  ${log_output}
499
500Get Time Stamp
501    [Documentation]     Get the current time stamp data
502    ${cur_time}=    Get Current Date   result_format=%Y%m%d%H%M%S%f
503    [Return]   ${cur_time}
504
505
506Verify BMC State
507    [Documentation]   Get the BMC state and verify if the current
508    ...               BMC state is as expected.
509    [Arguments]       ${expected}
510
511    ${current}=  Get BMC State Deprecated
512    Should Contain  ${expected}   ${current}
513
514Start Journal Log
515    [Documentation]   Start capturing journal log to a file in /tmp using
516    ...               journalctl command. By default journal log is collected
517    ...               at /tmp/journal_log else user input location.
518    ...               The File is appended with datetime.
519    [Arguments]       ${file_path}=/tmp/journal_log
520
521    Open Connection And Log In
522
523    ${cur_time}=    Get Time Stamp
524    Set Global Variable   ${LOG_TIME}   ${cur_time}
525    Start Command
526    ...  journalctl -f > ${file_path}-${LOG_TIME}
527    Log    Journal Log Started: ${file_path}-${LOG_TIME}
528
529
530Stop Journal Log
531    [Documentation]   Stop journalctl process if its running.
532    ...               By default return log from /tmp/journal_log else
533    ...               user input location.
534    [Arguments]       ${file_path}=/tmp/journal_log
535
536    Open Connection And Log In
537
538    ${rc}=
539    ...  Execute Command
540    ...  ps ax | grep journalctl | grep -v grep
541    ...  return_stdout=False  return_rc=True
542
543    Return From Keyword If   '${rc}' == '${1}'
544    ...   No journal log process running
545
546    ${output}  ${stderr}=
547    ...  Execute Command   killall journalctl
548    ...  return_stderr=True
549    Should Be Empty     ${stderr}
550
551    ${journal_log}  ${stderr}=
552    ...  Execute Command
553    ...  cat ${file_path}-${LOG_TIME}
554    ...  return_stderr=True
555    Should Be Empty     ${stderr}
556
557    Log    ${journal_log}
558
559    Execute Command    rm ${file_path}-${LOG_TIME}
560
561    [Return]    ${journal_log}
562
563Mac Address To Hex String
564    [Documentation]   Converts MAC address into hex format.
565    ...               Example
566    ...               Given the following MAC: 00:01:6C:80:02:78
567    ...               This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
568    ...               Description of arguments:
569    ...               i_macaddress  MAC address in the following format
570    ...               00:01:6C:80:02:78
571    [Arguments]    ${i_macaddress}
572
573    ${mac_hex}=  Catenate  0x${i_macaddress.replace(':', ' 0x')}
574    [Return]    ${mac_hex}
575
576IP Address To Hex String
577    [Documentation]   Converts IP address into hex format.
578    ...               Example:
579    ...               Given the following IP: 10.3.164.100
580    ...               This keyword will return: 0xa 0x3 0xa4 0xa0
581    ...               Description of arguments:
582    ...               i_ipaddress  IP address in the following format
583    ...               10.10.10.10
584    [Arguments]    ${i_ipaddress}
585
586    @{ip}=  Split String  ${i_ipaddress}    .
587    ${index}=  Set Variable  ${0}
588
589    :FOR    ${item}     IN      @{ip}
590    \   ${hex}=  Convert To Hex    ${item}    prefix=0x    lowercase=yes
591    \   Set List Value    ${ip}    ${index}    ${hex}
592    \   ${index}=  Set Variable    ${index + 1}
593    ${ip_hex}=  Catenate    @{ip}
594    [Return]    ${ip_hex}
595
596BMC CPU Performance Check
597   [Documentation]   Minimal 10% of proc should be free in this instance
598
599    ${bmc_cpu_usage_output}  ${stderr}=  Execute Command  ${bmc_cpu_usage_cmd}
600    ...                   return_stderr=True
601    Should be empty  ${stderr}
602    ${bmc_cpu_percentage}=  Fetch From Left  ${bmc_cpu_usage_output}  %
603    Should be true  ${bmc_cpu_percentage} < 90
604
605BMC Mem Performance Check
606    [Documentation]   Minimal 10% of memory should be free in this instance
607
608    ${bmc_mem_free_output}  ${stderr}=   Execute Command  ${bmc_mem_free_cmd}
609    ...                   return_stderr=True
610    Should be empty  ${stderr}
611
612    ${bmc_mem_total_output}  ${stderr}=   Execute Command  ${bmc_mem_total_cmd}
613    ...                   return_stderr=True
614    Should be empty  ${stderr}
615
616    ${bmc_mem_percentage}=   Evaluate  ${bmc_mem_free_output}*100
617    ${bmc_mem_percentage}=  Evaluate
618    ...   ${bmc_mem_percentage}/${bmc_mem_total_output}
619    Should be true  ${bmc_mem_percentage} > 10
620
621BMC File System Usage Check
622    [Documentation]   Check the file system space. None should be 100% full
623    ...   except /run/initramfs/ro
624    ${bmc_fs_usage_output}  ${stderr}=   Execute Command
625    ...   ${bmc_file_system_usage_cmd}  return_stderr=True
626    Should Be Empty  ${stderr}
627    Should Be True  ${bmc_fs_usage_output}==0
628
629Check BMC CPU Performance
630    [Documentation]   Minimal 10% of proc should be free in 3 sample
631    :FOR  ${var}  IN Range  1  4
632    \     BMC CPU Performance check
633
634Check BMC Mem Performance
635    [Documentation]   Minimal 10% of memory should be free
636
637    :FOR  ${var}  IN Range  1  4
638    \     BMC Mem Performance check
639
640Check BMC File System Performance
641    [Documentation]  Check for file system usage for 4 times
642
643    :FOR  ${var}  IN Range  1  4
644    \     BMC File System Usage check
645
646Get Endpoint Paths
647    [Documentation]   Returns all url paths ending with given endpoint
648    ...               Example:
649    ...               Given the following endpoint: cpu
650    ...               This keyword will return: list of all urls ending with
651    ...               cpu -
652    ...               /org/openbmc/inventory/system/chassis/motherboard/cpu0,
653    ...               /org/openbmc/inventory/system/chassis/motherboard/cpu1
654    ...               Description of arguments:
655    ...               path       URL path for enumeration
656    ...               endpoint   string for which url path ending
657    [Arguments]   ${path}   ${endpoint}
658
659    ${resp}=   Read Properties   ${path}/enumerate   timeout=30
660    log Dictionary   ${resp}
661
662    ${list}=   Get Dictionary Keys   ${resp}
663    ${resp}=   Get Matches   ${list}   regexp=^.*[0-9a-z_].${endpoint}[0-9]*$
664    [Return]   ${resp}
665
666Check Zombie Process
667    [Documentation]    Check if any defunct process exist or not on BMC
668    ${count}  ${stderr}  ${rc}=  Execute Command  ps -o stat | grep Z | wc -l
669    ...    return_stderr=True  return_rc=True
670    Should Be True    ${count}==0
671    Should Be Empty    ${stderr}
672
673Prune Journal Log
674    [Documentation]   Prune archived journal logs.
675    [Arguments]   ${vacuum_size}=1M
676
677    # This keyword can be used to prevent the journal
678    # log from filling up the /run filesystem.
679    # This command will retain only the latest logs
680    # of the user specified size.
681
682    Open Connection And Log In
683    ${output}  ${stderr}  ${rc}=
684    ...  Execute Command
685    ...  journalctl --vacuum-size=${vacuum_size}
686    ...  return_stderr=True  return_rc=True
687
688    Should Be Equal  ${rc}  ${0}  msg=${stderr}
689    Should Contain   ${stderr}  Vacuuming done
690
691Set BMC Power Policy
692    [Documentation]   Set the given BMC power policy.
693    [arguments]   ${policy}
694
695    ${valueDict}=     create dictionary  data=${policy}
696    Write Attribute    ${HOST_SETTING}    power_policy   data=${valueDict}
697    ${currentPolicy}=  Read Attribute     ${HOST_SETTING}   power_policy
698    Should Be Equal    ${currentPolicy}   ${policy}
699
700Get System Power Policy
701    [Documentation]  Get the BMC power policy.
702    ${currentPolicy}=  Read Attribute  ${HOST_SETTING}  power_policy
703    [Return]  ${currentPolicy}
704
705Get Auto Reboot
706    [Documentation]  Returns auto reboot setting.
707    ${setting}=  Read Attribute  ${HOST_SETTING}  auto_reboot
708    [Return]  ${setting}
709
710
711Set Auto Reboot
712    [Documentation]  Set the given auto reboot setting.
713    [Arguments]  ${setting}
714    # setting  auto reboot's setting, i.e. yes or no
715
716    ${valueDict}=  Set Variable  ${setting}
717    ${data}=  Create Dictionary  data=${valueDict}
718    Write Attribute  ${HOST_SETTING}  auto_reboot  data=${data}
719    ${current_setting}=  Get Auto Reboot
720    Should Be Equal  ${current_setting}  ${setting}
721
722
723Set BMC Reset Reference Time
724    [Documentation]  Set current boot time as a reference and increment
725    ...              boot count.
726
727    ${cur_btime}=  Get BMC Boot Time
728    Run Keyword If  ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
729    ...  Set Global Variable  ${BOOT_TIME}  ${cur_btime}
730    ...  ELSE IF  ${cur_btime} > ${BOOT_TIME}
731    ...  Run Keywords  Set Global Variable  ${BOOT_TIME}  ${cur_btime}
732    ...  AND
733    ...  Set Global Variable  ${BOOT_COUNT}  ${BOOT_COUNT + 1}
734
735Get BMC Boot Time
736    [Documentation]  Get boot time from /proc/stat.
737
738    Open Connection And Log In
739    ${output}  ${stderr}=
740    ...  Execute Command  egrep '^btime ' /proc/stat | cut -f 2 -d ' '
741    ...  return_stderr=True
742    Should Be Empty  ${stderr}
743    ${btime}=  Convert To Integer  ${output}
744    [Return]  ${btime}
745
746Execute Command On BMC
747    [Documentation]  Execute given command on BMC and return output.
748    [Arguments]  ${command}
749    ${stdout}  ${stderr}=  Execute Command  ${command}  return_stderr=True
750    Should Be Empty  ${stderr}
751    [Return]  ${stdout}
752
753Enable Core Dump On BMC
754    [Documentation]  Enable core dump collection.
755    Open Connection And Log In
756    ${core_pattern}=  Execute Command On BMC
757    ...  echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
758    Should Be Equal As Strings  ${core_pattern}  /tmp/core_%e.%p
759