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