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