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