Package com.applitools.eyes.playwright

Class Eyes

java.lang.Object

com.applitools.eyes.playwright.Eyes

All Implemented Interfaces:

com.applitools.eyes.IEyesBase

public class Eyes
extends Object
implements com.applitools.eyes.IEyesBase

Field Summary

Fields inherited from interface com.applitools.eyes.IEyesBase

APPLITOOLS_PUBLIC_CLOUD_URL

Constructor Summary

Constructors

Constructor	Description
Eyes()	Instantiates a new Eyes.
Eyes(com.applitools.eyes.EyesRunner runner0)	Instantiates a new Eyes.

Method Summary

Modifier and Type	Method	Description
com.applitools.eyes.TestResults	abort()
void	abortAsync()
com.applitools.eyes.TestResults	abortIfNotClosed()
void	addProperty(String name, String value)
void	check(com.applitools.ICheckSettings checkSettings)	Check.
void	check(com.applitools.ICheckSettings... checkSettings)	Takes multiple screenshots at once (given all ICheckSettings objects are on the same level).
void	check(String tag, com.applitools.ICheckSettings checkSettings)	Check.
void	clearProperties()
com.applitools.eyes.TestResults	close()	See close(boolean).
com.applitools.eyes.TestResults	close(boolean shouldThrowException)	Close test results.
void	closeAsync()
com.applitools.eyes.config.Configuration	configure()
List<String>	extractText(com.applitools.eyes.locators.BaseOcrRegion... ocrRegions)	Extract text.
Map<String,List<com.applitools.eyes.locators.TextRegion>>	extractTextRegions(com.applitools.eyes.locators.TextRegionSettings textRegionSettings)	Locate text.
com.applitools.eyes.AccessibilitySettings	getAccessibilityValidation()
String	getAgentId()
String	getApiKey()
String	getAppName()
String	getBaselineBranchName()
String	getBaselineEnvName()	If not null, determines the name of the environment of the baseline.
String	getBaselineName()	Deprecated. Only available for backward compatibility.
com.applitools.eyes.BatchInfo	getBatch()
String	getBranchName()
com.applitools.eyes.config.Configuration	getConfiguration()
String	getDebugScreenshotsPath()	Gets debug screenshots path.
String	getDebugScreenshotsPrefix()	Gets debug screenshots prefix.
com.applitools.eyes.ImageMatchSettings	getDefaultMatchSettings()
boolean	getEnablePatterns()
String	getEnvironmentName()
String	getEnvName()	If not null specifies a name for the environment in which the application under test is running.
String	getFullAgentId()
String	getHostApp()
String	getHostOS()
boolean	getIgnoreCaret()
boolean	getIgnoreDisplacements()
Boolean	getIsDisabled()
boolean	getIsOpen()	Gets is open.
com.applitools.eyes.Logger	getLogger()
com.applitools.eyes.LogHandler	getLogHandler()
com.applitools.eyes.MatchLevel	getMatchLevel()	Deprecated. Please usegetDefaultMatchSettings() instead.
int	getMatchTimeout()
String	getParentBranchName()
com.applitools.eyes.AbstractProxySettings	getProxy()
List<com.applitools.eyes.TestResults>	getResults()
List<com.applitools.eyes.TestResults>	getResults(boolean shouldThrowException)
Boolean	getSaveDiffs()	Returns whether to automatically save differences as a baseline.
boolean	getSaveFailedTests()
boolean	getSaveNewTests()
URI	getServerUrl()
int	getStitchOverlap()	Returns the stitching overlap in pixels.
String	getTestName()
boolean	getUseDom()
Map<String,List<com.applitools.eyes.Region>>	locate(com.applitools.eyes.locators.VisualLocatorSettings visualLocatorSettings)	Locate.
com.microsoft.playwright.Page	open(com.microsoft.playwright.Page page)	Starts a test.
com.microsoft.playwright.Page	open(com.microsoft.playwright.Page page, String appName, String testName)	Starts a test.
com.microsoft.playwright.Page	open(com.microsoft.playwright.Page page, String appName, String testName, com.applitools.eyes.RectangleSize viewportSize)	Starts a test.
com.applitools.eyes.config.Configuration	setAccessibilityValidation(com.applitools.eyes.AccessibilitySettings accessibilityValidation)
com.applitools.eyes.config.Configuration	setAgentId(String agentId)
void	setApiKey(String apiKey)
void	setAppEnvironment(String hostOS, String hostApp)	Deprecated.
com.applitools.eyes.config.Configuration	setAppName(String appName)
com.applitools.eyes.config.Configuration	setBaselineBranchName(String branchName)	Sets the branch under which new branches are created.
com.applitools.eyes.config.Configuration	setBaselineEnvName(String baselineEnvName)	If not null, determines the name of the environment of the baseline.
void	setBaselineName(String baselineName)	Deprecated. Only available for backward compatibility.
com.applitools.eyes.config.Configuration	setBatch(com.applitools.eyes.BatchInfo batch)	Sets the batch in which context future tests will run or null if tests are to run standalone.
com.applitools.eyes.config.Configuration	setBranchName(String branchName)	Sets the branch in which the baseline for subsequent test runs resides.
void	setConfiguration(com.applitools.eyes.config.Configuration configuration)
void	setDebugScreenshotsPath(String pathToSave)	Sets debug screenshots path.
void	setDebugScreenshotsPrefix(String prefix)	Sets debug screenshots prefix.
com.applitools.eyes.config.Configuration	setDefaultMatchSettings(com.applitools.eyes.ImageMatchSettings defaultMatchSettings)	Updates the match settings to be used for the session.
com.applitools.eyes.config.Configuration	setEnablePatterns(boolean enablePatterns)
com.applitools.eyes.config.Configuration	setEnvironmentName(String environmentName)
void	setEnvName(String envName)	If not null specifies a name for the environment in which the application under test is running.
void	setHideCaret(Boolean hideCaret)
void	setHideScrollbars(Boolean hideScrollbars)
com.applitools.eyes.config.Configuration	setHostApp(String hostApp)
com.applitools.eyes.config.Configuration	setHostOS(String hostOS)
com.applitools.eyes.config.Configuration	setIgnoreCaret(boolean value)	Sets the ignore blinking caret value.
com.applitools.eyes.config.Configuration	setIgnoreDisplacements(boolean isIgnoreDisplacements)
void	setImageCut(com.applitools.eyes.UnscaledFixedCutProvider unscaledFixedCutProvider)
void	setIsDisabled(Boolean isDisabled)
void	setLogHandler(com.applitools.eyes.LogHandler logHandler)
com.applitools.eyes.config.Configuration	setMatchLevel(com.applitools.eyes.MatchLevel matchLevel)	This function is deprecated.
com.applitools.eyes.config.Configuration	setMatchTimeout(int ms)	Sets the maximum time (in ms) a match operation tries to perform a match.
com.applitools.eyes.config.Configuration	setParentBranchName(String branchName)	Sets the branch under which new branches are created.
void	setProxy(com.applitools.eyes.AbstractProxySettings proxySettings)
com.applitools.eyes.config.Configuration	setSaveDiffs(Boolean saveDiffs)	Automatically save differences as a baseline.
com.applitools.eyes.config.Configuration	setSaveFailedTests(boolean saveFailedTests)	Set whether or not failed tests are saved by default.
com.applitools.eyes.config.Configuration	setSaveNewTests(boolean saveNewTests)	Set whether or not new tests are saved by default.
void	setServerUrl(String serverUrl)
void	setStitchMode(com.applitools.eyes.selenium.StitchMode stitchMode)
com.applitools.eyes.config.Configuration	setStitchOverlap(int pixels)	Sets the stitching overlap in pixels.
com.applitools.eyes.config.Configuration	setTestName(String testName)
com.applitools.eyes.config.Configuration	setUseDom(boolean useDom)

