blob: cf5ee7bc3e73c88ef7eb3817723c2e6c2fa4de33 [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
Michael Walsh391ba9b2017-08-24 11:36:24 -05005Library String
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
Michael Walshe53e47a2017-06-30 17:03:24 -050013Library bmc_ssh_utils.py
Michael Walshfdc5ced2017-08-17 13:15:15 -050014Library utils.py
Chris Austenb29d2e82016-06-07 12:25:35 -050015
16*** Variables ***
Sivas SRRd97aa9c2017-05-22 11:19:25 -050017${pflash_cmd} /usr/sbin/pflash -r /dev/stdout -P VERSION
Chris Austenb29d2e82016-06-07 12:25:35 -050018${SYSTEM_SHUTDOWN_TIME} ${5}
Michael Walsha6723f22016-11-22 11:12:01 -060019${dbuscmdBase}
George Keishing85ca05e2016-11-30 09:47:18 -060020... dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host
Michael Walsha6723f22016-11-22 11:12:01 -060021${dbuscmdGet}
George Keishing9485af92017-01-04 10:21:43 -060022... ${SETTINGS_URI}host0 org.freedesktop.DBus.Properties.Get
George Keishing85ca05e2016-11-30 09:47:18 -060023# Enable when ready with openbmc/openbmc-test-automation#203
24#${dbuscmdString}= string:"xyz.openbmc_project.settings.Host" string:
Michael Walsha6723f22016-11-22 11:12:01 -060025${dbuscmdString}= string:"org.openbmc.settings.Host" string:
26
27# Assign default value to QUIET for programs which may not define it.
28${QUIET} ${0}
Sivas SRRea85d1f2016-11-13 22:44:28 -060029${bmc_mem_free_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4
30${bmc_mem_total_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2
31${bmc_cpu_usage_cmd}= top -n 1 | grep CPU: | cut -c 7-9
Sridevi Ramesh1699d372016-12-06 00:20:22 -060032${HOST_SETTING} ${SETTINGS_URI}host0
Sivas SRR352bc162017-02-13 22:12:29 -060033# /run/initramfs/ro associate filesystem should be 100% full always
Sivas SRRaca55712016-12-21 04:32:35 -060034${bmc_file_system_usage_cmd}=
Sivas SRR352bc162017-02-13 22:12:29 -060035... df -h | grep -v /run/initramfs/ro | cut -c 52-54 | grep 100 | wc -l
Chris Austenb29d2e82016-06-07 12:25:35 -050036
George Keishingcce9df22017-01-24 06:19:33 -060037${BOOT_TIME} ${0}
38${BOOT_COUNT} ${0}
Sweta Potthuri025e0122017-02-21 00:42:48 -060039${count} ${0}
Sivas SRR8254db62017-02-07 09:39:46 -060040${devicetree_base} /sys/firmware/devicetree/base/model
George Keishingcce9df22017-01-24 06:19:33 -060041
George Keishingb7c9b542017-05-23 08:19:58 -050042# Initialize default debug value to 0.
43${DEBUG} ${0}
44
Michael Walshfdc5ced2017-08-17 13:15:15 -050045# These variables are used to straddle between new and old methods of setting
46# values.
Michael Walshc972d4d2017-08-16 15:38:03 -050047${boot_prog_method} ${EMPTY}
48
Michael Walshfdc5ced2017-08-17 13:15:15 -050049${power_policy_setup} ${0}
50${bmc_power_policy_method} ${EMPTY}
51@{valid_power_policy_vars} RESTORE_LAST_STATE ALWAYS_POWER_ON
52... ALWAYS_POWER_OFF
53
Chris Austenb29d2e82016-06-07 12:25:35 -050054*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060055
Sivas SRRd97aa9c2017-05-22 11:19:25 -050056Verify PNOR Update
57 [Documentation] Verify that the PNOR is not corrupted.
58 # Example:
59 # FFS: Flash header not found. Code: 100
60 # Error 100 opening ffs !
61
62 Open Connection And Log In
63 ${pnor_info}= Execute Command On BMC ${pflash_cmd}
64 Should Not Contain Any ${pnor_info} Flash header not found Error
65
Sivas SRR8254db62017-02-07 09:39:46 -060066Get BMC System Model
67 [Documentation] Get the BMC model from the device tree.
68
Michael Walshe53e47a2017-06-30 17:03:24 -050069 ${bmc_model} ${stderr} ${rc}= BMC Execute Command
George Keishing90ab1772017-02-24 05:40:55 -060070 ... cat ${devicetree_base} | cut -d " " -f 1 return_stderr=True
Sivas SRR8254db62017-02-07 09:39:46 -060071 Should Be Empty ${stderr}
72 Should Not Be Empty ${bmc_model}
73 [Return] ${bmc_model}
74
75Verify BMC System Model
76 [Documentation] Verify the BMC model with ${OPENBMC_MODEL}.
77 [Arguments] ${bmc_model}
78
79 ${tmp_bmc_model}= Fetch From Right ${OPENBMC_MODEL} /
80 ${tmp_bmc_model}= Fetch From Left ${tmp_bmc_model} .
81 ${ret}= Run Keyword And Return Status Should Contain ${bmc_model}
82 ... ${tmp_bmc_model} ignore_case=True
83 [Return] ${ret}
84
Chris Austenb29d2e82016-06-07 12:25:35 -050085Wait For Host To Ping
root442f0ef2016-08-04 20:23:05 +000086 [Arguments] ${host} ${timeout}=${OPENBMC_REBOOT_TIMEOUT}min
87 ... ${interval}=5 sec
88
89 # host The DNS name or IP of the host to ping.
90 # timeout The amount of time after which attempts to ping cease.
91 # interval The amount of time in between attempts to ping.
92
93 Wait Until Keyword Succeeds ${timeout} ${interval} Ping Host ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -050094
95Ping Host
96 [Arguments] ${host}
George Keishing8a84f952016-08-25 04:54:53 -050097 Should Not Be Empty ${host} msg=No host provided
Michael Walsha6723f22016-11-22 11:12:01 -060098 ${RC} ${output}= Run and return RC and Output ping -c 4 ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -050099 Log RC: ${RC}\nOutput:\n${output}
100 Should be equal ${RC} ${0}
101
102Get Boot Progress
Michael Walshc972d4d2017-08-16 15:38:03 -0500103 [Documentation] Get the boot progress and return it.
Michael Walsha6723f22016-11-22 11:12:01 -0600104 [Arguments] ${quiet}=${QUIET}
105
Michael Walshc972d4d2017-08-16 15:38:03 -0500106 # Description of argument(s):
107 # quiet Indicates whether this keyword should run without any output to
108 # the console.
109
110 Set Boot Progress Method
111 ${state}= Run Keyword If '${boot_prog_method}' == 'New'
112 ... New Get Boot Progress quiet=${quiet}
113 ... ELSE
114 ... Old Get Boot Progress quiet=${quiet}
115
116 [Return] ${state}
117
118Set Boot Progress Method
119 [Documentation] Set the boot_prog_method to either 'Old' or 'New'.
120
121 # The boot progress data has moved from an 'org' location to an 'xyz'
122 # location. This keyword will determine whether the new method of getting
123 # the boot progress is valid and will set the global boot_prog_method
124 # variable accordingly. If boot_prog_method is already set (either by a
125 # prior call to this function or via a -v parm), this keyword will simply
126 # return.
127
128 # Note: There are interim builds that contain boot_progress in both the old
129 # and the new location values. It is nearly impossible for this keyword to
130 # determine whether the old boot_progress or the new one is active. When
131 # using such builds where the old boot_progress is active, the only recourse
132 # users will have is that they may specify -v boot_prog_method:Old to force
133 # old behavior on such builds.
134
135 Run Keyword If '${boot_prog_method}' != '${EMPTY}' Return From Keyword
136
137 ${new_status} ${new_value}= Run Keyword And Ignore Error
138 ... New Get Boot Progress
139 # If the new style read fails, the method must necessarily be "Old".
140 Run Keyword If '${new_status}' == 'PASS'
141 ... Run Keywords
142 ... Set Global Variable ${boot_prog_method} New AND
143 ... Rqpvars boot_prog_method AND
144 ... Return From Keyword
145
146 # Default method is "Old".
147 Set Global Variable ${boot_prog_method} Old
148 Rqpvars boot_prog_method
149
150Old Get Boot Progress
151 [Documentation] Get the boot progress the old way (via org location).
152 [Arguments] ${quiet}=${QUIET}
153
154 # Description of argument(s):
155 # quiet Indicates whether this keyword should run without any output to
156 # the console.
157
George Keishing85ca05e2016-11-30 09:47:18 -0600158 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
Michael Walsha6723f22016-11-22 11:12:01 -0600159 ... value quiet=${quiet}
Michael Walshc972d4d2017-08-16 15:38:03 -0500160
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600161 [Return] ${state}
Chris Austenb29d2e82016-06-07 12:25:35 -0500162
Michael Walshc972d4d2017-08-16 15:38:03 -0500163New Get Boot Progress
164 [Documentation] Get the boot progress the new way (via xyz location).
165 [Arguments] ${quiet}=${QUIET}
166
167 # Description of argument(s):
168 # quiet Indicates whether this keyword should run without any output to
169 # the console.
170
171 ${state}= Read Attribute ${HOST_STATE_URI} BootProgress quiet=${quiet}
172
173 [Return] ${state.rsplit('.', 1)[1]}
174
Chris Austenb29d2e82016-06-07 12:25:35 -0500175Is Power On
root442f0ef2016-08-04 20:23:05 +0000176 ${state}= Get Power State
177 Should be equal ${state} ${1}
Chris Austenb29d2e82016-06-07 12:25:35 -0500178
179Is Power Off
root442f0ef2016-08-04 20:23:05 +0000180 ${state}= Get Power State
181 Should be equal ${state} ${0}
Chris Austenb29d2e82016-06-07 12:25:35 -0500182
root442f0ef2016-08-04 20:23:05 +0000183Initiate Power On
184 [Documentation] Initiates the power on and waits until the Is Power On
185 ... keyword returns that the power state has switched to on.
Michael Walsha6723f22016-11-22 11:12:01 -0600186 [Arguments] ${wait}=${1}
187
Chris Austenb29d2e82016-06-07 12:25:35 -0500188 @{arglist}= Create List
189 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600190 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
Michael Walsha6723f22016-11-22 11:12:01 -0600191 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500192 should be equal as strings ${resp.status_code} ${HTTP_OK}
Chris Austenb29d2e82016-06-07 12:25:35 -0500193
Michael Walsha6723f22016-11-22 11:12:01 -0600194 # Does caller want to wait for power on status?
195 Run Keyword If '${wait}' == '${0}' Return From Keyword
196 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500197
root442f0ef2016-08-04 20:23:05 +0000198Initiate Power Off
199 [Documentation] Initiates the power off and waits until the Is Power Off
200 ... keyword returns that the power state has switched to off.
Chris Austenb29d2e82016-06-07 12:25:35 -0500201 @{arglist}= Create List
202 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600203 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
Michael Walsha6723f22016-11-22 11:12:01 -0600204 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500205 should be equal as strings ${resp.status_code} ${HTTP_OK}
Michael Walsha6723f22016-11-22 11:12:01 -0600206 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
Chris Austenb29d2e82016-06-07 12:25:35 -0500207
Michael Walsh81843772017-03-02 14:44:44 -0600208Initiate OS Host Power Off
209 [Documentation] Initiate an OS reboot.
210 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
211 ... ${os_password}=${OS_PASSWORD}
212
213 # Description of arguments:
214 # os_host The DNS name or IP of the OS.
215 # os_username The username to be used to sign in to the OS.
216 # os_password The password to be used to sign in to the OS.
217
Michael Walsh4549cd12017-09-07 18:02:36 -0500218 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
219 ... Set Variable shutdown
220 ... ELSE
221 ... Set Variable echo ${os_password} | sudo -S shutdown
222
223 ${output} ${stderr} ${rc}= OS Execute Command
224 ... ${cmd_buf} fork=${1}
Michael Walsh81843772017-03-02 14:44:44 -0600225
226Initiate OS Host Reboot
227 [Documentation] Initiate an OS reboot.
228 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
229 ... ${os_password}=${OS_PASSWORD}
230
Michael Walshf1a59fb2017-09-01 17:07:13 -0500231 # Description of argument(s):
232 # os_host The host name or IP address of the OS.
Michael Walsh81843772017-03-02 14:44:44 -0600233 # os_username The username to be used to sign in to the OS.
234 # os_password The password to be used to sign in to the OS.
235
Michael Walshf1a59fb2017-09-01 17:07:13 -0500236 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
237 ... Set Variable reboot
238 ... ELSE
239 ... Set Variable echo ${os_password} | sudo -S reboot
240
241 ${output} ${stderr} ${rc}= OS Execute Command
242 ... ${cmd_buf} fork=${1}
Michael Walsh81843772017-03-02 14:44:44 -0600243
244Initiate Auto Reboot
245 [Documentation] Initiate an auto reboot.
246
247 # Set the auto reboot policy.
Sweta Potthuri62a23572017-07-28 04:05:13 -0500248 Set Auto Reboot ${1}
Michael Walsh81843772017-03-02 14:44:44 -0600249 # Set the watchdog timer. Note: 5000 = milliseconds which is 5 seconds.
George Keishing37cfa6b2017-06-15 10:25:55 -0500250 Trigger Host Watchdog Error 5000
Michael Walsh81843772017-03-02 14:44:44 -0600251
Chris Austenb29d2e82016-06-07 12:25:35 -0500252Trigger Warm Reset
253 log to console "Triggering warm reset"
Michael Walsha6723f22016-11-22 11:12:01 -0600254 ${data}= create dictionary data=@{EMPTY}
George Keishing85ca05e2016-11-30 09:47:18 -0600255 ${resp}= openbmc post request
256 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
Chris Austenb29d2e82016-06-07 12:25:35 -0500257 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
George Keishingb3700812016-08-31 03:03:30 -0500258 ${session_active}= Check If warmReset is Initiated
259 Run Keyword If '${session_active}' == '${True}'
260 ... Fail msg=warm reset didn't occur
261
Chris Austenb29d2e82016-06-07 12:25:35 -0500262 Sleep ${SYSTEM_SHUTDOWN_TIME}min
Rahul Maheshwari5f253c42017-01-30 05:19:51 -0600263 Check If BMC Is Up
Michael Walsh49ab0f42016-07-20 11:44:33 -0500264
265Check OS
root442f0ef2016-08-04 20:23:05 +0000266 [Documentation] Attempts to ping the host OS and then checks that the host
267 ... OS is up by running an SSH command.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500268
269 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walsha6723f22016-11-22 11:12:01 -0600270 ... ${os_password}=${OS_PASSWORD} ${quiet}=${QUIET}
271 ... ${print_string}=${EMPTY}
Michael Walshac275512017-03-07 11:39:28 -0600272 [Teardown] SSHLibrary.Close Connection
Michael Walsh49ab0f42016-07-20 11:44:33 -0500273
274 # os_host The DNS name/IP of the OS host associated with our BMC.
275 # os_username The username to be used to sign on to the OS host.
276 # os_password The password to be used to sign on to the OS host.
Michael Walsha6723f22016-11-22 11:12:01 -0600277 # quiet Indicates whether this keyword should write to console.
278 # print_string A string to be printed before checking the OS.
279
280 rprint ${print_string}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500281
root442f0ef2016-08-04 20:23:05 +0000282 # Attempt to ping the OS. Store the return code to check later.
283 ${ping_rc}= Run Keyword and Return Status Ping Host ${os_host}
284
Michael Walshac275512017-03-07 11:39:28 -0600285 SSHLibrary.Open connection ${os_host}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500286
Michael Walsha6723f22016-11-22 11:12:01 -0600287 ${status} ${msg}= Run Keyword And Ignore Error Login ${os_username}
288 ... ${os_password}
289 ${err_msg1}= Sprint Error ${msg}
290 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
291 Run Keyword If '${status}' == 'FAIL' Fail msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500292 ${output} ${stderr} ${rc}= Execute Command uptime return_stderr=True
293 ... return_rc=True
294
Michael Walsha6723f22016-11-22 11:12:01 -0600295 ${temp_msg}= Catenate Could not execute a command on the operating
296 ... system.\n
297 ${err_msg1}= Sprint Error ${temp_msg}
298 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
299
300 # If the return code returned by "Execute Command" is non-zero, this
301 # keyword will fail.
302 Should Be Equal ${rc} ${0} msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500303 # We will likewise fail if there is any stderr data.
304 Should Be Empty ${stderr}
305
Michael Walsha6723f22016-11-22 11:12:01 -0600306 ${temp_msg}= Set Variable Could not ping the operating system.\n
307 ${err_msg1}= Sprint Error ${temp_msg}
308 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
309 # We will likewise fail if the OS did not ping, as we could SSH but not
310 # ping
311 Should Be Equal As Strings ${ping_rc} ${TRUE} msg=${err_msg}
root442f0ef2016-08-04 20:23:05 +0000312
Michael Walsh49ab0f42016-07-20 11:44:33 -0500313Wait for OS
314 [Documentation] Waits for the host OS to come up via calls to "Check OS".
315 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
316 ... ${os_password}=${OS_PASSWORD} ${timeout}=${OS_WAIT_TIMEOUT}
Michael Walsha6723f22016-11-22 11:12:01 -0600317 ... ${quiet}=${0}
318 [Teardown] rprintn
Michael Walsh49ab0f42016-07-20 11:44:33 -0500319
320 # os_host The DNS name or IP of the OS host associated with our
321 # BMC.
322 # os_username The username to be used to sign on to the OS host.
323 # os_password The password to be used to sign on to the OS host.
324 # timeout The timeout in seconds indicating how long you're
325 # willing to wait for the OS to respond.
Michael Walsha6723f22016-11-22 11:12:01 -0600326 # quiet Indicates whether this keyword should write to console.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500327
328 # The interval to be used between calls to "Check OS".
329 ${interval}= Set Variable 5
330
Michael Walsha6723f22016-11-22 11:12:01 -0600331 ${message}= Catenate Checking every ${interval} seconds for up to
332 ... ${timeout} seconds for the operating system to communicate.
333 rqprint_timen ${message}
334
Michael Walsh49ab0f42016-07-20 11:44:33 -0500335 Wait Until Keyword Succeeds ${timeout} sec ${interval} Check OS
336 ... ${os_host} ${os_username} ${os_password}
Michael Walsha6723f22016-11-22 11:12:01 -0600337 ... print_string=\#
338
339 rqprintn
340
341 rqprint_timen The operating system is now communicating.
root442f0ef2016-08-04 20:23:05 +0000342
root442f0ef2016-08-04 20:23:05 +0000343
344Get Power State
345 [Documentation] Returns the power state as an integer. Either 0 or 1.
Michael Walsha6723f22016-11-22 11:12:01 -0600346 [Arguments] ${quiet}=${QUIET}
347
root442f0ef2016-08-04 20:23:05 +0000348 @{arglist}= Create List
349 ${args}= Create Dictionary data=@{arglist}
Michael Walsha6723f22016-11-22 11:12:01 -0600350
George Keishing85ca05e2016-11-30 09:47:18 -0600351 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
Michael Walsha6723f22016-11-22 11:12:01 -0600352 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000353 Should be equal as strings ${resp.status_code} ${HTTP_OK}
354 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600355 [Return] ${content["data"]}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500356
357Clear BMC Record Log
358 [Documentation] Clears all the event logs on the BMC. This would be
359 ... equivalent to ipmitool sel clear.
360 @{arglist}= Create List
361 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600362 ${resp}= Call Method
363 ... ${OPENBMC_BASE_URI}records/events/ clear data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500364 should be equal as strings ${resp.status_code} ${HTTP_OK}
365
366Copy PNOR to BMC
367 Import Library SCPLibrary WITH NAME scp
368 Open Connection for SCP
369 Log Copying ${PNOR_IMAGE_PATH} to /tmp
370 scp.Put File ${PNOR_IMAGE_PATH} /tmp
371
372Flash PNOR
373 [Documentation] Calls flash bios update method to flash PNOR image
Gunnar Mills38032802016-12-12 13:43:40 -0600374 [Arguments] ${pnor_image}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500375 @{arglist}= Create List ${pnor_image}
376 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600377 ${resp}= Call Method ${OPENBMC_BASE_URI}control/flash/bios/ update
Michael Walsha6723f22016-11-22 11:12:01 -0600378 ... data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500379 should be equal as strings ${resp.status_code} ${HTTP_OK}
380 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
381
382Get Flash BIOS Status
383 [Documentation] Returns the status of the flash BIOS API as a string. For
384 ... example 'Flashing', 'Flash Done', etc
George Keishing85ca05e2016-11-30 09:47:18 -0600385 ${data}= Read Properties ${OPENBMC_BASE_URI}control/flash/bios
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600386 [Return] ${data['status']}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500387
388Is PNOR Flashing
389 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
390 ... flashing has started.
391 ${status}= Get Flash BIOS Status
Rahul Maheshwari449dfb72017-05-08 02:06:48 -0500392 Should Contain ${status} Flashing
Jay Azurine4c52eb2016-08-16 20:51:10 -0500393
394Is PNOR Flash Done
395 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
396 ... PNOR flashing has completed.
Leah McNutt9ba32272016-11-17 15:48:39 +0000397 ${status}= Get Flash BIOS Status
Jay Azurine4c52eb2016-08-16 20:51:10 -0500398 should be equal as strings ${status} Flash Done
399
George Keishing5e870cd2016-08-24 10:05:47 -0500400
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600401Is OS Starting
402 [Documentation] Check if boot progress is OS starting.
403 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500404 Should Be Equal ${boot_progress} OSStart
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600405
George Keishing0af24412017-03-10 13:33:23 -0600406Is OS Off
407 [Documentation] Check if boot progress is "Off".
408 ${boot_progress}= Get Boot Progress
409 Should Be Equal ${boot_progress} Off
410
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500411Get Boot Progress To OS Starting State
412 [Documentation] Get the system to a boot progress state of 'FW Progress,
413 ... Starting OS'.
414
415 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500416 Run Keyword If '${boot_progress}' == 'OSStart'
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500417 ... Log Host is already in OS starting state
418 ... ELSE
419 ... Run Keywords Initiate Host PowerOff AND Initiate Host Boot
420 ... AND Wait Until Keyword Succeeds 10 min 10 sec Is OS Starting
421
George Keishing5e870cd2016-08-24 10:05:47 -0500422Verify Ping and REST Authentication
Michael Walsha6723f22016-11-22 11:12:01 -0600423 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500424 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -0500425 Run Keyword If '${l_ping}' == '${False}'
426 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500427
Michael Walsha6723f22016-11-22 11:12:01 -0600428 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500429 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -0500430 Run Keyword If '${l_rest}' == '${False}'
431 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500432
433 # Just to make sure the SSH is working for SCP
434 Open Connection And Log In
435 ${system} ${stderr}= Execute Command hostname return_stderr=True
436 Should Be Empty ${stderr}
437
George Keishingc4d3dc02016-09-19 03:45:55 -0500438Check If BMC is Up
439 [Documentation] Wait for Host to be online. Checks every X seconds
440 ... interval for Y minutes and fails if timed out.
441 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -0600442 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -0500443 ... ${interval}=10 sec
444
445 Wait Until Keyword Succeeds
446 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
447
George Keishingb3700812016-08-31 03:03:30 -0500448
449Check If warmReset is Initiated
450 [Documentation] Ping would be still alive, so try SSH to connect
451 ... if fails the ports are down indicating reboot
452 ... is in progress
George Keishing3c05d352016-12-13 06:54:50 -0600453
454 # Warm reset adds 3 seconds delay before forcing reboot
455 # To minimize race conditions, we wait for 7 seconds
456 Sleep 7s
George Keishingb3700812016-08-31 03:03:30 -0500457 ${alive}= Run Keyword and Return Status
458 ... Open Connection And Log In
459 Return From Keyword If '${alive}' == '${False}' ${False}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600460 [Return] ${True}
George Keishingb3700812016-08-31 03:03:30 -0500461
George Keishing06ae4aa2016-08-30 01:41:28 -0500462Flush REST Sessions
463 [Documentation] Removes all the active session objects
464 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500465
Sivas SRRe1143ae2016-08-26 22:31:02 -0500466Initialize DBUS cmd
467 [Documentation] Initialize dbus string with property string to extract
Gunnar Mills38032802016-12-12 13:43:40 -0600468 [Arguments] ${boot_property}
Michael Walsha6723f22016-11-22 11:12:01 -0600469 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
470 ${cmd}= Catenate ${cmd}${boot_property}
Sivas SRRe1143ae2016-08-26 22:31:02 -0500471 Set Global Variable ${dbuscmd} ${cmd}
472
David Shawba2d2c22017-01-23 16:56:38 -0600473Create OS Console File Path
474 [Documentation] Create OS console file path name and return it.
475 [Arguments] ${log_file_path}=${EMPTY}
George Keishing30c12ff2016-09-02 10:25:29 -0500476
David Shawba2d2c22017-01-23 16:56:38 -0600477 # Description of arguements:
478 # file_path The caller's candidate value. If this value is ${EMPTY}, this
479 # keyword will compose a file path name. Otherwise, this
480 # keyword will use the caller's file_path value. In either
481 # case, the value will be returned.
Gunnar Mills9c760342016-12-08 10:12:06 -0600482
George Keishing3deb7d12017-09-14 07:50:00 -0500483 ${default_file_path}= Catenate /tmp/${OPENBMC_HOST}_os_console.txt
David Shawba2d2c22017-01-23 16:56:38 -0600484 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
485 ... ${default_file_path} ${log_file_path}
Michael Walsh01bd3682017-01-10 11:21:05 -0600486
David Shawba2d2c22017-01-23 16:56:38 -0600487 [Return] ${log_file_path}
Gunnar Mills9c760342016-12-08 10:12:06 -0600488
David Shawba2d2c22017-01-23 16:56:38 -0600489Create OS Console Command String
490 [Documentation] Return a command string to start OS console logging.
Gunnar Mills9c760342016-12-08 10:12:06 -0600491
David Shawba2d2c22017-01-23 16:56:38 -0600492 # First make sure that the ssh_pw program is available.
493 ${cmd_buf}= Catenate which ssh_pw 2>&1
494 Rdpissuing ${cmd_buf}
495 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
496 Rdpvars rc output
Gunnar Mills9c760342016-12-08 10:12:06 -0600497
George Keishingb45d9522017-06-29 04:20:59 -0500498 ${ssh_pw_file_path}= Run Keyword If ${rc} != ${0}
George Keishing72f76442017-09-18 10:47:52 -0500499 ... Set Variable ${EXECDIR}${/}bin/ssh_pw
500 ... ELSE
501 ... Set Variable ssh_pw
George Keishingb45d9522017-06-29 04:20:59 -0500502
503 ${cmd_buf}= Catenate ${ssh_pw_file_path} ${OPENBMC_PASSWORD} -p 2200
George Keishing1f9ec7f2017-06-06 08:59:19 -0500504 ... -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST}
George Keishing30c12ff2016-09-02 10:25:29 -0500505
David Shawba2d2c22017-01-23 16:56:38 -0600506 [Return] ${cmd_buf}
George Keishing30c12ff2016-09-02 10:25:29 -0500507
Michael Walshcadf1342017-08-28 13:49:25 -0500508Get SOL Console Pid
509 [Documentation] Get the pid of the active sol conole job.
510
511 # Find the pid of the active system console logging session (if any).
512 ${search_string}= Create OS Console Command String
513 # At least in some cases, ps output does not show double quotes so we must
514 # replace them in our search string with the regexes to indicate that they
515 # are optional.
516 ${search_string}= Replace String ${search_string} " ["]?
517 ${cmd_buf}= Catenate echo $(ps -ef | egrep '${search_string}'
518 ... | egrep -v grep | cut -c10-14)
519 Rdpissuing ${cmd_buf}
520 ${rc} ${os_con_pid}= Run And Return Rc And Output ${cmd_buf}
521 Rdpvars os_con_pid
522 # If rc is not zero it just means that there is no OS Console process
523 # running.
524
525 [Return] ${os_con_pid}
526
527
George Keishing30c12ff2016-09-02 10:25:29 -0500528Stop SOL Console Logging
David Shawba2d2c22017-01-23 16:56:38 -0600529 [Documentation] Stop system console logging and return log output.
George Keishing72992e42017-06-16 06:42:36 -0500530 [Arguments] ${log_file_path}=${EMPTY}
531 ... ${targ_file_path}=${EXECDIR}${/}logs${/}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500532 ... ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600533
534 # If there are muliple system console processes, they will all be stopped.
535 # If there is no existing log file this keyword will return an error
536 # message to that effect (and write that message to targ_file_path, if
537 # specified).
538 # NOTE: This keyword will not fail if there is no running system console
539 # process.
Michael Walsh01bd3682017-01-10 11:21:05 -0600540
541 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600542 # log_file_path The file path that was used to call "Start SOL
543 # Console Logging". See that keyword (above) for details.
544 # targ_file_path If specified, the file path to which the source
545 # file path (i.e. "log_file_path") should be copied.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500546 # return_data If this is set to ${1}, this keyword will return the SOL
547 # data to the caller as a unicode string.
George Keishing30c12ff2016-09-02 10:25:29 -0500548
David Shawba2d2c22017-01-23 16:56:38 -0600549 ${log_file_path}= Create OS Console File Path ${log_file_path}
Michael Walshcadf1342017-08-28 13:49:25 -0500550
551 ${os_con_pid}= Get SOL Console Pid
George Keishing30c12ff2016-09-02 10:25:29 -0500552
David Shawba2d2c22017-01-23 16:56:38 -0600553 ${cmd_buf}= Catenate kill -9 ${os_con_pid}
554 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpissuing ${cmd_buf}
555 ${rc} ${output}= Run Keyword If '${os_con_pid}' != '${EMPTY}'
556 ... Run And Return Rc And Output ${cmd_buf}
557 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpvars rc output
George Keishing30c12ff2016-09-02 10:25:29 -0500558
Michael Walsh01bd3682017-01-10 11:21:05 -0600559 Run Keyword If '${targ_file_path}' != '${EMPTY}'
David Shawba2d2c22017-01-23 16:56:38 -0600560 ... Run Keyword And Ignore Error
561 ... Copy File ${log_file_path} ${targ_file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500562
Michael Walsh5f3f4142017-05-22 17:09:47 -0500563 ${output}= Set Variable ${EMPTY}
564 ${loc_quiet}= Evaluate ${debug}^1
565 ${rc} ${output}= Run Keyword If '${return_data}' == '${1}'
566 ... Cmd Fnc cat ${log_file_path} quiet=${loc_quiet} print_output=${0}
567
David Shawba2d2c22017-01-23 16:56:38 -0600568 [Return] ${output}
569
570Start SOL Console Logging
571 [Documentation] Start system console log to file.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500572 [Arguments] ${log_file_path}=${EMPTY} ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600573
574 # This keyword will first call "Stop SOL Console Logging". Only then will
575 # it start SOL console logging. The data returned by "Stop SOL Console
576 # Logging" will in turn be returned by this keyword.
577
578 # Description of arguments:
Michael Walsh5f3f4142017-05-22 17:09:47 -0500579 # log_file_path The file path to which system console log data should be
580 # written. Note that this path is taken to be a location
581 # on the machine where this program is running rather than
582 # on the Open BMC system.
583 # return_data If this is set to ${1}, this keyword will return any SOL
584 # data to the caller as a unicode string.
David Shawba2d2c22017-01-23 16:56:38 -0600585
586 ${log_file_path}= Create OS Console File Path ${log_file_path}
587
588 ${log_output}= Stop SOL Console Logging ${log_file_path}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500589 ... return_data=${return_data}
David Shawba2d2c22017-01-23 16:56:38 -0600590
591 # Validate by making sure we can create the file. Problems creating the
592 # file would not be noticed by the subsequent ssh command because we fork
593 # the command.
594 Create File ${log_file_path}
595 ${sub_cmd_buf}= Create OS Console Command String
596 # Routing stderr to stdout so that any startup error text will go to the
597 # output file.
George Keishing8c3c1df2017-09-13 13:50:20 -0500598 # TODO: Doesn't work with tox so reverting temporarily.
Michael Walsh460042e2017-09-05 16:55:49 -0500599 # nohup detaches the process completely from our pty.
George Keishing8c3c1df2017-09-13 13:50:20 -0500600 #${cmd_buf}= Catenate nohup ${sub_cmd_buf} &> ${log_file_path} &
601 ${cmd_buf}= Catenate ${sub_cmd_buf} > ${log_file_path} 2>&1 &
David Shawba2d2c22017-01-23 16:56:38 -0600602 Rdpissuing ${cmd_buf}
603 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
604 # Because we are forking this command, we essentially will never get a
605 # non-zero return code or any output.
606 Should Be Equal ${rc} ${0}
607
Michael Walshcadf1342017-08-28 13:49:25 -0500608 Sleep 1
609 ${os_con_pid}= Get SOL Console Pid
610
611 Should Not Be Empty ${os_con_pid}
612
David Shawba2d2c22017-01-23 16:56:38 -0600613 [Return] ${log_output}
George Keishing30c12ff2016-09-02 10:25:29 -0500614
615Get Time Stamp
616 [Documentation] Get the current time stamp data
617 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500618 [Return] ${cur_time}
George Keishing30c12ff2016-09-02 10:25:29 -0500619
George Keishing1b150202016-09-29 08:51:58 -0500620
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500621Start Journal Log
622 [Documentation] Start capturing journal log to a file in /tmp using
623 ... journalctl command. By default journal log is collected
624 ... at /tmp/journal_log else user input location.
625 ... The File is appended with datetime.
626 [Arguments] ${file_path}=/tmp/journal_log
627
628 Open Connection And Log In
629
630 ${cur_time}= Get Time Stamp
631 Set Global Variable ${LOG_TIME} ${cur_time}
632 Start Command
633 ... journalctl -f > ${file_path}-${LOG_TIME}
634 Log Journal Log Started: ${file_path}-${LOG_TIME}
635
David Shawba2d2c22017-01-23 16:56:38 -0600636
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500637Stop Journal Log
638 [Documentation] Stop journalctl process if its running.
639 ... By default return log from /tmp/journal_log else
640 ... user input location.
641 [Arguments] ${file_path}=/tmp/journal_log
642
643 Open Connection And Log In
644
645 ${rc}=
646 ... Execute Command
647 ... ps ax | grep journalctl | grep -v grep
648 ... return_stdout=False return_rc=True
649
650 Return From Keyword If '${rc}' == '${1}'
651 ... No journal log process running
652
653 ${output} ${stderr}=
654 ... Execute Command killall journalctl
655 ... return_stderr=True
656 Should Be Empty ${stderr}
657
658 ${journal_log} ${stderr}=
659 ... Execute Command
660 ... cat ${file_path}-${LOG_TIME}
661 ... return_stderr=True
662 Should Be Empty ${stderr}
663
664 Log ${journal_log}
665
666 Execute Command rm ${file_path}-${LOG_TIME}
667
668 [Return] ${journal_log}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500669
670Mac Address To Hex String
671 [Documentation] Converts MAC address into hex format.
672 ... Example
673 ... Given the following MAC: 00:01:6C:80:02:78
674 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
675 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600676 ... i_macaddress MAC address in the following format
677 ... 00:01:6C:80:02:78
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500678 [Arguments] ${i_macaddress}
679
680 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600681 [Return] ${mac_hex}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500682
683IP Address To Hex String
684 [Documentation] Converts IP address into hex format.
685 ... Example:
686 ... Given the following IP: 10.3.164.100
687 ... This keyword will return: 0xa 0x3 0xa4 0xa0
688 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600689 ... i_ipaddress IP address in the following format
690 ... 10.10.10.10
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500691 [Arguments] ${i_ipaddress}
692
693 @{ip}= Split String ${i_ipaddress} .
694 ${index}= Set Variable ${0}
695
696 :FOR ${item} IN @{ip}
697 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes
698 \ Set List Value ${ip} ${index} ${hex}
699 \ ${index}= Set Variable ${index + 1}
700 ${ip_hex}= Catenate @{ip}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600701 [Return] ${ip_hex}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600702
703BMC CPU Performance Check
704 [Documentation] Minimal 10% of proc should be free in this instance
705
706 ${bmc_cpu_usage_output} ${stderr}= Execute Command ${bmc_cpu_usage_cmd}
707 ... return_stderr=True
708 Should be empty ${stderr}
709 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} %
710 Should be true ${bmc_cpu_percentage} < 90
711
712BMC Mem Performance Check
713 [Documentation] Minimal 10% of memory should be free in this instance
714
715 ${bmc_mem_free_output} ${stderr}= Execute Command ${bmc_mem_free_cmd}
716 ... return_stderr=True
717 Should be empty ${stderr}
718
719 ${bmc_mem_total_output} ${stderr}= Execute Command ${bmc_mem_total_cmd}
720 ... return_stderr=True
721 Should be empty ${stderr}
722
723 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100
724 ${bmc_mem_percentage}= Evaluate
725 ... ${bmc_mem_percentage}/${bmc_mem_total_output}
726 Should be true ${bmc_mem_percentage} > 10
727
Sivas SRRaca55712016-12-21 04:32:35 -0600728BMC File System Usage Check
729 [Documentation] Check the file system space. None should be 100% full
Sivas SRR352bc162017-02-13 22:12:29 -0600730 ... except /run/initramfs/ro
Sivas SRRaca55712016-12-21 04:32:35 -0600731 ${bmc_fs_usage_output} ${stderr}= Execute Command
732 ... ${bmc_file_system_usage_cmd} return_stderr=True
733 Should Be Empty ${stderr}
734 Should Be True ${bmc_fs_usage_output}==0
735
Sivas SRRea85d1f2016-11-13 22:44:28 -0600736Check BMC CPU Performance
737 [Documentation] Minimal 10% of proc should be free in 3 sample
738 :FOR ${var} IN Range 1 4
739 \ BMC CPU Performance check
740
741Check BMC Mem Performance
742 [Documentation] Minimal 10% of memory should be free
743
744 :FOR ${var} IN Range 1 4
745 \ BMC Mem Performance check
746
Sivas SRRaca55712016-12-21 04:32:35 -0600747Check BMC File System Performance
748 [Documentation] Check for file system usage for 4 times
749
750 :FOR ${var} IN Range 1 4
751 \ BMC File System Usage check
752
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500753Get URL List
754 [Documentation] Return list of URLs under given URL.
755 [Arguments] ${openbmc_url}
756 # Description of argument(s):
Michael Walsh5f3f4142017-05-22 17:09:47 -0500757 # openbmc_url URL for list operation (e.g.
758 # /xyz/openbmc_project/inventory).
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500759
George Keishing335f5362017-06-30 15:11:20 -0500760 ${url_list}= Read Properties ${openbmc_url}/list quiet=${1}
George Keishing184a89a2017-06-27 07:12:16 -0500761 Sort List ${url_list}
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500762 [Return] ${url_list}
763
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600764Get Endpoint Paths
765 [Documentation] Returns all url paths ending with given endpoint
766 ... Example:
767 ... Given the following endpoint: cpu
Michael Walsh01bd3682017-01-10 11:21:05 -0600768 ... This keyword will return: list of all urls ending with
769 ... cpu -
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600770 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
771 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
772 ... Description of arguments:
773 ... path URL path for enumeration
774 ... endpoint string for which url path ending
775 [Arguments] ${path} ${endpoint}
776
777 ${resp}= Read Properties ${path}/enumerate timeout=30
778 log Dictionary ${resp}
779
780 ${list}= Get Dictionary Keys ${resp}
781 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9]*$
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600782 [Return] ${resp}
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500783
784Check Zombie Process
785 [Documentation] Check if any defunct process exist or not on BMC
Michael Walsh01bd3682017-01-10 11:21:05 -0600786 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500787 ... return_stderr=True return_rc=True
788 Should Be True ${count}==0
789 Should Be Empty ${stderr}
George Keishing5327d012016-12-08 08:43:29 -0600790
791Prune Journal Log
792 [Documentation] Prune archived journal logs.
793 [Arguments] ${vacuum_size}=1M
794
795 # This keyword can be used to prevent the journal
796 # log from filling up the /run filesystem.
797 # This command will retain only the latest logs
798 # of the user specified size.
799
800 Open Connection And Log In
801 ${output} ${stderr} ${rc}=
802 ... Execute Command
803 ... journalctl --vacuum-size=${vacuum_size}
804 ... return_stderr=True return_rc=True
805
806 Should Be Equal ${rc} ${0} msg=${stderr}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600807
808Set BMC Power Policy
809 [Documentation] Set the given BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -0500810 [Arguments] ${policy}
811
812 # Note that this function will translate the old style "RESTORE_LAST_STATE"
813 # policy to the new style "xyz.openbmc_project.Control.Power.RestorePolicy.
814 # Policy.Restore" for you.
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600815
George Keishing1c3a9662017-08-11 10:16:36 -0500816 # Description of argument(s):
Michael Walshfdc5ced2017-08-17 13:15:15 -0500817 # policy Power restore policy (e.g "RESTORE_LAST_STATE",
818 # ${RESTORE_LAST_STATE}).
819
820 # Set the bmc_power_policy_method to either 'Old' or 'New'.
821 Set Power Policy Method
822 # This translation helps bridge between old and new method for calling.
823 ${policy}= Translate Power Policy Value ${policy}
824 # Run the appropriate keyword.
825 Run Key ${bmc_power_policy_method} Set Power Policy \ ${policy}
826 ${currentPolicy}= Get System Power Policy
827 Should Be Equal ${currentPolicy} ${policy}
828
829New Set Power Policy
830 [Documentation] Set the given BMC power policy (new method).
831 [Arguments] ${policy}
832
833 # Description of argument(s):
834 # policy Power restore policy (e.g. ${RESTORE_LAST_STATE}).
George Keishing1c3a9662017-08-11 10:16:36 -0500835
836 ${valueDict}= Create Dictionary data=${policy}
837 Write Attribute
Michael Walshfdc5ced2017-08-17 13:15:15 -0500838 ... ${POWER_RESTORE_URI} PowerRestorePolicy data=${valueDict}
839
840Old Set Power Policy
841 [Documentation] Set the given BMC power policy (old method).
842 [Arguments] ${policy}
843
844 # Description of argument(s):
845 # policy Power restore policy (e.g. "RESTORE_LAST_STATE").
846
847 ${valueDict}= create dictionary data=${policy}
848 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
George Keishingcce9df22017-01-24 06:19:33 -0600849
George Keishing4d6f3d62017-02-06 09:50:41 -0600850Get System Power Policy
851 [Documentation] Get the BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -0500852
853 # Set the bmc_power_policy_method to either 'Old' or 'New'.
854 Set Power Policy Method
855 ${cmd_buf}= Create List ${bmc_power_policy_method} Get Power Policy
856 # Run the appropriate keyword.
857 ${currentPolicy}= Run Keyword @{cmd_buf}
858 [Return] ${currentPolicy}
859
860New Get Power Policy
861 [Documentation] Get the BMC power policy (new method).
George Keishing1c3a9662017-08-11 10:16:36 -0500862 ${currentPolicy}= Read Attribute ${POWER_RESTORE_URI} PowerRestorePolicy
George Keishing4d6f3d62017-02-06 09:50:41 -0600863 [Return] ${currentPolicy}
George Keishingcce9df22017-01-24 06:19:33 -0600864
Michael Walshfdc5ced2017-08-17 13:15:15 -0500865Old Get Power Policy
866 [Documentation] Get the BMC power policy (old method).
867 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
868 [Return] ${currentPolicy}
869
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600870Get Auto Reboot
871 [Documentation] Returns auto reboot setting.
Sweta Potthuri62a23572017-07-28 04:05:13 -0500872 ${setting}= Read Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600873 [Return] ${setting}
874
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600875Set Auto Reboot
876 [Documentation] Set the given auto reboot setting.
877 [Arguments] ${setting}
Sweta Potthuri62a23572017-07-28 04:05:13 -0500878 # setting auto reboot's setting, i.e. 1 for enabling and 0 for disabling.
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600879
880 ${valueDict}= Set Variable ${setting}
881 ${data}= Create Dictionary data=${valueDict}
Sweta Potthuri62a23572017-07-28 04:05:13 -0500882 Write Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot data=${data}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600883 ${current_setting}= Get Auto Reboot
Sweta Potthuri62a23572017-07-28 04:05:13 -0500884 Should Be Equal As Integers ${current_setting} ${setting}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600885
886
George Keishingcce9df22017-01-24 06:19:33 -0600887Set BMC Reset Reference Time
888 [Documentation] Set current boot time as a reference and increment
George Keishing80dd5af2017-02-08 07:01:25 -0600889 ... boot count.
George Keishingcce9df22017-01-24 06:19:33 -0600890
891 ${cur_btime}= Get BMC Boot Time
George Keishing80dd5af2017-02-08 07:01:25 -0600892 Run Keyword If ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
George Keishingcce9df22017-01-24 06:19:33 -0600893 ... Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishing80dd5af2017-02-08 07:01:25 -0600894 ... ELSE IF ${cur_btime} > ${BOOT_TIME}
895 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishingcce9df22017-01-24 06:19:33 -0600896 ... AND
897 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
898
George Keishingcce9df22017-01-24 06:19:33 -0600899Get BMC Boot Time
900 [Documentation] Get boot time from /proc/stat.
901
902 Open Connection And Log In
903 ${output} ${stderr}=
904 ... Execute Command egrep '^btime ' /proc/stat | cut -f 2 -d ' '
905 ... return_stderr=True
906 Should Be Empty ${stderr}
907 ${btime}= Convert To Integer ${output}
908 [Return] ${btime}
George Keishingede30002017-02-02 09:33:07 -0600909
George Keishingede30002017-02-02 09:33:07 -0600910Execute Command On BMC
911 [Documentation] Execute given command on BMC and return output.
912 [Arguments] ${command}
913 ${stdout} ${stderr}= Execute Command ${command} return_stderr=True
914 Should Be Empty ${stderr}
915 [Return] ${stdout}
David Shawba2d2c22017-01-23 16:56:38 -0600916
Sridevi Rameshea36b412017-03-09 04:08:02 -0600917
George Keishing7a520222017-02-27 09:44:30 -0600918Enable Core Dump On BMC
919 [Documentation] Enable core dump collection.
920 Open Connection And Log In
921 ${core_pattern}= Execute Command On BMC
922 ... echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
923 Should Be Equal As Strings ${core_pattern} /tmp/core_%e.%p
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600924
Sivas SRR01262bd2017-03-19 10:00:23 -0500925Get Number Of BMC Core Dump Files
926 [Documentation] Get number of core dump files on BMC.
927 Open Connection And Log In
928 ${num_of_core_dump}= Execute Command
929 ... ls /tmp/core* 2>/dev/null | wc -l
930 [Return] ${num_of_core_dump}
931
932Set Core Dump File Size Unlimited
933 [Documentation] Set core dump file size to unlimited.
934 Open Connection And Log In
935 Execute Command On BMC
936 ... ulimit -c unlimited
937
938Check For Core Dumps
939 [Documentation] Check for any core dumps exist.
940 ${output}= Get Number Of BMC Core Dump Files
941 Run Keyword If ${output} > 0
942 ... Log **Warning** BMC core dump files exist level=WARN
943
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600944Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -0500945 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600946 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Michael Walshb5839d02017-04-12 16:11:20 -0500947 # Description of argument(s):
948 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
949 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600950 # sleep_time Time delay for host watchdog error to get injected.
951 # Default is 5 seconds.
952
George Keishing37cfa6b2017-06-15 10:25:55 -0500953 ${data}= Create Dictionary data=${True}
954 Write Attribute /xyz/openbmc_project/watchdog/host0 Enabled data=${data}
955
956 ${data}= Create Dictionary data=${milliseconds}
957 Write Attribute /xyz/openbmc_project/watchdog/host0 TimeRemaining data=${data}
958
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600959 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500960
961Login To OS Host
962 [Documentation] Login to OS Host.
963 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
964 ... ${os_password}=${OS_PASSWORD}
965 # Desription of arguments:
966 # ${os_host} IP address of the OS Host.
967 # ${os_username} OS Host Login user name.
968 # ${os_password} OS Host Login passwrd.
969
970 ${os_state}= Run Keyword And Return Status Ping Host ${os_host}
971 Run Keyword If '${os_state}' == 'False'
972 ... Run Keywords Initiate Host Reboot AND
973 ... Is Host Running AND
974 ... Wait for OS ${os_host} ${os_username} ${os_password}
975
George Keishing3f223b82017-06-28 03:50:35 -0500976 SSHLibrary.Open Connection ${os_host}
Sridevi Rameshea36b412017-03-09 04:08:02 -0600977 ${resp}= Login ${os_username} ${os_password}
978 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -0500979
980Configure Initial Settings
981 [Documentation] Restore old IP and route.
982 ... This keyword requires initial settings viz IP address,
983 ... Network Mask, default gatway and serial console IP and port
984 ... information which should be provided in command line.
985
Michael Walshb5839d02017-04-12 16:11:20 -0500986 [Arguments] ${host}=${OPENBMC_HOST} ${mask}=${NET_MASK}
987 ... ${gw_ip}=${GW_IP}
Prashanth Katti884ee062017-03-16 05:05:03 -0500988
Michael Walshb5839d02017-04-12 16:11:20 -0500989 # Open telnet connection and ignore the error, in case telnet session is
990 # already opened by the program calling this keyword.
Prashanth Katti884ee062017-03-16 05:05:03 -0500991
992 Run Keyword And Ignore Error Open Telnet Connection to BMC Serial Console
993 Telnet.write ifconfig eth0 ${host} netmask ${mask}
994 Telnet.write route add default gw ${gw_ip}
George Keishingd05b1082017-03-24 05:27:32 -0500995
996Install Debug Tarball On BMC
George Keishing55441822017-05-18 14:17:59 -0500997 [Documentation] Copy the debug tar file to BMC and install.
998 [Arguments] ${tarball_file_path}=${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz
George Keishing5591d332017-09-05 12:57:17 -0500999 ... ${targ_tarball_dir_path}=/tmp/tarball/
George Keishingd05b1082017-03-24 05:27:32 -05001000
George Keishing55441822017-05-18 14:17:59 -05001001 # Description of arguments:
1002 # tarball_file_path Path of the debug tarball file.
1003 # The tar file is downloaded from the build page
1004 # https://openpower.xyz/job/openbmc-build/
1005 # obmc-phosphor-debug-tarball-witherspoon.tar.xz
1006 #
1007 # targ_tarball_dir_path The directory path where the tarball is to be
1008 # installed.
1009
1010 OperatingSystem.File Should Exist ${tarball_file_path}
1011 ... msg=${tarball_file_path} doesn't exist.
1012
1013 # Upload the file to BMC.
George Keishingd05b1082017-03-24 05:27:32 -05001014 Import Library SCPLibrary WITH NAME scp
1015 Open Connection for SCP
George Keishing55441822017-05-18 14:17:59 -05001016 scp.Put File ${tarball_file_path} /tmp/debug-tarball.tar.xz
1017
1018 # Create tarball directory and install.
George Keishing95c371a2017-09-14 15:42:33 -05001019 BMC Execute Command mkdir -p ${targ_tarball_dir_path}
1020 BMC Execute Command
George Keishing55441822017-05-18 14:17:59 -05001021 ... tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path}
1022
George Keishing95c371a2017-09-14 15:42:33 -05001023 # Remove the tarball file from BMC.
1024 BMC Execute Command rm -f /tmp/debug-tarball.tar.xz
George Keishingd05b1082017-03-24 05:27:32 -05001025
George Keishing55441822017-05-18 14:17:59 -05001026
Sweta Potthuri025e0122017-02-21 00:42:48 -06001027Get BMC Boot Count
1028 [Documentation] Get BMC boot count based on boot time.
1029 ${cur_btime}= Get BMC Boot Time
1030
1031 # Set global variable BOOT_TIME to current boot time if current boot time
1032 # is changed. Also increase value of global variable BOOT_COUNT by 1.
1033 Run Keyword If ${cur_btime} > ${BOOT_TIME}
1034 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
1035 ... AND
1036 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
1037 [Return] ${BOOT_COUNT}
1038
1039Set BMC Boot Count
1040 [Documentation] Set BMC boot count to given value.
1041 [Arguments] ${count}
1042
1043 # Description of arguments:
1044 # count boot count value.
1045 ${cur_btime}= Get BMC Boot Time
1046
1047 # Set global variable BOOT_COUNT to given value.
1048 Set Global Variable ${BOOT_COUNT} ${count}
1049
1050 # Set BOOT_TIME variable to current boot time.
1051 Set Global Variable ${BOOT_COUNT} ${count}
Michael Walsh689fbbe2017-04-04 17:58:03 -05001052
Sweta Potthurie5a9fc72017-05-03 07:02:46 -05001053Get System LED State
1054 [Documentation] Return the state of given system LED.
1055 [Arguments] ${led_name}
1056
1057 # Description of argument(s):
1058 # led_name System LED name (e.g. heartbeat, identify, beep).
1059
1060 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State
1061 [Return] ${state.rsplit('.', 1)[1]}
1062
George Keishing3987a1e2017-09-20 09:13:02 -05001063
George Keishingd2d90af2017-06-27 08:17:34 -05001064Delete Error Logs
Michael Walsh689fbbe2017-04-04 17:58:03 -05001065 [Documentation] Delete error logs.
1066
George Keishingd2d90af2017-06-27 08:17:34 -05001067 # Check if error logs entries exist, if not return.
George Keishing335f5362017-06-30 15:11:20 -05001068 ${resp}= OpenBMC Get Request ${BMC_LOGGING_ENTRY}${/}list quiet=${1}
George Keishingd2d90af2017-06-27 08:17:34 -05001069 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND}
1070
1071 # Get the list of error logs entries and delete them all.
George Keishing335f5362017-06-30 15:11:20 -05001072 ${elog_entries}= Get URL List ${BMC_LOGGING_ENTRY}
George Keishingd2d90af2017-06-27 08:17:34 -05001073 :FOR ${entry} IN @{elog_entries}
1074 \ Delete Error Log Entry ${entry}
George Keishingdb34c2f2017-04-18 13:20:25 -05001075
George Keishing3987a1e2017-09-20 09:13:02 -05001076
George Keishingd2d90af2017-06-27 08:17:34 -05001077Delete Error Log Entry
George Keishingdb34c2f2017-04-18 13:20:25 -05001078 [Documentation] Delete error log entry.
1079 [Arguments] ${entry_path}
1080
1081 # Description of argument(s):
1082 # entry_path Delete an error log entry.
1083 # Ex. /xyz/openbmc_project/logging/entry/1
1084
George Keishing6a8ed0f2017-07-11 22:54:42 -05001085 # Skip delete if entry URI is a callout.
1086 # Example: /xyz/openbmc_project/logging/entry/1/callout
1087 Return From Keyword If '${entry_path.rsplit('/', 1)[1]}' == 'callout'
1088
George Keishingdb34c2f2017-04-18 13:20:25 -05001089 ${data}= Create Dictionary data=@{EMPTY}
1090 ${resp}= Openbmc Delete Request ${entry_path} data=${data}
1091 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Rahul Maheshwari43be6932017-05-01 02:37:06 -05001092
1093
George Keishingcc71c3c2017-09-20 09:38:03 -05001094Delete All Error Logs
George Keishing3987a1e2017-09-20 09:13:02 -05001095 [Documentation] Delete all error log entries using "DeleteAll" interface.
1096
1097 ${data}= Create Dictionary data=@{EMPTY}
1098 ${resp}= Openbmc Post Request ${BMC_LOGGING_URI}action/DeleteAll
1099 ... data=${data}
1100 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
1101
1102
Rahul Maheshwari43be6932017-05-01 02:37:06 -05001103Get LED State XYZ
1104 [Documentation] Returns state of given LED.
1105 [Arguments] ${led_name}
1106 # Description of argument(s):
1107 # led_name Name of LED
1108
1109 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
1110 [Return] ${state}
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001111
1112
1113Get BMC Version
1114 [Documentation] Returns BMC version from /etc/os-release.
1115 ... e.g. "v1.99.6-141-ge662190"
1116
1117 Open Connection And Log In
1118 ${cmd}= Set Variable grep ^VERSION_ID= /etc/os-release | cut -f 2 -d '='
1119 ${output}= Execute Command On BMC ${cmd}
1120 [Return] ${output}
1121
George Keishingad5817a2017-06-28 10:19:03 -05001122
George Keishingad5817a2017-06-28 10:19:03 -05001123Get Elog URL List
1124 [Documentation] Return error log entry list of URLs.
1125
1126 ${url_list}= Read Properties /xyz/openbmc_project/logging/entry/
1127 Sort List ${url_list}
1128 [Return] ${url_list}
1129
1130
Steven Sombaraaf72c42017-09-05 12:02:00 -05001131Read Turbo Setting Via REST
1132 [Documentation] Return turbo setting via REST.
1133
1134 ${resp}= OpenBMC Get Request ${SENSORS_URI}host/TurboAllowed
1135 ${jsondata}= To JSON ${resp.content}
1136 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
1137 [Return] ${jsondata["data"]["value"]}
1138
1139
Steven Sombaraaf72c42017-09-05 12:02:00 -05001140Set Turbo Setting Via REST
1141 [Documentation] Set turbo setting via REST.
1142 [Arguments] ${setting}
1143 # Description of argument(s):
1144 # setting Value which needs to be set.(i.e. False or True)
1145
1146 ${valueDict}= Create Dictionary data=${setting}
1147 Write Attribute ${SENSORS_URI}host/TurboAllowed value data=${valueDict}