blob: c4cd4d5daa477142f671742afd3200137db642ab [file] [log] [blame]
Chris Austenb29d2e82016-06-07 12:25:35 -05001*** Settings ***
Steven Sombar0acb3412018-01-24 09:38:42 -06002
3Documentation Utilities for Robot keywords.
4
Chris Austenb29d2e82016-06-07 12:25:35 -05005Resource ../lib/resource.txt
6Resource ../lib/rest_client.robot
George Keishing5e870cd2016-08-24 10:05:47 -05007Resource ../lib/connection_client.robot
Michael Walsh391ba9b2017-08-24 11:36:24 -05008Library String
George Keishing30c12ff2016-09-02 10:25:29 -05009Library DateTime
10Library Process
Chris Austenb29d2e82016-06-07 12:25:35 -050011Library OperatingSystem
Michael Walsha6723f22016-11-22 11:12:01 -060012Library gen_print.py
13Library gen_robot_print.py
Michael Walsh5f3f4142017-05-22 17:09:47 -050014Library gen_cmd.py
Sunil Macd110a2017-05-23 04:14:32 -050015Library gen_robot_keyword.py
Michael Walshe53e47a2017-06-30 17:03:24 -050016Library bmc_ssh_utils.py
Michael Walshfdc5ced2017-08-17 13:15:15 -050017Library utils.py
Charles Paul Hofer35816152017-10-02 11:55:11 -050018Library var_funcs.py
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050019Library SCPLibrary WITH NAME scp
Chris Austenb29d2e82016-06-07 12:25:35 -050020
21*** Variables ***
Steven Sombar0acb3412018-01-24 09:38:42 -060022
23${pflash_cmd} /usr/sbin/pflash -r /dev/stdout -P VERSION
24${SYSTEM_SHUTDOWN_TIME} ${5}
25
Michael Walsha6723f22016-11-22 11:12:01 -060026${dbuscmdBase}
George Keishing85ca05e2016-11-30 09:47:18 -060027... dbus-send --system --print-reply --dest=${OPENBMC_BASE_DBUS}.settings.Host
Michael Walsha6723f22016-11-22 11:12:01 -060028${dbuscmdGet}
George Keishing9485af92017-01-04 10:21:43 -060029... ${SETTINGS_URI}host0 org.freedesktop.DBus.Properties.Get
Steven Sombar0acb3412018-01-24 09:38:42 -060030${dbuscmdString}= string:"xyz.openbmc_project.settings.Host" string:
Michael Walsha6723f22016-11-22 11:12:01 -060031
32# Assign default value to QUIET for programs which may not define it.
33${QUIET} ${0}
Steven Sombar0acb3412018-01-24 09:38:42 -060034
Sivas SRRea85d1f2016-11-13 22:44:28 -060035${bmc_mem_free_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f4
36${bmc_mem_total_cmd}= free | tr -s ' ' | sed '/^Mem/!d' | cut -d" " -f2
37${bmc_cpu_usage_cmd}= top -n 1 | grep CPU: | cut -c 7-9
Sridevi Ramesh1699d372016-12-06 00:20:22 -060038${HOST_SETTING} ${SETTINGS_URI}host0
Steven Sombar0acb3412018-01-24 09:38:42 -060039
Sivas SRR352bc162017-02-13 22:12:29 -060040# /run/initramfs/ro associate filesystem should be 100% full always
Sivas SRR5ff4d692017-11-23 02:53:52 -060041${bmc_file_system_usage_cmd}= df -h | cut -c 52-54 | grep 100 | wc -l
42${total_pnor_ro_file_system_cmd}= df -h | grep /media/pnor-ro | wc -l
43${total_bmc_ro_file_system_cmd}= df -h | grep /media/rofs | wc -l
Chris Austenb29d2e82016-06-07 12:25:35 -050044
George Keishingcce9df22017-01-24 06:19:33 -060045${BOOT_TIME} ${0}
46${BOOT_COUNT} ${0}
Sweta Potthuri025e0122017-02-21 00:42:48 -060047${count} ${0}
Sivas SRR8254db62017-02-07 09:39:46 -060048${devicetree_base} /sys/firmware/devicetree/base/model
George Keishingcce9df22017-01-24 06:19:33 -060049
George Keishingb7c9b542017-05-23 08:19:58 -050050# Initialize default debug value to 0.
51${DEBUG} ${0}
52
Steven Sombar0acb3412018-01-24 09:38:42 -060053${probe_cpu_tool_path} ${EXECDIR}/tools/ras/probe_cpus.sh
54${scom_addrs_tool_path} ${EXECDIR}/tools/ras/scom_addr_p9.sh
55${target_file_path} /root/
56
57${default_tarball} ${EXECDIR}/obmc-phosphor-debug-tarball-witherspoon.tar.xz
58
Michael Walshfdc5ced2017-08-17 13:15:15 -050059# These variables are used to straddle between new and old methods of setting
60# values.
Steven Sombar0acb3412018-01-24 09:38:42 -060061${boot_prog_method} ${EMPTY}
Michael Walshfdc5ced2017-08-17 13:15:15 -050062${power_policy_setup} ${0}
63${bmc_power_policy_method} ${EMPTY}
64@{valid_power_policy_vars} RESTORE_LAST_STATE ALWAYS_POWER_ON
65... ALWAYS_POWER_OFF
66
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -050067
Chris Austenb29d2e82016-06-07 12:25:35 -050068*** Keywords ***
Sridevi Ramesh1699d372016-12-06 00:20:22 -060069
Sivas SRRc0957412017-10-06 13:02:08 -050070Check BMC Performance
71 [Documentation] Check BMC basic CPU Mem File system performance.
72
73 Check BMC CPU Performance
74 Check BMC Mem Performance
75 Check BMC File System Performance
76
Steven Sombar0acb3412018-01-24 09:38:42 -060077
Sivas SRRd97aa9c2017-05-22 11:19:25 -050078Verify PNOR Update
79 [Documentation] Verify that the PNOR is not corrupted.
80 # Example:
81 # FFS: Flash header not found. Code: 100
82 # Error 100 opening ffs !
83
George Keishinga37682e2018-06-15 13:12:13 -050084 ${pnor_info}= BMC Execute Command ${pflash_cmd}
Sivas SRRd97aa9c2017-05-22 11:19:25 -050085 Should Not Contain Any ${pnor_info} Flash header not found Error
86
Steven Sombar0acb3412018-01-24 09:38:42 -060087
Sivas SRR8254db62017-02-07 09:39:46 -060088Get BMC System Model
Steven Sombar0acb3412018-01-24 09:38:42 -060089 [Documentation] Get the BMC model from the device tree and return it.
Sivas SRR8254db62017-02-07 09:39:46 -060090
Michael Walshe53e47a2017-06-30 17:03:24 -050091 ${bmc_model} ${stderr} ${rc}= BMC Execute Command
George Keishing90ab1772017-02-24 05:40:55 -060092 ... cat ${devicetree_base} | cut -d " " -f 1 return_stderr=True
Michael Walsh71182ab2017-10-20 14:44:25 -050093 ... test_mode=0
Sivas SRR8254db62017-02-07 09:39:46 -060094 Should Be Empty ${stderr}
Steven Sombar0acb3412018-01-24 09:38:42 -060095 Should Not Be Empty ${bmc_model} msg=BMC model is empty.
Sivas SRR8254db62017-02-07 09:39:46 -060096 [Return] ${bmc_model}
97
Steven Sombar0acb3412018-01-24 09:38:42 -060098
Sivas SRR8254db62017-02-07 09:39:46 -060099Verify BMC System Model
100 [Documentation] Verify the BMC model with ${OPENBMC_MODEL}.
101 [Arguments] ${bmc_model}
102
Steven Sombar0acb3412018-01-24 09:38:42 -0600103 # Description of argument(s):
104 # bmc_model System model (e.g. "witherspoon").
105
Sivas SRR8254db62017-02-07 09:39:46 -0600106 ${tmp_bmc_model}= Fetch From Right ${OPENBMC_MODEL} /
107 ${tmp_bmc_model}= Fetch From Left ${tmp_bmc_model} .
108 ${ret}= Run Keyword And Return Status Should Contain ${bmc_model}
109 ... ${tmp_bmc_model} ignore_case=True
110 [Return] ${ret}
111
Steven Sombar0acb3412018-01-24 09:38:42 -0600112
Chris Austenb29d2e82016-06-07 12:25:35 -0500113Wait For Host To Ping
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500114 [Documentation] Wait for the given host to ping.
root442f0ef2016-08-04 20:23:05 +0000115 [Arguments] ${host} ${timeout}=${OPENBMC_REBOOT_TIMEOUT}min
116 ... ${interval}=5 sec
117
Steven Sombar0acb3412018-01-24 09:38:42 -0600118 # Description of argument(s):
119 # host The host name or IP of the host to ping.
120 # timeout The amount of time after which ping attempts cease.
121 # This should be expressed in Robot Framework's time format
122 # (e.g. "10 seconds").
root442f0ef2016-08-04 20:23:05 +0000123 # interval The amount of time in between attempts to ping.
Steven Sombar0acb3412018-01-24 09:38:42 -0600124 # This should be expressed in Robot Framework's time format
125 # (e.g. "5 seconds").
root442f0ef2016-08-04 20:23:05 +0000126
127 Wait Until Keyword Succeeds ${timeout} ${interval} Ping Host ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -0500128
Steven Sombar0acb3412018-01-24 09:38:42 -0600129
Chris Austenb29d2e82016-06-07 12:25:35 -0500130Ping Host
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500131 [Documentation] Ping the given host.
Chris Austenb29d2e82016-06-07 12:25:35 -0500132 [Arguments] ${host}
Steven Sombar0acb3412018-01-24 09:38:42 -0600133
134 # Description of argument(s):
135 # host The host name or IP of the host to ping.
136
George Keishing8a84f952016-08-25 04:54:53 -0500137 Should Not Be Empty ${host} msg=No host provided
Michael Walsha6723f22016-11-22 11:12:01 -0600138 ${RC} ${output}= Run and return RC and Output ping -c 4 ${host}
Chris Austenb29d2e82016-06-07 12:25:35 -0500139 Log RC: ${RC}\nOutput:\n${output}
140 Should be equal ${RC} ${0}
141
Steven Sombar0acb3412018-01-24 09:38:42 -0600142
Chris Austenb29d2e82016-06-07 12:25:35 -0500143Get Boot Progress
Michael Walshc972d4d2017-08-16 15:38:03 -0500144 [Documentation] Get the boot progress and return it.
Michael Walsha6723f22016-11-22 11:12:01 -0600145 [Arguments] ${quiet}=${QUIET}
146
Michael Walshc972d4d2017-08-16 15:38:03 -0500147 # Description of argument(s):
148 # quiet Indicates whether this keyword should run without any output to
149 # the console.
150
151 Set Boot Progress Method
152 ${state}= Run Keyword If '${boot_prog_method}' == 'New'
153 ... New Get Boot Progress quiet=${quiet}
154 ... ELSE
155 ... Old Get Boot Progress quiet=${quiet}
156
157 [Return] ${state}
158
Steven Sombar0acb3412018-01-24 09:38:42 -0600159
Michael Walshc972d4d2017-08-16 15:38:03 -0500160Set Boot Progress Method
161 [Documentation] Set the boot_prog_method to either 'Old' or 'New'.
162
163 # The boot progress data has moved from an 'org' location to an 'xyz'
164 # location. This keyword will determine whether the new method of getting
165 # the boot progress is valid and will set the global boot_prog_method
166 # variable accordingly. If boot_prog_method is already set (either by a
167 # prior call to this function or via a -v parm), this keyword will simply
168 # return.
169
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500170 # Note: There are interim builds that contain boot_progress in both the
171 # old and the new location values. It is nearly impossible for this
172 # keyword to determine whether the old boot_progress or the new one is
173 # active. When using such builds where the old boot_progress is active,
174 # the only recourse users will have is that they may specify
175 # -v boot_prog_method:Old to force old behavior on such builds.
Michael Walshc972d4d2017-08-16 15:38:03 -0500176
177 Run Keyword If '${boot_prog_method}' != '${EMPTY}' Return From Keyword
178
179 ${new_status} ${new_value}= Run Keyword And Ignore Error
180 ... New Get Boot Progress
181 # If the new style read fails, the method must necessarily be "Old".
182 Run Keyword If '${new_status}' == 'PASS'
183 ... Run Keywords
184 ... Set Global Variable ${boot_prog_method} New AND
185 ... Rqpvars boot_prog_method AND
186 ... Return From Keyword
187
188 # Default method is "Old".
189 Set Global Variable ${boot_prog_method} Old
190 Rqpvars boot_prog_method
191
Steven Sombar0acb3412018-01-24 09:38:42 -0600192
Michael Walshc972d4d2017-08-16 15:38:03 -0500193Old Get Boot Progress
194 [Documentation] Get the boot progress the old way (via org location).
195 [Arguments] ${quiet}=${QUIET}
196
197 # Description of argument(s):
198 # quiet Indicates whether this keyword should run without any output to
199 # the console.
200
George Keishing85ca05e2016-11-30 09:47:18 -0600201 ${state}= Read Attribute ${OPENBMC_BASE_URI}sensors/host/BootProgress
Michael Walsha6723f22016-11-22 11:12:01 -0600202 ... value quiet=${quiet}
Michael Walshc972d4d2017-08-16 15:38:03 -0500203
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600204 [Return] ${state}
Chris Austenb29d2e82016-06-07 12:25:35 -0500205
Steven Sombar0acb3412018-01-24 09:38:42 -0600206
Michael Walshc972d4d2017-08-16 15:38:03 -0500207New Get Boot Progress
208 [Documentation] Get the boot progress the new way (via xyz location).
209 [Arguments] ${quiet}=${QUIET}
210
211 # Description of argument(s):
212 # quiet Indicates whether this keyword should run without any output to
213 # the console.
214
215 ${state}= Read Attribute ${HOST_STATE_URI} BootProgress quiet=${quiet}
216
217 [Return] ${state.rsplit('.', 1)[1]}
218
Steven Sombar0acb3412018-01-24 09:38:42 -0600219
Chris Austenb29d2e82016-06-07 12:25:35 -0500220Is Power On
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500221 [Documentation] Verify that the BMC chassis state is on.
root442f0ef2016-08-04 20:23:05 +0000222 ${state}= Get Power State
223 Should be equal ${state} ${1}
Chris Austenb29d2e82016-06-07 12:25:35 -0500224
Steven Sombar0acb3412018-01-24 09:38:42 -0600225
Chris Austenb29d2e82016-06-07 12:25:35 -0500226Is Power Off
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500227 [Documentation] Verify that the BMC chassis state is off.
root442f0ef2016-08-04 20:23:05 +0000228 ${state}= Get Power State
229 Should be equal ${state} ${0}
Chris Austenb29d2e82016-06-07 12:25:35 -0500230
Steven Sombar0acb3412018-01-24 09:38:42 -0600231
root442f0ef2016-08-04 20:23:05 +0000232Initiate Power On
233 [Documentation] Initiates the power on and waits until the Is Power On
234 ... keyword returns that the power state has switched to on.
Michael Walsha6723f22016-11-22 11:12:01 -0600235 [Arguments] ${wait}=${1}
236
Steven Sombar0acb3412018-01-24 09:38:42 -0600237 # Description of argument(s):
238 # wait Indicates whether to wait for a powered on state after issuing
239 # the power on command.
240
Chris Austenb29d2e82016-06-07 12:25:35 -0500241 @{arglist}= Create List
242 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600243 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOn
Michael Walsha6723f22016-11-22 11:12:01 -0600244 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500245 should be equal as strings ${resp.status_code} ${HTTP_OK}
Chris Austenb29d2e82016-06-07 12:25:35 -0500246
Michael Walsha6723f22016-11-22 11:12:01 -0600247 # Does caller want to wait for power on status?
248 Run Keyword If '${wait}' == '${0}' Return From Keyword
249 Wait Until Keyword Succeeds 3 min 10 sec Is Power On
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500250
Steven Sombar0acb3412018-01-24 09:38:42 -0600251
root442f0ef2016-08-04 20:23:05 +0000252Initiate Power Off
253 [Documentation] Initiates the power off and waits until the Is Power Off
254 ... keyword returns that the power state has switched to off.
Steven Sombar0acb3412018-01-24 09:38:42 -0600255
Chris Austenb29d2e82016-06-07 12:25:35 -0500256 @{arglist}= Create List
257 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600258 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ powerOff
Michael Walsha6723f22016-11-22 11:12:01 -0600259 ... data=${args}
Chris Austenb29d2e82016-06-07 12:25:35 -0500260 should be equal as strings ${resp.status_code} ${HTTP_OK}
Michael Walsha6723f22016-11-22 11:12:01 -0600261 Wait Until Keyword Succeeds 1 min 10 sec Is Power Off
Chris Austenb29d2e82016-06-07 12:25:35 -0500262
Steven Sombar0acb3412018-01-24 09:38:42 -0600263
Michael Walsh81843772017-03-02 14:44:44 -0600264Initiate OS Host Power Off
265 [Documentation] Initiate an OS reboot.
266 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walshdfc75372018-01-11 11:47:25 -0600267 ... ${os_password}=${OS_PASSWORD} ${hard}=${0}
Michael Walsh81843772017-03-02 14:44:44 -0600268
Michael Walshdfc75372018-01-11 11:47:25 -0600269 # Description of argument(s):
Michael Walsh81843772017-03-02 14:44:44 -0600270 # os_host The DNS name or IP of the OS.
271 # os_username The username to be used to sign in to the OS.
272 # os_password The password to be used to sign in to the OS.
Michael Walshdfc75372018-01-11 11:47:25 -0600273 # hard Indicates whether to do a hard vs. soft power off.
274
275 ${time_string}= Run Keyword If ${hard} Set Variable ${SPACE}now
276 ... ELSE Set Variable ${EMPTY}
Michael Walsh81843772017-03-02 14:44:44 -0600277
Michael Walsh4549cd12017-09-07 18:02:36 -0500278 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
Michael Walshdfc75372018-01-11 11:47:25 -0600279 ... Set Variable shutdown${time_string}
Michael Walsh4549cd12017-09-07 18:02:36 -0500280 ... ELSE
Michael Walshdfc75372018-01-11 11:47:25 -0600281 ... Set Variable echo ${os_password} | sudo -S shutdown${time_string}
Michael Walsh4549cd12017-09-07 18:02:36 -0500282
283 ${output} ${stderr} ${rc}= OS Execute Command
284 ... ${cmd_buf} fork=${1}
Michael Walsh81843772017-03-02 14:44:44 -0600285
Steven Sombar0acb3412018-01-24 09:38:42 -0600286
Michael Walsh81843772017-03-02 14:44:44 -0600287Initiate OS Host Reboot
288 [Documentation] Initiate an OS reboot.
289 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
290 ... ${os_password}=${OS_PASSWORD}
291
Michael Walshf1a59fb2017-09-01 17:07:13 -0500292 # Description of argument(s):
293 # os_host The host name or IP address of the OS.
Michael Walsh81843772017-03-02 14:44:44 -0600294 # os_username The username to be used to sign in to the OS.
295 # os_password The password to be used to sign in to the OS.
296
Michael Walshf1a59fb2017-09-01 17:07:13 -0500297 ${cmd_buf}= Run Keyword If '${os_username}' == 'root'
298 ... Set Variable reboot
299 ... ELSE
300 ... Set Variable echo ${os_password} | sudo -S reboot
301
302 ${output} ${stderr} ${rc}= OS Execute Command
303 ... ${cmd_buf} fork=${1}
Michael Walsh81843772017-03-02 14:44:44 -0600304
Steven Sombar0acb3412018-01-24 09:38:42 -0600305
Michael Walsh81843772017-03-02 14:44:44 -0600306Initiate Auto Reboot
307 [Documentation] Initiate an auto reboot.
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500308 [Arguments] ${milliseconds}=5000
309
310 # Description of argument(s):
311 # milliseconds The number of milliseconds for the watchdog timer.
Michael Walsh81843772017-03-02 14:44:44 -0600312
313 # Set the auto reboot policy.
Sweta Potthuri62a23572017-07-28 04:05:13 -0500314 Set Auto Reboot ${1}
Michael Walsh4ffd1a12018-03-14 10:35:44 -0500315 # Set the watchdog timer.
316 Trigger Host Watchdog Error ${milliseconds}
Michael Walsh81843772017-03-02 14:44:44 -0600317
Steven Sombar0acb3412018-01-24 09:38:42 -0600318
Chris Austenb29d2e82016-06-07 12:25:35 -0500319Trigger Warm Reset
Steven Sombar0acb3412018-01-24 09:38:42 -0600320 [Documentation] Initiate a warm reset.
321
Chris Austenb29d2e82016-06-07 12:25:35 -0500322 log to console "Triggering warm reset"
Michael Walsha6723f22016-11-22 11:12:01 -0600323 ${data}= create dictionary data=@{EMPTY}
George Keishing85ca05e2016-11-30 09:47:18 -0600324 ${resp}= openbmc post request
325 ... ${OPENBMC_BASE_URI}control/bmc0/action/warmReset data=${data}
Chris Austenb29d2e82016-06-07 12:25:35 -0500326 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
George Keishingb3700812016-08-31 03:03:30 -0500327 ${session_active}= Check If warmReset is Initiated
328 Run Keyword If '${session_active}' == '${True}'
329 ... Fail msg=warm reset didn't occur
330
Chris Austenb29d2e82016-06-07 12:25:35 -0500331 Sleep ${SYSTEM_SHUTDOWN_TIME}min
Rahul Maheshwari5f253c42017-01-30 05:19:51 -0600332 Check If BMC Is Up
Michael Walsh49ab0f42016-07-20 11:44:33 -0500333
Steven Sombar0acb3412018-01-24 09:38:42 -0600334
Michael Walsh49ab0f42016-07-20 11:44:33 -0500335Check OS
root442f0ef2016-08-04 20:23:05 +0000336 [Documentation] Attempts to ping the host OS and then checks that the host
337 ... OS is up by running an SSH command.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500338
339 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
Michael Walsha6723f22016-11-22 11:12:01 -0600340 ... ${os_password}=${OS_PASSWORD} ${quiet}=${QUIET}
341 ... ${print_string}=${EMPTY}
Michael Walshac275512017-03-07 11:39:28 -0600342 [Teardown] SSHLibrary.Close Connection
Michael Walsh49ab0f42016-07-20 11:44:33 -0500343
Steven Sombar0acb3412018-01-24 09:38:42 -0600344 # Description of argument(s):
Michael Walsh49ab0f42016-07-20 11:44:33 -0500345 # os_host The DNS name/IP of the OS host associated with our BMC.
346 # os_username The username to be used to sign on to the OS host.
347 # os_password The password to be used to sign on to the OS host.
Michael Walsha6723f22016-11-22 11:12:01 -0600348 # quiet Indicates whether this keyword should write to console.
349 # print_string A string to be printed before checking the OS.
350
351 rprint ${print_string}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500352
root442f0ef2016-08-04 20:23:05 +0000353 # Attempt to ping the OS. Store the return code to check later.
354 ${ping_rc}= Run Keyword and Return Status Ping Host ${os_host}
355
Michael Walshac275512017-03-07 11:39:28 -0600356 SSHLibrary.Open connection ${os_host}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500357
Michael Walsha6723f22016-11-22 11:12:01 -0600358 ${status} ${msg}= Run Keyword And Ignore Error Login ${os_username}
359 ... ${os_password}
360 ${err_msg1}= Sprint Error ${msg}
361 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
362 Run Keyword If '${status}' == 'FAIL' Fail msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500363 ${output} ${stderr} ${rc}= Execute Command uptime return_stderr=True
364 ... return_rc=True
365
Michael Walsha6723f22016-11-22 11:12:01 -0600366 ${temp_msg}= Catenate Could not execute a command on the operating
367 ... system.\n
368 ${err_msg1}= Sprint Error ${temp_msg}
369 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
370
371 # If the return code returned by "Execute Command" is non-zero, this
372 # keyword will fail.
373 Should Be Equal ${rc} ${0} msg=${err_msg}
Michael Walsh49ab0f42016-07-20 11:44:33 -0500374 # We will likewise fail if there is any stderr data.
375 Should Be Empty ${stderr}
376
Michael Walsha6723f22016-11-22 11:12:01 -0600377 ${temp_msg}= Set Variable Could not ping the operating system.\n
378 ${err_msg1}= Sprint Error ${temp_msg}
379 ${err_msg}= Catenate SEPARATOR= \n ${err_msg1}
380 # We will likewise fail if the OS did not ping, as we could SSH but not
381 # ping
382 Should Be Equal As Strings ${ping_rc} ${TRUE} msg=${err_msg}
root442f0ef2016-08-04 20:23:05 +0000383
Steven Sombar0acb3412018-01-24 09:38:42 -0600384
Michael Walsh49ab0f42016-07-20 11:44:33 -0500385Wait for OS
386 [Documentation] Waits for the host OS to come up via calls to "Check OS".
387 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
388 ... ${os_password}=${OS_PASSWORD} ${timeout}=${OS_WAIT_TIMEOUT}
Michael Walsha6723f22016-11-22 11:12:01 -0600389 ... ${quiet}=${0}
390 [Teardown] rprintn
Michael Walsh49ab0f42016-07-20 11:44:33 -0500391
Steven Sombar0acb3412018-01-24 09:38:42 -0600392 # Description of argument(s):
Michael Walsh49ab0f42016-07-20 11:44:33 -0500393 # os_host The DNS name or IP of the OS host associated with our
394 # BMC.
395 # os_username The username to be used to sign on to the OS host.
396 # os_password The password to be used to sign on to the OS host.
397 # timeout The timeout in seconds indicating how long you're
398 # willing to wait for the OS to respond.
Michael Walsha6723f22016-11-22 11:12:01 -0600399 # quiet Indicates whether this keyword should write to console.
Michael Walsh49ab0f42016-07-20 11:44:33 -0500400
401 # The interval to be used between calls to "Check OS".
402 ${interval}= Set Variable 5
403
Michael Walsha6723f22016-11-22 11:12:01 -0600404 ${message}= Catenate Checking every ${interval} seconds for up to
405 ... ${timeout} seconds for the operating system to communicate.
406 rqprint_timen ${message}
407
Michael Walsh49ab0f42016-07-20 11:44:33 -0500408 Wait Until Keyword Succeeds ${timeout} sec ${interval} Check OS
409 ... ${os_host} ${os_username} ${os_password}
Michael Walsha6723f22016-11-22 11:12:01 -0600410 ... print_string=\#
411
412 rqprintn
413
414 rqprint_timen The operating system is now communicating.
root442f0ef2016-08-04 20:23:05 +0000415
root442f0ef2016-08-04 20:23:05 +0000416
417Get Power State
418 [Documentation] Returns the power state as an integer. Either 0 or 1.
Michael Walsha6723f22016-11-22 11:12:01 -0600419 [Arguments] ${quiet}=${QUIET}
420
Steven Sombar0acb3412018-01-24 09:38:42 -0600421 # Description of argument(s):
422 # quiet Indicates whether this keyword should run without any output to
423 # the console.
424
root442f0ef2016-08-04 20:23:05 +0000425 @{arglist}= Create List
426 ${args}= Create Dictionary data=@{arglist}
Michael Walsha6723f22016-11-22 11:12:01 -0600427
George Keishing85ca05e2016-11-30 09:47:18 -0600428 ${resp}= Call Method ${OPENBMC_BASE_URI}control/chassis0/ getPowerState
Michael Walsha6723f22016-11-22 11:12:01 -0600429 ... data=${args} quiet=${quiet}
root442f0ef2016-08-04 20:23:05 +0000430 Should be equal as strings ${resp.status_code} ${HTTP_OK}
431 ${content}= to json ${resp.content}
Steven Sombar0acb3412018-01-24 09:38:42 -0600432
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600433 [Return] ${content["data"]}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500434
George Keishinga8d68e22017-12-18 09:30:30 -0600435
436Clear BMC Gard Record
437 [Documentation] Clear gard records from the system.
438
439 @{arglist}= Create List
440 ${args}= Create Dictionary data=@{arglist}
George Keishing85ca05e2016-11-30 09:47:18 -0600441 ${resp}= Call Method
George Keishinga8d68e22017-12-18 09:30:30 -0600442 ... ${OPENPOWER_CONTROL}gard Reset data=${args}
443 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
444
Jay Azurine4c52eb2016-08-16 20:51:10 -0500445
446Copy PNOR to BMC
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500447 [Documentation] Copy the PNOR image to the BMC.
Jay Azurine4c52eb2016-08-16 20:51:10 -0500448 Import Library SCPLibrary WITH NAME scp
449 Open Connection for SCP
450 Log Copying ${PNOR_IMAGE_PATH} to /tmp
451 scp.Put File ${PNOR_IMAGE_PATH} /tmp
452
Steven Sombar0acb3412018-01-24 09:38:42 -0600453
Jay Azurine4c52eb2016-08-16 20:51:10 -0500454Flash PNOR
455 [Documentation] Calls flash bios update method to flash PNOR image
Gunnar Mills38032802016-12-12 13:43:40 -0600456 [Arguments] ${pnor_image}
Steven Sombar0acb3412018-01-24 09:38:42 -0600457
458 # Description of argument(s):
459 # pnor_image The filename and path of the PNOR image
460 # (e.g. "/home/image/zaius.pnor").
461
Jay Azurine4c52eb2016-08-16 20:51:10 -0500462 @{arglist}= Create List ${pnor_image}
463 ${args}= Create Dictionary data=@{arglist}
George Keishinge24fdbc2017-10-31 13:41:35 -0500464 ${resp}= Call Method /org/openbmc/control/flash/bios/ update
Michael Walsha6723f22016-11-22 11:12:01 -0600465 ... data=${args}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500466 should be equal as strings ${resp.status_code} ${HTTP_OK}
467 Wait Until Keyword Succeeds 2 min 10 sec Is PNOR Flashing
468
Steven Sombar0acb3412018-01-24 09:38:42 -0600469
Jay Azurine4c52eb2016-08-16 20:51:10 -0500470Get Flash BIOS Status
471 [Documentation] Returns the status of the flash BIOS API as a string. For
472 ... example 'Flashing', 'Flash Done', etc
George Keishinge24fdbc2017-10-31 13:41:35 -0500473 ${data}= Read Properties /org/openbmc/control/flash/bios
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600474 [Return] ${data['status']}
Jay Azurine4c52eb2016-08-16 20:51:10 -0500475
Steven Sombar0acb3412018-01-24 09:38:42 -0600476
Jay Azurine4c52eb2016-08-16 20:51:10 -0500477Is PNOR Flashing
478 [Documentation] Get BIOS 'Flashing' status. This indicates that PNOR
479 ... flashing has started.
480 ${status}= Get Flash BIOS Status
Rahul Maheshwari449dfb72017-05-08 02:06:48 -0500481 Should Contain ${status} Flashing
Jay Azurine4c52eb2016-08-16 20:51:10 -0500482
Steven Sombar0acb3412018-01-24 09:38:42 -0600483
Jay Azurine4c52eb2016-08-16 20:51:10 -0500484Is PNOR Flash Done
485 [Documentation] Get BIOS 'Flash Done' status. This indicates that the
486 ... PNOR flashing has completed.
Leah McNutt9ba32272016-11-17 15:48:39 +0000487 ${status}= Get Flash BIOS Status
Jay Azurine4c52eb2016-08-16 20:51:10 -0500488 should be equal as strings ${status} Flash Done
489
George Keishing5e870cd2016-08-24 10:05:47 -0500490
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600491Is OS Starting
492 [Documentation] Check if boot progress is OS starting.
493 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500494 Should Be Equal ${boot_progress} OSStart
Rahul Maheshwari2c725042017-01-29 22:55:28 -0600495
Steven Sombar0acb3412018-01-24 09:38:42 -0600496
George Keishing0af24412017-03-10 13:33:23 -0600497Is OS Off
498 [Documentation] Check if boot progress is "Off".
499 ${boot_progress}= Get Boot Progress
500 Should Be Equal ${boot_progress} Off
501
Steven Sombar0acb3412018-01-24 09:38:42 -0600502
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500503Get Boot Progress To OS Starting State
504 [Documentation] Get the system to a boot progress state of 'FW Progress,
505 ... Starting OS'.
506
507 ${boot_progress}= Get Boot Progress
Michael Walsh01975fa2017-08-20 20:51:36 -0500508 Run Keyword If '${boot_progress}' == 'OSStart'
Rahul Maheshwariffd30de2017-06-27 05:57:45 -0500509 ... Log Host is already in OS starting state
510 ... ELSE
511 ... Run Keywords Initiate Host PowerOff AND Initiate Host Boot
512 ... AND Wait Until Keyword Succeeds 10 min 10 sec Is OS Starting
513
Steven Sombar0acb3412018-01-24 09:38:42 -0600514
George Keishing5e870cd2016-08-24 10:05:47 -0500515Verify Ping and REST Authentication
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500516 [Documentation] Verify ping and rest authentication.
Michael Walsha6723f22016-11-22 11:12:01 -0600517 ${l_ping}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500518 ... Ping Host ${OPENBMC_HOST}
George Keishingc4d3dc02016-09-19 03:45:55 -0500519 Run Keyword If '${l_ping}' == '${False}'
520 ... Fail msg=Ping Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500521
Michael Walsha6723f22016-11-22 11:12:01 -0600522 ${l_rest}= Run Keyword And Return Status
George Keishing5e870cd2016-08-24 10:05:47 -0500523 ... Initialize OpenBMC
George Keishingc4d3dc02016-09-19 03:45:55 -0500524 Run Keyword If '${l_rest}' == '${False}'
525 ... Fail msg=REST Authentication Failed
George Keishing5e870cd2016-08-24 10:05:47 -0500526
527 # Just to make sure the SSH is working for SCP
528 Open Connection And Log In
529 ${system} ${stderr}= Execute Command hostname return_stderr=True
530 Should Be Empty ${stderr}
531
Steven Sombar0acb3412018-01-24 09:38:42 -0600532
George Keishingc4d3dc02016-09-19 03:45:55 -0500533Check If BMC is Up
534 [Documentation] Wait for Host to be online. Checks every X seconds
535 ... interval for Y minutes and fails if timed out.
536 ... Default MAX timedout is 10 min, interval 10 seconds.
Gunnar Mills38032802016-12-12 13:43:40 -0600537 [Arguments] ${max_timeout}=${OPENBMC_REBOOT_TIMEOUT} min
George Keishingc4d3dc02016-09-19 03:45:55 -0500538 ... ${interval}=10 sec
539
Steven Sombar0acb3412018-01-24 09:38:42 -0600540 # Description of argument(s):
541 # max_timeout Maximum time to wait.
542 # This should be expressed in Robot Framework's time format
543 # (e.g. "10 minutes").
544 # interfal Interval to wait between status checks.
545 # This should be expressed in Robot Framework's time format
546 # (e.g. "5 seconds").
547
George Keishingc4d3dc02016-09-19 03:45:55 -0500548 Wait Until Keyword Succeeds
549 ... ${max_timeout} ${interval} Verify Ping and REST Authentication
550
George Keishingb3700812016-08-31 03:03:30 -0500551
552Check If warmReset is Initiated
553 [Documentation] Ping would be still alive, so try SSH to connect
554 ... if fails the ports are down indicating reboot
555 ... is in progress
George Keishing3c05d352016-12-13 06:54:50 -0600556
557 # Warm reset adds 3 seconds delay before forcing reboot
558 # To minimize race conditions, we wait for 7 seconds
559 Sleep 7s
George Keishingb3700812016-08-31 03:03:30 -0500560 ${alive}= Run Keyword and Return Status
561 ... Open Connection And Log In
562 Return From Keyword If '${alive}' == '${False}' ${False}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600563 [Return] ${True}
George Keishingb3700812016-08-31 03:03:30 -0500564
Steven Sombar0acb3412018-01-24 09:38:42 -0600565
George Keishing06ae4aa2016-08-30 01:41:28 -0500566Flush REST Sessions
567 [Documentation] Removes all the active session objects
568 Delete All Sessions
George Keishingb3700812016-08-31 03:03:30 -0500569
Steven Sombar0acb3412018-01-24 09:38:42 -0600570
Sivas SRRe1143ae2016-08-26 22:31:02 -0500571Initialize DBUS cmd
572 [Documentation] Initialize dbus string with property string to extract
Gunnar Mills38032802016-12-12 13:43:40 -0600573 [Arguments] ${boot_property}
Steven Sombar0acb3412018-01-24 09:38:42 -0600574
575 # Description of argument(s):
576 # boot_property Property string.
577
Michael Walsha6723f22016-11-22 11:12:01 -0600578 ${cmd}= Catenate ${dbuscmdBase} ${dbuscmdGet} ${dbuscmdString}
579 ${cmd}= Catenate ${cmd}${boot_property}
Sivas SRRe1143ae2016-08-26 22:31:02 -0500580 Set Global Variable ${dbuscmd} ${cmd}
581
Steven Sombar0acb3412018-01-24 09:38:42 -0600582
David Shawba2d2c22017-01-23 16:56:38 -0600583Create OS Console File Path
584 [Documentation] Create OS console file path name and return it.
585 [Arguments] ${log_file_path}=${EMPTY}
George Keishing30c12ff2016-09-02 10:25:29 -0500586
Gunnar Mills28e403b2017-10-25 16:16:38 -0500587 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600588 # file_path The caller's candidate value. If this value is ${EMPTY}, this
589 # keyword will compose a file path name. Otherwise, this
590 # keyword will use the caller's file_path value. In either
591 # case, the value will be returned.
Gunnar Mills9c760342016-12-08 10:12:06 -0600592
Charles Paul Hofer92a4f452018-06-14 14:48:32 -0500593 ${status}= Run Keyword And Return Status Variable Should Exist ${TEST_NAME}
594
595 ${default_file_path}= Set Variable If ${status} == ${TRUE}
596 ... /tmp/${OPENBMC_HOST}_${TEST_NAME.replace(' ', '')}_os_console.txt
597 ... /tmp/${OPENBMC_HOST}_os_console.txt
598
David Shawba2d2c22017-01-23 16:56:38 -0600599 ${log_file_path}= Set Variable If '${log_file_path}' == '${EMPTY}'
600 ... ${default_file_path} ${log_file_path}
Michael Walsh01bd3682017-01-10 11:21:05 -0600601
David Shawba2d2c22017-01-23 16:56:38 -0600602 [Return] ${log_file_path}
Gunnar Mills9c760342016-12-08 10:12:06 -0600603
Steven Sombar0acb3412018-01-24 09:38:42 -0600604
David Shawba2d2c22017-01-23 16:56:38 -0600605Create OS Console Command String
606 [Documentation] Return a command string to start OS console logging.
Gunnar Mills9c760342016-12-08 10:12:06 -0600607
David Shawba2d2c22017-01-23 16:56:38 -0600608 # First make sure that the ssh_pw program is available.
Steven Sombar0acb3412018-01-24 09:38:42 -0600609 ${cmd}= Catenate which ssh_pw 2>/dev/null || find
610 ... ${EXECDIR} -name 'ssh_pw'
611
612 Rdpissuing ${cmd}
613 ${rc} ${output}= Run And Return Rc And Output ${cmd}
David Shawba2d2c22017-01-23 16:56:38 -0600614 Rdpvars rc output
Gunnar Mills9c760342016-12-08 10:12:06 -0600615
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500616 Should Be Equal As Integers 0 ${rc} msg=Could not find ssh_pw.
617
618 ${ssh_pw_file_path}= Set Variable ${output}
George Keishingb45d9522017-06-29 04:20:59 -0500619
Steven Sombar0acb3412018-01-24 09:38:42 -0600620 ${cmd}= Catenate ${ssh_pw_file_path} ${OPENBMC_PASSWORD} -p 2200
George Keishing1f9ec7f2017-06-06 08:59:19 -0500621 ... -o "StrictHostKeyChecking no" ${OPENBMC_USERNAME}@${OPENBMC_HOST}
George Keishing30c12ff2016-09-02 10:25:29 -0500622
Steven Sombar0acb3412018-01-24 09:38:42 -0600623 [Return] ${cmd}
624
George Keishing30c12ff2016-09-02 10:25:29 -0500625
Michael Walshcadf1342017-08-28 13:49:25 -0500626Get SOL Console Pid
Michael Walsh70419172017-12-06 14:20:52 -0600627 [Documentation] Get the pid of the active SOL console job.
628 [Arguments] ${expect_running}=${0}
629
630 # Description of argument(s):
631 # expect_running If set and if no SOL console job is found, print debug
632 # info and fail.
Michael Walshcadf1342017-08-28 13:49:25 -0500633
634 # Find the pid of the active system console logging session (if any).
635 ${search_string}= Create OS Console Command String
636 # At least in some cases, ps output does not show double quotes so we must
637 # replace them in our search string with the regexes to indicate that they
638 # are optional.
639 ${search_string}= Replace String ${search_string} " ["]?
Michael Walsh70419172017-12-06 14:20:52 -0600640 ${ps_cmd}= Catenate ps axwwo user,pid,cmd
641 ${cmd_buf}= Catenate echo $(${ps_cmd} | egrep '${search_string}' |
642 ... egrep -v grep | cut -c10-14)
Michael Walshcadf1342017-08-28 13:49:25 -0500643 Rdpissuing ${cmd_buf}
644 ${rc} ${os_con_pid}= Run And Return Rc And Output ${cmd_buf}
645 Rdpvars os_con_pid
646 # If rc is not zero it just means that there is no OS Console process
647 # running.
648
Michael Walsh70419172017-12-06 14:20:52 -0600649 Return From Keyword If '${os_con_pid}' != '${EMPTY}' ${os_con_pid}
650 Return From Keyword If '${expect_running}' == '${0}' ${os_con_pid}
651
652 Cmd Fnc cat ${log_file_path} ; echo ; ${ps_cmd} quiet=${0}
653 ... print_output=${1} show_err=${1}
654
655 Should Not Be Empty ${os_con_pid}
Michael Walshcadf1342017-08-28 13:49:25 -0500656
657
George Keishing30c12ff2016-09-02 10:25:29 -0500658Stop SOL Console Logging
David Shawba2d2c22017-01-23 16:56:38 -0600659 [Documentation] Stop system console logging and return log output.
George Keishing72992e42017-06-16 06:42:36 -0500660 [Arguments] ${log_file_path}=${EMPTY}
661 ... ${targ_file_path}=${EXECDIR}${/}logs${/}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500662 ... ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600663
664 # If there are muliple system console processes, they will all be stopped.
665 # If there is no existing log file this keyword will return an error
666 # message to that effect (and write that message to targ_file_path, if
667 # specified).
668 # NOTE: This keyword will not fail if there is no running system console
669 # process.
Michael Walsh01bd3682017-01-10 11:21:05 -0600670
671 # Description of arguments:
David Shawba2d2c22017-01-23 16:56:38 -0600672 # log_file_path The file path that was used to call "Start SOL
673 # Console Logging". See that keyword (above) for details.
674 # targ_file_path If specified, the file path to which the source
675 # file path (i.e. "log_file_path") should be copied.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500676 # return_data If this is set to ${1}, this keyword will return the SOL
677 # data to the caller as a unicode string.
George Keishing30c12ff2016-09-02 10:25:29 -0500678
David Shawba2d2c22017-01-23 16:56:38 -0600679 ${log_file_path}= Create OS Console File Path ${log_file_path}
Michael Walshcadf1342017-08-28 13:49:25 -0500680
681 ${os_con_pid}= Get SOL Console Pid
George Keishing30c12ff2016-09-02 10:25:29 -0500682
David Shawba2d2c22017-01-23 16:56:38 -0600683 ${cmd_buf}= Catenate kill -9 ${os_con_pid}
684 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpissuing ${cmd_buf}
685 ${rc} ${output}= Run Keyword If '${os_con_pid}' != '${EMPTY}'
686 ... Run And Return Rc And Output ${cmd_buf}
687 Run Keyword If '${os_con_pid}' != '${EMPTY}' Rdpvars rc output
George Keishing30c12ff2016-09-02 10:25:29 -0500688
Michael Walsh01bd3682017-01-10 11:21:05 -0600689 Run Keyword If '${targ_file_path}' != '${EMPTY}'
David Shawba2d2c22017-01-23 16:56:38 -0600690 ... Run Keyword And Ignore Error
691 ... Copy File ${log_file_path} ${targ_file_path}
George Keishing30c12ff2016-09-02 10:25:29 -0500692
Michael Walsh5f3f4142017-05-22 17:09:47 -0500693 ${output}= Set Variable ${EMPTY}
694 ${loc_quiet}= Evaluate ${debug}^1
695 ${rc} ${output}= Run Keyword If '${return_data}' == '${1}'
Michael Walsh98d8c9e2017-10-04 12:24:29 -0500696 ... Cmd Fnc cat ${log_file_path} 2>/dev/null quiet=${loc_quiet}
697 ... print_output=${0} show_err=${0}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500698
David Shawba2d2c22017-01-23 16:56:38 -0600699 [Return] ${output}
700
Steven Sombar0acb3412018-01-24 09:38:42 -0600701
David Shawba2d2c22017-01-23 16:56:38 -0600702Start SOL Console Logging
703 [Documentation] Start system console log to file.
Michael Walsh5f3f4142017-05-22 17:09:47 -0500704 [Arguments] ${log_file_path}=${EMPTY} ${return_data}=${1}
David Shawba2d2c22017-01-23 16:56:38 -0600705
706 # This keyword will first call "Stop SOL Console Logging". Only then will
707 # it start SOL console logging. The data returned by "Stop SOL Console
708 # Logging" will in turn be returned by this keyword.
709
710 # Description of arguments:
Michael Walsh5f3f4142017-05-22 17:09:47 -0500711 # log_file_path The file path to which system console log data should be
712 # written. Note that this path is taken to be a location
713 # on the machine where this program is running rather than
714 # on the Open BMC system.
715 # return_data If this is set to ${1}, this keyword will return any SOL
716 # data to the caller as a unicode string.
David Shawba2d2c22017-01-23 16:56:38 -0600717
718 ${log_file_path}= Create OS Console File Path ${log_file_path}
719
720 ${log_output}= Stop SOL Console Logging ${log_file_path}
Michael Walsh5f3f4142017-05-22 17:09:47 -0500721 ... return_data=${return_data}
David Shawba2d2c22017-01-23 16:56:38 -0600722
723 # Validate by making sure we can create the file. Problems creating the
724 # file would not be noticed by the subsequent ssh command because we fork
725 # the command.
726 Create File ${log_file_path}
727 ${sub_cmd_buf}= Create OS Console Command String
728 # Routing stderr to stdout so that any startup error text will go to the
729 # output file.
George Keishing8c3c1df2017-09-13 13:50:20 -0500730 # TODO: Doesn't work with tox so reverting temporarily.
Michael Walsh460042e2017-09-05 16:55:49 -0500731 # nohup detaches the process completely from our pty.
George Keishing8c3c1df2017-09-13 13:50:20 -0500732 #${cmd_buf}= Catenate nohup ${sub_cmd_buf} &> ${log_file_path} &
733 ${cmd_buf}= Catenate ${sub_cmd_buf} > ${log_file_path} 2>&1 &
David Shawba2d2c22017-01-23 16:56:38 -0600734 Rdpissuing ${cmd_buf}
735 ${rc} ${output}= Run And Return Rc And Output ${cmd_buf}
736 # Because we are forking this command, we essentially will never get a
737 # non-zero return code or any output.
738 Should Be Equal ${rc} ${0}
739
Michael Walsh70419172017-12-06 14:20:52 -0600740 Wait Until Keyword Succeeds 10 seconds 0 seconds
741 ... Get SOL Console Pid ${1}
Michael Walshcadf1342017-08-28 13:49:25 -0500742
David Shawba2d2c22017-01-23 16:56:38 -0600743 [Return] ${log_output}
George Keishing30c12ff2016-09-02 10:25:29 -0500744
Michael Walsh70419172017-12-06 14:20:52 -0600745
George Keishing30c12ff2016-09-02 10:25:29 -0500746Get Time Stamp
747 [Documentation] Get the current time stamp data
748 ${cur_time}= Get Current Date result_format=%Y%m%d%H%M%S%f
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500749 [Return] ${cur_time}
George Keishing30c12ff2016-09-02 10:25:29 -0500750
George Keishing1b150202016-09-29 08:51:58 -0500751
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500752Start Journal Log
753 [Documentation] Start capturing journal log to a file in /tmp using
754 ... journalctl command. By default journal log is collected
755 ... at /tmp/journal_log else user input location.
756 ... The File is appended with datetime.
George Keishing76a5daf2018-09-14 06:00:01 -0500757 [Arguments] ${file_path}=/tmp/journal_log ${filter}=${EMPTY}
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500758
Steven Sombar0acb3412018-01-24 09:38:42 -0600759 # Description of arguments:
760 # file_path The file path of the journal file.
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500761
762 ${cur_time}= Get Time Stamp
763 Set Global Variable ${LOG_TIME} ${cur_time}
George Keishing76a5daf2018-09-14 06:00:01 -0500764 Open Connection And Log In
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500765 Start Command
George Keishing76a5daf2018-09-14 06:00:01 -0500766 ... journalctl -f ${filter} > ${file_path}-${LOG_TIME}
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500767 Log Journal Log Started: ${file_path}-${LOG_TIME}
768
David Shawba2d2c22017-01-23 16:56:38 -0600769
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500770Stop Journal Log
771 [Documentation] Stop journalctl process if its running.
772 ... By default return log from /tmp/journal_log else
773 ... user input location.
774 [Arguments] ${file_path}=/tmp/journal_log
775
Steven Sombar0acb3412018-01-24 09:38:42 -0600776 # Description of arguments:
777 # file_path The file path of the journal file.
778
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500779 Open Connection And Log In
780
781 ${rc}=
782 ... Execute Command
George Keishing76a5daf2018-09-14 06:00:01 -0500783 ... ps | grep journalctl | grep -v grep
Rahul Maheshwarif684ba72016-10-25 07:24:41 -0500784 ... return_stdout=False return_rc=True
785
786 Return From Keyword If '${rc}' == '${1}'
787 ... No journal log process running
788
789 ${output} ${stderr}=
790 ... Execute Command killall journalctl
791 ... return_stderr=True
792 Should Be Empty ${stderr}
793
794 ${journal_log} ${stderr}=
795 ... Execute Command
796 ... cat ${file_path}-${LOG_TIME}
797 ... return_stderr=True
798 Should Be Empty ${stderr}
799
800 Log ${journal_log}
801
802 Execute Command rm ${file_path}-${LOG_TIME}
803
804 [Return] ${journal_log}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500805
Steven Sombar0acb3412018-01-24 09:38:42 -0600806
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500807Mac Address To Hex String
808 [Documentation] Converts MAC address into hex format.
809 ... Example
810 ... Given the following MAC: 00:01:6C:80:02:78
811 ... This keyword will return: 0x00 0x01 0x6C 0x80 0x02 0x78
812 ... Description of arguments:
Michael Walsh01bd3682017-01-10 11:21:05 -0600813 ... i_macaddress MAC address in the following format
814 ... 00:01:6C:80:02:78
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500815 [Arguments] ${i_macaddress}
816
Steven Sombar0acb3412018-01-24 09:38:42 -0600817 # Description of arguments:
818 # i_macaddress The MAC address.
819
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500820 ${mac_hex}= Catenate 0x${i_macaddress.replace(':', ' 0x')}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600821 [Return] ${mac_hex}
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500822
Steven Sombar0acb3412018-01-24 09:38:42 -0600823
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500824IP Address To Hex String
825 [Documentation] Converts IP address into hex format.
826 ... Example:
827 ... Given the following IP: 10.3.164.100
828 ... This keyword will return: 0xa 0x3 0xa4 0xa0
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500829 [Arguments] ${i_ipaddress}
830
Steven Sombar0acb3412018-01-24 09:38:42 -0600831 # Description of arguments:
832 # i_macaddress The IP address in the format 10.10.10.10.
833
Rahul Maheshwari757d80c2016-10-17 01:09:55 -0500834 @{ip}= Split String ${i_ipaddress} .
835 ${index}= Set Variable ${0}
836
837 :FOR ${item} IN @{ip}
838 \ ${hex}= Convert To Hex ${item} prefix=0x lowercase=yes
839 \ Set List Value ${ip} ${index} ${hex}
840 \ ${index}= Set Variable ${index + 1}
841 ${ip_hex}= Catenate @{ip}
Steven Sombar0acb3412018-01-24 09:38:42 -0600842
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600843 [Return] ${ip_hex}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600844
Steven Sombar0acb3412018-01-24 09:38:42 -0600845
Sivas SRRea85d1f2016-11-13 22:44:28 -0600846BMC CPU Performance Check
847 [Documentation] Minimal 10% of proc should be free in this instance
848
Sivas SRRa13eb202017-11-03 10:01:56 -0500849 ${bmc_cpu_usage_output} ${stderr} ${rc}= BMC Execute Command
850 ... ${bmc_cpu_usage_cmd}
Sivas SRR5ff4d692017-11-23 02:53:52 -0600851 ${bmc_cpu_usage_output} ${stderr} ${rc}= BMC Execute Command
852 ... ${bmc_cpu_usage_cmd}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600853 ${bmc_cpu_percentage}= Fetch From Left ${bmc_cpu_usage_output} %
854 Should be true ${bmc_cpu_percentage} < 90
855
Steven Sombar0acb3412018-01-24 09:38:42 -0600856
Sivas SRRea85d1f2016-11-13 22:44:28 -0600857BMC Mem Performance Check
858 [Documentation] Minimal 10% of memory should be free in this instance
859
Sivas SRRa13eb202017-11-03 10:01:56 -0500860 ${bmc_mem_free_output} ${stderr} ${rc}= BMC Execute Command
861 ... ${bmc_mem_free_cmd}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600862
Sivas SRRa13eb202017-11-03 10:01:56 -0500863 ${bmc_mem_total_output} ${stderr} ${rc}= BMC Execute Command
864 ... ${bmc_mem_total_cmd}
Sivas SRR5ff4d692017-11-23 02:53:52 -0600865 ${bmc_mem_free_output} ${stderr} ${rc}= BMC Execute Command
866 ... ${bmc_mem_free_cmd}
Sivas SRRea85d1f2016-11-13 22:44:28 -0600867
Sivas SRR5ff4d692017-11-23 02:53:52 -0600868 ${bmc_mem_total_output} ${stderr} ${rc}= BMC Execute Command
869 ... ${bmc_mem_total_cmd}
870
871 ${bmc_mem_percentage}= Evaluate ${bmc_mem_free_output}*100
Sivas SRRea85d1f2016-11-13 22:44:28 -0600872 ${bmc_mem_percentage}= Evaluate
873 ... ${bmc_mem_percentage}/${bmc_mem_total_output}
874 Should be true ${bmc_mem_percentage} > 10
875
Steven Sombar0acb3412018-01-24 09:38:42 -0600876
Sivas SRRaca55712016-12-21 04:32:35 -0600877BMC File System Usage Check
Sivas SRRc0957412017-10-06 13:02:08 -0500878 [Documentation] Check the file system space. 4 file system should be
879 ... 100% full which is expected
Steven Sombar0acb3412018-01-24 09:38:42 -0600880 # Filesystem Size Used Available Use% Mounted on
881 # /dev/root 14.4M 14.4M 0 100% /
882 # /dev/ubiblock0_0 14.4M 14.4M 0 100% /media/rofs-c9249b0e
883 # /dev/ubiblock8_0 19.6M 19.6M 0 100% /media/pnor-ro-8764baa3
884 # /dev/ubiblock4_0 14.4M 14.4M 0 100% /media/rofs-407816c
885 # /dev/ubiblock8_4 21.1M 21.1M 0 100% /media/pnor-ro-cecc64c4
Sivas SRR5ff4d692017-11-23 02:53:52 -0600886 ${bmc_fs_usage_output} ${stderr} ${rc}= BMC Execute Command
887 ... ${bmc_file_system_usage_cmd}
888 ${bmc_pnor_fs_usage_output} ${stderr} ${rc}= BMC Execute Command
889 ... ${total_pnor_ro_file_system_cmd}
890 ${bmc_bmc_fs_usage_output} ${stderr} ${rc}= BMC Execute Command
891 ... ${total_bmc_ro_file_system_cmd}
892 ${total_bmc_pnor_image}= Evaluate
893 ... ${bmc_pnor_fs_usage_output}+${bmc_bmc_fs_usage_output}
894 # Considering /dev/root also in total 100% used file system
895 ${total_full_fs}= Evaluate ${total_bmc_pnor_image}+1
896 Should Be True ${bmc_fs_usage_output}==${total_full_fs}
Sivas SRRaca55712016-12-21 04:32:35 -0600897
Steven Sombar0acb3412018-01-24 09:38:42 -0600898
Sivas SRRea85d1f2016-11-13 22:44:28 -0600899Check BMC CPU Performance
900 [Documentation] Minimal 10% of proc should be free in 3 sample
901 :FOR ${var} IN Range 1 4
902 \ BMC CPU Performance check
903
Steven Sombar0acb3412018-01-24 09:38:42 -0600904
Sivas SRRea85d1f2016-11-13 22:44:28 -0600905Check BMC Mem Performance
906 [Documentation] Minimal 10% of memory should be free
907
908 :FOR ${var} IN Range 1 4
909 \ BMC Mem Performance check
910
Steven Sombar0acb3412018-01-24 09:38:42 -0600911
Sivas SRRaca55712016-12-21 04:32:35 -0600912Check BMC File System Performance
913 [Documentation] Check for file system usage for 4 times
914
915 :FOR ${var} IN Range 1 4
916 \ BMC File System Usage check
917
Steven Sombar0acb3412018-01-24 09:38:42 -0600918
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500919Get URL List
920 [Documentation] Return list of URLs under given URL.
921 [Arguments] ${openbmc_url}
Steven Sombar0acb3412018-01-24 09:38:42 -0600922
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500923 # Description of argument(s):
Michael Walsh5f3f4142017-05-22 17:09:47 -0500924 # openbmc_url URL for list operation (e.g.
925 # /xyz/openbmc_project/inventory).
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500926
George Keishing335f5362017-06-30 15:11:20 -0500927 ${url_list}= Read Properties ${openbmc_url}/list quiet=${1}
George Keishing184a89a2017-06-27 07:12:16 -0500928 Sort List ${url_list}
Steven Sombar0acb3412018-01-24 09:38:42 -0600929
Rahul Maheshwari63c105b2017-05-12 05:13:52 -0500930 [Return] ${url_list}
931
Steven Sombar0acb3412018-01-24 09:38:42 -0600932
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600933Get Endpoint Paths
934 [Documentation] Returns all url paths ending with given endpoint
935 ... Example:
936 ... Given the following endpoint: cpu
Michael Walsh01bd3682017-01-10 11:21:05 -0600937 ... This keyword will return: list of all urls ending with
938 ... cpu -
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600939 ... /org/openbmc/inventory/system/chassis/motherboard/cpu0,
940 ... /org/openbmc/inventory/system/chassis/motherboard/cpu1
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600941 [Arguments] ${path} ${endpoint}
942
Steven Sombar0acb3412018-01-24 09:38:42 -0600943 # Description of arguments:
944 # path URL path for enumeration.
945 # endpoint Endpoint string (url path ending).
946
George Keishingc7b161b2017-12-01 09:58:12 -0600947 ${resp}= Read Properties ${path}/enumerate timeout=30
948 Log Dictionary ${resp}
Rahul Maheshwari9a8d3b12016-12-05 04:06:16 -0600949
George Keishingc7b161b2017-12-01 09:58:12 -0600950 ${list}= Get Dictionary Keys ${resp}
951 # For a given string, look for prefix and suffix for matching expression.
952 # Start of string followed by zero or more of any character followed by
953 # any digit or lower case character.
954 ${resp}= Get Matches ${list} regexp=^.*[0-9a-z_].${endpoint}[0-9a-z]*$
Steven Sombar0acb3412018-01-24 09:38:42 -0600955
George Keishingc7b161b2017-12-01 09:58:12 -0600956 [Return] ${resp}
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500957
Steven Sombar0acb3412018-01-24 09:38:42 -0600958
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500959Check Zombie Process
960 [Documentation] Check if any defunct process exist or not on BMC
Michael Walsh01bd3682017-01-10 11:21:05 -0600961 ${count} ${stderr} ${rc}= Execute Command ps -o stat | grep Z | wc -l
Sridevi Rameshb96a0c32016-10-19 05:09:52 -0500962 ... return_stderr=True return_rc=True
963 Should Be True ${count}==0
964 Should Be Empty ${stderr}
George Keishing5327d012016-12-08 08:43:29 -0600965
Steven Sombar0acb3412018-01-24 09:38:42 -0600966
George Keishing5327d012016-12-08 08:43:29 -0600967Prune Journal Log
968 [Documentation] Prune archived journal logs.
969 [Arguments] ${vacuum_size}=1M
970
971 # This keyword can be used to prevent the journal
972 # log from filling up the /run filesystem.
973 # This command will retain only the latest logs
974 # of the user specified size.
975
Steven Sombar0acb3412018-01-24 09:38:42 -0600976 # Description of argument(s):
977 # vacuum_size Size of journal.
978
George Keishing5327d012016-12-08 08:43:29 -0600979 Open Connection And Log In
980 ${output} ${stderr} ${rc}=
981 ... Execute Command
982 ... journalctl --vacuum-size=${vacuum_size}
983 ... return_stderr=True return_rc=True
984
985 Should Be Equal ${rc} ${0} msg=${stderr}
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600986
Steven Sombar0acb3412018-01-24 09:38:42 -0600987
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600988Set BMC Power Policy
989 [Documentation] Set the given BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -0500990 [Arguments] ${policy}
991
992 # Note that this function will translate the old style "RESTORE_LAST_STATE"
993 # policy to the new style "xyz.openbmc_project.Control.Power.RestorePolicy.
994 # Policy.Restore" for you.
Sridevi Ramesh1699d372016-12-06 00:20:22 -0600995
George Keishing1c3a9662017-08-11 10:16:36 -0500996 # Description of argument(s):
Michael Walshfdc5ced2017-08-17 13:15:15 -0500997 # policy Power restore policy (e.g "RESTORE_LAST_STATE",
998 # ${RESTORE_LAST_STATE}).
999
1000 # Set the bmc_power_policy_method to either 'Old' or 'New'.
1001 Set Power Policy Method
1002 # This translation helps bridge between old and new method for calling.
1003 ${policy}= Translate Power Policy Value ${policy}
1004 # Run the appropriate keyword.
1005 Run Key ${bmc_power_policy_method} Set Power Policy \ ${policy}
1006 ${currentPolicy}= Get System Power Policy
1007 Should Be Equal ${currentPolicy} ${policy}
1008
Steven Sombar0acb3412018-01-24 09:38:42 -06001009
Michael Walshfdc5ced2017-08-17 13:15:15 -05001010New Set Power Policy
1011 [Documentation] Set the given BMC power policy (new method).
1012 [Arguments] ${policy}
1013
1014 # Description of argument(s):
George Keishingefc3ff22017-12-12 11:49:25 -06001015 # policy Power restore policy (e.g. ${ALWAYS_POWER_OFF}).
George Keishing1c3a9662017-08-11 10:16:36 -05001016
1017 ${valueDict}= Create Dictionary data=${policy}
1018 Write Attribute
Michael Walshfdc5ced2017-08-17 13:15:15 -05001019 ... ${POWER_RESTORE_URI} PowerRestorePolicy data=${valueDict}
1020
Steven Sombar0acb3412018-01-24 09:38:42 -06001021
Michael Walshfdc5ced2017-08-17 13:15:15 -05001022Old Set Power Policy
1023 [Documentation] Set the given BMC power policy (old method).
1024 [Arguments] ${policy}
1025
1026 # Description of argument(s):
George Keishingefc3ff22017-12-12 11:49:25 -06001027 # policy Power restore policy (e.g. "ALWAYS_POWER_OFF").
Michael Walshfdc5ced2017-08-17 13:15:15 -05001028
1029 ${valueDict}= create dictionary data=${policy}
1030 Write Attribute ${HOST_SETTING} power_policy data=${valueDict}
George Keishingcce9df22017-01-24 06:19:33 -06001031
Steven Sombar0acb3412018-01-24 09:38:42 -06001032
George Keishing4d6f3d62017-02-06 09:50:41 -06001033Get System Power Policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001034 [Documentation] Returns the BMC power policy.
Michael Walshfdc5ced2017-08-17 13:15:15 -05001035
1036 # Set the bmc_power_policy_method to either 'Old' or 'New'.
1037 Set Power Policy Method
1038 ${cmd_buf}= Create List ${bmc_power_policy_method} Get Power Policy
1039 # Run the appropriate keyword.
1040 ${currentPolicy}= Run Keyword @{cmd_buf}
Steven Sombar0acb3412018-01-24 09:38:42 -06001041
Michael Walshfdc5ced2017-08-17 13:15:15 -05001042 [Return] ${currentPolicy}
1043
Steven Sombar0acb3412018-01-24 09:38:42 -06001044
Michael Walshfdc5ced2017-08-17 13:15:15 -05001045New Get Power Policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001046 [Documentation] Returns the BMC power policy (new method).
George Keishing1c3a9662017-08-11 10:16:36 -05001047 ${currentPolicy}= Read Attribute ${POWER_RESTORE_URI} PowerRestorePolicy
Steven Sombar0acb3412018-01-24 09:38:42 -06001048
George Keishing4d6f3d62017-02-06 09:50:41 -06001049 [Return] ${currentPolicy}
George Keishingcce9df22017-01-24 06:19:33 -06001050
Steven Sombar0acb3412018-01-24 09:38:42 -06001051
Michael Walshfdc5ced2017-08-17 13:15:15 -05001052Old Get Power Policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001053 [Documentation] Returns the BMC power policy (old method).
Michael Walshfdc5ced2017-08-17 13:15:15 -05001054 ${currentPolicy}= Read Attribute ${HOST_SETTING} power_policy
Steven Sombar0acb3412018-01-24 09:38:42 -06001055
Michael Walshfdc5ced2017-08-17 13:15:15 -05001056 [Return] ${currentPolicy}
1057
Steven Sombar0acb3412018-01-24 09:38:42 -06001058
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001059Get Auto Reboot
1060 [Documentation] Returns auto reboot setting.
Sweta Potthuri62a23572017-07-28 04:05:13 -05001061 ${setting}= Read Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot
Steven Sombar0acb3412018-01-24 09:38:42 -06001062
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001063 [Return] ${setting}
1064
Steven Sombar0acb3412018-01-24 09:38:42 -06001065
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001066Set Auto Reboot
1067 [Documentation] Set the given auto reboot setting.
1068 [Arguments] ${setting}
Steven Sombar0acb3412018-01-24 09:38:42 -06001069
1070 # Description of argument(s):
1071 # setting The reboot setting, 1 for enabling and 0 for disabling.
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001072
1073 ${valueDict}= Set Variable ${setting}
1074 ${data}= Create Dictionary data=${valueDict}
Sweta Potthuri62a23572017-07-28 04:05:13 -05001075 Write Attribute ${CONTROL_HOST_URI}/auto_reboot AutoReboot data=${data}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001076 ${current_setting}= Get Auto Reboot
Sweta Potthuri62a23572017-07-28 04:05:13 -05001077 Should Be Equal As Integers ${current_setting} ${setting}
Rahul Maheshwari1cbf0042017-02-13 05:17:37 -06001078
1079
George Keishingcce9df22017-01-24 06:19:33 -06001080Set BMC Reset Reference Time
1081 [Documentation] Set current boot time as a reference and increment
George Keishing80dd5af2017-02-08 07:01:25 -06001082 ... boot count.
George Keishingcce9df22017-01-24 06:19:33 -06001083
1084 ${cur_btime}= Get BMC Boot Time
George Keishing80dd5af2017-02-08 07:01:25 -06001085 Run Keyword If ${BOOT_TIME} == ${0} and ${BOOT_COUNT} == ${0}
George Keishingcce9df22017-01-24 06:19:33 -06001086 ... Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishing80dd5af2017-02-08 07:01:25 -06001087 ... ELSE IF ${cur_btime} > ${BOOT_TIME}
1088 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
George Keishingcce9df22017-01-24 06:19:33 -06001089 ... AND
1090 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
1091
Steven Sombar0acb3412018-01-24 09:38:42 -06001092
George Keishingcce9df22017-01-24 06:19:33 -06001093Get BMC Boot Time
Steven Sombar0acb3412018-01-24 09:38:42 -06001094 [Documentation] Returns boot time from /proc/stat.
George Keishingcce9df22017-01-24 06:19:33 -06001095
1096 Open Connection And Log In
1097 ${output} ${stderr}=
1098 ... Execute Command egrep '^btime ' /proc/stat | cut -f 2 -d ' '
1099 ... return_stderr=True
1100 Should Be Empty ${stderr}
1101 ${btime}= Convert To Integer ${output}
1102 [Return] ${btime}
George Keishingede30002017-02-02 09:33:07 -06001103
Steven Sombar0acb3412018-01-24 09:38:42 -06001104
George Keishing7a520222017-02-27 09:44:30 -06001105Enable Core Dump On BMC
1106 [Documentation] Enable core dump collection.
Joy Onyerikwu9b668972018-05-22 19:10:43 -05001107 ${core_pattern} ${stderr} ${rc}= BMC Execute Command
George Keishing7a520222017-02-27 09:44:30 -06001108 ... echo '/tmp/core_%e.%p' | tee /proc/sys/kernel/core_pattern
1109 Should Be Equal As Strings ${core_pattern} /tmp/core_%e.%p
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001110
Steven Sombar0acb3412018-01-24 09:38:42 -06001111
Sivas SRR01262bd2017-03-19 10:00:23 -05001112Get Number Of BMC Core Dump Files
Steven Sombar0acb3412018-01-24 09:38:42 -06001113 [Documentation] Returns number of core dump files on BMC.
Sivas SRR01262bd2017-03-19 10:00:23 -05001114 Open Connection And Log In
1115 ${num_of_core_dump}= Execute Command
1116 ... ls /tmp/core* 2>/dev/null | wc -l
1117 [Return] ${num_of_core_dump}
1118
Steven Sombar0acb3412018-01-24 09:38:42 -06001119
Sivas SRR01262bd2017-03-19 10:00:23 -05001120Set Core Dump File Size Unlimited
1121 [Documentation] Set core dump file size to unlimited.
Joy Onyerikwu9b668972018-05-22 19:10:43 -05001122 BMC Execute Command ulimit -c unlimited
Sivas SRR01262bd2017-03-19 10:00:23 -05001123
Steven Sombar0acb3412018-01-24 09:38:42 -06001124
Sivas SRR01262bd2017-03-19 10:00:23 -05001125Check For Core Dumps
1126 [Documentation] Check for any core dumps exist.
1127 ${output}= Get Number Of BMC Core Dump Files
1128 Run Keyword If ${output} > 0
1129 ... Log **Warning** BMC core dump files exist level=WARN
1130
Steven Sombar0acb3412018-01-24 09:38:42 -06001131
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001132Trigger Host Watchdog Error
George Keishing37cfa6b2017-06-15 10:25:55 -05001133 [Documentation] Inject host watchdog timeout error via REST.
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001134 [Arguments] ${milliseconds}=1000 ${sleep_time}=5s
Steven Sombar0acb3412018-01-24 09:38:42 -06001135
Michael Walshb5839d02017-04-12 16:11:20 -05001136 # Description of argument(s):
1137 # milliseconds The time watchdog timer value in milliseconds (e.g. 1000 =
1138 # 1 second).
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001139 # sleep_time Time delay for host watchdog error to get injected.
1140 # Default is 5 seconds.
1141
Michael Walsh4ffd1a12018-03-14 10:35:44 -05001142 ${data}= Create Dictionary
1143 ... data=xyz.openbmc_project.State.Watchdog.Action.PowerCycle
1144 ${status} ${result}= Run Keyword And Ignore Error
1145 ... Read Attribute ${HOST_WATCHDOG_URI} ExpireAction
1146 Run Keyword If '${status}' == 'PASS'
1147 ... Write Attribute ${HOST_WATCHDOG_URI} ExpireAction data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -05001148
1149 ${data}= Create Dictionary data=${milliseconds}
Michael Walsh4ffd1a12018-03-14 10:35:44 -05001150 Write Attribute ${HOST_WATCHDOG_URI} Interval data=${data}
1151
1152 ${data}= Create Dictionary data=${True}
1153 Write Attribute ${HOST_WATCHDOG_URI} Enabled data=${data}
George Keishing37cfa6b2017-06-15 10:25:55 -05001154
Rahul Maheshwarie95622c2017-02-24 10:04:29 -06001155 Sleep ${sleep_time}
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001156
Steven Sombar0acb3412018-01-24 09:38:42 -06001157
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001158Login To OS Host
Steven Sombar0acb3412018-01-24 09:38:42 -06001159 [Documentation] Login to OS Host and return the Login response code.
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001160 [Arguments] ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
1161 ... ${os_password}=${OS_PASSWORD}
Steven Sombar0acb3412018-01-24 09:38:42 -06001162
Gunnar Mills28e403b2017-10-25 16:16:38 -05001163 # Description of arguments:
Prashanth Kattiae7c2282017-03-15 07:43:46 -05001164 # ${os_host} IP address of the OS Host.
1165 # ${os_username} OS Host Login user name.
1166 # ${os_password} OS Host Login passwrd.
1167
1168 ${os_state}= Run Keyword And Return Status Ping Host ${os_host}
1169 Run Keyword If '${os_state}' == 'False'
1170 ... Run Keywords Initiate Host Reboot AND
1171 ... Is Host Running AND
1172 ... Wait for OS ${os_host} ${os_username} ${os_password}
1173
George Keishing3f223b82017-06-28 03:50:35 -05001174 SSHLibrary.Open Connection ${os_host}
Sridevi Rameshea36b412017-03-09 04:08:02 -06001175 ${resp}= Login ${os_username} ${os_password}
1176 [Return] ${resp}
Prashanth Katti884ee062017-03-16 05:05:03 -05001177
Steven Sombar0acb3412018-01-24 09:38:42 -06001178
Prashanth Katti884ee062017-03-16 05:05:03 -05001179Configure Initial Settings
1180 [Documentation] Restore old IP and route.
1181 ... This keyword requires initial settings viz IP address,
1182 ... Network Mask, default gatway and serial console IP and port
1183 ... information which should be provided in command line.
1184
Michael Walshb5839d02017-04-12 16:11:20 -05001185 [Arguments] ${host}=${OPENBMC_HOST} ${mask}=${NET_MASK}
1186 ... ${gw_ip}=${GW_IP}
Prashanth Katti884ee062017-03-16 05:05:03 -05001187
Steven Sombar0acb3412018-01-24 09:38:42 -06001188 # Description of arguments:
1189 # host IP address of the OS Host.
1190 # mask Network mask.
1191 # gu_ip Gateway IP address or hostname.
1192
Michael Walshb5839d02017-04-12 16:11:20 -05001193 # Open telnet connection and ignore the error, in case telnet session is
1194 # already opened by the program calling this keyword.
Prashanth Katti884ee062017-03-16 05:05:03 -05001195 Run Keyword And Ignore Error Open Telnet Connection to BMC Serial Console
1196 Telnet.write ifconfig eth0 ${host} netmask ${mask}
1197 Telnet.write route add default gw ${gw_ip}
George Keishingd05b1082017-03-24 05:27:32 -05001198
Steven Sombar0acb3412018-01-24 09:38:42 -06001199
George Keishingd05b1082017-03-24 05:27:32 -05001200Install Debug Tarball On BMC
George Keishing55441822017-05-18 14:17:59 -05001201 [Documentation] Copy the debug tar file to BMC and install.
Steven Sombar0acb3412018-01-24 09:38:42 -06001202 [Arguments] ${tarball_file_path}=${default_tarball}
1203 ... ${targ_tarball_dir_path}=/tmp/tarball/
George Keishingd05b1082017-03-24 05:27:32 -05001204
George Keishing55441822017-05-18 14:17:59 -05001205 # Description of arguments:
1206 # tarball_file_path Path of the debug tarball file.
1207 # The tar file is downloaded from the build page
1208 # https://openpower.xyz/job/openbmc-build/
1209 # obmc-phosphor-debug-tarball-witherspoon.tar.xz
1210 #
1211 # targ_tarball_dir_path The directory path where the tarball is to be
1212 # installed.
1213
1214 OperatingSystem.File Should Exist ${tarball_file_path}
1215 ... msg=${tarball_file_path} doesn't exist.
1216
1217 # Upload the file to BMC.
George Keishingd05b1082017-03-24 05:27:32 -05001218 Import Library SCPLibrary WITH NAME scp
1219 Open Connection for SCP
George Keishing55441822017-05-18 14:17:59 -05001220 scp.Put File ${tarball_file_path} /tmp/debug-tarball.tar.xz
1221
1222 # Create tarball directory and install.
George Keishing95c371a2017-09-14 15:42:33 -05001223 BMC Execute Command mkdir -p ${targ_tarball_dir_path}
1224 BMC Execute Command
George Keishing55441822017-05-18 14:17:59 -05001225 ... tar -xf /tmp/debug-tarball.tar.xz -C ${targ_tarball_dir_path}
1226
George Keishing95c371a2017-09-14 15:42:33 -05001227 # Remove the tarball file from BMC.
1228 BMC Execute Command rm -f /tmp/debug-tarball.tar.xz
George Keishingd05b1082017-03-24 05:27:32 -05001229
George Keishing55441822017-05-18 14:17:59 -05001230
Sweta Potthuri025e0122017-02-21 00:42:48 -06001231Get BMC Boot Count
Steven Sombar0acb3412018-01-24 09:38:42 -06001232 [Documentation] Returns BMC boot count based on boot time.
Sweta Potthuri025e0122017-02-21 00:42:48 -06001233 ${cur_btime}= Get BMC Boot Time
1234
1235 # Set global variable BOOT_TIME to current boot time if current boot time
1236 # is changed. Also increase value of global variable BOOT_COUNT by 1.
1237 Run Keyword If ${cur_btime} > ${BOOT_TIME}
1238 ... Run Keywords Set Global Variable ${BOOT_TIME} ${cur_btime}
1239 ... AND
1240 ... Set Global Variable ${BOOT_COUNT} ${BOOT_COUNT + 1}
Steven Sombar0acb3412018-01-24 09:38:42 -06001241
Sweta Potthuri025e0122017-02-21 00:42:48 -06001242 [Return] ${BOOT_COUNT}
1243
Steven Sombar0acb3412018-01-24 09:38:42 -06001244
Sweta Potthuri025e0122017-02-21 00:42:48 -06001245Set BMC Boot Count
1246 [Documentation] Set BMC boot count to given value.
1247 [Arguments] ${count}
1248
1249 # Description of arguments:
1250 # count boot count value.
1251 ${cur_btime}= Get BMC Boot Time
1252
1253 # Set global variable BOOT_COUNT to given value.
1254 Set Global Variable ${BOOT_COUNT} ${count}
1255
1256 # Set BOOT_TIME variable to current boot time.
1257 Set Global Variable ${BOOT_COUNT} ${count}
Michael Walsh689fbbe2017-04-04 17:58:03 -05001258
Steven Sombar0acb3412018-01-24 09:38:42 -06001259
Sweta Potthurie5a9fc72017-05-03 07:02:46 -05001260Get System LED State
1261 [Documentation] Return the state of given system LED.
1262 [Arguments] ${led_name}
1263
1264 # Description of argument(s):
1265 # led_name System LED name (e.g. heartbeat, identify, beep).
1266
1267 ${state}= Read Attribute ${LED_PHYSICAL_URI}${led_name} State
1268 [Return] ${state.rsplit('.', 1)[1]}
1269
George Keishing3987a1e2017-09-20 09:13:02 -05001270
Steven Sombar5f3af442018-02-14 08:30:15 -06001271Set System LED State
1272 [Documentation] Set given system LED via REST.
1273 [Arguments] ${led_name} ${led_state}
1274 # Description of argument(s):
1275 # led_name System LED name (e.g. heartbeat, identify, beep).
1276 # led_state LED state to be set (e.g. On, Off).
1277
1278 ${args}= Create Dictionary
1279 ... data=xyz.openbmc_project.Led.Physical.Action.${led_state}
1280 Write Attribute ${LED_PHYSICAL_URI}${led_name} State data=${args}
1281
1282 Verify LED State ${led_name} ${led_state}
1283
1284
1285Verify LED State
1286 [Documentation] Checks if LED is in given state.
1287 [Arguments] ${led_name} ${led_state}
1288 # Description of argument(s):
1289 # led_name System LED name (e.g. heartbeat, identify, beep).
1290 # led_state LED state to be verified (e.g. On, Off).
1291
1292 ${state}= Get System LED State ${led_name}
1293 Should Be Equal ${state} ${led_state}
1294
1295
Steven Sombarb89d5802018-02-15 14:48:49 -06001296Get LED State XYZ
1297 [Documentation] Returns state of given LED.
1298 [Arguments] ${led_name}
1299
1300 # Description of argument(s):
1301 # led_name Name of LED.
1302
1303 ${state}= Read Attribute ${LED_GROUPS_URI}${led_name} Asserted
1304 # Returns the state of the LED, either On or Off.
1305 [Return] ${state}
1306
1307
George Keishingd2d90af2017-06-27 08:17:34 -05001308Delete Error Logs
Michael Walsh689fbbe2017-04-04 17:58:03 -05001309 [Documentation] Delete error logs.
1310
George Keishingd2d90af2017-06-27 08:17:34 -05001311 # Check if error logs entries exist, if not return.
George Keishing335f5362017-06-30 15:11:20 -05001312 ${resp}= OpenBMC Get Request ${BMC_LOGGING_ENTRY}${/}list quiet=${1}
George Keishingd2d90af2017-06-27 08:17:34 -05001313 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND}
1314
1315 # Get the list of error logs entries and delete them all.
George Keishing335f5362017-06-30 15:11:20 -05001316 ${elog_entries}= Get URL List ${BMC_LOGGING_ENTRY}
George Keishingd2d90af2017-06-27 08:17:34 -05001317 :FOR ${entry} IN @{elog_entries}
1318 \ Delete Error Log Entry ${entry}
George Keishingdb34c2f2017-04-18 13:20:25 -05001319
George Keishing3987a1e2017-09-20 09:13:02 -05001320
George Keishingd2d90af2017-06-27 08:17:34 -05001321Delete Error Log Entry
George Keishingdb34c2f2017-04-18 13:20:25 -05001322 [Documentation] Delete error log entry.
1323 [Arguments] ${entry_path}
1324
1325 # Description of argument(s):
1326 # entry_path Delete an error log entry.
1327 # Ex. /xyz/openbmc_project/logging/entry/1
1328
George Keishing6a8ed0f2017-07-11 22:54:42 -05001329 # Skip delete if entry URI is a callout.
1330 # Example: /xyz/openbmc_project/logging/entry/1/callout
1331 Return From Keyword If '${entry_path.rsplit('/', 1)[1]}' == 'callout'
1332
George Keishingdb34c2f2017-04-18 13:20:25 -05001333 ${data}= Create Dictionary data=@{EMPTY}
1334 ${resp}= Openbmc Delete Request ${entry_path} data=${data}
1335 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Rahul Maheshwari43be6932017-05-01 02:37:06 -05001336
1337
George Keishingcc71c3c2017-09-20 09:38:03 -05001338Delete All Error Logs
George Keishing3987a1e2017-09-20 09:13:02 -05001339 [Documentation] Delete all error log entries using "DeleteAll" interface.
1340
1341 ${data}= Create Dictionary data=@{EMPTY}
1342 ${resp}= Openbmc Post Request ${BMC_LOGGING_URI}action/DeleteAll
1343 ... data=${data}
1344 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
1345
1346
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001347Get BMC Version
1348 [Documentation] Returns BMC version from /etc/os-release.
1349 ... e.g. "v1.99.6-141-ge662190"
1350
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001351 ${cmd}= Set Variable grep ^VERSION_ID= /etc/os-release | cut -f 2 -d '='
Joy Onyerikwu9b668972018-05-22 19:10:43 -05001352 ${output} ${stderr} ${rc}= BMC Execute Command ${cmd}
Rahul Maheshwari13256d92017-06-15 10:05:40 -05001353 [Return] ${output}
1354
George Keishingad5817a2017-06-28 10:19:03 -05001355
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -05001356Get PNOR Version
Steven Sombar0acb3412018-01-24 09:38:42 -06001357 [Documentation] Returns the PNOR version from the BMC.
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -05001358
1359 ${pnor_attrs}= Get PNOR Attributes
1360 [Return] ${pnor_attrs['version']}
1361
1362
1363Get PNOR Attributes
1364 [Documentation] Return PNOR software attributes as a dictionary.
1365
Michael Walsh98d8c9e2017-10-04 12:24:29 -05001366 # This keyword parses /var/lib/phosphor-software-manager/pnor/ro/pnor.toc
1367 # into key/value pairs.
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -05001368
1369 ${outbuf} ${stderr} ${rc}= BMC Execute Command
1370 ... cat /var/lib/phosphor-software-manager/pnor/ro/pnor.toc
1371 ${pnor_attrs}= Key Value Outbuf To Dict ${outbuf} delim==
1372
1373 [Return] ${pnor_attrs}
1374
1375
George Keishingad5817a2017-06-28 10:19:03 -05001376Get Elog URL List
1377 [Documentation] Return error log entry list of URLs.
1378
1379 ${url_list}= Read Properties /xyz/openbmc_project/logging/entry/
1380 Sort List ${url_list}
1381 [Return] ${url_list}
1382
1383
Steven Sombaraaf72c42017-09-05 12:02:00 -05001384Read Turbo Setting Via REST
1385 [Documentation] Return turbo setting via REST.
Steven Sombarea79a492018-04-18 11:14:57 -05001386 # Returns 1 if TurboAllowed, 0 if not.
Steven Sombaraaf72c42017-09-05 12:02:00 -05001387
Steven Sombarea79a492018-04-18 11:14:57 -05001388 ${turbo_setting}= Read Attribute
1389 ... ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
1390 [Return] ${turbo_setting}
1391
Steven Sombaraaf72c42017-09-05 12:02:00 -05001392
Steven Sombaraaf72c42017-09-05 12:02:00 -05001393Set Turbo Setting Via REST
1394 [Documentation] Set turbo setting via REST.
Steven Sombar80bc8592018-04-24 11:44:53 -05001395 [Arguments] ${setting} ${verify}=${False}
Steven Sombar0acb3412018-01-24 09:38:42 -06001396
Steven Sombaraaf72c42017-09-05 12:02:00 -05001397 # Description of argument(s):
Steven Sombar80bc8592018-04-24 11:44:53 -05001398 # setting State to set TurboAllowed, 1=allowed, 0=not allowed.
1399 # verify If True, read the TurboAllowed setting to confirm.
Steven Sombaraaf72c42017-09-05 12:02:00 -05001400
Steven Sombarea79a492018-04-18 11:14:57 -05001401 ${data}= Create Dictionary data=${${setting}}
Steven Sombar80bc8592018-04-24 11:44:53 -05001402 Write Attribute ${CONTROL_HOST_URI}turbo_allowed TurboAllowed
1403 ... verify=${verify} data=${data}
George Keishingef74a8c2017-10-20 10:23:52 -05001404
Steven Sombar0acb3412018-01-24 09:38:42 -06001405
George Keishingef74a8c2017-10-20 10:23:52 -05001406Set Control Boot Mode
1407 [Documentation] Set given boot mode on the boot object path attribute.
1408 [Arguments] ${boot_path} ${boot_mode}
1409
1410 # Description of argument(s):
1411 # boot_path Boot object path.
1412 # Example:
1413 # /xyz/openbmc_project/control/host0/boot
1414 # /xyz/openbmc_project/control/host0/boot/one_time
1415 # boot_mode Boot mode which need to be set.
1416 # Example:
1417 # "xyz.openbmc_project.Control.Boot.Mode.Modes.Regular"
1418
1419 ${valueDict}= Create Dictionary data=${boot_mode}
1420 Write Attribute ${boot_path} BootMode data=${valueDict}
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -05001421
Steven Sombar0acb3412018-01-24 09:38:42 -06001422
Sridevi Ramesh0d88ab32017-09-21 11:07:28 -05001423Copy Address Translation Utils To HOST OS
1424 [Documentation] Copy address translation utils to host OS.
1425
1426 OperatingSystem.File Should Exist ${probe_cpu_tool_path}
1427 ... msg=${probe_cpu_tool_path} doesn't exist.
1428 OperatingSystem.File Should Exist ${probe_cpu_tool_path}
1429 ... msg=${probe_cpu_tool_path} doesn't exist.
1430
1431 scp.Open connection ${OS_HOST} username=${OS_USERNAME}
1432 ... password=${OS_PASSWORD}
1433 scp.Put File ${probe_cpu_tool_path} ${target_file_path}
1434 scp.Put File ${scom_addrs_tool_path} ${target_file_path}
George Keishing034902d2017-11-10 13:15:38 -06001435
1436
1437Verify BMC RTC And UTC Time Drift
1438 [Documentation] Verify that the RTC and UTC time difference is less than
1439 ... the given time_drift_max.
1440 [Arguments] ${time_diff_max}=${10}
1441
1442 # Description of argument(s):
1443 # time_diff_max The max allowable RTC and UTC time difference in seconds.
1444
1445 # Example:
1446 # time_dict:
1447 # [local_time]: Fri 2017-11-03 152756 UTC
1448 # [local_time_seconds]: 1509740876
1449 # [universal_time]: Fri 2017-11-03 152756 UTC
1450 # [universal_time_seconds]: 1509740876
1451 # [rtc_time]: Fri 2016-05-20 163403
1452 # [rtc_time_seconds]: 1463780043
1453 # [time_zone]: n/a (UTC, +0000)
1454 # [network_time_on]: yes
1455 # [ntp_synchronized]: no
1456 # [rtc_in_local_tz]: no
1457
Steven Sombar0acb3412018-01-24 09:38:42 -06001458 ${time}= Get BMC Date Time
George Keishing034902d2017-11-10 13:15:38 -06001459 ${time_diff}= Evaluate
Steven Sombar0acb3412018-01-24 09:38:42 -06001460 ... ${time['universal_time_seconds']} - ${time['rtc_time_seconds']}
George Keishing034902d2017-11-10 13:15:38 -06001461 Should Be True ${time_diff} < ${time_diff_max}
Sweta Potthuri7d3af3c2018-01-29 03:07:07 -06001462
Sweta Potthurif39022d2018-02-06 03:40:07 -06001463
Sweta Potthuri7d3af3c2018-01-29 03:07:07 -06001464Watchdog Object Should Exist
1465 [Documentation] Check that watchdog object exists.
1466
1467 ${resp}= OpenBMC Get Request ${WATCHDOG_URI}host0
1468 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
1469 ... msg=Expected watchdog object does not exist.
Sweta Potthurif39022d2018-02-06 03:40:07 -06001470
1471
1472Validate IP On BMC
1473 [Documentation] Validate IP address is present in set of IP addresses.
1474 [Arguments] ${ip_address} ${ip_data}
1475
1476 # Description of argument(s):
1477 # ip_address IP address to check (e.g. xx.xx.xx.xx).
1478 # ip_data Set of the IP addresses present.
1479
1480 Should Contain Match ${ip_data} ${ip_address}/*
1481 ... msg=${ip_address} not found in the list provided.
George Keishingb9f407b2018-02-20 00:07:46 -06001482
1483
1484Remove Journald Logs
1485 [Documentation] Remove all journald logs and restart service.
1486
1487 ${cmd}= Catenate systemctl stop systemd-journald.service &&
1488 ... rm -rf /var/log/journal && systemctl start systemd-journald.service
1489
1490 BMC Execute Command ${cmd}
1491
George Keishing78ce8dc2018-03-30 11:49:06 -05001492
1493Verify Identify LED State
1494 [Documentation] Verify the identify LED state
1495 ... matches caller's expectations.
1496 [Arguments] ${expected_state}
1497
1498 # Description of argument(s):
1499 # expected_state The LED state expected by the caller ("Blink" or "Off").
1500
1501 ${resp}= Read Attribute ${LED_PHYSICAL_URI}/front_id State
1502 Should Be Equal ${resp}
1503 ... xyz.openbmc_project.Led.Physical.Action.${expected_state}
1504 ... msg=Unexpected LED state.
1505
1506 ${resp}= Read Attribute ${LED_PHYSICAL_URI}/rear_id State
1507 Should Be Equal ${resp}
1508 ... xyz.openbmc_project.Led.Physical.Action.${expected_state}
1509 ... msg=Unexpected LED state.
1510
Sweta Potthuri39255032018-03-28 10:12:14 -05001511
1512Verify The Attribute
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -05001513 [Documentation] Verify the given attribute.
Sweta Potthuri39255032018-03-28 10:12:14 -05001514 [Arguments] ${uri} ${attribute_name} ${attribute_value}
1515
1516 # Description of argument(s):
1517 # uri URI path
1518 # (e.g. "/xyz/openbmc_project/control/host0/TPMEnable").
1519 # attribute_name Name of attribute to be verified (e.g. "TPMEnable").
1520 # attribute_value The expected value of attribute (e.g. "1", "0", etc.)
1521
1522 ${output}= Read Attribute ${uri} ${attribute_name}
1523 Should Be Equal ${attribute_value} ${output}
1524 ... msg=Attribute "${attribute_name} does not have the expected value.
George Keishingcf0d7772018-05-04 08:22:50 -05001525
1526
1527Get BMC Flash Chip Boot Side
1528 [Documentation] Return the BMC flash chip boot side.
1529
1530 # Example:
George Keishinge3d3abc2018-06-25 09:08:19 -05001531 # 0 - indicates chip select is current side.
1532 # 32 - indicates chip select is alternate side.
George Keishingcf0d7772018-05-04 08:22:50 -05001533
1534 ${boot_side} ${stderr} ${rc}= BMC Execute Command
George Keishinge3d3abc2018-06-25 09:08:19 -05001535 ... cat /sys/class/watchdog/watchdog1/bootstatus
George Keishingcf0d7772018-05-04 08:22:50 -05001536
1537 [Return] ${boot_side}
1538
George Keishingc5fef582018-07-18 08:41:28 -05001539
1540Check For Regex In Journald
1541 [Documentation] Parse the journal log and check for regex string.
George Keishingb4adfc72018-10-26 09:39:32 -05001542 [Arguments] ${regex}=${ERROR_REGEX} ${error_check}=${0} ${boot}=${EMPTY}
1543
1544 # Description of argument(s):
1545 # regex Strings to be filter.
1546 # error_check Check for errors.
1547 # boot Argument to check current or persistent full boot log
1548 # (e.g. "-b").
George Keishingc5fef582018-07-18 08:41:28 -05001549
1550 ${journal_log} ${stderr} ${rc}= BMC Execute Command
George Keishingb4adfc72018-10-26 09:39:32 -05001551 ... journalctl --no-pager ${boot} | egrep '${regex}' ignore_err=1
George Keishingc5fef582018-07-18 08:41:28 -05001552
1553 Run Keyword If ${error_check} == ${0}
1554 ... Should Be Empty ${journal_log}
1555 ... ELSE
1556 ... Should Not Be Empty ${journal_log}
George Keishing216e5842018-08-31 14:58:15 -05001557
1558
1559Get Service Attribute
1560 [Documentation] Get service attribute policy output.
1561 [Arguments] ${option} ${servicename}
George Keishing3c004dc2018-10-10 07:16:47 -05001562
1563 # Description of argument(s):
George Keishingb53a37e2018-10-26 11:59:34 -05001564 # option systemctl supported options
George Keishing216e5842018-08-31 14:58:15 -05001565 # servicename Qualified service name
1566 ${cmd}= Set Variable
1567 ... systemctl -p ${option} show ${servicename} | cut -d = -f2
1568 ${attr} ${stderr} ${rc}= BMC Execute Command ${cmd}
1569 [Return] ${attr}
George Keishing3c004dc2018-10-10 07:16:47 -05001570
1571
1572Set REST Logging Policy
1573 [Documentation] Enable or disable REST logging setting.
1574 [Arguments] ${policy_setting}=${True}
1575
1576 # Description of argument(s):
1577 # policy_setting The policy setting value which can be either True or False.
1578
1579 ${log_dict}= Create Dictionary data=${policy_setting}
1580 Write Attribute ${BMC_LOGGING_URI}${/}rest_api_logs Enabled
1581 ... data=${log_dict} verify=${1} expected_value=${policy_setting}
1582