com.applitools.eyes.selenium

Class Eyes

java.lang.Object

com.applitools.eyes.EyesBase

com.applitools.eyes.selenium.Eyes

public class Eyes
extends EyesBase

The main API gateway for the SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Eyes.WebDriverAction

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_DEVICE_PIXEL_RATIO
static double	UNKNOWN_DEVICE_PIXEL_RATIO

Fields inherited from class com.applitools.eyes.EyesBase

cutProviderHandler, lastScreenshot, logger, positionProvider, runningSession, scaleProviderHandler, serverConnector, sessionStartInfo, USE_DEFAULT_TIMEOUT, viewportSize

Constructor Summary

Constructors

Constructor and Description
Eyes()
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
protected void	addMouseTrigger(MouseAction action, Region control, Location cursor) Adds a mouse trigger.
protected void	addMouseTrigger(MouseAction action, org.openqa.selenium.WebElement element) Adds a mouse trigger.
protected void	addTextTrigger(Region control, String text) Adds a keyboard trigger.
protected void	addTextTrigger(org.openqa.selenium.WebElement element, String text) Adds a keyboard trigger.
protected void	checkCurrentFrame(int matchTimeout, String tag) Verifies the current frame.
protected void	checkElement(org.openqa.selenium.By selector) See checkElement(By, String).
protected void	checkElement(org.openqa.selenium.By selector, int matchTimeout, String tag) Takes a snapshot of the application under test and matches an element specified by the given selector with the expected region output.
protected void	checkElement(org.openqa.selenium.By selector, String tag) See checkElement(By, int, String).
protected void	checkElement(org.openqa.selenium.WebElement element) See checkElement(WebElement, String).
protected void	checkElement(org.openqa.selenium.WebElement element, int matchTimeout, String tag) Takes a snapshot of the application under test and matches a specific element with the expected region output.
protected void	checkElement(org.openqa.selenium.WebElement element, String tag) See checkElement(WebElement, int, String).
void	checkFrame(int frameIndex)
void	checkFrame(int frameIndex, int matchTimeout, String tag) Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.
void	checkFrame(int frameIndex, String tag)
void	checkFrame(String frameNameOrId)
void	checkFrame(String[] framesPath)
void	checkFrame(String[] framePath, int matchTimeout, String tag) Matches the frame given by the frames path, by switching into the frame and using stitching to get an image of the frame.
void	checkFrame(String[] framesPath, String tag)
void	checkFrame(String frameNameOrId, int matchTimeout, String tag) Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.
void	checkFrame(String frameNameOrId, String tag)
void	checkFrame(org.openqa.selenium.WebElement frameReference)
void	checkFrame(org.openqa.selenium.WebElement frameReference, int matchTimeout, String tag) Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.
void	checkFrame(org.openqa.selenium.WebElement frameReference, String tag)
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(Region region)
void	checkRegion(Region region, int matchTimeout, String tag)
void	checkRegion(org.openqa.selenium.WebElement element)
void	checkRegion(org.openqa.selenium.WebElement element, boolean stitchContent)
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)
void	checkRegion(org.openqa.selenium.WebElement element, String tag, boolean stitchContent)
void	checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector)
void	checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, boolean stitchContent)
void	checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, int matchTimeout, String tag)
void	checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, int matchTimeout, String tag, boolean stitchContent) Switches into the given frame, takes a snapshot of the application under test and matches a region specified by the given selector.
void	checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, String tag)
void	checkRegionInFrame(int frameIndex, org.openqa.selenium.By selector, String tag, boolean stitchContent)
void	checkRegionInFrame(String[] framePath, org.openqa.selenium.By selector)
void	checkRegionInFrame(String[] framePath, org.openqa.selenium.By selector, int matchTimeout, String tag) See checkRegionInFrame(String[], By, int, String, boolean).
void	checkRegionInFrame(String[] framePath, org.openqa.selenium.By selector, int matchTimeout, String tag, boolean stitchContent) 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[] framePath, org.openqa.selenium.By selector, String tag)
void	checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector)
void	checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector, boolean stitchContent) See checkRegionInFrame(String, By, String, boolean).
void	checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector, int matchTimeout, String tag)
void	checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector, int matchTimeout, String tag, boolean stitchContent) 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, String tag)
void	checkRegionInFrame(String frameNameOrId, org.openqa.selenium.By selector, String tag, boolean stitchContent)
void	checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector)
void	checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector, boolean stitchContent)
void	checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector, int matchTimeout, String tag)
void	checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector, int matchTimeout, String tag, boolean stitchContent) 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, String tag)
void	checkRegionInFrame(org.openqa.selenium.WebElement frameReference, org.openqa.selenium.By selector, String tag, boolean stitchContent)
void	checkWindow()
void	checkWindow(int matchTimeout, String tag) Takes a snapshot of the application under test and matches it with the expected output.
void	checkWindow(String tag) See checkWindow(int, String).
protected AppEnvironment	getAppEnvironment() This override also checks for mobile operating system.
String	getBaseAgentId()
double	getDevicePixelRatio()
boolean	getForceFullPageScreenshot()
boolean	getHideScrollbars()
protected String	getInferredEnvironment()
ImageRotation	getRotation()
protected EyesScreenshot	getScreenshot()
boolean	getScrollToRegion()
StitchMode	getStitchMode()
protected String	getTitle()
protected RectangleSize	getViewportSize()
static RectangleSize	getViewportSize(org.openqa.selenium.WebDriver driver)
int	getWaitBeforeScreenshots()
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, RectangleSize viewportSize)
protected org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName, RectangleSize viewportSize, SessionType sessionType) Starts a test.
protected org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName, SessionType sessionType)
void	setForceFullPageScreenshot(boolean shouldForce)
void	setHideScrollbars(boolean shouldHide)
void	setRotation(ImageRotation rotation)
void	setScrollToRegion(boolean shouldScroll)
void	setStitchMode(StitchMode mode)
protected void	setViewportSize(RectangleSize size)
static void	setViewportSize(org.openqa.selenium.WebDriver driver, RectangleSize size) Set the viewport size using the driver.
void	setWaitBeforeScreenshots(int waitBeforeScreenshots)
void	testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName)
void	testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action)
void	testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action, int deadline)
void	testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action, int deadline, int timeout)
void	testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action, int deadline, int timeout, RectangleSize viewportSize)
void	testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action, int deadline, RectangleSize viewportSize)
void	testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, Eyes.WebDriverAction action, RectangleSize viewportSize)
void	testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, int deadline)
void	testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, int deadline, int timeout, RectangleSize viewportSize)
void	testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, int deadline, RectangleSize viewportSize)
void	testResponseTime(org.openqa.selenium.WebDriver driver, String appName, String testName, RectangleSize viewportSize)
void	testWindow(org.openqa.selenium.WebDriver driver, String testName)
void	testWindow(org.openqa.selenium.WebDriver driver, String testName, RectangleSize viewportSize) See testWindow(WebDriver, String, String, RectangleSize).
void	testWindow(org.openqa.selenium.WebDriver driver, String appName, String testName)
void	testWindow(org.openqa.selenium.WebDriver driver, String appName, String testName, RectangleSize viewportSize) Runs a test on the current window.
protected ScaleProviderFactory	updateScalingParams() Updates the state of scaling related parameters.

