blob: 4d14919b656bd26fc4d28693d69e40ec5dabdebc [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 Walshac275512017-03-07 11:39:28 -0600218 SSHLibrary.Open connection ${os_host}
Michael Walsh81843772017-03-02 14:44:44 -0600219 Login ${os_username} ${os_password}
220 ${cmd_buf} Catenate shutdown
221 Start Command ${cmd_buf}
Michael Walshac275512017-03-07 11:39:28 -0600222 SSHLibrary.Close Connection
Michael Walsh81843772017-03-02 14:44:44 -0600223
224Initiate OS Host Reboot
225 [Documentation] Initiate an OS reboot.
226 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
227 ... ${os_password}=${OS_PASSWORD}
228
229 # Description of arguments:
230 # os_host The DNS name or IP of the OS.
231 # os_username The username to be used to sign in to the OS.
232 # os_password The password to be used to sign in to the OS.
233
Michael Walshac275512017-03-07 11:39:28 -0600234 SSHLibrary.Open connection ${os_host}
Michael Walsh81843772017-03-02 14:44:44 -0600235 Login ${os_username} ${os_password}
236 ${cmd_buf} Catenate reboot
237 Start Command ${cmd_buf}
Michael Walshac275512017-03-07 11:39:28 -0600238 SSHLibrary.Close Connection
Michael Walsh81843772017-03-02 14:44:44 -0600239
240Initiate Auto Reboot
241 [Documentation] Initiate an auto reboot.
242
243 # Set the auto reboot policy.
Sweta Potthuri62a23572017-07-28 04:05:13 -0500244 Set Auto Reboot ${1}
Michael Walsh81843772017-03-02 14:44:44 -0600245 # Set the watchdog timer. Note: 5000 = milliseconds which is 5 seconds.
George Keishing37cfa6b2017-06-15 10:25:55 -0500246 Trigger Host Watchdog Error 5000
Michael Walsh81843772017-03-02 14:44:44 -0600247
Chris Austenb29d2e82016-06-07 12:25:35 -0500248Trigger Warm Reset
249 log to console "Triggering warm reset"
Michael Walsha6723f22016-11-22 11:12:01 -0600250 ${data}= create dictionary data=@{EMPTY}
George Keishing85ca05e2016-11-30 09:47:18 -0600251 ${resp}= openbmc post request
252 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
Chris Austenb29d2e82016-06-07 12:25:35 -0500253 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
George Keishingb3700812016-08-31 03:03:30 -0500254 ${session_active}= Check If warmReset is Initiated
255 Run Keyword If '${session_active}' == '${True}'
256 ... Fail msg=warm reset didn't occur
257
Chris Austenb29d2e82016-06-07 12:25:35 -0500258 Sleep ${SYSTEM_SHUTDOWN_TIME}min
Rahul Maheshwari5f253c42017-01-30 05:19:51 -0600259 Check If BMC Is Up
Michael Walsh49ab0f42016-07-20 11:44:33 -0500260
261Check OS
root442f0ef2016-08-04 20:23:05 +0000262 [Documentation] Attempts to ping the host OS and then checks that the host
263 ... OS is up by running an SSH command.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500264
265 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walsha6723f22016-11-22 11:12:01 -0600266 ... ${os_password}=${OS_PASSWORD} ${quiet}=${QUIET}
267 ... ${print_string}=${EMPTY}
Michael Walshac275512017-03-07 11:39:28 -0600268 [Teardown] SSHLibrary.Close Connection
Michael Walsh49ab0f42016-07-20 11:44:33 -0500269
270 # os_host The DNS name/IP of the OS host associated with our BMC.
271 # os_username The username to be used to sign on to the OS host.
272 # os_password The password to be used to sign on to the OS host.
Michael Walsha6723f22016-11-22 11:12:01 -0600273 # quiet Indicates whether this keyword should write to console.
274 # print_string A string to be printed before checking the OS.
275
276 rprint ${print_string}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500277
root442f0ef2016-08-04 20:23:05 +0000278 # Attempt to ping the OS. Store the return code to check later.
279 ${ping_rc}= Run Keyword and Return Status Ping Host ${os_host}
280
Michael Walshac275512017-03-07 11:39:28 -0600281 SSHLibrary.Open connection ${os_host}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500282
Michael Walsha6723f22016-11-22 11:12:01 -0600283 ${status} ${msg}= Run Keyword And Ignore Error Login ${os_username}
284 ... ${os_password}
285 ${err_msg1}= Sprint Error ${msg}
286 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
287 Run Keyword If '${status}' == 'FAIL' Fail msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500288 ${output} ${stderr} ${rc}= Execute Command uptime return_stderr=True
289 ... return_rc=True
290
Michael Walsha6723f22016-11-22 11:12:01 -0600291 ${temp_msg}= Catenate Could not execute a command on the operating
292 ... system.\n
293 ${err_msg1}= Sprint Error ${temp_msg}
294 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
295
296 # If the return code returned by "Execute Command" is non-zero, this
297 # keyword will fail.
298 Should Be Equal ${rc} ${0} msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500299 # We will likewise fail if there is any stderr data.
300 Should Be Empty ${stderr}
301
Michael Walsha6723f22016-11-22 11:12:01 -0600302 ${temp_msg}= Set Variable Could not ping the operating system.\n
303 ${err_msg1}= Sprint Error ${temp_msg}
304 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
305 # We will likewise fail if the OS did not ping, as we could SSH but not
306 # ping
307 Should Be Equal As Strings ${ping_rc} ${TRUE} msg=${err_msg}
root442f0ef2016-08-04 20:23:05 +0000308
Michael Walsh49ab0f42016-07-20 11:44:33 -0500309Wait for OS
310 [Documentation] Waits for the host OS to come up via calls to "Check OS".
311 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
312 ... ${os_password}=${OS_PASSWORD} ${timeout}=${OS_WAIT_TIMEOUT}
Michael Walsha6723f22016-11-22 11:12:01 -0600313 ... ${quiet}=${0}
314 [Teardown] rprintn
Michael Walsh49ab0f42016-07-20 11:44:33 -0500315
316 # os_host The DNS name or IP of the OS host associated with our
317 # BMC.
318 # os_username The username to be used to sign on to the OS host.
319 # os_password The password to be used to sign on to the OS host.
320 # timeout The timeout in seconds indicating how long you're
321 # willing to wait for the OS to respond.
Michael Walsha6723f22016-11-22 11:12:01 -0600322 # quiet Indicates whether this keyword should write to console.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500323
324 # The interval to be used between calls to "Check OS".
325 ${interval}= Set Variable 5
326
Michael Walsha6723f22016-11-22 11:12:01 -0600327 ${message}= Catenate Checking every ${interval} seconds for up to
328 ... ${timeout} seconds for the operating system to communicate.
329 rqprint_timen ${message}
330
Michael Walsh49ab0f42016-07-20 11:44:33 -0500331 Wait Until Keyword Succeeds ${timeout} sec ${interval} Check OS
332 ... ${os_host} ${os_username} ${os_password}
Michael Walsha6723f22016-11-22 11:12:01 -0600333 ... print_string=\#
334
335 rqprintn
336
337 rqprint_timen The operating system is now communicating.
root442f0ef2016-08-04 20:23:05 +0000338
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600339Get BMC State Deprecated
root442f0ef2016-08-04 20:23:05 +0000340 [Documentation] Returns the state of the BMC as a string. (i.e: BMC_READY)
Michael Walsha6723f22016-11-22 11:12:01 -0600341 [Arguments] ${quiet}=${QUIET}
342
root442f0ef2016-08-04 20:23:05 +0000343 @{arglist}= Create List
344 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600345 ${resp}= Call Method ${OPENBMC_BASE_URI}managers/System/ getSystemState
Michael Walsha6723f22016-11-22 11:12:01 -0600346 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000347 Should be equal as strings ${resp.status_code} ${HTTP_OK}
348 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600349 [Return] ${content["data"]}
root442f0ef2016-08-04 20:23:05 +0000350
351Get Power State
352 [Documentation] Returns the power state as an integer. Either 0 or 1.
Michael Walsha6723f22016-11-22 11:12:01 -0600353 [Arguments] ${quiet}=${QUIET}
354
root442f0ef2016-08-04 20:23:05 +0000355 @{arglist}= Create List
356 ${args}= Create Dictionary data=@{arglist}
Michael Walsha6723f22016-11-22 11:12:01 -0600357
George Keishing85ca05e2016-11-30 09:47:18 -0600358 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
Michael Walsha6723f22016-11-22 11:12:01 -0600359 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000360 Should be equal as strings ${resp.status_code} ${HTTP_OK}
361 ${content}= to json ${resp.content}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600362 [Return] ${content["data"]}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500363
364Clear BMC Record Log
365 [Documentation] Clears all the event logs on the BMC. This would be
366 ... equivalent to ipmitool sel clear.
367 @{arglist}= Create List
368 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600369 ${resp}= Call Method
370 ... ${OPENBMC_BASE_URI}records/events/ clear data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500371 should be equal as strings ${resp.status_code} ${HTTP_OK}
372
373Copy PNOR to BMC
374 Import Library SCPLibrary WITH NAME scp
375 Open Connection for SCP
376 Log Copying ${PNOR_IMAGE_PATH} to /tmp
377 scp.Put File ${PNOR_IMAGE_PATH} /tmp
378
379Flash PNOR
380 [Documentation] Calls flash bios update method to flash PNOR image
Gunnar Mills38032802016-12-12 13:43:40 -0600381 [Arguments] ${pnor_image}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500382 @{arglist}= Create List ${pnor_image}
383 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600384 ${resp}= Call Method ${OPENBMC_BASE_URI}control/flash/bios/ update
Michael Walsha6723f22016-11-22 11:12:01 -0600385 ... data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500386 should be equal as strings ${resp.status_code} ${HTTP_OK}
387 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
388
389Get Flash BIOS Status
390 [Documentation] Returns the status of the flash BIOS API as a string. For
391 ... example 'Flashing', 'Flash Done', etc
George Keishing85ca05e2016-11-30 09:47:18 -0600392 ${data}= Read Properties ${OPENBMC_BASE_URI}control/flash/bios
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600393 [Return] ${data['status']}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500394
395Is PNOR Flashing
396 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
397 ... flashing has started.
398 ${status}= Get Flash BIOS Status
Rahul Maheshwari449dfb72017-05-08 02:06:48 -0500399 Should Contain ${status} Flashing
Jay Azurine4c52eb2016-08-16 20:51:10 -0500400
401Is PNOR Flash Done
402 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
403 ... PNOR flashing has completed.
Leah McNutt9ba32272016-11-17 15:48:39 +0000404 ${status}= Get Flash BIOS Status
Jay Azurine4c52eb2016-08-16 20:51:10 -0500405 should be equal as strings ${status} Flash Done
406
407Is System State Host Booted
408 [Documentation] Checks whether system state is HOST_BOOTED.
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600409 ${state}= Get BMC State Deprecated
Jay Azurine4c52eb2016-08-16 20:51:10 -0500410 should be equal as strings ${state} HOST_BOOTED
George Keishing5e870cd2016-08-24 10:05:47 -0500411
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600412Is OS Starting
413 [Documentation] Check if boot progress is OS starting.
414 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500415 Should Be Equal ${boot_progress} OSStart
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600416
George Keishing0af24412017-03-10 13:33:23 -0600417Is OS Off
418 [Documentation] Check if boot progress is "Off".
419 ${boot_progress}= Get Boot Progress
420 Should Be Equal ${boot_progress} Off
421
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500422Get Boot Progress To OS Starting State
423 [Documentation] Get the system to a boot progress state of 'FW Progress,
424 ... Starting OS'.
425
426 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500427 Run Keyword If '${boot_progress}' == 'OSStart'
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500428 ... Log Host is already in OS starting state
429 ... ELSE
430 ... Run Keywords Initiate Host PowerOff AND Initiate Host Boot
431 ... AND Wait Until Keyword Succeeds 10 min 10 sec Is OS Starting
432
George Keishing5e870cd2016-08-24 10:05:47 -0500433Verify Ping and REST Authentication
Michael Walsha6723f22016-11-22 11:12:01 -0600434 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500435 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -0500436 Run Keyword If '${l_ping}' == '${False}'
437 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500438
Michael Walsha6723f22016-11-22 11:12:01 -0600439 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500440 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -0500441 Run Keyword If '${l_rest}' == '${False}'
442 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500443
444 # Just to make sure the SSH is working for SCP
445 Open Connection And Log In
446 ${system} ${stderr}= Execute Command hostname return_stderr=True
447 Should Be Empty ${stderr}
448
George Keishingc4d3dc02016-09-19 03:45:55 -0500449Check If BMC is Up
450 [Documentation] Wait for Host to be online. Checks every X seconds
451 ... interval for Y minutes and fails if timed out.
452 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -0600453 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -0500454 ... ${interval}=10 sec
455
456 Wait Until Keyword Succeeds
457 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
458
George Keishingb3700812016-08-31 03:03:30 -0500459
460Check If warmReset is Initiated
461 [Documentation] Ping would be still alive, so try SSH to connect
462 ... if fails the ports are down indicating reboot
463 ... is in progress
George Keishing3c05d352016-12-13 06:54:50 -0600464
465 # Warm reset adds 3 seconds delay before forcing reboot
466 # To minimize race conditions, we wait for 7 seconds
467 Sleep 7s
George Keishingb3700812016-08-31 03:03:30 -0500468 ${alive}= Run Keyword and Return Status
469 ... Open Connection And Log In
470 Return From Keyword If '${alive}' == '${False}' ${False}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600471 [Return] ${True}
George Keishingb3700812016-08-31 03:03:30 -0500472
George Keishing06ae4aa2016-08-30 01:41:28 -0500473Flush REST Sessions
474 [Documentation] Removes all the active session objects
475 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500476
Sivas SRRe1143ae2016-08-26 22:31:02 -0500477Initialize DBUS cmd
478 [Documentation] Initialize dbus string with property string to extract
Gunnar Mills38032802016-12-12 13:43:40 -0600479 [Arguments] ${boot_property}
Michael Walsha6723f22016-11-22 11:12:01 -0600480 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
481 ${cmd}= Catenate ${cmd}${boot_property}
Sivas SRRe1143ae2016-08-26 22:31:02 -0500482 Set Global Variable ${dbuscmd} ${cmd}
483
David Shawba2d2c22017-01-23 16:56:38 -0600484Create OS Console File Path
485 [Documentation] Create OS console file path name and return it.
486 [Arguments] ${log_file_path}=${EMPTY}
George Keishing30c12ff2016-09-02 10:25:29 -0500487
David Shawba2d2c22017-01-23 16:56:38 -0600488 # Description of arguements:
489 # file_path The caller's candidate value. If this value is ${EMPTY}, this
490 # keyword will compose a file path name. Otherwise, this
491 # keyword will use the caller's file_path value. In either
492 # case, the value will be returned.
Gunnar Mills9c760342016-12-08 10:12:06 -0600493
David Shawba2d2c22017-01-23 16:56:38 -0600494 ${default_file_path}= Catenate /tmp/${OPENBMC_HOST}_os_console
495 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
496 ... ${default_file_path} ${log_file_path}
Michael Walsh01bd3682017-01-10 11:21:05 -0600497
David Shawba2d2c22017-01-23 16:56:38 -0600498 [Return] ${log_file_path}
Gunnar Mills9c760342016-12-08 10:12:06 -0600499
David Shawba2d2c22017-01-23 16:56:38 -0600500Create OS Console Command String
501 [Documentation] Return a command string to start OS console logging.
Gunnar Mills9c760342016-12-08 10:12:06 -0600502
David Shawba2d2c22017-01-23 16:56:38 -0600503 # First make sure that the ssh_pw program is available.
504 ${cmd_buf}= Catenate which ssh_pw 2>&1
505 Rdpissuing ${cmd_buf}
506 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
507 Rdpvars rc output
508 Should Be Equal ${rc} ${0} msg=${output}\n
Gunnar Mills9c760342016-12-08 10:12:06 -0600509
David Shawba2d2c22017-01-23 16:56:38 -0600510 ${cmd_buf}= Catenate ssh_pw ${OPENBMC_PASSWORD} -p 2200
George Keishing1f9ec7f2017-06-06 08:59:19 -0500511 ... -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST}
George Keishing30c12ff2016-09-02 10:25:29 -0500512
David Shawba2d2c22017-01-23 16:56:38 -0600513 [Return] ${cmd_buf}
George Keishing30c12ff2016-09-02 10:25:29 -0500514
515Stop SOL Console Logging
David Shawba2d2c22017-01-23 16:56:38 -0600516 [Documentation] Stop system console logging and return log output.
George Keishing72992e42017-06-16 06:42:36 -0500517 [Arguments] ${log_file_path}=${EMPTY}
518 ... ${targ_file_path}=${EXECDIR}${/}logs${/}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500519 ... ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600520
521 # If there are muliple system console processes, they will all be stopped.
522 # If there is no existing log file this keyword will return an error
523 # message to that effect (and write that message to targ_file_path, if
524 # specified).
525 # NOTE: This keyword will not fail if there is no running system console
526 # process.
Michael Walsh01bd3682017-01-10 11:21:05 -0600527
528 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600529 # log_file_path The file path that was used to call "Start SOL
530 # Console Logging". See that keyword (above) for details.
531 # targ_file_path If specified, the file path to which the source
532 # file path (i.e. "log_file_path") should be copied.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500533 # return_data If this is set to ${1}, this keyword will return the SOL
534 # data to the caller as a unicode string.
George Keishing30c12ff2016-09-02 10:25:29 -0500535
David Shawba2d2c22017-01-23 16:56:38 -0600536 ${log_file_path}= Create OS Console File Path ${log_file_path}
537 # Find the pid of the active system console logging session (if any).
538 ${search_string}= Create OS Console Command String
Michael Walsh391ba9b2017-08-24 11:36:24 -0500539 # At least in some cases, ps output does not show double quotes so we must
540 # replace them in our search string with the regexes to indicate that they
541 # are optional.
542 ${search_string}= Replace String ${search_string} " ["]?
David Shawba2d2c22017-01-23 16:56:38 -0600543 ${cmd_buf}= Catenate echo $(ps -ef | egrep '${search_string}'
544 ... | egrep -v grep | cut -c10-14)
545 Rdpissuing ${cmd_buf}
546 ${rc} ${os_con_pid}= Run And Return Rc And Output ${cmd_buf}
547 Rdpvars os_con_pid
548 # If rc is not zero it just means that there is no OS Console process
549 # running.
George Keishing30c12ff2016-09-02 10:25:29 -0500550
David Shawba2d2c22017-01-23 16:56:38 -0600551 ${cmd_buf}= Catenate kill -9 ${os_con_pid}
552 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpissuing ${cmd_buf}
553 ${rc} ${output}= Run Keyword If '${os_con_pid}' != '${EMPTY}'
554 ... Run And Return Rc And Output ${cmd_buf}
555 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpvars rc output
George Keishing30c12ff2016-09-02 10:25:29 -0500556
Michael Walsh01bd3682017-01-10 11:21:05 -0600557 Run Keyword If '${targ_file_path}' != '${EMPTY}'
David Shawba2d2c22017-01-23 16:56:38 -0600558 ... Run Keyword And Ignore Error
559 ... Copy File ${log_file_path} ${targ_file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500560
Michael Walsh5f3f4142017-05-22 17:09:47 -0500561 ${output}= Set Variable ${EMPTY}
562 ${loc_quiet}= Evaluate ${debug}^1
563 ${rc} ${output}= Run Keyword If '${return_data}' == '${1}'
564 ... Cmd Fnc cat ${log_file_path} quiet=${loc_quiet} print_output=${0}
565
David Shawba2d2c22017-01-23 16:56:38 -0600566 [Return] ${output}
567
568Start SOL Console Logging
569 [Documentation] Start system console log to file.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500570 [Arguments] ${log_file_path}=${EMPTY} ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600571
572 # This keyword will first call "Stop SOL Console Logging". Only then will
573 # it start SOL console logging. The data returned by "Stop SOL Console
574 # Logging" will in turn be returned by this keyword.
575
576 # Description of arguments:
Michael Walsh5f3f4142017-05-22 17:09:47 -0500577 # log_file_path The file path to which system console log data should be
578 # written. Note that this path is taken to be a location
579 # on the machine where this program is running rather than
580 # on the Open BMC system.
581 # return_data If this is set to ${1}, this keyword will return any SOL
582 # data to the caller as a unicode string.
David Shawba2d2c22017-01-23 16:56:38 -0600583
584 ${log_file_path}= Create OS Console File Path ${log_file_path}
585
586 ${log_output}= Stop SOL Console Logging ${log_file_path}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500587 ... return_data=${return_data}
David Shawba2d2c22017-01-23 16:56:38 -0600588
589 # Validate by making sure we can create the file. Problems creating the
590 # file would not be noticed by the subsequent ssh command because we fork
591 # the command.
592 Create File ${log_file_path}
593 ${sub_cmd_buf}= Create OS Console Command String
594 # Routing stderr to stdout so that any startup error text will go to the
595 # output file.
596 ${cmd_buf}= Catenate ${sub_cmd_buf} > ${log_file_path} 2>&1 &
597 Rdpissuing ${cmd_buf}
598 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
599 # Because we are forking this command, we essentially will never get a
600 # non-zero return code or any output.
601 Should Be Equal ${rc} ${0}
602
603 [Return] ${log_output}
George Keishing30c12ff2016-09-02 10:25:29 -0500604
605Get Time Stamp
606 [Documentation] Get the current time stamp data
607 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500608 [Return] ${cur_time}
George Keishing30c12ff2016-09-02 10:25:29 -0500609
George Keishing1b150202016-09-29 08:51:58 -0500610
611Verify BMC State
612 [Documentation] Get the BMC state and verify if the current
613 ... BMC state is as expected.
614 [Arguments] ${expected}
615
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600616 ${current}= Get BMC State Deprecated
George Keishing8db0e1b2016-10-20 13:46:54 -0500617 Should Contain ${expected} ${current}
George Keishing1b150202016-09-29 08:51:58 -0500618
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500619Start Journal Log
620 [Documentation] Start capturing journal log to a file in /tmp using
621 ... journalctl command. By default journal log is collected
622 ... at /tmp/journal_log else user input location.
623 ... The File is appended with datetime.
624 [Arguments] ${file_path}=/tmp/journal_log
625
626 Open Connection And Log In
627
628 ${cur_time}= Get Time Stamp
629 Set Global Variable ${LOG_TIME} ${cur_time}
630 Start Command
631 ... journalctl -f > ${file_path}-${LOG_TIME}
632 Log Journal Log Started: ${file_path}-${LOG_TIME}
633
David Shawba2d2c22017-01-23 16:56:38 -0600634
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500635Stop Journal Log
636 [Documentation] Stop journalctl process if its running.
637 ... By default return log from /tmp/journal_log else
638 ... user input location.
639 [Arguments] ${file_path}=/tmp/journal_log
640
641 Open Connection And Log In
642
643 ${rc}=
644 ... Execute Command
645 ... ps ax | grep journalctl | grep -v grep
646 ... return_stdout=False return_rc=True
647
648 Return From Keyword If '${rc}' == '${1}'
649 ... No journal log process running
650
651 ${output} ${stderr}=
652 ... Execute Command killall journalctl
653 ... return_stderr=True
654 Should Be Empty ${stderr}
655
656 ${journal_log} ${stderr}=
657 ... Execute Command
658 ... cat ${file_path}-${LOG_TIME}
659 ... return_stderr=True
660 Should Be Empty ${stderr}
661
662 Log ${journal_log}
663
664 Execute Command rm ${file_path}-${LOG_TIME}
665
666 [Return] ${journal_log}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500667
668Mac Address To Hex String
669 [Documentation] Converts MAC address into hex format.
670 ... Example
671 ... Given the following MAC: 00:01:6C:80:02:78
672 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
673 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600674 ... i_macaddress MAC address in the following format
675 ... 00:01:6C:80:02:78
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500676 [Arguments] ${i_macaddress}
677
678 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600679 [Return] ${mac_hex}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500680
681IP Address To Hex String
682 [Documentation] Converts IP address into hex format.
683 ... Example:
684 ... Given the following IP: 10.3.164.100
685 ... This keyword will return: 0xa 0x3 0xa4 0xa0
686 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600687 ... i_ipaddress IP address in the following format
688 ... 10.10.10.10
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500689 [Arguments] ${i_ipaddress}
690
691 @{ip}= Split String ${i_ipaddress} .
692 ${index}= Set Variable ${0}
693
694 :FOR ${item} IN @{ip}
695 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes
696 \ Set List Value ${ip} ${index} ${hex}
697 \ ${index}= Set Variable ${index + 1}
698 ${ip_hex}= Catenate @{ip}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600699 [Return] ${ip_hex}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600700
701BMC CPU Performance Check
702 [Documentation] Minimal 10% of proc should be free in this instance
703
704 ${bmc_cpu_usage_output} ${stderr}= Execute Command ${bmc_cpu_usage_cmd}
705 ... return_stderr=True
706 Should be empty ${stderr}
707 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} %
708 Should be true ${bmc_cpu_percentage} < 90
709
710BMC Mem Performance Check
711 [Documentation] Minimal 10% of memory should be free in this instance
712
713 ${bmc_mem_free_output} ${stderr}= Execute Command ${bmc_mem_free_cmd}
714 ... return_stderr=True
715 Should be empty ${stderr}
716
717 ${bmc_mem_total_output} ${stderr}= Execute Command ${bmc_mem_total_cmd}
718 ... return_stderr=True
719 Should be empty ${stderr}
720
721 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100
722 ${bmc_mem_percentage}= Evaluate
723 ... ${bmc_mem_percentage}/${bmc_mem_total_output}
724 Should be true ${bmc_mem_percentage} > 10
725
Sivas SRRaca55712016-12-21 04:32:35 -0600726BMC File System Usage Check
727 [Documentation] Check the file system space. None should be 100% full
Sivas SRR352bc162017-02-13 22:12:29 -0600728 ... except /run/initramfs/ro
Sivas SRRaca55712016-12-21 04:32:35 -0600729 ${bmc_fs_usage_output} ${stderr}= Execute Command
730 ... ${bmc_file_system_usage_cmd} return_stderr=True
731 Should Be Empty ${stderr}
732 Should Be True ${bmc_fs_usage_output}==0
733
Sivas SRRea85d1f2016-11-13 22:44:28 -0600734Check BMC CPU Performance
735 [Documentation] Minimal 10% of proc should be free in 3 sample
736 :FOR ${var} IN Range 1 4
737 \ BMC CPU Performance check
738
739Check BMC Mem Performance
740 [Documentation] Minimal 10% of memory should be free
741
742 :FOR ${var} IN Range 1 4
743 \ BMC Mem Performance check
744
Sivas SRRaca55712016-12-21 04:32:35 -0600745Check BMC File System Performance
746 [Documentation] Check for file system usage for 4 times
747
748 :FOR ${var} IN Range 1 4
749 \ BMC File System Usage check
750
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500751Get URL List
752 [Documentation] Return list of URLs under given URL.
753 [Arguments] ${openbmc_url}
754 # Description of argument(s):
Michael Walsh5f3f4142017-05-22 17:09:47 -0500755 # openbmc_url URL for list operation (e.g.
756 # /xyz/openbmc_project/inventory).
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500757
George Keishing335f5362017-06-30 15:11:20 -0500758 ${url_list}= Read Properties ${openbmc_url}/list quiet=${1}
George Keishing184a89a2017-06-27 07:12:16 -0500759 Sort List ${url_list}
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500760 [Return] ${url_list}
761
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600762Get Endpoint Paths
763 [Documentation] Returns all url paths ending with given endpoint
764 ... Example:
765 ... Given the following endpoint: cpu
Michael Walsh01bd3682017-01-10 11:21:05 -0600766 ... This keyword will return: list of all urls ending with
767 ... cpu -
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600768 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
769 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
770 ... Description of arguments:
771 ... path URL path for enumeration
772 ... endpoint string for which url path ending
773 [Arguments] ${path} ${endpoint}
774
775 ${resp}= Read Properties ${path}/enumerate timeout=30
776 log Dictionary ${resp}
777
778 ${list}= Get Dictionary Keys ${resp}
779 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9]*$
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600780 [Return] ${resp}
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500781
782Check Zombie Process
783 [Documentation] Check if any defunct process exist or not on BMC
Michael Walsh01bd3682017-01-10 11:21:05 -0600784 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500785 ... return_stderr=True return_rc=True
786 Should Be True ${count}==0
787 Should Be Empty ${stderr}
George Keishing5327d012016-12-08 08:43:29 -0600788
789Prune Journal Log
790 [Documentation] Prune archived journal logs.
791 [Arguments] ${vacuum_size}=1M
792
793 # This keyword can be used to prevent the journal
794 # log from filling up the /run filesystem.
795 # This command will retain only the latest logs
796 # of the user specified size.
797
798 Open Connection And Log In
799 ${output} ${stderr} ${rc}=
800 ... Execute Command
801 ... journalctl --vacuum-size=${vacuum_size}
802 ... return_stderr=True return_rc=True
803
804 Should Be Equal ${rc} ${0} msg=${stderr}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600805
806Set BMC Power Policy
807 [Documentation] Set the given BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -0500808 [Arguments] ${policy}
809
810 # Note that this function will translate the old style "RESTORE_LAST_STATE"
811 # policy to the new style "xyz.openbmc_project.Control.Power.RestorePolicy.
812 # Policy.Restore" for you.
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600813
George Keishing1c3a9662017-08-11 10:16:36 -0500814 # Description of argument(s):
Michael Walshfdc5ced2017-08-17 13:15:15 -0500815 # policy Power restore policy (e.g "RESTORE_LAST_STATE",
816 # ${RESTORE_LAST_STATE}).
817
818 # Set the bmc_power_policy_method to either 'Old' or 'New'.
819 Set Power Policy Method
820 # This translation helps bridge between old and new method for calling.
821 ${policy}= Translate Power Policy Value ${policy}
822 # Run the appropriate keyword.
823 Run Key ${bmc_power_policy_method} Set Power Policy \ ${policy}
824 ${currentPolicy}= Get System Power Policy
825 Should Be Equal ${currentPolicy} ${policy}
826
827New Set Power Policy
828 [Documentation] Set the given BMC power policy (new method).
829 [Arguments] ${policy}
830
831 # Description of argument(s):
832 # policy Power restore policy (e.g. ${RESTORE_LAST_STATE}).
George Keishing1c3a9662017-08-11 10:16:36 -0500833
834 ${valueDict}= Create Dictionary data=${policy}
835 Write Attribute
Michael Walshfdc5ced2017-08-17 13:15:15 -0500836 ... ${POWER_RESTORE_URI} PowerRestorePolicy data=${valueDict}
837
838Old Set Power Policy
839 [Documentation] Set the given BMC power policy (old method).
840 [Arguments] ${policy}
841
842 # Description of argument(s):
843 # policy Power restore policy (e.g. "RESTORE_LAST_STATE").
844
845 ${valueDict}= create dictionary data=${policy}
846 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
George Keishingcce9df22017-01-24 06:19:33 -0600847
George Keishing4d6f3d62017-02-06 09:50:41 -0600848Get System Power Policy
849 [Documentation] Get the BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -0500850
851 # Set the bmc_power_policy_method to either 'Old' or 'New'.
852 Set Power Policy Method
853 ${cmd_buf}= Create List ${bmc_power_policy_method} Get Power Policy
854 # Run the appropriate keyword.
855 ${currentPolicy}= Run Keyword @{cmd_buf}
856 [Return] ${currentPolicy}
857
858New Get Power Policy
859 [Documentation] Get the BMC power policy (new method).
George Keishing1c3a9662017-08-11 10:16:36 -0500860 ${currentPolicy}= Read Attribute ${POWER_RESTORE_URI} PowerRestorePolicy
George Keishing4d6f3d62017-02-06 09:50:41 -0600861 [Return] ${currentPolicy}
George Keishingcce9df22017-01-24 06:19:33 -0600862
Michael Walshfdc5ced2017-08-17 13:15:15 -0500863Old Get Power Policy
864 [Documentation] Get the BMC power policy (old method).
865 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
866 [Return] ${currentPolicy}
867
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600868Get Auto Reboot
869 [Documentation] Returns auto reboot setting.
Sweta Potthuri62a23572017-07-28 04:05:13 -0500870 ${setting}= Read Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600871 [Return] ${setting}
872
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600873Set Auto Reboot
874 [Documentation] Set the given auto reboot setting.
875 [Arguments] ${setting}
Sweta Potthuri62a23572017-07-28 04:05:13 -0500876 # setting auto reboot's setting, i.e. 1 for enabling and 0 for disabling.
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600877
878 ${valueDict}= Set Variable ${setting}
879 ${data}= Create Dictionary data=${valueDict}
Sweta Potthuri62a23572017-07-28 04:05:13 -0500880 Write Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot data=${data}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600881 ${current_setting}= Get Auto Reboot
Sweta Potthuri62a23572017-07-28 04:05:13 -0500882 Should Be Equal As Integers ${current_setting} ${setting}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -0600883
884
George Keishingcce9df22017-01-24 06:19:33 -0600885Set BMC Reset Reference Time
886 [Documentation] Set current boot time as a reference and increment
George Keishing80dd5af2017-02-08 07:01:25 -0600887 ... boot count.
George Keishingcce9df22017-01-24 06:19:33 -0600888
889 ${cur_btime}= Get BMC Boot Time
George Keishing80dd5af2017-02-08 07:01:25 -0600890 Run Keyword If ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
George Keishingcce9df22017-01-24 06:19:33 -0600891 ... Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishing80dd5af2017-02-08 07:01:25 -0600892 ... ELSE IF ${cur_btime} > ${BOOT_TIME}
893 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishingcce9df22017-01-24 06:19:33 -0600894 ... AND
895 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
896
George Keishingcce9df22017-01-24 06:19:33 -0600897Get BMC Boot Time
898 [Documentation] Get boot time from /proc/stat.
899
900 Open Connection And Log In
901 ${output} ${stderr}=
902 ... Execute Command egrep '^btime ' /proc/stat | cut -f 2 -d ' '
903 ... return_stderr=True
904 Should Be Empty ${stderr}
905 ${btime}= Convert To Integer ${output}
906 [Return] ${btime}
George Keishingede30002017-02-02 09:33:07 -0600907
George Keishingede30002017-02-02 09:33:07 -0600908Execute Command On BMC
909 [Documentation] Execute given command on BMC and return output.
910 [Arguments] ${command}
911 ${stdout} ${stderr}= Execute Command ${command} return_stderr=True
912 Should Be Empty ${stderr}
913 [Return] ${stdout}
David Shawba2d2c22017-01-23 16:56:38 -0600914
Sridevi Rameshea36b412017-03-09 04:08:02 -0600915
George Keishing7a520222017-02-27 09:44:30 -0600916Enable Core Dump On BMC
917 [Documentation] Enable core dump collection.
918 Open Connection And Log In
919 ${core_pattern}= Execute Command On BMC
920 ... echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
921 Should Be Equal As Strings ${core_pattern} /tmp/core_%e.%p
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600922
Sivas SRR01262bd2017-03-19 10:00:23 -0500923Get Number Of BMC Core Dump Files
924 [Documentation] Get number of core dump files on BMC.
925 Open Connection And Log In
926 ${num_of_core_dump}= Execute Command
927 ... ls /tmp/core* 2>/dev/null | wc -l
928 [Return] ${num_of_core_dump}
929
930Set Core Dump File Size Unlimited
931 [Documentation] Set core dump file size to unlimited.
932 Open Connection And Log In
933 Execute Command On BMC
934 ... ulimit -c unlimited
935
936Check For Core Dumps
937 [Documentation] Check for any core dumps exist.
938 ${output}= Get Number Of BMC Core Dump Files
939 Run Keyword If ${output} > 0
940 ... Log **Warning** BMC core dump files exist level=WARN
941
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600942Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -0500943 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600944 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Michael Walshb5839d02017-04-12 16:11:20 -0500945 # Description of argument(s):
946 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
947 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600948 # sleep_time Time delay for host watchdog error to get injected.
949 # Default is 5 seconds.
950
George Keishing37cfa6b2017-06-15 10:25:55 -0500951 ${data}= Create Dictionary data=${True}
952 Write Attribute /xyz/openbmc_project/watchdog/host0 Enabled data=${data}
953
954 ${data}= Create Dictionary data=${milliseconds}
955 Write Attribute /xyz/openbmc_project/watchdog/host0 TimeRemaining data=${data}
956
Rahul Maheshwarie95622c2017-02-24 10:04:29 -0600957 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500958
959Login To OS Host
960 [Documentation] Login to OS Host.
961 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
962 ... ${os_password}=${OS_PASSWORD}
963 # Desription of arguments:
964 # ${os_host} IP address of the OS Host.
965 # ${os_username} OS Host Login user name.
966 # ${os_password} OS Host Login passwrd.
967
968 ${os_state}= Run Keyword And Return Status Ping Host ${os_host}
969 Run Keyword If '${os_state}' == 'False'
970 ... Run Keywords Initiate Host Reboot AND
971 ... Is Host Running AND
972 ... Wait for OS ${os_host} ${os_username} ${os_password}
973
George Keishing3f223b82017-06-28 03:50:35 -0500974 SSHLibrary.Open Connection ${os_host}
Sridevi Rameshea36b412017-03-09 04:08:02 -0600975 ${resp}= Login ${os_username} ${os_password}
976 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -0500977
978Configure Initial Settings
979 [Documentation] Restore old IP and route.
980 ... This keyword requires initial settings viz IP address,
981 ... Network Mask, default gatway and serial console IP and port
982 ... information which should be provided in command line.
983
Michael Walshb5839d02017-04-12 16:11:20 -0500984 [Arguments] ${host}=${OPENBMC_HOST} ${mask}=${NET_MASK}
985 ... ${gw_ip}=${GW_IP}
Prashanth Katti884ee062017-03-16 05:05:03 -0500986
Michael Walshb5839d02017-04-12 16:11:20 -0500987 # Open telnet connection and ignore the error, in case telnet session is
988 # already opened by the program calling this keyword.
Prashanth Katti884ee062017-03-16 05:05:03 -0500989
990 Run Keyword And Ignore Error Open Telnet Connection to BMC Serial Console
991 Telnet.write ifconfig eth0 ${host} netmask ${mask}
992 Telnet.write route add default gw ${gw_ip}
George Keishingd05b1082017-03-24 05:27:32 -0500993
994Install Debug Tarball On BMC
George Keishing55441822017-05-18 14:17:59 -0500995 [Documentation] Copy the debug tar file to BMC and install.
996 [Arguments] ${tarball_file_path}=${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz
997 ... ${targ_tarball_dir_path}=/home/root/tarball/
George Keishingd05b1082017-03-24 05:27:32 -0500998
George Keishing55441822017-05-18 14:17:59 -0500999 # Description of arguments:
1000 # tarball_file_path Path of the debug tarball file.
1001 # The tar file is downloaded from the build page
1002 # https://openpower.xyz/job/openbmc-build/
1003 # obmc-phosphor-debug-tarball-witherspoon.tar.xz
1004 #
1005 # targ_tarball_dir_path The directory path where the tarball is to be
1006 # installed.
1007
1008 OperatingSystem.File Should Exist ${tarball_file_path}
1009 ... msg=${tarball_file_path} doesn't exist.
1010
1011 # Upload the file to BMC.
George Keishingd05b1082017-03-24 05:27:32 -05001012 Import Library SCPLibrary WITH NAME scp
1013 Open Connection for SCP
George Keishing55441822017-05-18 14:17:59 -05001014 scp.Put File ${tarball_file_path} /tmp/debug-tarball.tar.xz
1015
1016 # Create tarball directory and install.
George Keishingd05b1082017-03-24 05:27:32 -05001017 Open Connection And Log In
George Keishing55441822017-05-18 14:17:59 -05001018 Execute Command On BMC mkdir -p ${targ_tarball_dir_path}
1019 Execute Command On BMC
1020 ... tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path}
1021
1022 # Create symlink to callout-test binary.
1023 Execute Command On BMC
1024 ... ln -s ${targ_tarball_dir_path}/bin/callout-test /usr/bin/callout-test
1025
George Keishing4fc998b2017-05-26 05:24:12 -05001026 # Create symlink to logging-test binary.
1027 Execute Command On BMC
1028 ... ln -s ${targ_tarball_dir_path}/bin/logging-test /usr/bin/logging-test
1029
George Keishingd05b1082017-03-24 05:27:32 -05001030 # Remove the tarball file from BMC
1031 Execute Command On BMC rm /tmp/debug-tarball.tar.xz
1032
George Keishing55441822017-05-18 14:17:59 -05001033
Sweta Potthuri025e0122017-02-21 00:42:48 -06001034Get BMC Boot Count
1035 [Documentation] Get BMC boot count based on boot time.
1036 ${cur_btime}= Get BMC Boot Time
1037
1038 # Set global variable BOOT_TIME to current boot time if current boot time
1039 # is changed. Also increase value of global variable BOOT_COUNT by 1.
1040 Run Keyword If ${cur_btime} > ${BOOT_TIME}
1041 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
1042 ... AND
1043 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
1044 [Return] ${BOOT_COUNT}
1045
1046Set BMC Boot Count
1047 [Documentation] Set BMC boot count to given value.
1048 [Arguments] ${count}
1049
1050 # Description of arguments:
1051 # count boot count value.
1052 ${cur_btime}= Get BMC Boot Time
1053
1054 # Set global variable BOOT_COUNT to given value.
1055 Set Global Variable ${BOOT_COUNT} ${count}
1056
1057 # Set BOOT_TIME variable to current boot time.
1058 Set Global Variable ${BOOT_COUNT} ${count}
Michael Walsh689fbbe2017-04-04 17:58:03 -05001059
Sweta Potthurie5a9fc72017-05-03 07:02:46 -05001060Get System LED State
1061 [Documentation] Return the state of given system LED.
1062 [Arguments] ${led_name}
1063
1064 # Description of argument(s):
1065 # led_name System LED name (e.g. heartbeat, identify, beep).
1066
1067 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State
1068 [Return] ${state.rsplit('.', 1)[1]}
1069
Michael Walsh689fbbe2017-04-04 17:58:03 -05001070###############################################################################
George Keishingd2d90af2017-06-27 08:17:34 -05001071Delete Error Logs
Michael Walsh689fbbe2017-04-04 17:58:03 -05001072 [Documentation] Delete error logs.
1073
George Keishingd2d90af2017-06-27 08:17:34 -05001074 # Check if error logs entries exist, if not return.
George Keishing335f5362017-06-30 15:11:20 -05001075 ${resp}= OpenBMC Get Request ${BMC_LOGGING_ENTRY}${/}list quiet=${1}
George Keishingd2d90af2017-06-27 08:17:34 -05001076 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND}
1077
1078 # Get the list of error logs entries and delete them all.
George Keishing335f5362017-06-30 15:11:20 -05001079 ${elog_entries}= Get URL List ${BMC_LOGGING_ENTRY}
George Keishingd2d90af2017-06-27 08:17:34 -05001080 :FOR ${entry} IN @{elog_entries}
1081 \ Delete Error Log Entry ${entry}
George Keishingdb34c2f2017-04-18 13:20:25 -05001082
1083###############################################################################
George Keishingd2d90af2017-06-27 08:17:34 -05001084Delete Error Log Entry
George Keishingdb34c2f2017-04-18 13:20:25 -05001085 [Documentation] Delete error log entry.
1086 [Arguments] ${entry_path}
1087
1088 # Description of argument(s):
1089 # entry_path Delete an error log entry.
1090 # Ex. /xyz/openbmc_project/logging/entry/1
1091
George Keishing6a8ed0f2017-07-11 22:54:42 -05001092 # Skip delete if entry URI is a callout.
1093 # Example: /xyz/openbmc_project/logging/entry/1/callout
1094 Return From Keyword If '${entry_path.rsplit('/', 1)[1]}' == 'callout'
1095
George Keishingdb34c2f2017-04-18 13:20:25 -05001096 ${data}= Create Dictionary data=@{EMPTY}
1097 ${resp}= Openbmc Delete Request ${entry_path} data=${data}
1098 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Rahul Maheshwari43be6932017-05-01 02:37:06 -05001099
1100
George Keishingad5817a2017-06-28 10:19:03 -05001101###############################################################################
Rahul Maheshwari43be6932017-05-01 02:37:06 -05001102Get LED State XYZ
1103 [Documentation] Returns state of given LED.
1104 [Arguments] ${led_name}
1105 # Description of argument(s):
1106 # led_name Name of LED
1107
1108 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
1109 [Return] ${state}
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001110
1111
George Keishingad5817a2017-06-28 10:19:03 -05001112###############################################################################
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001113Get 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
1123###############################################################################
1124Get Elog URL List
1125 [Documentation] Return error log entry list of URLs.
1126
1127 ${url_list}= Read Properties /xyz/openbmc_project/logging/entry/
1128 Sort List ${url_list}
1129 [Return] ${url_list}
1130
1131
1132###############################################################################