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