com.applitools.eyes.appium

Class Eyes

java.lang.Object

com.applitools.eyes.EyesBase

com.applitools.eyes.appium.Eyes

All Implemented Interfaces:

com.applitools.eyes.IEyesBase

public class Eyes
extends com.applitools.eyes.EyesBase

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_DEVICE_PIXEL_RATIO
protected org.openqa.selenium.WebElement	targetElement
static double	UNKNOWN_DEVICE_PIXEL_RATIO

Fields inherited from class com.applitools.eyes.EyesBase

agentRunId, cutProviderHandler, debugScreenshotsProvider, isOpen, lastScreenshot, logger, positionProviderHandler, runner, runningSession, scaleProviderHandler, serverConnector, sessionStartInfo, testResultContainer, USE_DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
Eyes()

Method Summary

Modifier and Type	Method and Description
void	check(com.applitools.ICheckSettings... checkSettings)
void	check(com.applitools.ICheckSettings checkSettings)
void	check(String name, com.applitools.ICheckSettings checkSettings)
void	checkElement(org.openqa.selenium.By selector)
void	checkElement(org.openqa.selenium.By selector, int matchTimeout, String tag)
void	checkElement(org.openqa.selenium.By selector, String tag)
void	checkElement(org.openqa.selenium.WebElement element)
void	checkElement(org.openqa.selenium.WebElement element, int matchTimeout, String tag)
void	checkElement(org.openqa.selenium.WebElement element, String tag)
protected com.applitools.eyes.MatchResult	checkElement(org.openqa.selenium.WebElement element, String name, com.applitools.ICheckSettings checkSettings)
void	checkRegion(org.openqa.selenium.By selector)
void	checkRegion(org.openqa.selenium.By selector, boolean stitchContent)
void	checkRegion(org.openqa.selenium.By selector, int matchTimeout, String tag)
void	checkRegion(org.openqa.selenium.By selector, int matchTimeout, String tag, boolean stitchContent)
void	checkRegion(org.openqa.selenium.By selector, String tag)
void	checkRegion(org.openqa.selenium.By selector, String tag, boolean stitchContent)
void	checkRegion(com.applitools.eyes.Region region)
void	checkRegion(com.applitools.eyes.Region region, int matchTimeout, String tag)
protected com.applitools.eyes.MatchResult	checkRegion(String name, com.applitools.ICheckSettings checkSettings)
void	checkRegion(org.openqa.selenium.WebElement element)
void	checkRegion(org.openqa.selenium.WebElement element, int matchTimeout, String tag)
void	checkRegion(org.openqa.selenium.WebElement element, int matchTimeout, String tag, boolean stitchContent)
void	checkRegion(org.openqa.selenium.WebElement element, String tag, boolean stitchContent)
void	checkWindow()
void	checkWindow(int matchTimeout, String tag)
void	checkWindow(String tag)
void	checkWindow(String tag, boolean fully)
com.applitools.eyes.TestResults	close(boolean throwEx)
protected void	ensureViewportSize()
String	getAgentId()
Object	getAgentSetup()
protected com.applitools.eyes.AppEnvironment	getAppEnvironment()
protected void	getAppOutputForOcr(BaseOcrRegion ocrRegion)
String	getBaseAgentId()
String	getBaselineBranchName()
String	getBaselineEnvName()
com.applitools.eyes.BatchInfo	getBatch()
String	getBranchName()
Configuration	getConfiguration()
protected com.applitools.eyes.config.Configuration	getConfigurationInstance()
com.applitools.eyes.ImageMatchSettings	getDefaultMatchSettings()
double	getDevicePixelRatio()
org.openqa.selenium.WebDriver	getDriver()
String	getEnvName()
boolean	getForceFullPageScreenshot()
protected EyesAppiumScreenshot	getFullPageScreenshot()
String	getHostApp()
String	getHostOS()
boolean	getIgnoreCaret()
boolean	getIgnoreDisplacements()
protected String	getInferredEnvironment()
com.applitools.eyes.MatchLevel	getMatchLevel()
int	getMatchTimeout()
String	getParentBranchName()
ImageRotation	getRotation()
Boolean	getSaveDiffs()
boolean	getSaveNewTests() Gets save new tests.
protected com.applitools.eyes.EyesScreenshot	getScreenshot(com.applitools.eyes.Region targetRegion, com.applitools.eyes.fluent.ICheckSettingsInternal checkSettingsInternal)
protected com.applitools.eyes.capture.ScreenshotProvider	getScreenshotProvider()
boolean	getScrollToRegion() Gets scroll to region.
protected EyesAppiumScreenshot	getSimpleScreenshot()
int	getStitchOverlap() Gets stitch overlap.
protected String	getTitle()
protected com.applitools.eyes.RectangleSize	getViewportSize()
Map<String,List<com.applitools.eyes.Region>>	locate(VisualLocatorSettings visualLocatorSettings)
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, com.applitools.eyes.config.Configuration configuration)
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName)
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName, com.applitools.eyes.RectangleSize viewportSize) See open(WebDriver, String, String, RectangleSize, SessionType).
protected org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName, com.applitools.eyes.RectangleSize viewportSize, com.applitools.eyes.SessionType sessionType) Starts a test.
void	setAgentId(String agentId)
void	setBaselineBranchName(String branchName)
void	setBaselineEnvName(String baselineEnvName)
com.applitools.eyes.config.Configuration	setBatch(com.applitools.eyes.BatchInfo batch)
void	setBranchName(String branchName)
void	setConfiguration(com.applitools.eyes.config.Configuration configuration)
void	setDefaultMatchSettings(com.applitools.eyes.ImageMatchSettings defaultMatchSettings)
void	setEnvName(String envName)
void	setForceFullPageScreenshot(boolean shouldForce)
void	setHostApp(String hostApp)
void	setHostOS(String hostOS)
void	setIgnoreCaret(boolean value)
void	setIgnoreDisplacements(boolean isIgnoreDisplacements)
void	setMatchLevel(com.applitools.eyes.MatchLevel matchLevel)
void	setMatchTimeout(int ms) Sets the maximum time (in ms) a match operation tries to perform a match.
void	setParentBranchName(String branchName)
void	setRotation(ImageRotation rotation)
void	setSaveDiffs(Boolean saveDiffs)
void	setSaveNewTests(boolean saveNewTests) Set whether or not new tests are saved by default.
void	setScrollToRegion(boolean shouldScroll)
void	setStitchOverlap(int pixels) Sets the stitching overlap in pixels.
protected com.applitools.eyes.config.Configuration	setViewportSize(com.applitools.eyes.RectangleSize size)
boolean	shouldStitchContent()
protected String	tryCaptureDom()
protected void	tryUpdateDevicePixelRatio()

