xref: /openbmc/openbmc-test-automation/lib/openbmc_ffdc.robot (revision 4c1b99f1a44c4fe3dd126a8bcf5dddc1622fc113)
1*** Settings ***
2Documentation      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
10...                │       ├── 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
17...                │       ├── 20160909102538035251_BMC_general.txt
18...                │       ├── 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
28...                │       └── 20160909102538035251_OS_secure.txt
29...                └── test_history.txt
30
31Resource           openbmc_ffdc_methods.robot
32Resource           openbmc_ffdc_utils.robot
33Library            openbmc_ffdc.py
34
35*** Keywords ***
36
37FFDC On Test Case Fail
38    [Documentation]   Generic FFDC entry point. Place holder to hook in
39    ...               other data collection methods
40    ...               1. Collect Logs if test fails
41    ...               2. Added Test execution history logging
42    ...                  By default this will log Test status PASS/FAIL format
43    ...                  EX: 20160822041250932049:Test:Test case 1:PASS
44    ...                      20160822041250969913:Test:Test case 2:FAIL
45
46    Run Keyword If  '${TEST_STATUS}' == 'FAIL'
47    ...    FFDC
48
49    Log Test Case Status
50