1*** Settings ***
2Documentation     Update the BMC code on a target BMC.
3...               Execution Method:
4...               python -m robot -v OPENBMC_HOST:<hostname>
5...               -v IMAGE_FILE_PATH:<path/*.tar>  bmc_code_update.robot
6
7Library           ../../lib/code_update_utils.py
8Library           ../../lib/gen_robot_keyword.py
9Variables         ../../data/variables.py
10Resource          ../../lib/utils.robot
11Resource          ../../lib/boot_utils.robot
12Resource          code_update_utils.robot
13Resource          ../../lib/code_update_utils.robot
14Resource          ../../lib/openbmc_ffdc.robot
15Resource          ../../lib/dump_utils.robot
16Resource          ../../lib/certificate_utils.robot
17
18Suite Setup       Suite Setup Execution
19
20Test Teardown     Test Teardown Execution
21
22# Force the test to timedout to prevent test hanging.
23Test Timeout      30 minutes
24
25Force Tags        BMC_Code_Update
26
27*** Variables ***
28
29${QUIET}                          ${1}
30${IMAGE_FILE_PATH}                ${EMPTY}
31${ALTERNATE_IMAGE_FILE_PATH}      ${EMPTY}
32${SKIP_UPDATE_IF_ACTIVE}          false
33${dump_id}                        ${EMPTY}
34${running_persistence_test}       ${FALSE}
35${test_errlog_text}               AutoTestSimple
36
37*** Test Cases ***
38
39Test Basic BMC Performance Before BMC Code Update
40    [Documentation]  Check performance of memory, CPU & file system of BMC.
41    [Tags]  Test_Basic_BMC_Performance_Before_BMC_Code_Update
42
43    Open Connection And Log In
44    Check BMC Performance
45
46Prepare Persistent Data
47    [Documentation]  Set data that should persist across the code update.
48    [Tags]  Prepare_Persistent_Data
49
50    # Install the debug tarball.
51    BMC Execute Command  rm -rf /tmp/tarball
52    Install Debug Tarball On BMC  tarball_file_path=${DEBUG_TARBALL_PATH}
53
54    # Create a dummy error log and dump.
55    BMC Execute Command  /tmp/tarball/bin/logging-test -c ${test_errlog_text}
56    ${dump_id}=  Create User Initiated Dump
57    Check Dump Existence  ${dump_id}
58    Set Suite Variable  ${dump_id}
59
60    # Set persistent settings.
61    ${autoreboot_dict}=  Create Dictionary  data=${0}
62    Write Attribute  ${CONTROL_HOST_URI}auto_reboot  AutoReboot
63    ...  data=${autoreboot_dict}
64    ${onetime_dict}=  Create Dictionary  data=${0}
65    Write Attribute  ${CONTROL_HOST_URI}boot/one_time  Enabled
66    ...  data=${onetime_dict}
67
68    # Let the remaining test cases know we are doing a persistence test so we
69    # do not delete logs.
70    Set Suite Variable  ${running_persistence_test}  ${TRUE}
71
72
73REST BMC Code Update
74    [Documentation]  Do a BMC code update by uploading image on BMC via REST.
75    [Tags]  REST_BMC_Code_Update
76    [Teardown]  REST BMC Code Update Teardown
77
78    Run Keyword And Ignore Error  List Installed Images  BMC
79    Run Keyword And Ignore Error  Set ApplyTime  policy=OnReset
80
81    ${image_version}=  Get Version Tar  ${IMAGE_FILE_PATH}
82    ${bmc_release_info}=  Get BMC Release Info
83    ${functional_version}=  Set Variable  ${bmc_release_info['version_id']}
84    Rprint Vars  image_version  functional_version
85
86    # Check if the existing firmware is functional.
87    Pass Execution If  '${functional_version}' == '${image_version}'
88    ...  The existing ${image_version} firmware is already functional.
89
90    Upload And Activate Image  ${IMAGE_FILE_PATH}
91    ...  skip_if_active=${SKIP_UPDATE_IF_ACTIVE}
92    OBMC Reboot (off)
93    Verify Running BMC Image  ${IMAGE_FILE_PATH}
94    BMC Execute Command  cd /etc ; cat host.conf hosts hostname  print_out=1
95
96
97Verify Error Log Persistency
98    [Documentation]  Check that the error log is still present after a
99    ...              code update.
100    [Tags]  Verify_Error_Log_Persistency
101
102    ${error_log_paths}=  Read Properties  ${BMC_LOGGING_ENTRY}list
103    Log To Console  ${error_log_paths}
104    ${test_error_message}=  Read Attribute  @{error_log_paths}[-1]  Message
105    Should Be Equal  ${test_error_message}
106    ...  example.xyz.openbmc_project.Example.Elog.${test_errlog_text}
107    Delete Error Log Entry  @{error_log_paths}[-1]
108
109
110Verify BMC Dump Persistency
111    [Documentation]  Check that the BMC dump present after a code update.
112    [Tags]  Verify_BMC_Dump_Persistency
113    [Teardown]  Set Suite Variable  ${running_persistence_test}  ${FALSE}
114
115    Check Dump Existence  ${dump_id}
116    Delete BMC Dump  ${dump_id}
117
118
119Verify Settings Persistency
120    [Documentation]  Verify that the settings from 'Prepare Persistent Data'
121    ...              are still set correctly after the code update.
122    [Tags]  Verify_Settings_Persistency
123
124    ${autoreboot_enabled}=  Read Attribute  ${CONTROL_HOST_URI}auto_reboot
125    ...  AutoReboot
126    Should Be Equal  ${autoreboot_enabled}  ${0}
127    ${onetime_enabled}=  Read Attribute  ${CONTROL_HOST_URI}boot/one_time
128    ...  Enabled
129    Should Be Equal  ${onetime_enabled}  ${0}
130
131    # Set values back to their defaults
132    ${autoreboot_dict}=  Create Dictionary  data=${1}
133    Write Attribute  ${CONTROL_HOST_URI}auto_reboot  AutoReboot
134    ...  data=${autoreboot_dict}
135    ${onetime_dict}=  Create Dictionary  data=${1}
136    Write Attribute  ${CONTROL_HOST_URI}boot/one_time  Enabled
137    ...  data=${onetime_dict}
138
139
140Upload And Activate Multiple BMC Images
141    [Documentation]  Upload another BMC image and verify that its state is
142    ...              different from all others.
143    [Tags]  Upload_And_Activate_Multiple_BMC_Images
144    [Template]  Activate Image And Verify No Duplicate Priorities
145    [Setup]  Upload And Activate Multiple BMC Images Setup
146
147    # Image File Path              Image Purpose
148    ${ALTERNATE_IMAGE_FILE_PATH}   ${VERSION_PURPOSE_BMC}
149
150
151BMC Set Priority To Invalid Values
152    [Documentation]  Attempt to set the priority of an image to an invalid
153    ...              value and expect an error.
154    [Tags]  BMC_Set_Priority_To_Invalid_Values
155    [Template]  Set Priority To Invalid Value And Expect Error
156
157    # Version Type              Priority
158    ${VERSION_PURPOSE_BMC}     ${-1}
159    ${VERSION_PURPOSE_BMC}     ${256}
160
161
162Delete BMC Image
163    [Documentation]  Delete a BMC image from the BMC flash chip.
164    [Tags]  Delete_BMC_Image
165
166    ${software_object}=  Get Non Running BMC Software Object
167    Delete Image And Verify  ${software_object}  ${VERSION_PURPOSE_BMC}
168
169
170BMC Image Priority Attribute Test
171    [Documentation]  Set "Priority" attribute.
172    [Tags]  BMC_Image_Priority_Attribute_Test
173    [Template]  Temporarily Set BMC Attribute
174
175    # Property        Value
176    Priority          ${False}
177    Priority          ${True}
178    Priority          ${0}
179    Priority          ${1}
180    Priority          ${127}
181    Priority          ${255}
182
183
184Delete All Non Running BMC Images
185    [Documentation]  Delete all non running BMC images.
186    [Tags]  Delete_All_Non_Running_BMC_Images
187
188    ${version_id}=  Upload And Activate Image  ${ALTERNATE_IMAGE_FILE_PATH}
189    ...  skip_if_active=true
190    Delete All Non Running BMC Images
191
192    ${software_ids}=  Get Software Objects Id
193    ...  version_type=${VERSION_PURPOSE_BMC}
194    Should Not Contain  ${software_ids}  ${version_id}
195
196
197Test Certificate Persistency After BMC Code Update
198    [Documentation]  Test certificate persistency after BMC update.
199    [Tags]  Test_Certificate_Persistency_After_BMC_Code_Update
200
201    # Create certificate sub-directory in current working directory.
202    Create Directory  certificate_dir
203    OperatingSystem.Directory Should Exist  ${EXECDIR}${/}certificate_dir
204
205    ${cert_file_path}=  Generate Certificate File Via Openssl
206    ...  Valid Certificate Valid Privatekey
207    ${file_data}=  OperatingSystem.Get Binary File  ${cert_file_path}
208    ${cert_file_content}=  OperatingSystem.Get File  ${cert_file_path}
209
210    Redfish.Login
211    ${cert_id}=  Install Certificate File On BMC  ${REDFISH_CA_CERTIFICATE_URI}  ok  data=${file_data}
212    Logging  Installed certificate id: ${cert_id}
213
214    # Adding delay after certificate installation.
215    Sleep  30s
216
217    ${bmc_cert_content}=  redfish_utils.Get Attribute
218    ...  /redfish/v1/Managers/bmc/Truststore/Certificates/${cert_id}  CertificateString
219    Should Contain  ${cert_file_content}  ${bmc_cert_content}
220
221    Upload And Activate Image  ${IMAGE_FILE_PATH}
222    ...  skip_if_active=${SKIP_UPDATE_IF_ACTIVE}
223    OBMC Reboot (off)
224    Verify Running BMC Image  ${IMAGE_FILE_PATH}
225
226    Redfish.Login
227    ${bmc_cert_content}=  redfish_utils.Get Attribute
228    ...  ${REDFISH_CA_CERTIFICATE_URI}/${cert_id}  CertificateString
229    Should Contain  ${cert_file_content}  ${bmc_cert_content}
230
231    Redfish.Logout
232
233
234Test Basic BMC Performance After Code Update
235    [Documentation]  Check performance of memory, CPU & file system of BMC.
236    [Tags]  Test_Basic_BMC_Performance_After_Code_Update
237
238    Open Connection And Log In
239    Check BMC Performance
240
241
242*** Keywords ***
243
244Temporarily Set BMC Attribute
245    [Documentation]  Update the BMC attribute value.
246    [Arguments]  ${attribute_name}  ${attribute_value}
247
248    # Description of argument(s):
249    # attribute_name    BMC software attribute name (e.g. "Priority").
250    # attribute_value   Value to be written.
251
252    ${image_ids}=  Get Software Objects  ${VERSION_PURPOSE_BMC}
253    ${init_bmc_properties}=  Get Host Software Property  ${image_ids[0]}
254    ${initial_priority}=  Set Variable  ${init_bmc_properties["Priority"]}
255
256    Set Host Software Property  ${image_ids[0]}  ${attribute_name}
257    ...  ${attribute_value}
258
259    ${cur_bmc_properties}=  Get Host Software Property  ${image_ids[0]}
260    Should Be Equal As Integers  ${cur_bmc_properties["Priority"]}
261    ...  ${attribute_value}
262
263    # Revert to to initial value.
264    Set Host Software Property
265    ...  ${image_ids[0]}  ${attribute_name}  ${initial_priority}
266
267
268Upload And Activate Multiple BMC Images Setup
269    [Documentation]  Check that the ALTERNATE_FILE_PATH variable is set.
270
271    Should Not Be Empty  ${ALTERNATE_IMAGE_FILE_PATH}
272
273
274REST BMC Code Update Teardown
275    [Documentation]  Do code update test teardown.
276
277    FFDC On Test Case Fail
278    Run Keyword If Test Failed  Fatal Error  msg=Code update failed.
279
280
281Suite Setup Execution
282    [Documentation]  Do code update test case setup.
283    # - Clean up all existing BMC dumps.
284
285    Run Key  Delete All Dumps  ignore=1
286    Run Keyword And Ignore Error  Smart Power Off
287
288Test Teardown Execution
289    [Documentation]  Do code update test case teardown.
290    # 1. Collect FFDC if test case failed.
291    # 2. Collect FFDC if test PASS but error log exists.
292
293    # Don't delete our logs if we want to persist them for tests.
294    Return From Keyword If  ${running_persistence_test}
295
296    FFDC On Test Case Fail
297    Run Keyword If  '${TEST_STATUS}' == 'PASS'  Check Error And Collect FFDC
298    Close All Connections
299