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