blob: b333aeae5c08aaf0623e610060d5b6ecf7e4c9bc [file] [log] [blame]
Chris Austenb29d2e82016-06-07 12:25:35 -05001*** Settings ***
Steven Sombar0acb3412018-01-24 09:38:42 -06002
3Documentation Utilities for Robot keywords.
4
Chris Austenb29d2e82016-06-07 12:25:35 -05005Resource ../lib/resource.txt
6Resource ../lib/rest_client.robot
George Keishing5e870cd2016-08-24 10:05:47 -05007Resource ../lib/connection_client.robot
Michael Walsh391ba9b2017-08-24 11:36:24 -05008Library String
George Keishing30c12ff2016-09-02 10:25:29 -05009Library DateTime
10Library Process
Chris Austenb29d2e82016-06-07 12:25:35 -050011Library OperatingSystem
Michael Walsha6723f22016-11-22 11:12:01 -060012Library gen_print.py
13Library gen_robot_print.py
Michael Walsh5f3f4142017-05-22 17:09:47 -050014Library gen_cmd.py
Sunil Macd110a2017-05-23 04:14:32 -050015Library gen_robot_keyword.py
Michael Walshe53e47a2017-06-30 17:03:24 -050016Library bmc_ssh_utils.py
Michael Walshfdc5ced2017-08-17 13:15:15 -050017Library utils.py
Charles Paul Hofer35816152017-10-02 11:55:11 -050018Library var_funcs.py
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050019Library SCPLibrary WITH NAME scp
Chris Austenb29d2e82016-06-07 12:25:35 -050020
21*** Variables ***
Steven Sombar0acb3412018-01-24 09:38:42 -060022
23${pflash_cmd} /usr/sbin/pflash -r /dev/stdout -P VERSION
24${SYSTEM_SHUTDOWN_TIME} ${5}
25
Michael Walsha6723f22016-11-22 11:12:01 -060026${dbuscmdBase}
George Keishing85ca05e2016-11-30 09:47:18 -060027... dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host
Michael Walsha6723f22016-11-22 11:12:01 -060028${dbuscmdGet}
George Keishing9485af92017-01-04 10:21:43 -060029... ${SETTINGS_URI}host0 org.freedesktop.DBus.Properties.Get
Steven Sombar0acb3412018-01-24 09:38:42 -060030${dbuscmdString}= string:"xyz.openbmc_project.settings.Host" string:
Michael Walsha6723f22016-11-22 11:12:01 -060031
32# Assign default value to QUIET for programs which may not define it.
33${QUIET} ${0}
Steven Sombar0acb3412018-01-24 09:38:42 -060034
Sivas SRRea85d1f2016-11-13 22:44:28 -060035${bmc_mem_free_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4
36${bmc_mem_total_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2
37${bmc_cpu_usage_cmd}= top -n 1 | grep CPU: | cut -c 7-9
Sridevi Ramesh1699d372016-12-06 00:20:22 -060038${HOST_SETTING} ${SETTINGS_URI}host0
Steven Sombar0acb3412018-01-24 09:38:42 -060039
Sivas SRR352bc162017-02-13 22:12:29 -060040# /run/initramfs/ro associate filesystem should be 100% full always
Sivas SRR5ff4d692017-11-23 02:53:52 -060041${bmc_file_system_usage_cmd}= df -h | cut -c 52-54 | grep 100 | wc -l
42${total_pnor_ro_file_system_cmd}= df -h | grep /media/pnor-ro | wc -l
43${total_bmc_ro_file_system_cmd}= df -h | grep /media/rofs | wc -l
Chris Austenb29d2e82016-06-07 12:25:35 -050044
George Keishingcce9df22017-01-24 06:19:33 -060045${BOOT_TIME} ${0}
46${BOOT_COUNT} ${0}
Sweta Potthuri025e0122017-02-21 00:42:48 -060047${count} ${0}
Sivas SRR8254db62017-02-07 09:39:46 -060048${devicetree_base} /sys/firmware/devicetree/base/model
George Keishingcce9df22017-01-24 06:19:33 -060049
George Keishingb7c9b542017-05-23 08:19:58 -050050# Initialize default debug value to 0.
51${DEBUG} ${0}
52
Steven Sombar0acb3412018-01-24 09:38:42 -060053${probe_cpu_tool_path} ${EXECDIR}/tools/ras/probe_cpus.sh
54${scom_addrs_tool_path} ${EXECDIR}/tools/ras/scom_addr_p9.sh
55${target_file_path} /root/
56
57${default_tarball} ${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz
58
Michael Walshfdc5ced2017-08-17 13:15:15 -050059# These variables are used to straddle between new and old methods of setting
60# values.
Steven Sombar0acb3412018-01-24 09:38:42 -060061${boot_prog_method} ${EMPTY}
Michael Walshfdc5ced2017-08-17 13:15:15 -050062${power_policy_setup} ${0}
63${bmc_power_policy_method} ${EMPTY}
64@{valid_power_policy_vars} RESTORE_LAST_STATE ALWAYS_POWER_ON
65... ALWAYS_POWER_OFF
66
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050067
Chris Austenb29d2e82016-06-07 12:25:35 -050068*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060069
Sivas SRRc0957412017-10-06 13:02:08 -050070Check BMC Performance
71 [Documentation] Check BMC basic CPU Mem File system performance.
72
73 Check BMC CPU Performance
74 Check BMC Mem Performance
75 Check BMC File System Performance
76
Steven Sombar0acb3412018-01-24 09:38:42 -060077
Sivas SRRd97aa9c2017-05-22 11:19:25 -050078Verify PNOR Update
79 [Documentation] Verify that the PNOR is not corrupted.
80 # Example:
81 # FFS: Flash header not found. Code: 100
82 # Error 100 opening ffs !
83
George Keishinga37682e2018-06-15 13:12:13 -050084 ${pnor_info}= BMC Execute Command ${pflash_cmd}
Sivas SRRd97aa9c2017-05-22 11:19:25 -050085 Should Not Contain Any ${pnor_info} Flash header not found Error
86
Steven Sombar0acb3412018-01-24 09:38:42 -060087
Sivas SRR8254db62017-02-07 09:39:46 -060088Get BMC System Model
Steven Sombar0acb3412018-01-24 09:38:42 -060089 [Documentation] Get the BMC model from the device tree and return it.
Sivas SRR8254db62017-02-07 09:39:46 -060090
Michael Walshe53e47a2017-06-30 17:03:24 -050091 ${bmc_model} ${stderr} ${rc}= BMC Execute Command
George Keishing90ab1772017-02-24 05:40:55 -060092 ... cat ${devicetree_base} | cut -d " " -f 1 return_stderr=True
Michael Walsh71182ab2017-10-20 14:44:25 -050093 ... test_mode=0
Sivas SRR8254db62017-02-07 09:39:46 -060094 Should Be Empty ${stderr}
Steven Sombar0acb3412018-01-24 09:38:42 -060095 Should Not Be Empty ${bmc_model} msg=BMC model is empty.
Sivas SRR8254db62017-02-07 09:39:46 -060096 [Return] ${bmc_model}
97
Steven Sombar0acb3412018-01-24 09:38:42 -060098
Sivas SRR8254db62017-02-07 09:39:46 -060099Verify BMC System Model
100 [Documentation] Verify the BMC model with ${OPENBMC_MODEL}.
101 [Arguments] ${bmc_model}
102
Steven Sombar0acb3412018-01-24 09:38:42 -0600103 # Description of argument(s):
104 # bmc_model System model (e.g. "witherspoon").
105
Sivas SRR8254db62017-02-07 09:39:46 -0600106 ${tmp_bmc_model}= Fetch From Right ${OPENBMC_MODEL} /
107 ${tmp_bmc_model}= Fetch From Left ${tmp_bmc_model} .
108 ${ret}= Run Keyword And Return Status Should Contain ${bmc_model}
109 ... ${tmp_bmc_model} ignore_case=True
110 [Return] ${ret}
111
Steven Sombar0acb3412018-01-24 09:38:42 -0600112
Chris Austenb29d2e82016-06-07 12:25:35 -0500113Wait For Host To Ping
root442f0ef2016-08-04 20:23:05 +0000114 [Arguments] ${host} ${timeout}=${OPENBMC_REBOOT_TIMEOUT}min
115 ... ${interval}=5 sec
116
Steven Sombar0acb3412018-01-24 09:38:42 -0600117 # Description of argument(s):
118 # host The host name or IP of the host to ping.
119 # timeout The amount of time after which ping attempts cease.
120 # This should be expressed in Robot Framework's time format
121 # (e.g. "10 seconds").
root442f0ef2016-08-04 20:23:05 +0000122 # interval The amount of time in between attempts to ping.
Steven Sombar0acb3412018-01-24 09:38:42 -0600123 # This should be expressed in Robot Framework's time format
124 # (e.g. "5 seconds").
root442f0ef2016-08-04 20:23:05 +0000125
126 Wait Until Keyword Succeeds ${timeout} ${interval} Ping Host ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -0500127
Steven Sombar0acb3412018-01-24 09:38:42 -0600128
Chris Austenb29d2e82016-06-07 12:25:35 -0500129Ping Host
130 [Arguments] ${host}
Steven Sombar0acb3412018-01-24 09:38:42 -0600131
132 # Description of argument(s):
133 # host The host name or IP of the host to ping.
134
George Keishing8a84f952016-08-25 04:54:53 -0500135 Should Not Be Empty ${host} msg=No host provided
Michael Walsha6723f22016-11-22 11:12:01 -0600136 ${RC} ${output}= Run and return RC and Output ping -c 4 ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -0500137 Log RC: ${RC}\nOutput:\n${output}
138 Should be equal ${RC} ${0}
139
Steven Sombar0acb3412018-01-24 09:38:42 -0600140
Chris Austenb29d2e82016-06-07 12:25:35 -0500141Get Boot Progress
Michael Walshc972d4d2017-08-16 15:38:03 -0500142 [Documentation] Get the boot progress and return it.
Michael Walsha6723f22016-11-22 11:12:01 -0600143 [Arguments] ${quiet}=${QUIET}
144
Michael Walshc972d4d2017-08-16 15:38:03 -0500145 # Description of argument(s):
146 # quiet Indicates whether this keyword should run without any output to
147 # the console.
148
149 Set Boot Progress Method
150 ${state}= Run Keyword If '${boot_prog_method}' == 'New'
151 ... New Get Boot Progress quiet=${quiet}
152 ... ELSE
153 ... Old Get Boot Progress quiet=${quiet}
154
155 [Return] ${state}
156
Steven Sombar0acb3412018-01-24 09:38:42 -0600157
Michael Walshc972d4d2017-08-16 15:38:03 -0500158Set Boot Progress Method
159 [Documentation] Set the boot_prog_method to either 'Old' or 'New'.
160
161 # The boot progress data has moved from an 'org' location to an 'xyz'
162 # location. This keyword will determine whether the new method of getting
163 # the boot progress is valid and will set the global boot_prog_method
164 # variable accordingly. If boot_prog_method is already set (either by a
165 # prior call to this function or via a -v parm), this keyword will simply
166 # return.
167
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500168 # Note: There are interim builds that contain boot_progress in both the
169 # old and the new location values. It is nearly impossible for this
170 # keyword to determine whether the old boot_progress or the new one is
171 # active. When using such builds where the old boot_progress is active,
172 # the only recourse users will have is that they may specify
173 # -v boot_prog_method:Old to force old behavior on such builds.
Michael Walshc972d4d2017-08-16 15:38:03 -0500174
175 Run Keyword If '${boot_prog_method}' != '${EMPTY}' Return From Keyword
176
177 ${new_status} ${new_value}= Run Keyword And Ignore Error
178 ... New Get Boot Progress
179 # If the new style read fails, the method must necessarily be "Old".
180 Run Keyword If '${new_status}' == 'PASS'
181 ... Run Keywords
182 ... Set Global Variable ${boot_prog_method} New AND
183 ... Rqpvars boot_prog_method AND
184 ... Return From Keyword
185
186 # Default method is "Old".
187 Set Global Variable ${boot_prog_method} Old
188 Rqpvars boot_prog_method
189
Steven Sombar0acb3412018-01-24 09:38:42 -0600190
Michael Walshc972d4d2017-08-16 15:38:03 -0500191Old Get Boot Progress
192 [Documentation] Get the boot progress the old way (via org location).
193 [Arguments] ${quiet}=${QUIET}
194
195 # Description of argument(s):
196 # quiet Indicates whether this keyword should run without any output to
197 # the console.
198
George Keishing85ca05e2016-11-30 09:47:18 -0600199 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
Michael Walsha6723f22016-11-22 11:12:01 -0600200 ... value quiet=${quiet}
Michael Walshc972d4d2017-08-16 15:38:03 -0500201
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600202 [Return] ${state}
Chris Austenb29d2e82016-06-07 12:25:35 -0500203
Steven Sombar0acb3412018-01-24 09:38:42 -0600204
Michael Walshc972d4d2017-08-16 15:38:03 -0500205New Get Boot Progress
206 [Documentation] Get the boot progress the new way (via xyz location).
207 [Arguments] ${quiet}=${QUIET}
208
209 # Description of argument(s):
210 # quiet Indicates whether this keyword should run without any output to
211 # the console.
212
213 ${state}= Read Attribute ${HOST_STATE_URI} BootProgress quiet=${quiet}
214
215 [Return] ${state.rsplit('.', 1)[1]}
216
Steven Sombar0acb3412018-01-24 09:38:42 -0600217
Chris Austenb29d2e82016-06-07 12:25:35 -0500218Is Power On
root442f0ef2016-08-04 20:23:05 +0000219 ${state}= Get Power State
220 Should be equal ${state} ${1}
Chris Austenb29d2e82016-06-07 12:25:35 -0500221
Steven Sombar0acb3412018-01-24 09:38:42 -0600222
Chris Austenb29d2e82016-06-07 12:25:35 -0500223Is Power Off
root442f0ef2016-08-04 20:23:05 +0000224 ${state}= Get Power State
225 Should be equal ${state} ${0}
Chris Austenb29d2e82016-06-07 12:25:35 -0500226
Steven Sombar0acb3412018-01-24 09:38:42 -0600227
root442f0ef2016-08-04 20:23:05 +0000228Initiate Power On
229 [Documentation] Initiates the power on and waits until the Is Power On
230 ... keyword returns that the power state has switched to on.
Michael Walsha6723f22016-11-22 11:12:01 -0600231 [Arguments] ${wait}=${1}
232
Steven Sombar0acb3412018-01-24 09:38:42 -0600233 # Description of argument(s):
234 # wait Indicates whether to wait for a powered on state after issuing
235 # the power on command.
236
Chris Austenb29d2e82016-06-07 12:25:35 -0500237 @{arglist}= Create List
238 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600239 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
Michael Walsha6723f22016-11-22 11:12:01 -0600240 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500241 should be equal as strings ${resp.status_code} ${HTTP_OK}
Chris Austenb29d2e82016-06-07 12:25:35 -0500242
Michael Walsha6723f22016-11-22 11:12:01 -0600243 # Does caller want to wait for power on status?
244 Run Keyword If '${wait}' == '${0}' Return From Keyword
245 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500246
Steven Sombar0acb3412018-01-24 09:38:42 -0600247
root442f0ef2016-08-04 20:23:05 +0000248Initiate Power Off
249 [Documentation] Initiates the power off and waits until the Is Power Off
250 ... keyword returns that the power state has switched to off.
Steven Sombar0acb3412018-01-24 09:38:42 -0600251
Chris Austenb29d2e82016-06-07 12:25:35 -0500252 @{arglist}= Create List
253 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600254 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
Michael Walsha6723f22016-11-22 11:12:01 -0600255 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500256 should be equal as strings ${resp.status_code} ${HTTP_OK}
Michael Walsha6723f22016-11-22 11:12:01 -0600257 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
Chris Austenb29d2e82016-06-07 12:25:35 -0500258
Steven Sombar0acb3412018-01-24 09:38:42 -0600259
Michael Walsh81843772017-03-02 14:44:44 -0600260Initiate OS Host Power Off
261 [Documentation] Initiate an OS reboot.
262 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walshdfc75372018-01-11 11:47:25 -0600263 ... ${os_password}=${OS_PASSWORD} ${hard}=${0}
Michael Walsh81843772017-03-02 14:44:44 -0600264
Michael Walshdfc75372018-01-11 11:47:25 -0600265 # Description of argument(s):
Michael Walsh81843772017-03-02 14:44:44 -0600266 # os_host The DNS name or IP of the OS.
267 # os_username The username to be used to sign in to the OS.
268 # os_password The password to be used to sign in to the OS.
Michael Walshdfc75372018-01-11 11:47:25 -0600269 # hard Indicates whether to do a hard vs. soft power off.
270
271 ${time_string}= Run Keyword If ${hard} Set Variable ${SPACE}now
272 ... ELSE Set Variable ${EMPTY}
Michael Walsh81843772017-03-02 14:44:44 -0600273
Michael Walsh4549cd12017-09-07 18:02:36 -0500274 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
Michael Walshdfc75372018-01-11 11:47:25 -0600275 ... Set Variable shutdown${time_string}
Michael Walsh4549cd12017-09-07 18:02:36 -0500276 ... ELSE
Michael Walshdfc75372018-01-11 11:47:25 -0600277 ... Set Variable echo ${os_password} | sudo -S shutdown${time_string}
Michael Walsh4549cd12017-09-07 18:02:36 -0500278
279 ${output} ${stderr} ${rc}= OS Execute Command
280 ... ${cmd_buf} fork=${1}
Michael Walsh81843772017-03-02 14:44:44 -0600281
Steven Sombar0acb3412018-01-24 09:38:42 -0600282
Michael Walsh81843772017-03-02 14:44:44 -0600283Initiate OS Host Reboot
284 [Documentation] Initiate an OS reboot.
285 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
286 ... ${os_password}=${OS_PASSWORD}
287
Michael Walshf1a59fb2017-09-01 17:07:13 -0500288 # Description of argument(s):
289 # os_host The host name or IP address of the OS.
Michael Walsh81843772017-03-02 14:44:44 -0600290 # os_username The username to be used to sign in to the OS.
291 # os_password The password to be used to sign in to the OS.
292
Michael Walshf1a59fb2017-09-01 17:07:13 -0500293 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
294 ... Set Variable reboot
295 ... ELSE
296 ... Set Variable echo ${os_password} | sudo -S reboot
297
298 ${output} ${stderr} ${rc}= OS Execute Command
299 ... ${cmd_buf} fork=${1}
Michael Walsh81843772017-03-02 14:44:44 -0600300
Steven Sombar0acb3412018-01-24 09:38:42 -0600301
Michael Walsh81843772017-03-02 14:44:44 -0600302Initiate Auto Reboot
303 [Documentation] Initiate an auto reboot.
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500304 [Arguments] ${milliseconds}=5000
305
306 # Description of argument(s):
307 # milliseconds The number of milliseconds for the watchdog timer.
Michael Walsh81843772017-03-02 14:44:44 -0600308
309 # Set the auto reboot policy.
Sweta Potthuri62a23572017-07-28 04:05:13 -0500310 Set Auto Reboot ${1}
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500311 # Set the watchdog timer.
312 Trigger Host Watchdog Error ${milliseconds}
Michael Walsh81843772017-03-02 14:44:44 -0600313
Steven Sombar0acb3412018-01-24 09:38:42 -0600314
Chris Austenb29d2e82016-06-07 12:25:35 -0500315Trigger Warm Reset
Steven Sombar0acb3412018-01-24 09:38:42 -0600316 [Documentation] Initiate a warm reset.
317
Chris Austenb29d2e82016-06-07 12:25:35 -0500318 log to console "Triggering warm reset"
Michael Walsha6723f22016-11-22 11:12:01 -0600319 ${data}= create dictionary data=@{EMPTY}
George Keishing85ca05e2016-11-30 09:47:18 -0600320 ${resp}= openbmc post request
321 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
Chris Austenb29d2e82016-06-07 12:25:35 -0500322 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
George Keishingb3700812016-08-31 03:03:30 -0500323 ${session_active}= Check If warmReset is Initiated
324 Run Keyword If '${session_active}' == '${True}'
325 ... Fail msg=warm reset didn't occur
326
Chris Austenb29d2e82016-06-07 12:25:35 -0500327 Sleep ${SYSTEM_SHUTDOWN_TIME}min
Rahul Maheshwari5f253c42017-01-30 05:19:51 -0600328 Check If BMC Is Up
Michael Walsh49ab0f42016-07-20 11:44:33 -0500329
Steven Sombar0acb3412018-01-24 09:38:42 -0600330
Michael Walsh49ab0f42016-07-20 11:44:33 -0500331Check OS
root442f0ef2016-08-04 20:23:05 +0000332 [Documentation] Attempts to ping the host OS and then checks that the host
333 ... OS is up by running an SSH command.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500334
335 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walsha6723f22016-11-22 11:12:01 -0600336 ... ${os_password}=${OS_PASSWORD} ${quiet}=${QUIET}
337 ... ${print_string}=${EMPTY}
Michael Walshac275512017-03-07 11:39:28 -0600338 [Teardown] SSHLibrary.Close Connection
Michael Walsh49ab0f42016-07-20 11:44:33 -0500339
Steven Sombar0acb3412018-01-24 09:38:42 -0600340 # Description of argument(s):
Michael Walsh49ab0f42016-07-20 11:44:33 -0500341 # os_host The DNS name/IP of the OS host associated with our BMC.
342 # os_username The username to be used to sign on to the OS host.
343 # os_password The password to be used to sign on to the OS host.
Michael Walsha6723f22016-11-22 11:12:01 -0600344 # quiet Indicates whether this keyword should write to console.
345 # print_string A string to be printed before checking the OS.
346
347 rprint ${print_string}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500348
root442f0ef2016-08-04 20:23:05 +0000349 # Attempt to ping the OS. Store the return code to check later.
350 ${ping_rc}= Run Keyword and Return Status Ping Host ${os_host}
351
Michael Walshac275512017-03-07 11:39:28 -0600352 SSHLibrary.Open connection ${os_host}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500353
Michael Walsha6723f22016-11-22 11:12:01 -0600354 ${status} ${msg}= Run Keyword And Ignore Error Login ${os_username}
355 ... ${os_password}
356 ${err_msg1}= Sprint Error ${msg}
357 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
358 Run Keyword If '${status}' == 'FAIL' Fail msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500359 ${output} ${stderr} ${rc}= Execute Command uptime return_stderr=True
360 ... return_rc=True
361
Michael Walsha6723f22016-11-22 11:12:01 -0600362 ${temp_msg}= Catenate Could not execute a command on the operating
363 ... system.\n
364 ${err_msg1}= Sprint Error ${temp_msg}
365 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
366
367 # If the return code returned by "Execute Command" is non-zero, this
368 # keyword will fail.
369 Should Be Equal ${rc} ${0} msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500370 # We will likewise fail if there is any stderr data.
371 Should Be Empty ${stderr}
372
Michael Walsha6723f22016-11-22 11:12:01 -0600373 ${temp_msg}= Set Variable Could not ping the operating system.\n
374 ${err_msg1}= Sprint Error ${temp_msg}
375 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
376 # We will likewise fail if the OS did not ping, as we could SSH but not
377 # ping
378 Should Be Equal As Strings ${ping_rc} ${TRUE} msg=${err_msg}
root442f0ef2016-08-04 20:23:05 +0000379
Steven Sombar0acb3412018-01-24 09:38:42 -0600380
Michael Walsh49ab0f42016-07-20 11:44:33 -0500381Wait for OS
382 [Documentation] Waits for the host OS to come up via calls to "Check OS".
383 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
384 ... ${os_password}=${OS_PASSWORD} ${timeout}=${OS_WAIT_TIMEOUT}
Michael Walsha6723f22016-11-22 11:12:01 -0600385 ... ${quiet}=${0}
386 [Teardown] rprintn
Michael Walsh49ab0f42016-07-20 11:44:33 -0500387
Steven Sombar0acb3412018-01-24 09:38:42 -0600388 # Description of argument(s):
Michael Walsh49ab0f42016-07-20 11:44:33 -0500389 # os_host The DNS name or IP of the OS host associated with our
390 # BMC.
391 # os_username The username to be used to sign on to the OS host.
392 # os_password The password to be used to sign on to the OS host.
393 # timeout The timeout in seconds indicating how long you're
394 # willing to wait for the OS to respond.
Michael Walsha6723f22016-11-22 11:12:01 -0600395 # quiet Indicates whether this keyword should write to console.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500396
397 # The interval to be used between calls to "Check OS".
398 ${interval}= Set Variable 5
399
Michael Walsha6723f22016-11-22 11:12:01 -0600400 ${message}= Catenate Checking every ${interval} seconds for up to
401 ... ${timeout} seconds for the operating system to communicate.
402 rqprint_timen ${message}
403
Michael Walsh49ab0f42016-07-20 11:44:33 -0500404 Wait Until Keyword Succeeds ${timeout} sec ${interval} Check OS
405 ... ${os_host} ${os_username} ${os_password}
Michael Walsha6723f22016-11-22 11:12:01 -0600406 ... print_string=\#
407
408 rqprintn
409
410 rqprint_timen The operating system is now communicating.
root442f0ef2016-08-04 20:23:05 +0000411
root442f0ef2016-08-04 20:23:05 +0000412
413Get Power State
414 [Documentation] Returns the power state as an integer. Either 0 or 1.
Michael Walsha6723f22016-11-22 11:12:01 -0600415 [Arguments] ${quiet}=${QUIET}
416
Steven Sombar0acb3412018-01-24 09:38:42 -0600417 # Description of argument(s):
418 # quiet Indicates whether this keyword should run without any output to
419 # the console.
420
root442f0ef2016-08-04 20:23:05 +0000421 @{arglist}= Create List
422 ${args}= Create Dictionary data=@{arglist}
Michael Walsha6723f22016-11-22 11:12:01 -0600423
George Keishing85ca05e2016-11-30 09:47:18 -0600424 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
Michael Walsha6723f22016-11-22 11:12:01 -0600425 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000426 Should be equal as strings ${resp.status_code} ${HTTP_OK}
427 ${content}= to json ${resp.content}
Steven Sombar0acb3412018-01-24 09:38:42 -0600428
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600429 [Return] ${content["data"]}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500430
George Keishinga8d68e22017-12-18 09:30:30 -0600431
432Clear BMC Gard Record
433 [Documentation] Clear gard records from the system.
434
435 @{arglist}= Create List
436 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600437 ${resp}= Call Method
George Keishinga8d68e22017-12-18 09:30:30 -0600438 ... ${OPENPOWER_CONTROL}gard Reset data=${args}
439 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
440
Jay Azurine4c52eb2016-08-16 20:51:10 -0500441
442Copy PNOR to BMC
443 Import Library SCPLibrary WITH NAME scp
444 Open Connection for SCP
445 Log Copying ${PNOR_IMAGE_PATH} to /tmp
446 scp.Put File ${PNOR_IMAGE_PATH} /tmp
447
Steven Sombar0acb3412018-01-24 09:38:42 -0600448
Jay Azurine4c52eb2016-08-16 20:51:10 -0500449Flash PNOR
450 [Documentation] Calls flash bios update method to flash PNOR image
Gunnar Mills38032802016-12-12 13:43:40 -0600451 [Arguments] ${pnor_image}
Steven Sombar0acb3412018-01-24 09:38:42 -0600452
453 # Description of argument(s):
454 # pnor_image The filename and path of the PNOR image
455 # (e.g. "/home/image/zaius.pnor").
456
Jay Azurine4c52eb2016-08-16 20:51:10 -0500457 @{arglist}= Create List ${pnor_image}
458 ${args}= Create Dictionary data=@{arglist}
George Keishinge24fdbc2017-10-31 13:41:35 -0500459 ${resp}= Call Method /org/openbmc/control/flash/bios/ update
Michael Walsha6723f22016-11-22 11:12:01 -0600460 ... data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500461 should be equal as strings ${resp.status_code} ${HTTP_OK}
462 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
463
Steven Sombar0acb3412018-01-24 09:38:42 -0600464
Jay Azurine4c52eb2016-08-16 20:51:10 -0500465Get Flash BIOS Status
466 [Documentation] Returns the status of the flash BIOS API as a string. For
467 ... example 'Flashing', 'Flash Done', etc
George Keishinge24fdbc2017-10-31 13:41:35 -0500468 ${data}= Read Properties /org/openbmc/control/flash/bios
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600469 [Return] ${data['status']}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500470
Steven Sombar0acb3412018-01-24 09:38:42 -0600471
Jay Azurine4c52eb2016-08-16 20:51:10 -0500472Is PNOR Flashing
473 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
474 ... flashing has started.
475 ${status}= Get Flash BIOS Status
Rahul Maheshwari449dfb72017-05-08 02:06:48 -0500476 Should Contain ${status} Flashing
Jay Azurine4c52eb2016-08-16 20:51:10 -0500477
Steven Sombar0acb3412018-01-24 09:38:42 -0600478
Jay Azurine4c52eb2016-08-16 20:51:10 -0500479Is PNOR Flash Done
480 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
481 ... PNOR flashing has completed.
Leah McNutt9ba32272016-11-17 15:48:39 +0000482 ${status}= Get Flash BIOS Status
Jay Azurine4c52eb2016-08-16 20:51:10 -0500483 should be equal as strings ${status} Flash Done
484
George Keishing5e870cd2016-08-24 10:05:47 -0500485
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600486Is OS Starting
487 [Documentation] Check if boot progress is OS starting.
488 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500489 Should Be Equal ${boot_progress} OSStart
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600490
Steven Sombar0acb3412018-01-24 09:38:42 -0600491
George Keishing0af24412017-03-10 13:33:23 -0600492Is OS Off
493 [Documentation] Check if boot progress is "Off".
494 ${boot_progress}= Get Boot Progress
495 Should Be Equal ${boot_progress} Off
496
Steven Sombar0acb3412018-01-24 09:38:42 -0600497
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500498Get Boot Progress To OS Starting State
499 [Documentation] Get the system to a boot progress state of 'FW Progress,
500 ... Starting OS'.
501
502 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500503 Run Keyword If '${boot_progress}' == 'OSStart'
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500504 ... Log Host is already in OS starting state
505 ... ELSE
506 ... Run Keywords Initiate Host PowerOff AND Initiate Host Boot
507 ... AND Wait Until Keyword Succeeds 10 min 10 sec Is OS Starting
508
Steven Sombar0acb3412018-01-24 09:38:42 -0600509
George Keishing5e870cd2016-08-24 10:05:47 -0500510Verify Ping and REST Authentication
Michael Walsha6723f22016-11-22 11:12:01 -0600511 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500512 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -0500513 Run Keyword If '${l_ping}' == '${False}'
514 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500515
Michael Walsha6723f22016-11-22 11:12:01 -0600516 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500517 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -0500518 Run Keyword If '${l_rest}' == '${False}'
519 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500520
521 # Just to make sure the SSH is working for SCP
522 Open Connection And Log In
523 ${system} ${stderr}= Execute Command hostname return_stderr=True
524 Should Be Empty ${stderr}
525
Steven Sombar0acb3412018-01-24 09:38:42 -0600526
George Keishingc4d3dc02016-09-19 03:45:55 -0500527Check If BMC is Up
528 [Documentation] Wait for Host to be online. Checks every X seconds
529 ... interval for Y minutes and fails if timed out.
530 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -0600531 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -0500532 ... ${interval}=10 sec
533
Steven Sombar0acb3412018-01-24 09:38:42 -0600534 # Description of argument(s):
535 # max_timeout Maximum time to wait.
536 # This should be expressed in Robot Framework's time format
537 # (e.g. "10 minutes").
538 # interfal Interval to wait between status checks.
539 # This should be expressed in Robot Framework's time format
540 # (e.g. "5 seconds").
541
George Keishingc4d3dc02016-09-19 03:45:55 -0500542 Wait Until Keyword Succeeds
543 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
544
George Keishingb3700812016-08-31 03:03:30 -0500545
546Check If warmReset is Initiated
547 [Documentation] Ping would be still alive, so try SSH to connect
548 ... if fails the ports are down indicating reboot
549 ... is in progress
George Keishing3c05d352016-12-13 06:54:50 -0600550
551 # Warm reset adds 3 seconds delay before forcing reboot
552 # To minimize race conditions, we wait for 7 seconds
553 Sleep 7s
George Keishingb3700812016-08-31 03:03:30 -0500554 ${alive}= Run Keyword and Return Status
555 ... Open Connection And Log In
556 Return From Keyword If '${alive}' == '${False}' ${False}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600557 [Return] ${True}
George Keishingb3700812016-08-31 03:03:30 -0500558
Steven Sombar0acb3412018-01-24 09:38:42 -0600559
George Keishing06ae4aa2016-08-30 01:41:28 -0500560Flush REST Sessions
561 [Documentation] Removes all the active session objects
562 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500563
Steven Sombar0acb3412018-01-24 09:38:42 -0600564
Sivas SRRe1143ae2016-08-26 22:31:02 -0500565Initialize DBUS cmd
566 [Documentation] Initialize dbus string with property string to extract
Gunnar Mills38032802016-12-12 13:43:40 -0600567 [Arguments] ${boot_property}
Steven Sombar0acb3412018-01-24 09:38:42 -0600568
569 # Description of argument(s):
570 # boot_property Property string.
571
Michael Walsha6723f22016-11-22 11:12:01 -0600572 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
573 ${cmd}= Catenate ${cmd}${boot_property}
Sivas SRRe1143ae2016-08-26 22:31:02 -0500574 Set Global Variable ${dbuscmd} ${cmd}
575
Steven Sombar0acb3412018-01-24 09:38:42 -0600576
David Shawba2d2c22017-01-23 16:56:38 -0600577Create OS Console File Path
578 [Documentation] Create OS console file path name and return it.
579 [Arguments] ${log_file_path}=${EMPTY}
George Keishing30c12ff2016-09-02 10:25:29 -0500580
Gunnar Mills28e403b2017-10-25 16:16:38 -0500581 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600582 # file_path The caller's candidate value. If this value is ${EMPTY}, this
583 # keyword will compose a file path name. Otherwise, this
584 # keyword will use the caller's file_path value. In either
585 # case, the value will be returned.
Gunnar Mills9c760342016-12-08 10:12:06 -0600586
George Keishing3deb7d12017-09-14 07:50:00 -0500587 ${default_file_path}= Catenate /tmp/${OPENBMC_HOST}_os_console.txt
David Shawba2d2c22017-01-23 16:56:38 -0600588 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
589 ... ${default_file_path} ${log_file_path}
Michael Walsh01bd3682017-01-10 11:21:05 -0600590
David Shawba2d2c22017-01-23 16:56:38 -0600591 [Return] ${log_file_path}
Gunnar Mills9c760342016-12-08 10:12:06 -0600592
Steven Sombar0acb3412018-01-24 09:38:42 -0600593
David Shawba2d2c22017-01-23 16:56:38 -0600594Create OS Console Command String
595 [Documentation] Return a command string to start OS console logging.
Gunnar Mills9c760342016-12-08 10:12:06 -0600596
David Shawba2d2c22017-01-23 16:56:38 -0600597 # First make sure that the ssh_pw program is available.
Steven Sombar0acb3412018-01-24 09:38:42 -0600598 ${cmd}= Catenate which ssh_pw 2>/dev/null || find
599 ... ${EXECDIR} -name 'ssh_pw'
600
601 Rdpissuing ${cmd}
602 ${rc} ${output}= Run And Return Rc And Output ${cmd}
David Shawba2d2c22017-01-23 16:56:38 -0600603 Rdpvars rc output
Gunnar Mills9c760342016-12-08 10:12:06 -0600604
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500605 Should Be Equal As Integers 0 ${rc} msg=Could not find ssh_pw.
606
607 ${ssh_pw_file_path}= Set Variable ${output}
George Keishingb45d9522017-06-29 04:20:59 -0500608
Steven Sombar0acb3412018-01-24 09:38:42 -0600609 ${cmd}= Catenate ${ssh_pw_file_path} ${OPENBMC_PASSWORD} -p 2200
George Keishing1f9ec7f2017-06-06 08:59:19 -0500610 ... -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST}
George Keishing30c12ff2016-09-02 10:25:29 -0500611
Steven Sombar0acb3412018-01-24 09:38:42 -0600612 [Return] ${cmd}
613
George Keishing30c12ff2016-09-02 10:25:29 -0500614
Michael Walshcadf1342017-08-28 13:49:25 -0500615Get SOL Console Pid
Michael Walsh70419172017-12-06 14:20:52 -0600616 [Documentation] Get the pid of the active SOL console job.
617 [Arguments] ${expect_running}=${0}
618
619 # Description of argument(s):
620 # expect_running If set and if no SOL console job is found, print debug
621 # info and fail.
Michael Walshcadf1342017-08-28 13:49:25 -0500622
623 # Find the pid of the active system console logging session (if any).
624 ${search_string}= Create OS Console Command String
625 # At least in some cases, ps output does not show double quotes so we must
626 # replace them in our search string with the regexes to indicate that they
627 # are optional.
628 ${search_string}= Replace String ${search_string} " ["]?
Michael Walsh70419172017-12-06 14:20:52 -0600629 ${ps_cmd}= Catenate ps axwwo user,pid,cmd
630 ${cmd_buf}= Catenate echo $(${ps_cmd} | egrep '${search_string}' |
631 ... egrep -v grep | cut -c10-14)
Michael Walshcadf1342017-08-28 13:49:25 -0500632 Rdpissuing ${cmd_buf}
633 ${rc} ${os_con_pid}= Run And Return Rc And Output ${cmd_buf}
634 Rdpvars os_con_pid
635 # If rc is not zero it just means that there is no OS Console process
636 # running.
637
Michael Walsh70419172017-12-06 14:20:52 -0600638 Return From Keyword If '${os_con_pid}' != '${EMPTY}' ${os_con_pid}
639 Return From Keyword If '${expect_running}' == '${0}' ${os_con_pid}
640
641 Cmd Fnc cat ${log_file_path} ; echo ; ${ps_cmd} quiet=${0}
642 ... print_output=${1} show_err=${1}
643
644 Should Not Be Empty ${os_con_pid}
Michael Walshcadf1342017-08-28 13:49:25 -0500645
646
George Keishing30c12ff2016-09-02 10:25:29 -0500647Stop SOL Console Logging
David Shawba2d2c22017-01-23 16:56:38 -0600648 [Documentation] Stop system console logging and return log output.
George Keishing72992e42017-06-16 06:42:36 -0500649 [Arguments] ${log_file_path}=${EMPTY}
650 ... ${targ_file_path}=${EXECDIR}${/}logs${/}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500651 ... ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600652
653 # If there are muliple system console processes, they will all be stopped.
654 # If there is no existing log file this keyword will return an error
655 # message to that effect (and write that message to targ_file_path, if
656 # specified).
657 # NOTE: This keyword will not fail if there is no running system console
658 # process.
Michael Walsh01bd3682017-01-10 11:21:05 -0600659
660 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600661 # log_file_path The file path that was used to call "Start SOL
662 # Console Logging". See that keyword (above) for details.
663 # targ_file_path If specified, the file path to which the source
664 # file path (i.e. "log_file_path") should be copied.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500665 # return_data If this is set to ${1}, this keyword will return the SOL
666 # data to the caller as a unicode string.
George Keishing30c12ff2016-09-02 10:25:29 -0500667
David Shawba2d2c22017-01-23 16:56:38 -0600668 ${log_file_path}= Create OS Console File Path ${log_file_path}
Michael Walshcadf1342017-08-28 13:49:25 -0500669
670 ${os_con_pid}= Get SOL Console Pid
George Keishing30c12ff2016-09-02 10:25:29 -0500671
David Shawba2d2c22017-01-23 16:56:38 -0600672 ${cmd_buf}= Catenate kill -9 ${os_con_pid}
673 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpissuing ${cmd_buf}
674 ${rc} ${output}= Run Keyword If '${os_con_pid}' != '${EMPTY}'
675 ... Run And Return Rc And Output ${cmd_buf}
676 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpvars rc output
George Keishing30c12ff2016-09-02 10:25:29 -0500677
Michael Walsh01bd3682017-01-10 11:21:05 -0600678 Run Keyword If '${targ_file_path}' != '${EMPTY}'
David Shawba2d2c22017-01-23 16:56:38 -0600679 ... Run Keyword And Ignore Error
680 ... Copy File ${log_file_path} ${targ_file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500681
Michael Walsh5f3f4142017-05-22 17:09:47 -0500682 ${output}= Set Variable ${EMPTY}
683 ${loc_quiet}= Evaluate ${debug}^1
684 ${rc} ${output}= Run Keyword If '${return_data}' == '${1}'
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500685 ... Cmd Fnc cat ${log_file_path} 2>/dev/null quiet=${loc_quiet}
686 ... print_output=${0} show_err=${0}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500687
David Shawba2d2c22017-01-23 16:56:38 -0600688 [Return] ${output}
689
Steven Sombar0acb3412018-01-24 09:38:42 -0600690
David Shawba2d2c22017-01-23 16:56:38 -0600691Start SOL Console Logging
692 [Documentation] Start system console log to file.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500693 [Arguments] ${log_file_path}=${EMPTY} ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600694
695 # This keyword will first call "Stop SOL Console Logging". Only then will
696 # it start SOL console logging. The data returned by "Stop SOL Console
697 # Logging" will in turn be returned by this keyword.
698
699 # Description of arguments:
Michael Walsh5f3f4142017-05-22 17:09:47 -0500700 # log_file_path The file path to which system console log data should be
701 # written. Note that this path is taken to be a location
702 # on the machine where this program is running rather than
703 # on the Open BMC system.
704 # return_data If this is set to ${1}, this keyword will return any SOL
705 # data to the caller as a unicode string.
David Shawba2d2c22017-01-23 16:56:38 -0600706
707 ${log_file_path}= Create OS Console File Path ${log_file_path}
708
709 ${log_output}= Stop SOL Console Logging ${log_file_path}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500710 ... return_data=${return_data}
David Shawba2d2c22017-01-23 16:56:38 -0600711
712 # Validate by making sure we can create the file. Problems creating the
713 # file would not be noticed by the subsequent ssh command because we fork
714 # the command.
715 Create File ${log_file_path}
716 ${sub_cmd_buf}= Create OS Console Command String
717 # Routing stderr to stdout so that any startup error text will go to the
718 # output file.
George Keishing8c3c1df2017-09-13 13:50:20 -0500719 # TODO: Doesn't work with tox so reverting temporarily.
Michael Walsh460042e2017-09-05 16:55:49 -0500720 # nohup detaches the process completely from our pty.
George Keishing8c3c1df2017-09-13 13:50:20 -0500721 #${cmd_buf}= Catenate nohup ${sub_cmd_buf} &> ${log_file_path} &
722 ${cmd_buf}= Catenate ${sub_cmd_buf} > ${log_file_path} 2>&1 &
David Shawba2d2c22017-01-23 16:56:38 -0600723 Rdpissuing ${cmd_buf}
724 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
725 # Because we are forking this command, we essentially will never get a
726 # non-zero return code or any output.
727 Should Be Equal ${rc} ${0}
728
Michael Walsh70419172017-12-06 14:20:52 -0600729 Wait Until Keyword Succeeds 10 seconds 0 seconds
730 ... Get SOL Console Pid ${1}
Michael Walshcadf1342017-08-28 13:49:25 -0500731
David Shawba2d2c22017-01-23 16:56:38 -0600732 [Return] ${log_output}
George Keishing30c12ff2016-09-02 10:25:29 -0500733
Michael Walsh70419172017-12-06 14:20:52 -0600734
George Keishing30c12ff2016-09-02 10:25:29 -0500735Get Time Stamp
736 [Documentation] Get the current time stamp data
737 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500738 [Return] ${cur_time}
George Keishing30c12ff2016-09-02 10:25:29 -0500739
George Keishing1b150202016-09-29 08:51:58 -0500740
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500741Start Journal Log
742 [Documentation] Start capturing journal log to a file in /tmp using
743 ... journalctl command. By default journal log is collected
744 ... at /tmp/journal_log else user input location.
745 ... The File is appended with datetime.
746 [Arguments] ${file_path}=/tmp/journal_log
747
Steven Sombar0acb3412018-01-24 09:38:42 -0600748 # Description of arguments:
749 # file_path The file path of the journal file.
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500750
751 ${cur_time}= Get Time Stamp
752 Set Global Variable ${LOG_TIME} ${cur_time}
753 Start Command
754 ... journalctl -f > ${file_path}-${LOG_TIME}
755 Log Journal Log Started: ${file_path}-${LOG_TIME}
756
David Shawba2d2c22017-01-23 16:56:38 -0600757
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500758Stop Journal Log
759 [Documentation] Stop journalctl process if its running.
760 ... By default return log from /tmp/journal_log else
761 ... user input location.
762 [Arguments] ${file_path}=/tmp/journal_log
763
Steven Sombar0acb3412018-01-24 09:38:42 -0600764 # Description of arguments:
765 # file_path The file path of the journal file.
766
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500767 Open Connection And Log In
768
769 ${rc}=
770 ... Execute Command
771 ... ps ax | grep journalctl | grep -v grep
772 ... return_stdout=False return_rc=True
773
774 Return From Keyword If '${rc}' == '${1}'
775 ... No journal log process running
776
777 ${output} ${stderr}=
778 ... Execute Command killall journalctl
779 ... return_stderr=True
780 Should Be Empty ${stderr}
781
782 ${journal_log} ${stderr}=
783 ... Execute Command
784 ... cat ${file_path}-${LOG_TIME}
785 ... return_stderr=True
786 Should Be Empty ${stderr}
787
788 Log ${journal_log}
789
790 Execute Command rm ${file_path}-${LOG_TIME}
791
792 [Return] ${journal_log}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500793
Steven Sombar0acb3412018-01-24 09:38:42 -0600794
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500795Mac Address To Hex String
796 [Documentation] Converts MAC address into hex format.
797 ... Example
798 ... Given the following MAC: 00:01:6C:80:02:78
799 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
800 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600801 ... i_macaddress MAC address in the following format
802 ... 00:01:6C:80:02:78
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500803 [Arguments] ${i_macaddress}
804
Steven Sombar0acb3412018-01-24 09:38:42 -0600805 # Description of arguments:
806 # i_macaddress The MAC address.
807
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500808 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600809 [Return] ${mac_hex}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500810
Steven Sombar0acb3412018-01-24 09:38:42 -0600811
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500812IP Address To Hex String
813 [Documentation] Converts IP address into hex format.
814 ... Example:
815 ... Given the following IP: 10.3.164.100
816 ... This keyword will return: 0xa 0x3 0xa4 0xa0
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500817 [Arguments] ${i_ipaddress}
818
Steven Sombar0acb3412018-01-24 09:38:42 -0600819 # Description of arguments:
820 # i_macaddress The IP address in the format 10.10.10.10.
821
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500822 @{ip}= Split String ${i_ipaddress} .
823 ${index}= Set Variable ${0}
824
825 :FOR ${item} IN @{ip}
826 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes
827 \ Set List Value ${ip} ${index} ${hex}
828 \ ${index}= Set Variable ${index + 1}
829 ${ip_hex}= Catenate @{ip}
Steven Sombar0acb3412018-01-24 09:38:42 -0600830
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600831 [Return] ${ip_hex}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600832
Steven Sombar0acb3412018-01-24 09:38:42 -0600833
Sivas SRRea85d1f2016-11-13 22:44:28 -0600834BMC CPU Performance Check
835 [Documentation] Minimal 10% of proc should be free in this instance
836
Sivas SRRa13eb202017-11-03 10:01:56 -0500837 ${bmc_cpu_usage_output} ${stderr} ${rc}= BMC Execute Command
838 ... ${bmc_cpu_usage_cmd}
Sivas SRR5ff4d692017-11-23 02:53:52 -0600839 ${bmc_cpu_usage_output} ${stderr} ${rc}= BMC Execute Command
840 ... ${bmc_cpu_usage_cmd}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600841 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} %
842 Should be true ${bmc_cpu_percentage} < 90
843
Steven Sombar0acb3412018-01-24 09:38:42 -0600844
Sivas SRRea85d1f2016-11-13 22:44:28 -0600845BMC Mem Performance Check
846 [Documentation] Minimal 10% of memory should be free in this instance
847
Sivas SRRa13eb202017-11-03 10:01:56 -0500848 ${bmc_mem_free_output} ${stderr} ${rc}= BMC Execute Command
849 ... ${bmc_mem_free_cmd}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600850
Sivas SRRa13eb202017-11-03 10:01:56 -0500851 ${bmc_mem_total_output} ${stderr} ${rc}= BMC Execute Command
852 ... ${bmc_mem_total_cmd}
Sivas SRR5ff4d692017-11-23 02:53:52 -0600853 ${bmc_mem_free_output} ${stderr} ${rc}= BMC Execute Command
854 ... ${bmc_mem_free_cmd}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600855
Sivas SRR5ff4d692017-11-23 02:53:52 -0600856 ${bmc_mem_total_output} ${stderr} ${rc}= BMC Execute Command
857 ... ${bmc_mem_total_cmd}
858
859 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100
Sivas SRRea85d1f2016-11-13 22:44:28 -0600860 ${bmc_mem_percentage}= Evaluate
861 ... ${bmc_mem_percentage}/${bmc_mem_total_output}
862 Should be true ${bmc_mem_percentage} > 10
863
Steven Sombar0acb3412018-01-24 09:38:42 -0600864
Sivas SRRaca55712016-12-21 04:32:35 -0600865BMC File System Usage Check
Sivas SRRc0957412017-10-06 13:02:08 -0500866 [Documentation] Check the file system space. 4 file system should be
867 ... 100% full which is expected
Steven Sombar0acb3412018-01-24 09:38:42 -0600868 # Filesystem Size Used Available Use% Mounted on
869 # /dev/root 14.4M 14.4M 0 100% /
870 # /dev/ubiblock0_0 14.4M 14.4M 0 100% /media/rofs-c9249b0e
871 # /dev/ubiblock8_0 19.6M 19.6M 0 100% /media/pnor-ro-8764baa3
872 # /dev/ubiblock4_0 14.4M 14.4M 0 100% /media/rofs-407816c
873 # /dev/ubiblock8_4 21.1M 21.1M 0 100% /media/pnor-ro-cecc64c4
Sivas SRR5ff4d692017-11-23 02:53:52 -0600874 ${bmc_fs_usage_output} ${stderr} ${rc}= BMC Execute Command
875 ... ${bmc_file_system_usage_cmd}
876 ${bmc_pnor_fs_usage_output} ${stderr} ${rc}= BMC Execute Command
877 ... ${total_pnor_ro_file_system_cmd}
878 ${bmc_bmc_fs_usage_output} ${stderr} ${rc}= BMC Execute Command
879 ... ${total_bmc_ro_file_system_cmd}
880 ${total_bmc_pnor_image}= Evaluate
881 ... ${bmc_pnor_fs_usage_output}+${bmc_bmc_fs_usage_output}
882 # Considering /dev/root also in total 100% used file system
883 ${total_full_fs}= Evaluate ${total_bmc_pnor_image}+1
884 Should Be True ${bmc_fs_usage_output}==${total_full_fs}
Sivas SRRaca55712016-12-21 04:32:35 -0600885
Steven Sombar0acb3412018-01-24 09:38:42 -0600886
Sivas SRRea85d1f2016-11-13 22:44:28 -0600887Check BMC CPU Performance
888 [Documentation] Minimal 10% of proc should be free in 3 sample
889 :FOR ${var} IN Range 1 4
890 \ BMC CPU Performance check
891
Steven Sombar0acb3412018-01-24 09:38:42 -0600892
Sivas SRRea85d1f2016-11-13 22:44:28 -0600893Check BMC Mem Performance
894 [Documentation] Minimal 10% of memory should be free
895
896 :FOR ${var} IN Range 1 4
897 \ BMC Mem Performance check
898
Steven Sombar0acb3412018-01-24 09:38:42 -0600899
Sivas SRRaca55712016-12-21 04:32:35 -0600900Check BMC File System Performance
901 [Documentation] Check for file system usage for 4 times
902
903 :FOR ${var} IN Range 1 4
904 \ BMC File System Usage check
905
Steven Sombar0acb3412018-01-24 09:38:42 -0600906
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500907Get URL List
908 [Documentation] Return list of URLs under given URL.
909 [Arguments] ${openbmc_url}
Steven Sombar0acb3412018-01-24 09:38:42 -0600910
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500911 # Description of argument(s):
Michael Walsh5f3f4142017-05-22 17:09:47 -0500912 # openbmc_url URL for list operation (e.g.
913 # /xyz/openbmc_project/inventory).
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500914
George Keishing335f5362017-06-30 15:11:20 -0500915 ${url_list}= Read Properties ${openbmc_url}/list quiet=${1}
George Keishing184a89a2017-06-27 07:12:16 -0500916 Sort List ${url_list}
Steven Sombar0acb3412018-01-24 09:38:42 -0600917
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500918 [Return] ${url_list}
919
Steven Sombar0acb3412018-01-24 09:38:42 -0600920
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600921Get Endpoint Paths
922 [Documentation] Returns all url paths ending with given endpoint
923 ... Example:
924 ... Given the following endpoint: cpu
Michael Walsh01bd3682017-01-10 11:21:05 -0600925 ... This keyword will return: list of all urls ending with
926 ... cpu -
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600927 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
928 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600929 [Arguments] ${path} ${endpoint}
930
Steven Sombar0acb3412018-01-24 09:38:42 -0600931 # Description of arguments:
932 # path URL path for enumeration.
933 # endpoint Endpoint string (url path ending).
934
George Keishingc7b161b2017-12-01 09:58:12 -0600935 ${resp}= Read Properties ${path}/enumerate timeout=30
936 Log Dictionary ${resp}
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600937
George Keishingc7b161b2017-12-01 09:58:12 -0600938 ${list}= Get Dictionary Keys ${resp}
939 # For a given string, look for prefix and suffix for matching expression.
940 # Start of string followed by zero or more of any character followed by
941 # any digit or lower case character.
942 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9a-z]*$
Steven Sombar0acb3412018-01-24 09:38:42 -0600943
George Keishingc7b161b2017-12-01 09:58:12 -0600944 [Return] ${resp}
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500945
Steven Sombar0acb3412018-01-24 09:38:42 -0600946
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500947Check Zombie Process
948 [Documentation] Check if any defunct process exist or not on BMC
Michael Walsh01bd3682017-01-10 11:21:05 -0600949 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500950 ... return_stderr=True return_rc=True
951 Should Be True ${count}==0
952 Should Be Empty ${stderr}
George Keishing5327d012016-12-08 08:43:29 -0600953
Steven Sombar0acb3412018-01-24 09:38:42 -0600954
George Keishing5327d012016-12-08 08:43:29 -0600955Prune Journal Log
956 [Documentation] Prune archived journal logs.
957 [Arguments] ${vacuum_size}=1M
958
959 # This keyword can be used to prevent the journal
960 # log from filling up the /run filesystem.
961 # This command will retain only the latest logs
962 # of the user specified size.
963
Steven Sombar0acb3412018-01-24 09:38:42 -0600964 # Description of argument(s):
965 # vacuum_size Size of journal.
966
George Keishing5327d012016-12-08 08:43:29 -0600967 Open Connection And Log In
968 ${output} ${stderr} ${rc}=
969 ... Execute Command
970 ... journalctl --vacuum-size=${vacuum_size}
971 ... return_stderr=True return_rc=True
972
973 Should Be Equal ${rc} ${0} msg=${stderr}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600974
Steven Sombar0acb3412018-01-24 09:38:42 -0600975
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600976Set BMC Power Policy
977 [Documentation] Set the given BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -0500978 [Arguments] ${policy}
979
980 # Note that this function will translate the old style "RESTORE_LAST_STATE"
981 # policy to the new style "xyz.openbmc_project.Control.Power.RestorePolicy.
982 # Policy.Restore" for you.
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600983
George Keishing1c3a9662017-08-11 10:16:36 -0500984 # Description of argument(s):
Michael Walshfdc5ced2017-08-17 13:15:15 -0500985 # policy Power restore policy (e.g "RESTORE_LAST_STATE",
986 # ${RESTORE_LAST_STATE}).
987
988 # Set the bmc_power_policy_method to either 'Old' or 'New'.
989 Set Power Policy Method
990 # This translation helps bridge between old and new method for calling.
991 ${policy}= Translate Power Policy Value ${policy}
992 # Run the appropriate keyword.
993 Run Key ${bmc_power_policy_method} Set Power Policy \ ${policy}
994 ${currentPolicy}= Get System Power Policy
995 Should Be Equal ${currentPolicy} ${policy}
996
Steven Sombar0acb3412018-01-24 09:38:42 -0600997
Michael Walshfdc5ced2017-08-17 13:15:15 -0500998New Set Power Policy
999 [Documentation] Set the given BMC power policy (new method).
1000 [Arguments] ${policy}
1001
1002 # Description of argument(s):
George Keishingefc3ff22017-12-12 11:49:25 -06001003 # policy Power restore policy (e.g. ${ALWAYS_POWER_OFF}).
George Keishing1c3a9662017-08-11 10:16:36 -05001004
1005 ${valueDict}= Create Dictionary data=${policy}
1006 Write Attribute
Michael Walshfdc5ced2017-08-17 13:15:15 -05001007 ... ${POWER_RESTORE_URI} PowerRestorePolicy data=${valueDict}
1008
Steven Sombar0acb3412018-01-24 09:38:42 -06001009
Michael Walshfdc5ced2017-08-17 13:15:15 -05001010Old Set Power Policy
1011 [Documentation] Set the given BMC power policy (old method).
1012 [Arguments] ${policy}
1013
1014 # Description of argument(s):
George Keishingefc3ff22017-12-12 11:49:25 -06001015 # policy Power restore policy (e.g. "ALWAYS_POWER_OFF").
Michael Walshfdc5ced2017-08-17 13:15:15 -05001016
1017 ${valueDict}= create dictionary data=${policy}
1018 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
George Keishingcce9df22017-01-24 06:19:33 -06001019
Steven Sombar0acb3412018-01-24 09:38:42 -06001020
George Keishing4d6f3d62017-02-06 09:50:41 -06001021Get System Power Policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001022 [Documentation] Returns the BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -05001023
1024 # Set the bmc_power_policy_method to either 'Old' or 'New'.
1025 Set Power Policy Method
1026 ${cmd_buf}= Create List ${bmc_power_policy_method} Get Power Policy
1027 # Run the appropriate keyword.
1028 ${currentPolicy}= Run Keyword @{cmd_buf}
Steven Sombar0acb3412018-01-24 09:38:42 -06001029
Michael Walshfdc5ced2017-08-17 13:15:15 -05001030 [Return] ${currentPolicy}
1031
Steven Sombar0acb3412018-01-24 09:38:42 -06001032
Michael Walshfdc5ced2017-08-17 13:15:15 -05001033New Get Power Policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001034 [Documentation] Returns the BMC power policy (new method).
George Keishing1c3a9662017-08-11 10:16:36 -05001035 ${currentPolicy}= Read Attribute ${POWER_RESTORE_URI} PowerRestorePolicy
Steven Sombar0acb3412018-01-24 09:38:42 -06001036
George Keishing4d6f3d62017-02-06 09:50:41 -06001037 [Return] ${currentPolicy}
George Keishingcce9df22017-01-24 06:19:33 -06001038
Steven Sombar0acb3412018-01-24 09:38:42 -06001039
Michael Walshfdc5ced2017-08-17 13:15:15 -05001040Old Get Power Policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001041 [Documentation] Returns the BMC power policy (old method).
Michael Walshfdc5ced2017-08-17 13:15:15 -05001042 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001043
Michael Walshfdc5ced2017-08-17 13:15:15 -05001044 [Return] ${currentPolicy}
1045
Steven Sombar0acb3412018-01-24 09:38:42 -06001046
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001047Get Auto Reboot
1048 [Documentation] Returns auto reboot setting.
Sweta Potthuri62a23572017-07-28 04:05:13 -05001049 ${setting}= Read Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot
Steven Sombar0acb3412018-01-24 09:38:42 -06001050
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001051 [Return] ${setting}
1052
Steven Sombar0acb3412018-01-24 09:38:42 -06001053
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001054Set Auto Reboot
1055 [Documentation] Set the given auto reboot setting.
1056 [Arguments] ${setting}
Steven Sombar0acb3412018-01-24 09:38:42 -06001057
1058 # Description of argument(s):
1059 # setting The reboot setting, 1 for enabling and 0 for disabling.
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001060
1061 ${valueDict}= Set Variable ${setting}
1062 ${data}= Create Dictionary data=${valueDict}
Sweta Potthuri62a23572017-07-28 04:05:13 -05001063 Write Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot data=${data}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001064 ${current_setting}= Get Auto Reboot
Sweta Potthuri62a23572017-07-28 04:05:13 -05001065 Should Be Equal As Integers ${current_setting} ${setting}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001066
1067
George Keishingcce9df22017-01-24 06:19:33 -06001068Set BMC Reset Reference Time
1069 [Documentation] Set current boot time as a reference and increment
George Keishing80dd5af2017-02-08 07:01:25 -06001070 ... boot count.
George Keishingcce9df22017-01-24 06:19:33 -06001071
1072 ${cur_btime}= Get BMC Boot Time
George Keishing80dd5af2017-02-08 07:01:25 -06001073 Run Keyword If ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
George Keishingcce9df22017-01-24 06:19:33 -06001074 ... Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishing80dd5af2017-02-08 07:01:25 -06001075 ... ELSE IF ${cur_btime} > ${BOOT_TIME}
1076 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishingcce9df22017-01-24 06:19:33 -06001077 ... AND
1078 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
1079
Steven Sombar0acb3412018-01-24 09:38:42 -06001080
George Keishingcce9df22017-01-24 06:19:33 -06001081Get BMC Boot Time
Steven Sombar0acb3412018-01-24 09:38:42 -06001082 [Documentation] Returns boot time from /proc/stat.
George Keishingcce9df22017-01-24 06:19:33 -06001083
1084 Open Connection And Log In
1085 ${output} ${stderr}=
1086 ... Execute Command egrep '^btime ' /proc/stat | cut -f 2 -d ' '
1087 ... return_stderr=True
1088 Should Be Empty ${stderr}
1089 ${btime}= Convert To Integer ${output}
1090 [Return] ${btime}
George Keishingede30002017-02-02 09:33:07 -06001091
Steven Sombar0acb3412018-01-24 09:38:42 -06001092
George Keishing7a520222017-02-27 09:44:30 -06001093Enable Core Dump On BMC
1094 [Documentation] Enable core dump collection.
Joy Onyerikwu9b668972018-05-22 19:10:43 -05001095 ${core_pattern} ${stderr} ${rc}= BMC Execute Command
George Keishing7a520222017-02-27 09:44:30 -06001096 ... echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
1097 Should Be Equal As Strings ${core_pattern} /tmp/core_%e.%p
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001098
Steven Sombar0acb3412018-01-24 09:38:42 -06001099
Sivas SRR01262bd2017-03-19 10:00:23 -05001100Get Number Of BMC Core Dump Files
Steven Sombar0acb3412018-01-24 09:38:42 -06001101 [Documentation] Returns number of core dump files on BMC.
Sivas SRR01262bd2017-03-19 10:00:23 -05001102 Open Connection And Log In
1103 ${num_of_core_dump}= Execute Command
1104 ... ls /tmp/core* 2>/dev/null | wc -l
1105 [Return] ${num_of_core_dump}
1106
Steven Sombar0acb3412018-01-24 09:38:42 -06001107
Sivas SRR01262bd2017-03-19 10:00:23 -05001108Set Core Dump File Size Unlimited
1109 [Documentation] Set core dump file size to unlimited.
Joy Onyerikwu9b668972018-05-22 19:10:43 -05001110 BMC Execute Command ulimit -c unlimited
Sivas SRR01262bd2017-03-19 10:00:23 -05001111
Steven Sombar0acb3412018-01-24 09:38:42 -06001112
Sivas SRR01262bd2017-03-19 10:00:23 -05001113Check For Core Dumps
1114 [Documentation] Check for any core dumps exist.
1115 ${output}= Get Number Of BMC Core Dump Files
1116 Run Keyword If ${output} > 0
1117 ... Log **Warning** BMC core dump files exist level=WARN
1118
Steven Sombar0acb3412018-01-24 09:38:42 -06001119
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001120Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -05001121 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001122 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Steven Sombar0acb3412018-01-24 09:38:42 -06001123
Michael Walshb5839d02017-04-12 16:11:20 -05001124 # Description of argument(s):
1125 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
1126 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001127 # sleep_time Time delay for host watchdog error to get injected.
1128 # Default is 5 seconds.
1129
Michael Walsh4ffd1a12018-03-14 10:35:44 -05001130 ${data}= Create Dictionary
1131 ... data=xyz.openbmc_project.State.Watchdog.Action.PowerCycle
1132 ${status} ${result}= Run Keyword And Ignore Error
1133 ... Read Attribute ${HOST_WATCHDOG_URI} ExpireAction
1134 Run Keyword If '${status}' == 'PASS'
1135 ... Write Attribute ${HOST_WATCHDOG_URI} ExpireAction data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -05001136
1137 ${data}= Create Dictionary data=${milliseconds}
Michael Walsh4ffd1a12018-03-14 10:35:44 -05001138 Write Attribute ${HOST_WATCHDOG_URI} Interval data=${data}
1139
1140 ${data}= Create Dictionary data=${True}
1141 Write Attribute ${HOST_WATCHDOG_URI} Enabled data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -05001142
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001143 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001144
Steven Sombar0acb3412018-01-24 09:38:42 -06001145
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001146Login To OS Host
Steven Sombar0acb3412018-01-24 09:38:42 -06001147 [Documentation] Login to OS Host and return the Login response code.
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001148 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
1149 ... ${os_password}=${OS_PASSWORD}
Steven Sombar0acb3412018-01-24 09:38:42 -06001150
Gunnar Mills28e403b2017-10-25 16:16:38 -05001151 # Description of arguments:
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001152 # ${os_host} IP address of the OS Host.
1153 # ${os_username} OS Host Login user name.
1154 # ${os_password} OS Host Login passwrd.
1155
1156 ${os_state}= Run Keyword And Return Status Ping Host ${os_host}
1157 Run Keyword If '${os_state}' == 'False'
1158 ... Run Keywords Initiate Host Reboot AND
1159 ... Is Host Running AND
1160 ... Wait for OS ${os_host} ${os_username} ${os_password}
1161
George Keishing3f223b82017-06-28 03:50:35 -05001162 SSHLibrary.Open Connection ${os_host}
Sridevi Rameshea36b412017-03-09 04:08:02 -06001163 ${resp}= Login ${os_username} ${os_password}
1164 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -05001165
Steven Sombar0acb3412018-01-24 09:38:42 -06001166
Prashanth Katti884ee062017-03-16 05:05:03 -05001167Configure Initial Settings
1168 [Documentation] Restore old IP and route.
1169 ... This keyword requires initial settings viz IP address,
1170 ... Network Mask, default gatway and serial console IP and port
1171 ... information which should be provided in command line.
1172
Michael Walshb5839d02017-04-12 16:11:20 -05001173 [Arguments] ${host}=${OPENBMC_HOST} ${mask}=${NET_MASK}
1174 ... ${gw_ip}=${GW_IP}
Prashanth Katti884ee062017-03-16 05:05:03 -05001175
Steven Sombar0acb3412018-01-24 09:38:42 -06001176 # Description of arguments:
1177 # host IP address of the OS Host.
1178 # mask Network mask.
1179 # gu_ip Gateway IP address or hostname.
1180
Michael Walshb5839d02017-04-12 16:11:20 -05001181 # Open telnet connection and ignore the error, in case telnet session is
1182 # already opened by the program calling this keyword.
Prashanth Katti884ee062017-03-16 05:05:03 -05001183 Run Keyword And Ignore Error Open Telnet Connection to BMC Serial Console
1184 Telnet.write ifconfig eth0 ${host} netmask ${mask}
1185 Telnet.write route add default gw ${gw_ip}
George Keishingd05b1082017-03-24 05:27:32 -05001186
Steven Sombar0acb3412018-01-24 09:38:42 -06001187
George Keishingd05b1082017-03-24 05:27:32 -05001188Install Debug Tarball On BMC
George Keishing55441822017-05-18 14:17:59 -05001189 [Documentation] Copy the debug tar file to BMC and install.
Steven Sombar0acb3412018-01-24 09:38:42 -06001190 [Arguments] ${tarball_file_path}=${default_tarball}
1191 ... ${targ_tarball_dir_path}=/tmp/tarball/
George Keishingd05b1082017-03-24 05:27:32 -05001192
George Keishing55441822017-05-18 14:17:59 -05001193 # Description of arguments:
1194 # tarball_file_path Path of the debug tarball file.
1195 # The tar file is downloaded from the build page
1196 # https://openpower.xyz/job/openbmc-build/
1197 # obmc-phosphor-debug-tarball-witherspoon.tar.xz
1198 #
1199 # targ_tarball_dir_path The directory path where the tarball is to be
1200 # installed.
1201
1202 OperatingSystem.File Should Exist ${tarball_file_path}
1203 ... msg=${tarball_file_path} doesn't exist.
1204
1205 # Upload the file to BMC.
George Keishingd05b1082017-03-24 05:27:32 -05001206 Import Library SCPLibrary WITH NAME scp
1207 Open Connection for SCP
George Keishing55441822017-05-18 14:17:59 -05001208 scp.Put File ${tarball_file_path} /tmp/debug-tarball.tar.xz
1209
1210 # Create tarball directory and install.
George Keishing95c371a2017-09-14 15:42:33 -05001211 BMC Execute Command mkdir -p ${targ_tarball_dir_path}
1212 BMC Execute Command
George Keishing55441822017-05-18 14:17:59 -05001213 ... tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path}
1214
George Keishing95c371a2017-09-14 15:42:33 -05001215 # Remove the tarball file from BMC.
1216 BMC Execute Command rm -f /tmp/debug-tarball.tar.xz
George Keishingd05b1082017-03-24 05:27:32 -05001217
George Keishing55441822017-05-18 14:17:59 -05001218
Sweta Potthuri025e0122017-02-21 00:42:48 -06001219Get BMC Boot Count
Steven Sombar0acb3412018-01-24 09:38:42 -06001220 [Documentation] Returns BMC boot count based on boot time.
Sweta Potthuri025e0122017-02-21 00:42:48 -06001221 ${cur_btime}= Get BMC Boot Time
1222
1223 # Set global variable BOOT_TIME to current boot time if current boot time
1224 # is changed. Also increase value of global variable BOOT_COUNT by 1.
1225 Run Keyword If ${cur_btime} > ${BOOT_TIME}
1226 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
1227 ... AND
1228 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
Steven Sombar0acb3412018-01-24 09:38:42 -06001229
Sweta Potthuri025e0122017-02-21 00:42:48 -06001230 [Return] ${BOOT_COUNT}
1231
Steven Sombar0acb3412018-01-24 09:38:42 -06001232
Sweta Potthuri025e0122017-02-21 00:42:48 -06001233Set BMC Boot Count
1234 [Documentation] Set BMC boot count to given value.
1235 [Arguments] ${count}
1236
1237 # Description of arguments:
1238 # count boot count value.
1239 ${cur_btime}= Get BMC Boot Time
1240
1241 # Set global variable BOOT_COUNT to given value.
1242 Set Global Variable ${BOOT_COUNT} ${count}
1243
1244 # Set BOOT_TIME variable to current boot time.
1245 Set Global Variable ${BOOT_COUNT} ${count}
Michael Walsh689fbbe2017-04-04 17:58:03 -05001246
Steven Sombar0acb3412018-01-24 09:38:42 -06001247
Sweta Potthurie5a9fc72017-05-03 07:02:46 -05001248Get System LED State
1249 [Documentation] Return the state of given system LED.
1250 [Arguments] ${led_name}
1251
1252 # Description of argument(s):
1253 # led_name System LED name (e.g. heartbeat, identify, beep).
1254
1255 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State
1256 [Return] ${state.rsplit('.', 1)[1]}
1257
George Keishing3987a1e2017-09-20 09:13:02 -05001258
Steven Sombar5f3af442018-02-14 08:30:15 -06001259Set System LED State
1260 [Documentation] Set given system LED via REST.
1261 [Arguments] ${led_name} ${led_state}
1262 # Description of argument(s):
1263 # led_name System LED name (e.g. heartbeat, identify, beep).
1264 # led_state LED state to be set (e.g. On, Off).
1265
1266 ${args}= Create Dictionary
1267 ... data=xyz.openbmc_project.Led.Physical.Action.${led_state}
1268 Write Attribute ${LED_PHYSICAL_URI}${led_name} State data=${args}
1269
1270 Verify LED State ${led_name} ${led_state}
1271
1272
1273Verify LED State
1274 [Documentation] Checks if LED is in given state.
1275 [Arguments] ${led_name} ${led_state}
1276 # Description of argument(s):
1277 # led_name System LED name (e.g. heartbeat, identify, beep).
1278 # led_state LED state to be verified (e.g. On, Off).
1279
1280 ${state}= Get System LED State ${led_name}
1281 Should Be Equal ${state} ${led_state}
1282
1283
Steven Sombarb89d5802018-02-15 14:48:49 -06001284Get LED State XYZ
1285 [Documentation] Returns state of given LED.
1286 [Arguments] ${led_name}
1287
1288 # Description of argument(s):
1289 # led_name Name of LED.
1290
1291 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
1292 # Returns the state of the LED, either On or Off.
1293 [Return] ${state}
1294
1295
George Keishingd2d90af2017-06-27 08:17:34 -05001296Delete Error Logs
Michael Walsh689fbbe2017-04-04 17:58:03 -05001297 [Documentation] Delete error logs.
1298
George Keishingd2d90af2017-06-27 08:17:34 -05001299 # Check if error logs entries exist, if not return.
George Keishing335f5362017-06-30 15:11:20 -05001300 ${resp}= OpenBMC Get Request ${BMC_LOGGING_ENTRY}${/}list quiet=${1}
George Keishingd2d90af2017-06-27 08:17:34 -05001301 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND}
1302
1303 # Get the list of error logs entries and delete them all.
George Keishing335f5362017-06-30 15:11:20 -05001304 ${elog_entries}= Get URL List ${BMC_LOGGING_ENTRY}
George Keishingd2d90af2017-06-27 08:17:34 -05001305 :FOR ${entry} IN @{elog_entries}
1306 \ Delete Error Log Entry ${entry}
George Keishingdb34c2f2017-04-18 13:20:25 -05001307
George Keishing3987a1e2017-09-20 09:13:02 -05001308
George Keishingd2d90af2017-06-27 08:17:34 -05001309Delete Error Log Entry
George Keishingdb34c2f2017-04-18 13:20:25 -05001310 [Documentation] Delete error log entry.
1311 [Arguments] ${entry_path}
1312
1313 # Description of argument(s):
1314 # entry_path Delete an error log entry.
1315 # Ex. /xyz/openbmc_project/logging/entry/1
1316
George Keishing6a8ed0f2017-07-11 22:54:42 -05001317 # Skip delete if entry URI is a callout.
1318 # Example: /xyz/openbmc_project/logging/entry/1/callout
1319 Return From Keyword If '${entry_path.rsplit('/', 1)[1]}' == 'callout'
1320
George Keishingdb34c2f2017-04-18 13:20:25 -05001321 ${data}= Create Dictionary data=@{EMPTY}
1322 ${resp}= Openbmc Delete Request ${entry_path} data=${data}
1323 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Rahul Maheshwari43be6932017-05-01 02:37:06 -05001324
1325
George Keishingcc71c3c2017-09-20 09:38:03 -05001326Delete All Error Logs
George Keishing3987a1e2017-09-20 09:13:02 -05001327 [Documentation] Delete all error log entries using "DeleteAll" interface.
1328
1329 ${data}= Create Dictionary data=@{EMPTY}
1330 ${resp}= Openbmc Post Request ${BMC_LOGGING_URI}action/DeleteAll
1331 ... data=${data}
1332 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
1333
1334
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001335Get BMC Version
1336 [Documentation] Returns BMC version from /etc/os-release.
1337 ... e.g. "v1.99.6-141-ge662190"
1338
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001339 ${cmd}= Set Variable grep ^VERSION_ID= /etc/os-release | cut -f 2 -d '='
Joy Onyerikwu9b668972018-05-22 19:10:43 -05001340 ${output} ${stderr} ${rc}= BMC Execute Command ${cmd}
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001341 [Return] ${output}
1342
George Keishingad5817a2017-06-28 10:19:03 -05001343
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -05001344Get PNOR Version
Steven Sombar0acb3412018-01-24 09:38:42 -06001345 [Documentation] Returns the PNOR version from the BMC.
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -05001346
1347 ${pnor_attrs}= Get PNOR Attributes
1348 [Return] ${pnor_attrs['version']}
1349
1350
1351Get PNOR Attributes
1352 [Documentation] Return PNOR software attributes as a dictionary.
1353
Michael Walsh98d8c9e2017-10-04 12:24:29 -05001354 # This keyword parses /var/lib/phosphor-software-manager/pnor/ro/pnor.toc
1355 # into key/value pairs.
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -05001356
1357 ${outbuf} ${stderr} ${rc}= BMC Execute Command
1358 ... cat /var/lib/phosphor-software-manager/pnor/ro/pnor.toc
1359 ${pnor_attrs}= Key Value Outbuf To Dict ${outbuf} delim==
1360
1361 [Return] ${pnor_attrs}
1362
1363
George Keishingad5817a2017-06-28 10:19:03 -05001364Get Elog URL List
1365 [Documentation] Return error log entry list of URLs.
1366
1367 ${url_list}= Read Properties /xyz/openbmc_project/logging/entry/
1368 Sort List ${url_list}
1369 [Return] ${url_list}
1370
1371
Steven Sombaraaf72c42017-09-05 12:02:00 -05001372Read Turbo Setting Via REST
1373 [Documentation] Return turbo setting via REST.
Steven Sombarea79a492018-04-18 11:14:57 -05001374 # Returns 1 if TurboAllowed, 0 if not.
Steven Sombaraaf72c42017-09-05 12:02:00 -05001375
Steven Sombarea79a492018-04-18 11:14:57 -05001376 ${turbo_setting}= Read Attribute
1377 ... ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
1378 [Return] ${turbo_setting}
1379
Steven Sombaraaf72c42017-09-05 12:02:00 -05001380
Steven Sombaraaf72c42017-09-05 12:02:00 -05001381Set Turbo Setting Via REST
1382 [Documentation] Set turbo setting via REST.
Steven Sombar80bc8592018-04-24 11:44:53 -05001383 [Arguments] ${setting} ${verify}=${False}
Steven Sombar0acb3412018-01-24 09:38:42 -06001384
Steven Sombaraaf72c42017-09-05 12:02:00 -05001385 # Description of argument(s):
Steven Sombar80bc8592018-04-24 11:44:53 -05001386 # setting State to set TurboAllowed, 1=allowed, 0=not allowed.
1387 # verify If True, read the TurboAllowed setting to confirm.
Steven Sombaraaf72c42017-09-05 12:02:00 -05001388
Steven Sombarea79a492018-04-18 11:14:57 -05001389 ${data}= Create Dictionary data=${${setting}}
Steven Sombar80bc8592018-04-24 11:44:53 -05001390 Write Attribute ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
1391 ... verify=${verify} data=${data}
George Keishingef74a8c2017-10-20 10:23:52 -05001392
Steven Sombar0acb3412018-01-24 09:38:42 -06001393
George Keishingef74a8c2017-10-20 10:23:52 -05001394Set Control Boot Mode
1395 [Documentation] Set given boot mode on the boot object path attribute.
1396 [Arguments] ${boot_path} ${boot_mode}
1397
1398 # Description of argument(s):
1399 # boot_path Boot object path.
1400 # Example:
1401 # /xyz/openbmc_project/control/host0/boot
1402 # /xyz/openbmc_project/control/host0/boot/one_time
1403 # boot_mode Boot mode which need to be set.
1404 # Example:
1405 # "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"
1406
1407 ${valueDict}= Create Dictionary data=${boot_mode}
1408 Write Attribute ${boot_path} BootMode data=${valueDict}
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -05001409
Steven Sombar0acb3412018-01-24 09:38:42 -06001410
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -05001411Copy Address Translation Utils To HOST OS
1412 [Documentation] Copy address translation utils to host OS.
1413
1414 OperatingSystem.File Should Exist ${probe_cpu_tool_path}
1415 ... msg=${probe_cpu_tool_path} doesn't exist.
1416 OperatingSystem.File Should Exist ${probe_cpu_tool_path}
1417 ... msg=${probe_cpu_tool_path} doesn't exist.
1418
1419 scp.Open connection ${OS_HOST} username=${OS_USERNAME}
1420 ... password=${OS_PASSWORD}
1421 scp.Put File ${probe_cpu_tool_path} ${target_file_path}
1422 scp.Put File ${scom_addrs_tool_path} ${target_file_path}
George Keishing034902d2017-11-10 13:15:38 -06001423
1424
1425Verify BMC RTC And UTC Time Drift
1426 [Documentation] Verify that the RTC and UTC time difference is less than
1427 ... the given time_drift_max.
1428 [Arguments] ${time_diff_max}=${10}
1429
1430 # Description of argument(s):
1431 # time_diff_max The max allowable RTC and UTC time difference in seconds.
1432
1433 # Example:
1434 # time_dict:
1435 # [local_time]: Fri 2017-11-03 152756 UTC
1436 # [local_time_seconds]: 1509740876
1437 # [universal_time]: Fri 2017-11-03 152756 UTC
1438 # [universal_time_seconds]: 1509740876
1439 # [rtc_time]: Fri 2016-05-20 163403
1440 # [rtc_time_seconds]: 1463780043
1441 # [time_zone]: n/a (UTC, +0000)
1442 # [network_time_on]: yes
1443 # [ntp_synchronized]: no
1444 # [rtc_in_local_tz]: no
1445
Steven Sombar0acb3412018-01-24 09:38:42 -06001446 ${time}= Get BMC Date Time
George Keishing034902d2017-11-10 13:15:38 -06001447 ${time_diff}= Evaluate
Steven Sombar0acb3412018-01-24 09:38:42 -06001448 ... ${time['universal_time_seconds']} - ${time['rtc_time_seconds']}
George Keishing034902d2017-11-10 13:15:38 -06001449 Should Be True ${time_diff} < ${time_diff_max}
Sweta Potthuri7d3af3c2018-01-29 03:07:07 -06001450
Sweta Potthurif39022d2018-02-06 03:40:07 -06001451
Sweta Potthuri7d3af3c2018-01-29 03:07:07 -06001452Watchdog Object Should Exist
1453 [Documentation] Check that watchdog object exists.
1454
1455 ${resp}= OpenBMC Get Request ${WATCHDOG_URI}host0
1456 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
1457 ... msg=Expected watchdog object does not exist.
Sweta Potthurif39022d2018-02-06 03:40:07 -06001458
1459
1460Validate IP On BMC
1461 [Documentation] Validate IP address is present in set of IP addresses.
1462 [Arguments] ${ip_address} ${ip_data}
1463
1464 # Description of argument(s):
1465 # ip_address IP address to check (e.g. xx.xx.xx.xx).
1466 # ip_data Set of the IP addresses present.
1467
1468 Should Contain Match ${ip_data} ${ip_address}/*
1469 ... msg=${ip_address} not found in the list provided.
George Keishingb9f407b2018-02-20 00:07:46 -06001470
1471
1472Remove Journald Logs
1473 [Documentation] Remove all journald logs and restart service.
1474
1475 ${cmd}= Catenate systemctl stop systemd-journald.service &&
1476 ... rm -rf /var/log/journal && systemctl start systemd-journald.service
1477
1478 BMC Execute Command ${cmd}
1479
George Keishing78ce8dc2018-03-30 11:49:06 -05001480
1481Verify Identify LED State
1482 [Documentation] Verify the identify LED state
1483 ... matches caller's expectations.
1484 [Arguments] ${expected_state}
1485
1486 # Description of argument(s):
1487 # expected_state The LED state expected by the caller ("Blink" or "Off").
1488
1489 ${resp}= Read Attribute ${LED_PHYSICAL_URI}/front_id State
1490 Should Be Equal ${resp}
1491 ... xyz.openbmc_project.Led.Physical.Action.${expected_state}
1492 ... msg=Unexpected LED state.
1493
1494 ${resp}= Read Attribute ${LED_PHYSICAL_URI}/rear_id State
1495 Should Be Equal ${resp}
1496 ... xyz.openbmc_project.Led.Physical.Action.${expected_state}
1497 ... msg=Unexpected LED state.
1498
Sweta Potthuri39255032018-03-28 10:12:14 -05001499
1500Verify The Attribute
1501 [Arguments] ${uri} ${attribute_name} ${attribute_value}
1502
1503 # Description of argument(s):
1504 # uri URI path
1505 # (e.g. "/xyz/openbmc_project/control/host0/TPMEnable").
1506 # attribute_name Name of attribute to be verified (e.g. "TPMEnable").
1507 # attribute_value The expected value of attribute (e.g. "1", "0", etc.)
1508
1509 ${output}= Read Attribute ${uri} ${attribute_name}
1510 Should Be Equal ${attribute_value} ${output}
1511 ... msg=Attribute "${attribute_name} does not have the expected value.
George Keishingcf0d7772018-05-04 08:22:50 -05001512
1513
1514Get BMC Flash Chip Boot Side
1515 [Documentation] Return the BMC flash chip boot side.
1516
1517 # Example:
1518 # 0 - indicates chip select is current side.
1519 # 1 - indicates chip select is alternate side.
1520
1521 ${boot_side} ${stderr} ${rc}= BMC Execute Command
1522 ... echo $(($(/sbin/devmem 0x1E785030) >> 1 & 1))
1523
1524 [Return] ${boot_side}
1525