1*** Settings *** 2Documentation Update firmware 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/dump_utils.robot 18Resource ../../lib/logging_utils.robot 19Resource ../../lib/redfish_code_update_utils.robot 20Resource ../../lib/utils.robot 21Resource ../../lib/bmc_redfish_utils.robot 22Resource ../../lib/external_intf/management_console_utils.robot 23Resource ../../lib/bmc_network_utils.robot 24Resource ../../lib/certificate_utils.robot 25Library ../../lib/gen_robot_valid.py 26Library ../../lib/tftp_update_utils.py 27Library ../../lib/gen_robot_keyword.py 28 29Suite Setup Suite Setup Execution 30Suite Teardown Redfish.Logout 31Test Setup Printn 32Test Teardown FFDC On Test Case Fail 33 34Force Tags BMC_Code_Update 35 36*** Variables *** 37 38@{ADMIN} admin_user TestPwd123 39&{USERS} Administrator=${ADMIN} 40${LOOP_COUNT} ${2} 41@{HOSTNAME} bmc_system01 bmc_system02 bmc_system03 bmc_system04 bmc_system05 42 43*** Test Cases *** 44 45Redfish Code Update With ApplyTime OnReset 46 [Documentation] Update the firmware image with ApplyTime of OnReset. 47 [Tags] Redfish_Code_Update_With_ApplyTime_OnReset 48 [Template] Redfish Update Firmware 49 50 # policy 51 OnReset 52 53 54Redfish Code Update With ApplyTime Immediate 55 [Documentation] Update the firmware image with ApplyTime of Immediate. 56 [Tags] Redfish_Code_Update_With_ApplyTime_Immediate 57 [Template] Redfish Update Firmware 58 59 # policy 60 Immediate 61 62 63Redfish Code Update Same Firmware Multiple Times 64 [Documentation] Multiple times update the firmware image for update service. 65 [Tags] Redfish_Code_Update_Same_Firmware_Multiple_Times 66 67 ${temp_update_loop_count}= Evaluate ${LOOP_COUNT} + 1 68 69 FOR ${count} IN RANGE 1 ${temp_update_loop_count} 70 Print Timen *************************************** 71 Print Timen * The Current Loop Count is ${count} of ${LOOP_COUNT} * 72 Print Timen *************************************** 73 74 Redfish Update Firmware apply_time=OnReset 75 END 76 77 78 79Redfish Code Update With Multiple Firmware 80 [Documentation] Update the firmware image with ApplyTime of Immediate. 81 [Tags] Redfish_Code_Update_With_Multiple_Firmware 82 [Template] Redfish Multiple Upload Image And Check Progress State 83 84 # policy image_file_path alternate_image_file_path 85 Immediate ${IMAGE_FILE_PATH} ${ALTERNATE_IMAGE_FILE_PATH} 86 87 88Post BMC Reset Perform Redfish Code Update 89 [Documentation] Test to reset BMC at standby and then perform BMC firmware update and 90 ... ensure there is not error or dump logs post update. 91 [Tags] Post_BMC_Reset_Perform_Redfish_Code_Update 92 93 Redfish Delete All BMC Dumps 94 Redfish Purge Event Log 95 96 Redfish OBMC Reboot (off) 97 98 Redfish Update Firmware apply_time=OnReset 99 100 Event Log Should Not Exist 101 Redfish BMC Dump Should Not Exist 102 103 Redfish Power Off 104 105 106Post BMC Reset Perform Image Switched To Backup Multiple Times 107 [Documentation] Test to reset BMC at standby and then perform switch 108 ... to backup image multiple times. 109 ... Then ensure no event and dump logs exist. 110 [Tags] Post_BMC_Reset_Perform_Image_Switched_To_Backup_Multiple_Times 111 112 Redfish Delete All BMC Dumps 113 Redfish Purge Event Log 114 115 Redfish OBMC Reboot (off) 116 117 ${temp_update_loop_count}= Evaluate ${LOOP_COUNT} + 1 118 119 FOR ${count} IN RANGE 1 ${temp_update_loop_count} 120 ${state}= Get Pre Reboot State 121 122 # change to backup image and reset the BMC. 123 Switch Backup Firmware Image To Functional 124 125 Wait For Reboot start_boot_seconds=${state['epoch_seconds']} 126 END 127 128 Event Log Should Not Exist 129 Redfish BMC Dump Should Not Exist 130 131 132Verify If The Modified Admin Credential Is Valid Post Image Switched To Backup 133 [Documentation] Verify updated admin credential remain same post switch to back up image. 134 [Tags] Verify_If_The_Modified_Admin_Credential_Is_Valid_Post_Image_Switched_To_Backup 135 [Setup] Create Users With Different Roles users=${USERS} force=${True} 136 [Teardown] Run Keywords Redfish.Login AND Delete BMC Users Via Redfish users=${USERS} 137 138 ${post_code_update_actions}= Get Post Boot Action 139 ${state}= Get Pre Reboot State 140 Expire And Update New Password Via Redfish ${ADMIN[0]} ${ADMIN[1]} 0penBmc123 141 142 Redfish.Login 143 # change to backup image and reset the BMC. 144 Switch Backup Firmware Image To Functional 145 Wait For Reboot start_boot_seconds=${state['epoch_seconds']} 146 147 # verify modified admin password on backup image. 148 Redfish.Login admin_user 0penBmc123 149 Redfish.Logout 150 151 152Verify If The Modified Admin Credential Is Valid Post Update 153 [Documentation] Verify updated admin credential remain same post code update image. 154 [Tags] Verify_If_The_Modified_Admin_Credential_Is_Valid_Post_Update 155 [Setup] Create Users With Different Roles users=${USERS} force=${True} 156 [Teardown] Run Keywords Redfish.Login AND Delete BMC Users Via Redfish users=${USERS} 157 158 Expire And Update New Password Via Redfish ${ADMIN[0]} ${ADMIN[1]} 0penBmc123 159 160 Redfish.Login 161 # Flash latest firmware using redfish. 162 Redfish Update Firmware OnReset 163 164 # verify modified admin credentails on latest image. 165 Redfish.Login admin_user 0penBmc123 166 Redfish.Logout 167 168 169Redfish Code Update With Different Interrupted Operation 170 [Documentation] Ensure firmware update is successful when different interrupted operation executed 171 ... i.e. change the hostname, updating https certificate and firmware update fail 172 ... when kernel panic. 173 [Tags] Redfish_Code_Update_With_Different_Interrupted_Operation 174 [Template] Verify Redfish Code Update With Different Interrupted Operation 175 176 # operation count 177 host_name 1 178 kernel_panic 1 179 https_certificate 1 180 181*** Keywords *** 182 183Suite Setup Execution 184 [Documentation] Do the suite setup. 185 186 Valid File Path IMAGE_FILE_PATH 187 Redfish.Login 188 189 Redfish Delete All BMC Dumps 190 Redfish Purge Event Log 191 192 Redfish Power Off stack_mode=skip 193 194 195Redfish Update Firmware 196 [Documentation] Update the BMC firmware via redfish interface. 197 [Arguments] ${apply_time} 198 199 # Description of argument(s): 200 # policy ApplyTime allowed values (e.g. "OnReset", "Immediate"). 201 202 ${post_code_update_actions}= Get Post Boot Action 203 ${state}= Get Pre Reboot State 204 Rprint Vars state 205 Set ApplyTime policy=${apply_Time} 206 207 ${task_inv_dict}= Get Task State from File 208 209 ${file_bin_data}= OperatingSystem.Get Binary File ${image_file_path} 210 211 Log To Console Start uploading image to BMC. 212 Upload Image To BMC ${REDFISH_BASE_URI}UpdateService timeout=${600} data=${file_bin_data} 213 Log To Console Completed image upload to BMC. 214 215 ${task_inv}= Check Task With Match TargetUri /redfish/v1/UpdateService 216 217 Rprint Vars task_inv 218 219 Wait Until Keyword Succeeds 5 min 10 sec 220 ... Verify Task Progress State ${task_inv} ${task_inv_dict['TaskCompleted']} 221 222 Run Key ${post_code_update_actions['BMC image']['${apply_time}']} 223 Redfish.Login 224 Redfish Verify BMC Version ${IMAGE_FILE_PATH} 225 Verify Get ApplyTime ${apply_time} 226 227 228Redfish Multiple Upload Image And Check Progress State 229 [Documentation] Update multiple BMC firmware via redfish interface and check status. 230 [Arguments] ${apply_time} ${IMAGE_FILE_PATH} ${ALTERNATE_IMAGE_FILE_PATH} 231 232 # Description of argument(s): 233 # apply_time ApplyTime allowed values (e.g. "OnReset", "Immediate"). 234 # IMAGE_FILE_PATH The path to BMC image file. 235 # ALTERNATE_IMAGE_FILE_PATH The path to alternate BMC image file. 236 237 ${post_code_update_actions}= Get Post Boot Action 238 Valid File Path ALTERNATE_IMAGE_FILE_PATH 239 ${state}= Get Pre Reboot State 240 Rprint Vars state 241 242 Set ApplyTime policy=${apply_time} 243 Redfish Upload Image ${REDFISH_BASE_URI}UpdateService ${IMAGE_FILE_PATH} 244 245 ${first_image_id}= Get Latest Image ID 246 Rprint Vars first_image_id 247 Sleep 5s 248 Redfish Upload Image ${REDFISH_BASE_URI}UpdateService ${ALTERNATE_IMAGE_FILE_PATH} 249 250 ${second_image_id}= Get Latest Image ID 251 Rprint Vars second_image_id 252 253 Check Image Update Progress State 254 ... match_state='Updating', 'Disabled' image_id=${second_image_id} 255 256 Check Image Update Progress State 257 ... match_state='Updating' image_id=${first_image_id} 258 259 Wait Until Keyword Succeeds 8 min 20 sec 260 ... Check Image Update Progress State 261 ... match_state='Enabled' image_id=${first_image_id} 262 Run Key ${post_code_update_actions['BMC image']['${apply_time}']} 263 Redfish.Login 264 Redfish Verify BMC Version ${IMAGE_FILE_PATH} 265 266 267Run Configure BMC Hostname In Loop 268 [Documentation] Update hostname in loop. 269 [Arguments] ${count} 270 271 # Description of argument(s): 272 # count Loop count. 273 274 FOR ${index} IN RANGE ${count} 275 Configure Hostname hostname=${HOSTNAME}[${index}] status_code=[${HTTP_INTERNAL_SERVER_ERROR}] 276 END 277 278 279Redfish Update Certificate Upload In Loop 280 [Documentation] Upload HTTPS server certificate via Redfish and verify using OpenSSL. 281 [Arguments] ${count} 282 283 # Description of argument(s): 284 # count Loop count. 285 286 FOR ${index} IN RANGE ${count} 287 ${resp}= Run Keyword And Return Status Redfish.Get ${REDFISH_HTTPS_CERTIFICATE_URI}/1 valid_status_codes=[${HTTP_OK}] 288 Should Be Equal As Strings ${resp} ${True} 289 290 ${cert_file_path}= Generate Certificate File Via Openssl Valid Certificate Valid Privatekey 291 ${bytes}= OperatingSystem.Get Binary File ${cert_file_path} 292 ${file_data}= Decode Bytes To String ${bytes} UTF-8 293 294 ${certificate_dict}= Create Dictionary 295 ... @odata.id=${REDFISH_HTTPS_CERTIFICATE_URI}/1 296 ${payload}= Create Dictionary CertificateString=${file_data} 297 ... CertificateType=PEM CertificateUri=${certificate_dict} 298 299 ${resp}= Redfish.Post /redfish/v1/CertificateService/Actions/CertificateService.ReplaceCertificate 300 ... body=${payload} 301 302 Verify Certificate Visible Via OpenSSL ${cert_file_path} 303 END 304 305 306Run Operation On BMC 307 [Documentation] Run operation on BMC. 308 [Arguments] ${operation} ${count} 309 310 # Description of argument(s): 311 # operation If host_name then change hostname. 312 # count Loop count. 313 314 Run Keyword If '${operation}' == 'host_name' 315 ... Run Configure BMC Hostname In Loop count=${count} 316 ... ELSE IF '${operation}' == 'kernel_panic' 317 ... Run Keywords Kernel Panic BMC Reset Operation AND 318 ... Is BMC Unpingable 319 ... ELSE IF '${operation}' == 'https_certificate' 320 ... Redfish Update Certificate Upload In Loop count=${count} 321 ... ELSE 322 ... Fail msg=Operation not handled. 323 324 325Get Active Firmware Image 326 [Documentation] Return get active firmware image. 327 328 ${active_image}= Redfish.Get Attribute /redfish/v1/Managers/bmc Links 329 Rprint Vars active_image 330 331 [Return] ${active_image} 332 333 334Get New Image ID 335 [Documentation] Return the ID of the most recently extracted image. 336 337 ${image_id}= Get Image Id Updating 338 339 [Return] ${image_id} 340 341 342Verify Redfish Code Update With Different Interrupted Operation 343 [Documentation] Verify code update is successful when other operation 344 ... getting executed i.e. change the hostname, updating http certificate 345 ... and code update will fail for kernel panic. 346 [Arguments] ${operation} ${count} 347 348 # Description of argument(s): 349 # operation host_name to change Hostname, kernel_panic to perform kernel panic. 350 # count Number of times loop will get executed. 351 352 ${before_update_activeswimage}= Get Active Firmware Image 353 354 ${post_code_update_actions}= Get Post Boot Action 355 356 Set ApplyTime policy=OnReset 357 358 ${task_inv_dict}= Get Task State from File 359 360 ${file_bin_data}= OperatingSystem.Get Binary File ${image_file_path} 361 362 Log To Console Start uploading image to BMC. 363 Upload Image To BMC ${REDFISH_BASE_URI}UpdateService timeout=${600} data=${file_bin_data} 364 Log To Console Completed image upload to BMC. 365 366 Sleep 5 367 368 ${image_id}= Get New Image ID 369 Rprint Vars image_id 370 371 ${task_inv}= Check Task With Match TargetUri /redfish/v1/UpdateService 372 Rprint Vars task_inv 373 374 Wait Until Keyword Succeeds 1 min 10 sec 375 ... Verify Task Progress State ${task_inv} ${task_inv_dict['TaskStarting']} 376 377 Run Operation On BMC ${operation} ${count} 378 379 IF '${operation}' == 'kernel_panic' 380 Wait Until Keyword Succeeds 10 min 10 sec Is BMC Standby 381 ELSE IF '${operation}' == 'host_name' 382 Wait Until Keyword Succeeds 5 min 10 sec 383 ... Verify Task Progress State ${task_inv} ${task_inv_dict['TaskCompleted']} 384 Run Key ${post_code_update_actions['BMC image']['OnReset']} 385 Redfish Verify BMC Version ${IMAGE_FILE_PATH} 386 ELSE IF '${operation}' == 'https_certificate' 387 Check Image Update Progress State 388 ... match_state='Updating' image_id=${image_id} 389 Wait Until Keyword Succeeds 8 min 20 sec 390 ... Check Image Update Progress State 391 ... match_state='Enabled' image_id=${image_id} 392 Run Key ${post_code_update_actions['BMC image']['OnReset']} 393 Redfish Verify BMC Version ${IMAGE_FILE_PATH} 394 ELSE 395 Fail msg=Operation not handled. 396 END 397 398 ${after_update_activeswimage}= Get Active Firmware Image 399 400 ${status}= Run Keyword And Return Status Should Be Equal As Strings 401 ... ${before_update_activeswimage['ActiveSoftwareImage']['@odata.id']} 402 ... ${after_update_activeswimage['ActiveSoftwareImage']['@odata.id']} 403 404 Run Keyword If '${operation}' == 'kernel_panic' 405 ... Should Be True ${status} 406 ... ELSE 407 ... Should Not Be True ${status} 408 409 Verify Get ApplyTime OnReset 410 411