blob: 2dcf39ab0c07ddaf8b3adff3bfd7a60f33a224a3 [file] [log] [blame]
George Keishingb88df3d2017-01-10 07:28:08 -06001*** Settings ***
George Keishingbec365b2017-01-19 01:28:41 -06002Resource ../lib/utils.robot
3Variables ../data/variables.py
George Keishingb88df3d2017-01-10 07:28:08 -06004
5*** Variables ***
6
Rahul Maheshwari2f8de6c2017-01-17 07:00:22 -06007${BMC_READY_STATE} Ready
8${BMC_NOT_READY_STATE} NotReady
George Keishingb88df3d2017-01-10 07:28:08 -06009${QUIET} ${0}
10
Michael Walshb2869542017-04-12 15:41:02 -050011# "1" indicates that the new "xyz" interface should be used.
12${OBMC_STATES_VERSION} ${1}
George Keishing43a021f2017-01-30 11:10:13 -060013
George Keishingb88df3d2017-01-10 07:28:08 -060014*** Keywords ***
15
16Initiate Host Boot
17 [Documentation] Initiate host power on.
Michael Walsh67ef6222017-03-21 14:48:26 -050018 [Arguments] ${wait}=${1}
19
George Keishingb2a8dea2018-07-20 10:25:51 -050020 # Description of argument(s):
Michael Walsh67ef6222017-03-21 14:48:26 -050021 # wait Indicates that this keyword should wait for host running state.
22
George Keishingb88df3d2017-01-10 07:28:08 -060023 ${args}= Create Dictionary data=${HOST_POWERON_TRANS}
24 Write Attribute
25 ... ${HOST_STATE_URI} RequestedHostTransition data=${args}
26
Michael Walsh67ef6222017-03-21 14:48:26 -050027 # Does caller want to wait for status?
28 Run Keyword If '${wait}' == '${0}' Return From Keyword
29
George Keishingb88df3d2017-01-10 07:28:08 -060030 Wait Until Keyword Succeeds
31 ... 10 min 10 sec Is Host Running
32
33
34Initiate Host PowerOff
35 [Documentation] Initiate host power off.
George Keishingfbea6042017-08-01 06:31:51 -050036 # 1. Request soft power off
37 # 2. Hard power off, if failed.
Michael Walsh67ef6222017-03-21 14:48:26 -050038 [Arguments] ${wait}=${1}
39
George Keishingb2a8dea2018-07-20 10:25:51 -050040 # Description of argument(s):
Michael Walsh67ef6222017-03-21 14:48:26 -050041 # wait Indicates that this keyword should wait for host off state.
42
George Keishingb88df3d2017-01-10 07:28:08 -060043 ${args}= Create Dictionary data=${HOST_POWEROFF_TRANS}
44 Write Attribute
45 ... ${HOST_STATE_URI} RequestedHostTransition data=${args}
46
Michael Walsh67ef6222017-03-21 14:48:26 -050047 # Does caller want to wait for status?
48 Run Keyword If '${wait}' == '${0}' Return From Keyword
49
George Keishingfbea6042017-08-01 06:31:51 -050050 ${status}= Run Keyword And Return Status Wait For PowerOff
51
52 Run Keyword if '${status}' == '${False}' Hard Power Off
53
54
55Wait For PowerOff
56 [Documentation] Wait for power off state.
57
George Keishing2c54e692017-07-10 13:07:02 -050058 # TODO: Reference to open-power/skiboot#81.
59 # Revert to 3 minutes once fixed.
George Keishingfbea6042017-08-01 06:31:51 -050060 Wait Until Keyword Succeeds 6 min 10 sec Is Host Off
61
62
63Hard Power Off
64 [Documentation] Do a hard power off.
Michael Walsh245db7c2017-09-05 15:45:03 -050065 [Arguments] ${wait}=${1}
66
67 # Description of argument(s):
68 # wait Indicates that this keyword should wait for host off state.
George Keishingfbea6042017-08-01 06:31:51 -050069
70 ${args}= Create Dictionary data=${CHASSIS_POWEROFF_TRANS}
71 Write Attribute
72 ... ${CHASSIS_STATE_URI} RequestedPowerTransition data=${args}
73
Michael Walsh245db7c2017-09-05 15:45:03 -050074 # Does caller want to wait for status?
75 Run Keyword If '${wait}' == '${0}' Return From Keyword
76
George Keishingb88df3d2017-01-10 07:28:08 -060077 Wait Until Keyword Succeeds
George Keishingfbea6042017-08-01 06:31:51 -050078 ... 1 min 10 sec Run Keywords Is Chassis Off AND Is Host Off
George Keishingb88df3d2017-01-10 07:28:08 -060079
80
Rahul Maheshwarif7ead242017-02-14 01:59:42 -060081Initiate Host Reboot
82 [Documentation] Initiate host reboot via REST.
George Keishingb2a8dea2018-07-20 10:25:51 -050083 [Arguments] ${wait}=${1}
84
85 # Description of argument(s):
86 # wait Indicates that this keyword should wait for host reboot state.
Rahul Maheshwarif7ead242017-02-14 01:59:42 -060087
88 ${args}= Create Dictionary data=${HOST_REBOOT_TRANS}
89 Write Attribute
90 ... ${HOST_STATE_URI} RequestedHostTransition data=${args}
George Keishingb2a8dea2018-07-20 10:25:51 -050091
92 # Does caller want to wait for host booted status?
93 Run Keyword If '${wait}' == '${0}' Return From Keyword
94
Rahul Maheshwarif7ead242017-02-14 01:59:42 -060095 Is Host Rebooted
96
97
George Keishingb88df3d2017-01-10 07:28:08 -060098Is Host Running
Rahul Maheshwarif7ead242017-02-14 01:59:42 -060099 [Documentation] Check if host state is "Running".
George Keishing13cc2102017-07-25 07:48:58 -0500100 # Chassis state should be "On" before we check the host state.
101 Is Chassis On
George Keishingb88df3d2017-01-10 07:28:08 -0600102 ${host_state}= Get Host State
George Keishing59d6cb42017-01-19 08:26:03 -0600103 Should Be Equal Running ${host_state}
George Keishing13cc2102017-07-25 07:48:58 -0500104 # Check to verify that the host is really booted.
George Keishing2bd6fc02017-08-10 01:15:16 -0500105 Is OS Booted
106
107
108Get Host State Attribute
109 [Documentation] Return the state of the host as a string.
110 [Arguments] ${host_attribute} ${quiet}=${QUIET}
111
112 # Description of argument(s):
113 # host_attribute Host attribute name.
114 # quiet Suppress REST output logging to console.
115
Tim Lee29e073a2022-04-12 12:07:17 +0800116 ${HOST_STATE_URI}= Set Variable If '${PLATFORM_ARCH_TYPE}' == 'x86' and '${host_attribute}' == 'OperatingSystemState'
117 ... ${OS_STATE_URI} ${HOST_STATE_URI}
118
George Keishing2bd6fc02017-08-10 01:15:16 -0500119 ${state}=
120 ... Read Attribute ${HOST_STATE_URI} ${host_attribute} quiet=${quiet}
George Keishing409df052024-01-17 22:36:14 +0530121 RETURN ${state}
George Keishing2bd6fc02017-08-10 01:15:16 -0500122
123
124Is OS Booted
125 [Documentation] Check OS status.
126
127 # Example:
128 # "/xyz/openbmc_project/state/host0": {
129 # "AttemptsLeft": 0,
130 # "BootProgress": "xyz.openbmc_project.State.Boot.Progress.ProgressStages.OSStart",
131 # "CurrentHostState": "xyz.openbmc_project.State.Host.HostState.Running",
132 # "OperatingSystemState": "xyz.openbmc_project.State.OperatingSystem.Status.OSStatus.BootComplete",
133 # "RequestedHostTransition": "xyz.openbmc_project.State.Host.Transition.On"
134 # }
135
George Keishing2bd6fc02017-08-10 01:15:16 -0500136 ${boot_stage}= Get Host State Attribute BootProgress
137 Should Be Equal ${OS_BOOT_START} ${boot_stage}
138
139 ${os_state}= Get Host State Attribute OperatingSystemState
140 Should Be Equal ${OS_BOOT_COMPLETE} ${os_state}
George Keishingb88df3d2017-01-10 07:28:08 -0600141
142
143Is Host Off
Rahul Maheshwarif7ead242017-02-14 01:59:42 -0600144 [Documentation] Check if host state is "Off".
George Keishing13cc2102017-07-25 07:48:58 -0500145 # Chassis state should be "Off" before we check the host state.
146 Is Chassis Off
George Keishingb88df3d2017-01-10 07:28:08 -0600147 ${host_state}= Get Host State
George Keishing59d6cb42017-01-19 08:26:03 -0600148 Should Be Equal Off ${host_state}
George Keishing13cc2102017-07-25 07:48:58 -0500149 # Check to verify that the host shutdown completely.
Andrew Geissler854e9fe2017-07-29 09:51:13 -0500150 # TODO openbmc/openbmc#2049 - boot sensor not cleared on power off
151 #Is OS Off
George Keishingb88df3d2017-01-10 07:28:08 -0600152
Rahul Maheshwarif7ead242017-02-14 01:59:42 -0600153
154Is Host Rebooted
155 [Documentation] Checks if host rebooted.
156
157 ${host_trans_state}= Get Host Trans State
158 Should Be Equal ${host_trans_state} Reboot
159 Is Host Running
160
161
162Is Chassis On
163 [Documentation] Check if chassis state is "On".
164 ${power_state}= Get Chassis Power State
165 Should Be Equal On ${power_state}
166
167
168Is Chassis Off
169 [Documentation] Check if chassis state is "Off".
170 ${power_state}= Get Chassis Power State
171 Should Be Equal Off ${power_state}
172
Rahul Maheshwarid01596e2017-02-20 00:04:42 -0600173Is Host Quiesced
174 [Documentation] Check if host state is quiesced.
175 ${host_state}= Get Host State
Rahul Maheshwarid01596e2017-02-20 00:04:42 -0600176 ${status}= Run Keyword And Return Status Should Be Equal
177 ... ${host_state} Quiesced
George Keishing409df052024-01-17 22:36:14 +0530178 RETURN ${status}
Rahul Maheshwarid01596e2017-02-20 00:04:42 -0600179
George Keishingb88df3d2017-01-10 07:28:08 -0600180
Rahul Maheshwari09439a22017-02-23 01:10:05 -0600181Recover Quiesced Host
182 [Documentation] Recover host from quisced state.
183
184 ${resp}= Run Keyword And Return Status Is Host Quiesced
185 Run Keyword If '${resp}' == 'True'
186 ... Run Keywords Initiate Host PowerOff AND
187 ... Log HOST is recovered from quiesced state
188
189
George Keishingb88df3d2017-01-10 07:28:08 -0600190Get Host State
191 [Documentation] Return the state of the host as a string.
192 [Arguments] ${quiet}=${QUIET}
193 # quiet - Suppress REST output logging to console.
194 ${state}=
195 ... Read Attribute ${HOST_STATE_URI} CurrentHostState
196 ... quiet=${quiet}
George Keishing409df052024-01-17 22:36:14 +0530197 RETURN ${state.rsplit('.', 1)[1]}
George Keishingb88df3d2017-01-10 07:28:08 -0600198
Rahul Maheshwarif7ead242017-02-14 01:59:42 -0600199Get Host Trans State
200 [Documentation] Return the transition state of host as a string.
201 ... e.g. On, Off, Reboot
202 [Arguments] ${quiet}=${QUIET}
203 # Description of arguments:
204 # quiet Suppress REST output logging to console.
205
206 ${state}=
207 ... Read Attribute ${HOST_STATE_URI} RequestedHostTransition
208 ... quiet=${quiet}
George Keishing409df052024-01-17 22:36:14 +0530209 RETURN ${state.rsplit('.', 1)[1]}
George Keishingb88df3d2017-01-10 07:28:08 -0600210
211Get Chassis Power State
212 [Documentation] Return the power state of the Chassis
213 ... as a string.
214 [Arguments] ${quiet}=${QUIET}
215 # quiet - Suppress REST output logging to console.
216 ${state}=
217 ... Read Attribute ${CHASSIS_STATE_URI} CurrentPowerState
218 ... quiet=${quiet}
George Keishing409df052024-01-17 22:36:14 +0530219 RETURN ${state.rsplit('.', 1)[1]}
Rahul Maheshwari2f8de6c2017-01-17 07:00:22 -0600220
221
222Get BMC State
223 [Documentation] Return the state of the BMC.
224 [Arguments] ${quiet}=${QUIET}
225 # quiet - Suppress REST output logging to console.
226 ${state}=
227 ... Read Attribute ${BMC_STATE_URI} CurrentBMCState quiet=${quiet}
George Keishing409df052024-01-17 22:36:14 +0530228 RETURN ${state.rsplit('.', 1)[1]}
Rahul Maheshwari2f8de6c2017-01-17 07:00:22 -0600229
230
231Put BMC State
232 [Documentation] Put BMC in given state.
233 [Arguments] ${expected_state}
234 # expected_state - expected BMC state
235
236 ${bmc_state}= Get BMC State
237 Run Keyword If '${bmc_state}' == '${expected_state}'
George Keishing334df292021-02-08 05:08:47 -0600238 ... Log BMC is already in ${expected_state} state
239 ... ELSE
240 ... OBMC Reboot (off)
Rahul Maheshwari2f8de6c2017-01-17 07:00:22 -0600241
Rahul Maheshwari2f8de6c2017-01-17 07:00:22 -0600242Initiate BMC Reboot
243 [Documentation] Initiate BMC reboot.
Michael Walsh8b388682017-09-08 10:57:45 -0500244 [Arguments] ${wait}=${1}
245
246 # Description of argument(s):
247 # wait Indicates that this keyword should wait for ending state..
248
249 ${args}= Create Dictionary data=${BMC_REBOOT_TRANS}
Rahul Maheshwari55a68e22017-04-20 04:36:21 -0500250
251 Run Keyword And Ignore Error Write Attribute
Michael Walsh8b388682017-09-08 10:57:45 -0500252 ... ${BMC_STATE_URI} RequestedBMCTransition data=${args}
Rahul Maheshwari2f8de6c2017-01-17 07:00:22 -0600253
Michael Walsh8b388682017-09-08 10:57:45 -0500254 # Does caller want to wait for status?
255 Run Keyword If '${wait}' == '${0}' Return From Keyword
256
257 ${session_active}= Check If BMC Reboot Is Initiated
258 Run Keyword If '${session_active}' == '${True}'
259 ... Fail msg=BMC Reboot didn't occur.
Rahul Maheshwari2f8de6c2017-01-17 07:00:22 -0600260
261 Check If BMC is Up
262
263Check If BMC Reboot Is Initiated
264 [Documentation] Checks whether BMC Reboot is initiated by checking
265 ... BMC connection loss.
266 # Reboot adds 3 seconds delay before forcing reboot
267 # To minimize race conditions, we wait for 7 seconds
268 Sleep 7s
269 ${alive}= Run Keyword and Return Status
270 ... Open Connection And Log In
271 Return From Keyword If '${alive}' == '${False}' ${False}
George Keishing409df052024-01-17 22:36:14 +0530272 RETURN ${True}
Rahul Maheshwari2f8de6c2017-01-17 07:00:22 -0600273
274Is BMC Ready
275 [Documentation] Check if BMC state is Ready.
276 ${bmc_state}= Get BMC State
277 Should Be Equal ${BMC_READY_STATE} ${bmc_state}
278
279Is BMC Not Ready
280 [Documentation] Check if BMC state is Not Ready.
281 ${bmc_state}= Get BMC State
282 Should Be Equal ${BMC_NOT_READY_STATE} ${bmc_state}
283
284Wait for BMC state
285 [Documentation] Wait until given BMC state is reached.
286 [Arguments] ${state}
287 # state - BMC state to wait for
288 Run Keyword If '${state}' == '${BMC_READY_STATE}'
289 ... Wait Until Keyword Succeeds
290 ... 10 min 10 sec Is BMC Ready
291 ... ELSE IF '${state}' == '${BMC_NOT_READY_STATE}'
292 ... Wait Until Keyword Succeeds
293 ... 10 min 10 sec Is BMC Not Ready
294 ... ELSE Fail msg=Invalid BMC state
George Keishing43a021f2017-01-30 11:10:13 -0600295
296
297Set State Interface Version
298 [Documentation] Set version to indicate which interface to use.
Rahul Maheshwari073f8ad2017-03-02 00:55:22 -0600299 ${resp}= Openbmc Get Request ${CHASSIS_STATE_URI}
George Keishing43a021f2017-01-30 11:10:13 -0600300 ${status}= Run Keyword And Return Status
301 ... Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
302 Run Keyword If '${status}' == '${True}'
303 ... Set Global Variable ${OBMC_STATES_VERSION} ${1}
304 ... ELSE
305 ... Set Global Variable ${OBMC_STATES_VERSION} ${0}
306
307
308Power Off Request
309 [Documentation] Select appropriate poweroff keyword.
Rahul Maheshwari073f8ad2017-03-02 00:55:22 -0600310 Run Keyword If '${OBMC_STATES_VERSION}' == '${0}'
George Keishing43a021f2017-01-30 11:10:13 -0600311 ... Initiate Power Off
312 ... ELSE
313 ... Initiate Host PowerOff
314
315
316Wait For BMC Ready
317 [Documentation] Check BMC state and wait for BMC Ready.
George Keishingb2a8dea2018-07-20 10:25:51 -0500318 Wait Until Keyword Succeeds 10 min 10 sec Is BMC Ready
chithraga6be41e2022-03-01 13:20:23 +0000319
320
321Get Host State Via Redfish
322 [Documentation] Return the state of the host Via Redfish as a string.
323
324 ${powerstate}=
325 ... Redfish.Get Attribute ${REDFISH_CHASSIS_URI}/${CHASSIS_ID} PowerState
326
George Keishing409df052024-01-17 22:36:14 +0530327 RETURN ${powerstate}