Methods inherited from class java.lang.Object

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

Constructor Details

Eyes

public Eyes()

Instantiates a new Eyes.

Eyes

public Eyes(com.applitools.eyes.EyesRunner runner0)

Instantiates a new Eyes.

Parameters:

runner0 - the runner

Method Details

open

public com.microsoft.playwright.Page open(com.microsoft.playwright.Page page)

Starts a test.

Parameters:

page - The web driver that controls the browser hosting the application under test.

Returns:

the page

open

public com.microsoft.playwright.Page open(com.microsoft.playwright.Page page,
 String appName,
 String testName)

Starts a test.

Parameters:

page - The web driver that controls the browser hosting the application under test.

appName - The name of the application under test.

testName - The test name. (i.e., the visible part of the document's body) or null to use the current window's viewport.

Returns:

the page

open

public com.microsoft.playwright.Page open(com.microsoft.playwright.Page page,
 String appName,
 String testName,
 com.applitools.eyes.RectangleSize viewportSize)

Starts a test.

Parameters:

page - The web driver that controls the browser hosting the application under test.

appName - The name of the application under test.

testName - The test name.

viewportSize - The required browser's viewport size (i.e., the visible part of the document's body) or null to use the current window's viewport.

Returns:

the page

check

public void check(com.applitools.ICheckSettings... checkSettings)

