blob: 896ac1df5735bbc4381b94a44a4e1802deace13f [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#############################################################
4# @file openbmc_ffdc_list.py
George Keishing4346a412016-07-19 11:26:49 -05005#
6# @brief List for FFDC ( First failure data capture )
7# commands and files to be collected as a part
8# of the test case failure.
9#############################################################
Gunnar Millsa812e0f2016-09-29 20:30:03 -050010"""
George Keishing4346a412016-07-19 11:26:49 -050011
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# -------------------
George Keishing4346a412016-07-19 11:26:49 -050015
Gunnar Millsa812e0f2016-09-29 20:30:03 -050016# -----------------------------------------------------------------
17# Dict Name { Index string : { Key String : Comand string} }
18# -----------------------------------------------------------------
George Keishing69e6f712016-09-12 06:30:09 -050019# Add cmd's needed to be part of the ffdc report manifest file
20FFDC_BMC_CMD = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -050021 'DRIVER INFO':
22 {
23 # String Name Command
Gunnar Millsa812e0f2016-09-29 20:30:03 -050024 'FW Level': 'cat /etc/os-release',
25 },
26 'BMC DATA':
27 {
28 'BMC OS': 'uname -a',
29 'BMC Uptime': 'uptime',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050030 'BMC File System Disk Space Usage': 'df -hT',
31 },
32 'APPLICATION DATA':
33 {
Michael Walshe53e47a2017-06-30 17:03:24 -050034 'BMC state': '/usr/sbin/obmcutil state',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050035 },
36}
George Keishing4346a412016-07-19 11:26:49 -050037
George Keishing69e6f712016-09-12 06:30:09 -050038# Add file name and correcponding command needed for BMC
39FFDC_BMC_FILE = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -050040 'BMC FILES':
41 {
42 # File Name Command
43 'BMC_proc_list': 'top -n 1 -b',
George Keishing158a76c2017-07-18 00:53:37 -050044 'BMC_proc_fd_active_list': 'ls -Al /proc/*/fd/',
Gunnar Millsaca140d2016-10-26 13:05:10 -050045 'BMC_journalctl': 'journalctl --no-pager',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050046 'BMC_dmesg': 'dmesg',
Gunnar Millsaca140d2016-10-26 13:05:10 -050047 'BMC_procinfo': 'cat /proc/cpuinfo',
48 'BMC_meminfo': 'cat /proc/meminfo',
Gunnar Millsa812e0f2016-09-29 20:30:03 -050049 },
50}
51
Gunnar Mills7e2cda22016-10-11 15:37:34 -050052# Add file name and correcponding command needed for all Linux distributions
53FFDC_OS_ALL_DISTROS_FILE = {
54 'OS FILES':
55 {
56 # File Name Command
57 'OS_msglog': 'cat /sys/firmware/opal/msglog',
58 'OS_cpufrequency': 'ppc64_cpu --frequency',
59 'OS_dmesg': 'dmesg',
60 'OS_boot': 'cat /var/log/boot.log',
Gunnar Millsaca140d2016-10-26 13:05:10 -050061 'OS_procinfo': 'cat /proc/cpuinfo',
62 'OS_meminfo': 'cat /proc/meminfo',
63 'OS_netstat': 'netstat -a',
Gunnar Mills7e2cda22016-10-11 15:37:34 -050064 },
65}
66
Gunnar Millscce185d2016-10-17 17:04:15 -050067# Add file name and correcponding command needed for Ubuntu Linux
68FFDC_OS_UBUNTU_FILE = {
69 'OS FILES':
70 {
71 # File Name Command
72 'OS_isusb': 'lsusb -t ; lsusb -v',
73 'OS_kern': 'tail -n 50000 /var/log/kern.log',
74 'OS_authlog': 'cat /var/log/auth.log; cat /var/log/auth.log.1',
75 'OS_syslog': 'tail -n 200000 /var/log/syslog',
76 'OS_info': 'uname -a; dpkg -s opal-prd; dpkg -s ipmitool',
77 },
78}
79
80# Add file name and correcponding command needed for RHEL Linux
81FFDC_OS_RHEL_FILE = {
82 'OS FILES':
83 {
84 # File Name Command
85 'OS_rsct': '/usr/bin/ctversion -bv',
86 'OS_secure': 'cat /var/log/secure',
87 'OS_syslog': 'tail -n 200000 /var/log/messages',
88 'OS_info': 'lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa',
89 },
90}
91
92# Add file name and correcponding command needed for RHEL Linux
93FFDC_OS_IBM_POWERKVM_FILE = {
94 'OS FILES':
95 {
96 # File Name Command
97 'OS_secure': 'cat /var/log/secure',
98 'OS_syslog': 'tail -n 200000 /var/log/messages',
99 'OS_info': 'lsb_release -a; uname -a; rpm -qa',
100 },
101}
102
George Keishing136bcc62016-11-23 08:34:16 -0600103# Enable when ready with openbmc/openbmc-test-automation#203
104# replace with new path /xyz/openbmc_project
105OPENBMC_BASE = '/org/openbmc/'
George Keishingfe5724d2016-11-23 09:25:36 -0600106ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
George Keishing7f7040c2017-02-20 10:23:56 -0600107# TODO: Use the xyz enums once moved to xyz completely
108# ENUMERATE_SYSTEMS = OPENBMC_BASE + 'inventory/enumerate'
George Keishingc06fc992017-02-22 09:01:08 -0600109ENUMERATE_SYSTEMS = '/xyz/openbmc_project/inventory/enumerate'
110ENUMERATE_ELOG = '/xyz/openbmc_project/logging/entry/enumerate'
George Keishingfe5724d2016-11-23 09:25:36 -0600111ENUMERATE_EVENTS = OPENBMC_BASE + 'records/events/enumerate'
112ENUMERATE_LED = OPENBMC_BASE + 'control/led/enumerate'
113
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500114# Add file name and correcponding Get Request
115FFDC_GET_REQUEST = {
116 'GET REQUESTS':
117 {
118 # File Name Command
George Keishingfe5724d2016-11-23 09:25:36 -0600119 'BMC_sensor_list': ENUMERATE_SENSORS,
120 'BMC_inventory': ENUMERATE_SYSTEMS,
George Keishingc06fc992017-02-22 09:01:08 -0600121 'BMC_elog': ENUMERATE_ELOG,
George Keishingfe5724d2016-11-23 09:25:36 -0600122 'BMC_led': ENUMERATE_EVENTS,
123 'BMC_record_log': ENUMERATE_LED,
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500124 },
125}
126
George Keishing69e6f712016-09-12 06:30:09 -0500127
128# Define your keywords in method/utils and call here
129FFDC_METHOD_CALL = {
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500130 'BMC LOGS':
131 {
132 # Description Keyword name
133 'FFDC Generic Report': 'BMC FFDC Manifest',
134 'BMC Specific Files': 'BMC FFDC Files',
135 'Get Request FFDC': 'BMC FFDC Get Requests',
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500136 'OS FFDC': 'OS FFDC Files',
George Keishing7a520222017-02-27 09:44:30 -0600137 'Core Files': 'SCP Coredump Files',
George Keishingeb7b4bc2017-03-13 12:04:28 -0500138 'SEL Log': 'Collect eSEL Log',
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500139 },
140}
George Keishing4346a412016-07-19 11:26:49 -0500141
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500142# -----------------------------------------------------------------
George Keishing4346a412016-07-19 11:26:49 -0500143
144
145# base class for FFDC default list
146class openbmc_ffdc_list():
147
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500148 def get_ffdc_bmc_cmd(self, i_type):
149 r"""
150 ########################################################################
151 # @brief This method returns the list from the dictionary for cmds
152 # @param i_type: @type string: string index lookup
153 # @return List of key pair from the dictionary
154 ########################################################################
155 """
George Keishing69e6f712016-09-12 06:30:09 -0500156 return FFDC_BMC_CMD[i_type].items()
George Keishing4346a412016-07-19 11:26:49 -0500157
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500158 def get_ffdc_bmc_file(self, i_type):
159 r"""
160 ########################################################################
161 # @brief This method returns the list from the dictionary for scp
162 # @param i_type: @type string: string index lookup
163 # @return List of key pair from the dictionary
164 ########################################################################
165 """
George Keishing69e6f712016-09-12 06:30:09 -0500166 return FFDC_BMC_FILE[i_type].items()
George Keishing4346a412016-07-19 11:26:49 -0500167
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500168 def get_ffdc_get_request(self, i_type):
169 r"""
170 ########################################################################
171 # @brief This method returns the list from the dictionary for scp
172 # @param i_type: @type string: string index lookup
173 # @return List of key pair from the dictionary
174 ########################################################################
175 """
176 return FFDC_GET_REQUEST[i_type].items()
177
George Keishing69e6f712016-09-12 06:30:09 -0500178 def get_ffdc_cmd_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500179 r"""
180 ########################################################################
181 # @brief This method returns the list index from dictionary
182 # @return List of index to the dictionary
183 ########################################################################
184 """
George Keishing69e6f712016-09-12 06:30:09 -0500185 return FFDC_BMC_CMD.keys()
186
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500187 def get_ffdc_get_request_index(self):
188 r"""
189 ########################################################################
190 # @brief This method returns the list index from dictionary
191 # @return List of index to the dictionary
192 ########################################################################
193 """
194 return FFDC_GET_REQUEST.keys()
195
George Keishing69e6f712016-09-12 06:30:09 -0500196 def get_ffdc_file_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500197 r"""
198 ########################################################################
199 # @brief This method returns the list index from dictionary
200 # @return List of index to the dictionary
201 ########################################################################
202 """
George Keishing69e6f712016-09-12 06:30:09 -0500203 return FFDC_BMC_FILE.keys()
204
George Keishing69e6f712016-09-12 06:30:09 -0500205 def get_ffdc_method_index(self):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500206 r"""
207 ########################################################################
208 # @brief This method returns the key pair from the dictionary
209 # @return Index of the method dictionary
210 ########################################################################
211 """
George Keishing69e6f712016-09-12 06:30:09 -0500212 return FFDC_METHOD_CALL.keys()
213
Michael Walshe844e9a2017-04-20 16:51:10 -0500214 def get_ffdc_method_desc(self,
215 index):
216 r"""
217 ########################################################################
218 # @brief This method returns the just the keys from the dictionary.
219 # @return List of ffdc descriptions.
220 ########################################################################
221 """
222 return FFDC_METHOD_CALL[index].keys()
223
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500224 def get_ffdc_method_call(self, i_type):
225 r"""
226 ########################################################################
227 # @brief This method returns the key pair from the dictionary
228 # @return List of key pair keywords
229 ########################################################################
230 """
George Keishing69e6f712016-09-12 06:30:09 -0500231 return FFDC_METHOD_CALL[i_type].items()
George Keishing4346a412016-07-19 11:26:49 -0500232
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500233 def get_ffdc_os_all_distros_index(self):
234 r"""
235 ########################################################################
236 # @brief This method returns the key pair from the dictionary
237 # @return Index of the method dictionary
238 ########################################################################
239 """
240 return FFDC_OS_ALL_DISTROS_FILE.keys()
241
242 def get_ffdc_os_all_distros_call(self, i_type):
243 r"""
244 ########################################################################
245 # @brief This method returns the key pair from the dictionary
246 # @return List of key pair keywords
247 ########################################################################
248 """
249 return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
250
Gunnar Millscce185d2016-10-17 17:04:15 -0500251 def get_ffdc_os_distro_index(self, distro):
252 r"""
253 ########################################################################
254 # @brief This method returns the key pair from the dictionary
255 # @return Index of the method dictionary
256 ########################################################################
257 """
258 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
259 return eval(distro_file).keys()
260
261 def get_ffdc_os_distro_call(self, i_type, distro):
262 r"""
263 ########################################################################
264 # @brief This method returns the key pair from the dictionary
265 # @return List of key pair keywords
266 ########################################################################
267 """
268 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
269 return eval(distro_file)[i_type].items()
270
George Keishing4346a412016-07-19 11:26:49 -0500271 def get_strip_string(self, i_str):
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500272 r"""
273 ########################################################################
274 # @brief Returns the stripped strings
275 # @param i_str: @type string: string name
276 # @return Remove all special chars and return the string
277 ########################################################################
278 """
George Keishing4346a412016-07-19 11:26:49 -0500279 return ''.join(e for e in i_str if e.isalnum())