blob: 187d462c91f3c3912e3f9e0743a2ead540c39779 [file] [log] [blame]
Sushil Singh87dcee12019-08-07 13:13:13 -05001*** Settings ***
2Documentation Update the BMC code on a target BMC via Redifsh.
3
4# Test Parameters:
5# IMAGE_FILE_PATH The path to the BMC image file.
6#
7# Firmware update states:
8# Enabled Image is installed and either functional or active.
9# Disabled Image installation failed or ready for activation.
10# Updating Image installation currently in progress.
11
12Resource ../../lib/resource.robot
13Resource ../../lib/bmc_redfish_resource.robot
14Resource ../../lib/openbmc_ffdc.robot
15Resource ../../lib/common_utils.robot
16Resource ../../lib/code_update_utils.robot
17Resource ../../lib/redfish_code_update_utils.robot
Sushil Singh6624ce52020-01-22 00:53:41 -060018Resource ../../lib/utils.robot
Sushil Singh87dcee12019-08-07 13:13:13 -050019Library ../../lib/gen_robot_valid.py
20Library ../../lib/var_funcs.py
Sushil Singh8f48c8f2020-01-16 04:36:25 -060021Library ../../lib/gen_robot_keyword.py
Sushil Singh8469a482020-07-30 04:19:10 -050022Library ../../lib/code_update_utils.py
Sushil Singh87dcee12019-08-07 13:13:13 -050023
Sushil Singhb2162d82019-09-27 07:22:04 -050024Suite Setup Suite Setup Execution
25Suite Teardown Redfish.Logout
26Test Setup Printn
27Test Teardown FFDC On Test Case Fail
Sushil Singh87dcee12019-08-07 13:13:13 -050028
George Keishing7e854712021-03-17 13:18:10 -050029# Force the test to timedout to prevent test hanging.
George Keishing15d4b202023-11-20 11:35:38 +053030Test Timeout 45 minutes
George Keishing7e854712021-03-17 13:18:10 -050031
George Keishing9899a902023-09-07 20:57:53 +053032Force Tags Bmc_Code_Update
Sushil Singh87dcee12019-08-07 13:13:13 -050033
Sushil Singh65878cb2020-02-27 03:43:44 -060034*** Variables ***
35
George Keishing4d2c0052023-12-04 21:21:12 +053036${FORCE_UPDATE} ${0}
37${LOOP_COUNT} ${2}
38${DELETE_ERRLOGS} ${1}
39# Refer: https://github.com/open-power/guard
40${DELETE_OLD_GUARD_FILE} ${0}
Sushil Singh65878cb2020-02-27 03:43:44 -060041
George Keishing2e078ae2022-02-03 09:13:23 -060042${ACTIVATION_WAIT_TIMEOUT} 8 min
43
George Keishing57ab7cc2023-02-13 01:18:42 -060044# New code update path.
45${REDFISH_UPDATE_URI} /redfish/v1/UpdateService/update
46
Sushil Singh87dcee12019-08-07 13:13:13 -050047*** Test Cases ***
48
49Redfish BMC Code Update
50 [Documentation] Update the firmware image.
51 [Tags] Redfish_BMC_Code_Update
52
George Keishingaa027222021-11-17 06:37:57 -060053 # Python module: get_version_tar(tar_file_path)
54 ${image_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH}
Sushil Singh87dcee12019-08-07 13:13:13 -050055 Rprint Vars image_version
56
George Keishingaa027222021-11-17 06:37:57 -060057 # Python module: get_bmc_release_info()
58 ${bmc_release_info}= utils.Get BMC Release Info
George Keishingfedd5ce2020-07-24 02:25:08 -050059 ${functional_version}= Set Variable ${bmc_release_info['version_id']}
60 Rprint Vars functional_version
61
Sushil Singh76650912020-12-10 23:48:05 -060062 ${post_code_update_actions}= Get Post Boot Action
63 ${state}= Get Pre Reboot State
64 Rprint Vars state
65
George Keishing78903952020-07-24 07:04:53 -050066 # Check if the existing firmware is functional.
67 Pass Execution If '${functional_version}' == '${image_version}'
68 ... The existing ${image_version} firmware is already functional.
69
Sushil Singh76650912020-12-10 23:48:05 -060070 ${sw_inv}= Get Functional Firmware BMC image
71 ${nonfunctional_sw_inv}= Get Non Functional Firmware ${sw_inv} False
72
73 # Redfish active software image API.
Sushil Singhaad1da22021-06-21 04:19:18 -050074 Run Keyword If ${num_records} > 0
75 ... Run Keyword If '${nonfunctional_sw_inv['version']}' == '${image_version}'
76 ... Set Backup Firmware To Functional ${image_version} ${state}
Sushil Singh52859242020-10-09 07:28:22 -050077
Sushil Singhaad1da22021-06-21 04:19:18 -050078 Print Timen Performing firmware update ${image_version}.
Sushil Singh52859242020-10-09 07:28:22 -050079
Sushil Singh87dcee12019-08-07 13:13:13 -050080 Redfish Update Firmware
81
Sushil Singh8469a482020-07-30 04:19:10 -050082
George Keishingb695a902022-05-11 09:26:21 -050083Redfish BMC Code Update Running And Backup Image With Same Firmware
84 [Documentation] Perform the firmware update with same image back to back, so that
85 ... the running (functional Image) and backup image (alternate image)
86 ... with same firmware.
87 [Tags] Redfish_BMC_Code_Update_Running_And_Backup_Image_With_Same_Firmware
88
89 # Python module: get_version_tar(tar_file_path)
90 ${image_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH}
91 Rprint Vars image_version
92
93 # Python module: get_bmc_release_info()
94 ${bmc_release_info}= utils.Get BMC Release Info
95 ${functional_version}= Set Variable ${bmc_release_info['version_id']}
96 Rprint Vars functional_version
97
98 # First update.
99 Print Timen Performing firmware update ${image_version}.
100 Redfish Update Firmware
101
102 # Second update.
103 Print Timen Performing firmware update ${image_version}.
104 Redfish Update Firmware
105
106
Sushil Singh8469a482020-07-30 04:19:10 -0500107Redfish Firmware Update Loop
George Keishing98cf8af2022-07-14 11:13:49 -0500108 [Documentation] Update the same firmware image in loop.
Sushil Singh8469a482020-07-30 04:19:10 -0500109 [Tags] Redfish_Firmware_Update_Loop
110 [Template] Redfish Firmware Update In Loop
George Keishing98cf8af2022-07-14 11:13:49 -0500111 [Timeout] NONE
112 # Override default 30 minutes, Disabling timeout with NONE explicitly
113 # else this test will fail for longer loop runs.
Sushil Singh8469a482020-07-30 04:19:10 -0500114
115 ${LOOP_COUNT}
116
117
Sushil Singh87dcee12019-08-07 13:13:13 -0500118*** Keywords ***
119
120Suite Setup Execution
121 [Documentation] Do the suite setup.
122
123 Redfish.Login
Sushil Singh87dcee12019-08-07 13:13:13 -0500124 # Delete BMC dump and Error logs.
George Keishingc1954452020-10-14 07:44:17 -0500125 Run Keyword And Ignore Error Redfish Delete All BMC Dumps
George Keishingcad841d2022-02-24 01:02:20 -0600126 Run Keyword If ${DELETE_ERRLOGS} == ${1}
127 ... Run Keyword And Ignore Error Redfish Purge Event Log
George Keishing4d2c0052023-12-04 21:21:12 +0530128 # To invalidate all the guard records.
129 Run Keyword If '${DELETE_OLD_GUARD_FILE}' == '${1}'
130 ... BMC Execute Command guard -I
131
Sushil Singh87dcee12019-08-07 13:13:13 -0500132 # Checking for file existence.
133 Valid File Path IMAGE_FILE_PATH
134
George Keishing57ab7cc2023-02-13 01:18:42 -0600135 # Check and set the update path.
136 # Old - /redfish/v1/UpdateService/
137 # New - /redfish/v1/UpdateService/update
138 ${resp}= Redfish.Get /redfish/v1/UpdateService/update
139 ... valid_status_codes=[${HTTP_OK},${HTTP_NOT_FOUND},${HTTP_METHOD_NOT_ALLOWED}]
140
141 # If the method is not found, set update URI to old method.
142 Run Keyword If ${resp.status} == ${HTTP_NOT_FOUND}
143 ... Set Suite Variable ${REDFISH_UPDATE_URI} /redfish/v1/UpdateService
144
145 Log To Console Update URI: ${REDFISH_UPDATE_URI}
146
George Keishing4574ec42021-10-06 11:45:33 -0500147 Redfish Power Off stack_mode=skip
148
Sushil Singh8469a482020-07-30 04:19:10 -0500149
150Redfish Firmware Update In Loop
151 [Documentation] Update the firmware in loop.
152 [Arguments] ${update_loop_count}
153
154 # Description of argument(s):
155 # update_loop_count This value is used to run the firmware update in loop.
156
George Keishing98cf8af2022-07-14 11:13:49 -0500157 # Python module: get_version_tar(tar_file_path)
158 ${image_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH}
159 Rprint Vars image_version
160
161 # Python module: get_bmc_release_info()
162 ${bmc_release_info}= utils.Get BMC Release Info
163 ${functional_version}= Set Variable ${bmc_release_info['version_id']}
164 Print Timen Starting firmware information:
165 Rprint Vars functional_version
166
Sushil Singh53c2dde2020-09-18 05:53:20 -0500167 ${temp_update_loop_count}= Evaluate ${update_loop_count} + 1
Sushil Singh8469a482020-07-30 04:19:10 -0500168
Sushil Singh53c2dde2020-09-18 05:53:20 -0500169 FOR ${count} IN RANGE 1 ${temp_update_loop_count}
George Keishing98cf8af2022-07-14 11:13:49 -0500170 Print Timen **************************************
171 Print Timen * The Current Loop Count is ${count} of ${update_loop_count} *
172 Print Timen **************************************
173 Print Timen Performing firmware update ${image_version}.
174 Redfish Update Firmware
Sushil Singh8469a482020-07-30 04:19:10 -0500175 END
176
Sushil Singh8469a482020-07-30 04:19:10 -0500177
Sushil Singh8469a482020-07-30 04:19:10 -0500178Delete BMC Image
179 [Documentation] Delete a BMC image from the BMC flash chip.
180
181 ${software_object}= Get Non Running BMC Software Object
182 Delete Image And Verify ${software_object} ${VERSION_PURPOSE_BMC}
183
184
Sushil Singh87dcee12019-08-07 13:13:13 -0500185Activate Existing Firmware
George Keishing16b3c7b2021-01-28 09:23:37 -0600186 [Documentation] Set firmware image to lower priority.
Sushil Singh87dcee12019-08-07 13:13:13 -0500187 [Arguments] ${image_version}
188
189 # Description of argument(s):
190 # image_version Version of image.
191
192 ${software_inventory_record}= Get Software Inventory State By Version
193 ... ${image_version}
194 ${num_keys}= Get Length ${software_inventory_record}
195
196 Rprint Vars software_inventory_record
197
198 # If no software inventory record was found, there is no existing
199 # firmware for the given version and therefore no action to be taken.
200 Return From Keyword If not ${num_keys}
201
202 # Check if the existing firmware is functional.
203 Pass Execution If ${software_inventory_record['functional']}
204 ... The existing ${image_version} firmware is already functional.
205
206 # If existing firmware is not functional, then set the priority to least.
207 Print Timen The existing ${image_version} firmware is not yet functional.
208 Set BMC Image Priority To Least ${image_version} ${software_inventory_record}
209
210 Pass Execution The existing ${image_version} firmware is now functional.
211
212
213Get Image Priority
214 [Documentation] Get Current Image Priority.
215 [Arguments] ${image_version}
216
217 # Description of argument(s):
George Keishing16b3c7b2021-01-28 09:23:37 -0600218 # image_version The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95).
Sushil Singh87dcee12019-08-07 13:13:13 -0500219
220 ${software_info}= Read Properties
221 ... ${SOFTWARE_VERSION_URI}/enumerate quiet=1
222 # Get only the record associated with our image_version.
223
224 ${software_info}= Filter Struct
225 ... ${software_info} [('Version', '${image_version}')]
226 # Convert from dict to list.
227 ${software_info}= Get Dictionary Values ${software_info}
228
229 [Return] ${software_info[0]['Priority']}
230
231
232Set BMC Image Priority To Least
233 [Documentation] Set BMC image priority to least value.
234 [Arguments] ${image_version} ${software_inventory}
235
236 # Description of argument(s):
George Keishing16b3c7b2021-01-28 09:23:37 -0600237 # image_version The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95).
Sushil Singh87dcee12019-08-07 13:13:13 -0500238 # software_inventory Software inventory details.
239
240 ${least_priority}= Get Least Value Priority Image ${VERSION_PURPOSE_BMC}
241 ${cur_priority}= Get Image Priority ${image_version}
242 Rprint Vars least_priority cur_priority
243
244 Return From Keyword If '${least_priority}' == ${cur_priority}
245 Set Host Software Property
246 ... ${SOFTWARE_VERSION_URI}${software_inventory['image_id']}
247 ... Priority ${least_priority}
248
Sushil Singh87dcee12019-08-07 13:13:13 -0500249 Redfish OBMC Reboot (off)
Sushil Singh87dcee12019-08-07 13:13:13 -0500250
251
Sushil Singhaad1da22021-06-21 04:19:18 -0500252Set Backup Firmware To Functional
253 [Documentation] Set the backup firmware to functional.
254 [Arguments] ${image_version} ${state}
255
256 # Description of argument(s):
257 # image_version Version of image.
258 # state Pre reboot state.
259
260 Print Timen Switch to back up and rebooting.
261 Switch Backup Firmware Image To Functional
262 Wait For Reboot start_boot_seconds=${state['epoch_seconds']}
263 Redfish Verify BMC Version ${IMAGE_FILE_PATH}
264 Pass Execution The backup firmware image ${image_version} is now functional.
265
266
Sushil Singh87dcee12019-08-07 13:13:13 -0500267Redfish Update Firmware
268 [Documentation] Update the BMC firmware via redfish interface.
269
Sushil Singh6624ce52020-01-22 00:53:41 -0600270 ${post_code_update_actions}= Get Post Boot Action
Sushil Singh87dcee12019-08-07 13:13:13 -0500271 ${state}= Get Pre Reboot State
272 Rprint Vars state
Sushil Singh090eedc2019-11-05 02:04:59 -0600273 Run Keyword And Ignore Error Set ApplyTime policy=OnReset
George Keishing2e078ae2022-02-03 09:13:23 -0600274
275 # Python module: get_member_list(resource_path)
276 ${before_inv_list}= redfish_utils.Get Member List /redfish/v1/UpdateService/FirmwareInventory
277 Log To Console Current images on the BMC before upload: ${before_inv_list}
278
George Keishingb695a902022-05-11 09:26:21 -0500279 Print Timen Start uploading image to BMC.
George Keishing57ab7cc2023-02-13 01:18:42 -0600280 Redfish Upload Image ${REDFISH_UPDATE_URI} ${IMAGE_FILE_PATH}
George Keishingb695a902022-05-11 09:26:21 -0500281 Print Timen Completed image upload to BMC.
George Keishing2e078ae2022-02-03 09:13:23 -0600282
283 # Python module: get_member_list(resource_path)
284 ${after_inv_list}= redfish_utils.Get Member List /redfish/v1/UpdateService/FirmwareInventory
285 Log To Console Current images on the BMC after upload: ${after_inv_list}
286
287 ${image_id}= Evaluate set(${after_inv_list}) - set(${before_inv_list})
288 Should Not Be Empty ${image_id}
289 ${image_id}= Evaluate list(${image_id})[0].split('/')[-1]
290 Log To Console Firmware installation in progress with image id:: ${image_id}
291
292 Wait Until Keyword Succeeds ${ACTIVATION_WAIT_TIMEOUT} 10 sec
293 ... Check Image Update Progress State match_state='Enabled' image_id=${image_id}
294
295 # Python module: get_version_tar(tar_file_path)
296 ${tar_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH}
Sushil Singh8f48c8f2020-01-16 04:36:25 -0600297 ${image_info}= Get Software Inventory State By Version ${tar_version}
George Keishing2e078ae2022-02-03 09:13:23 -0600298
Sushil Singh8f48c8f2020-01-16 04:36:25 -0600299 Run Key ${post_code_update_actions['${image_info["image_type"]}']['OnReset']}
300 Redfish.Login
301 Redfish Verify BMC Version ${IMAGE_FILE_PATH}
Sushil Singh87dcee12019-08-07 13:13:13 -0500302