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