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