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        # String Name         Command
22        "FW Level": "cat /etc/os-release",
23        "FW Timestamp": "cat /etc/timestamp",
24    },
25    "BMC DATA": {
26        "BMC OS": "uname -a",
27        "BMC Uptime": "uptime;cat /proc/uptime",
28        "BMC File System Disk Space Usage": "df -hT",
29        "BMC Date Time": "date;/sbin/hwclock --show;/usr/bin/timedatectl",
30    },
31    "APPLICATION DATA": {
32        "BMC state": "/usr/bin/obmcutil state",
33    },
34}
35# Add file name and corresponding command needed for BMC
36FFDC_BMC_FILE = {
37    "BMC FILES": {
38        # File Name         Command
39        "BMC_flash_side.txt": (
40            "cat /sys/class/watchdog/watchdog1/bootstatus"
41            " >/tmp/BMC_flash_side.txt 2>&1"
42        ),
43        "BMC_hwmon.txt": (
44            "grep -r . /sys/class/hwmon/* >/tmp/BMC_hwmon.txt 2>&1"
45        ),
46        "BMC_proc_list.txt": "top -n 1 -b >/tmp/BMC_proc_list.txt 2>&1",
47        "BMC_proc_fd_active_list.txt": (
48            "ls -Al /proc/*/fd/ >/tmp/BMC_proc_fd_active_list.txt 2>&1"
49        ),
50        "BMC_journalctl_nopager.txt": (
51            "journalctl --no-pager >/tmp/BMC_journalctl_nopager.txt 2>&1"
52        ),
53        "BMC_journalctl_pretty.json": (
54            "journalctl -o json-pretty >/tmp/BMC_journalctl_pretty.json 2>&1"
55        ),
56        "BMC_dmesg.txt": "dmesg >/tmp/BMC_dmesg.txt 2>&1",
57        "BMC_procinfo.txt": "cat /proc/cpuinfo >/tmp/BMC_procinfo.txt 2>&1",
58        "BMC_meminfo.txt": "cat /proc/meminfo >/tmp/BMC_meminfo.txt 2>&1",
59        "BMC_systemd.txt": "systemctl status --all >/tmp/BMC_systemd.txt 2>&1",
60        "BMC_failed_service.txt": (
61            "systemctl list-units --failed >/tmp/BMC_failed_service.txt 2>&1"
62        ),
63        "BMC_list_service.txt": (
64            "systemctl list-jobs >/tmp/BMC_list_service.txt 2>&1"
65        ),
66        "BMC_obmc_console.txt": (
67            "cat /var/log/obmc-console.log >/tmp/BMC_obmc_console.txt 2>&1"
68        ),
69        "BMC_obmc_console1.txt": (
70            "cat /var/log/obmc-console1.log >/tmp/BMC_obmc_console1.txt 2>&1"
71        ),
72        "vpd-inventory.txt": "vpd-tool -i >/tmp/vpd-inventory.txt 2>&1",
73        "PEL_logs_list.json": "peltool -l >/tmp/PEL_logs_list.json 2>&1",
74        "PEL_logs_complete_list.json": (
75            "peltool -l -a -f >/tmp/PEL_logs_complete_list.json 2>&1"
76        ),
77        "PEL_logs_display.json": "peltool -a >/tmp/PEL_logs_display.json 2>&1",
78        "PEL_logs_complete_display.json": (
79            "peltool -a -f -h>/tmp/PEL_logs_complete_display.json 2>&1"
80        ),
81        "PEL_logs_badPEL.txt": (
82            "hexdump -C"
83            + " /var/lib/phosphor-logging/extensions/pels/badPEL>/tmp/PEL_logs_badPEL.txt"
84            " 2>&1"
85        ),
86        "PLDM_fru_record.txt": (
87            "pldmtool fru getfrurecordtable>/tmp/PLDM_fru_record.txt 2>&1"
88        ),
89        "BMC_pldm_flight_recorder.txt": (
90            "rm -rf /tmp/pldm_flight_recorder; killall -s SIGUSR1 pldmd;"
91            + " sleep 5; cat /tmp/pldm_flight_recorder >"
92            " /tmp/BMC_pldm_flight_recorder.txt 2>&1;"
93        ),
94        "OCC_state.txt": (
95            'echo "OCC state check";for i in {0..3};'
96            + " do (echo /org/open_power/control/occ$i;"
97            + " busctl get-property org.open_power.OCC.Control"
98            " /org/open_power/control/occ$i"
99            + " org.open_power.OCC.Status OccActive) done > /tmp/OCC_state.txt"
100            " 2>&1"
101        ),
102        "bmcweb_persistent_data.json": (
103            "cat /home/root/bmcweb_persistent_data.json"
104            + " > /tmp/bmcweb_persistent_data.json"
105        ),
106        "GUARD_list.txt": "guard -l > /tmp/GUARD_list.txt 2>&1",
107        "fan_control_dump.json": "fanctl dump; sleep 5",
108        "fan_monitor_dump.json": "killall -s SIGUSR1 phosphor-fan-monitor; sleep 5",
109        "DEVTREE": (
110            "cat /var/lib/phosphor-software-manager/pnor/rw/DEVTREE >"
111            " /tmp/DEVTREE 2>&1"
112        ),
113    },
114}
115# Add file name and corresponding command needed for all Linux distributions
116FFDC_OS_ALL_DISTROS_FILE = {
117    "OS FILES": {
118        # File Name         Command
119        "OS_msglog.txt": (
120            "cat /sys/firmware/opal/msglog >/tmp/OS_msglog.txt 2>&1"
121        ),
122        "OS_cpufrequency.txt": (
123            "ppc64_cpu --frequency >/tmp/OS_cpufrequency.txt 2>&1"
124        ),
125        "OS_dmesg.txt": "dmesg >/tmp/OS_dmesg.txt 2>&1",
126        "OS_opal_prd.txt": "cat /var/log/opal-prd* >/tmp/OS_opal_prd.txt 2>&1",
127        "OS_boot.txt": "cat /var/log/boot.log >/tmp/OS_boot.txt 2>&1",
128        "OS_procinfo.txt": "cat /proc/cpuinfo >/tmp/OS_procinfo.txt 2>&1",
129        "OS_meminfo.txt": "cat /proc/meminfo >/tmp/OS_meminfo.txt 2>&1",
130        "OS_netstat.txt": "netstat -a >/tmp/OS_netstat.txt 2>&1",
131        "OS_lspci.txt": "lspci >/tmp/OS_lspci.txt 2>&1",
132        "OS_lscpu.txt": "lscpu >/tmp/OS_lscpu.txt 2>&1",
133        "OS_lscfg.txt": "lscfg >/tmp/OS_lscfg.txt 2>&1",
134        "OS_journalctl_nopager.txt": (
135            "journalctl --no-pager -b "
136            + "> /tmp/OS_journalctl_nopager.txt  2>&1"
137        ),
138    },
139}
140# Add file name and corresponding command needed for Ubuntu Linux
141FFDC_OS_UBUNTU_FILE = {
142    "OS FILES": {
143        # File Name         Command
144        "OS_isusb.txt": "{ lsusb -t ; lsusb -v ; } >/tmp/OS_isusb.txt 2>&1",
145        "OS_kern.txt": (
146            "tail -n 50000 /var/log/kern.log >/tmp/OS_kern.txt 2>&1"
147        ),
148        "OS_authlog.txt": (
149            "{ cat /var/log/auth.log; cat /var/log/auth.log.1 ; } "
150            + ">/tmp/OS_authlog.txt 2>&1"
151        ),
152        "OS_syslog.txt": (
153            "tail -n 200000 /var/log/syslog >/tmp/OS_syslog.txt 2>&1"
154        ),
155        "OS_info.txt": (
156            "{ uname -a; dpkg -s opal-prd; dpkg -s ipmitool ; } "
157            + ">/tmp/OS_info.txt 2>&1"
158        ),
159        "OS_sosreport.txt": (
160            "{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir "
161            + "/tmp --ticket-number FFDC ; } >/tmp/OS_sosreport.txt 2>&1"
162        ),
163    },
164}
165# Add file name and corresponding command needed for RHEL Linux
166FFDC_OS_RHEL_FILE = {
167    "OS FILES": {
168        # File Name         Command
169        "OS_rsct.txt": "/usr/bin/ctversion -bv >/tmp/OS_rsct.txt 2>&1",
170        "OS_secure.txt": "cat /var/log/secure >/tmp/OS_secure.txt 2>&1",
171        "OS_syslog.txt": (
172            "tail -n 200000 /var/log/messages >/tmp/OS_syslog.txt 2>&1"
173        ),
174        "OS_info.txt": (
175            "{ lsb_release -a; cat /etc/redhat-release; "
176            + "uname -a; rpm -qa ; } >/tmp/OS_info.txt 2>&1"
177        ),
178        "OS_sosreport.txt": (
179            "{ rm -rf /tmp/sosreport*FFDC* ; sosreport --batch --tmp-dir "
180            + "/tmp --label FFDC ; } >/tmp/OS_sosreport.txt 2>&1"
181        ),
182    },
183}
184# Add file name and corresponding command needed for AIX.
185FFDC_OS_AIX_FILE = {
186    "OS FILES": {
187        # File Name         Command
188        "OS_errpt.txt": "errpt >/tmp/OS_errpt.txt 2>&1 ; errclear 0;",
189        "OS_processors.txt": "bindprocessor -q >/tmp/OS_processors.txt 2>&1",
190    },
191}
192
193try:
194    redfish_support_trans_state = os.environ.get(
195        "REDFISH_SUPPORT_TRANS_STATE", 0
196    ) or int(
197        BuiltIn().get_variable_value(
198            "${REDFISH_SUPPORT_TRANS_STATE}", default=0
199        )
200    )
201except RobotNotRunningError:
202    pass
203
204OPENBMC_BASE = "/xyz/openbmc_project/"
205OPENPOWER_BASE = "/org/open_power/"
206ENUMERATE_SENSORS = OPENBMC_BASE + "sensors/enumerate"
207ENUMERATE_INVENTORY = OPENBMC_BASE + "inventory/enumerate"
208ENUMERATE_ELOG = OPENBMC_BASE + "logging/entry/enumerate"
209ENUMERATE_LED = OPENBMC_BASE + "led/enumerate"
210ENUMERATE_SW = OPENBMC_BASE + "software/enumerate"
211ENUMERATE_CONTROL = OPENBMC_BASE + "control/enumerate"
212ENUMERATE_STATE = OPENBMC_BASE + "state/enumerate"
213ENUMERATE_OCC = OPENPOWER_BASE + "/enumerate"
214ENUMERATE_DUMPS = OPENBMC_BASE + "dumps/enumerate"
215ENUMERATE_USER = OPENBMC_BASE + "user/enumerate"
216
217# Add file name and corresponding Get Request
218FFDC_GET_REQUEST = {
219    "GET REQUESTS": {
220        # File Name         Command
221        "FIRMWARE_list.txt": ENUMERATE_SW,
222        "BMC_sensor_list.txt": ENUMERATE_SENSORS,
223        "BMC_control_list.txt": ENUMERATE_CONTROL,
224        "BMC_inventory.txt": ENUMERATE_INVENTORY,
225        "BMC_elog.txt": ENUMERATE_ELOG,
226        "BMC_led.txt": ENUMERATE_LED,
227        "BMC_state.txt": ENUMERATE_STATE,
228        "OCC_state.txt": ENUMERATE_OCC,
229        "BMC_dumps.txt": ENUMERATE_DUMPS,
230        "BMC_USER.txt": ENUMERATE_USER,
231    },
232}
233
234# Remove the REST dictionary elements.
235if redfish_support_trans_state == 1:
236    for key in list(FFDC_GET_REQUEST):
237        del FFDC_GET_REQUEST[key]
238
239REDFISH_BASE = "/redfish/v1/"
240REDFISH_FIRMWARE = REDFISH_BASE + "UpdateService/FirmwareInventory"
241
242try:
243    REDFISH_SYSTEM_ID = REDFISH_SYSTEM_ID = os.environ.get(
244        "SYSTEM_ID", ""
245    ) or BuiltIn().get_variable_value("${SYSTEM_ID}", default="system")
246
247    REDFISH_ELOG = (
248        REDFISH_BASE
249        + "Systems/"
250        + REDFISH_SYSTEM_ID
251        + "/LogServices/EventLog/Entries"
252    )
253except RobotNotRunningError:
254    REDFISH_ELOG = REDFISH_BASE + "Systems/system/LogServices/EventLog/Entries"
255    pass
256
257# Add file name and corresponding Get Request
258FFDC_GET_REDFISH_REQUEST = {
259    "GET REQUESTS": {
260        # File Name         Command
261        "BMC_redfish_elog.txt": REDFISH_ELOG,
262    },
263}
264
265# Define your keywords in method/utils and call here
266FFDC_METHOD_CALL = {
267    "BMC LOGS": {
268        # Description               Keyword name
269        "Start ffdc cleanup": "BMC FFDC Cleanup",
270        "FFDC Generic Report": "BMC FFDC Manifest",
271        "BMC Specific Files": "BMC FFDC Files",
272        "Get Request FFDC": "BMC FFDC Get Requests",
273        "Get Redfish Request FFDC": "BMC FFDC Get Redfish Requests",
274        "OS FFDC": "OS FFDC Files",
275        "Core Files": "SCP Coredump Files",
276        "SEL Log": "Collect eSEL Log",
277        "Sys Inventory Files": "System Inventory Files",
278        "Dump Files": "SCP Dump Files",
279        "PEL Files": "Collect PEL Log",
280        "Redfish Log": "Enumerate Redfish Resources",
281        "Firmware Log": (
282            "Enumerate Redfish Resources  "
283            + " enum_uri=/redfish/v1/UpdateService/FirmwareInventory  "
284            + " file_enum_name=redfish_FIRMWARE_list.txt"
285        ),
286        "Redfish OEM Log": "Enumerate Redfish OEM Resources",
287        "End ffdc cleanup": "BMC FFDC Cleanup",
288    },
289}
290
291try:
292    platform_arch_type = os.environ.get(
293        "PLATFORM_ARCH_TYPE", ""
294    ) or BuiltIn().get_variable_value("${PLATFORM_ARCH_TYPE}", default="power")
295except RobotNotRunningError:
296    pass
297
298# Filter the logs based on platform type.
299if platform_arch_type == "x86":
300    del FFDC_BMC_FILE["BMC FILES"]["PEL_logs_list.json"]
301    del FFDC_BMC_FILE["BMC FILES"]["PEL_logs_display.json"]
302    del FFDC_METHOD_CALL["BMC LOGS"]["PEL Files"]
303
304# -----------------------------------------------------------------
305# base class for FFDC default list
306
307
308class openbmc_ffdc_list:
309    def get_ffdc_bmc_cmd(self, i_type):
310        r"""
311        #######################################################################
312        #   @brief    This method returns the list from the dictionary for cmds
313        #   @param    i_type: @type string: string index lookup
314        #   @return   List of key pair from the dictionary
315        #######################################################################
316        """
317        return FFDC_BMC_CMD[i_type].items()
318
319    def get_ffdc_bmc_file(self, i_type):
320        r"""
321        #######################################################################
322        #   @brief    This method returns the list from the dictionary for scp
323        #   @param    i_type: @type string: string index lookup
324        #   @return   List of key pair from the dictionary
325        #######################################################################
326        """
327        return FFDC_BMC_FILE[i_type].items()
328
329    def get_ffdc_get_request(self, i_type):
330        r"""
331        #######################################################################
332        #   @brief    This method returns the list from the dictionary for scp
333        #   @param    i_type: @type string: string index lookup
334        #   @return   List of key pair from the dictionary
335        #######################################################################
336        """
337        return FFDC_GET_REQUEST[i_type].items()
338
339    def get_ffdc_get_redfish_request(self, i_type):
340        r"""
341        #######################################################################
342        #   @brief    This method returns the list from the dictionary for scp
343        #   @param    i_type: @type string: string index lookup
344        #   @return   List of key pair from the dictionary
345        #######################################################################
346        """
347        return FFDC_GET_REDFISH_REQUEST[i_type].items()
348
349    def get_ffdc_cmd_index(self):
350        r"""
351        #######################################################################
352        #   @brief    This method returns the list index from dictionary
353        #   @return   List of index to the dictionary
354        #######################################################################
355        """
356        return FFDC_BMC_CMD.keys()
357
358    def get_ffdc_get_request_index(self):
359        r"""
360        #######################################################################
361        #   @brief    This method returns the list index from dictionary
362        #   @return   List of index to the dictionary
363        #######################################################################
364        """
365        return FFDC_GET_REQUEST.keys()
366
367    def get_ffdc_get_redfish_request_index(self):
368        r"""
369        #######################################################################
370        #   @brief    This method returns the list index from dictionary
371        #   @return   List of index to the dictionary
372        #######################################################################
373        """
374        return FFDC_GET_REDFISH_REQUEST.keys()
375
376    def get_ffdc_file_index(self):
377        r"""
378        #######################################################################
379        #   @brief    This method returns the list index from dictionary
380        #   @return   List of index to the dictionary
381        #######################################################################
382        """
383        return FFDC_BMC_FILE.keys()
384
385    def get_ffdc_method_index(self):
386        r"""
387        #######################################################################
388        #   @brief    This method returns the key pair from the dictionary
389        #   @return   Index of the method dictionary
390        #######################################################################
391        """
392        return FFDC_METHOD_CALL.keys()
393
394    def get_ffdc_method_desc(self, index):
395        r"""
396        #######################################################################
397        #   @brief   This method returns the just the keys from the dictionary.
398        #   @return  List of ffdc descriptions.
399        #######################################################################
400        """
401        return FFDC_METHOD_CALL[index].keys()
402
403    def get_ffdc_method_call(self, i_type):
404        r"""
405        #######################################################################
406        #   @brief    This method returns the key pair from the dictionary
407        #   @return   List of key pair keywords
408        #######################################################################
409        """
410        return FFDC_METHOD_CALL[i_type].items()
411
412    def get_ffdc_os_all_distros_index(self):
413        r"""
414        #######################################################################
415        #   @brief    This method returns the key pair from the dictionary
416        #   @return   Index of the method dictionary
417        #######################################################################
418        """
419        return FFDC_OS_ALL_DISTROS_FILE.keys()
420
421    def get_ffdc_os_all_distros_call(self, i_type):
422        r"""
423        #######################################################################
424        #   @brief    This method returns the key pair from the dictionary
425        #   @return   List of key pair keywords
426        #######################################################################
427        """
428        return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
429
430    def get_ffdc_os_distro_index(self, distro):
431        r"""
432        #######################################################################
433        #   @brief    This method returns the key pair from the dictionary
434        #   @return   Index of the method dictionary
435        #######################################################################
436        """
437        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
438        return eval(distro_file).keys()
439
440    def get_ffdc_os_distro_call(self, i_type, distro):
441        r"""
442        #######################################################################
443        #   @brief    This method returns the key pair from the dictionary
444        #   @return   List of key pair keywords
445        #######################################################################
446        """
447        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
448        return eval(distro_file)[i_type].items()
449
450    def get_strip_string(self, i_str):
451        r"""
452        #######################################################################
453        #   @brief    Returns the stripped strings
454        #   @param    i_str: @type string: string name
455        #   @return   Remove all special chars and return the string
456        #######################################################################
457        """
458        return "".join(e for e in i_str if e.isalnum())
459
460    def get_esel_index(self, esel_list):
461        r"""
462        #######################################################################
463        #   @brief    Returns the eSEL binary index.
464        #   @param    esel_ist: @type list: eSEL list.
465        #   @return   Index of "ESEL=" in the list.
466        #######################################################################
467        """
468        index = [i for i, str in enumerate(esel_list) if "ESEL=" in str]
469        return index[0]
470
471    def get_dump_index(self, dump_list):
472        r"""
473        #######################################################################
474        #   @brief    Returns the eSEL binary index.
475        #   @param    esel_ist: @type list: eSEL list.
476        #   @return   Index of "ESEL=" in the list.
477        #######################################################################
478        """
479        index = [i for i, str in enumerate(dump_list) if "DUMP=" in str]
480        return index[0]
481