blob: 1ac67d57f7d1658738812f7c227d70adaf68784e [file] [log] [blame]
George Keishing4346a412016-07-19 11:26:49 -05001#!/usr/bin/python
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',
59 'PEL_logs_display.json': 'peltool -a >/tmp/PEL_logs_display.json 2>&1',
George Keishing79d17432021-08-31 12:43:57 -050060 'BMC_pldm_flight_recorder.txt': 'rm -rf /tmp/pldm_flight_recorder; killall -s SIGUSR1 pldmd;'
61 + ' sleep 5; cat /tmp/pldm_flight_recorder > /tmp/BMC_pldm_flight_recorder.txt 2>&1;',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050062 },
63}
George Keishingf9f661d2020-03-18 11:42:53 -050064# Add file name and corresponding command needed for all Linux distributions
Gunnar Mills7e2cda22016-10-11 15:37:34 -050065FFDC_OS_ALL_DISTROS_FILE = {
66 'OS FILES':
67 {
68 # File Name Command
George Keishing1a4c57d2020-03-18 13:18:49 -050069 'OS_msglog.txt': 'cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt 2>&1',
70 'OS_cpufrequency.txt': 'ppc64_cpu --frequency '
71 + '>/tmp/OS_cpufrequency.txt 2>&1',
72 'OS_dmesg.txt': 'dmesg >/tmp/OS_dmesg.txt 2>&1',
73 'OS_opal_prd.txt': 'cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt 2>&1',
74 'OS_boot.txt': 'cat /var/log/boot.log >/tmp/OS_boot.txt 2>&1',
75 'OS_procinfo.txt': 'cat /proc/cpuinfo >/tmp/OS_procinfo.txt 2>&1',
76 'OS_meminfo.txt': 'cat /proc/meminfo >/tmp/OS_meminfo.txt 2>&1',
77 'OS_netstat.txt': 'netstat -a >/tmp/OS_netstat.txt 2>&1',
78 'OS_lspci.txt': 'lspci >/tmp/OS_lspci.txt 2>&1',
79 'OS_lscpu.txt': 'lscpu >/tmp/OS_lscpu.txt 2>&1',
80 'OS_lscfg.txt': 'lscfg >/tmp/OS_lscfg.txt 2>&1',
81 'OS_journalctl_nopager.txt': 'journalctl --no-pager -b '
82 + '> /tmp/OS_journalctl_nopager.txt 2>&1',
Gunnar Mills7e2cda22016-10-11 15:37:34 -050083 },
84}
George Keishing671dd662021-05-28 03:26:30 -050085# Add file name and corresponding command needed for Ubuntu Linux
Gunnar Millscce185d2016-10-17 17:04:15 -050086FFDC_OS_UBUNTU_FILE = {
87 'OS FILES':
88 {
89 # File Name Command
George Keishinga760b6d2021-09-03 12:31:31 -050090 'OS_isusb.txt': '{ lsusb -t ; lsusb -v ; } >/tmp/OS_isusb.txt 2>&1',
George Keishing1a4c57d2020-03-18 13:18:49 -050091 'OS_kern.txt': 'tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt 2>&1',
92 'OS_authlog.txt': '{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } '
93 + '>/tmp/OS_authlog.txt 2>&1',
94 'OS_syslog.txt': 'tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt 2>&1',
95 'OS_info.txt': '{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } '
96 + '>/tmp/OS_info.txt 2>&1',
97 'OS_sosreport.txt': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir '
98 + '/tmp --ticket-number FFDC ; } >/tmp/OS_sosreport.txt 2>&1',
Gunnar Millscce185d2016-10-17 17:04:15 -050099 },
100}
George Keishing671dd662021-05-28 03:26:30 -0500101# Add file name and corresponding command needed for RHEL Linux
Gunnar Millscce185d2016-10-17 17:04:15 -0500102FFDC_OS_RHEL_FILE = {
103 'OS FILES':
104 {
105 # File Name Command
George Keishing1a4c57d2020-03-18 13:18:49 -0500106 'OS_rsct.txt': '/usr/bin/ctversion -bv >/tmp/OS_rsct.txt 2>&1',
107 'OS_secure.txt': 'cat /var/log/secure >/tmp/OS_secure.txt 2>&1',
108 'OS_syslog.txt': 'tail -n 200000 /var/log/messages '
109 + '>/tmp/OS_syslog.txt 2>&1',
110 'OS_info.txt': '{ lsb_release -a; cat /etc/redhat-release; '
111 + 'uname -a; rpm -qa ; } >/tmp/OS_info.txt 2>&1',
112 'OS_sosreport.txt': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir '
113 + '/tmp --label FFDC ; } >/tmp/OS_sosreport.txt 2>&1',
Gunnar Millscce185d2016-10-17 17:04:15 -0500114 },
115}
George Keishing671dd662021-05-28 03:26:30 -0500116# Add file name and corresponding command needed for AIX.
117FFDC_OS_AIX_FILE = {
118 'OS FILES':
119 {
120 # File Name Command
121 'OS_errpt.txt': 'errpt >/tmp/OS_errpt.txt 2>&1 ; errclear 0;',
122 'OS_processors.txt': 'bindprocessor -q >/tmp/OS_processors.txt 2>&1',
123 },
124}
George Keishing19700762020-01-22 12:32:53 -0600125
George Keishingf77ea872017-09-01 08:02:21 -0500126OPENBMC_BASE = '/xyz/openbmc_project/'
George Keishingba000382017-09-19 13:25:29 -0500127OPENPOWER_BASE = '/org/open_power/'
George Keishingfe5724d2016-11-23 09:25:36 -0600128ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
George Keishingf77ea872017-09-01 08:02:21 -0500129ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate'
130ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate'
131ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate'
132ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate'
133ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate'
George Keishing9be77cd2017-11-13 07:52:08 -0600134ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
George Keishing8d500452019-04-03 07:42:25 -0500135ENUMERATE_OCC = OPENPOWER_BASE + '/enumerate'
Sweta Potthuria82efd62017-10-18 05:34:59 -0500136ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
George Keishing42ebe192018-10-10 14:17:51 -0500137ENUMERATE_USER = OPENBMC_BASE + 'user/enumerate'
Sweta Potthuria82efd62017-10-18 05:34:59 -0500138
George Keishing671dd662021-05-28 03:26:30 -0500139# Add file name and corresponding Get Request
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500140FFDC_GET_REQUEST = {
141 'GET REQUESTS':
142 {
143 # File Name Command
George Keishing1a4c57d2020-03-18 13:18:49 -0500144 'FIRMWARE_list.txt': ENUMERATE_SW,
145 'BMC_sensor_list.txt': ENUMERATE_SENSORS,
146 'BMC_control_list.txt': ENUMERATE_CONTROL,
147 'BMC_inventory.txt': ENUMERATE_INVENTORY,
148 'BMC_elog.txt': ENUMERATE_ELOG,
149 'BMC_led.txt': ENUMERATE_LED,
150 'BMC_state.txt': ENUMERATE_STATE,
151 'OCC_state.txt': ENUMERATE_OCC,
152 'BMC_dumps.txt': ENUMERATE_DUMPS,
153 'BMC_USER.txt': ENUMERATE_USER,
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500154 },
155}
George Keishing69e6f712016-09-12 06:30:09 -0500156# Define your keywords in method/utils and call here
157FFDC_METHOD_CALL = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500158 'BMC LOGS':
159 {
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500160 # Description Keyword name
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500161 'FFDC Generic Report': 'BMC FFDC Manifest',
162 'BMC Specific Files': 'BMC FFDC Files',
163 'Get Request FFDC': 'BMC FFDC Get Requests',
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500164 'OS FFDC': 'OS FFDC Files',
George Keishing7a520222017-02-27 09:44:30 -0600165 'Core Files': 'SCP Coredump Files',
George Keishingeb7b4bc2017-03-13 12:04:28 -0500166 'SEL Log': 'Collect eSEL Log',
Steven Sombar96de5732017-08-17 09:04:52 -0500167 'Sys Inventory Files': 'System Inventory Files',
Sweta Potthuria82efd62017-10-18 05:34:59 -0500168 'Dump Log': 'Collect Dump Log',
Steven Sombar2da175f2019-02-04 10:32:58 -0600169 'Dump Files': 'SCP Dump Files',
George Keishing1165a022021-05-19 06:23:13 -0500170 'Dump HB Files': 'SCP Dump HB Files',
George Keishingbe396b82020-03-23 10:23:58 -0500171 'PEL Files': 'Collect PEL Log',
Steven Sombar2da175f2019-02-04 10:32:58 -0600172 'Redfish Log': 'Enumerate Redfish Resources',
George Keishing985659a2021-06-23 02:52:13 -0500173 'Redfish OEM Log': 'Enumerate Redfish OEM Resources',
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500174 },
175}
Konstantin Aladyshev67880492021-03-20 17:20:57 +0300176
George Keishing4b4eef72021-04-01 02:31:42 -0500177try:
178 platform_arch_type = os.environ.get('PLATFORM_ARCH_TYPE', '') or \
179 BuiltIn().get_variable_value("${PLATFORM_ARCH_TYPE}", default="power")
180except RobotNotRunningError:
181 pass
182
Konstantin Aladyshev67880492021-03-20 17:20:57 +0300183# Filter the logs based on platform type.
184if platform_arch_type == "x86":
185 del FFDC_BMC_FILE['BMC FILES']['PEL_logs_list.json']
186 del FFDC_BMC_FILE['BMC FILES']['PEL_logs_display.json']
187 del FFDC_METHOD_CALL['BMC LOGS']['PEL Files']
188
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500189# -----------------------------------------------------------------
George Keishing4346a412016-07-19 11:26:49 -0500190# base class for FFDC default list
Gunnar Mills096cd562018-03-26 10:19:12 -0500191
192
George Keishing4346a412016-07-19 11:26:49 -0500193class openbmc_ffdc_list():
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500194 def get_ffdc_bmc_cmd(self, i_type):
195 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500196 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500197 # @brief This method returns the list from the dictionary for cmds
198 # @param i_type: @type string: string index lookup
199 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500200 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500201 """
George Keishing69e6f712016-09-12 06:30:09 -0500202 return FFDC_BMC_CMD[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500203
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500204 def get_ffdc_bmc_file(self, i_type):
205 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500206 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500207 # @brief This method returns the list from the dictionary for scp
208 # @param i_type: @type string: string index lookup
209 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500210 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500211 """
George Keishing69e6f712016-09-12 06:30:09 -0500212 return FFDC_BMC_FILE[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500213
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500214 def get_ffdc_get_request(self, i_type):
215 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500216 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500217 # @brief This method returns the list from the dictionary for scp
218 # @param i_type: @type string: string index lookup
219 # @return List of key pair from the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500220 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500221 """
222 return FFDC_GET_REQUEST[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500223
George Keishing69e6f712016-09-12 06:30:09 -0500224 def get_ffdc_cmd_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500225 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500226 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500227 # @brief This method returns the list index from dictionary
228 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500229 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500230 """
George Keishing69e6f712016-09-12 06:30:09 -0500231 return FFDC_BMC_CMD.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500232
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500233 def get_ffdc_get_request_index(self):
234 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500235 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500236 # @brief This method returns the list index from dictionary
237 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500238 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500239 """
240 return FFDC_GET_REQUEST.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500241
George Keishing69e6f712016-09-12 06:30:09 -0500242 def get_ffdc_file_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500243 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500244 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500245 # @brief This method returns the list index from dictionary
246 # @return List of index to the dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500247 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500248 """
George Keishing69e6f712016-09-12 06:30:09 -0500249 return FFDC_BMC_FILE.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500250
George Keishing69e6f712016-09-12 06:30:09 -0500251 def get_ffdc_method_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500252 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500253 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500254 # @brief This method returns the key pair from the dictionary
255 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500256 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500257 """
George Keishing69e6f712016-09-12 06:30:09 -0500258 return FFDC_METHOD_CALL.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500259
Michael Walshe844e9a2017-04-20 16:51:10 -0500260 def get_ffdc_method_desc(self,
261 index):
262 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500263 #######################################################################
Michael Walshe844e9a2017-04-20 16:51:10 -0500264 # @brief This method returns the just the keys from the dictionary.
265 # @return List of ffdc descriptions.
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500266 #######################################################################
Michael Walshe844e9a2017-04-20 16:51:10 -0500267 """
268 return FFDC_METHOD_CALL[index].keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500269
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500270 def get_ffdc_method_call(self, i_type):
271 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500272 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500273 # @brief This method returns the key pair from the dictionary
274 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500275 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500276 """
George Keishing69e6f712016-09-12 06:30:09 -0500277 return FFDC_METHOD_CALL[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500278
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500279 def get_ffdc_os_all_distros_index(self):
280 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500281 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500282 # @brief This method returns the key pair from the dictionary
283 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500284 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500285 """
286 return FFDC_OS_ALL_DISTROS_FILE.keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500287
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500288 def get_ffdc_os_all_distros_call(self, i_type):
289 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500290 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500291 # @brief This method returns the key pair from the dictionary
292 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500293 #######################################################################
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500294 """
295 return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500296
Gunnar Millscce185d2016-10-17 17:04:15 -0500297 def get_ffdc_os_distro_index(self, distro):
298 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500299 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500300 # @brief This method returns the key pair from the dictionary
301 # @return Index of the method dictionary
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500302 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500303 """
304 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
305 return eval(distro_file).keys()
Gunnar Mills096cd562018-03-26 10:19:12 -0500306
Gunnar Millscce185d2016-10-17 17:04:15 -0500307 def get_ffdc_os_distro_call(self, i_type, distro):
308 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500309 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500310 # @brief This method returns the key pair from the dictionary
311 # @return List of key pair keywords
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500312 #######################################################################
Gunnar Millscce185d2016-10-17 17:04:15 -0500313 """
314 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
315 return eval(distro_file)[i_type].items()
Gunnar Mills096cd562018-03-26 10:19:12 -0500316
George Keishing4346a412016-07-19 11:26:49 -0500317 def get_strip_string(self, i_str):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500318 r"""
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500319 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500320 # @brief Returns the stripped strings
321 # @param i_str: @type string: string name
322 # @return Remove all special chars and return the string
Joy Onyerikwu004ad3c2018-06-11 16:29:56 -0500323 #######################################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500324 """
George Keishing4346a412016-07-19 11:26:49 -0500325 return ''.join(e for e in i_str if e.isalnum())
Gunnar Mills096cd562018-03-26 10:19:12 -0500326
George Keishing28da9482017-07-27 13:38:54 -0500327 def get_esel_index(self, esel_list):
328 r"""
329 #######################################################################
330 # @brief Returns the eSEL binary index.
331 # @param esel_ist: @type list: eSEL list.
332 # @return Index of "ESEL=" in the list.
333 #######################################################################
334 """
335 index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
336 return index[0]
Sweta Potthuria82efd62017-10-18 05:34:59 -0500337
338 def get_dump_index(self, dump_list):
339 r"""
340 #######################################################################
341 # @brief Returns the eSEL binary index.
342 # @param esel_ist: @type list: eSEL list.
343 # @return Index of "ESEL=" in the list.
344 #######################################################################
345 """
346 index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str]
347 return index[0]