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        'bmcweb data': 'for f in `find /var/lib/bmcweb/ -name "*.json"`; do (echo $f; cat $f) done',
37    },
38}
39# Add file name and corresponding command needed for BMC
40FFDC_BMC_FILE = {
41    'BMC FILES':
42    {
43        # File Name         Command
44        'BMC_flash_side.txt': 'cat /sys/class/watchdog/watchdog1/bootstatus >/tmp/BMC_flash_side.txt 2>&1',
45        'BMC_hwmon.txt': 'grep -r . /sys/class/hwmon/* >/tmp/BMC_hwmon.txt 2>&1',
46        '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',
54        'BMC_failed_service.txt': 'systemctl list-units --failed >/tmp/BMC_failed_service.txt 2>&1',
55        'BMC_list_service.txt': 'systemctl list-jobs >/tmp/BMC_list_service.txt 2>&1',
56        'BMC_obmc_console.txt': 'cat /var/log/obmc-console.log >/tmp/BMC_obmc_console.txt 2>&1',
57        'BMC_obmc_console1.txt': 'cat /var/log/obmc-console1.log >/tmp/BMC_obmc_console1.txt 2>&1',
58        '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',
60        'pldm_flight_recorder': 'killall -s SIGUSR1 pldmd; sleep 5;',
61    },
62}
63# Add file name and corresponding command needed for all Linux distributions
64FFDC_OS_ALL_DISTROS_FILE = {
65    'OS FILES':
66    {
67        # File Name         Command
68        'OS_msglog.txt': 'cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt 2>&1',
69        'OS_cpufrequency.txt': 'ppc64_cpu --frequency '
70        + '>/tmp/OS_cpufrequency.txt 2>&1',
71        'OS_dmesg.txt': 'dmesg >/tmp/OS_dmesg.txt 2>&1',
72        'OS_opal_prd.txt': 'cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt 2>&1',
73        'OS_boot.txt': 'cat /var/log/boot.log >/tmp/OS_boot.txt 2>&1',
74        'OS_procinfo.txt': 'cat /proc/cpuinfo >/tmp/OS_procinfo.txt 2>&1',
75        'OS_meminfo.txt': 'cat /proc/meminfo >/tmp/OS_meminfo.txt 2>&1',
76        'OS_netstat.txt': 'netstat -a >/tmp/OS_netstat.txt 2>&1',
77        'OS_lspci.txt': 'lspci >/tmp/OS_lspci.txt 2>&1',
78        'OS_lscpu.txt': 'lscpu >/tmp/OS_lscpu.txt 2>&1',
79        'OS_lscfg.txt': 'lscfg >/tmp/OS_lscfg.txt 2>&1',
80        'OS_journalctl_nopager.txt': 'journalctl --no-pager -b '
81        + '> /tmp/OS_journalctl_nopager.txt  2>&1',
82    },
83}
84# Add file name and corresponding command needed for Ubuntu Linux
85FFDC_OS_UBUNTU_FILE = {
86    'OS FILES':
87    {
88        # File Name         Command
89        'OS_isusb.txt': '{ lsusb -t ; lsusb -v ; } >/tmp/OS_isub.txt 2>&1',
90        'OS_kern.txt': 'tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt 2>&1',
91        'OS_authlog.txt': '{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } '
92        + '>/tmp/OS_authlog.txt 2>&1',
93        'OS_syslog.txt': 'tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt 2>&1',
94        'OS_info.txt': '{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } '
95        + '>/tmp/OS_info.txt 2>&1',
96        'OS_sosreport.txt': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir '
97        + '/tmp --ticket-number FFDC ; } >/tmp/OS_sosreport.txt 2>&1',
98    },
99}
100# Add file name and corresponding command needed for RHEL Linux
101FFDC_OS_RHEL_FILE = {
102    'OS FILES':
103    {
104        # File Name         Command
105        'OS_rsct.txt': '/usr/bin/ctversion -bv >/tmp/OS_rsct.txt 2>&1',
106        'OS_secure.txt': 'cat /var/log/secure >/tmp/OS_secure.txt 2>&1',
107        'OS_syslog.txt': 'tail -n 200000 /var/log/messages '
108        + '>/tmp/OS_syslog.txt 2>&1',
109        'OS_info.txt': '{ lsb_release -a; cat /etc/redhat-release; '
110        + 'uname -a; rpm -qa ; } >/tmp/OS_info.txt 2>&1',
111        'OS_sosreport.txt': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir '
112        + '/tmp --label FFDC ; } >/tmp/OS_sosreport.txt 2>&1',
113    },
114}
115# Add file name and corresponding command needed for AIX.
116FFDC_OS_AIX_FILE = {
117    'OS FILES':
118    {
119        # File Name         Command
120        'OS_errpt.txt': 'errpt >/tmp/OS_errpt.txt 2>&1 ; errclear 0;',
121        'OS_processors.txt': 'bindprocessor -q >/tmp/OS_processors.txt 2>&1',
122    },
123}
124
125OPENBMC_BASE = '/xyz/openbmc_project/'
126OPENPOWER_BASE = '/org/open_power/'
127ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
128ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate'
129ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate'
130ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate'
131ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate'
132ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate'
133ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
134ENUMERATE_OCC = OPENPOWER_BASE + '/enumerate'
135ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
136ENUMERATE_USER = OPENBMC_BASE + 'user/enumerate'
137
138# Add file name and corresponding Get Request
139FFDC_GET_REQUEST = {
140    'GET REQUESTS':
141    {
142        # File Name         Command
143        'FIRMWARE_list.txt': ENUMERATE_SW,
144        'BMC_sensor_list.txt': ENUMERATE_SENSORS,
145        'BMC_control_list.txt': ENUMERATE_CONTROL,
146        'BMC_inventory.txt': ENUMERATE_INVENTORY,
147        'BMC_elog.txt': ENUMERATE_ELOG,
148        'BMC_led.txt': ENUMERATE_LED,
149        'BMC_state.txt': ENUMERATE_STATE,
150        'OCC_state.txt': ENUMERATE_OCC,
151        'BMC_dumps.txt': ENUMERATE_DUMPS,
152        'BMC_USER.txt': ENUMERATE_USER,
153    },
154}
155# Define your keywords in method/utils and call here
156FFDC_METHOD_CALL = {
157    'BMC LOGS':
158    {
159        # Description               Keyword name
160        'FFDC Generic Report': 'BMC FFDC Manifest',
161        'BMC Specific Files': 'BMC FFDC Files',
162        'Get Request FFDC': 'BMC FFDC Get Requests',
163        'OS FFDC': 'OS FFDC Files',
164        'Core Files': 'SCP Coredump Files',
165        'SEL Log': 'Collect eSEL Log',
166        'Sys Inventory Files': 'System Inventory Files',
167        'Dump Log': 'Collect Dump Log',
168        'Dump Files': 'SCP Dump Files',
169        'Dump HB Files': 'SCP Dump HB Files',
170        'PEL Files': 'Collect PEL Log',
171        'Redfish Log': 'Enumerate Redfish Resources',
172        'Redfish OEM Log': 'Enumerate Redfish OEM Resources',
173    },
174}
175
176try:
177    platform_arch_type = os.environ.get('PLATFORM_ARCH_TYPE', '') or \
178        BuiltIn().get_variable_value("${PLATFORM_ARCH_TYPE}", default="power")
179except RobotNotRunningError:
180    pass
181
182# Filter the logs based on platform type.
183if platform_arch_type == "x86":
184    del FFDC_BMC_FILE['BMC FILES']['PEL_logs_list.json']
185    del FFDC_BMC_FILE['BMC FILES']['PEL_logs_display.json']
186    del FFDC_METHOD_CALL['BMC LOGS']['PEL Files']
187
188# -----------------------------------------------------------------
189# base class for FFDC default list
190
191
192class openbmc_ffdc_list():
193    def get_ffdc_bmc_cmd(self, i_type):
194        r"""
195        #######################################################################
196        #   @brief    This method returns the list from the dictionary for cmds
197        #   @param    i_type: @type string: string index lookup
198        #   @return   List of key pair from the dictionary
199        #######################################################################
200        """
201        return FFDC_BMC_CMD[i_type].items()
202
203    def get_ffdc_bmc_file(self, i_type):
204        r"""
205        #######################################################################
206        #   @brief    This method returns the list from the dictionary for scp
207        #   @param    i_type: @type string: string index lookup
208        #   @return   List of key pair from the dictionary
209        #######################################################################
210        """
211        return FFDC_BMC_FILE[i_type].items()
212
213    def get_ffdc_get_request(self, i_type):
214        r"""
215        #######################################################################
216        #   @brief    This method returns the list from the dictionary for scp
217        #   @param    i_type: @type string: string index lookup
218        #   @return   List of key pair from the dictionary
219        #######################################################################
220        """
221        return FFDC_GET_REQUEST[i_type].items()
222
223    def get_ffdc_cmd_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_CMD.keys()
231
232    def get_ffdc_get_request_index(self):
233        r"""
234        #######################################################################
235        #   @brief    This method returns the list index from dictionary
236        #   @return   List of index to the dictionary
237        #######################################################################
238        """
239        return FFDC_GET_REQUEST.keys()
240
241    def get_ffdc_file_index(self):
242        r"""
243        #######################################################################
244        #   @brief    This method returns the list index from dictionary
245        #   @return   List of index to the dictionary
246        #######################################################################
247        """
248        return FFDC_BMC_FILE.keys()
249
250    def get_ffdc_method_index(self):
251        r"""
252        #######################################################################
253        #   @brief    This method returns the key pair from the dictionary
254        #   @return   Index of the method dictionary
255        #######################################################################
256        """
257        return FFDC_METHOD_CALL.keys()
258
259    def get_ffdc_method_desc(self,
260                             index):
261        r"""
262        #######################################################################
263        #   @brief   This method returns the just the keys from the dictionary.
264        #   @return  List of ffdc descriptions.
265        #######################################################################
266        """
267        return FFDC_METHOD_CALL[index].keys()
268
269    def get_ffdc_method_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_METHOD_CALL[i_type].items()
277
278    def get_ffdc_os_all_distros_index(self):
279        r"""
280        #######################################################################
281        #   @brief    This method returns the key pair from the dictionary
282        #   @return   Index of the method dictionary
283        #######################################################################
284        """
285        return FFDC_OS_ALL_DISTROS_FILE.keys()
286
287    def get_ffdc_os_all_distros_call(self, i_type):
288        r"""
289        #######################################################################
290        #   @brief    This method returns the key pair from the dictionary
291        #   @return   List of key pair keywords
292        #######################################################################
293        """
294        return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
295
296    def get_ffdc_os_distro_index(self, distro):
297        r"""
298        #######################################################################
299        #   @brief    This method returns the key pair from the dictionary
300        #   @return   Index of the method dictionary
301        #######################################################################
302        """
303        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
304        return eval(distro_file).keys()
305
306    def get_ffdc_os_distro_call(self, i_type, distro):
307        r"""
308        #######################################################################
309        #   @brief    This method returns the key pair from the dictionary
310        #   @return   List of key pair keywords
311        #######################################################################
312        """
313        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
314        return eval(distro_file)[i_type].items()
315
316    def get_strip_string(self, i_str):
317        r"""
318        #######################################################################
319        #   @brief    Returns the stripped strings
320        #   @param    i_str: @type string: string name
321        #   @return   Remove all special chars and return the string
322        #######################################################################
323        """
324        return ''.join(e for e in i_str if e.isalnum())
325
326    def get_esel_index(self, esel_list):
327        r"""
328        #######################################################################
329        #   @brief    Returns the eSEL binary index.
330        #   @param    esel_ist: @type list: eSEL list.
331        #   @return   Index of "ESEL=" in the list.
332        #######################################################################
333        """
334        index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
335        return index[0]
336
337    def get_dump_index(self, dump_list):
338        r"""
339        #######################################################################
340        #   @brief    Returns the eSEL binary index.
341        #   @param    esel_ist: @type list: eSEL list.
342        #   @return   Index of "ESEL=" in the list.
343        #######################################################################
344        """
345        index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str]
346        return index[0]
347