George Keishing | e7e9171 | 2021-09-03 11:28:44 -0500 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 2 | r""" |
George Keishing | 4346a41 | 2016-07-19 11:26:49 -0500 | [diff] [blame] | 3 | # @file openbmc_ffdc_list.py |
George Keishing | 4346a41 | 2016-07-19 11:26:49 -0500 | [diff] [blame] | 4 | # @brief List for FFDC ( First failure data capture ) |
| 5 | # commands and files to be collected as a part |
| 6 | # of the test case failure. |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 7 | """ |
Konstantin Aladyshev | c056c2b | 2021-03-25 11:59:39 +0300 | [diff] [blame] | 8 | import os |
| 9 | |
Konstantin Aladyshev | 6788049 | 2021-03-20 17:20:57 +0300 | [diff] [blame] | 10 | from robot.libraries.BuiltIn import BuiltIn |
| 11 | |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 12 | # ------------------- |
George Keishing | 4346a41 | 2016-07-19 11:26:49 -0500 | [diff] [blame] | 13 | # FFDC default list |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 14 | # ------------------- |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 15 | # ----------------------------------------------------------------- |
Gunnar Mills | 28e403b | 2017-10-25 16:16:38 -0500 | [diff] [blame] | 16 | # Dict Name { Index string : { Key String : Command string} } |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 17 | # ----------------------------------------------------------------- |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 18 | # Add cmd's needed to be part of the ffdc report manifest file |
| 19 | FFDC_BMC_CMD = { |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 20 | "DRIVER INFO": { |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 21 | # String Name Command |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 22 | "FW Level": "cat /etc/os-release", |
| 23 | "FW Timestamp": "cat /etc/timestamp", |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 24 | }, |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 25 | "BMC DATA": { |
| 26 | "BMC OS": "uname -a", |
| 27 | "BMC Uptime": "uptime;cat /proc/uptime", |
| 28 | "BMC File System Disk Space Usage": "df -hT", |
| 29 | "BMC Date Time": "date;/sbin/hwclock --show;/usr/bin/timedatectl", |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 30 | }, |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 31 | "APPLICATION DATA": { |
| 32 | "BMC state": "/usr/bin/obmcutil state", |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 33 | }, |
| 34 | } |
George Keishing | 671dd66 | 2021-05-28 03:26:30 -0500 | [diff] [blame] | 35 | # Add file name and corresponding command needed for BMC |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 36 | FFDC_BMC_FILE = { |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 37 | "BMC FILES": { |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 38 | # File Name Command |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 39 | "BMC_flash_side.txt": ( |
| 40 | "cat /sys/class/watchdog/watchdog1/bootstatus" |
| 41 | " >/tmp/BMC_flash_side.txt 2>&1" |
| 42 | ), |
| 43 | "BMC_hwmon.txt": ( |
| 44 | "grep -r . /sys/class/hwmon/* >/tmp/BMC_hwmon.txt 2>&1" |
| 45 | ), |
| 46 | "BMC_proc_list.txt": "top -n 1 -b >/tmp/BMC_proc_list.txt 2>&1", |
| 47 | "BMC_proc_fd_active_list.txt": ( |
| 48 | "ls -Al /proc/*/fd/ >/tmp/BMC_proc_fd_active_list.txt 2>&1" |
| 49 | ), |
| 50 | "BMC_journalctl_nopager.txt": ( |
| 51 | "journalctl --no-pager >/tmp/BMC_journalctl_nopager.txt 2>&1" |
| 52 | ), |
| 53 | "BMC_journalctl_pretty.json": ( |
| 54 | "journalctl -o json-pretty >/tmp/BMC_journalctl_pretty.json 2>&1" |
| 55 | ), |
| 56 | "BMC_dmesg.txt": "dmesg >/tmp/BMC_dmesg.txt 2>&1", |
| 57 | "BMC_procinfo.txt": "cat /proc/cpuinfo >/tmp/BMC_procinfo.txt 2>&1", |
| 58 | "BMC_meminfo.txt": "cat /proc/meminfo >/tmp/BMC_meminfo.txt 2>&1", |
| 59 | "BMC_systemd.txt": "systemctl status --all >/tmp/BMC_systemd.txt 2>&1", |
| 60 | "BMC_failed_service.txt": ( |
| 61 | "systemctl list-units --failed >/tmp/BMC_failed_service.txt 2>&1" |
| 62 | ), |
| 63 | "BMC_list_service.txt": ( |
| 64 | "systemctl list-jobs >/tmp/BMC_list_service.txt 2>&1" |
| 65 | ), |
| 66 | "BMC_obmc_console.txt": ( |
| 67 | "cat /var/log/obmc-console.log >/tmp/BMC_obmc_console.txt 2>&1" |
| 68 | ), |
| 69 | "BMC_obmc_console1.txt": ( |
| 70 | "cat /var/log/obmc-console1.log >/tmp/BMC_obmc_console1.txt 2>&1" |
| 71 | ), |
George Keishing | ecf4428 | 2024-05-20 20:44:17 +0530 | [diff] [blame] | 72 | "vpd-inventory.txt": "vpd-tool -i >/tmp/vpd-inventory.txt 2>&1", |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 73 | "PEL_logs_list.json": "peltool -l >/tmp/PEL_logs_list.json 2>&1", |
| 74 | "PEL_logs_complete_list.json": ( |
| 75 | "peltool -l -a -f >/tmp/PEL_logs_complete_list.json 2>&1" |
| 76 | ), |
| 77 | "PEL_logs_display.json": "peltool -a >/tmp/PEL_logs_display.json 2>&1", |
| 78 | "PEL_logs_complete_display.json": ( |
| 79 | "peltool -a -f -h>/tmp/PEL_logs_complete_display.json 2>&1" |
| 80 | ), |
George Keishing | 4afd655 | 2023-02-06 03:08:04 -0600 | [diff] [blame] | 81 | "PEL_logs_badPEL.txt": ( |
| 82 | "hexdump -C" |
| 83 | + " /var/lib/phosphor-logging/extensions/pels/badPEL>/tmp/PEL_logs_badPEL.txt" |
| 84 | " 2>&1" |
| 85 | ), |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 86 | "PLDM_fru_record.txt": ( |
| 87 | "pldmtool fru getfrurecordtable>/tmp/PLDM_fru_record.txt 2>&1" |
| 88 | ), |
| 89 | "BMC_pldm_flight_recorder.txt": ( |
| 90 | "rm -rf /tmp/pldm_flight_recorder; killall -s SIGUSR1 pldmd;" |
George Keishing | 4afd655 | 2023-02-06 03:08:04 -0600 | [diff] [blame] | 91 | + " sleep 5; cat /tmp/pldm_flight_recorder >" |
| 92 | " /tmp/BMC_pldm_flight_recorder.txt 2>&1;" |
| 93 | ), |
| 94 | "OCC_state.txt": ( |
| 95 | 'echo "OCC state check";for i in {0..3};' |
| 96 | + " do (echo /org/open_power/control/occ$i;" |
| 97 | + " busctl get-property org.open_power.OCC.Control" |
| 98 | " /org/open_power/control/occ$i" |
| 99 | + " org.open_power.OCC.Status OccActive) done > /tmp/OCC_state.txt" |
| 100 | " 2>&1" |
| 101 | ), |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 102 | "bmcweb_persistent_data.json": ( |
| 103 | "cat /home/root/bmcweb_persistent_data.json" |
George Keishing | 4afd655 | 2023-02-06 03:08:04 -0600 | [diff] [blame] | 104 | + " > /tmp/bmcweb_persistent_data.json" |
| 105 | ), |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 106 | "GUARD_list.txt": "guard -l > /tmp/GUARD_list.txt 2>&1", |
| 107 | "fan_control_dump.json": "fanctl dump; sleep 5", |
George Keishing | 326e41b | 2023-12-13 14:52:45 +0530 | [diff] [blame] | 108 | "fan_monitor_dump.json": "killall -s SIGUSR1 phosphor-fan-monitor; sleep 5", |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 109 | "DEVTREE": ( |
| 110 | "cat /var/lib/phosphor-software-manager/pnor/rw/DEVTREE >" |
| 111 | " /tmp/DEVTREE 2>&1" |
| 112 | ), |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 113 | }, |
| 114 | } |
George Keishing | f9f661d | 2020-03-18 11:42:53 -0500 | [diff] [blame] | 115 | # Add file name and corresponding command needed for all Linux distributions |
Gunnar Mills | 7e2cda2 | 2016-10-11 15:37:34 -0500 | [diff] [blame] | 116 | FFDC_OS_ALL_DISTROS_FILE = { |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 117 | "OS FILES": { |
Gunnar Mills | 7e2cda2 | 2016-10-11 15:37:34 -0500 | [diff] [blame] | 118 | # File Name Command |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 119 | "OS_msglog.txt": ( |
| 120 | "cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt 2>&1" |
| 121 | ), |
George Keishing | 4afd655 | 2023-02-06 03:08:04 -0600 | [diff] [blame] | 122 | "OS_cpufrequency.txt": ( |
| 123 | "ppc64_cpu --frequency >/tmp/OS_cpufrequency.txt 2>&1" |
| 124 | ), |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 125 | "OS_dmesg.txt": "dmesg >/tmp/OS_dmesg.txt 2>&1", |
| 126 | "OS_opal_prd.txt": "cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt 2>&1", |
| 127 | "OS_boot.txt": "cat /var/log/boot.log >/tmp/OS_boot.txt 2>&1", |
| 128 | "OS_procinfo.txt": "cat /proc/cpuinfo >/tmp/OS_procinfo.txt 2>&1", |
| 129 | "OS_meminfo.txt": "cat /proc/meminfo >/tmp/OS_meminfo.txt 2>&1", |
| 130 | "OS_netstat.txt": "netstat -a >/tmp/OS_netstat.txt 2>&1", |
| 131 | "OS_lspci.txt": "lspci >/tmp/OS_lspci.txt 2>&1", |
| 132 | "OS_lscpu.txt": "lscpu >/tmp/OS_lscpu.txt 2>&1", |
| 133 | "OS_lscfg.txt": "lscfg >/tmp/OS_lscfg.txt 2>&1", |
George Keishing | 4afd655 | 2023-02-06 03:08:04 -0600 | [diff] [blame] | 134 | "OS_journalctl_nopager.txt": ( |
| 135 | "journalctl --no-pager -b " |
| 136 | + "> /tmp/OS_journalctl_nopager.txt 2>&1" |
| 137 | ), |
Gunnar Mills | 7e2cda2 | 2016-10-11 15:37:34 -0500 | [diff] [blame] | 138 | }, |
| 139 | } |
George Keishing | 671dd66 | 2021-05-28 03:26:30 -0500 | [diff] [blame] | 140 | # Add file name and corresponding command needed for Ubuntu Linux |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 141 | FFDC_OS_UBUNTU_FILE = { |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 142 | "OS FILES": { |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 143 | # File Name Command |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 144 | "OS_isusb.txt": "{ lsusb -t ; lsusb -v ; } >/tmp/OS_isusb.txt 2>&1", |
| 145 | "OS_kern.txt": ( |
| 146 | "tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt 2>&1" |
| 147 | ), |
| 148 | "OS_authlog.txt": ( |
| 149 | "{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } " |
George Keishing | 4afd655 | 2023-02-06 03:08:04 -0600 | [diff] [blame] | 150 | + ">/tmp/OS_authlog.txt 2>&1" |
| 151 | ), |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 152 | "OS_syslog.txt": ( |
| 153 | "tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt 2>&1" |
| 154 | ), |
George Keishing | 4afd655 | 2023-02-06 03:08:04 -0600 | [diff] [blame] | 155 | "OS_info.txt": ( |
| 156 | "{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } " |
| 157 | + ">/tmp/OS_info.txt 2>&1" |
| 158 | ), |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 159 | "OS_sosreport.txt": ( |
| 160 | "{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir " |
George Keishing | 4afd655 | 2023-02-06 03:08:04 -0600 | [diff] [blame] | 161 | + "/tmp --ticket-number FFDC ; } >/tmp/OS_sosreport.txt 2>&1" |
| 162 | ), |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 163 | }, |
| 164 | } |
George Keishing | 671dd66 | 2021-05-28 03:26:30 -0500 | [diff] [blame] | 165 | # Add file name and corresponding command needed for RHEL Linux |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 166 | FFDC_OS_RHEL_FILE = { |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 167 | "OS FILES": { |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 168 | # File Name Command |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 169 | "OS_rsct.txt": "/usr/bin/ctversion -bv >/tmp/OS_rsct.txt 2>&1", |
| 170 | "OS_secure.txt": "cat /var/log/secure >/tmp/OS_secure.txt 2>&1", |
George Keishing | 4afd655 | 2023-02-06 03:08:04 -0600 | [diff] [blame] | 171 | "OS_syslog.txt": ( |
| 172 | "tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt 2>&1" |
| 173 | ), |
| 174 | "OS_info.txt": ( |
| 175 | "{ lsb_release -a; cat /etc/redhat-release; " |
| 176 | + "uname -a; rpm -qa ; } >/tmp/OS_info.txt 2>&1" |
| 177 | ), |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 178 | "OS_sosreport.txt": ( |
| 179 | "{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir " |
George Keishing | 4afd655 | 2023-02-06 03:08:04 -0600 | [diff] [blame] | 180 | + "/tmp --label FFDC ; } >/tmp/OS_sosreport.txt 2>&1" |
| 181 | ), |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 182 | }, |
| 183 | } |
George Keishing | 671dd66 | 2021-05-28 03:26:30 -0500 | [diff] [blame] | 184 | # Add file name and corresponding command needed for AIX. |
| 185 | FFDC_OS_AIX_FILE = { |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 186 | "OS FILES": { |
George Keishing | 671dd66 | 2021-05-28 03:26:30 -0500 | [diff] [blame] | 187 | # File Name Command |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 188 | "OS_errpt.txt": "errpt >/tmp/OS_errpt.txt 2>&1 ; errclear 0;", |
| 189 | "OS_processors.txt": "bindprocessor -q >/tmp/OS_processors.txt 2>&1", |
George Keishing | 671dd66 | 2021-05-28 03:26:30 -0500 | [diff] [blame] | 190 | }, |
| 191 | } |
George Keishing | 1970076 | 2020-01-22 12:32:53 -0600 | [diff] [blame] | 192 | |
George Keishing | a5bbc30 | 2021-10-04 22:30:55 -0500 | [diff] [blame] | 193 | try: |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 194 | redfish_support_trans_state = os.environ.get( |
| 195 | "REDFISH_SUPPORT_TRANS_STATE", 0 |
| 196 | ) or int( |
| 197 | BuiltIn().get_variable_value( |
| 198 | "${REDFISH_SUPPORT_TRANS_STATE}", default=0 |
| 199 | ) |
| 200 | ) |
George Keishing | a5bbc30 | 2021-10-04 22:30:55 -0500 | [diff] [blame] | 201 | except RobotNotRunningError: |
| 202 | pass |
| 203 | |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 204 | OPENBMC_BASE = "/xyz/openbmc_project/" |
| 205 | OPENPOWER_BASE = "/org/open_power/" |
| 206 | ENUMERATE_SENSORS = OPENBMC_BASE + "sensors/enumerate" |
| 207 | ENUMERATE_INVENTORY = OPENBMC_BASE + "inventory/enumerate" |
| 208 | ENUMERATE_ELOG = OPENBMC_BASE + "logging/entry/enumerate" |
| 209 | ENUMERATE_LED = OPENBMC_BASE + "led/enumerate" |
| 210 | ENUMERATE_SW = OPENBMC_BASE + "software/enumerate" |
| 211 | ENUMERATE_CONTROL = OPENBMC_BASE + "control/enumerate" |
| 212 | ENUMERATE_STATE = OPENBMC_BASE + "state/enumerate" |
| 213 | ENUMERATE_OCC = OPENPOWER_BASE + "/enumerate" |
| 214 | ENUMERATE_DUMPS = OPENBMC_BASE + "dumps/enumerate" |
| 215 | ENUMERATE_USER = OPENBMC_BASE + "user/enumerate" |
Sweta Potthuri | a82efd6 | 2017-10-18 05:34:59 -0500 | [diff] [blame] | 216 | |
George Keishing | 671dd66 | 2021-05-28 03:26:30 -0500 | [diff] [blame] | 217 | # Add file name and corresponding Get Request |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 218 | FFDC_GET_REQUEST = { |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 219 | "GET REQUESTS": { |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 220 | # File Name Command |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 221 | "FIRMWARE_list.txt": ENUMERATE_SW, |
| 222 | "BMC_sensor_list.txt": ENUMERATE_SENSORS, |
| 223 | "BMC_control_list.txt": ENUMERATE_CONTROL, |
| 224 | "BMC_inventory.txt": ENUMERATE_INVENTORY, |
| 225 | "BMC_elog.txt": ENUMERATE_ELOG, |
| 226 | "BMC_led.txt": ENUMERATE_LED, |
| 227 | "BMC_state.txt": ENUMERATE_STATE, |
| 228 | "OCC_state.txt": ENUMERATE_OCC, |
| 229 | "BMC_dumps.txt": ENUMERATE_DUMPS, |
| 230 | "BMC_USER.txt": ENUMERATE_USER, |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 231 | }, |
| 232 | } |
George Keishing | 8c42bbc | 2021-09-28 14:52:54 -0500 | [diff] [blame] | 233 | |
George Keishing | a5bbc30 | 2021-10-04 22:30:55 -0500 | [diff] [blame] | 234 | # Remove the REST dictionary elements. |
| 235 | if redfish_support_trans_state == 1: |
| 236 | for key in list(FFDC_GET_REQUEST): |
| 237 | del FFDC_GET_REQUEST[key] |
| 238 | |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 239 | REDFISH_BASE = "/redfish/v1/" |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 240 | REDFISH_FIRMWARE = REDFISH_BASE + "UpdateService/FirmwareInventory" |
George Keishing | 8c42bbc | 2021-09-28 14:52:54 -0500 | [diff] [blame] | 241 | |
Yi Hu | c32434a | 2024-01-11 17:33:10 -0800 | [diff] [blame] | 242 | try: |
| 243 | REDFISH_SYSTEM_ID = REDFISH_SYSTEM_ID = os.environ.get( |
| 244 | "SYSTEM_ID", "" |
| 245 | ) or BuiltIn().get_variable_value("${SYSTEM_ID}", default="system") |
| 246 | |
| 247 | REDFISH_ELOG = ( |
| 248 | REDFISH_BASE |
| 249 | + "Systems/" |
| 250 | + REDFISH_SYSTEM_ID |
| 251 | + "/LogServices/EventLog/Entries" |
| 252 | ) |
| 253 | except RobotNotRunningError: |
| 254 | REDFISH_ELOG = REDFISH_BASE + "Systems/system/LogServices/EventLog/Entries" |
| 255 | pass |
| 256 | |
George Keishing | 8c42bbc | 2021-09-28 14:52:54 -0500 | [diff] [blame] | 257 | # Add file name and corresponding Get Request |
| 258 | FFDC_GET_REDFISH_REQUEST = { |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 259 | "GET REQUESTS": { |
George Keishing | 8c42bbc | 2021-09-28 14:52:54 -0500 | [diff] [blame] | 260 | # File Name Command |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 261 | "BMC_redfish_elog.txt": REDFISH_ELOG, |
George Keishing | 8c42bbc | 2021-09-28 14:52:54 -0500 | [diff] [blame] | 262 | }, |
| 263 | } |
| 264 | |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 265 | # Define your keywords in method/utils and call here |
| 266 | FFDC_METHOD_CALL = { |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 267 | "BMC LOGS": { |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 268 | # Description Keyword name |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 269 | "Start ffdc cleanup": "BMC FFDC Cleanup", |
| 270 | "FFDC Generic Report": "BMC FFDC Manifest", |
| 271 | "BMC Specific Files": "BMC FFDC Files", |
| 272 | "Get Request FFDC": "BMC FFDC Get Requests", |
| 273 | "Get Redfish Request FFDC": "BMC FFDC Get Redfish Requests", |
| 274 | "OS FFDC": "OS FFDC Files", |
| 275 | "Core Files": "SCP Coredump Files", |
| 276 | "SEL Log": "Collect eSEL Log", |
| 277 | "Sys Inventory Files": "System Inventory Files", |
| 278 | "Dump Files": "SCP Dump Files", |
| 279 | "PEL Files": "Collect PEL Log", |
| 280 | "Redfish Log": "Enumerate Redfish Resources", |
George Keishing | 4afd655 | 2023-02-06 03:08:04 -0600 | [diff] [blame] | 281 | "Firmware Log": ( |
| 282 | "Enumerate Redfish Resources " |
| 283 | + " enum_uri=/redfish/v1/UpdateService/FirmwareInventory " |
| 284 | + " file_enum_name=redfish_FIRMWARE_list.txt" |
| 285 | ), |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 286 | "Redfish OEM Log": "Enumerate Redfish OEM Resources", |
| 287 | "End ffdc cleanup": "BMC FFDC Cleanup", |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 288 | }, |
| 289 | } |
Konstantin Aladyshev | 6788049 | 2021-03-20 17:20:57 +0300 | [diff] [blame] | 290 | |
George Keishing | 4b4eef7 | 2021-04-01 02:31:42 -0500 | [diff] [blame] | 291 | try: |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 292 | platform_arch_type = os.environ.get( |
| 293 | "PLATFORM_ARCH_TYPE", "" |
| 294 | ) or BuiltIn().get_variable_value("${PLATFORM_ARCH_TYPE}", default="power") |
George Keishing | 4b4eef7 | 2021-04-01 02:31:42 -0500 | [diff] [blame] | 295 | except RobotNotRunningError: |
| 296 | pass |
| 297 | |
Konstantin Aladyshev | 6788049 | 2021-03-20 17:20:57 +0300 | [diff] [blame] | 298 | # Filter the logs based on platform type. |
| 299 | if platform_arch_type == "x86": |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 300 | del FFDC_BMC_FILE["BMC FILES"]["PEL_logs_list.json"] |
| 301 | del FFDC_BMC_FILE["BMC FILES"]["PEL_logs_display.json"] |
| 302 | del FFDC_METHOD_CALL["BMC LOGS"]["PEL Files"] |
Konstantin Aladyshev | 6788049 | 2021-03-20 17:20:57 +0300 | [diff] [blame] | 303 | |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 304 | # ----------------------------------------------------------------- |
George Keishing | 4346a41 | 2016-07-19 11:26:49 -0500 | [diff] [blame] | 305 | # base class for FFDC default list |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 306 | |
| 307 | |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 308 | class openbmc_ffdc_list: |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 309 | def get_ffdc_bmc_cmd(self, i_type): |
| 310 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 311 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 312 | # @brief This method returns the list from the dictionary for cmds |
| 313 | # @param i_type: @type string: string index lookup |
| 314 | # @return List of key pair from the dictionary |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 315 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 316 | """ |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 317 | return FFDC_BMC_CMD[i_type].items() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 318 | |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 319 | def get_ffdc_bmc_file(self, i_type): |
| 320 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 321 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 322 | # @brief This method returns the list from the dictionary for scp |
| 323 | # @param i_type: @type string: string index lookup |
| 324 | # @return List of key pair from the dictionary |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 325 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 326 | """ |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 327 | return FFDC_BMC_FILE[i_type].items() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 328 | |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 329 | def get_ffdc_get_request(self, i_type): |
| 330 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 331 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 332 | # @brief This method returns the list from the dictionary for scp |
| 333 | # @param i_type: @type string: string index lookup |
| 334 | # @return List of key pair from the dictionary |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 335 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 336 | """ |
| 337 | return FFDC_GET_REQUEST[i_type].items() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 338 | |
George Keishing | 8c42bbc | 2021-09-28 14:52:54 -0500 | [diff] [blame] | 339 | def get_ffdc_get_redfish_request(self, i_type): |
| 340 | r""" |
| 341 | ####################################################################### |
| 342 | # @brief This method returns the list from the dictionary for scp |
| 343 | # @param i_type: @type string: string index lookup |
| 344 | # @return List of key pair from the dictionary |
| 345 | ####################################################################### |
| 346 | """ |
| 347 | return FFDC_GET_REDFISH_REQUEST[i_type].items() |
| 348 | |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 349 | def get_ffdc_cmd_index(self): |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 350 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 351 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 352 | # @brief This method returns the list index from dictionary |
| 353 | # @return List of index to the dictionary |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 354 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 355 | """ |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 356 | return FFDC_BMC_CMD.keys() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 357 | |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 358 | def get_ffdc_get_request_index(self): |
| 359 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 360 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 361 | # @brief This method returns the list index from dictionary |
| 362 | # @return List of index to the dictionary |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 363 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 364 | """ |
| 365 | return FFDC_GET_REQUEST.keys() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 366 | |
George Keishing | 8c42bbc | 2021-09-28 14:52:54 -0500 | [diff] [blame] | 367 | def get_ffdc_get_redfish_request_index(self): |
| 368 | r""" |
| 369 | ####################################################################### |
| 370 | # @brief This method returns the list index from dictionary |
| 371 | # @return List of index to the dictionary |
| 372 | ####################################################################### |
| 373 | """ |
| 374 | return FFDC_GET_REDFISH_REQUEST.keys() |
| 375 | |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 376 | def get_ffdc_file_index(self): |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 377 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 378 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 379 | # @brief This method returns the list index from dictionary |
| 380 | # @return List of index to the dictionary |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 381 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 382 | """ |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 383 | return FFDC_BMC_FILE.keys() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 384 | |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 385 | def get_ffdc_method_index(self): |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 386 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 387 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 388 | # @brief This method returns the key pair from the dictionary |
| 389 | # @return Index of the method dictionary |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 390 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 391 | """ |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 392 | return FFDC_METHOD_CALL.keys() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 393 | |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 394 | def get_ffdc_method_desc(self, index): |
Michael Walsh | e844e9a | 2017-04-20 16:51:10 -0500 | [diff] [blame] | 395 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 396 | ####################################################################### |
Michael Walsh | e844e9a | 2017-04-20 16:51:10 -0500 | [diff] [blame] | 397 | # @brief This method returns the just the keys from the dictionary. |
| 398 | # @return List of ffdc descriptions. |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 399 | ####################################################################### |
Michael Walsh | e844e9a | 2017-04-20 16:51:10 -0500 | [diff] [blame] | 400 | """ |
| 401 | return FFDC_METHOD_CALL[index].keys() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 402 | |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 403 | def get_ffdc_method_call(self, i_type): |
| 404 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 405 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 406 | # @brief This method returns the key pair from the dictionary |
| 407 | # @return List of key pair keywords |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 408 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 409 | """ |
George Keishing | 69e6f71 | 2016-09-12 06:30:09 -0500 | [diff] [blame] | 410 | return FFDC_METHOD_CALL[i_type].items() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 411 | |
Gunnar Mills | 7e2cda2 | 2016-10-11 15:37:34 -0500 | [diff] [blame] | 412 | def get_ffdc_os_all_distros_index(self): |
| 413 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 414 | ####################################################################### |
Gunnar Mills | 7e2cda2 | 2016-10-11 15:37:34 -0500 | [diff] [blame] | 415 | # @brief This method returns the key pair from the dictionary |
| 416 | # @return Index of the method dictionary |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 417 | ####################################################################### |
Gunnar Mills | 7e2cda2 | 2016-10-11 15:37:34 -0500 | [diff] [blame] | 418 | """ |
| 419 | return FFDC_OS_ALL_DISTROS_FILE.keys() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 420 | |
Gunnar Mills | 7e2cda2 | 2016-10-11 15:37:34 -0500 | [diff] [blame] | 421 | def get_ffdc_os_all_distros_call(self, i_type): |
| 422 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 423 | ####################################################################### |
Gunnar Mills | 7e2cda2 | 2016-10-11 15:37:34 -0500 | [diff] [blame] | 424 | # @brief This method returns the key pair from the dictionary |
| 425 | # @return List of key pair keywords |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 426 | ####################################################################### |
Gunnar Mills | 7e2cda2 | 2016-10-11 15:37:34 -0500 | [diff] [blame] | 427 | """ |
| 428 | return FFDC_OS_ALL_DISTROS_FILE[i_type].items() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 429 | |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 430 | def get_ffdc_os_distro_index(self, distro): |
| 431 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 432 | ####################################################################### |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 433 | # @brief This method returns the key pair from the dictionary |
| 434 | # @return Index of the method dictionary |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 435 | ####################################################################### |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 436 | """ |
| 437 | distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE" |
| 438 | return eval(distro_file).keys() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 439 | |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 440 | def get_ffdc_os_distro_call(self, i_type, distro): |
| 441 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 442 | ####################################################################### |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 443 | # @brief This method returns the key pair from the dictionary |
| 444 | # @return List of key pair keywords |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 445 | ####################################################################### |
Gunnar Mills | cce185d | 2016-10-17 17:04:15 -0500 | [diff] [blame] | 446 | """ |
| 447 | distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE" |
| 448 | return eval(distro_file)[i_type].items() |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 449 | |
George Keishing | 4346a41 | 2016-07-19 11:26:49 -0500 | [diff] [blame] | 450 | def get_strip_string(self, i_str): |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 451 | r""" |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 452 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 453 | # @brief Returns the stripped strings |
| 454 | # @param i_str: @type string: string name |
| 455 | # @return Remove all special chars and return the string |
Joy Onyerikwu | 004ad3c | 2018-06-11 16:29:56 -0500 | [diff] [blame] | 456 | ####################################################################### |
Gunnar Mills | a812e0f | 2016-09-29 20:30:03 -0500 | [diff] [blame] | 457 | """ |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 458 | return "".join(e for e in i_str if e.isalnum()) |
Gunnar Mills | 096cd56 | 2018-03-26 10:19:12 -0500 | [diff] [blame] | 459 | |
George Keishing | 28da948 | 2017-07-27 13:38:54 -0500 | [diff] [blame] | 460 | def get_esel_index(self, esel_list): |
| 461 | r""" |
| 462 | ####################################################################### |
| 463 | # @brief Returns the eSEL binary index. |
| 464 | # @param esel_ist: @type list: eSEL list. |
| 465 | # @return Index of "ESEL=" in the list. |
| 466 | ####################################################################### |
| 467 | """ |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 468 | index = [i for i, str in enumerate(esel_list) if "ESEL=" in str] |
George Keishing | 28da948 | 2017-07-27 13:38:54 -0500 | [diff] [blame] | 469 | return index[0] |
Sweta Potthuri | a82efd6 | 2017-10-18 05:34:59 -0500 | [diff] [blame] | 470 | |
| 471 | def get_dump_index(self, dump_list): |
| 472 | r""" |
| 473 | ####################################################################### |
| 474 | # @brief Returns the eSEL binary index. |
| 475 | # @param esel_ist: @type list: eSEL list. |
| 476 | # @return Index of "ESEL=" in the list. |
| 477 | ####################################################################### |
| 478 | """ |
Patrick Williams | 20f3871 | 2022-12-08 06:18:26 -0600 | [diff] [blame] | 479 | index = [i for i, str in enumerate(dump_list) if "DUMP=" in str] |
Sweta Potthuri | a82efd6 | 2017-10-18 05:34:59 -0500 | [diff] [blame] | 480 | return index[0] |