Package allurium

Class UiSteps

java.lang.Object
allurium.UiSteps
public class UiSteps extends Object
This class provides utility methods for performing common UI interactions in Selenium tests. All methods are marked with the `@Step` annotation from Allure for better reporting.

  • Constructor Summary

    Constructors
    Constructor
    Description
    UiSteps()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    assertPageTitle(String title)
    Asserts that the current browser page title matches the specified title.
    static void
    assertPageTitleContains(String titlePart)
    Asserts that the current browser page title contains the specified part.
    static void
    assertUrl(String url)
    Asserts that the current browser URL matches the specified value.
    static void
    assertUrlContains(String urlPart)
    Asserts that the current browser URL contains the specified part.
    static void
    assertUrlContains(String urlPart, int timerSec)
    Asserts that the current browser URL contains the specified part within a custom timeout.
    static void
    assertUrlPath(String urlPart)
    Asserts that the current browser URL ends with the specified part.
    static void
    closeCurrentTab()
    Closes the currently active browser tab.
    static void
    closeTab(int index)
    Closes the browser tab located at the specified index in the list of open tabs.
    static void
    closeTab(String tabHandle)
    Closes the browser tab identified by the given tab handle.
    static void
    delay(long millisec)
    Pauses the execution for a specified duration.
    static void
    dragAndDrop(UIElement dragThis, UIElement toThat)
    Performs a drag-and-drop operation, moving one UI element onto another.
    static void
    goBack()
    Navigates to the previous page in the browser's history.
    static void
    goForward()
    Navigates to the next page in the browser's history.
    static void
    loadPage(String url)
    Loads the specified URL with multiple retries.
    static void
    loadPage(String url, String login, String password)
    Opens the specified URL with login credentials.
    static void
    loadPageAndWaitCompleteState(String pageUrl)
    Loads the specified URL and waits for the page to reach a complete state.
    static void
    loadPageAndWaitCompleteState(String pageUrl, int retries)
    Loads the specified URL, waits for the page to reach a complete state, and retries the loading process if necessary.
    static void
    maximize()
    Maximizes the browser window to fill the screen.
    void
    openBrowser()
    Opens the browser without navigating to a specific URL.
    void
    openBrowser(String url)
    Opens the browser and navigates to the specified URL.
    static void
    openNewBlankTab()
    Opens a new blank tab in the browser and switches to it.
    static void
    openNewTabWithUrl(String url)
    Opens a new browser tab and navigates to the specified URL.
    static void
    pressArrowDown()
    Simulates pressing the 'Arrow Down' key using WebDriver actions.
    static void
    pressArrowLeft()
    Simulates pressing the 'Arrow Left' key using WebDriver actions.
    static void
    pressArrowRight()
    Simulates pressing the 'Arrow Right' key using WebDriver actions.
    static void
    pressArrowUp()
    Simulates pressing the 'Arrow Up' key using WebDriver actions.
    static void
    pressEnter()
    Simulates pressing the 'Enter' key on the body element of the page.
    static void
    pressEsc()
    Simulates pressing the 'Escape' key on the body element of the page.
    static void
    pressTab()
    Simulates pressing the 'Tab' key to move focus to the next interactive element on the page.
    static void
    refreshCurrentPage()
    Refreshes the current page in the browser.
    static void
    scrollBottom()
    Smoothly scrolls the page to the bottom.
    static void
    scrollPage(boolean up)
    Scrolls the page either to the top or the bottom.
    static void
    scrollTop()
    Smoothly scrolls the page to the top.
    static void
    setWindowSize(int width, int height)
    Sets the browser window size to the specified dimensions.
    void
    switchToTab(int index)
    Switches to the browser tab at the specified index.
    static void
    switchToTab(String tabTitle)
    Switches to the browser tab with the specified title.
    static void
    waiting(long seconds)
    Pauses the execution for the specified number of seconds.
    static void
    waiting(long seconds, boolean showLog)
    Pauses the execution for a specified duration with optional logging.
    static void
    waiting(long sec, String description)
    Pauses the execution for the specified number of seconds, with a custom description for the waiting step.
    static void
    waitingFor(long sec, String description)
    Pauses the execution for the specified number of seconds, with a description of the action being waited for.
    static void
    waitingUntil(long sec, String description)
    Pauses the execution for the specified number of seconds, with a description of the condition being waited for.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • UiSteps

      public UiSteps()

  • Method Details

    • openBrowser

      @Step("Open the browser and navigate to {url}") public void openBrowser(String url)
      Opens the browser and navigates to the specified URL.
      Parameters:
      url - the URL to open

    • openBrowser

      @Step("Open the browser") public void openBrowser()
      Opens the browser without navigating to a specific URL.

    • loadPage

      @Step("Open the page {url} with the login {login} and the password {password}") public static void loadPage(String url, String login, String password)
      Opens the specified URL with login credentials.
      Parameters:
      url - The URL to open.
      login - The login username.
      password - The login password.

    • loadPage

      @Step("Load the page {url}") public static void loadPage(String url)
      Loads the specified URL with multiple retries. Avoid using this method to open a browser, as it may cause multiple instances if retries are triggered.
      Parameters:
      url - the URL to load

    • loadPageAndWaitCompleteState

      @Step("Load the page {pageUrl} and wait for the complete status") public static void loadPageAndWaitCompleteState(String pageUrl)
      Loads the specified URL and waits for the page to reach a complete state.
      Parameters:
      pageUrl - the URL to load

    • loadPageAndWaitCompleteState

      @Step("Load the page {pageUrl} and wait for the complete status") public static void loadPageAndWaitCompleteState(String pageUrl, int retries)
      Loads the specified URL, waits for the page to reach a complete state, and retries the loading process if necessary.
      Parameters:
      pageUrl - the URL to load
      retries - the number of retries for loading

    • openNewBlankTab

      @Step("Open a new blank tab") public static void openNewBlankTab()
      Opens a new blank tab in the browser and switches to it. Uses JavaScript execution to create the new tab.

    • openNewTabWithUrl

      @Step("Open a new tab with the URL \'{url}\'") public static void openNewTabWithUrl(String url)
      Opens a new browser tab and navigates to the specified URL. The method uses JavaScript execution to open the tab and switches to it.
      Parameters:
      url - the URL to open in the new tab

    • switchToTab

      @Step("Switch to the browser tab with the title \'{tabTitle}\'") public static void switchToTab(String tabTitle)
      Switches to the browser tab with the specified title. If the tab is not found, an exception is thrown.
      Parameters:
      tabTitle - the title of the tab to switch to

    • switchToTab

      @Step("Switch to the browser tab with index {index}") public void switchToTab(int index)
      Switches to the browser tab at the specified index. The index is based on the order of the window handles.
      Parameters:
      index - the index of the tab to switch to (0-based)
      Throws:
      IndexOutOfBoundsException - if the index is invalid

    • closeCurrentTab

      @Step("Close the current tab") public static void closeCurrentTab()
      Closes the currently active browser tab. If other tabs are open, switches to the next available tab. Logs warnings if no tabs are available after closing.

    • closeTab

      @Step("Close the tab with the handle \'{tabHandle}\'") public static void closeTab(String tabHandle)
      Closes the browser tab identified by the given tab handle. If other tabs are open, switches to the next available tab. Logs warnings if the specified tab handle is not found or if no tabs remain open.
      Parameters:
      tabHandle - the handle of the tab to be closed

    • closeTab

      @Step("Close the tab at index {index}") public static void closeTab(int index)
      Closes the browser tab located at the specified index in the list of open tabs. If other tabs are available, switches to the next available tab. Logs warnings if the index is invalid or if no tabs remain open after the operation.
      Parameters:
      index - the zero-based index of the tab to be closed
      Throws:
      IndexOutOfBoundsException - if the provided index is invalid

    • assertUrl

      @Step("Assert that the current url is \'{url}\'") public static void assertUrl(String url)
      Asserts that the current browser URL matches the specified value. If the URL does not match, retries every second until the timeout defined in Configuration.timeout is reached. Throws an assertion error if the URL still does not match after the timeout.
      Parameters:
      url - the expected URL to assert
      Throws:
      AssertionError - if the current URL does not match the expected value

    • assertUrlContains

      @Step("Assert that the current url contains \'{urlPart}\'") public static void assertUrlContains(String urlPart)
      Asserts that the current browser URL contains the specified part. Retries every second until the URL contains the part or the timeout defined in Configuration.timeout is reached. Throws an assertion error if the condition is not met.
      Parameters:
      urlPart - the substring that the current URL should contain
      Throws:
      AssertionError - if the URL does not contain the specified substring after the timeout

    • assertUrlContains

      @Step("Assert that the current url contains \'{urlPart}\'") public static void assertUrlContains(String urlPart, int timerSec)
      Asserts that the current browser URL contains the specified part within a custom timeout. Retries every second until the URL contains the part or the timeout is reached. Throws an assertion error if the condition is not met.
      Parameters:
      urlPart - the substring that the current URL should contain
      timerSec - the maximum time in seconds to wait for the condition
      Throws:
      AssertionError - if the URL does not contain the specified substring after the timeout

    • assertUrlPath

      @Step("Assert that the current url ends with \'{urlPart}\'") public static void assertUrlPath(String urlPart)
      Asserts that the current browser URL ends with the specified part.
      Parameters:
      urlPart - the expected ending of the current URL
      Throws:
      AssertionError - if the URL does not end with the specified substring

    • delay

      @Step("Technical delay [{millisec}] seconds") public static void delay(long millisec)
      Pauses the execution for a specified duration.
      Parameters:
      millisec - the duration of the delay in milliseconds

    • waiting

      public static void waiting(long seconds, boolean showLog)
      Pauses the execution for a specified duration with optional logging.
      Parameters:
      seconds - the duration of the delay in seconds
      showLog - whether to log the delay

    • assertPageTitle

      @Step("Assert that the current page title is \'{title}\'") public static void assertPageTitle(String title)
      Asserts that the current browser page title matches the specified title. Retries every second until the title matches or the timeout defined in Configuration.timeout is reached. Throws an assertion error if the condition is not met.
      Parameters:
      title - the expected page title
      Throws:
      AssertionError - if the page title does not match the specified title after the timeout

    • assertPageTitleContains

      @Step("Assert that the current page title contains \'{titlePart}\'") public static void assertPageTitleContains(String titlePart)
      Asserts that the current browser page title contains the specified part. Retries every second until the title contains the part or the timeout defined in Configuration.timeout is reached. Throws an assertion error if the condition is not met.
      Parameters:
      titlePart - the substring that the current page title should contain
      Throws:
      AssertionError - if the page title does not contain the specified substring after the timeout

    • waiting

      @Step("Waiting [{seconds}] seconds") public static void waiting(long seconds)
      Pauses the execution for the specified number of seconds.
      Parameters:
      seconds - the number of seconds to wait

    • waiting

      @Step("Waiting [{description}] during [{sec}] second(s)") public static void waiting(long sec, String description)
      Pauses the execution for the specified number of seconds, with a custom description for the waiting step.
      Parameters:
      sec - the number of seconds to wait
      description - a brief description of why the waiting is occurring

    • waitingUntil

      @Step("Waiting [{sec}] second(s) until [{description}]") public static void waitingUntil(long sec, String description)
      Pauses the execution for the specified number of seconds, with a description of the condition being waited for.
      Parameters:
      sec - the number of seconds to wait
      description - a description of the condition being waited for

    • waitingFor

      @Step("Waiting [{sec}] second(s) for [{description}]") public static void waitingFor(long sec, String description)
      Pauses the execution for the specified number of seconds, with a description of the action being waited for.
      Parameters:
      sec - the number of seconds to wait
      description - a description of the action being waited for

    • refreshCurrentPage

      @Step("Refresh the current page") public static void refreshCurrentPage()
      Refreshes the current page in the browser.

    • goBack

      @Step("Press \'Backspace\'") public static void goBack()
      Navigates to the previous page in the browser's history.

    • goForward

      @Step("Press \'Forward\'") public static void goForward()
      Navigates to the next page in the browser's history.

    • scrollPage

      @Step("Scrolling page up [{up}]") public static void scrollPage(boolean up)
      Scrolls the page either to the top or the bottom.
      Parameters:
      up - if true, scrolls to the top; if false, scrolls to the bottom

    • scrollTop

      @Step("Scroll the page to the top") public static void scrollTop()
      Smoothly scrolls the page to the top.

    • scrollBottom

      @Step("Scroll the page to the bottom") public static void scrollBottom()
      Smoothly scrolls the page to the bottom.

    • pressEnter

      @Step("Press the key \'Enter\'") public static void pressEnter()
      Simulates pressing the 'Enter' key on the body element of the page.

    • pressEsc

      @Step("Press the key \'Esc\'") public static void pressEsc()
      Simulates pressing the 'Escape' key on the body element of the page.

    • pressArrowUp

      @Step("Press the \'Arrow Up\' key") public static void pressArrowUp()
      Simulates pressing the 'Arrow Up' key using WebDriver actions.

    • pressArrowDown

      @Step("Press the \'Arrow Down\' key") public static void pressArrowDown()
      Simulates pressing the 'Arrow Down' key using WebDriver actions.

    • pressArrowLeft

      @Step("Press the \'Arrow Left\' key") public static void pressArrowLeft()
      Simulates pressing the 'Arrow Left' key using WebDriver actions.

    • pressArrowRight

      @Step("Press the \'Arrow Right\' key") public static void pressArrowRight()
      Simulates pressing the 'Arrow Right' key using WebDriver actions.

    • pressTab

      @Step("Press the \'Tab\' key") public static void pressTab()
      Simulates pressing the 'Tab' key to move focus to the next interactive element on the page.

    • dragAndDrop

      @Step("Drag and Drop") public static void dragAndDrop(UIElement dragThis, UIElement toThat)
      Performs a drag-and-drop operation, moving one UI element onto another.
      Parameters:
      dragThis - the UI element to be dragged
      toThat - the UI element to drop the dragged element onto

    • maximize

      @Step("Expand the browser window to full size") public static void maximize()
      Maximizes the browser window to fill the screen.

    • setWindowSize

      @Step("Set the browser window size to {width}x{height}") public static void setWindowSize(int width, int height)
      Sets the browser window size to the specified dimensions.
      Parameters:
      width - the desired width of the browser window
      height - the desired height of the browser window