1#!/usr/bin/python 2r""" 3############################################################# 4# @file openbmc_ffdc_list.py 5# 6# @brief List for FFDC ( First failure data capture ) 7# commands and files to be collected as a part 8# of the test case failure. 9############################################################# 10""" 11 12# ------------------- 13# FFDC default list 14# ------------------- 15 16# ----------------------------------------------------------------- 17# Dict Name { Index string : { Key String : Comand string} } 18# ----------------------------------------------------------------- 19# Add cmd's needed to be part of the ffdc report manifest file 20FFDC_BMC_CMD = { 21 'DRIVER INFO': 22 { 23 # String Name Command 24 'FW Level': 'cat /etc/os-release', 25 'FW Timestamp': 'cat /etc/timestamp', 26 }, 27 'BMC DATA': 28 { 29 'BMC OS': 'uname -a', 30 'BMC Uptime': 'uptime', 31 'BMC File System Disk Space Usage': 'df -hT', 32 }, 33 'APPLICATION DATA': 34 { 35 'BMC state': '/usr/sbin/obmcutil state', 36 }, 37} 38 39# Add file name and correcponding command needed for BMC 40FFDC_BMC_FILE = { 41 'BMC FILES': 42 { 43 # File Name Command 44 'BMC_proc_list': 'top -n 1 -b', 45 'BMC_proc_fd_active_list': 'ls -Al /proc/*/fd/', 46 'BMC_journalctl': 'journalctl --no-pager', 47 'BMC_dmesg': 'dmesg', 48 'BMC_procinfo': 'cat /proc/cpuinfo', 49 'BMC_meminfo': 'cat /proc/meminfo', 50 }, 51} 52 53# Add file name and correcponding command needed for all Linux distributions 54FFDC_OS_ALL_DISTROS_FILE = { 55 'OS FILES': 56 { 57 # File Name Command 58 'OS_msglog': 'cat /sys/firmware/opal/msglog', 59 'OS_cpufrequency': 'ppc64_cpu --frequency', 60 'OS_dmesg': 'dmesg', 61 'OS_boot': 'cat /var/log/boot.log', 62 'OS_procinfo': 'cat /proc/cpuinfo', 63 'OS_meminfo': 'cat /proc/meminfo', 64 'OS_netstat': 'netstat -a', 65 'OS_lspci': 'lspci', 66 'OS_lscpu': 'lscpu', 67 'OS_lscfg': 'lscfg', 68 }, 69} 70 71# Add file name and correcponding command needed for Ubuntu Linux 72FFDC_OS_UBUNTU_FILE = { 73 'OS FILES': 74 { 75 # File Name Command 76 'OS_isusb': 'lsusb -t ; lsusb -v', 77 'OS_kern': 'tail -n 50000 /var/log/kern.log', 78 'OS_authlog': 'cat /var/log/auth.log; cat /var/log/auth.log.1', 79 'OS_syslog': 'tail -n 200000 /var/log/syslog', 80 'OS_info': 'uname -a; dpkg -s opal-prd; dpkg -s ipmitool', 81 }, 82} 83 84# Add file name and correcponding command needed for RHEL Linux 85FFDC_OS_RHEL_FILE = { 86 'OS FILES': 87 { 88 # File Name Command 89 'OS_rsct': '/usr/bin/ctversion -bv', 90 'OS_secure': 'cat /var/log/secure', 91 'OS_syslog': 'tail -n 200000 /var/log/messages', 92 'OS_info': 'lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa', 93 }, 94} 95 96# Add file name and correcponding command needed for RHEL Linux 97FFDC_OS_IBM_POWERKVM_FILE = { 98 'OS FILES': 99 { 100 # File Name Command 101 'OS_secure': 'cat /var/log/secure', 102 'OS_syslog': 'tail -n 200000 /var/log/messages', 103 'OS_info': 'lsb_release -a; uname -a; rpm -qa', 104 }, 105} 106 107# Enable when ready with openbmc/openbmc-test-automation#203 108# replace with new path /xyz/openbmc_project 109OPENBMC_BASE = '/org/openbmc/' 110ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate' 111# TODO: Use the xyz enums once moved to xyz completely 112# ENUMERATE_SYSTEMS = OPENBMC_BASE + 'inventory/enumerate' 113ENUMERATE_SYSTEMS = '/xyz/openbmc_project/inventory/enumerate' 114ENUMERATE_ELOG = '/xyz/openbmc_project/logging/entry/enumerate' 115ENUMERATE_EVENTS = OPENBMC_BASE + 'records/events/enumerate' 116ENUMERATE_LED = OPENBMC_BASE + 'control/led/enumerate' 117 118# Sensors/control data. 119ENUMERATE_SENSOR = '/xyz/openbmc_project/sensors/enumerate' 120ENUMERATE_CONTROL = '/xyz/openbmc_project/control/enumerate' 121 122# Add file name and correcponding Get Request 123FFDC_GET_REQUEST = { 124 'GET REQUESTS': 125 { 126 # File Name Command 127 'BMC_sensor_list': ENUMERATE_SENSORS, 128 'BMC_sensor_xyz_list': ENUMERATE_SENSOR, 129 'BMC_control_list': ENUMERATE_CONTROL, 130 'BMC_inventory': ENUMERATE_SYSTEMS, 131 'BMC_elog': ENUMERATE_ELOG, 132 'BMC_led': ENUMERATE_EVENTS, 133 'BMC_record_log': ENUMERATE_LED, 134 }, 135} 136 137 138# Define your keywords in method/utils and call here 139FFDC_METHOD_CALL = { 140 'BMC LOGS': 141 { 142 # Description Keyword name 143 'FFDC Generic Report': 'BMC FFDC Manifest', 144 'BMC Specific Files': 'BMC FFDC Files', 145 'Get Request FFDC': 'BMC FFDC Get Requests', 146 'OS FFDC': 'OS FFDC Files', 147 'Core Files': 'SCP Coredump Files', 148 'SEL Log': 'Collect eSEL Log', 149 'Sys Inventory Files': 'System Inventory Files', 150 }, 151} 152 153# ----------------------------------------------------------------- 154 155 156# base class for FFDC default list 157class openbmc_ffdc_list(): 158 159 def get_ffdc_bmc_cmd(self, i_type): 160 r""" 161 ######################################################################## 162 # @brief This method returns the list from the dictionary for cmds 163 # @param i_type: @type string: string index lookup 164 # @return List of key pair from the dictionary 165 ######################################################################## 166 """ 167 return FFDC_BMC_CMD[i_type].items() 168 169 def get_ffdc_bmc_file(self, i_type): 170 r""" 171 ######################################################################## 172 # @brief This method returns the list from the dictionary for scp 173 # @param i_type: @type string: string index lookup 174 # @return List of key pair from the dictionary 175 ######################################################################## 176 """ 177 return FFDC_BMC_FILE[i_type].items() 178 179 def get_ffdc_get_request(self, i_type): 180 r""" 181 ######################################################################## 182 # @brief This method returns the list from the dictionary for scp 183 # @param i_type: @type string: string index lookup 184 # @return List of key pair from the dictionary 185 ######################################################################## 186 """ 187 return FFDC_GET_REQUEST[i_type].items() 188 189 def get_ffdc_cmd_index(self): 190 r""" 191 ######################################################################## 192 # @brief This method returns the list index from dictionary 193 # @return List of index to the dictionary 194 ######################################################################## 195 """ 196 return FFDC_BMC_CMD.keys() 197 198 def get_ffdc_get_request_index(self): 199 r""" 200 ######################################################################## 201 # @brief This method returns the list index from dictionary 202 # @return List of index to the dictionary 203 ######################################################################## 204 """ 205 return FFDC_GET_REQUEST.keys() 206 207 def get_ffdc_file_index(self): 208 r""" 209 ######################################################################## 210 # @brief This method returns the list index from dictionary 211 # @return List of index to the dictionary 212 ######################################################################## 213 """ 214 return FFDC_BMC_FILE.keys() 215 216 def get_ffdc_method_index(self): 217 r""" 218 ######################################################################## 219 # @brief This method returns the key pair from the dictionary 220 # @return Index of the method dictionary 221 ######################################################################## 222 """ 223 return FFDC_METHOD_CALL.keys() 224 225 def get_ffdc_method_desc(self, 226 index): 227 r""" 228 ######################################################################## 229 # @brief This method returns the just the keys from the dictionary. 230 # @return List of ffdc descriptions. 231 ######################################################################## 232 """ 233 return FFDC_METHOD_CALL[index].keys() 234 235 def get_ffdc_method_call(self, i_type): 236 r""" 237 ######################################################################## 238 # @brief This method returns the key pair from the dictionary 239 # @return List of key pair keywords 240 ######################################################################## 241 """ 242 return FFDC_METHOD_CALL[i_type].items() 243 244 def get_ffdc_os_all_distros_index(self): 245 r""" 246 ######################################################################## 247 # @brief This method returns the key pair from the dictionary 248 # @return Index of the method dictionary 249 ######################################################################## 250 """ 251 return FFDC_OS_ALL_DISTROS_FILE.keys() 252 253 def get_ffdc_os_all_distros_call(self, i_type): 254 r""" 255 ######################################################################## 256 # @brief This method returns the key pair from the dictionary 257 # @return List of key pair keywords 258 ######################################################################## 259 """ 260 return FFDC_OS_ALL_DISTROS_FILE[i_type].items() 261 262 def get_ffdc_os_distro_index(self, distro): 263 r""" 264 ######################################################################## 265 # @brief This method returns the key pair from the dictionary 266 # @return Index of the method dictionary 267 ######################################################################## 268 """ 269 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE" 270 return eval(distro_file).keys() 271 272 def get_ffdc_os_distro_call(self, i_type, distro): 273 r""" 274 ######################################################################## 275 # @brief This method returns the key pair from the dictionary 276 # @return List of key pair keywords 277 ######################################################################## 278 """ 279 distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE" 280 return eval(distro_file)[i_type].items() 281 282 def get_strip_string(self, i_str): 283 r""" 284 ######################################################################## 285 # @brief Returns the stripped strings 286 # @param i_str: @type string: string name 287 # @return Remove all special chars and return the string 288 ######################################################################## 289 """ 290 return ''.join(e for e in i_str if e.isalnum()) 291 292 def get_esel_index(self, esel_list): 293 r""" 294 ####################################################################### 295 # @brief Returns the eSEL binary index. 296 # @param esel_ist: @type list: eSEL list. 297 # @return Index of "ESEL=" in the list. 298 ####################################################################### 299 """ 300 index = [i for i, str in enumerate(esel_list) if 'ESEL=' in str] 301 return index[0] 302