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