com.applitools.eyes.images

Class Eyes

java.lang.Object

com.applitools.eyes.EyesBase

com.applitools.eyes.images.Eyes

public class Eyes
extends EyesBase

Field Summary

Fields inherited from class com.applitools.eyes.EyesBase

cutProviderHandler, debugScreenshotsProvider, lastScreenshot, logger, positionProvider, runningSession, scaleProviderHandler, serverConnector, sessionStartInfo, stitchingOverlap, USE_DEFAULT_TIMEOUT, viewportSizeHandler

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	addMouseTrigger(MouseAction action, Region control, Location cursor) Adds a mouse trigger.
void	addTextTrigger(Region control, String text) Adds a keyboard trigger.
boolean	checkImage(BufferedImage image) See checkImage(BufferedImage, String).
boolean	checkImage(BufferedImage image, String tag) See checkImage(BufferedImage, String, boolean).
boolean	checkImage(BufferedImage image, String tag, boolean ignoreMismatch) Matches the input image with the next expected image.
boolean	checkImage(byte[] image) See checkImage(byte[], String).
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) See checkImage(String, String).
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) Perform visual validation of a region for a given image.
void	checkRegion(BufferedImage image, Region region, String tag) Perform visual validation for a region in a given image.
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.
String	getBaseAgentId() Get the base agent id.
protected String	getInferredEnvironment() Get the inferred environment.
EyesScreenshot	getScreenshot() Get the screenshot.
protected String	getTitle() Get the title.
RectangleSize	getViewportSize()
void	open(String appName, String testName) Starts a new test without setting the viewport size of the AUT.
void	open(String appName, String testName, RectangleSize dimensions) Starts a test.
void	setInferredEnvironment(String inferred) Sets the inferred environment for the test.
void	setViewportSize(RectangleSize size) Set the viewport size.

Methods inherited from class com.applitools.eyes.EyesBase

abortIfNotClosed, addMouseTriggerBase, addProperty, addTextTriggerBase, addUserInput, checkWindowBase, checkWindowBase, checkWindowBase, clearUserInputs, close, close, closeResponseTime, getAgentId, getApiKey, getAppEnvironment, getAppName, getBaselineEnvName, getBaselineName, getBatch, getBranchName, getDebugScreenshotsPath, getDebugScreenshotsPrefix, getDebugScreenshotsProvider, getDefaultMatchSettings, getDefaultServerUrl, getEnvName, getFailureReports, getFullAgentId, getHostApp, getHostOS, getIgnoreCaret, getIsDisabled, getIsOpen, getLogHandler, getMatchLevel, getMatchTimeout, getParentBranchName, getPositionProvider, getProxy, getSaveDebugScreenshots, getSaveFailedTests, getSaveNewTests, getScaleRatio, getServerUrl, getStitchOverlap, getUserInputs, openBase, setAgentId, setApiKey, setAppEnvironment, setAppName, setBaselineEnvName, setBaselineName, setBatch, setBranchName, setDebugScreenshotsPath, setDebugScreenshotsPrefix, setDefaultMatchSettings, setEnvName, setExplicitViewportSize, setFailureReports, setHostApp, setHostOS, setIgnoreCaret, setImageCut, setIsDisabled, setLogHandler, setMatchLevel, setMatchTimeout, setParentBranchName, setPositionProvider, setProxy, setSaveDebugScreenshots, setSaveFailedTests, setSaveNewTests, setScaleRatio, setServerUrl, setStitchOverlap, startSession, testResponseTimeBase

Methods inherited from class java.lang.Object

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

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

Get the base agent id.

Specified by:

getBaseAgentId in class EyesBase

Returns:

Base agent id.

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)

Starts a new test without setting the viewport size of the AUT.

Parameters:

appName - The name of the application under test.

testName - The test name.

See Also:

open(String, String, RectangleSize)

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)

See checkImage(BufferedImage, String). tag defaults to null.

checkImage

public boolean checkImage(BufferedImage image,
                          String tag)

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

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)

See checkImage(String, String). tag defaults to null.

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)

See checkImage(byte[], String). tag defaults to null.

Parameters:

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

Returns:

Whether or not the image matched the baseline.

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.

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)

Perform visual validation for a region in a given image. Does not ignore mismatches.

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.

Throws:

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

checkRegion

public void checkRegion(BufferedImage image,
                        Region region)

Perform visual validation of a region for a given image. Tag is empty and mismatches are not ignored.

Parameters:

image - The image to perform visual validation for.

region - The region to validate within the image.

Throws:

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

addMouseTrigger

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

Adds a mouse trigger.

Parameters:

action - Mouse action.

control - The control on which the trigger is activated (context relative coordinates).

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

addTextTrigger

public void addTextTrigger(Region control,
                           String text)

Adds a keyboard trigger.

Parameters:

control - The control's context-relative region.

text - The trigger's text.

getViewportSize

public RectangleSize getViewportSize()

Specified by:

getViewportSize in class EyesBase

setViewportSize

public void setViewportSize(RectangleSize size)

Set the viewport size.

Specified by:

setViewportSize in class EyesBase

Parameters:

size - The required viewport size.

getInferredEnvironment

protected String getInferredEnvironment()

Get the inferred environment.

Specified by:

getInferredEnvironment in class EyesBase

Returns:

Inferred environment.

setInferredEnvironment

public void setInferredEnvironment(String inferred)

Sets the inferred environment for the test.

Parameters:

inferred - The inferred environment string.

getScreenshot

public EyesScreenshot getScreenshot()

Get the screenshot.

Specified by:

getScreenshot in class EyesBase

Returns:

The screenshot.

getTitle

protected String getTitle()

Get the title.

Specified by:

getTitle in class EyesBase

Returns:

The title.