1*** Settings ***
2
3Documentation       Test BMC dump functionality of OpenBMC.
4
5Resource            ../../lib/bmc_redfish_resource.robot
6Resource            ../../lib/boot_utils.robot
7Resource            ../../lib/dump_utils.robot
8Resource            ../../lib/openbmc_ffdc.robot
9Variables           ../../data/pel_variables.py
10
11Suite Setup         Redfish.Login
12Test Setup          Redfish Delete All BMC Dumps
13Test Teardown       Test Teardown Execution
14
15*** Variables ***
16
17# Total size of the dump in kilo bytes
18${BMC_DUMP_TOTAL_SIZE}       ${1024}
19
20# Minimum space required for one bmc dump in kilo bytes
21${BMC_DUMP_MIN_SPACE_REQD}   ${20}
22${MAX_DUMP_COUNT}            ${20}
23${BMC_DUMP_COLLECTOR_PATH}   /var/lib/phosphor-debug-collector/dumps
24
25*** Test Cases ***
26
27Verify Error Response For Already Deleted Dump Id
28    [Documentation]  Delete non existing BMC dump and expect an error.
29    [Tags]  Verify_Error_Response_For_Already_Deleted_Dump_Id
30
31    Redfish Power Off  stack_mode=skip
32    ${dump_id}=  Create User Initiated BMC Dump Via Redfish
33    Wait Until Keyword Succeeds  15 sec  5 sec  Redfish Delete BMC Dump  ${dump_id}
34    Run Keyword And Expect Error  ValueError: *  Redfish Delete BMC Dump  ${dump_id}
35
36
37Verify User Initiated BMC Dump When Host Powered Off
38    [Documentation]  Create user initiated BMC dump at host off state and
39    ...  verify dump entry for it.
40    [Tags]  Verify_User_Initiated_BMC_Dump_When_Host_Powered_Off
41
42    Redfish Power Off  stack_mode=skip
43    ${dump_id}=  Create User Initiated BMC Dump Via Redfish
44    ${dump_entries}=  Get BMC Dump Entries
45    Length Should Be  ${dump_entries}  1
46    List Should Contain Value  ${dump_entries}  ${dump_id}
47
48
49Verify User Initiated BMC Dump Size
50    [Documentation]  Verify user initiated BMC dump size is under 20 MB.
51    [Tags]  Verify_User_Initiated_BMC_Dump_Size
52
53    Redfish Power Off  stack_mode=skip
54    ${dump_id}=  Create User Initiated BMC Dump Via Redfish
55    ${resp}=  Redfish.Get Properties  /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries/${dump_id}
56
57    # Example of response from above Redfish GET request.
58    # "@odata.type": "#LogEntry.v1_7_0.LogEntry",
59    # "AdditionalDataSizeBytes": 31644,
60    # "AdditionalDataURI": "/redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/attachment/9",
61    # "Created": "2020-10-23T06:32:53+00:00",
62    # "DiagnosticDataType": "Manager",
63    # "EntryType": "Event",
64    # "Id": "9",
65    # "Name": "BMC Dump Entry"
66
67    # Max size for dump is 20 MB = 20x1024x1024 Byte.
68    Should Be True  0 < ${resp["AdditionalDataSizeBytes"]} < 20971520
69
70
71Verify Internal Failure Initiated BMC Dump Size
72    [Documentation]  Verify that the internal failure initiated BMC dump size is under 20 MB.
73    [Tags]  Verify_Internal_Failure_Initiated_BMC_Dump_Size
74
75    Redfish Delete All BMC Dumps
76
77    # Create an internal failure error log.
78    BMC Execute Command  ${CMD_INTERNAL_FAILURE}
79
80    # Wait for BMC dump to get generated after injecting internal failure.
81    Wait Until Keyword Succeeds  2 min  10 sec  Is BMC Dump Available
82
83    # Verify that only one BMC dump is generated after injecting error.
84    ${dump_entries}=  Get BMC Dump Entries
85    ${length}=  Get length  ${dump_entries}
86    Should Be Equal As Integers  ${length}  ${1}
87
88    # Max size for dump is 20 MB = 20x1024x1024 Byte.
89    ${resp}=  Redfish.Get Properties
90    ...  /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries/${dump_entries[0]}
91    Should Be True  0 < ${resp["AdditionalDataSizeBytes"]} < 20971520
92
93
94Verify Multiple BMC Dump Creation
95    [Documentation]  Verify that multiple BMC dumps can be created one after
96    ...  another successfully.
97    [Tags]   Verify_Multiple_BMC_Dump_Creation
98
99    Redfish Power Off  stack_mode=skip
100    ${dump_count}=  Evaluate  random.randint(5, 10)  modules=random
101    FOR  ${INDEX}  IN  1  ${dump_count}
102      Create User Initiated BMC Dump Via Redfish
103    END
104
105
106Verify BMC Dump Default Location In BMC
107     [Documentation]  Verify that BMC dump is created in its default location of BMC.
108     [Tags]  Verify_BMC_Dump_Default_Location_In_BMC
109
110     Redfish Power Off  stack_mode=skip
111     Redfish Delete All BMC Dumps
112     ${dump_id}=  Create User Initiated BMC Dump Via Redfish
113     ${dump_file}  ${stderr}  ${rc}=  BMC Execute Command
114     ...  ls ${BMC_DUMP_COLLECTOR_PATH}/${dump_id}
115     Should Be True  ${rc} == 0
116     Should Contain Any  ${dump_file}  BMCDUMP  obmcdump
117
118
119Verify User Initiated BMC Dump When Host Booted
120    [Documentation]  Create user initiated BMC dump at host booted state and
121    ...  verify dump entry for it.
122    [Tags]  Verify_User_Initiated_BMC_Dump_When_Host_Booted
123
124    Redfish Power On  stack_mode=skip
125    ${dump_id}=  Create User Initiated BMC Dump Via Redfish
126    ${dump_entries}=  Get BMC Dump Entries
127    Length Should Be  ${dump_entries}  1
128    List Should Contain Value  ${dump_entries}  ${dump_id}
129
130
131Verify User Initiated BMC Dump At Host Booting
132    [Documentation]  Create and verify user initiated BMC dump during Host is powwering on
133    ...  or when host booting is in progress.
134    [Tags]  Verify_User_Initiated_BMC_Dump_At_Host_Booting
135
136    Redfish Power Off  stack_mode=skip
137    Redfish Delete All BMC Dumps
138
139    # Initiate power on.
140    Redfish Power Operation  On
141    Wait Until Keyword Succeeds  2 min  5 sec  Is Boot Progress Changed
142
143    # Create user initiated BMC dump and verify only one dump is available.
144    Create User Initiated BMC Dump Via Redfish
145    ${dump_entries}=  Get BMC Dump Entries
146    Length Should Be  ${dump_entries}  1
147
148
149Verify Dump Persistency On Dump Service Restart
150    [Documentation]  Create user dump, restart dump manager service and verify dump
151    ...  persistency.
152    [Tags]  Verify_Dump_Persistency_On_Dump_Service_Restart
153
154    Redfish Power Off  stack_mode=skip
155    Create User Initiated BMC Dump Via Redfish
156    ${dump_entries_before}=  redfish_utils.get_member_list  /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries
157
158    # Restart dump service.
159    BMC Execute Command  systemctl restart xyz.openbmc_project.Dump.Manager.service
160    Sleep  10s  reason=Wait for BMC dump service to restart properly
161
162    ${dump_entries_after}=  redfish_utils.get_member_list  /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries
163    Lists Should Be Equal  ${dump_entries_before}  ${dump_entries_after}
164
165
166Verify Dump Persistency On BMC Reset
167    [Documentation]  Create user dump, reset BMC and verify dump persistency.
168    [Tags]  Verify_Dump_Persistency_On_BMC_Reset
169
170    # Power off host so that dump is not offloaded to host OS.
171    Redfish Power Off  stack_mode=skip
172
173    Create User Initiated BMC Dump Via Redfish
174    ${dump_entries_before}=  redfish_utils.get_member_list  /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries
175
176    # Reset BMC.
177    OBMC Reboot (off)  stack_mode=skip
178
179    ${dump_entries_after}=  redfish_utils.get_member_list  /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries
180    Lists Should Be Equal  ${dump_entries_before}  ${dump_entries_after}
181
182
183Delete User Initiated BMC Dump And Verify
184    [Documentation]  Delete user initiated BMC dump and verify.
185    [Tags]  Delete_User_Initiated_BMC_Dump_And_Verify
186
187    Redfish Power Off  stack_mode=skip
188    ${dump_id}=  Create User Initiated BMC Dump Via Redfish
189    Wait Until Keyword Succeeds  15 sec  5 sec  Redfish Delete BMC Dump  ${dump_id}
190
191    ${dump_entries}=  Get BMC Dump Entries
192    Should Be Empty  ${dump_entries}
193
194
195Delete All User Initiated BMC Dumps And Verify
196    [Documentation]  Delete all user initiated BMC dumps and verify.
197    [Tags]  Delete_All_User_Initiated_BMC_Dumps_And_Verify
198
199    # Power off host so that dump is not offloaded to host OS.
200    Redfish Power Off  stack_mode=skip
201
202    # Create some BMC dump.
203    Create User Initiated BMC Dump Via Redfish
204    Create User Initiated BMC Dump Via Redfish
205
206    Redfish Delete All BMC Dumps
207    ${dump_entries}=  Get BMC Dump Entries
208    Should Be Empty  ${dump_entries}
209
210
211Create Two User Initiated BMC Dumps
212    [Documentation]  Create two user initiated BMC dumps.
213    [Tags]  Create_Two_User_Initiated_BMC_Dumps
214
215    Redfish Power Off  stack_mode=skip
216    ${dump_id1}=  Create User Initiated BMC Dump Via Redfish
217    ${dump_id2}=  Create User Initiated BMC Dump Via Redfish
218
219    ${dump_entries}=  Get BMC Dump Entries
220    Length Should Be  ${dump_entries}  2
221    Should Contain  ${dump_entries}  ${dump_id1}
222    Should Contain  ${dump_entries}  ${dump_id2}
223
224
225Create Two User Initiated BMC Dumps And Delete One
226    [Documentation]  Create two dumps and delete the first.
227    [Tags]  Create_Two_User_Initiated_BMC_Dumps_And_Delete_One
228
229    Redfish Power Off  stack_mode=skip
230    ${dump_id1}=  Create User Initiated BMC Dump Via Redfish
231    ${dump_id2}=  Create User Initiated BMC Dump Via Redfish
232
233    Wait Until Keyword Succeeds  15 sec  5 sec  Redfish Delete BMC Dump  ${dump_id1}
234
235    ${dump_entries}=  Get BMC Dump Entries
236    Length Should Be  ${dump_entries}  1
237    List Should Contain Value  ${dump_entries}  ${dump_id2}
238
239
240Create And Delete User Initiated BMC Dump Multiple Times
241    [Documentation]  Create and delete user initiated BMC dump multiple times.
242    [Tags]  Create_And_Delete_User_Initiated_BMC_Dump_Multiple_Times
243
244    Redfish Power Off  stack_mode=skip
245    FOR  ${INDEX}  IN  1  10
246      ${dump_id}=  Create User Initiated BMC Dump Via Redfish
247      Wait Until Keyword Succeeds  15 sec  5 sec  Redfish Delete BMC Dump  ${dump_id}
248    END
249
250
251Verify Maximum BMC Dump Creation
252    [Documentation]  Create maximum BMC dump and verify error when dump runs out of space.
253    [Tags]  Verify_Maximum_BMC_Dump_Creation
254    [Teardown]  Redfish Delete All BMC Dumps
255
256    # Maximum allowed space for dump is 1024 KB. BMC typically hold 8-14 dumps
257    # before running out of this dump space. So trying to create dumps in 20
258    # iterations to run out of space.
259    # User can key in the Maximum allowed space for bmc dump and how many iteration.
260    FOR  ${n}  IN RANGE  0  ${MAX_DUMP_COUNT}
261      Create User Initiated BMC Dump Via Redfish
262      ${dump_space}=  Get Disk Usage For Dumps
263      Exit For Loop If  ${dump_space} >= (${BMC_DUMP_TOTAL_SIZE} - ${BMC_DUMP_MIN_SPACE_REQD})
264    END
265
266    # Check error while creating dump when dump size is full.
267    ${payload}=  Create Dictionary  DiagnosticDataType=Manager
268    Redfish.Post  /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Actions/LogService.CollectDiagnosticData
269    ...  body=${payload}  valid_status_codes=[${HTTP_INTERNAL_SERVER_ERROR}]
270
271
272Verify BMC Core Dump When Host Powered Off
273    [Documentation]  Verify BMC core dump after application crash at host powered off state.
274    [Tags]  Verify_BMC_Core_Dump_When_Host_Powered_Off
275
276    Redfish Power Off  stack_mode=skip
277
278    # Ensure all dumps are cleaned out.
279    Redfish Delete All BMC Dumps
280    Trigger Core Dump
281
282    # Verify that BMC dump is available.
283    Wait Until Keyword Succeeds  2 min  10 sec  Is BMC Dump Available
284
285
286Verify Core Dump Size
287    [Documentation]  Verify BMC core dump size is under 20 MB.
288    [Tags]  Verify_Core_Dump_Size
289
290    Redfish Power Off  stack_mode=skip
291
292    # Ensure all dumps are cleaned out.
293    Redfish Delete All BMC Dumps
294    Trigger Core Dump
295
296    # Verify that BMC dump is available.
297    Wait Until Keyword Succeeds  2 min  10 sec  Is BMC Dump Available
298    ${dump_entries}=  Get BMC Dump Entries
299    ${resp}=  Redfish.Get Properties
300    ...  /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries/${dump_entries[0]}
301
302    # Max size for dump is 20 MB = 20x1024x1024 Byte.
303    Should Be True  0 < ${resp["AdditionalDataSizeBytes"]} < 20971520
304
305
306Verify Error While Initiating BMC Dump During Dumping State
307    [Documentation]  Verify error while initiating BMC dump during dumping state.
308    [Tags]  Verify_Error_While_Initiating_BMC_Dump_During_Dumping_State
309
310    Redfish Power Off  stack_mode=skip
311    ${task_id}=  Create User Initiated BMC Dump Via Redfish  ${1}
312
313    # Check error while initiating BMC dump while dump in progress.
314    ${payload}=  Create Dictionary  DiagnosticDataType=Manager
315    Redfish.Post
316    ...  /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Actions/LogService.CollectDiagnosticData
317    ...  body=${payload}  valid_status_codes=[${HTTP_SERVICE_UNAVAILABLE}]
318
319    # Wait for above initiated dump to complete. Otherwise, on going dump would impact next test.
320    Wait Until Keyword Succeeds  5 min  15 sec  Check Task Completion  ${task_id}
321
322
323Verify BMC Dump Create Errors While Another BMC Dump In Progress
324    [Documentation]  Verify BMC dump creation error until older BMC dump completion.
325    [Tags]  Verify_BMC_Dump_Create_Errors_While_Another_BMC_Dump_In_Progress
326
327    Redfish Power Off  stack_mode=skip
328
329    # Initiate a BMC dump that returns without completion.
330    ${task_id}=  Create User Initiated BMC Dump Via Redfish  ${1}
331    ${task_dict}=  Redfish.Get Properties  /redfish/v1/TaskService/Tasks/${task_id}
332    ${payload}=  Create Dictionary  DiagnosticDataType=Manager
333    IF  '${task_dict['TaskState']}' != 'Completed'
334        ${resp}=  Redfish.Post
335        ...  /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Actions/LogService.CollectDiagnosticData
336        ...  body=${payload}  valid_status_codes=[${HTTP_SERVICE_UNAVAILABLE}]
337    END
338
339    # Wait for above initiated dump to complete. Otherwise, on going dump would impact next test.
340    Wait Until Keyword Succeeds  5 min  15 sec  Check Task Completion  ${task_id}
341
342
343Verify Core Dump After Terminating Dump Manager Service
344    [Documentation]  Verify initiate core dumps and kill Phosphor-dump-manager.
345    [Tags]  Verify_Core_Dump_After_Terminating_Dump_Manager_Service
346
347    Redfish Power Off  stack_mode=skip
348
349    # Remove all available dumps in BMC.
350    Redfish Delete All BMC Dumps
351
352    # Find the pid of the phosphor-dump-manage process and kill it.
353    ${cmd_buf}=  Catenate  kill -s SEGV $(pgrep phosphor-dump-manager)
354    ${cmd_output}  ${stderr}  ${rc}=  BMC Execute Command  ${cmd_buf}
355    Should Be Equal As Integers  ${rc}  ${0}
356
357    # Verify that BMC dump is available.
358    Wait Until Keyword Succeeds  2 min  10 sec  Is BMC Dump Available
359
360    # Verifying that there is only one dump.
361    ${dump_entries}=  Get BMC Dump Entries
362    ${length}=  Get length  ${dump_entries}
363    Should Be Equal As Integers  ${length}  ${1}
364
365
366Verify Error Log And Dump For Internal Failure
367    [Documentation]  Verify error log and dump for internal failure.
368    [Tags]  Verify_Error_Log_And_Dump_For_Internal_Failure
369
370    Redfish Purge Event Log
371    Redfish Delete All BMC Dumps
372
373    # Create an internal failure error log.
374    BMC Execute Command  ${CMD_INTERNAL_FAILURE}
375
376    # With internal failure, an error log file is generated. Check if
377    # BMC has only one error log for this internal failure.
378    ${resp}=  Redfish.Get  /redfish/v1/Systems/system/LogServices/CELog/Entries
379    Should Be True  ${resp.dict["Members@odata.count"]} == ${1}
380
381    # Wait for the BMC dump to become available and verify its presence.
382    Wait Until Keyword Succeeds  2 min  10 sec  Is BMC Dump Available
383    ${dump_entries}=  Get BMC Dump Entries
384    ${length}=  Get length  ${dump_entries}
385    Should Be Equal As Integers  ${length}  ${1}
386
387
388Verify Core Watchdog Initiated BMC Dump
389    [Documentation]  Verify core watchdog timeout initiated BMC dump.
390    [Tags]  Verify_Core_Watchdog_Initiated_BMC_Dump
391
392    Redfish Delete All BMC Dumps
393    Redfish Power Off  stack_mode=skip
394
395    # Trigger watchdog timeout.
396    Redfish Initiate Auto Reboot  2000
397
398    # Wait for BMC dump to get generated after injecting watchdog timeout.
399    Wait Until Keyword Succeeds  4 min  20 sec  Is BMC Dump Available
400
401    # Verify that only one BMC dump is available.
402    ${dump_entry_list}=  Get BMC Dump Entries
403    ${length}=  Get length  ${dump_entry_list}
404    Should Be Equal As Integers  ${length}  ${1}
405
406
407Verify User Initiated BMC Dump Type
408    [Documentation]  Download user initiate BMC dump and validates its type.
409    [Tags]  Verify_User_Initiated_BMC_Dump_Type
410
411    Redfish Power Off  stack_mode=skip
412    ${dump_id}=  Create User Initiated BMC Dump Via Redfish
413
414    # Download BMC dump and verify its size.
415    ${resp}=  Redfish.Get  /redfish/v1/Managers/bmc/LogServices/Dump/Entries/${dump_id}
416    ${redfish_dump_creation_timestamp}=  Set Variable  ${resp.dict["Created"]}
417    # Download BMC dump and verify its size.
418    ${tarfile}=  Download BMC Dump  ${dump_id}
419
420    # Extract dump and verify type of dump from summary.log content:
421    # Wed Aug 30 17:23:29 UTC 2023 Name:          BMCDUMP.XXXXXXX.0001005.20230830172329
422    # Wed Aug 30 17:23:29 UTC 2023 Epochtime:     1693416209
423    # Wed Aug 30 17:23:29 UTC 2023 ID:            0001005
424    # Wed Aug 30 17:23:29 UTC 2023 Type:          user
425    ${extracted_dump_folder}=  Extract BMC Dump  BMC_dump.tar.gz  ${redfish_dump_creation_timestamp}
426    ${contents}=  OperatingSystem.Get File  ${extracted_dump_folder}/summary.log
427    Should Match Regexp  ${contents}  Type:[ ]*user
428
429    # Clean extracted dump files.
430    Remove Files  output  output.zst
431    Remove Directory  ${extracted_dump_folder}  True
432
433
434Verify Retrieve Core Initiated BMC Dump
435    [Documentation]  Verify retrieval of core initiated BMC dump.
436    [Tags]  Verify_Retrieve_Core_Initiated_BMC_Dump
437
438    Redfish Power Off  stack_mode=skip
439
440    # Ensure all dumps are cleaned out.
441    Redfish Delete All BMC Dumps
442    Trigger Core Dump
443
444    # Verify that BMC dump is available.
445    Wait Until Keyword Succeeds  2 min  10 sec  Is BMC Dump Available
446
447    ${dump_entries}=  Get BMC Dump Entries
448    # Download BMC dump and verify its size.
449    Download BMC Dump  ${dump_entries[0]}
450
451
452Verify Retrieve User Initiated BMC Dump
453    [Documentation]  Verify retrieval of user initiated BMC dump.
454    [Tags]  Verify_Retrieve_User_Initiated_BMC_Dump
455
456    Redfish Power Off  stack_mode=skip
457    ${dump_id}=  Create User Initiated BMC Dump Via Redfish
458
459    # Download BMC dump.
460    Download BMC Dump  ${dump_id}
461
462
463Verify Core Initiated BMC Dump Type
464    [Documentation]  Download core initiate BMC dump and validates its type.
465    [Tags]  Verify_Core_Initiated_BMC_Dump_Type
466
467    Redfish Power Off  stack_mode=skip
468
469    # Ensure all dumps are cleaned out.
470    Redfish Delete All BMC Dumps
471    Trigger Core Dump
472
473    # Verify that BMC dump is available.
474    Wait Until Keyword Succeeds  2 min  10 sec  Is BMC Dump Available
475
476    ${dump_entries}=  Get BMC Dump Entries
477
478    # Find the timestamp of BMC dump.
479    ${resp}=  Redfish.Get  /redfish/v1/Managers/bmc/LogServices/Dump/Entries/${dump_entries[0]}
480    ${redfish_dump_creation_timestamp}=  Set Variable  ${resp.dict["Created"]}
481
482    # Download BMC dump and verify its size.
483    ${tarfile}=  Download BMC Dump  ${dump_entries[0]}
484
485    # Extract dump and verify type of dump from summary.log content:
486    # Wed Aug 30 17:23:29 UTC 2023 Name:          BMCDUMP.XXXXXXX.0001005.20230830172329
487    # Wed Aug 30 17:23:29 UTC 2023 Epochtime:     1693416209
488    # Wed Aug 30 17:23:29 UTC 2023 ID:            0001005
489    # Wed Aug 30 17:23:29 UTC 2023 Type:          core
490
491    ${extracted_dump_folder}=  Extract BMC Dump  ${tarfile}  ${redfish_dump_creation_timestamp}
492    ${contents}=  OperatingSystem.Get File  ${extracted_dump_folder}/summary.log
493    Should Match Regexp  ${contents}  Type:[ ]*core
494
495    # Clean extracted dump files.
496    Remove Files  output  output.zst
497    Remove Directory  ${extracted_dump_folder}  True
498
499
500*** Keywords ***
501
502Download BMC Dump
503    [Documentation]  Download BMC dump and verify its size.
504    [Arguments]  ${dump_id}
505
506    # Description of argument(s):
507    # dump_id                An integer value that identifies a particular dump (e.g. 1, 3).
508
509    ${resp}=  Redfish.Get  /redfish/v1/Managers/bmc/LogServices/Dump/Entries/${dump_id}
510    ${redfish_bmc_dump_size}=  Set Variable  ${resp.dict["AdditionalDataSizeBytes"]}
511
512    Initialize OpenBMC
513    ${headers}=  Create Dictionary  Content-Type=application/octet-stream  X-Auth-Token=${XAUTH_TOKEN}
514
515    ${ret}=  Get Request  openbmc  /redfish/v1/Managers/bmc/LogServices/Dump/Entries/${dump_id}/attachment  headers=${headers}
516
517    Should Be Equal As Numbers  ${ret.status_code}  200
518
519    Create Binary File  BMC_dump.tar.gz  ${ret.content}
520    ${downloaded_dump_size}=  Get File Size  BMC_dump.tar.gz
521    Should Be Equal  ${downloaded_dump_size}  ${redfish_bmc_dump_size}
522    [Return]  BMC_dump.tar.gz
523
524
525Extract BMC Dump
526    [Documentation]  Extract BMC dump from the tar file and returns the name of
527    ...  extracted folder like BMCDUMP.XXXXXXX.0000070.20230706063841.
528    [Arguments]  ${filename}   ${bmc_dump_timestamp}
529
530    # Description of argument(s):
531    # filename                name of BMC dump tar file.
532    # bmc_dump_timestamp      timestamp of generated BMC dump.
533
534    OperatingSystem.File Should Exist  ${filename}
535    ${rc}=  Run And Return RC  dd if=${filename} of=output.zst bs=1 skip=628
536    Should Be True  0 == ${rc}
537
538    ${rc}=  Run And Return RC  zstd -d output.zst
539    Should Be True  0 == ${rc}
540
541    ${rc}=  Run And Return RC  tar -xvf output
542    Should Be True  0 == ${rc}
543
544    # Find the extracted dump folder identified with BMCDUMP as prefix and
545    # timestamp of dump generation where timestamp format is : 2023-09-27T08:30:17.000000+00:00.
546    ${var}=  Fetch From Left  ${bmc_dump_timestamp}  .
547    ${var}=  Remove String  ${var}  -  T  :
548    ${bmc_extraction_folders}=  OperatingSystem.List Directories In Directory  .  BMCDUMP*${var}
549    ${cnt}=  Get length  ${bmc_extraction_folders}
550    should be equal as numbers  ${cnt}  1
551
552    [Return]  ${bmc_extraction_folders}[0]
553
554
555Get BMC Dump Entries
556    [Documentation]  Return BMC dump ids list.
557
558    ${dump_uris}=  redfish_utils.get_member_list  /redfish/v1/Managers/${MANAGER_ID}/LogServices/Dump/Entries
559    ${dump_ids}=  Create List
560
561    FOR  ${dump_uri}  IN  @{dump_uris}
562      ${dump_id}=  Fetch From Right  ${dump_uri}  /
563      Append To List  ${dump_ids}  ${dump_id}
564    END
565
566    [Return]  ${dump_ids}
567
568
569Is BMC Dump Available
570    [Documentation]  Verify if BMC dump is available.
571
572    ${dump_entries}=  Get BMC Dump Entries
573
574    # Verifying that BMC dump is available.
575    ${length}=  Get length  ${dump_entries}
576    Should Be True  0 < ${length}
577
578
579Get Disk Usage For Dumps
580    [Documentation]  Return disk usage in kilobyte for BMC dumps.
581
582    ${usage_output}  ${stderr}  ${rc}=  BMC Execute Command  du -s ${BMC_DUMP_COLLECTOR_PATH}
583
584    # Example of output from above BMC cli command.
585    # $ du -s /var/lib/phosphor-debug-collector/dumps
586    # 516    /var/lib/phosphor-debug-collector/dumps
587
588    ${usage_output}=  Fetch From Left  ${usage_output}  /
589    ${usage_output}=  Convert To Integer  ${usage_output}
590
591    [return]  ${usage_output}
592
593
594Test Teardown Execution
595    [Documentation]  Do test teardown operation.
596
597    FFDC On Test Case Fail
598    Close All Connections
599