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}            ${20}
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 Firmware Update Loop
79    [Documentation]  Update the firmware image in loop.
80    [Tags]  Redfish_Firmware_Update_Loop
81    [Template]  Redfish Firmware Update In Loop
82
83    ${LOOP_COUNT}
84
85
86*** Keywords ***
87
88Suite Setup Execution
89    [Documentation]  Do the suite setup.
90
91    Redfish.Login
92    # Delete BMC dump and Error logs.
93    Run Keyword And Ignore Error  Redfish Delete All BMC Dumps
94    Run Keyword If  ${DELETE_ERRLOGS} == ${1}
95    ...   Run Keyword And Ignore Error  Redfish Purge Event Log
96    # Checking for file existence.
97    Valid File Path  IMAGE_FILE_PATH
98
99    Redfish Power Off  stack_mode=skip
100
101
102Redfish Firmware Update In Loop
103    [Documentation]  Update the firmware in loop.
104    [Arguments]  ${update_loop_count}
105
106    # Description of argument(s):
107    # update_loop_count    This value is used to run the firmware update in loop.
108
109    ${before_image_state}=  Get BMC Functional Firmware
110    ${temp_update_loop_count}=  Evaluate  ${update_loop_count} + 1
111
112    FOR  ${count}  IN RANGE  1  ${temp_update_loop_count}
113      Print Timen  **************************************
114      Print Timen  * The Current Loop Count is ${count} of ${update_loop_count} *
115      Print Timen  **************************************
116      Redfish Update Firmware
117      ${sw_inv}=  Get Functional Firmware  BMC update
118      ${nonfunctional_sw_inv}=  Get Non Functional Firmware  ${sw_inv}  False
119      Run Keyword If  ${nonfunctional_sw_inv['functional']} == False
120      ...  Set BMC Image Priority To Least  ${nonfunctional_sw_inv['version']}  ${nonfunctional_sw_inv}
121      Redfish.Login
122      ${sw_inv}=  Get Functional Firmware  BMC update
123      ${nonfunctional_sw_inv}=  Get Non Functional Firmware  ${sw_inv}  False
124      Delete BMC Image
125    END
126
127    ${after_image_state}=  Get BMC Functional Firmware
128    Valid Value  before_image_state["version"]  ['${after_image_state["version"]}']
129
130
131Delete BMC Image
132    [Documentation]  Delete a BMC image from the BMC flash chip.
133
134    ${software_object}=  Get Non Running BMC Software Object
135    Delete Image And Verify  ${software_object}  ${VERSION_PURPOSE_BMC}
136
137
138Activate Existing Firmware
139    [Documentation]  Set firmware image to lower priority.
140    [Arguments]  ${image_version}
141
142    # Description of argument(s):
143    # image_version     Version of image.
144
145    ${software_inventory_record}=  Get Software Inventory State By Version
146    ...  ${image_version}
147    ${num_keys}=  Get Length  ${software_inventory_record}
148
149    Rprint Vars  software_inventory_record
150
151    # If no software inventory record was found, there is no existing
152    # firmware for the given version and therefore no action to be taken.
153    Return From Keyword If  not ${num_keys}
154
155    # Check if the existing firmware is functional.
156    Pass Execution If  ${software_inventory_record['functional']}
157    ...  The existing ${image_version} firmware is already functional.
158
159    # If existing firmware is not functional, then set the priority to least.
160    Print Timen  The existing ${image_version} firmware is not yet functional.
161    Set BMC Image Priority To Least  ${image_version}  ${software_inventory_record}
162
163    Pass Execution  The existing ${image_version} firmware is now functional.
164
165
166Get Image Priority
167    [Documentation]  Get Current Image Priority.
168    [Arguments]  ${image_version}
169
170    # Description of argument(s):
171    # image_version       The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95).
172
173    ${software_info}=  Read Properties
174    ...  ${SOFTWARE_VERSION_URI}/enumerate  quiet=1
175    # Get only the record associated with our image_version.
176
177    ${software_info}=  Filter Struct
178    ...  ${software_info}  [('Version', '${image_version}')]
179    # Convert from dict to list.
180    ${software_info}=  Get Dictionary Values  ${software_info}
181
182    [Return]  ${software_info[0]['Priority']}
183
184
185Set BMC Image Priority To Least
186    [Documentation]  Set BMC image priority to least value.
187    [Arguments]  ${image_version}  ${software_inventory}
188
189    # Description of argument(s):
190    # image_version       The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95).
191    # software_inventory  Software inventory details.
192
193    ${least_priority}=  Get Least Value Priority Image  ${VERSION_PURPOSE_BMC}
194    ${cur_priority}=  Get Image Priority  ${image_version}
195    Rprint Vars  least_priority  cur_priority
196
197    Return From Keyword If  '${least_priority}' == ${cur_priority}
198    Set Host Software Property
199    ...  ${SOFTWARE_VERSION_URI}${software_inventory['image_id']}
200    ...  Priority  ${least_priority}
201
202    Redfish OBMC Reboot (off)
203
204
205Set Backup Firmware To Functional
206    [Documentation]  Set the backup firmware to functional.
207    [Arguments]  ${image_version}  ${state}
208
209    # Description of argument(s):
210    # image_version     Version of image.
211    # state             Pre reboot state.
212
213    Print Timen  Switch to back up and rebooting.
214    Switch Backup Firmware Image To Functional
215    Wait For Reboot  start_boot_seconds=${state['epoch_seconds']}
216    Redfish Verify BMC Version  ${IMAGE_FILE_PATH}
217    Pass Execution  The backup firmware image ${image_version} is now functional.
218
219
220Redfish Update Firmware
221    [Documentation]  Update the BMC firmware via redfish interface.
222
223    ${post_code_update_actions}=  Get Post Boot Action
224    ${state}=  Get Pre Reboot State
225    Rprint Vars  state
226    Run Keyword And Ignore Error  Set ApplyTime  policy=OnReset
227
228    # Python module:  get_member_list(resource_path)
229    ${before_inv_list}=  redfish_utils.Get Member List  /redfish/v1/UpdateService/FirmwareInventory
230    Log To Console   Current images on the BMC before upload: ${before_inv_list}
231
232    Log To Console   Start uploading image to BMC.
233    Redfish Upload Image  /redfish/v1/UpdateService  ${IMAGE_FILE_PATH}
234    Log To Console   Completed image upload to BMC.
235
236    # Python module:  get_member_list(resource_path)
237    ${after_inv_list}=  redfish_utils.Get Member List  /redfish/v1/UpdateService/FirmwareInventory
238    Log To Console  Current images on the BMC after upload: ${after_inv_list}
239
240    ${image_id}=  Evaluate  set(${after_inv_list}) - set(${before_inv_list})
241    Should Not Be Empty    ${image_id}
242    ${image_id}=  Evaluate  list(${image_id})[0].split('/')[-1]
243    Log To Console  Firmware installation in progress with image id:: ${image_id}
244
245    Wait Until Keyword Succeeds  ${ACTIVATION_WAIT_TIMEOUT}  10 sec
246    ...  Check Image Update Progress State  match_state='Enabled'  image_id=${image_id}
247
248    # Python module:  get_version_tar(tar_file_path)
249    ${tar_version}=  code_update_utils.Get Version Tar  ${IMAGE_FILE_PATH}
250    ${image_info}=  Get Software Inventory State By Version  ${tar_version}
251
252    Run Key  ${post_code_update_actions['${image_info["image_type"]}']['OnReset']}
253    Redfish.Login
254    Redfish Verify BMC Version  ${IMAGE_FILE_PATH}
255
256