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
39*** Test Cases ***
40
41Redfish BMC Code Update
42    [Documentation]  Update the firmware image.
43    [Tags]  Redfish_BMC_Code_Update
44
45    # Python module:  get_version_tar(tar_file_path)
46    ${image_version}=  code_update_utils.Get Version Tar  ${IMAGE_FILE_PATH}
47    Rprint Vars  image_version
48
49    # Python module: get_bmc_release_info()
50    ${bmc_release_info}=  utils.Get BMC Release Info
51    ${functional_version}=  Set Variable  ${bmc_release_info['version_id']}
52    Rprint Vars  functional_version
53
54    ${post_code_update_actions}=  Get Post Boot Action
55    ${state}=  Get Pre Reboot State
56    Rprint Vars  state
57
58    # Check if the existing firmware is functional.
59    Pass Execution If  '${functional_version}' == '${image_version}'
60    ...  The existing ${image_version} firmware is already functional.
61
62    ${sw_inv}=  Get Functional Firmware  BMC image
63    ${nonfunctional_sw_inv}=  Get Non Functional Firmware  ${sw_inv}  False
64
65    # Redfish active software image API.
66    Run Keyword If  ${num_records} > 0
67    ...  Run Keyword If  '${nonfunctional_sw_inv['version']}' == '${image_version}'
68    ...  Set Backup Firmware To Functional  ${image_version}  ${state}
69
70    Print Timen  Performing firmware update ${image_version}.
71
72    Redfish Update Firmware
73
74
75Redfish Firmware Update Loop
76    [Documentation]  Update the firmware image in loop.
77    [Tags]  Redfish_Firmware_Update_Loop
78    [Template]  Redfish Firmware Update In Loop
79
80    ${LOOP_COUNT}
81
82
83*** Keywords ***
84
85Suite Setup Execution
86    [Documentation]  Do the suite setup.
87
88    Redfish.Login
89    # Delete BMC dump and Error logs.
90    Run Keyword And Ignore Error  Redfish Delete All BMC Dumps
91    Run Keyword And Ignore Error  Redfish Purge Event Log
92    # Checking for file existence.
93    Valid File Path  IMAGE_FILE_PATH
94
95    Redfish Power Off  stack_mode=skip
96
97
98Redfish Firmware Update In Loop
99    [Documentation]  Update the firmware in loop.
100    [Arguments]  ${update_loop_count}
101
102    # Description of argument(s):
103    # update_loop_count    This value is used to run the firmware update in loop.
104
105    ${before_image_state}=  Get BMC Functional Firmware
106    ${temp_update_loop_count}=  Evaluate  ${update_loop_count} + 1
107
108    FOR  ${count}  IN RANGE  1  ${temp_update_loop_count}
109      Print Timen  **************************************
110      Print Timen  * The Current Loop Count is ${count} of ${update_loop_count} *
111      Print Timen  **************************************
112      Redfish Update Firmware
113      ${sw_inv}=  Get Functional Firmware  BMC update
114      ${nonfunctional_sw_inv}=  Get Non Functional Firmware  ${sw_inv}  False
115      Run Keyword If  ${nonfunctional_sw_inv['functional']} == False
116      ...  Set BMC Image Priority To Least  ${nonfunctional_sw_inv['version']}  ${nonfunctional_sw_inv}
117      Redfish.Login
118      ${sw_inv}=  Get Functional Firmware  BMC update
119      ${nonfunctional_sw_inv}=  Get Non Functional Firmware  ${sw_inv}  False
120      Delete BMC Image
121    END
122
123    ${after_image_state}=  Get BMC Functional Firmware
124    Valid Value  before_image_state["version"]  ['${after_image_state["version"]}']
125
126
127Delete BMC Image
128    [Documentation]  Delete a BMC image from the BMC flash chip.
129
130    ${software_object}=  Get Non Running BMC Software Object
131    Delete Image And Verify  ${software_object}  ${VERSION_PURPOSE_BMC}
132
133
134Activate Existing Firmware
135    [Documentation]  Set firmware image to lower priority.
136    [Arguments]  ${image_version}
137
138    # Description of argument(s):
139    # image_version     Version of image.
140
141    ${software_inventory_record}=  Get Software Inventory State By Version
142    ...  ${image_version}
143    ${num_keys}=  Get Length  ${software_inventory_record}
144
145    Rprint Vars  software_inventory_record
146
147    # If no software inventory record was found, there is no existing
148    # firmware for the given version and therefore no action to be taken.
149    Return From Keyword If  not ${num_keys}
150
151    # Check if the existing firmware is functional.
152    Pass Execution If  ${software_inventory_record['functional']}
153    ...  The existing ${image_version} firmware is already functional.
154
155    # If existing firmware is not functional, then set the priority to least.
156    Print Timen  The existing ${image_version} firmware is not yet functional.
157    Set BMC Image Priority To Least  ${image_version}  ${software_inventory_record}
158
159    Pass Execution  The existing ${image_version} firmware is now functional.
160
161
162Get Image Priority
163    [Documentation]  Get Current Image Priority.
164    [Arguments]  ${image_version}
165
166    # Description of argument(s):
167    # image_version       The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95).
168
169    ${software_info}=  Read Properties
170    ...  ${SOFTWARE_VERSION_URI}/enumerate  quiet=1
171    # Get only the record associated with our image_version.
172
173    ${software_info}=  Filter Struct
174    ...  ${software_info}  [('Version', '${image_version}')]
175    # Convert from dict to list.
176    ${software_info}=  Get Dictionary Values  ${software_info}
177
178    [Return]  ${software_info[0]['Priority']}
179
180
181Set BMC Image Priority To Least
182    [Documentation]  Set BMC image priority to least value.
183    [Arguments]  ${image_version}  ${software_inventory}
184
185    # Description of argument(s):
186    # image_version       The Firmware image version (e.g. 2.8.0-dev-1107-g512028d95).
187    # software_inventory  Software inventory details.
188
189    ${least_priority}=  Get Least Value Priority Image  ${VERSION_PURPOSE_BMC}
190    ${cur_priority}=  Get Image Priority  ${image_version}
191    Rprint Vars  least_priority  cur_priority
192
193    Return From Keyword If  '${least_priority}' == ${cur_priority}
194    Set Host Software Property
195    ...  ${SOFTWARE_VERSION_URI}${software_inventory['image_id']}
196    ...  Priority  ${least_priority}
197
198    Redfish OBMC Reboot (off)
199
200
201Set Backup Firmware To Functional
202    [Documentation]  Set the backup firmware to functional.
203    [Arguments]  ${image_version}  ${state}
204
205    # Description of argument(s):
206    # image_version     Version of image.
207    # state             Pre reboot state.
208
209    Print Timen  Switch to back up and rebooting.
210    Switch Backup Firmware Image To Functional
211    Wait For Reboot  start_boot_seconds=${state['epoch_seconds']}
212    Redfish Verify BMC Version  ${IMAGE_FILE_PATH}
213    Pass Execution  The backup firmware image ${image_version} is now functional.
214
215
216Redfish Update Firmware
217    [Documentation]  Update the BMC firmware via redfish interface.
218
219    ${post_code_update_actions}=  Get Post Boot Action
220    ${state}=  Get Pre Reboot State
221    Rprint Vars  state
222    Run Keyword And Ignore Error  Set ApplyTime  policy=OnReset
223    Redfish Upload Image And Check Progress State
224    ${tar_version}=  Get Version Tar  ${IMAGE_FILE_PATH}
225    ${image_info}=  Get Software Inventory State By Version  ${tar_version}
226    Run Key  ${post_code_update_actions['${image_info["image_type"]}']['OnReset']}
227    Redfish.Login
228    Redfish Verify BMC Version  ${IMAGE_FILE_PATH}
229
230