Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 1 | *** Settings *** |
| 2 | Documentation 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 | |
| 12 | Resource ../../lib/resource.robot |
| 13 | Resource ../../lib/bmc_redfish_resource.robot |
| 14 | Resource ../../lib/openbmc_ffdc.robot |
| 15 | Resource ../../lib/common_utils.robot |
| 16 | Resource ../../lib/code_update_utils.robot |
| 17 | Resource ../../lib/redfish_code_update_utils.robot |
Sushil Singh | 6624ce5 | 2020-01-22 00:53:41 -0600 | [diff] [blame] | 18 | Resource ../../lib/utils.robot |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 19 | Library ../../lib/gen_robot_valid.py |
| 20 | Library ../../lib/var_funcs.py |
Sushil Singh | 8f48c8f | 2020-01-16 04:36:25 -0600 | [diff] [blame] | 21 | Library ../../lib/gen_robot_keyword.py |
Sushil Singh | 8469a48 | 2020-07-30 04:19:10 -0500 | [diff] [blame] | 22 | Library ../../lib/code_update_utils.py |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 23 | |
Sushil Singh | b2162d8 | 2019-09-27 07:22:04 -0500 | [diff] [blame] | 24 | Suite Setup Suite Setup Execution |
| 25 | Suite Teardown Redfish.Logout |
| 26 | Test Setup Printn |
| 27 | Test Teardown FFDC On Test Case Fail |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 28 | |
George Keishing | 7e85471 | 2021-03-17 13:18:10 -0500 | [diff] [blame] | 29 | # Force the test to timedout to prevent test hanging. |
| 30 | Test Timeout 30 minutes |
| 31 | |
Sushil Singh | b2162d8 | 2019-09-27 07:22:04 -0500 | [diff] [blame] | 32 | Force Tags BMC_Code_Update |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 33 | |
Sushil Singh | 65878cb | 2020-02-27 03:43:44 -0600 | [diff] [blame] | 34 | *** Variables *** |
| 35 | |
| 36 | ${FORCE_UPDATE} ${0} |
Sushil Singh | 8469a48 | 2020-07-30 04:19:10 -0500 | [diff] [blame] | 37 | ${LOOP_COUNT} 20 |
Sushil Singh | 65878cb | 2020-02-27 03:43:44 -0600 | [diff] [blame] | 38 | |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 39 | *** Test Cases *** |
| 40 | |
| 41 | Redfish BMC Code Update |
| 42 | [Documentation] Update the firmware image. |
| 43 | [Tags] Redfish_BMC_Code_Update |
| 44 | |
| 45 | ${image_version}= Get Version Tar ${IMAGE_FILE_PATH} |
| 46 | Rprint Vars image_version |
| 47 | |
George Keishing | fedd5ce | 2020-07-24 02:25:08 -0500 | [diff] [blame] | 48 | ${bmc_release_info}= Get BMC Release Info |
| 49 | ${functional_version}= Set Variable ${bmc_release_info['version_id']} |
| 50 | Rprint Vars functional_version |
| 51 | |
Sushil Singh | 7665091 | 2020-12-10 23:48:05 -0600 | [diff] [blame] | 52 | ${post_code_update_actions}= Get Post Boot Action |
| 53 | ${state}= Get Pre Reboot State |
| 54 | Rprint Vars state |
| 55 | |
George Keishing | 7890395 | 2020-07-24 07:04:53 -0500 | [diff] [blame] | 56 | # Check if the existing firmware is functional. |
| 57 | Pass Execution If '${functional_version}' == '${image_version}' |
| 58 | ... The existing ${image_version} firmware is already functional. |
| 59 | |
Sushil Singh | 7665091 | 2020-12-10 23:48:05 -0600 | [diff] [blame] | 60 | ${sw_inv}= Get Functional Firmware BMC image |
| 61 | ${nonfunctional_sw_inv}= Get Non Functional Firmware ${sw_inv} False |
| 62 | |
| 63 | # Redfish active software image API. |
| 64 | Run Keyword If not ${FORCE_UPDATE} |
George Keishing | 5d4e396 | 2021-05-20 07:37:51 +0000 | [diff] [blame] | 65 | ... Run Keyword If '${nonfunctional_sw_inv['version']}' == '${image_version}' |
Sushil Singh | 7665091 | 2020-12-10 23:48:05 -0600 | [diff] [blame] | 66 | ... Run Keywords Switch Backup Firmware Image To Functional AND |
| 67 | ... Wait For Reboot start_boot_seconds=${state['epoch_seconds']} AND |
| 68 | ... Redfish Verify BMC Version ${IMAGE_FILE_PATH} AND |
| 69 | ... Pass Execution The firmware ${image_version} is backup image. |
Sushil Singh | 5285924 | 2020-10-09 07:28:22 -0500 | [diff] [blame] | 70 | |
| 71 | # Firmware inventory record of the given image version. |
| 72 | ${image_info}= Get Software Inventory State By Version ${image_version} |
| 73 | |
| 74 | ${image_info_len}= Get Length ${image_info} |
| 75 | |
| 76 | # REST delete the image to fresh code update for a given same image object |
| 77 | # which is already ACTIVE but on the alternate side. Irrespective of when |
| 78 | # REST is disabled in near future or the below operation fails, is purely |
| 79 | # done to give a chance. |
| 80 | |
| 81 | Run Keyword If '${image_info_len}' != 0 |
Sushil Singh | fd481ef | 2020-10-12 06:51:00 -0500 | [diff] [blame] | 82 | ... Run Keywords Print Timen |
| 83 | ... The ${image_version} version is installed but not functional, try delete and continue firmware update. |
| 84 | ... AND |
Sushil Singh | 5285924 | 2020-10-09 07:28:22 -0500 | [diff] [blame] | 85 | ... Run Keyword And Ignore Error |
| 86 | ... Delete Software Object /xyz/openbmc_project/software/${image_info['image_id']} |
| 87 | |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 88 | Redfish Update Firmware |
| 89 | |
Sushil Singh | 8469a48 | 2020-07-30 04:19:10 -0500 | [diff] [blame] | 90 | |
| 91 | Redfish Firmware Update Loop |
| 92 | [Documentation] Update the firmware image in loop. |
| 93 | [Tags] Redfish_Firmware_Update_Loop |
| 94 | [Template] Redfish Firmware Update In Loop |
| 95 | |
| 96 | ${LOOP_COUNT} |
| 97 | |
| 98 | |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 99 | *** Keywords *** |
| 100 | |
| 101 | Suite Setup Execution |
| 102 | [Documentation] Do the suite setup. |
| 103 | |
| 104 | Redfish.Login |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 105 | # Delete BMC dump and Error logs. |
George Keishing | c647551 | 2020-10-06 00:32:10 -0500 | [diff] [blame] | 106 | Run Keyword And Ignore Error Delete All BMC Dump |
George Keishing | c195445 | 2020-10-14 07:44:17 -0500 | [diff] [blame] | 107 | Run Keyword And Ignore Error Redfish Delete All BMC Dumps |
George Keishing | 2dac812 | 2020-07-24 02:11:47 -0500 | [diff] [blame] | 108 | Run Keyword And Ignore Error Redfish Purge Event Log |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 109 | # Checking for file existence. |
| 110 | Valid File Path IMAGE_FILE_PATH |
| 111 | |
Sushil Singh | 8469a48 | 2020-07-30 04:19:10 -0500 | [diff] [blame] | 112 | |
| 113 | Redfish Firmware Update In Loop |
| 114 | [Documentation] Update the firmware in loop. |
| 115 | [Arguments] ${update_loop_count} |
| 116 | |
| 117 | # Description of argument(s): |
| 118 | # update_loop_count This value is used to run the firmware update in loop. |
| 119 | |
| 120 | ${before_image_state}= Get BMC Functional Firmware |
Sushil Singh | 53c2dde | 2020-09-18 05:53:20 -0500 | [diff] [blame] | 121 | ${temp_update_loop_count}= Evaluate ${update_loop_count} + 1 |
Sushil Singh | 8469a48 | 2020-07-30 04:19:10 -0500 | [diff] [blame] | 122 | |
Sushil Singh | 53c2dde | 2020-09-18 05:53:20 -0500 | [diff] [blame] | 123 | FOR ${count} IN RANGE 1 ${temp_update_loop_count} |
Sushil Singh | 8469a48 | 2020-07-30 04:19:10 -0500 | [diff] [blame] | 124 | Print Timen ************************************** |
| 125 | Print Timen * The Current Loop Count is ${count} of ${update_loop_count} * |
| 126 | Print Timen ************************************** |
| 127 | Redfish Update Firmware |
| 128 | ${sw_inv}= Get Functional Firmware BMC update |
Sushil Singh | fd481ef | 2020-10-12 06:51:00 -0500 | [diff] [blame] | 129 | ${nonfunctional_sw_inv}= Get Non Functional Firmware ${sw_inv} False |
Sushil Singh | 8469a48 | 2020-07-30 04:19:10 -0500 | [diff] [blame] | 130 | Run Keyword If ${nonfunctional_sw_inv['functional']} == False |
| 131 | ... Set BMC Image Priority To Least ${nonfunctional_sw_inv['version']} ${nonfunctional_sw_inv} |
| 132 | Redfish.Login |
| 133 | ${sw_inv}= Get Functional Firmware BMC update |
Sushil Singh | fd481ef | 2020-10-12 06:51:00 -0500 | [diff] [blame] | 134 | ${nonfunctional_sw_inv}= Get Non Functional Firmware ${sw_inv} False |
Sushil Singh | 8469a48 | 2020-07-30 04:19:10 -0500 | [diff] [blame] | 135 | Delete BMC Image |
| 136 | END |
| 137 | |
| 138 | ${after_image_state}= Get BMC Functional Firmware |
| 139 | Valid Value before_image_state["version"] ['${after_image_state["version"]}'] |
| 140 | |
| 141 | |
Sushil Singh | 8469a48 | 2020-07-30 04:19:10 -0500 | [diff] [blame] | 142 | Delete BMC Image |
| 143 | [Documentation] Delete a BMC image from the BMC flash chip. |
| 144 | |
| 145 | ${software_object}= Get Non Running BMC Software Object |
| 146 | Delete Image And Verify ${software_object} ${VERSION_PURPOSE_BMC} |
| 147 | |
| 148 | |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 149 | Activate Existing Firmware |
George Keishing | 16b3c7b | 2021-01-28 09:23:37 -0600 | [diff] [blame] | 150 | [Documentation] Set firmware image to lower priority. |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 151 | [Arguments] ${image_version} |
| 152 | |
| 153 | # Description of argument(s): |
| 154 | # image_version Version of image. |
| 155 | |
| 156 | ${software_inventory_record}= Get Software Inventory State By Version |
| 157 | ... ${image_version} |
| 158 | ${num_keys}= Get Length ${software_inventory_record} |
| 159 | |
| 160 | Rprint Vars software_inventory_record |
| 161 | |
| 162 | # If no software inventory record was found, there is no existing |
| 163 | # firmware for the given version and therefore no action to be taken. |
| 164 | Return From Keyword If not ${num_keys} |
| 165 | |
| 166 | # Check if the existing firmware is functional. |
| 167 | Pass Execution If ${software_inventory_record['functional']} |
| 168 | ... The existing ${image_version} firmware is already functional. |
| 169 | |
| 170 | # If existing firmware is not functional, then set the priority to least. |
| 171 | Print Timen The existing ${image_version} firmware is not yet functional. |
| 172 | Set BMC Image Priority To Least ${image_version} ${software_inventory_record} |
| 173 | |
| 174 | Pass Execution The existing ${image_version} firmware is now functional. |
| 175 | |
| 176 | |
| 177 | Get Image Priority |
| 178 | [Documentation] Get Current Image Priority. |
| 179 | [Arguments] ${image_version} |
| 180 | |
| 181 | # Description of argument(s): |
George Keishing | 16b3c7b | 2021-01-28 09:23:37 -0600 | [diff] [blame] | 182 | # image_version The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95). |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 183 | |
| 184 | ${software_info}= Read Properties |
| 185 | ... ${SOFTWARE_VERSION_URI}/enumerate quiet=1 |
| 186 | # Get only the record associated with our image_version. |
| 187 | |
| 188 | ${software_info}= Filter Struct |
| 189 | ... ${software_info} [('Version', '${image_version}')] |
| 190 | # Convert from dict to list. |
| 191 | ${software_info}= Get Dictionary Values ${software_info} |
| 192 | |
| 193 | [Return] ${software_info[0]['Priority']} |
| 194 | |
| 195 | |
| 196 | Set BMC Image Priority To Least |
| 197 | [Documentation] Set BMC image priority to least value. |
| 198 | [Arguments] ${image_version} ${software_inventory} |
| 199 | |
| 200 | # Description of argument(s): |
George Keishing | 16b3c7b | 2021-01-28 09:23:37 -0600 | [diff] [blame] | 201 | # image_version The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95). |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 202 | # software_inventory Software inventory details. |
| 203 | |
| 204 | ${least_priority}= Get Least Value Priority Image ${VERSION_PURPOSE_BMC} |
| 205 | ${cur_priority}= Get Image Priority ${image_version} |
| 206 | Rprint Vars least_priority cur_priority |
| 207 | |
| 208 | Return From Keyword If '${least_priority}' == ${cur_priority} |
| 209 | Set Host Software Property |
| 210 | ... ${SOFTWARE_VERSION_URI}${software_inventory['image_id']} |
| 211 | ... Priority ${least_priority} |
| 212 | |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 213 | Redfish OBMC Reboot (off) |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 214 | |
| 215 | |
| 216 | Redfish Update Firmware |
| 217 | [Documentation] Update the BMC firmware via redfish interface. |
| 218 | |
Sushil Singh | 6624ce5 | 2020-01-22 00:53:41 -0600 | [diff] [blame] | 219 | ${post_code_update_actions}= Get Post Boot Action |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 220 | ${state}= Get Pre Reboot State |
| 221 | Rprint Vars state |
Sushil Singh | 090eedc | 2019-11-05 02:04:59 -0600 | [diff] [blame] | 222 | Run Keyword And Ignore Error Set ApplyTime policy=OnReset |
Sushil Singh | 6f86f17 | 2019-10-30 11:36:25 -0500 | [diff] [blame] | 223 | Redfish Upload Image And Check Progress State |
Sushil Singh | 8f48c8f | 2020-01-16 04:36:25 -0600 | [diff] [blame] | 224 | ${tar_version}= Get Version Tar ${IMAGE_FILE_PATH} |
| 225 | ${image_info}= Get Software Inventory State By Version ${tar_version} |
Sushil Singh | 8f48c8f | 2020-01-16 04:36:25 -0600 | [diff] [blame] | 226 | Run Key ${post_code_update_actions['${image_info["image_type"]}']['OnReset']} |
| 227 | Redfish.Login |
| 228 | Redfish Verify BMC Version ${IMAGE_FILE_PATH} |
Sushil Singh | 87dcee1 | 2019-08-07 13:13:13 -0500 | [diff] [blame] | 229 | |