blob: a9ed9ba50c1c6b6ae564524c5a265e1e4b63176e [file] [log] [blame]
Sathyajith M S4f26ae72018-01-16 04:45:05 -06001*** Settings ***
2Documentation This is a resource file of OpenBMC ASMI It contains the
3... user-defined keywords which are available to all gui modules
4
5Library String
6Library Collections
7Library DateTime
8Library XvfbRobot
9Library OperatingSystem
10Library Selenium2Library 120 120
11Library AngularJSLibrary
12Library SSHLibrary 30 Seconds
13Library Process
14Library supporting_libs.py
Sandhya Somashekar839a0c22019-01-31 05:05:43 -060015Library ../../../lib/gen_print.py
16Library ../../../lib/gen_robot_print.py
17Library ../../../lib/gen_valid.py
18Library ../../../lib/gen_robot_ssh.py
19Library ../../../lib/bmc_ssh_utils.py
20Resource ../../../lib/resource.robot
21Resource ../../../lib/rest_client.robot
22Resource ../../../lib/state_manager.robot
Sathyajith M S4f26ae72018-01-16 04:45:05 -060023Variables ../data/resource_variables.py
24
25*** Variables ***
Sivas SRRc70e9ae2018-02-14 23:53:49 -060026${obmc_gui_url} https://${OPENBMC_HOST}
Sathyajith M S2cdab0a2018-02-13 19:36:28 -060027
Sathyajith M S4f26ae72018-01-16 04:45:05 -060028${obmc_PowerOff_state} Off
29${obmc_PowerRunning_state} Running
Sathyajith M Sf52d6fc2018-01-24 10:11:18 -060030${obmc_PowerStandby_state} Standby
Sathyajith M S4f26ae72018-01-16 04:45:05 -060031
Rahul Maheshwaridd38aef2018-11-15 23:33:10 -060032# Default GUI broswer and mode is set to "Firefox" and "headless"
33# respectively here.
34${GUI_BROWSER} ff
35${GUI_MODE} headless
36
Sathyajith M S4f26ae72018-01-16 04:45:05 -060037*** Keywords ***
38Launch OpenBMC GUI Browser
39 [Documentation] Launch the OpenBMC GUI URL on a browser.
40 # By default uses headless mode, otherwise, the GUI browser.
41
42 ${op_system}= Get Operating System
43 Run Keyword If '${op_system}' == 'windows'
Sivas SRRa0113482018-02-22 22:27:05 -060044 ... Launch Header Browser
45 ... ELSE IF '${op_system}' == 'Darwin'
46 # Mac OS is currently having some issues with firefox, so using
47 # chrome.
48 # TODO: Need to add support for other browsers. Issue #1280.
49 ... Launch Header Browser chrome
Sathyajith M S4f26ae72018-01-16 04:45:05 -060050 ... ELSE
Sivas SRRa0113482018-02-22 22:27:05 -060051 # Linux OS.
Sathyajith M S4f26ae72018-01-16 04:45:05 -060052 ... Launch Headless Browser
53
54Get Operating System
55 [Documentation] Identify platform/OS.
56
57 ${curdir_lower_case}= Convert To Lowercase ${CURDIR}
58 ${windows_platform}= Run Keyword And Return Status
59 ... Should Contain ${curdir_lower_case} c:\
60 ${op_system}= Run Keyword If '${windows_platform}' == 'True'
Sivas SRRa0113482018-02-22 22:27:05 -060061 ... Set Variable windows
62 ... ELSE
63 ... Run uname
Sathyajith M S4f26ae72018-01-16 04:45:05 -060064 [Return] ${op_system}
65
Sivas SRRa0113482018-02-22 22:27:05 -060066Launch Header Browser
Sathyajith M S4f26ae72018-01-16 04:45:05 -060067 [Documentation] Open the browser with the URL and
68 ... login on windows platform.
Rahul Maheshwaridd38aef2018-11-15 23:33:10 -060069 [Arguments] ${browser_type}=${GUI_BROWSER}
Sathyajith M S4f26ae72018-01-16 04:45:05 -060070
Sivas SRRa0113482018-02-22 22:27:05 -060071 # Description of argument(s):
72 # browser_type Type of browser (e.g. "firefox", "chrome", etc.).
Sathyajith M S2cdab0a2018-02-13 19:36:28 -060073
Sivas SRRa0113482018-02-22 22:27:05 -060074 ${BROWSER_ID}= Open Browser ${obmc_gui_url} ${browser_type}
Sathyajith M S4f26ae72018-01-16 04:45:05 -060075 Maximize Browser Window
76 Set Global Variable ${BROWSER_ID}
77
78Launch Headless Browser
79 [Documentation] Launch headless browser.
Rahul Maheshwaridd38aef2018-11-15 23:33:10 -060080 [Arguments] ${URL}=${obmc_gui_url} ${browser}=${GUI_BROWSER}
Sathyajith M S4f26ae72018-01-16 04:45:05 -060081
Rahul Maheshwari79e276c2018-06-11 01:23:15 -050082 # Description of argument(s):
83 # URL Openbmc GUI URL to be open
84 # (e.g. https://openbmc-test.mybluemix.net/#/login).
85 # browser Browser to open given URL in headless way
86 # (e.g. gc for google chrome, ff for firefox).
87
88 Start Virtual Display
89 ${browser_ID}= Open Browser ${URL}
Sathyajith M S4f26ae72018-01-16 04:45:05 -060090 Set Window Size 1920 1080
91
Rahul Maheshwari79e276c2018-06-11 01:23:15 -050092 [Return] ${browser_ID}
93
Sathyajith M S4f26ae72018-01-16 04:45:05 -060094Login OpenBMC GUI
95 [Documentation] Perform login to open BMC GUI.
96 [Arguments] ${username}=${OPENBMC_USERNAME}
97 ... ${password}=${OPENBMC_PASSWORD}
Sathyajith M S2cdab0a2018-02-13 19:36:28 -060098
Sathyajith M S4f26ae72018-01-16 04:45:05 -060099 # Description of argument(s):
100 # username The username.
101 # password The password.
102
Sivas SRRc70e9ae2018-02-14 23:53:49 -0600103 Go To ${obmc_gui_url}
Sivas SRRa6925352018-02-19 08:59:03 -0600104 Wait Until Element Is Enabled ${xpath_textbox_hostname}
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600105 Input Text ${xpath_textbox_hostname} ${OPENBMC_HOST}
106 Input Text ${xpath_textbox_username} ${username}
107 Input Password ${xpath_textbox_password} ${password}
Sivas SRRffa42692018-01-17 05:17:35 -0600108 Click Element login__submit
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600109 Wait Until Element Is Enabled ${xpath_button_logout}
Sivas SRRffa42692018-01-17 05:17:35 -0600110 Page Should Contain Server information
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600111
112
113Test Setup Execution
114 [Documentation] Verify all the preconditions to be tested.
Sathyajith M Sf52d6fc2018-01-24 10:11:18 -0600115 [Arguments] ${obmc_test_setup_state}=${OBMC_PowerOff_state}
Sathyajith M S2cdab0a2018-02-13 19:36:28 -0600116
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600117 # Description of argument(s):
118 # obmc_test_setup The OpenBMC required state.
119
120 Rprint Timen ${TEST NAME} ==> [STARTED]
Rahul Maheshwari7872f052018-06-19 01:12:34 -0500121 Launch Browser And Login OpenBMC GUI
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600122 Log To Console Verifying the system state and stablity...
Rahul Maheshwari8b5b5a42018-11-30 01:41:35 -0600123
124 Click Button ${xpath_select_server_power}
125 ${obmc_current_state}= Get Text ${xpath_power_indicator}
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600126 Rpvars obmc_current_state
Sathyajith M Sf52d6fc2018-01-24 10:11:18 -0600127
128 ${obmc_state_status}= Run Keyword And Return Status
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600129 ... Should Contain ${obmc_current_state} ${obmc_test_setup_state}
Sathyajith M Sf52d6fc2018-01-24 10:11:18 -0600130 Return From Keyword If '${obmc_state_status}' == 'True'
131
132 ${obmc_standby_state}= Run Keyword And Return Status
133 ... Should Contain ${obmc_current_state} ${obmc_standby_state}
134
135 Run Keyword If '${obmc_standby_state}' == 'True'
136 ... Reboot OpenBMC
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600137 Run Keyword If '${obmc_test_setup_state}' == '${obmc_PowerRunning_state}'
Rahul Maheshwari1ea8fec2018-12-07 12:42:04 -0600138 ... Run Keywords Power On OpenBMC AND
139 ... Wait Until Keyword Succeeds 10 min 60 sec Is Host Running
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600140 Run Keyword If '${obmc_test_setup_state}' == '${obmc_PowerOff_state}'
141 ... Power Off OpenBMC
142
143Power Off OpenBMC
144 [Documentation] Power off the OBMC system.
145
146 Log To Console Power Off OpenBMC...
147 Click Element ${xpath_display_server_power_status}
148 Execute JavaScript window.scrollTo(0, document.body.scrollHeight)
Sathyajith M Sf52d6fc2018-01-24 10:11:18 -0600149 Click Button ${xpath_select_button_orderly_shutdown}
150 Click Yes Button ${xpath_select_button_orderly_shutdown_yes}
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600151 Wait OpenBMC To Become Stable ${obmc_off_state}
152
153Power On OpenBMC
154 [Documentation] Power on the OBMC system.
155
156 Log To Console Power On OpenBMC...
157 Click Element ${xpath_display_server_power_status}
158 Click Button ${xpath_select_button_power_on }
159 Wait OpenBMC To Become Stable ${obmc_running_state}
160
161Reboot OpenBMC
162 [Documentation] Rebooting the OBMC system.
163
164 Log To Console Reboting the OpenBMC...
165 Click Element ${xpath_display_server_power_status}
Sathyajith M Sf52d6fc2018-01-24 10:11:18 -0600166 Click Button ${xpath_select_button_orderly_shutdown}
167 Click Yes Button ${xpath_select_button_orderly_shutdown_yes}
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600168 Wait OpenBMC To Become Stable ${obmc_off_state}
169
170Wait OpenBMC To Become Stable
171 [Documentation] Power off the OBMC.
Sathyajith M S2cdab0a2018-02-13 19:36:28 -0600172 [Arguments] ${obmc_expected_state} ${retry_time}=15 min
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600173 ... ${retry_interval}=45 sec
Sathyajith M S2cdab0a2018-02-13 19:36:28 -0600174
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600175 # Description of argument(s):
176 # OBMC_expected_state The OBMC state which is required for test.
177 # retry_time Total wait time after executing the command.
178 # retry_interval Time interval for to keep checking with in the
179 # above total wait time.
180
181 Wait Until Keyword Succeeds ${retry_time} ${retry_interval}
182 ... Wait Until Element Contains ${xpath_display_server_power_status}
183 ... ${obmc_expected_state}
184 Wait Until Keyword Succeeds ${retry_time} ${retry_interval}
185 ... Verify OpenBMC State From REST Interface ${obmc_expected_state}
186
187Verify OpenBMC State From REST Interface
188 [Documentation] Verify system state from REST Interface.
189 [Arguments] ${obmc_required_state}
Sathyajith M S2cdab0a2018-02-13 19:36:28 -0600190
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600191 # Description of argument(s):
192 # obmc_required_state The OBMC state which is required for test.
193
194 ${obmc_current_state_REST}= Get Host State
195 Should Be Equal ${obmc_current_state_REST} ${obmc_required_state}
196
197Click Yes Button
Sathyajith M Sf52d6fc2018-01-24 10:11:18 -0600198 [Documentation] Click the 'Yes' button.
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600199 [Arguments] ${xpath_button_yes}
Sathyajith M S2cdab0a2018-02-13 19:36:28 -0600200
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600201 # Description of argument(s):
Sathyajith M Sf52d6fc2018-01-24 10:11:18 -0600202 # xpath_button_yes The xpath of 'Yes' button.
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600203
204 Click Button ${xpath_button_yes}
205
206LogOut OpenBMC GUI
207 [Documentation] Log out of OpenBMC GUI.
208 SSHLibrary.Close All Connections
Sivas SRRae39abe2018-02-26 02:40:46 -0600209 # Passing direct id element "header" as an argument to Click Element.
Rahul Maheshwarid36b6ac2018-06-19 01:44:06 -0500210 Click Element ${xpath_button_logout}
Sathyajith M S4f26ae72018-01-16 04:45:05 -0600211 Wait Until Page Contains Element ${xpath_button_login}
212
213Test Teardown Execution
214 [Documentation] Do final closure activities of test case execution.
215 Rprint Pgm Footer
216 Print Dashes 0 100 1 =
Rahul Maheshwaricfdec852018-11-30 03:44:49 -0600217 Close Browser
Sivas SRRffa42692018-01-17 05:17:35 -0600218
Rahul Maheshwari1b5369b2018-06-11 00:57:03 -0500219
Sivas SRRffa42692018-01-17 05:17:35 -0600220Open Browser With URL
221 [Documentation] Open browser with specified URL and returns browser id.
Rahul Maheshwaridd38aef2018-11-15 23:33:10 -0600222 [Arguments] ${URL} ${browser}=ff ${mode}=${GUI_MODE}
Sathyajith M S2cdab0a2018-02-13 19:36:28 -0600223
Sivas SRRffa42692018-01-17 05:17:35 -0600224 # Description of argument(s):
225 # URL Openbmc GUI URL to be open
Rahul Maheshwari79e276c2018-06-11 01:23:15 -0500226 # (e.g. https://openbmc-test.mybluemix.net/#/login).
227 # browser Browser used to open above URL
228 # (e.g. gc for google chrome, ff for firefox).
229 # mode Browser opening mode(e.g. headless, header).
Sathyajith M S2cdab0a2018-02-13 19:36:28 -0600230
Rahul Maheshwari79e276c2018-06-11 01:23:15 -0500231 ${browser_ID}= Run Keyword If '${mode}' == 'headless'
232 ... Launch Headless Browser ${URL} ${browser}
233 ... ELSE Open Browser ${URL} ${browser}
234
Sivas SRRffa42692018-01-17 05:17:35 -0600235 [Return] ${browser_ID}
236
Rahul Maheshwari1b5369b2018-06-11 00:57:03 -0500237
Sivas SRRffa42692018-01-17 05:17:35 -0600238Model Server Power Click Button
239 [Documentation] Click main server power in the header section.
240 [Arguments] ${div_element} ${anchor_element}
Sathyajith M S2cdab0a2018-02-13 19:36:28 -0600241
Sivas SRRffa42692018-01-17 05:17:35 -0600242 # Description of argument(s):
243 # div_element Server power header divisional element
244 # (e.g. header_wrapper.)
245 # anchor_element Server power header anchor element
246 # (e.g. header_wrapper_elt.)
Sathyajith M S2cdab0a2018-02-13 19:36:28 -0600247
Sivas SRRffa42692018-01-17 05:17:35 -0600248 Wait Until Element Is Visible
249 ... //*[@id='header__wrapper']/div/div[${div_element}]/a[${anchor_element}]/span
250 Click Element
251 ... //*[@id='header__wrapper']/div/div[${div_element}]/a[${anchor_element}]/span
252
253Controller Server Power Click Button
254 [Documentation] Click main server power in the header section.
255 [Arguments] ${controller_element}
Sathyajith M S2cdab0a2018-02-13 19:36:28 -0600256
Sivas SRRffa42692018-01-17 05:17:35 -0600257 # Description of argument(s):
258 # controller_element Server power controller element
259 # (e.g. power__power-on.)
260
Rahul Maheshwaridbbf1792018-10-31 05:36:29 -0500261 Click Element ${xpath_select_server_power}
Sivas SRRffa42692018-01-17 05:17:35 -0600262 Wait Until Element Is Visible ${controller_element}
263 Page Should Contain Button ${controller_element}
264 Click Element ${controller_element}
265
266Controller Power Operations Confirmation Click Button
267 [Documentation] Click Common Power Operations Confirmation.
268 [Arguments] ${main_element} ${sub_element} ${confirm_msg_elt} ${confirmation}
Sathyajith M S2cdab0a2018-02-13 19:36:28 -0600269
Sivas SRRffa42692018-01-17 05:17:35 -0600270 # Description of argument(s):
271 # main_element Server power operations element
272 # (e.g. power_operations.)
273 # sub_element Server power operations sub element
274 # (e.g. warm_boot, shut_down.)
275 # confirm_msg_elt Server power operations confirm message element
276 # (e.g. confirm_msg.)
277 # confirmation Server power operations confirmation
278 # (e.g. yes.)
279
Joy Onyerikwuf4a807b2018-06-20 08:43:54 -0500280 ${element_path}= Catenate //*[@id='power-operations']/div[${main_element}]/div[${sub_element}]
281 ... /confirm/div/div[${confirm_msg_elt}]/button[${confirmation}]
282 Click Element ${element_path.replace(" ","")}
283
Sivas SRRffa42692018-01-17 05:17:35 -0600284
285GUI Power On
Sathyajith M Sf52d6fc2018-01-24 10:11:18 -0600286 [Documentation] Power on the host using GUI.
Sivas SRRffa42692018-01-17 05:17:35 -0600287
288 Model Server Power Click Button ${header_wrapper} ${header_wrapper_elt}
289 Page Should Contain Attempts to power on the server
290 Controller Server Power Click Button power__power-on
291 Page Should Contain Running
292
Sathyajith M Sf52d6fc2018-01-24 10:11:18 -0600293Verify Display Content
294 [Documentation] Verify text content display.
295 [Arguments] ${display_text}
296
297 # Description of argument(s):
298 # display_text The text which is expected to be found on the web page.
299
300 Page Should Contain ${display_text}
301
302Warm Reboot openBMC
303 [Documentation] Warm reboot the OBMC system.
304
305 Log To Console Warm Reboting the OpenBMC...
306 Click Element ${xpath_select_button_warm_reboot}
307 Verify Warning Message Display Text ${xpath_warm_reboot_warning_message}
308 ... ${text_warm_reboot_warning_message}
309 Click Yes Button ${xpath_select_button_warm_reboot_yes}
310 Wait OpenBMC To Become Stable ${obmc_running_state}
311
312Click No Button
313 [Documentation] Click the 'No' button.
314 [Arguments] ${xpath_button_no}
315
316 # Description of argument(s):
317 # xpath_button_no The xpath of 'No' button.
318
319 Click Button ${xpath_button_no}
320
321Cold Reboot openBMC
322 [Documentation] Cold reboot the OBMC system.
323
324 Log To Console Cold Reboting the OpenBMC...
325 Click Element ${xpath_select_button_cold_reboot}
326 Verify Warning Message Display Text ${xpath_cold_reboot_warning_message}
327 ... ${text_cold_reboot_warning_message}
328 Click Yes Button ${xpath_select_button_cold_reboot_yes}
329 Wait OpenBMC To Become Stable ${obmc_running_state}
330
331Orderly Shutdown OpenBMC
332 [Documentation] Do orderly shutdown the OBMC system.
333
334 Log To Console Orderly Shutdown the OpenBMC...
335 Click Element ${xpath_select_button_orderly_shutdown}
336 Verify Warning Message Display Text ${xpath_orderly_shutdown_warning_message}
337 ... ${text_orderly_shutdown_warning_message}
338 Click Yes Button ${xpath_select_button_orderly_shutdown_yes}
339 Wait OpenBMC To Become Stable ${obmc_off_state}
340
341Immediate Shutdown openBMC
342 [Documentation] Do immediate shutdown the OBMC system.
343
344 Log To Console Immediate Shutdown the OpenBMC...
345 Click Element ${xpath_select_button_immediate_shutdown}
346 Verify Warning Message Display Text
347 ... ${xpath_immediate_shutdown_warning_message}
348 ... ${text_immediate_shutdown_warning_message}
349 Click Yes Button ${xpath_select_button_immediate_shutdown_yes}
350 Wait OpenBMC To Become Stable ${obmc_off_state}
351
352Verify Warning Message Display Text
353 [Documentation] Verify the warning message display text.
354 [Arguments] ${xpath_text_message} ${text_message}
355
356 # xpath_text_message Xpath of warning message display.
357 # text_message Content of the display message info.
358
359 Element Text Should Be ${xpath_text_message} ${text_message}
Sivas SRRca534e62018-02-20 02:22:02 -0600360
361
362Expected Initial Test State
363 [Documentation] Power on the host if "Running" expected, Power off the
364 ... host if "Off" expected as per the requirement of initial test state.
365 [Arguments] ${expectedState}
366 # Description of argument(s):
367 # expectedState Test initial host state.
368
369 Run Keyword If '${expectedState}' == 'Running'
Rahul Maheshwari23491692018-11-09 03:42:41 -0600370 ... REST Power On stack_mode=skip quiet=1
Sivas SRRca534e62018-02-20 02:22:02 -0600371
372 Run Keyword If '${expectedState}' == 'Off'
Rahul Maheshwari23491692018-11-09 03:42:41 -0600373 ... REST Power Off stack_mode=skip quiet=1
Sivas SRR008dcc62018-02-27 06:34:56 -0600374
375Launch Browser And Login OpenBMC GUI
376 [Documentation] Launch browser and log into openbmc GUI.
377
378 Open Browser With URL ${obmc_gui_url}
379 Login OpenBMC GUI ${OPENBMC_USERNAME} ${OPENBMC_PASSWORD}
380
381Logout And Close Browser
382 [Documentation] Logout from openbmc application and close the browser.
383
Rahul Maheshwari1a6945e2018-11-26 03:21:40 -0600384 Click Element //*[text()='Log out']
Sivas SRR008dcc62018-02-27 06:34:56 -0600385 Close Browser