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