blob: 8d5792e924fca67ce6d780de0af1dfe80f456bba [file] [log] [blame]
Chris Austenb29d2e82016-06-07 12:25:35 -05001*** Settings ***
2Library Collections
3Library String
George Keishingfbd67002022-08-01 11:24:03 -05004Library RequestsLibrary
Chris Austenb29d2e82016-06-07 12:25:35 -05005Library OperatingSystem
Sandhya Somashekar839a0c22019-01-31 05:05:43 -06006Resource resource.robot
George Keishingeaa73b72018-07-30 09:30:16 -05007Library disable_warning_urllib.py
Michael Walshad66c952018-10-04 15:12:47 -05008Library utils.py
Steven Sombarb3489242018-12-13 15:59:02 -06009Library gen_misc.py
Sridevi Ramesheadeef02019-01-17 08:56:18 -060010Library var_funcs.py
George Keishingeaa73b72018-07-30 09:30:16 -050011Resource rest_response_code.robot
Chris Austenb29d2e82016-06-07 12:25:35 -050012
13*** Variables ***
Michael Walsha6723f22016-11-22 11:12:01 -060014# Assign default value to QUIET for programs which may not define it.
15${QUIET} ${0}
Chris Austenb29d2e82016-06-07 12:25:35 -050016
Sridevi Ramesheadeef02019-01-17 08:56:18 -060017${XAUTH_TOKEN} ${EMPTY}
18
Chris Austenb29d2e82016-06-07 12:25:35 -050019*** Keywords ***
20OpenBMC Get Request
manasarm604b8cd2018-01-29 12:14:20 +053021 [Documentation] Do REST GET request and return the result.
22 # Example result data:
23 # Response code:200, Content:{
24 # "data": [
25 # "/xyz/openbmc_project/state/host0",
26 # "/xyz/openbmc_project/state/chassis0",
27 # "/xyz/openbmc_project/state/bmc0"
28 # ],
29 # "message": "200 OK",
30 # "status": "ok"
31 # }
George Keishing41c44cf2017-11-15 08:02:59 -060032 [Arguments] ${uri} ${timeout}=30 ${quiet}=${QUIET} &{kwargs}
manasarm604b8cd2018-01-29 12:14:20 +053033 # Description of argument(s):
34 # uri The URI to establish connection with
35 # (e.g. '/xyz/openbmc_project/software/').
36 # timeout Timeout in seconds to establish connection with URI.
37 # quiet If enabled, turns off logging to console.
38 # kwargs Any additional arguments to be passed directly to the
39 # Get Request call. For example, the caller might
40 # set kwargs as follows:
41 # ${kwargs}= Create Dictionary allow_redirect=${True}.
Michael Walshf00edee2016-12-09 14:10:26 -060042
Sridevi Ramesheadeef02019-01-17 08:56:18 -060043 Initialize OpenBMC ${timeout} quiet=${quiet}
44
Chris Austenb29d2e82016-06-07 12:25:35 -050045 ${base_uri}= Catenate SEPARATOR= ${DBUS_PREFIX} ${uri}
George Keishing4f76cf62020-12-22 06:42:07 -060046 ${headers}= Create Dictionary X-Auth-Token=${XAUTH_TOKEN} Accept=application/json
Sridevi Ramesheadeef02019-01-17 08:56:18 -060047 Set To Dictionary ${kwargs} headers ${headers}
Michael Walsha6723f22016-11-22 11:12:01 -060048 Run Keyword If '${quiet}' == '${0}' Log Request method=Get
49 ... base_uri=${base_uri} args=&{kwargs}
George Keishingfbd67002022-08-01 11:24:03 -050050 ${resp}= GET On Session openbmc ${base_uri} &{kwargs} timeout=${timeout} expected_status=any
51 Run Keyword If '${quiet}' == '${0}' Log Response ${resp}
George Keishing08540c02017-07-19 09:42:50 -050052 Delete All Sessions
George Keishingfbd67002022-08-01 11:24:03 -050053 [Return] ${resp}
Chris Austenb29d2e82016-06-07 12:25:35 -050054
55OpenBMC Post Request
manasarm604b8cd2018-01-29 12:14:20 +053056 [Documentation] Do REST POST request and return the result.
57 # Example result data:
58 # <Response [200]>
Michael Walsha6723f22016-11-22 11:12:01 -060059 [Arguments] ${uri} ${timeout}=10 ${quiet}=${QUIET} &{kwargs}
manasarm604b8cd2018-01-29 12:14:20 +053060 # Description of argument(s):
61 # uri The URI to establish connection with
62 # (e.g. '/xyz/openbmc_project/software/').
63 # timeout Timeout in seconds to establish connection with URI.
64 # quiet If enabled, turns off logging to console.
65 # kwargs Any additional arguments to be passed directly to the
66 # Post Request call. For example, the caller might
67 # set kwargs as follows:
68 # ${kwargs}= Create Dictionary allow_redirect=${True}.
Michael Walsha6723f22016-11-22 11:12:01 -060069
Michael Walshf00edee2016-12-09 14:10:26 -060070 Initialize OpenBMC ${timeout} quiet=${quiet}
Chris Austenb29d2e82016-06-07 12:25:35 -050071 ${base_uri}= Catenate SEPARATOR= ${DBUS_PREFIX} ${uri}
Sridevi Ramesheadeef02019-01-17 08:56:18 -060072 ${headers}= Create Dictionary Content-Type=application/json
73 ... X-Auth-Token=${XAUTH_TOKEN}
George Keishingfbd67002022-08-01 11:24:03 -050074 Set To Dictionary ${kwargs} headers ${headers}
Michael Walsha6723f22016-11-22 11:12:01 -060075 Run Keyword If '${quiet}' == '${0}' Log Request method=Post
76 ... base_uri=${base_uri} args=&{kwargs}
George Keishingfbd67002022-08-01 11:24:03 -050077 ${ret}= POST On Session openbmc ${base_uri} &{kwargs} timeout=${timeout}
Michael Walsha6723f22016-11-22 11:12:01 -060078 Run Keyword If '${quiet}' == '${0}' Log Response ${ret}
George Keishing08540c02017-07-19 09:42:50 -050079 Delete All Sessions
Chris Austenb29d2e82016-06-07 12:25:35 -050080 [Return] ${ret}
81
82OpenBMC Put Request
manasarm604b8cd2018-01-29 12:14:20 +053083 [Documentation] Do REST PUT request on the resource identified by the URI.
Rahul Maheshwari79c12942016-10-17 09:39:17 -050084 [Arguments] ${uri} ${timeout}=10 &{kwargs}
manasarm604b8cd2018-01-29 12:14:20 +053085 # Description of argument(s):
86 # uri The URI to establish connection with
87 # (e.g. '/xyz/openbmc_project/software/').
88 # timeout Timeout in seconds to establish connection with URI.
89 # kwargs Arguments passed to the REST call.
90 # kwargs Any additional arguments to be passed directly to the
91 # Put Request call. For example, the caller might
92 # set kwargs as follows:
93 # ${kwargs}= Create Dictionary allow_redirect=${True}.
Michael Walshf00edee2016-12-09 14:10:26 -060094
95 Initialize OpenBMC ${timeout}
George Keishingfbd67002022-08-01 11:24:03 -050096 ${base_uri}= Catenate SEPARATOR= ${DBUS_PREFIX} ${uri}
97 ${headers}= Create Dictionary Content-Type=application/json
Sridevi Ramesheadeef02019-01-17 08:56:18 -060098 ... X-Auth-Token=${XAUTH_TOKEN}
George Keishingfbd67002022-08-01 11:24:03 -050099 Log Request method=Put base_uri=${base_uri} args=&{kwargs}
100 ${resp}= PUT On Session openbmc ${base_uri} json=${kwargs["data"]} headers=${headers}
101 Log Response ${resp}
George Keishing08540c02017-07-19 09:42:50 -0500102 Delete All Sessions
George Keishingfbd67002022-08-01 11:24:03 -0500103 [Return] ${resp}
Chris Austenb29d2e82016-06-07 12:25:35 -0500104
105OpenBMC Delete Request
manasarm604b8cd2018-01-29 12:14:20 +0530106 [Documentation] Do REST request to delete the resource identified by the
107 ... URI.
Michael Sheposcc490b42020-08-26 12:53:01 -0500108 [Arguments] ${uri} ${timeout}=10 ${quiet}=${QUIET} &{kwargs}
manasarm604b8cd2018-01-29 12:14:20 +0530109 # Description of argument(s):
110 # uri The URI to establish connection with
111 # (e.g. '/xyz/openbmc_project/software/').
112 # timeout Timeout in seconds to establish connection with URI.
Michael Sheposcc490b42020-08-26 12:53:01 -0500113 # quiet If enabled, turns off logging to console.
manasarm604b8cd2018-01-29 12:14:20 +0530114 # kwargs Any additional arguments to be passed directly to the
115 # Delete Request call. For example, the caller might
116 # set kwargs as follows:
117 # ${kwargs}= Create Dictionary allow_redirect=${True}.
Michael Walshf00edee2016-12-09 14:10:26 -0600118
119 Initialize OpenBMC ${timeout}
Chris Austenb29d2e82016-06-07 12:25:35 -0500120 ${base_uri}= Catenate SEPARATOR= ${DBUS_PREFIX} ${uri}
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600121 ${headers}= Create Dictionary Content-Type=application/json
122 ... X-Auth-Token=${XAUTH_TOKEN}
123 Set To Dictionary ${kwargs} headers ${headers}
Michael Sheposcc490b42020-08-26 12:53:01 -0500124 Run Keyword If '${quiet}' == '${0}' Log Request method=Delete
125 ... base_uri=${base_uri} args=&{kwargs}
George Keishingfbd67002022-08-01 11:24:03 -0500126 ${ret}= DELETE On Session openbmc ${base_uri} &{kwargs} timeout=${timeout}
Michael Sheposcc490b42020-08-26 12:53:01 -0500127 Run Keyword If '${quiet}' == '${0}' Log Response ${ret}
George Keishing08540c02017-07-19 09:42:50 -0500128 Delete All Sessions
Chris Austenb29d2e82016-06-07 12:25:35 -0500129 [Return] ${ret}
130
131Initialize OpenBMC
manasarm604b8cd2018-01-29 12:14:20 +0530132 [Documentation] Do a REST login connection within specified time.
George Keishing1cdc6dd2017-04-24 15:31:03 -0500133 [Arguments] ${timeout}=20 ${quiet}=${1}
George Keishing7981f432023-11-15 23:49:16 +0530134 ... ${rest_username}=${OPENBMC_USERNAME}
135 ... ${rest_password}=${OPENBMC_PASSWORD}
Michael Walshf00edee2016-12-09 14:10:26 -0600136
George Keishing1cdc6dd2017-04-24 15:31:03 -0500137 # Description of argument(s):
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600138 # timeout REST login attempt time out.
139 # quiet Suppress console log if set.
140 # rest_username The REST username.
141 # rest_password The REST password.
142
143 ${bmcweb_status}= Run Keyword And Return Status BMC Web Login Request
144 ... ${timeout} ${rest_username} ${rest_password}
145
146 Return From Keyword If ${bmcweb_status} == ${True}
George Keishing1cdc6dd2017-04-24 15:31:03 -0500147
George Keishing1cdc6dd2017-04-24 15:31:03 -0500148 # This will retry at 20 second interval.
149 Wait Until Keyword Succeeds 40 sec 20 sec
150 ... Post Login Request ${timeout} ${quiet}
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600151 ... ${rest_username} ${rest_password}
152
153
154BMC Web Login Request
155 [Documentation] Do BMC web-based login.
George Keishing7981f432023-11-15 23:49:16 +0530156 [Arguments] ${timeout}=20 ${rest_username}=${OPENBMC_USERNAME}
157 ... ${rest_password}=${OPENBMC_PASSWORD}
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600158
159 # Description of argument(s):
160 # timeout REST login attempt time out.
161 # rest_username The REST username.
162 # rest_password The REST password.
163
164 Create Session openbmc ${AUTH_URI} timeout=${timeout}
165
166 ${headers}= Create Dictionary Content-Type=application/json
167 @{credentials}= Create List ${rest_username} ${rest_password}
168 ${data}= Create Dictionary data=@{credentials}
George Keishingfbd67002022-08-01 11:24:03 -0500169 ${resp}= POST On Session openbmc /login json=${data} headers=${headers}
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600170 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
171
172 ${processed_token_data}=
173 ... Evaluate re.split(r'[;,]', '${resp.headers["Set-Cookie"]}') modules=re
174 ${result}= Key Value List To Dict ${processed_token_data} delim==
175
176 # Example result data:
177 # 'XSRF-TOKEN=hQuOyDJFEIbrN4aOg2CT; Secure,
178 # SESSION=c4wloTiETumSxPI9nLeg; Secure; HttpOnly'
179 Set Global Variable ${XAUTH_TOKEN} ${result['session']}
180
George Keishing1cdc6dd2017-04-24 15:31:03 -0500181
182Post Login Request
manasarm604b8cd2018-01-29 12:14:20 +0530183 [Documentation] Do REST login request.
George Keishing1cdc6dd2017-04-24 15:31:03 -0500184 [Arguments] ${timeout}=20 ${quiet}=${1}
George Keishing7981f432023-11-15 23:49:16 +0530185 ... ${rest_username}=${OPENBMC_USERNAME}
186 ... ${rest_password}=${OPENBMC_PASSWORD}
George Keishing1cdc6dd2017-04-24 15:31:03 -0500187
188 # Description of argument(s):
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600189 # timeout REST login attempt time out.
190 # quiet Suppress console log if set.
191 # rest_username The REST username.
192 # rest_password The REST password.
George Keishing1cdc6dd2017-04-24 15:31:03 -0500193
194 Create Session openbmc ${AUTH_URI} timeout=${timeout} max_retries=3
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600195
Michael Walsha6723f22016-11-22 11:12:01 -0600196 ${headers}= Create Dictionary Content-Type=application/json
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600197 @{credentials}= Create List ${rest_username} ${rest_password}
George Keishing695ffe82022-08-17 22:00:03 -0500198 ${data}= Create Dictionary data=@{credentials}
George Keishingfbd67002022-08-01 11:24:03 -0500199 ${status} ${resp}= Run Keyword And Ignore Error POST On Session openbmc
George Keishing695ffe82022-08-17 22:00:03 -0500200 ... /login json=${data} headers=${headers}
Michael Walshf00edee2016-12-09 14:10:26 -0600201
202 Should Be Equal ${status} PASS msg=${resp}
203 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Chris Austenb29d2e82016-06-07 12:25:35 -0500204
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600205
George Keishinge8225522017-03-31 09:21:13 -0500206Log Out OpenBMC
manasarm604b8cd2018-01-29 12:14:20 +0530207 [Documentation] Log out of the openbmc REST session.
George Keishinge8225522017-03-31 09:21:13 -0500208
209 ${headers}= Create Dictionary Content-Type=application/json
Sridevi Ramesheadeef02019-01-17 08:56:18 -0600210 ... X-Auth-Token=${XAUTH_TOKEN}
George Keishinge8225522017-03-31 09:21:13 -0500211 ${data}= Create dictionary data=@{EMPTY}
212
George Keishinge16f1582022-12-15 07:32:21 -0600213 # If there is no active session it will throw the following exception
George Keishinge8225522017-03-31 09:21:13 -0500214 # "Non-existing index or alias 'openbmc'"
George Keishingfbd67002022-08-01 11:24:03 -0500215 ${resp}= POST On Session openbmc
George Keishing695ffe82022-08-17 22:00:03 -0500216 ... /logout json=${data} headers=${headers}
George Keishinge8225522017-03-31 09:21:13 -0500217
218 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
219 ... msg=${resp}
220
George Keishingfbd67002022-08-01 11:24:03 -0500221
Chris Austenb29d2e82016-06-07 12:25:35 -0500222Log Request
manasarm604b8cd2018-01-29 12:14:20 +0530223 [Documentation] Log the specific REST URI, method name on the console.
Chris Austenb29d2e82016-06-07 12:25:35 -0500224 [Arguments] &{kwargs}
Michael Walsha6723f22016-11-22 11:12:01 -0600225 ${msg}= Catenate SEPARATOR= URI: ${AUTH_URI} ${kwargs["base_uri"]}
226 ... , method: ${kwargs["method"]} , args: ${kwargs["args"]}
Chris Austenb29d2e82016-06-07 12:25:35 -0500227 Logging ${msg} console=True
228
George Keishingfbd67002022-08-01 11:24:03 -0500229
Chris Austenb29d2e82016-06-07 12:25:35 -0500230Log Response
manasarm604b8cd2018-01-29 12:14:20 +0530231 [Documentation] Log the response code on the console.
Chris Austenb29d2e82016-06-07 12:25:35 -0500232 [Arguments] ${resp}
George Keishingfbd67002022-08-01 11:24:03 -0500233
Michael Walsha6723f22016-11-22 11:12:01 -0600234 ${msg}= Catenate SEPARATOR= Response code: ${resp.status_code}
235 ... , Content: ${resp.content}
Chris Austenb29d2e82016-06-07 12:25:35 -0500236 Logging ${msg} console=True
237
George Keishingfbd67002022-08-01 11:24:03 -0500238
Chris Austenb29d2e82016-06-07 12:25:35 -0500239Logging
manasarm604b8cd2018-01-29 12:14:20 +0530240 [Documentation] Log the specified message on the console.
Chris Austenb29d2e82016-06-07 12:25:35 -0500241 [Arguments] ${msg} ${console}=default False
George Keishingfbd67002022-08-01 11:24:03 -0500242 Log ${msg} console=True
243
Chris Austenb29d2e82016-06-07 12:25:35 -0500244
245Read Attribute
manasarm604b8cd2018-01-29 12:14:20 +0530246 [Documentation] Retrieve attribute value from URI and return result.
247 # Example result data for the attribute 'FieldModeEnabled' in
248 # "/xyz/openbmc_project/software/attr/" :
249 # 0
Gunnar Mills38032802016-12-12 13:43:40 -0600250 [Arguments] ${uri} ${attr} ${timeout}=10 ${quiet}=${QUIET}
manasarmc505e382018-02-05 14:05:48 +0530251 ... ${expected_value}=${EMPTY}
manasarm604b8cd2018-01-29 12:14:20 +0530252 # Description of argument(s):
253 # uri URI of the object that the attribute lives on
254 # (e.g. '/xyz/openbmc_project/software/').
255 # attr Name of the attribute (e.g. 'FieldModeEnabled').
256 # timeout Timeout for the REST call.
257 # quiet If enabled, turns off logging to console.
manasarmc505e382018-02-05 14:05:48 +0530258 # expected_value If this argument is not empty, the retrieved value
259 # must match this value.
manasarm604b8cd2018-01-29 12:14:20 +0530260
Steven Sombarb3489242018-12-13 15:59:02 -0600261 # Make sure uri ends with slash.
262 ${uri}= Add Trailing Slash ${uri}
263
264 ${resp}= OpenBMC Get Request ${uri}attr/${attr} timeout=${timeout}
Michael Walsha6723f22016-11-22 11:12:01 -0600265 ... quiet=${quiet}
Michael Walsh9cd61932017-01-17 16:11:02 -0600266 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
manasarmc505e382018-02-05 14:05:48 +0530267 Run Keyword If '${expected_value}' != '${EMPTY}'
George Keishingfbd67002022-08-01 11:24:03 -0500268 ... Should Be Equal As Strings ${expected_value} ${resp.json()["data"]}
269 [Return] ${resp.json()["data"]}
Chris Austenb29d2e82016-06-07 12:25:35 -0500270
Charles Paul Hoferf45e5ee2017-10-04 12:15:48 -0500271
Chris Austenb29d2e82016-06-07 12:25:35 -0500272Write Attribute
Charles Paul Hoferf45e5ee2017-10-04 12:15:48 -0500273 [Documentation] Write a D-Bus attribute with REST.
274 [Arguments] ${uri} ${attr} ${timeout}=10 ${verify}=${FALSE}
275 ... ${expected_value}=${EMPTY} &{kwargs}
276
277 # Description of argument(s):
278 # uri URI of the object that the attribute lives on
279 # (e.g. '/xyz/openbmc_project/software/').
280 # attr Name of the attribute (e.g. 'FieldModeEnabled').
281 # timeout Timeout for the REST call.
282 # verify If set to ${TRUE}, the attribute will be read back to
283 # ensure that its value is set to ${verify_attr}.
284 # expected_value Only used if verify is set to ${TRUE}. The value that
285 # ${attr} should be set to. This defaults to
286 # ${kwargs['data']. There are cases where the caller
287 # expects some other value in which case this value can
288 # be explicitly specified.
289 # kwargs Arguments passed to the REST call. This should always
290 # contain the value to set the property to at the 'data'
291 # key (e.g. data={"data": 1}).
292
George Keishingdf3e65f2018-12-18 13:06:56 -0600293 # Make sure uri ends with slash.
294 ${uri}= Add Trailing Slash ${uri}
295
Charles Paul Hoferf45e5ee2017-10-04 12:15:48 -0500296 ${base_uri}= Catenate SEPARATOR= ${DBUS_PREFIX} ${uri}
George Keishingdf3e65f2018-12-18 13:06:56 -0600297 ${resp}= Openbmc Put Request ${base_uri}attr/${attr}
Michael Walsha6723f22016-11-22 11:12:01 -0600298 ... timeout=${timeout} &{kwargs}
Charles Paul Hoferf45e5ee2017-10-04 12:15:48 -0500299 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
300
301 # Verify the attribute was set correctly if the caller requested it.
302 Return From Keyword If ${verify} == ${FALSE}
303
304 ${expected_value}= Set Variable If '${expected_value}' == '${EMPTY}'
Charles Paul Hofer00401e72017-10-31 11:42:30 -0500305 ... ${kwargs['data']['data']} ${expected_value}
Charles Paul Hoferf45e5ee2017-10-04 12:15:48 -0500306 ${value}= Read Attribute ${uri} ${attr}
307 Should Be Equal ${value} ${expected_value}
308
Chris Austenb29d2e82016-06-07 12:25:35 -0500309Read Properties
manasarm604b8cd2018-01-29 12:14:20 +0530310 [Documentation] Read data part of the URI object and return result.
311 # Example result data:
312 # [u'/xyz/openbmc_project/software/cf7bf9d5',
313 # u'/xyz/openbmc_project/software/5ecb8b2c',
314 # u'/xyz/openbmc_project/software/active',
315 # u'/xyz/openbmc_project/software/functional']
George Keishing335f5362017-06-30 15:11:20 -0500316 [Arguments] ${uri} ${timeout}=10 ${quiet}=${QUIET}
manasarm604b8cd2018-01-29 12:14:20 +0530317 # Description of argument(s):
318 # uri URI of the object
319 # (e.g. '/xyz/openbmc_project/software/').
320 # timeout Timeout for the REST call.
321 # quiet If enabled, turns off logging to console.
322
George Keishing335f5362017-06-30 15:11:20 -0500323 ${resp}= OpenBMC Get Request ${uri} timeout=${timeout} quiet=${quiet}
324 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
Michael Walshad66c952018-10-04 15:12:47 -0500325
George Keishingfbd67002022-08-01 11:24:03 -0500326 [Return] ${resp.json()["data"]}
Chris Austenb29d2e82016-06-07 12:25:35 -0500327
328Call Method
manasarm604b8cd2018-01-29 12:14:20 +0530329 [Documentation] Invoke the specific REST service method.
Gunnar Mills38032802016-12-12 13:43:40 -0600330 [Arguments] ${uri} ${method} ${timeout}=10 ${quiet}=${QUIET} &{kwargs}
manasarm604b8cd2018-01-29 12:14:20 +0530331 # Description of arguments:
332 # uri The URI to establish connection with
333 # (e.g. '/xyz/openbmc_project/software/').
334 # timeout Timeout in seconds to establish connection with URI.
335 # quiet If enabled, turns off logging to console.
336 # kwargs Arguments passed to the REST call.
Michael Walsha6723f22016-11-22 11:12:01 -0600337
Chris Austenb29d2e82016-06-07 12:25:35 -0500338 ${base_uri}= Catenate SEPARATOR= ${DBUS_PREFIX} ${uri}
George Keishing5c231a82019-02-05 09:02:04 -0600339 ${resp}= OpenBmc Post Request ${base_uri}action/${method}
Michael Walsha6723f22016-11-22 11:12:01 -0600340 ... timeout=${timeout} quiet=${quiet} &{kwargs}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600341 [Return] ${resp}
Saqib Khanbb8b63f2017-05-24 10:58:01 -0500342
Sushil Singh47f80132019-08-27 04:53:24 -0500343
Saqib Khanbb8b63f2017-05-24 10:58:01 -0500344Upload Image To BMC
Sushil Singh47f80132019-08-27 04:53:24 -0500345 [Documentation] Upload image to BMC via REST and return status code.
346 [Arguments] ${uri} ${timeout}=10 ${quiet}=${1}
Sushil Singhc08df052020-03-30 00:39:22 -0500347 ... ${valid_status_codes}=[${HTTP_OK}, ${HTTP_ACCEPTED}] &{kwargs}
Saqib Khanbb8b63f2017-05-24 10:58:01 -0500348
349 # Description of argument(s):
Sushil Singh47f80132019-08-27 04:53:24 -0500350 # uri URI for uploading image via REST e.g.
351 # "/upload/image".
352 # timeout Time allocated for the REST command to
353 # return status (specified in Robot
354 # Framework Time Format e.g. "3 mins").
355 # quiet If enabled, turns off logging to console.
356 # valid_status_codes A list of status codes that are valid for
357 # the REST post command. This can be
358 # specified as a string the evaluates to a
359 # python object (e.g. [${HTTP_OK}]).
360 # kwargs A dictionary keys/values to be passed
361 # directly to Post Request.
Saqib Khanbb8b63f2017-05-24 10:58:01 -0500362
363 Initialize OpenBMC ${timeout} quiet=${quiet}
364 ${base_uri}= Catenate SEPARATOR= ${DBUS_PREFIX} ${uri}
365 ${headers}= Create Dictionary Content-Type=application/octet-stream
George Keishing4f76cf62020-12-22 06:42:07 -0600366 ... X-Auth-Token=${XAUTH_TOKEN} Accept=application/json
Saqib Khanbb8b63f2017-05-24 10:58:01 -0500367 Set To Dictionary ${kwargs} headers ${headers}
368 Run Keyword If '${quiet}' == '${0}' Log Request method=Post
369 ... base_uri=${base_uri} args=&{kwargs}
George Keishingfbd67002022-08-01 11:24:03 -0500370 ${ret}= POST On Session openbmc ${base_uri} &{kwargs} timeout=${timeout}
Saqib Khanbb8b63f2017-05-24 10:58:01 -0500371 Run Keyword If '${quiet}' == '${0}' Log Response ${ret}
Sushil Singh47f80132019-08-27 04:53:24 -0500372 Valid Value ret.status_code ${valid_status_codes}
George Keishing08540c02017-07-19 09:42:50 -0500373 Delete All Sessions
Sushil Singh47f80132019-08-27 04:53:24 -0500374
Sushil Singh62098652023-08-31 09:14:50 -0500375 [Return] ${ret}
Sushil Singh47f80132019-08-27 04:53:24 -0500376
George Keishingf4a43972020-06-29 03:55:38 -0500377
378Redfish Login
379 [Documentation] Do BMC web-based login.
George Keishing7981f432023-11-15 23:49:16 +0530380 [Arguments] ${timeout}=20 ${rest_username}=${OPENBMC_USERNAME}
381 ... ${rest_password}=${OPENBMC_PASSWORD} ${kwargs}=${EMPTY}
George Keishingf4a43972020-06-29 03:55:38 -0500382
383 # Description of argument(s):
384 # timeout REST login attempt time out.
385 # rest_username The REST username.
386 # rest_password The REST password.
387 # kwargs Any additional arguments to be passed directly to the
388 # Get Request call. For example, the caller might
389 # set kwargs as follows:
390 # ${kwargs}= Create Dictionary allow_redirect=${True}.
391
George Keishing566daaf2020-07-02 06:18:50 -0500392 Create Session redfish ${AUTH_URI} timeout=${timeout}
George Keishingf4a43972020-06-29 03:55:38 -0500393 ${headers}= Create Dictionary Content-Type=application/json
394 ${data}= Set Variable If '${kwargs}' == '${EMPTY}'
395 ... {"UserName":"${rest_username}", "Password":"${rest_password}"}
396 ... {"UserName":"${rest_username}", "Password":"${rest_password}", ${kwargs}}
397
George Keishingfbd67002022-08-01 11:24:03 -0500398 ${resp}= POST On Session redfish /redfish/v1/SessionService/Sessions
George Keishingf4a43972020-06-29 03:55:38 -0500399 ... data=${data} headers=${headers}
400 Should Be Equal As Strings ${resp.status_code} ${HTTP_CREATED}
401
402 Set Global Variable ${XAUTH_TOKEN} ${resp.headers["X-Auth-Token"]}
403
George Keishingfbd67002022-08-01 11:24:03 -0500404 [Return] ${resp.json()}
George Keishing566daaf2020-07-02 06:18:50 -0500405
406
Sushil Singh4ec68ba2020-09-11 09:16:43 -0500407Redfish Get Request
408 [Documentation] Do REST POST request and return the result.
409 [Arguments] ${uri} ${timeout}=10 ${quiet}=${QUIET} &{kwargs}
410
411 # Description of argument(s):
412 # uri The URI to establish connection with
413 # (e.g. '/xyz/openbmc_project/software/').
414 # timeout Timeout in seconds to establish connection with URI.
415 # quiet If enabled, turns off logging to console.
416 # kwargs Any additional arguments to be passed directly to the
417 # Post Request call. For example, the caller might
418 # set kwargs as follows:
419 # ${kwargs}= Create Dictionary allow_redirect=${True}.
420
421 ${base_uri}= Catenate SEPARATOR= ${DBUS_PREFIX} ${uri}
422 ${headers}= Create Dictionary Content-Type=application/json X-Auth-Token=${XAUTH_TOKEN}
423 Set To Dictionary ${kwargs} headers ${headers}
424 Run Keyword If '${quiet}' == '${0}' Log Request method=Post base_uri=${base_uri} args=&{kwargs}
George Keishingfbd67002022-08-01 11:24:03 -0500425 ${resp}= GET On Session redfish ${base_uri} &{kwargs} timeout=${timeout}
Sushil Singh4ec68ba2020-09-11 09:16:43 -0500426 Run Keyword If '${quiet}' == '${0}' Log Response ${resp}
427
428 [Return] ${resp}
429
430
George Keishing566daaf2020-07-02 06:18:50 -0500431Redfish Post Request
432 [Documentation] Do REST POST request and return the result.
433 [Arguments] ${uri} ${timeout}=10 ${quiet}=${QUIET} &{kwargs}
434
435 # Description of argument(s):
436 # uri The URI to establish connection with
437 # (e.g. '/xyz/openbmc_project/software/').
438 # timeout Timeout in seconds to establish connection with URI.
439 # quiet If enabled, turns off logging to console.
440 # kwargs Any additional arguments to be passed directly to the
441 # Post Request call. For example, the caller might
442 # set kwargs as follows:
443 # ${kwargs}= Create Dictionary allow_redirect=${True}.
444
445 ${base_uri}= Catenate SEPARATOR= ${DBUS_PREFIX} ${uri}
446 ${headers}= Create Dictionary Content-Type=application/json X-Auth-Token=${XAUTH_TOKEN}
447 Set To Dictionary ${kwargs} headers ${headers}
448 Run Keyword If '${quiet}' == '${0}' Log Request method=Post base_uri=${base_uri} args=&{kwargs}
George Keishingfbd67002022-08-01 11:24:03 -0500449 ${resp}= POST On Session redfish ${base_uri} &{kwargs} timeout=${timeout} expected_status=any
George Keishing566daaf2020-07-02 06:18:50 -0500450 Run Keyword If '${quiet}' == '${0}' Log Response ${resp}
451
452 [Return] ${resp}