blob: bd186d653f59524ef3cfa4d008308a1163127ba4 [file] [log] [blame]
George Keishing27bf6932017-08-07 14:30:40 -05001*** Settings ***
Sushil Singhc51eee72019-09-01 11:13:37 -05002Documentation BMC and PNOR update utilities keywords.
George Keishing27bf6932017-08-07 14:30:40 -05003
Sushil Singhc51eee72019-09-01 11:13:37 -05004Library code_update_utils.py
5Library OperatingSystem
6Library String
7Library utilities.py
8Library gen_robot_valid.py
9Variables ../data/variables.py
10Resource boot_utils.robot
11Resource rest_client.robot
12Resource openbmc_ffdc.robot
13
14*** Variables ***
15${ignore_err} ${0}
George Keishing27bf6932017-08-07 14:30:40 -050016
17*** Keywords ***
18
19Get Software Objects
20 [Documentation] Get the host software objects and return as a list.
21 [Arguments] ${version_type}=${VERSION_PURPOSE_HOST}
22
23 # Description of argument(s):
24 # version_type Either BMC or host version purpose.
25 # By default host version purpose string.
26 # (e.g. "xyz.openbmc_project.Software.Version.VersionPurpose.BMC"
27 # "xyz.openbmc_project.Software.Version.VersionPurpose.Host").
28
29 # Example:
30 # "data": [
31 # "/xyz/openbmc_project/software/f3b29aa8",
32 # "/xyz/openbmc_project/software/e49bc78e",
33 # ],
34 # Iterate the list and return the host object name path list.
35
36 ${host_list}= Create List
37 ${sw_list}= Read Properties ${SOFTWARE_VERSION_URI}
38
Sushil Singh8d8ce962020-06-05 09:43:33 -050039 FOR ${index} IN @{sw_list}
40 ${attr_purpose}= Read Software Attribute ${index} Purpose
41 Continue For Loop If '${attr_purpose}' != '${version_type}'
42 Append To List ${host_list} ${index}
43 END
George Keishing27bf6932017-08-07 14:30:40 -050044
George Keishingd62db0f2017-09-13 08:50:33 -050045 [Return] ${host_list}
46
47
48Read Software Attribute
49 [Documentation] Return software attribute data.
50 [Arguments] ${software_object} ${attribute_name}
51
52 # Description of argument(s):
53 # software_object Software object path.
54 # (e.g. "/xyz/openbmc_project/software/f3b29aa8").
55 # attribute_name Software object attribute name.
56
57 ${resp}= OpenBMC Get Request ${software_object}/attr/${attribute_name}
58 ... quiet=${1}
59 Return From Keyword If ${resp.status_code} != ${HTTP_OK}
60 ${content}= To JSON ${resp.content}
61 [Return] ${content["data"]}
George Keishing27bf6932017-08-07 14:30:40 -050062
63
George Keishingfe4ebd22017-09-12 06:05:22 -050064Get Software Objects Id
65 [Documentation] Get the software objects id and return as a list.
66 [Arguments] ${version_type}=${VERSION_PURPOSE_HOST}
67
68 # Description of argument(s):
69 # version_type Either BMC or host version purpose.
70 # By default host version purpose string.
71 # (e.g. "xyz.openbmc_project.Software.Version.VersionPurpose.BMC"
72 # "xyz.openbmc_project.Software.Version.VersionPurpose.Host").
73
74 ${sw_id_list}= Create List
75 ${sw_list}= Get Software Objects ${version_type}
76
Marissa Garza20ccfc72020-06-19 12:51:10 -050077 FOR ${index} IN @{sw_list}
78 Append To List ${sw_id_list} ${index.rsplit('/', 1)[1]}
79 END
George Keishingfe4ebd22017-09-12 06:05:22 -050080 [Return] ${sw_id_list}
81
82
George Keishing27bf6932017-08-07 14:30:40 -050083Get Host Software Property
84 [Documentation] Return a dictionary of host software properties.
85 [Arguments] ${host_object}
86
87 # Description of argument(s):
88 # host_object Host software object path.
89 # (e.g. "/xyz/openbmc_project/software/f3b29aa8").
90
91 ${sw_attributes}= Read Properties ${host_object}
92 [return] ${sw_attributes}
93
Sweta Potthuricd966342017-09-06 03:41:32 -050094Get Host Software Objects Details
95 [Documentation] Return software object details as a list of dictionaries.
96 [Arguments] ${quiet}=${QUIET}
97
98 ${software}= Create List
99
100 ${pnor_details}= Get Software Objects ${VERSION_PURPOSE_HOST}
Marissa Garza20ccfc72020-06-19 12:51:10 -0500101 FOR ${pnor} IN @{pnor_details}
102 ${resp}= OpenBMC Get Request ${pnor} quiet=${1}
103 ${json}= To JSON ${resp.content}
104 Append To List ${software} ${json["data"]}
105 END
Sweta Potthuricd966342017-09-06 03:41:32 -0500106 [Return] ${software}
George Keishing27bf6932017-08-07 14:30:40 -0500107
108Set Host Software Property
109 [Documentation] Set the host software properties of a given object.
110 [Arguments] ${host_object} ${sw_attribute} ${data}
111
112 # Description of argument(s):
113 # host_object Host software object name.
114 # sw_attribute Host software attribute name.
115 # (e.g. "Activation", "Priority", "RequestedActivation" etc).
116 # data Value to be written.
117
118 ${args}= Create Dictionary data=${data}
119 Write Attribute ${host_object} ${sw_attribute} data=${args}
George Keishing9ebc0522018-02-06 12:58:22 -0600120 # Sync time for software updater manager to update.
George Keishing9ebc0522018-02-06 12:58:22 -0600121 Sleep 10s
George Keishing27bf6932017-08-07 14:30:40 -0500122
Charles Paul Hofercef61992017-08-18 10:14:18 -0500123
124Set Property To Invalid Value And Verify No Change
125 [Documentation] Attempt to set a property and check that the value didn't
126 ... change.
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500127 [Arguments] ${property} ${version_type}
Charles Paul Hofercef61992017-08-18 10:14:18 -0500128
129 # Description of argument(s):
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500130 # property The property to attempt to set.
131 # version_type Either BMC or host version purpose.
132 # By default host version purpose string.
133 # (e.g. "xyz.openbmc_project.Software.Version.VersionPurpose.BMC"
134 # "xyz.openbmc_project.Software.Version.VersionPurpose.Host").
Charles Paul Hofercef61992017-08-18 10:14:18 -0500135
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500136 ${software_objects}= Get Software Objects version_type=${version_type}
137 ${prev_properties}= Get Host Software Property @{software_objects}[0]
Charles Paul Hofercef61992017-08-18 10:14:18 -0500138 Run Keyword And Expect Error 500 != 200
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500139 ... Set Host Software Property @{software_objects}[0] ${property} foo
140 ${cur_properties}= Get Host Software Property @{software_objects}[0]
141 Should Be Equal As Strings &{prev_properties}[${property}]
142 ... &{cur_properties}[${property}]
Charles Paul Hofercef61992017-08-18 10:14:18 -0500143
144
Charles Paul Hofer42f17462017-09-12 14:09:32 -0500145Set Priority To Invalid Value And Expect Error
146 [Documentation] Set the priority of an image to an invalid value and
147 ... check that an error was returned.
148 [Arguments] ${version_type} ${priority}
149
150 # Description of argument(s):
151 # version_type Either BMC or host version purpose.
152 # (e.g. "xyz.openbmc_project.Software.Version.VersionPurpose.BMC"
153 # "xyz.openbmc_project.Software.Version.VersionPurpose.Host").
154 # priority The priority value to set. Should be an integer outside of
155 # the range of 0 through 255.
156
157 ${images}= Get Software Objects version_type=${version_type}
158 ${num_images}= Get Length ${images}
159 Should Be True 0 < ${num_images}
160
161 Run Keyword And Expect Error 403 != 200
162 ... Set Host Software Property @{images}[0] Priority ${priority}
163
164
Sushil Singh5ea86d02019-07-11 02:05:16 -0500165Redfish Upload Image
166 [Documentation] Upload an image to the BMC via redfish.
167 [Arguments] ${uri} ${image_file_path}
168
169 # Description of argument(s):
170 # uri URI for uploading image via redfish.
171 # image_file_path The path to the image tarball.
172
173 ${image_data}= OperatingSystem.Get Binary File ${image_file_path}
174
George Keishing36db9962021-05-13 02:10:45 -0500175 Wait Until Keyword Succeeds 2 times 240 sec
176 ... Upload Image To BMC ${uri} timeout=${240} data=${image_data}
Sushil Singh5ea86d02019-07-11 02:05:16 -0500177
178
179Redfish Verify BMC Version
180 [Documentation] Verify that the version on the BMC is the same as the
181 ... version in the given image via Redfish.
182 [Arguments] ${image_file_path}
183
184 # Description of argument(s):
185 # image_file_path Path to the image tarball.
186
187 # Extract the version from the image tarball on our local system.
188 ${tar_version}= Get Version Tar ${image_file_path}
189 ${bmc_version}= Redfish Get BMC Version
190
Michael Walshe7edb222019-08-19 17:39:38 -0500191 Valid Value bmc_version valid_values=['${tar_version}']
Sushil Singh5ea86d02019-07-11 02:05:16 -0500192
193
194Redfish Verify Host Version
195 [Documentation] Verify that the version of the PNOR image that is on the
196 ... BMC is the same as the one in the given image via Redfish.
197 [Arguments] ${image_file_path}
198
199 # Description of argument(s):
200 # image_file_path Path to the image tarball.
201
202 # Extract the version from the image tarball on our local system.
203 ${tar_version}= Get Version Tar ${image_file_path}
204 ${host_version}= Redfish Get Host Version
205
Michael Walshe7edb222019-08-19 17:39:38 -0500206 Valid Value host_version valid_values=['${tar_version}']
Sushil Singh5ea86d02019-07-11 02:05:16 -0500207
208
Charles Paul Hofercef61992017-08-18 10:14:18 -0500209Upload And Activate Image
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500210 [Documentation] Upload an image to the BMC and activate it with REST.
Charles Paul Hoferb7842a52017-09-22 10:11:33 -0500211 [Arguments] ${image_file_path} ${wait}=${1} ${skip_if_active}=false
Charles Paul Hofercef61992017-08-18 10:14:18 -0500212
213 # Description of argument(s):
George Keishing71c24ed2017-09-25 13:11:10 -0500214 # image_file_path The path to the image tarball to upload and activate.
215 # wait Indicates that this keyword should wait for host or
216 # BMC activation is completed.
Charles Paul Hoferb7842a52017-09-22 10:11:33 -0500217 # skip_if_active If set to true, will skip the code update if this
218 # image is already on the BMC.
Charles Paul Hofercef61992017-08-18 10:14:18 -0500219
220 OperatingSystem.File Should Exist ${image_file_path}
221 ${image_version}= Get Version Tar ${image_file_path}
222
223 ${image_data}= OperatingSystem.Get Binary File ${image_file_path}
Leonel Gonzalez6ac206e2017-10-12 16:04:23 -0500224
George Keishing65a7f162019-10-30 01:33:28 -0500225 Wait Until Keyword Succeeds 3 times 120 sec
226 ... Upload Image To BMC /upload/image timeout=${90} data=${image_data}
Charles Paul Hofercef61992017-08-18 10:14:18 -0500227 ${ret} ${version_id}= Verify Image Upload ${image_version}
228 Should Be True ${ret}
229
Charles Paul Hoferb7842a52017-09-22 10:11:33 -0500230 # Verify the image is 'READY' to be activated or if it's already active,
231 # set priority to 0 and reboot the BMC.
Charles Paul Hofercef61992017-08-18 10:14:18 -0500232 ${software_state}= Read Properties ${SOFTWARE_VERSION_URI}${version_id}
Sushil Singhec4ab932020-06-08 01:32:11 -0500233 ${activation}= Set Variable ${software_state}[Activation]
George Keishingd5949852018-01-31 12:56:55 -0600234
Charles Paul Hoferb7842a52017-09-22 10:11:33 -0500235 Run Keyword If
236 ... '${skip_if_active}' == 'true' and '${activation}' == '${ACTIVE}'
Charles Paul Hoferb420c572017-10-31 09:24:12 -0500237 ... Run Keywords
238 ... Set Host Software Property ${SOFTWARE_VERSION_URI}${version_id}
239 ... Priority ${0}
240 ... AND
241 ... Return From Keyword
242
Sushil Singh8d8ce962020-06-05 09:43:33 -0500243 Should Be Equal As Strings ${software_state}[Activation] ${READY}
Charles Paul Hofercef61992017-08-18 10:14:18 -0500244
245 # Request the image to be activated.
246 ${args}= Create Dictionary data=${REQUESTED_ACTIVE}
247 Write Attribute ${SOFTWARE_VERSION_URI}${version_id}
248 ... RequestedActivation data=${args}
249 ${software_state}= Read Properties ${SOFTWARE_VERSION_URI}${version_id}
Sushil Singh8d8ce962020-06-05 09:43:33 -0500250 Should Be Equal As Strings ${software_state}[RequestedActivation]
Charles Paul Hofercef61992017-08-18 10:14:18 -0500251 ... ${REQUESTED_ACTIVE}
252
George Keishing71c24ed2017-09-25 13:11:10 -0500253 # Does caller want to wait for activation to complete?
Charles Paul Hofere0e17802017-09-21 09:19:33 -0500254 Return From Keyword If '${wait}' == '${0}' ${version_id}
George Keishing71c24ed2017-09-25 13:11:10 -0500255
Charles Paul Hofercef61992017-08-18 10:14:18 -0500256 # Verify code update was successful and Activation state is Active.
257 Wait For Activation State Change ${version_id} ${ACTIVATING}
258 ${software_state}= Read Properties ${SOFTWARE_VERSION_URI}${version_id}
Sushil Singh8d8ce962020-06-05 09:43:33 -0500259 Should Be Equal As Strings ${software_state}[Activation] ${ACTIVE}
Charles Paul Hofercef61992017-08-18 10:14:18 -0500260
George Keishingd5949852018-01-31 12:56:55 -0600261 # Uploaded and activated image should have priority set to 0. Due to timing
Gunnar Mills948e2e22018-03-23 12:54:27 -0500262 # contention, it may take up to 10 seconds to complete updating priority.
George Keishingd5949852018-01-31 12:56:55 -0600263 Wait Until Keyword Succeeds 10 sec 5 sec
264 ... Check Software Object Attribute ${version_id} Priority ${0}
265
Charles Paul Hofere0e17802017-09-21 09:19:33 -0500266 [Return] ${version_id}
267
Charles Paul Hofercef61992017-08-18 10:14:18 -0500268
Charles Paul Hofere09408d2017-10-02 14:42:38 -0500269Attempt To Reboot BMC During Image Activation
270 [Documentation] Attempt to reboot the BMC while an image is activating and
271 ... check that the BMC ignores the reboot command and finishes
272 ... activation.
273 [Arguments] ${image_file_path}
274
275 # Description of argument(s):
276 # image_file_path Path to the image to update to.
277
278 # Attempt to reboot during activation.
279 ${version_id}= Upload And Activate Image ${image_file_path}
280 ... wait=${0}
George Keishingfd346d12017-11-20 23:23:01 -0600281 ${resp}= OpenBMC Get Request ${SOFTWARE_VERSION_URI}${version_id}
282 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Charles Paul Hofere09408d2017-10-02 14:42:38 -0500283
George Keishingfd346d12017-11-20 23:23:01 -0600284 OBMC Reboot (off)
Charles Paul Hofere09408d2017-10-02 14:42:38 -0500285
George Keishingfd346d12017-11-20 23:23:01 -0600286 ${resp}= OpenBMC Get Request ${SOFTWARE_VERSION_URI}${version_id}
287 Should Be Equal As Strings ${resp.status_code} ${HTTP_NOT_FOUND}
Charles Paul Hofere09408d2017-10-02 14:42:38 -0500288
289
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -0500290Activate Image And Verify No Duplicate Priorities
291 [Documentation] Upload an image, and then check that no images have the
292 ... same priority.
293 [Arguments] ${image_file_path} ${image_purpose}
294
295 # Description of argument(s):
296 # image_file_path The path to the image to upload.
297 # image_purpose The purpose in the image's MANIFEST file.
298
George Keishing72373f82017-11-20 09:18:41 -0600299 Upload And Activate Image ${image_file_path} skip_if_active=true
Charles Paul Hoferc1fa2bc2017-08-18 16:44:03 -0500300 Verify No Duplicate Image Priorities ${image_purpose}
301
302
Charles Paul Hofera5673162017-08-30 09:49:16 -0500303Set Same Priority For Multiple Images
304 [Documentation] Find two images, set the priorities to be the same, and
305 ... verify that the priorities are not the same.
306 [Arguments] ${version_purpose}
307
308 # Description of argument(s):
309 # version_purpose Either BMC or host version purpose.
310 # (e.g. "xyz.openbmc_project.Software.Version.VersionPurpose.BMC"
311 # "xyz.openbmc_project.Software.Version.VersionPurpose.Host").
312
313 # Make sure we have more than two images.
314 ${software_objects}= Get Software Objects version_type=${version_purpose}
315 ${num_images}= Get Length ${software_objects}
316 Should Be True 1 < ${num_images}
317 ... msg=Only found one image on the BMC with purpose ${version_purpose}.
318
319 # Set the priority of the second image to the priority of the first.
320 ${properties}= Get Host Software Property @{software_objects}[0]
321 Set Host Software Property @{software_objects}[1] Priority
322 ... &{properties}[Priority]
323 Verify No Duplicate Image Priorities ${version_purpose}
324
325 # Set the priority of the first image back to what it was before
326 Set Host Software Property @{software_objects}[0] Priority
327 ... &{properties}[Priority]
328
329
Charles Paul Hoferda24d0a2017-08-09 15:03:40 -0500330Delete Software Object
331 [Documentation] Deletes an image from the BMC.
332 [Arguments] ${software_object}
333
334 # Description of argument(s):
335 # software_object The URI to the software image to delete.
336
337 ${arglist}= Create List
338 ${args}= Create Dictionary data=${arglist}
Adriana Kobylak2e9d9cf2019-08-12 13:48:47 -0500339 ${resp}= OpenBMC Post Request ${software_object}/action/Delete
Charles Paul Hoferda24d0a2017-08-09 15:03:40 -0500340 ... data=${args}
341 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Charles Paul Hofercef61992017-08-18 10:14:18 -0500342
343
344Delete Image And Verify
345 [Documentation] Delete an image from the BMC and verify that it was
346 ... removed from software and the /tmp/images directory.
347 [Arguments] ${software_object} ${version_type}
348
349 # Description of argument(s):
350 # software_object The URI of the software object to delete.
351 # version_type The type of the software object, e.g.
352 # xyz.openbmc_project.Software.Version.VersionPurpose.Host
353 # or xyz.openbmc_project.Software.Version.VersionPurpose.BMC.
354
Gunnar Mills917ba1a2018-04-08 16:42:12 -0500355 Log To Console Deleting ${software_object}
Charles Paul Hofer9f74d3a2017-08-18 09:54:28 -0500356
Charles Paul Hofercef61992017-08-18 10:14:18 -0500357 # Delete the image.
358 Delete Software Object ${software_object}
Charles Paul Hofercef61992017-08-18 10:14:18 -0500359
360 # Verify that it's gone from software.
361 ${software_objects}= Get Software Objects version_type=${version_type}
362 Should Not Contain ${software_objects} ${software_object}
363
364 # Check that there is no file in the /tmp/images directory.
365 ${image_id}= Fetch From Right ${software_object} /
366 BMC Execute Command
367 ... [ ! -d "/tmp/images/${image_id}" ]
George Keishing00715492017-08-18 11:46:37 -0500368
369
Charles Paul Hofere8dc5252017-10-10 13:50:18 -0500370Delete All Non Running BMC Images
371 [Documentation] Delete all BMC images that are not running on the BMC.
372
373 @{datalist}= Create List
374 ${data}= Create Dictionary data=@{datalist}
375 Call Method ${SOFTWARE_VERSION_URI} DeleteAll data=${data}
376
377
George Keishing00715492017-08-18 11:46:37 -0500378Check Error And Collect FFDC
379 [Documentation] Collect FFDC if error log exists.
380
381 ${status}= Run Keyword And Return Status Error Logs Should Not Exist
382 Run Keyword If '${status}' == 'False' FFDC
383 Delete Error Logs
Charles Paul Hofere43fb2f2017-09-26 15:36:18 -0500384
385
386Verify Running BMC Image
387 [Documentation] Verify that the version on the BMC is the same as the
388 ... version in the given image.
389 [Arguments] ${image_file_path}
390
391 # Description of argument(s):
392 # image_file_path Path to the BMC image tarball.
393
394 ${tar_version}= Get Version Tar ${image_file_path}
395 ${bmc_version}= Get BMC Version
396 ${bmc_version}= Remove String ${bmc_version} "
397 Should Be Equal ${tar_version} ${bmc_version}
398
399
400Verify Running Host Image
401 [Documentation] Verify that the version of the PNOR image that is on the
402 ... BMC is the same as the one in the given image.
403 [Arguments] ${image_file_path}
404
405 # Description of argument(s):
406 # image_file_path Path to the PNOR image tarball.
407
408 ${tar_version}= Get Version Tar ${image_file_path}
409 ${pnor_version}= Get PNOR Version
410 Should Be Equal ${tar_version} ${pnor_version}
Charles Paul Hofere0e17802017-09-21 09:19:33 -0500411
George Keishing81ae45b2017-09-28 14:05:04 -0500412
413Get Least Value Priority Image
414 [Documentation] Find the least value in "Priority" attribute and return.
415 [Arguments] ${version_type}
416
417 # Description of argument(s):
418 # version_type Either BMC or host version purpose.
419
420 ${priority_value_list}= Create List
421 ${sw_list}= Get Software Objects version_type=${version_type}
422
Marissa Garza20ccfc72020-06-19 12:51:10 -0500423 FOR ${index} IN @{sw_list}
424 ${priority_value}=
425 ... Read Software Attribute ${index} Priority
426 Append To List ${priority_value_list} ${priority_value}
427 END
George Keishing81ae45b2017-09-28 14:05:04 -0500428 ${min_value}= Min List Value ${priority_value_list}
429
430 [Return] ${min_value}
George Keishingfb762032017-11-14 11:18:21 -0600431
432
433Enable Field Mode And Verify Unmount
434 [Documentation] Enable field mode and check that /usr/local is unmounted.
435
436 # After running, /xyz/openbmc_project/software should look like this:
437 # /xyz/openbmc_project/software
438 # {
439 # "FieldModeEnabled": 1,
440 # "associations": [
441 # [
442 # "active",
443 # "software_version",
444 # "/xyz/openbmc_project/software/fcf8e182"
445 # ],
446 # [
447 # "functional",
Gunnar Millsaf472ce2018-02-27 16:08:27 -0600448 # "functional",
George Keishingfb762032017-11-14 11:18:21 -0600449 # "/xyz/openbmc_project/software/fcf8e182"
450 # ]
451 # ]
452 # }
453
454 ${args}= Create Dictionary data=${1}
455 Write Attribute ${SOFTWARE_VERSION_URI} FieldModeEnabled data=${args}
456 Sleep 5s
457 BMC Execute Command [ ! -d "/usr/local/share" ]
458
George Keishingef97f3f2017-11-15 10:32:59 -0600459
460Disable Field Mode And Verify Unmount
461 [Documentation] Disable field mode, unmask usr local mount and reboot.
462
463 BMC Execute Command /sbin/fw_setenv fieldmode
464 BMC Execute Command /bin/systemctl unmask usr-local.mount
George Keishingc9031582017-12-18 11:58:11 -0600465 OBMC Reboot (off) stack_mode=normal
George Keishingef97f3f2017-11-15 10:32:59 -0600466 BMC Execute Command [ -d "/usr/local/share" ]
467
George Keishing13b8a212017-11-17 00:35:13 -0600468
469Field Mode Should Be Enabled
470 [Documentation] Check that field mode is enabled.
471
472 ${value}= Read Attribute ${SOFTWARE_VERSION_URI} FieldModeEnabled
473 Should Be True ${value} ${1}
Sweta Potthuri8c7ada42018-01-15 05:05:59 -0600474
475List Installed Images
476 [Documentation] List all the installed images.
477 [Arguments] ${image_type}
478
Gunnar Mills948e2e22018-03-23 12:54:27 -0500479 # Description of argument(s):
Sweta Potthuri8c7ada42018-01-15 05:05:59 -0600480 # image_type Either "BMC" or "PNOR".
481
482 # List the installed images.
483 ${installed_images}= Get Software Objects
484 ... ${SOFTWARE_PURPOSE}.${image_type}
485
486 Run Keyword If ${installed_images} != []
487 ... Get List of Images ${installed_images}
488 ... ELSE Log No ${image_type} images are present.
489
490Get List of Images
491 [Documentation] Get List of Images
492 [Arguments] ${installed_images}
493
Sushil Singh8d8ce962020-06-05 09:43:33 -0500494 FOR ${uri} IN @{installed_images}
495 ${resp}= OpenBMC Get Request ${uri}
496 ${json}= To JSON ${resp.content}
497 Log ${json["data"]}
498 END
George Keishingd5949852018-01-31 12:56:55 -0600499
500
501Check Software Object Attribute
502 [Documentation] Get the software property of a given object and verify.
503 [Arguments] ${image_object} ${sw_attribute} ${value}
504
505 # Description of argument(s):
506 # image_object Image software object name.
507 # sw_attribute Software attribute name.
508 # (e.g. "Activation", "Priority", "RequestedActivation" etc).
509 # value Software attribute value to compare.
510
511 ${data}= Read Attribute
512 ... ${SOFTWARE_VERSION_URI}${image_object} ${sw_attribute}
513
514 Should Be True ${data} == ${value}
515 ... msg=Given attribute value ${data} mismatch ${value}.
George Keishing0b837432018-03-20 13:46:10 -0500516
517
518Image Should Be Signed
519 [Documentation] Fail if the image is not signed.
520
521 Directory Should Exist ${ACTIVATION_DIR_PATH}
522 ... msg=${ACTIVATION_DIR_PATH} does not exist. Therefore, the image is not signed.
George Keishingcba6d422019-07-09 15:01:59 -0500523
524
525Get Latest Image ID
526 [Documentation] Return the ID of the most recently extracted image.
527 # Note: This keyword will fail if there is no such file.
528
529 # Example: # ls /tmp/images/
530 # 1b714fb7
531 ${image_id}= Get Latest File /tmp/images/
George Keishingcba6d422019-07-09 15:01:59 -0500532
George Keishinge25113a2021-06-18 13:50:43 -0500533 Return From Keyword If '${image_id}' != '${EMPTY}' ${image_id}
George Keishingcba6d422019-07-09 15:01:59 -0500534
George Keishinge25113a2021-06-18 13:50:43 -0500535 ${image_id}= Get Image Id Updating
George Keishingcba6d422019-07-09 15:01:59 -0500536 [Return] ${image_id}
537
538
539Check Image Update Progress State
540 [Documentation] Check that the image update progress state matches the specified state.
541 [Arguments] ${match_state} ${image_id}
542
543 # Description of argument(s):
544 # match_state The expected state. This may be one or more comma-separated values
545 # (e.g. "Disabled", "Disabled, Updating"). If the actual state matches
546 # any of the states named in this argument, this keyword passes.
547 # image_id The image ID (e.g. "1b714fb7").
548
549 ${state}= Get Image Update Progress State image_id=${image_id}
Michael Walshe7edb222019-08-19 17:39:38 -0500550 Valid Value state valid_values=[${match_state}]
George Keishingcba6d422019-07-09 15:01:59 -0500551
552
Sushil Singh5fe1e022021-06-13 23:50:59 -0500553Get Image Id
554 [Documentation] Get image id.
555 [Arguments] ${match_state}
556
557 # Description of argument(s):
558 # match_state The expected state. This may be one or more comma-separated values
559 # (e.g. "Disabled", "Disabled, Updating"). If the actual state matches
560 # any of the states named in this argument, this keyword passes.
561
562 ${sw_member_list}= Redfish.Get Members List /redfish/v1/UpdateService/FirmwareInventory
563
564 FOR ${sw_member} IN @{sw_member_list}
565 ${status}= Redfish.Get Attribute ${sw_member} Status
566 Return From Keyword If '${status['State']}' == ${match_state} ${sw_member.split('/')[-1]}
567 END
568
569 [Return] None
570
571
George Keishingcba6d422019-07-09 15:01:59 -0500572Get Image Update Progress State
573 [Documentation] Return the current state of the image update.
574 [Arguments] ${image_id}
575
576 # Description of argument(s):
577 # image_id The image ID (e.g. "1b714fb7").
578
579 # In this example, this keyword would return the value "Enabled".
580 # "Status": {
581 # "Health": "OK",
582 # "HealthRollup": "OK",
583 # "State": "Enabled"
584 # },
585 ${status}= Redfish.Get Attribute /redfish/v1/UpdateService/FirmwareInventory/${image_id} Status
586 Rprint Vars status
587
588 [Return] ${status["State"]}
589
590
591Get Firmware Image Version
592 [Documentation] Get the version of the currently installed firmware and return it.
593 [Arguments] ${image_id}
594
595 # Description of argument(s):
596 # image_id The image ID (e.g. "1b714fb7").
597
598 # Example of a version returned by this keyword:
599 # 2.8.0-dev-19-g6d5764b33
600 ${version}= Redfish.Get Attribute /redfish/v1/UpdateService/FirmwareInventory/${image_id} Version
601 Rprint Vars version
602
603 [Return] ${version}
George Keishingcfa950c2019-07-18 12:46:46 -0500604
605
Sushil Singhca0bc3b2019-10-17 11:28:41 -0500606Get ApplyTime
607 [Documentation] Get the firmware "ApplyTime" policy.
608 [Arguments] ${policy}
609
610 # Description of argument(s):
611 # policy ApplyTime allowed values (e.g. "OnReset", "Immediate").
612
613 ${system_applytime}= Redfish.Get Attribute ${REDFISH_BASE_URI}UpdateService HttpPushUriOptions
Sushil Singhf617c302020-07-23 01:01:07 -0500614
Sushil Singhca0bc3b2019-10-17 11:28:41 -0500615 [Return] ${system_applytime["HttpPushUriApplyTime"]["ApplyTime"]}
616
617
618Verify Get ApplyTime
619 [Documentation] Get and verify the firmware "ApplyTime" policy.
620 [Arguments] ${policy}
621
622 # Description of argument(s):
623 # policy ApplyTime allowed values (e.g. "OnReset", "Immediate").
624
625 ${system_applytime}= Get ApplyTime ${policy}
Sushil Singhf617c302020-07-23 01:01:07 -0500626 Rprint Vars system_applytime
Sushil Singhca0bc3b2019-10-17 11:28:41 -0500627 Valid Value system_applytime ['${policy}']
628
629
George Keishingcfa950c2019-07-18 12:46:46 -0500630Set ApplyTime
631 [Documentation] Set and verify the firmware "ApplyTime" policy.
632 [Arguments] ${policy}
633
634 # Description of argument(s):
635 # policy ApplyTime allowed values (e.g. "OnReset", "Immediate").
636
Sushil Singh56f590a2019-09-25 11:26:41 -0500637 Redfish.Patch ${REDFISH_BASE_URI}UpdateService
638 ... body={'HttpPushUriOptions' : {'HttpPushUriApplyTime' : {'ApplyTime' : '${policy}'}}}
Sushil Singhca0bc3b2019-10-17 11:28:41 -0500639 Verify Get ApplyTime ${policy}
Sushil Singhc51eee72019-09-01 11:13:37 -0500640
641
642Get Image Version From TFTP Server
643 [Documentation] Get and return the image version
644 ... from the TFTP server.
645 [Arguments] ${server_host} ${image_file_name}
646
647 # Description of argument(s):
648 # server_host The host name or IP address of the TFTP server.
649 # image_file_name The file name of the image.
650
651 Shell Cmd
652 ... curl -s tftp://${server_host}/${image_file_name} > tftp_image.tar
653 ${version}= Get Version Tar tftp_image.tar
654 OperatingSystem.Remove File tftp_image.tar
655
656 [Return] ${version}
657