blob: 40fc2b23e2e174430855195e7260e9b750fa9a64 [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.
30Test Timeout 30 minutes
31
Sushil Singhb2162d82019-09-27 07:22:04 -050032Force 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}
Sushil Singh8469a482020-07-30 04:19:10 -050037${LOOP_COUNT} 20
Sushil Singh65878cb2020-02-27 03:43:44 -060038
Sushil Singh87dcee12019-08-07 13:13:13 -050039*** Test Cases ***
40
41Redfish 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 Keishingfedd5ce2020-07-24 02:25:08 -050048 ${bmc_release_info}= Get BMC Release Info
49 ${functional_version}= Set Variable ${bmc_release_info['version_id']}
50 Rprint Vars functional_version
51
Sushil Singh76650912020-12-10 23:48:05 -060052 ${post_code_update_actions}= Get Post Boot Action
53 ${state}= Get Pre Reboot State
54 Rprint Vars state
55
George Keishing78903952020-07-24 07:04:53 -050056 # 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 Singh76650912020-12-10 23:48:05 -060060 ${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}
Sushil Singh3b6f9162021-05-20 06:47:47 -050065 ... Run Keyword If ${num_records} > 0
66 ... Run Keyword If '${nonfunctional_sw_inv['version']}' == '${image_version}'
67 ... Run Keywords Switch Backup Firmware Image To Functional AND
68 ... Wait For Reboot start_boot_seconds=${state['epoch_seconds']} AND
69 ... Redfish Verify BMC Version ${IMAGE_FILE_PATH} AND
70 ... Pass Execution The firmware ${image_version} is backup image.
Sushil Singh52859242020-10-09 07:28:22 -050071
72 # Firmware inventory record of the given image version.
73 ${image_info}= Get Software Inventory State By Version ${image_version}
74
75 ${image_info_len}= Get Length ${image_info}
76
77 # REST delete the image to fresh code update for a given same image object
78 # which is already ACTIVE but on the alternate side. Irrespective of when
79 # REST is disabled in near future or the below operation fails, is purely
80 # done to give a chance.
81
82 Run Keyword If '${image_info_len}' != 0
Sushil Singhfd481ef2020-10-12 06:51:00 -050083 ... Run Keywords Print Timen
George Keishingf9248952021-05-28 07:52:37 -050084 ... The ${image_version} version is installed but not functional, delete and continue update.
Sushil Singhfd481ef2020-10-12 06:51:00 -050085 ... AND
Sushil Singh52859242020-10-09 07:28:22 -050086 ... Run Keyword And Ignore Error
87 ... Delete Software Object /xyz/openbmc_project/software/${image_info['image_id']}
88
Sushil Singh87dcee12019-08-07 13:13:13 -050089 Redfish Update Firmware
90
Sushil Singh8469a482020-07-30 04:19:10 -050091
92Redfish Firmware Update Loop
93 [Documentation] Update the firmware image in loop.
94 [Tags] Redfish_Firmware_Update_Loop
95 [Template] Redfish Firmware Update In Loop
96
97 ${LOOP_COUNT}
98
99
Sushil Singh87dcee12019-08-07 13:13:13 -0500100*** Keywords ***
101
102Suite Setup Execution
103 [Documentation] Do the suite setup.
104
105 Redfish.Login
Sushil Singh87dcee12019-08-07 13:13:13 -0500106 # Delete BMC dump and Error logs.
George Keishingc6475512020-10-06 00:32:10 -0500107 Run Keyword And Ignore Error Delete All BMC Dump
George Keishingc1954452020-10-14 07:44:17 -0500108 Run Keyword And Ignore Error Redfish Delete All BMC Dumps
George Keishing2dac8122020-07-24 02:11:47 -0500109 Run Keyword And Ignore Error Redfish Purge Event Log
Sushil Singh87dcee12019-08-07 13:13:13 -0500110 # Checking for file existence.
111 Valid File Path IMAGE_FILE_PATH
112
Sushil Singh8469a482020-07-30 04:19:10 -0500113
114Redfish Firmware Update In Loop
115 [Documentation] Update the firmware in loop.
116 [Arguments] ${update_loop_count}
117
118 # Description of argument(s):
119 # update_loop_count This value is used to run the firmware update in loop.
120
121 ${before_image_state}= Get BMC Functional Firmware
Sushil Singh53c2dde2020-09-18 05:53:20 -0500122 ${temp_update_loop_count}= Evaluate ${update_loop_count} + 1
Sushil Singh8469a482020-07-30 04:19:10 -0500123
Sushil Singh53c2dde2020-09-18 05:53:20 -0500124 FOR ${count} IN RANGE 1 ${temp_update_loop_count}
Sushil Singh8469a482020-07-30 04:19:10 -0500125 Print Timen **************************************
126 Print Timen * The Current Loop Count is ${count} of ${update_loop_count} *
127 Print Timen **************************************
128 Redfish Update Firmware
129 ${sw_inv}= Get Functional Firmware BMC update
Sushil Singhfd481ef2020-10-12 06:51:00 -0500130 ${nonfunctional_sw_inv}= Get Non Functional Firmware ${sw_inv} False
Sushil Singh8469a482020-07-30 04:19:10 -0500131 Run Keyword If ${nonfunctional_sw_inv['functional']} == False
132 ... Set BMC Image Priority To Least ${nonfunctional_sw_inv['version']} ${nonfunctional_sw_inv}
133 Redfish.Login
134 ${sw_inv}= Get Functional Firmware BMC update
Sushil Singhfd481ef2020-10-12 06:51:00 -0500135 ${nonfunctional_sw_inv}= Get Non Functional Firmware ${sw_inv} False
Sushil Singh8469a482020-07-30 04:19:10 -0500136 Delete BMC Image
137 END
138
139 ${after_image_state}= Get BMC Functional Firmware
140 Valid Value before_image_state["version"] ['${after_image_state["version"]}']
141
142
Sushil Singh8469a482020-07-30 04:19:10 -0500143Delete BMC Image
144 [Documentation] Delete a BMC image from the BMC flash chip.
145
146 ${software_object}= Get Non Running BMC Software Object
147 Delete Image And Verify ${software_object} ${VERSION_PURPOSE_BMC}
148
149
Sushil Singh87dcee12019-08-07 13:13:13 -0500150Activate Existing Firmware
George Keishing16b3c7b2021-01-28 09:23:37 -0600151 [Documentation] Set firmware image to lower priority.
Sushil Singh87dcee12019-08-07 13:13:13 -0500152 [Arguments] ${image_version}
153
154 # Description of argument(s):
155 # image_version Version of image.
156
157 ${software_inventory_record}= Get Software Inventory State By Version
158 ... ${image_version}
159 ${num_keys}= Get Length ${software_inventory_record}
160
161 Rprint Vars software_inventory_record
162
163 # If no software inventory record was found, there is no existing
164 # firmware for the given version and therefore no action to be taken.
165 Return From Keyword If not ${num_keys}
166
167 # Check if the existing firmware is functional.
168 Pass Execution If ${software_inventory_record['functional']}
169 ... The existing ${image_version} firmware is already functional.
170
171 # If existing firmware is not functional, then set the priority to least.
172 Print Timen The existing ${image_version} firmware is not yet functional.
173 Set BMC Image Priority To Least ${image_version} ${software_inventory_record}
174
175 Pass Execution The existing ${image_version} firmware is now functional.
176
177
178Get Image Priority
179 [Documentation] Get Current Image Priority.
180 [Arguments] ${image_version}
181
182 # Description of argument(s):
George Keishing16b3c7b2021-01-28 09:23:37 -0600183 # image_version The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95).
Sushil Singh87dcee12019-08-07 13:13:13 -0500184
185 ${software_info}= Read Properties
186 ... ${SOFTWARE_VERSION_URI}/enumerate quiet=1
187 # Get only the record associated with our image_version.
188
189 ${software_info}= Filter Struct
190 ... ${software_info} [('Version', '${image_version}')]
191 # Convert from dict to list.
192 ${software_info}= Get Dictionary Values ${software_info}
193
194 [Return] ${software_info[0]['Priority']}
195
196
197Set BMC Image Priority To Least
198 [Documentation] Set BMC image priority to least value.
199 [Arguments] ${image_version} ${software_inventory}
200
201 # Description of argument(s):
George Keishing16b3c7b2021-01-28 09:23:37 -0600202 # image_version The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95).
Sushil Singh87dcee12019-08-07 13:13:13 -0500203 # software_inventory Software inventory details.
204
205 ${least_priority}= Get Least Value Priority Image ${VERSION_PURPOSE_BMC}
206 ${cur_priority}= Get Image Priority ${image_version}
207 Rprint Vars least_priority cur_priority
208
209 Return From Keyword If '${least_priority}' == ${cur_priority}
210 Set Host Software Property
211 ... ${SOFTWARE_VERSION_URI}${software_inventory['image_id']}
212 ... Priority ${least_priority}
213
Sushil Singh87dcee12019-08-07 13:13:13 -0500214 Redfish OBMC Reboot (off)
Sushil Singh87dcee12019-08-07 13:13:13 -0500215
216
217Redfish Update Firmware
218 [Documentation] Update the BMC firmware via redfish interface.
219
Sushil Singh6624ce52020-01-22 00:53:41 -0600220 ${post_code_update_actions}= Get Post Boot Action
Sushil Singh87dcee12019-08-07 13:13:13 -0500221 ${state}= Get Pre Reboot State
222 Rprint Vars state
Sushil Singh090eedc2019-11-05 02:04:59 -0600223 Run Keyword And Ignore Error Set ApplyTime policy=OnReset
Sushil Singh6f86f172019-10-30 11:36:25 -0500224 Redfish Upload Image And Check Progress State
Sushil Singh8f48c8f2020-01-16 04:36:25 -0600225 ${tar_version}= Get Version Tar ${IMAGE_FILE_PATH}
226 ${image_info}= Get Software Inventory State By Version ${tar_version}
Sushil Singh8f48c8f2020-01-16 04:36:25 -0600227 Run Key ${post_code_update_actions['${image_info["image_type"]}']['OnReset']}
228 Redfish.Login
229 Redfish Verify BMC Version ${IMAGE_FILE_PATH}
Sushil Singh87dcee12019-08-07 13:13:13 -0500230