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.EyesScreenshot	lastScreenshot
protected Logger	logger
protected com.applitools.eyes.PositionProvider	positionProvider
protected com.applitools.eyes.RunningSession	runningSession
protected com.applitools.utils.PropertyHandler<com.applitools.eyes.ScaleProvider>	scaleProviderHandler
protected ServerConnector	serverConnector
protected com.applitools.eyes.SessionStartInfo	sessionStartInfo
protected static int	USE_DEFAULT_TIMEOUT
protected RectangleSize	viewportSize

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	abortIfNotClosed()
void	addMouseTrigger(MouseAction action, Region control, Location cursor)
protected void	addMouseTriggerBase(MouseAction arg0, Region arg1, Location arg2)
void	addTextTrigger(Region control, String text)
protected void	addTextTriggerBase(Region arg0, String arg1)
protected void	addUserInput(com.applitools.eyes.Trigger arg0)
boolean	checkImage(BufferedImage image)
boolean	checkImage(BufferedImage image, String tag)
boolean	checkImage(BufferedImage image, String tag, boolean ignoreMismatch) Matches the input image with the next expected image.
boolean	checkImage(byte[] image)
boolean	checkImage(byte[] image, String tag) See checkImage(byte[], String, boolean).
boolean	checkImage(byte[] image, String tag, boolean ignoreMismatch) Matches the input image with the next expected image.
boolean	checkImage(String path)
boolean	checkImage(String path, String tag) See checkImage(String, String, boolean).
boolean	checkImage(String path, String tag, boolean ignoreMismatch) Matches the image stored in the input file with the next expected image.
void	checkRegion(BufferedImage image, Region region)
void	checkRegion(BufferedImage image, Region region, String tag)
boolean	checkRegion(BufferedImage image, Region region, String tag, boolean ignoreMismatch) Perform visual validation for the current image.
boolean	checkWindow(BufferedImage image) Deprecated.
boolean	checkWindow(BufferedImage image, String tag) Deprecated.
boolean	checkWindow(BufferedImage image, String tag, boolean ignoreMismatch) Deprecated.
protected com.applitools.eyes.MatchResult	checkWindowBase(com.applitools.eyes.RegionProvider arg0, String arg1, boolean arg2)
protected com.applitools.eyes.MatchResult	checkWindowBase(com.applitools.eyes.RegionProvider arg0, String arg1, boolean arg2, int arg3)
protected void	clearUserInputs()
TestResults	close()
TestResults	close(boolean arg0)
protected void	closeResponseTime(boolean arg0)
String	getAgentId()
String	getApiKey()
protected com.applitools.eyes.AppEnvironment	getAppEnvironment()
String	getAppName()
String	getBaseAgentId()
String	getBaselineName()
BatchInfo	getBatch()
String	getBranchName()
ImageMatchSettings	getDefaultMatchSettings()
static URI	getDefaultServerUrl()
FailureReports	getFailureReports()
protected String	getFullAgentId()
String	getHostApp()
String	getHostOS()
protected String	getInferredEnvironment()
boolean	getIsDisabled()
boolean	getIsOpen()
LogHandler	getLogHandler()
MatchLevel	getMatchLevel()
int	getMatchTimeout()
String	getParentBranchName()
protected com.applitools.eyes.PositionProvider	getPositionProvider()
ProxySettings	getProxy()
boolean	getSaveFailedTests()
boolean	getSaveNewTests()
protected ScaleMethod	getScaleMethod()
double	getScaleRatio()
com.applitools.eyes.EyesScreenshot	getScreenshot()
URI	getServerUrl()
protected String	getTitle()
protected com.applitools.eyes.Trigger[]	getUserInputs()
RectangleSize	getViewportSize()
void	open(String appName, String testName)
void	open(String appName, String testName, RectangleSize dimensions) Starts a test.
void	openBase(String arg0, String arg1, RectangleSize arg2, SessionType arg3)
void	setAgentId(String arg0)
void	setApiKey(String arg0)
void	setAppEnvironment(String arg0, String arg1) Deprecated.
void	setAppName(String arg0)
void	setBaselineName(String arg0)
void	setBatch(BatchInfo arg0)
void	setBranchName(String arg0)
void	setDefaultMatchSettings(ImageMatchSettings arg0)
void	setFailureReports(FailureReports arg0)
void	setHostApp(String arg0)
void	setHostOS(String arg0)
void	setInferredEnvironment(String inferred)
void	setIsDisabled(boolean arg0)
void	setLogHandler(LogHandler arg0)
void	setMatchLevel(MatchLevel arg0)
void	setMatchTimeout(int arg0)
void	setParentBranchName(String arg0)
protected void	setPositionProvider(com.applitools.eyes.PositionProvider arg0)
void	setProxy(ProxySettings arg0)
void	setSaveFailedTests(boolean arg0)
void	setSaveNewTests(boolean arg0)
protected void	setScaleMethod(ScaleMethod arg0)
void	setScaleRatio(Double arg0)
void	setServerUrl(URI arg0)
void	setViewportSize(RectangleSize size)
protected void	startSession()
protected com.applitools.eyes.MatchWindowDataWithScreenshot	testResponseTimeBase(com.applitools.eyes.RegionProvider arg0, Runnable arg1, int arg2, int arg3, long arg4)

