Class BrowserActions

java.lang.Object

com.shaft.gui.playwright.browser.BrowserActions

All Implemented Interfaces:

BrowserActionsContract

public class BrowserActions
extends Object
implements BrowserActionsContract

Constructor Summary

Constructors

Constructor	Description
BrowserActions(PlaywrightSession session)

Method Summary

Modifier and Type	Method	Description
BrowserActions	acceptAlert()	Accepts the current browser alert, confirm, or prompt dialog.
AccessibilityActions	accessibility()
BrowserActions	addCookie(String key, String value)
BrowserActions	and()
BrowserActions	assertContract(String contractFilePath, String... urlContains)	Starts hard-assert validation of live Playwright responses against an HTTP contract.
PlaywrightBrowserValidationsBuilder	assertThat()
BrowserActions	capturePageSnapshot()
BrowserActions	captureScreenshot()
BrowserActions	captureScreenshot(Screenshots type)
BrowserActions	captureSnapshot()
BrowserActions	clearNetworkInterceptors()
void	closeCurrentWindow()
BrowserActions	deleteAllCookies()
BrowserActions	deleteCookie(String cookieName)
BrowserActions	dismissAlert()	Dismisses the current browser alert, confirm, or prompt dialog.
BrowserActions	fullScreenWindow()
void	generateLightHouseReport()
String	getAlertText()	Gets the current browser alert, confirm, or prompt dialog text.
Set<org.openqa.selenium.Cookie>	getAllCookies()
String	getContext()
List<String>	getContextHandles()
org.openqa.selenium.Cookie	getCookie(String cookieName)
String	getCookieDomain(String cookieName)
String	getCookiePath(String cookieName)
String	getCookieValue(String cookieName)
String	getCurrentURL()
String	getCurrentWindowTitle()
com.microsoft.playwright.BrowserContext	getNativeContext()
com.microsoft.playwright.Page	getNativePage()
String	getPageSource()
String	getWindowHandle()
List<String>	getWindowHandles()
String	getWindowHeight()
String	getWindowPosition()
String	getWindowSize()
String	getWindowWidth()
BrowserActions	intercept(Predicate<org.openqa.selenium.remote.http.HttpRequest> requestPredicate, org.openqa.selenium.remote.http.HttpResponse mockedResponse)
NetworkInterceptionRequestBuilder<BrowserActions>	interceptRequest()
boolean	isAlertPresent()	Checks whether a browser alert, confirm, or prompt dialog is currently present.
BrowserActions	loadStorageState(String filePath)	Loads browser cookies, localStorage, and sessionStorage from a JSON file.
com.microsoft.playwright.Locator	locator(String selector)
BrowserActions	maximizeWindow()
BrowserActions	mock(Predicate<org.openqa.selenium.remote.http.HttpRequest> requestPredicate, org.openqa.selenium.remote.http.HttpResponse mockedResponse)
BrowserActions	navigateBack()
BrowserActions	navigateForward()
BrowserActions	navigateToURL(String targetUrl)
BrowserActions	navigateToURL(String targetUrl, String targetUrlAfterRedirection)
BrowserActions	navigateToURL(String targetUrl, org.openqa.selenium.WindowType windowType)
BrowserActions	navigateToURLWithBasicAuthentication(String targetUrl, String username, String password, String targetUrlAfterAuthentication)
BrowserActions	openNewTab(String targetUrl)	Opens the target URL in a new browser tab and switches focus to it.
BrowserActions	openNewWindow(String targetUrl)	Opens the target URL in a new browser window and switches focus to it.
BrowserActions	refreshCurrentPage()
BrowserActions	registerNetworkInterceptionRule(BrowserNetworkInterceptionRule rule, String successMessage)
BrowserActions	replayContract(String contractFilePath)	Replays recorded contract responses through the Playwright network interceptor.
BrowserActions	routeFromHar(String harFilePath)	Replays recorded HAR (HTTP Archive) responses through the Playwright network interceptor.
BrowserActions	saveStorageState(String filePath)	Saves the current browser cookies, localStorage, and sessionStorage to a JSON file.
BrowserActions	setContext(String context)
BrowserActions	setWindowSize(int width, int height)
BrowserActions	startContractRecording(String contractFilePath, String... urlContains)	Starts recording selected Playwright browser traffic into an HTTP contract.
BrowserActions	switchToWindow(String nameOrHandle)
BrowserActions	typeIntoPromptAlert(String text)	Types text into the current browser prompt dialog.
BrowserActions	verifyContract(String contractFilePath, String... urlContains)	Starts soft-verify validation of live Playwright responses against an HTTP contract.
PlaywrightBrowserValidationsBuilder	verifyThat()
BrowserActions	waitForLazyLoading()

