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