blob: b11022dad7c057192d8ed3ddaaa3fdb10ae89b24 [file] [log] [blame]
Chris Austenb29d2e82016-06-07 12:25:35 -05001*** Settings ***
2Resource ../lib/resource.txt
3Resource ../lib/rest_client.robot
George Keishing5e870cd2016-08-24 10:05:47 -05004Resource ../lib/connection_client.robot
Sunil Macd110a2017-05-23 04:14:32 -05005Resource ../extended/obmc_boot_test_resource.robot
George Keishing30c12ff2016-09-02 10:25:29 -05006Library DateTime
7Library Process
Chris Austenb29d2e82016-06-07 12:25:35 -05008Library OperatingSystem
Michael Walsha6723f22016-11-22 11:12:01 -06009Library gen_print.py
10Library gen_robot_print.py
Michael Walsh5f3f4142017-05-22 17:09:47 -050011Library gen_cmd.py
Sunil Macd110a2017-05-23 04:14:32 -050012Library gen_robot_keyword.py
Chris Austenb29d2e82016-06-07 12:25:35 -050013
14*** Variables ***
15${SYSTEM_SHUTDOWN_TIME} ${5}
Michael Walsha6723f22016-11-22 11:12:01 -060016${dbuscmdBase}
George Keishing85ca05e2016-11-30 09:47:18 -060017... dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host
Michael Walsha6723f22016-11-22 11:12:01 -060018${dbuscmdGet}
George Keishing9485af92017-01-04 10:21:43 -060019... ${SETTINGS_URI}host0 org.freedesktop.DBus.Properties.Get
George Keishing85ca05e2016-11-30 09:47:18 -060020# Enable when ready with openbmc/openbmc-test-automation#203
21#${dbuscmdString}= string:"xyz.openbmc_project.settings.Host" string:
Michael Walsha6723f22016-11-22 11:12:01 -060022${dbuscmdString}= string:"org.openbmc.settings.Host" string:
23
24# Assign default value to QUIET for programs which may not define it.
25${QUIET} ${0}
Sivas SRRea85d1f2016-11-13 22:44:28 -060026${bmc_mem_free_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4
27${bmc_mem_total_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2
28${bmc_cpu_usage_cmd}= top -n 1 | grep CPU: | cut -c 7-9
Sridevi Ramesh1699d372016-12-06 00:20:22 -060029${HOST_SETTING} ${SETTINGS_URI}host0
Sivas SRR352bc162017-02-13 22:12:29 -060030# /run/initramfs/ro associate filesystem should be 100% full always
Sivas SRRaca55712016-12-21 04:32:35 -060031${bmc_file_system_usage_cmd}=
Sivas SRR352bc162017-02-13 22:12:29 -060032... df -h | grep -v /run/initramfs/ro | cut -c 52-54 | grep 100 | wc -l
Chris Austenb29d2e82016-06-07 12:25:35 -050033
George Keishingcce9df22017-01-24 06:19:33 -060034${BOOT_TIME} ${0}
35${BOOT_COUNT} ${0}
Sweta Potthuri025e0122017-02-21 00:42:48 -060036${count} ${0}
Sivas SRR8254db62017-02-07 09:39:46 -060037${devicetree_base} /sys/firmware/devicetree/base/model
Sunil Macd110a2017-05-23 04:14:32 -050038# MAC input from user.
39${MAC_ADDRESS} ${EMPTY}
George Keishingcce9df22017-01-24 06:19:33 -060040
George Keishingb7c9b542017-05-23 08:19:58 -050041# Initialize default debug value to 0.
42${DEBUG} ${0}
43
Chris Austenb29d2e82016-06-07 12:25:35 -050044*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060045
Sivas SRR8254db62017-02-07 09:39:46 -060046Get BMC System Model
47 [Documentation] Get the BMC model from the device tree.
48
Michael Walshb5839d02017-04-12 16:11:20 -050049 Open Connection And Log In
George Keishing90ab1772017-02-24 05:40:55 -060050 ${bmc_model} ${stderr}= Execute Command
51 ... cat ${devicetree_base} | cut -d " " -f 1 return_stderr=True
Sivas SRR8254db62017-02-07 09:39:46 -060052 Should Be Empty ${stderr}
53 Should Not Be Empty ${bmc_model}
54 [Return] ${bmc_model}
55
56Verify BMC System Model
57 [Documentation] Verify the BMC model with ${OPENBMC_MODEL}.
58 [Arguments] ${bmc_model}
59
60 ${tmp_bmc_model}= Fetch From Right ${OPENBMC_MODEL} /
61 ${tmp_bmc_model}= Fetch From Left ${tmp_bmc_model} .
62 ${ret}= Run Keyword And Return Status Should Contain ${bmc_model}
63 ... ${tmp_bmc_model} ignore_case=True
64 [Return] ${ret}
65
Chris Austenb29d2e82016-06-07 12:25:35 -050066Wait For Host To Ping
root442f0ef2016-08-04 20:23:05 +000067 [Arguments] ${host} ${timeout}=${OPENBMC_REBOOT_TIMEOUT}min
68 ... ${interval}=5 sec
69
70 # host The DNS name or IP of the host to ping.
71 # timeout The amount of time after which attempts to ping cease.
72 # interval The amount of time in between attempts to ping.
73
74 Wait Until Keyword Succeeds ${timeout} ${interval} Ping Host ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -050075
76Ping Host
77 [Arguments] ${host}
George Keishing8a84f952016-08-25 04:54:53 -050078 Should Not Be Empty ${host} msg=No host provided
Michael Walsha6723f22016-11-22 11:12:01 -060079 ${RC} ${output}= Run and return RC and Output ping -c 4 ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -050080 Log RC: ${RC}\nOutput:\n${output}
81 Should be equal ${RC} ${0}
82
83Get Boot Progress
Michael Walsha6723f22016-11-22 11:12:01 -060084 [Arguments] ${quiet}=${QUIET}
85
George Keishing85ca05e2016-11-30 09:47:18 -060086 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
Michael Walsha6723f22016-11-22 11:12:01 -060087 ... value quiet=${quiet}
Gunnar Millsc9ea9362016-12-13 16:21:13 -060088 [Return] ${state}
Chris Austenb29d2e82016-06-07 12:25:35 -050089
90Is Power On
root442f0ef2016-08-04 20:23:05 +000091 ${state}= Get Power State
92 Should be equal ${state} ${1}
Chris Austenb29d2e82016-06-07 12:25:35 -050093
94Is Power Off
root442f0ef2016-08-04 20:23:05 +000095 ${state}= Get Power State
96 Should be equal ${state} ${0}
Chris Austenb29d2e82016-06-07 12:25:35 -050097
root442f0ef2016-08-04 20:23:05 +000098Initiate Power On
99 [Documentation] Initiates the power on and waits until the Is Power On
100 ... keyword returns that the power state has switched to on.
Michael Walsha6723f22016-11-22 11:12:01 -0600101 [Arguments] ${wait}=${1}
102
Chris Austenb29d2e82016-06-07 12:25:35 -0500103 @{arglist}= Create List
104 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600105 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
Michael Walsha6723f22016-11-22 11:12:01 -0600106 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500107 should be equal as strings ${resp.status_code} ${HTTP_OK}
Chris Austenb29d2e82016-06-07 12:25:35 -0500108
Michael Walsha6723f22016-11-22 11:12:01 -0600109 # Does caller want to wait for power on status?
110 Run Keyword If '${wait}' == '${0}' Return From Keyword
111 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500112
root442f0ef2016-08-04 20:23:05 +0000113Initiate Power Off
114 [Documentation] Initiates the power off and waits until the Is Power Off
115 ... keyword returns that the power state has switched to off.
Chris Austenb29d2e82016-06-07 12:25:35 -0500116 @{arglist}= Create List
117 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600118 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
Michael Walsha6723f22016-11-22 11:12:01 -0600119 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500120 should be equal as strings ${resp.status_code} ${HTTP_OK}
Michael Walsha6723f22016-11-22 11:12:01 -0600121 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
Chris Austenb29d2e82016-06-07 12:25:35 -0500122
Michael Walsh81843772017-03-02 14:44:44 -0600123Initiate OS Host Power Off
124 [Documentation] Initiate an OS reboot.
125 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
126 ... ${os_password}=${OS_PASSWORD}
127
128 # Description of arguments:
129 # os_host The DNS name or IP of the OS.
130 # os_username The username to be used to sign in to the OS.
131 # os_password The password to be used to sign in to the OS.
132
Michael Walshac275512017-03-07 11:39:28 -0600133 SSHLibrary.Open connection ${os_host}
Michael Walsh81843772017-03-02 14:44:44 -0600134 Login ${os_username} ${os_password}
135 ${cmd_buf} Catenate shutdown
136 Start Command ${cmd_buf}
Michael Walshac275512017-03-07 11:39:28 -0600137 SSHLibrary.Close Connection
Michael Walsh81843772017-03-02 14:44:44 -0600138
139Initiate OS Host Reboot
140 [Documentation] Initiate an OS reboot.
141 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
142 ... ${os_password}=${OS_PASSWORD}
143
144 # Description of arguments:
145 # os_host The DNS name or IP of the OS.
146 # os_username The username to be used to sign in to the OS.
147 # os_password The password to be used to sign in to the OS.
148
Michael Walshac275512017-03-07 11:39:28 -0600149 SSHLibrary.Open connection ${os_host}
Michael Walsh81843772017-03-02 14:44:44 -0600150 Login ${os_username} ${os_password}
151 ${cmd_buf} Catenate reboot
152 Start Command ${cmd_buf}
Michael Walshac275512017-03-07 11:39:28 -0600153 SSHLibrary.Close Connection
Michael Walsh81843772017-03-02 14:44:44 -0600154
155Initiate Auto Reboot
156 [Documentation] Initiate an auto reboot.
157
158 # Set the auto reboot policy.
159 Set Auto Reboot yes
160
Michael Walshac275512017-03-07 11:39:28 -0600161 SSHLibrary.Open connection ${openbmc_host}
Michael Walsh81843772017-03-02 14:44:44 -0600162 Login ${openbmc_username} ${openbmc_password}
163
164 # Set the watchdog timer. Note: 5000 = milliseconds which is 5 seconds.
165 ${cmd_buf}= Catenate /usr/sbin/mapper call /org/openbmc/watchdog/host0
166 ... org.openbmc.Watchdog set i 5000
167 ${output} ${stderr} ${rc}= Execute Command ${cmd_buf}
168 ... return_stderr=True return_rc=True
169 Should Be Empty ${stderr}
170 Should be equal ${rc} ${0}
171
172 # Start the watchdog.
173 ${cmd_buf}= Catenate /usr/sbin/mapper call /org/openbmc/watchdog/host0
174 ... org.openbmc.Watchdog start
175 ${output} ${stderr} ${rc}= Execute Command ${cmd_buf}
176 ... return_stderr=True return_rc=True
177 Should Be Empty ${stderr}
178 Should be equal ${rc} ${0}
179
Chris Austenb29d2e82016-06-07 12:25:35 -0500180Trigger Warm Reset
181 log to console "Triggering warm reset"
Michael Walsha6723f22016-11-22 11:12:01 -0600182 ${data}= create dictionary data=@{EMPTY}
George Keishing85ca05e2016-11-30 09:47:18 -0600183 ${resp}= openbmc post request
184 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
Chris Austenb29d2e82016-06-07 12:25:35 -0500185 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
George Keishingb3700812016-08-31 03:03:30 -0500186 ${session_active}= Check If warmReset is Initiated
187 Run Keyword If '${session_active}' == '${True}'
188 ... Fail msg=warm reset didn't occur
189
Chris Austenb29d2e82016-06-07 12:25:35 -0500190 Sleep ${SYSTEM_SHUTDOWN_TIME}min
Rahul Maheshwari5f253c42017-01-30 05:19:51 -0600191 Check If BMC Is Up
Michael Walsh49ab0f42016-07-20 11:44:33 -0500192
193Check OS
root442f0ef2016-08-04 20:23:05 +0000194 [Documentation] Attempts to ping the host OS and then checks that the host
195 ... OS is up by running an SSH command.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500196
197 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walsha6723f22016-11-22 11:12:01 -0600198 ... ${os_password}=${OS_PASSWORD} ${quiet}=${QUIET}
199 ... ${print_string}=${EMPTY}
Michael Walshac275512017-03-07 11:39:28 -0600200 [Teardown] SSHLibrary.Close Connection
Michael Walsh49ab0f42016-07-20 11:44:33 -0500201
202 # os_host The DNS name/IP of the OS host associated with our BMC.
203 # os_username The username to be used to sign on to the OS host.
204 # os_password The password to be used to sign on to the OS host.
Michael Walsha6723f22016-11-22 11:12:01 -0600205 # quiet Indicates whether this keyword should write to console.
206 # print_string A string to be printed before checking the OS.
207
208 rprint ${print_string}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500209
root442f0ef2016-08-04 20:23:05 +0000210 # Attempt to ping the OS. Store the return code to check later.
211 ${ping_rc}= Run Keyword and Return Status Ping Host ${os_host}
212
Michael Walshac275512017-03-07 11:39:28 -0600213 SSHLibrary.Open connection ${os_host}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500214
Michael Walsha6723f22016-11-22 11:12:01 -0600215 ${status} ${msg}= Run Keyword And Ignore Error Login ${os_username}
216 ... ${os_password}
217 ${err_msg1}= Sprint Error ${msg}
218 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
219 Run Keyword If '${status}' == 'FAIL' Fail msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500220 ${output} ${stderr} ${rc}= Execute Command uptime return_stderr=True
221 ... return_rc=True
222
Michael Walsha6723f22016-11-22 11:12:01 -0600223 ${temp_msg}= Catenate Could not execute a command on the operating
224 ... system.\n
225 ${err_msg1}= Sprint Error ${temp_msg}
226 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
227
228 # If the return code returned by "Execute Command" is non-zero, this
229 # keyword will fail.
230 Should Be Equal ${rc} ${0} msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500231 # We will likewise fail if there is any stderr data.
232 Should Be Empty ${stderr}
233
Michael Walsha6723f22016-11-22 11:12:01 -0600234 ${temp_msg}= Set Variable Could not ping the operating system.\n
235 ${err_msg1}= Sprint Error ${temp_msg}
236 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
237 # We will likewise fail if the OS did not ping, as we could SSH but not
238 # ping
239 Should Be Equal As Strings ${ping_rc} ${TRUE} msg=${err_msg}
root442f0ef2016-08-04 20:23:05 +0000240
Michael Walsh49ab0f42016-07-20 11:44:33 -0500241Wait for OS
242 [Documentation] Waits for the host OS to come up via calls to "Check OS".
243 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
244 ... ${os_password}=${OS_PASSWORD} ${timeout}=${OS_WAIT_TIMEOUT}
Michael Walsha6723f22016-11-22 11:12:01 -0600245 ... ${quiet}=${0}
246 [Teardown] rprintn
Michael Walsh49ab0f42016-07-20 11:44:33 -0500247
248 # os_host The DNS name or IP of the OS host associated with our
249 # BMC.
250 # os_username The username to be used to sign on to the OS host.
251 # os_password The password to be used to sign on to the OS host.
252 # timeout The timeout in seconds indicating how long you're
253 # willing to wait for the OS to respond.
Michael Walsha6723f22016-11-22 11:12:01 -0600254 # quiet Indicates whether this keyword should write to console.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500255
256 # The interval to be used between calls to "Check OS".
257 ${interval}= Set Variable 5
258
Michael Walsha6723f22016-11-22 11:12:01 -0600259 ${message}= Catenate Checking every ${interval} seconds for up to
260 ... ${timeout} seconds for the operating system to communicate.
261 rqprint_timen ${message}
262
Michael Walsh49ab0f42016-07-20 11:44:33 -0500263 Wait Until Keyword Succeeds ${timeout} sec ${interval} Check OS
264 ... ${os_host} ${os_username} ${os_password}
Michael Walsha6723f22016-11-22 11:12:01 -0600265 ... print_string=\#
266
267 rqprintn
268
269 rqprint_timen The operating system is now communicating.
root442f0ef2016-08-04 20:23:05 +0000270
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600271Get BMC State Deprecated
root442f0ef2016-08-04 20:23:05 +0000272 [Documentation] Returns the state of the BMC as a string. (i.e: BMC_READY)
Michael Walsha6723f22016-11-22 11:12:01 -0600273 [Arguments] ${quiet}=${QUIET}
274
root442f0ef2016-08-04 20:23:05 +0000275 @{arglist}= Create List
276 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600277 ${resp}= Call Method ${OPENBMC_BASE_URI}managers/System/ getSystemState
Michael Walsha6723f22016-11-22 11:12:01 -0600278 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000279 Should be equal as strings ${resp.status_code} ${HTTP_OK}
280 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600281 [Return] ${content["data"]}
root442f0ef2016-08-04 20:23:05 +0000282
283Get Power State
284 [Documentation] Returns the power state as an integer. Either 0 or 1.
Michael Walsha6723f22016-11-22 11:12:01 -0600285 [Arguments] ${quiet}=${QUIET}
286
root442f0ef2016-08-04 20:23:05 +0000287 @{arglist}= Create List
288 ${args}= Create Dictionary data=@{arglist}
Michael Walsha6723f22016-11-22 11:12:01 -0600289
George Keishing85ca05e2016-11-30 09:47:18 -0600290 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
Michael Walsha6723f22016-11-22 11:12:01 -0600291 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000292 Should be equal as strings ${resp.status_code} ${HTTP_OK}
293 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600294 [Return] ${content["data"]}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500295
296Clear BMC Record Log
297 [Documentation] Clears all the event logs on the BMC. This would be
298 ... equivalent to ipmitool sel clear.
299 @{arglist}= Create List
300 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600301 ${resp}= Call Method
302 ... ${OPENBMC_BASE_URI}records/events/ clear data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500303 should be equal as strings ${resp.status_code} ${HTTP_OK}
304
305Copy PNOR to BMC
306 Import Library SCPLibrary WITH NAME scp
307 Open Connection for SCP
308 Log Copying ${PNOR_IMAGE_PATH} to /tmp
309 scp.Put File ${PNOR_IMAGE_PATH} /tmp
310
311Flash PNOR
312 [Documentation] Calls flash bios update method to flash PNOR image
Gunnar Mills38032802016-12-12 13:43:40 -0600313 [Arguments] ${pnor_image}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500314 @{arglist}= Create List ${pnor_image}
315 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600316 ${resp}= Call Method ${OPENBMC_BASE_URI}control/flash/bios/ update
Michael Walsha6723f22016-11-22 11:12:01 -0600317 ... data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500318 should be equal as strings ${resp.status_code} ${HTTP_OK}
319 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
320
321Get Flash BIOS Status
322 [Documentation] Returns the status of the flash BIOS API as a string. For
323 ... example 'Flashing', 'Flash Done', etc
George Keishing85ca05e2016-11-30 09:47:18 -0600324 ${data}= Read Properties ${OPENBMC_BASE_URI}control/flash/bios
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600325 [Return] ${data['status']}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500326
327Is PNOR Flashing
328 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
329 ... flashing has started.
330 ${status}= Get Flash BIOS Status
Rahul Maheshwari449dfb72017-05-08 02:06:48 -0500331 Should Contain ${status} Flashing
Jay Azurine4c52eb2016-08-16 20:51:10 -0500332
333Is PNOR Flash Done
334 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
335 ... PNOR flashing has completed.
Leah McNutt9ba32272016-11-17 15:48:39 +0000336 ${status}= Get Flash BIOS Status
Jay Azurine4c52eb2016-08-16 20:51:10 -0500337 should be equal as strings ${status} Flash Done
338
339Is System State Host Booted
340 [Documentation] Checks whether system state is HOST_BOOTED.
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600341 ${state}= Get BMC State Deprecated
Jay Azurine4c52eb2016-08-16 20:51:10 -0500342 should be equal as strings ${state} HOST_BOOTED
George Keishing5e870cd2016-08-24 10:05:47 -0500343
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600344Is OS Starting
345 [Documentation] Check if boot progress is OS starting.
346 ${boot_progress}= Get Boot Progress
347 Should Be Equal ${boot_progress} FW Progress, Starting OS
348
George Keishing0af24412017-03-10 13:33:23 -0600349Is OS Off
350 [Documentation] Check if boot progress is "Off".
351 ${boot_progress}= Get Boot Progress
352 Should Be Equal ${boot_progress} Off
353
George Keishing5e870cd2016-08-24 10:05:47 -0500354Verify Ping and REST Authentication
Michael Walsha6723f22016-11-22 11:12:01 -0600355 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500356 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -0500357 Run Keyword If '${l_ping}' == '${False}'
358 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500359
Michael Walsha6723f22016-11-22 11:12:01 -0600360 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500361 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -0500362 Run Keyword If '${l_rest}' == '${False}'
363 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500364
365 # Just to make sure the SSH is working for SCP
366 Open Connection And Log In
367 ${system} ${stderr}= Execute Command hostname return_stderr=True
368 Should Be Empty ${stderr}
369
George Keishingc4d3dc02016-09-19 03:45:55 -0500370Check If BMC is Up
371 [Documentation] Wait for Host to be online. Checks every X seconds
372 ... interval for Y minutes and fails if timed out.
373 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -0600374 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -0500375 ... ${interval}=10 sec
376
377 Wait Until Keyword Succeeds
378 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
379
George Keishingb3700812016-08-31 03:03:30 -0500380
381Check If warmReset is Initiated
382 [Documentation] Ping would be still alive, so try SSH to connect
383 ... if fails the ports are down indicating reboot
384 ... is in progress
George Keishing3c05d352016-12-13 06:54:50 -0600385
386 # Warm reset adds 3 seconds delay before forcing reboot
387 # To minimize race conditions, we wait for 7 seconds
388 Sleep 7s
George Keishingb3700812016-08-31 03:03:30 -0500389 ${alive}= Run Keyword and Return Status
390 ... Open Connection And Log In
391 Return From Keyword If '${alive}' == '${False}' ${False}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600392 [Return] ${True}
George Keishingb3700812016-08-31 03:03:30 -0500393
George Keishing06ae4aa2016-08-30 01:41:28 -0500394Flush REST Sessions
395 [Documentation] Removes all the active session objects
396 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500397
Sivas SRRe1143ae2016-08-26 22:31:02 -0500398Initialize DBUS cmd
399 [Documentation] Initialize dbus string with property string to extract
Gunnar Mills38032802016-12-12 13:43:40 -0600400 [Arguments] ${boot_property}
Michael Walsha6723f22016-11-22 11:12:01 -0600401 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
402 ${cmd}= Catenate ${cmd}${boot_property}
Sivas SRRe1143ae2016-08-26 22:31:02 -0500403 Set Global Variable ${dbuscmd} ${cmd}
404
David Shawba2d2c22017-01-23 16:56:38 -0600405Create OS Console File Path
406 [Documentation] Create OS console file path name and return it.
407 [Arguments] ${log_file_path}=${EMPTY}
George Keishing30c12ff2016-09-02 10:25:29 -0500408
David Shawba2d2c22017-01-23 16:56:38 -0600409 # Description of arguements:
410 # file_path The caller's candidate value. If this value is ${EMPTY}, this
411 # keyword will compose a file path name. Otherwise, this
412 # keyword will use the caller's file_path value. In either
413 # case, the value will be returned.
Gunnar Mills9c760342016-12-08 10:12:06 -0600414
David Shawba2d2c22017-01-23 16:56:38 -0600415 ${default_file_path}= Catenate /tmp/${OPENBMC_HOST}_os_console
416 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
417 ... ${default_file_path} ${log_file_path}
Michael Walsh01bd3682017-01-10 11:21:05 -0600418
David Shawba2d2c22017-01-23 16:56:38 -0600419 [Return] ${log_file_path}
Gunnar Mills9c760342016-12-08 10:12:06 -0600420
David Shawba2d2c22017-01-23 16:56:38 -0600421Create OS Console Command String
422 [Documentation] Return a command string to start OS console logging.
Gunnar Mills9c760342016-12-08 10:12:06 -0600423
David Shawba2d2c22017-01-23 16:56:38 -0600424 # First make sure that the ssh_pw program is available.
425 ${cmd_buf}= Catenate which ssh_pw 2>&1
426 Rdpissuing ${cmd_buf}
427 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
428 Rdpvars rc output
429 Should Be Equal ${rc} ${0} msg=${output}\n
Gunnar Mills9c760342016-12-08 10:12:06 -0600430
David Shawba2d2c22017-01-23 16:56:38 -0600431 ${cmd_buf}= Catenate ssh_pw ${OPENBMC_PASSWORD} -p 2200
George Keishing1f9ec7f2017-06-06 08:59:19 -0500432 ... -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST}
George Keishing30c12ff2016-09-02 10:25:29 -0500433
David Shawba2d2c22017-01-23 16:56:38 -0600434 [Return] ${cmd_buf}
George Keishing30c12ff2016-09-02 10:25:29 -0500435
436Stop SOL Console Logging
David Shawba2d2c22017-01-23 16:56:38 -0600437 [Documentation] Stop system console logging and return log output.
438 [Arguments] ${log_file_path}=${EMPTY} ${targ_file_path}=${EMPTY}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500439 ... ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600440
441 # If there are muliple system console processes, they will all be stopped.
442 # If there is no existing log file this keyword will return an error
443 # message to that effect (and write that message to targ_file_path, if
444 # specified).
445 # NOTE: This keyword will not fail if there is no running system console
446 # process.
Michael Walsh01bd3682017-01-10 11:21:05 -0600447
448 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600449 # log_file_path The file path that was used to call "Start SOL
450 # Console Logging". See that keyword (above) for details.
451 # targ_file_path If specified, the file path to which the source
452 # file path (i.e. "log_file_path") should be copied.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500453 # return_data If this is set to ${1}, this keyword will return the SOL
454 # data to the caller as a unicode string.
George Keishing30c12ff2016-09-02 10:25:29 -0500455
David Shawba2d2c22017-01-23 16:56:38 -0600456 ${log_file_path}= Create OS Console File Path ${log_file_path}
457 # Find the pid of the active system console logging session (if any).
458 ${search_string}= Create OS Console Command String
459 ${cmd_buf}= Catenate echo $(ps -ef | egrep '${search_string}'
460 ... | egrep -v grep | cut -c10-14)
461 Rdpissuing ${cmd_buf}
462 ${rc} ${os_con_pid}= Run And Return Rc And Output ${cmd_buf}
463 Rdpvars os_con_pid
464 # If rc is not zero it just means that there is no OS Console process
465 # running.
George Keishing30c12ff2016-09-02 10:25:29 -0500466
David Shawba2d2c22017-01-23 16:56:38 -0600467 ${cmd_buf}= Catenate kill -9 ${os_con_pid}
468 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpissuing ${cmd_buf}
469 ${rc} ${output}= Run Keyword If '${os_con_pid}' != '${EMPTY}'
470 ... Run And Return Rc And Output ${cmd_buf}
471 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpvars rc output
George Keishing30c12ff2016-09-02 10:25:29 -0500472
Michael Walsh01bd3682017-01-10 11:21:05 -0600473 Run Keyword If '${targ_file_path}' != '${EMPTY}'
David Shawba2d2c22017-01-23 16:56:38 -0600474 ... Run Keyword And Ignore Error
475 ... Copy File ${log_file_path} ${targ_file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500476
Michael Walsh5f3f4142017-05-22 17:09:47 -0500477 ${output}= Set Variable ${EMPTY}
478 ${loc_quiet}= Evaluate ${debug}^1
479 ${rc} ${output}= Run Keyword If '${return_data}' == '${1}'
480 ... Cmd Fnc cat ${log_file_path} quiet=${loc_quiet} print_output=${0}
481
David Shawba2d2c22017-01-23 16:56:38 -0600482 [Return] ${output}
483
484Start SOL Console Logging
485 [Documentation] Start system console log to file.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500486 [Arguments] ${log_file_path}=${EMPTY} ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600487
488 # This keyword will first call "Stop SOL Console Logging". Only then will
489 # it start SOL console logging. The data returned by "Stop SOL Console
490 # Logging" will in turn be returned by this keyword.
491
492 # Description of arguments:
Michael Walsh5f3f4142017-05-22 17:09:47 -0500493 # log_file_path The file path to which system console log data should be
494 # written. Note that this path is taken to be a location
495 # on the machine where this program is running rather than
496 # on the Open BMC system.
497 # return_data If this is set to ${1}, this keyword will return any SOL
498 # data to the caller as a unicode string.
David Shawba2d2c22017-01-23 16:56:38 -0600499
500 ${log_file_path}= Create OS Console File Path ${log_file_path}
501
502 ${log_output}= Stop SOL Console Logging ${log_file_path}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500503 ... return_data=${return_data}
David Shawba2d2c22017-01-23 16:56:38 -0600504
505 # Validate by making sure we can create the file. Problems creating the
506 # file would not be noticed by the subsequent ssh command because we fork
507 # the command.
508 Create File ${log_file_path}
509 ${sub_cmd_buf}= Create OS Console Command String
510 # Routing stderr to stdout so that any startup error text will go to the
511 # output file.
512 ${cmd_buf}= Catenate ${sub_cmd_buf} > ${log_file_path} 2>&1 &
513 Rdpissuing ${cmd_buf}
514 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
515 # Because we are forking this command, we essentially will never get a
516 # non-zero return code or any output.
517 Should Be Equal ${rc} ${0}
518
519 [Return] ${log_output}
George Keishing30c12ff2016-09-02 10:25:29 -0500520
521Get Time Stamp
522 [Documentation] Get the current time stamp data
523 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500524 [Return] ${cur_time}
George Keishing30c12ff2016-09-02 10:25:29 -0500525
George Keishing1b150202016-09-29 08:51:58 -0500526
527Verify BMC State
528 [Documentation] Get the BMC state and verify if the current
529 ... BMC state is as expected.
530 [Arguments] ${expected}
531
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600532 ${current}= Get BMC State Deprecated
George Keishing8db0e1b2016-10-20 13:46:54 -0500533 Should Contain ${expected} ${current}
George Keishing1b150202016-09-29 08:51:58 -0500534
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500535Start Journal Log
536 [Documentation] Start capturing journal log to a file in /tmp using
537 ... journalctl command. By default journal log is collected
538 ... at /tmp/journal_log else user input location.
539 ... The File is appended with datetime.
540 [Arguments] ${file_path}=/tmp/journal_log
541
542 Open Connection And Log In
543
544 ${cur_time}= Get Time Stamp
545 Set Global Variable ${LOG_TIME} ${cur_time}
546 Start Command
547 ... journalctl -f > ${file_path}-${LOG_TIME}
548 Log Journal Log Started: ${file_path}-${LOG_TIME}
549
David Shawba2d2c22017-01-23 16:56:38 -0600550
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500551Stop Journal Log
552 [Documentation] Stop journalctl process if its running.
553 ... By default return log from /tmp/journal_log else
554 ... user input location.
555 [Arguments] ${file_path}=/tmp/journal_log
556
557 Open Connection And Log In
558
559 ${rc}=
560 ... Execute Command
561 ... ps ax | grep journalctl | grep -v grep
562 ... return_stdout=False return_rc=True
563
564 Return From Keyword If '${rc}' == '${1}'
565 ... No journal log process running
566
567 ${output} ${stderr}=
568 ... Execute Command killall journalctl
569 ... return_stderr=True
570 Should Be Empty ${stderr}
571
572 ${journal_log} ${stderr}=
573 ... Execute Command
574 ... cat ${file_path}-${LOG_TIME}
575 ... return_stderr=True
576 Should Be Empty ${stderr}
577
578 Log ${journal_log}
579
580 Execute Command rm ${file_path}-${LOG_TIME}
581
582 [Return] ${journal_log}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500583
584Mac Address To Hex String
585 [Documentation] Converts MAC address into hex format.
586 ... Example
587 ... Given the following MAC: 00:01:6C:80:02:78
588 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
589 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600590 ... i_macaddress MAC address in the following format
591 ... 00:01:6C:80:02:78
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500592 [Arguments] ${i_macaddress}
593
594 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600595 [Return] ${mac_hex}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500596
597IP Address To Hex String
598 [Documentation] Converts IP address into hex format.
599 ... Example:
600 ... Given the following IP: 10.3.164.100
601 ... This keyword will return: 0xa 0x3 0xa4 0xa0
602 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600603 ... i_ipaddress IP address in the following format
604 ... 10.10.10.10
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500605 [Arguments] ${i_ipaddress}
606
607 @{ip}= Split String ${i_ipaddress} .
608 ${index}= Set Variable ${0}
609
610 :FOR ${item} IN @{ip}
611 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes
612 \ Set List Value ${ip} ${index} ${hex}
613 \ ${index}= Set Variable ${index + 1}
614 ${ip_hex}= Catenate @{ip}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600615 [Return] ${ip_hex}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600616
617BMC CPU Performance Check
618 [Documentation] Minimal 10% of proc should be free in this instance
619
620 ${bmc_cpu_usage_output} ${stderr}= Execute Command ${bmc_cpu_usage_cmd}
621 ... return_stderr=True
622 Should be empty ${stderr}
623 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} %
624 Should be true ${bmc_cpu_percentage} < 90
625
626BMC Mem Performance Check
627 [Documentation] Minimal 10% of memory should be free in this instance
628
629 ${bmc_mem_free_output} ${stderr}= Execute Command ${bmc_mem_free_cmd}
630 ... return_stderr=True
631 Should be empty ${stderr}
632
633 ${bmc_mem_total_output} ${stderr}= Execute Command ${bmc_mem_total_cmd}
634 ... return_stderr=True
635 Should be empty ${stderr}
636
637 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100
638 ${bmc_mem_percentage}= Evaluate
639 ... ${bmc_mem_percentage}/${bmc_mem_total_output}
640 Should be true ${bmc_mem_percentage} > 10
641
Sivas SRRaca55712016-12-21 04:32:35 -0600642BMC File System Usage Check
643 [Documentation] Check the file system space. None should be 100% full
Sivas SRR352bc162017-02-13 22:12:29 -0600644 ... except /run/initramfs/ro
Sivas SRRaca55712016-12-21 04:32:35 -0600645 ${bmc_fs_usage_output} ${stderr}= Execute Command
646 ... ${bmc_file_system_usage_cmd} return_stderr=True
647 Should Be Empty ${stderr}
648 Should Be True ${bmc_fs_usage_output}==0
649
Sivas SRRea85d1f2016-11-13 22:44:28 -0600650Check BMC CPU Performance
651 [Documentation] Minimal 10% of proc should be free in 3 sample
652 :FOR ${var} IN Range 1 4
653 \ BMC CPU Performance check
654
655Check BMC Mem Performance
656 [Documentation] Minimal 10% of memory should be free
657
658 :FOR ${var} IN Range 1 4
659 \ BMC Mem Performance check
660
Sivas SRRaca55712016-12-21 04:32:35 -0600661Check BMC File System Performance
662 [Documentation] Check for file system usage for 4 times
663
664 :FOR ${var} IN Range 1 4
665 \ BMC File System Usage check
666
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500667Get URL List
668 [Documentation] Return list of URLs under given URL.
669 [Arguments] ${openbmc_url}
670 # Description of argument(s):
Michael Walsh5f3f4142017-05-22 17:09:47 -0500671 # openbmc_url URL for list operation (e.g.
672 # /xyz/openbmc_project/inventory).
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500673
674 ${url_list}= Read Properties ${openbmc_url}/list
675 [Return] ${url_list}
676
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600677Get Endpoint Paths
678 [Documentation] Returns all url paths ending with given endpoint
679 ... Example:
680 ... Given the following endpoint: cpu
Michael Walsh01bd3682017-01-10 11:21:05 -0600681 ... This keyword will return: list of all urls ending with
682 ... cpu -
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600683 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
684 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
685 ... Description of arguments:
686 ... path URL path for enumeration
687 ... endpoint string for which url path ending
688 [Arguments] ${path} ${endpoint}
689
690 ${resp}= Read Properties ${path}/enumerate timeout=30
691 log Dictionary ${resp}
692
693 ${list}= Get Dictionary Keys ${resp}
694 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9]*$
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600695 [Return] ${resp}
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500696
697Check Zombie Process
698 [Documentation] Check if any defunct process exist or not on BMC
Michael Walsh01bd3682017-01-10 11:21:05 -0600699 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500700 ... return_stderr=True return_rc=True
701 Should Be True ${count}==0
702 Should Be Empty ${stderr}
George Keishing5327d012016-12-08 08:43:29 -0600703
704Prune Journal Log
705 [Documentation] Prune archived journal logs.
706 [Arguments] ${vacuum_size}=1M
707
708 # This keyword can be used to prevent the journal
709 # log from filling up the /run filesystem.
710 # This command will retain only the latest logs
711 # of the user specified size.
712
713 Open Connection And Log In
714 ${output} ${stderr} ${rc}=
715 ... Execute Command
716 ... journalctl --vacuum-size=${vacuum_size}
717 ... return_stderr=True return_rc=True
718
719 Should Be Equal ${rc} ${0} msg=${stderr}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600720
721Set BMC Power Policy
722 [Documentation] Set the given BMC power policy.
723 [arguments] ${policy}
724
725 ${valueDict}= create dictionary data=${policy}
726 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
727 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
728 Should Be Equal ${currentPolicy} ${policy}
George Keishingcce9df22017-01-24 06:19:33 -0600729
George Keishing4d6f3d62017-02-06 09:50:41 -0600730Get System Power Policy
731 [Documentation] Get the BMC power policy.
732 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
733 [Return] ${currentPolicy}
George Keishingcce9df22017-01-24 06:19:33 -0600734
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600735Get Auto Reboot
736 [Documentation] Returns auto reboot setting.
Sridevi Ramesh4dbe6592017-04-06 01:47:52 -0500737 ${setting}= Read Attribute ${HOST_SETTING} auto_reboot
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600738 [Return] ${setting}
739
740
741Set Auto Reboot
742 [Documentation] Set the given auto reboot setting.
743 [Arguments] ${setting}
744 # setting auto reboot's setting, i.e. yes or no
745
746 ${valueDict}= Set Variable ${setting}
747 ${data}= Create Dictionary data=${valueDict}
Sridevi Ramesh4dbe6592017-04-06 01:47:52 -0500748 Write Attribute ${HOST_SETTING} auto_reboot data=${data}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600749 ${current_setting}= Get Auto Reboot
750 Should Be Equal ${current_setting} ${setting}
751
752
George Keishingcce9df22017-01-24 06:19:33 -0600753Set BMC Reset Reference Time
754 [Documentation] Set current boot time as a reference and increment
George Keishing80dd5af2017-02-08 07:01:25 -0600755 ... boot count.
George Keishingcce9df22017-01-24 06:19:33 -0600756
757 ${cur_btime}= Get BMC Boot Time
George Keishing80dd5af2017-02-08 07:01:25 -0600758 Run Keyword If ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
George Keishingcce9df22017-01-24 06:19:33 -0600759 ... Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishing80dd5af2017-02-08 07:01:25 -0600760 ... ELSE IF ${cur_btime} > ${BOOT_TIME}
761 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishingcce9df22017-01-24 06:19:33 -0600762 ... AND
763 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
764
George Keishingcce9df22017-01-24 06:19:33 -0600765Get BMC Boot Time
766 [Documentation] Get boot time from /proc/stat.
767
768 Open Connection And Log In
769 ${output} ${stderr}=
770 ... Execute Command egrep '^btime ' /proc/stat | cut -f 2 -d ' '
771 ... return_stderr=True
772 Should Be Empty ${stderr}
773 ${btime}= Convert To Integer ${output}
774 [Return] ${btime}
George Keishingede30002017-02-02 09:33:07 -0600775
George Keishingede30002017-02-02 09:33:07 -0600776Execute Command On BMC
777 [Documentation] Execute given command on BMC and return output.
778 [Arguments] ${command}
779 ${stdout} ${stderr}= Execute Command ${command} return_stderr=True
780 Should Be Empty ${stderr}
781 [Return] ${stdout}
David Shawba2d2c22017-01-23 16:56:38 -0600782
Sridevi Rameshea36b412017-03-09 04:08:02 -0600783
George Keishing7a520222017-02-27 09:44:30 -0600784Enable Core Dump On BMC
785 [Documentation] Enable core dump collection.
786 Open Connection And Log In
787 ${core_pattern}= Execute Command On BMC
788 ... echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
789 Should Be Equal As Strings ${core_pattern} /tmp/core_%e.%p
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600790
Sivas SRR01262bd2017-03-19 10:00:23 -0500791Get Number Of BMC Core Dump Files
792 [Documentation] Get number of core dump files on BMC.
793 Open Connection And Log In
794 ${num_of_core_dump}= Execute Command
795 ... ls /tmp/core* 2>/dev/null | wc -l
796 [Return] ${num_of_core_dump}
797
798Set Core Dump File Size Unlimited
799 [Documentation] Set core dump file size to unlimited.
800 Open Connection And Log In
801 Execute Command On BMC
802 ... ulimit -c unlimited
803
804Check For Core Dumps
805 [Documentation] Check for any core dumps exist.
806 ${output}= Get Number Of BMC Core Dump Files
807 Run Keyword If ${output} > 0
808 ... Log **Warning** BMC core dump files exist level=WARN
809
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600810Trigger Host Watchdog Error
811 [Documentation] Inject host watchdog error using BMC.
812 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Michael Walshb5839d02017-04-12 16:11:20 -0500813 # Description of argument(s):
814 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
815 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600816 # sleep_time Time delay for host watchdog error to get injected.
817 # Default is 5 seconds.
818
819 Execute Command On BMC
820 ... /usr/sbin/mapper call /org/openbmc/watchdog/host0 org.openbmc.Watchdog set i ${milliseconds}
821 Execute Command On BMC
822 ... /usr/sbin/mapper call /org/openbmc/watchdog/host0 org.openbmc.Watchdog start
823 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500824
825Login To OS Host
826 [Documentation] Login to OS Host.
827 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
828 ... ${os_password}=${OS_PASSWORD}
829 # Desription of arguments:
830 # ${os_host} IP address of the OS Host.
831 # ${os_username} OS Host Login user name.
832 # ${os_password} OS Host Login passwrd.
833
834 ${os_state}= Run Keyword And Return Status Ping Host ${os_host}
835 Run Keyword If '${os_state}' == 'False'
836 ... Run Keywords Initiate Host Reboot AND
837 ... Is Host Running AND
838 ... Wait for OS ${os_host} ${os_username} ${os_password}
839
840 Open Connection ${os_host}
Sridevi Rameshea36b412017-03-09 04:08:02 -0600841 ${resp}= Login ${os_username} ${os_password}
842 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -0500843
844Configure Initial Settings
845 [Documentation] Restore old IP and route.
846 ... This keyword requires initial settings viz IP address,
847 ... Network Mask, default gatway and serial console IP and port
848 ... information which should be provided in command line.
849
Michael Walshb5839d02017-04-12 16:11:20 -0500850 [Arguments] ${host}=${OPENBMC_HOST} ${mask}=${NET_MASK}
851 ... ${gw_ip}=${GW_IP}
Prashanth Katti884ee062017-03-16 05:05:03 -0500852
Michael Walshb5839d02017-04-12 16:11:20 -0500853 # Open telnet connection and ignore the error, in case telnet session is
854 # already opened by the program calling this keyword.
Prashanth Katti884ee062017-03-16 05:05:03 -0500855
856 Run Keyword And Ignore Error Open Telnet Connection to BMC Serial Console
857 Telnet.write ifconfig eth0 ${host} netmask ${mask}
858 Telnet.write route add default gw ${gw_ip}
George Keishingd05b1082017-03-24 05:27:32 -0500859
860Install Debug Tarball On BMC
George Keishing55441822017-05-18 14:17:59 -0500861 [Documentation] Copy the debug tar file to BMC and install.
862 [Arguments] ${tarball_file_path}=${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz
863 ... ${targ_tarball_dir_path}=/home/root/tarball/
George Keishingd05b1082017-03-24 05:27:32 -0500864
George Keishing55441822017-05-18 14:17:59 -0500865 # Description of arguments:
866 # tarball_file_path Path of the debug tarball file.
867 # The tar file is downloaded from the build page
868 # https://openpower.xyz/job/openbmc-build/
869 # obmc-phosphor-debug-tarball-witherspoon.tar.xz
870 #
871 # targ_tarball_dir_path The directory path where the tarball is to be
872 # installed.
873
874 OperatingSystem.File Should Exist ${tarball_file_path}
875 ... msg=${tarball_file_path} doesn't exist.
876
877 # Upload the file to BMC.
George Keishingd05b1082017-03-24 05:27:32 -0500878 Import Library SCPLibrary WITH NAME scp
879 Open Connection for SCP
George Keishing55441822017-05-18 14:17:59 -0500880 scp.Put File ${tarball_file_path} /tmp/debug-tarball.tar.xz
881
882 # Create tarball directory and install.
George Keishingd05b1082017-03-24 05:27:32 -0500883 Open Connection And Log In
George Keishing55441822017-05-18 14:17:59 -0500884 Execute Command On BMC mkdir -p ${targ_tarball_dir_path}
885 Execute Command On BMC
886 ... tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path}
887
888 # Create symlink to callout-test binary.
889 Execute Command On BMC
890 ... ln -s ${targ_tarball_dir_path}/bin/callout-test /usr/bin/callout-test
891
George Keishing4fc998b2017-05-26 05:24:12 -0500892 # Create symlink to logging-test binary.
893 Execute Command On BMC
894 ... ln -s ${targ_tarball_dir_path}/bin/logging-test /usr/bin/logging-test
895
George Keishingd05b1082017-03-24 05:27:32 -0500896 # Remove the tarball file from BMC
897 Execute Command On BMC rm /tmp/debug-tarball.tar.xz
898
George Keishing55441822017-05-18 14:17:59 -0500899
Sweta Potthuri025e0122017-02-21 00:42:48 -0600900Get BMC Boot Count
901 [Documentation] Get BMC boot count based on boot time.
902 ${cur_btime}= Get BMC Boot Time
903
904 # Set global variable BOOT_TIME to current boot time if current boot time
905 # is changed. Also increase value of global variable BOOT_COUNT by 1.
906 Run Keyword If ${cur_btime} > ${BOOT_TIME}
907 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
908 ... AND
909 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
910 [Return] ${BOOT_COUNT}
911
912Set BMC Boot Count
913 [Documentation] Set BMC boot count to given value.
914 [Arguments] ${count}
915
916 # Description of arguments:
917 # count boot count value.
918 ${cur_btime}= Get BMC Boot Time
919
920 # Set global variable BOOT_COUNT to given value.
921 Set Global Variable ${BOOT_COUNT} ${count}
922
923 # Set BOOT_TIME variable to current boot time.
924 Set Global Variable ${BOOT_COUNT} ${count}
Michael Walsh689fbbe2017-04-04 17:58:03 -0500925
Sunil Macd110a2017-05-23 04:14:32 -0500926Check And Reset MAC
927 [Documentation] Update BMC with user input MAC address.
928 [Arguments] ${mac_address}=${MAC_ADDRESS}
929
930 # Description of argument(s):
931 # mac_address The mac address (e.g. 00:01:6c:80:02:28).
932
933 Should Not Be Empty ${mac_address}
934 Open Connection And Log In
935 ${bmc_mac_addr}= Execute Command On BMC cat /sys/class/net/eth0/address
936 Run Keyword If '${mac_address}' != '${bmc_mac_addr}'
937 ... Set MAC Address
938
939Set MAC Address
940 [Documentation] Update eth0 with input MAC address.
941 [Arguments] ${mac_address}=${MAC_ADDRESS}
942
943 # Description of argument(s):
944 # mac_address The mac address (e.g. 00:01:6c:80:02:28).
945 Write fw_setenv ethaddr ${mac_address}
946 Run Key U OBMC Boot Test \ OBMC Reboot (off)
947 ${bmc_mac_addr}= Execute Command On BMC cat /sys/class/net/eth0/address
948 Should Be Equal ${bmc_mac_addr} ${mac_address}
949
Michael Walsh689fbbe2017-04-04 17:58:03 -0500950###############################################################################
951Delete Error logs
952 [Documentation] Delete error logs.
953
954 # The REST method to delete error openbmc/openbmc#1327
955 # until then using logging restart.
956 Open Connection And Log In
957 Execute Command On BMC
958 ... systemctl restart xyz.openbmc_project.Logging.service
959 Sleep 10s reason=Wait for logging service to restart properly.
George Keishingdb34c2f2017-04-18 13:20:25 -0500960
961###############################################################################
962Delete Error log Entry
963 [Documentation] Delete error log entry.
964 [Arguments] ${entry_path}
965
966 # Description of argument(s):
967 # entry_path Delete an error log entry.
968 # Ex. /xyz/openbmc_project/logging/entry/1
969
970 ${data}= Create Dictionary data=@{EMPTY}
971 ${resp}= Openbmc Delete Request ${entry_path} data=${data}
972 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Rahul Maheshwari43be6932017-05-01 02:37:06 -0500973
974
975Get LED State XYZ
976 [Documentation] Returns state of given LED.
977 [Arguments] ${led_name}
978 # Description of argument(s):
979 # led_name Name of LED
980
981 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
982 [Return] ${state}