blob: ecd31160dabed3668299b9b008d4f1dea4a9e150 [file] [log] [blame]
George Keishing4346a412016-07-19 11:26:49 -05001*** Settings ***
George Keishing69e6f712016-09-12 06:30:09 -05002Documentation This module is for data collection on test case failure
3... for openbmc systems. Collects data with default name
4... ffdc_report.txt under directory logs/testSuite/testName/
5... on failure.
6... FFDC logging sample layout:
7... logs
8... ├── 20160909102538035251_TestWarmreset
9... │   └── 20160909102538035251_TestWarmResetviaREST
Gunnar Mills50070fa2016-11-14 11:17:30 -060010... │   ├── 20160909102538035251_BMC_journalctl.txt
11... │   ├── 20160909102538035251_BMC_proc_list.txt
12... │   ├── 20160909102538035251_BMC_dmesg.txt
13... │   ├── 20160909102538035251_BMC_inventory.txt
14... │   ├── 20160909102538035251_BMC_led.txt
15... │   ├── 20160909102538035251_BMC_record_log.txt
16... │   ├── 20160909102538035251_BMC_sensor_list.txt
Gunnar Millsaca140d2016-10-26 13:05:10 -050017... │   ├── 20160909102538035251_BMC_general.txt
Gunnar Mills50070fa2016-11-14 11:17:30 -060018... │   ├── 20160909102538035251_OS_dmesg.txt
19... │   ├── 20160909102538035251_OS_msglog.txt
20... │   ├── 20160909102538035251_OS_cpufrequency.txt
21... │   ├── 20160909102538035251_OS_boot.txt
22... │   ├── 20160909102538035251_OS_isusb.txt
23... │   ├── 20160909102538035251_OS_kern.txt
24... │   ├── 20160909102538035251_OS_authlog.txt
25... │   ├── 20160909102538035251_OS_syslog.txt
26... │   ├── 20160909102538035251_OS_info.txt
27... │   ├── 20160909102538035251_OS_rsct.txt
Sweta Potthuri92e7b132017-03-17 06:02:32 -050028... │   ├── 20160909102538035251_OS_secure.txt
29... │   └── 20160909102538035251_OS_esel
George Keishing69e6f712016-09-12 06:30:09 -050030... └── test_history.txt
George Keishing4346a412016-07-19 11:26:49 -050031
George Keishing69e6f712016-09-12 06:30:09 -050032Resource openbmc_ffdc_methods.robot
33Resource openbmc_ffdc_utils.robot
George Keishing6a6e76d2017-09-14 08:19:17 -050034Resource dump_utils.robot
Michael Walsh769c2a12016-12-13 15:45:17 -060035Library openbmc_ffdc.py
George Keishing4346a412016-07-19 11:26:49 -050036
37*** Keywords ***
38
Gunnar Millseac1af22016-11-14 15:30:09 -060039FFDC On Test Case Fail
George Keishing4346a412016-07-19 11:26:49 -050040 [Documentation] Generic FFDC entry point. Place holder to hook in
George Keishing69e6f712016-09-12 06:30:09 -050041 ... other data collection methods
Rahul Maheshwari09439a22017-02-23 01:10:05 -060042 ... 1. Collect Logs if test fails or host reaches quiesced
43 ... state.
George Keishing6a6e76d2017-09-14 08:19:17 -050044 ... 2. Added test execution history logging.
George Keishing69e6f712016-09-12 06:30:09 -050045 ... By default this will log Test status PASS/FAIL format
46 ... EX: 20160822041250932049:Test:Test case 1:PASS
47 ... 20160822041250969913:Test:Test case 2:FAIL
George Keishing6a6e76d2017-09-14 08:19:17 -050048 ... 3. Delete error logs and BMC dumps post FFDC collection.
Joy Onyerikwud806cc02019-10-01 07:46:18 -050049 [Arguments] ${clean_up}=${TRUE}
50 # Description of argument(s):
51 # clean_up: Boolean value indicating whether error logs and dumps should be deleted on test failure after
52 # FFDC collection.
George Keishing4346a412016-07-19 11:26:49 -050053
George Keishing7f0dd252019-04-29 02:02:59 -050054 ${OVERRIDE_FFDC_ON_TEST_CASE_FAIL}= Get Environment Variable OVERRIDE_FFDC_ON_TEST_CASE_FAIL 0
Michael Walshfa84c8f2019-04-24 16:44:49 -050055 ${OVERRIDE_FFDC_ON_TEST_CASE_FAIL}= Convert To Integer ${OVERRIDE_FFDC_ON_TEST_CASE_FAIL}
George Keishing7f0dd252019-04-29 02:02:59 -050056 Return From Keyword If ${OVERRIDE_FFDC_ON_TEST_CASE_FAIL}
Michael Walshfa84c8f2019-04-24 16:44:49 -050057
George Keishing6a6e76d2017-09-14 08:19:17 -050058 Run Keyword If '${TEST_STATUS}' == 'FAIL' FFDC
George Keishing69e6f712016-09-12 06:30:09 -050059
60 Log Test Case Status
George Keishing6a6e76d2017-09-14 08:19:17 -050061
62 # Clean up error logs and BMC dumps.
Joy Onyerikwud806cc02019-10-01 07:46:18 -050063 Run Keyword If '${TEST_STATUS}' == 'FAIL' and ${clean_up}
George Keishing32fe4e12018-07-13 05:06:47 -050064 ... Run Keywords Delete All Error Logs AND Delete All Dumps