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