gui/lib/gui_resource.robot

*** Settings ***
Documentation  This is a resource file containing user-defined keywords for new Vue based OpenBMC GUI.

Library        XvfbRobot
Library        SeleniumLibrary
Library        SSHLibrary  30 Seconds
Resource       ../../lib/state_manager.robot
Variables      ../data/gui_variables.py


*** Variables ***
${OPENBMC_GUI_URL}            https://${OPENBMC_HOST}:${HTTPS_PORT}
${xpath_power_page}           //*[@data-test-id='appHeader-container-power']
${xpath_power_shutdown}       //*[@data-test-id='serverPowerOperations-button-shutDown']
${xpath_power_power_on}       //*[@data-test-id='serverPowerOperations-button-powerOn']
${xpath_power_reboot}         //*[@data-test-id='serverPowerOperations-button-reboot']
${xpath_confirm}              //button[contains(text(),'Confirm')]

# Default GUI browser and mode is set to "Firefox" and "headless"
# respectively here.
${GUI_BROWSER}               ff
${GUI_MODE}                  headless


*** Keywords ***

Open Browser With URL
    [Documentation]  Open browser with specified URL and returns browser id.
    [Arguments]  ${URL}  ${browser}=ff  ${mode}=${GUI_MODE}

    # Description of argument(s):
    # URL      Openbmc GUI URL to be open
    #          (e.g. https://openbmc-test.mybluemix.net/#/login).
    # browser  Browser used to open above URL
    #          (e.g. gc for google chrome, ff for firefox).
    # mode     Browser opening mode(e.g. headless, header).

    IF  '${mode}' == 'headless'
       ${browser_ID}=  Launch Headless Browser  ${URL}  ${browser}
    ELSE
       ${browser_ID}=  Open Browser  ${URL}  ${browser}
    END
    RETURN  ${browser_ID}


Launch Header Browser
    [Documentation]  Open the browser with the URL and
    ...              login on windows platform.
    [Arguments]  ${browser_type}=${GUI_BROWSER}

    # Description of argument(s):
    # browser_type  Type of browser (e.g. "firefox", "chrome", etc.).

    ${BROWSER_ID}=  Open Browser  ${OPENBMC_GUI_URL}  ${browser_type}
    Maximize Browser Window
    Set Global Variable  ${BROWSER_ID}


Launch Headless Browser
    [Documentation]  Launch headless browser.
    [Arguments]  ${URL}=${OPENBMC_GUI_URL}  ${browser}=${GUI_BROWSER}

    # Description of argument(s):
    # URL      Openbmc GUI URL to be open
    #          (e.g. https://openbmc-test.mybluemix.net/#/login).
    # browser  Browser to open given URL in headless way
    #          (e.g. gc for google chrome, ff for firefox).

    Start Virtual Display
    ${browser_ID}=  Open Browser  ${URL}    ${browser}
    Set Window Size  1920  1080

    RETURN  ${browser_ID}


Launch Browser And Login GUI
    [Documentation]  Launch browser and login to OpenBMC GUI, retry 2 attempts
    ...              in 1 minute time.

    Wait Until Keyword Succeeds  195 sec   65 sec  Retry Browser Login Attempts


Retry Browser Login Attempts
    [Documentation]  Launch browser and login to OpenBMC GUI.

    Open Browser With URL  ${OPENBMC_GUI_URL}
    Login GUI  ${OPENBMC_USERNAME}  ${OPENBMC_PASSWORD}


Login GUI
    [Documentation]  Login to OpenBMC GUI.
    [Arguments]  ${username}=${OPENBMC_USERNAME}  ${password}=${OPENBMC_PASSWORD}

    # Description of argument(s):
    # username  The username to be used for login.
    # password  The password to be used for login.

    Go To  ${OPENBMC_GUI_URL}
    Wait Until Element Is Enabled  ${xpath_login_username_input}
    Input Text  ${xpath_login_username_input}  ${username}
    Input Password  ${xpath_login_password_input}  ${password}
    Wait Until Element Is Enabled  ${xpath_login_button}
    Click Element  ${xpath_login_button}
    Wait Until Page Contains  Operations  timeout=60s
    Wait Until Element Is Not Visible
    ...  ${xpath_page_loading_progress_bar}  timeout=120s


Launch Browser And Login GUI With Given User
    [Documentation]  Launch browser and login eBMC with specified user
    ...  credentials through GUI.
    [Arguments]  ${user_name}  ${user_password}

    # Description of argument(s):
    # user_name        User name to login to eBMC.
    # user_password    User password to login to eBMC.

    Open Browser With URL  ${OPENBMC_GUI_URL}
    LOGIN GUI  ${user_name}  ${user_password}


Logout GUI
    [Documentation]  Logout of OpenBMC GUI.

    Click Element  ${xpath_root_button_menu}
    Click Element  ${xpath_logout_button}
    Wait Until Page Contains Element  ${xpath_login_button}