Methods inherited from class com.applitools.eyes.EyesBase

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

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

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

Method Detail

getBaseAgentId

public String getBaseAgentId()

Specified by:

getBaseAgentId in class EyesBase

setForceFullPageScreenshot

public void setForceFullPageScreenshot(boolean shouldForce)

getForceFullPageScreenshot

public boolean getForceFullPageScreenshot()

setWaitBeforeScreenshots

public void setWaitBeforeScreenshots(int waitBeforeScreenshots)

getWaitBeforeScreenshots

public int getWaitBeforeScreenshots()

setScrollToRegion

public void setScrollToRegion(boolean shouldScroll)

getScrollToRegion

public boolean getScrollToRegion()

setStitchMode

public void setStitchMode(StitchMode mode)

getStitchMode

public StitchMode getStitchMode()

Returns:

The current stitch mode settings.

setHideScrollbars

public void setHideScrollbars(boolean shouldHide)

getHideScrollbars

public boolean getHideScrollbars()

getRotation

public ImageRotation getRotation()

setRotation

public void setRotation(ImageRotation rotation)

getDevicePixelRatio

public double getDevicePixelRatio()

open

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

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,
                                             RectangleSize viewportSize,
                                             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.

open

protected org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                             String appName,
                                             String testName,
                                             SessionType sessionType)