Methods inherited from class Object

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

Methods inherited from interface BrowserActionsContract

scrollToLoadAll

Constructor Details

BrowserActions

public BrowserActions(PlaywrightSession session)

Method Details

and

public BrowserActions and()

Specified by:

and in interface BrowserActionsContract

assertThat

public PlaywrightBrowserValidationsBuilder assertThat()

Specified by:

assertThat in interface BrowserActionsContract

verifyThat

public PlaywrightBrowserValidationsBuilder verifyThat()

Specified by:

verifyThat in interface BrowserActionsContract

capturePageSnapshot

public BrowserActions capturePageSnapshot()

Specified by:

capturePageSnapshot in interface BrowserActionsContract

getCurrentURL

public String getCurrentURL()

Specified by:

getCurrentURL in interface BrowserActionsContract

getCurrentWindowTitle

public String getCurrentWindowTitle()

Specified by:

getCurrentWindowTitle in interface BrowserActionsContract

getPageSource

public String getPageSource()

Specified by:

getPageSource in interface BrowserActionsContract

getWindowHandle

public String getWindowHandle()

Specified by:

getWindowHandle in interface BrowserActionsContract

getWindowPosition

public String getWindowPosition()

Specified by:

getWindowPosition in interface BrowserActionsContract

getWindowSize

public String getWindowSize()

Specified by:

getWindowSize in interface BrowserActionsContract

getWindowHeight

public String getWindowHeight()

Specified by:

getWindowHeight in interface BrowserActionsContract

getWindowWidth

public String getWindowWidth()

Specified by:

getWindowWidth in interface BrowserActionsContract

navigateToURL

public BrowserActions navigateToURL(String targetUrl)

Specified by:

navigateToURL in interface BrowserActionsContract

navigateToURL

public BrowserActions navigateToURL(String targetUrl,
 org.openqa.selenium.WindowType windowType)

Specified by:

navigateToURL in interface BrowserActionsContract

openNewTab

public BrowserActions openNewTab(String targetUrl)

Opens the target URL in a new browser tab and switches focus to it.

Specified by:

openNewTab in interface BrowserActionsContract

Parameters:

targetUrl - target URL to open

Returns:

a self-reference to be used to chain actions

openNewWindow

public BrowserActions openNewWindow(String targetUrl)

Opens the target URL in a new browser window and switches focus to it.

Specified by:

openNewWindow in interface BrowserActionsContract

Parameters:

targetUrl - target URL to open

Returns:

a self-reference to be used to chain actions

navigateToURL

public BrowserActions navigateToURL(String targetUrl,
 String targetUrlAfterRedirection)

Specified by:

navigateToURL in interface BrowserActionsContract

navigateToURLWithBasicAuthentication

public BrowserActions navigateToURLWithBasicAuthentication(String targetUrl,
 String username,
 String password,
 String targetUrlAfterAuthentication)

Specified by:

navigateToURLWithBasicAuthentication in interface BrowserActionsContract

navigateBack

public BrowserActions navigateBack()

Specified by:

navigateBack in interface BrowserActionsContract

navigateForward

public BrowserActions navigateForward()

Specified by:

navigateForward in interface BrowserActionsContract

refreshCurrentPage

public BrowserActions refreshCurrentPage()

Specified by:

refreshCurrentPage in interface BrowserActionsContract

closeCurrentWindow

public void closeCurrentWindow()

Specified by:

