com.applitools.eyes

Class Eyes

java.lang.Object

com.applitools.eyes.Eyes

public class Eyes
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected com.applitools.eyes.AgentConnector	agentConnector
static String	DEFAULT_CHARSET_NAME
protected static com.applitools.eyes.MatchLevel	DEFAULT_MATCH_LEVEL
protected com.applitools.eyes.EyesScreenshot	lastScreenshot
protected com.applitools.eyes.RunningSession	runningSession
protected com.applitools.eyes.SessionStartInfo	sessionStartInfo
protected com.applitools.eyes.RectangleSize	viewportSize

Constructor Summary

Constructors

Constructor and Description
Eyes() Creates a new Eyes instance that interacts with the Eyes cloud service.
Eyes(URI serverUrl) Creates a new Eyes instance that interacts with the Eyes Server at the specified url.
Eyes(URI serverUrl, boolean isDisabled) Creates a new (possibly disabled) Eyes instance that interacts with the Eyes Server at the specified url.

Method Summary

Methods

Modifier and Type	Method and Description
void	abortIfNotClosed()
protected void	addMouseTrigger(com.applitools.eyes.MouseAction action, com.applitools.eyes.Region control, com.applitools.eyes.Location cursor) Adds a mouse trigger.
protected void	addMouseTrigger(com.applitools.eyes.MouseAction action, org.openqa.selenium.WebElement element) Adds a mouse trigger.
protected void	addTextTrigger(com.applitools.eyes.Region control, String text) Adds a keyboard trigger.
protected void	addTextTrigger(org.openqa.selenium.WebElement element, String text) Adds a keyboard trigger.
protected void	addUserInput(com.applitools.eyes.Trigger arg0)
protected void	checkRegion(BufferedImage arg0, com.applitools.eyes.Region arg1, String arg2, boolean arg3)
void	checkRegion(org.openqa.selenium.By selector) checkRegion(By selector, String tag).
void	checkRegion(org.openqa.selenium.By selector, String tag) Takes a snapshot of the application under test and matches a region specified by the given selector with the expected region output.
void	checkRegion(com.applitools.eyes.Region region) checkRegion(Region region, String tag).
void	checkRegion(com.applitools.eyes.Region region, String tag) Takes a snapshot of the application under test and matches a specific region within it with the expected output.
void	checkRegion(org.openqa.selenium.WebElement element) checkRegion(WebElement element, String tag).
void	checkRegion(org.openqa.selenium.WebElement element, String tag) Takes a snapshot of the application under test and matches a region of a specific element with the expected region output.
void	checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector) checkRegionInFrame(int frameIndex, By selector, String tag).
void	checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, String tag) Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
void	checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector) checkRegionInFrame(String frameNameOrId, By selector, String tag).
void	checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector, String tag) Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
void	checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector) checkRegionInFrame(WebElement frameReference, By selector, String tag).
void	checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector, String tag) Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
void	checkWindow() checkWindow(String tag).
protected void	checkWindow(BufferedImage arg0, String arg1, boolean arg2)
void	checkWindow(String tag) Takes a snapshot of the application under test and matches it with the expected output.
protected void	clearUserInputs()
com.applitools.eyes.TestResults	close()
com.applitools.eyes.TestResults	close(boolean arg0)
String	getAgentId()
static String	getApiKey() Gets the currently set API key or null if no key is set.
static URI	getDefaultServerUrl()
protected com.applitools.eyes.AppEnvironment	getEnvironment() This override also checks for mobile operating system.
com.applitools.eyes.FailureReports	getFailureReports()
protected String	getInferredEnvironment()
boolean	getIsDisabled()
boolean	getIsOpen()
protected com.applitools.eyes.EyesScreenshot	getLastScreenshot()
static com.applitools.eyes.ProxySettings	getProxy() Get the current proxy settings.
boolean	getSaveFailedTests()
boolean	getSaveNewTests()
protected String	getTitle()
protected com.applitools.eyes.Trigger[]	getUserInputs()
protected com.applitools.eyes.RectangleSize	getViewportSize()
protected void	handleMatchResult(com.applitools.eyes.MatchResult matchResult, String tag)
void	open(String arg0, String arg1, com.applitools.eyes.RectangleSize arg2, com.applitools.eyes.MatchLevel arg3, com.applitools.eyes.FailureReports arg4)
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName) Starts a test for any viewport size that reports failures upon test completion.
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName, com.applitools.eyes.RectangleSize viewportSize) Starts a test that reports failures upon test completion.
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName, com.applitools.eyes.RectangleSize viewportSize, com.applitools.eyes.FailureReports failureReports) Starts a test.
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName, com.applitools.eyes.RectangleSize viewportSize, com.applitools.eyes.MatchLevel matchLevel) Starts a test that reports failures upon test completion.
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName, com.applitools.eyes.RectangleSize viewportSize, com.applitools.eyes.MatchLevel matchLevel, com.applitools.eyes.FailureReports failureReports) Starts a test.
protected void	resetLastScreenshot()
static void	setApiKey(String apiKey) Sets the API key of your applitools Eyes account.
void	setAppEnvironment(String arg0, String arg1)
void	setBatch(com.applitools.eyes.BatchInfo arg0)
void	setBranchName(String arg0)
void	setForceFullPageScreenshot(boolean shouldForce) Tells Eyes whether to force a full page screenshot if the browser only provides a screenshot of the viewport (full screenshot will be composed by scrolling and stitching viewport screenshots).
static void	setLogHandler(com.applitools.eyes.LogHandler logHandler) Sets a handler of log messages generated by this API.
void	setMatchTimeout(int seconds) Sets the maximal time (in seconds) checkWindow(java.lang.String) waits for a match.
protected void	setMatchWindowTask(com.applitools.eyes.MatchWindowTask matchWindowTask) Used for unit testing.
void	setParentBranchName(String arg0)
static void	setProxy(com.applitools.eyes.ProxySettings proxySettings) Sets a proxy.
void	setSaveFailedTests(boolean arg0)
void	setSaveNewTests(boolean arg0)
protected void	setViewportSize(com.applitools.eyes.RectangleSize size)
protected void	startSession()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MATCH_LEVEL

