blob: 81b82a256c7332104b73e1266fea479ee9f915e6 [file] [log] [blame]
Chris Austenb29d2e82016-06-07 12:25:35 -05001*** Settings ***
Steven Sombar0acb3412018-01-24 09:38:42 -06002
3Documentation Utilities for Robot keywords.
4
Chris Austenb29d2e82016-06-07 12:25:35 -05005Resource ../lib/resource.txt
6Resource ../lib/rest_client.robot
George Keishing5e870cd2016-08-24 10:05:47 -05007Resource ../lib/connection_client.robot
Rahul Maheshwarid1f45f22018-10-26 05:16:39 -05008Resource ../lib/boot_utils.robot
Michael Walsh391ba9b2017-08-24 11:36:24 -05009Library String
George Keishing30c12ff2016-09-02 10:25:29 -050010Library DateTime
11Library Process
Chris Austenb29d2e82016-06-07 12:25:35 -050012Library OperatingSystem
Michael Walsha6723f22016-11-22 11:12:01 -060013Library gen_print.py
14Library gen_robot_print.py
Michael Walsh5f3f4142017-05-22 17:09:47 -050015Library gen_cmd.py
Sunil Macd110a2017-05-23 04:14:32 -050016Library gen_robot_keyword.py
Michael Walshe53e47a2017-06-30 17:03:24 -050017Library bmc_ssh_utils.py
Michael Walshfdc5ced2017-08-17 13:15:15 -050018Library utils.py
Charles Paul Hofer35816152017-10-02 11:55:11 -050019Library var_funcs.py
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050020Library SCPLibrary WITH NAME scp
Chris Austenb29d2e82016-06-07 12:25:35 -050021
22*** Variables ***
Steven Sombar0acb3412018-01-24 09:38:42 -060023
24${pflash_cmd} /usr/sbin/pflash -r /dev/stdout -P VERSION
25${SYSTEM_SHUTDOWN_TIME} ${5}
26
Michael Walsha6723f22016-11-22 11:12:01 -060027${dbuscmdBase}
George Keishing85ca05e2016-11-30 09:47:18 -060028... dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host
Michael Walsha6723f22016-11-22 11:12:01 -060029${dbuscmdGet}
George Keishing9485af92017-01-04 10:21:43 -060030... ${SETTINGS_URI}host0 org.freedesktop.DBus.Properties.Get
Steven Sombar0acb3412018-01-24 09:38:42 -060031${dbuscmdString}= string:"xyz.openbmc_project.settings.Host" string:
Michael Walsha6723f22016-11-22 11:12:01 -060032
33# Assign default value to QUIET for programs which may not define it.
34${QUIET} ${0}
Steven Sombar0acb3412018-01-24 09:38:42 -060035
Sivas SRRea85d1f2016-11-13 22:44:28 -060036${bmc_mem_free_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4
37${bmc_mem_total_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2
38${bmc_cpu_usage_cmd}= top -n 1 | grep CPU: | cut -c 7-9
Sridevi Ramesh1699d372016-12-06 00:20:22 -060039${HOST_SETTING} ${SETTINGS_URI}host0
Steven Sombar0acb3412018-01-24 09:38:42 -060040
Sivas SRR352bc162017-02-13 22:12:29 -060041# /run/initramfs/ro associate filesystem should be 100% full always
Sivas SRR5ff4d692017-11-23 02:53:52 -060042${bmc_file_system_usage_cmd}= df -h | cut -c 52-54 | grep 100 | wc -l
43${total_pnor_ro_file_system_cmd}= df -h | grep /media/pnor-ro | wc -l
44${total_bmc_ro_file_system_cmd}= df -h | grep /media/rofs | wc -l
Chris Austenb29d2e82016-06-07 12:25:35 -050045
George Keishingcce9df22017-01-24 06:19:33 -060046${BOOT_TIME} ${0}
47${BOOT_COUNT} ${0}
Sweta Potthuri025e0122017-02-21 00:42:48 -060048${count} ${0}
Sivas SRR8254db62017-02-07 09:39:46 -060049${devicetree_base} /sys/firmware/devicetree/base/model
George Keishingcce9df22017-01-24 06:19:33 -060050
George Keishingb7c9b542017-05-23 08:19:58 -050051# Initialize default debug value to 0.
52${DEBUG} ${0}
53
Steven Sombar0acb3412018-01-24 09:38:42 -060054${probe_cpu_tool_path} ${EXECDIR}/tools/ras/probe_cpus.sh
55${scom_addrs_tool_path} ${EXECDIR}/tools/ras/scom_addr_p9.sh
56${target_file_path} /root/
57
58${default_tarball} ${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz
59
Michael Walshfdc5ced2017-08-17 13:15:15 -050060# These variables are used to straddle between new and old methods of setting
61# values.
Steven Sombar0acb3412018-01-24 09:38:42 -060062${boot_prog_method} ${EMPTY}
Michael Walshfdc5ced2017-08-17 13:15:15 -050063${power_policy_setup} ${0}
64${bmc_power_policy_method} ${EMPTY}
65@{valid_power_policy_vars} RESTORE_LAST_STATE ALWAYS_POWER_ON
66... ALWAYS_POWER_OFF
67
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050068
Chris Austenb29d2e82016-06-07 12:25:35 -050069*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060070
Sivas SRRc0957412017-10-06 13:02:08 -050071Check BMC Performance
72 [Documentation] Check BMC basic CPU Mem File system performance.
73
74 Check BMC CPU Performance
75 Check BMC Mem Performance
76 Check BMC File System Performance
77
Steven Sombar0acb3412018-01-24 09:38:42 -060078
Sivas SRRd97aa9c2017-05-22 11:19:25 -050079Verify PNOR Update
80 [Documentation] Verify that the PNOR is not corrupted.
81 # Example:
82 # FFS: Flash header not found. Code: 100
83 # Error 100 opening ffs !
84
George Keishing21650dd2018-10-24 08:25:58 -050085 ${stdout} ${stderr} ${rc}=
Michael Walsh26a16782018-11-13 15:42:32 -060086 ... BMC Execute Command /usr/sbin/pflash -h | egrep -q skip
87 ... ignore_err=${1}
88 ${pflash_cmd}= Set Variable If ${rc} == ${0} ${pflash_cmd} --skip=4096
89 ... ${pflash_cmd}
George Keishinga37682e2018-06-15 13:12:13 -050090 ${pnor_info}= BMC Execute Command ${pflash_cmd}
Sivas SRRd97aa9c2017-05-22 11:19:25 -050091 Should Not Contain Any ${pnor_info} Flash header not found Error
92
Steven Sombar0acb3412018-01-24 09:38:42 -060093
Sivas SRR8254db62017-02-07 09:39:46 -060094Get BMC System Model
Steven Sombar0acb3412018-01-24 09:38:42 -060095 [Documentation] Get the BMC model from the device tree and return it.
Sivas SRR8254db62017-02-07 09:39:46 -060096
Michael Walshe53e47a2017-06-30 17:03:24 -050097 ${bmc_model} ${stderr} ${rc}= BMC Execute Command
George Keishing90ab1772017-02-24 05:40:55 -060098 ... cat ${devicetree_base} | cut -d " " -f 1 return_stderr=True
Michael Walsh71182ab2017-10-20 14:44:25 -050099 ... test_mode=0
Sivas SRR8254db62017-02-07 09:39:46 -0600100 Should Be Empty ${stderr}
Steven Sombar0acb3412018-01-24 09:38:42 -0600101 Should Not Be Empty ${bmc_model} msg=BMC model is empty.
Sivas SRR8254db62017-02-07 09:39:46 -0600102 [Return] ${bmc_model}
103
Steven Sombar0acb3412018-01-24 09:38:42 -0600104
Sivas SRR8254db62017-02-07 09:39:46 -0600105Verify BMC System Model
106 [Documentation] Verify the BMC model with ${OPENBMC_MODEL}.
107 [Arguments] ${bmc_model}
108
Steven Sombar0acb3412018-01-24 09:38:42 -0600109 # Description of argument(s):
110 # bmc_model System model (e.g. "witherspoon").
111
Sivas SRR8254db62017-02-07 09:39:46 -0600112 ${tmp_bmc_model}= Fetch From Right ${OPENBMC_MODEL} /
113 ${tmp_bmc_model}= Fetch From Left ${tmp_bmc_model} .
114 ${ret}= Run Keyword And Return Status Should Contain ${bmc_model}
115 ... ${tmp_bmc_model} ignore_case=True
116 [Return] ${ret}
117
Steven Sombar0acb3412018-01-24 09:38:42 -0600118
Chris Austenb29d2e82016-06-07 12:25:35 -0500119Wait For Host To Ping
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500120 [Documentation] Wait for the given host to ping.
root442f0ef2016-08-04 20:23:05 +0000121 [Arguments] ${host} ${timeout}=${OPENBMC_REBOOT_TIMEOUT}min
122 ... ${interval}=5 sec
123
Steven Sombar0acb3412018-01-24 09:38:42 -0600124 # Description of argument(s):
125 # host The host name or IP of the host to ping.
126 # timeout The amount of time after which ping attempts cease.
127 # This should be expressed in Robot Framework's time format
128 # (e.g. "10 seconds").
root442f0ef2016-08-04 20:23:05 +0000129 # interval The amount of time in between attempts to ping.
Steven Sombar0acb3412018-01-24 09:38:42 -0600130 # This should be expressed in Robot Framework's time format
131 # (e.g. "5 seconds").
root442f0ef2016-08-04 20:23:05 +0000132
133 Wait Until Keyword Succeeds ${timeout} ${interval} Ping Host ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -0500134
Steven Sombar0acb3412018-01-24 09:38:42 -0600135
Chris Austenb29d2e82016-06-07 12:25:35 -0500136Ping Host
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500137 [Documentation] Ping the given host.
Chris Austenb29d2e82016-06-07 12:25:35 -0500138 [Arguments] ${host}
Steven Sombar0acb3412018-01-24 09:38:42 -0600139
140 # Description of argument(s):
141 # host The host name or IP of the host to ping.
142
George Keishing8a84f952016-08-25 04:54:53 -0500143 Should Not Be Empty ${host} msg=No host provided
Michael Walsha6723f22016-11-22 11:12:01 -0600144 ${RC} ${output}= Run and return RC and Output ping -c 4 ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -0500145 Log RC: ${RC}\nOutput:\n${output}
146 Should be equal ${RC} ${0}
147
Steven Sombar0acb3412018-01-24 09:38:42 -0600148
Chris Austenb29d2e82016-06-07 12:25:35 -0500149Get Boot Progress
Michael Walshc972d4d2017-08-16 15:38:03 -0500150 [Documentation] Get the boot progress and return it.
Michael Walsha6723f22016-11-22 11:12:01 -0600151 [Arguments] ${quiet}=${QUIET}
152
Michael Walshc972d4d2017-08-16 15:38:03 -0500153 # Description of argument(s):
154 # quiet Indicates whether this keyword should run without any output to
155 # the console.
156
157 Set Boot Progress Method
158 ${state}= Run Keyword If '${boot_prog_method}' == 'New'
159 ... New Get Boot Progress quiet=${quiet}
160 ... ELSE
161 ... Old Get Boot Progress quiet=${quiet}
162
163 [Return] ${state}
164
Steven Sombar0acb3412018-01-24 09:38:42 -0600165
Michael Walshc972d4d2017-08-16 15:38:03 -0500166Set Boot Progress Method
167 [Documentation] Set the boot_prog_method to either 'Old' or 'New'.
168
169 # The boot progress data has moved from an 'org' location to an 'xyz'
170 # location. This keyword will determine whether the new method of getting
171 # the boot progress is valid and will set the global boot_prog_method
172 # variable accordingly. If boot_prog_method is already set (either by a
173 # prior call to this function or via a -v parm), this keyword will simply
174 # return.
175
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500176 # Note: There are interim builds that contain boot_progress in both the
177 # old and the new location values. It is nearly impossible for this
178 # keyword to determine whether the old boot_progress or the new one is
179 # active. When using such builds where the old boot_progress is active,
180 # the only recourse users will have is that they may specify
181 # -v boot_prog_method:Old to force old behavior on such builds.
Michael Walshc972d4d2017-08-16 15:38:03 -0500182
183 Run Keyword If '${boot_prog_method}' != '${EMPTY}' Return From Keyword
184
185 ${new_status} ${new_value}= Run Keyword And Ignore Error
186 ... New Get Boot Progress
187 # If the new style read fails, the method must necessarily be "Old".
188 Run Keyword If '${new_status}' == 'PASS'
189 ... Run Keywords
190 ... Set Global Variable ${boot_prog_method} New AND
191 ... Rqpvars boot_prog_method AND
192 ... Return From Keyword
193
194 # Default method is "Old".
195 Set Global Variable ${boot_prog_method} Old
196 Rqpvars boot_prog_method
197
Steven Sombar0acb3412018-01-24 09:38:42 -0600198
Michael Walshc972d4d2017-08-16 15:38:03 -0500199Old Get Boot Progress
200 [Documentation] Get the boot progress the old way (via org location).
201 [Arguments] ${quiet}=${QUIET}
202
203 # Description of argument(s):
204 # quiet Indicates whether this keyword should run without any output to
205 # the console.
206
George Keishing85ca05e2016-11-30 09:47:18 -0600207 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
Michael Walsha6723f22016-11-22 11:12:01 -0600208 ... value quiet=${quiet}
Michael Walshc972d4d2017-08-16 15:38:03 -0500209
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600210 [Return] ${state}
Chris Austenb29d2e82016-06-07 12:25:35 -0500211
Steven Sombar0acb3412018-01-24 09:38:42 -0600212
Michael Walshc972d4d2017-08-16 15:38:03 -0500213New Get Boot Progress
214 [Documentation] Get the boot progress the new way (via xyz location).
215 [Arguments] ${quiet}=${QUIET}
216
217 # Description of argument(s):
218 # quiet Indicates whether this keyword should run without any output to
219 # the console.
220
221 ${state}= Read Attribute ${HOST_STATE_URI} BootProgress quiet=${quiet}
222
223 [Return] ${state.rsplit('.', 1)[1]}
224
Steven Sombar0acb3412018-01-24 09:38:42 -0600225
Chris Austenb29d2e82016-06-07 12:25:35 -0500226Is Power On
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500227 [Documentation] Verify that the BMC chassis state is on.
root442f0ef2016-08-04 20:23:05 +0000228 ${state}= Get Power State
229 Should be equal ${state} ${1}
Chris Austenb29d2e82016-06-07 12:25:35 -0500230
Steven Sombar0acb3412018-01-24 09:38:42 -0600231
Chris Austenb29d2e82016-06-07 12:25:35 -0500232Is Power Off
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500233 [Documentation] Verify that the BMC chassis state is off.
root442f0ef2016-08-04 20:23:05 +0000234 ${state}= Get Power State
235 Should be equal ${state} ${0}
Chris Austenb29d2e82016-06-07 12:25:35 -0500236
Steven Sombar0acb3412018-01-24 09:38:42 -0600237
root442f0ef2016-08-04 20:23:05 +0000238Initiate Power On
239 [Documentation] Initiates the power on and waits until the Is Power On
240 ... keyword returns that the power state has switched to on.
Michael Walsha6723f22016-11-22 11:12:01 -0600241 [Arguments] ${wait}=${1}
242
Steven Sombar0acb3412018-01-24 09:38:42 -0600243 # Description of argument(s):
244 # wait Indicates whether to wait for a powered on state after issuing
245 # the power on command.
246
Chris Austenb29d2e82016-06-07 12:25:35 -0500247 @{arglist}= Create List
248 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600249 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
Michael Walsha6723f22016-11-22 11:12:01 -0600250 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500251 should be equal as strings ${resp.status_code} ${HTTP_OK}
Chris Austenb29d2e82016-06-07 12:25:35 -0500252
Michael Walsha6723f22016-11-22 11:12:01 -0600253 # Does caller want to wait for power on status?
254 Run Keyword If '${wait}' == '${0}' Return From Keyword
255 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500256
Steven Sombar0acb3412018-01-24 09:38:42 -0600257
root442f0ef2016-08-04 20:23:05 +0000258Initiate Power Off
259 [Documentation] Initiates the power off and waits until the Is Power Off
260 ... keyword returns that the power state has switched to off.
Steven Sombar0acb3412018-01-24 09:38:42 -0600261
Chris Austenb29d2e82016-06-07 12:25:35 -0500262 @{arglist}= Create List
263 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600264 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
Michael Walsha6723f22016-11-22 11:12:01 -0600265 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500266 should be equal as strings ${resp.status_code} ${HTTP_OK}
Michael Walsha6723f22016-11-22 11:12:01 -0600267 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
Chris Austenb29d2e82016-06-07 12:25:35 -0500268
Steven Sombar0acb3412018-01-24 09:38:42 -0600269
Michael Walsh81843772017-03-02 14:44:44 -0600270Initiate OS Host Power Off
271 [Documentation] Initiate an OS reboot.
272 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walshdfc75372018-01-11 11:47:25 -0600273 ... ${os_password}=${OS_PASSWORD} ${hard}=${0}
Michael Walsh81843772017-03-02 14:44:44 -0600274
Michael Walshdfc75372018-01-11 11:47:25 -0600275 # Description of argument(s):
Michael Walsh81843772017-03-02 14:44:44 -0600276 # os_host The DNS name or IP of the OS.
277 # os_username The username to be used to sign in to the OS.
278 # os_password The password to be used to sign in to the OS.
Michael Walshdfc75372018-01-11 11:47:25 -0600279 # hard Indicates whether to do a hard vs. soft power off.
280
281 ${time_string}= Run Keyword If ${hard} Set Variable ${SPACE}now
282 ... ELSE Set Variable ${EMPTY}
Michael Walsh81843772017-03-02 14:44:44 -0600283
Michael Walsh4549cd12017-09-07 18:02:36 -0500284 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
Michael Walshdfc75372018-01-11 11:47:25 -0600285 ... Set Variable shutdown${time_string}
Michael Walsh4549cd12017-09-07 18:02:36 -0500286 ... ELSE
Michael Walshdfc75372018-01-11 11:47:25 -0600287 ... Set Variable echo ${os_password} | sudo -S shutdown${time_string}
Michael Walsh4549cd12017-09-07 18:02:36 -0500288
289 ${output} ${stderr} ${rc}= OS Execute Command
290 ... ${cmd_buf} fork=${1}
Michael Walsh81843772017-03-02 14:44:44 -0600291
Steven Sombar0acb3412018-01-24 09:38:42 -0600292
Michael Walsh81843772017-03-02 14:44:44 -0600293Initiate OS Host Reboot
294 [Documentation] Initiate an OS reboot.
295 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
296 ... ${os_password}=${OS_PASSWORD}
297
Michael Walshf1a59fb2017-09-01 17:07:13 -0500298 # Description of argument(s):
299 # os_host The host name or IP address of the OS.
Michael Walsh81843772017-03-02 14:44:44 -0600300 # os_username The username to be used to sign in to the OS.
301 # os_password The password to be used to sign in to the OS.
302
Michael Walshf1a59fb2017-09-01 17:07:13 -0500303 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
304 ... Set Variable reboot
305 ... ELSE
306 ... Set Variable echo ${os_password} | sudo -S reboot
307
308 ${output} ${stderr} ${rc}= OS Execute Command
309 ... ${cmd_buf} fork=${1}
Michael Walsh81843772017-03-02 14:44:44 -0600310
Steven Sombar0acb3412018-01-24 09:38:42 -0600311
Michael Walsh81843772017-03-02 14:44:44 -0600312Initiate Auto Reboot
313 [Documentation] Initiate an auto reboot.
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500314 [Arguments] ${milliseconds}=5000
315
316 # Description of argument(s):
317 # milliseconds The number of milliseconds for the watchdog timer.
Michael Walsh81843772017-03-02 14:44:44 -0600318
319 # Set the auto reboot policy.
Sweta Potthuri62a23572017-07-28 04:05:13 -0500320 Set Auto Reboot ${1}
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500321 # Set the watchdog timer.
322 Trigger Host Watchdog Error ${milliseconds}
Michael Walsh81843772017-03-02 14:44:44 -0600323
Steven Sombar0acb3412018-01-24 09:38:42 -0600324
Chris Austenb29d2e82016-06-07 12:25:35 -0500325Trigger Warm Reset
Steven Sombar0acb3412018-01-24 09:38:42 -0600326 [Documentation] Initiate a warm reset.
327
Chris Austenb29d2e82016-06-07 12:25:35 -0500328 log to console "Triggering warm reset"
Michael Walsha6723f22016-11-22 11:12:01 -0600329 ${data}= create dictionary data=@{EMPTY}
George Keishing85ca05e2016-11-30 09:47:18 -0600330 ${resp}= openbmc post request
331 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
Chris Austenb29d2e82016-06-07 12:25:35 -0500332 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
George Keishingb3700812016-08-31 03:03:30 -0500333 ${session_active}= Check If warmReset is Initiated
334 Run Keyword If '${session_active}' == '${True}'
335 ... Fail msg=warm reset didn't occur
336
Chris Austenb29d2e82016-06-07 12:25:35 -0500337 Sleep ${SYSTEM_SHUTDOWN_TIME}min
Rahul Maheshwari5f253c42017-01-30 05:19:51 -0600338 Check If BMC Is Up
Michael Walsh49ab0f42016-07-20 11:44:33 -0500339
Steven Sombar0acb3412018-01-24 09:38:42 -0600340
Michael Walsh49ab0f42016-07-20 11:44:33 -0500341Check OS
root442f0ef2016-08-04 20:23:05 +0000342 [Documentation] Attempts to ping the host OS and then checks that the host
343 ... OS is up by running an SSH command.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500344
345 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walsha6723f22016-11-22 11:12:01 -0600346 ... ${os_password}=${OS_PASSWORD} ${quiet}=${QUIET}
347 ... ${print_string}=${EMPTY}
Michael Walshac275512017-03-07 11:39:28 -0600348 [Teardown] SSHLibrary.Close Connection
Michael Walsh49ab0f42016-07-20 11:44:33 -0500349
Steven Sombar0acb3412018-01-24 09:38:42 -0600350 # Description of argument(s):
Michael Walsh49ab0f42016-07-20 11:44:33 -0500351 # os_host The DNS name/IP of the OS host associated with our BMC.
352 # os_username The username to be used to sign on to the OS host.
353 # os_password The password to be used to sign on to the OS host.
Michael Walsha6723f22016-11-22 11:12:01 -0600354 # quiet Indicates whether this keyword should write to console.
355 # print_string A string to be printed before checking the OS.
356
357 rprint ${print_string}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500358
root442f0ef2016-08-04 20:23:05 +0000359 # Attempt to ping the OS. Store the return code to check later.
360 ${ping_rc}= Run Keyword and Return Status Ping Host ${os_host}
361
Michael Walshac275512017-03-07 11:39:28 -0600362 SSHLibrary.Open connection ${os_host}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500363
Michael Walsha6723f22016-11-22 11:12:01 -0600364 ${status} ${msg}= Run Keyword And Ignore Error Login ${os_username}
365 ... ${os_password}
366 ${err_msg1}= Sprint Error ${msg}
367 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
368 Run Keyword If '${status}' == 'FAIL' Fail msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500369 ${output} ${stderr} ${rc}= Execute Command uptime return_stderr=True
370 ... return_rc=True
371
Michael Walsha6723f22016-11-22 11:12:01 -0600372 ${temp_msg}= Catenate Could not execute a command on the operating
373 ... system.\n
374 ${err_msg1}= Sprint Error ${temp_msg}
375 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
376
377 # If the return code returned by "Execute Command" is non-zero, this
378 # keyword will fail.
379 Should Be Equal ${rc} ${0} msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500380 # We will likewise fail if there is any stderr data.
381 Should Be Empty ${stderr}
382
Michael Walsha6723f22016-11-22 11:12:01 -0600383 ${temp_msg}= Set Variable Could not ping the operating system.\n
384 ${err_msg1}= Sprint Error ${temp_msg}
385 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
386 # We will likewise fail if the OS did not ping, as we could SSH but not
387 # ping
388 Should Be Equal As Strings ${ping_rc} ${TRUE} msg=${err_msg}
root442f0ef2016-08-04 20:23:05 +0000389
Steven Sombar0acb3412018-01-24 09:38:42 -0600390
Michael Walsh49ab0f42016-07-20 11:44:33 -0500391Wait for OS
392 [Documentation] Waits for the host OS to come up via calls to "Check OS".
393 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
394 ... ${os_password}=${OS_PASSWORD} ${timeout}=${OS_WAIT_TIMEOUT}
Michael Walsha6723f22016-11-22 11:12:01 -0600395 ... ${quiet}=${0}
396 [Teardown] rprintn
Michael Walsh49ab0f42016-07-20 11:44:33 -0500397
Steven Sombar0acb3412018-01-24 09:38:42 -0600398 # Description of argument(s):
Michael Walsh49ab0f42016-07-20 11:44:33 -0500399 # os_host The DNS name or IP of the OS host associated with our
400 # BMC.
401 # os_username The username to be used to sign on to the OS host.
402 # os_password The password to be used to sign on to the OS host.
403 # timeout The timeout in seconds indicating how long you're
404 # willing to wait for the OS to respond.
Michael Walsha6723f22016-11-22 11:12:01 -0600405 # quiet Indicates whether this keyword should write to console.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500406
407 # The interval to be used between calls to "Check OS".
408 ${interval}= Set Variable 5
409
Michael Walsha6723f22016-11-22 11:12:01 -0600410 ${message}= Catenate Checking every ${interval} seconds for up to
411 ... ${timeout} seconds for the operating system to communicate.
412 rqprint_timen ${message}
413
Michael Walsh49ab0f42016-07-20 11:44:33 -0500414 Wait Until Keyword Succeeds ${timeout} sec ${interval} Check OS
415 ... ${os_host} ${os_username} ${os_password}
Michael Walsha6723f22016-11-22 11:12:01 -0600416 ... print_string=\#
417
418 rqprintn
419
420 rqprint_timen The operating system is now communicating.
root442f0ef2016-08-04 20:23:05 +0000421
root442f0ef2016-08-04 20:23:05 +0000422
423Get Power State
424 [Documentation] Returns the power state as an integer. Either 0 or 1.
Michael Walsha6723f22016-11-22 11:12:01 -0600425 [Arguments] ${quiet}=${QUIET}
426
Steven Sombar0acb3412018-01-24 09:38:42 -0600427 # Description of argument(s):
428 # quiet Indicates whether this keyword should run without any output to
429 # the console.
430
root442f0ef2016-08-04 20:23:05 +0000431 @{arglist}= Create List
432 ${args}= Create Dictionary data=@{arglist}
Michael Walsha6723f22016-11-22 11:12:01 -0600433
George Keishing85ca05e2016-11-30 09:47:18 -0600434 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
Michael Walsha6723f22016-11-22 11:12:01 -0600435 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000436 Should be equal as strings ${resp.status_code} ${HTTP_OK}
437 ${content}= to json ${resp.content}
Steven Sombar0acb3412018-01-24 09:38:42 -0600438
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600439 [Return] ${content["data"]}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500440
George Keishinga8d68e22017-12-18 09:30:30 -0600441
442Clear BMC Gard Record
443 [Documentation] Clear gard records from the system.
444
445 @{arglist}= Create List
446 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600447 ${resp}= Call Method
George Keishinga8d68e22017-12-18 09:30:30 -0600448 ... ${OPENPOWER_CONTROL}gard Reset data=${args}
449 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
450
Jay Azurine4c52eb2016-08-16 20:51:10 -0500451
452Copy PNOR to BMC
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500453 [Documentation] Copy the PNOR image to the BMC.
Jay Azurine4c52eb2016-08-16 20:51:10 -0500454 Import Library SCPLibrary WITH NAME scp
455 Open Connection for SCP
456 Log Copying ${PNOR_IMAGE_PATH} to /tmp
457 scp.Put File ${PNOR_IMAGE_PATH} /tmp
458
Steven Sombar0acb3412018-01-24 09:38:42 -0600459
Jay Azurine4c52eb2016-08-16 20:51:10 -0500460Flash PNOR
461 [Documentation] Calls flash bios update method to flash PNOR image
Gunnar Mills38032802016-12-12 13:43:40 -0600462 [Arguments] ${pnor_image}
Steven Sombar0acb3412018-01-24 09:38:42 -0600463
464 # Description of argument(s):
465 # pnor_image The filename and path of the PNOR image
466 # (e.g. "/home/image/zaius.pnor").
467
Jay Azurine4c52eb2016-08-16 20:51:10 -0500468 @{arglist}= Create List ${pnor_image}
469 ${args}= Create Dictionary data=@{arglist}
George Keishinge24fdbc2017-10-31 13:41:35 -0500470 ${resp}= Call Method /org/openbmc/control/flash/bios/ update
Michael Walsha6723f22016-11-22 11:12:01 -0600471 ... data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500472 should be equal as strings ${resp.status_code} ${HTTP_OK}
473 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
474
Steven Sombar0acb3412018-01-24 09:38:42 -0600475
Jay Azurine4c52eb2016-08-16 20:51:10 -0500476Get Flash BIOS Status
477 [Documentation] Returns the status of the flash BIOS API as a string. For
478 ... example 'Flashing', 'Flash Done', etc
George Keishinge24fdbc2017-10-31 13:41:35 -0500479 ${data}= Read Properties /org/openbmc/control/flash/bios
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600480 [Return] ${data['status']}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500481
Steven Sombar0acb3412018-01-24 09:38:42 -0600482
Jay Azurine4c52eb2016-08-16 20:51:10 -0500483Is PNOR Flashing
484 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
485 ... flashing has started.
486 ${status}= Get Flash BIOS Status
Rahul Maheshwari449dfb72017-05-08 02:06:48 -0500487 Should Contain ${status} Flashing
Jay Azurine4c52eb2016-08-16 20:51:10 -0500488
Steven Sombar0acb3412018-01-24 09:38:42 -0600489
Jay Azurine4c52eb2016-08-16 20:51:10 -0500490Is PNOR Flash Done
491 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
492 ... PNOR flashing has completed.
Leah McNutt9ba32272016-11-17 15:48:39 +0000493 ${status}= Get Flash BIOS Status
Jay Azurine4c52eb2016-08-16 20:51:10 -0500494 should be equal as strings ${status} Flash Done
495
George Keishing5e870cd2016-08-24 10:05:47 -0500496
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600497Is OS Starting
498 [Documentation] Check if boot progress is OS starting.
499 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500500 Should Be Equal ${boot_progress} OSStart
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600501
Steven Sombar0acb3412018-01-24 09:38:42 -0600502
George Keishing0af24412017-03-10 13:33:23 -0600503Is OS Off
504 [Documentation] Check if boot progress is "Off".
505 ${boot_progress}= Get Boot Progress
506 Should Be Equal ${boot_progress} Off
507
Steven Sombar0acb3412018-01-24 09:38:42 -0600508
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500509Get Boot Progress To OS Starting State
510 [Documentation] Get the system to a boot progress state of 'FW Progress,
511 ... Starting OS'.
512
513 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500514 Run Keyword If '${boot_progress}' == 'OSStart'
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500515 ... Log Host is already in OS starting state
516 ... ELSE
517 ... Run Keywords Initiate Host PowerOff AND Initiate Host Boot
518 ... AND Wait Until Keyword Succeeds 10 min 10 sec Is OS Starting
519
Steven Sombar0acb3412018-01-24 09:38:42 -0600520
George Keishing5e870cd2016-08-24 10:05:47 -0500521Verify Ping and REST Authentication
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500522 [Documentation] Verify ping and rest authentication.
Michael Walsha6723f22016-11-22 11:12:01 -0600523 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500524 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -0500525 Run Keyword If '${l_ping}' == '${False}'
526 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500527
Michael Walsha6723f22016-11-22 11:12:01 -0600528 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500529 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -0500530 Run Keyword If '${l_rest}' == '${False}'
531 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500532
533 # Just to make sure the SSH is working for SCP
534 Open Connection And Log In
535 ${system} ${stderr}= Execute Command hostname return_stderr=True
536 Should Be Empty ${stderr}
537
Steven Sombar0acb3412018-01-24 09:38:42 -0600538
George Keishingc4d3dc02016-09-19 03:45:55 -0500539Check If BMC is Up
540 [Documentation] Wait for Host to be online. Checks every X seconds
541 ... interval for Y minutes and fails if timed out.
542 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -0600543 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -0500544 ... ${interval}=10 sec
545
Steven Sombar0acb3412018-01-24 09:38:42 -0600546 # Description of argument(s):
547 # max_timeout Maximum time to wait.
548 # This should be expressed in Robot Framework's time format
549 # (e.g. "10 minutes").
550 # interfal Interval to wait between status checks.
551 # This should be expressed in Robot Framework's time format
552 # (e.g. "5 seconds").
553
George Keishingc4d3dc02016-09-19 03:45:55 -0500554 Wait Until Keyword Succeeds
555 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
556
George Keishingb3700812016-08-31 03:03:30 -0500557
558Check If warmReset is Initiated
559 [Documentation] Ping would be still alive, so try SSH to connect
560 ... if fails the ports are down indicating reboot
561 ... is in progress
George Keishing3c05d352016-12-13 06:54:50 -0600562
563 # Warm reset adds 3 seconds delay before forcing reboot
564 # To minimize race conditions, we wait for 7 seconds
565 Sleep 7s
George Keishingb3700812016-08-31 03:03:30 -0500566 ${alive}= Run Keyword and Return Status
567 ... Open Connection And Log In
568 Return From Keyword If '${alive}' == '${False}' ${False}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600569 [Return] ${True}
George Keishingb3700812016-08-31 03:03:30 -0500570
Steven Sombar0acb3412018-01-24 09:38:42 -0600571
George Keishing06ae4aa2016-08-30 01:41:28 -0500572Flush REST Sessions
573 [Documentation] Removes all the active session objects
574 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500575
Steven Sombar0acb3412018-01-24 09:38:42 -0600576
Sivas SRRe1143ae2016-08-26 22:31:02 -0500577Initialize DBUS cmd
578 [Documentation] Initialize dbus string with property string to extract
Gunnar Mills38032802016-12-12 13:43:40 -0600579 [Arguments] ${boot_property}
Steven Sombar0acb3412018-01-24 09:38:42 -0600580
581 # Description of argument(s):
582 # boot_property Property string.
583
Michael Walsha6723f22016-11-22 11:12:01 -0600584 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
585 ${cmd}= Catenate ${cmd}${boot_property}
Sivas SRRe1143ae2016-08-26 22:31:02 -0500586 Set Global Variable ${dbuscmd} ${cmd}
587
Steven Sombar0acb3412018-01-24 09:38:42 -0600588
David Shawba2d2c22017-01-23 16:56:38 -0600589Create OS Console File Path
590 [Documentation] Create OS console file path name and return it.
591 [Arguments] ${log_file_path}=${EMPTY}
George Keishing30c12ff2016-09-02 10:25:29 -0500592
Gunnar Mills28e403b2017-10-25 16:16:38 -0500593 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600594 # file_path The caller's candidate value. If this value is ${EMPTY}, this
595 # keyword will compose a file path name. Otherwise, this
596 # keyword will use the caller's file_path value. In either
597 # case, the value will be returned.
Gunnar Mills9c760342016-12-08 10:12:06 -0600598
Charles Paul Hofer92a4f452018-06-14 14:48:32 -0500599 ${status}= Run Keyword And Return Status Variable Should Exist ${TEST_NAME}
600
601 ${default_file_path}= Set Variable If ${status} == ${TRUE}
602 ... /tmp/${OPENBMC_HOST}_${TEST_NAME.replace(' ', '')}_os_console.txt
603 ... /tmp/${OPENBMC_HOST}_os_console.txt
604
David Shawba2d2c22017-01-23 16:56:38 -0600605 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
606 ... ${default_file_path} ${log_file_path}
Michael Walsh01bd3682017-01-10 11:21:05 -0600607
David Shawba2d2c22017-01-23 16:56:38 -0600608 [Return] ${log_file_path}
Gunnar Mills9c760342016-12-08 10:12:06 -0600609
Steven Sombar0acb3412018-01-24 09:38:42 -0600610
David Shawba2d2c22017-01-23 16:56:38 -0600611Create OS Console Command String
612 [Documentation] Return a command string to start OS console logging.
Gunnar Mills9c760342016-12-08 10:12:06 -0600613
David Shawba2d2c22017-01-23 16:56:38 -0600614 # First make sure that the ssh_pw program is available.
Steven Sombar0acb3412018-01-24 09:38:42 -0600615 ${cmd}= Catenate which ssh_pw 2>/dev/null || find
616 ... ${EXECDIR} -name 'ssh_pw'
617
618 Rdpissuing ${cmd}
619 ${rc} ${output}= Run And Return Rc And Output ${cmd}
David Shawba2d2c22017-01-23 16:56:38 -0600620 Rdpvars rc output
Gunnar Mills9c760342016-12-08 10:12:06 -0600621
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500622 Should Be Equal As Integers 0 ${rc} msg=Could not find ssh_pw.
623
624 ${ssh_pw_file_path}= Set Variable ${output}
George Keishingb45d9522017-06-29 04:20:59 -0500625
Steven Sombar0acb3412018-01-24 09:38:42 -0600626 ${cmd}= Catenate ${ssh_pw_file_path} ${OPENBMC_PASSWORD} -p 2200
George Keishing1f9ec7f2017-06-06 08:59:19 -0500627 ... -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST}
George Keishing30c12ff2016-09-02 10:25:29 -0500628
Steven Sombar0acb3412018-01-24 09:38:42 -0600629 [Return] ${cmd}
630
George Keishing30c12ff2016-09-02 10:25:29 -0500631
Michael Walshcadf1342017-08-28 13:49:25 -0500632Get SOL Console Pid
Michael Walsh70419172017-12-06 14:20:52 -0600633 [Documentation] Get the pid of the active SOL console job.
634 [Arguments] ${expect_running}=${0}
635
636 # Description of argument(s):
637 # expect_running If set and if no SOL console job is found, print debug
638 # info and fail.
Michael Walshcadf1342017-08-28 13:49:25 -0500639
640 # Find the pid of the active system console logging session (if any).
641 ${search_string}= Create OS Console Command String
642 # At least in some cases, ps output does not show double quotes so we must
643 # replace them in our search string with the regexes to indicate that they
644 # are optional.
645 ${search_string}= Replace String ${search_string} " ["]?
Michael Walsh70419172017-12-06 14:20:52 -0600646 ${ps_cmd}= Catenate ps axwwo user,pid,cmd
647 ${cmd_buf}= Catenate echo $(${ps_cmd} | egrep '${search_string}' |
648 ... egrep -v grep | cut -c10-14)
Michael Walshcadf1342017-08-28 13:49:25 -0500649 Rdpissuing ${cmd_buf}
650 ${rc} ${os_con_pid}= Run And Return Rc And Output ${cmd_buf}
651 Rdpvars os_con_pid
652 # If rc is not zero it just means that there is no OS Console process
653 # running.
654
Michael Walsh70419172017-12-06 14:20:52 -0600655 Return From Keyword If '${os_con_pid}' != '${EMPTY}' ${os_con_pid}
656 Return From Keyword If '${expect_running}' == '${0}' ${os_con_pid}
657
658 Cmd Fnc cat ${log_file_path} ; echo ; ${ps_cmd} quiet=${0}
659 ... print_output=${1} show_err=${1}
660
661 Should Not Be Empty ${os_con_pid}
Michael Walshcadf1342017-08-28 13:49:25 -0500662
663
George Keishing30c12ff2016-09-02 10:25:29 -0500664Stop SOL Console Logging
David Shawba2d2c22017-01-23 16:56:38 -0600665 [Documentation] Stop system console logging and return log output.
George Keishing72992e42017-06-16 06:42:36 -0500666 [Arguments] ${log_file_path}=${EMPTY}
667 ... ${targ_file_path}=${EXECDIR}${/}logs${/}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500668 ... ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600669
670 # If there are muliple system console processes, they will all be stopped.
671 # If there is no existing log file this keyword will return an error
672 # message to that effect (and write that message to targ_file_path, if
673 # specified).
674 # NOTE: This keyword will not fail if there is no running system console
675 # process.
Michael Walsh01bd3682017-01-10 11:21:05 -0600676
677 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600678 # log_file_path The file path that was used to call "Start SOL
679 # Console Logging". See that keyword (above) for details.
680 # targ_file_path If specified, the file path to which the source
681 # file path (i.e. "log_file_path") should be copied.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500682 # return_data If this is set to ${1}, this keyword will return the SOL
683 # data to the caller as a unicode string.
George Keishing30c12ff2016-09-02 10:25:29 -0500684
David Shawba2d2c22017-01-23 16:56:38 -0600685 ${log_file_path}= Create OS Console File Path ${log_file_path}
Michael Walshcadf1342017-08-28 13:49:25 -0500686
687 ${os_con_pid}= Get SOL Console Pid
George Keishing30c12ff2016-09-02 10:25:29 -0500688
David Shawba2d2c22017-01-23 16:56:38 -0600689 ${cmd_buf}= Catenate kill -9 ${os_con_pid}
690 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpissuing ${cmd_buf}
691 ${rc} ${output}= Run Keyword If '${os_con_pid}' != '${EMPTY}'
692 ... Run And Return Rc And Output ${cmd_buf}
693 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpvars rc output
George Keishing30c12ff2016-09-02 10:25:29 -0500694
Michael Walsh01bd3682017-01-10 11:21:05 -0600695 Run Keyword If '${targ_file_path}' != '${EMPTY}'
David Shawba2d2c22017-01-23 16:56:38 -0600696 ... Run Keyword And Ignore Error
697 ... Copy File ${log_file_path} ${targ_file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500698
Michael Walsh5f3f4142017-05-22 17:09:47 -0500699 ${output}= Set Variable ${EMPTY}
700 ${loc_quiet}= Evaluate ${debug}^1
701 ${rc} ${output}= Run Keyword If '${return_data}' == '${1}'
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500702 ... Cmd Fnc cat ${log_file_path} 2>/dev/null quiet=${loc_quiet}
703 ... print_output=${0} show_err=${0}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500704
David Shawba2d2c22017-01-23 16:56:38 -0600705 [Return] ${output}
706
Steven Sombar0acb3412018-01-24 09:38:42 -0600707
David Shawba2d2c22017-01-23 16:56:38 -0600708Start SOL Console Logging
709 [Documentation] Start system console log to file.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500710 [Arguments] ${log_file_path}=${EMPTY} ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600711
712 # This keyword will first call "Stop SOL Console Logging". Only then will
713 # it start SOL console logging. The data returned by "Stop SOL Console
714 # Logging" will in turn be returned by this keyword.
715
716 # Description of arguments:
Michael Walsh5f3f4142017-05-22 17:09:47 -0500717 # log_file_path The file path to which system console log data should be
718 # written. Note that this path is taken to be a location
719 # on the machine where this program is running rather than
720 # on the Open BMC system.
721 # return_data If this is set to ${1}, this keyword will return any SOL
722 # data to the caller as a unicode string.
David Shawba2d2c22017-01-23 16:56:38 -0600723
724 ${log_file_path}= Create OS Console File Path ${log_file_path}
725
726 ${log_output}= Stop SOL Console Logging ${log_file_path}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500727 ... return_data=${return_data}
David Shawba2d2c22017-01-23 16:56:38 -0600728
729 # Validate by making sure we can create the file. Problems creating the
730 # file would not be noticed by the subsequent ssh command because we fork
731 # the command.
732 Create File ${log_file_path}
733 ${sub_cmd_buf}= Create OS Console Command String
734 # Routing stderr to stdout so that any startup error text will go to the
735 # output file.
George Keishing8c3c1df2017-09-13 13:50:20 -0500736 # TODO: Doesn't work with tox so reverting temporarily.
Michael Walsh460042e2017-09-05 16:55:49 -0500737 # nohup detaches the process completely from our pty.
George Keishing8c3c1df2017-09-13 13:50:20 -0500738 #${cmd_buf}= Catenate nohup ${sub_cmd_buf} &> ${log_file_path} &
739 ${cmd_buf}= Catenate ${sub_cmd_buf} > ${log_file_path} 2>&1 &
David Shawba2d2c22017-01-23 16:56:38 -0600740 Rdpissuing ${cmd_buf}
741 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
742 # Because we are forking this command, we essentially will never get a
743 # non-zero return code or any output.
744 Should Be Equal ${rc} ${0}
745
Michael Walsh70419172017-12-06 14:20:52 -0600746 Wait Until Keyword Succeeds 10 seconds 0 seconds
747 ... Get SOL Console Pid ${1}
Michael Walshcadf1342017-08-28 13:49:25 -0500748
David Shawba2d2c22017-01-23 16:56:38 -0600749 [Return] ${log_output}
George Keishing30c12ff2016-09-02 10:25:29 -0500750
Michael Walsh70419172017-12-06 14:20:52 -0600751
George Keishing30c12ff2016-09-02 10:25:29 -0500752Get Time Stamp
753 [Documentation] Get the current time stamp data
754 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500755 [Return] ${cur_time}
George Keishing30c12ff2016-09-02 10:25:29 -0500756
George Keishing1b150202016-09-29 08:51:58 -0500757
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500758Start Journal Log
759 [Documentation] Start capturing journal log to a file in /tmp using
760 ... journalctl command. By default journal log is collected
761 ... at /tmp/journal_log else user input location.
762 ... The File is appended with datetime.
George Keishing76a5daf2018-09-14 06:00:01 -0500763 [Arguments] ${file_path}=/tmp/journal_log ${filter}=${EMPTY}
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500764
Steven Sombar0acb3412018-01-24 09:38:42 -0600765 # Description of arguments:
766 # file_path The file path of the journal file.
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500767
768 ${cur_time}= Get Time Stamp
769 Set Global Variable ${LOG_TIME} ${cur_time}
George Keishing76a5daf2018-09-14 06:00:01 -0500770 Open Connection And Log In
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500771 Start Command
George Keishing76a5daf2018-09-14 06:00:01 -0500772 ... journalctl -f ${filter} > ${file_path}-${LOG_TIME}
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500773 Log Journal Log Started: ${file_path}-${LOG_TIME}
774
David Shawba2d2c22017-01-23 16:56:38 -0600775
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500776Stop Journal Log
777 [Documentation] Stop journalctl process if its running.
778 ... By default return log from /tmp/journal_log else
779 ... user input location.
780 [Arguments] ${file_path}=/tmp/journal_log
781
Steven Sombar0acb3412018-01-24 09:38:42 -0600782 # Description of arguments:
783 # file_path The file path of the journal file.
784
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500785 Open Connection And Log In
786
787 ${rc}=
788 ... Execute Command
George Keishing76a5daf2018-09-14 06:00:01 -0500789 ... ps | grep journalctl | grep -v grep
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500790 ... return_stdout=False return_rc=True
791
792 Return From Keyword If '${rc}' == '${1}'
793 ... No journal log process running
794
795 ${output} ${stderr}=
796 ... Execute Command killall journalctl
797 ... return_stderr=True
798 Should Be Empty ${stderr}
799
800 ${journal_log} ${stderr}=
801 ... Execute Command
802 ... cat ${file_path}-${LOG_TIME}
803 ... return_stderr=True
804 Should Be Empty ${stderr}
805
806 Log ${journal_log}
807
808 Execute Command rm ${file_path}-${LOG_TIME}
809
810 [Return] ${journal_log}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500811
Steven Sombar0acb3412018-01-24 09:38:42 -0600812
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500813Mac Address To Hex String
814 [Documentation] Converts MAC address into hex format.
815 ... Example
816 ... Given the following MAC: 00:01:6C:80:02:78
817 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
818 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600819 ... i_macaddress MAC address in the following format
820 ... 00:01:6C:80:02:78
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500821 [Arguments] ${i_macaddress}
822
Steven Sombar0acb3412018-01-24 09:38:42 -0600823 # Description of arguments:
824 # i_macaddress The MAC address.
825
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500826 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600827 [Return] ${mac_hex}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500828
Steven Sombar0acb3412018-01-24 09:38:42 -0600829
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500830IP Address To Hex String
831 [Documentation] Converts IP address into hex format.
832 ... Example:
833 ... Given the following IP: 10.3.164.100
834 ... This keyword will return: 0xa 0x3 0xa4 0xa0
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500835 [Arguments] ${i_ipaddress}
836
Steven Sombar0acb3412018-01-24 09:38:42 -0600837 # Description of arguments:
838 # i_macaddress The IP address in the format 10.10.10.10.
839
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500840 @{ip}= Split String ${i_ipaddress} .
841 ${index}= Set Variable ${0}
842
843 :FOR ${item} IN @{ip}
844 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes
845 \ Set List Value ${ip} ${index} ${hex}
846 \ ${index}= Set Variable ${index + 1}
847 ${ip_hex}= Catenate @{ip}
Steven Sombar0acb3412018-01-24 09:38:42 -0600848
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600849 [Return] ${ip_hex}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600850
Steven Sombar0acb3412018-01-24 09:38:42 -0600851
Sivas SRRea85d1f2016-11-13 22:44:28 -0600852BMC CPU Performance Check
853 [Documentation] Minimal 10% of proc should be free in this instance
854
Sivas SRRa13eb202017-11-03 10:01:56 -0500855 ${bmc_cpu_usage_output} ${stderr} ${rc}= BMC Execute Command
856 ... ${bmc_cpu_usage_cmd}
Sivas SRR5ff4d692017-11-23 02:53:52 -0600857 ${bmc_cpu_usage_output} ${stderr} ${rc}= BMC Execute Command
858 ... ${bmc_cpu_usage_cmd}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600859 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} %
860 Should be true ${bmc_cpu_percentage} < 90
861
Steven Sombar0acb3412018-01-24 09:38:42 -0600862
Sivas SRRea85d1f2016-11-13 22:44:28 -0600863BMC Mem Performance Check
864 [Documentation] Minimal 10% of memory should be free in this instance
865
Sivas SRRa13eb202017-11-03 10:01:56 -0500866 ${bmc_mem_free_output} ${stderr} ${rc}= BMC Execute Command
867 ... ${bmc_mem_free_cmd}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600868
Sivas SRRa13eb202017-11-03 10:01:56 -0500869 ${bmc_mem_total_output} ${stderr} ${rc}= BMC Execute Command
870 ... ${bmc_mem_total_cmd}
Sivas SRR5ff4d692017-11-23 02:53:52 -0600871 ${bmc_mem_free_output} ${stderr} ${rc}= BMC Execute Command
872 ... ${bmc_mem_free_cmd}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600873
Sivas SRR5ff4d692017-11-23 02:53:52 -0600874 ${bmc_mem_total_output} ${stderr} ${rc}= BMC Execute Command
875 ... ${bmc_mem_total_cmd}
876
877 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100
Sivas SRRea85d1f2016-11-13 22:44:28 -0600878 ${bmc_mem_percentage}= Evaluate
879 ... ${bmc_mem_percentage}/${bmc_mem_total_output}
880 Should be true ${bmc_mem_percentage} > 10
881
Steven Sombar0acb3412018-01-24 09:38:42 -0600882
Sivas SRRaca55712016-12-21 04:32:35 -0600883BMC File System Usage Check
Sivas SRRc0957412017-10-06 13:02:08 -0500884 [Documentation] Check the file system space. 4 file system should be
885 ... 100% full which is expected
Steven Sombar0acb3412018-01-24 09:38:42 -0600886 # Filesystem Size Used Available Use% Mounted on
887 # /dev/root 14.4M 14.4M 0 100% /
888 # /dev/ubiblock0_0 14.4M 14.4M 0 100% /media/rofs-c9249b0e
889 # /dev/ubiblock8_0 19.6M 19.6M 0 100% /media/pnor-ro-8764baa3
890 # /dev/ubiblock4_0 14.4M 14.4M 0 100% /media/rofs-407816c
891 # /dev/ubiblock8_4 21.1M 21.1M 0 100% /media/pnor-ro-cecc64c4
Sivas SRR5ff4d692017-11-23 02:53:52 -0600892 ${bmc_fs_usage_output} ${stderr} ${rc}= BMC Execute Command
893 ... ${bmc_file_system_usage_cmd}
894 ${bmc_pnor_fs_usage_output} ${stderr} ${rc}= BMC Execute Command
895 ... ${total_pnor_ro_file_system_cmd}
896 ${bmc_bmc_fs_usage_output} ${stderr} ${rc}= BMC Execute Command
897 ... ${total_bmc_ro_file_system_cmd}
898 ${total_bmc_pnor_image}= Evaluate
899 ... ${bmc_pnor_fs_usage_output}+${bmc_bmc_fs_usage_output}
900 # Considering /dev/root also in total 100% used file system
901 ${total_full_fs}= Evaluate ${total_bmc_pnor_image}+1
902 Should Be True ${bmc_fs_usage_output}==${total_full_fs}
Sivas SRRaca55712016-12-21 04:32:35 -0600903
Steven Sombar0acb3412018-01-24 09:38:42 -0600904
Sivas SRRea85d1f2016-11-13 22:44:28 -0600905Check BMC CPU Performance
906 [Documentation] Minimal 10% of proc should be free in 3 sample
907 :FOR ${var} IN Range 1 4
908 \ BMC CPU Performance check
909
Steven Sombar0acb3412018-01-24 09:38:42 -0600910
Sivas SRRea85d1f2016-11-13 22:44:28 -0600911Check BMC Mem Performance
912 [Documentation] Minimal 10% of memory should be free
913
914 :FOR ${var} IN Range 1 4
915 \ BMC Mem Performance check
916
Steven Sombar0acb3412018-01-24 09:38:42 -0600917
Sivas SRRaca55712016-12-21 04:32:35 -0600918Check BMC File System Performance
919 [Documentation] Check for file system usage for 4 times
920
921 :FOR ${var} IN Range 1 4
922 \ BMC File System Usage check
923
Steven Sombar0acb3412018-01-24 09:38:42 -0600924
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500925Get URL List
926 [Documentation] Return list of URLs under given URL.
927 [Arguments] ${openbmc_url}
Steven Sombar0acb3412018-01-24 09:38:42 -0600928
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500929 # Description of argument(s):
Michael Walsh5f3f4142017-05-22 17:09:47 -0500930 # openbmc_url URL for list operation (e.g.
931 # /xyz/openbmc_project/inventory).
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500932
George Keishing335f5362017-06-30 15:11:20 -0500933 ${url_list}= Read Properties ${openbmc_url}/list quiet=${1}
George Keishing184a89a2017-06-27 07:12:16 -0500934 Sort List ${url_list}
Steven Sombar0acb3412018-01-24 09:38:42 -0600935
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500936 [Return] ${url_list}
937
Steven Sombar0acb3412018-01-24 09:38:42 -0600938
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600939Get Endpoint Paths
940 [Documentation] Returns all url paths ending with given endpoint
941 ... Example:
942 ... Given the following endpoint: cpu
Michael Walsh01bd3682017-01-10 11:21:05 -0600943 ... This keyword will return: list of all urls ending with
944 ... cpu -
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600945 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
946 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600947 [Arguments] ${path} ${endpoint}
948
Steven Sombar0acb3412018-01-24 09:38:42 -0600949 # Description of arguments:
950 # path URL path for enumeration.
951 # endpoint Endpoint string (url path ending).
952
George Keishingc7b161b2017-12-01 09:58:12 -0600953 ${resp}= Read Properties ${path}/enumerate timeout=30
954 Log Dictionary ${resp}
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600955
George Keishingc7b161b2017-12-01 09:58:12 -0600956 ${list}= Get Dictionary Keys ${resp}
957 # For a given string, look for prefix and suffix for matching expression.
958 # Start of string followed by zero or more of any character followed by
959 # any digit or lower case character.
960 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9a-z]*$
Steven Sombar0acb3412018-01-24 09:38:42 -0600961
George Keishingc7b161b2017-12-01 09:58:12 -0600962 [Return] ${resp}
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500963
Steven Sombar0acb3412018-01-24 09:38:42 -0600964
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500965Check Zombie Process
966 [Documentation] Check if any defunct process exist or not on BMC
Michael Walsh01bd3682017-01-10 11:21:05 -0600967 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500968 ... return_stderr=True return_rc=True
969 Should Be True ${count}==0
970 Should Be Empty ${stderr}
George Keishing5327d012016-12-08 08:43:29 -0600971
Steven Sombar0acb3412018-01-24 09:38:42 -0600972
George Keishing5327d012016-12-08 08:43:29 -0600973Prune Journal Log
974 [Documentation] Prune archived journal logs.
975 [Arguments] ${vacuum_size}=1M
976
977 # This keyword can be used to prevent the journal
978 # log from filling up the /run filesystem.
979 # This command will retain only the latest logs
980 # of the user specified size.
981
Steven Sombar0acb3412018-01-24 09:38:42 -0600982 # Description of argument(s):
983 # vacuum_size Size of journal.
984
George Keishing5327d012016-12-08 08:43:29 -0600985 Open Connection And Log In
986 ${output} ${stderr} ${rc}=
987 ... Execute Command
988 ... journalctl --vacuum-size=${vacuum_size}
989 ... return_stderr=True return_rc=True
990
991 Should Be Equal ${rc} ${0} msg=${stderr}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600992
Steven Sombar0acb3412018-01-24 09:38:42 -0600993
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600994Set BMC Power Policy
995 [Documentation] Set the given BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -0500996 [Arguments] ${policy}
997
998 # Note that this function will translate the old style "RESTORE_LAST_STATE"
999 # policy to the new style "xyz.openbmc_project.Control.Power.RestorePolicy.
1000 # Policy.Restore" for you.
Sridevi Ramesh1699d372016-12-06 00:20:22 -06001001
George Keishing1c3a9662017-08-11 10:16:36 -05001002 # Description of argument(s):
Michael Walshfdc5ced2017-08-17 13:15:15 -05001003 # policy Power restore policy (e.g "RESTORE_LAST_STATE",
1004 # ${RESTORE_LAST_STATE}).
1005
1006 # Set the bmc_power_policy_method to either 'Old' or 'New'.
1007 Set Power Policy Method
1008 # This translation helps bridge between old and new method for calling.
1009 ${policy}= Translate Power Policy Value ${policy}
1010 # Run the appropriate keyword.
1011 Run Key ${bmc_power_policy_method} Set Power Policy \ ${policy}
1012 ${currentPolicy}= Get System Power Policy
1013 Should Be Equal ${currentPolicy} ${policy}
1014
Steven Sombar0acb3412018-01-24 09:38:42 -06001015
Michael Walshfdc5ced2017-08-17 13:15:15 -05001016New Set Power Policy
1017 [Documentation] Set the given BMC power policy (new method).
1018 [Arguments] ${policy}
1019
1020 # Description of argument(s):
George Keishingefc3ff22017-12-12 11:49:25 -06001021 # policy Power restore policy (e.g. ${ALWAYS_POWER_OFF}).
George Keishing1c3a9662017-08-11 10:16:36 -05001022
1023 ${valueDict}= Create Dictionary data=${policy}
1024 Write Attribute
Michael Walshfdc5ced2017-08-17 13:15:15 -05001025 ... ${POWER_RESTORE_URI} PowerRestorePolicy data=${valueDict}
1026
Steven Sombar0acb3412018-01-24 09:38:42 -06001027
Michael Walshfdc5ced2017-08-17 13:15:15 -05001028Old Set Power Policy
1029 [Documentation] Set the given BMC power policy (old method).
1030 [Arguments] ${policy}
1031
1032 # Description of argument(s):
George Keishingefc3ff22017-12-12 11:49:25 -06001033 # policy Power restore policy (e.g. "ALWAYS_POWER_OFF").
Michael Walshfdc5ced2017-08-17 13:15:15 -05001034
1035 ${valueDict}= create dictionary data=${policy}
1036 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
George Keishingcce9df22017-01-24 06:19:33 -06001037
Steven Sombar0acb3412018-01-24 09:38:42 -06001038
George Keishing4d6f3d62017-02-06 09:50:41 -06001039Get System Power Policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001040 [Documentation] Returns the BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -05001041
1042 # Set the bmc_power_policy_method to either 'Old' or 'New'.
1043 Set Power Policy Method
1044 ${cmd_buf}= Create List ${bmc_power_policy_method} Get Power Policy
1045 # Run the appropriate keyword.
1046 ${currentPolicy}= Run Keyword @{cmd_buf}
Steven Sombar0acb3412018-01-24 09:38:42 -06001047
Michael Walshfdc5ced2017-08-17 13:15:15 -05001048 [Return] ${currentPolicy}
1049
Steven Sombar0acb3412018-01-24 09:38:42 -06001050
Michael Walshfdc5ced2017-08-17 13:15:15 -05001051New Get Power Policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001052 [Documentation] Returns the BMC power policy (new method).
George Keishing1c3a9662017-08-11 10:16:36 -05001053 ${currentPolicy}= Read Attribute ${POWER_RESTORE_URI} PowerRestorePolicy
Steven Sombar0acb3412018-01-24 09:38:42 -06001054
George Keishing4d6f3d62017-02-06 09:50:41 -06001055 [Return] ${currentPolicy}
George Keishingcce9df22017-01-24 06:19:33 -06001056
Steven Sombar0acb3412018-01-24 09:38:42 -06001057
Michael Walshfdc5ced2017-08-17 13:15:15 -05001058Old Get Power Policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001059 [Documentation] Returns the BMC power policy (old method).
Michael Walshfdc5ced2017-08-17 13:15:15 -05001060 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001061
Michael Walshfdc5ced2017-08-17 13:15:15 -05001062 [Return] ${currentPolicy}
1063
Steven Sombar0acb3412018-01-24 09:38:42 -06001064
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001065Get Auto Reboot
1066 [Documentation] Returns auto reboot setting.
Sweta Potthuri62a23572017-07-28 04:05:13 -05001067 ${setting}= Read Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot
Steven Sombar0acb3412018-01-24 09:38:42 -06001068
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001069 [Return] ${setting}
1070
Steven Sombar0acb3412018-01-24 09:38:42 -06001071
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001072Set Auto Reboot
1073 [Documentation] Set the given auto reboot setting.
1074 [Arguments] ${setting}
Steven Sombar0acb3412018-01-24 09:38:42 -06001075
1076 # Description of argument(s):
1077 # setting The reboot setting, 1 for enabling and 0 for disabling.
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001078
1079 ${valueDict}= Set Variable ${setting}
1080 ${data}= Create Dictionary data=${valueDict}
Sweta Potthuri62a23572017-07-28 04:05:13 -05001081 Write Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot data=${data}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001082 ${current_setting}= Get Auto Reboot
Sweta Potthuri62a23572017-07-28 04:05:13 -05001083 Should Be Equal As Integers ${current_setting} ${setting}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001084
1085
George Keishingcce9df22017-01-24 06:19:33 -06001086Set BMC Reset Reference Time
1087 [Documentation] Set current boot time as a reference and increment
George Keishing80dd5af2017-02-08 07:01:25 -06001088 ... boot count.
George Keishingcce9df22017-01-24 06:19:33 -06001089
1090 ${cur_btime}= Get BMC Boot Time
George Keishing80dd5af2017-02-08 07:01:25 -06001091 Run Keyword If ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
George Keishingcce9df22017-01-24 06:19:33 -06001092 ... Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishing80dd5af2017-02-08 07:01:25 -06001093 ... ELSE IF ${cur_btime} > ${BOOT_TIME}
1094 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishingcce9df22017-01-24 06:19:33 -06001095 ... AND
1096 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
1097
Steven Sombar0acb3412018-01-24 09:38:42 -06001098
George Keishingcce9df22017-01-24 06:19:33 -06001099Get BMC Boot Time
Steven Sombar0acb3412018-01-24 09:38:42 -06001100 [Documentation] Returns boot time from /proc/stat.
George Keishingcce9df22017-01-24 06:19:33 -06001101
1102 Open Connection And Log In
1103 ${output} ${stderr}=
1104 ... Execute Command egrep '^btime ' /proc/stat | cut -f 2 -d ' '
1105 ... return_stderr=True
1106 Should Be Empty ${stderr}
1107 ${btime}= Convert To Integer ${output}
1108 [Return] ${btime}
George Keishingede30002017-02-02 09:33:07 -06001109
Steven Sombar0acb3412018-01-24 09:38:42 -06001110
George Keishing7a520222017-02-27 09:44:30 -06001111Enable Core Dump On BMC
1112 [Documentation] Enable core dump collection.
Joy Onyerikwu9b668972018-05-22 19:10:43 -05001113 ${core_pattern} ${stderr} ${rc}= BMC Execute Command
George Keishing7a520222017-02-27 09:44:30 -06001114 ... echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
1115 Should Be Equal As Strings ${core_pattern} /tmp/core_%e.%p
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001116
Steven Sombar0acb3412018-01-24 09:38:42 -06001117
Sivas SRR01262bd2017-03-19 10:00:23 -05001118Get Number Of BMC Core Dump Files
Steven Sombar0acb3412018-01-24 09:38:42 -06001119 [Documentation] Returns number of core dump files on BMC.
Sivas SRR01262bd2017-03-19 10:00:23 -05001120 Open Connection And Log In
1121 ${num_of_core_dump}= Execute Command
1122 ... ls /tmp/core* 2>/dev/null | wc -l
1123 [Return] ${num_of_core_dump}
1124
Steven Sombar0acb3412018-01-24 09:38:42 -06001125
Sivas SRR01262bd2017-03-19 10:00:23 -05001126Set Core Dump File Size Unlimited
1127 [Documentation] Set core dump file size to unlimited.
Joy Onyerikwu9b668972018-05-22 19:10:43 -05001128 BMC Execute Command ulimit -c unlimited
Sivas SRR01262bd2017-03-19 10:00:23 -05001129
Steven Sombar0acb3412018-01-24 09:38:42 -06001130
Sivas SRR01262bd2017-03-19 10:00:23 -05001131Check For Core Dumps
1132 [Documentation] Check for any core dumps exist.
1133 ${output}= Get Number Of BMC Core Dump Files
1134 Run Keyword If ${output} > 0
1135 ... Log **Warning** BMC core dump files exist level=WARN
1136
Steven Sombar0acb3412018-01-24 09:38:42 -06001137
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001138Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -05001139 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001140 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Steven Sombar0acb3412018-01-24 09:38:42 -06001141
Michael Walshb5839d02017-04-12 16:11:20 -05001142 # Description of argument(s):
1143 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
1144 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001145 # sleep_time Time delay for host watchdog error to get injected.
1146 # Default is 5 seconds.
1147
Michael Walsh4ffd1a12018-03-14 10:35:44 -05001148 ${data}= Create Dictionary
1149 ... data=xyz.openbmc_project.State.Watchdog.Action.PowerCycle
1150 ${status} ${result}= Run Keyword And Ignore Error
1151 ... Read Attribute ${HOST_WATCHDOG_URI} ExpireAction
1152 Run Keyword If '${status}' == 'PASS'
1153 ... Write Attribute ${HOST_WATCHDOG_URI} ExpireAction data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -05001154
1155 ${data}= Create Dictionary data=${milliseconds}
Michael Walsh4ffd1a12018-03-14 10:35:44 -05001156 Write Attribute ${HOST_WATCHDOG_URI} Interval data=${data}
1157
1158 ${data}= Create Dictionary data=${True}
1159 Write Attribute ${HOST_WATCHDOG_URI} Enabled data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -05001160
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001161 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001162
Steven Sombar0acb3412018-01-24 09:38:42 -06001163
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001164Login To OS Host
Steven Sombar0acb3412018-01-24 09:38:42 -06001165 [Documentation] Login to OS Host and return the Login response code.
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001166 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
1167 ... ${os_password}=${OS_PASSWORD}
Steven Sombar0acb3412018-01-24 09:38:42 -06001168
Gunnar Mills28e403b2017-10-25 16:16:38 -05001169 # Description of arguments:
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001170 # ${os_host} IP address of the OS Host.
1171 # ${os_username} OS Host Login user name.
1172 # ${os_password} OS Host Login passwrd.
1173
Rahul Maheshwarid1f45f22018-10-26 05:16:39 -05001174 REST Power On stack_mode=skip quiet=1
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001175
George Keishing3f223b82017-06-28 03:50:35 -05001176 SSHLibrary.Open Connection ${os_host}
Sridevi Rameshea36b412017-03-09 04:08:02 -06001177 ${resp}= Login ${os_username} ${os_password}
1178 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -05001179
Steven Sombar0acb3412018-01-24 09:38:42 -06001180
Prashanth Katti884ee062017-03-16 05:05:03 -05001181Configure Initial Settings
1182 [Documentation] Restore old IP and route.
1183 ... This keyword requires initial settings viz IP address,
1184 ... Network Mask, default gatway and serial console IP and port
1185 ... information which should be provided in command line.
1186
Michael Walshb5839d02017-04-12 16:11:20 -05001187 [Arguments] ${host}=${OPENBMC_HOST} ${mask}=${NET_MASK}
1188 ... ${gw_ip}=${GW_IP}
Prashanth Katti884ee062017-03-16 05:05:03 -05001189
Steven Sombar0acb3412018-01-24 09:38:42 -06001190 # Description of arguments:
1191 # host IP address of the OS Host.
1192 # mask Network mask.
1193 # gu_ip Gateway IP address or hostname.
1194
Michael Walshb5839d02017-04-12 16:11:20 -05001195 # Open telnet connection and ignore the error, in case telnet session is
1196 # already opened by the program calling this keyword.
Prashanth Katti884ee062017-03-16 05:05:03 -05001197 Run Keyword And Ignore Error Open Telnet Connection to BMC Serial Console
1198 Telnet.write ifconfig eth0 ${host} netmask ${mask}
1199 Telnet.write route add default gw ${gw_ip}
George Keishingd05b1082017-03-24 05:27:32 -05001200
Steven Sombar0acb3412018-01-24 09:38:42 -06001201
George Keishingd05b1082017-03-24 05:27:32 -05001202Install Debug Tarball On BMC
George Keishing55441822017-05-18 14:17:59 -05001203 [Documentation] Copy the debug tar file to BMC and install.
Steven Sombar0acb3412018-01-24 09:38:42 -06001204 [Arguments] ${tarball_file_path}=${default_tarball}
1205 ... ${targ_tarball_dir_path}=/tmp/tarball/
George Keishingd05b1082017-03-24 05:27:32 -05001206
George Keishing55441822017-05-18 14:17:59 -05001207 # Description of arguments:
1208 # tarball_file_path Path of the debug tarball file.
1209 # The tar file is downloaded from the build page
1210 # https://openpower.xyz/job/openbmc-build/
1211 # obmc-phosphor-debug-tarball-witherspoon.tar.xz
1212 #
1213 # targ_tarball_dir_path The directory path where the tarball is to be
1214 # installed.
1215
1216 OperatingSystem.File Should Exist ${tarball_file_path}
1217 ... msg=${tarball_file_path} doesn't exist.
1218
1219 # Upload the file to BMC.
George Keishingd05b1082017-03-24 05:27:32 -05001220 Import Library SCPLibrary WITH NAME scp
1221 Open Connection for SCP
George Keishing55441822017-05-18 14:17:59 -05001222 scp.Put File ${tarball_file_path} /tmp/debug-tarball.tar.xz
1223
1224 # Create tarball directory and install.
George Keishing95c371a2017-09-14 15:42:33 -05001225 BMC Execute Command mkdir -p ${targ_tarball_dir_path}
1226 BMC Execute Command
George Keishing55441822017-05-18 14:17:59 -05001227 ... tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path}
1228
George Keishing95c371a2017-09-14 15:42:33 -05001229 # Remove the tarball file from BMC.
1230 BMC Execute Command rm -f /tmp/debug-tarball.tar.xz
George Keishingd05b1082017-03-24 05:27:32 -05001231
George Keishing55441822017-05-18 14:17:59 -05001232
Sweta Potthuri025e0122017-02-21 00:42:48 -06001233Get BMC Boot Count
Steven Sombar0acb3412018-01-24 09:38:42 -06001234 [Documentation] Returns BMC boot count based on boot time.
Sweta Potthuri025e0122017-02-21 00:42:48 -06001235 ${cur_btime}= Get BMC Boot Time
1236
1237 # Set global variable BOOT_TIME to current boot time if current boot time
1238 # is changed. Also increase value of global variable BOOT_COUNT by 1.
1239 Run Keyword If ${cur_btime} > ${BOOT_TIME}
1240 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
1241 ... AND
1242 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
Steven Sombar0acb3412018-01-24 09:38:42 -06001243
Sweta Potthuri025e0122017-02-21 00:42:48 -06001244 [Return] ${BOOT_COUNT}
1245
Steven Sombar0acb3412018-01-24 09:38:42 -06001246
Sweta Potthuri025e0122017-02-21 00:42:48 -06001247Set BMC Boot Count
1248 [Documentation] Set BMC boot count to given value.
1249 [Arguments] ${count}
1250
1251 # Description of arguments:
1252 # count boot count value.
1253 ${cur_btime}= Get BMC Boot Time
1254
1255 # Set global variable BOOT_COUNT to given value.
1256 Set Global Variable ${BOOT_COUNT} ${count}
1257
1258 # Set BOOT_TIME variable to current boot time.
1259 Set Global Variable ${BOOT_COUNT} ${count}
Michael Walsh689fbbe2017-04-04 17:58:03 -05001260
Steven Sombar0acb3412018-01-24 09:38:42 -06001261
Sweta Potthurie5a9fc72017-05-03 07:02:46 -05001262Get System LED State
1263 [Documentation] Return the state of given system LED.
1264 [Arguments] ${led_name}
1265
1266 # Description of argument(s):
1267 # led_name System LED name (e.g. heartbeat, identify, beep).
1268
1269 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State
1270 [Return] ${state.rsplit('.', 1)[1]}
1271
George Keishing3987a1e2017-09-20 09:13:02 -05001272
Steven Sombar5f3af442018-02-14 08:30:15 -06001273Set System LED State
1274 [Documentation] Set given system LED via REST.
1275 [Arguments] ${led_name} ${led_state}
1276 # Description of argument(s):
1277 # led_name System LED name (e.g. heartbeat, identify, beep).
1278 # led_state LED state to be set (e.g. On, Off).
1279
1280 ${args}= Create Dictionary
1281 ... data=xyz.openbmc_project.Led.Physical.Action.${led_state}
1282 Write Attribute ${LED_PHYSICAL_URI}${led_name} State data=${args}
1283
1284 Verify LED State ${led_name} ${led_state}
1285
1286
1287Verify LED State
1288 [Documentation] Checks if LED is in given state.
1289 [Arguments] ${led_name} ${led_state}
1290 # Description of argument(s):
1291 # led_name System LED name (e.g. heartbeat, identify, beep).
1292 # led_state LED state to be verified (e.g. On, Off).
1293
1294 ${state}= Get System LED State ${led_name}
1295 Should Be Equal ${state} ${led_state}
1296
1297
Steven Sombarb89d5802018-02-15 14:48:49 -06001298Get LED State XYZ
1299 [Documentation] Returns state of given LED.
1300 [Arguments] ${led_name}
1301
1302 # Description of argument(s):
1303 # led_name Name of LED.
1304
1305 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
1306 # Returns the state of the LED, either On or Off.
1307 [Return] ${state}
1308
1309
George Keishingd2d90af2017-06-27 08:17:34 -05001310Delete Error Logs
Michael Walsh689fbbe2017-04-04 17:58:03 -05001311 [Documentation] Delete error logs.
1312
George Keishingd2d90af2017-06-27 08:17:34 -05001313 # Check if error logs entries exist, if not return.
George Keishing335f5362017-06-30 15:11:20 -05001314 ${resp}= OpenBMC Get Request ${BMC_LOGGING_ENTRY}${/}list quiet=${1}
George Keishingd2d90af2017-06-27 08:17:34 -05001315 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND}
1316
1317 # Get the list of error logs entries and delete them all.
George Keishing335f5362017-06-30 15:11:20 -05001318 ${elog_entries}= Get URL List ${BMC_LOGGING_ENTRY}
George Keishingd2d90af2017-06-27 08:17:34 -05001319 :FOR ${entry} IN @{elog_entries}
1320 \ Delete Error Log Entry ${entry}
George Keishingdb34c2f2017-04-18 13:20:25 -05001321
George Keishing3987a1e2017-09-20 09:13:02 -05001322
George Keishingd2d90af2017-06-27 08:17:34 -05001323Delete Error Log Entry
George Keishingdb34c2f2017-04-18 13:20:25 -05001324 [Documentation] Delete error log entry.
1325 [Arguments] ${entry_path}
1326
1327 # Description of argument(s):
1328 # entry_path Delete an error log entry.
1329 # Ex. /xyz/openbmc_project/logging/entry/1
1330
George Keishing6a8ed0f2017-07-11 22:54:42 -05001331 # Skip delete if entry URI is a callout.
Michael Walsh18526b42018-11-09 14:51:53 -06001332 # Examples:
1333 # /xyz/openbmc_project/logging/entry/1/callout
1334 # /xyz/openbmc_project/logging/entry/1/callouts/0
1335 ${callout_entry}= Run Keyword And Return Status
1336 ... Should Match Regexp ${entry_path} /callout[s]?(/|$)
1337 Return From Keyword If ${callout_entry}
George Keishing6a8ed0f2017-07-11 22:54:42 -05001338
George Keishingdb34c2f2017-04-18 13:20:25 -05001339 ${data}= Create Dictionary data=@{EMPTY}
1340 ${resp}= Openbmc Delete Request ${entry_path} data=${data}
1341 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Rahul Maheshwari43be6932017-05-01 02:37:06 -05001342
1343
George Keishingcc71c3c2017-09-20 09:38:03 -05001344Delete All Error Logs
George Keishing3987a1e2017-09-20 09:13:02 -05001345 [Documentation] Delete all error log entries using "DeleteAll" interface.
1346
1347 ${data}= Create Dictionary data=@{EMPTY}
1348 ${resp}= Openbmc Post Request ${BMC_LOGGING_URI}action/DeleteAll
1349 ... data=${data}
1350 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
1351
1352
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001353Get BMC Version
1354 [Documentation] Returns BMC version from /etc/os-release.
1355 ... e.g. "v1.99.6-141-ge662190"
1356
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001357 ${cmd}= Set Variable grep ^VERSION_ID= /etc/os-release | cut -f 2 -d '='
Joy Onyerikwu9b668972018-05-22 19:10:43 -05001358 ${output} ${stderr} ${rc}= BMC Execute Command ${cmd}
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001359 [Return] ${output}
1360
George Keishingad5817a2017-06-28 10:19:03 -05001361
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -05001362Get PNOR Version
Steven Sombar0acb3412018-01-24 09:38:42 -06001363 [Documentation] Returns the PNOR version from the BMC.
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -05001364
1365 ${pnor_attrs}= Get PNOR Attributes
1366 [Return] ${pnor_attrs['version']}
1367
1368
1369Get PNOR Attributes
1370 [Documentation] Return PNOR software attributes as a dictionary.
1371
Michael Walsh98d8c9e2017-10-04 12:24:29 -05001372 # This keyword parses /var/lib/phosphor-software-manager/pnor/ro/pnor.toc
1373 # into key/value pairs.
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -05001374
1375 ${outbuf} ${stderr} ${rc}= BMC Execute Command
1376 ... cat /var/lib/phosphor-software-manager/pnor/ro/pnor.toc
1377 ${pnor_attrs}= Key Value Outbuf To Dict ${outbuf} delim==
1378
1379 [Return] ${pnor_attrs}
1380
1381
George Keishingad5817a2017-06-28 10:19:03 -05001382Get Elog URL List
1383 [Documentation] Return error log entry list of URLs.
1384
1385 ${url_list}= Read Properties /xyz/openbmc_project/logging/entry/
1386 Sort List ${url_list}
1387 [Return] ${url_list}
1388
1389
Steven Sombaraaf72c42017-09-05 12:02:00 -05001390Read Turbo Setting Via REST
1391 [Documentation] Return turbo setting via REST.
Steven Sombarea79a492018-04-18 11:14:57 -05001392 # Returns 1 if TurboAllowed, 0 if not.
Steven Sombaraaf72c42017-09-05 12:02:00 -05001393
Steven Sombarea79a492018-04-18 11:14:57 -05001394 ${turbo_setting}= Read Attribute
1395 ... ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
1396 [Return] ${turbo_setting}
1397
Steven Sombaraaf72c42017-09-05 12:02:00 -05001398
Steven Sombaraaf72c42017-09-05 12:02:00 -05001399Set Turbo Setting Via REST
1400 [Documentation] Set turbo setting via REST.
Steven Sombar80bc8592018-04-24 11:44:53 -05001401 [Arguments] ${setting} ${verify}=${False}
Steven Sombar0acb3412018-01-24 09:38:42 -06001402
Steven Sombaraaf72c42017-09-05 12:02:00 -05001403 # Description of argument(s):
Steven Sombar80bc8592018-04-24 11:44:53 -05001404 # setting State to set TurboAllowed, 1=allowed, 0=not allowed.
1405 # verify If True, read the TurboAllowed setting to confirm.
Steven Sombaraaf72c42017-09-05 12:02:00 -05001406
Steven Sombarea79a492018-04-18 11:14:57 -05001407 ${data}= Create Dictionary data=${${setting}}
Steven Sombar80bc8592018-04-24 11:44:53 -05001408 Write Attribute ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
1409 ... verify=${verify} data=${data}
George Keishingef74a8c2017-10-20 10:23:52 -05001410
Steven Sombar0acb3412018-01-24 09:38:42 -06001411
George Keishingef74a8c2017-10-20 10:23:52 -05001412Set Control Boot Mode
1413 [Documentation] Set given boot mode on the boot object path attribute.
1414 [Arguments] ${boot_path} ${boot_mode}
1415
1416 # Description of argument(s):
1417 # boot_path Boot object path.
1418 # Example:
1419 # /xyz/openbmc_project/control/host0/boot
1420 # /xyz/openbmc_project/control/host0/boot/one_time
1421 # boot_mode Boot mode which need to be set.
1422 # Example:
1423 # "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"
1424
1425 ${valueDict}= Create Dictionary data=${boot_mode}
1426 Write Attribute ${boot_path} BootMode data=${valueDict}
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -05001427
Steven Sombar0acb3412018-01-24 09:38:42 -06001428
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -05001429Copy Address Translation Utils To HOST OS
1430 [Documentation] Copy address translation utils to host OS.
1431
1432 OperatingSystem.File Should Exist ${probe_cpu_tool_path}
1433 ... msg=${probe_cpu_tool_path} doesn't exist.
1434 OperatingSystem.File Should Exist ${probe_cpu_tool_path}
1435 ... msg=${probe_cpu_tool_path} doesn't exist.
1436
1437 scp.Open connection ${OS_HOST} username=${OS_USERNAME}
1438 ... password=${OS_PASSWORD}
1439 scp.Put File ${probe_cpu_tool_path} ${target_file_path}
1440 scp.Put File ${scom_addrs_tool_path} ${target_file_path}
George Keishing034902d2017-11-10 13:15:38 -06001441
1442
1443Verify BMC RTC And UTC Time Drift
1444 [Documentation] Verify that the RTC and UTC time difference is less than
1445 ... the given time_drift_max.
1446 [Arguments] ${time_diff_max}=${10}
1447
1448 # Description of argument(s):
1449 # time_diff_max The max allowable RTC and UTC time difference in seconds.
1450
1451 # Example:
1452 # time_dict:
1453 # [local_time]: Fri 2017-11-03 152756 UTC
1454 # [local_time_seconds]: 1509740876
1455 # [universal_time]: Fri 2017-11-03 152756 UTC
1456 # [universal_time_seconds]: 1509740876
1457 # [rtc_time]: Fri 2016-05-20 163403
1458 # [rtc_time_seconds]: 1463780043
1459 # [time_zone]: n/a (UTC, +0000)
1460 # [network_time_on]: yes
1461 # [ntp_synchronized]: no
1462 # [rtc_in_local_tz]: no
1463
Steven Sombar0acb3412018-01-24 09:38:42 -06001464 ${time}= Get BMC Date Time
George Keishing034902d2017-11-10 13:15:38 -06001465 ${time_diff}= Evaluate
Steven Sombar0acb3412018-01-24 09:38:42 -06001466 ... ${time['universal_time_seconds']} - ${time['rtc_time_seconds']}
George Keishing034902d2017-11-10 13:15:38 -06001467 Should Be True ${time_diff} < ${time_diff_max}
Sweta Potthuri7d3af3c2018-01-29 03:07:07 -06001468
Sweta Potthurif39022d2018-02-06 03:40:07 -06001469
Sweta Potthuri7d3af3c2018-01-29 03:07:07 -06001470Watchdog Object Should Exist
1471 [Documentation] Check that watchdog object exists.
1472
1473 ${resp}= OpenBMC Get Request ${WATCHDOG_URI}host0
1474 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
1475 ... msg=Expected watchdog object does not exist.
Sweta Potthurif39022d2018-02-06 03:40:07 -06001476
1477
1478Validate IP On BMC
1479 [Documentation] Validate IP address is present in set of IP addresses.
1480 [Arguments] ${ip_address} ${ip_data}
1481
1482 # Description of argument(s):
1483 # ip_address IP address to check (e.g. xx.xx.xx.xx).
1484 # ip_data Set of the IP addresses present.
1485
1486 Should Contain Match ${ip_data} ${ip_address}/*
1487 ... msg=${ip_address} not found in the list provided.
George Keishingb9f407b2018-02-20 00:07:46 -06001488
1489
1490Remove Journald Logs
1491 [Documentation] Remove all journald logs and restart service.
1492
1493 ${cmd}= Catenate systemctl stop systemd-journald.service &&
1494 ... rm -rf /var/log/journal && systemctl start systemd-journald.service
1495
1496 BMC Execute Command ${cmd}
1497
George Keishing78ce8dc2018-03-30 11:49:06 -05001498
1499Verify Identify LED State
1500 [Documentation] Verify the identify LED state
1501 ... matches caller's expectations.
1502 [Arguments] ${expected_state}
1503
1504 # Description of argument(s):
1505 # expected_state The LED state expected by the caller ("Blink" or "Off").
1506
1507 ${resp}= Read Attribute ${LED_PHYSICAL_URI}/front_id State
1508 Should Be Equal ${resp}
1509 ... xyz.openbmc_project.Led.Physical.Action.${expected_state}
1510 ... msg=Unexpected LED state.
1511
1512 ${resp}= Read Attribute ${LED_PHYSICAL_URI}/rear_id State
1513 Should Be Equal ${resp}
1514 ... xyz.openbmc_project.Led.Physical.Action.${expected_state}
1515 ... msg=Unexpected LED state.
1516
Sweta Potthuri39255032018-03-28 10:12:14 -05001517
1518Verify The Attribute
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -05001519 [Documentation] Verify the given attribute.
Sweta Potthuri39255032018-03-28 10:12:14 -05001520 [Arguments] ${uri} ${attribute_name} ${attribute_value}
1521
1522 # Description of argument(s):
1523 # uri URI path
1524 # (e.g. "/xyz/openbmc_project/control/host0/TPMEnable").
1525 # attribute_name Name of attribute to be verified (e.g. "TPMEnable").
1526 # attribute_value The expected value of attribute (e.g. "1", "0", etc.)
1527
1528 ${output}= Read Attribute ${uri} ${attribute_name}
1529 Should Be Equal ${attribute_value} ${output}
1530 ... msg=Attribute "${attribute_name} does not have the expected value.
George Keishingcf0d7772018-05-04 08:22:50 -05001531
1532
1533Get BMC Flash Chip Boot Side
1534 [Documentation] Return the BMC flash chip boot side.
1535
1536 # Example:
George Keishinge3d3abc2018-06-25 09:08:19 -05001537 # 0 - indicates chip select is current side.
1538 # 32 - indicates chip select is alternate side.
George Keishingcf0d7772018-05-04 08:22:50 -05001539
1540 ${boot_side} ${stderr} ${rc}= BMC Execute Command
George Keishinge3d3abc2018-06-25 09:08:19 -05001541 ... cat /sys/class/watchdog/watchdog1/bootstatus
George Keishingcf0d7772018-05-04 08:22:50 -05001542
1543 [Return] ${boot_side}
1544
George Keishingc5fef582018-07-18 08:41:28 -05001545
1546Check For Regex In Journald
1547 [Documentation] Parse the journal log and check for regex string.
George Keishingb4adfc72018-10-26 09:39:32 -05001548 [Arguments] ${regex}=${ERROR_REGEX} ${error_check}=${0} ${boot}=${EMPTY}
1549
1550 # Description of argument(s):
1551 # regex Strings to be filter.
1552 # error_check Check for errors.
1553 # boot Argument to check current or persistent full boot log
1554 # (e.g. "-b").
George Keishingc5fef582018-07-18 08:41:28 -05001555
1556 ${journal_log} ${stderr} ${rc}= BMC Execute Command
George Keishingb4adfc72018-10-26 09:39:32 -05001557 ... journalctl --no-pager ${boot} | egrep '${regex}' ignore_err=1
George Keishingc5fef582018-07-18 08:41:28 -05001558
1559 Run Keyword If ${error_check} == ${0}
1560 ... Should Be Empty ${journal_log}
1561 ... ELSE
1562 ... Should Not Be Empty ${journal_log}
George Keishing216e5842018-08-31 14:58:15 -05001563
1564
1565Get Service Attribute
1566 [Documentation] Get service attribute policy output.
1567 [Arguments] ${option} ${servicename}
George Keishing3c004dc2018-10-10 07:16:47 -05001568
1569 # Description of argument(s):
George Keishingb53a37e2018-10-26 11:59:34 -05001570 # option systemctl supported options
George Keishing216e5842018-08-31 14:58:15 -05001571 # servicename Qualified service name
1572 ${cmd}= Set Variable
1573 ... systemctl -p ${option} show ${servicename} | cut -d = -f2
1574 ${attr} ${stderr} ${rc}= BMC Execute Command ${cmd}
1575 [Return] ${attr}
George Keishing3c004dc2018-10-10 07:16:47 -05001576
1577
1578Set REST Logging Policy
1579 [Documentation] Enable or disable REST logging setting.
1580 [Arguments] ${policy_setting}=${True}
1581
1582 # Description of argument(s):
1583 # policy_setting The policy setting value which can be either True or False.
1584
1585 ${log_dict}= Create Dictionary data=${policy_setting}
1586 Write Attribute ${BMC_LOGGING_URI}${/}rest_api_logs Enabled
1587 ... data=${log_dict} verify=${1} expected_value=${policy_setting}
1588
George Keishingc25c55d2018-10-30 02:23:44 -05001589
1590Update Root Password
1591 [Documentation] Update system "root" user password.
1592 [Arguments] ${openbmc_password}=${OPENBMC_PASSWORD}
1593
1594 # Description of argument(s):
1595 # openbmc_password The root password for the open BMC system.
1596
George Keishingfb218a12018-11-28 11:20:42 -06001597 @{password}= Create List ${openbmc_password}
1598 ${data}= Create Dictionary data=@{password}
George Keishingc25c55d2018-10-30 02:23:44 -05001599
George Keishingfb218a12018-11-28 11:20:42 -06001600 ${headers}= Create Dictionary Content-Type=application/json
1601 ${resp}= Post Request openbmc ${BMC_USER_URI}root/action/SetPassword
George Keishingc25c55d2018-10-30 02:23:44 -05001602 ... data=${data} headers=${headers}
1603 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
1604 ... msg=Updating the new root password failed, RC=${resp.status_code}.