checkWindow

public void checkWindow()

checkWindow

public void checkWindow(String tag)

See checkWindow(int, String). Default match timeout is used.

Parameters:

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

checkWindow

public void checkWindow(int matchTimeout,
                        String tag)

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

Parameters:

matchTimeout - The amount of time to retry matching (Milliseconds).

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

Throws:

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

testWindow

public void testWindow(org.openqa.selenium.WebDriver driver,
                       String appName,
                       String testName,
                       RectangleSize viewportSize)

Runs a test on the current window.

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 (will also be used as the tag name for the step).

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.

testWindow

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

testWindow

public void testWindow(org.openqa.selenium.WebDriver driver,
                       String testName,
                       RectangleSize viewportSize)

See testWindow(WebDriver, String, String, RectangleSize). appName defaults to null (which means the name set in EyesBase.setAppName(String) would be used.

testWindow

public void testWindow(org.openqa.selenium.WebDriver driver,
                       String testName)

testResponseTime

public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action,
                             int deadline,
                             int timeout)

testResponseTime

public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action,
                             int deadline)

testResponseTime

public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action)

testResponseTime

public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             int deadline)

testResponseTime

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

testResponseTime

public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action,
                             int deadline,
                             int timeout,
                             RectangleSize viewportSize)

testResponseTime

public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action,
                             int deadline,
                             RectangleSize viewportSize)

testResponseTime

public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             Eyes.WebDriverAction action,
                             RectangleSize viewportSize)

testResponseTime

public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             int deadline,
                             int timeout,
                             RectangleSize viewportSize)

testResponseTime

public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             int deadline,
                             RectangleSize viewportSize)

testResponseTime

public void testResponseTime(org.openqa.selenium.WebDriver driver,
                             String appName,
                             String testName,
                             RectangleSize viewportSize)

checkRegion

public void checkRegion(Region region)

checkRegion

public void checkRegion(Region region,
                        int matchTimeout,
                        String tag)

checkRegion

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

checkRegion

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

checkRegion

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

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)

checkRegionInFrame

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

checkRegionInFrame

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

checkRegionInFrame

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

checkRegionInFrame

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

checkRegionInFrame

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

checkRegionInFrame

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

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.

matchTimeout - The amount of time to retry matching. (Milliseconds)

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

stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.

checkRegionInFrame

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

checkRegionInFrame

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

See checkRegionInFrame(String, By, String, boolean). tag defaults to null.

checkRegionInFrame

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

checkRegionInFrame

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

checkRegionInFrame

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

checkRegionInFrame

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

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.

matchTimeout - The amount of time to retry matching. (Milliseconds)

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

stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.

checkRegionInFrame

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

checkRegionInFrame

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

checkRegionInFrame

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

checkRegionInFrame

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

checkRegionInFrame

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

checkRegionInFrame

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

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.

matchTimeout - The amount of time to retry matching. (Milliseconds)

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

stitchContent - If true, stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.

updateScalingParams

protected ScaleProviderFactory updateScalingParams()

Updates the state of scaling related parameters.

checkCurrentFrame

protected void checkCurrentFrame(int matchTimeout,
                                 String tag)

Verifies the current frame.

Parameters:

matchTimeout - The amount of time to retry matching. (Milliseconds)

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

checkFrame

public void checkFrame(String frameNameOrId)

checkFrame

public void checkFrame(String frameNameOrId,
                       String tag)

checkFrame

public void checkFrame(String frameNameOrId,
                       int matchTimeout,
                       String tag)

Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.

Parameters:

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

matchTimeout - The amount of time to retry matching. (Milliseconds)

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

checkFrame

public void checkFrame(int frameIndex)

checkFrame