Methods inherited from class com.applitools.eyes.EyesBase

abort, abortAsync, abortIfNotClosed, addMouseTriggerBase, addProperty, addProperty, addTextTriggerBase, addUserInput, checkWindowBase, checkWindowBase, checkWindowBase, checkWindowBase, checkWindowBase, clearProperties, clearUserInputs, close, closeAsync, extractText, extractTextRegions, fireValidationWillStartEvent, getApiKey, getAppName, getDebugScreenshotsPath, getDebugScreenshotsPrefix, getDebugScreenshotsProvider, getDefaultServerUrl, getDevicesSizes, getFullAgentId, getIsCutProviderExplicitlySet, getIsDisabled, getIsOpen, getIsScaleProviderExplicitlySet, getLogger, getLogHandler, getMobileDeviceInfo, getPositionProvider, getProxy, getRenderingInfo, getSaveDebugScreenshots, getScaleRatio, getServerConnector, getServerUrl, getTestId, getTestName, getUserAgents, getUserInputs, getViewportSizeForOpen, isCompleted, isSendDom, logSessionResultsAndThrowException, openBase, openCompleted, openLogger, performMatch, prepareForMatch, prepareForOpen, prepareStopSession, setApiKey, setDebugScreenshotsPath, setDebugScreenshotsPrefix, setEffectiveViewportSize, setExplicitViewportSize, setImageCut, setIsDisabled, setIsDisabled, setLogHandler, setPositionProvider, setProxy, setSaveDebugScreenshots, setScaleRatio, setSendDom, setServerConnector, setServerUrl, setServerUrl, setTestId, shouldCaptureDom, stopSession, tryCaptureAndPostDom, validateResult

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_DEVICE_PIXEL_RATIO

public static final double UNKNOWN_DEVICE_PIXEL_RATIO

See Also:

Constant Field Values

DEFAULT_DEVICE_PIXEL_RATIO

public static final double DEFAULT_DEVICE_PIXEL_RATIO

See Also:

Constant Field Values

targetElement

protected org.openqa.selenium.WebElement targetElement

Constructor Detail

Eyes

public Eyes()

Method Detail

open

public org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                          com.applitools.eyes.config.Configuration configuration)

open

public org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                          String appName,
                                          String testName,
                                          com.applitools.eyes.RectangleSize viewportSize)

