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