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