protected static final com.applitools.eyes.MatchLevel DEFAULT_MATCH_LEVEL

DEFAULT_CHARSET_NAME

public static final String DEFAULT_CHARSET_NAME

See Also:

Constant Field Values

agentConnector

protected com.applitools.eyes.AgentConnector agentConnector

runningSession

protected com.applitools.eyes.RunningSession runningSession

sessionStartInfo

protected com.applitools.eyes.SessionStartInfo sessionStartInfo

viewportSize

protected com.applitools.eyes.RectangleSize viewportSize

lastScreenshot

protected com.applitools.eyes.EyesScreenshot lastScreenshot

Constructor Detail

Eyes

public Eyes(URI serverUrl,
    boolean isDisabled)

Creates a new (possibly disabled) Eyes instance that interacts with the Eyes Server at the specified url.

Parameters:

serverUrl - The Eyes server URL.

isDisabled - If true, all interactions with this API will be silently ignored.

Eyes

public Eyes(URI serverUrl)

Creates a new Eyes instance that interacts with the Eyes Server at the specified url.

Parameters:

serverUrl - The Eyes server URL.

Eyes

public Eyes()

Creates a new Eyes instance that interacts with the Eyes cloud service.

Method Detail

setLogHandler

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

Sets a handler of log messages generated by this API.

Parameters:

logHandler - Handles log messages generated by this API.

setApiKey

public static void setApiKey(String apiKey)

Sets the API key of your applitools Eyes account.

getApiKey

public static String getApiKey()

Gets the currently set API key or null if no key is set.

setProxy

public static void setProxy(com.applitools.eyes.ProxySettings proxySettings)

Sets a proxy. Set null to remove existing proxy settings.

getProxy

public static com.applitools.eyes.ProxySettings getProxy()

Get the current proxy settings.

getAgentId

public String getAgentId()

open

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

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 allow any viewport size.

matchLevel - The test-wide match level to use when comparing actual application outputs with expected outputs (overrides stricter step-specific match levels).