Takes multiple screenshots at once (given all ICheckSettings objects are on the same level).

Parameters:

checkSettings - Multiple ICheckSettings object representing different regions in the viewport.

check

public void check(String tag,
 com.applitools.ICheckSettings checkSettings)

Check.

Parameters:

tag - the tag

checkSettings - the check settings

check

public void check(com.applitools.ICheckSettings checkSettings)

Check.

Parameters:

checkSettings - the check settings

extractText

public List<String> extractText(com.applitools.eyes.locators.BaseOcrRegion... ocrRegions)

Extract text.

Parameters:

ocrRegions - the ocrRegions.

Returns:

the extracted text

extractTextRegions

public Map<String,List<com.applitools.eyes.locators.TextRegion>> extractTextRegions(com.applitools.eyes.locators.TextRegionSettings textRegionSettings)

Locate text. Formerly known as extractTextRegions.

Parameters:

textRegionSettings - the image from which the location of the text will be extracted.

Returns:

mapping of the located text regions

locate

public Map<String,List<com.applitools.eyes.Region>> locate(com.applitools.eyes.locators.VisualLocatorSettings visualLocatorSettings)

Locate.

Parameters:

visualLocatorSettings - the locator settings.

Returns:

mapping of the region locations.

close

public com.applitools.eyes.TestResults close()

See close(boolean). throwEx defaults to true.

Returns:

The test results.

close

public com.applitools.eyes.TestResults close(boolean shouldThrowException)

Close test results.

Parameters:

shouldThrowException - the should throw exception

Returns:

the test results

configure

public com.applitools.eyes.config.Configuration configure()

setAppName

public com.applitools.eyes.config.Configuration setAppName(String appName)

Parameters:

appName - The name of the application under test.

setTestName

public com.applitools.eyes.config.Configuration setTestName(String testName)

getAppName

public String getAppName()

Returns:

The name of the application under test.

getTestName

public String getTestName()

setBranchName

public com.applitools.eyes.config.Configuration setBranchName(String branchName)

Sets the branch in which the baseline for subsequent test runs resides. If the branch does not already exist it will be created under the specified parent branch (see setParentBranchName(java.lang.String)). Changes to the baseline or model of a branch do not propagate to other branches.

Parameters:

branchName - Branch name or null to specify the default branch.

setAgentId

public com.applitools.eyes.config.Configuration setAgentId(String agentId)

getBranchName

public String getBranchName()

Returns:

The current branch (see setBranchName(String)).

getAgentId

public String getAgentId()

setParentBranchName

public com.applitools.eyes.config.Configuration setParentBranchName(String branchName)