public void checkFrame(int frameIndex,
                       String tag)

checkFrame

public void checkFrame(int frameIndex,
                       int matchTimeout,
                       String tag)

Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.

Parameters:

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

matchTimeout - The amount of time to retry matching. (Milliseconds)

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

checkFrame

public void checkFrame(org.openqa.selenium.WebElement frameReference)

checkFrame

public void checkFrame(org.openqa.selenium.WebElement frameReference,
                       String tag)

checkFrame

public void checkFrame(org.openqa.selenium.WebElement frameReference,
                       int matchTimeout,
                       String tag)

Matches the frame given as parameter, by switching into the frame and using stitching to get an image of the frame.

Parameters:

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

matchTimeout - The amount of time to retry matching (milliseconds).

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

checkFrame

public void checkFrame(String[] framePath,
                       int matchTimeout,
                       String tag)

Matches the frame given by the frames path, by switching into the frame and using stitching to get an image of the frame.

Parameters:

framePath - The path to the frame to check. This is a list of frame names/IDs (where each frame is nested in the previous frame).

matchTimeout - The amount of time to retry matching (milliseconds).

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

checkFrame

public void checkFrame(String[] framesPath,
                       String tag)

checkFrame

public void checkFrame(String[] framesPath)

checkRegionInFrame

public void checkRegionInFrame(String[] framePath,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag,
                               boolean stitchContent)

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

Parameters:

framePath - The path to the frame to check. This is a list of frame names/IDs (where each frame is nested in the previous frame).

selector - A Selector specifying the region to check.

matchTimeout - The amount of time to retry matching (milliseconds).

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

stitchContent - Whether or not to stitch the internal content of the region (i.e., perform checkElement(By, int, String) on the region.

checkRegionInFrame

public void checkRegionInFrame(String[] framePath,
                               org.openqa.selenium.By selector,
                               int matchTimeout,
                               String tag)

See checkRegionInFrame(String[], By, int, String, boolean). stitchContent defaults to false.

checkRegionInFrame

public void checkRegionInFrame(String[] framePath,
                               org.openqa.selenium.By selector,
                               String tag)

checkRegionInFrame

public void checkRegionInFrame(String[] framePath,
                               org.openqa.selenium.By selector)

checkElement

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

See checkElement(WebElement, String). tag defaults to null.

checkElement

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

See checkElement(WebElement, int, String). Default match timeout is used.

checkElement

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

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

Parameters:

element - The element to check.

matchTimeout - The amount of time to retry matching. (Milliseconds)

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

Throws:

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

checkElement

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

See checkElement(By, String). tag defaults to null.

checkElement

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

See checkElement(By, int, String). Default match timeout is used.

checkElement

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

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

Parameters:

selector - Selects the element to check.

matchTimeout - The amount of time to retry matching. (Milliseconds)

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

Throws:

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

addMouseTrigger

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

addMouseTrigger

protected void addMouseTrigger(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(Region control,
                              String text)

Adds a keyboard trigger.

Parameters:

control - The control's context-relative region.

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.

getViewportSize

protected RectangleSize getViewportSize()

Specified by:

getViewportSize in class EyesBase

getViewportSize

public static RectangleSize getViewportSize(org.openqa.selenium.WebDriver driver)

setViewportSize

protected void setViewportSize(RectangleSize size)

Specified by:

setViewportSize in class EyesBase

setViewportSize

public static void setViewportSize(org.openqa.selenium.WebDriver driver,
                                   RectangleSize size)

Set the viewport size using the driver. Call this method if for some reason you don't want to call open(WebDriver, String, String) (or one of its variants) yet.

Parameters:

driver - The driver to use for setting the viewport.

size - The required viewport size.

getScreenshot

protected EyesScreenshot getScreenshot()

Specified by:

getScreenshot in class EyesBase

getTitle

protected String getTitle()

Specified by:

getTitle in class EyesBase

getInferredEnvironment

protected String getInferredEnvironment()

Specified by:

getInferredEnvironment in class EyesBase

getAppEnvironment

protected AppEnvironment getAppEnvironment()

This override also checks for mobile operating system.

Overrides:

getAppEnvironment in class EyesBase