failureReports - Specifies how detected failures are reported.

open

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

Starts a test that reports failures upon test completion.

See open(org.openqa.selenium.WebDriver, java.lang.String, java.lang.String, com.applitools.eyes.RectangleSize, com.applitools.eyes.MatchLevel, com.applitools.eyes.FailureReports).

open

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

Starts a test.

See open(org.openqa.selenium.WebDriver, java.lang.String, java.lang.String, com.applitools.eyes.RectangleSize, com.applitools.eyes.MatchLevel, com.applitools.eyes.FailureReports).

open

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

Starts a test that reports failures upon test completion.

See open(org.openqa.selenium.WebDriver, java.lang.String, java.lang.String, com.applitools.eyes.RectangleSize, com.applitools.eyes.MatchLevel, com.applitools.eyes.FailureReports).

open

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

Starts a test for any viewport size that reports failures upon test completion.

See open(org.openqa.selenium.WebDriver, java.lang.String, java.lang.String, com.applitools.eyes.RectangleSize, com.applitools.eyes.MatchLevel, com.applitools.eyes.FailureReports)

handleMatchResult

protected void handleMatchResult(com.applitools.eyes.MatchResult matchResult,
                     String tag)

checkWindow

public void checkWindow(String tag)

Takes a snapshot of the application under test and matches it with the expected output.

Parameters:

tag - An optional tag to be associated with the snapshot.

Throws:

TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.

checkWindow

public void checkWindow()

checkWindow(String tag). Tag defaults to null.

checkRegion

public void checkRegion(com.applitools.eyes.Region region,
               String tag)

Takes a snapshot of the application under test and matches a specific region within it with the expected output.

Parameters:

region - A non empty region representing the screen region to check.

tag - An optional tag to be associated with the snapshot.

Throws:

TestFailedException - Thrown if a mismatch is detected and immediate failure reports are enabled.

checkRegion

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

checkRegion(Region region, String tag). Tag defaults to null.

checkRegion

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

Takes a snapshot of the application under test and matches a region of a specific element with the expected region output.

Parameters:

element - The element which represents the region to check.

tag - An optional tag to be associated with the snapshot.

Throws:

TestFailedException - if a mismatch is detected and immediate failure reports are enabled

checkRegion

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

checkRegion(WebElement element, String tag). Tag defaults to null.

checkRegion

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

Takes a snapshot of the application under test and matches a region specified by the given selector with the expected region output.

Parameters:

selector - Selects the region to check.

tag - An optional tag to be associated with the snapshot.

Throws:

TestFailedException - if a mismatch is detected and immediate failure reports are enabled

checkRegion

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

checkRegion(By selector, String tag). Tag defaults to null.

checkRegionInFrame

public void checkRegionInFrame(int frameIndex,
                      org.openqa.selenium.By selector,
                      String tag)

Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.

Parameters:

frameIndex - The index of the frame to switch to. (The same index as would be used in a call to driver.switchTo().frame()).

selector - A Selector specifying the region to check.

tag - An optional tag to be associated with the snapshot.

checkRegionInFrame

public void checkRegionInFrame(int frameIndex,
                      org.openqa.selenium.By selector)

checkRegionInFrame(int frameIndex, By selector, String tag). Tag defaults to null

checkRegionInFrame

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

Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.

Parameters:

frameNameOrId - The name or id of the frame to switch to. (as would be used in a call to driver.switchTo().frame()).

selector - A Selector specifying the region to check.

tag - An optional tag to be associated with the snapshot.

checkRegionInFrame

public void checkRegionInFrame(String frameNameOrId,
                      org.openqa.selenium.By selector)

checkRegionInFrame(String frameNameOrId, By selector, String tag). Tag defaults to null

checkRegionInFrame

public void checkRegionInFrame(org.openqa.selenium.WebElement frameReference,
                      org.openqa.selenium.By selector,
                      String tag)

Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.

Parameters:

frameReference - The element which is the frame to switch to. (as would be used in a call to driver.switchTo().frame()).

selector - A Selector specifying the region to check.

tag - An optional tag to be associated with the snapshot.

