George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | |
| 3 | r""" |
| 4 | BMC redfish utility functions. |
| 5 | """ |
| 6 | |
| 7 | import json |
George Keishing | 3a6f073 | 2020-07-13 14:21:23 -0500 | [diff] [blame^] | 8 | import re |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 9 | from robot.libraries.BuiltIn import BuiltIn |
Michael Walsh | c86a2f7 | 2019-03-19 13:24:37 -0500 | [diff] [blame] | 10 | import gen_print as gp |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 11 | |
| 12 | |
| 13 | class bmc_redfish_utils(object): |
| 14 | |
George Keishing | eb1fe35 | 2020-06-19 03:02:22 -0500 | [diff] [blame] | 15 | ROBOT_LIBRARY_SCOPE = 'TEST SUITE' |
| 16 | |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 17 | def __init__(self): |
| 18 | r""" |
| 19 | Initialize the bmc_redfish_utils object. |
| 20 | """ |
| 21 | # Obtain a reference to the global redfish object. |
George Keishing | eb1fe35 | 2020-06-19 03:02:22 -0500 | [diff] [blame] | 22 | self.__inited__ = False |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 23 | self._redfish_ = BuiltIn().get_library_instance('redfish') |
| 24 | |
George Keishing | eb1fe35 | 2020-06-19 03:02:22 -0500 | [diff] [blame] | 25 | # There is a possibility that a given driver support both redfish and |
| 26 | # legacy REST. |
| 27 | self._redfish_.login() |
| 28 | self._rest_response_ = \ |
| 29 | self._redfish_.get("/xyz/openbmc_project/", valid_status_codes=[200, 404]) |
| 30 | |
| 31 | # If REST URL /xyz/openbmc_project/ is supported. |
| 32 | if self._rest_response_.status == 200: |
| 33 | self.__inited__ = True |
| 34 | |
| 35 | BuiltIn().set_global_variable("${REDFISH_REST_SUPPORTED}", self.__inited__) |
| 36 | |
George Keishing | 374e684 | 2019-02-20 08:57:18 -0600 | [diff] [blame] | 37 | def get_redfish_session_info(self): |
| 38 | r""" |
| 39 | Returns redfish sessions info dictionary. |
| 40 | |
| 41 | { |
| 42 | 'key': 'yLXotJnrh5nDhXj5lLiH' , |
| 43 | 'location': '/redfish/v1/SessionService/Sessions/nblYY4wlz0' |
| 44 | } |
| 45 | """ |
| 46 | session_dict = { |
George Keishing | 97c9394 | 2019-03-04 12:45:07 -0600 | [diff] [blame] | 47 | "key": self._redfish_.get_session_key(), |
| 48 | "location": self._redfish_.get_session_location() |
George Keishing | 374e684 | 2019-02-20 08:57:18 -0600 | [diff] [blame] | 49 | } |
| 50 | return session_dict |
| 51 | |
Sandhya Somashekar | 37122b6 | 2019-06-18 06:02:02 -0500 | [diff] [blame] | 52 | def get_attribute(self, resource_path, attribute, verify=None): |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 53 | r""" |
| 54 | Get resource attribute. |
| 55 | |
| 56 | Description of argument(s): |
Michael Walsh | c86a2f7 | 2019-03-19 13:24:37 -0500 | [diff] [blame] | 57 | resource_path URI resource absolute path (e.g. |
| 58 | "/redfish/v1/Systems/1"). |
| 59 | attribute Name of the attribute (e.g. 'PowerState'). |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 60 | """ |
| 61 | |
| 62 | resp = self._redfish_.get(resource_path) |
Sandhya Somashekar | 37122b6 | 2019-06-18 06:02:02 -0500 | [diff] [blame] | 63 | |
| 64 | if verify: |
| 65 | if resp.dict[attribute] == verify: |
| 66 | return resp.dict[attribute] |
| 67 | else: |
| 68 | raise ValueError("Attribute value is not equal") |
| 69 | elif attribute in resp.dict: |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 70 | return resp.dict[attribute] |
| 71 | |
| 72 | return None |
| 73 | |
George Keishing | c3c05c2 | 2019-02-19 01:04:54 -0600 | [diff] [blame] | 74 | def get_properties(self, resource_path): |
| 75 | r""" |
| 76 | Returns dictionary of attributes for the resource. |
| 77 | |
| 78 | Description of argument(s): |
Michael Walsh | c86a2f7 | 2019-03-19 13:24:37 -0500 | [diff] [blame] | 79 | resource_path URI resource absolute path (e.g. |
Sandhya Somashekar | 37122b6 | 2019-06-18 06:02:02 -0500 | [diff] [blame] | 80 | /redfish/v1/Systems/1"). |
George Keishing | c3c05c2 | 2019-02-19 01:04:54 -0600 | [diff] [blame] | 81 | """ |
| 82 | |
| 83 | resp = self._redfish_.get(resource_path) |
| 84 | return resp.dict |
| 85 | |
George Keishing | 3a6f073 | 2020-07-13 14:21:23 -0500 | [diff] [blame^] | 86 | def get_endpoint_path_list(self, resource_path, end_point_prefix): |
| 87 | r""" |
| 88 | Returns list with entries ending in "/endpoint". |
| 89 | |
| 90 | Description of argument(s): |
| 91 | resource_path URI resource base path (e.g. "/redfish/v1/Chassis/"). |
| 92 | end_point_prefix Name of the enpoint (e.g. 'Power'). |
| 93 | |
| 94 | Find all list entries ending in "/endpoint" combination such as |
| 95 | /redfish/v1/Chassis/<foo>/Power |
| 96 | /redfish/v1/Chassis/<bar>/Power |
| 97 | """ |
| 98 | |
| 99 | end_point_list = self.list_request(resource_path) |
| 100 | |
| 101 | # Regex to match entries ending in "/prefix" with optional underscore. |
| 102 | regex = ".*/" + end_point_prefix + "[_]?[0-9]*?" |
| 103 | return [x for x in end_point_list if re.match(regex, x, re.IGNORECASE)] |
| 104 | |
George Keishing | 7ec4593 | 2019-02-27 14:02:16 -0600 | [diff] [blame] | 105 | def get_target_actions(self, resource_path, target_attribute): |
| 106 | r""" |
| 107 | Returns resource target entry of the searched target attribute. |
| 108 | |
| 109 | Description of argument(s): |
| 110 | resource_path URI resource absolute path |
George Keishing | f8acde9 | 2019-04-19 19:46:48 +0000 | [diff] [blame] | 111 | (e.g. "/redfish/v1/Systems/system"). |
George Keishing | 7ec4593 | 2019-02-27 14:02:16 -0600 | [diff] [blame] | 112 | target_attribute Name of the attribute (e.g. 'ComputerSystem.Reset'). |
| 113 | |
| 114 | Example: |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 115 | "Actions": { |
| 116 | "#ComputerSystem.Reset": { |
| 117 | "ResetType@Redfish.AllowableValues": [ |
George Keishing | 7ec4593 | 2019-02-27 14:02:16 -0600 | [diff] [blame] | 118 | "On", |
| 119 | "ForceOff", |
| 120 | "GracefulRestart", |
| 121 | "GracefulShutdown" |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 122 | ], |
| 123 | "target": "/redfish/v1/Systems/system/Actions/ComputerSystem.Reset" |
| 124 | } |
| 125 | } |
George Keishing | 7ec4593 | 2019-02-27 14:02:16 -0600 | [diff] [blame] | 126 | """ |
| 127 | |
| 128 | global target_list |
| 129 | target_list = [] |
| 130 | |
| 131 | resp_dict = self.get_attribute(resource_path, "Actions") |
| 132 | if resp_dict is None: |
| 133 | return None |
| 134 | |
| 135 | # Recursively search the "target" key in the nested dictionary. |
| 136 | # Populate the target_list of target entries. |
| 137 | self.get_key_value_nested_dict(resp_dict, "target") |
George Keishing | 7ec4593 | 2019-02-27 14:02:16 -0600 | [diff] [blame] | 138 | # Return the matching target URL entry. |
| 139 | for target in target_list: |
| 140 | # target "/redfish/v1/Systems/system/Actions/ComputerSystem.Reset" |
| 141 | if target_attribute in target: |
| 142 | return target |
| 143 | |
| 144 | return None |
| 145 | |
George Keishing | dabf38f | 2019-03-10 09:52:40 -0500 | [diff] [blame] | 146 | def get_member_list(self, resource_path): |
| 147 | r""" |
| 148 | Perform a GET list request and return available members entries. |
| 149 | |
| 150 | Description of argument(s): |
| 151 | resource_path URI resource absolute path |
George Keishing | f8acde9 | 2019-04-19 19:46:48 +0000 | [diff] [blame] | 152 | (e.g. "/redfish/v1/SessionService/Sessions"). |
George Keishing | dabf38f | 2019-03-10 09:52:40 -0500 | [diff] [blame] | 153 | |
| 154 | "Members": [ |
| 155 | { |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 156 | "@odata.id": "/redfish/v1/SessionService/Sessions/Z5HummWPZ7" |
George Keishing | dabf38f | 2019-03-10 09:52:40 -0500 | [diff] [blame] | 157 | } |
| 158 | { |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 159 | "@odata.id": "/redfish/v1/SessionService/Sessions/46CmQmEL7H" |
George Keishing | dabf38f | 2019-03-10 09:52:40 -0500 | [diff] [blame] | 160 | } |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 161 | ], |
George Keishing | dabf38f | 2019-03-10 09:52:40 -0500 | [diff] [blame] | 162 | """ |
| 163 | |
| 164 | member_list = [] |
| 165 | resp_list_dict = self.get_attribute(resource_path, "Members") |
| 166 | if resp_list_dict is None: |
| 167 | return member_list |
| 168 | |
| 169 | for member_id in range(0, len(resp_list_dict)): |
| 170 | member_list.append(resp_list_dict[member_id]["@odata.id"]) |
| 171 | |
| 172 | return member_list |
| 173 | |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 174 | def list_request(self, resource_path): |
| 175 | r""" |
| 176 | Perform a GET list request and return available resource paths. |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 177 | Description of argument(s): |
| 178 | resource_path URI resource absolute path |
George Keishing | f8acde9 | 2019-04-19 19:46:48 +0000 | [diff] [blame] | 179 | (e.g. "/redfish/v1/SessionService/Sessions"). |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 180 | """ |
Michael Walsh | c86a2f7 | 2019-03-19 13:24:37 -0500 | [diff] [blame] | 181 | gp.qprint_executing(style=gp.func_line_style_short) |
Michael Walsh | c86a2f7 | 2019-03-19 13:24:37 -0500 | [diff] [blame] | 182 | # Set quiet variable to keep subordinate get() calls quiet. |
| 183 | quiet = 1 |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 184 | self.__pending_enumeration = set() |
Michael Walsh | c86a2f7 | 2019-03-19 13:24:37 -0500 | [diff] [blame] | 185 | self._rest_response_ = \ |
George Keishing | f8acde9 | 2019-04-19 19:46:48 +0000 | [diff] [blame] | 186 | self._redfish_.get(resource_path, |
| 187 | valid_status_codes=[200, 404, 500]) |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 188 | |
| 189 | # Return empty list. |
| 190 | if self._rest_response_.status != 200: |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 191 | return self.__pending_enumeration |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 192 | self.walk_nested_dict(self._rest_response_.dict) |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 193 | if not self.__pending_enumeration: |
| 194 | return resource_path |
| 195 | for resource in self.__pending_enumeration.copy(): |
Michael Walsh | c86a2f7 | 2019-03-19 13:24:37 -0500 | [diff] [blame] | 196 | self._rest_response_ = \ |
George Keishing | f8acde9 | 2019-04-19 19:46:48 +0000 | [diff] [blame] | 197 | self._redfish_.get(resource, |
| 198 | valid_status_codes=[200, 404, 500]) |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 199 | |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 200 | if self._rest_response_.status != 200: |
| 201 | continue |
| 202 | self.walk_nested_dict(self._rest_response_.dict) |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 203 | return list(sorted(self.__pending_enumeration)) |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 204 | |
Anusha Dathatri | 3e7930d | 2019-11-06 03:55:35 -0600 | [diff] [blame] | 205 | def enumerate_request(self, resource_path, return_json=1, |
| 206 | include_dead_resources=False): |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 207 | r""" |
| 208 | Perform a GET enumerate request and return available resource paths. |
| 209 | |
| 210 | Description of argument(s): |
Michael Walsh | 37e028f | 2019-05-22 16:16:32 -0500 | [diff] [blame] | 211 | resource_path URI resource absolute path (e.g. |
| 212 | "/redfish/v1/SessionService/Sessions"). |
| 213 | return_json Indicates whether the result should be |
| 214 | returned as a json string or as a |
| 215 | dictionary. |
Anusha Dathatri | 3e7930d | 2019-11-06 03:55:35 -0600 | [diff] [blame] | 216 | include_dead_resources Check and return a list of dead/broken URI |
| 217 | resources. |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 218 | """ |
| 219 | |
Michael Walsh | c86a2f7 | 2019-03-19 13:24:37 -0500 | [diff] [blame] | 220 | gp.qprint_executing(style=gp.func_line_style_short) |
| 221 | |
Michael Walsh | 37e028f | 2019-05-22 16:16:32 -0500 | [diff] [blame] | 222 | return_json = int(return_json) |
| 223 | |
Michael Walsh | c86a2f7 | 2019-03-19 13:24:37 -0500 | [diff] [blame] | 224 | # Set quiet variable to keep subordinate get() calls quiet. |
| 225 | quiet = 1 |
| 226 | |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 227 | # Variable to hold enumerated data. |
| 228 | self.__result = {} |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 229 | |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 230 | # Variable to hold the pending list of resources for which enumeration. |
| 231 | # is yet to be obtained. |
| 232 | self.__pending_enumeration = set() |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 233 | |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 234 | self.__pending_enumeration.add(resource_path) |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 235 | |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 236 | # Variable having resources for which enumeration is completed. |
| 237 | enumerated_resources = set() |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 238 | |
Anusha Dathatri | 3e7930d | 2019-11-06 03:55:35 -0600 | [diff] [blame] | 239 | if include_dead_resources: |
| 240 | dead_resources = {} |
| 241 | |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 242 | resources_to_be_enumerated = (resource_path,) |
| 243 | |
| 244 | while resources_to_be_enumerated: |
| 245 | for resource in resources_to_be_enumerated: |
Anusha Dathatri | 6d2d42f | 2019-11-20 06:17:51 -0600 | [diff] [blame] | 246 | # JsonSchemas, SessionService or URLs containing # are not |
| 247 | # required in enumeration. |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 248 | # Example: '/redfish/v1/JsonSchemas/' and sub resources. |
Anusha Dathatri | cdb77db | 2019-09-10 08:10:29 -0500 | [diff] [blame] | 249 | # '/redfish/v1/SessionService' |
Anusha Dathatri | 6d2d42f | 2019-11-20 06:17:51 -0600 | [diff] [blame] | 250 | # '/redfish/v1/Managers/bmc#/Oem' |
| 251 | if ('JsonSchemas' in resource) or ('SessionService' in resource)\ |
| 252 | or ('#' in resource): |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 253 | continue |
| 254 | |
| 255 | self._rest_response_ = \ |
| 256 | self._redfish_.get(resource, valid_status_codes=[200, 404, 500]) |
| 257 | # Enumeration is done for available resources ignoring the |
| 258 | # ones for which response is not obtained. |
| 259 | if self._rest_response_.status != 200: |
Anusha Dathatri | 3e7930d | 2019-11-06 03:55:35 -0600 | [diff] [blame] | 260 | if include_dead_resources: |
| 261 | try: |
| 262 | dead_resources[self._rest_response_.status].append( |
| 263 | resource) |
| 264 | except KeyError: |
| 265 | dead_resources[self._rest_response_.status] = \ |
| 266 | [resource] |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 267 | continue |
| 268 | |
| 269 | self.walk_nested_dict(self._rest_response_.dict, url=resource) |
| 270 | |
| 271 | enumerated_resources.update(set(resources_to_be_enumerated)) |
| 272 | resources_to_be_enumerated = \ |
| 273 | tuple(self.__pending_enumeration - enumerated_resources) |
| 274 | |
Michael Walsh | 37e028f | 2019-05-22 16:16:32 -0500 | [diff] [blame] | 275 | if return_json: |
Anusha Dathatri | 3e7930d | 2019-11-06 03:55:35 -0600 | [diff] [blame] | 276 | if include_dead_resources: |
| 277 | return json.dumps(self.__result, sort_keys=True, |
| 278 | indent=4, separators=(',', ': ')), dead_resources |
| 279 | else: |
| 280 | return json.dumps(self.__result, sort_keys=True, |
| 281 | indent=4, separators=(',', ': ')) |
Michael Walsh | 37e028f | 2019-05-22 16:16:32 -0500 | [diff] [blame] | 282 | else: |
Anusha Dathatri | 3e7930d | 2019-11-06 03:55:35 -0600 | [diff] [blame] | 283 | if include_dead_resources: |
| 284 | return self.__result, dead_resources |
| 285 | else: |
| 286 | return self.__result |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 287 | |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 288 | def walk_nested_dict(self, data, url=''): |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 289 | r""" |
| 290 | Parse through the nested dictionary and get the resource id paths. |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 291 | Description of argument(s): |
| 292 | data Nested dictionary data from response message. |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 293 | url Resource for which the response is obtained in data. |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 294 | """ |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 295 | url = url.rstrip('/') |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 296 | |
| 297 | for key, value in data.items(): |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 298 | |
| 299 | # Recursion if nested dictionary found. |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 300 | if isinstance(value, dict): |
| 301 | self.walk_nested_dict(value) |
| 302 | else: |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 303 | # Value contains a list of dictionaries having member data. |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 304 | if 'Members' == key: |
| 305 | if isinstance(value, list): |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 306 | for memberDict in value: |
| 307 | self.__pending_enumeration.add(memberDict['@odata.id']) |
George Keishing | f2613b7 | 2019-02-13 12:45:59 -0600 | [diff] [blame] | 308 | if '@odata.id' == key: |
Anusha Dathatri | 62dfb86 | 2019-04-23 06:52:16 -0500 | [diff] [blame] | 309 | value = value.rstrip('/') |
| 310 | # Data for the given url. |
| 311 | if value == url: |
| 312 | self.__result[url] = data |
| 313 | # Data still needs to be looked up, |
| 314 | else: |
| 315 | self.__pending_enumeration.add(value) |
George Keishing | 7ec4593 | 2019-02-27 14:02:16 -0600 | [diff] [blame] | 316 | |
| 317 | def get_key_value_nested_dict(self, data, key): |
| 318 | r""" |
| 319 | Parse through the nested dictionary and get the searched key value. |
| 320 | |
| 321 | Description of argument(s): |
| 322 | data Nested dictionary data from response message. |
| 323 | key Search dictionary key element. |
| 324 | """ |
| 325 | |
| 326 | for k, v in data.items(): |
| 327 | if isinstance(v, dict): |
| 328 | self.get_key_value_nested_dict(v, key) |
| 329 | |
| 330 | if k == key: |
| 331 | target_list.append(v) |