1#!/usr/bin/python
2r"""
3#    @file     openbmc_ffdc_list.py
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.
7"""
8# -------------------
9# FFDC default list
10# -------------------
11# -----------------------------------------------------------------
12# Dict Name {  Index string : { Key String :  Command string} }
13# -----------------------------------------------------------------
14# Add cmd's needed to be part of the ffdc report manifest file
15FFDC_BMC_CMD = {
16    'DRIVER INFO':
17    {
18        # String Name         Command
19        'FW Level': 'cat /etc/os-release',
20        'FW Timestamp': 'cat /etc/timestamp',
21    },
22    'BMC DATA':
23    {
24        'BMC OS': 'uname -a',
25        'BMC Uptime': 'uptime',
26        'BMC File System Disk Space Usage': 'df -hT',
27        'BMC Date Time': 'date;/sbin/hwclock --show;/usr/bin/timedatectl'
28    },
29    'APPLICATION DATA':
30    {
31        'BMC state': '/usr/sbin/obmcutil state',
32    },
33}
34# Add file name and correcponding command needed for BMC
35FFDC_BMC_FILE = {
36    'BMC FILES':
37    {
38        # File Name         Command
39        'BMC_proc_list': 'top -n 1 -b',
40        'BMC_proc_fd_active_list': 'ls -Al /proc/*/fd/',
41        'BMC_journalctl_nopager': 'journalctl --no-pager',
42        'BMC_journalctl_pretty': 'journalctl -o json-pretty',
43        'BMC_dmesg': 'dmesg',
44        'BMC_procinfo': 'cat /proc/cpuinfo',
45        'BMC_meminfo': 'cat /proc/meminfo',
46        'BMC_systemd': 'systemctl status --all',
47    },
48}
49# Add file name and correcponding command needed for all Linux distributions
50FFDC_OS_ALL_DISTROS_FILE = {
51    'OS FILES':
52    {
53        # File Name         Command
54        'OS_msglog': 'cat /sys/firmware/opal/msglog',
55        'OS_cpufrequency': 'ppc64_cpu --frequency',
56        'OS_dmesg': 'dmesg',
57        'OS_opal_prd': 'cat /var/log/opal-prd*',
58        'OS_boot': 'cat /var/log/boot.log',
59        'OS_procinfo': 'cat /proc/cpuinfo',
60        'OS_meminfo': 'cat /proc/meminfo',
61        'OS_netstat': 'netstat -a',
62        'OS_lspci': 'lspci',
63        'OS_lscpu': 'lscpu',
64        'OS_lscfg': 'lscfg',
65    },
66}
67# 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# Add file name and correcponding command needed for RHEL Linux
80FFDC_OS_RHEL_FILE = {
81    'OS FILES':
82    {
83        # File Name         Command
84        'OS_rsct': '/usr/bin/ctversion -bv',
85        'OS_secure': 'cat /var/log/secure',
86        'OS_syslog': 'tail -n 200000 /var/log/messages',
87        'OS_info': 'lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa',
88    },
89}
90# Add file name and correcponding command needed for RHEL Linux
91FFDC_OS_IBM_POWERKVM_FILE = {
92    'OS FILES':
93    {
94        # File Name         Command
95        'OS_secure': 'cat /var/log/secure',
96        'OS_syslog': 'tail -n 200000 /var/log/messages',
97        'OS_info': 'lsb_release -a; uname -a; rpm -qa',
98    },
99}
100OPENBMC_BASE = '/xyz/openbmc_project/'
101OPENPOWER_BASE = '/org/open_power/'
102ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
103ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate'
104ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate'
105ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate'
106ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate'
107ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate'
108ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
109ENUMERATE_OCC = OPENPOWER_BASE + 'control/enumerate'
110ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
111
112# Add file name and correcponding Get Request
113FFDC_GET_REQUEST = {
114    'GET REQUESTS':
115    {
116        # File Name         Command
117        'FIRMWARE_list': ENUMERATE_SW,
118        'BMC_sensor_list': ENUMERATE_SENSORS,
119        'BMC_control_list': ENUMERATE_CONTROL,
120        'BMC_inventory': ENUMERATE_INVENTORY,
121        'BMC_elog': ENUMERATE_ELOG,
122        'BMC_led': ENUMERATE_LED,
123        'BMC_state': ENUMERATE_STATE,
124        'OCC_state': ENUMERATE_OCC,
125        'BMC_dumps': ENUMERATE_DUMPS,
126    },
127}
128# Define your keywords in method/utils and call here
129FFDC_METHOD_CALL = {
130    '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',
136        'OS FFDC': 'OS FFDC Files',
137        'Core Files': 'SCP Coredump Files',
138        'SEL Log': 'Collect eSEL Log',
139        'Sys Inventory Files': 'System Inventory Files',
140        'Dump Log': 'Collect Dump Log',
141        'Dump Files': 'SCP Dump Files'
142    },
143}
144# -----------------------------------------------------------------
145# base class for FFDC default list
146
147
148class openbmc_ffdc_list():
149    def get_ffdc_bmc_cmd(self, i_type):
150        r"""
151        ########################################################################
152        #   @brief    This method returns the list from the dictionary for cmds
153        #   @param    i_type: @type string: string index lookup
154        #   @return   List of key pair from the dictionary
155        ########################################################################
156        """
157        return FFDC_BMC_CMD[i_type].items()
158
159    def get_ffdc_bmc_file(self, i_type):
160        r"""
161        ########################################################################
162        #   @brief    This method returns the list from the dictionary for scp
163        #   @param    i_type: @type string: string index lookup
164        #   @return   List of key pair from the dictionary
165        ########################################################################
166        """
167        return FFDC_BMC_FILE[i_type].items()
168
169    def get_ffdc_get_request(self, i_type):
170        r"""
171        ########################################################################
172        #   @brief    This method returns the list from the dictionary for scp
173        #   @param    i_type: @type string: string index lookup
174        #   @return   List of key pair from the dictionary
175        ########################################################################
176        """
177        return FFDC_GET_REQUEST[i_type].items()
178
179    def get_ffdc_cmd_index(self):
180        r"""
181        ########################################################################
182        #   @brief    This method returns the list index from dictionary
183        #   @return   List of index to the dictionary
184        ########################################################################
185        """
186        return FFDC_BMC_CMD.keys()
187
188    def get_ffdc_get_request_index(self):
189        r"""
190        ########################################################################
191        #   @brief    This method returns the list index from dictionary
192        #   @return   List of index to the dictionary
193        ########################################################################
194        """
195        return FFDC_GET_REQUEST.keys()
196
197    def get_ffdc_file_index(self):
198        r"""
199        ########################################################################
200        #   @brief    This method returns the list index from dictionary
201        #   @return   List of index to the dictionary
202        ########################################################################
203        """
204        return FFDC_BMC_FILE.keys()
205
206    def get_ffdc_method_index(self):
207        r"""
208        ########################################################################
209        #   @brief    This method returns the key pair from the dictionary
210        #   @return   Index of the method dictionary
211        ########################################################################
212        """
213        return FFDC_METHOD_CALL.keys()
214
215    def get_ffdc_method_desc(self,
216                             index):
217        r"""
218        ########################################################################
219        #   @brief   This method returns the just the keys from the dictionary.
220        #   @return  List of ffdc descriptions.
221        ########################################################################
222        """
223        return FFDC_METHOD_CALL[index].keys()
224
225    def get_ffdc_method_call(self, i_type):
226        r"""
227        ########################################################################
228        #   @brief    This method returns the key pair from the dictionary
229        #   @return   List of key pair keywords
230        ########################################################################
231        """
232        return FFDC_METHOD_CALL[i_type].items()
233
234    def get_ffdc_os_all_distros_index(self):
235        r"""
236        ########################################################################
237        #   @brief    This method returns the key pair from the dictionary
238        #   @return   Index of the method dictionary
239        ########################################################################
240        """
241        return FFDC_OS_ALL_DISTROS_FILE.keys()
242
243    def get_ffdc_os_all_distros_call(self, i_type):
244        r"""
245        ########################################################################
246        #   @brief    This method returns the key pair from the dictionary
247        #   @return   List of key pair keywords
248        ########################################################################
249        """
250        return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
251
252    def get_ffdc_os_distro_index(self, distro):
253        r"""
254        ########################################################################
255        #   @brief    This method returns the key pair from the dictionary
256        #   @return   Index of the method dictionary
257        ########################################################################
258        """
259        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
260        return eval(distro_file).keys()
261
262    def get_ffdc_os_distro_call(self, i_type, distro):
263        r"""
264        ########################################################################
265        #   @brief    This method returns the key pair from the dictionary
266        #   @return   List of key pair keywords
267        ########################################################################
268        """
269        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
270        return eval(distro_file)[i_type].items()
271
272    def get_strip_string(self, i_str):
273        r"""
274        ########################################################################
275        #   @brief    Returns the stripped strings
276        #   @param    i_str: @type string: string name
277        #   @return   Remove all special chars and return the string
278        ########################################################################
279        """
280        return ''.join(e for e in i_str if e.isalnum())
281
282    def get_esel_index(self, esel_list):
283        r"""
284        #######################################################################
285        #   @brief    Returns the eSEL binary index.
286        #   @param    esel_ist: @type list: eSEL list.
287        #   @return   Index of "ESEL=" in the list.
288        #######################################################################
289        """
290        index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
291        return index[0]
292
293    def get_dump_index(self, dump_list):
294        r"""
295        #######################################################################
296        #   @brief    Returns the eSEL binary index.
297        #   @param    esel_ist: @type list: eSEL list.
298        #   @return   Index of "ESEL=" in the list.
299        #######################################################################
300        """
301        index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str]
302        return index[0]
303