Generate Test Error Log
    [Documentation]  Generate test error log.

    BMC Execute Command  ${CMD_UNRECOVERABLE_ERROR}


Set Timezone In Profile Settings Page
    [Documentation]  Set the given timezone in profile settings page.
    [Arguments]  ${timezone}=Default

    # Description of argument(s):
    # timezone  Timezone to select (eg. Default or Browser_offset).

    Wait Until Page Contains Element  ${xpath_root_button_menu}
    Click Element  ${xpath_root_button_menu}
    Click Element  ${xpath_profile_settings}
    Click Element At Coordinates  ${xpath_default_UTC}  0  0
    Click Element  ${xpath_profile_save_button}


Refresh GUI
    [Documentation]  Refresh GUI via refresh button in header.

    Click Element  ${xpath_refresh_button}
    # Waiting for  page to load fully after refresh.
    Wait Until Element Is Not Visible   ${xpath_page_loading_progress_bar}  timeout=120s


Refresh GUI And Verify Element Value
    [Documentation]  Refresh GUI using refresh button and verify that given element contains expected value.
    [Arguments]  ${element}  ${expected_value}

    # Description of argument(s):
    # element         Element whose value need to be checked.
    # expected_value  Expected value of for the given element.

    # Refresh GUI.
    Refresh GUI

    # Check element value and verify that it contains expected value.
    ${element_value}=  Get Text  ${element}
    Log  ${element_value}
    Should Contain  ${element_value}  ${expected_value}


Reboot BMC via GUI
    [Documentation]  Reboot BMC via GUI.

    Click Element  ${xpath_operations_menu}
    Click Element  ${xpath_reboot_bmc_sub_menu}
    Click Button  ${xpath_reboot_bmc_button}
    Wait Until Keyword Succeeds  30 sec  10 sec  Click Button  ${xpath_confirm_bmc_reboot}
    Wait Until Keyword Succeeds  2 min  10 sec  Is BMC Unpingable
    Wait For Host To Ping  ${OPENBMC_HOST}  1 min


Add DNS Servers And Verify
    [Documentation]  Login to GUI Network page,add DNS server on BMC
    ...  and verify it via BMC CLI.
    [Arguments]  ${dns_server}   ${expected_status}=Valid format

    # Description of the argument(s):
    # dns_server           A list of static name server IPs to be
    #                      configured on the BMC.
    # expected_status      Expected status while adding DNS server address
    #                      (e.g. Invalid format / Field required).

    Wait Until Page Contains Element  ${xpath_add_dns_ip_address_button}  timeout=15sec

    Click Button  ${xpath_add_dns_ip_address_button}
    Input Text  ${xpath_input_static_dns}  ${dns_server}
    Click Button  ${xpath_add_button}
    IF  '${expected_status}' != 'Valid format'
        Page Should Contain  ${expected_status}
        Return From Keyword
    END

    Wait Until Page Contains Element  ${xpath_add_dns_ip_address_button}  timeout=10sec
    Wait Until Page Contains  ${dns_server}  timeout=40sec

    # Check if newly added DNS server is configured on BMC.
    ${cli_name_servers}=  CLI Get Nameservers
    ${cmd_status}=  Run Keyword And Return Status
    ...  List Should Contain Sub List  ${cli_name_servers}  ${dns_server}
    IF  '${expected_status}' == '${HTTP_OK}'
       Should Be True  ${cmd_status} == ${True}
    ELSE
       Should Not Be True  ${cmd_status}
    END


Navigate To Server Power Page
    [Documentation]  Navigate To Server Power Page.

    Click Element  ${xpath_power_page}
    Wait Until Element Is Not Visible  ${xpath_page_loading_progress_bar}  timeout=30s


Power Off Server
    [Documentation]  Powering off server.

    ${boot_state}  ${host_state}=  Redfish Get Boot Progress
    IF  '${host_state}' == 'Disabled'
        Log To Console    Server is already powered Off.
    ELSE
        Navigate To Server Power Page
        Wait And Click Element  ${xpath_power_shutdown}
        Click Button  ${xpath_confirm}
        Wait Until Element Is Visible  ${xpath_power_poweron}  timeout=60
        Verify And Close Information Message Via GUI
        Wait Until Keyword Succeeds  5m  30s  Check Boot Progress State Via Redfish  None  Disabled
    END


Power On Server
    [Documentation]  Powering on server.

    ${boot_state}  ${host_state}=  Redfish Get Boot Progress
    Log To Console  Current boot state: ${boot_state}

    IF  '${boot_state}' == 'OSRunning'
        Log To Console    Server is already powered on.
    ELSE
        Navigate To Server Power Page
        IF  '${boot_state}' != 'None'
            Power Off Server
        END
        Set BIOS Attribute  pvm_stop_at_standby  Disabled
        Wait And Click Element  ${xpath_power_power_on}
        Wait Until Element Is Visible  ${xpath_power_shutdown}  timeout=60s
        Verify And Close Information Message Via GUI
        Wait Until Keyword Succeeds  15m  45s  Check Boot Progress State Via Redfish  OSRunning  Enabled
    END