Sets the branch under which new branches are created. (see setBranchName(String).

Parameters:

branchName - Branch name or null to specify the default branch.

getParentBranchName

public String getParentBranchName()

Returns:

The name of the current parent branch under which new branches will be created. (see setParentBranchName(String)).

setBaselineBranchName

public com.applitools.eyes.config.Configuration setBaselineBranchName(String branchName)

Sets the branch under which new branches are created. (see setBranchName(String).

Parameters:

branchName - Branch name or null to specify the default branch.

getBaselineBranchName

public String getBaselineBranchName()

Returns:

The name of the current parent branch under which new branches will be created. (see setBaselineBranchName(String)).

setSaveDiffs

public com.applitools.eyes.config.Configuration setSaveDiffs(Boolean saveDiffs)

Automatically save differences as a baseline.

Parameters:

saveDiffs - Sets whether to automatically save differences as baseline.

getSaveDiffs

public Boolean getSaveDiffs()

Returns whether to automatically save differences as a baseline.

Returns:

Whether to automatically save differences as baseline.

setMatchTimeout

public com.applitools.eyes.config.Configuration setMatchTimeout(int ms)

Sets the maximum time (in ms) a match operation tries to perform a match.

Parameters:

ms - Total number of ms to wait for a match.

getMatchTimeout

public int getMatchTimeout()

Returns:

The maximum time in ms.

setSaveNewTests

public com.applitools.eyes.config.Configuration setSaveNewTests(boolean saveNewTests)

Set whether or not new tests are saved by default.

Parameters:

saveNewTests - True if new tests should be saved by default. False otherwise.

getSaveNewTests

public boolean getSaveNewTests()

Returns:

True if new tests are saved by default.

setSaveFailedTests

public com.applitools.eyes.config.Configuration setSaveFailedTests(boolean saveFailedTests)

Set whether or not failed tests are saved by default.

Parameters:

saveFailedTests - True if failed tests should be saved by default, false otherwise.

getSaveFailedTests

public boolean getSaveFailedTests()

Returns:

True if failed tests are saved by default.

setBatch

public com.applitools.eyes.config.Configuration setBatch(com.applitools.eyes.BatchInfo batch)

Sets the batch in which context future tests will run or null if tests are to run standalone.

Parameters:

batch - The batch info to set.

getBatch

public com.applitools.eyes.BatchInfo getBatch()

Returns:

The currently set batch info.

setDefaultMatchSettings

public com.applitools.eyes.config.Configuration setDefaultMatchSettings(com.applitools.eyes.ImageMatchSettings defaultMatchSettings)

Updates the match settings to be used for the session.

Parameters:

defaultMatchSettings - The match settings to be used for the session.

getDefaultMatchSettings

public com.applitools.eyes.ImageMatchSettings getDefaultMatchSettings()

Returns:

The match settings used for the session.

setMatchLevel

public com.applitools.eyes.config.Configuration setMatchLevel(com.applitools.eyes.MatchLevel matchLevel)

This function is deprecated. Please use setDefaultMatchSettings(com.applitools.eyes.ImageMatchSettings) instead.

The test-wide match level to use when checking application screenshot with the expected output.

Parameters:

matchLevel - The match level setting.

Returns:

The match settings used for the session.

See Also:

• MatchLevel

setIgnoreDisplacements

public com.applitools.eyes.config.Configuration setIgnoreDisplacements(boolean isIgnoreDisplacements)

setAccessibilityValidation

public com.applitools.eyes.config.Configuration setAccessibilityValidation(com.applitools.eyes.AccessibilitySettings accessibilityValidation)

setUseDom

public com.applitools.eyes.config.Configuration setUseDom(boolean useDom)

setEnablePatterns

public com.applitools.eyes.config.Configuration setEnablePatterns(boolean enablePatterns)

getMatchLevel

public com.applitools.eyes.MatchLevel getMatchLevel()

Deprecated.

Please usegetDefaultMatchSettings() instead.

Returns:

The test-wide match level.

getIgnoreDisplacements

public boolean getIgnoreDisplacements()

getAccessibilityValidation

public com.applitools.eyes.AccessibilitySettings getAccessibilityValidation()

getUseDom

public boolean getUseDom()

getEnablePatterns

public boolean getEnablePatterns()

getIgnoreCaret

public boolean getIgnoreCaret()

Returns:

Whether to ignore or the blinking caret or not when comparing images.

setIgnoreCaret

public com.applitools.eyes.config.Configuration setIgnoreCaret(boolean value)

Sets the ignore blinking caret value.

Parameters:

value - The ignore value.

getStitchOverlap

public int getStitchOverlap()

Returns the stitching overlap in pixels.

setStitchOverlap

public com.applitools.eyes.config.Configuration setStitchOverlap(int pixels)

Sets the stitching overlap in pixels.

Parameters:

pixels - The width (in pixels) of the overlap.

setHostOS

public com.applitools.eyes.config.Configuration setHostOS(String hostOS)

Parameters:

hostOS - The host OS running the AUT.

getHostOS

public String getHostOS()

Returns:

get the host OS running the AUT.

setHostApp

public com.applitools.eyes.config.Configuration setHostApp(String hostApp)

Parameters:

hostApp - The application running the AUT (e.g., Chrome).

getHostApp

public String getHostApp()

Returns:

The application name running the AUT.

setBaselineName

public void setBaselineName(String baselineName)

Deprecated.

Only available for backward compatibility. See setBaselineEnvName(String).

Parameters:

baselineName - If specified, determines the baseline to compare with and disables automatic baseline inference.

getBaselineName

public String getBaselineName()

Deprecated.

Only available for backward compatibility. See getBaselineEnvName().

Returns:

The baseline name, if specified.

setBaselineEnvName

public com.applitools.eyes.config.Configuration setBaselineEnvName(String baselineEnvName)

If not null, determines the name of the environment of the baseline.

Parameters:

baselineEnvName - The name of the baseline's environment.

setEnvironmentName

public com.applitools.eyes.config.Configuration setEnvironmentName(String environmentName)

getBaselineEnvName

public String getBaselineEnvName()

If not null, determines the name of the environment of the baseline.

Returns:

The name of the baseline's environment, or null if no such name was set.

getEnvironmentName

public String getEnvironmentName()

setEnvName

public void setEnvName(String envName)

If not null specifies a name for the environment in which the application under test is running.

Parameters:

envName - The name of the environment of the baseline.

getEnvName

public String getEnvName()

If not null specifies a name for the environment in which the application under test is running.

Returns:

The name of the environment of the baseline, or null if no such name was set.

setAppEnvironment

@Deprecated
public void setAppEnvironment(String hostOS,
 String hostApp)

Deprecated.

Superseded by setHostOS(String) and setHostApp(String). Sets the OS (e.g., Windows) and application (e.g., Chrome) that host the application under test.

Parameters:

hostOS - The name of the OS hosting the application under test or null to auto-detect.

hostApp - The name of the application hosting the application under test or null to auto-detect.

setConfiguration

public void setConfiguration(com.applitools.eyes.config.Configuration configuration)

getConfiguration

public com.applitools.eyes.config.Configuration getConfiguration()

setProxy

public void setProxy(com.applitools.eyes.AbstractProxySettings proxySettings)

getProxy

public com.applitools.eyes.AbstractProxySettings getProxy()

getApiKey

public String getApiKey()

Specified by:

getApiKey in interface com.applitools.eyes.IEyesBase

setApiKey

public void setApiKey(String apiKey)

getServerUrl

public URI getServerUrl()

Specified by:

getServerUrl in interface com.applitools.eyes.IEyesBase

setServerUrl

public void setServerUrl(String serverUrl)

setIsDisabled

public void setIsDisabled(Boolean isDisabled)

Specified by:

setIsDisabled in interface com.applitools.eyes.IEyesBase

getIsDisabled

public Boolean getIsDisabled()

Specified by:

getIsDisabled in interface com.applitools.eyes.IEyesBase

getFullAgentId

public String getFullAgentId()

Specified by:

getFullAgentId in interface com.applitools.eyes.IEyesBase

getIsOpen

public boolean getIsOpen()

Gets is open.

Specified by:

getIsOpen in interface com.applitools.eyes.IEyesBase

Returns:

Whether a session is open.

setLogHandler

public void setLogHandler(com.applitools.eyes.LogHandler logHandler)

Specified by:

setLogHandler in interface com.applitools.eyes.IEyesBase

getLogHandler

public com.applitools.eyes.LogHandler getLogHandler()

Specified by:

getLogHandler in interface com.applitools.eyes.IEyesBase

getLogger

public com.applitools.eyes.Logger getLogger()

Specified by:

getLogger in interface com.applitools.eyes.IEyesBase

addProperty

public void addProperty(String name,
 String value)

Specified by:

addProperty in interface com.applitools.eyes.IEyesBase

clearProperties

public void clearProperties()

Specified by:

clearProperties in interface com.applitools.eyes.IEyesBase

abortIfNotClosed

public com.applitools.eyes.TestResults abortIfNotClosed()

Specified by:

abortIfNotClosed in interface com.applitools.eyes.IEyesBase

closeAsync

public void closeAsync()

Specified by:

closeAsync in interface com.applitools.eyes.IEyesBase

abortAsync

public void abortAsync()

Specified by:

abortAsync in interface com.applitools.eyes.IEyesBase

abort

public com.applitools.eyes.TestResults abort()

Specified by:

abort in interface com.applitools.eyes.IEyesBase

getResults

public List<com.applitools.eyes.TestResults> getResults(boolean shouldThrowException)

Specified by:

getResults in interface com.applitools.eyes.IEyesBase

getResults

public List<com.applitools.eyes.TestResults> getResults()

Specified by:

getResults in interface com.applitools.eyes.IEyesBase

setImageCut

public void setImageCut(com.applitools.eyes.UnscaledFixedCutProvider unscaledFixedCutProvider)

setDebugScreenshotsPath

public void setDebugScreenshotsPath(String pathToSave)

Sets debug screenshots path.

Parameters:

pathToSave - Path where you want to save the debug screenshots.

getDebugScreenshotsPath

public String getDebugScreenshotsPath()

Gets debug screenshots path.

Returns:

The path where you want to save the debug screenshots.

setDebugScreenshotsPrefix

public void setDebugScreenshotsPrefix(String prefix)

Sets debug screenshots prefix.

Parameters:

prefix - The prefix for the screenshots' names.

getDebugScreenshotsPrefix

public String getDebugScreenshotsPrefix()

Gets debug screenshots prefix.

Returns:

The prefix for the screenshots' names.

setHideScrollbars

public void setHideScrollbars(Boolean hideScrollbars)

setHideCaret

public void setHideCaret(Boolean hideCaret)

setStitchMode

public void setStitchMode(com.applitools.eyes.selenium.StitchMode stitchMode)