xref: /openbmc/openbmc-test-automation/extended/code_update/bmc_code_update.robot (revision 665bc61e1efab6f903983b44efdf1f5cc1b4d3b0)
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/ipmi_client.robot
17
18Suite Setup       Suite Setup Execution
19
20Test Teardown     Test Teardown Execution
21
22Force Tags        BMC_Code_Update
23
24*** Variables ***
25
26${QUIET}                          ${1}
27${IMAGE_FILE_PATH}                ${EMPTY}
28${ALTERNATE_IMAGE_FILE_PATH}      ${EMPTY}
29${SKIP_UPDATE_IF_ACTIVE}          false
30${dump_id}                        ${EMPTY}
31${running_persistence_test}       ${FALSE}
32${test_errlog_text}               AutoTestSimple
33
34*** Test Cases ***
35
36Test Basic BMC Performance Before BMC Code Update
37    [Documentation]  Check performance of memory, CPU & file system of BMC.
38    [Tags]  Test_Basic_BMC_Performance_Before_BMC_Code_Update
39
40    Open Connection And Log In
41    Check BMC Performance
42
43Prepare Persistent Data
44    [Documentation]  Set data that should persist across the code update.
45    [Tags]  Prepare_Persistent_Data
46
47    # Install the debug tarball.
48    BMC Execute Command  rm -rf /tmp/tarball
49    Install Debug Tarball On BMC  tarball_file_path=${DEBUG_TARBALL_PATH}
50
51    # Create a dummy error log and dump.
52    BMC Execute Command  /tmp/tarball/bin/logging-test -c ${test_errlog_text}
53    ${dump_id}=  Create User Initiated Dump
54    Check Dump Existence  ${dump_id}
55    Set Suite Variable  ${dump_id}
56
57    # Set persistent settings.
58    ${autoreboot_dict}=  Create Dictionary  data=${0}
59    Write Attribute  ${CONTROL_HOST_URI}auto_reboot  AutoReboot
60    ...  data=${autoreboot_dict}
61    ${onetime_dict}=  Create Dictionary  data=${0}
62    Write Attribute  ${CONTROL_HOST_URI}boot/one_time  Enabled
63    ...  data=${onetime_dict}
64
65    # Let the remaining test cases know we are doing a persistence test so we
66    # do not delete logs.
67    Set Suite Variable  ${running_persistence_test}  ${TRUE}
68
69
70REST BMC Code Update
71    [Documentation]  Do a BMC code update by uploading image on BMC via REST.
72    [Tags]  REST_BMC_Code_Update
73    [Teardown]  REST BMC Code Update Teardown
74
75    Run Keyword And Ignore Error  List Installed Images  BMC
76
77    Upload And Activate Image  ${IMAGE_FILE_PATH}
78    ...  skip_if_active=${SKIP_UPDATE_IF_ACTIVE}
79    OBMC Reboot (off)
80    Verify Running BMC Image  ${IMAGE_FILE_PATH}
81
82
83Verify Error Log Persistency
84    [Documentation]  Check that the error log is still present after a
85    ...              code update.
86    [Tags]  Verify_Error_Log_Persistency
87
88    ${error_log_paths}=  Read Properties  ${BMC_LOGGING_URI}/list
89    Log To Console  ${error_log_paths}
90    ${test_error_message}=  Read Attribute  @{error_log_paths}[-1]  Message
91    Should Be Equal  ${test_error_message}
92    ...  example.xyz.openbmc_project.Example.Elog.${test_errlog_text}
93    Delete Error Log Entry  @{error_log_paths}[-1]
94
95
96Verify BMC Dump Persistency
97    [Documentation]  Check that the BMC dump present after a code update.
98    [Tags]  Verify_BMC_Dump_Persistency
99    [Teardown]  Set Suite Variable  ${running_persistence_test}  ${FALSE}
100
101    Check Dump Existence  ${dump_id}
102    Delete BMC Dump  ${dump_id}
103
104
105Verify Settings Persistency
106    [Documentation]  Verify that the settings from 'Prepare Persistent Data'
107    ...              are still set correctly after the code update.
108    [Tags]  Verify_Settings_Persistency
109
110    ${autoreboot_enabled}=  Read Attribute  ${CONTROL_HOST_URI}auto_reboot
111    ...  AutoReboot
112    Should Be Equal  ${autoreboot_enabled}  ${0}
113    ${onetime_enabled}=  Read Attribute  ${CONTROL_HOST_URI}boot/one_time
114    ...  Enabled
115    Should Be Equal  ${onetime_enabled}  ${0}
116
117    # Set values back to their defaults
118    ${autoreboot_dict}=  Create Dictionary  data=${1}
119    Write Attribute  ${CONTROL_HOST_URI}auto_reboot  AutoReboot
120    ...  data=${autoreboot_dict}
121    ${onetime_dict}=  Create Dictionary  data=${1}
122    Write Attribute  ${CONTROL_HOST_URI}boot/one_time  Enabled
123    ...  data=${onetime_dict}
124
125
126Upload And Activate Multiple BMC Images
127    [Documentation]  Upload another BMC image and verify that its state is
128    ...              different from all others.
129    [Tags]  Upload_And_Activate_Multiple_BMC_Images
130    [Template]  Activate Image And Verify No Duplicate Priorities
131    [Setup]  Upload And Activate Multiple BMC Images Setup
132
133    # Image File Path              Image Purpose
134    ${ALTERNATE_IMAGE_FILE_PATH}   ${VERSION_PURPOSE_BMC}
135
136
137BMC Set Priority To Invalid Values
138    [Documentation]  Attempt to set the priority of an image to an invalid
139    ...              value and expect an error.
140    [Tags]  BMC_Set_Priority_To_Invalid_Values
141    [Template]  Set Priority To Invalid Value And Expect Error
142
143    # Version Type              Priority
144    ${VERSION_PURPOSE_BMC}     ${-1}
145    ${VERSION_PURPOSE_BMC}     ${256}
146
147
148Delete BMC Image
149    [Documentation]  Delete a BMC image from the BMC flash chip.
150    [Tags]  Delete_BMC_Image
151
152    ${software_object}=  Get Non Running BMC Software Object
153    Delete Image And Verify  ${software_object}  ${VERSION_PURPOSE_BMC}
154
155
156BMC Image Priority Attribute Test
157    [Documentation]  Set "Priority" attribute.
158    [Tags]  BMC_Image_Priority_Attribute_Test
159    [Template]  Temporarily Set BMC Attribute
160
161    # Property        Value
162    Priority          ${0}
163    Priority          ${1}
164    Priority          ${127}
165    Priority          ${255}
166
167
168Delete All Non Running BMC Images
169    [Documentation]  Delete all non running BMC images.
170    [Tags]  Delete_All_Non_Running_BMC_Images
171
172    ${version_id}=  Upload And Activate Image  ${ALTERNATE_IMAGE_FILE_PATH}
173    ...  skip_if_active=true
174    Delete All Non Running BMC Images
175
176    ${software_ids}=  Get Software Objects Id
177    ...  version_type=${VERSION_PURPOSE_BMC}
178    Should Not Contain  ${software_ids}  ${version_id}
179
180
181Verify IPMI Disable Policy Post BMC Code Update
182    [Documentation]  Disable IPMI, update BMC and verify post-update.
183    [Tags]  Verify_IPMI_Disable_Policy_Post_BMC_Code_Update
184
185    REST Power On
186
187    Run Inband IPMI Standard Command  lan set 1 access off
188    Run Keyword and Expect Error  *Unable to establish IPMI*
189    ...  Run External IPMI Standard Command  lan print
190
191    Upload And Activate Image  ${IMAGE_FILE_PATH}
192    ...  skip_if_active=${SKIP_UPDATE_IF_ACTIVE}
193    OBMC Reboot (off)
194    Verify Running BMC Image  ${IMAGE_FILE_PATH}
195
196    Run Keyword and Expect Error  *Unable to establish IPMI*
197    ...  Run External IPMI Standard Command  lan print
198
199
200Test Basic BMC Performance After Code Update
201    [Documentation]  Check performance of memory, CPU & file system of BMC.
202    [Tags]  Test_Basic_BMC_Performance_After_Code_Update
203
204    Open Connection And Log In
205    Check BMC Performance
206
207
208*** Keywords ***
209
210Temporarily Set BMC Attribute
211    [Documentation]  Update the BMC attribute value.
212    [Arguments]  ${attribute_name}  ${attribute_value}
213
214    # Description of argument(s):
215    # attribute_name    BMC software attribute name (e.g. "Priority").
216    # attribute_value   Value to be written.
217
218    ${image_ids}=  Get Software Objects  ${VERSION_PURPOSE_BMC}
219    ${init_bmc_properties}=  Get Host Software Property  ${image_ids[0]}
220    ${initial_priority}=  Set Variable  ${init_bmc_properties["Priority"]}
221
222    Set Host Software Property  ${image_ids[0]}  ${attribute_name}
223    ...  ${attribute_value}
224
225    ${cur_bmc_properties}=  Get Host Software Property  ${image_ids[0]}
226    Should Be Equal As Integers  ${cur_bmc_properties["Priority"]}
227    ...  ${attribute_value}
228
229    # Revert to to initial value.
230    Set Host Software Property
231    ...  ${image_ids[0]}  ${attribute_name}  ${initial_priority}
232
233
234Upload And Activate Multiple BMC Images Setup
235    [Documentation]  Check that the ALTERNATE_FILE_PATH variable is set.
236
237    Should Not Be Empty  ${ALTERNATE_IMAGE_FILE_PATH}
238
239
240REST BMC Code Update Teardown
241    [Documentation]  Do code update test teardown.
242
243    FFDC On Test Case Fail
244    Run Keyword If Test Failed  Fatal Error  msg=Code update failed.
245
246
247Suite Setup Execution
248    [Documentation]  Do code update test case setup.
249    # - Clean up all existing BMC dumps.
250
251    Run Key  Delete All Dumps  ignore=1
252    Run Keyword And Ignore Error  Smart Power Off
253
254Test Teardown Execution
255    [Documentation]  Do code update test case teardown.
256    # 1. Collect FFDC if test case failed.
257    # 2. Collect FFDC if test PASS but error log exists.
258
259    # Don't delete our logs if we want to persist them for tests.
260    Return From Keyword If  ${running_persistence_test}
261
262    FFDC On Test Case Fail
263    Run Keyword If  '${TEST_STATUS}' == 'PASS'  Check Error And Collect FFDC
264    Close All Connections
265