See open(WebDriver, String, String, RectangleSize, SessionType). sessionType defaults to null.

open

public org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                          String appName,
                                          String testName)

open

protected org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                             String appName,
                                             String testName,
                                             com.applitools.eyes.RectangleSize viewportSize,
                                             com.applitools.eyes.SessionType sessionType)

Starts a test.

Parameters:

driver - 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.

sessionType - The type of test (e.g., standard test / visual performance test).

Returns:

A wrapped WebDriver which enables Eyes trigger recording and frame handling.

checkWindow

public void checkWindow()

checkWindow

public void checkWindow(String tag)

checkWindow

public void checkWindow(int matchTimeout,
                        String tag)

checkWindow

public void checkWindow(String tag,
                        boolean fully)

check

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

ensureViewportSize

protected void ensureViewportSize()

getRotation

public ImageRotation getRotation()

Returns:

The image rotation data.

setRotation

public void setRotation(ImageRotation rotation)

Parameters:

rotation - The image rotation data.

setForceFullPageScreenshot

public void setForceFullPageScreenshot(boolean shouldForce)

getForceFullPageScreenshot

public boolean getForceFullPageScreenshot()

setScrollToRegion

public void setScrollToRegion(boolean shouldScroll)

getScrollToRegion

public boolean getScrollToRegion()

Gets scroll to region.

Returns:

Whether to automatically scroll to a region being validated.

shouldStitchContent

public boolean shouldStitchContent()

getBaseAgentId

public String getBaseAgentId()

Specified by:

getBaseAgentId in class com.applitools.eyes.EyesBase

tryCaptureDom

protected String tryCaptureDom()

Specified by:

tryCaptureDom in class com.applitools.eyes.EyesBase

getViewportSize

protected com.applitools.eyes.RectangleSize getViewportSize()

Specified by:

getViewportSize in class com.applitools.eyes.EyesBase

setViewportSize

protected com.applitools.eyes.config.Configuration setViewportSize(com.applitools.eyes.RectangleSize size)

Specified by:

setViewportSize in class com.applitools.eyes.EyesBase

getInferredEnvironment

protected String getInferredEnvironment()

Specified by:

getInferredEnvironment in class com.applitools.eyes.EyesBase

getDriver

public org.openqa.selenium.WebDriver getDriver()

getAppEnvironment

protected com.applitools.eyes.AppEnvironment getAppEnvironment()

This override also checks for mobile operating system.

Overrides:

getAppEnvironment in class com.applitools.eyes.EyesBase

getDevicePixelRatio

public double getDevicePixelRatio()

tryUpdateDevicePixelRatio

protected void tryUpdateDevicePixelRatio()

check

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

check

public void check(com.applitools.ICheckSettings checkSettings)

close

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

Overrides:

close in class com.applitools.eyes.EyesBase

getAppOutputForOcr

protected void getAppOutputForOcr(BaseOcrRegion ocrRegion)

Specified by:

getAppOutputForOcr in class com.applitools.eyes.EyesBase

getScreenshotProvider

protected com.applitools.eyes.capture.ScreenshotProvider getScreenshotProvider()

Specified by:

getScreenshotProvider in class com.applitools.eyes.EyesBase

setMatchTimeout

public void 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 (RegionProvider, String, boolean, int) waits for a match.

getScreenshot

protected com.applitools.eyes.EyesScreenshot getScreenshot(com.applitools.eyes.Region targetRegion,
                                                           com.applitools.eyes.fluent.ICheckSettingsInternal checkSettingsInternal)

Specified by:

getScreenshot in class com.applitools.eyes.EyesBase

getTitle

protected String getTitle()

Specified by:

getTitle in class com.applitools.eyes.EyesBase

checkElement

protected com.applitools.eyes.MatchResult checkElement(org.openqa.selenium.WebElement element,
                                                       String name,
                                                       com.applitools.ICheckSettings checkSettings)

checkElement

public void checkElement(org.openqa.selenium.WebElement element)

checkElement

public void checkElement(org.openqa.selenium.WebElement element,
                         String tag)

checkElement

public void checkElement(org.openqa.selenium.WebElement element,
                         int matchTimeout,
                         String tag)

checkElement

public void checkElement(org.openqa.selenium.By selector)

checkElement

public void checkElement(org.openqa.selenium.By selector,
                         String tag)

checkElement

public void checkElement(org.openqa.selenium.By selector,
                         int matchTimeout,
                         String tag)

setSaveNewTests

public void 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()

