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