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    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
88    FOR  ${count}  IN RANGE  ${update_loop_count}
89      Print Timen  **************************************
90      Print Timen  * The Current Loop Count is ${count} of ${update_loop_count} *
91      Print Timen  **************************************
92      Redfish Update Firmware
93      ${sw_inv}=  Get Functional Firmware  BMC update
94      ${nonfunctional_sw_inv}=  Get Non Fucntional Firmware  ${sw_inv}  False
95      Run Keyword If  ${nonfunctional_sw_inv['functional']} == False
96      ...  Set BMC Image Priority To Least  ${nonfunctional_sw_inv['version']}  ${nonfunctional_sw_inv}
97      Redfish.Login
98      ${sw_inv}=  Get Functional Firmware  BMC update
99      ${nonfunctional_sw_inv}=  Get Non Fucntional Firmware  ${sw_inv}  False
100      Delete BMC Image
101    END
102
103    ${after_image_state}=  Get BMC Functional Firmware
104    Valid Value  before_image_state["version"]  ['${after_image_state["version"]}']
105
106
107Get BMC Functional Firmware
108    [Documentation]  Get BMC functional firmware details.
109
110    ${sw_inv}=  Get Functional Firmware  BMC update
111    ${sw_inv}=  Get Non Fucntional Firmware  ${sw_inv}  True
112
113    [Return]  ${sw_inv}
114
115
116Get Functional Firmware
117    [Documentation]  Get all the BMC firmware details.
118    [Arguments]  ${image_type}
119
120    # Description of argument(s):
121    # image_type    Image value can be either BMC update or Host update.
122
123    ${software_inventory}=  Get Software Inventory State
124    ${bmc_inv}=  Get BMC Firmware  ${image_type}  ${software_inventory}
125
126    [Return]  ${bmc_inv}
127
128
129Get Non Fucntional Firmware
130    [Documentation]  Get BMC non functional fimware details.
131    [Arguments]  ${sw_inv}  ${functional_sate}
132
133    # Description of argument(s):
134    # sw_inv           This dictionay contains all the BMC fimware details.
135    # functional_sate  Functional state can be either True or False.
136
137    ${resp}=  Filter Struct  ${sw_inv}  [('functional', ${functional_sate})]
138    ${list_inv_dict}=  Get Dictionary Values  ${resp}
139
140    [Return]  ${list_inv_dict}[0]
141
142
143Delete BMC Image
144    [Documentation]  Delete a BMC image from the BMC flash chip.
145
146    ${software_object}=  Get Non Running BMC Software Object
147    Delete Image And Verify  ${software_object}  ${VERSION_PURPOSE_BMC}
148
149
150Activate Existing Firmware
151    [Documentation]  Set fimware image to lower priority.
152    [Arguments]  ${image_version}
153
154    # Description of argument(s):
155    # image_version     Version of image.
156
157    ${software_inventory_record}=  Get Software Inventory State By Version
158    ...  ${image_version}
159    ${num_keys}=  Get Length  ${software_inventory_record}
160
161    Rprint Vars  software_inventory_record
162
163    # If no software inventory record was found, there is no existing
164    # firmware for the given version and therefore no action to be taken.
165    Return From Keyword If  not ${num_keys}
166
167    # Check if the existing firmware is functional.
168    Pass Execution If  ${software_inventory_record['functional']}
169    ...  The existing ${image_version} firmware is already functional.
170
171    # If existing firmware is not functional, then set the priority to least.
172    Print Timen  The existing ${image_version} firmware is not yet functional.
173    Set BMC Image Priority To Least  ${image_version}  ${software_inventory_record}
174
175    Pass Execution  The existing ${image_version} firmware is now functional.
176
177
178Get Image Priority
179    [Documentation]  Get Current Image Priority.
180    [Arguments]  ${image_version}
181
182    # Description of argument(s):
183    # image_version       The Fimware image version (e.g. 2.8.0-dev-1107-g512028d95).
184
185    ${software_info}=  Read Properties
186    ...  ${SOFTWARE_VERSION_URI}/enumerate  quiet=1
187    # Get only the record associated with our image_version.
188
189    ${software_info}=  Filter Struct
190    ...  ${software_info}  [('Version', '${image_version}')]
191    # Convert from dict to list.
192    ${software_info}=  Get Dictionary Values  ${software_info}
193
194    [Return]  ${software_info[0]['Priority']}
195
196
197Set BMC Image Priority To Least
198    [Documentation]  Set BMC image priority to least value.
199    [Arguments]  ${image_version}  ${software_inventory}
200
201    # Description of argument(s):
202    # image_version       The Fimware image version (e.g. 2.8.0-dev-1107-g512028d95).
203    # software_inventory  Software inventory details.
204
205    ${least_priority}=  Get Least Value Priority Image  ${VERSION_PURPOSE_BMC}
206    ${cur_priority}=  Get Image Priority  ${image_version}
207    Rprint Vars  least_priority  cur_priority
208
209    Return From Keyword If  '${least_priority}' == ${cur_priority}
210    Set Host Software Property
211    ...  ${SOFTWARE_VERSION_URI}${software_inventory['image_id']}
212    ...  Priority  ${least_priority}
213
214    Redfish OBMC Reboot (off)
215
216
217Redfish Update Firmware
218    [Documentation]  Update the BMC firmware via redfish interface.
219
220    ${post_code_update_actions}=  Get Post Boot Action
221    ${state}=  Get Pre Reboot State
222    Rprint Vars  state
223    Run Keyword And Ignore Error  Set ApplyTime  policy=OnReset
224    Redfish Upload Image And Check Progress State
225    ${tar_version}=  Get Version Tar  ${IMAGE_FILE_PATH}
226    ${image_info}=  Get Software Inventory State By Version  ${tar_version}
227    Run Key  ${post_code_update_actions['${image_info["image_type"]}']['OnReset']}
228    Redfish.Login
229    Redfish Verify BMC Version  ${IMAGE_FILE_PATH}
230
231