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