1*** Settings ***
2Documentation            Update firmware 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/dump_utils.robot
18Resource                 ../../lib/logging_utils.robot
19Resource                 ../../lib/redfish_code_update_utils.robot
20Resource                 ../../lib/utils.robot
21Resource                 ../../lib/bmc_redfish_utils.robot
22Resource                 ../../lib/external_intf/management_console_utils.robot
23Resource                 ../../lib/bmc_network_utils.robot
24Resource                 ../../lib/certificate_utils.robot
25Library                  ../../lib/gen_robot_valid.py
26Library                  ../../lib/tftp_update_utils.py
27Library                  ../../lib/gen_robot_keyword.py
28
29Suite Setup              Suite Setup Execution
30Suite Teardown           Redfish.Logout
31Test Setup               Printn
32Test Teardown            FFDC On Test Case Fail
33
34Force Tags               Redfish_Bmc_Code_Update
35
36*** Variables ***
37
38@{ADMIN}                 admin_user  TestPwd123
39&{USERS}                 Administrator=${ADMIN}
40${LOOP_COUNT}            ${2}
41@{HOSTNAME}              bmc_system01  bmc_system02  bmc_system03  bmc_system04  bmc_system05
42
43*** Test Cases ***
44
45Redfish Code Update With ApplyTime OnReset
46    [Documentation]  Update the firmware image with ApplyTime of OnReset.
47    [Tags]  Redfish_Code_Update_With_ApplyTime_OnReset
48    [Template]  Redfish Update Firmware
49
50    # policy
51    OnReset
52
53
54Redfish Code Update With ApplyTime Immediate
55    [Documentation]  Update the firmware image with ApplyTime of Immediate.
56    [Tags]  Redfish_Code_Update_With_ApplyTime_Immediate
57    [Template]  Redfish Update Firmware
58
59    # policy
60    Immediate
61
62
63Redfish Code Update Same Firmware Multiple Times
64    [Documentation]  Multiple times update the firmware image for update service.
65    [Tags]  Redfish_Code_Update_Same_Firmware_Multiple_Times
66
67    ${temp_update_loop_count}=  Evaluate  ${LOOP_COUNT} + 1
68
69    FOR  ${count}  IN RANGE  1  ${temp_update_loop_count}
70       Print Timen  ***************************************
71       Print Timen  * The Current Loop Count is ${count} of ${LOOP_COUNT} *
72       Print Timen  ***************************************
73
74       Redfish Update Firmware  apply_time=OnReset
75    END
76
77
78
79Redfish Code Update With Multiple Firmware
80    [Documentation]  Update the firmware image with ApplyTime of Immediate.
81    [Tags]  Redfish_Code_Update_With_Multiple_Firmware
82    [Template]  Redfish Multiple Upload Image And Check Progress State
83
84    # policy   image_file_path     alternate_image_file_path
85    OnReset  ${IMAGE_FILE_PATH}  ${ALTERNATE_IMAGE_FILE_PATH}
86
87
88Post BMC Reset Perform Redfish Code Update
89    [Documentation]  Test to reset BMC at standby and then perform BMC firmware update and
90    ...              ensure there is not error or dump logs post update.
91    [Tags]  Post_BMC_Reset_Perform_Redfish_Code_Update
92
93    Redfish Delete All BMC Dumps
94    Redfish Purge Event Log
95
96    Redfish OBMC Reboot (off)
97
98    Redfish Update Firmware  apply_time=OnReset
99
100    Event Log Should Not Exist
101    Redfish BMC Dump Should Not Exist
102
103    Redfish Power Off
104
105
106Post BMC Reset Perform Image Switched To Backup Multiple Times
107    [Documentation]  Test to reset BMC at standby and then perform switch
108    ...              to backup image multiple times.
109    ...              Then ensure no event and dump logs exist.
110    [Tags]  Post_BMC_Reset_Perform_Image_Switched_To_Backup_Multiple_Times
111
112    Redfish Delete All BMC Dumps
113    Redfish Purge Event Log
114
115    Redfish OBMC Reboot (off)
116
117    ${temp_update_loop_count}=  Evaluate  ${LOOP_COUNT} + 1
118
119    FOR  ${count}  IN RANGE  1  ${temp_update_loop_count}
120      ${state}=  Get Pre Reboot State
121
122      # change to backup image and reset the BMC.
123      Switch Backup Firmware Image To Functional
124
125      Wait For Reboot  start_boot_seconds=${state['epoch_seconds']}
126    END
127
128    Event Log Should Not Exist
129    Redfish BMC Dump Should Not Exist
130
131
132Verify If The Modified Admin Credential Is Valid Post Image Switched To Backup
133    [Documentation]  Verify updated admin credential remain same post switch to back up image.
134    [Tags]  Verify_If_The_Modified_Admin_Credential_Is_Valid_Post_Image_Switched_To_Backup
135    [Setup]  Create Users With Different Roles  users=${USERS}  force=${True}
136    [Teardown]  Run Keywords  Redfish.Login  AND  Delete BMC Users Via Redfish  users=${USERS}
137
138    ${post_code_update_actions}=  Get Post Boot Action
139    ${state}=  Get Pre Reboot State
140    Expire And Update New Password Via Redfish  ${ADMIN[0]}  ${ADMIN[1]}  0penBmc123
141
142    Redfish.Login
143    # change to backup image and reset the BMC.
144    Switch Backup Firmware Image To Functional
145    Wait For Reboot  start_boot_seconds=${state['epoch_seconds']}
146
147    # verify modified admin password on backup image.
148    Redfish.Login  admin_user  0penBmc123
149    Redfish.Logout
150
151
152Verify If The Modified Admin Credential Is Valid Post Update
153    [Documentation]  Verify updated admin credential remain same post code update image.
154    [Tags]  Verify_If_The_Modified_Admin_Credential_Is_Valid_Post_Update
155    [Setup]  Create Users With Different Roles  users=${USERS}  force=${True}
156    [Teardown]  Run Keywords  Redfish.Login  AND  Delete BMC Users Via Redfish  users=${USERS}
157
158    Expire And Update New Password Via Redfish  ${ADMIN[0]}  ${ADMIN[1]}  0penBmc123
159
160    Redfish.Login
161    # Flash latest firmware using redfish.
162    Redfish Update Firmware  OnReset
163
164    # verify modified admin credentails on latest image.
165    Redfish.Login  admin_user  0penBmc123
166    Redfish.Logout
167
168
169Redfish Code Update With Different Interrupted Operation
170    [Documentation]  Ensure firmware update is successful when different interrupted operation executed
171    ...              i.e. change the hostname, updating https certificate and firmware update fail
172    ...              when kernel panic.
173    [Tags]  Redfish_Code_Update_With_Different_Interrupted_Operation
174    [Template]  Verify Redfish Code Update With Different Interrupted Operation
175
176    # operation          count
177    host_name            1
178    kernel_panic         1
179    https_certificate    1
180
181*** Keywords ***
182
183Suite Setup Execution
184    [Documentation]  Do the suite setup.
185
186    Valid File Path  IMAGE_FILE_PATH
187    Redfish.Login
188
189    Redfish Delete All BMC Dumps
190    Redfish Purge Event Log
191
192    Redfish Power Off  stack_mode=skip
193
194
195Get Redfish Update Service URI
196    [Documentation]  Get Redfish firmware update URI.
197
198    ${update_url}=  Redfish.Get Attribute  ${REDFISH_BASE_URI}UpdateService  HttpPushUri
199
200    Log To Console  Firmware update URI: ${update_url}
201
202    [Return]  ${update_url}
203
204
205Redfish Multiple Upload Image And Check Progress State
206    [Documentation]  Update multiple BMC firmware via redfish interface and check status.
207    [Arguments]  ${apply_time}  ${IMAGE_FILE_PATH}  ${ALTERNATE_IMAGE_FILE_PATH}
208
209    # Description of argument(s):
210    # apply_time                 ApplyTime allowed values (e.g. "OnReset", "Immediate").
211    # IMAGE_FILE_PATH            The path to BMC image file.
212    # ALTERNATE_IMAGE_FILE_PATH  The path to alternate BMC image file.
213
214
215    ${task_inv_dict}=  Get Task State from File
216
217    ${post_code_update_actions}=  Get Post Boot Action
218
219    Valid File Path  ALTERNATE_IMAGE_FILE_PATH
220
221    ${state}=  Get Pre Reboot State
222    Rprint Vars  state
223
224    Set ApplyTime  policy=${apply_time}
225
226    # URI : /redfish/v1/UpdateService
227    # "HttpPushUri": "/redfish/v1/UpdateService/update",
228
229    ${redfish_update_uri}=  Get Redfish Update Service URI
230
231    ${file_bin_data1}=  OperatingSystem.Get Binary File  ${IMAGE_FILE_PATH}
232    ${file_bin_data2}=  OperatingSystem.Get Binary File  ${ALTERNATE_IMAGE_FILE_PATH}
233
234    Log To Console  Uploading first image.
235    ${resp1}=  Upload Image To BMC  ${redfish_update_uri}  timeout=${600}  data=${file_bin_data1}
236
237    Log To Console  Uploading second image.
238    ${resp2}=  Upload Image To BMC  ${redfish_update_uri}  timeout=${600}  data=${file_bin_data2}
239
240    ${task_info2}=    evaluate    json.loads('''${resp2.content}''')    json
241
242    Sleep  3s
243
244    ${task_inv2}=  Get Task Inventory  ${task_info2}
245    Log  ${task_inv2}
246
247    Wait Until Keyword Succeeds  5 min  10 sec
248    ...  Verify Task Progress State  ${task_inv2}  ${task_inv_dict['TaskException']}
249
250    ${task_info1}=    evaluate    json.loads('''${resp1.content}''')    json
251    Log  ${task_info1}
252
253    ${task_inv1}=  Get Task Inventory  ${task_info1}
254    Log  ${task_inv1}
255
256    Wait Until Keyword Succeeds  5 min  10 sec
257    ...  Verify Task Progress State  ${task_inv1}  ${task_inv_dict['TaskCompleted']}
258
259    Run Key  ${post_code_update_actions['BMC image']['${apply_time}']}
260    Redfish.Login
261    Redfish Verify BMC Version  ${IMAGE_FILE_PATH}
262
263
264Run Configure BMC Hostname In Loop
265    [Documentation]  Update hostname in loop.
266    [Arguments]  ${count}
267
268    # Description of argument(s):
269    # count    Loop count.
270
271    FOR  ${index}  IN RANGE  ${count}
272      Configure Hostname  hostname=${HOSTNAME}[${index}]  status_code=[${HTTP_OK}]
273    END
274
275
276Redfish Update Certificate Upload In Loop
277    [Documentation]  Upload HTTPS server certificate via Redfish and verify using OpenSSL.
278    [Arguments]  ${count}
279
280    # Description of argument(s):
281    # count    Loop count.
282
283    FOR  ${index}  IN RANGE  ${count}
284      ${resp}=  Run Keyword And Return Status  Redfish.Get  ${REDFISH_HTTPS_CERTIFICATE_URI}/1  valid_status_codes=[${HTTP_OK}]
285      Should Be Equal As Strings  ${resp}  ${True}
286
287      ${cert_file_path}=  Generate Certificate File Via Openssl  Valid Certificate Valid Privatekey
288      ${bytes}=  OperatingSystem.Get Binary File  ${cert_file_path}
289      ${file_data}=  Decode Bytes To String  ${bytes}  UTF-8
290
291      ${certificate_dict}=  Create Dictionary
292      ...  @odata.id=${REDFISH_HTTPS_CERTIFICATE_URI}/1
293      ${payload}=  Create Dictionary  CertificateString=${file_data}
294      ...  CertificateType=PEM  CertificateUri=${certificate_dict}
295
296      ${resp}=  Redfish.Post  /redfish/v1/CertificateService/Actions/CertificateService.ReplaceCertificate
297      ...  body=${payload}
298
299      Verify Certificate Visible Via OpenSSL  ${cert_file_path}
300    END
301
302
303Run Operation On BMC
304    [Documentation]  Run operation on BMC.
305    [Arguments]  ${operation}  ${count}
306
307    # Description of argument(s):
308    # operation    If host_name then change hostname.
309    # count        Loop count.
310
311    Run Keyword If  '${operation}' == 'host_name'
312    ...    Run Configure BMC Hostname In Loop  count=${count}
313    ...  ELSE IF  '${operation}' == 'kernel_panic'
314    ...    Run Keywords  Kernel Panic BMC Reset Operation  AND
315    ...    Is BMC Unpingable
316    ...  ELSE IF  '${operation}' == 'https_certificate'
317    ...    Redfish Update Certificate Upload In Loop  count=${count}
318    ...  ELSE
319    ...    Fail  msg=Operation not handled.
320
321
322Get Active Firmware Image
323    [Documentation]  Return get active firmware image.
324
325    ${active_image}=  Redfish.Get Attribute  /redfish/v1/Managers/${MANAGER_ID}  Links
326    Rprint Vars  active_image
327
328    [Return]  ${active_image}
329
330
331Get New Image ID
332    [Documentation]  Return the ID of the most recently extracted image.
333
334    ${image_id}=   Get Image Id   Updating
335
336    [Return]  ${image_id}
337
338
339Verify Redfish Code Update With Different Interrupted Operation
340    [Documentation]  Verify code update is successful when other operation
341    ...              getting executed i.e. change the hostname, updating http certificate
342    ...              and code update will fail for kernel panic.
343    [Arguments]  ${operation}  ${count}
344
345    # Description of argument(s):
346    # operation    host_name to change Hostname, kernel_panic to perform kernel panic.
347    # count        Number of times loop will get executed.
348
349    ${before_update_activeswimage}=  Get Active Firmware Image
350
351    ${post_code_update_actions}=  Get Post Boot Action
352
353    Set ApplyTime  policy=OnReset
354
355    ${task_inv_dict}=  Get Task State from File
356
357    ${file_bin_data}=  OperatingSystem.Get Binary File  ${image_file_path}
358
359    Log To Console   Start uploading image to BMC.
360
361    # URI : /redfish/v1/UpdateService
362    # "HttpPushUri": "/redfish/v1/UpdateService/update",
363
364    ${redfish_update_uri}=  Get Redfish Update Service URI
365    Upload Image To BMC  ${redfish_update_uri}  timeout=${600}  data=${file_bin_data}
366    Log To Console   Completed image upload to BMC.
367
368    Sleep  5
369
370    ${image_id}=  Get New Image ID
371    Rprint Vars  image_id
372
373    ${task_inv}=  Check Task With Match TargetUri  ${redfish_update_uri}
374    Rprint Vars  task_inv
375
376    Wait Until Keyword Succeeds  2 min  10 sec
377    ...  Verify Task Progress State  ${task_inv}  ${task_inv_dict['TaskStarting']}
378
379    Run Operation On BMC  ${operation}  ${count}
380
381    IF  '${operation}' == 'kernel_panic'
382        Wait Until Keyword Succeeds  10 min  10 sec  Is BMC Standby
383    ELSE IF  '${operation}' == 'host_name'
384        Wait Until Keyword Succeeds  5 min  10 sec
385        ...  Verify Task Progress State  ${task_inv}  ${task_inv_dict['TaskCompleted']}
386        Run Key  ${post_code_update_actions['BMC image']['OnReset']}
387        Redfish Verify BMC Version  ${IMAGE_FILE_PATH}
388    ELSE IF  '${operation}' == 'https_certificate'
389        Check Image Update Progress State
390        ...  match_state='Updating'  image_id=${image_id}
391        Wait Until Keyword Succeeds  8 min  20 sec
392        ...  Check Image Update Progress State
393        ...  match_state='Enabled'  image_id=${image_id}
394        Run Key  ${post_code_update_actions['BMC image']['OnReset']}
395        Redfish Verify BMC Version  ${IMAGE_FILE_PATH}
396    ELSE
397        Fail  msg=Operation not handled.
398    END
399
400    ${after_update_activeswimage}=  Get Active Firmware Image
401
402    ${status}=  Run Keyword And Return Status  Should Be Equal As Strings
403    ...  ${before_update_activeswimage['ActiveSoftwareImage']['@odata.id']}
404    ...  ${after_update_activeswimage['ActiveSoftwareImage']['@odata.id']}
405
406    Run Keyword If  '${operation}' == 'kernel_panic'
407    ...    Should Be True  ${status}
408    ...  ELSE
409    ...    Should Not Be True  ${status}
410
411    Verify Get ApplyTime  OnReset
412
413