blob: d607676f6571a509b59792c44101d87dc8d365d2 [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
36${FORCE_UPDATE} ${0}
George Keishing98cf8af2022-07-14 11:13:49 -050037${LOOP_COUNT} ${2}
George Keishingcad841d2022-02-24 01:02:20 -060038${DELETE_ERRLOGS} ${1}
Sushil Singh65878cb2020-02-27 03:43:44 -060039
George Keishing2e078ae2022-02-03 09:13:23 -060040${ACTIVATION_WAIT_TIMEOUT} 8 min
41
George Keishing57ab7cc2023-02-13 01:18:42 -060042# New code update path.
43${REDFISH_UPDATE_URI} /redfish/v1/UpdateService/update
44
Sushil Singh87dcee12019-08-07 13:13:13 -050045*** Test Cases ***
46
47Redfish BMC Code Update
48 [Documentation] Update the firmware image.
49 [Tags] Redfish_BMC_Code_Update
50
George Keishingaa027222021-11-17 06:37:57 -060051 # Python module: get_version_tar(tar_file_path)
52 ${image_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH}
Sushil Singh87dcee12019-08-07 13:13:13 -050053 Rprint Vars image_version
54
George Keishingaa027222021-11-17 06:37:57 -060055 # Python module: get_bmc_release_info()
56 ${bmc_release_info}= utils.Get BMC Release Info
George Keishingfedd5ce2020-07-24 02:25:08 -050057 ${functional_version}= Set Variable ${bmc_release_info['version_id']}
58 Rprint Vars functional_version
59
Sushil Singh76650912020-12-10 23:48:05 -060060 ${post_code_update_actions}= Get Post Boot Action
61 ${state}= Get Pre Reboot State
62 Rprint Vars state
63
George Keishing78903952020-07-24 07:04:53 -050064 # Check if the existing firmware is functional.
65 Pass Execution If '${functional_version}' == '${image_version}'
66 ... The existing ${image_version} firmware is already functional.
67
Sushil Singh76650912020-12-10 23:48:05 -060068 ${sw_inv}= Get Functional Firmware BMC image
69 ${nonfunctional_sw_inv}= Get Non Functional Firmware ${sw_inv} False
70
71 # Redfish active software image API.
Sushil Singhaad1da22021-06-21 04:19:18 -050072 Run Keyword If ${num_records} > 0
73 ... Run Keyword If '${nonfunctional_sw_inv['version']}' == '${image_version}'
74 ... Set Backup Firmware To Functional ${image_version} ${state}
Sushil Singh52859242020-10-09 07:28:22 -050075
Sushil Singhaad1da22021-06-21 04:19:18 -050076 Print Timen Performing firmware update ${image_version}.
Sushil Singh52859242020-10-09 07:28:22 -050077
Sushil Singh87dcee12019-08-07 13:13:13 -050078 Redfish Update Firmware
79
Sushil Singh8469a482020-07-30 04:19:10 -050080
George Keishingb695a902022-05-11 09:26:21 -050081Redfish BMC Code Update Running And Backup Image With Same Firmware
82 [Documentation] Perform the firmware update with same image back to back, so that
83 ... the running (functional Image) and backup image (alternate image)
84 ... with same firmware.
85 [Tags] Redfish_BMC_Code_Update_Running_And_Backup_Image_With_Same_Firmware
86
87 # Python module: get_version_tar(tar_file_path)
88 ${image_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH}
89 Rprint Vars image_version
90
91 # Python module: get_bmc_release_info()
92 ${bmc_release_info}= utils.Get BMC Release Info
93 ${functional_version}= Set Variable ${bmc_release_info['version_id']}
94 Rprint Vars functional_version
95
96 # First update.
97 Print Timen Performing firmware update ${image_version}.
98 Redfish Update Firmware
99
100 # Second update.
101 Print Timen Performing firmware update ${image_version}.
102 Redfish Update Firmware
103
104
Sushil Singh8469a482020-07-30 04:19:10 -0500105Redfish Firmware Update Loop
George Keishing98cf8af2022-07-14 11:13:49 -0500106 [Documentation] Update the same firmware image in loop.
Sushil Singh8469a482020-07-30 04:19:10 -0500107 [Tags] Redfish_Firmware_Update_Loop
108 [Template] Redfish Firmware Update In Loop
George Keishing98cf8af2022-07-14 11:13:49 -0500109 [Timeout] NONE
110 # Override default 30 minutes, Disabling timeout with NONE explicitly
111 # else this test will fail for longer loop runs.
Sushil Singh8469a482020-07-30 04:19:10 -0500112
113 ${LOOP_COUNT}
114
115
Sushil Singh87dcee12019-08-07 13:13:13 -0500116*** Keywords ***
117
118Suite Setup Execution
119 [Documentation] Do the suite setup.
120
121 Redfish.Login
Sushil Singh87dcee12019-08-07 13:13:13 -0500122 # Delete BMC dump and Error logs.
George Keishingc1954452020-10-14 07:44:17 -0500123 Run Keyword And Ignore Error Redfish Delete All BMC Dumps
George Keishingcad841d2022-02-24 01:02:20 -0600124 Run Keyword If ${DELETE_ERRLOGS} == ${1}
125 ... Run Keyword And Ignore Error Redfish Purge Event Log
Sushil Singh87dcee12019-08-07 13:13:13 -0500126 # Checking for file existence.
127 Valid File Path IMAGE_FILE_PATH
128
George Keishing57ab7cc2023-02-13 01:18:42 -0600129 # Check and set the update path.
130 # Old - /redfish/v1/UpdateService/
131 # New - /redfish/v1/UpdateService/update
132 ${resp}= Redfish.Get /redfish/v1/UpdateService/update
133 ... valid_status_codes=[${HTTP_OK},${HTTP_NOT_FOUND},${HTTP_METHOD_NOT_ALLOWED}]
134
135 # If the method is not found, set update URI to old method.
136 Run Keyword If ${resp.status} == ${HTTP_NOT_FOUND}
137 ... Set Suite Variable ${REDFISH_UPDATE_URI} /redfish/v1/UpdateService
138
139 Log To Console Update URI: ${REDFISH_UPDATE_URI}
140
George Keishing4574ec42021-10-06 11:45:33 -0500141 Redfish Power Off stack_mode=skip
142
Sushil Singh8469a482020-07-30 04:19:10 -0500143
144Redfish Firmware Update In Loop
145 [Documentation] Update the firmware in loop.
146 [Arguments] ${update_loop_count}
147
148 # Description of argument(s):
149 # update_loop_count This value is used to run the firmware update in loop.
150
George Keishing98cf8af2022-07-14 11:13:49 -0500151 # Python module: get_version_tar(tar_file_path)
152 ${image_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH}
153 Rprint Vars image_version
154
155 # Python module: get_bmc_release_info()
156 ${bmc_release_info}= utils.Get BMC Release Info
157 ${functional_version}= Set Variable ${bmc_release_info['version_id']}
158 Print Timen Starting firmware information:
159 Rprint Vars functional_version
160
Sushil Singh53c2dde2020-09-18 05:53:20 -0500161 ${temp_update_loop_count}= Evaluate ${update_loop_count} + 1
Sushil Singh8469a482020-07-30 04:19:10 -0500162
Sushil Singh53c2dde2020-09-18 05:53:20 -0500163 FOR ${count} IN RANGE 1 ${temp_update_loop_count}
George Keishing98cf8af2022-07-14 11:13:49 -0500164 Print Timen **************************************
165 Print Timen * The Current Loop Count is ${count} of ${update_loop_count} *
166 Print Timen **************************************
167 Print Timen Performing firmware update ${image_version}.
168 Redfish Update Firmware
Sushil Singh8469a482020-07-30 04:19:10 -0500169 END
170
Sushil Singh8469a482020-07-30 04:19:10 -0500171
Sushil Singh8469a482020-07-30 04:19:10 -0500172Delete BMC Image
173 [Documentation] Delete a BMC image from the BMC flash chip.
174
175 ${software_object}= Get Non Running BMC Software Object
176 Delete Image And Verify ${software_object} ${VERSION_PURPOSE_BMC}
177
178
Sushil Singh87dcee12019-08-07 13:13:13 -0500179Activate Existing Firmware
George Keishing16b3c7b2021-01-28 09:23:37 -0600180 [Documentation] Set firmware image to lower priority.
Sushil Singh87dcee12019-08-07 13:13:13 -0500181 [Arguments] ${image_version}
182
183 # Description of argument(s):
184 # image_version Version of image.
185
186 ${software_inventory_record}= Get Software Inventory State By Version
187 ... ${image_version}
188 ${num_keys}= Get Length ${software_inventory_record}
189
190 Rprint Vars software_inventory_record
191
192 # If no software inventory record was found, there is no existing
193 # firmware for the given version and therefore no action to be taken.
194 Return From Keyword If not ${num_keys}
195
196 # Check if the existing firmware is functional.
197 Pass Execution If ${software_inventory_record['functional']}
198 ... The existing ${image_version} firmware is already functional.
199
200 # If existing firmware is not functional, then set the priority to least.
201 Print Timen The existing ${image_version} firmware is not yet functional.
202 Set BMC Image Priority To Least ${image_version} ${software_inventory_record}
203
204 Pass Execution The existing ${image_version} firmware is now functional.
205
206
207Get Image Priority
208 [Documentation] Get Current Image Priority.
209 [Arguments] ${image_version}
210
211 # Description of argument(s):
George Keishing16b3c7b2021-01-28 09:23:37 -0600212 # image_version The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95).
Sushil Singh87dcee12019-08-07 13:13:13 -0500213
214 ${software_info}= Read Properties
215 ... ${SOFTWARE_VERSION_URI}/enumerate quiet=1
216 # Get only the record associated with our image_version.
217
218 ${software_info}= Filter Struct
219 ... ${software_info} [('Version', '${image_version}')]
220 # Convert from dict to list.
221 ${software_info}= Get Dictionary Values ${software_info}
222
223 [Return] ${software_info[0]['Priority']}
224
225
226Set BMC Image Priority To Least
227 [Documentation] Set BMC image priority to least value.
228 [Arguments] ${image_version} ${software_inventory}
229
230 # Description of argument(s):
George Keishing16b3c7b2021-01-28 09:23:37 -0600231 # image_version The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95).
Sushil Singh87dcee12019-08-07 13:13:13 -0500232 # software_inventory Software inventory details.
233
234 ${least_priority}= Get Least Value Priority Image ${VERSION_PURPOSE_BMC}
235 ${cur_priority}= Get Image Priority ${image_version}
236 Rprint Vars least_priority cur_priority
237
238 Return From Keyword If '${least_priority}' == ${cur_priority}
239 Set Host Software Property
240 ... ${SOFTWARE_VERSION_URI}${software_inventory['image_id']}
241 ... Priority ${least_priority}
242
Sushil Singh87dcee12019-08-07 13:13:13 -0500243 Redfish OBMC Reboot (off)
Sushil Singh87dcee12019-08-07 13:13:13 -0500244
245
Sushil Singhaad1da22021-06-21 04:19:18 -0500246Set Backup Firmware To Functional
247 [Documentation] Set the backup firmware to functional.
248 [Arguments] ${image_version} ${state}
249
250 # Description of argument(s):
251 # image_version Version of image.
252 # state Pre reboot state.
253
254 Print Timen Switch to back up and rebooting.
255 Switch Backup Firmware Image To Functional
256 Wait For Reboot start_boot_seconds=${state['epoch_seconds']}
257 Redfish Verify BMC Version ${IMAGE_FILE_PATH}
258 Pass Execution The backup firmware image ${image_version} is now functional.
259
260
Sushil Singh87dcee12019-08-07 13:13:13 -0500261Redfish Update Firmware
262 [Documentation] Update the BMC firmware via redfish interface.
263
Sushil Singh6624ce52020-01-22 00:53:41 -0600264 ${post_code_update_actions}= Get Post Boot Action
Sushil Singh87dcee12019-08-07 13:13:13 -0500265 ${state}= Get Pre Reboot State
266 Rprint Vars state
Sushil Singh090eedc2019-11-05 02:04:59 -0600267 Run Keyword And Ignore Error Set ApplyTime policy=OnReset
George Keishing2e078ae2022-02-03 09:13:23 -0600268
269 # Python module: get_member_list(resource_path)
270 ${before_inv_list}= redfish_utils.Get Member List /redfish/v1/UpdateService/FirmwareInventory
271 Log To Console Current images on the BMC before upload: ${before_inv_list}
272
George Keishingb695a902022-05-11 09:26:21 -0500273 Print Timen Start uploading image to BMC.
George Keishing57ab7cc2023-02-13 01:18:42 -0600274 Redfish Upload Image ${REDFISH_UPDATE_URI} ${IMAGE_FILE_PATH}
George Keishingb695a902022-05-11 09:26:21 -0500275 Print Timen Completed image upload to BMC.
George Keishing2e078ae2022-02-03 09:13:23 -0600276
277 # Python module: get_member_list(resource_path)
278 ${after_inv_list}= redfish_utils.Get Member List /redfish/v1/UpdateService/FirmwareInventory
279 Log To Console Current images on the BMC after upload: ${after_inv_list}
280
281 ${image_id}= Evaluate set(${after_inv_list}) - set(${before_inv_list})
282 Should Not Be Empty ${image_id}
283 ${image_id}= Evaluate list(${image_id})[0].split('/')[-1]
284 Log To Console Firmware installation in progress with image id:: ${image_id}
285
286 Wait Until Keyword Succeeds ${ACTIVATION_WAIT_TIMEOUT} 10 sec
287 ... Check Image Update Progress State match_state='Enabled' image_id=${image_id}
288
289 # Python module: get_version_tar(tar_file_path)
290 ${tar_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH}
Sushil Singh8f48c8f2020-01-16 04:36:25 -0600291 ${image_info}= Get Software Inventory State By Version ${tar_version}
George Keishing2e078ae2022-02-03 09:13:23 -0600292
Sushil Singh8f48c8f2020-01-16 04:36:25 -0600293 Run Key ${post_code_update_actions['${image_info["image_type"]}']['OnReset']}
294 Redfish.Login
295 Redfish Verify BMC Version ${IMAGE_FILE_PATH}
Sushil Singh87dcee12019-08-07 13:13:13 -0500296