closeCurrentWindow in interface BrowserActionsContract

maximizeWindow

public BrowserActions maximizeWindow()

Specified by:

maximizeWindow in interface BrowserActionsContract

setWindowSize

public BrowserActions setWindowSize(int width,
 int height)

Specified by:

setWindowSize in interface BrowserActionsContract

mock

public BrowserActions mock(Predicate<org.openqa.selenium.remote.http.HttpRequest> requestPredicate,
 org.openqa.selenium.remote.http.HttpResponse mockedResponse)

Specified by:

mock in interface BrowserActionsContract

interceptRequest

public NetworkInterceptionRequestBuilder<BrowserActions> interceptRequest()

Specified by:

interceptRequest in interface BrowserActionsContract

startContractRecording

public BrowserActions startContractRecording(String contractFilePath,
 String... urlContains)

Starts recording selected Playwright browser traffic into an HTTP contract.

Specified by:

startContractRecording in interface BrowserActionsContract

Parameters:

contractFilePath - destination JSON contract path

urlContains - optional URL fragments used to select recorded traffic

Returns:

a self-reference to be used to chain actions

assertContract

public BrowserActions assertContract(String contractFilePath,
 String... urlContains)

Starts hard-assert validation of live Playwright responses against an HTTP contract.

Specified by:

assertContract in interface BrowserActionsContract

Parameters:

contractFilePath - source JSON contract path

urlContains - optional URL fragments used to select validated traffic

Returns:

a self-reference to be used to chain actions

verifyContract

public BrowserActions verifyContract(String contractFilePath,
 String... urlContains)

Starts soft-verify validation of live Playwright responses against an HTTP contract.

Specified by:

verifyContract in interface BrowserActionsContract

Parameters:

contractFilePath - source JSON contract path

urlContains - optional URL fragments used to select validated traffic

Returns:

a self-reference to be used to chain actions

replayContract

public BrowserActions replayContract(String contractFilePath)

Replays recorded contract responses through the Playwright network interceptor.

Example:

driver.browser().replayContract("src/test/resources/contracts/checkout.json");
driver.browser().navigateToURL("https://shop.example/checkout");

Specified by:

replayContract in interface BrowserActionsContract

Parameters:

contractFilePath - source JSON contract path

Returns:

a self-reference to be used to chain actions

routeFromHar

public BrowserActions routeFromHar(String harFilePath)

Replays recorded HAR (HTTP Archive) responses through the Playwright network interceptor.

Example:

driver.browser().routeFromHar("src/test/resources/har/checkout.har");
driver.browser().navigateToURL("https://shop.example/checkout");

Specified by:

routeFromHar in interface BrowserActionsContract

Parameters:

harFilePath - path to a HAR 1.2 JSON file

Returns:

a self-reference to be used to chain actions

intercept

public BrowserActions intercept(Predicate<org.openqa.selenium.remote.http.HttpRequest> requestPredicate,
 org.openqa.selenium.remote.http.HttpResponse mockedResponse)

Specified by:

intercept in interface BrowserActionsContract

clearNetworkInterceptors

public BrowserActions clearNetworkInterceptors()

Specified by:

clearNetworkInterceptors in interface BrowserActionsContract

fullScreenWindow

public BrowserActions fullScreenWindow()

Specified by:

fullScreenWindow in interface BrowserActionsContract

switchToWindow

public BrowserActions switchToWindow(String nameOrHandle)

Specified by:

switchToWindow in interface BrowserActionsContract

isAlertPresent

public boolean isAlertPresent()

Checks whether a browser alert, confirm, or prompt dialog is currently present.

Specified by:

isAlertPresent in interface BrowserActionsContract

Returns:

true when an alert is present; otherwise false

acceptAlert

public BrowserActions acceptAlert()

Accepts the current browser alert, confirm, or prompt dialog.

Specified by:

acceptAlert in interface BrowserActionsContract

Returns:

a self-reference to be used to chain actions

dismissAlert

public BrowserActions dismissAlert()

Dismisses the current browser alert, confirm, or prompt dialog.

Specified by:

dismissAlert in interface BrowserActionsContract

Returns:

a self-reference to be used to chain actions

getAlertText

public String getAlertText()

Gets the current browser alert, confirm, or prompt dialog text.

Specified by:

getAlertText in interface BrowserActionsContract

Returns:

the alert text

typeIntoPromptAlert

public BrowserActions typeIntoPromptAlert(String text)

Types text into the current browser prompt dialog.

Specified by:

typeIntoPromptAlert in interface BrowserActionsContract

Parameters:

text - text to type into the prompt

Returns:

a self-reference to be used to chain actions

addCookie

public BrowserActions addCookie(String key,
 String value)

Specified by:

addCookie in interface BrowserActionsContract

getCookie

public org.openqa.selenium.Cookie getCookie(String cookieName)

Specified by:

getCookie in interface BrowserActionsContract

getAllCookies

public Set<org.openqa.selenium.Cookie> getAllCookies()

Specified by:

getAllCookies in interface BrowserActionsContract

getCookieDomain

public String getCookieDomain(String cookieName)

Specified by:

getCookieDomain in interface BrowserActionsContract

getCookieValue

public String getCookieValue(String cookieName)

Specified by:

getCookieValue in interface BrowserActionsContract

getCookiePath

public String getCookiePath(String cookieName)

Specified by:

getCookiePath in interface BrowserActionsContract

deleteCookie

public BrowserActions deleteCookie(String cookieName)

Specified by:

deleteCookie in interface BrowserActionsContract

deleteAllCookies

public BrowserActions deleteAllCookies()

Specified by:

deleteAllCookies in interface BrowserActionsContract

saveStorageState

public BrowserActions saveStorageState(String filePath)

Saves the current browser cookies, localStorage, and sessionStorage to a JSON file.

Produces the same JSON schema as the WebDriver backend's saveStorageState, so files are interchangeable between backends. Example:

driver.browser().saveStorageState("target/auth-state.json");

Parameters:

filePath - target JSON file path

Returns:

a self-reference to be used to chain actions

loadStorageState

public BrowserActions loadStorageState(String filePath)

Loads browser cookies, localStorage, and sessionStorage from a JSON file.

Navigate to the target origin before loading storage so browser cookie domain rules can apply. Reads the same JSON schema as the WebDriver backend's loadStorageState. Example:

driver.browser()
      .navigateToURL("https://example.com")
      .and().loadStorageState("target/auth-state.json");

Parameters:

filePath - source JSON file path

Returns:

a self-reference to be used to chain actions

captureScreenshot

public BrowserActions captureScreenshot()

Specified by:

captureScreenshot in interface BrowserActionsContract

captureScreenshot

public BrowserActions captureScreenshot(Screenshots type)

Specified by:

captureScreenshot in interface BrowserActionsContract

captureSnapshot

public BrowserActions captureSnapshot()

Specified by:

captureSnapshot in interface BrowserActionsContract

generateLightHouseReport

public void generateLightHouseReport()

Specified by:

generateLightHouseReport in interface BrowserActionsContract

waitForLazyLoading

public BrowserActions waitForLazyLoading()

Specified by:

waitForLazyLoading in interface BrowserActionsContract

getContext

public String getContext()

Specified by:

getContext in interface BrowserActionsContract

setContext

public BrowserActions setContext(String context)

Specified by:

setContext in interface BrowserActionsContract

getWindowHandles

public List<String> getWindowHandles()

Specified by:

getWindowHandles in interface BrowserActionsContract

getContextHandles

public List<String> getContextHandles()

Specified by:

getContextHandles in interface BrowserActionsContract

accessibility

public AccessibilityActions accessibility()

Specified by:

accessibility in interface BrowserActionsContract

getNativeContext

public com.microsoft.playwright.BrowserContext getNativeContext()

getNativePage

public com.microsoft.playwright.Page getNativePage()

locator

public com.microsoft.playwright.Locator locator(String selector)

registerNetworkInterceptionRule

public BrowserActions registerNetworkInterceptionRule(BrowserNetworkInterceptionRule rule,
 String successMessage)