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
162try:
163    platform_arch_type = os.environ.get('PLATFORM_ARCH_TYPE', '') or \
164        BuiltIn().get_variable_value("${PLATFORM_ARCH_TYPE}", default="power")
165except RobotNotRunningError:
166    pass
167
168# Filter the logs based on platform type.
169if platform_arch_type == "x86":
170    del FFDC_BMC_FILE['BMC FILES']['PEL_logs_list.json']
171    del FFDC_BMC_FILE['BMC FILES']['PEL_logs_display.json']
172    del FFDC_METHOD_CALL['BMC LOGS']['PEL Files']
173
174# -----------------------------------------------------------------
175# base class for FFDC default list
176
177
178class openbmc_ffdc_list():
179    def get_ffdc_bmc_cmd(self, i_type):
180        r"""
181        #######################################################################
182        #   @brief    This method returns the list from the dictionary for cmds
183        #   @param    i_type: @type string: string index lookup
184        #   @return   List of key pair from the dictionary
185        #######################################################################
186        """
187        return FFDC_BMC_CMD[i_type].items()
188
189    def get_ffdc_bmc_file(self, i_type):
190        r"""
191        #######################################################################
192        #   @brief    This method returns the list from the dictionary for scp
193        #   @param    i_type: @type string: string index lookup
194        #   @return   List of key pair from the dictionary
195        #######################################################################
196        """
197        return FFDC_BMC_FILE[i_type].items()
198
199    def get_ffdc_get_request(self, i_type):
200        r"""
201        #######################################################################
202        #   @brief    This method returns the list from the dictionary for scp
203        #   @param    i_type: @type string: string index lookup
204        #   @return   List of key pair from the dictionary
205        #######################################################################
206        """
207        return FFDC_GET_REQUEST[i_type].items()
208
209    def get_ffdc_cmd_index(self):
210        r"""
211        #######################################################################
212        #   @brief    This method returns the list index from dictionary
213        #   @return   List of index to the dictionary
214        #######################################################################
215        """
216        return FFDC_BMC_CMD.keys()
217
218    def get_ffdc_get_request_index(self):
219        r"""
220        #######################################################################
221        #   @brief    This method returns the list index from dictionary
222        #   @return   List of index to the dictionary
223        #######################################################################
224        """
225        return FFDC_GET_REQUEST.keys()
226
227    def get_ffdc_file_index(self):
228        r"""
229        #######################################################################
230        #   @brief    This method returns the list index from dictionary
231        #   @return   List of index to the dictionary
232        #######################################################################
233        """
234        return FFDC_BMC_FILE.keys()
235
236    def get_ffdc_method_index(self):
237        r"""
238        #######################################################################
239        #   @brief    This method returns the key pair from the dictionary
240        #   @return   Index of the method dictionary
241        #######################################################################
242        """
243        return FFDC_METHOD_CALL.keys()
244
245    def get_ffdc_method_desc(self,
246                             index):
247        r"""
248        #######################################################################
249        #   @brief   This method returns the just the keys from the dictionary.
250        #   @return  List of ffdc descriptions.
251        #######################################################################
252        """
253        return FFDC_METHOD_CALL[index].keys()
254
255    def get_ffdc_method_call(self, i_type):
256        r"""
257        #######################################################################
258        #   @brief    This method returns the key pair from the dictionary
259        #   @return   List of key pair keywords
260        #######################################################################
261        """
262        return FFDC_METHOD_CALL[i_type].items()
263
264    def get_ffdc_os_all_distros_index(self):
265        r"""
266        #######################################################################
267        #   @brief    This method returns the key pair from the dictionary
268        #   @return   Index of the method dictionary
269        #######################################################################
270        """
271        return FFDC_OS_ALL_DISTROS_FILE.keys()
272
273    def get_ffdc_os_all_distros_call(self, i_type):
274        r"""
275        #######################################################################
276        #   @brief    This method returns the key pair from the dictionary
277        #   @return   List of key pair keywords
278        #######################################################################
279        """
280        return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
281
282    def get_ffdc_os_distro_index(self, distro):
283        r"""
284        #######################################################################
285        #   @brief    This method returns the key pair from the dictionary
286        #   @return   Index of the method dictionary
287        #######################################################################
288        """
289        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
290        return eval(distro_file).keys()
291
292    def get_ffdc_os_distro_call(self, i_type, distro):
293        r"""
294        #######################################################################
295        #   @brief    This method returns the key pair from the dictionary
296        #   @return   List of key pair keywords
297        #######################################################################
298        """
299        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
300        return eval(distro_file)[i_type].items()
301
302    def get_strip_string(self, i_str):
303        r"""
304        #######################################################################
305        #   @brief    Returns the stripped strings
306        #   @param    i_str: @type string: string name
307        #   @return   Remove all special chars and return the string
308        #######################################################################
309        """
310        return ''.join(e for e in i_str if e.isalnum())
311
312    def get_esel_index(self, esel_list):
313        r"""
314        #######################################################################
315        #   @brief    Returns the eSEL binary index.
316        #   @param    esel_ist: @type list: eSEL list.
317        #   @return   Index of "ESEL=" in the list.
318        #######################################################################
319        """
320        index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str]
321        return index[0]
322
323    def get_dump_index(self, dump_list):
324        r"""
325        #######################################################################
326        #   @brief    Returns the eSEL binary index.
327        #   @param    esel_ist: @type list: eSEL list.
328        #   @return   Index of "ESEL=" in the list.
329        #######################################################################
330        """
331        index = [i for i, str in enumerate(dump_list) if 'DUMP=' in str]
332        return index[0]
333