1*** Settings *** 2Documentation This module provides general keywords for dump. 3 4Library bmc_ssh_utils.py 5Variables ../data/variables.py 6 7*** Variables *** 8 9*** Keywords *** 10 11Create User Initiated Dump 12 [Documentation] Generate user initiated dump and return 13 ... the dump id number (e.g., "5"). Optionally return EMPTY 14 ... if out of dump space. 15 [Arguments] ${check_out_of_space}=${False} 16 17 # Description of Argument(s): 18 # check_out_of_space If ${False}, a dump will be created and 19 # its dump_id will be returned. 20 # If ${True}, either the dump_id will be 21 # returned, or the value ${EMPTY} will be 22 # returned if out of dump space was 23 # detected when creating the dump. 24 25 ${resp}= OpenBMC Get Request ${REST_DUMP_URI} 26 Run Keyword If '${resp.status_code}' == '${HTTP_NOT_FOUND}' 27 ... Set Global Variable ${REST_DUMP_URI} /xyz/openbmc_project/dump/ 28 29 ${data}= Create Dictionary data=@{EMPTY} 30 ${resp}= OpenBMC Post Request 31 ... ${REST_DUMP_URI}action/CreateDump data=${data} quiet=${1} 32 33 Run Keyword If '${check_out_of_space}' == '${False}' 34 ... Run Keyword And Return Get The Dump Id ${resp} 35 ... ELSE 36 ... Run Keyword And Return Check For Too Many Dumps ${resp} 37 38 39Get The Dump Id 40 [Documentation] Wait for the dump to be created. Return the 41 ... dump id number (e.g., "5"). 42 [Arguments] ${resp} 43 44 # Description of Argument(s): 45 # resp Response object from action/Create Dump attempt. 46 # Example object: 47 # { 48 # "data": 5, 49 # "message": "200 OK", 50 # "status": "ok" 51 # }, 52 # The "data" field conveys the id number of the created dump. 53 54 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK} 55 56 Run Keyword If ${resp.json()["data"]} == ${None} 57 ... Fail Dump id returned null. 58 59 ${dump_id}= Set Variable ${json["data"]} 60 61 Wait Until Keyword Succeeds 3 min 15 sec Check Dump Existence 62 ... ${dump_id} 63 64 [Return] ${dump_id} 65 66 67Check For Too Many Dumps 68 [Documentation] Return the dump_id number, or return ${EMPTY} if dump 69 ... creation failed due to too many dumps. 70 [Arguments] ${resp} 71 72 # Description of Argument(s): 73 # resp Response object from action/Create Dump attempt. 74 # Example object if there are too many dumps: 75 # { 76 # "data": { 77 # "description": "xyz.openbmc_project.Dump.Create.Error.QuotaExceeded" 78 # }, 79 # "message": "Dump not captured due to a cap.", 80 # "status": "error" 81 # } 82 83 # If dump was created normally, return the dump_id number. 84 Run Keyword If '${resp.status_code}' == '${HTTP_OK}' 85 ... Run Keyword And Return Get The Dump Id ${resp} 86 87 ${exception}= Set Variable ${resp.json()["message"]} 88 ${at_capacity}= Set Variable Dump not captured due to a cap 89 ${too_many_dumps}= Evaluate $at_capacity in $exception 90 Printn 91 Rprint Vars exception too_many_dumps 92 # If there are too many dumps, return ${EMPTY}, otherwise Fail. 93 ${status}= Run Keyword If ${too_many_dumps} Set Variable ${EMPTY} 94 ... ELSE Fail msg=${exception}. 95 96 [Return] ${status} 97 98 99Verify No Dump In Progress 100 [Documentation] Verify no dump in progress. 101 102 ${dump_progress} ${stderr} ${rc}= BMC Execute Command ls /tmp 103 Should Not Contain ${dump_progress} obmcdump 104 105 106Check Dump Existence 107 [Documentation] Verify if given dump exist. 108 [Arguments] ${dump_id} 109 110 # Description of Argument(s): 111 # dump_id An integer value that identifies a particular dump 112 # object(e.g. 1, 3, 5). 113 114 ${resp}= OpenBMC Get Request ${REST_DUMP_URI} 115 Run Keyword If '${resp.status_code}' == '${HTTP_NOT_FOUND}' 116 ... Set Global Variable ${DUMP_ENTRY_URI} /xyz/openbmc_project/dump/entry/ 117 118 ${resp}= OpenBMC Get Request ${DUMP_ENTRY_URI}${dump_id} 119 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK} 120 121 122Delete BMC Dump 123 [Documentation] Deletes a given bmc dump. 124 [Arguments] ${dump_id} 125 126 # Description of Argument(s): 127 # dump_id An integer value that identifies a particular dump (e.g. 1, 3). 128 129 ${resp}= OpenBMC Get Request ${REST_DUMP_URI} 130 Run Keyword If '${resp.status_code}' == '${HTTP_NOT_FOUND}' 131 ... Set Global Variable ${DUMP_ENTRY_URI} /xyz/openbmc_project/dump/entry/ 132 133 ${args}= Set Variable {"data": []} 134 ${resp}= OpenBMC Post Request 135 ... ${DUMP_ENTRY_URI}${dump_id}/action/Delete data=${args} 136 137 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK} 138 139Delete All Dumps 140 [Documentation] Delete all dumps. 141 142 ${resp}= OpenBMC Get Request ${REST_DUMP_URI} 143 Run Keyword If '${resp.status_code}' == '${HTTP_NOT_FOUND}' 144 ... Set Global Variable ${DUMP_ENTRY_URI} /xyz/openbmc_project/dump/entry/ 145 146 # Check if dump entries exist, if not return. 147 ${resp}= OpenBMC Get Request ${DUMP_ENTRY_URI}list quiet=${1} 148 Return From Keyword If ${resp.status_code} == ${HTTP_NOT_FOUND} 149 150 # Get the list of dump entries and delete them all. 151 ${dump_entries}= Get URL List ${DUMP_ENTRY_URI} 152 FOR ${entry} IN @{dump_entries} 153 ${dump_id}= Fetch From Right ${entry} / 154 Delete BMC Dump ${dump_id} 155 END 156 157 158Redfish Delete BMC Dump 159 [Documentation] Deletes a given BMC dump via Redfish.. 160 [Arguments] ${dump_id} 161 162 # Description of Argument(s): 163 # dump_id An integer value that identifies a particular dump (e.g. 1, 3). 164 165 Redfish.Delete /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries/${dump_id} 166 167 168Redfish Delete All BMC Dumps 169 [Documentation] Delete all BMC dumps via Redfish. 170 171 # Check if dump entries exist, if not return. 172 ${resp}= Redfish.Get /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries 173 Return From Keyword If ${resp.dict["Members@odata.count"]} == ${0} 174 175 Redfish.Post /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Actions/LogService.ClearLog 176 177 178Get Redfish BMC Dump Log Entries 179 [Documentation] Get the BMC dump log entries. 180 181 ${resp}= Redfish.Get ${REDFISH_DUMP_URI} 182 183 [Return] ${resp.dict} 184 185 186Redfish Delete All System Dumps 187 [Documentation] Delete all system dumps via Redfish. 188 189 Redfish.Post /redfish/v1/Systems/system/LogServices/Dump/Actions/LogService.ClearLog 190 191 192Redfish BMC Dump Should Not Exist 193 [Documentation] Verify that there is no BMC dump at dump URI. 194 195 # Verify no dump exists. 196 ${dump_entries}= Get Redfish BMC Dump Log Entries 197 Should Be Equal As Integers 0 ${dump_entries['Members@odata.count']} 198 199 200Delete All BMC Dump 201 [Documentation] Delete all BMC dump entries using "DeleteAll" interface. 202 203 ${resp}= OpenBMC Get Request ${REST_DUMP_URI} 204 Run Keyword If '${resp.status_code}' == '${HTTP_NOT_FOUND}' 205 ... Set Global Variable ${REST_DUMP_URI} /xyz/openbmc_project/dump/ 206 207 ${args}= Set Variable {"data": []} 208 ${resp}= Openbmc Post Request ${REST_DUMP_URI}action/DeleteAll data=${args} 209 Should Be Equal As Strings ${resp.status_code} ${HTTP_OK} 210 211Dump Should Not Exist 212 [Documentation] Verify that BMC dumps do not exist. 213 214 ${resp}= OpenBMC Get Request ${REST_DUMP_URI} 215 Run Keyword If '${resp.status_code}' == '${HTTP_NOT_FOUND}' 216 ... Set Global Variable ${DUMP_ENTRY_URI} /xyz/openbmc_project/dump/entry/ 217 218 ${resp}= OpenBMC Get Request ${DUMP_ENTRY_URI}list quiet=${1} 219 Should Be Equal As Strings ${resp.status_code} ${HTTP_NOT_FOUND} 220 221Check Existence Of BMC Dump File 222 [Documentation] Verify existence of BMC dump file. 223 [Arguments] ${dump_id} 224 225 # Description of argument(s): 226 # dump_id BMC dump identifier 227 228 ${dump_check_cmd}= Set Variable 229 ... ls /var/lib/phosphor-debug-collector/dumps 230 231 # Output of sample BMC Execute command with '2' as dump id is as follows 232 # ls /var/lib/phosphor-debug-collector/dumps/2 233 # obmcdump_2_XXXXXXXXXX.tar.xz 234 ${file_there} ${stderr} ${rc}= BMC Execute Command 235 ... ${dump_check_cmd}/${dump_id} 236 Should End With ${file_there} tar.xz msg=BMC dump file not found. 237 238Get Dump Entries 239 [Documentation] Return dump entries list. 240 241 ${resp}= OpenBMC Get Request ${REST_DUMP_URI} 242 Run Keyword If '${resp.status_code}' == '${HTTP_NOT_FOUND}' 243 ... Set Global Variable ${DUMP_ENTRY_URI} /xyz/openbmc_project/dump/entry/ 244 245 ${dump_entries}= Get URL List ${DUMP_ENTRY_URI} 246 [Return] ${dump_entries} 247 248Trigger Core Dump 249 [Documentation] Trigger core dump. 250 251 # Find the pid of the active ipmid and kill it. 252 ${cmd_buf}= Catenate kill -s SEGV $(ps | egrep ' ipmid$' | 253 ... egrep -v grep | \ cut -c1-6) 254 255 ${cmd_output} ${stderr} ${rc}= BMC Execute Command ${cmd_buf} 256 Should Be Empty ${stderr} msg=BMC execute command error. 257 Should Be Equal As Integers ${rc} ${0} 258 ... msg=BMC execute command return code is not zero. 259 260Initiate BMC Dump Using Redfish And Return Task Id 261 [Documentation] Initiate BMC dump via Redfish and return its task ID. 262 263 ${payload}= Create Dictionary DiagnosticDataType=Manager 264 ${resp}= Redfish.Post 265 ... /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Actions/LogService.CollectDiagnosticData 266 ... body=${payload} valid_status_codes=[${HTTP_ACCEPTED}] 267 268 # Example of response from above Redfish POST request. 269 # "@odata.id": "/redfish/v1/TaskService/Tasks/0", 270 # "@odata.type": "#Task.v1_4_3.Task", 271 # "Id": "0", 272 # "TaskState": "Running", 273 # "TaskStatus": "OK" 274 275 [Return] ${resp.dict['Id']} 276 277Create User Initiated BMC Dump Via Redfish 278 [Documentation] Generate user initiated BMC dump via Redfish and return the dump id number (e.g., "5"). 279 [Arguments] ${skip_dump_completion}=0 280 281 # Description of Argument(s): 282 # skip_dump_completion If skip_dump_completion is set to 0, this 283 # keyword will waiting for BMC dump to 284 # complete and returns the dump id. 285 # Otherwise, the keyword is skipped after 286 # initiating BMC dump and returns dump task id. 287 288 ${payload}= Create Dictionary DiagnosticDataType=Manager 289 ${resp}= Redfish.Post /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Actions/LogService.CollectDiagnosticData 290 ... body=${payload} valid_status_codes=[${HTTP_ACCEPTED}] 291 292 # Example of response from above Redfish POST request. 293 # "@odata.id": "/redfish/v1/TaskService/Tasks/0", 294 # "@odata.type": "#Task.v1_4_3.Task", 295 # "Id": "0", 296 # "TaskState": "Running", 297 # "TaskStatus": "OK" 298 299 Run Keyword If ${skip_dump_completion} != 0 Return From Keyword ${resp.dict['Id']} 300 Wait Until Keyword Succeeds 5 min 15 sec Check Task Completion ${resp.dict['Id']} 301 ${task_id}= Set Variable ${resp.dict['Id']} 302 303 ${task_dict}= Redfish.Get Properties /redfish/v1/TaskService/Tasks/${task_id} 304 305 # Example of HttpHeaders field of task details. 306 # "Payload": { 307 # "HttpHeaders": [ 308 # "Host: <BMC_IP>", 309 # "Accept-Encoding: identity", 310 # "Connection: Keep-Alive", 311 # "Accept: */*", 312 # "Content-Length: 33", 313 # "Location: /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries/2"] 314 # ], 315 # "HttpOperation": "POST", 316 # "JsonBody": "{\"DiagnosticDataType\":\"Manager\"}", 317 # "TargetUri": "/redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Actions/LogService.CollectDiagnosticData" 318 # } 319 320 [Return] ${task_dict["Payload"]["HttpHeaders"][-1].split("/")[-1]} 321 322Auto Generate BMC Dump 323 [Documentation] Auto generate BMC dump. 324 325 ${cmd}= Catenate busctl --verbose call xyz.openbmc_project.Dump.Manager 326 ... /xyz/openbmc_project/dump/bmc xyz.openbmc_project.Dump.Create CreateDump a{sv} 0 327 ${stdout} ${stderr} ${rc}= 328 ... BMC Execute Command ${cmd} 329 [Return] ${stdout} ${stderr} ${rc} 330 331Get Dump Size 332 [Documentation] Get dump size. 333 [Arguments] ${dump_uri} 334 335 # Description of argument(s): 336 # dump_uri Dump URI 337 # (Eg. /xyz/openbmc_project/dump/bmc/entry/1). 338 339 # Example of Dump entry. 340 # "data": { 341 # "CompletedTime": 1616760931, 342 # "Elapsed": 1616760931, 343 # "OffloadUri": "", 344 # "Offloaded": false, 345 # "Password": "", 346 # "Size": 3056, 347 # "SourceDumpId": 117440513, 348 # "StartTime": 1616760931, 349 # "Status": "xyz.openbmc_project.Common.Progress.OperationStatus.Completed", 350 # "VSPString": "" 351 # }, 352 353 Log ${dump_uri} 354 ${dump_data}= Redfish.Get Properties ${dump_uri} 355 [Return] ${dump_data["data"]["Size"]} 356 357Get Dump ID 358 [Documentation] Return dump ID. 359 [Arguments] ${task_id} 360 361 # Description of argument(s): 362 # task_id Task ID. 363 364 # Example of HttpHeaders field of task details. 365 # "Payload": { 366 # "HttpHeaders": [ 367 # "Host: <BMC_IP>", 368 # "Accept-Encoding: identity", 369 # "Connection: Keep-Alive", 370 # "Accept: */*", 371 # "Content-Length: 33", 372 # "Location: /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries/2"] 373 # ], 374 # "HttpOperation": "POST", 375 # "JsonBody": "{\"DiagnosticDataType\":\"Manager\"}", 376 # "TargetUri": 377 # "/redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Actions/LogService.CollectDiagnosticData" 378 # } 379 380 ${task_dict}= Redfish.Get Properties /redfish/v1/TaskService/Tasks/${task_id} 381 ${key} ${value}= Set Variable ${task_dict["Payload"]["HttpHeaders"][-1].split(":")} 382 Run Keyword If '${key}' != 'Location' Fail 383 [Return] ${value.strip('/').split('/')[-1]} 384 385Get Task Status 386 [Documentation] Return task status. 387 [Arguments] ${task_id} 388 389 # Description of argument(s): 390 # task_id Task ID. 391 392 ${resp}= Redfish.Get Properties /redfish/v1/TaskService/Tasks/${task_id} 393 [Return] ${resp['TaskState']} 394 395Check Task Completion 396 [Documentation] Check if the task is complete. 397 [Arguments] ${task_id} 398 399 # Description of argument(s): 400 # task_id Task ID. 401 402 ${task_dict}= Redfish.Get Properties /redfish/v1/TaskService/Tasks/${task_id} 403 Should Be Equal As Strings ${task_dict['TaskState']} Completed 404 405Get Dump ID And Status 406 [Documentation] Return dump ID and status. 407 [Arguments] ${task_id} 408 409 # Description of argument(s): 410 # task_id Task ID. 411 412 Wait Until Keyword Succeeds 10 min 15 sec Check Task Completion ${task_id} 413 ${dump_id}= Get Dump ID ${task_id} 414 [Return] ${dump_id} Completed 415 416 417Create BMC User Dump 418 [Documentation] Generate user initiated BMC dump via Redfish and return 419 ... the task instance Id and response object (e.g., "5"). 420 421 ${payload}= Create Dictionary DiagnosticDataType=Manager 422 ${resp}= Redfish.Post /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Actions/LogService.CollectDiagnosticData 423 ... body=${payload} valid_status_codes=[${HTTP_ACCEPTED}] 424 425 ${ip_resp}= Evaluate json.loads(r'''${resp.text}''') json 426 427 Return From Keyword ${ip_resp["Id"]} ${resp} 428 429 430Wait For Task Completion 431 [Documentation] Check whether the state of task instance matches any of the 432 ... expected completion states before maximum number of retries exceeds and 433 ... exit loop in case completion state is met. 434 [Arguments] ${task_id} ${expected_status} ${retry_max_count}=300 435 ... ${check_state}=${FALSE} 436 437 # Description of argument(s): 438 # task_id the task id for which completion is 439 # to be monitored. 440 # expected_status the task state which is to be considered as the 441 # end of task life cycle. 442 # retry_max_count the maximum number of retry count to wait for 443 # task to reach its completion state. Default 444 # value of retry_max_count is 300. 445 # check_state if set as TRUE, the task state will be 446 # monitored whether the task state value is 447 # valid throughout task life cycle until 448 # expected completion state is reached. 449 # Default value of check_state is FALSE. 450 451 FOR ${retry} IN RANGE ${retry_max_count} 452 ${resp}= Redfish.Get Properties /redfish/v1/TaskService/Tasks/${task_id} 453 ${current_task_state}= Set Variable ${resp["TaskState"]} 454 Rprint Vars current_task_state 455 456 Run Keyword If ${check_state} == ${TRUE} Should Be True 457 ... '${resp["TaskState"]}' in ${allowed_task_state} 458 ... msg=Verify task state is valid 459 460 Exit For Loop If 461 ... '${resp["TaskState"]}' in ${expected_status} 462 463 Sleep 5s 464 END 465 466Get Dump Status In BMC 467 [Documentation] Get dump status from BMC using busctl method. 468 [Arguments] ${dump_uri} 469 470 # Description of argument(s): 471 # dump_uri Dump URI E.g: /xyz/openbmc_project/dump/bmc/entry/7. 472 473 ${cmd}= Catenate busctl get-property xyz.openbmc_project.Dump.Manager 474 ... ${dump_uri} xyz.openbmc_project.Common.Progress Status 475 476 ${stdout} ${stderr} ${rc}= BMC Execute Command ${cmd} 477 Log ${stdout} 478 # Example output: 479 # s "xyz.openbmc_project.Common.Progress.OperationStatus.Completed". 480 481 ${status}= Set Variable ${stdout.split('.')[-1].strip('"')} 482 [Return] ${status} 483 484Verify Dump Status In BMC 485 [Documentation] Verify Dump Status in BMC. 486 [Arguments] ${dump_uri} ${expected_dump_status} 487 488 # Description of argument(s): 489 # dump_uri Dump URI E.g: /xyz/openbmc_project/dump/bmc/entry/7. 490 # expected_dump_status Expected Dump Status (Completed or Failed etc). 491 492 ${dump_status}= Get Dump Status In BMC ${dump_uri} 493 Should Be Equal ${dump_status} ${expected_dump_status} 494