Package allurium.browser

Class BrowserSteps

java.lang.Object
allurium.browser.BrowserSteps
public class BrowserSteps extends Object
A utility class for managing browser actions related to local storage, cookies, and other browser state interactions.

The `BrowserSteps` class provides a collection of static methods to interact with the browser's local storage, manage cookies, and perform common browser-related steps. It simplifies browser state manipulation in test automation and debugging scenarios.

Purpose:

  • Provide reusable methods for browser state operations.
  • Streamline test setup and teardown by handling browser state programmatically.

  • Constructor Details

    • BrowserSteps

      public BrowserSteps()

  • Method Details

    • clearLocalStorage

      @Step("Clear the local storage") public static void clearLocalStorage()
      Clears all entries from the browser's local storage.

      This method executes a JavaScript command to clear all data from the browser's local storage.

      Purpose:

      • Ensure a clean state for tests by removing all local storage items.

      Step

      Clear the local storage

    • addValueToLocalStorage

      @Step("Insert the item \'{key}\' with the value \'{value}\' into the local storage") public static void addValueToLocalStorage(String key, String value)
      Inserts a key-value pair into the browser's local storage.

      This method uses JavaScript to add an item with the specified key and value into the browser's local storage.

      Parameters:
      key - the key of the local storage item
      value - the value to associate with the key

      Step

      Insert the item '{key}' with the value '{value}' into the local storage

    • updateValueInLocalStorage

      @Step("Update the local storage item \'{key}\' with the new value \'{newValue}\'") public static void updateValueInLocalStorage(String key, String newValue)
      Updates the value of an existing item in the browser's local storage.

      This method modifies the value of an item with the specified key in local storage, or creates it if it does not exist.

      Parameters:
      key - the key of the local storage item to update
      newValue - the new value to set for the item

      Step

      Update the local storage item '{key}' with the new value '{newValue}'

    • deleteValueFromLocalStorage

      @Step("Removing the \'{variable}\' from the local storage") public static void deleteValueFromLocalStorage(String variable)
      Removes an item from the browser's local storage by its key.

      This method deletes the local storage item with the specified key, if it exists.

      Parameters:
      variable - the key of the local storage item to remove

      Step

      Removing the '{variable}' from the local storage

    • assertLocalStorageValue

      @Step("Assert the local storage item \'{key}\' has the value \'{expectedValue}\'") public static void assertLocalStorageValue(String key, String expectedValue)
      Asserts that the local storage item with the specified key has the expected value.

      This method retrieves the value from the local storage for the provided key and compares it with the expected value. Throws an assertion error if the key is not present or the value does not match.

      Parameters:
      key - the key of the local storage item
      expectedValue - the expected value for the key

      Step

      Assert the local storage item '{key}' has the value '{expectedValue}'

    • assertLocalStorageValueAbsent

      @Step("Assert that the local storage does not contain an item with the key \'{key}\'") public static void assertLocalStorageValueAbsent(String key)
      Asserts that the local storage does not contain an item with the specified key.

      This method checks the absence of a key in the local storage and throws an assertion error if the key exists.

      Parameters:
      key - the key to check in the local storage

      Step

      Assert that the local storage does not contain an item with the key '{key}'

    • assertLocalStorageIsBlank

      @Step("Assert that the local storage is blank") public static void assertLocalStorageIsBlank()
      Asserts that the local storage is empty.

      This method verifies that there are no items in the local storage by checking its length. Throws an assertion error if the local storage is not empty.

      Step

      Assert that the local storage is blank

    • addCookie

      @Step("Add the cookie \'{nameCookie}\' with the value=\'{valueCookie}\'") public static void addCookie(String nameCookie, String valueCookie)
      Adds a cookie to the browser and refreshes the current page.

      This method appends a cookie with the specified name and value to the browser's cookie storage and then refreshes the page to ensure the cookie is applied.

      Parameters:
      nameCookie - the name of the cookie
      valueCookie - the value of the cookie

      Step

      Add the cookie '{nameCookie}' with the value='{valueCookie}'

    • addCookies

      public static void addCookies(Map<String,String> cookies)
      Adds multiple cookies to the browser and refreshes the current page.

      This method iterates over the provided map of cookies, adding each cookie to the browser's cookie storage, and then refreshes the page to apply the changes.

      Parameters:
      cookies - a map containing cookie names as keys and their respective values as values

      Example Usage:

      
 Map<String, String> cookies = Map.of("sessionToken", "abc123", "userId", "42");
 BrowserSteps.addCookies(cookies);

    • updateCookie

      @Step("Update the cookie \'{nameCookie}\' with the new value=\'{newValueCookie}\'") public static void updateCookie(String nameCookie, String newValueCookie)
      Updates the value of an existing cookie or creates a new one if it doesn't exist, then refreshes the page.

      This method first deletes the cookie with the specified name (if present) and then adds a new cookie with the same name but a new value. The page is refreshed to apply the updated cookie.

      Parameters:
      nameCookie - the name of the cookie to update
      newValueCookie - the new value for the cookie

      Step

      Update the cookie '{nameCookie}' with the new value='{newValueCookie}'

    • deleteCookie

      @Step("Remove the cookie \'{nameCookie}\'") public static void deleteCookie(String nameCookie)
      Deletes a cookie from the browser by its name and refreshes the current page.

      This method removes a single cookie specified by its name from the browser's cookie storage and then refreshes the page to apply the changes.

      Parameters:
      nameCookie - the name of the cookie to remove

      Step

      Remove the cookie '{nameCookie}'

    • deleteAllCookies

      @Step("Remove all cookies") public static void deleteAllCookies()
      Deletes all cookies from the browser and refreshes the current page.

      This method clears all cookies stored in the browser and then refreshes the page to reflect the changes.

      Step

      Remove all cookies

    • assertCookiePresent

      @Step("Assert that the cookie \'{cookieName}\' presents") public static void assertCookiePresent(String cookieName)
      Asserts that a cookie with the specified name is present in the browser.

      This method checks if the cookie exists within the browser's storage, retrying until the timeout is reached.

      Parameters:
      cookieName - the name of the cookie to check

      Step

      Assert that the cookie '{cookieName}' presents

      Example Usage:

      
 BrowserSteps.assertCookiePresent("sessionCookie");

    • assertCookieAbsent

      @Step("Assert that the cookie \'{cookieName}\' is absent in the local storage") public static void assertCookieAbsent(String cookieName)
      Asserts that a cookie with the specified name is absent in the browser's storage.

      This method ensures that the cookie does not exist, retrying until the timeout is reached.

      Parameters:
      cookieName - the name of the cookie to check

      Step

      Assert that the cookie '{cookieName}' is absent in the local storage

      Example Usage:

      
 BrowserSteps.assertCookieAbsent("obsoleteCookie");

    • assertCookieValue

      @Step("Assert that the cookie \'{cookieName}\' has the value \'{expectedValue}\'") public static void assertCookieValue(String cookieName, String expectedValue)
      Asserts that a cookie has the expected value.

      This method retrieves the cookie with the specified name and verifies that its value matches the expected value.

      Parameters:
      cookieName - the name of the cookie to check
      expectedValue - the expected value of the cookie

      Step

      Assert that the cookie '{cookieName}' has the value '{expectedValue}'

      Example Usage:

      
 BrowserSteps.assertCookieValue("sessionCookie", "xyz123");