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_boot': 'cat /var/log/boot.log',
58        'OS_procinfo': 'cat /proc/cpuinfo',
59        'OS_meminfo': 'cat /proc/meminfo',
60        'OS_netstat': 'netstat -a',
61        'OS_lspci': 'lspci',
62        'OS_lscpu': 'lscpu',
63        'OS_lscfg': 'lscfg',
64    },
65}
66# Add file name and correcponding command needed for Ubuntu Linux
67FFDC_OS_UBUNTU_FILE = {
68    'OS FILES':
69    {
70        # File Name         Command
71        'OS_isusb': 'lsusb -t ; lsusb -v',
72        'OS_kern': 'tail -n 50000 /var/log/kern.log',
73        'OS_authlog': 'cat /var/log/auth.log; cat /var/log/auth.log.1',
74        'OS_syslog': 'tail -n 200000 /var/log/syslog',
75        'OS_info': 'uname -a; dpkg -s opal-prd; dpkg -s ipmitool',
76    },
77}
78# Add file name and correcponding command needed for RHEL Linux
79FFDC_OS_RHEL_FILE = {
80    'OS FILES':
81    {
82        # File Name         Command
83        'OS_rsct': '/usr/bin/ctversion -bv',
84        'OS_secure': 'cat /var/log/secure',
85        'OS_syslog': 'tail -n 200000 /var/log/messages',
86        'OS_info': 'lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa',
87    },
88}
89# Add file name and correcponding command needed for RHEL Linux
90FFDC_OS_IBM_POWERKVM_FILE = {
91    'OS FILES':
92    {
93        # File Name         Command
94        'OS_secure': 'cat /var/log/secure',
95        'OS_syslog': 'tail -n 200000 /var/log/messages',
96        'OS_info': 'lsb_release -a; uname -a; rpm -qa',
97    },
98}
99OPENBMC_BASE = '/xyz/openbmc_project/'
100OPENPOWER_BASE = '/org/open_power/'
101ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
102ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate'
103ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate'
104ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate'
105ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate'
106ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate'
107ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
108ENUMERATE_OCC = OPENPOWER_BASE + 'control/enumerate'
109ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
110
111# Add file name and correcponding Get Request
112FFDC_GET_REQUEST = {
113    'GET REQUESTS':
114    {
115        # File Name         Command
116        'FIRMWARE_list': ENUMERATE_SW,
117        'BMC_sensor_list': ENUMERATE_SENSORS,
118        'BMC_control_list': ENUMERATE_CONTROL,
119        'BMC_inventory': ENUMERATE_INVENTORY,
120        'BMC_elog': ENUMERATE_ELOG,
121        'BMC_led': ENUMERATE_LED,
122        'BMC_state': ENUMERATE_STATE,
123        'OCC_state': ENUMERATE_OCC,
124        'BMC_dumps': ENUMERATE_DUMPS,
125    },
126}
127# Define your keywords in method/utils and call here
128FFDC_METHOD_CALL = {
129    'BMC LOGS':
130    {
131        # Description             Keyword name
132        'FFDC Generic Report': 'BMC FFDC Manifest',
133        'BMC Specific Files': 'BMC FFDC Files',
134        'Get Request FFDC': 'BMC FFDC Get Requests',
135        'OS FFDC': 'OS FFDC Files',
136        'Core Files': 'SCP Coredump Files',
137        'SEL Log': 'Collect eSEL Log',
138        'Sys Inventory Files': 'System Inventory Files',
139        'Dump Log': 'Collect Dump Log',
140        'Dump Files': 'SCP Dump Files'
141    },
142}
143# -----------------------------------------------------------------
144# base class for FFDC default list
145class openbmc_ffdc_list():
146    def get_ffdc_bmc_cmd(self, i_type):
147        r"""
148        ########################################################################
149        #   @brief    This method returns the list from the dictionary for cmds
150        #   @param    i_type: @type string: string index lookup
151        #   @return   List of key pair from the dictionary
152        ########################################################################
153        """
154        return FFDC_BMC_CMD[i_type].items()
155    def get_ffdc_bmc_file(self, i_type):
156        r"""
157        ########################################################################
158        #   @brief    This method returns the list from the dictionary for scp
159        #   @param    i_type: @type string: string index lookup
160        #   @return   List of key pair from the dictionary
161        ########################################################################
162        """
163        return FFDC_BMC_FILE[i_type].items()
164    def get_ffdc_get_request(self, i_type):
165        r"""
166        ########################################################################
167        #   @brief    This method returns the list from the dictionary for scp
168        #   @param    i_type: @type string: string index lookup
169        #   @return   List of key pair from the dictionary
170        ########################################################################
171        """
172        return FFDC_GET_REQUEST[i_type].items()
173    def get_ffdc_cmd_index(self):
174        r"""
175        ########################################################################
176        #   @brief    This method returns the list index from dictionary
177        #   @return   List of index to the dictionary
178        ########################################################################
179        """
180        return FFDC_BMC_CMD.keys()
181    def get_ffdc_get_request_index(self):
182        r"""
183        ########################################################################
184        #   @brief    This method returns the list index from dictionary
185        #   @return   List of index to the dictionary
186        ########################################################################
187        """
188        return FFDC_GET_REQUEST.keys()
189    def get_ffdc_file_index(self):
190        r"""
191        ########################################################################
192        #   @brief    This method returns the list index from dictionary
193        #   @return   List of index to the dictionary
194        ########################################################################
195        """
196        return FFDC_BMC_FILE.keys()
197    def get_ffdc_method_index(self):
198        r"""
199        ########################################################################
200        #   @brief    This method returns the key pair from the dictionary
201        #   @return   Index of the method dictionary
202        ########################################################################
203        """
204        return FFDC_METHOD_CALL.keys()
205    def get_ffdc_method_desc(self,
206                             index):
207        r"""
208        ########################################################################
209        #   @brief   This method returns the just the keys from the dictionary.
210        #   @return  List of ffdc descriptions.
211        ########################################################################
212        """
213        return FFDC_METHOD_CALL[index].keys()
214    def get_ffdc_method_call(self, i_type):
215        r"""
216        ########################################################################
217        #   @brief    This method returns the key pair from the dictionary
218        #   @return   List of key pair keywords
219        ########################################################################
220        """
221        return FFDC_METHOD_CALL[i_type].items()
222    def get_ffdc_os_all_distros_index(self):
223        r"""
224        ########################################################################
225        #   @brief    This method returns the key pair from the dictionary
226        #   @return   Index of the method dictionary
227        ########################################################################
228        """
229        return FFDC_OS_ALL_DISTROS_FILE.keys()
230    def get_ffdc_os_all_distros_call(self, i_type):
231        r"""
232        ########################################################################
233        #   @brief    This method returns the key pair from the dictionary
234        #   @return   List of key pair keywords
235        ########################################################################
236        """
237        return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
238    def get_ffdc_os_distro_index(self, distro):
239        r"""
240        ########################################################################
241        #   @brief    This method returns the key pair from the dictionary
242        #   @return   Index of the method dictionary
243        ########################################################################
244        """
245        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
246        return eval(distro_file).keys()
247    def get_ffdc_os_distro_call(self, i_type, distro):
248        r"""
249        ########################################################################
250        #   @brief    This method returns the key pair from the dictionary
251        #   @return   List of key pair keywords
252        ########################################################################
253        """
254        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
255        return eval(distro_file)[i_type].items()
256    def get_strip_string(self, i_str):
257        r"""
258        ########################################################################
259        #   @brief    Returns the stripped strings
260        #   @param    i_str: @type string: string name
261        #   @return   Remove all special chars and return the string
262        ########################################################################
263        """
264        return ''.join(e for e in i_str if e.isalnum())
265    def get_esel_index(self, esel_list):
266        r"""
267        #######################################################################
268        #   @brief    Returns the eSEL binary index.
269        #   @param    esel_ist: @type list: eSEL list.
270        #   @return   Index of "ESEL=" in the list.
271        #######################################################################
272        """
273        index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
274        return index[0]
275
276    def get_dump_index(self, dump_list):
277        r"""
278        #######################################################################
279        #   @brief    Returns the eSEL binary index.
280        #   @param    esel_ist: @type list: eSEL list.
281        #   @return   Index of "ESEL=" in the list.
282        #######################################################################
283        """
284        index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str]
285        return index[0]
286
287