checkRegionInFrame

public void checkRegionInFrame(org.openqa.selenium.WebElement frameReference,
                      org.openqa.selenium.By selector)

checkRegionInFrame(WebElement frameReference, By selector, String tag). Tag defaults to null

setMatchWindowTask

protected void setMatchWindowTask(com.applitools.eyes.MatchWindowTask matchWindowTask)

Used for unit testing.

setMatchTimeout

public void setMatchTimeout(int seconds)

Sets the maximal time (in seconds) checkWindow(java.lang.String) waits for a match.

Parameters:

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

setForceFullPageScreenshot

public void setForceFullPageScreenshot(boolean shouldForce)

Tells Eyes whether to force a full page screenshot if the browser only provides a screenshot of the viewport (full screenshot will be composed by scrolling and stitching viewport screenshots).

Parameters:

shouldForce - Weather to force full screenshot or not.

getTitle

protected String getTitle()

getViewportSize

protected com.applitools.eyes.RectangleSize getViewportSize()

addMouseTrigger

protected void addMouseTrigger(com.applitools.eyes.MouseAction action,
                   com.applitools.eyes.Region control,
                   com.applitools.eyes.Location cursor)

Adds a mouse trigger.

Parameters:

action - Mouse action.

control - The control on which the trigger is activated (location is relative to the window).

cursor - The cursor's position relative to the control.

addMouseTrigger

protected void addMouseTrigger(com.applitools.eyes.MouseAction action,
                   org.openqa.selenium.WebElement element)

Adds a mouse trigger.

Parameters:

action - Mouse action.

element - The WebElement on which the click was called.

addTextTrigger

protected void addTextTrigger(com.applitools.eyes.Region control,
                  String text)

Adds a keyboard trigger.

Parameters:

control - The control's position relative to the window.

text - The trigger's text.

addTextTrigger

protected void addTextTrigger(org.openqa.selenium.WebElement element,
                  String text)

Adds a keyboard trigger.

Parameters:

element - The element for which we sent keys.

text - The trigger's text.

setViewportSize

protected void setViewportSize(com.applitools.eyes.RectangleSize size)

getInferredEnvironment

protected String getInferredEnvironment()

startSession

protected void startSession()

getEnvironment

protected com.applitools.eyes.AppEnvironment getEnvironment()

This override also checks for mobile operating system.

getIsDisabled

public boolean getIsDisabled()

getIsOpen

public boolean getIsOpen()

getFailureReports

public com.applitools.eyes.FailureReports getFailureReports()

getSaveNewTests

public boolean getSaveNewTests()

setSaveNewTests

public void setSaveNewTests(boolean arg0)

getSaveFailedTests

public boolean getSaveFailedTests()

setSaveFailedTests

public void setSaveFailedTests(boolean arg0)

open

public void open(String arg0,
        String arg1,
        com.applitools.eyes.RectangleSize arg2,
        com.applitools.eyes.MatchLevel arg3,
        com.applitools.eyes.FailureReports arg4)

close

public com.applitools.eyes.TestResults close()

close

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

abortIfNotClosed

public void abortIfNotClosed()

setBranchName

public void setBranchName(String arg0)

setParentBranchName

public void setParentBranchName(String arg0)

setAppEnvironment

public void setAppEnvironment(String arg0,
                     String arg1)

setBatch

public void setBatch(com.applitools.eyes.BatchInfo arg0)

getDefaultServerUrl

public static URI getDefaultServerUrl()

getLastScreenshot

protected com.applitools.eyes.EyesScreenshot getLastScreenshot()

checkRegion

protected void checkRegion(BufferedImage arg0,
               com.applitools.eyes.Region arg1,
               String arg2,
               boolean arg3)

checkWindow

protected void checkWindow(BufferedImage arg0,
               String arg1,
               boolean arg2)

addUserInput

protected void addUserInput(com.applitools.eyes.Trigger arg0)

resetLastScreenshot

protected void resetLastScreenshot()

clearUserInputs

protected void clearUserInputs()

getUserInputs

protected com.applitools.eyes.Trigger[] getUserInputs()