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        'Build Info': 'cat /etc/version',
25        'FW Level': 'cat /etc/os-release',
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_journalctl': 'journalctl --no-pager',
46        'BMC_dmesg': 'dmesg',
47        'BMC_procinfo': 'cat /proc/cpuinfo',
48        'BMC_meminfo': 'cat /proc/meminfo',
49    },
50}
51
52# Add file name and correcponding command needed for all Linux distributions
53FFDC_OS_ALL_DISTROS_FILE = {
54    'OS FILES':
55    {
56        # File Name         Command
57        'OS_msglog': 'cat /sys/firmware/opal/msglog',
58        'OS_cpufrequency': 'ppc64_cpu --frequency',
59        'OS_dmesg': 'dmesg',
60        'OS_boot': 'cat /var/log/boot.log',
61        'OS_procinfo': 'cat /proc/cpuinfo',
62        'OS_meminfo': 'cat /proc/meminfo',
63        'OS_netstat': 'netstat -a',
64    },
65}
66
67# Add file name and correcponding command needed for Ubuntu Linux
68FFDC_OS_UBUNTU_FILE = {
69    'OS FILES':
70    {
71        # File Name         Command
72        'OS_isusb': 'lsusb -t ; lsusb -v',
73        'OS_kern': 'tail -n 50000 /var/log/kern.log',
74        'OS_authlog': 'cat /var/log/auth.log; cat /var/log/auth.log.1',
75        'OS_syslog': 'tail -n 200000 /var/log/syslog',
76        'OS_info': 'uname -a; dpkg -s opal-prd; dpkg -s ipmitool',
77    },
78}
79
80# Add file name and correcponding command needed for RHEL Linux
81FFDC_OS_RHEL_FILE = {
82    'OS FILES':
83    {
84        # File Name         Command
85        'OS_rsct': '/usr/bin/ctversion -bv',
86        'OS_secure': 'cat /var/log/secure',
87        'OS_syslog': 'tail -n 200000 /var/log/messages',
88        'OS_info': 'lsb_release -a; cat /etc/redhat-release; uname -a; rpm -qa',
89    },
90}
91
92# Add file name and correcponding command needed for RHEL Linux
93FFDC_OS_IBM_POWERKVM_FILE = {
94    'OS FILES':
95    {
96        # File Name         Command
97        'OS_secure': 'cat /var/log/secure',
98        'OS_syslog': 'tail -n 200000 /var/log/messages',
99        'OS_info': 'lsb_release -a; uname -a; rpm -qa',
100    },
101}
102
103# Enable when ready with openbmc/openbmc-test-automation#203
104# replace with new path /xyz/openbmc_project
105OPENBMC_BASE = '/org/openbmc/'
106ENUMERATE_SENSORS = OPENBMC_BASE + 'sensors/enumerate'
107# TODO: Use the xyz enums once moved to xyz completely
108# ENUMERATE_SYSTEMS = OPENBMC_BASE + 'inventory/enumerate'
109ENUMERATE_SYSTEMS = '/xyz/openbmc_project/inventory/enumerate'
110ENUMERATE_ELOG = '/xyz/openbmc_project/logging/entry/enumerate'
111ENUMERATE_EVENTS = OPENBMC_BASE + 'records/events/enumerate'
112ENUMERATE_LED = OPENBMC_BASE + 'control/led/enumerate'
113
114# Add file name and correcponding Get Request
115FFDC_GET_REQUEST = {
116    'GET REQUESTS':
117    {
118        # File Name         Command
119        'BMC_sensor_list': ENUMERATE_SENSORS,
120        'BMC_inventory': ENUMERATE_SYSTEMS,
121        'BMC_elog': ENUMERATE_ELOG,
122        'BMC_led': ENUMERATE_EVENTS,
123        'BMC_record_log': ENUMERATE_LED,
124    },
125}
126
127
128# Define your keywords in method/utils and call here
129FFDC_METHOD_CALL = {
130    'BMC LOGS':
131    {
132        # Description             Keyword name
133        'FFDC Generic Report': 'BMC FFDC Manifest',
134        'BMC Specific Files': 'BMC FFDC Files',
135        'Get Request FFDC': 'BMC FFDC Get Requests',
136        'OS FFDC': 'OS FFDC Files',
137        'Core Files': 'SCP Coredump Files',
138        'SEL Log': 'Collect eSEL Log',
139    },
140}
141
142# -----------------------------------------------------------------
143
144
145# base class for FFDC default list
146class openbmc_ffdc_list():
147
148    def get_ffdc_bmc_cmd(self, i_type):
149        r"""
150        ########################################################################
151        #   @brief    This method returns the list from the dictionary for cmds
152        #   @param    i_type: @type string: string index lookup
153        #   @return   List of key pair from the dictionary
154        ########################################################################
155        """
156        return FFDC_BMC_CMD[i_type].items()
157
158    def get_ffdc_bmc_file(self, i_type):
159        r"""
160        ########################################################################
161        #   @brief    This method returns the list from the dictionary for scp
162        #   @param    i_type: @type string: string index lookup
163        #   @return   List of key pair from the dictionary
164        ########################################################################
165        """
166        return FFDC_BMC_FILE[i_type].items()
167
168    def get_ffdc_get_request(self, i_type):
169        r"""
170        ########################################################################
171        #   @brief    This method returns the list from the dictionary for scp
172        #   @param    i_type: @type string: string index lookup
173        #   @return   List of key pair from the dictionary
174        ########################################################################
175        """
176        return FFDC_GET_REQUEST[i_type].items()
177
178    def get_ffdc_cmd_index(self):
179        r"""
180        ########################################################################
181        #   @brief    This method returns the list index from dictionary
182        #   @return   List of index to the dictionary
183        ########################################################################
184        """
185        return FFDC_BMC_CMD.keys()
186
187    def get_ffdc_get_request_index(self):
188        r"""
189        ########################################################################
190        #   @brief    This method returns the list index from dictionary
191        #   @return   List of index to the dictionary
192        ########################################################################
193        """
194        return FFDC_GET_REQUEST.keys()
195
196    def get_ffdc_file_index(self):
197        r"""
198        ########################################################################
199        #   @brief    This method returns the list index from dictionary
200        #   @return   List of index to the dictionary
201        ########################################################################
202        """
203        return FFDC_BMC_FILE.keys()
204
205    def get_ffdc_method_index(self):
206        r"""
207        ########################################################################
208        #   @brief    This method returns the key pair from the dictionary
209        #   @return   Index of the method dictionary
210        ########################################################################
211        """
212        return FFDC_METHOD_CALL.keys()
213
214    def get_ffdc_method_desc(self,
215                             index):
216        r"""
217        ########################################################################
218        #   @brief   This method returns the just the keys from the dictionary.
219        #   @return  List of ffdc descriptions.
220        ########################################################################
221        """
222        return FFDC_METHOD_CALL[index].keys()
223
224    def get_ffdc_method_call(self, i_type):
225        r"""
226        ########################################################################
227        #   @brief    This method returns the key pair from the dictionary
228        #   @return   List of key pair keywords
229        ########################################################################
230        """
231        return FFDC_METHOD_CALL[i_type].items()
232
233    def get_ffdc_os_all_distros_index(self):
234        r"""
235        ########################################################################
236        #   @brief    This method returns the key pair from the dictionary
237        #   @return   Index of the method dictionary
238        ########################################################################
239        """
240        return FFDC_OS_ALL_DISTROS_FILE.keys()
241
242    def get_ffdc_os_all_distros_call(self, i_type):
243        r"""
244        ########################################################################
245        #   @brief    This method returns the key pair from the dictionary
246        #   @return   List of key pair keywords
247        ########################################################################
248        """
249        return FFDC_OS_ALL_DISTROS_FILE[i_type].items()
250
251    def get_ffdc_os_distro_index(self, distro):
252        r"""
253        ########################################################################
254        #   @brief    This method returns the key pair from the dictionary
255        #   @return   Index of the method dictionary
256        ########################################################################
257        """
258        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
259        return eval(distro_file).keys()
260
261    def get_ffdc_os_distro_call(self, i_type, distro):
262        r"""
263        ########################################################################
264        #   @brief    This method returns the key pair from the dictionary
265        #   @return   List of key pair keywords
266        ########################################################################
267        """
268        distro_file = "FFDC_OS_" + str(distro).upper() + "_FILE"
269        return eval(distro_file)[i_type].items()
270
271    def get_strip_string(self, i_str):
272        r"""
273        ########################################################################
274        #   @brief    Returns the stripped strings
275        #   @param    i_str: @type string: string name
276        #   @return   Remove all special chars and return the string
277        ########################################################################
278        """
279        return ''.join(e for e in i_str if e.isalnum())
280