blob: cdd6778b677f084df89a4d06fa354204e0eb8075 [file] [log] [blame]
George Keishing69e6f712016-09-12 06:30:09 -05001*** Settings ***
2Documentation Methods to execute commands on BMC and collect
3... data to a list of FFDC files
4
Michael Walsh265ae412018-11-16 15:32:03 -06005Resource openbmc_ffdc_utils.robot
6Resource rest_client.robot
7Resource utils.robot
8Resource list_utils.robot
9Resource logging_utils.robot
Steven Sombar2da175f2019-02-04 10:32:58 -060010Resource bmc_redfish_resource.robot
Michael Walsh265ae412018-11-16 15:32:03 -060011Library SSHLibrary
12Library OperatingSystem
13Library Collections
14Library String
15Library gen_print.py
16Library gen_cmd.py
17Library gen_robot_keyword.py
18Library dump_utils.py
19Library logging_utils.py
Gunnar Mills7e2cda22016-10-11 15:37:34 -050020
Michael Walshde5e9372018-11-15 11:28:23 -060021*** Variables ***
22
Michael Walsh265ae412018-11-16 15:32:03 -060023${FFDC_CMD_TIMEOUT} 240
Michael Walshde5e9372018-11-15 11:28:23 -060024
George Keishing69e6f712016-09-12 06:30:09 -050025*** Keywords ***
26
George Keishing69e6f712016-09-12 06:30:09 -050027# Method : Call FFDC Methods #
28# Execute the user define keywords from the FFDC List #
29# Unlike any other keywords this will call into the #
30# list of keywords defined in the FFDC list at one go #
George Keishing69e6f712016-09-12 06:30:09 -050031
32Call FFDC Methods
Michael Walshe844e9a2017-04-20 16:51:10 -050033 [Documentation] Call into FFDC Keyword index list.
34 [Arguments] ${ffdc_function_list}=${EMPTY}
George Keishing69e6f712016-09-12 06:30:09 -050035
Michael Walshe844e9a2017-04-20 16:51:10 -050036 # Description of argument(s):
37 # ffdc_function_list A colon-delimited list naming the kinds of FFDC that
Michael Walsh63b70c02017-10-30 15:02:09 -050038 # are to be collected
Michael Walshe844e9a2017-04-20 16:51:10 -050039 # (e.g. "FFDC Generic Report:BMC Specific Files").
40 # Acceptable values can be found in the description
41 # field of FFDC_METHOD_CALL in
42 # lib/openbmc_ffdc_list.py. Those values can be
43 # obtained via a call to 'Get FFDC Method Desc' (also
44 # from lib/openbmc_ffdc_list.py).
45
46 @{entries}= Get FFDC Method Index
Michael Walsh63b70c02017-10-30 15:02:09 -050047 # Example entries:
48 # entries:
49 # entries[0]: BMC LOGS
50
51 @{ffdc_file_list}= Create List
Michael Walshe844e9a2017-04-20 16:51:10 -050052 :FOR ${index} IN @{entries}
Michael Walsh63b70c02017-10-30 15:02:09 -050053 \ ${ffdc_file_sub_list}= Method Call Keyword List ${index}
54 ... ${ffdc_function_list}
55 \ ${ffdc_file_list}= Smart Combine Lists ${ffdc_file_list}
56 ... ${ffdc_file_sub_list}
57
Michael Walsh6bad8412017-06-27 14:09:36 -050058 Run Key U SSHLibrary.Close All Connections
George Keishing69e6f712016-09-12 06:30:09 -050059
Michael Walsh63b70c02017-10-30 15:02:09 -050060 [Return] ${ffdc_file_list}
61
Steven Sombar2da175f2019-02-04 10:32:58 -060062
George Keishing69e6f712016-09-12 06:30:09 -050063Method Call Keyword List
Michael Walsh63b70c02017-10-30 15:02:09 -050064 [Documentation] Process FFDC request and return a list of generated files.
Michael Walshe844e9a2017-04-20 16:51:10 -050065 [Arguments] ${index} ${ffdc_function_list}=${EMPTY}
George Keishing69e6f712016-09-12 06:30:09 -050066
Michael Walshe844e9a2017-04-20 16:51:10 -050067 # Description of argument(s):
68 # index The index into the FFDC_METHOD_CALL dictionary (e.g.
69 # 'BMC LOGS').
70 # ffdc_function_list See ffdc_function_list description in
71 # "Call FFDC Methods" (above).
72
Michael Walsh63b70c02017-10-30 15:02:09 -050073 @{method_list}= Get FFDC Method Call ${index}
74 # Example method_list:
75 # method_list:
76 # method_list[0]:
77 # method_list[0][0]: FFDC Generic Report
78 # method_list[0][1]: BMC FFDC Manifest
79 # method_list[1]:
80 # method_list[1][0]: Get Request FFDC
81 # method_list[1][1]: BMC FFDC Get Requests
82 # (etc.)
Michael Walshe844e9a2017-04-20 16:51:10 -050083
84 # If function list is empty assign default (i.e. a list of all allowable
85 # values). In either case, convert ffdc_function_list from a string to
86 # a list.
87 @{ffdc_function_list}=
88 ... Run Keyword If '${ffdc_function_list}' == '${EMPTY}'
89 ... Get FFDC Method Desc ${index}
90 ... ELSE
91 ... Split String ${ffdc_function_list} separator=:
92
Michael Walsh63b70c02017-10-30 15:02:09 -050093 @{ffdc_file_list}= Create List
George Keishing69e6f712016-09-12 06:30:09 -050094 :FOR ${method} IN @{method_list}
Michael Walsh63b70c02017-10-30 15:02:09 -050095 \ ${ffdc_file_sub_list}= Execute Keyword Method ${method[0]}
96 ... ${method[1]} @{ffdc_function_list}
97 \ ${ffdc_file_list}= Smart Combine Lists ${ffdc_file_list}
98 ... ${ffdc_file_sub_list}
99
100 [Return] ${ffdc_file_list}
101
George Keishing69e6f712016-09-12 06:30:09 -0500102
103Execute Keyword Method
Michael Walshe844e9a2017-04-20 16:51:10 -0500104 [Documentation] Call into BMC method keywords. Don't let one
105 ... failure skip the remaining. Get whatever data
106 ... it could gather at worse case scenario.
107 [Arguments] ${description} ${keyword_name} @{ffdc_function_list}
George Keishing69e6f712016-09-12 06:30:09 -0500108
Michael Walshe844e9a2017-04-20 16:51:10 -0500109 # Description of argument(s):
110 # description The description of the FFDC to be collected. This
111 # would be any value returned by
112 # 'Get FFDC Method Desc' (e.g. "FFDC Generic Report").
113 # keyword_name The name of the keyword to call to collect the FFDC
114 # data (again, see FFDC_METHOD_CALL).
115 # ffdc_function_list See ffdc_function_list description in
116 # "Call FFDC Methods" (above). The only difference is
117 # in this case, it should be a list rather than a
118 # colon-delimited value.
George Keishing69e6f712016-09-12 06:30:09 -0500119
Michael Walsh63b70c02017-10-30 15:02:09 -0500120 @{ffdc_file_list}= Create List
Michael Walshe844e9a2017-04-20 16:51:10 -0500121
Michael Walsh63b70c02017-10-30 15:02:09 -0500122 ${index}= Get Index From List ${ffdc_function_list} ${description}
123 Run Keyword If '${index}' == '${-1}' Return from Keyword
124 ... ${ffdc_file_list}
125
126 ${status} ${ffdc_file_list}= Run Key ${keyword_name} ignore=1
127 [Return] ${ffdc_file_list}
George Keishing69e6f712016-09-12 06:30:09 -0500128
George Keishing69e6f712016-09-12 06:30:09 -0500129# Method : BMC FFDC Manifest #
130# Execute command on BMC and write to ffdc_report.txt #
George Keishing69e6f712016-09-12 06:30:09 -0500131
132BMC FFDC Manifest
Michael Walsh63b70c02017-10-30 15:02:09 -0500133 [Documentation] Run the ssh commands from FFDC_BMC_CMD and return a list
134 ... of generated files.
George Keishing69e6f712016-09-12 06:30:09 -0500135
Michael Walsh63b70c02017-10-30 15:02:09 -0500136 @{ffdc_file_list}= Create List ${FFDC_FILE_PATH}
137 @{entries}= Get FFDC Cmd Index
138 :FOR ${index} IN @{entries}
139 \ Iterate BMC Command List Pairs ${index}
140
141 [Return] ${ffdc_file_list}
George Keishing69e6f712016-09-12 06:30:09 -0500142
143
144Iterate BMC Command List Pairs
145 [Documentation] Feed in key pair list from dictionary to execute
146 [Arguments] ${key_index}
147
148 @{cmd_list}= Get ffdc bmc cmd ${key_index}
149 Set Suite Variable ${ENTRY_INDEX} ${key_index}
150 :FOR ${cmd} IN @{cmd_list}
151 \ Execute Command and Write FFDC ${cmd[0]} ${cmd[1]}
152
153
154Execute Command and Write FFDC
Michael Walsh63b70c02017-10-30 15:02:09 -0500155 [Documentation] Run a command on the BMC or OS, write the output to the
156 ... specified file and return a list of generated files.
157 [Arguments] ${key_index} ${cmd} ${logpath}=${FFDC_FILE_PATH}
158 ... ${target}=BMC
George Keishing69e6f712016-09-12 06:30:09 -0500159
Michael Walsh63b70c02017-10-30 15:02:09 -0500160 Run Keyword If '${logpath}' == '${FFDC_FILE_PATH}'
161 ... Write Cmd Output to FFDC File ${key_index} ${cmd}
162
163 @{ffdc_file_list}= Create List ${log_path}
George Keishing69e6f712016-09-12 06:30:09 -0500164
Michael Walshe53e47a2017-06-30 17:03:24 -0500165 ${cmd_buf}= Catenate ${target} Execute Command \ ${cmd} \ ignore_err=${1}
Michael Walsh265ae412018-11-16 15:32:03 -0600166 ... \ time_out=${FFDC_CMD_TIMEOUT}
Michael Walshe53e47a2017-06-30 17:03:24 -0500167 ${status} ${ret_values}= Run Key ${cmd_buf} ignore=${1}
Michael Walshde5e9372018-11-15 11:28:23 -0600168 # If the command times out, status will be 'FAIL'.
169 Return From Keyword If '${status}' == 'FAIL' ${ffdc_file_list}
Michael Walshe53e47a2017-06-30 17:03:24 -0500170
171 ${stdout}= Set Variable @{ret_values}[0]
172 ${stderr}= Set Variable @{ret_values}[1]
George Keishing69e6f712016-09-12 06:30:09 -0500173
Jeff Whitlock7d805b22017-01-20 14:04:33 -0600174 # Write stdout on success and stderr/stdout to the file on failure.
175 Run Keyword If $stderr == '${EMPTY}'
Sweta Potthuri15e6d2f2017-02-28 03:10:02 -0600176 ... Write Data To File ${stdout}${\n} ${logpath}
177 ... ELSE Write Data To File
Jeff Whitlock7d805b22017-01-20 14:04:33 -0600178 ... ERROR output:${\n}${stderr}${\n}Output:${\n}${stdout}${\n}
179 ... ${logpath}
George Keishing69e6f712016-09-12 06:30:09 -0500180
Michael Walsh63b70c02017-10-30 15:02:09 -0500181 [Return] ${ffdc_file_list}
182
George Keishing69e6f712016-09-12 06:30:09 -0500183
George Keishing69e6f712016-09-12 06:30:09 -0500184# Method : BMC FFDC Files #
185# Execute command on BMC and write to individual file #
186# based on the file name pre-defined in the list #
George Keishing69e6f712016-09-12 06:30:09 -0500187
188BMC FFDC Files
Michael Walsh63b70c02017-10-30 15:02:09 -0500189 [Documentation] Run the commands from FFDC_BMC_FILE and return a list of
190 ... generated files.
191
192 @{entries}= Get FFDC File Index
193 # Example of entries:
194 # entries:
195 # entries[0]: BMC FILES
196
197 @{ffdc_file_list}= Create List
198 :FOR ${index} IN @{entries}
199 \ ${ffdc_file_sub_list}= Create File and Write Data ${index}
200 \ ${ffdc_file_list}= Smart Combine Lists ${ffdc_file_list}
201 ... ${ffdc_file_sub_list}
202
203 [Return] ${ffdc_file_list}
George Keishing69e6f712016-09-12 06:30:09 -0500204
205
206Create File and Write Data
Michael Walsh63b70c02017-10-30 15:02:09 -0500207 [Documentation] Run commands from FFDC_BMC_FILE to create FFDC files and
208 ... return a list of generated files.
209 [Arguments] ${key_index}
George Keishing69e6f712016-09-12 06:30:09 -0500210
Michael Walsh63b70c02017-10-30 15:02:09 -0500211 # Description of argument(s):
212 # key_index The index into the FFDC_BMC_FILE dictionary.
213
214 @{ffdc_file_list}= Create List
215 @{cmd_list}= Get FFDC BMC File ${key_index}
George Keishing69e6f712016-09-12 06:30:09 -0500216 :FOR ${cmd} IN @{cmd_list}
Michael Walsh63b70c02017-10-30 15:02:09 -0500217 \ ${logpath}= Catenate SEPARATOR= ${LOG_PREFIX} ${cmd[0]}.txt
218 \ ${ffdc_file_sub_list}= Execute Command and Write FFDC ${cmd[0]}
219 ... ${cmd[1]} ${logpath}
220 \ ${ffdc_file_list}= Smart Combine Lists ${ffdc_file_list}
221 ... ${ffdc_file_sub_list}
Sivas SRR0d657e82017-03-13 01:00:34 -0500222
Michael Walsh63b70c02017-10-30 15:02:09 -0500223 [Return] ${ffdc_file_list}
George Keishing69e6f712016-09-12 06:30:09 -0500224
225
George Keishing69e6f712016-09-12 06:30:09 -0500226# Method : Log Test Case Status #
227# Creates test result history footprint for reference #
George Keishing69e6f712016-09-12 06:30:09 -0500228
229Log Test Case Status
Jeff Whitlock7d805b22017-01-20 14:04:33 -0600230 [Documentation] Test case execution result history.
231 ... Create once and append to this file
232 ... logs/test_history.txt
233 ... Format Date:Test suite:Test case:Status
234 ... 20160909214053719992:Test Warmreset:Test WarmReset via REST:FAIL
Michael Walshfa9f70f2017-04-21 16:00:18 -0500235
236 ${FFDC_DIR_PATH_STYLE}= Get Variable Value ${FFDC_DIR_PATH_STYLE}
237 ... ${EMPTY}
238 ${FFDC_DIR_PATH}= Get Variable Value ${FFDC_DIR_PATH} ${EMPTY}
239
240 Run Keyword If '${FFDC_DIR_PATH}' == '${EMPTY}' Set FFDC Defaults
241
242 Run Keyword If '${FFDC_DIR_PATH_STYLE}' == '${1}' Run Keywords
243 ... Set Global Variable ${FFDC_LOG_PATH} ${FFDC_DIR_PATH} AND
244 ... Set Global Variable ${TEST_HISTORY} ${FFDC_DIR_PATH}test_history.txt
245
George Keishing69e6f712016-09-12 06:30:09 -0500246 Create Directory ${FFDC_LOG_PATH}
247
248 ${exist}= Run Keyword and Return Status
249 ... OperatingSystem.File Should Exist ${TEST_HISTORY}
250
251 Run Keyword If '${exist}' == '${False}'
252 ... Create File ${TEST_HISTORY}
253
Michael Walshfa9f70f2017-04-21 16:00:18 -0500254 Rpvars TEST_HISTORY
255
George Keishing69e6f712016-09-12 06:30:09 -0500256 ${cur_time}= Get Current Time Stamp
257
258 Append To File ${TEST_HISTORY}
259 ... ${cur_time}:${SUITE_NAME}:${TEST_NAME}:${TEST_STATUS}${\n}
260
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500261
262Log FFDC Get Requests
Michael Walsh63b70c02017-10-30 15:02:09 -0500263 [Documentation] Run the get requests associated with the key and return a
264 ... list of generated files.
265 [Arguments] ${key_index}
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500266
Michael Walsh63b70c02017-10-30 15:02:09 -0500267 # Note: Output will be in JSON pretty_print format.
268
269 # Description of argument(s):
270 # key_index The key to the FFDC_GET_REQUEST dictionary that contains the
271 # get requests that are to be run.
272
273 @{ffdc_file_list}= Create List
274 @{cmd_list}= Get FFDC Get Request ${key_index}
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500275 :FOR ${cmd} IN @{cmd_list}
Michael Walsh63b70c02017-10-30 15:02:09 -0500276 \ ${logpath}= Catenate SEPARATOR= ${LOG_PREFIX} ${cmd[0]}.txt
277 \ ${resp}= OpenBMC Get Request ${cmd[1]} quiet=${1}
278 \ ${status}= Run Keyword and Return Status
279 ... Should Be Equal As Strings ${resp.status_code} ${HTTP_OK}
280 \ Run Keyword If '${status}' == '${False}' Continue For Loop
281 \ ${jsondata}= to json ${resp.content} pretty_print=True
282 \ Write Data To File ${\n}${jsondata}${\n} ${logpath}
283 \ Append To List ${ffdc_file_list} ${logpath}
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500284
Michael Walsh63b70c02017-10-30 15:02:09 -0500285 [Return] ${ffdc_file_list}
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500286
287BMC FFDC Get Requests
Michael Walsh63b70c02017-10-30 15:02:09 -0500288 [Documentation] Iterate over get request list and return a list of
289 ... generated files.
290
291 @{ffdc_file_list}= Create List
292
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500293 @{entries}= Get ffdc get request index
Michael Walsh63b70c02017-10-30 15:02:09 -0500294 # Example of entries:
295 # entries:
296 # entries[0]: GET REQUESTS
Gunnar Millsa812e0f2016-09-29 20:30:03 -0500297 :FOR ${index} IN @{entries}
Michael Walsh63b70c02017-10-30 15:02:09 -0500298 \ ${ffdc_file_sub_list}= Log FFDC Get Requests ${index}
299 \ ${ffdc_file_list}= Smart Combine Lists ${ffdc_file_list}
300 ... ${ffdc_file_sub_list}
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500301
Michael Walsh63b70c02017-10-30 15:02:09 -0500302 [Return] ${ffdc_file_list}
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500303
Michael Walsh63b70c02017-10-30 15:02:09 -0500304Log OS All distros FFDC
305 [Documentation] Run commands from FFDC_OS_ALL_DISTROS_FILE to create FFDC
306 ... files and return a list of generated files.
307 [Arguments] ${key_index}
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500308
Michael Walsh63b70c02017-10-30 15:02:09 -0500309 # Description of argument(s):
310 # key_index The index into the FFDC_OS_ALL_DISTROS_FILE dictionary.
311
312 @{ffdc_file_list}= Create List
313
314 @{cmd_list}= Get FFDC OS All Distros Call ${key_index}
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500315 :FOR ${cmd} IN @{cmd_list}
Michael Walsh63b70c02017-10-30 15:02:09 -0500316 \ ${logpath}= Catenate SEPARATOR= ${LOG_PREFIX} ${cmd[0]}.txt
317 \ ${ffdc_file_sub_list}= Execute Command and Write FFDC ${cmd[0]}
318 ... ${cmd[1]} ${logpath} target=OS
319 \ ${ffdc_file_list}= Smart Combine Lists ${ffdc_file_list}
320 ... ${ffdc_file_sub_list}
321
322 [Return] ${ffdc_file_list}
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500323
324
Gunnar Millscce185d2016-10-17 17:04:15 -0500325Log OS SPECIFIC DISTRO FFDC
Michael Walsh63b70c02017-10-30 15:02:09 -0500326 [Documentation] Run commands from the FFDC_OS_<distro>_FILE to create FFDC
327 ... files and return a list of generated files.
328 [Arguments] ${key_index} ${linux_distro}
Gunnar Millscce185d2016-10-17 17:04:15 -0500329
Michael Walsh63b70c02017-10-30 15:02:09 -0500330 # Description of argument(s):
331 # key_index The index into the FFDC_OS_<distro>_FILE dictionary.
332 # linux_distro Your OS's linux distro (e.g. "UBUNTU", "RHEL", etc).
333
334 @{ffdc_file_list}= Create List
335
336 @{cmd_list}= Get FFDC OS Distro Call ${key_index} ${linux_distro}
Gunnar Millscce185d2016-10-17 17:04:15 -0500337 :FOR ${cmd} IN @{cmd_list}
Michael Walsh63b70c02017-10-30 15:02:09 -0500338 \ ${logpath}= Catenate SEPARATOR= ${LOG_PREFIX} ${cmd[0]}.txt
339 \ ${ffdc_file_sub_list}= Execute Command and Write FFDC ${cmd[0]}
340 ... ${cmd[1]} ${logpath} target=OS
341 \ ${ffdc_file_list}= Smart Combine Lists ${ffdc_file_list}
342 ... ${ffdc_file_sub_list}
343
344 [Return] ${ffdc_file_list}
Gunnar Millscce185d2016-10-17 17:04:15 -0500345
346
George Keishingca8c4c62016-10-14 10:08:40 -0500347OS FFDC Files
Michael Walsh63b70c02017-10-30 15:02:09 -0500348 [Documentation] Run the commands from FFDC_OS_ALL_DISTROS_FILE to create
349 ... FFDC files and return a list of generated files.
Gunnar Millsaca140d2016-10-26 13:05:10 -0500350 [Arguments] ${OS_HOST}=${OS_HOST} ${OS_USERNAME}=${OS_USERNAME}
Michael Walsh63b70c02017-10-30 15:02:09 -0500351 ... ${OS_PASSWORD}=${OS_PASSWORD}
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500352
Michael Walsh63b70c02017-10-30 15:02:09 -0500353 @{ffdc_file_list}= Create List
Gunnar Millsaca140d2016-10-26 13:05:10 -0500354
Michael Walsh63b70c02017-10-30 15:02:09 -0500355 Run Keyword If '${OS_HOST}' == '${EMPTY}' Run Keywords
356 ... Print Timen No OS Host provided so no OS FFDC will be done. AND
357 ... Return From Keyword ${ffdc_file_list}
Gunnar Millsaca140d2016-10-26 13:05:10 -0500358
Michael Walsh63b70c02017-10-30 15:02:09 -0500359 ${match_state}= Create Dictionary os_ping=^1$ os_login=^1$
360 ... os_run_cmd=^1$
361 ${status} ${ret_values}= Run Keyword and Ignore Error Check State
362 ... ${match_state} quiet=0
363
364 Run Keyword If '${status}' == 'FAIL' Run Keywords
Michael Walshc3b28d72017-11-16 10:43:14 -0600365 ... Print Timen The OS is not communicating so no OS FFDC will be done.\n
Michael Walsh63b70c02017-10-30 15:02:09 -0500366 ... AND
367 ... Return From Keyword ${ffdc_file_list}
Gunnar Millscce185d2016-10-17 17:04:15 -0500368
Michael Walshe53e47a2017-06-30 17:03:24 -0500369 ${stdout} ${stderr} ${rc}= OS Execute Command
370 ... . /etc/os-release; echo $ID ignore_err=${0}
371 Set Global Variable ${linux_distro} ${stdout}
Gunnar Millsaca140d2016-10-26 13:05:10 -0500372
Michael Walshe53e47a2017-06-30 17:03:24 -0500373 Rpvars linux_distro
Gunnar Millsaca140d2016-10-26 13:05:10 -0500374
Michael Walsh63b70c02017-10-30 15:02:09 -0500375 @{entries}= Get FFDC OS All Distros Index
Gunnar Mills7e2cda22016-10-11 15:37:34 -0500376 :FOR ${index} IN @{entries}
Michael Walsh63b70c02017-10-30 15:02:09 -0500377 \ ${ffdc_file_sub_list}= Log OS All distros FFDC ${index}
378 \ ${ffdc_file_list}= Smart Combine Lists ${ffdc_file_list}
379 ... ${ffdc_file_sub_list}
Gunnar Millscce185d2016-10-17 17:04:15 -0500380
Jeff Whitlock7d805b22017-01-20 14:04:33 -0600381 Return From Keyword If
382 ... '${linux_distro}' == '${EMPTY}' or '${linux_distro}' == 'None'
Michael Walsh63b70c02017-10-30 15:02:09 -0500383 ... ${ffdc_file_list}
Gunnar Millscce185d2016-10-17 17:04:15 -0500384
385 @{entries}= Get ffdc os distro index ${linux_distro}
386 :FOR ${index} IN @{entries}
Michael Walsh63b70c02017-10-30 15:02:09 -0500387 \ ${ffdc_file_sub_list}= Log OS SPECIFIC DISTRO FFDC ${index}
388 ... ${linux_distro}
389 \ ${ffdc_file_list}= Smart Combine Lists ${ffdc_file_list}
390 ... ${ffdc_file_sub_list}
391
392 [Return] ${ffdc_file_list}
George Keishing7a520222017-02-27 09:44:30 -0600393
394
Steven Sombar96de5732017-08-17 09:04:52 -0500395System Inventory Files
Michael Walsh63b70c02017-10-30 15:02:09 -0500396 [Documentation] Copy systest os_inventory files and return a list of
397 ... generated files..
Steven Sombar96de5732017-08-17 09:04:52 -0500398 # The os_inventory files are the result of running
399 # systest/htx_hardbootme_test. If these files exist
400 # they are copied to the FFDC directory.
401 # Global variable ffdc_dir_path is the path name of the
402 # directory they are copied to.
Michael Walsh63b70c02017-10-30 15:02:09 -0500403
404 @{ffdc_file_list}= Create List
405
406 ${globex}= Set Variable os_inventory_*.json
407
408 @{file_list}= OperatingSystem.List Files In Directory . ${globex}
409
410 Copy Files ${globex} ${ffdc_dir_path}
411
412 : FOR ${file_name} IN @{file_list}
413 \ Append To List ${ffdc_file_list} ${ffdc_dir_path}${file_name}
414
415 Run Keyword and Ignore Error Remove Files ${globex}
416
417 [Return] ${ffdc_file_list}
Steven Sombar96de5732017-08-17 09:04:52 -0500418
419
George Keishing7a520222017-02-27 09:44:30 -0600420SCP Coredump Files
Michael Walsh63b70c02017-10-30 15:02:09 -0500421 [Documentation] Copy core dump files from BMC to local system and return a
422 ... list of generated file names.
423
424 @{ffdc_file_list}= Create List
Michael Walshe53e47a2017-06-30 17:03:24 -0500425
George Keishing7a520222017-02-27 09:44:30 -0600426 # Check if core dump exist in the /tmp
Michael Walshe53e47a2017-06-30 17:03:24 -0500427 ${core_files} ${stderr} ${rc}= BMC Execute Command ls /tmp/core_*
Michael Walsh63b70c02017-10-30 15:02:09 -0500428 ... ignore_err=${1}
429 Run Keyword If '${rc}' != '${0}' Return From Keyword ${ffdc_file_list}
430
431 @{core_list}= Split String ${core_files}
George Keishing7a520222017-02-27 09:44:30 -0600432 # Copy the core files
Michael Walsh6bad8412017-06-27 14:09:36 -0500433 Run Key U Open Connection for SCP
George Keishing7a520222017-02-27 09:44:30 -0600434 :FOR ${index} IN @{core_list}
Michael Walsh63b70c02017-10-30 15:02:09 -0500435 \ ${ffdc_file_path}= Catenate ${LOG_PREFIX}${index.lstrip("/tmp/")}
436 \ ${status}= Run Keyword and Return Status
437 ... scp.Get File ${index} ${ffdc_file_path}
438 \ Run Keyword If '${status}' == '${False}' Continue For Loop
439 \ Append To List ${ffdc_file_list} ${ffdc_file_path}
George Keishing7a520222017-02-27 09:44:30 -0600440 # Remove the file from remote to avoid re-copying on next FFDC call
Michael Walsh63b70c02017-10-30 15:02:09 -0500441 \ BMC Execute Command rm ${index} ignore_err=${1}
Michael Walshe53e47a2017-06-30 17:03:24 -0500442 # I can't find a way to do this: scp.Close Connection
George Keishing7a520222017-02-27 09:44:30 -0600443
Michael Walsh63b70c02017-10-30 15:02:09 -0500444 [Return] ${ffdc_file_list}
445
Steven Sombar2da175f2019-02-04 10:32:58 -0600446
Sweta Potthuria82efd62017-10-18 05:34:59 -0500447SCP Dump Files
448 [Documentation] Copy all dump files from BMC to local system.
449
450 # Check if dumps exist
451 ${ffdc_file_list}= Scp Dumps ${FFDC_DIR_PATH} ${FFDC_PREFIX}
452
453 [Return] ${ffdc_file_list}
454
Steven Sombar2da175f2019-02-04 10:32:58 -0600455
Sweta Potthuria82efd62017-10-18 05:34:59 -0500456Collect Dump Log
457 [Documentation] Collect dumps from dump entry.
458 [Arguments] ${log_prefix_path}=${LOG_PREFIX}
459
Steven Sombaraaaab222018-12-19 13:16:23 -0600460 ${data}= Read Properties ${DUMP_ENTRY_URI}enumerate quiet=${1}
Sweta Potthuria82efd62017-10-18 05:34:59 -0500461
462 # Grab the list of entries from dump/entry/
463 # The data shown below is the result of the "Get Dictionary Keys".
464 # Example:
465 # /xyz/openbmc_project/dump/entry/1
466 # /xyz/openbmc_project/dump/entry/2
467
468 ${dump_list}= Get Dictionary Keys ${data}
George Keishingeb7b4bc2017-03-13 12:04:28 -0500469
Michael Walsh02c70602018-10-04 15:24:30 -0500470
Steven Sombar2da175f2019-02-04 10:32:58 -0600471Enumerate Redfish Resources
472 [Documentation] Enumerate /redfish/v1 resources and properties to
473 ... a file. Return a list which contains the file name.
474 [Arguments] ${log_prefix_path}=${LOG_PREFIX}
475
476 # Description of argument(s):
477 # log_prefix_path The location specifying where to create FFDC file(s).
478
479 # Login is needed to fetch Redfish information.
480 # If login fails, return from keyword.
George Keishing97c93942019-03-04 12:45:07 -0600481 ${status}= Run Keyword And Return Status Redfish.Login
Steven Sombar2da175f2019-02-04 10:32:58 -0600482 Return From Keyword If ${status} == ${False}
483
484 # Get the Redfish resources and properties.
George Keishingf2613b72019-02-13 12:45:59 -0600485 ${json_data}= redfish_utils.Enumerate Request /redfish/v1
Steven Sombar2da175f2019-02-04 10:32:58 -0600486 # Typical output:
487 # {
488 # "@odata.id": "/redfish/v1",
489 # "@odata.type": "#ServiceRoot.v1_1_1.ServiceRoot",
490 # "AccountService": {
491 # "@odata.id": "/redfish/v1/AccountService"
492 # },
493 # "Chassis": {
494 # "@odata.id": "/redfish/v1/Chassis"
495 # },
496 # "Id": "RootService",
497 # "JsonSchemas": {
498 # "@odata.id": "/redfish/v1/JsonSchemas"
499 # },
500 # ..etc...
501 # }
502
503 @{ffdc_file_list}= Create List
504 ${logpath}= Catenate SEPARATOR= ${log_prefix_path}
505 ... redfish_resource_properties.txt
506 Create File ${logpath}
507 Write Data To File "${\n}${json_data}${\n}" ${logpath}
508
509 Append To List ${ffdc_file_list} ${logpath}
510
511 [Return] ${ffdc_file_list}
512
513
George Keishingeb7b4bc2017-03-13 12:04:28 -0500514Collect eSEL Log
Michael Walsh02c70602018-10-04 15:24:30 -0500515 [Documentation] Create raw and formatted eSEL files.
Sridevi Rameshb180c9f2017-08-06 10:27:41 -0500516 [Arguments] ${log_prefix_path}=${LOG_PREFIX}
517
Michael Walsh02c70602018-10-04 15:24:30 -0500518 # NOTE: If no eSEL.pl program can be located, then no formatted eSEL file
519 # will be generated.
520
521 # Description of argument(s):
522 # log_prefix_path The path prefix to be used in creating
523 # eSEL file path names. For example, if
524 # log_prefix_path is
525 # "/tmp/user1/dummy.181001.120000.", then
526 # this keyword will create
527 # /tmp/user1/dummy.181001.120000.esel (raw)
528 # and
529 # /tmp/user1/dummy.181001.120000.esel.txt
530 # (formatted).
531
Michael Walsh63b70c02017-10-30 15:02:09 -0500532 @{ffdc_file_list}= Create List
533
Michael Walsh02c70602018-10-04 15:24:30 -0500534 ${esels}= Get Esels
535 ${num_esels}= Evaluate len(${esels})
536 Rprint Vars num_esels
537 Return From Keyword If ${num_esels} == ${0} ${ffdc_file_list}
George Keishingeb7b4bc2017-03-13 12:04:28 -0500538
Sridevi Rameshb180c9f2017-08-06 10:27:41 -0500539 ${logpath}= Catenate SEPARATOR= ${log_prefix_path} esel
George Keishingeb7b4bc2017-03-13 12:04:28 -0500540 Create File ${logpath}
George Keishingeb7b4bc2017-03-13 12:04:28 -0500541
Michael Walsh02c70602018-10-04 15:24:30 -0500542 :FOR ${esel} IN @{esels}
543 \ Write Data To File "${esel}"${\n} ${logpath}
George Keishingb1ca69b2017-03-31 14:36:42 -0500544
Michael Walsh63b70c02017-10-30 15:02:09 -0500545 Append To List ${ffdc_file_list} ${logpath}
Michael Walsh02c70602018-10-04 15:24:30 -0500546
547 ${rc} ${output}= Shell Cmd which eSEL.pl show_err=0
548 Return From Keyword If ${rc} != ${0} ${ffdc_file_list}
549
550 Convert eSEL To Elog Format ${logpath}
Michael Walsh0192e9b2017-11-14 15:14:15 -0600551 Append To List ${ffdc_file_list} ${logpath}.txt
Michael Walsh63b70c02017-10-30 15:02:09 -0500552
553 [Return] ${ffdc_file_list}
554
George Keishingb1ca69b2017-03-31 14:36:42 -0500555
George Keishingb1ca69b2017-03-31 14:36:42 -0500556Convert eSEL To Elog Format
557 [Documentation] Execute parser tool on the eSEL data file to generate
Michael Walsha30dac72017-04-04 17:56:23 -0500558 ... formatted error log.
George Keishingb1ca69b2017-03-31 14:36:42 -0500559 [Arguments] ${esel_file_path}
Michael Walsh02c70602018-10-04 15:24:30 -0500560 # Description of argument(s):
George Keishing7c6342b2018-11-02 14:27:13 -0500561 # esel_file_path The path to the file containing raw eSEL
Michael Walsh02c70602018-10-04 15:24:30 -0500562 # data (e.g.
563 # "/tmp/user1/dummy.181001.120000.esel").
George Keishingb1ca69b2017-03-31 14:36:42 -0500564
Michael Walsha30dac72017-04-04 17:56:23 -0500565 # Note: The only way to get eSEL.pl to put the output in a particular
566 # directory is to cd to that directory.
567 ${cmd_buf}= Catenate cd $(dirname ${esel_file_path}) ; eSEL.pl -l
568 ... ${esel_file_path} -p decode_obmc_data
Michael Walsh02c70602018-10-04 15:24:30 -0500569 Qprint Issuing ${cmd_buf}
Michael Walsha30dac72017-04-04 17:56:23 -0500570 Run ${cmd_buf}
Michael Walsh02c70602018-10-04 15:24:30 -0500571 # The .binary file, which is generated by eSEL.pl, is of no use to us.
572 Remove File ${esel_file_path}.binary