Gets save new tests.

Returns:

True if new tests are saved by default.

setSaveDiffs

public void setSaveDiffs(Boolean saveDiffs)

getSaveDiffs

public Boolean getSaveDiffs()

setDefaultMatchSettings

public void setDefaultMatchSettings(com.applitools.eyes.ImageMatchSettings defaultMatchSettings)

getDefaultMatchSettings

public com.applitools.eyes.ImageMatchSettings getDefaultMatchSettings()

getStitchOverlap

public int getStitchOverlap()

Gets stitch overlap.

Returns:

Returns the stitching overlap in pixels.

setStitchOverlap

public void setStitchOverlap(int pixels)

Sets the stitching overlap in pixels.

Parameters:

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

getFullPageScreenshot

protected EyesAppiumScreenshot getFullPageScreenshot()

getSimpleScreenshot

protected EyesAppiumScreenshot getSimpleScreenshot()

checkRegion

protected com.applitools.eyes.MatchResult checkRegion(String name,
                                                      com.applitools.ICheckSettings checkSettings)

checkRegion

public void checkRegion(com.applitools.eyes.Region region)

checkRegion

public void checkRegion(com.applitools.eyes.Region region,
                        int matchTimeout,
                        String tag)
                 throws com.applitools.eyes.exceptions.TestFailedException

Throws:

com.applitools.eyes.exceptions.TestFailedException

checkRegion

public void checkRegion(org.openqa.selenium.WebElement element)

checkRegion

public void checkRegion(org.openqa.selenium.WebElement element,
                        String tag,
                        boolean stitchContent)

checkRegion

public void checkRegion(org.openqa.selenium.WebElement element,
                        int matchTimeout,
                        String tag)

checkRegion

public void checkRegion(org.openqa.selenium.WebElement element,
                        int matchTimeout,
                        String tag,
                        boolean stitchContent)

checkRegion

public void checkRegion(org.openqa.selenium.By selector)

checkRegion

public void checkRegion(org.openqa.selenium.By selector,
                        boolean stitchContent)

checkRegion

public void checkRegion(org.openqa.selenium.By selector,
                        String tag)

checkRegion

public void checkRegion(org.openqa.selenium.By selector,
                        String tag,
                        boolean stitchContent)

checkRegion

public void checkRegion(org.openqa.selenium.By selector,
                        int matchTimeout,
                        String tag)

checkRegion

public void checkRegion(org.openqa.selenium.By selector,
                        int matchTimeout,
                        String tag,
                        boolean stitchContent)

locate

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

getConfiguration

public Configuration getConfiguration()

Overrides:

getConfiguration in class com.applitools.eyes.EyesBase

setBranchName

public void setBranchName(String branchName)

getBranchName

public String getBranchName()

setParentBranchName

public void setParentBranchName(String branchName)

getParentBranchName

public String getParentBranchName()

setBatch

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

Overrides:

setBatch in class com.applitools.eyes.EyesBase

getConfigurationInstance

protected com.applitools.eyes.config.Configuration getConfigurationInstance()

Specified by:

getConfigurationInstance in class com.applitools.eyes.EyesBase

getBatch

public com.applitools.eyes.BatchInfo getBatch()

setAgentId

public void setAgentId(String agentId)

getAgentId

public String getAgentId()

setHostOS

public void setHostOS(String hostOS)

getHostOS

public String getHostOS()

setHostApp

public void setHostApp(String hostApp)

getHostApp

public String getHostApp()

getIgnoreCaret

public boolean getIgnoreCaret()

setIgnoreCaret

public void setIgnoreCaret(boolean value)

setMatchLevel

public void setMatchLevel(com.applitools.eyes.MatchLevel matchLevel)

getMatchLevel

public com.applitools.eyes.MatchLevel getMatchLevel()

setEnvName

public void setEnvName(String envName)

getEnvName

public String getEnvName()

setBaselineEnvName

public void setBaselineEnvName(String baselineEnvName)

getBaselineEnvName

public String getBaselineEnvName()

Overrides:

getBaselineEnvName in class com.applitools.eyes.EyesBase

setBaselineBranchName

public void setBaselineBranchName(String branchName)

getBaselineBranchName

public String getBaselineBranchName()

setIgnoreDisplacements

public void setIgnoreDisplacements(boolean isIgnoreDisplacements)

getIgnoreDisplacements

public boolean getIgnoreDisplacements()

setConfiguration

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

getAgentSetup

public Object getAgentSetup()

Overrides:

getAgentSetup in class com.applitools.eyes.EyesBase