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