1*** 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 18Resource ../../lib/utils.robot 19Library ../../lib/gen_robot_valid.py 20Library ../../lib/var_funcs.py 21Library ../../lib/gen_robot_keyword.py 22Library ../../lib/code_update_utils.py 23 24Suite Setup Suite Setup Execution 25Suite Teardown Redfish.Logout 26Test Setup Printn 27Test Teardown FFDC On Test Case Fail 28 29# Force the test to timedout to prevent test hanging. 30Test Timeout 45 minutes 31 32Test Tags Bmc_Code_Update 33 34*** Variables *** 35 36${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} 41 42${ACTIVATION_WAIT_TIMEOUT} 8 min 43 44# New code update path. 45${REDFISH_UPDATE_URI} /redfish/v1/UpdateService/update 46 47*** Test Cases *** 48 49Redfish BMC Code Update 50 [Documentation] Update the firmware image. 51 [Tags] Redfish_BMC_Code_Update 52 53 # Python module: get_version_tar(tar_file_path) 54 ${image_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH} 55 Rprint Vars image_version 56 57 # Python module: get_bmc_release_info() 58 ${bmc_release_info}= utils.Get BMC Release Info 59 ${functional_version}= Set Variable ${bmc_release_info['version_id']} 60 Rprint Vars functional_version 61 62 ${post_code_update_actions}= Get Post Boot Action 63 ${state}= Get Pre Reboot State 64 Rprint Vars state 65 66 # 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 70 ${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. 74 IF ${num_records} > 0 75 IF '${nonfunctional_sw_inv['version']}' == '${image_version}' 76 Set Backup Firmware To Functional ${image_version} ${state} 77 END 78 END 79 80 Print Timen Performing firmware update ${image_version}. 81 82 Redfish Update Firmware 83 84 85Redfish BMC Code Update Running And Backup Image With Same Firmware 86 [Documentation] Perform the firmware update with same image back to back, so that 87 ... the running (functional Image) and backup image (alternate image) 88 ... with same firmware. 89 [Tags] Redfish_BMC_Code_Update_Running_And_Backup_Image_With_Same_Firmware 90 91 # Python module: get_version_tar(tar_file_path) 92 ${image_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH} 93 Rprint Vars image_version 94 95 # Python module: get_bmc_release_info() 96 ${bmc_release_info}= utils.Get BMC Release Info 97 ${functional_version}= Set Variable ${bmc_release_info['version_id']} 98 Rprint Vars functional_version 99 100 # First update. 101 Print Timen Performing firmware update ${image_version}. 102 Redfish Update Firmware 103 104 # Second update. 105 Print Timen Performing firmware update ${image_version}. 106 Redfish Update Firmware 107 108 109Redfish Firmware Update Loop 110 [Documentation] Update the same firmware image in loop. 111 [Tags] Redfish_Firmware_Update_Loop 112 [Template] Redfish Firmware Update In Loop 113 [Timeout] NONE 114 # Override default 30 minutes, Disabling timeout with NONE explicitly 115 # else this test will fail for longer loop runs. 116 117 ${LOOP_COUNT} 118 119 120*** Keywords *** 121 122Suite Setup Execution 123 [Documentation] Do the suite setup. 124 125 Redfish.Login 126 # Delete BMC dump and Error logs. 127 Run Keyword And Ignore Error Redfish Delete All BMC Dumps 128 Run Keyword If ${DELETE_ERRLOGS} == ${1} 129 ... Run Keyword And Ignore Error Redfish Purge Event Log 130 # To invalidate all the guard records. 131 Run Keyword If '${DELETE_OLD_GUARD_FILE}' == '${1}' 132 ... BMC Execute Command guard -I 133 134 # Checking for file existence. 135 Valid File Path IMAGE_FILE_PATH 136 137 # Check and set the update path. 138 # Old - /redfish/v1/UpdateService/ 139 # New - /redfish/v1/UpdateService/update 140 ${resp}= Redfish.Get /redfish/v1/UpdateService/update 141 ... valid_status_codes=[${HTTP_OK},${HTTP_NOT_FOUND},${HTTP_METHOD_NOT_ALLOWED}] 142 143 # If the method is not found, set update URI to old method. 144 Run Keyword If ${resp.status} == ${HTTP_NOT_FOUND} 145 ... Set Suite Variable ${REDFISH_UPDATE_URI} /redfish/v1/UpdateService 146 147 Log To Console Update URI: ${REDFISH_UPDATE_URI} 148 149 Redfish Power Off stack_mode=skip 150 151 152Redfish Firmware Update In Loop 153 [Documentation] Update the firmware in loop. 154 [Arguments] ${update_loop_count} 155 156 # Description of argument(s): 157 # update_loop_count This value is used to run the firmware update in loop. 158 159 # Python module: get_version_tar(tar_file_path) 160 ${image_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH} 161 Rprint Vars image_version 162 163 # Python module: get_bmc_release_info() 164 ${bmc_release_info}= utils.Get BMC Release Info 165 ${functional_version}= Set Variable ${bmc_release_info['version_id']} 166 Print Timen Starting firmware information: 167 Rprint Vars functional_version 168 169 ${temp_update_loop_count}= Evaluate ${update_loop_count} + 1 170 171 FOR ${count} IN RANGE 1 ${temp_update_loop_count} 172 Print Timen ************************************** 173 Print Timen * The Current Loop Count is ${count} of ${update_loop_count} * 174 Print Timen ************************************** 175 Print Timen Performing firmware update ${image_version}. 176 Redfish Update Firmware 177 END 178 179 180Delete BMC Image 181 [Documentation] Delete a BMC image from the BMC flash chip. 182 183 ${software_object}= Get Non Running BMC Software Object 184 Delete Image And Verify ${software_object} ${VERSION_PURPOSE_BMC} 185 186 187Activate Existing Firmware 188 [Documentation] Set firmware image to lower priority. 189 [Arguments] ${image_version} 190 191 # Description of argument(s): 192 # image_version Version of image. 193 194 ${software_inventory_record}= Get Software Inventory State By Version 195 ... ${image_version} 196 ${num_keys}= Get Length ${software_inventory_record} 197 198 Rprint Vars software_inventory_record 199 200 # If no software inventory record was found, there is no existing 201 # firmware for the given version and therefore no action to be taken. 202 IF not ${num_keys} RETURN 203 204 # Check if the existing firmware is functional. 205 Pass Execution If ${software_inventory_record['functional']} 206 ... The existing ${image_version} firmware is already functional. 207 208 # If existing firmware is not functional, then set the priority to least. 209 Print Timen The existing ${image_version} firmware is not yet functional. 210 Set BMC Image Priority To Least ${image_version} ${software_inventory_record} 211 212 Pass Execution The existing ${image_version} firmware is now functional. 213 214 215Get Image Priority 216 [Documentation] Get Current Image Priority. 217 [Arguments] ${image_version} 218 219 # Description of argument(s): 220 # image_version The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95). 221 222 ${software_info}= Read Properties 223 ... ${SOFTWARE_VERSION_URI}/enumerate quiet=1 224 # Get only the record associated with our image_version. 225 226 ${software_info}= Filter Struct 227 ... ${software_info} [('Version', '${image_version}')] 228 # Convert from dict to list. 229 ${software_info}= Get Dictionary Values ${software_info} 230 231 RETURN ${software_info[0]['Priority']} 232 233 234Set BMC Image Priority To Least 235 [Documentation] Set BMC image priority to least value. 236 [Arguments] ${image_version} ${software_inventory} 237 238 # Description of argument(s): 239 # image_version The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95). 240 # software_inventory Software inventory details. 241 242 ${least_priority}= Get Least Value Priority Image ${VERSION_PURPOSE_BMC} 243 ${cur_priority}= Get Image Priority ${image_version} 244 Rprint Vars least_priority cur_priority 245 246 IF '${least_priority}' == ${cur_priority} RETURN 247 248 Set Host Software Property 249 ... ${SOFTWARE_VERSION_URI}${software_inventory['image_id']} 250 ... Priority ${least_priority} 251 252 Redfish OBMC Reboot (off) 253 254 255Set Backup Firmware To Functional 256 [Documentation] Set the backup firmware to functional. 257 [Arguments] ${image_version} ${state} 258 259 # Description of argument(s): 260 # image_version Version of image. 261 # state Pre reboot state. 262 263 Print Timen Switch to back up and rebooting. 264 Switch Backup Firmware Image To Functional 265 Wait For Reboot start_boot_seconds=${state['epoch_seconds']} 266 Redfish Verify BMC Version ${IMAGE_FILE_PATH} 267 Pass Execution The backup firmware image ${image_version} is now functional. 268 269 270Redfish Update Firmware 271 [Documentation] Update the BMC firmware via redfish interface. 272 273 ${post_code_update_actions}= Get Post Boot Action 274 ${state}= Get Pre Reboot State 275 Rprint Vars state 276 Run Keyword And Ignore Error Set ApplyTime policy=OnReset 277 278 # Python module: get_member_list(resource_path) 279 ${before_inv_list}= redfish_utils.Get Member List /redfish/v1/UpdateService/FirmwareInventory 280 Log To Console Current images on the BMC before upload: ${before_inv_list} 281 282 Print Timen Start uploading image to BMC. 283 Redfish Upload Image ${REDFISH_UPDATE_URI} ${IMAGE_FILE_PATH} 284 Print Timen Completed image upload to BMC. 285 286 # Python module: get_member_list(resource_path) 287 ${after_inv_list}= redfish_utils.Get Member List /redfish/v1/UpdateService/FirmwareInventory 288 Log To Console Current images on the BMC after upload: ${after_inv_list} 289 290 ${image_id}= Evaluate set(${after_inv_list}) - set(${before_inv_list}) 291 Should Not Be Empty ${image_id} 292 ${image_id}= Evaluate list(${image_id})[0].split('/')[-1] 293 Log To Console Firmware installation in progress with image id:: ${image_id} 294 295 Wait Until Keyword Succeeds ${ACTIVATION_WAIT_TIMEOUT} 10 sec 296 ... Check Image Update Progress State match_state='Enabled' image_id=${image_id} 297 298 # Python module: get_version_tar(tar_file_path) 299 ${tar_version}= code_update_utils.Get Version Tar ${IMAGE_FILE_PATH} 300 ${image_info}= Get Software Inventory State By Version ${tar_version} 301 302 Run Key ${post_code_update_actions['${image_info["image_type"]}']['OnReset']} 303 Redfish.Login 304 Redfish Verify BMC Version ${IMAGE_FILE_PATH} 305 306