1#!/usr/bin/env python3
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_complete_list.json': 'peltool -l -a -f >/tmp/PEL_logs_complete_list.json 2>&1',
60        'PEL_logs_display.json': 'peltool -a >/tmp/PEL_logs_display.json 2>&1',
61        'PEL_logs_complete_display.json': 'peltool -a -f -h>/tmp/PEL_logs_complete_display.json 2>&1',
62        'PEL_logs_badPEL.txt': 'hexdump -C'
63        + ' /var/lib/phosphor-logging/extensions/pels/badPEL>/tmp/PEL_logs_badPEL.txt 2>&1',
64        'BMC_pldm_flight_recorder.txt': 'rm -rf /tmp/pldm_flight_recorder; killall -s SIGUSR1 pldmd;'
65        + ' sleep 5; cat /tmp/pldm_flight_recorder > /tmp/BMC_pldm_flight_recorder.txt 2>&1;',
66        'OCC_state.txt': 'for i in {0..3};'
67        + ' do (echo /org/open_power/control/occ$i;'
68        + ' busctl get-property org.open_power.OCC.Control /org/open_power/control/occ$i'
69        + ' org.open_power.OCC.Status OccActive) done > /tmp/OCC_state.txt 2>&1',
70        'bmcweb_persistent_data.json': 'cat /home/root/bmcweb_persistent_data.json'
71        + ' > /tmp/bmcweb_persistent_data.json',
72        'GUARD_list.txt': 'guard -l > /tmp/GUARD_list.txt 2>&1',
73        'fan_control_dump.json': 'fanctl dump; cat /tmp/fan_control_dump.json'
74        + ' /tmp/fan_control_dump.json 2>&1',
75    },
76}
77# Add file name and corresponding command needed for all Linux distributions
78FFDC_OS_ALL_DISTROS_FILE = {
79    'OS FILES':
80    {
81        # File Name         Command
82        'OS_msglog.txt': 'cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt 2>&1',
83        'OS_cpufrequency.txt': 'ppc64_cpu --frequency '
84        + '>/tmp/OS_cpufrequency.txt 2>&1',
85        'OS_dmesg.txt': 'dmesg >/tmp/OS_dmesg.txt 2>&1',
86        'OS_opal_prd.txt': 'cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt 2>&1',
87        'OS_boot.txt': 'cat /var/log/boot.log >/tmp/OS_boot.txt 2>&1',
88        'OS_procinfo.txt': 'cat /proc/cpuinfo >/tmp/OS_procinfo.txt 2>&1',
89        'OS_meminfo.txt': 'cat /proc/meminfo >/tmp/OS_meminfo.txt 2>&1',
90        'OS_netstat.txt': 'netstat -a >/tmp/OS_netstat.txt 2>&1',
91        'OS_lspci.txt': 'lspci >/tmp/OS_lspci.txt 2>&1',
92        'OS_lscpu.txt': 'lscpu >/tmp/OS_lscpu.txt 2>&1',
93        'OS_lscfg.txt': 'lscfg >/tmp/OS_lscfg.txt 2>&1',
94        'OS_journalctl_nopager.txt': 'journalctl --no-pager -b '
95        + '> /tmp/OS_journalctl_nopager.txt  2>&1',
96    },
97}
98# Add file name and corresponding command needed for Ubuntu Linux
99FFDC_OS_UBUNTU_FILE = {
100    'OS FILES':
101    {
102        # File Name         Command
103        'OS_isusb.txt': '{ lsusb -t ; lsusb -v ; } >/tmp/OS_isusb.txt 2>&1',
104        'OS_kern.txt': 'tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt 2>&1',
105        'OS_authlog.txt': '{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } '
106        + '>/tmp/OS_authlog.txt 2>&1',
107        'OS_syslog.txt': 'tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt 2>&1',
108        'OS_info.txt': '{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } '
109        + '>/tmp/OS_info.txt 2>&1',
110        'OS_sosreport.txt': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir '
111        + '/tmp --ticket-number FFDC ; } >/tmp/OS_sosreport.txt 2>&1',
112    },
113}
114# Add file name and corresponding command needed for RHEL Linux
115FFDC_OS_RHEL_FILE = {
116    'OS FILES':
117    {
118        # File Name         Command
119        'OS_rsct.txt': '/usr/bin/ctversion -bv >/tmp/OS_rsct.txt 2>&1',
120        'OS_secure.txt': 'cat /var/log/secure >/tmp/OS_secure.txt 2>&1',
121        'OS_syslog.txt': 'tail -n 200000 /var/log/messages '
122        + '>/tmp/OS_syslog.txt 2>&1',
123        'OS_info.txt': '{ lsb_release -a; cat /etc/redhat-release; '
124        + 'uname -a; rpm -qa ; } >/tmp/OS_info.txt 2>&1',
125        'OS_sosreport.txt': '{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir '
126        + '/tmp --label FFDC ; } >/tmp/OS_sosreport.txt 2>&1',
127    },
128}
129# Add file name and corresponding command needed for AIX.
130FFDC_OS_AIX_FILE = {
131    'OS FILES':
132    {
133        # File Name         Command
134        'OS_errpt.txt': 'errpt >/tmp/OS_errpt.txt 2>&1 ; errclear 0;',
135        'OS_processors.txt': 'bindprocessor -q >/tmp/OS_processors.txt 2>&1',
136    },
137}
138
139try:
140    redfish_support_trans_state = os.environ.get('REDFISH_SUPPORT_TRANS_STATE', 0) or \
141        int(BuiltIn().get_variable_value("${REDFISH_SUPPORT_TRANS_STATE}", default=0))
142except RobotNotRunningError:
143    pass
144
145OPENBMC_BASE = '/xyz/openbmc_project/'
146OPENPOWER_BASE = '/org/open_power/'
147ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
148ENUMERATE_INVENTORY = OPENBMC_BASE + 'inventory/enumerate'
149ENUMERATE_ELOG = OPENBMC_BASE + 'logging/entry/enumerate'
150ENUMERATE_LED = OPENBMC_BASE + 'led/enumerate'
151ENUMERATE_SW = OPENBMC_BASE + 'software/enumerate'
152ENUMERATE_CONTROL = OPENBMC_BASE + 'control/enumerate'
153ENUMERATE_STATE = OPENBMC_BASE + 'state/enumerate'
154ENUMERATE_OCC = OPENPOWER_BASE + '/enumerate'
155ENUMERATE_DUMPS = OPENBMC_BASE + 'dumps/enumerate'
156ENUMERATE_USER = OPENBMC_BASE + 'user/enumerate'
157
158# Add file name and corresponding Get Request
159FFDC_GET_REQUEST = {
160    'GET REQUESTS':
161    {
162        # File Name         Command
163        'FIRMWARE_list.txt': ENUMERATE_SW,
164        'BMC_sensor_list.txt': ENUMERATE_SENSORS,
165        'BMC_control_list.txt': ENUMERATE_CONTROL,
166        'BMC_inventory.txt': ENUMERATE_INVENTORY,
167        'BMC_elog.txt': ENUMERATE_ELOG,
168        'BMC_led.txt': ENUMERATE_LED,
169        'BMC_state.txt': ENUMERATE_STATE,
170        'OCC_state.txt': ENUMERATE_OCC,
171        'BMC_dumps.txt': ENUMERATE_DUMPS,
172        'BMC_USER.txt': ENUMERATE_USER,
173    },
174}
175
176# Remove the REST dictionary elements.
177if redfish_support_trans_state == 1:
178    for key in list(FFDC_GET_REQUEST):
179        del FFDC_GET_REQUEST[key]
180
181REDFISH_BASE = '/redfish/v1/'
182REDFISH_ELOG = REDFISH_BASE + 'Systems/system/LogServices/EventLog/Entries'
183REDFISH_FIRMWARE = REDFISH_BASE + 'UpdateService/FirmwareInventory'
184
185# Add file name and corresponding Get Request
186FFDC_GET_REDFISH_REQUEST = {
187    'GET REQUESTS':
188    {
189        # File Name         Command
190        'BMC_redfish_elog.txt': REDFISH_ELOG,
191    },
192}
193
194# Define your keywords in method/utils and call here
195FFDC_METHOD_CALL = {
196    'BMC LOGS':
197    {
198        # Description               Keyword name
199        'FFDC Generic Report': 'BMC FFDC Manifest',
200        'BMC Specific Files': 'BMC FFDC Files',
201        'Get Request FFDC': 'BMC FFDC Get Requests',
202        'Get Redfish Request FFDC': 'BMC FFDC Get Redfish Requests',
203        'OS FFDC': 'OS FFDC Files',
204        'Core Files': 'SCP Coredump Files',
205        'SEL Log': 'Collect eSEL Log',
206        'Sys Inventory Files': 'System Inventory Files',
207        'Dump Log': 'Collect Dump Log',
208        'Dump Files': 'SCP Dump Files',
209        'Dump HB Files': 'SCP Dump HB Files',
210        'PEL Files': 'Collect PEL Log',
211        'Redfish Log': 'Enumerate Redfish Resources',
212        'Firmware Log': 'Enumerate Redfish Resources  '
213        + ' enum_uri=/redfish/v1/UpdateService/FirmwareInventory  '
214        + ' file_enum_name=redfish_FIRMWARE_list.txt',
215        'Redfish OEM Log': 'Enumerate Redfish OEM Resources',
216    },
217}
218
219try:
220    platform_arch_type = os.environ.get('PLATFORM_ARCH_TYPE', '') or \
221        BuiltIn().get_variable_value("${PLATFORM_ARCH_TYPE}", default="power")
222except RobotNotRunningError:
223    pass
224
225# Filter the logs based on platform type.
226if platform_arch_type == "x86":
227    del FFDC_BMC_FILE['BMC FILES']['PEL_logs_list.json']
228    del FFDC_BMC_FILE['BMC FILES']['PEL_logs_display.json']
229    del FFDC_METHOD_CALL['BMC LOGS']['PEL Files']
230
231# -----------------------------------------------------------------
232# base class for FFDC default list
233
234
235class openbmc_ffdc_list():
236    def get_ffdc_bmc_cmd(self, i_type):
237        r"""
238        #######################################################################
239        #   @brief    This method returns the list from the dictionary for cmds
240        #   @param    i_type: @type string: string index lookup
241        #   @return   List of key pair from the dictionary
242        #######################################################################
243        """
244        return FFDC_BMC_CMD[i_type].items()
245
246    def get_ffdc_bmc_file(self, i_type):
247        r"""
248        #######################################################################
249        #   @brief    This method returns the list from the dictionary for scp
250        #   @param    i_type: @type string: string index lookup
251        #   @return   List of key pair from the dictionary
252        #######################################################################
253        """
254        return FFDC_BMC_FILE[i_type].items()
255
256    def get_ffdc_get_request(self, i_type):
257        r"""
258        #######################################################################
259        #   @brief    This method returns the list from the dictionary for scp
260        #   @param    i_type: @type string: string index lookup
261        #   @return   List of key pair from the dictionary
262        #######################################################################
263        """
264        return FFDC_GET_REQUEST[i_type].items()
265
266    def get_ffdc_get_redfish_request(self, i_type):
267        r"""
268        #######################################################################
269        #   @brief    This method returns the list from the dictionary for scp
270        #   @param    i_type: @type string: string index lookup
271        #   @return   List of key pair from the dictionary
272        #######################################################################
273        """
274        return FFDC_GET_REDFISH_REQUEST[i_type].items()
275
276    def get_ffdc_cmd_index(self):
277        r"""
278        #######################################################################
279        #   @brief    This method returns the list index from dictionary
280        #   @return   List of index to the dictionary
281        #######################################################################
282        """
283        return FFDC_BMC_CMD.keys()
284
285    def get_ffdc_get_request_index(self):
286        r"""
287        #######################################################################
288        #   @brief    This method returns the list index from dictionary
289        #   @return   List of index to the dictionary
290        #######################################################################
291        """
292        return FFDC_GET_REQUEST.keys()
293
294    def get_ffdc_get_redfish_request_index(self):
295        r"""
296        #######################################################################
297        #   @brief    This method returns the list index from dictionary
298        #   @return   List of index to the dictionary
299        #######################################################################
300        """
301        return FFDC_GET_REDFISH_REQUEST.keys()
302
303    def get_ffdc_file_index(self):
304        r"""
305        #######################################################################
306        #   @brief    This method returns the list index from dictionary
307        #   @return   List of index to the dictionary
308        #######################################################################
309        """
310        return FFDC_BMC_FILE.keys()
311
312    def get_ffdc_method_index(self):
313        r"""
314        #######################################################################
315        #   @brief    This method returns the key pair from the dictionary
316        #   @return   Index of the method dictionary
317        #######################################################################
318        """
319        return FFDC_METHOD_CALL.keys()
320
321    def get_ffdc_method_desc(self,
322                             index):
323        r"""
324        #######################################################################
325        #   @brief   This method returns the just the keys from the dictionary.
326        #   @return  List of ffdc descriptions.
327        #######################################################################
328        """
329        return FFDC_METHOD_CALL[index].keys()
330
331    def get_ffdc_method_call(self, i_type):
332        r"""
333        #######################################################################
334        #   @brief    This method returns the key pair from the dictionary
335        #   @return   List of key pair keywords
336        #######################################################################
337        """
338        return FFDC_METHOD_CALL[i_type].items()
339
340    def get_ffdc_os_all_distros_index(self):
341        r"""
342        #######################################################################
343        #   @brief    This method returns the key pair from the dictionary
344        #   @return   Index of the method dictionary
345        #######################################################################
346        """
347        return FFDC_OS_ALL_DISTROS_FILE.keys()
348
349    def get_ffdc_os_all_distros_call(self, i_type):
350        r"""
351        #######################################################################
352        #   @brief    This method returns the key pair from the dictionary
353        #   @return   List of key pair keywords
354        #######################################################################
355        """
356        return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
357
358    def get_ffdc_os_distro_index(self, distro):
359        r"""
360        #######################################################################
361        #   @brief    This method returns the key pair from the dictionary
362        #   @return   Index of the method dictionary
363        #######################################################################
364        """
365        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
366        return eval(distro_file).keys()
367
368    def get_ffdc_os_distro_call(self, i_type, distro):
369        r"""
370        #######################################################################
371        #   @brief    This method returns the key pair from the dictionary
372        #   @return   List of key pair keywords
373        #######################################################################
374        """
375        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
376        return eval(distro_file)[i_type].items()
377
378    def get_strip_string(self, i_str):
379        r"""
380        #######################################################################
381        #   @brief    Returns the stripped strings
382        #   @param    i_str: @type string: string name
383        #   @return   Remove all special chars and return the string
384        #######################################################################
385        """
386        return ''.join(e for e in i_str if e.isalnum())
387
388    def get_esel_index(self, esel_list):
389        r"""
390        #######################################################################
391        #   @brief    Returns the eSEL binary index.
392        #   @param    esel_ist: @type list: eSEL list.
393        #   @return   Index of "ESEL=" in the list.
394        #######################################################################
395        """
396        index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
397        return index[0]
398
399    def get_dump_index(self, dump_list):
400        r"""
401        #######################################################################
402        #   @brief    Returns the eSEL binary index.
403        #   @param    esel_ist: @type list: eSEL list.
404        #   @return   Index of "ESEL=" in the list.
405        #######################################################################
406        """
407        index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str]
408        return index[0]
409