blob: 7ea68925b918df33e344011b73cd7e7de0ff9db2 [file] [log] [blame]
Chris Austenb29d2e82016-06-07 12:25:35 -05001*** Settings ***
George Keishing4d6c1da2016-07-15 05:51:22 -05002Documentation This module is for IPMI client for copying ipmitool to
Sivas SRRa2dab3c2016-07-25 05:08:18 -05003... openbmc box and execute ipmitool IPMI standard
4... command. IPMI raw command will use dbus-send command
Chris Austenb29d2e82016-06-07 12:25:35 -05005Resource ../lib/resource.txt
George Keishing4d6c1da2016-07-15 05:51:22 -05006Resource ../lib/connection_client.robot
Prashanth Kattiae7c2282017-03-15 07:43:46 -05007Resource ../lib/utils.robot
8Resource ../lib/state_manager.robot
9
Sivas SRRa2dab3c2016-07-25 05:08:18 -050010Library String
11
12*** Variables ***
George Keishingd7f11f72017-01-04 10:58:19 -060013${dbusHostIpmicmd1}= dbus-send --system ${OPENBMC_BASE_URI}HostIpmi/1
14${dbusHostIpmiCmdReceivedMsg}= ${OPENBMC_BASE_DBUS}.HostIpmi.ReceivedMessage
Gunnar Mills59204d22016-12-06 11:05:19 -060015${netfnByte}= ${EMPTY}
George Keishingd7f11f72017-01-04 10:58:19 -060016${cmdByte}= ${EMPTY}
Gunnar Mills59204d22016-12-06 11:05:19 -060017${arrayByte}= array:byte:
Michael Walsha7913892017-04-20 16:29:01 -050018${IPMI_EXT_CMD}= ipmitool -I lanplus -C 3
19${IPMI_USER_OPTIONS} ${EMPTY}
Prashanth Kattiae7c2282017-03-15 07:43:46 -050020${IPMI_INBAND_CMD}= ipmitool -C 3
Gunnar Mills59204d22016-12-06 11:05:19 -060021${HOST}= -H
22${RAW}= raw
Chris Austenb29d2e82016-06-07 12:25:35 -050023
24*** Keywords ***
Rahul Maheshwari7a212a02016-09-05 21:17:30 -050025
Chris Austenb29d2e82016-06-07 12:25:35 -050026Run IPMI Command
Prashanth Kattiae7c2282017-03-15 07:43:46 -050027 [Arguments] ${args}
28 ${resp}= Run Keyword If '${IPMI_COMMAND}' == 'External'
29 ... Run External IPMI RAW Command ${args}
30 ... ELSE IF '${IPMI_COMMAND}' == 'Inband'
31 ... Run Inband IPMI RAW Command ${args}
32 ... ELSE IF '${IPMI_COMMAND}' == 'Dbus'
33 ... Run Dbus IPMI RAW Command ${args}
34 ... ELSE Fail msg=Invalid IPMI Command type provided : ${IPMI_COMMAND}
35 [Return] ${resp}
Rahul Maheshwari7a212a02016-09-05 21:17:30 -050036
37Run IPMI Standard Command
Prashanth Kattiae7c2282017-03-15 07:43:46 -050038 [Arguments] ${args}
39 ${resp}= Run Keyword If '${IPMI_COMMAND}' == 'External'
40 ... Run External IPMI Standard Command ${args}
41 ... ELSE IF '${IPMI_COMMAND}' == 'Inband'
42 ... Run Inband IPMI Standard Command ${args}
43 ... ELSE IF '${IPMI_COMMAND}' == 'Dbus'
44 ... Run Dbus IPMI Standard Command ${args}
45 ... ELSE Fail msg=Invalid IPMI Command type provided : ${IPMI_COMMAND}
Rahul Maheshwari7a212a02016-09-05 21:17:30 -050046
Prashanth Kattiae7c2282017-03-15 07:43:46 -050047 [Return] ${resp}
Rahul Maheshwari7a212a02016-09-05 21:17:30 -050048
49Run Dbus IPMI RAW Command
Gunnar Mills38032802016-12-12 13:43:40 -060050 [Arguments] ${args}
Gunnar Mills59204d22016-12-06 11:05:19 -060051 ${valueinBytes}= Byte Conversion ${args}
52 ${cmd}= Catenate ${dbushostipmicmd1} ${dbusHostIpmiCmdReceivedMsg}
53 ${cmd}= Catenate ${cmd} ${valueinBytes}
Sivas SRRa2dab3c2016-07-25 05:08:18 -050054 ${output} ${stderr}= Execute Command ${cmd} return_stderr=True
55 Should Be Empty ${stderr}
Chris Austenb29d2e82016-06-07 12:25:35 -050056 set test variable ${OUTPUT} "${output}"
57
Rahul Maheshwari7a212a02016-09-05 21:17:30 -050058Run Dbus IPMI Standard Command
Gunnar Mills38032802016-12-12 13:43:40 -060059 [Arguments] ${args}
George Keishing4d6c1da2016-07-15 05:51:22 -050060 Copy ipmitool
Rahul Maheshwari7a212a02016-09-05 21:17:30 -050061 ${stdout} ${stderr} ${output}= Execute Command
62 ... /tmp/ipmitool -I dbus ${args} return_stdout=True
63 ... return_stderr= True return_rc=True
Chris Austenb29d2e82016-06-07 12:25:35 -050064 Should Be Equal ${output} ${0} msg=${stderr}
Gunnar Millsc9ea9362016-12-13 16:21:13 -060065 [Return] ${stdout}
Chris Austenb29d2e82016-06-07 12:25:35 -050066
Prashanth Kattiae7c2282017-03-15 07:43:46 -050067Run Inband IPMI Raw Command
68 [Documentation] Run Inband IPMI raw command.
69 [Arguments] ${args} ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
70 ... ${os_password}=${OS_PASSWORD}
71
72 # Desription of arguments:
73 # ${args} parameters to IPMI command.
74 # ${os_host} IP address of the OS Host.
75 # ${os_username} OS Host Login user name.
76 # ${os_password} OS Host Login passwrd.
77
78 Login To OS Host ${os_host} ${os_username} ${os_password}
79 Check If IPMI Tool Exist
80
81 ${inband_raw_cmd}= Catenate ${IPMI_INBAND_CMD} ${RAW} ${args}
82 ${stdout} ${stderr}= Execute Command ${inband_raw_cmd} return_stderr=True
83 Should Be Empty ${stderr} msg=${stdout}
84 [Return] ${stdout}
85
86Run Inband IPMI Standard Command
87 [Documentation] Run Inband IPMI standard command.
88 [Arguments] ${args} ${os_host}=${OS_HOST} ${os_username}=${OS_USERNAME}
89 ... ${os_password}=${OS_PASSWORD}
90
91 # Desription of arguments:
92 # ${args} parameters to IPMI command.
93 # ${os_host} IP address of the OS Host.
94 # ${os_username} OS Host Login user name.
95 # ${os_password} OS Host Login passwrd.
96
97 Login To OS Host ${os_host} ${os_username} ${os_password}
98 Check If IPMI Tool Exist
99
100 ${inband_std_cmd}= Catenate ${IPMI_INBAND_CMD} ${args}
101 ${stdout} ${stderr}= Execute Command ${inband_std_cmd} return_stderr=True
102 Should Be Empty ${stderr} msg=${stdout}
103 [Return] ${stdout}
104
Rahul Maheshwari7a212a02016-09-05 21:17:30 -0500105Run External IPMI RAW Command
Gunnar Mills38032802016-12-12 13:43:40 -0600106 [Arguments] ${args}
Rahul Maheshwari7a212a02016-09-05 21:17:30 -0500107 ${ipmi_raw_cmd}= Catenate SEPARATOR=
Michael Walsha7913892017-04-20 16:29:01 -0500108 ... ${IPMI_EXT_CMD} -P${SPACE}${IPMI_PASSWORD}${SPACE}
Rahul Maheshwari7a212a02016-09-05 21:17:30 -0500109 ... ${HOST}${SPACE}${OPENBMC_HOST}${SPACE}${RAW}${SPACE}${args}
110 ${rc} ${output}= Run and Return RC and Output ${ipmi_raw_cmd}
111 Should Be Equal ${rc} ${0} msg=${output}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600112 [Return] ${output}
Rahul Maheshwari7a212a02016-09-05 21:17:30 -0500113
114Run External IPMI Standard Command
Gunnar Mills38032802016-12-12 13:43:40 -0600115 [Arguments] ${args}
Michael Walsha7913892017-04-20 16:29:01 -0500116
117 ${ipmi_cmd}= Catenate SEPARATOR=
118 ... ${IPMI_EXT_CMD} ${IPMI_USER_OPTIONS} -P${SPACE}${IPMI_PASSWORD}
119 ... ${SPACE}${HOST}${SPACE}${OPENBMC_HOST}${SPACE}${args}
Rahul Maheshwari04a22042017-05-02 01:54:31 -0500120 ${rc} ${output}= Run And Return RC and Output ${ipmi_cmd}
Michael Walsha7913892017-04-20 16:29:01 -0500121 Should Be Equal ${rc} ${0} msg=${output}
122 [Return] ${output}
Rahul Maheshwari7a212a02016-09-05 21:17:30 -0500123
Prashanth Kattiae7c2282017-03-15 07:43:46 -0500124Check If IPMI Tool Exist
125 [Documentation] Check if IPMI Tool installed or not.
126 ${output}= Execute Command which ipmitool
127 Should Not Be Empty ${output} msg=ipmitool not installed.
Rahul Maheshwari7a212a02016-09-05 21:17:30 -0500128
Rahul Maheshwari04a22042017-05-02 01:54:31 -0500129
130Activate SOL Via IPMI
131 [Documentation] Start SOL using IPMI and route output to a file.
132 [Arguments] ${file_path}=/tmp/sol_${OPENBMC_HOST}
133 # Description of argument(s):
134 # file_path The file path on the local machine (vs OBMC) to collect SOL
135 # output. By default SOL output is collected at
136 # /tmp/sol_<BMC_IP> else user input location.
137
138 ${ipmi_cmd}= Catenate SEPARATOR=
Rahul Maheshwaric8470882017-08-30 05:41:16 -0500139 ... ${IPMI_EXT_CMD} -P${SPACE}${IPMI_PASSWORD}${SPACE}${HOST}
140 ... ${SPACE}${OPENBMC_HOST}${SPACE}sol activate usesolkeepalive
Rahul Maheshwari04a22042017-05-02 01:54:31 -0500141
George Keishing2102f6b2017-06-06 08:30:10 -0500142 Start Process ${ipmi_cmd} shell=True stdout=${file_path}
Rahul Maheshwari4f360842017-06-06 15:05:01 -0500143 ... alias=sol_proc
Rahul Maheshwari04a22042017-05-02 01:54:31 -0500144
145
146Deactivate SOL Via IPMI
147 [Documentation] Stop SOL using IPMI and return SOL output.
148 [Arguments] ${file_path}=/tmp/sol_${OPENBMC_HOST}
149 # Description of argument(s):
150 # file_path The file path on the local machine to copy SOL output
151 # collected by above "Activate SOL Via IPMI" keyword.
152 # By default it copies log from /tmp/sol_<BMC_IP>.
153
154 ${ipmi_cmd}= Catenate SEPARATOR=
155 ... ${IPMI_EXT_CMD} -P${SPACE}${IPMI_PASSWORD}${SPACE}
156 ... ${HOST}${SPACE}${OPENBMC_HOST}${SPACE}sol deactivate
157
158 ${rc} ${output}= Run and Return RC and Output ${ipmi_cmd}
Rahul Maheshwari4f360842017-06-06 15:05:01 -0500159 Run Keyword If ${rc} > 0 Run Keywords
Rahul Maheshwari7f48a2c2017-06-16 04:00:26 -0500160 ... Run Keyword And Ignore Error Terminate Process sol_proc
161 ... AND Return From Keyword ${output}
Rahul Maheshwari04a22042017-05-02 01:54:31 -0500162
163 ${rc} ${output}= Run and Return RC and Output cat ${file_path}
164 Should Be Equal ${rc} ${0} msg=${output}
165
166 # Logging SOL output for debug purpose.
167 Log ${output}
168
169 [Return] ${output}
170
171
Sivas SRRa2dab3c2016-07-25 05:08:18 -0500172Byte Conversion
173 [Documentation] Byte Conversion method receives IPMI RAW commands as
174 ... argument in string format.
175 ... Sample argument is as follows
176 ... "0x04 0x30 9 0x01 0x00 0x35 0x00 0x00 0x00 0x00 0x00
177 ... 0x00"
178 ... IPMI RAW command format is as follows
179 ... <netfn Byte> <cmd Byte> <Data Bytes..>
180 ... This method converts IPMI command format into
181 ... dbus command format as follows
182 ... <byte:seq-id> <byte:netfn> <byte:lun> <byte:cmd>
183 ... <array:byte:data>
184 ... Sample dbus Host IPMI Received Message argument
185 ... byte:0x00 byte:0x04 byte:0x00 byte:0x30
186 ... array:byte:9,0x01,0x00,0x35,0x00,0x00,0x00,0x00,0x00,0x00
Gunnar Mills38032802016-12-12 13:43:40 -0600187 [Arguments] ${args}
Gunnar Mills59204d22016-12-06 11:05:19 -0600188 ${argLength}= Get Length ${args}
Sivas SRRa2dab3c2016-07-25 05:08:18 -0500189 Set Global Variable ${arrayByte} array:byte:
Gunnar Mills59204d22016-12-06 11:05:19 -0600190 @{listargs}= Split String ${args}
191 ${index}= Set Variable ${0}
Sivas SRRa2dab3c2016-07-25 05:08:18 -0500192 :FOR ${word} in @{listargs}
193 \ Run Keyword if ${index} == 0 Set NetFn Byte ${word}
194 \ Run Keyword if ${index} == 1 Set Cmd Byte ${word}
195 \ Run Keyword if ${index} > 1 Set Array Byte ${word}
Gunnar Mills59204d22016-12-06 11:05:19 -0600196 \ ${index}= Set Variable ${index + 1}
197 ${length}= Get Length ${arrayByte}
198 ${length}= Evaluate ${length} - 1
199 ${arrayByteLocal}= Get Substring ${arrayByte} 0 ${length}
Sivas SRRa2dab3c2016-07-25 05:08:18 -0500200 Set Global Variable ${arrayByte} ${arrayByteLocal}
Gunnar Mills59204d22016-12-06 11:05:19 -0600201 ${valueinBytesWithArray}= Catenate byte:0x00 ${netfnByte} byte:0x00
202 ${valueinBytesWithArray}= Catenate ${valueinBytesWithArray} ${cmdByte}
203 ${valueinBytesWithArray}= Catenate ${valueinBytesWithArray} ${arrayByte}
204 ${valueinBytesWithoutArray}= Catenate byte:0x00 ${netfnByte} byte:0x00
205 ${valueinBytesWithoutArray}= Catenate ${valueinBytesWithoutArray} ${cmdByte}
Sivas SRRa2dab3c2016-07-25 05:08:18 -0500206# To Check scenario for smaller IPMI raw commands with only 2 arguments
207# instead of usual 12 arguments.
208# Sample small IPMI raw command: Run IPMI command 0x06 0x36
209# If IPMI raw argument length is only 9 then return value in bytes without
210# array population.
211# Equivalent dbus-send argument for smaller IPMI raw command:
212# byte:0x00 byte:0x06 byte:0x00 byte:0x36
213 Run Keyword if ${argLength} == 9 Return from Keyword ${valueinBytesWithoutArray}
Gunnar Millsc9ea9362016-12-13 16:21:13 -0600214 [Return] ${valueinBytesWithArray}
Sivas SRRa2dab3c2016-07-25 05:08:18 -0500215
216
217Set NetFn Byte
Gunnar Mills38032802016-12-12 13:43:40 -0600218 [Arguments] ${word}
Gunnar Mills59204d22016-12-06 11:05:19 -0600219 ${netfnByteLocal}= Catenate byte:${word}
Sivas SRRa2dab3c2016-07-25 05:08:18 -0500220 Set Global Variable ${netfnByte} ${netfnByteLocal}
221
222Set Cmd Byte
Gunnar Mills38032802016-12-12 13:43:40 -0600223 [Arguments] ${word}
Gunnar Mills59204d22016-12-06 11:05:19 -0600224 ${cmdByteLocal}= Catenate byte:${word}
Sivas SRRa2dab3c2016-07-25 05:08:18 -0500225 Set Global Variable ${cmdByte} ${cmdByteLocal}
226
227Set Array Byte
Gunnar Mills38032802016-12-12 13:43:40 -0600228 [Arguments] ${word}
Gunnar Mills59204d22016-12-06 11:05:19 -0600229 ${arrayByteLocal}= Catenate SEPARATOR= ${arrayByte} ${word}
230 ${arrayByteLocal}= Catenate SEPARATOR= ${arrayByteLocal} ,
Sivas SRRa2dab3c2016-07-25 05:08:18 -0500231 Set Global Variable ${arrayByte} ${arrayByteLocal}
232
Chris Austenb29d2e82016-06-07 12:25:35 -0500233Copy ipmitool
234 OperatingSystem.File Should Exist tools/ipmitool msg=The ipmitool program could not be found in the tools directory. It is not part of the automation code by default. You must manually copy or link the correct openbmc version of the tool in to the tools directory in order to run this test suite.
235
236 Import Library SCPLibrary WITH NAME scp
237 scp.Open connection ${OPENBMC_HOST} username=${OPENBMC_USERNAME} password=${OPENBMC_PASSWORD}
238 scp.Put File tools/ipmitool /tmp
239 SSHLibrary.Open Connection ${OPENBMC_HOST}
240 Login ${OPENBMC_USERNAME} ${OPENBMC_PASSWORD}
241 Execute Command chmod +x /tmp/ipmitool
Sridevi Ramesh0c34f692017-04-25 02:40:32 -0500242
243Initiate Host Boot Via External IPMI
244 [Documentation] Initiate host power on using external IPMI.
Rahul Maheshwari982fee42017-05-03 00:33:15 -0500245 [Arguments] ${wait}=${1}
246 # Description of argument(s):
247 # wait Indicates that this keyword should wait for host running state.
248
Sridevi Ramesh0c34f692017-04-25 02:40:32 -0500249 ${output}= Run External IPMI Standard Command chassis power on
250 Should Not Contain ${output} Error
Rahul Maheshwari982fee42017-05-03 00:33:15 -0500251
252 Run Keyword If '${wait}' == '${0}' Return From Keyword
253 Wait Until Keyword Succeeds 10 min 10 sec Is Host Running
Sridevi Ramesh0c34f692017-04-25 02:40:32 -0500254
255Initiate Host PowerOff Via External IPMI
256 [Documentation] Initiate host power off using external IPMI.
Rahul Maheshwari982fee42017-05-03 00:33:15 -0500257 [Arguments] ${wait}=${1}
258 # Description of argument(s):
259 # wait Indicates that this keyword should wait for host off state.
260
Sridevi Ramesh0c34f692017-04-25 02:40:32 -0500261 ${output}= Run External IPMI Standard Command chassis power off
262 Should Not Contain ${output} Error
Rahul Maheshwari982fee42017-05-03 00:33:15 -0500263
264 Run Keyword If '${wait}' == '${0}' Return From Keyword
265 Wait Until Keyword Succeeds 3 min 10 sec Is Host Off
266
267Get Host State Via External IPMI
268 [Documentation] Returns host state using external IPMI.
269
270 ${output}= Run External IPMI Standard Command chassis power status
271 Should Not Contain ${output} Error
272 ${output}= Fetch From Right ${output} ${SPACE}
273
274 [Return] ${output}