Methods inherited from class java.lang.Object

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

Field Detail

USE_DEFAULT_TIMEOUT

protected static final int USE_DEFAULT_TIMEOUT

See Also:

Constant Field Values

serverConnector

protected ServerConnector serverConnector

runningSession

protected com.applitools.eyes.RunningSession runningSession

sessionStartInfo

protected com.applitools.eyes.SessionStartInfo sessionStartInfo

viewportSize

protected RectangleSize viewportSize

lastScreenshot

protected com.applitools.eyes.EyesScreenshot lastScreenshot

scaleProviderHandler

protected com.applitools.utils.PropertyHandler<com.applitools.eyes.ScaleProvider> scaleProviderHandler

positionProvider

protected com.applitools.eyes.PositionProvider positionProvider

logger

protected Logger logger

Constructor Detail

Eyes

public Eyes(URI serverUrl)

Creates a new (possibly disabled) 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 Server at the specified url.

Method Detail

getBaseAgentId

public String getBaseAgentId()

open

public void open(String appName,
                 String testName,
                 RectangleSize dimensions)

Starts a test.

Parameters:

appName - The name of the application under test.

testName - The test name.

dimensions - Determines the resolution used for the baseline. null will automatically grab the resolution from the image.

open

public void open(String appName,
                 String testName)

checkWindow

@Deprecated
public boolean checkWindow(BufferedImage image)

Deprecated.

checkWindow

@Deprecated
public boolean checkWindow(BufferedImage image,
                                       String tag)

Deprecated.

checkWindow

@Deprecated
public boolean checkWindow(BufferedImage image,
                                       String tag,
                                       boolean ignoreMismatch)

Deprecated.

checkImage

public boolean checkImage(BufferedImage image)

checkImage

public boolean checkImage(BufferedImage image,
                          String tag)

checkImage

public boolean checkImage(BufferedImage image,
                          String tag,
                          boolean ignoreMismatch)

Matches the input image with the next expected image.

Parameters:

image - The image to perform visual validation for.

tag - An optional tag to be associated with the validation checkpoint.

ignoreMismatch - True if the server should ignore a negative result for the visual validation.

Returns:

True if the image matched the expected output, false otherwise.

Throws:

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

checkImage

public boolean checkImage(String path)

checkImage

public boolean checkImage(String path,
                          String tag)

See checkImage(String, String, boolean). ignoreMismatch defaults to false.

Parameters:

path - The path to the image to check.

tag - The tag to be associated with the visual checkpoint.

Returns:

Whether or not the image matched the baseline.

checkImage

public boolean checkImage(String path,
                          String tag,
                          boolean ignoreMismatch)

Matches the image stored in the input file with the next expected image. See checkImage(BufferedImage, String, boolean).

Parameters:

path - The base64 representation of the image's raw bytes.

tag - An optional tag to be associated with the validation checkpoint.

ignoreMismatch - True if the server should ignore a negative result for the visual validation.

Returns:

Whether or not the image matched the baseline.

checkImage

public boolean checkImage(byte[] image)

checkImage

public boolean checkImage(byte[] image,
                          String tag)

See checkImage(byte[], String, boolean). ignoreMismatch defaults to false.

Parameters:

image - The raw png bytes of the image to perform visual validation for.

tag - An optional tag to be associated with the validation checkpoint.

Returns:

Whether or not the image matched the baseline.

checkImage

public boolean checkImage(byte[] image,
                          String tag,
                          boolean ignoreMismatch)

Matches the input image with the next expected image. See checkImage(BufferedImage, String, boolean).

Parameters:

image - The raw png bytes of the image to perform visual validation for.

tag - An optional tag to be associated with the validation checkpoint.

ignoreMismatch - True if the server should ignore a negative result for the visual validation.

Returns:

Whether or not the image matched the baseline.

checkRegion

public boolean checkRegion(BufferedImage image,
                           Region region,
                           String tag,
                           boolean ignoreMismatch)

Perform visual validation for the current image.

Parameters:

image - The image to perform visual validation for.

region - The region to validate within the image.

tag - An optional tag to be associated with the validation checkpoint.

ignoreMismatch - True if the server should ignore a negative result for the visual validation.

Returns:

Whether or not the image matched the baseline.

Throws:

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

checkRegion

public void checkRegion(BufferedImage image,
                        Region region,
                        String tag)

checkRegion

public void checkRegion(BufferedImage image,
                        Region region)