Check Boot Progress State Via Redfish
    [Documentation]   Checking boot progress state via redfish.
    [Arguments]  ${expected_boot_state}  ${expected_host_state}

    # Description of argument(s):
    # expected_boot_state      Expected Boot states are "OSRunning" and "None".
    # expected_host_state      Expected Host states are "Enabled" and "Disabled"

    ${boot_state}  ${host_state}=  Redfish Get Boot Progress
    Log To Console  Current boot state: ${boot_state}, host state: ${host_state}

    Should Be Equal As Strings  ${boot_state}  ${expected_boot_state}
    ...  msg=Boot state mismatch: expected '${expected_boot_state}', got '${boot_state}'
    Should Be Equal As Strings  ${host_state}  ${expected_host_state}
    ...  msg=Host state mismatch: expected '${expected_host_state}', got '${host_state}'


Verify And Close Information Message Via GUI
    [Documentation]  Verify and close Information message via GUI page.

    Wait Until Element Is Visible  ${xpath_close_information_message}  timeout=5s
    Page Should Contain Element  ${xpath_information_message}
    Click Element  ${xpath_close_information_message}


Reboot Server
    [Documentation]  Rebooting the server.

    Navigate To Server Power Page
    ${present}=    Run Keyword And Return Status
    ...  Element Should Be Visible    ${xpath_power_reboot}
    IF  ${present}
      Click Element  ${xpath_power_reboot}
      Wait Until Element Is Visible  ${xpath_confirm}  timeout=30
      Click Button  ${xpath_confirm}
      Wait Until Element Is Visible  ${xpath_power_reboot}  timeout=60
    ELSE
      Log To console    Server is already powered Off, can't reboot.
    END


Verify Success Message On BMC GUI Page
    [Documentation]  Perform actions on the GUI and verify that a success message is displayed.

    Wait Until Element Is Visible   ${xpath_success_message}  timeout=30
    Page Should Contain Element   ${xpath_success_message}
    Wait Until Element Is Not Visible   ${xpath_success_message}  timeout=30


Verify Error And Unauthorized Message On GUI
    [Documentation]   Perform operations on GUI with Readonly user and
    ...               verify Error and Unauthorized messages.

    Wait Until Element Is Visible  ${xpath_error_popup}
    Page Should Contain  Error
    Page Should Contain  Unauthorized
    Click Element  ${xpath_error_popup}
    Click Element  ${xpath_unauthorized_popup}


Create Readonly User And Login To GUI
    [Documentation]   Logout current GUI sessions and Created Readonly_user
    ...               via Redfish and Login BMC GUI with Readonly user

    # Logout current GUI session.
    Logout GUI

    # Created readonly_user via redfish and login BMC GUI with readonly
    # user to perform test.
    Redfish.Login
    Redfish Create User  readonly_user  ${OPENBMC_PASSWORD}  ReadOnly  ${True}
    Login GUI  readonly_user  ${OPENBMC_PASSWORD}


Delete Readonly User And Logout Current GUI Session
    [Documentation]  Logout current GUI session and delete Readonly user,
    ...              Perform Login GUI with default user and password.

    # Delete Read-only user and Logout current GUI session.
    Logout GUI
    Redfish.Delete  /redfish/v1/AccountService/Accounts/readonly_user
    Close Browser

    # Login BMC GUI with default user.
    Launch Browser And Login GUI


Wait And Click Element
    [Documentation]  Wait until element is visible then click the element.
    [Arguments]  ${locator}  ${wait_timeout}=10s

    # Description of argument(s):
    # locator        xpath of the element.
    # wait_timeout   timeout for the locator to visible.

    Wait Until Element Is Visible    ${locator}    timeout=${wait_timeout}
    Click Element    ${locator}


Navigate To Required Sub Menu
    [Documentation]  Navigate to required sub menu from main menu.
    [Arguments]  ${xpath_main_menu}  ${xpath_sub_menu}  ${sub_menu_text}

    # Description of argument(s):
    # xpath_main_menu    Locator of main menu.
    # xpath_sub_menu     Locator of sub menu.
    # sub_menu_text      Text of sub menu.

    ${present}=    Run Keyword And Return Status
    ...  Element Should Be Visible    ${xpath_sub_menu}

    IF  not ${present}
        Wait And Click Element  ${xpath_main_menu}
    END
    Wait And Click Element  ${xpath_sub_menu}  wait_timeout=60s
    Location Should Contain  ${sub_menu_text}
    Wait Until Element Is Not Visible  ${xpath_page_loading_progress_bar}  timeout=1min