1*** Settings *** 2Documentation This suite tests Platform Event Log (PEL) functionality of OpenBMC. 3 4Library ../../lib/pel_utils.py 5Variables ../../data/pel_variables.py 6Resource ../../lib/list_utils.robot 7Resource ../../lib/logging_utils.robot 8Resource ../../lib/connection_client.robot 9Resource ../../lib/openbmc_ffdc.robot 10 11Test Setup Redfish.Login 12Test Teardown Run Keywords Redfish.Logout AND FFDC On Test Case Fail 13 14 15*** Variables *** 16 17@{mandatory_pel_fileds} Private Header User Header Primary SRC Extended User Header Failing MTMS 18 19 20*** Test Cases *** 21 22Create Test PEL Log And Verify 23 [Documentation] Create PEL log using busctl command and verify via peltool. 24 [Tags] Create_Test_PEL_Log_And_Verify 25 26 Redfish Purge Event Log 27 Create Test PEL Log 28 ${pel_id}= Get PEL Log Via BMC CLI 29 Should Not Be Empty ${pel_id} msg=System PEL log entry is empty. 30 31 32Verify PEL Log Details 33 [Documentation] Verify PEL log details via peltool. 34 [Tags] Verify_PEL_Log_Details 35 36 Redfish Purge Event Log 37 38 ${bmc_time1}= CLI Get BMC DateTime 39 Create Test PEL Log 40 ${bmc_time2}= CLI Get BMC DateTime 41 42 ${pel_records}= Peltool -l 43 44 # Example output from 'Peltool -l': 45 # pel_records: 46 # [0x50000012]: 47 # [CreatorID]: BMC 48 # [CompID]: 0x1000 49 # [PLID]: 0x50000012 50 # [Subsystem]: BMC Firmware 51 # [Message]: An application had an internal failure 52 # [SRC]: BD8D1002 53 # [Commit Time]: 03/02/2020 09:35:15 54 # [Sev]: Unrecoverable Error 55 56 ${ids}= Get Dictionary Keys ${pel_records} 57 ${id}= Get From List ${ids} 0 58 59 @{pel_fields}= Create List CreatorID Subsystem Message Sev 60 FOR ${field} IN @{pel_fields} 61 Valid Value pel_records['${id}']['${field}'] ['${PEL_DETAILS['${field}']}'] 62 END 63 64 Valid Value pel_records['${id}']['PLID'] ['${id}'] 65 66 # Verify if "CompID" and "SRC" fields of PEL has alphanumeric value. 67 Should Match Regexp ${pel_records['${id}']['CompID']} [a-zA-Z0-9] 68 Should Match Regexp ${pel_records['${id}']['SRC']} [a-zA-Z0-9] 69 70 ${pel_date_time}= Convert Date ${pel_records['${id}']['Commit Time']} 71 ... date_format=%m/%d/%Y %H:%M:%S exclude_millis=yes 72 73 # Convert BMC and PEL time to epoch time before comparing. 74 ${bmc_time1_epoch}= Convert Date ${bmc_time1} epoch 75 ${pel_time_epoch}= Convert Date ${pel_date_time} epoch 76 ${bmc_time2_epoch}= Convert Date ${bmc_time2} epoch 77 78 Should Be True ${bmc_time1_epoch} <= ${pel_time_epoch} <= ${bmc_time2_epoch} 79 80 81Verify Mandatory Sections Of Error Log PEL 82 [Documentation] Verify mandatory sections of error log PEL. 83 [Tags] Verify_Mandatory_Sections_Of_Error_Log_PEL 84 85 Create Test PEL Log 86 87 ${pel_ids}= Get PEL Log Via BMC CLI 88 ${pel_id}= Get From List ${pel_ids} -1 89 ${pel_output}= Peltool -i ${pel_id} 90 ${pel_sections}= Get Dictionary Keys ${pel_output} 91 92 List Should Contain Sub List ${pel_sections} ${mandatory_pel_fileds} 93 94 95Verify PEL Log Persistence After BMC Reboot 96 [Documentation] Verify PEL log persistence after BMC reboot. 97 [Tags] Verify_PEL_Log_Persistence_After_BMC_Reboot 98 99 Create Test PEL Log 100 ${pel_before_reboot}= Get PEL Log Via BMC CLI 101 102 Redfish OBMC Reboot (off) 103 ${pel_after_reboot}= Get PEL Log Via BMC CLI 104 105 List Should Contain Sub List ${pel_after_reboot} ${pel_before_reboot} 106 107 108Verify PEL ID Numbering 109 [Documentation] Verify PEL ID numbering. 110 [Tags] Verify_PEL_ID_Numbering 111 112 Redfish Purge Event Log 113 Create Test PEL Log 114 Create Test PEL Log 115 116 ${pel_ids}= Get PEL Log Via BMC CLI 117 118 # Example of PEL IDs from PEL logs. 119 # [0x50000012]: <--- First PEL ID 120 # [CreatorID]: BMC 121 # [CompID]: 0x1000 122 # [PLID]: 0x50000012 123 # [Subsystem]: BMC Firmware 124 # [Message]: An application had an internal failure 125 # [SRC]: BD8D1002 126 # [Commit Time]: 03/02/2020 09:35:15 127 # [Sev]: Unrecoverable Error 128 # 129 # [0x50000013]: <--- Second PEL ID 130 # [CreatorID]: BMC 131 # [CompID]: 0x1000 132 # [PLID]: 0x50000013 133 # [Subsystem]: BMC Firmware 134 # [Message]: An application had an internal failure 135 # [SRC]: BD8D1002 136 # [Commit Time]: 03/02/2020 09:35:15 137 # [Sev]: Unrecoverable Error 138 139 Should Be True ${pel_ids[1]} == ${pel_ids[0]}+1 140 141Verify Machine Type Model And Serial Number 142 [Documentation] Verify machine type model and serial number from PEL. 143 [Tags] Verify_Machine_Type_Model_And_Serial_Number 144 145 Create Test PEL Log 146 147 ${pel_ids}= Get PEL Log Via BMC CLI 148 ${id}= Get From List ${pel_ids} -1 149 150 ${pel_serial_number}= Get PEL Field Value ${id} Failing MTMS Serial Number 151 ${pel_serial_number}= Replace String Using Regexp ${pel_serial_number} ^0+ ${EMPTY} 152 ${pel_machine_type_model}= Get PEL Field Value ${id} Failing MTMS Machine Type Model 153 ${pel_machine_type_model}= Replace String Using Regexp ${pel_machine_type_model} ^0+ ${EMPTY} 154 155 # Example of "Machine Type Model" and "Serial Number" fields value from "Failing MTMS" section of PEL. 156 # [Failing MTMS]: 157 # [Created by]: 0x2000 158 # [Machine Type Model]: 1234-ABC <---- Machine type 159 # [Section Version]: 1 160 # [Serial Number]: ABCDEFG <---- Serial number 161 # [Sub-section type]: 0 162 163 ${redfish_machine_model}= Redfish.Get Attribute /redfish/v1/Systems/system/ Model 164 ${redfish_machine_model}= Replace String Using Regexp ${redfish_machine_model} ^0+ ${EMPTY} 165 ${redfish_serial_number}= Redfish.Get Attribute /redfish/v1/Systems/system/ SerialNumber 166 ${redfish_serial_number}= Replace String Using Regexp ${redfish_serial_number} ^0+ ${EMPTY} 167 168 Valid Value pel_machine_type_model ['${redfish_machine_model}'] 169 Valid Value pel_serial_number ['${redfish_serial_number}'] 170 171 # Check "Machine Type Model" and "Serial Number" fields value from "Extended User Header" section of PEL. 172 ${pel_machine_type_model}= Get PEL Field Value ${id} Extended User Header Reporting Machine Type 173 ${pel_machine_type_model}= Replace String Using Regexp ${pel_machine_type_model} ^0+ ${EMPTY} 174 ${pel_serial_number}= Get PEL Field Value ${id} Extended User Header Reporting Serial Number 175 ${pel_serial_number}= Replace String Using Regexp ${pel_serial_number} ^0+ ${EMPTY} 176 177 Valid Value pel_machine_type_model ['${redfish_machine_model}'] 178 Valid Value pel_serial_number ['${redfish_serial_number}'] 179 180 181Verify Host Off State From PEL 182 [Documentation] Verify Host off state from PEL. 183 [Tags] Verify_Host_Off_State_From_PEL 184 185 Redfish Power Off stack_mode=skip 186 Create Test PEL Log 187 188 ${pel_ids}= Get PEL Log Via BMC CLI 189 ${id}= Get From List ${pel_ids} -1 190 ${pel_host_state}= Get PEL Field Value ${id} User Data HostState 191 192 Valid Value pel_host_state ['Off'] 193 194 195Verify BMC Version From PEL 196 [Documentation] Verify BMC Version from PEL. 197 [Tags] Verify_BMC_Version_From_PEL 198 199 Create Test PEL Log 200 201 ${pel_ids}= Get PEL Log Via BMC CLI 202 ${id}= Get From List ${pel_ids} -1 203 ${pel_bmc_version}= Get PEL Field Value ${id} User Data FW Version ID 204 205 ${bmc_version}= Get BMC Version 206 Valid Value bmc_version ['${bmc_version}'] 207 208 209Verify PEL Log After Host Poweron 210 [Documentation] Verify PEL log generation while booting host. 211 [Tags] Verify_PEL_Log_After_Host_Poweron 212 213 Redfish Power Off stack_mode=skip 214 Redfish Purge Event Log 215 Redfish Power On stack_mode=skip 216 217 ${pel_informational_error}= Get PEL Log IDs User Header Event Severity Informational Event 218 ${pel_bmc_created_error}= Get PEL Log IDs Private Header Creator Subsystem BMC 219 220 # Get BMC created non-infomational error. 221 ${pel_bmc_error}= Subtract Lists ${pel_bmc_created_error} ${pel_informational_error} 222 223 Should Be Empty ${pel_bmc_error} msg=Unexpected error log generated during Host poweron. 224 225 226Verify BMC Event Log ID 227 [Documentation] Verify BMC Event Log ID from PEL. 228 [Tags] Verify_BMC_Event_Log_ID 229 230 Redfish Purge Event Log 231 Create Test PEL Log 232 233 ${pel_ids}= Get PEL Log Via BMC CLI 234 ${pel_bmc_event_log_id}= Get PEL Field Value ${pel_ids[0]} Private Header BMC Event Log Id 235 236 # Example "BMC Event Log Id" field value from "Private Header" section of PEL. 237 # [Private Header]: 238 # [Created at]: 08/24/1928 12:04:06 239 # [Created by]: 0x584D 240 # [Sub-section type]: 0 241 # [Entry Id]: 0x50000BB7 242 # [Platform Log Id]: 0x8200061D 243 # [CSSVER]: 244 # [Section Version]: 1 245 # [Creator Subsystem]: PHYP 246 # [BMC Event Log Id]: 341 <---- BMC event log id value 247 # [Committed at]: 03/25/1920 12:06:22 248 249 ${redfish_event_logs}= Redfish.Get Properties /redfish/v1/Systems/system/LogServices/EventLog/Entries 250 251 # Example of redfish_event_logs output: 252 # redfish_event_logs: 253 # [@odata.id]: /redfish/v1/Systems/system/LogServices/EventLog/Entries 254 # [Name]: System Event Log Entries 255 # [Members@odata.count]: 1 256 # [@odata.type]: #LogEntryCollection.LogEntryCollection 257 # [Description]: Collection of System Event Log Entries 258 # [Members]: 259 # [0]: 260 # [@odata.id]: /redfish/v1/Systems/system/LogServices/EventLog/Entries/235 261 # [Name]: System Event Log Entry 262 # [Severity]: Critical 263 # [EntryType]: Event 264 # [Created]: 2020-04-02T07:25:13+00:00 265 # [@odata.type]: #LogEntry.v1_5_1.LogEntry 266 # [Id]: 235 <----- Event log ID 267 # [Message]: xyz.openbmc_project.Common.Error.InternalFailure 268 269 Valid Value pel_bmc_event_log_id ['${redfish_event_logs['Members'][0]['Id']}'] 270 271 272Verify FRU Callout 273 [Documentation] Verify FRU callout entries from PEL log. 274 [Tags] Verify_FRU_Callout 275 276 Create Test PEL Log FRU Callout 277 278 ${pel_ids}= Get PEL Log Via BMC CLI 279 ${id}= Get From List ${pel_ids} -1 280 ${pel_callout_section}= Get PEL Field Value ${id} Primary SRC Callout Section 281 282 # Example of PEL Callout Section from "peltool -i <id>" command. 283 # [Callouts]: 284 # [0]: 285 # [FRU Type]: Normal Hardware FRU 286 # [Priority]: Mandatory, replace all with this type as a unit 287 # [Location Code]: U78DA.ND1.1234567-P0 288 # [Part Number]: F191014 289 # [CCIN]: 2E2D 290 # [Serial Number]: YL2E2D010000 291 # [Callout Count]: 1 292 293 Valid Value pel_callout_section['Callout Count'] ['1'] 294 Valid Value pel_callout_section['Callouts'][0]['FRU Type'] ['Normal Hardware FRU'] 295 Should Contain ${pel_callout_section['Callouts'][0]['Priority']} Mandatory 296 297 # Verify Location Code field of PEL callout with motherboard's Location Code. 298 ${busctl_output}= BMC Execute Command ${CMD_INVENTORY_PREFIX} com.ibm.ipzvpd.Location LocationCode 299 Should Be Equal ${pel_callout_section['Callouts'][0]['Location Code']} 300 ... ${busctl_output[0].split('"')[1].strip('"')} 301 302 # TODO: Compare CCIN and part number fields of PEL callout with Redfish or busctl output. 303 Should Match Regexp ${pel_callout_section['Callouts'][0]['CCIN']} [a-zA-Z0-9] 304 Should Match Regexp ${pel_callout_section['Callouts'][0]['Part Number']} [a-zA-Z0-9] 305 306 # Verify Serial Number field of PEL callout with motherboard's Serial Number. 307 ${busctl_output}= BMC Execute Command 308 ... ${CMD_INVENTORY_PREFIX} xyz.openbmc_project.Inventory.Decorator.Asset SerialNumber 309 Should Be Equal ${pel_callout_section['Callouts'][0]['Serial Number']} 310 ... ${busctl_output[0].split('"')[1].strip('"')} 311 312 313Verify Procedure And Symbolic FRU Callout 314 [Documentation] Verify procedure and symbolic FRU callout from PEL log. 315 [Tags] Verify_Procedure_And_Symbolic_FRU_Callout 316 317 Create Test PEL Log Procedure And Symbolic FRU Callout 318 319 ${pel_ids}= Get PEL Log Via BMC CLI 320 ${id}= Get From List ${pel_ids} -1 321 ${pel_callout_section}= Get PEL Field Value ${id} Primary SRC Callout Section 322 323 # Example of PEL Callout Section from "peltool -i <id>" command. 324 # [Callouts]: 325 # [0]: 326 # [Priority]: Mandatory, replace all with this type as a unit 327 # [Procedure Number]: BMCSP02 328 # [FRU Type]: Maintenance Procedure Required 329 # [1]: 330 # [Priority]: Medium Priority 331 # [Part Number]: SVCDOCS 332 # [FRU Type]: Symbolic FRU 333 # [Callout Count]: 2 334 335 Valid Value pel_callout_section['Callout Count'] ['2'] 336 337 # Verify procedural callout info. 338 339 Valid Value pel_callout_section['Callouts'][0]['FRU Type'] ['Maintenance Procedure Required'] 340 Should Contain ${pel_callout_section['Callouts'][0]['Priority']} Mandatory 341 # Verify if "Procedure Number" field of PEL has an alphanumeric value. 342 Should Match Regexp ${pel_callout_section['Callouts'][0]['Procedure']} [a-zA-Z0-9] 343 344 # Verify procedural callout info. 345 346 Valid Value pel_callout_section['Callouts'][1]['FRU Type'] ['Symbolic FRU'] 347 Should Contain ${pel_callout_section['Callouts'][1]['Priority']} Medium Priority 348 # Verify if "Part Number" field of Symbolic FRU has an alphanumeric value. 349 Should Match Regexp ${pel_callout_section['Callouts'][1]['Part Number']} [a-zA-Z0-9] 350 351 352Verify PEL Log Entry For Event Log 353 [Documentation] Create an event log and verify PEL log entry in BMC for the same. 354 [Tags] Verify_PEL_Log_Entry_For_Event_Log 355 356 Redfish Purge Event Log 357 358 # Create an unrecoverable error log. 359 Create Test PEL Log Unrecoverable Error 360 361 ${elog_entry}= Get Event Logs 362 # Example of Redfish event logs: 363 # elog_entry: 364 # [0]: 365 # [Message]: BD802003 event in subsystem: Platform Firmware 366 # [Created]: 2020-04-20T01:55:22+00:00 367 # [Id]: 1 368 # [@odata.id]: /redfish/v1/Systems/system/LogServices/EventLog/Entries/1 369 # [@odata.type]: #LogEntry.v1_4_0.LogEntry 370 # [EntryType]: Event 371 # [Severity]: Critical 372 # [Name]: System Event Log Entry 373 374 ${redfish_log_time}= Convert Date ${elog_entry[0]["Created"]} epoch 375 376 ${pel_records}= Peltool -l 377 # Example output from 'Peltool -l': 378 # pel_records: 379 # [0x50000023]: 380 # [SRC]: BD802003 381 # [CreatorID]: BMC 382 # [Message]: This is a test error 383 # [CompID]: 0x2000 384 # [PLID]: 0x500053D9 385 # [Commit Time]: 04/20/2020 01:55:22 386 # [Subsystem]: Platform Firmware 387 # [Sev]: Unrecoverable Error 388 389 ${ids}= Get Dictionary Keys ${pel_records} 390 ${id}= Get From List ${ids} 0 391 ${pel_log_time}= Convert Date ${pel_records['${id}']['Commit Time']} epoch 392 ... date_format=%m/%d/%Y %H:%M:%S 393 394 # Verify that both Redfish event and PEL has log entry for internal error with same time stamp. 395 Should Contain Any ${pel_records['${id}']['Message']} test error ignore_case=True 396 Should Contain ${elog_entry[0]['Message']} 397 ... ${pel_records['${id}']['SRC']} ignore_case=True 398 399 Should Be Equal ${redfish_log_time} ${pel_log_time} 400 401 402Verify Delete All PEL 403 [Documentation] Verify deleting all PEL logs. 404 [Tags] Verify_Delete_All_PEL 405 406 Create Test PEL Log 407 Create Test PEL Log 408 Peltool --delete-all False 409 410 ${pel_ids}= Get PEL Log Via BMC CLI 411 Should Be Empty ${pel_ids} 412 413 414Verify Informational Error Log 415 [Documentation] Create an informational error log and verify. 416 [Tags] Verify_Informational_Error_Log 417 418 Redfish Purge Event Log 419 # Create an informational error log. 420 BMC Execute Command ${CMD_INFORMATIONAL_ERROR} 421 ${pel_records}= Peltool -lfh 422 423 # An example of information error log data: 424 # { 425 # "0x500006A0": { 426 # "SRC": "BD8D1002", 427 # "Message": "An application had an internal failure", 428 # "PLID": "0x500006A0", 429 # "CreatorID": "BMC", 430 # "Subsystem": "BMC Firmware", 431 # "Commit Time": "10/14/2020 11:41:38", 432 # "Sev": "Informational Event", 433 # "CompID": "0x1000" 434 # } 435 # } 436 437 ${ids}= Get Dictionary Keys ${pel_records} 438 ${id}= Get From List ${ids} 0 439 Should Contain ${pel_records['${id}']['Sev']} Informational 440 441 442Verify Predictable Error Log 443 [Documentation] Create a predictive error and verify. 444 [Tags] Verify_Predictable_Error_Log 445 446 # Create a predictable error log. 447 BMC Execute Command ${CMD_PREDICTIVE_ERROR} 448 ${pel_records}= Peltool -l 449 450 # An example of predictive error log data: 451 # { 452 # "0x5000069E": { 453 # "SRC": "BD8D1002", 454 # "Message": "An application had an internal failure", 455 # "PLID": "0x5000069E", 456 # "CreatorID": "BMC", 457 # "Subsystem": "BMC Firmware", 458 # "Commit Time": "10/14/2020 11:40:07", 459 # "Sev": "Predictive Error", 460 # "CompID": "0x1000" 461 # } 462 # } 463 464 ${pel_ids}= Get PEL Log Via BMC CLI 465 ${id}= Get From List ${pel_ids} -1 466 Should Contain ${pel_records['${id}']['Sev']} Predictive 467 468 469Verify Unrecoverable Error Log 470 [Documentation] Create an unrecoverable error and verify. 471 [Tags] Verify_Unrecoverable_Error_Log 472 473 # Create an internal failure error log. 474 BMC Execute Command ${CMD_UNRECOVERABLE_ERROR} 475 ${pel_records}= Peltool -l 476 477 # An example of unrecoverable error log data: 478 # { 479 # "0x50000CC5": { 480 # "SRC": "BD8D1002", 481 # "Message": "An application had an internal failure", 482 # "PLID": "0x50000CC5", 483 # "CreatorID": "BMC", 484 # "Subsystem": "BMC Firmware", 485 # "Commit Time": "04/01/2020 16:44:55", 486 # "Sev": "Unrecoverable Error", 487 # "CompID": "0x1000" 488 # } 489 # } 490 491 ${pel_ids}= Get PEL Log Via BMC CLI 492 ${id}= Get From List ${pel_ids} -1 493 Should Contain ${pel_records['${id}']['Sev']} Unrecoverable 494 495 496Verify Error Logging Rotation Policy 497 [Documentation] Verify error logging rotation policy. 498 [Tags] Verify_Error_Logging_Rotation_Policy 499 [Template] Error Logging Rotation Policy 500 501 # Error logs to be created % of total logging space when error 502 # log exceeds max limit. 503 Informational BMC 3000 15 504 Predictive BMC 3000 30 505 Unrecoverable BMC 3000 30 506 Informational BMC 1500, Predictive BMC 1500 45 507 Informational BMC 1500, Unrecoverable BMC 1500 45 508 Unrecoverable BMC 1500, Predictive BMC 1500 30 509 510 511Verify Error Logging Rotation Policy With All Types Of Errors 512 [Documentation] Verify error logging rotation policy with all types of errors. 513 [Tags] Verify_Error_Logging_Rotation_Policy_With_All_Types_Of_Errors 514 [Template] Error Logging Rotation Policy 515 516 # Error logs to be created % of total logging space when error 517 # log exceeds max limit. 518 Unrecoverable BMC 1000, Informational BMC 1000, Predictive BMC 1000 45 519 520 521Verify Error Logging Rotation Policy With HOST Error Logs 522 [Documentation] Verify error logging rotation policy for non bmc error logs. 523 [Tags] Verify_Error_Logging_Rotation_Policy_With_HOST_Error_Logs 524 [Setup] Run Keywords Open Connection for SCP AND scp.Put File ${UNRECOVERABLE_FILE_PATH} 525 ... /tmp/FILE_HOST_UNRECOVERABLE AND scp.Put File ${INFORMATIONAL_FILE_PATH} 526 ... /tmp/FILE_HOST_INFORMATIONAL 527 [Template] Error Logging Rotation Policy 528 529 # Error logs to be created % of total logging space when error 530 # log exceeds max limit. 531 Informational HOST 3000 15 532 Unrecoverable HOST 3000 30 533 Informational HOST 1500, Informational BMC 1500 30 534 Informational HOST 1500, Unrecoverable BMC 1500 45 535 Unrecoverable HOST 1500, Informational BMC 1500 45 536 Unrecoverable HOST 1500, Predictive BMC 1500 60 537 538 539Verify Error Logging Rotation Policy With Unrecoverable HOST And BMC Error Logs 540 [Documentation] Verify error logging rotation policy with unrecoverable HOST and BMC error logs. 541 [Tags] Verify_Error_Logging_Rotation_Policy_With_Unrecoverable_HOST_And_BMC_Error_Logs 542 [Setup] Run Keywords Open Connection for SCP AND scp.Put File ${UNRECOVERABLE_FILE_PATH} 543 ... /tmp/FILE_NBMC_UNRECOVERABLE AND Redfish.Login 544 [Template] Error Logging Rotation Policy 545 546 # Error logs to be created % of total logging space when error 547 # log exceeds max limit. 548 Unrecoverable HOST 1500, Unrecoverable BMC 1500 60 549 550 551Verify Old Logs Are Deleted When Count Crosses Max 552 [Documentation] Verify that when the count crosses max, older logs are deleted. 553 [Tags] Verify_Old_Logs_Are_Deleted_When_Count_Crosses_Max 554 555 Redfish Purge Event Log 556 # Create 3000 error logs. 557 FOR ${count} IN RANGE ${3000} 558 BMC Execute Command ${CMD_PREDICTIVE_ERROR} 559 END 560 561 # Retrieve the IDs of the logs. 562 ${pel_ids}= Get PEL Log Via BMC CLI 563 ${1st_id}= Get From List ${pel_ids} 0 564 ${3000th_id}= Get From List ${pel_ids} 2999 565 566 # Now create 3001st log to cross threshold limit and trigger error logs rotation. 567 BMC Execute Command ${CMD_PREDICTIVE_ERROR} 568 569 # Wait few seconds for error logs rotation to complete. 570 Sleep 10s 571 572 # Now verify that first log is no more available but the 3000th is available. 573 ${status} ${output}= Run Keyword And Ignore Error Peltool -i ${1st_id} 574 Should Be True '${status}' == 'FAIL' 575 Should Contain ${output} PEL not found 576 577 ${status} ${output}= Run Keyword And Ignore Error Peltool -i ${3000th_id} 578 Should Be True '${status}' == 'PASS' 579 Should Not Contain ${output} PEL not found 580 581 582Verify Reverse Order Of PEL Logs 583 [Documentation] Verify PEL command to output PEL logs in reverse order. 584 [Tags] Verify_Reverse_Order_Of_PEL_Logs 585 586 Redfish Purge Event Log 587 588 # Below commands create unrecoverable error log at first and then the predictable error. 589 BMC Execute Command ${CMD_UNRECOVERABLE_ERROR} 590 BMC Execute Command ${CMD_PREDICTIVE_ERROR} 591 592 # Using peltool -lr, recent PELs appear first. Hence the ID of first PEL is greater than the next. 593 ${pel_records}= peltool -lr 594 595 # It is found that, variables like dictionary always keep items in sorted order that makes 596 # this verification not possible, hence json is used to keep the items original order. 597 ${pel_records}= Convert To String ${pel_records} 598 ${json_string}= Replace String ${pel_records} ' " 599 ${json_object}= Evaluate json.loads('''${json_string}''') json 600 601 ${list}= Convert To List ${json_object} 602 603 ${id1}= Get From List ${list} 0 604 ${id1}= Convert To Integer ${id1} 605 ${id2}= Get From List ${list} 1 606 ${id2}= Convert To Integer ${id2} 607 608 Should Be True ${id1} > ${id2} 609 610 611Verify Total PEL Count 612 [Documentation] Verify total PEL count returned by peltool command. 613 [Tags] Verify_Total_PEL_Count 614 615 # Initially remove all logs. 616 Redfish Purge Event Log 617 618 # Generate a random number between 1-20. 619 ${random}= Evaluate random.randint(1, 20) modules=random 620 621 # Generate predictive error log multiple times. 622 FOR ${count} IN RANGE 0 ${random} 623 BMC Execute Command ${CMD_PREDICTIVE_ERROR} 624 END 625 626 # Check PEL log count via peltool command and compare it with actual generated log count. 627 ${pel_records}= peltool -n 628 629 Should Be Equal ${pel_records['Number of PELs found']} ${random} 630 631 632Verify Listing Information Error 633 [Documentation] Verify that information error logs can only be listed using -lfh option of peltool. 634 [Tags] Verify_Listing_Information_Error 635 636 # Initially remove all logs. 637 Redfish Purge Event Log 638 BMC Execute Command ${CMD_INFORMATIONAL_ERROR} 639 640 # Generate informational logs and verify that it would not get listed by peltool's list command. 641 ${pel_records}= peltool -l 642 ${ids}= Get Dictionary Keys ${pel_records} 643 Should Be Empty ${ids} 644 645 # Verify that information logs get listed using peltool's list command with -lfh option. 646 ${pel_records}= peltool -lfh 647 ${ids}= Get Dictionary Keys ${pel_records} 648 Should Not Be Empty ${ids} 649 ${id}= Get From List ${ids} 0 650 Should Contain ${pel_records['${id}']['Sev']} Informational 651 652 653Verify PEL Delete 654 [Documentation] Verify that peltool command can delete PEL log based on id. 655 [Tags] Verify_PEL_Delete 656 657 BMC Execute Command ${CMD_PREDICTIVE_ERROR} 658 ${pel_ids}= Get PEL Log Via BMC CLI 659 ${id}= Get From List ${pel_ids} -1 660 Peltool -d ${id} False 661 Run Keyword and Expect Error *PEL not found* Peltool -i ${id} 662 663 664*** Keywords *** 665 666Error Logging Rotation Policy 667 [Documentation] Verify that when maximum log limit is reached, given error logging type 668 ... are deleted when reached their max allocated space. 669 [Arguments] ${error_log_type} ${max_allocated_space_percentage} 670 671 # Description of argument(s): 672 # error_log Error logs to be created (E.g. Informational BMC 3000 673 # stands for BMC created 3000 informational error logs). 674 # max_allocated_space_percentage The maximum percentage of disk usage for given error 675 # log type when maximum count/log size is reached. 676 # The maximum error log count is 3000. 677 678 # Initially remove all logs. Purging is done to ensure that, only specific logs are present 679 # in BMC during the test. 680 Redfish Purge Event Log 681 682 @{lists}= Split String ${error_log_type} ,${SPACE} 683 684 ${length}= Get Length ${lists} 685 686 FOR ${list} IN RANGE ${length} 687 @{words}= Split String ${lists}[${list}] ${SPACE} 688 Create Error Log ${words}[0] ${words}[1] ${words}[2] 689 END 690 691 # Create an additional error log to exceed max error logs limit. 692 BMC Execute Command ${CMD_UNRECOVERABLE_ERROR} 693 694 # Delay for BMC to perform delete older error logs when log limit exceeds. 695 Sleep 10s 696 697 # Verify disk usage is around max allocated space. Maximum usage is around 3MB not exactly 3MB 698 # (for informational log) and around 6 MB for unrecoverable / predictive error log. So, usage 699 # percentage is NOT exactly 15% and 30%. So, an error/accuracy factor 0.5 percent is added. 700 701 ${disk_usage_percentage}= Get Disk Usage For Error Logs 702 ${percent_diff}= Evaluate ${disk_usage_percentage} - ${max_allocated_space_percentage} 703 ${percent_diff}= Evaluate abs(${percent_diff}) 704 705 ${trimmed_as_expected}= Run Keyword If ${disk_usage_percentage} > ${max_allocated_space_percentage} 706 ... Evaluate ${percent_diff} <= 0.5 707 ... ELSE 708 ... Set Variable True 709 710 # Check PEL log count via peltool command and compare it with actual generated log count. 711 ${pel_records}= peltool -n 712 ${no_pel_records}= Set Variable ${pel_records["Number of PELs found"]} 713 # Number of logs can be 80% of the total logs created after trimming. 714 ${expected_max_record}= Evaluate 3000 * 0.8 715 716 Run Keyword If ${trimmed_as_expected} == False 717 ... Should Be True ${no_pel_records} <= ${expected_max_record} 718 719 720Create Error Log 721 [Documentation] Create an error log. 722 [Arguments] ${error_severity} ${error_creator} ${count} 723 724 # Description of argument(s): 725 # error_severity Severity of the error (E.g. Informational, Unrecoberable or Predictive) 726 # error_creator Name of error log's creator(E.g BMC, Host Boot) 727 # count Number of error logs to be generated. 728 729 FOR ${i} IN RANGE 0 ${count} 730 ${cmd}= Set Variable If 731 ... '${error_severity}' == 'Informational' and '${error_creator}' == 'BMC' ${CMD_INFORMATIONAL_ERROR} 732 ... '${error_severity}' == 'Predictive' and '${error_creator}' == 'BMC' ${CMD_PREDICTIVE_ERROR} 733 ... '${error_severity}' == 'Unrecoverable' and '${error_creator}' == 'BMC' ${CMD_UNRECOVERABLE_ERROR} 734 ... '${error_severity}' == 'Unrecoverable' and '${error_creator}' == 'HOST' ${CMD_UNRECOVERABLE_HOST_ERROR} 735 BMC Execute Command ${cmd} 736 END 737 738 739Get Disk Usage For Error Logs 740 [Documentation] Get disk usage percentage for error logs. 741 742 ${usage_output} ${stderr} ${rc}= BMC Execute Command du /var/lib/phosphor-logging/errors 743 744 ${usage_output}= Fetch From Left ${usage_output} \/ 745 746 # Convert disk usage unit from KB to MB. 747 ${usage_output}= Evaluate ${usage_output} / 1024 748 749 # Logging disk capacity limit is set to 20MB. So calculating the log usage percentage. 750 ${usage_percent}= Evaluate ${usage_output} / 20 * 100 751 752 [return] ${usage_percent} 753 754 755Get PEL Log IDs 756 [Documentation] Returns the list of PEL log IDs which contains given field's value. 757 [Arguments] ${pel_section} ${pel_field} @{pel_field_value} 758 759 # Description of argument(s): 760 # pel_section The section of PEL (e.g. Private Header, User Header). 761 # pel_field The PEL field (e.g. Event Severity, Event Type). 762 # pel_field_value The list of PEL's field value (e.g. Unrecoverable Error). 763 764 ${pel_ids}= Get PEL Log Via BMC CLI 765 @{pel_id_list}= Create List 766 767 FOR ${id} IN @{pel_ids} 768 ${pel_output}= Peltool -i ${id} 769 # Example of PEL output from "peltool -i <id>" command. 770 # [Private Header]: 771 # [Created at]: 08/24/1928 12:04:06 772 # [Created by]: 0x584D 773 # [Sub-section type]: 0 774 # [Entry Id]: 0x50000BB7 775 # [Platform Log Id]: 0x8200061D 776 # [CSSVER]: 777 # [Section Version]: 1 778 # [Creator Subsystem]: PHYP 779 # [BMC Event Log Id]: 341 780 # [Committed at]: 03/25/1920 12:06:22 781 # [User Header]: 782 # [Log Committed by]: 0x4552 783 # [Action Flags]: 784 # [0]: Report Externally 785 # [Subsystem]: I/O Subsystem 786 # [Event Type]: Miscellaneous, Informational Only 787 # [Sub-section type]: 0 788 # [Event Scope]: Entire Platform 789 # [Event Severity]: Informational Event 790 # [Host Transmission]: Not Sent 791 # [Section Version]: 1 792 793 ${pel_section_output}= Get From Dictionary ${pel_output} ${pel_section} 794 ${pel_field_output}= Get From Dictionary ${pel_section_output} ${pel_field} 795 Run Keyword If '${pel_field_output}' in @{pel_field_value} Append To List ${pel_id_list} ${id} 796 END 797 Sort List ${pel_id_list} 798 799 [Return] ${pel_id_list} 800 801 802Get PEL Log Via BMC CLI 803 [Documentation] Returns the list of PEL IDs using BMC CLI. 804 805 ${pel_records}= Peltool -l 806 ${ids}= Get Dictionary Keys ${pel_records} 807 Sort List ${ids} 808 809 [Return] ${ids} 810 811 812Get PEL Field Value 813 [Documentation] Returns the value of given PEL's field. 814 [Arguments] ${pel_id} ${pel_section} ${pel_field} 815 816 # Description of argument(s): 817 # pel_id The ID of PEL (e.g. 0x5000002D, 0x5000002E). 818 # pel_section The section of PEL (e.g. Private Header, User Header) 819 # pel_field The PEL field (e.g. Event Severity, Event Type). 820 821 ${pel_output}= Peltool -i ${pel_id} 822 823 # Example of PEL output from "peltool -i <id>" command. 824 # [Private Header]: 825 # [Created at]: 08/24/1928 12:04:06 826 # [Created by]: 0x584D 827 # [Sub-section type]: 0 828 # [Entry Id]: 0x50000BB7 829 # [Platform Log Id]: 0x8200061D 830 # [CSSVER]: 831 # [Section Version]: 1 832 # [Creator Subsystem]: PHYP 833 # [BMC Event Log Id]: 341 834 # [Committed at]: 03/25/1920 12:06:22 835 # [User Header]: 836 # [Log Committed by]: 0x4552 837 # [Action Flags]: 838 # [0]: Report Externally 839 # [Subsystem]: I/O Subsystem 840 # [Event Type]: Miscellaneous, Informational Only 841 # [Sub-section type]: 0 842 # [Event Scope]: Entire Platform 843 # [Event Severity]: Informational Event 844 # [Host Transmission]: Not Sent 845 # [Section Version]: 1 846 847 ${pel_section_output}= Get From Dictionary ${pel_output} ${pel_section} 848 ${pel_field_output}= Get From Dictionary ${pel_section_output} ${pel_field} 849 850 [Return] ${pel_field_output} 851