addMouseTrigger

public void addMouseTrigger(MouseAction action,
                            Region control,
                            Location cursor)

addTextTrigger

public void addTextTrigger(Region control,
                           String text)

getViewportSize

public RectangleSize getViewportSize()

setViewportSize

public void setViewportSize(RectangleSize size)

getInferredEnvironment

protected String getInferredEnvironment()

setInferredEnvironment

public void setInferredEnvironment(String inferred)

getScreenshot

public com.applitools.eyes.EyesScreenshot getScreenshot()

getTitle

protected String getTitle()

setAgentId

public void setAgentId(String arg0)

getAgentId

public String getAgentId()

setApiKey

public void setApiKey(String arg0)

getApiKey

public String getApiKey()

setServerUrl

public void setServerUrl(URI arg0)

getServerUrl

public URI getServerUrl()

setProxy

public void setProxy(ProxySettings arg0)

getProxy

public ProxySettings getProxy()

setIsDisabled

public void setIsDisabled(boolean arg0)

getIsDisabled

public boolean getIsDisabled()

setAppName

public void setAppName(String arg0)

getAppName

public String getAppName()

setBranchName

public void setBranchName(String arg0)

getBranchName

public String getBranchName()

setParentBranchName

public void setParentBranchName(String arg0)

getParentBranchName

public String getParentBranchName()

clearUserInputs

protected void clearUserInputs()

getUserInputs

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

setMatchTimeout

public void setMatchTimeout(int arg0)

getMatchTimeout

public int getMatchTimeout()

setSaveNewTests

public void setSaveNewTests(boolean arg0)

getSaveNewTests

public boolean getSaveNewTests()

setSaveFailedTests

public void setSaveFailedTests(boolean arg0)

getSaveFailedTests

public boolean getSaveFailedTests()

setBatch

public void setBatch(BatchInfo arg0)

getBatch

public BatchInfo getBatch()

setFailureReports

public void setFailureReports(FailureReports arg0)

getFailureReports

public FailureReports getFailureReports()

setDefaultMatchSettings

public void setDefaultMatchSettings(ImageMatchSettings arg0)

getDefaultMatchSettings

public ImageMatchSettings getDefaultMatchSettings()

setMatchLevel

public void setMatchLevel(MatchLevel arg0)

getMatchLevel

public MatchLevel getMatchLevel()

getFullAgentId

protected String getFullAgentId()

getIsOpen

public boolean getIsOpen()

getDefaultServerUrl

public static URI getDefaultServerUrl()

setLogHandler

public void setLogHandler(LogHandler arg0)

getLogHandler

public LogHandler getLogHandler()

setScaleRatio

public void setScaleRatio(Double arg0)

getScaleRatio

public double getScaleRatio()

setScaleMethod

protected void setScaleMethod(ScaleMethod arg0)

getScaleMethod

protected ScaleMethod getScaleMethod()

close

public TestResults close()

close

public TestResults close(boolean arg0)

closeResponseTime

protected void closeResponseTime(boolean arg0)

abortIfNotClosed

public void abortIfNotClosed()

setHostOS

public void setHostOS(String arg0)

getHostOS

public String getHostOS()

setHostApp

public void setHostApp(String arg0)

getHostApp

public String getHostApp()

setBaselineName

public void setBaselineName(String arg0)

getBaselineName

public String getBaselineName()

setAppEnvironment

@Deprecated
public void setAppEnvironment(String arg0,
                                          String arg1)

Deprecated.

getPositionProvider

protected com.applitools.eyes.PositionProvider getPositionProvider()

setPositionProvider

protected void setPositionProvider(com.applitools.eyes.PositionProvider arg0)

checkWindowBase

protected com.applitools.eyes.MatchResult checkWindowBase(com.applitools.eyes.RegionProvider arg0,
                                                          String arg1,
                                                          boolean arg2)

checkWindowBase

protected com.applitools.eyes.MatchResult checkWindowBase(com.applitools.eyes.RegionProvider arg0,
                                                          String arg1,
                                                          boolean arg2,
                                                          int arg3)

testResponseTimeBase

protected com.applitools.eyes.MatchWindowDataWithScreenshot testResponseTimeBase(com.applitools.eyes.RegionProvider arg0,
                                                                                 Runnable arg1,
                                                                                 int arg2,
                                                                                 int arg3,
                                                                                 long arg4)

openBase

public void openBase(String arg0,
                     String arg1,
                     RectangleSize arg2,
                     SessionType arg3)

addUserInput

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

addTextTriggerBase

protected void addTextTriggerBase(Region arg0,
                                  String arg1)

addMouseTriggerBase

protected void addMouseTriggerBase(MouseAction arg0,
                                   Region arg1,
                                   Location arg2)

getAppEnvironment

protected com.applitools.eyes.AppEnvironment getAppEnvironment()

startSession

protected void startSession()