blob: 3b4bd61aa8746dfd40c18c1c774b0928eeef5a24 [file] [log] [blame]
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -05001*** Settings ***
2Documentation Update the PNOR code on a target BMC.
3... Execution Method:
4... python -m robot -v OPENBMC_HOST:<hostname>
5... -v DELETE_OLD_PNOR_IMAGES:<"true" or "false">
Charles Paul Hofera5673162017-08-30 09:49:16 -05006... -v IMAGE_FILE_PATH:<path/*.tar>
7... -v ALTERNATE_IMAGE_FILE_PATH:<path/*.tar>
8... host_code_update.robot
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -05009...
10... Code update method BMC
11... Update work flow sequence:
12... - Upload image via REST
13... - Verify that the file exists on the BMC
14... - Check that software "Activation" is set to "Ready"
15... - Set "Requested Activation" to "Active"
16... - Wait for code update to complete
17... - Verify the new version
18
19Library ../../lib/bmc_ssh_utils.py
20Library ../../lib/code_update_utils.py
Michael Walshe78a4432018-03-29 16:36:04 -050021Library ../../lib/gen_robot_keyword.py
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050022Variables ../../data/variables.py
23Resource ../../lib/boot_utils.robot
24Resource code_update_utils.robot
25Resource ../../lib/code_update_utils.robot
George Keishing1eb85f52017-08-30 22:55:13 -050026Resource ../../lib/openbmc_ffdc.robot
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050027Resource ../../lib/state_manager.robot
George Keishing1eb85f52017-08-30 22:55:13 -050028Resource ../../lib/dump_utils.robot
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050029
George Keishing00715492017-08-18 11:46:37 -050030Test Teardown Code Update Test Teardown
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050031
George Keishing09712a12017-10-16 12:52:42 -050032Force Tags Host_Code_Update
33
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050034*** Variables ***
35
Steven Sombar9629b0e2018-08-23 07:26:58 -050036${QUIET} ${1}
37${IMAGE_FILE_PATH} ${EMPTY}
38${DELETE_OLD_PNOR_IMAGES} false
39${DELETE_OLD_GUARD_FILE} false
40${ALTERNATE_IMAGE_FILE_PATH} ${EMPTY}
Michael Walsh1ca51442018-09-18 16:38:43 -050041${SKIP_UPDATE_IF_ACTIVE} false
Steven Sombar9629b0e2018-08-23 07:26:58 -050042${cache_files_dir_path} /var/lib/phosphor-software-manager/pnor/prsv/
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050043
44*** Test Cases ***
45
46REST Host Code Update
47 [Documentation] Do a PNOR code update by uploading image on BMC via REST.
George Keishing00715492017-08-18 11:46:37 -050048 # 1. Delete error logs if there is any.
49 # 1. Do code update.
50 # 2. Do post update the following:
51 # - Collect FFDC if error log exist and delete error logs.
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050052 [Tags] REST_Host_Code_Update
53 [Setup] Code Update Setup
54
Sweta Potthuri8c7ada42018-01-15 05:05:59 -060055 Run Keyword And Ignore Error List Installed Images Host
56
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050057 Upload And Activate Image ${IMAGE_FILE_PATH}
Michael Walsh1ca51442018-09-18 16:38:43 -050058 ... skip_if_active=${SKIP_UPDATE_IF_ACTIVE}
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050059 OBMC Reboot (off)
60
61
62Post Update Boot To OS
63 [Documentation] Boot the host OS
64 [Tags] Post_Update_Boot_To_OS
Charles Paul Hofer0c4a87d2017-10-11 17:27:40 -050065 [Setup] Start SOL Console Logging
George Keishingda6bace2017-09-14 07:42:27 -050066 [Teardown] Run Keywords Stop SOL Console Logging
67 ... AND Code Update Test Teardown
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050068
69 Run Keyword If '${PREV_TEST_STATUS}' == 'FAIL'
70 ... Fail Code update failed. No need to boot to OS.
George Keishing32fe4e12018-07-13 05:06:47 -050071 Delete All Error Logs
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050072 REST Power On
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -050073 Verify Running Host Image ${IMAGE_FILE_PATH}
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -050074
75
Steven Sombar9629b0e2018-08-23 07:26:58 -050076Test Boot With No VPD Cache
77 [Documentation] After having done a PNOR update and
78 ... booted the OS in the tests above, remove the cached
79 ... VPD files and verify that the OS can still boot.
80 [Tags] Test_Boot_With_No_VPD_Cache
81 [Setup] Start SOL Console Logging
82 [Teardown] Run Keywords Stop SOL Console Logging
83 ... AND Code Update Test Teardown
84
85 ${num_vpd_files} ${stderr} ${rc}= BMC Execute Command
86 ... ls ${cache_files_dir_path} | grep VPD -c
87 # Typically, vpd files = "CVPD DJVPD MVPD NVRAM".
88 Should Be Equal As Integers ${num_vpd_files} ${3}
89 ... msg=Missing VPD files at ${cache_files_dir_path}.
90
91 # Delete the *VPD* files.
92 BMC Execute Command rm -f ${xxx_dir_path}*VPD*
93
94 REST Power On
95
96 # After powering-on the system, the VPD files should be present.
97 ${num_vpd_files} ${stderr} ${rc}= BMC Execute Command
98 ... ls ${cache_files_dir_path} | grep VPD -c
99 Should Be Equal As Integers ${num_vpd_files} ${3}
100 ... msg=Three VPD files expected at ${cache_files_dir_path}.
101
102 # Power off. The next test case will boot the OS with the new VPD files.
103 REST Power Off
104
105
Charles Paul Hofer7c6e7522017-10-18 17:09:27 -0500106REST Host Code Update While OS Is Running
107 [Documentation] Do a PNOR code update while the host is running.
108 [Tags] REST_Host_Code_Update_While_OS_Is_Running
Charles Paul Hofer4e8c09b2017-11-03 14:59:05 -0500109 [Teardown] Run Keywords REST Power Off stack_mode=skip
110 ... AND Code Update Test Teardown
Charles Paul Hofer7c6e7522017-10-18 17:09:27 -0500111
112 Run Keyword If '${PREV_TEST_STATUS}' == 'FAIL'
113 ... Fail Cannot boot the OS.
114
115 REST Power On stack_mode=skip
George Keishing72373f82017-11-20 09:18:41 -0600116 Upload And Activate Image
117 ... ${ALTERNATE_IMAGE_FILE_PATH} skip_if_active=true
Charles Paul Hofer7c6e7522017-10-18 17:09:27 -0500118 REST Power On stack_mode=normal
119 Verify Running Host Image ${ALTERNATE_IMAGE_FILE_PATH}
120
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500121Host Image Priority Attribute Test
122 [Documentation] Set "Priority" attribute.
123 [Tags] Host_Image_Priority_Attribute_Test
124 [Template] Temporarily Set PNOR Attribute
125
126 # Property Value
127 Priority ${0}
128 Priority ${1}
129 Priority ${127}
George Keishing97ecb272017-09-12 04:30:20 -0500130 Priority ${255}
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500131
132
Charles Paul Hofer42f17462017-09-12 14:09:32 -0500133Host Set Priority To Invalid Values
134 [Documentation] Attempt to set the priority of an image to an invalid
135 ... value and expect an error.
136 [Tags] Host_Set_Priority_To_Invalid_Values
137 [Template] Set Priority To Invalid Value And Expect Error
138
139 # Version Type Priority
140 ${VERSION_PURPOSE_HOST} ${-1}
141 ${VERSION_PURPOSE_HOST} ${256}
142
143
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500144Set RequestedActivation To None
145 [Documentation] Set the RequestedActivation of the image to None and
146 ... verify that it is in fact set to None.
147 [Tags] Set_RequestedActivation_To_None
148
149 ${software_objects}= Get Software Objects
150 Set Host Software Property @{software_objects}[0] RequestedActivation
151 ... ${REQUESTED_NONE}
152 ${software_properties}= Get Host Software Property @{software_objects}[0]
153 Should Be Equal As Strings &{software_properties}[RequestedActivation]
154 ... ${REQUESTED_NONE}
155
156
157Set RequestedActivation And Activation To Invalid Value
158 [Documentation] Set the RequestedActivation and Activation propreties of
159 ... the image to an invalid value and verify that it was not
160 ... changed.
161 [Template] Set Property To Invalid Value And Verify No Change
162 [Tags] Set_RequestedActivation_And_Activation_To_Invalid_Value
163
164 # Property Version Type
165 RequestedActivation ${VERSION_PURPOSE_HOST}
166 Activation ${VERSION_PURPOSE_HOST}
167
168
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -0500169Upload And Activate Multiple Host Images
170 [Documentation] Upload another PNOR image and verify that its state is
171 ... different from all others.
172 [Tags] Upload_And_Activate_Multiple_Host_Images
173 [Template] Activate Image And Verify No Duplicate Priorities
174 [Setup] Upload And Activate Multiple BMC Images Setup
175
176 # Image File Path Image Purpose
177 ${ALTERNATE_IMAGE_FILE_PATH} ${VERSION_PURPOSE_HOST}
178
179
Charles Paul Hofera5673162017-08-30 09:49:16 -0500180Set Same Priority For Multiple Host Images
181 [Documentation] Attempt to set the priority to be the same for two PNOR
182 ... images and verify that the priorities are not the same.
183 [Tags] Set_Same_Priority_For_Multiple_Host_Images
184
185 Run Keyword If '${PREV_TEST_STATUS}' == 'FAIL'
186 ... Fail Activation of alternate image failed. Cannot set priority.
187 Set Same Priority For Multiple Images ${VERSION_PURPOSE_HOST}
188
189
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500190Delete Host Image
191 [Documentation] Delete a PNOR image from the BMC and PNOR flash chip.
192 [Tags] Delete_Host_Image
193 [Setup] Initiate Host PowerOff
194
195 ${software_objects}= Get Software Objects
196 ... version_type=${VERSION_PURPOSE_HOST}
197 ${num_images}= Get Length ${software_objects}
198 Should Be True 0 < ${num_images}
199 ... msg=There are no PNOR images on the BMC to delete.
200 Delete Image And Verify @{software_objects}[0] ${VERSION_PURPOSE_HOST}
201
202
George Keishing287faaf2017-11-21 12:31:03 -0600203Verify Host Update When Host Reboot During Activation In Progress
204 [Documentation] Attempt to reboot the host while an image is activating.
205 [Tags] Verify_Host_Update_When_Host_Reboot_During_Activation_In_Progress
206
207 Upload And Activate Image ${IMAGE_FILE_PATH}
208 REST Power On
George Keishing32fe4e12018-07-13 05:06:47 -0500209 Delete All Error Logs
George Keishing287faaf2017-11-21 12:31:03 -0600210
211 ${version_id}= Upload And Activate Image ${ALTERNATE_IMAGE_FILE_PATH}
212 ... wait=${0}
213
214 ${resp}= OpenBMC Get Request ${SOFTWARE_VERSION_URI}${version_id}
215 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
216
217 # Reboot Host during activation.
218 Host Reboot
219
220 Wait For Activation State Change ${version_id} ${ACTIVATING}
221
222 # New image priority should be 0.
223 ${new_host_properties}=
224 ... Get Host Software Property ${SOFTWARE_VERSION_URI}${version_id}
225 Should Be Equal As Integers ${new_host_properties["Priority"]} ${0}
226
227 # Reboot host to boot up with the new host image version.
228 Host Reboot
229 Verify Running Host Image ${ALTERNATE_IMAGE_FILE_PATH}
230
231
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500232*** Keywords ***
233
234Temporarily Set PNOR Attribute
235 [Documentation] Update the PNOR attribute value.
236 [Arguments] ${attribute_name} ${attribute_value}
237
238 # Description of argument(s):
239 # attribute_name Host software attribute name (e.g. "Priority").
240 # attribute_value Value to be written.
241
242 ${image_ids}= Get Software Objects
243 ${init_host_properties}= Get Host Software Property ${image_ids[0]}
244 ${initial_priority}= Set Variable ${init_host_properties["Priority"]}
245
246 Set Host Software Property ${image_ids[0]} ${attribute_name}
247 ... ${attribute_value}
248
249 ${cur_host_properties}= Get Host Software Property ${image_ids[0]}
250 Should Be Equal As Integers ${cur_host_properties["Priority"]}
251 ... ${attribute_value}
252
253 # Revert to to initial value.
254 Set Host Software Property
255 ... ${image_ids[0]} ${attribute_name} ${initial_priority}
256
257
258Code Update Setup
259 [Documentation] Do code update test case setup.
George Keishing1eb85f52017-08-30 22:55:13 -0500260 # - Clean up all existing BMC dumps.
261 # - Clean up all currently install PNOR images.
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500262
Charles Paul Hoferb9264082017-09-29 15:00:19 -0500263 Run Keyword And Ignore Error Smart Power Off
Michael Walshe78a4432018-03-29 16:36:04 -0500264 Run Key Delete All Dumps ignore=1
George Keishing32fe4e12018-07-13 05:06:47 -0500265 Run Key Delete All Error Logs ignore=1
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500266 Run Keyword If 'true' == '${DELETE_OLD_PNOR_IMAGES}'
267 ... Delete All PNOR Images
Charles Paul Hofer51b54c02017-09-13 22:13:49 -0500268 Run Keyword If 'true' == '${DELETE_OLD_GUARD_FILE}' BMC Execute Command
269 ... rm -f /var/lib/phosphor-software-manager/pnor/prsv/GUARD
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500270
George Keishingfd717562019-07-02 13:30:04 -0500271 BMC Execute Command rm -rf /tmp/images/*
272 BMC Execute Command systemctl restart xyz.openbmc_project.Software.BMC.Updater.service xyz.openbmc_project.Software.Version.service xyz.openbmc_project.Software.Download.service
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500273
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -0500274Upload And Activate Multiple BMC Images Setup
275 [Documentation] Check that the ALTERNATE_FILE_PATH variable is set.
276
277 Should Not Be Empty ${ALTERNATE_IMAGE_FILE_PATH}
Charles Paul Hofer4e8c09b2017-11-03 14:59:05 -0500278 Delete All PNOR Images
George Keishing72373f82017-11-20 09:18:41 -0600279 Upload And Activate Image ${IMAGE_FILE_PATH} skip_if_active=true
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -0500280
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500281Get PNOR Extended Version
282 [Documentation] Return the PNOR extended version.
283 [Arguments] ${manifest_path}
284
285 # Description of argument(s):
286 # manifest_path Path of the MANIFEST file
287 # (e.g. "/tmp/images/abc123/MANIFEST").
288
289 ${version}= BMC Execute Command
290 ... grep extended_version= ${manifest_path}
291 [return] ${version.split(",")}
George Keishing00715492017-08-18 11:46:37 -0500292
293
294Code Update Test Teardown
295 [Documentation] Do code update test case teardown.
296 # 1. Collect FFDC if test case failed.
297 # 2. Collect FFDC if test PASS but error log exists.
298
299 FFDC On Test Case Fail
300 Run Keyword If '${TEST_STATUS}' == 'PASS' Check Error And Collect FFDC