blob: 540b7444e3477723c896229f314041d4f8fa04d4 [file] [log] [blame]
George Keishinge7e91712021-09-03 11:28:44 -05001#!/usr/bin/env python3
Gunnar Millsa812e0f2016-09-29 20:30:03 -05002r"""
George Keishing4346a412016-07-19 11:26:49 -05003# @file openbmc_ffdc_list.py
George Keishing4346a412016-07-19 11:26:49 -05004# @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 Millsa812e0f2016-09-29 20:30:03 -05007"""
Konstantin Aladyshevc056c2b2021-03-25 11:59:39 +03008import os
9
Konstantin Aladyshev67880492021-03-20 17:20:57 +030010from robot.libraries.BuiltIn import BuiltIn
11
Gunnar Millsa812e0f2016-09-29 20:30:03 -050012# -------------------
George Keishing4346a412016-07-19 11:26:49 -050013# FFDC default list
Gunnar Millsa812e0f2016-09-29 20:30:03 -050014# -------------------
Gunnar Millsa812e0f2016-09-29 20:30:03 -050015# -----------------------------------------------------------------
Gunnar Mills28e403b2017-10-25 16:16:38 -050016# Dict Name { Index string : { Key String : Command string} }
Gunnar Millsa812e0f2016-09-29 20:30:03 -050017# -----------------------------------------------------------------
George Keishing69e6f712016-09-12 06:30:09 -050018# Add cmd's needed to be part of the ffdc report manifest file
19FFDC_BMC_CMD = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -050020 'DRIVER INFO':
21 {
22 # String Name Command
Gunnar Millsa812e0f2016-09-29 20:30:03 -050023 'FW Level': 'cat /etc/os-release',
George Keishingc5ab1b62017-08-16 13:51:14 -050024 'FW Timestamp': 'cat /etc/timestamp',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050025 },
26 'BMC DATA':
27 {
28 'BMC OS': 'uname -a',
Michael Walshcba9f332019-07-19 15:14:26 -050029 'BMC Uptime': 'uptime;cat /proc/uptime',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050030 'BMC File System Disk Space Usage': 'df -hT',
George Keishing342bcea2017-11-11 03:08:54 -060031 'BMC Date Time': 'date;/sbin/hwclock --show;/usr/bin/timedatectl'
Gunnar Millsa812e0f2016-09-29 20:30:03 -050032 },
33 'APPLICATION DATA':
34 {
George Keishing5bcbfba2019-04-19 12:31:16 -050035 'BMC state': '/usr/bin/obmcutil state',
George Keishingae5fefb2021-07-08 15:30:48 -050036 'bmcweb data': 'for f in `find /var/lib/bmcweb/ -name "*.json"`; do (echo $f; cat $f) done',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050037 },
38}
George Keishing671dd662021-05-28 03:26:30 -050039# Add file name and corresponding command needed for BMC
George Keishing69e6f712016-09-12 06:30:09 -050040FFDC_BMC_FILE = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -050041 'BMC FILES':
42 {
43 # File Name Command
George Keishing1a4c57d2020-03-18 13:18:49 -050044 'BMC_flash_side.txt': 'cat /sys/class/watchdog/watchdog1/bootstatus >/tmp/BMC_flash_side.txt 2>&1',
George Keishing255d81c2020-07-08 01:37:52 -050045 'BMC_hwmon.txt': 'grep -r . /sys/class/hwmon/* >/tmp/BMC_hwmon.txt 2>&1',
George Keishing1a4c57d2020-03-18 13:18:49 -050046 'BMC_proc_list.txt': 'top -n 1 -b >/tmp/BMC_proc_list.txt 2>&1',
47 'BMC_proc_fd_active_list.txt': 'ls -Al /proc/*/fd/ >/tmp/BMC_proc_fd_active_list.txt 2>&1',
48 'BMC_journalctl_nopager.txt': 'journalctl --no-pager >/tmp/BMC_journalctl_nopager.txt 2>&1',
49 'BMC_journalctl_pretty.json': 'journalctl -o json-pretty >/tmp/BMC_journalctl_pretty.json 2>&1',
50 'BMC_dmesg.txt': 'dmesg >/tmp/BMC_dmesg.txt 2>&1',
51 'BMC_procinfo.txt': 'cat /proc/cpuinfo >/tmp/BMC_procinfo.txt 2>&1',
52 'BMC_meminfo.txt': 'cat /proc/meminfo >/tmp/BMC_meminfo.txt 2>&1',
53 'BMC_systemd.txt': 'systemctl status --all >/tmp/BMC_systemd.txt 2>&1',
George Keishing7fecd1c2021-03-09 12:14:30 -060054 'BMC_failed_service.txt': 'systemctl list-units --failed >/tmp/BMC_failed_service.txt 2>&1',
George Keishing925d5262021-03-18 11:46:00 -050055 'BMC_list_service.txt': 'systemctl list-jobs >/tmp/BMC_list_service.txt 2>&1',
George Keishing1a4c57d2020-03-18 13:18:49 -050056 'BMC_obmc_console.txt': 'cat /var/log/obmc-console.log >/tmp/BMC_obmc_console.txt 2>&1',
George Keishing5f486dc2021-04-14 03:14:52 -050057 'BMC_obmc_console1.txt': 'cat /var/log/obmc-console1.log >/tmp/BMC_obmc_console1.txt 2>&1',
George Keishingea7b4a02020-03-18 14:21:05 -050058 'PEL_logs_list.json': 'peltool -l >/tmp/PEL_logs_list.json 2>&1',
George Keishingce183172021-10-21 13:37:01 -050059 'PEL_logs_complete_list.json': 'peltool -l -a -f >/tmp/PEL_logs_complete_list.json 2>&1',
George Keishingea7b4a02020-03-18 14:21:05 -050060 'PEL_logs_display.json': 'peltool -a >/tmp/PEL_logs_display.json 2>&1',
George Keishingce183172021-10-21 13:37:01 -050061 'PEL_logs_complete_display.json': 'peltool -a -f -h>/tmp/PEL_logs_complete_display.json 2>&1',
David Shaw4081fca2021-12-14 16:42:46 -060062 'PEL_logs_badPEL.txt': 'hexdump -C'
63 + ' /var/lib/phosphor-logging/extensions/pels/badPEL>/tmp/PEL_logs_badPEL.txt 2>&1',
George Keishing79d17432021-08-31 12:43:57 -050064 'BMC_pldm_flight_recorder.txt': 'rm -rf /tmp/pldm_flight_recorder; killall -s SIGUSR1 pldmd;'
65 + ' sleep 5; cat /tmp/pldm_flight_recorder > /tmp/BMC_pldm_flight_recorder.txt 2>&1;',
George Keishing7ae99222021-09-28 15:20:00 -050066 'OCC_state.txt': 'for i in {0..3};'
67 + ' do (echo /org/open_power/control/occ$i;'
68 + ' busctl get-property org.open_power.OCC.Control /org/open_power/control/occ$i'
69 + ' org.open_power.OCC.Status OccActive) done > /tmp/OCC_state.txt 2>&1',
George Keishingc9d61d32021-10-25 05:07:23 -050070 'bmcweb_persistent_data.json': 'cat /home/root/bmcweb_persistent_data.json'
71 + ' > /tmp/bmcweb_persistent_data.json',
George Keishing6589b472021-12-14 22:31:59 -060072 'GUARD_list.txt': 'guard -l > /tmp/GUARD_list.txt 2>&1',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050073 },
74}
George Keishingf9f661d2020-03-18 11:42:53 -050075# Add file name and corresponding command needed for all Linux distributions
Gunnar Mills7e2cda22016-10-11 15:37:34 -050076FFDC_OS_ALL_DISTROS_FILE = {
77 'OS FILES':
78 {
79 # File Name Command
George Keishing1a4c57d2020-03-18 13:18:49 -050080 'OS_msglog.txt': 'cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt 2>&1',
81 'OS_cpufrequency.txt': 'ppc64_cpu --frequency '
82 + '>/tmp/OS_cpufrequency.txt 2>&1',
83 'OS_dmesg.txt': 'dmesg >/tmp/OS_dmesg.txt 2>&1',
84 'OS_opal_prd.txt': 'cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt 2>&1',
85 'OS_boot.txt': 'cat /var/log/boot.log >/tmp/OS_boot.txt 2>&1',
86 'OS_procinfo.txt': 'cat /proc/cpuinfo >/tmp/OS_procinfo.txt 2>&1',
87 'OS_meminfo.txt': 'cat /proc/meminfo >/tmp/OS_meminfo.txt 2>&1',
88 'OS_netstat.txt': 'netstat -a >/tmp/OS_netstat.txt 2>&1',
89 'OS_lspci.txt': 'lspci >/tmp/OS_lspci.txt 2>&1',
90 'OS_lscpu.txt': 'lscpu >/tmp/OS_lscpu.txt 2>&1',
91 'OS_lscfg.txt': 'lscfg >/tmp/OS_lscfg.txt 2>&1',
92 'OS_journalctl_nopager.txt': 'journalctl --no-pager -b '
93 + '> /tmp/OS_journalctl_nopager.txt 2>&1',
Gunnar Mills7e2cda22016-10-11 15:37:34 -050094 },
95}
George Keishing671dd662021-05-28 03:26:30 -050096# Add file name and corresponding command needed for Ubuntu Linux
Gunnar Millscce185d2016-10-17 17:04:15 -050097FFDC_OS_UBUNTU_FILE = {
98 'OS FILES':
99 {
100 # File Name Command
George Keishinga760b6d2021-09-03 12:31:31 -0500101 'OS_isusb.txt': '{ lsusb -t ; lsusb -v ; } >/tmp/OS_isusb.txt 2>&1',
George Keishing1a4c57d2020-03-18 13:18:49 -0500102 'OS_kern.txt': 'tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt 2>&1',
103 'OS_authlog.txt': '{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } '
104 + '>/tmp/OS_authlog.txt 2>&1',
105 'OS_syslog.txt': 'tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt 2>&1',
106 'OS_info.txt': '{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } '
107 + '>/tmp/OS_info.txt 2>&1',
108 'OS_sosreport.txt': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir '
109 + '/tmp --ticket-number FFDC ; } >/tmp/OS_sosreport.txt 2>&1',
Gunnar Millscce185d2016-10-17 17:04:15 -0500110 },
111}
George Keishing671dd662021-05-28 03:26:30 -0500112# Add file name and corresponding command needed for RHEL Linux
Gunnar Millscce185d2016-10-17 17:04:15 -0500113FFDC_OS_RHEL_FILE = {
114 'OS FILES':
115 {
116 # File Name Command
George Keishing1a4c57d2020-03-18 13:18:49 -0500117 'OS_rsct.txt': '/usr/bin/ctversion -bv >/tmp/OS_rsct.txt 2>&1',
118 'OS_secure.txt': 'cat /var/log/secure >/tmp/OS_secure.txt 2>&1',
119 'OS_syslog.txt': 'tail -n 200000 /var/log/messages '
120 + '>/tmp/OS_syslog.txt 2>&1',
121 'OS_info.txt': '{ lsb_release -a; cat /etc/redhat-release; '
122 + 'uname -a; rpm -qa ; } >/tmp/OS_info.txt 2>&1',
123 'OS_sosreport.txt': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir '
124 + '/tmp --label FFDC ; } >/tmp/OS_sosreport.txt 2>&1',
Gunnar Millscce185d2016-10-17 17:04:15 -0500125 },
126}
George Keishing671dd662021-05-28 03:26:30 -0500127# Add file name and corresponding command needed for AIX.
128FFDC_OS_AIX_FILE = {
129 'OS FILES':
130 {
131 # File Name Command
132 'OS_errpt.txt': 'errpt >/tmp/OS_errpt.txt 2>&1 ; errclear 0;',
133 'OS_processors.txt': 'bindprocessor -q >/tmp/OS_processors.txt 2>&1',
134 },
135}
George Keishing19700762020-01-22 12:32:53 -0600136
George Keishinga5bbc302021-10-04 22:30:55 -0500137try:
138 redfish_support_trans_state = os.environ.get('REDFISH_SUPPORT_TRANS_STATE', 0) or \
139 int(BuiltIn().get_variable_value("${REDFISH_SUPPORT_TRANS_STATE}", default=0))
140except RobotNotRunningError:
141 pass
142
George Keishingf77ea872017-09-01 08:02:21 -0500143OPENBMC_BASE = '/xyz/openbmc_project/'
George Keishingba000382017-09-19 13:25:29 -0500144OPENPOWER_BASE = '/org/open_power/'
George Keishingfe5724d2016-11-23 09:25:36 -0600145ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
George Keishingf77ea872017-09-01 08:02:21 -0500146ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate'
147ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate'
148ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate'
149ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate'
150ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate'
George Keishing9be77cd2017-11-13 07:52:08 -0600151ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
George Keishing8d500452019-04-03 07:42:25 -0500152ENUMERATE_OCC = OPENPOWER_BASE + '/enumerate'
Sweta Potthuria82efd62017-10-18 05:34:59 -0500153ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
George Keishing42ebe192018-10-10 14:17:51 -0500154ENUMERATE_USER = OPENBMC_BASE + 'user/enumerate'
Sweta Potthuria82efd62017-10-18 05:34:59 -0500155
George Keishing671dd662021-05-28 03:26:30 -0500156# Add file name and corresponding Get Request
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500157FFDC_GET_REQUEST = {
158 'GET REQUESTS':
159 {
160 # File Name Command
George Keishing1a4c57d2020-03-18 13:18:49 -0500161 'FIRMWARE_list.txt': ENUMERATE_SW,
162 'BMC_sensor_list.txt': ENUMERATE_SENSORS,
163 'BMC_control_list.txt': ENUMERATE_CONTROL,
164 'BMC_inventory.txt': ENUMERATE_INVENTORY,
165 'BMC_elog.txt': ENUMERATE_ELOG,
166 'BMC_led.txt': ENUMERATE_LED,
167 'BMC_state.txt': ENUMERATE_STATE,
168 'OCC_state.txt': ENUMERATE_OCC,
169 'BMC_dumps.txt': ENUMERATE_DUMPS,
170 'BMC_USER.txt': ENUMERATE_USER,
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500171 },
172}
George Keishing8c42bbc2021-09-28 14:52:54 -0500173
George Keishinga5bbc302021-10-04 22:30:55 -0500174# Remove the REST dictionary elements.
175if redfish_support_trans_state == 1:
176 for key in list(FFDC_GET_REQUEST):
177 del FFDC_GET_REQUEST[key]
178
George Keishing8c42bbc2021-09-28 14:52:54 -0500179REDFISH_BASE = '/redfish/v1/'
180REDFISH_ELOG = REDFISH_BASE + 'Systems/system/LogServices/EventLog/Entries'
George Keishing5942d202021-10-04 13:09:24 -0500181REDFISH_FIRMWARE = REDFISH_BASE + 'UpdateService/FirmwareInventory'
George Keishing8c42bbc2021-09-28 14:52:54 -0500182
183# Add file name and corresponding Get Request
184FFDC_GET_REDFISH_REQUEST = {
185 'GET REQUESTS':
186 {
187 # File Name Command
188 'BMC_redfish_elog.txt': REDFISH_ELOG,
189 },
190}
191
George Keishing69e6f712016-09-12 06:30:09 -0500192# Define your keywords in method/utils and call here
193FFDC_METHOD_CALL = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500194 'BMC LOGS':
195 {
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500196 # Description Keyword name
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500197 'FFDC Generic Report': 'BMC FFDC Manifest',
198 'BMC Specific Files': 'BMC FFDC Files',
199 'Get Request FFDC': 'BMC FFDC Get Requests',
George Keishing8c42bbc2021-09-28 14:52:54 -0500200 'Get Redfish Request FFDC': 'BMC FFDC Get Redfish Requests',
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500201 'OS FFDC': 'OS FFDC Files',
George Keishing7a520222017-02-27 09:44:30 -0600202 'Core Files': 'SCP Coredump Files',
George Keishingeb7b4bc2017-03-13 12:04:28 -0500203 'SEL Log': 'Collect eSEL Log',
Steven Sombar96de5732017-08-17 09:04:52 -0500204 'Sys Inventory Files': 'System Inventory Files',
Sweta Potthuria82efd62017-10-18 05:34:59 -0500205 'Dump Log': 'Collect Dump Log',
Steven Sombar2da175f2019-02-04 10:32:58 -0600206 'Dump Files': 'SCP Dump Files',
George Keishing1165a022021-05-19 06:23:13 -0500207 'Dump HB Files': 'SCP Dump HB Files',
George Keishingbe396b82020-03-23 10:23:58 -0500208 'PEL Files': 'Collect PEL Log',
Steven Sombar2da175f2019-02-04 10:32:58 -0600209 'Redfish Log': 'Enumerate Redfish Resources',
George Keishing5942d202021-10-04 13:09:24 -0500210 'Firmware Log': 'Enumerate Redfish Resources '
211 + ' enum_uri=/redfish/v1/UpdateService/FirmwareInventory '
212 + ' file_enum_name=redfish_FIRMWARE_list.txt',
George Keishing985659a2021-06-23 02:52:13 -0500213 'Redfish OEM Log': 'Enumerate Redfish OEM Resources',
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500214 },
215}
Konstantin Aladyshev67880492021-03-20 17:20:57 +0300216
George Keishing4b4eef72021-04-01 02:31:42 -0500217try:
218 platform_arch_type = os.environ.get('PLATFORM_ARCH_TYPE', '') or \
219 BuiltIn().get_variable_value("${PLATFORM_ARCH_TYPE}", default="power")
220except RobotNotRunningError:
221 pass
222
Konstantin Aladyshev67880492021-03-20 17:20:57 +0300223# Filter the logs based on platform type.
224if platform_arch_type == "x86":
225 del FFDC_BMC_FILE['BMC FILES']['PEL_logs_list.json']
226 del FFDC_BMC_FILE['BMC FILES']['PEL_logs_display.json']
227 del FFDC_METHOD_CALL['BMC LOGS']['PEL Files']
228
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500229# -----------------------------------------------------------------
George Keishing4346a412016-07-19 11:26:49 -0500230# base class for FFDC default list
Gunnar Mills096cd562018-03-26 10:19:12 -0500231
232
George Keishing4346a412016-07-19 11:26:49 -0500233class openbmc_ffdc_list():
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500234 def get_ffdc_bmc_cmd(self, i_type):
235 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500236 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500237 # @brief This method returns the list from the dictionary for cmds
238 # @param i_type: @type string: string index lookup
239 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500240 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500241 """
George Keishing69e6f712016-09-12 06:30:09 -0500242 return FFDC_BMC_CMD[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500243
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500244 def get_ffdc_bmc_file(self, i_type):
245 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500246 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500247 # @brief This method returns the list from the dictionary for scp
248 # @param i_type: @type string: string index lookup
249 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500250 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500251 """
George Keishing69e6f712016-09-12 06:30:09 -0500252 return FFDC_BMC_FILE[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500253
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500254 def get_ffdc_get_request(self, i_type):
255 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500256 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500257 # @brief This method returns the list from the dictionary for scp
258 # @param i_type: @type string: string index lookup
259 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500260 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500261 """
262 return FFDC_GET_REQUEST[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500263
George Keishing8c42bbc2021-09-28 14:52:54 -0500264 def get_ffdc_get_redfish_request(self, i_type):
265 r"""
266 #######################################################################
267 # @brief This method returns the list from the dictionary for scp
268 # @param i_type: @type string: string index lookup
269 # @return List of key pair from the dictionary
270 #######################################################################
271 """
272 return FFDC_GET_REDFISH_REQUEST[i_type].items()
273
George Keishing69e6f712016-09-12 06:30:09 -0500274 def get_ffdc_cmd_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500275 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500276 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500277 # @brief This method returns the list index from dictionary
278 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500279 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500280 """
George Keishing69e6f712016-09-12 06:30:09 -0500281 return FFDC_BMC_CMD.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500282
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500283 def get_ffdc_get_request_index(self):
284 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500285 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500286 # @brief This method returns the list index from dictionary
287 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500288 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500289 """
290 return FFDC_GET_REQUEST.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500291
George Keishing8c42bbc2021-09-28 14:52:54 -0500292 def get_ffdc_get_redfish_request_index(self):
293 r"""
294 #######################################################################
295 # @brief This method returns the list index from dictionary
296 # @return List of index to the dictionary
297 #######################################################################
298 """
299 return FFDC_GET_REDFISH_REQUEST.keys()
300
George Keishing69e6f712016-09-12 06:30:09 -0500301 def get_ffdc_file_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500302 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500303 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500304 # @brief This method returns the list index from dictionary
305 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500306 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500307 """
George Keishing69e6f712016-09-12 06:30:09 -0500308 return FFDC_BMC_FILE.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500309
George Keishing69e6f712016-09-12 06:30:09 -0500310 def get_ffdc_method_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500311 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500312 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500313 # @brief This method returns the key pair from the dictionary
314 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500315 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500316 """
George Keishing69e6f712016-09-12 06:30:09 -0500317 return FFDC_METHOD_CALL.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500318
Michael Walshe844e9a2017-04-20 16:51:10 -0500319 def get_ffdc_method_desc(self,
320 index):
321 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500322 #######################################################################
Michael Walshe844e9a2017-04-20 16:51:10 -0500323 # @brief This method returns the just the keys from the dictionary.
324 # @return List of ffdc descriptions.
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500325 #######################################################################
Michael Walshe844e9a2017-04-20 16:51:10 -0500326 """
327 return FFDC_METHOD_CALL[index].keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500328
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500329 def get_ffdc_method_call(self, i_type):
330 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500331 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500332 # @brief This method returns the key pair from the dictionary
333 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500334 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500335 """
George Keishing69e6f712016-09-12 06:30:09 -0500336 return FFDC_METHOD_CALL[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500337
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500338 def get_ffdc_os_all_distros_index(self):
339 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500340 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500341 # @brief This method returns the key pair from the dictionary
342 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500343 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500344 """
345 return FFDC_OS_ALL_DISTROS_FILE.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500346
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500347 def get_ffdc_os_all_distros_call(self, i_type):
348 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500349 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500350 # @brief This method returns the key pair from the dictionary
351 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500352 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500353 """
354 return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500355
Gunnar Millscce185d2016-10-17 17:04:15 -0500356 def get_ffdc_os_distro_index(self, distro):
357 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500358 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500359 # @brief This method returns the key pair from the dictionary
360 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500361 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500362 """
363 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
364 return eval(distro_file).keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500365
Gunnar Millscce185d2016-10-17 17:04:15 -0500366 def get_ffdc_os_distro_call(self, i_type, distro):
367 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500368 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500369 # @brief This method returns the key pair from the dictionary
370 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500371 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500372 """
373 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
374 return eval(distro_file)[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500375
George Keishing4346a412016-07-19 11:26:49 -0500376 def get_strip_string(self, i_str):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500377 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500378 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500379 # @brief Returns the stripped strings
380 # @param i_str: @type string: string name
381 # @return Remove all special chars and return the string
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500382 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500383 """
George Keishing4346a412016-07-19 11:26:49 -0500384 return ''.join(e for e in i_str if e.isalnum())
Gunnar Mills096cd562018-03-26 10:19:12 -0500385
George Keishing28da9482017-07-27 13:38:54 -0500386 def get_esel_index(self, esel_list):
387 r"""
388 #######################################################################
389 # @brief Returns the eSEL binary index.
390 # @param esel_ist: @type list: eSEL list.
391 # @return Index of "ESEL=" in the list.
392 #######################################################################
393 """
394 index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
395 return index[0]
Sweta Potthuria82efd62017-10-18 05:34:59 -0500396
397 def get_dump_index(self, dump_list):
398 r"""
399 #######################################################################
400 # @brief Returns the eSEL binary index.
401 # @param esel_ist: @type list: eSEL list.
402 # @return Index of "ESEL=" in the list.
403 #######################################################################
404 """
405 index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str]
406 return index[0]