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